kalup 0.4.0 → 0.5.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.
Files changed (32) hide show
  1. package/README.md +3 -3
  2. package/dist/{commands-CHucC_PV.mjs → commands-D_Q8-jc5.mjs} +10931 -8208
  3. package/dist/commands.d.mts +1 -1
  4. package/dist/commands.mjs +1 -1
  5. package/dist/{context-B7bI9BjL.d.mts → context-0mrva_6H.d.mts} +42 -0
  6. package/dist/{host-D1HtgrVd.mjs → host-BkBYlh_7.mjs} +1 -1
  7. package/dist/host.d.mts +1 -1
  8. package/dist/host.mjs +1 -1
  9. package/dist/index.mjs +1 -1
  10. package/dist/schemas/ir-1.schema.json +655 -130
  11. package/dist/schemas/state-1.schema.json +80 -18
  12. package/docs/apply.md +8 -5
  13. package/docs/config.md +34 -8
  14. package/docs/dictionary.md +2 -2
  15. package/docs/errors/E_ASSOCIATION_FIELD.md +21 -0
  16. package/docs/errors/E_ASSOCIATION_NAME.md +17 -0
  17. package/docs/errors/E_BLUEPRINT_REQUIRES.md +3 -3
  18. package/docs/errors/E_PLAN_DELETE.md +1 -1
  19. package/docs/errors/E_PLAN_INVALID.md +1 -1
  20. package/docs/errors/E_PLAN_RISK.md +1 -1
  21. package/docs/errors/E_PREVENT_DESTROY.md +1 -1
  22. package/docs/errors/E_TOMBSTONE_ADDRESS.md +1 -1
  23. package/docs/errors/E_TOMBSTONE_CONFLICT.md +1 -1
  24. package/docs/errors/E_UNKNOWN_OBJECT.md +1 -1
  25. package/docs/errors/W_OBJECT_FIELD.md +25 -0
  26. package/docs/errors/W_OBJECT_PROPERTY.md +17 -0
  27. package/docs/plan.md +25 -6
  28. package/docs/pull.md +8 -5
  29. package/docs/rm.md +6 -5
  30. package/docs/snapshot.md +3 -3
  31. package/docs/targets.md +1 -1
  32. package/package.json +2 -2
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Kalup: configuration as code for HubSpot. This is the CLI, bin `kalup`.
4
4
 
5
- Kalup keeps a HubSpot portal's properties, property groups, custom object schemas and pipelines in TypeScript files in your repository. It reads a portal into those files, shows every change as a plan, and applies the plan you approve to any portal you name. Edits made in the HubSpot UI are held, not reverted. The tool parses the files and never executes them; your app imports the same files for its types through [`@kalup/core`](https://www.npmjs.com/package/@kalup/core).
5
+ Kalup keeps a HubSpot portal's properties, property groups, custom object schemas, pipelines and association labels in TypeScript files in your repository. It reads a portal into those files, shows every change as a plan, and applies the plan you approve to any portal you name. Edits made in the HubSpot UI are held, not reverted. The tool parses the files and never executes them; your app imports the same files for its types through [`@kalup/core`](https://www.npmjs.com/package/@kalup/core).
6
6
 
7
7
  ## Install
8
8
 
@@ -55,13 +55,13 @@ Commit `kalup.config.ts` and `hubspot/`. Keep `.kalup/`, plan files and `.env` o
55
55
 
56
56
  ## What it covers
57
57
 
58
- - Reads and writes properties and property groups on standard and custom objects, and the pipelines and stages of deals, tickets and custom objects. Custom object schemas are read and compared, not written.
58
+ - Reads and writes custom object schemas, properties and property groups on standard and custom objects, the pipelines and stages of deals, tickets and custom objects, and association labels and plain associations between two objects.
59
59
  - Every property definition field HubSpot lets you write, such as display hints, `hidden`, `displayOrder` and calculation formulas, checked against a live developer test account.
60
60
  - Takeover mode, `exclude`, `adopt: 'overwrite'` and `yesLimit` per target, lenient enums, blueprints and per-target overrides.
61
61
  - State local to your machine by default, or committed with `state: 'repo'`. Monorepos and git worktrees.
62
62
  - Every command takes `--json` and prints one `envelope/1` document with stable issue codes and exit codes. The JSON Schemas ship as `kalup/schemas/<file>`.
63
63
 
64
- The pull, plan, apply and drift workflow passed [live runs](https://github.com/scopiousdigital/kalup/blob/main/docs/hubspot.md#live-runs) on a HubSpot developer test account. Start on a test account or sandbox. Custom object schema writes and association labels are next. Before 1.0, a minor release may change the config grammar or the JSON output, and its release notes say so.
64
+ The pull, plan, apply and drift workflow passed [live runs](https://github.com/scopiousdigital/kalup/blob/main/docs/hubspot.md#live-runs) on a HubSpot developer test account. Start on a test account or sandbox. Before 1.0, a minor release may change the config grammar or the JSON output, and its release notes say so.
65
65
 
66
66
  ## Docs
67
67