@nocobase/plugin-flow-engine 2.1.0-alpha.9 → 2.1.0-beta.10

package/dist/ai/docs/runjs/context/block-model.md

@@ -1,49 +1,49 @@
 # ctx.blockModel
 
-The parent block model (BlockModel instance) where the current JS Field / JS Block is located. In scenarios such as JSField, JSItem, and JSColumn, `ctx.blockModel` points to the form block or table block carrying the current JS logic. In a standalone JSBlock, it may be `null` or the same as `ctx.model`.
+The parent block model (BlockModel instance) that hosts the current JS field / JS block. In JSField, JSItem, JSColumn, etc., `ctx.blockModel` refers to the form block or table block that hosts the current JS logic; in a standalone JSBlock it may be `null` or the same as `ctx.model`.
 
-## Scenarios
+## Use Cases
 
 | Scenario | Description |
-|------|------|
-| **JSField** | Access the `form`, `collection`, and `resource` of the parent form block within a form field to implement linkage or validation. |
-| **JSItem** | Access the resource and collection information of the parent table/form block within a sub-table item. |
-| **JSColumn** | Access the `resource` (e.g., `getSelectedRows`) and `collection` of the parent table block within a table column. |
-| **Form Actions / FlowEngine** | Access `form` for pre-submission validation, `resource` for refreshing, etc. |
+|----------|-------------|
+| **JSField** | Access parent form block's `form`, `collection`, `resource` for linkage or validation |
+| **JSItem** | Access parent table/form block's resource and collection in sub-table items |
+| **JSColumn** | Access parent table block's `resource` (e.g. `getSelectedRows`), `collection` |
+| **Form actions / event flow** | Use `form` for pre-submit validation, `resource` for refresh, etc. |
 
-> Note: `ctx.blockModel` is only available in RunJS contexts where a parent block exists. In standalone JSBlocks (without a parent form/table), it may be `null`. It is recommended to perform a null check before use.
+> Note: `ctx.blockModel` is only available in RunJS contexts that have a parent block; in a standalone JSBlock (no parent form/table) it may be `null`—check before use.
 
-## Type Definition
+## Type
 
 ```ts
 blockModel: BlockModel | FormBlockModel | TableBlockModel | CollectionBlockModel | DataBlockModel | null;
 ```
 
-The specific type depends on the parent block type: form blocks are mostly `FormBlockModel` or `EditFormModel`, while table blocks are mostly `TableBlockModel`.
+The exact type depends on the parent block: form blocks are usually `FormBlockModel` / `EditFormModel`, table blocks are usually `TableBlockModel`.
 
 ## Common Properties
 
 | Property | Type | Description |
-|------|------|------|
-| `uid` | `string` | Unique identifier of the block model. |
-| `collection` | `Collection` | The collection bound to the current block. |
-| `resource` | `Resource` | The resource instance used by the block (`SingleRecordResource` / `MultiRecordResource`, etc.). |
-| `form` | `FormInstance` | Form Block: Ant Design Form instance, supporting `getFieldsValue`, `validateFields`, `setFieldsValue`, etc. |
-| `emitter` | `EventEmitter` | Event emitter, used to listen for `formValuesChange`, `onFieldReset`, etc. |
+|----------|------|-------------|
+| `uid` | `string` | Block model unique id |
+| `collection` | `Collection` | Collection bound to the block |
+| `resource` | `Resource` | Resource instance (`SingleRecordResource` / `MultiRecordResource`, etc.) |
+| `form` | `FormInstance` | Form block: Ant Design Form instance (`getFieldsValue`, `validateFields`, `setFieldsValue`, etc.) |
+| `emitter` | `EventEmitter` | Event emitter; can listen to `formValuesChange`, `onFieldReset`, etc. |
 
-## Relationship with ctx.model and ctx.form
+## Relation to ctx.model, ctx.form
 
