Merge pull request #86 from nocodb/docs/script-corrections

Author: DarkPhoenix2704

content/scripts/api-reference/base.mdx

@@ -16,11 +16,11 @@ In every script, you have access to a global `base` object that represents the c
 
 ## Properties
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `id` | `string` | The unique identifier of the base |
-| `name` | `string` | The name of the base |
-| `tables` | `Table[]` | Array of all tables in the base with their fields and views |
+| Property              | Type             | Description                                                                          |
+|-----------------------|------------------|--------------------------------------------------------------------------------------|
+| `id`                  | `string`         | The unique identifier of the base                                                    |
+| `name`                | `string`         | The name of the base                                                                 |
+| `tables`              | `Table[]`        | Array of all tables in the base with their fields and views                          |
 | `activeCollaborators` | `Collaborator[]` | Array of active collaborators having access to this base (with read-only properties) |
 
 ## Methods
@@ -47,7 +47,7 @@ Both the table name and table ID are case-sensitive.
 const projects = base.getTable('Projects');
 
 // Get a table by ID
-const tasks = base.getTable('tbl123456789');
+const tasks = base.getTable('m123456789');
 
 // Check if a table exists
 const tableName = 'Customers';
@@ -222,7 +222,7 @@ if (teamMember) {
 }
 
 // You can also search by ID or name
-const memberById = base.getCollaborator('usr_123456');
+const memberById = base.getCollaborator('u123456789'); // Replace with actual ID
 const memberByName = base.getCollaborator('John Doe');
 
 // getCollaborator returns null if no match is found

content/scripts/api-reference/collaborator.mdx

@@ -19,11 +19,11 @@ This object enables user identification, tracking ownership, assigning responsib
 
 ## Properties
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `id` | `string` | The unique identifier of the collaborator (read-only) |
-| `name` | `string \| null` | The display name of the collaborator (read-only, may be null if not set) |
-| `email` | `string` | The email address of the collaborator (read-only) |
+| Property | Type             | Description                                                              |
+|----------|------------------|--------------------------------------------------------------------------|
+| `id`     | `string`         | The unique identifier of the collaborator (read-only)                    |
+| `name`   | `string \| null` | The display name of the collaborator (read-only, may be null if not set) |
+| `email`  | `string`         | The email address of the collaborator (read-only)                        |
 
 **Note:** All Collaborator properties are read-only and cannot be modified.
 
@@ -80,7 +80,7 @@ When a table has a User field type, `getCellValue()` returns a Collaborator obje
 ```javascript
 // Get a record from the Tasks table
 const tasksTable = base.getTable('Tasks');
-const taskRecord = await tasksTable.selectRecordAsync('rec123456');
+const taskRecord = await tasksTable.selectRecordAsync('123');
 
 // Get the assigned user (assuming 'Assigned To' is a User field)
 const assignedTo = taskRecord.getCellValue('Assigned To');
@@ -113,7 +113,7 @@ The `CreatedBy` and `LastModifiedBy` field types return Collaborator objects:
 ```javascript
 // Get a record with system user fields
 const recordsTable = base.getTable('Documents');
-const document = await recordsTable.selectRecordAsync('rec123456');
+const document = await recordsTable.selectRecordAsync('123');
 
 // Get the user who created the record
 const createdBy = document.getCellValue('Created By');

content/scripts/api-reference/cursor.mdx

@@ -19,12 +19,12 @@ This contextual awareness helps you create scripts that respond intelligently to
 
 ## Properties
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `activeBaseId` | `string` | The ID of the currently active base |
-| `activeTableId` | `string \| null` | The ID of the currently active table, or `null` if no table is active |
-| `activeViewId` | `string \| null` | The ID of the currently active view, or `null` if no view is active |
-| `row` | `Record < string, unknown > \| null` | The data of the currently selected row, or `null` if no row is selected |
+| Property        | Type                                 | Description                                                             |
+|-----------------|--------------------------------------|-------------------------------------------------------------------------|
+| `activeBaseId`  | `string`                             | The ID of the currently active base                                     |
+| `activeTableId` | `string \| null`                     | The ID of the currently active table, or `null` if no table is active   |
+| `activeViewId`  | `string \| null`                     | The ID of the currently active view, or `null` if no view is active     |
+| `row`           | `Record < string, unknown > \| null` | The data of the currently selected row, or `null` if no row is selected |
 
 ## Usage Examples
 

content/scripts/api-reference/field.mdx

