zinkee 0.1.41 → 0.1.43
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/AGENTS.md +1 -0
- package/README.md +31 -2
- package/dist/index.js +506 -192
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/api/displays.ts +14 -2
- package/src/api/formulas.test.ts +65 -0
- package/src/api/formulas.ts +67 -0
- package/src/api/schemas.ts +3 -0
- package/src/command-registry.ts +21 -0
- package/src/commands/displays.test.ts +99 -0
- package/src/commands/displays.ts +19 -3
- package/src/commands/formulas.test.ts +194 -0
- package/src/commands/formulas.ts +243 -0
- package/src/commands/schemas.test.ts +89 -0
- package/src/commands/schemas.ts +13 -1
- package/src/program.ts +2 -0
- package/src/utils/examples.ts +110 -5
package/AGENTS.md
CHANGED
package/README.md
CHANGED
|
@@ -18,6 +18,7 @@ Implemented command groups:
|
|
|
18
18
|
- `displays`
|
|
19
19
|
- `automations`
|
|
20
20
|
- `document-templates`
|
|
21
|
+
- `formulas`
|
|
21
22
|
|
|
22
23
|
## Requirements
|
|
23
24
|
|
|
@@ -143,7 +144,7 @@ zinkee --json schemas get projects
|
|
|
143
144
|
Simple field types use `--type`, `--slug`, `--label`:
|
|
144
145
|
|
|
145
146
|
```bash
|
|
146
|
-
zinkee schemas fields create projects --type text --slug name --label "Name"
|
|
147
|
+
zinkee schemas fields create projects --type text --slug name --label "Name" --description "Primary project name"
|
|
147
148
|
zinkee schemas fields create projects --type number --slug budget --label "Budget" --required true --default 0
|
|
148
149
|
zinkee schemas fields create projects --type date --slug start-date --label "Start Date"
|
|
149
150
|
zinkee schemas fields create projects --type file --slug attachment --label "Attachment"
|
|
@@ -205,6 +206,8 @@ Use `--default <value>` for the common default-value case:
|
|
|
205
206
|
|
|
206
207
|
```bash
|
|
207
208
|
zinkee schemas fields update projects budget --default 0
|
|
209
|
+
zinkee schemas fields update projects budget --description "Approved project budget"
|
|
210
|
+
zinkee schemas fields update projects budget --description "" # Clear the description
|
|
208
211
|
```
|
|
209
212
|
|
|
210
213
|
PATCH bodies are flat (no `set` / `unset` wrapper). Config properties must be wrapped inside a `config` key:
|
|
@@ -468,7 +471,11 @@ zinkee displays folders delete "Executive Dashboards"
|
|
|
468
471
|
### Create a freeform display
|
|
469
472
|
|
|
470
473
|
```bash
|
|
471
|
-
zinkee --json displays create --name "Project Dashboard"
|
|
474
|
+
zinkee --json displays create --name "Project Dashboard" \
|
|
475
|
+
--description "Project delivery overview" \
|
|
476
|
+
--template freeform
|
|
477
|
+
zinkee --json displays update <display-uuid> --description "Updated overview"
|
|
478
|
+
zinkee --json displays update <display-uuid> --description "" # Clear the description
|
|
472
479
|
```
|
|
473
480
|
|
|
474
481
|
### Add a context variable
|
|
@@ -815,6 +822,27 @@ zinkee document-templates assets download <template-uuid> <asset-uuid> > contrac
|
|
|
815
822
|
|
|
816
823
|
---
|
|
817
824
|
|
|
825
|
+
## Formula recalculation
|
|
826
|
+
|
|
827
|
+
Queue a full recalculation without changing the formula text. Acceptance means
|
|
828
|
+
the work was queued; it does not mean calculation has completed.
|
|
829
|
+
|
|
830
|
+
```bash
|
|
831
|
+
zinkee formulas recompute field <schema> <field>
|
|
832
|
+
zinkee formulas recompute schema <schema> --yes
|
|
833
|
+
zinkee formulas recompute workspace --yes
|
|
834
|
+
```
|
|
835
|
+
|
|
836
|
+
`schema` and `field` accept UUIDs or slugs. Prefer the smallest useful scope.
|
|
837
|
+
Schema and workspace recalculations require `--yes` because they can enqueue
|
|
838
|
+
substantial work and trigger dependent formula cascades. All three commands are
|
|
839
|
+
blocked by global `--read-only` mode.
|
|
840
|
+
|
|
841
|
+
Use `--json --example formulas recompute <scope>` for canonical payloads and
|
|
842
|
+
responses.
|
|
843
|
+
|
|
844
|
+
---
|
|
845
|
+
|
|
818
846
|
## Discovery
|
|
819
847
|
|
|
820
848
|
```bash
|
|
@@ -825,5 +853,6 @@ zinkee --json automations list
|
|
|
825
853
|
zinkee --json automations plugins list
|
|
826
854
|
zinkee --json automations connections list
|
|
827
855
|
zinkee --json document-templates list
|
|
856
|
+
zinkee --json formulas recompute field <schema> <field>
|
|
828
857
|
zinkee --example <command path>
|
|
829
858
|
```
|