com-angel-authorization 1.0.17 → 1.0.18

package/dist/react/index.d.cts

@@ -424,7 +424,98 @@ type RoleManagerProps = {
 };
 declare function RoleManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: RoleManagerProps): react.JSX.Element;
 
-type SystemAdminMenuKey = 'menu' | 'resource' | 'role';
+type SystemGroupOption = {
+    groupId: string;
+    name: string;
+};
+type SystemRoleOption = {
+    roleId: string;
+    name: string;
+};
+type SystemUser = {
+    userId: string;
+    username: string;
+    name: string;
+    groupIds: string[];
+    roleIds: string[];
+    /** 列表展示用，接口若返回则优先使用 */
+    groupNames?: string[];
+    roleNames?: string[];
+    enabled: boolean;
+};
+type SystemUserFormValues = {
+    username: string;
+    name: string;
+    /** 新增必填；编辑时可留空表示不修改 */
+    password: string;
+    groupIds: string[];
+    roleIds: string[];
+    enabled: boolean;
+};
+type CreateSystemUserBody = {
+    username: string;
+    name: string;
+    password: string;
+    groupIds: string[];
+    roleIds: string[];
+    enabled: boolean;
+};
+type UpdateSystemUserBody = {
+    username: string;
+    name: string;
+    password?: string;
+    groupIds: string[];
+    roleIds: string[];
+    enabled: boolean;
+};
+type FetchSystemUsersParams = {
+    keyword?: string;
+    /** undefined 表示不过滤 */
+    enabled?: boolean;
+    pagination?: ListPaginationParams;
+};
+type SystemUserListResult = {
+    records: SystemUser[];
+    pageToken: string;
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+};
+type FetchSystemGroupsParams = {
+    keyword?: string;
+};
+type FetchSystemRoleOptionsParams = {
+    keyword?: string;
+};
+
+type SystemUserApi = {
+    list: (params?: FetchSystemUsersParams, signal?: AbortSignal) => Promise<SystemUserListResult>;
+    create: (values: SystemUserFormValues, signal?: AbortSignal) => Promise<unknown>;
+    update: (userId: string, values: SystemUserFormValues, signal?: AbortSignal) => Promise<unknown>;
+    remove: (userId: string, signal?: AbortSignal) => Promise<unknown>;
+    listGroups: (params?: FetchSystemGroupsParams, signal?: AbortSignal) => Promise<SystemGroupOption[]>;
+    listRoleOptions: (params?: FetchSystemRoleOptionsParams, signal?: AbortSignal) => Promise<SystemRoleOption[]>;
+};
+declare function mapSystemUser(item: unknown): SystemUser | null;
+declare function mapSystemGroupOption(item: unknown): SystemGroupOption | null;
+declare function mapSystemRoleOption(item: unknown): SystemRoleOption | null;
+/**
+ * 账号校验：不少于 6 位，且同时包含字母与数字。
+ * 通过返回 null，失败返回错误文案。
+ */
+declare function validateUsername(username: string): string | null;
+declare function buildCreateUserBody(values: SystemUserFormValues): CreateSystemUserBody;
+declare function buildUpdateUserBody(values: SystemUserFormValues): UpdateSystemUserBody;
+declare function createSystemUserApi(request: ResourceHttpRequest): SystemUserApi;
+
+type UserManagerProps = {
+    api: SystemUserApi;
+    title?: string;
+    pageSize?: string;
+    toolbarExtra?: ReactNode;
+};
+declare function UserManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: UserManagerProps): react.JSX.Element;
+
+type SystemAdminMenuKey = 'menu' | 'resource' | 'role' | 'user';
 type SystemAdminSubMenu = {
     key: SystemAdminMenuKey;
     label: string;
@@ -442,6 +533,7 @@ type SystemAdminProps = {
     menuApi: MenuResourceApi;
     resourceApi: AuthorizationResourceApi;
     roleApi: SystemRoleApi;
+    userApi: SystemUserApi;
     /** 默认选中的子菜单，默认菜单管理 */
     defaultActiveKey?: SystemAdminMenuKey;
     /** 受控选中 key */
@@ -451,9 +543,9 @@ type SystemAdminProps = {
     toolbarExtra?: ReactNode;
 };
 /**
- * 系统管理：侧栏父菜单「系统管理」，子菜单为菜单 / 权限点 / 角色管理。
+ * 系统管理：侧栏父菜单「系统管理」，子菜单为菜单 / 权限点 / 角色 / 用户管理。
  */
-declare function SystemAdmin({ menuApi, resourceApi, roleApi, defaultActiveKey, activeKey: controlledKey, onActiveKeyChange, title, toolbarExtra, }: SystemAdminProps): react.JSX.Element;
+declare function SystemAdmin({ menuApi, resourceApi, roleApi, userApi, defaultActiveKey, activeKey: controlledKey, onActiveKeyChange, title, toolbarExtra, }: SystemAdminProps): react.JSX.Element;
 
 interface SnowyflakeOptions {
     epoch?: bigint;
@@ -485,4 +577,4 @@ declare const snowyflake: ConfigurableSnowflake;
 declare function getAppClientId(): string;
 declare function getDeviceWorkerId(): string;
 
-export { type ApiResourceType, type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, type CanProps, type CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type CreateMenuResourceBody, type CreateSystemRoleBody, type FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, type FetchSystemRolesParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, MENU_LEAF_NO, MENU_LEAF_YES, MENU_LIST_TYPE_PARAM, MENU_TYPE_BUTTON, MENU_TYPE_LABEL, MENU_TYPE_MENU, MENU_TYPE_OPTIONS, MENU_TYPE_PAGE, MENU_VISIBILITY_OPTIONS, type MatchMode, MenuManager, type MenuManagerProps, type MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionListener, PermissionProvider, type PermissionProviderProps, type PermissionState, PermissionStore, type PermissionStoreAPI, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, ROOT_MENU_DEPTH, ROOT_PARENT_ID, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, RoleManager, type RoleManagerProps, type RolePermissionTreeNode, type RolePermissionsResult, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, type SaveRolePermissionsBody, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminProps, type SystemAdminSubMenu, type SystemRole, type SystemRoleApi, type SystemRoleFormValues, type SystemRoleListResult, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UpdateSystemRoleBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildCreateRoleBody, buildPermissionTreeIndex, buildSavePermissionsBody, buildUpdateBody, buildUpdateMenuBody, buildUpdateRoleBody, collectTreeResourceIds, countCheckedDescendants, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionStore, createSystemRoleApi, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, hasCheckedDescendant, isMenuLeaf, isPermissionNodeIndeterminate, mapAuthorizationResource, mapMenuResource, mapPermissionTreeNode, mapRolePermissions, mapSystemRole, resolveMenuDepth, snowyflake, togglePermissionCheck, useHasPermission, useHasRole, usePermission };
+export { type ApiResourceType, type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, type CanProps, type CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type CreateMenuResourceBody, type CreateSystemRoleBody, type CreateSystemUserBody, type FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, type FetchSystemGroupsParams, type FetchSystemRoleOptionsParams, type FetchSystemRolesParams, type FetchSystemUsersParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, MENU_LEAF_NO, MENU_LEAF_YES, MENU_LIST_TYPE_PARAM, MENU_TYPE_BUTTON, MENU_TYPE_LABEL, MENU_TYPE_MENU, MENU_TYPE_OPTIONS, MENU_TYPE_PAGE, MENU_VISIBILITY_OPTIONS, type MatchMode, MenuManager, type MenuManagerProps, type MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionListener, PermissionProvider, type PermissionProviderProps, type PermissionState, PermissionStore, type PermissionStoreAPI, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, ROOT_MENU_DEPTH, ROOT_PARENT_ID, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, RoleManager, type RoleManagerProps, type RolePermissionTreeNode, type RolePermissionsResult, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, type SaveRolePermissionsBody, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminProps, type SystemAdminSubMenu, type SystemGroupOption, type SystemRole, type SystemRoleApi, type SystemRoleFormValues, type SystemRoleListResult, type SystemRoleOption, type SystemUser, type SystemUserApi, type SystemUserFormValues, type SystemUserListResult, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UpdateSystemRoleBody, type UpdateSystemUserBody, type UsePermissionResult, UserManager, type UserManagerProps, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildCreateRoleBody, buildCreateUserBody, buildPermissionTreeIndex, buildSavePermissionsBody, buildUpdateBody, buildUpdateMenuBody, buildUpdateRoleBody, buildUpdateUserBody, collectTreeResourceIds, countCheckedDescendants, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionStore, createSystemRoleApi, createSystemUserApi, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, hasCheckedDescendant, isMenuLeaf, isPermissionNodeIndeterminate, mapAuthorizationResource, mapMenuResource, mapPermissionTreeNode, mapRolePermissions, mapSystemGroupOption, mapSystemRole, mapSystemRoleOption, mapSystemUser, resolveMenuDepth, snowyflake, togglePermissionCheck, useHasPermission, useHasRole, usePermission, validateUsername };

package/dist/react/index.d.ts

@@ -424,7 +424,98 @@ type RoleManagerProps = {
 };
 declare function RoleManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: RoleManagerProps): react.JSX.Element;
 
-type SystemAdminMenuKey = 'menu' | 'resource' | 'role';
+type SystemGroupOption = {
+    groupId: string;
+    name: string;
+};
+type SystemRoleOption = {
+    roleId: string;
+    name: string;
+};
+type SystemUser = {
+    userId: string;
+    username: string;
+    name: string;
+    groupIds: string[];
+    roleIds: string[];
+    /** 列表展示用，接口若返回则优先使用 */
+    groupNames?: string[];
+    roleNames?: string[];
+    enabled: boolean;
+};
+type SystemUserFormValues = {
+    username: string;
+    name: string;
+    /** 新增必填；编辑时可留空表示不修改 */
+    password: string;
+    groupIds: string[];
+    roleIds: string[];
+    enabled: boolean;
+};
+type CreateSystemUserBody = {
+    username: string;
+    name: string;
+    password: string;
+    groupIds: string[];
+    roleIds: string[];
+    enabled: boolean;
+};
+type UpdateSystemUserBody = {
+    username: string;
+    name: string;
+    password?: string;
+    groupIds: string[];
+    roleIds: string[];
+    enabled: boolean;
+};
+type FetchSystemUsersParams = {
+    keyword?: string;
+    /** undefined 表示不过滤 */
+    enabled?: boolean;
+    pagination?: ListPaginationParams;
+};
+type SystemUserListResult = {
+    records: SystemUser[];
+    pageToken: string;
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+};
+type FetchSystemGroupsParams = {
+    keyword?: string;
+};
+type FetchSystemRoleOptionsParams = {
+    keyword?: string;
+};
+
+type SystemUserApi = {
+    list: (params?: FetchSystemUsersParams, signal?: AbortSignal) => Promise<SystemUserListResult>;
+    create: (values: SystemUserFormValues, signal?: AbortSignal) => Promise<unknown>;
+    update: (userId: string, values: SystemUserFormValues, signal?: AbortSignal) => Promise<unknown>;
+    remove: (userId: string, signal?: AbortSignal) => Promise<unknown>;
+    listGroups: (params?: FetchSystemGroupsParams, signal?: AbortSignal) => Promise<SystemGroupOption[]>;
+    listRoleOptions: (params?: FetchSystemRoleOptionsParams, signal?: AbortSignal) => Promise<SystemRoleOption[]>;
+};
+declare function mapSystemUser(item: unknown): SystemUser | null;
+declare function mapSystemGroupOption(item: unknown): SystemGroupOption | null;
+declare function mapSystemRoleOption(item: unknown): SystemRoleOption | null;
+/**
+ * 账号校验：不少于 6 位，且同时包含字母与数字。
+ * 通过返回 null，失败返回错误文案。
+ */
+declare function validateUsername(username: string): string | null;
+declare function buildCreateUserBody(values: SystemUserFormValues): CreateSystemUserBody;
+declare function buildUpdateUserBody(values: SystemUserFormValues): UpdateSystemUserBody;
+declare function createSystemUserApi(request: ResourceHttpRequest): SystemUserApi;
+
+type UserManagerProps = {
+    api: SystemUserApi;
+    title?: string;
+    pageSize?: string;
+    toolbarExtra?: ReactNode;
+};
+declare function UserManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: UserManagerProps): react.JSX.Element;
+
+type SystemAdminMenuKey = 'menu' | 'resource' | 'role' | 'user';
 type SystemAdminSubMenu = {
     key: SystemAdminMenuKey;
     label: string;
@@ -442,6 +533,7 @@ type SystemAdminProps = {
     menuApi: MenuResourceApi;
     resourceApi: AuthorizationResourceApi;
     roleApi: SystemRoleApi;
+    userApi: SystemUserApi;
     /** 默认选中的子菜单，默认菜单管理 */
     defaultActiveKey?: SystemAdminMenuKey;
     /** 受控选中 key */
@@ -451,9 +543,9 @@ type SystemAdminProps = {
     toolbarExtra?: ReactNode;
 };
 /**
- * 系统管理：侧栏父菜单「系统管理」，子菜单为菜单 / 权限点 / 角色管理。
+ * 系统管理：侧栏父菜单「系统管理」，子菜单为菜单 / 权限点 / 角色 / 用户管理。
  */
-declare function SystemAdmin({ menuApi, resourceApi, roleApi, defaultActiveKey, activeKey: controlledKey, onActiveKeyChange, title, toolbarExtra, }: SystemAdminProps): react.JSX.Element;
+declare function SystemAdmin({ menuApi, resourceApi, roleApi, userApi, defaultActiveKey, activeKey: controlledKey, onActiveKeyChange, title, toolbarExtra, }: SystemAdminProps): react.JSX.Element;
 
 interface SnowyflakeOptions {
     epoch?: bigint;
@@ -485,4 +577,4 @@ declare const snowyflake: ConfigurableSnowflake;
 declare function getAppClientId(): string;
 declare function getDeviceWorkerId(): string;
 
-export { type ApiResourceType, type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, type CanProps, type CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type CreateMenuResourceBody, type CreateSystemRoleBody, type FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, type FetchSystemRolesParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, MENU_LEAF_NO, MENU_LEAF_YES, MENU_LIST_TYPE_PARAM, MENU_TYPE_BUTTON, MENU_TYPE_LABEL, MENU_TYPE_MENU, MENU_TYPE_OPTIONS, MENU_TYPE_PAGE, MENU_VISIBILITY_OPTIONS, type MatchMode, MenuManager, type MenuManagerProps, type MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionListener, PermissionProvider, type PermissionProviderProps, type PermissionState, PermissionStore, type PermissionStoreAPI, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, ROOT_MENU_DEPTH, ROOT_PARENT_ID, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, RoleManager, type RoleManagerProps, type RolePermissionTreeNode, type RolePermissionsResult, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, type SaveRolePermissionsBody, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminProps, type SystemAdminSubMenu, type SystemRole, type SystemRoleApi, type SystemRoleFormValues, type SystemRoleListResult, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UpdateSystemRoleBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildCreateRoleBody, buildPermissionTreeIndex, buildSavePermissionsBody, buildUpdateBody, buildUpdateMenuBody, buildUpdateRoleBody, collectTreeResourceIds, countCheckedDescendants, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionStore, createSystemRoleApi, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, hasCheckedDescendant, isMenuLeaf, isPermissionNodeIndeterminate, mapAuthorizationResource, mapMenuResource, mapPermissionTreeNode, mapRolePermissions, mapSystemRole, resolveMenuDepth, snowyflake, togglePermissionCheck, useHasPermission, useHasRole, usePermission };
+export { type ApiResourceType, type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, type CanProps, type CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type CreateMenuResourceBody, type CreateSystemRoleBody, type CreateSystemUserBody, type FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, type FetchSystemGroupsParams, type FetchSystemRoleOptionsParams, type FetchSystemRolesParams, type FetchSystemUsersParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, MENU_LEAF_NO, MENU_LEAF_YES, MENU_LIST_TYPE_PARAM, MENU_TYPE_BUTTON, MENU_TYPE_LABEL, MENU_TYPE_MENU, MENU_TYPE_OPTIONS, MENU_TYPE_PAGE, MENU_VISIBILITY_OPTIONS, type MatchMode, MenuManager, type MenuManagerProps, type MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionListener, PermissionProvider, type PermissionProviderProps, type PermissionState, PermissionStore, type PermissionStoreAPI, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, ROOT_MENU_DEPTH, ROOT_PARENT_ID, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, RoleManager, type RoleManagerProps, type RolePermissionTreeNode, type RolePermissionsResult, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, type SaveRolePermissionsBody, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminProps, type SystemAdminSubMenu, type SystemGroupOption, type SystemRole, type SystemRoleApi, type SystemRoleFormValues, type SystemRoleListResult, type SystemRoleOption, type SystemUser, type SystemUserApi, type SystemUserFormValues, type SystemUserListResult, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UpdateSystemRoleBody, type UpdateSystemUserBody, type UsePermissionResult, UserManager, type UserManagerProps, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildCreateRoleBody, buildCreateUserBody, buildPermissionTreeIndex, buildSavePermissionsBody, buildUpdateBody, buildUpdateMenuBody, buildUpdateRoleBody, buildUpdateUserBody, collectTreeResourceIds, countCheckedDescendants, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionStore, createSystemRoleApi, createSystemUserApi, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, hasCheckedDescendant, isMenuLeaf, isPermissionNodeIndeterminate, mapAuthorizationResource, mapMenuResource, mapPermissionTreeNode, mapRolePermissions, mapSystemGroupOption, mapSystemRole, mapSystemRoleOption, mapSystemUser, resolveMenuDepth, snowyflake, togglePermissionCheck, useHasPermission, useHasRole, usePermission, validateUsername };