@arki/journal 0.0.0-stage → 0.1.0

package/dist/dot.d.ts

@@ -0,0 +1,102 @@
+/**
+ * `@arki/dot` adapter.
+ *
+ * - `journal(...)` is the plugin. It publishes the journal as `services.journal`
+ *   and runs one worker per plugin instance between `start` and `stop`.
+ * - `journalHandlers(...)` is the feature slice. A feature lists its projections
+ *   and effects with it, and `journal({ j, tables, features })` collects them.
+ *
+ * The app's `db` plugin must publish the root Drizzle database under the `db` key.
+ *
+ * `@arki/dot` is an optional peer. Import this module only inside a Dot app.
+ * Feature slices are read by shape: this file never imports `@arki/feature`.
+ */
+import type { z } from 'zod';
+import type { Plugin, Token } from '@arki/dot/plugin';
+import type { Journal, JournalDefinitions } from './api.js';
+import type { JournalTables } from './pg.js';
+import type { DbHandle, Effect, Needs, Projection, RootDb, ServicesFor, Tap, TransactionSource, WakeListener } from './types.js';
+export declare const JOURNAL_ACTION_META_SCHEMA = "@arki/journal/action-meta@1";
+export declare const JOURNAL_PLUGIN_ERROR_CODES: {
+    readonly badSlice: 'JOURNAL_PLUGIN_E001';
+};
+/** One effect in the app manifest: async work that the journal's job table feeds in. */
+export type JournalDotAction = {
+    readonly id: string;
+    readonly binding: 'journal';
+    readonly direction: 'in';
+    readonly address: string;
+    readonly metaSchema: typeof JOURNAL_ACTION_META_SCHEMA;
+    readonly meta: {
+        readonly entities: string[];
+        readonly events: string[];
+    };
+};
+/** What one feature hands to the journal. Its effects already hold the feature's services. */
+export type JournalHandlers<Meta = unknown, Tx = DbHandle, AppDb = RootDb> = {
+    readonly projections: readonly Projection<Meta, Tx>[];
+    readonly effects: readonly Effect<Meta, AppDb>[];
+    readonly taps: readonly Tap<Meta, AppDb>[];
+};
+/**
+ * The `@arki/feature` slice contract a `journalHandlers(...)` declaration produces.
+ * `TServices` is what the feature's effects need: the feature must declare it in `needs`.
+ */
+export type JournalFeatureSlice<Meta = unknown, Tx = DbHandle, AppDb = RootDb, TServices = unknown> = {
+    readonly key: 'journal';
+    readonly actions: readonly JournalDotAction[];
+    readonly resolve: (services: TServices) => JournalHandlers<Meta, Tx, AppDb>;
+};
+/**
+ * Declare a feature's projections and effects as a boot-time slice
+ * (`defineFeature(..., { use: [journalHandlers({ projections, effects })] })`).
+ * The payload lands under `journal` in the feature's slice token, where
+ * `journal({ j, tables, features })` collects it.
+ *
+ * An effect with needs (`j.effect(name, entity, { mailer: need<Mailer>() }, on)`) gets
+ * them from the booted services of this feature, by name. The feature must declare
+ * each one in its own `needs`: the slice's `resolve` does not type-check otherwise.
+ * Two features may use the same need name for two different services.
+ *
+ * Actions: one per effect. Projections add none: they run inside the write, not
+ * at an app boundary.
+ */
+export declare function journalHandlers<Meta = unknown, Tx = DbHandle, AppDb = RootDb, const E extends readonly Effect<Meta, AppDb, unknown, Needs>[] = readonly [], const T extends readonly Tap<Meta, AppDb, Needs>[] = readonly []>(handlers: {
+    readonly projections?: readonly Projection<Meta, Tx>[];
+    readonly effects?: E;
+    readonly taps?: T;
+}): JournalFeatureSlice<Meta, Tx, AppDb, ServicesFor<E> & ServicesFor<T>>;
+type WorkerOptions = {
+    /** Run the async lane in this process. Default `true`. */
+    readonly worker?: boolean;
+    readonly pollMs?: number;
+    readonly batchSize?: number;
+    readonly leaseSeconds?: number;
+    /** See `journal.worker`: required when the journal has taps, unless `taps: false`. */
+    readonly listen?: WakeListener;
+    readonly taps?: boolean;
+};
+/** Direct mode: the app composed the journal itself. */
+export type JournalDirectOptions<Meta extends z.ZodObject, Tx extends TransactionSource<Tx>, AppDb extends RootDb> = WorkerOptions & {
+    readonly journal: Journal<Meta, Tx, AppDb>;
+};
+/** Feature mode: the plugin composes the journal from the features' `journalHandlers` slices. */
+export type JournalFeatureOptions<Meta extends z.ZodObject, Tx extends TransactionSource<Tx>, AppDb extends RootDb> = WorkerOptions & {
+    readonly j: Pick<JournalDefinitions<Meta, Tx, AppDb>, 'compose'>;
+    readonly tables: JournalTables;
+    /** `tokens(features)` from `@arki/feature/dot`. A feature without a journal slice adds nothing. */
+    readonly features: readonly Token<object, string>[];
+};
+/**
+ * `RootDb` again on purpose: a Drizzle transaction fits `AppDb` by shape, and must not fit here.
+ * `TransactionSource<Tx>`: the worker's database runs the commands of effects, so it opens `Tx`.
+ */
+export type JournalPlugin<Meta extends z.ZodObject, Tx extends TransactionSource<Tx>, AppDb extends RootDb> = Plugin<{
+    db: AppDb & RootDb & TransactionSource<Tx>;
+}, {
+    journal: Journal<Meta, Tx, AppDb>;
+}>;
+export declare function journal<Meta extends z.ZodObject, Tx extends TransactionSource<Tx>, AppDb extends RootDb>(options: JournalDirectOptions<Meta, Tx, AppDb>): JournalPlugin<Meta, Tx, AppDb>;
+export declare function journal<Meta extends z.ZodObject, Tx extends TransactionSource<Tx>, AppDb extends RootDb>(options: JournalFeatureOptions<Meta, Tx, AppDb>): JournalPlugin<Meta, Tx, AppDb>;
+export {};
+//# sourceMappingURL=dot.d.ts.map

