@rindle/api-server 0.1.0-rc.5

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,73 @@
+# @rindle/api-server
+
+Framework-neutral helpers for the application API server in daemon/serverless Rindle deployments.
+
+Default public API paths:
+
+- `POST /api/rindle/query`
+- `POST /api/rindle/read`
+- `POST /api/rindle/mutate`
+
+`read` is the one-shot read path (`handleReadJson`): it parses a default `{ name, args }` body and
+runs the query once for a server-rendered/SSR read, holding a short-lived lease (`readIdleTtlMs`)
+unless the browser's follow-up `subscribe` lands first. `query` mints the subscription lease and
+`mutate` runs named mutators.
+
+The API server remains the application authority. It authenticates requests, optionally runs the
+SDK authorizer hooks, resolves named queries to ASTs, and runs named mutators. The daemon only sees
+approved ASTs and approved write/rejection records.
+
+A query is defined **once** with `defineQuery` (in `@rindle/client`), co-located with the component
+that reads it, and the same value is registered here. `registerQueries` turns the list of those
+co-located queries into the server's query surface — it re-runs each query's validator on the
+untrusted wire args and builds the authoritative AST, so client and server resolve a byte-identical
+query:
+
+```ts
+import { createRindleApiServer, registerQueries, defineApiMutators } from "@rindle/api-server";
+import { HttpRindleDaemonClient } from "@rindle/daemon-client";
+import { issuesPageQuery, myIssuesQuery } from "./components/IssueListItem.queries.ts";
+
+const rindle = createRindleApiServer({
+  daemon: new HttpRindleDaemonClient({ baseUrl: "https://rindle.internal" }),
+  queries: registerQueries([issuesPageQuery, myIssuesQuery]),
+  mutators: defineApiMutators({
+    createIssue: (tx, args) => {
+      tx.exec("INSERT INTO issue (id, title) VALUES (?, ?)", [args.id, args.title]);
+    },
+  }),
+  authorizeQuery: ({ user }) => Boolean(user),
+  authorizeMutation: ({ user }) => Boolean(user),
+});
+```
+
+`registerQueries` forwards the request's authoritative `ApiContext` (`{ user, request }`) as a
+context-scoped query's ctx, so a per-principal query (e.g. "my issues") is built from the server's
+trusted identity — never a client-supplied arg.
+
+When the server must **diverge** from the client — add a tenancy/auth filter the client can't see —
+use `defineApiQueries`, which maps a name directly to a `(ctx, args)` resolver. Register a
+server-specific query under the same name and it wins (both are plain `{ name → resolver }` maps, so
+spread them together):
+
+```ts
+import { defineApiQueries, registerQueries } from "@rindle/api-server";
+
+const queries = {
+  ...registerQueries([issuesPageQuery, myIssuesQuery]),
+  ...defineApiQueries({
+    // SAME name as the client's issuesPage — the later spread wins, so this server-only resolver
+    // overrides it and adds a tenancy filter (the `where`) the client's query never carries.
+    issuesPage: (ctx, _args) => q.issue.where.tenantId(ctx.user).orderBy("id", "asc"),
+  }),
+};
+```
+
+There is no scope key. If two requests resolve to the same canonical AST, the daemon may dedupe
+them because the result is the same. If tenant or user visibility matters, encode it into the AST.
+
+The mutate handler also accepts `{ envelopes: [...] }` — an in-order batch (the client-side
+`createQueuedMutationSender` from `@rindle/remote` flushes these) — and replies with an array.
+Envelopes run strictly sequentially; a policy rejection still advances the daemon's lmid, so
+later envelopes stay contiguous and keep applying. A daemon *error* fails the whole batch: the
+client retries it and the daemon's mid dedup absorbs the already-applied prefix.

package/dist/index.d.ts

