@turinhub/tale-js-sdk 1.3.0 → 2.1.0

package/dist/cms/file.d.ts

@@ -1,5 +1,5 @@
 import type { PageResponse } from "../common/types.js";
-import type { File, CreateFileRequest, UpdateFileRequest, ListFilesRequest, FileOptions } from "./types.js";
+import type { File, CreateFileRequest, UpdateFileRequest, ListFilesRequest, FileOptions, FileAttachment } from "./types.js";
 /**
  * Gets a file by ID.
  *
@@ -15,9 +15,9 @@ import type { File, CreateFileRequest, UpdateFileRequest, ListFilesRequest, File
  * import { getFile } from '@tale/client';
  *
  * try {
- *   const file = await getFile('file_id_here');
- *   console.log('File name:', file.file_name);
- *   console.log('File type:', file.file_type);
+ *   const file = await getFile('fileId_here');
+ *   console.log('File name:', file.fileName);
+ *   console.log('File type:', file.fileType);
  * } catch (error) {
  *   console.error('Failed to get file:', error.message);
  * }
@@ -39,10 +39,10 @@ export declare function getFile(fileId: string, options?: FileOptions): Promise<
  *
  * try {
  *   const result = await listFiles({
- *     folder_id: 'folder_id_here',
+ *     folderId: 'folderId_here',
  *     page: 0,
  *     size: 20,
- *     sort_by: 'createdAt'
+ *     sort: 'createdAt'
  *   });
  *   console.log(`Found ${result.total} files`);
  * } catch (error) {
@@ -67,9 +67,9 @@ export declare function listFiles(options?: ListFilesRequest & FileOptions): Pro
  *
  * try {
  *   const file = await createFile({
- *     folder_id: 'folder_id_here',
- *     file_name: 'My Document',
- *     file_type: 'markdown',
+ *     folderId: 'folderId_here',
+ *     fileName: 'My Document',
+ *     fileType: 'markdown',
  *     content: '# Hello World'
  *   });
  *   console.log('File created:', file.id);
@@ -95,11 +95,11 @@ export declare function createFile(request: CreateFileRequest, options?: FileOpt
  * import { updateFile } from '@tale/client';
  *
  * try {
- *   const file = await updateFile('file_id_here', {
- *     file_name: 'Updated Name',
+ *   const file = await updateFile('fileId_here', {
+ *     fileName: 'Updated Name',
  *     remark: 'Updated remark'
  *   });
- *   console.log('File updated:', file.file_name);
+ *   console.log('File updated:', file.fileName);
  * } catch (error) {
  *   console.error('Failed to update file:', error.message);
  * }
@@ -122,7 +122,7 @@ export declare function updateFile(fileId: string, request: UpdateFileRequest, o
  * import { updateFileContent } from '@tale/client';
  *
  * try {
- *   const file = await updateFileContent('file_id_here', '# New Content');
+ *   const file = await updateFileContent('fileId_here', '# New Content');
  *   console.log('Content updated:', file.content);
  * } catch (error) {
  *   console.error('Failed to update content:', error.message);
@@ -145,7 +145,7 @@ export declare function updateFileContent(fileId: string, content: string, optio
  * import { deleteFile } from '@tale/client';
  *
  * try {
- *   await deleteFile('file_id_here');
+ *   await deleteFile('fileId_here');
  *   console.log('File deleted successfully');
  * } catch (error) {
  *   console.error('Failed to delete file:', error.message);
@@ -169,8 +169,8 @@ export declare function deleteFile(fileId: string, options?: FileOptions): Promi
  * import { getFilePresignedUrl } from '@tale/client';
  *
  * try {
- *   const result = await getFilePresignedUrl('file_id_here', 3600);
- *   console.log('Presigned URL:', result.presigned_url);
+ *   const result = await getFilePresignedUrl('fileId_here', 3600);
+ *   console.log('Presigned URL:', result.presignedUrl);
  *   // Now you can download the file directly
  * } catch (error) {
  *   console.error('Failed to get presigned URL:', error.message);
@@ -178,11 +178,11 @@ export declare function deleteFile(fileId: string, options?: FileOptions): Promi
  * ```
  */
 export declare function getFilePresignedUrl(fileId: string, expireTimeInSeconds?: number, options?: FileOptions): Promise<{
-    file_id: string;
-    file_name: string;
-    oss_key: string;
-    presigned_url: string;
-    expire_time_in_seconds: number;
+    fileId: string;
+    fileName: string;
+    ossKey: string;
+    presignedUrl: string;
+    expireTimeInSeconds: number;
 }>;
 /**
  * Batch gets presigned URLs for multiple files.
@@ -201,14 +201,14 @@ export declare function getFilePresignedUrl(fileId: string, expireTimeInSeconds?
  *
  * try {
  *   const results = await batchGetFilePresignedUrl(
- *     ['file_id_1', 'file_id_2'],
+ *     ['fileId_1', 'fileId_2'],
  *     3600
  *   );
  *   results.forEach(result => {
  *     if (result.error) {
- *       console.error('Error for file:', result.file_id, result.error);
+ *       console.error('Error for file:', result.fileId, result.error);
  *     } else {
- *       console.log('URL:', result.presigned_url);
+ *       console.log('URL:', result.presignedUrl);
  *     }
  *   });
  * } catch (error) {
@@ -217,11 +217,11 @@ export declare function getFilePresignedUrl(fileId: string, expireTimeInSeconds?
  * ```
  */
 export declare function batchGetFilePresignedUrl(fileIds: string[], expireTimeInSeconds?: number, options?: FileOptions): Promise<Array<{
-    file_id: string;
-    file_name?: string;
-    oss_key?: string;
-    presigned_url?: string;
-    expire_time_in_seconds?: number;
+    fileId: string;
+    fileName?: string;
+    ossKey?: string;
+    presignedUrl?: string;
+    expireTimeInSeconds?: number;
     error?: string;
 }>>;
 /**
@@ -240,18 +240,18 @@ export declare function batchGetFilePresignedUrl(fileIds: string[], expireTimeIn
  *
  * try {
  *   const metadata = await getOssMetadata('cms/appkey/folder/fileid.pdf');
- *   console.log('File size:', metadata.content_length);
- *   console.log('Content type:', metadata.content_type);
+ *   console.log('File size:', metadata.contentLength);
+ *   console.log('Content type:', metadata.contentType);
  * } catch (error) {
  *   console.error('Failed to get OSS metadata:', error.message);
  * }
  * ```
  */
 export declare function getOssMetadata(ossKey: string, options?: FileOptions): Promise<{
-    oss_key: string;
-    content_type?: string;
-    content_length?: number;
-    last_modified?: string;
+    ossKey: string;
+    contentType?: string;
+    contentLength?: number;
+    lastModified?: string;
     etag?: string;
     metadata?: Record<string, string>;
 }>;
