@nocobase/plugin-data-source-manager 2.1.0-alpha.1 → 2.1.0-alpha.3

package/dist/ai/tools/defineCollections.js

@@ -0,0 +1,275 @@
+/**
+ * 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 defineCollections_exports = {};
+__export(defineCollections_exports, {
+  default: () => defineCollections_default
+});
+module.exports = __toCommonJS(defineCollections_exports);
+var import_ai = require("@nocobase/ai");
+var import_lodash = __toESM(require("lodash"));
+var import_zod = require("zod");
+var import_package = __toESM(require("../../../package.json"));
+const idField = {
+  name: "id",
+  type: "snowflakeId",
+  autoIncrement: false,
+  primaryKey: true,
+  allowNull: false,
+  uiSchema: {
+    type: "number",
+    title: `{{t("ai.tools.defineCollections.fields.id", { ns: "${import_package.default.name}" })}}`,
+    "x-component": "InputNumber",
+    "x-component-props": {
+      stringMode: true,
+      separator: "0.00",
+      step: "1"
+    },
+    "x-validator": "integer"
+  },
+  interface: "snowflakeId"
+};
+const createdAtField = {
+  name: "createdAt",
+  interface: "createdAt",
+  type: "date",
+  field: "createdAt",
+  uiSchema: {
+    type: "datetime",
+    title: `{{t("ai.tools.defineCollections.fields.createdAt", { ns: "${import_package.default.name}" })}}`,
+    "x-component": "DatePicker",
+    "x-component-props": {},
+    "x-read-pretty": true
+  }
+};
+const updatedAtField = {
+  type: "date",
+  field: "updatedAt",
+  name: "updatedAt",
+  interface: "updatedAt",
+  uiSchema: {
+    type: "datetime",
+    title: `{{t("ai.tools.defineCollections.fields.updatedAt", { ns: "${import_package.default.name}" })}}`,
+    "x-component": "DatePicker",
+    "x-component-props": {},
+    "x-read-pretty": true
+  }
+};
+class IntentError extends Error {
+  constructor(message) {
+    super(message);
+  }
+}
+var defineCollections_default = (0, import_ai.defineTools)({
+  scope: "SPECIFIED",
+  introduction: {
+    title: `{{t("ai.tools.defineCollections.title", { ns: "${import_package.default.name}" })}}`,
+    about: `{{t("ai.tools.defineCollections.about", { ns: "${import_package.default.name}" })}}`
+  },
+  definition: {
+    name: "defineCollections",
+    description: "Create or edit collections",
+    schema: import_zod.z.object({
+      intent: import_zod.z.enum(["create", "edit"]).describe(
+        `Pass the intent of the current tool invocation as an enum value. The value must be either 'create' or 'edit':
+- create: create a brand-new data table definition
+- edit: modify an existing data table definition`
+      ),
+      collections: import_zod.z.array(
+        import_zod.z.object({}).catchall(import_zod.z.any()).describe("Valid collection object which defined in collection_type_definition")
+      ).describe("An array of collections to be defined or edited.")
+    })
+  },
+  invoke: async (ctx, args) => {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const toolCallArgs = ((_d = (_c = (_b = (_a = ctx.action) == null ? void 0 : _a.params) == null ? void 0 : _b.values) == null ? void 0 : _c.args) == null ? void 0 : _d.intent) ? (_g = (_f = (_e = ctx.action) == null ? void 0 : _e.params) == null ? void 0 : _f.values) == null ? void 0 : _g.args : args;
+    const { intent, collections: originalCollections } = toolCallArgs ?? {};
+    if (!intent || !["create", "edit"].includes(intent)) {
+      return {
+        status: "error",
+        content: `Please explicitly specify your intent. The value of the intent parameter must be either 'create' or 'edit'.`
+      };
+    }
+    const collectionsType = typeof originalCollections;
+    const collections = collectionsType === "string" ? JSON.parse(originalCollections) : originalCollections;
+    if (!collections || !Array.isArray(collections)) {
+      return {
+        status: "error",
+        content: "No collections provided or invalid format."
+      };
+    }
+    const sorted = collections.sort((a, b) => (a.isThrough ? 1 : 0) - (b.isThrough ? 1 : 0));
+    try {
+      await ctx.db.sequelize.transaction(async (transaction) => {
+        const repo = ctx.db.getRepository("collections");
+        const pendingRelationFields = [];
+        for (const rawOptions of sorted) {
+          const options = { ...rawOptions };
+          options.fields = options.fields || [];
+          options.fields = options.fields.map(
+            (f) => f.defaultValue === "CURRENT_TIMESTAMP" ? import_lodash.default.omit(f, ["defaultValue"]) : f
+          );
+          const relationFields = options.fields.filter(
+            (f) => ["belongsTo", "hasMany", "belongsToMany", "hasOne"].includes(f.type)
+          );
+          const normalFields = options.fields.filter(
+            (f) => !["belongsTo", "hasMany", "belongsToMany", "hasOne"].includes(f.type)
+          );
+          const systemFields = [];
+          if (options.autoGenId !== false && !options.isThrough) {
+            systemFields.push(idField);
+            options.autoGenId = false;
+          }
+          if (options.createdAt !== false) {
+            systemFields.push(createdAtField);
+            options.createdAt = true;
+          }
+          if (options.updatedAt !== false) {
+            systemFields.push(updatedAtField);
+            options.updatedAt = true;
+          }
+          const baseFields = [...systemFields, ...normalFields];
+          const collection = await repo.findOne({ filter: { name: options.name }, transaction });
+          if (!collection) {
+            if (intent === "edit") {
+              throw new IntentError(
+                `You want to edit a collection definition, but there is no existing data table definition named '${options.name}'.`
+              );
+            }
+            await repo.create({
+              values: { ...options, fields: baseFields },
+              transaction,
+              context: ctx
+            });
+          } else {
+            if (intent === "create") {
+              throw new IntentError(
+                `You want to create a collection definition, but a collection definition named '${options.name}' already exists. Please change the name of your collection definition and then invoke this tool again.`
+              );
+            }
+            await repo.update({
+              filterByTk: options.name,
+              values: import_lodash.default.omit(options, ["fields"]),
+              transaction,
+              context: ctx
+            });
+            for (const field of baseFields) {
+              const fieldRepo = ctx.db.getRepository("collections.fields", options.name);
+              const existing = await fieldRepo.findOne({
+                filter: {
+                  name: field.name
+                }
+              });
+              if (!existing) {
+                await fieldRepo.create({
+                  values: field,
+                  transaction,
+                  context: ctx
+                });
+              } else {
+                await fieldRepo.update({
+                  filterByTk: field.name,
+                  values: import_lodash.default.omit(field, ["key"]),
+                  transaction,
+                  context: ctx
+                });
+              }
+            }
+          }
+          if (relationFields.length > 0) {
+            pendingRelationFields.push({
+              name: options.name,
+              relationFields
+            });
+          }
+        }
+        for (const { name, relationFields } of pendingRelationFields) {
+          const fieldRepo = ctx.db.getRepository("collections.fields", name);
+          for (const field of relationFields) {
+            const existing = await fieldRepo.findOne({
+              filter: {
+                name: field.name
+              }
+            });
+            if (!existing) {
+              await fieldRepo.create({
+                values: field,
+                transaction,
+                context: ctx
+              });
+            } else {
+              await fieldRepo.update({
+                filterByTk: field.name,
+                values: import_lodash.default.omit(field, ["key"]),
+                transaction,
+                context: ctx
+              });
+            }
+          }
+        }
+      });
+    } catch (e) {
+      ctx.log.error(e, {
+        module: "ai",
+        subModule: "toolCalling",
+        groupName: "dataModeling",
+        toolName: "defineCollections",
+        collections,
+        stack: e.stack,
+        cause: e.cause
+      });
+      if (e instanceof IntentError) {
+        return {
+          status: "error",
+          content: e.message
+        };
+      }
+      if (intent === "create") {
+        for (const options of sorted) {
+          ctx.db.removeCollection(options.name);
+        }
+      }
+      return {
+        status: "error",
+        content: `Failed to define collections: ${e.message}`
+      };
+    }
+    return {
+      status: "success",
+      content: "Defined collections successfully in one transaction."
+    };
+  }
+});

package/dist/ai/tools/getCollectionMetadata.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.
+ */
+declare const _default: import("@nocobase/ai").ToolsOptions;
+export default _default;

