commitrail 0.1.0-alpha.0

package/LICENSE

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

package/README.md

@@ -0,0 +1,12 @@
+# commitrail
+
+**CommitRail is not publicly available.**
+
+This package is published as a prerelease. It is undocumented, it is not on the `latest` tag,
+and its API may change without notice.
+
+**Please do not use it in production.**
+
+---
+
+Apache-2.0 — © Syrenox Systems Ltd

package/dist/cjs/envelope.d.ts

@@ -0,0 +1,91 @@
+/**
+ * The wire contract.
+ *
+ * This package is the single definition of it. CommitRail signs and sends using exactly
+ * what customers import to receive and verify, so the two cannot drift — the same reason
+ * the control plane serialises through its route schemas rather than describing them
+ * separately.
+ */
+import type { EventSubject } from './subjects.js';
+export declare const SPEC_VERSION = "1";
+export interface CommitRailEvent<TData = unknown> {
+    specVersion: string;
+    /**
+     * The producer's own event identity, carried through untouched.
+     *
+     * Unique within its source, and not beyond it: a destination fed by two sources can see
+     * the same id from unrelated events. Deduplicate on `delivery.id`.
+     */
+    id: string;
+    type: string;
+    version: number;
+    /** When the event happened, as the producer recorded it. */
+    occurredAt: string;
+    /**
+     * The logical operation this event belongs to, and the event that caused it.
+     *
+     * Absent when the producer named neither — an absent member says "this event names no
+     * operation" more clearly than a null does. Put the same `correlationId` on whatever you
+     * emit in response and CommitRail joins the chain without being told anything else.
+     */
+    correlationId?: string;
+    causationId?: string;
+    /**
+     * The business identities the producer declared this event concerns.
+     *
+     * Absent when none were declared, for the same reason as the members above — and never
+     * inferred: these are exactly what the producer wrote, so a consumer can route or index
+     * on them with the same trust the producer's own code would get.
+     */
+    subjects?: EventSubject[];
+    delivery: {
+        /**
+         * The obligation this request is fulfilling, stable across every retry.
+         *
+         * **This is the idempotency key.** One event legitimately becomes two obligations when
+         * two routes point at the same destination, so deduplicating on `id` would silently
+         * drop the second.
+         */
+        id: string;
+        attempt: number;
+    };
+    data: TData;
+}
+/** Header names CommitRail sends. Lowercase, as Node normalises them. */
+export declare const HEADERS: {
+    readonly specVersion: "commitrail-spec-version";
+    readonly deliveryId: "commitrail-delivery-id";
+    readonly idempotencyKey: "commitrail-idempotency-key";
+    readonly attemptId: "commitrail-attempt-id";
+    readonly attemptNumber: "commitrail-attempt-number";
+    readonly eventId: "commitrail-event-id";
+    readonly eventType: "commitrail-event-type";
+    readonly timestamp: "commitrail-timestamp";
+    readonly signature: "commitrail-signature";
+};
+/**
+ * Serialise the wire envelope.
+ *
+ * Built by hand rather than with `JSON.stringify` on an object, for one reason: `data` is
+ * the customer's payload as PostgreSQL rendered it, and it must be spliced in as text.
+ * Parsing it to put it in an object would run it through `JSON.parse`, which is float64 and
+ * silently rewrites any integer past 2^53 — an order id of 12345678901234567890 came back
+ * as 12345678901234567000. See docs/defects.md.
+ *
+ * Every other member still goes through `JSON.stringify`, which is what escapes them. The
+ * field order is fixed and visible on purpose: these bytes are what gets signed, so the
+ * order is part of the contract rather than an implementation detail of an object literal.
+ */
+export declare function serialiseEnvelope(input: {
+    id: string;
+    type: string;
+    version: number;
+    occurredAt: string;
+    correlationId?: string | null;
+    causationId?: string | null;
+    subjects?: EventSubject[] | null;
+    deliveryId: string;
+    attempt: number;
+    /** JSON text. Never a parsed value — see the note above. */
+    data: string;
+}): string;

