tale-js-sdk 0.1.3 → 1.0.0

package/dist/acl/types.d.ts

@@ -1,208 +1,142 @@
-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 AclOptions extends CommonOptions {
-    include_records?: boolean;
-    include_templates?: boolean;
-    effect_type?: 'allow' | 'deny' | 'inherit';
-    priority_range?: {
-        min: number;
-        max: number;
-    };
-}
+import type { CommonOptions } from "../common/types.js";
+/**
+ * ACL Record (Access Control List Record)
+ * Represents a single access control rule
+ */
 export interface AclRecord {
     record_id: string;
     app_id: string;
-    template_id: string;
-    subject_type: 'user' | 'role' | 'group';
+    template_id?: string;
+    subject_type: string;
     subject_id?: string;
     subject_identifier?: string;
     resource_type: string;
     resource_id?: string;
     resource_identifier?: string;
-    effect_type: 'allow' | 'deny' | 'inherit';
-    priority: number;
-    data_scope?: Record<string, any>;
-    description?: string;
-    created_at?: string;
-    updated_at?: string;
-}
-export interface AclTemplate {
-    template_id: string;
-    app_id: string;
-    template_name: string;
-    template_code: string;
-    subject_filter?: Record<string, any>;
-    resource_filter?: Record<string, any>;
-    effect_type?: 'allow' | 'deny' | 'inherit';
-    default_priority?: number;
+    effect_type: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
     description?: string;
-    created_at?: string;
-    updated_at?: string;
+    created_at: string;
+    updated_at: string;
 }
+/**
+ * Request for creating an ACL record
+ */
 export interface CreateAclRecordRequest {
-    template_id: string;
-    subject_type: 'user' | 'role' | 'group';
+    template_id?: string;
+    subject_type: string;
     subject_id?: string;
     subject_identifier?: string;
     resource_type: string;
     resource_id?: string;
     resource_identifier?: string;
-    effect_type: 'allow' | 'deny' | 'inherit';
+    effect_type: string;
     priority?: number;
-    data_scope?: Record<string, any>;
+    data_scope?: Record<string, unknown>;
     description?: string;
 }
+/**
+ * Request for updating an ACL record
+ */
 export interface UpdateAclRecordRequest {
     template_id?: string;
-    effect_type?: 'allow' | 'deny' | 'inherit';
+    effect_type?: string;
     priority?: number;
-    data_scope?: Record<string, any>;
+    data_scope?: Record<string, unknown>;
     description?: string;
 }
+/**
+ * Request for listing ACL records
+ */
 export interface ListAclRecordsRequest {
+    page?: number;
+    size?: number;
     template_id?: string;
-    subject_type?: 'user' | 'role' | 'group';
+    subject_type?: string;
     subject_id?: string;
     subject_identifier?: string;
     resource_type?: string;
     resource_id?: string;
     resource_identifier?: string;
-    page?: number;
-    size?: number;
-    sort_by?: string;
-    sort_direction?: 'asc' | 'desc';
 }