@@ -19,14 +19,14 @@ NocoDB supports a wide variety of field types to accommodate different kinds of
 
 All Field objects share these common properties:
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `id` | `string` | The unique identifier of the field |
-| `name` | `string` | The display name of the field |
-| `type` | `UITypes` | The type of the field (e.g., SingleLineText, Number, Date) |
-| `description` | `string \| null` | The description of the field (if any) |
-| `isComputed` | `boolean` | Whether the field value is computed rather than directly editable |
-| `options` | `object \| null` | Type-specific options for the field |
+| Property      | Type             | Description                                                       |
+|---------------|------------------|-------------------------------------------------------------------|
+| `id`          | `string`         | The unique identifier of the field                                |
+| `name`        | `string`         | The display name of the field                                     |
+| `type`        | `UITypes`        | The type of the field (e.g., SingleLineText, Number, Date)        |
+| `description` | `string \| null` | The description of the field (if any)                             |
+| `isComputed`  | `boolean`        | Whether the field value is computed rather than directly editable |
+| `options`     | `object \| null` | Type-specific options for the field                               |
 
 ## Common Methods
 
@@ -633,7 +633,7 @@ const reviewers = record.getCellValue('Reviewers');
 const statusField = projectsTable.getField('Status');
 
 // Get a field by ID
