@nocobase/plugin-flow-engine 2.1.0-alpha.10 → 2.1.0-alpha.11

package/dist/server/flow-schema-contributions/field-models.js

@@ -0,0 +1,693 @@
+/**
+ * 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 __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 field_models_exports = {};
+__export(field_models_exports, {
+  coreFieldBindingContextContributions: () => coreFieldBindingContextContributions,
+  coreFieldBindingContributions: () => coreFieldBindingContributions,
+  coreFieldModelContributions: () => coreFieldModelContributions
+});
+module.exports = __toCommonJS(field_models_exports);
+var import_shared = require("./shared");
+function toTitle(use) {
+  return use.replace(/Model$/, "").replace(/([a-z0-9])([A-Z])/g, "$1 $2").replace(/\bJson\b/g, "JSON").replace(/\bUrl\b/g, "URL").trim();
+}
+function createFieldContribution(use, options = {}) {
+  return {
+    ...(0, import_shared.createFieldModelSchemaContribution)({
+      use,
+      title: toTitle(use)
+    }),
+    ...options,
+    use,
+    title: options.title || toTitle(use)
+  };
+}
+function createJsFieldContribution(use) {
+  const baseSchema = (0, import_shared.createFieldModelStepParamsSchema)();
+  const skeleton = (0, import_shared.createFieldModelSkeleton)(use);
+  return createFieldContribution(use, {
+    title: use === "JSEditableFieldModel" ? "JS editable field" : "JS field",
+    stepParamsSchema: {
+      type: "object",
+      properties: {
+        ...baseSchema.properties || {},
+        jsSettings: import_shared.runJsActionSettingsStepParamsSchema
+      },
+      additionalProperties: true
+    },
+    skeleton: {
+      ...skeleton,
+      stepParams: {
+        ...skeleton.stepParams || {},
+        jsSettings: {
+          runJs: {
+            version: "v2",
+            code: ""
+          }
+        }
+      }
+    }
+  });
+}
+function createAssociationDisplayFieldSkeleton(use, options = {}) {
+  const dataSourceKey = options.dataSourceKey || "main";
+  const sourceCollectionName = options.sourceCollectionName || "users";
+  const sourceFieldPath = options.sourceFieldPath || "roles";
+  const targetCollectionName = options.targetCollectionName || "roles";
+  const targetFieldPath = options.targetFieldPath || "title";
+  return {
+    ...(0, import_shared.createFieldModelSkeleton)(use, {
+      dataSourceKey,
+      collectionName: sourceCollectionName,
+      fieldPath: sourceFieldPath
+    }),
+    subModels: {
+      field: (0, import_shared.createFieldModelSkeleton)("DisplayTextFieldModel", {
+        dataSourceKey,
+        collectionName: targetCollectionName,
+        fieldPath: targetFieldPath
+      })
+    }
+  };
+}
+function createRecordPickerFieldContribution() {
+  const skeleton = createAssociationDisplayFieldSkeleton("RecordPickerFieldModel");
+  return createFieldContribution("RecordPickerFieldModel", {
+    subModelSlots: {
+      field: (0, import_shared.createRuntimeFieldModelSlotSchema)("display-field", "Selected record label renderer."),
+      "grid-block": {
+        type: "object",
+        use: "BlockGridModel",
+        description: "Popup selector content grid."
+      }
+    },
+    skeleton: {
+      ...skeleton,
+      subModels: {
+        ...skeleton.subModels,
+        "grid-block": (0, import_shared.createPopupBlockGrid)({
+          prefix: "record-picker-popup"
+        })
+      }
+    }
+  });
+}
+function createRecordSelectFieldContribution() {
+  return createFieldContribution("RecordSelectFieldModel", {
+    subModelSlots: {
+      field: (0, import_shared.createRuntimeFieldModelSlotSchema)("display-field", "Selected option label renderer.")
+    },
+    skeleton: createAssociationDisplayFieldSkeleton("RecordSelectFieldModel")
+  });
+}
+function createSubTableColumnContribution() {
+  const dataSourceKey = "main";
+  const collectionName = "users";
+  const fieldPath = "roles.title";
+  return createFieldContribution("SubTableColumnModel", {
+    subModelSlots: {
+      field: (0, import_shared.createRuntimeFieldModelSlotSchema)("editable-field", "Inline sub-table column editor field.")
+    },
+    skeleton: {
+      uid: "todo-sub-table-column-model",
+      use: "SubTableColumnModel",
+      stepParams: {
+        fieldSettings: {
+          init: {
+            dataSourceKey,
+            collectionName,
+            fieldPath
+          }
+        }
+      },
+      subModels: {
+        field: (0, import_shared.createFieldModelSkeleton)("DisplayTextFieldModel", {
+          dataSourceKey,
+          collectionName,
+          fieldPath
+        })
+      }
+    }
+  });
+}
+function createSubTableFieldContribution() {
+  return createFieldContribution("SubTableFieldModel", {
+    subModelSlots: {
+      columns: {
+        type: "array",
+        uses: ["SubTableColumnModel"],
+        description: "Inline editable sub-table columns."
+      }
+    },
+    skeleton: {
+      ...(0, import_shared.createFieldModelSkeleton)("SubTableFieldModel", {
+        dataSourceKey: "main",
+        collectionName: "users",
+        fieldPath: "roles"
+      }),
+      subModels: {
+        columns: [
+          {
+            uid: "todo-sub-table-column-model",
+            use: "SubTableColumnModel",
+            stepParams: {
+              fieldSettings: {
+                init: {
+                  dataSourceKey: "main",
+                  collectionName: "users",
+                  fieldPath: "roles.title"
+                }
+              }
+            },
+            subModels: {
+              field: (0, import_shared.createFieldModelSkeleton)("DisplayTextFieldModel", {
+                dataSourceKey: "main",
+                collectionName: "users",
+                fieldPath: "roles.title"
+              })
+            }
+          }
+        ]
+      }
+    }
+  });
+}
+function createSubFormFieldContribution(use) {
+  return createFieldContribution(use, {
+    subModelSlots: {
+      grid: {
+        type: "object",
+        use: "FormGridModel",
+        description: "Nested form grid."
+      }
+    },
+    skeleton: {
+      ...(0, import_shared.createFieldModelSkeleton)(use, {
+        dataSourceKey: "main",
+        collectionName: "users",
+        fieldPath: use === "SubFormFieldModel" ? "profile" : "roles"
+      }),
+      subModels: {
+        grid: {
+          uid: `todo-${use.replace(/Model$/, "").replace(/[A-Z]/g, (m, i) => `${i ? "-" : ""}${m.toLowerCase()}`)}-grid`,
+          use: "FormGridModel"
+        }
+      }
+    }
+  });
+}
+function associationBinding(context, use, interfaces, options = {}) {
+  return {
+    context,
+    use,
+    interfaces,
+    conditions: {
+      association: true,
+      ...options.conditions || {}
+    },
+    ...options
+  };
+}
+const coreFieldBindingContextContributions = [
+  { name: "editable-field" },
+  { name: "display-field" },
+  { name: "filter-field" },
+  { name: "form-item-field", inherits: ["editable-field"] },
+  { name: "assign-form-item-field", inherits: ["form-item-field"] },
+  { name: "table-column-field", inherits: ["display-field"] },
+  { name: "details-item-field", inherits: ["display-field"] },
+  { name: "form-association-item-field", inherits: ["display-field"] },
+  { name: "filter-form-item-field", inherits: ["filter-field"] }
+];
+const coreFieldModelContributionEntries = [
+  "InputFieldModel",
+  "NumberFieldModel",
+  "PercentFieldModel",
+  "PasswordFieldModel",
+  "CollectionSelectorFieldModel",
+  "DateOnlyFieldModel",
+  "DateTimeNoTzFieldModel",
+  "DateTimeTzFieldModel",
+  "TimeFieldModel",
+  "CheckboxFieldModel",
+  "CheckboxGroupFieldModel",
+  "RadioGroupFieldModel",
+  "SelectFieldModel",
+  "TextareaFieldModel",
+  "JsonFieldModel",
+  "RichTextFieldModel",
+  "ColorFieldModel",
+  "IconFieldModel",
+  createJsFieldContribution("JSFieldModel"),
+  createJsFieldContribution("JSEditableFieldModel"),
+  createRecordSelectFieldContribution(),
+  createRecordPickerFieldContribution(),
+  "CascadeSelectFieldModel",
+  "CascadeSelectListFieldModel",
+  "PopupSubTableFieldModel",
+  createSubFormFieldContribution("SubFormFieldModel"),
+  createSubFormFieldContribution("SubFormListFieldModel"),
+  createSubTableFieldContribution(),
+  createSubTableColumnContribution(),
+  "DisplayTextFieldModel",
+  "DisplayNumberFieldModel",
+  "DisplayDateTimeFieldModel",
+  "DisplayTimeFieldModel",
+  "DisplayColorFieldModel",
+  "DisplayEnumFieldModel",
+  "DisplayPasswordFieldModel",
+  "DisplayCheckboxFieldModel",
+  "DisplayJSONFieldModel",
+  "DisplayHtmlFieldModel",
+  "DisplayIconFieldModel",
+  "DisplayPercentFieldModel",
+  "DisplayURLFieldModel",
+  "DisplaySubItemFieldModel",
+  "DisplaySubListFieldModel",
+  "DisplaySubTableFieldModel",
+  "FilterFormRecordSelectFieldModel",
+  "DateTimeFilterFieldModel",
+  "DateOnlyFilterFieldModel",
+  "DateTimeNoTzFilterFieldModel",
+  "DateTimeTzFilterFieldModel"
+];
+const coreFieldModelContributions = coreFieldModelContributionEntries.map(
+  (contribution) => typeof contribution === "string" ? createFieldContribution(contribution) : contribution
+);
+const coreFieldBindingContributions = [
+  {
+    context: "editable-field",
+    use: "InputFieldModel",
+    interfaces: ["input", "email", "phone", "uuid", "url", "nanoid"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "NumberFieldModel",
+    interfaces: ["number", "integer", "id", "snowflakeId"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "PercentFieldModel",
+    interfaces: ["percent"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "PasswordFieldModel",
+    interfaces: ["password"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "CollectionSelectorFieldModel",
+    interfaces: ["collection", "tableoid"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "DateOnlyFieldModel",
+    interfaces: ["date"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "DateTimeNoTzFieldModel",
+    interfaces: ["datetimeNoTz"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "DateTimeTzFieldModel",
+    interfaces: ["createdAt", "datetime", "updatedAt", "unixTimestamp"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "TimeFieldModel",
+    interfaces: ["time"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "CheckboxFieldModel",
+    interfaces: ["checkbox"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "CheckboxGroupFieldModel",
+    interfaces: ["checkboxGroup"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "RadioGroupFieldModel",
+    interfaces: ["radioGroup"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "SelectFieldModel",
+    interfaces: ["select", "multipleSelect"],
+    isDefault: true,
+    defaultProps: {
+      allowClear: true
+    }
+  },
+  {
+    context: "editable-field",
+    use: "SelectFieldModel",
+    interfaces: ["radioGroup"]
+  },
+  {
+    context: "editable-field",
+    use: "SelectFieldModel",
+    interfaces: ["checkboxGroup"],
+    isDefault: true,
+    defaultProps: {
+      allowClear: true,
+      mode: "tags"
+    }
+  },
+  {
+    context: "editable-field",
+    use: "TextareaFieldModel",
+    interfaces: ["textarea"],
+    isDefault: true,
+    defaultProps: {
+      autoSize: {
+        minRows: 3
+      }
+    }
+  },
+  {
+    context: "editable-field",
+    use: "JsonFieldModel",
+    interfaces: ["json"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "RichTextFieldModel",
+    interfaces: ["richText"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "ColorFieldModel",
+    interfaces: ["color"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "IconFieldModel",
+    interfaces: ["icon"],
+    isDefault: true
+  },
+  {
+    context: "editable-field",
+    use: "JSEditableFieldModel",
+    interfaces: ["*"]
+  },
+  associationBinding(
+    "editable-field",
+    "RecordSelectFieldModel",
+    ["m2m", "m2o", "o2o", "o2m", "oho", "obo", "updatedBy", "createdBy", "mbm"],
+    {
+      isDefault: true,
+      order: 1
+    }
+  ),
+  associationBinding(
+    "editable-field",
+    "RecordPickerFieldModel",
+    ["m2m", "m2o", "o2o", "o2m", "oho", "obo", "updatedBy", "createdBy", "mbm"],
+    {
+      order: 20
+    }
+  ),
+  associationBinding("editable-field", "CascadeSelectFieldModel", ["m2o", "o2o", "oho", "obo"], {
+    isDefault: true,
+    order: 60,
+    conditions: {
+      targetCollectionTemplateIn: ["tree"]
+    }
+  }),
+  associationBinding("editable-field", "CascadeSelectListFieldModel", ["m2m", "o2m", "mbm"], {
+    isDefault: true,
+    order: 60,
+    conditions: {
+      targetCollectionTemplateIn: ["tree"]
+    }
+  }),
+  associationBinding("editable-field", "PopupSubTableFieldModel", ["m2m", "o2m", "mbm"], {
+    order: 300,
+    conditions: {
+      targetCollectionTemplateNotIn: ["file"]
+    }
+  }),
+  associationBinding("form-item-field", "SubFormFieldModel", ["m2o", "o2o", "oho", "obo", "updatedBy", "createdBy"], {
+    order: 100,
+    conditions: {
+      targetCollectionTemplateNotIn: ["file"]
+    }
+  }),
+  associationBinding("form-item-field", "SubFormListFieldModel", ["m2m", "o2m", "mbm"], {
+    order: 100,
+    conditions: {
+      targetCollectionTemplateNotIn: ["file"]
+    }
+  }),
+  associationBinding("form-item-field", "SubTableFieldModel", ["m2m", "o2m", "mbm"], {
+    order: 200,
+    conditions: {
+      targetCollectionTemplateNotIn: ["file"]
+    }
+  }),
+  {
+    context: "display-field",
+    use: "DisplayTextFieldModel",
+    interfaces: ["input", "email", "phone", "uuid", "textarea", "nanoid"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayNumberFieldModel",
+    interfaces: ["number", "integer", "id", "snowflakeId"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayDateTimeFieldModel",
+    interfaces: ["date", "datetimeNoTz", "createdAt", "datetime", "updatedAt", "unixTimestamp"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayTimeFieldModel",
+    interfaces: ["time"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayColorFieldModel",
+    interfaces: ["color"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayEnumFieldModel",
+    interfaces: ["select", "multipleSelect", "radioGroup", "checkboxGroup", "collection", "tableoid"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayPasswordFieldModel",
+    interfaces: ["password"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayCheckboxFieldModel",
+    interfaces: ["checkbox"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayJSONFieldModel",
+    interfaces: ["json"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayHtmlFieldModel",
+    interfaces: ["richText"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayIconFieldModel",
+    interfaces: ["icon"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayPercentFieldModel",
+    interfaces: ["percent"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "DisplayURLFieldModel",
+    interfaces: ["url"],
+    isDefault: true
+  },
+  {
+    context: "display-field",
+    use: "JSFieldModel",
+    interfaces: ["*"]
+  },
+  associationBinding("details-item-field", "DisplaySubItemFieldModel", [
+    "m2o",
+    "o2o",
+    "oho",
+    "obo",
+    "updatedBy",
+    "createdBy"
+  ]),
+  associationBinding("details-item-field", "DisplaySubListFieldModel", ["m2m", "o2m", "mbm"]),
+  associationBinding("details-item-field", "DisplaySubTableFieldModel", ["m2m", "o2m", "mbm"]),
+  {
+    context: "filter-field",
+    use: "InputFieldModel",
+    interfaces: [
+      "input",
+      "email",
+      "phone",
+      "uuid",
+      "url",
+      "nanoid",
+      "textarea",
+      "markdown",
+      "vditor",
+      "richText",
+      "password",
+      "color"
+    ],
+    isDefault: true
+  },
+  {
+    context: "filter-field",
+    use: "NumberFieldModel",
+    interfaces: ["number", "integer", "id", "snowflakeId"],
+    isDefault: true
+  },
+  {
+    context: "filter-field",
+    use: "PercentFieldModel",
+    interfaces: ["percent"],
+    isDefault: true
+  },
+  {
+    context: "filter-field",
+    use: "TimeFieldModel",
+    interfaces: ["time"],
+    isDefault: true
+  },
+  {
+    context: "filter-field",
+    use: "SelectFieldModel",
+    interfaces: ["select", "multipleSelect", "radioGroup"],
+    isDefault: true,
+    defaultProps: {
+      allowClear: true
+    }
+  },
+  {
+    context: "filter-field",
+    use: "SelectFieldModel",
+    interfaces: ["checkboxGroup"],
+    isDefault: true,
+    defaultProps: {
+      allowClear: true,
+      mode: "tags"
+    }
+  },
+  {
+    context: "filter-field",
+    use: "SelectFieldModel",
+    interfaces: ["checkbox"],
+    isDefault: true,
+    defaultProps: {
+      allowClear: true,
+      multiple: false,
+      options: [
+        { label: '{{t("Yes")}}', value: true },
+        { label: '{{t("No")}}', value: false }
+      ]
+    }
+  },
+  {
+    context: "filter-field",
+    use: "DateOnlyFilterFieldModel",
+    interfaces: ["date"],
+    isDefault: true
+  },
+  {
+    context: "filter-field",
+    use: "DateTimeNoTzFilterFieldModel",
+    interfaces: ["datetimeNoTz"],
+    isDefault: true
+  },
+  {
+    context: "filter-field",
+    use: "DateTimeTzFilterFieldModel",
+    interfaces: ["createdAt", "datetime", "updatedAt", "unixTimestamp"],
+    isDefault: true
+  },
+  associationBinding(
+    "filter-field",
+    "FilterFormRecordSelectFieldModel",
+    ["m2m", "m2o", "o2o", "o2m", "oho", "obo", "updatedBy", "createdBy", "mbm"],
+    {
+      isDefault: true,
+      defaultProps: {
+        allowMultiple: true,
+        multiple: true,
+        quickCreate: "none"
+      }
+    }
+  )
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  coreFieldBindingContextContributions,
+  coreFieldBindingContributions,
+  coreFieldModelContributions
+});

package/dist/server/flow-schema-contributions/index.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 type { FlowSchemaContribution } from '@nocobase/flow-engine';
+export * from './actions';
+export * from './field-models';
+export * from './models';
+export declare const flowSchemaContribution: FlowSchemaContribution;