@nocobase/plugin-flow-engine 2.0.0-alpha.2

package/dist/server/server.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { Plugin } from '@nocobase/server';
+export declare const compile: (title: string) => string;
+export declare class PluginUISchemaStorageServer extends Plugin {
+    registerRepository(): void;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+}
+export default PluginUISchemaStorageServer;

package/dist/server/server.js

@@ -0,0 +1,198 @@
+/**
+ * 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 __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 server_exports = {};
+__export(server_exports, {
+  PluginUISchemaStorageServer: () => PluginUISchemaStorageServer,
+  compile: () => compile,
+  default: () => server_default
+});
+module.exports = __toCommonJS(server_exports);
+var import_database = require("@nocobase/database");
+var import_server = require("@nocobase/server");
+var import_utils = require("@nocobase/utils");
+var import_model = require("./model");
+var import_repository = __toESM(require("./repository"));
+const compile = (title) => (title || "").replace(/{{\s*t\(["|'|`](.*)["|'|`]\)\s*}}/g, "$1");
+function extractFields(obj) {
+  var _a, _b, _c, _d, _e;
+  const fields = [
+    obj.title,
+    obj.description,
+    (_a = obj["x-component-props"]) == null ? void 0 : _a.title,
+    (_b = obj["x-component-props"]) == null ? void 0 : _b.description,
+    (_c = obj["x-decorator-props"]) == null ? void 0 : _c.title,
+    (_d = obj["x-decorator-props"]) == null ? void 0 : _d.description
+  ];
+  const content = (_e = obj["x-component-props"]) == null ? void 0 : _e.content;
+  if (typeof content === "string") {
+    const regex = /\{\{\s*t\s+['"]([^'"]+)['"]\s*\}\}/g;
+    let match;
+    while ((match = regex.exec(content)) !== null) {
+      fields.push(match[1]);
+    }
+  }
+  return fields.filter((value) => value !== void 0 && value !== "");
+}
+class PluginUISchemaStorageServer extends import_server.Plugin {
+  registerRepository() {
+    this.app.db.registerRepositories({
+      FlowModelRepository: import_repository.default
+    });
+  }
+  async beforeLoad() {
+    const db = this.app.db;
+    const pm = this.app.pm;
+    this.app.db.registerModels({ MagicAttributeModel: import_database.MagicAttributeModel, FlowSchemaModel: import_model.FlowSchemaModel });
+    this.registerRepository();
+    this.app.acl.registerSnippet({
+      name: "ui.flowModels",
+      actions: ["flowModels:*"]
+    });
+    db.on("flowModels.beforeCreate", function setUid(model) {
+      if (!model.get("name")) {
+        model.set("name", (0, import_utils.uid)());
+      }
+    });
+    db.on("flowModels.afterSave", async function setUid(model, options) {
+      var _a;
+      const localizationPlugin = pm.get("localization");
+      const texts = [];
+      const changedFields = extractFields(model.toJSON());
+      if (!changedFields.length) {
+        return;
+      }
+      changedFields.forEach((field) => {
+        field && texts.push({ text: compile(field), module: `resources.ui-schema-storage` });
+      });
+      await ((_a = localizationPlugin == null ? void 0 : localizationPlugin.addNewTexts) == null ? void 0 : _a.call(localizationPlugin, texts, options));
+    });
+    db.on("flowModels.afterCreate", async function insertSchema(model, options) {
+      const { transaction } = options;
+      const uiSchemaRepository = db.getCollection("flowModels").repository;
+      const context = options.context;
+      if (context == null ? void 0 : context.disableInsertHook) {
+        return;
+      }
+      await uiSchemaRepository.insert(model.toJSON(), {
+        transaction
+      });
+    });
+    db.on("flowModels.afterUpdate", async function patchSchema(model, options) {
+      const { transaction } = options;
+      const uiSchemaRepository = db.getCollection("flowModels").repository;
+      await uiSchemaRepository.patch(model.toJSON(), {
+        transaction
+      });
+    });
+    db.on("flowModels.afterDestroy", async function patchSchema(model, options) {
+      const { transaction } = options;
+      const uiSchemaRepository = db.getCollection("flowModels").repository;
+      await uiSchemaRepository.remove(model.get("name"), { transaction });
+    });
+    this.app.resourceManager.define({
+      name: "flowModels",
+      actions: {
+        findOne: async (ctx, next) => {
+          const { uid: uid2, parentId, subKey } = ctx.action.params;
+          const repository = ctx.db.getRepository("flowModels");
+          if (uid2) {
+            ctx.body = await repository.findModelById(uid2);
+          } else if (parentId) {
+            ctx.body = await repository.findModelByParentId(parentId, { subKey });
+          }
+          await next();
+        },
+        move: async (ctx, next) => {
+          const { sourceId, targetId, position } = ctx.action.params;
+          const repository = ctx.db.getRepository("flowModels");
+          await repository.move({ sourceId, targetId, position });
+          ctx.body = "ok";
+          await next();
+        },
+        save: async (ctx, next) => {
+          const { values } = ctx.action.params;
+          const repository = ctx.db.getRepository("flowModels");
+          const uid2 = await repository.upsertModel(values);
+          ctx.body = uid2;
+          await next();
+        },
+        destroy: async (ctx, next) => {
+          const { filterByTk } = ctx.action.params;
+          const repository = ctx.db.getRepository("flowModels");
+          await repository.remove(filterByTk);
+          ctx.body = "ok";
+          await next();
+        }
+      }
+    });
+    this.app.acl.allow("flowModels", ["findOne"], "loggedIn");
+  }
+  async load() {
+    const getSourceAndTargetForRemoveAction = async (ctx) => {
+      const { filterByTk } = ctx.action.params;
+      return {
+        targetCollection: "flowModels",
+        targetRecordUK: filterByTk
+      };
+    };
+    const getSourceAndTargetForInsertAdjacentAction = async (ctx) => {
+      var _a, _b;
+      return {
+        targetCollection: "flowModels",
+        targetRecordUK: (_b = (_a = ctx.request.body) == null ? void 0 : _a.options) == null ? void 0 : _b["uid"]
+      };
+    };
+    const getSourceAndTargetForPatchAction = async (ctx) => {
+      var _a;
+      return {
+        targetCollection: "flowModels",
+        targetRecordUK: (_a = ctx.request.body) == null ? void 0 : _a["uid"]
+      };
+    };
+    this.app.auditManager.registerActions([
+      { name: "flowModels:remove", getSourceAndTarget: getSourceAndTargetForRemoveAction },
+      { name: "flowModels:insertAdjacent", getSourceAndTarget: getSourceAndTargetForInsertAdjacentAction },
+      { name: "flowModels:patch", getSourceAndTarget: getSourceAndTargetForPatchAction }
+    ]);
+  }
+}
+var server_default = PluginUISchemaStorageServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginUISchemaStorageServer,
+  compile
+});

package/dist/server/template/contexts.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { ResourcerContext } from '@nocobase/resourcer';
+type Getter<T = any> = (ctx: ServerBaseContext) => T | Promise<T>;
+export interface PropertyOptions {
+    /** 固定值，优先级高于 get */
+    value?: any;
+    /** 惰性求值 getter，返回值可为 Promise；默认会被缓存 */
+    get?: Getter;
+    /** 是否禁用缓存，true 表示每次访问都重新计算 */
+    cache?: boolean;
+    /** 仅允许首次定义，后续重复定义将被忽略 */
+    once?: boolean;
+}
+/**
+ * 服务器端上下文基础类。
+ * - 支持以 defineProperty 定义惰性/常量属性，并可选择缓存
+ * - 支持以 defineMethod 定义方法
+ * - 支持 delegate 机制，属性与方法可回退到被委托的上游上下文
+ * - 通过 Proxy 实现按需求值与 this 绑定
+ */
+export declare class ServerBaseContext {
+    protected _props: Record<string, PropertyOptions>;
+    protected _methods: Record<string, (...args: any[]) => any>;
+    protected _cache: Record<string, any>;
+    protected _delegates: ServerBaseContext[];
+    protected _proxy?: ServerBaseContext;
+    [key: string]: any;
+    constructor();
+    protected _getOwn(key: string, current: ServerBaseContext): any;
+    /**
+     * 定义一个可枚举属性。
+     * - value：固定值
+     * - get：惰性 getter（默认带缓存）
+     * - once：已存在时忽略重复定义
+     */
+    defineProperty(key: string, options: PropertyOptions): void;
+    /** 定义一个方法（不可枚举、不可写），访问时会自动绑定到对应实例 */
+    defineMethod(name: string, fn: (...args: any[]) => any): void;
+    /**
+     * 委托到另一个 ServerBaseContext：
+     * - 访问属性/方法找不到时，会回退到被委托者进行解析
+     */
+    delegate(ctx: ServerBaseContext): void;
+    /** 清空所有委托 */
+    clearDelegates(): void;
+    /** 创建并返回代理对象（同一实例下保持稳定引用） */
+    createProxy(): any;
+}
+/**
+ * 全局上下文：
+ * - now/timestamp：时间值（不缓存）
+ * - env：环境变量（仅暴露白名单前缀）
+ * - date：日期快捷变量集合（包含前天等）
+ */
+export declare class GlobalContext extends ServerBaseContext {
+    constructor(env?: Record<string, any>);
+}
+/**
+ * 请求级上下文：从 Koa-like 上下文中映射基础信息。
+ * - user（缓存）、roleName、locale、ip、headers、query、params
+ */
+export declare class HttpRequestContext extends ServerBaseContext {
+    private koaCtx;
+    constructor(koaCtx: ResourcerContext);
+}
+export {};

