@next-api-sdk/permission-sdk 1.1.0

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+export * from "./api/permission/audit/index.js";
+export * from "./api/permission/cache_manager/index.js";
+export * from "./api/permission/change_history/index.js";
+export * from "./api/permission/inheritance/index.js";
+export * from "./api/permission/menu/index.js";
+export * from "./api/permission/org/index.js";
+export * from "./api/permission/permission/index.js";
+export * from "./api/permission/permission_system_module/index.js";
+export * from "./api/permission/permission_v2/index.js";
+export * from "./api/permission/policy/index.js";
+export * from "./api/permission/policy_resource_enable/index.js";
+export * from "./api/permission/policy_validate/index.js";
+export * from "./api/permission/resource_action/index.js";
+export * from "./api/permission/role/index.js";
+export * from "./api/permission/role_v2/index.js";
+export * as PermissionModels from "./model/permission/index.js";
+export * as CmdbModels from "./model/cmdb/index.js";
+export * as CommonModels from "./model/common/index.js";

package/dist/types/model/cmdb/ModelCmdbSort.d.ts

@@ -0,0 +1,7 @@
+/** CmdbSort */
+export interface ModelCmdbSort {
+    /** 属性id */
+    key: string;
+    /** 1表示升序， -1表示降序, 2表示自然升序， -2表示自然降序 */
+    order: -1 | 1 | -2 | 2;
+}

package/dist/types/model/cmdb/index.d.ts

@@ -0,0 +1 @@
+export * from "./ModelCmdbSort.js";

package/dist/types/model/common/ModelIcon.d.ts

@@ -0,0 +1,13 @@
+/** Icon */
+export interface ModelIcon {
+    /** icon */
+    icon: string;
+    /** lib */
+    lib: string;
+    /** category */
+    category: string;
+    /** prefix */
+    prefix: string;
+    /** color */
+    color: string;
+}

package/dist/types/model/common/index.d.ts

@@ -0,0 +1 @@
+export * from "./ModelIcon.js";

package/dist/types/model/permission/ModelBaseRole.d.ts

@@ -0,0 +1,9 @@
+/** 权限角色基本字段, CMDB的存储结构 */
+export interface ModelBaseRole {
+    /** 实例id */
+    instanceId: string;
+    /** 角色名称 */
+    role: string;
+    /** 旧的角色id，保留项 */
+    oid: string;
+}

package/dist/types/model/permission/ModelBaseUserGroup.d.ts

@@ -0,0 +1,7 @@
+/** 权限角色基本字段, CMDB的存储结构 */
+export interface ModelBaseUserGroup {
+    /** 实例id */
+    instanceId: string;
+    /** 组名称 */
+    name: string;
+}

package/dist/types/model/permission/ModelChangeHistory.d.ts

@@ -0,0 +1,15 @@
+/** 变更历史 */
+export interface ModelChangeHistory {
+    /** 操作 */
+    operation: string;
+    /** 执行用户 */
+    operator: string;
+    /** 变更摘要 */
+    detail: string;
+    /** 来源ip */
+    remote_addr: string;
+    /** 操作是否成功 */
+    status: "success" | "fail";
+    /** 操作时间 */
+    time: number;
+}

package/dist/types/model/permission/ModelColumnDbSearchPrepare.d.ts

@@ -0,0 +1,11 @@
+/** columnDB辅助查询 */
+export interface ModelColumnDbSearchPrepare {
+    /** name */
+    name: string;
+    /** 资源id */
+    resource: string;
+    /** 查询条件 */
+    filter: string;
+    /** 选择字段 */
+    fields: string[];
+}

package/dist/types/model/permission/ModelInheritNode.d.ts

@@ -0,0 +1,14 @@
+import { ModelInheritNodeFilter } from "./index.js";
+/** 继承规则节点定义 */
+export interface ModelInheritNode {
+    /** 当前节点模型id */
+    objectId: string;
+    /** 关系id */
+    relationId: string;
+    /** 指向下一节点的关系sideId */
+    relationSideId: string;
+    /** 变更字段 */
+    effectFields: string[];
+    /** 当前节点查询条件 */
+    filters: Partial<ModelInheritNodeFilter>[];
+}

