orpc-fn 0.4.0 → 0.5.1

package/dist/vue/testing.js

@@ -0,0 +1,225 @@
+import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query';
+import { createApp, effectScope } from 'vue';
+import { provideOrpc } from '../vue.js';
+const emptyAsyncIterable = () => ({
+    async *[Symbol.asyncIterator]() { }
+});
+const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+/**
+ * A deep stand-in for oRPC utils or a client: `o.order.key()` is `['order']`,
+ * `o.order.get.call()` resolves an empty stream, `.key()`/`.queryKey()` on a
+ * procedure return `[]`, and any other method returns `{}`. The same path
+ * always returns the same mock, so calls can be asserted. Type it as your
+ * utils: `createOrpcMock<typeof orpc>({ fn: mock })`.
+ */
+export function createOrpcMock(options = {}) {
+    const { fn = (implementation) => implementation, keys, overrides } = options;
+    const created = [];
+    const method = (implementation) => {
+        const wrapped = fn(implementation);
+        created.push(wrapped);
+        return wrapped;
+    };
+    const reset = () => {
+        for (const wrapped of created) {
+            ;
+            wrapped.mockReset?.();
+        }
+    };
+    const procedures = new Map();
+    const procedure = (path) => {
+        let found = procedures.get(path);
+        if (!found) {
+            const methods = new Map();
+            found = new Proxy({}, {
+                get(_target, name) {
+                    if (typeof name === 'symbol')
+                        return undefined;
+                    let existing = methods.get(name);
+                    if (!existing) {
+                        existing = method(name === 'call'
+                            ? async () => emptyAsyncIterable()
+                            : name === 'key' || name === 'queryKey'
+                                ? () => []
+                                : () => ({}));
+                        methods.set(name, existing);
+                    }
+                    return existing;
+                }
+            });
+            procedures.set(path, found);
+        }
+        return found;
+    };
+    const namespaces = new Map();
+    const namespace = (name) => {
+        let found = namespaces.get(name);
+        if (!found) {
+            const override = overrides?.[name];
+            const target = isObject(override) ? { ...override } : {};
+            found = new Proxy(target, {
+                get(shape, key) {
+                    if (typeof key === 'symbol')
+                        return undefined;
+                    if (key === 'key')
+                        return () => keys?.[name] ?? [name];
+                    if (key in shape)
+                        return shape[key];
+                    return procedure(`${name}.${key}`);
+                }
+            });
+            namespaces.set(name, found);
+        }
+        return found;
+    };
+    // The proxy answers every path at runtime; `T` is the shape tests read it as.
+    return new Proxy({ $reset: reset }, {
+        get(_target, key) {
+            if (key === '$reset')
+                return reset;
+            if (typeof key === 'symbol')
+                return undefined;
+            const override = overrides?.[key];
+            if (override !== undefined && !isObject(override))
+                return override;
+            return namespace(key);
+        }
+    });
+}
+/**
+ * A controllable stand-in for an oRPC event iterator, for driving
+ * subscriptions and live queries in tests without timers.
+ */
+export function createTestStream() {
+    const connections = [];
+    const openWaiters = [];
+    function open(args) {
+        const options = [...args]
+            .reverse()
+            .find((arg) => isObject(arg) && 'signal' in arg);
+        const queue = [];
+        let failure = null;
+        let closed = false;
+        let pending = null;
+        // The event the consumer holds; it is processed once it asks for the next.
+        let handedOut = null;
+        const settle = () => {
+            if (!pending)
+                return;
+            const current = pending;
+            if (failure) {
+                pending = null;
+                current.reject(failure);
+                return;
+            }
+            const next = queue.shift();
+            if (!next)
+                return;
+            pending = null;
+            handedOut = next.delivered;
+            current.resolve(next.result);
+        };
+        const close = () => {
+            closed = true;
+            handedOut?.();
+            handedOut = null;
+            for (const queued of queue)
+                queued.delivered();
+        };
+        // oRPC rejects a pending `next()` with an AbortError when the call is aborted.
+        options?.signal?.addEventListener('abort', () => {
+            const abort = new Error('This operation was aborted');
+            abort.name = 'AbortError';
+            failure = abort;
+            settle();
+            close();
+        });
+        const connection = {
+            input: args[0],
+            signal: options?.signal,
+            get closed() {
+                return closed;
+            },
+            push(event) {
+                if (closed)
+                    return Promise.resolve();
+                return new Promise((delivered) => {
+                    queue.push({ result: { done: false, value: event }, delivered });
+                    settle();
+                });
+            },
+            end() {
+                const done = { done: true, value: undefined };
+                queue.push({ result: done, delivered: () => { } });
+                settle();
+                closed = true;
+            },
+            fail(error) {
+                failure = error;
+                settle();
+                close();
+            }
+        };
+        const iterator = {
+            next() {
+                handedOut?.();
+                handedOut = null;
+                return new Promise((resolve, reject) => {
+                    pending = { resolve, reject };
+                    settle();
+                });
+            },
+            async return() {
+                close();
+                pending?.resolve({ done: true, value: undefined });
+                pending = null;
+                return { done: true, value: undefined };
+            }
+        };
+        connections.push(connection);
+        for (const waiter of [...openWaiters]) {
+            if (connections.length < waiter.count)
+                continue;
+            openWaiters.splice(openWaiters.indexOf(waiter), 1);
+            waiter.resolve();
+        }
+        return Object.assign(connection, {
+            [Symbol.asyncIterator]: () => iterator
+        });
+    }
+    const latest = () => {
+        const connection = connections.at(-1);
+        if (!connection)
+            throw new Error('createTestStream: no connection opened');
+        return connection;
+    };
+    return {
+        subscribe: async (...args) => open(args),
+        connections,
+        opened: (count = 1) => new Promise((resolve) => {
+            const done = () => resolve(connections[count - 1]);
+            if (connections.length >= count)
+                done();
+            else
+                openWaiters.push({ count, resolve: done });
+        }),
+        push: (event) => latest().push(event),
+        end: () => latest().end(),
+        fail: (error) => latest().fail(error)
+    };
+}
+/**
+ * Run composables inside a real Vue app with a `QueryClient` and the provided
+ * oRPC client, without a DOM. `stop()` disposes the scope, closing streams.
+ */
+export function withOrpcApp(setup, options = {}) {
+    const queryClient = options.queryClient ??
+        new QueryClient({ defaultOptions: { queries: { retry: false } } });
+    const app = createApp({ render: () => null });
+    app.use(VueQueryPlugin, { queryClient });
+    provideOrpc(app, { client: options.client, utils: options.utils });
+    const scope = effectScope();
+    const result = app.runWithContext(() => scope.run(setup));
+    return { result, queryClient, app, stop: () => scope.stop() };
+}
+//# sourceMappingURL=testing.js.map

