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

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

@@ -0,0 +1,435 @@
+/**
+ * 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 BlockListModel_exports = {};
+__export(BlockListModel_exports, {
+  flowSchemaContribution: () => flowSchemaContribution
+});
+module.exports = __toCommonJS(BlockListModel_exports);
+const genericFilterSchemaId = "urn:nocobase:schema:plugin-block-list:generic-filter";
+const genericFilterSchema = {
+  $id: genericFilterSchemaId,
+  definitions: {
+    filterCondition: {
+      type: "object",
+      properties: {
+        path: {
+          type: "string"
+        },
+        operator: {
+          type: "string"
+        },
+        value: {},
+        noValue: {
+          type: "boolean"
+        }
+      },
+      required: ["path"],
+      additionalProperties: true,
+      allOf: [
+        {
+          not: {
+            required: ["logic"]
+          }
+        },
+        {
+          not: {
+            required: ["items"]
+          }
+        }
+      ]
+    },
+    filterGroup: {
+      type: "object",
+      properties: {
+        logic: {
+          type: "string",
+          enum: ["$and", "$or"]
+        },
+        items: {
+          type: "array",
+          items: {
+            oneOf: [
+              { $ref: `${genericFilterSchemaId}#/definitions/filterCondition` },
+              { $ref: `${genericFilterSchemaId}#/definitions/filterGroup` }
+            ]
+          }
+        }
+      },
+      required: ["logic", "items"],
+      additionalProperties: true,
+      allOf: [
+        {
+          not: {
+            required: ["path"]
+          }
+        },
+        {
+          not: {
+            required: ["operator"]
+          }
+        },
+        {
+          not: {
+            required: ["value"]
+          }
+        },
+        {
+          not: {
+            required: ["noValue"]
+          }
+        }
+      ]
+    }
+  },
+  type: "object",
+  properties: {
+    logic: {
+      type: "string",
+      enum: ["$and", "$or"]
+    },
+    items: {
+      type: "array",
+      items: {
+        oneOf: [
+          { $ref: `${genericFilterSchemaId}#/definitions/filterCondition` },
+          { $ref: `${genericFilterSchemaId}#/definitions/filterGroup` }
+        ]
+      }
+    }
+  },
+  required: ["logic", "items"],
+  additionalProperties: true,
+  allOf: [
+    {
+      not: {
+        required: ["path"]
+      }
+    },
+    {
+      not: {
+        required: ["operator"]
+      }
+    },
+    {
+      not: {
+        required: ["value"]
+      }
+    },
+    {
+      not: {
+        required: ["noValue"]
+      }
+    }
+  ]
+};
+const sortingRuleParamsSchema = {
+  type: "object",
+  properties: {
+    sort: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          field: { type: "string" },
+          direction: { type: "string", enum: ["asc", "desc"] }
+        },
+        required: ["field", "direction"],
+        additionalProperties: false
+      }
+    }
+  },
+  additionalProperties: false
+};
+const layoutParamsSchema = {
+  type: "object",
+  properties: {
+    layout: {
+      type: "string",
+      enum: ["vertical", "horizontal"]
+    },
+    labelAlign: {
+      type: "string",
+      enum: ["left", "right"]
+    },
+    labelWidth: { type: ["number", "string", "null"] },
+    labelWrap: { type: "boolean" },
+    colon: { type: "boolean" }
+  },
+  required: ["layout"],
+  additionalProperties: false
+};
+const genericModelNodeSchema = {
+  type: "object",
+  required: ["uid", "use"],
+  properties: {
+    uid: { type: "string" },
+    use: { type: "string" }
+  },
+  additionalProperties: true
+};
+const collectionResourceInitSchema = {
+  type: "object",
+  properties: {
+    dataSourceKey: { type: "string" },
+    collectionName: { type: "string" },
+    associationName: { type: "string" },
+    sourceId: { type: ["string", "number"] },
+    filterByTk: { type: ["string", "number"] }
+  },
+  required: ["dataSourceKey", "collectionName"],
+  additionalProperties: true
+};
+const collectionResourceSettingsStepParamsSchema = {
+  type: "object",
+  properties: {
+    resourceSettings: {
+      type: "object",
+      properties: {
+        init: collectionResourceInitSchema
+      },
+      additionalProperties: true
+    }
+  },
+  additionalProperties: true
+};
+const createCollectionResourceStepParams = (init = {}, extraStepParams = {}) => ({
+  resourceSettings: {
+    init: {
+      dataSourceKey: "main",
+      collectionName: "users",
+      ...init
+    }
+  },
+  ...extraStepParams
+});
+const createAssociatedCollectionPattern = (use, extraStepParams = {}) => ({
+  title: "Associated records in popup/new scene",
+  description: "Use associationName + sourceId when the block should load records through a parent relation.",
+  snippet: {
+    use,
+    stepParams: createCollectionResourceStepParams(
+      {
+        collectionName: "roles",
+        associationName: "users.roles",
+        sourceId: "{{ctx.view.inputArgs.sourceId}}"
+      },
+      extraStepParams
+    )
+  }
+});
+const listItemModelInternalSchemaContribution = {
+  use: "ListItemModel",
+  title: "List item",
+  source: "plugin",
+  strict: false,
+  exposure: "internal",
+  subModelSlots: {
+    grid: {
+      type: "object",
+      use: "DetailsGridModel",
+      description: "Per-record details grid."
+    }
+  },
+  skeleton: {
+    uid: "todo-list-item-uid",
+    use: "ListItemModel",
+    subModels: {
+      grid: {
+        uid: "todo-list-item-grid-uid",
+        use: "DetailsGridModel"
+      }
+    }
+  }
+};
+const listBlockModelSchemaContribution = {
+  use: "ListBlockModel",
+  title: "List block",
+  source: "plugin",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      ...collectionResourceSettingsStepParamsSchema.properties || {},
+      resourceSettings2: {
+        type: "object",
+        additionalProperties: true
+      },
+      listSettings: {
+        type: "object",
+        properties: {
+          pageSize: {
+            type: "object",
+            properties: {
+              pageSize: {
+                type: "number",
+                enum: [5, 10, 20, 50, 100, 200]
+              }
+            },
+            additionalProperties: false
+          },
+          dataScope: {
+            type: "object",
+            properties: {
+              filter: genericFilterSchema
+            },
+            additionalProperties: false
+          },
+          defaultSorting: sortingRuleParamsSchema,
+          layout: layoutParamsSchema
+        },
+        additionalProperties: true
+      },
+      paginationChange: {
+        type: "object",
+        properties: {
+          linkageRulesRefresh: {
+            type: "object",
+            properties: {
+              actionName: { type: "string" },
+              flowKey: { type: "string" },
+              stepKey: { type: "string" }
+            },
+            required: ["actionName", "flowKey"],
+            additionalProperties: false
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  subModelSlots: {
+    item: {
+      type: "object",
+      use: "ListItemModel",
+      description: "List item layout."
+    },
+    actions: {
+      type: "array",
+      dynamic: true,
+      schema: genericModelNodeSchema,
+      description: "List actions depend on runtime collection-action registries."
+    }
+  },
+  skeleton: {
+    uid: "todo-uid",
+    use: "ListBlockModel",
+    stepParams: createCollectionResourceStepParams(
+      {},
+      {
+        listSettings: {
+          pageSize: {
+            pageSize: 20
+          }
+        }
+      }
+    ),
+    subModels: {
+      item: {
+        uid: "todo-list-item-uid",
+        use: "ListItemModel"
+      },
+      actions: []
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "list-users",
+      use: "ListBlockModel",
+      stepParams: createCollectionResourceStepParams(
+        {},
+        {
+          listSettings: {
+            pageSize: {
+              pageSize: 20
+            }
+          }
+        }
+      ),
+      subModels: {
+        item: {
+          uid: "list-item-users",
+          use: "ListItemModel"
+        },
+        actions: []
+      }
+    },
+    commonPatterns: [
+      {
+        title: "Basic list block",
+        snippet: {
+          use: "ListBlockModel",
+          stepParams: createCollectionResourceStepParams(
+            {},
+            {
+              listSettings: {
+                pageSize: {
+                  pageSize: 20
+                }
+              }
+            }
+          )
+        }
+      },
+      createAssociatedCollectionPattern("ListBlockModel", {
+        listSettings: {
+          pageSize: {
+            pageSize: 20
+          }
+        }
+      })
+    ],
+    dynamicHints: [
+      {
+        kind: "dynamic-children",
+        path: "ListBlockModel.subModels.actions",
+        message: "List actions depend on runtime collection-action registries.",
+        "x-flow": {
+          slotRules: {
+            slotKey: "actions",
+            type: "array"
+          },
+          contextRequirements: ["collection action registry"],
+          unresolvedReason: "runtime-list-actions"
+        }
+      }
+    ]
+  }
+};
+const flowSchemaContribution = {
+  inventory: {
+    publicTreeRoots: ["ListBlockModel"]
+  },
+  models: [listItemModelInternalSchemaContribution, listBlockModelSchemaContribution],
+  defaults: {
+    source: "plugin"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  flowSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/BlockMarkdownModel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 '../../flow-schema-registry';
+export declare const flowSchemaContribution: FlowSchemaContribution;

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

@@ -0,0 +1,108 @@
+/**
+ * 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 BlockMarkdownModel_exports = {};
+__export(BlockMarkdownModel_exports, {
+  flowSchemaContribution: () => flowSchemaContribution
+});
+module.exports = __toCommonJS(BlockMarkdownModel_exports);
+const markdownBlockModelSchemaContribution = {
+  use: "MarkdownBlockModel",
+  title: "Markdown block",
+  source: "plugin",
+  strict: false,
+  stepParamsSchema: {
+    type: "object",
+    properties: {
+      markdownBlockSettings: {
+        type: "object",
+        properties: {
+          editMarkdown: {
+            type: "object",
+            properties: {
+              content: {
+                type: "string"
+              }
+            },
+            required: ["content"],
+            additionalProperties: false
+          }
+        },
+        additionalProperties: true
+      }
+    },
+    additionalProperties: true
+  },
+  skeleton: {
+    uid: "todo-markdown-block-uid",
+    use: "MarkdownBlockModel",
+    stepParams: {
+      markdownBlockSettings: {
+        editMarkdown: {
+          content: "This is a demo text, **supports Markdown syntax**."
+        }
+      }
+    }
+  },
+  docs: {
+    minimalExample: {
+      uid: "markdown-intro",
+      use: "MarkdownBlockModel",
+      stepParams: {
+        markdownBlockSettings: {
+          editMarkdown: {
+            content: "# Welcome"
+          }
+        }
+      }
+    },
+    dynamicHints: [
+      {
+        kind: "dynamic-ui-schema",
+        path: "MarkdownBlockModel.stepParams.markdownBlockSettings.editMarkdown.content",
+        message: "Markdown content can contain liquid variables resolved against the runtime flow context.",
+        "x-flow": {
+          contextRequirements: ["liquid variables", "markdown renderer"],
+          unresolvedReason: "runtime-markdown-context",
+          recommendedFallback: "# Welcome"
+        }
+      }
+    ]
+  }
+};
+const flowSchemaContribution = {
+  inventory: {
+    publicTreeRoots: ["MarkdownBlockModel"]
+  },
+  models: [markdownBlockModelSchemaContribution],
+  defaults: {
+    source: "plugin"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  flowSchemaContribution
+});

package/dist/server/flow-schema-contributions/models/BlockWorkbenchModel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 '../../flow-schema-registry';
+export declare const flowSchemaContribution: FlowSchemaContribution;