miakapi 4.0.0-alpha.1 → 4.0.0-alpha.2

package/README.md

@@ -11,11 +11,10 @@ client. It is currently an alpha while the Miakapp 4 stack is being completed.
 
 **Building a home with a coding agent?** Read
 [docs/agent-guide.md](docs/agent-guide.md) first. It covers the judgment the
-reference below does not: what the coordinator must authorize, why component
+reference below does not: what the coordinator must authorize, why app
 requirements and coordinator grants intersect silently, and which failures must
 never be retried. Start a home interface with the published CLI:
-`npx @miakapp/cli init --starter app`. [`templates/home`](templates/home) is an
-optional developer example that builds against this repository's sources.
+`npx @miakapp/cli init --starter app`.
 
 ## Coordinator requirements
 

package/dist/local.d.ts

@@ -0,0 +1,24 @@
+export type LocalFunction = (args: unknown) => unknown;
+export interface LocalServerOptions {
+    readonly home: {
+        readonly id: string;
+        readonly name: string;
+    };
+    /** The built app bundle (`dist/app.js`): a path or its contents. */
+    readonly artifact: string | Uint8Array;
+    readonly release?: string;
+    readonly state?: Readonly<Record<string, unknown>>;
+    readonly functions?: Readonly<Record<string, LocalFunction>>;
+    readonly port?: number;
+    readonly host?: string;
+    readonly token?: string;
+}
+export interface LocalServer {
+    /** Addresses a device on the network can open. */
+    readonly urls: readonly string[];
+    /** Merges values into the state and pushes them to open pages; `undefined` removes a path. */
+    set(values: Readonly<Record<string, unknown>>): void;
+    close(): Promise<void>;
+}
+export declare function serveLocal(options: LocalServerOptions): Promise<LocalServer>;
+//# sourceMappingURL=local.d.ts.map

package/dist/local.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.d.ts","sourceRoot":"","sources":["../src/local.ts"],"names":[],"mappings":"AAiBA,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9D,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IACvC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAC7D,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,kDAAkD;IAClD,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,8FAA8F;IAC9F,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IACrD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AA+ED,wBAAsB,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CA2FlF"}

package/dist/local.js

