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

package/dist/ai/tools/data-query/common.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { z } from 'zod';
+export declare const ArgSchema: z.ZodObject<{
+    datasource: z.ZodString;
+    collectionName: z.ZodString;
+    fields: z.ZodArray<z.ZodString>;
+    appends: z.ZodArray<z.ZodString>;
+    filter: z.ZodObject<{}, z.core.$catchall<z.ZodAny>>;
+    sort: z.ZodArray<z.ZodString>;
+    offset: z.ZodOptional<z.ZodNumber>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type ArgType = z.infer<typeof ArgSchema>;

package/dist/ai/tools/data-query/common.js

@@ -0,0 +1,110 @@
+/**
+ * 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 common_exports = {};
+__export(common_exports, {
+  ArgSchema: () => ArgSchema
+});
+module.exports = __toCommonJS(common_exports);
+var import_zod = require("zod");
+var import_package = __toESM(require("../../../../package.json"));
+const ArgSchema = import_zod.z.object({
+  datasource: import_zod.z.string().describe(`{{t("ai.tools.dataQuery.args.datasource", { ns: "${import_package.default.name}" })}}`),
+  collectionName: import_zod.z.string().describe(`{{t("ai.tools.dataQuery.args.collectionName", { ns: "${import_package.default.name}" })}}`),
+  fields: import_zod.z.array(import_zod.z.string()).describe(`{{t("ai.tools.dataQuery.args.fields", { ns: "${import_package.default.name}" })}}`),
+  appends: import_zod.z.array(import_zod.z.string()).describe(`{{t("ai.tools.dataQuery.args.appends", { ns: "${import_package.default.name}" })}}`),
+  filter: import_zod.z.object({}).catchall(import_zod.z.any()).describe(`# Parameters definition
+\`\`\`
+export type QueryCondition = {
+  [field: string]: { // \`field\` key is Field name
+    [operator: string]: any; // \`operator\` key is Query condition operator.
+  };
+};
+
+
+export type QueryObject =
+  | {
+      [logic: string]: (QueryCondition | QueryObject)[]; // \`logic\` key is the relationship between query conditions, should be one of '$and', '$or', the value is recursion object array, item in array can be QueryCondition or QueryObject
+    }
+  | QueryCondition // QueryCondition definition above;
+\`\`\`
+
+
+// QueryCondition examples
+
+\`\`\`
+const example1: QueryCondition = {
+  age: { $gt: 18 },          // age great than 18
+  name: { $like: '%John%' }, // name include John
+};
+
+const example2: QueryCondition = {
+  status: { $in: ['active', 'pending'] }, // status is active or pending
+};
+\`\`\`
+
+// QueryObject example
+\`\`\`
+const example1: QueryObject = {
+  $and: [
+    { age: { $gt: 18 } },
+    { status: { $eq: 'active' } }
+  ]
+};
+
+const example2: QueryObject = {
+  $or: [
+    { name: { $like: '%John%' } },
+    {
+      $and: [
+        { age: { $gte: 30 } },
+        { status: { $eq: 'pending' } }
+      ]
+    }
+  ]
+};
+
+const example3: QueryObject = { age: { $lt: 50 } };
+\`\`\`
+`),
+  sort: import_zod.z.array(import_zod.z.string()).describe(`{{t("ai.tools.dataQuery.args.sort", { ns: "${import_package.default.name}" })}}`),
+  offset: import_zod.z.number().optional().describe(`{{t("ai.tools.dataQuery.args.offset", { ns: "${import_package.default.name}" })}}`),
+  limit: import_zod.z.number().optional().describe(`{{t("ai.tools.dataQuery.args.limit", { ns: "${import_package.default.name}" })}}`)
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ArgSchema
+});

package/dist/ai/tools/data-query/dataSourceCounting.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/data-query/dataSourceCounting.js

@@ -0,0 +1,65 @@
+/**
+ * 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 dataSourceCounting_exports = {};
+__export(dataSourceCounting_exports, {
+  default: () => dataSourceCounting_default
+});
+module.exports = __toCommonJS(dataSourceCounting_exports);
+var import_ai = require("@nocobase/ai");
+var import_common = require("./common");
+var import_package = __toESM(require("../../../../package.json"));
+var dataSourceCounting_default = (0, import_ai.defineTools)({
+  scope: "GENERAL",
+  defaultPermission: "ALLOW",
+  introduction: {
+    title: `{{t("ai.tools.dataSourceCounting.title", { ns: "${import_package.default.name}" })}}`,
+    about: `{{t("ai.tools.dataSourceCounting.about", { ns: "${import_package.default.name}" })}}`
+  },
+  definition: {
+    name: "dataSourceCounting",
+    description: "Use dataSource, collectionName, and collection fields to query data from the database, get total count of records",
+    schema: import_common.ArgSchema
+  },
+  invoke: async (ctx, args) => {
+    const plugin = ctx.app.pm.get("ai");
+    const content = await plugin.aiContextDatasourceManager.query(ctx, { ...args, offset: 0, limit: 1 });
+    return {
+      status: "success",
+      content: String((content == null ? void 0 : content.total) ?? 0)
+    };
+  }
+});

package/dist/ai/tools/data-query/dataSourceQuery.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/data-query/dataSourceQuery.js

@@ -0,0 +1,77 @@
+/**
+ * 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 dataSourceQuery_exports = {};
+__export(dataSourceQuery_exports, {
+  default: () => dataSourceQuery_default
+});
+module.exports = __toCommonJS(dataSourceQuery_exports);
+var import_ai = require("@nocobase/ai");
+var import_common = require("./common");
+var import_utils = require("./utils");
+var import_package = __toESM(require("../../../../package.json"));
+var dataSourceQuery_default = (0, import_ai.defineTools)({
+  scope: "GENERAL",
+  defaultPermission: "ALLOW",
+  introduction: {
+    title: `{{t("ai.tools.dataSourceQuery.title", { ns: "${import_package.default.name}" })}}`,
+    about: `{{t("ai.tools.dataSourceQuery.about", { ns: "${import_package.default.name}" })}}`
+  },
+  definition: {
+    name: "dataSourceQuery",
+    description: "Use dataSource, collectionName, and collection fields to query data from the database",
+    schema: import_common.ArgSchema
+  },
+  invoke: async (ctx, args) => {
+    const plugin = ctx.app.pm.get("ai");
+    const { limit, offset } = (0, import_utils.normalizeLimitOffset)(args, { defaultLimit: 50, maxLimit: import_utils.MAX_QUERY_LIMIT });
+    const content = await plugin.aiContextDatasourceManager.query(ctx, {
+      ...args,
+      limit,
+      offset
+    });
+    const records = (0, import_utils.truncateLongStrings)((content == null ? void 0 : content.records) || []);
+    const total = (content == null ? void 0 : content.total) || 0;
+    const result = (0, import_utils.buildPagedToolResult)({ total, offset, limit, records });
+    if (result.hasMore) {
+      result.note = `Showing ${result.returned} of ${result.total} records. To fetch more, call this tool again with offset:${result.nextOffset}`;
+    }
+    return {
+      status: "success",
+      content: JSON.stringify(result)
+    };
+  }
+});

package/dist/ai/tools/data-query/utils.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 declare const MAX_STRING_LENGTH = 500;
+/** 单次查询最大记录数 */
+export declare const MAX_QUERY_LIMIT = 100;
+export declare function normalizeLimitOffset(args: {
+    limit?: unknown;
+    offset?: unknown;
+}, options?: {
+    defaultLimit?: number;
+    maxLimit?: number;
+}): {
+    limit: number;
+    offset: number;
+};
+export declare function buildPagedToolResult<T>(params: {
+    total: number;
+    offset: number;
+    limit: number;
+    records: T[];
+}): {
+    total: number;
+    offset: number;
+    limit: number;
+    returned: number;
+    hasMore: boolean;
+    nextOffset: number;
+    records: T[];
+};
+/**
+ * 递归截断对象中的长字符串，保持 JSON 结构完整
+ */
+export declare function truncateLongStrings(obj: any, maxLen?: number): any;

package/dist/ai/tools/data-query/utils.js

@@ -0,0 +1,87 @@
+/**
+ * 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 utils_exports = {};
+__export(utils_exports, {
+  MAX_QUERY_LIMIT: () => MAX_QUERY_LIMIT,
+  MAX_STRING_LENGTH: () => MAX_STRING_LENGTH,
+  buildPagedToolResult: () => buildPagedToolResult,
+  normalizeLimitOffset: () => normalizeLimitOffset,
+  truncateLongStrings: () => truncateLongStrings
+});
+module.exports = __toCommonJS(utils_exports);
+const MAX_STRING_LENGTH = 500;
+const MAX_QUERY_LIMIT = 100;
+function normalizeLimitOffset(args, options) {
+  const defaultLimit = (options == null ? void 0 : options.defaultLimit) ?? 50;
+  const maxLimit = (options == null ? void 0 : options.maxLimit) ?? MAX_QUERY_LIMIT;
+  const rawLimit = typeof args.limit === "number" && Number.isFinite(args.limit) ? args.limit : void 0;
+  const rawOffset = typeof args.offset === "number" && Number.isFinite(args.offset) ? args.offset : void 0;
+  const limit = Math.min(Math.max(rawLimit ?? defaultLimit, 1), maxLimit);
+  const offset = Math.max(rawOffset ?? 0, 0);
+  return { limit, offset };
+}
+function buildPagedToolResult(params) {
+  const returned = params.records.length;
+  const nextOffset = params.offset + returned;
+  const hasMore = params.total > nextOffset;
+  return {
+    total: params.total,
+    offset: params.offset,
+    limit: params.limit,
+    returned,
+    hasMore,
+    nextOffset,
+    records: params.records
+  };
+}
+function truncateLongStrings(obj, maxLen = MAX_STRING_LENGTH) {
+  if (obj === null || obj === void 0) {
+    return obj;
+  }
+  if (typeof obj === "string") {
+    return obj.length > maxLen ? obj.slice(0, maxLen) + "...[truncated]" : obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj.map((item) => truncateLongStrings(item, maxLen));
+  }
+  if (typeof obj === "object") {
+    const result = {};
+    for (const key in obj) {
+      result[key] = truncateLongStrings(obj[key], maxLen);
+    }
+    return result;
+  }
+  return obj;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MAX_QUERY_LIMIT,
+  MAX_STRING_LENGTH,
+  buildPagedToolResult,
+  normalizeLimitOffset,
+  truncateLongStrings
+});

package/dist/ai/tools/defineCollections.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;