package/dist/dot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dot.d.ts","sourceRoot":"","sources":["../src/dot.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,KAAK,EAAE,MAAM,EAAW,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAG/D,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,EACV,QAAQ,EACR,MAAM,EAEN,KAAK,EACL,UAAU,EACV,MAAM,EAEN,WAAW,EACX,GAAG,EACH,iBAAiB,EACjB,YAAY,EACb,MAAM,YAAY,CAAC;AAKpB,eAAO,MAAM,0BAA0B,gCAAgC,CAAC;AAExE,eAAO,MAAM,0BAA0B;aAAK,QAAQ,EAAE,qBAAqB;CAAW,CAAC;AAEvF,wFAAwF;AACxF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,OAAO,0BAA0B,CAAC;IACvD,QAAQ,CAAC,IAAI,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAC3E,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,eAAe,CAAC,IAAI,GAAG,OAAO,EAAE,EAAE,GAAG,QAAQ,EAAE,KAAK,GAAG,MAAM,IAAI;IAC3E,QAAQ,CAAC,WAAW,EAAE,SAAS,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;IACjD,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,GAAG,OAAO,EAAE,EAAE,GAAG,QAAQ,EAAE,KAAK,GAAG,MAAM,EAAE,SAAS,GAAG,OAAO,IAAI;IACpG,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAC9C,QAAQ,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,eAAe,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;CAC7E,CAAC;AAiBF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,IAAI,GAAG,OAAO,EACd,EAAE,GAAG,QAAQ,EACb,KAAK,GAAG,MAAM,EACd,KAAK,CAAC,CAAC,SAAS,SAAS,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,GAAG,SAAS,EAAE,EAC5E,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,GAAG,SAAS,EAAE,EAChE,QAAQ,EAAE;IACV,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;CACnB,GAAG,mBAAmB,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAYxE;AAID,KAAK,aAAa,GAAG;IACnB,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,sFAAsF;IACtF,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,oBAAoB,CAC9B,IAAI,SAAS,CAAC,CAAC,SAAS,EACxB,EAAE,SAAS,iBAAiB,CAAC,EAAE,CAAC,EAChC,KAAK,SAAS,MAAM,IAClB,aAAa,GAAG;IAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;CAAE,CAAC;AAEnE,iGAAiG;AACjG,MAAM,MAAM,qBAAqB,CAC/B,IAAI,SAAS,CAAC,CAAC,SAAS,EACxB,EAAE,SAAS,iBAAiB,CAAC,EAAE,CAAC,EAChC,KAAK,SAAS,MAAM,IAClB,aAAa,GAAG;IAClB,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;IACjE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,mGAAmG;IACnG,QAAQ,CAAC,QAAQ,EAAE,SAAS,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CACrD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,EAAE,CAAC,EAAE,KAAK,SAAS,MAAM,IAAI,MAAM,CAClH;IAAE,EAAE,EAAE,KAAK,GAAG,MAAM,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAA;CAAE,EAC9C;IAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;CAAE,CACtC,CAAC;AAuFF,wBAAgB,OAAO,CAAC,IAAI,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,EAAE,CAAC,EAAE,KAAK,SAAS,MAAM,EACtG,OAAO,EAAE,oBAAoB,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,GAC7C,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;AAClC,wBAAgB,OAAO,CAAC,IAAI,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,EAAE,CAAC,EAAE,KAAK,SAAS,MAAM,EACtG,OAAO,EAAE,qBAAqB,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,GAC9C,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC"}

package/dist/dot.js