package/dist/vue/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sourceRoot":"","sources":["../../src/vue/testing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAmBvC,MAAM,kBAAkB,GAAG,GAAG,EAAE,CAAC,CAAC;IACjC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,KAAI,CAAC;CAClC,CAAC,CAAA;AAEF,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CACrE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAErE;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC7B,OAAO,GAA0B,EAAE;IAEnC,MAAM,EAAE,EAAE,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IAC5E,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,MAAM,MAAM,GAAG,CAAC,cAAsB,EAAE,EAAE;QACzC,MAAM,OAAO,GAAG,EAAE,CAAC,cAAc,CAAC,CAAA;QAClC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrB,OAAO,OAAO,CAAA;IACf,CAAC,CAAA;IACD,MAAM,KAAK,GAAG,GAAG,EAAE;QAClB,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;YAC/B,CAAC;YAAC,OAAsC,CAAC,SAAS,EAAE,EAAE,CAAA;QACvD,CAAC;IACF,CAAC,CAAA;IAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAmC,CAAA;IAC7D,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE;QAClC,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAChC,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAA;YACzC,KAAK,GAAG,IAAI,KAAK,CAChB,EAAE,EACF;gBACC,GAAG,CAAC,OAAO,EAAE,IAAI;oBAChB,IAAI,OAAO,IAAI,KAAK,QAAQ;wBAAE,OAAO,SAAS,CAAA;oBAC9C,IAAI,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;oBAChC,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACf,QAAQ,GAAG,MAAM,CAChB,IAAI,KAAK,MAAM;4BACd,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,kBAAkB,EAAE;4BAClC,CAAC,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,UAAU;gCACtC,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE;gCACV,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CACd,CAAA;wBACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;oBAC5B,CAAC;oBACD,OAAO,QAAQ,CAAA;gBAChB,CAAC;aACD,CACD,CAAA;YACD,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAC5B,CAAC;QACD,OAAO,KAAK,CAAA;IACb,CAAC,CAAA;IAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAmC,CAAA;IAC7D,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE;QAClC,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAChC,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,MAAM,QAAQ,GAAG,SAAS,EAAE,CAAC,IAAI,CAAC,CAAA;YAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;YACxD,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE;gBACzB,GAAG,CAAC,KAAK,EAAE,GAAG;oBACb,IAAI,OAAO,GAAG,KAAK,QAAQ;wBAAE,OAAO,SAAS,CAAA;oBAC7C,IAAI,GAAG,KAAK,KAAK;wBAAE,OAAO,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBACtD,IAAI,GAAG,IAAI,KAAK;wBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAA;oBACnC,OAAO,SAAS,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAA;gBACnC,CAAC;aACD,CAAC,CAAA;YACF,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QAC5B,CAAC;QACD,OAAO,KAAK,CAAA;IACb,CAAC,CAAA;IAED,8EAA8E;IAC9E,OAAO,IAAI,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,EAAiB,EAAE;QAClD,GAAG,CAAC,OAAO,EAAE,GAAG;YACf,IAAI,GAAG,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAA;YAClC,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,OAAO,SAAS,CAAA;YAC7C,MAAM,QAAQ,GAAG,SAAS,EAAE,CAAC,GAAG,CAAC,CAAA;YACjC,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAAE,OAAO,QAAQ,CAAA;YAClE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;QACtB,CAAC;KACD,CAAC,CAAA;AACH,CAAC;AA2BD;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC/B,MAAM,WAAW,GAAwB,EAAE,CAAA;IAC3C,MAAM,WAAW,GAA6C,EAAE,CAAA;IAEhE,SAAS,IAAI,CAAC,IAAe;QAC5B,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC;aACvB,OAAO,EAAE;aACT,IAAI,CACJ,CAAC,GAAG,EAAmC,EAAE,CACxC,QAAQ,CAAC,GAAG,CAAC,IAAI,QAAQ,IAAI,GAAG,CACjC,CAAA;QAMF,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,IAAI,OAAO,GAAiB,IAAI,CAAA;QAChC,IAAI,MAAM,GAAG,KAAK,CAAA;QAClB,IAAI,OAAO,GAGA,IAAI,CAAA;QACf,2EAA2E;QAC3E,IAAI,SAAS,GAAwB,IAAI,CAAA;QAEzC,MAAM,MAAM,GAAG,GAAG,EAAE;YACnB,IAAI,CAAC,OAAO;gBAAE,OAAM;YACpB,MAAM,OAAO,GAAG,OAAO,CAAA;YACvB,IAAI,OAAO,EAAE,CAAC;gBACb,OAAO,GAAG,IAAI,CAAA;gBACd,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACvB,OAAM;YACP,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;YAC1B,IAAI,CAAC,IAAI;gBAAE,OAAM;YACjB,OAAO,GAAG,IAAI,CAAA;YACd,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;YAC1B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC7B,CAAC,CAAA;QAED,MAAM,KAAK,GAAG,GAAG,EAAE;YAClB,MAAM,GAAG,IAAI,CAAA;YACb,SAAS,EAAE,EAAE,CAAA;YACb,SAAS,GAAG,IAAI,CAAA;YAChB,KAAK,MAAM,MAAM,IAAI,KAAK;gBAAE,MAAM,CAAC,SAAS,EAAE,CAAA;QAC/C,CAAC,CAAA;QAED,+EAA+E;QAC/E,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YAC/C,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;YACrD,KAAK,CAAC,IAAI,GAAG,YAAY,CAAA;YACzB,OAAO,GAAG,KAAK,CAAA;YACf,MAAM,EAAE,CAAA;YACR,KAAK,EAAE,CAAA;QACR,CAAC,CAAC,CAAA;QAEF,MAAM,UAAU,GAAsB;YACrC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;YACd,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,IAAI,MAAM;gBACT,OAAO,MAAM,CAAA;YACd,CAAC;YACD,IAAI,CAAC,KAAK;gBACT,IAAI,MAAM;oBAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;gBACpC,OAAO,IAAI,OAAO,CAAO,CAAC,SAAS,EAAE,EAAE;oBACtC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,CAAA;oBAChE,MAAM,EAAE,CAAA;gBACT,CAAC,CAAC,CAAA;YACH,CAAC;YACD,GAAG;gBACF,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,IAAa,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;gBACtD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC,CAAA;gBACjD,MAAM,EAAE,CAAA;gBACR,MAAM,GAAG,IAAI,CAAA;YACd,CAAC;YACD,IAAI,CAAC,KAAK;gBACT,OAAO,GAAG,KAAK,CAAA;gBACf,MAAM,EAAE,CAAA;gBACR,KAAK,EAAE,CAAA;YACR,CAAC;SACD,CAAA;QAED,MAAM,QAAQ,GAAgC;YAC7C,IAAI;gBACH,SAAS,EAAE,EAAE,CAAA;gBACb,SAAS,GAAG,IAAI,CAAA;gBAChB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACtC,OAAO,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;oBAC7B,MAAM,EAAE,CAAA;gBACT,CAAC,CAAC,CAAA;YACH,CAAC;YACD,KAAK,CAAC,MAAM;gBACX,KAAK,EAAE,CAAA;gBACP,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;gBAClD,OAAO,GAAG,IAAI,CAAA;gBACd,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;YACxC,CAAC;SACD,CAAA;QAED,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC5B,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,WAAW,CAAC,EAAE,CAAC;YACvC,IAAI,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK;gBAAE,SAAQ;YAC/C,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAClD,MAAM,CAAC,OAAO,EAAE,CAAA;QACjB,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;YAChC,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ;SACtC,CAAC,CAAA;IACH,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,EAAE;QACnB,MAAM,UAAU,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QACrC,IAAI,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;QAC1E,OAAO,UAAU,CAAA;IAClB,CAAC,CAAA;IAED,OAAO;QACN,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAC5B,IAAI,CAAC,IAAI,CAAyC;QACnD,WAAW;QACX,MAAM,EAAE,CAAC,KAAK,GAAG,CAAC,EAAE,EAAE,CACrB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACvB,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,CAAsB,CAAC,CAAA;YACvE,IAAI,WAAW,CAAC,MAAM,IAAI,KAAK;gBAAE,IAAI,EAAE,CAAA;;gBAClC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QAChD,CAAC,CAAC;QACH,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;QACrC,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACzB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;KACrC,CAAA;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAC1B,KAAc,EACd,OAAO,GAIH,EAAE;IAEN,MAAM,WAAW,GAChB,OAAO,CAAC,WAAW;QACnB,IAAI,WAAW,CAAC,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAA;IACnE,MAAM,GAAG,GAAG,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;IAC7C,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA;IACxC,WAAW,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IAClE,MAAM,KAAK,GAAG,WAAW,EAAE,CAAA;IAC3B,MAAM,MAAM,GAAG,GAAG,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAM,CAAA;IAC9D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAA;AAC9D,CAAC","sourcesContent":["import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query'\nimport { createApp, effectScope } from 'vue'\nimport { provideOrpc } from '../vue.js'\n\ntype Method = (...args: never[]) => unknown\ntype MockFactory = (implementation: Method) => Method\n\nexport type OrpcMock<T> = T & {\n\t/** Reset every method mock created so far (calls `mockReset` when the factory provides it). */\n\t$reset: () => void\n}\n\nexport type CreateOrpcMockOptions = {\n\t/** Wraps each method, e.g. `mock` from `bun:test` or `vi.fn`, so calls can be asserted. */\n\tfn?: MockFactory\n\t/** Namespace `.key()` results (default: `[namespace]`). */\n\tkeys?: Record<string, readonly unknown[]>\n\t/** Explicit namespace shapes merged over the auto-mock. */\n\toverrides?: Record<string, unknown>\n}\n\nconst emptyAsyncIterable = () => ({\n\tasync *[Symbol.asyncIterator]() {}\n})\n\nconst isObject = (value: unknown): value is Record<string, unknown> =>\n\ttypeof value === 'object' && value !== null && !Array.isArray(value)\n\n/**\n * A deep stand-in for oRPC utils or a client: `o.order.key()` is `['order']`,\n * `o.order.get.call()` resolves an empty stream, `.key()`/`.queryKey()` on a\n * procedure return `[]`, and any other method returns `{}`. The same path\n * always returns the same mock, so calls can be asserted. Type it as your\n * utils: `createOrpcMock<typeof orpc>({ fn: mock })`.\n */\nexport function createOrpcMock<T = Record<string, unknown>>(\n\toptions: CreateOrpcMockOptions = {}\n): OrpcMock<T> {\n\tconst { fn = (implementation) => implementation, keys, overrides } = options\n\tconst created: Method[] = []\n\tconst method = (implementation: Method) => {\n\t\tconst wrapped = fn(implementation)\n\t\tcreated.push(wrapped)\n\t\treturn wrapped\n\t}\n\tconst reset = () => {\n\t\tfor (const wrapped of created) {\n\t\t\t;(wrapped as { mockReset?: () => void }).mockReset?.()\n\t\t}\n\t}\n\n\tconst procedures = new Map<string, Record<string, unknown>>()\n\tconst procedure = (path: string) => {\n\t\tlet found = procedures.get(path)\n\t\tif (!found) {\n\t\t\tconst methods = new Map<string, Method>()\n\t\t\tfound = new Proxy(\n\t\t\t\t{},\n\t\t\t\t{\n\t\t\t\t\tget(_target, name) {\n\t\t\t\t\t\tif (typeof name === 'symbol') return undefined\n\t\t\t\t\t\tlet existing = methods.get(name)\n\t\t\t\t\t\tif (!existing) {\n\t\t\t\t\t\t\texisting = method(\n\t\t\t\t\t\t\t\tname === 'call'\n\t\t\t\t\t\t\t\t\t? async () => emptyAsyncIterable()\n\t\t\t\t\t\t\t\t\t: name === 'key' || name === 'queryKey'\n\t\t\t\t\t\t\t\t\t\t? () => []\n\t\t\t\t\t\t\t\t\t\t: () => ({})\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t\tmethods.set(name, existing)\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn existing\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t)\n\t\t\tprocedures.set(path, found)\n\t\t}\n\t\treturn found\n\t}\n\n\tconst namespaces = new Map<string, Record<string, unknown>>()\n\tconst namespace = (name: string) => {\n\t\tlet found = namespaces.get(name)\n\t\tif (!found) {\n\t\t\tconst override = overrides?.[name]\n\t\t\tconst target = isObject(override) ? { ...override } : {}\n\t\t\tfound = new Proxy(target, {\n\t\t\t\tget(shape, key) {\n\t\t\t\t\tif (typeof key === 'symbol') return undefined\n\t\t\t\t\tif (key === 'key') return () => keys?.[name] ?? [name]\n\t\t\t\t\tif (key in shape) return shape[key]\n\t\t\t\t\treturn procedure(`${name}.${key}`)\n\t\t\t\t}\n\t\t\t})\n\t\t\tnamespaces.set(name, found)\n\t\t}\n\t\treturn found\n\t}\n\n\t// The proxy answers every path at runtime; `T` is the shape tests read it as.\n\treturn new Proxy({ $reset: reset } as OrpcMock<T>, {\n\t\tget(_target, key) {\n\t\t\tif (key === '$reset') return reset\n\t\t\tif (typeof key === 'symbol') return undefined\n\t\t\tconst override = overrides?.[key]\n\t\t\tif (override !== undefined && !isObject(override)) return override\n\t\t\treturn namespace(key)\n\t\t}\n\t})\n}\n\nexport type TestConnection<T> = {\n\tinput: unknown\n\tsignal: AbortSignal | undefined\n\treadonly closed: boolean\n\t/** Deliver an event. Resolves once the consumer asked for the next one, or the stream closed. */\n\tpush: (event: T) => Promise<void>\n\t/** End the stream normally (`done`). */\n\tend: () => void\n\t/** Fail the stream. */\n\tfail: (error: Error) => void\n}\n\nexport type TestStream<T> = {\n\t/** Pass as the subscribe function; works for any `(input, …, { signal })` shape. */\n\tsubscribe: (...args: unknown[]) => Promise<AsyncIterable<T>>\n\t/** Every connection opened so far, oldest first. */\n\tconnections: TestConnection<T>[]\n\t/** Resolves when at least `count` connections have been opened. */\n\topened: (count?: number) => Promise<TestConnection<T>>\n\t/** Push into the newest connection. */\n\tpush: (event: T) => Promise<void>\n\tend: () => void\n\tfail: (error: Error) => void\n}\n\n/**\n * A controllable stand-in for an oRPC event iterator, for driving\n * subscriptions and live queries in tests without timers.\n */\nexport function createTestStream<T>(): TestStream<T> {\n\tconst connections: TestConnection<T>[] = []\n\tconst openWaiters: { count: number; resolve: () => void }[] = []\n\n\tfunction open(args: unknown[]): TestConnection<T> {\n\t\tconst options = [...args]\n\t\t\t.reverse()\n\t\t\t.find(\n\t\t\t\t(arg): arg is { signal?: AbortSignal } =>\n\t\t\t\t\tisObject(arg) && 'signal' in arg\n\t\t\t)\n\n\t\ttype Queued = {\n\t\t\tresult: IteratorResult<T, undefined>\n\t\t\tdelivered: () => void\n\t\t}\n\t\tconst queue: Queued[] = []\n\t\tlet failure: Error | null = null\n\t\tlet closed = false\n\t\tlet pending: {\n\t\t\tresolve: (result: IteratorResult<T, undefined>) => void\n\t\t\treject: (error: Error) => void\n\t\t} | null = null\n\t\t// The event the consumer holds; it is processed once it asks for the next.\n\t\tlet handedOut: (() => void) | null = null\n\n\t\tconst settle = () => {\n\t\t\tif (!pending) return\n\t\t\tconst current = pending\n\t\t\tif (failure) {\n\t\t\t\tpending = null\n\t\t\t\tcurrent.reject(failure)\n\t\t\t\treturn\n\t\t\t}\n\t\t\tconst next = queue.shift()\n\t\t\tif (!next) return\n\t\t\tpending = null\n\t\t\thandedOut = next.delivered\n\t\t\tcurrent.resolve(next.result)\n\t\t}\n\n\t\tconst close = () => {\n\t\t\tclosed = true\n\t\t\thandedOut?.()\n\t\t\thandedOut = null\n\t\t\tfor (const queued of queue) queued.delivered()\n\t\t}\n\n\t\t// oRPC rejects a pending `next()` with an AbortError when the call is aborted.\n\t\toptions?.signal?.addEventListener('abort', () => {\n\t\t\tconst abort = new Error('This operation was aborted')\n\t\t\tabort.name = 'AbortError'\n\t\t\tfailure = abort\n\t\t\tsettle()\n\t\t\tclose()\n\t\t})\n\n\t\tconst connection: TestConnection<T> = {\n\t\t\tinput: args[0],\n\t\t\tsignal: options?.signal,\n\t\t\tget closed() {\n\t\t\t\treturn closed\n\t\t\t},\n\t\t\tpush(event) {\n\t\t\t\tif (closed) return Promise.resolve()\n\t\t\t\treturn new Promise<void>((delivered) => {\n\t\t\t\t\tqueue.push({ result: { done: false, value: event }, delivered })\n\t\t\t\t\tsettle()\n\t\t\t\t})\n\t\t\t},\n\t\t\tend() {\n\t\t\t\tconst done = { done: true as const, value: undefined }\n\t\t\t\tqueue.push({ result: done, delivered: () => {} })\n\t\t\t\tsettle()\n\t\t\t\tclosed = true\n\t\t\t},\n\t\t\tfail(error) {\n\t\t\t\tfailure = error\n\t\t\t\tsettle()\n\t\t\t\tclose()\n\t\t\t}\n\t\t}\n\n\t\tconst iterator: AsyncIterator<T, undefined> = {\n\t\t\tnext() {\n\t\t\t\thandedOut?.()\n\t\t\t\thandedOut = null\n\t\t\t\treturn new Promise((resolve, reject) => {\n\t\t\t\t\tpending = { resolve, reject }\n\t\t\t\t\tsettle()\n\t\t\t\t})\n\t\t\t},\n\t\t\tasync return() {\n\t\t\t\tclose()\n\t\t\t\tpending?.resolve({ done: true, value: undefined })\n\t\t\t\tpending = null\n\t\t\t\treturn { done: true, value: undefined }\n\t\t\t}\n\t\t}\n\n\t\tconnections.push(connection)\n\t\tfor (const waiter of [...openWaiters]) {\n\t\t\tif (connections.length < waiter.count) continue\n\t\t\topenWaiters.splice(openWaiters.indexOf(waiter), 1)\n\t\t\twaiter.resolve()\n\t\t}\n\t\treturn Object.assign(connection, {\n\t\t\t[Symbol.asyncIterator]: () => iterator\n\t\t})\n\t}\n\n\tconst latest = () => {\n\t\tconst connection = connections.at(-1)\n\t\tif (!connection) throw new Error('createTestStream: no connection opened')\n\t\treturn connection\n\t}\n\n\treturn {\n\t\tsubscribe: async (...args) =>\n\t\t\topen(args) as TestConnection<T> & AsyncIterable<T>,\n\t\tconnections,\n\t\topened: (count = 1) =>\n\t\t\tnew Promise((resolve) => {\n\t\t\t\tconst done = () => resolve(connections[count - 1] as TestConnection<T>)\n\t\t\t\tif (connections.length >= count) done()\n\t\t\t\telse openWaiters.push({ count, resolve: done })\n\t\t\t}),\n\t\tpush: (event) => latest().push(event),\n\t\tend: () => latest().end(),\n\t\tfail: (error) => latest().fail(error)\n\t}\n}\n\n/**\n * Run composables inside a real Vue app with a `QueryClient` and the provided\n * oRPC client, without a DOM. `stop()` disposes the scope, closing streams.\n */\nexport function withOrpcApp<T>(\n\tsetup: () => T,\n\toptions: {\n\t\tutils?: unknown\n\t\tclient?: unknown\n\t\tqueryClient?: QueryClient\n\t} = {}\n) {\n\tconst queryClient =\n\t\toptions.queryClient ??\n\t\tnew QueryClient({ defaultOptions: { queries: { retry: false } } })\n\tconst app = createApp({ render: () => null })\n\tapp.use(VueQueryPlugin, { queryClient })\n\tprovideOrpc(app, { client: options.client, utils: options.utils })\n\tconst scope = effectScope()\n\tconst result = app.runWithContext(() => scope.run(setup)) as T\n\treturn { result, queryClient, app, stop: () => scope.stop() }\n}\n"]}