package/dist/cjs/envelope.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HEADERS = exports.SPEC_VERSION = void 0;
+exports.serialiseEnvelope = serialiseEnvelope;
+exports.SPEC_VERSION = '1';
+/** Header names CommitRail sends. Lowercase, as Node normalises them. */
+exports.HEADERS = {
+    specVersion: 'commitrail-spec-version',
+    deliveryId: 'commitrail-delivery-id',
+    idempotencyKey: 'commitrail-idempotency-key',
+    attemptId: 'commitrail-attempt-id',
+    attemptNumber: 'commitrail-attempt-number',
+    eventId: 'commitrail-event-id',
+    eventType: 'commitrail-event-type',
+    timestamp: 'commitrail-timestamp',
+    signature: 'commitrail-signature',
+};
+/**
+ * Serialise the wire envelope.
+ *
+ * Built by hand rather than with `JSON.stringify` on an object, for one reason: `data` is
+ * the customer's payload as PostgreSQL rendered it, and it must be spliced in as text.
+ * Parsing it to put it in an object would run it through `JSON.parse`, which is float64 and
+ * silently rewrites any integer past 2^53 — an order id of 12345678901234567890 came back
+ * as 12345678901234567000. See docs/defects.md.
+ *
+ * Every other member still goes through `JSON.stringify`, which is what escapes them. The
+ * field order is fixed and visible on purpose: these bytes are what gets signed, so the
+ * order is part of the contract rather than an implementation detail of an object literal.
+ */
+function serialiseEnvelope(input) {
+    // Omitted rather than sent as null, so the envelope keeps the shape it has always had for
+    // events that name no operation.
+    const optional = (name, value) => value === null || value === undefined ? '' : `"${name}":${JSON.stringify(value)},`;
+    return ('{' +
+        `"specVersion":${JSON.stringify(exports.SPEC_VERSION)},` +
+        `"id":${JSON.stringify(input.id)},` +
+        `"type":${JSON.stringify(input.type)},` +
+        `"version":${JSON.stringify(input.version)},` +
+        `"occurredAt":${JSON.stringify(input.occurredAt)},` +
+        optional('correlationId', input.correlationId) +
+        optional('causationId', input.causationId) +
+        // A new member is added to the fixed order, never inserted into it: envelopes without
+        // subjects keep exactly the bytes they have always had, which is what lets deployed
+        // verifiers stay deployed. `JSON.stringify` of the array is safe — subjects are strings
+        // by contract, so there is no float64 hazard here, unlike `data`.
+        (input.subjects === null || input.subjects === undefined || input.subjects.length === 0
+            ? ''
+            : `"subjects":${JSON.stringify(input.subjects)},`) +
+        `"delivery":{"id":${JSON.stringify(input.deliveryId)},"attempt":${JSON.stringify(input.attempt)}},` +
+        `"data":${input.data}` +
+        '}');
+}
+//# sourceMappingURL=envelope.js.map

