tale-js-sdk 0.1.4 → 1.0.0

package/dist/rbac/index.d.ts

@@ -1,2 +1,464 @@
-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';
+import type { Role, Privilege, CreateRoleRequest, UpdateRoleRequest, CreatePrivilegeRequest, UpdatePrivilegeRequest, UserRoleAssignmentRequest, UserRoleUnassignmentRequest, UserPrivilegeAssignmentRequest, UserPrivilegeUnassignmentRequest, RolePrivilegeAssignmentRequest, RolePrivilegeUnassignmentRequest, RbacOptions, ListRolesRequest, ListPrivilegesRequest, PrivilegeRolePair } from "./types.js";
+export type { Role, Privilege, CreateRoleRequest, UpdateRoleRequest, CreatePrivilegeRequest, UpdatePrivilegeRequest, UserRoleAssignmentRequest, UserRoleUnassignmentRequest, UserPrivilegeAssignmentRequest, UserPrivilegeUnassignmentRequest, RolePrivilegeAssignmentRequest, RolePrivilegeUnassignmentRequest, RbacOptions, ListRolesRequest, ListPrivilegesRequest, PrivilegeRolePair, };
+/**
+ * Gets a role by ID.
+ *
+ * @param roleId - Role ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to role information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getRole } from '@tale/client';
+ *
+ * try {
+ *   const role = await getRole('role_id_here');
+ *   console.log('Role name:', role.role_name);
+ * } catch (error) {
+ *   console.error('Failed to get role:', error.message);
+ * }
+ * ```
+ */
+export declare function getRole(roleId: string, options?: RbacOptions): Promise<Role>;
+/**
+ * Lists roles with pagination and optional filtering.
+ *
+ * @param options - Optional parameters for pagination and filtering
+ * @returns Promise resolving to paginated role list
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listRoles } from '@tale/client';
+ *
+ * try {
+ *   const result = await listRoles({
+ *     page: 0,
+ *     size: 20,
+ *     role_type: 'admin'
+ *   });
+ *   console.log(`Found ${result.totalElements} roles`);
+ * } catch (error) {
+ *   console.error('Failed to list roles:', error.message);
+ * }
+ * ```
+ */
+export declare function listRoles(options?: ListRolesRequest & RbacOptions): Promise<{
+    content: Role[];
+    totalElements: number;
+}>;
+/**
+ * Creates a new role.
+ *
+ * @param request - Role creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created role
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createRole } from '@tale/client';
+ *
+ * try {
+ *   const role = await createRole({
+ *     roleName: 'Administrator',
+ *     role_type: 'admin',
+ *     privilege_ids: ['priv1', 'priv2']
+ *   });
+ *   console.log('Role created:', role.role_id);
+ * } catch (error) {
+ *   console.error('Failed to create role:', error.message);
+ * }
+ * ```
+ */
+export declare function createRole(request: CreateRoleRequest, options?: RbacOptions): Promise<Role>;
+/**
+ * Updates an existing role.
+ *
+ * @param roleId - Role ID to update
+ * @param request - Update request with fields to modify
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated role
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updateRole } from '@tale/client';
+ *
+ * try {
+ *   const role = await updateRole('role_id_here', {
+ *     roleName: 'Updated Role Name',
+ *     remark: 'Updated description'
+ *   });
+ *   console.log('Role updated:', role.role_name);
+ * } catch (error) {
+ *   console.error('Failed to update role:', error.message);
+ * }
+ * ```
+ */
+export declare function updateRole(roleId: string, request: UpdateRoleRequest, options?: RbacOptions): Promise<Role>;
+/**
+ * Deletes a role.
+ *
+ * @param roleId - Role 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 { deleteRole } from '@tale/client';
+ *
+ * try {
+ *   await deleteRole('role_id_here');
+ *   console.log('Role deleted successfully');
+ * } catch (error) {
+ *   console.error('Failed to delete role:', error.message);
+ * }
+ * ```
+ */
+export declare function deleteRole(roleId: string, options?: RbacOptions): Promise<void>;
+/**
+ * Gets a privilege by ID.
+ *
+ * @param privilegeId - Privilege ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to privilege information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getPrivilege } from '@tale/client';
+ *
+ * try {
+ *   const privilege = await getPrivilege('privilege_id_here');
+ *   console.log('Privilege name:', privilege.privilege_name);
+ * } catch (error) {
+ *   console.error('Failed to get privilege:', error.message);
+ * }
+ * ```
+ */
+export declare function getPrivilege(privilegeId: string, options?: RbacOptions): Promise<Privilege>;
+/**
+ * Lists privileges with pagination and optional filtering.
+ *
+ * @param options - Optional parameters for pagination and filtering
+ * @returns Promise resolving to paginated privilege list
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { listPrivileges } from '@tale/client';
+ *
+ * try {
+ *   const result = await listPrivileges({
+ *     page: 0,
+ *     size: 20,
+ *     privilege_type: 'read'
+ *   });
+ *   console.log(`Found ${result.totalElements} privileges`);
+ * } catch (error) {
+ *   console.error('Failed to list privileges:', error.message);
+ * }
+ * ```
+ */
+export declare function listPrivileges(options?: ListPrivilegesRequest & RbacOptions): Promise<{
+    content: Privilege[];
+    totalElements: number;
+}>;
+/**
+ * Creates a new privilege.
+ *
+ * @param request - Privilege creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created privilege
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { createPrivilege } from '@tale/client';
+ *
+ * try {
+ *   const privilege = await createPrivilege({
+ *     privilegeName: 'read_posts',
+ *     privilege_type: 'read',
+ *     resourceIds: ['posts']
+ *   });
+ *   console.log('Privilege created:', privilege.privilege_id);
+ * } catch (error) {
+ *   console.error('Failed to create privilege:', error.message);
+ * }
+ * ```
+ */
+export declare function createPrivilege(request: CreatePrivilegeRequest, options?: RbacOptions): Promise<Privilege>;
+/**
+ * Updates an existing privilege.
+ *
+ * @param privilegeId - Privilege ID to update
+ * @param request - Update request with fields to modify
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated privilege
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { updatePrivilege } from '@tale/client';
+ *
+ * try {
+ *   const privilege = await updatePrivilege('privilege_id_here', {
+ *     privilegeName: 'updated_name',
+ *     remark: 'Updated description'
+ *   });
+ *   console.log('Privilege updated:', privilege.privilege_name);
+ * } catch (error) {
+ *   console.error('Failed to update privilege:', error.message);
+ * }
+ * ```
+ */
+export declare function updatePrivilege(privilegeId: string, request: UpdatePrivilegeRequest, options?: RbacOptions): Promise<Privilege>;
+/**
+ * Deletes a privilege.
+ *
+ * @param privilegeId - Privilege 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 { deletePrivilege } from '@tale/client';
+ *
+ * try {
+ *   await deletePrivilege('privilege_id_here');
+ *   console.log('Privilege deleted successfully');
+ * } catch (error) {
+ *   console.error('Failed to delete privilege:', error.message);
+ * }
+ * ```
+ */
+export declare function deletePrivilege(privilegeId: string, options?: RbacOptions): Promise<void>;
+/**
+ * Gets roles assigned to a user.
+ *
+ * @param userId - User ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to list of user roles
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserRoles } from '@tale/client';
+ *
+ * try {
+ *   const roles = await getUserRoles('user_id_here');
+ *   console.log(`User has ${roles.length} roles`);
+ *   roles.forEach(role => console.log('-', role.role_name));
+ * } catch (error) {
+ *   console.error('Failed to get user roles:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserRoles(userId: string, options?: RbacOptions): Promise<Role[]>;
+/**
+ * Assigns roles to a user.
+ *
+ * @param userId - User ID
+ * @param request - Request containing role IDs to assign
+ * @param options - Optional configuration
+ * @returns Promise resolving to list of assigned roles
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { assignRolesToUser } from '@tale/client';
+ *
+ * try {
+ *   const roles = await assignRolesToUser('user_id_here', {
+ *     role_ids: ['role1', 'role2']
+ *   });
+ *   console.log('Roles assigned successfully');
+ * } catch (error) {
+ *   console.error('Failed to assign roles:', error.message);
+ * }
+ * ```
+ */
+export declare function assignRolesToUser(userId: string, request: UserRoleAssignmentRequest, options?: RbacOptions): Promise<Role[]>;
+/**
+ * Unassigns roles from a user.
+ *
+ * @param userId - User ID
+ * @param request - Request containing role IDs to unassign
+ * @param options - Optional configuration
+ * @returns Promise that resolves when unassignment 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 { unassignRolesFromUser } from '@tale/client';
+ *
+ * try {
+ *   await unassignRolesFromUser('user_id_here', {
+ *     role_ids: ['role1', 'role2']
+ *   });
+ *   console.log('Roles unassigned successfully');
+ * } catch (error) {
+ *   console.error('Failed to unassign roles:', error.message);
+ * }
+ * ```
+ */
+export declare function unassignRolesFromUser(userId: string, request: UserRoleUnassignmentRequest, options?: RbacOptions): Promise<void>;
+/**
+ * Gets privileges assigned to a user.
+ *
+ * @param userId - User ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to list of user privileges
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { getUserPrivileges } from '@tale/client';
+ *
+ * try {
+ *   const privileges = await getUserPrivileges('user_id_here');
+ *   console.log(`User has ${privileges.length} privileges`);
+ *   privileges.forEach(priv => console.log('-', priv.privilegeName));
+ * } catch (error) {
+ *   console.error('Failed to get user privileges:', error.message);
+ * }
+ * ```
+ */
+export declare function getUserPrivileges(userId: string, options?: RbacOptions): Promise<Privilege[]>;
+/**
+ * Assigns privileges to a user.
+ *
+ * @param userId - User ID
+ * @param request - Request containing privilege IDs to assign
+ * @param options - Optional configuration
+ * @returns Promise resolving to list of assigned privileges
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { assignPrivilegesToUser } from '@tale/client';
+ *
+ * try {
+ *   const privileges = await assignPrivilegesToUser('user_id_here', {
+ *     privilege_ids: ['priv1', 'priv2']
+ *   });
+ *   console.log('Privileges assigned successfully');
+ * } catch (error) {
+ *   console.error('Failed to assign privileges:', error.message);
+ * }
+ * ```
+ */
+export declare function assignPrivilegesToUser(userId: string, request: UserPrivilegeAssignmentRequest, options?: RbacOptions): Promise<Privilege[]>;
+/**
+ * Unassigns privileges from a user.
+ *
+ * @param userId - User ID
+ * @param request - Request containing privilege IDs to unassign
+ * @param options - Optional configuration
+ * @returns Promise that resolves when unassignment 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 { unassignPrivilegesFromUser } from '@tale/client';
+ *
+ * try {
+ *   await unassignPrivilegesFromUser('user_id_here', {
+ *     privilege_ids: ['priv1', 'priv2']
+ *   });
+ *   console.log('Privileges unassigned successfully');
+ * } catch (error) {
+ *   console.error('Failed to unassign privileges:', error.message);
+ * }
+ * ```
+ */
+export declare function unassignPrivilegesFromUser(userId: string, request: UserPrivilegeUnassignmentRequest, options?: RbacOptions): Promise<void>;
+/**
+ * Assigns privileges to a role.
+ *
+ * @param roleId - Role ID
+ * @param request - Request containing privilege IDs to assign
+ * @param options - Optional configuration
+ * @returns Promise resolving to list of assigned privileges
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { assignPrivilegesToRole } from '@tale/client';
+ *
+ * try {
+ *   const privileges = await assignPrivilegesToRole('role_id_here', {
+ *     privilege_ids: ['priv1', 'priv2']
+ *   });
+ *   console.log('Privileges assigned successfully');
+ * } catch (error) {
+ *   console.error('Failed to assign privileges:', error.message);
+ * }
+ * ```
+ */
+export declare function assignPrivilegesToRole(roleId: string, request: RolePrivilegeAssignmentRequest, options?: RbacOptions): Promise<Privilege[]>;
+/**
+ * Unassigns privileges from a role.
+ *
+ * @param roleId - Role ID
+ * @param request - Request containing privilege IDs to unassign
+ * @param options - Optional configuration
+ * @returns Promise that resolves when unassignment 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 { unassignPrivilegesFromRole } from '@tale/client';
+ *
+ * try {
+ *   await unassignPrivilegesFromRole('role_id_here', {
+ *     privilege_ids: ['priv1', 'priv2']
+ *   });
+ *   console.log('Privileges unassigned successfully');
+ * } catch (error) {
+ *   console.error('Failed to unassign privileges:', error.message);
+ * }
+ * ```
+ */
+export declare function unassignPrivilegesFromRole(roleId: string, request: RolePrivilegeUnassignmentRequest, options?: RbacOptions): Promise<void>;