package/dist/server/template/contexts.js

@@ -0,0 +1,233 @@
+/**
+ * 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 __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 contexts_exports = {};
+__export(contexts_exports, {
+  GlobalContext: () => GlobalContext,
+  HttpRequestContext: () => HttpRequestContext,
+  ServerBaseContext: () => ServerBaseContext
+});
+module.exports = __toCommonJS(contexts_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_utils = require("@nocobase/utils");
+class ServerBaseContext {
+  _props = {};
+  _methods = {};
+  _cache = {};
+  _delegates = [];
+  _proxy;
+  constructor() {
+    return this.createProxy();
+  }
+  _getOwn(key, current) {
+    const opt = this._props[key];
+    if (!opt) return void 0;
+    if (Object.prototype.hasOwnProperty.call(opt, "value")) return opt.value;
+    if (opt.get) {
+      if (opt.cache === false) return opt.get(current);
+      if (key in this._cache) return this._cache[key];
+      const p = opt.get(current);
+      this._cache[key] = p;
+      return p;
+    }
+    return void 0;
+  }
+  /**
+   * 定义一个可枚举属性。
+   * - value：固定值
+   * - get：惰性 getter（默认带缓存）
+   * - once：已存在时忽略重复定义
+   */
+  defineProperty(key, options) {
+    var _a;
+    if (this._props[key] && ((_a = this._props[key]) == null ? void 0 : _a.once)) return;
+    this._props[key] = options;
+    delete this._cache[key];
+    Object.defineProperty(this, key, {
+      configurable: true,
+      enumerable: true,
+      get: () => this._getOwn(key, this.createProxy())
+    });
+  }
+  /** 定义一个方法（不可枚举、不可写），访问时会自动绑定到对应实例 */
+  defineMethod(name, fn) {
+    this._methods[name] = fn;
+    Object.defineProperty(this, name, {
+      configurable: true,
+      enumerable: false,
+      writable: false,
+      value: fn
+      // bind at proxy access to keep delegate binding consistent
+    });
+  }
+  /**
+   * 委托到另一个 ServerBaseContext：
+   * - 访问属性/方法找不到时，会回退到被委托者进行解析
+   */
+  delegate(ctx) {
+    if (!(ctx instanceof ServerBaseContext)) {
+      throw new Error("Delegate must be a ServerBaseContext");
+    }
+    if (!this._delegates.includes(ctx)) this._delegates.unshift(ctx);
+  }
+  /** 清空所有委托 */
+  clearDelegates() {
+    this._delegates = [];
+  }
+  /** 创建并返回代理对象（同一实例下保持稳定引用） */
+  createProxy() {
+    if (this._proxy) return this._proxy;
+    this._proxy = new Proxy(this, {
+      get: (target, key, receiver) => {
+        var _a;
+        if (typeof key !== "string") return Reflect.get(target, key, receiver);
+        if (Reflect.has(target, key)) {
+          const v = Reflect.get(target, key, receiver);
+          return typeof v === "function" ? v.bind(target) : v;
+        }
+        if (Object.prototype.hasOwnProperty.call(target._props, key)) {
+          return target._getOwn(key, this.createProxy());
+        }
+        if (Object.prototype.hasOwnProperty.call(target._methods, key)) {
+          const fn = target._methods[key];
+          return typeof fn === "function" ? fn.bind(target) : fn;
+        }
+        for (const d of target._delegates) {
+          const candidate = (_a = d._getOwn) == null ? void 0 : _a.call(d, key, this.createProxy());
+          if (typeof candidate !== "undefined") return candidate;
+          if (Object.prototype.hasOwnProperty.call(d._methods || {}, key)) {
+            const fn = d._methods[key];
+            return typeof fn === "function" ? fn.bind(d) : fn;
+          }
+        }
+        return void 0;
+      },
+      has: (target, key) => {
+        if (typeof key !== "string") return Reflect.has(target, key);
+        if (Reflect.has(target, key)) return true;
+        if (Object.prototype.hasOwnProperty.call(target._props, key)) return true;
+        if (Object.prototype.hasOwnProperty.call(target._methods, key)) return true;
+        return target._delegates.some(
+          (d) => Object.prototype.hasOwnProperty.call(d._props, key) || Object.prototype.hasOwnProperty.call(d._methods, key)
+        );
+      }
+    });
+    return this._proxy;
+  }
+}
+class GlobalContext extends ServerBaseContext {
+  constructor(env) {
+    super();
+    this.defineProperty("now", { get: () => (/* @__PURE__ */ new Date()).toISOString(), cache: false });
+    this.defineProperty("timestamp", { get: () => Date.now(), cache: false });
+    if (env) this.defineProperty("env", { value: filterEnv(env) });
+    this.defineProperty("date", {
+      get: (_ctx) => buildDateVariables(),
+      cache: false
+    });
+  }
+}
+class HttpRequestContext extends ServerBaseContext {
+  constructor(koaCtx) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
+    super();
+    this.koaCtx = koaCtx;
+    this.defineProperty("user", { get: async () => {
+      var _a2, _b2;
+      return (_b2 = (_a2 = this.koaCtx) == null ? void 0 : _a2.auth) == null ? void 0 : _b2.user;
+    }, cache: true });
+    this.defineProperty("roleName", { value: (_b = (_a = this.koaCtx) == null ? void 0 : _a.auth) == null ? void 0 : _b.role });
+    this.defineProperty("locale", { value: (_d = (_c = this.koaCtx) == null ? void 0 : _c.getCurrentLocale) == null ? void 0 : _d.call(_c) });
+    this.defineProperty("ip", { value: ((_f = (_e = this.koaCtx) == null ? void 0 : _e.state) == null ? void 0 : _f.clientIp) || ((_h = (_g = this.koaCtx) == null ? void 0 : _g.request) == null ? void 0 : _h.ip) });
+    this.defineProperty("headers", { value: (_i = this.koaCtx) == null ? void 0 : _i.headers });
+    this.defineProperty("query", { value: (_k = (_j = this.koaCtx) == null ? void 0 : _j.request) == null ? void 0 : _k.query });
+    this.defineProperty("params", { value: import_lodash.default.get(this.koaCtx, "action.params") });
+  }
+}
+const DEFAULT_ENV_PREFIXES = ["PUBLIC_", "NEXT_PUBLIC_", "NCB_PUBLIC_"];
+function filterEnv(env, allowedPrefixes = DEFAULT_ENV_PREFIXES) {
+  try {
+    const out = {};
+    for (const [k, v] of Object.entries(env || {})) {
+      if (allowedPrefixes.some((p) => k.startsWith(p))) {
+        out[k] = v;
+      }
+    }
+    return out;
+  } catch (_2) {
+    return {};
+  }
+}
+function buildDateVariables() {
+  const timezone = getServerTimezone();
+  const now = (/* @__PURE__ */ new Date()).toISOString();
+  const base = (0, import_utils.getDateVars)();
+  base.dayBeforeYesterday = (0, import_utils.toUnit)("day", -2);
+  const out = {};
+  for (const [key, val] of Object.entries(base)) {
+    try {
+      out[key] = typeof val === "function" ? val({ timezone, now }) : val;
+    } catch (_2) {
+    }
+  }
+  return out;
+}
+function getServerTimezone() {
+  var _a, _b;
+  const tzEnv = ((_a = process == null ? void 0 : process.env) == null ? void 0 : _a.DB_TIMEZONE) || ((_b = process == null ? void 0 : process.env) == null ? void 0 : _b.TZ);
+  if (tzEnv) {
+    const m = tzEnv.match(/^([+-])(\d{1,2}):(\d{2})$/);
+    if (m) {
+      const sign2 = m[1];
+      const hh2 = m[2].padStart(2, "0");
+      const mm2 = m[3];
+      return `${sign2}${hh2}:${mm2}`;
+    }
+    return tzEnv;
+  }
+  const offsetMinutes = -(/* @__PURE__ */ new Date()).getTimezoneOffset();
+  const sign = offsetMinutes >= 0 ? "+" : "-";
+  const abs = Math.abs(offsetMinutes);
+  const hh = String(Math.floor(abs / 60)).padStart(2, "0");
+  const mm = String(abs % 60).padStart(2, "0");
+  return `${sign}${hh}:${mm}`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GlobalContext,
+  HttpRequestContext,
+  ServerBaseContext
+});

package/dist/server/template/resolver.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 'ses';
+export type JSONValue = string | {
+    [key: string]: JSONValue;
+} | JSONValue[];
+/**
+ * 解析 JSON 模板中形如 {{ ... }} 的占位符（服务端解析）。
+ * 仅支持以 ctx 开头的路径与表达式（如：{{ ctx.user.id }}、{{ ctx.record.roles[0].name }}）。
+ * 无法解析或不受支持的表达式将原样保留。
+ *
+ * @param template 要解析的对象/数组/字符串模板
+ * @param ctx 变量上下文（实现了所需属性/方法的代理对象）
+ * @returns 解析后的结果，与输入结构相同
+ */
+export declare function resolveJsonTemplate(template: JSONValue, ctx: any): Promise<any>;
+/**
+ * 将表达式中的 ctx 访问改写为内部 __get 调用。
+ * 例如：ctx.user.id + 1 => (await __get('user', '.id')) + 1
+ *
+ * @param expression 原始表达式字符串
+ * @returns 改写后的表达式字符串
+ */
+export declare function preprocessExpression(expression: string): string;