package/dist/vue.d.ts

@@ -0,0 +1,211 @@
+import { type DefaultError, type FetchQueryOptions, type InferDataFromTag, type InfiniteData, type InvalidateQueryFilters, type MutationObserverOptions, type UseInfiniteQueryOptions, type UseInfiniteQueryReturnType, type UseMutationReturnType, type UseQueryReturnType, type Updater, type QueryKey, type UseQueryOptions, useQuery as useVueQuery } from '@tanstack/vue-query';
+import { type App, type MaybeRefOrGetter, type Ref } from 'vue';
+import { type InvalidationStreamOptions, type LiveConnectionStatus } from './realtime.js';
+export type { InvalidationDomain, LiveConnectionStatus } from './realtime.js';
+/**
+ * Register your client types once so every composable infers them:
+ *
+ * ```ts
+ * declare module 'orpc-fn/vue' {
+ *   interface Register { utils: typeof orpc; client: typeof client }
+ * }
+ * ```
+ */
+export interface Register {
+}
+export type RegisteredOrpcUtils = Register extends {
+    utils: infer T;
+} ? T : {
+    'orpc-fn/vue: register your utils with `declare module "orpc-fn/vue" { interface Register { utils: typeof orpc } }`, or pass `orpc`': never;
+};
+export type RegisteredOrpcClient = Register extends {
+    client: infer T;
+} ? T : unknown;
+/** An explicit `<TData>`, else the data type oRPC tagged on the key. */
+type CachedData<TData, TKey extends QueryKey> = [TData] extends [never] ? InferDataFromTag<unknown, TKey> : TData;
+/**
+ * Make an oRPC client and its TanStack Query utils the app's default. A
+ * surface that talks to another API (an embed with its own auth) passes
+ * `orpc` to each composable instead and never needs this.
+ */
+export declare function provideOrpc<TClient, TUtils>(app: App, orpc: {
+    client: TClient;
+    utils: TUtils;
+}): void;
+/** The client and utils from {@link provideOrpc}. */
+export declare function useOrpc(): {
+    client: RegisteredOrpcClient;
+    utils: RegisteredOrpcUtils;
+};
+/**
+ * Picks the stream to open from the utils. A procedure's `call` fits as is:
+ * `(o) => o.order.watch.call`. The composable passes the input and an abort signal.
+ */
+export type OrpcSubscribeFn<TInput, TEvent, TOrpc = RegisteredOrpcUtils> = (orpc: TOrpc) => (input: TInput, options: {
+    signal: AbortSignal;
+}) => Promise<AsyncIterable<TEvent>>;
+export interface UseSubscriptionOptions<TEvent, TOrpc = RegisteredOrpcUtils> {
+    /** Start the stream on its own (default: true). With false, call `connect()`. */
+    immediate?: MaybeRefOrGetter<boolean> | undefined;
+    onEvent?: (event: TEvent, meta?: {
+        connectionId: number;
+    }) => void;
+    onError?: ((error: Error) => void) | undefined;
+    /** Every successful connect; `connectionId > 1` is a reconnect. */
+    onConnect?: (connectionId: number) => void;
+    onClose?: () => void;
+    /** Events kept in `events` (default: 100). 1 keeps only `latestEvent`. */
+    maxEvents?: number;
+    /** Reconnect when the input changes (default: true). */
+    autoReconnectOnInputChange?: boolean;
+    /**
+     * After a connect, reconnect with backoff when the stream ends or errors
+     * unexpectedly (proxy idle timeout, network blip). Deliberate teardown
+     * does not retry. Default: true.
+     */
+    autoReconnectOnClose?: boolean;
+    orpc?: MaybeRefOrGetter<TOrpc> | undefined;
+    /**
+     * Close the stream while the page is hidden (default: true), so a
+     * background tab holds no server connection. It reconnects, and a live
+     * route re-sends its snapshot, when the page is visible again.
+     */
+    respectVisibility?: boolean | undefined;
+}
+export interface UseSubscriptionReturn<TEvent> {
+    events: Ref<TEvent[]>;
+    latestEvent: Ref<TEvent | undefined>;
+    status: Ref<LiveConnectionStatus>;
+    error: Ref<Error | null>;
+    isConnected: Ref<boolean>;
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    clearEvents: () => void;
+}
+/**
+ * An oRPC event iterator as reactive state, with backoff reconnects and a
+ * pause while the page is hidden. Closed when the owning effect scope stops.
+ */
+export declare function useOrpcSubscription<TInput, TEvent, TOrpc = RegisteredOrpcUtils>(input: MaybeRefOrGetter<TInput>, subscribeFn: OrpcSubscribeFn<TInput, TEvent, TOrpc>, options?: UseSubscriptionOptions<TEvent, TOrpc>): UseSubscriptionReturn<TEvent>;
+/**
+ * TanStack Query composables that receive the oRPC utils, so call sites read
+ * `useQuery((o) => o.order.get.queryOptions({ input }))`. Pass `orpc` to bind
+ * another client than the provided one.
+ */
+export declare function useApiClient<TOrpc = RegisteredOrpcUtils>(clientOptions?: {
+    orpc?: MaybeRefOrGetter<TOrpc> | undefined;
+}): {
+    useQuery: <TQueryFnData, TError = Error, TData = TQueryFnData, TQueryKey extends QueryKey = readonly unknown[]>(optionsFn: (orpc: TOrpc) => UseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>) => UseQueryReturnType<TData, TError>;
+    useInfiniteQuery: <TQueryFnData, TError = Error, TData = InfiniteData<TQueryFnData, unknown>, TQueryKey extends QueryKey = readonly unknown[], TPageParam = unknown>(optionsFn: (orpc: TOrpc) => UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>) => UseInfiniteQueryReturnType<TData, TError>;
+    useMutation: {
+        <TData = unknown, TError = Error, TVariables = void, TContext = unknown>(optionsFn: (orpc: TOrpc) => MutationObserverOptions<TData, TError, TVariables, TContext>, config: {
+            initialInput: TVariables;
+        }): UseMutationReturnType<TData, TError, TVariables, TContext> & {
+            inputData: Ref<TVariables>;
+            mutate: (variables?: TVariables) => void;
+            mutateAsync: (variables?: TVariables) => Promise<TData>;
+        };
+        <TData = unknown, TError = Error, TVariables = void, TContext = unknown>(optionsFn: (orpc: TOrpc) => MutationObserverOptions<TData, TError, TVariables, TContext>): UseMutationReturnType<TData, TError, TVariables, TContext>;
+    };
+    useSubscription: <TInput, TEvent>(input: MaybeRefOrGetter<TInput>, subscribeFn: OrpcSubscribeFn<TInput, TEvent, TOrpc>, options?: UseSubscriptionOptions<TEvent, TOrpc>) => UseSubscriptionReturn<TEvent>;
+    invalidate: (keyFn: (orpc: TOrpc) => QueryKey, filters?: Omit<InvalidateQueryFilters, 'queryKey'>) => Promise<void>;
+    /** Route preloading and hover-to-prefetch. */
+    prefetch: <TQueryFnData, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(optionsFn: (orpc: TOrpc) => FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>) => Promise<void>;
+    /** Data is typed from oRPC's tagged key; pass `<TData>` for an untagged one. */
+    getQueryData: <TData = never, TKey extends QueryKey = QueryKey>(keyFn: (orpc: TOrpc) => TKey) => CachedData<TData, TKey> | undefined;
+    /** Optimistic updates, typed like `getQueryData`. */
+    setQueryData: <TData = never, TKey extends QueryKey = QueryKey>(keyFn: (orpc: TOrpc) => TKey, updater: Updater<CachedData<TData, TKey> | undefined, CachedData<TData, TKey> | undefined>) => NoInfer<CachedData<TData, TKey>> | undefined;
+    cancelQueries: (keyFn: (orpc: TOrpc) => QueryKey) => Promise<void>;
+    removeQueries: (keyFn: (orpc: TOrpc) => QueryKey) => void;
+    isFetching: (keyFn?: (orpc: TOrpc) => QueryKey) => number;
+    queryClient: import("@tanstack/vue-query").QueryClient;
+};
+type ApplyEvent<TStreamEvent, TData> = (event: TStreamEvent, previous: TData | undefined) => TData | undefined;
+type LiveQueryOptions<TInput, TRouteData, TStreamEvent, TData, TOrpc, TSubscriptionInput> = {
+    immediate?: MaybeRefOrGetter<boolean>;
+    orpc?: MaybeRefOrGetter<TOrpc>;
+    /** Input for the stream when it differs from the query's. */
+    subscriptionInput?: MaybeRefOrGetter<TSubscriptionInput>;
+    /**
+     * Convert the route output once at fetch time into a differently typed
+     * cache; `applyEvent` then reduces stream events into that cache.
+     */
+    select?: (data: TRouteData) => TData;
+    /**
+     * The raw route output of a seed before `select` drops fields. `input` is
+     * what the seed was fetched for, so a seed that resolves after the input
+     * moved on can be told apart.
+     */
+    onSeed?: (data: TRouteData, input: TInput) => void;
+    /**
+     * Fold a stream event into the cached data. Required when the stream sends
+     * something other than the cached type (an `fnLive` patch route, or a
+     * `select`ed cache). Return `undefined` to skip the write.
+     */
+    applyEvent?: ApplyEvent<TStreamEvent, NoInfer<TData>>;
+    onEvent?: (event: TStreamEvent, meta?: {
+        connectionId: number;
+    }) => void;
+    onError?: (error: Error) => void;
+    /**
+     * Reconcile a fetched seed with what the stream already wrote. The HTTP
+     * request can resolve last, so a plain overwrite would drop events that
+     * arrived while it was in flight. Default: take the fetched value.
+     */
+    mergeSeed?: (fetched: NoInfer<TData>, cached: NoInfer<TData> | undefined) => NoInfer<TData>;
+    /**
+     * Show the previous key's data while a new key loads (default: true). Pass
+     * false when the key says which entity is shown, not just how it is
+     * filtered: another conversation's timeline must not stand in for this one.
+     */
+    keepPreviousData?: boolean;
+    /** Pause the stream while the page is hidden (default: true). */
+    respectVisibility?: boolean;
+};
+type LiveQueryReturn<TData, TError> = ReturnType<typeof useVueQuery<TData, TError>> & {
+    liveStatus: Ref<LiveConnectionStatus>;
+};
+/**
+ * The client half of `fnLive`: the HTTP query seeds the cache, and the live
+ * route's stream writes each snapshot into the same cache entry. Marked
+ * `meta.live`, so invalidation streams leave it alone.
+ *
+ * One signature, not overloads: TypeScript fixes an untyped callback's
+ * parameters at the first overload it tries, which made valid calls fail.
+ */
+export declare function useLiveQuery<TInput, TRouteData, TStreamEvent, TData = TRouteData, TError = Error, TOrpc = RegisteredOrpcUtils, TSubscriptionInput = TInput>(input: MaybeRefOrGetter<TInput>, queryOptionsFn: (input: TInput, orpc: TOrpc) => UseQueryOptions<TRouteData, TError> & {
+    queryKey: QueryKey;
+}, subscribeFn: OrpcSubscribeFn<NoInfer<TSubscriptionInput>, TStreamEvent, TOrpc>, ...options: [TStreamEvent] extends [TData] ? [
+    options?: LiveQueryOptions<TInput, TRouteData, TStreamEvent, TData, TOrpc, TSubscriptionInput>
+] : [
+    options: LiveQueryOptions<TInput, TRouteData, TStreamEvent, TData, TOrpc, TSubscriptionInput> & {
+        applyEvent: ApplyEvent<TStreamEvent, NoInfer<TData>>;
+    }
+]): LiveQueryReturn<TData, TError>;
+/**
+ * Treat a stream as a "something changed" ping: invalidate `keyFn` on each
+ * event. Prefer {@link useLiveQuery} when the stream carries the data itself.
+ */
+export declare function useSubscriptionInvalidates<TInput, TEvent, TOrpc = RegisteredOrpcUtils>(input: MaybeRefOrGetter<TInput>, subscribeFn: OrpcSubscribeFn<TInput, TEvent, TOrpc>, keyFn: (orpc: TOrpc) => QueryKey, options?: Pick<UseSubscriptionOptions<TEvent, TOrpc>, 'immediate' | 'maxEvents' | 'respectVisibility' | 'orpc'> & {
+    onEvent?: (event: TEvent) => void;
+    /** Return false to skip invalidation for this event. */
+    shouldInvalidate?: (event: TEvent) => boolean;
+}): UseSubscriptionReturn<TEvent>;
+/**
+ * One app-wide stream of `{ domain }` change events that keeps list and count
+ * queries fresh: each event invalidates its domain's query keys (debounced),
+ * and a reconnect that proves healthy invalidates every domain to cover
+ * events lost while it was down. Call once, in the signed-in shell.
+ *
+ * ```ts
+ * useInvalidationStream({}, (o) => o.realtime.subscribeChanges.call, {
+ *   domains: { order: { debounceMs: 100, queryKeys: [orpc.order.key()] } }
+ * })
+ * ```
+ */
+export declare function useInvalidationStream<TInput, TEvent extends {
+    domain: string;
+}, TOrpc = RegisteredOrpcUtils>(input: MaybeRefOrGetter<TInput>, subscribe: OrpcSubscribeFn<TInput, TEvent, TOrpc>, options: InvalidationStreamOptions<TEvent> & Pick<UseSubscriptionOptions<TEvent, TOrpc>, 'immediate' | 'respectVisibility' | 'orpc'>): UseSubscriptionReturn<TEvent>;
+/** Localized text for a failed query: your fallback unless the server marked its message user-safe. */
+export declare function useQueryErrorMessage(error: MaybeRefOrGetter<unknown>, fallback: MaybeRefOrGetter<string>): import("vue").ComputedRef<string | null>;
+//# sourceMappingURL=vue.d.ts.map

