@nocobase/acl 1.2.13-alpha → 1.3.0-alpha.20240710084543

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@nocobase/acl",
-  "version": "1.2.13-alpha",
+  "version": "1.3.0-alpha.20240710084543",
   "description": "",
   "license": "AGPL-3.0",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@nocobase/resourcer": "1.2.13-alpha",
-    "@nocobase/utils": "1.2.13-alpha",
+    "@nocobase/resourcer": "1.3.0-alpha.20240710084543",
+    "@nocobase/utils": "1.3.0-alpha.20240710084543",
     "minimatch": "^5.1.1"
   },
   "repository": {
@@ -15,5 +15,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/acl"
   },
-  "gitHead": "b6a1c2ee330b47c2581ea2ce15ee46210e6220f2"
+  "gitHead": "07a8b596fc64a9779a194cb9b0dc2ca7570ed9d4"
 }

package/lib/acl-available-action.d.ts

@@ -1,24 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-export interface AvailableActionOptions {
-    /**
-     * @deprecated
-     */
-    type?: 'new-data' | 'old-data';
-    displayName?: string;
-    aliases?: string[] | string;
-    resource?: string;
-    onNewRecord?: boolean;
-    allowConfigureFields?: boolean;
-}
-export declare class ACLAvailableAction {
-    name: string;
-    options: AvailableActionOptions;
-    constructor(name: string, options: AvailableActionOptions);
-}

package/lib/acl-available-action.js

@@ -1,44 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var acl_available_action_exports = {};
-__export(acl_available_action_exports, {
-  ACLAvailableAction: () => ACLAvailableAction
-});
-module.exports = __toCommonJS(acl_available_action_exports);
-const _ACLAvailableAction = class _ACLAvailableAction {
-  constructor(name, options) {
-    this.name = name;
-    this.options = options;
-  }
-};
-__name(_ACLAvailableAction, "ACLAvailableAction");
-let ACLAvailableAction = _ACLAvailableAction;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ACLAvailableAction
-});

package/lib/acl-available-strategy.d.ts

@@ -1,37 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-import { ACL } from './acl';
-export interface AvailableStrategyOptions {
-    displayName?: string;
-    actions?: false | string | string[];
-    allowConfigure?: boolean;
-    /**
-     * @internal
-     */
-    resource?: '*';
-}
-export declare const predicate: {
-    own: {
-        filter: {
-            createdById: string;
-        };
-    };
-    all: {};
-};
-export declare class ACLAvailableStrategy {
-    acl: ACL;
-    options: AvailableStrategyOptions;
-    actionsAsObject: {
-        [key: string]: string;
-    };
-    allowConfigure: boolean;
-    constructor(acl: ACL, options: AvailableStrategyOptions);
-    matchAction(actionName: string): any;
-    allow(resourceName: string, actionName: string): any;
-}

package/lib/acl-available-strategy.js

@@ -1,97 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var acl_available_strategy_exports = {};
-__export(acl_available_strategy_exports, {
-  ACLAvailableStrategy: () => ACLAvailableStrategy,
-  predicate: () => predicate
-});
-module.exports = __toCommonJS(acl_available_strategy_exports);
-var import_lodash = __toESM(require("lodash"));
-const predicate = {
-  own: {
-    filter: {
-      createdById: "{{ ctx.state.currentUser.id }}"
-    }
-  },
-  all: {}
-};
-const _ACLAvailableStrategy = class _ACLAvailableStrategy {
-  acl;
-  options;
-  actionsAsObject;
-  allowConfigure;
-  constructor(acl, options) {
-    this.acl = acl;
-    this.options = options;
-    this.allowConfigure = options.allowConfigure;
-    let actions = this.options.actions;
-    if (import_lodash.default.isString(actions) && actions != "*") {
-      actions = [actions];
-    }
-    if (import_lodash.default.isArray(actions)) {
-      this.actionsAsObject = actions.reduce((carry, action) => {
-        const [actionName, predicate2] = action.split(":");
-        carry[actionName] = predicate2;
-        return carry;
-      }, {});
-    }
-  }
-  matchAction(actionName) {
-    if (this.options.actions == "*") {
-      return true;
-    }
-    if (Object.prototype.hasOwnProperty.call(this.actionsAsObject || {}, actionName)) {
-      const predicateName = this.actionsAsObject[actionName];
-      if (predicateName) {
-        return import_lodash.default.cloneDeep(predicate[predicateName]);
-      }
-      return true;
-    }
-    return false;
-  }
-  allow(resourceName, actionName) {
-    return this.matchAction(this.acl.resolveActionAlias(actionName));
-  }
-};
-__name(_ACLAvailableStrategy, "ACLAvailableStrategy");
-let ACLAvailableStrategy = _ACLAvailableStrategy;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ACLAvailableStrategy,
-  predicate
-});

package/lib/acl-resource.d.ts