@@ -0,0 +1,159 @@
+import { DotPluginError, plugin, service } from '@arki/dot/plugin';
+import { debugWorker } from './debug.js';
+import { JournalError } from './errors.js';
+import { bindEffect, bindTap } from './handlers.js';
+export const JOURNAL_ACTION_META_SCHEMA = '@arki/journal/action-meta@1';
+export const JOURNAL_PLUGIN_ERROR_CODES = { badSlice: 'JOURNAL_PLUGIN_E001' };
+function effectAction(effect) {
+    return {
+        id: `${effect.name}.run`,
+        binding: 'journal',
+        direction: 'in',
+        address: effect.name,
+        metaSchema: JOURNAL_ACTION_META_SCHEMA,
+        meta: { entities: effect.entities.map(entity => entity.kind), events: [...effect.types] },
+    };
+}
+/**
+ * Declare a feature's projections and effects as a boot-time slice
+ * (`defineFeature(..., { use: [journalHandlers({ projections, effects })] })`).
+ * The payload lands under `journal` in the feature's slice token, where
+ * `journal({ j, tables, features })` collects it.
+ *
+ * An effect with needs (`j.effect(name, entity, { mailer: need<Mailer>() }, on)`) gets
+ * them from the booted services of this feature, by name. The feature must declare
+ * each one in its own `needs`: the slice's `resolve` does not type-check otherwise.
+ * Two features may use the same need name for two different services.
+ *
+ * Actions: one per effect. Projections add none: they run inside the write, not
+ * at an app boundary.
+ */
+export function journalHandlers(handlers) {
+    const { projections = [], effects = [], taps = [] } = handlers;
+    return {
+        key: 'journal',
+        actions: effects.map(effect => effectAction(effect)),
+        // The kernel hands the feature's services over untyped, so they are read by name here.
+        resolve: (services) => ({
+            projections,
+            effects: effects.map(effect => bindEffect(effect, isServices(services) ? services : {})),
+            taps: taps.map(tap => bindTap(tap, isServices(services) ? services : {})),
+        }),
+    };
+}
+const isServices = (value) => typeof value === 'object' && value !== null;
+const isHandler = (value) => typeof value === 'object' &&
+    value !== null &&
+    'name' in value &&
+    typeof value.name === 'string' &&
+    'run' in value &&
+    typeof value.run === 'function';
+/** The kernel hands services over untyped, so the slice shape is checked here, once, at boot. */
+function isJournalHandlers(value) {
+    return (typeof value === 'object' &&
+        value !== null &&
+        'projections' in value &&
+        Array.isArray(value.projections) &&
+        value.projections.every(item => isHandler(item)) &&
+        'effects' in value &&
+        Array.isArray(value.effects) &&
+        value.effects.every(item => isHandler(item)) &&
+        'taps' in value &&
+        Array.isArray(value.taps) &&
+        value.taps.every(item => isHandler(item)));
+}
+/**
+ * Throws when another handler of this kind already has the name, and names the
+ * feature tokens that hold the two. `j.compose` makes the same check, but it gets
+ * one flat list and cannot say which feature a handler came from.
+ */
+function claimName(kind, owners, name, feature) {
+    const owner = owners.get(name);
+    if (owner !== undefined) {
+        const where = owner === feature ? `feature "${feature}", twice` : `features "${owner}" and "${feature}"`;
+        throw new JournalError('BAD_DEFINITION', kind, name, `journal: duplicate ${kind} name "${name}" (${where})`);
+    }
+    owners.set(name, feature);
+}
+/**
+ * Read each feature's `journal` slice from the booted services, in feature order.
+ * Refuses a projection name or an effect name that is listed twice.
+ */
+function collectHandlers(features, services) {
+    const projections = [];
+    const effects = [];
+    const taps = [];
+    const projectionOwners = new Map();
+    const effectOwners = new Map();
+    const tapOwners = new Map();
+    for (const feature of features) {
+        const slices = services[feature.key];
+        const slice = typeof slices === 'object' && slices !== null && 'journal' in slices ? slices.journal : undefined;
+        if (slice === undefined) {
+            debugWorker.debug('[journal] feature "{featureKey}" did not contribute a journal slice', {
+                featureKey: feature.key,
+            });
+            continue;
+        }
+        if (!isJournalHandlers(slice)) {
+            throw new DotPluginError({
+                code: JOURNAL_PLUGIN_ERROR_CODES.badSlice,
+                message: `[journal] feature token "${feature.key}" holds a \`journal\` slice that is not lists of projections, effects and taps.`,
+                remediation: 'Declare the slice with journalHandlers({ projections, effects, taps }) from @arki/journal/dot.',
+                docsUrl: 'https://github.com/arki-labs/arki/blob/HEAD/packages/journal/docs/agent-guide.md#dot-boot-errors',
+            });
+        }
+        for (const { name } of slice.projections)
+            claimName('projection', projectionOwners, name, feature.key);
+        for (const { name } of slice.effects)
+            claimName('effect', effectOwners, name, feature.key);
+        for (const { name } of slice.taps)
+            claimName('tap', tapOwners, name, feature.key);
+        projections.push(...slice.projections);
+        effects.push(...slice.effects);
+        taps.push(...slice.taps);
+    }
+    return { projections, effects, taps };
+}
+export function journal(options) {
+    let composed;
+    let worker;
+    // Each feature token is a need, so the kernel boots the features first and refuses a missing one.
+    const featureNeeds = 'features' in options ? options.features.map(feature => [feature.key, feature]) : [];
+    const needs = {
+        ...Object.fromEntries(featureNeeds),
+        db: service(),
+    };
+    return plugin({
+        name: 'journal',
+        needs,
+        configure(ctx) {
+            ctx.registerService('journal', 'custom');
+            ctx.declareProvides('journal');
+        },
+        boot(services) {
+            composed =
+                'journal' in options
+                    ? options.journal
+                    : options.j.compose({ tables: options.tables, ...collectHandlers(options.features, services) });
+            return { journal: composed };
+        },
+        async start({ db }) {
+            if (options.worker === false)
+                return;
+            worker = composed?.worker(db, {
+                pollMs: options.pollMs,
+                batchSize: options.batchSize,
+                leaseSeconds: options.leaseSeconds,
+                listen: options.listen,
+                taps: options.taps,
+            });
+            await worker?.start();
+        },
+        async stop() {
+            await worker?.stop();
+            worker = undefined;
+        },
+    });
+}
+//# sourceMappingURL=dot.js.map

