@laiye_packages/uci 1.0.7 → 1.0.8

package/dist/app/organization/api/user.d.ts

@@ -1,95 +1,385 @@
 import type { LYRangeQueryParams, LYAppHttpClient, LYBaseResponse, LYListResponse } from '../../../http';
+/**
+ * 用户来源类型
+ */
 type LYSourceType = 'builtin' | 'web' | 'sso' | string;
-interface LYUserQueryParams extends LYRangeQueryParams {
+/**
+ * 用户查询参数
+ */
+export interface LYUserQueryParams extends LYRangeQueryParams {
+    /** 用户唯一名称，英文和数字组合 */
     name?: string;
+    display_name?: string;
+    /** 角色ID */
     role_id?: string;
+    /** 邮箱，仅精确匹配 */
     email?: string;
+    /** 手机号，仅精确匹配 */
     phone?: string;
+    /** 手机区号，仅精确匹配 */
+    country_code?: string;
+    /** 部门ID */
     department_id?: string;
+    /** 是否只查询该部门管理员，指定department_id时有效 */
     manager_only?: boolean;
 }
+/**
+ * 账号检查请求
+ */
 interface LYAccountCheckRequest {
+    /** 邮箱地址 */
     email?: string;
+    /** 手机号（不包含国家区号） */
     phone?: string;
+    /** 账号类型：email 或 phone */
     account_type?: "email" | "phone";
+    /** 国家区号（手机号时必需，如+86） */
     country_code?: string;
 }
+/**
+ * 用户注册响应
+ */
 interface LYUserRegisterResonse extends LYBaseResponse {
+    /** 用户ID */
     user_id: string;
+    /** 响应消息 */
     message: string;
+    /** 邮箱是否已验证 */
     email_verified: boolean;
+    /** 手机是否已验证 */
     phone_verified: boolean;
 }
-interface LYUserResponse extends LYBaseResponse {
+/**
+ * 用户信息响应
+ */
+export interface LYUserResponse extends LYBaseResponse {
+    /** 用户ID */
     id: string;
+    /** 用户名 */
     name: string;
+    /** 角色ID */
     role_id: string;
+    /** 角色名称 */
+    role_name?: string;
+    /** 部门ID */
+    department_id?: string;
+    /** 部门名称 */
+    department_name?: string;
+    /** 用户来源 */
     source: LYSourceType;
-    email: string;
-    phone: string;
+    /** 邮箱 */
+    email?: string;
+    /** 手机号 */
+    phone?: string;
+    /** 手机区号 */
+    country_code?: string;
+    /** 是否为超级管理员 */
     is_super_admin: boolean;
-    description: string;
+    /** 显示名称 */
+    display_name: string;
+    /** 用户描述 */
+    description?: string;
+    is_enabled: boolean;
+    /** 是否锁定 */
     is_locked: boolean;
-    locked_at: string;
-    locked_by: string;
+    /** 锁定时间 */
+    locked_at?: string;
+    /** 锁定者 */
+    locked_by?: string;
+    /** 登录失败次数 */
     login_failures: number;
-    last_login_at: string;
-    last_login_ip: string;
-    last_login_location: string;
-    last_login_device: string;
-    last_login_browser: string;
-    last_login_os: string;
+    /** 最后登录时间 */
+    last_login_at?: string;
+    /** 最后登录IP */
+    last_login_ip?: string;
+    /** 最后登录地点 */
+    last_login_location?: string;
+    /** 最后登录设备 */
+    last_login_device?: string;
+    /** 最后登录浏览器 */
+    last_login_browser?: string;
+    /** 最后登录操作系统 */
+    last_login_os?: string;
 }
+/**
+ * 用户列表响应
+ */
 interface LYUserListResponse extends LYListResponse<LYUserResponse> {
 }
-interface LYUserPostRequest {
+/**
+ * 创建用户请求
+ */
+export interface LYUserPostRequest {
+    /** 用户唯一名称 */
     name: string;
+    /** 用户密码 */
     password: string;
+    /** 显示名称 */
+    display_name?: string;
+    /** 部门id */
+    department_id: string;
+    /** 角色ID */
+    role_id: string;
+    /** 用户描述 */
     description?: string;
-    role_id?: string;
+    /** 邮箱 */
     email?: string;
+    /** 手机号 */
     phone?: string;
 }
-interface LYUserPatchRequest {
+/**
+ * 更新用户请求
+ */
+export interface LYUserPatchRequest {
+    /** 用户密码 */
     password?: string;
+    /** 用户描述 */
     description?: string;
+    /** 用户是否启用 */
+    is_enabled?: boolean;
+    /** 是否锁定 */
     is_locked?: boolean;
+    /** 角色ID */
     role_id?: string;
+    /** 邮箱 */
     email?: string;
+    /** 手机号 */
     phone?: string;
+    /** 显示名称 */
+    display_name?: string;
+}
+/**
+ * 删除用户请求
+ */
+export interface LYUserDeleteRequest {
+    /** 资产接收用户ID */
+    receiver_user_id: string;
 }
+/**
+ * 用户注册请求
+ */
 interface LYRegisterRequest {
+    /** 邮箱地址 */
     email?: string;
+    /** 手机号（不包含国家区号） */
     phone?: string;
+    /** 国家区号（手机号时必需，如+86） */
     country_code?: string;
+    /** 账号类型：email 或 phone */
     account_type: string;
+    /** 密码 */
     password: string;
-    display_name?: string;
+    /** 显示名称 */
+    display_name: string;
 }
+/**
+ * 密码重置请求
+ */
 interface LYResetPasswordRequest {
+    /** 账号类型：email 或 phone */
     account_type: "email" | "phone";
+    /** 验证令牌ID */
     verification_code_id: string;
+    /** 新密码 */
     new_password: string;
+    /** 邮箱，仅精确匹配 */
     email?: string;
+    /** 手机区号，仅精确匹配 */
     country_code?: string;
+    /** 手机号，仅精确匹配 */
     phone?: string;
 }
+/**
+ * 修改密码请求
+ */
+interface LYPasswordChangeRequest {
+    /** 当前密码（首次登录强制修改时可为空） */
+    current_password?: string;
+    /** 新密码 */
+    new_password: string;
+}
+/**
+ * 密码策略响应
+ */
+interface LYPasswordPolicyResponse extends LYBaseResponse {
+    /** 最小长度 */
+    min_length: number;
+    /** 最大长度 */
+    max_length: number;
+    /** 强度1 */
+    strength1: boolean;
+    /** 强度2 */
+    strength2: boolean;
+    /** 强度3 */
+    strength3: boolean;
+    /** 历史数量 */
+    history_count: number;
+    /** 历史过期时间 */
+    history_expire: number;
+    /** 用户名 */
+    no_user_name: boolean;
+    /** 连续字符 */
+    no_continuous_chars: number;
+    /** 顺序字符 */
+    no_sequential_chars: number;
+    /** 键盘顺序字符 */
+    no_keyboard_sequential_chars: number;
+    /** 字典单词 */
+    no_dictionary_words: string[];
+}
+/**
+ * 锁定策略响应
+ */
+interface LYLockoutPolicyResponse extends LYBaseResponse {
+    /** 登录失败次数 */
+    lock_after_login_failures: number;
+    /** 锁定时间 */
+    lock_duration: number;
+}
+/**
+ * 用户设置响应
+ */
+interface LYUserSettingsResponse extends LYBaseResponse {
+    /** 密码策略 */
+    password_policy: LYPasswordPolicyResponse;
+    /** 锁定策略 */
+    lockout_policy: LYLockoutPolicyResponse;
+}
+/**
+ * 密码策略请求
+ */
+interface LYPasswordPolicyRequest {
+    /** 最小长度 */
+    min_length?: number;
+    /** 最大长度 */
+    max_length?: number;
+    /** 强度1 */
+    strength1?: boolean;
+    /** 强度2 */
+    strength2?: boolean;
+    /** 强度3 */
+    strength3?: boolean;
+    /** 历史数量 */
+    history_count?: number;
+    /** 历史过期时间 */
+    history_expire?: number;
+    /** 用户名 */
+    no_user_name?: boolean;
+    /** 连续字符 */
+    no_continuous_chars?: number;
+    /** 顺序字符 */
+    no_sequential_chars?: number;
+    /** 键盘顺序字符 */
+    no_keyboard_sequential_chars?: number;
+    /** 字典单词 */
+    no_dictionary_words?: string[];
+}
+/**
+ * 锁定策略请求
+ */
+interface LYLockoutPolicyRequest {
+    /** 登录失败次数 */
+    lock_after_login_failures?: number;
+    /** 锁定时间 */
+    lock_duration?: number;
+    /** 启用锁定提示 */
+    enabled_tip?: boolean;
+}
+/**
+ * 用户设置请求
+ */
+interface LYUserSettingsRequest {
+    /** 密码策略 */
+    password_policy: LYPasswordPolicyRequest;
+    /** 锁定策略 */
+    lockout_policy: LYLockoutPolicyRequest;
+}
+/**
+ * 用户API类
+ * 提供用户管理相关的所有API接口
+ */
 export declare class LYUserApi {
     private _httpClient;
     constructor(httpClient: LYAppHttpClient);
+    /**
+     * 获取用户列表
+     * @param params 查询参数
+     * @returns 用户列表响应
+     */
     query(params: LYUserQueryParams): Promise<LYUserListResponse>;
-    get(name: string): Promise<LYUserResponse | undefined>;
+    setPassword(newPassword: string): Promise<{
+        message: string;
+    }>;
+    /**
+     * 获取用户信息
+     * @param id 用户ID
+     * @returns 用户信息
+     */
+    get(id: string): Promise<LYUserResponse | undefined>;
+    /**
+     * 创建用户
+     * @param user 用户信息
+     * @returns 用户ID
+     */
     add(user: LYUserPostRequest): Promise<string>;
-    update(name: string, user: LYUserPatchRequest): Promise<number>;
-    remove(name: string): Promise<number>;
+    /**
+     * 更新用户
+     * @param id 用户ID
+     * @param user 更新的用户信息
+     * @returns 更新的记录数
+     */
+    update(id: string, user: LYUserPatchRequest): Promise<number>;
+    /**
+     * 删除用户
+     * @param id 用户ID
+     * @param request 删除请求，包含资产接收用户ID
+     * @returns 删除的记录数
+     */
+    remove(id: string, request: LYUserDeleteRequest): Promise<number>;
+    /**
+     * 检查账号是否存在
+     * @param request 账号检查请求
+     * @returns 账号是否存在
+     */
     accountCheck(request: LYAccountCheckRequest): Promise<boolean>;
+    /**
+     * 用户自注册
+     * @param request 注册请求
+     * @returns 注册结果
+     */
     register(request: LYRegisterRequest): Promise<LYUserRegisterResonse>;
+    /**
+     * 检查用户名是否可用
+     * @param name 用户名
+     * @returns 用户名是否可用
+     */
     userNameCheck(name: string): Promise<boolean>;
-    changePassword(currentPassword: string, newPassword: string): Promise<{
+    /**
+     * 修改密码（已登录用户修改自己的密码）
+     * @param request 修改密码请求
+     * @returns 修改结果
+     */
+    changePassword(request: LYPasswordChangeRequest): Promise<{
         message: string;
     }>;
+    /**
+     * 重置密码
+     * @param request 重置密码请求
+     * @returns 重置结果
+     */
     resetPassword(request: LYResetPasswordRequest): Promise<{
         message: string;
     }>;
+    /**
+     * 获取用户设置
+     * @returns 用户设置（密码策略和锁定策略）
+     */
+    getSettings(): Promise<LYUserSettingsResponse>;
+    /**
+     * 更新用户设置
+     * @param request 用户设置请求
+     * @returns 更新的记录数
+     */
+    updateSettings(request: LYUserSettingsRequest): Promise<number>;
 }
 export {};

package/dist/app/organization/app/index.d.ts

@@ -6,14 +6,59 @@ import type { LYBaseAuthorizer } from '../authorizer/base';
 import { LYLicenseApi } from '../api/license';
 import { LYOEMApi } from '../api/oem';
 import { LYVerificationCodesApi } from '../api/verificationCodes';
+import { LYPermissionApi, type LYRoleMetaData } from '../api/permission';
+import { LYDepartmentApi } from '../api/department';
+export type { LYUserDepartmentDataPermissionInfo, LYCreateUserDepartmentDataPermissionRequest, LYPatchUserDepartmentDataPermissionRequest, LYUserDepartmentDataPermissionQueryParams, } from '../api/department';
+export interface IMenuItem {
+    menu_key: string;
+    parent_key: string;
+    menu_type: string;
+    label_i18n_key: string;
+    label: string;
+    icon: string;
+    route: string;
+    permissions: string[];
+    allow_l3_mount: boolean;
+    order: number;
+}
+export interface IRemoteComponentItem {
+    app_name: string;
+    component_key: string;
+    label_i18n_key: string;
+    label: string;
+    icon: string;
+    path: string;
+    parent_key: string;
+    permissions: string[];
+    mount_menu_key: string;
+    order: number;
+}
+export interface ILayout {
+    menus: IMenuItem[];
+    components: IRemoteComponentItem[];
+}
+export interface IMetricItem {
+    key: string;
+    name: string;
+    value: number;
+    unit: string;
+    icon: string;
+    order: number;
+}
 declare class LYOrganizationApp extends LYBaseOrganizationApp {
     static _instance?: LYOrganizationApp;
     private _sessionApi;
     private _userApi;
     private _licenseApi;
+    private _permissionApi;
+    private _departmentApi;
     private _authorizers;
     private _oemApi;
     private _verificationCodesApi;
+    /**
+     * 权限元数据缓存，key 为 app_name
+     */
+    private _permissionMeta;
     constructor(name: string, version: string, description: string);
     static get instance(): LYOrganizationApp;
     get sessionApi(): LYSessionApi;
@@ -21,7 +66,33 @@ declare class LYOrganizationApp extends LYBaseOrganizationApp {
     get oemApi(): LYOEMApi;
     get licenseApi(): LYLicenseApi;
     get verificationCodesApi(): LYVerificationCodesApi;
+    get permissionApi(): LYPermissionApi;
+    get departmentApi(): LYDepartmentApi;
+    /**
+     * 获取指定 app 声明的所有权限编码
+     * @param appName 应用名称
+     * @returns 权限编码列表
+     */
+    getAllPermissionCodes(appName: string): string[];
+    /**
+     * 获取权限元数据
+     * @returns 权限元数据
+     */
+    getPermissionMeta(): LYRoleMetaData;
+    getLayout(): Promise<ILayout>;
+    getMetrics(): Promise<{
+        range: string;
+        list: IMetricItem[];
+    }>;
     protected doLoad(): Promise<void>;
+    /**
+     * 加载权限元数据（需要在登录后调用）
+     */
+    loadPermissionMeta(): Promise<void>;
+    /**
+     * 更新当前 session 的权限对象中的 allCodes
+     */
+    private _updateSessionAllCodes;
     private mergeOEM;
     getAuthorizer<T extends LYBaseAuthorizer = LYBaseAuthorizer>(name?: string): T;
 }

package/dist/app/organization/authorizer/base.d.ts

@@ -7,7 +7,7 @@ type LYAuthorizerEvents = {
     'status-change': (status: LYAuthorizerStatus) => void;
 };
 export interface LYSigninArgs {
-    redirect_uri: string;
+    redirect_uri?: string;
     sso_config?: SSOConfig;
 }
 export interface LYSignoutArgs {

package/dist/app/organization/authorizer/web.d.ts

@@ -1,6 +1,16 @@
 import type { LYBaseApp } from '../../base';
 import { LYBaseAuthorizer, type LYSigninArgs, type LYSignoutArgs } from './base';
-import type { LYSessionApi } from '../api/session';
+import type { LYSessionApi, LYLoginClientData, LYSessionResponse } from '../api/session';
+export interface LYClientLoginUrlParams {
+    response_type?: string;
+    client_id?: string;
+    return_url?: string;
+    api_base_url?: string;
+    state?: string;
+    tenant_name?: string;
+    client_type?: string;
+    code?: string;
+}
 export interface LYWebSigninArgs extends LYSigninArgs {
     name?: string;
     password?: string;
@@ -10,12 +20,52 @@ export interface LYWebSigninArgs extends LYSigninArgs {
     account_type?: "email" | "phone";
     verification_code?: string;
     verification_code_id?: string;
+    client_type?: "web" | "app";
+    client_data?: LYLoginClientData;
 }
 export interface LYWebSignoutArgs extends LYSignoutArgs {
 }
 export declare class LYWebAuthorizer extends LYBaseAuthorizer<LYWebSigninArgs, LYWebSignoutArgs> {
     private _sessionApi;
     constructor(app: LYBaseApp, name: string, sessionApi: LYSessionApi);
+    /**
+     * 从 URL 解析客户端登录参数
+     * 后端 /auth/authorize 重定向时会带上这些参数：
+     * 未登录：response_type=code, client_id, return_url, api_base_url, state, tenant_name, client_type=app
+     * 已登录：return_url, state, api_base_url, tenant_name, code
+     *
+     * 支持两种格式：
+     * 1. search 参数：?code=xxx&return_url=xxx
+     * 2. hash 参数：#client-login?code=xxx&return_url=xxx
+     */
+    static parseClientLoginParams(): LYClientLoginUrlParams;
+    /**
+     * 获取客户端登录 URL 参数
+     * 返回所有从 URL 解析的参数，供 signinWithResponse 内部组装
+     */
+    static getClientLoginArgs(): LYClientLoginUrlParams;
+    /**
+     * 检查是否是客户端登录请求
+     */
+    static isClientLoginRequest(): boolean;
+    /**
+     * 检查是否是已登录用户的客户端登录回调
+     * 当用户已登录时，/auth/authorize 会直接生成 code 并重定向
+     * 此时 URL 中会有 code 和 return_url 参数
+     */
+    static isClientLoginCallback(): boolean;
+    /**
+     * 执行已登录用户的客户端登录回调跳转
+     * 将 code、state、tenant_name、api_base_url 传递给客户端
+     */
+    static handleClientLoginCallback(): void;
+    /**
+     * 登录并返回 response，供需要直接访问响应数据的场景使用
+     * 例如：客户端登录需要检查 is_first_login
+     *
+     * 此方法会自动从 URL 中检测客户端登录参数，如果存在则自动处理客户端登录流程
+     */
+    signinWithResponse(args: LYWebSigninArgs): Promise<LYSessionResponse>;
     _signin(args: LYWebSigninArgs): Promise<void>;
     _signout(args: LYWebSignoutArgs): Promise<void>;
     /**

package/dist/config/app.d.ts

@@ -2,4 +2,5 @@ import { LYBaseConfigModel } from './base';
 export declare class LYAppConfig extends LYBaseConfigModel {
     name: string;
     version: string;
+    display_name: string;
 }

package/dist/config/crypto.d.ts

@@ -2,4 +2,5 @@ import { LYBaseConfigModel } from './base';
 export type LYCryptoType = 'default' | 'sm' | 'gm';
 export declare class LYCryptoConfig extends LYBaseConfigModel {
     type: LYCryptoType;
+    encrypt_public_key: string;
 }