-| Requirement | Recommended Usage |
-|------|----------|
-| **Parent block of the current JS** | `ctx.blockModel` |
-| **Read/Write form fields** | `ctx.form` (equivalent to `ctx.blockModel?.form`, more convenient in form blocks) |
-| **Model of the current execution context** | `ctx.model` (Field model in JSField, Block model in JSBlock) |
+| Need | Recommended |
+|------|-------------|
+| **Parent block of current JS** | `ctx.blockModel` |
+| **Read/write form fields** | `ctx.form` (same as `ctx.blockModel?.form`; more convenient in form blocks) |
+| **Model for current execution context** | `ctx.model` (field model in JSField, block model in JSBlock) |
 
-In a JSField, `ctx.model` is the field model, and `ctx.blockModel` is the form or table block carrying that field; `ctx.form` is typically `ctx.blockModel.form`.
+In JSField, `ctx.model` is the field model and `ctx.blockModel` is the form/table block that hosts it; `ctx.form` is usually `ctx.blockModel.form`.
 
 ## Examples
 
-### Table: Get selected rows and process
+### Table: get selected rows and process
 
 ```ts
 const rows = ctx.blockModel?.resource?.getSelectedRows?.() || [];
@@ -53,7 +53,7 @@ if (rows.length === 0) {
 }
 ```
 
-### Form Scenario: Validate and Refresh
+### Form: validate and refresh
 
 ```ts
 if (ctx.blockModel?.form) {
@@ -62,15 +62,15 @@ if (ctx.blockModel?.form) {
 }
 ```
 
-### Listen for Form Changes
+### Listen to form changes
 
 ```ts
 ctx.blockModel?.emitter?.on?.('formValuesChange', (payload) => {
-  // Implement linkage or re-rendering based on the latest form values
+  // React to latest form values or re-render
 });
 ```
 
-### Trigger Block Re-render
+### Trigger block re-render
 
 ```ts
 ctx.blockModel?.rerender?.();
@@ -78,13 +78,13 @@ ctx.blockModel?.rerender?.();
 
 ## Notes
 
-- In a **standalone JSBlock** (without a parent form or table block), `ctx.blockModel` may be `null`. It is recommended to use optional chaining when accessing its properties: `ctx.blockModel?.resource?.refresh?.()`.
-- In **JSField / JSItem / JSColumn**, `ctx.blockModel` refers to the form or table block carrying the current field. In a **JSBlock**, it may be itself or an upper-level block, depending on the actual hierarchy.
-- `resource` only exists in data blocks; `form` only exists in form blocks. Table blocks typically do not have a `form`.
+- In a **standalone JSBlock** (no parent form/table), `ctx.blockModel` may be `null`; use optional chaining: `ctx.blockModel?.resource?.refresh?.()`.
+- In **JSField / JSItem / JSColumn**, `ctx.blockModel` is the form or table block that hosts the field; in **JSBlock**, it may be the block itself or an ancestor, depending on hierarchy.
+- `resource` exists only on data blocks; `form` exists only on form blocks; table blocks usually have no `form`.
 
 ## Related
 
-- [ctx.model](./model.md): The model of the current execution context.
-- [ctx.form](./form.md): Form instance, commonly used in form blocks.
-- [ctx.resource](./resource.md): Resource instance (equivalent to `ctx.blockModel?.resource`, use directly if available).
-- [ctx.getModel()](./get-model.md): Get other block models by UID.
+- [ctx.model](./model.md): model for current execution context
+- [ctx.form](./form.md): form instance, common in form blocks
+- [ctx.resource](./resource.md): resource instance (same as `ctx.blockModel?.resource` when present)
+- [ctx.getModel()](./get-model.md): get another block model by uid

package/dist/ai/docs/runjs/context/collection-field.md

@@ -1,18 +1,18 @@
 # ctx.collectionField
 
-The `CollectionField` instance associated with the current RunJS execution context, used to access field metadata, types, validation rules, and association information. It only exists when the field is bound to a collection definition; custom/virtual fields may be `null`.
+The collection field (CollectionField) instance for the current RunJS context; used to access field metadata, type, validation rules, and association info. Only present when the field is bound to a collection definition; custom/virtual fields may have `null`.
 
 ## Use Cases
 
 | Scenario | Description |
-|------|------|
-| **JSField** | Perform linkage or validation in form fields based on `interface`, `enum`, `targetCollection`, etc. |
-| **JSItem** | Access metadata of the field corresponding to the current column in sub-table items. |
-| **JSColumn** | Select rendering methods based on `collectionField.interface` or access `targetCollection` in table columns. |
+|----------|-------------|
+| **JSField** | Use `interface`, `enum`, `targetCollection`, etc. for linkage or validation |
+| **JSItem** | Access metadata of the column’s field in sub-table items |
+| **JSColumn** | Choose render by `collectionField.interface`, or use `targetCollection` |
 
-> Note: `ctx.collectionField` is only available when the field is bound to a Collection definition; it is usually `undefined` in scenarios like JSBlock independent blocks or action events without field binding. It is recommended to check for null values before use.
+> Note: `ctx.collectionField` is only available when the field is bound to a collection; in standalone JSBlock or actions with no field binding it is usually `undefined`—check before use.
 
-## Type Definition
+## Type
 
 ```ts
 collectionField: CollectionField | null | undefined;