package/dist/dot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dot.js","sourceRoot":"","sources":["../src/dot.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAiBnE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAEpD,MAAM,CAAC,MAAM,0BAA0B,GAAG,6BAA6B,CAAC;AAExE,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,QAAQ,EAAE,qBAAqB,EAAW,CAAC;AA6BvF,SAAS,YAAY,CAAC,MAIrB;IACC,OAAO;QACL,EAAE,EAAE,GAAG,MAAM,CAAC,IAAI,MAAM;QACxB,OAAO,EAAE,SAAS;QAClB,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,MAAM,CAAC,IAAI;QACpB,UAAU,EAAE,0BAA0B;QACtC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE;KAC1F,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAM7B,QAID;IACC,MAAM,EAAE,WAAW,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC;IAC/D,OAAO;QACL,GAAG,EAAE,SAAS;QACd,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACpD,uFAAuF;QACvF,OAAO,EAAE,CAAC,QAAiB,EAAE,EAAE,CAAC,CAAC;YAC/B,WAAW;YACX,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxF,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;SAC1E,CAAC;KACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,KAAc,EAAqB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AAyCtG,MAAM,SAAS,GAAG,CAAC,KAAc,EAAW,EAAE,CAC5C,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACd,MAAM,IAAI,KAAK;IACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;IAC9B,KAAK,IAAI,KAAK;IACd,OAAO,KAAK,CAAC,GAAG,KAAK,UAAU,CAAC;AAElC,iGAAiG;AACjG,SAAS,iBAAiB,CAAC,KAAc;IACvC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,aAAa,IAAI,KAAK;QACtB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;QAChC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAChD,SAAS,IAAI,KAAK;QAClB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5B,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK;QACf,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAC1C,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAChB,IAAqC,EACrC,MAA2B,EAC3B,IAAY,EACZ,OAAe;IAEf,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,YAAY,OAAO,UAAU,CAAC,CAAC,CAAC,aAAa,KAAK,UAAU,OAAO,GAAG,CAAC;QACzG,MAAM,IAAI,YAAY,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,EAAE,sBAAsB,IAAI,UAAU,IAAI,MAAM,KAAK,GAAG,CAAC,CAAC;IAC/G,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CACtB,QAA0C,EAC1C,QAA2C;IAE3C,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAU,EAAE,CAAC;IACvB,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;IACnD,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC/C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QAChH,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,WAAW,CAAC,KAAK,CAAC,qEAAqE,EAAE;gBACvF,UAAU,EAAE,OAAO,CAAC,GAAG;aACxB,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,cAAc,CAAC;gBACvB,IAAI,EAAE,0BAA0B,CAAC,QAAQ;gBACzC,OAAO,EAAE,4BAA4B,OAAO,CAAC,GAAG,iFAAiF;gBACjI,WAAW,EAAE,gGAAgG;gBAC7G,OAAO,EAAE,kGAAkG;aAC5G,CAAC,CAAC;QACL,CAAC;QACD,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,WAAW;YAAE,SAAS,CAAC,YAAY,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QACvG,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,OAAO;YAAE,SAAS,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3F,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,IAAI;YAAE,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAClF,WAAW,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QACvC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACxC,CAAC;AAQD,MAAM,UAAU,OAAO,CACrB,OAAuF;IAEvF,IAAI,QAA8C,CAAC;IACnD,IAAI,MAAiC,CAAC;IACtC,kGAAkG;IAClG,MAAM,YAAY,GAAG,UAAU,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1G,MAAM,KAAK,GAAqE;QAC9E,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC;QACnC,EAAE,EAAE,OAAO,EAA0C;KACtD,CAAC;IAEF,OAAO,MAAM,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,KAAK;QACL,SAAS,CAAC,GAAG;YACX,GAAG,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACzC,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,QAAQ;YACX,QAAQ;gBACN,SAAS,IAAI,OAAO;oBAClB,CAAC,CAAC,OAAO,CAAC,OAAO;oBACjB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;YACpG,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;QAC/B,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE;YAChB,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK;gBAAE,OAAO;YACrC,MAAM,GAAG,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE;gBAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC,CAAC;YACH,MAAM,MAAM,EAAE,KAAK,EAAE,CAAC;QACxB,CAAC;QACD,KAAK,CAAC,IAAI;YACR,MAAM,MAAM,EAAE,IAAI,EAAE,CAAC;YACrB,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/dist/entity.d.ts

@@ -0,0 +1,56 @@
+import type { AnyEventDef, EntityDef, EntityId, EntityTable, Patch, Recorded, RecordedOf, ReducerRow, ReducerValues, Row } from './types.js';
+/**
+ * The keys that every `.create` reducer so far returns with a type that
+ * excludes `undefined`. `CreateResults` is the union of their return types, so a key
+ * one of them leaves out, or may set to `undefined`, is not in the set. With
+ * no `.create` yet, the set is empty.
+ *
+ * `keyof CreateResults & string` keeps the mapped type from distributing over the
+ * union: `keyof (A | B)` is the keys both have, and `CreateResults[P]` is the union
+ * of what each branch holds there. A create returning `cond ? { note } : {}`
+ * therefore promises nothing.
+ */
+export type GuaranteedCreateKeys<CreateResults> = [CreateResults] extends [never] ? never : {
+    [P in keyof CreateResults & string]: undefined extends CreateResults[P] ? never : P;
+}[keyof CreateResults & string];
+/**
+ * The state an `.on` reducer receives: the reducer-shaped row, with the keys
+ * every `.create` reducer sets made required. A patch cannot unset a key and
+ * `undefined` values are stripped, so a key a create sets stays set.
+ */
+export type OnReducerRow<Tbl extends EntityTable, Key extends string, CreateResults> = ReducerRow<Tbl, Key> & Required<Pick<ReducerValues<Tbl, Key>, GuaranteedCreateKeys<CreateResults> & keyof ReducerValues<Tbl, Key>>>;
+/**
+ * An entity under construction. Each `.create` / `.on` adds the event to the
+ * union the entity accepts, so `events` cannot return an undeclared event.
+ * `CreateResults` collects what the `.create` reducers return; see `OnReducerRow`.
+ *
+ * The rule: every `.create` comes before the first `.on`. After the first
+ * `.on` the builder is `OnOnlyEntityBuilder`, which has no `.create`: a later
+ * create could leave out a column that `.on` was promised.
+ */
+export type EntityBuilder<Kind extends string, Tbl extends EntityTable, EventDefs extends AnyEventDef, Meta, Key extends string = 'id', CreateResults = never> = OnOnlyEntityBuilder<Kind, Tbl, EventDefs, Meta, Key, CreateResults> & {
+    /** A create reducer receives no row. It builds the first row from the event. */
+    create<AddedEvent extends AnyEventDef, CreateResult extends ReducerValues<Tbl, Key>>(event: AddedEvent, reduce: (event: RecordedOf<AddedEvent, Meta, EntityId<Tbl, Key>>) => CreateResult): EntityBuilder<Kind, Tbl, EventDefs | AddedEvent, Meta, Key, CreateResults | CreateResult>;
+};
+/** An entity after its first `.on`: only more `.on` reducers may follow. */
+export type OnOnlyEntityBuilder<Kind extends string, Tbl extends EntityTable, EventDefs extends AnyEventDef, Meta, Key extends string = 'id', CreateResults = never> = EntityDef<Kind, Tbl, EventDefs, Meta, Key> & {
+    /**
+     * An `.on` reducer always receives the reducer-shaped state: the insert shape plus
+     * the key column and `version`. Columns with database defaults may be absent unless
+     * every `.create` reducer sets them. It returns a patch that is merged onto the
+     * state. Returning `null` deletes the row; the events stay.
+     */
+    on<AddedEvent extends AnyEventDef>(event: AddedEvent, reduce: (row: OnReducerRow<Tbl, Key, CreateResults>, event: RecordedOf<AddedEvent, Meta, EntityId<Tbl, Key>>) => Patch<Tbl, Key> | null): OnOnlyEntityBuilder<Kind, Tbl, EventDefs | AddedEvent, Meta, Key, CreateResults>;
+};
+export declare function defineEntity<Kind extends string, Tbl extends EntityTable, Meta, Key extends string>(kind: Kind, table: Tbl, key: Key): EntityBuilder<Kind, Tbl, never, Meta, Key>;
+/** The reducer-shaped row: a state plus the key column and `version`. */
+export declare function withEntityIdentity<Tbl extends EntityTable, Key extends string>(entity: EntityDef<string, Tbl, AnyEventDef, unknown, Key>, state: Row<Tbl> | ReducerValues<Tbl, Key>, id: EntityId<Tbl, Key>, version: number): ReducerRow<Tbl, Key>;
+/**
+ * Fold one event onto the in-memory state. Shared by write and replay, so
+ * both produce the same value for every column a reducer set. The caller has
+ * checked that a reducer exists for the event in this state. `reducerColumns`, when
+ * given, collects the columns the reducers set: a create starts it afresh, a
+ * patch adds its keys, a delete empties it.
+ */
+export declare function reduceOne<Tbl extends EntityTable, Meta, Key extends string>(entity: EntityDef<string, Tbl, AnyEventDef, Meta, Key>, state: Row<Tbl> | ReducerValues<Tbl, Key> | null, id: EntityId<Tbl, Key>, event: Recorded<string, unknown, Meta>, reducerColumns?: Set<string>): ReducerValues<Tbl, Key> | null;
+//# sourceMappingURL=entity.d.ts.map

