tale-js-sdk 0.1.4 → 1.1.0

package/dist/acl/index.d.ts

@@ -1,170 +1,300 @@
-import type { AclRecord, CreateAclRecordRequest, UpdateAclRecordRequest, ListAclRecordsRequest, CreateAclRecordResponse, UpdateAclRecordResponse, DeleteAclRecordResponse, GetAclRecordResponse, AclTemplate, CreateAclTemplateRequest, UpdateAclTemplateRequest, ListAclTemplatesRequest, CreateAclTemplateResponse, UpdateAclTemplateResponse, DeleteAclTemplateResponse, GetAclTemplateResponse, PaginatedResponse, AclOptions } from './types.js';
+import type { AclRecord, CreateAclRecordRequest, UpdateAclRecordRequest, ListAclRecordsRequest, AclBatchCreateResponse, AclTemplate, CreateAclTemplateRequest, UpdateAclTemplateRequest, ListAclTemplatesRequest, AclOptions } from "./types.js";
+export type { AclRecord, CreateAclRecordRequest, UpdateAclRecordRequest, ListAclRecordsRequest, AclBatchCreateResponse, AclTemplate, CreateAclTemplateRequest, UpdateAclTemplateRequest, ListAclTemplatesRequest, AclOptions, };
 /**
- * Creates a new ACL record in the Tale application.
+ * Gets an ACL record by ID.
  *
- * @param recordData - ACL record data to create
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the created ACL record information
+ * @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 or returns invalid response
+ * @throws {ApiError} When API request fails
  * @throws {NetworkError} When network request fails
  *
  * @example
  * ```typescript
- * import { createRecord } from '@tale/client';
+ * import { getAclRecord } from '@tale/client';
  *
  * try {
- *   const result = await createRecord({
- *     template_id: 'template_user_read',
- *     subject_type: 'user',
- *     subject_id: 'user_123',
- *     resource_type: 'document',
- *     resource_id: 'doc_456',
- *     effect_type: 'allow',
- *     priority: 50,
- *     description: 'Allow user to read document'
- *   });
- *   console.log('ACL record created:', result.record.record_id);
+ *   const record = await getAclRecord('record_id_here');
+ *   console.log('Record effect:', record.effect_type);
  * } catch (error) {
- *   console.error('Failed to create ACL record:', error.message);
+ *   console.error('Failed to get ACL record:', error.message);
  * }
  * ```
  */
-export declare function createRecord(recordData: CreateAclRecordRequest, options?: AclOptions): Promise<CreateAclRecordResponse>;
+export declare function getAclRecord(recordId: string, options?: AclOptions): Promise<AclRecord>;
 /**
- * Updates an existing ACL record by ID.
+ * Lists ACL records with pagination and optional filtering.
  *
- * @param recordId - ACL record ID to update
- * @param updateData - ACL record information to update
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the updated ACL record information
+ * @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 or returns invalid response
+ * @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.totalElements} records`);
+ * } catch (error) {
+ *   console.error('Failed to list ACL records:', error.message);
+ * }
+ * ```
  */
-export declare function updateRecord(recordId: string, updateData: UpdateAclRecordRequest, options?: AclOptions): Promise<UpdateAclRecordResponse>;
+export declare function listAclRecords(options?: ListAclRecordsRequest & AclOptions): Promise<{
+    content: AclRecord[];
+    totalElements: number;
+}>;
 /**
- * Deletes an ACL record by ID.
+ * Creates a new ACL record.
  *
- * @param recordId - ACL record ID to delete
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the deletion result
+ * @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 or returns invalid response
+ * @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 declare function deleteRecord(recordId: string, options?: AclOptions): Promise<DeleteAclRecordResponse>;
+export declare function createAclRecord(request: CreateAclRecordRequest, options?: AclOptions): Promise<AclRecord>;
 /**
- * Retrieves ACL record information by ID.
+ * Batch creates ACL records.
  *
- * @param recordId - ACL record ID to query
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the ACL record information
+ * @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 or returns invalid response
+ * @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 declare function getRecordById(recordId: string, options?: AclOptions): Promise<GetAclRecordResponse>;
+export declare function batchCreateAclRecords(requests: CreateAclRecordRequest[], options?: AclOptions): Promise<AclBatchCreateResponse>;
 /**
- * Lists ACL records with pagination and filtering.
+ * Updates an existing ACL record.
  *
- * @param options - Optional parameters for pagination, filtering, and configuration
- * @returns Promise resolving to paginated ACL record list with metadata
+ * @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 or returns invalid response
+ * @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 declare function listRecords(options?: ListAclRecordsRequest & AclOptions): Promise<PaginatedResponse<AclRecord>>;
+export declare function updateAclRecord(recordId: string, request: UpdateAclRecordRequest, options?: AclOptions): Promise<AclRecord>;
 /**
- * Creates a new ACL template in the Tale application.
+ * Deletes an ACL record.
  *
- * @param templateData - ACL template data to create
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the created ACL template information
+ * @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 or returns invalid response
+ * @throws {ApiError} When API request fails
  * @throws {NetworkError} When network request fails
  *
  * @example
  * ```typescript
- * import { createTemplate } from '@tale/client';
+ * import { deleteAclRecord } from '@tale/client';
  *
  * try {
- *   const result = await createTemplate({
- *     template_name: 'User Document Read Template',
- *     template_code: 'user_doc_read',
- *     subject_type: 'user',
- *     resource_type: 'document',
- *     effect_type: 'allow',
- *     default_priority: 30,
- *     description: 'Template for allowing users to read documents'
- *   });
- *   console.log('ACL template created:', result.template.template_id);
+ *   await deleteAclRecord('record_id_here');
+ *   console.log('ACL record deleted successfully');
  * } catch (error) {
- *   console.error('Failed to create ACL template:', error.message);
+ *   console.error('Failed to delete ACL record:', error.message);
  * }
  * ```
  */
