@satorio/machinery 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Satorio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# @satorio/machinery
+
+This package gives a backend service its machinery half, ready to import:
+events, transactions, queues, retry strategies, and public endpoints. You
+keep business intent in your own service. Every cross-mechanism import goes
+through a mechanism's public index, so the boundary between your rules and
+the machinery stays visible in the code.
+
+You reach for this package when you build a web service in Effect and
+TypeScript and would rather not write that machinery again.
+
+Install it from the registry:
+
+```bash
+bun add @satorio/machinery
+```
+
+See [Install a mechanism](https://docs.satorio.dev/machinery/getting-started/install-a-mechanism/)
+for the peer dependency each mechanism needs.
+
+## Mechanisms
+
+Each mechanism is one npm subpath export, with its own public entry — no deep
+import reaches inside a mechanism from outside it.
+
+| Mechanism | What it gives you |
+| --- | --- |
+| `core` | identifiers, closed sets, bigint serialization, the base domain error |
+| `time` | a calendar day a person reads and writes, a period with both bounds named, an instant on the world's clock, and the named zone that decides which day a moment falls on |
+| `money` | an exact amount of one currency over Dinero.js, a share of it in both written forms, an exchange rate, and one rounding policy every figure goes through |
+| `identifiers` | the ULID a machine mints for a record, and the numbers a person reads off a document: client codes, document numbers, a Damm check digit, and an ISO 11649 creditor reference |
+| `ports` | boundaries: transaction, the exactly-once claim, outbox, publisher, queue, object storage, readiness probe |
+| `workflow` | `transactionally`, `onClaim`, `claimAsProcessedNow`/`claimAsProcessedAt`, versioned payloads, the outbox relay |
+| `postgres` | client and pool, database failure translation, the transaction boundary, a migration runner with an advisory lock |
+| `queue` | envelope, decoder, a consumer with a closed set of message outcomes, the queue transports |
+| `graphql` | a Pothos builder with federation and two subgraphs, a resolver failure boundary, a Yoga server |
+| `http` | readiness probes mounted on the same port as GraphQL |
+| `integration` | an HTTP kit for external reference data: a client with timeout and retry (on 5xx and network errors, never on 4xx), Schema-based decoding, and a call log |
+| `publishing` | the event publishers |
+| `storage` | S3 object storage: put/get/exists/delete, with the bucket read from environment variables |
+| `testing` | in-memory ports, a controllable clock, the scenario player (for tests and a seeder), a view onto live database rows, and typed-failure parsing |
+| `vitest` | live-stand test suites — Postgres and an AWS stand (localstack) in containers — port contracts, a stub server for HTTP adapter contracts, and the three runtime guards (one `effect` instance, one `fast-check` instance, the TestClock+fork isolation list) as callable functions your own test files register; the guards that read a written canon ship as `@satorio/canon` |
+
+## Where do you read next
+
+- [Install a mechanism](https://docs.satorio.dev/machinery/getting-started/install-a-mechanism/)
+  — the peer dependency each mechanism needs, and your first import.
+- [Wire your first mechanism](https://docs.satorio.dev/machinery/getting-started/wire-your-first-mechanism/)
+  — one use case inside a real Postgres transaction.
+- [Your rules live in your service](https://docs.satorio.dev/machinery/concepts/machinery-and-your-service/)
+  — why the split holds, and what your service is allowed to import.
+- [Design notes](https://docs.satorio.dev/machinery/reference/design-notes/)
+  — why each mechanism has the shape it has.
+- [The prompt you hand your agent](https://docs.satorio.dev/machinery/for-agents/)
+  — the briefing to paste at the start of a session with a coding agent. It
+  opens on `bunx satorio-machinery surface money`, the dictionary the
+  installed package prints for itself.
+
+Every recipe and concept lives on the
+[documentation site](https://docs.satorio.dev/machinery/).
+
+## Acknowledgements
+
+The decisions behind this package live in [`.haft`](.haft/README.md) as
+architecture decision records, kept with
+[haft](https://github.com/m0n0x41d/haft), living decision documentation and a
+decision engine for building alongside AI. Our thanks to its authors.
+
+## License
+
+MIT — see [`LICENSE`](LICENSE), © 2026 Satorio.