package/dist/ai/tools/getCollectionMetadata.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 __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 getCollectionMetadata_exports = {};
+__export(getCollectionMetadata_exports, {
+  default: () => getCollectionMetadata_default
+});
+module.exports = __toCommonJS(getCollectionMetadata_exports);
+var import_ai = require("@nocobase/ai");
+var import_package = __toESM(require("../../../package.json"));
+var getCollectionMetadata_default = (0, import_ai.defineTools)({
+  scope: "GENERAL",
+  defaultPermission: "ALLOW",
+  introduction: {
+    title: `{{t("ai.tools.getCollectionMetadata.title", { ns: "${import_package.default.name}" })}}`,
+    about: `{{t("ai.tools.getCollectionMetadata.about", { ns: "${import_package.default.name}" })}}`
+  },
+  definition: {
+    name: "getCollectionMetadata",
+    description: "Retrieve metadata for specified collections and their fields",
+    schema: {
+      type: "object",
+      properties: {
+        dataSource: {
+          type: "string",
+          description: 'The data source name. Defaults to "main".'
+        },
+        collectionNames: {
+          type: "array",
+          items: {
+            type: "string"
+          },
+          description: "An array of collection names to retrieve metadata for."
+        }
+      },
+      required: ["collectionNames"],
+      additionalProperties: false
+    }
+  },
+  invoke: async (ctx, args) => {
+    const { collectionNames, dataSource = "main" } = args || {};
+    if (!collectionNames || !Array.isArray(collectionNames) || collectionNames.length === 0) {
+      return {
+        status: "error",
+        content: "No collection names provided or invalid format."
+      };
+    }
+    try {
+      const ds = ctx.app.dataSourceManager.dataSources.get(dataSource);
+      if (!ds) {
+        return {
+          status: "error",
+          content: `Data source "${dataSource}" not found`
+        };
+      }
+      const metadata = [];
+      for (const name of collectionNames) {
+        const collection = ds.collectionManager.getCollection(name);
+        if (!collection) continue;
+        const fields = collection.getFields().map((field) => {
+          return {
+            name: field.name,
+            type: field.type,
+            interface: field.options.interface,
+            options: field.options || {}
+          };
+        });
+        metadata.push({
+          name: collection.name,
+          title: collection.title,
+          fields
+        });
+      }
+      return {
+        status: "success",
+        content: JSON.stringify(metadata)
+      };
+    } catch (err) {
+      return {
+        status: "error",
+        content: `Failed to retrieve metadata: ${err.message}`
+      };
+    }
+  }
+});

