@lotics/cli 0.318.32 → 0.318.34
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 +247 -264
- package/dist/src/client.d.ts +4 -2
- package/docs/agent_surface.md +6 -7
- package/docs/app_architecture.md +2 -2
- package/docs/app_bindings.md +1 -1
- package/docs/building_an_app.md +1 -1
- package/docs/data_model.md +1 -1
- package/docs/design.md +194 -28
- package/docs/examples.md +39 -33
- package/docs/filters.md +3 -3
- package/docs/first_build.md +10 -20
- package/docs/getting_started.md +2 -2
- package/docs/workflow_steps.md +3 -76
- package/docs/workflows.md +137 -128
- package/package.json +1 -1
package/dist/src/client.d.ts
CHANGED
|
@@ -442,8 +442,10 @@ export declare class LoticsClient {
|
|
|
442
442
|
version_id: string;
|
|
443
443
|
version_number: number;
|
|
444
444
|
bundle_size_bytes: number;
|
|
445
|
-
/**
|
|
446
|
-
|
|
445
|
+
/** Where a signed-in person opens this version; composing it here would re-derive what the server owns. */
|
|
446
|
+
url?: string;
|
|
447
|
+
/** Where anyone opens it, while the app is shared publicly. */
|
|
448
|
+
public_url?: string;
|
|
447
449
|
}>;
|
|
448
450
|
downloadFile(url: string, outputPath: string): Promise<string>;
|
|
449
451
|
/**
|
package/docs/agent_surface.md
CHANGED
|
@@ -31,9 +31,9 @@ app has.
|
|
|
31
31
|
|
|
32
32
|
| Called | What it says of itself | Takes | Generated for |
|
|
33
33
|
|---|---|---|---|
|
|
34
|
-
| `<entity>_list` | Every row of <entity> the reader may see. | `search`?; `<scope entity>_id` where the app states `scope`; `<filter>_is`? per List `filters` field holding one value — a select, a one-row link, a member, a yes/no; `<filter>_from`? / `<filter>_to`? per date filter — none for a date holding a span; `<filter>_min`? / `<filter>_max`? per number filter — none over sources, none for a looked-up link or member, none for a number read in each row's own unit or currency | every entity the app draws; the filter params on the app's own entity alone |
|
|
35
|
-
| `<entity>_list_<tab>` | The <entity> rows of the tab "<tab>". | the list's; `from`? / `to`? on a tab dated `in` a period; `to` on a tab of rows `open` on a day | each Tab of the register; none over sources, none for a Tab whose period reads a date holding a span |
|
|
36
|
-
| `<entity>_totals_<tab>` | The <child> rows added per <entity> row, by "<link>", over the period from `from` to `to`, dated by "<date>": . | `from`; `to` | each Tab of the register stating `totals
|
|
34
|
+
| `<entity>_list` | Every row of <entity> the reader may see. | `search`?; `<scope entity>_id` where the app states `scope`; `<filter>_is`? per List `filters` field holding one value — a select, a one-row link, a member, a yes/no; `<filter>_from`? / `<filter>_to`? per date filter — none for a date holding a span; `<filter>_min`? / `<filter>_max`? per number filter — none over sources, none for a looked-up link or member, none for a number read in each row's own unit or currency | every entity the app draws; the filter params on the app's own entity alone; a root List after the first over an entity, whose chips differ from the first's, adds one of its own, called by its key |
|
|
35
|
+
| `<entity>_list_<tab>` | The <entity> rows of the tab "<tab>". | the list's; `from`? / `to`? on a tab dated `in` a period; `to` on a tab of rows `open` on a day | each Tab of the register, and of each later root List over an entity, called by its key; none over sources, none for a Tab whose period reads a date holding a span |
|
|
36
|
+
| `<entity>_totals_<tab>` | The <child> rows added per <entity> row, by "<link>", over the period from `from` to `to`, dated by "<date>": . | `from`; `to` | each Tab of the register stating `totals`, and of each later root List over an entity, called by its key |
|
|
37
37
|
| `<entity>_record` | One row of <entity> by its id. | `<entity>_id` | every entity the app draws |
|
|
38
38
|
| `<child>_by_<link>` | The <child> rows under one <entity>, through "<link>". | `<entity>_id` | each List of child rows on the record; one narrowed by `where` or ordered by `sort` adds `_<field>_<option>` and `_sorted_<field>` to its name |
|
|
39
39
|
| `outside_<key>_one` | One row of <entity> by its id. | `record` | each Outside: the record a link opens, projected to the fields the Outside states |
|
|
@@ -78,7 +78,6 @@ the screen already holds.
|
|
|
78
78
|
| `<entity>_pictures` | The picture and name of each <entity> row among the ids handed in. | `<entity>_ids` | a link to several pictured rows |
|
|
79
79
|
| `<entity>_count_by_<scope>` | How many <entity> rows each <scope entity> holds. | | an app stating `scope` |
|
|
80
80
|
| `<task>_progress_by_<link>` | How many <task> rows each <entity> row handed in holds, at each status. | `<entity>_ids` | rows whose task rows are counted done |
|
|
81
|
-
| `<rows>_measured_by_<link>` | The share of each <entity> row handed in its <rows> rows add, day by day. | `<entity>_ids` | a Reading stating `planned`, `done` and `measured` |
|
|
82
81
|
| `<entity>_sub_counts_by_<link>` | How many <entity> rows stand under each <entity> row handed in, through <link>, at each status. | `<entity>_ids` | a record's rows block over a hierarchy (`nests`), for the rows it draws |
|
|
83
82
|
| `<entity>_plan_places` | Every <place> the <entity> rows stand at, with what the plan draws of each. | | a register laid out as a `plan`: the places its rows stand at |
|
|
84
83
|
| `<lane>_lanes` | The <lane> rows of one <scope entity>, each a lane of the board. | `<scope entity>_id` | a lanes board inside an app stating `scope` |
|
|
@@ -117,7 +116,7 @@ run_app_query {"app_id":"app_…","alias":"order_list","params":{"status_is":"op
|
|
|
117
116
|
| `fields` | The output columns to return, in place of all of them; each row then holds them and the id of the record it is |
|
|
118
117
|
| `sort` | An order in place of the query's own: `[{ "field_key": "<column>", "order": "asc" }]`, `asc` or `desc`, each `field_key` an output column's name |
|
|
119
118
|
| `count` | `true`: `total`, the number of rows, in place of the rows; with `count_by`, `counts` per value of one column, keyed by an option's label, a member's name or a linked row's display; with `count_where` — a map of name → filter, never beside `count_by` — `counts` per name. Never with `fields`, `sort`, `limit` or `cursor` |
|
|
120
|
-
| `aggregate` | Groups of the result in place of its rows, one row per group: `by` (up to 3 columns), `bands` (a number column of `by` grouped by its breakpoints), or `day` (a date column, answered as `__day`),
|
|
119
|
+
| `aggregate` | Groups of the result in place of its rows, one row per group: `by` (up to 3 columns), `bands` (a number column of `by` grouped by its breakpoints), or `day` (a date column, answered as `__day`), `sum` (a number column, answered as `__sum`) and `avg` (a number column averaged over the group's rows that hold one, answered as `__avg`), each group with its `__count`. Sent with `params` and `filters` alone. Buckets are by day only: a period's total is one call per period, with `from` and `to` or a date filter |
|
|
121
120
|
| `limit`, `cursor` | A page — 200 rows at most, 50 where no `limit` is stated — and the `next_cursor` of the page before it; `truncated` says more rows matched than `rows` holds |
|
|
122
121
|
| `runs` | Several reads in one call, 20 at most, each with its own `alias` and arguments, answered in order under `runs`. Never beside an `alias` of the call's own |
|
|
123
122
|
|
|
@@ -286,8 +285,8 @@ Acts: every figure or list whose definition is the business's own (open orders,
|
|
|
286
285
|
It reads under the app's `rows` (every row, where the app states none of the table) and, on the app's own table, exactly the rows its list reads —
|
|
287
286
|
so never the table of an app whose List reads `sources`, several tables. A condition reading an
|
|
288
287
|
optional param narrows nothing when the call leaves it out; no param compares a number read in each row's
|
|
289
|
-
own unit or currency, or a date holding a span.
|
|
290
|
-
|
|
288
|
+
own unit or currency, or a date holding a span. A Query returns its `fields`; a caller counts, sums or
|
|
289
|
+
averages them with `run_app_query`'s `aggregate`. A Query, a Workflow and
|
|
291
290
|
a Reading's `key` take no name the app generates (`reference/app.generated-name`).
|
|
292
291
|
|
|
293
292
|
**A workflow** — a write no Act of the record makes, typed in the app's tree and its code set on the app:
|
package/docs/app_architecture.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# App architecture — a worked split
|
|
2
2
|
|
|
3
|
-
The rule that splits a business into apps is in `first_build`, § 3: one app per main entity, and everything that belongs to a row on that row's page. This is one split it produces, settled before any tree is written
|
|
3
|
+
The rule that splits a business into apps is in `first_build`, § 3: one app per main entity, and everything that belongs to a row on that row's page. This is one split it produces, settled before any tree is written.
|
|
4
4
|
|
|
5
5
|
One bakery's wholesale arm, five people, seven apps:
|
|
6
6
|
|
|
@@ -38,4 +38,4 @@ record, one page. The owner reads the figures each register leads with. Each app
|
|
|
38
38
|
}
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
Then `set_access` gives each
|
|
41
|
+
Then `set_access` gives each app to all who work its rows (`first_build`, § 3). How each tree is composed is `design`.
|
package/docs/app_bindings.md
CHANGED
|
@@ -120,7 +120,7 @@ name → `{ type, required?, description?, …per type }`. An entry is required
|
|
|
120
120
|
| `array` | `items` — one entry |
|
|
121
121
|
|
|
122
122
|
Nesting stops at depth 8. A `field`-form select tracks the field's options as they change; an
|
|
123
|
-
inline `options` set is a fixed list.
|
|
123
|
+
inline `options` set is a fixed list. A query's select param takes an option by alias, label or key, each condition reading it by its own field's options, and a value that is none of them is refused naming the options.
|
|
124
124
|
|
|
125
125
|
## Outputs
|
|
126
126
|
|
package/docs/building_an_app.md
CHANGED
|
@@ -154,7 +154,7 @@ people differ; a table with none is read whole by everyone the app is shared wit
|
|
|
154
154
|
| Team leads see people, not salaries | an app that draws no salary field — what it does not show, no one reads through it |
|
|
155
155
|
|
|
156
156
|
A child read under a ruled row states its own rule, through its link to the parent; only a status history inherits.
|
|
157
|
-
|
|
157
|
+
An 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
|
|
158
158
|
choose. An app never reads past its owner's own access. A table's own `read_scope` governs opening the table directly.
|
|
159
159
|
Working inside one row of a folder (`scope`) narrows the view, not who may read: a branch app shared with every manager
|
|
160
160
|
still states the branch rule.
|
package/docs/data_model.md
CHANGED
|
@@ -55,7 +55,7 @@ express rather than quietly picking the nearest value.
|
|
|
55
55
|
|
|
56
56
|
A 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
|
|
57
57
|
a body and read as its key, a member or a link by its id. A value a check matches
|
|
58
|
-
across tables is a link to one table: two selects never compare, and a save that compares them is refused.
|
|
58
|
+
across 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.
|
|
59
59
|
|
|
60
60
|
A 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.
|
|
61
61
|
|
package/docs/design.md
CHANGED
|
@@ -5,8 +5,7 @@ tree states COMPOSITION — which fields, lists and acts each job's screen holds
|
|
|
5
5
|
one way per concept. A node the tree leaves out draws its default, from the table's facts (`records`, the stage, the
|
|
6
6
|
write rules): a List's Readings band, the stage buttons, the picture, a Record's Sections. State a node to change it,
|
|
7
7
|
or `false` at it to turn it off (`"readings": false`, a Record's `"row": { "image": false }`). A drawn Field is a control unless it
|
|
8
|
-
or its entity is read-only (`edit: false`); a stepped status never is, since Acts move it.
|
|
9
|
-
worked in a whole workspace is `examples/<treatment>`, and which apps a business needs is `first_build`, § 3.
|
|
8
|
+
or its entity is read-only (`edit: false`); a stepped status never is, since Acts move it. Which apps a business needs is `first_build`, § 3.
|
|
10
9
|
|
|
11
10
|
**The visual bar.** Every screen is judged against it; a miss is a change to the tree.
|
|
12
11
|
|
|
@@ -16,8 +15,9 @@ worked in a whole workspace is `examples/<treatment>`, and which apps a business
|
|
|
16
15
|
- What needs attention leads the row: `records.mark` on a select or a computed category (a formula stating its options;
|
|
17
16
|
where it is empty, its seat is blank). A yes that needs attention (papers still owed) is a `Check` of its List over a
|
|
18
17
|
yes/no formula, in the warning tone on the row's line; every other yes reads in the success tone.
|
|
19
|
-
- A list's columns: the name and its lead, the status, then the
|
|
20
|
-
fact once:
|
|
18
|
+
- A list's columns: the name and its lead, the status, then the columns the job reads on every row, as many as fit a desk. Each
|
|
19
|
+
fact once: a column the row draws itself stands once. A generated number (`autonumber`) as the title yields
|
|
20
|
+
the row's name to the subtitle's first part and stands first on its line.
|
|
21
21
|
- A list worked by a date states `sort` on that date's column, newest first; without one, a register reads newest made
|
|
22
22
|
first and a record's child List in the order its rows were added.
|
|
23
23
|
- Someone is a face wherever they are read: a link to a table stating `records.party` draws its row's face; a member
|
|
@@ -30,13 +30,172 @@ worked in a whole workspace is `examples/<treatment>`, and which apps a business
|
|
|
30
30
|
means something.
|
|
31
31
|
- Every app states its tile's `color`, apart from the workspace's other apps where it can be.
|
|
32
32
|
- The paperwork is the proof of the work: a files field per purpose (what arrived, what was issued to the customer, the
|
|
33
|
-
carrier, the authority) in the Section where that work happens,
|
|
33
|
+
carrier, the authority) in the Section where that work happens, and the source of a
|
|
34
34
|
figure (a screenshot, an email, a sheet) on its row. Every files field is drawn somewhere.
|
|
35
35
|
|
|
36
36
|
**Each shot answers:** can the person find their row? Is what needs doing first, on the row's lead? Is anything
|
|
37
37
|
repeated or empty? Is anyone shown without their face? Is every paper visible? Across the workspace: can each app be
|
|
38
38
|
told apart by its own screen, and does any app hold a second entity behind tabs? A failed answer is a change to the tree.
|
|
39
39
|
|
|
40
|
+
<!-- generated:start words -->
|
|
41
|
+
|
|
42
|
+
**The words most builds state.** A node's page holds its rules and every other word: `reference/list-node`, `reference/records`, `reference/field`.
|
|
43
|
+
|
|
44
|
+
**Table**
|
|
45
|
+
|
|
46
|
+
- `ref` (alias): A created table's handle in this call
|
|
47
|
+
- `label` (text, required): The table's name in the workspace
|
|
48
|
+
- `singular` (text): One row of this table, in the business's own words
|
|
49
|
+
- `title` (alias): The alias of the field that names a row wherever a link or a record shows one
|
|
50
|
+
- `fields` (map of alias → Field, required): The table's columns, each under its alias, which is its key here and so is never stated inside it
|
|
51
|
+
- `records` (any value): How a row is recognised
|
|
52
|
+
- `checks` (map of alias → table check (`workflows/table-checks`)): The conditions a write of the table's rows may not meet, each under its alias
|
|
53
|
+
- `unique` (list (at least one) of list of alias (at least one)): Sets of fields whose values no two live rows share
|
|
54
|
+
|
|
55
|
+
**Any field**
|
|
56
|
+
|
|
57
|
+
- `label` (text, required): The field's name in the workspace
|
|
58
|
+
- `required` (boolean): Refuse a record whose cell for this field is empty
|
|
59
|
+
- `default_from` (text): Copied when a record is made off the row a one-row link of this entity names
|
|
60
|
+
|
|
61
|
+
**`number` field**
|
|
62
|
+
|
|
63
|
+
- `notation` (notation): How the figure reads
|
|
64
|
+
- `min` (number | text): Refuse a create or update whose value is below this
|
|
65
|
+
|
|
66
|
+
**`select` field**
|
|
67
|
+
|
|
68
|
+
- `options` (list of Select option (at least one), required): The choices, in the order every picker and every ladder lists them
|
|
69
|
+
- `multi` (boolean): Allow multiple selections
|
|
70
|
+
|
|
71
|
+
**`link` field**
|
|
72
|
+
|
|
73
|
+
- `table` (text, required): The table the link points at
|
|
74
|
+
- `multi` (boolean, required): Whether a row links to one row or many
|
|
75
|
+
- `pair` (`true` | alias): Makes the link two-way
|
|
76
|
+
|
|
77
|
+
**`formula` field**
|
|
78
|
+
|
|
79
|
+
- `expression` (text, required): The expression, over fields of THIS entity by alias in braces
|
|
80
|
+
- `output_type` (`"number"` | `"text"` | `"date"` | `"datetime"` | `"boolean"` | `"select"`): Holds a formula to the type its readers need
|
|
81
|
+
|
|
82
|
+
**`rollup` field**
|
|
83
|
+
|
|
84
|
+
- `via` (alias, required): The alias of a link of this table to roll up from
|
|
85
|
+
- `op` (operation, required): The operation over the linked rows
|
|
86
|
+
- `field` (alias): The alias of the field on the linked table the operation reads
|
|
87
|
+
|
|
88
|
+
**`lookup` field**
|
|
89
|
+
|
|
90
|
+
- `via` (alias, required): The alias of a link of this table to look up through
|
|
91
|
+
- `field` (alias, required): The alias of the field on the linked table to show
|
|
92
|
+
|
|
93
|
+
**`autonumber` field**
|
|
94
|
+
|
|
95
|
+
- `prefix` (text): Literal prefix prepended to every display value (e.g. 'KH-' → 'KH-001')
|
|
96
|
+
|
|
97
|
+
**`records`**
|
|
98
|
+
|
|
99
|
+
- `subtitle` (list of alias (1–2)): Up to two fields read under the title wherever a row is drawn (a code, a date, a party)
|
|
100
|
+
- `figure` (alias): The one number the row stands for, read at its right (a total, a quantity left)
|
|
101
|
+
- `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
|
|
102
|
+
- `due` (list of alias (at least one)): Dates that are deadlines (stored, or computed as a date)
|
|
103
|
+
- `image` (alias): A files field that pictures the row
|
|
104
|
+
- `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)
|
|
105
|
+
- `limits` (map of alias → (alias | number)): A number read against a bound
|
|
106
|
+
- `starts` (map of alias → `"today"` | `"me"`): What a field of a row being added starts at, where that start is certain
|
|
107
|
+
- `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
|
|
108
|
+
- `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
|
|
109
|
+
|
|
110
|
+
**`records.status`**
|
|
111
|
+
|
|
112
|
+
- `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`
|
|
113
|
+
- `closed` (list of alias (at least one)): Options that end the work
|
|
114
|
+
- `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)
|
|
115
|
+
- `dates` (map of alias → alias): Option alias → 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
|
|
116
|
+
- `stages` (map of alias → Stage): Option alias → who owns that stage and how long it should take
|
|
117
|
+
|
|
118
|
+
**App**
|
|
119
|
+
|
|
120
|
+
- `key` (alias, required): The app's alias, its name among apps
|
|
121
|
+
- `name` (text, required): The job, in the words of the people who do it
|
|
122
|
+
- `children` (list of (List | Sheet | Query | Workflow) (at least one)): The App's Views in order
|
|
123
|
+
- `color` (colour): The launcher tile's colour
|
|
124
|
+
- `pages` (list of Record (at least one)): The page the rows of an entity open, one per entity, each a Record stating its `entity`
|
|
125
|
+
|
|
126
|
+
**List**
|
|
127
|
+
|
|
128
|
+
- `entity` (alias, required): The table whose rows the List draws
|
|
129
|
+
- `create` (boolean | list of alias (at least one)): The fields an add asks
|
|
130
|
+
- `columns` (list of (alias | Edit column)): Fields read after the row's title
|
|
131
|
+
- `label` (text): The register's name in the app's lists and tab strip
|
|
132
|
+
- `filters` (list of (alias | Tiered filter) (at most 3)): Fields the reader narrows by every day, beside the stage chips
|
|
133
|
+
- `children` (list of (Tab | Reading | Export | Act | List) (at least one)): Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view
|
|
134
|
+
- `key` (alias): Names the List among its siblings and in a Query's `list`
|
|
135
|
+
- `sort` (Sort key | list of Sort key (at least one)): The rows' order
|
|
136
|
+
- `layout` (layout): A word, or an object stating one layout with its data
|
|
137
|
+
- `remove` (boolean): Rows offer a Delete
|
|
138
|
+
- `search` (list of alias (at least one)): Fields the search box reads
|
|
139
|
+
- `where` (narrowing): A fixed narrowing on the server, for every reader
|
|
140
|
+
- `group` (alias): A field the rows stand grouped by
|
|
141
|
+
- `expect` (alias | Expect): What a record should hold, shown before it does
|
|
142
|
+
- `opens` (narrowing): The view the register opens on, a chip the reader may take away
|
|
143
|
+
|
|
144
|
+
**Record**
|
|
145
|
+
|
|
146
|
+
- `entity` (alias, required): The table whose rows open on this page
|
|
147
|
+
- `children` (list of (alias | Field | Fieldset | Section | Side | Outside | List | Reading | Statement | Act | Check) (at least one)): Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly
|
|
148
|
+
- `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
|
|
149
|
+
- `row` (Record row): How the App reads this entity's rows wherever it lists them
|
|
150
|
+
- `door` (`"page"` | `"drawer"`): How a row opens, on a page or in a drawer
|
|
151
|
+
|
|
152
|
+
**Section**
|
|
153
|
+
|
|
154
|
+
- `title` (text, required): The part's heading
|
|
155
|
+
- `key` (alias): Unique among its siblings
|
|
156
|
+
- `children` (list of (alias | Field | Fieldset | List | Reading | Statement | Act) (at least one)): What the part draws, in reading order
|
|
157
|
+
- `at` (list of alias (at least one)): Options of the record's status during which this part is the work now
|
|
158
|
+
- `when` (condition): Drawn only while this holds
|
|
159
|
+
|
|
160
|
+
**Field**
|
|
161
|
+
|
|
162
|
+
- `field` (alias, required): The field's alias
|
|
163
|
+
- `edit` (boolean): Shows a value nobody changes here
|
|
164
|
+
- `label` (text): The heading of the field's gallery or prose block, where it draws as one
|
|
165
|
+
- `block` (boolean): Gives a field room of its own
|
|
166
|
+
|
|
167
|
+
**Act**
|
|
168
|
+
|
|
169
|
+
- `key` (alias, required): The act's name
|
|
170
|
+
- `label` (text, required): The verb, as the reader says it
|
|
171
|
+
- `when` (condition): The act works only while this holds
|
|
172
|
+
- `set` (map of alias → value): What the act writes
|
|
173
|
+
- `asks` (list of (alias | `{ "field": alias, "starts": "today" | "me" }` | Asked input) (at least one)): What the reader states on pressing
|
|
174
|
+
- `confirm` (`true` | text): The press asks first
|
|
175
|
+
- `requires` (list of alias (at least one)): Fields filled first, each drawn where the act stands
|
|
176
|
+
- `template` (alias): A document template it makes a file from
|
|
177
|
+
- `into` (alias): The record's files field keeping the document
|
|
178
|
+
- `owner` (`"field"` | `"link.field"` | `{ "group": id }`): Who presses it
|
|
179
|
+
- `workflow` (alias): The workflow it runs for what `set` cannot say
|
|
180
|
+
- `danger` (`true`): The act destroys or cannot be undone
|
|
181
|
+
|
|
182
|
+
**Check**
|
|
183
|
+
|
|
184
|
+
- `field` (alias, required): A yes/no or text formula of the page's entity
|
|
185
|
+
- `on` (`"all"` | list of (`"update"` | alias) (at least one)): What the standing check refuses
|
|
186
|
+
- `resolve` (alias): An Act on one row of this entity that clears it
|
|
187
|
+
|
|
188
|
+
**Reading**
|
|
189
|
+
|
|
190
|
+
- `label` (text): What the figure is called
|
|
191
|
+
- `value` (alias | `{ "avg": alias }`): A number field summed over the rows, or `{ avg }` averaged over the rows holding one
|
|
192
|
+
- `by` (alias | Tiered filter): Splits the rows into parts
|
|
193
|
+
- `where` (narrowing): 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 }`)
|
|
194
|
+
- `entity` (alias): The List's rows
|
|
195
|
+
- `over` (alias): The date that places a row in time
|
|
196
|
+
|
|
197
|
+
<!-- generated:end words -->
|
|
198
|
+
|
|
40
199
|
## Look at it
|
|
41
200
|
|
|
42
201
|
After an apply, `screenshot_app` draws each app as its people see it — the register, and a record by its `path` (`screen`
|
|
@@ -51,39 +210,39 @@ send the tree saved before the change as `body` with `app_id`, nulling an App pr
|
|
|
51
210
|
A treatment named below is one the answer of `set_app` notes when the rows call for it and nothing draws it, naming the
|
|
52
211
|
node that would state it; a note refuses nothing. Each kind of row's view is chosen before its List is written:
|
|
53
212
|
|
|
54
|
-
| The rows are | The treatment | Its
|
|
213
|
+
| The rows are | The treatment | Its own page |
|
|
55
214
|
|---|---|---|
|
|
56
|
-
| People or organisations | `records.party`, with a photo or logo as its `image` |
|
|
57
|
-
| Things with a photo, a scan or a paper | `records.image`; List `layout: "cards"` where the picture is how a row is found | `reference/
|
|
215
|
+
| People or organisations | `records.party`, with a photo or logo as its `image` | |
|
|
216
|
+
| Things with a photo, a scan or a paper | `records.image`; List `layout: "cards"` where the picture is how a row is found | `reference/cards` |
|
|
58
217
|
| Read by their day | List `layout: "calendar"`; on a record, a child List with `layout: {"agenda": …}` | `reference/calendar`, `reference/layouts` |
|
|
59
|
-
| Ranked by a figure, or worked by a date | List `sort: {"field": …, "desc": true}` on that column |
|
|
218
|
+
| Ranked by a figure, or worked by a date | List `sort: {"field": …, "desc": true}` on that column | |
|
|
60
219
|
| Booked on a resource | List `layout: {"lanes": {"by": …}}`, and the table's `no_overlap` | `reference/lanes`, `reference/write-rules` |
|
|
61
220
|
| A log of what happened | a child List with `layout: "timeline"` | `reference/layouts` |
|
|
62
|
-
| Opened to be worked on | the Record's Sections, in the order the work reaches them — `at` where it moves in steps; fields only one kind of row holds (a delay's cause, a safety issue's hours lost) in a Section whose `when` names that kind |
|
|
63
|
-
| Rows that each belong to another row | a child List on that row's Record, with `create` and `remove` — and a child's own rows a List in that child's page, as deep as the data goes; a List with `same` where read-only |
|
|
221
|
+
| Opened to be worked on | the Record's Sections, in the order the work reaches them — `at` where it moves in steps; fields only one kind of row holds (a delay's cause, a safety issue's hours lost) in a Section whose `when` names that kind | |
|
|
222
|
+
| Rows that each belong to another row | a child List on that row's Record, with `create` and `remove` — and a child's own rows a List in that child's page, as deep as the data goes; a List with `same` where read-only | |
|
|
64
223
|
| A related row's value on the list (the newest contract's end date) | a `lookup` field of the table, ordered, as a column | `reference/lookup` |
|
|
65
|
-
| Moving through a status | an Act per move, `status.dates` for the moment of each stage, and the register's Readings |
|
|
66
|
-
| Counted over a period | the register's Tabs over one `period`; a Tab's `totals` for a child's sums before, during and through it; an open Tab's `where` reads only what was true at the period's end, never a status the row moves on from |
|
|
67
|
-
| Papers a case gathers | a List with `expect`; the papers made, an Act's `templates` |
|
|
224
|
+
| Moving through a status | an Act per move, `status.dates` for the moment of each stage, and the register's Readings | |
|
|
225
|
+
| Counted over a period | the register's Tabs over one `period`; a Tab's `totals` for a child's sums before, during and through it; an open Tab's `where` reads only what was true at the period's end, never a status the row moves on from | |
|
|
226
|
+
| Papers a case gathers | a List with `expect`; the papers made, an Act's `templates` | |
|
|
68
227
|
| A plan of spans | List `layout: {"gantt": {"start": …}}` | `reference/gantt` |
|
|
69
228
|
| Stood at a place on a plan, flat or in 3D — pallets, bins | List `layout: {"plan": …}`; places state `plan_place` | `reference/plan` |
|
|
70
|
-
| Checked item by item against a standard | a List with `checklist: {"photo": …, "clause": …, "failed": […], "passed": …}`: each row a mark (passed at `closed`, failed at a `failed` option, or by the yes/no `passed` names — a measured verdict, no task or status needed), its photo and the clause it is checked against; with `expect` on the standard's items, each item is a line marked the same way and filled by the block's columns |
|
|
71
|
-
| A place before and after the work | a List with `compare: {"before": …, "after": …}`: two files fields read side by side, or two value fields read as one struck-then-new column |
|
|
229
|
+
| Checked item by item against a standard | a List with `checklist: {"photo": …, "clause": …, "failed": […], "passed": …}`: each row a mark (passed at `closed`, failed at a `failed` option, or by the yes/no `passed` names — a measured verdict, no task or status needed), its photo and the clause it is checked against; with `expect` on the standard's items, each item is a line marked the same way and filled by the block's columns | |
|
|
230
|
+
| A place before and after the work | a List with `compare: {"before": …, "after": …}`: two files fields read side by side, or two value fields read as one struck-then-new column | |
|
|
72
231
|
| Spots on a drawing | `records.pin: {"on": …, "x": …, "y": …}` on the spots' table: a record listing rows that link to them draws the picture with a numbered pin at each; the picture is the `on` row's `records.image` | `reference/record-places-pins-and-cadence` |
|
|
73
232
|
| Photos that must be taken on site | `records.on_site: {"photos": […]}`: a photo taken through the camera keeps where the device stood, and a record holding one taken away says so | `reference/record-places-pins-and-cadence` |
|
|
74
233
|
| The real size of the thing (a carton, a piece of furniture, a pallet) | `records.size: {"across": …, "along": …, "up": …}`: three number fields in one length unit, read as one fact "400 × 300 × 250 mm" after the subtitle; a plan register draws each box at that size | `reference/record-places-pins-and-cadence`, `reference/plan` |
|
|
75
234
|
| A number painted on the thing, or a barcode or QR code on it | `records.scan: "iso6346"` or `"text"` (read off one photo by an agent), or `"code"` (decoded on the device, no agent): the title read on a phone, beside each search matching it | `reference/record-places-pins-and-cadence` |
|
|
76
235
|
| Who did what on which day | List `layout: "roster"` with the List of its cells inside | `reference/roster` |
|
|
77
|
-
| Someone with no seat signs off one record (a buyer approves a proof, a client signs a handover) | the Record's `Outside`: the Fields and Lists the link shows as they are, and Acts that each move the status out of its `at` — a link a member makes of the record, never a seat; the link's page names the record only where the Outside states its title's field |
|
|
78
|
-
| Steps people drop out of between | a Reading with `steps` on the record whose child rows count them |
|
|
79
|
-
| A record's own numbers nobody keys, read at a glance | consecutive Readings with no `entity` (
|
|
236
|
+
| Someone with no seat signs off one record (a buyer approves a proof, a client signs a handover) | the Record's `Outside`: the Fields and Lists the link shows as they are, and Acts that each move the status out of its `at` — a link a member makes of the record, never a seat; the link's page names the record only where the Outside states its title's field | |
|
|
237
|
+
| Steps people drop out of between | a Reading with `steps` on the record whose child rows count them | |
|
|
238
|
+
| A record's own numbers nobody keys, read at a glance | consecutive Readings with no `entity` (up to eight tiles) | |
|
|
80
239
|
| Rows that are each a place a record is sent | a List with `expect` on the link to those places and `post`: each ticked, the post written there and read as its feed shows it | `reference/publish-desk` |
|
|
81
|
-
| Papers an agent reads, where the owner asked for one | an Act's `intake` with `fills` |
|
|
82
|
-
| Calls and visits | an Act's `record` |
|
|
83
|
-
| Changes a workflow proposes that a person approves row by row — a price list applied, a statement matched to what is owed | an Act's `workflow` with `review`, its body returning a changeset in `data.review` |
|
|
84
|
-
| Documents covering lines | a List with `under` |
|
|
85
|
-
| Rows on file a record takes in | a List with `pick` |
|
|
86
|
-
| One owner's question across jobs | an App of Tabs and Readings and no register |
|
|
240
|
+
| Papers an agent reads, where the owner asked for one | an Act's `intake` with `fills` | |
|
|
241
|
+
| Calls and visits | an Act's `record` | |
|
|
242
|
+
| Changes a workflow proposes that a person approves row by row — a price list applied, a statement matched to what is owed | an Act's `workflow` with `review`, its body returning a changeset in `data.review` | |
|
|
243
|
+
| Documents covering lines | a List with `under` | |
|
|
244
|
+
| Rows on file a record takes in | a List with `pick` | |
|
|
245
|
+
| One owner's question across jobs | an App of Tabs and Readings and no register | |
|
|
87
246
|
|
|
88
247
|
What these nodes do not state, a long-form writing page or a bespoke tool, is a custom-code app (`lotics app create <name> --custom`, `building_an_app`), never a new node.
|
|
89
248
|
|
|
@@ -94,7 +253,8 @@ What these nodes do not state, a long-form writing page or a bespoke tool, is a
|
|
|
94
253
|
`records.party` is `"person"` where the rows are people (a contact, a patient, a driver) and
|
|
95
254
|
`"organization"` where they are companies (a customer, a supplier, a carrier). Every surface drawing one of
|
|
96
255
|
its rows then draws a face: its `image` (a photo, a logo), else its initials. Without it, a person is drawn as a thing. A workspace
|
|
97
|
-
member is a `member` field, and is drawn by their face already.
|
|
256
|
+
member is a `member` field, and is drawn by their face already. A column holding a link to several rows of people,
|
|
257
|
+
or several members, draws their faces as a stack that names them on hover. Worked: `examples/party`.
|
|
98
258
|
|
|
99
259
|
#### Image
|
|
100
260
|
|
|
@@ -195,7 +355,7 @@ register; a register whose job is a strict order, a first-come queue, states `at
|
|
|
195
355
|
Who changed what and when is the platform's audit trail, never a table and never shown by an app. When a stage's moment matters
|
|
196
356
|
to the business — reported, filtered, printed — it is a date on the row that `records.status.dates` stamps as the row
|
|
197
357
|
enters the option, whoever writes: the one way a status is timed, and the moment a stage's `within` runs from (each stage, and
|
|
198
|
-
each open option of a status with stages, naming none gets `<option>_at`). A straight-line process is one select of its steps in order, each dated; a move whose
|
|
358
|
+
each open option of a status with stages, naming none gets `<option>_at`). A straight-line process is one select of its steps in order, each dated (a record whose parts state no `at` draws it as steps by itself: no date fields or formulas copy it); a move whose
|
|
199
359
|
day may already be past `asks` that date with `starts: "today"`. `records.status.history` names a child the record write path appends one row to per
|
|
200
360
|
status move (its link to the row, the new status, the moment and who) for a business that reports on every move: moves
|
|
201
361
|
per person, or time in a stage a row re-enters. An event with facts of its own — a reason, an amount, a signature — is
|
|
@@ -206,7 +366,7 @@ stage is signed once per person, read off who moved the row.
|
|
|
206
366
|
|
|
207
367
|
A List usually opens with one band of figures or a chart, chosen for what that person watches. Its Readings stand above the rows and its filters and read the rows under the open tab, never narrowed by the controls below them. Lead with the job's headline number —
|
|
208
368
|
its exception as a formula's yes/no in a Reading's `where` (what is short), never a stage the
|
|
209
|
-
status chips already count, nor the overdue rows the register's summary line counts from `records.due` — then at most the mix (`by` a field) and the movement (`by` a date), varied by job. A movement over a date is stated, never defaulted
|
|
369
|
+
status chips already count, nor the overdue rows the register's summary line counts from `records.due` — then at most the mix (`by` a field) and the movement (`by` a date), varied by job. A movement over a date is stated, never defaulted; so is a sum, but for the one a status register with a money figure leads with by default: that figure over its open rows. A register with no such figure and no single select to split by gets no default band.
|
|
210
370
|
A grid (`by` and `across`) reads on a Sheet. A Sheet — a View of Readings at the App's root, beside its Lists or alone —
|
|
211
371
|
answers one owner's question across jobs, each Reading windowed by the reader's period (the App's `period`), and a
|
|
212
372
|
List on it hands over the rows to act on. Many Readings stand on several Sheets, each a View the reader picks. A
|
|
@@ -234,6 +394,12 @@ an app (`first_build` § 3).
|
|
|
234
394
|
|
|
235
395
|
#### Sections
|
|
236
396
|
|
|
397
|
+
A record is a head, its parts and at most one Side. From three parts it shows one part at a time; fewer stack. State each
|
|
398
|
+
part whole for the work there: a field may stand in any number of parts, and a field an Act requires draws beside it
|
|
399
|
+
unstated. A step may hold nothing but its name. What a person needs in view at every part (who it is for, how to reach
|
|
400
|
+
them) goes in a Side: it leaves the head and stays on the rows. The status stands in the head or the Side, never a
|
|
401
|
+
Section. `row` changes how the app's rows read, never a page.
|
|
402
|
+
|
|
237
403
|
The Record's Sections, in the order the work reaches them: the fields people write, a Field per paper the record
|
|
238
404
|
keeps, a child List per child, the Acts at each one's foot. A register's `columns` are in the order the job reads them, as many as fit a desk; what is read only on the way deeper is the Record's, and a figure that is final only from a stage is a Field of that stage's Section, never a column read on every row at every stage. A register laid out in time (calendar, lanes, roster) opens the
|
|
239
405
|
default record: every field a person writes. Behaviour belongs in an Act.
|