@blotout/qinto-cli 0.1.17 → 0.1.18
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 +14 -6
- package/dist/index.js +3214 -2950
- package/dist/index.js.map +1 -1
- package/dist/worker-artifact/app-runtime/index.js +100 -50
- package/dist/worker-artifact/main/index.js +839 -538
- package/dist/worker-artifact/version.json +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -147,7 +147,7 @@ or go straight to the Developer area:
|
|
|
147
147
|
|
|
148
148
|
| Environment | Developer area |
|
|
149
149
|
| --- | --- |
|
|
150
|
-
| `production` | `https://
|
|
150
|
+
| `production` | `https://platform.blotout.io/developer` |
|
|
151
151
|
| `sandbox` | `https://portal.qinto.tech/developer` |
|
|
152
152
|
|
|
153
153
|
**Opening that page is the whole step.** The first visit creates a personal organization named after your email address and makes
|
|
@@ -281,6 +281,14 @@ Declared `server.schedules` fire on their own while `dev` runs — at the cron's
|
|
|
281
281
|
instant, exactly as the deployed sweep dispatches them. Each schedule on the app's console page also has a **Run now** button,
|
|
282
282
|
so you never wait for the window.
|
|
283
283
|
|
|
284
|
+
Declared `server.hooks.onLifecycle` hooks fire on the same transitions the platform announces: `installed` when you install the
|
|
285
|
+
app or add an install — and on the first boot of a dev root, which seeds the app installed — `enabled` and `disabled` when
|
|
286
|
+
you switch the app or an install, `configurationChanged` when install or app variables change, from the console or the panel,
|
|
287
|
+
and `uninstalled` when you remove an install or uninstall the app. Each goes out once the worker holds the new state, in
|
|
288
|
+
per-install sequence order. `versionChanged` never fires locally, because a dev build has one version. Like a deployed hook,
|
|
289
|
+
a failing one rolls nothing back: the change stays saved and the console, or the terminal at boot, names the hook that failed.
|
|
290
|
+
To run `installed` again on an existing dev root, uninstall and install the app.
|
|
291
|
+
|
|
284
292
|
Three surfaces, one per side of the product:
|
|
285
293
|
|
|
286
294
|
- **The console** is the platform's side. A team and the site `dev.localhost` are seeded for you; every mounted app is listed
|
|
@@ -295,7 +303,7 @@ Three surfaces, one per side of the product:
|
|
|
295
303
|
`track`, `identify`, `consent`, `alias`, `getSession` — then shows which app bundles `q.js` carried and which installs
|
|
296
304
|
activated. Its **Visitor** panel shows the browser's anon id, the one to paste into the ID graph page, and the person id
|
|
297
305
|
once `identify` links one. Its **Events** panel has a button for each of the eleven standard events in
|
|
298
|
-
[the standard events reference](https://docs.
|
|
306
|
+
[the standard events reference](https://docs.blotout.io): selecting one loads its documented payload into an editable box,
|
|
299
307
|
and **Track it** sends whatever is in it, so you can fire the real shape or your own. Every event reaches your hooks;
|
|
300
308
|
only one carrying a numeric `value` and a non-empty `orderId` — `Purchase`, among the standard ones — is also recorded as a
|
|
301
309
|
conversion in the identity graph.
|
|
@@ -527,7 +535,7 @@ can cancel it — an organization owner unwedges an abandoned draft with `--forc
|
|
|
527
535
|
|
|
528
536
|
`qinto.app.jsonc` is the app: it is JSONC (comments and trailing commas allowed), it is validated before every publish, and its
|
|
529
537
|
digest is what the version is finalized against. Every field and option is documented in
|
|
530
|
-
[the manifest reference](https://docs.
|
|
538
|
+
[the manifest reference](https://docs.blotout.io); the summary:
|
|
531
539
|
|
|
532
540
|
| Field | What it declares |
|
|
533
541
|
| --- | --- |
|
|
@@ -535,7 +543,7 @@ digest is what the version is finalized against. Every field and option is docum
|
|
|
535
543
|
| `slug`, `name`, `description` | Identity. `slug` is immutable and must match the registered app. |
|
|
536
544
|
| `flows` | `transform`, `destination`, or both. |
|
|
537
545
|
| `consent` | The single consent category a visitor must have granted before events reach the app. |
|
|
538
|
-
| `legal` | `termsUrl` and `privacyUrl` — HTTPS, and your own documents, never a
|
|
546
|
+
| `legal` | `termsUrl` and `privacyUrl` — HTTPS, and your own documents, never a Qinto platform URL. |
|
|
539
547
|
| `server` | `entry` plus the event and advisory lifecycle hooks the entry exports. |
|
|
540
548
|
| `browser` | `entry` for the bundle inside the site's `q.js`, optional capture names, and action types whose browser handlers return a same-event server result. |
|
|
541
549
|
| `capabilities` | The platform `api` calls and the event `data` the app is allowed to read. |
|
|
@@ -552,7 +560,7 @@ Limits worth knowing before a publish: the server bundle is capped at 10 MB, the
|
|
|
552
560
|
one site together), the UI panel at 200 files and 25 MB, and an app at 15 installs per site. A variable value is capped at 256
|
|
553
561
|
serialized bytes, and one variable's values across every install of that app on a site must fit in 5 KB. Every other cap — the
|
|
554
562
|
manifest, the publish, the install, and the runtime envelope — is listed in
|
|
555
|
-
[Qinto app limits](https://docs.
|
|
563
|
+
[Qinto app limits](https://docs.blotout.io).
|
|
556
564
|
|
|
557
565
|
## Built for humans and agents alike
|
|
558
566
|
|
|
@@ -574,7 +582,7 @@ Qinto runs in two environments, and every command talks to exactly one of them:
|
|
|
574
582
|
|
|
575
583
|
| Environment | API origin | Platform |
|
|
576
584
|
| --- | --- | --- |
|
|
577
|
-
| `production` | `https://api.
|
|
585
|
+
| `production` | `https://qinto-api.blotout.io` | `https://platform.blotout.io` |
|
|
578
586
|
| `sandbox` | `https://api.qinto.tech` | `https://portal.qinto.tech` |
|
|
579
587
|
|
|
580
588
|
`qinto env` picks one and remembers it, so nothing after it needs a flag:
|