@turinhub/tale-js-sdk 1.3.0 → 2.1.0

package/dist/attachment/index.js

@@ -0,0 +1,247 @@
+import { getAppToken } from "../token.js";
+import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
+function parseApiResponse(json, errorMessage, statusCode) {
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError(`Invalid response: ${errorMessage} - not an object`, statusCode);
+    }
+    const response = json;
+    if (response.code !== 200) {
+        const errorMsg = typeof response.msg === "string" ? response.msg : errorMessage;
+        throw new ApiError(errorMsg, statusCode, response.code);
+    }
+    if (!response.data) {
+        throw new ApiError(`Invalid response: ${errorMessage} - missing data`, statusCode);
+    }
+    return response.data;
+}
+function assertRequiredString(value, fieldName) {
+    if (!value || value.trim() === "") {
+        throw new ApiError(`${fieldName} is required`, 400, "9400");
+    }
+}
+function getBaseUrl(options) {
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    return String(base).replace(/\/+$/, "");
+}
+/** Get attachment by ID */
+export async function getAttachment(attachmentId, options) {
+    assertRequiredString(attachmentId, "attachmentId");
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/attachment/v2/attachments/${encodeURIComponent(attachmentId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get attachment: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get attachment", response.status);
+}
+/** List attachments by reference */
+export async function listAttachmentsByRef(request) {
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.refId, "refId");
+    const token = request.appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + "/attachment/v2/attachments/by-ref");
+    const { appToken, baseUrl, refType, refId, ...pagination } = request;
+    url.searchParams.append("refType", refType);
+    url.searchParams.append("refId", refId);
+    const queryParams = {
+        page: 0,
+        size: 20,
+        sort: "createdAt,desc",
+        ...pagination,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list attachments: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list attachments", response.status);
+}
+/** Upload attachment directly (multipart) */
+export async function uploadAttachment(request) {
+    assertRequiredString(request?.attachmentTypeId, "attachmentTypeId");
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.refId, "refId");
+    if (!request?.file) {
+        throw new ApiError("file is required", 400, "9400");
+    }
+    const { appToken, baseUrl, attachmentTypeId, refType, refId, file, remark } = request;
+    const token = appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + "/attachment/v2/attachments");
+    const formData = new FormData();
+    formData.append("attachmentTypeId", attachmentTypeId);
+    formData.append("refType", refType);
+    formData.append("refId", refId);
+    if (remark) {
+        formData.append("remark", remark);
+    }
+    if (typeof File !== "undefined" && file instanceof File) {
+        formData.append("file", file, file.name);
+    }
+    else {
+        formData.append("file", file);
+    }
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "POST",
+            headers: {
+                "x-t-token": token,
+            },
+            body: formData,
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to upload attachment: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to upload attachment", response.status);
+}
+/** Delete attachment */
+export async function deleteAttachment(request) {
+    assertRequiredString(request?.attachmentId, "attachmentId");
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.refId, "refId");
+    const { appToken, baseUrl, attachmentId, refType, refId } = request;
+    const token = appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + `/attachment/v2/attachments/${encodeURIComponent(attachmentId)}`);
+    url.searchParams.append("refType", refType);
+    url.searchParams.append("refId", refId);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "DELETE",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to delete attachment: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = (await response.json());
+    if (json.code !== 200) {
+        const errorMsg = typeof json.msg === "string" ? json.msg : "Failed to delete attachment";
+        throw new ApiError(errorMsg, response.status, json.code);
+    }
+}
+/** Get upload URL for two-phase upload */
+export async function getAttachmentUploadUrl(request) {
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.attachmentTypeId, "attachmentTypeId");
+    assertRequiredString(request?.refId, "refId");
+    assertRequiredString(request?.fileName, "fileName");
+    assertRequiredString(request?.fileType, "fileType");
+    const { appToken, baseUrl, ...body } = request;
+    const token = appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + "/attachment/v2/attachments/upload-url");
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(body),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get upload URL: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get upload URL", response.status);
+}
+/** Complete two-phase upload */
+export async function completeAttachmentUpload(attachmentId, request, options) {
+    assertRequiredString(attachmentId, "attachmentId");
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.refId, "refId");
+    assertRequiredString(request?.ossKey, "ossKey");
+    if (!request || request.fileSize === undefined || request.fileSize === null) {
+        throw new ApiError("fileSize is required", 400, "9400");
+    }
+    assertRequiredString(request.etag, "etag");
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base +
+        `/attachment/v2/attachments/${encodeURIComponent(attachmentId)}/complete`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to complete upload: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to complete upload", response.status);
+}
+/** Get download URL */
+export async function getAttachmentDownloadUrl(request) {
+    assertRequiredString(request?.attachmentId, "attachmentId");
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.refId, "refId");
+    const { appToken, baseUrl, attachmentId, refType, refId, expiresInSeconds = 3600, } = request;
+    const token = appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base +
+        `/attachment/v2/attachments/${encodeURIComponent(attachmentId)}/download-url`);
+    url.searchParams.append("refType", refType);
+    url.searchParams.append("refId", refId);
+    url.searchParams.append("expiresInSeconds", String(expiresInSeconds));
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get download URL: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get download URL", response.status);
+}

