@shenora/react 0.1.0 → 0.1.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Jiarong Gu
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Jiarong Gu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,91 +1,91 @@
-# @shenora/react
-
-React client for [Shenora](https://github.com/JiarongGu/Shenora) desktop hosts (.NET + WinForms +
-WebView2). The typed bridge between a React frontend and the Shenora host: correlated `invoke`
-with timeouts and structured errors, the event hub host notifications stream into, typed module
-services, React hooks, and a pluggable transport with a browser fallback so the UI can be
-developed in a plain browser. Headless by design — no UI components, bring your own design
-system. Versioned in lockstep with the `Shenora.*` NuGet packages.
-
-```ts
-import {
-  getBridge, useShenoraEvent, useShenoraQuery, BaseModuleService, createShenoraStore,
-} from '@shenora/react';
-
-// Once at startup, after your listeners are attached: it starts notification delivery (anything the
-// host buffered arrives in the first batch). Drop zones need no particular ordering against it — the
-// host clears them when a new DOCUMENT loads, not on this handshake.
-await getBridge().notifyReady();
-
-// a typed service per backend module:
-interface NoteRequests { GET_ALL: void; ADD: { title: string } }
-class NoteService extends BaseModuleService<NoteRequests> {
-  constructor() { super('NOTES'); }
-  getAll() { return this.send<Note[]>('GET_ALL'); }
-  add(title: string) { return this.send<Note>('ADD', { payload: { title } }); }
-}
-
-// in components:
-const { data, loading, refetch } = useShenoraQuery<Note[]>('NOTES', 'GET_ALL');
-useShenoraEvent<Note>('NOTES', 'ADDED', (note) => refetch());
-```
-
-Failed calls reject with `OperationError` — a structured `code` (an i18n key: translate
-`errors.{code}`) plus interpolation `parameters`, never raw host exception text.
-
-### Long-running work: post, then read a store
-
-`invoke` awaits a correlated reply and carries a timeout, and its handler's synchronous segment runs
-on the host's **UI thread** — so it is for calls that are quick and UI-thread-safe. Everything else
-posts and streams results back as events:
-
-```ts
-const useDeploy = createShenoraStore('DEPLOY', {
-  initial: { status: 'idle', lines: [] as string[] },
-  // Loaded on the FIRST subscriber, so a component that mounts mid-run isn't empty:
-  // events it missed cannot be replayed.
-  snapshot: { type: 'GET_STATE', apply: (s, d) => ({ ...s, ...(d as object) }) },
-  on: {
-    PROGRESS: (s, p: { line: string }) => ({ ...s, lines: [...s.lines, p.line] }),
-    ENDED: (s, p: { ok: boolean }) => ({ ...s, status: p.ok ? 'done' : 'failed' }),
-  },
-  actions: ({ post }) => ({ start: (cfg: unknown) => post('START', { payload: cfg }) }),
-});
-
-// any number of components share ONE subscription:
-const status = useDeploy((s) => s.status);
-useDeploy.actions.start({ env: 'prod' });
-```
-
-Use the **store for shared or long-lived state** and **`useShenoraEvent` for a one-off reaction in a
-single component**. A failed `post` has no promise to reject, so it is reported through the bridge's
-`onPostError` rather than vanishing — it is bridge-wide, so wire it once at startup
-(`getBridge()` takes no options):
-
-```ts
-configureBridge({ onPostError: (failure) => log.error(failure.module, failure.type, failure.error) });
-```
-
-### Observing the whole stream
-
-`useShenoraEvent` and `createShenoraStore` listen for an exact `(module, type)`. When the vocabulary
-isn't knowable up front — plug-in-contributed events, a diagnostics tap, or an adoption shim keeping
-a legacy "every host message" handler alive while features migrate one at a time — subscribe broadly
-instead. Both mirror the host's `IEventBus` and return an unsubscribe:
-
-```ts
-const off = eventBus.subscribeToAll((event) => log.debug(event.module, event.type, event.payload));
-eventBus.subscribeToModule('DEPLOY', (event) => audit(event));   // every type from one module
-```
-
-Delivery is narrowest-first — exact pair, then module, then catch-all — so a broad observer never
-runs ahead of the feature code it is observing. Prefer `subscribe` when you know the pair: a
-catch-all wakes for every event on the bus.
-
-Pure-UI development in a plain browser: pass a `fallback` to `configureBridge` (gated behind
-`import.meta.env.DEV`) to answer requests with canned data. Other shells (WebSocket,
-mobile/Capacitor) implement the small `ShenoraTransport` seam and speak the same envelopes.
-For CDP-driven testing, `installDevInterceptor()` records IPC/event traffic into ring buffers
-and exposes `window.__shenora.call()/waitEvent()`.
-
-MIT © Jiarong Gu
+# @shenora/react
+
+React client for [Shenora](https://github.com/JiarongGu/Shenora) desktop hosts (.NET + WinForms +
+WebView2). The typed bridge between a React frontend and the Shenora host: correlated `invoke`
+with timeouts and structured errors, the event hub host notifications stream into, typed module
+services, React hooks, and a pluggable transport with a browser fallback so the UI can be
+developed in a plain browser. Headless by design — no UI components, bring your own design
+system. Versioned in lockstep with the `Shenora.*` NuGet packages.
+
+```ts
+import {
+  getBridge, useShenoraEvent, useShenoraQuery, BaseModuleService, createShenoraStore,
+} from '@shenora/react';
+
+// Once at startup, after your listeners are attached: it starts notification delivery (anything the
+// host buffered arrives in the first batch). Drop zones need no particular ordering against it — the
+// host clears them when a new DOCUMENT loads, not on this handshake.
+await getBridge().notifyReady();
+
+// a typed service per backend module:
+interface NoteRequests { GET_ALL: void; ADD: { title: string } }
+class NoteService extends BaseModuleService<NoteRequests> {
+  constructor() { super('NOTES'); }
+  getAll() { return this.send<Note[]>('GET_ALL'); }
+  add(title: string) { return this.send<Note>('ADD', { payload: { title } }); }
+}
+
+// in components:
+const { data, loading, refetch } = useShenoraQuery<Note[]>('NOTES', 'GET_ALL');
+useShenoraEvent<Note>('NOTES', 'ADDED', (note) => refetch());
+```
+
+Failed calls reject with `OperationError` — a structured `code` (an i18n key: translate
+`errors.{code}`) plus interpolation `parameters`, never raw host exception text.
+
+### Long-running work: post, then read a store
+
+`invoke` awaits a correlated reply and carries a timeout, and its handler's synchronous segment runs
+on the host's **UI thread** — so it is for calls that are quick and UI-thread-safe. Everything else
+posts and streams results back as events:
+
+```ts
+const useDeploy = createShenoraStore('DEPLOY', {
+  initial: { status: 'idle', lines: [] as string[] },
+  // Loaded on the FIRST subscriber, so a component that mounts mid-run isn't empty:
+  // events it missed cannot be replayed.
+  snapshot: { type: 'GET_STATE', apply: (s, d) => ({ ...s, ...(d as object) }) },
+  on: {
+    PROGRESS: (s, p: { line: string }) => ({ ...s, lines: [...s.lines, p.line] }),
+    ENDED: (s, p: { ok: boolean }) => ({ ...s, status: p.ok ? 'done' : 'failed' }),
+  },
+  actions: ({ post }) => ({ start: (cfg: unknown) => post('START', { payload: cfg }) }),
+});
+
+// any number of components share ONE subscription:
+const status = useDeploy((s) => s.status);
+useDeploy.actions.start({ env: 'prod' });
+```
+
+Use the **store for shared or long-lived state** and **`useShenoraEvent` for a one-off reaction in a
+single component**. A failed `post` has no promise to reject, so it is reported through the bridge's
+`onPostError` rather than vanishing — it is bridge-wide, so wire it once at startup
+(`getBridge()` takes no options):
+
+```ts
+configureBridge({ onPostError: (failure) => log.error(failure.module, failure.type, failure.error) });
+```
+
+### Observing the whole stream
+
+`useShenoraEvent` and `createShenoraStore` listen for an exact `(module, type)`. When the vocabulary
+isn't knowable up front — plug-in-contributed events, a diagnostics tap, or an adoption shim keeping
+a legacy "every host message" handler alive while features migrate one at a time — subscribe broadly
+instead. Both mirror the host's `IEventBus` and return an unsubscribe:
+
+```ts
+const off = eventBus.subscribeToAll((event) => log.debug(event.module, event.type, event.payload));
+eventBus.subscribeToModule('DEPLOY', (event) => audit(event));   // every type from one module
+```
+
+Delivery is narrowest-first — exact pair, then module, then catch-all — so a broad observer never
+runs ahead of the feature code it is observing. Prefer `subscribe` when you know the pair: a
+catch-all wakes for every event on the bus.
+
+Pure-UI development in a plain browser: pass a `fallback` to `configureBridge` (gated behind
+`import.meta.env.DEV`) to answer requests with canned data. Other shells (WebSocket,
+mobile/Capacitor) implement the small `ShenoraTransport` seam and speak the same envelopes.
+For CDP-driven testing, `installDevInterceptor()` records IPC/event traffic into ring buffers
+and exposes `window.__shenora.call()/waitEvent()`.
+
+MIT © Jiarong Gu