@@ -21,47 +21,46 @@ collectionField: CollectionField | null | undefined;
 ## Common Properties
 
 | Property | Type | Description |
-|------|------|------|
-| `name` | `string` | Field name (e.g., `status`, `userId`) |
-| `title` | `string` | Field title (including internationalization) |
-| `type` | `string` | Field data type (`string`, `integer`, `belongsTo`, etc.) |
-| `interface` | `string` | Field interface type (`input`, `select`, `m2o`, `o2m`, `m2m`, etc.) |
-| `collection` | `Collection` | The collection the field belongs to |
-| `targetCollection` | `Collection` | The target collection of the association field (only for association types) |
-| `target` | `string` | Target collection name (for association fields) |
-| `enum` | `array` | Enumeration options (select, radio, etc.) |
+|----------|------|-------------|
+| `name` | `string` | Field name (e.g. `status`, `userId`) |
+| `title` | `string` | Field title (i18n) |
+| `type` | `string` | Data type (`string`, `integer`, `belongsTo`, etc.) |
+| `interface` | `string` | UI type (`input`, `select`, `m2o`, `o2m`, `m2m`, etc.) |
+| `collection` | `Collection` | Field’s collection |
+| `targetCollection` | `Collection` | Target collection for association fields only |
+| `target` | `string` | Target collection name (association) |
+| `enum` | `array` | Enum options (select, radio, etc.) |
 | `defaultValue` | `any` | Default value |
-| `collectionName` | `string` | Name of the collection it belongs to |
-| `foreignKey` | `string` | Foreign key field name (belongsTo, etc.) |
-| `sourceKey` | `string` | Association source key (hasMany, etc.) |
-| `targetKey` | `string` | Association target key |
-| `fullpath` | `string` | Full path (e.g., `main.users.status`), used for API or variable references |
-| `resourceName` | `string` | Resource name (e.g., `users.status`) |
-| `readonly` | `boolean` | Whether it is read-only |
-| `titleable` | `boolean` | Whether it can be displayed as a title |
-| `validation` | `object` | Validation rule configuration |
-| `uiSchema` | `object` | UI configuration |
-| `targetCollectionTitleField` | `CollectionField` | The title field of the target collection (for association fields) |
+| `collectionName` | `string` | Collection name |
+| `foreignKey` | `string` | Foreign key (e.g. belongsTo) |
+| `sourceKey` | `string` | Source key (e.g. hasMany) |
+| `targetKey` | `string` | Target key |
+| `fullpath` | `string` | Full path (e.g. `main.users.status`) for API/variables |
+| `resourceName` | `string` | Resource name (e.g. `users.status`) |
+| `readonly` | `boolean` | Read-only |
+| `titleable` | `boolean` | Can be used as title |
+| `validation` | `object` | Validation config |
+| `uiSchema` | `object` | UI config |
+| `targetCollectionTitleField` | `CollectionField` | Title field of target collection (association) |
 
 ## Common Methods
 
 | Method | Description |