package/dist/entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,QAAQ,EACR,WAAW,EAGX,KAAK,EACL,QAAQ,EACR,UAAU,EACV,UAAU,EAEV,aAAa,EACb,GAAG,EACJ,MAAM,YAAY,CAAC;AAIpB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,oBAAoB,CAAC,aAAa,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,GAC7E,KAAK,GACL;KAAG,CAAC,IAAI,MAAM,aAAa,GAAG,MAAM,GAAG,SAAS,SAAS,aAAa,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC;CAAE,CAAC,MAAM,aAAa,GACzG,MAAM,CAAC,CAAC;AAEd;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,GAAG,SAAS,WAAW,EAAE,GAAG,SAAS,MAAM,EAAE,aAAa,IAAI,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,GACzG,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,oBAAoB,CAAC,aAAa,CAAC,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;AAE/G;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CACvB,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,WAAW,EACvB,SAAS,SAAS,WAAW,EAC7B,IAAI,EACJ,GAAG,SAAS,MAAM,GAAG,IAAI,EACzB,aAAa,GAAG,KAAK,IACnB,mBAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,GAAG;IACxE,gFAAgF;IAChF,MAAM,CAAC,UAAU,SAAS,WAAW,EAAE,YAAY,SAAS,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EACjF,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,YAAY,GAChF,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,GAAG,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,GAAG,YAAY,CAAC,CAAC;CAC9F,CAAC;AAEF,4EAA4E;AAC5E,MAAM,MAAM,mBAAmB,CAC7B,IAAI,SAAS,MAAM,EACnB,GAAG,SAAS,WAAW,EACvB,SAAS,SAAS,WAAW,EAC7B,IAAI,EACJ,GAAG,SAAS,MAAM,GAAG,IAAI,EACzB,aAAa,GAAG,KAAK,IACnB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG;IAC/C;;;;;OAKG;IACH,EAAE,CAAC,UAAU,SAAS,WAAW,EAC/B,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,CACN,GAAG,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,CAAC,EAC1C,KAAK,EAAE,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KACpD,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,GAC1B,mBAAmB,CAAC,IAAI,EAAE,GAAG,EAAE,SAAS,GAAG,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;CACrF,CAAC;AAkHF,wBAAgB,YAAY,CAAC,IAAI,SAAS,MAAM,EAAE,GAAG,SAAS,WAAW,EAAE,IAAI,EAAE,GAAG,SAAS,MAAM,EACjG,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,GAAG,EACV,GAAG,EAAE,GAAG,GACP,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAgB5C;AA4GD,yEAAyE;AACzE,wBAAgB,kBAAkB,CAAC,GAAG,SAAS,WAAW,EAAE,GAAG,SAAS,MAAM,EAC5E,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,CAAC,EACzD,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EACzC,EAAE,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,EACtB,OAAO,EAAE,MAAM,GACd,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAEtB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,SAAS,WAAW,EAAE,IAAI,EAAE,GAAG,SAAS,MAAM,EACzE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,CAAC,EACtD,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,EAChD,EAAE,EAAE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,EACtB,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EACtC,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAC3B,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAoBhC"}

package/dist/entity.js

