Skip to content

improve: Add Base64 download support to TailorDBFileAPI and extend metadata #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ikawaha merged 3 commits into from
Dec 1, 2025
Merged

improve: Add Base64 download support to TailorDBFileAPI and extend metadata #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea43fbc
improve: Add Base64 download support to TailorDBFileAPI and extend me…
ikawaha Dec 1, 2025
d6ca265
chore: Update version
ikawaha Dec 1, 2025
a94ebd5
fix: Add FILE_TOO_LARGE error note to download() JSDoc
ikawaha Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/types/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@tailor-platform/function-types",
"version": "0.7.2",
"version": "0.8.0",
"description": "TypeScript types for Tailor Platform Function service",
"repository": {
"type": "git",
Expand Down
27 changes: 26 additions & 1 deletion packages/types/tailor.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ declare namespace tailor.iconv {
*/
declare class TailorDBFileError extends Error {
name: 'TailorDBFileError';
code?: 'INVALID_PARAMS' | 'INVALID_DATA_TYPE' | 'OPERATION_FAILED' | 'DELETE_FAILED' | 'STREAM_OPEN_FAILED' | 'STREAM_READ_ERROR' | 'STREAM_ERROR';
code?: 'INVALID_PARAMS' | 'INVALID_DATA_TYPE' | 'OPERATION_FAILED' | 'DELETE_FAILED' | 'STREAM_OPEN_FAILED' | 'STREAM_READ_ERROR' | 'STREAM_ERROR' | 'FILE_TOO_LARGE';
cause?: unknown;
}

Expand All @@ -135,6 +135,8 @@ interface UploadMetadata {
interface DownloadMetadata {
contentType: string;
fileSize: number;
sha256sum: string;
lastUploadedAt: string;
}

/**
Expand Down Expand Up @@ -179,6 +181,14 @@ interface FileDownloadResponse {
metadata: DownloadMetadata;
}

/**
* Download as Base64 response interface
*/
interface FileDownloadAsBase64Response {
data: string;
metadata: DownloadMetadata;
}

/**
* Stream chunk types
*/
Expand Down Expand Up @@ -213,6 +223,7 @@ interface TailorDBFileAPI {

/**
* Download a file from TailorDB
* @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use openDownloadStream() for large files
*/
download(
namespace: string,
Expand All @@ -221,6 +232,20 @@ interface TailorDBFileAPI {
recordId: string
): Promise<FileDownloadResponse>;

/**
* Download a file from TailorDB as Base64 string
* Unlike download which returns decoded binary data (Uint8Array),
* this returns the raw Base64-encoded string for use cases requiring
* Base64 format (e.g., embedding in JSON responses, data URIs)
* @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use openDownloadStream() for large files
*/
downloadAsBase64(
namespace: string,
typeName: string,
fieldName: string,
recordId: string
): Promise<FileDownloadAsBase64Response>;

/**
* Delete a file from TailorDB
*/
Expand Down