@@ -0,0 +1,185 @@
+/**
+ * Serves a home's app on the local network, without the relay or the internet.
+ *
+ * The coordinator process opens a small HTTP server. A device on the same
+ * network opens `http://<coordinator address>:<port>/`: the page installs the
+ * same `window.miakapp` the trusted shell installs, wired straight to this
+ * process (state over Server-Sent Events, calls over POST), then runs the
+ * published `app.js`. Nothing here needs Firebase or the control plane, so it
+ * keeps working when the home's internet link is down.
+ *
+ * Access: anyone on the network, or only holders of `token` when one is set
+ * (open the page once as `/?key=<token>`).
+ */
+import { readFileSync } from 'node:fs';
+import { createServer } from 'node:http';
+import { networkInterfaces } from 'node:os';
+const SHIM = `(() => {
+  const config = JSON.parse(document.getElementById('miakapp-local').textContent);
+  const key = new URLSearchParams(location.search).get('key') || '';
+  const query = key ? '?key=' + encodeURIComponent(key) : '';
+  let values = config.state;
+  let revision = 0;
+  let stale = false;
+  const listeners = new Set();
+  const snapshot = () => ({ values, revision, stale });
+  const emit = () => { for (const listener of listeners) listener(snapshot()); };
+  const events = new EventSource('/events' + query);
+  events.onmessage = (message) => { values = JSON.parse(message.data); revision += 1; stale = false; emit(); };
+  events.onerror = () => { stale = true; emit(); };
+  window.miakapp = {
+    abi: 'miakapp.app/1',
+    release: config.release,
+    home: config.home,
+    locale: navigator.language || 'en',
+    theme: 'system',
+    onThemeChange: () => () => {},
+    state: {
+      get: (path) => values[path],
+      values: () => values,
+      get revision() { return revision; },
+      get stale() { return stale; },
+      subscribe: (listener) => { listeners.add(listener); return () => listeners.delete(listener); },
+    },
+    can: { read: () => true, call: (name) => config.functions.includes(name) },
+    async call(name, args, options) {
+      const controller = new AbortController();
+      const timer = setTimeout(() => controller.abort(), (options && options.timeoutMs) || 15000);
+      try {
+        const response = await fetch('/call' + query, {
+          method: 'POST',
+          headers: { 'content-type': 'application/json' },
+          body: JSON.stringify({ name, args: args === undefined ? null : args }),
+          signal: controller.signal,
+        });
+        const body = await response.json();
+        if (!response.ok) throw Object.assign(new Error(body.code), { code: body.code });
+        return body.result;
+      } catch (error) {
+        if (error && error.code) throw error;
+        throw Object.assign(new Error('timeout'), { code: controller.signal.aborted ? 'timeout' : 'unavailable' });
+      } finally {
+        clearTimeout(timer);
+      }
+    },
+    ready() {},
+  };
+})();`;
+function escapeJson(value) {
+    return JSON.stringify(value).replace(/</g, '\\u003c');
+}
+function lanUrls(port) {
+    const urls = [`http://localhost:${port}/`];
+    for (const addresses of Object.values(networkInterfaces())) {
+        for (const address of addresses ?? []) {
+            if (address.family === 'IPv4' && !address.internal)
+                urls.push(`http://${address.address}:${port}/`);
+        }
+    }
+    return urls;
+}
+async function readJson(request) {
+    const chunks = [];
+    let size = 0;
+    for await (const chunk of request) {
+        size += chunk.byteLength;
+        if (size > 1_048_576)
+            throw new Error('Body too large');
+        chunks.push(chunk);
+    }
+    return JSON.parse(Buffer.concat(chunks).toString('utf8'));
+}
+export async function serveLocal(options) {
+    const artifact = typeof options.artifact === 'string'
+        ? readFileSync(options.artifact)
+        : Buffer.from(options.artifact);
+    const functions = options.functions ?? {};
+    let state = { ...(options.state ?? {}) };
+    const streams = new Set();
+    const port = options.port ?? 8787;
+    const send = (response, status, type, body) => {
+        response.writeHead(status, { 'content-type': type, 'cache-control': 'no-store' });
+        response.end(body);
+    };
+    const server = createServer((request, response) => {
+        const url = new URL(request.url ?? '/', 'http://local');
+        if (options.token !== undefined && url.searchParams.get('key') !== options.token) {
+            send(response, 401, 'text/plain; charset=utf-8', 'Open this page with ?key=<token>.');
+            return;
+        }
+        if (request.method === 'GET' && url.pathname === '/') {
+            const config = {
+                home: options.home,
+                release: options.release ?? 'local',
+                state,
+                functions: Object.keys(functions),
+            };
+            send(response, 200, 'text/html; charset=utf-8', `<!doctype html>
+<html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1">
+<title>${options.home.name.replace(/[<&]/g, '')}</title></head>
+<body><script type="application/json" id="miakapp-local">${escapeJson(config)}</script>
+<script>${SHIM}</script><script src="/app.js${url.search}"></script></body></html>`);
+            return;
+        }
+        if (request.method === 'GET' && url.pathname === '/app.js') {
+            send(response, 200, 'application/javascript; charset=utf-8', artifact);
+            return;
+        }
+        if (request.method === 'GET' && url.pathname === '/events') {
+            response.writeHead(200, {
+                'content-type': 'text/event-stream',
+                'cache-control': 'no-store',
+                connection: 'keep-alive',
+            });
+            response.write(`data: ${JSON.stringify(state)}\n\n`);
+            streams.add(response);
+            request.on('close', () => streams.delete(response));
+            return;
+        }
+        if (request.method === 'POST' && url.pathname === '/call') {
+            void (async () => {
+                try {
+                    const { name, args } = await readJson(request);
+                    const handler = typeof name === 'string' ? functions[name] : undefined;
+                    if (handler === undefined) {
+                        send(response, 403, 'application/json', JSON.stringify({ code: 'denied' }));
+                        return;
+                    }
+                    const result = await handler(args);
+                    send(response, 200, 'application/json', JSON.stringify({ result: result ?? null }));
+                }
+                catch {
+                    send(response, 500, 'application/json', JSON.stringify({ code: 'failed' }));
+                }
+            })();
+            return;
+        }
+        send(response, 404, 'text/plain; charset=utf-8', 'Not found');
+    });
+    await new Promise((resolve, reject) => {
+        server.once('error', reject);
+        server.listen(port, options.host ?? '0.0.0.0', () => resolve());
+    });
+    return {
+        urls: lanUrls(port),
+        set(values) {
+            const next = { ...state };
+            for (const [path, value] of Object.entries(values)) {
+                if (value === undefined)
+                    delete next[path];
+                else
+                    next[path] = value;
+            }
+            state = next;
+            const frame = `data: ${JSON.stringify(state)}\n\n`;
+            for (const stream of streams)
+                stream.write(frame);
+        },
+        close() {
+            for (const stream of streams)
+                stream.end();
+            return new Promise((resolve) => server.close(() => resolve()));
+        },
+    };
+}
+//# sourceMappingURL=local.js.map