+/**
+ * Batch creation response for ACL records
+ */
+export interface AclBatchCreateResponse {
+    success_count: number;
+    failure_count: number;
+    success_records: AclRecord[];
+    failures: AclBatchFailure[];
+}
+/**
+ * Failure details for batch creation
+ */
+export interface AclBatchFailure {
+    index: number;
+    request: CreateAclRecordRequest;
+    error_message: string;
+}
+/**
+ * ACL Template
+ * Represents a reusable ACL configuration template
+ */
+export interface AclTemplate {
+    template_id: string;
+    app_id: string;
+    template_name: string;
+    template_code: string;
+    subject_type?: string;
+    subject_filter?: Record<string, unknown>;
+    resource_type?: string;
+    resource_filter?: Record<string, unknown>;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
+    description?: string;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Request for creating an ACL template
+ */
 export interface CreateAclTemplateRequest {
     template_name: string;
     template_code: string;
-    subject_filter?: Record<string, any>;
-    resource_filter?: Record<string, any>;
-    effect_type?: 'allow' | 'deny' | 'inherit';
-    default_priority?: number;
+    subject_type?: string;
+    subject_filter?: Record<string, unknown>;
+    resource_type?: string;
+    resource_filter?: Record<string, unknown>;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
     description?: string;
 }
+/**
+ * Request for updating an ACL template
+ */
 export interface UpdateAclTemplateRequest {
     template_name?: string;
-    subject_filter?: Record<string, any>;
-    resource_filter?: Record<string, any>;
-    effect_type?: 'allow' | 'deny' | 'inherit';
-    default_priority?: number;
+    subject_filter?: Record<string, unknown>;
+    resource_filter?: Record<string, unknown>;
+    effect_type?: string;
+    priority?: number;
+    data_scope?: Record<string, unknown>;
     description?: string;
 }
+/**
+ * Request for listing ACL templates
+ */
 export interface ListAclTemplatesRequest {
-    resource_type?: string;
-    subject_type?: 'user' | 'role' | 'group';
     page?: number;
     size?: number;
     sort_by?: string;
-    sort_direction?: 'asc' | 'desc';
-}
-export interface CreateAclRecordResponse {
-    record: AclRecord;
-    message?: string;
-}
-export interface CreateAclRecordJson {
-    data: CreateAclRecordResponse;
-    code: number;
-    msg: string;
-}
-export interface UpdateAclRecordResponse {
-    record: AclRecord;
-    message?: string;
-}
-export interface UpdateAclRecordJson {
-    data: UpdateAclRecordResponse;
-    code: number;
-    msg: string;
-}
-export interface DeleteAclRecordResponse {
-    deleted: boolean;
-    record_id: string;
-}
-export interface DeleteAclRecordJson {
-    data: DeleteAclRecordResponse;
-    code: number;
-    msg: string;
-}
-export interface GetAclRecordResponse {
-    record: AclRecord;
-}
-export interface GetAclRecordJson {
-    data: GetAclRecordResponse;
-    code: number;
-    msg: string;
-}
-export interface ListAclRecordsJson {
-    data: PaginatedResponse<AclRecord>;
-    code: number;
-    msg: string;
-}
-export interface CreateAclTemplateResponse {
-    template: AclTemplate;
-    message?: string;
-}
-export interface CreateAclTemplateJson {
-    data: CreateAclTemplateResponse;
-    code: number;
-    msg: string;
-}
-export interface UpdateAclTemplateResponse {
-    template: AclTemplate;
-    message?: string;
-}
-export interface UpdateAclTemplateJson {
-    data: UpdateAclTemplateResponse;
-    code: number;
-    msg: string;
-}
-export interface DeleteAclTemplateResponse {
-    deleted: boolean;
-    template_id: string;
-}
-export interface DeleteAclTemplateJson {
-    data: DeleteAclTemplateResponse;
-    code: number;
-    msg: string;
-}
-export interface GetAclTemplateResponse {
-    template: AclTemplate;
-}
-export interface GetAclTemplateJson {
-    data: GetAclTemplateResponse;
-    code: number;
-    msg: string;
+    sort_direction?: "asc" | "desc";
+    resource_type?: string;
+    subject_type?: string;
 }
-export interface ListAclTemplatesJson {
-    data: PaginatedResponse<AclTemplate>;
-    code: number;
-    msg: string;
+/**
+ * Options for ACL operations
+ */
+export interface AclOptions extends CommonOptions {
 }

package/dist/auth/types.d.ts

@@ -1,9 +1,9 @@
-import type { AppInfo, BaseUser, UserGroup, Role, Privilege, CommonOptions } from "../common/types.js";
+import type { AppInfo, User, UserGroup, Role, Privilege, CommonOptions } from "../common/types.js";
 export type { AppInfo, UserGroup };
 /**
- * Auth user information (extends BaseUser with non-null remark)
+ * Auth user information (extends User with non-null remark)
  */
-export interface AuthUser extends Omit<BaseUser, "remark"> {
+export interface AuthUser extends Omit<User, "remark"> {
     remark: string;
 }
 /**

package/dist/common/types.d.ts

@@ -1,76 +1,85 @@
-/**
- * Application information
- */
-export interface AppInfo {
-    app_id: string;
-    org_id: string;
-    app_key: string;
-    app_name: string;
+export interface CommonOptions {
+    baseUrl?: string;
+    appToken?: string;
 }
 /**
- * Base user information with common fields
+ * Spring Boot Page serialization format
+ *
+ * This matches the default JSON serialization format of Spring Data's Page object
+ *
+ * @see https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/domain/Page.html
  */
-export interface BaseUser {
-    user_id: string;
-    nick_name: string;
-    avatar_url: string;
-    username: string;
-    email: string;
-    phone: string;
-    registered_at: string;
-    remark: string | null;
-    is_frozen: boolean;
-    latest_login_time?: string;
+export interface PageResponse<T> {
+    /** Page content */
+    content: T[];
+    /** Pagination information */
+    pageable: {
+        pageNumber: number;
+        pageSize: number;
+        sort: {
+            sorted: boolean;
+            unsorted: boolean;
+            empty: boolean;
+        };
+    };
+    /** Total number of pages */
+    totalPages: number;
+    /** Total number of elements */
+    totalElements: number;
+    /** Whether this is the last page */
+    last: boolean;
+    /** Whether this is the first page */
+    first: boolean;
+    /** Number of elements in current page */
+    numberOfElements: number;
+    /** Page size */
+    size: number;
+    /** Current page number */
+    number: number;
+    /** Whether the page is empty */
+    empty: boolean;
 }
-/**
- * User group information
- */
 export interface UserGroup {
     group_id: string;
     group_name: string;
     description?: string;
+    remark?: string;
 }
-/**
- * Role information
- */
 export interface Role {
     role_id: string;
     role_name: string;
-    description?: string;
+    role_type?: string;
+    role_property?: Record<string, unknown>;
+    role_privileges?: Privilege[];
+    privilege_ids?: string[];
+    resource_ids?: string[];
+    expired_at?: string;
+    remark?: string;
 }
-/**
- * Privilege information
- */
 export interface Privilege {
     privilege_id: string;
     privilege_name: string;
-    description?: string;
-}
-/**
- * Sort information for pagination
- */
-export interface Sort {
-    empty: boolean;
-    sorted: boolean;
-    unsorted: boolean;
+    privilege_type?: string;
+    privilege_property?: Record<string, unknown>;
+    resource_ids?: string[];
+    expired_at?: string;
+    remark?: string;
 }
-/**
- * Pageable information for pagination
- */
-export interface Pageable {
-    sort: Sort;
-    offset: number;
-    pageNumber: number;
-    pageSize: number;
-    paged: boolean;
-    unpaged: boolean;
+export interface AppInfo {
+    app_id: string;
+    app_key: string;
+    app_name: string;
 }
-/**
- * Common API request options
- */
-export interface CommonOptions {
-    baseUrl?: string;
-    appKey?: string;
-    appSecret?: string;
-    appToken?: string;
+export interface User {
+    user_id: string;
+    open_id: string;
+    username: string;
+    nick_name: string;
+    email: string;
+    phone: string;
+    avatar_url?: string;
+    is_frozen: boolean;
+    created_at: string;
+    updated_at: string;
+    remark?: string;
 }

package/dist/common/types.js

@@ -1,3 +1,2 @@
 // ==================== Common Types ====================
-// This file contains shared type definitions used across multiple modules
 export {};

package/dist/index.d.ts

@@ -3,5 +3,7 @@ export * from "./token.js";
 export * from "./user/index.js";
 export * from "./auth/index.js";
 export * from "./user-group/index.js";
+export * from "./rbac/index.js";
+export * from "./acl/index.js";
 export * from "./errors.js";
-export * from "./common/types.js";
+export type { CommonOptions, PageResponse, UserGroup, Role, Privilege, AppInfo, User } from "./common/types.js";

package/dist/index.js

@@ -3,5 +3,6 @@ export * from "./token.js";
 export * from "./user/index.js";
 export * from "./auth/index.js";
 export * from "./user-group/index.js";
+export * from "./rbac/index.js";
+export * from "./acl/index.js";
 export * from "./errors.js";
-export * from "./common/types.js";