@lotics/cli 0.321.15 → 0.321.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/cli.js +4 -4
- package/docs/workflow_steps.md +4 -3
- package/docs/workflows.md +2 -0
- package/docs/working_in_a_workspace.md +1 -1
- package/package.json +1 -1
package/docs/workflow_steps.md
CHANGED
|
@@ -2154,7 +2154,7 @@ above. A provider's refusal carries the provider's own words.
|
|
|
2154
2154
|
### get_record (workflow step)
|
|
2155
2155
|
|
|
2156
2156
|
- Fetch a single record with all field values.
|
|
2157
|
-
- Returns data (raw values) and display (human-readable labels).
|
|
2157
|
+
- Returns data (raw values) and display (human-readable labels); a workflow body's read carries `display`, `links`, `comment_count` and `units` only when the body reads them.
|
|
2158
2158
|
- A workspace admin's `as_member` fetches it as that member would see it.
|
|
2159
2159
|
- Cell shapes in `data`, keyed by field alias: select / member / link, and a formula with options, read back as arrays — a single-select as ["open"], the option's alias; one member as ["mbr_x"].
|
|
2160
2160
|
- A workflow body reads the same single-select, single-member or option-formula cell as the bare value, and a files cell as a list of file objects, each with id, filename and mime_type: `first(record.file).id` is the id a file tool takes.
|
|
@@ -2174,11 +2174,12 @@ above. A provider's refusal carries the provider's own words.
|
|
|
2174
2174
|
| Name | Type | Required | What it is |
|
|
2175
2175
|
| --- | --- | --- | --- |
|
|
2176
2176
|
| `id` | string | yes | |
|
|
2177
|
+
| `table_id` | string | yes | |
|
|
2177
2178
|
| `data` | object | yes | |
|
|
2178
|
-
| `display` | object |
|
|
2179
|
+
| `display` | object | | Human-readable display values for select, member, and record link fields. Omitted from a workflow read whose body never looks at it. |
|
|
2179
2180
|
| `links` | object | | Each link field's linked rows with the title the cell carries, by field alias; `data` holds their ids. |
|
|
2180
2181
|
| `locked` | boolean | | |
|
|
2181
|
-
| `comment_count` | number |
|
|
2182
|
+
| `comment_count` | number | | How many comments the record holds. Omitted from a workflow read whose body never looks at it. |
|
|
2182
2183
|
| `comments` | object[] | | With `comments: true`: the newest first. |
|
|
2183
2184
|
| `comments[].id` | string | yes | Unique identifier for the comment |
|
|
2184
2185
|
| `comments[].member_id` | string | yes | ID of the member who created this comment |
|
package/docs/workflows.md
CHANGED
|
@@ -111,6 +111,8 @@ The name in `const x = await tool({...})` is the step's id; later expressions re
|
|
|
111
111
|
`x.records`, `x.id` and so on. A `// id: my_step` comment directly above a statement sets an explicit
|
|
112
112
|
id; any other `//` comment there becomes the step's description.
|
|
113
113
|
|
|
114
|
+
A run reads a repeated identical record read once, until the run writes; a loop that waits for a row to change needs a `wait` step, or each pass sees the same rows.
|
|
115
|
+
|
|
114
116
|
**`await` inside a statement** runs the call as its own step first, then reads its output where it is
|
|
115
117
|
written: `size((await query_records({...})).records)`, an `if` test, a `return` value, a `for-of`
|
|
116
118
|
iterable, a tool input. `const x = c ? await t({...}) : null;` is stored as the `if` it means. An
|
|
@@ -29,7 +29,7 @@ Find the means in this order: `get_workspace` maps the workspace; `search` it by
|
|
|
29
29
|
|
|
30
30
|
## Comments
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
A record read carries `comment_count` (a workflow body gets it when it reads it). `query_records` takes `comments: true` to return the thread (`limit` defaults to 20, 20 at most). Comments are written by people, on the record in Lotics or through the product's chat.
|
|
33
33
|
|
|
34
34
|
## Deleting and restoring
|
|
35
35
|
|