@nocobase/plugin-data-source-main 2.1.0-beta.8 → 2.2.0-alpha.1

package/dist/server/modeling/collections.js

@@ -0,0 +1,280 @@
+/**
+ * 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 collections_exports = {};
+__export(collections_exports, {
+  buildTemplateBaseline: () => buildTemplateBaseline,
+  composeCollectionDefinition: () => composeCollectionDefinition,
+  normalizeCollectionInput: () => normalizeCollectionInput
+});
+module.exports = __toCommonJS(collections_exports);
+var import_lodash = __toESM(require("lodash"));
+var import_constants = require("./constants");
+var import_fields = require("./fields");
+function buildPresetFields(options) {
+  const fields = [];
+  if (options.includeId) {
+    fields.push((0, import_fields.normalizeFieldInput)({ name: "id", interface: "snowflakeId", title: "ID" }));
+  }
+  if (options.includeCreatedAt) {
+    fields.push((0, import_fields.normalizeFieldInput)({ name: "createdAt", interface: "createdAt", title: "Created at" }));
+  }
+  if (options.includeCreatedBy) {
+    fields.push((0, import_fields.normalizeFieldInput)({ name: "createdBy", interface: "createdBy", title: "Created by" }));
+  }
+  if (options.includeUpdatedAt) {
+    fields.push((0, import_fields.normalizeFieldInput)({ name: "updatedAt", interface: "updatedAt", title: "Last updated at" }));
+  }
+  if (options.includeUpdatedBy) {
+    fields.push((0, import_fields.normalizeFieldInput)({ name: "updatedBy", interface: "updatedBy", title: "Last updated by" }));
+  }
+  return fields;
+}
+function buildTemplateBaseline(input) {
+  const template = input.template || "general";
+  const name = input.name;
+  const titleField = input.titleField || "title";
+  switch (template) {
+    case "general":
+      return {
+        template,
+        logging: input.logging ?? true,
+        autoGenId: false,
+        fields: buildPresetFields({
+          includeId: true,
+          includeCreatedAt: true,
+          includeCreatedBy: true,
+          includeUpdatedAt: true,
+          includeUpdatedBy: true
+        })
+      };
+    case "tree":
+      return {
+        template,
+        logging: input.logging ?? true,
+        view: false,
+        tree: input.tree || "adjacencyList",
+        autoGenId: false,
+        fields: [
+          (0, import_fields.normalizeFieldInput)({
+            name: "parentId",
+            interface: "integer",
+            type: "bigInt",
+            isForeignKey: true,
+            autoFill: false,
+            title: "Parent ID"
+          }),
+          (0, import_fields.normalizeFieldInput)({
+            name: "parent",
+            interface: "m2o",
+            target: name,
+            foreignKey: "parentId",
+            treeParent: true,
+            onDelete: "CASCADE",
+            targetTitleField: titleField,
+            title: "Parent"
+          }),
+          (0, import_fields.normalizeFieldInput)({
+            name: "children",
+            interface: "o2m",
+            target: name,
+            foreignKey: "parentId",
+            treeChildren: true,
+            onDelete: "CASCADE",
+            targetTitleField: titleField,
+            title: "Children"
+          }),
+          ...buildPresetFields({
+            includeId: true,
+            includeCreatedAt: true,
+            includeCreatedBy: true,
+            includeUpdatedAt: true,
+            includeUpdatedBy: true
+          })
+        ]
+      };
+    case "file":
+      return {
+        template,
+        logging: input.logging ?? true,
+        view: false,
+        createdBy: true,
+        updatedBy: true,
+        fields: [
+          (0, import_fields.normalizeFieldInput)({ name: "title", interface: "input", title: "Title" }),
+          (0, import_fields.normalizeFieldInput)({ name: "filename", interface: "input", title: "File name" }),
+          (0, import_fields.normalizeFieldInput)({ name: "extname", interface: "input", title: "Extension name" }),
+          (0, import_fields.normalizeFieldInput)({ name: "size", interface: "integer", type: "integer", title: "Size" }),
+          (0, import_fields.normalizeFieldInput)({ name: "mimetype", interface: "input", title: "MIME type" }),
+          (0, import_fields.normalizeFieldInput)({ name: "path", interface: "textarea", type: "text", title: "Path" }),
+          (0, import_fields.normalizeFieldInput)({ name: "url", interface: "url", type: "text", title: "URL" }),
+          (0, import_fields.normalizeFieldInput)({ name: "preview", interface: "url", type: "text", field: "url", title: "Preview" }),
+          (0, import_fields.normalizeFieldInput)({
+            name: "storage",
+            interface: "m2o",
+            target: "storages",
+            foreignKey: "storageId",
+            targetTitleField: "title",
+            title: "Storage"
+          }),
+          (0, import_fields.normalizeFieldInput)({
+            name: "meta",
+            interface: "json",
+            type: "jsonb",
+            defaultValue: {},
+            title: "Meta"
+          }),
+          ...buildPresetFields({
+            includeId: true,
+            includeCreatedAt: true,
+            includeCreatedBy: true,
+            includeUpdatedAt: true,
+            includeUpdatedBy: true
+          })
+        ]
+      };
+    case "calendar":
+      return {
+        template,
+        logging: input.logging ?? true,
+        createdBy: true,
+        updatedBy: true,
+        createdAt: true,
+        updatedAt: true,
+        sortable: input.sortable ?? true,
+        fields: [
+          (0, import_fields.normalizeFieldInput)({
+            name: "cron",
+            interface: "select",
+            type: "string",
+            title: "Repeats",
+            uiSchema: {
+              type: "string",
+              title: "Repeats",
+              "x-component": "CronSet",
+              "x-component-props": "allowClear",
+              enum: [
+                { label: "Daily", value: "0 0 0 * * ?" },
+                { label: "Weekly", value: "every_week" },
+                { label: "Monthly", value: "every_month" },
+                { label: "Yearly", value: "every_year" }
+              ]
+            }
+          }),
+          (0, import_fields.normalizeFieldInput)({
+            name: "exclude",
+            interface: "json",
+            type: "json",
+            title: "Exclude"
+          }),
+          ...buildPresetFields({
+            includeId: true,
+            includeCreatedAt: true,
+            includeCreatedBy: true,
+            includeUpdatedAt: true,
+            includeUpdatedBy: true
+          })
+        ]
+      };
+    case "comment":
+      return {
+        template,
+        logging: input.logging ?? true,
+        autoGenId: false,
+        fields: [
+          (0, import_fields.normalizeFieldInput)({
+            name: "content",
+            interface: "vditor",
+            type: "text",
+            length: "long",
+            deletable: false,
+            title: "Comment Content"
+          }),
+          ...buildPresetFields({
+            includeId: true,
+            includeCreatedAt: true,
+            includeCreatedBy: true,
+            includeUpdatedAt: true,
+            includeUpdatedBy: true
+          })
+        ]
+      };
+    case "view":
+      return { template, view: true, schema: input.schema || "public" };
+    case "inherit":
+      return { template, inherits: input.inherits };
+    case "sql":
+    default:
+      return { template };
+  }
+}
+function normalizeCollectionInput(input, options = {}) {
+  var _a, _b;
+  const values = import_lodash.default.cloneDeep(input || {});
+  if ((options.mode || "create") === "create") {
+    values.template = values.template || "general";
+    values.title = values.title || (0, import_constants.toDisplayTitle)(values.name);
+  }
+  if (Array.isArray(values.fields)) {
+    values.fields = values.fields.map((field) => (0, import_fields.normalizeFieldInput)(field, { collectionName: values.name }));
+  }
+  if ((options.mode || "create") === "create" && !values.titleField) {
+    const primaryKeyField = (_b = (_a = values.fields) == null ? void 0 : _a.find) == null ? void 0 : _b.call(_a, (field) => (field == null ? void 0 : field.primaryKey) === true);
+    if (primaryKeyField == null ? void 0 : primaryKeyField.name) {
+      values.titleField = primaryKeyField.name;
+    }
+  }
+  return values;
+}
+function composeCollectionDefinition(input, options = {}) {
+  const baseline = options.mode === "create" ? buildTemplateBaseline(input) : {};
+  const baselineFields = Array.isArray(baseline.fields) ? baseline.fields : [];
+  const inputFields = Array.isArray(input.fields) ? input.fields : [];
+  return normalizeCollectionInput(
+    {
+      ...baseline,
+      ...input,
+      fields: (0, import_constants.uniqueByName)([...baselineFields, ...inputFields])
+    },
+    options
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildTemplateBaseline,
+  composeCollectionDefinition,
+  normalizeCollectionInput
+});

package/dist/server/modeling/constants.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 type PlainObject = Record<string, any>;
+export type TemplateName = 'general' | 'tree' | 'file' | 'calendar' | 'comment' | 'sql' | 'view' | 'inherit';
+export declare const TEMPLATE_NAMES: TemplateName[];
+export declare const MULTI_COMPONENT_INTERFACES: Set<string>;
+export declare const ARRAY_DEFAULT_INTERFACES: Set<string>;
+export declare const CHOICE_INTERFACES: Set<string>;
+export declare const RELATION_INTERFACES: Set<string>;
+export declare const INTERFACE_ALIASES: Record<string, string>;
+export declare const CHOICE_COLOR_OPTIONS: string[];
+export declare const PLUGIN_REQUIREMENTS: Record<string, {
+    runtimeName: string;
+    packageName: string;
+    capability: string;
+}>;
+export declare function toDisplayTitle(value?: string): string;
+export declare function normalizeChoiceEnum(enumValues?: any[]): any[];
+export declare function validateChoiceEnumColors(enumValues?: any[], fieldName?: string): void;
+export declare function uniqueByName(fields: PlainObject[]): PlainObject[];

package/dist/server/modeling/constants.js

@@ -0,0 +1,239 @@
+/**
+ * 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 constants_exports = {};
+__export(constants_exports, {
+  ARRAY_DEFAULT_INTERFACES: () => ARRAY_DEFAULT_INTERFACES,
+  CHOICE_COLOR_OPTIONS: () => CHOICE_COLOR_OPTIONS,
+  CHOICE_INTERFACES: () => CHOICE_INTERFACES,
+  INTERFACE_ALIASES: () => INTERFACE_ALIASES,
+  MULTI_COMPONENT_INTERFACES: () => MULTI_COMPONENT_INTERFACES,
+  PLUGIN_REQUIREMENTS: () => PLUGIN_REQUIREMENTS,
+  RELATION_INTERFACES: () => RELATION_INTERFACES,
+  TEMPLATE_NAMES: () => TEMPLATE_NAMES,
+  normalizeChoiceEnum: () => normalizeChoiceEnum,
+  toDisplayTitle: () => toDisplayTitle,
+  uniqueByName: () => uniqueByName,
+  validateChoiceEnumColors: () => validateChoiceEnumColors
+});
+module.exports = __toCommonJS(constants_exports);
+var import_lodash = __toESM(require("lodash"));
+const TEMPLATE_NAMES = [
+  "general",
+  "tree",
+  "file",
+  "calendar",
+  "comment",
+  "sql",
+  "view",
+  "inherit"
+];
+const MULTI_COMPONENT_INTERFACES = /* @__PURE__ */ new Set([
+  "multipleSelect",
+  "checkboxGroup",
+  "m2m",
+  "o2m",
+  "attachment",
+  "mbm"
+]);
+const ARRAY_DEFAULT_INTERFACES = /* @__PURE__ */ new Set(["multipleSelect", "checkboxGroup"]);
+const CHOICE_INTERFACES = /* @__PURE__ */ new Set(["select", "multipleSelect", "radioGroup", "checkboxGroup"]);
+const RELATION_INTERFACES = /* @__PURE__ */ new Set(["m2o", "o2m", "m2m", "obo", "oho", "mbm"]);
+const INTERFACE_ALIASES = {
+  text: "textarea",
+  longText: "textarea",
+  singleSelect: "select",
+  multiSelect: "multipleSelect",
+  singleLineText: "input",
+  date: "dateOnly",
+  dateOnly: "dateOnly",
+  datetimeWithoutTz: "datetimeNoTz",
+  datetimeWithoutTimezone: "datetimeNoTz",
+  datetimeWithTimezone: "datetime",
+  unixTs: "unixTimestamp",
+  o2o: "obo"
+};
+const CHOICE_COLOR_OPTIONS = [
+  "red",
+  "magenta",
+  "volcano",
+  "orange",
+  "gold",
+  "lime",
+  "green",
+  "cyan",
+  "blue",
+  "geekblue",
+  "purple",
+  "default"
+];
+const CHOICE_COLOR_OPTION_SET = new Set(CHOICE_COLOR_OPTIONS);
+const PLUGIN_REQUIREMENTS = {
+  file: {
+    runtimeName: "file-manager",
+    packageName: "@nocobase/plugin-file-manager",
+    capability: "file collection template"
+  },
+  attachment: {
+    runtimeName: "file-manager",
+    packageName: "@nocobase/plugin-file-manager",
+    capability: "attachment field and attachments collection"
+  },
+  attachmentURL: {
+    runtimeName: "field-attachment-url",
+    packageName: "@nocobase/plugin-field-attachment-url",
+    capability: "attachmentURL field"
+  },
+  comment: {
+    runtimeName: "comments",
+    packageName: "@nocobase/plugin-comments",
+    capability: "comment collection template"
+  },
+  vditor: {
+    runtimeName: "field-markdown-vditor",
+    packageName: "@nocobase/plugin-field-markdown-vditor",
+    capability: "vditor field"
+  },
+  point: {
+    runtimeName: "map",
+    packageName: "@nocobase/plugin-map",
+    capability: "point geometry field"
+  },
+  lineString: {
+    runtimeName: "map",
+    packageName: "@nocobase/plugin-map",
+    capability: "lineString geometry field"
+  },
+  circle: {
+    runtimeName: "map",
+    packageName: "@nocobase/plugin-map",
+    capability: "circle geometry field"
+  },
+  polygon: {
+    runtimeName: "map",
+    packageName: "@nocobase/plugin-map",
+    capability: "polygon geometry field"
+  },
+  chinaRegion: {
+    runtimeName: "field-china-region",
+    packageName: "@nocobase/plugin-field-china-region",
+    capability: "chinaRegion field and chinaRegions backing collection"
+  },
+  formula: {
+    runtimeName: "field-formula",
+    packageName: "@nocobase/plugin-field-formula",
+    capability: "formula field"
+  },
+  sort: {
+    runtimeName: "field-sort",
+    packageName: "@nocobase/plugin-field-sort",
+    capability: "sort field"
+  },
+  code: {
+    runtimeName: "field-code",
+    packageName: "@nocobase/plugin-field-code",
+    capability: "code field"
+  },
+  sequence: {
+    runtimeName: "field-sequence",
+    packageName: "@nocobase/plugin-field-sequence",
+    capability: "sequence field"
+  },
+  encryption: {
+    runtimeName: "field-encryption",
+    packageName: "@nocobase/plugin-field-encryption",
+    capability: "encryption field"
+  },
+  mbm: {
+    runtimeName: "field-m2m-array",
+    packageName: "@nocobase/plugin-field-m2m-array",
+    capability: "many-to-many array field"
+  }
+};
+function toDisplayTitle(value) {
+  if (!value) {
+    return value;
+  }
+  return import_lodash.default.startCase(value.replace(/[._-]+/g, " "));
+}
+function normalizeChoiceEnum(enumValues = []) {
+  return enumValues.map((item) => {
+    if (import_lodash.default.isPlainObject(item)) {
+      return item;
+    }
+    return {
+      label: String(item),
+      value: item
+    };
+  });
+}
+function validateChoiceEnumColors(enumValues = [], fieldName = "(unknown)") {
+  const allowedColors = CHOICE_COLOR_OPTIONS.join(", ");
+  enumValues.forEach((item, index) => {
+    if (!import_lodash.default.isPlainObject(item)) {
+      throw new Error(
+        `Field ${fieldName} enum item #${index + 1} must be an object with value, label, and color; string shorthand is not allowed`
+      );
+    }
+    const optionName = item.value ?? item.label ?? `#${index + 1}`;
+    if (!item.color) {
+      throw new Error(`Field ${fieldName} enum item ${optionName} requires color`);
+    }
+    if (!CHOICE_COLOR_OPTION_SET.has(item.color)) {
+      throw new Error(
+        `Field ${fieldName} enum item ${optionName} color ${item.color} is invalid. Allowed colors: ${allowedColors}`
+      );
+    }
+  });
+}
+function uniqueByName(fields) {
+  return import_lodash.default.uniqBy(fields.filter(Boolean).reverse(), "name").reverse();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ARRAY_DEFAULT_INTERFACES,
+  CHOICE_COLOR_OPTIONS,
+  CHOICE_INTERFACES,
+  INTERFACE_ALIASES,
+  MULTI_COMPONENT_INTERFACES,
+  PLUGIN_REQUIREMENTS,
+  RELATION_INTERFACES,
+  TEMPLATE_NAMES,
+  normalizeChoiceEnum,
+  toDisplayTitle,
+  uniqueByName,
+  validateChoiceEnumColors
+});

package/dist/server/modeling/fields.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 { PlainObject } from './constants';
+export declare function normalizeInterfaceName(value?: string): string;
+export declare function validateChoiceFieldInput(field?: PlainObject): void;
+export declare function normalizeFieldInput(input: PlainObject, context?: PlainObject): PlainObject;
+export declare function normalizeFieldList(fields?: PlainObject[], collectionName?: string): PlainObject[];