plugin-build-visualization-block 0.1.1

package/dist/server/pipeline/generator.js

@@ -0,0 +1,386 @@
+/**
+ * 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 generator_exports = {};
+__export(generator_exports, {
+  default: () => generator_default,
+  generate: () => generate,
+  generateChartSchema: () => generateChartSchema,
+  generateFormSchema: () => generateFormSchema,
+  generateTableSchema: () => generateTableSchema
+});
+module.exports = __toCommonJS(generator_exports);
+var import_shared = require("@formily/shared");
+var import_fallback = require("./fallback");
+const DEFAULT_AGGREGATION = "count";
+const DEFAULT_QUERY_LIMIT = 2e3;
+const DEFAULT_TABLE_PAGE_SIZE = 20;
+function createRendererSchema(decoratorProps) {
+  const { collection, config } = decoratorProps;
+  const { title, bordered } = config;
+  return {
+    type: "void",
+    "x-decorator": "ChartRendererProvider",
+    "x-decorator-props": decoratorProps,
+    "x-acl-action": `${collection}:list`,
+    "x-toolbar": "ChartRendererToolbar",
+    "x-settings": "chart:renderer",
+    "x-component": "CardItem",
+    "x-component-props": {
+      size: "small",
+      title,
+      bordered
+    },
+    "x-initializer": "charts:addBlock",
+    properties: {
+      actions: {
+        type: "void",
+        "x-decorator": "div",
+        "x-decorator-props": {
+          style: {
+            position: "absolute",
+            top: 0,
+            right: 0,
+            zIndex: 10
+          }
+        },
+        "x-component": "ActionBar",
+        "x-component-props": {
+          style: {
+            marginRight: "var(--nb-designer-offset)",
+            marginTop: "var(--nb-designer-offset)"
+          }
+        },
+        "x-initializer": "chart:configureActions"
+      },
+      [(0, import_shared.uid)()]: {
+        type: "void",
+        "x-component": "ChartRenderer",
+        "x-component-props": {}
+      }
+    }
+  };
+}
+function gridRowColWrap(schema) {
+  return {
+    type: "void",
+    "x-component": "Grid.Row",
+    properties: {
+      [(0, import_shared.uid)()]: {
+        type: "void",
+        "x-component": "Grid.Col",
+        properties: {
+          [(schema == null ? void 0 : schema.name) || (0, import_shared.uid)()]: schema
+        }
+      }
+    }
+  };
+}
+function createChartSchema(chart, dataSource, collection) {
+  const dimensions = (chart.dimensions ?? []).map((dimension) => ({
+    field: dimension.field,
+    alias: dimension.alias,
+    format: dimension.format
+  }));
+  const measures = chart.measures.map((measure) => ({
+    field: measure.field,
+    aggregation: measure.aggregation ?? DEFAULT_AGGREGATION,
+    alias: measure.alias,
+    distinct: measure.distinct
+  }));
+  const config = {
+    chartType: chart.chartType,
+    title: chart.title,
+    bordered: false,
+    general: chart.config ?? {},
+    advanced: {}
+  };
+  const rendererProps = {
+    mode: "builder",
+    dataSource,
+    collection,
+    query: {
+      measures,
+      dimensions,
+      limit: DEFAULT_QUERY_LIMIT,
+      offset: 0
+    },
+    config
+  };
+  return gridRowColWrap(createRendererSchema(rendererProps));
+}
+function generateChartSchema(spec, summary) {
+  const charts = spec.charts ?? [];
+  const properties = {};
+  for (const chart of charts) {
+    properties[(0, import_shared.uid)()] = createChartSchema(chart, spec.dataSource, spec.primaryCollection);
+  }
+  return {
+    type: "void",
+    "x-component": "ChartCardItem",
+    "x-use-component-props": "useChartBlockCardProps",
+    "x-settings": "chart:block",
+    "x-decorator": "ChartBlockProvider",
+    properties: {
+      actions: {
+        type: "void",
+        "x-component": "ActionBar",
+        "x-component-props": {
+          style: {
+            marginBottom: "var(--nb-designer-offset)"
+          }
+        },
+        "x-initializer": "chartBlock:configureActions"
+      },
+      [(0, import_shared.uid)()]: {
+        type: "void",
+        "x-component": "Grid",
+        "x-decorator": "ChartV2Block",
+        "x-initializer": "charts:addBlock",
+        properties
+      }
+    }
+  };
+}
+function createTableColumnSchema(collection, field) {
+  return {
+    type: "void",
+    "x-decorator": "TableV2.Column.Decorator",
+    "x-toolbar": "TableColumnSchemaToolbar",
+    "x-settings": "fieldSettings:TableColumn",
+    "x-component": "TableV2.Column",
+    properties: {
+      [field]: {
+        "x-collection-field": `${collection}.${field}`,
+        "x-component": "CollectionField",
+        "x-component-props": {}
+      }
+    }
+  };
+}
+function createTableActionColumnSchema() {
+  return {
+    type: "void",
+    title: '{{ t("Actions") }}',
+    "x-action-column": "actions",
+    "x-decorator": "TableV2.Column.ActionBar",
+    "x-component": "TableV2.Column",
+    "x-toolbar": "TableColumnSchemaToolbar",
+    "x-initializer": "table:configureItemActions",
+    "x-settings": "fieldSettings:TableColumn",
+    "x-toolbar-props": {
+      initializer: "table:configureItemActions"
+    },
+    properties: {
+      [(0, import_shared.uid)()]: {
+        type: "void",
+        "x-decorator": "DndContext",
+        "x-component": "Space",
+        "x-component-props": {
+          split: "|"
+        }
+      }
+    }
+  };
+}
+function generateTableSchema(spec, summary) {
+  var _a;
+  const collection = spec.primaryCollection;
+  const fields = ((_a = spec.table) == null ? void 0 : _a.fields) ?? [];
+  const decoratorProps = {
+    collection,
+    dataSource: spec.dataSource,
+    action: "list",
+    params: { pageSize: DEFAULT_TABLE_PAGE_SIZE },
+    showIndex: true,
+    dragSort: false
+  };
+  const columnProperties = {
+    actions: createTableActionColumnSchema()
+  };
+  for (const field of fields) {
+    columnProperties[(0, import_shared.uid)()] = createTableColumnSchema(collection, field);
+  }
+  return {
+    type: "void",
+    "x-decorator": "TableBlockProvider",
+    "x-acl-action": `${collection}:list`,
+    "x-use-decorator-props": "useTableBlockDecoratorProps",
+    "x-decorator-props": decoratorProps,
+    "x-toolbar": "BlockSchemaToolbar",
+    "x-settings": "blockSettings:table",
+    "x-component": "CardItem",
+    "x-filter-targets": [],
+    properties: {
+      actions: {
+        type: "void",
+        "x-initializer": "table:configureActions",
+        "x-component": "ActionBar",
+        "x-component-props": {
+          style: {
+            marginBottom: "var(--nb-spacing)"
+          }
+        },
+        properties: {}
+      },
+      [(0, import_shared.uid)()]: {
+        type: "array",
+        "x-initializer": "table:configureColumns",
+        "x-component": "TableV2",
+        "x-use-component-props": "useTableBlockProps",
+        "x-component-props": {
+          rowKey: "id",
+          rowSelection: {
+            type: "checkbox"
+          }
+        },
+        properties: columnProperties
+      }
+    }
+  };
+}
+function createFormFieldRowSchema(collection, field) {
+  return {
+    type: "void",
+    "x-component": "Grid.Row",
+    properties: {
+      [(0, import_shared.uid)()]: {
+        type: "void",
+        "x-component": "Grid.Col",
+        properties: {
+          [field]: {
+            type: "string",
+            "x-toolbar": "FormItemSchemaToolbar",
+            "x-settings": "fieldSettings:FormItem",
+            "x-component": "CollectionField",
+            "x-decorator": "FormItem",
+            "x-collection-field": `${collection}.${field}`,
+            "x-component-props": {}
+          }
+        }
+      }
+    }
+  };
+}
+function generateFormSchema(spec, summary) {
+  var _a, _b;
+  const collection = spec.primaryCollection;
+  const fields = ((_a = spec.form) == null ? void 0 : _a.fields) ?? [];
+  const isCreate = ((_b = spec.form) == null ? void 0 : _b.mode) === "create";
+  const decoratorProps = isCreate ? { dataSource: spec.dataSource, collection } : { action: "get", dataSource: spec.dataSource, collection };
+  const gridProperties = {};
+  for (const field of fields) {
+    gridProperties[(0, import_shared.uid)()] = createFormFieldRowSchema(collection, field);
+  }
+  return {
+    type: "void",
+    "x-acl-action-props": {
+      skipScopeCheck: isCreate
+    },
+    "x-acl-action": isCreate ? `${collection}:create` : `${collection}:get`,
+    "x-decorator": "FormBlockProvider",
+    "x-use-decorator-props": isCreate ? "useCreateFormBlockDecoratorProps" : "useEditFormBlockDecoratorProps",
+    "x-decorator-props": decoratorProps,
+    "x-toolbar": "BlockSchemaToolbar",
+    "x-settings": isCreate ? "blockSettings:createForm" : "blockSettings:editForm",
+    "x-component": "CardItem",
+    properties: {
+      [(0, import_shared.uid)()]: {
+        type: "void",
+        "x-component": "FormV2",
+        "x-use-component-props": isCreate ? "useCreateFormBlockProps" : "useEditFormBlockProps",
+        properties: {
+          grid: {
+            type: "void",
+            "x-component": "Grid",
+            "x-initializer": "form:configureFields",
+            properties: gridProperties
+          },
+          [(0, import_shared.uid)()]: {
+            type: "void",
+            "x-initializer": isCreate ? "createForm:configureActions" : "editForm:configureActions",
+            "x-component": "ActionBar",
+            "x-component-props": {
+              layout: "one-column"
+            }
+          }
+        }
+      }
+    }
+  };
+}
+function generateSchema(spec, summary) {
+  switch (spec.blockType) {
+    case "chart":
+      return generateChartSchema(spec, summary);
+    case "table":
+      return generateTableSchema(spec, summary);
+    case "form":
+      return generateFormSchema(spec, summary);
+    default:
+      throw new Error(`[generator] unknown blockType "${String(spec.blockType)}"`);
+  }
+}
+function isProducible(spec) {
+  var _a, _b, _c, _d, _e;
+  switch (spec.blockType) {
+    case "chart":
+      return (((_a = spec.charts) == null ? void 0 : _a.length) ?? 0) > 0;
+    case "table":
+      return (((_c = (_b = spec.table) == null ? void 0 : _b.fields) == null ? void 0 : _c.length) ?? 0) > 0;
+    case "form":
+      return (((_e = (_d = spec.form) == null ? void 0 : _d.fields) == null ? void 0 : _e.length) ?? 0) > 0;
+    default:
+      return false;
+  }
+}
+function toErrorMessage(error) {
+  return error instanceof Error ? error.message : String(error);
+}
+function generate(spec, summary) {
+  if (!isProducible(spec)) {
+    try {
+      const schema = generateSchema((0, import_fallback.buildFallbackSpec)(summary), summary);
+      return { ok: true, schema, usedFallback: true };
+    } catch (error) {
+      return { ok: false, error: toErrorMessage(error), failedNode: "fallback" };
+    }
+  }
+  try {
+    const schema = generateSchema(spec, summary);
+    return { ok: true, schema, usedFallback: false };
+  } catch (error) {
+    return { ok: false, error: toErrorMessage(error), failedNode: spec.blockType };
+  }
+}
+var generator_default = generate;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generate,
+  generateChartSchema,
+  generateFormSchema,
+  generateTableSchema
+});

package/dist/server/pipeline/introspector.js

@@ -0,0 +1,118 @@
+/**
+ * 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 introspector_exports = {};
+__export(introspector_exports, {
+  default: () => introspector_default,
+  introspect: () => introspect
+});
+module.exports = __toCommonJS(introspector_exports);
+const RELATION_TYPES = /* @__PURE__ */ new Set([
+  "belongsTo",
+  "hasMany",
+  "hasOne",
+  "belongsToMany",
+  "o2m",
+  "m2o",
+  "o2o",
+  "m2m",
+  "obo",
+  "oho"
+]);
+const DEFAULT_DATA_SOURCE_KEYS = /* @__PURE__ */ new Set(["", "main"]);
+function resolveCollection(app, dataSource, name) {
+  var _a, _b, _c;
+  if (DEFAULT_DATA_SOURCE_KEYS.has(dataSource)) {
+    return app.db.getCollection(name);
+  }
+  const source = (_b = (_a = app.dataSourceManager) == null ? void 0 : _a.dataSources) == null ? void 0 : _b.get(dataSource);
+  const collection = (_c = source == null ? void 0 : source.collectionManager) == null ? void 0 : _c.getCollection(name);
+  return collection;
+}
+function readFieldTitle(field, name) {
+  var _a;
+  const options = field.options ?? {};
+  return ((_a = options.uiSchema) == null ? void 0 : _a.title) ?? options.title ?? name;
+}
+function isRelation(field, type) {
+  if (typeof field.isRelationField === "function") {
+    return field.isRelationField();
+  }
+  return RELATION_TYPES.has(type);
+}
+function summarizeCollection(name, collection) {
+  const fields = [];
+  const relations = [];
+  for (const field of collection.getFields()) {
+    const options = field.options ?? {};
+    const fieldName = field.name ?? options.name ?? "";
+    const type = field.type ?? options.type ?? "";
+    if (fieldName === "" || type === "") {
+      continue;
+    }
+    fields.push({
+      name: fieldName,
+      type,
+      interface: options.interface ?? "",
+      title: readFieldTitle(field, fieldName)
+    });
+    if (isRelation(field, type) && typeof options.target === "string") {
+      relations.push({
+        name: fieldName,
+        type,
+        target: options.target
+      });
+    }
+  }
+  return { name, fields, relations };
+}
+async function introspect(app, options) {
+  var _a, _b;
+  const { dataSource, collections } = options;
+  const summaries = [];
+  for (const name of collections) {
+    try {
+      const collection = resolveCollection(app, dataSource, name);
+      if (!collection || typeof collection.getFields !== "function") {
+        summaries.push({ name, fields: [], relations: [], introspectionFailed: true });
+        continue;
+      }
+      summaries.push(summarizeCollection(name, collection));
+    } catch (error) {
+      (_b = (_a = app.logger) == null ? void 0 : _a.warn) == null ? void 0 : _b.call(
+        _a,
+        `[plugin-build-visualization-block] failed to introspect collection "${name}" in data source "${dataSource}": ${error instanceof Error ? error.message : String(error)}`
+      );
+      summaries.push({ name, fields: [], relations: [], introspectionFailed: true });
+    }
+  }
+  return { dataSource, collections: summaries };
+}
+var introspector_default = introspect;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  introspect
+});