package/dist/attachment/types.d.ts

@@ -0,0 +1,82 @@
+import type { CommonOptions } from "../common/types.js";
+/** Discriminator for the domain entity an attachment belongs to. */
+export type AttachmentRefType = "task" | "cms_file" | "acl_record";
+export interface Attachment {
+    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;
+}
+export interface ListAttachmentsByRefRequest {
+    refType: AttachmentRefType;
+    refId: string;
+    page?: number;
+    size?: number;
+    sort?: string;
+}
+export interface UploadAttachmentRequest {
+    attachmentTypeId: string;
+    refType: AttachmentRefType;
+    refId: string;
+    file: File | Blob;
+    remark?: string;
+}
+export interface UploadAuthorizationRequest {
+    attachmentTypeId: string;
+    refType: AttachmentRefType;
+    refId: string;
+    fileName: string;
+    fileType: string;
+    mimeType?: string;
+    fileSize?: number;
+    remark?: string;
+    expireTimeInSeconds?: number;
+}
+export interface UploadAuthorizationResponse {
+    attachmentId: string;
+    ossKey: string;
+    uploadUrl: string;
+    fileName: string;
+    fileType: string;
+    expiresInSeconds: number;
+}
+export interface CompleteUploadRequest {
+    refType: AttachmentRefType;
+    refId: string;
+    ossKey: string;
+    fileSize: number;
+    etag: string;
+}
+export interface DeleteAttachmentRequest {
+    attachmentId: string;
+    refType: AttachmentRefType;
+    refId: string;
+}
+export interface DownloadAttachmentUrlRequest {
+    attachmentId: string;
+    refType: AttachmentRefType;
+    refId: string;
+    expiresInSeconds?: number;
+}
+export interface DownloadUrlResponse {
+    attachmentId: string;
+    fileName: string;
+    ossKey: string;
+    downloadUrl: string;
+    expiresInSeconds: number;
+}
+export interface AttachmentOptions extends CommonOptions {
+}

package/dist/attachment/types.js

@@ -0,0 +1 @@
+export {};

package/dist/attachment-type/index.d.ts

@@ -0,0 +1,15 @@
+import type { PageResponse } from "../common/types.js";
+import type { AttachmentType, CreateAttachmentTypeRequest, UpdateAttachmentTypeRequest, ListAttachmentTypesRequest, ListAttachmentTypesByRefRequest, AttachmentTypeOptions } from "./types.js";
+export type { AttachmentRefType, AttachmentType, CreateAttachmentTypeRequest, UpdateAttachmentTypeRequest, ListAttachmentTypesRequest, ListAttachmentTypesByRefRequest, AttachmentTypeOptions, } from "./types.js";
+/** List attachment types */
+export declare function listAttachmentTypes(request?: ListAttachmentTypesRequest & AttachmentTypeOptions): Promise<PageResponse<AttachmentType>>;
+/** List attachment types by reference */
+export declare function listAttachmentTypesByRef(request: ListAttachmentTypesByRefRequest & AttachmentTypeOptions): Promise<PageResponse<AttachmentType>>;
+/** Get attachment type by ID */
+export declare function getAttachmentType(typeId: string, options?: AttachmentTypeOptions): Promise<AttachmentType>;
+/** Create attachment type */
+export declare function createAttachmentType(request: CreateAttachmentTypeRequest, options?: AttachmentTypeOptions): Promise<AttachmentType>;
+/** Update attachment type */
+export declare function updateAttachmentType(typeId: string, request: UpdateAttachmentTypeRequest, options?: AttachmentTypeOptions): Promise<AttachmentType>;
+/** Delete attachment type */
+export declare function deleteAttachmentType(typeId: string, options?: AttachmentTypeOptions): Promise<void>;

package/dist/attachment-type/index.js

