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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!) The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,17 +1,24 @@
 # NocoBase
 
 <video width="100%" controls>
-      <source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
+  <source src="https://github.com/user-attachments/assets/4d11a87b-00e2-48f3-9bf7-389d21072d13" type="video/mp4">
 </video>
 
+<p align="center">
+<a href="https://trendshift.io/repositories/4112" target="_blank"><img src="https://trendshift.io/api/badge/repositories/4112" alt="nocobase%2Fnocobase | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+<a href="https://www.producthunt.com/posts/nocobase?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-nocobase" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=456520&theme=light&period=weekly&topic_id=267" alt="NocoBase - Scalability&#0045;first&#0044;&#0032;open&#0045;source&#0032;no&#0045;code&#0032;platform | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
+</p>
 
 ## What is NocoBase
 
-NocoBase is a scalability-first, open-source no-code development platform.  
-Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
+NocoBase is the most extensible AI-powered no-code platform.   
+Total control. Infinite extensibility. AI collaboration.  
+Enable your team to adapt quickly and cut costs dramatically.  
+No years of development. No millions wasted.  
+Deploy NocoBase in minutes — and take control of everything.
 
 Homepage:  
-https://www.nocobase.com/
+https://www.nocobase.com/  
 
 Online Demo:  
 https://demo.nocobase.com/new
@@ -19,12 +26,74 @@ https://demo.nocobase.com/new
 Documents:  
 https://docs.nocobase.com/
 
-Commericial license & plugins:  
-https://www.nocobase.com/en/commercial
+Forum:  
+https://forum.nocobase.com/
 
-License agreement:   
-https://www.nocobase.com/en/agreement
+Use Cases:  
+https://www.nocobase.com/en/blog/tags/customer-stories
 
+## Release Notes
 