@@ -0,0 +1,174 @@
+import { getTableColumns, getTableName } from 'drizzle-orm';
+import { getTableConfig, PgColumn } from 'drizzle-orm/pg-core';
+import { JournalError } from './errors.js';
+import { assertStoredName } from './id.js';
+/** The two facts `KeyColumn` states: the column holds a string and is not null. */
+function isKeyColumn(column) {
+    const [dataType] = column.dataType.split(' ');
+    return dataType === 'string' && column.notNull;
+}
+/**
+ * The supported key types: `text`, `varchar`, `varchar(n)` and `uuid`. The first three compare
+ * as exact strings. A `uuid` ignores case, so its ids must also use the canonical spelling
+ * (lower-case, hyphenated); `assertExactId` checks that on every call.
+ */
+const EXACT_KEY_TYPE = /^(?:text|uuid|varchar(?:\s*\(\s*\d+\s*\))?)$/;
+/** A column's SQL type in comparable form: trimmed and lower-case. */
+function sqlTypeOf(column) {
+    return column.getSQLType().trim().toLowerCase();
+}
+/** The journal's own limit: `journal_events.entity_id` holds 256 characters. */
+const LOG_KEY_LIMIT = 256;
+/**
+ * The longest id the key may hold, in code points: `varchar(n)` allows `min(n, 256)`, `text` and
+ * `varchar` allow the log's 256, and a `uuid` is fixed at 36.
+ */
+function keyLimitOf(column) {
+    const sqlType = sqlTypeOf(column);
+    if (sqlType === 'uuid')
+        return { max: 36, source: 'column' };
+    const length = /\(\s*(\d+)\s*\)/.exec(sqlType)?.[1];
+    if (length !== undefined && Number(length) <= LOG_KEY_LIMIT)
+        return { max: Number(length), source: 'column' };
+    return { max: LOG_KEY_LIMIT, source: 'journal' };
+}
+/**
+ * Whether `column` identifies one row on its own: it is the primary key, or
+ * carries a unique constraint, or is the only column of a table-level primary
+ * key, unique constraint or unique index. Table-level constraints and indexes
+ * hold their own column objects (an index wraps them), so they are matched by
+ * SQL name; an SQL expression in an index has no name and never matches.
+ */
+function isUniqueOn(table, column) {
+    if (column.primary || column.isUnique)
+        return true;
+    const only = (columns) => {
+        const [first] = columns;
+        return (columns.length === 1 &&
+            typeof first === 'object' &&
+            first !== null &&
+            'name' in first &&
+            first.name === column.name);
+    };
+    const config = getTableConfig(table);
+    return (config.primaryKeys.some(pk => only(pk.columns)) ||
+        config.uniqueConstraints.some(constraint => only(constraint.columns)) ||
+        // A unique index with a `where` is unique only inside that subset, so it is no key.
+        config.indexes.some(index => index.config.unique && index.config.where === undefined && only(index.config.columns)));
+}
+/** The column `table` holds under `key`, checked to be a usable entity key. */
+function keyColumnOf(kind, table, key) {
+    const columns = getTableColumns(table);
+    const column = columns[key];
+    if (!(column instanceof PgColumn)) {
+        throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}": table "${getTableName(table)}" has no column "${key}"`);
+    }
+    const [dataType] = column.dataType.split(' ');
+    const sqlType = sqlTypeOf(column);
+    if (dataType !== 'custom' && !isKeyColumn(column)) {
+        throw new JournalError('BAD_DEFINITION', 'entity', kind, dataType === 'string'
+            ? `journal: entity "${kind}": key column "${key}" must be not null`
+            : `journal: entity "${kind}": key column "${key}" must hold a string, it holds ${column.dataType}`);
+    }
+    if (!EXACT_KEY_TYPE.test(sqlType)) {
+        throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}": key column "${key}" has SQL type "${sqlType}"; the key must be text, varchar or uuid, because other types can treat two different strings as the same key`);
+    }
+    if (!isKeyColumn(column)) {
+        throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}": key column "${key}" is a custom column type; a key must be a plain text, varchar or uuid column, because a custom type's mapping can change the string`);
+    }
+    if (!isUniqueOn(table, column)) {
+        throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}": key column "${key}" must be the primary key or carry a unique constraint`);
+    }
+    return column;
+}
+export function defineEntity(kind, table, key) {
+    assertStoredName('entity kind', kind);
+    const keyColumn = keyColumnOf(kind, table, key);
+    const uuidKey = sqlTypeOf(keyColumn) === 'uuid';
+    const keyLimit = keyLimitOf(keyColumn);
+    return builder(kind, table, key, keyColumn, uuidKey, keyLimit, new Map(), new Map(), null);
+}
+function builder(kind, table, key, keyColumn, uuidKey, keyLimit, events, reducers, 
+/** The first `.on` event type, once one is declared. `.create` is refused after it. */
+firstOn) {
+    const declare = (event, next, sealedBy) => builder(kind, table, key, keyColumn, uuidKey, keyLimit, new Map([...events, [event.type, event]]), new Map([...reducers, [event.type, next]]), sealedBy);
+    const create = (event, reduce) => {
+        if (firstOn !== null) {
+            throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}": declare .create(${event.type}) before any .on; .on(${firstOn}) came first`);
+        }
+        const current = reducers.get(event.type) ?? {};
+        if (current.create !== undefined) {
+            throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}" already declares a create reducer for "${event.type}"`);
+        }
+        return declare(event, { ...current, create: reduce }, null);
+    };
+    const on = (event, reduce) => {
+        const current = reducers.get(event.type) ?? {};
+        if (current.on !== undefined) {
+            throw new JournalError('BAD_DEFINITION', 'entity', kind, `journal: entity "${kind}" already declares an on reducer for "${event.type}"`);
+        }
+        return declare(event, { ...current, on: reduce }, firstOn ?? event.type);
+    };
+    return { kind, table, key, keyColumn, uuidKey, keyLimit, events, reducers, create, on };
+}
+/**
+ * A copy of `value` without the own keys that hold `undefined`. In a patch,
+ * `undefined` means "unchanged". In a create result it means "not set": the
+ * database default applies, and the key is not part of the journal's state.
+ */
+function definedOnly(value) {
+    const out = { ...value };
+    for (const key in out) {
+        if (Object.hasOwn(out, key) && out[key] === undefined)
+            delete out[key];
+    }
+    return out;
+}
+function hasKey(value, key) {
+    return key in value;
+}
+/**
+ * `{ [key]: id }` typed by the key. TypeScript types a computed key as an
+ * index signature; the guard above narrows it back to the one key.
+ */
+function keyed(key, id) {
+    const out = { [key]: id };
+    if (!hasKey(out, key))
+        throw new Error(`journal: key "${key}" was not set`);
+    return out;
+}
+/** The reducer-shaped row: a state plus the key column and `version`. */
+export function withEntityIdentity(entity, state, id, version) {
+    return { ...state, ...keyed(entity.key, id), version };
+}
+/**
+ * Fold one event onto the in-memory state. Shared by write and replay, so
+ * both produce the same value for every column a reducer set. The caller has
+ * checked that a reducer exists for the event in this state. `reducerColumns`, when
+ * given, collects the columns the reducers set: a create starts it afresh, a
+ * patch adds its keys, a delete empties it.
+ */
+export function reduceOne(entity, state, id, event, reducerColumns) {
+    const reducers = entity.reducers.get(event.type);
+    if (state === null) {
+        if (reducers?.create === undefined)
+            throw new Error(`journal: entity "${entity.kind}" has no create reducer for "${event.type}"`);
+        const created = definedOnly(reducers.create(event));
+        reducerColumns?.clear();
+        for (const key of Object.keys(created))
+            reducerColumns?.add(key);
+        return created;
+    }
+    if (reducers?.on === undefined)
+        throw new Error(`journal: entity "${entity.kind}" has no on reducer for "${event.type}"`);
+    const patch = reducers.on(withEntityIdentity(entity, state, id, event.version - 1), event);
+    if (patch === null) {
+        reducerColumns?.clear();
+        return null;
+    }
+    const defined = definedOnly(patch);
+    for (const key of Object.keys(defined))
+        reducerColumns?.add(key);
+    return { ...state, ...defined };
+}
+//# sourceMappingURL=entity.js.map

