@satorio/machinery 0.2.1

package/dictionary/vitest.json

@@ -0,0 +1,356 @@
+{
+  "package": "@satorio/machinery",
+  "version": "0.2.1",
+  "mechanism": {
+    "mechanism": "vitest",
+    "import": "@satorio/machinery/vitest",
+    "kind": "test kit",
+    "page": "mechanisms/vitest",
+    "what": "Public entry to the vitest mechanism: live stands, port contracts, and the guards that read the test runtime.",
+    "whatUk": "Публічний вхід до механізму vitest: живі стенди, контракти портів і три перевірки збірки (guard), які тримають рантайм цих тестів.",
+    "rows": [
+      {
+        "name": "AwsStand",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "The address and the region of the live AWS stand a suite talks to.",
+        "captionUk": "Адреса і регіон живого стенда AWS, з яким говорить сьют.",
+        "anchor": "vitest-AwsStand-value"
+      },
+      {
+        "name": "FILES_THAT_FORK_A_FIBER_AND_ADJUST_TEST_CLOCK",
+        "kind": "value",
+        "signature": "readonly string[]",
+        "fallback": "",
+        "caption": "The test files that need their own fresh module state, because they fork a fiber and move the clock.",
+        "captionUk": "Тестові файли, яким потрібен власний свіжий стан модулів, бо вони форкають файбер і рухають годинник.",
+        "anchor": "vitest-FILES-THAT-FORK-A-FIBER-AND-ADJUST-TEST-CLOCK-value"
+      },
+      {
+        "name": "LOCALSTACK_REGION",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "The one region every client and resource in a suite agrees on.",
+        "captionUk": "Єдиний регіон, про який домовляються кожен клієнт і кожен ресурс у сьюті.",
+        "anchor": "vitest-LOCALSTACK-REGION-value"
+      },
+      {
+        "name": "PortContractTester",
+        "kind": "value",
+        "signature": "type",
+        "fallback": "",
+        "caption": "The subset of vitest test methods a port contract needs from its tester.",
+        "captionUk": "Той підмножинний набір тестових методів vitest, якого контракт порту потребує від свого тестувальника.",
+        "anchor": "vitest-PortContractTester-value"
+      },
+      {
+        "name": "POSTGRES_IMAGE",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "The Postgres image every live-stand test starts through testcontainers.",
+        "captionUk": "Образ Postgres, який кожен тест на живому стенді піднімає через testcontainers.",
+        "anchor": "vitest-POSTGRES-IMAGE-value"
+      },
+      {
+        "name": "ReaderPortUnderTest",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "What a reader port's own test hands the contract.",
+        "captionUk": "Що власний тест порту-читача подає контрактові.",
+        "anchor": "vitest-ReaderPortUnderTest-value"
+      },
+      {
+        "name": "RecordedStubRequest",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "One request the stub server received, as a test reads it back: the method and the path.",
+        "captionUk": "Один запит, який отримав стаб-сервер (stub server), у тому вигляді, в якому тест читає його назад: метод і шлях.",
+        "anchor": "vitest-RecordedStubRequest-value"
+      },
+      {
+        "name": "StubResponse",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "One answer the stub server gives: the status, the body and content type where there is one, and the delay before it answers.",
+        "captionUk": "Одна відповідь стаб-сервера: статус, тіло і тип вмісту, коли вони є, і затримка перед відповіддю.",
+        "anchor": "vitest-StubResponse-value"
+      },
+      {
+        "name": "StubRoute",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "One route the stub server serves: the method, the path, and the answers it gives in turn.",
+        "captionUk": "Один маршрут, який обслуговує стаб-сервер: метод, шлях і відповіді, які він дає по черзі.",
+        "anchor": "vitest-StubRoute-value"
+      },
+      {
+        "name": "blobStoreContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, layer: Layer.Layer<BlobStore>, unavailable?: Layer.Layer<BlobStore>) => void",
+        "fallback": "",
+        "caption": "One contract, every blob store.",
+        "captionUk": "Один контракт, кожне сховище об'єктів.",
+        "anchor": "vitest-blobStoreContract-procedure"
+      },
+      {
+        "name": "documentNumberCounterContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, layer: Layer.Layer<DocumentNumberCounter>, unavailable?: Layer.Layer<DocumentNumberCounter>) => void",
+        "fallback": "",
+        "caption": "One contract, every counter implementation.",
+        "captionUk": "Один контракт, кожна реалізація лічильника.",
+        "anchor": "vitest-documentNumberCounterContract-procedure"
+      },
+      {
+        "name": "eventPublisherContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, publisher: PublisherUnderTest, unavailable?: Layer.Layer<EventPublisher>) => void",
+        "fallback": "",
+        "caption": "One contract, every event publisher.",
+        "captionUk": "Один контракт, кожен публікатор подій.",
+        "anchor": "vitest-eventPublisherContract-procedure"
+      },
+      {
+        "name": "externalHttpClientContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, service: ExternalServiceUnderTest, unavailable?: Layer.Layer<ExternalHttpClient>) => void",
+        "fallback": "",
+        "caption": "One contract, every external HTTP client.",
+        "captionUk": "Один контракт, кожен зовнішній HTTP-клієнт.",
+        "anchor": "vitest-externalHttpClientContract-procedure"
+      },
+      {
+        "name": "integrationEventOutboxContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, layer: Layer.Layer<IntegrationEventOutbox>, unavailable?: Layer.Layer<IntegrationEventOutbox>) => void",
+        "fallback": "",
+        "caption": "One contract, every integration event outbox.",
+        "captionUk": "Один контракт, кожен буфер трансмітера.",
+        "anchor": "vitest-integrationEventOutboxContract-procedure"
+      },
+      {
+        "name": "onLocalstack",
+        "kind": "procedure",
+        "signature": "(options: LocalstackSuiteOptions, subject: string, checks: SuiteChecks) => void",
+        "fallback": "",
+        "caption": "Runs a suite against a real AWS stand (localstack) for `subject`.",
+        "captionUk": "Крутить сьют проти справжнього стенда AWS (localstack) для `subject`.",
+        "anchor": "vitest-onLocalstack-procedure"
+      },
+      {
+        "name": "onPostgres",
+        "kind": "procedure",
+        "signature": "(options: PostgresSuiteOptions, subject: string, checks: SuiteChecks) => void",
+        "fallback": "",
+        "caption": "Runs a suite against a real Postgres — the container, or an externally configured database when `PGHOST` is set.",
+        "captionUk": "Крутить сьют проти справжнього Postgres — контейнера або зовні налаштованої бази, коли поставлено `PGHOST`.",
+        "anchor": "vitest-onPostgres-procedure"
+      },
+      {
+        "name": "onPostgresContainer",
+        "kind": "procedure",
+        "signature": "(options: PostgresSuiteOptions, subject: string, checks: SuiteChecks) => void",
+        "fallback": "",
+        "caption": "Runs a suite against a container-only Postgres, ignoring any `PG*` environment variables.",
+        "captionUk": "Крутить сьют проти Postgres лише в контейнері, ігноруючи будь-які змінні оточення `PG*`.",
+        "anchor": "vitest-onPostgresContainer-procedure"
+      },
+      {
+        "name": "outboxEvent",
+        "kind": "procedure",
+        "signature": "(messageId: string, payload: { readonly [key: string]: unknown }) => OutboxMessage",
+        "fallback": "",
+        "caption": "One message, built the way an outbox hands it over.",
+        "captionUk": "Одне повідомлення, збудоване так, як його віддає буфер трансмітера.",
+        "anchor": "vitest-outboxEvent-procedure"
+      },
+      {
+        "name": "outboxMessage",
+        "kind": "procedure",
+        "signature": "(messageId: string) => OutboxMessage",
+        "fallback": "",
+        "caption": "One outbox message a contract enqueues and reads back, so every implementation is asked the same question.",
+        "captionUk": "Одне повідомлення буфера, яке контракт ставить у чергу і читає назад, тож кожній реалізації ставлять те саме питання.",
+        "anchor": "vitest-outboxMessage-procedure"
+      },
+      {
+        "name": "processedEventRegistryContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, layer: Layer.Layer<ProcessedEventRegistry>, unavailable?: Layer.Layer<ProcessedEventRegistry>) => void",
+        "fallback": "",
+        "caption": "One contract, every processed event registry.",
+        "captionUk": "Один контракт, кожен реєстр відпрацьованих подій.",
+        "anchor": "vitest-processedEventRegistryContract-procedure"
+      },
+      {
+        "name": "queueMessageProducerContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, producer: ProducerUnderTest, unavailable?: Layer.Layer<QueueMessageProducer>) => void",
+        "fallback": "",
+        "caption": "One contract, every message producer.",
+        "captionUk": "Один контракт, кожен відправник повідомлень.",
+        "anchor": "vitest-queueMessageProducerContract-procedure"
+      },
+      {
+        "name": "queueMessageSourceContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, queue: QueueUnderTest, unavailable?: Layer.Layer<QueueMessageSource>) => void",
+        "fallback": "",
+        "caption": "One contract, every message source.",
+        "captionUk": "Один контракт, кожне джерело повідомлень.",
+        "anchor": "vitest-queueMessageSourceContract-procedure"
+      },
+      {
+        "name": "readerPortContract",
+        "kind": "procedure",
+        "signature": "<Subject, Value>(it: PortContractTester, port: ReaderPortUnderTest<Subject, Value>) => void",
+        "fallback": "",
+        "caption": "One contract for a port that only reads.",
+        "captionUk": "Один контракт для порту, який лише читає.",
+        "anchor": "vitest-readerPortContract-procedure"
+      },
+      {
+        "name": "readinessProbeContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, layer: Layer.Layer<ReadinessProbe>, unavailable?: Layer.Layer<ReadinessProbe>) => void",
+        "fallback": "",
+        "caption": "One contract, every readiness probe.",
+        "captionUk": "Один контракт, кожна проба готовності.",
+        "anchor": "vitest-readinessProbeContract-procedure"
+      },
+      {
+        "name": "repoCommittableFiles",
+        "kind": "procedure",
+        "signature": "(root: string = repoRoot()) => readonly string[]",
+        "fallback": "",
+        "caption": "Every file git would commit as it stands under `root`.",
+        "captionUk": "Кожен файл, який git закомітив би таким, яким той стоїть під `root`.",
+        "anchor": "vitest-repoCommittableFiles-procedure"
+      },
+      {
+        "name": "repoFilesUnder",
+        "kind": "procedure",
+        "signature": "(root: string, directories: readonly string[], extension: string) => readonly string[]",
+        "fallback": "",
+        "caption": "Lists files with `extension` recursively under `directories`, relative to `root`.",
+        "captionUk": "Перелічує файли з розширенням `extension` рекурсивно під `directories`, відносно `root`.",
+        "anchor": "vitest-repoFilesUnder-procedure"
+      },
+      {
+        "name": "repoRoot",
+        "kind": "procedure",
+        "signature": "(cwd: string = process.cwd()) => string",
+        "fallback": "",
+        "caption": "Root of the git repository that contains `cwd` (`process.cwd()` by default).",
+        "captionUk": "Корінь git-репозиторію, який містить `cwd` (за замовчуванням `process.cwd()`).",
+        "anchor": "vitest-repoRoot-procedure"
+      },
+      {
+        "name": "scopedStubServer",
+        "kind": "procedure",
+        "signature": "(routes: readonly StubRoute[]) => Effect.Effect<StubServerShape, never, Scope.Scope>",
+        "fallback": "",
+        "caption": "Runs the stub server for the lifetime of a scope.",
+        "captionUk": "Крутить стаб-сервер стільки, скільки живе скоуп.",
+        "anchor": "vitest-scopedStubServer-procedure"
+      },
+      {
+        "name": "settingsContract",
+        "kind": "procedure",
+        "signature": "<A>(mechanism: string, environment: readonly EnvironmentEntry[], settings: Config.Config<A>, variablePrefix = '') => void",
+        "fallback": "",
+        "caption": "One contract, every adapter that names variables.",
+        "captionUk": "Один контракт, кожен адаптер, який називає змінні.",
+        "anchor": "vitest-settingsContract-procedure"
+      },
+      {
+        "name": "storedBlob",
+        "kind": "procedure",
+        "signature": "(text: string) => StoredBlob",
+        "fallback": "",
+        "caption": "One blob a contract stores and reads back, so every implementation is asked the same question.",
+        "captionUk": "Один об'єкт, який контракт зберігає і читає назад, тож кожній реалізації ставлять те саме питання.",
+        "anchor": "vitest-storedBlob-procedure"
+      },
+      {
+        "name": "transactionBoundaryContract",
+        "kind": "procedure",
+        "signature": "(it: PortContractTester, implementationName: string, layer: Layer.Layer<TransactionBoundary>, unavailable?: Layer.Layer<TransactionBoundary>) => void",
+        "fallback": "",
+        "caption": "One contract, every transaction boundary.",
+        "captionUk": "Один контракт, кожна межа транзакції.",
+        "anchor": "vitest-transactionBoundaryContract-procedure"
+      },
+      {
+        "name": "truncateTables",
+        "kind": "procedure",
+        "signature": "(tableNames: readonly string[]) => Effect.Effect<void, SqlError, SqlClient.SqlClient>",
+        "fallback": "",
+        "caption": "Empties the named tables in one query, for a test that needs a familiar initial state.",
+        "captionUk": "Спорожнює названі таблиці одним запитом — для тесту, якому потрібен знайомий початковий стан.",
+        "anchor": "vitest-truncateTables-procedure"
+      },
+      {
+        "name": "postgresInContainerLive",
+        "kind": "adapter",
+        "signature": "(options: PostgresSuiteOptions) => Layer.Layer<never>",
+        "fallback": "",
+        "caption": "Builds the Postgres layer for a suite from a fresh container only, ignoring any `PG*` environment variables.",
+        "captionUk": "Будує шар Postgres для сьюта лише зі свіжого контейнера, ігноруючи будь-які змінні оточення `PG*`.",
+        "anchor": "vitest-postgresInContainerLive-adapter"
+      },
+      {
+        "name": "PostgresPortsUnderTestLive",
+        "kind": "adapter",
+        "signature": "Layer.Layer<PostgresPorts | PgClient.PgClient | SqlClient.SqlClient>",
+        "fallback": "",
+        "caption": "The Postgres mechanism's own ports, on the suite's database.",
+        "captionUk": "Власні порти механізму postgres на базі цього сьюта.",
+        "anchor": "vitest-PostgresPortsUnderTestLive-adapter"
+      },
+      {
+        "name": "postgresUnderTestLive",
+        "kind": "adapter",
+        "signature": "(options: PostgresSuiteOptions) => Layer.Layer<never>",
+        "fallback": "",
+        "caption": "The Postgres layer a suite runs on: the configured database when the environment names one, a fresh container when it does not, migrated either way.",
+        "captionUk": "Шар Postgres, на якому біжить сьют: налаштована база, коли оточення її називає, свіжий контейнер, коли ні, і мігровані обидва.",
+        "anchor": "vitest-postgresUnderTestLive-adapter"
+      },
+      {
+        "name": "oneEffectInstanceGuard",
+        "kind": "guard",
+        "signature": "(options: SingleEffectInstanceOptions = {}) => void",
+        "fallback": "",
+        "caption": "Registers a vitest suite that fails when a tree holds more than one copy of Effect.",
+        "captionUk": "Реєструє сьют vitest, який валить прогін, коли дерево тримає більш ніж одну копію Effect.",
+        "anchor": "vitest-oneEffectInstanceGuard-guard"
+      },
+      {
+        "name": "oneFastCheckInstanceGuard",
+        "kind": "guard",
+        "signature": "() => void",
+        "fallback": "",
+        "caption": "Registers a vitest suite that fails when the property library resolves to two module instances.",
+        "captionUk": "Реєструє сьют vitest, який валить прогін, коли бібліотека властивостей резолвиться у два примірники модуля.",
+        "anchor": "vitest-oneFastCheckInstanceGuard-guard"
+      },
+      {
+        "name": "testclockForkIsolationGuard",
+        "kind": "guard",
+        "signature": "(knownIsolatedFiles: readonly string[], options: TestclockForkIsolationOptions) => void",
+        "fallback": "",
+        "caption": "Registers a vitest suite that fails when a test moves the clock in a forked fiber outside its own list.",
+        "captionUk": "Реєструє сьют vitest, який валить прогін, коли тест рухає годинник у форкнутому файбері поза власним списком.",
+        "anchor": "vitest-testclockForkIsolationGuard-guard"
+      }
+    ]
+  }
+}

