@pedit/serve 0.0.0-stage → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kobaken
+
+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,3 +1,108 @@
-# Temporary Holding Version
+# @pedit/serve
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run [`pedit serve`](https://github.com/piconic-ai/pedit) for a local app. pedit holds one file's Yjs
+document and writes the file; this package starts it, checks every request, and bridges a browser's
+WebSocket to pedit's Unix socket. Your page edits the file live, with several pages at once, and
+there is no room, relay or account.
+
+Experimental (0.x): the API may change. The package is published with every pedit release and
+carries the same version number; the pedit it needs is listed below.
+
+## Requirements
+
+- pedit 0.4.0 or later on the PATH (or pass `bin`). Older ones are refused with a message on how to update.
+- Node 22 or later, on macOS or Linux (Unix sockets; not Windows).
+
+## Install
+
+```sh
+npm install @pedit/serve yjs y-protocols y-websocket   # the browser client's peers
+npm install hono @hono/node-server @hono/node-ws       # for the Hono routes
+```
+
+`@pedit/serve/client` needs `yjs`, `y-protocols` and `y-websocket`; `@pedit/serve/hono` needs `hono`.
+They are peers, so your app keeps one copy of Yjs.
+
+## Server
+
+```js
+import { serve } from '@hono/node-server'
+import { createNodeWebSocket } from '@hono/node-ws'
+import { peditRoutes } from '@pedit/serve/hono'
+import { Hono } from 'hono'
+
+const app = new Hono()
+const { injectWebSocket, upgradeWebSocket } = createNodeWebSocket({ app })
+const server = serve({ fetch: app.fetch, port: 3000, hostname: '127.0.0.1' })
+const routes = peditRoutes({
+  upgradeWebSocket,
+  root: '/home/me/notes', // only files under it are served
+  origins: ['http://127.0.0.1:3000'],
+  app: 'my-app',
+  resolve: async (id) => (id === 'todo' ? { path: '/home/me/notes/todo.md', role: 'edit' } : null),
+})
+app.route('/edit', routes)
+injectWebSocket(server)
+process.on('SIGINT', () => routes.close().finally(() => process.exit(0)))
+```
+
+## Browser
+
+```js
+import { connect } from '@pedit/serve/client'
+import { yCollab } from 'y-codemirror.next'
+
+const conn = await connect('/edit', 'todo', { name: 'Ann' })
+conn.status.subscribe((status, error) => {
+  if (error?.code === 'gone') showReload() // your UI
+})
+const extensions = [yCollab(conn.text, conn.awareness)] // plus basicSetup, EditorState.readOnly for 'read'
+```
+
+## API
+
+`@pedit/serve/hono`
+
+| Export | |
+| --- | --- |
+| `peditRoutes(options)` | A Hono app: `POST /:id/session` and the WebSocket `GET /:id/doc`. Has `close()`. |
+| `options.resolve(id, c)` | Maps an id to `{ path, role: 'edit' \| 'read' }`, or `null` for 404. |
+| `options.root`, `origins`, `app` | The served directory, the exact page origins, and a label shown if another process holds the file. |
+| `options.bin`, `idleMs`, `allowRemote`, `onEvent` | Absolute path to pedit; idle stop (default 60 s); accept non-loopback peers (default false); `started`/`stopped`/`error` events. |
+
+`@pedit/serve/client`
+
+| Export | |
+| --- | --- |
+| `connect(base, id, { name, color })` | Resolves after the first sync with `{ doc, text, awareness, role, status, synced, destroy }`. |
+| `conn.status` | `get()` and `subscribe(cb)`; states `connecting`, `connected`, `reconnecting`, `closed`. |
+| `PeditError.code` | `not-found`, `held`, `busy`, `forbidden`, `gone`, `unavailable`. |
+
+`@pedit/serve`
+
+| Export | |
+| --- | --- |
+| `ServedFiles` | The layer below the routes: `acquire(path)` starts or reuses a child, `close()` ends all. |
+| `resolvePedit({ bin })`, `MIN_PEDIT_VERSION` | Finds pedit, checks the binary and its version. |
+| `HeldError`, `LimitError`, `NoPeditError` | Another process serves the file; 32 files or 8 clients; pedit missing or too old. |
+
+## Security model
+
+- One hook, `resolve`, decides which ids exist and their role. Every other request is refused by default.
+- Files must be under `root` (realpath checked); ids are `[A-Za-z0-9_-]` only.
+- Host and Origin must match `origins`, and peers must be on loopback unless `allowRemote` is set.
+- A session token is single use and expires in 60 s; it travels in the WebSocket URL, so log no `token`.
+- A `read` role is enforced by pedit itself, not just by the page: updates from a reader close the socket.
+- The browser never sees a path, a pid or a socket name.
+
+## Known limits
+
+- Unix only; one id is one file; at most 32 files and 8 clients per file.
+- Awareness (names, cursors) is unauthenticated: any connected page can claim any name.
+- `gone`: pedit's saved state was discarded, so the page's copy cannot merge into the new document.
+  The client stops; the app decides whether to offer the text or reload.
+- Don't write the file yourself while a page is connected.
+
+Design: [docs/design/serve.md](https://github.com/piconic-ai/pedit/blob/main/docs/design/serve.md).
+Sample: [examples/serve-app](https://github.com/piconic-ai/pedit/tree/main/examples/serve-app).
+MIT license.

package/dist/bridge.d.ts

@@ -0,0 +1,13 @@
+import type { Role } from './types.ts';
+export declare const MAX_FRAME: number;
+export interface Bridge {
+    /** page -> pedit. A frame over 16 MiB closes the bridge. */
+    send(frame: Uint8Array): void;
+    /** pedit -> page (single handler). Frames that arrive before it is set are held. */
+    onframe: ((frame: Uint8Array) => void) | null;
+    /** `code` is pedit's close code, passed through (1005/1006 when it gave none). */
+    onclose: ((reason: string, code?: number) => void) | null;
+    close(): void;
+}
+/** Dial the child's socket. `ws+unix://` URLs break on paths with spaces, so hand ws the connection. */
+export declare function dialSocket(socketPath: string, role: Role, onGone: () => void): Promise<Bridge>;

package/dist/bridge.js

@@ -0,0 +1,87 @@
+import { connect } from 'node:net';
+import { WebSocket } from 'ws';
+export const MAX_FRAME = 16 * 1024 * 1024;
+/** Dial the child's socket. `ws+unix://` URLs break on paths with spaces, so hand ws the connection. */
+export async function dialSocket(socketPath, role, onGone) {
+    const ws = new WebSocket('ws://pedit/', {
+        createConnection: () => connect(socketPath),
+        headers: role === 'read' ? { 'X-Pedit-Role': 'read' } : {},
+        perMessageDeflate: false,
+        maxPayload: 4 * MAX_FRAME,
+        handshakeTimeout: 5000,
+    });
+    let handler = null;
+    const held = [];
+    let heldBytes = 0;
+    let closeHandler = null;
+    let ended;
+    let opened = false;
+    let closing = false;
+    const bridge = {
+        send(frame) {
+            if (ws.readyState !== WebSocket.OPEN)
+                return;
+            if (frame.byteLength > MAX_FRAME)
+                return ws.close(1009, 'frame too large');
+            ws.send(frame, { binary: true });
+            if (ws.bufferedAmount > MAX_FRAME)
+                ws.close(1013, 'too slow');
+        },
+        get onframe() {
+            return handler;
+        },
+        set onframe(fn) {
+            handler = fn;
+            heldBytes = 0;
+            if (fn)
+                for (const f of held.splice(0))
+                    fn(f);
+        },
+        get onclose() {
+            return closeHandler;
+        },
+        set onclose(fn) {
+            closeHandler = fn;
+            if (fn && ended)
+                fn(ended.reason, ended.code);
+        },
+        close() {
+            if (closing)
+                return;
+            closing = true;
+            ws.close(1000);
+            // Do not wait for a stuck peer to answer: the slot must come back.
+            setTimeout(() => ws.terminate(), 2000).unref();
+        },
+    };
+    ws.on('message', (data) => {
+        const frame = Array.isArray(data) ? Buffer.concat(data) : new Uint8Array(data);
+        if (handler)
+            return handler(frame);
+        held.push(frame);
+        heldBytes += frame.byteLength;
+        if (heldBytes > MAX_FRAME)
+            ws.close(1013, 'no reader');
+    });
+    ws.on('close', (code, reason) => {
+        if (!opened || ended)
+            return;
+        ended = { reason: reason.toString(), code };
+        onGone();
+        closeHandler?.(ended.reason, ended.code);
+    });
+    // Listen before waiting for the open: pedit's first frame can arrive in the same tick.
+    await new Promise((resolve, reject) => {
+        ws.once('open', resolve);
+        ws.once('error', reject);
+        ws.once('unexpected-response', () => reject(new Error('pedit refused the connection')));
+    });
+    opened = true;
+    ws.removeAllListeners('error');
+    ws.on('error', () => ws.terminate());
+    // A close in the same tick as the open came before `opened` was set.
+    if (ws.readyState === WebSocket.CLOSED)
+        ws.emit('close', 1006, Buffer.alloc(0));
+    return bridge;
+}
+//# sourceMappingURL=bridge.js.map

package/dist/bridge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridge.js","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAA;AAG9B,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAA;AAYzC,wGAAwG;AACxG,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,UAAkB,EAClB,IAAU,EACV,MAAkB;IAElB,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,aAAa,EAAE;QACtC,gBAAgB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC;QAC3C,OAAO,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE;QAC1D,iBAAiB,EAAE,KAAK;QACxB,UAAU,EAAE,CAAC,GAAG,SAAS;QACzB,gBAAgB,EAAE,IAAI;KACvB,CAAC,CAAA;IACF,IAAI,OAAO,GAAsB,IAAI,CAAA;IACrC,MAAM,IAAI,GAAiB,EAAE,CAAA;IAC7B,IAAI,SAAS,GAAG,CAAC,CAAA;IACjB,IAAI,YAAY,GAAsB,IAAI,CAAA;IAC1C,IAAI,KAAmD,CAAA;IACvD,IAAI,MAAM,GAAG,KAAK,CAAA;IAClB,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,MAAM,MAAM,GAAW;QACrB,IAAI,CAAC,KAAK;YACR,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI;gBAAE,OAAM;YAC5C,IAAI,KAAK,CAAC,UAAU,GAAG,SAAS;gBAAE,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAA;YAC1E,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;YAChC,IAAI,EAAE,CAAC,cAAc,GAAG,SAAS;gBAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,OAAO;YACT,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,IAAI,OAAO,CAAC,EAAE;YACZ,OAAO,GAAG,EAAE,CAAA;YACZ,SAAS,GAAG,CAAC,CAAA;YACb,IAAI,EAAE;gBAAE,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;oBAAE,EAAE,CAAC,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,IAAI,OAAO;YACT,OAAO,YAAY,CAAA;QACrB,CAAC;QACD,IAAI,OAAO,CAAC,EAAE;YACZ,YAAY,GAAG,EAAE,CAAA;YACjB,IAAI,EAAE,IAAI,KAAK;gBAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAC/C,CAAC;QACD,KAAK;YACH,IAAI,OAAO;gBAAE,OAAM;YACnB,OAAO,GAAG,IAAI,CAAA;YACd,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACd,mEAAmE;YACnE,UAAU,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,CAAA;QAChD,CAAC;KACF,CAAA;IACD,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,IAAc,CAAC,CAAA;QACxF,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC,KAAK,CAAC,CAAA;QAClC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChB,SAAS,IAAI,KAAK,CAAC,UAAU,CAAA;QAC7B,IAAI,SAAS,GAAG,SAAS;YAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;IACF,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QAC9B,IAAI,CAAC,MAAM,IAAI,KAAK;YAAE,OAAM;QAC5B,KAAK,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAA;QAC3C,MAAM,EAAE,CAAA;QACR,YAAY,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;IACF,uFAAuF;IACvF,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACxB,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QACxB,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAA;IACzF,CAAC,CAAC,CAAA;IACF,MAAM,GAAG,IAAI,CAAA;IACb,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC9B,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAA;IACpC,qEAAqE;IACrE,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,MAAM;QAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/E,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,33 @@
+import { Awareness } from 'y-protocols/awareness';
+import * as Y from 'yjs';
+export type Role = 'edit' | 'read';
+export type Status = 'connecting' | 'connected' | 'reconnecting' | 'closed';
+export type PeditErrorCode = 'not-found' | 'held' | 'busy' | 'forbidden' | 'gone' | 'unavailable';
+export declare class PeditError extends Error {
+    code: PeditErrorCode;
+    constructor(code: PeditErrorCode, message?: string);
+}
+export interface Connection {
+    doc: Y.Doc;
+    /** `doc.getText('content')`: the file's text. */
+    text: Y.Text;
+    /** Unauthenticated: anyone who can connect can claim any name. */
+    awareness: Awareness;
+    /** For `read`, no update is ever sent; also make the editor read-only (`EditorState.readOnly.of(true)`). */
+    role: Role;
+    status: {
+        get(): Status;
+        subscribe(cb: (s: Status, error?: PeditError) => void): () => void;
+    };
+    /** Resolves after the first sync. */
+    synced: Promise<void>;
+    destroy(): void;
+}
+/**
+ * Open `${base}/${id}` (where `peditRoutes` is mounted): issue a session, connect, and resolve
+ * after the first sync. Reconnects with a fresh token until the server says it is gone.
+ */
+export declare function connect(base: string, id: string, options?: {
+    name?: string;
+    color?: string;
+}): Promise<Connection>;

package/dist/client.js

@@ -0,0 +1,176 @@
+import { Awareness } from 'y-protocols/awareness';
+import { WebsocketProvider } from 'y-websocket';
+import * as Y from 'yjs';
+export class PeditError extends Error {
+    code;
+    constructor(code, message = code) {
+        super(message);
+        this.name = 'PeditError';
+        this.code = code;
+    }
+}
+const REASONS = {
+    403: 'forbidden',
+    404: 'not-found',
+    409: 'held',
+    503: 'busy',
+};
+const MAX_DELAY_MS = 30_000;
+async function session(url) {
+    let res;
+    try {
+        res = await fetch(url, { method: 'POST', credentials: 'same-origin' });
+    }
+    catch (e) {
+        throw new PeditError('unavailable', String(e?.message));
+    }
+    if (!res.ok)
+        throw new PeditError(REASONS[res.status] ?? 'unavailable', `session: ${res.status}`);
+    const body = (await res.json());
+    if (typeof body.token !== 'string' ||
+        (body.role !== 'edit' && body.role !== 'read') ||
+        typeof body.generation !== 'string') {
+        throw new PeditError('unavailable', 'bad session response');
+    }
+    return { token: body.token, role: body.role, generation: body.generation };
+}
+/**
+ * Open `${base}/${id}` (where `peditRoutes` is mounted): issue a session, connect, and resolve
+ * after the first sync. Reconnects with a fresh token until the server says it is gone.
+ */
+export async function connect(base, id, options = {}) {
+    const root = `${base.replace(/\/$/, '')}/${encodeURIComponent(id)}`;
+    const sessionUrl = `${location.origin}${root}/session`;
+    const first = await session(sessionUrl);
+    const role = first.role;
+    const generation = first.generation;
+    const doc = new Y.Doc();
+    const text = doc.getText('content');
+    const awareness = new Awareness(doc);
+    const provider = new WebsocketProvider(`${location.origin.replace(/^http/, 'ws')}${root}`, 'doc', doc, { connect: false, disableBc: true, params: { token: first.token }, awareness });
+    // A reader never sends an update; pedit also refuses one, with close code 4003.
+    if (role === 'read') {
+        doc.off('update', provider._updateHandler);
+    }
+    if (options.name || options.color) {
+        const color = options.color ?? '#3b82f6';
+        awareness.setLocalStateField('user', {
+            name: options.name ?? 'guest',
+            color,
+            colorLight: `${color}33`,
+        });
+    }
+    let status = 'connecting';
+    const subs = new Set();
+    const setStatus = (s, error) => {
+        if (status === 'closed')
+            return;
+        status = s;
+        for (const cb of [...subs])
+            cb(s, error);
+    };
+    const isClosed = () => status === 'closed';
+    let halting = false;
+    // disconnect() emits connection-close itself; do not handle that one.
+    const halt = () => {
+        halting = true;
+        try {
+            provider.disconnect();
+        }
+        finally {
+            halting = false;
+        }
+    };
+    let destroyed = false;
+    let attempts = 0;
+    let timer;
+    const stop = (error) => {
+        clearTimeout(timer);
+        halt();
+        settle?.reject(error);
+        setStatus('closed', error);
+    };
+    async function retry() {
+        if (destroyed || isClosed())
+            return;
+        try {
+            const next = await session(sessionUrl);
+            if (destroyed || isClosed())
+                return;
+            // Live role changes are not supported: the update handler and the editor were set up for one role.
+            if (next.role !== role)
+                return stop(new PeditError('forbidden', 'role changed; connect again'));
+            // The document started afresh: merging this page's copy would duplicate its text.
+            if (next.generation !== generation)
+                return stop(new PeditError('gone', 'the document was restarted; reload'));
+            provider.params = { token: next.token };
+            provider.connect();
+        }
+        catch (e) {
+            const err = e instanceof PeditError ? e : new PeditError('unavailable');
+            if (err.code === 'forbidden' || err.code === 'not-found')
+                return stop(err);
+            schedule();
+        }
+    }
+    function schedule() {
+        clearTimeout(timer);
+        const delay = Math.min(MAX_DELAY_MS, 1000 * 2 ** attempts++);
+        timer = setTimeout(retry, delay);
+    }
+    let settle;
+    const synced = new Promise((resolve, reject) => {
+        settle = { resolve, reject };
+    });
+    synced.catch(() => { });
+    provider.on('sync', (isSynced) => {
+        if (!isSynced)
+            return;
+        attempts = 0;
+        setStatus('connected');
+        settle?.resolve();
+    });
+    provider.on('connection-close', (event) => {
+        if (destroyed || isClosed() || halting)
+            return;
+        halt();
+        // 4003: refused for good. 4001 (the child exited) reconnects: retry() re-issues a session
+        // and stops only if the generation changed.
+        if (event?.code === 4003)
+            return stop(new PeditError('forbidden'));
+        setStatus(status === 'connecting' ? 'connecting' : 'reconnecting');
+        schedule();
+    });
+    const connection = {
+        doc,
+        text,
+        awareness,
+        role,
+        status: {
+            get: () => status,
+            subscribe(cb) {
+                subs.add(cb);
+                return () => subs.delete(cb);
+            },
+        },
+        synced,
+        destroy() {
+            destroyed = true;
+            clearTimeout(timer);
+            halt();
+            provider.destroy();
+            awareness.destroy();
+            subs.clear();
+        },
+    };
+    provider.connect();
+    try {
+        await synced;
+    }
+    catch (e) {
+        connection.destroy();
+        throw e;
+    }
+    return connection;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAMxB,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,IAAI,CAAgB;IACpB,YAAY,IAAoB,EAAE,UAAkB,IAAI;QACtD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,YAAY,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CACF;AAgBD,MAAM,OAAO,GAAmC;IAC9C,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;CACZ,CAAA;AACD,MAAM,YAAY,GAAG,MAAM,CAAA;AAE3B,KAAK,UAAU,OAAO,CAAC,GAAW;IAChC,IAAI,GAAa,CAAA;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC,CAAA;IACxE,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE,MAAM,CAAE,CAAW,EAAE,OAAO,CAAC,CAAC,CAAA;IACpE,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,aAAa,EAAE,YAAY,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;IACjG,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAyD,CAAA;IACvF,IACE,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;QAC9B,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,UAAU,KAAK,QAAQ,EACnC,CAAC;QACD,MAAM,IAAI,UAAU,CAAC,aAAa,EAAE,sBAAsB,CAAC,CAAA;IAC7D,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAA;AAC5E,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,IAAY,EACZ,EAAU,EACV,UAA6C,EAAE;IAE/C,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAA;IACnE,MAAM,UAAU,GAAG,GAAG,QAAQ,CAAC,MAAM,GAAG,IAAI,UAAU,CAAA;IACtD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAA;IACvC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAA;IACvB,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAA;IAEnC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,GAAG,EAAE,CAAA;IACvB,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAA;IACpC,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CACpC,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,IAAI,EAAE,EAClD,KAAK,EACL,GAAG,EACH,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,CAC/E,CAAA;IACD,gFAAgF;IAChF,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACpB,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAG,QAAiD,CAAC,cAAc,CAAC,CAAA;IACtF,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,SAAS,CAAA;QACxC,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE;YACnC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,OAAO;YAC7B,KAAK;YACL,UAAU,EAAE,GAAG,KAAK,IAAI;SACzB,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,MAAM,GAAW,YAAY,CAAA;IACjC,MAAM,IAAI,GAAG,IAAI,GAAG,EAA2C,CAAA;IAC/D,MAAM,SAAS,GAAG,CAAC,CAAS,EAAE,KAAkB,EAAE,EAAE;QAClD,IAAI,MAAM,KAAK,QAAQ;YAAE,OAAM;QAC/B,MAAM,GAAG,CAAC,CAAA;QACV,KAAK,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;YAAE,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IAC1C,CAAC,CAAA;IACD,MAAM,QAAQ,GAAG,GAAG,EAAE,CAAC,MAAM,KAAK,QAAQ,CAAA;IAC1C,IAAI,OAAO,GAAG,KAAK,CAAA;IACnB,sEAAsE;IACtE,MAAM,IAAI,GAAG,GAAG,EAAE;QAChB,OAAO,GAAG,IAAI,CAAA;QACd,IAAI,CAAC;YACH,QAAQ,CAAC,UAAU,EAAE,CAAA;QACvB,CAAC;gBAAS,CAAC;YACT,OAAO,GAAG,KAAK,CAAA;QACjB,CAAC;IACH,CAAC,CAAA;IACD,IAAI,SAAS,GAAG,KAAK,CAAA;IACrB,IAAI,QAAQ,GAAG,CAAC,CAAA;IAChB,IAAI,KAAgD,CAAA;IAEpD,MAAM,IAAI,GAAG,CAAC,KAAiB,EAAE,EAAE;QACjC,YAAY,CAAC,KAAK,CAAC,CAAA;QACnB,IAAI,EAAE,CAAA;QACN,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;QACrB,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC5B,CAAC,CAAA;IACD,KAAK,UAAU,KAAK;QAClB,IAAI,SAAS,IAAI,QAAQ,EAAE;YAAE,OAAM;QACnC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,CAAA;YACtC,IAAI,SAAS,IAAI,QAAQ,EAAE;gBAAE,OAAM;YACnC,mGAAmG;YACnG,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI;gBACpB,OAAO,IAAI,CAAC,IAAI,UAAU,CAAC,WAAW,EAAE,6BAA6B,CAAC,CAAC,CAAA;YACzE,kFAAkF;YAClF,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU;gBAChC,OAAO,IAAI,CAAC,IAAI,UAAU,CAAC,MAAM,EAAE,oCAAoC,CAAC,CAAC,CAAA;YAC3E,QAAQ,CAAC,MAAM,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAA;YACvC,QAAQ,CAAC,OAAO,EAAE,CAAA;QACpB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,CAAC,YAAY,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC,CAAA;YACvE,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW;gBAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;YAC1E,QAAQ,EAAE,CAAA;QACZ,CAAC;IACH,CAAC;IACD,SAAS,QAAQ;QACf,YAAY,CAAC,KAAK,CAAC,CAAA;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,GAAG,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAA;QAC5D,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IAClC,CAAC;IAED,IAAI,MAAoE,CAAA;IACxE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACnD,MAAM,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;IAC9B,CAAC,CAAC,CAAA;IACF,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;IAEtB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAiB,EAAE,EAAE;QACxC,IAAI,CAAC,QAAQ;YAAE,OAAM;QACrB,QAAQ,GAAG,CAAC,CAAA;QACZ,SAAS,CAAC,WAAW,CAAC,CAAA;QACtB,MAAM,EAAE,OAAO,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IACF,QAAQ,CAAC,EAAE,CAAC,kBAAkB,EAAE,CAAC,KAAwB,EAAE,EAAE;QAC3D,IAAI,SAAS,IAAI,QAAQ,EAAE,IAAI,OAAO;YAAE,OAAM;QAC9C,IAAI,EAAE,CAAA;QACN,0FAA0F;QAC1F,4CAA4C;QAC5C,IAAI,KAAK,EAAE,IAAI,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;QAClE,SAAS,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,CAAC,CAAA;QAClE,QAAQ,EAAE,CAAA;IACZ,CAAC,CAAC,CAAA;IAEF,MAAM,UAAU,GAAe;QAC7B,GAAG;QACH,IAAI;QACJ,SAAS;QACT,IAAI;QACJ,MAAM,EAAE;YACN,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM;YACjB,SAAS,CAAC,EAAE;gBACV,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;gBACZ,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC9B,CAAC;SACF;QACD,MAAM;QACN,OAAO;YACL,SAAS,GAAG,IAAI,CAAA;YAChB,YAAY,CAAC,KAAK,CAAC,CAAA;YACnB,IAAI,EAAE,CAAA;YACN,QAAQ,CAAC,OAAO,EAAE,CAAA;YAClB,SAAS,CAAC,OAAO,EAAE,CAAA;YACnB,IAAI,CAAC,KAAK,EAAE,CAAA;QACd,CAAC;KACF,CAAA;IACD,QAAQ,CAAC,OAAO,EAAE,CAAA;IAClB,IAAI,CAAC;QACH,MAAM,MAAM,CAAA;IACd,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,UAAU,CAAC,OAAO,EAAE,CAAA;QACpB,MAAM,CAAC,CAAA;IACT,CAAC;IACD,OAAO,UAAU,CAAA;AACnB,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,19 @@
+/** Another process (maybe another app) serves the file. The labels come from a lock file: never signal the pid. */
+export declare class HeldError extends Error {
+    holder: {
+        pid: number;
+        app?: string;
+    };
+    constructor(holder: {
+        pid: number;
+        app?: string;
+    });
+}
+/** A hard limit was reached: 32 files, or 8 clients per file. */
+export declare class LimitError extends Error {
+    constructor(message: string);
+}
+/** The pedit binary is missing or not trustworthy. */
+export declare class NoPeditError extends Error {
+    constructor(message: string);
+}

package/dist/errors.js

@@ -0,0 +1,24 @@
+/** Another process (maybe another app) serves the file. The labels come from a lock file: never signal the pid. */
+export class HeldError extends Error {
+    holder;
+    constructor(holder) {
+        super('the file is served by another process');
+        this.name = 'HeldError';
+        this.holder = holder;
+    }
+}
+/** A hard limit was reached: 32 files, or 8 clients per file. */
+export class LimitError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'LimitError';
+    }
+}
+/** The pedit binary is missing or not trustworthy. */
+export class NoPeditError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'NoPeditError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,mHAAmH;AACnH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,MAAM,CAA+B;IACrC,YAAY,MAAqC;QAC/C,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC9C,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AAED,iEAAiE;AACjE,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,YAAY,CAAA;IAC1B,CAAC;CACF;AAED,sDAAsD;AACtD,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;IAC5B,CAAC;CACF"}

package/dist/hono.d.ts

@@ -0,0 +1,43 @@
+import { type Context, type Env, Hono } from 'hono';
+import type { UpgradeWebSocket } from 'hono/ws';
+import type { Role } from './types.ts';
+export type { Role };
+export interface PeditOptions<E extends Env = Env> {
+    /** From the adapter, created on the PARENT app (`createNodeWebSocket({ app })`). */
+    upgradeWebSocket: UpgradeWebSocket;
+    /** realpath'd at startup; must exist. */
+    root: string;
+    /** Exact origins of the integrator's pages; also used for the Host check. */
+    origins: string[];
+    app: string;
+    /** Map an id to a file under `root`. null is 404; throw an HTTPException for anything else. */
+    resolve: (id: string, c: Context<E>) => Promise<{
+        path: string;
+        role: Role;
+    } | null>;
+    /** Absolute path to pedit; default: `pedit` on the PATH. Config only. */
+    bin?: string;
+    idleMs?: number;
+    /** Default false: refuse peers that are not on loopback. */
+    allowRemote?: boolean;
+    onEvent?: (event: PeditEvent) => void;
+}
+export type PeditEvent = {
+    type: 'started';
+    id: string;
+    path: string;
+} | {
+    type: 'stopped';
+    id: string;
+    path: string;
+    reason: 'idle' | 'exited' | 'shutdown';
+} | {
+    type: 'error';
+    id: string | null;
+    message: string;
+};
+/** True for 127.0.0.0/8, ::1 and their IPv4-mapped forms. */
+export declare function isLoopback(address: string | undefined): boolean;
+export declare function peditRoutes<E extends Env = Env>(options: PeditOptions<E>): Hono<E> & {
+    close(): Promise<void>;
+};