@@ -1,31 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-import { ACLRole, RoleActionParams } from './acl-role';
-import { ACL } from './acl';
-export type ResourceActions = {
-    [key: string]: RoleActionParams;
-};
-interface AclResourceOptions {
-    name: string;
-    role: ACLRole;
-    actions?: ResourceActions;
-}
-export declare class ACLResource {
-    actions: Map<string, RoleActionParams>;
-    acl: ACL;
-    role: ACLRole;
-    name: string;
-    constructor(options: AclResourceOptions);
-    getActions(): {};
-    getAction(name: string): RoleActionParams;
-    setAction(name: string, params: RoleActionParams): void;
-    setActions(actions: ResourceActions): void;
-    removeAction(name: string): void;
-}
-export {};

package/lib/acl-resource.js

@@ -1,100 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var acl_resource_exports = {};
-__export(acl_resource_exports, {
-  ACLResource: () => ACLResource
-});
-module.exports = __toCommonJS(acl_resource_exports);
-var import_lodash = __toESM(require("lodash"));
-const _ACLResource = class _ACLResource {
-  actions = /* @__PURE__ */ new Map();
-  acl;
-  role;
-  name;
-  constructor(options) {
-    this.acl = options.role.acl;
-    this.role = options.role;
-    this.name = options.name;
-    const actionsOption = options.actions || {};
-    for (const actionName of Object.keys(actionsOption)) {
-      this.actions.set(actionName, actionsOption[actionName]);
-    }
-  }
-  getActions() {
-    return Array.from(this.actions.keys()).reduce((carry, key) => {
-      carry[key] = this.actions.get(key);
-      return carry;
-    }, {});
-  }
-  getAction(name) {
-    const result = this.actions.get(name) || this.actions.get(this.acl.resolveActionAlias(name));
-    if (!result) {
-      return null;
-    }
-    if (Array.isArray(result.fields) && result.fields.length > 0) {
-      result.fields = import_lodash.default.uniq(result.fields);
-    }
-    return import_lodash.default.cloneDeep(result);
-  }
-  setAction(name, params) {
-    const context = {
-      role: this.role,
-      acl: this.role.acl,
-      params: params || {},
-      path: `${this.name}:${name}`,
-      resourceName: this.name,
-      actionName: name
-    };
-    this.acl.emit("beforeGrantAction", context);
-    this.actions.set(name, context.params);
-  }
-  setActions(actions) {
-    for (const actionName of Object.keys(actions)) {
-      this.setAction(actionName, actions[actionName]);
-    }
-  }
-  removeAction(name) {
-    this.actions.delete(name);
-  }
-};
-__name(_ACLResource, "ACLResource");
-let ACLResource = _ACLResource;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ACLResource
-});

package/lib/acl-role.d.ts

@@ -1,58 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-import { ACL, DefineOptions } from './acl';
-import { ACLAvailableStrategy, AvailableStrategyOptions } from './acl-available-strategy';
-import { ACLResource } from './acl-resource';
-export interface RoleActionParams {
-    fields?: string[];
-    filter?: any;
-    own?: boolean;
-    whitelist?: string[];
-    blacklist?: string[];
-    [key: string]: any;
-}
-export interface ResourceActionsOptions {
-    [actionName: string]: RoleActionParams;
-}
-/**
- * @internal
- */
-export declare class ACLRole {
-    acl: ACL;
-    name: string;
-    strategy: string | AvailableStrategyOptions;
-    resources: Map<string, ACLResource>;
-    snippets: Set<string>;
-    _snippetCache: {
-        params: any;
-        result: any;
-    };
-    constructor(acl: ACL, name: string);
-    _serializeSet(set: Set<string>): string;
-    getResource(name: string): ACLResource | undefined;
-    setStrategy(value: string | AvailableStrategyOptions): void;
-    getStrategy(): ACLAvailableStrategy;
-    getResourceActionsParams(resourceName: string): {};
-    revokeResource(resourceName: string): void;
-    grantAction(path: string, options?: RoleActionParams): void;
-    getActionParams(path: string): RoleActionParams;
-    revokeAction(path: string): void;
-    effectiveSnippets(): {
-        allowed: Array<string>;
-        rejected: Array<string>;
-    };
-    snippetAllowed(actionPath: string): boolean;
-    toJSON(): DefineOptions;
-    protected getResourceActionFromPath(path: string): {
-        resourceName: string;
-        actionName: string;
-        resource: ACLResource;
-        action: any;
-    };
-}

package/lib/acl-role.js