package/dist/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sourceRoot":"","sources":["../src/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAiB/D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AA0E3C,mFAAmF;AACnF,SAAS,WAAW,CAAC,MAAgB;IACnC,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,OAAO,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,cAAc,GAAG,8CAA8C,CAAC;AAEtE,sEAAsE;AACtE,SAAS,SAAS,CAAC,MAAgB;IACjC,OAAO,MAAM,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAClD,CAAC;AAED,gFAAgF;AAChF,MAAM,aAAa,GAAG,GAAG,CAAC;AAE1B;;;GAGG;AACH,SAAS,UAAU,CAAC,MAAgB;IAClC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,IAAI,OAAO,KAAK,MAAM;QAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC7D,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,aAAa;QAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC9G,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACnD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,KAAkB,EAAE,MAAgB;IACtD,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IACnD,MAAM,IAAI,GAAG,CAAC,OAA2B,EAAW,EAAE;QACpD,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;QACxB,OAAO,CACL,OAAO,CAAC,MAAM,KAAK,CAAC;YACpB,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,MAAM,IAAI,KAAK;YACf,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAC3B,CAAC;IACJ,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IACrC,OAAO,CACL,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACrE,oFAAoF;QACpF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CACpH,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,SAAS,WAAW,CAAC,IAAY,EAAE,KAAkB,EAAE,GAAW;IAChE,MAAM,OAAO,GAA4B,eAAe,CAAC,KAAK,CAAC,CAAC;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,MAAM,YAAY,QAAQ,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,aAAa,YAAY,CAAC,KAAK,CAAC,oBAAoB,GAAG,GAAG,CACnF,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,IAAI,QAAQ,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,QAAQ,KAAK,QAAQ;YACnB,CAAC,CAAC,oBAAoB,IAAI,kBAAkB,GAAG,oBAAoB;YACnE,CAAC,CAAC,oBAAoB,IAAI,kBAAkB,GAAG,kCAAkC,MAAM,CAAC,QAAQ,EAAE,CACrG,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,kBAAkB,GAAG,mBAAmB,OAAO,+GAA+G,CACvL,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,kBAAkB,GAAG,sIAAsI,CACpL,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,kBAAkB,GAAG,wDAAwD,CACtG,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,IAAU,EACV,KAAU,EACV,GAAQ;IAER,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC;IAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,OAAO,CACZ,IAAI,EACJ,KAAK,EACL,GAAG,EACH,SAAS,EACT,OAAO,EACP,QAAQ,EACR,IAAI,GAAG,EAAE,EACT,IAAI,GAAG,EAAE,EACT,IAAI,CACL,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAQd,IAAU,EACV,KAAU,EACV,GAAQ,EACR,SAAoB,EACpB,OAAgB,EAChB,QAAkB,EAClB,MAAwC,EACxC,QAAuD;AACvD,uFAAuF;AACvF,OAAsB;IAEtB,MAAM,OAAO,GAAG,CACd,KAAiB,EACjB,IAA8B,EAC9B,QAAuB,EAC4C,EAAE,CACrE,OAAO,CACL,IAAI,EACJ,KAAK,EACL,GAAG,EACH,SAAS,EACT,OAAO,EACP,QAAQ,EACR,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACzC,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAC1C,QAAQ,CACT,CAAC;IACJ,MAAM,MAAM,GAAG,CACb,KAAiB,EACjB,MAAiF,EACU,EAAE;QAC7F,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,sBAAsB,KAAK,CAAC,IAAI,yBAAyB,OAAO,cAAc,CACvG,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/C,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,4CAA4C,KAAK,CAAC,IAAI,GAAG,CAClF,CAAC;QACJ,CAAC;QACD,OAAO,OAAO,CAA2C,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC;IACxG,CAAC,CAAC;IACF,MAAM,EAAE,GAAG,CACT,KAAiB,EACjB,MAG2B,EACuD,EAAE;QACpF,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC/C,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,YAAY,CACpB,gBAAgB,EAChB,QAAQ,EACR,IAAI,EACJ,oBAAoB,IAAI,yCAAyC,KAAK,CAAC,IAAI,GAAG,CAC/E,CAAC;QACJ,CAAC;QACD,OAAO,OAAO,CAA4B,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;IACtG,CAAC,CAAC;IACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;AAC1F,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAmB,KAAQ;IAC7C,MAAM,GAAG,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IACzB,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,MAAM,CAAqC,KAAQ,EAAE,GAAM;IAClE,OAAO,GAAG,IAAI,KAAK,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,SAAS,KAAK,CAAuB,GAAM,EAAE,EAAM;IACjD,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC;IAC1B,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,eAAe,CAAC,CAAC;IAC5E,OAAO,GAAG,CAAC;AACb,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,kBAAkB,CAChC,MAAyD,EACzD,KAAyC,EACzC,EAAsB,EACtB,OAAe;IAEf,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AACzD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,MAAsD,EACtD,KAAgD,EAChD,EAAsB,EACtB,KAAsC,EACtC,cAA4B;IAE5B,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,IAAI,QAAQ,EAAE,MAAM,KAAK,SAAS;YAChC,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,CAAC,IAAI,gCAAgC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;QAChG,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACpD,cAAc,EAAE,KAAK,EAAE,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YAAE,cAAc,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;QACjE,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,QAAQ,EAAE,EAAE,KAAK,SAAS;QAC5B,MAAM,IAAI,KAAK,CAAC,oBAAoB,MAAM,CAAC,IAAI,4BAA4B,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;IAC5F,MAAM,KAAK,GAAG,QAAQ,CAAC,EAAE,CAAC,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC3F,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,cAAc,EAAE,KAAK,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,cAAc,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACjE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;AAClC,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,47 @@
+export type JournalErrorCode = 'CONFLICT' | 'NO_ROW' | 'ROW_EXISTS' | 'UNKNOWN_EVENT' | 'VERSION_MISMATCH' | 'NO_HISTORY' | 'HISTORY_GAP' | 'REPLAY_FAILED' | 'UNSTABLE_SCHEMA' | 'ID_MISMATCH' | 'VALUE_MISMATCH' | 'BAD_DEFINITION';
+/**
+ * An error about one entity's row or history: a write, replay, verify or repair
+ * that the journal refuses. Match on `code`, never on the message.
+ *
+ * Not every error the journal lets out is a `JournalError`:
+ * - A wrong definition is a `JournalError` with code `BAD_DEFINITION`, thrown when the
+ *   declaration runs (a bad name, a bad key column, a duplicate reducer or handler name).
+ * - A misuse at run time is a plain `Error` whose message starts with `journal:` (two
+ *   operations at once on one transaction, `drain` inside a transaction).
+ * - Command input, event data or `meta` that fails its schema is a `ZodError`.
+ * - An error thrown by a command handler, an `events` function, a reducer or a
+ *   projection passes through unchanged. A rejected business rule is one of
+ *   these: a `CommandError`, below.
+ * An error thrown by an effect is caught by `drain` and stored on the job.
+ */
+export declare class JournalError extends Error {
+    readonly code: JournalErrorCode;
+    readonly kind: string;
+    readonly entityId: string;
+    /** The message reads: `CODE: what happened (kind id): detail. What to do next.` */
+    constructor(code: JournalErrorCode, kind: string, entityId: string, detail?: string, options?: ErrorOptions);
+}
+export declare function isJournalError(error: unknown, code?: JournalErrorCode): error is JournalError;
+/** The kind of answer a rejected request gets. The names are the usual HTTP ones: 404, 400, 403, 409. */
+export type CommandErrorCode = 'NOT_FOUND' | 'BAD_REQUEST' | 'FORBIDDEN' | 'CONFLICT';
+/**
+ * A business rule rejected the request. App code throws it: a command handler,
+ * or the `events` function of a `write`. The code names the kind of answer and
+ * the message is written for the client.
+ *
+ * It is NOT a `JournalError`. A `JournalError` is the library's own failure: a
+ * row or a history it refuses. A `CommandError` is the app's rule saying no.
+ * The library never throws one and never changes one: like every error thrown
+ * by app code, it leaves `journal.run` as the same instance, after the
+ * command's transaction rolled back.
+ *
+ * Nothing here knows HTTP. The host maps the code to its own transport:
+ * `@arki/journal/orpc` does it for oRPC, and any other host matches on the
+ * code with `isCommandError`.
+ */
+export declare class CommandError extends Error {
+    readonly code: CommandErrorCode;
+    constructor(code: CommandErrorCode, message: string);
+}
+export declare function isCommandError(error: unknown, code?: CommandErrorCode): error is CommandError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GACxB,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,eAAe,GACf,kBAAkB,GAClB,YAAY,GACZ,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,gBAAgB,GAChB,gBAAgB,CAAC;AAsDrB;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAa,SAAQ,KAAK;IACrC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,mFAAmF;IACnF,YAAY,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAS1G;CACF;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,KAAK,IAAI,YAAY,CAE7F;AAED,yGAAyG;AACzG,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAC;AAEtF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAa,SAAQ,KAAK;IACrC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAEhC,YAAY,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAIlD;CACF;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,gBAAgB,GAAG,KAAK,IAAI,YAAY,CAE7F"}