@turinhub/tale-js-sdk 1.3.0 → 2.0.0

package/dist/cms/folder.js

@@ -34,8 +34,8 @@ function parseApiResponse(json, errorMessage, statusCode) {
  * import { getFolder } from '@tale/client';
  *
  * try {
- *   const folder = await getFolder('folder_id_here');
- *   console.log('Folder name:', folder.folder_name);
+ *   const folder = await getFolder('folderId_here');
+ *   console.log('Folder name:', folder.folderName);
  * } catch (error) {
  *   console.error('Failed to get folder:', error.message);
  * }
@@ -52,7 +52,7 @@ export async function getFolder(folderId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/cms/v1/folders/${encodeURIComponent(folderId)}`;
+        `/cms/v2/folders/${encodeURIComponent(folderId)}`;
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -86,7 +86,7 @@ export async function getFolder(folderId, options) {
  *   const result = await listFolders({
  *     page: 0,
  *     size: 20,
- *     sort_by: 'createdAt'
+ *     sort: 'createdAt'
  *   });
  *   console.log(`Found ${result.total} folders`);
  * } catch (error) {
@@ -101,12 +101,12 @@ export async function listFolders(options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = new URL(String(base).replace(/\/+$/, "") + "/cms/v1/folders");
+    const url = new URL(String(base).replace(/\/+$/, "") + "/cms/v2/folders");
     const { appToken, baseUrl, ...requestParams } = options || {};
     const queryParams = {
         page: 0,
-        size: 10,
-        sort_by: "createdAt",
+        size: 20,
+        sort: "createdAt,desc",
         ...requestParams,
     };
     Object.entries(queryParams).forEach(([key, value]) => {
@@ -146,8 +146,8 @@ export async function listFolders(options) {
  *
  * try {
  *   const folder = await createFolder({
- *     folder_name: 'Images',
- *     folder_type: ['IMAGE', 'VIDEO'],
+ *     folderName: 'Images',
+ *     folderType: ['IMAGE', 'VIDEO'],
  *     remark: 'Image and video files'
  *   });
  *   console.log('Folder created:', folder.id);
@@ -157,8 +157,8 @@ export async function listFolders(options) {
  * ```
  */
 export async function createFolder(request, options) {
-    if (!request.folder_name || request.folder_name.trim() === "") {
-        throw new ApiError("folder_name is required", 400, "9400");
+    if (!request.folderName || request.folderName.trim() === "") {
+        throw new ApiError("folderName is required", 400, "9400");
     }
     const token = options?.appToken ?? (await getAppToken(options));
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
@@ -166,7 +166,7 @@ export async function createFolder(request, options) {
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
-    const url = String(base).replace(/\/+$/, "") + "/cms/v1/folders";
+    const url = String(base).replace(/\/+$/, "") + "/cms/v2/folders";
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -200,11 +200,11 @@ export async function createFolder(request, options) {
  * import { updateFolder } from '@tale/client';
  *
  * try {
- *   const folder = await updateFolder('folder_id_here', {
- *     folder_name: 'Updated Name',
+ *   const folder = await updateFolder('folderId_here', {
+ *     folderName: 'Updated Name',
  *     remark: 'Updated remark'
  *   });
- *   console.log('Folder updated:', folder.folder_name);
+ *   console.log('Folder updated:', folder.folderName);
  * } catch (error) {
  *   console.error('Failed to update folder:', error.message);
  * }
@@ -221,7 +221,7 @@ export async function updateFolder(folderId, request, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/cms/v1/folders/${encodeURIComponent(folderId)}`;
+        `/cms/v2/folders/${encodeURIComponent(folderId)}`;
     let response;
     try {
         response = await globalThis.fetch(url, {
@@ -254,7 +254,7 @@ export async function updateFolder(folderId, request, options) {
  * import { deleteFolder } from '@tale/client';
  *
  * try {
- *   await deleteFolder('folder_id_here');
+ *   await deleteFolder('folderId_here');
  *   console.log('Folder deleted successfully');
  * } catch (error) {
  *   console.error('Failed to delete folder:', error.message);
@@ -272,7 +272,7 @@ export async function deleteFolder(folderId, options) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
     const url = String(base).replace(/\/+$/, "") +
-        `/cms/v1/folders/${encodeURIComponent(folderId)}`;
+        `/cms/v2/folders/${encodeURIComponent(folderId)}`;
     let response;
     try {
         response = await globalThis.fetch(url, {

package/dist/cms/types.d.ts

@@ -10,30 +10,30 @@ export interface Folder {
     /** Folder ID (UUID) */
     id: string;
     /** Application key */
-    app_key: string;
+    appKey: string;
     /** Folder name */
-    folder_name: string;
+    folderName: string;
     /** Folder types (array of file types allowed in this folder) */
-    folder_type: FileType[];
+    folderType: FileType[];
     /** Folder attributes (custom metadata) */
-    folder_attr: Record<string, unknown> | null;
+    folderAttr: Record<string, unknown> | null;
     /** Remark/note */
     remark: string | null;
     /** Creation timestamp */
-    created_at: string;
+    createdAt: string;
     /** Last update timestamp */
-    updated_at: string;
+    updatedAt: string;
 }
 /**
  * Request to create a folder
  */
 export interface CreateFolderRequest {
     /** Folder name (required) */
-    folder_name: string;
+    folderName: string;
     /** Folder types (optional) */
-    folder_type?: FileType[];
+    folderType?: FileType[];
     /** Folder attributes (optional) */
-    folder_attr?: Record<string, unknown>;
+    folderAttr?: Record<string, unknown>;
     /** Remark (optional) */
     remark?: string;
 }
@@ -42,11 +42,11 @@ export interface CreateFolderRequest {
  */
 export interface UpdateFolderRequest {
     /** Folder name (optional) */
-    folder_name?: string;
+    folderName?: string;
     /** Folder types (optional) */
-    folder_type?: FileType[];
+    folderType?: FileType[];
     /** Folder attributes (optional) */
-    folder_attr?: Record<string, unknown>;
+    folderAttr?: Record<string, unknown>;
     /** Remark (optional) */
     remark?: string;
 }
@@ -69,7 +69,7 @@ export interface ListFoldersRequest {
     /** Page size (default: 10) */
     size?: number;
     /** Sort field (default: "createdAt") */
-    sort_by?: string;
+    sort?: string;
 }
 /**
  * File information
@@ -78,44 +78,44 @@ export interface File {
     /** File ID (UUID) */
     id: string;
     /** Application key */
-    app_key: string;
+    appKey: string;
     /** Folder ID (UUID) */
-    folder_id: string;
+    folderId: string;
     /** File name */
-    file_name: string;
+    fileName: string;
     /** File type */
-    file_type: FileType;
+    fileType: FileType;
     /** File attributes (custom metadata) */
-    file_attr: Record<string, unknown> | null;
+    fileAttr: Record<string, unknown> | null;
     /** Link URL (for LINK type files) */
-    link_url: string | null;
+    linkUrl: string | null;
     /** OSS URL (for uploaded files) */
-    oss_url: string | null;
+    ossUrl: string | null;
     /** Content (for MARKDOWN type files) */
     content: string | null;
     /** Remark/note */
     remark: string | null;
     /** Preview image URL (presigned) */
-    preview_image_url: string | null;
+    previewImageUrl: string | null;
     /** Creation timestamp */
-    created_at: string;
+    createdAt: string;
     /** Last update timestamp */
-    updated_at: string;
+    updatedAt: string;
 }
 /**
  * Request to create a file
  */
 export interface CreateFileRequest {
     /** Folder ID (UUID, required) */
-    folder_id: string;
+    folderId: string;
     /** File name (required) */
-    file_name: string;
+    fileName: string;
     /** File type (required) */
-    file_type: FileType;
+    fileType: FileType;
     /** File attributes (optional) */
-    file_attr?: Record<string, unknown>;
+    fileAttr?: Record<string, unknown>;
     /** Link URL (for LINK type, optional) */
-    link_url?: string;
+    linkUrl?: string;
     /** Content (for MARKDOWN type, optional) */
     content?: string;
     /** Remark (optional) */
@@ -126,15 +126,15 @@ export interface CreateFileRequest {
  */
 export interface UpdateFileRequest {
     /** Folder ID (optional) */
-    folder_id?: string;
+    folderId?: string;
     /** File name (optional) */
-    file_name?: string;
+    fileName?: string;
     /** File type (optional) */
-    file_type?: FileType;
+    fileType?: FileType;
     /** File attributes (optional) */
-    file_attr?: Record<string, unknown>;
+    fileAttr?: Record<string, unknown>;
     /** Link URL (optional) */
-    link_url?: string;
+    linkUrl?: string;
     /** Content (optional) */
     content?: string;
     /** Remark (optional) */
@@ -144,14 +144,34 @@ export interface UpdateFileRequest {
  * Request to list files with pagination
  */
 export interface ListFilesRequest {
-    /** Folder ID (optional, filters by folder if provided) */
-    folder_id?: string;
+    /** Folder ID (required for listing files) */
+    folderId: string;
     /** Page number (0-based, default: 0) */
     page?: number;
     /** Page size (default: 10) */
     size?: number;
     /** Sort field (default: "createdAt") */
-    sort_by?: string;
-    /** Include attachments in response (default: false) */
-    include_attachments?: boolean;
+    sort?: string;
+}
+/**
+ * File attachment (camelCase, matches AttachmentRespVO)
+ */
+export interface FileAttachment {
+    attachmentId: string;
+    appId: string;
+    typeId: string;
+    refId: string;
+    refType: string;
+    fileName: string;
+    fileOriginalName: string;
+    fileExtension: string;
+    fileOssKey: string;
+    fileSize: number;
+    fileHash: string;
+    mimeType: string;
+    uploadStatus: string;
+    sortOrder: number;
+    remark?: string;
+    createdAt: string;
+    updatedAt: string;
 }

package/dist/common/types.d.ts

@@ -3,89 +3,73 @@ export interface CommonOptions {
     appToken?: string;
 }
 /**
- * Pagination response format used by Tale backend
- *
- * This matches the actual backend response format with simplified pagination metadata
+ * Pagination response format used by Tale backend (PageResponseVO)
  */
 export interface PageResponse<T> {
-    /** Page content */
     content: T[];
-    /** Total number of elements across all pages */
     total: number;
-    /** Pagination information */
-    pageable: {
-        /** Current page number (0-based) */
-        pageNumber: number;
-        /** Page size */
-        pageSize: number;
-        /** Sort information */
-        sort?: {
-            orders?: Array<{
-                direction: "ASC" | "DESC";
-                property: string;
-                ignoreCase: boolean;
-                nullHandling: string;
-            }>;
-        };
-    };
+    page: number;
+    totalPages: number;
+    size: number;
+    numberOfElements: number;
+    first: boolean;
+    last: boolean;
+    empty: boolean;
+    sort: Array<{
+        property: string;
+        direction: "ASC" | "DESC";
+    }>;
 }
 export interface UserGroup {
-    group_id: string;
-    group_name: string;
+    groupId: string;
+    name: string;
     description?: string;
+    type?: string;
     remark?: string;
 }
 export interface Role {
-    role_id: string;
-    role_name: string;
-    role_type?: string;
-    role_property?: Record<string, unknown>;
-    role_privileges?: Privilege[];
-    privilege_ids?: string[];
-    resource_ids?: string[];
-    expired_at?: string;
+    roleId: string;
+    roleName: string;
+    roleType?: string;
+    roleProperty?: Record<string, unknown>;
+    roleConfig?: Record<string, unknown>;
+    rolePrivileges?: Privilege[];
+    privilegeIds?: string[];
+    resourceIds?: string[];
+    expiredAt?: string;
     remark?: string;
 }
 export interface Privilege {
-    privilege_id: string;
-    privilege_name: string;
-    privilege_type?: string;
-    privilege_property?: Record<string, unknown>;
-    resource_ids?: string[];
-    expired_at?: string;
+    privilegeId: string;
+    privilegeName: string;
+    privilegeType?: string;
+    privilegeProperty?: Record<string, unknown>;
+    privilegeConfig?: Record<string, unknown>;
+    resourceIds?: string[];
+    expiredAt?: string;
     remark?: string;
 }
 export interface AppInfo {
-    app_id: string;
-    app_key: string;
-    app_name: string;
+    appId: string;
+    appKey: string;
+    appName: string;
+    appProperty?: Record<string, unknown>;
+    appRoles?: unknown[];
+    appPrivileges?: unknown[];
+    appAdmins?: Record<string, unknown>;
+    roleConfig?: Record<string, unknown>;
+    userGroupConfig?: Record<string, unknown>;
 }
 export interface User {
-    user_id: string;
-    open_id: string;
+    userId: string;
+    openId: string;
     username: string;
-    nick_name: string;
+    nickname: string;
     email: string;
     phone: string;
-    avatar_url?: string;
-    is_frozen: boolean;
-    created_at: string;
-    updated_at: string;
+    avatarUrl?: string;
+    isFrozen: boolean;
+    createdAt: string;
+    updatedAt: string;
     remark?: string;
 }
-/**
- * Attachment data (common type used across modules)
- */
-export interface Attachment {
-    attachment_id: string;
-    app_id: string;
-    attachment_type_id: string;
-    ref_id: string;
-    file_name: string;
-    file_url: string;
-    file_size: number;
-    mime_type: string;
-    remark?: string;
-    created_at: string;
-    updated_at: string;
-}

package/dist/index.d.ts

@@ -9,5 +9,8 @@ export * from "./user-attribute/index.js";
 export * from "./task-type/index.js";
 export * from "./task/index.js";
 export * from "./cms/index.js";
+export * from "./attachment/index.js";
+export * from "./attachment-type/index.js";
 export * from "./errors.js";
-export type { CommonOptions, PageResponse, UserGroup, Role, Privilege, AppInfo, User, Attachment, } from "./common/types.js";
+export type { CommonOptions, PageResponse, UserGroup, Role, Privilege, AppInfo, User, } from "./common/types.js";
+export type { Attachment, AttachmentRefType, ListAttachmentsByRefRequest, UploadAttachmentRequest, UploadAuthorizationRequest, CompleteUploadRequest, DeleteAttachmentRequest, DownloadAttachmentUrlRequest, DownloadUrlResponse, AttachmentOptions, } from "./attachment/types.js";

package/dist/index.js

@@ -9,4 +9,6 @@ export * from "./user-attribute/index.js";
 export * from "./task-type/index.js";
 export * from "./task/index.js";
 export * from "./cms/index.js";
+export * from "./attachment/index.js";
+export * from "./attachment-type/index.js";
 export * from "./errors.js";