@lotics/cli 0.318.36 → 0.318.38

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 CHANGED
@@ -233,6 +233,54 @@ var LoticsRequestError = class extends Error {
233
233
  body;
234
234
  telemetryMessage;
235
235
  };
236
+ var OutcomeUnknownError = class extends Error {
237
+ constructor(waited, request_id, cause) {
238
+ super(
239
+ `No answer from the server ${waited}, so this call cannot say whether it took effect. Read the records before running it again. Request id: ${request_id}.`,
240
+ { cause }
241
+ );
242
+ this.request_id = request_id;
243
+ this.name = "OutcomeUnknownError";
244
+ }
245
+ request_id;
246
+ error_code = "outcome_unknown";
247
+ };
248
+ var NoAnswerError = class extends Error {
249
+ constructor(waited, request_id, cause) {
250
+ super(
251
+ `No answer from ${request_id === void 0 ? "storage" : "the server"} ${waited}. This call only reads, so nothing changed.${request_id === void 0 ? "" : ` Request id: ${request_id}.`}`,
252
+ { cause }
253
+ );
254
+ this.request_id = request_id;
255
+ this.name = "NoAnswerError";
256
+ }
257
+ request_id;
258
+ };
259
+ async function fetchStorage(url2, timeoutMs, read) {
260
+ try {
261
+ return await read(await fetch(url2, timeoutMs === void 0 ? {} : { signal: AbortSignal.timeout(timeoutMs) }));
262
+ } catch (error62) {
263
+ if (error62 instanceof Error && error62.name === "TimeoutError" && timeoutMs !== void 0) {
264
+ throw new NoAnswerError(`within ${timeoutMs / 1e3}s`, void 0, error62);
265
+ }
266
+ throw error62;
267
+ }
268
+ }
269
+ var NEVER_SENT_CODES = /* @__PURE__ */ new Set([
270
+ "ENOTFOUND",
271
+ "ECONNREFUSED",
272
+ "EAI_AGAIN",
273
+ "UND_ERR_CONNECT_TIMEOUT",
274
+ "CERT_HAS_EXPIRED",
275
+ "UNABLE_TO_VERIFY_LEAF_SIGNATURE",
276
+ "DEPTH_ZERO_SELF_SIGNED_CERT",
277
+ "SELF_SIGNED_CERT_IN_CHAIN",
278
+ "UNABLE_TO_GET_ISSUER_CERT_LOCALLY",
279
+ "ERR_TLS_CERT_ALTNAME_INVALID"
280
+ ]);
281
+ function errorCode(cause) {
282
+ return typeof cause === "object" && cause !== null && "code" in cause && typeof cause.code === "string" ? cause.code : void 0;
283
+ }
236
284
  var WEB_APP_URL = process.env.LOTICS_WEB_URL ?? "https://lotics.ai";
237
285
  var PUBLIC_FETCH_TIMEOUT_MS = 1e4;
238
286
  async function startCliLogin(apiUrl, email3) {
@@ -285,7 +333,9 @@ var LoticsClient = class {
285
333
  workspaceId;
286
334
  /** The instance this client sends every request to. */
287
335
  baseUrl;
336
+ timeoutMs;
288
337
  constructor(options) {
338
+ this.timeoutMs = options.timeoutMs;
289
339
  this.apiKey = options.apiKey;
290
340
  this.workspaceId = options.workspaceId;
291
341
  this.baseUrl = options.apiUrl;
@@ -302,7 +352,20 @@ var LoticsClient = class {
302
352
  * logs. Every call against the API passes the id its own headers carry.
303
353
  */
304
354
  async throwResponseError(response, requestId) {
305
- const text = await response.text();
355
+ const trace = requestId === void 0 ? "" : `
356
+
357
+ Request id: ${requestId} \u2014 quote this to Lotics support.`;
358
+ let text;
359
+ try {
360
+ text = await response.text();
361
+ } catch (readError) {
362
+ throw new LoticsRequestError(
363
+ `${response.status}: the server refused with HTTP ${response.status} and its error body could not be read (${readError instanceof Error ? readError.message : String(readError)})${trace}`,
364
+ response.status,
365
+ {},
366
+ `${response.status}: ${telemetryErrorMessage(response.status, {})}${trace}`
367
+ );
368
+ }
306
369
  let body = {};
307
370
  try {
308
371
  const json2 = JSON.parse(text);
@@ -313,9 +376,6 @@ var LoticsClient = class {
313
376
  const message = typeof body.message === "string" ? body.message : unparsedAnswer(text);
314
377
  const hint = typeof body.hint === "string" ? `
315
378
  ${body.hint}` : "";
316
- const trace = requestId === void 0 ? "" : `
317
-
318
- Request id: ${requestId} \u2014 quote this to Lotics support.`;
319
379
  throw new LoticsRequestError(
320
380
  `${response.status}: ${message}${hint}${trace}`,
321
381
  response.status,
@@ -357,17 +417,54 @@ var LoticsClient = class {
357
417
  headers["x-request-id"] = newRequestId();
358
418
  return headers;
359
419
  }
360
- async request(method, path17, body) {
420
+ /**
421
+ * The one transport for every call to our API. Waits for the server's answer;
422
+ * only the client's `timeoutMs` stops the wait earlier, and a lost connection
423
+ * ends it too. Either way a call that may write could have taken effect, so
424
+ * it gets `OutcomeUnknownError`, never a plain failure; a read gets
425
+ * `NoAnswerError`, because it changed nothing. `read` turns the answer into
426
+ * the result and runs inside the wait.
427
+ */
428
+ async call(method, path17, body, read) {
361
429
  const url2 = `${this.baseUrl}${path17}`;
362
430
  const headers = this.buildHeaders();
431
+ const requestId = headers["x-request-id"];
432
+ const timeoutMs = this.timeoutMs;
433
+ const readOnly = method === "GET" || method === "HEAD";
434
+ const noAnswer = (waited, cause) => readOnly ? new NoAnswerError(waited, requestId, cause) : new OutcomeUnknownError(waited, requestId, cause);
363
435
  const init = { method, headers };
364
- if (body !== void 0) {
436
+ if (timeoutMs !== void 0) init.signal = AbortSignal.timeout(timeoutMs);
437
+ if (body?.kind === "json") {
365
438
  headers["Content-Type"] = "application/json";
366
- init.body = JSON.stringify(body);
439
+ init.body = JSON.stringify(body.value);
440
+ } else if (body?.kind === "form") {
441
+ init.body = body.value;
442
+ }
443
+ try {
444
+ const response = await fetch(url2, init);
445
+ if (!response.ok) {
446
+ if (response.status >= 500 && !response.headers.has("x-request-id")) {
447
+ throw noAnswer(`before the gateway in front of it gave up (HTTP ${response.status})`);
448
+ }
449
+ await this.throwResponseError(response, requestId);
450
+ }
451
+ return await read(response);
452
+ } catch (error62) {
453
+ if (error62 instanceof LoticsRequestError || error62 instanceof OutcomeUnknownError || error62 instanceof NoAnswerError) throw error62;
454
+ if (error62 instanceof Error && error62.name === "TimeoutError" && timeoutMs !== void 0) {
455
+ throw noAnswer(`within ${timeoutMs / 1e3}s`, error62);
456
+ }
457
+ if (error62 instanceof TypeError && error62.cause !== void 0 && !NEVER_SENT_CODES.has(errorCode(error62.cause))) {
458
+ throw noAnswer("before the connection closed", error62.cause);
459
+ }
460
+ throw error62;
367
461
  }
368
- const response = await fetch(url2, init);
369
- if (!response.ok) await this.throwResponseError(response, headers["x-request-id"]);
370
- return response.json();
462
+ }
463
+ async request(method, path17, body) {
464
+ return this.call(method, path17, body === void 0 ? void 0 : { kind: "json", value: body }, async (response) => await response.json());
465
+ }
466
+ async requestForm(method, path17, form) {
467
+ return this.call(method, path17, { kind: "form", value: form }, async (response) => await response.json());
371
468
  }
372
469
  /** `email` is null for a credential no person signs in as; `account_type` is absent from an older server. */
373
470
  /** `credential_origin` describes the CREDENTIAL this call carried, not the
@@ -426,31 +523,7 @@ var LoticsClient = class {
426
523
  return this.request("GET", `/v1/tools/${encodeURIComponent(name)}`);
427
524
  }
428
525
  async execute(tool, args, options) {
429
- const body = { tool, args, format: options?.format ?? "text" };
430
- if (options?.timeoutMs) {
431
- const controller = new AbortController();
432
- const timeout = setTimeout(() => controller.abort(), options.timeoutMs);
433
- try {
434
- const url2 = `${this.baseUrl}/v1/tools/execute`;
435
- const headers = { ...this.buildHeaders(), "Content-Type": "application/json" };
436
- const response = await fetch(url2, {
437
- method: "POST",
438
- headers,
439
- body: JSON.stringify(body),
440
- signal: controller.signal
441
- });
442
- if (!response.ok) await this.throwResponseError(response, headers["x-request-id"]);
443
- return response.json();
444
- } catch (error62) {
445
- if (error62 instanceof Error && error62.name === "AbortError") {
446
- throw new Error(`Tool execution timed out after ${options.timeoutMs}ms`);
447
- }
448
- throw error62;
449
- } finally {
450
- clearTimeout(timeout);
451
- }
452
- }
453
- return this.request("POST", "/v1/tools/execute", body);
526
+ return this.request("POST", "/v1/tools/execute", { tool, args, format: options?.format ?? "text" });
454
527
  }
455
528
  // --- Knowledge docs ---
456
529
  /**
@@ -495,9 +568,10 @@ var LoticsClient = class {
495
568
  "GET",
496
569
  `/v1/apps/${encodeURIComponent(appId)}/versions/${encodeURIComponent(versionId)}/source`
497
570
  );
498
- const response = await fetch(url2);
499
- if (!response.ok) await this.throwResponseError(response);
500
- return Buffer.from(await response.arrayBuffer());
571
+ return fetchStorage(url2, this.timeoutMs, async (response) => {
572
+ if (!response.ok) await this.throwResponseError(response);
573
+ return Buffer.from(await response.arrayBuffer());
574
+ });
501
575
  }
502
576
  /**
503
577
  * Workspace-wide dangling-reference sweep — active app/workflow artifacts
@@ -538,20 +612,13 @@ var LoticsClient = class {
538
612
  );
539
613
  if (args.prev_version_id) formData.append("prev_version_id", args.prev_version_id);
540
614
  if (args.message) formData.append("message", args.message);
541
- const url2 = `${this.baseUrl}/v1/apps/${encodeURIComponent(args.app_id)}/versions`;
542
- const headers = this.buildHeaders();
543
- const response = await fetch(url2, { method: "POST", headers, body: formData });
544
- if (!response.ok) {
545
- await this.throwResponseError(response, headers["x-request-id"]);
546
- }
547
- return response.json();
615
+ return this.requestForm("POST", `/v1/apps/${encodeURIComponent(args.app_id)}/versions`, formData);
548
616
  }
549
617
  async downloadFile(url2, outputPath) {
550
- const response = await fetch(url2);
551
- if (!response.ok) {
552
- throw new Error(`${response.status}: Failed to download file`);
553
- }
554
- const buffer = Buffer.from(await response.arrayBuffer());
618
+ const buffer = await fetchStorage(url2, this.timeoutMs, async (response) => {
619
+ if (!response.ok) throw new Error(`${response.status}: Failed to download file`);
620
+ return Buffer.from(await response.arrayBuffer());
621
+ });
555
622
  const absolutePath = path2.resolve(outputPath);
556
623
  await fs2.promises.mkdir(path2.dirname(absolutePath), { recursive: true });
557
624
  await fs2.promises.writeFile(absolutePath, buffer);
@@ -573,20 +640,12 @@ var LoticsClient = class {
573
640
  return this.request("GET", `/v1/files${query ? `?${query}` : ""}`);
574
641
  }
575
642
  async downloadFileById(fileId, destination, options) {
576
- const signedHeaders = this.buildHeaders();
577
- const signedUrlRes = await fetch(
578
- `${this.baseUrl}/v1/files/${encodeURIComponent(fileId)}/signed_url`,
579
- { headers: signedHeaders }
580
- );
581
- if (!signedUrlRes.ok) {
582
- await this.throwResponseError(signedUrlRes, signedHeaders["x-request-id"]);
583
- }
584
- const { url: url2 } = await signedUrlRes.json();
585
- const response = await fetch(url2);
586
- if (!response.ok) await this.throwResponseError(response);
587
- const disposition = response.headers.get("content-disposition") ?? "";
643
+ const { url: url2 } = await this.request("GET", `/v1/files/${encodeURIComponent(fileId)}/signed_url`);
644
+ const { disposition, buffer } = await fetchStorage(url2, this.timeoutMs, async (response) => {
645
+ if (!response.ok) await this.throwResponseError(response);
646
+ return { disposition: response.headers.get("content-disposition") ?? "", buffer: Buffer.from(await response.arrayBuffer()) };
647
+ });
588
648
  const originalFilename = parseContentDispositionFilename(disposition) ?? fileId;
589
- const buffer = Buffer.from(await response.arrayBuffer());
590
649
  const { dir, named } = destination === void 0 ? { dir: process.cwd() } : "file" in destination ? {
591
650
  dir: path2.dirname(path2.resolve(destination.file)),
592
651
  named: path2.basename(destination.file)
@@ -635,6 +694,7 @@ var LoticsClient = class {
635
694
  files.push(...result.files);
636
695
  errors.push(...result.errors);
637
696
  } catch (error62) {
697
+ if (error62 instanceof OutcomeUnknownError) throw error62;
638
698
  const message = error62 instanceof Error ? error62.message : String(error62);
639
699
  errors.push(...sent.map((item) => ({ filename: item.filename, error: message })));
640
700
  }
@@ -656,6 +716,7 @@ var LoticsClient = class {
656
716
  try {
657
717
  files.push(await this.uploadLargeFile(item));
658
718
  } catch (error62) {
719
+ if (error62 instanceof OutcomeUnknownError) throw error62;
659
720
  errors.push({
660
721
  filename: item.filename,
661
722
  error: error62 instanceof Error ? error62.message : String(error62)
@@ -758,11 +819,7 @@ var LoticsClient = class {
758
819
  const mimeType = item.mimeType ?? getMimeType(item.filename);
759
820
  formData.append("file", new Blob([item.bytes], { type: mimeType }), item.filename);
760
821
  }
761
- const url2 = `${this.baseUrl}/v1/files`;
762
- const headers = this.buildHeaders();
763
- const response = await fetch(url2, { method: "POST", headers, body: formData });
764
- if (!response.ok) await this.throwResponseError(response, headers["x-request-id"]);
765
- return response.json();
822
+ return this.requestForm("POST", "/v1/files", formData);
766
823
  }
767
824
  };
768
825
 
@@ -1753,18 +1810,20 @@ function signedLinks(result) {
1753
1810
  }
1754
1811
  return Object.values(result).flatMap(signedLinks);
1755
1812
  }
1756
- async function saveSignedLinks(links, dir) {
1813
+ async function saveSignedLinks(links, dir, timeoutMs) {
1757
1814
  const target = path6.resolve(dir);
1758
1815
  await fs6.promises.mkdir(target, { recursive: true });
1759
1816
  const saved = [];
1760
1817
  for (const link of links) {
1761
- const response = await fetch(link.url);
1762
- if (!response.ok) {
1763
- fail(`Could not fetch ${link.filename}: HTTP ${response.status}. A link is signed for an hour; run the tool again for a new one.`);
1764
- }
1818
+ const bytes = await fetchStorage(link.url, timeoutMs, async (response) => {
1819
+ if (!response.ok) {
1820
+ fail(`Could not fetch ${link.filename}: HTTP ${response.status}. A link is signed for an hour; run the tool again for a new one.`);
1821
+ }
1822
+ return Buffer.from(await response.arrayBuffer());
1823
+ });
1765
1824
  const name = findAvailableFilename(target, path6.basename(link.filename));
1766
1825
  const file2 = path6.join(target, name);
1767
- await fs6.promises.writeFile(file2, Buffer.from(await response.arrayBuffer()));
1826
+ await fs6.promises.writeFile(file2, bytes);
1768
1827
  saved.push(file2);
1769
1828
  if (link.snapshot !== void 0) {
1770
1829
  const text = path6.join(target, findAvailableFilename(target, `${path6.parse(name).name}.txt`));
@@ -1776,7 +1835,7 @@ async function saveSignedLinks(links, dir) {
1776
1835
  }
1777
1836
 
1778
1837
  // src/version.ts
1779
- var VERSION = "0.318.36";
1838
+ var VERSION = "0.318.38";
1780
1839
 
1781
1840
  // src/timezone.ts
1782
1841
  function machineTimezone() {
@@ -1810,7 +1869,7 @@ var permissions_default = "# Permissions\n\nWho can reach what, what runs under
1810
1869
  var working_in_a_workspace_default = "# Working in a workspace \u2014 the right means for each job\n\nOnce tables and apps exist, an agent does the team's work through them. The means depends on what the work is.\n\n| The work | The means | Why |\n|---|---|---|\n| A business operation: move an order on, issue a paper, notify someone | `run_app_workflow` on the app's act, `act_<key>` or the `workflow` it names | The outcome equals a person's press: status, stamps, documents, notifications. `update_records` on an act's field skips all of them. |\n| Data entry, a correction, loading the owner's lists | `create_records`, `update_records` | The table's rules hold for every writer. |\n| A rule or policy the business wrote | `get_workspace` with `search`, then `read_knowledge` | The business's own words, not a guess. |\n| A file someone hands over | `view_files`; `upload_file` to keep it. A picture reaches a CLI as a note naming `download_file` and `lotics file download <file_id>` | Reads its content; the upload files it in the workspace. When your host passes no bytes, `upload_file` with `person: true` gives the person a link to drop it on. |\n| A paper an app makes | the act that makes it, which files it on the record | `generate_document` makes an unattached file, for a paper no app makes. |\n| A connected service (KiotViet, MISA, a carrier) | a workflow step, reached through a Workflow node | No tool calls a service directly (`workflows/reaching-a-connected-service`). |\n| A figure or list the business defines, or an operation it repeats | the app's declared Query or Workflow node: `run_app_query`, `run_app_workflow` | The node is the business's own definition, found by `get_workspace` with `search` and read in `get_app`. |\n| A count or sum no app answers | `query_records` with `aggregate` (grouped by `group_by`), or its rows; `record_ids` reads those records by id | |\n\nFind the means in this order: `get_workspace` maps the workspace; `search` it by what is asked (\"overdue\"), which matches an app's declared Query and Workflow keys and descriptions and names the matching keys under the app; `get_app` lists that app's queries and workflows with their inputs. Run the declared node. Only a question no node answers goes to `query_records`.\n\n## Workspace settings and standing instructions\n\n`get_workspace` shows the workspace's settings (name, timezone, default currency) and, with kind `instruction`, its standing instructions. `set_workspace` changes them in one all-or-nothing patch: a setting it leaves out is unchanged, and `instructions` is a map keyed by instruction name where an entry creates or merges and `null` removes. A workspace-wide instruction arrives with the connection, in the instructions a host reads when an agent connects; the answer of `set_workspace` names any that no longer fit that block. An administrator writes them.\n\n## People\n\n`get_workspace` with kind `member` lists every member's name and id; an admin also sees each one's email, role, `managed` and `sign_in_name`, and, on kind `app`, `knowledge` or `template`, `not_listed`: how many more they can reach, which `all: true` lists. Listed docs and templates carry `access`. An admin also reads the credit limits there.\n\n`set_members` is an admin's: `members` is a map keyed by an email address, a member id or a managed member's sign-in name, and `groups` a map keyed by a group id or the name of a group to create. In `members`, an email no member holds invites that person (`role` is `member` or `admin`; the invitation email goes out), a current member's entry sets `name` and `role`, a removed member's entry restores them and takes only `name`, and `null` removes a member or cancels the invitation pending to that address. Sign-in names are compared in lowercase. A person adds a managed member and sets its password in Settings \u2192 Members. The organization keeps at least one admin: the last one cannot be demoted or removed. In `groups`, an entry sets `name`, `description` and the roster with `member_ids`, or with `add_member_ids` and `remove_member_ids` that leave the rest in place; a roster entry may be a key of `members`, so a person invited in the same call can join; `null` deletes the group. The whole input is checked before anything is written or sent; members are applied before groups, in the order given, and the caller's own step-down last. A member's tool list does not carry `set_members` or `set_workspace`.\n\n`set_access` gives members, groups or the whole organization a role on resources. Role `owner`, on one member, hands every resource listed to that member, whom only the resource's owner or an admin may name; a call cannot share an app and hand it over together, an app handed to or from a member loses its sharing, and an automation is turned off until its new owner turns it on. Handovers are applied one resource at a time, and a failure part-way names what was already applied. `set_workspace` takes `credit_limits` (`workspace`, `apps` by app id, `members` by member id; a number is the daily ceiling in credits, `null` removes it and asks for approval).\n\n## Comments\n\nEvery record read carries `comment_count`. `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.\n\n## Deleting and restoring\n\nA keyed entry is removed by `null`: a field, check, view, option, instruction, query alias, a member or a group. A resource addressed by its id is deleted with `delete: true` and brought back with `restore: true`, beside its id: a table in a `set_tables` item (`{ table_id, delete: true }`; `cascade` deletes the links that point at the deleted tables and is refused unless the call deletes; `force` goes with a patch that loses stored values and is refused on a call that only deletes or restores), a knowledge doc (`set_knowledge` with `knowledge_doc_id`), a template (`set_template` with `template_id`), an app (`set_app` with `app_id`) and a workflow (`set_workflow` with `workflow_id`; a deletion only). Records are deleted by `delete_records` and brought back by `update_records` with `restore: true` and `record_ids` or `filters`: the rows their delete took come back with them, all or none, and a row needing its link stays deleted while the row it names does. `delete` takes no other key. A call that deletes asks for approval; one that does not never does.\n\n## Locking and changing a locked record\n\n`update_records` with `locked: true` locks the targets (write access) and `locked: false` unlocks them (the table's manager). Beside field edits, a record that is locked before and after the call is refused into `blocked`; an unlock lands before the edit and a lock after it. `request_change: { reason }` files one change request per blocked record instead, carrying the values the call resolves, and lists them in `requested` as `{ record_id, request_id }`; the unlocked targets of the same call are written, and the call and its requests are one transaction, so a request that cannot be filed leaves them unwritten too.\n\n## Undoing a write\n\nA write is put back by writing the value `query_audit_logs` shows before the change: `update_records` for a field, `update_records` with `restore: true` for a deleted record, with the rows its delete took, or an app's `restore_<entity>` where the row went by that app's Delete, `delete_records` for a record a run created.\n\n## Files\n\n`view_files` reads what a file says (up to 100 by id, or the files of a record's file field with `source`). Inside an app's agent only the `file_ids` a query returned may be opened, and `source` is refused. `download_file` returns a `download_url` and, for a caller on a key or a connector, the bytes (up to 512 KB; `bytes_omitted` says why they are absent). In the in-product chat the `download_url` is the stable address a signed-in member opens, so it is for the person, not a link a tool fetches.\n\n`upload_file` names one source:\n\n- `url`: a public http(s) address the server fetches.\n- `file`: the `{download_url, file_id}` reference a host hands over for a member's attachment (a ChatGPT file parameter arrives hydrated into this shape). Never construct one.\n- `files`: bytes you hold locally. Each entry gets an `upload_url`, valid for 5 minutes, on the same host as your other calls; PUT the bytes to it and the response is the `file_id`. Where your sandbox allows no outbound request to that host (in Claude, a Team or Enterprise owner lists it under Admin settings \u2192 Capabilities), the PUT fails before it leaves: give the person the file with `person: true` instead.\n- `person: true`: returns a `drop_url`, valid for an hour, to give the person, and a `ticket_id` per file; once they say they dropped the files, call again with each `ticket_id` for its `file_id`.\n\n## Doing an operation\n\n`get_app` lists the app's acts as `act_<key>` (or the `workflow` an Act names) with what each takes. `run_app_workflow` with `dry_run: true` writes nothing\nand answers what the run would do; the same call without it runs. An act refuses a row its conditions do not hold for,\nand says why (`agent_surface` \xA7 A refusal).\n\n## Writing records\n\n`create_records` takes 50 records a call, 20 or more of one shape in columnar form (`field_keys` once, then `rows`);\n`update_records` changes one or many. Both name fields and select options by alias, and `field_values` gives each\ntype's value. Every write meets the table's rules (`reference/write-rules`): every broken rule is listed at once, and a\nlocked record answers under `blocked`. The owner's own lists (a menu with prices, customers, open orders) are rows of their\ntables, loaded this way after `set_tables`.\n\n## A business's tax ID\n\nNo tool resolves a business name to its tax ID. The customer's own papers carry the ID they are invoiced under: a PO's\ninvoicing footer, a contract, a past invoice. A web search limited to registry listings (`masothue.com`,\n`infodoanhnghiep.com`) shows each match's tax ID in its result, though those sites refuse a direct fetch; many companies\nshare a name, and the registered address is what tells them apart. For a\nVietnamese tax ID (a branch's with a `-00N` suffix), `https://api.vietqr.io/v2/business/{tax_id}` answers the\nregistered name, address and status (`NNT \u0111ang ho\u1EA1t \u0111\u1ED9ng` when active); it is rate-limited, answering 429 to a burst. A\nregistered address can differ from the one a PO prints.\n\n## Answering a question\n\n1. `get_app`: a Reading's query (its `key`) is the business's own figure for it. `run_app_query` with `alias` and\n `params` returns it; `filters`, `fields`, `sort` and `count` narrow the result.\n2. A period's total is one call per period, each with `from` and `to` or a date filter. `aggregate` groups a result by\n a column (`by`), a number's bands (`bands`) or a date column's day (`day`), and sums one (`sum`).\n3. A question no app answers is `query_records` over one table: its rows, or with `aggregate` counts and sums grouped by a\n field; `filters` is the grammar of both.\n\n## A worked day\n\nA customer asks for the status of order 1042, then the order is shipped:\n\n```\nget_workspace kind \"app\" \u2192 app_id of the sales desk\nget_app app_id \u2192 aliases: order_list, act_ship, \u2026\nrun_app_query app_id, alias \"order_list\", params {\"search\": \"1042\"}\nrun_app_workflow app_id, alias \"act_ship\", inputs {\"record_id\": \"rec_\u2026\"}, dry_run true\nrun_app_workflow the same call without dry_run\nquery_records table_id, aggregate {group_by \"stage\", count} \u2192 how many orders stand at each stage now\n```\n";
1811
1870
 
1812
1871
  // src/reference.md
1813
- var reference_default = '# Tables and apps\n\nThe tables of a workspace and the apps over them, each a JSON document. A table is a document, an item of\nthe tool `set_tables`: its fields, options, how a row is recognised, and the rules its writes\nfollow. An app is a tree of components, the `body` of the tool `set_app`: its Views \u2014 Lists of rows and Sheets of\nreadings \u2014 and the page each table\'s rows open. Each \xA7 is its own page, `reference/<section>`.\nWhich treatment each job\'s screen needs: the `design` reference. Each treatment worked through in an\napp: the `examples` reference.\n\n**What the documents compose with**\n\n- **Tables and fields** (\xA7 Tables, \xA7 Read scope, \xA7 Field) \u2014 a table\'s columns, options and links. A table document sits\n in the `tables` list of a `set_tables` call; a field sits under its alias in the table\'s `fields`.\n- **Records** (\xA7 Records, then \xA7 Status) \u2014 how a row of each table is RECOGNISED: its title, the line\n under it, its picture, its status, the one number it stands for. Stated once per table\n and read by every surface that draws one of its rows.\n- **Write rules** (\xA7 Write rules) \u2014 what a write finds, bounds and picks among.\n- **Apps** (\xA7 App tree, then a page each) \u2014 the Lists and Sheets at the app\'s root, each a View of its own, and the\n page each table\'s rows open: which fields go where, the acts, and the checks that guard them.\n How each thing LOOKS is the runtime\'s, one treatment per concept; no prop here changes it.\n A screen the job needs and no component states is told to the person \u2014 the job, what the app\n drew, the word wanted \u2014 never props bent to approximate it.\n\n**The working order**\n\n1. The tables and fields the jobs touch, and a `records` entry for every table an\n app lists, opens or picks. Which apps a business needs is `first_build`, \xA7 3.\n2. One `set_tables` call with the tables: a link names the table it points at by the `ref` of another\n item of the call, and the answer carries every table id and the aliases of the fields it added. A\n call carries at most 50 tables, 200 first rows a table, and 2000 rows and 2000 documents in all; more\n tables go in a further call, which names the earlier tables by alias. A call is checked whole and writes\n nothing when refused, listing everything wrong; `dry_run` is for reading the grants a write would make or\n deciding `force`.\n3. One `set_app` call per app. The tree names its tables and document templates by alias wherever it points at one;\n the App node\'s `tables` and `templates` maps are filled by `set_app`, never written.\n `set_app` with the tree as `body` creates the app, named by its `name`; a refused tree writes nothing and is listed whole, and `dry_run` is for reading the permissions the write\n would grant and remove (on the CLI, `lotics app apply <file>`, with `--check` for `dry_run`).\n4. Change an app afterwards one node at a time: `get_app` prints the `tree:`, each node\'s address under `node addresses:`\n and the `version` line, which is the `base_version_id` to send (the tree and addresses go to the app\'s author alone);\n `set_app` with `app_id`, `base_version_id` and `nodes`, a map from a node\'s address to a\n patch, changes it (`reference/changing-an-app`), and its answer states the permissions the change grants and removes. A table\n is changed by `set_tables` with its `table_id`, a merge patch over the document `get_table` answers. To go back,\n send the tree you saved before the change as `body` with `app_id`: it replaces `children` but keeps every App prop it\n omits (`words`, `scope`, `period`, `icon`), so null those. (On the CLI, `lotics app pull <app_id>` writes the tree as JSON and `lotics app apply\n <file>` sends an edited file, refused when the app has moved past the version the file was pulled at.) An app\n saved before apps were trees has no tree: `get_app` says so beside what it lets a person write, and `set_app` with\n `app_id` changes it by its whole tree as `body`, which replaces it, or by its name, description, icon and color alone.\n\n## The rules\n\n- **A `set_tables` call is all or nothing.** Every item is checked before any is written; an item\n without `table_id` makes a table, one with it patches that table.\n- **An app\'s labels decide its language.** A body names no locale \u2014 the words an\n app draws itself (its buttons, empty states, refusals) are in the language its\n own labels are written in, so a Vietnamese desk beside English ones answers in\n Vietnamese. The generated screens read the kit\'s\n pack, and a generated WRITE cannot: its refusals run on the server, so they are\n worded in that same language. Mix the two within one app and it answers in two. The app\'s own `words`\n (its words for a table, a field or an option) count as its labels: Vietnamese words over an English table\n make the app answer in Vietnamese.\n- **`set_tables` and `set_app` check all of it before anything is written**, and\n report every problem in one run rather than the first. The tables half of this\n page ends its keys with the rules the check enforces there, and \xA7 App rules and the pages after it hold the app\'s, one sentence each\n under an id; a finding names its rule\'s id (`[list.filter]`), and\n `reference/<rule id>` is that one rule\'s page.\n\n## Top level\n\nEvery table of keys on this page is generated from the grammar a table document and an app tree are written in, so it is the whole of what a key may hold.\n\n<!-- generated:start top-level -->\n\n#### set_tables call\n\n| Key | Type | Meaning |\n|---|---|---|\n| `tables` | list of [Table item](#table-item), required | One or more, all or nothing; each item is a table document with these keys added. It creates a table (a `label` and `fields` at least) or, with `table_id`, patches one: the document it states merges into the table\'s own |\n| `rows` | map of alias \u2192 list of [Row](#row) | First records of the tables the call creates, keyed by each one\'s `ref` |\n| `force` | boolean | Consent to losing what rows hold: a field deleted, an option removed |\n| `dry_run` | boolean | Answer what the call would change, writing nothing: for reading the grants a write would make or deciding `force`. A refused call writes nothing too and lists every reason, so a dry run checks no more than the call does |\n\n#### Table item\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | alias | A created table\'s handle in this call: other items link to it, and `rows` are keyed by it |\n| `table_id` | text | The table to patch; absent, the item creates one. A patch states only what changes: `null` removes a key, a list replaces whole |\n\n<!-- generated:end top-level -->\n\n**A `set_tables` item is a table document** (\xA7 Tables) with `ref` and `table_id` added, and the call\ntakes no other key. **A `set_app` body is an app tree** (\xA7 App tree), whose root is an App node: its `tables` and\n`templates` each map a local alias the tree names to the id of the table or document template it means, from the\n`set_tables` answer or `get_table`. The tree is the only home of the app\'s `name`, `description`, `icon` and `color`;\n`set_app` takes it whole to create, or as a merge patch over the App node with `app_id`, or `nodes` with `app_id` to change one, and with `base_version_id` (the\nversion you read) it refuses a write over a newer one. Nothing is built code. An unknown key is an error, never ignored.\n\nA smallest call, two tables of plain fields, a select and a two-way link \u2014 nothing else is needed to write it:\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"type": "text", "label": "Name", "required": true},\n "tier": {"type": "select", "label": "Tier", "options": [{"alias": "gold", "label": "Gold", "color": "yellow"}, {"alias": "standard", "label": "Standard", "color": "gray"}]},\n "orders": {"type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer"}\n }\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"type": "text", "label": "Code", "required": true},\n "customer": {"type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders"},\n "amount": {"type": "number", "label": "Amount"}\n }\n }\n ]\n}\n```\n\n### Aliases\n\nEvery `alias` is a lowercase slug \u2014 a letter, then letters, digits and\nunderscores (`unit_price`, `so_1001`). Aliases are how a document and an app tree\nname a field, an option or a table; they are never shown to anyone. `label` is\nwhat a person sees.\n\nLabels must be unique within their namespace \u2014 two fields on one table, two options\non one field cannot share a label.\n\n## Tables\n\n<!-- generated:start table -->\n\n#### Table document\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text, required | The table\'s name in the workspace |\n| `singular` | text | One row of this table, in the business\'s own words \u2014 what a create\'s button and panel name |\n| `description` | text | The table\'s description, written onto the table in the workspace, where a caller of an app\'s queries and workflows reads it beside them |\n| `fields` | map of alias \u2192 [Field](#field), required | The table\'s columns, each under its alias, which is its key here and so is never stated inside it |\n| `read_scope` | [Read scope rule](#read-scope-rule) | Which rows a member reads. Absent, every member with access to the table reads every row. |\n| `unique` | list (at least one) of list of alias (at least one) | Sets of fields whose values no two live rows share \u2014 each a list of field aliases (text, number, date, a single select, or a link holding one row \u2014 `multi: false`); a single text field states `unique: true` on itself instead of a one-field set. A create or update landing a second row with the same values is refused. |\n| `title` | alias | The alias of the field that names a row wherever a link or a record shows one; absent, the first text field |\n| `colors` | any value | Row colors: a list of { filters, color }, the filter reading fields of this table by alias and a select\'s options by alias; one condition on its own is a group of one |\n| `records` | any value | How a row is recognised: the keys of the Record, Status and Cadence tables below but `title`, which sits above; a table they name is an id or a `ref`. A status `history` that names a `ref` no item of the call declares is made by the call as a table, `dates` add each date field they name, and a status with stages each stage and each open option they name none for its `<option>_at`, unless the document declares it; each is listed in the result\'s notes |\n| `natural_key` | list of alias (at least one) | The field aliases a row of this table is RECOGNISED by: an app\'s add and find-or-create reuse the row they find by these values, minting one only where nothing matches. A record tool or the API creates the row it is handed. |\n| `no_overlap` | [No overlap](#no-overlap) | No two rows hold overlapping spans \u2014 a create or update that would is refused, and so is a change to the dates or states of the row a span is read through that would make two rows overlap |\n| `checks` | map of alias \u2192 table check (`workflows/table-checks`) | The conditions a write of the table\'s rows may not meet, each under its alias: a merge patch edits one, and `null` removes it. Expressions name fields by alias |\n\n<!-- generated:end table -->\n\n<!-- generated:start rules-entity -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `entity.singular` | A table a List\'s `create` is mounted over \u2014 a root List\'s or a child List\'s that adds rows \u2014 states its `singular`: one row of it, in the business\'s words. |\n| `entity.link-format` | A text field of `format: "link"` holds web addresses; one whose rows hold a phone or a mail address states no format. |\n| `entity.read-scope` | A `read_scope` clause names a group (`member_of`) or a field of its table reached through one-row links: `"self"` a member field, options a single select declares; an `any` or an `all` groups clauses, and groups nest. |\n| `entity.unique` | A `unique` set names fields of its table once each, each holding one value to compare \u2014 text, a number, a date, a single select, a one-row link \u2014 and is stated once; a lone text field is `unique: true` on it. |\n\n<!-- generated:end rules-entity -->\n\n**`unique` is a set of values no two live rows share.** Each entry names fields\nof this table holding ONE value \u2014 text, number, date, a single select, a link\nwith `multi: false` \u2014 and a create or update landing a second row with the\nsame values is refused. A set of one text field is that field\'s own `unique:\ntrue`, so it is refused here. A create carries each set in the names its panel\nsends, so the panel can name the duplicate before the write does.\n\n**`singular` is what a create says** \u2014 `New Order`, `Add Claim line`, `H\u1ED3 s\u01A1\nm\u1EDBi` \u2014 while `label` names the table, so without it the button reads `New\nOrders`. Nothing derives it: English plurals are irregular, and no language is\nexempt. In a language without plural forms it is usually the label itself,\nless any word for the collection. A List that leaves `create` to its default adds nothing over a table that states\nnone (nor does the app\'s `words` state one); a `create` list stated over such a table is refused (`entity.singular`).\n\n**An app that only reads a table\'s rows draws them with `edit: false`** and states `create: false` and `remove: false` \u2014 a log of what the system sent, a copy of\nwhat another system holds. The app keeps the section and opens each row at rest, with no Add and no Delete; a party\nof it is picked, never found or minted; and the app writes no create, update or remove for it. It shapes that app, not who may write: a direct write \u2014 the records\nAPI, the chat agent, an import \u2014 follows the table\'s access, as on any table, and another app over the same rows\nstates its own tree.\n\n**`read_scope`** \u2014 which rows a member reads \u2014 is its own page, `reference/read-scope`.\n\n## Read scope\n\n<!-- generated:start read-scope -->\n\n#### Read scope rule\n\n| Key | Type | Meaning |\n|---|---|---|\n| `any` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ANY of these holds |\n| `all` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ALL of these hold |\n\n#### Read scope by role\n\n| Key | Type | Meaning |\n|---|---|---|\n| `member_of` | text, required | The id of a group (from Settings, or chat): whoever is in it reads the row |\n\n#### Read scope by member\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A member field alias on this entity, or on the entity `through` lands on |\n| `is` | `"self"`, required | The members this column names on a row read that row |\n\n#### Read scope by option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A single-select field alias on this entity, or on the entity `through` lands on |\n| `is` | list of alias (at least one), required | Its option aliases whose rows are readable \u2014 naming none would hide every row |\n\n<!-- generated:end read-scope -->\n\n**A row rule is enforced by the platform.** A table\'s `read_scope` is resolved into its own row filters, so\nthe table tools, the data view and the API answer the same rows, and it caps what an app\'s owner can hand out: an\napp never reads beyond its owner\'s reach. An app states its own rule of each table it reads in `rows` on the App\nnode (\xA7 App tree), in the grammar above. A `"self"` clause reads a column of one member or several, and every group\nand option a clause names must exist.\n\n**A rule holds through a link.** A filter through a link and a List\'s linked column read the linked row under the\nreader\'s own rule of it, and a link to a row the writer cannot read is refused. A lookup, rollup or copy is stored, so\nit reads one value for everyone who reads its table: one over a table with a rule takes `manage` on that table, and\n`get_table` of that table lists them as `crossings`.\n\n**An app runs under its owner\'s authority**, so the people it is shared with need the app and no access to its\ntables. Where they differ in what they may read, `rows` states it: one rule per table, evaluated against the caller,\nnarrowing the app\'s screens, its queries (the AI and MCP path), its writes and acts, and its workflow bodies and app\nagents, every row they read or write. A table `rows` states no rule of is read whole by everyone the app is shared\nwith, so a desk whose audience its sharing already decides states nothing. The rule holds for admins too: an app with people who see every row names them, as a group.\n\n**A row rule is never inherited.** A child read under a ruled record states\nits own in `rows`: the record\'s `member_of` clauses as they are, and its column clauses\n`through` the one-row link the child hangs by \u2014 over one hop or several, each a\nlink with `"multi": false`, since over several rows the rule would admit a\nreader any one of them admits while the editor\'s guard reads the first. Only the\nstatus history takes its record\'s rule.\n\n## Field\n\nEvery field carries the keys below, and its `type`\'s section adds the rest; a\ntype whose section names no `default` takes none. `label` may not contain `{` or\n`}` (formulas reference fields by label at the platform level). Every row in `rows` states each\n`required` field it carries (neither a default nor a `default_from` copy is applied to them), and a required\nLINK is written with its row: the table it names is created first, and tables\nwhose required links name each other are refused, since none of their rows could\never be created.\n\n**A table states who keys nothing.** Whether a person may change a field in an app is that app\'s statement\n(what its tree draws, and `edit: false`, \xA7 App tree): a post\'s id a publishing workflow brings back, a count a sync fills, a status an act moves\nare left out of the apps that do not save them, and written by a workflow, the records API, the chat agent and an\nimport as the table\'s access allows. A formula, a rollup, a lookup and an autonumber are no one\'s to key already.\n\n<!-- generated:start field -->\n\n#### Field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"date"` \\| `"boolean"` \\| `"select"` \\| `"member"` \\| `"link"` \\| `"files"` \\| `"formula"` \\| `"rollup"` \\| `"lookup"` \\| `"autonumber"`, required | What the field holds \u2014 each type takes the further keys its own section lists |\n| `label` | text, required | The field\'s name in the workspace |\n| `description` | text | The field\'s description, written onto the field in the workspace |\n| `required` | boolean | Refuse a record whose cell for this field is empty. Every write path \u2014 create, update, an agent\'s tool call, a workflow\'s set \u2014 refuses the row by field name. A stored field is flagged only once every row holds a value. |\n\n<!-- generated:end field -->\n\n### `text`\n\n<!-- generated:start field-text -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `unique` | boolean | Unique values required |\n| `format` | `"text"` \\| `"link"` \\| `"markdown"` | How the words are drawn \u2014 plain, as a link that opens, or as markdown |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `suggest` | [Suggest](#suggest) | A text field whose control offers, as the reader types, the distinct values a text field of a catalog table holds (a damage position\'s code among the codes on file); any text is still written |\n\n<!-- generated:end field-text -->\n\n### `number`\n\n<!-- generated:start field-number -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | number | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. Omitted, a decimal. |\n| `rating` | [Rating](#rating) | The figure is a grade: whole numbers 1 to `max` (3 to 10), empty or one of them, drawn as stars. Only on a plain decimal figure. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n#### Rating\n\n| Key | Type | Meaning |\n|---|---|---|\n| `max` | integer, required | The scale\'s top: the most stars a grade holds |\n\n<!-- generated:end field-number -->\n\n`notation` is how the number reads, and every surface reads it:\n`{ "style": "currency", "currency": "USD" }` prints as money in its code,\n`{ "style": "unit", "unit": "kg" }` as a quantity with its unit after it,\n`{ "style": "unit", "unit": "percent" }` as a percent \u2014 10 is "10%", never\nmultiplied \u2014 and `{ "style": "decimal" }`, or no notation, as a plain number. One\nkey, so a figure reads one way.\n\nAn absent number is drawn blank, except a `sum` or count rollup read as a meter\'s measure: nothing accumulated yet reads 0.\n\nA unit \u2014 `{ "style": "unit", "unit": "kg" }` \u2014 is what a figure counts or\nmeasures; `percent` aside, it is measured or counted. A **measured** unit is a code of one catalog \u2014 mass `g`\n`kg` `t`, volume `l` `m3` `cbm` (a cubic metre under freight\'s name), length\n`mm` `cm` `m` `km`, area `m2`, duration `min` `h` `day` \u2014 so a figure typed in\nanother unit of its dimension converts (`12,5 t` into a `kg` field is 12 500),\nand a tile or a chart reads it in the largest unit it reaches (12 500 kg as\n12,5 t\u1EA5n; CBM never scales) while a cell, a fact and a column always read in the\nfield\'s own. Any other noun of at most 12 characters (`ki\u1EC7n`, `pallet`, `TEU`) is a\n**counted** unit: a word after the figure that never converts. A measured unit is\nwritten as its code \u2014 `t\u1EA5n`, `KG` or `m\xB3` is refused, naming the code. A formula\nstates its own as its `notation`; a rollup that keeps the value (`sum`, `avg`,\n`median`, `min`, `max`, `range`) and a lookup carry the unit of the figure they\nread, exactly as they carry a currency, and a count carries none. A quantity is a\nnumber with its unit, never words (`3 cartons` in a text field): only a number\nsums, converts and reads down a column.\n\nA field\'s cells always hold figures in its own unit, so moving it between two\nunits of one dimension (`kg` to `t`) converts every stored figure \u2014 a change made\nin the workspace, in the field\'s settings (which say how many first) or through\n`set_tables`. Any other change of unit\nrelabels.\n\nA figure whose unit or currency varies by row names a single select of its own\nrow as `per_row` \u2014 `{ "style": "unit", "unit": { "per_row": "uom" } }`,\n`{ "style": "currency", "currency": { "per_row": "currency" } }` \u2014 or a lookup of\none through a one-link, a line reading its shipment\'s currency. That select\'s\noptions are the vocabulary: each label a unit (`chi\u1EBFc`, `kg`), or an ISO 4217 code\n(`USD`). A label outside it is refused when the figure is written and when the\nselect is \u2014 its options, its type or its deletion while a figure names it. A row\nwhose select is empty reads its figure bare. Every app reads each row\'s figure in\nits own row\'s unit, and a sum never mixes units: totals are one per unit (past three units a total the runtime draws over a set of rows \u2014\nsummary line, group totals and feet, a Sheet\'s table foot \u2014\nstates the count alone; a reading an author states draws every unit), a chart draws one at a time. A rollup that keeps the value (`sum`, `avg`, `min`\u2026)\nover such a figure stands only where the child\'s select is a lookup, through\nthe rollup\'s own link, of a select on this table \u2014 the rollup reads that\nselect\'s unit; otherwise it is refused. A lookup of such a figure stands only\nwhere its table also looks up the figure\'s select through the same one-link,\nand reads in that lookup; otherwise it is refused. A count is unaffected. Moving a field between a\nfixed and a per-row unit relabels.\n\n### `date`\n\n<!-- generated:start field-date -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. A date string in the field\'s format. |\n| `format` | `"date"` \\| `"datetime"` \\| `"month"` \\| `"date_range"` \\| `"datetime_range"` | Whether the field holds a day or a moment, alone or as a span; `month` (stored YYYY-MM) is read where a field holds it; a write cannot set it. |\n| `timezone` | text | IANA timezone |\n| `derive_from` | `"created_at"` \\| `"updated_at"` | Auto-populate from the row\'s system timestamp; the field becomes read-only. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n<!-- generated:end field-date -->\n\nA `default` is refused beside `derive_from`: the platform stamps that date.\n\n### `boolean`\n\n<!-- generated:start field-boolean -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | boolean | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-boolean -->\n\n### `select`\n\n<!-- generated:start field-select -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | list of alias | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. Option alias(es) this field declares \u2014 one for single-select. |\n| `options` | list of [Select option](#select-option) (at least one), required | The choices, in the order every picker and every ladder lists them |\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n#### Select option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | Stable local alias, unique within the field |\n| `label` | text, required | Display label for the option |\n| `color` | [colour](#select) | The colour the option\'s badge is drawn in; absent, the platform gives it one no sibling option holds |\n| `mark` | [mark](#select) | The option\'s own mark, drawn in place of its colour dot wherever the option is shown: the brand it is ({kind: "brand", name: one of facebook, instagram, threads, meta, tiktok, google-ads, zalo, linkedin, x, google-meet, youtube, telegram, whatsapp, gmail, google-drive, outlook, kiotviet, misa, lark, payos}) a kit glyph ({kind: "icon", name: "wrench"}) or the face of who it is, drawn from its label ({kind: "avatar", name: "person" or "organization"}). Every option of a field has one, or none does. A mark a reader does not draw falls back to the dot |\n| `short` | text | A few letters the option reads as where room is short \u2014 a table\'s column ("K5" for a long legal category) \u2014 its label shown on hover |\n\n<!-- generated:end field-select -->\n\nA patch of a select states its whole `options` list: a list replaces whole, so an option it leaves out is deleted. To\nrename or recolour one option, restate every option kept, each with its alias. Rows still holding a deleted option refuse\nthe patch unless `force`.\n\n```json\n{\n "options": [\n { "alias": "draft", "label": "Draft" },\n { "alias": "confirmed", "label": "Confirmed" },\n { "alias": "shipped", "label": "Shipped", "color": "green" }\n ]\n}\n```\n\n`color` is one of: `red`, `orange`, `amber`, `yellow`, `lime`, `green`,\n`emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`,\n`fuchsia`, `pink`, `rose`, `slate`, `gray`, `zinc`, `neutral`, `stone`.\nEvery option is drawn in its colour wherever it shows \u2014 a cell, a row\'s line,\na record, a picker, the bar a reading splits the rows by.\n\nAn option may carry its own `mark`, drawn in place of its colour dot wherever\nthe option is shown \u2014 a stage, a chip, a filter, a fact, an entry of a log, a\nreading\'s part, a lookup of the select on another table. Where the select is its\nrows\' `records` `mark`, a brand or glyph stands on the row\'s lead tile in the option\'s\ncolour, and an option with none leads with its colour dot there. A select a reader scans\ndown a column \u2014 how a payment was made, the channel, the mode \u2014 states one on every\noption, since a glyph reads before its word: the brand it IS\n(`{"kind": "brand", "name": "tiktok"}` \u2014 one of `facebook`, `instagram`,\n`threads`, `meta`, `tiktok`, `google-ads`, `zalo`, `linkedin`, `x`,\n`google-meet`, `youtube`, `telegram`, `whatsapp`, `gmail`, `google-drive`,\n`outlook`, `kiotviet`, `misa`, `lark`, `payos`), a glyph the kit draws\n(`{"kind": "icon", "name": "wrench"}`; any other name is refused), or \u2014 where the\noptions name people or organisations who are no member and no row \u2014 the face of who\nit is, drawn from its label (`{"kind": "avatar", "name": "person"}` or\n`"organization"`). Every option of a select has one, or none does: a run of chips\nwhere one carries no mark reads as the one missing something. `set_tables` writes the\nmarks onto the table. The glyph names are `reference/field/option-glyphs`.\n\n```jsonc\n"options": [\n { "alias": "short_video", "label": "Short video", "color": "zinc", "mark": { "kind": "brand", "name": "tiktok" } },\n { "alias": "print", "label": "Print", "color": "amber", "mark": { "kind": "icon", "name": "newspaper" } }\n]\n```\n\n### Option glyphs\n\nThe kit\'s glyph names an option\'s `mark` takes:\n\n<!-- generated:start field-select-glyphs -->\n\nactivity, align-center, align-left, align-right, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, arrow-down, arrow-down-a-z, arrow-down-up, arrow-down-wide-narrow, arrow-left, arrow-left-from-line, arrow-right, arrow-right-from-line, arrow-right-left, arrow-up, arrow-up-down, arrow-up-wide-narrow, arrow-up-z-a, ban, banknote, bed, bell, between-horizontal-start, between-vertical-start, bold, bolt, book-marked, book-open, book-text, bot, box, brackets, brain, briefcase, building-2, calculator, calendar, calendar-clock, calendar-off, camera, car, chart-column, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down-up, chevrons-up-down, circle-alert, circle-check, circle-x, clipboard-list, clipboard-paste, clock, code, code-xml, columns-3, columns-3-cog, combine, construction, container, copy, credit-card, database, decimals-arrow-left, decimals-arrow-right, dollar-sign, download, ellipsis, eraser, expand, external-link, eye, eye-off, file, file-csv, file-down, file-question, file-spreadsheet, file-stack, file-text, file-up, folder, folder-closed, folder-open, folder-pen, form, funnel-plus, funnel-x, gauge, globe, gpu, grid-2x2, grip-vertical, group, hand-coins, hash, heading, heading-1, heading-2, heading-3, history, house, image, inbox, info, italic, keyboard, languages, layout-dashboard, layout-grid, library-big, link-2, link-2-off, list, list-checks, list-collapse, list-filter, list-filter-plus, list-ordered, list-tree, loader, lock, lock-keyhole, lock-keyhole-open, lock-open, log-in, log-out, mail, map-pin, maximize-2, megaphone, menu, message-circle, message-circle-question-mark, message-square, messages-square, mic, minimize-2, minus, monitor, mouse, mouse-pointer-click, music, newspaper, notepad-text-dashed, package, paint-bucket, paintbrush-vertical, palette, panel-left, panel-left-close, panel-left-open, panel-right, panel-right-close, panel-right-open, paperclip, pause, pencil, percent, phone, pin, pin-off, plane, play, plug, plus, receipt, rectangle-ellipsis, redo, refresh-cw, repeat, rotate-ccw, rotate-cw, rows-3, scan, scan-line, scissors, search, send, settings, share, share-2, shield, shield-alert, shield-check, shopping-cart, sigma, sliders-horizontal, smile, smile-plus, snowflake, sparkles, split, square, square-check, square-pen, square-sigma, star, stethoscope, sticky-note, strikethrough, table, table-2, tag, target, text-quote, text-wrap, thumbs-down, thumbs-up, ticket, trash, trending-down, trending-up, triangle-alert, truck, tv-minimal, type, underline, undo, upload, user, user-check, user-pen, users, utensils, waypoints, workflow, wrench, x, zap, zoom-in, zoom-out\n\n<!-- generated:end field-select-glyphs -->\n\n### `member`\n\nA person picker over the workspace\'s members. No default. With no role it is still drawn \u2014\nface and name, ranked as a `party` \u2014 in a screen\'s `columns` and in the register\na record draws of these rows.\n\n<!-- generated:start field-member -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-member -->\n\n### `link`\n\n<!-- generated:start field-link -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `options_where` | [filter](#filters) | Which rows of the target this link may point at \u2014 an `and` group of plain conditions over the TARGET table\'s own fields, each `field_key` a field alias. It narrows every picker of the link, and a save naming a row outside it is refused on every path \u2014 an app, the grid, an import, a workflow, the API. |\n| `same` | list of alias (at least one) | One-row links this row and each row this link points at must name alike \u2014 a fee\'s invoice is one of its own visit\'s, a box\'s seal one of its own shipping line\'s: each a one-row link of both tables to the same table, or a lookup of one (a line\'s shipping line looked up from its visit, never stored beside it). It narrows the picker\'s read to the rows naming what this row names, a row made from the picker names it too (set, never asked), and a write is refused wherever it lands \u2014 on the link, or on what the two rows compare. |\n| `table` | text, required | The table the link points at: its alias, or the `ref` of another item of the call |\n| `multi` | boolean, required | Whether a row links to one row or many: true, many; false, one. Where the link is paired, at most one of the two sides holds one |\n| `pair` | `true` \\| alias | Makes the link two-way: the alias of its partner field on the other table, which names this one back, or `true` to have the alias derived. Stated on one table, the partner is made on the other with the inverse cardinality; a many-to-many link states both sides |\n\n<!-- generated:end field-link -->\n\n**`multi` is stated on every link:** `true` holds several rows, `false` one \u2014 one customer on an\ninvoice, one project on a device. There is no default.\n\nA two-way link states `pair` on one table, as `true` or a free alias, and the partner is made on the\nother table with the inverse cardinality; a many-to-many link states both sides, since the inverse of\nmany is not decided. A pair stated on both sides is made once. Both tables are written in the one\ncall (`table` names the other item\'s `ref`). A link with no `pair` is one-way, and nothing is created on the target. Pair a link when\nthe target\'s own record should list what points at it, and leave it unpaired when it should not: either\nway the record plan draws the relation as a section on the side it points at, so an unpaired link costs\nthe target nothing. Of two paired links at most one holds one row.\nA link to its own table is paired with itself (a spouse) when `pair` is `true`, and with a second field of that table when `pair`\nnames its alias (a parent and its children, each stating the other); paired with itself it cannot hold one row.\n\n```jsonc\n// a field of table "order"\n"customer": { "type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders" }\n```\n\n```jsonc\n// a field of table "customer"\n"orders": { "type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer" }\n```\n\n### `files`\n\nA row attaches documents to it (\xA7 Rows). Each file\nis drawn by its kind, with no key to choose: a picture (an image, a video) as its\nthumbnail, a document (a PDF, a sheet) as its type\'s badge and its filename.\n\n### `formula`\n\nA formula states its keys on the field itself, beside `type` and `label`:\n`{ "type": "formula", "label": "Total", "expression": "{quantity} * {unit_price}", "notation": { "style": "currency", "currency": "USD" } }`.\n\n<!-- generated:start field-formula -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `expression` | text, required | The expression, over fields of THIS entity by alias in braces \u2014 `{quantity} * {unit_price}` |\n| `output_type` | `"number"` \\| `"text"` \\| `"date"` \\| `"datetime"` \\| `"boolean"` \\| `"select"` | Holds a formula to the type its readers need: absent, it is what the expression yields. Stated, it is checked against that and refused where they differ (a datetime is never stated date) |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. For a formula yielding a number. |\n| `link` | `true` | The formula yields a URL as text, drawn as a link that opens. |\n| `options` | list of [Select option](#select-option) (at least one) | The categories the formula yields, drawn as a single select\'s options are (read-only). The expression yields one of them as `{this_field:option}`, or null \u2014 `{days_idle} > 30 ? {warmth:cold} : {warmth:hot}`. Omit for a formula yielding a plain value. |\n\n<!-- generated:end field-formula -->\n\n`output_type` is what lets a role or a screen clause accept a computed value: a\ncaption over a derived name (`output_type: "text"`), a period over a settled date\n(`"date"`). A formula declaring no `output_type`, `notation` or `link` says nothing\nabout its result, and every rule that needs one refuses it by name. A formula stating\n`options` is a computed category: read-only, and read as a single select\nwherever it is drawn \u2014 a column, a filter, a reading\'s `by` or `where`.\n\n**A select reaches a formula as the KEYS of its chosen options**, a list \u2014\nnever their labels, and never their aliases \u2014 and a document has no keys: the\nworkspace mints them when the table is made. So an option is named in a formula\nas `{field:option}`, both aliases, and the write puts that option\'s key in its\nplace: `includes({kind}, {kind:crate})` for a select holding one or several,\n`{kind}[0] == {kind:crate}` for a single one. A select compared to its own words\n(`{kind} != "Crate"`) matches no row and computes the other branch everywhere,\nso the check refuses it and names the token. A select looked up from another\ntable is tested there, in a formula of its own, and that result looked up.\n\n**The language.** The check refuses a call or a name the platform cannot run, naming what to write:\n\n<!-- generated:start field-formula-language -->\n\n- Operators: `+ - * / %`, `== != > < >= <=`, `&& || !`; `+` also joins text\n- Numbers: arithmetic is exact decimal (`0.1 * 3` is `0.3`), a division that does not end the nearest double; a comparison between two numbers reads both at 15 significant digits; `round` rounds a half away from zero (`round(-2.5)` is `-3`)\n- Conditionals: a ternary only \u2014 `{amount} > 100 ? "High" : "Low"`\n- Not supported: optional chaining (`?.`), nullish coalescing (`??`), template literals, arrow functions \u2014 use `get(obj, "path", default)`, `coalesce(v1, v2)`\n- Helpers are these names, spelled exactly; a spreadsheet function (`IF`, `SUM`, `LEN`, `DATEDIF`) is none of them, and a formula calling one is refused\n- Math: round(n,decimals?), ceil(n), floor(n), abs(n), min(a,b), max(a,b), sum(arr), mean(arr), clamp(n,min,max), percentage(part,total,decimals?), pow(base,exp), sqrt(n), mod(n,divisor)\n- A select reads as its option keys: compare it with `{field:option}`; read its name as text with `label({field})`\n- Strings: label(select) (the option\'s name; a multi-select\'s names joined ", "), upper(s), lower(s), trim(s), capitalize(s), length(s), contains(s,search), join(arr,sep), split(s,sep), replace(s,search,rep), replaceAll(s,search,rep), removeChars(s,chars) (s without any character that occurs in chars), removeSpaces(s) (s without any whitespace), startsWith(s,prefix), endsWith(s,suffix), substring(s,start,end?), padStart(s,len,char), padEnd(s,len,char), numberToWords(n, lang?) (lang \'vi\' default, or \'en\'), uuidFrom(s) (the same UUID for the same text)\n- Lists: includes(list,value), first(list), last(list), unique(list), compact(list) \u2014 length(list) counts one\n- Dates: now(), formatDate(d,fmt), addDays(d,n), subDays(d,n), addHours(d,n), subHours(d,n), addMinutes(d,n), subMinutes(d,n), startOfDay(d), endOfDay(d), startOfMonth(d), endOfMonth(d), addMonths(d,n), differenceInCalendarDays(later,earlier), differenceInHours(later,earlier), differenceInMinutes(later,earlier), isBefore(d1,d2), isAfter(d1,d2), isSameDay(d1,d2), isToday(d), isWithinRange(d,start,end), meetsBounds(value,kind,{gt,gte,lt,lte},tz?), parseDate(d)\n- Null/type: isNull(v), isEmpty(v) (also true for "" and []), coalesce(v1,v2,...), isString(v), isNumber(v), isBoolean(v), isArray(v), toNumber(v), toFigure(v), toString(v)\n- Other: formatCurrency(amount,locale,currency), formatDecimal(value,decimals,locale) (grouped quantity, no symbol), get(obj,"path",default?)\n- Empty cells: a cell nobody filled is null inside a formula, whatever its type; one holding 0, false or "0" is not empty. Test it with `isEmpty({note})` \u2014 `{note} == ""` and `{done} == false` are false on an unset cell\n- Arithmetic over an empty cell: `+` and `-` read it as 0 beside a value (`{fee} + {surcharge}` is `{fee}` when the surcharge is empty, null when both are); `*`, `/`, `%` and a unary `-` yield null (`{price} * {qty}` is null, not 0, when the quantity is empty)\n- No helper throws on an empty cell: the math helpers and toNumber return null, the string helpers "". A value of the wrong type still errors. When EVERY field a formula reads is empty it is null \u2014 unless it reads each only as the argument of isEmpty, isNull or isNotNull (`!isEmpty({file})` is false there, not null)\n\n<!-- generated:end field-formula-language -->\n\n### `rollup`\n\nAggregates the records reached through a link on this table.\n\n<!-- generated:start field-rollup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `filter` | [filter](#filters) group | Only linked records matching this filter are aggregated; one condition on its own is a group of one. Every `field_key` in it names a field alias on the linked entity, and a select condition\'s value names an option alias there. A traversal node reaches past that entity, so its `path` hops and inner `field_key` are fully-qualified `entity.field` aliases. |\n| `via` | alias, required | The alias of a link of this table to roll up from |\n| `op` | [operation](#rollup), required | The operation over the linked rows |\n| `field` | alias | The alias of the field on the linked table the operation reads; absent for `count` |\n\n<!-- generated:end field-rollup -->\n\nA rollup states `via` (a link of this table), `op` and \u2014 except for `count` \u2014 `field`, an alias on the\nlinked table; `op` is one of `count`,\n`sum`, `avg`, `median`, `min`, `max`, `range`, `empty`, `filled`,\n`percent_empty`, `percent_filled`, `unique`, `percent_unique`, `earliest`,\n`latest`, `date_range`, `checked`, `unchecked`, `percent_checked`,\n`percent_unchecked`. The operation must be one the aggregated field\'s type\nallows \u2014 `sum` over a number, `earliest` over a date, `filled` over any stored or\nformula field. A lookup is never rolled up: roll up the child\'s own field, or a formula\nover it. A rollup states no `notation`: `sum`, `avg`, `median`, `min`, `max` and `range`\nread in the aggregated figure\'s, a count as a plain number, and a `percent_*` as a\npercent (0\u2013100), in the app as in the table.\n\n### `lookup`\n\nDisplays a field from the linked records: `via` names a link of this table, `field` a field of the table it\npoints at. Through a link holding several rows it holds every linked row\'s value, which an app reads whole: a sort by\nits first value, a filter matching any value, a grouping counting the row under each; `order_by` (`field`, `direction`)\npicks the one row whose value shows instead.\n\n<!-- generated:start field-lookup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `via` | alias, required | The alias of a link of this table to look up through |\n| `field` | alias, required | The alias of the field on the linked table to show |\n| `order_by` | [Lookup order](#lookup-order) | Show ONE linked row\'s value \u2014 the first in this order \u2014 rather than every linked row\'s |\n\n#### Lookup order\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A field alias on the linked table the rows are ordered by |\n| `direction` | `"asc"` \\| `"desc"`, required | Which end of that order the one row is taken from |\n\n<!-- generated:end field-lookup -->\n\nInside a formula, a lookup holding one value is that value (`{due_soon}` is\n`true`, not `[true]`); several values are a list.\n\n### `autonumber`\n\n<!-- generated:start field-autonumber -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `prefix` | text | Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\'). Ignored when `template` is set. |\n| `padding` | integer | Zero-pad the integer to this width. Default 1 (no padding). 3 \u2192 \'001\', \'012\', \'123\', \'1234\' (overflow uses the actual width). Ignored when `template` is set. |\n| `template` | text | Format template with placeholder tokens evaluated at insert time. Tokens: {N} (raw integer), {N:W} (zero-padded to width W, e.g. {N:3} \u2192 001), {YEAR} (4-digit year), {YEAR:2} (2-digit year), {MONTH} (2-digit month), {DAY} (2-digit day). Date tokens use the workspace timezone. Example: \'HM-{YEAR}-{N:3}\' yields \'HM-2026-001\'. Stored as the composed string; subsequent template edits do NOT re-format existing rows (date tokens would lose the original creation date). |\n| `next` | integer | Sets the number the next row takes, once, as the patch is written; never below one past the highest number issued. On a field added to a table with rows, those rows are numbered from it in creation order. It is no setting of the field: a read of the table shows none |\n\n<!-- generated:end field-autonumber -->\n\nA refused write and a dry run take no number, so a table\'s numbers run without a gap; a removed row\'s number is not\nissued again.\n\n<!-- generated:start rules-field -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `field.default` | A default names options its select declares \u2014 one on a single select \u2014 and a date stamped by `derive_from` states none. |\n| `field.default-from` | A field\'s `default_from` reads `<link>.<field>` off the row a one-row link of its table names \u2014 a link no copy fills \u2014 or, through further one-row links, `<link>.<link>.<field>` off the row the last names, into a field of the same type, date format and notation that `derive_from` does not stamp: a lookup only through a one-row link, a link only into one to the same table, a select\'s option as this field\'s of the same alias (one it lacks is not copied), several values only into a field holding several. The server copies it on every add that fills the link and leaves the field empty, so a List\'s `create` sure to fill the link \u2014 a required one, or the record it files the row under \u2014 does not ask it by default. |\n| `field.option-mark` | An option\'s `mark` is one the kit draws, and a select\'s options mark every one or none. |\n| `field.unit-select` | A notation\'s `per_row` names a single select of the same row, or a lookup of one through a one-link, whose every option label is a unit, or an ISO 4217 code. |\n| `field.link` | A link targets a table of the call or the workspace: its `pair` a link on that table naming this one back \u2014 and of two paired links at most one reads one row (`multi: false`). |\n| `field.formula` | A formula parses, reads fields of its own table by alias, names an option as `{field:option}` of one a select declares, and compares a select to its options\' keys, never their words. |\n| `field.formula-type` | A formula yields what it states \u2014 its `output_type` (the type the platform stores: a `"datetime"` is never stated `date`), else a figure where it states a `notation` and text where it states `link` \u2014 as the platform infers it from the expression when the field is created. |\n| `field.rollup` | A rollup aggregates, through a link of its table (`via`), a field of the linked table (`field`) by an operation (`op`) that field\'s type takes \u2014 never a figure read in each row\'s own unit or currency \u2014 filtered on fields of the linked table. |\n| `field.lookup` | A lookup reads (`field`), through a link of its table (`via`), a field of the linked table \u2014 a figure read in each row\'s own unit or currency only where this table looks up that row\'s select through the same one-row link \u2014 ordered by a field of it (`order_by`). |\n| `field.computed-cycle` | Computed fields never wait on each other in a loop: each is computed after what it reads. |\n\n<!-- generated:end rules-field -->\n\n## Filters\n\nA table\'s saved views are not part of its document: `set_table_views` writes them and `get_table` lists them. A view\'s\nfilter, a color rule\'s filter, `options_where` and a rollup\'s `filter` share one grammar. Every field reference is a\nfield ALIAS on that table.\n\nA filter is a group \u2014 `{ "node_type": "group", "logic": "and" | "or",\n"children": [ \u2026 ] }` \u2014 or one condition on its own, `{ "node_type":\n"condition", "field_key": "tier", "operator": "has_any_of", "value": ["gold"] }`. A sort is a list of `{ "field_key": \u2026, "order": "asc" |\n"desc" | null }`. A condition states no `type`: its field\'s type decides which `operator` it admits: `has_any_of` / `has_none_of` / `has_all_of` / `is_empty` /\n`is_not_empty` for a select, `equals` / `greater_than` / `less_than` for a\nnumber, `on` / `before` / `after` / `between` for a date, `contains` /\n`is_any_of` for text. A select condition\'s `value` names option ALIASES.\n\n<!-- generated:start rules-color -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `color.fields` | A color rule\'s filters name fields of its table. |\n\n<!-- generated:end rules-color -->\n\n## Groups and templates\n\nA member group and a document template are made on their own, outside a table document and an app tree. A tree names a\ntemplate by its alias. A table document names a group by its id, where a `read_scope` clause (`member_of`),\na stage owner (`group`) or a check\'s `member_of("<id>")` takes one. `get_workspace` kind `group` lists the groups with their ids and members; `set_members` creates,\nchanges or deletes one in its `groups` (an admin\'s verb).\n\n`{{name}}` in an `html` or `email` template is filled from the workflow\'s data. Inline content is refused where it holds a\nscript, a frame, a `<link>`, an inline event handler or a `javascript:` URL; an `html` one may be a fragment, kept as\nwritten and printed as a whole document.\n\nA template\'s markup is the `template` of `set_template`, as one JSON string. A paper shaped like a counterparty\'s \u2014 a letterhead, a reference line, a seal, a signature block \u2014 is an `html` template with a shell around the body; `document_templates` covers the types.\n\n**What an act\'s template is handed** is its record\'s own fields by alias: a\nselect, a member and a link as their words (a link as the linked row\'s title), a\nnumber, a date and a computed value that declares its kind raw (`2800000`,\n`2026-09-14`) and a files field as its file cells (`{id, name, mime, url}`, the photos in the order held; a child row\'s\nfiles likewise) \u2014 never a computed select. On one record it is\nhanded, too, the rows of each child List the record draws, listed under that child\'s\nlink\'s name for `{{#each <link>}}` (and under the child entity\'s alias too): every row filed under the record, oldest first, each\nby its own fields as the record\'s are, less its link back to the record. A List that only reads is listed under its `key`, its rows reached by its link\nor, for a `<link>.<link>` path, by both. Over\nseveral rows the rows are listed under the table\'s alias, for\n`{{#each <alias>}}`, without their child rows.\n\n**Photos in a paper.** A file cell is drawn only if whoever makes the paper may read that file, by the rule the file\nproxy applies; a file they may not read is never drawn. html: `{{#each photos}}<img src="{{url}}">{{/each}}`, each\nphoto inline, only those the data\'s file cells carry (a url typed into a text field stays a link). Word:\n`{{IMAGE picture(cover, 8)}}` for one file cell, and `{{FOR p IN photos}}{{IMAGE picture($p, 8)}}{{END-FOR p}}` for\nmany. Excel: `{{cover | picture:6}}` as the whole cell, and `{{#each photos}}` with `{{this | picture}}` for many, each\nrow growing to its picture. The number is the width in centimetres (8 by default, 6 in Excel); the height follows the\npicture. `picture` takes one image file cell: a list, a file that is no image and a file that cannot be read are\nrefused by name. Photos are embedded at most 1600 pixels across.\n\nHelpers print a raw value in the template\'s `locale` \u2014 `vi` or `en`, the organization\'s language where it states\nnone; each prints `""` for an empty value:\n\n| Helper | Prints (`vi` / `en`) |\n|---|---|\n| `{{money total "USD"}}` | `1.250,50 US$` / `$1,250.50`, in the currency\'s minor units; no code, a number |\n| `{{number qty}}` | `1.234,5` / `1,234.5`: grouped, up to 2 decimals |\n| `{{date issued_on}}` | `14/09/2026`, `14 Sep 2026` in an English template; a date-fns pattern as the second argument, `{{date at "dd/MM/yyyy HH:mm"}}`, literal text quoted (`"\'Ng\xE0y\' dd"`). A moment prints on the workspace\'s timezone |\n| `{{words total "USD"}}` | `M\u1ED9t ngh\xECn hai tr\u0103m n\u0103m m\u01B0\u01A1i \u0111\xF4 la M\u1EF9 n\u0103m m\u01B0\u01A1i xu` / `One thousand two hundred fifty US dollars and fifty cents`; no code, VND (`\u0111\u1ED3ng`) |\n| `{{qr link}}`, `{{code128 position 6}}` | the value as a QR code, or as a Code 128 barcode (ASCII text only), a picture the width of the optional second argument in centimetres, by default sized to the value (a module prints 0.5 mm in a QR code, 0.33 mm in a barcode); a width too narrow to scan is refused, naming the least that does; not in an email template |\n| `{{date (add_days issued_on -1)}}` | `13/09/2026`: the date shifted by whole days (`-1`: the day before), for `date` to print; a number field as the days, empty shifting none |\n\nA value it cannot read (`{{money "abc"}}`, `{{date "14/09/2026"}}`) fails the render. A field named like a\nhelper and written alone (`{{number}}`) prints its own value.\n\nA field printed as a code in the other types: Excel `{{position | qr}}` or `{{position | code128:6}}` as the whole\ncell and the last helper \u2014 the picture is anchored on the cell and its row grows to hold it; Word `{{IMAGE qr(position)}}` or `{{IMAGE code128(position, 6)}}`. An empty field draws no picture.\n\n## Rows\n\n`rows` of a `set_tables` call are the first records of the tables the call creates, keyed by each one\'s `ref`;\na patch of an existing table seeds none, so write its rows into the table. A sample, not a data set: rows past it go in with `create_records` once the tables exist, in the batches its description bounds.\n\n```jsonc\n"rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } }\n ]\n}\n```\n\n`rows` sits beside `tables` in the call, not inside a table.\n\n<!-- generated:start rows -->\n\n#### Row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | text, required | Local handle for this row, referenced by other rows\' link fields |\n| `fields` | map of text \u2192 any value, required | Field alias \u2192 the value, read against the field\'s declared type |\n\n<!-- generated:end rows -->\n\n<!-- generated:start rules-rows -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `rows.ref` | A row\'s `ref` is unique within its table. |\n| `rows.required` | A row states every field its table requires: it is created with what it states, its fields\' defaults and copies unapplied. |\n| `rows.value` | A row\'s value fits its field: an option alias for a select, `"<table ref>:<row ref>"` of a row of the linked table in this call or a stored record\'s id for a link, `"self"` for a member, a `fil_` id for files, a date in the date grammar (an hour only on a datetime), a text, number, yes/no or null otherwise \u2014 and none on a computed field. |\n\n<!-- generated:end rules-rows -->\n\nA `ref` is lowercase letters, digits and underscores, and is never persisted.\n\n`fields` is keyed by field alias, and every value is read against the field\'s\nDECLARED type:\n\n| Field type | Value |\n|---|---|\n| `text` / `number` / `boolean` | the value itself |\n| `date` | `"2026-03-14"`, or a relative expression (below) |\n| `select` | the option ALIAS \u2014 `"gold"`, or `["gold","vip"]` for a multi-select |\n| `link` | `"<table ref>:<row ref>"` naming another row of this call \u2014 `"customer:acme"` \u2014 or the id of a record the linked table already holds, or an array for several; a paired link is stated on ONE side (the child\'s link to its parent) and its partner fills itself |\n| `member` | `"self"` only \u2014 the member making the call |\n| `files` | the `fil_` id of a file already in this workspace, or a list of them |\n| `formula`, `rollup`, `lookup`, `autonumber` | not allowed \u2014 the platform writes these |\n\n### Relative dates\n\nA date cell holds a literal `YYYY-MM-DD`, or an expression relative to the day\nthe call is made, so a screen that opens on "this month" is not empty a month\nlater:\n\n- `@today` \u2014 the day of the run, in the workspace\'s timezone\n- `@month-start` \u2014 the 1st of that month\n- either with a whole-day offset: `@today-14`, `@month-start+9`\n- on a date that holds its hour (`format: "datetime"`), that hour after the day, and always stated:\n `@today 14:30`, `@today+1 06:00`\n\n`@month-start` exists because `@today-N` cannot promise a month: applied on the\n2nd, `@today-3` lands in the previous one.\n\n## Records\n\n`records` says how a row of a table is RECOGNISED \u2014 stated once in the table\'s document, beside its\n`title` \u2014 and every surface that draws one of its rows reads the same\nstatement: the register\'s row, a picker\'s option, a link\'s chip, a child table\'s\nrow and the record\'s header. Every table an app lists, opens or picks has one. The rarer keys \u2014 `scan`, `cadence`, `place`, `on_site`, `pin`, `plan_place` and `size` \u2014 are stated on `reference/record-places-pins-and-cadence`.\n\n```jsonc\n// table "visit"\n"title": "container_no",\n"records": {\n "subtitle": ["customer", "arrived_on"],\n "image": "photos",\n "status": { "field": "stage", "closed": ["gone"], "history": "visit_history" },\n "figure": "total_fees",\n "due": ["free_until"]\n}\n```\n\n```jsonc\n// table "release": a release order read against what it allows \u2014 a meter wherever it shows\n"title": "release_no",\n"records": { "figure": "issued", "limits": { "issued": "units" } }\n```\n\n```jsonc\n// table "dossier": a straight-line process \u2014 the stage a select, each step\'s day the date it stamps\n"title": "applicant",\n"records": { "status": { "field": "stage", "closed": ["signed"], "dates": { "received": "received_on", "appraised": "appraised_on", "signed": "signed_on" } } }\n```\n\n<!-- generated:start records -->\n\n#### Record\n\n| Key | Type | Meaning |\n|---|---|---|\n| `subtitle` | list of alias (1\u20132) | Up to two fields read under the title wherever a row is drawn (a code, a date, a party): one line at a desk, wrapping to a second on a phone |\n| `image` | alias | A files field that pictures the row \u2014 never one an act keeps the document it makes in. Absent, a table with exactly one files field is pictured by the first image in it \u2014 never a paper or other file \u2014 unless the entry states a `mark` or puts that field in the title or subtitle; an app turns it off with `row.image: false`. |\n| `mark` | alias | A single select (or a lookup of one through a one-row link), or a formula that states its options, whose option leads the row wherever a mark leads it \u2014 a list\'s row, the record\'s head, a link naming the row: the option\'s brand or glyph, else its colour dot, on a tile. The field stays a field: a subtitle run, a column, a section\'s control. Never beside `image` or `party`, and never the status field |\n| `description` | alias | A text field saying what the row is about \u2014 a plan\'s brief, a customer\'s note: read in its record\'s head under the title\'s line, its first lines at rest and whole on a press, and written from the head\'s \u270E. Never on a row\'s line |\n| `party` | `"person"` \\| `"organization"` \\| `"organisation"` | What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier); absent, the rows are things (an order, an item, a paper) |\n| `status` | [Status](#status) | The stage a row moves through, a single select, drawn in the record\'s head, or its Side where the Side states it |\n| `figure` | alias | The one number the row stands for, read at its right (a total, a quantity left) |\n| `limits` | map of alias \u2192 (alias \\| number) | A number read against a bound \u2014 a field of the same row or a constant \u2014 drawn as a meter wherever it shows |\n| `gates` | map of alias \u2192 (alias \\| number) | A pass mark on a meter `limits` bounds \u2014 a field of the same row or a constant; a percent field is its share of the bound, any other number an amount. The meter marks it and fills complete once past it |\n| `tolerance` | map of alias \u2192 number | How far past its `limits` bound a meter may stand, in percent of the bound: the bound is an amount expected (received against ordered), not a cap. Without one the bound is a cap, and past it is an overrun |\n| `due` | list of alias (at least one) | Dates that are deadlines (stored, or computed as a date): each counts down and turns overdue until the row is at a `closed` option or `settled` holds, whatever stage it has moved to. A deadline is never an appointment date or the day a stage starts |\n| `frees` | alias | A date ending the row\'s span of days on which what the row holds is free again (a check-out, a hire\'s return): a stay from the 3rd to the 5th holds the 3rd and the 4th, and another may start on the 5th \u2014 on a lanes board, a calendar, a roster and in `no_overlap` alike. Absent, a span of days holds its last day; a span of moments always frees its end |\n| `settled` | alias | A yes/no of the row (stored, a formula: an invoice paid in full, or looked up through a one-row link: a line settled with its parent) that ends its deadlines: while it is true, no `due` of the row counts down or turns overdue \u2014 in a cell, on its line, in its head, on a calendar or gantt, or in the overdue count. A Sheet\'s or reading\'s `where` reads it as any other yes/no |\n| `task` | `true` | A row is work someone finishes: wherever rows of it stand in a table \u2014 a register, a record\'s rows, the rows filed under one \u2014 each is led by a ring ticking it done and unticking it by the one write of the app making that move. Its status is a stored select with `closed` |\n| `applies` | map of alias \u2192 map of alias \u2192 (list of alias (at least one) \\| boolean) | Fields that apply only while their conditions hold (a length only on a line whose tariff charges by the metre): where one does not apply no add asks it and no surface shows it. Never the title; a required one starts at its `default` |\n| `starts` | map of alias \u2192 `"today"` \\| `"me"` | What a field of a row being added starts at, where that start is certain: `today` a date (a moment starts now), `me` a member, the reader adding it; every other field starts empty unless the reader narrowed the register to a value or the field declares a `default` |\n\n<!-- generated:end records -->\n\n<!-- generated:start rules-records -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.title` | A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title\'s own field. |\n| `records.image` | `image` is a files field, never one an Act keeps the documents it makes in (`into`). |\n| `records.mark` | `mark` is a single select or a lookup of one through a one-row link, or a formula that states its options, never the status field, nor on the folder an App works inside (`scope`), which its switcher names by a picture or its initials. |\n| `records.description` | `description` is a text field, read in the record\'s head \u2014 never a Field of a part too. |\n| `records.figure` | A figure is a number. |\n| `records.applies` | `applies` holds a field of the row other than its title to conditions of the same row \u2014 a yes/no (stored or a formula) by `true` or `false`, a single select by its options, its own or looked up through a one-row link \u2014 never to itself; a required field it holds starts at a `default`. |\n| `records.limits` | `limits` bounds a number by a number field of the row, in its unit or one of the same dimension \u2014 or by a constant, where every row reads the figure in one unit. |\n| `records.gates` | `gates` marks a pass on a meter `limits` bounds: a percent field (its share of the bound), another number in the bound\'s unit, or a constant. |\n| `records.tolerance` | `tolerance` stands on a meter `limits` bounds. |\n| `records.starts` | `starts` starts a field a person writes \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 and a `create` that does not ask a field it starts writes that start. |\n| `records.due` | A deadline (`due`) is a date. |\n| `records.frees` | `frees` names a stored day, never a moment: a span of moments already frees its end. |\n| `records.settled` | `settled` names a yes/no of the row (stored, a formula, or looked up through a one-row link) beside a `due`: while it holds, the row\'s deadlines neither count down nor turn overdue. |\n| `records.task` | A task entity (`task`) states a `status` of a stored single select with `closed` options \u2014 its ring ticks a row done by moving it to one. |\n| `records.picture` | *Noted by the designer on a write, never refused:* Rows an App draws that each hold one files field no Act makes documents into, no call is filed into, no files gallery keeps and no List compares as a pair (`compare`) \u2014 and no figure \u2014 are pictured by it (`image`); where the workspace\'s files are known, the field holding images is the picture, a figure or not. |\n| `records.mark-lead` | *Noted by the designer on a write, never refused:* Rows an App draws of an entity that states a computed category (a formula stating `options`) or a single select besides its status whose options state a mark, and states no `mark`, `image` or `party`, can lead with that field\'s option as their mark (`records.mark`). |\n| `records.stage-holder` | *Noted, never refused:* A stage owned by a member field of the row itself, where the table does not require that field and no `create` or Act of the App states it (asks, sets, requires or writes it), lets a row reach the stage with the field empty: require the field, or state it in a `create` or an Act. |\n\n<!-- generated:end rules-records -->\n\n- **The title names the row** by who or what it is \u2014 a link by the linked row (a job\n read by its customer). Any field but a button or a yes/no may title it, yet a code\n titles a row only where people name the row by it, else it is a `subtitle`; it is the table\'s own setting, which every link shows.\n- **One lead per row.** A row leads with its picture (`image`), a face (`party`) or the\n option of a single select it holds (`mark`) \u2014 never two. A `mark` draws that option\n on a tile: its brand or glyph, else its colour dot; a row holding none, a ring saying\n none is picked. The same tile heads the row\'s record and leads it where a link\n names it; the select stays a field \u2014 a subtitle run, a column, a section\'s control.\n- **A limit** reads a number against a bound \u2014 another field of the row, or a constant.\n A `gates` entry marks a pass on that meter: a percent field is its share of the\n bound, any other number an amount.\n- **A deadline** (`due`) counts down wherever it is drawn and is overdue once past while\n the work is open. A register over the table says how many rows in view are overdue on\n its summary line, and pressing that count narrows to them \u2014 no reading to state.\n- **A span\'s free day** (`frees`) is the end date on which what the row held is free\n again \u2014 a check-out, a hire\'s return. A stay from the 3rd to the 5th holds two nights:\n a lanes board, a calendar and a roster draw it through the 4th, and `no_overlap` lets\n the next stay start on the 5th. Without it a span of days holds its last day; a span of\n moments always ends as the next may begin.\n- **`starts`** is where an add\'s field begins, stated only where that is certain \u2014 a\n log\'s own day at `today`, a request\'s requester at `me`. Nothing else starts a field\n but its declared `default` and what the reader narrowed the register to.\n\n## Record places, pins and cadence\n\nThe rarer keys of `records`, stated beside the ones on `reference/records`: a title read off a photo (`scan`), the rows a child owes each day (`cadence`), where a row stands on a map (`place`, `on_site`) or on a picture (`pin`, `plan_place`).\n\n```jsonc\n// table "site": it owes a diary page each day it works, from breaking ground through handover\n"title": "name",\n"records": { "cadence": [{ "entity": "diary_page", "on": ["mon", "tue", "wed", "thu", "fri", "sat"], "from": "started", "until": "handed_over" }] }\n```\n\n<!-- generated:start records-places -->\n\n#### Record places\n\n| Key | Type | Meaning |\n|---|---|---|\n| `cadence` | list of [Cadence](#cadence) (at least one) | The rows of a child each row owes one of a day, on the days of the week listed (a site\'s diary page, Monday to Saturday) \u2014 one entry a child, never owed on a day still to come. A roster of these rows over days marks a past day owed with none missing in the danger tone, counted in the legend; today\'s is due, offered to add and never marked; each row\'s total reads the days it holds of those owed |\n| `scan` | `"text"` \\| `"iso6346"` \\| `"code"` | Its title, a text field, is painted or printed on the thing a row is (a container\'s number, a seal\'s) and read off one photo on a phone, beside each search matching it and each field holding or picking it: `iso6346` a container number, refused unless its check digit holds; `text` as it stands; `code` a barcode or QR code on the thing, decoded on the device from the photo with no agent |\n| `place` | [Place](#place) | Where a row stands, as plain fields of it, drawn as one place where its record draws the address: how sure it is, a press opening it in the device\'s maps, and one taking it from where the device stands |\n| `plan_place` | [Plan place](#plan-place) | Each row is a place on the plan a `plan` register draws: its title the place\'s code, its subtitle a note. A flat list, no tree |\n| `on_site` | [On site](#on-site) | Photos taken where a place stands (a site diary\'s): a photo taken through a phone\'s camera here keeps where the device stood, marked at the place, away from it or unknown, and a record holding one taken away says so among its checks \u2014 one with no place (picked on a computer, or kept before places were) is marked and warns nothing; a place reaches only members of the organization, through the apps drawing these photos |\n| `pin` | [Pin](#pin) | Each row is a place on a picture (a snag on a flat\'s plan, a spot on a container\'s drawing): a List of these rows draws the picture its `on` row holds with a numbered pin at each row\'s own place, each row led by its number, the row opened lit on it and a pin pressed opening its row; where the List writes rows, a press on the bare picture adds one there, and a pin dragged moves its row. A List of rows that link to these by a single link draws their places the same way |\n| `size` | [Record size](#record-size) | The real size of the thing a row is (a carton, a piece of furniture, a pallet): three number fields stating one length unit alike, read as one fact \u2014 "400 \xD7 300 \xD7 250 mm", a part the row lacks "\u2014" \u2014 after the subtitle wherever the row\'s line and head draw facts, never also as the subtitle\'s fields. A plan register drawing these rows draws each box at this size |\n\n#### Cadence\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | text, required | The table owed: each of its rows stands on one row of this table by its single link to it, and on the first date of its line (`records` title or subtitle) |\n| `on` | list of `"mon"` \\| `"tue"` \\| `"wed"` \\| `"thu"` \\| `"fri"` \\| `"sat"` \\| `"sun"` (at least one), required | The days of the week one is owed on, each listed \u2014 `mon` to `sun` |\n| `from` | alias | A date of this row: the first day one is owed (a site breaking ground, a contract\'s start); absent, no first day |\n| `until` | alias | A date of this row: the last day one is owed (a site\'s handover, a contract\'s end); empty or absent, through today |\n\n#### Place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `address` | alias, required | A text field: the address, as people write it |\n| `latitude` | alias, required | A number field: degrees north, negative south |\n| `longitude` | alias, required | A number field: degrees east, negative west |\n| `accuracy` | alias | A number field: how many metres off the device that gave the place said it may be |\n\n#### On site\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photos` | list of alias (at least one), required | Files fields of this row holding photos taken on site |\n| `place` | alias | A single link of this row to the row whose `place` its photos are taken at (a diary page\'s site); absent, this row\'s own `place` |\n| `radius` | number, required | How many metres from the place a photo still counts as taken there |\n\n#### Pin\n\n| Key | Type | Meaning |\n|---|---|---|\n| `on` | alias, required | A single link of this row to the row whose picture (its `records` `image`) the place is on \u2014 a container\'s drawing, a floor\'s plan |\n| `x` | alias, required | A number field of this row: how far across that picture the place stands, in percent from its left edge |\n| `y` | alias, required | A number field of this row: how far down that picture the place stands, in percent from its top edge |\n\n#### Record size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of the thing a row is, across |\n| `along` | alias, required | A number field: its depth, along |\n| `up` | alias, required | A number field: its height, up |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.scan` | A title read off a photo or a code (`scan`) is a text field the row stores. |\n| `records.cadence` | A `cadence` names each child once \u2014 its rows standing on one row of this entity by their single link and on the first date of their line \u2014 lists each day of the week once, and `from` and `until` are two different days of this entity. |\n| `records.place` | A `place` names four different fields of the row: its address a text field, its latitude, longitude and accuracy number fields it stores. |\n| `records.plan_place` | A `plan_place` names `kind` and `reach_from` as single selects, `sheet` as a single select or a one-row link, `stacked` as a boolean and the rest as numbers, each a different field; `kind`, `x`, `y` required. `size` names three numbers (`across`, `along`, `up`) stating one cell in one length `unit` alike. A `sheet` linking to an entity that states an `image` draws that drawing under the places, `scale` (a number field of that entity) its width in cells; `scale` goes with such a `sheet` alone. |\n| `records.on_site` | `on_site` lists files fields of the row, each once, taken at the `place` of the row itself or of the one row a single link of it names (`place`), which states one. |\n| `records.pin` | A `pin` names a single link of the row (`on`) to an entity whose `records` states its `image` (a PDF is drawn as its first page), and two different number fields of the row, how far across (`x`) and down (`y`) that picture in percent. A List of rows whose own entity states a `pin` is drawn over that picture; `on`, `x` and `y` are set by the press that adds a row, never asked. |\n| `records.size` | A `size` names three different number fields of the row (`across`, `along`, `up`) stating one length unit alike (mm, cm, m or km); they read as one fact after the subtitle, so the subtitle never also names one. |\n\n<!-- generated:end records-places -->\n\n## Status\n\nA record\'s `status` is the stage a row moves through \u2014 a stored single select, each\noption\'s moment the date `dates` names. A record draws it as its dot and word where Act buttons on the page offer its moves, and as a control for the moves no drawn Act offers: choosing one runs its Act, asking and refusing as its button does.\n\n<!-- generated:start status -->\n\n#### Status\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The single select that is the row\'s state, its options in the order the work goes through them, read as steps by itself on a record whose parts state no `at` |\n| `closed` | list of alias (at least one) | Options that end the work: a register opens on the rows not at them, and the badge reads muted |\n| `dropped` | list of alias (at least one) | Options of `closed` that leave the work undone (cancelled, rejected): whoever holds the row moves it to one from any stage, where every other move forward passes each owned stage between that binds the row (its `when`) and needs each one\'s owner, and a row leaving one enters a stage as a row made there does |\n| `history` | text | A table every write that sets or moves the status appends one row to (its link to this table, the new status, the moment and who) \u2014 by the record write path, whoever writes: for reporting on every move |\n| `dates` | map of alias \u2192 alias | Option alias \u2192 a date field of this entity the record write path stamps with the moment a row moves into that option, or is made at it \u2014 whoever writes. A value the same write states for that field wins, so past data loads as it happened \u2014 and the `history` records the move at that day, a row made at a later option recording each earlier one whose date the write states, in order; the platform never clears a stamp, so each is when the row last entered the option. A stage\'s date is made where none is named |\n| `stages` | map of alias \u2192 [Stage](#stage) | Option alias \u2192 who owns that stage and how long it should take: the owner alone takes a row out of it, by any write, and presses the acts offered there; every move forward past it of a row it binds (its `when`), and every such row made past it, is its owner\'s too. Its days run from the moment its `dates` field holds. In an app the status then moves only by acts that `set` one of its options \u2014 no save writes it and no act asks it |\n\n#### Stage\n\n| Key | Type | Meaning |\n|---|---|---|\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }`, required | Who owns the stage: a member field of the row, `link.field` read through a one-row link (not at the stage a row opens at, whose owner made the row: a member field of the row itself), or `{ group }`. A member moves a row off only one stage that groups own, one at a time: the next waits on a different member, or on a stage stating no owner; a row made past a stage signs nothing there |\n| `within` | integer | Whole days the stage should take from the moment the row entered it |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| [comparison](#values) \\| `{ "empty": true \\| false }`) | The rows that must pass this stage: a row meeting every entry on its own fields, as it stood before a write or as the write leaves it \u2014 a single select holding one of these options, a yes/no this value, a number or date meeting its bounds, a field empty or filled. Absent, every row must. A row at the stage leaves it by its owner either way |\n\n#### Stage group\n\n| Key | Type | Meaning |\n|---|---|---|\n| `group` | text, required | A group of the workspace, by id: its members press the act. One person moves a row off only one of the stages different groups own |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.status` | A status is one single select, its options in the order the work goes through them, `closed` naming the ones that end it and `dropped` those of them reached from any stage. |\n| `records.history` | A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member. |\n| `records.stages` | A stage\'s owner (`status.stages`) is a single member field of the row, one read through a one-row link (never at the stage a row opens at: its owner made the row, so it is a member field of the row itself), or a group, on an option that does not end the work; a group\'s stage needs the status `history` with who moved the row. Every write takes a row off a stage as its owner alone, and moves a row past it or makes a row past it as its owner alone where the stage binds the row (its `when`) \u2014 a move to a `dropped` option excepted, which whoever holds the row makes from any stage; a row leaving a dropped option, or holding none, enters a stage as one made there. Each stage\'s moment, and each open option\'s, is the date its `dates` names, made where none is named, which every write that opens or moves the status stamps; `within` runs from it. In an App a status with stages moves only by Acts that `set` one of its options \u2014 no save writes it or a date it stamps, and no Act asks either, sets it otherwise or writes either from a workflow; an Act moving a row forward past a stage another owner owns, into an option not `dropped`, keeps its `when` off every row that stage binds. |\n| `records.stage-when` | A stage\'s `when` names the rows that must pass it, as an Act\'s `when` holds them \u2014 single selects to their options, yes/nos to `true` or `false`, numbers and dates to bounds, any field to `{ "empty": true \\| false }` \u2014 on fields a write stores of the row itself: never the status, a formula, a lookup or a rollup, and never on the stage a row opens at. It binds a row meeting it as it stood before a write or as the write leaves it; absent, it binds every row. |\n| `records.detour-note` | *Noted, never refused:* A stage the work only steps aside into \u2014 not where a row starts, entered from one step alone that also moves the work on without it, and left by its own moves only back to that step (a pause, a repair) \u2014 is a detour: its option and the Section whose `at` holds it stand before that step\'s, else the work reads it as its next step, and the Act moving the work into it leads that Section \u2014 never a correction waiting in a \u22EF. |\n\n<!-- generated:end status -->\n\n- **The status** is one single select. `closed` options end the work: a register opens\n on the rows not in them, a row holding no status among them. A `history` table gets one row per move \u2014 its link to this\n table, the new status (a select holding the same option aliases, or text), the\n moment (the stage\'s `dates` value where the write states a past one, so loaded rows keep\n the day they reached it) and who \u2014 appended by the record write path in every write that opens a row at a\n stage or moves it, whoever writes (the member behind the write is its `by`; an automation\n leaves it empty). A `history` the tables do not declare is derived, and needs no\n `records` of its own.\n- **When each step happened** is the date `dates` names for its option, stamped as the row\n enters it, whoever moves it. One way times a status: a straight-line process is a select\n whose options are its steps in order, each with its date \u2014 never a run of dates the stage\n is read off. An Act that moves the stage and `asks` the step\'s date with `starts: "today"`\n lets the reader record a day already past in the same press.\n\n## Write rules\n\nWhat a WRITE of a table\'s rows meets is stated in the table\'s document, where it applies: `min` and\n`max` on a number or date field, `options_where` and `same` on a link, `suggest` on a text field,\nand `no_overlap` and `natural_key` on the table. A key a field\'s type does not take is refused at\nits path, and a document has no `write_rules` key.\nEvery one but `natural_key` and `suggest` holds on every path a record is written by \u2014 the grid, a record\'s form, an import, a workflow, an\nagent, the API, an app \u2014 judged in the write\'s own transaction, every broken rule listed at once; the\nscreen and a picker only mirror them. A row that already breaks one stays editable until a write\ntouches what the rule reads. `natural_key` names the fields an app recognises a row by, to reuse it where an\nadd or a find-or-create meets it; a record tool or the API creates the row it is handed. `suggest` offers\nvalues in a text control and refuses none. An `options_where` link is refused where a write names a row the\nnarrowing does not admit, and every picker of the link offers only the rows it admits.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customer",\n "fields": { "email": { "type": "text", "label": "Email", "unique": true } },\n "natural_key": ["email"]\n }\n ]\n}\n```\n\nA customer above is RECOGNISED by their address. An add that names one \u2014 from the customers\nregister or from a picker\'s "new" \u2014 reuses the row it matches and opens one only where nothing does,\nso the book never grows a second Acme.\n\n```json\n{\n "tables": [\n { "ref": "product", "label": "Product", "fields": { "name": { "type": "text", "label": "Name" }, "in_stock": { "type": "number", "label": "In stock" } } },\n {\n "ref": "order",\n "label": "Order",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "placed_on": { "type": "date", "label": "Placed on" },\n "due_on": { "type": "date", "label": "Due on" },\n "lines": { "type": "link", "label": "Lines", "table": "order_line", "multi": true, "pair": "order" }\n }\n },\n {\n "ref": "order_line",\n "label": "Order line",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "order": { "type": "link", "label": "Order", "table": "order", "multi": false, "pair": "lines" },\n "quantity": { "type": "number", "label": "Quantity", "min": 1, "max": 9999 },\n "ships_on": { "type": "date", "label": "Ships on", "min": "order.placed_on", "max": "order.due_on" },\n "product": {\n "type": "link",\n "label": "Product",\n "table": "product",\n "multi": false,\n "options_where": {\n "node_type": "group",\n "logic": "and",\n "children": [{ "node_type": "condition", "type": "number", "field_key": "in_stock", "operator": "greater_than", "value": 0 }]\n }\n }\n }\n }\n ]\n}\n```\n\nA line of nothing is not a line: `quantity` is refused on create and on update. A line ships inside\nits order\'s window \u2014 a bound read off the row a link names is judged when the line is written. Nothing is sold off an empty shelf: every picker of `product`\nreads only the rows that answer its `options_where`, and every save refuses the same rows again.\n\n```json\n{\n "tables": [\n {\n "ref": "booking",\n "label": "Booking",\n "fields": {\n "room": { "type": "text", "label": "Room" },\n "state": { "type": "select", "label": "State", "options": [{ "alias": "held", "label": "Held", "color": "blue" }, { "alias": "released", "label": "Released", "color": "gray" }] },\n "starts_on": { "type": "date", "label": "Starts on" },\n "ends_on": { "type": "date", "label": "Ends on", "min": "starts_on" }\n },\n "no_overlap": { "from": "starts_on", "to": "ends_on", "by": ["room"], "while": { "state": ["held"] } }\n }\n ]\n}\n```\n\nOne booking per room at a time, while it is held \u2014 a create or a save whose span overlaps another\nheld booking of the same room is refused.\n\nA table\'s `checks` (the conditions no write of its rows may meet) are stated in its document and hold on every path a record is written by; their keys, what they read and an example are on `workflows/table-checks`. What follows every committed write of its rows is a workflow, written with `set_workflow` (`workflows/table-workflows`).\n\n<!-- generated:start write-rules -->\n\n#### Suggest\n\n| Key | Type | Meaning |\n|---|---|---|\n| `table` | text, required | The table whose text field is offered from: its id, or its `ref` in this call |\n| `field` | alias, required | The alias of that table\'s stored text field; the field\'s control offers, as the reader types, the distinct values it holds, and any text is still written |\n\n#### No overlap\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | text, required | The stored date (or datetime) a row\'s span starts on: `<field alias>` of the row, or `<link alias>.<field alias>` of the one row a one-row link names (a booking line\'s piece held for its booking\'s dates) |\n| `to` | text, required | The stored date (or datetime) a row\'s span ends on, named like `from` and through the same link \u2014 a day it holds, unless `records` names it the day the row `frees`; a moment another row may start at |\n| `by` | list of alias (at least one) | Fields two rows share to compete for a span (the same employee, the same room); absent, every row |\n| `while` | map of text \u2192 list of alias (at least one) | Only rows at these options of these selects hold their span (running, not closed), the select named like `from` \u2014 `<field alias>` or `<link alias>.<field alias>`; absent, every row |\n\n<!-- generated:end write-rules -->\n\n<!-- generated:start rules-write -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `write.natural-key` | A `natural_key` is text or a number a person types back, or a one-row link; a text key is unique \u2014 `unique: true`, or the key\'s fields as a set in the table\'s `unique`. |\n| `write.bounds` | `min` and `max` bound a number or a date \u2014 by a constant a number, by a field of this row or of the one row a one-row link names either, of the same type and unit, never by itself \u2014 and `min` is never above `max`. |\n| `write.bound-per-row-unit` | On a figure whose unit or currency is the row\'s own (its notation\'s `per_row`) a constant bound is only 0 \u2014 bound it by a field of the row. |\n| `write.suggest` | `suggest` stands on a stored text field and names a `table` and a `field`, a stored text field of that table; the app reads that table, so it has a `records` entry. |\n| `write.same` | `same` stands on a link and names one-row links, or lookups of one, this table and the link\'s target both hold to one table. |\n| `write.options-where` | `options_where` narrows a link by an `"and"` group of plain conditions over the target\'s own fields \u2014 a number compared in one unit on every row, a select by options it declares. |\n| `write.no-overlap` | `no_overlap` spans two date fields, the row\'s own or the one row a one-row link names (`booking.start_on`); `by` names values rows share \u2014 a link, a person, one option, a text or a number; `while` names single selects by their options, the row\'s own or that linked row\'s. |\n\n<!-- generated:end rules-write -->\n\n- A `natural_key` is `text` or `number`, because a person types it back, or a\n one-row link, because a row is also recognised by the one row it belongs with (a\n fee by its visit and its kind). A key holding a `text` field is unique: `unique:\n true` on that field, or the key\'s fields as a set in the table\'s `unique` (a\n site by its customer and its name) \u2014 two rows sharing it would make\n find-or-create pick whichever the read answered first. An add asks the key by\n default.\n- A `same` link names only rows that name what this row names \u2014 a fee\'s invoice\n is one of its own visit\'s \u2014 through a one-row link both tables hold to one\n table; its picker offers nothing until the row names one. A row added under a\n record names what it copies off it (`default_from`) from the start, so a block\n expecting one line per row of the link lists that record\'s rows alone. A save\n of this row moving what the two compare is refused while they would name apart.\n- An `options_where` link may be left empty; a row it names is refused on every\n save that writes the link unless it holds the narrowing, and the refusal names\n the link and the row. A save that leaves the link alone is not judged, so a row\n still naming a row the narrowing no longer admits stays editable. A link naming\n one kind of a book\'s rows (a "Shipping line" among the parties) narrows to that\n kind, or its picker offers every row.\n\nA field\'s own `required` is not here: the field carries it, and every write\npath refuses the row by field name from it. `unique` is the text field\'s own\nclause (\xA7 `text`) \u2014 an add says so at the control before the column does. A\nfield the workspace writes (a formula, a rollup, a lookup, an autonumber, a date\nwith `derive_from`) is never asked, written or edited.\n\n## App tree\n\nAn app is a tree of components, assembled the way a page is written in JSX: pick a component, bind it to a table by\nname, and it draws well with no props, because its defaults come from the table\'s facts (\xA7 Records, \xA7 Status,\n\xA7 Write rules, \xA7 Field). A prop overrides a default at its own node. No prop says how anything looks: the runtime\ndraws each concept one way, and a screen the job needs that no component states is told to the person \u2014 the job,\nwhat the app drew, the word wanted \u2014 never props bent to approximate it.\n\n**The smallest tree is one root List.** `{ "type": "App", "key": "orders", "name": "Orders", "children": [{ "type": "List", "entity": "order" }] }`\nis a whole app: the platform draws the rest from the tables \u2014 the page every row opens, a Section per stage with its moves\nat the foot, a child List per child, the band of readings, the add and the Delete. Every answer of `set_app` and `get_app`\nshows what it drew (`(default)` among the addresses) and says what it placed or folded in what you stated, so you state only\nthe difference. Lists at the root stand beside one another, two over one entity opening its one page.\n\nEach component is a page of its own: `reference/app-node`, `reference/list-node`, `reference/list-source`, `reference/record-node`, `reference/section-node`,\n`reference/side-node`, `reference/outside-node`, `reference/tab-node`, `reference/sheet-node`, `reference/field-node`, `reference/fieldset-node`, `reference/act-node`, `reference/check-node`,\n`reference/reading-node`, `reference/statement-node`, `reference/export-node`,\n`reference/query-node` and `reference/workflow-node`. Beside them: `reference/changing-an-app` and `reference/what-an-app-may-write`, `reference/layouts`, `reference/time-and-place-layouts` and\n`reference/publish-desk` for a List\'s `layout`, `reference/tasks`, and the rules, `reference/app-rules`,\n`reference/reading-rules`, `reference/statement-rules`, `reference/check-rules`, `reference/list-rules`, `reference/record-rules`, `reference/act-rules` and `reference/template-rules`.\n\n<!-- generated:start app-components -->\n\n| Component | Draws | Holds |\n|---|---|---|\n| [App](#app-node) | the launcher tile, the app\'s words, its Views (Lists and Sheets), and its API | List, Sheet, Query, Workflow, Record |\n| [List](#list-node) | rows of an entity: the register, a record\'s child rows, a roster\'s cells, related rows | Tab, Reading, Export, Act, List |\n| [Record](#record-node) | what a row opens: the head and the parts | Field, Fieldset, Section, Side, Outside, List, Reading, Statement, Act, Check |\n| [Section](#section-node) | a titled part of a record, and optionally a step of its path | Field, Fieldset, List, Reading, Statement, Act |\n| [Side](#side-node) | the part the rest is worked from, beside them | Field, Fieldset, List, Reading, Statement, Act |\n| [Outside](#outside-node) | what one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it | Field, List, Act |\n| [Tab](#tab-node) | one view of a List\'s rows over a period | \u2014 |\n| [Sheet](#sheet-node) | a grid of Readings and Lists over the App\'s rows in its period | Reading, List |\n| [Field](#field-node) | one field: a control, a gallery, prose, a link and its picker, the rows filed under a back-link | \u2014 |\n| [Fieldset](#fieldset-node) | fields of a part read together under a heading of their own | Field |\n| [Act](#act-node) | a verb: what pressing it does | \u2014 |\n| [Check](#check-node) | a formula of the rows that warns, or refuses the writes and acts it names | \u2014 |\n| [Reading](#reading-node) | a number over rows: one figure, its parts, a grid, per period, steps; or a record\'s own figure; with `planned` and `done`, the work against its plan, day by day | \u2014 |\n| [Statement](#statement-node) | a figure built from figures of the record | \u2014 |\n| [Export](#export-node) | a report file of the rows in view | \u2014 |\n| [Query](#query-node) | nothing: a read for agents | \u2014 |\n| [Workflow](#workflow-node) | nothing: a verb for agents | \u2014 |\n\n<!-- generated:end app-components -->\n\n### A node\n\nA node is `{ "type": <Component>, "key"?, ...props, "children"?: [...] }`. `type` names the component, `key` its\nname among its siblings, the other keys its props, `children` the nodes it holds. An unknown prop is refused.\n\n- **Two shorthands, both for Field.** A bare string child is a Field (`"due_date"`); an object with `field` and no\n `type` is a Field with props (`{ "field": "price", "edit": false }`). Both work in every prop that lists fields:\n `create`, a Record\'s `row.subtitle` and `add`, and the `children` of a Record or a part. A column is a field\'s alias, or\n `{ "field", "edit": true }` for the line\'s own control, and takes no other prop.\n- **Fields and options are named by alias**, never by label. A tagged value is an object, never a magic string.\n- **`false` turns a default off at its node:** `"edit": false` makes a field read-only, `"create": false` and\n `"remove": false` take a List\'s add and Delete away, `"readings": false` its band; on a Record, `"row": { "figure": false }`\n drops the row\'s figure, `"row": { "status": { "edit": false } }` the status buttons (another app moves the stage) and\n `"row": { "image": false }` the picture.\n\n### Keys and addresses\n\nA key is unique among its siblings, the way a React key is. A node that binds data takes its key from what it binds:\n\n| Node | Key when none is stated |\n|---|---|\n| Field, Check | its field alias |\n| List | its entity alias |\n| Record | its `entity` alias |\n\nEvery other node states its key. Three kinds of key are unique across the whole app, because each is an API name:\nan Act\'s (its workflow is `act_<key>`, or the one it names), a Reading\'s (its query name for `run_app_query`), and a Query\'s or\nWorkflow\'s.\n\nA node\'s **address** is the path of keys from the app, such as `pages/customer/orders`; the app itself is `/` (the `in` of a node at the root), and its own key is part of no address. A patch may use any ending\nof that path that names exactly one node (`orders`). The exact path wins where one exists; an ending naming two\nnodes is refused, and the refusal lists both paths. `get_app` prints the tree with each node\'s address.\n\n### Values\n\n| Value | Written |\n|---|---|\n| now, the reader, an asked input | `{ "now": true }`, `{ "me": true }`, `{ "input": "name" }` |\n| a computed value | `{ "formula": "{cost} * 1.2" }` over the acted row\'s fields |\n| a call\'s own value, in a Query | `{ "param": "name" }` |\n| cleared | `null` in an Act\'s `set` |\n| an option | its alias |\n\nA **condition** (`when`) maps a select to a list of its option aliases and a yes/no to `true` or `false`; every entry\nholds. A number (a number, currency or percent field, or a formula or rollup yielding one) takes a comparison with any\nof `gt`, `gte`, `lt`, `lte` (at least one, never both `gt` and `gte` or both `lt` and `lte`), each a number; a date\ntakes the same keys with a day (`"2026-03-01"`), a moment on a datetime (`"2026-03-01T09:30"`) or `{ "now": true }`\n\u2014 today, or the current minute on a datetime, read when the rows are, so overdue is `{ "due_on": { "lt": { "now": true } } }`;\nand any field but a yes/no takes `{ "empty": true }` or `{ "empty": false }`. A comparison on a field it does not fit is\nrefused, naming the field, its type and what it takes. A `when` on an Act, a Section or other block, and a List\'s `where`\n(the register\'s or a child List\'s) take these; a child List that adds, picks or expects rows refuses a comparison in its\n`where`, since a row it holds could stand outside it. A **narrowing** (`opens`, a Reading\'s, a Tab\'s or an Export\'s `where`) takes these and also `{ "me": true }` on a member\nfield or a lookup of one, the reader; `where` on a root List or a record\'s child rows fixes the rows on the server for every reader, so it refuses\n`{ "me": true }` \u2014 open on it with `opens`; on a record\'s related rows (`same`, `app`) and on a Sheet\'s List it\nnarrows by the reader and takes it, and those two take no comparison.\n\n## Changing an app\n\n1. `get_workspace` with `kind: "app"` names the app. `get_app` prints the `tree:`, the `node addresses:` (the address of\n each node the app draws, `(default)` on those the tree leaves to the platform) and the `version` line, whose id is the `base_version_id` to send. A member who is not the\n app\'s author is shown no tree. Keep the tree: no tool reads an earlier one.\n2. `set_app` with `app_id`, `base_version_id` (that version: a newer write is refused, not overwritten) and `nodes`,\n (a refused change writes nothing, so `dry_run` is for reading the permissions it would grant and remove). Every answer\n states the permissions the change grants and removes.\n3. `screenshot_app` shows the result.\n\n`nodes` maps an address to a patch of that node. Read against the customers List and page of the account review (\xA7 A complete\nworkspace, abridged), the call below makes `tier` read-only, moves the Orders Section ahead of Account, adds an Act to\nAccount and removes the Reading:\n\n```json\n{\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "children": [{ "type": "List", "entity": "customer", "children": [{ "type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered" }] }],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n { "type": "Section", "key": "account", "title": "Account", "children": ["tier"] },\n { "type": "Section", "key": "orders", "title": "Orders", "children": [{ "type": "List", "entity": "order" }] }\n ]\n }\n ]\n}\n```\n\n```json\n{\n "app_id": "<id of the app>",\n "base_version_id": "<current_version_id>",\n "nodes": {\n "tier": { "edit": false },\n "orders": { "before": "account" },\n "mark_gold": { "type": "Act", "in": "account", "label": "Make gold", "when": { "tier": ["standard"] }, "set": { "tier": "gold" } },\n "ordered_by_tier": null\n }\n}\n```\n\nEach entry applies in order:\n\n- **An existing node:** a JSON merge patch (RFC 7396) of its props; `null` drops a prop, and a list (`children`,\n `columns`) replaces the node\'s whole, as `layout` does: a patch states the whole layout.\n- **`null`:** removes the node and everything under it.\n- **An address naming no node, with `type`:** adds a node into the node its path names (`"pages/<entity>": { "type":\n "Record", \u2026 }` adds a Record page), or, for a bare key, into the node `in` names (`/` the app); its key is the\n address\'s last word, and a Field states `field` in place of `type`.\n- **`in`, `before`, `after`:** move a node into another, or ahead of or behind a sibling.\n\nThe app\'s own props (`name`, `description`, `icon`, `color`, `words`, `scope`, `period`) change\nthrough `body`, a merge patch over the App node. `dry_run` checks a change and writes nothing.\n\n| To change | State |\n|---|---|\n| a field read-only | `"edit": false` on its Field, or on the Section, Side or Record that draws it |\n| a column added or dropped | `columns` of the List, every column kept: a List that never stated `columns` draws none beyond the row\'s title and its `records` line |\n| a button | an Act node (\xA7 Act node); `confirm` makes its press ask first |\n| a label | the table\'s field `label` in `set_tables`, for every app; for this app alone, `body: { "words": { "<table>": { "fields": { "fee": "Consultation" }, "options": { "urgency": { "rush": "Same day" } } } } }`; a List\'s `label`, a Section\'s `title`, an Act\'s `label`, `add_label` on the add. A Field\'s `label` heads only a gallery or prose block |\n| the order of nodes and rows | `before` or `after` a sibling, or `in` another parent, in the node\'s entry (a Section ahead of another, a Field ahead of another in its Section); a List\'s `columns` read in the order stated; its rows read in its `sort`: `{ "sort": { "field": "collected_on", "desc": true } }` |\n| the row\'s second line | `row: { "subtitle": ["mechanic"] }` on the List: up to two fields under the title, in place of the table\'s `records` line, which stays as it is |\n| a picker\'s add | `add` on the linked table\'s page: `{ "type": "Record", "entity": "pet", "add": ["species", "microchip"] }` asks those fields of the new row; absent, the picker only picks. It holds in every picker of that table in the app |\n| a linked row fixed or deleted where its link stands | the linked table\'s page in `pages`: the link\'s card opens the row in the drawer as that page draws it, saving what it writes, with a Delete where it states `remove: true`. A table a List of the app draws is worked in that List |\n| a headline figure | a Reading in the List: `{ "type": "Reading", "in": "orders", "label": "Prepaid owed", "value": "prepaid", "where": { "stage": ["awaiting_payment"] } }` sums the rows in view; without a `value` it counts them |\n| a calendar and its date | `layout: { "calendar": { "date": "pickup_on" } }` on the List, with `end` for the date a row runs to (both days or both moments); the bare `"calendar"` takes them from the rows\' facts and is refused, naming `date`, where those name none |\n| a record\'s child lines | a List inside the Record\'s Section over the child table: `{ "type": "List", "in": "details", "entity": "repair_line" }`; the child table (one link back to the record) and the record\'s rollup over its rows come from `set_tables` first. Lines priced off a book: `docs path="design/treatments/moves-and-numbers/priced-lines"` |\n\n**A node the tree leaves to the platform has an address too.** `get_app` lists the nodes the app draws, those the stored\ntree does not state marked `(default)`: the Record with its Sections and Fields, the status buttons, the band of readings.\nPatch one by its address and the call states it first: the nearest node the tree does state gains the default child that\nleads to it, as drawn (the whole page in `pages` for an entity that states none, with its `row` picture, and the List\'s `columns` the\ndefaults added; every Section of a Record that states no part; every status button of the app, each in the Section of its\nstage; every reading of the band, since stating one stands the others down), then the patch applies. Defaults\noutside that subtree stay defaults, and the answer\'s notes say what was stated. Removing every reading, or every status\nbutton, is refused: a set no node states is drawn again by the platform, and only `readings: false` on the List or\n`row.status: { "edit": false }` on the Record draws none. **A stated subtree stays as it is**: a\nfield or option the tables gain later is not added to it, so name it in the tree. `{ "due_date": { "edit": false } }`\nover a sparse tree makes that field read-only and takes away `saves <table>: due_date` alone. An address that ends several\ndrawn nodes is refused, as for stated ones.\n\n**A write places what has one fix, and says so.** The stored tree is the placed one, `get_app` shows it, and the answer lists\neach placement at its address, so you read the difference instead of meeting a refusal:\n\n- `where: { "<field>": { "me": true } }` on a root List moves to `opens`, the chip that names the reader. A child List\n keeps the refusal: bound access with a row rule, or list the rows in a root List.\n- A read-only repeat of a field across a record\'s steps, or a Field beside the files or text block that draws it, is left\n out and said; the statement stays in the tree.\n- `door` on the page of an entity no root List and no Sheet\'s List is over, where the page states no Side, is\n not drawn and is said: its rows open in place. It stays stated, and applies once one of those or a root List does.\n\n## What an app may write\n\nAn app states no list of what it writes: the tree derives it, and the generated workflows accept exactly that, so it is\nalso what an agent can do through the app\'s API. `get_app` prints it beside the tree.\n\n1. **A save of field `f` of table `E`** exists when a node draws `f` on a page of `E`\'s rows (a Field in a Record,\n Section or Side, or a part of the head), the table lets a person write it (stored; not computed, stamped or the\n back side of a child\'s link), no Act of the app on `E`\'s rows writes it, and neither the node nor a container above it\n says `edit: false`. A row\'s stage is moved by an Act or the one button per move a status no Act moves gets, by hand only where its Record\'s `row.status` says `{ "edit": true }`, and by none where it says `{ "edit": false }`.\n2. **An add of `E`** exists for a List over `E` that writes its rows unless it says `create: false` (asking what it lists, and\n setting the link back to the record itself), and for every picker of `E` where `E`\'s page states `add`. An absent `create`\n stands down where the table states no `singular` (nor the app\'s `words`), or where `where` keeps a select at an option an\n Act sets other than the one a new row starts at; a stated `create` list over such a table is refused. A roster\'s cells and\n a document are added only where `create: true`.\n3. **A Delete of `E`** exists for a List over `E` unless it says `remove: false`, and for the table of each of that\n List\'s `sources` (a source has no `remove` of its own). A roster\'s cells, a document and a desk\'s rows are deleted only where `remove: true`.\n A Delete comes with `restore_<entity>`, which brings the row back with the rows its delete took, all or none.\n `remove: false` takes this app\'s Delete away and no more: the record tools, the API and other apps still delete. A row no\n surface may delete is a table check with `on: ["delete"]`.\n4. **An act** exists for each Act node. Every field it sets, asks, files into, signs or records is the act\'s, and read-only\n everywhere else in the app.\n5. **The table\'s contract holds on every path** and is not restated here: required, unique, no overlap, field rules, table\n checks, stage owners, history and the read scope. (`natural_key` is read by an app\'s add and find-or-create alone.)\n\nDrawing is reading or saving; a List that writes its rows also adds and deletes them, until it says `create: false` or `remove: false`, and a List below a part or a Record that says `edit: false` writes, adds and deletes none.\n\n### What a table gives a component\n\n| Table fact | Feeds |\n|---|---|\n| The title | every row\'s name: Lists, a Record\'s head, link chips, pickers, an add |\n| The row\'s line (`records` subtitle, figure, image, mark, party, description) | the row\'s line and head, cards, a checklist\'s photo |\n| The stage (`records` status) | the stage chips, a List\'s `opens`, the badge, an Act\'s moves, stage owners gating acts, a Section\'s `at` |\n| Deadlines (`records` due, settled, frees) | countdowns and overdue marks, the default sort, attention order, spans on lanes, calendars and rosters |\n| Bounds (`records` limits, gates, tolerance) | the figure\'s meter, wherever it stands |\n| Tasks and cadence (`records` task, cadence) | the ring on task rows, a roster\'s owed days |\n| Applicability and starts (`records` applies, starts) | a field shown and asked only where it applies; an add\'s starting values |\n| A field\'s `required`, `default`, `default_from`, `natural_key`, `unique` | what an add asks, and what it starts at |\n| A field\'s `notation`, `format`, options, `options_where` | money, units, chips, and what a picker offers |\n| The table\'s `read_scope` | which rows each reader reads, in every List |\n\n### Where the rules stand\n\n\xA7 App rules and the rule pages after it are every rule the check holds over an app, by id, whichever component it concerns. A\n**language** is decided by the app\'s own words: a tree names no locale, so what an app draws itself (its buttons, empty\nstates, refusals) is in the language its labels are written in, and `words` count as labels. Mix two languages in one\napp and it answers in two.\n\n## App node\n\nAn app draws its launcher tile, its words, its Views and its API. It binds the tables it names: `set_app` fills\n`tables` with the id of every table alias the tree uses, and `templates` with that of every document template alias.\nA relabel on either side is a rename and no tree points at another table by accident.\n\n<!-- generated:start node-app -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The app\'s alias, its name among apps; the App node is addressed `/`, and no address in it starts with this key |\n| `name` | text, required | The job, in the words of the people who do it |\n| `description` | text | What the job is for, in a sentence |\n| `icon` | text | A Lucide icon name in kebab-case the launcher tile draws |\n| `color` | [colour](#select) | The launcher tile\'s colour |\n| `words` | map of alias \u2192 [Table labels](#table-labels) | A table \u2192 the words this app draws for it |\n| `scope` | alias | The table whose one row the app works inside \u2014 the folder: every List over a table holding a one-row link to it lists the open folder\'s rows and files each add under it; absent, the app reads every row |\n| `folders` | alias | The key of a root List over the table `scope` names: it draws the folders the app opens on \u2014 its columns, filters, grouping, order and summary \u2014 and a row pressed is the folder entered; absent, the folders are listed by their anatomy |\n| `rows` | map of alias \u2192 [Read scope rule](#read-scope-rule) | Each table\'s row rule in this app, by its alias (a table the app only reaches, by the table\'s own alias): who of the people the app is shared with reads which rows, on its screens, its queries, its writes and its workflows. A table the app states none of is read whole by everyone it is shared with |\n| `uses` | list of alias (at least one) | Tables the app\'s Query and Workflow nodes read without drawing them, by alias: they join the tables the app reaches, so a workflow may name them |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window every Sheet opens on: "month", "quarter", "year" or { "days": 30 }; absent, the calendar month |\n| `tables` | map of alias \u2192 text | The id of each table the tree names, by its alias: filled by set_app, never written |\n| `templates` | map of alias \u2192 text | The id of each document template the tree names, by its alias: filled by set_app, never written |\n| `children` | list of ([List](#list-node) \\| [Sheet](#sheet-node) \\| [Query](#query-node) \\| [Workflow](#workflow-node)) (at least one) | The App\'s Views in order \u2014 Lists and Sheets, the first where the App opens \u2014 and its Queries and Workflows. Queries and Workflows alone: an API app, which a server calls with an app key |\n| `pages` | list of [Record](#record-node) (at least one) | The page the rows of an entity open, one per entity, each a Record stating its `entity`; every List over the entity, anywhere in the App, opens it, and a link\'s row no List lists. Absent, the platform draws the page |\n\n#### Table labels\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text | The table\'s name in the plural (a register\'s heading, a block\'s, a link\'s picker) |\n| `singular` | text | One row of the table, as the add and empty sentences name it |\n| `fields` | map of alias \u2192 text | A field alias \u2192 the words this app draws wherever it names the field; the table\'s field keeps its own label |\n| `options` | map of alias \u2192 map of alias \u2192 text | A select field alias \u2192 option alias \u2192 its words |\n\n<!-- generated:end node-app -->\n\n- **Every View at the root is a peer**: a List or a Sheet, in the order stated, the first where the App opens and the\n others each one entry of the App\'s lists, picked under its title, each at its own address: the first at the app\'s root (`/`), any other at `/<key>`, inside the folder where the App is scoped. A List states\n its `label`, any layout, its own Tabs, Readings and Exports, and may read `sources`; two may stand over one entity, and\n both open its one page. Whoever the app is shared with is shown every View, each table narrowed by the App\'s `rows`.\n A list people work every day as a desk of their own is another app.\n- **A Sheet** draws Readings and read-only Lists over the App\'s rows. The App\'s one `period` windows every reading of\n its Sheets placed in time: the calendar month by default, or `quarter`, `year` or `{ "days": 30 }`. An App of Sheets alone\n draws the pages its Sheets\' Lists open (a List naming no `app`), each from `pages` as any page is. A Sheet\'s List\n naming no `app` opens its row\'s page in this app, in the drawer over the Sheet, at `/<sheet key>/<row>`.\n- **Query and Workflow** nodes stand at the root and are never drawn.\n- **Writes:** nothing itself.\n\n## List node\n\nA List draws rows of one table. What its rows are depends on where it stands:\n\n- at the App root: a register, a View of its own among the App\'s;\n- under a Record, Section or Side: the record\'s child rows, filed through the child\'s one link to the record\n (`via` where it has several);\n- under a roster List: the rows that fill the roster\'s cells;\n- with `same` or `app`, or on a Sheet: related rows, read only.\n\nA List below a row\'s page is a View too: it takes Tabs, Readings and Exports as a root List does, and its rows open at\n`/<view>/<row>/<key>`, drawn alone with its band, its way back the row\'s page. An Export of it is the file of that one\nrow\'s rows.\n\n<!-- generated:start node-list -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Names the List among its siblings and in a Query\'s `list`; absent, the entity alias |\n| `entity` | alias, required | The table whose rows the List draws |\n| `sources` | list of [List source](#list-source) (at least one) | Further tables read as one List with this entity |\n| `source_column` | `false` | Reads a List\'s tables as one: false, no column naming each row\'s table and no filter by it; absent, a List with `sources` draws both |\n| `scope` | alias | Says which folder a row files in: with the App\'s `scope`, the one-row link, where the table holds several |\n| `via` | alias \\| text | The child\'s link to the record, where it has several; a List that only reads may state `<link>.<link>`, reaching the record through a row of their own |\n| `same` | alias | A one-row link of the record: the rows sharing its row, the record left out, read only |\n| `where` | [narrowing](#app-tree) | A fixed narrowing on the server, for every reader: a condition (\xA7 Values), and `<link>.<field>`, the rows whose one-row link names a row holding a select or yes/no so. A List that only reads (`same`, a Record with `edit: false`) also bounds a date or number by a field of the record, `{ "record": "<field>" }`: blank, it keeps no row; an Act\'s paper naming the List is handed the same rows; it is never an access bound, which the table\'s row rules are. An add holds only a select\'s option and a yes/no\'s value |\n| `expect` | alias \\| [Expect](#expect) | What a record should hold, shown before it does: one line per option of this select, or per row of this catalog link |\n| `under` | alias | Groups lines by the document covering them: a one-row link to it |\n| `edit` | `false` | Shows rows nobody changes here: false, this List only reads them |\n| `label` | text | The register\'s name in the app\'s lists and tab strip; absent, the entity\'s label. Never the noun of its rows, which is the table\'s label and singular (this app\'s `words`) |\n| `columns` | list of (alias \\| [Edit column](#edit-column)) | Fields read after the row\'s title; `{ field, edit: true }` is the line\'s own control, at most 2. Absent: the title and the `records` line alone |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter)) (at most 3) | Fields the reader narrows by every day, beside the stage chips: a select, member, link, date, yes/no or number range; `tiers` bands a number or date |\n| `search` | list of alias (at least one) | Fields the search box reads; absent, every word of the row |\n| `group` | alias | A field the rows stand grouped by; a gantt draws the groups as its lanes |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The rows\' order; absent, a register reads newest made first, a record\'s rows as added |\n| `opens` | [narrowing](#app-tree) | The view the register opens on, a chip the reader may take away: `where`\'s entries but a record bound, and `{ "me": true }` on a member field or a lookup of one |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window a table\'s or cards\' dated Tabs read, or the day, week or month a calendar or lanes board opens on; absent, this month |\n| `attention` | `false` | Keeps a list in its own order: false, the sort menu offers no attention-first order |\n| `readings` | `false` | Leaves a list without figures above it: false, no band; absent, rows that move, fall due or carry money lead with one. Never with Readings stated |\n| `layout` | [layout](#layouts) | A word, or an object stating one layout with its data; absent, a table |\n| `beside` | `true` | Keeps the list in view while a row is worked: true, a row pressed opens beside this table; a root List drawn as a table. Absent, the page\'s `door` |\n| `compare` | [Compare](#compare) | Each row\'s before against its after: two files fields as a pair of photos, or two values of one type as one column |\n| `current` | alias | A child List of revisions: the child\'s date or number field ordering them. The latest reads as current, the others fold under "superseded \xB7 N"; the record shows the current file through a lookup of the child ordered by it |\n| `create` | boolean \\| list of alias (at least one) | The fields an add asks; `false`: rows are not added here. Absent: where this List writes its rows, the table\'s required fields, natural key and title; nothing where the table states no `singular` (nor the app\'s `words`), or `where` keeps a select at an option an Act sets other than the one a new row starts at. A roster\'s cells and a document add only where `true` |\n| `add_label` | text | The add button\'s words; absent, the platform\'s word and the singular |\n| `remove` | boolean | Rows offer a Delete. Absent: where this List writes its rows; `false`: this app\'s Delete alone is gone, and a row no surface may delete is a table check with `on: ["delete"]`. A roster\'s cells, a document and a desk\'s rows delete only where `true` |\n| `pick` | `true` | Also picks rows of the child that no record holds yet |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `children` | list of ([Tab](#tab-node) \\| [Reading](#reading-node) \\| [Export](#export-node) \\| [Act](#act-node) \\| [List](#list-node)) (at least one) | Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view; under a roster the List of its cells, with `under` the List of its documents. An Act on one row and every Check stand in `pages/<entity>` |\n\n#### Edit column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The column\'s field |\n| `edit` | `true`, required | Lets a person change the value on the line: true, its own control, written in place |\n\n#### Expect\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The child\'s title, one row per value: a single select or a one-row link to a catalog |\n| `of` | alias | Lets each record choose its lines: with a select, the record\'s own multi-select naming the options it expects, in place of every option |\n| `only` | list of alias (at least one) | Holds lines for some options alone: with a select, those options; never with `of` |\n\n#### Compare\n\n| Key | Type | Meaning |\n|---|---|---|\n| `before` | alias, required | The rows\' field holding what stood before: files, text, a number, a date or a single select |\n| `after` | alias, required | A field of the same type holding what stands after |\n| `edit` | `true` | The after is written on the line |\n\n#### Tiered filter\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number \u2014 stored, or a formula or rollup reading one \u2014 in one unit for every row |\n| `tiers` | list of number (at least one), required | The breakpoints between its bands, ascending, in the field\'s stored unit: under the first, from each to the next, from the last up \u2014 each band worded in the field\'s notation; a filter picks several at once |\n\n#### Sort key\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field rows are ordered by |\n| `desc` | boolean | Latest or largest first; absent or false, soonest or smallest first |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.scope` | With the App\'s `scope`, a List over a table holding one one-row link to the folder\'s table is filed in the open folder by it, and one holding several names it in `scope`; that link is required. A List over the folder\'s own table states no `scope`. |\n| `list.unscoped` | *Noted, never refused:* In an App that states `scope`, a List over a table holding no one-row link to the folder\'s table lists every row, in every folder; so does a Tab\'s totals over a child holding no single link to it. |\n\n<!-- generated:end node-list -->\n\nA List takes only the props its place lists:\n\n<!-- generated:start list-places -->\n\n| A List standing in | Takes |\n|---|---|\n| every List | `key`, `entity` |\n| every List on a record | `via`, `label`, `when`, `filters`, `search`, `group`, `sort`, `opens`, `period`, `attention`, `readings` |\n| a root List (the first is the register) | `label`, `columns`, `filters`, `search`, `group`, `sort`, `opens`, `period`, `attention`, `layout`, `beside`, `create`, `add_label`, `remove`, `readings`, `where`, `edit`, `sources`, `source_column`, `scope` |\n| a record\'s child rows, as a table, a checklist, a desk or a gantt (which refuses `under`, `pick`, `compare`, `current`, `expect` and an `edit: true` column) | `columns`, `create`, `add_label`, `where`, `under`, `remove`, `pick`, `layout`, `compare`, `current`, `expect` |\n| a record\'s child rows with `layout` an agenda | `columns`, `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s child rows with `layout` `"timeline"` | `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s related rows, read only (`same`, or a Record that is `edit: false`) | `where`, `columns`, `same`, `edit` |\n| the documents a child List\'s lines stand under (`under`), a List inside it | `create`, `remove` |\n| the cells of a roster, a List inside it | `expect`, `create`, `remove` |\n| a Sheet\'s list, read only | `label`, `where`, `columns`, `sort` |\n\n<!-- generated:end list-places -->\n\n- **The page a child List\'s rows open** is the entity\'s page in `pages`: its Fields in stated order, those the rows\' saves write editable, and the List\'s `columns` are the line. A row opens in place under itself: its fields or Sections, then each List of its own children, at any depth. With `edit: false` the List reads as a related-rows List does.\n- **Documents:** in a child List with `under`, a List over the document\'s table (`key`, `entity`, `create`, `remove`,\n Acts and Checks; the document\'s Fields and Lists stand in its page) is the one place the documents are added or deleted;\n `create` states `true`, and `remove` needs `create: true` beside it.\n- **Writes:** a layout move (a gantt bar, a lane\'s block, a plan\'s item) writes only fields the app already writes on the row\'s page.\n- **`create` asks:** `true` asks the title, the natural key and every required field a person writes, never a computed\n or stamped field or the link the place sets. An `expect` list also asks the key it makes its lines by, and their picture.\n- **`filters`:** a threshold the business names ("large orders") is a formula yes/no, and bands it names (new, warm, cold) a formula with options, never a range.\n- **`opens`** absent, the register opens on the open work (rows not at a `closed` stage).\n- **`expect`:** an empty line adds its row (a checklist of papers per case).\n\n## List source\n\nSources are further tables a root List reads beside its entity as one List: the same job kept in tables of their own (a legacy ledger, a second branch\'s register). Each is projected onto the List\'s fields \u2014 by alias, else by its `fields` (the List\'s field \u2192 the source\'s) \u2014 and options line up by alias; its `where` narrows its own rows. Each row opens its own table\'s page in `pages`, stated or refused (`list.source-page`), and runs the Acts and Checks that page states: nothing the List offers its own rows reaches a source\'s. The add offers each table, asking the List\'s `create` in that table\'s fields; a source lacking one adds no row. `source_column: true` draws a column naming each row\'s table, and a filter by it. Every source holds the title, the stage and the scope; a table, cards or a plan reads sources, and an Export\'s `sources` makes a report of some of them.\n\n<!-- generated:start node-list-source -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | A further table this List reads beside its own entity: the same job over its rows |\n| `fields` | map of alias \u2192 alias | A field of the List\'s entity \u2192 this table\'s field holding the same fact, where their aliases differ |\n| `where` | [narrowing](#app-tree) | Which of this table\'s rows the List reads |\n| `row` | [List source row](#list-source-row) | How the List reads this table\'s rows, where it differs from the table\'s `records` |\n\n#### List source row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `status` | `{ "edit": true }` | Lets a person move this table\'s stage by hand in the List: `{ edit: true }` |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.sources` | A List\'s `sources` each name another entity once (`entity`) \u2014 never the List\'s own \u2014 whose fields line up with the List\'s by alias, else by `fields` (a field the List reads, or one an Export prints \u2192 one of the source\'s): read as one column type (a day apart from a moment), one value or several alike, a link to the same entity. Each source holds the title, the status where the List shows one, the List\'s folder link and what `where` keeps; the List is a table, cards or a plan, whose `at`, `across` and `up` line up like any field. Two sources holding a field of their own under one alias hold it as one kind of value. An Export\'s `sources` each name the List\'s entity or one of its sources, once, and one of them holds each field its `where` and `per` narrow by. A List with `sources` draws a column naming each row\'s table, and a filter by it; `source_column: false` draws neither. A source\'s rows open the page of its own entity, which states the Acts and Checks they run: each Act\'s `key` its own among the App\'s Acts. |\n| `list.source-lacks` | *Noted, never refused:* A source lacking a field its List\'s `create` asks adds no row; one lacking the select its List\'s plan marks or sizes by never marks or sizes its rows. A field only an Export prints, held by a source as another kind of value, prints blank on its rows. A Tab\'s `totals` over a child linking to no row of a source total nothing on its rows. |\n| `list.source-option-kin` | *Noted, never refused:* A source\'s option labelled as one of the List\'s, under another alias, reads apart from it: the List lists both and counts each on its own. |\n\n<!-- generated:end node-list-source -->\n\n## Layouts\n\nA List\'s `layout` is how it draws its rows: a word (`"table"`, `"cards"`, `"calendar"`, `"roster"`, `"timeline"`) or an\nobject stating one layout and the data it reads (`{ "gantt": \u2026 }`, `{ "lanes": \u2026 }`, `{ "plan": \u2026 }`, `{ "agenda": \u2026 }`,\n`{ "checklist": \u2026 }`, `{ "desk": \u2026 }`). Absent, a table: the word `"table"` is the register\'s, and a child List states a\nchecklist, a desk, a gantt, an agenda or `"timeline"`, else leaves `layout` out. Each layout reads what the rows already state \u2014 their\n`records` line, stage and dates \u2014 and the keys a layout adds stand on its section: here for an agenda and a checklist, \xA7 Time and place layouts for the rest, \xA7 Publish desk for a desk. Which one a job needs: the\n`design` reference. The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a record\'s\nchild rows as a table, a checklist, a desk, a gantt, an agenda or a timeline.\n\n### Table\n\n<!-- generated:start layout-doc-table -->\n\nAbsent `layout`, each row is one line: the table\'s `records` entry \u2014 its picture or mark, title and the line under it \u2014\nthen the stage, the `columns`, and the figure at the right; the title, the stage and a column of days or amounts sort\nthe rows by their header. A table groups its rows by `group`; a table or cards reads `Tab`s and the `sources` of its List.\n\n<!-- generated:end layout-doc-table -->\n\n### Cards\n\n<!-- generated:start layout-doc-cards -->\n\n`"cards"` draws each row as a card led by its picture \u2014 the `records` `image`, or the List\'s `row.image`: its title and\nthe line under it, its stage and what needs the reader (a deadline, a warning), then its figure and the `columns` at its\nfoot. Cards are for rows found by their picture (a product, a vehicle, a damage photo); rows with no picture read better\nas a table.\n\n<!-- generated:end layout-doc-cards -->\n\n### Calendar\n\n<!-- generated:start layout-doc-calendar -->\n\n`"calendar"` or `{ "calendar": { "date": "starts_at", "end": "ends_at" } }` places each row on its day \u2014 a month, a week,\na day or a list (a phone reads the list or a day): at its hour where `date` holds one, over its span where `end` names\nthe date it runs to, with its line\'s other words and the `columns` after its title. `date` and `end` are two dates of\nthe row, both days or both moments; a span of moments gives a phone its day view, and a day\'s `end` is the last day held\n(unless `records` names it the day the row `frees`). The bare word takes them from the rows\' facts: two dates a person\nstates, the second ordered after the first by a `min` or a table check, both required or the second the row\'s `due`; else the one required\ndate a person states that no Act stamps and a new row does not start at today \u2014 and is refused, naming `date`, where the\nrows hold neither. A `due` is a deadline, never the day a row is held on. The calendar reads the window in view, and its\ncount and the stage chips count that window, opening on every row.\n\n<!-- generated:end layout-doc-calendar -->\n\n<!-- generated:start layout-calendar -->\n\n#### Calendar keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `date` | alias, required | The date or moment of this entity each row stands on: a viewing\'s start, a hire\'s first day, a visit\'s day |\n| `end` | alias | The date or moment each row\'s span ends on, read as `date` is \u2014 two days or two moments (a moment\'s end gives a phone its day view); absent, a row stands on `date` alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.calendar` | `layout: "calendar"` or `{ calendar: { date, end } }`: two dates of the row, both days or both moments; bare, it takes the rows\' span or appointment, else is refused, naming `date`. |\n\n<!-- generated:end layout-calendar -->\n\n### Roster\n\n<!-- generated:start layout-doc-roster -->\n\n`"roster"` draws the List\'s rows down the side and the days of a week or a month across; the roster\'s cells are a List\ninside it over the table whose rows fill the days \u2014 each stands on one row by its single link to it, and on the first\ndate of its line (a shift on a person\'s day, a run on a vehicle\'s), on every day through the second date where its line\nholds one. A cell reads its row\'s stage, else the first single select on its line (a shift\'s kind), several rows their\ncount. A day holding none stays empty: nothing was due, which is never an absence. A filled cell opens its row; an empty\none adds a row there, the register row and the day set. With `expect` on the cells (a single select of those rows) the\ncolumns are its options in place of days \u2014 a checklist of papers \u2014 and `of` names the ones each row expects: a gap among\nthem reads as one and adds its row, the others stand blank, and each row reads what it holds of them, `2/3`. Over days, a\nroster reads the `cadence` its table\'s `records` states (a site\'s diary page, Monday to Saturday from breaking ground to\nhandover): a past day owed with none is marked missing and counted, and each row reads the days it holds of those owed. A\nroster states no `columns` and needs no readings: its legend counts each state in view.\n\n<!-- generated:end layout-doc-roster -->\n\n```json\n{ "type": "List", "entity": "operator", "layout": "roster", "filters": ["depot"], "children": [{ "type": "List", "entity": "run" }] }\n```\n\n### Timeline\n\n`"timeline"` reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds\nentries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each\nmove. A timeline\'s moment is its child\'s first date, and who its member field. Rows each what happened on a day and who \u2014\na date on their line, a member, no stage and no figure \u2014 read best as a timeline.\n\n### Agenda\n\n`{ "agenda": { \u2026 } }` reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its\npicture and the day that is today marked. The day is the first date on the child\'s row line (its `records` title or\nsubtitle); within a day entries follow a datetime there, else the first single select after the date. An entry with no day\nyet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading\ncounts from it (Day 1, Day 2).\n\n<!-- generated:start layout-agenda -->\n\n#### Agenda keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The record\'s date that is the first day: each day\'s heading counts from it; absent, the weekday and the date alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.agenda` | An agenda List\'s child names a date on its row line (`records` title or subtitle); the layout\'s `start` is a date of the record. |\n| `list.agenda-note` | *Noted, never refused:* Rows each on a day and within it (at an hour, in a part of the day) listed as a table: a List with `layout: { agenda }` draws them by day. |\n| `list.timeline` | A timeline List\'s child holds a date to place its entries by. |\n| `list.timeline-note` | *Noted, never refused:* Rows each what happened on a day and who \u2014 a date on their line, a member, no status and no figure \u2014 listed as a table: a List with `layout: "timeline"` draws them as a timeline, newest first. |\n\n<!-- generated:end layout-agenda -->\n\n### Checklist\n\n`{ "checklist": { \u2026 } }` reads a record\'s child rows, which are tasks, as a checklist of checks: each one\'s mark \u2014 passed\nat a `closed` option, failed at a `failed` one, else still to check \u2014 its title, its columns as its words (a text column\nits note, on its own line), and on a line under its title its photo and its clause. Never grouped nor written in place.\n`passed` alone sets the mark, so rows with no `task` and no status are checks: a measured yes/no is the verdict. With\n`expect` on the standard\'s items, each item is a line marked the same way (a missing one still to check), filled in\nplace by the block\'s `columns` (a measured value, a note, a photo), so `photo` and `clause` are not named.\n\n<!-- generated:start layout-checklist -->\n\n#### Checklist keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photo` | alias | The child\'s files field holding the photo each row is checked by; absent, the child\'s `records.image` |\n| `clause` | alias | The child\'s one-row link to what each row is checked against \u2014 a standard\'s clause, a rule |\n| `failed` | list of alias (at least one) | Options of the child\'s status a row stands failed at \u2014 none of them closed |\n| `passed` | alias | The child\'s yes/no field (stored or a formula) setting each row\'s mark: yes passed, no failed, empty still to check |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.checklist` | A child List with `layout: { checklist }` reads a task entity\'s rows as checks \u2014 never under documents, grouped, edited in place or picked together by an Act over several, its columns no files; `photo` names a files field of the child, `clause` a one-row link of it, `failed` options of its status, none `closed`; `passed` a yes/no of it, stored or a formula, setting each mark (yes passed, no failed, empty still to check) and standing without `task` or a status. With `expect` the lines of a standard are the checks, each marked and filled by the block\'s columns (a measured value, a note, a photo), so `photo` and `clause` are not named. |\n\n<!-- generated:end layout-checklist -->\n\n## Time and place layouts\n\nThe layouts that place a List\'s rows in time or on a plan. Each is a `layout` object stating the data it reads.\n\n### Lanes\n\n<!-- generated:start layout-doc-lanes -->\n\n`{ "lanes": { "by": \u2026 } }` draws each row of the linked table as a lane (a chair, a machine, a room), empty ones too,\nand each row of the List as a block from the first date on its line to the second: over the hours of one day where the\nfirst holds its hour, else over the days of one day, a week or a month. X a free stretch between blocks adds a row there, its lane and its start set, and its end where the next block\nbounds it. Rows naming no lane stand first, in a lane of their own; where the app writes the link, each block moves to\nanother lane from its menu. Inside a `scope`, the lanes are the ones whose own one-link names that scope\'s row. A span\'s\nend holds its day unless `records` names it the day the row `frees`.\n\nA person is a lane too: `by` may name a member field holding one person, with `of` the role (one of the model\'s\n`roles`) whose every member is a lane, empty ones too \u2014 `{ "lanes": { "by": "engineer", "of": "engineers" } }`. A row stands\nin the lane of the person it holds, and a `no_overlap` by that member keeps one row per person at a time. `of` is\nrequired with a member `by` and refused with a link; `loads` read a lane\'s row, which a person is not.\n\n`loads` names what a lane carries: `{ "weight": "payload", "volume": "box" }` sums each block\'s number and reads it\nagainst the lane row\'s own, at most two; each block then reads that number after its first column. A lane holds its blocks while they stand, so it reads the most they add up to at\none time in the window, named, past its bound, by how much and on which day or hour. The two are in one unit, or two of\none dimension. A bound a single row must keep (no parcel heavier than its van) is a `max` on the field through the link,\nwhich refuses the move.\n\n<!-- generated:end layout-doc-lanes -->\n\n<!-- generated:start layout-lanes -->\n\n#### Lanes keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `by` | alias, required | A one-link of this entity whose target\'s rows are the lanes (a chair, a machine, a room), each drawn even when empty; or a member field holding one person, whose lanes are the members of the role `of` names |\n| `of` | alias | Shows a whole team, the idle included: with a member `by` only (refused with a link), the role, one of the model\'s `roles`, whose every member is a lane, drawn even when empty |\n| `loads` | map of alias \u2192 alias | What a lane carries against what it holds, at most 2: a number of this entity each block adds \u2192 a number of the lane\'s row it is held within, in one unit or two of one dimension |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.lanes` | `layout: { lanes }`: `by` is a one-row link to an entity with a `records` entry, the rows name a date on their line (a field of the row itself, or a lookup of its parent\'s date), a lane block\'s two ends are read alike (two days or two moments), and `loads` stands with it. |\n| `list.loads` | A lanes layout\'s `loads` names one to 2 numbers a lane block adds \u2014 never a percent \u2014 each against a number of the lane\'s row, in one unit or two of one dimension. |\n\n<!-- generated:end layout-lanes -->\n\n### Gantt\n\n<!-- generated:start layout-doc-gantt -->\n\n`{ "gantt": { \u2026 } }` draws each row as one bar on one axis of time: `{ "start": "etd", "end": "eta", "milestones":\n["cut_off"], "planned": { "end": "booked_eta" }, "progress": "done", "after": "waits_on" }`. `end` defaults to the table\'s\nfirst `due`, and a table with neither is refused; `start` and `end` are two dates of the row, both days or both moments,\nand each planned date is read as `start` is. `progress` is a percent (0\u2013100); absent, a row whose record lists its tasks\nfills to how many are done. `after` is a link to rows of the same table, each ending before the row starts. The bars\nstand in the lanes of the List\'s `group`. Where the app writes the row and a person writes a bar\'s date, the bar is\ndragged through the row\'s save; a computed date, one an Act sets, or a row the app does not write drags nothing. Over a\ntable that holds rows under rows, each bar stands under the row above it, indented and folded as the register\'s outline\nis, `group` still the outer section. A child List of a record may lay out as a gantt too: the bars of the rows the\nrecord\'s link names.\n\n<!-- generated:end layout-doc-gantt -->\n\n<!-- generated:start layout-gantt -->\n\n#### Gantt bar\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of this entity each row\'s bar starts at (a sailing, a hire\'s start, a task\'s start) |\n| `end` | alias | The date each row\'s bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity\'s first `due` |\n| `milestones` | list of alias (at least one) | Dates of the row marked on its bar\'s line as diamonds, each named by its label (a cut-off, a delivery, the end of free time) \u2014 never `start` or `end` |\n| `planned` | [Gantt plan](#gantt-plan) | The plan each row is read against, drawn as a thin bar under its own \u2014 each date read as `start` is; a missing one is the bar\'s own |\n| `progress` | alias | A percent of this entity (0\u2013100) filling each row\'s bar as far as the work is done; absent, how many of the row\'s tasks are done fills it where its record lists them, else the bar wears its status\'s tone |\n| `after` | alias | A link of this entity to its own rows each row waits on \u2014 it starts once they end (finish-to-start), an arrow from each; a row starting before one ends is drawn in the danger tone |\n\n#### Gantt plan\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The date the row was planned to start at |\n| `end` | alias | The date the row was planned to end at (a booked arrival) |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.gantt` | `layout: { gantt }`: `start` and `end` (absent, the entity\'s first `due`) are two different dates of the row, both days or both moments; each diamond (`milestones`) another date of it, each planned date read as `start` is, `progress` a percent and `after` a link to rows of the same entity. |\n\n<!-- generated:end layout-gantt -->\n\n### Plan\n\n<!-- generated:start layout-doc-plan -->\n\n`{ "plan": { \u2026 } }` draws things that stand at a place \u2014 pallets in a warehouse \u2014 on a plan of the places. The places are\nthe rows of a table whose `records` states a `plan_place` (a bay, an open area or a landmark, each at its spot on a sheet\nof the plan); `at` names the one-link of the List\'s rows to a place and, for an item in a bay, the row (`across`) and the\ntier (`up`) it stands in, counted from 1. A bay is drawn as its rows and tiers, an area with a count, a landmark as a\nlabelled frame; the reader sees a plan, one bay enlarged, and the same plan in 3D. The List may read other tables as\n`sources`: one plan of every table\'s items. Each item carries `__reach` \u2014 how many items stand in the way of taking it out\n(those above it where the place is `stacked`, and those in the rows between it and the side `reach_from` says the bay is\ntaken from) \u2014 so the list, its export and an agent\'s read all carry it; `<table>_plan_load` counts the rows each place\nholds. A move through the app is refused unless it clears the place, row and tier all three, or places the item at\na free cell of a bay \u2014 resting on a present item where the place is `stacked` \u2014 or at an area. Every other write (a grid edit, an import, a tool) holds one item to a cell only where the item\'s table states `unique: [<at>, <across>, <up>]`; a plan over a table stating none is noted. A plan opens on every row\nits `where` keeps, with no stage chip narrowing it. Rows with no place wait in a tray beside the plan. An Act that asks exactly a place (a link to the plan\'s places) and two numbers (the row and the tier) is answered by a pick on the plan, never by a form. On a desk a press opens a row\'s record in the panel beside the plan.\n\n<!-- generated:end layout-doc-plan -->\n\n```jsonc\n// table "bay"\n"title": "code",\n"records": { "plan_place": { "kind": "kind", "x": "x", "y": "y", "across": "rows", "up": "tiers", "reach_from": "taken_from", "stacked": "is_stack" } }\n```\n\n```json\n{ "type": "List", "entity": "pallet", "filters": ["line"], "layout": { "plan": { "at": "bay", "across": "row", "up": "tier" } } }\n```\n\n```jsonc\n// table "pallet": one item to a cell on every write, not only through the app\n"unique": [["bay", "row", "tier"]]\n```\n\n<!-- generated:start layout-plan -->\n\n#### Plan keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `at` | alias, required | A one-link of this entity to an entity whose `records` states a `plan_place`: where each row stands |\n| `across` | alias, required | A number field: the row of a bay a row stands in, counted from 1; empty at an area |\n| `up` | alias, required | A number field: the tier of a bay a row stands at, counted from 1 at the ground; empty at an area |\n| `fill` | alias | A single select the items are coloured by; absent, the first single select among the register\'s filters |\n| `mark` | [Plan mark](#plan-mark) | A row holding the option says the option\'s label on its box and is hatched in the option\'s own colour, and the legend names it by the label; over `sources`, the select is matched by option alias, and a source lacking the select never marks its rows |\n| `size` | [Plan size](#plan-size) | Each row\'s box as it stands in the world, in the one length unit its places\' `size` states: the option the row holds of the select names its box\'s width across, depth along and height; over `sources`, matched by option alias, as `mark` is; a row holding an option it does not name is drawn at its place\'s cell |\n\n#### Plan mark\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `option` | alias, required | An option alias of that select |\n\n#### Plan size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `options` | map of alias \u2192 [Plan size box](#plan-size-box), required | The box of each option alias of that select |\n\n#### Plan size box\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | number, required | The box\'s width across the bay\'s rows |\n| `along` | number, required | The box\'s depth along them |\n| `up` | number, required | The box\'s height |\n\n#### Plan place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `kind` | alias, required | A single select, options aliased `bay` and, where the places have them, `area` and `landmark`: a bay holds rows and tiers, an area neither, a landmark nothing |\n| `sheet` | alias | The plan sheet it is on: a single select, or a one-row link to an entity whose `records` states its `image` \u2014 the sheet\'s drawing, which the places are drawn over (with `scale`) |\n| `scale` | alias | A number field of the sheet entity `sheet` links to: how many cells wide its drawing is, the plan\'s scale. Required where that entity states an `image`, and only then |\n| `x` | alias, required | A number field: left edge, in cells |\n| `y` | alias, required | A number field: top edge, in cells |\n| `width` | alias | A number field: an area\'s frame width, in cells |\n| `depth` | alias | A number field: an area\'s frame depth, in cells |\n| `across` | alias, required | A number field: a bay\'s rows |\n| `up` | alias, required | A number field: a bay\'s most tiers |\n| `reach_from` | alias | A single select, options aliased exactly `first`, `last`, `both`: the side boxes leave a bay from; a bay that names none has no reach and no arrow |\n| `stacked` | alias | A boolean field: true where items at this place rest on the one below (a stack), so a tier above the first needs a present item under it, shows floating without one, and an item\'s reach counts the items above it; false or empty, items sit at any tier and only the rows between a bay\'s reach side and the item are in the way |\n| `size` | [Plan place size](#plan-place-size) | The real size of ONE cell of the place, for 3D: three number fields stating one length `unit` alike. Absent, a cell is drawn at the size most of the sheet\'s places state, a unit cube where none states one |\n\n#### Plan place size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of one cell across the rows |\n| `along` | alias, required | A number field: the depth of one cell along the place |\n| `up` | alias, required | A number field: the height of one cell, one level |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.plan` | `layout: { plan }`: `at` is a one-row link to an entity whose `records` states a `plan_place`, `across` and `up` two different numbers of the row, `fill` a single select; a plan List has no Tabs, `group` or `attention`. A write that sets `at`, `across` or `up` is refused unless it clears all three, or places the row at a free cell of a bay (a row from 1 to the bay\'s `across`, a tier from 1 to its `up`, resting on a present item), or at an area with neither. |\n| `list.plan-unique` | *Noted, never refused:* A plan\'s items (the List\'s table and each source) state `unique` on their place link, `across` and `up`: the app\'s moves refuse a taken cell, and the unique makes every other write hold it \u2014 the note names a table that states none. |\n| `list.plan-mark` | A plan\'s `mark` names a single select of the row, or a lookup of one through a one-row link, and an option of it by alias: a row holding that option is hatched on its box in the option\'s colour, which the legend names by its label. A source that holds the select must hold it as a single select with that option; a source lacking it never marks its rows (`list.source-lacks`). |\n| `list.plan-size` | A plan\'s `size` names a single select of the row, or a lookup of one through a one-row link, and, by option alias, the box (`across`, `along`, `up` \u2014 positive, in the one length unit the places\' `size` states) of each option: a row holding one is drawn as that box, any other at its place\'s cell. A source that holds the select must hold it as a single select; a source lacking it draws its rows at their places\' cells (`list.source-lacks`). |\n| `list.plan-box-size` | *Noted, never refused:* A plan whose places state a `size` and whose rows\' select options are ISO 6346 container size-type codes (`20DC`, `40HC`) states the box of each in `size`, from the ISO 668 dimensions, else every box is drawn at its place\'s cell. |\n\n<!-- generated:end layout-plan -->\n\n## Publish desk\n\nRows that are each a place the record is sent \u2014 a notice\'s boards, a listing\'s portals \u2014 are a record\'s child List with\n`expect` on the child\'s one-row link to the catalog of those places and `layout: { "desk": \u2026 }`:\n\n```json\n{\n "type": "List",\n "entity": "posting",\n "expect": "board",\n "columns": ["posted_link", "refusal"],\n "layout": { "desk": { "bodies": ["wording", "wording_abroad"], "text": "goes_out_as", "media": "pictures", "link": "page", "group": "reach", "network": "kind", "networks": { "company_page": "linkedin" } } }\n}\n```\n\nThe desk is where the post is written. `bodies` are the record\'s plain text fields it is written in (one per language,\nsay), each its editor between the list and the preview, saved as any field of the record is and drawn nowhere else on it.\nThe preview is `text` read over what is on screen: where `text` is a formula of the child, the desk computes that same\nformula over what is typed, so the post moves as it is written, and a place not ticked previews the words its row would\nhold. For that the formula reads only what a screen holds whole: stored values of its row, the record through lookups over\nthe link back to it, the place through lookups over `expect`, and formulas of the row over those \u2014 a rollup, a lookup\nthrough another link or the clock is refused, naming the field.\n\nEvery place the link admits is a line with a tick and that place\'s face: its picture, else the mark of the network it is on\nwhere `networks` names one. `group`, another single select of the place, stands the lines under its options in their\norder: a kind holding a ticked line is open, one holding none folded to its heading and its count. A tick makes the line\'s\nrow from its key alone \u2014 so nothing else the child requires is left without a default \u2014 and an untick deletes it until the\nrow\'s stage is `closed`: what went out is not taken back. It asks first only where a person wrote on the row. One line is\nworked beside the list and read as the post that place\'s feed shows: `text` is the child\'s words for that place, `media`\nand `link` the record\'s, and `network` the place\'s single select whose options `networks` names to a feed; an option not\nnamed reads on a plain card. Under the bodies stand the List\'s `columns` a person writes of the line\'s row; under the post,\nthe press copying its words beside the Acts of the child, then what the line and the `columns` hold that nobody writes\nthere (the link it went out at, why it was refused). A value an Act or a workflow fills is stated as that Act\'s, so the\ndesk never offers it as an empty box. Sending is an ordinary Act of the record.\n\n<!-- generated:start layout-desk -->\n\n#### Desk keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `bodies` | list of alias (1\u20133) | The record\'s plain text fields the post is written in, in order \u2014 one per language, say \u2014 at most 3: each its editor on the desk, between the list and the preview, and drawn nowhere else on the record |\n| `text` | alias, required | A text of the block\'s rows \u2014 stored, or a formula yielding text \u2014 holding the words that go out on that row\'s destination. A formula is computed on the desk too, over what is typed: it reads stored values of its row, the record through lookups over the link back to it, the destination through lookups over `expect`, and formulas of the row over those \u2014 never a rollup, another link or the clock |\n| `media` | alias, required | A files field of the record: the pictures or the video the post carries |\n| `link` | alias | A text field of the record holding a link (`format: "link"`), carried as the post\'s card |\n| `network` | alias, required | A single select of the entity `expect` links to, saying which network each destination is on |\n| `group` | alias | Another single select of the entity `expect` links to \u2014 the destination\'s kind \u2014 the lines stand grouped by: each option a heading in the select\'s order, a group holding no ticked line folded to its heading and its count, destinations holding no option last |\n| `networks` | map of alias \u2192 `"facebook"` \\| `"instagram"` \\| `"threads"` \\| `"x"` \\| `"linkedin"`, required | That select\'s options, each by its alias, to the network whose feed the post is previewed in \u2014 facebook, instagram, threads, x, linkedin. An option not named has no feed to imitate: its words read as a plain card |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.post` | A child List with `layout: { desk }` needs `expect` on a one-row link \u2014 never a select, nor with `under`, `pick`, a checklist layout, `compare` or a `create` list, its line made by a tick from its key alone: its `bodies` are plain text fields of the record a person writes, drawn nowhere else on it; its `text` is a text of the child, stored or a formula yielding text \u2014 a formula reading only stored values of its row, lookups through the link back to the record or through `expect`, and formulas of the row over those, never the clock; its `media` a files field of the record and its `link` a text field of the record; its `network` a single select of the entity the link names, and `networks` holds options of that select, by alias, each to one of facebook, instagram, threads, x, linkedin; its `group` is another single select of that entity. |\n\n<!-- generated:end layout-desk -->\n\n## Record node\n\nA Record draws what a row opens: the head, then the parts.\n\n- **The head:** title, subtitle, picture, mark, party, figure and meter, deadlines, description \u2014 the\n table\'s `records` facts, overridden by the Record\'s `row`. `row` changes how the App\'s rows read wherever it lists them, and has nothing to do with arranging a page. The status stands in the head, or the Side where the Side states it, never in a Section.\n- **Where it stands:** a Record stands only in the App\'s `pages`, one per entity, stating its `entity`; every List over\n the entity opens it. With no page for an entity, the platform designs the record\'s Sections from the rows: the fields\n the head does not draw, child Lists, papers and Acts. A stated page stands exactly as written, so it replaces them.\n Under a child List, an absent page is every field of the child except the link back.\n- **Children:** either parts \u2014 `Section`, `Side` \u2014 or, for a one-part record, `Field`, `List`, `Reading`,\n `Statement` and `Act` directly. The two are never mixed. The page of an entity no root List and no Sheet\'s List (one stating no `app`) is over \u2014 a\n child List\'s, a document\'s or a roster cell\'s \u2014 holds `edit`, Fields, Sections of them with the Acts and the Lists of\n their rows\' own children, and the Lists of its rows\' own children; a row opened in place draws each Section under its\n title, an Act no Section holds at the last Section\'s foot, and a page with no Section its one section. Such a page\n holds what any page holds \u2014 a Reading, a Side \u2014 and one stating a Side opens its rows\n by its `door` instead of in place; any other `door` there is not drawn and stays stated.\n\n<!-- generated:start node-record -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The table whose rows open on this page: a page stands once per entity, in the App\'s `pages`, and every List over the entity opens it |\n| `row` | [Record row](#record-row) | How the App reads this entity\'s rows wherever it lists them \u2014 their line, figure, picture, deadlines and stage \u2014 where it differs from the table\'s `records` |\n| `add` | `false` \\| list of alias (at least one) | What a new row asks where a picker of this entity offers one, anywhere in the App: these fields; `false`: a picker only picks. Absent, the table\'s required fields, its natural key and its title, where the table states a `singular` |\n| `remove` | `true` | Lets a person delete a row reached through a link: true, it offers a Delete; rows a List lists are deleted as that List\'s `remove` says |\n| `door` | `"page"` \\| `"drawer"` | How a row opens, on a page or in a drawer: absent, a page where a part is a step or a Side or there are more than 3 parts, else a drawer |\n| `edit` | `false` | Shows a record nobody changes here: false, nothing it draws is written, a link\'s row of it included |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [Section](#section-node) \\| [Side](#side-node) \\| [Outside](#outside-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly \u2014 never both. Beside either stand Outsides, Checks (guarding this entity\'s Acts and saves) and Acts on one row, each placed at the foot of the part whose step it moves into, a correction in the head\'s \u22EF. Holding only Acts, Checks and Outsides, or absent, the record\'s Sections are the platform\'s: the fields the head does not draw, child Lists, papers and Acts. Otherwise it stands exactly as written |\n\n#### Record row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `title` | [Record row title](#record-row-title) | The row\'s title field, stated for its `edit` alone |\n| `subtitle` | list of (alias \\| [Record row line field](#record-row-line-field)) (1\u20132) | Up to two fields read under the title, in place of the table\'s |\n| `figure` | alias \\| `false` | The one number a row stands for, in place of the table\'s; false, none |\n| `image` | alias \\| `false` | A files field that pictures a row, in place of the table\'s; false, none |\n| `due` | list of alias (at least one) \\| `false` | Dates that count down, in place of the table\'s; false, none |\n| `status` | `false` \\| `{ "edit": true \\| false }` | Whether this app shows and moves the stage: false, it is not shown. `{ edit: true }`: the stage is also moved by hand. `{ edit: false }`: nobody moves it in this app, another app does. Absent, the stage stands in the record\'s head, or in the Side where the Side states it: choosing a move runs its Act, asking and refusing as its button does |\n\n#### Record row title\n\n| Key | Type | Meaning |\n|---|---|---|\n| `edit` | `false` | Keeps a row\'s name as it stands: false, the title is read; absent, it is written where the table lets a person write it |\n\n#### Record row line field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n\n<!-- generated:end node-record -->\n\nThe door is a page where a part is a step or a Side, or where there are more than 3 parts; else a drawer. `door`\nis a judged choice of how a job is worked (one after another over a long record), so it is kept. From three parts on, the\nrecord shows one at a time: a press on a page\'s rail (a strip of the same names on a phone and in a drawer) flips to a part and returns\nto the top. It opens on the part the address names, else the step that is now, else the first. A part\'s rows and drafts are kept\nacross flips. With fewer parts they stack.\n\nA record shows no activity and no audit log: a history an app shows is table-backed \u2014 `records.status.dates`, `records.status.history`, an event table an act\nmakes \u2014 stated where the app shows it.\n\nA field may be stated in any number of parts, and each part draws what it states. Where parts stack it stands once: in the\nstep that is now if that step states it, else the first part stating it. A Section or a List with `when` is\ndrawn only while each named select of the record holds one of its options.\n\n## Section node\n\nA titled part of a record, and optionally a step of its path. A Section draws its Fields, Lists, Readings,\nStatements and Acts in reading order; its Acts stand at its foot.\n\n<!-- generated:start node-section -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The part\'s heading |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `at` | list of alias (at least one) | Options of the record\'s status during which this part is the work now: a step of its path |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own |\n\n<!-- generated:end node-section -->\n\n#### Kinds of block\n\nWhat a Section draws beside its Fields is a block, of the kind its item states: a List a rows block, an outline where its table holds rows under rows, an agenda or a timeline by its layout, or a list that only reads; a Field a gallery of files or a prose block; a Statement and a Reading each its own.\n\n<!-- generated:start block-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `rows` | Rows list a record\'s child rows under it, each a line in the register\'s row anatomy: a List standing in a Section, its rows linked to the record, narrowed by its `where`, opened in place, their Acts in each row\'s \u22EF; rows that hold pictures are cards, each led by its picture. A child List draws as rows unless its layout says otherwise; a `checklist` reads the rows as checks, a `desk` as the places the record is sent and a `gantt` as bars on an axis of time (the register\'s, over the rows the record\'s link names). |\n| `outline` | An outline draws a record\'s child rows as a tree where their table holds rows under rows (a task under a task, a part of a part): the top rows first, each row\'s sub-rows read when it is opened, with the count of them, closed of all, beside its name; a row adds a row under itself from its \u22EF. A List the reader narrows, orders by a header, groups or searches draws as plain rows. |\n| `agenda` | An agenda reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its picture and the day that is today marked. The day is the first date on the child\'s row line; within a day entries follow a datetime there, else the first single select after the date. An entry with no day yet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading counts from it (Day 1, Day 2). |\n| `timeline` | A timeline reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds entries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each move. A timeline\'s moment is its child\'s first date, and who its member field. |\n| `files` | Files draw a run of the record\'s files fields as one gallery under a heading, each field\'s files as thumbnails with a drop zone to add to them. A files field, or a lookup of one, draws as a gallery unless its Field states `block: false`. |\n| `text` | Text draws one of the record\'s markdown fields as prose under a heading, edited in place where the app writes it. A markdown field draws as prose unless its Field states `block: false`; plain text is a control among the part\'s fields unless it states `block: true`. |\n| `choices` | Choices draws one of the record\'s multi-selects as a checklist under a heading: every option on a line of its own, ticked where the record holds it, ticked and unticked in place where the app writes it. A multi-select is a control among the part\'s fields unless its Field states `block: true`. |\n| `linked` | Linked draws the row a link of the record to one row names, whole and in place, as its page draws it \u2014 its fields, parts, Lists and Acts, read and written as that row\'s own \u2014 under a heading. A link draws as its row\'s chip unless its Field states `block: true`. |\n| `figures` | Figures draw numbers of the record (1 to 8) as tiles, each under its field\'s label. A tile holding nothing reads as not measured, never 0. |\n| `statement` | A statement builds one figure from figures of the record: each line a number of it with its operator and its label, the figures on one right edge, the last an `equals` drawn heaviest (a claim\'s payable, an invoice\'s total, a payslip\'s net). A line may carry the rows its figure adds up (`parts`), each listed under it. |\n| `reading` | A reading block draws a Reading over the child rows under the record, through their link to it: a number, a split into parts, a trend, a grid, a shortfall against stock, or the work against its plan. It stands in the record\'s strip beside the record\'s own figures. |\n| `list` | A list shows rows of another entity beside the record, read only: those linked to it, a path through a row of their own, or \u2014 with `same` \u2014 the siblings sharing a link of the record, the record itself left out. Each row reads in its `records` anatomy with the `columns` after its title, and opens on its page. |\n| `funnel` | A funnel counts steps people drop out of between, a column of each child row a step (2 to 8): one funnel over the rows under the record \u2014 each step its column summed, its bar over the first step, the share kept between two steps and from the first to the last. |\n\n<!-- generated:end block-kinds -->\n\n- **`at`** names the stage options during which the section is the work now \u2014 only on a record that\n truly moves through those stages: the rail marks it done, now or waiting, and it may hold nothing, its title being the step;\n one that is now and holds nothing says so. Two Sections at one option are both the work there, and the first opens. A step\n never hides a field, locks it or gates an act: fields stay writable as the write rules and checks allow, at any stage.\n- **Acts:** every Act on a record stands in the Section whose work it is. An Act moving the stage and offered at ONE step\n stands at that step\'s foot when it moves the work forward, to an exit later in the stage\'s options, or back to a step the\n work passes anyway; one offered at several steps, or moving back into a detour, stands in the Section it enters. One stated elsewhere stands there, and the answer says so. A\n correction (`danger`, and not one of its step\'s outcomes) waits in the Section heading\'s \u22EF.\n- **A detour** \u2014 a stage the work only steps aside into from one step and leaves only back to it (a pause, a repair) \u2014\n stands before that step, its option and its Section alike.\n- **An exit** stands only once the record is in it, its reason there and its rail item apart from the path; until then the\n Act waits in the header\'s \u22EF.\n- **A document:** a Section that is no step and holds nothing but one `text` block over a markdown field reads as a document: the field is written in place with no box, saved when the writer leaves it, and the record reads in an article column while that part is in view.\n- **Writes:** its Fields and its Acts.\n\n## Side node\n\nThe one part drawn beside the rest \u2014 the photos looked at, the pool picked from, the facts kept in view. It stands on the\nright, beside the rail and the parts; on a phone it is one pinned line that opens in place. At most one Side to a record, on a page\ndoor.\n\n<!-- generated:start node-side -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The part\'s heading |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own |\n\n<!-- generated:end node-side -->\n\nIt holds what a Section holds. A field it states, the status included, leaves the head and stays on list rows; the title stays in the head. Writes: its Fields and its Acts.\n\n## Outside node\n\nWhat one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it. A member\npresses Create link on a record while its status stands in `at`; the link opens that one record until it expires, is\nrevoked, or its act moves the status out of `at`. The person sees the stated Fields and Lists and presses the stated Acts\nand nothing else. It stands directly in the Record of a table with a stored status select, whichever List over it opens the page.\n\n<!-- generated:start node-outside -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique in the app: a link to the record names it. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The heading of the page the person without a seat opens |\n| `description` | text | A line under the heading |\n| `at` | list of alias (at least one), required | Options of the record\'s status during which a link to it opens; none is owned by a stage, and each Act moves the status out of them |\n| `children` | list of (alias \\| [Field](#field-node) \\| [List](#list-node) \\| [Act](#act-node)) (at least one), required | Exactly what the link shows and allows: Fields read as values, Lists of child rows read as they are, and the Acts the person may press, each moving the status out of `at` |\n\n<!-- generated:end node-outside -->\n\n- **Fields** are read as values, in order; a lookup, a rollup or a formula is computed for the link only if stated here.\n A Field states nothing but its alias.\n- **Lists** read the child rows under the record as they are: `columns`, `label` and `where`.\n- **Acts** are the link\'s alone: no member, visitor or agent presses them. Each states `key`, `label`, `confirm`, `when`,\n `requires`, `asks`, `set`, `template` with `into`, or `sign`. `when` absent is the status held in `at`; `set` moves the\n status to an option outside `at`, so each press ends the visit. `asks` are text, numbers, dates or listed options. A\n `sign` is by a text field the signer types, with no witness: the link is the attestation.\n- `at` names options no stage owns, and no two Outsides of a table open during the same option.\n- **Writes:** its Acts, and nothing else.\n\n## Tab node\n\nA Tab is one view of a List\'s rows over a period: a register reporting a period \u2014 what stands at its end beside what came and went during it (the stock,\n the hires out, the tickets open) \u2014 reads its rows as Tabs over one `period` the reader picks above them. A Tab holds\n the rows `dated` within the period, those `open` at its end, or lists every row and draws what a child\'s rows came to\n in the period (`totals`). A Tab narrows its rows and holds no nodes; Readings stand beside it in the List and read the\n open Tab, or the one their `tab` names. Never date chips set by hand, and never a Tab per stage, which the chips split.\n Readings and Lists read apart from a List\'s rows stand on a Sheet, a View of the App\'s own.\n\n<!-- generated:start node-tab -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among its siblings; part of the node\'s address |\n| `label` | text, required | What the tab holds, in the reader\'s words |\n| `dated` | alias | A date: the tab holds the rows dated within the List\'s period |\n| `open` | [Tab open](#tab-open) | The tab holds the rows open at the period\'s end: begun, and not yet ended |\n| `totals` | [Tab totals](#tab-totals) | Each row\'s figures over a child\'s rows in the period |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order this tab\'s rows read in; absent, the List\'s |\n\n#### Tab open\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | alias, required | The date a row begins on |\n| `to` | alias, required | The date a row ends on, empty while it is open |\n\n#### Tab totals\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | An entity of this app whose rows each belong to one row of the register\'s entity: the rows the columns add |\n| `on` | alias, required | A date of the child placing each row in time: stored, a formula yielding a date, or a lookup of a date through a one-row link \u2014 never a moment or a span of days |\n| `columns` | list of [Totals column](#totals-column) (1\u20136), required | The figures drawn in place of the register\'s columns after each row\'s name, each under its own alias and label |\n\n#### Totals column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | The column\'s name: its address in the totals read |\n| `label` | text, required | What the column holds, in the reader\'s words |\n| `value` | alias \\| `{ "avg": alias }` | A number of the child (stored, a formula or a rollup) summed over the rows, or `{ avg }` averaged over the rows holding one, a window holding none drawing blank; absent, the rows are counted. A figure read in each row\'s own unit or currency stands only where the child\'s select is a lookup, through `via`, of a single select of the register\'s entity |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | Only the child\'s rows whose select holds one of these options, or whose yes/no is this value \u2014 every entry ANDed |\n| `window` | `"before"` \\| `"in"` \\| `"through"`, required | Which of the child\'s rows, by `on`, the column adds: `before` those dated before the period\'s first day, `in` those from its first day through its last, `through` those on or before its last day |\n\n#### Period days\n\n| Key | Type | Meaning |\n|---|---|---|\n| `days` | integer, required | How many days through today, at most 366 |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.tabs` | A List\'s Tabs each have a `key` of their own, none the entity\'s alias or one a report template holds (`title`, `lines`, `readings`, `at`, `dates`, `period`, `per`); a Tab states one of `dated` and `open` (dates of its rows, `open`\'s two different) or `totals` (a child\'s rows windowed by the period); its `where` and `sort` hold as the List\'s do, and never narrow by the status, which its chips split. Only a table or cards List has Tabs, and a Reading\'s `tab` names one of them. A `period` opens a List on a window: over a table or cards a Tab that states `dated`, `open` or `totals` reads it; a calendar or a lanes board opens on `"today"`, `"week"` or `"month"` (a lanes board of hours, on `"today"`); no other layout draws one. Wrong: `period: "year"` over a table with no dated Tab. Right: add `{ "type": "Tab", "key": "this_year", "label": "This year", "dated": "sold_on" }`, or drop `period`. |\n| `list.tab-totals` | A Tab\'s `totals` name a child linked to the List\'s entity by a one-row link (a child linking the List\'s entity twice cannot be totalled), a date of the child, never a moment or a span, and 1 to 6 columns each under its own alias and label; a column\'s `value` is a number of the child, its `where` holds over the child\'s selects and yes/nos, and a value read in each row\'s own unit or currency stands only where that select of the child looks up, through its link, a single select of the List\'s entity, and the child links to no source\'s rows. A source\'s rows are totalled by the child\'s one link to them, by one field to one row; a source the child links to not at all totals nothing on its rows (`list.source-lacks`). Only a table List has them, and no Tab states `totals` beside `dated` or `open`. A column sums a number or counts rows, never `{ avg }`. |\n\n<!-- generated:end node-tab -->\n\nA `totals` Tab adds, per column, the child\'s rows `before` the period\'s first day, `in` the period, or `through` its last\nday, so `before` plus `in` of one value is its `through`:\n\n```json\n{\n "type": "Tab",\n "key": "items",\n "label": "Items",\n "totals": {\n "rows": "ledger_line",\n "on": "moved_on",\n "columns": [\n { "alias": "opening", "label": "Opening", "value": "quantity", "window": "before" },\n { "alias": "received", "label": "Received", "value": "quantity", "where": { "kind": ["receipt"] }, "window": "in" },\n { "alias": "issued", "label": "Issued", "value": "quantity", "where": { "kind": ["issue"] }, "window": "in" },\n { "alias": "closing", "label": "Closing", "value": "quantity", "window": "through" }\n ]\n }\n}\n```\n\n## Sheet node\n\nA Sheet is a grid of Readings and Lists over the App\'s rows in its `period`: each Reading a figure, each List the rows it lists. An App of one Sheet opens on it; an App of several draws a strip that picks one.\n\n<!-- generated:start node-sheet -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among the App\'s Views: the sheet\'s address, `/<key>` |\n| `label` | text, required | What the sheet holds, in the reader\'s words: its name among the App\'s Views |\n| `children` | list of ([Reading](#reading-node) \\| [List](#list-node)) (at least one), required | The Readings and Lists the sheet draws as a grid, in reading order: each Reading a figure over the App\'s rows in the App\'s `period`, each List the rows it lists |\n\n<!-- generated:end node-sheet -->\n\n## Field node\n\nA Field draws one field of the record it stands in. How it is drawn follows from the field\'s type and the table\'s facts:\n\n- a control or a value, with its notation, money, units and deadline countdown;\n- a files field as pictures and documents, a long or markdown text as prose written in place \u2014 a gallery or a prose block,\n with a heading (`label`) and a condition (`when`) of its own; a run of files Fields is one gallery;\n- a link as its row\'s chip, with a picker narrowed by `options_where`, offering a new row where the linked table\'s page\n states `add`;\n- the back side of a child\'s link as the rows filed under the record;\n- the fields an Act\'s `sign` writes as one signature.\n\n<!-- generated:start node-field -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n| `label` | text | The heading of the field\'s gallery or prose block, where it draws as one; absent, the field\'s label. A run of files fields takes the first one\'s |\n| `block` | boolean | Gives a field room of its own: true, a files, text or multi-select field draws as its own gallery, prose or checklist block, and a link to one row as that row drawn whole in place, as its page draws it; false: as a control among the part\'s fields. Absent, files and markdown fields draw as blocks, plain text, a multi-select and a link as a control |\n| `when` | [condition](#app-tree) | A gallery or prose block is shown only while the record\'s selects hold these options, its yes/nos these values, its numbers and dates meet their bounds and its `{ "empty": true \\| false }` fields are blank or filled |\n\n<!-- generated:end node-field -->\n\nA field drawn in the head (title, subtitle, picture, figure, stage) is never also a Field node. A Field is drawn once per\npage. **Writes:** the field, under \xA7 App tree; a picker\'s add is the linked table\'s page\'s `add`.\n\n## Fieldset node\n\nA Fieldset heads a run of a part\'s Fields with a few words of its own: the facts of one kind among a part\'s many (a\nvehicle\'s plate, make and seats under "Vehicle"). It stands among a Section\'s or Side\'s children, or a one-part\nRecord\'s, and holds Fields alone \u2014 two or more, each drawn as a control, each in one Fieldset. A Field in it reads and is\nwritten as it would be in the part. A gallery or prose Field stands beside it, never in it.\n\n<!-- generated:start node-fieldset -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text, required | The heading over the facts it holds, in the reader\'s words |\n| `children` | list of (alias \\| [Field](#field-node)) (at least 2), required | The Fields drawn under the label, in the order stated; each reads as it would in the part |\n\n<!-- generated:end node-fieldset -->\n\n## Act node\n\nAn Act is a verb, stated whole where it stands. Its place decides what it works on:\n\n- in a Section or Side, or in a one-part Record: one record, at that part\'s foot;\n- in a List, with `on`: the ticked rows or every row in view, each checked before any is written;\n- directly in a Record that holds parts: refused.\n\n<!-- generated:start node-act -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The act\'s name; its workflow is `act_<key>`, or the `workflow` it names |\n| `label` | text, required | The verb, as the reader says it |\n| `when` | [condition](#app-tree) | The act works only while this holds |\n| `requires` | list of alias (at least one) | Fields filled first, each drawn where the act stands |\n| `recommends` | list of alias (at least one) | Fields it runs without and reads when filled |\n| `asks` | list of (alias \\| `{ "field": alias, "starts": "today" \\| "me" }` \\| [Asked input](#asked-input)) (at least one) | What the reader states on pressing: fields of the row (written by the act) or inputs; a `link` input\'s picker adds as its entity\'s page `add` says |\n| `set` | map of alias \u2192 [value](#app-tree) | What the act writes; each field is read-only elsewhere in the app |\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }` | Who presses it: a member field of the row, `link.field` read through a one-row link, or `{ group }` by id. Absent, the owner of the stage it is offered at, or anyone the app is shared with where it stands at none |\n| `workflow` | alias | The workflow it runs for what `set` cannot say: one made under this name, its body set by `set_workflow`, or the app\'s Workflow node, taking the row as `record_id`; the act\'s guards head its body |\n| `template` | alias | A document template it makes a file from: html a PDF, excel a workbook, word a .docx; over several rows, one file of them all |\n| `templates` | list of [Act template](#act-template) (at least 2) | Several papers made into `into`, instead of `template`: the reader ticks which |\n| `into` | alias | The record\'s files field keeping the document; remade, it replaces its own last paper, never a person\'s file |\n| `paper` | text | Its paper, `<child>.<kind>`: the line of the record\'s papers it stands on |\n| `intake` | alias | A child the record lists whose rows are its papers: the press takes papers, an agent reads them, each filed as a row of it. With `on: "view"`, they make a new record of the List\'s entity, and the save opens it |\n| `fills` | list of text (at least one) | With `intake`, what the papers may fill: a field of the record, `<link>.<field>` on the row a required one-row link names, or a child they add rows to; on a new record that row is found on its entity\'s `natural_key` or added. With `record`, fields of the new row an agent fills from the transcript |\n| `record` | [Recording](#recording) | The press records a call, visit or meeting, filed as a new row of a child the record lists |\n| `sign` | [Signature](#signature) | The press opens a pad; the act keeps the signature as a picture with who signed, when and the witness |\n| `review` | `true` | Lets a person approve what a workflow would write: with `workflow`, it only proposes a changeset of the act\'s table, and the reader ticks the rows to write |\n| `confirm` | `true` \\| text | The press asks first: the question, or `true` for the act\'s label over the row |\n| `danger` | `true` | The act destroys or cannot be undone |\n| `on` | `"ticked"` \\| `"view"` | Which rows an Act over a List works on: `ticked`, those ticked in the List holding it; `view`, every row in view. Every Act a List holds states it, and no other |\n\n#### Asked input\n\n| Key | Type | Meaning |\n|---|---|---|\n| `input` | alias, required | A value the act asks for that is not a field of the record |\n| `label` | text, required | What the reader is asked, in their words |\n| `type` | `"text"` \\| `"long_text"` \\| `"number"` \\| `"date"` \\| `"select"` \\| `"link"` \\| `"member"` \\| `"file"`, required | What the reader states. A `file` is one uploaded file, handed to the act\'s authored `workflow` as its file id and read by nothing else |\n| `options` | list of [Select option](#select-option) (at least one) | The choices a `select` input offers, one picked \u2014 written into a select holding the same option aliases |\n| `entity` | alias | The entity a `link` input picks one row of |\n| `accepts` | list of `"sheet"` \\| `"pdf"` \\| `"document"` \\| `"photo"` (at least one) | The kinds of file a `file` input takes; absent, a sheet, a PDF or a document \u2014 a phone offers its camera only where `photo` is among them |\n| `required` | `true` | The act is refused without it |\n| `default` | alias | A field of the row whose value the input starts from, still changed at will |\n\n#### Set formula\n\n| Key | Type | Meaning |\n|---|---|---|\n| `formula` | text, required | A formula over the acted row\'s fields, `{alias}` each, read as the entity\'s own formulas read them |\n\n#### Act template\n\n| Key | Type | Meaning |\n|---|---|---|\n| `template` | alias, required | A document template made into `into` |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | The paper starts ticked while each named select of the record holds one of these options and each named yes/no (stored, or a formula \u2014 how a multi-select is tested: `includes({needs}, {needs:x})`) is this value \u2014 a suggestion the reader changes, never a refusal; absent, it starts ticked |\n\n#### Recording\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | A child the record lists in a timeline or rows block, linking back by a single link: each recording is a new row |\n| `audio` | alias, required | The child\'s files field the recording\'s audio is kept in |\n| `transcript` | alias, required | The child\'s text field the transcript is kept in, a speaker\'s turn per line |\n| `video` | alias | The child\'s files field the screen is kept in, where the recording captured it |\n| `at` | alias | The child\'s date field stamped with the moment the recording started |\n| `by` | alias | The child\'s member field set to the person who recorded |\n\n#### Signature\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | The record\'s files field the signature is kept in, as a picture \u2014 each signing replaces the one before |\n| `by` | alias, required | Who signed: a text field the signer types into (someone with no seat), or a member field set to the person pressing |\n| `at` | alias, required | The record\'s date field stamped with the server\'s time as the act runs |\n| `witness` | alias | Beside a text `by`, the member field set to the person pressing, who saw the signer sign |\n\n<!-- generated:end node-act -->\n\nAn Act whose `when` does not hold is not offered. One whose `requires` are empty is offered disabled, naming each; one whose\n`recommends` are empty names what it will leave blank and still presses; one a standing Check blocks is offered disabled in\nits words. The `act_<key>` workflow re-checks all three on the server, writes `set` and what was asked,\nand appends the status history. A field an act both `requires` and `asks` never disables the press. A field an Act `requires` draws in its part with no statement. An Act in a child List may `sign` the row pressed.\n\n- **Writes:** every field it sets, asks, files into, signs or records is the act\'s.\n- **Papers.** A button that makes a paper is `template` (or `templates`) with `into` and no workflow, made from the row as the act left it. `templates` keeps a paper not made yet as a placeholder, and the set downloads as one archive (`archive_<key>`). `into` files the paper in the row\'s own files field, a write of the row its table\'s lock refuses; a `paper` line is a row of its own, made on a locked record. `intake`: what the papers state of each field `fills` names is shown beside what the row holds, and the save writes only what differs. `sign`: the record reads `into` as one signature, and the act\'s paper is handed the picture under `into`\'s name (`{{#each signature}}<img src="{{url}}">{{/each}}` in an html template).\n- **`review: true`:** the workflow (`workflows`) reads and returns a changeset of the act\'s table in `data.review`; the rows the reader ticks are written each checked first, all or none. Over every row in view the act is handed no rows.\n- **A `when` that compares** splits one stage by an amount or a date with no formula field behind it; the server refuses a press the row does not meet, and a blank number or date meets no bound:\n\n```json\n{ "type": "Act", "key": "approve", "label": "Approve", "when": { "status": ["submitted"], "amount": { "lte": 5000000 } }, "set": { "status": "approved" } }\n```\n\n```json\n{ "type": "Act", "key": "gate_in", "label": "Make the gate-in EIR", "template": "eir_in", "into": "eir", "sign": { "into": "driver_signature", "by": "driver_name", "at": "signed_at", "witness": "signed_before" } }\n```\n\n## Check node\n\nA Check is a yes/no or text formula of the row of the Record page it stands in (`pages/<entity>`): it stands while true or non-empty, and a text\nformula\'s words are what the reader sees. Without `on` it only warns; with it, it refuses the saves and acts it names, on\nthe server, in every write it names.\n\n<!-- generated:start node-check -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A yes/no or text formula of the page\'s entity: true or non-empty means the check stands |\n| `on` | `"all"` \\| list of (`"update"` \\| alias) (at least one) | What the standing check refuses: `update` is the rows\' saves, an Act key is that Act \u2014 on one row, or over a List\'s rows of this entity \u2014 and `all` is every Act and save; absent, it only warns |\n| `resolve` | alias | An Act on one row of this entity that clears it |\n\n<!-- generated:end node-check -->\n\n`update` is the rows\' saves; an Act key is that Act, on the same rows; `all` is every act and save.\nA rule that refuses a Delete is a check of the table, not a Check: state it in the table\'s `checks` with `on: ["delete"]`\n(\xA7 Write rules), where it holds for every way a row is deleted and a removal that cascades to child rows is refused whole.\nA Check stands on each row of its page\'s entity wherever the App lists or opens it \u2014 a root List\'s, a child List\'s, a\nsource\'s \u2014 and refuses the acts and saves it names, an Act over a List\'s rows of the entity included. A warning reading the figure of a meter that `gates` marks against its\nbound or its pass mark is refused: the meter already draws it.\n\nThe check field\'s `label` is its short name \u2014 "Over budget", "Release expired": a row\'s line says it in the check\'s tone\n(the most severe of several, and how many more), while its words whole are the row\'s tooltip. Label it as the reader names\nthe problem, in a few words, and let a text formula say the sentence. A check with no `resolve` links to the first field its formula reads that the record draws.\nA yes/no formula whose yes needs attention (papers the customer still owes) is a Check: its yes reads in the warning tone\nwherever it is drawn, every other yes in the success tone \u2014 and the row\'s line says it, so it is no column of the List too.\n\nA Check that every app over a table states the same way restates the table\'s contract and belongs in the table\'s `checks`\n(\xA7 Write rules).\n\nA Check refusing `update` (or `edit: false` on a record, part or field) makes the rows read-only in this app alone, drawn\nunder the read-only mark, never as a lock. A lock is the table\'s: a table workflow, a person, or an Act whose workflow sets `locked: true` on `update_records` locks a row, and every door refuses its writes until a table manager unlocks it \u2014 `update_records` with\n`locked: false` in an app\'s run is judged as the member who pressed. A locked row reads locked in every app: its lock mark, its fields as values\nunder one line naming who can change it, its saves, Delete and each Act writing it refused \u2014 an Act that writes\nelsewhere, makes a paper it hands back, or unlocks it stays its workflow\'s to answer.\n\n## Reading node\n\nA Reading is a number over rows: one figure, its parts, a grid, a figure per period, steps; or a record\'s own figure. The\npicture is the runtime\'s, chosen from what the reading means \u2014 no prop picks a chart. The question is stated by which\nsplit it names:\n\n| Names | Answers |\n|---|---|\n| nothing | one figure: the rows counted, or `value` summed, `{ "avg": \u2026 }` averaged |\n| `by` | the figure per value of a select, one-row link, member or yes/no, or per band of a number\'s `tiers` |\n| `by` a date field | the figure per period (a trend); `ahead: true` reads forward over the rows still to come |\n| `by` and `across` | a grid, `by` down the side and `across` along the top |\n| `steps` | a funnel: 2 to 8 number fields summed, each kept as a share of the one before; in a record only |\n| `planned` and `done` | the work against its plan, day by day: a List\'s band over a folder, or a record\'s block, never a Sheet |\n| no `entity`, in a Record | the record\'s own `value`, a tile under its field\'s label; up to eight consecutive tiles draw as one strip |\n\n<!-- generated:start node-reading -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The reading\'s query name, unique in the app. Absent, the label\'s words as a slug, else its kind and field, written once and kept |\n| `label` | text | What the figure is called: absent, a split\'s `by` field\'s label, a trend\'s summed `value`\'s (else the rows\'), a grid\'s two fields\'; one figure states its label; with `planned`, always stated |\n| `entity` | alias | The List\'s rows; in a Record, the child\'s rows under it; absent in a Record with no `by`: the record\'s own `value`; with `planned`, the rows that are the parts of the work, always stated |\n| `via` | alias | The child\'s link to the record, where it has several |\n| `value` | alias \\| `{ "avg": alias }` | A number field summed over the rows, or `{ avg }` averaged over the rows holding one; absent, the rows are counted |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | Splits the rows into parts; a date field splits them per period |\n| `across` | alias \\| [Tiered filter](#tiered-filter) | Reads a split against a second field: with `by`, the columns of a grid |\n| `over` | alias | The date that places a row in time |\n| `ahead` | `true` | Shows what is coming, not what has been: with a date `by`, the current period and those after it |\n| `steps` | list of alias (2\u20138) | Number fields summed, each a step of a funnel |\n| `on_hand` | [Reading on hand](#reading-on-hand) | With `by` (and `across`): the Reading\'s rows are what is owed, per value of those fields; drawn beside what is on hand per the same values, and the shortfall |\n| `target` | number | The number the figure is read against; absent, its bound, where the table states one |\n| `better` | `"up"` \\| `"down"` | Which way is good, for the figure\'s tone; absent, read from the figure\'s shape |\n| `planned` | [Reading planned](#reading-planned) | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | With `planned`, the work against its plan: a percent field of the row the server computes, its share done today (0\u2013100) |\n| `finished` | alias | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `tab` | alias | The Tab it reads, else the open one |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Reading on hand\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The entity whose rows are what is on hand, all of them |\n| `value` | alias | A number field summed over those rows; absent, the rows are counted |\n| `by` | alias | The field of this entity matching the Reading\'s `by`; absent, the same alias |\n| `across` | alias | The field of this entity matching the Reading\'s `across`; absent, the same alias |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n\n#### Reading planned\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of the row: the first day of its planned work |\n| `end` | alias, required | A date of the row: the last day of its planned work |\n\n<!-- generated:end node-reading -->\n\n#### Kinds of reading\n\n<!-- generated:start reading-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `metric` | A metric is one number over an entity\'s rows: how many, or the sum or average of a number field. It is read against a target, or against the bound its `limits` states; placed in time by `over`, it shows its change over the recent periods and which way is good (`better`). |\n| `breakdown` | A breakdown splits an entity\'s rows into parts: each row is counted, or its number summed, under the one value of the field it is split by \u2014 a select\'s option, a linked row, a person, yes or no \u2014 or under the band of a number cut by `tiers`. |\n| `trend` | A trend counts an entity\'s rows, or sums a number of them, per period of the date that places each row in time (`over`) \u2014 the periods up to today, or with `ahead` the current one and those after it, over the rows dated today or later. |\n| `pivot` | A pivot crosses two splits in a grid: each row of the entity is counted, or its number summed, under the pair of values it holds \u2014 one down the side (`rows`), one across the top (`columns`). |\n| `shortfall` | A shortfall sets what is still owed against what is on hand: the owed rows are counted, or a number of them summed, per value of the fields they are for (`by`, and `across`), beside every row of the stock (`on_hand`) matching those fields, with what falls short. |\n| `progress` | A progress reads the work against its plan: each row is a part of the work, planned over the days between two of its dates and done by a share the server computes, set against the plan day by day. Each row weighs its planned days. |\n| `list` | A list shows an entity\'s rows, each in its `records` anatomy \u2014 its title, its line, its status \u2014 with the fields read after the title (`columns`). |\n\n<!-- generated:end reading-kinds -->\n\nWhere a Reading stands decides which rows: a Sheet\'s every row, a List\'s rows in its open tab and folder (the search,\nthe status and the filters narrow the rows and leave the figures as they stand), a Record\'s the child\'s rows under the record. A Reading counts its rows, or sums the number\n`value` names \u2014 never a percent. `over` is a date, the row\'s own or its parent\'s through a lookup: a trend\'s periods, a\nfigure\'s recent periods, and what a Sheet\'s period windows. `where` keeps rows whose select holds one of the options, or\nwhose yes/no is the value, every entry ANDed \u2014 a band leads with the job\'s exception as a formula\'s yes/no (what is\nshort), never a stage the chips already count nor the overdue rows the register\'s summary line counts from `records.due`.\n\n- **A figure\'s change** is green where it moves the good way: a sum\'s rise, a count kept by `where` falling; `better` states\n the other way where that reads wrong (money going out). A value `limits` bounds reads against the sum of its bound\n (`10 / 14`); `target` reads one against a number nothing bounds.\n- **An average** is its sum over the rows that hold a value, divided by how many hold one; a row holding none is no part\n of it, and where none holds one the figure reads a dash, never 0. Under a Sheet\'s period it is the average over the\n period so far, never a sum of averages. A share is an average too: a number formula that is `100` on the rows that count\n and `0` on the others, in percent notation, averaged. Only a single figure averages.\n- **Bands.** `by` and `across` each take, in place of a field, a number by its `tiers` \u2014 `{ "field", "tiers" }` \u2014\n splitting the rows by the bands those breakpoints cut: `[1, 31, 61]` over days late reads not due, 1\u201330, 31\u201360 and over\n 60, the aged report. Every band is drawn in the bands\' own order, one holding no row at zero; rows holding no number\n stand apart. On a List a band is a door: a press narrows the rows to it. In a List\'s band, a split by one or two\n breakpoints stands in it, and one by three or more stands whole under it.\n- **In a List,** Readings stand under the title in one compact band: the job\'s headline number first, then at most the mix\n and the movement. A picture stands only where it splits the rows in view into two parts or more, one holding two rows or\n more. The summary line already totals the figure and the chips count the rows, so a figure summing the figure, or counting\n the rows of a table with a stage, is refused unless its `where` narrows it.\n- **Name.** A Reading\'s `key` is the query it is read by (`run_app_query`).\n- **The work against its plan** (`planned` and `done`, `label` and `entity` stated) takes none of a figure\'s props: the\n share of the work planned and the share done, cumulative day by day, today\'s two at its foot. Each row is a part of the\n work, its plan spread evenly over its planned days and weighing its planned days. Its share done today is `done`, a\n percent the server computes; on an earlier day, its `done` from its `finished` day on and nothing before it.\n\n## Statement node\n\nA Statement draws a figure the record works out from its own figures \u2014 a claim\'s payable, an invoice\'s total, a payslip\'s\nnet \u2014 line by line in the order the arithmetic runs: each line a number of the record, the first stating no `op`, the last\nan `equals`. Every figure is a field the server computes or a person writes; the screen adds nothing up. A line\'s `parts`\nlists the rows its figure carries, each read from its own row, and that figure is what they add up to \u2014 a formula, rollup\nor lookup, or the server\'s copy when the record is made (`default_from`), which nothing writes after.\n\n<!-- generated:start node-statement -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The statement\'s name, unique among its siblings. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | What the statement is called: absent, the label of what it comes to |\n| `lines` | list of [Statement line](#statement-line) (at least 3), required | The figures it is built from, top to bottom, ending in the one it comes to |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Statement line\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number of the record \u2014 stored, a formula, a rollup or a lookup \u2014 read on the line after its label |\n| `op` | `"plus"` \\| `"minus"` \\| `"times"` \\| `"equals"` | How the line works on the lines above it \u2014 `plus`, `minus`, `times`, or `equals` for what they come to, a formula, rollup or lookup the server computes; absent on the first line, which the rest work from |\n| `rate` | alias | A percent of the record read after the line\'s label: the rate its figure is taken at (retention at 5 %) |\n| `parts` | [Statement parts](#statement-parts) | The rows the line\'s figure carries, each listed under it with its words and its own figure \u2014 read from those rows, never a copy of them. The line\'s figure is what they add up to, drawn read: a formula, rollup or lookup, or a value the server copies when the record is made (`default_from`) that nothing writes after |\n\n#### Statement parts\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | The entity whose rows the line\'s figure carries \u2014 the record\'s own for the earlier rows of the same thing |\n| `same` | alias, required | A one-link the record and those rows both hold: the rows naming what the record names in it |\n| `at` | alias | A moment (a datetime) of those rows no person keys \u2014 when each was certified: with `before`, only the rows whose moment stands before the record\'s, earliest first; absent with it, every row so named, in their own order |\n| `before` | alias | A moment (a datetime) of the record no person keys \u2014 when it was made: the moment the rows\' `at` stands before; stated with `at` |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `{ "empty": true \\| false }` \\| [comparison](#values)) | Only the rows whose single select holds one of these options, whose yes/no (stored, or a formula) is this value, whose number or date meets its bounds, or whose field is empty or filled \u2014 read so on the server |\n| `columns` | list of alias (1\u20132), required | The rows\' fields read as each one\'s words, in order (its date, its percent) |\n| `figure` | alias, required | The rows\' number each one reads at the figures\' edge, frozen when the row was certified: a stored number an act fills (`{ "formula": \u2026 }` as it runs) or the server copies when the row is made (`default_from`) \u2014 never one a person keys, nor a formula, rollup or lookup the server recomputes |\n\n<!-- generated:end node-statement -->\n\n```json\n{\n "type": "Statement",\n "key": "claim",\n "lines": [\n { "field": "contract_value" },\n { "field": "done_to_date", "op": "times" },\n { "field": "value_to_date", "op": "equals" },\n { "field": "certified_before", "op": "minus", "parts": { "rows": "claim", "same": "contract", "at": "certified_at", "before": "made_at", "where": { "kind": ["work"] }, "columns": ["claimed_on", "done_to_date"], "figure": "certified_value" } },\n { "field": "claim_value", "op": "equals" },\n { "field": "retention", "op": "minus", "rate": "retention_rate" },\n { "field": "payable", "op": "equals" }\n ],\n "when": { "kind": ["work"] }\n}\n```\n\n## Export node\n\nAn Export is a report file of the rows in view: the title, a line per chip, the search and the moment it was exported, the\nReadings, and every row, at most 20,000. With no props, the one Export is the workbook of the List\'s columns, the Readings\non a sheet before the rows. A List states the reports the business sends \u2014 one a button, several one menu \u2014 each a `label`,\na `description`, and a `template` filled with `title`, `lines`, `readings`, `at` (the moment it was made), `dates` (each\ndate filter\'s `from` and `to` by field) and the rows under the table\'s alias (an html one made a PDF, an excel one a\nworkbook). A report\'s `filename` names its file in the template grammar over the same keys but the rows. Where `per` is a\none-row link, `per_row.<field>` reads a text, number, date or yes/no field of the picked row, and `| add_days:<n>` shifts a\ndate by whole days (`n` a number or such a field, empty for none): `Stock {{per}} {{period.to | add_days:per_row.day_offset | format:"dd.MM.yyyy"}}`. A report of some\nrows (`where`), or of one value the reader picks (`per`: one file per value), is made of the List as those chips would\nnarrow it; the screen keeps the chips and rows it shows. A report sent outside the business \u2014 a partner\'s stock, a\nfiling \u2014 is `fixed`: the same file from every screen and device, of what the reader narrowed only the period and the\ndate chips reaching it, never their status, other chips or search.\n\n<!-- generated:start node-export -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The report\'s name, unique in the app. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | The report\'s name; absent on the one Export that stands for the register\'s workbook |\n| `description` | text | What the report is for, in a sentence |\n| `template` | alias | An html or excel document template the report fills, with `title`, `lines`, `readings`, `at`, `dates`, `period`, `per` and `per_row` (a one-row `per`\'s picked row, the fields `filename` reads); absent, the workbook of the List\'s columns |\n| `filename` | text | The file\'s name, at most 500 characters, in the template grammar, over one value each: `title`, `at`, `dates.<field>.from` or `.to`, `period.from` or `.to`, `per`, `per_row.<field>` (a text, number, date or yes/no field of the row a one-row `per` picks), `lines \\| lookup:<n>`; `\\| add_days:<n>` shifts a date by whole days, `n` a number or `per_row.<field>`. Absent, the report\'s label |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `per` | alias | A select, member or one-row link the reader picks one value of: one file of that value |\n| `sources` | list of alias (at least one) | Of the List\'s entity and its sources, the tables the report reads; absent, all |\n| `fixed` | `true` | The same file from every screen: only its `where`, its `per`, the period and the date chips narrow it, never the reader\'s status, other chips or search; absent, the rows in view |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.export-report` | A List\'s Exports each have their own `label`; `per` picks one option, person or one-link row \u2014 never of the status, the folder or a field its `where` fixes. |\n| `list.export-key` | An Export is named by its key alone: no two Exports of an app share one. |\n| `list.export-filename` | An Export\'s `filename` is words and `{{value}}` placeholders, each value one of `title`, `at`, `dates.<field>.from` or `.to` (a date filter of the List), `period.from` or `.to` (a List with Tabs), `per`, `per_row.<field>` (a field of the row a one-link `per` picks) and `lines \\| lookup:<n>`, through helpers that exist and take the arguments given. |\n| `list.export-template` | A template an Export fills reads at its root only `title`, `lines`, `readings`, `at`, `dates` and its rows under the List\'s entity alias \u2014 an entity named none of those \u2014 and is the document of no Act. |\n\n<!-- generated:end node-export -->\n\n## Query node\n\nA Query is a read for agents, never drawn. An app generates a query for everything its screen reads (`agent_surface` lists them); a Query declares one the screen never asks, called through `run_app_query` or the app\'s API: the\ntable whose rows it reads, the fields each row returns, and what narrows them.\n\n<!-- generated:start node-query -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the query answers, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `params` | map of alias \u2192 ([Workflow value](#workflow-value) \\| a typed input (`app_bindings`)) | What a call states, by name: with `rows` or `list`, values a `where` entry reads; with `ast`, typed inputs the ast reads as `{{params.<name>}} |\n| `fields` | list of alias (at least one) | The fields each row returns, by alias: with `rows` or `list`. `ast` states its own |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order the rows return in; absent, the order the entity\'s list reads in |\n| `limit` | integer | The most rows returned |\n| `key` | alias, required | The query\'s name, what `run_app_query` calls; unique in the app |\n| `rows` | alias | The table whose rows it reads, under the app\'s row rule of it and, where the table holds one one-row link to the App\'s `scope`, inside the folder the call states. A Query states `rows`, `list` or `ast`, one of the three |\n| `list` | alias | The key of a root List of the App: the rows read as that List reads them \u2014 its `where`, its folder and its order. A Query states `rows`, `list` or `ast`, one of the three |\n| `ast` | a query tree (`app_bindings`) | The whole read, where `rows` or `list` cannot state it: a join, a union, a group, a window or a computed column. Fields and tables by alias |\n| `templates` | map of text \u2192 a document template (`app_bindings`) | Document templates an export of this query\'s rows may fill, by the name the export asks for. An export names one of these or none; a template it does not declare is refused. |\n| `where` | map of alias \u2192 [condition](#query-node) | What narrows the rows, as a List\'s `where` does: a select\'s options, a yes/no\'s value, a number or date meeting its bounds (`gt`, `gte`, `lt`, `lte`), a field `{ "empty": true \\| false }`, `{ "me": true }` on a member field \u2014 or a value the call states (`{ "param": name }`), or a date or number range of params (`{ "from": \u2026, "to": \u2026 }`) |\n\n#### Query param\n\n| Key | Type | Meaning |\n|---|---|---|\n| `param` | text, required | A param of this query: the condition holds what the call states for it, and is left out where the call states none |\n\n#### Query range\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | [Query param](#query-param) | The param the field is on or after \u2014 a date\'s first day, a number\'s least |\n| `to` | [Query param](#query-param) | The param the field is on or before \u2014 a date\'s last day, a number\'s most |\n\n<!-- generated:end node-query -->\n\n```json\n{\n "type": "Query",\n "key": "fees_unbilled",\n "description": "A customer\'s fees no invoice covers yet, oldest first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "description": "The customer whose fees are read." },\n "since": { "type": "date", "required": false, "description": "Only fees charged on or after this day." }\n },\n "rows": "fee",\n "fields": ["visit", "service", "amount", "charged_on"],\n "where": { "billed": false, "customer": { "param": "customer" }, "charged_on": { "from": { "param": "since" } } },\n "sort": { "field": "charged_on" },\n "limit": 200\n}\n```\n\nAn entry of `where` holds what a Reading\'s `where` holds, or a value the call states: `{ "param": "<name>" }`. A required\nparam is always stated; one stating `required: false` may be left out, and the condition reading it then narrows nothing.\nA query reads under its table\'s read scope, as every read of the app does. A caller counts, sums or averages its rows\nwith `run_app_query`\'s `aggregate`. `set_app` compiles a Query with the rest of the app: no code is set.\n\nEvery Reading of the app is a query too, returning its groups, called by its key. A Tab\'s `totals` read is called by\n`<table>_totals_<tab>` with the period\'s two days, `from` and `to`, both required.\n\nA query reads one table: on an app whose List reads `sources`, it names a source\'s own table, never the\nList\'s. A param compares a field holding one value \u2014 or, as a range, a date or a number \u2014 and never a number read in each\nrow\'s own unit or currency, nor a date holding a span.\n\n## Workflow node\n\nA Workflow is a verb for agents, never drawn: a job no press of the screen starts \u2014 an agent or a service handing the app a\nfile, or a list of rows to reconcile a table against. It states what it takes and what it hands back; a table is named by\nits alias in `tables` and a select by `<table>.<field>`. It is called through the app, by `run_app_workflow` or the app\'s\nAPI. On an app shared by a public link it runs only for someone who holds the app, and a visitor\'s call is refused as an\nalias the app does not have.\n\n<!-- generated:start node-workflow -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the workflow does, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `inputs` | map of text \u2192 [Workflow value](#workflow-value) | What a call hands it, by name \u2014 checked before its body runs |\n| `outputs` | map of text \u2192 [Workflow value](#workflow-value) | What its body returns as `data`, by name \u2014 checked as it returns; absent, read off the body |\n| `key` | alias, required | The workflow\'s name, what `run_app_workflow` calls; unique in the app |\n\n#### Workflow value\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"boolean"` \\| `"date"` \\| `"datetime"` \\| `"email"` \\| `"json"` \\| `"record_link"` \\| `"select"` \\| `"member"` \\| `"file"` \\| `"object"` \\| `"array"`, required | What the value is |\n| `description` | text | What the value is for, read by whoever calls the workflow |\n| `required` | boolean | Lets a caller leave the value out: false; absent or true, it is always there |\n| `multi` | `true` | A `record_link`, `select`, `member` or `file` holding several |\n| `entity` | alias | The entity a `record_link` names a row of |\n| `field` | text | `<entity>.<field>`: the select field whose options a `select` takes, as the field holds them when the workflow runs |\n| `options` | list of (alias \\| [Select option](#select-option)) (at least one) | The values a `select` takes, where no field holds them: aliases, or the objects a field\'s `options` take |\n| `fields` | map of text \u2192 [Workflow value](#workflow-value) | An `object`\'s values, by name |\n| `items` | [Workflow value](#workflow-value) | What each item of an `array` is |\n\n<!-- generated:end node-workflow -->\n\n```json\n{\n "type": "Workflow",\n "key": "reconcile_fees",\n "description": "Reconciles a visit\'s fees against the lines of the carrier\'s statement.",\n "inputs": {\n "visit": { "type": "record_link", "entity": "visit" },\n "statement": { "type": "file", "required": false },\n "lines": { "type": "array", "items": { "type": "object", "fields": { "service": { "type": "select", "field": "fee.service" }, "amount": { "type": "number" } } } }\n },\n "outputs": { "added": { "type": "number" }, "changed": { "type": "number" } }\n}\n```\n\nIts code is set on the app, never stated in the tree: `set_workflow` with a `source` whose `on({ type: "app", app_id, alias })` header names the app and the key, leaving\n`inputs` and `outputs` out \u2014 the code is checked against what the node declares. Every `set_app` keeps that code and holds\nwhat it takes, what it hands back and its description to the node. To change what a workflow takes or hands back, change\nthe node first: `set_app` keeps the code where it still meets the change, and where it does not the workflow stands on no\ncode again until `set_workflow` sets one that does. With no code it refuses every call, and each `set_app` says so. A\nWorkflow the tree stops declaring is archived with its key.\n\n## Tasks\n\nA table whose `records` states `"task": true` \u2014 its status a stored select with `closed` \u2014 is work someone finishes.\nEvery List of its rows draws it alike, each row led by a ring. Ticking the ring moves the row to a closed option by the\none write the app already has for that move: the Act of that table setting a closed option, offered on an open row and\nasking nothing, else its own save where people write the status \u2014 stamping what that act stamps and appending the\nstatus history. Unticking runs the Act moving a closed row back, else the save back to the status\'s default. A move no\nwrite reaches leaves the ring disabled and the check notes it. An Act with `on: "ticked"` completes several at once.\n\nA record listing task rows filed under it by a link holding one row says how much of that work is done \u2014 those at a\nclosed option of all \u2014 wherever its row is drawn: a meter on its head, a column of its register\'s rows, a card\'s foot, a\ncalendar entry, a gantt\'s or a lane\'s bar. No rollup is stated for it.\n\n```json\n{\n "tables": [\n {\n "ref": "project",\n "label": "Projects",\n "singular": "Project",\n "fields": {\n "name": { "label": "Name", "required": true, "type": "text" },\n "lead": { "label": "Lead", "type": "member" }\n },\n "title": "name",\n "records": {}\n },\n {\n "ref": "task",\n "label": "Tasks",\n "singular": "Task",\n "fields": {\n "title": { "label": "Title", "required": true, "type": "text" },\n "project": { "label": "Project", "required": true, "type": "link", "table": "project", "multi": false },\n "assignee": { "label": "Assignee", "type": "member" },\n "status": {\n "label": "Status",\n "required": true,\n "default": ["todo"],\n "type": "select",\n "options": [\n { "alias": "todo", "label": "To do", "color": "slate" },\n { "alias": "done", "label": "Done", "color": "green" }\n ]\n },\n "due": { "label": "Due", "type": "date", "format": "date" },\n "done_on": { "label": "Done on", "type": "date", "format": "date" }\n },\n "title": "title",\n "records": {\n "subtitle": ["assignee"],\n "due": ["due"],\n "task": true,\n "starts": { "assignee": "me" },\n "status": { "field": "status", "closed": ["done"] }\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "projects",\n "name": "Projects",\n "color": "blue",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "project"\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "project",\n "children": [\n {\n "type": "Section",\n "key": "work",\n "title": "Work",\n "children": [\n "lead",\n {\n "type": "List",\n "entity": "task",\n "columns": ["due"],\n "children": [\n { "type": "Act", "key": "complete_all", "label": "Complete", "on": "ticked", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } }\n ]\n }\n ]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "task",\n "children": [\n { "type": "Act", "key": "complete", "label": "Complete", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "reopen", "label": "Reopen", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\nThe tasks as a register of their own, for one person: a one-part Record holds its Fields and Acts directly.\n\n```json\n{\n "body": {\n "type": "App",\n "key": "my_tasks",\n "name": "My tasks",\n "color": "teal",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "task",\n "opens": { "assignee": { "me": true } },\n "children": [\n { "type": "Reading", "label": "Open", "where": { "status": ["todo"] } }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "task",\n "door": "drawer",\n "children": [\n "project",\n "due",\n { "type": "Act", "key": "finish", "label": "Finish", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "undo", "label": "Undo", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\n## App rules\n\nEvery rule the check enforces over an app, one sentence each under an id; a finding names its rule\'s id\n(`[list.filter]`), and `reference/<rule id>` is that one rule\'s page. A sentence names the node and the prop an author writes (`List.create`, a `Section`);\neach area stands in the tree where this table says:\n\n| Area | Stands at |\n|---|---|\n| `app` | what every write meets (the tree\'s keys, the names it declares, the tables and rows it carries), the App, and the register List\'s props that belong to the app: `words` (labels), `color`, `scope`, sources, the root Views |\n| `template` | the document templates an Act makes and an Export fills |\n| `list` | a List: its columns, filters, search, group, sort, layout, tabs, period, export, and what a child List holds |\n| `reading` | a Reading |\n| `record` | a Record and its parts: Section, Side, Act placement |\n| `statement` | a Statement |\n| `act` | an Act |\n| `check` | a Check |\n\n<!-- generated:start rules-app -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.schema` | Every key is one its table lists, holding the type its row gives, and every required key is stated. |\n| `app.names-declared` | Every alias a key names is declared: a table of the App\'s `tables`, a field of the table the node reads, an option of the select it names, an Act `key` of the App, a template of its `templates`, or an app. |\n| `app.record-home` | A Record stands in the App\'s `pages`, never inside a List: one page per entity, opened from the Lists over it. |\n| `app.spec-claims` | The app a tree compiles to names only the queries, workflows and agents it declares, reads the columns its screens draw, sends the inputs its workflows take, and gives each layout what it draws its rows by (a calendar a date to stand a row on). |\n| `app.compile-lowers` | Every screen, read and write a tree states lowers to the app\'s spec: a tree the compiler cannot lower is refused at the App. |\n| `app.tables` | A call declares at least one table and at most 50; send the rest in a second call. |\n| `app.rows-cap` | Rows are a sample: at most 200 per entity, 2000 per call and 2000 documents attached \u2014 a real data set goes in with `create_records` once the tables exist. |\n| `app.alias-scope` | An alias is unique where it is named: tables and fields in their table, options in their select. |\n| `app.label-unique` | A label is unique where it is found by its label: fields in their table, options in their select. |\n| `app.filter` | A filter \u2014 a view\'s, a rollup\'s \u2014 tests fields of the entity it reads, through links as `entity.field` hops each standing on the entity the last lands on, by options its select declares. |\n| `app.input-once` | The fields the App\'s saves, adds and Acts of a table send are each sent under one input name: a files or many-link field is sent as `<alias>_added` (and `<alias>_removed` by a save or an Act), so no other field of the write is so named, and none takes an input the workflow names itself, such as `record_id`, the input naming the row. |\n| `app.alias-unique` | An App\'s `key` is unique among apps, and an Act\'s among the Acts of its App, every List\'s included. |\n| `app.icon` | An App\'s `icon` is a Lucide icon name in kebab-case, as `receipt` or `trending-up` are. |\n| `app.add-label` | A List\'s `add_label` stands only where it adds rows (`create`), in words that are not empty and hold no `{` or `}`. |\n| `app.labels` | An App\'s `words` name a table it reads and a field or option of it, in words that are not empty and hold no `{` or `}`; no two fields of a table, nor two options of a field, show the same words. |\n| `app.records-entry` | Every table an App draws a List over, opens or picks from \u2014 a root List\'s, a child List\'s, a linked row\'s, a documents List\'s \u2014 has a `records` entry. |\n| `app.scope` | The App\'s `scope` names the table whose one row the app works inside (the folder), a table whose row rule can bind; every List over a table linking to it is filed in the open folder (`list.scope`). Stated again on such a List as a `columns`, `filters` or `search` entry, `group`, `where`, `opens`, a Field of a part, a `create` question or a report\'s `where` or `per`, its folder link is left out and said: the App already narrows every read to it and files every add under it. |\n| `app.folders` | The App\'s `folders` names a root List over the table its `scope` names: that List draws the folders the app opens on, and a row pressed is the folder entered. |\n| `app.when` | A node\'s `when` holds single selects to options, yes/nos to `true` or `false` (stored, a formula of one \u2014 a formula with `options` is a select \u2014 or, offering a node, a lookup through a link to one row), numbers and dates to bounds (`gt`, `gte`, `lt`, `lte`; a date\'s bound is a day, a moment on a datetime, or `{ "now": true }`) and any field but a yes/no to `{ "empty": true \\| false }` \u2014 a number read in each row\'s own unit or currency and a lookup take no bound. |\n| `app.asked-written` | What a List\'s `create` asks, what an Act\'s `asks` asks and what `starts` fills is a field a person writes \u2014 never a formula, rollup, lookup, autonumber or a date the workspace stamps. |\n| `app.own-rows` | A many-link to rows that each belong to one row of this entity is never a `create` question or an Act\'s `asks`: those rows are the record\'s own, each written by its own write. |\n| `app.create-asks` | A List\'s `create` asks fields a person writes \u2014 never the link or the folder it files the row under, which the add sets itself. |\n| `app.create-required` | A List\'s `create` asks every field its entity requires that nothing else fills \u2014 a `default`, `starts`, the record or folder it files the row under, or a `default_from` over a link it fills \u2014 or the server refuses every add. |\n| `app.row` | A Record\'s `row` states only what differs from `records`: a `subtitle` that is not the title, a number for its `figure`, dates for its `due`, an `image` that is a files picture no Act makes documents into, or `false` for a figure, deadlines or picture the entity states and the App draws none of. |\n| `app.restates` | *Noted, never refused:* A key the tree states that the platform sets the same without it \u2014 a `label` the table\'s or field\'s own, a `row.subtitle` the table\'s, a `door`, an add or a layout end the default gives, a row rule a status history inherits \u2014 changes nothing: the write keeps it and says so. |\n| `app.tasks` | *Noted, never refused:* A task entity an App lists whose rows no write of the App moves to a closed option (its ring stands disabled), or that an Act ticks done and none moves back. |\n| `app.same-list` | *Noted, never refused:* A root List over a table another App of the workspace lists at its root. Unnarrowed, every reader sees the same list, and a row\'s rail shows only that app\'s parts, so no one sees the whole path. A different job narrows with `where` and `columns`; a shared job stays one app, `owner` on its Acts and stages deciding who presses. |\n| `app.workflow-value` | A value a Workflow takes or hands back states what its type needs and nothing another type does: a `"record_link"` its `entity`, a `"select"` its `options` or the `field` holding them \u2014 never both \u2014 an `"object"` its `fields`, an `"array"` its `items`; `multi` stands on a `"record_link"`, `"select"`, `"member"` or `"file"`; an output is never a `"member"` or a `"file"`; and a value nests at most 8 deep. |\n| `app.query` | A Query reads `rows` of one table \u2014 under the App\'s row rule of it and inside the open folder where the table holds one one-row link to the App\'s `scope` (one holding several is read through `list`) \u2014 or a root List\'s rows as that List reads them (`list`: its `where`, folder and order; never a List reading `sources`), one of the two; it returns them as `fields`, ordered by `sort` and bounded by `limit`; each param is a number, a yes/no, a date, a select, a one-row link or a member holding one, read by an entry of `where` on a field of its type \u2014 a date by a range, a number by either, and never a number read in each row\'s own unit or currency or a date holding a span. |\n| `app.generated-name` | A name the App makes is taken by nothing the App states: no Query, Workflow, Reading or List `key` is the name of a read or a workflow the App makes, an Act\'s own `workflow` among them; where the App makes two reads spelled alike, the later takes the next free ordinal (`_2`, `_3`). |\n| `app.surface-described` | *Noted, never refused:* A value a Workflow takes, and a param a Query takes, that states no `description`: the one line a caller reads to fill it. |\n| `app.keys-unique` | No two children of one node share a key: an address names one node. |\n| `app.states-list` | An App states a List whose rows it lists, only Sheets of Readings, or only Queries and Workflows for a server to call. |\n| `app.period` | An App\'s `period` is the window every Sheet opens on, so it stands in an App that holds a Sheet: a List states its own `period`. |\n| `app.dashboard-words` | An App that holds Sheets and no List reads every table\'s rows whole and states no `words` or `scope`: those are an App with a List\'s. |\n| `app.entity-once` | The App\'s Lists and their sources work a table one way: its rows ticked as tasks by the same moves, and their work counted by the same kinds of task rows. |\n| `app.add-filed` | The Lists adding rows of one table file them by one link: where two Lists add them by different links, each is refused naming the other\'s \u2014 state `create: false` on every List but the one whose link files them. Wrong: a List adding `booking` rows filed by `freelancer` beside one filed by `production`. Right: one states `create: false`. |\n| `app.adds-field` | A picker\'s `add` names fields of its table a person writes, each once. |\n| `app.edits` | *Noted by the designer on a write, never refused:* The fields an app\'s saves may change are the fields its surfaces write \u2014 a record\'s save, a child row\'s, an in-place column, a lane, gantt or plan move \u2014 less what its own Acts change; the designer notes an app whose saves change none. |\n\n<!-- generated:end rules-app -->\n\n## Reading rules\n\n<!-- generated:start rules-reading -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.value` | A Reading sums a number, never a percent \u2014 percents do not add up; a value of `{ avg }` reads one. |\n| `reading.average` | `{ avg }` averages a Reading\'s `value` over the rows holding one, read against a plain `target` \u2014 never a value `limits` bounds, whose bound is a sum. |\n| `reading.split` | `by` and `across` split by one value each row holds \u2014 a single select, a one-row link, one member or a yes/no, stored or a formula, a lookup through one-row links as the field it reads \u2014 or by the bands `tiers` cut a number read in one unit on every row; a date `by` splits them per period, as a trend; a grid crosses two different fields. |\n| `reading.over` | `over` is a date: the row\'s own, stored or a formula, or its parent\'s through a lookup over a one-row link. |\n| `reading.where` | A reading\'s and a Query\'s `where` keep rows by a select\'s options, a yes/no\'s `true` or `false`, a number or date\'s bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }`), `{ "empty": true \\| false }`, or a member field, a lookup of one, or a member of the row a one-row link names (`<link>.<member>`), holding the reader (`{ "me": true }`); a List\'s `where` also keeps rows by `<link>.<field>`, a select or yes/no of the row a one-row link names; a Query\'s `where` also holds a field to what the call states (`param`, `from`, `to`). |\n| `reading.target` | `target` reads a value nothing bounds \u2014 a value `limits` bounds reads against the sum of its bound. |\n| `reading.better` | `better` needs `over`: a change is read over the periods its date places the rows in. |\n| `reading.progress` | A Reading stating `planned` and `done` (the work against its plan) reads dates of its rows for `planned` and `finished`, and a number for `done`. |\n| `reading.progress-alone` | A Reading stating `planned` or `done` is the work against its plan: it names its `entity` and states `planned` and `done`, with `finished`, `where`, `via`, `tab`, `when` and `label` beside them, and none of a figure\'s props (`value`, `by`, `across`, `over`, `ahead`, `steps`, `on_hand`, `target`, `better`). It stands in a List\'s band or a record, never on a Sheet. |\n| `reading.key` | A Reading\'s `key` is its query\'s name, and a List that only reads is called by its `key`, else its entity\'s alias: each its own among the App\'s Readings, Lists that only read and Queries. |\n| `reading.tabs` | A Sheet holds Readings and Lists, one at least; a Reading stands in a Sheet or in a List\'s band. |\n| `reading.restate` | *Noted, never refused:* A Sheet\'s count tile counting the rows a List beside it lists under the same `where` and tab, and a List\'s band counting its rows past a deadline, say what the List already draws: its head counts the first, its overdue chip the second. |\n| `reading.period` | An App\'s `period` is the one its Sheets open on \u2014 "month", "quarter", "year" or { "days": 30 } \u2014 and it stands only over a Reading placed in time by `over`. |\n| `reading.funnel-place` | A Reading with `steps` (a funnel) stands in a part of a Record: a band and a Sheet draw none. |\n| `reading.on-hand-split` | A Reading with `on_hand` compares what is owed with what is on hand per value of one field, or two: its `by` and `across` name fields, never bands. |\n| `reading.average-single` | An average (`value: { avg }`) is a single figure\'s: its Reading states no `on_hand`, `by` or `across`. |\n| `reading.grid-rows` | `across` splits a grid\'s columns, and stands only beside the `by` splitting its rows. |\n| `reading.band-off` | `readings: false` turns off the band a register leads with by default: a List stating it states no Readings, which are the band. |\n\n<!-- generated:end rules-reading -->\n\n## Statement rules\n\n<!-- generated:start rules-statement -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `statement.lines` | A Statement\'s `lines` are numbers of the record, each once \u2014 the first stating no `op`, every other one, the last an `"equals"` \u2014 each `"equals"` a formula, rollup or lookup, and a `rate` a number of the record. |\n| `statement.rows` | A line\'s `parts` read rows of an entity holding `same`, a one-link of the record\'s to the same entity; `at`, a moment of those rows, and `before`, a moment of the record (datetimes, never days), stated together; their `columns` and `figure` are those rows\' fields, the figure a number. |\n| `statement.parts-keyed` | A line\'s `parts` add up to its figure, so no person keys it: a formula, rollup or lookup, a value the server copies when the record is made (`default_from`) that no `create` asks and no save or Act writes, or a stored number the App\'s saves leave out \u2014 the line draws it read; each part\'s `figure` is frozen when its row was certified \u2014 a stored number an Act fills, the server copies or the App\'s saves leave out, never one a person keys or the server recomputes \u2014 and no person keys the moments `at` and `before` either. |\n\n<!-- generated:end rules-statement -->\n\n## Check rules\n\n<!-- generated:start rules-check -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `check.field` | A Check\'s `field` is a yes/no or text formula of the rows of the page\'s entity. |\n| `check.of` | A Check stands in `pages/<entity>` and reads a yes/no or text formula of that entity. |\n| `check.not-placed` | A Check\'s field is never also placed on the record as a Field \u2014 the line under the head says it. |\n| `check.on` | A Check\'s `on` names what it refuses: `"update"` (the saves), the `key` of an Act over the Check\'s entity \u2014 on one row or over a List\'s rows \u2014 or `"all"`. It binds this App alone; a Delete is the table\'s checks\' to refuse. |\n| `check.resolve` | A Check\'s `resolve` names an Act of this App on one row of the Check\'s entity, not refused by the Check, and drawn as a button \u2014 never a correction. |\n| `check.restates-meter` | A warning reading a gated meter\'s figure against its bound or pass mark is refused \u2014 the meter draws it. |\n\n<!-- generated:end rules-check -->\n\n## List rules\n\nThe rules of a List\'s props and of what a child List holds. A layout\'s, a Tab\'s, an Export\'s and a desk\'s rules stand with their keys.\n\n<!-- generated:start rules-list -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.key-shape` | A List\'s key is not a record id\'s shape. |\n| `list.peers-read` | Root Lists over one table may state different `where`, unless one holds a `where` through a link, `sources` or a `plan` layout. |\n| `list.column-drawn` | A List\'s `columns` stand beside what the row draws itself: a column of its title, subtitle, picture, status, figure or meter\'s bound, of a child List\'s link back, or one named a second time, stands once where the row seats it. |\n| `list.columns-budget` | *Noted, never refused:* A List\'s `columns`, each at the width of its kind, are told against the room a desk leaves beside its name and the row\'s own status, deadline and figure; what does not fit folds onto the name\'s line. |\n| `list.filter` | A List\'s `filters` name a select, a member, a link, a date, a yes/no or a number of the List\'s own rows \u2014 a lookup through one-row links as the field it reads \u2014 never the status (its chips), nor one `where` fixes. |\n| `list.filter-split` | *Noted, never refused:* A `filters` entry on a field a Reading of the List with `by` or `across` splits the rows by \u2014 a press on its part narrows by it too; a member\'s filter, which narrows to the reader\'s own rows, is never noted. |\n| `list.filter-unshown` | A `filters` entry, a narrowing the List `opens` on, and a press in a Reading\'s band (a part, a grid cell, a figure\'s `where`) name a field its rows show \u2014 a `columns` entry, the row\'s title, line, picture, status, figure, deadline or meter\'s bound, the unit or currency a drawn figure is read in, a warning its line says, or the group or lane it stands under \u2014 or a formula drawn where every field it reads is (through other formulas too; one reading none is drawn nowhere). A narrowing to the reader needs none. A tree leaves out a `filters` entry no row shows and says so (name the field as a column or in the row\'s line to offer it); the other two are refused. |\n| `list.tiers` | `tiers` band a number read in one unit on every row; a figure read in each row\'s own unit or currency is named bare. |\n| `list.search-undrawn` | *Noted, never refused:* A List\'s `search` matches all of a row\'s text, drawn or not: where a lookup, rollup, copy or link of its rows reads another entity under a row rule the List\'s readers are not all inside, the search finds rows by that text though the List draws none of it. |\n| `list.search` | A List\'s `search` names text, a code, or a link \u2014 matched by its row\'s title. |\n| `list.sort` | Each `sort` key of a List or a Tab names a field of the List\'s rows that holds an order \u2014 never files \u2014 and no field twice. |\n| `list.group` | A List\'s `group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 the status too, but never on a task list\'s block, whose chips narrow it; only a table or cards List groups, and a gantt into its lanes; grouping by the title needs a `row.subtitle` to lead each row. |\n| `list.readings-own` | A Reading in a List reads the List\'s own entity; another entity\'s stands on a Sheet. |\n| `list.readings-bands` | A Reading in a List that bands a number by `tiers` has that field with the same tiers among the List\'s `filters`, which a press on a band narrows by. |\n| `list.readings-restate` | A Reading with no `by` in a List never sums the row\'s figure, counts the rows, or counts one stage\'s rows, unless it is placed in time (`over`): the summary line and the status chips already do, but draw no change against the last period. For the summed figure a mix `by` a field, or a sum under a `where`, stands instead; for the rows counted, a sum of the figure under a `where`, a mix `by` a field, or a yes/no in `where`. |\n| `list.where-opens` | A List\'s `where` and `opens` hold a select\'s options, a yes/no\'s value, a number or date\'s bounds (`lte`, `gte`; a date\'s `{ "now": true }`) and `{ "empty": true \\| false }`; `opens` alone names the reader \u2014 a member field or a lookup of one holding `{ "me": true }`, or, on a status whose `stages` have owners, the rows waiting on the reader \u2014 and takes fields only, on the status only options. A field `where` fixes to options is never a filter nor opened otherwise, and `opens` stays among the options `where` keeps. A List laid out as a `plan` keeps its items by options and yes/nos alone. |\n| `list.roster` | A `layout: "roster"` List holds the List of its cells: the cells\' entity has one single link to this one and a date on its line (its own field, or a lookup of its parent\'s date); a roster draws no `columns`, and an `expect` (with `of`) stands only on the cells List. |\n| `list.roster-expect` | A roster cells List\'s `expect` is a single select of its rows, and its `of` this entity\'s multi-select whose every option is one of `expect`\'s. |\n| `list.source-page` | A source\'s entity states a Record page in the App\'s `pages`. |\n| `list.band-pivot` | *Noted, never refused:* A Reading with `across` (a grid) among a List\'s Readings: its grid reads on a Sheet, and the band leads with a figure (a Reading with no `by`). |\n| `list.headline` | *Noted by the designer on a write, never refused:* A List over rows that fall due or carry money and have no status whose steps the chips count, laid out as a table, cards or a gantt, has Readings \u2014 they split the rows by a field they show. |\n| `list.figures-lead` | *Noted, never refused:* A root List over a table holding a status, or a money field beside a date, to count or total states a Reading, or a Tab with totals, above its rows: what a person watches (money owed, what is late, what waits on them) as a figure or a chart. |\n| `list.title-only` | *Noted, never refused:* A root List whose rows draw their title alone: a subtitle, a figure, a status, a deadline, a picture, a face or `columns` says what each row is. |\n| `list.people-undrawn` | *Noted, never refused:* A root List drawn in columns, stating fewer than two besides the figure, where a table whose rows are people links to its table: the paired link holding several of them is not a column of it, or the link is not paired. |\n| `list.span` | *Noted, never refused:* Rows that each run from one date a person states to a later one \u2014 ordered by a `min` or a table check, both required or the second the row\'s `due` \u2014 are drawn in time by some List of some app; the note names a calendar, and lanes on a `no_overlap` link beside it. |\n| `list.lanes-overlap` | *Noted, never refused:* Lanes of dated rows by a link with no `no_overlap`. |\n| `list.planned` | *Noted, never refused:* Rows each held on one date a person states \u2014 required, no Act stamps it, a new row does not start at today \u2014 listed by a register with no `layout`: `layout: "calendar"` draws them on their days. |\n| `list.where-bound` | A bound read from the record (`{ "record": \u2026 }`) in `where` narrows only a List that reads its rows \u2014 `same`, or `edit: false`. |\n| `list.where-reader` | A root List\'s `opens` names the reader (`{ "me": true }`), never its `where`. Wrong: `where: { crew_lead: { me: true } }` on a child List. Right: a row rule bounds access, or a root List over the entity states `opens: { crew_lead: { me: true } }`; the write moves a root List\'s `where` there and says so. For a member of a linked row, add a lookup of `<link>.<member>` on the table and open on it. |\n| `list.where-reader-path` | A path reader `<link>.<field>` names a one-row link and a member field of the row it links. |\n| `list.props` | A node states only the props of its place: a List those of a root List, a roster\'s cells, a rows, agenda, timeline or read-only List of a record (which take every prop of a View but `sources`), a document or a Sheet; the Record of a List that opens no row in place and a source\'s entity page `entity`, `edit` and its children; a Sheet its `key`, `label` and children. |\n| `list.holds` | A List holds what its place draws: a root List its Tabs, Readings, Exports, Acts over ticked rows or every row in view, sources and, under a roster, the List of its cells; a child List its Tabs, Readings, Exports, Acts over ticked rows and, with `under`, the List of its documents; a Sheet its Readings and Lists. An Act on one row and every Check stand in `pages/<entity>`. |\n| `list.layout-place` | The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a child List writing its rows as a table, checklist, desk or gantt; any child List as an agenda or timeline. |\n| `list.edit-column` | An edit column (`{ "field": \u2026, "edit": true }`) stands in a child List only: the register\'s rows are written where they open. |\n| `list.child-link` | A child List reads a child linked to the record; `via` names the link where the child links more than once. |\n| `list.row-blocks` | A List drawn as lines (`expect`, `under` or a desk) opens no row in place, so no List stands below its rows; a plain list of rows holds one. |\n| `list.title-back` | Where a child\'s title is its link back to the record, its first other `row.subtitle` names it there \u2014 a text, a code, a select, a link or a member, never a number or a date. |\n| `list.where` | A child List\'s `where` names single selects of the child by the options they hold (a row holding none stands in no such List; one held at a single option is never also a column), yes/nos by value, numbers and dates by bounds, and fields by `{ "empty": true \\| false }`. A yes/no, a bound or a blank is never held: a child List adds rows only at a stored yes/no\'s start, none under a bound or a blank, and never picks, expects or stands lines under documents. |\n| `list.under` | `under` names the child\'s one-row link to a document entity that pairs a many-link back and is read under this record by its one link; the lines\' columns never read the document (its heading does) nor hold long text. |\n| `list.under-once` | Documents drawn over their lines (`under`) are never listed again as a List of their own. |\n| `list.edits` | A child List\'s editable columns (`{ "field", "edit": true }`) name at most two of the child\'s columns or its figure that the App\'s saves write \u2014 a number, a date, a few words, one option or a one-row link, never a files or long-text field, the List\'s `via` nor a link it must name alike (a link\'s `same`) \u2014 and never stand on an `expect` List. |\n| `list.remove-roster` | A roster cells List\'s `remove: true` offers the Delete of the roster\'s rows, so it stands only beside a roster over rows the App writes. |\n| `list.attention` | `attention: false` keeps a table\'s or cards\' rows in the List\'s own order; a calendar, lanes, a gantt and a roster stand their rows in time and lift none. |\n| `list.remove-documents` | The documents List inside a child List with `under` states `remove: true` only over documents the App writes. |\n| `list.compare` | A child List\'s `compare` names two different fields of the child, `before` and `after`: two files fields, or two values of one type (text but long text, a number, a date, a single select), never with `expect`. Over files on a checklist layout, `before` is the check\'s `photo`. Over values neither side is a column or something the row draws already, two numbers share a notation, no column is long text, and the layout is no checklist. |\n| `list.current` | A child List\'s `current` names a date or number of the child (stored, or a formula) that orders revisions: the latest row is current, the rest fold as superseded. Never with `group`, `under`, `expect`, `checklist`, `compare`, `desk` or `pick`, nor beside a column of long text. |\n| `list.pick` | A child List\'s `pick` links rows of the child through `via` \u2014 an optional one-row link a person writes, no Act writes, no other rule compares rows by and no `under` List stands lines under \u2014 paired with a many-link of the record its own save writes; the child\'s `read_scope` reads a row naming no record through `via`; never with `expect` or `under`, nor where the App\'s saves leave out the child or the many-link. |\n| `list.narrow` | A child List\'s `filters`, `search`, `group` and `sort` follow the register\'s rules over the child\'s rows, its status among them but on a task list (its chips); never on the link back or a select its `where` holds at one option, nor on an `expect` List; an `under` List is grouped by its documents. |\n| `list.expect` | `expect` names the child\'s title \u2014 a single select or a one-row link a person writes, never the link back \u2014 on a child added in the List; its `columns` name a field filled in place (not on a desk, whose lines are ticked) and its `create` takes the file where the child is pictured by one. |\n| `list.expect-fills` | An expected line is made from its key and its first filled column \u2014 a desk\'s from its key alone \u2014 so every other field the child requires has a default, a start or a `default_from`, or is read first. |\n| `list.expect-of` | An `expect` object\'s `of` or `only` needs a select: `of` names the record\'s multi-select of the title\'s options; `only` names options of a single select, never with `of` or a `where` on it, one List per option; an Act\'s `paper` is drawn in one. |\n| `list.post-option` | A desk\'s `text` formula names, as `{field:option}`, only options that select states. |\n| `list.funnel` | A Reading\'s `steps` (a funnel) are 2 to 8 numbers of its child, each named once \u2014 stored, a formula or a rollup \u2014 all in one notation, never a percent nor a unit read on each row. |\n| `list.list` | A read-only child List (`same`, or a Record that is `edit: false`) lists the rows of an entity that link to the record by its one link (`via` where it has several); with `same`, a one-row link of the record, it lists the rows sharing that link\'s row \u2014 the record left out \u2014 by the listed entity\'s one link to that row\'s entity (likewise `via`). `same` stands in a Record, never on a Sheet. Its Record\'s Fields \u2014 at least one, each a field of the listed entity named once, never its title nor a `columns` entry \u2014 are what an opened row shows, read-only. |\n| `list.figures` | A Record\'s own figures (Readings with no `entity` or `by`, whose `value` names the field) are 1 to 8 numbers of the record, each a tile. |\n| `list.create-boolean` | A document\'s and a roster\'s cells\' `create` is `true` or `false`: their add asks the table\'s defaults. |\n| `list.via-path` | A `<link>.<link>` `via` only reads rows, through a row of their own: a List writing its rows lists a child linked to the row it stands under. |\n| `list.beside` | `beside` opens a row beside a table: a root List drawn as a table states it, never a board, cards, a calendar or a List of a record. |\n| `list.create-empty` | A child List that adds rows asks the fields of its add: where the table\'s defaults ask none, state `create: false`, or the fields it asks. |\n| `list.read-scope` | A child read under a record whose rows a `read_scope` narrows states its own \u2014 a row rule is not inherited, save the status history\'s, which takes its record\'s. |\n| `list.unworked-stage` | *Noted, never refused:* A register lists rows (every open one, else those its `where` keeps) at a stage no Act of the App is offered at and no Section stands at, though the App states the stages it works: keep them out with `where` or leave them to the App that works them. |\n| `list.under-note` | *Noted, never refused:* Rows holding a paper that cover another List\'s lines, listed apart with no add of their own stated: `under` draws them over the lines they cover. |\n| `list.expect-note` | *Noted, never refused:* Rows each a kind of paper, listed with no `expect` and no `where` on the kind, that no Act files a call into or `fills`: the lines still missing read as what a record needs. |\n\n<!-- generated:end rules-list -->\n\n## Record rules\n\n<!-- generated:start rules-record -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.placed-once` | A child List, a Reading, a Statement and an Act each stand once in a Record; a set of papers stands where its Act does. A Field may be stated in several parts: parts that stack draw it once, parts a reader navigates each draw it. The head draws the title, line, picture, status, figure and the nearest open deadline, and a Field of a part standing there stands aside unless a person writes it in the part; what a Side states stands only in the Side. |\n| `record.foot-total` | A child List\'s foot totals the child\'s figure and each summed column over the rows it lists; the record\'s rollup summing that field over those rows (the same `where`) is that foot, never also a Field of a part. |\n| `record.section-holds` | A part without `at` (Section, Side) holds Fields, Fieldsets, child Lists, Readings, Statements or Acts. |\n| `record.linked` | A link drawn as a block (`block: true`) is a link to one row of a table the App states a Record page of: the row stands in place as that page draws it. |\n| `record.fieldset` | A Fieldset stands in a part, or in a one-part Record, and holds two or more Fields drawn as controls \u2014 never a gallery or prose Field (`block`) \u2014 each Field in one Fieldset. |\n| `record.parts` | *Noted by the designer on a write, never refused:* A List laid out as a table, cards or a gantt opens a Record whose Sections hold the fields people write, a files Field per paper and the Acts no stage places, a Section per stage the status states (in option order) with the moves offered there at its foot, and a child List per child, a table\'s own rows that belong to a row of it included. |\n| `record.lists` | *Noted by the designer on a write, never refused:* A table some App records, whose rows other rows each belong to (a one-row link to it, never its status history), draws some of them under its row \u2014 a child List in its Record, a List with `layout` roster or lanes by that link, or an App over them working inside one of its rows at a time (`scope`). |\n| `record.at` | A Section\'s `at` names options of the record\'s status; a record with no status has no steps. |\n| `record.beside-door` | A Record whose entity a root List opens `beside` its table states no `door`: the rows open beside the table. |\n| `record.key-clash` | A Record\'s List blocks, filed rows and links share one namespace of `key`s: none repeats, a List\'s default being its table, and a link\'s or a filed field\'s being its alias; a List and a link at one key, or one alias leading to two tables, is refused. |\n| `record.side` | At most one Side stands in a Record, on a page `door`. |\n| `record.history` | No part of a Record reads the entity\'s status history (`status.history`): the rail reads each move. |\n| `record.section-acts` | An Act in a part works on the record itself; an Act over ticked rows or every row in view stands in a List. |\n| `record.move-home` | *Noted, never refused:* A status move offered at one step stands at that step\'s foot when it moves the work forward, to an exit, or back to a step it passes anyway; one offered at several steps, or moving back into a detour, stands in the Section whose `at` holds the status it enters. A move written in another Section, or in none, stands there and is said. |\n| `record.act-staged` | An Act at a staged Section\'s foot is offered only during that Section\'s steps: its `when` holds the status to options the Section\'s `at` names. A tree\'s Act with no `when` at the foot of a Section staged at one step is offered at that step and said; a correction stays offered at every step, and an exit is refused. |\n| `record.act-hidden` | An Act is never offered only while its part\'s `when` hides the part. |\n| `record.outside-place` | An Outside stands directly in a Record whose table states a stored status select, and its `key` is unique in the App: a link to a record names it. |\n| `record.outside-at` | An Outside\'s `at` names options of the record\'s status that no stage owns, and no two Outsides of a record open during the same option. |\n| `record.outside-field` | An Outside\'s Fields are read as values, each a field of the record shown once, never `edit`, `when` or a label of its own. |\n| `record.outside-list` | An Outside\'s Lists read the child rows under the record as they are: their `columns`, `label` and `where` only, never an add, a Delete, a pick, a filter, a search, a link that opens, or a bound read from the record. |\n| `record.outside-where` | An Outside List\'s `where` keeps the child rows by single selects held at options, yes/nos at values, numbers and dates between bounds, and fields by `{ "empty": \u2026 }`. |\n| `record.outside-act` | An Outside\'s Acts are its alone and each ends the visit: `when` holds the status to `at`, `set` moves it to an option outside `at`, `asks` are text, numbers, dates or listed options, `requires` names fields the Outside shows or the act asks, a `sign` is by a text field with no witness, and none states `on`, `workflow`, `templates`, `paper`, `intake`, `record`, `review`, `danger`, `recommends` or `me`. |\n| `record.holds` | A Record stands in the App\'s `pages`, once per entity some List of the app or of a Sheet is over, or whose rows a link the app draws names. Every Record holds the same: parts (Section, Side) or the Fields, Fieldsets, Lists, Readings and Statements of its one part, never both; beside either stand Outsides, Checks and Acts on one row; holding only those, the record\'s Sections are the platform\'s. The page of an entity whose rows a child List opens no row of in place (an agenda, a timeline, a read-only List) holds Fields alone. |\n| `record.remove` | A Record\'s `remove` deletes a row opened from a link; an entity a List lists is deleted as that List\'s `remove` says. |\n| `record.field-heading` | A Field drawn as a control states no `label` or `when`: only a gallery or prose Field (`block`) has a heading and a condition. |\n| `record.section-owners` | *Noted, never refused:* A Section holding acts offered at stages that different owners work \u2014 a role apiece, or a member field apiece \u2014 is two jobs in one: each owner\'s part is a Section of its own. |\n\n<!-- generated:end rules-record -->\n\n## Act rules\n\n<!-- generated:start rules-act -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.paper-note` | *Noted, never refused:* A made paper kept in a field of a record that lists its papers by kind: it is one of those lines. |\n| `act.moves` | *Noted by the designer on a write, never refused:* The rows of a root List of the App that a stored status stages towards `closed` options are moved by an Act of the App (on a page, a List or an Outside), or by its authored `workflow` \u2014 each open option moves to the next, the last to the first closed one. |\n| `act.set-not-asked` | A field an Act `set`s (an option, a value, `{ "now": true }`, `{ "me": true }`, an input) or `sign`s is the Act\'s outcome: the App\'s `create` never asks it, and a required one takes a `default`. A `formula` only starts a value, which a person may change after. |\n| `act.owner` | An Act\'s `owner` is a single member field of its row, a one-row link\'s member field (`link.field`), or `{ "group": <id> }` of a group the workspace holds: the press is that owner\'s, or the one standing in for them. An Act handed no row (`review`, `intake`, or over the list asking a person something) has no row to read a member field from, so its owner is a group. |\n| `act.owner-stage` | *Noted, never refused:* An Act that moves no status and is offered while the status holds a stage another member owns is pressed by that stage\'s owner: state its `owner` for someone else to press it. |\n| `act.owner-moves` | An Act stating `owner` moves no row off a stage another owner owns: the server refuses that move to anyone else, so the press would be refused. A move from an option no one owns is fine. |\n| `act.asks-set` | A field an Act `asks`, `set`s or `sign`s is stated by one of them: what the Act writes is its outcome, never also asked, and no field is written by two clauses of one Act. |\n| `act.starts` | `starts` (an ask `{ field, starts }`) starts a field the Act asks \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 for the reader pressing it, who changes it at will. |\n| `act.set-formula` | `set: { <field>: { formula } }` reads fields of the acted row and computes what the field holds \u2014 a number, a date, text, a yes/no or a single select\'s option (`{field:option}`), typed as the entity\'s own formulas are \u2014 never the status; a bound a write rule holds the field to is checked on the computed value as the Act runs. |\n| `act.set-formula-option` | A `{field:option}` token of a `set` formula names an option that select states. |\n| `act.of` | An Act in a child List works on that child: the one row pressed \u2014 or, with `on: "ticked"`, the rows ticked together where the record lists them as tasks \u2014 never the rows in view. |\n| `act.writes-line-key` | An Act never writes the link or the key naming an expected line under its record \u2014 a line\'s key is stated by filling it. |\n| `act.makes-or-runs` | An Act makes a document (`template`, `templates`) or runs an authored `workflow`, never both \u2014 the workflow makes what it needs. |\n| `act.does-nothing` | An Act does something: it `set`s a value, `asks` a field, runs a `workflow`, makes a document, or takes an `intake`, a `record` or a `sign`. |\n| `act.view` | An Act over every row in view (`on: "view"`) writes (`set`), makes a document, runs a workflow or reads papers into a new record, and states no `requires`. |\n| `act.requires-written` | A field an Act requires that only an Act writes is written by an Act offered together with it, or asked by the Act itself. |\n| `act.recommends` | A field an Act `recommends` is not also in its `requires`. |\n| `act.set` | `set` writes each field a value it holds \u2014 an option alias, a number, a yes/no, a text, `{ "now": true }` on a date, `{ "me": true }` on a member, `{ "input": "<name>" }` of an input the Act asks of the same kind \u2014 or clears an optional one with `null`. |\n| `act.into` | `into` is a files field of the one record the Act is pressed on, beside its `template` or `templates`. |\n| `act.paper-list` | A List a made paper names is one it can list: none keeps its rows by the reader, and no name is reached by a child List that writes its rows and one that only reads them, or by two of either, at once. |\n| `act.paper-list-field` | A List a made paper names is not also a field of the record, other than the link to those rows; an outline\'s rows are handed their depth as `level`, so they hold no field of that name. |\n| `act.paper-loop` | A loop of an html or Word paper that prints a field of each item runs over a List\'s rows, never over a link, whose rows a paper is handed as their titles \u2014 in the record or in a listed row; a List\'s rows are looped for their fields, never printed whole; a loop runs over a name the paper is handed, never one it is not, which prints an empty table. |\n| `act.paper` | `paper` is a kind the record lists its papers by, on one record \u2014 never beside `into` or `templates`; one maker per kind. |\n| `act.templates` | `templates` names each template once, kept in `into`, on one record pressed alone \u2014 never beside `template` or `asks`, in a child List, or with an `on` over several rows. |\n| `act.intake` | `intake` names a child the record lists in a child List with `expect` on its title \u2014 a single select, the paper\'s kind \u2014 and is narrowed by no `where`, holding exactly one files field and needing nothing an added line does not fill; the Act runs on one record, or over the view (`on: "view"`) where the papers make a new record, states `fills`, and states nothing but its `label`, `when` and `requires` beside them \u2014 over the view no `when` or `requires`, the record has no row yet. |\n| `act.record` | `record` names a child the record draws in a timeline List or a child List with no `expect`, `under` or `where`, linking back by one single link, its row needing nothing the recording does not write: `audio` and `video` files fields, `transcript` text, `at` a date, `by` a member, each its own field; on one record, stating only `label`, `when`, `requires` and `fills` beside it. |\n| `act.sign` | `sign` runs on one record: `into` a files field, `by` a text field the signer types or a member field set to the person pressing, `at` a date, `witness` a member field \u2014 stated exactly beside a text `by` \u2014 each a field of its own that the Act does not also ask or set, and no other Act signs into `into`. |\n| `act.fills` | `fills` names each once, only beside `intake` or `record`. Beside `record`: a field of the recording\'s row the recording does not write, never a link. Beside `intake`: a field of the record, `<link>.<field>` on the row a required one-row link names (never beside that link), or a child the record adds rows of in a child List with no `expect`, `under` or `where`, filled in the fields its `create` asks \u2014 every one a new row needs among them. Each field filled is one a person writes \u2014 text, a number, a date, a yes/no, options or a single link\'s row \u2014 never a status, a field an Act writes or a link `same` narrows; a link\'s row is one the App reads of its entity. Over the view the papers make a new record, so `fills` names every field the record requires that nothing fills itself \u2014 the review asks the ones no paper states \u2014 and the row a required one-row link names is found on its entity\'s `natural_key` once `<link>.<field>` fills every field of it, left as it is, else added with the fields filled, so `fills` names each field that row requires too. |\n| `act.fills-drawn` | *Noted, never refused:* A field `fills` writes that the record draws nowhere: the review shows the change, the record does not. |\n| `act.fills-new` | *Noted, never refused:* A child `fills` adds rows of, whose natural key the papers cannot state: every row read is added, so the same papers read twice list them twice. Over the view, so is the row a required link names where the papers fill no natural key of it. |\n| `act.input` | An input has a name of its own \u2014 never another ask\'s, a field the act sends under that name (one it asks, one a `set` takes from an input, a typed `sign.by`, a `requires`), `sign.into`, or the record input its workflow takes (nor `approved` beside `review`) \u2014 `options` exactly when it is a select, `entity` exactly when it is a link, and a `default` field holding what it states. An input starts empty, or from its `default`, and never reads, shadows or overwrites a field of the row: an act that adds a subtask may ask `name`, though the row has a `name`. A `"file"` input is read by the Act\'s authored `workflow` alone, starts empty, and is never written into a field by `set`. |\n| `act.review` | `review: true` stands beside an authored `workflow` on an Act over the record, the ticked rows or every row in view (never on a List reading `sources`), never beside `set`, `template`, `templates`, `intake`, `record`, `sign` or `confirm`, nor in a child List, and it asks inputs only, none named `approved`. Its workflow is that Act\'s alone, run by no other Act. The workflow calls only steps that read \u2014 no agent \u2014 and returns a changeset of the entity\'s table in `data.review`, the same for the same inputs and rows; the platform writes the rows `approved` names, each only while the run proposes it as the caller read it. Over every row in view (`on: "view"`) it is handed no rows and states no `when`: its workflow reads the rows it may change, whatever the view is narrowed to, and no bound on a run\'s rows applies. |\n| `act.workflow` | An Act\'s authored `workflow` body parses once the guards the Act states are placed above it: the code is the author\'s, the guards above it the platform\'s. A declared Workflow an Act runs takes the row pressed as `record_id` (a required record_link to the act\'s rows), is run by that one Act, over one row, which asks only its inputs and states no `set`, papers, `intake`, `record` or `review`. An authored `workflow` is one Act\'s. |\n| `act.set-tagged` | An Act\'s `set` states the moment as `{ "now": true }`, the person pressing as `{ "me": true }` and an input as `{ "input": \u2026 }` \u2014 never the strings `"now"`, `"me"` or `"input:\u2026"`. |\n\n<!-- generated:end rules-act -->\n\n## Template rules\n\nThe rules of the document templates an Act makes and an Export fills.\n\n<!-- generated:start rules-template -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `template.kind` | An Act\'s `template` is an html, excel or word document template and an Export\'s `template` an html or excel one, never an email or pdf-form one. |\n| `template.marker` | Every marker of a Word template an Act makes is filled by that Act: a field of its entity, or a list of the child rows its record lists (the entity\'s own alias over several rows). |\n| `template.act` | *Noted, never refused:* In an App none of whose Acts runs an authored `workflow`, every html, excel or word template is made by an Act (`template`, `templates`) or filled by an Export \u2014 the note names the app over the table whose fields it prints most, where the Act belongs. |\n\n<!-- generated:end rules-template -->\n\n## What the workspace remembers\n\nThe workspace holds every table, field and select option under an id that never changes, whatever its\nlabel or alias becomes. `set_tables` answers each table\'s id, and an\napp\'s body names tables and templates by those ids, so a relabel on either side is a rename and no body\npoints at another table by accident.\n\nA table `set_tables` refuses to write, or an id the workspace no longer holds, is a refusal by name. `set_tables` with `{ table_id, restore: true }` puts a deleted table back.\n\n## A complete workspace\n\nTwo main entities, so two apps: a sales desk over the orders, where an order is taken and shipped, and an account review\nover the customers, where an account manager reads each customer by tier. What belongs to a row is a child List on that\nrow\'s page, never another app or a Tab: a customer\'s orders are on the customer\'s page, and each order is also a row of\nthe sales desk, one record with one page (`first_build`, \xA7 3).\n\nOne `set_tables` call makes both tables: each item carries a `ref`, and a link names the table it points\nat by the `ref` of the other item. Its answer carries each table\'s id. One `set_app` call then makes each\napp, `{ "body": \u2026 }`: the tree\'s root names the app by its `key` and `name`, and the tables it uses in `tables` by those ids,\nshown here as placeholders to replace.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"label": "Name", "required": true, "type": "text"},\n "logo": {"label": "Logo", "type": "files"},\n "tier": {\n "label": "Tier",\n "default": ["standard"],\n "type": "select",\n "options": [\n {"alias": "standard", "label": "Standard", "color": "slate"},\n {"alias": "gold", "label": "Gold", "color": "amber"}\n ]\n },\n "orders": {"label": "Orders", "type": "link", "pair": "customer", "table": "order", "multi": true},\n "total_ordered": {"label": "Total ordered", "type": "rollup", "via": "orders", "op": "sum", "field": "amount"}\n },\n "title": "name",\n "records": {"image": "logo", "party": "organization", "figure": "total_ordered"}\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"label": "Order no.", "type": "text", "unique": true},\n "placed_on": {"label": "Placed on", "type": "date", "format": "date"},\n "amount": {"label": "Amount", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "total": {\n "label": "Total with VAT",\n "type": "formula",\n "expression": "{amount} * 1.1",\n "notation": {"style": "currency", "currency": "VND"}\n },\n "customer": {"label": "Customer", "type": "link", "pair": "orders", "table": "customer", "multi": false},\n "note": {"label": "Note", "type": "text"},\n "stage": {\n "label": "Stage",\n "default": ["draft"],\n "type": "select",\n "options": [\n {"alias": "draft", "label": "Draft", "color": "slate"},\n {"alias": "confirmed", "label": "Confirmed", "color": "blue"},\n {"alias": "shipped", "label": "Shipped", "color": "green"}\n ]\n }\n },\n "title": "customer",\n "records": {\n "subtitle": ["code", "placed_on"],\n "figure": "amount",\n "status": {"field": "stage", "closed": ["shipped"]},\n "starts": {"placed_on": "today"}\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "color": "blue",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["tier"],\n "children": [\n {"type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n {"type": "Section", "key": "account", "title": "Account", "children": ["tier"]},\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [{"type": "List", "entity": "order", "columns": ["total"], "create": ["code", "amount"]}]\n }\n ]\n }\n ]\n }\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "sales_desk",\n "name": "Sales desk",\n "color": "violet",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "order",\n "filters": ["customer"],\n "create": ["code", "customer", "placed_on"],\n "children": [\n {"type": "Reading", "by": "placed_on", "value": "amount"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "order",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "order",\n "title": "Order",\n "children": [\n "note",\n {\n "type": "Act",\n "key": "confirm",\n "label": "Confirm",\n "when": {"stage": ["draft"]},\n "set": {"stage": "confirmed"}\n },\n {\n "type": "Act",\n "key": "ship",\n "label": "Ship",\n "when": {"stage": ["confirmed"]},\n "set": {"stage": "shipped"}\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\nThe account review leaves the door a record opens through and the rows it opens in to the system, each the default the\ntable\'s facts give; the sales desk states a drawer. Each List names what its add asks (`create`). The customer\'s orders are a block in its "Orders" section, never its own `Orders`\nlink as a field as well: one fact, one place. An order is titled by its customer and read by its number under it; the\nList names what its add asks, since a subtitle or a figure is never asked by default. `Total ordered` is a rollup, so it\nis read and never asked; the sales desk\'s record opens in a drawer, because its rows are worked one after another. An\norder\'s `stage` is its status (`records.status`), moved only by the app\'s acts: they set it, so the app\'s saves leave it\nout, each act names the stage it is offered at (`when`) and the one it sets, and the register opens on the orders not yet\nshipped (`closed`).\n';
1872
+ var reference_default = '# Tables and apps\n\nThe tables of a workspace and the apps over them, each a JSON document. A table is a document, an item of\nthe tool `set_tables`: its fields, options, how a row is recognised, and the rules its writes\nfollow. An app is a tree of components, the `body` of the tool `set_app`: its Views \u2014 Lists of rows and Sheets of\nreadings \u2014 and the page each table\'s rows open. Each \xA7 is its own page, `reference/<section>`.\nWhich treatment each job\'s screen needs: the `design` reference. Each treatment worked through in an\napp: the `examples` reference.\n\n**What the documents compose with**\n\n- **Tables and fields** (\xA7 Tables, \xA7 Read scope, \xA7 Field) \u2014 a table\'s columns, options and links. A table document sits\n in the `tables` list of a `set_tables` call; a field sits under its alias in the table\'s `fields`.\n- **Records** (\xA7 Records, then \xA7 Status) \u2014 how a row of each table is RECOGNISED: its title, the line\n under it, its picture, its status, the one number it stands for. Stated once per table\n and read by every surface that draws one of its rows.\n- **Write rules** (\xA7 Write rules) \u2014 what a write finds, bounds and picks among.\n- **Apps** (\xA7 App tree, then a page each) \u2014 the Lists and Sheets at the app\'s root, each a View of its own, and the\n page each table\'s rows open: which fields go where, the acts, and the checks that guard them.\n How each thing LOOKS is the runtime\'s, one treatment per concept; no prop here changes it.\n A screen the job needs and no component states is told to the person \u2014 the job, what the app\n drew, the word wanted \u2014 never props bent to approximate it.\n\n**The working order**\n\n1. The tables and fields the jobs touch, and a `records` entry for every table an\n app lists, opens or picks. Which apps a business needs is `first_build`, \xA7 3.\n2. One `set_tables` call with the tables: a link names the table it points at by the `ref` of another\n item of the call, and the answer carries every table id and the aliases of the fields it added. A\n call carries at most 50 tables, 200 first rows a table, and 2000 rows and 2000 documents in all; more\n tables go in a further call, which names the earlier tables by alias. A call is checked whole and writes\n nothing when refused, listing everything wrong; `dry_run` is for reading the grants a write would make or\n deciding `force`.\n3. One `set_app` call per app. The tree names its tables and document templates by alias wherever it points at one;\n the App node\'s `tables` and `templates` maps are filled by `set_app`, never written.\n `set_app` with the tree as `body` creates the app, named by its `name`; a refused tree writes nothing and is listed whole, and `dry_run` is for reading the permissions the write\n would grant and remove (on the CLI, `lotics app apply <file>`, with `--check` for `dry_run`).\n4. Change an app afterwards one node at a time: `get_app` prints the `tree:`, each node\'s address under `node addresses:`\n and the `version` line, which is the `base_version_id` to send (the tree and addresses go to the app\'s author alone);\n `set_app` with `app_id`, `base_version_id` and `nodes`, a map from a node\'s address to a\n patch, changes it (`reference/changing-an-app`), and its answer states the permissions the change grants and removes. A table\n is changed by `set_tables` with its `table_id`, a merge patch over the document `get_table` answers. To go back,\n send the tree you saved before the change as `body` with `app_id`: it replaces `children` but keeps every App prop it\n omits (`words`, `scope`, `period`, `icon`), so null those. (On the CLI, `lotics app pull <app_id>` writes the tree as JSON and `lotics app apply\n <file>` sends an edited file, refused when the app has moved past the version the file was pulled at.) An app\n saved before apps were trees has no tree: `get_app` says so beside what it lets a person write, and `set_app` with\n `app_id` changes it by its whole tree as `body`, which replaces it, or by its name, description, icon and color alone.\n\n## The rules\n\n- **A `set_tables` call is all or nothing.** Every item is checked before any is written; an item\n without `table_id` makes a table, one with it patches that table.\n- **An app\'s labels decide its language.** A body names no locale \u2014 the words an\n app draws itself (its buttons, empty states, refusals) are in the language its\n own labels are written in, so a Vietnamese desk beside English ones answers in\n Vietnamese. The generated screens read the kit\'s\n pack, and a generated WRITE cannot: its refusals run on the server, so they are\n worded in that same language. Mix the two within one app and it answers in two. The app\'s own `words`\n (its words for a table, a field or an option) count as its labels: Vietnamese words over an English table\n make the app answer in Vietnamese.\n- **`set_tables` and `set_app` check all of it before anything is written**, and\n report every problem in one run rather than the first. The tables half of this\n page ends its keys with the rules the check enforces there, and \xA7 App rules and the pages after it hold the app\'s, one sentence each\n under an id; a finding names its rule\'s id (`[list.filter]`), and\n `reference/<rule id>` is that one rule\'s page.\n\n## Top level\n\nEvery table of keys on this page is generated from the grammar a table document and an app tree are written in, so it is the whole of what a key may hold.\n\n<!-- generated:start top-level -->\n\n#### set_tables call\n\n| Key | Type | Meaning |\n|---|---|---|\n| `tables` | list of [Table item](#table-item), required | One or more, all or nothing; each item is a table document with these keys added. It creates a table (a `label` and `fields` at least) or, with `table_id`, patches one: the document it states merges into the table\'s own |\n| `rows` | map of alias \u2192 list of [Row](#row) | First records of the tables the call creates, keyed by each one\'s `ref` |\n| `force` | boolean | Consent to losing what rows hold: a field deleted, an option removed |\n| `dry_run` | boolean | Answer what the call would change, writing nothing: for reading the grants a write would make or deciding `force`. A refused call writes nothing too and lists every reason, so a dry run checks no more than the call does |\n\n#### Table item\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | alias | A created table\'s handle in this call: other items link to it, and `rows` are keyed by it |\n| `table_id` | text | The table to patch; absent, the item creates one. A patch states only what changes: `null` removes a key, a list replaces whole |\n\n<!-- generated:end top-level -->\n\n**A `set_tables` item is a table document** (\xA7 Tables) with `ref` and `table_id` added, and the call\ntakes no other key. **A `set_app` body is an app tree** (\xA7 App tree), whose root is an App node: its `tables` and\n`templates` each map a local alias the tree names to the id of the table or document template it means, from the\n`set_tables` answer or `get_table`. The tree is the only home of the app\'s `name`, `description`, `icon` and `color`;\n`set_app` takes it whole to create, or as a merge patch over the App node with `app_id`, or `nodes` with `app_id` to change one, and with `base_version_id` (the\nversion you read) it refuses a write over a newer one. Nothing is built code. An unknown key is an error, never ignored.\n\nA smallest call, two tables of plain fields, a select and a two-way link \u2014 nothing else is needed to write it:\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"type": "text", "label": "Name", "required": true},\n "tier": {"type": "select", "label": "Tier", "options": [{"alias": "gold", "label": "Gold", "color": "yellow"}, {"alias": "standard", "label": "Standard", "color": "gray"}]},\n "orders": {"type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer"}\n }\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"type": "text", "label": "Code", "required": true},\n "customer": {"type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders"},\n "amount": {"type": "number", "label": "Amount"}\n }\n }\n ]\n}\n```\n\n### Aliases\n\nEvery `alias` is a lowercase slug \u2014 a letter, then letters, digits and\nunderscores (`unit_price`, `so_1001`). Aliases are how a document and an app tree\nname a field, an option or a table; they are never shown to anyone. `label` is\nwhat a person sees.\n\nLabels must be unique within their namespace \u2014 two fields on one table, two options\non one field cannot share a label.\n\n## Tables\n\n<!-- generated:start table -->\n\n#### Table document\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text, required | The table\'s name in the workspace |\n| `singular` | text | One row of this table, in the business\'s own words \u2014 what a create\'s button and panel name |\n| `description` | text | The table\'s description, written onto the table in the workspace, where a caller of an app\'s queries and workflows reads it beside them |\n| `fields` | map of alias \u2192 [Field](#field), required | The table\'s columns, each under its alias, which is its key here and so is never stated inside it |\n| `read_scope` | [Read scope rule](#read-scope-rule) | Which rows a member reads. Absent, every member with access to the table reads every row. |\n| `unique` | list (at least one) of list of alias (at least one) | Sets of fields whose values no two live rows share \u2014 each a list of field aliases (text, number, date, a single select, or a link holding one row \u2014 `multi: false`); a single text field states `unique: true` on itself instead of a one-field set. A create or update landing a second row with the same values is refused. |\n| `title` | alias | The alias of the field that names a row wherever a link or a record shows one; absent, the first text field |\n| `colors` | any value | Row colors: a list of { filters, color }, the filter reading fields of this table by alias and a select\'s options by alias; one condition on its own is a group of one |\n| `records` | any value | How a row is recognised: the keys of the Record, Status and Cadence tables below but `title`, which sits above; a table they name is an id or a `ref`. A status `history` that names a `ref` no item of the call declares is made by the call as a table, `dates` add each date field they name, and a status with stages each stage and each open option they name none for its `<option>_at`, unless the document declares it; each is listed in the result\'s notes |\n| `natural_key` | list of alias (at least one) | The field aliases a row of this table is RECOGNISED by: an app\'s add and find-or-create reuse the row they find by these values, minting one only where nothing matches. A record tool or the API creates the row it is handed. |\n| `no_overlap` | [No overlap](#no-overlap) | No two rows hold overlapping spans \u2014 a create or update that would is refused, and so is a change to the dates or states of the row a span is read through that would make two rows overlap |\n| `checks` | map of alias \u2192 table check (`workflows/table-checks`) | The conditions a write of the table\'s rows may not meet, each under its alias: a merge patch edits one, and `null` removes it. Expressions name fields by alias |\n\n<!-- generated:end table -->\n\n<!-- generated:start rules-entity -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `entity.singular` | A table a List\'s `create` is mounted over \u2014 a root List\'s or a child List\'s that adds rows \u2014 states its `singular`: one row of it, in the business\'s words. |\n| `entity.link-format` | A text field of `format: "link"` holds web addresses; one whose rows hold a phone or a mail address states no format. |\n| `entity.read-scope` | A `read_scope` clause names a group (`member_of`) or a field of its table reached through one-row links: `"self"` a member field, options a single select declares; an `any` or an `all` groups clauses, and groups nest. |\n| `entity.unique` | A `unique` set names fields of its table once each, each holding one value to compare \u2014 text, a number, a date, a single select, a one-row link \u2014 and is stated once; a lone text field is `unique: true` on it. |\n\n<!-- generated:end rules-entity -->\n\n**`unique` is a set of values no two live rows share.** Each entry names fields\nof this table holding ONE value \u2014 text, number, date, a single select, a link\nwith `multi: false` \u2014 and a create or update landing a second row with the\nsame values is refused. A set of one text field is that field\'s own `unique:\ntrue`, so it is refused here. A create carries each set in the names its panel\nsends, so the panel can name the duplicate before the write does.\n\n**`singular` is what a create says** \u2014 `New Order`, `Add Claim line`, `H\u1ED3 s\u01A1\nm\u1EDBi` \u2014 while `label` names the table, so without it the button reads `New\nOrders`. Nothing derives it: English plurals are irregular, and no language is\nexempt. In a language without plural forms it is usually the label itself,\nless any word for the collection. A List that leaves `create` to its default adds nothing over a table that states\nnone (nor does the app\'s `words` state one); a `create` list stated over such a table is refused (`entity.singular`).\n\n**An app that only reads a table\'s rows draws them with `edit: false`** and states `create: false` and `remove: false` \u2014 a log of what the system sent, a copy of\nwhat another system holds. The app keeps the section and opens each row at rest, with no Add and no Delete; a party\nof it is picked, never found or minted; and the app writes no create, update or remove for it. It shapes that app, not who may write: a direct write \u2014 the records\nAPI, the chat agent, an import \u2014 follows the table\'s access, as on any table, and another app over the same rows\nstates its own tree.\n\n**`read_scope`** \u2014 which rows a member reads \u2014 is its own page, `reference/read-scope`.\n\n## Read scope\n\n<!-- generated:start read-scope -->\n\n#### Read scope rule\n\n| Key | Type | Meaning |\n|---|---|---|\n| `any` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ANY of these holds |\n| `all` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ALL of these hold |\n\n#### Read scope by role\n\n| Key | Type | Meaning |\n|---|---|---|\n| `member_of` | text, required | The id of a group (from Settings, or chat): whoever is in it reads the row |\n\n#### Read scope by member\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A member field alias on this entity, or on the entity `through` lands on |\n| `is` | `"self"`, required | The members this column names on a row read that row |\n\n#### Read scope by option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A single-select field alias on this entity, or on the entity `through` lands on |\n| `is` | list of alias (at least one), required | Its option aliases whose rows are readable \u2014 naming none would hide every row |\n\n<!-- generated:end read-scope -->\n\n**A row rule is enforced by the platform.** A table\'s `read_scope` is resolved into its own row filters, so\nthe table tools, the data view and the API answer the same rows, and it caps what an app\'s owner can hand out: an\napp never reads beyond its owner\'s reach. An app states its own rule of each table it reads in `rows` on the App\nnode (\xA7 App tree), in the grammar above. A `"self"` clause reads a column of one member or several, and every group\nand option a clause names must exist.\n\n**A rule holds through a link.** A filter through a link and a List\'s linked column read the linked row under the\nreader\'s own rule of it, and a link to a row the writer cannot read is refused. A lookup, rollup or copy is stored, so\nit reads one value for everyone who reads its table: one over a table with a rule takes `manage` on that table, and\n`get_table` of that table lists them as `crossings`.\n\n**An app runs under its owner\'s authority**, so the people it is shared with need the app and no access to its\ntables. Where they differ in what they may read, `rows` states it: one rule per table, evaluated against the caller,\nnarrowing the app\'s screens, its queries (the AI and MCP path), its writes and acts, and its workflow bodies and app\nagents, every row they read or write. A table `rows` states no rule of is read whole by everyone the app is shared\nwith, so a desk whose audience its sharing already decides states nothing. The rule holds for admins too: an app with people who see every row names them, as a group.\n\n**A row rule is never inherited.** A child read under a ruled record states\nits own in `rows`: the record\'s `member_of` clauses as they are, and its column clauses\n`through` the one-row link the child hangs by \u2014 over one hop or several, each a\nlink with `"multi": false`, since over several rows the rule would admit a\nreader any one of them admits while the editor\'s guard reads the first. Only the\nstatus history takes its record\'s rule.\n\n## Field\n\nEvery field carries the keys below, and its `type`\'s section adds the rest; a\ntype whose section names no `default` takes none. `label` may not contain `{` or\n`}` (formulas reference fields by label at the platform level). Every row in `rows` states each\n`required` field it carries (neither a default nor a `default_from` copy is applied to them), and a required\nLINK is written with its row: the table it names is created first, and tables\nwhose required links name each other are refused, since none of their rows could\never be created.\n\n**A table states who keys nothing.** Whether a person may change a field in an app is that app\'s statement\n(what its tree draws, and `edit: false`, \xA7 App tree): a post\'s id a publishing workflow brings back, a count a sync fills, a status an act moves\nare left out of the apps that do not save them, and written by a workflow, the records API, the chat agent and an\nimport as the table\'s access allows. A formula, a rollup, a lookup and an autonumber are no one\'s to key already.\n\n<!-- generated:start field -->\n\n#### Field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"date"` \\| `"boolean"` \\| `"select"` \\| `"member"` \\| `"link"` \\| `"files"` \\| `"formula"` \\| `"rollup"` \\| `"lookup"` \\| `"autonumber"`, required | What the field holds \u2014 each type takes the further keys its own section lists |\n| `label` | text, required | The field\'s name in the workspace |\n| `description` | text | The field\'s description, written onto the field in the workspace |\n| `required` | boolean | Refuse a record whose cell for this field is empty. Every write path \u2014 create, update, an agent\'s tool call, a workflow\'s set \u2014 refuses the row by field name. A stored field is flagged only once every row holds a value. |\n\n<!-- generated:end field -->\n\n### `text`\n\n<!-- generated:start field-text -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `unique` | boolean | Unique values required |\n| `format` | `"text"` \\| `"link"` \\| `"markdown"` | How the words are drawn \u2014 plain, as a link that opens, or as markdown |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `suggest` | [Suggest](#suggest) | A text field whose control offers, as the reader types, the distinct values a text field of a catalog table holds (a damage position\'s code among the codes on file); any text is still written |\n\n<!-- generated:end field-text -->\n\n### `number`\n\n<!-- generated:start field-number -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | number | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. Omitted, a decimal. |\n| `rating` | [Rating](#rating) | The figure is a grade: whole numbers 1 to `max` (3 to 10), empty or one of them, drawn as stars. Only on a plain decimal figure. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n#### Rating\n\n| Key | Type | Meaning |\n|---|---|---|\n| `max` | integer, required | The scale\'s top: the most stars a grade holds |\n\n<!-- generated:end field-number -->\n\n`notation` is how the number reads, and every surface reads it:\n`{ "style": "currency", "currency": "USD" }` prints as money in its code,\n`{ "style": "unit", "unit": "kg" }` as a quantity with its unit after it,\n`{ "style": "unit", "unit": "percent" }` as a percent \u2014 10 is "10%", never\nmultiplied \u2014 and `{ "style": "decimal" }`, or no notation, as a plain number. One\nkey, so a figure reads one way.\n\nAn absent number is drawn blank, except a `sum` or count rollup read as a meter\'s measure: nothing accumulated yet reads 0.\n\nA unit \u2014 `{ "style": "unit", "unit": "kg" }` \u2014 is what a figure counts or\nmeasures; `percent` aside, it is measured or counted. A **measured** unit is a code of one catalog \u2014 mass `g`\n`kg` `t`, volume `l` `m3` `cbm` (a cubic metre under freight\'s name), length\n`mm` `cm` `m` `km`, area `m2`, duration `min` `h` `day` \u2014 so a figure typed in\nanother unit of its dimension converts (`12,5 t` into a `kg` field is 12 500),\nand a tile or a chart reads it in the largest unit it reaches (12 500 kg as\n12,5 t\u1EA5n; CBM never scales) while a cell, a fact and a column always read in the\nfield\'s own. Any other noun of at most 12 characters (`ki\u1EC7n`, `pallet`, `TEU`) is a\n**counted** unit: a word after the figure that never converts. A measured unit is\nwritten as its code \u2014 `t\u1EA5n`, `KG` or `m\xB3` is refused, naming the code. A formula\nstates its own as its `notation`; a rollup that keeps the value (`sum`, `avg`,\n`median`, `min`, `max`, `range`) and a lookup carry the unit of the figure they\nread, exactly as they carry a currency, and a count carries none. A quantity is a\nnumber with its unit, never words (`3 cartons` in a text field): only a number\nsums, converts and reads down a column.\n\nA field\'s cells always hold figures in its own unit, so moving it between two\nunits of one dimension (`kg` to `t`) converts every stored figure \u2014 a change made\nin the workspace, in the field\'s settings (which say how many first) or through\n`set_tables`. Any other change of unit\nrelabels.\n\nA figure whose unit or currency varies by row names a single select of its own\nrow as `per_row` \u2014 `{ "style": "unit", "unit": { "per_row": "uom" } }`,\n`{ "style": "currency", "currency": { "per_row": "currency" } }` \u2014 or a lookup of\none through a one-link, a line reading its shipment\'s currency. That select\'s\noptions are the vocabulary: each label a unit (`chi\u1EBFc`, `kg`), or an ISO 4217 code\n(`USD`). A label outside it is refused when the figure is written and when the\nselect is \u2014 its options, its type or its deletion while a figure names it. A row\nwhose select is empty reads its figure bare. Every app reads each row\'s figure in\nits own row\'s unit, and a sum never mixes units: totals are one per unit (past three units a total the runtime draws over a set of rows \u2014\nsummary line, group totals and feet, a Sheet\'s table foot \u2014\nstates the count alone; a reading an author states draws every unit), a chart draws one at a time. A rollup that keeps the value (`sum`, `avg`, `min`\u2026)\nover such a figure stands only where the child\'s select is a lookup, through\nthe rollup\'s own link, of a select on this table \u2014 the rollup reads that\nselect\'s unit; otherwise it is refused. A lookup of such a figure stands only\nwhere its table also looks up the figure\'s select through the same one-link,\nand reads in that lookup; otherwise it is refused. A count is unaffected. Moving a field between a\nfixed and a per-row unit relabels.\n\n### `date`\n\n<!-- generated:start field-date -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. A date string in the field\'s format. |\n| `format` | `"date"` \\| `"datetime"` \\| `"month"` \\| `"date_range"` \\| `"datetime_range"` | Whether the field holds a day or a moment, alone or as a span; `month` (stored YYYY-MM) is read where a field holds it; a write cannot set it. |\n| `timezone` | text | IANA timezone |\n| `derive_from` | `"created_at"` \\| `"updated_at"` | Auto-populate from the row\'s system timestamp; the field becomes read-only. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n<!-- generated:end field-date -->\n\nA `default` is refused beside `derive_from`: the platform stamps that date.\n\n### `boolean`\n\n<!-- generated:start field-boolean -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | boolean | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-boolean -->\n\n### `select`\n\n<!-- generated:start field-select -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | list of alias | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. Option alias(es) this field declares \u2014 one for single-select. |\n| `options` | list of [Select option](#select-option) (at least one), required | The choices, in the order every picker and every ladder lists them |\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n#### Select option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | Stable local alias, unique within the field |\n| `label` | text, required | Display label for the option |\n| `color` | [colour](#select) | The colour the option\'s badge is drawn in; absent, the platform gives it one no sibling option holds |\n| `mark` | [mark](#select) | The option\'s own mark, drawn in place of its colour dot wherever the option is shown: the brand it is ({kind: "brand", name: one of facebook, instagram, threads, meta, tiktok, google-ads, zalo, linkedin, x, google-meet, youtube, telegram, whatsapp, gmail, google-drive, outlook, excel, kiotviet, misa, lark, payos}) a kit glyph ({kind: "icon", name: "wrench"}) or the face of who it is, drawn from its label ({kind: "avatar", name: "person" or "organization"}). Every option of a field has one, or none does. A mark a reader does not draw falls back to the dot |\n| `short` | text | A few letters the option reads as where room is short \u2014 a table\'s column ("K5" for a long legal category) \u2014 its label shown on hover |\n\n<!-- generated:end field-select -->\n\nA patch of a select states its whole `options` list: a list replaces whole, so an option it leaves out is deleted. To\nrename or recolour one option, restate every option kept, each with its alias. Rows still holding a deleted option refuse\nthe patch unless `force`.\n\n```json\n{\n "options": [\n { "alias": "draft", "label": "Draft" },\n { "alias": "confirmed", "label": "Confirmed" },\n { "alias": "shipped", "label": "Shipped", "color": "green" }\n ]\n}\n```\n\n`color` is one of: `red`, `orange`, `amber`, `yellow`, `lime`, `green`,\n`emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`,\n`fuchsia`, `pink`, `rose`, `slate`, `gray`, `zinc`, `neutral`, `stone`.\nEvery option is drawn in its colour wherever it shows \u2014 a cell, a row\'s line,\na record, a picker, the bar a reading splits the rows by.\n\nAn option may carry its own `mark`, drawn in place of its colour dot wherever\nthe option is shown \u2014 a stage, a chip, a filter, a fact, an entry of a log, a\nreading\'s part, a lookup of the select on another table. Where the select is its\nrows\' `records` `mark`, a brand or glyph stands on the row\'s lead tile in the option\'s\ncolour, and an option with none leads with its colour dot there. A select a reader scans\ndown a column \u2014 how a payment was made, the channel, the mode \u2014 states one on every\noption, since a glyph reads before its word: the brand it IS\n(`{"kind": "brand", "name": "tiktok"}` \u2014 one of `facebook`, `instagram`,\n`threads`, `meta`, `tiktok`, `google-ads`, `zalo`, `linkedin`, `x`,\n`google-meet`, `youtube`, `telegram`, `whatsapp`, `gmail`, `google-drive`,\n`outlook`, `excel`, `kiotviet`, `misa`, `lark`, `payos`), a glyph the kit draws\n(`{"kind": "icon", "name": "wrench"}`; any other name is refused), or \u2014 where the\noptions name people or organisations who are no member and no row \u2014 the face of who\nit is, drawn from its label (`{"kind": "avatar", "name": "person"}` or\n`"organization"`). Every option of a select has one, or none does: a run of chips\nwhere one carries no mark reads as the one missing something. `set_tables` writes the\nmarks onto the table. The glyph names are `reference/field/option-glyphs`.\n\n```jsonc\n"options": [\n { "alias": "short_video", "label": "Short video", "color": "zinc", "mark": { "kind": "brand", "name": "tiktok" } },\n { "alias": "print", "label": "Print", "color": "amber", "mark": { "kind": "icon", "name": "newspaper" } }\n]\n```\n\n### Option glyphs\n\nThe kit\'s glyph names an option\'s `mark` takes:\n\n<!-- generated:start field-select-glyphs -->\n\nactivity, align-center, align-left, align-right, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, arrow-down, arrow-down-a-z, arrow-down-up, arrow-down-wide-narrow, arrow-left, arrow-left-from-line, arrow-right, arrow-right-from-line, arrow-right-left, arrow-up, arrow-up-down, arrow-up-wide-narrow, arrow-up-z-a, ban, banknote, bed, bell, between-horizontal-start, between-vertical-start, bold, bolt, book-marked, book-open, book-text, bot, box, brackets, brain, briefcase, building-2, calculator, calendar, calendar-clock, calendar-off, camera, car, chart-column, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down-up, chevrons-up-down, circle-alert, circle-check, circle-x, clipboard-list, clipboard-paste, clock, code, code-xml, columns-3, columns-3-cog, combine, construction, container, copy, credit-card, database, decimals-arrow-left, decimals-arrow-right, dollar-sign, download, ellipsis, eraser, expand, external-link, eye, eye-off, file, file-csv, file-down, file-question, file-spreadsheet, file-stack, file-text, file-up, folder, folder-closed, folder-open, folder-pen, form, funnel-plus, funnel-x, gauge, globe, gpu, grid-2x2, grip-vertical, group, hand-coins, hash, heading, heading-1, heading-2, heading-3, history, house, image, inbox, info, italic, keyboard, languages, layout-dashboard, layout-grid, library-big, link-2, link-2-off, list, list-checks, list-collapse, list-filter, list-filter-plus, list-ordered, list-tree, loader, lock, lock-keyhole, lock-keyhole-open, lock-open, log-in, log-out, mail, map-pin, maximize-2, megaphone, menu, message-circle, message-circle-question-mark, message-square, messages-square, mic, minimize-2, minus, monitor, mouse, mouse-pointer-click, music, newspaper, notepad-text-dashed, package, paint-bucket, paintbrush-vertical, palette, panel-left, panel-left-close, panel-left-open, panel-right, panel-right-close, panel-right-open, paperclip, pause, pencil, percent, phone, pin, pin-off, plane, play, plug, plus, receipt, rectangle-ellipsis, redo, refresh-cw, repeat, rotate-ccw, rotate-cw, rows-3, scan, scan-line, scissors, search, send, settings, share, share-2, shield, shield-alert, shield-check, shopping-cart, sigma, sliders-horizontal, smile, smile-plus, snowflake, sparkles, split, square, square-check, square-pen, square-sigma, star, stethoscope, sticky-note, strikethrough, table, table-2, tag, target, text-quote, text-wrap, thumbs-down, thumbs-up, ticket, trash, trending-down, trending-up, triangle-alert, truck, tv-minimal, type, underline, undo, upload, user, user-check, user-pen, users, utensils, waypoints, workflow, wrench, x, zap, zoom-in, zoom-out\n\n<!-- generated:end field-select-glyphs -->\n\n### `member`\n\nA person picker over the workspace\'s members. No default. With no role it is still drawn \u2014\nface and name, ranked as a `party` \u2014 in a screen\'s `columns` and in the register\na record draws of these rows.\n\n<!-- generated:start field-member -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-member -->\n\n### `link`\n\n<!-- generated:start field-link -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `options_where` | [filter](#filters) | Which rows of the target this link may point at \u2014 an `and` group of plain conditions over the TARGET table\'s own fields, each `field_key` a field alias. It narrows every picker of the link, and a save naming a row outside it is refused on every path \u2014 an app, the grid, an import, a workflow, the API. |\n| `same` | list of alias (at least one) | One-row links this row and each row this link points at must name alike \u2014 a fee\'s invoice is one of its own visit\'s, a box\'s seal one of its own shipping line\'s: each a one-row link of both tables to the same table, or a lookup of one (a line\'s shipping line looked up from its visit, never stored beside it). It narrows the picker\'s read to the rows naming what this row names, a row made from the picker names it too (set, never asked), and a write is refused wherever it lands \u2014 on the link, or on what the two rows compare. |\n| `table` | text, required | The table the link points at: its alias, or the `ref` of another item of the call |\n| `multi` | boolean, required | Whether a row links to one row or many: true, many; false, one. Where the link is paired, at most one of the two sides holds one |\n| `pair` | `true` \\| alias | Makes the link two-way: the alias of its partner field on the other table, which names this one back, or `true` to have the alias derived. Stated on one table, the partner is made on the other with the inverse cardinality; a many-to-many link states both sides |\n\n<!-- generated:end field-link -->\n\n**`multi` is stated on every link:** `true` holds several rows, `false` one \u2014 one customer on an\ninvoice, one project on a device. There is no default.\n\nA two-way link states `pair` on one table, as `true` or a free alias, and the partner is made on the\nother table with the inverse cardinality; a many-to-many link states both sides, since the inverse of\nmany is not decided. A pair stated on both sides is made once. Both tables are written in the one\ncall (`table` names the other item\'s `ref`). A link with no `pair` is one-way, and nothing is created on the target. Pair a link when\nthe target\'s own record should list what points at it, and leave it unpaired when it should not: either\nway the record plan draws the relation as a section on the side it points at, so an unpaired link costs\nthe target nothing. Of two paired links at most one holds one row.\nA link to its own table is paired with itself (a spouse) when `pair` is `true`, and with a second field of that table when `pair`\nnames its alias (a parent and its children, each stating the other); paired with itself it cannot hold one row.\n\n```jsonc\n// a field of table "order"\n"customer": { "type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders" }\n```\n\n```jsonc\n// a field of table "customer"\n"orders": { "type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer" }\n```\n\n### `files`\n\nA row attaches documents to it (\xA7 Rows). Each file\nis drawn by its kind, with no key to choose: a picture (an image, a video) as its\nthumbnail, a document (a PDF, a sheet) as its type\'s badge and its filename.\n\n### `formula`\n\nA formula states its keys on the field itself, beside `type` and `label`:\n`{ "type": "formula", "label": "Total", "expression": "{quantity} * {unit_price}", "notation": { "style": "currency", "currency": "USD" } }`.\n\n<!-- generated:start field-formula -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `expression` | text, required | The expression, over fields of THIS entity by alias in braces \u2014 `{quantity} * {unit_price}` |\n| `output_type` | `"number"` \\| `"text"` \\| `"date"` \\| `"datetime"` \\| `"boolean"` \\| `"select"` | Holds a formula to the type its readers need: absent, it is what the expression yields. Stated, it is checked against that and refused where they differ (a datetime is never stated date) |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. For a formula yielding a number. |\n| `link` | `true` | The formula yields a URL as text, drawn as a link that opens. |\n| `options` | list of [Select option](#select-option) (at least one) | The categories the formula yields, drawn as a single select\'s options are (read-only). The expression yields one of them as `{this_field:option}`, or null \u2014 `{days_idle} > 30 ? {warmth:cold} : {warmth:hot}`. Omit for a formula yielding a plain value. |\n\n<!-- generated:end field-formula -->\n\n`output_type` is what lets a role or a screen clause accept a computed value: a\ncaption over a derived name (`output_type: "text"`), a period over a settled date\n(`"date"`). A formula declaring no `output_type`, `notation` or `link` says nothing\nabout its result, and every rule that needs one refuses it by name. A formula stating\n`options` is a computed category: read-only, and read as a single select\nwherever it is drawn \u2014 a column, a filter, a reading\'s `by` or `where`.\n\n**A select reaches a formula as the KEYS of its chosen options**, a list \u2014\nnever their labels, and never their aliases \u2014 and a document has no keys: the\nworkspace mints them when the table is made. So an option is named in a formula\nas `{field:option}`, both aliases, and the write puts that option\'s key in its\nplace: `includes({kind}, {kind:crate})` for a select holding one or several,\n`{kind}[0] == {kind:crate}` for a single one. A select compared to its own words\n(`{kind} != "Crate"`) matches no row and computes the other branch everywhere,\nso the check refuses it and names the token. A select looked up from another\ntable is tested there, in a formula of its own, and that result looked up.\n\n**The language.** The check refuses a call or a name the platform cannot run, naming what to write:\n\n<!-- generated:start field-formula-language -->\n\n- Operators: `+ - * / %`, `== != > < >= <=`, `&& || !`; `+` also joins text\n- Numbers: arithmetic is exact decimal (`0.1 * 3` is `0.3`), a division that does not end the nearest double; a comparison between two numbers reads both at 15 significant digits; `round` rounds a half away from zero (`round(-2.5)` is `-3`)\n- Conditionals: a ternary only \u2014 `{amount} > 100 ? "High" : "Low"`\n- Not supported: optional chaining (`?.`), nullish coalescing (`??`), template literals, arrow functions \u2014 use `get(obj, "path", default)`, `coalesce(v1, v2)`\n- Helpers are these names, spelled exactly; a spreadsheet function (`IF`, `SUM`, `LEN`, `DATEDIF`) is none of them, and a formula calling one is refused\n- Math: round(n,decimals?), ceil(n), floor(n), abs(n), min(a,b), max(a,b), sum(arr), mean(arr), clamp(n,min,max), percentage(part,total,decimals?), pow(base,exp), sqrt(n), mod(n,divisor)\n- A select reads as its option keys: compare it with `{field:option}`; read its name as text with `label({field})`\n- Strings: label(select) (the option\'s name; a multi-select\'s names joined ", "), upper(s), lower(s), trim(s), capitalize(s), length(s), contains(s,search), join(arr,sep), split(s,sep), replace(s,search,rep), replaceAll(s,search,rep), removeChars(s,chars) (s without any character that occurs in chars), removeSpaces(s) (s without any whitespace), startsWith(s,prefix), endsWith(s,suffix), substring(s,start,end?), padStart(s,len,char), padEnd(s,len,char), numberToWords(n, lang?) (lang \'vi\' default, or \'en\'), uuidFrom(s) (the same UUID for the same text)\n- Lists: includes(list,value), first(list), last(list), unique(list), compact(list) \u2014 length(list) counts one\n- Dates: now(), formatDate(d,fmt), addDays(d,n), subDays(d,n), addHours(d,n), subHours(d,n), addMinutes(d,n), subMinutes(d,n), startOfDay(d), endOfDay(d), startOfMonth(d), endOfMonth(d), addMonths(d,n), differenceInCalendarDays(later,earlier), differenceInHours(later,earlier), differenceInMinutes(later,earlier), isBefore(d1,d2), isAfter(d1,d2), isSameDay(d1,d2), isToday(d), isWithinRange(d,start,end), meetsBounds(value,kind,{gt,gte,lt,lte},tz?), parseDate(d)\n- Null/type: isNull(v), isEmpty(v) (also true for "" and []), coalesce(v1,v2,...), isString(v), isNumber(v), isBoolean(v), isArray(v), toNumber(v), toFigure(v), toString(v)\n- Other: formatCurrency(amount,locale,currency), formatDecimal(value,decimals,locale) (grouped quantity, no symbol), get(obj,"path",default?)\n- Empty cells: a cell nobody filled is null inside a formula, whatever its type; one holding 0, false or "0" is not empty. Test it with `isEmpty({note})` \u2014 `{note} == ""` and `{done} == false` are false on an unset cell\n- Arithmetic over an empty cell: `+` and `-` read it as 0 beside a value (`{fee} + {surcharge}` is `{fee}` when the surcharge is empty, null when both are); `*`, `/`, `%` and a unary `-` yield null (`{price} * {qty}` is null, not 0, when the quantity is empty)\n- No helper throws on an empty cell: the math helpers and toNumber return null, the string helpers "". A value of the wrong type still errors. When EVERY field a formula reads is empty it is null \u2014 unless it reads each only as the argument of isEmpty, isNull or isNotNull (`!isEmpty({file})` is false there, not null)\n\n<!-- generated:end field-formula-language -->\n\n### `rollup`\n\nAggregates the records reached through a link on this table.\n\n<!-- generated:start field-rollup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `filter` | [filter](#filters) group | Only linked records matching this filter are aggregated; one condition on its own is a group of one. Every `field_key` in it names a field alias on the linked entity, and a select condition\'s value names an option alias there. A traversal node reaches past that entity, so its `path` hops and inner `field_key` are fully-qualified `entity.field` aliases. |\n| `via` | alias, required | The alias of a link of this table to roll up from |\n| `op` | [operation](#rollup), required | The operation over the linked rows |\n| `field` | alias | The alias of the field on the linked table the operation reads; absent for `count` |\n\n<!-- generated:end field-rollup -->\n\nA rollup states `via` (a link of this table), `op` and \u2014 except for `count` \u2014 `field`, an alias on the\nlinked table; `op` is one of `count`,\n`sum`, `avg`, `median`, `min`, `max`, `range`, `empty`, `filled`,\n`percent_empty`, `percent_filled`, `unique`, `percent_unique`, `earliest`,\n`latest`, `date_range`, `checked`, `unchecked`, `percent_checked`,\n`percent_unchecked`. The operation must be one the aggregated field\'s type\nallows \u2014 `sum` over a number, `earliest` over a date, `filled` over any stored or\nformula field. A lookup is never rolled up: roll up the child\'s own field, or a formula\nover it. A rollup states no `notation`: `sum`, `avg`, `median`, `min`, `max` and `range`\nread in the aggregated figure\'s, a count as a plain number, and a `percent_*` as a\npercent (0\u2013100), in the app as in the table.\n\n### `lookup`\n\nDisplays a field from the linked records: `via` names a link of this table, `field` a field of the table it\npoints at. Through a link holding several rows it holds every linked row\'s value, which an app reads whole: a sort by\nits first value, a filter matching any value, a grouping counting the row under each; `order_by` (`field`, `direction`)\npicks the one row whose value shows instead.\n\n<!-- generated:start field-lookup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `via` | alias, required | The alias of a link of this table to look up through |\n| `field` | alias, required | The alias of the field on the linked table to show |\n| `order_by` | [Lookup order](#lookup-order) | Show ONE linked row\'s value \u2014 the first in this order \u2014 rather than every linked row\'s |\n\n#### Lookup order\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A field alias on the linked table the rows are ordered by |\n| `direction` | `"asc"` \\| `"desc"`, required | Which end of that order the one row is taken from |\n\n<!-- generated:end field-lookup -->\n\nInside a formula, a lookup holding one value is that value (`{due_soon}` is\n`true`, not `[true]`); several values are a list.\n\n### `autonumber`\n\n<!-- generated:start field-autonumber -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `prefix` | text | Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\'). Ignored when `template` is set. |\n| `padding` | integer | Zero-pad the integer to this width. Default 1 (no padding). 3 \u2192 \'001\', \'012\', \'123\', \'1234\' (overflow uses the actual width). Ignored when `template` is set. |\n| `template` | text | Format template with placeholder tokens evaluated at insert time. Tokens: {N} (raw integer), {N:W} (zero-padded to width W, e.g. {N:3} \u2192 001), {YEAR} (4-digit year), {YEAR:2} (2-digit year), {MONTH} (2-digit month), {DAY} (2-digit day). Date tokens use the workspace timezone. Example: \'HM-{YEAR}-{N:3}\' yields \'HM-2026-001\'. Stored as the composed string; subsequent template edits do NOT re-format existing rows (date tokens would lose the original creation date). |\n| `next` | integer | Sets the number the next row takes, once, as the patch is written; never below one past the highest number issued. On a field added to a table with rows, those rows are numbered from it in creation order. It is no setting of the field: a read of the table shows none |\n\n<!-- generated:end field-autonumber -->\n\nA refused write and a dry run take no number, so a table\'s numbers run without a gap; a removed row\'s number is not\nissued again.\n\n<!-- generated:start rules-field -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `field.default` | A default names options its select declares \u2014 one on a single select \u2014 and a date stamped by `derive_from` states none. |\n| `field.default-from` | A field\'s `default_from` reads `<link>.<field>` off the row a one-row link of its table names \u2014 a link no copy fills \u2014 or, through further one-row links, `<link>.<link>.<field>` off the row the last names, into a field of the same type, date format and notation that `derive_from` does not stamp: a lookup only through a one-row link, a link only into one to the same table, a select\'s option as this field\'s of the same alias (one it lacks is not copied), several values only into a field holding several. The server copies it on every add that fills the link and leaves the field empty, so a List\'s `create` sure to fill the link \u2014 a required one, or the record it files the row under \u2014 does not ask it by default. |\n| `field.option-mark` | An option\'s `mark` is one the kit draws, and a select\'s options mark every one or none. |\n| `field.unit-select` | A notation\'s `per_row` names a single select of the same row, or a lookup of one through a one-link, whose every option label is a unit, or an ISO 4217 code. |\n| `field.link` | A link targets a table of the call or the workspace: its `pair` a link on that table naming this one back \u2014 and of two paired links at most one reads one row (`multi: false`). |\n| `field.formula` | A formula parses, reads fields of its own table by alias, names an option as `{field:option}` of one a select declares, and compares a select to its options\' keys, never their words. |\n| `field.formula-type` | A formula yields what it states \u2014 its `output_type` (the type the platform stores: a `"datetime"` is never stated `date`), else a figure where it states a `notation` and text where it states `link` \u2014 as the platform infers it from the expression when the field is created. |\n| `field.rollup` | A rollup aggregates, through a link of its table (`via`), a field of the linked table (`field`) by an operation (`op`) that field\'s type takes \u2014 never a figure read in each row\'s own unit or currency \u2014 filtered on fields of the linked table. |\n| `field.lookup` | A lookup reads (`field`), through a link of its table (`via`), a field of the linked table \u2014 a figure read in each row\'s own unit or currency only where this table looks up that row\'s select through the same one-row link \u2014 ordered by a field of it (`order_by`). |\n| `field.computed-cycle` | Computed fields never wait on each other in a loop: each is computed after what it reads. |\n\n<!-- generated:end rules-field -->\n\n## Filters\n\nA table\'s saved views are not part of its document: `set_table_views` writes them and `get_table` lists them. A view\'s\nfilter, a color rule\'s filter, `options_where` and a rollup\'s `filter` share one grammar. Every field reference is a\nfield ALIAS on that table.\n\nA filter is a group \u2014 `{ "node_type": "group", "logic": "and" | "or",\n"children": [ \u2026 ] }` \u2014 or one condition on its own, `{ "node_type":\n"condition", "field_key": "tier", "operator": "has_any_of", "value": ["gold"] }`. A sort is a list of `{ "field_key": \u2026, "order": "asc" |\n"desc" | null }`. A condition states no `type`: its field\'s type decides which `operator` it admits: `has_any_of` / `has_none_of` / `has_all_of` / `is_empty` /\n`is_not_empty` for a select, `equals` / `greater_than` / `less_than` for a\nnumber, `on` / `before` / `after` / `between` for a date, `contains` /\n`is_any_of` for text. A select condition\'s `value` names option ALIASES.\n\n<!-- generated:start rules-color -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `color.fields` | A color rule\'s filters name fields of its table. |\n\n<!-- generated:end rules-color -->\n\n## Groups and templates\n\nA member group and a document template are made on their own, outside a table document and an app tree. A tree names a\ntemplate by its alias. A table document names a group by its id, where a `read_scope` clause (`member_of`),\na stage owner (`group`) or a check\'s `member_of("<id>")` takes one. `get_workspace` kind `group` lists the groups with their ids and members; `set_members` creates,\nchanges or deletes one in its `groups` (an admin\'s verb).\n\n`{{name}}` in an `html` or `email` template is filled from the workflow\'s data. Inline content is refused where it holds a\nscript, a frame, a `<link>`, an inline event handler or a `javascript:` URL; an `html` one may be a fragment, kept as\nwritten and printed as a whole document.\n\nA template\'s markup is the `template` of `set_template`, as one JSON string. A paper shaped like a counterparty\'s \u2014 a letterhead, a reference line, a seal, a signature block \u2014 is an `html` template with a shell around the body; `document_templates` covers the types.\n\n**What an act\'s template is handed** is its record\'s own fields by alias: a\nselect, a member and a link as their words (a link as the linked row\'s title), a\nnumber, a date and a computed value that declares its kind raw (`2800000`,\n`2026-09-14`) and a files field as its file cells (`{id, name, mime, url}`, the photos in the order held; a child row\'s\nfiles likewise) \u2014 never a computed select. On one record it is\nhanded, too, the rows of each child List the record draws, listed under that child\'s\nlink\'s name for `{{#each <link>}}` (and under the child entity\'s alias too): every row filed under the record, oldest first, each\nby its own fields as the record\'s are, less its link back to the record. A List that only reads is listed under its `key`, its rows reached by its link\nor, for a `<link>.<link>` path, by both. Over\nseveral rows the rows are listed under the table\'s alias, for\n`{{#each <alias>}}`, without their child rows.\n\n**Photos in a paper.** A file cell is drawn only if whoever makes the paper may read that file, by the rule the file\nproxy applies; a file they may not read is never drawn. html: `{{#each photos}}<img src="{{url}}">{{/each}}`, each\nphoto inline, only those the data\'s file cells carry (a url typed into a text field stays a link). Word:\n`{{IMAGE picture(cover, 8)}}` for one file cell, and `{{FOR p IN photos}}{{IMAGE picture($p, 8)}}{{END-FOR p}}` for\nmany. Excel: `{{cover | picture:6}}` as the whole cell, and `{{#each photos}}` with `{{this | picture}}` for many, each\nrow growing to its picture. The number is the width in centimetres (8 by default, 6 in Excel); the height follows the\npicture. `picture` takes one image file cell: a list, a file that is no image and a file that cannot be read are\nrefused by name. Photos are embedded at most 1600 pixels across.\n\nHelpers print a raw value in the template\'s `locale` \u2014 `vi` or `en`, the organization\'s language where it states\nnone; each prints `""` for an empty value:\n\n| Helper | Prints (`vi` / `en`) |\n|---|---|\n| `{{money total "USD"}}` | `1.250,50 US$` / `$1,250.50`, in the currency\'s minor units; no code, a number |\n| `{{number qty}}` | `1.234,5` / `1,234.5`: grouped, up to 2 decimals |\n| `{{date issued_on}}` | `14/09/2026`, `14 Sep 2026` in an English template; a date-fns pattern as the second argument, `{{date at "dd/MM/yyyy HH:mm"}}`, literal text quoted (`"\'Ng\xE0y\' dd"`). A moment prints on the workspace\'s timezone |\n| `{{words total "USD"}}` | `M\u1ED9t ngh\xECn hai tr\u0103m n\u0103m m\u01B0\u01A1i \u0111\xF4 la M\u1EF9 n\u0103m m\u01B0\u01A1i xu` / `One thousand two hundred fifty US dollars and fifty cents`; no code, VND (`\u0111\u1ED3ng`) |\n| `{{qr link}}`, `{{code128 position 6}}` | the value as a QR code, or as a Code 128 barcode (ASCII text only), a picture the width of the optional second argument in centimetres, by default sized to the value (a module prints 0.5 mm in a QR code, 0.33 mm in a barcode); a width too narrow to scan is refused, naming the least that does; not in an email template |\n| `{{date (add_days issued_on -1)}}` | `13/09/2026`: the date shifted by whole days (`-1`: the day before), for `date` to print; a number field as the days, empty shifting none |\n\nA value it cannot read (`{{money "abc"}}`, `{{date "14/09/2026"}}`) fails the render. A field named like a\nhelper and written alone (`{{number}}`) prints its own value.\n\nA field printed as a code in the other types: Excel `{{position | qr}}` or `{{position | code128:6}}` as the whole\ncell and the last helper \u2014 the picture is anchored on the cell and its row grows to hold it; Word `{{IMAGE qr(position)}}` or `{{IMAGE code128(position, 6)}}`. An empty field draws no picture.\n\n## Rows\n\n`rows` of a `set_tables` call are the first records of the tables the call creates, keyed by each one\'s `ref`;\na patch of an existing table seeds none, so write its rows into the table. A sample, not a data set: rows past it go in with `create_records` once the tables exist, in the batches its description bounds.\n\n```jsonc\n"rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } }\n ]\n}\n```\n\n`rows` sits beside `tables` in the call, not inside a table.\n\n<!-- generated:start rows -->\n\n#### Row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | text, required | Local handle for this row, referenced by other rows\' link fields |\n| `fields` | map of text \u2192 any value, required | Field alias \u2192 the value, read against the field\'s declared type |\n\n<!-- generated:end rows -->\n\n<!-- generated:start rules-rows -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `rows.ref` | A row\'s `ref` is unique within its table. |\n| `rows.required` | A row states every field its table requires: it is created with what it states, its fields\' defaults and copies unapplied. |\n| `rows.value` | A row\'s value fits its field: an option alias for a select, `"<table ref>:<row ref>"` of a row of the linked table in this call or a stored record\'s id for a link, `"self"` for a member, a `fil_` id for files, a date in the date grammar (an hour only on a datetime), a text, number, yes/no or null otherwise \u2014 and none on a computed field. |\n\n<!-- generated:end rules-rows -->\n\nA `ref` is lowercase letters, digits and underscores, and is never persisted.\n\n`fields` is keyed by field alias, and every value is read against the field\'s\nDECLARED type:\n\n| Field type | Value |\n|---|---|\n| `text` / `number` / `boolean` | the value itself |\n| `date` | `"2026-03-14"`, or a relative expression (below) |\n| `select` | the option ALIAS \u2014 `"gold"`, or `["gold","vip"]` for a multi-select |\n| `link` | `"<table ref>:<row ref>"` naming another row of this call \u2014 `"customer:acme"` \u2014 or the id of a record the linked table already holds, or an array for several; a paired link is stated on ONE side (the child\'s link to its parent) and its partner fills itself |\n| `member` | `"self"` only \u2014 the member making the call |\n| `files` | the `fil_` id of a file already in this workspace, or a list of them |\n| `formula`, `rollup`, `lookup`, `autonumber` | not allowed \u2014 the platform writes these |\n\n### Relative dates\n\nA date cell holds a literal `YYYY-MM-DD`, or an expression relative to the day\nthe call is made, so a screen that opens on "this month" is not empty a month\nlater:\n\n- `@today` \u2014 the day of the run, in the workspace\'s timezone\n- `@month-start` \u2014 the 1st of that month\n- either with a whole-day offset: `@today-14`, `@month-start+9`\n- on a date that holds its hour (`format: "datetime"`), that hour after the day, and always stated:\n `@today 14:30`, `@today+1 06:00`\n\n`@month-start` exists because `@today-N` cannot promise a month: applied on the\n2nd, `@today-3` lands in the previous one.\n\n## Records\n\n`records` says how a row of a table is RECOGNISED \u2014 stated once in the table\'s document, beside its\n`title` \u2014 and every surface that draws one of its rows reads the same\nstatement: the register\'s row, a picker\'s option, a link\'s chip, a child table\'s\nrow and the record\'s header. Every table an app lists, opens or picks has one. The rarer keys \u2014 `scan`, `cadence`, `place`, `on_site`, `pin`, `plan_place` and `size` \u2014 are stated on `reference/record-places-pins-and-cadence`.\n\n```jsonc\n// table "visit"\n"title": "container_no",\n"records": {\n "subtitle": ["customer", "arrived_on"],\n "image": "photos",\n "status": { "field": "stage", "closed": ["gone"], "history": "visit_history" },\n "figure": "total_fees",\n "due": ["free_until"]\n}\n```\n\n```jsonc\n// table "release": a release order read against what it allows \u2014 a meter wherever it shows\n"title": "release_no",\n"records": { "figure": "issued", "limits": { "issued": "units" } }\n```\n\n```jsonc\n// table "dossier": a straight-line process \u2014 the stage a select, each step\'s day the date it stamps\n"title": "applicant",\n"records": { "status": { "field": "stage", "closed": ["signed"], "dates": { "received": "received_on", "appraised": "appraised_on", "signed": "signed_on" } } }\n```\n\n<!-- generated:start records -->\n\n#### Record\n\n| Key | Type | Meaning |\n|---|---|---|\n| `subtitle` | list of alias (1\u20132) | Up to two fields read under the title wherever a row is drawn (a code, a date, a party): one line at a desk, wrapping to a second on a phone |\n| `image` | alias | A files field that pictures the row \u2014 never one an act keeps the document it makes in. Absent, a table with exactly one files field is pictured by the first image in it \u2014 never a paper or other file \u2014 unless the entry states a `mark` or puts that field in the title or subtitle; an app turns it off with `row.image: false`. |\n| `mark` | alias | A single select (or a lookup of one through a one-row link), or a formula that states its options, whose option leads the row wherever a mark leads it \u2014 a list\'s row, the record\'s head, a link naming the row: the option\'s brand or glyph, else its colour dot, on a tile. The field stays a field: a subtitle run, a column, a section\'s control. Never beside `image` or `party`, and never the status field |\n| `description` | alias | A text field saying what the row is about \u2014 a plan\'s brief, a customer\'s note: read in its record\'s head under the title\'s line, its first lines at rest and whole on a press, and written from the head\'s \u270E. Never on a row\'s line |\n| `party` | `"person"` \\| `"organization"` \\| `"organisation"` | What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier); absent, the rows are things (an order, an item, a paper) |\n| `status` | [Status](#status) | The stage a row moves through, a single select, drawn in the record\'s head, or its Side where the Side states it |\n| `figure` | alias | The one number the row stands for, read at its right (a total, a quantity left) |\n| `limits` | map of alias \u2192 (alias \\| number) | A number read against a bound \u2014 a field of the same row or a constant \u2014 drawn as a meter wherever it shows |\n| `gates` | map of alias \u2192 (alias \\| number) | A pass mark on a meter `limits` bounds \u2014 a field of the same row or a constant; a percent field is its share of the bound, any other number an amount. The meter marks it and fills complete once past it |\n| `tolerance` | map of alias \u2192 number | How far past its `limits` bound a meter may stand, in percent of the bound: the bound is an amount expected (received against ordered), not a cap. Without one the bound is a cap, and past it is an overrun |\n| `due` | list of alias (at least one) | Dates that are deadlines (stored, or computed as a date): each counts down and turns overdue until the row is at a `closed` option or `settled` holds, whatever stage it has moved to. A deadline is never an appointment date or the day a stage starts |\n| `frees` | alias | A date ending the row\'s span of days on which what the row holds is free again (a check-out, a hire\'s return): a stay from the 3rd to the 5th holds the 3rd and the 4th, and another may start on the 5th \u2014 on a lanes board, a calendar, a roster and in `no_overlap` alike. Absent, a span of days holds its last day; a span of moments always frees its end |\n| `settled` | alias | A yes/no of the row (stored, a formula: an invoice paid in full, or looked up through a one-row link: a line settled with its parent) that ends its deadlines: while it is true, no `due` of the row counts down or turns overdue \u2014 in a cell, on its line, in its head, on a calendar or gantt, or in the overdue count. A Sheet\'s or reading\'s `where` reads it as any other yes/no |\n| `task` | `true` | A row is work someone finishes: wherever rows of it stand in a table \u2014 a register, a record\'s rows, the rows filed under one \u2014 each is led by a ring ticking it done and unticking it by the one write of the app making that move. Its status is a stored select with `closed` |\n| `applies` | map of alias \u2192 map of alias \u2192 (list of alias (at least one) \\| boolean) | Fields that apply only while their conditions hold (a length only on a line whose tariff charges by the metre): where one does not apply no add asks it and no surface shows it. Never the title; a required one starts at its `default` |\n| `starts` | map of alias \u2192 `"today"` \\| `"me"` | What a field of a row being added starts at, where that start is certain: `today` a date (a moment starts now), `me` a member, the reader adding it; every other field starts empty unless the reader narrowed the register to a value or the field declares a `default` |\n\n<!-- generated:end records -->\n\n<!-- generated:start rules-records -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.title` | A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title\'s own field. |\n| `records.image` | `image` is a files field, never one an Act keeps the documents it makes in (`into`). |\n| `records.mark` | `mark` is a single select or a lookup of one through a one-row link, or a formula that states its options, never the status field, nor on the folder an App works inside (`scope`), which its switcher names by a picture or its initials. |\n| `records.description` | `description` is a text field, read in the record\'s head \u2014 never a Field of a part too. |\n| `records.figure` | A figure is a number. |\n| `records.applies` | `applies` holds a field of the row other than its title to conditions of the same row \u2014 a yes/no (stored or a formula) by `true` or `false`, a single select by its options, its own or looked up through a one-row link \u2014 never to itself; a required field it holds starts at a `default`. |\n| `records.limits` | `limits` bounds a number by a number field of the row, in its unit or one of the same dimension \u2014 or by a constant, where every row reads the figure in one unit. |\n| `records.gates` | `gates` marks a pass on a meter `limits` bounds: a percent field (its share of the bound), another number in the bound\'s unit, or a constant. |\n| `records.tolerance` | `tolerance` stands on a meter `limits` bounds. |\n| `records.starts` | `starts` starts a field a person writes \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 and a `create` that does not ask a field it starts writes that start. |\n| `records.due` | A deadline (`due`) is a date. |\n| `records.frees` | `frees` names a stored day, never a moment: a span of moments already frees its end. |\n| `records.settled` | `settled` names a yes/no of the row (stored, a formula, or looked up through a one-row link) beside a `due`: while it holds, the row\'s deadlines neither count down nor turn overdue. |\n| `records.task` | A task entity (`task`) states a `status` of a stored single select with `closed` options \u2014 its ring ticks a row done by moving it to one. |\n| `records.picture` | *Noted by the designer on a write, never refused:* Rows an App draws that each hold one files field no Act makes documents into, no call is filed into, no files gallery keeps and no List compares as a pair (`compare`) \u2014 and no figure \u2014 are pictured by it (`image`); where the workspace\'s files are known, the field holding images is the picture, a figure or not. |\n| `records.mark-lead` | *Noted by the designer on a write, never refused:* Rows an App draws of an entity that states a computed category (a formula stating `options`) or a single select besides its status whose options state a mark, and states no `mark`, `image` or `party`, can lead with that field\'s option as their mark (`records.mark`). |\n| `records.stage-holder` | *Noted, never refused:* A stage owned by a member field of the row itself, where the table does not require that field and no `create` or Act of the App states it (asks, sets, requires or writes it), lets a row reach the stage with the field empty: require the field, or state it in a `create` or an Act. |\n\n<!-- generated:end rules-records -->\n\n- **The title names the row** by who or what it is \u2014 a link by the linked row (a job\n read by its customer). Any field but a button or a yes/no may title it, yet a code\n titles a row only where people name the row by it, else it is a `subtitle`; it is the table\'s own setting, which every link shows.\n- **One lead per row.** A row leads with its picture (`image`), a face (`party`) or the\n option of a single select it holds (`mark`) \u2014 never two. A `mark` draws that option\n on a tile: its brand or glyph, else its colour dot; a row holding none, a ring saying\n none is picked. The same tile heads the row\'s record and leads it where a link\n names it; the select stays a field \u2014 a subtitle run, a column, a section\'s control.\n- **A limit** reads a number against a bound \u2014 another field of the row, or a constant.\n A `gates` entry marks a pass on that meter: a percent field is its share of the\n bound, any other number an amount.\n- **A deadline** (`due`) counts down wherever it is drawn and is overdue once past while\n the work is open. A register over the table says how many rows in view are overdue on\n its summary line, and pressing that count narrows to them \u2014 no reading to state.\n- **A span\'s free day** (`frees`) is the end date on which what the row held is free\n again \u2014 a check-out, a hire\'s return. A stay from the 3rd to the 5th holds two nights:\n a lanes board, a calendar and a roster draw it through the 4th, and `no_overlap` lets\n the next stay start on the 5th. Without it a span of days holds its last day; a span of\n moments always ends as the next may begin.\n- **`starts`** is where an add\'s field begins, stated only where that is certain \u2014 a\n log\'s own day at `today`, a request\'s requester at `me`. Nothing else starts a field\n but its declared `default` and what the reader narrowed the register to.\n\n## Record places, pins and cadence\n\nThe rarer keys of `records`, stated beside the ones on `reference/records`: a title read off a photo (`scan`), the rows a child owes each day (`cadence`), where a row stands on a map (`place`, `on_site`) or on a picture (`pin`, `plan_place`).\n\n```jsonc\n// table "site": it owes a diary page each day it works, from breaking ground through handover\n"title": "name",\n"records": { "cadence": [{ "entity": "diary_page", "on": ["mon", "tue", "wed", "thu", "fri", "sat"], "from": "started", "until": "handed_over" }] }\n```\n\n<!-- generated:start records-places -->\n\n#### Record places\n\n| Key | Type | Meaning |\n|---|---|---|\n| `cadence` | list of [Cadence](#cadence) (at least one) | The rows of a child each row owes one of a day, on the days of the week listed (a site\'s diary page, Monday to Saturday) \u2014 one entry a child, never owed on a day still to come. A roster of these rows over days marks a past day owed with none missing in the danger tone, counted in the legend; today\'s is due, offered to add and never marked; each row\'s total reads the days it holds of those owed |\n| `scan` | `"text"` \\| `"iso6346"` \\| `"code"` | Its title, a text field, is painted or printed on the thing a row is (a container\'s number, a seal\'s) and read off one photo on a phone, beside each search matching it and each field holding or picking it: `iso6346` a container number, refused unless its check digit holds; `text` as it stands; `code` a barcode or QR code on the thing, decoded on the device from the photo with no agent |\n| `place` | [Place](#place) | Where a row stands, as plain fields of it, drawn as one place where its record draws the address: how sure it is, a press opening it in the device\'s maps, and one taking it from where the device stands |\n| `plan_place` | [Plan place](#plan-place) | Each row is a place on the plan a `plan` register draws: its title the place\'s code, its subtitle a note. A flat list, no tree |\n| `on_site` | [On site](#on-site) | Photos taken where a place stands (a site diary\'s): a photo taken through a phone\'s camera here keeps where the device stood, marked at the place, away from it or unknown, and a record holding one taken away says so among its checks \u2014 one with no place (picked on a computer, or kept before places were) is marked and warns nothing; a place reaches only members of the organization, through the apps drawing these photos |\n| `pin` | [Pin](#pin) | Each row is a place on a picture (a snag on a flat\'s plan, a spot on a container\'s drawing): a List of these rows draws the picture its `on` row holds with a numbered pin at each row\'s own place, each row led by its number, the row opened lit on it and a pin pressed opening its row; where the List writes rows, a press on the bare picture adds one there, and a pin dragged moves its row. A List of rows that link to these by a single link draws their places the same way |\n| `size` | [Record size](#record-size) | The real size of the thing a row is (a carton, a piece of furniture, a pallet): three number fields stating one length unit alike, read as one fact \u2014 "400 \xD7 300 \xD7 250 mm", a part the row lacks "\u2014" \u2014 after the subtitle wherever the row\'s line and head draw facts, never also as the subtitle\'s fields. A plan register drawing these rows draws each box at this size |\n\n#### Cadence\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | text, required | The table owed: each of its rows stands on one row of this table by its single link to it, and on the first date of its line (`records` title or subtitle) |\n| `on` | list of `"mon"` \\| `"tue"` \\| `"wed"` \\| `"thu"` \\| `"fri"` \\| `"sat"` \\| `"sun"` (at least one), required | The days of the week one is owed on, each listed \u2014 `mon` to `sun` |\n| `from` | alias | A date of this row: the first day one is owed (a site breaking ground, a contract\'s start); absent, no first day |\n| `until` | alias | A date of this row: the last day one is owed (a site\'s handover, a contract\'s end); empty or absent, through today |\n\n#### Place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `address` | alias, required | A text field: the address, as people write it |\n| `latitude` | alias, required | A number field: degrees north, negative south |\n| `longitude` | alias, required | A number field: degrees east, negative west |\n| `accuracy` | alias | A number field: how many metres off the device that gave the place said it may be |\n\n#### On site\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photos` | list of alias (at least one), required | Files fields of this row holding photos taken on site |\n| `place` | alias | A single link of this row to the row whose `place` its photos are taken at (a diary page\'s site); absent, this row\'s own `place` |\n| `radius` | number, required | How many metres from the place a photo still counts as taken there |\n\n#### Pin\n\n| Key | Type | Meaning |\n|---|---|---|\n| `on` | alias, required | A single link of this row to the row whose picture (its `records` `image`) the place is on \u2014 a container\'s drawing, a floor\'s plan |\n| `x` | alias, required | A number field of this row: how far across that picture the place stands, in percent from its left edge |\n| `y` | alias, required | A number field of this row: how far down that picture the place stands, in percent from its top edge |\n\n#### Record size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of the thing a row is, across |\n| `along` | alias, required | A number field: its depth, along |\n| `up` | alias, required | A number field: its height, up |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.scan` | A title read off a photo or a code (`scan`) is a text field the row stores. |\n| `records.cadence` | A `cadence` names each child once \u2014 its rows standing on one row of this entity by their single link and on the first date of their line \u2014 lists each day of the week once, and `from` and `until` are two different days of this entity. |\n| `records.place` | A `place` names four different fields of the row: its address a text field, its latitude, longitude and accuracy number fields it stores. |\n| `records.plan_place` | A `plan_place` names `kind` and `reach_from` as single selects, `sheet` as a single select or a one-row link, `stacked` as a boolean and the rest as numbers, each a different field; `kind`, `x`, `y` required. `size` names three numbers (`across`, `along`, `up`) stating one cell in one length `unit` alike. A `sheet` linking to an entity that states an `image` draws that drawing under the places, `scale` (a number field of that entity) its width in cells; `scale` goes with such a `sheet` alone. |\n| `records.on_site` | `on_site` lists files fields of the row, each once, taken at the `place` of the row itself or of the one row a single link of it names (`place`), which states one. |\n| `records.pin` | A `pin` names a single link of the row (`on`) to an entity whose `records` states its `image` (a PDF is drawn as its first page), and two different number fields of the row, how far across (`x`) and down (`y`) that picture in percent. A List of rows whose own entity states a `pin` is drawn over that picture; `on`, `x` and `y` are set by the press that adds a row, never asked. |\n| `records.size` | A `size` names three different number fields of the row (`across`, `along`, `up`) stating one length unit alike (mm, cm, m or km); they read as one fact after the subtitle, so the subtitle never also names one. |\n\n<!-- generated:end records-places -->\n\n## Status\n\nA record\'s `status` is the stage a row moves through \u2014 a stored single select, each\noption\'s moment the date `dates` names. A record draws it as its dot and word where Act buttons on the page offer its moves, and as a control for the moves no drawn Act offers: choosing one runs its Act, asking and refusing as its button does.\n\n<!-- generated:start status -->\n\n#### Status\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The single select that is the row\'s state, its options in the order the work goes through them, read as steps by itself on a record whose parts state no `at` |\n| `closed` | list of alias (at least one) | Options that end the work: a register opens on the rows not at them, and the badge reads muted |\n| `dropped` | list of alias (at least one) | Options of `closed` that leave the work undone (cancelled, rejected): whoever holds the row moves it to one from any stage, where every other move forward passes each owned stage between that binds the row (its `when`) and needs each one\'s owner, and a row leaving one enters a stage as a row made there does |\n| `history` | text | A table every write that sets or moves the status appends one row to (its link to this table, the new status, the moment and who) \u2014 by the record write path, whoever writes: for reporting on every move |\n| `dates` | map of alias \u2192 alias | Option alias \u2192 a date field of this entity the record write path stamps with the moment a row moves into that option, or is made at it \u2014 whoever writes. A value the same write states for that field wins, so past data loads as it happened \u2014 and the `history` records the move at that day, a row made at a later option recording each earlier one whose date the write states, in order; the platform never clears a stamp, so each is when the row last entered the option. A stage\'s date is made where none is named |\n| `stages` | map of alias \u2192 [Stage](#stage) | Option alias \u2192 who owns that stage and how long it should take: the owner alone takes a row out of it, by any write, and presses the acts offered there; every move forward past it of a row it binds (its `when`), and every such row made past it, is its owner\'s too. Its days run from the moment its `dates` field holds. In an app the status then moves only by acts that `set` one of its options \u2014 no save writes it and no act asks it |\n\n#### Stage\n\n| Key | Type | Meaning |\n|---|---|---|\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }`, required | Who owns the stage: a member field of the row, `link.field` read through a one-row link (not at the stage a row opens at, whose owner made the row: a member field of the row itself), or `{ group }`. A member moves a row off only one stage that groups own, one at a time: the next waits on a different member, or on a stage stating no owner; a row made past a stage signs nothing there |\n| `within` | integer | Whole days the stage should take from the moment the row entered it |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| [comparison](#values) \\| `{ "empty": true \\| false }`) | The rows that must pass this stage: a row meeting every entry on its own fields, as it stood before a write or as the write leaves it \u2014 a single select holding one of these options, a yes/no this value, a number or date meeting its bounds, a field empty or filled. Absent, every row must. A row at the stage leaves it by its owner either way |\n\n#### Stage group\n\n| Key | Type | Meaning |\n|---|---|---|\n| `group` | text, required | A group of the workspace, by id: its members press the act. One person moves a row off only one of the stages different groups own |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.status` | A status is one single select, its options in the order the work goes through them, `closed` naming the ones that end it and `dropped` those of them reached from any stage. |\n| `records.history` | A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member. |\n| `records.stages` | A stage\'s owner (`status.stages`) is a single member field of the row, one read through a one-row link (never at the stage a row opens at: its owner made the row, so it is a member field of the row itself), or a group, on an option that does not end the work; a group\'s stage needs the status `history` with who moved the row. Every write takes a row off a stage as its owner alone, and moves a row past it or makes a row past it as its owner alone where the stage binds the row (its `when`) \u2014 a move to a `dropped` option excepted, which whoever holds the row makes from any stage; a row leaving a dropped option, or holding none, enters a stage as one made there. Each stage\'s moment, and each open option\'s, is the date its `dates` names, made where none is named, which every write that opens or moves the status stamps; `within` runs from it. In an App a status with stages moves only by Acts that `set` one of its options \u2014 no save writes it or a date it stamps, and no Act asks either, sets it otherwise or writes either from a workflow; an Act moving a row forward past a stage another owner owns, into an option not `dropped`, keeps its `when` off every row that stage binds. |\n| `records.stage-when` | A stage\'s `when` names the rows that must pass it, as an Act\'s `when` holds them \u2014 single selects to their options, yes/nos to `true` or `false`, numbers and dates to bounds, any field to `{ "empty": true \\| false }` \u2014 on fields a write stores of the row itself: never the status, a formula, a lookup or a rollup, and never on the stage a row opens at. It binds a row meeting it as it stood before a write or as the write leaves it; absent, it binds every row. |\n| `records.detour-note` | *Noted, never refused:* A stage the work only steps aside into \u2014 not where a row starts, entered from one step alone that also moves the work on without it, and left by its own moves only back to that step (a pause, a repair) \u2014 is a detour: its option and the Section whose `at` holds it stand before that step\'s, else the work reads it as its next step, and the Act moving the work into it leads that Section \u2014 never a correction waiting in a \u22EF. |\n\n<!-- generated:end status -->\n\n- **The status** is one single select. `closed` options end the work: a register opens\n on the rows not in them, a row holding no status among them. A `history` table gets one row per move \u2014 its link to this\n table, the new status (a select holding the same option aliases, or text), the\n moment (the stage\'s `dates` value where the write states a past one, so loaded rows keep\n the day they reached it) and who \u2014 appended by the record write path in every write that opens a row at a\n stage or moves it, whoever writes (the member behind the write is its `by`; an automation\n leaves it empty). A `history` the tables do not declare is derived, and needs no\n `records` of its own.\n- **When each step happened** is the date `dates` names for its option, stamped as the row\n enters it, whoever moves it. One way times a status: a straight-line process is a select\n whose options are its steps in order, each with its date \u2014 never a run of dates the stage\n is read off. An Act that moves the stage and `asks` the step\'s date with `starts: "today"`\n lets the reader record a day already past in the same press.\n\n## Write rules\n\nWhat a WRITE of a table\'s rows meets is stated in the table\'s document, where it applies: `min` and\n`max` on a number or date field, `options_where` and `same` on a link, `suggest` on a text field,\nand `no_overlap` and `natural_key` on the table. A key a field\'s type does not take is refused at\nits path, and a document has no `write_rules` key.\nEvery one but `natural_key` and `suggest` holds on every path a record is written by \u2014 the grid, a record\'s form, an import, a workflow, an\nagent, the API, an app \u2014 judged in the write\'s own transaction, every broken rule listed at once; the\nscreen and a picker only mirror them. A row that already breaks one stays editable until a write\ntouches what the rule reads. `natural_key` names the fields an app recognises a row by, to reuse it where an\nadd or a find-or-create meets it; a record tool or the API creates the row it is handed. `suggest` offers\nvalues in a text control and refuses none. An `options_where` link is refused where a write names a row the\nnarrowing does not admit, and every picker of the link offers only the rows it admits.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customer",\n "fields": { "email": { "type": "text", "label": "Email", "unique": true } },\n "natural_key": ["email"]\n }\n ]\n}\n```\n\nA customer above is RECOGNISED by their address. An add that names one \u2014 from the customers\nregister or from a picker\'s "new" \u2014 reuses the row it matches and opens one only where nothing does,\nso the book never grows a second Acme.\n\n```json\n{\n "tables": [\n { "ref": "product", "label": "Product", "fields": { "name": { "type": "text", "label": "Name" }, "in_stock": { "type": "number", "label": "In stock" } } },\n {\n "ref": "order",\n "label": "Order",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "placed_on": { "type": "date", "label": "Placed on" },\n "due_on": { "type": "date", "label": "Due on" },\n "lines": { "type": "link", "label": "Lines", "table": "order_line", "multi": true, "pair": "order" }\n }\n },\n {\n "ref": "order_line",\n "label": "Order line",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "order": { "type": "link", "label": "Order", "table": "order", "multi": false, "pair": "lines" },\n "quantity": { "type": "number", "label": "Quantity", "min": 1, "max": 9999 },\n "ships_on": { "type": "date", "label": "Ships on", "min": "order.placed_on", "max": "order.due_on" },\n "product": {\n "type": "link",\n "label": "Product",\n "table": "product",\n "multi": false,\n "options_where": {\n "node_type": "group",\n "logic": "and",\n "children": [{ "node_type": "condition", "type": "number", "field_key": "in_stock", "operator": "greater_than", "value": 0 }]\n }\n }\n }\n }\n ]\n}\n```\n\nA line of nothing is not a line: `quantity` is refused on create and on update. A line ships inside\nits order\'s window \u2014 a bound read off the row a link names is judged when the line is written. Nothing is sold off an empty shelf: every picker of `product`\nreads only the rows that answer its `options_where`, and every save refuses the same rows again.\n\n```json\n{\n "tables": [\n {\n "ref": "booking",\n "label": "Booking",\n "fields": {\n "room": { "type": "text", "label": "Room" },\n "state": { "type": "select", "label": "State", "options": [{ "alias": "held", "label": "Held", "color": "blue" }, { "alias": "released", "label": "Released", "color": "gray" }] },\n "starts_on": { "type": "date", "label": "Starts on" },\n "ends_on": { "type": "date", "label": "Ends on", "min": "starts_on" }\n },\n "no_overlap": { "from": "starts_on", "to": "ends_on", "by": ["room"], "while": { "state": ["held"] } }\n }\n ]\n}\n```\n\nOne booking per room at a time, while it is held \u2014 a create or a save whose span overlaps another\nheld booking of the same room is refused.\n\nA table\'s `checks` (the conditions no write of its rows may meet) are stated in its document and hold on every path a record is written by; their keys, what they read and an example are on `workflows/table-checks`. What follows every committed write of its rows is a workflow, written with `set_workflow` (`workflows/table-workflows`).\n\n<!-- generated:start write-rules -->\n\n#### Suggest\n\n| Key | Type | Meaning |\n|---|---|---|\n| `table` | text, required | The table whose text field is offered from: its id, or its `ref` in this call |\n| `field` | alias, required | The alias of that table\'s stored text field; the field\'s control offers, as the reader types, the distinct values it holds, and any text is still written |\n\n#### No overlap\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | text, required | The stored date (or datetime) a row\'s span starts on: `<field alias>` of the row, or `<link alias>.<field alias>` of the one row a one-row link names (a booking line\'s piece held for its booking\'s dates) |\n| `to` | text, required | The stored date (or datetime) a row\'s span ends on, named like `from` and through the same link \u2014 a day it holds, unless `records` names it the day the row `frees`; a moment another row may start at |\n| `by` | list of alias (at least one) | Fields two rows share to compete for a span (the same employee, the same room); absent, every row |\n| `while` | map of text \u2192 list of alias (at least one) | Only rows at these options of these selects hold their span (running, not closed), the select named like `from` \u2014 `<field alias>` or `<link alias>.<field alias>`; absent, every row |\n\n<!-- generated:end write-rules -->\n\n<!-- generated:start rules-write -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `write.natural-key` | A `natural_key` is text or a number a person types back, or a one-row link; a text key is unique \u2014 `unique: true`, or the key\'s fields as a set in the table\'s `unique`. |\n| `write.bounds` | `min` and `max` bound a number or a date \u2014 by a constant a number, by a field of this row or of the one row a one-row link names either, of the same type and unit, never by itself \u2014 and `min` is never above `max`. |\n| `write.bound-per-row-unit` | On a figure whose unit or currency is the row\'s own (its notation\'s `per_row`) a constant bound is only 0 \u2014 bound it by a field of the row. |\n| `write.suggest` | `suggest` stands on a stored text field and names a `table` and a `field`, a stored text field of that table; the app reads that table, so it has a `records` entry. |\n| `write.same` | `same` stands on a link and names one-row links, or lookups of one, this table and the link\'s target both hold to one table. |\n| `write.options-where` | `options_where` narrows a link by an `"and"` group of plain conditions over the target\'s own fields \u2014 a number compared in one unit on every row, a select by options it declares. |\n| `write.no-overlap` | `no_overlap` spans two date fields, the row\'s own or the one row a one-row link names (`booking.start_on`); `by` names values rows share \u2014 a link, a person, one option, a text or a number; `while` names single selects by their options, the row\'s own or that linked row\'s. |\n\n<!-- generated:end rules-write -->\n\n- A `natural_key` is `text` or `number`, because a person types it back, or a\n one-row link, because a row is also recognised by the one row it belongs with (a\n fee by its visit and its kind). A key holding a `text` field is unique: `unique:\n true` on that field, or the key\'s fields as a set in the table\'s `unique` (a\n site by its customer and its name) \u2014 two rows sharing it would make\n find-or-create pick whichever the read answered first. An add asks the key by\n default.\n- A `same` link names only rows that name what this row names \u2014 a fee\'s invoice\n is one of its own visit\'s \u2014 through a one-row link both tables hold to one\n table; its picker offers nothing until the row names one. A row added under a\n record names what it copies off it (`default_from`) from the start, so a block\n expecting one line per row of the link lists that record\'s rows alone. A save\n of this row moving what the two compare is refused while they would name apart.\n- An `options_where` link may be left empty; a row it names is refused on every\n save that writes the link unless it holds the narrowing, and the refusal names\n the link and the row. A save that leaves the link alone is not judged, so a row\n still naming a row the narrowing no longer admits stays editable. A link naming\n one kind of a book\'s rows (a "Shipping line" among the parties) narrows to that\n kind, or its picker offers every row.\n\nA field\'s own `required` is not here: the field carries it, and every write\npath refuses the row by field name from it. `unique` is the text field\'s own\nclause (\xA7 `text`) \u2014 an add says so at the control before the column does. A\nfield the workspace writes (a formula, a rollup, a lookup, an autonumber, a date\nwith `derive_from`) is never asked, written or edited.\n\n## App tree\n\nAn app is a tree of components, assembled the way a page is written in JSX: pick a component, bind it to a table by\nname, and it draws well with no props, because its defaults come from the table\'s facts (\xA7 Records, \xA7 Status,\n\xA7 Write rules, \xA7 Field). A prop overrides a default at its own node. No prop says how anything looks: the runtime\ndraws each concept one way, and a screen the job needs that no component states is told to the person \u2014 the job,\nwhat the app drew, the word wanted \u2014 never props bent to approximate it.\n\n**The smallest tree is one root List.** `{ "type": "App", "key": "orders", "name": "Orders", "children": [{ "type": "List", "entity": "order" }] }`\nis a whole app: the platform draws the rest from the tables \u2014 the page every row opens, a Section per stage with its moves\nat the foot, a child List per child, the band of readings, the add and the Delete. Every answer of `set_app` and `get_app`\nshows what it drew (`(default)` among the addresses) and says what it placed or folded in what you stated, so you state only\nthe difference. Lists at the root stand beside one another, two over one entity opening its one page.\n\nEach component is a page of its own: `reference/app-node`, `reference/list-node`, `reference/list-source`, `reference/record-node`, `reference/section-node`,\n`reference/side-node`, `reference/outside-node`, `reference/tab-node`, `reference/sheet-node`, `reference/field-node`, `reference/fieldset-node`, `reference/act-node`, `reference/check-node`,\n`reference/reading-node`, `reference/statement-node`, `reference/export-node`,\n`reference/query-node` and `reference/workflow-node`. Beside them: `reference/changing-an-app` and `reference/what-an-app-may-write`, `reference/layouts`, `reference/time-and-place-layouts` and\n`reference/publish-desk` for a List\'s `layout`, `reference/tasks`, and the rules, `reference/app-rules`,\n`reference/reading-rules`, `reference/statement-rules`, `reference/check-rules`, `reference/list-rules`, `reference/record-rules`, `reference/act-rules` and `reference/template-rules`.\n\n<!-- generated:start app-components -->\n\n| Component | Draws | Holds |\n|---|---|---|\n| [App](#app-node) | the launcher tile, the app\'s words, its Views (Lists and Sheets), and its API | List, Sheet, Query, Workflow, Record |\n| [List](#list-node) | rows of an entity: the register, a record\'s child rows, a roster\'s cells, related rows | Tab, Reading, Export, Act, List |\n| [Record](#record-node) | what a row opens: the head and the parts | Field, Fieldset, Section, Side, Outside, List, Reading, Statement, Act, Check |\n| [Section](#section-node) | a titled part of a record, and optionally a step of its path | Field, Fieldset, List, Reading, Statement, Act |\n| [Side](#side-node) | the part the rest is worked from, beside them | Field, Fieldset, List, Reading, Statement, Act |\n| [Outside](#outside-node) | what one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it | Field, List, Act |\n| [Tab](#tab-node) | one view of a List\'s rows over a period | \u2014 |\n| [Sheet](#sheet-node) | a grid of Readings and Lists over the App\'s rows in its period | Reading, List |\n| [Field](#field-node) | one field: a control, a gallery, prose, a link and its picker, the rows filed under a back-link | \u2014 |\n| [Fieldset](#fieldset-node) | fields of a part read together under a heading of their own | Field |\n| [Act](#act-node) | a verb: what pressing it does | \u2014 |\n| [Check](#check-node) | a formula of the rows that warns, or refuses the writes and acts it names | \u2014 |\n| [Reading](#reading-node) | a number over rows: one figure, its parts, a grid, per period, steps; or a record\'s own figure; with `planned` and `done`, the work against its plan, day by day | \u2014 |\n| [Statement](#statement-node) | a figure built from figures of the record | \u2014 |\n| [Export](#export-node) | a report file of the rows in view | \u2014 |\n| [Query](#query-node) | nothing: a read for agents | \u2014 |\n| [Workflow](#workflow-node) | nothing: a verb for agents | \u2014 |\n\n<!-- generated:end app-components -->\n\n### A node\n\nA node is `{ "type": <Component>, "key"?, ...props, "children"?: [...] }`. `type` names the component, `key` its\nname among its siblings, the other keys its props, `children` the nodes it holds. An unknown prop is refused.\n\n- **Two shorthands, both for Field.** A bare string child is a Field (`"due_date"`); an object with `field` and no\n `type` is a Field with props (`{ "field": "price", "edit": false }`). Both work in every prop that lists fields:\n `create`, a Record\'s `row.subtitle` and `add`, and the `children` of a Record or a part. A column is a field\'s alias, or\n `{ "field", "edit": true }` for the line\'s own control, and takes no other prop.\n- **Fields and options are named by alias**, never by label. A tagged value is an object, never a magic string.\n- **`false` turns a default off at its node:** `"edit": false` makes a field read-only, `"create": false` and\n `"remove": false` take a List\'s add and Delete away, `"readings": false` its band; on a Record, `"row": { "figure": false }`\n drops the row\'s figure, `"row": { "status": { "edit": false } }` the status buttons (another app moves the stage) and\n `"row": { "image": false }` the picture.\n\n### Keys and addresses\n\nA key is unique among its siblings, the way a React key is. A node that binds data takes its key from what it binds:\n\n| Node | Key when none is stated |\n|---|---|\n| Field, Check | its field alias |\n| List | its entity alias |\n| Record | its `entity` alias |\n\nEvery other node states its key. Three kinds of key are unique across the whole app, because each is an API name:\nan Act\'s (its workflow is `act_<key>`, or the one it names), a Reading\'s (its query name for `run_app_query`), and a Query\'s or\nWorkflow\'s.\n\nA node\'s **address** is the path of keys from the app, such as `pages/customer/orders`; the app itself is `/` (the `in` of a node at the root), and its own key is part of no address. A patch may use any ending\nof that path that names exactly one node (`orders`). The exact path wins where one exists; an ending naming two\nnodes is refused, and the refusal lists both paths. `get_app` prints the tree with each node\'s address.\n\n### Values\n\n| Value | Written |\n|---|---|\n| now, the reader, an asked input | `{ "now": true }`, `{ "me": true }`, `{ "input": "name" }` |\n| a computed value | `{ "formula": "{cost} * 1.2" }` over the acted row\'s fields |\n| a call\'s own value, in a Query | `{ "param": "name" }` |\n| cleared | `null` in an Act\'s `set` |\n| an option | its alias |\n\nA **condition** (`when`) maps a select to a list of its option aliases and a yes/no to `true` or `false`; every entry\nholds. A number (a number, currency or percent field, or a formula or rollup yielding one) takes a comparison with any\nof `gt`, `gte`, `lt`, `lte` (at least one, never both `gt` and `gte` or both `lt` and `lte`), each a number; a date\ntakes the same keys with a day (`"2026-03-01"`), a moment on a datetime (`"2026-03-01T09:30"`) or `{ "now": true }`\n\u2014 today, or the current minute on a datetime, read when the rows are, so overdue is `{ "due_on": { "lt": { "now": true } } }`;\nand any field but a yes/no takes `{ "empty": true }` or `{ "empty": false }`. A comparison on a field it does not fit is\nrefused, naming the field, its type and what it takes. A `when` on an Act, a Section or other block, and a List\'s `where`\n(the register\'s or a child List\'s) take these; a child List that adds, picks or expects rows refuses a comparison in its\n`where`, since a row it holds could stand outside it. A **narrowing** (`opens`, a Reading\'s, a Tab\'s or an Export\'s `where`) takes these and also `{ "me": true }` on a member\nfield or a lookup of one, the reader; `where` on a root List or a record\'s child rows fixes the rows on the server for every reader, so it refuses\n`{ "me": true }` \u2014 open on it with `opens`; on a record\'s related rows (`same`, `app`) and on a Sheet\'s List it\nnarrows by the reader and takes it, and those two take no comparison.\n\n## Changing an app\n\n1. `get_workspace` with `kind: "app"` names the app. `get_app` prints the `tree:`, the `node addresses:` (the address of\n each node the app draws, `(default)` on those the tree leaves to the platform) and the `version` line, whose id is the `base_version_id` to send. A member who is not the\n app\'s author is shown no tree. Keep the tree: no tool reads an earlier one.\n2. `set_app` with `app_id`, `base_version_id` (that version: a newer write is refused, not overwritten) and `nodes`,\n (a refused change writes nothing, so `dry_run` is for reading the permissions it would grant and remove). Every answer\n states the permissions the change grants and removes.\n3. `screenshot_app` shows the result.\n\n`nodes` maps an address to a patch of that node. Read against the customers List and page of the account review (\xA7 A complete\nworkspace, abridged), the call below makes `tier` read-only, moves the Orders Section ahead of Account, adds an Act to\nAccount and removes the Reading:\n\n```json\n{\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "children": [{ "type": "List", "entity": "customer", "children": [{ "type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered" }] }],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n { "type": "Section", "key": "account", "title": "Account", "children": ["tier"] },\n { "type": "Section", "key": "orders", "title": "Orders", "children": [{ "type": "List", "entity": "order" }] }\n ]\n }\n ]\n}\n```\n\n```json\n{\n "app_id": "<id of the app>",\n "base_version_id": "<current_version_id>",\n "nodes": {\n "tier": { "edit": false },\n "orders": { "before": "account" },\n "mark_gold": { "type": "Act", "in": "account", "label": "Make gold", "when": { "tier": ["standard"] }, "set": { "tier": "gold" } },\n "ordered_by_tier": null\n }\n}\n```\n\nEach entry applies in order:\n\n- **An existing node:** a JSON merge patch (RFC 7396) of its props; `null` drops a prop, and a list (`children`,\n `columns`) replaces the node\'s whole, as `layout` does: a patch states the whole layout.\n- **`null`:** removes the node and everything under it.\n- **An address naming no node, with `type`:** adds a node into the node its path names (`"pages/<entity>": { "type":\n "Record", \u2026 }` adds a Record page), or, for a bare key, into the node `in` names (`/` the app); its key is the\n address\'s last word, and a Field states `field` in place of `type`.\n- **`in`, `before`, `after`:** move a node into another, or ahead of or behind a sibling.\n\nThe app\'s own props (`name`, `description`, `icon`, `color`, `words`, `scope`, `period`) change\nthrough `body`, a merge patch over the App node. `dry_run` checks a change and writes nothing.\n\n| To change | State |\n|---|---|\n| a field read-only | `"edit": false` on its Field, or on the Section, Side or Record that draws it |\n| a column added or dropped | `columns` of the List, every column kept: a List that never stated `columns` draws none beyond the row\'s title and its `records` line |\n| a button | an Act node (\xA7 Act node); `confirm` makes its press ask first |\n| a label | the table\'s field `label` in `set_tables`, for every app; for this app alone, `body: { "words": { "<table>": { "fields": { "fee": "Consultation" }, "options": { "urgency": { "rush": "Same day" } } } } }`; a List\'s `label`, a Section\'s `title`, an Act\'s `label`, `add_label` on the add. A Field\'s `label` heads only a gallery or prose block |\n| the order of nodes and rows | `before` or `after` a sibling, or `in` another parent, in the node\'s entry (a Section ahead of another, a Field ahead of another in its Section); a List\'s `columns` read in the order stated; its rows read in its `sort`: `{ "sort": { "field": "collected_on", "desc": true } }` |\n| the row\'s second line | `row: { "subtitle": ["mechanic"] }` on the List: up to two fields under the title, in place of the table\'s `records` line, which stays as it is |\n| a picker\'s add | `add` on the linked table\'s page: `{ "type": "Record", "entity": "pet", "add": ["species", "microchip"] }` asks those fields of the new row; absent, the picker only picks. It holds in every picker of that table in the app |\n| a linked row fixed or deleted where its link stands | the linked table\'s page in `pages`: the link\'s card opens the row in the drawer as that page draws it, saving what it writes, with a Delete where it states `remove: true`. A table a List of the app draws is worked in that List |\n| a headline figure | a Reading in the List: `{ "type": "Reading", "in": "orders", "label": "Prepaid owed", "value": "prepaid", "where": { "stage": ["awaiting_payment"] } }` sums the rows in view; without a `value` it counts them |\n| a calendar and its date | `layout: { "calendar": { "date": "pickup_on" } }` on the List, with `end` for the date a row runs to (both days or both moments); the bare `"calendar"` takes them from the rows\' facts and is refused, naming `date`, where those name none |\n| a record\'s child lines | a List inside the Record\'s Section over the child table: `{ "type": "List", "in": "details", "entity": "repair_line" }`; the child table (one link back to the record) and the record\'s rollup over its rows come from `set_tables` first. Lines priced off a book: `docs path="design/treatments/moves-and-numbers/priced-lines"` |\n\n**A node the tree leaves to the platform has an address too.** `get_app` lists the nodes the app draws, those the stored\ntree does not state marked `(default)`: the Record with its Sections and Fields, the status buttons, the band of readings.\nPatch one by its address and the call states it first: the nearest node the tree does state gains the default child that\nleads to it, as drawn (the whole page in `pages` for an entity that states none, with its `row` picture, and the List\'s `columns` the\ndefaults added; every Section of a Record that states no part; every status button of the app, each in the Section of its\nstage; every reading of the band, since stating one stands the others down), then the patch applies. Defaults\noutside that subtree stay defaults, and the answer\'s notes say what was stated. Removing every reading, or every status\nbutton, is refused: a set no node states is drawn again by the platform, and only `readings: false` on the List or\n`row.status: { "edit": false }` on the Record draws none. **A stated subtree stays as it is**: a\nfield or option the tables gain later is not added to it, so name it in the tree. `{ "due_date": { "edit": false } }`\nover a sparse tree makes that field read-only and takes away `saves <table>: due_date` alone. An address that ends several\ndrawn nodes is refused, as for stated ones.\n\n**A write places what has one fix, and says so.** The stored tree is the placed one, `get_app` shows it, and the answer lists\neach placement at its address, so you read the difference instead of meeting a refusal:\n\n- `where: { "<field>": { "me": true } }` on a root List moves to `opens`, the chip that names the reader. A child List\n keeps the refusal: bound access with a row rule, or list the rows in a root List.\n- A read-only repeat of a field across a record\'s steps, or a Field beside the files or text block that draws it, is left\n out and said; the statement stays in the tree.\n- `door` on the page of an entity no root List and no Sheet\'s List is over, where the page states no Side, is\n not drawn and is said: its rows open in place. It stays stated, and applies once one of those or a root List does.\n\n## What an app may write\n\nAn app states no list of what it writes: the tree derives it, and the generated workflows accept exactly that, so it is\nalso what an agent can do through the app\'s API. `get_app` prints it beside the tree.\n\n1. **A save of field `f` of table `E`** exists when a node draws `f` on a page of `E`\'s rows (a Field in a Record,\n Section or Side, or a part of the head), the table lets a person write it (stored; not computed, stamped or the\n back side of a child\'s link), no Act of the app on `E`\'s rows writes it, and neither the node nor a container above it\n says `edit: false`. A row\'s stage is moved by an Act or the one button per move a status no Act moves gets, by hand only where its Record\'s `row.status` says `{ "edit": true }`, and by none where it says `{ "edit": false }`.\n2. **An add of `E`** exists for a List over `E` that writes its rows unless it says `create: false` (asking what it lists, and\n setting the link back to the record itself), and for every picker of `E` where `E`\'s page states `add`. An absent `create`\n stands down where the table states no `singular` (nor the app\'s `words`), or where `where` keeps a select at an option an\n Act sets other than the one a new row starts at; a stated `create` list over such a table is refused. A roster\'s cells and\n a document are added only where `create: true`.\n3. **A Delete of `E`** exists for a List over `E` unless it says `remove: false`, and for the table of each of that\n List\'s `sources` (a source has no `remove` of its own). A roster\'s cells, a document and a desk\'s rows are deleted only where `remove: true`.\n A Delete comes with `restore_<entity>`, which brings the row back with the rows its delete took, all or none.\n `remove: false` takes this app\'s Delete away and no more: the record tools, the API and other apps still delete. A row no\n surface may delete is a table check with `on: ["delete"]`.\n4. **An act** exists for each Act node. Every field it sets, asks, files into, signs or records is the act\'s, and read-only\n everywhere else in the app.\n5. **The table\'s contract holds on every path** and is not restated here: required, unique, no overlap, field rules, table\n checks, stage owners, history and the read scope. (`natural_key` is read by an app\'s add and find-or-create alone.)\n\nDrawing is reading or saving; a List that writes its rows also adds and deletes them, until it says `create: false` or `remove: false`, and a List below a part or a Record that says `edit: false` writes, adds and deletes none.\n\n### What a table gives a component\n\n| Table fact | Feeds |\n|---|---|\n| The title | every row\'s name: Lists, a Record\'s head, link chips, pickers, an add |\n| The row\'s line (`records` subtitle, figure, image, mark, party, description) | the row\'s line and head, cards, a checklist\'s photo |\n| The stage (`records` status) | the stage chips, a List\'s `opens`, the badge, an Act\'s moves, stage owners gating acts, a Section\'s `at` |\n| Deadlines (`records` due, settled, frees) | countdowns and overdue marks, the default sort, attention order, spans on lanes, calendars and rosters |\n| Bounds (`records` limits, gates, tolerance) | the figure\'s meter, wherever it stands |\n| Tasks and cadence (`records` task, cadence) | the ring on task rows, a roster\'s owed days |\n| Applicability and starts (`records` applies, starts) | a field shown and asked only where it applies; an add\'s starting values |\n| A field\'s `required`, `default`, `default_from`, `natural_key`, `unique` | what an add asks, and what it starts at |\n| A field\'s `notation`, `format`, options, `options_where` | money, units, chips, and what a picker offers |\n| The table\'s `read_scope` | which rows each reader reads, in every List |\n\n### Where the rules stand\n\n\xA7 App rules and the rule pages after it are every rule the check holds over an app, by id, whichever component it concerns. A\n**language** is decided by the app\'s own words: a tree names no locale, so what an app draws itself (its buttons, empty\nstates, refusals) is in the language its labels are written in, and `words` count as labels. Mix two languages in one\napp and it answers in two.\n\n## App node\n\nAn app draws its launcher tile, its words, its Views and its API. It binds the tables it names: `set_app` fills\n`tables` with the id of every table alias the tree uses, and `templates` with that of every document template alias.\nA relabel on either side is a rename and no tree points at another table by accident.\n\n<!-- generated:start node-app -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The app\'s alias, its name among apps; the App node is addressed `/`, and no address in it starts with this key |\n| `name` | text, required | The job, in the words of the people who do it |\n| `description` | text | What the job is for, in a sentence |\n| `icon` | text | A Lucide icon name in kebab-case the launcher tile draws |\n| `color` | [colour](#select) | The launcher tile\'s colour |\n| `words` | map of alias \u2192 [Table labels](#table-labels) | A table \u2192 the words this app draws for it |\n| `scope` | alias | The table whose one row the app works inside \u2014 the folder: every List over a table holding a one-row link to it lists the open folder\'s rows and files each add under it; absent, the app reads every row |\n| `folders` | alias | The key of a root List over the table `scope` names: it draws the folders the app opens on \u2014 its columns, filters, grouping, order and summary \u2014 and a row pressed is the folder entered; absent, the folders are listed by their anatomy |\n| `rows` | map of alias \u2192 [Read scope rule](#read-scope-rule) | Each table\'s row rule in this app, by its alias (a table the app only reaches, by the table\'s own alias): who of the people the app is shared with reads which rows, on its screens, its queries, its writes and its workflows. A table the app states none of is read whole by everyone it is shared with |\n| `uses` | list of alias (at least one) | Tables the app\'s Query and Workflow nodes read without drawing them, by alias: they join the tables the app reaches, so a workflow may name them |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window every Sheet opens on: "month", "quarter", "year" or { "days": 30 }; absent, the calendar month |\n| `tables` | map of alias \u2192 text | The id of each table the tree names, by its alias: filled by set_app, never written |\n| `templates` | map of alias \u2192 text | The id of each document template the tree names, by its alias: filled by set_app, never written |\n| `children` | list of ([List](#list-node) \\| [Sheet](#sheet-node) \\| [Query](#query-node) \\| [Workflow](#workflow-node)) (at least one) | The App\'s Views in order \u2014 Lists and Sheets, the first where the App opens \u2014 and its Queries and Workflows. Queries and Workflows alone: an API app, which a server calls with an app key |\n| `pages` | list of [Record](#record-node) (at least one) | The page the rows of an entity open, one per entity, each a Record stating its `entity`; every List over the entity, anywhere in the App, opens it, and a link\'s row no List lists. Absent, the platform draws the page |\n\n#### Table labels\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text | The table\'s name in the plural (a register\'s heading, a block\'s, a link\'s picker) |\n| `singular` | text | One row of the table, as the add and empty sentences name it |\n| `fields` | map of alias \u2192 text | A field alias \u2192 the words this app draws wherever it names the field; the table\'s field keeps its own label |\n| `options` | map of alias \u2192 map of alias \u2192 text | A select field alias \u2192 option alias \u2192 its words |\n\n<!-- generated:end node-app -->\n\n- **Every View at the root is a peer**: a List or a Sheet, in the order stated, the first where the App opens and the\n others each one entry of the App\'s lists, picked under its title, each at its own address: the first at the app\'s root (`/`), any other at `/<key>`, inside the folder where the App is scoped. A List states\n its `label`, any layout, its own Tabs, Readings and Exports, and may read `sources`; two may stand over one entity, and\n both open its one page. Whoever the app is shared with is shown every View, each table narrowed by the App\'s `rows`.\n A list people work every day as a desk of their own is another app.\n- **A Sheet** draws Readings and read-only Lists over the App\'s rows. The App\'s one `period` windows every reading of\n its Sheets placed in time: the calendar month by default, or `quarter`, `year` or `{ "days": 30 }`. An App of Sheets alone\n draws the pages its Sheets\' Lists open (a List naming no `app`), each from `pages` as any page is. A Sheet\'s List\n naming no `app` opens its row\'s page in this app, in the drawer over the Sheet, at `/<sheet key>/<row>`.\n- **Query and Workflow** nodes stand at the root and are never drawn.\n- **Writes:** nothing itself.\n\n## List node\n\nA List draws rows of one table. What its rows are depends on where it stands:\n\n- at the App root: a register, a View of its own among the App\'s;\n- under a Record, Section or Side: the record\'s child rows, filed through the child\'s one link to the record\n (`via` where it has several);\n- under a roster List: the rows that fill the roster\'s cells;\n- with `same` or `app`, or on a Sheet: related rows, read only.\n\nA List below a row\'s page is a View too: it takes Tabs, Readings and Exports as a root List does, and its rows open at\n`/<view>/<row>/<key>`, drawn alone with its band, its way back the row\'s page. An Export of it is the file of that one\nrow\'s rows.\n\n<!-- generated:start node-list -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Names the List among its siblings and in a Query\'s `list`; absent, the entity alias |\n| `entity` | alias, required | The table whose rows the List draws |\n| `sources` | list of [List source](#list-source) (at least one) | Further tables read as one List with this entity |\n| `source_column` | `false` | Reads a List\'s tables as one: false, no column naming each row\'s table and no filter by it; absent, a List with `sources` draws both |\n| `scope` | alias | Says which folder a row files in: with the App\'s `scope`, the one-row link, where the table holds several |\n| `via` | alias \\| text | The child\'s link to the record, where it has several; a List that only reads may state `<link>.<link>`, reaching the record through a row of their own |\n| `same` | alias | A one-row link of the record: the rows sharing its row, the record left out, read only |\n| `where` | [narrowing](#app-tree) | A fixed narrowing on the server, for every reader: a condition (\xA7 Values), and `<link>.<field>`, the rows whose one-row link names a row holding a select or yes/no so. A List that only reads (`same`, a Record with `edit: false`) also bounds a date or number by a field of the record, `{ "record": "<field>" }`: blank, it keeps no row; an Act\'s paper naming the List is handed the same rows; it is never an access bound, which the table\'s row rules are. An add holds only a select\'s option and a yes/no\'s value |\n| `expect` | alias \\| [Expect](#expect) | What a record should hold, shown before it does: one line per option of this select, or per row of this catalog link |\n| `under` | alias | Groups lines by the document covering them: a one-row link to it |\n| `edit` | `false` | Shows rows nobody changes here: false, this List only reads them |\n| `label` | text | The register\'s name in the app\'s lists and tab strip; absent, the entity\'s label. Never the noun of its rows, which is the table\'s label and singular (this app\'s `words`) |\n| `columns` | list of (alias \\| [Edit column](#edit-column)) | Fields read after the row\'s title; `{ field, edit: true }` is the line\'s own control, at most 2. Absent: the title and the `records` line alone |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter)) (at most 3) | Fields the reader narrows by every day, beside the stage chips: a select, member, link, date, yes/no or number range; `tiers` bands a number or date |\n| `search` | list of alias (at least one) | Fields the search box reads; absent, every word of the row |\n| `group` | alias | A field the rows stand grouped by; a gantt draws the groups as its lanes |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The rows\' order; absent, a register reads newest made first, a record\'s rows as added |\n| `opens` | [narrowing](#app-tree) | The view the register opens on, a chip the reader may take away: `where`\'s entries but a record bound, and `{ "me": true }` on a member field or a lookup of one |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window a table\'s or cards\' dated Tabs read, or the day, week or month a calendar or lanes board opens on; absent, this month |\n| `attention` | `false` | Keeps a list in its own order: false, the sort menu offers no attention-first order |\n| `readings` | `false` | Leaves a list without figures above it: false, no band; absent, rows that move, fall due or carry money lead with one. Never with Readings stated |\n| `layout` | [layout](#layouts) | A word, or an object stating one layout with its data; absent, a table |\n| `beside` | `true` | Keeps the list in view while a row is worked: true, a row pressed opens beside this table; a root List drawn as a table. Absent, the page\'s `door` |\n| `compare` | [Compare](#compare) | Each row\'s before against its after: two files fields as a pair of photos, or two values of one type as one column |\n| `current` | alias | A child List of revisions: the child\'s date or number field ordering them. The latest reads as current, the others fold under "superseded \xB7 N"; the record shows the current file through a lookup of the child ordered by it |\n| `create` | boolean \\| list of alias (at least one) | The fields an add asks; `false`: rows are not added here. Absent: where this List writes its rows, the table\'s required fields, natural key and title; nothing where the table states no `singular` (nor the app\'s `words`), or `where` keeps a select at an option an Act sets other than the one a new row starts at. A roster\'s cells and a document add only where `true` |\n| `add_label` | text | The add button\'s words; absent, the platform\'s word and the singular |\n| `remove` | boolean | Rows offer a Delete. Absent: where this List writes its rows; `false`: this app\'s Delete alone is gone, and a row no surface may delete is a table check with `on: ["delete"]`. A roster\'s cells, a document and a desk\'s rows delete only where `true` |\n| `pick` | `true` | Also picks rows of the child that no record holds yet |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `children` | list of ([Tab](#tab-node) \\| [Reading](#reading-node) \\| [Export](#export-node) \\| [Act](#act-node) \\| [List](#list-node)) (at least one) | Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view; under a roster the List of its cells, with `under` the List of its documents. An Act on one row and every Check stand in `pages/<entity>` |\n\n#### Edit column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The column\'s field |\n| `edit` | `true`, required | Lets a person change the value on the line: true, its own control, written in place |\n\n#### Expect\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The child\'s title, one row per value: a single select or a one-row link to a catalog |\n| `of` | alias | Lets each record choose its lines: with a select, the record\'s own multi-select naming the options it expects, in place of every option |\n| `only` | list of alias (at least one) | Holds lines for some options alone: with a select, those options; never with `of` |\n\n#### Compare\n\n| Key | Type | Meaning |\n|---|---|---|\n| `before` | alias, required | The rows\' field holding what stood before: files, text, a number, a date or a single select |\n| `after` | alias, required | A field of the same type holding what stands after |\n| `edit` | `true` | The after is written on the line |\n\n#### Tiered filter\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number \u2014 stored, or a formula or rollup reading one \u2014 in one unit for every row |\n| `tiers` | list of number (at least one), required | The breakpoints between its bands, ascending, in the field\'s stored unit: under the first, from each to the next, from the last up \u2014 each band worded in the field\'s notation; a filter picks several at once |\n\n#### Sort key\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field rows are ordered by |\n| `desc` | boolean | Latest or largest first; absent or false, soonest or smallest first |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.scope` | With the App\'s `scope`, a List over a table holding one one-row link to the folder\'s table is filed in the open folder by it, and one holding several names it in `scope`; that link is required. A List over the folder\'s own table states no `scope`. |\n| `list.unscoped` | *Noted, never refused:* In an App that states `scope`, a List over a table holding no one-row link to the folder\'s table lists every row, in every folder; so does a Tab\'s totals over a child holding no single link to it. |\n\n<!-- generated:end node-list -->\n\nA List takes only the props its place lists:\n\n<!-- generated:start list-places -->\n\n| A List standing in | Takes |\n|---|---|\n| every List | `key`, `entity` |\n| every List on a record | `via`, `label`, `when`, `filters`, `search`, `group`, `sort`, `opens`, `period`, `attention`, `readings` |\n| a root List (the first is the register) | `label`, `columns`, `filters`, `search`, `group`, `sort`, `opens`, `period`, `attention`, `layout`, `beside`, `create`, `add_label`, `remove`, `readings`, `where`, `edit`, `sources`, `source_column`, `scope` |\n| a record\'s child rows, as a table, a checklist, a desk or a gantt (which refuses `under`, `pick`, `compare`, `current`, `expect` and an `edit: true` column) | `columns`, `create`, `add_label`, `where`, `under`, `remove`, `pick`, `layout`, `compare`, `current`, `expect` |\n| a record\'s child rows with `layout` an agenda | `columns`, `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s child rows with `layout` `"timeline"` | `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s related rows, read only (`same`, or a Record that is `edit: false`) | `where`, `columns`, `same`, `edit` |\n| the documents a child List\'s lines stand under (`under`), a List inside it | `create`, `remove` |\n| the cells of a roster, a List inside it | `expect`, `create`, `remove` |\n| a Sheet\'s list, read only | `label`, `where`, `columns`, `sort` |\n\n<!-- generated:end list-places -->\n\n- **The page a child List\'s rows open** is the entity\'s page in `pages`: its Fields in stated order, those the rows\' saves write editable, and the List\'s `columns` are the line. A row opens in place under itself: its fields or Sections, then each List of its own children, at any depth. With `edit: false` the List reads as a related-rows List does.\n- **Documents:** in a child List with `under`, a List over the document\'s table (`key`, `entity`, `create`, `remove`,\n Acts and Checks; the document\'s Fields and Lists stand in its page) is the one place the documents are added or deleted;\n `create` states `true`, and `remove` needs `create: true` beside it.\n- **Writes:** a layout move (a gantt bar, a lane\'s block, a plan\'s item) writes only fields the app already writes on the row\'s page.\n- **`create` asks:** `true` asks the title, the natural key and every required field a person writes, never a computed\n or stamped field or the link the place sets. An `expect` list also asks the key it makes its lines by, and their picture.\n- **`filters`:** a threshold the business names ("large orders") is a formula yes/no, and bands it names (new, warm, cold) a formula with options, never a range.\n- **`opens`** absent, the register opens on the open work (rows not at a `closed` stage).\n- **`expect`:** an empty line adds its row (a checklist of papers per case).\n\n## List source\n\nSources are further tables a root List reads beside its entity as one List: the same job kept in tables of their own (a legacy ledger, a second branch\'s register). Each is projected onto the List\'s fields \u2014 by alias, else by its `fields` (the List\'s field \u2192 the source\'s) \u2014 and options line up by alias; its `where` narrows its own rows. Each row opens its own table\'s page in `pages`, stated or refused (`list.source-page`), and runs the Acts and Checks that page states: nothing the List offers its own rows reaches a source\'s. The add offers each table, asking the List\'s `create` in that table\'s fields; a source lacking one adds no row. `source_column: true` draws a column naming each row\'s table, and a filter by it. Every source holds the title, the stage and the scope; a table, cards or a plan reads sources, and an Export\'s `sources` makes a report of some of them.\n\n<!-- generated:start node-list-source -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | A further table this List reads beside its own entity: the same job over its rows |\n| `fields` | map of alias \u2192 alias | A field of the List\'s entity \u2192 this table\'s field holding the same fact, where their aliases differ |\n| `where` | [narrowing](#app-tree) | Which of this table\'s rows the List reads |\n| `row` | [List source row](#list-source-row) | How the List reads this table\'s rows, where it differs from the table\'s `records` |\n\n#### List source row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `status` | `{ "edit": true }` | Lets a person move this table\'s stage by hand in the List: `{ edit: true }` |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.sources` | A List\'s `sources` each name another entity once (`entity`) \u2014 never the List\'s own \u2014 whose fields line up with the List\'s by alias, else by `fields` (a field the List reads, or one an Export prints \u2192 one of the source\'s): read as one column type (a day apart from a moment), one value or several alike, a link to the same entity. Each source holds the title, the status where the List shows one, the List\'s folder link and what `where` keeps; the List is a table, cards or a plan, whose `at`, `across` and `up` line up like any field. Two sources holding a field of their own under one alias hold it as one kind of value. An Export\'s `sources` each name the List\'s entity or one of its sources, once, and one of them holds each field its `where` and `per` narrow by. A List with `sources` draws a column naming each row\'s table, and a filter by it; `source_column: false` draws neither. A source\'s rows open the page of its own entity, which states the Acts and Checks they run: each Act\'s `key` its own among the App\'s Acts. |\n| `list.source-lacks` | *Noted, never refused:* A source lacking a field its List\'s `create` asks adds no row; one lacking the select its List\'s plan marks or sizes by never marks or sizes its rows. A field only an Export prints, held by a source as another kind of value, prints blank on its rows. A Tab\'s `totals` over a child linking to no row of a source total nothing on its rows. |\n| `list.source-option-kin` | *Noted, never refused:* A source\'s option labelled as one of the List\'s, under another alias, reads apart from it: the List lists both and counts each on its own. |\n\n<!-- generated:end node-list-source -->\n\n## Layouts\n\nA List\'s `layout` is how it draws its rows: a word (`"table"`, `"cards"`, `"calendar"`, `"roster"`, `"timeline"`) or an\nobject stating one layout and the data it reads (`{ "gantt": \u2026 }`, `{ "lanes": \u2026 }`, `{ "plan": \u2026 }`, `{ "agenda": \u2026 }`,\n`{ "checklist": \u2026 }`, `{ "desk": \u2026 }`). Absent, a table: the word `"table"` is the register\'s, and a child List states a\nchecklist, a desk, a gantt, an agenda or `"timeline"`, else leaves `layout` out. Each layout reads what the rows already state \u2014 their\n`records` line, stage and dates \u2014 and the keys a layout adds stand on its section: here for an agenda and a checklist, \xA7 Time and place layouts for the rest, \xA7 Publish desk for a desk. Which one a job needs: the\n`design` reference. The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a record\'s\nchild rows as a table, a checklist, a desk, a gantt, an agenda or a timeline.\n\n### Table\n\n<!-- generated:start layout-doc-table -->\n\nAbsent `layout`, each row is one line: the table\'s `records` entry \u2014 its picture or mark, title and the line under it \u2014\nthen the stage, the `columns`, and the figure at the right; the title, the stage and a column of days or amounts sort\nthe rows by their header. A table groups its rows by `group`; a table or cards reads `Tab`s and the `sources` of its List.\n\n<!-- generated:end layout-doc-table -->\n\n### Cards\n\n<!-- generated:start layout-doc-cards -->\n\n`"cards"` draws each row as a card led by its picture \u2014 the `records` `image`, or the List\'s `row.image`: its title and\nthe line under it, its stage and what needs the reader (a deadline, a warning), then its figure and the `columns` at its\nfoot. Cards are for rows found by their picture (a product, a vehicle, a damage photo); rows with no picture read better\nas a table.\n\n<!-- generated:end layout-doc-cards -->\n\n### Calendar\n\n<!-- generated:start layout-doc-calendar -->\n\n`"calendar"` or `{ "calendar": { "date": "starts_at", "end": "ends_at" } }` places each row on its day \u2014 a month, a week,\na day or a list (a phone reads the list or a day): at its hour where `date` holds one, over its span where `end` names\nthe date it runs to, with its line\'s other words and the `columns` after its title. `date` and `end` are two dates of\nthe row, both days or both moments; a span of moments gives a phone its day view, and a day\'s `end` is the last day held\n(unless `records` names it the day the row `frees`). The bare word takes them from the rows\' facts: two dates a person\nstates, the second ordered after the first by a `min` or a table check, both required or the second the row\'s `due`; else the one required\ndate a person states that no Act stamps and a new row does not start at today \u2014 and is refused, naming `date`, where the\nrows hold neither. A `due` is a deadline, never the day a row is held on. The calendar reads the window in view, and its\ncount and the stage chips count that window, opening on every row.\n\n<!-- generated:end layout-doc-calendar -->\n\n<!-- generated:start layout-calendar -->\n\n#### Calendar keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `date` | alias, required | The date or moment of this entity each row stands on: a viewing\'s start, a hire\'s first day, a visit\'s day |\n| `end` | alias | The date or moment each row\'s span ends on, read as `date` is \u2014 two days or two moments (a moment\'s end gives a phone its day view); absent, a row stands on `date` alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.calendar` | `layout: "calendar"` or `{ calendar: { date, end } }`: two dates of the row, both days or both moments; bare, it takes the rows\' span or appointment, else is refused, naming `date`. |\n\n<!-- generated:end layout-calendar -->\n\n### Roster\n\n<!-- generated:start layout-doc-roster -->\n\n`"roster"` draws the List\'s rows down the side and the days of a week or a month across; the roster\'s cells are a List\ninside it over the table whose rows fill the days \u2014 each stands on one row by its single link to it, and on the first\ndate of its line (a shift on a person\'s day, a run on a vehicle\'s), on every day through the second date where its line\nholds one. A cell reads its row\'s stage, else the first single select on its line (a shift\'s kind), several rows their\ncount. A day holding none stays empty: nothing was due, which is never an absence. A filled cell opens its row; an empty\none adds a row there, the register row and the day set. With `expect` on the cells (a single select of those rows) the\ncolumns are its options in place of days \u2014 a checklist of papers \u2014 and `of` names the ones each row expects: a gap among\nthem reads as one and adds its row, the others stand blank, and each row reads what it holds of them, `2/3`. Over days, a\nroster reads the `cadence` its table\'s `records` states (a site\'s diary page, Monday to Saturday from breaking ground to\nhandover): a past day owed with none is marked missing and counted, and each row reads the days it holds of those owed. A\nroster states no `columns` and needs no readings: its legend counts each state in view.\n\n<!-- generated:end layout-doc-roster -->\n\n```json\n{ "type": "List", "entity": "operator", "layout": "roster", "filters": ["depot"], "children": [{ "type": "List", "entity": "run" }] }\n```\n\n### Timeline\n\n`"timeline"` reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds\nentries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each\nmove. A timeline\'s moment is its child\'s first date, and who its member field. Rows each what happened on a day and who \u2014\na date on their line, a member, no stage and no figure \u2014 read best as a timeline.\n\n### Agenda\n\n`{ "agenda": { \u2026 } }` reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its\npicture and the day that is today marked. The day is the first date on the child\'s row line (its `records` title or\nsubtitle); within a day entries follow a datetime there, else the first single select after the date. An entry with no day\nyet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading\ncounts from it (Day 1, Day 2).\n\n<!-- generated:start layout-agenda -->\n\n#### Agenda keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The record\'s date that is the first day: each day\'s heading counts from it; absent, the weekday and the date alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.agenda` | An agenda List\'s child names a date on its row line (`records` title or subtitle); the layout\'s `start` is a date of the record. |\n| `list.agenda-note` | *Noted, never refused:* Rows each on a day and within it (at an hour, in a part of the day) listed as a table: a List with `layout: { agenda }` draws them by day. |\n| `list.timeline` | A timeline List\'s child holds a date to place its entries by. |\n| `list.timeline-note` | *Noted, never refused:* Rows each what happened on a day and who \u2014 a date on their line, a member, no status and no figure \u2014 listed as a table: a List with `layout: "timeline"` draws them as a timeline, newest first. |\n\n<!-- generated:end layout-agenda -->\n\n### Checklist\n\n`{ "checklist": { \u2026 } }` reads a record\'s child rows, which are tasks, as a checklist of checks: each one\'s mark \u2014 passed\nat a `closed` option, failed at a `failed` one, else still to check \u2014 its title, its columns as its words (a text column\nits note, on its own line), and on a line under its title its photo and its clause. Never grouped nor written in place.\n`passed` alone sets the mark, so rows with no `task` and no status are checks: a measured yes/no is the verdict. With\n`expect` on the standard\'s items, each item is a line marked the same way (a missing one still to check), filled in\nplace by the block\'s `columns` (a measured value, a note, a photo), so `photo` and `clause` are not named.\n\n<!-- generated:start layout-checklist -->\n\n#### Checklist keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photo` | alias | The child\'s files field holding the photo each row is checked by; absent, the child\'s `records.image` |\n| `clause` | alias | The child\'s one-row link to what each row is checked against \u2014 a standard\'s clause, a rule |\n| `failed` | list of alias (at least one) | Options of the child\'s status a row stands failed at \u2014 none of them closed |\n| `passed` | alias | The child\'s yes/no field (stored or a formula) setting each row\'s mark: yes passed, no failed, empty still to check |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.checklist` | A child List with `layout: { checklist }` reads a task entity\'s rows as checks \u2014 never under documents, grouped, edited in place or picked together by an Act over several, its columns no files; `photo` names a files field of the child, `clause` a one-row link of it, `failed` options of its status, none `closed`; `passed` a yes/no of it, stored or a formula, setting each mark (yes passed, no failed, empty still to check) and standing without `task` or a status. With `expect` the lines of a standard are the checks, each marked and filled by the block\'s columns (a measured value, a note, a photo), so `photo` and `clause` are not named. |\n\n<!-- generated:end layout-checklist -->\n\n## Time and place layouts\n\nThe layouts that place a List\'s rows in time or on a plan. Each is a `layout` object stating the data it reads.\n\n### Lanes\n\n<!-- generated:start layout-doc-lanes -->\n\n`{ "lanes": { "by": \u2026 } }` draws each row of the linked table as a lane (a chair, a machine, a room), empty ones too,\nand each row of the List as a block from the first date on its line to the second: over the hours of one day where the\nfirst holds its hour, else over the days of one day, a week or a month. X a free stretch between blocks adds a row there, its lane and its start set, and its end where the next block\nbounds it. Rows naming no lane stand first, in a lane of their own; where the app writes the link, each block moves to\nanother lane from its menu. Inside a `scope`, the lanes are the ones whose own one-link names that scope\'s row. A span\'s\nend holds its day unless `records` names it the day the row `frees`.\n\nA person is a lane too: `by` may name a member field holding one person, with `of` the role (one of the model\'s\n`roles`) whose every member is a lane, empty ones too \u2014 `{ "lanes": { "by": "engineer", "of": "engineers" } }`. A row stands\nin the lane of the person it holds, and a `no_overlap` by that member keeps one row per person at a time. `of` is\nrequired with a member `by` and refused with a link; `loads` read a lane\'s row, which a person is not.\n\n`loads` names what a lane carries: `{ "weight": "payload", "volume": "box" }` sums each block\'s number and reads it\nagainst the lane row\'s own, at most two; each block then reads that number after its first column. A lane holds its blocks while they stand, so it reads the most they add up to at\none time in the window, named, past its bound, by how much and on which day or hour. The two are in one unit, or two of\none dimension. A bound a single row must keep (no parcel heavier than its van) is a `max` on the field through the link,\nwhich refuses the move.\n\n<!-- generated:end layout-doc-lanes -->\n\n<!-- generated:start layout-lanes -->\n\n#### Lanes keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `by` | alias, required | A one-link of this entity whose target\'s rows are the lanes (a chair, a machine, a room), each drawn even when empty; or a member field holding one person, whose lanes are the members of the role `of` names |\n| `of` | alias | Shows a whole team, the idle included: with a member `by` only (refused with a link), the role, one of the model\'s `roles`, whose every member is a lane, drawn even when empty |\n| `loads` | map of alias \u2192 alias | What a lane carries against what it holds, at most 2: a number of this entity each block adds \u2192 a number of the lane\'s row it is held within, in one unit or two of one dimension |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.lanes` | `layout: { lanes }`: `by` is a one-row link to an entity with a `records` entry, the rows name a date on their line (a field of the row itself, or a lookup of its parent\'s date), a lane block\'s two ends are read alike (two days or two moments), and `loads` stands with it. |\n| `list.loads` | A lanes layout\'s `loads` names one to 2 numbers a lane block adds \u2014 never a percent \u2014 each against a number of the lane\'s row, in one unit or two of one dimension. |\n\n<!-- generated:end layout-lanes -->\n\n### Gantt\n\n<!-- generated:start layout-doc-gantt -->\n\n`{ "gantt": { \u2026 } }` draws each row as one bar on one axis of time: `{ "start": "etd", "end": "eta", "milestones":\n["cut_off"], "planned": { "end": "booked_eta" }, "progress": "done", "after": "waits_on" }`. `end` defaults to the table\'s\nfirst `due`, and a table with neither is refused; `start` and `end` are two dates of the row, both days or both moments,\nand each planned date is read as `start` is. `progress` is a percent (0\u2013100); absent, a row whose record lists its tasks\nfills to how many are done. `after` is a link to rows of the same table, each ending before the row starts. The bars\nstand in the lanes of the List\'s `group`. Where the app writes the row and a person writes a bar\'s date, the bar is\ndragged through the row\'s save; a computed date, one an Act sets, or a row the app does not write drags nothing. Over a\ntable that holds rows under rows, each bar stands under the row above it, indented and folded as the register\'s outline\nis, `group` still the outer section. A child List of a record may lay out as a gantt too: the bars of the rows the\nrecord\'s link names.\n\n<!-- generated:end layout-doc-gantt -->\n\n<!-- generated:start layout-gantt -->\n\n#### Gantt bar\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of this entity each row\'s bar starts at (a sailing, a hire\'s start, a task\'s start) |\n| `end` | alias | The date each row\'s bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity\'s first `due` |\n| `milestones` | list of alias (at least one) | Dates of the row marked on its bar\'s line as diamonds, each named by its label (a cut-off, a delivery, the end of free time) \u2014 never `start` or `end` |\n| `planned` | [Gantt plan](#gantt-plan) | The plan each row is read against, drawn as a thin bar under its own \u2014 each date read as `start` is; a missing one is the bar\'s own |\n| `progress` | alias | A percent of this entity (0\u2013100) filling each row\'s bar as far as the work is done; absent, how many of the row\'s tasks are done fills it where its record lists them, else the bar wears its status\'s tone |\n| `after` | alias | A link of this entity to its own rows each row waits on \u2014 it starts once they end (finish-to-start), an arrow from each; a row starting before one ends is drawn in the danger tone |\n\n#### Gantt plan\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The date the row was planned to start at |\n| `end` | alias | The date the row was planned to end at (a booked arrival) |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.gantt` | `layout: { gantt }`: `start` and `end` (absent, the entity\'s first `due`) are two different dates of the row, both days or both moments; each diamond (`milestones`) another date of it, each planned date read as `start` is, `progress` a percent and `after` a link to rows of the same entity. |\n\n<!-- generated:end layout-gantt -->\n\n### Plan\n\n<!-- generated:start layout-doc-plan -->\n\n`{ "plan": { \u2026 } }` draws things that stand at a place \u2014 pallets in a warehouse \u2014 on a plan of the places. The places are\nthe rows of a table whose `records` states a `plan_place` (a bay, an open area or a landmark, each at its spot on a sheet\nof the plan); `at` names the one-link of the List\'s rows to a place and, for an item in a bay, the row (`across`) and the\ntier (`up`) it stands in, counted from 1. A bay is drawn as its rows and tiers, an area with a count, a landmark as a\nlabelled frame; the reader sees a plan, one bay enlarged, and the same plan in 3D. The List may read other tables as\n`sources`: one plan of every table\'s items. Each item carries `__reach` \u2014 how many items stand in the way of taking it out\n(those above it where the place is `stacked`, and those in the rows between it and the side `reach_from` says the bay is\ntaken from) \u2014 so the list, its export and an agent\'s read all carry it; `<table>_plan_load` counts the rows each place\nholds. A move through the app is refused unless it clears the place, row and tier all three, or places the item at\na free cell of a bay \u2014 resting on a present item where the place is `stacked` \u2014 or at an area. Every other write (a grid edit, an import, a tool) holds one item to a cell only where the item\'s table states `unique: [<at>, <across>, <up>]`; a plan over a table stating none is noted. A plan opens on every row\nits `where` keeps, with no stage chip narrowing it. Rows with no place wait in a tray beside the plan. An Act that asks exactly a place (a link to the plan\'s places) and two numbers (the row and the tier) is answered by a pick on the plan, never by a form. On a desk a press opens a row\'s record in the panel beside the plan.\n\n<!-- generated:end layout-doc-plan -->\n\n```jsonc\n// table "bay"\n"title": "code",\n"records": { "plan_place": { "kind": "kind", "x": "x", "y": "y", "across": "rows", "up": "tiers", "reach_from": "taken_from", "stacked": "is_stack" } }\n```\n\n```json\n{ "type": "List", "entity": "pallet", "filters": ["line"], "layout": { "plan": { "at": "bay", "across": "row", "up": "tier" } } }\n```\n\n```jsonc\n// table "pallet": one item to a cell on every write, not only through the app\n"unique": [["bay", "row", "tier"]]\n```\n\n<!-- generated:start layout-plan -->\n\n#### Plan keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `at` | alias, required | A one-link of this entity to an entity whose `records` states a `plan_place`: where each row stands |\n| `across` | alias, required | A number field: the row of a bay a row stands in, counted from 1; empty at an area |\n| `up` | alias, required | A number field: the tier of a bay a row stands at, counted from 1 at the ground; empty at an area |\n| `fill` | alias | A single select the items are coloured by; absent, the first single select among the register\'s filters |\n| `mark` | [Plan mark](#plan-mark) | A row holding the option says the option\'s label on its box and is hatched in the option\'s own colour, and the legend names it by the label; over `sources`, the select is matched by option alias, and a source lacking the select never marks its rows |\n| `size` | [Plan size](#plan-size) | Each row\'s box as it stands in the world, in the one length unit its places\' `size` states: the option the row holds of the select names its box\'s width across, depth along and height; over `sources`, matched by option alias, as `mark` is; a row holding an option it does not name is drawn at its place\'s cell |\n\n#### Plan mark\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `option` | alias, required | An option alias of that select |\n\n#### Plan size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `options` | map of alias \u2192 [Plan size box](#plan-size-box), required | The box of each option alias of that select |\n\n#### Plan size box\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | number, required | The box\'s width across the bay\'s rows |\n| `along` | number, required | The box\'s depth along them |\n| `up` | number, required | The box\'s height |\n\n#### Plan place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `kind` | alias, required | A single select, options aliased `bay` and, where the places have them, `area` and `landmark`: a bay holds rows and tiers, an area neither, a landmark nothing |\n| `sheet` | alias | The plan sheet it is on: a single select, or a one-row link to an entity whose `records` states its `image` \u2014 the sheet\'s drawing, which the places are drawn over (with `scale`) |\n| `scale` | alias | A number field of the sheet entity `sheet` links to: how many cells wide its drawing is, the plan\'s scale. Required where that entity states an `image`, and only then |\n| `x` | alias, required | A number field: left edge, in cells |\n| `y` | alias, required | A number field: top edge, in cells |\n| `width` | alias | A number field: an area\'s frame width, in cells |\n| `depth` | alias | A number field: an area\'s frame depth, in cells |\n| `across` | alias, required | A number field: a bay\'s rows |\n| `up` | alias, required | A number field: a bay\'s most tiers |\n| `reach_from` | alias | A single select, options aliased exactly `first`, `last`, `both`: the side boxes leave a bay from; a bay that names none has no reach and no arrow |\n| `stacked` | alias | A boolean field: true where items at this place rest on the one below (a stack), so a tier above the first needs a present item under it, shows floating without one, and an item\'s reach counts the items above it; false or empty, items sit at any tier and only the rows between a bay\'s reach side and the item are in the way |\n| `size` | [Plan place size](#plan-place-size) | The real size of ONE cell of the place, for 3D: three number fields stating one length `unit` alike. Absent, a cell is drawn at the size most of the sheet\'s places state, a unit cube where none states one |\n\n#### Plan place size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of one cell across the rows |\n| `along` | alias, required | A number field: the depth of one cell along the place |\n| `up` | alias, required | A number field: the height of one cell, one level |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.plan` | `layout: { plan }`: `at` is a one-row link to an entity whose `records` states a `plan_place`, `across` and `up` two different numbers of the row, `fill` a single select; a plan List has no Tabs, `group` or `attention`. A write that sets `at`, `across` or `up` is refused unless it clears all three, or places the row at a free cell of a bay (a row from 1 to the bay\'s `across`, a tier from 1 to its `up`, resting on a present item), or at an area with neither. |\n| `list.plan-unique` | *Noted, never refused:* A plan\'s items (the List\'s table and each source) state `unique` on their place link, `across` and `up`: the app\'s moves refuse a taken cell, and the unique makes every other write hold it \u2014 the note names a table that states none. |\n| `list.plan-mark` | A plan\'s `mark` names a single select of the row, or a lookup of one through a one-row link, and an option of it by alias: a row holding that option is hatched on its box in the option\'s colour, which the legend names by its label. A source that holds the select must hold it as a single select with that option; a source lacking it never marks its rows (`list.source-lacks`). |\n| `list.plan-size` | A plan\'s `size` names a single select of the row, or a lookup of one through a one-row link, and, by option alias, the box (`across`, `along`, `up` \u2014 positive, in the one length unit the places\' `size` states) of each option: a row holding one is drawn as that box, any other at its place\'s cell. A source that holds the select must hold it as a single select; a source lacking it draws its rows at their places\' cells (`list.source-lacks`). |\n| `list.plan-box-size` | *Noted, never refused:* A plan whose places state a `size` and whose rows\' select options are ISO 6346 container size-type codes (`20DC`, `40HC`) states the box of each in `size`, from the ISO 668 dimensions, else every box is drawn at its place\'s cell. |\n\n<!-- generated:end layout-plan -->\n\n## Publish desk\n\nRows that are each a place the record is sent \u2014 a notice\'s boards, a listing\'s portals \u2014 are a record\'s child List with\n`expect` on the child\'s one-row link to the catalog of those places and `layout: { "desk": \u2026 }`:\n\n```json\n{\n "type": "List",\n "entity": "posting",\n "expect": "board",\n "columns": ["posted_link", "refusal"],\n "layout": { "desk": { "bodies": ["wording", "wording_abroad"], "text": "goes_out_as", "media": "pictures", "link": "page", "group": "reach", "network": "kind", "networks": { "company_page": "linkedin" } } }\n}\n```\n\nThe desk is where the post is written. `bodies` are the record\'s plain text fields it is written in (one per language,\nsay), each its editor between the list and the preview, saved as any field of the record is and drawn nowhere else on it.\nThe preview is `text` read over what is on screen: where `text` is a formula of the child, the desk computes that same\nformula over what is typed, so the post moves as it is written, and a place not ticked previews the words its row would\nhold. For that the formula reads only what a screen holds whole: stored values of its row, the record through lookups over\nthe link back to it, the place through lookups over `expect`, and formulas of the row over those \u2014 a rollup, a lookup\nthrough another link or the clock is refused, naming the field.\n\nEvery place the link admits is a line with a tick and that place\'s face: its picture, else the mark of the network it is on\nwhere `networks` names one. `group`, another single select of the place, stands the lines under its options in their\norder: a kind holding a ticked line is open, one holding none folded to its heading and its count. A tick makes the line\'s\nrow from its key alone \u2014 so nothing else the child requires is left without a default \u2014 and an untick deletes it until the\nrow\'s stage is `closed`: what went out is not taken back. It asks first only where a person wrote on the row. One line is\nworked beside the list and read as the post that place\'s feed shows: `text` is the child\'s words for that place, `media`\nand `link` the record\'s, and `network` the place\'s single select whose options `networks` names to a feed; an option not\nnamed reads on a plain card. Under the bodies stand the List\'s `columns` a person writes of the line\'s row; under the post,\nthe press copying its words beside the Acts of the child, then what the line and the `columns` hold that nobody writes\nthere (the link it went out at, why it was refused). A value an Act or a workflow fills is stated as that Act\'s, so the\ndesk never offers it as an empty box. Sending is an ordinary Act of the record.\n\n<!-- generated:start layout-desk -->\n\n#### Desk keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `bodies` | list of alias (1\u20133) | The record\'s plain text fields the post is written in, in order \u2014 one per language, say \u2014 at most 3: each its editor on the desk, between the list and the preview, and drawn nowhere else on the record |\n| `text` | alias, required | A text of the block\'s rows \u2014 stored, or a formula yielding text \u2014 holding the words that go out on that row\'s destination. A formula is computed on the desk too, over what is typed: it reads stored values of its row, the record through lookups over the link back to it, the destination through lookups over `expect`, and formulas of the row over those \u2014 never a rollup, another link or the clock |\n| `media` | alias, required | A files field of the record: the pictures or the video the post carries |\n| `link` | alias | A text field of the record holding a link (`format: "link"`), carried as the post\'s card |\n| `network` | alias, required | A single select of the entity `expect` links to, saying which network each destination is on |\n| `group` | alias | Another single select of the entity `expect` links to \u2014 the destination\'s kind \u2014 the lines stand grouped by: each option a heading in the select\'s order, a group holding no ticked line folded to its heading and its count, destinations holding no option last |\n| `networks` | map of alias \u2192 `"facebook"` \\| `"instagram"` \\| `"threads"` \\| `"x"` \\| `"linkedin"`, required | That select\'s options, each by its alias, to the network whose feed the post is previewed in \u2014 facebook, instagram, threads, x, linkedin. An option not named has no feed to imitate: its words read as a plain card |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.post` | A child List with `layout: { desk }` needs `expect` on a one-row link \u2014 never a select, nor with `under`, `pick`, a checklist layout, `compare` or a `create` list, its line made by a tick from its key alone: its `bodies` are plain text fields of the record a person writes, drawn nowhere else on it; its `text` is a text of the child, stored or a formula yielding text \u2014 a formula reading only stored values of its row, lookups through the link back to the record or through `expect`, and formulas of the row over those, never the clock; its `media` a files field of the record and its `link` a text field of the record; its `network` a single select of the entity the link names, and `networks` holds options of that select, by alias, each to one of facebook, instagram, threads, x, linkedin; its `group` is another single select of that entity. |\n\n<!-- generated:end layout-desk -->\n\n## Record node\n\nA Record draws what a row opens: the head, then the parts.\n\n- **The head:** title, subtitle, picture, mark, party, figure and meter, deadlines, description \u2014 the\n table\'s `records` facts, overridden by the Record\'s `row`. `row` changes how the App\'s rows read wherever it lists them, and has nothing to do with arranging a page. The status stands in the head, or the Side where the Side states it, never in a Section.\n- **Where it stands:** a Record stands only in the App\'s `pages`, one per entity, stating its `entity`; every List over\n the entity opens it. With no page for an entity, the platform designs the record\'s Sections from the rows: the fields\n the head does not draw, child Lists, papers and Acts. A stated page stands exactly as written, so it replaces them.\n Under a child List, an absent page is every field of the child except the link back.\n- **Children:** either parts \u2014 `Section`, `Side` \u2014 or, for a one-part record, `Field`, `List`, `Reading`,\n `Statement` and `Act` directly. The two are never mixed. The page of an entity no root List and no Sheet\'s List (one stating no `app`) is over \u2014 a\n child List\'s, a document\'s or a roster cell\'s \u2014 holds `edit`, Fields, Sections of them with the Acts and the Lists of\n their rows\' own children, and the Lists of its rows\' own children; a row opened in place draws each Section under its\n title, an Act no Section holds at the last Section\'s foot, and a page with no Section its one section. Such a page\n holds what any page holds \u2014 a Reading, a Side \u2014 and one stating a Side opens its rows\n by its `door` instead of in place; any other `door` there is not drawn and stays stated.\n\n<!-- generated:start node-record -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The table whose rows open on this page: a page stands once per entity, in the App\'s `pages`, and every List over the entity opens it |\n| `row` | [Record row](#record-row) | How the App reads this entity\'s rows wherever it lists them \u2014 their line, figure, picture, deadlines and stage \u2014 where it differs from the table\'s `records` |\n| `add` | `false` \\| list of alias (at least one) | What a new row asks where a picker of this entity offers one, anywhere in the App: these fields; `false`: a picker only picks. Absent, the table\'s required fields, its natural key and its title, where the table states a `singular` |\n| `remove` | `true` | Lets a person delete a row reached through a link: true, it offers a Delete; rows a List lists are deleted as that List\'s `remove` says |\n| `door` | `"page"` \\| `"drawer"` | How a row opens, on a page or in a drawer: absent, a page where a part is a step or a Side or there are more than 3 parts, else a drawer |\n| `edit` | `false` | Shows a record nobody changes here: false, nothing it draws is written, a link\'s row of it included |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [Section](#section-node) \\| [Side](#side-node) \\| [Outside](#outside-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly \u2014 never both. Beside either stand Outsides, Checks (guarding this entity\'s Acts and saves) and Acts on one row, each placed at the foot of the part whose step it moves into, a correction in the head\'s \u22EF. Holding only Acts, Checks and Outsides, or absent, the record\'s Sections are the platform\'s: the fields the head does not draw, child Lists, papers and Acts. Otherwise it stands exactly as written |\n\n#### Record row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `title` | [Record row title](#record-row-title) | The row\'s title field, stated for its `edit` alone |\n| `subtitle` | list of (alias \\| [Record row line field](#record-row-line-field)) (1\u20132) | Up to two fields read under the title, in place of the table\'s |\n| `figure` | alias \\| `false` | The one number a row stands for, in place of the table\'s; false, none |\n| `image` | alias \\| `false` | A files field that pictures a row, in place of the table\'s; false, none |\n| `due` | list of alias (at least one) \\| `false` | Dates that count down, in place of the table\'s; false, none |\n| `status` | `false` \\| `{ "edit": true \\| false }` | Whether this app shows and moves the stage: false, it is not shown. `{ edit: true }`: the stage is also moved by hand. `{ edit: false }`: nobody moves it in this app, another app does. Absent, the stage stands in the record\'s head, or in the Side where the Side states it: choosing a move runs its Act, asking and refusing as its button does |\n\n#### Record row title\n\n| Key | Type | Meaning |\n|---|---|---|\n| `edit` | `false` | Keeps a row\'s name as it stands: false, the title is read; absent, it is written where the table lets a person write it |\n\n#### Record row line field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n\n<!-- generated:end node-record -->\n\nThe door is a page where a part is a step or a Side, or where there are more than 3 parts; else a drawer. `door`\nis a judged choice of how a job is worked (one after another over a long record), so it is kept. From three parts on, the\nrecord shows one at a time: a press on a page\'s rail (a strip of the same names on a phone and in a drawer) flips to a part and returns\nto the top. It opens on the part the address names, else the step that is now, else the first. A part\'s rows and drafts are kept\nacross flips. With fewer parts they stack.\n\nA record shows no activity and no audit log: a history an app shows is table-backed \u2014 `records.status.dates`, `records.status.history`, an event table an act\nmakes \u2014 stated where the app shows it.\n\nA field may be stated in any number of parts, and each part draws what it states. Where parts stack it stands once: in the\nstep that is now if that step states it, else the first part stating it. A Section or a List with `when` is\ndrawn only while each named select of the record holds one of its options.\n\n## Section node\n\nA titled part of a record, and optionally a step of its path. A Section draws its Fields, Lists, Readings,\nStatements and Acts in reading order; its Acts stand at its foot.\n\n<!-- generated:start node-section -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The part\'s heading |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `at` | list of alias (at least one) | Options of the record\'s status during which this part is the work now: a step of its path |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own |\n\n<!-- generated:end node-section -->\n\n#### Kinds of block\n\nWhat a Section draws beside its Fields is a block, of the kind its item states: a List a rows block, an outline where its table holds rows under rows, an agenda or a timeline by its layout, or a list that only reads; a Field a gallery of files or a prose block; a Statement and a Reading each its own.\n\n<!-- generated:start block-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `rows` | Rows list a record\'s child rows under it, each a line in the register\'s row anatomy: a List standing in a Section, its rows linked to the record, narrowed by its `where`, opened in place, their Acts in each row\'s \u22EF; rows that hold pictures are cards, each led by its picture. A child List draws as rows unless its layout says otherwise; a `checklist` reads the rows as checks, a `desk` as the places the record is sent and a `gantt` as bars on an axis of time (the register\'s, over the rows the record\'s link names). |\n| `outline` | An outline draws a record\'s child rows as a tree where their table holds rows under rows (a task under a task, a part of a part): the top rows first, each row\'s sub-rows read when it is opened, with the count of them, closed of all, beside its name; a row adds a row under itself from its \u22EF. A List the reader narrows, orders by a header, groups or searches draws as plain rows. |\n| `agenda` | An agenda reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its picture and the day that is today marked. The day is the first date on the child\'s row line; within a day entries follow a datetime there, else the first single select after the date. An entry with no day yet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading counts from it (Day 1, Day 2). |\n| `timeline` | A timeline reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds entries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each move. A timeline\'s moment is its child\'s first date, and who its member field. |\n| `files` | Files draw a run of the record\'s files fields as one gallery under a heading, each field\'s files as thumbnails with a drop zone to add to them. A files field, or a lookup of one, draws as a gallery unless its Field states `block: false`. |\n| `text` | Text draws one of the record\'s markdown fields as prose under a heading, edited in place where the app writes it. A markdown field draws as prose unless its Field states `block: false`; plain text is a control among the part\'s fields unless it states `block: true`. |\n| `choices` | Choices draws one of the record\'s multi-selects as a checklist under a heading: every option on a line of its own, ticked where the record holds it, ticked and unticked in place where the app writes it. A multi-select is a control among the part\'s fields unless its Field states `block: true`. |\n| `linked` | Linked draws the row a link of the record to one row names, whole and in place, as its page draws it \u2014 its fields, parts, Lists and Acts, read and written as that row\'s own \u2014 under a heading. A link draws as its row\'s chip unless its Field states `block: true`. |\n| `figures` | Figures draw numbers of the record (1 to 8) as tiles, each under its field\'s label. A tile holding nothing reads as not measured, never 0. |\n| `statement` | A statement builds one figure from figures of the record: each line a number of it with its operator and its label, the figures on one right edge, the last an `equals` drawn heaviest (a claim\'s payable, an invoice\'s total, a payslip\'s net). A line may carry the rows its figure adds up (`parts`), each listed under it. |\n| `reading` | A reading block draws a Reading over the child rows under the record, through their link to it: a number, a split into parts, a trend, a grid, a shortfall against stock, or the work against its plan. It stands in the record\'s strip beside the record\'s own figures. |\n| `list` | A list shows rows of another entity beside the record, read only: those linked to it, a path through a row of their own, or \u2014 with `same` \u2014 the siblings sharing a link of the record, the record itself left out. Each row reads in its `records` anatomy with the `columns` after its title, and opens on its page. |\n| `funnel` | A funnel counts steps people drop out of between, a column of each child row a step (2 to 8): one funnel over the rows under the record \u2014 each step its column summed, its bar over the first step, the share kept between two steps and from the first to the last. |\n\n<!-- generated:end block-kinds -->\n\n- **`at`** names the stage options during which the section is the work now \u2014 only on a record that\n truly moves through those stages: the rail marks it done, now or waiting, and it may hold nothing, its title being the step;\n one that is now and holds nothing says so. Two Sections at one option are both the work there, and the first opens. A step\n never hides a field, locks it or gates an act: fields stay writable as the write rules and checks allow, at any stage.\n- **Acts:** every Act on a record stands in the Section whose work it is. An Act moving the stage and offered at ONE step\n stands at that step\'s foot when it moves the work forward, to an exit later in the stage\'s options, or back to a step the\n work passes anyway; one offered at several steps, or moving back into a detour, stands in the Section it enters. One stated elsewhere stands there, and the answer says so. A\n correction (`danger`, and not one of its step\'s outcomes) waits in the Section heading\'s \u22EF.\n- **A detour** \u2014 a stage the work only steps aside into from one step and leaves only back to it (a pause, a repair) \u2014\n stands before that step, its option and its Section alike.\n- **An exit** stands only once the record is in it, its reason there and its rail item apart from the path; until then the\n Act waits in the header\'s \u22EF.\n- **A document:** a Section that is no step and holds nothing but one `text` block over a markdown field reads as a document: the field is written in place with no box, saved when the writer leaves it, and the record reads in an article column while that part is in view.\n- **Writes:** its Fields and its Acts.\n\n## Side node\n\nThe one part drawn beside the rest \u2014 the photos looked at, the pool picked from, the facts kept in view. It stands on the\nright, beside the rail and the parts; on a phone it is one pinned line that opens in place. At most one Side to a record, on a page\ndoor.\n\n<!-- generated:start node-side -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The part\'s heading |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own |\n\n<!-- generated:end node-side -->\n\nIt holds what a Section holds. A field it states, the status included, leaves the head and stays on list rows; the title stays in the head. Writes: its Fields and its Acts.\n\n## Outside node\n\nWhat one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it. A member\npresses Create link on a record while its status stands in `at`; the link opens that one record until it expires, is\nrevoked, or its act moves the status out of `at`. The person sees the stated Fields and Lists and presses the stated Acts\nand nothing else. It stands directly in the Record of a table with a stored status select, whichever List over it opens the page.\n\n<!-- generated:start node-outside -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique in the app: a link to the record names it. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The heading of the page the person without a seat opens |\n| `description` | text | A line under the heading |\n| `at` | list of alias (at least one), required | Options of the record\'s status during which a link to it opens; none is owned by a stage, and each Act moves the status out of them |\n| `children` | list of (alias \\| [Field](#field-node) \\| [List](#list-node) \\| [Act](#act-node)) (at least one), required | Exactly what the link shows and allows: Fields read as values, Lists of child rows read as they are, and the Acts the person may press, each moving the status out of `at` |\n\n<!-- generated:end node-outside -->\n\n- **Fields** are read as values, in order; a lookup, a rollup or a formula is computed for the link only if stated here.\n A Field states nothing but its alias.\n- **Lists** read the child rows under the record as they are: `columns`, `label` and `where`.\n- **Acts** are the link\'s alone: no member, visitor or agent presses them. Each states `key`, `label`, `confirm`, `when`,\n `requires`, `asks`, `set`, `template` with `into`, or `sign`. `when` absent is the status held in `at`; `set` moves the\n status to an option outside `at`, so each press ends the visit. `asks` are text, numbers, dates or listed options. A\n `sign` is by a text field the signer types, with no witness: the link is the attestation.\n- `at` names options no stage owns, and no two Outsides of a table open during the same option.\n- **Writes:** its Acts, and nothing else.\n\n## Tab node\n\nA Tab is one view of a List\'s rows over a period: a register reporting a period \u2014 what stands at its end beside what came and went during it (the stock,\n the hires out, the tickets open) \u2014 reads its rows as Tabs over one `period` the reader picks above them. A Tab holds\n the rows `dated` within the period, those `open` at its end, or lists every row and draws what a child\'s rows came to\n in the period (`totals`). A Tab narrows its rows and holds no nodes; Readings stand beside it in the List and read the\n open Tab, or the one their `tab` names. Never date chips set by hand, and never a Tab per stage, which the chips split.\n Readings and Lists read apart from a List\'s rows stand on a Sheet, a View of the App\'s own.\n\n<!-- generated:start node-tab -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among its siblings; part of the node\'s address |\n| `label` | text, required | What the tab holds, in the reader\'s words |\n| `dated` | alias | A date: the tab holds the rows dated within the List\'s period |\n| `open` | [Tab open](#tab-open) | The tab holds the rows open at the period\'s end: begun, and not yet ended |\n| `totals` | [Tab totals](#tab-totals) | Each row\'s figures over a child\'s rows in the period |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order this tab\'s rows read in; absent, the List\'s |\n\n#### Tab open\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | alias, required | The date a row begins on |\n| `to` | alias, required | The date a row ends on, empty while it is open |\n\n#### Tab totals\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | An entity of this app whose rows each belong to one row of the register\'s entity: the rows the columns add |\n| `on` | alias, required | A date of the child placing each row in time: stored, a formula yielding a date, or a lookup of a date through a one-row link \u2014 never a moment or a span of days |\n| `columns` | list of [Totals column](#totals-column) (1\u20136), required | The figures drawn in place of the register\'s columns after each row\'s name, each under its own alias and label |\n\n#### Totals column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | The column\'s name: its address in the totals read |\n| `label` | text, required | What the column holds, in the reader\'s words |\n| `value` | alias \\| `{ "avg": alias }` | A number of the child (stored, a formula or a rollup) summed over the rows, or `{ avg }` averaged over the rows holding one, a window holding none drawing blank; absent, the rows are counted. A figure read in each row\'s own unit or currency stands only where the child\'s select is a lookup, through `via`, of a single select of the register\'s entity |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | Only the child\'s rows whose select holds one of these options, or whose yes/no is this value \u2014 every entry ANDed |\n| `window` | `"before"` \\| `"in"` \\| `"through"`, required | Which of the child\'s rows, by `on`, the column adds: `before` those dated before the period\'s first day, `in` those from its first day through its last, `through` those on or before its last day |\n\n#### Period days\n\n| Key | Type | Meaning |\n|---|---|---|\n| `days` | integer, required | How many days through today, at most 366 |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.tabs` | A List\'s Tabs each have a `key` of their own, none the entity\'s alias or one a report template holds (`title`, `lines`, `readings`, `at`, `dates`, `period`, `per`); a Tab states one of `dated` and `open` (dates of its rows, `open`\'s two different) or `totals` (a child\'s rows windowed by the period); its `where` and `sort` hold as the List\'s do, and never narrow by the status, which its chips split. Only a table or cards List has Tabs, and a Reading\'s `tab` names one of them. A `period` opens a List on a window: over a table or cards a Tab that states `dated`, `open` or `totals` reads it; a calendar or a lanes board opens on `"today"`, `"week"` or `"month"` (a lanes board of hours, on `"today"`); no other layout draws one. Wrong: `period: "year"` over a table with no dated Tab. Right: add `{ "type": "Tab", "key": "this_year", "label": "This year", "dated": "sold_on" }`, or drop `period`. |\n| `list.tab-totals` | A Tab\'s `totals` name a child linked to the List\'s entity by a one-row link (a child linking the List\'s entity twice cannot be totalled), a date of the child, never a moment or a span, and 1 to 6 columns each under its own alias and label; a column\'s `value` is a number of the child, its `where` holds over the child\'s selects and yes/nos, and a value read in each row\'s own unit or currency stands only where that select of the child looks up, through its link, a single select of the List\'s entity, and the child links to no source\'s rows. A source\'s rows are totalled by the child\'s one link to them, by one field to one row; a source the child links to not at all totals nothing on its rows (`list.source-lacks`). Only a table List has them, and no Tab states `totals` beside `dated` or `open`. A column sums a number or counts rows, never `{ avg }`. |\n\n<!-- generated:end node-tab -->\n\nA `totals` Tab adds, per column, the child\'s rows `before` the period\'s first day, `in` the period, or `through` its last\nday, so `before` plus `in` of one value is its `through`:\n\n```json\n{\n "type": "Tab",\n "key": "items",\n "label": "Items",\n "totals": {\n "rows": "ledger_line",\n "on": "moved_on",\n "columns": [\n { "alias": "opening", "label": "Opening", "value": "quantity", "window": "before" },\n { "alias": "received", "label": "Received", "value": "quantity", "where": { "kind": ["receipt"] }, "window": "in" },\n { "alias": "issued", "label": "Issued", "value": "quantity", "where": { "kind": ["issue"] }, "window": "in" },\n { "alias": "closing", "label": "Closing", "value": "quantity", "window": "through" }\n ]\n }\n}\n```\n\n## Sheet node\n\nA Sheet is a grid of Readings and Lists over the App\'s rows in its `period`: each Reading a figure, each List the rows it lists. An App of one Sheet opens on it; an App of several draws a strip that picks one.\n\n<!-- generated:start node-sheet -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among the App\'s Views: the sheet\'s address, `/<key>` |\n| `label` | text, required | What the sheet holds, in the reader\'s words: its name among the App\'s Views |\n| `children` | list of ([Reading](#reading-node) \\| [List](#list-node)) (at least one), required | The Readings and Lists the sheet draws as a grid, in reading order: each Reading a figure over the App\'s rows in the App\'s `period`, each List the rows it lists |\n\n<!-- generated:end node-sheet -->\n\n## Field node\n\nA Field draws one field of the record it stands in. How it is drawn follows from the field\'s type and the table\'s facts:\n\n- a control or a value, with its notation, money, units and deadline countdown;\n- a files field as pictures and documents, a long or markdown text as prose written in place \u2014 a gallery or a prose block,\n with a heading (`label`) and a condition (`when`) of its own; a run of files Fields is one gallery;\n- a link as its row\'s chip, with a picker narrowed by `options_where`, offering a new row where the linked table\'s page\n states `add`;\n- the back side of a child\'s link as the rows filed under the record;\n- the fields an Act\'s `sign` writes as one signature.\n\n<!-- generated:start node-field -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n| `label` | text | The heading of the field\'s gallery or prose block, where it draws as one; absent, the field\'s label. A run of files fields takes the first one\'s |\n| `block` | boolean | Gives a field room of its own: true, a files, text or multi-select field draws as its own gallery, prose or checklist block, and a link to one row as that row drawn whole in place, as its page draws it; false: as a control among the part\'s fields. Absent, files and markdown fields draw as blocks, plain text, a multi-select and a link as a control |\n| `when` | [condition](#app-tree) | A gallery or prose block is shown only while the record\'s selects hold these options, its yes/nos these values, its numbers and dates meet their bounds and its `{ "empty": true \\| false }` fields are blank or filled |\n\n<!-- generated:end node-field -->\n\nA field drawn in the head (title, subtitle, picture, figure, stage) is never also a Field node. A Field is drawn once per\npage. **Writes:** the field, under \xA7 App tree; a picker\'s add is the linked table\'s page\'s `add`.\n\n## Fieldset node\n\nA Fieldset heads a run of a part\'s Fields with a few words of its own: the facts of one kind among a part\'s many (a\nvehicle\'s plate, make and seats under "Vehicle"). It stands among a Section\'s or Side\'s children, or a one-part\nRecord\'s, and holds Fields alone \u2014 two or more, each drawn as a control, each in one Fieldset. A Field in it reads and is\nwritten as it would be in the part. A gallery or prose Field stands beside it, never in it.\n\n<!-- generated:start node-fieldset -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text, required | The heading over the facts it holds, in the reader\'s words |\n| `children` | list of (alias \\| [Field](#field-node)) (at least 2), required | The Fields drawn under the label, in the order stated; each reads as it would in the part |\n\n<!-- generated:end node-fieldset -->\n\n## Act node\n\nAn Act is a verb, stated whole where it stands. Its place decides what it works on:\n\n- in a Section or Side, or in a one-part Record: one record, at that part\'s foot;\n- in a List, with `on`: the ticked rows or every row in view, each checked before any is written;\n- directly in a Record that holds parts: refused.\n\n<!-- generated:start node-act -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The act\'s name; its workflow is `act_<key>`, or the `workflow` it names |\n| `label` | text, required | The verb, as the reader says it |\n| `when` | [condition](#app-tree) | The act works only while this holds |\n| `requires` | list of alias (at least one) | Fields filled first, each drawn where the act stands |\n| `recommends` | list of alias (at least one) | Fields it runs without and reads when filled |\n| `asks` | list of (alias \\| `{ "field": alias, "starts": "today" \\| "me" }` \\| [Asked input](#asked-input)) (at least one) | What the reader states on pressing: fields of the row (written by the act) or inputs; a `link` input\'s picker adds as its entity\'s page `add` says |\n| `set` | map of alias \u2192 [value](#app-tree) | What the act writes; each field is read-only elsewhere in the app |\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }` | Who presses it: a member field of the row, `link.field` read through a one-row link, or `{ group }` by id. Absent, the owner of the stage it is offered at, or anyone the app is shared with where it stands at none |\n| `workflow` | alias | The workflow it runs for what `set` cannot say: one made under this name, its body set by `set_workflow`, or the app\'s Workflow node, taking the row as `record_id`; the act\'s guards head its body |\n| `template` | alias | A document template it makes a file from: html a PDF, excel a workbook, word a .docx; over several rows, one file of them all |\n| `templates` | list of [Act template](#act-template) (at least 2) | Several papers made into `into`, instead of `template`: the reader ticks which |\n| `into` | alias | The record\'s files field keeping the document; remade, it replaces its own last paper, never a person\'s file |\n| `paper` | text | Its paper, `<child>.<kind>`: the line of the record\'s papers it stands on |\n| `intake` | alias | A child the record lists whose rows are its papers: the press takes papers, an agent reads them, each filed as a row of it. With `on: "view"`, they make a new record of the List\'s entity, and the save opens it |\n| `fills` | list of text (at least one) | With `intake`, what the papers may fill: a field of the record, `<link>.<field>` on the row a required one-row link names, or a child they add rows to; on a new record that row is found on its entity\'s `natural_key` or added. With `record`, fields of the new row an agent fills from the transcript |\n| `record` | [Recording](#recording) | The press records a call, visit or meeting, filed as a new row of a child the record lists |\n| `sign` | [Signature](#signature) | The press opens a pad; the act keeps the signature as a picture with who signed, when and the witness |\n| `review` | `true` | Lets a person approve what a workflow would write: with `workflow`, it only proposes a changeset of the act\'s table, and the reader ticks the rows to write |\n| `confirm` | `true` \\| text | The press asks first: the question, or `true` for the act\'s label over the row |\n| `danger` | `true` | The act destroys or cannot be undone |\n| `on` | `"ticked"` \\| `"view"` | Which rows an Act over a List works on: `ticked`, those ticked in the List holding it; `view`, every row in view. Every Act a List holds states it, and no other |\n\n#### Asked input\n\n| Key | Type | Meaning |\n|---|---|---|\n| `input` | alias, required | A value the act asks for that is not a field of the record |\n| `label` | text, required | What the reader is asked, in their words |\n| `type` | `"text"` \\| `"long_text"` \\| `"number"` \\| `"date"` \\| `"select"` \\| `"link"` \\| `"member"` \\| `"file"`, required | What the reader states. A `file` is one uploaded file, handed to the act\'s authored `workflow` as its file id and read by nothing else |\n| `options` | list of [Select option](#select-option) (at least one) | The choices a `select` input offers, one picked \u2014 written into a select holding the same option aliases |\n| `entity` | alias | The entity a `link` input picks one row of |\n| `accepts` | list of `"sheet"` \\| `"pdf"` \\| `"document"` \\| `"photo"` (at least one) | The kinds of file a `file` input takes; absent, a sheet, a PDF or a document \u2014 a phone offers its camera only where `photo` is among them |\n| `required` | `true` | The act is refused without it |\n| `default` | alias | A field of the row whose value the input starts from, still changed at will |\n\n#### Set formula\n\n| Key | Type | Meaning |\n|---|---|---|\n| `formula` | text, required | A formula over the acted row\'s fields, `{alias}` each, read as the entity\'s own formulas read them |\n\n#### Act template\n\n| Key | Type | Meaning |\n|---|---|---|\n| `template` | alias, required | A document template made into `into` |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | The paper starts ticked while each named select of the record holds one of these options and each named yes/no (stored, or a formula \u2014 how a multi-select is tested: `includes({needs}, {needs:x})`) is this value \u2014 a suggestion the reader changes, never a refusal; absent, it starts ticked |\n\n#### Recording\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | A child the record lists in a timeline or rows block, linking back by a single link: each recording is a new row |\n| `audio` | alias, required | The child\'s files field the recording\'s audio is kept in |\n| `transcript` | alias, required | The child\'s text field the transcript is kept in, a speaker\'s turn per line |\n| `video` | alias | The child\'s files field the screen is kept in, where the recording captured it |\n| `at` | alias | The child\'s date field stamped with the moment the recording started |\n| `by` | alias | The child\'s member field set to the person who recorded |\n\n#### Signature\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | The record\'s files field the signature is kept in, as a picture \u2014 each signing replaces the one before |\n| `by` | alias, required | Who signed: a text field the signer types into (someone with no seat), or a member field set to the person pressing |\n| `at` | alias, required | The record\'s date field stamped with the server\'s time as the act runs |\n| `witness` | alias | Beside a text `by`, the member field set to the person pressing, who saw the signer sign |\n\n<!-- generated:end node-act -->\n\nAn Act whose `when` does not hold is not offered. One whose `requires` are empty is offered disabled, naming each; one whose\n`recommends` are empty names what it will leave blank and still presses; one a standing Check blocks is offered disabled in\nits words. The `act_<key>` workflow re-checks all three on the server, writes `set` and what was asked,\nand appends the status history. A field an act both `requires` and `asks` never disables the press. A field an Act `requires` draws in its part with no statement. An Act in a child List may `sign` the row pressed.\n\n- **Writes:** every field it sets, asks, files into, signs or records is the act\'s.\n- **Papers.** A button that makes a paper is `template` (or `templates`) with `into` and no workflow, made from the row as the act left it. `templates` keeps a paper not made yet as a placeholder, and the set downloads as one archive (`archive_<key>`). `into` files the paper in the row\'s own files field, a write of the row its table\'s lock refuses; a `paper` line is a row of its own, made on a locked record. `intake`: what the papers state of each field `fills` names is shown beside what the row holds, and the save writes only what differs. `sign`: the record reads `into` as one signature, and the act\'s paper is handed the picture under `into`\'s name (`{{#each signature}}<img src="{{url}}">{{/each}}` in an html template).\n- **`review: true`:** the workflow (`workflows`) reads and returns a changeset of the act\'s table in `data.review`; the rows the reader ticks are written each checked first, all or none. Over every row in view the act is handed no rows.\n- **A `when` that compares** splits one stage by an amount or a date with no formula field behind it; the server refuses a press the row does not meet, and a blank number or date meets no bound:\n\n```json\n{ "type": "Act", "key": "approve", "label": "Approve", "when": { "status": ["submitted"], "amount": { "lte": 5000000 } }, "set": { "status": "approved" } }\n```\n\n```json\n{ "type": "Act", "key": "gate_in", "label": "Make the gate-in EIR", "template": "eir_in", "into": "eir", "sign": { "into": "driver_signature", "by": "driver_name", "at": "signed_at", "witness": "signed_before" } }\n```\n\n## Check node\n\nA Check is a yes/no or text formula of the row of the Record page it stands in (`pages/<entity>`): it stands while true or non-empty, and a text\nformula\'s words are what the reader sees. Without `on` it only warns; with it, it refuses the saves and acts it names, on\nthe server, in every write it names.\n\n<!-- generated:start node-check -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A yes/no or text formula of the page\'s entity: true or non-empty means the check stands |\n| `on` | `"all"` \\| list of (`"update"` \\| alias) (at least one) | What the standing check refuses: `update` is the rows\' saves, an Act key is that Act \u2014 on one row, or over a List\'s rows of this entity \u2014 and `all` is every Act and save; absent, it only warns |\n| `resolve` | alias | An Act on one row of this entity that clears it |\n\n<!-- generated:end node-check -->\n\n`update` is the rows\' saves; an Act key is that Act, on the same rows; `all` is every act and save.\nA rule that refuses a Delete is a check of the table, not a Check: state it in the table\'s `checks` with `on: ["delete"]`\n(\xA7 Write rules), where it holds for every way a row is deleted and a removal that cascades to child rows is refused whole.\nA Check stands on each row of its page\'s entity wherever the App lists or opens it \u2014 a root List\'s, a child List\'s, a\nsource\'s \u2014 and refuses the acts and saves it names, an Act over a List\'s rows of the entity included. A warning reading the figure of a meter that `gates` marks against its\nbound or its pass mark is refused: the meter already draws it.\n\nThe check field\'s `label` is its short name \u2014 "Over budget", "Release expired": a row\'s line says it in the check\'s tone\n(the most severe of several, and how many more), while its words whole are the row\'s tooltip. Label it as the reader names\nthe problem, in a few words, and let a text formula say the sentence. A check with no `resolve` links to the first field its formula reads that the record draws.\nA yes/no formula whose yes needs attention (papers the customer still owes) is a Check: its yes reads in the warning tone\nwherever it is drawn, every other yes in the success tone \u2014 and the row\'s line says it, so it is no column of the List too.\n\nA Check that every app over a table states the same way restates the table\'s contract and belongs in the table\'s `checks`\n(\xA7 Write rules).\n\nA Check refusing `update` (or `edit: false` on a record, part or field) makes the rows read-only in this app alone, drawn\nunder the read-only mark, never as a lock. A lock is the table\'s: a table workflow, a person, or an Act whose workflow sets `locked: true` on `update_records` locks a row, and every door refuses its writes until a table manager unlocks it \u2014 `update_records` with\n`locked: false` in an app\'s run is judged as the member who pressed. A locked row reads locked in every app: its lock mark, its fields as values\nunder one line naming who can change it, its saves, Delete and each Act writing it refused \u2014 an Act that writes\nelsewhere, makes a paper it hands back, or unlocks it stays its workflow\'s to answer.\n\n## Reading node\n\nA Reading is a number over rows: one figure, its parts, a grid, a figure per period, steps; or a record\'s own figure. The\npicture is the runtime\'s, chosen from what the reading means \u2014 no prop picks a chart. The question is stated by which\nsplit it names:\n\n| Names | Answers |\n|---|---|\n| nothing | one figure: the rows counted, or `value` summed, `{ "avg": \u2026 }` averaged |\n| `by` | the figure per value of a select, one-row link, member or yes/no, or per band of a number\'s `tiers` |\n| `by` a date field | the figure per period (a trend); `ahead: true` reads forward over the rows still to come |\n| `by` and `across` | a grid, `by` down the side and `across` along the top |\n| `steps` | a funnel: 2 to 8 number fields summed, each kept as a share of the one before; in a record only |\n| `planned` and `done` | the work against its plan, day by day: a List\'s band over a folder, or a record\'s block, never a Sheet |\n| no `entity`, in a Record | the record\'s own `value`, a tile under its field\'s label; up to eight consecutive tiles draw as one strip |\n\n<!-- generated:start node-reading -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The reading\'s query name, unique in the app. Absent, the label\'s words as a slug, else its kind and field, written once and kept |\n| `label` | text | What the figure is called: absent, a split\'s `by` field\'s label, a trend\'s summed `value`\'s (else the rows\'), a grid\'s two fields\'; one figure states its label; with `planned`, always stated |\n| `entity` | alias | The List\'s rows; in a Record, the child\'s rows under it; absent in a Record with no `by`: the record\'s own `value`; with `planned`, the rows that are the parts of the work, always stated |\n| `via` | alias | The child\'s link to the record, where it has several |\n| `value` | alias \\| `{ "avg": alias }` | A number field summed over the rows, or `{ avg }` averaged over the rows holding one; absent, the rows are counted |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | Splits the rows into parts; a date field splits them per period |\n| `across` | alias \\| [Tiered filter](#tiered-filter) | Reads a split against a second field: with `by`, the columns of a grid |\n| `over` | alias | The date that places a row in time |\n| `ahead` | `true` | Shows what is coming, not what has been: with a date `by`, the current period and those after it |\n| `steps` | list of alias (2\u20138) | Number fields summed, each a step of a funnel |\n| `on_hand` | [Reading on hand](#reading-on-hand) | With `by` (and `across`): the Reading\'s rows are what is owed, per value of those fields; drawn beside what is on hand per the same values, and the shortfall |\n| `target` | number | The number the figure is read against; absent, its bound, where the table states one |\n| `better` | `"up"` \\| `"down"` | Which way is good, for the figure\'s tone; absent, read from the figure\'s shape |\n| `planned` | [Reading planned](#reading-planned) | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | With `planned`, the work against its plan: a percent field of the row the server computes, its share done today (0\u2013100) |\n| `finished` | alias | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `tab` | alias | The Tab it reads, else the open one |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Reading on hand\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The entity whose rows are what is on hand, all of them |\n| `value` | alias | A number field summed over those rows; absent, the rows are counted |\n| `by` | alias | The field of this entity matching the Reading\'s `by`; absent, the same alias |\n| `across` | alias | The field of this entity matching the Reading\'s `across`; absent, the same alias |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n\n#### Reading planned\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of the row: the first day of its planned work |\n| `end` | alias, required | A date of the row: the last day of its planned work |\n\n<!-- generated:end node-reading -->\n\n#### Kinds of reading\n\n<!-- generated:start reading-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `metric` | A metric is one number over an entity\'s rows: how many, or the sum or average of a number field. It is read against a target, or against the bound its `limits` states; placed in time by `over`, it shows its change over the recent periods and which way is good (`better`). |\n| `breakdown` | A breakdown splits an entity\'s rows into parts: each row is counted, or its number summed, under the one value of the field it is split by \u2014 a select\'s option, a linked row, a person, yes or no \u2014 or under the band of a number cut by `tiers`. |\n| `trend` | A trend counts an entity\'s rows, or sums a number of them, per period of the date that places each row in time (`over`) \u2014 the periods up to today, or with `ahead` the current one and those after it, over the rows dated today or later. |\n| `pivot` | A pivot crosses two splits in a grid: each row of the entity is counted, or its number summed, under the pair of values it holds \u2014 one down the side (`rows`), one across the top (`columns`). |\n| `shortfall` | A shortfall sets what is still owed against what is on hand: the owed rows are counted, or a number of them summed, per value of the fields they are for (`by`, and `across`), beside every row of the stock (`on_hand`) matching those fields, with what falls short. |\n| `progress` | A progress reads the work against its plan: each row is a part of the work, planned over the days between two of its dates and done by a share the server computes, set against the plan day by day. Each row weighs its planned days. |\n| `list` | A list shows an entity\'s rows, each in its `records` anatomy \u2014 its title, its line, its status \u2014 with the fields read after the title (`columns`). |\n\n<!-- generated:end reading-kinds -->\n\nWhere a Reading stands decides which rows: a Sheet\'s every row, a List\'s rows in its open tab and folder (the search,\nthe status and the filters narrow the rows and leave the figures as they stand), a Record\'s the child\'s rows under the record. A Reading counts its rows, or sums the number\n`value` names \u2014 never a percent. `over` is a date, the row\'s own or its parent\'s through a lookup: a trend\'s periods, a\nfigure\'s recent periods, and what a Sheet\'s period windows. `where` keeps rows whose select holds one of the options, or\nwhose yes/no is the value, every entry ANDed \u2014 a band leads with the job\'s exception as a formula\'s yes/no (what is\nshort), never a stage the chips already count nor the overdue rows the register\'s summary line counts from `records.due`.\n\n- **A figure\'s change** is green where it moves the good way: a sum\'s rise, a count kept by `where` falling; `better` states\n the other way where that reads wrong (money going out). A value `limits` bounds reads against the sum of its bound\n (`10 / 14`); `target` reads one against a number nothing bounds.\n- **An average** is its sum over the rows that hold a value, divided by how many hold one; a row holding none is no part\n of it, and where none holds one the figure reads a dash, never 0. Under a Sheet\'s period it is the average over the\n period so far, never a sum of averages. A share is an average too: a number formula that is `100` on the rows that count\n and `0` on the others, in percent notation, averaged. Only a single figure averages.\n- **Bands.** `by` and `across` each take, in place of a field, a number by its `tiers` \u2014 `{ "field", "tiers" }` \u2014\n splitting the rows by the bands those breakpoints cut: `[1, 31, 61]` over days late reads not due, 1\u201330, 31\u201360 and over\n 60, the aged report. Every band is drawn in the bands\' own order, one holding no row at zero; rows holding no number\n stand apart. On a List a band is a door: a press narrows the rows to it. In a List\'s band, a split by one or two\n breakpoints stands in it, and one by three or more stands whole under it.\n- **In a List,** Readings stand under the title in one compact band: the job\'s headline number first, then at most the mix\n and the movement. A picture stands only where it splits the rows in view into two parts or more, one holding two rows or\n more. The summary line already totals the figure and the chips count the rows, so a figure summing the figure, or counting\n the rows of a table with a stage, is refused unless its `where` narrows it.\n- **Name.** A Reading\'s `key` is the query it is read by (`run_app_query`).\n- **The work against its plan** (`planned` and `done`, `label` and `entity` stated) takes none of a figure\'s props: the\n share of the work planned and the share done, cumulative day by day, today\'s two at its foot. Each row is a part of the\n work, its plan spread evenly over its planned days and weighing its planned days. Its share done today is `done`, a\n percent the server computes; on an earlier day, its `done` from its `finished` day on and nothing before it.\n\n## Statement node\n\nA Statement draws a figure the record works out from its own figures \u2014 a claim\'s payable, an invoice\'s total, a payslip\'s\nnet \u2014 line by line in the order the arithmetic runs: each line a number of the record, the first stating no `op`, the last\nan `equals`. Every figure is a field the server computes or a person writes; the screen adds nothing up. A line\'s `parts`\nlists the rows its figure carries, each read from its own row, and that figure is what they add up to \u2014 a formula, rollup\nor lookup, or the server\'s copy when the record is made (`default_from`), which nothing writes after.\n\n<!-- generated:start node-statement -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The statement\'s name, unique among its siblings. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | What the statement is called: absent, the label of what it comes to |\n| `lines` | list of [Statement line](#statement-line) (at least 3), required | The figures it is built from, top to bottom, ending in the one it comes to |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Statement line\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number of the record \u2014 stored, a formula, a rollup or a lookup \u2014 read on the line after its label |\n| `op` | `"plus"` \\| `"minus"` \\| `"times"` \\| `"equals"` | How the line works on the lines above it \u2014 `plus`, `minus`, `times`, or `equals` for what they come to, a formula, rollup or lookup the server computes; absent on the first line, which the rest work from |\n| `rate` | alias | A percent of the record read after the line\'s label: the rate its figure is taken at (retention at 5 %) |\n| `parts` | [Statement parts](#statement-parts) | The rows the line\'s figure carries, each listed under it with its words and its own figure \u2014 read from those rows, never a copy of them. The line\'s figure is what they add up to, drawn read: a formula, rollup or lookup, or a value the server copies when the record is made (`default_from`) that nothing writes after |\n\n#### Statement parts\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | The entity whose rows the line\'s figure carries \u2014 the record\'s own for the earlier rows of the same thing |\n| `same` | alias, required | A one-link the record and those rows both hold: the rows naming what the record names in it |\n| `at` | alias | A moment (a datetime) of those rows no person keys \u2014 when each was certified: with `before`, only the rows whose moment stands before the record\'s, earliest first; absent with it, every row so named, in their own order |\n| `before` | alias | A moment (a datetime) of the record no person keys \u2014 when it was made: the moment the rows\' `at` stands before; stated with `at` |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `{ "empty": true \\| false }` \\| [comparison](#values)) | Only the rows whose single select holds one of these options, whose yes/no (stored, or a formula) is this value, whose number or date meets its bounds, or whose field is empty or filled \u2014 read so on the server |\n| `columns` | list of alias (1\u20132), required | The rows\' fields read as each one\'s words, in order (its date, its percent) |\n| `figure` | alias, required | The rows\' number each one reads at the figures\' edge, frozen when the row was certified: a stored number an act fills (`{ "formula": \u2026 }` as it runs) or the server copies when the row is made (`default_from`) \u2014 never one a person keys, nor a formula, rollup or lookup the server recomputes |\n\n<!-- generated:end node-statement -->\n\n```json\n{\n "type": "Statement",\n "key": "claim",\n "lines": [\n { "field": "contract_value" },\n { "field": "done_to_date", "op": "times" },\n { "field": "value_to_date", "op": "equals" },\n { "field": "certified_before", "op": "minus", "parts": { "rows": "claim", "same": "contract", "at": "certified_at", "before": "made_at", "where": { "kind": ["work"] }, "columns": ["claimed_on", "done_to_date"], "figure": "certified_value" } },\n { "field": "claim_value", "op": "equals" },\n { "field": "retention", "op": "minus", "rate": "retention_rate" },\n { "field": "payable", "op": "equals" }\n ],\n "when": { "kind": ["work"] }\n}\n```\n\n## Export node\n\nAn Export is a report file of the rows in view: the title, a line per chip, the search and the moment it was exported, the\nReadings, and every row, at most 20,000. With no props, the one Export is the workbook of the List\'s columns, the Readings\non a sheet before the rows. A List states the reports the business sends \u2014 one a button, several one menu \u2014 each a `label`,\na `description`, and a `template` filled with `title`, `lines`, `readings`, `at` (the moment it was made), `dates` (each\ndate filter\'s `from` and `to` by field) and the rows under the table\'s alias (an html one made a PDF, an excel one a\nworkbook). A report\'s `filename` names its file in the template grammar over the same keys but the rows. Where `per` is a\none-row link, `per_row.<field>` reads a text, number, date or yes/no field of the picked row, and `| add_days:<n>` shifts a\ndate by whole days (`n` a number or such a field, empty for none): `Stock {{per}} {{period.to | add_days:per_row.day_offset | format:"dd.MM.yyyy"}}`. A report of some\nrows (`where`), or of one value the reader picks (`per`: one file per value), is made of the List as those chips would\nnarrow it; the screen keeps the chips and rows it shows. A report sent outside the business \u2014 a partner\'s stock, a\nfiling \u2014 is `fixed`: the same file from every screen and device, of what the reader narrowed only the period and the\ndate chips reaching it, never their status, other chips or search.\n\n<!-- generated:start node-export -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The report\'s name, unique in the app. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | The report\'s name; absent on the one Export that stands for the register\'s workbook |\n| `description` | text | What the report is for, in a sentence |\n| `template` | alias | An html or excel document template the report fills, with `title`, `lines`, `readings`, `at`, `dates`, `period`, `per` and `per_row` (a one-row `per`\'s picked row, the fields `filename` reads); absent, the workbook of the List\'s columns |\n| `filename` | text | The file\'s name, at most 500 characters, in the template grammar, over one value each: `title`, `at`, `dates.<field>.from` or `.to`, `period.from` or `.to`, `per`, `per_row.<field>` (a text, number, date or yes/no field of the row a one-row `per` picks), `lines \\| lookup:<n>`; `\\| add_days:<n>` shifts a date by whole days, `n` a number or `per_row.<field>`. Absent, the report\'s label |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `per` | alias | A select, member or one-row link the reader picks one value of: one file of that value |\n| `sources` | list of alias (at least one) | Of the List\'s entity and its sources, the tables the report reads; absent, all |\n| `fixed` | `true` | The same file from every screen: only its `where`, its `per`, the period and the date chips narrow it, never the reader\'s status, other chips or search; absent, the rows in view |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.export-report` | A List\'s Exports each have their own `label`; `per` picks one option, person or one-link row \u2014 never of the status, the folder or a field its `where` fixes. |\n| `list.export-key` | An Export is named by its key alone: no two Exports of an app share one. |\n| `list.export-filename` | An Export\'s `filename` is words and `{{value}}` placeholders, each value one of `title`, `at`, `dates.<field>.from` or `.to` (a date filter of the List), `period.from` or `.to` (a List with Tabs), `per`, `per_row.<field>` (a field of the row a one-link `per` picks) and `lines \\| lookup:<n>`, through helpers that exist and take the arguments given. |\n| `list.export-template` | A template an Export fills reads at its root only `title`, `lines`, `readings`, `at`, `dates` and its rows under the List\'s entity alias \u2014 an entity named none of those \u2014 and is the document of no Act. |\n\n<!-- generated:end node-export -->\n\n## Query node\n\nA Query is a read for agents, never drawn. An app generates a query for everything its screen reads (`agent_surface` lists them); a Query declares one the screen never asks, called through `run_app_query` or the app\'s API: the\ntable whose rows it reads, the fields each row returns, and what narrows them.\n\n<!-- generated:start node-query -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the query answers, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `params` | map of alias \u2192 ([Workflow value](#workflow-value) \\| a typed input (`app_bindings`)) | What a call states, by name: with `rows` or `list`, values a `where` entry reads; with `ast`, typed inputs the ast reads as `{{params.<name>}} |\n| `fields` | list of alias (at least one) | The fields each row returns, by alias: with `rows` or `list`. `ast` states its own |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order the rows return in; absent, the order the entity\'s list reads in |\n| `limit` | integer | The most rows returned |\n| `key` | alias, required | The query\'s name, what `run_app_query` calls; unique in the app |\n| `rows` | alias | The table whose rows it reads, under the app\'s row rule of it and, where the table holds one one-row link to the App\'s `scope`, inside the folder the call states. A Query states `rows`, `list` or `ast`, one of the three |\n| `list` | alias | The key of a root List of the App: the rows read as that List reads them \u2014 its `where`, its folder and its order. A Query states `rows`, `list` or `ast`, one of the three |\n| `ast` | a query tree (`app_bindings`) | The whole read, where `rows` or `list` cannot state it: a join, a union, a group, a window or a computed column. Fields and tables by alias |\n| `templates` | map of text \u2192 a document template (`app_bindings`) | Document templates an export of this query\'s rows may fill, by the name the export asks for. An export names one of these or none; a template it does not declare is refused. |\n| `where` | map of alias \u2192 [condition](#query-node) | What narrows the rows, as a List\'s `where` does: a select\'s options, a yes/no\'s value, a number or date meeting its bounds (`gt`, `gte`, `lt`, `lte`), a field `{ "empty": true \\| false }`, `{ "me": true }` on a member field \u2014 or a value the call states (`{ "param": name }`), or a date or number range of params (`{ "from": \u2026, "to": \u2026 }`) |\n\n#### Query param\n\n| Key | Type | Meaning |\n|---|---|---|\n| `param` | text, required | A param of this query: the condition holds what the call states for it, and is left out where the call states none |\n\n#### Query range\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | [Query param](#query-param) | The param the field is on or after \u2014 a date\'s first day, a number\'s least |\n| `to` | [Query param](#query-param) | The param the field is on or before \u2014 a date\'s last day, a number\'s most |\n\n<!-- generated:end node-query -->\n\n```json\n{\n "type": "Query",\n "key": "fees_unbilled",\n "description": "A customer\'s fees no invoice covers yet, oldest first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "description": "The customer whose fees are read." },\n "since": { "type": "date", "required": false, "description": "Only fees charged on or after this day." }\n },\n "rows": "fee",\n "fields": ["visit", "service", "amount", "charged_on"],\n "where": { "billed": false, "customer": { "param": "customer" }, "charged_on": { "from": { "param": "since" } } },\n "sort": { "field": "charged_on" },\n "limit": 200\n}\n```\n\nAn entry of `where` holds what a Reading\'s `where` holds, or a value the call states: `{ "param": "<name>" }`. A required\nparam is always stated; one stating `required: false` may be left out, and the condition reading it then narrows nothing.\nA query reads under its table\'s read scope, as every read of the app does. A caller counts, sums or averages its rows\nwith `run_app_query`\'s `aggregate`. `set_app` compiles a Query with the rest of the app: no code is set.\n\nEvery Reading of the app is a query too, returning its groups, called by its key. A Tab\'s `totals` read is called by\n`<table>_totals_<tab>` with the period\'s two days, `from` and `to`, both required.\n\nA query reads one table: on an app whose List reads `sources`, it names a source\'s own table, never the\nList\'s. A param compares a field holding one value \u2014 or, as a range, a date or a number \u2014 and never a number read in each\nrow\'s own unit or currency, nor a date holding a span.\n\n## Workflow node\n\nA Workflow is a verb for agents, never drawn: a job no press of the screen starts \u2014 an agent or a service handing the app a\nfile, or a list of rows to reconcile a table against. It states what it takes and what it hands back; a table is named by\nits alias in `tables` and a select by `<table>.<field>`. It is called through the app, by `run_app_workflow` or the app\'s\nAPI. On an app shared by a public link it runs only for someone who holds the app, and a visitor\'s call is refused as an\nalias the app does not have.\n\n<!-- generated:start node-workflow -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the workflow does, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `inputs` | map of text \u2192 [Workflow value](#workflow-value) | What a call hands it, by name \u2014 checked before its body runs |\n| `outputs` | map of text \u2192 [Workflow value](#workflow-value) | What its body returns as `data`, by name \u2014 checked as it returns; absent, read off the body |\n| `key` | alias, required | The workflow\'s name, what `run_app_workflow` calls; unique in the app |\n\n#### Workflow value\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"boolean"` \\| `"date"` \\| `"datetime"` \\| `"email"` \\| `"json"` \\| `"record_link"` \\| `"select"` \\| `"member"` \\| `"file"` \\| `"object"` \\| `"array"`, required | What the value is |\n| `description` | text | What the value is for, read by whoever calls the workflow |\n| `required` | boolean | Lets a caller leave the value out: false; absent or true, it is always there |\n| `multi` | `true` | A `record_link`, `select`, `member` or `file` holding several |\n| `entity` | alias | The entity a `record_link` names a row of |\n| `field` | text | `<entity>.<field>`: the select field whose options a `select` takes, as the field holds them when the workflow runs |\n| `options` | list of (alias \\| [Select option](#select-option)) (at least one) | The values a `select` takes, where no field holds them: aliases, or the objects a field\'s `options` take |\n| `fields` | map of text \u2192 [Workflow value](#workflow-value) | An `object`\'s values, by name |\n| `items` | [Workflow value](#workflow-value) | What each item of an `array` is |\n\n<!-- generated:end node-workflow -->\n\n```json\n{\n "type": "Workflow",\n "key": "reconcile_fees",\n "description": "Reconciles a visit\'s fees against the lines of the carrier\'s statement.",\n "inputs": {\n "visit": { "type": "record_link", "entity": "visit" },\n "statement": { "type": "file", "required": false },\n "lines": { "type": "array", "items": { "type": "object", "fields": { "service": { "type": "select", "field": "fee.service" }, "amount": { "type": "number" } } } }\n },\n "outputs": { "added": { "type": "number" }, "changed": { "type": "number" } }\n}\n```\n\nIts code is set on the app, never stated in the tree: `set_workflow` with a `source` whose `on({ type: "app", app_id, alias })` header names the app and the key, leaving\n`inputs` and `outputs` out \u2014 the code is checked against what the node declares. Every `set_app` keeps that code and holds\nwhat it takes, what it hands back and its description to the node. To change what a workflow takes or hands back, change\nthe node first: `set_app` keeps the code where it still meets the change, and where it does not the workflow stands on no\ncode again until `set_workflow` sets one that does. With no code it refuses every call, and each `set_app` says so. A\nWorkflow the tree stops declaring is archived with its key.\n\n## Tasks\n\nA table whose `records` states `"task": true` \u2014 its status a stored select with `closed` \u2014 is work someone finishes.\nEvery List of its rows draws it alike, each row led by a ring. Ticking the ring moves the row to a closed option by the\none write the app already has for that move: the Act of that table setting a closed option, offered on an open row and\nasking nothing, else its own save where people write the status \u2014 stamping what that act stamps and appending the\nstatus history. Unticking runs the Act moving a closed row back, else the save back to the status\'s default. A move no\nwrite reaches leaves the ring disabled and the check notes it. An Act with `on: "ticked"` completes several at once.\n\nA record listing task rows filed under it by a link holding one row says how much of that work is done \u2014 those at a\nclosed option of all \u2014 wherever its row is drawn: a meter on its head, a column of its register\'s rows, a card\'s foot, a\ncalendar entry, a gantt\'s or a lane\'s bar. No rollup is stated for it.\n\n```json\n{\n "tables": [\n {\n "ref": "project",\n "label": "Projects",\n "singular": "Project",\n "fields": {\n "name": { "label": "Name", "required": true, "type": "text" },\n "lead": { "label": "Lead", "type": "member" }\n },\n "title": "name",\n "records": {}\n },\n {\n "ref": "task",\n "label": "Tasks",\n "singular": "Task",\n "fields": {\n "title": { "label": "Title", "required": true, "type": "text" },\n "project": { "label": "Project", "required": true, "type": "link", "table": "project", "multi": false },\n "assignee": { "label": "Assignee", "type": "member" },\n "status": {\n "label": "Status",\n "required": true,\n "default": ["todo"],\n "type": "select",\n "options": [\n { "alias": "todo", "label": "To do", "color": "slate" },\n { "alias": "done", "label": "Done", "color": "green" }\n ]\n },\n "due": { "label": "Due", "type": "date", "format": "date" },\n "done_on": { "label": "Done on", "type": "date", "format": "date" }\n },\n "title": "title",\n "records": {\n "subtitle": ["assignee"],\n "due": ["due"],\n "task": true,\n "starts": { "assignee": "me" },\n "status": { "field": "status", "closed": ["done"] }\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "projects",\n "name": "Projects",\n "color": "blue",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "project"\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "project",\n "children": [\n {\n "type": "Section",\n "key": "work",\n "title": "Work",\n "children": [\n "lead",\n {\n "type": "List",\n "entity": "task",\n "columns": ["due"],\n "children": [\n { "type": "Act", "key": "complete_all", "label": "Complete", "on": "ticked", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } }\n ]\n }\n ]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "task",\n "children": [\n { "type": "Act", "key": "complete", "label": "Complete", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "reopen", "label": "Reopen", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\nThe tasks as a register of their own, for one person: a one-part Record holds its Fields and Acts directly.\n\n```json\n{\n "body": {\n "type": "App",\n "key": "my_tasks",\n "name": "My tasks",\n "color": "teal",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "task",\n "opens": { "assignee": { "me": true } },\n "children": [\n { "type": "Reading", "label": "Open", "where": { "status": ["todo"] } }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "task",\n "door": "drawer",\n "children": [\n "project",\n "due",\n { "type": "Act", "key": "finish", "label": "Finish", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "undo", "label": "Undo", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\n## App rules\n\nEvery rule the check enforces over an app, one sentence each under an id; a finding names its rule\'s id\n(`[list.filter]`), and `reference/<rule id>` is that one rule\'s page. A sentence names the node and the prop an author writes (`List.create`, a `Section`);\neach area stands in the tree where this table says:\n\n| Area | Stands at |\n|---|---|\n| `app` | what every write meets (the tree\'s keys, the names it declares, the tables and rows it carries), the App, and the register List\'s props that belong to the app: `words` (labels), `color`, `scope`, sources, the root Views |\n| `template` | the document templates an Act makes and an Export fills |\n| `list` | a List: its columns, filters, search, group, sort, layout, tabs, period, export, and what a child List holds |\n| `reading` | a Reading |\n| `record` | a Record and its parts: Section, Side, Act placement |\n| `statement` | a Statement |\n| `act` | an Act |\n| `check` | a Check |\n\n<!-- generated:start rules-app -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.schema` | Every key is one its table lists, holding the type its row gives, and every required key is stated. |\n| `app.names-declared` | Every alias a key names is declared: a table of the App\'s `tables`, a field of the table the node reads, an option of the select it names, an Act `key` of the App, a template of its `templates`, or an app. |\n| `app.record-home` | A Record stands in the App\'s `pages`, never inside a List: one page per entity, opened from the Lists over it. |\n| `app.spec-claims` | The app a tree compiles to names only the queries, workflows and agents it declares, reads the columns its screens draw, sends the inputs its workflows take, and gives each layout what it draws its rows by (a calendar a date to stand a row on). |\n| `app.compile-lowers` | Every screen, read and write a tree states lowers to the app\'s spec: a tree the compiler cannot lower is refused at the App. |\n| `app.tables` | A call declares at least one table and at most 50; send the rest in a second call. |\n| `app.rows-cap` | Rows are a sample: at most 200 per entity, 2000 per call and 2000 documents attached \u2014 a real data set goes in with `create_records` once the tables exist. |\n| `app.alias-scope` | An alias is unique where it is named: tables and fields in their table, options in their select. |\n| `app.label-unique` | A label is unique where it is found by its label: fields in their table, options in their select. |\n| `app.filter` | A filter \u2014 a view\'s, a rollup\'s \u2014 tests fields of the entity it reads, through links as `entity.field` hops each standing on the entity the last lands on, by options its select declares. |\n| `app.input-once` | The fields the App\'s saves, adds and Acts of a table send are each sent under one input name: a files or many-link field is sent as `<alias>_added` (and `<alias>_removed` by a save or an Act), so no other field of the write is so named, and none takes an input the workflow names itself, such as `record_id`, the input naming the row. |\n| `app.alias-unique` | An App\'s `key` is unique among apps, and an Act\'s among the Acts of its App, every List\'s included. |\n| `app.icon` | An App\'s `icon` is a Lucide icon name in kebab-case, as `receipt` or `trending-up` are. |\n| `app.add-label` | A List\'s `add_label` stands only where it adds rows (`create`), in words that are not empty and hold no `{` or `}`. |\n| `app.labels` | An App\'s `words` name a table it reads and a field or option of it, in words that are not empty and hold no `{` or `}`; no two fields of a table, nor two options of a field, show the same words. |\n| `app.records-entry` | Every table an App draws a List over, opens or picks from \u2014 a root List\'s, a child List\'s, a linked row\'s, a documents List\'s \u2014 has a `records` entry. |\n| `app.scope` | The App\'s `scope` names the table whose one row the app works inside (the folder), a table whose row rule can bind; every List over a table linking to it is filed in the open folder (`list.scope`). Stated again on such a List as a `columns`, `filters` or `search` entry, `group`, `where`, `opens`, a Field of a part, a `create` question or a report\'s `where` or `per`, its folder link is left out and said: the App already narrows every read to it and files every add under it. |\n| `app.folders` | The App\'s `folders` names a root List over the table its `scope` names: that List draws the folders the app opens on, and a row pressed is the folder entered. |\n| `app.when` | A node\'s `when` holds single selects to options, yes/nos to `true` or `false` (stored, a formula of one \u2014 a formula with `options` is a select \u2014 or, offering a node, a lookup through a link to one row), numbers and dates to bounds (`gt`, `gte`, `lt`, `lte`; a date\'s bound is a day, a moment on a datetime, or `{ "now": true }`) and any field but a yes/no to `{ "empty": true \\| false }` \u2014 a number read in each row\'s own unit or currency and a lookup take no bound. |\n| `app.asked-written` | What a List\'s `create` asks, what an Act\'s `asks` asks and what `starts` fills is a field a person writes \u2014 never a formula, rollup, lookup, autonumber or a date the workspace stamps. |\n| `app.own-rows` | A many-link to rows that each belong to one row of this entity is never a `create` question or an Act\'s `asks`: those rows are the record\'s own, each written by its own write. |\n| `app.create-asks` | A List\'s `create` asks fields a person writes \u2014 never the link or the folder it files the row under, which the add sets itself. |\n| `app.create-required` | A List\'s `create` asks every field its entity requires that nothing else fills \u2014 a `default`, `starts`, the record or folder it files the row under, or a `default_from` over a link it fills \u2014 or the server refuses every add. |\n| `app.row` | A Record\'s `row` states only what differs from `records`: a `subtitle` that is not the title, a number for its `figure`, dates for its `due`, an `image` that is a files picture no Act makes documents into, or `false` for a figure, deadlines or picture the entity states and the App draws none of. |\n| `app.restates` | *Noted, never refused:* A key the tree states that the platform sets the same without it \u2014 a `label` the table\'s or field\'s own, a `row.subtitle` the table\'s, a `door`, an add or a layout end the default gives, a row rule a status history inherits \u2014 changes nothing: the write keeps it and says so. |\n| `app.tasks` | *Noted, never refused:* A task entity an App lists whose rows no write of the App moves to a closed option (its ring stands disabled), or that an Act ticks done and none moves back. |\n| `app.same-list` | *Noted, never refused:* A root List over a table another App of the workspace lists at its root. Unnarrowed, every reader sees the same list, and a row\'s rail shows only that app\'s parts, so no one sees the whole path. A different job narrows with `where` and `columns`; a shared job stays one app, `owner` on its Acts and stages deciding who presses. |\n| `app.workflow-value` | A value a Workflow takes or hands back states what its type needs and nothing another type does: a `"record_link"` its `entity`, a `"select"` its `options` or the `field` holding them \u2014 never both \u2014 an `"object"` its `fields`, an `"array"` its `items`; `multi` stands on a `"record_link"`, `"select"`, `"member"` or `"file"`; an output is never a `"member"` or a `"file"`; and a value nests at most 8 deep. |\n| `app.query` | A Query reads `rows` of one table \u2014 under the App\'s row rule of it and inside the open folder where the table holds one one-row link to the App\'s `scope` (one holding several is read through `list`) \u2014 or a root List\'s rows as that List reads them (`list`: its `where`, folder and order; never a List reading `sources`), one of the two; it returns them as `fields`, ordered by `sort` and bounded by `limit`; each param is a number, a yes/no, a date, a select, a one-row link or a member holding one, read by an entry of `where` on a field of its type \u2014 a date by a range, a number by either, and never a number read in each row\'s own unit or currency or a date holding a span. |\n| `app.generated-name` | A name the App makes is taken by nothing the App states: no Query, Workflow, Reading or List `key` is the name of a read or a workflow the App makes, an Act\'s own `workflow` among them; where the App makes two reads spelled alike, the later takes the next free ordinal (`_2`, `_3`). |\n| `app.surface-described` | *Noted, never refused:* A value a Workflow takes, and a param a Query takes, that states no `description`: the one line a caller reads to fill it. |\n| `app.keys-unique` | No two children of one node share a key: an address names one node. |\n| `app.states-list` | An App states a List whose rows it lists, only Sheets of Readings, or only Queries and Workflows for a server to call. |\n| `app.period` | An App\'s `period` is the window every Sheet opens on, so it stands in an App that holds a Sheet: a List states its own `period`. |\n| `app.dashboard-words` | An App that holds Sheets and no List reads every table\'s rows whole and states no `words` or `scope`: those are an App with a List\'s. |\n| `app.entity-once` | The App\'s Lists and their sources work a table one way: its rows ticked as tasks by the same moves, and their work counted by the same kinds of task rows. |\n| `app.add-filed` | The Lists adding rows of one table file them by one link: where two Lists add them by different links, each is refused naming the other\'s \u2014 state `create: false` on every List but the one whose link files them. Wrong: a List adding `booking` rows filed by `freelancer` beside one filed by `production`. Right: one states `create: false`. |\n| `app.adds-field` | A picker\'s `add` names fields of its table a person writes, each once. |\n| `app.edits` | *Noted by the designer on a write, never refused:* The fields an app\'s saves may change are the fields its surfaces write \u2014 a record\'s save, a child row\'s, an in-place column, a lane, gantt or plan move \u2014 less what its own Acts change; the designer notes an app whose saves change none. |\n\n<!-- generated:end rules-app -->\n\n## Reading rules\n\n<!-- generated:start rules-reading -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.value` | A Reading sums a number, never a percent \u2014 percents do not add up; a value of `{ avg }` reads one. |\n| `reading.average` | `{ avg }` averages a Reading\'s `value` over the rows holding one, read against a plain `target` \u2014 never a value `limits` bounds, whose bound is a sum. |\n| `reading.split` | `by` and `across` split by one value each row holds \u2014 a single select, a one-row link, one member or a yes/no, stored or a formula, a lookup through one-row links as the field it reads \u2014 or by the bands `tiers` cut a number read in one unit on every row; a date `by` splits them per period, as a trend; a grid crosses two different fields. |\n| `reading.over` | `over` is a date: the row\'s own, stored or a formula, or its parent\'s through a lookup over a one-row link. |\n| `reading.where` | A reading\'s and a Query\'s `where` keep rows by a select\'s options, a yes/no\'s `true` or `false`, a number or date\'s bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }`), `{ "empty": true \\| false }`, or a member field, a lookup of one, or a member of the row a one-row link names (`<link>.<member>`), holding the reader (`{ "me": true }`); a List\'s `where` also keeps rows by `<link>.<field>`, a select or yes/no of the row a one-row link names; a Query\'s `where` also holds a field to what the call states (`param`, `from`, `to`). |\n| `reading.target` | `target` reads a value nothing bounds \u2014 a value `limits` bounds reads against the sum of its bound. |\n| `reading.better` | `better` needs `over`: a change is read over the periods its date places the rows in. |\n| `reading.progress` | A Reading stating `planned` and `done` (the work against its plan) reads dates of its rows for `planned` and `finished`, and a number for `done`. |\n| `reading.progress-alone` | A Reading stating `planned` or `done` is the work against its plan: it names its `entity` and states `planned` and `done`, with `finished`, `where`, `via`, `tab`, `when` and `label` beside them, and none of a figure\'s props (`value`, `by`, `across`, `over`, `ahead`, `steps`, `on_hand`, `target`, `better`). It stands in a List\'s band or a record, never on a Sheet. |\n| `reading.key` | A Reading\'s `key` is its query\'s name, and a List that only reads is called by its `key`, else its entity\'s alias: each its own among the App\'s Readings, Lists that only read and Queries. |\n| `reading.tabs` | A Sheet holds Readings and Lists, one at least; a Reading stands in a Sheet or in a List\'s band. |\n| `reading.restate` | *Noted, never refused:* A Sheet\'s count tile counting the rows a List beside it lists under the same `where` and tab, and a List\'s band counting its rows past a deadline, say what the List already draws: its head counts the first, its overdue chip the second. |\n| `reading.period` | An App\'s `period` is the one its Sheets open on \u2014 "month", "quarter", "year" or { "days": 30 } \u2014 and it stands only over a Reading placed in time by `over`. |\n| `reading.funnel-place` | A Reading with `steps` (a funnel) stands in a part of a Record: a band and a Sheet draw none. |\n| `reading.on-hand-split` | A Reading with `on_hand` compares what is owed with what is on hand per value of one field, or two: its `by` and `across` name fields, never bands. |\n| `reading.average-single` | An average (`value: { avg }`) is a single figure\'s: its Reading states no `on_hand`, `by` or `across`. |\n| `reading.grid-rows` | `across` splits a grid\'s columns, and stands only beside the `by` splitting its rows. |\n| `reading.band-off` | `readings: false` turns off the band a register leads with by default: a List stating it states no Readings, which are the band. |\n\n<!-- generated:end rules-reading -->\n\n## Statement rules\n\n<!-- generated:start rules-statement -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `statement.lines` | A Statement\'s `lines` are numbers of the record, each once \u2014 the first stating no `op`, every other one, the last an `"equals"` \u2014 each `"equals"` a formula, rollup or lookup, and a `rate` a number of the record. |\n| `statement.rows` | A line\'s `parts` read rows of an entity holding `same`, a one-link of the record\'s to the same entity; `at`, a moment of those rows, and `before`, a moment of the record (datetimes, never days), stated together; their `columns` and `figure` are those rows\' fields, the figure a number. |\n| `statement.parts-keyed` | A line\'s `parts` add up to its figure, so no person keys it: a formula, rollup or lookup, a value the server copies when the record is made (`default_from`) that no `create` asks and no save or Act writes, or a stored number the App\'s saves leave out \u2014 the line draws it read; each part\'s `figure` is frozen when its row was certified \u2014 a stored number an Act fills, the server copies or the App\'s saves leave out, never one a person keys or the server recomputes \u2014 and no person keys the moments `at` and `before` either. |\n\n<!-- generated:end rules-statement -->\n\n## Check rules\n\n<!-- generated:start rules-check -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `check.field` | A Check\'s `field` is a yes/no or text formula of the rows of the page\'s entity. |\n| `check.of` | A Check stands in `pages/<entity>` and reads a yes/no or text formula of that entity. |\n| `check.not-placed` | A Check\'s field is never also placed on the record as a Field \u2014 the line under the head says it. |\n| `check.on` | A Check\'s `on` names what it refuses: `"update"` (the saves), the `key` of an Act over the Check\'s entity \u2014 on one row or over a List\'s rows \u2014 or `"all"`. It binds this App alone; a Delete is the table\'s checks\' to refuse. |\n| `check.resolve` | A Check\'s `resolve` names an Act of this App on one row of the Check\'s entity, not refused by the Check, and drawn as a button \u2014 never a correction. |\n| `check.restates-meter` | A warning reading a gated meter\'s figure against its bound or pass mark is refused \u2014 the meter draws it. |\n\n<!-- generated:end rules-check -->\n\n## List rules\n\nThe rules of a List\'s props and of what a child List holds. A layout\'s, a Tab\'s, an Export\'s and a desk\'s rules stand with their keys.\n\n<!-- generated:start rules-list -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.key-shape` | A List\'s key is not a record id\'s shape. |\n| `list.peers-read` | Root Lists over one table may state different `where`, unless one holds a `where` through a link, `sources` or a `plan` layout. |\n| `list.column-drawn` | A List\'s `columns` stand beside what the row draws itself: a column of its title, subtitle, picture, status, figure or meter\'s bound, of a child List\'s link back, or one named a second time, stands once where the row seats it. |\n| `list.columns-budget` | *Noted, never refused:* A List\'s `columns`, each at the width of its kind, are told against the room a desk leaves beside its name and the row\'s own status, deadline and figure; what does not fit folds onto the name\'s line. |\n| `list.filter` | A List\'s `filters` name a select, a member, a link, a date, a yes/no or a number of the List\'s own rows \u2014 a lookup through one-row links as the field it reads \u2014 never the status (its chips), nor one `where` fixes. |\n| `list.filter-split` | *Noted, never refused:* A `filters` entry on a field a Reading of the List with `by` or `across` splits the rows by \u2014 a press on its part narrows by it too; a member\'s filter, which narrows to the reader\'s own rows, is never noted. |\n| `list.filter-unshown` | A `filters` entry, a narrowing the List `opens` on, and a press in a Reading\'s band (a part, a grid cell, a figure\'s `where`) name a field its rows show \u2014 a `columns` entry, the row\'s title, line, picture, status, figure, deadline or meter\'s bound, the unit or currency a drawn figure is read in, a warning its line says, or the group or lane it stands under \u2014 or a formula drawn where every field it reads is (through other formulas too; one reading none is drawn nowhere). A narrowing to the reader needs none. A tree leaves out a `filters` entry no row shows and says so (name the field as a column or in the row\'s line to offer it); the other two are refused. |\n| `list.tiers` | `tiers` band a number read in one unit on every row; a figure read in each row\'s own unit or currency is named bare. |\n| `list.search-undrawn` | *Noted, never refused:* A List\'s `search` matches all of a row\'s text, drawn or not: where a lookup, rollup, copy or link of its rows reads another entity under a row rule the List\'s readers are not all inside, the search finds rows by that text though the List draws none of it. |\n| `list.search` | A List\'s `search` names text, a code, or a link \u2014 matched by its row\'s title. |\n| `list.sort` | Each `sort` key of a List or a Tab names a field of the List\'s rows that holds an order \u2014 never files \u2014 and no field twice. |\n| `list.group` | A List\'s `group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 the status too, but never on a task list\'s block, whose chips narrow it; only a table or cards List groups, and a gantt into its lanes; grouping by the title needs a `row.subtitle` to lead each row. |\n| `list.readings-own` | A Reading in a List reads the List\'s own entity; another entity\'s stands on a Sheet. |\n| `list.readings-bands` | A Reading in a List that bands a number by `tiers` has that field with the same tiers among the List\'s `filters`, which a press on a band narrows by. |\n| `list.readings-restate` | A Reading with no `by` in a List never sums the row\'s figure, counts the rows, or counts one stage\'s rows, unless it is placed in time (`over`): the summary line and the status chips already do, but draw no change against the last period. For the summed figure a mix `by` a field, or a sum under a `where`, stands instead; for the rows counted, a sum of the figure under a `where`, a mix `by` a field, or a yes/no in `where`. |\n| `list.where-opens` | A List\'s `where` and `opens` hold a select\'s options, a yes/no\'s value, a number or date\'s bounds (`lte`, `gte`; a date\'s `{ "now": true }`) and `{ "empty": true \\| false }`; `opens` alone names the reader \u2014 a member field or a lookup of one holding `{ "me": true }`, or, on a status whose `stages` have owners, the rows waiting on the reader \u2014 and takes fields only, on the status only options. A field `where` fixes to options is never a filter nor opened otherwise, and `opens` stays among the options `where` keeps. A List laid out as a `plan` keeps its items by options and yes/nos alone. |\n| `list.roster` | A `layout: "roster"` List holds the List of its cells: the cells\' entity has one single link to this one and a date on its line (its own field, or a lookup of its parent\'s date); a roster draws no `columns`, and an `expect` (with `of`) stands only on the cells List. |\n| `list.roster-expect` | A roster cells List\'s `expect` is a single select of its rows, and its `of` this entity\'s multi-select whose every option is one of `expect`\'s. |\n| `list.source-page` | A source\'s entity states a Record page in the App\'s `pages`. |\n| `list.band-pivot` | *Noted, never refused:* A Reading with `across` (a grid) among a List\'s Readings: its grid reads on a Sheet, and the band leads with a figure (a Reading with no `by`). |\n| `list.headline` | *Noted by the designer on a write, never refused:* A List over rows that fall due or carry money and have no status whose steps the chips count, laid out as a table, cards or a gantt, has Readings \u2014 they split the rows by a field they show. |\n| `list.figures-lead` | *Noted, never refused:* A root List over a table holding a status, or a money field beside a date, to count or total states a Reading, or a Tab with totals, above its rows: what a person watches (money owed, what is late, what waits on them) as a figure or a chart. |\n| `list.title-only` | *Noted, never refused:* A root List whose rows draw their title alone: a subtitle, a figure, a status, a deadline, a picture, a face or `columns` says what each row is. |\n| `list.people-undrawn` | *Noted, never refused:* A root List drawn in columns, stating fewer than two besides the figure, where a table whose rows are people links to its table: the paired link holding several of them is not a column of it, or the link is not paired. |\n| `list.span` | *Noted, never refused:* Rows that each run from one date a person states to a later one \u2014 ordered by a `min` or a table check, both required or the second the row\'s `due` \u2014 are drawn in time by some List of some app; the note names a calendar, and lanes on a `no_overlap` link beside it. |\n| `list.lanes-overlap` | *Noted, never refused:* Lanes of dated rows by a link with no `no_overlap`. |\n| `list.planned` | *Noted, never refused:* Rows each held on one date a person states \u2014 required, no Act stamps it, a new row does not start at today \u2014 listed by a register with no `layout`: `layout: "calendar"` draws them on their days. |\n| `list.where-bound` | A bound read from the record (`{ "record": \u2026 }`) in `where` narrows only a List that reads its rows \u2014 `same`, or `edit: false`. |\n| `list.where-reader` | A root List\'s `opens` names the reader (`{ "me": true }`), never its `where`. Wrong: `where: { crew_lead: { me: true } }` on a child List. Right: a row rule bounds access, or a root List over the entity states `opens: { crew_lead: { me: true } }`; the write moves a root List\'s `where` there and says so. For a member of a linked row, add a lookup of `<link>.<member>` on the table and open on it. |\n| `list.where-reader-path` | A path reader `<link>.<field>` names a one-row link and a member field of the row it links. |\n| `list.props` | A node states only the props of its place: a List those of a root List, a roster\'s cells, a rows, agenda, timeline or read-only List of a record (which take every prop of a View but `sources`), a document or a Sheet; the Record of a List that opens no row in place and a source\'s entity page `entity`, `edit` and its children; a Sheet its `key`, `label` and children. |\n| `list.holds` | A List holds what its place draws: a root List its Tabs, Readings, Exports, Acts over ticked rows or every row in view, sources and, under a roster, the List of its cells; a child List its Tabs, Readings, Exports, Acts over ticked rows and, with `under`, the List of its documents; a Sheet its Readings and Lists. An Act on one row and every Check stand in `pages/<entity>`. |\n| `list.layout-place` | The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a child List writing its rows as a table, checklist, desk or gantt; any child List as an agenda or timeline. |\n| `list.edit-column` | An edit column (`{ "field": \u2026, "edit": true }`) stands in a child List only: the register\'s rows are written where they open. |\n| `list.child-link` | A child List reads a child linked to the record; `via` names the link where the child links more than once. |\n| `list.row-blocks` | A List drawn as lines (`expect`, `under` or a desk) opens no row in place, so no List stands below its rows; a plain list of rows holds one. |\n| `list.title-back` | Where a child\'s title is its link back to the record, its first other `row.subtitle` names it there \u2014 a text, a code, a select, a link or a member, never a number or a date. |\n| `list.where` | A child List\'s `where` names single selects of the child by the options they hold (a row holding none stands in no such List; one held at a single option is never also a column), yes/nos by value, numbers and dates by bounds, and fields by `{ "empty": true \\| false }`. A yes/no, a bound or a blank is never held: a child List adds rows only at a stored yes/no\'s start, none under a bound or a blank, and never picks, expects or stands lines under documents. |\n| `list.under` | `under` names the child\'s one-row link to a document entity that pairs a many-link back and is read under this record by its one link; the lines\' columns never read the document (its heading does) nor hold long text. |\n| `list.under-once` | Documents drawn over their lines (`under`) are never listed again as a List of their own. |\n| `list.edits` | A child List\'s editable columns (`{ "field", "edit": true }`) name at most two of the child\'s columns or its figure that the App\'s saves write \u2014 a number, a date, a few words, one option or a one-row link, never a files or long-text field, the List\'s `via` nor a link it must name alike (a link\'s `same`) \u2014 and never stand on an `expect` List. |\n| `list.remove-roster` | A roster cells List\'s `remove: true` offers the Delete of the roster\'s rows, so it stands only beside a roster over rows the App writes. |\n| `list.attention` | `attention: false` keeps a table\'s or cards\' rows in the List\'s own order; a calendar, lanes, a gantt and a roster stand their rows in time and lift none. |\n| `list.remove-documents` | The documents List inside a child List with `under` states `remove: true` only over documents the App writes. |\n| `list.compare` | A child List\'s `compare` names two different fields of the child, `before` and `after`: two files fields, or two values of one type (text but long text, a number, a date, a single select), never with `expect`. Over files on a checklist layout, `before` is the check\'s `photo`. Over values neither side is a column or something the row draws already, two numbers share a notation, no column is long text, and the layout is no checklist. |\n| `list.current` | A child List\'s `current` names a date or number of the child (stored, or a formula) that orders revisions: the latest row is current, the rest fold as superseded. Never with `group`, `under`, `expect`, `checklist`, `compare`, `desk` or `pick`, nor beside a column of long text. |\n| `list.pick` | A child List\'s `pick` links rows of the child through `via` \u2014 an optional one-row link a person writes, no Act writes, no other rule compares rows by and no `under` List stands lines under \u2014 paired with a many-link of the record its own save writes; the child\'s `read_scope` reads a row naming no record through `via`; never with `expect` or `under`, nor where the App\'s saves leave out the child or the many-link. |\n| `list.narrow` | A child List\'s `filters`, `search`, `group` and `sort` follow the register\'s rules over the child\'s rows, its status among them but on a task list (its chips); never on the link back or a select its `where` holds at one option, nor on an `expect` List; an `under` List is grouped by its documents. |\n| `list.expect` | `expect` names the child\'s title \u2014 a single select or a one-row link a person writes, never the link back \u2014 on a child added in the List; its `columns` name a field filled in place (not on a desk, whose lines are ticked) and its `create` takes the file where the child is pictured by one. |\n| `list.expect-fills` | An expected line is made from its key and its first filled column \u2014 a desk\'s from its key alone \u2014 so every other field the child requires has a default, a start or a `default_from`, or is read first. |\n| `list.expect-of` | An `expect` object\'s `of` or `only` needs a select: `of` names the record\'s multi-select of the title\'s options; `only` names options of a single select, never with `of` or a `where` on it, one List per option; an Act\'s `paper` is drawn in one. |\n| `list.post-option` | A desk\'s `text` formula names, as `{field:option}`, only options that select states. |\n| `list.funnel` | A Reading\'s `steps` (a funnel) are 2 to 8 numbers of its child, each named once \u2014 stored, a formula or a rollup \u2014 all in one notation, never a percent nor a unit read on each row. |\n| `list.list` | A read-only child List (`same`, or a Record that is `edit: false`) lists the rows of an entity that link to the record by its one link (`via` where it has several); with `same`, a one-row link of the record, it lists the rows sharing that link\'s row \u2014 the record left out \u2014 by the listed entity\'s one link to that row\'s entity (likewise `via`). `same` stands in a Record, never on a Sheet. Its Record\'s Fields \u2014 at least one, each a field of the listed entity named once, never its title nor a `columns` entry \u2014 are what an opened row shows, read-only. |\n| `list.figures` | A Record\'s own figures (Readings with no `entity` or `by`, whose `value` names the field) are 1 to 8 numbers of the record, each a tile. |\n| `list.create-boolean` | A document\'s and a roster\'s cells\' `create` is `true` or `false`: their add asks the table\'s defaults. |\n| `list.via-path` | A `<link>.<link>` `via` only reads rows, through a row of their own: a List writing its rows lists a child linked to the row it stands under. |\n| `list.beside` | `beside` opens a row beside a table: a root List drawn as a table states it, never a board, cards, a calendar or a List of a record. |\n| `list.create-empty` | A child List that adds rows asks the fields of its add: where the table\'s defaults ask none, state `create: false`, or the fields it asks. |\n| `list.read-scope` | A child read under a record whose rows a `read_scope` narrows states its own \u2014 a row rule is not inherited, save the status history\'s, which takes its record\'s. |\n| `list.unworked-stage` | *Noted, never refused:* A register lists rows (every open one, else those its `where` keeps) at a stage no Act of the App is offered at and no Section stands at, though the App states the stages it works: keep them out with `where` or leave them to the App that works them. |\n| `list.under-note` | *Noted, never refused:* Rows holding a paper that cover another List\'s lines, listed apart with no add of their own stated: `under` draws them over the lines they cover. |\n| `list.expect-note` | *Noted, never refused:* Rows each a kind of paper, listed with no `expect` and no `where` on the kind, that no Act files a call into or `fills`: the lines still missing read as what a record needs. |\n\n<!-- generated:end rules-list -->\n\n## Record rules\n\n<!-- generated:start rules-record -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.placed-once` | A child List, a Reading, a Statement and an Act each stand once in a Record; a set of papers stands where its Act does. A Field may be stated in several parts: parts that stack draw it once, parts a reader navigates each draw it. The head draws the title, line, picture, status, figure and the nearest open deadline, and a Field of a part standing there stands aside unless a person writes it in the part; what a Side states stands only in the Side. |\n| `record.foot-total` | A child List\'s foot totals the child\'s figure and each summed column over the rows it lists; the record\'s rollup summing that field over those rows (the same `where`) is that foot, never also a Field of a part. |\n| `record.section-holds` | A part without `at` (Section, Side) holds Fields, Fieldsets, child Lists, Readings, Statements or Acts. |\n| `record.linked` | A link drawn as a block (`block: true`) is a link to one row of a table the App states a Record page of: the row stands in place as that page draws it. |\n| `record.fieldset` | A Fieldset stands in a part, or in a one-part Record, and holds two or more Fields drawn as controls \u2014 never a gallery or prose Field (`block`) \u2014 each Field in one Fieldset. |\n| `record.parts` | *Noted by the designer on a write, never refused:* A List laid out as a table, cards or a gantt opens a Record whose Sections hold the fields people write, a files Field per paper and the Acts no stage places, a Section per stage the status states (in option order) with the moves offered there at its foot, and a child List per child, a table\'s own rows that belong to a row of it included. |\n| `record.lists` | *Noted by the designer on a write, never refused:* A table some App records, whose rows other rows each belong to (a one-row link to it, never its status history), draws some of them under its row \u2014 a child List in its Record, a List with `layout` roster or lanes by that link, or an App over them working inside one of its rows at a time (`scope`). |\n| `record.at` | A Section\'s `at` names options of the record\'s status; a record with no status has no steps. |\n| `record.beside-door` | A Record whose entity a root List opens `beside` its table states no `door`: the rows open beside the table. |\n| `record.key-clash` | A Record\'s List blocks, filed rows and links share one namespace of `key`s: none repeats, a List\'s default being its table, and a link\'s or a filed field\'s being its alias; a List and a link at one key, or one alias leading to two tables, is refused. |\n| `record.side` | At most one Side stands in a Record, on a page `door`. |\n| `record.history` | No part of a Record reads the entity\'s status history (`status.history`): the rail reads each move. |\n| `record.section-acts` | An Act in a part works on the record itself; an Act over ticked rows or every row in view stands in a List. |\n| `record.move-home` | *Noted, never refused:* A status move offered at one step stands at that step\'s foot when it moves the work forward, to an exit, or back to a step it passes anyway; one offered at several steps, or moving back into a detour, stands in the Section whose `at` holds the status it enters. A move written in another Section, or in none, stands there and is said. |\n| `record.act-staged` | An Act at a staged Section\'s foot is offered only during that Section\'s steps: its `when` holds the status to options the Section\'s `at` names. A tree\'s Act with no `when` at the foot of a Section staged at one step is offered at that step and said; a correction stays offered at every step, and an exit is refused. |\n| `record.act-hidden` | An Act is never offered only while its part\'s `when` hides the part. |\n| `record.outside-place` | An Outside stands directly in a Record whose table states a stored status select, and its `key` is unique in the App: a link to a record names it. |\n| `record.outside-at` | An Outside\'s `at` names options of the record\'s status that no stage owns, and no two Outsides of a record open during the same option. |\n| `record.outside-field` | An Outside\'s Fields are read as values, each a field of the record shown once, never `edit`, `when` or a label of its own. |\n| `record.outside-list` | An Outside\'s Lists read the child rows under the record as they are: their `columns`, `label` and `where` only, never an add, a Delete, a pick, a filter, a search, a link that opens, or a bound read from the record. |\n| `record.outside-where` | An Outside List\'s `where` keeps the child rows by single selects held at options, yes/nos at values, numbers and dates between bounds, and fields by `{ "empty": \u2026 }`. |\n| `record.outside-act` | An Outside\'s Acts are its alone and each ends the visit: `when` holds the status to `at`, `set` moves it to an option outside `at`, `asks` are text, numbers, dates or listed options, `requires` names fields the Outside shows or the act asks, a `sign` is by a text field with no witness, and none states `on`, `workflow`, `templates`, `paper`, `intake`, `record`, `review`, `danger`, `recommends` or `me`. |\n| `record.holds` | A Record stands in the App\'s `pages`, once per entity some List of the app or of a Sheet is over, or whose rows a link the app draws names. Every Record holds the same: parts (Section, Side) or the Fields, Fieldsets, Lists, Readings and Statements of its one part, never both; beside either stand Outsides, Checks and Acts on one row; holding only those, the record\'s Sections are the platform\'s. The page of an entity whose rows a child List opens no row of in place (an agenda, a timeline, a read-only List) holds Fields alone. |\n| `record.remove` | A Record\'s `remove` deletes a row opened from a link; an entity a List lists is deleted as that List\'s `remove` says. |\n| `record.field-heading` | A Field drawn as a control states no `label` or `when`: only a gallery or prose Field (`block`) has a heading and a condition. |\n| `record.section-owners` | *Noted, never refused:* A Section holding acts offered at stages that different owners work \u2014 a role apiece, or a member field apiece \u2014 is two jobs in one: each owner\'s part is a Section of its own. |\n\n<!-- generated:end rules-record -->\n\n## Act rules\n\n<!-- generated:start rules-act -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.paper-note` | *Noted, never refused:* A made paper kept in a field of a record that lists its papers by kind: it is one of those lines. |\n| `act.moves` | *Noted by the designer on a write, never refused:* The rows of a root List of the App that a stored status stages towards `closed` options are moved by an Act of the App (on a page, a List or an Outside), or by its authored `workflow` \u2014 each open option moves to the next, the last to the first closed one. |\n| `act.set-not-asked` | A field an Act `set`s (an option, a value, `{ "now": true }`, `{ "me": true }`, an input) or `sign`s is the Act\'s outcome: the App\'s `create` never asks it, and a required one takes a `default`. A `formula` only starts a value, which a person may change after. |\n| `act.owner` | An Act\'s `owner` is a single member field of its row, a one-row link\'s member field (`link.field`), or `{ "group": <id> }` of a group the workspace holds: the press is that owner\'s, or the one standing in for them. An Act handed no row (`review`, `intake`, or over the list asking a person something) has no row to read a member field from, so its owner is a group. |\n| `act.owner-stage` | *Noted, never refused:* An Act that moves no status and is offered while the status holds a stage another member owns is pressed by that stage\'s owner: state its `owner` for someone else to press it. |\n| `act.owner-moves` | An Act stating `owner` moves no row off a stage another owner owns: the server refuses that move to anyone else, so the press would be refused. A move from an option no one owns is fine. |\n| `act.asks-set` | A field an Act `asks`, `set`s or `sign`s is stated by one of them: what the Act writes is its outcome, never also asked, and no field is written by two clauses of one Act. |\n| `act.starts` | `starts` (an ask `{ field, starts }`) starts a field the Act asks \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 for the reader pressing it, who changes it at will. |\n| `act.set-formula` | `set: { <field>: { formula } }` reads fields of the acted row and computes what the field holds \u2014 a number, a date, text, a yes/no or a single select\'s option (`{field:option}`), typed as the entity\'s own formulas are \u2014 never the status; a bound a write rule holds the field to is checked on the computed value as the Act runs. |\n| `act.set-formula-option` | A `{field:option}` token of a `set` formula names an option that select states. |\n| `act.of` | An Act in a child List works on that child: the one row pressed \u2014 or, with `on: "ticked"`, the rows ticked together where the record lists them as tasks \u2014 never the rows in view. |\n| `act.writes-line-key` | An Act never writes the link or the key naming an expected line under its record \u2014 a line\'s key is stated by filling it. |\n| `act.makes-or-runs` | An Act makes a document (`template`, `templates`) or runs an authored `workflow`, never both \u2014 the workflow makes what it needs. |\n| `act.does-nothing` | An Act does something: it `set`s a value, `asks` a field, runs a `workflow`, makes a document, or takes an `intake`, a `record` or a `sign`. |\n| `act.view` | An Act over every row in view (`on: "view"`) writes (`set`), makes a document, runs a workflow or reads papers into a new record, and states no `requires`. |\n| `act.requires-written` | A field an Act requires that only an Act writes is written by an Act offered together with it, or asked by the Act itself. |\n| `act.recommends` | A field an Act `recommends` is not also in its `requires`. |\n| `act.set` | `set` writes each field a value it holds \u2014 an option alias, a number, a yes/no, a text, `{ "now": true }` on a date, `{ "me": true }` on a member, `{ "input": "<name>" }` of an input the Act asks of the same kind \u2014 or clears an optional one with `null`. |\n| `act.into` | `into` is a files field of the one record the Act is pressed on, beside its `template` or `templates`. |\n| `act.paper-list` | A List a made paper names is one it can list: none keeps its rows by the reader, and no name is reached by a child List that writes its rows and one that only reads them, or by two of either, at once. |\n| `act.paper-list-field` | A List a made paper names is not also a field of the record, other than the link to those rows; an outline\'s rows are handed their depth as `level`, so they hold no field of that name. |\n| `act.paper-loop` | A loop of an html or Word paper that prints a field of each item runs over a List\'s rows, never over a link, whose rows a paper is handed as their titles \u2014 in the record or in a listed row; a List\'s rows are looped for their fields, never printed whole; a loop runs over a name the paper is handed, never one it is not, which prints an empty table. |\n| `act.paper` | `paper` is a kind the record lists its papers by, on one record \u2014 never beside `into` or `templates`; one maker per kind. |\n| `act.templates` | `templates` names each template once, kept in `into`, on one record pressed alone \u2014 never beside `template` or `asks`, in a child List, or with an `on` over several rows. |\n| `act.intake` | `intake` names a child the record lists in a child List with `expect` on its title \u2014 a single select, the paper\'s kind \u2014 and is narrowed by no `where`, holding exactly one files field and needing nothing an added line does not fill; the Act runs on one record, or over the view (`on: "view"`) where the papers make a new record, states `fills`, and states nothing but its `label`, `when` and `requires` beside them \u2014 over the view no `when` or `requires`, the record has no row yet. |\n| `act.record` | `record` names a child the record draws in a timeline List or a child List with no `expect`, `under` or `where`, linking back by one single link, its row needing nothing the recording does not write: `audio` and `video` files fields, `transcript` text, `at` a date, `by` a member, each its own field; on one record, stating only `label`, `when`, `requires` and `fills` beside it. |\n| `act.sign` | `sign` runs on one record: `into` a files field, `by` a text field the signer types or a member field set to the person pressing, `at` a date, `witness` a member field \u2014 stated exactly beside a text `by` \u2014 each a field of its own that the Act does not also ask or set, and no other Act signs into `into`. |\n| `act.fills` | `fills` names each once, only beside `intake` or `record`. Beside `record`: a field of the recording\'s row the recording does not write, never a link. Beside `intake`: a field of the record, `<link>.<field>` on the row a required one-row link names (never beside that link), or a child the record adds rows of in a child List with no `expect`, `under` or `where`, filled in the fields its `create` asks \u2014 every one a new row needs among them. Each field filled is one a person writes \u2014 text, a number, a date, a yes/no, options or a single link\'s row \u2014 never a status, a field an Act writes or a link `same` narrows; a link\'s row is one the App reads of its entity. Over the view the papers make a new record, so `fills` names every field the record requires that nothing fills itself \u2014 the review asks the ones no paper states \u2014 and the row a required one-row link names is found on its entity\'s `natural_key` once `<link>.<field>` fills every field of it, left as it is, else added with the fields filled, so `fills` names each field that row requires too. |\n| `act.fills-drawn` | *Noted, never refused:* A field `fills` writes that the record draws nowhere: the review shows the change, the record does not. |\n| `act.fills-new` | *Noted, never refused:* A child `fills` adds rows of, whose natural key the papers cannot state: every row read is added, so the same papers read twice list them twice. Over the view, so is the row a required link names where the papers fill no natural key of it. |\n| `act.input` | An input has a name of its own \u2014 never another ask\'s, a field the act sends under that name (one it asks, one a `set` takes from an input, a typed `sign.by`, a `requires`), `sign.into`, or the record input its workflow takes (nor `approved` beside `review`) \u2014 `options` exactly when it is a select, `entity` exactly when it is a link, and a `default` field holding what it states. An input starts empty, or from its `default`, and never reads, shadows or overwrites a field of the row: an act that adds a subtask may ask `name`, though the row has a `name`. A `"file"` input is read by the Act\'s authored `workflow` alone, starts empty, and is never written into a field by `set`. |\n| `act.review` | `review: true` stands beside an authored `workflow` on an Act over the record, the ticked rows or every row in view (never on a List reading `sources`), never beside `set`, `template`, `templates`, `intake`, `record`, `sign` or `confirm`, nor in a child List, and it asks inputs only, none named `approved`. Its workflow is that Act\'s alone, run by no other Act. The workflow calls only steps that read \u2014 no agent \u2014 and returns a changeset of the entity\'s table in `data.review`, the same for the same inputs and rows; the platform writes the rows `approved` names, each only while the run proposes it as the caller read it. Over every row in view (`on: "view"`) it is handed no rows and states no `when`: its workflow reads the rows it may change, whatever the view is narrowed to, and no bound on a run\'s rows applies. |\n| `act.workflow` | An Act\'s authored `workflow` body parses once the guards the Act states are placed above it: the code is the author\'s, the guards above it the platform\'s. A declared Workflow an Act runs takes the row pressed as `record_id` (a required record_link to the act\'s rows), is run by that one Act, over one row, which asks only its inputs and states no `set`, papers, `intake`, `record` or `review`. An authored `workflow` is one Act\'s. |\n| `act.set-tagged` | An Act\'s `set` states the moment as `{ "now": true }`, the person pressing as `{ "me": true }` and an input as `{ "input": \u2026 }` \u2014 never the strings `"now"`, `"me"` or `"input:\u2026"`. |\n\n<!-- generated:end rules-act -->\n\n## Template rules\n\nThe rules of the document templates an Act makes and an Export fills.\n\n<!-- generated:start rules-template -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `template.kind` | An Act\'s `template` is an html, excel or word document template and an Export\'s `template` an html or excel one, never an email or pdf-form one. |\n| `template.marker` | Every marker of a Word template an Act makes is filled by that Act: a field of its entity, or a list of the child rows its record lists (the entity\'s own alias over several rows). |\n| `template.act` | *Noted, never refused:* In an App none of whose Acts runs an authored `workflow`, every html, excel or word template is made by an Act (`template`, `templates`) or filled by an Export \u2014 the note names the app over the table whose fields it prints most, where the Act belongs. |\n\n<!-- generated:end rules-template -->\n\n## What the workspace remembers\n\nThe workspace holds every table, field and select option under an id that never changes, whatever its\nlabel or alias becomes. `set_tables` answers each table\'s id, and an\napp\'s body names tables and templates by those ids, so a relabel on either side is a rename and no body\npoints at another table by accident.\n\nA table `set_tables` refuses to write, or an id the workspace no longer holds, is a refusal by name. `set_tables` with `{ table_id, restore: true }` puts a deleted table back.\n\n## A complete workspace\n\nTwo main entities, so two apps: a sales desk over the orders, where an order is taken and shipped, and an account review\nover the customers, where an account manager reads each customer by tier. What belongs to a row is a child List on that\nrow\'s page, never another app or a Tab: a customer\'s orders are on the customer\'s page, and each order is also a row of\nthe sales desk, one record with one page (`first_build`, \xA7 3).\n\nOne `set_tables` call makes both tables: each item carries a `ref`, and a link names the table it points\nat by the `ref` of the other item. Its answer carries each table\'s id. One `set_app` call then makes each\napp, `{ "body": \u2026 }`: the tree\'s root names the app by its `key` and `name`, and the tables it uses in `tables` by those ids,\nshown here as placeholders to replace.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"label": "Name", "required": true, "type": "text"},\n "logo": {"label": "Logo", "type": "files"},\n "tier": {\n "label": "Tier",\n "default": ["standard"],\n "type": "select",\n "options": [\n {"alias": "standard", "label": "Standard", "color": "slate"},\n {"alias": "gold", "label": "Gold", "color": "amber"}\n ]\n },\n "orders": {"label": "Orders", "type": "link", "pair": "customer", "table": "order", "multi": true},\n "total_ordered": {"label": "Total ordered", "type": "rollup", "via": "orders", "op": "sum", "field": "amount"}\n },\n "title": "name",\n "records": {"image": "logo", "party": "organization", "figure": "total_ordered"}\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"label": "Order no.", "type": "text", "unique": true},\n "placed_on": {"label": "Placed on", "type": "date", "format": "date"},\n "amount": {"label": "Amount", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "total": {\n "label": "Total with VAT",\n "type": "formula",\n "expression": "{amount} * 1.1",\n "notation": {"style": "currency", "currency": "VND"}\n },\n "customer": {"label": "Customer", "type": "link", "pair": "orders", "table": "customer", "multi": false},\n "note": {"label": "Note", "type": "text"},\n "stage": {\n "label": "Stage",\n "default": ["draft"],\n "type": "select",\n "options": [\n {"alias": "draft", "label": "Draft", "color": "slate"},\n {"alias": "confirmed", "label": "Confirmed", "color": "blue"},\n {"alias": "shipped", "label": "Shipped", "color": "green"}\n ]\n }\n },\n "title": "customer",\n "records": {\n "subtitle": ["code", "placed_on"],\n "figure": "amount",\n "status": {"field": "stage", "closed": ["shipped"]},\n "starts": {"placed_on": "today"}\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "color": "blue",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["tier"],\n "children": [\n {"type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n {"type": "Section", "key": "account", "title": "Account", "children": ["tier"]},\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [{"type": "List", "entity": "order", "columns": ["total"], "create": ["code", "amount"]}]\n }\n ]\n }\n ]\n }\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "sales_desk",\n "name": "Sales desk",\n "color": "violet",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "order",\n "filters": ["customer"],\n "create": ["code", "customer", "placed_on"],\n "children": [\n {"type": "Reading", "by": "placed_on", "value": "amount"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "order",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "order",\n "title": "Order",\n "children": [\n "note",\n {\n "type": "Act",\n "key": "confirm",\n "label": "Confirm",\n "when": {"stage": ["draft"]},\n "set": {"stage": "confirmed"}\n },\n {\n "type": "Act",\n "key": "ship",\n "label": "Ship",\n "when": {"stage": ["confirmed"]},\n "set": {"stage": "shipped"}\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\nThe account review leaves the door a record opens through and the rows it opens in to the system, each the default the\ntable\'s facts give; the sales desk states a drawer. Each List names what its add asks (`create`). The customer\'s orders are a block in its "Orders" section, never its own `Orders`\nlink as a field as well: one fact, one place. An order is titled by its customer and read by its number under it; the\nList names what its add asks, since a subtitle or a figure is never asked by default. `Total ordered` is a rollup, so it\nis read and never asked; the sales desk\'s record opens in a drawer, because its rows are worked one after another. An\norder\'s `stage` is its status (`records.status`), moved only by the app\'s acts: they set it, so the app\'s saves leave it\nout, each act names the stage it is offered at (`when`) and the one it sets, and the register opens on the orders not yet\nshipped (`closed`).\n';
1814
1873
 
1815
1874
  // docs/examples.md
1816
1875
  var examples_default = '# Worked examples\n\nEach section is one treatment, cut from a complete workspace of an invented business: the job, the keys to\nread, where the treatment is wrong, and the excerpt \u2014 the app\'s tree, the App node `set_app` takes as `body`,\nwhich the check passes with no finding; the tables it draws as the items of a `set_tables` call, each with its\n`title` and `records`; those tables\' fields it names, by what each holds and how it is drawn; and the templates it makes.\nLeft out, for the page\'s size: a Section or page that carries nothing of the treatment, every `label` and `description` of a table or field, `required`, `min`, `unique`, `default` (a section keeps the ones its **Read** rests on), a link\'s\n`pair`, how a computed field computes, the `tables` and `templates` maps an App adds (ids from the\n`set_tables` answer), and template contents \u2014 a call states each table\'s and field\'s `label`. Choosing\namong them: the `design` reference. Every key: `reference`, at the pages each section names under\n**Keys**.\n\n## Calendar\n\n**The job.** Book visits on the days they happen, and see a week\'s work at a glance.\n\n**Read.** `layout: "calendar"` on the List; each visit stands from `scheduled_for` over its span to `ends_at`, the two `required` moments of its facts (`ends_at` is ordered after `scheduled_for` by its `min`); a keyed calendar names the date and the end itself.\n\n**Keys.** `reference/calendar`\n\n**Not when.** Rows booked on a resource that two may not share at once \u2014 that is `lanes`. Rows with a date nobody plans by (an invoice\'s date) stay a table.\n\n```json\n{\n "tables": [\n {\n "ref": "service_visit",\n "title": "customer",\n "fields": {\n "customer": {"required": true, "type": "link", "table": "customer", "multi": false},\n "scheduled_for": {"required": true, "type": "date", "format": "datetime"},\n "ends_at": {"required": true, "type": "date", "format": "datetime", "min": "scheduled_for"},\n "engineer": {"type": "link", "table": "engineer", "multi": false},\n "job": {\n "required": true,\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n "stage": {\n "type": "select",\n "options": [\n {"alias": "booked_on", "color": "blue"},\n {"alias": "parts_ready_on", "color": "blue"},\n {"alias": "arrived_on", "color": "blue"},\n {"alias": "completed_on", "color": "green"}\n ]\n },\n "booked_on": {"type": "date"},\n "parts_ready_on": {"type": "date"},\n "arrived_on": {"type": "date"},\n "hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}},\n "report": {"type": "text", "format": "markdown"},\n "completed_on": {"type": "date"}\n },\n "records": {\n "subtitle": ["scheduled_for", "ends_at"],\n "figure": "hours",\n "due": ["scheduled_for"],\n "status": {\n "field": "stage",\n "closed": ["completed_on"],\n "dates": {\n "booked_on": "booked_on",\n "parts_ready_on": "parts_ready_on",\n "arrived_on": "arrived_on",\n "completed_on": "completed_on"\n }\n }\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "visits",\n "name": "Service visits",\n "icon": "calendar",\n "color": "emerald",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "service_visit",\n "columns": ["engineer", "job"],\n "filters": ["customer"],\n "sort": {"field": "scheduled_for"},\n "layout": "calendar",\n "create": ["customer", "job", "scheduled_for", "ends_at", "engineer"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "label": "Repairs", "where": {"job": ["repair"]}},\n {"type": "Reading", "key": "register_reading_1", "value": "hours", "by": "engineer"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "service_visit",\n "children": [\n {\n "type": "Section",\n "key": "visit",\n "title": "Visit",\n "at": ["booked_on", "parts_ready_on"],\n "children": [\n "job",\n "booked_on",\n "parts_ready_on",\n {\n "type": "Act",\n "key": "reschedule",\n "label": "Reschedule",\n "asks": ["scheduled_for", "ends_at"],\n "when": {"stage": ["booked_on", "parts_ready_on"]}\n },\n {\n "type": "Act",\n "key": "to_booked_on",\n "label": "Booked",\n "when": {"stage": {"empty": true}},\n "asks": [{"field": "booked_on", "starts": "today"}],\n "set": {"stage": "booked_on"}\n },\n {\n "type": "Act",\n "key": "to_parts_ready_on",\n "label": "Parts ready",\n "when": {"stage": ["booked_on"], "job": ["repair"]},\n "asks": [{"field": "parts_ready_on", "starts": "today"}],\n "set": {"stage": "parts_ready_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on",\n "label": "On site",\n "when": {"stage": ["booked_on"], "job": ["inspection"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on_2",\n "label": "On site",\n "when": {"stage": ["parts_ready_on"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "report",\n "title": "Report",\n "at": ["arrived_on"],\n "children": [\n "engineer",\n "arrived_on",\n {"field": "report", "block": false},\n {\n "type": "Act",\n "key": "complete",\n "label": "Complete visit",\n "requires": ["engineer"],\n "asks": [\n "hours",\n {"input": "summary", "label": "What was done", "type": "long_text", "required": true}\n ],\n "set": {"report": {"input": "summary"}, "stage": "completed_on"},\n "when": {"stage": ["arrived_on"]}\n },\n {\n "type": "Act",\n "key": "clear_visit_hours",\n "label": "Clear hours",\n "set": {"hours": null},\n "confirm": true\n }\n ]\n }\n ]\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "engineer", "add": ["name", "base"]},\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Lanes\n\n**The job.** Put each service visit on an engineer\'s day by the hour, and see at once who is free between visits.\n\n**Read.** `layout` `lanes` with `by` naming the one-row link to the resource (the engineer); every engineer stands as a lane, empty or not.\n\n**Keys.** `reference/lanes`\n\n**Not when.** The resource is not a row of the model (a free-text room name), or rows never compete for one \u2014 a `calendar` reads them by day.\n\n```json\n{\n "tables": [\n {\n "ref": "service_visit",\n "title": "customer",\n "fields": {\n "customer": {"type": "link", "table": "customer", "multi": false},\n "scheduled_for": {"type": "date", "format": "datetime"},\n "ends_at": {"type": "date", "format": "datetime"},\n "engineer": {"type": "link", "table": "engineer", "multi": false},\n "job": {\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n "stage": {\n "type": "select",\n "options": [\n {"alias": "booked_on", "color": "blue"},\n {"alias": "parts_ready_on", "color": "blue"},\n {"alias": "arrived_on", "color": "blue"},\n {"alias": "completed_on", "color": "green"}\n ]\n },\n "booked_on": {"type": "date"},\n "parts_ready_on": {"type": "date"},\n "arrived_on": {"type": "date"},\n "hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}},\n "completed_on": {"type": "date"}\n },\n "records": {\n "subtitle": ["scheduled_for", "ends_at"],\n "figure": "hours",\n "due": ["scheduled_for"],\n "status": {\n "field": "stage",\n "closed": ["completed_on"],\n "dates": {\n "booked_on": "booked_on",\n "parts_ready_on": "parts_ready_on",\n "arrived_on": "arrived_on",\n "completed_on": "completed_on"\n }\n }\n }\n },\n {\n "ref": "engineer",\n "title": "name",\n "fields": {"name": {"type": "text"}, "base": {"type": "link", "table": "warehouse", "multi": false}},\n "records": {"subtitle": ["base"], "party": "person"}\n }\n ],\n "body": {\n "type": "App",\n "key": "dispatch",\n "name": "Dispatch",\n "icon": "wrench",\n "color": "sky",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "service_visit",\n "columns": ["job"],\n "search": ["customer"],\n "layout": {"lanes": {"by": "engineer"}},\n "create": ["engineer", "scheduled_for", "ends_at", "customer", "job"]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "service_visit",\n "children": [\n {\n "type": "Section",\n "key": "booking",\n "title": "Booking",\n "children": [\n "engineer",\n "job",\n {\n "type": "Act",\n "key": "to_booked_on",\n "label": "Booked",\n "when": {"stage": {"empty": true}},\n "asks": [{"field": "booked_on", "starts": "today"}],\n "set": {"stage": "booked_on"}\n },\n {\n "type": "Act",\n "key": "to_parts_ready_on",\n "label": "Parts ready",\n "when": {"stage": ["booked_on"], "job": ["repair"]},\n "asks": [{"field": "parts_ready_on", "starts": "today"}],\n "set": {"stage": "parts_ready_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on",\n "label": "On site",\n "when": {"stage": ["booked_on"], "job": ["inspection"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on_2",\n "label": "On site",\n "when": {"stage": ["parts_ready_on"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_completed_on",\n "label": "Completed",\n "when": {"stage": ["arrived_on"]},\n "asks": [{"field": "completed_on", "starts": "today"}],\n "set": {"stage": "completed_on"}\n }\n ]\n }\n ],\n "row": {"subtitle": [{"field": "scheduled_for", "edit": false}, {"field": "ends_at", "edit": false}]}\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "engineer", "add": ["name", "base"]},\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Gantt\n\n**The job.** Read every hire as a bar from the day the machine goes out to the day it is due back, against today.\n\n**Read.** `layout` `gantt` with its `start`; with no end stated, the bar ends at the entity\'s first `due`. The day a hire comes back (`ngay_tra`) is stamped by the status\'s `dates`, so no act sets it.\n\n**Keys.** `reference/gantt`\n\n**Not when.** Rows that last a day or less (a visit, a shift) \u2014 `calendar` or `lanes`; a plan with no dates set yet.\n\n```json\n{\n "tables": [\n {\n "ref": "phieu_thue",\n "title": "khach_hang",\n "fields": {\n "khach_hang": {"type": "link", "table": "khach_hang", "multi": false},\n "so_phieu": {"type": "text"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "moi", "color": "slate"},\n {"alias": "dang_thue", "color": "blue"},\n {"alias": "da_tra", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n "phu_trach": {"type": "member"},\n "ngay_giao": {"type": "date"},\n "han_tra": {"type": "date"},\n "ngay_tra": {"type": "date"},\n "tinh_trang_tra": {\n "type": "select",\n "options": [\n {"alias": "tot", "color": "green"},\n {"alias": "tray_xuoc", "color": "amber"},\n {"alias": "hu_hong", "color": "red"}\n ]\n },\n "so_ngay": {"type": "formula"},\n "tong_tien": {"type": "rollup"}\n },\n "records": {\n "subtitle": ["so_phieu"],\n "figure": "tong_tien",\n "due": ["han_tra"],\n "status": {"field": "trang_thai", "closed": ["da_tra", "huy"], "dates": {"da_tra": "ngay_tra"}}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "tien_do_thue",\n "name": "Ti\u1EBFn \u0111\u1ED9 cho thu\xEA",\n "icon": "calendar-range",\n "color": "teal",\n "children": [\n {\n "type": "List",\n "entity": "phieu_thue",\n "columns": ["phu_trach"],\n "filters": ["phu_trach", "khach_hang"],\n "layout": {"gantt": {"start": "ngay_giao"}},\n "create": false,\n "remove": false,\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "Phi\u1EBFu \u0111ang cho thu\xEA",\n "where": {"trang_thai": ["dang_thue"]}\n },\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Ti\u1EC1n thu\xEA \u0111ang ch\u1EA1y",\n "value": "tong_tien",\n "where": {"trang_thai": ["dang_thue"]}\n }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "phieu_thue",\n "children": [\n {\n "type": "Section",\n "key": "phieu_thue",\n "title": "Phi\u1EBFu thu\xEA",\n "children": ["ngay_giao", "han_tra"]\n },\n {\n "type": "Section",\n "key": "dang_thue",\n "title": "\u0110ang thu\xEA",\n "at": ["dang_thue"],\n "children": [\n "so_ngay",\n "ngay_tra",\n {\n "type": "Act",\n "key": "nhan_tra",\n "label": "Nh\u1EADn m\xE1y tr\u1EA3",\n "when": {"trang_thai": ["dang_thue"]},\n "asks": ["tinh_trang_tra"],\n "set": {"trang_thai": "da_tra"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "mo_lai",\n "label": "M\u1EDF l\u1EA1i",\n "when": {"trang_thai": ["da_tra"]},\n "set": {"trang_thai": "dang_thue"},\n "confirm": true\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\n## Roster\n\n**The job.** See who works which shift on each day of the week or the month.\n\n**Read.** `layout: "roster"` over the people; the child List (`lich_truc`) is the rows that fill the days \u2014 one link back and a date on its line.\n\n**Keys.** `reference/roster`\n\n**Not when.** Rows that are themselves the bookings (a stay over several days) \u2014 a `calendar` or `lanes` draws them; a roster\'s row is what the days are filled for.\n\n```json\n{\n "tables": [\n {\n "ref": "nha_si",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "chuyen_mon": {\n "type": "select",\n "options": [\n {"alias": "tong_quat", "color": "blue"},\n {"alias": "chinh_nha", "color": "purple"},\n {"alias": "nha_chu", "color": "green"},\n {"alias": "phuc_hinh", "color": "orange"}\n ]\n },\n "dien_thoai": {"type": "text"}\n },\n "records": {"subtitle": ["chuyen_mon"], "party": "person"}\n },\n {\n "ref": "lich_truc",\n "title": "ca",\n "fields": {\n "nha_si": {"type": "link", "table": "nha_si", "multi": false},\n "ca": {\n "type": "select",\n "options": [\n {"alias": "sang", "color": "blue"},\n {"alias": "chieu", "color": "purple"},\n {"alias": "ca_ngay", "color": "green"},\n {"alias": "nghi", "color": "gray"}\n ]\n },\n "ngay": {"type": "date"},\n "ghe": {"type": "link", "table": "ghe", "multi": false}\n },\n "records": {"subtitle": ["ngay", "ghe"]}\n }\n ],\n "body": {\n "type": "App",\n "key": "lich_truc",\n "name": "L\u1ECBch tr\u1EF1c",\n "icon": "users",\n "color": "indigo",\n "children": [\n {\n "type": "List",\n "entity": "nha_si",\n "filters": ["chuyen_mon"],\n "layout": "roster",\n "create": ["ho_ten", "chuyen_mon", "dien_thoai"],\n "children": [{"type": "List", "entity": "lich_truc", "create": true, "remove": true}]\n }\n ],\n "pages": [{"type": "Record", "entity": "lich_truc"}, {"type": "Record", "entity": "ghe", "add": ["ten", "phong"]}]\n }\n}\n```\n\n## Cards\n\n**The job.** Find an item by its picture, and count what the shelf holds.\n\n**Read.** `layout: "cards"` over rows whose `records.image` is a photo; `scope` keeps the app inside one warehouse at a time.\n\n**Keys.** `reference/cards`, `reference/records`, `reference/app-node`\n\n**Not when.** Rows with no picture \u2014 cards of words are a table drawn worse.\n\n```json\n{\n "tables": [\n {\n "ref": "stock_item",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "warehouse": {"type": "link", "table": "warehouse", "multi": false},\n "photo": {"type": "files"},\n "sku": {"type": "text"},\n "category": {\n "type": "select",\n "options": [\n {"alias": "pumps", "color": "blue"},\n {"alias": "valves", "color": "teal"},\n {"alias": "seals", "color": "amber"},\n {"alias": "motors", "color": "violet"}\n ]\n },\n "on_hand": {"type": "number"},\n "minimum": {"type": "number"},\n "price": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "supplier_page": {"type": "text", "format": "link"},\n "last_counted": {"type": "date"},\n "counted_by": {"type": "member"},\n "count_note": {"type": "text"}\n },\n "records": {\n "subtitle": ["sku", "category"],\n "image": "photo",\n "figure": "on_hand",\n "limits": {"on_hand": 400},\n "gates": {"on_hand": "minimum"}\n }\n },\n {\n "ref": "order_line",\n "title": "item",\n "fields": {\n "item": {"type": "link", "table": "stock_item", "multi": false},\n "order": {"type": "link", "table": "order", "multi": false},\n "quantity": {"type": "number"},\n "shipped": {"type": "number"},\n "picked": {"type": "number"},\n "unit_price": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "amount": {"type": "formula", "notation": {"style": "currency", "currency": "USD"}},\n "settled": {"type": "formula"},\n "category": {"type": "lookup"}\n },\n "records": {\n "subtitle": ["order", "unit_price"],\n "figure": "amount",\n "limits": {"shipped": "quantity", "picked": "quantity"}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "stock",\n "name": "Stock",\n "icon": "boxes",\n "color": "teal",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]}\n },\n "scope": "warehouse",\n "children": [\n {\n "type": "List",\n "entity": "stock_item",\n "columns": ["price"],\n "filters": ["on_hand"],\n "search": ["name", "sku"],\n "layout": "cards",\n "children": [\n {"type": "Reading", "key": "register_reading_0", "value": "on_hand", "by": "category"},\n {"type": "Export", "key": "export"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "stock_item",\n "children": [\n {\n "type": "Section",\n "key": "item",\n "title": "Item",\n "children": ["price", "minimum", "supplier_page"]\n },\n {\n "type": "Section",\n "key": "last_count",\n "title": "Last count",\n "children": [\n "last_counted",\n "counted_by",\n "count_note",\n {\n "type": "Act",\n "key": "count",\n "label": "Count stock",\n "asks": [\n {"input": "counted", "label": "Units on the shelf", "type": "number", "required": true},\n {"input": "remark", "label": "Remark", "type": "long_text"}\n ],\n "set": {\n "on_hand": {"input": "counted"},\n "last_counted": {"now": true},\n "counted_by": {"me": true},\n "count_note": {"input": "remark"}\n }\n }\n ]\n },\n {\n "type": "Section",\n "key": "on_order",\n "title": "On order",\n "children": [{"type": "List", "entity": "order_line"}]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "order_line",\n "children": ["quantity", "shipped", {"type": "Check", "field": "settled", "on": ["update"]}]\n },\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Party\n\n**The job.** Keep each customer account \u2014 who they are, what they ordered, what was said to them.\n\n**Read.** `records.customer.party: "organization"` and its `image` (the logo); a List with `layout: "timeline"` for the touches, a Reading `by` the day placed for its orders, and its papers `expect`ed by kind.\n\n**Keys.** `reference/records`, `reference/layouts`, `reference/list-node`, `reference/reading-node`\n\n**Not when.** A list of customers is not a job by itself: the customer is a link on the desk whose rows name it, unless the job is the account itself.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "logo": {"type": "files"},\n "code": {"type": "text"},\n "tier": {\n "type": "select",\n "options": [\n {"alias": "key", "color": "violet"},\n {"alias": "standard", "color": "sky"},\n {"alias": "lapsed", "color": "gray"}\n ]\n },\n "phone": {"type": "text"},\n "website": {"type": "text", "format": "link"},\n "account_manager": {"type": "member"},\n "credit_limit": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "orders": {"type": "link", "table": "order", "multi": true},\n "outstanding": {"type": "rollup"},\n "over_limit": {"type": "formula"},\n "papers_needed": {\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ],\n "multi": true\n },\n "notes": {"type": "text", "format": "markdown"}\n },\n "records": {\n "subtitle": ["tier"],\n "image": "logo",\n "party": "organization",\n "figure": "outstanding",\n "limits": {"outstanding": "credit_limit"}\n }\n },\n {\n "ref": "order",\n "title": "reference",\n "fields": {\n "customer": {"type": "link", "table": "customer", "multi": false},\n "reference": {"type": "text"},\n "stage": {\n "type": "select",\n "options": [\n {"alias": "draft", "color": "slate"},\n {"alias": "confirmed", "color": "blue"},\n {"alias": "picking", "color": "amber"},\n {"alias": "shipped", "color": "indigo"},\n {"alias": "received", "color": "green"},\n {"alias": "cancelled", "color": "rose"}\n ]\n },\n "placed": {"type": "date"},\n "due_date": {"type": "date"},\n "handler": {"type": "member"},\n "priority": {"type": "boolean"},\n "lines": {"type": "link", "table": "order_line", "multi": true},\n "payments": {"type": "link", "table": "payment", "multi": true},\n "total": {"type": "rollup"},\n "balance": {"type": "formula", "notation": {"style": "currency", "currency": "USD"}},\n "units_ordered": {"type": "rollup"},\n "units_shipped": {"type": "rollup"},\n "units_picked": {"type": "rollup"},\n "carrier": {"type": "text"},\n "tracking_no": {"type": "text"},\n "shipped_on": {"type": "date"},\n "cancellation_reason": {"type": "text"},\n "cancelled_by": {"type": "member"},\n "replaced_by": {"type": "link", "table": "order", "multi": false},\n "attachments": {"type": "files"},\n "delivery_note": {"type": "files"},\n "notes": {"type": "text", "format": "markdown"},\n "paid_in_full": {"type": "formula"},\n "has_payments": {"type": "formula"},\n "reminder_ref": {"type": "text"}\n },\n "records": {\n "subtitle": ["customer", "placed"],\n "figure": "total",\n "limits": {"units_shipped": "units_ordered", "units_picked": "units_ordered"},\n "due": ["due_date"],\n "status": {\n "field": "stage",\n "closed": ["received", "cancelled"],\n "dates": {"shipped": "shipped_on"},\n "history": "order_stage"\n }\n }\n },\n {\n "ref": "customer_paper",\n "title": "kind",\n "fields": {\n "kind": {\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ]\n },\n "customer": {"type": "link", "table": "customer", "multi": false},\n "received_on": {"type": "date"},\n "file": {"type": "files"}\n },\n "records": {"image": "file"}\n },\n {\n "ref": "touch",\n "title": "said",\n "fields": {\n "said": {"type": "text"},\n "customer": {"type": "link", "table": "customer", "multi": false},\n "on": {"type": "date"},\n "by": {"type": "member"}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "customers",\n "name": "Customers",\n "icon": "users",\n "color": "violet",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "touch": {"any": [{"member_of": "sales"}]},\n "customer_paper": {"any": [{"member_of": "sales"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["phone", "account_manager"],\n "filters": ["account_manager"],\n "sort": {"field": "name"},\n "opens": {"tier": ["key", "standard"]},\n "create": ["name", "code", "credit_limit"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "value": "outstanding", "by": "tier"},\n {"type": "Reading", "key": "register_reading_1", "value": "outstanding", "by": "account_manager"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "door": "drawer",\n "children": [\n {"type": "Section", "key": "contact", "title": "Contact", "children": ["phone", "website"]},\n {\n "type": "Section",\n "key": "account",\n "title": "Account",\n "children": [\n "code",\n "account_manager",\n "credit_limit",\n {\n "type": "Act",\n "key": "reassign",\n "label": "Reassign",\n "asks": [{"input": "to", "label": "Account manager", "type": "member", "required": true}],\n "set": {"account_manager": {"input": "to"}}\n },\n {\n "type": "Act",\n "key": "lapse",\n "label": "Mark lapsed",\n "when": {"tier": ["key", "standard"]},\n "set": {"tier": "lapsed"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "reinstate",\n "label": "Reinstate",\n "when": {"tier": ["lapsed"]},\n "asks": [\n {\n "input": "back_to",\n "label": "Back to",\n "type": "select",\n "options": [\n {\n "alias": "key",\n "label": "Key account",\n "color": "violet",\n "mark": {"kind": "icon", "name": "building-2"}\n },\n {"alias": "standard", "label": "Standard", "color": "sky"}\n ],\n "required": true\n }\n ],\n "set": {"tier": {"input": "back_to"}}\n }\n ]\n },\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [\n {\n "type": "Reading",\n "key": "block_reading_0",\n "label": "Order value",\n "entity": "order",\n "value": "total",\n "where": {"stage": ["confirmed", "picking", "shipped", "received"]},\n "by": "placed"\n },\n {\n "type": "List",\n "entity": "order",\n "where": {"stage": ["draft", "confirmed", "picking", "shipped"]},\n "label": "Open orders",\n "columns": ["due_date"],\n "create": false\n },\n {\n "type": "List",\n "key": "order_2",\n "entity": "order",\n "where": {"stage": ["shipped", "received"], "paid_in_full": false},\n "label": "Shipped, still owed",\n "columns": ["balance"],\n "create": false\n },\n {\n "type": "List",\n "key": "block_reading_3",\n "entity": "service_visit",\n "columns": ["engineer", "job"],\n "edit": false\n }\n ]\n },\n {\n "type": "Section",\n "key": "account_papers",\n "title": "Account papers",\n "children": [\n {\n "type": "List",\n "entity": "customer_paper",\n "expect": {"field": "kind", "of": "papers_needed"},\n "columns": ["received_on"]\n }\n ]\n },\n {\n "type": "Section",\n "key": "contact_log",\n "title": "Contact log",\n "children": [{"type": "List", "entity": "touch", "layout": "timeline"}]\n },\n {"type": "Section", "key": "notes", "title": "Notes", "children": ["notes"]},\n {"type": "Check", "field": "over_limit"}\n ]\n },\n {\n "type": "Record",\n "entity": "order",\n "children": [\n "due_date",\n "handler",\n {"field": "priority", "edit": false},\n "lines",\n "payments",\n {"field": "carrier", "edit": false},\n {"field": "tracking_no", "edit": false},\n {"field": "shipped_on", "edit": false},\n {"field": "cancellation_reason", "edit": false},\n {"field": "cancelled_by", "edit": false},\n {"field": "replaced_by", "edit": false},\n {"field": "attachments", "edit": false},\n "delivery_note",\n "notes",\n {"field": "reminder_ref", "edit": false},\n {"type": "Check", "field": "paid_in_full", "on": ["update"]},\n {"type": "Check", "field": "has_payments"}\n ]\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "stock_item", "add": ["name", "warehouse", "sku", "category"]},\n {"type": "Record", "entity": "order_line", "add": ["item", "quantity"]}\n ]\n }\n}\n```\n\n## Case\n\n**The job.** Gather an applicant\'s papers into one case, make the forms it needs, and file it on time.\n\n**Read.** Lists with `expect` for the papers brought (one line per kind, the missing ones empty), an Act\'s `templates` for the forms made (ticked and made at once, kept in `into`), and `intake` reading the papers brought.\n\n**Keys.** `reference/list-node`, `reference/act-node`\n\n**Not when.** A record that needs no papers, or one paper made once \u2014 a single `template` act.\n\n```json\n{\n "tables": [\n {\n "ref": "ho_so",\n "title": "khach_hang",\n "fields": {\n "khach_hang": {"type": "link", "table": "khach_hang", "multi": false},\n "du_an": {"type": "link", "table": "du_an", "multi": false},\n "ma_ho_so": {"type": "autonumber"},\n "dich_vu": {\n "type": "select",\n "options": [{"alias": "tron_goi", "color": "blue"}, {"alias": "lam_ho_so", "color": "violet"}]\n },\n "doi_tuong": {\n "type": "select",\n "options": [\n {"alias": "thu_nhap_thap", "color": "sky"},\n {"alias": "cong_nhan", "color": "teal"},\n {"alias": "can_bo", "color": "indigo"},\n {"alias": "luc_luong", "color": "green"},\n {"alias": "ho_ngheo", "color": "amber"},\n {"alias": "nguoi_co_cong", "color": "rose"}\n ]\n },\n "tinh_trang_nha_o": {\n "type": "select",\n "options": [{"alias": "chua_co_nha", "color": "gray"}, {"alias": "nha_chat", "color": "orange"}]\n },\n "giay_chung_nhan_so": {"type": "text"},\n "dien_tich_nha": {"type": "number"},\n "sale": {"type": "member"},\n "xu_ly": {"type": "member"},\n "can_bo_sung": {"type": "boolean"},\n "phi_dich_vu": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "loai_can": {\n "type": "select",\n "options": [\n {"alias": "studio", "color": "sky"},\n {"alias": "mot_pn", "color": "blue"},\n {"alias": "hai_pn", "color": "indigo"},\n {"alias": "ba_pn", "color": "violet"}\n ]\n },\n "giai_doan": {\n "type": "select",\n "options": [\n {"alias": "ngay_thu_phi", "color": "blue"},\n {"alias": "ngay_nhan_giay_to", "color": "blue"},\n {"alias": "ngay_lap_ho_so", "color": "blue"},\n {"alias": "ngay_nop_cdt", "color": "blue"},\n {"alias": "ngay_cdt_duyet", "color": "blue"},\n {"alias": "ngay_so_xd_duyet", "color": "blue"},\n {"alias": "ngay_boc_tham", "color": "blue"},\n {"alias": "ngay_ky_hdmb", "color": "green"},\n {"alias": "ngay_ban_giao", "color": "green"}\n ]\n },\n "ngay_thu_phi": {"type": "date"},\n "ngay_nhan_giay_to": {"type": "date"},\n "ngay_lap_ho_so": {"type": "date"},\n "ngay_nop_cdt": {"type": "date"},\n "ngay_cdt_duyet": {"type": "date"},\n "ngay_so_xd_duyet": {"type": "date"},\n "ngay_boc_tham": {"type": "date"},\n "ngay_ky_hdmb": {"type": "date"},\n "ngay_ban_giao": {"type": "date"},\n "bo_ho_so": {"type": "files"},\n "giay_to": {"type": "link", "table": "giay_to", "multi": true},\n "thanh_vien": {"type": "link", "table": "thanh_vien", "multi": true},\n "phieu_thu": {"type": "link", "table": "phieu_thu", "multi": true},\n "dien_thoai": {"type": "lookup"},\n "cccd": {"type": "lookup"},\n "ngay_sinh": {"type": "lookup"},\n "da_thu": {"type": "rollup"},\n "chua_thu_phi": {"type": "formula"},\n "con_no_phi": {"type": "formula"},\n "vuot_thu_nhap": {"type": "formula"},\n "da_hoan_tat": {"type": "formula"}\n },\n "records": {\n "subtitle": ["dich_vu"],\n "figure": "phi_dich_vu",\n "status": {\n "field": "giai_doan",\n "closed": ["ngay_ky_hdmb", "ngay_ban_giao"],\n "dates": {\n "ngay_thu_phi": "ngay_thu_phi",\n "ngay_nhan_giay_to": "ngay_nhan_giay_to",\n "ngay_lap_ho_so": "ngay_lap_ho_so",\n "ngay_nop_cdt": "ngay_nop_cdt",\n "ngay_cdt_duyet": "ngay_cdt_duyet",\n "ngay_so_xd_duyet": "ngay_so_xd_duyet",\n "ngay_boc_tham": "ngay_boc_tham",\n "ngay_ky_hdmb": "ngay_ky_hdmb",\n "ngay_ban_giao": "ngay_ban_giao"\n }\n }\n }\n },\n {\n "ref": "thanh_vien",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "quan_he": {\n "type": "select",\n "options": [\n {"alias": "nguoi_dung_don", "color": "blue"},\n {"alias": "vo_chong", "color": "violet"},\n {"alias": "con", "color": "teal"},\n {"alias": "bo_me", "color": "amber"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n "ngay_sinh": {"type": "date"},\n "cccd": {"type": "text"},\n "thu_nhap": {"type": "number", "notation": {"style": "currency", "currency": "VND"}}\n },\n "records": {"subtitle": ["quan_he", "cccd"], "party": "person", "figure": "thu_nhap"}\n },\n {\n "ref": "giay_to",\n "title": "loai",\n "fields": {\n "loai": {\n "type": "select",\n "options": [\n {"alias": "don_dang_ky", "color": "blue"},\n {"alias": "can_cuoc", "color": "sky"},\n {"alias": "giay_doi_tuong", "color": "violet"},\n {"alias": "xac_nhan_nha_o", "color": "teal"},\n {"alias": "xac_nhan_thu_nhap", "color": "amber"},\n {"alias": "hon_nhan", "color": "indigo"}\n ]\n },\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "ngay_nhan": {"type": "date"},\n "tep": {"type": "files"}\n },\n "records": {"image": "tep", "starts": {"ngay_nhan": "today"}}\n },\n {\n "ref": "phieu_thu",\n "title": "khoan",\n "fields": {\n "khoan": {\n "type": "select",\n "options": [\n {"alias": "dat_coc", "color": "blue"},\n {"alias": "tat_toan", "color": "indigo"},\n {"alias": "phi_ho_so", "color": "violet"}\n ]\n },\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "hinh_thuc": {\n "type": "select",\n "options": [\n {"alias": "tien_mat", "color": "green", "mark": {"kind": "icon", "name": "banknote"}},\n {"alias": "chuyen_khoan", "color": "blue", "mark": {"kind": "icon", "name": "arrow-right-left"}}\n ]\n },\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "cho_thu", "color": "amber"},\n {"alias": "da_thu", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n "ngay_thu": {"type": "date"}\n },\n "records": {\n "subtitle": ["hinh_thuc", "ngay_thu"],\n "figure": "so_tien",\n "status": {"field": "trang_thai", "closed": ["da_thu", "huy"]}\n }\n }\n ],\n "templates": [\n {"alias": "don_dang_ky", "type": "html", "label": "\u0110\u01A1n \u0111\u0103ng k\xFD mua nh\xE0 \u1EDF x\xE3 h\u1ED9i"},\n {"alias": "mau_02_chua_co_nha", "type": "html", "label": "M\u1EABu 02 \u2014 X\xE1c nh\u1EADn ch\u01B0a c\xF3 nh\xE0 \u1EDF"},\n {"alias": "mau_03_nha_chat", "type": "html", "label": "M\u1EABu 03 \u2014 X\xE1c nh\u1EADn nh\xE0 \u1EDF d\u01B0\u1EDBi 15 m\xB2/ng\u01B0\u1EDDi"},\n {"alias": "mau_05_thu_nhap", "type": "html", "label": "M\u1EABu 05 \u2014 X\xE1c nh\u1EADn thu nh\u1EADp"},\n {"alias": "danh_sach_nop", "type": "html", "label": "Danh s\xE1ch h\u1ED3 s\u01A1 n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0"}\n ],\n "body": {\n "type": "App",\n "key": "ho_so",\n "name": "H\u1ED3 s\u01A1 nh\xE0 \u1EDF x\xE3 h\u1ED9i",\n "icon": "folder-open",\n "color": "blue",\n "scope": "du_an",\n "folders": "cac_du_an",\n "children": [\n {\n "type": "List",\n "entity": "ho_so",\n "columns": ["doi_tuong", "xu_ly", "can_bo_sung"],\n "filters": ["xu_ly", "can_bo_sung"],\n "search": ["khach_hang", "ma_ho_so", "dien_thoai"],\n "create": ["khach_hang", "dich_vu", "doi_tuong", "tinh_trang_nha_o", "loai_can", "phi_dich_vu", "sale"],\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "Ch\u1EDD kh\xE1ch b\u1ED5 sung",\n "where": {"can_bo_sung": true}\n },\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Ph\xED \u0111\xE3 thu",\n "value": "da_thu",\n "over": "ngay_nhan_giay_to"\n },\n {"type": "Reading", "key": "register_reading_2", "by": "doi_tuong"},\n {"type": "Export", "key": "export"},\n {\n "type": "Act",\n "key": "in_danh_sach",\n "label": "In danh s\xE1ch n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "on": "view",\n "template": "danh_sach_nop"\n }\n ]\n },\n {\n "type": "List",\n "entity": "du_an",\n "key": "cac_du_an",\n "columns": ["han_nop"],\n "create": false,\n "sort": {"field": "han_nop"},\n "children": [{"type": "Reading", "key": "du_an_theo_trang_thai", "by": "trang_thai"}]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "ho_so",\n "children": [\n {\n "type": "Section",\n "key": "nguoi_dung_don",\n "title": "Ng\u01B0\u1EDDi \u0111\u1EE9ng \u0111\u01A1n",\n "children": [\n "ma_ho_so",\n {"field": "khach_hang", "block": true, "label": "Th\xF4ng tin c\xE1 nh\xE2n"},\n {\n "type": "Fieldset",\n "key": "dieu_kien",\n "label": "\u0110i\u1EC1u ki\u1EC7n mua",\n "children": ["doi_tuong", "tinh_trang_nha_o"]\n },\n {\n "type": "Fieldset",\n "key": "phu_trach",\n "label": "Ph\u1EE5 tr\xE1ch",\n "children": ["sale", "xu_ly", "can_bo_sung"]\n },\n {\n "type": "Fieldset",\n "key": "moc",\n "label": "M\u1ED1c h\u1ED3 s\u01A1",\n "children": ["ngay_ky_hdmb", "ngay_ban_giao"]\n },\n {\n "type": "List",\n "entity": "thanh_vien",\n "label": "H\u1ED9 gia \u0111\xECnh",\n "columns": ["ngay_sinh"],\n "create": ["ho_ten", "quan_he", "ngay_sinh", "cccd", "thu_nhap"]\n },\n {\n "type": "List",\n "entity": "giay_to",\n "expect": {"field": "loai", "only": ["can_cuoc", "hon_nhan"]},\n "label": "Gi\u1EA5y t\u1EDD c\xE1 nh\xE2n",\n "columns": ["ngay_nhan"]\n },\n {\n "type": "Act",\n "key": "doc_giay_to",\n "label": "\u0110\u1ECDc gi\u1EA5y t\u1EDD",\n "intake": "giay_to",\n "fills": [\n "doi_tuong",\n "tinh_trang_nha_o",\n "giay_chung_nhan_so",\n "dien_tich_nha",\n "khach_hang.ho_ten",\n "khach_hang.cccd",\n "khach_hang.ngay_sinh",\n "khach_hang.dia_chi",\n "thanh_vien"\n ]\n },\n {\n "type": "Act",\n "key": "giao_xu_ly",\n "label": "Giao ng\u01B0\u1EDDi x\u1EED l\xFD",\n "asks": [{"input": "nguoi", "label": "Ng\u01B0\u1EDDi x\u1EED l\xFD", "type": "member", "required": true}],\n "set": {"xu_ly": {"input": "nguoi"}}\n },\n {\n "type": "Act",\n "key": "chuyen_du_an",\n "label": "Chuy\u1EC3n d\u1EF1 \xE1n",\n "asks": [\n {\n "input": "du_an_moi",\n "label": "Sang d\u1EF1 \xE1n",\n "type": "link",\n "entity": "du_an",\n "required": true\n }\n ],\n "set": {"du_an": {"input": "du_an_moi"}},\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "bo_ho_so",\n "title": "B\u1ED9 h\u1ED3 s\u01A1",\n "at": ["ngay_nhan_giay_to", "ngay_lap_ho_so"],\n "children": [\n "ngay_nhan_giay_to",\n "ngay_lap_ho_so",\n {\n "type": "Act",\n "key": "tao_giay_to",\n "label": "T\u1EA1o gi\u1EA5y t\u1EDD",\n "templates": [\n {"template": "don_dang_ky"},\n {"template": "mau_02_chua_co_nha", "when": {"tinh_trang_nha_o": ["chua_co_nha"]}},\n {"template": "mau_03_nha_chat", "when": {"tinh_trang_nha_o": ["nha_chat"]}}\n ],\n "into": "bo_ho_so",\n "when": {"giai_doan": ["ngay_nhan_giay_to", "ngay_lap_ho_so"]}\n },\n {\n "type": "Act",\n "key": "nop_cdt",\n "label": "N\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "when": {"dich_vu": ["tron_goi"], "giai_doan": ["ngay_lap_ho_so"]},\n "requires": ["bo_ho_so", "loai_can"],\n "asks": ["loai_can"],\n "set": {"giai_doan": "ngay_nop_cdt"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "to_ngay_nhan_giay_to",\n "label": "\u0110\xE3 nh\u1EADn gi\u1EA5y t\u1EDD",\n "when": {"giai_doan": {"empty": true}, "dich_vu": ["tron_goi"]},\n "asks": [{"field": "ngay_nhan_giay_to", "starts": "today"}],\n "set": {"giai_doan": "ngay_nhan_giay_to"}\n },\n {\n "type": "Act",\n "key": "to_ngay_lap_ho_so",\n "label": "\u0110\xE3 l\u1EADp h\u1ED3 s\u01A1",\n "when": {"giai_doan": ["ngay_nhan_giay_to"], "dich_vu": ["tron_goi"]},\n "asks": [{"field": "ngay_lap_ho_so", "starts": "today"}],\n "set": {"giai_doan": "ngay_lap_ho_so"}\n },\n {\n "type": "Act",\n "key": "to_ngay_ban_giao",\n "label": "\u0110\xE3 b\xE0n giao h\u1ED3 s\u01A1",\n "when": {"giai_doan": ["ngay_nhan_giay_to"], "dich_vu": ["lam_ho_so"]},\n "asks": [{"field": "ngay_ban_giao", "starts": "today"}],\n "set": {"giai_doan": "ngay_ban_giao"}\n }\n ]\n },\n {\n "type": "Act",\n "key": "lap_mau_05",\n "label": "L\u1EADp m\u1EABu 05",\n "when": {"doi_tuong": ["thu_nhap_thap"]},\n "template": "mau_05_thu_nhap",\n "paper": "giay_to.xac_nhan_thu_nhap"\n },\n {"type": "Check", "field": "chua_thu_phi", "on": ["nop_cdt"]},\n {"type": "Check", "field": "con_no_phi"},\n {"type": "Check", "field": "vuot_thu_nhap"},\n {"type": "Check", "field": "da_hoan_tat", "on": ["doc_giay_to"]}\n ]\n },\n {"type": "Record", "entity": "du_an", "add": ["ten_du_an", "chu_dau_tu", "so_can"]}\n ]\n }\n}\n```\n\n## Calls\n\n**The job.** Call a lead from their record, and keep what was said as a touch on its timeline.\n\n**Read.** An Act\'s `record` (into the `timeline` child: audio, transcript, when and who) and `fills` (the touch\'s fields an agent fills from the transcript).\n\n**Keys.** `reference/act-node`, `reference/layouts`\n\n**Not when.** Calls made and logged elsewhere \u2014 a `timeline` with its own add keeps the note.\n\n```json\n{\n "tables": [\n {\n "ref": "khach_tiem_nang",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "ten_cong_ty": {"type": "text"},\n "vai_tro": {\n "type": "select",\n "options": [\n {"alias": "chu_doanh_nghiep", "color": "emerald"},\n {"alias": "ke_toan_truong", "color": "blue"},\n {"alias": "quan_ly", "color": "teal"},\n {"alias": "nhan_vien", "color": "sky"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "loai_hinh": {\n "type": "select",\n "options": [\n {"alias": "thuong_mai", "color": "blue"},\n {"alias": "san_xuat", "color": "amber"},\n {"alias": "dich_vu", "color": "violet"},\n {"alias": "xay_dung", "color": "orange"},\n {"alias": "ho_kinh_doanh", "color": "teal"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "quy_mo": {\n "type": "select",\n "options": [\n {"alias": "q_1_10", "color": "sky"},\n {"alias": "q_11_50", "color": "blue"},\n {"alias": "q_51_200", "color": "indigo"},\n {"alias": "q_200", "color": "violet"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "so_dien_thoai": {"type": "text"},\n "zalo": {"type": "text"},\n "email": {"type": "text"},\n "trang_ca_nhan": {"type": "text", "format": "link"},\n "anh": {"type": "files"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "moi", "color": "gray"},\n {"alias": "du_dieu_kien", "color": "blue"},\n {"alias": "da_lien_he", "color": "amber"},\n {"alias": "da_chuyen_doi", "color": "emerald"},\n {"alias": "loai", "color": "red"}\n ]\n },\n "ly_do_loai": {\n "type": "select",\n "options": [\n {"alias": "khong_phu_hop", "color": "orange"},\n {"alias": "qua_nho", "color": "amber"},\n {"alias": "chua_co_ngan_sach", "color": "yellow"},\n {"alias": "sai_nguoi", "color": "blue"},\n {"alias": "yeu_cau_dung", "color": "red"},\n {"alias": "trung", "color": "zinc"}\n ]\n },\n "vi_sao_du_dieu_kien": {"type": "text"},\n "phu_trach": {"type": "member"},\n "nguon": {"type": "link", "table": "kenh", "multi": false},\n "lien_he": {"type": "link", "table": "lien_he", "multi": false},\n "cong_ty": {"type": "link", "table": "cong_ty", "multi": false},\n "ngay_chuyen_doi": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "ghi_chu": {"type": "text", "format": "markdown"},\n "tin_hieu": {"type": "link", "table": "tin_hieu", "multi": true},\n "buoc_tiep": {"type": "link", "table": "buoc_tiep", "multi": true},\n "tuong_tac": {"type": "link", "table": "tuong_tac", "multi": true},\n "do_nong": {\n "type": "formula",\n "options": [\n {"alias": "nong", "label": "N\xF3ng", "color": "orange"},\n {"alias": "nguoi", "label": "Ngu\u1ED9i", "color": "sky"}\n ]\n },\n "han_buoc_tiep": {"type": "rollup"},\n "khong_lien_he": {"type": "formula"}\n },\n "records": {\n "subtitle": ["ten_cong_ty"],\n "image": "anh",\n "party": "person",\n "due": ["han_buoc_tiep"],\n "status": {\n "field": "trang_thai",\n "closed": ["da_chuyen_doi", "loai"],\n "dates": {"da_chuyen_doi": "ngay_chuyen_doi"}\n }\n }\n },\n {\n "ref": "tin_hieu",\n "title": "tom_tat",\n "fields": {\n "tom_tat": {"type": "text"},\n "noi_dung": {"type": "text", "format": "markdown"},\n "anh_chup": {"type": "files"},\n "lien_ket": {"type": "text", "format": "link"},\n "kenh": {"type": "link", "table": "kenh", "multi": false},\n "loai": {\n "type": "select",\n "options": [\n {"alias": "hoi_dich_vu", "color": "emerald"},\n {"alias": "than_phien", "color": "blue"},\n {"alias": "tuyen_ke_toan", "color": "amber"},\n {"alias": "moi_thanh_lap", "color": "violet"},\n {"alias": "gioi_thieu", "color": "teal"},\n {"alias": "danh_ba", "color": "zinc"},\n {"alias": "nhieu", "color": "stone"}\n ]\n },\n "ngay_dang": {"type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n "ngay_xay_ra": {"type": "formula"}\n },\n "records": {"subtitle": ["kenh", "ngay_xay_ra"], "image": "anh_chup"}\n },\n {\n "ref": "buoc_tiep",\n "title": "vi_sao_luc_nay",\n "fields": {\n "vi_sao_luc_nay": {"type": "text"},\n "viec": {\n "type": "select",\n "options": [\n {"alias": "binh_luan", "color": "blue", "mark": {"kind": "icon", "name": "message-square"}},\n {"alias": "nhan_facebook", "color": "violet", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "nhan_zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "gui_email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gui_bang_gia", "color": "amber", "mark": {"kind": "icon", "name": "receipt"}}\n ]\n },\n "ban_nhap": {"type": "text", "format": "markdown"},\n "han": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "tinh_trang": {\n "type": "select",\n "options": [\n {"alias": "cho", "color": "blue"},\n {"alias": "xong", "color": "emerald"},\n {"alias": "bo_qua", "color": "zinc"}\n ]\n }\n },\n "records": {\n "subtitle": ["viec"],\n "mark": "viec",\n "due": ["han"],\n "status": {"field": "tinh_trang", "closed": ["xong", "bo_qua"]}\n }\n },\n {\n "ref": "tuong_tac",\n "title": "tom_tat",\n "fields": {\n "tom_tat": {"type": "text"},\n "thoi_diem": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "qua": {\n "type": "select",\n "options": [\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "facebook", "color": "blue", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gap_truc_tiep", "color": "emerald", "mark": {"kind": "icon", "name": "users"}},\n {"alias": "khac", "color": "zinc", "mark": {"kind": "icon", "name": "ellipsis"}}\n ]\n },\n "phan_hoi": {\n "type": "select",\n "options": [\n {"alias": "dang_cho", "color": "blue"},\n {"alias": "da_tra_loi", "color": "green"},\n {"alias": "quan_tam", "color": "amber"},\n {"alias": "khong_phu_hop", "color": "red"},\n {"alias": "khong_phan_hoi", "color": "zinc"},\n {"alias": "sai_so", "color": "stone"}\n ]\n },\n "ghi_am": {"type": "files"},\n "man_hinh": {"type": "files"},\n "nguyen_van": {"type": "text", "format": "markdown"},\n "hen_lai": {"type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n "nguoi_thuc_hien": {"type": "member"}\n },\n "records": {"subtitle": ["qua", "phan_hoi"]}\n }\n ],\n "body": {\n "type": "App",\n "key": "khach_tiem_nang",\n "name": "Kh\xE1ch ti\u1EC1m n\u0103ng",\n "icon": "radar",\n "color": "violet",\n "children": [\n {\n "type": "List",\n "entity": "khach_tiem_nang",\n "columns": ["phu_trach", "han_buoc_tiep"],\n "filters": ["phu_trach"],\n "create": ["ho_ten", "trang_ca_nhan", "so_dien_thoai", "ten_cong_ty", "nguon"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "by": "phu_trach"},\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Kh\xE1ch chuy\u1EC3n \u0111\u1ED5i",\n "by": "ngay_chuyen_doi"\n }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "khach_tiem_nang",\n "children": [\n {\n "type": "Section",\n "key": "danh_gia",\n "title": "\u0110\xE1nh gi\xE1",\n "at": ["moi"],\n "children": [\n "vai_tro",\n "loai_hinh",\n "quy_mo",\n "vi_sao_du_dieu_kien",\n "do_nong",\n {\n "type": "List",\n "entity": "tin_hieu",\n "columns": ["loai", "noi_dung"],\n "create": ["tom_tat", "anh_chup", "loai", "noi_dung", "kenh", "lien_ket", "ngay_dang"]\n },\n {\n "type": "Act",\n "key": "danh_gia_dat",\n "label": "\u0110\u1EE7 \u0111i\u1EC1u ki\u1EC7n",\n "when": {"trang_thai": ["moi"]},\n "requires": ["vi_sao_du_dieu_kien"],\n "set": {"trang_thai": "du_dieu_kien"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "lien_he",\n "title": "Li\xEAn h\u1EC7",\n "at": ["du_dieu_kien"],\n "children": [\n "so_dien_thoai",\n "phu_trach",\n "trang_ca_nhan",\n "zalo",\n "email",\n {"field": "ghi_chu", "block": false},\n {\n "type": "List",\n "entity": "buoc_tiep",\n "columns": ["ban_nhap"],\n "create": ["vi_sao_luc_nay", "viec", "han", "ban_nhap"]\n },\n {\n "type": "List",\n "entity": "tuong_tac",\n "layout": "timeline",\n "create": ["tom_tat", "qua", "phan_hoi", "thoi_diem", "hen_lai"]\n },\n {\n "type": "Act",\n "key": "ghi_cuoc_goi",\n "label": "Ghi \xE2m cu\u1ED9c g\u1ECDi",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "fills": ["tom_tat", "phan_hoi"],\n "record": {\n "into": "tuong_tac",\n "audio": "ghi_am",\n "transcript": "nguyen_van",\n "at": "thoi_diem",\n "by": "nguoi_thuc_hien",\n "video": "man_hinh"\n }\n },\n {\n "type": "Act",\n "key": "da_lien_he",\n "label": "\u0110\xE1nh d\u1EA5u \u0111\xE3 li\xEAn h\u1EC7",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "set": {"trang_thai": "da_lien_he"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "chuyen_doi",\n "title": "Chuy\u1EC3n \u0111\u1ED5i",\n "at": ["da_lien_he"],\n "children": [\n "nguon",\n {"field": "lien_he", "edit": false},\n {"field": "cong_ty", "edit": false},\n {\n "type": "Act",\n "key": "chuyen_doi",\n "label": "Chuy\u1EC3n \u0111\u1ED5i",\n "when": {"trang_thai": ["da_lien_he"]},\n "workflow": "chuyen_doi_khach",\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "loai",\n "title": "Lo\u1EA1i",\n "at": ["loai"],\n "children": [\n "ly_do_loai",\n {\n "type": "Act",\n "key": "loai",\n "label": "Lo\u1EA1i",\n "when": {"trang_thai": ["moi", "du_dieu_kien", "da_lien_he"]},\n "asks": ["ly_do_loai"],\n "set": {"trang_thai": "loai"},\n "danger": true\n },\n {\n "type": "Act",\n "key": "mo_lai",\n "label": "M\u1EDF l\u1EA1i",\n "when": {"trang_thai": ["loai"]},\n "set": {"trang_thai": "moi"}\n }\n ]\n },\n {"type": "Check", "field": "khong_lien_he", "resolve": "da_lien_he"}\n ]\n },\n {"type": "Record", "entity": "kenh", "add": ["ten", "loai"]},\n {\n "type": "Record",\n "entity": "buoc_tiep",\n "children": [\n {\n "type": "Act",\n "key": "lam_xong",\n "label": "\u0110\xE3 l\xE0m",\n "when": {"tinh_trang": ["cho"]},\n "set": {"tinh_trang": "xong"}\n }\n ]\n }\n ]\n }\n}\n```\n\n## Approval\n\n**The job.** Raise a payment request, see it through approval, and read what is waiting at the top of the list.\n\n**Read.** `records.de_nghi.status` with its `history` (each move: when and who), Sections staged by `at`, and the List\'s Readings leading with the headline number. The history stays because the business reads who signed each move; where only the day a stage was reached matters, the status stamps a date on the row instead (the Gantt above).\n\n**Keys.** `reference/status`, `reference/section-node`, `reference/reading-node`\n\n**Not when.** Rows that never move \u2014 a reference list (a price list, a catalog) has no status and no headline number.\n\n```json\n{\n "tables": [\n {\n "ref": "de_nghi",\n "title": "noi_dung",\n "fields": {\n "noi_dung": {"type": "text"},\n "so_de_nghi": {"type": "text"},\n "loai": {\n "type": "select",\n "options": [\n {"alias": "thanh_toan_ncc", "color": "violet"},\n {"alias": "nhan_cong", "color": "indigo"},\n {"alias": "chi_phi_cong_truong", "color": "sky"},\n {"alias": "tam_ung", "color": "amber"},\n {"alias": "hoan_ung", "color": "teal"}\n ]\n },\n "du_an": {"type": "link", "table": "du_an", "multi": false},\n "nha_cung_cap": {"type": "link", "table": "nha_cung_cap", "multi": false},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "han_thanh_toan": {"type": "date"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "nhap", "color": "slate"},\n {"alias": "cho_duyet", "color": "amber"},\n {"alias": "cho_chu_tich", "color": "violet"},\n {"alias": "da_duyet", "color": "blue"},\n {"alias": "da_chi", "color": "green"},\n {"alias": "tu_choi", "color": "rose"}\n ]\n },\n "nguoi_de_nghi": {"type": "member"},\n "chung_tu": {"type": "files"},\n "nguoi_duyet": {"type": "member"},\n "duyet_luc": {"type": "date", "format": "datetime"},\n "ly_do_tu_choi": {"type": "text"},\n "phieu_chi": {"type": "files"},\n "ngan_sach_du_an": {"type": "lookup"},\n "da_duyet_du_an": {"type": "lookup"},\n "vuot_ngan_sach": {"type": "formula"},\n "sat_ngan_sach": {"type": "formula"},\n "da_gui": {"type": "formula"},\n "nhap_at": {"type": "date", "format": "datetime"},\n "cho_duyet_at": {"type": "date", "format": "datetime"},\n "cho_chu_tich_at": {"type": "date", "format": "datetime"},\n "da_duyet_at": {"type": "date", "format": "datetime"}\n },\n "records": {\n "subtitle": ["du_an"],\n "figure": "so_tien",\n "limits": {"da_duyet_du_an": "ngan_sach_du_an"},\n "due": ["han_thanh_toan"],\n "starts": {"nguoi_de_nghi": "me"},\n "status": {\n "field": "trang_thai",\n "closed": ["da_chi", "tu_choi"],\n "dropped": ["tu_choi"],\n "dates": {\n "nhap": "nhap_at",\n "cho_duyet": "cho_duyet_at",\n "cho_chu_tich": "cho_chu_tich_at",\n "da_duyet": "da_duyet_at"\n },\n "history": "lich_su_duyet",\n "stages": {\n "nhap": {"owner": "nguoi_de_nghi"},\n "cho_duyet": {"owner": {"group": "<id of the giam_doc group>"}, "within": 1},\n "cho_chu_tich": {\n "owner": {"group": "<id of the chu_tich group>"},\n "within": 2,\n "when": {"so_tien": {"gt": 200000000}}\n },\n "da_duyet": {"owner": {"group": "<id of the ke_toan group>"}, "within": 2}\n }\n }\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "de_nghi_chi",\n "name": "\u0110\u1EC1 ngh\u1ECB thanh to\xE1n",\n "icon": "hand-coins",\n "color": "amber",\n "children": [\n {\n "type": "List",\n "entity": "de_nghi",\n "columns": ["nguoi_de_nghi"],\n "filters": ["du_an"],\n "group": "du_an",\n "create": ["noi_dung", "loai", "du_an", "nha_cung_cap", "so_tien", "han_thanh_toan", "nguoi_de_nghi"],\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "\u0110\xE3 duy\u1EC7t, ch\u1EDD chi",\n "value": "so_tien",\n "where": {"trang_thai": ["da_duyet"]}\n },\n {"type": "Reading", "key": "register_reading_1", "value": "so_tien", "by": "han_thanh_toan"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "de_nghi",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "de_nghi",\n "title": "\u0110\u1EC1 ngh\u1ECB",\n "at": ["nhap"],\n "children": [\n "so_de_nghi",\n "loai",\n "nha_cung_cap",\n "han_thanh_toan",\n "nguoi_de_nghi",\n {"field": "chung_tu"},\n {\n "type": "Act",\n "key": "gui_duyet",\n "label": "G\u1EEDi duy\u1EC7t",\n "when": {"trang_thai": ["nhap"]},\n "requires": ["chung_tu", "nguoi_de_nghi"],\n "set": {"trang_thai": "cho_duyet"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "duyet",\n "title": "Duy\u1EC7t",\n "at": ["cho_duyet", "cho_chu_tich"],\n "children": [\n {"field": "nguoi_duyet", "edit": false},\n {"field": "duyet_luc", "edit": false},\n {"field": "ly_do_tu_choi", "edit": false},\n {\n "type": "Act",\n "key": "rut_lai",\n "label": "R\xFAt l\u1EA1i",\n "when": {"trang_thai": ["cho_duyet", "cho_chu_tich"]},\n "set": {"trang_thai": "nhap"},\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "da_chi",\n "title": "\u0110\xE3 chi",\n "at": ["da_chi"],\n "children": [{"field": "phieu_chi", "edit": false}]\n },\n {"type": "Check", "field": "da_gui", "on": ["update"]},\n {"type": "Check", "field": "vuot_ngan_sach"},\n {"type": "Check", "field": "sat_ngan_sach"}\n ]\n },\n {"type": "Record", "entity": "du_an", "add": ["ten", "ma_du_an", "chu_dau_tu", "ngan_sach"]}\n ]\n }\n}\n```\n\n## Dashboard\n\n**The job.** The owner\'s question \u2014 what came in, what went out, where it went, and what is still unmatched \u2014 answered over one period.\n\n**Read.** An App of Readings and no List: Readings with `over` (the period windows them), a Reading `by` the day, Readings `by` a field, and a List of rows to act on.\n\n**Keys.** `reference/app-node`, `reference/reading-node`\n\n**Not when.** One job\'s headline numbers \u2014 those lead that job\'s List as its Readings.\n\n```json\n{\n "tables": [\n {\n "ref": "giao_dich",\n "title": "noi_dung",\n "fields": {\n "noi_dung": {"type": "text"},\n "ngay": {"type": "date"},\n "loai": {"type": "select", "options": [{"alias": "thu", "color": "green"}, {"alias": "chi", "color": "rose"}]},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "bien_dong": {"type": "formula", "notation": {"style": "currency", "currency": "VND"}},\n "doi_tuong": {"type": "link", "table": "doi_tuong", "multi": false},\n "danh_muc": {\n "type": "select",\n "options": [\n {"alias": "doanh_thu", "color": "green"},\n {"alias": "hang_hoa", "color": "blue"},\n {"alias": "van_chuyen", "color": "indigo"},\n {"alias": "nhan_su", "color": "violet"},\n {"alias": "van_phong", "color": "sky"},\n {"alias": "thue_phi", "color": "slate"},\n {"alias": "ngan_hang", "color": "teal"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n "sao_ke": {"type": "link", "table": "sao_ke", "multi": false},\n "hoa_don": {"type": "link", "table": "hoa_don", "multi": true},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "chua_khop", "color": "amber"},\n {"alias": "da_khop", "color": "green"},\n {"alias": "khong_can_hd", "color": "slate"}\n ]\n },\n "khop_luc": {"type": "date", "format": "datetime"}\n },\n "records": {\n "subtitle": ["ngay"],\n "figure": "bien_dong",\n "status": {"field": "trang_thai", "closed": ["da_khop", "khong_can_hd"], "dates": {"da_khop": "khop_luc"}}\n }\n },\n {\n "ref": "hoa_don",\n "title": "doi_tuong",\n "fields": {\n "doi_tuong": {"type": "link", "table": "doi_tuong", "multi": false},\n "so_hoa_don": {"type": "text"},\n "ngay_hoa_don": {"type": "date"},\n "so_ngay_qua_han": {"type": "formula", "notation": {"style": "unit", "unit": "day"}},\n "chieu": {\n "type": "select",\n "options": [{"alias": "ban_ra", "color": "green"}, {"alias": "mua_vao", "color": "violet"}]\n },\n "tong_cong": {"type": "formula", "notation": {"style": "currency", "currency": "VND"}},\n "thue_suat": {"type": "formula", "notation": {"style": "unit", "unit": "percent"}},\n "tep": {"type": "files"},\n "giao_dich": {"type": "link", "table": "giao_dich", "multi": true}\n },\n "records": {"subtitle": ["so_hoa_don", "ngay_hoa_don"], "image": "tep", "figure": "tong_cong"}\n }\n ],\n "body": {\n "type": "App",\n "key": "dong_tien",\n "name": "D\xF2ng ti\u1EC1n",\n "icon": "chart-line",\n "color": "emerald",\n "children": [\n {\n "type": "Sheet",\n "key": "dong_tien",\n "label": "D\xF2ng ti\u1EC1n",\n "children": [\n {\n "type": "Reading",\n "key": "dashboard_reading_0",\n "label": "Ti\u1EC1n v\xE0o",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_1",\n "label": "Ti\u1EC1n ra",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "over": "ngay",\n "better": "down"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_2",\n "label": "D\xF2ng ti\u1EC1n r\xF2ng",\n "entity": "giao_dich",\n "value": "bien_dong",\n "by": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_3",\n "label": "Chi theo danh m\u1EE5c",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "by": "danh_muc",\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_4",\n "label": "Thu theo kh\xE1ch h\xE0ng",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "by": "doi_tuong",\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_5",\n "label": "C\xF4ng n\u1EE3 b\xE1n ra theo tu\u1ED5i n\u1EE3",\n "entity": "hoa_don",\n "value": "tong_cong",\n "where": {"chieu": ["ban_ra"]},\n "by": "doi_tuong",\n "across": {"field": "so_ngay_qua_han", "tiers": [1, 8, 16, 31]}\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_6",\n "label": "S\u1ED1 ng\xE0y qu\xE1 h\u1EA1n b\xECnh qu\xE2n",\n "entity": "hoa_don",\n "value": {"avg": "so_ngay_qua_han"},\n "where": {"chieu": ["ban_ra"]}\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_7",\n "label": "Thu\u1EBF su\u1EA5t b\xECnh qu\xE2n",\n "entity": "hoa_don",\n "value": {"avg": "thue_suat"}\n },\n {\n "type": "List",\n "key": "dashboard_reading_8",\n "entity": "giao_dich",\n "where": {"trang_thai": ["chua_khop"]},\n "label": "D\xF2ng ch\u01B0a kh\u1EDBp",\n "columns": ["sao_ke"]\n }\n ]\n }\n ]\n }\n}\n```\n';
@@ -1825,7 +1884,7 @@ var AGENTS_default = "# @lotics/cli \u2014 agent index\n\nThe model an agent nee
1825
1884
  var building_an_app_default = '# Building an app, end to end\n\nThe other references here describe **grammars** \u2014 what a table document or an app tree may state, what a tool takes. This\none describes the **sequence**: the order the steps go in, and why. Read it once for the shape, then\nreach for the area doc (`lotics docs`) whenever you need the detail.\n\n**The live app is the only edit surface.** Every change to an app \u2014 applying a tree, deploying a\nbuild, setting one query or workflow \u2014 mints a new version of it. To go back, apply the earlier tree\nagain (or deploy the earlier source). Nothing about an app lives in a local directory the platform\nreads back.\n\n**Going back restores the app, not the data.** A table change, and every row a workflow wrote while\nyou tried it, stay where they are. Try a write on a throwaway record.\n\n---\n\n## 1 \u2014 Two kinds of app\n\n- **An app stated as a tree** \u2014 the default, and the right one for almost every job. The tree (a\n JSON file, one per app) is a List of one table, whose rows are recognised by the\n table\'s own `records`, and the page its rows open (`pages`), with the Lists and Sheets that stand beside it at the root as peers (which a change may add at any time, each a View of its own, shown to whoever the app is shared with): its columns and filters, its Sections in the order its work\n reaches them, its Acts and the Checks that guard them (`lotics docs reference/app-tree`,\n `reference/list-node`, `reference/section-node`, `reference/act-node`, `reference/check-node`). The platform\n compiles each app and draws it with the runtime every such app shares, so how each piece looks is\n the platform\'s, one way per concept, and no prop changes it. Every write the app makes is a\n generated workflow that re-checks on the server what the tables state.\n- **A custom-code app** \u2014 your own project, for a surface the tree\'s components cannot state. Its UI\n library, components, styling, state, bundler, tests and lint are yours; it reads and writes through\n `@lotics/app-sdk` (queries, workflows, files, AI).\n\n## 2 \u2014 Clarify what is being asked, before designing it\n\n**A metric name is not a definition.** "Revenue", "in stock", "active", "overdue" \u2014 each is a\nbusiness rule the person asking owns, and the cost of guessing is a screen that is confidently\nwrong. Ask until there is no ambiguity left:\n\n- Which rows count, keyed off which field \u2014 a date, a status, a flag?\n- Does the same metric need a **different rule per table**? One table may key off a date and\n another off a status; one rule rarely covers both.\n- Snapshot or flow? "Current stock" is as-of-now; "revenue this month" is a window. They compile\n to different filters.\n- If the data cannot support the definition asked for \u2014 the field simply is not there \u2014 **say so\n and show the options.** Silently substituting a near-miss produces a number nobody can trace.\n\nThis is the step that gets skipped under time pressure, and it is the only one whose mistakes are\ninvisible in review: every later artifact is correct with respect to the wrong definition.\n\n## 3 \u2014 The data model, before any app\n\nGet this wrong and nothing above it can be precise. Each kind of thing is its own table with links into\nthe spine; attributes and evidence are fields on their owner. A single table with a `type` column\nstanding in for three kinds of thing collapses the distinctions every later query needs.\n\n**Verify real VALUES, never just that a field exists.** `lotics run query_records` a sample and\nlook at fill rates \u2014 a field that is present and empty on 90% of rows will not support the screen\nyou are about to design.\n\n**That includes imagery.** If the thing has a likeness \u2014 a product, a property, a vehicle, a\nperson \u2014 its picture is the strongest identifier a register row can carry, and an empty image field\nis a data gap to fill before you design around it: `lotics file upload`, then `update_records`.\n\n**Match on ids and option aliases, never on rendered text.** Resolve a name to its `rec_\u2026` or its option alias\nonce, at the boundary, and compare those. Treat an unresolved name as UNKNOWN, never as a wildcard.\n\n**How the tables RELATE, and one fact in one column, is `lotics docs data_model`** \u2014 read it before designing a\nschema; those decisions outlive any one app.\n\n## 4 \u2014 An app stated as a tree\n\nTables first, then apps. `set_tables` takes a list of table documents, one or many, and writes them all or\nnone; `set_app` takes one app per call. Each creates when it is given no id and edits when it is given one.\n\n```\nlotics docs reference # the keys of a table document and the app tree\'s components, with a worked example\nlotics docs design # the treatment per kind of row\nlotics run set_tables @tables.json # one call, every table: {"tables": [...]}\nlotics run set_app @orders.call.json # one app: {"body": <the App tree>} to create (add "dry_run": true to check)\nlotics app apply orders.app.json --check # the same tool from a bare tree file: what would refuse it, writing nothing\nlotics app apply orders.app.json # no app known: creates it; known: edits it to the file\nlotics app pull <app_id> # the app\'s tree, as ./<name>.app.json\n```\n\nA new workspace is built in one order: one `set_tables` call with the tables, then every `set_app`\ncall, then fixes. One call carries at most 50 tables, 200 first rows a table, and 2000 rows and 2000\ndocuments in all; a workspace of more tables is built in further calls, each naming the tables already made by\ntheir ids.\n\nA table is a document: its `fields` are keyed by alias, and a link field names the table it\npoints at by id, or by the `ref` of another table of the same call, and states `multi`. A\ntwo-way link states `pair` on one table, as `true` or as a free alias, and the partner is made on the other; a many-to-many link states both sides. A table is edited by an RFC 7396 merge patch of its document:\nwhat the patch leaves alone is left alone and `null` deletes. `dry_run` checks the call and writes\nnothing; a refusal lists everything wrong in it at once.\n\nThe App node is the app: its `name`, `description`, `icon` and `color` are props of it, and no other input of\n`set_app` states them. It names the tables and templates it uses by their aliases (an entity is a table\'s alias, a `template` a template\'s alias);\n`set_app` fills the `tables` and `templates` maps by id from them and `get_app` shows aliases (`lotics docs reference/app-node`).\nWho reads which rows is the app\'s `rows` (\xA7 Who reads which rows, below). A call that creates\nis `{"body": <the App tree>}`; one that changes a part is `{"app_id": "app_\u2026", "nodes": {"<address>": <patch>}}`,\neach address a node\'s path of keys (`get_app` prints every one), a patch a JSON merge patch of that node\'s props\nand `null` removing the node; the App\'s own props change through `body`. A call stating `base_version_id` \u2014 the\nversion you read \u2014 is refused when the app has moved on. The old body grammar (`register`, `record`, `acts`,\n`edits`) is refused with a sentence pointing here.\n\nA tree states what it means once: a statement equal to what the runtime draws anyway (a column the row already shows) is kept,\ndrawn once and noted, while a statement that conflicts is refused. A register List\'s `label` is the register\'s heading in the app\'s lists; its rows are named by the table\'s own label and singular.\n`type` may be omitted, and a Section, Side or Page\nwithout a `key` is keyed by its title\'s slug, written once and kept.\n\n`app apply` with no app known creates one from the file, named by the tree\'s `name`, and records its id and\nversion in `<file>.lotics.json` (`app pull` writes the same file), so the next apply of that file edits that\napp; `--app <app_id>` names it instead, and is refused for a file whose record names another app. A known app\nis read first and only what the file changes is sent, as a JSON merge patch (RFC 7396): a key the file drops\nis removed, a list is replaced whole, and what the file leaves alone is left alone. A file pulled at a\nversion the app has since left is refused, naming the version: pull the current tree into another path and\ncarry your edits over. Applying a tree the app already has mints nothing.\n`--check` sends the same change as `dry_run`: what would refuse the tree, the notes on it, and the permissions the\nwrite would grant and remove, writing nothing. Every write\'s answer states those permissions: the saves, adds,\nDeletes and act writes the new tree grants and removes, from the previous tree to the new one.\n\n**What the tree leaves out is drawn, never stored.** The answer shows a treatment the rows call for that the tree leaves out \u2014\nReadings over its rows, a record\'s Sections, an Act per status move, a picture where its rows hold photos\n(`lotics docs design`) \u2014 and the tree states the ones the job needs. What it states with one fix, the write places\nand says (`lotics docs reference/changing-an-app`); edit only the difference.\n\n**The tree changes after the app exists, and applying it again is how it lands.** Pull the tree, edit\nthe file, apply it; or send `nodes` for one part. An Act whose write the tree cannot say names its own `workflow`; that workflow\'s code is\nthe live one, and `lotics run set_workflow` changes it. A job no press starts \u2014 an agent or a\nservice handing the app a file or a list of rows \u2014 is a Workflow node the app declares\n(`lotics docs reference/workflow-node`): the node states what it takes and hands back, and `lotics run\nset_workflow` sets its code with `inputs` and `outputs` left out of its `on({ type: "app", ... })` header.\n\n**What a person reads and does in the app, an agent reads and does through it.** Writing the tree generates a\nquery for every List, record, child List and figure the screen reads, and a workflow for every add, edit,\nremoval and act \u2014 `lotics run get_app` lists them, and `lotics docs agent_surface` names each\nfamily and how it is called. A question the screen never asks is a Query node the app declares\n(`lotics docs reference/query-node`), beside its Workflow nodes. Both are part of the design: `lotics docs\nagent_surface`, \xA7 Declaring more.\n\n### Who reads which rows\n\nAn app runs with its owner\'s access, and the people it is shared with need the app alone, never its tables. Who of them\nreads which rows is the app\'s `rows`, one rule per table in the grammar of a table\'s `read_scope` (`lotics docs reference/read-scope`); it narrows\nthe app\'s screens, its queries and workflows called through it (`run_app_query`, `run_app_workflow`), its acts and its\nworkflow bodies alike, and a record id a caller passes is refused where the rule hides the row. State a rule only where\npeople differ; a table with none is read whole by everyone the app is shared with.\n\n| The business says | The app states |\n|---|---|\n| Everyone on the team sees every order | nothing |\n| Each rep sees only their own deals | `"rows": { "deal": { "any": [{ "field": "rep", "is": "self" }] } }` |\n| Reps see their own deals; managers see all | `"rows": { "deal": { "any": [{ "field": "rep", "is": "self" }, { "member_of": "<managers group id>" }] } }` |\n| Each branch manager sees their branch\'s orders | `"rows": { "order": { "any": [{ "through": ["branch"], "field": "manager", "is": "self" }] } }` |\n| Each employee sees only their own payslips; HR sees all | two apps: one stating `"payslip": { "any": [{ "field": "employee", "is": "self" }] }`, one for HR stating none |\n| Team leads see people, not salaries | an app that draws no salary field \u2014 what it does not show, no one reads through it |\n\nA child read under a ruled row states its own rule, through its link to the parent; only a status history inherits.\nAn admin and the app\'s owner are narrowed like anyone, and the write says so when a rule hides rows from them. Someone on a public link, signed in as no one, reads no row a `self` clause would\nchoose. An app never reads past its owner\'s own access. A table\'s own `read_scope` governs opening the table directly.\nWorking inside one row of a folder (`scope`) narrows the view, not who may read: a branch app shared with every manager\nstill states the branch rule.\n\n## 5 \u2014 A custom-code app\n\n```\nlotics app create "<name>" --custom . # registers the app and links this directory (package.json#lotics)\nlotics app deploy -m "<what changed>" # build, upload, a new version live\nlotics app pull <app_id> # the live version\'s source, on a machine without the project or after another deploy\n```\n\nThe contract, and nothing more:\n\n- `@lotics/app-sdk` is React hooks and needs React 19 (`react` and `react-dom` `^19.2`); `react-router`\n (`^7` or `^8`) only for `@lotics/app-sdk/router`. Its reference is `node_modules/@lotics/app-sdk/AGENTS.md`.\n- `lotics app deploy` writes the app\'s declarations into `.lotics/` (`app_queries.d.ts` types\n `useQuery` by its aliases; include the directory in the project\'s TypeScript config), runs\n `npm run typecheck` when the project declares it, then `npm run build`, which must write a static\n `dist/` with an `index.html`. It uploads `dist/` and the source (without `node_modules`, `dist`,\n `.git`).\n- The app is a static bundle on the app host and reaches data only through the SDK.\n\nWhat the app reads and writes is bound on the app, never in the project: `lotics run\nset_app` binds named queries (`app_bindings`), `lotics run set_workflow` a workflow body, and each mints a\nversion. `useQuery("<alias>")` and `useWorkflow("<alias>")` call them. A deploy uploads the build\nand carries every binding forward unchanged.\n\n**Named queries.** Author them as `kind: "project"` with a `filter`, naming each projected column\n(`{ "source": "amount", "output": "total" }`), so a row reads as `r.total`. Scope per-user reads with\n`is_current_member` **inside the query** \u2014 a member id passed from the client is chosen by the\ncaller. Write one `description` per alias: it is the line a chat or MCP caller chooses by.\n\n**Workflows are the only way an app writes**, and every query and workflow bound to an app is also what\nan agent reads and runs there: `lotics docs agent_surface` \xA7 Declaring more states how each is shaped for\nthat caller.\n\n## 6 \u2014 Prove it, without a screen\n\nStatic checks prove parse, types and names \u2014 they evaluate nothing. Rehearse a write first:\n\n```\nlotics run set_workflow \'{"source":"on({ type: \\"app\\", app_id: \\"app_\u2026\\", alias: \\"\u2026\\" });\\n\u2026","dry_run":true,"record_id":"rec_\u2026"}\'\n```\n\nIt walks the draft through the same engine an Act\'s preview uses, under the app\'s authority: reads are real,\nwrites and sends are said and not made, and it returns what the run would answer plus the calls it would make.\nPass `preview_inputs` for the values of a workflow that takes inputs and no row.\n\nThen run it end to end, on a throwaway record:\n\n```\nlotics run run_app_query \'{"app_id":"app_\u2026","alias":"\u2026","params":{\u2026}}\'\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"\u2026","inputs":{\u2026}}\'\n# exits non-zero when the run failed, so it is assertable\n```\n\nA workflow is also how an app **produces a document** \u2014 `generate_document` fills a template\nyou registered once (`lotics docs document_templates`).\n\n## 7 \u2014 Look at it, then name it\n\nLook at every app you apply, at a desktop width and at a phone\'s \u2014 every check above reads the\ndefinition, none of them the pixels \u2014 and judge each shot against the visual bar `design` opens on:\n\n```\nlotics run screenshot_app \'{"app_id":"app_\u2026"}\' -o ./shots\n# one PNG per width saved into ./shots, each with its text snapshot beside it as <name>.txt;\n# "path":"/rec_\u2026" opens a screen inside the app\n```\n\nFrom the CLI each image is a link signed for an hour, and `-o` saves it. Each shot is one screen, as a member sees it; `"screen":2` draws the next screen of\nthe content scrolling inside the app, and so on to its end, and `"full_page":true` grows one image\nto the first five screens \u2014 one or the other. Beside each image comes its `snapshot`, the screen\'s\naccessibility tree as text \u2014 read it to check labels and values without opening the picture \u2014 and,\nwhere a table left columns off at that width, `shed` names them.\n\nThe app is drawn live, as you, read-only: a screen that writes when it opens shows that write\nrefused, and `errors` lists what failed on the page. A version that looks wrong is one\n`lotics app apply` away from the one before: apply the earlier tree again.\n\nFor an app stated as a tree, `verdict` comes beside the images: what a check of that app finds now,\nbeside its rows \u2014 what the next write would refuse it for and the notes\non it. `verdict_unread` says why none was read.\n\nThe app\'s `name`, `icon`, `color` and `description` are props of the App node; an app\nstating no `color` gets the platform\'s grey tile. `lotics run set_app` with the app\'s id and a `body` patch changes them\non the app, and `lotics app pull` reads the tree back as the app holds it. The\n`description` heads the capability listing the member\'s chat agent reads on **every** turn, so a\nstanding process the app expects that agent to carry out belongs there and nowhere else.\n\n**A caller outside the team gets its own app.** Sharing an app publicly, or giving an API key\naccess to it, reaches every alias the app declares; no alias can be held back. So whatever\noutsiders may call is a SECOND app over the same tables: only the queries they may read and the\nworkflows they may run. The desk the team works in stays a separate, private app. One only a server calls is an API app: `lotics docs app_bindings` \xA7 API apps.\n';
1826
1885
 
1827
1886
  // docs/cli_reference.md
1828
- var cli_reference_default = "# @lotics/cli \u2014 CLI Command Reference\n\nPer-command syntax, flags, contracts, and gotchas for the public `lotics` CLI. Start at [AGENTS.md](../AGENTS.md) for the model this reference assumes; `lotics --help` is the authoritative, always-current verb list.\n\n| Command | What it does |\n|---|---|\n| `lotics` / `lotics --help` | Show full help: capabilities, the verb list (\xA7 COMMANDS), flags, config. `lotics <verb> --help` prints that verb's entries alone (`lotics app --help`, `lotics file download --help`); `lotics report --help` prints the report frame. |\n| `lotics auth signup <email>` | Create account + org + API key, sends magic link email. Refused on a private instance, whose people arrive by invitation; prints that creating the account accepts the Terms and Privacy Policy. Registers the new org as a profile; `--local` pins this directory to it (pointer) instead of setting the global default. |\n| `lotics auth login <email>` | Sign in an account that already exists, on a machine holding no key. **Two steps, and it does not wait for the person.** The first prints the page to open \u2014 `https://lotics.ai/cli_login/<request_id>`, also mailed \u2014 and the code that page must show, records the request, and exits 0. They sign in there if asked, check the code and press Confirm. **Then the next command that needs a credential collects the key** before it does its own work, so the second step is just re-running whatever was wanted; a command run before Confirm exits 1 naming the page and the code again, and once the 15 minutes are up it says to ask again. The handful that run WITHOUT a credential \u2014 `docs` among them \u2014 claim nothing, so one of those run after Confirm still answers as though signed out. `--wait` keeps one command instead, holding the terminal until Confirm; `--local` pins this directory to that org rather than setting the global default, and implies `--wait` (a pin names THIS directory, so only the terminal that stays in it can write one). `--json` prints `organization_id`, `workspace_id` and `organization_name` when it finishes signed in, and `request_id`, `confirm_url`, `code`, `email`, `expires_at` when it is the first step. The request's secret is never printed and the org's key never leaves the store. |\n| \u2014 | **A flag is refused on a verb that does not read it**, naming the verbs that do, before any request or credential: `--check` on `lotics run` would otherwise be parsed and ignored, and the write it was meant to stop would run. `--json`, `--workspace`, `--api-key` and `--timeout` are read by every verb. |\n| `lotics auth api-key [key]` | `whoami` \u2192 **upsert** the key's org as a profile in the global store (never overwrites). The profile records the instance the key was verified against (`LOTICS_API_URL`, default `https://api.lotics.ai`), and every later command for that org goes there. `--local` additionally pins this directory to it (pointer) instead of setting the global default. |\n| `lotics auth web` | Send a magic link email to access the web app (requires auth) |\n| `lotics auth whoami` | Print active account name, email, org, resolved workspace, the instance the credential belongs to, which **kind** of credential this machine holds (a sign-in from `auth login`, or an API key \u2014 read from the saved profile, and from the server when the profile does not say, which covers `--api-key`/`LOTICS_API_KEY` and a profile saved before the field existed; unknown only when neither can say), and the resolution **source** (flag/env/local/app-manifest/global). `--json` adds `workspace_id`, `api_url`, `credential_kind` + `source`. |\n| `lotics auth logout [<name\\|id>]` | In a pinned dir: delete the local pin. Else: remove the profile (default the active org), `--all` for every one. What happens server-side depends on which KIND of credential it is. A **sign-in** (`auth login` / `auth signup`) is revoked \u2014 logging that terminal out ends its credential rather than leaving a live one behind; a server that cannot be reached, or a credential already dead, never blocks the local forget, and one line names the org and Settings \u2192 Security \u2192 *Keys and terminals*. An **API key** (`auth api-key`) is only forgotten here \u2014 an admin issued it and it is routinely on a server and on other machines, so one terminal signing out must not kill it for everyone; the line says it is still active and names both pages, because Settings \u2192 API keys is admin-only and the credential may well be the holder's own sign-in, which they revoke themselves at Settings \u2192 Security \u2192 *Keys and terminals*. A profile saved before the kind was recorded states nothing, so the SERVER is asked (`auth whoami`) and it is revoked only if the answer is a sign-in: an older server, a credential minted before the column, and a request that fails all leave it alone. |\n| \u2014 | **A refused credential says which of three ways it is dead, and names the remedy that ends its kind.** `This credential expired.` / `was revoked.` / `belongs to a member who is no longer active in this organization.` carries `Run \\`lotics auth login <email>\\` to sign in again.` for a sign-in and `Ask an admin for a new API key (Settings \u2192 API keys).` for an issued key. A credential minted before that was recorded still gets BOTH in one sentence, because nothing on the row tells them apart \u2014 so a headless box is never sent looking for a browser alone. A key the server does not recognize at all gets one flat `Invalid or disabled API key.` \u2014 deliberately, so a guessed key learns nothing, not even that it named a row. The body carries `reason` for a script to branch on, since the code stays `unauthorized` for every 401. Changing or resetting the account's password revokes its sign-ins, never an issued key. |\n| `lotics org` | List saved orgs (profiles) from the global store with the instance each belongs to, marks active for this directory (a local pin wins over the global default). |\n| `LOTICS_ORG=<name\\|id>` | Scope every command in this shell to one saved org. **Resolved once, before any command dispatches**, so a value matching no saved credential refuses every verb with one sentence \u2014 a read, a write, and a local check that needs no credential alike \u2014 and refuses it before the first byte is written. It refuses even when a credential arrives another way, because `--api-key` / `LOTICS_API_KEY` outrank it in the precedence chain and a write must never fall through to whatever THOSE name while the variable says otherwise; when the variable resolves and a key is also given, the key decides and the command says so. The refusal lists the orgs this machine holds, so it is answerable without another command (`lotics org` is refused by the same rule). A name is whatever the credential was SAVED under \u2014 a server-side rename never moves it, and the new name resolves too, so both keep working and `lotics org` prints the pair. |\n| `lotics org use <name\\|id> [--local]` | Switch the active org by org name (case-insensitive, ambiguous \u2192 error) or id. No flag \u2192 global `active_org`; `--local` \u2192 a `.lotics/config.json` pointer in the current dir. |\n| `lotics workspace` | List workspaces in the active org, marks current with `(current)` |\n| `lotics workspace select <id>` | Set the workspace in the **active scope** \u2014 a local pin if the dir has one, else the active org's global profile. Records the workspace's NAME beside its id, which is what the `lotics \u2192 <org> / <workspace>` echo prints; `workspace list`, `workspace create`, `workspace rename` and `org use` record it too, so a target is named rather than identified. Until one command has listed it, the echo prints the id and says the name is not known yet. |\n| `lotics workspace create <name> [--timezone <Area/City>] [--currency <ISO>]` | Create a new workspace (admin only), auto-switches to it. Neither flag is defaulted from THIS machine, unlike signup: an extra workspace is routinely created by an operator for somebody else. Without `--timezone` the new workspace inherits the zone of the org's OLDEST workspace; without `--currency` it takes the org's default. Both ride the create, so the workspace is never briefly denominated in a currency nobody asked for. `--currency` takes an ISO-4217 code (case-insensitive; anything else is refused). |\n| `lotics workspace rename <name>` | Rename the **current** workspace (admin only) \u2014 the endpoint takes its target from the request's workspace, never a path id, so switch with `workspace select <id>` first and read the `lotics \u2192 <org> / <workspace>` echo before trusting it \u2014 both halves are names, and the rename moves the cached one in the same act. Carries the workspace's existing `default_currency` and `timezone` through unchanged: the endpoint takes the whole settings triple, so sending only a name would blank the other two. |\n| `lotics workspace settings [--name <n>] [--currency <ISO>] [--timezone <Area/City>]` | Change the CURRENT workspace's name, default currency or timezone \u2014 `PATCH /v1/workspace`, admin only. Only what you name changes; the endpoint takes the whole triple, so the CLI carries the two you did not. `rename` is this verb with the name alone, which is why it can never forget the other two. Both values are invisible once they are wrong: the currency decides how every money field RENDERS and the zone decides how every date BUCKETS, on a workspace whose whole purpose may be to look like the customer's own. `--json` prints the updated workspace. |\n| `lotics workspace delete <id> --yes` | Delete a workspace by id (admin only). **Soft delete** \u2014 `archived_at` is set, so it drops out of listings, can no longer be selected, and its tables/records go dark, while the data is retained and recoverable. Its **apps are cascade-archived** too \u2014 every app entry point (embedded, public link, standalone subdomain, incl. anonymous public links) stops serving. Refuses the org's **only** active workspace (400) and any workspace outside the caller's org (404). Requires `--yes` to confirm (destructive; the CLI is used non-interactively). |\n| `lotics workspace doctor` | Report workspace-wide dangling schema references via `GET /v1/workspaces/dangling-references` \u2014 every active app/workflow artifact whose prefixed schema id no longer resolves, printed as `<referent.kind> \"<name>\" (<id>) \u2192 <namespace> <id> (missing)`; healthy prints a one-line all-clear. **Exits non-zero (exit 1) on findings** so scripts can gate on it. Resolves the first workspace like every data command (runs before the global workspace resolution). Admin-only. |\n| `lotics tools` | List tools by category with descriptions |\n| `lotics tools <name>` | Full description, input JSON Schema, and the output schema where the tool answers a shape, for one tool; a workflow step says to call it from a workflow body, not `lotics run` |\n| `lotics run <tool> '<json>'` | Execute a tool (text output via toModelOutput). Args may also come from a file (`lotics run <tool> @args.json`) or stdin behind the `-` sentinel (`cat args.json \\| lotics run <tool> -`) \u2014 both bypass the OS `ARG_MAX` limit for large payloads (a knowledge-doc `content`, a bulk update). A leading `@` on the args is unambiguously a file path (JSON args start with `{`). **Stdin is asked for, never guessed.** `lotics run <tool>` with no payload runs the tool with no arguments and returns at once. `lotics report` takes the same sentinel. In PowerShell use `@file`: quotes inside an inline argument are consumed by the shell, and the CLI reports the JSON it received with its quotes gone \u2014 the error names both escapes. |\n| `lotics run <tool> --json '<json>'` | Execute a tool (full JSON output) |\n| `lotics run <tool>` \u2014 **file cells** | A file in a tool's result carries its `fil_\u2026` id and metadata and **no `url`**, on every tool and in both output modes. That is not a broken file \u2014 this surface resolves no URL for a cell. Reach the bytes with `lotics file download <file_id>`, which takes the id straight from the cell; the text output says so whenever a result carries one. |\n| \u2014 | **Every tool is invoked here, including the ones that RUN something** (`run_app_workflow`, `run_app_query`) and every one that builds: `set_tables` (a list of table documents), `set_app` (one app), `set_workflow`. A command exists only for work that touches a local file: `app apply`, `app create --custom`, `app pull`, `app deploy`. |\n| \u2014 | **An app's queries and workflows take more than their params and inputs** (`lotics docs agent_surface`). `run_app_query '{\"app_id\",\"alias\",\"params\"}'` also takes `filters` and `sort` over the query's output columns, `fields` (the columns to return), `count` with `count_by` or `count_where`, `aggregate`, `limit` (200 rows at most; 50 where none is stated) and `cursor`, and `runs` \u2014 up to 20 reads in one call, each `{\"alias\", \u2026}`, a refused one answered with its `error`; one call's rows total at most 262,144 bytes. `export: {\"key\", \u2026narrowing}` instead of the read arguments makes the file an app's Export makes (`lotics docs agent_surface`). `run_app_workflow '{\"app_id\",\"alias\",\"inputs\"}'` also takes `dry_run: true` \u2014 a rehearsal on the real inputs, nothing written or sent; the answer is what the run would return, with the reads it made under `dry_run.reads`, the calls it would make under `dry_run.writes` and the papers it rendered under `dry_run.papers` and the parts of the answer it could not say under `dry_run.unpredicted`; a workflow no dry run is offered of answers `status: \"not_previewed\"` \u2014 and `runs` \u2014 up to 50 runs in order, the first refused, failed or not previewed ending the call, an input `{\"from_run\": <index>, \"path\": \"data.<key>\"}` reading an earlier run's answer. |\n| \u2014 | **The exit code reports the WORK, not just the call \u2014 for the tool that RUNS one.** `run_app_workflow` whose envelope carries a failed `status` (`error`/`failed`/`cancelled`, or `not_previewed` \u2014 a dry run asked for and not given) exit non-zero and print `<tool> \u2192 <status>: <message>` to stderr, so `lotics run \u2026 && next-step` cannot walk past a refused run. The rule is an allowlist of FAILURE \u2014 an unrecognized status exits 0, so a status added later never turns a working script red. A parked run (`awaiting_input`) is not a failure: it is waiting for an answer and the work is still live. Only a TOP-LEVEL `status` counts; one inside the data belongs to the data. Any OTHER tool's `status` is data, and exits 0. |\n| `lotics run <tool> '<json>' -o <dir>` | Also save every **signed link** the answer carries \u2014 an object with a `url`, a `filename` and the `expires_at` its signature ends at, at any depth, such as `screenshot_app`'s images. Each is fetched into `<dir>` (created if missing) under its `filename`, taking a free spelling beside a file of that name already there, and a link's `snapshot` text is written beside it as `<name>.txt`. The written paths follow the answer on **stdout**, one per line (on stderr under `--json`, whose stdout stays the one object). A link is signed for an hour; one the store no longer serves exits non-zero. A workspace file states no `expires_at` and is left to `lotics file download`. |\n| `lotics run set_members '{\"members\": {\"<email or member id>\": {\"role\": \"member\", \"name\": \"\u2026\"}}}'` | Invite, rename, change a role, remove (`null`) or restore members; `groups` keeps the member groups in the same call. Admin only: the whole input is checked before an email is sent. A member's `lotics tools` does not list it, nor `set_workspace`. View-as is the web app's preview alone; the CLI acts as the signed-in member. |\n| `lotics run <tool> --print-created` | Report the records the call created, grouped by table, with a paste-ready `delete_records` per table and the mandatory caveat naming what cannot be auto-undone (external integrations, notifications, possible sub-workflows). Works for any tool that returns a `side_effects` block, not workflows alone. |\n| `lotics run <tool> --cleanup` | Implies `--print-created`, then runs those deletes \u2014 harvested records **only**, never files / external calls / notifications. **Not a rollback**; a rollback is structurally impossible here. A partial cleanup exits non-zero so a script cannot read it as success. |\n| `lotics file upload <file\\|dir...>` (alias `lotics upload`) \xB7 `--stdin` \xB7 `--base64` \xB7 `--url <url>` | Upload files/directories. **The transport is chosen by size and is not a flag**: under 8 MiB the file is POSTed to `/v1/files`, several such files to a request up to half that route's 100 MiB cap; at or above it the CLI takes presigned part URLs and PUTs the bytes straight to object storage, so they never pass through the API. That threshold matches the AWS CLI's own `multipart_threshold`, and the number matters less than there being nothing to choose \u2014 one verb, any size, up to the 2 GiB a workspace may store. A large upload reads one part at a time, so memory stays flat regardless of file size, and a failure part-way abandons the parts already sent rather than leaving them billable and invisible. A directory expands to its immediate files; `--as <name>` renames a single upload. **Three alternative byte sources, for a caller that never had the bytes on disk** \u2014 an attachment decoded in memory, a generated document, a signed download link \u2014 each mutually exclusive with the others and with a path argument: `--stdin` takes raw bytes on stdin, `--base64` takes base64 on stdin (the shape attachments arrive in), `--url <url>` fetches the URL first. `--stdin`/`--base64` REQUIRE `--as`, because stdin carries no filename and the mime type is derived from it; `--url` falls back to `Content-Disposition` then the URL's last path segment. `--base64` decodes STRICTLY \u2014 `Buffer.from(s, \"base64\")` silently skips invalid characters and truncates on bad padding, so a corrupted pipe would otherwise store a short file that only fails when a human opens it. The `--url` fetch happens in the CLI, not the server: the URL comes from the operator running the command, so routing it through the backend would add an SSRF surface to buy what `curl` already does. |\n| `lotics file download <file_id> [<path>]` \xB7 `-o <dir>` | (alias `lotics download`) Download a stored file: `GET /v1/files/{id}/signed_url` \u2192 fetch the presigned URL and write it where you asked. **The two spellings mean two different things, and neither is read by shape: the positional `<path>` is the FILE to write, `-o <dir>` is the DIRECTORY to save into.** That is `cp` and `curl -o`, so nothing here consults an extension. A named file is written as named, its parent created, overwriting what is there \u2014 the point of naming it is that the next command opens that exact path. A directory is created if missing and written into under the stored filename (the response's `Content-Disposition`), taking a free spelling beside a file of that name already there so a repeat download never clobbers the first; with no destination at all, that filename lands in cwd. Give the destination once \u2014 a positional and `-o` together is refused, as is a positional that names an existing directory or ends in a separator (`a directory goes in -o`). The first argument is a **file id**, so a path in that slot is refused rather than sent as an id. The written path goes to **stdout** (under `--json`, `{file_id, path, filename, stored_filename}`) and the narration to stderr, so a download pipes into whatever opens it. `lotics file download record <record_id> <field_alias> [-o <dir>]` (the field named by the alias `query_records` shows it under) spreads every file on a record's file field over a DIRECTORY \u2014 there is no single file for N files to be. |\n| `lotics file list [--limit <n>] [--cursor <token>]` | The workspace's files, newest first \u2014 id, upload time, bytes, MIME type, filename on stdout, one per line (`--json` for the object). `GET /v1/files` with no `file_ids`. A file holding the content of a knowledge doc or template you cannot use is left out. **A page, not a dump**: the store only ever grows, so the last line prints the command for the next page and `next_cursor` is null on the last one. The cursor is opaque and keyset \u2014 pass it back as given \u2014 so an upload landing mid-sweep cannot make a walk skip or repeat a row. Every other file verb takes an id, so this is the only answer to \"what is in here\" short of reading Postgres. |\n| `lotics knowledge list [--include-hidden \\| --deleted]` | `GET /v1/knowledge_docs` \u2014 a table of id, name, tags, description (`--json` for the docs). **REST, not `get_workspace` kind `knowledge`**: the tool answers what the ASSISTANT may browse, and a hidden doc is out of that corpus by definition, so a tool-backed listing could never show one and the person who hid it would have no way back to it. Hidden docs are left out unless `--include-hidden` asks; those rows are marked `(hidden)`. **`--deleted` is the one tool-backed form**: it calls `get_workspace` with `kind: \"knowledge\"` and `include_archived: true`, page by page, and prints the deleted docs you can manage (id, name, deleted time, description); it cannot be combined with `--include-hidden`. |\n| `lotics knowledge create --name <n> [--description <d>] [--tags <a,b>] (--from <file.md> \\| --content <str>)` | Read the body client-side (a file XOR an inline string \u2014 exactly one required), then call `set_knowledge` with `{ name, description, content, tags? }` and no `knowledge_doc_id`, which makes a doc (description defaults to `\"\"`). `--tags` files the doc as it is made, which is the only moment a corpus reliably gets labelled. Prints the new id to stdout. Large files ride the POST body fine. |\n| `lotics knowledge get <id> [-o <file.md>]` | `GET /v1/knowledge_docs/{id}` (`getKnowledgeDoc`) \u2192 the doc with its **hydrated `content`** (the one whole-content read for a non-sandbox client; the tool `read_knowledge` reads a line range). `-o` writes the body via `writeFileAtomic`; else the body goes to stdout. `--json` prints the full doc instead. |\n| `lotics knowledge update <id> [--from <file.md> \\| --content <str>] [--name <n>] [--description <d>] [--tags <a,b>]` | Call `set_knowledge` with a `knowledge_doc_id` and **only** the provided fields (a body from --from/--content becomes `content`; the tool diffs + CASes the content change internally, so the CLI passes no `expected_content_file_id`). `--tags` REPLACES the doc's label set \u2014 the single-doc form, where the caller is looking at one doc and can state what it should carry. At least one field required; --from and --content are mutually exclusive. |\n| `lotics knowledge tag <id...> [--add <a,b>] [--remove <c,d>]` | `PATCH /v1/knowledge_docs` with `{ knowledge_doc_ids, add_tags?, remove_tags? }` \u2014 one transaction over the whole set. A **DIFF applied to each doc's own labels**, never a replacement: the docs named on one command line carry different labels, so one array across them would strip whatever the others were filed under. Removal matches case-insensitively; adding a label a doc already carries writes nothing. Ids may be separate arguments or comma-separated. At least one of --add/--remove required. |\n| `lotics knowledge hide <id...>` / `lotics knowledge unhide <id...>` | `PATCH /v1/knowledge_docs` with `{ knowledge_doc_ids, hidden }`. Hiding takes docs out of every **listing** \u2014 the Library's list, and the corpus `get_workspace` lists and its `search` searches \u2014 while leaving IAM untouched and keeping them readable **by id** (`read_knowledge` with an id, a code run staging one, an app agent's declared set). So it can never silently break an app that depends on a doc, and unhiding costs nothing. Refuses the no-argument form rather than reading it as \"everything\". |\n| `lotics knowledge rm <id...>` | Delete docs via `set_knowledge` (`{ knowledge_doc_id, delete: true }`), one call per id: each must be a live doc you manage that no app or workflow names, and the command reports which succeeded and which failed. Sharing and history are kept. The REST execute path does not gate `needsApproval`, so this runs unattended. |\n| `lotics knowledge restore <id...>` | Bring deleted docs back via `set_knowledge` (`{ knowledge_doc_id, restore: true }`), one call per id: each must be a deleted doc you manage, and the command reports which succeeded and which failed. Refuses the no-argument form. |\n| `lotics app create <name> --custom [path]` | **A custom-code app**: creates the app (`POST /v1/apps`) and links `[path]` (default `./<name>`, made when absent) to it by writing `package.json#lotics` (the app and its workspace, which is how `app deploy` in that directory finds both) \u2014 into the project's own `package.json` when it has one, every other key kept, otherwise a `package.json` holding the link alone. Nothing else is written and nothing is installed: the project is yours. `app deploy` needs `@lotics/app-sdk` (React 19) and an `npm run build` that writes a static `dist/` with an `index.html`. A directory already linked to an app is refused before the app row exists. The app has no version until the first `lotics app deploy`. `--custom` is required: a JSON app is made by `lotics app apply` (the tool `set_app`). The SDK's reference is `node_modules/@lotics/app-sdk/AGENTS.md` once the project installs it. |\n| `lotics app pull [app_id] [path]` | **An app's live definition, pulled.** The app is read with `get_app`: its author is shown a body, a JSON **tree** (with the addresses of its nodes) pulled as that tree and a custom-code app (its identity and Query nodes) as its source; an app whose stored tree does not read in this release is pulled as it is stored, with a warning giving the reason `get_app` gives (where the stored value is not a JSON object, nothing is pulled and the reason is the error); an app that shows the caller no body (the caller does not author it, or it has no version) is refused. **A JSON app**: the tree is written as JSON to `[path]` (a directory receives `./<name>.app.json`; default `./<name>.app.json`), and the app's id and current version beside it in `<file>.lotics.json` (`{ \"app_id\": \"\u2026\", \"version_id\": \"\u2026\", \"digest\": \"\u2026\" }`, the digest being the file as the CLI last left it; a record without all three is refused by `app apply`, naming `lotics app pull`) \u2014 a custom-code project records both in `package.json#lotics`, a single file has no such place \u2014 so the next `lotics app apply <file>` edits that app, and is refused if the app has since moved past that version. An existing file is overwritten only when its `.lotics.json` names this same app and the file is unchanged since it was last pulled or applied; a file with edits, or whose record names the app but no digest, is refused, naming `--force`, which overwrites it. `--force` is a flag of `app pull` alone. `--json` prints `{workspace_id, app_id, path, outcome}`. **A custom-code app**: its live source, as a project ready to deploy on it. The target is `[path]`, else this directory when it is the app's project (or no app is named), else `./<name>`. **The app's own project is brought up to date in place** \u2014 but only when it holds no edit since the version `package.json#lotics.current_version_id` names: its source (packed as a deploy packs it) is compared with that version's archive, ignoring `.lotics/` and `package.json#lotics`, and any difference refuses the pull, naming the changed files; a pull never merges, so local work is never lost. Already at the live version is a no-op that says so. **An empty or new directory receives the source whole**; any other directory is refused. Downloads come from `GET /v1/apps/{id}/versions/{version_id}/source`. `package.json#lotics` is then set to exactly the app, its workspace and the pulled version, dropping every other key an older CLI wrote there, so the next `lotics app deploy` builds on the live version; then `.lotics/` is written (`GET /v1/apps/{id}/types`) and dependencies installed (`npm ci` with a lockfile, else `npm install`, both `--ignore-scripts`). |\n| `lotics app apply <file> [--app <app_id>] [--check] [--json]` | **A JSON app, one at a time, through the tool `set_app`.** The file is an app's tree (`lotics docs reference`: the App node with the nodes under it, its tables and templates named by alias). **No app known** (no `--app`, no `<file>.lotics.json` beside it): the file is sent as `{ \"body\": \u2026 }` to make a new app, named by the body's `name`, and the id made is printed, then recorded with its version in `<file>.lotics.json`. **An app known**: its current tree is read (`get_app`) and the **RFC 7396 merge patch** that turns it into the file is sent as `body` with the `app_id` and the version the patch was computed against as `base_version_id` \u2014 a key the file drops is `null` in the patch, a list is replaced whole, what the file leaves alone is left alone, and a tree the app already has sends nothing and says so. **A file pulled at a version the app has since left is refused** where the stored tree changed since the pull (a version that moved only for a workflow's body applies) before anything is sent, naming both versions and `lotics app pull <app_id> <path>`: pull the current tree into another path, carry the edits over, apply that file. `--app` naming an app other than the sibling file's is refused too. A write that races the apply is refused by the server, which names the app's current version. A file that sets an object key to `null` is refused naming the key, since a merge patch reads `null` as a removal. `--app` names the app, else the sibling file does; an app whose `get_app` shows no body (it is not yours) is refused, **over a stored tree that does not read in this release the file is sent whole** (`set_app` with `app_id`, the file as `body` and the version read as `base_version_id`; no merge patch is computed against a tree that does not read) where it states `\"type\": \"App\"`, and any other file is refused, naming that only a whole tree replaces it; a custom-code app takes its identity (name, description, icon, colour) and, where the file states `children`, its Query nodes, which replace every query it holds; a file stating none leaves its queries alone and no `<file>.lotics.json` records it, since an identity write makes no version \u2014 its source deploys with `app deploy`. **The file is never rewritten**: a node the tree leaves out draws as the rows call for it and is stored nowhere (`lotics docs design`). It prints what `set_app` answered and reports its `outcome`: its notes and findings, every finding at once, and the saves, adds and Deletes the write grants and removes. **`--check` sends `dry_run`** (a flag of `app apply` alone, as is `--app`) \u2014 what would refuse the tree, and what it would grant and remove \u2014 and writes nothing, the file and its sibling included; an `outcome` of `refused` exits 1. A tree the app already has, or one `set_app` answers `unchanged`, records the version the app stays at in the sibling. **To go back to an earlier version, apply the earlier tree again.** Resolves and ANNOUNCES its workspace first. `--json` prints `{workspace_id, app_id, outcome, write}`, `outcome` being `set_app`'s: `created`, `updated`, `unchanged` or `refused` (with `--check`, what it would be). |\n| `lotics app deploy [-m <message>]` | **Build this directory and upload it as a new version of the live app.** Rewrites `.lotics/` with the declarations of the app's live bindings (`GET /v1/apps/{id}/types`, replacing each file there), then runs the project's `npm run typecheck` (warned about when absent; a type error in the app's own files stops the deploy, one inside an installed package is reported and does not) and `npm run build`, tars the source (without `node_modules`, `dist`, `.git`, `*.tsbuildinfo`) and `dist/`, and posts both to `POST /v1/apps/{id}/versions` on the version `package.json#lotics.current_version_id` names, then stamps the new one there. The version carries the app's queries, workflows, agents and capabilities forward unchanged \u2014 those are written through their tools. A project with no `build` script, or whose `package.json#lotics` still declares `queries`, `workflows`, `agents` or `capabilities`, is refused before anything is built; the refusal names the tool that sets each. **A 409 because another version went live since this directory's last deploy** (a deploy from elsewhere, a rollback) prints the server's sentence and the version that is live, and names `lotics app pull`: run in this directory, it brings an unedited project up to date, and lists the files a project with edits changed, to carry over into a fresh pull. `-m` (or a bare positional) is the version's message, optional. The workspace comes from `package.json#lotics.workspace_id` unless `--workspace` / `LOTICS_WORKSPACE` names another. |\n| `lotics docs` \\| `lotics docs <area>[/<section>]` \\| `lotics docs [<area>[/<section>]] --grep <text>` | **This CLI's own references, carried inside the binary** \u2014 the model reference, this index, and every doc under `docs/` \u2014 so the doc a reader opens describes the binary answering, listed by the job a reader comes to do. Capped at ONE PAGE: a doc that does not fit prints its opening and the addresses of what it holds (`lotics docs <area>/<section>`, each section's size beside it, or a table's row names), and every address prints within a page. **A reference the binary's copy lacks, or a part of one the server serves, is read from the server's `docs` tool** with this machine's credential, after the copy's refusal \u2014 a page the server added since this binary was built, which a server refusal can cite. A name matching more than one reference, or a part missing from a guide to this CLI, is answered by the copy alone. **`--grep` searches the references the server serves** (not this CLI's own guides, which it refuses), with this machine's credential, narrowed to the area or section named: literal text unless `--regex`; a literal search that finds nothing while the pattern read as an expression matches (`a|b`) returns those lines under a note saying so, and `--literal` keeps the literal zero; with `--case-sensitive`, `--diacritic-insensitive`, `--context-lines <n>` and `--limit <n>` \u2014 the dialect the knowledge lines of `get_workspace` with `search` are read in \u2014 each hit under the address that opens its page; any of those options without `--grep` is refused. A custom-code app's SDK reference ships inside `@lotics/app-sdk` in the app's `node_modules`. |\n| `lotics upgrade` | Update this CLI in place. Runs the same installer a person would, chosen by how THIS copy arrived: an npm install upgrades through npm, a script install re-runs the script \u2014 the runtime knows which (the executable is compiled, the npm bin runs under node), so nobody has to. It downloads nothing itself; resolving a version, verifying the checksum and replacing a running executable already exist in the installers, and a second copy of that inside the binary would be a second thing to get right. Replacing the binary while it runs is safe \u2014 a rename leaves the running image mapped on unix, and on Windows the installer moves the old aside precisely because the file is in use. Already current is a no-op that says so. Needs no auth. |\n| `lotics docs reference` \\| `lotics docs reference/<section>[/\u2026]` | **The reference for tables and apps, from inside the binary** \u2014 at this CLI's version; `lotics docs` lists it under \"Build an app\", after `design`. Its first page is what the documents compose with, the working order (jobs \u2192 tables and fields \u2192 `records` \u2192 one app per job \u2192 one `set_tables` call with every table, then every `set_app` call) and the section addresses; every page of it is whole. Every key of a table document and an app body, every field `type` with the config each one needs, the option / view / inline-template shapes, `records` (how a row of a table is recognised), `write_rules`, the apps (each register, record, act and check), the row format (relative dates `@today` / `@month-start` with whole-day offsets; links as `\"<table-ref>:<row-ref>\"` or a stored record's id), the rules, the caps of one `set_tables` call, and a worked example; **Offline, no account.** |\n| `lotics report '<json>'` \\| `lotics report @report.json` | File a report with the Lotics team about what got in your way. **Covers the classes telemetry structurally cannot see**: a capability that does not exist (no command ran, so nothing was recorded), a command that exited 0 having done the wrong thing, an error whose message did not name the remedy, and anything that made authoring slower than it should be. **A frame, not a paragraph** \u2014 `{goal, actual, expected?, tried?, wanted?}`, `goal` and `actual` required, unknown keys dropped rather than refused. **No severity or category.** Ingest is inline JSON, `@file`, or `-` for stdin. A bare sentence is refused with the frame printed beside it, so the fix is one step; a bare invocation prints the frame BEFORE asking for a credential, since someone whose key will not resolve is exactly who has something to report. **Not spooled**: unlike telemetry it posts inline, prints whether it landed, and exits non-zero if it did not, echoing the report back so a failed send never loses it. Runs regardless of `LOTICS_TELEMETRY` \u2014 invoking it IS the consent that passive collection needs an opt-in for \u2014 but with telemetry off there are no recorded commands to attach, and it says so rather than implying context it does not have. Requires auth. Never paste records, file contents, or credentials. **Prints the id of each frame filed** \u2014 a filing nobody can cite cannot be answered about. The ids come from the server, so an instance that only logs the frames prints the count alone; the CLI never mints one of its own, which would hand back a token that resolves to nothing. |\n\n";
1887
+ var cli_reference_default = "# @lotics/cli \u2014 CLI Command Reference\n\nPer-command syntax, flags, contracts, and gotchas for the public `lotics` CLI. Start at [AGENTS.md](../AGENTS.md) for the model this reference assumes; `lotics --help` is the authoritative, always-current verb list.\n\n| Command | What it does |\n|---|---|\n| `lotics` / `lotics --help` | Show full help: capabilities, the verb list (\xA7 COMMANDS), flags, config. `lotics <verb> --help` prints that verb's entries alone (`lotics app --help`, `lotics file download --help`); `lotics report --help` prints the report frame. |\n| `lotics auth signup <email>` | Create account + org + API key, sends magic link email. Refused on a private instance, whose people arrive by invitation; prints that creating the account accepts the Terms and Privacy Policy. Registers the new org as a profile; `--local` pins this directory to it (pointer) instead of setting the global default. |\n| `lotics auth login <email>` | Sign in an account that already exists, on a machine holding no key. **Two steps, and it does not wait for the person.** The first prints the page to open \u2014 `https://lotics.ai/cli_login/<request_id>`, also mailed \u2014 and the code that page must show, records the request, and exits 0. They sign in there if asked, check the code and press Confirm. **Then the next command that needs a credential collects the key** before it does its own work, so the second step is just re-running whatever was wanted; a command run before Confirm exits 1 naming the page and the code again, and once the 15 minutes are up it says to ask again. The handful that run WITHOUT a credential \u2014 `docs` among them \u2014 claim nothing, so one of those run after Confirm still answers as though signed out. `--wait` keeps one command instead, holding the terminal until Confirm; `--local` pins this directory to that org rather than setting the global default, and implies `--wait` (a pin names THIS directory, so only the terminal that stays in it can write one). `--json` prints `organization_id`, `workspace_id` and `organization_name` when it finishes signed in, and `request_id`, `confirm_url`, `code`, `email`, `expires_at` when it is the first step. The request's secret is never printed and the org's key never leaves the store. |\n| \u2014 | **A flag is refused on a verb that does not read it**, naming the verbs that do, before any request or credential: `--check` on `lotics run` would otherwise be parsed and ignored, and the write it was meant to stop would run. `--json`, `--workspace`, `--api-key` and `--timeout` are read by every verb. |\n| \u2014 | **Every call a verb makes waits for the server's answer**; `--timeout <ms>` (a whole number of milliseconds from 1 to 2147483647) stops each wait early. The wait ends without an answer when `--timeout` passes or no answer arrives from the server. A read with no answer changed nothing: the command exits non-zero naming the request id. A write with no answer exits non-zero with `error_code: \"outcome_unknown\"` and the request id under `--json`, because it cannot say whether the call took effect: read before running it again. The one fetch outside this is the download from an object-storage signed URL, which carries no request id and is stopped by `--timeout` alone. Under `--json` every error is one object on stdout: `error`, with `error_code` and `request_id` where the error has them. |\n| `lotics auth api-key [key]` | `whoami` \u2192 **upsert** the key's org as a profile in the global store (never overwrites). The profile records the instance the key was verified against (`LOTICS_API_URL`, default `https://api.lotics.ai`), and every later command for that org goes there. `--local` additionally pins this directory to it (pointer) instead of setting the global default. |\n| `lotics auth web` | Send a magic link email to access the web app (requires auth) |\n| `lotics auth whoami` | Print active account name, email, org, resolved workspace, the instance the credential belongs to, which **kind** of credential this machine holds (a sign-in from `auth login`, or an API key \u2014 read from the saved profile, and from the server when the profile does not say, which covers `--api-key`/`LOTICS_API_KEY` and a profile saved before the field existed; unknown only when neither can say), and the resolution **source** (flag/env/local/app-manifest/global). `--json` adds `workspace_id`, `api_url`, `credential_kind` + `source`. |\n| `lotics auth logout [<name\\|id>]` | In a pinned dir: delete the local pin. Else: remove the profile (default the active org), `--all` for every one. What happens server-side depends on which KIND of credential it is. A **sign-in** (`auth login` / `auth signup`) is revoked \u2014 logging that terminal out ends its credential rather than leaving a live one behind; a server that cannot be reached, or a credential already dead, never blocks the local forget, and one line names the org and Settings \u2192 Security \u2192 *Keys and terminals*. An **API key** (`auth api-key`) is only forgotten here \u2014 an admin issued it and it is routinely on a server and on other machines, so one terminal signing out must not kill it for everyone; the line says it is still active and names both pages, because Settings \u2192 API keys is admin-only and the credential may well be the holder's own sign-in, which they revoke themselves at Settings \u2192 Security \u2192 *Keys and terminals*. A profile saved before the kind was recorded states nothing, so the SERVER is asked (`auth whoami`) and it is revoked only if the answer is a sign-in: an older server, a credential minted before the column, and a request that fails all leave it alone. |\n| \u2014 | **A refused credential says which of three ways it is dead, and names the remedy that ends its kind.** `This credential expired.` / `was revoked.` / `belongs to a member who is no longer active in this organization.` carries `Run \\`lotics auth login <email>\\` to sign in again.` for a sign-in and `Ask an admin for a new API key (Settings \u2192 API keys).` for an issued key. A credential minted before that was recorded still gets BOTH in one sentence, because nothing on the row tells them apart \u2014 so a headless box is never sent looking for a browser alone. A key the server does not recognize at all gets one flat `Invalid or disabled API key.` \u2014 deliberately, so a guessed key learns nothing, not even that it named a row. The body carries `reason` for a script to branch on, since the code stays `unauthorized` for every 401. Changing or resetting the account's password revokes its sign-ins, never an issued key. |\n| `lotics org` | List saved orgs (profiles) from the global store with the instance each belongs to, marks active for this directory (a local pin wins over the global default). |\n| `LOTICS_ORG=<name\\|id>` | Scope every command in this shell to one saved org. **Resolved once, before any command dispatches**, so a value matching no saved credential refuses every verb with one sentence \u2014 a read, a write, and a local check that needs no credential alike \u2014 and refuses it before the first byte is written. It refuses even when a credential arrives another way, because `--api-key` / `LOTICS_API_KEY` outrank it in the precedence chain and a write must never fall through to whatever THOSE name while the variable says otherwise; when the variable resolves and a key is also given, the key decides and the command says so. The refusal lists the orgs this machine holds, so it is answerable without another command (`lotics org` is refused by the same rule). A name is whatever the credential was SAVED under \u2014 a server-side rename never moves it, and the new name resolves too, so both keep working and `lotics org` prints the pair. |\n| `lotics org use <name\\|id> [--local]` | Switch the active org by org name (case-insensitive, ambiguous \u2192 error) or id. No flag \u2192 global `active_org`; `--local` \u2192 a `.lotics/config.json` pointer in the current dir. |\n| `lotics workspace` | List workspaces in the active org, marks current with `(current)` |\n| `lotics workspace select <id>` | Set the workspace in the **active scope** \u2014 a local pin if the dir has one, else the active org's global profile. Records the workspace's NAME beside its id, which is what the `lotics \u2192 <org> / <workspace>` echo prints; `workspace list`, `workspace create`, `workspace rename` and `org use` record it too, so a target is named rather than identified. Until one command has listed it, the echo prints the id and says the name is not known yet. |\n| `lotics workspace create <name> [--timezone <Area/City>] [--currency <ISO>]` | Create a new workspace (admin only), auto-switches to it. Neither flag is defaulted from THIS machine, unlike signup: an extra workspace is routinely created by an operator for somebody else. Without `--timezone` the new workspace inherits the zone of the org's OLDEST workspace; without `--currency` it takes the org's default. Both ride the create, so the workspace is never briefly denominated in a currency nobody asked for. `--currency` takes an ISO-4217 code (case-insensitive; anything else is refused). |\n| `lotics workspace rename <name>` | Rename the **current** workspace (admin only) \u2014 the endpoint takes its target from the request's workspace, never a path id, so switch with `workspace select <id>` first and read the `lotics \u2192 <org> / <workspace>` echo before trusting it \u2014 both halves are names, and the rename moves the cached one in the same act. Carries the workspace's existing `default_currency` and `timezone` through unchanged: the endpoint takes the whole settings triple, so sending only a name would blank the other two. |\n| `lotics workspace settings [--name <n>] [--currency <ISO>] [--timezone <Area/City>]` | Change the CURRENT workspace's name, default currency or timezone \u2014 `PATCH /v1/workspace`, admin only. Only what you name changes; the endpoint takes the whole triple, so the CLI carries the two you did not. `rename` is this verb with the name alone, which is why it can never forget the other two. Both values are invisible once they are wrong: the currency decides how every money field RENDERS and the zone decides how every date BUCKETS, on a workspace whose whole purpose may be to look like the customer's own. `--json` prints the updated workspace. |\n| `lotics workspace delete <id> --yes` | Delete a workspace by id (admin only). **Soft delete** \u2014 `archived_at` is set, so it drops out of listings, can no longer be selected, and its tables/records go dark, while the data is retained and recoverable. Its **apps are cascade-archived** too \u2014 every app entry point (embedded, public link, standalone subdomain, incl. anonymous public links) stops serving. Refuses the org's **only** active workspace (400) and any workspace outside the caller's org (404). Requires `--yes` to confirm (destructive; the CLI is used non-interactively). |\n| `lotics workspace doctor` | Report workspace-wide dangling schema references via `GET /v1/workspaces/dangling-references` \u2014 every active app/workflow artifact whose prefixed schema id no longer resolves, printed as `<referent.kind> \"<name>\" (<id>) \u2192 <namespace> <id> (missing)`; healthy prints a one-line all-clear. **Exits non-zero (exit 1) on findings** so scripts can gate on it. Resolves the first workspace like every data command (runs before the global workspace resolution). Admin-only. |\n| `lotics tools` | List tools by category with descriptions |\n| `lotics tools <name>` | Full description, input JSON Schema, and the output schema where the tool answers a shape, for one tool; a workflow step says to call it from a workflow body, not `lotics run` |\n| `lotics run <tool> '<json>'` | Execute a tool (text output via toModelOutput). Args may also come from a file (`lotics run <tool> @args.json`) or stdin behind the `-` sentinel (`cat args.json \\| lotics run <tool> -`) \u2014 both bypass the OS `ARG_MAX` limit for large payloads (a knowledge-doc `content`, a bulk update). A leading `@` on the args is unambiguously a file path (JSON args start with `{`). **Stdin is asked for, never guessed.** `lotics run <tool>` with no payload runs the tool with no arguments and returns at once. `lotics report` takes the same sentinel. In PowerShell use `@file`: quotes inside an inline argument are consumed by the shell, and the CLI reports the JSON it received with its quotes gone \u2014 the error names both escapes. |\n| `lotics run <tool> --json '<json>'` | Execute a tool (full JSON output) |\n| `lotics run <tool>` \u2014 **file cells** | A file in a tool's result carries its `fil_\u2026` id and metadata and **no `url`**, on every tool and in both output modes. That is not a broken file \u2014 this surface resolves no URL for a cell. Reach the bytes with `lotics file download <file_id>`, which takes the id straight from the cell; the text output says so whenever a result carries one. |\n| \u2014 | **Every tool is invoked here, including the ones that RUN something** (`run_app_workflow`, `run_app_query`) and every one that builds: `set_tables` (a list of table documents), `set_app` (one app), `set_workflow`. A command exists only for work that touches a local file: `app apply`, `app create --custom`, `app pull`, `app deploy`. |\n| \u2014 | **An app's queries and workflows take more than their params and inputs** (`lotics docs agent_surface`). `run_app_query '{\"app_id\",\"alias\",\"params\"}'` also takes `filters` and `sort` over the query's output columns, `fields` (the columns to return), `count` with `count_by` or `count_where`, `aggregate`, `limit` (200 rows at most; 50 where none is stated) and `cursor`, and `runs` \u2014 up to 20 reads in one call, each `{\"alias\", \u2026}`, a refused one answered with its `error`; one call's rows total at most 262,144 bytes. `export: {\"key\", \u2026narrowing}` instead of the read arguments makes the file an app's Export makes (`lotics docs agent_surface`). `run_app_workflow '{\"app_id\",\"alias\",\"inputs\"}'` also takes `dry_run: true` \u2014 a rehearsal on the real inputs, nothing written or sent; the answer is what the run would return, with the reads it made under `dry_run.reads`, the calls it would make under `dry_run.writes` and the papers it rendered under `dry_run.papers` and the parts of the answer it could not say under `dry_run.unpredicted`; a workflow no dry run is offered of answers `status: \"not_previewed\"` \u2014 and `runs` \u2014 up to 50 runs in order, the first refused, failed or not previewed ending the call, an input `{\"from_run\": <index>, \"path\": \"data.<key>\"}` reading an earlier run's answer. |\n| \u2014 | **The exit code reports the WORK, not just the call \u2014 for the tool that RUNS one.** `run_app_workflow` whose envelope carries a failed `status` (`error`/`failed`/`cancelled`, or `not_previewed` \u2014 a dry run asked for and not given) exit non-zero and print `<tool> \u2192 <status>: <message>` to stderr, so `lotics run \u2026 && next-step` cannot walk past a refused run. The rule is an allowlist of FAILURE \u2014 an unrecognized status exits 0, so a status added later never turns a working script red. A parked run (`awaiting_input`) is not a failure: it is waiting for an answer and the work is still live. Only a TOP-LEVEL `status` counts; one inside the data belongs to the data. Any OTHER tool's `status` is data, and exits 0. |\n| `lotics run <tool> '<json>' -o <dir>` | Also save every **signed link** the answer carries \u2014 an object with a `url`, a `filename` and the `expires_at` its signature ends at, at any depth, such as `screenshot_app`'s images. Each is fetched into `<dir>` (created if missing) under its `filename`, taking a free spelling beside a file of that name already there, and a link's `snapshot` text is written beside it as `<name>.txt`. The written paths follow the answer on **stdout**, one per line (on stderr under `--json`, whose stdout stays the one object). A link is signed for an hour; one the store no longer serves exits non-zero. A workspace file states no `expires_at` and is left to `lotics file download`. |\n| `lotics run set_members '{\"members\": {\"<email or member id>\": {\"role\": \"member\", \"name\": \"\u2026\"}}}'` | Invite, rename, change a role, remove (`null`) or restore members; `groups` keeps the member groups in the same call. Admin only: the whole input is checked before an email is sent. A member's `lotics tools` does not list it, nor `set_workspace`. View-as is the web app's preview alone; the CLI acts as the signed-in member. |\n| `lotics run <tool> --print-created` | Report the records the call created, grouped by table, with a paste-ready `delete_records` per table and the mandatory caveat naming what cannot be auto-undone (external integrations, notifications, possible sub-workflows). Works for any tool that returns a `side_effects` block, not workflows alone. |\n| `lotics run <tool> --cleanup` | Implies `--print-created`, then runs those deletes \u2014 harvested records **only**, never files / external calls / notifications. **Not a rollback**; a rollback is structurally impossible here. A partial cleanup exits non-zero so a script cannot read it as success. |\n| `lotics file upload <file\\|dir...>` (alias `lotics upload`) \xB7 `--stdin` \xB7 `--base64` \xB7 `--url <url>` | Upload files/directories. **The transport is chosen by size and is not a flag**: under 8 MiB the file is POSTed to `/v1/files`, several such files to a request up to half that route's 100 MiB cap; at or above it the CLI takes presigned part URLs and PUTs the bytes straight to object storage, so they never pass through the API. That threshold matches the AWS CLI's own `multipart_threshold`, and the number matters less than there being nothing to choose \u2014 one verb, any size, up to the 2 GiB a workspace may store. A large upload reads one part at a time, so memory stays flat regardless of file size, and a failure part-way abandons the parts already sent rather than leaving them billable and invisible. A directory expands to its immediate files; `--as <name>` renames a single upload. **Three alternative byte sources, for a caller that never had the bytes on disk** \u2014 an attachment decoded in memory, a generated document, a signed download link \u2014 each mutually exclusive with the others and with a path argument: `--stdin` takes raw bytes on stdin, `--base64` takes base64 on stdin (the shape attachments arrive in), `--url <url>` fetches the URL first. `--stdin`/`--base64` REQUIRE `--as`, because stdin carries no filename and the mime type is derived from it; `--url` falls back to `Content-Disposition` then the URL's last path segment. `--base64` decodes STRICTLY \u2014 `Buffer.from(s, \"base64\")` silently skips invalid characters and truncates on bad padding, so a corrupted pipe would otherwise store a short file that only fails when a human opens it. The `--url` fetch happens in the CLI, not the server: the URL comes from the operator running the command, so routing it through the backend would add an SSRF surface to buy what `curl` already does. |\n| `lotics file download <file_id> [<path>]` \xB7 `-o <dir>` | (alias `lotics download`) Download a stored file: `GET /v1/files/{id}/signed_url` \u2192 fetch the presigned URL and write it where you asked. **The two spellings mean two different things, and neither is read by shape: the positional `<path>` is the FILE to write, `-o <dir>` is the DIRECTORY to save into.** That is `cp` and `curl -o`, so nothing here consults an extension. A named file is written as named, its parent created, overwriting what is there \u2014 the point of naming it is that the next command opens that exact path. A directory is created if missing and written into under the stored filename (the response's `Content-Disposition`), taking a free spelling beside a file of that name already there so a repeat download never clobbers the first; with no destination at all, that filename lands in cwd. Give the destination once \u2014 a positional and `-o` together is refused, as is a positional that names an existing directory or ends in a separator (`a directory goes in -o`). The first argument is a **file id**, so a path in that slot is refused rather than sent as an id. The written path goes to **stdout** (under `--json`, `{file_id, path, filename, stored_filename}`) and the narration to stderr, so a download pipes into whatever opens it. `lotics file download record <record_id> <field_alias> [-o <dir>]` (the field named by the alias `query_records` shows it under) spreads every file on a record's file field over a DIRECTORY \u2014 there is no single file for N files to be. |\n| `lotics file list [--limit <n>] [--cursor <token>]` | The workspace's files, newest first \u2014 id, upload time, bytes, MIME type, filename on stdout, one per line (`--json` for the object). `GET /v1/files` with no `file_ids`. A file holding the content of a knowledge doc or template you cannot use is left out. **A page, not a dump**: the store only ever grows, so the last line prints the command for the next page and `next_cursor` is null on the last one. The cursor is opaque and keyset \u2014 pass it back as given \u2014 so an upload landing mid-sweep cannot make a walk skip or repeat a row. Every other file verb takes an id, so this is the only answer to \"what is in here\" short of reading Postgres. |\n| `lotics knowledge list [--include-hidden \\| --deleted]` | `GET /v1/knowledge_docs` \u2014 a table of id, name, tags, description (`--json` for the docs). **REST, not `get_workspace` kind `knowledge`**: the tool answers what the ASSISTANT may browse, and a hidden doc is out of that corpus by definition, so a tool-backed listing could never show one and the person who hid it would have no way back to it. Hidden docs are left out unless `--include-hidden` asks; those rows are marked `(hidden)`. **`--deleted` is the one tool-backed form**: it calls `get_workspace` with `kind: \"knowledge\"` and `include_archived: true`, page by page, and prints the deleted docs you can manage (id, name, deleted time, description); it cannot be combined with `--include-hidden`. |\n| `lotics knowledge create --name <n> [--description <d>] [--tags <a,b>] (--from <file.md> \\| --content <str>)` | Read the body client-side (a file XOR an inline string \u2014 exactly one required), then call `set_knowledge` with `{ name, description, content, tags? }` and no `knowledge_doc_id`, which makes a doc (description defaults to `\"\"`). `--tags` files the doc as it is made, which is the only moment a corpus reliably gets labelled. Prints the new id to stdout. Large files ride the POST body fine. |\n| `lotics knowledge get <id> [-o <file.md>]` | `GET /v1/knowledge_docs/{id}` (`getKnowledgeDoc`) \u2192 the doc with its **hydrated `content`** (the one whole-content read for a non-sandbox client; the tool `read_knowledge` reads a line range). `-o` writes the body via `writeFileAtomic`; else the body goes to stdout. `--json` prints the full doc instead. |\n| `lotics knowledge update <id> [--from <file.md> \\| --content <str>] [--name <n>] [--description <d>] [--tags <a,b>]` | Call `set_knowledge` with a `knowledge_doc_id` and **only** the provided fields (a body from --from/--content becomes `content`; the tool diffs + CASes the content change internally, so the CLI passes no `expected_content_file_id`). `--tags` REPLACES the doc's label set \u2014 the single-doc form, where the caller is looking at one doc and can state what it should carry. At least one field required; --from and --content are mutually exclusive. |\n| `lotics knowledge tag <id...> [--add <a,b>] [--remove <c,d>]` | `PATCH /v1/knowledge_docs` with `{ knowledge_doc_ids, add_tags?, remove_tags? }` \u2014 one transaction over the whole set. A **DIFF applied to each doc's own labels**, never a replacement: the docs named on one command line carry different labels, so one array across them would strip whatever the others were filed under. Removal matches case-insensitively; adding a label a doc already carries writes nothing. Ids may be separate arguments or comma-separated. At least one of --add/--remove required. |\n| `lotics knowledge hide <id...>` / `lotics knowledge unhide <id...>` | `PATCH /v1/knowledge_docs` with `{ knowledge_doc_ids, hidden }`. Hiding takes docs out of every **listing** \u2014 the Library's list, and the corpus `get_workspace` lists and its `search` searches \u2014 while leaving IAM untouched and keeping them readable **by id** (`read_knowledge` with an id, a code run staging one, an app agent's declared set). So it can never silently break an app that depends on a doc, and unhiding costs nothing. Refuses the no-argument form rather than reading it as \"everything\". |\n| `lotics knowledge rm <id...>` | Delete docs via `set_knowledge` (`{ knowledge_doc_id, delete: true }`), one call per id: each must be a live doc you manage that no app or workflow names, and the command reports which succeeded and which failed. Sharing and history are kept. The REST execute path does not gate `needsApproval`, so this runs unattended. |\n| `lotics knowledge restore <id...>` | Bring deleted docs back via `set_knowledge` (`{ knowledge_doc_id, restore: true }`), one call per id: each must be a deleted doc you manage, and the command reports which succeeded and which failed. Refuses the no-argument form. |\n| `lotics app create <name> --custom [path]` | **A custom-code app**: creates the app (`POST /v1/apps`) and links `[path]` (default `./<name>`, made when absent) to it by writing `package.json#lotics` (the app and its workspace, which is how `app deploy` in that directory finds both) \u2014 into the project's own `package.json` when it has one, every other key kept, otherwise a `package.json` holding the link alone. Nothing else is written and nothing is installed: the project is yours. `app deploy` needs `@lotics/app-sdk` (React 19) and an `npm run build` that writes a static `dist/` with an `index.html`. A directory already linked to an app is refused before the app row exists. The app has no version until the first `lotics app deploy`. `--custom` is required: a JSON app is made by `lotics app apply` (the tool `set_app`). The SDK's reference is `node_modules/@lotics/app-sdk/AGENTS.md` once the project installs it. |\n| `lotics app pull [app_id] [path]` | **An app's live definition, pulled.** The app is read with `get_app`: its author is shown a body, a JSON **tree** (with the addresses of its nodes) pulled as that tree and a custom-code app (its identity and Query nodes) as its source; an app whose stored tree does not read in this release is pulled as it is stored, with a warning giving the reason `get_app` gives (where the stored value is not a JSON object, nothing is pulled and the reason is the error); an app that shows the caller no body (the caller does not author it, or it has no version) is refused. **A JSON app**: the tree is written as JSON to `[path]` (a directory receives `./<name>.app.json`; default `./<name>.app.json`), and the app's id and current version beside it in `<file>.lotics.json` (`{ \"app_id\": \"\u2026\", \"version_id\": \"\u2026\", \"digest\": \"\u2026\" }`, the digest being the file as the CLI last left it; a record without all three is refused by `app apply`, naming `lotics app pull`) \u2014 a custom-code project records both in `package.json#lotics`, a single file has no such place \u2014 so the next `lotics app apply <file>` edits that app, and is refused if the app has since moved past that version. An existing file is overwritten only when its `.lotics.json` names this same app and the file is unchanged since it was last pulled or applied; a file with edits, or whose record names the app but no digest, is refused, naming `--force`, which overwrites it. `--force` is a flag of `app pull` alone. `--json` prints `{workspace_id, app_id, path, outcome}`. **A custom-code app**: its live source, as a project ready to deploy on it. The target is `[path]`, else this directory when it is the app's project (or no app is named), else `./<name>`. **The app's own project is brought up to date in place** \u2014 but only when it holds no edit since the version `package.json#lotics.current_version_id` names: its source (packed as a deploy packs it) is compared with that version's archive, ignoring `.lotics/` and `package.json#lotics`, and any difference refuses the pull, naming the changed files; a pull never merges, so local work is never lost. Already at the live version is a no-op that says so. **An empty or new directory receives the source whole**; any other directory is refused. Downloads come from `GET /v1/apps/{id}/versions/{version_id}/source`. `package.json#lotics` is then set to exactly the app, its workspace and the pulled version, dropping every other key an older CLI wrote there, so the next `lotics app deploy` builds on the live version; then `.lotics/` is written (`GET /v1/apps/{id}/types`) and dependencies installed (`npm ci` with a lockfile, else `npm install`, both `--ignore-scripts`). |\n| `lotics app apply <file> [--app <app_id>] [--check] [--json]` | **A JSON app, one at a time, through the tool `set_app`.** The file is an app's tree (`lotics docs reference`: the App node with the nodes under it, its tables and templates named by alias). **No app known** (no `--app`, no `<file>.lotics.json` beside it): the file is sent as `{ \"body\": \u2026 }` to make a new app, named by the body's `name`, and the id made is printed, then recorded with its version in `<file>.lotics.json`. **An app known**: its current tree is read (`get_app`) and the **RFC 7396 merge patch** that turns it into the file is sent as `body` with the `app_id` and the version the patch was computed against as `base_version_id` \u2014 a key the file drops is `null` in the patch, a list is replaced whole, what the file leaves alone is left alone, and a tree the app already has sends nothing and says so. **A file pulled at a version the app has since left is refused** where the stored tree changed since the pull (a version that moved only for a workflow's body applies) before anything is sent, naming both versions and `lotics app pull <app_id> <path>`: pull the current tree into another path, carry the edits over, apply that file. `--app` naming an app other than the sibling file's is refused too. A write that races the apply is refused by the server, which names the app's current version. A file that sets an object key to `null` is refused naming the key, since a merge patch reads `null` as a removal. `--app` names the app, else the sibling file does; an app whose `get_app` shows no body (it is not yours) is refused, **over a stored tree that does not read in this release the file is sent whole** (`set_app` with `app_id`, the file as `body` and the version read as `base_version_id`; no merge patch is computed against a tree that does not read) where it states `\"type\": \"App\"`, and any other file is refused, naming that only a whole tree replaces it; a custom-code app takes its identity (name, description, icon, colour) and, where the file states `children`, its Query nodes, which replace every query it holds; a file stating none leaves its queries alone and no `<file>.lotics.json` records it, since an identity write makes no version \u2014 its source deploys with `app deploy`. **The file is never rewritten**: a node the tree leaves out draws as the rows call for it and is stored nowhere (`lotics docs design`). It prints what `set_app` answered and reports its `outcome`: its notes and findings, every finding at once, and the saves, adds and Deletes the write grants and removes. **`--check` sends `dry_run`** (a flag of `app apply` alone, as is `--app`) \u2014 what would refuse the tree, and what it would grant and remove \u2014 and writes nothing, the file and its sibling included; an `outcome` of `refused` exits 1. A tree the app already has, or one `set_app` answers `unchanged`, records the version the app stays at in the sibling. **To go back to an earlier version, apply the earlier tree again.** Resolves and ANNOUNCES its workspace first. `--json` prints `{workspace_id, app_id, outcome, write}`, `outcome` being `set_app`'s: `created`, `updated`, `unchanged` or `refused` (with `--check`, what it would be). |\n| `lotics app deploy [-m <message>]` | **Build this directory and upload it as a new version of the live app.** Rewrites `.lotics/` with the declarations of the app's live bindings (`GET /v1/apps/{id}/types`, replacing each file there), then runs the project's `npm run typecheck` (warned about when absent; a type error in the app's own files stops the deploy, one inside an installed package is reported and does not) and `npm run build`, tars the source (without `node_modules`, `dist`, `.git`, `*.tsbuildinfo`) and `dist/`, and posts both to `POST /v1/apps/{id}/versions` on the version `package.json#lotics.current_version_id` names, then stamps the new one there. The version carries the app's queries, workflows, agents and capabilities forward unchanged \u2014 those are written through their tools. A project with no `build` script, or whose `package.json#lotics` still declares `queries`, `workflows`, `agents` or `capabilities`, is refused before anything is built; the refusal names the tool that sets each. **A 409 because another version went live since this directory's last deploy** (a deploy from elsewhere, a rollback) prints the server's sentence and the version that is live, and names `lotics app pull`: run in this directory, it brings an unedited project up to date, and lists the files a project with edits changed, to carry over into a fresh pull. `-m` (or a bare positional) is the version's message, optional. The workspace comes from `package.json#lotics.workspace_id` unless `--workspace` / `LOTICS_WORKSPACE` names another. |\n| `lotics docs` \\| `lotics docs <area>[/<section>]` \\| `lotics docs [<area>[/<section>]] --grep <text>` | **This CLI's own references, carried inside the binary** \u2014 the model reference, this index, and every doc under `docs/` \u2014 so the doc a reader opens describes the binary answering, listed by the job a reader comes to do. Capped at ONE PAGE: a doc that does not fit prints its opening and the addresses of what it holds (`lotics docs <area>/<section>`, each section's size beside it, or a table's row names), and every address prints within a page. **A reference the binary's copy lacks, or a part of one the server serves, is read from the server's `docs` tool** with this machine's credential, after the copy's refusal \u2014 a page the server added since this binary was built, which a server refusal can cite. A name matching more than one reference, or a part missing from a guide to this CLI, is answered by the copy alone. **`--grep` searches the references the server serves** (not this CLI's own guides, which it refuses), with this machine's credential, narrowed to the area or section named: literal text unless `--regex`; a literal search that finds nothing while the pattern read as an expression matches (`a|b`) returns those lines under a note saying so, and `--literal` keeps the literal zero; with `--case-sensitive`, `--diacritic-insensitive`, `--context-lines <n>` and `--limit <n>` \u2014 the dialect the knowledge lines of `get_workspace` with `search` are read in \u2014 each hit under the address that opens its page; any of those options without `--grep` is refused. A custom-code app's SDK reference ships inside `@lotics/app-sdk` in the app's `node_modules`. |\n| `lotics upgrade` | Update this CLI in place. Runs the same installer a person would, chosen by how THIS copy arrived: an npm install upgrades through npm, a script install re-runs the script \u2014 the runtime knows which (the executable is compiled, the npm bin runs under node), so nobody has to. It downloads nothing itself; resolving a version, verifying the checksum and replacing a running executable already exist in the installers, and a second copy of that inside the binary would be a second thing to get right. Replacing the binary while it runs is safe \u2014 a rename leaves the running image mapped on unix, and on Windows the installer moves the old aside precisely because the file is in use. Already current is a no-op that says so. Needs no auth. |\n| `lotics docs reference` \\| `lotics docs reference/<section>[/\u2026]` | **The reference for tables and apps, from inside the binary** \u2014 at this CLI's version; `lotics docs` lists it under \"Build an app\", after `design`. Its first page is what the documents compose with, the working order (jobs \u2192 tables and fields \u2192 `records` \u2192 one app per job \u2192 one `set_tables` call with every table, then every `set_app` call) and the section addresses; every page of it is whole. Every key of a table document and an app body, every field `type` with the config each one needs, the option / view / inline-template shapes, `records` (how a row of a table is recognised), `write_rules`, the apps (each register, record, act and check), the row format (relative dates `@today` / `@month-start` with whole-day offsets; links as `\"<table-ref>:<row-ref>\"` or a stored record's id), the rules, the caps of one `set_tables` call, and a worked example; **Offline, no account.** |\n| `lotics report '<json>'` \\| `lotics report @report.json` | File a report with the Lotics team about what got in your way. **Covers the classes telemetry structurally cannot see**: a capability that does not exist (no command ran, so nothing was recorded), a command that exited 0 having done the wrong thing, an error whose message did not name the remedy, and anything that made authoring slower than it should be. **A frame, not a paragraph** \u2014 `{goal, actual, expected?, tried?, wanted?}`, `goal` and `actual` required, unknown keys dropped rather than refused. **No severity or category.** Ingest is inline JSON, `@file`, or `-` for stdin. A bare sentence is refused with the frame printed beside it, so the fix is one step; a bare invocation prints the frame BEFORE asking for a credential, since someone whose key will not resolve is exactly who has something to report. **Not spooled**: unlike telemetry it posts inline, prints whether it landed, and exits non-zero if it did not, echoing the report back so a failed send never loses it. Runs regardless of `LOTICS_TELEMETRY` \u2014 invoking it IS the consent that passive collection needs an opt-in for \u2014 but with telemetry off there are no recorded commands to attach, and it says so rather than implying context it does not have. Requires auth. Never paste records, file contents, or credentials. **Prints the id of each frame filed** \u2014 a filing nobody can cite cannot be answered about. The ids come from the server, so an instance that only logs the frames prints the count alone; the CLI never mints one of its own, which would hand back a token that resolves to nothing. |\n\n";
1829
1888
 
1830
1889
  // docs/data_model.md
1831
1890
  var data_model_default = '# The data model \u2014 tables, their fields, and how they relate\n\nThe decisions here outlive any one app, and most become expensive the moment a second screen depends\non them. They stand apart from building an app on purpose: **every workspace starts with tables\nand many never get an app**, so schema design is not a chapter of app building.\n\nThe rules below share one signature. **Both sides read correctly on their own**, so nothing reports\nthe problem \u2014 no error, no empty column, no failing query. Each is found by looking for it. Then,\nunder **Fields**, what each field type takes.\n\n## One fact, one column\n\n**Read the table\'s existing fields first (`get_table`), and add nothing that stores a fact the table already\nstores.** A value written as text and the same value held as a `link` are one fact in\ntwo columns \u2014 a customer\'s city typed into a text box beside a link to the city record, a status\nword beside the select that decides it, a total beside the formula that computes it.\n\nTwo columns for one fact do not stay equal. Some writer sets only one of them, and nothing reports\nthe divergence: both rows still look correct on their own. A reader that then matches on the text\nhalf treats "Acme" and "Acme Ltd" as different records, so an import creates a duplicate every time\nit runs.\n\n- **Prefer the link, the select, or the formula.** Text is a RENDERING of a record; compose it when\n you read, rather than storing it a second time.\n- **Renaming, retyping or re-pointing the existing field beats adding another.** A field\'s key is\n stable, so a rename breaks nothing that addresses it by key.\n- **Superseding a field means DELETING it**, not leaving it beside its replacement with a\n description that says which one is real.\n- **Empty is not the same as redundant.** A field nothing fills may still be the only home for a\n real distinction \u2014 read what it MEANS before removing it.\n- **A stored field becomes required only once every row holds a value**, so it always holds one: fill the\n empty cells first, then set it. A computed field\'s flag is checked as each row is written.\n\n## One entity, one table \u2014 and the test is measurable\n\nVariation belongs in a column \u2014 a multi-select role, a kind, a stage \u2014 not in a second table. Two\ntables for one kind of thing give the same real-world entity two rows, two ids and two halves of its\nhistory, and each screen shows whichever half it happens to link to.\n\nSplit tables are often right. A supplier book beside a customer book is a normal shape, and merging\non suspicion is a large repoint bought for nothing. So do not argue it in the abstract:\n\n> **List both tables\' names and look for one that appears in both.**\n\nNone means the split is holding. One means it has broken \u2014 the usual cause is a party you begin to\ninvoice as well as buy from \u2014 and the fix is to merge before a second screen depends on the copy.\n\n## One vocabulary wherever values are COPIED between tables\n\nTwo `select` fields for one concept carry different option keys even when their labels match. Copy an option by its\nalias or label: the record tools match an option by alias or label, so a value copied by alias lands\non the option of that alias on the other field. Prefer a link to a shared reference table where the set is open or\ngrowing. Where one side holds more values than the other, the wider side must **refuse** what the narrower one cannot\nexpress rather than quietly picking the nearest value.\n\nA value read through a link or a lookup reads exactly as the same field would on its own row: an option written by its alias in\na body and read as its key, a member or a link by its id. A value a check matches\nacross tables is a link to one table: two selects never compare, and a save that compares them is refused, in a check\'s lookup too. A filter or a write on another table\'s select takes a value read from this one by its alias, else its label.\n\nA lookup reads as one flat list of the values it looks up, in a check and in every body: `first(record.x)` is the one value through a one-row link and `includes(record.x, v)` asks whether any row holds `v`; two selects never compare, so a value matched across tables is a link to one table. A single member, a single select, a number or a text reads as the value itself, and `first(...)` of one is refused when the body is saved. A rollup that adds up (a sum, a count) over no rows is 0, never empty, as `sum` over an empty list is; a min, a max or an average over no rows is empty.\n\n## A copy boundary accounts for EVERY source field\n\nEach field on the source gets a column on the destination, a deliberate drop with the reason written\ndown, or a refusal.\n\nA field with nowhere to land is data destroyed at the boundary, and it is invisible afterwards: the\ndestination is not empty and not obviously wrong \u2014 just a number that no longer agrees with where it\ncame from.\n\n## Provenance is a LINK, not a flag and not a copy\n\nA row created BY another row carries a link to it.\n\nThat link is what makes "is this the estimate or the actual", "where did this come from" and "have we\nalready imported this" answerable at all. A boolean records that something was true once; a link\nstays true, survives a rename, and lets the next write UPDATE the original instead of adding a second\nrow beside it.\n\n## Say what makes two rows the SAME row\n\nState it as the table\'s `natural_key` (`reference/write-rules`); a text key is also `unique`.\n\nAnything that imports, reconciles or de-duplicates has to decide identity, and with no declared key it falls back to\ncomparing displayed text \u2014 which is how one company arrives three times under three spellings. Name the key: a reference\nnumber, a tax id, a link plus a period. Then match on record ids and option aliases, never on rendered labels.\n\n## A stage\'s moment is a date on the row\n\nWho changed what, and when, is the platform\'s audit trail, which an agent already reads (`query_audit_logs`) under\nits own access to the table \u2014 so it is never a table of yours, and an app shows none of it: a history an app shows is\ntable-backed (`records.status.dates`, `records.status.history`, an event table an act makes).\n\nWhen the business reports, filters or prints the moment a row reached a stage (completed on, cancelled on), that\nmoment is a `date` field of the row, as `completed_at` and `canceled_at` are in SQL. State it as `records.status.dates`\n(`reference/status`): option \u2192 date. The record write path stamps it as a row is made at the option or moved into it,\nwhoever writes, so no one has to remember; a value the same write states wins, which loads past data as it happened. The\nplatform never clears a stamp: each date is when the row last entered the option, and leaving keeps it, and putting a\nchange back restamps nothing. A date range is a span, never a moment, so it is refused. It is the one way a status is\ntimed: a stage\'s `within` runs from its date, a straight-line process is one select whose options are its steps, each\ndated, and the stage is never read off a run of dates.\n\n`records.status.history` is for a business that reports on every move \u2014 moves per person, or time in a stage a row\nre-enters \u2014 and the platform appends one row per move. An event that carries facts of its own (a reason, an amount, a\nsignature, an inspection\'s findings) is its own table with those fields, made by the act that records it.\n\n## Keep derived chains shallow\n\nFormulas and rollups are computed and STORED when a row is written, and one that reads another recomputes with it. A\nrollup over a formula over a formula is paid three times on every touch, and again for every row upstream of it.\n**Depth costs more than row count**: chain depth is yours to keep down, row scanning is the platform\'s.\n\n## Fields\n\nA field is stated inside its table\'s document in a `set_tables` call, keyed by alias. A name people read (a\ntable\'s, a field\'s, an option\'s) is in the owner\'s language; an alias stays English. Every field `type`, the\nkeys each one takes (notation, defaults, options, links, formulas, rollups, lookups, copies) and a worked\nexample are in `docs path="reference/field"`; this page holds the choices around them.\n\n### Types and formats\n\n`type` is one of `text`, `number`, `date`, `boolean`, `select`, `member`,\n`link`, `files`, `formula`, `rollup`, `lookup`, `autonumber`.\n\nA URL, an email, markdown, a checkbox, a datetime, money, a quantity or a percentage is a `format`\nor a `notation` on another type, never a `type`:\n\n| Wanted | Field |\n|---|---|\n| URL or external link | `{ type: "text", format: "link" }` |\n| Email or phone | `{ type: "text" }` |\n| Markdown | `{ type: "text", format: "markdown" }` |\n| Checkbox | `{ type: "boolean" }` |\n| Money | `{ type: "number", notation: { style: "currency", currency: "USD" } }` |\n| Quantity | `{ type: "number", notation: { style: "unit", unit: "kg" } }` |\n| Percentage | `{ type: "number", notation: { style: "unit", unit: "percent" } }` |\n| Datetime | `{ type: "date", format: "datetime" }` |\n| Date range | `{ type: "date", format: "date_range" }` |\n\n### Changing a field\n\nRead the table with `get_table`, which answers its document exactly as `set_tables` takes it, then send `set_tables` with\nthe `table_id` and only what changes. The table is edited by an RFC 7396 merge patch of its document, so what the patch\nleaves alone is left alone and `null` deletes the field it names. Every key a table and a field take is in\n`docs path="reference/tables"` and `reference/field`.\n\nA table is named by its alias wherever a call names one (`table_id`, a link\'s `table`, a lookup, `records.history`), and a new table in the call is named by its `ref`, which becomes its alias. The alias is kept while the table exists, archived or not: asking for one an archived table holds is refused, offering to restore that table or to choose another alias. A filter in a table document (a rollup\'s `filter`, `options_where`, a colour\'s condition, a check\'s lookup) takes the record tools\' operators and values (`is`, `is_any_of`, `gte`, a plain date as a day). An `autonumber` field takes `next` (`"next": 232`): the number its next row gets, refused below the highest already issued.\n\n- **A list is replaced whole**, so an option cannot be nulled. To rename, recolour, add or remove an option, restate the\n field\'s whole `options` list, each option with its alias (`reference/field/select`). A rename changes the label and every\n record keeps its value; an alias left out is removed, which needs `force` while rows hold it.\n- **A number field becomes an `autonumber`** when every row holds its own whole number of 1 or more: the numbers are kept\n and the next row takes the one after the highest (a `next` must be above it). Otherwise the call is refused, saying how\n many rows are blank, repeated or not whole, with up to 5 row ids. No other type converts to or from an autonumber; add\n one as a new field, which numbers the rows already there from 1 (or from `next`) in creation order.\n- **Splitting an option is a rename plus an add.** The old option keeps its alias and takes the first part\'s label, so its\n rows and every app reference to it keep working; the second part is a new option. Rows that belong to the second part\n are then moved by a filtered `update_records`.\n- **A status history holds every option its status ever had** and follows them in the same write: an option added or renamed\n on the status is added or renamed on the history, which a call never restates. Removing an option on the status leaves it\n on the history, because the moves already written hold it. A call that changes nothing of the status\'s options leaves the\n history alone, and options only the history holds stay. Deleting a row deletes its history rows with it, and restoring\n the row restores them; they never hold a delete back.\n- A link names its table by id, or by the `ref` of another table of the same call, and states its `multi`. A two-way link\n states `pair` on one table, as `true` or as a free alias, and the platform makes the partner on the other table with the\n inverse cardinality; a many-to-many link states both sides, since the inverse of many is not decided.\n A link to its own table pairs with itself when `pair` is `true`, and with a second field of that table when `pair` names it\n (a parent and its children).\n A link already holding rows is paired the same way, with its partner stated beside it in the call: the partner is filled from\n the links the rows hold and no cell of the link is rewritten. `pair: null` lets a pair go, both fields staying one-way links\n with their values; a field that holds one row, the partner or the link itself, refuses a pair two rows would crowd, naming the rows.\n The partner may stand on a table the call does not name: `pair: "<alias>"` makes it there, or pairs the one-way link that table\n already holds under that alias, and the answer lists that table among the call\'s. Only someone who manages that table may.\n- A formula\'s `output_type` is inferred from its expression; state it only to override.\n- **A call\'s removals are judged together, on what the call leaves.** A table and the links and lookups naming it, removed in one call, pass; every reader left outside the call is named in one answer, not one per retry. An app reading a field or an option that leaves is rebuilt in the same call, and the answer (a dry run too) lists each node of its tree that changed: a column, a filter, a sort key or a field of a part that only drew the field is dropped, and an option leaves every list of options it stood in. What has no meaning without it refuses the call, naming the node: an act that sets a removed option, a part left with nothing to draw, a list that held only the removed option. An app drawing a field that is retyped, or a link pointed at another table, is rebuilt too, its tree unchanged: where the field no longer lets the tree draw what it drew, the call refuses, naming the node, and a field that became a formula, rollup, lookup or autonumber leaves the app\'s allowlist of saves. A workflow body its author wrote is never rewritten: it is checked again against the tables as the call leaves them, and the call refuses, naming the workflow, only if it no longer checks. A table\'s check or workflow that reads a retyped field or a link pointed elsewhere is judged the same way and refuses, naming it, only if it no longer holds. Deleting one field through the table\'s field route drops no node: an app whose tree draws the field refuses it, naming the node.\n- **A field something reads cannot go.** A query, a workflow, a check, an app only its owner can rebuild, or another\n table\'s formula, rollup, lookup or copy that reads the field refuses its deletion, naming the reader. Change or remove\n the reader first, or in the same call.\n- **`force` consents to losing values:** deleting a field rows hold, removing an option rows hold, and a change of type\n that does not convert every value.\n- A money formula is proven by its numbers. `query_records` with `aggregate` the affected totals before the change and after, and\n compare. A new field in a formula is tested for the value you want, never for differing from an empty cell, which reads\n `""` and differs from every option.\n- A check\'s expressions are written in the language of `workflows/table-checks`.\n- Views are written with `set_table_views`, not `set_tables`: `views` is keyed by a view\'s id (patch; `null` deletes) or a new key (create), and `order` lists view ids or new keys. `get_table` lists each view\'s id and name and returns the definitions with `views: true`.\n- A refused edit writes nothing and lists everything wrong; `dry_run` is for reading the grants it would make or deciding `force`.\n\nA worked call: add the option `cancelled` to `stage` (the whole list restated), add a check, and consent to losing\nwhat rows hold.\n\n```json5\n{\n "tables": [\n {\n "table_id": "<id of the table>",\n "fields": {\n "stage": {\n "options": [\n { "alias": "draft", "label": "Draft" },\n { "alias": "confirmed", "label": "Confirmed" },\n { "alias": "cancelled", "label": "Cancelled", "color": "red" }\n ]\n }\n },\n "checks": {\n "returns_after_leaves": {\n "on": ["create", "update"],\n "when": "!isNull(record.returns)",\n "fail_when": "record.returns < record.leaves",\n "message": "\\"Return before departure\\"",\n "field": "returns"\n }\n }\n }\n ],\n "force": true,\n "dry_run": true\n}\n```\n\nSplitting `queued` into waiting and underway is one call of the same shape:\n\n```json5\n{ "tables": [{ "table_id": "<id of the table>", "fields": { "stage": { "options": [\n { "alias": "draft", "label": "Draft" },\n { "alias": "queued", "label": "Waiting" },\n { "alias": "underway", "label": "Underway", "color": "green" }\n] } } }] }\n```\n\n`table_id` picks the table patched; `fields` merges by alias, so only `stage` changes; `checks` adds one under its alias\n(`null` removes it); `force` consents to losing values (leave it out unless rows hold a removed option); `dry_run`\nchecks and writes nothing, for reading the grants or deciding `force` before the call that writes.\n';
@@ -2261,6 +2320,10 @@ function flushPendingWarnings() {
2261
2320
  for (const text of collectedWarnings) console.error(text);
2262
2321
  collectedWarnings.length = 0;
2263
2322
  }
2323
+ function exitCli(code) {
2324
+ flushPendingWarnings();
2325
+ process.exit(code);
2326
+ }
2264
2327
 
2265
2328
  // src/docs_command.ts
2266
2329
  var TEXTS = {
@@ -2303,7 +2366,7 @@ async function docsCommand(args, server) {
2303
2366
  const own2 = ownArea(args.area);
2304
2367
  if (own2 !== void 0) {
2305
2368
  console.error(`--grep searches the references the server holds, and "${own2}" is this binary's own: read it with \`lotics docs ${own2}\`.`);
2306
- process.exit(1);
2369
+ exitCli(1);
2307
2370
  }
2308
2371
  return printAnswer(await (await server()).execute("docs", { path: args.area, ...args.search }, { format: "text" }));
2309
2372
  }
@@ -2314,7 +2377,7 @@ async function docsCommand(args, server) {
2314
2377
  }
2315
2378
  console.error(page.error);
2316
2379
  const newer = page.kind === "no_area" || page.kind === "no_part" && SERVED2.has(page.area);
2317
- if (!newer) process.exit(1);
2380
+ if (!newer) exitCli(1);
2318
2381
  note("This binary's references may predate the page; reading the server's.");
2319
2382
  printAnswer(await (await server()).execute("docs", { path: args.area }, { format: "text" }));
2320
2383
  }
@@ -2327,7 +2390,7 @@ function ownArea(path17) {
2327
2390
  function printAnswer(answer) {
2328
2391
  if (answer.error) {
2329
2392
  console.error(answer.error);
2330
- process.exit(1);
2393
+ exitCli(1);
2331
2394
  }
2332
2395
  if (answer.model_output === void 0) fail("The server's docs tool answered without its text.");
2333
2396
  process.stdout.write(`${answer.model_output.replace(/\n+$/, "")}
@@ -2747,7 +2810,7 @@ async function reportCommand(client, options) {
2747
2810
  `Could not file the report: ${error62 instanceof Error ? error62.message : String(error62)}`
2748
2811
  );
2749
2812
  echoReport(report);
2750
- process.exit(1);
2813
+ exitCli(1);
2751
2814
  }
2752
2815
  console.error(
2753
2816
  `Filed${filed > 1 ? ` ${filed} reports` : ""}${filedIds.length > 0 ? `: ${filedIds.join(", ")}` : ""}. Thank you \u2014 this is read.`
@@ -26032,6 +26095,7 @@ var BRAND_NAMES = [
26032
26095
  "gmail",
26033
26096
  "google-drive",
26034
26097
  "outlook",
26098
+ "excel",
26035
26099
  "kiotviet",
26036
26100
  "misa",
26037
26101
  "lark",
@@ -27653,6 +27717,7 @@ var AGENT_RUN_POLL = {
27653
27717
  function splitList(value) {
27654
27718
  return (value ?? "").split(",").map((part) => part.trim()).filter((part) => part !== "");
27655
27719
  }
27720
+ var MAX_TIMEOUT_MS = 2147483647;
27656
27721
  var CANONICAL_FLAG = {
27657
27722
  "-o": "--output",
27658
27723
  "-w": "--workspace",
@@ -27692,6 +27757,7 @@ function parseArgs(argv2) {
27692
27757
  const typed = [];
27693
27758
  let unknownFlag;
27694
27759
  let missingValue;
27760
+ let invalidValue;
27695
27761
  let i = 0;
27696
27762
  const takeValue = (flag, expects) => {
27697
27763
  const value = argv2[++i];
@@ -27715,9 +27781,12 @@ function parseArgs(argv2) {
27715
27781
  case "--url":
27716
27782
  flags.url = takeValue(arg, "<url>");
27717
27783
  break;
27718
- case "--timeout":
27719
- flags.timeout = parseInt(takeValue(arg, "<ms>"), 10);
27784
+ case "--timeout": {
27785
+ const value = takeValue(arg, "<ms>");
27786
+ if (/^[1-9]\d*$/.test(value) && Number(value) <= MAX_TIMEOUT_MS) flags.timeout = Number(value);
27787
+ else if (!missingValue) invalidValue ??= { flag: arg, expects: `a whole number of milliseconds from 1 to ${MAX_TIMEOUT_MS}`, value };
27720
27788
  break;
27789
+ }
27721
27790
  case "--output":
27722
27791
  case "-o":
27723
27792
  flags.output = takeValue(arg, "<path>");
@@ -27857,21 +27926,7 @@ function parseArgs(argv2) {
27857
27926
  if (matched) typed.push(CANONICAL_FLAG[arg] ?? arg);
27858
27927
  i++;
27859
27928
  }
27860
- return { command, subcommand, toolArgs, restArgs, flags, typed, unknownFlag, missingValue };
27861
- }
27862
-
27863
- // ../shared/src/screenshot_limits.ts
27864
- var MAX_SCREENSHOT_WIDTHS = 3;
27865
- var SCREENSHOT_BUDGET_MS = 3e4;
27866
- var SCREENSHOT_QUEUE_WAIT_MS = 2e4;
27867
- var SCREENSHOT_CAPTURE_MARGIN_MS = 43e3;
27868
- var SCREENSHOT_BROWSER_OPEN_MS = 49e3;
27869
- var SCREENSHOT_TRANSFER_MS = 1e4;
27870
- function screenshotRenderCeilingMs(widths) {
27871
- return widths * (SCREENSHOT_BUDGET_MS + SCREENSHOT_CAPTURE_MARGIN_MS);
27872
- }
27873
- function screenshotTimeoutMs(widths) {
27874
- return SCREENSHOT_QUEUE_WAIT_MS + SCREENSHOT_BROWSER_OPEN_MS + screenshotRenderCeilingMs(widths) + SCREENSHOT_TRANSFER_MS;
27929
+ return { command, subcommand, toolArgs, restArgs, flags, typed, unknownFlag, missingValue, invalidValue };
27875
27930
  }
27876
27931
 
27877
27932
  // src/cli_login.ts
@@ -28389,7 +28444,7 @@ ${renderCommandsHelp()}
28389
28444
 
28390
28445
  FLAGS
28391
28446
  --json Full JSON output (default is human-readable text)
28392
- --timeout <ms> Timeout for tool execution (default: 60000; screenshot_app waits for its widest request)
28447
+ --timeout <ms> Stop waiting for the server's answer after this long (default: wait for it)
28393
28448
  -o <path> download: the directory to save into; knowledge get: the file
28394
28449
  to write; run: the directory every signed link in the
28395
28450
  tool's answer is saved into
@@ -28559,14 +28614,14 @@ async function runUpgrade() {
28559
28614
  Upgrade failed (exit ${code}). Run it yourself to see why:
28560
28615
  ${cmd}`
28561
28616
  );
28562
- process.exit(1);
28617
+ exitCli(1);
28563
28618
  }
28564
28619
  }
28565
28620
  async function handleSignup(positionalEmail, flags) {
28566
28621
  const email3 = positionalEmail ?? (process.stdin.isTTY ? await prompt("Email: ") : "");
28567
28622
  if (!email3) {
28568
28623
  console.error("Email is required. Usage: lotics auth signup <email>");
28569
- process.exit(1);
28624
+ exitCli(1);
28570
28625
  }
28571
28626
  if (alreadySetUp(email3)) {
28572
28627
  console.error(
@@ -28593,7 +28648,7 @@ async function handleSignup(positionalEmail, flags) {
28593
28648
  });
28594
28649
  } catch (error62) {
28595
28650
  console.error(error62 instanceof Error ? error62.message : String(error62));
28596
- process.exit(1);
28651
+ exitCli(1);
28597
28652
  }
28598
28653
  if (outcome.kind === "email_taken") {
28599
28654
  console.error(
@@ -28601,7 +28656,7 @@ async function handleSignup(positionalEmail, flags) {
28601
28656
  Sign in on this machine: lotics auth login ${email3}
28602
28657
  Which account is saved: lotics auth whoami`
28603
28658
  );
28604
- process.exit(1);
28659
+ exitCli(1);
28605
28660
  }
28606
28661
  const { orgId, orgName } = outcome.account;
28607
28662
  console.error(`Account created. You can now use the CLI.`);
@@ -28619,7 +28674,7 @@ async function handleLogin(positionalEmail, flags) {
28619
28674
  const email3 = positionalEmail ?? (process.stdin.isTTY ? await prompt("Email: ") : "");
28620
28675
  if (!email3) {
28621
28676
  console.error("Email is required. Usage: lotics auth login <email>");
28622
- process.exit(1);
28677
+ exitCli(1);
28623
28678
  }
28624
28679
  if (!waitsForConfirm(flags)) {
28625
28680
  const pending = await startPendingLogin(email3);
@@ -28646,7 +28701,7 @@ async function handleLogin(positionalEmail, flags) {
28646
28701
  account = await awaitCliLogin(email3, flags.local ? { local: true } : {});
28647
28702
  } catch (error62) {
28648
28703
  console.error(error62 instanceof Error ? error62.message : String(error62));
28649
- process.exit(1);
28704
+ exitCli(1);
28650
28705
  }
28651
28706
  narrate(`lotics \u2192 ${account.orgName} / ${account.workspaceId}`);
28652
28707
  if (flags.json) {
@@ -28663,22 +28718,15 @@ async function handleLogin(positionalEmail, flags) {
28663
28718
  );
28664
28719
  }
28665
28720
  }
28666
- async function handleSetup(providedKey, local) {
28721
+ async function handleSetup(providedKey, local, timeoutMs) {
28667
28722
  const apiKey = providedKey ?? await prompt("Enter your API key: ");
28668
28723
  if (!apiKey) {
28669
28724
  console.error("No API key provided.");
28670
- process.exit(1);
28725
+ exitCli(1);
28671
28726
  }
28672
28727
  const apiUrl = envApiUrl();
28673
- const client = new LoticsClient({ apiKey, apiUrl });
28674
- let info;
28675
- try {
28676
- info = await client.whoami();
28677
- } catch (error62) {
28678
- const message = error62 instanceof Error ? error62.message : String(error62);
28679
- console.error(`Authentication failed: ${message}`);
28680
- process.exit(1);
28681
- }
28728
+ const client = new LoticsClient({ apiKey, apiUrl, timeoutMs });
28729
+ const info = await client.whoami();
28682
28730
  let workspaceId;
28683
28731
  let workspaceName;
28684
28732
  try {
@@ -28765,16 +28813,16 @@ async function requireClient(flags, appWorkspaceId) {
28765
28813
  const { ctx, refusal } = await resolveContextOrClaim(flags, { appWorkspaceId });
28766
28814
  if (refusal !== void 0) {
28767
28815
  console.error(refusal);
28768
- process.exit(1);
28816
+ exitCli(1);
28769
28817
  }
28770
28818
  if (!ctx) {
28771
28819
  console.error('Not authenticated. Run "lotics auth signup", "lotics auth api-key <key>", or set LOTICS_API_KEY.');
28772
- process.exit(1);
28820
+ exitCli(1);
28773
28821
  }
28774
28822
  noteScope({ org_id: ctx.orgId ?? void 0, workspace_id: ctx.workspaceId });
28775
28823
  flushSpool(ctx.apiUrl, (events) => postEvents(ctx.apiUrl, ctx.apiKey, events));
28776
28824
  return {
28777
- client: new LoticsClient({ apiKey: ctx.apiKey, apiUrl: ctx.apiUrl, workspaceId: ctx.workspaceId }),
28825
+ client: new LoticsClient({ apiKey: ctx.apiKey, apiUrl: ctx.apiUrl, workspaceId: ctx.workspaceId, timeoutMs: flags.timeout }),
28778
28826
  ctx
28779
28827
  };
28780
28828
  }
@@ -28832,17 +28880,10 @@ async function resolveWorkspace(client, ctx) {
28832
28880
  announceTarget(ctx, ctx.workspaceId, name);
28833
28881
  return;
28834
28882
  }
28835
- let workspaces;
28836
- try {
28837
- workspaces = await client.listWorkspaces();
28838
- } catch (error62) {
28839
- const message = error62 instanceof Error ? error62.message : String(error62);
28840
- console.error(`Failed to list workspaces: ${message}`);
28841
- process.exit(1);
28842
- }
28883
+ const workspaces = await client.listWorkspaces();
28843
28884
  if (workspaces.length === 0) {
28844
28885
  console.error("No workspaces found for this organization.");
28845
- process.exit(1);
28886
+ exitCli(1);
28846
28887
  }
28847
28888
  if (workspaces.length === 1) {
28848
28889
  setSelectedWorkspace(workspaces[0].id, ctx.orgId, workspaces[0].name);
@@ -28854,7 +28895,7 @@ async function resolveWorkspace(client, ctx) {
28854
28895
  console.error(" lotics workspace select <id>\n");
28855
28896
  printWorkspaceList(workspaces);
28856
28897
  console.error("");
28857
- process.exit(1);
28898
+ exitCli(1);
28858
28899
  }
28859
28900
  function resolveUploadPaths(rawPaths) {
28860
28901
  const result = [];
@@ -28878,12 +28919,17 @@ function wholeNumberFlag(flag, value, min) {
28878
28919
  const parsed = Number(value);
28879
28920
  if (value.trim() === "" || !Number.isInteger(parsed) || parsed < min) {
28880
28921
  console.error(`Invalid ${flag} "${value}" \u2014 expected ${min === 1 ? "a positive integer" : "a whole number"}.`);
28881
- process.exit(1);
28922
+ exitCli(1);
28882
28923
  }
28883
28924
  return parsed;
28884
28925
  }
28885
28926
  async function main(argv2) {
28927
+ await dispatch(argv2);
28928
+ flushPendingWarnings();
28929
+ }
28930
+ async function dispatch(argv2) {
28886
28931
  const parsed = parseArgs(argv2);
28932
+ setMachineOutput(parsed.flags.json);
28887
28933
  const { restArgs, flags } = parsed;
28888
28934
  let { command, subcommand, toolArgs } = parsed;
28889
28935
  if (parsed.unknownFlag !== void 0) {
@@ -28895,12 +28941,17 @@ async function main(argv2) {
28895
28941
  );
28896
28942
  } else if (dryRunFlag) console.error("Nothing was written. A dry run is --check: lotics app apply <file> --check");
28897
28943
  else console.error("Run 'lotics --help' for the options each command takes.");
28898
- process.exit(1);
28944
+ exitCli(1);
28899
28945
  }
28900
28946
  if (parsed.missingValue !== void 0) {
28901
28947
  const { flag, expects } = parsed.missingValue;
28902
28948
  console.error(`${flag} needs a value \u2014 write it as: ${flag} ${expects}`);
28903
- process.exit(1);
28949
+ exitCli(1);
28950
+ }
28951
+ if (parsed.invalidValue !== void 0) {
28952
+ const { flag, expects, value } = parsed.invalidValue;
28953
+ console.error(`${flag} needs ${expects} \u2014 got ${JSON.stringify(value)}`);
28954
+ exitCli(1);
28904
28955
  }
28905
28956
  if (flags.help && command === "report") {
28906
28957
  console.error(REPORT_USAGE);
@@ -28933,7 +28984,7 @@ async function main(argv2) {
28933
28984
  `--version prints this CLI's version and takes no argument; it cannot be combined with a command.
28934
28985
  The CLI version: lotics --version`
28935
28986
  );
28936
- process.exit(1);
28987
+ exitCli(1);
28937
28988
  }
28938
28989
  if (flags.version) {
28939
28990
  console.log(VERSION);
@@ -28942,7 +28993,7 @@ async function main(argv2) {
28942
28993
  const misplaced = misplacedFlag(parsed.typed, [command, subcommand].filter((word) => word !== void 0));
28943
28994
  if (misplaced !== null) {
28944
28995
  console.error(misplaced);
28945
- process.exit(1);
28996
+ exitCli(1);
28946
28997
  }
28947
28998
  const envOrg = resolveEnvOrg();
28948
28999
  if (envOrg && (flags.apiKey ?? process.env.LOTICS_API_KEY)) {
@@ -28956,12 +29007,12 @@ async function main(argv2) {
28956
29007
  const stray = Object.entries(searchOnly).find(([, given]) => given)?.[0];
28957
29008
  if (stray !== void 0) {
28958
29009
  console.error(`${stray} shapes a search \u2014 add --grep <text>.`);
28959
- process.exit(1);
29010
+ exitCli(1);
28960
29011
  }
28961
29012
  }
28962
29013
  if (flags.regex && flags.literal) {
28963
29014
  console.error("--regex and --literal read the pattern two ways \u2014 pass one.");
28964
- process.exit(1);
29015
+ exitCli(1);
28965
29016
  }
28966
29017
  const search = flags.grep === void 0 ? void 0 : {
28967
29018
  grep: flags.grep,
@@ -28987,7 +29038,7 @@ async function main(argv2) {
28987
29038
  const file2 = input2.slice(1);
28988
29039
  if (!fs17.existsSync(file2)) {
28989
29040
  console.error(`No such file: ${file2}`);
28990
- process.exit(1);
29041
+ exitCli(1);
28991
29042
  }
28992
29043
  input2 = fs17.readFileSync(file2, "utf-8");
28993
29044
  } else if (input2 === "-") {
@@ -28996,31 +29047,31 @@ async function main(argv2) {
28996
29047
  }
28997
29048
  if (input2.trim() === "") {
28998
29049
  console.error(REPORT_USAGE);
28999
- process.exit(1);
29050
+ exitCli(1);
29000
29051
  }
29001
29052
  const parsed2 = parseReport(input2, source);
29002
29053
  if ("error" in parsed2) {
29003
29054
  console.error(`${parsed2.error}
29004
29055
  `);
29005
29056
  console.error(REPORT_USAGE);
29006
- process.exit(1);
29057
+ exitCli(1);
29007
29058
  }
29008
29059
  const { ctx: reportCtx, refusal } = await resolveContextOrClaim(flags);
29009
29060
  if (refusal !== void 0) {
29010
29061
  console.error(refusal);
29011
29062
  echoReport(parsed2.report);
29012
- process.exit(1);
29063
+ exitCli(1);
29013
29064
  }
29014
29065
  if (!reportCtx) {
29015
29066
  console.error(
29016
29067
  'Not authenticated, so this could not be sent. Run "lotics auth signup", "lotics auth api-key <key>", or set LOTICS_API_KEY.'
29017
29068
  );
29018
29069
  echoReport(parsed2.report);
29019
- process.exit(1);
29070
+ exitCli(1);
29020
29071
  }
29021
29072
  noteScope({ org_id: reportCtx.orgId ?? void 0, workspace_id: reportCtx.workspaceId });
29022
29073
  await reportCommand(
29023
- new LoticsClient({ apiKey: reportCtx.apiKey, apiUrl: reportCtx.apiUrl, workspaceId: reportCtx.workspaceId }),
29074
+ new LoticsClient({ apiKey: reportCtx.apiKey, apiUrl: reportCtx.apiUrl, workspaceId: reportCtx.workspaceId, timeoutMs: flags.timeout }),
29024
29075
  {
29025
29076
  report: parsed2.report,
29026
29077
  version: VERSION,
@@ -29039,20 +29090,20 @@ async function main(argv2) {
29039
29090
  return;
29040
29091
  }
29041
29092
  if (subcommand === "api-key") {
29042
- await handleSetup(toolArgs ?? flags.apiKey, flags.local);
29093
+ await handleSetup(toolArgs ?? flags.apiKey, flags.local, flags.timeout);
29043
29094
  return;
29044
29095
  }
29045
29096
  if (subcommand === "whoami") {
29046
29097
  const { ctx: ctx2, refusal } = await resolveContextOrClaim(flags);
29047
29098
  if (refusal !== void 0) {
29048
29099
  console.error(refusal);
29049
- process.exit(1);
29100
+ exitCli(1);
29050
29101
  }
29051
29102
  if (!ctx2) {
29052
29103
  console.error('Not authenticated. Run "lotics auth signup", "lotics auth api-key <key>", or set LOTICS_API_KEY.');
29053
- process.exit(1);
29104
+ exitCli(1);
29054
29105
  }
29055
- const client2 = new LoticsClient({ apiKey: ctx2.apiKey, apiUrl: ctx2.apiUrl });
29106
+ const client2 = new LoticsClient({ apiKey: ctx2.apiKey, apiUrl: ctx2.apiUrl, timeoutMs: flags.timeout });
29056
29107
  const info = await client2.whoami();
29057
29108
  const existing = loadGlobalConfig() ?? {};
29058
29109
  if (info.email !== null) saveGlobalConfig({ ...existing, email: info.email });
@@ -29108,7 +29159,7 @@ async function main(argv2) {
29108
29159
  }
29109
29160
  if (!resolved) {
29110
29161
  console.error(toolArgs ? `No saved credential matches "${toolArgs}".` : "No active credential to remove. Pass an org name/id, or use --all.");
29111
- process.exit(1);
29162
+ exitCli(1);
29112
29163
  }
29113
29164
  const [orgId, profile] = resolved;
29114
29165
  await revokeCredential(orgId, profile);
@@ -29142,12 +29193,12 @@ async function main(argv2) {
29142
29193
  if (subcommand === "use") {
29143
29194
  if (!toolArgs) {
29144
29195
  console.error("Usage: lotics org use <name|id> [--local]");
29145
- process.exit(1);
29196
+ exitCli(1);
29146
29197
  }
29147
29198
  const resolved = resolveProfileByNameOrId(profiles, toolArgs);
29148
29199
  if (!resolved) {
29149
29200
  console.error(`No saved credential for "${toolArgs}". Run "lotics auth api-key <key>" while authenticated to that org, or "lotics org" to list.`);
29150
- process.exit(1);
29201
+ exitCli(1);
29151
29202
  }
29152
29203
  const [orgId, profile] = resolved;
29153
29204
  if (flags.local) {
@@ -29170,7 +29221,7 @@ async function main(argv2) {
29170
29221
  if (subcommand && subcommand !== "list") {
29171
29222
  console.error(`Unknown org subcommand: ${subcommand}`);
29172
29223
  console.error("Usage: lotics org [list | use <name|id> [--local]]");
29173
- process.exit(1);
29224
+ exitCli(1);
29174
29225
  }
29175
29226
  const orgIds = Object.keys(profiles);
29176
29227
  if (orgIds.length === 0) {
@@ -29207,20 +29258,20 @@ async function main(argv2) {
29207
29258
  console.error(
29208
29259
  `If Lotics genuinely cannot do this yet, say so \u2014 run \`lotics report\` for the frame.`
29209
29260
  );
29210
- process.exit(1);
29261
+ exitCli(1);
29211
29262
  }
29212
29263
  if (command === "app" && !subcommand) {
29213
29264
  console.error(`Usage:
29214
29265
  ${commandHelp(["app"])}`);
29215
29266
  console.error("Everything else about an app is a tool: lotics tools, then lotics run <tool>.");
29216
- process.exit(1);
29267
+ exitCli(1);
29217
29268
  }
29218
29269
  if (command === "run" && !subcommand) {
29219
29270
  console.error(
29220
29271
  "Usage: lotics run <tool> '<json_args>'\n lotics run <tool> @args.json (read args from a file \u2014 for large payloads)\n cat args.json | lotics run <tool> - (read args from stdin)"
29221
29272
  );
29222
29273
  console.error('Run "lotics tools" to see available tools.');
29223
- process.exit(1);
29274
+ exitCli(1);
29224
29275
  }
29225
29276
  if (command === "upload" && !subcommand && !flags.stdin && !flags.base64 && !flags.url) {
29226
29277
  console.error("Usage:");
@@ -29229,7 +29280,7 @@ ${commandHelp(["app"])}`);
29229
29280
  console.error(" lotics upload --base64 --as <name> Base64 on stdin");
29230
29281
  console.error(" lotics upload --url <url> [--as <name>]");
29231
29282
  console.error("Uploads files and returns their file_ids. Directories expand to their immediate files.");
29232
- process.exit(1);
29283
+ exitCli(1);
29233
29284
  }
29234
29285
  if (command === "download") {
29235
29286
  const args = resolveDownloadArgs({
@@ -29276,7 +29327,7 @@ ${commandHelp(["app"])}`);
29276
29327
  console.error(`Unknown file subcommand: ${subcommand}
29277
29328
  `);
29278
29329
  console.error(commandHelp(["file"]));
29279
- process.exit(1);
29330
+ exitCli(1);
29280
29331
  }
29281
29332
  const { client: client2, ctx: ctx2 } = await requireClient(flags);
29282
29333
  await resolveWorkspace(client2, ctx2);
@@ -29320,7 +29371,7 @@ ${commandHelp(["app"])}`);
29320
29371
  if (subcommand === "rename" && !settingsName) {
29321
29372
  console.error("Usage: lotics workspace rename <new name>");
29322
29373
  console.error('Renames the CURRENT workspace. Switch first with "lotics workspace select <id>".');
29323
- process.exit(1);
29374
+ exitCli(1);
29324
29375
  }
29325
29376
  if (subcommand === "settings" && settingsName === void 0 && flags.currency === void 0 && flags.timezone === void 0) {
29326
29377
  console.error(
@@ -29330,7 +29381,7 @@ ${commandHelp(["app"])}`);
29330
29381
  "Changes the CURRENT workspace. The currency decides how every money field renders and the"
29331
29382
  );
29332
29383
  console.error("zone decides how every date buckets; neither is visible once it is wrong.");
29333
- process.exit(1);
29384
+ exitCli(1);
29334
29385
  }
29335
29386
  const workspaces = await client.listWorkspaces();
29336
29387
  const currentWorkspaceId = ctx.workspaceId;
@@ -29338,7 +29389,7 @@ ${commandHelp(["app"])}`);
29338
29389
  const targetId = toolArgs;
29339
29390
  if (!targetId) {
29340
29391
  console.error("Usage: lotics workspace select <workspace_id>");
29341
- process.exit(1);
29392
+ exitCli(1);
29342
29393
  }
29343
29394
  const target = workspaces.find((ws) => ws.id === targetId);
29344
29395
  if (!target) {
@@ -29346,7 +29397,7 @@ ${commandHelp(["app"])}`);
29346
29397
 
29347
29398
  Available workspaces:`);
29348
29399
  printWorkspaceList(workspaces, currentWorkspaceId);
29349
- process.exit(1);
29400
+ exitCli(1);
29350
29401
  }
29351
29402
  sayWorkspaceSwitch(target, setSelectedWorkspace(target.id, ctx.orgId, target.name));
29352
29403
  return;
@@ -29355,7 +29406,7 @@ Available workspaces:`);
29355
29406
  const current2 = workspaces.find((ws) => ws.id === currentWorkspaceId);
29356
29407
  if (!current2) {
29357
29408
  console.error('No workspace selected. Choose one with "lotics workspace select <id>".');
29358
- process.exit(1);
29409
+ exitCli(1);
29359
29410
  }
29360
29411
  const updated = await client.updateWorkspace({
29361
29412
  name: settingsName ?? current2.name,
@@ -29376,7 +29427,7 @@ Available workspaces:`);
29376
29427
  const name = toolArgs;
29377
29428
  if (!name) {
29378
29429
  console.error("Usage: lotics workspace create <name> [--timezone <tz>] [--currency <ISO>]");
29379
- process.exit(1);
29430
+ exitCli(1);
29380
29431
  }
29381
29432
  const timezone = flags.timezone;
29382
29433
  const created = await client.createWorkspace({
@@ -29400,7 +29451,7 @@ Available workspaces:`);
29400
29451
  const targetId = toolArgs;
29401
29452
  if (!targetId) {
29402
29453
  console.error("Usage: lotics workspace delete <workspace_id> --yes");
29403
- process.exit(1);
29454
+ exitCli(1);
29404
29455
  }
29405
29456
  const target = workspaces.find((ws) => ws.id === targetId);
29406
29457
  if (!target) {
@@ -29408,12 +29459,12 @@ Available workspaces:`);
29408
29459
 
29409
29460
  Available workspaces:`);
29410
29461
  printWorkspaceList(workspaces, currentWorkspaceId);
29411
- process.exit(1);
29462
+ exitCli(1);
29412
29463
  }
29413
29464
  if (!flags.yes) {
29414
29465
  console.error(`This deletes workspace "${target.name}" (${target.id}) \u2014 every table, app, record, and template inside it becomes inaccessible (soft delete: retained and recoverable by an admin).`);
29415
29466
  console.error(`Re-run with --yes to confirm: lotics workspace delete ${target.id} --yes`);
29416
- process.exit(1);
29467
+ exitCli(1);
29417
29468
  }
29418
29469
  const deleted = await client.deleteWorkspace(target.id);
29419
29470
  if (flags.json) {
@@ -29429,7 +29480,7 @@ Available workspaces:`);
29429
29480
  if (subcommand && subcommand !== "list") {
29430
29481
  console.error(`Unknown workspace subcommand: ${subcommand}`);
29431
29482
  console.error("Usage: lotics workspace [list | select <id> | create <name> | delete <id> --yes]");
29432
- process.exit(1);
29483
+ exitCli(1);
29433
29484
  }
29434
29485
  const current = workspaces.find((ws) => ws.id === currentWorkspaceId);
29435
29486
  if (current !== void 0) cacheWorkspaceName(current.id, ctx.orgId, current.name);
@@ -29462,15 +29513,13 @@ Available workspaces:`);
29462
29513
  console.error(" A custom-code app: registered here and linked to [path] (default ./<name>)");
29463
29514
  console.error(" by package.json#lotics; the project there is yours. An app the runtime");
29464
29515
  console.error(" draws from a JSON body is made by `lotics app apply <file>`.");
29465
- process.exit(1);
29516
+ exitCli(1);
29466
29517
  }
29467
- if (flags.json) setMachineOutput(true);
29468
29518
  const created = await appCreate(client, { name, ...restArgs[0] === void 0 ? {} : { targetPath: restArgs[0] } });
29469
29519
  if (flags.json) emitJson({ workspace_id: ctx.workspaceId, ...created });
29470
29520
  return;
29471
29521
  }
29472
29522
  if (subcommand === "pull") {
29473
- if (flags.json) setMachineOutput(true);
29474
29523
  const pulled = await appPull(client, {
29475
29524
  force: flags.force,
29476
29525
  ...toolArgs === void 0 ? {} : { appId: toolArgs },
@@ -29489,23 +29538,21 @@ Available workspaces:`);
29489
29538
  console.error(" app has moved past the version the file was pulled at.");
29490
29539
  console.error(" --check sends dry_run and writes nothing. To go back, apply the earlier body");
29491
29540
  console.error(" again. Pull a body (the tool get_app): lotics app pull <app_id> [path]");
29492
- process.exit(1);
29541
+ exitCli(1);
29493
29542
  }
29494
- if (flags.json) setMachineOutput(true);
29495
29543
  const applied = await applyAppBody(client, { file: toolArgs, appId: flags.app, check: flags.check });
29496
29544
  if (flags.json) emitJson({ workspace_id: ctx.workspaceId, ...applied });
29497
29545
  return;
29498
29546
  }
29499
29547
  if (subcommand === "deploy") {
29500
29548
  const message = (flags.message ?? toolArgs)?.trim();
29501
- if (flags.json) setMachineOutput(true);
29502
29549
  const deployed = await appDeploy(client, message ? { message } : {});
29503
29550
  if (flags.json) emitJson(deployed);
29504
29551
  return;
29505
29552
  }
29506
29553
  console.error(`Unknown app subcommand: ${subcommand}`);
29507
29554
  console.error("Run 'lotics app' for usage.");
29508
- process.exit(1);
29555
+ exitCli(1);
29509
29556
  }
29510
29557
  if (command === "tools") {
29511
29558
  if (subcommand) {
@@ -29548,19 +29595,19 @@ ${JSON.stringify(info.input_schema, null, 2)}${output2}`);
29548
29595
  const sources = [flags.stdin && "--stdin", flags.base64 && "--base64", flags.url && "--url"].filter(Boolean);
29549
29596
  if (sources.length > 1) {
29550
29597
  console.error(`Pick one source: ${sources.join(", ")} were all given.`);
29551
- process.exit(1);
29598
+ exitCli(1);
29552
29599
  }
29553
29600
  let upload;
29554
29601
  if (sources.length === 1) {
29555
29602
  const positional = [subcommand, toolArgs, ...restArgs].filter((v) => v !== void 0);
29556
29603
  if (positional.length > 0) {
29557
29604
  console.error(`${sources[0]} reads the bytes itself \u2014 drop the path argument (${positional.join(", ")}).`);
29558
- process.exit(1);
29605
+ exitCli(1);
29559
29606
  }
29560
29607
  const resolved = await resolveUploadSource(String(sources[0]), flags);
29561
29608
  if ("error" in resolved) {
29562
29609
  console.error(resolved.error);
29563
- process.exit(1);
29610
+ exitCli(1);
29564
29611
  }
29565
29612
  upload = await client.uploadFileBytes([resolved]);
29566
29613
  } else {
@@ -29568,11 +29615,11 @@ ${JSON.stringify(info.input_schema, null, 2)}${output2}`);
29568
29615
  const filePaths = resolveUploadPaths(rawPaths);
29569
29616
  if (filePaths.length === 0) {
29570
29617
  console.error("No files found in the specified paths.");
29571
- process.exit(1);
29618
+ exitCli(1);
29572
29619
  }
29573
29620
  if (flags.as && filePaths.length > 1) {
29574
29621
  console.error("Cannot use --as with multiple files.");
29575
- process.exit(1);
29622
+ exitCli(1);
29576
29623
  }
29577
29624
  upload = await client.uploadFiles(filePaths, {
29578
29625
  filenames: flags.as ? [flags.as] : void 0
@@ -29580,7 +29627,7 @@ ${JSON.stringify(info.input_schema, null, 2)}${output2}`);
29580
29627
  }
29581
29628
  if (upload.files.length === 0 && upload.errors.length > 0) {
29582
29629
  console.error(`Upload failed: ${upload.errors.map((e) => `${e.filename}: ${e.error}`).join(", ")}`);
29583
- process.exit(1);
29630
+ exitCli(1);
29584
29631
  }
29585
29632
  if (flags.json) {
29586
29633
  console.log(JSON.stringify({ files: upload.files, errors: upload.errors }, null, 2));
@@ -29604,21 +29651,20 @@ ${JSON.stringify(info.input_schema, null, 2)}${output2}`);
29604
29651
  });
29605
29652
  if (ingested.kind === "error") {
29606
29653
  console.error(ingested.message);
29607
- process.exit(1);
29654
+ exitCli(1);
29608
29655
  }
29609
29656
  const args = ingested.args;
29610
29657
  noteToolArgs(args);
29611
- const timeoutMs = flags.timeout ?? (toolName === "screenshot_app" ? screenshotTimeoutMs(MAX_SCREENSHOT_WIDTHS) : 6e4);
29612
- const result = await client.execute(toolName, args, { format: "text", timeoutMs });
29658
+ const result = await client.execute(toolName, args, { format: "text" });
29613
29659
  if (result.error) {
29614
29660
  const recorded = result.message_source === "system" ? result.error : result.error_code ?? "unmarked tool error";
29615
29661
  if (flags.json) {
29616
- console.log(JSON.stringify({ error: result.error }, null, 2));
29662
+ emitJson({ error: result.error });
29617
29663
  } else {
29618
29664
  narrate(result.error);
29619
29665
  }
29620
29666
  recordFailure(recorded);
29621
- process.exit(1);
29667
+ exitCli(1);
29622
29668
  }
29623
29669
  if (flags.json) {
29624
29670
  console.log(JSON.stringify(result.result, null, 2));
@@ -29628,7 +29674,7 @@ ${JSON.stringify(info.input_schema, null, 2)}${output2}`);
29628
29674
  console.log(JSON.stringify(result.result, null, 2));
29629
29675
  }
29630
29676
  if (flags.output !== void 0) {
29631
- const saved = await saveSignedLinks(signedLinks(result.result), flags.output);
29677
+ const saved = await saveSignedLinks(signedLinks(result.result), flags.output, flags.timeout);
29632
29678
  for (const file2 of saved) (flags.json ? console.error : console.log)(file2);
29633
29679
  if (saved.length === 0) console.error("(this result carries no signed link to save; a workspace file is saved by lotics download <file_id>)");
29634
29680
  }
@@ -29648,21 +29694,31 @@ ${JSON.stringify(info.input_schema, null, 2)}${output2}`);
29648
29694
  }
29649
29695
  if (resultReportsFailure(toolName, result.result)) {
29650
29696
  console.error(`${toolName} \u2192 ${resultSummary(result.result) ?? "failed"}`);
29651
- process.exit(1);
29697
+ exitCli(1);
29652
29698
  }
29653
- if (cleanupFailed) process.exit(1);
29699
+ if (cleanupFailed) exitCli(1);
29654
29700
  return;
29655
29701
  }
29656
29702
  }
29703
+ function machineError(error62, text) {
29704
+ const error_code = error62 instanceof OutcomeUnknownError ? error62.error_code : error62 instanceof LoticsRequestError && typeof error62.body.error_code === "string" ? error62.body.error_code : void 0;
29705
+ const request_id = error62 instanceof OutcomeUnknownError || error62 instanceof NoAnswerError ? error62.request_id : void 0;
29706
+ return { error: text, ...error_code === void 0 ? {} : { error_code }, ...request_id === void 0 ? {} : { request_id } };
29707
+ }
29657
29708
  function exitOnError(error62) {
29658
29709
  flushPendingWarnings();
29659
- if (error62 instanceof Error && isCustomerWorded(error62)) {
29660
- narrate(describeCliError(error62));
29661
- recordFailure(error62.telemetryMessage);
29710
+ const text = describeCliError(error62);
29711
+ const recorded = error62 instanceof OutcomeUnknownError ? error62.error_code : error62 instanceof Error && isCustomerWorded(error62) ? error62.telemetryMessage : void 0;
29712
+ if (isMachineOutput()) {
29713
+ emitJson(machineError(error62, text));
29714
+ recordFailure(recorded ?? text);
29715
+ } else if (recorded !== void 0) {
29716
+ narrate(text);
29717
+ recordFailure(recorded);
29662
29718
  } else {
29663
- console.error(describeCliError(error62));
29719
+ console.error(text);
29664
29720
  }
29665
- process.exit(1);
29721
+ exitCli(1);
29666
29722
  }
29667
29723
 
29668
29724
  // src/cli.ts