package/package.json

@@ -1,61 +1,61 @@
-{
-  "name": "@shenora/react",
-  "version": "0.1.0",
-  "description": "React client for Shenora desktop hosts: correlated invoke/send/subscribe over the WebView2 bridge, typed module services, hooks, and a browser fallback for pure-UI development.",
-  "license": "MIT",
-  "author": "Jiarong Gu",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/JiarongGu/Shenora.git",
-    "directory": "src/Shenora.React"
-  },
-  "homepage": "https://github.com/JiarongGu/Shenora#readme",
-  "keywords": [
-    "shenora",
-    "webview2",
-    "desktop",
-    "ipc",
-    "react",
-    "winforms",
-    "dotnet"
-  ],
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "sideEffects": false,
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "npm run clean && tsc -p tsconfig.build.json",
-    "prepublishOnly": "npm run build",
-    "//typecheck": "The ONLY thing that type-checks the tests — `build` excludes them and vitest transpiles without checking, so `@ts-expect-error` assertions (which pin the typed-service generic) are inert without this. Run by dev.mjs verify.",
-    "typecheck": "tsc -p tsconfig.json",
-    "test": "vitest run",
-    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\""
-  },
-  "peerDependencies": {
-    "react": ">=18"
-  },
-  "devDependencies": {
-    "@testing-library/react": "^16.3.2",
-    "@types/react": "^19.2.17",
-    "jsdom": "^29.1.1",
-    "react": "^19.2.8",
-    "react-dom": "^19.2.8",
-    "typescript": "^5.9.0",
-    "vitest": "^3.2.0"
-  }
-}
+{
+  "name": "@shenora/react",
+  "version": "0.1.2",
+  "description": "React client for Shenora desktop hosts: correlated invoke/send/subscribe over the WebView2 bridge, typed module services, hooks, and a browser fallback for pure-UI development.",
+  "license": "MIT",
+  "author": "Jiarong Gu",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JiarongGu/Shenora.git",
+    "directory": "src/Shenora.React"
+  },
+  "homepage": "https://github.com/JiarongGu/Shenora#readme",
+  "keywords": [
+    "shenora",
+    "webview2",
+    "desktop",
+    "ipc",
+    "react",
+    "winforms",
+    "dotnet"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "//typecheck": "The ONLY thing that type-checks the tests — `build` excludes them and vitest transpiles without checking, so `@ts-expect-error` assertions (which pin the typed-service generic) are inert without this. Run by dev.mjs verify.",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\""
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.2.17",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "typescript": "^5.9.0",
+    "vitest": "^3.2.0"
+  }
+}