@openlup/outbox 0.0.0 → 0.14.0

package/AGENTS.md

@@ -0,0 +1,65 @@
+# @openlup/outbox for agents
+
+## Purpose and kind
+
+Kind: `rail`.
+
+The package owns neutral dispatch, registry composition, lease-bound schedules and the default PostgreSQL store. Drivers, application handlers, credentials, producer transactions, host guards and trigger bindings stay in the application. Inside the OpenLup monorepo the root `AGENTS.md` governs.
+
+## Subpath maturity
+
+| Export | Role | Maturity |
+| --- | --- | --- |
+| `.` | rail | experimental |
+| `./postgres` | rail | experimental |
+| `./testing` | testing | testing |
+
+## Wiring example
+
+The compiled npm-only reference proof uses the same factories at scheduled and immediate entries. A minimal store binding is:
+
+```ts
+import { createPostgresOutboxStore } from "@openlup/outbox/postgres";
+import type { SqlExecutor } from "@openlup/core/readiness";
+export const bindStore = (executor: SqlExecutor) => createPostgresOutboxStore(executor);
+```
+
+The executor must commit every operation before resolving. Apply shipped SQL through the application's migration chain and admit the candidate with the core checker before effects. The README explains full schedule, transaction and failure ownership.
+
+## Sources and declarations
+
+Inspect `src/` and the exported declaration files in `dist/`; `sql/manifest.json` binds the baseline. The development preview may change any experimental export.
+
+## Readiness codes
+
+Composition can report `OPENLUP_E_PORT_MISSING`, `OPENLUP_E_EVENT_UNHANDLED`, `OPENLUP_E_EVENT_DUPLICATE`, `OPENLUP_E_SCHEDULE_UNBOUND`, `OPENLUP_E_SCHEMA_BEHIND`, `OPENLUP_E_SET_MISMATCH` and `OPENLUP_E_ENV_MISSING`. Unknown observations refuse activation. Catalog observations prove no SQL-body, ACL or provider-recovery semantics.
+
+## Using this package in an application
+
+Keep the dispatch engine in its authentic npm package. Do not edit
+`node_modules/@openlup/**`, autonomously patch/fork/vendor/monkey-patch/shadow the
+package or restore a copied engine. Use declared public exports. Drivers,
+handlers, policies, host bindings and compatible native stores remain ordinary
+application code; they need no record per function or upstream release.
+
+The public `withPayloadSchema`, `composeHandlers` and `uniqueRegistry` seams keep
+handler policy and effects in the application. The [README](README.md) explains
+retry, transaction, fence and admission obligations; `./testing` supplies the
+store-fence check, not complete adapter or absorption proof. A missing seam needs
+a local reproducer and authorized upstream proposal. Use a supported compatible
+wrapper/adapter, or hold the dependent change while retaining compatible serving
+work or an available compatible rollback. Do not rewrite published SQL or lose
+pending obligations.
+
+Upgrade every `@openlup/*` together after reading all `Migration:` blocks. Compare
+current producer/schema/policy/bindings with the actual target at first adoption
+and upgrade. Settle affected nominations as full, partial, retained or hold using
+capability and durable-effect evidence, including dormant branches and retry;
+keep distinct same-event effects. Move or settle open markers when native code is
+refactored even without pin changes. A merged contribution is not adoption proof.
+
+This guide describes the installed contract; it grants no host/tool/external-write
+authority and installs no controls. The monorepo's contributor process does not
+govern your application. Your application owns admission, delivery and production
+authority. The [README's adoption route](README.md#adoption-and-native-extensions)
+links optional source guidance; later instructions do not change this version.

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## [Unreleased]
+
+## [0.14.0]
+
+- Publishable on the npm `latest` dist-tag as `0.14.0`, from tag
+  `openlup-outbox-v0.14.0`.
+
+- Republish with the exact `@openlup/core` `0.14.0` peer pin; Outbox APIs, runtime behavior and shipped SQL are unchanged.
+
+## [0.13.1]
+
+- Publishable on the npm `latest` dist-tag as `0.13.1`, from tag
+  `openlup-outbox-v0.13.1`.
+
+- Build the exact workspace core peer before packing outbox on a fresh publication runner. The `0.13.0` outbox publication stopped before npm; `0.13.1` restores the complete package set without changing APIs, runtime behavior or shipped SQL.
+
+## [0.13.0]
+
+- Publishable on the npm `latest` dist-tag as `0.13.0`, from tag
+  `openlup-outbox-v0.13.0`.
+
+- Introduce the experimental transactional outbox rail with bare dispatch, registry composition, typed-payload validation and lease-bound dispatch/prune schedules.
+- Ship the default PostgreSQL store and fresh-install schema; terminal compaction preserves dedupe identities and leaves uncertain discard ages untouched.
+
+Migration: before, an application owned its copied dispatch engine. After, compose the package and keep application-owned drivers, handlers, recovery and producer transactions; apply the shipped baseline only to a fresh database through your migration chain, then admit the exact candidate before effects. Upgrade the whole package set when released.

package/LICENSE

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

package/README.md

@@ -1,3 +1,95 @@
-# Package-name registration placeholder
+# @openlup/outbox
 
-This inert version reserves the package name for automated, provenance-backed releases. It contains no implementation. Do not install it for application use.
+Development preview, kind `rail`. One at-least-once dispatch engine, lease-bound dispatch and terminal-compaction schedules, registry composition, transactional enqueue and a driver-free PostgreSQL default. No stable API or universal exactly-once guarantee is claimed.
+
+The publication catalogue admits this complete rail to the release set. Catalogue admission does not publish it: direct directory publishing still refuses, and the reviewed release workflow owns provenance-backed publication. New API and shipped SQL require the next minor set.
+
+## Package Surface Maturity
+
+| Export | Role | Maturity |
+| --- | --- | --- |
+| `.` | rail | experimental |
+| `./postgres` | rail | experimental |
+| `./testing` | testing | testing |
+
+The application supplies its driver, committed-operation executor, lease adapter, effect handlers, explicit ordered known event vocabulary and host trigger bindings. `createOutbox` validates effective composed timeouts before construction and matches the run-built registry before the first claim. The lease must cover the full declared host execution window, including finish time; the factory has no renewal loop. Build after the lease; a builder owns partially acquired resources until it returns a scope. A returned scope closes after finish, including failure. Hook metadata cannot replace reserved run identity or worker counters. A resolved negative business observation is nonfatal; a thrown business hook prevents claims and attempts a failed finish once. A failed finish remains observable; cleanup errors do not turn accepted effects into retries.
+
+The bare `runOutboxDispatchWorker` supports immediate dispatch without a job lease. The registry alone supplies its claim allowlist. `knownEventTypes` is explicit and is never derived from enabled handlers. A composed handler replays its first component when the second retries, sums timeouts, and retains the original nested details and top-level delivery observations. Its components deliberately do not receive the transient execution context. Effects must honor abort and enforce their own idempotency; timeout cannot cancel a request already accepted by a provider.
+
+## PostgreSQL installation and transactions
+
+Apply [the baseline](sql/0001_outbox.sql) through your own migration chain on a fresh PostgreSQL database. [The manifest](sql/manifest.json) binds its bytes to their public migration owner. PostgreSQL 16 or later supplies the validated timestamp parser used by compaction. Importing the package never applies SQL. Existing managed schemas need their own compatibility assessment; do not apply the fresh-install baseline over them. The default does not supply provider recovery, RLS or role grants.
+
+`buildOutboxEnqueue` returns bound SQL for the producer's transaction. Execute the domain write and enqueue on the same transaction client; commit or roll back both. Duplicate `(event_type,idempotency_key)` enqueue creates no second row. The dispatch executor must commit each claim/ack/failure/release operation before its promise resolves, with no transaction held across handler I/O. A type-compatible executor alone does not prove this property. Compaction likewise commits per operation.
+
+Claims retain six timestamp digits, per-aggregate ordering, exact dormant identities and claim-token fences. An unknown non-dormant predecessor blocks its aggregate; a known but currently unclaimed type may be bypassed. Snooze and release refund attempts. Storage errors remain exceptions; unstarted claims from an interrupted batch expire rather than being falsely settled.
+
+Prune defaults to 30 days for processed and 90 for discarded, in batches of 500. It empties terminal payload/error and stamps `retentionCompactedAt`, `retentionCompactedBy` and `retentionCompactedStatus`; rows and unique dedupe keys survive. Missing/malformed discard timestamps are ineligible. Pending, failed and processing work remains untouched. Application delivery/ledger adjunct retention remains application-owned.
+
+## Readiness and verification
+
+<!-- openlup-doc-impact {"unit":"outbox-rail","digest":"sha256-207a9646260642afdf50398c025d2305f1126fc89a45a5652ededd14bef1f402","reason":"The Outbox version and exact Core peer pin move together from 0.13.1 to 0.14.0. This preparation changes no Outbox API, runtime, SQL, readiness responsibilities or verification step."} -->
+
+Compose the contribution with `@openlup/core/readiness`, actual loaded package metadata, selected-adapter schema observations and host bindings to the exact contribution run/handle functions before activating the exact new candidate. Only `ready` admits; `unknown` and `unsatisfied` leave the serving version running. Descriptors are inert; the builder supplies the same actual event identities and effective timeouts after lease acquisition. The default schema declaration describes catalog existence and overloads; it does not prove bodies, ACL or recovery. Use framework-free fence conformance from `./testing` and real transactional proof for your adapter. No ambient database URL is used by the packed proof.
+
+From an OpenLup task checkout, the existing packed proof accepts an explicit disposable loopback PostgreSQL database and a verified cold-set manifest:
+
+```sh
+node --experimental-strip-types scripts/packages/outbox-consumer-proof.ts \
+  postgresql://postgres@127.0.0.1:5432/openlup_outbox_proof \
+  .context/scratch/outbox-packed-proof \
+  --manifest "$OPENLUP_PACK_MANIFEST" --expected-commit "$OPENLUP_PACK_COMMIT"
+```
+
+Supply both manifest inputs together. The runner verifies the exact publishable inventory, versions, commit and tarball digests before installation; missing or damaged input refuses without repacking. It installs only Core and Outbox, the packages imported by this reference composition; unrelated modules have their own consumers. It installs outside checkout ancestry with scripts disabled, records consumed artifacts and installed identities in task scratch, injects only the host PostgreSQL test driver and compiles the actual reference composition. Omitting both inputs retains manual packing of already-built packages. The caller owns the disposable database; the proof closes its pools and removes its temporary consumer on success or failure. Required CI and its local runner provide an owned PostgreSQL 17 instance and an enclosing deadline.
+
+For the local required route, run `node --experimental-strip-types scripts/packages/outbox-disposable-postgres.ts --manifest <manifest-path> --expected-commit <full-sha>`. It owns a fresh pinned PostgreSQL 17 container, loopback port, database and cleanup; it refuses invalid artifacts before starting the service. The CI form receives the exact pinned job service container ID and mapped port, creates only this proof's UUID-named database and drops it afterward, including when the CREATE response is lost. The manual proof above retains its fixed disposable database name; the owned route uses `openlup_outbox_proof_<32 lowercase UUID hex digits>`. Neither form adopts an ambient service. Local cleanup can recover the container by its known unique name if its creation response is lost, and requires the actual name, ID and owner label before removal. Startup is bounded at 30 seconds, packed child work at 180 seconds, and each Docker operation at 30 seconds; interruptions terminate the child process group before owned cleanup. Repeated signals forwarded by npm or the package wrapper remain handled until cleanup finishes. The actual proof owner also shields its bounded cleanup inspect, container removal and database DROP commands from verifier group signals. The owner stays in that group until those commands finish; their existing 30-second limits and all ownership checks remain. Local containers use one CPU and 512 MiB of memory. These are proof bounds, not package runtime settings.
+
+Before SQL, the Outbox binding supplies its actual installed schema/probe/checker exports and reference input to the common repository test utility `scripts/packages/schema-budget-proof.mjs`. Future modules can reuse that utility with their own installed requirement and input callback; it carries no package registry or duplicate schema inventory. Its positive serial model uses 250 ms setup plus 100 ms per presence operation, so actual schema growth participates automatically. A single operation longer than the unchanged 3000 ms waiting deadline proves timeout refusal even if the adapter later batches reads. Completeness and overload cases follow the supplied schema's capabilities. Timer cleanup does not imply cancellation of pending driver work; the proof settles its owned fake queue before restoring real timers. The same real database then demonstrates absent table, column and function-overload observations. A single replay witness accepts a synthetic durable effect, loses acknowledgement, reclaims the same event through scheduled work after immediate work, refuses the formerly valid token and acknowledges the new claim. Multiple attempts with one application-owned deduped effect demonstrate at-least-once recovery for this synthetic example, not provider recovery or a universal exactly-once contract.
+
+The same installed Core tarball also executes the additive grouped readiness
+catalog query in [the neutral grouped proof](smoke/groupedSchemaProof.ts).
+Within a host-owned read-only repeatable-read transaction it compares grouped
+presence with every scalar probe, including the existing Outbox requirement,
+exact overloads, absent objects, dropped/system columns, views and sequences,
+quoted relation names, duplicate ordinals and an empty request. Independent
+catalog reads verify constraints, indexes, noninternal triggers, policies and
+function definitions. Fresh tables/partitions, identity/generated/default
+columns, RLS, ACL and function configuration/security/volatility exercise rich
+and empty shapes. The proof requires jsonb text rows, definition-string arrays,
+null empty aggregates, raw policy OIDs/command codes/booleans and exact parsed
+jsonb property/nested ordering. Parsed driver objects are refused.
+Invalid catalog resolution still propagates to the host. This reuses the existing
+pinned PostgreSQL service, artifact checks and cleanup; it adds no gate or host
+admission policy and does not prove effective authorization or SQL behavior.
+
+The root companion tests retain real interruption and lost-response fixtures. Their owned JSON witness markers are written completely to a same-directory temporary file and then renamed into place, so readers never treat a newly created, partially written file as a ready observation. A plain Node process owns each fixture's service and launcher and stays in the root test process group until teardown finishes, even when Vitest's worker exits. Only the bounded Docker cleanup commands detach; their process-start window can still receive a group TERM. The companion fixture allows one recovery only for a child terminated by SIGTERM with no reported error, inside the original 10-second inspect or removal deadline. An interrupted removal is followed by actual Docker inspection: normal no-such-object refusal confirms absence, otherwise the same full ID, name and UUID label must still match before one removal retry. The recovery never resets its deadline, treats a signal as absence, or masks a timeout, nonzero result, wrong owner or second interruption. Cleanup recovers by the known unique name after a lost creation response. Root cancellation regressions interrupt actual Vitest workers after service creation and after detached proof readiness, and check resource termination before releasing their own test lock. They create no verification stamp or shared verifier lock. Separate teardown regressions cancel the actual npm/launcher route during each cleanup operation and assert that its container or UUID database is removed while an unrelated supplied-service database remains.
+
+Upgrade the complete `@openlup/*` set together after reading each changelog. Use ports and composition; do not edit or patch installed package bytes. Sources are in `src/`, built JavaScript/declarations in `dist/`. Synthetic packed-consumer proof is first-party package evidence, not an independent adopter, provider-delivery or deployment certificate.
+
+## Adoption and native extensions
+
+One npm package owns the dispatch algorithm. Application drivers, handlers,
+policies, host bindings and compatible native stores remain editable through
+public seams without a nomination or per-function ownership record. Do not
+autonomously fork, vendor, monkey-patch, shadow or restore a copied engine; use
+only the installed package's declared exports. A missing seam follows the
+[agent guide's dependent hold and compatible recovery route](AGENTS.md#using-this-package-in-an-application).
+
+At first adoption compare the actual selected artifact with current consumer
+behavior, including producer payload/schema and composition changes outside the
+extracted engine. On upgrades, preserve pending obligations, transactional enqueue,
+claim/ack/fencing and native recovery. Compatible native schema additions remain
+permitted; published SQL stays immutable. Validate the actual adapter and serving
+binding. For full or partial absorption remove only proven duplicate behavior,
+retain distinct effects sharing an event, and demonstrate durable success and
+unfinished work across retries and replacement. Catalogue existence, a handler
+return or an upstream merge alone cannot establish that proof.
+
+The public [adopter recipe](https://github.com/openlup/openlup/blob/main/docs/platform/adopter-kit/README.md#adopt-or-upgrade-a-package)
+explains source-local nominations and full/partial/retained/hold dispositions.
+Select that optional source guidance at a deliberate revision against your
+installed contract. This package guide conveys version-bound contract information,
+not tool permissions, an automatic control installation or external-write authority.
+The existing wiring and packed protocol examples remain narrow package evidence;
+a complete extension/absorption/retry witness belongs to the actual module adoption.

package/dist/config.d.ts

@@ -0,0 +1,4 @@
+import type { OutboxDispatchConfig } from "./contracts.js";
+export declare function readOutboxDispatchConfig(env: Record<string, string | undefined>, prefix?: string): OutboxDispatchConfig;
+/** @beta Scheduled configuration is stricter than the bare immediate worker. */
+export declare function validateScheduledConfig(config: OutboxDispatchConfig, hostLimitSeconds: number, timeouts: readonly number[]): void;

package/dist/config.js

@@ -0,0 +1,73 @@
+const CONFIG_BOUNDS = {
+    batchSize: { env: "COMMERCE_OUTBOX_DISPATCH_BATCH_SIZE", def: 25, min: 1, max: 100 },
+    maxAttempts: { env: "COMMERCE_OUTBOX_DISPATCH_MAX_ATTEMPTS", def: 8, min: 1, max: 20 },
+    visibilitySeconds: {
+        env: "COMMERCE_OUTBOX_DISPATCH_VISIBILITY_SECONDS",
+        def: 300,
+        min: 300,
+        max: 3600,
+    },
+    backoffBaseSeconds: { env: "COMMERCE_OUTBOX_DISPATCH_BACKOFF_BASE_SECONDS", def: 60, min: 5, max: 3600 },
+    backoffCapSeconds: { env: "COMMERCE_OUTBOX_DISPATCH_BACKOFF_CAP_SECONDS", def: 3600, min: 5, max: 86_400 },
+    snoozeSeconds: { env: "COMMERCE_OUTBOX_DISPATCH_SNOOZE_SECONDS", def: 300, min: 60, max: 3600 },
+    maxSnoozes: { env: "COMMERCE_OUTBOX_DISPATCH_MAX_SNOOZES", def: 48, min: 1, max: 1000 },
+    // Max keeps a >= 15s tail under the cron's hard kill: drain stop + in-flight
+    // handler + marks + queue stats + finishJobRun must all fit after the budget.
+    softBudgetMs: {
+        env: "COMMERCE_OUTBOX_DISPATCH_SOFT_BUDGET_MS",
+        def: 40_000,
+        min: 5000,
+        max: 60 * 1000 - 15_000,
+    },
+};
+function readBoundedInt(env, bound) {
+    const raw = env[bound.env];
+    if (raw === undefined || raw.trim() === "")
+        return bound.def;
+    const parsed = Number.parseInt(raw, 10);
+    if (!Number.isFinite(parsed)) {
+        console.warn(`[outbox-dispatch] invalid ${bound.env}=${raw}; using default ${bound.def}`);
+        return bound.def;
+    }
+    const clamped = Math.min(Math.max(parsed, bound.min), bound.max);
+    if (clamped !== parsed) {
+        console.warn(`[outbox-dispatch] ${bound.env}=${parsed} clamped to ${clamped}`);
+    }
+    return clamped;
+}
+export function readOutboxDispatchConfig(env, prefix = "COMMERCE_OUTBOX_DISPATCH_") {
+    const bounds = Object.fromEntries(Object.entries(CONFIG_BOUNDS).map(([key, bound]) => [key, { ...bound, env: prefix + bound.env.slice("COMMERCE_OUTBOX_DISPATCH_".length) }]));
+    const config = {
+        batchSize: readBoundedInt(env, bounds.batchSize),
+        maxAttempts: readBoundedInt(env, bounds.maxAttempts),
+        visibilitySeconds: readBoundedInt(env, bounds.visibilitySeconds),
+        backoffBaseSeconds: readBoundedInt(env, bounds.backoffBaseSeconds),
+        backoffCapSeconds: readBoundedInt(env, bounds.backoffCapSeconds),
+        snoozeSeconds: readBoundedInt(env, bounds.snoozeSeconds),
+        maxSnoozes: readBoundedInt(env, bounds.maxSnoozes),
+        softBudgetMs: readBoundedInt(env, bounds.softBudgetMs),
+    };
+    if (config.backoffCapSeconds < config.backoffBaseSeconds) {
+        console.warn(`[outbox-dispatch] backoff cap ${config.backoffCapSeconds}s below base ${config.backoffBaseSeconds}s; raising cap to base`);
+        config.backoffCapSeconds = config.backoffBaseSeconds;
+    }
+    return config;
+}
+/** @beta Scheduled configuration is stricter than the bare immediate worker. */
+export function validateScheduledConfig(config, hostLimitSeconds, timeouts) {
+    const fail = (key, fix) => { throw new Error(`@openlup/outbox: ${key}: ${fix}`); };
+    if (!Number.isFinite(hostLimitSeconds) || hostLimitSeconds < 20 || hostLimitSeconds > 720)
+        fail("hostLimitSeconds", "use 20–720 seconds");
+    for (const [key, bound] of Object.entries(CONFIG_BOUNDS)) {
+        const value = config[key];
+        const min = key === "visibilitySeconds" ? Math.min(5 * hostLimitSeconds, 3600) : bound.min;
+        const max = key === "softBudgetMs" ? hostLimitSeconds * 1000 - 15000 : bound.max;
+        if (!Number.isInteger(value) || value < min || value > max)
+            fail(key, `use an integer in ${min}–${max}`);
+    }
+    if (config.backoffCapSeconds < config.backoffBaseSeconds)
+        fail("backoffCapSeconds", "keep cap at least the base delay");
+    for (const timeout of timeouts)
+        if (!Number.isFinite(timeout) || timeout <= 0 || timeout + 2000 > config.softBudgetMs)
+            fail("handler.timeoutMs", "fit the effective timeout plus 2000 ms mark margin in the budget");
+}

package/dist/contracts.d.ts

@@ -0,0 +1,88 @@
+import type { OutboxHandler as KernelHandler, OutboxEventRow } from "@openlup/core/outbox";
+export type { OutboxEventRow, OutboxHandlerOutcome, OutboxHandlerExecutionContext, OutboxHandlerDescriptor } from "@openlup/core/outbox";
+/** @beta The worker creates the host's standard AbortController. */
+export type OutboxHandler = KernelHandler<AbortSignal>;
+export type OutboxHandlerRegistry = ReadonlyMap<string, OutboxHandler>;
+export type OutboxMarkFailedStatus = "failed" | "discarded" | "snoozed" | "missed";
+export interface OutboxStore {
+    /** Read-only preflight used to admit a terminal handler when active providers are unavailable. */
+    hasPendingEventType?(eventType: string): Promise<boolean>;
+    claimBatch(input: {
+        eventTypes: readonly string[];
+        knownEventTypes?: readonly string[];
+        batchSize: number;
+        visibilitySeconds: number;
+        maxAttempts: number;
+    }): Promise<OutboxEventRow[]>;
+    markProcessed(input: {
+        eventId: string;
+        claimToken: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<{
+        applied: boolean;
+    }>;
+    markFailed(input: {
+        eventId: string;
+        claimToken: string;
+        error: string;
+        outcome: "retry" | "discard" | "snooze";
+        baseDelaySeconds: number;
+        maxDelaySeconds: number;
+        maxAttempts: number;
+        snoozeSeconds: number;
+    }): Promise<{
+        status: OutboxMarkFailedStatus;
+    }>;
+    releaseUnprocessed(items: ReadonlyArray<{
+        eventId: string;
+        claimToken: string;
+    }>, delaySeconds: number): Promise<number>;
+}
+/** Managed-only best-effort queue observation, separate from core claim/ack policy. */
+export interface OutboxQueueDiagnostics {
+    queueStats(): Promise<Record<string, unknown>>;
+}
+export interface Clock {
+    now(): number;
+}
+export interface OutboxDispatchRunResult {
+    ok: boolean;
+    checked: number;
+    updated: number;
+    failures: number;
+    skipped: boolean;
+    reason?: string;
+    claimed: number;
+    processed: number;
+    retried: number;
+    snoozed: number;
+    discarded: number;
+    released: number;
+    duplicateInRun: number;
+    leaseLost: number;
+    batches: number;
+    runMs: number;
+    byEventType: Record<string, Record<string, number>>;
+    discardedEventIds: string[];
+    queue?: Record<string, unknown>;
+}
+export interface OutboxDispatchConfig {
+    batchSize: number;
+    maxAttempts: number;
+    visibilitySeconds: number;
+    backoffBaseSeconds: number;
+    backoffCapSeconds: number;
+    snoozeSeconds: number;
+    maxSnoozes: number;
+    softBudgetMs: number;
+}
+/** @beta Logging defaults retain the dispatch console transcript. */
+export interface OutboxLogger {
+    warn(...args: unknown[]): void;
+    error(...args: unknown[]): void;
+}
+/** @beta Synchronous bounded observations; no payloads or credentials. */
+export interface OutboxObservation {
+    event: "claimed" | "finished";
+    count: number;
+}

package/dist/contracts.js

@@ -0,0 +1 @@
+export {};

package/dist/enqueue.d.ts

@@ -0,0 +1,15 @@
+/** @beta Caller executes this inside the same transaction as its domain write. */
+export interface EnqueueEvent {
+    aggregateType: string;
+    aggregateId: string;
+    eventType: string;
+    idempotencyKey: string;
+    payload: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    availableAt?: string;
+}
+/** @beta Duplicate enqueue keeps the durable event identity; no independent commit. */
+export declare function buildOutboxEnqueue(event: EnqueueEvent): {
+    text: string;
+    values: readonly unknown[];
+};

package/dist/enqueue.js

@@ -0,0 +1,9 @@
+/** @beta Duplicate enqueue keeps the durable event identity; no independent commit. */
+export function buildOutboxEnqueue(event) {
+    return {
+        text: `insert into public.outbox_events (aggregate_type, aggregate_id, event_type, idempotency_key, payload, metadata, available_at)
+values ($1, $2::uuid, $3, $4, $5::jsonb, $6::jsonb, coalesce($7::timestamptz, now()))
+on conflict (event_type, idempotency_key) do nothing returning id::text`,
+        values: [event.aggregateType, event.aggregateId, event.eventType, event.idempotencyKey, JSON.stringify(event.payload), JSON.stringify(event.metadata ?? {}), event.availableAt ?? null],
+    };
+}