@bridgething/client 0.1.6 → 0.2.0

package/dist/settings.d.ts

@@ -0,0 +1,67 @@
+import type { ConfigEntry, ConfigField, DocEntry } from '@bridgething/lib';
+export type { ConfigEntry, ConfigField, DocEntry } from '@bridgething/lib';
+/** Identity of the webapp whose settings page is being rendered. */
+export type SettingsContext = {
+    webappId: string;
+    name: string;
+    version: string;
+    deviceId: string;
+};
+/** A config or doc key/value after a write; `value` is null when reset to no value. */
+export type KeyValue = {
+    key: string;
+    value: string | null;
+};
+/** Callback for unsolicited doc changes pushed by the host. */
+export type DocChangedListener = (key: string, value: string | null) => void;
+declare global {
+    interface Window {
+        ReactNativeWebView?: {
+            postMessage: (json: string) => void;
+        };
+        __bridgethingSettingsDeliver?: (json: string) => void;
+    }
+}
+/**
+ * Bridge a webapp settings page to its host inside the bridgething companion
+ * app. Speaks the React-Native WebView `postMessage` protocol, not a
+ * WebSocket; the host delivers replies through a global installed at import.
+ *
+ * Network caveat: the page runs on the phone with real internet, but from a
+ * `file://` origin, so the webview enforces CORS on fetch/XHR (requests carry
+ * `Origin: null`). Websocket APIs are not CORS-gated and work out of the box;
+ * prefer them. For a CORS-strict HTTP-only service, fetch from the on-device
+ * webapp via `client.net` (phone-tunneled, not origin-restricted) instead.
+ */
+export declare const settings: {
+    /** Identity of the webapp and device this settings page is scoped to. */
+    context(): Promise<SettingsContext>;
+    config: {
+        /** The config schema the webapp declared in its manifest. */
+        fields(): Promise<ConfigField[]>;
+        /** Current config values (declared defaults plus user overrides). */
+        list(): Promise<ConfigEntry[]>;
+        /** Set a config value; resolves with the stored key/value. */
+        set(key: string, value: string): Promise<KeyValue>;
+        /** Clear a config override; resolves with the restored default or null. */
+        delete(key: string): Promise<KeyValue>;
+    };
+    doc: {
+        /** Read one doc value; resolves with null when unset. */
+        get(key: string): Promise<KeyValue>;
+        /** List every doc key/value in the webapp's namespace. */
+        list(): Promise<DocEntry[]>;
+        /** Write one doc value, readable by both the webapp and companion. */
+        set(key: string, value: string): Promise<KeyValue>;
+        /** Delete one doc value; resolves with a null value. */
+        delete(key: string): Promise<{
+            key: string;
+            value: null;
+        }>;
+    };
+    /** Subscribe to host-pushed doc changes; returns an unsubscribe function. */
+    onDocChanged(listener: DocChangedListener): () => void;
+    /** Signal the host to close the settings webview. Fire-and-forget. */
+    done(): void;
+};
+//# sourceMappingURL=settings.d.ts.map

package/dist/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE3E,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAK3E,oEAAoE;AACpE,MAAM,MAAM,eAAe,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpG,uFAAuF;AACvF,MAAM,MAAM,QAAQ,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAE7D,+DAA+D;AAC/D,MAAM,MAAM,kBAAkB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;AAW7E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,kBAAkB,CAAC,EAAE;YAAE,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;SAAE,CAAC;QAC7D,4BAA4B,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;KACvD;CACF;AAmDD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ;IACnB,yEAAyE;eAC9D,OAAO,CAAC,eAAe,CAAC;;QAIjC,6DAA6D;kBACnD,OAAO,CAAC,WAAW,EAAE,CAAC;QAGhC,qEAAqE;gBAC7D,OAAO,CAAC,WAAW,EAAE,CAAC;QAG9B,8DAA8D;iBACrD,MAAM,SAAS,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;QAGlD,2EAA2E;oBAC/D,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;;;QAKtC,yDAAyD;iBAChD,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;QAGnC,0DAA0D;gBAClD,OAAO,CAAC,QAAQ,EAAE,CAAC;QAG3B,sEAAsE;iBAC7D,MAAM,SAAS,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;QAGlD,wDAAwD;oBAC5C,MAAM,GAAG,OAAO,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,IAAI,CAAA;SAAE,CAAC;;IAI5D,6EAA6E;2BACtD,kBAAkB,GAAG,MAAM,IAAI;IAItD,sEAAsE;YAC9D,IAAI;CAKb,CAAC"}

