@lotics/cli 0.321.74 → 0.321.75
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 +12 -5
- package/docs/build.md +14 -10
- package/docs/design.md +10 -8
- package/docs/examples.md +331 -291
- package/package.json +1 -1
package/docs/build.md
CHANGED
|
@@ -95,16 +95,18 @@ One template per paper the owner sends. A slot is named after a field of the rec
|
|
|
95
95
|
],
|
|
96
96
|
"pages": [
|
|
97
97
|
{"type": "Record", "entity": "cake_order", "children": [
|
|
98
|
-
{"type": "
|
|
99
|
-
"
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
{"
|
|
107
|
-
|
|
98
|
+
{"type": "Steps", "children": [
|
|
99
|
+
{"type": "Section", "title": "Order", "at": ["taken", "baking"], "children": [
|
|
100
|
+
"due_on",
|
|
101
|
+
"pay_by",
|
|
102
|
+
{"type": "List", "entity": "cake_line", "create": ["item", "quantity"]},
|
|
103
|
+
{"type": "Act", "key": "start_baking", "label": "Start baking", "when": {"stage": ["taken"]}, "requires": ["due_on"], "asks": ["prepaid"], "set": {"stage": "baking"}},
|
|
104
|
+
{"type": "Act", "key": "ready", "label": "Ready", "when": {"stage": ["baking"]}, "set": {"stage": "ready"}, "template": "order_slip", "into": "slip"}
|
|
105
|
+
]},
|
|
106
|
+
{"type": "Section", "title": "Pickup", "at": ["ready"], "children": [
|
|
107
|
+
{"field": "slip", "edit": false},
|
|
108
|
+
{"type": "Act", "key": "collect", "label": "Collected", "when": {"stage": ["ready"], "paid": true}, "set": {"stage": "collected"}}
|
|
109
|
+
]}
|
|
108
110
|
]}
|
|
109
111
|
]}
|
|
110
112
|
]
|
|
@@ -112,6 +114,8 @@ One template per paper the owner sends. A slot is named after a field of the rec
|
|
|
112
114
|
}
|
|
113
115
|
```
|
|
114
116
|
|
|
117
|
+
**How a status draws follows the work, never this example.** The order states `Steps` because its stages hold something of their own: the lines it bakes from, the slip its Act files. A status whose Acts only move the row on states no `Steps` and draws as a line of steps. One a person sets by hand, closing nothing or moved by no Act, draws as its select (`design`, Stages).
|
|
118
|
+
|
|
115
119
|
**Give each main List a band** of what its person watches, a figure or a chart in its `children`, never a bare count.
|
|
116
120
|
|
|
117
121
|
**A press can be a mistake.** An Act also moves a row back (`when` the later stage, `set` the earlier), at the foot of the Section of the stage it leaves. **Someone with no seat** who signs or approves one record, a customer or a supplier, gets a Record's `Outside`: a link a member makes of that record.
|
package/docs/design.md
CHANGED
|
@@ -108,7 +108,7 @@ or its entity is read-only (`edit: false`); a stepped status is not, since Acts
|
|
|
108
108
|
|
|
109
109
|
**`records.status`**
|
|
110
110
|
|
|
111
|
-
- `field` (alias, required): The single select that is the row's state, its options in the order the work goes through them,
|
|
111
|
+
- `field` (alias, required): The single select that is the row's state, its options in the order the work goes through them, drawn as a line of steps on a record page where no Section states `at`
|
|
112
112
|
- `closed` (list of alias (at least one)): Options that end the work
|
|
113
113
|
- `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)
|
|
114
114
|
- `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
|
|
@@ -143,7 +143,7 @@ or its entity is read-only (`edit: false`); a stepped status is not, since Acts
|
|
|
143
143
|
**Record**
|
|
144
144
|
|
|
145
145
|
- `entity` (alias, required): The table whose rows open on this page
|
|
146
|
-
- `children` (list of (List over a Query in a Record | alias | Field | Fieldset | Section | Side | Outside | List | Reading | Statement | Comments | Act | Check) (at least one)): Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings, Statements and Comments directly
|
|
146
|
+
- `children` (list of (List over a Query in a Record | alias | Field | Fieldset | Section | Steps | Side | Outside | List | Reading | Statement | Comments | Act | Check) (at least one)): Parts (Section, Side, and one Steps holding the Sections that are its path), or for a one-part record its Fields, Fieldsets, Lists, Readings, Statements and Comments directly
|
|
147
147
|
- `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
|
|
148
148
|
- `row` (Record row): How the App reads this entity's rows wherever it lists them
|
|
149
149
|
- `door` (`"page"` | `"drawer"`): How a row opens, on a page or in a drawer
|
|
@@ -153,7 +153,7 @@ or its entity is read-only (`edit: false`); a stepped status is not, since Acts
|
|
|
153
153
|
- `title` (text): The part's heading
|
|
154
154
|
- `key` (alias): Unique among its siblings
|
|
155
155
|
- `children` (list of (List over a Query in a Record | alias | Field | Fieldset | List | Reading | Statement | Comments | Act | Check) (at least one)): What the part draws, in reading order
|
|
156
|
-
- `at` (list of alias (at least one)):
|
|
156
|
+
- `at` (list of alias (at least one)): The status options this part is the work of
|
|
157
157
|
- `when` (condition): Drawn only while this holds
|
|
158
158
|
|
|
159
159
|
**Field**
|
|
@@ -280,7 +280,7 @@ Each kind of row's view is chosen before its List is written:
|
|
|
280
280
|
| Booked on a resource | List `layout: {"lanes": {"by": …}}`, and the table's `no_overlap` — a list of rules where a row holds two (a room and a teacher) | `reference/lanes`, `reference/write-rules` |
|
|
281
281
|
| A day's work given out to people or vehicles | List `layout: {"lanes": {"by": …}}` over rows holding a day and no hour | `reference/lanes` |
|
|
282
282
|
| A log of what happened | a child List with `layout: "timeline"` | `reference/layouts` |
|
|
283
|
-
| Opened to be worked on | the Record's Sections — each one area of the record's data, its lists and field groups inside it; a status's stage acts stand at the foot of the rows they move,
|
|
283
|
+
| Opened to be worked on | the Record's Sections — each one area of the record's data, its lists and field groups inside it; a status's stage acts stand at the foot of the rows they move; a stage that holds something of its own, a note included, is a Section inside `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 | |
|
|
284
284
|
| 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, and every row's ⋯ offers Duplicate; a List with `same` where read-only | |
|
|
285
285
|
| 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` |
|
|
286
286
|
| Moving through a status | an Act per move, `status.dates` for the moment of each stage, and the register's Readings | |
|
|
@@ -429,12 +429,14 @@ A row at a stage leaves it by its owner whatever its `when`; `dropped` names the
|
|
|
429
429
|
that leave the work undone (cancelled, rejected), which whoever holds the row moves it to from any stage. A stage's owner gates who moves a row out of it; who may move a row into a stage ("only a bookkeeper marks an invoice paid") is a check. Late rows, rows due soon, a warning the line draws and rows waiting on the reader stand first in a
|
|
430
430
|
register; a register whose job is a strict order, a first-come queue, states `attention: false`.
|
|
431
431
|
|
|
432
|
+
A status draws one of three ways, by what the author states, never by habit. With nothing `closed` it is a condition a person sets: its select, no steps. With `closed` it is a path: one a person moves by hand (no Act moves it, or its `row` states `status: { edit: true }`) keeps its select alone, and one Acts move draws its stages as a line of steps across the page, each only moving the row on. Where a stage holds something of its own — fields, blocks, an act that asks or files a paper, a note — the Record states it as a Section inside `Steps`, and the path draws down the page, each step holding what its stage holds.
|
|
433
|
+
|
|
432
434
|
#### Stage dates and history
|
|
433
435
|
|
|
434
436
|
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
|
|
435
437
|
to the business — reported, filtered, printed — it is a date on the row that `records.status.dates` stamps as the row
|
|
436
438
|
enters the option, whoever writes: the one way a status is timed, and the moment a stage's `within` runs from (each stage, and
|
|
437
|
-
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
|
|
439
|
+
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 that states no `Steps` draws it as a line of steps by itself: no date fields or formulas copy it); a move whose
|
|
438
440
|
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
|
|
439
441
|
status move (its link to the row, the new status, the moment and who) for a business that reports on every move: moves
|
|
440
442
|
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
|
|
@@ -473,11 +475,11 @@ an app (`app_architecture`).
|
|
|
473
475
|
|
|
474
476
|
#### Sections
|
|
475
477
|
|
|
476
|
-
A record is a head, its parts and at most one Side. From three parts it shows one part at a time; fewer stack. A part is one area of the record's data a person comes to for its own job, like the tabs of a settings page; its related lists and field groups sit inside it under their headings. A status's stages are not areas: their acts stand at the foot of the rows they move. State each
|
|
478
|
+
A record is a head, its parts and at most one Side. From three parts it shows one part at a time; fewer stack. A part is one area of the record's data a person comes to for its own job, like the tabs of a settings page; its related lists and field groups sit inside it under their headings. A status's stages are not areas: their acts stand at the foot of the rows they move, and a stage that holds something of its own — fields, blocks, acts, a note — is a Section inside `Steps`, one `Steps` to a record. State each
|
|
477
479
|
part whole for the work there: a field may stand in any number of parts, and a field an Act requires draws beside it
|
|
478
|
-
unstated. A
|
|
480
|
+
unstated. A stage that holds nothing needs no Section: the path draws it by its name. What a person needs in view at every part (who it is for, how to reach
|
|
479
481
|
them) goes in a Side: it leaves the head and stays on the rows; what only a stage's Act writes (an invoice's number,
|
|
480
|
-
a delivery's signature) stands empty before it, so it goes in that stage's Section
|
|
482
|
+
a delivery's signature) stands empty before it, so it goes in that stage's Section inside `Steps`, never the Side. The status
|
|
481
483
|
stands in the head or the Side, never a Section. `row` changes how the app's rows read, never a page nor what the app writes. A List, Reading, Statement or Act stated alike in several
|
|
482
484
|
Sections draws once, in the first; a Check stated in a Section guards the whole record.
|
|
483
485
|
|