com-angel-authorization 1.0.14 → 1.0.15

package/dist/vue/index.d.cts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { InjectionKey, ComputedRef, Plugin, Directive, PropType } from 'vue';
+import { InjectionKey, ComputedRef, Plugin, Directive, PropType, VNode } from 'vue';
 
 type PermissionCode = string;
 type RoleCode = string;
@@ -448,7 +448,99 @@ declare const MenuManager: vue.DefineComponent<vue.ExtractPropTypes<{
     pageSize: string;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
-type SystemAdminMenuKey = 'menu' | 'resource';
+type SystemRole = {
+    roleId: string;
+    name: string;
+    description: string;
+};
+type SystemRoleFormValues = {
+    name: string;
+    description: string;
+};
+type CreateSystemRoleBody = SystemRoleFormValues;
+type UpdateSystemRoleBody = Partial<SystemRoleFormValues>;
+type FetchSystemRolesParams = {
+    keyword?: string;
+    pagination?: ListPaginationParams;
+};
+type SystemRoleListResult = {
+    records: SystemRole[];
+    pageToken: string;
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+};
+/** 角色授权树节点 */
+type RolePermissionTreeNode = {
+    resourceId: string;
+    name: string;
+    children: RolePermissionTreeNode[];
+};
+/** GET /system/roles/{role-id}/permissions */
+type RolePermissionsResult = {
+    /** 当前角色已授予的资源 ID，用于树回显勾选 */
+    resourceIds: string[];
+    resourceTree: RolePermissionTreeNode[];
+};
+/** POST /system/roles/{role-id}/permissions */
+type SaveRolePermissionsBody = {
+    resourceIds: string[];
+};
+
+type SystemRoleApi = {
+    list: (params?: FetchSystemRolesParams, signal?: AbortSignal) => Promise<SystemRoleListResult>;
+    create: (values: SystemRoleFormValues, signal?: AbortSignal) => Promise<unknown>;
+    update: (roleId: string, values: SystemRoleFormValues, signal?: AbortSignal) => Promise<unknown>;
+    remove: (roleId: string, signal?: AbortSignal) => Promise<unknown>;
+    getPermissions: (roleId: string, signal?: AbortSignal) => Promise<RolePermissionsResult>;
+    savePermissions: (roleId: string, resourceIds: string[], signal?: AbortSignal) => Promise<unknown>;
+};
+declare function mapSystemRole(item: unknown): SystemRole | null;
+declare function mapPermissionTreeNode(item: unknown): RolePermissionTreeNode | null;
+declare function mapRolePermissions(payload: unknown): RolePermissionsResult;
+/** 收集节点及其全部子孙 resourceId */
+declare function collectTreeResourceIds(node: RolePermissionTreeNode): string[];
+declare function buildCreateRoleBody(values: SystemRoleFormValues): CreateSystemRoleBody;
+declare function buildUpdateRoleBody(values: SystemRoleFormValues): UpdateSystemRoleBody;
+declare function buildSavePermissionsBody(resourceIds: string[]): SaveRolePermissionsBody;
+declare function createSystemRoleApi(request: ResourceHttpRequest): SystemRoleApi;
+
+/**
+ * 角色管理页面（Vue 3）
+ */
+declare const RoleManager: vue.DefineComponent<vue.ExtractPropTypes<{
+    api: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    pageSize: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    api: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    pageSize: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    title: string;
+    pageSize: string;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+type SystemAdminMenuKey = 'menu' | 'resource' | 'role';
 type SystemAdminSubMenu = {
     key: SystemAdminMenuKey;
     label: string;
@@ -458,12 +550,12 @@ type SystemAdminMenuGroup = {
     label: string;
     children: SystemAdminSubMenu[];
 };
-/** 系统管理菜单结构：菜单管理、权限点管理为其子菜单 */
+/** 系统管理菜单结构 */
 declare const SYSTEM_ADMIN_MENU: SystemAdminMenuGroup;
 declare const SYSTEM_ADMIN_DEFAULT_KEY: SystemAdminMenuKey;
 
 /**
- * 系统管理：侧栏父菜单「系统管理」，子菜单为「菜单管理」「权限点管理」。
+ * 系统管理：侧栏父菜单「系统管理」，子菜单为菜单 / 权限点 / 角色管理。
  */
 declare const SystemAdmin: vue.DefineComponent<vue.ExtractPropTypes<{
     menuApi: {
@@ -474,6 +566,10 @@ declare const SystemAdmin: vue.DefineComponent<vue.ExtractPropTypes<{
         type: PropType<AuthorizationResourceApi>;
         required: true;
     };
+    roleApi: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
     defaultActiveKey: {
         type: PropType<SystemAdminMenuKey>;
         default: SystemAdminMenuKey;
@@ -500,6 +596,10 @@ declare const SystemAdmin: vue.DefineComponent<vue.ExtractPropTypes<{
         type: PropType<AuthorizationResourceApi>;
         required: true;
     };
+    roleApi: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
     defaultActiveKey: {
         type: PropType<SystemAdminMenuKey>;
         default: SystemAdminMenuKey;
@@ -551,4 +651,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 CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type CreateMenuResourceBody, type FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, 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 MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, PERMISSION_STORE_KEY, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionDirectiveValue, type PermissionListener, type PermissionPluginOptions, 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 ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminSubMenu, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildUpdateBody, buildUpdateMenuBody, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionPlugin, createPermissionStore, createVPermission, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, isMenuLeaf, mapAuthorizationResource, mapMenuResource, resolveMenuDepth, snowyflake, useHasPermission, useHasRole, usePermission };
+export { type ApiResourceType, type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, 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 MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, PERMISSION_STORE_KEY, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionDirectiveValue, type PermissionListener, type PermissionPluginOptions, 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 ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, RoleManager, type RolePermissionTreeNode, type RolePermissionsResult, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, type SaveRolePermissionsBody, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminSubMenu, type SystemRole, type SystemRoleApi, type SystemRoleFormValues, type SystemRoleListResult, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UpdateSystemRoleBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildCreateRoleBody, buildSavePermissionsBody, buildUpdateBody, buildUpdateMenuBody, buildUpdateRoleBody, collectTreeResourceIds, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionPlugin, createPermissionStore, createSystemRoleApi, createVPermission, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, isMenuLeaf, mapAuthorizationResource, mapMenuResource, mapPermissionTreeNode, mapRolePermissions, mapSystemRole, resolveMenuDepth, snowyflake, useHasPermission, useHasRole, usePermission };

package/dist/vue/index.d.ts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { InjectionKey, ComputedRef, Plugin, Directive, PropType } from 'vue';
+import { InjectionKey, ComputedRef, Plugin, Directive, PropType, VNode } from 'vue';
 
 type PermissionCode = string;
 type RoleCode = string;
@@ -448,7 +448,99 @@ declare const MenuManager: vue.DefineComponent<vue.ExtractPropTypes<{
     pageSize: string;
 }, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
-type SystemAdminMenuKey = 'menu' | 'resource';
+type SystemRole = {
+    roleId: string;
+    name: string;
+    description: string;
+};
+type SystemRoleFormValues = {
+    name: string;
+    description: string;
+};
+type CreateSystemRoleBody = SystemRoleFormValues;
+type UpdateSystemRoleBody = Partial<SystemRoleFormValues>;
+type FetchSystemRolesParams = {
+    keyword?: string;
+    pagination?: ListPaginationParams;
+};
+type SystemRoleListResult = {
+    records: SystemRole[];
+    pageToken: string;
+    hasPreviousPage: boolean;
+    hasNextPage: boolean;
+};
+/** 角色授权树节点 */
+type RolePermissionTreeNode = {
+    resourceId: string;
+    name: string;
+    children: RolePermissionTreeNode[];
+};
+/** GET /system/roles/{role-id}/permissions */
+type RolePermissionsResult = {
+    /** 当前角色已授予的资源 ID，用于树回显勾选 */
+    resourceIds: string[];
+    resourceTree: RolePermissionTreeNode[];
+};
+/** POST /system/roles/{role-id}/permissions */
+type SaveRolePermissionsBody = {
+    resourceIds: string[];
+};
+
+type SystemRoleApi = {
+    list: (params?: FetchSystemRolesParams, signal?: AbortSignal) => Promise<SystemRoleListResult>;
+    create: (values: SystemRoleFormValues, signal?: AbortSignal) => Promise<unknown>;
+    update: (roleId: string, values: SystemRoleFormValues, signal?: AbortSignal) => Promise<unknown>;
+    remove: (roleId: string, signal?: AbortSignal) => Promise<unknown>;
+    getPermissions: (roleId: string, signal?: AbortSignal) => Promise<RolePermissionsResult>;
+    savePermissions: (roleId: string, resourceIds: string[], signal?: AbortSignal) => Promise<unknown>;
+};
+declare function mapSystemRole(item: unknown): SystemRole | null;
+declare function mapPermissionTreeNode(item: unknown): RolePermissionTreeNode | null;
+declare function mapRolePermissions(payload: unknown): RolePermissionsResult;
+/** 收集节点及其全部子孙 resourceId */
+declare function collectTreeResourceIds(node: RolePermissionTreeNode): string[];
+declare function buildCreateRoleBody(values: SystemRoleFormValues): CreateSystemRoleBody;
+declare function buildUpdateRoleBody(values: SystemRoleFormValues): UpdateSystemRoleBody;
+declare function buildSavePermissionsBody(resourceIds: string[]): SaveRolePermissionsBody;
+declare function createSystemRoleApi(request: ResourceHttpRequest): SystemRoleApi;
+
+/**
+ * 角色管理页面（Vue 3）
+ */
+declare const RoleManager: vue.DefineComponent<vue.ExtractPropTypes<{
+    api: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    pageSize: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    api: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    pageSize: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    title: string;
+    pageSize: string;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+type SystemAdminMenuKey = 'menu' | 'resource' | 'role';
 type SystemAdminSubMenu = {
     key: SystemAdminMenuKey;
     label: string;
@@ -458,12 +550,12 @@ type SystemAdminMenuGroup = {
     label: string;
     children: SystemAdminSubMenu[];
 };
-/** 系统管理菜单结构：菜单管理、权限点管理为其子菜单 */
+/** 系统管理菜单结构 */
 declare const SYSTEM_ADMIN_MENU: SystemAdminMenuGroup;
 declare const SYSTEM_ADMIN_DEFAULT_KEY: SystemAdminMenuKey;
 
 /**
- * 系统管理：侧栏父菜单「系统管理」，子菜单为「菜单管理」「权限点管理」。
+ * 系统管理：侧栏父菜单「系统管理」，子菜单为菜单 / 权限点 / 角色管理。
  */
 declare const SystemAdmin: vue.DefineComponent<vue.ExtractPropTypes<{
     menuApi: {
@@ -474,6 +566,10 @@ declare const SystemAdmin: vue.DefineComponent<vue.ExtractPropTypes<{
         type: PropType<AuthorizationResourceApi>;
         required: true;
     };
+    roleApi: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
     defaultActiveKey: {
         type: PropType<SystemAdminMenuKey>;
         default: SystemAdminMenuKey;
@@ -500,6 +596,10 @@ declare const SystemAdmin: vue.DefineComponent<vue.ExtractPropTypes<{
         type: PropType<AuthorizationResourceApi>;
         required: true;
     };
+    roleApi: {
+        type: PropType<SystemRoleApi>;
+        required: true;
+    };
     defaultActiveKey: {
         type: PropType<SystemAdminMenuKey>;
         default: SystemAdminMenuKey;
@@ -551,4 +651,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 CheckOptions, type CreateAuthorizationResourceBody, type CreateDefaultResourceRequestOptions, type CreateMenuResourceBody, type FetchAuthorizationResourcesParams, type FetchMenuResourcesParams, 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 MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, PERMISSION_STORE_KEY, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionDirectiveValue, type PermissionListener, type PermissionPluginOptions, 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 ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminSubMenu, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildUpdateBody, buildUpdateMenuBody, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionPlugin, createPermissionStore, createVPermission, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, isMenuLeaf, mapAuthorizationResource, mapMenuResource, resolveMenuDepth, snowyflake, useHasPermission, useHasRole, usePermission };
+export { type ApiResourceType, type AuthorizationResource, type AuthorizationResourceApi, type AuthorizationResourceFormValues, type AuthorizationResourceListResult, Can, 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 MenuResource, type MenuResourceApi, type MenuResourceFormValues, type MenuResourceListResult, type MenuResourceType, PERMISSION_STORE_KEY, type PageDirection, type PermissionChecker, type PermissionCode, type PermissionDirectiveValue, type PermissionListener, type PermissionPluginOptions, 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 ResourceRequestOptions, type ResourceStatus, type ResourceType, type RoleCode, RoleManager, type RolePermissionTreeNode, type RolePermissionsResult, SYSTEM_ADMIN_DEFAULT_KEY, SYSTEM_ADMIN_MENU, type SaveRolePermissionsBody, SystemAdmin, type SystemAdminMenuGroup, type SystemAdminMenuKey, type SystemAdminSubMenu, type SystemRole, type SystemRoleApi, type SystemRoleFormValues, type SystemRoleListResult, type UpdateAuthorizationResourceBody, type UpdateMenuResourceBody, type UpdateSystemRoleBody, type UsePermissionResult, appendQueryParam, buildCreateBody, buildCreateMenuBody, buildCreateRoleBody, buildSavePermissionsBody, buildUpdateBody, buildUpdateMenuBody, buildUpdateRoleBody, collectTreeResourceIds, createAuthorizationResourceApi, createDefaultResourceRequest, createMenuResourceApi, createPermissionPlugin, createPermissionStore, createSystemRoleApi, createVPermission, extractPagination, extractRecords, getAppClientId, getDeviceWorkerId, isMenuLeaf, mapAuthorizationResource, mapMenuResource, mapPermissionTreeNode, mapRolePermissions, mapSystemRole, resolveMenuDepth, snowyflake, useHasPermission, useHasRole, usePermission };