@turinhub/tale-js-sdk 1.3.0

package/dist/task/index.d.ts

@@ -0,0 +1,163 @@
+import type { UserTask, CreateUserTaskRequest, UpdateUserTaskRequest, BatchCreateUserTasksRequest, BatchQueryUserTasksRequest, BatchCreateUserTasksResponse, ListUserTasksRequest, UpdateTaskStatusRequest, TaskStatistics, TaskStatusResponse, UserTaskOptions } from "./types.js";
+import type { PageResponse } from "../common/types.js";
+export type { UserTask, CreateUserTaskRequest, UpdateUserTaskRequest, BatchCreateUserTasksRequest, BatchQueryUserTasksRequest, BatchCreateUserTasksResponse, ListUserTasksRequest, UpdateTaskStatusRequest, TaskStatistics, TaskStatusResponse, UserTaskOptions, };
+/**
+ * Creates a new user task.
+ *
+ * @param request - Task creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function createUserTask(request: CreateUserTaskRequest, options?: UserTaskOptions): Promise<UserTask>;
+/**
+ * Batch creates user tasks.
+ *
+ * @param request - Batch creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to batch creation response
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function batchCreateUserTasks(request: BatchCreateUserTasksRequest, options?: UserTaskOptions): Promise<BatchCreateUserTasksResponse>;
+/**
+ * Gets a user task by ID.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration (include_attachments, include_sub_tasks)
+ * @returns Promise resolving to task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getUserTask(taskId: string, options?: UserTaskOptions & {
+    include_attachments?: boolean;
+    include_sub_tasks?: boolean;
+}): Promise<UserTask>;
+/**
+ * Batch gets user tasks by IDs.
+ *
+ * @param request - Batch query request
+ * @param options - Optional configuration
+ * @returns Promise resolving to array of tasks
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function batchGetUserTasks(request: BatchQueryUserTasksRequest, options?: UserTaskOptions): Promise<UserTask[]>;
+/**
+ * Lists user tasks with pagination and optional filtering.
+ *
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of tasks
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listUserTasks(request?: ListUserTasksRequest & UserTaskOptions): Promise<PageResponse<UserTask>>;
+/**
+ * Updates a user task.
+ *
+ * @param taskId - Task ID
+ * @param request - Update request
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateUserTask(taskId: string, request: UpdateUserTaskRequest, options?: UserTaskOptions): Promise<UserTask>;
+/**
+ * Deletes a user task.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteUserTask(taskId: string, options?: UserTaskOptions): Promise<void>;
+/**
+ * Gets task input data.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to task input data
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getTaskInput(taskId: string, options?: UserTaskOptions): Promise<Record<string, unknown>>;
+/**
+ * Gets task output data.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to task output data
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getTaskOutput(taskId: string, options?: UserTaskOptions): Promise<Record<string, unknown>>;
+/**
+ * Updates task input data.
+ *
+ * @param taskId - Task ID
+ * @param taskInput - New task input data
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateTaskInput(taskId: string, taskInput: Record<string, unknown>, options?: UserTaskOptions): Promise<UserTask>;
+/**
+ * Updates task output data.
+ *
+ * @param taskId - Task ID
+ * @param taskOutput - New task output data
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateTaskOutput(taskId: string, taskOutput: Record<string, unknown>, options?: UserTaskOptions): Promise<UserTask>;
+/**
+ * Gets task status.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to task status
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getTaskStatus(taskId: string, options?: UserTaskOptions): Promise<string>;
+/**
+ * Updates task status.
+ *
+ * @param taskId - Task ID
+ * @param request - Status update request
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateTaskStatus(taskId: string, request: UpdateTaskStatusRequest, options?: UserTaskOptions): Promise<UserTask>;
+/**
+ * Gets task statistics.
+ *
+ * @param userId - Optional user ID filter
+ * @param options - Optional configuration
+ * @returns Promise resolving to task statistics
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getTaskStatistics(userId?: string, options?: UserTaskOptions): Promise<TaskStatistics>;

package/dist/task/index.js

@@ -0,0 +1,495 @@
+import { getAppToken } from "../token.js";
+import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
+// ==================== Helper Functions ====================
+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 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(/\/+$/, "");
+}
+// ==================== UserTask CRUD Operations ====================
+/**
+ * Creates a new user task.
+ *
+ * @param request - Task creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function createUserTask(request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + "/user-task/v1/tasks");
+    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 user task: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to create user task", response.status);
+}
+/**
+ * Batch creates user tasks.
+ *
+ * @param request - Batch creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to batch creation response
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function batchCreateUserTasks(request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + "/user-task/v2/tasks/batch");
+    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 batch create user tasks: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to batch create user tasks", response.status);
+}
+/**
+ * Gets a user task by ID.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration (include_attachments, include_sub_tasks)
+ * @returns Promise resolving to task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getUserTask(taskId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}`);
+    const { appToken, baseUrl, ...queryParams } = options || {};
+    if (queryParams.include_attachments !== undefined) {
+        url.searchParams.append("include_attachments", String(queryParams.include_attachments));
+    }
+    if (queryParams.include_sub_tasks !== undefined) {
+        url.searchParams.append("include_sub_tasks", String(queryParams.include_sub_tasks));
+    }
+    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 user task: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get user task", response.status);
+}
+/**
+ * Batch gets user tasks by IDs.
+ *
+ * @param request - Batch query request
+ * @param options - Optional configuration
+ * @returns Promise resolving to array of tasks
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function batchGetUserTasks(request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + "/user-task/v1/tasks/batch");
+    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 batch get user tasks: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    const result = parseApiResponse(json, "Failed to batch get user tasks", response.status);
+    if (!Array.isArray(result)) {
+        throw new ApiError("Invalid batch get user tasks response: not an array", response.status);
+    }
+    return result;
+}
+/**
+ * Lists user tasks with pagination and optional filtering.
+ *
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of tasks
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function listUserTasks(request) {
+    const token = request?.appToken ?? (await getAppToken(request));
+    const base = getBaseUrl(request);
+    const url = new URL(base + "/user-task/v2/tasks");
+    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 user tasks: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list user tasks", response.status);
+}
+/**
+ * Updates a user task.
+ *
+ * @param taskId - Task ID
+ * @param request - Update request
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function updateUserTask(taskId, request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}`);
+    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 user task: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update user task", response.status);
+}
+/**
+ * Deletes a user task.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function deleteUserTask(taskId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}`);
+    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 user task: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError("Invalid user task deletion response", response.status);
+    }
+    const apiResponse = json;
+    if (apiResponse.code !== 200) {
+        const errorMsg = typeof apiResponse.msg === "string"
+            ? apiResponse.msg
+            : "Failed to delete user task";
+        throw new ApiError(errorMsg, response.status, apiResponse.code);
+    }
+}
+// ==================== Task Input/Output Operations ====================
+/**
+ * Gets task input data.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to task input data
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getTaskInput(taskId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}/input`);
+    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 task input: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get task input", response.status);
+}
+/**
+ * Gets task output data.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to task output data
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getTaskOutput(taskId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}/output`);
+    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 task output: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get task output", response.status);
+}
+/**
+ * Updates task input data.
+ *
+ * @param taskId - Task ID
+ * @param taskInput - New task input data
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function updateTaskInput(taskId, taskInput, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}/input`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(taskInput),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to update task input: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update task input", response.status);
+}
+/**
+ * Updates task output data.
+ *
+ * @param taskId - Task ID
+ * @param taskOutput - New task output data
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function updateTaskOutput(taskId, taskOutput, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}/output`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(taskOutput),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to update task output: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update task output", response.status);
+}
+// ==================== Task Status Operations ====================
+/**
+ * Gets task status.
+ *
+ * @param taskId - Task ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to task status
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getTaskStatus(taskId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}/status`);
+    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 task status: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    const result = parseApiResponse(json, "Failed to get task status", response.status);
+    return result.task_status;
+}
+/**
+ * Updates task status.
+ *
+ * @param taskId - Task ID
+ * @param request - Status update request
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated task
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function updateTaskStatus(taskId, request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + `/user-task/v1/tasks/${encodeURIComponent(taskId)}/status`);
+    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 task status: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update task status", response.status);
+}
+// ==================== Task Statistics ====================
+/**
+ * Gets task statistics.
+ *
+ * @param userId - Optional user ID filter
+ * @param options - Optional configuration
+ * @returns Promise resolving to task statistics
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getTaskStatistics(userId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const base = getBaseUrl(options);
+    const url = new URL(base + "/user-task/v1/tasks/statistics");
+    if (userId !== undefined) {
+        url.searchParams.append("user_id", userId);
+    }
+    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 task statistics: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get task statistics", response.status);
+}