tale-js-sdk 0.1.2 → 0.1.3

package/dist/acl/index.d.ts

@@ -0,0 +1,170 @@
+import type { AclRecord, CreateAclRecordRequest, UpdateAclRecordRequest, ListAclRecordsRequest, CreateAclRecordResponse, UpdateAclRecordResponse, DeleteAclRecordResponse, GetAclRecordResponse, AclTemplate, CreateAclTemplateRequest, UpdateAclTemplateRequest, ListAclTemplatesRequest, CreateAclTemplateResponse, UpdateAclTemplateResponse, DeleteAclTemplateResponse, GetAclTemplateResponse, PaginatedResponse, AclOptions } from './types.js';
+/**
+ * Creates a new ACL record in the Tale application.
+ *
+ * @param recordData - ACL record data to create
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created ACL record information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createRecord } 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);
+ * } catch (error) {
+ *   console.error('Failed to create ACL record:', error.message);
+ * }
+ * ```
+ */
+export declare function createRecord(recordData: CreateAclRecordRequest, options?: AclOptions): Promise<CreateAclRecordResponse>;
+/**
+ * Updates an existing ACL record by ID.
+ *
+ * @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
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateRecord(recordId: string, updateData: UpdateAclRecordRequest, options?: AclOptions): Promise<UpdateAclRecordResponse>;
+/**
+ * Deletes an ACL record by ID.
+ *
+ * @param recordId - ACL record ID to delete
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the deletion result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteRecord(recordId: string, options?: AclOptions): Promise<DeleteAclRecordResponse>;
+/**
+ * Retrieves ACL record information by ID.
+ *
+ * @param recordId - ACL record ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the ACL record information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getRecordById(recordId: string, options?: AclOptions): Promise<GetAclRecordResponse>;
+/**
+ * Lists ACL records with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated ACL record list with metadata
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listRecords(options?: ListAclRecordsRequest & AclOptions): Promise<PaginatedResponse<AclRecord>>;
+/**
+ * Creates a new ACL template in the Tale application.
+ *
+ * @param templateData - ACL template data to create
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created ACL template information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createTemplate } 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);
+ * } catch (error) {
+ *   console.error('Failed to create ACL template:', error.message);
+ * }
+ * ```
+ */
+export declare function createTemplate(templateData: CreateAclTemplateRequest, options?: AclOptions): Promise<CreateAclTemplateResponse>;
+/**
+ * Updates an existing ACL template by ID.
+ *
+ * @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
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateTemplate(templateId: string, updateData: UpdateAclTemplateRequest, options?: AclOptions): Promise<UpdateAclTemplateResponse>;
+/**
+ * Deletes an ACL template by ID.
+ *
+ * @param templateId - ACL template ID or code to delete
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the deletion result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteTemplate(templateId: string, options?: AclOptions): Promise<DeleteAclTemplateResponse>;
+/**
+ * Retrieves ACL template information by ID or code.
+ *
+ * @param templateId - ACL template ID or code to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the ACL template information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getTemplateById(templateId: string, options?: AclOptions): Promise<GetAclTemplateResponse>;
+/**
+ * Lists ACL templates with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated ACL template list with metadata
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+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';
+/**
+ * ACL 核心工具函数，包含跨应用通用的业务逻辑
+ */
+export declare const AclCoreUtils: {
+    /**
+     * 验证优先级范围
+     */
+    validatePriority(priority: number): boolean;
+    /**
+     * 获取可用的效果类型
+     */
+    getEffectTypes(): ("allow" | "deny" | "inherit")[];
+    /**
+     * 获取可用的主体类型
+     */
+    getSubjectTypes(): ("user" | "role" | "group")[];
+};