@@ -0,0 +1,256 @@
+import type { Ast, MutationEnvelope, NamedQuery, Query } from "@rindle/client";
+import type { DematerializeInput, DematerializeOutput, MaterializationPolicy, MaterializeInput, MaterializeOutput, MigrateInput, MigrateOutput, MutationRejection, MutationRejectionOutput, QueryOnceInput, QueryOnceOutput, RindleDaemonClient, RowChangeTxn, RowChangeTxnOutput, SqlStatement, SqlTxn, SqlTxnOutput, StreamMode, WireValue } from "@rindle/daemon-client";
+export declare const DEFAULT_RINDLE_API_ROUTES: {
+    readonly query: "/api/rindle/query";
+    readonly read: "/api/rindle/read";
+    readonly mutate: "/api/rindle/mutate";
+};
+export type MaybePromise<T> = T | PromiseLike<T>;
+export interface ApiContext<User> {
+    user: User;
+    request?: unknown;
+}
+export type ApiQueryResult = Ast | Query<any, any, any>;
+export type ApiQuery<User, Args> = (ctx: ApiContext<User>, args: Args) => MaybePromise<ApiQueryResult>;
+export type ApiQueries<User> = Record<string, ApiQuery<User, any>>;
+export interface RunQueryInput<User> {
+    user: User;
+    name: string;
+    args: unknown;
+    query: ApiQuery<User, any>;
+    context: ApiContext<User>;
+}
+export type RunQuery<User> = (input: RunQueryInput<User>) => MaybePromise<ApiQueryResult>;
+export interface AuthorizeQueryInput<User> {
+    user: User;
+    name: string;
+    args: unknown;
+    context: ApiContext<User>;
+}
+export interface AuthorizeMutationInput<User> {
+    user: User;
+    envelope: MutationEnvelope;
+    context: ApiContext<User>;
+}
+export type Authorizer<T> = (input: T) => MaybePromise<boolean | void>;
+export interface MutationContext<User> {
+    user: User;
+    envelope: MutationEnvelope;
+    daemon: RindleDaemonClient;
+    request?: unknown;
+}
+export interface SqlMutationTx {
+    exec(sql: string, params?: WireValue[]): void;
+    readonly statements: readonly SqlStatement[];
+}
+export type ApiMutatorResult = void | SqlStatement[] | SqlTxn;
+export type ApiMutator<User, Args> = (tx: SqlMutationTx, args: Args, ctx: MutationContext<User>) => MaybePromise<ApiMutatorResult>;
+export type ApiMutators<User> = Record<string, ApiMutator<User, any>>;
+export interface QueryLeaseRequest<User> {
+    user: User;
+    name: string;
+    args: unknown;
+    request?: unknown;
+    /** The browser's stable `clientId` (sent on the query POST) — the anonymous routing-key fallback
+     *  when there is no authenticated subject and no session cookie (READ-ROUTER-DESIGN.md §1.5/§2.2).
+     *  A routing HINT only, never authorization. */
+    clientId?: string;
+}
+export interface QueryLeaseResponse {
+    leaseToken: string;
+    materializationId: string;
+    queryKey?: string;
+    reused?: boolean;
+    /** The follower this lease lives on (READ-ROUTER-DESIGN.md §2.3) — the browser opens its
+     *  subscription ws here. Absent ⇒ single-daemon (the client uses its static `wsUrl`). */
+    wsEndpoint?: string;
+}
+/** A one-shot SSR read of a named query (SSR-DESIGN.md §6): same `(name, args)` surface as a lease,
+ *  but the daemon serializes the current view ONCE and registers no subscriber. */
+export interface QueryReadRequest<User> {
+    user: User;
+    name: string;
+    args: unknown;
+    request?: unknown;
+    /** The browser's stable `clientId` — the anonymous routing-key fallback (see
+     *  {@link QueryLeaseRequest.clientId}). Lets the SSR read co-locate on the follower the booting
+     *  client's first subscribe will hit (READ-ROUTER-DESIGN.md §2.4). */
+    clientId?: string;
+}
+/** The assembled (nested-by-name) first-paint snapshot the server-side Store seeds + dehydrates
+ *  (SSR-DESIGN.md §3.3). `rows` hydrate without an engine; `cvMin` is their watermark baseline. */
+export interface QueryReadResponse {
+    rows: Array<{
+        cols: Record<string, unknown>;
+        [rel: string]: unknown;
+    }>;
+    cvMin?: number;
+    queryKey?: string;
+    /** The follower this read warmed (READ-ROUTER-DESIGN.md §2.4) — inject it into the SSR bootstrap
+     *  so the booting client opens its ws to the same warm follower. Absent ⇒ single-daemon. */
+    wsEndpoint?: string;
+}
+export interface PushMutationRequest<User> {
+    user: User;
+    envelope: MutationEnvelope;
+    request?: unknown;
+}
+export interface PushMutationsRequest<User> {
+    user: User;
+    envelopes: MutationEnvelope[];
+    request?: unknown;
+}
+export type PushMutationResponse = {
+    accepted: true;
+    rejected: false;
+    output: SqlTxnOutput;
+} | {
+    accepted: false;
+    rejected: true;
+    reason: string;
+    output?: unknown;
+};
+export interface RindleApiRoutes {
+    query: string;
+    read: string;
+    mutate: string;
+}
+/** A named query to keep permanently materialized (warm with zero subscribers). */
+export interface PinnedQuery {
+    name: string;
+    args?: unknown;
+}
+/** The explicit fleet pin fan-out seam (READ-ROUTER-DESIGN.md §4.2). The api-server resolves each
+ *  pin's authoritative AST under `pinUser` and hands the ready {@link MaterializeInput}s here; the
+ *  implementation (the read router) fans EACH across all live followers. Distinct, on purpose, from
+ *  a per-viewer `materialize` (which routes ONE) — a pin-assert always sprays ALL. */
+export interface PinFanout {
+    assertPins(pins: readonly MaterializeInput[]): Promise<void>;
+}
+export interface RindleApiServerOptions<User> {
+    daemon: RindleDaemonClient;
+    queries?: ApiQueries<User>;
+    runQuery?: RunQuery<User>;
+    mutators?: ApiMutators<User>;
+    authorizeQuery?: Authorizer<AuthorizeQueryInput<User>>;
+    authorizeMutation?: Authorizer<AuthorizeMutationInput<User>>;
+    routes?: Partial<RindleApiRoutes>;
+    mode?: StreamMode;
+    materializationPolicy?: MaterializationPolicy | ((input: QueryLeaseRequest<User>) => MaybePromise<MaterializationPolicy>);
+    leaseTtlMs?: number;
+    /** Idle TTL (ms) the warm pipeline a one-shot SSR {@link RindleApiServer.readQuery read} leaves
+     *  behind is held at (SSR-DESIGN.md §3.4) — it must comfortably cover page-load + client-boot +
+     *  the follow-up live `subscribe` so the browser lands on a still-warm pipeline (the warm
+     *  handoff). The TTL is NOT part of the dedup key (max-wins), so it only ever extends a shared
+     *  query's window. Absent ⇒ the daemon's default idle TTL. */
+    readIdleTtlMs?: number;
+    subject?: string | ((input: QueryLeaseRequest<User>) => MaybePromise<string | undefined>);
+    /** The ANONYMOUS routing key forwarded to the read router (READ-ROUTER-DESIGN.md §2.2) — used by
+     *  HRW placement when there is no authenticated `subject`. The router keys on `subject ?? this`;
+     *  the resolved value rides `metadata.routingKey` to the daemon. Default: the browser-supplied
+     *  `clientId` (from the query POST body). NOTE: the default cannot co-locate an ANONYMOUS SSR read
+     *  with the booting client — an SSR server can't see the browser's localStorage `clientId`, so the
+     *  two legs compute different keys and §2.4's warm handoff misses (still correct — just an extra
+     *  first-touch materialize). For anonymous SSR co-location, set this to read a server-set session
+     *  cookie from `input.request` (it rides the SSR request AND every browser request). A routing
+     *  HINT only — never authorization. Ignored by a single (unrouted) daemon, which has nothing to
+     *  route. */
+    routingKey?: string | ((input: QueryLeaseRequest<User>) => MaybePromise<string | undefined>);
+    /** The EXPLICIT fleet pin fan-out (READ-ROUTER-DESIGN.md §4.2 "push") — when set,
+     *  {@link RindleApiServer.assertPins} fans each resolved pin across ALL live followers through it
+     *  (e.g. `createRouterPinClient` from `@rindle/router`) instead of materializing each pin once on
+     *  the (single) daemon. A per-viewer `materialize` always routes ONE; a pin-assert always fans
+     *  ALL — never inferred from `policy.kind`. Absent ⇒ single-daemon behavior (one materialize per
+     *  pin). */
+    pinFanout?: PinFanout;
+    /** Named queries to keep permanently materialized via {@link RindleApiServer.assertPins}.
+     *  Each is materialized with a `pinned` policy (survives zero subscribers) so late joiners
+     *  attach to an already-warm result. Pins are viewer-independent — resolved with `pinUser`. */
+    pinnedQueries?: PinnedQuery[];
+    /** The user context pins resolve under (pins are shared, so they should not depend on a
+     *  per-viewer identity). Defaults to `undefined`. */
+    pinUser?: User;
+}
+export interface RindleApiServer<User> {
+    readonly routes: RindleApiRoutes;
+    createQueryLease(input: QueryLeaseRequest<User>): Promise<QueryLeaseResponse>;
+    /** (Re-)materialize every `pinnedQueries` entry with a pinned policy. Idempotent — the daemon
+     *  dedupes by canonical query, so a re-assert reuses the existing materialization. Call it at
+     *  startup and whenever the daemon restarts (e.g. from the daemon-client `onBootId` hook), since
+     *  the daemon holds no durable materialization state. No-op when `pinnedQueries` is empty. */
+    assertPins(): Promise<void>;
+    pushMutation(input: PushMutationRequest<User>): Promise<PushMutationResponse>;
+    /** Apply an in-order batch (the client mutation queue's flush). Envelopes run strictly
+     *  sequentially; a rejection still advances the daemon's lmid, so later envelopes in the
+     *  batch stay contiguous and keep applying. A daemon ERROR throws for the whole batch —
+     *  the client retries it and the daemon's mid dedup absorbs the already-applied prefix. */
+    pushMutations(input: PushMutationsRequest<User>): Promise<PushMutationResponse[]>;
+    /** One-shot SSR read (SSR-DESIGN.md §6): resolve `(name, args)` → AST (same authority path as a
+     *  lease, `authorizeQuery` enforced), have the daemon serialize the current view once, and return
+     *  the assembled rows for the loader to seed + dehydrate. Registers NO subscriber — a dropped
+     *  render leaks nothing; the pipeline self-reclaims after the idle TTL ({@link
+     *  RindleApiServerOptions.readIdleTtlMs}) unless the browser's follow-up `subscribe` lands first. */
+    readQuery(input: QueryReadRequest<User>): Promise<QueryReadResponse>;
+    handleQueryJson(body: unknown, context: ApiContext<User>): Promise<QueryLeaseResponse>;
+    /** Parse a default `{name, args}` read body and run {@link readQuery}. */
+    handleReadJson(body: unknown, context: ApiContext<User>): Promise<QueryReadResponse>;
+    /** Accepts `{envelope}` (one) or `{envelopes: [...]}` (an in-order batch → array reply). */
+    handleMutateJson(body: unknown, context: ApiContext<User>): Promise<PushMutationResponse | PushMutationResponse[]>;
+}
+export type RindleApiErrorCode = "bad-request" | "forbidden" | "not-found" | "rejected";
+export declare class RindleApiError extends Error {
+    readonly code: RindleApiErrorCode;
+    readonly status: number;
+    constructor(code: RindleApiErrorCode, message: string, status: number);
+}
+/**
+ * A read/write-split `RindleDaemonClient` (READ-ROUTER-DESIGN.md §2.1). Writes
+ * (`executeSqlTxn` / `rejectMutation` / `applyRowChangeTxn` / `migrate`) go to the single
+ * write-master, UNCHANGED and never through the router; reads (`materialize` / `query` /
+ * `dematerialize`) go to the read router. Hand one of these to {@link createRindleApiServer} as
+ * `daemon` to point the reads leg at the router while writes stay on the master — no placement
+ * logic enters the api-server.
+ *
+ * ```ts
+ * const daemon = new SplitDaemonClient(
+ *   new HttpRindleDaemonClient({ baseUrl: MASTER_URL, headers: writeAuth }),  // writes → master
+ *   new HttpRindleDaemonClient({ baseUrl: ROUTER_URL, headers: routerAuth }), // reads  → router
+ * );
+ * ```
+ */
+export declare class SplitDaemonClient implements RindleDaemonClient {
+    private readonly writes;
+    private readonly reads;
+    constructor(writes: RindleDaemonClient, reads: RindleDaemonClient);
+    executeSqlTxn(input: SqlTxn): Promise<SqlTxnOutput>;
+    rejectMutation(input: MutationRejection): Promise<MutationRejectionOutput>;
+    applyRowChangeTxn(input: RowChangeTxn): Promise<RowChangeTxnOutput>;
+    migrate(input: MigrateInput): Promise<MigrateOutput>;
+    materialize(input: MaterializeInput): Promise<MaterializeOutput>;
+    query(input: QueryOnceInput): Promise<QueryOnceOutput>;
+    dematerialize(input: DematerializeInput): Promise<DematerializeOutput>;
+}
+export declare function defineApiQueries<User, Q extends ApiQueries<User>>(queries: Q): Q;
+/**
+ * Register a list of co-located client {@link NamedQuery `defineQuery`} values as the server's query
+ * surface — the bulk, no-boilerplate counterpart to {@link defineApiQueries}. Each query already
+ * carries its wire `name` and a `resolve` that re-runs its validator on the UNTRUSTED wire args and
+ * builds the authoritative `Query`, so the server just imports every co-located query and hands the
+ * list here. The same validated args build a byte-identical AST on both tiers.
+ *
+ * The query's AUTHORITATIVE {@link ApiContext} is forwarded as `resolve`'s ctx — so a context-scoped
+ * `defineQuery` (e.g. "my issues") is built from the server's trusted principal, never the client's.
+ * A context-free query simply ignores the extra argument.
+ *
+ * Use {@link defineApiQueries} instead (or in addition) only when the server must DIVERGE from the
+ * client — define a server-specific `defineQuery` with the same name and register that.
+ *
+ * ```ts
+ * queries: registerQueries<User>([issuesPageQuery, issueDetailQuery, recentCommentsQuery, usersQuery]),
+ * ```
+ */
+export declare function registerQueries<User>(queries: readonly NamedQuery<any, any, any>[]): ApiQueries<User>;
+export declare function defineApiMutators<User, M extends ApiMutators<User>>(mutators: M): M;
+export declare function queryResultToAst(result: ApiQueryResult): Ast;
+export declare function createRindleApiServer<User = unknown>(opts: RindleApiServerOptions<User>): RindleApiServer<User>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,gBAAgB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,uBAAuB,EACvB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,MAAM,EACN,YAAY,EACZ,UAAU,EACV,SAAS,EACV,MAAM,uBAAuB,CAAC;AAE/B,eAAO,MAAM,yBAAyB;;;;CAI5B,CAAC;AAEX,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAEjD,MAAM,WAAW,UAAU,CAAC,IAAI;IAC9B,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,cAAc,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,MAAM,QAAQ,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC,cAAc,CAAC,CAAC;AACvG,MAAM,MAAM,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AAEnE,MAAM,WAAW,aAAa,CAAC,IAAI;IACjC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,MAAM,MAAM,QAAQ,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,cAAc,CAAC,CAAC;AAE1F,MAAM,WAAW,mBAAmB,CAAC,IAAI;IACvC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB,CAAC,IAAI;IAC1C,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;AAEvE,MAAM,WAAW,eAAe,CAAC,IAAI;IACnC,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,UAAU,EAAE,SAAS,YAAY,EAAE,CAAC;CAC9C;AAED,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;AAC9D,MAAM,MAAM,UAAU,CAAC,IAAI,EAAE,IAAI,IAAI,CACnC,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,KACvB,YAAY,CAAC,gBAAgB,CAAC,CAAC;AACpC,MAAM,MAAM,WAAW,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AAEtE,MAAM,WAAW,iBAAiB,CAAC,IAAI;IACrC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;oDAEgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;6FACyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;mFACmF;AACnF,MAAM,WAAW,gBAAgB,CAAC,IAAI;IACpC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;0EAEsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;mGACmG;AACnG,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;gGAC4F;IAC5F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB,CAAC,IAAI;IACvC,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB,CAAC,IAAI;IACxC,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,oBAAoB,GAC5B;IAAE,QAAQ,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,YAAY,CAAA;CAAE,GACzD;IAAE,QAAQ,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE1E,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,mFAAmF;AACnF,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;sFAGsF;AACtF,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,IAAI,EAAE,SAAS,gBAAgB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,sBAAsB,CAAC,IAAI;IAC1C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,OAAO,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAC3B,QAAQ,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC1B,QAAQ,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7B,cAAc,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;IACvD,iBAAiB,CAAC,EAAE,UAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,qBAAqB,CAAC,EAClB,qBAAqB,GACrB,CAAC,CAAC,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;kEAI8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC1F;;;;;;;;;iBASa;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAC7F;;;;;gBAKY;IACZ,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;mGAE+F;IAC/F,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B;yDACqD;IACrD,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB;AAED,MAAM,WAAW,eAAe,CAAC,IAAI;IACnC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC;IACjC,gBAAgB,CAAC,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E;;;kGAG8F;IAC9F,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,YAAY,CAAC,KAAK,EAAE,mBAAmB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC9E;;;+FAG2F;IAC3F,aAAa,CAAC,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAClF;;;;yGAIqG;IACrG,SAAS,CAAC,KAAK,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrE,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACvF,0EAA0E;IAC1E,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrF,4FAA4F;IAC5F,gBAAgB,CACd,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,GACxB,OAAO,CAAC,oBAAoB,GAAG,oBAAoB,EAAE,CAAC,CAAC;CAC3D;AAED,MAAM,MAAM,kBAAkB,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;AAExF,qBAAa,cAAe,SAAQ,KAAK;IACvC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAMtE;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,iBAAkB,YAAW,kBAAkB;IAC1D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAqB;gBAE/B,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,kBAAkB;IAMjE,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAGnD,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAG1E,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAGnE,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAKpD,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAGhE,KAAK,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAGtD,aAAa,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAGvE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,CAAC,SAAS,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAEhF;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,CASrG;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,CAAC,SAAS,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC,CAEnF;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,GAAG,GAAG,CAK5D;AAED,wBAAgB,qBAAqB,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAsM/G"}