-export declare function createTemplate(templateData: CreateAclTemplateRequest, options?: AclOptions): Promise<CreateAclTemplateResponse>;
+export declare function deleteAclRecord(recordId: string, options?: AclOptions): Promise<void>;
 /**
- * Updates an existing ACL template by ID.
+ * Gets an ACL template by ID or code.
  *
- * @param templateId - ACL template ID or code to update
- * @param updateData - ACL template information to update
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the updated ACL template information
+ * @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 or returns invalid response
+ * @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 declare function updateTemplate(templateId: string, updateData: UpdateAclTemplateRequest, options?: AclOptions): Promise<UpdateAclTemplateResponse>;
+export declare function getAclTemplate(templateId: string, options?: AclOptions): Promise<AclTemplate>;
 /**
- * Deletes an ACL template by ID.
+ * Lists ACL templates with pagination and optional filtering.
  *
- * @param templateId - ACL template ID or code to delete
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the deletion result
+ * @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 or returns invalid response
+ * @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.totalElements} templates`);
+ * } catch (error) {
+ *   console.error('Failed to list ACL templates:', error.message);
+ * }
+ * ```
  */
-export declare function deleteTemplate(templateId: string, options?: AclOptions): Promise<DeleteAclTemplateResponse>;
+export declare function listAclTemplates(options?: ListAclTemplatesRequest & AclOptions): Promise<{
+    content: AclTemplate[];
+    totalElements: number;
+}>;
 /**
- * Retrieves ACL template information by ID or code.
+ * Creates a new ACL template.
  *
- * @param templateId - ACL template ID or code to query
- * @param options - Optional configuration for the request
- * @returns Promise resolving to the ACL template information
+ * @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 or returns invalid response
+ * @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 declare function getTemplateById(templateId: string, options?: AclOptions): Promise<GetAclTemplateResponse>;
+export declare function createAclTemplate(request: CreateAclTemplateRequest, options?: AclOptions): Promise<AclTemplate>;
 /**
- * Lists ACL templates with pagination and filtering.
+ * Updates an existing ACL template.
  *
- * @param options - Optional parameters for pagination, filtering, and configuration
- * @returns Promise resolving to paginated ACL template list with metadata
+ * @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 or returns invalid response
+ * @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 declare function listTemplates(options?: ListAclTemplatesRequest & AclOptions): Promise<PaginatedResponse<AclTemplate>>;
-export type { PaginatedResponse, AclOptions, AclRecord, CreateAclRecordRequest, UpdateAclRecordRequest, ListAclRecordsRequest, CreateAclRecordResponse, UpdateAclRecordResponse, DeleteAclRecordResponse, GetAclRecordResponse, AclTemplate, CreateAclTemplateRequest, UpdateAclTemplateRequest, ListAclTemplatesRequest, CreateAclTemplateResponse, UpdateAclTemplateResponse, DeleteAclTemplateResponse, GetAclTemplateResponse } from './types.js';
+export declare function updateAclTemplate(templateId: string, request: UpdateAclTemplateRequest, options?: AclOptions): Promise<AclTemplate>;
 /**
- * ACL 核心工具函数，包含跨应用通用的业务逻辑
+ * 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 declare const AclCoreUtils: {
-    /**
-     * 验证优先级范围
-     */
-    validatePriority(priority: number): boolean;
-    /**
-     * 获取可用的效果类型
-     */
-    getEffectTypes(): ("allow" | "deny" | "inherit")[];
-    /**
-     * 获取可用的主体类型
-     */
-    getSubjectTypes(): ("user" | "role" | "group")[];
-};
+export declare function deleteAclTemplate(templateId: string, options?: AclOptions): Promise<void>;