package/dist/types/model/permission/ModelInheritNodeFilter.d.ts

@@ -0,0 +1,9 @@
+/** 继承规则节点过滤条件 */
+export interface ModelInheritNodeFilter {
+    /** 字段名称 */
+    name: string;
+    /** 操作符 */
+    operator: "eq" | "ne" | "like" | "lt" | "gt" | "lte" | "gte" | "in";
+    /** 比较值 */
+    value: any;
+}

package/dist/types/model/permission/ModelInheritRule.d.ts

@@ -0,0 +1,34 @@
+import { ModelInheritNode } from "./index.js";
+/** 继承规则定义 */
+export interface ModelInheritRule {
+    /** 规则id */
+    instanceId: string;
+    /** 规则名称 */
+    name: string;
+    /** 路径标识 */
+    label: string;
+    /** 路径id */
+    pathId: string;
+    /** 起点模型id */
+    sourceObjectId: string;
+    /** 触发变更的模型字段 */
+    sourceField: string;
+    /** 触发变更字段类型 */
+    sourceKind: "USER" | "USER_GROUP";
+    /** 是否启用 */
+    enable: boolean;
+    /** 是否异常 */
+    abnormal: boolean;
+    /** 规则路径 */
+    path: Partial<ModelInheritNode>[];
+    /** 受影响的所有模型id */
+    effectObjectIdList: string[];
+    /** query条件key,反向 */
+    reverseQueryKey: string;
+    /** 是否所有实例开启白名单 */
+    effectAll: boolean;
+    /** 创建时间 */
+    ctime: string;
+    /** 编辑时间 */
+    mtime: string;
+}

package/dist/types/model/permission/ModelLoginTrack.d.ts

@@ -0,0 +1,15 @@
+/** 登录轨迹 */
+export interface ModelLoginTrack {
+    /** 操作 */
+    operation: string;
+    /** 登录用户 */
+    user: string;
+    /** 来源 IP */
+    ip: string;
+    /** 登录结果 */
+    result: "success" | "failed";
+    /** 会话原因 */
+    detail: string;
+    /** 操作时间 */
+    time: number;
+}

package/dist/types/model/permission/ModelPermission.d.ts

@@ -0,0 +1,25 @@
+/** 权限点, mongoDB的存储结构 */
+export interface ModelPermission {
+    /** 权限点id */
+    id: string;
+    /** 组织号 */
+    org: number;
+    /** 系统名 */
+    system: string;
+    /** 需要鉴权的动作, 全局唯一 */
+    action: string;
+    /** 权限备注 */
+    remark: string;
+    /** remark英文翻译 */
+    remark_translation: string;
+    /** 权限角色 */
+    roles: string[];
+    /** 是否禁用, 默认为false */
+    disable: boolean;
+    /** 用户名列表 */
+    user: string[];
+    /** 用户组ID列表，ID开头带有分号，例：“:5c9f7b46cb292” */
+    user_group: string[];
+    /** 单个资源结构参考PermissionResource. 如果依赖多个资源，资源间判定逻辑条件用%and或者%or来扩住。 比如： { "%or":[ { "system":"flow", "condition":{ "executeAuthorizers":"%user" }, "name":"flow" }, { "system":"tool", "condition":{ "executeAuthorizers":"%user" }, "name":"tool" } ] } 表示这个权限点依赖流程的执行授权白名单和工具的执行授权白名单才能鉴权成功。 */
+    resource: any;
+}

package/dist/types/model/permission/ModelPermissionChangeDiff.d.ts

@@ -0,0 +1,9 @@
+/** 权限变更历史, 数据定义 */
+export interface ModelPermissionChangeDiff {
+    /** 变更字段 */
+    key: string;
+    /** 变更后的值 */
+    value: string;
+    /** 变更前的值 */
+    old_value: string;
+}

