@nocobase/plugin-flow-engine 2.1.0-beta.2 → 2.1.0-beta.20

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

@@ -1,18 +1,18 @@
 # ctx.collectionField
 
-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`.
+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`.
 
 ## Use Cases
 
 | Scenario | Description |
-|----------|-------------|
-| **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` |
+|------|------|
+| **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. |
 
-> 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.
+> 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.
 
-## Type
+## Type Definition
 
 ```ts
 collectionField: CollectionField | null | undefined;
@@ -21,46 +21,47 @@ collectionField: CollectionField | null | undefined;
 ## Common Properties
 
 | Property | Type | Description |
-|----------|------|-------------|
-| `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.) |
+|------|------|------|
+| `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.) |
 | `defaultValue` | `any` | Default value |
-| `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) |
+| `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) |
 
 ## Common Methods
 
 | Method | Description |
-|--------|-------------|
-| `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`) |
+|------|------|
+| `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.) |
 
 ## Examples
 
-### Branch by field type
+### Branch rendering based on 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') {
@@ -69,24 +70,24 @@ if (['m2o', 'o2m', 'm2m'].includes(iface)) {
 }
 ```
 
-### Check association and use target collection
+### Determine if it is an association field and access the 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 enum options
+### Get enumeration options
 
 ```ts
 const options = ctx.collectionField?.enum ?? [];
 const labels = options.map((o) => (typeof o === 'object' ? o.label : o));
 ```
 
-### Conditional render by readonly
+### Conditional rendering based on read-only/view mode
 
 ```ts
 const { Input } = ctx.libs.antd;
@@ -97,34 +98,35 @@ if (ctx.collectionField?.readonly) {
 }
 ```
 
-### Title field of target collection
+### Get the title field of the 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];
 ```
 
-## Relation to ctx.collection
+## Relationship with ctx.collection
 
-| Need | Recommended |
-|------|-------------|
-| **Collection of current field** | `ctx.collectionField?.collection` or `ctx.collection` |
+| Requirement | Recommended Usage |
+|------|----------|
+| **Current field's collection** | `ctx.collectionField?.collection` or `ctx.collection` |
 | **Field metadata (name, type, interface, enum, etc.)** | `ctx.collectionField` |
 | **Target collection** | `ctx.collectionField?.targetCollection` |
 
-`ctx.collection` is usually the block’s collection; `ctx.collectionField` is the field definition; they can differ in sub-tables and associations.
+`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.
 
 ## Notes
 
-- 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.
+- 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.
 
 ## Related
 