package/dist/cjs/envelope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"envelope.js","sourceRoot":"","sources":["../../src/envelope.ts"],"names":[],"mappings":";;;AAyFA,8CAsCC;AArHY,QAAA,YAAY,GAAG,GAAG,CAAC;AAqDhC,yEAAyE;AAC5D,QAAA,OAAO,GAAG;IACrB,WAAW,EAAE,yBAAyB;IACtC,UAAU,EAAE,wBAAwB;IACpC,cAAc,EAAE,4BAA4B;IAC5C,SAAS,EAAE,uBAAuB;IAClC,aAAa,EAAE,2BAA2B;IAC1C,OAAO,EAAE,qBAAqB;IAC9B,SAAS,EAAE,uBAAuB;IAClC,SAAS,EAAE,sBAAsB;IACjC,SAAS,EAAE,sBAAsB;CACzB,CAAC;AAEX;;;;;;;;;;;;GAYG;AACH,SAAgB,iBAAiB,CAAC,KAYjC;IACC,0FAA0F;IAC1F,iCAAiC;IACjC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAgC,EAAE,EAAE,CAClE,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;IAErF,OAAO,CACL,GAAG;QACH,iBAAiB,IAAI,CAAC,SAAS,CAAC,oBAAY,CAAC,GAAG;QAChD,QAAQ,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG;QACnC,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;QACvC,aAAa,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG;QAC7C,gBAAgB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG;QACnD,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,aAAa,CAAC;QAC9C,QAAQ,CAAC,aAAa,EAAE,KAAK,CAAC,WAAW,CAAC;QAC1C,sFAAsF;QACtF,oFAAoF;QACpF,wFAAwF;QACxF,kEAAkE;QAClE,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YACrF,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QACpD,oBAAoB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI;QACnG,UAAU,KAAK,CAAC,IAAI,EAAE;QACtB,GAAG,CACJ,CAAC;AACJ,CAAC"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The protocol, as a customer needs it.
+ *
+ * Everything here is something you use to integrate with CommitRail. Nothing is here because
+ * CommitRail's own server happens to need it: the server implements this same protocol from its
+ * own private code and imports nothing from this package, so the public surface is a decision
+ * about your integration rather than a projection of our internals.
+ *
+ * What that costs is the ability to say "we sign with exactly the function you verify with".
+ * What it buys is that every export here is one we intend to support, and the guarantee is kept
+ * where it can actually be kept for every language — by conformance vectors both implementations
+ * are tested against, and by end-to-end tests that verify what CommitRail sends using this
+ * verifier. A Go verifier could never have shared our functions either.
+ *
+ * Each side has a subpath of its own: `commitrail/postgres` produces, `commitrail/webhooks`
+ * receives, and neither is re-exported here.
+ */
+export { SPEC_VERSION, HEADERS, type CommitRailEvent } from './envelope.js';
+export { InvalidSubjectsError, SUBJECT_LIMITS, type EventSubject } from './subjects.js';
+export { verifySignatureHeader } from './signing.js';