-|------|------|
-| `isAssociationField(): boolean` | Whether it is an association field (belongsTo, hasMany, hasOne, belongsToMany, etc.) |
-| `isRelationshipField(): boolean` | Whether it is a relationship field (including o2o, m2o, o2m, m2m, etc.) |
-| `getComponentProps(): object` | Get the default props of the field component |
-| `getFields(): CollectionField[]` | Get the field list of the target collection (association fields only) |
-| `getFilterOperators(): object[]` | Get the filter operators supported by this field (e.g., `$eq`, `$ne`, etc.) |
+|--------|-------------|
+| `isAssociationField(): boolean` | Whether it is an association (belongsTo, hasMany, hasOne, belongsToMany, etc.) |
+| `isRelationshipField(): boolean` | Whether it is a relationship (o2o, m2o, o2m, m2m, etc.) |
+| `getComponentProps(): object` | Default props for the field component |
+| `getFields(): CollectionField[]` | Fields of target collection (association only) |
+| `getFilterOperators(): object[]` | Filter operators (e.g. `$eq`, `$ne`) |
 
 ## Examples
 
-### Branch rendering based on field type
+### Branch by field type
 
 ```ts
 if (!ctx.collectionField) return null;
 const { interface: iface } = ctx.collectionField;
 if (['m2o', 'o2m', 'm2m'].includes(iface)) {
-  // Association field: display associated records
   const target = ctx.collectionField.targetCollection;
   // ...
 } else if (iface === 'select' || iface === 'radioGroup') {
@@ -70,24 +69,24 @@ if (['m2o', 'o2m', 'm2m'].includes(iface)) {
 }
 ```
 
-### Determine if it is an association field and access the target collection
+### Check association and use target collection
 
 ```ts
 if (ctx.collectionField?.isAssociationField()) {
   const targetCol = ctx.collectionField.targetCollection;
   const titleField = targetCol?.titleCollectionField?.name;
-  // Process according to the target collection structure
+  // ...
 }
 ```
 
-### Get enumeration options
+### Get enum options
 
 ```ts
 const options = ctx.collectionField?.enum ?? [];
 const labels = options.map((o) => (typeof o === 'object' ? o.label : o));
 ```
 
-### Conditional rendering based on read-only/view mode
+### Conditional render by readonly
 
 ```ts
 const { Input } = ctx.libs.antd;
@@ -98,35 +97,34 @@ if (ctx.collectionField?.readonly) {
 }
 ```
 
-### Get the title field of the target collection
+### Title field of target collection
 
 ```ts
-// When displaying an association field, use targetCollectionTitleField to get the title field name
 const titleField = ctx.collectionField?.targetCollectionTitleField;
 const titleKey = titleField?.name ?? 'title';
 const assocValue = ctx.getValue?.() ?? ctx.record?.[ctx.collectionField?.name];
 const label = assocValue?.[titleKey];
 ```
 
-## Relationship with ctx.collection
+## Relation to ctx.collection
 
-| Requirement | Recommended Usage |
-|------|----------|
-| **Current field's collection** | `ctx.collectionField?.collection` or `ctx.collection` |
+| Need | Recommended |
+|------|-------------|
+| **Collection of current field** | `ctx.collectionField?.collection` or `ctx.collection` |
 | **Field metadata (name, type, interface, enum, etc.)** | `ctx.collectionField` |
 | **Target collection** | `ctx.collectionField?.targetCollection` |
 
-`ctx.collection` usually represents the collection bound to the current block; `ctx.collectionField` represents the definition of the current field in the collection. In scenarios like sub-tables or association fields, the two may differ.
+`ctx.collection` is usually the block’s collection; `ctx.collectionField` is the field definition; they can differ in sub-tables and associations.
 
 ## Notes
 
