tale-js-sdk 0.1.2 → 0.1.3

package/dist/rbac/types.d.ts

@@ -0,0 +1,356 @@
+export interface Role {
+    role_id: string;
+    role_name: string;
+    role_type?: string;
+    role_property?: Record<string, any>;
+    role_config?: Record<string, any>;
+    description?: string;
+    remark?: string;
+    created_at?: string;
+    updated_at?: string;
+    privileges?: Privilege[];
+}
+export interface Privilege {
+    privilege_id: string;
+    privilege_name: string;
+    privilege_type?: string;
+    privilege_property?: Record<string, any>;
+    privilege_config?: Record<string, any>;
+    resource_ids?: string[];
+    description?: string;
+    remark?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface UserGroup {
+    group_id: string;
+    group_name: string;
+    description?: string;
+    type?: string;
+    remark?: string;
+    created_at?: string;
+    updated_at?: string;
+    member_count?: number;
+}
+export interface PaginatedResponse<T> {
+    content: T[];
+    pageable: {
+        sort: Sort;
+        offset: number;
+        pageNumber: number;
+        pageSize: number;
+        paged: boolean;
+        unpaged: boolean;
+    };
+    last: boolean;
+    totalPages: number;
+    totalElements: number;
+    size: number;
+    number: number;
+    sort: Sort;
+    first: boolean;
+    numberOfElements: number;
+    empty: boolean;
+}
+export interface Sort {
+    empty: boolean;
+    sorted: boolean;
+    unsorted: boolean;
+}
+export interface CommonOptions {
+    baseUrl?: string;
+    appKey?: string;
+    appSecret?: string;
+    appToken?: string;
+}
+export interface RBACOptions extends CommonOptions {
+    include_privileges?: boolean;
+    include_assignments?: boolean;
+    assignment_expires_at?: string;
+}
+export interface CreateRoleRequest {
+    role_name: string;
+    role_type?: string;
+    role_property?: Record<string, any>;
+    role_config?: Record<string, any>;
+    privilege_ids?: string[];
+    remark?: string;
+}
+export interface UpdateRoleRequest {
+    role_name?: string;
+    role_type?: string;
+    role_property?: Record<string, any>;
+    role_config?: Record<string, any>;
+    privilege_ids?: string[];
+    remark?: string;
+}
+export interface ListRolesRequest {
+    page?: number;
+    size?: number;
+    role_type?: string;
+    sort_by?: string;
+    sort_direction?: 'asc' | 'desc';
+}
+export interface CreateRoleResponse {
+    role: Role;
+    message?: string;
+}
+export interface CreateRoleJson {
+    data: CreateRoleResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdateRoleResponse {
+    role: Role;
+    message?: string;
+}
+export interface UpdateRoleJson {
+    data: UpdateRoleResponse;
+    code: number;
+    msg: string;
+}
+export interface DeleteRoleResponse {
+    deleted: boolean;
+    role_id: string;
+}
+export interface DeleteRoleJson {
+    data: DeleteRoleResponse;
+    code: number;
+    msg: string;
+}
+export interface GetRoleResponse {
+    role: Role;
+}
+export interface GetRoleJson {
+    data: GetRoleResponse;
+    code: number;
+    msg: string;
+}
+export interface ListRolesJson {
+    data: PaginatedResponse<Role>;
+    code: number;
+    msg: string;
+}
+export interface CreatePrivilegeRequest {
+    privilege_name: string;
+    privilege_type?: string;
+    privilege_property?: Record<string, any>;
+    privilege_config?: Record<string, any>;
+    resource_ids?: string[];
+    remark?: string;
+}
+export interface UpdatePrivilegeRequest {
+    privilege_name?: string;
+    privilege_type?: string;
+    privilege_property?: Record<string, any>;
+    privilege_config?: Record<string, any>;
+    resource_ids?: string[];
+    remark?: string;
+}
+export interface ListPrivilegesRequest {
+    page?: number;
+    size?: number;
+    privilege_type?: string;
+    sort_by?: string;
+    sort_direction?: 'asc' | 'desc';
+}
+export interface CreatePrivilegeResponse {
+    privilege: Privilege;
+    message?: string;
+}
+export interface CreatePrivilegeJson {
+    data: CreatePrivilegeResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdatePrivilegeResponse {
+    privilege: Privilege;
+    message?: string;
+}
+export interface UpdatePrivilegeJson {
+    data: UpdatePrivilegeResponse;
+    code: number;
+    msg: string;
+}
+export interface DeletePrivilegeResponse {
+    deleted: boolean;
+    privilege_id: string;
+}
+export interface DeletePrivilegeJson {
+    data: DeletePrivilegeResponse;
+    code: number;
+    msg: string;
+}
+export interface GetPrivilegeResponse {
+    privilege: Privilege;
+}
+export interface GetPrivilegeJson {
+    data: GetPrivilegeResponse;
+    code: number;
+    msg: string;
+}
+export interface ListPrivilegesJson {
+    data: PaginatedResponse<Privilege>;
+    code: number;
+    msg: string;
+}
+export interface PropertyResponse {
+    property: Record<string, any>;
+}
+export interface PropertyJson {
+    data: PropertyResponse;
+    code: number;
+    msg: string;
+}
+export interface ConfigResponse {
+    config: Record<string, any>;
+}
+export interface ConfigJson {
+    data: ConfigResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdatePropertyRequest {
+    property: Record<string, any>;
+}
+export interface UpdatePropertyJson {
+    data: PropertyResponse;
+    code: number;
+    msg: string;
+}
+export interface UpdateConfigRequest {
+    config: Record<string, any>;
+}
+export interface UpdateConfigJson {
+    data: ConfigResponse;
+    code: number;
+    msg: string;
+}
+export interface RoleAssignment {
+    assignment_id?: string;
+    user_id: string;
+    role_id: string;
+    role: Role;
+    started_at?: string;
+    expired_at?: string;
+    assignment_type?: string;
+    assignment_ref?: string;
+    remark?: string;
+    created_at?: string;
+}
+export interface PrivilegeAssignment {
+    assignment_id?: string;
+    user_id: string;
+    privilege_id: string;
+    privilege: Privilege;
+    started_at?: string;
+    expired_at?: string;
+    assignment_type?: string;
+    assignment_ref?: string;
+    remark?: string;
+    created_at?: string;
+}
+export interface UserRoleAssignmentRequest {
+    role_ids: string[];
+    started_at?: string;
+    expired_at?: string;
+    assignment_type?: string;
+    assignment_ref?: string;
+    remark?: string;
+}
+export interface UserPrivilegeAssignmentRequest {
+    privilege_ids: string[];
+    started_at?: string;
+    expired_at?: string;
+    assignment_type?: string;
+    assignment_ref?: string;
+    remark?: string;
+}
+export interface RolePrivilegeAssignmentRequest {
+    privilege_ids: string[];
+    remark?: string;
+}
+export interface UserRoleUnassignmentRequest {
+    role_ids: string[];
+}
+export interface UserPrivilegeUnassignmentRequest {
+    privilege_ids: string[];
+}
+export interface RolePrivilegeUnassignmentRequest {
+    privilege_ids: string[];
+}
+export interface AssignRolesResponse {
+    roles: Role[];
+    message?: string;
+}
+export interface AssignRolesJson {
+    data: AssignRolesResponse;
+    code: number;
+    msg: string;
+}
+export interface UnassignRolesResponse {
+    unassigned: boolean;
+    unassigned_count: number;
+}
+export interface UnassignRolesJson {
+    data: UnassignRolesResponse;
+    code: number;
+    msg: string;
+}
+export interface AssignPrivilegesResponse {
+    privileges: Privilege[];
+    message?: string;
+}
+export interface AssignPrivilegesJson {
+    data: AssignPrivilegesResponse;
+    code: number;
+    msg: string;
+}
+export interface UnassignPrivilegesResponse {
+    unassigned: boolean;
+    unassigned_count: number;
+}
+export interface UnassignPrivilegesJson {
+    data: UnassignPrivilegesResponse;
+    code: number;
+    msg: string;
+}
+export interface GetUserRolesResponse {
+    roles: Role[];
+}
+export interface GetUserRolesJson {
+    data: GetUserRolesResponse;
+    code: number;
+    msg: string;
+}
+export interface GetUserPrivilegesResponse {
+    privileges: Privilege[];
+}
+export interface GetUserPrivilegesJson {
+    data: GetUserPrivilegesResponse;
+    code: number;
+    msg: string;
+}
+export interface PrivilegeRolePair {
+    privilege_id: string;
+    privilege_name: string;
+    role_id: string;
+    role_name: string;
+    resource_id: string;
+}
+export interface ResourcePermissionCheck {
+    user_id: string;
+    resource_id: string;
+    privilege_name: string;
+    has_permission: boolean;
+    granted_by_roles: string[];
+    granted_by_privileges: string[];
+}
+export interface GetResourcePrivilegeRolesResponse {
+    privilege_role_pairs: PrivilegeRolePair[];
+}
+export interface GetResourcePrivilegeRolesJson {
+    data: GetResourcePrivilegeRolesResponse;
+    code: number;
+    msg: string;
+}

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>;