better-ship 0.4.1 → 0.6.0

package/dist/index-BStnggQO.d.ts

@@ -0,0 +1,584 @@
+import { z } from "zod";
+//#region src/core/failure-classification.d.ts
+/**
+ * What one failure is, before any policy decides what to do about it.
+ *
+ * `transient`: the world may differ on the next attempt. `terminal`: repeating gives the
+ * same answer. `unknown`: nobody judged this error, so it came from outside unwrapped.
+ */
+type FailureClassification = 'transient' | 'terminal' | 'unknown';
+/**
+ * Who is asking to repeat the work.
+ *
+ * An immediate owner holds a caller and a socket open. A durable owner already stored the
+ * work, so it can afford to try again on a failure nobody classified.
+ */
+type RetryOwner = 'immediate' | 'durable';
+/** Decide whether one retry owner may repeat a failed operation. */
+declare function shouldRetryFailure(args: {
+  readonly classification: FailureClassification;
+  readonly repeatSafe: boolean;
+  readonly owner: RetryOwner;
+}): boolean;
+//#endregion
+//#region src/core/app-error.d.ts
+/**
+ * The base of every expected failure. A subclass declares its tag and its classification,
+ * so no boundary has to guess what kind of failure it holds. A boundary tells our errors from
+ * raw throws with `instanceof AppError`; a value that fails it was never judged.
+ *
+ * A `readonly` field with a literal initializer keeps the literal type, so
+ * `readonly _tag = 'StoreUnavailable'` is enough for `Result` unions and `matchError`.
+ */
+declare abstract class AppError extends Error {
+  abstract readonly _tag: string;
+  abstract readonly classification: FailureClassification;
+  get name(): string;
+}
+//#endregion
+//#region src/core/authentication.error.d.ts
+/** A protected operation requires a session that the caller did not provide. */
+declare class AuthenticationError extends AppError {
+  readonly _tag = "AuthenticationError";
+  readonly classification = "terminal";
+  constructor();
+}
+//#endregion
+//#region src/core/rate-limit.error.d.ts
+/** HTTP 429 with a retry delay in seconds. A null delay means the response supplies no valid duration. */
+declare class RateLimitError extends AppError {
+  readonly retryAfter: number | null;
+  readonly _tag = "RateLimitError";
+  readonly classification = "transient";
+  readonly status = 429;
+  constructor(retryAfter: number | null);
+}
+//#endregion
+//#region src/core/stale-session.error.d.ts
+/** A presented session cookie no longer resolves; the application owns cleanup and redirect policy. */
+declare class StaleSessionError extends AppError {
+  readonly _tag = "StaleSessionError";
+  readonly classification = "terminal";
+  constructor();
+}
+//#endregion
+//#region src/core/not-authorized.error.d.ts
+/** The authenticated caller cannot perform this operation. Ported from Porte's auth.errors.ts. */
+declare class NotAuthorizedError extends AppError {
+  readonly _tag = "NotAuthorizedError";
+  readonly classification = "terminal";
+  constructor();
+}
+//#endregion
+//#region src/core/internal.errors.d.ts
+/** Safe public replacement for an unknown failure, ported from Porte's internal.errors.ts. */
+declare class InternalServerError extends AppError {
+  readonly _tag = "InternalServerError";
+  readonly classification = "unknown";
+  constructor();
+}
+/** Safe public replacement for a classified transient failure. */
+declare class ServiceUnavailableError extends AppError {
+  readonly _tag = "ServiceUnavailableError";
+  readonly classification = "transient";
+  constructor();
+}
+//#endregion
+//#region src/core/problem-details.d.ts
+/**
+ * The standard RFC 9457 body for a failed HTTP response.
+ * The HTTP response status remains authoritative; extensions may add problem-specific data.
+ * @see https://http.dev/problem-details
+ */
+declare const ProblemDetailsSchema: z.ZodObject<{
+  type: z.ZodString;
+  title: z.ZodString;
+  detail: z.ZodOptional<z.ZodString>;
+  instance: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+/** An RFC 9457 problem body for a failed HTTP response. */
+type ProblemDetails = z.infer<typeof ProblemDetailsSchema>;
+/** One invalid value in a `422` validation problem. */
+declare const ValidationProblemErrorSchema: z.ZodObject<{
+  detail: z.ZodString;
+  pointer: z.ZodString;
+}, z.core.$strip>;
+/** One invalid value in a `422` validation problem. */
+type ValidationProblemError = z.infer<typeof ValidationProblemErrorSchema>;
+/** An RFC 9457 validation problem with one or more invalid content values. */
+declare const ValidationProblemDetailsSchema: z.ZodObject<{
+  type: z.ZodString;
+  title: z.ZodString;
+  detail: z.ZodOptional<z.ZodString>;
+  instance: z.ZodOptional<z.ZodString>;
+  errors: z.ZodArray<z.ZodObject<{
+    detail: z.ZodString;
+    pointer: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$loose>;
+/** An RFC 9457 validation problem with one or more invalid content values. */
+type ValidationProblemDetails = z.infer<typeof ValidationProblemDetailsSchema>;
+//#endregion
+//#region src/core/request.errors.d.ts
+/** One invalid value as a validator reports it: a message and a path of keys. */
+type ValidationIssue = {
+  readonly message: string;
+  readonly path: readonly PropertyKey[];
+};
+/** Invalid user input, one entry per invalid value in the RFC 9457 shape. Technical failures use another error. */
+declare class ValidationError extends AppError {
+  readonly errors: readonly ValidationProblemError[];
+  readonly _tag = "ValidationError";
+  readonly classification = "terminal";
+  constructor(errors: readonly ValidationProblemError[], message?: string);
+  /** Convert a Zod error. Each issue path becomes a JSON Pointer. */
+  static fromZod(error: z.ZodError, message?: string): ValidationError;
+  /** Convert issues from any validator, such as issues TanStack serialized into an error message. */
+  static fromIssues(issues: readonly ValidationIssue[], message?: string): ValidationError;
+}
+/** The server cannot parse the request syntax. */
+declare class MalformedRequestError extends AppError {
+  readonly _tag = "MalformedRequestError";
+  readonly classification = "terminal";
+  constructor(args: {
+    cause: unknown;
+  });
+}
+/** No resource matches the requested HTTP path. */
+declare class ResourceNotFoundError extends AppError {
+  readonly _tag = "ResourceNotFoundError";
+  readonly classification = "terminal";
+  constructor();
+}
+/** A WebSocket route received a request without an upgrade. */
+declare class UpgradeRequiredError extends AppError {
+  readonly _tag = "UpgradeRequiredError";
+  readonly classification = "terminal";
+  constructor();
+}
+/** The requested operation did not answer before its deadline. */
+declare class RequestTimeoutError extends AppError {
+  readonly _tag = "RequestTimeoutError";
+  readonly classification = "transient";
+  constructor();
+}
+//#endregion
+//#region src/core/error-table.d.ts
+type PublicFields = z.ZodObject;
+/**
+ * One public error: its class, its HTTP status, and the extra properties a client may read.
+ * `fields` strips the thrown error on the server and parses the payload in the browser.
+ */
+type ErrorEntry<Tag extends string, Fields extends PublicFields = PublicFields> = {
+  readonly error: abstract new (...args: never[]) => AppError & {
+    readonly _tag: Tag;
+  };
+  readonly status: number;
+  readonly fields?: Fields;
+};
+/** Entries keyed by tag. The compiler rejects a key that differs from the class's `_tag`. */
+type ErrorEntries<Entries> = { readonly [Tag in keyof Entries & string]: ErrorEntry<Tag>; };
+type EntryPayload<Tag extends string, Entry> = Entry extends {
+  readonly fields: infer Fields extends z.ZodType;
+} ? {
+  readonly _tag: Tag;
+  readonly message: string;
+} & z.output<Fields> : {
+  readonly _tag: Tag;
+  readonly message: string;
+};
+type PayloadOfEntries<Entries> = { [Tag in keyof Entries & string]: EntryPayload<Tag, Entries[Tag]>; }[keyof Entries & string];
+/** The HTTP status and public payload for one resolved failure. */
+type ResolvedError<Payload> = {
+  readonly status: number;
+  readonly payload: Payload;
+};
+/**
+ * One application's public errors, shared by every transport boundary and the browser.
+ * `resolve` and `fallback` serve boundaries. `parse` and `generic` serve screens.
+ */
+type ErrorTable<Entries> = {
+  readonly entries: Entries;
+  /** The discriminated union of every entry's `_tag`, `message`, and fields. */
+  readonly payloadSchema: z.ZodType<PayloadOfEntries<Entries>>;
+  /** The `InternalServerError` payload, for screens that must show something. */
+  readonly generic: PayloadOfEntries<Entries>;
+  /** Read a rejection value. Null means no known tag, so the request never reached the Worker. */
+  parse(cause: unknown): PayloadOfEntries<Entries> | null;
+  /** Narrow a rejection value to one tag's payload, for a caller that acts on that one error. */
+  is<Tag extends keyof Entries & string>(cause: unknown, tag: Tag): cause is Extract<PayloadOfEntries<Entries>, {
+    readonly _tag: Tag;
+  }>;
+  /** Match a local instance or a remote error by tag. Null means the failure is not public. */
+  resolve(cause: unknown): ResolvedError<PayloadOfEntries<Entries>> | null;
+  /** The replacement for an unmapped failure: 503 when it declared itself transient, else 500. */
+  fallback(cause: unknown): ResolvedError<PayloadOfEntries<Entries>>;
+};
+/** The union of payloads a table can produce. */
+type ErrorPayloadOf<Table> = Table extends ErrorTable<infer Entries> ? PayloadOfEntries<Entries> : never;
+/** The union of tags a table contains. */
+type ErrorTagOf<Table> = Table extends ErrorTable<infer Entries> ? keyof Entries & string : never;
+/** The errors every application can throw, with their statuses. `defineErrors` includes them. */
+declare const sharedErrors: {
+  readonly MalformedRequestError: {
+    readonly error: typeof MalformedRequestError;
+    readonly status: 400;
+  };
+  readonly AuthenticationError: {
+    readonly error: typeof AuthenticationError;
+    readonly status: 401;
+  };
+  readonly StaleSessionError: {
+    readonly error: typeof StaleSessionError;
+    readonly status: 401;
+  };
+  readonly NotAuthorizedError: {
+    readonly error: typeof NotAuthorizedError;
+    readonly status: 403;
+  };
+  readonly ResourceNotFoundError: {
+    readonly error: typeof ResourceNotFoundError;
+    readonly status: 404;
+  };
+  readonly ValidationError: {
+    readonly error: typeof ValidationError;
+    readonly status: 422;
+    readonly fields: z.ZodObject<{
+      errors: z.ZodArray<z.ZodObject<{
+        detail: z.ZodString;
+        pointer: z.ZodString;
+      }, z.core.$strip>>;
+    }, z.core.$strip>;
+  };
+  readonly UpgradeRequiredError: {
+    readonly error: typeof UpgradeRequiredError;
+    readonly status: 426;
+  };
+  readonly RateLimitError: {
+    readonly error: typeof RateLimitError;
+    readonly status: 429;
+    readonly fields: z.ZodObject<{
+      retryAfter: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>;
+  };
+  readonly InternalServerError: {
+    readonly error: typeof InternalServerError;
+    readonly status: 500;
+  };
+  readonly ServiceUnavailableError: {
+    readonly error: typeof ServiceUnavailableError;
+    readonly status: 503;
+  };
+  readonly RequestTimeoutError: {
+    readonly error: typeof RequestTimeoutError;
+    readonly status: 504;
+  };
+};
+type MergedEntries<Entries> = Omit<typeof sharedErrors, keyof Entries> & Entries;
+/**
+ * Build the application's error table. The shared entries are always included;
+ * an entry with the same key replaces the shared one.
+ */
+declare function defineErrors<const Entries extends ErrorEntries<Entries>>(entries: Entries): ErrorTable<MergedEntries<Entries>>;
+//#endregion
+//#region src/core/database.error.d.ts
+/** SQLite reports these constraint categories through D1. */
+type D1ConstraintKind = 'unique' | 'not_null' | 'foreign_key' | 'check';
+/** Database evidence for callers that interpret a specific code or constraint. */
+type DatabaseFailure = {
+  readonly database: 'd1';
+  readonly code: string | undefined;
+  readonly kind: D1ConstraintKind | undefined;
+  readonly table: string | undefined;
+  readonly column: string | undefined;
+  readonly constraintName: string | undefined;
+} | {
+  readonly database: 'postgres';
+  readonly code: string | undefined;
+  readonly table_name: string | undefined;
+  readonly column_name: string | undefined;
+  readonly constraint_name: string | undefined;
+};
+/** Classification describes the failure; callers must separately establish whether repetition is safe. */
+declare class DatabaseError extends AppError {
+  readonly operation: string;
+  readonly classification: FailureClassification;
+  readonly details: DatabaseFailure;
+  readonly _tag = "DatabaseError";
+  constructor(operation: string, classification: FailureClassification, details: DatabaseFailure, options: {
+    readonly cause: unknown;
+  });
+}
+//#endregion
+//#region src/core/defects.d.ts
+/**
+ * Mark a line the types say cannot run. A union member without a branch stops compilation here.
+ *
+ * @throws Panic when a value outside the union arrives at runtime.
+ */
+declare function unreachable(value: never): never;
+/**
+ * Mark a body that is not written yet. A defect, not an expected failure.
+ *
+ * @param what - The behavior the body will provide, such as `invoice export`.
+ * @throws Panic always.
+ */
+declare function notImplemented(what: string): never;
+//#endregion
+//#region src/core/identity.d.ts
+/** A string only `create()` or `schema.parse()` of the same kind can produce. */
+type Id<Brand extends string> = string & z.core.$brand<Brand>;
+/** One id kind the application mints. `schema` parses untrusted input; `create` mints a uuid v7. */
+type IdDefinition<Brand extends string> = {
+  readonly schema: z.core.$ZodBranded<z.ZodUUID, Brand>;
+  /** Mint a new time-ordered id. No parse: we produced it, so it is valid by construction. */
+  create(): Id<Brand>;
+};
+/** The id type of a definition: `type CallId = IdOf<typeof CallId>`. */
+type IdOf<Definition extends IdDefinition<string>> = z.output<Definition['schema']>;
+/**
+ * Define an id kind the application mints: `export const CallId = defineId('CallId')`.
+ * An id another system mints, such as a provider's call id, stays a plain branded schema.
+ */
+declare function defineId<const Brand extends string>(brand: Brand): IdDefinition<Brand>;
+//#endregion
+//#region src/core/messages.d.ts
+/**
+ * The identity of a command or event. Receipts and the outbox are keyed by it.
+ *
+ * Internal messages use UUID v7, so receipts sort by creation. External messages use the
+ * provider's own key, `stripe:event:evt_123`, so a redelivered webhook is a duplicate by
+ * construction. The app parses and generates ids; this package only carries them.
+ */
+type MessageId = string;
+/** An action to perform. One handler, returns a value. The product adds its payload. */
+type DomainCommand<Name extends string = string> = {
+  readonly type: 'command';
+  readonly name: Name;
+  readonly id: MessageId;
+};
+/** A request for data. One handler, returns a value. No id: nothing claims a read. */
+type DomainQuery<Name extends string = string> = {
+  readonly type: 'query';
+  readonly name: Name;
+};
+/** A fact that happened. Zero or more subscribers, returns nothing. The product adds its payload. */
+type DomainEvent<Name extends string = string> = {
+  readonly type: 'event';
+  readonly name: Name;
+  readonly id: MessageId;
+};
+/** The routing fields the bus reads. `type` selects the table, `name` selects the slot. */
+type DomainMessage = DomainCommand | DomainEvent | DomainQuery;
+//#endregion
+//#region src/core/define-messages.d.ts
+/** Payload schemas keyed by message name. A payload never carries `type`, `name`, or `id`. */
+type PayloadSchemas = Readonly<Record<string, z.ZodType<object>>>;
+/** An application's messages: one list of payload schemas per kind. */
+type MessageDefinition = {
+  readonly commands: PayloadSchemas;
+  readonly events: PayloadSchemas;
+  readonly queries: PayloadSchemas;
+};
+type AnyMessages = {
+  readonly definition: MessageDefinition;
+};
+type Def<Messages extends AnyMessages> = Messages['definition'];
+type Payload<Schemas extends PayloadSchemas, Name extends keyof Schemas> = z.output<Schemas[Name]>;
+/** Every command of an application: `CommandOf<typeof messages>`. */
+type CommandOf<Messages extends AnyMessages> = { [Name in keyof Def<Messages>['commands'] & string]: DomainCommand<Name> & Payload<Def<Messages>['commands'], Name>; }[keyof Def<Messages>['commands'] & string];
+/** Every event of an application: `EventOf<typeof messages>`. */
+type EventOf<Messages extends AnyMessages> = { [Name in keyof Def<Messages>['events'] & string]: DomainEvent<Name> & Payload<Def<Messages>['events'], Name>; }[keyof Def<Messages>['events'] & string];
+/** Every query of an application: `QueryOf<typeof messages>`. */
+type QueryOf<Messages extends AnyMessages> = { [Name in keyof Def<Messages>['queries'] & string]: DomainQuery<Name> & Payload<Def<Messages>['queries'], Name>; }[keyof Def<Messages>['queries'] & string];
+/** Every message of an application: what the registry and the bus are typed with. */
+type MessageOf<Messages extends AnyMessages> = CommandOf<Messages> | EventOf<Messages> | QueryOf<Messages>;
+/**
+ * What `defineMessages` returns. The factories build messages for in-process dispatch without
+ * parsing; the data is already typed. The schemas parse untrusted input at a boundary.
+ */
+type AppMessages<Definition extends MessageDefinition> = {
+  readonly definition: Definition;
+  /** Build a command. `id` defaults to a uuid v7; a webhook passes the provider's key, `stripe:event:evt_123`. */
+  createCommand<Name extends keyof Definition['commands'] & string>(name: Name, payload: Payload<Definition['commands'], Name>, id?: MessageId): DomainCommand<Name> & Payload<Definition['commands'], Name>;
+  /** Build an event. `id` defaults to a uuid v7, which also orders it in time. */
+  createEvent<Name extends keyof Definition['events'] & string>(name: Name, payload: Payload<Definition['events'], Name>, id?: MessageId): DomainEvent<Name> & Payload<Definition['events'], Name>;
+  /** Build a query. No id: nothing claims a read. */
+  createQuery<Name extends keyof Definition['queries'] & string>(name: Name, payload: Payload<Definition['queries'], Name>): DomainQuery<Name> & Payload<Definition['queries'], Name>;
+  readonly commandSchema: z.ZodType<CommandOf<AppMessages<Definition>>>;
+  readonly eventSchema: z.ZodType<EventOf<AppMessages<Definition>>>;
+  readonly querySchema: z.ZodType<QueryOf<AppMessages<Definition>>>;
+  /** What a queue body may be: a command or an event. Queries never cross a queue. */
+  readonly queueSchema: z.ZodType<CommandOf<AppMessages<Definition>> | EventOf<AppMessages<Definition>>>;
+};
+type RoutingField = 'type' | 'name' | 'id';
+/** A payload that declares a routing field maps to `never`, so `defineMessages` rejects it. */
+type WithoutRoutingFields<Schemas extends PayloadSchemas> = { readonly [Name in keyof Schemas]: keyof z.output<Schemas[Name]> & RoutingField extends never ? Schemas[Name] : never; };
+/** The compile-time rule: no payload of any kind declares `type`, `name`, or `id`. */
+type ValidDefinition<Definition extends MessageDefinition> = {
+  readonly commands: WithoutRoutingFields<Definition['commands']>;
+  readonly events: WithoutRoutingFields<Definition['events']>;
+  readonly queries: WithoutRoutingFields<Definition['queries']>;
+};
+/**
+ * Define an application's messages once. The key is the name; the factories add the routing
+ * fields `type`, `name`, and `id`. A payload that declares one of them is a compile error.
+ */
+declare function defineMessages<const Definition extends MessageDefinition>(definition: Definition & ValidDefinition<Definition>): AppMessages<Definition>;
+//#endregion
+//#region src/core/entity.d.ts
+/** What an aggregate's plain data must have: an identity. A branded id keeps its brand. */
+type EntityData = {
+  readonly id: string;
+};
+/**
+ * The base of an aggregate: its identity, the events it raised, and the plain data a repository
+ * stores. The subclass keeps its constructor private and declares `static restore(data: Data)`,
+ * the one door a repository rebuilds it through. A repository drains the events after `save`.
+ */
+declare abstract class Entity<Data extends EntityData, TEvent extends DomainEvent = DomainEvent> {
+  private events;
+  abstract readonly id: Data['id'];
+  /** Record one event with the state change that caused it. The unit of work commits both. */
+  protected addEvent(event: TEvent): void;
+  /** A copy of the events raised since the last `clearEvents`. */
+  collectEvents(): ReadonlyArray<TEvent>;
+  /** Forget the raised events once the boundary has taken them. */
+  clearEvents(): void;
+  /** Plain data for the repository. The subclass's `restore(data)` accepts exactly this. */
+  abstract toPlainObject(): Data;
+}
+//#endregion
+//#region src/core/transport-classification.d.ts
+/** Cancellation is a decision, not a failure to repeat. */
+declare function isAbortError(cause: unknown): boolean;
+/** Match known transient transport messages while excluding explicit cancellation. */
+declare function isTransientTransportError(cause: unknown): boolean;
+//#endregion
+//#region src/core/logger.d.ts
+/**
+ * Module-scoped logging for every host.
+ *
+ * A logger emits one plain-data entry per log. The default sink hands it to `console` as an
+ * entry object for a log service or as a colored line for a person, selected at startup.
+ */
+/** A value a log entry may carry. Errors enter only through `Logger.error`. */
+type LogValue = string | number | boolean | null | undefined | ReadonlyArray<LogValue> | LogFields;
+/** Named log values. */
+type LogFields = {
+  readonly [key: string]: LogValue;
+};
+/**
+ * The supported log severity levels, in ascending order.
+ *
+ * A const object, not an enum, so a parsed environment value typed `'INFO'` is a `LogLevel`.
+ */
+declare const LogLevel: {
+  readonly DEBUG: 'DEBUG';
+  readonly INFO: 'INFO';
+  readonly WARN: 'WARN';
+  readonly ERROR: 'ERROR';
+};
+type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
+/** An error as plain data, including diagnostics, causes, and aggregate members. */
+type SerializedError = {
+  readonly name: string;
+  readonly message: string;
+  readonly stack?: string;
+  readonly fields?: LogFields;
+  readonly cause?: SerializedError;
+  readonly errors?: ReadonlyArray<SerializedError>;
+};
+/** One log, as the sink receives it. Plain data, safe to stringify. */
+type LogEntry = {
+  readonly timestamp: string;
+  readonly level: LogLevel;
+  readonly module: string;
+  readonly message: string;
+  readonly details: LogFields;
+  readonly userId?: string;
+  /** Present on `Logger.error` entries that carried an error. */
+  readonly error?: SerializedError;
+};
+/** The context an error log carries. */
+type ErrorLogContext = {
+  readonly error?: unknown;
+  readonly userId?: string;
+  readonly details?: LogFields;
+};
+/** What a logger lets through: a level and everything above it, or nothing. */
+type LogThreshold = LogLevel | 'OFF';
+/** Overrides the application settings for one logger. */
+interface LoggerConfig {
+  readonly level?: LogThreshold;
+}
+/** `json` writes the entry object. `pretty` writes one readable line for a person. */
+type LogFormat = 'json' | 'pretty';
+/**
+ * The application settings, set once at the composition root.
+ *
+ * An omitted field keeps its default. An explicit `undefined` is a compile error, so the root
+ * parses an environment value before passing it. The logger reads no environment itself.
+ */
+interface LoggerSettings extends LoggerConfig {
+  readonly format?: LogFormat;
+}
+/**
+ * Set application settings, including for existing loggers. Per-logger overrides take priority.
+ * Call at startup, never per request. An omitted field resets to INFO and JSON output.
+ */
+declare function configureLogger(config: LoggerSettings): void;
+/** The error data sent to the configured error hook. */
+interface ErrorCaptureEntry {
+  readonly error: unknown;
+  readonly distinctId: string | undefined;
+  readonly context: LogFields;
+}
+/** A function that forwards one logged error to an error service. */
+type LoggerErrorHook = (entry: ErrorCaptureEntry) => void;
+/** Where every log entry goes. */
+type LogSink = (entry: LogEntry) => void;
+/**
+ * Register the function that receives each logged error.
+ *
+ * Set once at the process entry point. A later call replaces the earlier hook.
+ */
+declare function setLoggerErrorHook(fn: LoggerErrorHook): void;
+/**
+ * JSON format writes the entry object. Pretty format writes one line, then the details,
+ * the error, and the stack as separate console arguments.
+ */
+declare const consoleSink: LogSink;
+/**
+ * Send every log entry somewhere other than `console`.
+ *
+ * Set once at the process entry point, never per module. A logger is created
+ * by name and nothing else, so its destination is a fact about the process.
+ */
+declare function setLogSink(fn: LogSink): void;
+/** Write module-scoped logs with application defaults and optional overrides. */
+declare class Logger {
+  private readonly module;
+  private readonly config;
+  /** Create a logger for one module. */
+  constructor(module: string, overrideConfig?: LoggerConfig);
+  private log;
+  /** Write a debug log. */
+  debug(message: string, details?: LogFields): void;
+  /** Write an information log. */
+  info(message: string, details?: LogFields): void;
+  /** Write a warning log. */
+  warn(message: string, details?: LogFields): void;
+  /**
+   * Write an error log and send the error to the configured hook.
+   *
+   * The details say which call this was, and the error says what went wrong
+   * inside it. Both the entry and the error hook receive the supplied user ID.
+   */
+  error(message: string, context?: ErrorLogContext): void;
+}
+/** Create a logger for one module. */
+declare function createLogger(module: string, config?: LoggerConfig): Logger;
+//#endregion
+export { sharedErrors as $, QueryOf as A, defineId as B, EntityData as C, MessageDefinition as D, EventOf as E, DomainQuery as F, DatabaseFailure as G, unreachable as H, MessageId as I, ErrorPayloadOf as J, ErrorEntries as K, Id as L, DomainCommand as M, DomainEvent as N, MessageOf as O, DomainMessage as P, defineErrors as Q, IdDefinition as R, Entity as S, CommandOf as T, D1ConstraintKind as U, notImplemented as V, DatabaseError as W, ErrorTagOf as X, ErrorTable as Y, ResolvedError as Z, createLogger as _, AuthenticationError as _t, LogFormat as a, ValidationIssue as at, isAbortError as b, RetryOwner as bt, LogThreshold as c, ValidationProblemDetails as ct, LoggerConfig as d, ValidationProblemErrorSchema as dt, MalformedRequestError as et, LoggerErrorHook as f, InternalServerError as ft, consoleSink as g, RateLimitError as gt, configureLogger as h, StaleSessionError as ht, LogFields as i, ValidationError as it, defineMessages as j, PayloadSchemas as k, LogValue as l, ValidationProblemDetailsSchema as lt, SerializedError as m, NotAuthorizedError as mt, ErrorLogContext as n, ResourceNotFoundError as nt, LogLevel as o, ProblemDetails as ot, LoggerSettings as p, ServiceUnavailableError as pt, ErrorEntry as q, LogEntry as r, UpgradeRequiredError as rt, LogSink as s, ProblemDetailsSchema as st, ErrorCaptureEntry as t, RequestTimeoutError as tt, Logger as u, ValidationProblemError as ut, setLogSink as v, AppError as vt, AppMessages as w, isTransientTransportError as x, shouldRetryFailure as xt, setLoggerErrorHook as y, FailureClassification as yt, IdOf as z };
+//# sourceMappingURL=index-BStnggQO.d.ts.map

package/dist/index-BStnggQO.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-BStnggQO.d.ts","names":[],"sources":["../src/core/failure-classification.ts","../src/core/app-error.ts","../src/core/authentication.error.ts","../src/core/rate-limit.error.ts","../src/core/stale-session.error.ts","../src/core/not-authorized.error.ts","../src/core/internal.errors.ts","../src/core/problem-details.ts","../src/core/request.errors.ts","../src/core/error-table.ts","../src/core/database.error.ts","../src/core/defects.ts","../src/core/identity.ts","../src/core/messages.ts","../src/core/define-messages.ts","../src/core/entity.ts","../src/core/transport-classification.ts","../src/core/logger.ts"],"mappings":";;;;;;;;KAMY;;;;;;;KAQA;;iBAGI,mBAAmB;WACxB,gBAAgB;WAChB;WACA,OAAO;;;;;;;;;;;;uBCVI,iBAAiB;oBACnB;oBACA,gBAAgB;MAErB;;;;;cCXF,4BAA4B;WAC9B;WACA;EAET;;;;;cCJW,uBAAuB;WAKb;WAJZ;WACA;WACA;EAET,YAAqB;;;;;cCLV,0BAA0B;WAC5B;WACA;EAET;;;;;cCJW,2BAA2B;WAC7B;WACA;EAET;;;;;cCJW,4BAA4B;WAC9B;WACA;EAET;;;cAMW,gCAAgC;WAClC;WACA;EAET;;;;;;;;;cCVW,sBAAoB,EAAA;;;;;GAqB/B,EAAA,KAAA;;KAGU,iBAAiB,EAAE,aAAa;;cAG/B,8BAA4B,EAAA;;;GAWvC,EAAA,KAAA;;KAGU,yBAAyB,EAAE,aAAa;;cAGvC,gCAA8B,EAAA;;;;;;;;;GAEzC,EAAA,KAAA;;KAGU,2BAA2B,EAAE,aAAa;;;;KClD1C;WACD;WACA,eAAe;;;cAIb,wBAAwB;WAKxB,iBAAiB;WAJnB;WACA;EAET,YACW,iBAAiB,0BAC1B;;SAMK,QAAQ,OAAO,EAAE,UAAU,mBAAmB;;SAK9C,WAAW,iBAAiB,mBAAmB,mBAAmB;;;cAS9D,8BAA8B;WAChC;WACA;EAET,YAAY;IAAQ;;;;cAMT,8BAA8B;WAChC;WACA;EAET;;;cAMW,6BAA6B;WAC/B;WACA;EAET;;;cAMW,4BAA4B;WAC9B;WACA;EAET;;;;KCtDG,eAAe,EAAE;;;;;KAMV,WAAW,oBAAoB,eAAe,eAAe;WAC9D,wBAAwB,kBAAkB;aAAsB,MAAM;;WACtE;WACA,SAAS;;;KAMR,aAAa,uBACb,aAAa,mBAAmB,WAAW;KAGlD,aAAa,oBAAoB,SAAS;WACpC,cAAc,eAAe,EAAE;;WAE3B,MAAM;WAAc;IAAoB,EAAE,OAAO;WACjD,MAAM;WAAc;;KAE9B,iBAAiB,cACnB,aAAa,mBAAmB,aAAa,KAAK,QAAQ,eACrD;;KAGI,cAAc;WACf;WACA,SAAS;;;;;;KAOR,WAAW;WACZ,SAAS;;WAET,eAAe,EAAE,QAAQ,iBAAiB;;WAE1C,SAAS,iBAAiB;;EAEnC,MAAM,iBAAiB,iBAAiB;;EAExC,GAAG,kBAAkB,kBACnB,gBACA,KAAK,MACJ,SAAS,QAAQ,iBAAiB;aAAqB,MAAM;;;EAEhE,QAAQ,iBAAiB,cAAc,iBAAiB;;EAExD,SAAS,iBAAiB,cAAc,iBAAiB;;;KAI/C,eAAe,SACzB,cAAc,iBAAiB,WAAW,iBAAiB;;KAGjD,WAAW,SACrB,cAAc,iBAAiB,iBAAiB;;cAUrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAcR,cAAc,WAAW,YAAY,oBAAoB,WAAW;;;;;iBA4BzD,mBAAmB,gBAAgB,aAAa,UAC9D,SAAS,UACR,WAAW,cAAc;;;;KCpIhB;;KAGA;WAEG;WACA;WACA,MAAM;WACN;WACA;WACA;;WAGA;WACA;WACA;WACA;WACA;;;cAIF,sBAAsB;WAItB;WACA,gBAAgB;WAChB,SAAS;WALX;EAET,YACW,mBACA,gBAAgB,uBAChB,SAAS,iBAClB;aAAoB;;;;;;;;;;iBCzBR,YAAY;;;;;;;iBAUZ,eAAe;;;;KCbnB,GAAG,iCAAiC,EAAE,KAAK,OAAO;;KAGlD,aAAa;WACd,QAAQ,EAAE,KAAK,YAAY,EAAE,SAAS;;EAE/C,UAAU,GAAG;;;KAIH,KAAK,mBAAmB,wBAAwB,EAAE,OAAO;;;;;iBAMrD,eAAe,sBAAsB,OAAO,QAAQ,aAAa;;;;;;;;;;KCbrE;;KAGA,cAAc;WACf;WACA,MAAM;WACN,IAAI;;;KAIH,YAAY;WACb;WACA,MAAM;;;KAIL,YAAY;WACb;WACA,MAAM;WACN,IAAI;;;KAIH,gBAAgB,gBAAgB,cAAc;;;;KCxB9C,iBAAiB,SAAS,eAAe,EAAE;;KAG3C;WACD,UAAU;WACV,QAAQ;WACR,SAAS;;KAGf;WAAyB,YAAY;;KACrC,IAAI,iBAAiB,eAAe;KACpC,QAAQ,gBAAgB,gBAAgB,mBAAmB,WAAW,EAAE,OAAO,QAAQ;;KAGhF,UAAU,iBAAiB,kBACpC,cAAc,IAAI,iCAAiC,cAAc,QAChE,QAAQ,IAAI,uBAAuB,eAC/B,IAAI;;KAGA,QAAQ,iBAAiB,kBAClC,cAAc,IAAI,+BAA+B,YAAY,QAC5D,QAAQ,IAAI,qBAAqB,eAC7B,IAAI;;KAGA,QAAQ,iBAAiB,kBAClC,cAAc,IAAI,gCAAgC,YAAY,QAC7D,QAAQ,IAAI,sBAAsB,eAC9B,IAAI;;KAGA,UAAU,iBAAiB,eACnC,UAAU,YACV,QAAQ,YACR,QAAQ;;;;;KAMA,YAAY,mBAAmB;WAChC,YAAY;;EAErB,cAAc,mBAAmB,iCAC/B,MAAM,MACN,SAAS,QAAQ,wBAAwB,OACzC,KAAK,YACJ,cAAc,QAAQ,QAAQ,wBAAwB;;EAEzD,YAAY,mBAAmB,+BAC7B,MAAM,MACN,SAAS,QAAQ,sBAAsB,OACvC,KAAK,YACJ,YAAY,QAAQ,QAAQ,sBAAsB;;EAErD,YAAY,mBAAmB,gCAC7B,MAAM,MACN,SAAS,QAAQ,uBAAuB,QACvC,YAAY,QAAQ,QAAQ,uBAAuB;WAC7C,eAAe,EAAE,QAAQ,UAAU,YAAY;WAC/C,aAAa,EAAE,QAAQ,QAAQ,YAAY;WAC3C,aAAa,EAAE,QAAQ,QAAQ,YAAY;;WAE3C,aAAa,EAAE,QACtB,UAAU,YAAY,eAAe,QAAQ,YAAY;;KAIxD;;KAGA,qBAAqB,gBAAgB,8BAC9B,cAAc,gBAAgB,EAAE,OAAO,QAAQ,SAAS,6BAC9D,QAAQ;;KAKT,gBAAgB,mBAAmB;WAC7B,UAAU,qBAAqB;WAC/B,QAAQ,qBAAqB;WAC7B,SAAS,qBAAqB;;;;;;iBA6BzB,qBAAqB,mBAAmB,mBACtD,YAAY,aAAa,gBAAgB,cACxC,YAAY;;;;KCpHH;WAAwB;;;;;;;uBAOd,OAAO,aAAa,YAAY,eAAe,cAAc;UACzE;oBAEU,IAAI;;YAGZ,SAAS,OAAO;;EAK1B,iBAAiB,cAAc;;EAK/B;;WAKS,iBAAiB;;;;;iBCbZ,aAAa;;iBAKb,0BAA0B;;;;;;;;;;KCf9B,0DAMR,cAAc,YACd;;KAGQ;YAAwB,cAAc;;;;;;;cAOrC;WACX;WACA;WACA;WACA;;KAEU,mBAAmB,uBAAuB;;KAG1C;WACD;WACA;WACA;WACA,SAAS;WACT,QAAQ;WACR,SAAS,cAAc;;;KAItB;WACD;WACA,OAAO;WACP;WACA;WACA,SAAS;WACT;;WAEA,QAAQ;;;KAIP;WACD;WACA;WACA,UAAU;;;KAIT,eAAe;;UAGV;WACN,QAAQ;;;KAIP;;;;;;;UAQK,uBAAuB;WAC7B,SAAS;;;;;;iBAgBJ,gBAAgB,QAAQ;;UAQvB;WACN;WACA;WACA,SAAS;;;KAIR,mBAAmB,OAAO;;KAG1B,WAAW,OAAO;;;;;;iBASd,mBAAmB,IAAI;;;;;cA0C1B,aAAa;;;;;;;iBA6BV,WAAW,IAAI;;cAyDlB;mBAKQ;mBAJF;;EAGjB,YACmB,gBACjB,iBAAiB;UAKX;;EAuBR,MAAM,iBAAiB,UAAS;;EAKhC,KAAK,iBAAiB,UAAS;;EAK/B,KAAK,iBAAiB,UAAS;;;;;;;EAU/B,MAAM,iBAAiB,UAAS;;;iBAyBlB,aAAa,gBAAgB,SAAS,eAAe"}