package/dist/types/model/permission/ModelPermissionChangeHistoryData.d.ts

@@ -0,0 +1,20 @@
+import { ModelPermissionChangeDiff } from "./index.js";
+/** 权限变更历史, 数据定义 */
+export interface ModelPermissionChangeHistoryData {
+    /** columnDB row id */
+    _row_id: string;
+    /** permission领域模型id */
+    object_id: string;
+    /** 数据实例id */
+    instance_id: string;
+    /** 业务唯一键 */
+    name: string;
+    /** 操作用户 */
+    user: string;
+    /** 事件类型 */
+    event: "event.policy.create" | "event.policy.modify" | "event.policy.delete" | "event.policy.modify_role";
+    /** 时间戳 */
+    time: number;
+    /** 变更列表, 从columnDB获取后反序列化所得 */
+    diff_list: Partial<ModelPermissionChangeDiff>[];
+}

package/dist/types/model/permission/ModelPermissionMenu.d.ts

@@ -0,0 +1,9 @@
+/** 菜单权限 */
+export interface ModelPermissionMenu {
+    /** 菜单id */
+    id: string;
+    /** 菜单唯一标识 */
+    menu_id: string;
+    /** 权限角色 */
+    roles: string[];
+}

package/dist/types/model/permission/ModelPermissionResourceEnable.d.ts

@@ -0,0 +1,11 @@
+/** 权限策略资源配置表, 模型定义 */
+export interface ModelPermissionResourceEnable {
+    /** cmdb实例id */
+    instanceId: string;
+    /** 模块id */
+    moduleId: string;
+    /** 模块名称 */
+    moduleName: string;
+    /** 资源对象 */
+    resource: string;
+}

package/dist/types/model/permission/ModelPermissionSystemModule.d.ts

@@ -0,0 +1,9 @@
+/** 权限中心模块分类, 模型定义 */
+export interface ModelPermissionSystemModule {
+    /** 实例id */
+    instanceId: string;
+    /** 模块id */
+    id: string;
+    /** 模块名称 */
+    name: string;
+}

package/dist/types/model/permission/ModelPolicy.d.ts

@@ -0,0 +1,32 @@
+import { ModelPolicyStatement, ModelColumnDbSearchPrepare } from "./index.js";
+/** 权限策略, 模型定义 */
+export interface ModelPolicy {
+    /** instance id */
+    instanceId: string;
+    /** 策略名 */
+    name: string;
+    /** 策略类型 */
+    policyType: "system" | "custom";
+    /** 规则效果 */
+    effect: "allow" | "deny";
+    /** 备注 */
+    memo: string;
+    /** 策略规则 */
+    statement: Partial<ModelPolicyStatement>[];
+    /** 是否作用到所有用户, 为true时策略对所有的user都会生效 */
+    allUser: boolean;
+    /** columnDB辅助关联查询 */
+    columnDBSearchPrepare: Partial<ModelColumnDbSearchPrepare>;
+    /** ctime */
+    ctime: string;
+    /** mtime */
+    mtime: string;
+    /** creator */
+    creator: string;
+    /** modifier */
+    modifier: string;
+    /** 是否禁用 */
+    disable: boolean;
+    /** 编辑模式 */
+    editMode: "normal" | "highLevel";
+}

package/dist/types/model/permission/ModelPolicyStatement.d.ts

@@ -0,0 +1,17 @@
+import { ModelStatementExtra } from "./index.js";
+/** 策略规则 */
+export type ModelPolicyStatement = ModelStatementExtra & ModelPolicyStatement_2;
+export interface ModelPolicyStatement_2 {
+    /** 权限点动作 */
+    action: string;
+    /** 资源数据类型 */
+    resourceType: string;
+    /** 资源授权对象 */
+    resource: string;
+    /** 动作点类型 */
+    accessLevel: "Read" | "Write" | "List";
+    /** 所属模块id */
+    systemModule: string;
+    /** 授权条件 */
+    filters: string;
+}

package/dist/types/model/permission/ModelPolicyStatementGroupByResource.d.ts