package/dist/vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue.d.ts","sourceRoot":"","sources":["../src/vue.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,YAAY,EACjB,KAAK,iBAAiB,EAGtB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,OAAO,EAEZ,KAAK,QAAQ,EACb,KAAK,eAAe,EAGpB,QAAQ,IAAI,WAAW,EAEvB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACN,KAAK,GAAG,EAMR,KAAK,gBAAgB,EAErB,KAAK,GAAG,EAKR,MAAM,KAAK,CAAA;AAEZ,OAAO,EAIN,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EAEzB,MAAM,eAAe,CAAA;AAEtB,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAE7E;;;;;;;;GAQG;AAEH,MAAM,WAAW,QAAQ;CAAG;AAE5B,MAAM,MAAM,mBAAmB,GAAG,QAAQ,SAAS;IAAE,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAClE,CAAC,GACD;IACA,oIAAoI,EAAE,KAAK,CAAA;CAC3I,CAAA;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,SAAS;IAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACpE,CAAC,GACD,OAAO,CAAA;AAEV,wEAAwE;AACxE,KAAK,UAAU,CAAC,KAAK,EAAE,IAAI,SAAS,QAAQ,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GACpE,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,GAC/B,KAAK,CAAA;AAKR;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAC1C,GAAG,EAAE,GAAG,EACR,IAAI,EAAE;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACtC,IAAI,CAEN;AAOD,qDAAqD;AACrD,wBAAgB,OAAO,IAAI;IAC1B,MAAM,EAAE,oBAAoB,CAAA;IAC5B,KAAK,EAAE,mBAAmB,CAAA;CAC1B,CAOA;AAoCD;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,GAAG,mBAAmB,IAAI,CAC1E,IAAI,EAAE,KAAK,KACP,CACJ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,KAC5B,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAA;AAEnC,MAAM,WAAW,sBAAsB,CAAC,MAAM,EAAE,KAAK,GAAG,mBAAmB;IAC1E,iFAAiF;IACjF,SAAS,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;IACjD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IAClE,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,SAAS,CAAA;IAC9C,mEAAmE;IACnE,SAAS,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;IACpB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,IAAI,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IAC1C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CACvC;AAED,MAAM,WAAW,qBAAqB,CAAC,MAAM;IAC5C,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;IACrB,WAAW,EAAE,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACjC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;IACxB,WAAW,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACzB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5B,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/B,WAAW,EAAE,MAAM,IAAI,CAAA;CACvB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAClC,MAAM,EACN,MAAM,EACN,KAAK,GAAG,mBAAmB,EAE3B,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAC/B,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EACnD,OAAO,GAAE,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAM,GACjD,qBAAqB,CAAC,MAAM,CAAC,CA2G/B;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,GAAG,mBAAmB,EAAE,aAAa,CAAC,EAAE;IACzE,IAAI,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;CAC1C;eAOC,YAAY,EACZ,MAAM,UACN,KAAK,iBACL,SAAS,SAAS,QAAQ,kCAEf,CACV,IAAI,EAAE,KAAK,KACP,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,KACxE,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC;uBAiBnC,YAAY,EACZ,MAAM,UACN,KAAK,wCACL,SAAS,SAAS,QAAQ,uBAC1B,UAAU,uBAEC,CACV,IAAI,EAAE,KAAK,KACP,uBAAuB,CAC3B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,CACV,KACC,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC;;SAwB3C,KAAK,YACL,MAAM,UACN,UAAU,SACV,QAAQ,uBAEG,CACV,IAAI,EAAE,KAAK,KACP,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,UACzD;YAAE,YAAY,EAAE,UAAU,CAAA;SAAE,GAClC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,GAAG;YAC/D,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,CAAA;YAC1B,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,UAAU,KAAK,IAAI,CAAA;YACxC,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,UAAU,KAAK,OAAO,CAAC,KAAK,CAAC,CAAA;SACvD;SAEA,KAAK,YACL,MAAM,UACN,UAAU,SACV,QAAQ,uBAEG,CACV,IAAI,EAAE,KAAK,KACP,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,GAC/D,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC;;sBAoBpC,MAAM,EAAE,MAAM,SAC/B,gBAAgB,CAAC,MAAM,CAAC,eAClB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,YAC1C,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC;wBAiBtC,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ,YACtB,IAAI,CAAC,sBAAsB,EAAE,UAAU,CAAC;IAEnD,8CAA8C;eAE7C,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,aAE1B,CACV,IAAI,EAAE,KAAK,KACP,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC;IAE/D,gFAAgF;mBACjE,KAAK,GAAG,KAAK,EAAE,IAAI,SAAS,QAAQ,GAAG,QAAQ,SACtD,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,KAC1B,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,SAAS;IAEtC,qDAAqD;mBACtC,KAAK,GAAG,KAAK,EAAE,IAAI,SAAS,QAAQ,GAAG,QAAQ,SACtD,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,WACnB,OAAO,CACf,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,SAAS,EACnC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,SAAS,CACnC;2BAGqB,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ;2BAEzB,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ;yBAE3B,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ;;EAI/C;AAED,KAAK,UAAU,CAAC,YAAY,EAAE,KAAK,IAAI,CACtC,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,KAAK,GAAG,SAAS,KACvB,KAAK,GAAG,SAAS,CAAA;AAEtB,KAAK,gBAAgB,CACpB,MAAM,EACN,UAAU,EACV,YAAY,EACZ,KAAK,EACL,KAAK,EACL,kBAAkB,IACf;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACrC,IAAI,CAAC,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAC9B,6DAA6D;IAC7D,iBAAiB,CAAC,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAA;IACxD;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,KAAK,CAAA;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAClD;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;IACrD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IACxE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CACX,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,EACvB,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,KAC9B,OAAO,CAAC,KAAK,CAAC,CAAA;IACnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,iEAAiE;IACjE,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED,KAAK,eAAe,CAAC,KAAK,EAAE,MAAM,IAAI,UAAU,CAC/C,OAAO,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CACjC,GAAG;IAAE,UAAU,EAAE,GAAG,CAAC,oBAAoB,CAAC,CAAA;CAAE,CAAA;AAE7C;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC3B,MAAM,EACN,UAAU,EACV,YAAY,EACZ,KAAK,GAAG,UAAU,EAClB,MAAM,GAAG,KAAK,EACd,KAAK,GAAG,mBAAmB,EAC3B,kBAAkB,GAAG,MAAM,EAE3B,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAC/B,cAAc,EAAE,CACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,KAAK,KACP,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAA;CAAE,EACjE,WAAW,EAAE,eAAe,CAC3B,OAAO,CAAC,kBAAkB,CAAC,EAC3B,YAAY,EACZ,KAAK,CACL,EACD,GAAG,OAAO,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,GACvC;IACA,OAAO,CAAC,EAAE,gBAAgB,CACzB,MAAM,EACN,UAAU,EACV,YAAY,EACZ,KAAK,EACL,KAAK,EACL,kBAAkB,CAClB;CACD,GACA;IACA,OAAO,EAAE,gBAAgB,CACxB,MAAM,EACN,UAAU,EACV,YAAY,EACZ,KAAK,EACL,KAAK,EACL,kBAAkB,CAClB,GAAG;QAAE,UAAU,EAAE,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAA;KAAE;CAC5D,GACD,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAqGjC;;;GAGG;AACH,wBAAgB,0BAA0B,CACzC,MAAM,EACN,MAAM,EACN,KAAK,GAAG,mBAAmB,EAE3B,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAC/B,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EACnD,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ,EAChC,OAAO,GAAE,IAAI,CACZ,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,EACrC,WAAW,GAAG,WAAW,GAAG,mBAAmB,GAAG,MAAM,CACxD,GAAG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACjC,wDAAwD;IACxD,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;CACxC,GACJ,qBAAqB,CAAC,MAAM,CAAC,CAa/B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CACpC,MAAM,EACN,MAAM,SAAS;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EACjC,KAAK,GAAG,mBAAmB,EAE3B,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAC/B,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EACjD,OAAO,EAAE,yBAAyB,CAAC,MAAM,CAAC,GACzC,IAAI,CACH,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,EACrC,WAAW,GAAG,mBAAmB,GAAG,MAAM,CAC1C,GACA,qBAAqB,CAAC,MAAM,CAAC,CAa/B;AAED,uGAAuG;AACvG,wBAAgB,oBAAoB,CACnC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAChC,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,4CAMlC"}