@nocobase/plugin-ai 2.2.0-alpha.1 → 2.2.0-alpha.2

package/dist/ai/docs/nocobase/interface-builder/blocks/data-blocks/map.md

@@ -0,0 +1,105 @@
+---
+pkg: '@nocobase/plugin-map'
+title: 'Map Block'
+description: 'The Map block displays collection records on AMap or Google Maps, and supports point, line, polygon, and circle fields.'
+keywords: 'Map Block,AMap,Google Maps,Point,Line,Polygon,Circle,NocoBase'
+---
+
+# Map block
+
+## Introduction
+
+The Map block displays geographic data from a collection on a map. It is suitable for scenarios such as store locations, customer addresses, device distribution, route tracking, and area management.
+
+The Map block supports AMap and Google Maps. It can render point, line, polygon, and circle fields, and can open record views or run block actions from map overlays.
+
+![Map block interface](https://static-docs.nocobase.com/20260615162922.png)
+
+## Installation
+
+The Map block is provided by the built-in `@nocobase/plugin-map` plugin. Enable the plugin before adding the block.
+
+After enabling the plugin, go to "Plugin settings / Map manager" and configure the map provider:
+
+- **AMap**: configure `Access key`, plus `securityJsCode` or `serviceHost`
+- **Google Maps**: configure `Api key`
+
+If the map cannot be loaded, check whether the key is valid, whether the domain whitelist includes the current access domain, and whether the browser can access the selected map provider.
+
+## Prepare map fields
+
+Before adding a Map block, create at least one map field in the target collection. You can find these field types in the "Map-based geometry" group:
+
+| Field type | Usage                                                                 |
+| ---------- | --------------------------------------------------------------------- |
+| Point      | Marks a single location, such as a store, device, or customer address |
+| Line       | Represents a route or track                                           |
+| Polygon    | Represents an area                                                    |
+| Circle     | Represents a radius around a center point                             |
+
+When creating the field, choose the "Map type". This determines whether the field editor and the block use AMap or Google Maps.
+
+## Add block
+
+In page configuration mode, click "Add block" and choose "Map" from "Data Blocks".
+
+![Add a Map block from Data Blocks](https://static-docs.nocobase.com/20260615163017.png)
+
+When creating the block, configure:
+
+1. Select the collection to display.
+2. Select the "Map field" used to draw map overlays. It can be a field in the current collection or a map field reached through an association field.
+3. Optionally select the "Marker field". When the map field is a point field, this field is used as the point label.
+
+If the collection has no available map field, the "Map field" selector will be empty. Add a point, line, polygon, or circle field to the collection first.
+
+## Block settings
+
+### Map field and marker field
+
+Used to change the map field displayed by the block and the marker label field.
+
+The marker field only applies to point fields. It is usually a text field such as name, address, or code.
+
+### Data scope
+
+Used to restrict the records displayed in the Map block.
+
+For large datasets, configure a data scope or add filter actions to narrow the displayed records. The Map block loads all records that match the data scope without pagination.
+
+For more details, see: [Set Data Scope](/interface-builder/blocks/block-settings/data-scope)
+
+### Concatenation order field
+
+Used to sort point records and connect them into a route.
+
+This setting only takes effect when the map field is a point field.
+
+### Default zoom level
+
+Used to set the initial zoom level of the map.
+
+## Actions
+
+The Map block supports adding actions at the top of the block, such as:
+
+- Filter
+- Add new
+- Popup
+- Link
+- Refresh
+- Custom request
+- AI employee
+- JS action
+
+Clicking a map overlay triggers the record opening flow, which is usually used to open a popup, drawer, or another record view.
+
+## Select records
+
+The Map block provides selection tools in the upper-left corner:
+
+- Location icon: exits selection mode and returns to normal viewing
+- Selection icon: enters selection mode and lets you draw a polygon area on the map
+- Confirm icon: confirms the current selection area and adds records inside it to the selected state
+
+Selected records are synced to the block resource and can be used by later block actions.

package/dist/ai/docs/nocobase/interface-builder/fields/field-settings/scan-input.md

@@ -0,0 +1,43 @@
+---
+title: "Scan Code Input"
+description: "Field settings: enable scan code input for text form fields, supporting writing field values through QR codes or barcodes."
+keywords: "scan code input,QR code,barcode,field settings,interface builder,NocoBase"
+---
+
+# Scan Code Input
+
+## Introduction
+
+Scan code input is used for text fields in editable forms. After it is enabled, a scan button appears on the right side of the field input. Users can scan a QR code or barcode, or select an image from the album for recognition, and write the recognized result into the current field.
+
+It is typically suitable for entering values such as device numbers, asset codes, order numbers, and tracking numbers that are inconvenient to type manually.
+
+## Supported Fields
+
+Scan code input is mainly used for text-based fields, such as:
+
+- Single line text
+- Mobile phone
+- Email
+- URL
+- UUID
+- Nano ID
+
+If the field is read-only, in reading mode, or does not support editable input itself, the scan code input configuration will not be shown.
+
+## Configuration
+
+Select the corresponding field in a form block, open the field configuration menu, and find `Scan Code Input Settings`.
+
+Options include:
+
+- `Enable scan code input`: after enabling, a scan button is shown on the right side of the input box
+- `Disable manual input`: after enabling, users can only write the field value by scanning and cannot edit the input box manually
+
+After `Enable scan code input` is turned off, `Disable manual input` also becomes inactive.
+
+## Usage
+
+After the user clicks the scan button on the right side of the field, they can use the camera to recognize a QR code or barcode. Browser-based scanning requires permission to access the camera. In mobile environments that support native scan capabilities, the native mobile scan capability is used first.
+
+If it is not convenient to use the camera directly, users can also click `Album` to select an image for recognition.

package/dist/ai/docs/nocobase/interface-builder/fields/field-settings/validation-rules.md

@@ -30,10 +30,14 @@ Most fields support the configuration of validation rules. After a field is conf
 ![20251028230554](https://static-docs.nocobase.com/20251028230554.png)
 
 
-### Frontend Validation in Field Configuration
+### Client-Side Validation Rules in Field Settings
 
 Validation rules set in the field configuration will trigger frontend validation to ensure user input complies with the regulations.
 
+If the corresponding collection field already has validation rules, those rules are shown in the validation settings under **Server-side field validation rules**. They are inherited from the data source field configuration and are read-only here. If you need to change them, edit the collection field in Data source → Collection configuration.
+
+Rules added under **Client-side validation rules** only apply to the current field component. They do not change the collection field configuration. When both groups exist, NocoBase applies the inherited field rules and client-side validation rules together.
+
 
 ![20251028230105](https://static-docs.nocobase.com/20251028230105.png)
 
@@ -45,4 +49,4 @@ Validation rules set in the field configuration will trigger frontend validation
 **Text fields** also support custom regex validation to meet specific format requirements.
 
 
-![20251028230903](https://static-docs.nocobase.com/20251028230903.png)
+![20251028230903](https://static-docs.nocobase.com/20251028230903.png)

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/index.md

@@ -1,4 +1,4 @@
-# Quick start
+# NocoBase CLI Overview
 
 If this is your first time using this CLI, you don’t need to memorize all the commands at the beginning. Use `nb init --ui` to install an application first, and then continue looking at the rest according to the scenario.
 
@@ -20,7 +20,7 @@ Keep this in mind first, and the subsequent documents will be much smoother.
 
 If you're not sure where to start, it's usually easiest to follow this path:
 
-1. First read [Installation using CLI (recommended)](./installation/cli.md) and complete `nb init` once.
+1. First read [Install using CLI](./installation/cli.md) and complete `nb init` once.
 2. After the application is saved as env, look at [Multiple Environment Management](./operations/multi-environment.md) to confirm the current env, switch env, and check the status.
 3. For daily startup, stop, log and upgrade, continue to see [Manage Application](./operations/manage-app.md).
 4. Before making upgrades, migrations or important changes, see [Backup and Restore](./operations/backup-restore.md).
@@ -32,8 +32,8 @@ The first three steps cover most usage scenarios.
 
 | I want... | Where to look |
 | --- | --- |
-| There is no application yet, first install a new NocoBase and save it as CLI env | [Install using CLI (recommended)](./installation/cli.md) |
-| Already have a running NocoBase and want to access CLI management | [Install using CLI (recommended)](./installation/cli.md) |
+| There is no application yet and you want to install a new NocoBase and save it as a CLI env | [Install using CLI](./installation/cli.md) |
+| You already have a running NocoBase and want to bring it under CLI management | [Install using CLI](./installation/cli.md) |
 | Gradually migrate old installation methods to CLI | [Migrate from old installation methods to CLI](./installation/migration.md) |
 | See which envs are saved locally, switch the current env, and check the status | [Multiple environment management](./operations/multi-environment.md) |
 | Start, stop, restart the application, view logs, or continue the upgrade | [Manage Application](./operations/manage-app.md) |
@@ -44,11 +44,11 @@ The first three steps cover most usage scenarios.
 
 ## When to look at the command reference
 
-This set of quick start documents is more "what do I want to do now". If you already know which command you want to execute and just want to continue to see the complete parameters, just go to [NocoBase CLI Command Reference](../api/cli/index.md).
+This set of quick start documents is more about "what do I want to do now". If you already know which command you want to run and only want the full parameters, go straight to [NocoBase CLI Command Reference](../api/cli/index.md).
 
 The default suggestions are:
 
-- First use the Quick Start document to establish a sense of path
+- First use this overview and the quick start documents to establish a sense of path
 - Then check the parameter details on the specific command page
 
 This makes it easier to get started than reading the complete command tree at first glance.

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/cli.md

@@ -1,4 +1,4 @@
-# Install using CLI (recommended)
+# Install using CLI
 
 After NocoBase 2.1.0, the official CLI-based installation and management method is provided. You can use it to complete installation, connection, upgrade and daily maintenance, and you can also prepare a connectable and operable environment for AI Agent.
 
@@ -9,7 +9,7 @@ Only executed when installing the CLI for the first time.
 First install the CLI globally:
 
 ```bash
-npm install -g @nocobase/cli@beta
+npm install -g @nocobase/cli
 nb --version
 ```
 
@@ -23,12 +23,6 @@ nb session setup
 
 :::
 
-If you plan to use the Chinese interface for a long time, it is usually enough to set the locale first:
-
-```bash
-nb config set locale zh-CN
-```
-
 The CLI checks for self-updates by default. You can adjust the update strategy according to your own habits:
 
 - `prompt`: Prompt when a new version is found
@@ -41,6 +35,8 @@ nb config set update.policy auto
 nb config set update.policy off
 ```
 
+Self-update is only supported when the CLI is managed by a standard global npm, pnpm, or yarn install. If you are running from source or from a local project dependency tree, use [`nb self check`](../../api/cli/self/check.md) to see the detected install method and update that parent project instead.
+
 If you are going to deploy NocoBase to the server and want to open the `nb init --ui` wizard from a remote browser, it is recommended to first change the CLI's default host to the current server IP:
 
 ```bash
@@ -54,7 +50,7 @@ Replace `<server-ip>` with the actual IP of the current server that is accessibl
 
 Generally speaking:
 
-- `default-ui-host` is used for the default listening address of `nb init --ui` when starting the wizard page
+- `default-ui-host` is used to generate the browser-accessible URL for the `nb init --ui` wizard; the wizard service itself always listens on `0.0.0.0`
 - `default-api-host` for the API address generated by default on new installations
 
 If deployed on a server, both values ​​should usually be changed to IPs accessible to the current server, rather than continuing to use the default local address.

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/env.md

@@ -2,7 +2,7 @@
 
 This page only applies to applications created or hosted via the NocoBase CLI.
 
-If you have just finished reading [Installation using CLI (recommended)](./cli.md) and have seen the "Installation Directory" section, then the most common problems you will encounter are usually the following:
+If you have just finished reading [Install using CLI](./cli.md) and have seen the "Installation Directory" section, then the most common problems you will encounter are usually the following:
 
 - Where is the `.env` file placed?
 - Which configurations are still suitable to be written into `.env`
@@ -17,7 +17,7 @@ Let’s talk about the conclusion first:
 
 ## Find `app-path` first
 
-In [Install using CLI (recommended)](./cli.md#Installation directory), the default directory structure of CLI env is as follows:
+In [Install using CLI](./cli.md#Installation directory), the default directory structure of CLI env is as follows:
 
 ```text
 <app-path>/
@@ -148,6 +148,6 @@ This is also the mentality that this page most wants to help you build:
 
 ## Where to look next
 
-- If you have not confirmed the application directory structure, first go back to [Install using CLI (recommended)](./cli.md#Installation directory)
+- If you have not confirmed the application directory structure, first go back to [Install using CLI](./cli.md#Installation directory)
 - If you want to modify basic configurations such as ports, time zones, database connections, and public access paths, continue to see [`nb env update`](../../api/cli/env/update.md)
 - If you want to start, restart or view application logs, continue to see [Manage Application](../operations/manage-app.md)

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/installation/migration.md

@@ -99,5 +99,5 @@ By default, it is enough to migrate the test environment first. Only migrate the
 
 ## Where to look next
 
-- If you are ready to install and manage applications in a new way, continue to [Installation using CLI (recommended)](./cli.md)
+- If you are ready to install and manage applications in a new way, continue to [Install using CLI](./cli.md)
 - If you just continue to use the original installation method, just go back to the installation and upgrade document entry above.

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/index.md

@@ -69,7 +69,7 @@ If you happen to be stuck here "Why do you need `nb app autostart`", just contin
 - If you are going to connect to the reverse proxy, `appPort` has been saved in env
 - If you are ready to officially open it to the outside world, you have already planned the domain name, entrance port and HTTPS solution.
 
-If you have not completed the CLI installation or env initialization, go back to [Installation using CLI (recommended)](../installation/cli.md).
+If you have not completed the CLI installation or env initialization, go back to [Install using CLI](../installation/cli.md).
 
 If the command prompts that env is missing `appPort`, first execute [`nb env update`](../../api/cli/env/update.md) to fill it in.
 

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/reverse-proxy/caddy.md

@@ -290,6 +290,6 @@ nb proxy caddy status
 
 - [Production environment reverse proxy](./index.md)
 - [Nginx](./nginx.md)
-- [Install using CLI (recommended)](../../installation/cli.md)
+- [Install using CLI](../../installation/cli.md)
 - [Application configuration with `.env`](../../installation/env.md)
 - [`nb proxy caddy` Command Reference](../../../api/cli/proxy/caddy/index.md)

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/reverse-proxy/index.md

@@ -45,4 +45,4 @@ It can usually be judged like this:
 | Follow the Nginx management site entrance | [Nginx](./nginx.md) |
 | Connect HTTPS as soon as possible | [Caddy](./caddy.md) |
 | First adjust the env configuration that will affect the proxy results, such as `app-port`, `app-public-path` | [`nb env update`](../../../api/cli/env/update.md) |
-| First confirm the installation and env configuration of the application | [Install using CLI (recommended)](../../installation/cli.md) |
+| First confirm the installation and env configuration of the application | [Install using CLI](../../installation/cli.md) |

package/dist/ai/docs/nocobase/{quickstart → nocobase-cli}/production/reverse-proxy/nginx.md

@@ -246,6 +246,6 @@ However, if you just want to get available HTTPS as soon as possible, and don't
 
 - [Production environment reverse proxy](./index.md)
 - [Caddy](./caddy.md)
-- [Install using CLI (recommended)](../../installation/cli.md)
+- [Install using CLI](../../installation/cli.md)
 - [Application configuration with `.env`](../../installation/env.md)
 - [`nb proxy nginx` Command Reference](../../../api/cli/proxy/nginx/index.md)

package/dist/ai/docs/nocobase/ops-management/backup-manager/index.mdx

@@ -8,18 +8,20 @@ pkg: '@nocobase/plugin-backups'
 
 The NocoBase backup manager plugin provides features for fully backing up of the NocoBase database and user uploaded files, including backup's scheduling, downloading, deleting, and restoring operation.
 
-:::warning
-The Backup Manager plugin is included in the Professional and Enterprise editions. For Community and Standard edition users, you can directly back up the database; see details at: [`How to Backup and Restore NocoBase`](https://www.nocobase.com/en/blog/nocobase-backup-restore)
-:::
-
 ## Install Database Client
 
-The Backup Manager depends on the client for the corresponding database. Before use, please visit the official website to download the client that matches your database version:
+Backup Manager depends on the database client for the primary database. Before use, confirm that the current runtime environment has a client that matches your database version.
+
+:::tip
+When installing NocoBase with Docker, use the corresponding `full` image when possible, such as `latest-full`, `beta-full`, or `alpha-full`. These images already include common database clients, so manual installation is usually not required.
+:::
+
+If the current environment does not have the required database client, download the client that matches your database version from the official website:
 
 - MySQL: https://dev.mysql.com/downloads/
 - PostgreSQL: https://www.postgresql.org/download/
 
-For Docker versions, you can directly write a script in the `./storage/scripts` directory
+If you need to install it manually in a Docker environment, you can write a script in the `./storage/scripts` directory:
 
 ```bash
 mkdir ./storage/scripts
@@ -188,4 +190,4 @@ Switch to the "Settings" tab, modify the backup settings, and click `Save` to ta
 - `Backup local storage files`: Whether to include files uploaded by users to the server's local storage (storage/uploads) in the backup.
 - `Restore password`: If a restore password is set, it must be entered when restoring the backup.
 
-> **Please keep the restore password safe. Forgetting the password will make it impossible to restore the backup file.**
+> **Please keep the restore password safe. Forgetting the password will make it impossible to restore the backup file.**