@@ -0,0 +1,203 @@
+import { getAppToken } from "../token.js";
+import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
+function parseApiResponse(json, errorMessage, statusCode) {
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError(`Invalid response: ${errorMessage} - not an object`, statusCode);
+    }
+    const response = json;
+    if (response.code !== 200) {
+        const errorMsg = typeof response.msg === "string" ? response.msg : errorMessage;
+        throw new ApiError(errorMsg, statusCode, response.code);
+    }
+    if (!response.data) {
+        throw new ApiError(`Invalid response: ${errorMessage} - missing data`, statusCode);
+    }
+    return response.data;
+}
+function assertRequiredString(value, fieldName) {
+    if (!value || value.trim() === "") {
+        throw new ApiError(`${fieldName} is required`, 400, "9400");
+    }
+}
+function getBaseUrl(options) {
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    return String(base).replace(/\/+$/, "");
+}
+/** List attachment types */
+export async function listAttachmentTypes(request) {
+    const token = request?.appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + "/attachment-type/v2/types");
+    const { appToken, baseUrl, ...requestParams } = request || {};
+    const queryParams = {
+        page: 0,
+        size: 20,
+        sort: "createdAt,desc",
+        ...requestParams,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list attachment types: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list attachment types", response.status);
+}
+/** List attachment types by reference */
+export async function listAttachmentTypesByRef(request) {
+    const refTypeId = request?.refTypeId?.trim();
+    const refType = request?.refType?.trim();
+    if (!refTypeId && !refType) {
+        throw new ApiError("At least one of refTypeId or refType is required", 400, "9400");
+    }
+    const token = request.appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + "/attachment-type/v2/types/by-ref");
+    const { appToken, baseUrl, refTypeId: _refTypeId, refType: _refType, ...pagination } = request;
+    if (refTypeId) {
+        url.searchParams.append("refTypeId", refTypeId);
+    }
+    if (refType) {
+        url.searchParams.append("refType", refType);
+    }
+    const queryParams = {
+        page: 0,
+        size: 20,
+        sort: "createdAt,desc",
+        ...pagination,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list attachment types by ref: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list attachment types by ref", response.status);
+}
+/** Get attachment type by ID */
+export async function getAttachmentType(typeId, options) {
+    assertRequiredString(typeId, "typeId");
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/attachment-type/v2/types/${encodeURIComponent(typeId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get attachment type: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get attachment type", response.status);
+}
+/** Create attachment type */
+export async function createAttachmentType(request, options) {
+    assertRequiredString(request?.refType, "refType");
+    assertRequiredString(request?.typeCode, "typeCode");
+    assertRequiredString(request?.typeName, "typeName");
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + "/attachment-type/v2/types");
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to create attachment type: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to create attachment type", response.status);
+}
+/** Update attachment type */
+export async function updateAttachmentType(typeId, request, options) {
+    assertRequiredString(typeId, "typeId");
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/attachment-type/v2/types/${encodeURIComponent(typeId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to update attachment type: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update attachment type", response.status);
+}
+/** Delete attachment type */
+export async function deleteAttachmentType(typeId, options) {
+    assertRequiredString(typeId, "typeId");
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/attachment-type/v2/types/${encodeURIComponent(typeId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "DELETE",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to delete attachment type: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = (await response.json());
+    if (json.code !== 200) {
+        const errorMsg = typeof json.msg === "string"
+            ? json.msg
+            : "Failed to delete attachment type";
+        throw new ApiError(errorMsg, response.status, json.code);
+    }
+}

package/dist/attachment-type/types.d.ts

@@ -0,0 +1,60 @@
+import type { CommonOptions } from "../common/types.js";
+export type { AttachmentRefType } from "../attachment/types.js";
+type AttachmentRefType = import("../attachment/types.js").AttachmentRefType;
+export interface AttachmentType {
+    typeId: string;
+    appId: string;
+    refType: string;
+    refTypeId?: string | null;
+    typeCode: string;
+    typeName: string;
+    description?: string;
+    allowedExtensions: string[];
+    allowedMimeTypes: string[];
+    maxFileSize: number;
+    isUnique: boolean;
+    isEnabled: boolean;
+    createdAt: string;
+    updatedAt: string;
+    remark?: string;
+}
+export interface CreateAttachmentTypeRequest {
+    refType: AttachmentRefType;
+    refTypeId?: string;
+    typeCode: string;
+    typeName: string;
+    description?: string;
+    allowedExtensions?: string[];
+    allowedMimeTypes?: string[];
+    maxFileSize?: number;
+    isUnique?: boolean;
+    isEnabled?: boolean;
+    remark?: string;
+}
+export interface UpdateAttachmentTypeRequest {
+    refType?: AttachmentRefType;
+    refTypeId?: string;
+    typeCode?: string;
+    typeName?: string;
+    description?: string;
+    allowedExtensions?: string[];
+    allowedMimeTypes?: string[];
+    maxFileSize?: number;
+    isUnique?: boolean;
+    isEnabled?: boolean;
+    remark?: string;
+}
+export interface ListAttachmentTypesRequest {
+    page?: number;
+    size?: number;
+    sort?: string;
+}
+export interface ListAttachmentTypesByRefRequest {
+    refTypeId?: string;
+    refType?: AttachmentRefType;
+    page?: number;
+    size?: number;
+    sort?: string;
+}
+export interface AttachmentTypeOptions extends CommonOptions {
+}

package/dist/attachment-type/types.js

@@ -0,0 +1 @@
+export {};