package/dist/ai/tools/getCollectionNames.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.
+ */
+declare const _default: import("@nocobase/ai").ToolsOptions;
+export default _default;

package/dist/ai/tools/getCollectionNames.js

@@ -0,0 +1,95 @@
+/**
+ * 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 getCollectionNames_exports = {};
+__export(getCollectionNames_exports, {
+  default: () => getCollectionNames_default
+});
+module.exports = __toCommonJS(getCollectionNames_exports);
+var import_ai = require("@nocobase/ai");
+var import_package = __toESM(require("../../../package.json"));
+var getCollectionNames_default = (0, import_ai.defineTools)({
+  scope: "GENERAL",
+  defaultPermission: "ALLOW",
+  introduction: {
+    title: `{{t("ai.tools.getCollectionNames.title", { ns: "${import_package.default.name}" })}}`,
+    about: `{{t("ai.tools.getCollectionNames.about", { ns: "${import_package.default.name}" })}}`
+  },
+  definition: {
+    name: "getCollectionNames",
+    description: "Retrieve names and titles map of all collections",
+    schema: {
+      type: "object",
+      properties: {
+        dataSource: {
+          type: "string",
+          description: 'The data source name to retrieve collections from. Defaults to "main".'
+        }
+      },
+      additionalProperties: false
+    }
+  },
+  invoke: async (ctx, args) => {
+    const { dataSource = "main" } = args || {};
+    let names = [];
+    try {
+      const ds = ctx.app.dataSourceManager.dataSources.get(dataSource);
+      if (!ds) {
+        throw new Error(`Data source "${dataSource}" not found`);
+      }
+      const collections = ds.collectionManager.getCollections();
+      names = collections.map((collection) => ({
+        name: collection.name,
+        title: collection.title
+      }));
+    } catch (err) {
+      ctx.log.error(err, {
+        module: "ai",
+        subModule: "toolCalling",
+        groupName: "dataModeling",
+        toolName: "getCollectionNames"
+      });
+      return {
+        status: "error",
+        content: `Failed to retrieve collection names: ${err.message}`
+      };
+    }
+    return {
+      status: "success",
+      content: JSON.stringify(names)
+    };
+  }
+});

package/dist/ai/tools/getDataSources.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.
+ */
+declare const _default: import("@nocobase/ai").ToolsOptions;
+export default _default;

package/dist/ai/tools/getDataSources.js

@@ -0,0 +1,84 @@
+/**
+ * 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 getDataSources_exports = {};
+__export(getDataSources_exports, {
+  default: () => getDataSources_default
+});
+module.exports = __toCommonJS(getDataSources_exports);
+var import_ai = require("@nocobase/ai");
+var import_package = __toESM(require("../../../package.json"));
+var getDataSources_default = (0, import_ai.defineTools)({
+  scope: "GENERAL",
+  defaultPermission: "ALLOW",
+  introduction: {
+    title: `{{t("ai.tools.getDataSources.title", { ns: "${import_package.default.name}" })}}`,
+    about: `{{t("ai.tools.getDataSources.about", { ns: "${import_package.default.name}" })}}`
+  },
+  definition: {
+    name: "getDataSources",
+    description: "Retrieve list of all available data sources",
+    schema: {
+      type: "object",
+      properties: {},
+      additionalProperties: false
+    }
+  },
+  invoke: async (ctx) => {
+    var _a, _b, _c;
+    try {
+      const records = await ctx.db.getRepository("dataSources").find();
+      const displayNameMap = new Map(records.map((r) => [r.get("key"), r.get("displayName")]));
+      const dataSources = [];
+      for (const [key, ds] of ctx.app.dataSourceManager.dataSources) {
+        dataSources.push({
+          key,
+          displayName: displayNameMap.get(key) || key,
+          type: ((_c = (_b = (_a = ds.collectionManager) == null ? void 0 : _a.db) == null ? void 0 : _b.sequelize) == null ? void 0 : _c.getDialect()) || "unknown"
+        });
+      }
+      return {
+        status: "success",
+        content: JSON.stringify(dataSources)
+      };
+    } catch (err) {
+      return {
+        status: "error",
+        content: `Failed to retrieve data sources: ${err.message}`
+      };
+    }
+  }
+});

package/dist/ai/tools/intentRouter.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.
+ */
+declare const _default: import("@nocobase/ai").ToolsOptions;
+export default _default;