@fitzzero/quickdraw-core 5.1.1 → 5.1.3

package/dist/{infer-Teo1xpsd.d.ts → infer-Br62cnyW.d.ts}

@@ -296,7 +296,11 @@ interface ViaScope<Model extends string = string, Entry extends string = string,
 }
 /** What `via(...)` takes: the junction model, its entry and scope columns, and `refreshEntry`. */
 interface ViaOptions<Model extends string = string, Entry extends string = string, Scope extends string = string> {
-    /** The junction model, as the database client names it: `"chatMember"`. */
+    /**
+     * The junction model, as the database client names it: `"chatMember"`. It
+     * needs an `id` column (keep the pair unique with `@@unique`, never a
+     * composite `@@id`), or its writes are not tracked and never move a scope.
+     */
     readonly model: Model;
     /** The junction column holding the entry's id: `"chatId"`. */
     readonly entry: Entry;
@@ -378,9 +382,12 @@ declare const STREAM_MAX_SEED = 1000;
 /** A channel's sustained rate when it declares none: messages per second per socket. */
 declare const CHANNEL_DEFAULT_RATE = 30;
 /**
- * The app room a stream's subscriber must be in (`access: { room }`): the
- * room's name, `{ prefix }` for any room whose name starts with it, or for a
- * scoped stream a function of the scope (`(worldId) => \`world:${worldId}\``).
+ * The app room a stream's subscriber must be in (`access: { room }`): for a
+ * global stream the room's name, or `{ prefix }` for any room whose name
+ * starts with it; for a scoped stream a function of the scope
+ * (`(worldId) => \`world:${worldId}\``), since a name or a prefix would let
+ * a socket in that room read every scope (`defineContract` refuses them
+ * there).
  */
 type StreamRoom = string | RoomPrefix | ((scope: string) => string | null | undefined);
 /**
@@ -391,7 +398,9 @@ type StreamRoom = string | RoomPrefix | ((scope: string) => string | null | unde
  * `{ room }` opens it to the sockets in an app room a method joined them to
  * (signed in or not), as a channel's `requires: { room }` does its messages:
  * a socket that leaves the room, or is taken out of it, leaves the feed too.
- * A stream that declares none is closed: no client may subscribe.
+ * A scoped stream computes that room from its scope; a name or `{ prefix }`
+ * serves a global stream only. A stream that declares none is closed: no
+ * client may subscribe.
  */
 type StreamAccess = "public" | "authenticated" | {
     readonly service: AccessLevel;
@@ -418,6 +427,12 @@ type StreamAccess = "public" | "authenticated" | {
     readonly scope?: undefined;
     readonly of?: undefined;
 };
+/**
+ * Who serves a channel or a stream: the server, or the host of the app room
+ * it names (host mode, RFC 0003 section 12.5), a client the app chose with
+ * `ctx.rooms.setHost`, over its peer links.
+ */
+type RealtimeServe = "server" | "host";
 /** A server-to-client stream of append-only items (RFC 0003 section 12.5). */
 interface StreamDef<Item extends StandardSchemaV1 = StandardSchemaV1> {
     /** One item's schema. Pushed items are checked against it before they are sent. */
@@ -436,6 +451,14 @@ interface StreamDef<Item extends StandardSchemaV1 = StandardSchemaV1> {
     readonly volatile?: boolean;
     /** Who may subscribe. Without it the stream is closed. */
     readonly access?: StreamAccess;
+    /**
+     * Who pushes the items: `"server"`, the default, or `"host"`, the host of
+     * the room `access: { room }` computes from the scope. The host's client
+     * pushes them over its peer links, keeping the latest `seed` per scope for
+     * a peer that subscribes later, and the server never sees them. A
+     * host-served stream has a scope and `access: { room: (scope) => room }`.
+     */
+    readonly serve?: RealtimeServe | (string & Record<never, never>);
     /** What the stream carries, in a sentence or two, for the generated docs. */
     readonly describe?: string;
 }
@@ -459,9 +482,10 @@ interface RoomPrefix {
  * (`(payload) => \`lobby:${payload.lobbyId}\``), or `{ prefix }`, any room
  * whose name starts with it (`{ prefix: "world:" }`). Unlike a
  * {@link PayloadSelector}, a string here is the room's name, not a payload
- * key. A name starting with `qd:` or `user:` is never an app room: a literal
- * one (or such a prefix) is refused when the contract is defined, and a
- * computed one drops the message.
+ * key. A name starting with `qd:` or `user:`, or one with the shape of a
+ * Socket.IO socket id (20 letters, digits, `_` or `-`), is never an app
+ * room: a literal one (or such a prefix) is refused when the contract is
+ * defined, and a computed one drops the message.
  */
 type RoomSelector = string | ((payload: never) => string | null | undefined) | RoomPrefix;
 /**
@@ -500,8 +524,22 @@ interface ChannelDef<Payload extends StandardSchemaV1 = StandardSchemaV1> {
     readonly ratePerSecond?: number;
     /** How many messages one socket may send at once. Default twice `ratePerSecond`. */
     readonly burst?: number;
-    /** What the sender must already be subscribed to, or the app room it must be in. */
+    /**
+     * What the sender must already be subscribed to, or the app room it must
+     * be in. Without it every signed-in user may send the channel, about any
+     * row or room its payload names, and the server warns
+     * `channel-without-requires` unless the service declares the channel's
+     * `access` (`"authenticated"` when any signed-in user may send it).
+     */
     readonly requires?: ChannelRequires;
+    /**
+     * Who handles a message: `"server"`, the default, or `"host"`, the host of
+     * the room `requires: { room }` names. The sender's client sends it over
+     * its peer link to that host, whose client checks it as the server checks
+     * a channel message; the server never sees it. A host-served channel
+     * requires a room and takes no server handler.
+     */
+    readonly serve?: RealtimeServe | (string & Record<never, never>);
     /** What a message says, in a sentence or two, for the generated docs. */
     readonly describe?: string;
 }
@@ -795,12 +833,29 @@ type CheckChannels<Def> = CheckRealtimeNames<Def, ChannelsIn<Def>, "channel", ke
         RequiresProblem<Def, Name, ChannelsIn<Def>[Name]>
     ] extends [never] ? unknown : Problem<RequiresProblem<Def, Name, ChannelsIn<Def>[Name]>>;
 };
+/**
+ * A scoped stream's `access: { room }` is a function of its scope (the 5.1
+ * audit's RT-4): a name or `{ prefix }` would let a socket in that room read
+ * every scope. As `IsScopedStream` reads it, a scope other than `"global"`
+ * makes a stream scoped.
+ */
+type StreamRoomProblem<Name, Stream> = Stream extends {
+    readonly scope: infer Scope extends string;
+    readonly access: {
+        readonly room: infer Room;
+    };
+} ? Scope extends "global" ? never : Room extends (...args: never[]) => unknown ? never : `stream "${Name & string}" is scoped: its access room is a function of the scope, (scope) => room; a name or { prefix } lets a socket in that room read every scope` : never;
+type CheckStreams<Def> = CheckRealtimeNames<Def, StreamsIn<Def>, "stream", never> & {
+    readonly [Name in keyof StreamsIn<Def>]: [StreamRoomProblem<Name, StreamsIn<Def>[Name]>] extends [
+        never
+    ] ? unknown : Problem<StreamRoomProblem<Name, StreamsIn<Def>[Name]>>;
+};
 type DefinitionChecks<Def> = CheckKeys<Def, keyof ContractDefinition, "contract"> & {
     readonly methods?: CheckMethods<Def>;
     readonly collections?: CheckCollections<Def>;
     readonly projections?: CheckProjections<Def>;
     readonly fields?: CheckFields<Def>;
-    readonly streams?: CheckRealtimeNames<Def, StreamsIn<Def>, "stream", never>;
+    readonly streams?: CheckStreams<Def>;
     readonly channels?: CheckChannels<Def>;
     readonly events?: CheckRealtimeNames<Def, EventsIn<Def>, "event", keyof StreamsIn<Def> | keyof ChannelsIn<Def>>;
 };
@@ -925,6 +980,22 @@ type StreamName<C extends AnyContract> = keyof C["streams"] & string;
 type ChannelName<C extends AnyContract> = keyof C["channels"] & string;
 /** The names of a contract's typed room events. */
 type EventName<C extends AnyContract> = keyof C["events"] & string;
+/** The names of a contract's channels the room's host handles (`serve: "host"`). */
+type HostChannelName<C extends AnyContract> = {
+    readonly [K in ChannelName<C>]: C["channels"][K] extends {
+        readonly serve: "host";
+    } ? K : never;
+}[ChannelName<C>];
+/** The names of a contract's channels the server handles. */
+type ServerChannelName<C extends AnyContract> = Exclude<ChannelName<C>, HostChannelName<C>>;
+/** The names of a contract's streams the room's host pushes (`serve: "host"`). */
+type HostStreamName<C extends AnyContract> = {
+    readonly [K in StreamName<C>]: C["streams"][K] extends {
+        readonly serve: "host";
+    } ? K : never;
+}[StreamName<C>];
+/** The names of a contract's streams the server pushes. */
+type ServerStreamName<C extends AnyContract> = Exclude<StreamName<C>, HostStreamName<C>>;
 /** The item type of a stream: what `push` takes and subscribers receive. */
 type StreamItemOf<C extends AnyContract, K extends StreamName<C>> = InferOutput<C["streams"][K]["item"]>;
 /**
@@ -941,4 +1012,4 @@ type ChannelInputOf<C extends AnyContract, K extends ChannelName<C>> = InferInpu
 /** The payload type of a custom event: what `ctx.rooms.emit` takes and `useEvent` receives. */
 type EventPayloadOf<C extends AnyContract, K extends EventName<C>> = InferOutput<C["events"][K]["payload"]>;
 
-export { isScopedStream as $, type AccessLevel as A, type ViaScope as B, type CollectionDef as C, DEFAULT_COLLECTION_LIMIT as D, type EntityProjection as E, type Viewer as F, type ViewPredicate as G, defineContract as H, type InferInput as I, type AnyContract as J, type Contract as K, type ContractDefinition as L, type MethodDef as M, type NullableProjection as N, type OrderBy as O, type ProjectionList as P, type QueryDef as Q, type IndexRow as R, StandardJSONSchemaV1 as S, TODO_SCHEMA_VENDOR as T, type ReservedMethodName as U, type ValidationIssue as V, type Watch as W, type RowSchema as X, CHANNEL_DEFAULT_RATE as Y, GLOBAL_STREAM as Z, STREAM_MAX_SEED as _, type ACE as a, type ChannelDef as a0, type ChannelRequires as a1, type EventDef as a2, type PayloadSelector as a3, type RoomPrefix as a4, type RoomSelector as a5, type StreamAccess as a6, type StreamDef as a7, type StreamRoom as a8, type ChannelInputOf as a9, type ViewName as aA, type ChannelName as aa, type ChannelPayloadOf as ab, type CollectionName as ac, type CollectionOf as ad, type ContractMap as ae, type EntityOf as af, type EventName as ag, type EventPayloadOf as ah, type FullProjectionOf as ai, type IndexFieldOf as aj, type IndexRowOf as ak, type InputOf as al, type IsScopedStream as am, type ItemOf as an, type KindOf as ao, type MethodName as ap, type MethodOf as aq, type OutputOf as ar, type ParsedInputOf as as, type ProjectionName as at, type ProjectionOf as au, type ReceivedRow as av, type ScopeOf as aw, type ServiceNameOf as ax, type StreamItemOf as ay, type StreamName as az, type ACL as b, type InferOutput as c, StandardSchemaV1 as d, type StandardSchemaWithJSON as e, StandardTypedV1 as f, type TodoSchemaOptions as g, hasJsonSchema as h, isStandardSchema as i, type ValidationResult as j, type MethodKind as k, listOf as l, mutation as m, nullable as n, type MethodOutput as o, type MutationDef as p, query as q, type ProjectionRef as r, type ServiceModelsWatch as s, todoSchema as t, type ServiceWatch as u, validate as v, DEFAULT_COLLECTION_MAX_LIMIT as w, via as x, type CollectionWhere as y, type SortDirection as z };
+export { isScopedStream as $, type AccessLevel as A, type ViaScope as B, type CollectionDef as C, DEFAULT_COLLECTION_LIMIT as D, type EntityProjection as E, type Viewer as F, type ViewPredicate as G, defineContract as H, type InferInput as I, type AnyContract as J, type Contract as K, type ContractDefinition as L, type MethodDef as M, type NullableProjection as N, type OrderBy as O, type ProjectionList as P, type QueryDef as Q, type IndexRow as R, StandardJSONSchemaV1 as S, TODO_SCHEMA_VENDOR as T, type ReservedMethodName as U, type ValidationIssue as V, type Watch as W, type RowSchema as X, CHANNEL_DEFAULT_RATE as Y, GLOBAL_STREAM as Z, STREAM_MAX_SEED as _, type ACE as a, type ChannelDef as a0, type ChannelRequires as a1, type EventDef as a2, type PayloadSelector as a3, type RoomPrefix as a4, type RoomSelector as a5, type StreamAccess as a6, type StreamDef as a7, type StreamRoom as a8, type ChannelInputOf as a9, type ViewName as aA, type ServerChannelName as aB, type ServerStreamName as aC, type HostStreamName as aD, type HostChannelName as aE, type ChannelName as aa, type ChannelPayloadOf as ab, type CollectionName as ac, type CollectionOf as ad, type ContractMap as ae, type EntityOf as af, type EventName as ag, type EventPayloadOf as ah, type FullProjectionOf as ai, type IndexFieldOf as aj, type IndexRowOf as ak, type InputOf as al, type IsScopedStream as am, type ItemOf as an, type KindOf as ao, type MethodName as ap, type MethodOf as aq, type OutputOf as ar, type ParsedInputOf as as, type ProjectionName as at, type ProjectionOf as au, type ReceivedRow as av, type ScopeOf as aw, type ServiceNameOf as ax, type StreamItemOf as ay, type StreamName as az, type ACL as b, type InferOutput as c, StandardSchemaV1 as d, type StandardSchemaWithJSON as e, StandardTypedV1 as f, type TodoSchemaOptions as g, hasJsonSchema as h, isStandardSchema as i, type ValidationResult as j, type MethodKind as k, listOf as l, mutation as m, nullable as n, type MethodOutput as o, type MutationDef as p, query as q, type ProjectionRef as r, type ServiceModelsWatch as s, todoSchema as t, type ServiceWatch as u, validate as v, DEFAULT_COLLECTION_MAX_LIMIT as w, via as x, type CollectionWhere as y, type SortDirection as z };

package/dist/logger-Yz93KzdV.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Logger interface compatible with Winston and other loggers
+ */
+interface Logger {
+    info(message: string, meta?: Record<string, unknown>): void;
+    warn(message: string, meta?: Record<string, unknown>): void;
+    error(message: string, meta?: Record<string, unknown>): void;
+    debug(message: string, meta?: Record<string, unknown>): void;
+    child(options: Record<string, unknown>): Logger;
+}
+/** A logger's levels, lowest first. */
+type LogLevel = "debug" | "info" | "warn" | "error";
+/** Options of {@link createConsoleLogger}. */
+interface ConsoleLoggerOptions {
+    /**
+     * The lowest level written. Default `"info"` when `NODE_ENV` is
+     * `"production"` (read at each call), else `"debug"`.
+     */
+    readonly level?: LogLevel;
+}
+/**
+ * A logger that writes to the console from `level` up: by default every
+ * level, but `debug` when `NODE_ENV` is "production". `child` returns the
+ * same logger.
+ */
+declare function createConsoleLogger(options?: ConsoleLoggerOptions): Logger;
+/** The default console logger: every level, but `debug` in production. */
+declare const consoleLogger: Logger;
+
+export { type ConsoleLoggerOptions as C, type Logger as L, createConsoleLogger as a, type LogLevel as b, consoleLogger as c };

package/dist/{metrics-BdBu5o8G.d.ts → metrics-CTVpw0gu.d.ts}

@@ -1,6 +1,6 @@
-import { k as MethodKind } from './infer-Teo1xpsd.js';
+import { k as MethodKind } from './infer-Br62cnyW.js';
 import { a as ErrorCode } from './errors-S-bxEIBC.js';
-import { T as Transport } from './types-Cu0vmx7c.js';
+import { T as Transport } from './types-CLRCQGnO.js';
 
 /** How a call ended: `"ok"`, `"not-modified"`, or the error code it failed with. */
 type CallOutcome = "ok" | "not-modified" | ErrorCode;

package/dist/origins-kvpxnVcW.d.ts

@@ -0,0 +1,8 @@
+/**
+ * An allowed origin: exact (`"https://app.example.com"`), or a pattern over
+ * whole origins, anchored at both ends
+ * (`/^https:\/\/[a-z0-9-]+\.preview\.example\.com$/`).
+ */
+type AllowedOrigin = string | RegExp;
+
+export type { AllowedOrigin as A };

package/dist/parser.js

@@ -1,6 +1,7 @@
 import {
   createJsonParser
-} from "./chunk-Z2LZ7IZ7.js";
+} from "./chunk-SN3OZVEQ.js";
+import "./chunk-7Y5ROPXL.js";
 export {
   createJsonParser
 };