package/dist/settings.js

@@ -0,0 +1,118 @@
+const CALL_TIMEOUT_MS = 15_000;
+const HOST_MISSING = 'not running inside the bridgething companion settings host (window.ReactNativeWebView is absent)';
+let nextId = 1;
+const pending = new Map();
+const docListeners = new Set();
+function deliver(json) {
+    let parsed;
+    try {
+        parsed = JSON.parse(json);
+    }
+    catch {
+        return;
+    }
+    if ('event' in parsed && parsed.event === 'docChanged') {
+        for (const listener of docListeners)
+            listener(parsed.key, parsed.value);
+        return;
+    }
+    const reply = parsed;
+    const entry = pending.get(reply.id);
+    if (!entry)
+        return;
+    pending.delete(reply.id);
+    clearTimeout(entry.timer);
+    if (reply.ok)
+        entry.resolve(reply.value);
+    else
+        entry.reject(new Error(reply.error));
+}
+if (typeof window !== 'undefined')
+    window.__bridgethingSettingsDeliver = deliver;
+function call(verb, payload) {
+    const host = typeof window !== 'undefined' ? window.ReactNativeWebView : undefined;
+    if (!host)
+        return Promise.reject(new Error(HOST_MISSING));
+    const id = nextId++;
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => {
+            if (pending.delete(id))
+                reject(new Error(`bridgething settings call '${verb}' timed out after ${CALL_TIMEOUT_MS}ms`));
+        }, CALL_TIMEOUT_MS);
+        pending.set(id, { resolve: resolve, reject, timer });
+        try {
+            host.postMessage(JSON.stringify({ id, verb, payload }));
+        }
+        catch (err) {
+            pending.delete(id);
+            clearTimeout(timer);
+            reject(err instanceof Error ? err : new Error(String(err)));
+        }
+    });
+}
+/**
+ * Bridge a webapp settings page to its host inside the bridgething companion
+ * app. Speaks the React-Native WebView `postMessage` protocol, not a
+ * WebSocket; the host delivers replies through a global installed at import.
+ *
+ * Network caveat: the page runs on the phone with real internet, but from a
+ * `file://` origin, so the webview enforces CORS on fetch/XHR (requests carry
+ * `Origin: null`). Websocket APIs are not CORS-gated and work out of the box;
+ * prefer them. For a CORS-strict HTTP-only service, fetch from the on-device
+ * webapp via `client.net` (phone-tunneled, not origin-restricted) instead.
+ */
+export const settings = {
+    /** Identity of the webapp and device this settings page is scoped to. */
+    context() {
+        return call('context');
+    },
+    config: {
+        /** The config schema the webapp declared in its manifest. */
+        fields() {
+            return call('config.fields');
+        },
+        /** Current config values (declared defaults plus user overrides). */
+        list() {
+            return call('config.list');
+        },
+        /** Set a config value; resolves with the stored key/value. */
+        set(key, value) {
+            return call('config.set', { key, value });
+        },
+        /** Clear a config override; resolves with the restored default or null. */
+        delete(key) {
+            return call('config.delete', { key });
+        },
+    },
+    doc: {
+        /** Read one doc value; resolves with null when unset. */
+        get(key) {
+            return call('doc.get', { key });
+        },
+        /** List every doc key/value in the webapp's namespace. */
+        list() {
+            return call('doc.list');
+        },
+        /** Write one doc value, readable by both the webapp and companion. */
+        set(key, value) {
+            return call('doc.set', { key, value });
+        },
+        /** Delete one doc value; resolves with a null value. */
+        delete(key) {
+            return call('doc.delete', { key });
+        },
+    },
+    /** Subscribe to host-pushed doc changes; returns an unsubscribe function. */
+    onDocChanged(listener) {
+        docListeners.add(listener);
+        return () => docListeners.delete(listener);
+    },
+    /** Signal the host to close the settings webview. Fire-and-forget. */
+    done() {
+        const host = typeof window !== 'undefined' ? window.ReactNativeWebView : undefined;
+        if (!host)
+            throw new Error(HOST_MISSING);
+        host.postMessage(JSON.stringify({ id: nextId++, verb: 'done' }));
+    },
+};
+//# sourceMappingURL=settings.js.map

