@kehto/paja 0.1.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/README.md ADDED
@@ -0,0 +1,61 @@
1
+ # @kehto/paja
2
+
3
+ Single-window development runtime for local napplet authoring.
4
+
5
+ The runtime is designed to be used from a napplet package script:
6
+
7
+ ```json
8
+ {
9
+ "scripts": {
10
+ "dev": "kehto paja --target-url http://127.0.0.1:5173 -- pnpm vite --host 127.0.0.1"
11
+ }
12
+ }
13
+ ```
14
+
15
+ The target URL is explicit on purpose. Kehto can spawn any framework command and
16
+ wait for that URL, but it does not guess which URL the framework chose. Loading
17
+ that URL directly in the runtime iframe preserves the app's own HMR behavior
18
+ without Vite, Svelte, React, or any other framework lock-in.
19
+
20
+ The package provides the typed option model, CLI parser, runtime server, minimal
21
+ host page, and host config surface. The browser host keeps one iframe with a
22
+ reload loop and wires that frame through a real
23
+ `ShellBridge`, `@kehto/runtime`, and deterministic development service adapters
24
+ for the current web NAP surface: relay/outbox, storage, identity, keys, config,
25
+ resource, theme, notify, media, upload, intent, cvm, and inc. `shell` is the
26
+ mandatory handshake domain; the deprecated legacy package path remains an
27
+ upstream compatibility alias to `inc`.
28
+
29
+ Environment simulation can be supplied through CLI flags or a JSON config file:
30
+
31
+ ```bash
32
+ kehto paja \
33
+ --target-url http://127.0.0.1:5173 \
34
+ --identity-mode fixed \
35
+ --identity-pubkey 4444444444444444444444444444444444444444444444444444444444444444 \
36
+ --relay-mode disabled \
37
+ --capability relay:off \
38
+ --capability outbox:off \
39
+ --theme light \
40
+ --config-value 'density="compact"'
41
+ ```
42
+
43
+ ```json
44
+ {
45
+ "targetUrl": "http://127.0.0.1:5173",
46
+ "simulation": {
47
+ "identity": {
48
+ "mode": "fixed",
49
+ "pubkey": "4444444444444444444444444444444444444444444444444444444444444444"
50
+ },
51
+ "relay": { "mode": "disabled" },
52
+ "capabilities": { "domains": { "relay": false, "outbox": false } },
53
+ "theme": { "mode": "light" },
54
+ "config": { "values": { "density": "compact" } }
55
+ }
56
+ }
57
+ ```
58
+
59
+ Full package docs: [`docs/packages/paja.md`](../../docs/packages/paja.md).
60
+ Local authoring how-to: [`docs/how-tos/paja-local-authoring.md`](../../docs/how-tos/paja-local-authoring.md).
61
+ Generated API module: `docs/api/modules/_kehto_paja.html` (run `pnpm docs:api`).