tale-js-sdk 0.1.2 → 0.1.3

package/dist/rbac/index.d.ts

@@ -0,0 +1,2 @@
+export * as rbac from './rbac.js';
+export type { CreateRoleRequest, UpdateRoleRequest, ListRolesRequest, CreateRoleResponse, UpdateRoleResponse, DeleteRoleResponse, GetRoleResponse, CreatePrivilegeRequest, UpdatePrivilegeRequest, ListPrivilegesRequest, CreatePrivilegeResponse, UpdatePrivilegeResponse, DeletePrivilegeResponse, GetPrivilegeResponse, RoleAssignment, PrivilegeAssignment, UserRoleAssignmentRequest, UserPrivilegeAssignmentRequest, RolePrivilegeAssignmentRequest, UserRoleUnassignmentRequest, UserPrivilegeUnassignmentRequest, RolePrivilegeUnassignmentRequest, AssignRolesResponse, UnassignRolesResponse, AssignPrivilegesResponse, UnassignPrivilegesResponse, GetUserRolesResponse, GetUserPrivilegesResponse, PrivilegeRolePair, ResourcePermissionCheck, GetResourcePrivilegeRolesResponse, RBACOptions } from './types.js';

package/dist/rbac/index.js

@@ -0,0 +1,2 @@
+// 导出 RBAC 功能函数，使用命名空间避免与现有模块冲突
+export * as rbac from './rbac.js';

package/dist/rbac/rbac.d.ts

@@ -0,0 +1,198 @@
+import type { Role, CreateRoleRequest, UpdateRoleRequest, ListRolesRequest, CreateRoleResponse, UpdateRoleResponse, DeleteRoleResponse, GetRoleResponse, Privilege, CreatePrivilegeRequest, UpdatePrivilegeRequest, ListPrivilegesRequest, CreatePrivilegeResponse, UpdatePrivilegeResponse, DeletePrivilegeResponse, GetPrivilegeResponse, UserRoleAssignmentRequest, UserPrivilegeAssignmentRequest, UserRoleUnassignmentRequest, UserPrivilegeUnassignmentRequest, AssignRolesResponse, UnassignRolesResponse, AssignPrivilegesResponse, UnassignPrivilegesResponse, GetUserRolesResponse, GetUserPrivilegesResponse, PaginatedResponse, CommonOptions } from './types.js';
+/**
+ * Creates a new role in the Tale application.
+ *
+ * @param roleData - Role data to create the new role
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created role 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 { createRole } from '@tale/client';
+ *
+ * try {
+ *   const result = await createRole({
+ *     role_name: 'Admin',
+ *     role_type: 'system',
+ *     privilege_ids: ['privilege1', 'privilege2'],
+ *     remark: 'System administrator role'
+ *   });
+ *   console.log('Role created:', result.role.role_id);
+ * } catch (error) {
+ *   console.error('Failed to create role:', error.message);
+ * }
+ * ```
+ */
+export declare function createRole(roleData: CreateRoleRequest, options?: CommonOptions): Promise<CreateRoleResponse>;
+/**
+ * Updates an existing role by ID.
+ *
+ * @param roleId - Role ID to update
+ * @param updateData - Role information to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the updated role 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 updateRole(roleId: string, updateData: UpdateRoleRequest, options?: CommonOptions): Promise<UpdateRoleResponse>;
+/**
+ * Deletes a role by ID.
+ *
+ * @param roleId - Role 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 deleteRole(roleId: string, options?: CommonOptions): Promise<DeleteRoleResponse>;
+/**
+ * Retrieves role information by ID.
+ *
+ * @param roleId - Role ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the role 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 getRoleById(roleId: string, options?: CommonOptions): Promise<GetRoleResponse>;
+/**
+ * Lists roles with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated role 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 listRoles(options?: ListRolesRequest & CommonOptions): Promise<PaginatedResponse<Role>>;
+/**
+ * Creates a new privilege in the Tale application.
+ *
+ * @param privilegeData - Privilege data to create the new privilege
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created privilege 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 createPrivilege(privilegeData: CreatePrivilegeRequest, options?: CommonOptions): Promise<CreatePrivilegeResponse>;
+/**
+ * Updates an existing privilege by ID.
+ *
+ * @param privilegeId - Privilege ID to update
+ * @param updateData - Privilege information to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the updated privilege 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 updatePrivilege(privilegeId: string, updateData: UpdatePrivilegeRequest, options?: CommonOptions): Promise<UpdatePrivilegeResponse>;
+/**
+ * Deletes a privilege by ID.
+ *
+ * @param privilegeId - Privilege 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 deletePrivilege(privilegeId: string, options?: CommonOptions): Promise<DeletePrivilegeResponse>;
+/**
+ * Retrieves privilege information by ID.
+ *
+ * @param privilegeId - Privilege ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the privilege 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 getPrivilegeById(privilegeId: string, options?: CommonOptions): Promise<GetPrivilegeResponse>;
+/**
+ * Lists privileges with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated privilege 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 listPrivileges(options?: ListPrivilegesRequest & CommonOptions): Promise<PaginatedResponse<Privilege>>;
+/**
+ * Assigns roles to a user.
+ *
+ * @param userId - User ID to assign roles to
+ * @param assignmentData - Role assignment data
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the assigned roles
+ * @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 assignRolesToUser(userId: string, assignmentData: UserRoleAssignmentRequest, options?: CommonOptions): Promise<AssignRolesResponse>;
+/**
+ * Unassigns roles from a user.
+ *
+ * @param userId - User ID to unassign roles from
+ * @param unassignmentData - Role unassignment data
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the unassignment 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 unassignRolesFromUser(userId: string, unassignmentData: UserRoleUnassignmentRequest, options?: CommonOptions): Promise<UnassignRolesResponse>;
+/**
+ * Assigns privileges to a user.
+ *
+ * @param userId - User ID to assign privileges to
+ * @param assignmentData - Privilege assignment data
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the assigned privileges
+ * @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 assignPrivilegesToUser(userId: string, assignmentData: UserPrivilegeAssignmentRequest, options?: CommonOptions): Promise<AssignPrivilegesResponse>;
+/**
+ * Unassigns privileges from a user.
+ *
+ * @param userId - User ID to unassign privileges from
+ * @param unassignmentData - Privilege unassignment data
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the unassignment 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 unassignPrivilegesFromUser(userId: string, unassignmentData: UserPrivilegeUnassignmentRequest, options?: CommonOptions): Promise<UnassignPrivilegesResponse>;
+/**
+ * Gets the roles assigned to a user.
+ *
+ * @param userId - User ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the user's roles
+ * @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 getUserRoles(userId: string, options?: CommonOptions): Promise<GetUserRolesResponse>;
+/**
+ * Gets the privileges assigned to a user.
+ *
+ * @param userId - User ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the user's privileges
+ * @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 getUserPrivileges(userId: string, options?: CommonOptions): Promise<GetUserPrivilegesResponse>;