@@ -1,193 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var acl_role_exports = {};
-__export(acl_role_exports, {
-  ACLRole: () => ACLRole
-});
-module.exports = __toCommonJS(acl_role_exports);
-var import_acl_available_strategy = require("./acl-available-strategy");
-var import_acl_resource = require("./acl-resource");
-var import_lodash = __toESM(require("lodash"));
-var import_minimatch = __toESM(require("minimatch"));
-const _ACLRole = class _ACLRole {
-  constructor(acl, name) {
-    this.acl = acl;
-    this.name = name;
-  }
-  strategy;
-  resources = /* @__PURE__ */ new Map();
-  snippets = /* @__PURE__ */ new Set();
-  _snippetCache = {
-    params: null,
-    result: null
-  };
-  _serializeSet(set) {
-    return JSON.stringify([...set].sort());
-  }
-  getResource(name) {
-    return this.resources.get(name);
-  }
-  setStrategy(value) {
-    this.strategy = value;
-  }
-  getStrategy() {
-    if (!this.strategy) {
-      return null;
-    }
-    return import_lodash.default.isString(this.strategy) ? this.acl.availableStrategy.get(this.strategy) : new import_acl_available_strategy.ACLAvailableStrategy(this.acl, this.strategy);
-  }
-  getResourceActionsParams(resourceName) {
-    const resource = this.getResource(resourceName);
-    return resource.getActions();
-  }
-  revokeResource(resourceName) {
-    for (const key of [...this.resources.keys()]) {
-      if (key === resourceName || key.includes(`${resourceName}.`)) {
-        this.resources.delete(key);
-      }
-    }
-  }
-  grantAction(path, options) {
-    let { resource } = this.getResourceActionFromPath(path);
-    const { resourceName, actionName } = this.getResourceActionFromPath(path);
-    if (!resource) {
-      resource = new import_acl_resource.ACLResource({
-        role: this,
-        name: resourceName
-      });
-      this.resources.set(resourceName, resource);
-    }
-    resource.setAction(actionName, options);
-  }
-  getActionParams(path) {
-    const { action } = this.getResourceActionFromPath(path);
-    return action;
-  }
-  revokeAction(path) {
-    const { resource, actionName } = this.getResourceActionFromPath(path);
-    resource.removeAction(actionName);
-  }
-  effectiveSnippets() {
-    const currentParams = this._serializeSet(this.snippets);
-    if (this._snippetCache.params === currentParams) {
-      return this._snippetCache.result;
-    }
-    const allowedSnippets = /* @__PURE__ */ new Set();
-    const rejectedSnippets = /* @__PURE__ */ new Set();
-    const availableSnippets = this.acl.snippetManager.snippets;
-    for (let snippetRule of this.snippets) {
-      const negated = snippetRule.startsWith("!");
-      snippetRule = negated ? snippetRule.slice(1) : snippetRule;
-      for (const [_, availableSnippet] of availableSnippets) {
-        if ((0, import_minimatch.default)(availableSnippet.name, snippetRule)) {
-          if (negated) {
-            rejectedSnippets.add(availableSnippet.name);
-          } else {
-            allowedSnippets.add(availableSnippet.name);
-          }
-        }
-      }
-    }
-    const effectiveSnippets = new Set([...allowedSnippets].filter((x) => !rejectedSnippets.has(x)));
-    this._snippetCache = {
-      params: currentParams,
-      result: {
-        allowed: [...effectiveSnippets],
-        rejected: [...rejectedSnippets]
-      }
-    };
-    return this._snippetCache.result;
-  }
-  snippetAllowed(actionPath) {
-    const effectiveSnippets = this.effectiveSnippets();
-    const getActions = /* @__PURE__ */ __name((snippets) => {
-      return snippets.map((snippetName) => this.acl.snippetManager.snippets.get(snippetName).actions).flat();
-    }, "getActions");
-    const allowedActions = getActions(effectiveSnippets.allowed);
-    const rejectedActions = getActions(effectiveSnippets.rejected);
-    const actionMatched = /* @__PURE__ */ __name((actionPath2, actionRule) => {
-      return (0, import_minimatch.default)(actionPath2, actionRule);
-    }, "actionMatched");
-    for (const action of allowedActions) {
-      if (actionMatched(actionPath, action)) {
-        return true;
-      }
-    }
-    for (const action of rejectedActions) {
-      if (actionMatched(actionPath, action)) {
-        return false;
-      }
-    }
-    return null;
-  }
-  toJSON() {
-    const actions = {};
-    for (const resourceName of this.resources.keys()) {
-      const resourceActions = this.getResourceActionsParams(resourceName);
-      for (const actionName of Object.keys(resourceActions)) {
-        actions[`${resourceName}:${actionName}`] = resourceActions[actionName];
-      }
-    }
-    return {
-      role: this.name,
-      strategy: this.strategy,
-      actions,
-      snippets: Array.from(this.snippets)
-    };
-  }
-  getResourceActionFromPath(path) {
-    const [resourceName, actionName] = path.split(":");
-    const resource = this.resources.get(resourceName);
-    let action = null;
-    if (resource) {
-      action = resource.getAction(actionName);
-    }
-    return {
-      resourceName,
-      actionName,
-      resource,
-      action
-    };
-  }
-};
-__name(_ACLRole, "ACLRole");
-let ACLRole = _ACLRole;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ACLRole
-});