@turinhub/tale-js-sdk 1.3.0

package/dist/rbac/types.d.ts

@@ -0,0 +1,125 @@
+import type { CommonOptions, Role, Privilege } from "../common/types.js";
+export type { Role, Privilege };
+/**
+ * Request for creating a role
+ */
+export interface CreateRoleRequest {
+    role_name: string;
+    role_type?: string;
+    role_property?: Record<string, unknown>;
+    role_config?: Record<string, unknown>;
+    privilege_ids?: string[];
+    remark?: string;
+}
+/**
+ * Request for updating a role
+ */
+export interface UpdateRoleRequest {
+    role_name?: string;
+    role_type?: string;
+    role_property?: Record<string, unknown>;
+    role_config?: Record<string, unknown>;
+    privilege_ids?: string[];
+    remark?: string;
+}
+/**
+ * Request for creating a privilege
+ */
+export interface CreatePrivilegeRequest {
+    privilege_name: string;
+    privilege_type?: string;
+    privilege_property?: Record<string, unknown>;
+    privilege_config?: Record<string, unknown>;
+    resource_ids?: string[];
+    remark?: string;
+}
+/**
+ * Request for updating a privilege
+ */
+export interface UpdatePrivilegeRequest {
+    privilege_name?: string;
+    privilege_type?: string;
+    privilege_property?: Record<string, unknown>;
+    privilege_config?: Record<string, unknown>;
+    resource_ids?: string[];
+    remark?: string;
+}
+/**
+ * Request for assigning roles to a user
+ */
+export interface UserRoleAssignmentRequest {
+    role_ids: string[];
+    started_at?: string;
+    expired_at?: string;
+    assignment_type?: string;
+    assignment_ref?: string;
+    remark?: string;
+}
+/**
+ * Request for unassigning roles from a user
+ */
+export interface UserRoleUnassignmentRequest {
+    role_ids: string[];
+}
+/**
+ * Request for assigning privileges to a user
+ */
+export interface UserPrivilegeAssignmentRequest {
+    privilege_ids: string[];
+    started_at?: string;
+    expired_at?: string;
+    assignment_type?: string;
+    assignment_ref?: string;
+    remark?: string;
+}
+/**
+ * Request for unassigning privileges from a user
+ */
+export interface UserPrivilegeUnassignmentRequest {
+    privilege_ids: string[];
+}
+/**
+ * Request for assigning privileges to a role
+ */
+export interface RolePrivilegeAssignmentRequest {
+    privilege_ids: string[];
+    remark?: string;
+}
+/**
+ * Request for unassigning privileges from a role
+ */
+export interface RolePrivilegeUnassignmentRequest {
+    privilege_ids: string[];
+}
+/**
+ * Options for RBAC operations
+ */
+export interface RbacOptions extends CommonOptions {
+}
+/**
+ * Request for listing roles
+ */
+export interface ListRolesRequest {
+    page?: number;
+    size?: number;
+    role_type?: string;
+    sort_by?: string;
+    sort_direction?: "asc" | "desc";
+}
+/**
+ * Request for listing privileges
+ */
+export interface ListPrivilegesRequest {
+    page?: number;
+    size?: number;
+    privilege_type?: string;
+    sort_by?: string;
+    sort_direction?: "asc" | "desc";
+}
+/**
+ * Privilege and role pair
+ */
+export interface PrivilegeRolePair {
+    privilege: Privilege;
+    role: Role;
+}

package/dist/rbac/types.js

@@ -0,0 +1 @@
+export {};

package/dist/rbac/user-group.d.ts

@@ -0,0 +1,122 @@
+import type { UserGroup, CreateUserGroupRequest, UpdateUserGroupRequest, ListUserGroupsRequest, UserGroupMemberRequest, CreateUserGroupResponse, UpdateUserGroupResponse, DeleteUserGroupResponse, GetUserGroupResponse, GetUserGroupMembersResponse, AddUserGroupMembersResponse, RemoveUserGroupMembersResponse, GetUserGroupsResponse, PaginatedResponse, CommonOptions } from './types.js';
+/**
+ * Creates a new user group in the Tale application.
+ *
+ * @param groupData - User group data to create the new group
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created user group 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 { createUserGroup } from '@tale/client';
+ *
+ * try {
+ *   const result = await createUserGroup({
+ *     name: 'Developers',
+ *     description: 'Development team group',
+ *     type: 'department',
+ *     remark: 'All developers in the company'
+ *   });
+ *   console.log('User group created:', result.user_group.group_id);
+ * } catch (error) {
+ *   console.error('Failed to create user group:', error.message);
+ * }
+ * ```
+ */
+export declare function createUserGroup(groupData: CreateUserGroupRequest, options?: CommonOptions): Promise<CreateUserGroupResponse>;
+/**
+ * Updates an existing user group by ID.
+ *
+ * @param groupId - User group ID to update
+ * @param updateData - User group information to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the updated user group 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 updateUserGroup(groupId: string, updateData: UpdateUserGroupRequest, options?: CommonOptions): Promise<UpdateUserGroupResponse>;
+/**
+ * Deletes a user group by ID.
+ *
+ * @param groupId - User group 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 deleteUserGroup(groupId: string, options?: CommonOptions): Promise<DeleteUserGroupResponse>;
+/**
+ * Retrieves user group information by ID.
+ *
+ * @param groupId - User group ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the user group 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 getUserGroupById(groupId: string, options?: CommonOptions): Promise<GetUserGroupResponse>;
+/**
+ * Lists user groups with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated user group 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 listUserGroups(options?: ListUserGroupsRequest & CommonOptions): Promise<PaginatedResponse<UserGroup>>;
+/**
+ * Gets the members of a user group.
+ *
+ * @param groupId - User group ID to query
+ * @param options - Optional parameters for pagination and configuration
+ * @returns Promise resolving to the user group members
+ * @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 getUserGroupMembers(groupId: string, options?: {
+    page?: number;
+    size?: number;
+} & CommonOptions): Promise<GetUserGroupMembersResponse>;
+/**
+ * Adds members to a user group.
+ *
+ * @param groupId - User group ID to add members to
+ * @param memberData - Member data with user IDs to add
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the added members 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 addUserGroupMembers(groupId: string, memberData: UserGroupMemberRequest, options?: CommonOptions): Promise<AddUserGroupMembersResponse>;
+/**
+ * Removes members from a user group.
+ *
+ * @param groupId - User group ID to remove members from
+ * @param memberData - Member data with user IDs to remove
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the removal 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 removeUserGroupMembers(groupId: string, memberData: UserGroupMemberRequest, options?: CommonOptions): Promise<RemoveUserGroupMembersResponse>;
+/**
+ * Gets the user groups that a user belongs to.
+ *
+ * @param userId - User ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the user's groups
+ * @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 getUserGroups(userId: string, options?: CommonOptions): Promise<GetUserGroupsResponse>;