@@ -271,31 +271,31 @@ export declare function getOssMetadata(ossKey: string, options?: FileOptions): P
  *
  * try {
  *   const auth = await getUploadAuthorization({
- *     folder_id: 'folder_id_here',
- *     file_name: 'document.pdf',
- *     file_type: 'pdf'
+ *     folderId: 'folderId_here',
+ *     fileName: 'document.pdf',
+ *     fileType: 'pdf'
  *   });
- *   console.log('OSS Key:', auth.oss_key);
- *   console.log('Upload URL:', auth.presigned_url);
- *   console.log('File ID:', auth.file_id);
- *   // Use presigned_url to upload the file directly to OSS
+ *   console.log('OSS Key:', auth.ossKey);
+ *   console.log('Upload URL:', auth.presignedUrl);
+ *   console.log('File ID:', auth.fileId);
+ *   // Use presignedUrl to upload the file directly to OSS
  * } catch (error) {
  *   console.error('Failed to get upload authorization:', error.message);
  * }
  * ```
  */
 export declare function getUploadAuthorization(request: {
-    folder_id: string;
-    file_name: string;
-    file_type: string;
-    expire_time_in_seconds?: number;
+    folderId: string;
+    fileName: string;
+    fileType: string;
+    expireTimeInSeconds?: number;
 }, options?: FileOptions): Promise<{
-    oss_key: string;
-    presigned_url: string;
-    file_name: string;
-    file_type: string;
-    expire_time_in_seconds: number;
-    file_id: string;
+    ossKey: string;
+    presignedUrl: string;
+    fileName: string;
+    fileType: string;
+    expireTimeInSeconds: number;
+    fileId: string;
 }>;
 /**
  * Gets STS credentials for uploading to an existing file.
@@ -314,11 +314,11 @@ export declare function getUploadAuthorization(request: {
  * import { getFileStsCredentials } from '@tale/client';
  *
  * try {
- *   const credentials = await getFileStsCredentials('file_id_here', '.pdf', 1800);
- *   console.log('Access Key ID:', credentials.access_key_id);
- *   console.log('Secret Access Key:', credentials.secret_access_key);
- *   console.log('Session Token:', credentials.session_token);
- *   console.log('Upload Path:', credentials.upload_path);
+ *   const credentials = await getFileStsCredentials('fileId_here', '.pdf', 1800);
+ *   console.log('Access Key ID:', credentials.accessKeyId);
+ *   console.log('Secret Access Key:', credentials.secretAccessKey);
+ *   console.log('Session Token:', credentials.sessionToken);
+ *   console.log('Upload Path:', credentials.uploadPath);
  *   // Use these credentials to upload with OSS SDK
  * } catch (error) {
  *   console.error('Failed to get STS credentials:', error.message);
@@ -326,12 +326,18 @@ export declare function getUploadAuthorization(request: {
  * ```
  */
 export declare function getFileStsCredentials(fileId: string, fileExtension: string, durationSeconds?: number, options?: FileOptions): Promise<{
-    access_key_id: string;
-    secret_access_key: string;
-    session_token: string;
-    expiration: string;
-    upload_path: string;
+    credentials: {
+        tmpSecretId: string;
+        tmpSecretKey: string;
+        sessionToken: string;
+        bucket: string;
+        region: string;
+    };
+    startTime: number;
+    expiredTime: number;
+    bucket: string;
     region: string;
+    allowPrefix: string;
 }>;
 /**
  * Marks file upload as complete and updates OSS information.
@@ -349,9 +355,9 @@ export declare function getFileStsCredentials(fileId: string, fileExtension: str
  * import { fileUploadComplete } from '@tale/client';
  *
  * try {
- *   const result = await fileUploadComplete('file_id_here', {
- *     oss_key: 'cms/appkey/folder/fileid.pdf',
- *     file_size: 12345,
+ *   const result = await fileUploadComplete('fileId_here', {
+ *     ossKey: 'cms/appkey/folder/fileid.pdf',
+ *     fileSize: 12345,
  *     etag: 'abc123'
  *   });
  *   console.log('Upload complete:', result.message);
@@ -361,12 +367,12 @@ export declare function getFileStsCredentials(fileId: string, fileExtension: str
  * ```
  */
 export declare function fileUploadComplete(fileId: string, request: {
-    oss_key: string;
-    file_size: number;
+    ossKey: string;
+    fileSize: number;
     etag: string;
 }, options?: FileOptions): Promise<{
     message: string;
-    file_id: string;
+    fileId: string;
 }>;
 /**
  * Sets a preview image for a file.
@@ -388,11 +394,23 @@ export declare function fileUploadComplete(fileId: string, request: {
  *   const input = document.getElementById('previewInput');
  *   const file = input.files[0];
  *
- *   const updatedFile = await setFilePreviewImage('file_id_here', file);
- *   console.log('Preview image set:', updatedFile.preview_image_url);
+ *   const updatedFile = await setFilePreviewImage('fileId_here', file);
+ *   console.log('Preview image set:', updatedFile.previewImageUrl);
  * } catch (error) {
  *   console.error('Failed to set preview image:', error.message);
  * }
  * ```
  */
 export declare function setFilePreviewImage(fileId: string, imageFile: File | Blob, options?: FileOptions): Promise<File>;
+/** List attachments for a file */
+export declare function listFileAttachments(fileId: string, options?: FileOptions & {
+    page?: number;
+    size?: number;
+    sort?: string;
+}): Promise<PageResponse<FileAttachment>>;
+/** Get a file attachment by ID */
+export declare function getFileAttachment(fileId: string, attachmentId: string, options?: FileOptions): Promise<FileAttachment>;
+/** Upload an attachment to a file */
+export declare function uploadFileAttachment(fileId: string, attachmentTypeId: string, file: File | Blob, remark?: string, options?: FileOptions): Promise<FileAttachment>;
+/** Delete a file attachment */
+export declare function deleteFileAttachment(fileId: string, attachmentId: string, options?: FileOptions): Promise<void>;