@@ -0,0 +1,29 @@
+import { ModelStatementExtra } from "./index.js";
+/** 策略规则, 以资源进行分类 */
+export type ModelPolicyStatementGroupByResource = ModelStatementExtra & ModelPolicyStatementGroupByResource_2;
+export interface ModelPolicyStatementGroupByResource_2 {
+    /** 所属模块 */
+    systemModule: string;
+    /** 资源授权对象 */
+    resource: string;
+    /** 授权条件 */
+    filters: string;
+    /** action类型统计, 展示时使用; */
+    accessCount: ModelPolicyStatementGroupByResource_accessCount_item[];
+    /** 声明action列表 */
+    actions: ModelPolicyStatementGroupByResource_actions_item[];
+}
+export interface ModelPolicyStatementGroupByResource_accessCount_item {
+    /** 动作点类型 */
+    accessLevel?: "Read" | "Write" | "List";
+    /** 数量 */
+    count?: number;
+}
+export interface ModelPolicyStatementGroupByResource_actions_item {
+    /** ABAC权限点id, 对应action */
+    id?: string;
+    /** 资源数据类型 */
+    resourceType?: string;
+    /** 动作点类型 */
+    accessLevel?: "Read" | "Write" | "List";
+}

package/dist/types/model/permission/ModelPolicyTemplateGroupByResource.d.ts

@@ -0,0 +1,19 @@
+import { ModelIcon } from "../common/index.js";
+import { ModelPolicyStatementGroupByResource, ModelColumnDbSearchPrepare } from "./index.js";
+/** 权限策略模板定义, 以资源进行分类 */
+export interface ModelPolicyTemplateGroupByResource {
+    /** instance id */
+    instanceId: string;
+    /** 图标 */
+    icon: Partial<ModelIcon>;
+    /** 策略名 */
+    name: string;
+    /** 规则效果 */
+    effect: "allow" | "deny";
+    /** 备注 */
+    memo: string;
+    /** 策略规则 */
+    statement: Partial<ModelPolicyStatementGroupByResource>[];
+    /** columnDB辅助关联查询 */
+    columnDBSearchPrepare: Partial<ModelColumnDbSearchPrepare>;
+}

package/dist/types/model/permission/ModelPolicyWithRelation.d.ts

@@ -0,0 +1,9 @@
+import { ModelPolicy, ModelBaseRole, ModelBaseUserGroup } from "./index.js";
+/** 策略, 带模型关系, 模型定义 */
+export type ModelPolicyWithRelation = ModelPolicy & ModelPolicyWithRelation_2;
+export interface ModelPolicyWithRelation_2 {
+    /** 关系角色 */
+    role: Partial<ModelBaseRole>[];
+    /** 关系用户组 */
+    user_group: Partial<ModelBaseUserGroup>[];
+}

package/dist/types/model/permission/ModelResourceAction.d.ts

@@ -0,0 +1,30 @@
+import { ModelPermissionSystemModule } from "./index.js";
+/** 策略权限动作, 模型定义 */
+export interface ModelResourceAction {
+    /** action id */
+    id: string;
+    /** 资源数据类型 */
+    resourceType: string;
+    /** 资源授权对象 */
+    resource: string;
+    /** 资源范围字段 */
+    filterKeys: string[];
+    /** 动作点类型 */
+    accessLevel: "Read" | "Write" | "List";
+    /** 备注 */
+    memo: string;
+    /** 权限点是否禁用, 为false时启用 */
+    disable: boolean;
+    /** 是否有默认规则 */
+    isDefaultPolicy: boolean;
+    /** 默认规则 */
+    defaultPolicy: ModelResourceAction_defaultPolicy;
+    /** 所属的系统模块 */
+    system_module: Partial<ModelPermissionSystemModule>[];
+}
+export interface ModelResourceAction_defaultPolicy {
+    /** 规则效果 */
+    effect?: "allow" | "deny";
+    /** 授权条件 */
+    filters?: string;
+}

package/dist/types/model/permission/ModelRole.d.ts

