@lotics/app-sdk 0.87.8 → 0.87.9
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/mutations.md +3 -6
- package/docs/runtime.md +2 -2
- package/package.json +1 -1
package/docs/mutations.md
CHANGED
|
@@ -153,8 +153,7 @@ envelope's grammar — `message` is required, `field_errors` never reaches the a
|
|
|
153
153
|
against those. So a producer — a workflow's `return({ data })`, an app agent's
|
|
154
154
|
`submit_result` — is handed the legal keys and cannot settle a label where a key belongs.
|
|
155
155
|
Prefer `field` for any select backed by a real field (the generated type tracks it, no
|
|
156
|
-
redeploy); use inline `options` for a fixed enum the app owns
|
|
157
|
-
**package** (a `field` form carries a concrete field id and can't ride a package contract).
|
|
156
|
+
redeploy); use inline `options` for a fixed enum the app owns.
|
|
158
157
|
- **Validated at run.** On a success return, the returned `data` is validated against the
|
|
159
158
|
schema at the app boundary — a mismatch resolves as `status: "error"` with a field-level
|
|
160
159
|
message, so a declared output is a real contract. An *error* return's `data` passes through
|
|
@@ -251,10 +250,8 @@ When the alias declares `inputs`, the server validates the payload before the wo
|
|
|
251
250
|
(`lotics app workflow set` / `set_app_workflow`; `lotics app deploy` never binds workflows) with
|
|
252
251
|
`select input references field "<key>", which does not exist in this workspace` /
|
|
253
252
|
`… which is a <type> field, not a select`. Prefer `field` for any select backed by a real
|
|
254
|
-
field; keep `options` for a fixed enum the app owns
|
|
255
|
-
|
|
256
|
-
the options before publishing. Populate pickers from `useFieldOptions` either way (the live
|
|
257
|
-
option set — see [members_and_options](./members_and_options.md)).
|
|
253
|
+
field; keep `options` for a fixed enum the app owns. Populate pickers from `useFieldOptions`
|
|
254
|
+
either way (the live option set — see [members_and_options](./members_and_options.md)).
|
|
258
255
|
|
|
259
256
|
If the alias declares **no** `inputs`, the payload passes through opaquely — no validation,
|
|
260
257
|
no typing, no reference binding. Fine for a zero-input action; declare inputs for anything
|
package/docs/runtime.md
CHANGED
|
@@ -24,7 +24,7 @@ mount(<App />);
|
|
|
24
24
|
`dist/src/mount.d.ts`) is called **once** from the app's entry file. It:
|
|
25
25
|
|
|
26
26
|
1. **Registers the mock fixture**, if `options.fixture` was passed (below).
|
|
27
|
-
2. **Finds or creates `#root`.** Uses the `<div id="root">` from the
|
|
27
|
+
2. **Finds or creates `#root`.** Uses the `<div id="root">` from the scaffold's
|
|
28
28
|
`index.html`; if the bundler didn't ship one, it creates and appends it.
|
|
29
29
|
3. **Installs visible error handlers.** `window` `error` and
|
|
30
30
|
`unhandledrejection` listeners render a fixed red monospace banner (message +
|
|
@@ -179,7 +179,7 @@ surfaces:
|
|
|
179
179
|
|
|
180
180
|
| Op | Embedded (product) | `lotics app dev` | Standalone |
|
|
181
181
|
|---|---|---|---|
|
|
182
|
-
| `query`, `field_options`, `workflow`, `members`, `context`, `
|
|
182
|
+
| `query`, `field_options`, `workflow`, `members`, `context`, `upload`, `urlState.get/set`, `openExternal` | yes | yes | yes |
|
|
183
183
|
| `comments.*` | yes | yes | rejects — `"Comments are available only in embedded apps — a signed-in member is required."` |
|
|
184
184
|
| `agentRun` (streaming, internal to `useAgentRun`) | yes | yes | yes |
|
|
185
185
|
| `agentRun.get`, `agentRun.cancel` | yes | **no** — the dev forwarder doesn't implement them (`"Unknown RPC op: …"`) | yes |
|