com-angel-authorization 1.0.5 → 1.0.7

package/dist/react/index.d.cts

@@ -127,11 +127,16 @@ type ListPaginationResult = {
     hasPreviousPage: boolean;
     hasNextPage: boolean;
 };
-/** 权限点状态：1 启用，0 禁用 */
+/** 通用状态：权限点 1 启用 / 0 禁用；菜单 1 显示 / 0 隐藏 */
 type ResourceStatus = 0 | 1;
+/** 权限点类型 */
+type ApiResourceType = 'api';
+/** 菜单资源类型 */
+type MenuResourceType = 'page' | 'menu' | 'button';
+type ResourceType = ApiResourceType | MenuResourceType;
 type AuthorizationResource = {
     resourceId: string;
-    type: 'api';
+    type: ApiResourceType;
     name: string;
     identification: string;
     status: ResourceStatus;
@@ -147,10 +152,10 @@ type AuthorizationResourceFormValues = {
 };
 type CreateAuthorizationResourceBody = AuthorizationResourceFormValues & {
     resourceId: string;
-    type: 'api';
+    type: ApiResourceType;
 };
 type UpdateAuthorizationResourceBody = Partial<AuthorizationResourceFormValues> & {
-    type?: 'api';
+    type?: ApiResourceType;
 };
 type FetchAuthorizationResourcesParams = {
     pagination?: ListPaginationParams;
@@ -161,17 +166,65 @@ type AuthorizationResourceListResult = {
     hasPreviousPage: boolean;
     hasNextPage: boolean;
 };
-declare const RESOURCE_TYPE_API: "api";
+type MenuResource = {
+    resourceId: string;
+    parentId: string;
+    type: MenuResourceType;
+    name: string;
+    identification: string;
+    permissionPointIds: string[];
+    /** 关联权限点名称（列表展示用，后端可能返回） */
+    permissionPointNames?: string[];
+    status: ResourceStatus;
+};
+type MenuResourceFormValues = {
+    parentId: string;
+    type: MenuResourceType;
+    name: string;
+    identification: string;
+    permissionPointIds: string[];
+    status: ResourceStatus;
+};
+type CreateMenuResourceBody = MenuResourceFormValues & {
+    resourceId: string;
+};
+type UpdateMenuResourceBody = Partial<MenuResourceFormValues>;
+type FetchMenuResourcesParams = {
+    pagination?: ListPaginationParams;
+};
+type MenuResourceListResult = {
+    records: MenuResource[];
+    pageToken: string;
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+};
+declare const RESOURCE_TYPE_API: ApiResourceType;
+declare const MENU_TYPE_PAGE: MenuResourceType;
+declare const MENU_TYPE_MENU: MenuResourceType;
+declare const MENU_TYPE_BUTTON: MenuResourceType;
+/** 菜单列表查询 type 参数 */
+declare const MENU_LIST_TYPE_PARAM = "page,menu,button";
+declare const ROOT_PARENT_ID = "0";
 declare const RESOURCE_STATUS_ENABLED: ResourceStatus;
 declare const RESOURCE_STATUS_DISABLED: ResourceStatus;
 declare const RESOURCE_STATUS_OPTIONS: {
     label: string;
     value: ResourceStatus;
 }[];
+/** 菜单可见性 */
+declare const MENU_VISIBILITY_OPTIONS: {
+    label: string;
+    value: ResourceStatus;
+}[];
 declare const RESOURCE_PRIVATE_OPTIONS: {
     label: string;
     value: boolean;
 }[];
+declare const MENU_TYPE_OPTIONS: {
+    label: string;
+    value: MenuResourceType;
+}[];
+declare const MENU_TYPE_LABEL: Record<MenuResourceType, string>;
 
 type HttpMethod = 'GET' | 'POST' | 'PATCH' | 'DELETE';
 type ResourceRequestOptions = {
@@ -190,10 +243,22 @@ type AuthorizationResourceApi = {
     update: (resourceId: string, values: AuthorizationResourceFormValues, signal?: AbortSignal) => Promise<unknown>;
     remove: (resourceId: string, signal?: AbortSignal) => Promise<unknown>;
 };
+type MenuResourceApi = {
+    list: (params?: FetchMenuResourcesParams, signal?: AbortSignal) => Promise<MenuResourceListResult>;
+    /** 拉取权限点（type=api），供菜单表单多选 */
+    listPermissionPoints: (params?: FetchAuthorizationResourcesParams, signal?: AbortSignal) => Promise<AuthorizationResourceListResult>;
+    create: (values: MenuResourceFormValues, signal?: AbortSignal) => Promise<unknown>;
+    update: (resourceId: string, values: MenuResourceFormValues, signal?: AbortSignal) => Promise<unknown>;
+    remove: (resourceId: string, signal?: AbortSignal) => Promise<unknown>;
+};
 declare function mapAuthorizationResource(item: unknown): AuthorizationResource | null;
+declare function mapMenuResource(item: unknown): MenuResource | null;
 declare function buildCreateBody(values: AuthorizationResourceFormValues, resourceId?: string): CreateAuthorizationResourceBody;
 declare function buildUpdateBody(values: AuthorizationResourceFormValues): UpdateAuthorizationResourceBody;
+declare function buildCreateMenuBody(values: MenuResourceFormValues, resourceId?: string): CreateMenuResourceBody;
+declare function buildUpdateMenuBody(values: MenuResourceFormValues): UpdateMenuResourceBody;
 declare function createAuthorizationResourceApi(request: ResourceHttpRequest): AuthorizationResourceApi;
+declare function createMenuResourceApi(request: ResourceHttpRequest): MenuResourceApi;
 type CreateDefaultResourceRequestOptions = {
     /** API 前缀，如 `/api` 或完整域名 */
     baseUrl?: string;
@@ -220,6 +285,44 @@ type ResourceManagerProps = {
 };
 declare function ResourceManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: ResourceManagerProps): react.JSX.Element;
 
+type MenuManagerProps = {
+    api: MenuResourceApi;
+    title?: string;
+    pageSize?: string;
+    toolbarExtra?: ReactNode;
+};
+declare function MenuManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: MenuManagerProps): react.JSX.Element;
+
+type SystemAdminMenuKey = 'menu' | 'resource';
+type SystemAdminSubMenu = {
+    key: SystemAdminMenuKey;
+    label: string;
+};
+type SystemAdminMenuGroup = {
+    key: 'system';
+    label: string;
+    children: SystemAdminSubMenu[];
+};
+/** 系统管理菜单结构：菜单管理、权限点管理为其子菜单 */
+declare const SYSTEM_ADMIN_MENU: SystemAdminMenuGroup;
+declare const SYSTEM_ADMIN_DEFAULT_KEY: SystemAdminMenuKey;
+
+type SystemAdminProps = {
+    menuApi: MenuResourceApi;
+    resourceApi: AuthorizationResourceApi;
+    /** 默认选中的子菜单，默认菜单管理 */
+    defaultActiveKey?: SystemAdminMenuKey;
+    /** 受控选中 key */
+    activeKey?: SystemAdminMenuKey;
+    onActiveKeyChange?: (key: SystemAdminMenuKey) => void;
+    title?: string;
+    toolbarExtra?: ReactNode;
+};
+/**
+ * 系统管理：侧栏父菜单「系统管理」，子菜单为「菜单管理」「权限点管理」。
+ */
+declare function SystemAdmin({ menuApi, resourceApi, defaultActiveKey, activeKey: controlledKey, onActiveKeyChange, title, toolbarExtra, }: SystemAdminProps): react.JSX.Element;
+
 interface SnowyflakeOptions {
     epoch?: bigint;
     workerId?: bigint;
@@ -250,4 +353,4 @@ declare const snowyflake: ConfigurableSnowflake;
 declare function getAppClientId(): string;
 declare function getDeviceWorkerId(): string;
 
-export { type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, type CanProps, type CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type FetchAuthorizationResourcesParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, type MatchMode, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionListener, PermissionProvider, type PermissionProviderProps, type PermissionState, PermissionStore, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type RoleCode, type UpdateAuthorizationResourceBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildUpdateBody, createAuthorizationResourceApi, createDefaultResourceRequest, createPermissionStore, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, mapAuthorizationResource, snowyflake, 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 FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, 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, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, ROOT_PARENT_ID, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminProps, type SystemAdminSubMenu, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildUpdateBody, buildUpdateMenuBody, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionStore, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, mapAuthorizationResource, mapMenuResource, snowyflake, useHasPermission, useHasRole, usePermission };

package/dist/react/index.d.ts

@@ -127,11 +127,16 @@ type ListPaginationResult = {
     hasPreviousPage: boolean;
     hasNextPage: boolean;
 };
-/** 权限点状态：1 启用，0 禁用 */
+/** 通用状态：权限点 1 启用 / 0 禁用；菜单 1 显示 / 0 隐藏 */
 type ResourceStatus = 0 | 1;
+/** 权限点类型 */
+type ApiResourceType = 'api';
+/** 菜单资源类型 */
+type MenuResourceType = 'page' | 'menu' | 'button';
+type ResourceType = ApiResourceType | MenuResourceType;
 type AuthorizationResource = {
     resourceId: string;
-    type: 'api';
+    type: ApiResourceType;
     name: string;
     identification: string;
     status: ResourceStatus;
@@ -147,10 +152,10 @@ type AuthorizationResourceFormValues = {
 };
 type CreateAuthorizationResourceBody = AuthorizationResourceFormValues & {
     resourceId: string;
-    type: 'api';
+    type: ApiResourceType;
 };
 type UpdateAuthorizationResourceBody = Partial<AuthorizationResourceFormValues> & {
-    type?: 'api';
+    type?: ApiResourceType;
 };
 type FetchAuthorizationResourcesParams = {
     pagination?: ListPaginationParams;
@@ -161,17 +166,65 @@ type AuthorizationResourceListResult = {
     hasPreviousPage: boolean;
     hasNextPage: boolean;
 };
-declare const RESOURCE_TYPE_API: "api";
+type MenuResource = {
+    resourceId: string;
+    parentId: string;
+    type: MenuResourceType;
+    name: string;
+    identification: string;
+    permissionPointIds: string[];
+    /** 关联权限点名称（列表展示用，后端可能返回） */
+    permissionPointNames?: string[];
+    status: ResourceStatus;
+};
+type MenuResourceFormValues = {
+    parentId: string;
+    type: MenuResourceType;
+    name: string;
+    identification: string;
+    permissionPointIds: string[];
+    status: ResourceStatus;
+};
+type CreateMenuResourceBody = MenuResourceFormValues & {
+    resourceId: string;
+};
+type UpdateMenuResourceBody = Partial<MenuResourceFormValues>;
+type FetchMenuResourcesParams = {
+    pagination?: ListPaginationParams;
+};
+type MenuResourceListResult = {
+    records: MenuResource[];
+    pageToken: string;
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+};
+declare const RESOURCE_TYPE_API: ApiResourceType;
+declare const MENU_TYPE_PAGE: MenuResourceType;
+declare const MENU_TYPE_MENU: MenuResourceType;
+declare const MENU_TYPE_BUTTON: MenuResourceType;
+/** 菜单列表查询 type 参数 */
+declare const MENU_LIST_TYPE_PARAM = "page,menu,button";
+declare const ROOT_PARENT_ID = "0";
 declare const RESOURCE_STATUS_ENABLED: ResourceStatus;
 declare const RESOURCE_STATUS_DISABLED: ResourceStatus;
 declare const RESOURCE_STATUS_OPTIONS: {
     label: string;
     value: ResourceStatus;
 }[];
+/** 菜单可见性 */
+declare const MENU_VISIBILITY_OPTIONS: {
+    label: string;
+    value: ResourceStatus;
+}[];
 declare const RESOURCE_PRIVATE_OPTIONS: {
     label: string;
     value: boolean;
 }[];
+declare const MENU_TYPE_OPTIONS: {
+    label: string;
+    value: MenuResourceType;
+}[];
+declare const MENU_TYPE_LABEL: Record<MenuResourceType, string>;
 
 type HttpMethod = 'GET' | 'POST' | 'PATCH' | 'DELETE';
 type ResourceRequestOptions = {
@@ -190,10 +243,22 @@ type AuthorizationResourceApi = {
     update: (resourceId: string, values: AuthorizationResourceFormValues, signal?: AbortSignal) => Promise<unknown>;
     remove: (resourceId: string, signal?: AbortSignal) => Promise<unknown>;
 };
+type MenuResourceApi = {
+    list: (params?: FetchMenuResourcesParams, signal?: AbortSignal) => Promise<MenuResourceListResult>;
+    /** 拉取权限点（type=api），供菜单表单多选 */
+    listPermissionPoints: (params?: FetchAuthorizationResourcesParams, signal?: AbortSignal) => Promise<AuthorizationResourceListResult>;
+    create: (values: MenuResourceFormValues, signal?: AbortSignal) => Promise<unknown>;
+    update: (resourceId: string, values: MenuResourceFormValues, signal?: AbortSignal) => Promise<unknown>;
+    remove: (resourceId: string, signal?: AbortSignal) => Promise<unknown>;
+};
 declare function mapAuthorizationResource(item: unknown): AuthorizationResource | null;
+declare function mapMenuResource(item: unknown): MenuResource | null;
 declare function buildCreateBody(values: AuthorizationResourceFormValues, resourceId?: string): CreateAuthorizationResourceBody;
 declare function buildUpdateBody(values: AuthorizationResourceFormValues): UpdateAuthorizationResourceBody;
+declare function buildCreateMenuBody(values: MenuResourceFormValues, resourceId?: string): CreateMenuResourceBody;
+declare function buildUpdateMenuBody(values: MenuResourceFormValues): UpdateMenuResourceBody;
 declare function createAuthorizationResourceApi(request: ResourceHttpRequest): AuthorizationResourceApi;
+declare function createMenuResourceApi(request: ResourceHttpRequest): MenuResourceApi;
 type CreateDefaultResourceRequestOptions = {
     /** API 前缀，如 `/api` 或完整域名 */
     baseUrl?: string;
@@ -220,6 +285,44 @@ type ResourceManagerProps = {
 };
 declare function ResourceManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: ResourceManagerProps): react.JSX.Element;
 
+type MenuManagerProps = {
+    api: MenuResourceApi;
+    title?: string;
+    pageSize?: string;
+    toolbarExtra?: ReactNode;
+};
+declare function MenuManager({ api, title, pageSize: initialPageSize, toolbarExtra, }: MenuManagerProps): react.JSX.Element;
+
+type SystemAdminMenuKey = 'menu' | 'resource';
+type SystemAdminSubMenu = {
+    key: SystemAdminMenuKey;
+    label: string;
+};
+type SystemAdminMenuGroup = {
+    key: 'system';
+    label: string;
+    children: SystemAdminSubMenu[];
+};
+/** 系统管理菜单结构：菜单管理、权限点管理为其子菜单 */
+declare const SYSTEM_ADMIN_MENU: SystemAdminMenuGroup;
+declare const SYSTEM_ADMIN_DEFAULT_KEY: SystemAdminMenuKey;
+
+type SystemAdminProps = {
+    menuApi: MenuResourceApi;
+    resourceApi: AuthorizationResourceApi;
+    /** 默认选中的子菜单，默认菜单管理 */
+    defaultActiveKey?: SystemAdminMenuKey;
+    /** 受控选中 key */
+    activeKey?: SystemAdminMenuKey;
+    onActiveKeyChange?: (key: SystemAdminMenuKey) => void;
+    title?: string;
+    toolbarExtra?: ReactNode;
+};
+/**
+ * 系统管理：侧栏父菜单「系统管理」，子菜单为「菜单管理」「权限点管理」。
+ */
+declare function SystemAdmin({ menuApi, resourceApi, defaultActiveKey, activeKey: controlledKey, onActiveKeyChange, title, toolbarExtra, }: SystemAdminProps): react.JSX.Element;
+
 interface SnowyflakeOptions {
     epoch?: bigint;
     workerId?: bigint;
@@ -250,4 +353,4 @@ declare const snowyflake: ConfigurableSnowflake;
 declare function getAppClientId(): string;
 declare function getDeviceWorkerId(): string;
 
-export { type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, type CanProps, type CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type FetchAuthorizationResourcesParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, type MatchMode, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionListener, PermissionProvider, type PermissionProviderProps, type PermissionState, PermissionStore, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type RoleCode, type UpdateAuthorizationResourceBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildUpdateBody, createAuthorizationResourceApi, createDefaultResourceRequest, createPermissionStore, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, mapAuthorizationResource, snowyflake, 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 FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, type HttpMethod, type ListPaginationParams, type ListPaginationResult, 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, RESOURCE_PRIVATE_OPTIONS, RESOURCE_STATUS_DISABLED, RESOURCE_STATUS_ENABLED, RESOURCE_STATUS_OPTIONS, RESOURCE_TYPE_API, ROOT_PARENT_ID, type ResourceHttpRequest, ResourceManager, type ResourceManagerProps, type ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminProps, type SystemAdminSubMenu, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildUpdateBody, buildUpdateMenuBody, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionStore, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, mapAuthorizationResource, mapMenuResource, snowyflake, useHasPermission, useHasRole, usePermission };