package/dist/prisma/index.d.ts

@@ -1,9 +1,11 @@
-import { L as Logger } from '../logger-BY28acW-.js';
-export { C as CountArgs, F as FindManyArgs, c as StatementCount, S as StorageAdapter, a as StorageRow, b as StorageWhere, s as storageOf } from '../caller-CXTFswBO.js';
-import '../envelope-Cp3YcVxC.js';
-import '../infer-Teo1xpsd.js';
+import { L as Logger } from '../logger-Yz93KzdV.js';
+import { T as Tracked } from '../tracked-BR5b2O-U.js';
+export { a as TrackedTransaction } from '../tracked-BR5b2O-U.js';
+export { C as CountArgs, F as FindManyArgs, c as StatementCount, S as StorageAdapter, a as StorageRow, b as StorageWhere, s as storageOf } from '../caller-BTwGl7vm.js';
+import '../infer-Br62cnyW.js';
+import '../types-CLRCQGnO.js';
+import '../envelope-BMBaxppV.js';
 import '../errors-S-bxEIBC.js';
-import '../types-Cu0vmx7c.js';
 
 /** Options of {@link trackPrisma}. */
 interface TrackPrismaOptions {
@@ -37,6 +39,11 @@ interface PrismaClientLike {
  * Nested writes, raw SQL and database cascades are not seen; record those
  * with `ctx.touch`.
  *
+ * The result is a `Tracked<C>` (`tracked.ts`): still a `C`, but the
+ * untracked client is no `Tracked<C>`, so a helper that writes takes
+ * `db: Tracked<Db>` (or `TrackedTransaction<Db>`, which a transaction's `tx`
+ * is too) and the compiler refuses the untracked client there.
+ *
  * Prefer interactive transactions (`db.$transaction(async (tx) => ...)`). An
  * array-form `db.$transaction([...])` has no transaction client, so the rows
  * a `deleteMany` or `updateMany` there reads first (and an `update`'s old
@@ -49,7 +56,7 @@ interface PrismaClientLike {
  * export const qd = initQuickdraw<{ db: typeof db; principal: AppPrincipal }>();
  * const server = qd.createServer({ app, services, db, auth });
  */
-declare function trackPrisma<C extends PrismaClientLike>(client: C, options?: TrackPrismaOptions): C;
+declare function trackPrisma<C extends PrismaClientLike>(client: C, options?: TrackPrismaOptions): Tracked<C>;
 
 /** One nested write found in a write's `data`. */
 interface NestedWrite {
@@ -61,4 +68,4 @@ interface NestedWrite {
 /** The nested writes in `data`, one per relation field that has one. */
 declare function findNestedWrites(data: unknown): NestedWrite[];
 
-export { type NestedWrite, type PrismaClientLike, type TrackPrismaOptions, findNestedWrites, trackPrisma };
+export { type NestedWrite, type PrismaClientLike, type TrackPrismaOptions, Tracked, findNestedWrites, trackPrisma };