package/dictionary/vitest.toon

@@ -0,0 +1,48 @@
+package: @satorio/machinery
+version: 0.2.1
+mechanism:
+  mechanism: vitest
+  import: @satorio/machinery/vitest
+  kind: test kit
+  page: mechanisms/vitest
+  what: "Public entry to the vitest mechanism: live stands, port contracts, and the guards that read the test runtime."
+  whatUk: "Публічний вхід до механізму vitest: живі стенди, контракти портів і три перевірки збірки (guard), які тримають рантайм цих тестів."
+  rows[38]{name,kind,signature,fallback,caption,captionUk,anchor}:
+    AwsStand,value,interface,"",The address and the region of the live AWS stand a suite talks to.,"Адреса і регіон живого стенда AWS, з яким говорить сьют.",vitest-AwsStand-value
+    FILES_THAT_FORK_A_FIBER_AND_ADJUST_TEST_CLOCK,value,"readonly string[]","","The test files that need their own fresh module state, because they fork a fiber and move the clock.","Тестові файли, яким потрібен власний свіжий стан модулів, бо вони форкають файбер і рухають годинник.",vitest-FILES-THAT-FORK-A-FIBER-AND-ADJUST-TEST-CLOCK-value
+    LOCALSTACK_REGION,value,const,"",The one region every client and resource in a suite agrees on.,"Єдиний регіон, про який домовляються кожен клієнт і кожен ресурс у сьюті.",vitest-LOCALSTACK-REGION-value
+    PortContractTester,value,type,"",The subset of vitest test methods a port contract needs from its tester.,"Той підмножинний набір тестових методів vitest, якого контракт порту потребує від свого тестувальника.",vitest-PortContractTester-value
+    POSTGRES_IMAGE,value,const,"",The Postgres image every live-stand test starts through testcontainers.,"Образ Postgres, який кожен тест на живому стенді піднімає через testcontainers.",vitest-POSTGRES-IMAGE-value
+    ReaderPortUnderTest,value,interface,"",What a reader port's own test hands the contract.,Що власний тест порту-читача подає контрактові.,vitest-ReaderPortUnderTest-value
+    RecordedStubRequest,value,interface,"","One request the stub server received, as a test reads it back: the method and the path.","Один запит, який отримав стаб-сервер (stub server), у тому вигляді, в якому тест читає його назад: метод і шлях.",vitest-RecordedStubRequest-value
+    StubResponse,value,interface,"","One answer the stub server gives: the status, the body and content type where there is one, and the delay before it answers.","Одна відповідь стаб-сервера: статус, тіло і тип вмісту, коли вони є, і затримка перед відповіддю.",vitest-StubResponse-value
+    StubRoute,value,interface,"","One route the stub server serves: the method, the path, and the answers it gives in turn.","Один маршрут, який обслуговує стаб-сервер: метод, шлях і відповіді, які він дає по черзі.",vitest-StubRoute-value
+    blobStoreContract,procedure,"(it: PortContractTester, implementationName: string, layer: Layer.Layer<BlobStore>, unavailable?: Layer.Layer<BlobStore>) => void","","One contract, every blob store.","Один контракт, кожне сховище об'єктів.",vitest-blobStoreContract-procedure
+    documentNumberCounterContract,procedure,"(it: PortContractTester, implementationName: string, layer: Layer.Layer<DocumentNumberCounter>, unavailable?: Layer.Layer<DocumentNumberCounter>) => void","","One contract, every counter implementation.","Один контракт, кожна реалізація лічильника.",vitest-documentNumberCounterContract-procedure
+    eventPublisherContract,procedure,"(it: PortContractTester, implementationName: string, publisher: PublisherUnderTest, unavailable?: Layer.Layer<EventPublisher>) => void","","One contract, every event publisher.","Один контракт, кожен публікатор подій.",vitest-eventPublisherContract-procedure
+    externalHttpClientContract,procedure,"(it: PortContractTester, implementationName: string, service: ExternalServiceUnderTest, unavailable?: Layer.Layer<ExternalHttpClient>) => void","","One contract, every external HTTP client.","Один контракт, кожен зовнішній HTTP-клієнт.",vitest-externalHttpClientContract-procedure
+    integrationEventOutboxContract,procedure,"(it: PortContractTester, implementationName: string, layer: Layer.Layer<IntegrationEventOutbox>, unavailable?: Layer.Layer<IntegrationEventOutbox>) => void","","One contract, every integration event outbox.","Один контракт, кожен буфер трансмітера.",vitest-integrationEventOutboxContract-procedure
+    onLocalstack,procedure,"(options: LocalstackSuiteOptions, subject: string, checks: SuiteChecks) => void","",Runs a suite against a real AWS stand (localstack) for `subject`.,Крутить сьют проти справжнього стенда AWS (localstack) для `subject`.,vitest-onLocalstack-procedure
+    onPostgres,procedure,"(options: PostgresSuiteOptions, subject: string, checks: SuiteChecks) => void","","Runs a suite against a real Postgres — the container, or an externally configured database when `PGHOST` is set.","Крутить сьют проти справжнього Postgres — контейнера або зовні налаштованої бази, коли поставлено `PGHOST`.",vitest-onPostgres-procedure
+    onPostgresContainer,procedure,"(options: PostgresSuiteOptions, subject: string, checks: SuiteChecks) => void","","Runs a suite against a container-only Postgres, ignoring any `PG*` environment variables.","Крутить сьют проти Postgres лише в контейнері, ігноруючи будь-які змінні оточення `PG*`.",vitest-onPostgresContainer-procedure
+    outboxEvent,procedure,"(messageId: string, payload: { readonly [key: string]: unknown }) => OutboxMessage","","One message, built the way an outbox hands it over.","Одне повідомлення, збудоване так, як його віддає буфер трансмітера.",vitest-outboxEvent-procedure
+    outboxMessage,procedure,"(messageId: string) => OutboxMessage","","One outbox message a contract enqueues and reads back, so every implementation is asked the same question.","Одне повідомлення буфера, яке контракт ставить у чергу і читає назад, тож кожній реалізації ставлять те саме питання.",vitest-outboxMessage-procedure
+    processedEventRegistryContract,procedure,"(it: PortContractTester, implementationName: string, layer: Layer.Layer<ProcessedEventRegistry>, unavailable?: Layer.Layer<ProcessedEventRegistry>) => void","","One contract, every processed event registry.","Один контракт, кожен реєстр відпрацьованих подій.",vitest-processedEventRegistryContract-procedure
+    queueMessageProducerContract,procedure,"(it: PortContractTester, implementationName: string, producer: ProducerUnderTest, unavailable?: Layer.Layer<QueueMessageProducer>) => void","","One contract, every message producer.","Один контракт, кожен відправник повідомлень.",vitest-queueMessageProducerContract-procedure
+    queueMessageSourceContract,procedure,"(it: PortContractTester, implementationName: string, queue: QueueUnderTest, unavailable?: Layer.Layer<QueueMessageSource>) => void","","One contract, every message source.","Один контракт, кожне джерело повідомлень.",vitest-queueMessageSourceContract-procedure
+    readerPortContract,procedure,"<Subject, Value>(it: PortContractTester, port: ReaderPortUnderTest<Subject, Value>) => void","",One contract for a port that only reads.,"Один контракт для порту, який лише читає.",vitest-readerPortContract-procedure
+    readinessProbeContract,procedure,"(it: PortContractTester, implementationName: string, layer: Layer.Layer<ReadinessProbe>, unavailable?: Layer.Layer<ReadinessProbe>) => void","","One contract, every readiness probe.","Один контракт, кожна проба готовності.",vitest-readinessProbeContract-procedure
+    repoCommittableFiles,procedure,"(root: string = repoRoot()) => readonly string[]","",Every file git would commit as it stands under `root`.,"Кожен файл, який git закомітив би таким, яким той стоїть під `root`.",vitest-repoCommittableFiles-procedure
+    repoFilesUnder,procedure,"(root: string, directories: readonly string[], extension: string) => readonly string[]","","Lists files with `extension` recursively under `directories`, relative to `root`.","Перелічує файли з розширенням `extension` рекурсивно під `directories`, відносно `root`.",vitest-repoFilesUnder-procedure
+    repoRoot,procedure,"(cwd: string = process.cwd()) => string","",Root of the git repository that contains `cwd` (`process.cwd()` by default).,"Корінь git-репозиторію, який містить `cwd` (за замовчуванням `process.cwd()`).",vitest-repoRoot-procedure
+    scopedStubServer,procedure,"(routes: readonly StubRoute[]) => Effect.Effect<StubServerShape, never, Scope.Scope>","",Runs the stub server for the lifetime of a scope.,"Крутить стаб-сервер стільки, скільки живе скоуп.",vitest-scopedStubServer-procedure
+    settingsContract,procedure,"<A>(mechanism: string, environment: readonly EnvironmentEntry[], settings: Config.Config<A>, variablePrefix = '') => void","","One contract, every adapter that names variables.","Один контракт, кожен адаптер, який називає змінні.",vitest-settingsContract-procedure
+    storedBlob,procedure,"(text: string) => StoredBlob","","One blob a contract stores and reads back, so every implementation is asked the same question.","Один об'єкт, який контракт зберігає і читає назад, тож кожній реалізації ставлять те саме питання.",vitest-storedBlob-procedure
+    transactionBoundaryContract,procedure,"(it: PortContractTester, implementationName: string, layer: Layer.Layer<TransactionBoundary>, unavailable?: Layer.Layer<TransactionBoundary>) => void","","One contract, every transaction boundary.","Один контракт, кожна межа транзакції.",vitest-transactionBoundaryContract-procedure
+    truncateTables,procedure,"(tableNames: readonly string[]) => Effect.Effect<void, SqlError, SqlClient.SqlClient>","","Empties the named tables in one query, for a test that needs a familiar initial state.","Спорожнює названі таблиці одним запитом — для тесту, якому потрібен знайомий початковий стан.",vitest-truncateTables-procedure
+    postgresInContainerLive,adapter,"(options: PostgresSuiteOptions) => Layer.Layer<never>","","Builds the Postgres layer for a suite from a fresh container only, ignoring any `PG*` environment variables.","Будує шар Postgres для сьюта лише зі свіжого контейнера, ігноруючи будь-які змінні оточення `PG*`.",vitest-postgresInContainerLive-adapter
+    PostgresPortsUnderTestLive,adapter,Layer.Layer<PostgresPorts | PgClient.PgClient | SqlClient.SqlClient>,"","The Postgres mechanism's own ports, on the suite's database.",Власні порти механізму postgres на базі цього сьюта.,vitest-PostgresPortsUnderTestLive-adapter
+    postgresUnderTestLive,adapter,"(options: PostgresSuiteOptions) => Layer.Layer<never>","","The Postgres layer a suite runs on: the configured database when the environment names one, a fresh container when it does not, migrated either way.","Шар Postgres, на якому біжить сьют: налаштована база, коли оточення її називає, свіжий контейнер, коли ні, і мігровані обидва.",vitest-postgresUnderTestLive-adapter
+    oneEffectInstanceGuard,guard,"(options: SingleEffectInstanceOptions = {}) => void","",Registers a vitest suite that fails when a tree holds more than one copy of Effect.,"Реєструє сьют vitest, який валить прогін, коли дерево тримає більш ніж одну копію Effect.",vitest-oneEffectInstanceGuard-guard
+    oneFastCheckInstanceGuard,guard,() => void,"",Registers a vitest suite that fails when the property library resolves to two module instances.,"Реєструє сьют vitest, який валить прогін, коли бібліотека властивостей резолвиться у два примірники модуля.",vitest-oneFastCheckInstanceGuard-guard
+    testclockForkIsolationGuard,guard,"(knownIsolatedFiles: readonly string[], options: TestclockForkIsolationOptions) => void","",Registers a vitest suite that fails when a test moves the clock in a forked fiber outside its own list.,"Реєструє сьют vitest, який валить прогін, коли тест рухає годинник у форкнутому файбері поза власним списком.",vitest-testclockForkIsolationGuard-guard

