kalup 0.5.0 → 0.6.0
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/{commands-D_Q8-jc5.mjs → commands-DdogKJKg.mjs} +824 -357
- package/dist/commands.d.mts +1 -1
- package/dist/commands.mjs +1 -1
- package/dist/{context-0mrva_6H.d.mts → context-BgFzBPj9.d.mts} +10 -0
- package/dist/{host-BkBYlh_7.mjs → host-BSYg3I66.mjs} +1 -1
- package/dist/host.d.mts +1 -1
- package/dist/host.mjs +1 -1
- package/dist/index.mjs +1 -1
- package/dist/schemas/ir-1.schema.json +67 -98
- package/dist/schemas/plan-1.schema.json +15 -6
- package/dist/schemas/state-1.schema.json +17 -5
- package/docs/compare.md +1 -1
- package/docs/errors/E_PLAN_INVALID.md +2 -0
- package/docs/errors/W_SETTLING.md +19 -0
- package/docs/plan.md +5 -3
- package/docs/pull.md +2 -0
- package/docs/snapshot.md +1 -1
- package/docs/state.md +4 -3
- package/package.json +2 -2
package/docs/state.md
CHANGED
|
@@ -15,9 +15,10 @@ Without `--write` it is read-only: it checks the read key's portal, reads the ta
|
|
|
15
15
|
- `found`: config resources the portal holds, with how many units config and the portal agree on.
|
|
16
16
|
- `missing`: config resources a complete read did not find.
|
|
17
17
|
- `stale`: current entries that record another portal name, whose resource the portal no longer holds, or whose address is no longer in config.
|
|
18
|
-
- `
|
|
18
|
+
- `kept`: entries of a type this version does not manage, which a later version of Kalup wrote. The rebuild keeps them as they are, unchecked, and keeps the state file's fields it does not know.
|
|
19
|
+
- `excluded`: tombstoned addresses, skipped ones, ones the read could not see or does not trust yet because they are settling after an apply (plan.md), and ones Kalup does not write.
|
|
19
20
|
|
|
20
|
-
With `--write`, only a person at a terminal may run it (else `E_APPROVAL_REQUIRED`, exit 4); `--yes` and `--approve` are refused. It checks the write key's portal and refuses
|
|
21
|
+
With `--write`, only a person at a terminal may run it (else `E_APPROVAL_REQUIRED`, exit 4); `--yes` and `--approve` are refused. It checks the write key's portal and refuses a read that left out what config names (`E_INCOMPLETE`: a rebuild would drop what it could not check): a list it could not read, a property it could not capture, a resource settling after an apply (run it again after the time it names), or an association a type HubSpot does not name yet may be. What settles where config names nothing does not stop it. It shows the report and what the current file loses for good (the `created` origin, agreed values, entries not in config), asks for the target name, takes the portal lock, refuses a state file changed since the report (`E_STATE_CHANGED`), archives the current file under `.kalup/state/archive/` (ending its lineage; also with `state: 'repo'`), and writes a new lineage at serial 1: an `adopted` entry for every found resource, with a base for the units that agree. A tombstoned address is never adopted. Nothing is sent to the portal.
|
|
21
22
|
|
|
22
23
|
Plans saved before a rebuild are refused by apply (`E_STATE_CHANGED`); plan again.
|
|
23
24
|
|
|
@@ -27,7 +28,7 @@ Plans saved before a rebuild are refused by apply (`E_STATE_CHANGED`); plan agai
|
|
|
27
28
|
|
|
28
29
|
## Output
|
|
29
30
|
|
|
30
|
-
`--json` data for rebuild: `target`, `portalId`, `statePath`, `found`, `missing`, `stale`, `excluded`, `loses` and `written`, always `false`, since `--write --json` exits 4. Rebind with `--json` exits 4 with no data.
|
|
31
|
+
`--json` data for rebuild: `target`, `portalId`, `statePath`, `found`, `missing`, `stale`, `excluded`, `kept` when there are any, `loses` and `written`, always `false`, since `--write --json` exits 4. Rebind with `--json` exits 4 with no data.
|
|
31
32
|
|
|
32
33
|
## Exit codes
|
|
33
34
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "kalup",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "Configuration as code for HubSpot: pull, compare, plan and apply properties and property groups",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"hubspot",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
65
|
"@oclif/core": "^5.1.2",
|
|
66
|
-
"@kalup/core": "0.
|
|
66
|
+
"@kalup/core": "0.6.0"
|
|
67
67
|
},
|
|
68
68
|
"engines": {
|
|
69
69
|
"node": ">=22.13.1"
|