@nocobase/plugin-ai 2.2.0-beta.8 → 2.3.0-alpha.1

package/client-v2.d.ts

@@ -1 +1,2 @@
 export * from './dist/client-v2';
+export { default } from './dist/client-v2';

package/dist/ai/docs/nocobase/ai-employees/scenarios/company-background-research.md

@@ -0,0 +1,125 @@
+---
+title: "Workflow + AI for employees to complete company background research automation"
+description: "Through company information forms, background investigation records, workflows, and AI employees, a company background investigation process can be automatically triggered, retained, and supported for manual review."
+keywords: "NocoBase, AI employees, workflow, company background research, due diligence, automation, business practice"
+---
+
+# Workflow + AI for employees to complete company background research automation
+
+In NocoBase, you can turn company background research into a trackable automated task flow. Business staff still work in the familiar company information page, while workflow and AI staff are responsible for completing background information, recording the processing process, and saving each generated report.
+
+![](https://static-docs.nocobase.com/202607121806356.png)
+
+This scenario is suitable for dealing with a common problem: company background information is not a static field that ends after being entered once. Public information will change, regulatory events will occur, and the status of cooperation will be constantly adjusted as business progresses. If you only rely on manual supplementary recording on a regular basis, it will be easy to miss; if you directly let AI cover company information, it will be difficult to explain "how this judgment came about." The approach here is to separate and save the current data and the research process - the company record saves the version being used by the business personnel, and the background check record saves the status, output and history of each AI survey.
+
+## Let’s look at the two tables first
+
+The company information form provides the basic information of the research object, and the background investigation record form is responsible for undertaking each research task. One saves the currently available information, and the other saves the processing process and historical results.
+
+### `companies`: Company information table
+
+| Core fields               | effect                                                           |
+| ---------------------- | -------------------------------------------------------------- |
+| Company name           | The main identifying information of the research object.                                   |
+| Website                | Provide official website clues to reduce misjudgments caused by companies with the same name or abbreviation.                   |
+| Address                | Assist in determining regions, entities and business scope.                                 |
+| Company type           | Mark business relationships such as customers, suppliers, partners, etc. to facilitate subsequent judgment and follow-up priorities. |
+| Background information | Save the company background report you are currently using and use Markdown to render structured content. |
+
+### `background_check_tasks`: Background check record form
+
+| Core fields                  | effect                                                                               |
+| ------------------------- | ---------------------------------------------------------------------------------- |
+| Company ID / Company name | Record which company this survey is for to facilitate task execution and historical review.                                 |
+| Status                    | The flow of marking tasks from `pending` to `processing` and `completed` is also the basis for preventing repeated triggering. |
+| Research report           | Save the complete research report generated by AI this time.                                                   |
+| Summary                   | Save AI's summary of the research process, risk points, and information to be supplemented.                                     |
+| Previous background       | Save the old version before writing back, supporting historical tracking and comparison of old and new reports.                                   |
+
+![](https://static-docs.nocobase.com/202607121807627.png)
+
+## Enter the research process from company information
+
+The company list is the most familiar entrance for business people. You can see the company name, official website, company type, contact person, email and other information on the page. After entering a company, business personnel can view the current background report or initiate a new background investigation.
+
+After entering the editing page, "Background information" is displayed using the Markdown editing component. The AI-generated content is not a short summary, but a structured report that can be read, copied, and continued to be maintained. Business personnel can still modify it manually, but each result generated by AI will leave a corresponding history in the background check record.
+
+![](https://static-docs.nocobase.com/202607121807450.png)
+
+In this way, the page still looks like an ordinary company data maintenance interface, and the underlying processing method has become "current data + research history". The company table saves the current version, and the task table saves the process and evidence chain.
+
+## Three triggering methods
+
+![](https://static-docs.nocobase.com/202607121807495.png)
+
+Background research shouldn’t just rely on a manual button. In real business, you may want to automatically complete the information after adding a new company, you may also need to make up historical records regularly, and you may also take the initiative to re-investigate before signing a contract or reviewing.
+
+The `New company background check` workflow handles automatic research after adding or updating a company. It listens to the data events of the company table and is triggered when the company name exists and the background information is empty. The AI ​​will not be called immediately after triggering, but will first check whether there are any unfinished tasks for the same company; if not, a new background check record will be created.
+
+![](https://static-docs.nocobase.com/202607121807374.png)
+
+The `Timing company background check` workflow is responsible for the continuous completion of historical data. It runs every 30 minutes, queries companies whose background information is still empty, and loops through batches. Inside the loop, we also check whether the task already exists, and then decide whether to create a new task. In this way, the scheduled task can be run repeatedly without creating multiple concurrently processed records due to repeated scanning.
+
+![](https://static-docs.nocobase.com/202607121807404.png)
+
+The `Manual company background check` workflow is bound to the "Run background check" button on the company details page, which is suitable for business personnel to proactively initiate a survey before visiting, signing a contract, or reviewing. Manual triggering and automatic triggering use the same set of follow-up links: a background check record is created first, and then the task execution workflow takes over the AI ​​investigation.
+
+![](https://static-docs.nocobase.com/202607121807793.png)
+
+These three entrances solve problems at different points in time, and are ultimately merged into the same background investigation record form. New triggers, scheduled triggers, and manual triggers are only responsible for recording the "need to investigate", and the specific execution, status management, and result writing back are handed over to subsequent workflows for unified processing.
+
+## Turn AI research into tasks
+
+`Do company background check` is the workflow that actually performs research. It listens for the `pending` record in the background check record table. Once the previous automatic, scheduled or manual process creates a task, this workflow will be triggered asynchronously.
+
+When executed, the workflow first queries whether the company still exists. If the company does not exist, the task will be closed and the description will be written; if the company exists, the task status will be switched to `processing`, and then the AI ​​employee will be called to generate the report. The prompt word of the AI ​​employee requires the output of two parts: a Markdown report that can be written directly into the company background field, and a summary for manual review.
+
+![](https://static-docs.nocobase.com/202607121808833.png)
+
+After AI returns structured results, the workflow first writes the report, summary, and old background content into the background check record, and then writes the new report back to the company record. This order avoids the problem of "only the latest results, no process records": the company page keeps the latest available content, and the task records retain the context before this generation and writing back.
+
+![](https://static-docs.nocobase.com/202607121808662.png)
+
+After tasking, batch processing will also become more natural. The scheduled workflow does not need to wait for each company's research to be completed, but is only responsible for creating multiple records to be processed; each record independently triggers the AI ​​survey. Multiple companies can advance in parallel, and if a certain task fails or times out, other companies will not be blocked.
+
+## Make AI results reviewable
+
+AI-generated reports are organized according to a fixed structure: company profile, core business, development history and capital background, market position and competitive perspective, sales follow-up judgment, and citation links. Business personnel can see not only the "conclusion", but also the risk tips and additional information given by AI in the summary.
+
+The background investigation record details page displays "Research report" and "Previous background" in tabs, and provides a "Copy" operation. In this way, you can quickly copy this report during discussion, review, or external communication, and you can also check changes against the old version.
+
+The record details also configure two AI worker tasks. in:
+
+- Improve the background research report: regenerate the report after adding information through dialogue, and write the results back to the company records
+- Compare the old and new background research reports: Read the old and new reports and let AI explain the substantial differences brought about by this update
+
+This allows AI not to stop at “generating text once” but to participate in the process of continuous maintenance, review and version comparison.
+
+![](https://static-docs.nocobase.com/202607121808444.png)
+
+## How to combine workflow
+
+Overall, this set of workflows can be divided into four layers.
+
+The first layer is responsible for creating tasks. `New company background check` is for newly added or updated companies, `Timing company background check` is for historical data completion, and `Manual company background check` is for manual initiative. They will all check whether there are any unfinished records before creating a task, reducing duplicate processing from the source.
+
+The second layer is responsible for performing tasks. `Do company background check` listens to the background check record, advances the pending task to processing, calls the AI ​​employee, and writes the report, summary, and company's current background fields upon completion.
+
+The third layer is responsible for providing controlled writeback capabilities to AI employees. As a tool-based workflow, `Update company background` restricts AI to only write specified records according to clear parameters to avoid over-exerting data modification permissions.
+
+The fourth layer is responsible for exception cleaning. `Clean overtime processing background check` runs every 30 minutes to clean up non-completed tasks that have not been completed for more than 15 minutes to avoid long-term processing of tasks after abnormal interruption.
+
+![](https://static-docs.nocobase.com/202607121808799.png)
+
+## What scenarios can be migrated to?
+
+What this scene shows is not an isolated form or a separate AI button, but a combination of several capabilities in NocoBase: the data table is responsible for carrying business objects and historical records, the page is responsible for viewing and triggering by business personnel, the workflow is responsible for scheduling and writing back, and the AI ​​staff is responsible for generating reviewable structured results.
+
+Similar models can be migrated to scenarios such as supplier admission, customer due diligence, contract risk preliminary review, lead quality scoring, public opinion tracking, and preliminary screening of investment and financing targets. As long as there are several requirements in the business such as "data needs to be continuously completed", "AI results need to be left behind" and "historical versions cannot be overwritten", a runnable, trackable and scalable automated process can be built in a similar way.
+
+## Reference documentation
+
+- [NocoBase Workflow](/workflow/)
+- [NocoBase AI Employee](/ai-employees/)
+- [NocoBase Workflow AI Employee Node ](/ai-employees/workflow/nodes/employee/configuration)
+- [NocoBase AI employee customization tool ](/ai-employees/features/tools)

package/dist/ai/docs/nocobase/api/app/env.md

@@ -51,6 +51,33 @@ API_BASE_PATH=/api/
 
 ## API_BASE_URL
 
+## SERVER_REQUEST_WHITELIST
+
+Whitelist for outbound HTTP requests initiated by the server. It applies to server-side requests from features such as workflow request nodes, custom requests, and AI services.
+
+When this variable is not configured, NocoBase still allows `http` / `https` requests to keep existing deployments compatible. However, if the target is a loopback, private, link-local, or metadata address, or if a domain resolves to one of these addresses, the server logs a warning. Future versions may gradually tighten the default behavior. If your deployment needs to access internal services, configure an explicit whitelist in advance.
+
+Supported entries include:
+
+- Exact IPv4 address, such as `192.168.1.10`
+- IPv4 CIDR range, such as `10.0.0.0/8`
+- Exact IPv6 address, such as `::1`
+- IPv6 CIDR range, such as `fc00::/7`
+- Exact domain, such as `api.example.com`
+- Single-level wildcard subdomain, such as `*.example.com`
+
+Use `,` to separate multiple targets:
+
+```bash
+SERVER_REQUEST_WHITELIST=api.example.com,*.trusted.com,10.0.0.0/8,127.0.0.1
+```
+
+:::warning Note
+
+If a domain is configured in the whitelist, the whitelist check uses the host in the request URL. In other words, after `internal.example.com` is configured, it is treated as explicitly allowed even if the domain resolves to `127.0.0.1` or a private address.
+
+:::
+
 ## CLUSTER_MODE
 
 > `v1.6.0+`
@@ -285,4 +312,4 @@ Enabled trace data processors, defaults to `console`. Other values should refer
 
 ```bash
 TELEMETRY_TRACE_PROCESSOR=console
-```
+```

package/dist/ai/docs/nocobase/api/cli/config/delete.md

@@ -1,7 +1,7 @@
 ---
-title: "nb config delete"
-description: "nb config delete command reference: delete an explicitly set CLI configuration item."
-keywords: "nb config delete,NocoBase CLI,delete configuration"
+title: 'nb config delete'
+description: 'nb config delete command reference: delete an explicitly set CLI configuration item.'
+keywords: 'nb config delete,NocoBase CLI,delete configuration'
 ---
 
 # nb config delete
@@ -16,9 +16,9 @@ nb config delete <key>
 
 ## Parameters
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `<key>` | string | Configuration item name. See [`nb config`](./index.md) for supported values |
+| Parameter | Type   | Description                                                                 |
+| --------- | ------ | --------------------------------------------------------------------------- |
+| `<key>`   | string | Configuration item name. See [`nb config`](./index.md) for supported values |
 
 ## Examples
 
@@ -27,6 +27,8 @@ nb config delete locale
 nb config delete update.policy
 nb config delete docker.network
 nb config delete docker.container-prefix
+nb config delete nb-image-registry
+nb config delete nb-image-variant
 nb config delete proxy.nb-cli-root
 nb config delete proxy.upstream-host
 nb config delete proxy.nginx-driver

package/dist/ai/docs/nocobase/api/cli/config/get.md

@@ -1,7 +1,7 @@
 ---
-title: "nb config get"
-description: "nb config get command reference: read the effective value of a CLI configuration item."
-keywords: "nb config get,NocoBase CLI,read configuration"
+title: 'nb config get'
+description: 'nb config get command reference: read the effective value of a CLI configuration item.'
+keywords: 'nb config get,NocoBase CLI,read configuration'
 ---
 
 # nb config get
@@ -16,9 +16,9 @@ nb config get <key>
 
 ## Parameters
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `<key>` | string | Configuration item name. See [`nb config`](./index.md) for supported values |
+| Parameter | Type   | Description                                                                 |
+| --------- | ------ | --------------------------------------------------------------------------- |
+| `<key>`   | string | Configuration item name. See [`nb config`](./index.md) for supported values |
 
 ## Examples
 
@@ -28,6 +28,8 @@ nb config get update.policy
 nb config get license.pkg-url
 nb config get docker.network
 nb config get docker.container-prefix
+nb config get nb-image-registry
+nb config get nb-image-variant
 nb config get proxy.nb-cli-root
 nb config get proxy.upstream-host
 nb config get proxy.nginx-driver

package/dist/ai/docs/nocobase/api/cli/config/index.md

@@ -1,7 +1,7 @@
 ---
-title: "nb config"
-description: "nb config command reference: manage default configuration items for the NocoBase CLI."
-keywords: "nb config,NocoBase CLI,configuration,default configuration"
+title: 'nb config'
+description: 'nb config command reference: manage default configuration items for the NocoBase CLI.'
+keywords: 'nb config,NocoBase CLI,configuration,default configuration'
 ---
 
 # nb config
@@ -10,6 +10,7 @@ Manage default CLI configuration values. The currently supported keys are mainly
 
 - CLI itself: `locale`, `update.policy`, `license.pkg-url`
 - Docker runtime: `docker.network`, `docker.container-prefix`
+- Official NocoBase images: `nb-image-registry`, `nb-image-variant`
 - External executables: `bin.docker`, `bin.caddy`, `bin.git`, `bin.nginx`, `bin.pnpm`, `bin.yarn`
 - Proxy generation: `proxy.nb-cli-root`, `proxy.upstream-host`, `proxy.nginx-driver`, `proxy.caddy-driver`
 
@@ -18,28 +19,32 @@ Most projects only need a few of these keys. In practice, the most common ones a
 - `update.policy`
 - `docker.network`
 - `docker.container-prefix`
+- `nb-image-registry`
+- `nb-image-variant`
 - `bin.nginx` or `bin.caddy`
 - `proxy.nginx-driver` or `proxy.caddy-driver`
 
 ## Common configuration keys
 
-| Key | Default | Description |
-| --- | --- | --- |
-| `locale` | resolved by the current CLI rules | Override the language used by the CLI |
-| `update.policy` | `prompt` | Startup update policy: `prompt`, `auto`, or `off` |
-| `license.pkg-url` | `https://pkg.nocobase.com/` | Override the download URL for commercial extension packages |
-| `docker.network` | `nocobase` | Default network for CLI-managed Docker apps |
-| `docker.container-prefix` | `nb` | Default prefix for CLI-managed Docker containers |
-| `bin.docker` | `docker` | Override the Docker executable path |
-| `bin.caddy` | `caddy` | Override the Caddy executable path |
-| `bin.git` | `git` | Override the Git executable path |
-| `bin.nginx` | `nginx` | Override the Nginx executable path |
-| `bin.pnpm` | `pnpm` | Override the pnpm executable path |
-| `bin.yarn` | `yarn` | Override the Yarn executable path |
-| `proxy.nb-cli-root` | CLI root, usually the current user's home directory | Override the root path visible to the generated proxy config when the proxy process and CLI do not see the same filesystem root |
-| `proxy.upstream-host` | `127.0.0.1` | Override the host used when the proxy forwards traffic back to the NocoBase app |
-| `proxy.nginx-driver` | `local` | Default runtime driver used by `nb proxy nginx` |
-| `proxy.caddy-driver` | `local` | Default runtime driver used by `nb proxy caddy` |
+| Key                       | Default                                             | Description                                                                                                                     |
+| ------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `locale`                  | resolved by the current CLI rules                   | Override the language used by the CLI                                                                                           |
+| `update.policy`           | `prompt`                                            | Startup update policy: `prompt`, `auto`, or `off`                                                                               |
+| `license.pkg-url`         | `https://pkg.nocobase.com/`                         | Override the download URL for commercial extension packages                                                                     |
+| `docker.network`          | `nocobase`                                          | Default network for CLI-managed Docker apps                                                                                     |
+| `docker.container-prefix` | `nb`                                                | Default prefix for CLI-managed Docker containers                                                                                |
+| `nb-image-registry`       | `dockerhub`                                         | Default registry family for official NocoBase images: `dockerhub` or `aliyun`                                                   |
+| `nb-image-variant`        | `full`                                              | Default tag variant for official NocoBase app images: `standard`, `no-nginx`, `full`, or `full-no-nginx`                        |
+| `bin.docker`              | `docker`                                            | Override the Docker executable path                                                                                             |
+| `bin.caddy`               | `caddy`                                             | Override the Caddy executable path                                                                                              |
+| `bin.git`                 | `git`                                               | Override the Git executable path                                                                                                |
+| `bin.nginx`               | `nginx`                                             | Override the Nginx executable path                                                                                              |
+| `bin.pnpm`                | `pnpm`                                              | Override the pnpm executable path                                                                                               |
+| `bin.yarn`                | `yarn`                                              | Override the Yarn executable path                                                                                               |
+| `proxy.nb-cli-root`       | CLI root, usually the current user's home directory | Override the root path visible to the generated proxy config when the proxy process and CLI do not see the same filesystem root |
+| `proxy.upstream-host`     | `127.0.0.1`                                         | Override the host used when the proxy forwards traffic back to the NocoBase app                                                 |
+| `proxy.nginx-driver`      | `local`                                             | Default runtime driver used by `nb proxy nginx`                                                                                 |
+| `proxy.caddy-driver`      | `local`                                             | Default runtime driver used by `nb proxy caddy`                                                                                 |
 
 ## Usage
 
@@ -49,12 +54,12 @@ nb config <command>
 
 ## Subcommands
 
-| Command | Description |
-| --- | --- |
-| [`nb config get`](./get.md) | Read the effective value of a configuration key |
-| [`nb config set`](./set.md) | Set a configuration key |
-| [`nb config delete`](./delete.md) | Delete an explicitly set configuration key |
-| [`nb config list`](./list.md) | List the configuration keys that are currently set explicitly |
+| Command                           | Description                                                   |
+| --------------------------------- | ------------------------------------------------------------- |
+| [`nb config get`](./get.md)       | Read the effective value of a configuration key               |
+| [`nb config set`](./set.md)       | Set a configuration key                                       |
+| [`nb config delete`](./delete.md) | Delete an explicitly set configuration key                    |
+| [`nb config list`](./list.md)     | List the configuration keys that are currently set explicitly |
 
 ## Examples
 
@@ -69,6 +74,9 @@ nb config set proxy.nginx-driver docker
 nb config set proxy.caddy-driver local
 nb config get docker.network
 nb config set docker.network nocobase
+nb config get nb-image-registry
+nb config set nb-image-registry aliyun
+nb config set nb-image-variant full-no-nginx
 nb config set bin.nginx /usr/sbin/nginx
 nb config set bin.git /usr/bin/git
 nb config set bin.pnpm /usr/local/bin/pnpm
@@ -79,6 +87,9 @@ nb config delete docker.container-prefix
 
 - `bin.nginx` and `bin.caddy` only affect the `local` driver for `nb proxy nginx` and `nb proxy caddy`
 - `bin.pnpm` is used when commands need to run pnpm directly, such as updating a pnpm-managed global CLI install with `nb self update`
+- `nb-image-registry` only affects official NocoBase image defaults used by the CLI. `dockerhub` maps app images to `nocobase/nocobase`, while `aliyun` maps them to `registry.cn-shanghai.aliyuncs.com/nocobase/nocobase`
+- `nb-image-variant` only affects official NocoBase app image tags. With version tag `1.7.14`, the CLI resolves `standard` to `1.7.14`, `no-nginx` to `1.7.14-no-nginx`, `full` to `1.7.14-full`, and `full-no-nginx` to `1.7.14-full-no-nginx`
+- When `nb-image-registry=aliyun`, the CLI also switches the default built-in database images to the official Aliyun mirrors for PostgreSQL, MySQL, MariaDB, and Kingbase
 - `proxy.nginx-driver` and `proxy.caddy-driver` store the default driver used by each provider
 - `proxy.nb-cli-root` and `proxy.upstream-host` are advanced proxy overrides. Most CLI-managed `local` or `docker` envs can use the defaults directly
 - If you only want to switch the active proxy driver, using `nb proxy nginx use` or `nb proxy caddy use` is usually clearer than setting the config key manually

package/dist/ai/docs/nocobase/api/cli/config/set.md

@@ -1,7 +1,7 @@
 ---
-title: "nb config set"
-description: "nb config set command reference: set a CLI configuration item."
-keywords: "nb config set,NocoBase CLI,set configuration"
+title: 'nb config set'
+description: 'nb config set command reference: set a CLI configuration item.'
+keywords: 'nb config set,NocoBase CLI,set configuration'
 ---
 
 # nb config set
@@ -16,10 +16,10 @@ nb config set <key> <value>
 
 ## Parameters
 
-| Parameter | Type | Description |
-| --- | --- | --- |
-| `<key>` | string | Configuration item name. See [`nb config`](./index.md) for supported values |
-| `<value>` | string | Configuration value, cannot be empty |
+| Parameter | Type   | Description                                                                 |
+| --------- | ------ | --------------------------------------------------------------------------- |
+| `<key>`   | string | Configuration item name. See [`nb config`](./index.md) for supported values |
+| `<value>` | string | Configuration value, cannot be empty                                        |
 
 ## Examples
 
@@ -29,6 +29,10 @@ nb config set update.policy auto
 nb config set license.pkg-url https://pkg.nocobase.com/
 nb config set docker.network nocobase
 nb config set docker.container-prefix nb
+nb config set nb-image-registry dockerhub
+nb config set nb-image-registry aliyun
+nb config set nb-image-variant full
+nb config set nb-image-variant full-no-nginx
 nb config set bin.docker /usr/local/bin/docker
 nb config set bin.caddy /opt/homebrew/bin/caddy
 nb config set bin.git /usr/bin/git
@@ -43,7 +47,9 @@ nb config set bin.yarn yarn
 
 ## Notes
 
-`update.policy` supports `prompt`, `auto`, and `off`, and the default value is `prompt`.
+- `update.policy` supports `prompt`, `auto`, and `off`, and the default value is `prompt`
+- `nb-image-registry` supports `dockerhub` and `aliyun`, and the default value is `dockerhub`
+- `nb-image-variant` supports `standard`, `no-nginx`, `full`, and `full-no-nginx`, and the default value is `full`
 
 ## Related commands