package/dist/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../src/local.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,YAAY,EAA6C,MAAM,WAAW,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAwB5C,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAkDP,CAAC;AAEP,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,OAAO,CAAC,IAAY;IAC3B,MAAM,IAAI,GAAG,CAAC,oBAAoB,IAAI,GAAG,CAAC,CAAC;IAC3C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC;QAC3D,KAAK,MAAM,OAAO,IAAI,SAAS,IAAI,EAAE,EAAE,CAAC;YACtC,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ;gBAAE,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,CAAC,OAAO,IAAI,IAAI,GAAG,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,OAAwB;IAC9C,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAgC,EAAE,CAAC;QAC3D,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;QACzB,IAAI,IAAI,GAAG,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACxD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAA2B;IAC1D,MAAM,QAAQ,GAAG,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ;QACnD,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC;QAChC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;IAC1C,IAAI,KAAK,GAA4B,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;IAClE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC;IAElC,MAAM,IAAI,GAAG,CAAC,QAAwB,EAAE,MAAc,EAAE,IAAY,EAAE,IAAqB,EAAE,EAAE;QAC7F,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC;QAClF,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QAChD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,EAAE,cAAc,CAAC,CAAC;QACxD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC;YACjF,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,2BAA2B,EAAE,mCAAmC,CAAC,CAAC;YACtF,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;YACrD,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO;gBACnC,KAAK;gBACL,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aAClC,CAAC;YACF,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,0BAA0B,EAAE;;SAE7C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;2DACY,UAAU,CAAC,MAAM,CAAC;UACnE,IAAI,gCAAgC,GAAG,CAAC,MAAM,2BAA2B,CAAC,CAAC;YAC/E,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3D,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,uCAAuC,EAAE,QAAQ,CAAC,CAAC;YACvE,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3D,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE;gBACtB,cAAc,EAAE,mBAAmB;gBACnC,eAAe,EAAE,UAAU;gBAC3B,UAAU,EAAE,YAAY;aACzB,CAAC,CAAC;YACH,QAAQ,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACtB,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YACpD,OAAO;QACT,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC1D,KAAK,CAAC,KAAK,IAAI,EAAE;gBACf,IAAI,CAAC;oBACH,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAuC,CAAC;oBACrF,MAAM,OAAO,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;oBACvE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;wBAC1B,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;wBAC5E,OAAO;oBACT,CAAC;oBACD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;oBACnC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;gBACtF,CAAC;gBAAC,MAAM,CAAC;oBACP,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YACL,OAAO;QACT,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,2BAA2B,EAAE,WAAW,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,SAAS,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC;QACnB,GAAG,CAAC,MAAM;YACR,MAAM,IAAI,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;YAC1B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnD,IAAI,KAAK,KAAK,SAAS;oBAAE,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;;oBACtC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YAC1B,CAAC;YACD,KAAK,GAAG,IAAI,CAAC;YACb,MAAM,KAAK,GAAG,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;YACnD,KAAK,MAAM,MAAM,IAAI,OAAO;gBAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;QACD,KAAK;YACH,KAAK,MAAM,MAAM,IAAI,OAAO;gBAAE,MAAM,CAAC,GAAG,EAAE,CAAC;YAC3C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACjE,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miakapi",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-alpha.2",
   "description": "Typed coordinator and trusted-browser SDK for Miakapp",
   "type": "module",
   "packageManager": "bun@1.2.23",
@@ -19,6 +19,10 @@
     "./browser": {
       "types": "./dist/browser.d.ts",
       "import": "./dist/browser.js"
+    },
+    "./local": {
+      "types": "./dist/local.d.ts",
+      "import": "./dist/local.js"
     }
   },
   "files": [
@@ -33,9 +37,7 @@
     "build:contract": "tsc -p tsconfig.contract.json",
     "check": "bun run typecheck && bun run build && bun run test && bun run smoke:node && bun run smoke:browser && bun run test:contract && bun run pack:check",
     "check:cli": "bun --filter @miakapp/cli check",
-    "check:component": "bun --filter @miakapp/component check",
-    "check:packages": "bun run check:cli && bun run check:component && bun run check:app && bun run check:template",
-    "check:template": "bun run build && bun --filter @miakapp/component build && bun --filter @miakapp/app build && bun --filter @miakapp/cli build && cd templates/home && rm -rf node_modules && bun install --frozen-lockfile && bun run check",
+    "check:packages": "bun run check:cli && bun run check:app",
     "pack:check": "npm pack --dry-run",
     "prepublishOnly": "bun run check",
     "smoke:browser": "node scripts/check-browser-bundle.mjs",