@hs-x/hubspot-cli 0.1.0 → 0.1.3
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/README.md +40 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,3 +1,42 @@
|
|
|
1
1
|
# @hs-x/hubspot-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@hs-x/hubspot-cli` is the dev-time counterpart to
|
|
4
|
+
[`@hs-x/hubspot`](https://www.npmjs.com/package/@hs-x/hubspot). Where
|
|
5
|
+
`@hs-x/hubspot` is the Worker-safe client an app uses at runtime to talk to a
|
|
6
|
+
*portal*, this package talks to a HubSpot *developer account* from a developer
|
|
7
|
+
machine: it uploads, deploys, and polls HubSpot projects, drives the HubSpot
|
|
8
|
+
`dev-sessions` loop, and manages schemas, release flags, and card-view
|
|
9
|
+
migrations.
|
|
10
|
+
|
|
11
|
+
This package is **CLI-internal**. App authors do not install or import it; the
|
|
12
|
+
`hs-x` CLI and the control-plane deploy executors use it under the hood when you
|
|
13
|
+
run `hs-x dev` and `hs-x deploy`.
|
|
14
|
+
|
|
15
|
+
## What it wraps
|
|
16
|
+
|
|
17
|
+
`createHubSpotDeveloperClient(...)` builds a `HubSpotDeveloperClient` on top of
|
|
18
|
+
HubSpot's official local-dev libraries:
|
|
19
|
+
|
|
20
|
+
- [`@hubspot/local-dev-lib`](https://www.npmjs.com/package/@hubspot/local-dev-lib)
|
|
21
|
+
— config/auth, project upload, build and deploy status, app lookup.
|
|
22
|
+
- [`@hubspot/project-parsing-lib`](https://www.npmjs.com/package/@hubspot/project-parsing-lib)
|
|
23
|
+
— reading and validating HubSpot project structure.
|
|
24
|
+
- [`@hubspot/ui-extensions-dev-server`](https://www.npmjs.com/package/@hubspot/ui-extensions-dev-server)
|
|
25
|
+
— the UI-extension dev server behind the local card loop.
|
|
26
|
+
|
|
27
|
+
Because it pulls in those libraries and Node built-ins, it is **not Worker-safe**.
|
|
28
|
+
Runtime code that needs to reach a portal should keep using
|
|
29
|
+
[`@hs-x/hubspot`](https://www.npmjs.com/package/@hs-x/hubspot).
|
|
30
|
+
|
|
31
|
+
## Part of HS-X
|
|
32
|
+
|
|
33
|
+
HS-X is a leaveable, type-safe HubSpot app framework on Cloudflare Workers.
|
|
34
|
+
Start with the CLI:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npm i -g @hs-x/cli
|
|
38
|
+
hs-x init myapp
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
See [`@hs-x/cli`](https://www.npmjs.com/package/@hs-x/cli) and
|
|
42
|
+
[hs-x.dev](https://hs-x.dev).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hs-x/hubspot-cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Dev-time HubSpot developer-account client and dev-session driver. Counterpart to @hs-x/hubspot — wraps @hubspot/local-dev-lib for CLI and control-plane executors.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -31,5 +31,6 @@
|
|
|
31
31
|
"@hubspot/project-parsing-lib": "0.16.0",
|
|
32
32
|
"@hubspot/ui-extensions-dev-server": "2.0.7",
|
|
33
33
|
"effect": "^3.10.19"
|
|
34
|
-
}
|
|
34
|
+
},
|
|
35
|
+
"license": "Apache-2.0"
|
|
35
36
|
}
|