@@ -0,0 +1,15 @@
+/** 角色，mongoDB的存储结构 */
+export interface ModelRole {
+    /** 角色id */
+    id: string;
+    /** 角色所在org */
+    org: number;
+    /** 角色名称 */
+    role: string;
+    /** 角色下用户列表 */
+    user: string[];
+    /** 角色下权限id列表 */
+    permission: string[];
+    /** 角色下用户组列表 */
+    user_group: string[];
+}

package/dist/types/model/permission/ModelStatementExtra.d.ts

@@ -0,0 +1,13 @@
+/** Statement额外信息 */
+export interface ModelStatementExtra {
+    /** 额外信息, 资源过滤类型 */
+    extraFilterType: "" | "all" | "yaml" | "cmdbInstance.resource.selectInstance" | "cmdbInstance.resource.condition" | "cmdbInstance.resourceOwner.currResource" | "cmdbInstance.resourceOwner.relation" | "tool.selectTool" | "tool.selectToolCategory";
+    /** 额外信息, 关系路径标识 */
+    extraRelationPath: ModelStatementExtra_extraRelationPath_item[];
+}
+export interface ModelStatementExtra_extraRelationPath_item {
+    /** 模型id */
+    objectId?: string;
+    /** 关系向量id */
+    relationSideId?: string;
+}

package/dist/types/model/permission/index.d.ts

@@ -0,0 +1,22 @@
+export * from "./ModelChangeHistory.js";
+export * from "./ModelLoginTrack.js";
+export * from "./ModelPermissionChangeDiff.js";
+export * from "./ModelPermissionChangeHistoryData.js";
+export * from "./ModelInheritNodeFilter.js";
+export * from "./ModelInheritNode.js";
+export * from "./ModelInheritRule.js";
+export * from "./ModelPermissionMenu.js";
+export * from "./ModelPermission.js";
+export * from "./ModelRole.js";
+export * from "./ModelPermissionSystemModule.js";
+export * from "./ModelBaseUserGroup.js";
+export * from "./ModelStatementExtra.js";
+export * from "./ModelPolicyStatement.js";
+export * from "./ModelColumnDbSearchPrepare.js";
+export * from "./ModelPolicy.js";
+export * from "./ModelPolicyStatementGroupByResource.js";
+export * from "./ModelBaseRole.js";
+export * from "./ModelPolicyWithRelation.js";
+export * from "./ModelPolicyTemplateGroupByResource.js";
+export * from "./ModelResourceAction.js";
+export * from "./ModelPermissionResourceEnable.js";

package/dist/types/wrapper.d.ts

@@ -0,0 +1,12 @@
+export interface ResponseBodyWrapper<T> {
+    code: number;
+    data: T;
+    error?: string;
+    message?: string;
+}
+export interface ResponseListWrapper<T> {
+    list: T[];
+    page: number;
+    page_size: number;
+    total: number;
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@next-api-sdk/permission-sdk",
+  "version": "1.1.0",
+  "description": "API SDK for Permission",
+  "homepage": "https://github.com/easyops-cn/next-api-sdk/tree/master/sdk/permission-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:easyops-cn/next-api-sdk.git",
+    "directory": "sdk/permission-sdk"
+  },
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "typings": "dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "contracts.json"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "prestart": "npm run clean",
+    "start": "concurrently -k -n types,main \"npm run start:types\" \"npm run start:main\"",
+    "start:main": "cross-env NODE_ENV=development build-next-libs --watch",
+    "start:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types --watch",
+    "prebuild": "npm run clean",
+    "build": "npm run build:types && npm run build:main",
+    "build:main": "cross-env NODE_ENV=production build-next-libs",
+    "build:types": "tsc --emitDeclarationOnly --declaration --declarationDir dist/types"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@next-core/http": "^1.0.0"
+  },
+  "devDependencies": {
+    "@next-core/build-next-libs": "^1.0.0"
+  },
+  "gitHead": "8ca564915ee3885bec5039617ebec8e85ee1aa74"
+}