package/dictionary/workflow.json

@@ -0,0 +1,185 @@
+{
+  "package": "@satorio/machinery",
+  "version": "0.2.1",
+  "mechanism": {
+    "mechanism": "workflow",
+    "import": "@satorio/machinery/workflow",
+    "kind": "foundation",
+    "page": "mechanisms/workflow",
+    "what": "Public entry to the workflow mechanism: the combinators a use case composes its own beat from.",
+    "whatUk": "Публічний вхід до механізму workflow: комбінатори, з яких процедура складає власний такт.",
+    "rows": [
+      {
+        "name": "ClaimOnce",
+        "kind": "value",
+        "signature": "type",
+        "fallback": "",
+        "caption": "The exactly-once claim: shared ground for every use case that takes an event or command once.",
+        "captionUk": "Резервація рівно один раз: спільний ґрунт для кожної процедури, яка бере подію або команду один раз.",
+        "anchor": "workflow-ClaimOnce-value"
+      },
+      {
+        "name": "DEFAULT_PUBLISH_PENDING_EVENTS_SETTINGS",
+        "kind": "value",
+        "signature": "PublishPendingEventsSettings",
+        "fallback": "",
+        "caption": "The pace the relay keeps when a service names none of its own.",
+        "captionUk": "Темп, який тримає трансмітер вихідних подій, коли сервіс не називає власного.",
+        "anchor": "workflow-DEFAULT-PUBLISH-PENDING-EVENTS-SETTINGS-value"
+      },
+      {
+        "name": "OnClaimMatchers",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "The two branches `onClaim` takes: what to do when the event was already claimed, and what to do when this run claims it.",
+        "captionUk": "Дві гілки, які бере `onClaim`: що робити, коли подію вже зарезервовано, і що робити, коли її резервує цей прогін.",
+        "anchor": "workflow-OnClaimMatchers-value"
+      },
+      {
+        "name": "PublishPendingEventsSettings",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "How the relay paces itself: how many messages one beat takes, and how long it waits between beats.",
+        "captionUk": "Як трансмітер вихідних подій задає собі темп: скільки повідомлень бере один такт і скільки він чекає між тактами.",
+        "anchor": "workflow-PublishPendingEventsSettings-value"
+      },
+      {
+        "name": "UpcastStep",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "One lift, from the version it names to the next one up.",
+        "captionUk": "Один підйом, від названої версії до наступної вгору.",
+        "anchor": "workflow-UpcastStep-value"
+      },
+      {
+        "name": "VersionedEventDefinition",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "An event stored yesterday is read by today's code.",
+        "captionUk": "Подію, збережену вчора, читає сьогоднішній код.",
+        "anchor": "workflow-VersionedEventDefinition-value"
+      },
+      {
+        "name": "claimAsProcessedAt",
+        "kind": "procedure",
+        "signature": "(idempotencyKey: string, processedAt: DateTime.Utc) => ClaimOnce",
+        "fallback": "",
+        "caption": "Claims with a processedAt supplied by the caller, for a handler that has already read the clock and must store that exact moment.",
+        "captionUk": "Резервує з `processedAt`, поданим викликачем, — для обробника, який уже прочитав годинник і мусить зберегти саме ту мить.",
+        "anchor": "workflow-claimAsProcessedAt-procedure"
+      },
+      {
+        "name": "claimAsProcessedNow",
+        "kind": "procedure",
+        "signature": "(idempotencyKey: string) => ClaimOnce",
+        "fallback": "",
+        "caption": "Claims with the current time, for a caller that only needs the claim.",
+        "captionUk": "Резервує з поточним часом — для викликача, якому потрібна лише резервація.",
+        "anchor": "workflow-claimAsProcessedNow-procedure"
+      },
+      {
+        "name": "decodeStoredPayload",
+        "kind": "procedure",
+        "signature": "<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>, storedVersion: number, payload: unknown) => Effect.Effect<Schema.Schema.Type<S>, VersionedPayloadFailure | ParseResult.ParseError>",
+        "fallback": "",
+        "caption": "Lifts a stored payload to the current version and decodes it with the current schema.",
+        "captionUk": "Підіймає збережений payload до поточної версії і декодує його поточною схемою.",
+        "anchor": "workflow-decodeStoredPayload-procedure"
+      },
+      {
+        "name": "keepPublishingPendingEvents",
+        "kind": "procedure",
+        "signature": "(settings: PublishPendingEventsSettings = DEFAULT_PUBLISH_PENDING_EVENTS_SETTINGS) => Effect.Effect<never, never, IntegrationEventOutbox | EventPublisher>",
+        "fallback": "",
+        "caption": "Runs the outbox relay for as long as the service lives.",
+        "captionUk": "Крутить трансмітер вихідних подій стільки, скільки живе сервіс.",
+        "anchor": "workflow-keepPublishingPendingEvents-procedure"
+      },
+      {
+        "name": "onClaim",
+        "kind": "procedure",
+        "signature": "<A1, E1, R1, A2, E2, R2, EClaim, RClaim>(claim: Effect.Effect<ProcessedEventClaim, EClaim, RClaim>, matchers: OnClaimMatchers<A1, E1, R1, A2, E2, R2>) => Effect.Effect<A1 | A2, EClaim | E1 | E2, RClaim | R1 | R2>",
+        "fallback": "",
+        "caption": "Branches on the state of the exactly-once claim: AlreadyProcessed goes one way, ClaimAccepted the other.",
+        "captionUk": "Розгалужується на стані резервації: `AlreadyProcessed` іде одним шляхом, `ClaimAccepted` — іншим.",
+        "anchor": "workflow-onClaim-procedure"
+      },
+      {
+        "name": "publishOneBatch",
+        "kind": "procedure",
+        "signature": "(batchLimit: number) => Effect.Effect<number, PublishPendingEventsFailure, IntegrationEventOutbox | EventPublisher>",
+        "fallback": "",
+        "caption": "One outbox relay beat: take a batch of undelivered messages, hand it to the publisher, then mark it dispatched.",
+        "captionUk": "Один такт трансмітера вихідних подій: узяти пачку недоставлених повідомлень, віддати її публікаторові, тоді позначити її відправленою.",
+        "anchor": "workflow-publishOneBatch-procedure"
+      },
+      {
+        "name": "transactionally",
+        "kind": "procedure",
+        "signature": "<A, E, R>(work: Effect.Effect<A, E, R>)",
+        "fallback": "",
+        "caption": "Wraps work in a transaction boundary: pulls TransactionBoundary from context and runs the work through it.",
+        "captionUk": "Загортає роботу в межу транзакції: дістає `TransactionBoundary` з контексту і проганяє роботу крізь неї.",
+        "anchor": "workflow-transactionally-procedure"
+      },
+      {
+        "name": "upcastToCurrentVersion",
+        "kind": "procedure",
+        "signature": "<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>, storedVersion: number, payload: unknown) => Effect.Effect<unknown, VersionedPayloadFailure>",
+        "fallback": "",
+        "caption": "Lifts a stored payload from the version it was written at to the version this code reads, one step per version, in order.",
+        "captionUk": "Підіймає збережений payload від версії, якою його записали, до версії, яку читає цей код, по одному кроку на версію, по порядку.",
+        "anchor": "workflow-upcastToCurrentVersion-procedure"
+      },
+      {
+        "name": "MissingUpcastStepError",
+        "kind": "failure",
+        "signature": "Data.TaggedError<{ readonly eventType: string; readonly fromVersion: number; readonly currentVersion: number }>",
+        "fallback": "",
+        "caption": "One version between the stored payload and the current one has no upcast step, so the lift cannot finish.",
+        "captionUk": "Одна версія між збереженим payload і поточною не має кроку підйому, тож підйом не доходить до кінця.",
+        "anchor": "workflow-MissingUpcastStepError-failure"
+      },
+      {
+        "name": "PublishPendingEventsFailure",
+        "kind": "failure",
+        "signature": "type",
+        "fallback": "",
+        "caption": "What one beat of the relay can meet: the outbox did not answer, or the publisher did not.",
+        "captionUk": "Що може зустріти один такт трансмітера: буфер трансмітера не відповів або публікатор не відповів.",
+        "anchor": "workflow-PublishPendingEventsFailure-failure"
+      },
+      {
+        "name": "SchemaVersionFromTheFutureError",
+        "kind": "failure",
+        "signature": "Data.TaggedError<{ readonly eventType: string; readonly storedVersion: number; readonly currentVersion: number }>",
+        "fallback": "",
+        "caption": "The stored payload says it was written by a newer version of this code than the one reading it.",
+        "captionUk": "Збережений payload каже, що його записала новіша версія цього коду, ніж та, що його читає.",
+        "anchor": "workflow-SchemaVersionFromTheFutureError-failure"
+      },
+      {
+        "name": "UpcastStepFailedError",
+        "kind": "failure",
+        "signature": "Data.TaggedError<{ readonly eventType: string; readonly fromVersion: number; readonly cause: unknown }>",
+        "fallback": "",
+        "caption": "An upcast step threw while lifting the payload one version up.",
+        "captionUk": "Крок підйому кинув помилку, поки підіймав payload на версію вгору.",
+        "anchor": "workflow-UpcastStepFailedError-failure"
+      },
+      {
+        "name": "VersionedPayloadFailure",
+        "kind": "failure",
+        "signature": "type",
+        "fallback": "",
+        "caption": "Every way reading a stored payload can refuse.",
+        "captionUk": "Кожен спосіб, яким читання збереженого payload може відмовити.",
+        "anchor": "workflow-VersionedPayloadFailure-failure"
+      }
+    ]
+  }
+}