package/dist/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAIA,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,MAAM,YAAY,GAAG,kGAAkG,CAAC;AA2BxH,IAAI,MAAM,GAAG,CAAC,CAAC;AACf,MAAM,OAAO,GAAG,IAAI,GAAG,EAAmB,CAAC;AAC3C,MAAM,YAAY,GAAG,IAAI,GAAG,EAAsB,CAAC;AAEnD,SAAS,OAAO,CAAC,IAAY;IAC3B,IAAI,MAA6B,CAAC;IAClC,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAA0B,CAAC;IACrD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;IAED,IAAI,OAAO,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,KAAK,YAAY,EAAE,CAAC;QACvD,KAAK,MAAM,QAAQ,IAAI,YAAY;YAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACxE,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAG,MAAmB,CAAC;IAClC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACpC,IAAI,CAAC,KAAK;QAAE,OAAO;IACnB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,IAAI,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;;QACpC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,IAAI,OAAO,MAAM,KAAK,WAAW;IAAE,MAAM,CAAC,4BAA4B,GAAG,OAAO,CAAC;AAEjF,SAAS,IAAI,CAAI,IAAY,EAAE,OAAiB;IAC9C,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;IACnF,IAAI,CAAC,IAAI;QAAE,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAE1D,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IACpB,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,KAAK,CAAC,8BAA8B,IAAI,qBAAqB,eAAe,IAAI,CAAC,CAAC,CAAC;QAClG,CAAC,EAAE,eAAe,CAAC,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,OAAmC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACjF,IAAI,CAAC;YACH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC1D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACnB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,yEAAyE;IACzE,OAAO;QACL,OAAO,IAAI,CAAkB,SAAS,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,EAAE;QACN,6DAA6D;QAC7D,MAAM;YACJ,OAAO,IAAI,CAAgB,eAAe,CAAC,CAAC;QAC9C,CAAC;QACD,qEAAqE;QACrE,IAAI;YACF,OAAO,IAAI,CAAgB,aAAa,CAAC,CAAC;QAC5C,CAAC;QACD,8DAA8D;QAC9D,GAAG,CAAC,GAAW,EAAE,KAAa;YAC5B,OAAO,IAAI,CAAW,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,2EAA2E;QAC3E,MAAM,CAAC,GAAW;YAChB,OAAO,IAAI,CAAW,eAAe,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAClD,CAAC;KACF;IACD,GAAG,EAAE;QACH,yDAAyD;QACzD,GAAG,CAAC,GAAW;YACb,OAAO,IAAI,CAAW,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,0DAA0D;QAC1D,IAAI;YACF,OAAO,IAAI,CAAa,UAAU,CAAC,CAAC;QACtC,CAAC;QACD,sEAAsE;QACtE,GAAG,CAAC,GAAW,EAAE,KAAa;YAC5B,OAAO,IAAI,CAAW,SAAS,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;QACnD,CAAC;QACD,wDAAwD;QACxD,MAAM,CAAC,GAAW;YAChB,OAAO,IAAI,CAA+B,YAAY,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACnE,CAAC;KACF;IACD,6EAA6E;IAC7E,YAAY,CAAC,QAA4B;QACvC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IACD,sEAAsE;IACtE,IAAI;QACF,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;QACnF,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACnE,CAAC;CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bridgething/client",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Typed client SDK a bridgething webapp uses to talk to the on-device daemon on a Spotify Car Thing.",
   "license": "MIT",
   "author": "Joey Eamigh <55670930+JoeyEamigh@users.noreply.github.com> (https://github.com/JoeyEamigh)",
@@ -24,6 +24,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./settings": {
+      "types": "./dist/settings.d.ts",
+      "default": "./dist/settings.js"
     }
   },
   "files": ["dist"],
@@ -35,7 +39,7 @@
     "lint": "eslint ."
   },
   "dependencies": {
-    "@bridgething/lib": "0.1.6"
+    "@bridgething/lib": "0.2.0"
   },
   "peerDependencies": {
     "typescript": "^6.0.3"