-- In scenarios such as **JSBlock** or **JSAction (without field binding)**, `ctx.collectionField` is usually `undefined`. It is recommended to use optional chaining before access.
-- If a custom JS field is not bound to a collection field, `ctx.collectionField` may be `null`.
-- `targetCollection` only exists for association type fields (e.g., m2o, o2m, m2m); `enum` only exists for fields with options like select or radioGroup.
+- In **JSBlock**, **JSAction (no field binding)**, `ctx.collectionField` is usually `undefined`; use optional chaining.
+- Custom JS fields not bound to a collection field may have `ctx.collectionField` as `null`.
+- `targetCollection` exists only for association fields (m2o, o2m, m2m); `enum` only for select, radioGroup, etc.
 
 ## Related
 
-- [ctx.collection](./collection.md): Collection associated with the current context
-- [ctx.model](./model.md): Model where the current execution context is located
-- [ctx.blockModel](./block-model.md): Parent block carrying the current JS
-- [ctx.getValue()](./get-value.md), [ctx.setValue()](./set-value.md): Read and write the current field value
+- [ctx.collection](./collection.md): collection for current context
+- [ctx.model](./model.md): model for current execution context
+- [ctx.blockModel](./block-model.md): parent block
+- [ctx.getValue()](./get-value.md), [ctx.setValue()](./set-value.md): read/write current field value

package/dist/ai/docs/runjs/context/collection.md

@@ -1,18 +1,18 @@
 # ctx.collection
 
-The Collection instance associated with the current RunJS execution context, used to access collection metadata, field definitions, primary keys, and other configurations. It usually originates from `ctx.blockModel.collection` or `ctx.collectionField?.collection`.
+The collection (data table) instance associated with the current RunJS execution context; used to access collection metadata, field definitions, primary key, etc. Usually from `ctx.blockModel.collection` or `ctx.collectionField?.collection`.
 
 ## Use Cases
 
 | Scenario | Description |
