@turinhub/tale-js-sdk 1.3.0

package/dist/acl/index.js

@@ -0,0 +1,653 @@
+import { getAppToken } from "../token.js";
+import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
+// ==================== Helper Functions ====================
+/**
+ * Parses standard API response format: { code, msg, data }
+ */
+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;
+}
+// ==================== ACL Record Management (v2) ====================
+/**
+ * Gets an ACL record by ID.
+ *
+ * @param recordId - Record ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to ACL record information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getAclRecord } from '@tale/client';
+ *
+ * try {
+ *   const record = await getAclRecord('record_id_here');
+ *   console.log('Record effect:', record.effect_type);
+ * } catch (error) {
+ *   console.error('Failed to get ACL record:', error.message);
+ * }
+ * ```
+ */
+export async function getAclRecord(recordId, options) {
+    if (!recordId || recordId.trim() === "") {
+        throw new ApiError("record_id is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") +
+        `/acl/v2/records/${encodeURIComponent(recordId)}`;
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get ACL record: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get ACL record", response.status);
+}
+/**
+ * Lists ACL records with pagination and optional filtering.
+ *
+ * @param options - Optional parameters for pagination and filtering
+ * @returns Promise resolving to paginated ACL record list
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listAclRecords } from '@tale/client';
+ *
+ * try {
+ *   const result = await listAclRecords({
+ *     page: 0,
+ *     size: 20,
+ *     resource_type: 'document'
+ *   });
+ *   console.log(`Found ${result.total} records`);
+ * } catch (error) {
+ *   console.error('Failed to list ACL records:', error.message);
+ * }
+ * ```
+ */
+export async function listAclRecords(options) {
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") + "/acl/v2/records");
+    // 分离 AclOptions 字段，只保留请求参数
+    const { appToken, baseUrl, ...requestParams } = options || {};
+    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 ACL records: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list ACL records", response.status);
+}
+/**
+ * Creates a new ACL record.
+ *
+ * @param request - ACL record creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created ACL record
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createAclRecord } from '@tale/client';
+ *
+ * try {
+ *   const record = await createAclRecord({
+ *     subject_type: 'user',
+ *     subject_id: 'user123',
+ *     resource_type: 'document',
+ *     resource_id: 'doc456',
+ *     effect_type: 'allow'
+ *   });
+ *   console.log('Record created:', record.record_id);
+ * } catch (error) {
+ *   console.error('Failed to create ACL record:', error.message);
+ * }
+ * ```
+ */
+export async function createAclRecord(request, options) {
+    if (!request.subject_type || request.subject_type.trim() === "") {
+        throw new ApiError("subject_type is required", 400, "9400");
+    }
+    if (!request.resource_type || request.resource_type.trim() === "") {
+        throw new ApiError("resource_type is required", 400, "9400");
+    }
+    if (!request.effect_type || request.effect_type.trim() === "") {
+        throw new ApiError("effect_type is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") + "/acl/v2/records";
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to create ACL record: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to create ACL record", response.status);
+}
+/**
+ * Batch creates ACL records.
+ *
+ * @param requests - Array of ACL record creation requests
+ * @param options - Optional configuration
+ * @returns Promise resolving to batch creation response with success/failure details
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { batchCreateAclRecords } from '@tale/client';
+ *
+ * try {
+ *   const result = await batchCreateAclRecords([
+ *     {
+ *       subject_type: 'user',
+ *       subject_id: 'user1',
+ *       resource_type: 'document',
+ *       effect_type: 'allow'
+ *     },
+ *     {
+ *       subject_type: 'user',
+ *       subject_id: 'user2',
+ *       resource_type: 'document',
+ *       effect_type: 'deny'
+ *     }
+ *   ]);
+ *   console.log(`Created ${result.success_count}, Failed ${result.failure_count}`);
+ * } catch (error) {
+ *   console.error('Failed to batch create ACL records:', error.message);
+ * }
+ * ```
+ */
+export async function batchCreateAclRecords(requests, options) {
+    if (!Array.isArray(requests) || requests.length === 0) {
+        throw new ApiError("requests is required and must be a non-empty array", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") + "/acl/v2/records/batch";
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(requests),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to batch create ACL records: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to batch create ACL records", response.status);
+}
+/**
+ * Updates an existing ACL record.
+ *
+ * @param recordId - Record ID to update
+ * @param request - Update request with fields to modify
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated ACL record
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateAclRecord } from '@tale/client';
+ *
+ * try {
+ *   const record = await updateAclRecord('record_id_here', {
+ *     effect_type: 'deny',
+ *     priority: 100
+ *   });
+ *   console.log('Record updated:', record.record_id);
+ * } catch (error) {
+ *   console.error('Failed to update ACL record:', error.message);
+ * }
+ * ```
+ */
+export async function updateAclRecord(recordId, request, options) {
+    if (!recordId || recordId.trim() === "") {
+        throw new ApiError("record_id is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") +
+        `/acl/v2/records/${encodeURIComponent(recordId)}`;
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to update ACL record: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update ACL record", response.status);
+}
+/**
+ * Deletes an ACL record.
+ *
+ * @param recordId - Record ID to delete
+ * @param options - Optional configuration
+ * @returns Promise that resolves when deletion is successful
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { deleteAclRecord } from '@tale/client';
+ *
+ * try {
+ *   await deleteAclRecord('record_id_here');
+ *   console.log('ACL record deleted successfully');
+ * } catch (error) {
+ *   console.error('Failed to delete ACL record:', error.message);
+ * }
+ * ```
+ */
+export async function deleteAclRecord(recordId, options) {
+    if (!recordId || recordId.trim() === "") {
+        throw new ApiError("record_id is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") +
+        `/acl/v2/records/${encodeURIComponent(recordId)}`;
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "DELETE",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to delete ACL record: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    // Delete response may not have data field, handle differently
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError("Invalid ACL record deletion response", response.status);
+    }
+    const apiResponse = json;
+    if (apiResponse.code !== 200) {
+        const errorMsg = typeof apiResponse.msg === "string"
+            ? apiResponse.msg
+            : "Failed to delete ACL record";
+        throw new ApiError(errorMsg, response.status, apiResponse.code);
+    }
+}
+// ==================== ACL Template Management ====================
+/**
+ * Gets an ACL template by ID or code.
+ *
+ * @param templateId - Template ID or code
+ * @param options - Optional configuration
+ * @returns Promise resolving to ACL template information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getAclTemplate } from '@tale/client';
+ *
+ * try {
+ *   const template = await getAclTemplate('template_code_here');
+ *   console.log('Template name:', template.template_name);
+ * } catch (error) {
+ *   console.error('Failed to get ACL template:', error.message);
+ * }
+ * ```
+ */
+export async function getAclTemplate(templateId, options) {
+    if (!templateId || templateId.trim() === "") {
+        throw new ApiError("template_id is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") +
+        `/acl/v1/templates/${encodeURIComponent(templateId)}`;
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get ACL template: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get ACL template", response.status);
+}
+/**
+ * Lists ACL templates with pagination and optional filtering.
+ *
+ * @param options - Optional parameters for pagination and filtering
+ * @returns Promise resolving to paginated ACL template list
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listAclTemplates } from '@tale/client';
+ *
+ * try {
+ *   const result = await listAclTemplates({
+ *     page: 0,
+ *     size: 20,
+ *     resource_type: 'document'
+ *   });
+ *   console.log(`Found ${result.total} templates`);
+ * } catch (error) {
+ *   console.error('Failed to list ACL templates:', error.message);
+ * }
+ * ```
+ */
+export async function listAclTemplates(options) {
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") + "/acl/v2/templates");
+    // 分离 AclOptions 字段，只保留请求参数
+    const { appToken, baseUrl, ...requestParams } = options || {};
+    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 ACL templates: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list ACL templates", response.status);
+}
+/**
+ * Creates a new ACL template.
+ *
+ * @param request - ACL template creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created ACL template
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createAclTemplate } from '@tale/client';
+ *
+ * try {
+ *   const template = await createAclTemplate({
+ *     template_name: 'Document Access',
+ *     template_code: 'doc_access',
+ *     subject_type: 'user',
+ *     resource_type: 'document',
+ *     effect_type: 'allow'
+ *   });
+ *   console.log('Template created:', template.template_id);
+ * } catch (error) {
+ *   console.error('Failed to create ACL template:', error.message);
+ * }
+ * ```
+ */
+export async function createAclTemplate(request, options) {
+    if (!request.template_name || request.template_name.trim() === "") {
+        throw new ApiError("template_name is required", 400, "9400");
+    }
+    if (!request.template_code || request.template_code.trim() === "") {
+        throw new ApiError("template_code is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") + "/acl/v1/templates";
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to create ACL template: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to create ACL template", response.status);
+}
+/**
+ * Updates an existing ACL template.
+ *
+ * @param templateId - Template ID or code to update
+ * @param request - Update request with fields to modify
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated ACL template
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateAclTemplate } from '@tale/client';
+ *
+ * try {
+ *   const template = await updateAclTemplate('template_code_here', {
+ *     template_name: 'Updated Template Name',
+ *     effect_type: 'deny'
+ *   });
+ *   console.log('Template updated:', template.template_id);
+ * } catch (error) {
+ *   console.error('Failed to update ACL template:', error.message);
+ * }
+ * ```
+ */
+export async function updateAclTemplate(templateId, request, options) {
+    if (!templateId || templateId.trim() === "") {
+        throw new ApiError("template_id is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") +
+        `/acl/v1/templates/${encodeURIComponent(templateId)}`;
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to update ACL template: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update ACL template", response.status);
+}
+/**
+ * Deletes an ACL template.
+ *
+ * @param templateId - Template ID or code to delete
+ * @param options - Optional configuration
+ * @returns Promise that resolves when deletion is successful
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { deleteAclTemplate } from '@tale/client';
+ *
+ * try {
+ *   await deleteAclTemplate('template_code_here');
+ *   console.log('ACL template deleted successfully');
+ * } catch (error) {
+ *   console.error('Failed to delete ACL template:', error.message);
+ * }
+ * ```
+ */
+export async function deleteAclTemplate(templateId, options) {
+    if (!templateId || templateId.trim() === "") {
+        throw new ApiError("template_id is required", 400, "9400");
+    }
+    const token = options?.appToken ?? (await getAppToken(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");
+    }
+    const url = String(base).replace(/\/+$/, "") +
+        `/acl/v1/templates/${encodeURIComponent(templateId)}`;
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "DELETE",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to delete ACL template: ${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 ACL template";
+        throw new ApiError(errorMsg, response.status, json.code);
+    }
+}