-const titleField = projectsTable.getField('fld123456');
+const titleField = projectsTable.getField('c123456');
 
 // Check field properties
 if (statusField) {

content/scripts/api-reference/input.mdx

@@ -39,6 +39,9 @@ const subject = await input.textAsync('Enter email subject:');
 output.text(`Email subject: ${subject}`);
 ```
 
+**Output:**
+![Text Input Example](/img/v2/scripts/input-text-1.png)
+
 ### input.buttonsAsync()
 
 Presents the user with buttons to choose from.
@@ -64,6 +67,9 @@ const status = await input.buttonsAsync(
 output.text(`Selected status: ${status}`);
 ```
 
+**Output:**
+![Button Input Example](/img/v2/scripts/input-button-1.png)
+
 **Example with button options:**
 ```javascript
 // Ask for confirmation with styled buttons
@@ -83,6 +89,9 @@ if (confirmation) {
 }
 ```
 
+**Output:**
+![Button Input Example](/img/v2/scripts/input-button-2.png)
+
 ### input.selectAsync()
 
 Presents a dropdown menu of options for the user to choose from.
@@ -103,6 +112,9 @@ const department = await input.selectAsync(
 output.text(`Selected department: ${department}`);
 ```
 
+**Output:**
+![Select Input Example](/img/v2/scripts/input-select-1.png)
+
 **Example with label/value objects:**
 ```javascript
 // Ask user to select a priority level
@@ -117,6 +129,9 @@ const priority = await input.selectAsync(
 output.text(`Selected priority level: ${priority}`);
 ```
 
+**Output:**
+![Select Input Example](/img/v2/scripts/input-select-2.png)
+
 ### input.fileAsync()
 
 Prompts the user to upload a file.
@@ -150,6 +165,9 @@ if (result && result.parsedContents) {
 }
 ```
 
+**Output:**
+![File Input Example](/img/v2/scripts/input-file-1.png)
+
 ### input.tableAsync()
 
 Prompts the user to select a table from the base.
@@ -172,6 +190,9 @@ for (const field of table.fields) {
 }
 ```
 
+**Output:**
+![Table Input Example](/img/v2/scripts/input-table-1.png)
+
 ### input.viewAsync()
 
 Prompts the user to select a view from a specified table.
@@ -196,6 +217,9 @@ const records = await view.selectRecordsAsync();
 output.text(`This view contains ${records.records.length} records.`);
 ```
 
+**Output:**
+![View Input Example](/img/v2/scripts/input-view-1.png)
+
 ### input.fieldAsync()
 
 Prompts the user to select a field from a specified table.
@@ -231,6 +255,9 @@ for (const record of records.records) {
 output.text(`The field "${field.name}" has values in ${nonEmptyCount} out of ${records.records.length} records.`);
 ```
 
+**Output:**
+![Field Input Example](/img/v2/scripts/input-field-1.png)
+
 ### input.recordAsync()
 
 Prompts the user to select a record from a table, view, or set of records.
@@ -270,6 +297,9 @@ if (record) {
 }
 ```
 
+**Output:**
+![Record Input Example](/img/v2/scripts/input-record-1.png)
+
 ## Practical Examples
 
 ### Form-Based Data Entry

content/scripts/api-reference/output.mdx

@@ -37,6 +37,9 @@ output.text(`Records processed: ${recordCount}`);
 output.text(`Success: ${isSuccess}`);
 ```
 
+**Output:**
+![output.text example](/img/v2/scripts/output-text.png)
+
 ### output.markdown()
 
 Renders text with Markdown formatting.
@@ -75,6 +78,9 @@ output.markdown('## Example Query\n\n' +
   '```');
 ```
 
+**Output:**
+![output.markdown example](/img/v2/scripts/output-markdown.png)
+
 ### output.table()
 
 Displays data in a formatted table.
@@ -104,6 +110,9 @@ const summary = {
 output.table(summary);
 ```
 
+**Output:**
+![output.table example](/img/v2/scripts/output-table.png)
+
 ### output.inspect()
 
 Displays an object in an expandable, interactive format for inspection.
@@ -165,6 +174,9 @@ const projectData = {
 output.inspect(projectData);
 ```
 
+**Output:**
+![output.inspect example](/img/v2/scripts/output-inspect.png)
+
 ### output.clear()
 
 Clears all previous output content.

content/scripts/api-reference/record-query-result.mdx

@@ -20,13 +20,13 @@ The RecordQueryResult object is designed to help you work efficiently with query
 
 ## Properties
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `records` | `ReadonlyArray<NocoDBRecord>` | Array of NocoDBRecord objects returned by the query |
-| `recordIds` | `ReadonlyArray<string>` | Array of record IDs (strings) returned by the query |
-| `hasMoreRecords` | `boolean` | Whether there are more records available beyond what was returned |
-| `table` | `Table` | Reference to the table from which records were queried |
-| `raw_data` | `Array` | The raw underlying data from the API response |
+| Property         | Type                          | Description                                                       |
+|------------------|-------------------------------|-------------------------------------------------------------------|
+| `records`        | `ReadonlyArray<NocoDBRecord>` | Array of NocoDBRecord objects returned by the query               |
+| `recordIds`      | `ReadonlyArray<string>`       | Array of record IDs (strings) returned by the query               |
+| `hasMoreRecords` | `boolean`                     | Whether there are more records available beyond what was returned |
+| `table`          | `Table`                       | Reference to the table from which records were queried            |
+| `raw_data`       | `Array`                       | The raw underlying data from the API response                     |
 
 ## Methods
 

content/scripts/api-reference/record.mdx

@@ -19,10 +19,10 @@ Working with NocoDBRecord objects is central to most NocoDB scripts, as they all
 
 ## Properties
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `id` | `string` | The unique identifier for this record |
-| `name` | `string` | The primary display value for this record (derived from display field) |
+| Property | Type     | Description                                                            |
+|----------|----------|------------------------------------------------------------------------|
+| `id`     | `string` | The unique identifier for this record                                  |
+| `name`   | `string` | The primary display value for this record (derived from display field) |
 
 ## Methods
 
@@ -43,7 +43,7 @@ Retrieves the value of a specific cell in the record.
 const projectsTable = base.getTable('Projects');
 
 // Query a specific record
-const projectRecord = await projectsTable.selectRecordAsync('rec123456');
+const projectRecord = await projectsTable.selectRecordAsync('123');
 
 if (projectRecord) {
   // Get cell values using field names
@@ -86,7 +86,7 @@ Gets a cell value formatted as a string, applying appropriate formatting based o
 const invoicesTable = base.getTable('Invoices');
 
 // Query a specific record
-const invoiceRecord = await invoicesTable.selectRecordAsync('rec123456');
+const invoiceRecord = await invoicesTable.selectRecordAsync('123');
 
 if (invoiceRecord) {
   // Get formatted string values
@@ -279,7 +279,7 @@ const taskCount = record.getCellValue('Task Count'); // number or null
 const tasksTable = base.getTable('Tasks');
 
 // Get a specific record
-const taskRecord = await tasksTable.selectRecordAsync('rec123456', {
+const taskRecord = await tasksTable.selectRecordAsync('123', {
   fields: ['Task Name', 'Description', 'Status', 'Due Date', 'Assigned To', 'Priority']
 });
 
@@ -319,8 +319,8 @@ if (taskRecord) {
 const employeesTable = base.getTable('Employees');
 
 // Get two employee records
-const employee1 = await employeesTable.selectRecordAsync('rec123456');
-const employee2 = await employeesTable.selectRecordAsync('rec789012');
+const employee1 = await employeesTable.selectRecordAsync('123');
+const employee2 = await employeesTable.selectRecordAsync('456');
 
 if (employee1 && employee2) {
   // Compare salary values

content/scripts/api-reference/script-settings.mdx

@@ -59,11 +59,11 @@ output.text(`Processing limit: ${limit}`);
 
 The `input.config()` method accepts a configuration object with the following properties:
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
-| `title` | `string` | Title of the script, displayed at the top of the settings form |
-| `description` | `string` | Description of what the script does (supports some markdown) |
-| `items` | `Array<ConfigItem>` | Array of configuration items for the settings form |
+| Property      | Type                | Description                                                    |
+|---------------|---------------------|----------------------------------------------------------------|
+| `title`       | `string`            | Title of the script, displayed at the top of the settings form |
+| `description` | `string`            | Description of what the script does (supports some markdown)   |
+| `items`       | `Array<ConfigItem>` | Array of configuration items for the settings form             |
 
 ### Configuration Item Types
 

content/scripts/api-reference/session.mdx

@@ -14,8 +14,8 @@ The `session` object is available in every NocoDB script and provides a way to:
 
 ## Properties
 
-| Property | Type | Description |
-| -------- | ---- | ----------- |
+| Property      | Type           | Description                                                                        |
+|---------------|----------------|------------------------------------------------------------------------------------|
 | `currentUser` | `Collaborator` | A Collaborator object representing the current user running the script (read-only) |
 
 ## Usage Examples