-|------|------|
-| **JSBlock** | The collection bound to the block; can access `name`, `getFields`, `filterTargetKey`, etc. |
-| **JSField / JSItem / JSColumn** | The collection the current field belongs to (or the parent block's collection), used to retrieve field lists, primary keys, etc. |
-| **Table Column / Detail Block** | Used for rendering based on collection structure or passing `filterByTk` when opening popups. |
+|----------|-------------|
+| **JSBlock** | Block-bound collection; access `name`, `getFields`, `filterTargetKey`, etc. |
+| **JSField / JSItem / JSColumn** | Collection of current field or parent block; get field list, primary key, etc. |
+| **Table column / detail block** | Render by collection structure, pass `filterByTk` when opening popup, etc. |
 
-> Note: `ctx.collection` is available in scenarios where a data block, form block, or table block is bound to a collection. In an independent JSBlock that is not bound to a collection, it may be `null`. It is recommended to perform a null check before use.
+> Note: `ctx.collection` is available when the context is bound to a data block, form block, or table block; a standalone JSBlock with no bound collection may have `null`—check before use.
 
-## Type Definition
+## Type
 
 ```ts
 collection: Collection | null | undefined;
@@ -21,39 +21,39 @@ collection: Collection | null | undefined;
 ## Common Properties
 
 | Property | Type | Description |
-|------|------|------|
-| `name` | `string` | Collection name (e.g., `users`, `orders`) |
-| `title` | `string` | Collection title (includes internationalization) |
-| `filterTargetKey` | `string \| string[]` | Primary key field name, used for `filterByTk` and `getFilterByTK` |
-| `dataSourceKey` | `string` | Data source key (e.g., `main`) |
-| `dataSource` | `DataSource` | The data source instance it belongs to |
-| `template` | `string` | Collection template (e.g., `general`, `file`, `tree`) |
-| `titleableFields` | `CollectionField[]` | List of fields that can be displayed as titles |
-| `titleCollectionField` | `CollectionField` | The title field instance |
+|----------|------|-------------|
+| `name` | `string` | Collection name (e.g. `users`, `orders`) |
+| `title` | `string` | Collection title (i18n) |
+| `filterTargetKey` | `string \| string[]` | Primary key field name(s); used for `filterByTk`, `getFilterByTK` |
+| `dataSourceKey` | `string` | Data source key (e.g. `main`) |
+| `dataSource` | `DataSource` | Data source instance |
+| `template` | `string` | Collection template (e.g. `general`, `file`, `tree`) |
+| `titleableFields` | `CollectionField[]` | Fields that can be used as title |
+| `titleCollectionField` | `CollectionField` | Title field instance |
 
 ## Common Methods
 
 | Method | Description |
-|------|------|
-| `getFields(): CollectionField[]` | Get all fields (including inherited ones) |
-| `getField(name: string): CollectionField \| undefined` | Get a single field by field name |
-| `getFieldByPath(path: string): CollectionField \| undefined` | Get a field by path (supports associations, e.g., `user.name`) |
-| `getAssociationFields(types?): CollectionField[]` | Get association fields; `types` can be `['one']`, `['many']`, etc. |
-| `getFilterByTK(record): any` | Extract the primary key value from a record, used for the API's `filterByTk` |
+|--------|-------------|
+| `getFields(): CollectionField[]` | All fields (including inherited) |
+| `getField(name: string): CollectionField \| undefined` | Single field by name |
+| `getFieldByPath(path: string): CollectionField \| undefined` | Field by path (supports association, e.g. `user.name`) |
+| `getAssociationFields(types?): CollectionField[]` | Association fields; `types` e.g. `['one']`, `['many']` |
+| `getFilterByTK(record): any` | Primary key value from record for API `filterByTk` |
 
-## Relationship with ctx.collectionField and ctx.blockModel
+## Relation to ctx.collectionField, ctx.blockModel
 
-| Requirement | Recommended Usage |
-|------|----------|
-| **Collection associated with current context** | `ctx.collection` (equivalent to `ctx.blockModel?.collection` or `ctx.collectionField?.collection`) |
-| **Collection definition of the current field** | `ctx.collectionField?.collection` (the collection the field belongs to) |
-| **Association target collection** | `ctx.collectionField?.targetCollection` (the target collection of an association field) |
+| Need | Recommended |
+|------|-------------|
+| **Collection for current context** | `ctx.collection` (same as `ctx.blockModel?.collection` or `ctx.collectionField?.collection`) |
+| **Collection of current field** | `ctx.collectionField?.collection` |
+| **Target collection of association** | `ctx.collectionField?.targetCollection` |
 
-In scenarios like sub-tables, `ctx.collection` might be the association target collection; in standard forms/tables, it is usually the collection bound to the block.
+In sub-tables etc., `ctx.collection` may be the association target; in normal form/table it is usually the block’s collection.
 
 ## Examples
 
-### Get Primary Key and Open Popup
+### Get primary key and open popup
 
 ```ts
 const primaryKey = ctx.collection?.filterTargetKey ?? 'id';
@@ -66,7 +66,7 @@ await ctx.openView(popupUid, {
 });
 ```
 
-### Iterate Through Fields for Validation or Linkage
+### Iterate fields for validation or linkage
 
 ```ts
 const fields = ctx.collection?.getFields() ?? [];
@@ -80,21 +80,21 @@ for (const f of requiredFields) {
 }
 ```
 
-### Get Association Fields
+### Get association fields
 
 ```ts
 const oneToMany = ctx.collection?.getAssociationFields(['many']) ?? [];
-// Used for building sub-tables, associated resources, etc.
+// For sub-tables, association resources, etc.
 ```
 
 ## Notes
 
-- `filterTargetKey` is the primary key field name of the collection. Some collections may use a `string[]` for composite primary keys. If not configured, `'id'` is commonly used as a fallback.
-- In scenarios like **sub-tables or association fields**, `ctx.collection` may point to the association target collection, which differs from `ctx.blockModel.collection`.
-- `getFields()` merges fields from inherited collections; local fields override inherited fields with the same name.
+- `filterTargetKey` is the collection’s primary key field name; some collections use `string[]` composite keys; fallback is often `'id'`.
+- In **sub-tables, association fields**, `ctx.collection` may point to the association target, different from `ctx.blockModel.collection`.
+- `getFields()` merges inherited collection fields; local fields override inherited ones with the same name.
 
 ## Related
 
-- [ctx.collectionField](./collection-field.md): The collection field definition of the current field
-- [ctx.blockModel](./block-model.md): The parent block hosting the current JS, containing `collection`
-- [ctx.model](./model.md): The current model, which may contain `collection`
+- [ctx.collectionField](./collection-field.md): current field’s collection field definition
+- [ctx.blockModel](./block-model.md): parent block that hosts current JS; has `collection`
+- [ctx.model](./model.md): current model; may have `collection`

package/dist/ai/docs/runjs/context/data-source-manager.md

@@ -1,18 +1,18 @@
 # ctx.dataSourceManager
 
-The Data Source Manager (`DataSourceManager` instance) is used to manage and access multiple data sources (e.g., the main database `main`, logging database `logging`, etc.). It is used when multiple data sources exist or when cross-data source metadata access is required.
+The data source manager (`DataSourceManager` instance) for managing and accessing multiple data sources (e.g. main `main`, logging `logging`). Use when you have multiple data sources or need cross–data-source metadata access.
 
 ## Use Cases
 
 | Scenario | Description |
-|------|------|
-| **Multi-data source** | Enumerate all data sources, or get a specific data source by key. |
-| **Cross-data source access** | Access metadata using the "data source key + collection name" format when the data source of the current context is unknown. |
-| **Get fields by full path** | Use the `dataSourceKey.collectionName.fieldPath` format to retrieve field definitions across different data sources. |
+|----------|-------------|
+| **Multiple data sources** | Enumerate all data sources, get one by key |
+| **Cross–data-source access** | When context doesn’t know the data source, access by “data source key + collection name” |
+| **Field by full path** | Get field definition with path format `dataSourceKey.collectionName.fieldPath` |
 
-> Note: If you are only operating on the current data source, prioritize using `ctx.dataSource`. Use `ctx.dataSourceManager` only when you need to enumerate or switch between data sources.
+> Note: If you only work with the current data source, use `ctx.dataSource`; use `ctx.dataSourceManager` when you need to enumerate or switch data sources.
 
-## Type Definition
+## Type
 
 ```ts
 dataSourceManager: DataSourceManager;
@@ -20,74 +20,64 @@ dataSourceManager: DataSourceManager;
 class DataSourceManager {
   constructor();
 
-  // Data source management
   addDataSource(ds: DataSource | DataSourceOptions): void;
   upsertDataSource(ds: DataSource | DataSourceOptions): void;
   removeDataSource(key: string): void;
   clearDataSources(): void;
 
-  // Read data sources
-  getDataSources(): DataSource[];                     // Get all data sources
-  getDataSource(key: string): DataSource | undefined;  // Get data source by key
+  getDataSources(): DataSource[];
+  getDataSource(key: string): DataSource | undefined;
 
-  // Access metadata directly by data source + collection
   getCollection(dataSourceKey: string, collectionName: string): Collection | undefined;
   getCollectionField(fieldPathWithDataSource: string): CollectionField | undefined;
 }
 ```
 
-## Relationship with ctx.dataSource
+## Relation to ctx.dataSource
 
-| Requirement | Recommended Usage |
-|------|----------|
-| **Single data source bound to the current context** | `ctx.dataSource` (e.g., the data source of the current page/block) |
-| **Entry point for all data sources** | `ctx.dataSourceManager` |
+| Need | Recommended |
+|------|-------------|
+| **Single data source for context** | `ctx.dataSource` |
+| **Entry to all data sources** | `ctx.dataSourceManager` |
 | **List or switch data sources** | `ctx.dataSourceManager.getDataSources()` / `getDataSource(key)` |
-| **Get collection within the current data source** | `ctx.dataSource.getCollection(name)` |
-| **Get collection across data sources** | `ctx.dataSourceManager.getCollection(dataSourceKey, collectionName)` |
-| **Get field within the current data source** | `ctx.dataSource.getCollectionField('users.profile.avatar')` |
-| **Get field across data sources** | `ctx.dataSourceManager.getCollectionField('main.users.profile.avatar')` |
+| **Collection in current data source** | `ctx.dataSource.getCollection(name)` |
+| **Collection in another data source** | `ctx.dataSourceManager.getCollection(dataSourceKey, collectionName)` |
+| **Field in current data source** | `ctx.dataSource.getCollectionField('users.profile.avatar')` |
+| **Field across data sources** | `ctx.dataSourceManager.getCollectionField('main.users.profile.avatar')` |
 
 ## Examples
 
-### Get a Specific Data Source
+### Get a data source
 
 ```ts
-// Get the data source named 'main'
 const mainDS = ctx.dataSourceManager.getDataSource('main');
-
-// Get all collections under this data source
 const collections = mainDS?.getCollections();
 ```
 
-### Access Collection Metadata Across Data Sources
+### Cross–data-source collection metadata
 
 ```ts
-// Get collection by dataSourceKey + collectionName
 const users = ctx.dataSourceManager.getCollection('main', 'users');
 const orders = ctx.dataSourceManager.getCollection('main', 'orders');
 
-// Get the primary key of the collection
 const primaryKey = users?.filterTargetKey ?? 'id';
 ```
 
-### Get Field Definition by Full Path
+### Field by full path
 
 ```ts
 // Format: dataSourceKey.collectionName.fieldPath
-// Get field definition by "data source key.collection name.field path"
 const field = ctx.dataSourceManager.getCollectionField('main.users.profile.avatar');
 
-// Supports association field paths
 const userNameField = ctx.dataSourceManager.getCollectionField('main.orders.createdBy.name');
 ```
 
-### Iterate Through All Data Sources
+### Iterate all data sources
 
 ```ts
 const dataSources = ctx.dataSourceManager.getDataSources();
 for (const ds of dataSources) {
-  ctx.logger.info(`Data Source: ${ds.key}, Display Name: ${ds.displayName}`);
+  ctx.logger.info(`Data source: ${ds.key}, display: ${ds.displayName}`);
   const collections = ds.getCollections();
   for (const col of collections) {
     ctx.logger.info(`  - Collection: ${col.name}`);
@@ -95,7 +85,7 @@ for (const ds of dataSources) {
 }
 ```
 
-### Dynamically Select Data Source Based on Variables
+### Dynamic data source from variable
 
 ```ts
 const dsKey = ctx.getVar('dataSourceKey') ?? 'main';
@@ -109,12 +99,12 @@ if (col) {
 
 ## Notes
 
-- The path format for `getCollectionField` is `dataSourceKey.collectionName.fieldPath`, where the first segment is the data source key, followed by the collection name and the field path.
-- `getDataSource(key)` returns `undefined` if the data source does not exist; it is recommended to perform a null check before use.
-- `addDataSource` will throw an exception if the key already exists; `upsertDataSource` will either overwrite the existing one or add a new one.
+- `getCollectionField` path format is `dataSourceKey.collectionName.fieldPath`; first segment is data source key, then collection name and field path.
+- `getDataSource(key)` returns `undefined` if the data source doesn’t exist—check before use.
+- `addDataSource` throws if key already exists; `upsertDataSource` overwrites or adds.
 
 ## Related
 
-- [ctx.dataSource](./data-source.md): Current data source instance
-- [ctx.collection](./collection.md): Collection associated with the current context
-- [ctx.collectionField](./collection-field.md): Collection field definition for the current field
+- [ctx.dataSource](./data-source.md): current data source instance
+- [ctx.collection](./collection.md): collection for current context
+- [ctx.collectionField](./collection-field.md): current field’s collection field definition