package/dist/cjs/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifySignatureHeader = exports.SUBJECT_LIMITS = exports.InvalidSubjectsError = exports.HEADERS = exports.SPEC_VERSION = void 0;
+/**
+ * The protocol, as a customer needs it.
+ *
+ * Everything here is something you use to integrate with CommitRail. Nothing is here because
+ * CommitRail's own server happens to need it: the server implements this same protocol from its
+ * own private code and imports nothing from this package, so the public surface is a decision
+ * about your integration rather than a projection of our internals.
+ *
+ * What that costs is the ability to say "we sign with exactly the function you verify with".
+ * What it buys is that every export here is one we intend to support, and the guarantee is kept
+ * where it can actually be kept for every language — by conformance vectors both implementations
+ * are tested against, and by end-to-end tests that verify what CommitRail sends using this
+ * verifier. A Go verifier could never have shared our functions either.
+ *
+ * Each side has a subpath of its own: `commitrail/postgres` produces, `commitrail/webhooks`
+ * receives, and neither is re-exported here.
+ */
+var envelope_js_1 = require("./envelope.js");
+Object.defineProperty(exports, "SPEC_VERSION", { enumerable: true, get: function () { return envelope_js_1.SPEC_VERSION; } });
+Object.defineProperty(exports, "HEADERS", { enumerable: true, get: function () { return envelope_js_1.HEADERS; } });
+var subjects_js_1 = require("./subjects.js");
+Object.defineProperty(exports, "InvalidSubjectsError", { enumerable: true, get: function () { return subjects_js_1.InvalidSubjectsError; } });
+Object.defineProperty(exports, "SUBJECT_LIMITS", { enumerable: true, get: function () { return subjects_js_1.SUBJECT_LIMITS; } });
+var signing_js_1 = require("./signing.js");
+Object.defineProperty(exports, "verifySignatureHeader", { enumerable: true, get: function () { return signing_js_1.verifySignatureHeader; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,6CAA4E;AAAnE,2GAAA,YAAY,OAAA;AAAE,sGAAA,OAAO,OAAA;AAC9B,6CAAwF;AAA/E,mHAAA,oBAAoB,OAAA;AAAE,6GAAA,cAAc,OAAA;AAC7C,2CAAqD;AAA5C,mHAAA,qBAAqB,OAAA"}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/postgres.d.ts

@@ -0,0 +1,152 @@
+import { type EventSubject } from './subjects.js';
+/** Registered globally by description, so every copy of this package agrees on it. */
+declare const CONFLICTING_EVENT_BRAND: unique symbol;
+/**
+ * The minimum CommitRail needs to write a row.
+ *
+ * Structural on purpose, with no dependency on any driver: a `pg` `PoolClient` satisfies
+ * it as-is, and `fromPrisma` adapts a Prisma transaction client. Requiring a particular
+ * driver would make adoption a migration.
+ */
+export interface OutboxWriter {
+    query(sql: string, params: unknown[]): Promise<unknown>;
+}
+export interface EmitEvent<TData = unknown> {
+    type: string;
+    data: TData;
+    version?: number;
+    occurredAt?: Date;
+    /** Supply one to make emitting idempotent under your own retries. */
+    eventId?: string;
+    /**
+     * The logical operation this event belongs to — an order number, a checkout id, whatever
+     * your application already calls it.
+     *
+     * CommitRail groups events that share one and never invents one. Propagate it into the
+     * events your consumers emit in turn, and the chain joins up on its own.
+     */
+    correlationId?: string;
+    /** The event that caused this one, if your application knows. */
+    causationId?: string;
+    /**
+     * The business identities this event concerns — `{ type: 'order', id: 'order_1264' }`.
+     *
+     * Distinct from everything above: the event type says *what happened*, the correlation id
+     * says *which operation it belongs to*, the causation id says *what caused it* — subjects
+     * say *what it was about*. Declare every relevant identity; CommitRail indexes them so an
+     * investigation can start from an order or customer id rather than an event id. Exact
+     * duplicates are dropped; order carries no meaning.
+     */
+    subjects?: EventSubject[];
+}
+/**
+ * The outbox schema, as an append-only list of migrations.
+ *
+ * A list rather than one script, because the alternative already caused a problem. A single
+ * converge-to-latest constant changes when the package changes, so a customer who pasted it
+ * into `001_add_commitrail.sql` finds that migration meaning something different a year later
+ * — which is the one thing migrations exist not to do. Pinning a version instead gives them an
+ * immutable statement of what they applied.
+ *
+ * **Every entry here is frozen once released.** A released migration has run against databases
+ * we do not own and cannot re-run; editing one changes what a version *means* while leaving
+ * every already-migrated database untouched. Fix a mistake by appending, never by amending.
+ *
+ * Each is written to be safely re-runnable — `IF NOT EXISTS`, `ADD COLUMN IF NOT EXISTS` — so
+ * applying the whole list to any database converges it, whatever it started from.
+ */
+export declare const OUTBOX_MIGRATIONS: readonly {
+    readonly version: number;
+    readonly sql: string;
+}[];
+/** The newest schema this package knows how to write. */
+export declare const OUTBOX_SCHEMA_VERSION: number;
+/**
+ * Every migration, in order, for a fresh install or to bring an old outbox up to date.
+ *
+ * Safe to run against any database at any version: every statement is conditional, and the
+ * marker only moves forward. This is the convenience; `OUTBOX_MIGRATIONS` is the contract.
+ *
+ * Versions before the marker table existed record nothing — there is nowhere to record it. The
+ * migration that creates the table sets the version to its own, which is sound because the list
+ * is ordered and everything before it has just run.
+ */
+export declare const OUTBOX_SCHEMA_SQL: string;
+/**
+ * A different event was already written under this `eventId`.
+ *
+ * Supplying an `eventId` is a claim that two calls describe the same event. When they do not,
+ * one of them is a mistake — a reused id, or a collision — and CommitRail has no way to know
+ * which. Discarding the second silently would leave the producer believing it was written.
+ *
+ * Thrown from inside the caller's transaction. **When the exception is allowed to propagate
+ * out of a `transaction()` callback, the transaction rolls back** and nothing half-happens.
+ * That is the intended handling and the reason this throws rather than returning a flag.
+ *
+ * Note what a throw does not do: it does not poison the PostgreSQL transaction by itself. A
+ * caller managing `BEGIN`/`COMMIT` themselves can catch this and commit anyway, and would then
+ * have committed business state describing an event that was never written. There is no way for
+ * an SDK to prevent that; enforcing it against every writer would mean putting the rule in the
+ * customer's database, which is a schema-versioning cost not worth paying yet. Catching this and
+ * continuing is almost certainly wrong.
+ */
+export declare class EventIdConflictError extends Error {
+    readonly eventId: string;
+    static readonly brand: symbol;
+    readonly [CONFLICTING_EVENT_BRAND] = true;
+    constructor(eventId: string);
+    static is(error: unknown): error is EventIdConflictError;
+}
+/**
+ * Write an event to the outbox **inside the caller's transaction**.
+ *
+ * That is the entire point, and the only thing that can go wrong here. Pass a transaction
+ * and the event commits with your business state or not at all. Pass a pool — which also
+ * has `.query` — and you have written the event on a separate connection, which is the
+ * dual write CommitRail exists to eliminate. Nothing at runtime can tell the two apart, so
+ * prefer `transaction()` below, which does not give you the chance.
+ *
+ * If you already manage transactions yourself, call `emit` on your transaction-scoped client.
+ * The example is deliberately not a `BEGIN`/`COMMIT` pair: written short it has no rollback
+ * path, and `emit` throwing would leave the connection inside a failed transaction.
+ *
+ * ```ts
+ * // `tx` is whatever your code already uses for the surrounding transaction.
+ * await emit(tx, { type: 'order.created', data: { orderId } });
+ * ```
+ */
+export declare function emit<TData>(writer: OutboxWriter, event: EmitEvent<TData>): Promise<string>;
+export interface TransactionalWriter extends OutboxWriter {
+    emit<TData>(event: EmitEvent<TData>): Promise<string>;
+}
+interface Pool {
+    connect(): Promise<OutboxWriter & {
+        release(): void;
+    }>;
+}
+/**
+ * Run work in a transaction, with `emit` bound to it.
+ *
+ * The recommended shape, because it removes the one mistake available: the writer handed
+ * to the callback is the transaction, so an event cannot accidentally be written outside
+ * it.
+ *
+ * ```ts
+ * await transaction(pool, async (tx) => {
+ *   await tx.query('INSERT INTO orders (id, total) VALUES ($1, $2)', [id, total]);
+ *   await tx.emit({ type: 'order.created', data: { orderId: id } });
+ * });
+ * ```
+ */
+export declare function transaction<T>(pool: Pool, work: (tx: TransactionalWriter) => Promise<T>): Promise<T>;
+/**
+ * Adapt a Prisma transaction client.
+ *
+ * Typed structurally so this package does not depend on Prisma. Uses `$executeRawUnsafe`
+ * because the SQL is a constant defined above and the values are parameterised — the
+ * "unsafe" in the name refers to interpolating the statement, which never happens here.
+ */
+export declare function fromPrisma(tx: {
+    $executeRawUnsafe(sql: string, ...values: unknown[]): Promise<number>;
+}): OutboxWriter;
+export {};