@lotics/app-sdk 0.124.5 → 0.124.6
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/docs/queries.md +4 -5
- package/package.json +1 -1
package/docs/queries.md
CHANGED
|
@@ -42,9 +42,9 @@ several, each call a new version of the app:
|
|
|
42
42
|
(`text`, `number`, `boolean`, `date`, `datetime`, `email`, `select`, `member`, `record_link`,
|
|
43
43
|
`date_range`, `file`, `json`, `object`, `array`); each param may set `required: false`
|
|
44
44
|
(default is required) and `description`. Nesting is capped at depth 8.
|
|
45
|
-
- **`description`** — one line saying what the query returns
|
|
46
|
-
|
|
47
|
-
|
|
45
|
+
- **`description`** — one line saying what the query returns. No app code reads it: it is what
|
|
46
|
+
the **agents** that reach this app's data (its declared agents, a member's chat while the app is
|
|
47
|
+
open) read to choose between your aliases, its first 300 characters.
|
|
48
48
|
- **`templates`** — the document templates an `exportQuery` of this alias may fill, by the name
|
|
49
49
|
the export asks for: `{ "<name>": { "template_id": "dtl_…", "rows": "<key>" } }`. The template
|
|
50
50
|
is filled with `{ title, lines, readings, <key>: every row }`, each row keyed by output column —
|
|
@@ -64,8 +64,7 @@ query's reach (a token in a `table_id` or field-key position fails validation).
|
|
|
64
64
|
|
|
65
65
|
Binding fails — with the compiler's own message, never raw SQL/Postgres text — when any alias:
|
|
66
66
|
|
|
67
|
-
1. isn't a valid identifier, or the declaration isn't `{ ast, params?, description?, templates? }
|
|
68
|
-
description over 300 characters is refused here too);
|
|
67
|
+
1. isn't a valid identifier, or the declaration isn't `{ ast, params?, description?, templates? }`;
|
|
69
68
|
2. references `{{params.x}}` without declaring param `x` (typos can't silently widen);
|
|
70
69
|
3. doesn't parse as a `QueryNode` **as the raw template** (the runtime parses the stored
|
|
71
70
|
template before substitution, so a template that only parses after substitution would fail
|
package/package.json
CHANGED