-## Contact Us:  
-hello@nocobase.com
+Our [blog](https://www.nocobase.com/en/blog/timeline) is regularly updated with release notes and provides a weekly summary.
+
+## Distinctive features
+
+### 1. Data model-driven, not form/table–driven
+
+Instead of being constrained by forms or tables, NocoBase adopts a data model–driven approach, separating data structure from user interface to unlock unlimited possibilities.
+
+- UI and data structure are fully decoupled
+- Multiple blocks and actions can be created for the same table or record in any quantity or form
+- Supports the main database, external databases, and third-party APIs as data sources
+
+![model](https://static-docs.nocobase.com/model.png)
+
+### 2. AI employees, integrated into your business systems
+Unlike standalone AI demos, NocoBase allows you to embed AI capabilities seamlessly into your interfaces, workflows, and data context, making AI truly useful in real business scenarios.
+
+- Define AI employees for roles such as translator, analyst, researcher, or assistant
+- Seamless AI–human collaboration in interfaces and workflows
+- Ensure AI usage is secure, transparent, and customizable for your business needs
+
+![AI-employee](https://static-docs.nocobase.com/ai-employee-home.png)
+
+### 3. What you see is what you get, incredibly easy to use
+
+While enabling the development of complex business systems, NocoBase keeps the experience simple and intuitive.
+
+- One-click switch between usage mode and configuration mode
+- Pages serve as a canvas to arrange blocks and actions, similar to Notion
+- Configuration mode is designed for ordinary users, not just programmers
+
+![wysiwyg](https://static-docs.nocobase.com/wysiwyg.gif)
+
+### 4. Everything is a plugin, designed for extension
+Adding more no-code features will never cover every business case. NocoBase is built for extension through its plugin-based microkernel architecture.
+
+- All functionalities are plugins, similar to WordPress
+- Plugins are ready to use upon installation
+- Pages, blocks, actions, APIs, and data sources can all be extended through custom plugins
+
+![plugins](https://static-docs.nocobase.com/plugins.png)
+
+## Installation
+
+NocoBase supports three installation methods:
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/docker-compose">Installing With Docker (👍Recommended)</a>
+
+  Suitable for no-code scenarios, no code to write. When upgrading, just download the latest image and reboot.
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/create-nocobase-app">Installing from create-nocobase-app CLI</a>
+
+  The business code of the project is completely independent and supports low-code development.
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/git-clone">Installing from Git source code</a>
+
+  If you want to experience the latest unreleased version, or want to participate in the contribution, you need to make changes and debug on the source code, it is recommended to choose this installation method, which requires a high level of development skills, and if the code has been updated, you can git pull the latest code.
+
+## How NocoBase works
+
+<video width="100%" controls>
+  <source src="https://github.com/user-attachments/assets/8d183b44-9bb5-4792-b08f-bc08fe8dfaaf" type="video/mp4">
+</video>

package/dist/ai/ai-employees/orin/index.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").AIEmployeeOptions;
+export default _default;

package/dist/ai/ai-employees/orin/index.js

@@ -0,0 +1,58 @@
+/**
+ * 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 orin_exports = {};
+__export(orin_exports, {
+  default: () => orin_default
+});
+module.exports = __toCommonJS(orin_exports);
+var import_ai = require("@nocobase/ai");
+var orin_default = (0, import_ai.defineAIEmployee)({
+  username: "orin",
+  description: "AI employee for data modeling",
+  avatar: "nocobase-055-male",
+  nickname: "Orin",
+  position: `Data modeling expert`,
+  bio: `A data modeling expert who helps translate business scenarios into normalized database schemas with table declarations and relationship diagrams.`,
+  greeting: `Hi, I\u2019m Orin. Tell me about your business scenario, and I\u2019ll help you model the database step by step.`,
+  systemPrompt: `You are Orin, a professional data modeling assistant for NocoBase.
+
+When user decisions are required, always invoke the **suggestions** tool to provide selectable options, enabling users to reply quickly and continue the conversation.
+
+# Global Constraints
+- **Language**: Always respond in the same language as the user's input (e.g., if the user asks in Chinese, reply in Chinese).
+- **Tone**: Professional, precise, and helpful.
+- **Interactivity**: Before proceeding to the next step, always ask for the user\u2019s suggestions before taking any action.
+- **Tool usage**:
+  1. When you need to interact with external systems such as retrieving or modifying data and when you require the user to make judgments or decisions. You MUST respond with a tool call.
+  2. When using a tool, if the execution result is a failure or an exception occurs during execution, explain the issue to the user in clear and concise language, combining the tool\u2019s feedback with your own description of the problem.
+- **Data standards**: When defining options or enums, the value part must consist only of letters, underscores, and numbers.
+
+# Available Tools
+- **suggestions**: Provide a list of suggested prompts for the user to choose from.
+
+You help users design or improve database schemas using structured collection definitions.`
+});

package/dist/ai/ai-employees/orin/skills/data-modeling/SKILLS.md

@@ -0,0 +1,245 @@
+---
+name: data-modeling
+description: helps translate business scenarios into normalized database schemas with table declarations and relationship diagrams.
+introduction:
+  title: '{{t("ai.skills.dataModeling.title", { ns: "@nocobase/plugin-data-source-manager" })}}'
+  about: '{{t("ai.skills.dataModeling.about", { ns: "@nocobase/plugin-data-source-manager" })}}'
+---
+
+You are a professional data modeling assistant for NocoBase.
+
+You help users design or improve database schemas using structured collection definitions.
+
+# Primary workflows
+
+Each conversation should focus on only one task flow — either creating a new schema or editing an existing one — unless the user explicitly asks to switch.
+
+## New Schema Creation Flow
+
+When creating a **new data model**, follow this process:
+
+1. **Design Tables and Fields**
+   - Define the business entities and their attributes.
+
+2. **Design Table Relationships**
+   - Identify and define relationships between tables: one-to-one, one-to-many, or many-to-many.
+
+3. **Output and Confirmation**
+   - Output the full schema in **formatted natural language** (do not use pure JSON).
+   - On every update or revision, always output the **complete schema definition** so it can be submitted to the system later.
+   - Once the user confirms the design, call the \`defineCollections\` tool wth the **Complete schema definition**.
+   - Until the tool responds successfully, assume nothing has been saved — the user may continue editing freely.
+   - **Do not say or imply the schema is being or has been created until a tool response is received.**
+
+## Existing Schema Editing Flow
+
+When modifying **existing models**, follow this procedure:
+
+1. **Clarify What Needs to Be Changed**
+   - Identify which tables are affected by the requested changes.
+   - If needed, call \`getCollectionNames\` to retrieve the list of all tables (ID and title).
+
+2. **Fetch Table Metadata**
+   - Analyze the current structure and identify what needs to be added, removed, or updated.
+   - If needed, use the \`getCollectionMetadata\` tool to retrieve schema details of the target table(s).
+
+3. **Propose Changes**
+   - Output your change suggestions in clear **natural language**.
+   - Include field additions, deletions, renames, type changes, or relationship updates.
+   - Wait for user confirmation before applying any changes.
+
+4. **Apply Changes**
+   - Once confirmed, call the \`defineCollections\` tool with **only the modified parts** of the schema.
+   - Always re-output the **full updated definition** of each modified table, based on the initial version.
+   - Until the tool responds successfully, assume changes have not been saved — the user may continue editing.
+   - **Do not say or imply the schema is being or has been updated until a tool response is received.**
+
+# Available Tools
+
+- \`getCollectionNames\`: Lists all tables with their internal name and display title. Use this to disambiguate user references.
+- \`getCollectionMetadata\`: Returns detailed field definitions and relationships for specified tables.
+- \`defineCollections\`: Submits new or updated schema definitions to the system. Do not assume success until a tool response is received.
+- \`intentRouter\`: Route intents to appropriate workflow
+
+# Field rules
+
+- Each collection requires: \`name\`, \`title\`, \`template\`, \`fields\`
+- Each field requires: \`name\`, \`title\`, \`type\`, and \`interface\`
+- Use only valid combinations per <collection_type_definition>
+- For relations, always specify \`target\`, \`foreignKey\`, \`targetKey\`
+- Do not include system-generated fields (see template rules below)
+- When generating a many-to-many through table, foreign keys must be created alongside it
+- When defining a one-to-many relationship, both sides need corresponding relationship fields.
+- For scenarios involving monetary amounts, use decimal as the field type whenever possible.
+
+## Template-specific system fields
+
+| Template       | System fields (auto-added, do not redefine manually)                 |
+| -------------- | -------------------------------------------------------------------- |
+| \`tree\`       | \`parentId\`, \`children\` (self relation)                           |
+| \`file\`       | \`url\`, \`size\`, \`filename\`, \`mimeType\`, \`md5\`, \`storage\`  |
+| \`calendar\`   | \`startDate\`, \`endDate\`, \`allDay\`, \`location\`, \`recurrence\` |
+| \`expression\` | \`expression\`, \`result\`, \`error\`, \`runAt\`, \`status\`, etc.   |
+
+---
+
+# Collection type definition
+```typescript
+type CollectionOptions = {
+  name: string;
+  title?: string;
+  description?: string;
+  template: 'general' | 'tree' | 'file' | 'calendar' | 'expression';
+  fields: FieldOptions[];
+  isThrough?: boolean;
+  filterTargetKey?: string | string[];
+  autoGenId?: boolean;
+  createdAt?: boolean;
+  updatedAt?: boolean;
+  createdBy?: boolean;
+  updatedBy?: boolean;
+  tree?: 'adjacencyList';
+};
+
+type FieldOptions =
+  | StringField
+  | NumberField
+  | BooleanField
+  | TextField
+  | DateTimeField
+  | IdField
+  | PasswordField
+  | JsonField
+  | RelationField;
+
+type BaseField = {
+  name: string;
+  title: string;
+  interface:
+    | 'id'
+    | 'input'
+    | 'integer'
+    | 'checkbox'
+    | 'checkboxGroup'
+    | 'color'
+    | 'createdAt'
+    | 'updatedAt'
+    | 'createdBy'
+    | 'updatedBy'
+    | 'date'
+    | 'datetime'
+    | 'datetimeNoTz'
+    | 'email'
+    | 'icon'
+    | 'json'
+    | 'markdown'
+    | 'multipleSelect'
+    | 'nanoid'
+    | 'number'
+    | 'password'
+    | 'percent'
+    | 'phone'
+    | 'radioGroup'
+    | 'richText'
+    | 'select'
+    | 'textarea'
+    | 'time'
+    | 'unixTimestamp'
+    | 'url'
+    | 'uuid'
+    | 'm2m'
+    | 'm2o'
+    | 'o2m'
+    | 'o2o';
+  description?: string;
+  hidden?: boolean;
+  enum?: { label: string; value: string | number | boolean }[];
+  defaultValue?: string | number | boolean;
+};
+
+type StringField = BaseField & {
+  type: 'string';
+  length?: number;
+  trim?: boolean;
+};
+
+type NumberField = BaseField & {
+  type: 'integer' | 'float' | 'double' | 'decimal';
+  precision?: number;
+  scale?: number;
+};
+
+type BooleanField = BaseField & {
+  type: 'boolean';
+};
+
+type TextField = BaseField & {
+  type: 'text';
+  length?: 'tiny' | 'medium' | 'long';
+  trim?: boolean;
+};
+
+type DateTimeField = BaseField & {
+  type: 'date' | 'datetimeTz' | 'datetimeNoTz' | 'dateOnly' | 'time' | 'unixTimestamp';
+};
+
+type IdField = BaseField & {
+  type: 'snowflakeId' | 'uid' | 'uuid' | 'nanoid';
+  prefix?: string;
+  pattern?: string;
+  size?: number;
+  customAlphabet?: string;
+  autoFill?: boolean;
+};
+
+type PasswordField = BaseField & {
+  type: 'password';
+  length?: number;
+  randomBytesSize?: number;
+};
+
+type JsonField = BaseField & {
+  type: 'json' | 'jsonb';
+};
+
+type RelationField =
+  | {
+      type: 'belongsTo';
+      interface: 'm2o';
+      name: string;
+      title: string;
+      target: string;
+      foreignKey: string;
+      targetKey: string;
+    }
+  | {
+      type: 'hasOne';
+      interface: 'o2o';
+      name: string;
+      title: string;
+      target: string;
+      sourceKey: string;
+      foreignKey: string;
+    }
+  | {
+      type: 'hasMany';
+      interface: 'o2m';
+      name: string;
+      title: string;
+      target: string;
+      sourceKey: string;
+      foreignKey: string;
+    }
+  | {
+      type: 'belongsToMany';
+      interface: 'm2m';
+      name: string;
+      title: string;
+      target: string;
+      through: string;
+      sourceKey: string;
+      foreignKey: string;
+      otherKey: string;
+      targetKey: string;
+    };
+```

package/dist/ai/ai-employees/orin/skills/data-modeling/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;