-- [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
+- [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

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

@@ -1,18 +1,18 @@
 # ctx.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`.
+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`.
 
 ## Use Cases
 
 | Scenario | Description |
-|----------|-------------|
-| **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. |
+|------|------|
+| **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. |
 
-> 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.
+> 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.
 
-## Type
+## Type Definition
 
 ```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 (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 |
+|------|------|------|
+| `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 |
 
 ## Common Methods
 
 | Method | Description |
-|--------|-------------|
-| `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` |
+|------|------|
+| `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` |
 
-## Relation to ctx.collectionField, ctx.blockModel
+## Relationship with ctx.collectionField and ctx.blockModel
 
-| 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` |
+| 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) |
 
-In sub-tables etc., `ctx.collection` may be the association target; in normal form/table it is usually the block’s collection.
+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.
 
 ## 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 fields for validation or linkage
+### Iterate Through 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']) ?? [];
-// For sub-tables, association resources, etc.
+// Used for building sub-tables, associated resources, etc.
 ```
 
 ## Notes
 
-- `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.
+- `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.
 
 ## Related
 
-- [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`
+- [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`

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

@@ -1,18 +1,18 @@
 # ctx.dataSourceManager
 
-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.
+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.
 
 ## Use Cases
 
 | Scenario | Description |
-|----------|-------------|
-| **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` |
+|------|------|
+| **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. |
 
-> 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.
+> 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.
 
-## Type
+## Type Definition
 
 ```ts
 dataSourceManager: DataSourceManager;
@@ -20,64 +20,74 @@ dataSourceManager: DataSourceManager;
 class DataSourceManager {
   constructor();
 
+  // Data source management
   addDataSource(ds: DataSource | DataSourceOptions): void;
   upsertDataSource(ds: DataSource | DataSourceOptions): void;
   removeDataSource(key: string): void;
   clearDataSources(): void;
 
-  getDataSources(): DataSource[];
-  getDataSource(key: string): DataSource | undefined;
+  // Read data sources
+  getDataSources(): DataSource[];                     // Get all data sources
+  getDataSource(key: string): DataSource | undefined;  // Get data source by key
 
+  // Access metadata directly by data source + collection
   getCollection(dataSourceKey: string, collectionName: string): Collection | undefined;
   getCollectionField(fieldPathWithDataSource: string): CollectionField | undefined;
 }
 ```
 
-## Relation to ctx.dataSource
+## Relationship with ctx.dataSource
 
-| Need | Recommended |
-|------|-------------|
-| **Single data source for context** | `ctx.dataSource` |
-| **Entry to all data sources** | `ctx.dataSourceManager` |
+| 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` |
 | **List or switch data sources** | `ctx.dataSourceManager.getDataSources()` / `getDataSource(key)` |
-| **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')` |
+| **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')` |
 
 ## Examples
 
-### Get a data source
+### Get a Specific 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();
 ```
 
-### Cross–data-source collection metadata
+### Access Collection Metadata Across Data Sources
 
 ```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';
 ```
 
-### Field by full path
+### Get Field Definition 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 all data sources
+### Iterate Through All Data Sources
 
 ```ts
 const dataSources = ctx.dataSourceManager.getDataSources();
 for (const ds of dataSources) {
-  ctx.logger.info(`Data source: ${ds.key}, display: ${ds.displayName}`);
+  ctx.logger.info(`Data Source: ${ds.key}, Display Name: ${ds.displayName}`);
   const collections = ds.getCollections();
   for (const col of collections) {
     ctx.logger.info(`  - Collection: ${col.name}`);
@@ -85,7 +95,7 @@ for (const ds of dataSources) {
 }
 ```
 
-### Dynamic data source from variable
+### Dynamically Select Data Source Based on Variables
 
 ```ts
 const dsKey = ctx.getVar('dataSourceKey') ?? 'main';
@@ -99,12 +109,12 @@ if (col) {
 
 ## Notes
 
-- `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.
+- 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.
 
 ## Related
 
-- [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
+- [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

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

@@ -1,18 +1,18 @@
 # ctx.dataSource
 
-The data source instance (`DataSource`) bound to the current RunJS context; used to access collections, field metadata, and collection config **within that data source**. Usually the current page/block’s data source (e.g. main `main`).
+The `DataSource` instance bound to the current RunJS execution context, used to access collections, field metadata, and manage collection configurations **within the current data source**. It usually corresponds to the data source selected for the current page or block (e.g., the main database `main`).
 
 ## Use Cases
 
 | Scenario | Description |
-|----------|-------------|
-| **Single data source** | Get collections, field metadata when the current data source is known |
-| **Collection management** | Get/add/update/remove collections in the current data source |
-| **Field by path** | Get field definition by `collectionName.fieldPath` (supports association path) |
+|------|------|
+| **Single Data Source Operations** | Get collection and field metadata when the current data source is known. |
+| **Collection Management** | Get, add, update, or delete collections under the current data source. |
+| **Get Fields by Path** | Use the `collectionName.fieldPath` format to get field definitions (supports association paths). |
 
-> Note: `ctx.dataSource` is the single data source for the current context; to enumerate or access other data sources use [ctx.dataSourceManager](./data-source-manager.md).
+> Note: `ctx.dataSource` represents a single data source for the current context. To enumerate or access other data sources, please use [ctx.dataSourceManager](./data-source-manager.md).
 
-## Type
+## Type Definition
 
 ```ts
 dataSource: DataSource;
@@ -20,15 +20,18 @@ dataSource: DataSource;
 class DataSource {
   constructor(options?: Record<string, any>);
 
-  get flowEngine(): FlowEngine;
-  get displayName(): string;
-  get key(): string;
-  get name(): string;
+  // Read-only properties
+  get flowEngine(): FlowEngine;   // Current FlowEngine instance
+  get displayName(): string;      // Display name (supports i18n)
+  get key(): string;              // Data source key, e.g., 'main'
+  get name(): string;             // Same as key
 
-  getCollections(): Collection[];
-  getCollection(name: string): Collection | undefined;
-  getAssociation(associationName: string): CollectionField | undefined;
+  // Collection reading
+  getCollections(): Collection[];                      // Get all collections
+  getCollection(name: string): Collection | undefined; // Get collection by name
+  getAssociation(associationName: string): CollectionField | undefined; // Get association field (e.g., users.roles)
 
+  // Collection management
   addCollection(collection: Collection | CollectionOptions): void;
   updateCollection(newOptions: CollectionOptions): void;
   upsertCollection(options: CollectionOptions): Collection | undefined;
@@ -36,6 +39,7 @@ class DataSource {
   removeCollection(name: string): void;
   clearCollections(): void;
 
+  // Field metadata
   getCollectionField(fieldPath: string): CollectionField | undefined;
 }
 ```
@@ -43,57 +47,61 @@ class DataSource {
 ## Common Properties
 
 | Property | Type | Description |
-|----------|------|-------------|
-| `key` | `string` | Data source key (e.g. `main`) |
+|------|------|------|
+| `key` | `string` | Data source key, e.g., `'main'` |
 | `name` | `string` | Same as key |
-| `displayName` | `string` | Display name (i18n) |
+| `displayName` | `string` | Display name (supports i18n) |
 | `flowEngine` | `FlowEngine` | Current FlowEngine instance |
 
 ## Common Methods
 
 | Method | Description |
-|--------|-------------|
-| `getCollections()` | All collections in this data source (sorted, hidden filtered) |
-| `getCollection(name)` | Collection by name; `name` can be `collectionName.fieldName` for association target |
-| `getAssociation(associationName)` | Association field by `collectionName.fieldName` |
-| `getCollectionField(fieldPath)` | Field by `collectionName.fieldPath`; supports paths like `users.profile.avatar` |
+|------|------|
+| `getCollections()` | Gets all collections under the current data source (sorted, with hidden ones filtered). |
+| `getCollection(name)` | Gets a collection by name; `name` can be `collectionName.fieldName` to get the target collection of an association. |
+| `getAssociation(associationName)` | Gets an association field definition by `collectionName.fieldName`. |
+| `getCollectionField(fieldPath)` | Gets a field definition by `collectionName.fieldPath`, supporting association paths like `users.profile.avatar`. |
 
-## Relation to ctx.dataSourceManager
+## Relationship with ctx.dataSourceManager
 
-| Need | Recommended |
-|------|-------------|
-| **Single data source for context** | `ctx.dataSource` |
-| **Entry to all data sources** | `ctx.dataSourceManager` |
-| **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')` |
+| Requirement | Recommended Usage |
+|------|----------|
+| **Single data source bound to current context** | `ctx.dataSource` |
+| **Entry point for all data sources** | `ctx.dataSourceManager` |
+| **Get collection within current data source** | `ctx.dataSource.getCollection(name)` |
+| **Get collection across data sources** | `ctx.dataSourceManager.getCollection(dataSourceKey, collectionName)` |
+| **Get field within current data source** | `ctx.dataSource.getCollectionField('users.profile.avatar')` |
+| **Get field across data sources** | `ctx.dataSourceManager.getCollectionField('main.users.profile.avatar')` |
 
-## Examples
+## Example
 
-### Get collections and fields
+### Get Collections and Fields
 
 ```ts
+// Get all collections
 const collections = ctx.dataSource.getCollections();
 
+// Get collection by name
 const users = ctx.dataSource.getCollection('users');
 const primaryKey = users?.filterTargetKey ?? 'id';
 
+// Get field definition by "collectionName.fieldPath" (supports associations)
 const field = ctx.dataSource.getCollectionField('users.profile.avatar');
 const userNameField = ctx.dataSource.getCollectionField('orders.createdBy.name');
 ```
 
-### Get association field
+### Get Association Fields
 
 ```ts
+// Get association field definition by collectionName.fieldName
 const rolesField = ctx.dataSource.getAssociation('users.roles');
 if (rolesField?.isAssociationField()) {
   const targetCol = rolesField.targetCollection;
-  // ...
+  // Process based on target collection structure
 }
 ```
 
-### Iterate collections
+### Iterate Through Collections for Dynamic Processing
 
 ```ts
 const collections = ctx.dataSource.getCollections();
@@ -104,25 +112,25 @@ for (const col of collections) {
 }
 ```
 
-### Validation or dynamic UI from field metadata
+### Perform Validation or Dynamic UI Based on Field Metadata
 
 ```ts
 const field = ctx.dataSource.getCollectionField('users.status');
 if (field) {
   const options = field.enum ?? [];
   const operators = field.getFilterOperators();
-  // ...
+  // Perform UI logic or validation based on interface, enum, validation, etc.
 }
 ```
 
 ## Notes
 
-- `getCollectionField(fieldPath)` uses path format `collectionName.fieldPath`; first segment is collection name, rest is field path (supports association, e.g. `user.name`).
-- `getCollection(name)` supports `collectionName.fieldName` and returns the association target collection.
-- In RunJS, `ctx.dataSource` is usually determined by the current block/page; if there is no bound data source it may be `undefined`—check before use.
+- The path format for `getCollectionField(fieldPath)` is `collectionName.fieldPath`, where the first segment is the collection name and the subsequent segments are the field path (supports associations, e.g., `user.name`).
+- `getCollection(name)` supports the `collectionName.fieldName` format, returning the target collection of the association field.
+- In the RunJS context, `ctx.dataSource` is usually determined by the data source of the current block or page. If no data source is bound to the context, it may be `undefined`; it is recommended to perform a null check before use.
 
 ## Related
 
-- [ctx.dataSourceManager](./data-source-manager.md): manager for all data sources
-- [ctx.collection](./collection.md): collection for current context
-- [ctx.collectionField](./collection-field.md): current field’s collection field definition
+- [ctx.dataSourceManager](./data-source-manager.md): Data source manager, manages all data sources.
+- [ctx.collection](./collection.md): The collection associated with the current context.
+- [ctx.collectionField](./collection-field.md): The collection field definition for the current field.