@satorio/machinery 0.2.1

package/dictionary/reference/uk/api.mdx

@@ -0,0 +1,844 @@
+---
+title: Кожна назва, яку дає цей пакет
+description: >-
+  Кожна назва кожного механізму з її формою і одним реченням про те, що це і навіщо, складена з самого коду.
+sidebar:
+  order: 0
+tableOfContents:
+  minHeadingLevel: 2
+  maxHeadingLevel: 2
+mirrorOf: b4ed867b074ed0fe
+---
+
+Ви приблизно знаєте, що вам потрібно, і не знаєте, як воно зветься. Десь у цьому пакеті така назва є, а полювання на неї по вихідних файлах коштує більше, ніж зміна, заради якої ви прийшли. Ця сторінка — увесь список: кожна назва, яку дає кожний механізм, зібрана щоразу однаково, з одним реченням поруч про те, що це і навіщо. Назви і форми приходять із самого коду і лишаються англійською, бо код цього пакета англійський. Речення поруч ідуть українською. Шукайте за назвою, і ви зможете знайти потрібне за хвилину, а поруч побачите її форму та значення за замовчуванням.
+
+## Механізми
+
+| Механізм (mechanism) | Для чого він | Імпорт |
+| --- | --- | --- |
+| [core](#core) | Публічний вхід до механізму core: кілька частин, на які спирається кожен інший механізм і які самі не спираються ні на що. | `@satorio/machinery/core` |
+| [http](#http) | Публічний вхід до механізму http: проби готовності (ReadinessProbe), змонтовані на тому самому порту (port), що й GraphQL. | `@satorio/machinery/http` |
+| [money](#money) | Публічний вхід до механізму money, над dinero.js, спільною залежністю, яку ставить ваш сервіс: точні суми однієї валюти, частки, курси й округлення. | `@satorio/machinery/money` |
+| [ports](#ports) | Публічний вхід до механізму ports: кожна межа, яку може попросити процедура (use case), і відмова (refusal), яку піднімає кожна з них. | `@satorio/machinery/ports` |
+| [time](#time) | Публічний вхід до механізму time: день, який людина читає і пише, період (period) днів і мить на годиннику. | `@satorio/machinery/time` |
+| [identifiers](#identifiers) | Публічний вхід до механізму identifiers: ідентифікатор, який карбує машина, і номери, які людина читає з документа. | `@satorio/machinery/identifiers` |
+| [workflow](#workflow) | Публічний вхід до механізму workflow: комбінатори, з яких процедура складає власний такт. | `@satorio/machinery/workflow` |
+| [graphql](#graphql) | Публічний вхід до механізму graphql: один сервер, який відповідає на ваші операції і на проби готовності поруч із ними. | `@satorio/machinery/graphql` |
+| [integration](#integration) | Публічний вхід до механізму integration: один HTTP-клієнт до довідкових даних поза цим сервісом. | `@satorio/machinery/integration` |
+| [postgres](#postgres) | Публічний вхід до механізму postgres: кожен порт, який визначає ця машинерія (machinery), прив'язаний до справжньої бази. | `@satorio/machinery/postgres` |
+| [publishing](#publishing) | Публічний вхід до механізму publishing: публікатор (publisher) подій, прив'язаний до топіка або до одного рядка на stdout. | `@satorio/machinery/publishing` |
+| [queue](#queue) | Публічний вхід до механізму queue: конверт, у якому мандрує повідомлення, і робітник (consumer), який вирішує його долю. | `@satorio/machinery/queue` |
+| [storage](#storage) | Публічний вхід до механізму storage: цілі об'єкти, збережені під ключем і прочитані назад. | `@satorio/machinery/storage` |
+| [testing](#testing) | Публічний вхід до механізму testing: замінник кожного порту, годинник, яким керує тест (test), і програвач сценаріїв (playScenario). | `@satorio/machinery/testing` |
+| [vitest](#vitest) | Публічний вхід до механізму vitest: живі стенди, контракти портів і три перевірки збірки (guard), які тримають рантайм цих тестів. | `@satorio/machinery/vitest` |
+
+Механізми вище стоять у порядку залежностей: core відкриває, кожен нижче може сягати по ті, що вище, а тестові набори закривають. Кожен розділ нижче несе ті самі групи в тому самому порядку, а кожна група — ті самі чотири стовпці. Для назви, яку віддає код, другий стовпець — це форма, під яку ви пишете. Для змінної, яку вирішує оточення, той стовпець називає один із трьох станів. Вона має безпечне значення, вона відмовляє без нього, або вона передає рішення далі.
+
+## core
+
+Імпорт із `@satorio/machinery/core` — [ціла сторінка](../mechanisms/core.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="core-ClosedSet-value">`ClosedSet`</span> | `interface` | — | Чітко визначений перелік (closed set) із одного джерела: значення, тип-об'єднання його членів і перевірка `is`. |
+| <span id="core-EnvironmentEntry-value">`EnvironmentEntry`</span> | `interface` | — | Одна змінна, яку читає механізм, і один стан, у якому вона стоїть. |
+| <span id="core-EnvironmentState-value">`EnvironmentState`</span> | `type` | — | Котрий із трьох станів має змінна. |
+| <span id="core-Refusal-value">`Refusal`</span> | `interface` | — | Відмова у трьох частинах, яких потребує читач: що сталось, чому механізм без цього не піде далі і що робити. |
+| <span id="core-Ulid-value">`Ulid`</span> | `string & { readonly [ulidBrand]: 'Ulid' }` | — | ULID: ідентифікатор, який машина карбує для запису, сортовний за миттю карбування і звичайний рядок усюди, куди мандрує. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="core-bigIntsAsDecimalStrings-procedure">`bigIntsAsDecimalStrings`</span> | `(_key: string, value: unknown) => unknown` | — | Подавайте це аргументом-заміною до `JSON.stringify`. |
+| <span id="core-closedSet-procedure">`closedSet`</span> | `<const T extends readonly string[]>(values: T) => ClosedSet<T>` | — | Будує чітко визначений перелік зі списку рядкових літералів, тож перевірка і список, який вона стереже, приходять з одного джерела. |
+| <span id="core-fallsBackTo-procedure">`fallsBackTo`</span> | `(value: string) => EnvironmentState` | — | Змінну безпечно не ставити, і ось що стається натомість. |
+| <span id="core-handedOn-procedure">`handedOn`</span> | `(consequence: string) => EnvironmentState` | — | Змінна законно необов'язкова і не має значення за замовчуванням, бо її вирішує хтось інший; ось що випливає, якщо її не поставити. |
+| <span id="core-isUlid-procedure">`isUlid`</span> | `(value: string) => value is Ulid` | — | Чи є рядок ULID, як перевірка типу, тож викликач звужує тип і нічого не піднімає. |
+| <span id="core-optionalSecret-procedure">`optionalSecret`</span> | `(name: string) => Config.Config<Option.Option<Redacted.Redacted>>` | — | Читає секрет, який законно необов'язковий, і подає `Option.none`, коли той не поставлений або порожній. |
+| <span id="core-optionalText-procedure">`optionalText`</span> | `(name: string) => Config.Config<Option.Option<string>>` | — | Читає змінну, яка законно необов'язкова і не має значення за замовчуванням, бо її вирішує хтось поза цим процесом. |
+| <span id="core-refusalFor-procedure">`refusalFor`</span> | `(name: string, refusal: Refusal) => ConfigError.ConfigError` | — | Одна відмова, яку піднімає змінна, що відмовляє, з трьома її частинами, зшитими в один рядок. |
+| <span id="core-refusalText-procedure">`refusalText`</span> | `(refusal: Refusal) => string` | — | Зшиває відмову в один рядок, який оператор читає в лозі або у відмові на старті. |
+| <span id="core-refuses-procedure">`refuses`</span> | `(refusal: Refusal) => EnvironmentState` | — | Механізм без цієї змінної не працює, і ось той текст із трьох частин, який читач зустріне, коли її немає. |
+| <span id="core-requiredSecret-procedure">`requiredSecret`</span> | `(name: string, refusal: Refusal) => Config.Config<Redacted.Redacted>` | — | Читає секрет, без якого механізм не працює, і відмовляє тими самими трьома частинами, коли той відсутній або порожній. |
+| <span id="core-requiredText-procedure">`requiredText`</span> | `(name: string, refusal: Refusal) => Config.Config<string>` | — | Читає змінну, без якої механізм не працює, і відмовляє трьома частинами, коли та відсутня або порожня. |
+| <span id="core-ulid-procedure">`ulid`</span> | `(raw: string) => Ulid` | — | Читає рядок як ULID і кидає `NotAUlidError`, коли це не ULID, тож сирий рядок заходить одними дверима. |
+| <span id="core-variableNameOf-procedure">`variableNameOf`</span> | `(entry: EnvironmentEntry) => string` | — | Назва, яку ставить оператор, де `<PREFIX>` стоїть перед суфіксом, що його застосунок обирає під час монтування. |
+| <span id="core-wholeNumberFallingBackTo-procedure">`wholeNumberFallingBackTo`</span> | `(name: string, lowest: number, highest: number, fallback: number, refusal: Refusal) => Config.Config<number>` | — | Читає ціле число, без якого механізм радо обійдеться, і падає на назване значення, коли змінну ніхто не поставив. |
+| <span id="core-wholeNumberWithin-procedure">`wholeNumberWithin`</span> | `(name: string, lowest: number, highest: number, refusal: Refusal) => Config.Config<number>` | — | Читає ціле число всередині діапазону і відмовляє трьома частинами, коли це не воно. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="core-DomainError-failure">`DomainError`</span> | `Error` | — | Базовий клас доменних помилок. |
+| <span id="core-NotAUlidError-failure">`NotAUlidError`</span> | `DomainError` | — | Що зустрічає викликач, коли до `ulid` дійшов рядок, який не є ULID; повідомлення цитує точне отримане значення. |
+
+## http
+
+Імпорт із `@satorio/machinery/http` — [ціла сторінка](../mechanisms/http.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="http-DEFAULT-HEALTH-CHECK-DEADLINE-MILLIS-value">`DEFAULT_HEALTH_CHECK_DEADLINE_MILLIS`</span> | `const` | — | Скільки часу дістає одна перевірка, перш ніж рахуватись як недоступна. |
+| <span id="http-HealthCheckStatus-value">`HealthCheckStatus`</span> | `'ok' \| 'down'` | — | Як відповіла одна залежність: вона відповіла, або вона лежить. |
+| <span id="http-HealthRoutesOptions-value">`HealthRoutesOptions`</span> | `interface` | — | Що потрібно маршрутам готовності: рантайм, який виконує перевірку, самі перевірки і строк, який дістає одна з них. |
+| <span id="http-HEALTHZ-PATH-value">`HEALTHZ_PATH`</span> | `const` | — | Та сама перевірка, що й `READYZ_PATH`, під другою назвою. |
+| <span id="http-LIVEZ-PATH-value">`LIVEZ_PATH`</span> | `const` | — | Шлях, який відповідає, чи цей процес узагалі живий, не питаючи жодної залежності. |
+| <span id="http-NamedHealthCheck-value">`NamedHealthCheck`</span> | `interface` | — | Одна залежність до перевірки, під назвою, якою відповідь про неї звітує. |
+| <span id="http-ReadinessOutcome-value">`ReadinessOutcome`</span> | `interface` | — | Що відповідає точка готовності: чи сервіс готовий і як відповіла кожна залежність. |
+| <span id="http-READYZ-PATH-value">`READYZ_PATH`</span> | `const` | — | Шлях, який відповідає, чи цей сервіс може брати трафік, після того як опитано кожну змонтовану залежність. |
+| <span id="http-RunHealthCheck-value">`RunHealthCheck`</span> | `type` | — | Виконує перевірку готовності і повертає її `Exit`. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="http-checkReadiness-procedure">`checkReadiness`</span> | `<R>(options: HealthRoutesOptions<R>) => Effect.Effect<ReadinessOutcome>` | — | Виконує кожну перевірку незалежно, паралельно, під її власним строком. |
+| <span id="http-healthRoutesFetch-procedure">`healthRoutesFetch`</span> | `<R>(options: HealthRoutesOptions<R>) => ((request: Request) => Promise<Response \| null>)` | — | Обробляє три точки готовності. |
+
+## money
+
+Імпорт із `@satorio/machinery/money` — [ціла сторінка](../mechanisms/money.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="money-Currency-value">`Currency`</span> | `DineroCurrency<bigint>` | — | Одна валюта з таблиці ISO 4217: її код, основа, якою вона рахує, і скільки десяткових знаків тримає одна одиниця. |
+| <span id="money-ExchangeRate-value">`ExchangeRate`</span> | `interface` | — | Скільки одиниць валюти, у яку ви йдете, купує одна одиниця валюти, з якої ви йдете. |
+| <span id="money-Money-value">`Money`</span> | `Dinero<bigint>` | — | Точна сума однієї валюти. |
+| <span id="money-Percent-value">`Percent`</span> | `interface` | — | Частка суми (share), яку тримають точно. |
+| <span id="money-PercentFromPercentageString-value">`PercentFromPercentageString`</span> | `Schema.Schema<Percent, string>` | — | Читає частку з дроту у формі, якою пише прайс-лист: `30` означає тридцять відсотків. |
+| <span id="money-PercentFromRatioString-value">`PercentFromRatioString`</span> | `Schema.Schema<Percent, string>` | — | Читає частку з дроту у формі, якою пише таблиця ставок: `0.3` означає тридцять відсотків. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="money-addMoney-procedure">`addMoney`</span> | `(left: Money, right: Money) => Either.Either<Money, CurrenciesDoNotMeetError>` | — | Додає дві суми однієї валюти. |
+| <span id="money-atRate-procedure">`atRate`</span> | `(amount: Money, target: Currency, rate: ExchangeRate) => Money` | — | Переводить суму в іншу валюту за названим вами курсом, зберігаючи кожну цифру добутку. |
+| <span id="money-compareMoney-procedure">`compareMoney`</span> | `(left: Money, right: Money) => Either.Either<number, CurrenciesDoNotMeetError>` | — | Ставить дві суми однієї валюти по порядку. |
+| <span id="money-currencyCodeOf-procedure">`currencyCodeOf`</span> | `(currency: Currency) => string` | — | Пише валюту назад трьома літерами, які дає їй ISO 4217. |
+| <span id="money-currencyOf-procedure">`currencyOf`</span> | `(code: string) => Either.Either<Currency, NotACurrencyCodeError>` | — | Читає код валюти, який хтось написав: `USD`, `EUR`, `UAH`. |
+| <span id="money-currencyOfMoney-procedure">`currencyOfMoney`</span> | `(amount: Money) => Currency` | — | Валюта, у якій порахована сума. |
+| <span id="money-decimalsOf-procedure">`decimalsOf`</span> | `(currency: Currency) => number` | — | Скільки десяткових знаків тримає одна одиниця цієї валюти: два для валюти, що рахує центами, нуль для тієї, що рахує цілими. |
+| <span id="money-exchangeRateFromDecimalForm-procedure">`exchangeRateFromDecimalForm`</span> | `(text: string) => Either.Either<ExchangeRate, NotAnExchangeRateError>` | — | Читає курс, який хтось написав: `0.89`, `41.57306`. |
+| <span id="money-exchangeRateInDecimalForm-procedure">`exchangeRateInDecimalForm`</span> | `(rate: ExchangeRate) => string` | — | Пише курс назад, обрізаним, так, як його написало джерело, що його опублікувало: `0.89`. |
+| <span id="money-minorUnitsOf-procedure">`minorUnitsOf`</span> | `(amount: Money) => bigint` | — | Сума, порахована у власній найдрібнішій одиниці (minor unit) валюти, округлена до неї єдиним правилом, яке тримає цей механізм. |
+| <span id="money-money-procedure">`money`</span> | `(currency: Currency, minorUnits: bigint) => Money` | — | Сума, порахована у власній найдрібнішій одиниці валюти: 4055 таких одиниць валюти, що рахує центами, — це 40.55. |
+| <span id="money-moneyAtScale-procedure">`moneyAtScale`</span> | `(currency: Currency, units: bigint, scale: bigint) => Money` | — | Сума, яку тримають у масштабі тоншому за власний масштаб валюти, тож розрахунок не губить жодної цифри. |
+| <span id="money-moneyFromDecimalForm-procedure">`moneyFromDecimalForm`</span> | `(currency: Currency, text: string) => Either.Either<Money, NotAnAmountError>` | — | Читає суму, яку хтось написав: `40.0455`, `-25`, `0.10`. |
+| <span id="money-MoneyFromDecimalString-procedure">`MoneyFromDecimalString`</span> | `(currency: Currency) => Schema.Schema<Money, string>` | — | Читає і пише суму на дроті десятковим текстом, у названій вами валюті. |
+| <span id="money-moneyInDecimalForm-procedure">`moneyInDecimalForm`</span> | `(amount: Money) => string` | — | Пише суму для дроту і для людини: `40.0455`, `-25.00`. |
+| <span id="money-negatedMoney-procedure">`negatedMoney`</span> | `(amount: Money) => Money` | — | Обертає суму: те, що були винні, стає тим, що винні назад. |
+| <span id="money-percentFromPercentageForm-procedure">`percentFromPercentageForm`</span> | `(text: string) => Either.Either<Percent, NotAPercentError>` | — | Читає форму, якою пише прайс-лист: `30` означає тридцять відсотків. |
+| <span id="money-percentFromRatioForm-procedure">`percentFromRatioForm`</span> | `(text: string) => Either.Either<Percent, NotAPercentError>` | — | Читає форму, якою пише таблиця ставок: `0.3` означає тридцять відсотків. |
+| <span id="money-percentInPercentageForm-procedure">`percentInPercentageForm`</span> | `(percent: Percent) => string` | — | Пише відсоткову форму назад, обрізаною: тридцять відсотків читаються як `30`. |
+| <span id="money-percentInRatioForm-procedure">`percentInRatioForm`</span> | `(percent: Percent) => string` | — | Пише форму відношення назад, обрізаною: тридцять відсотків читаються як `0.3`. |
+| <span id="money-percentOf-procedure">`percentOf`</span> | `(amount: Money, percent: Percent) => Money` | — | Бере частку від суми і зберігає кожну цифру добутку. |
+| <span id="money-roundedToTheCent-procedure">`roundedToTheCent`</span> | `(amount: Money) => Money` | — | Округлює суму до власної найдрібнішої одиниці валюти, половину — геть від нуля. |
+| <span id="money-sameMoney-procedure">`sameMoney`</span> | `(left: Money, right: Money) => boolean` | — | Чи дві суми є однією сумою. |
+| <span id="money-samePercent-procedure">`samePercent`</span> | `(left: Percent, right: Percent) => boolean` | — | Чи дві частки є однією часткою, з якої б форми кожну не прочитали. |
+| <span id="money-scaleOfMoney-procedure">`scaleOfMoney`</span> | `(amount: Money) => bigint` | — | Масштаб, у якому суму тримають зараз: скількома десятковими знаками рахують її власні одиниці, і він росте, поки розрахунок береже точність. |
+| <span id="money-sharesOf-procedure">`sharesOf`</span> | `(amount: Money, proportions: readonly bigint[]) => Either.Either<readonly Money[], ProportionsDoNotSplitError>` | — | Ділить суму на частки, які складаються назад рівно в те, що зайшло. |
+| <span id="money-sumOfMoney-procedure">`sumOfMoney`</span> | `(currency: Currency, amounts: readonly Money[]) => Either.Either<Money, CurrenciesDoNotMeetError>` | — | Додає будь-яку кількість сум, починаючи від нуля в названій вами валюті. |
+| <span id="money-zeroMoney-procedure">`zeroMoney`</span> | `(currency: Currency) => Money` | — | Нічого взагалі, в одній валюті. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="money-CurrenciesDoNotMeetError-failure">`CurrenciesDoNotMeetError`</span> | `Data.TaggedError<{ readonly left: string; readonly right: string }>` | — | Дві суми у двох валютах попросили зустрітись. |
+| <span id="money-MoneyFailure-failure">`MoneyFailure`</span> | `type` | — | Кожен спосіб, яким цей механізм відмовляє значенню. |
+| <span id="money-NotACurrencyCodeError-failure">`NotACurrencyCodeError`</span> | `Data.TaggedError<{ readonly text: string }>` | — | Поданий текст не називає валюти, яку знає цей механізм. |
+| <span id="money-NotAnAmountError-failure">`NotAnAmountError`</span> | `Data.TaggedError<{ readonly text: string }>` | — | Поданий текст не пише суми. |
+| <span id="money-NotAnExchangeRateError-failure">`NotAnExchangeRateError`</span> | `Data.TaggedError<{ readonly text: string }>` | — | Поданий текст не пише курсу обміну. |
+| <span id="money-NotAPercentError-failure">`NotAPercentError`</span> | `Data.TaggedError<{ readonly text: string; readonly form: 'percentage' \| 'ratio' }>` | — | Поданий текст не пише відсотка. |
+| <span id="money-ProportionsDoNotSplitError-failure">`ProportionsDoNotSplitError`</span> | `Data.TaggedError<{ readonly proportions: readonly bigint[] }>` | — | Подані пропорції не ділять суми. |
+
+## ports
+
+Імпорт із `@satorio/machinery/ports` — [ціла сторінка](../mechanisms/ports.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="ports-BlobStoreShape-value">`BlobStoreShape`</span> | `interface` | — | Операції сховища об'єктів (blob store). |
+| <span id="ports-claimAccepted-value">`claimAccepted`</span> | `ProcessedEventClaim` | — | Резервація (claim-once), якої ще ніхто не взяв, тож саме цей прогін робить роботу. |
+| <span id="ports-ClaimProcessedEventInput-value">`ClaimProcessedEventInput`</span> | `interface` | — | Що потрібно резервації: яку подію резервують і в яку мить це роблять. |
+| <span id="ports-DocumentNumberCounterShape-value">`DocumentNumberCounterShape`</span> | `interface` | — | Що пропонує лічильник: один виклик, який рухає місяць клієнта далі й подає лічбу, яку візьме наступний документ. |
+| <span id="ports-DocumentNumberCountInput-value">`DocumentNumberCountInput`</span> | `interface` | — | Який лічильник рухати далі: один клієнт, один звітний місяць (reporting month). |
+| <span id="ports-EventPublisherShape-value">`EventPublisherShape`</span> | `interface` | — | Що пропонує публікатор: один виклик, який надсилає пачку повідомлень із буфера трансмітера (outbox) геть із цього сервісу. |
+| <span id="ports-ExternalHttpClientShape-value">`ExternalHttpClientShape`</span> | `interface` | — | Один зовнішній HTTP-сервіс, прочитаний однією операцією. |
+| <span id="ports-IntegrationEventOutboxShape-value">`IntegrationEventOutboxShape`</span> | `interface` | — | Буфер трансмітера тримає повідомлення, які процедура ставить у чергу тією самою транзакцією, що й свою зміну стану. |
+| <span id="ports-OutboxMessage-value">`OutboxMessage`</span> | `interface` | — | Одне повідомлення, що чекає в буфері трансмітера: власний ідентифікатор, що воно таке, яка схема надала йому форми, коли воно сталось і що воно несе. |
+| <span id="ports-PORT-FAILURES-IN-THE-EVENTS-LANGUAGE-value">`PORT_FAILURES_IN_THE_EVENTS_LANGUAGE`</span> | `Readonly<Record<string, string>>` | — | Відмова порту, названа мовою події, а не як `<Port>UnavailableError`, разом із реченням, яке заслуговує на цей виняток. |
+| <span id="ports-ProcessedEventClaim-value">`ProcessedEventClaim`</span> | `type` | — | Два стани замка резервації: цей прогін узяв подію, або хтось уже взяв її раніше. |
+| <span id="ports-ProcessedEventRegistryShape-value">`ProcessedEventRegistryShape`</span> | `interface` | — | Що пропонує замок резервації: один виклик, який або бере подію вперше, або каже, коли її взяли раніше. |
+| <span id="ports-QueueMessageProducerShape-value">`QueueMessageProducerShape`</span> | `interface` | — | Що пропонує відправник: один виклик, який кладе тіло повідомлення в чергу. |
+| <span id="ports-QueueMessageSourceShape-value">`QueueMessageSourceShape`</span> | `interface` | — | Джерело повідомлень черги: воно отримує пачку і підтверджує взяте. |
+| <span id="ports-RawQueueMessage-value">`RawQueueMessage`</span> | `interface` | — | Одне повідомлення таким, яким його віддає черга: власний ідентифікатор, квитанція, яку цитує підтвердження, і тіло, ще текстом. |
+| <span id="ports-ReadinessProbeShape-value">`ReadinessProbeShape`</span> | `interface` | — | Що пропонує проба готовності: одна перевірка того, що база відповідає, тож точка звітує про залежність, а не про здогад. |
+| <span id="ports-StoredBlob-value">`StoredBlob`</span> | `interface` | — | Байти збереженого об'єкта, його тип вмісту і довільні текстові метадані. |
+| <span id="ports-TransactionBoundaryShape-value">`TransactionBoundaryShape`</span> | `interface` | — | Що пропонує межа транзакції: один виклик, який виконує роботу всередині транзакції і відкочує її цілком, коли робота падає. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="ports-alreadyProcessed-procedure">`alreadyProcessed`</span> | `(processedAt: DateTime.Utc) => ProcessedEventClaim` | — | Резервація, яку хтось уже взяв, разом із миттю, коли він її взяв. |
+| <span id="ports-portUnavailable-procedure">`portUnavailable`</span> | `<E>(Unavailable: new (fields: { readonly operation: string; readonly cause: unknown }) => E)` | — | Будує фабрику відмов «не відповів» навколо власного конструктора `<Port>UnavailableError` одного порту. |
+
+### Порти
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="ports-BlobStore-port">`BlobStore`</span> | `Context.Tag('BlobStore')` | — | Порт, який просить процедура, коли зберігає цілі об'єкти під ключем і читає їх назад. |
+| <span id="ports-DocumentNumberCounter-port">`DocumentNumberCounter`</span> | `Context.Tag('DocumentNumberCounter')` | — | Порт, який просить процедура, коли нумерує документ, що його читатиме людина. |
+| <span id="ports-EventPublisher-port">`EventPublisher`</span> | `Context.Tag('EventPublisher')` | — | Порт, який просить трансмітер вихідних подій (outbox relay), коли оголошує те, що вже сталось. |
+| <span id="ports-ExternalHttpClient-port">`ExternalHttpClient`</span> | `Context.Tag('ExternalHttpClient')` | — | Порт, який просить процедура, коли читає довідкові дані із сервісу поза цим. |
+| <span id="ports-IntegrationEventOutbox-port">`IntegrationEventOutbox`</span> | `Context.Tag( 'IntegrationEventOutbox', )` | — | Порт, який просить процедура, коли ставить подію в чергу тією самою транзакцією, що й зміну стану, яка її спричинила. |
+| <span id="ports-ProcessedEventRegistry-port">`ProcessedEventRegistry`</span> | `Context.Tag( 'ProcessedEventRegistry', )` | — | Порт, який просить процедура, коли подію треба відпрацювати рівно раз, хоч би скільки разів вона прийшла. |
+| <span id="ports-QueueMessageProducer-port">`QueueMessageProducer`</span> | `Context.Tag('QueueMessageProducer')` | — | Порт, який просить процедура, коли надсилає повідомлення в чергу. |
+| <span id="ports-QueueMessageSource-port">`QueueMessageSource`</span> | `Context.Tag('QueueMessageSource')` | — | Порт, який просить робітник, коли отримує повідомлення з черги і підтверджує взяте. |
+| <span id="ports-ReadinessProbe-port">`ReadinessProbe`</span> | `Context.Tag('ReadinessProbe')` | — | Порт, який просить точка готовності, коли має сказати, чи цей сервіс може брати трафік. |
+| <span id="ports-TransactionBoundary-port">`TransactionBoundary`</span> | `Context.Tag('TransactionBoundary')` | — | Порт, який просить процедура, коли її записи мають лягти разом або не лягти зовсім. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="ports-BlobStoreUnavailableError-failure">`BlobStoreUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Сховище об'єктів не відповіло; ключ, якого там просто немає, ніколи не є цією відмовою. |
+| <span id="ports-DatabaseDidNotAnswerError-failure">`DatabaseDidNotAnswerError`</span> | `Data.TaggedError<{ readonly reason: string }>` | — | Перевірка готовності проти бази не повернулась; `reason` каже, що її спинило. |
+| <span id="ports-DocumentNumberCounterUnavailableError-failure">`DocumentNumberCounterUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Лічильник за номером документа не відповів; `operation` називає виклик, а `cause` несе власну помилку драйвера. |
+| <span id="ports-EventPublisherUnavailableError-failure">`EventPublisherUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Публікатор не відповів, або топік не налаштований; `cause` каже, що з двох сталось. |
+| <span id="ports-ExternalServiceRefusedError-failure">`ExternalServiceRefusedError`</span> | `Data.TaggedError<{ readonly service: string; readonly operation: string; readonly status: number }>` | — | Зовнішній сервіс відповів власною відмовою, тож той самий запит падатиме знову, доки запит не зміниться. |
+| <span id="ports-ExternalServiceResponseMalformedError-failure">`ExternalServiceResponseMalformedError`</span> | `Data.TaggedError<{ readonly service: string; readonly operation: string; readonly cause: unknown }>` | — | Зовнішній сервіс відповів, але тіло не лягло в схему, яку подав викликач. |
+| <span id="ports-ExternalServiceUnavailableError-failure">`ExternalServiceUnavailableError`</span> | `Data.TaggedError<{ readonly service: string; readonly operation: string; readonly cause: unknown }>` | — | Мережева невдача, вичерпаний строк або помилка сервера після того, як скінчились спроби; той самий запит цілком може вдатись пізніше. |
+| <span id="ports-IntegrationEventOutboxUnavailableError-failure">`IntegrationEventOutboxUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Драйвер буфера трансмітера не відповів; `operation` називає виклик, а `cause` несе власну помилку драйвера. |
+| <span id="ports-ProcessedEventRegistryUnavailableError-failure">`ProcessedEventRegistryUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Драйвер резервації не відповів; `operation` називає виклик, а `cause` несе власну помилку драйвера. |
+| <span id="ports-QueueMessageProducerUnavailableError-failure">`QueueMessageProducerUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Відправник черги не відповів; `operation` називає виклик, а `cause` несе власну помилку драйвера. |
+| <span id="ports-QueueMessageSourceUnavailableError-failure">`QueueMessageSourceUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Джерело черги не відповіло; `operation` називає виклик, а `cause` несе власну помилку драйвера. |
+| <span id="ports-TransactionBoundaryUnavailableError-failure">`TransactionBoundaryUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Драйвер транзакції не відповів; `operation` називає виклик, а `cause` несе власну помилку драйвера. |
+
+## time
+
+Імпорт із `@satorio/machinery/time` — [ціла сторінка](../mechanisms/time.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="time-CalendarDay-value">`CalendarDay`</span> | `type` | — | Один день календаря, без часу і без зони всередині. |
+| <span id="time-CalendarDayFromHumanString-value">`CalendarDayFromHumanString`</span> | `Schema.Schema<CalendarDay, string>` | — | Читає день із дроту у формі, якою пише людина, і пише його назад тією самою формою. |
+| <span id="time-CalendarDayOrder-value">`CalendarDayOrder`</span> | `Order.Order<CalendarDay>` | — | Ставить два дні в календарному порядку, раніший першим. |
+| <span id="time-CalendarDayRefusalReason-value">`CalendarDayRefusalReason`</span> | `type` | — | Чому написаний день не є календарним днем (calendar day). |
+| <span id="time-Instant-value">`Instant`</span> | `interface` | — | Одна мить на світовому годиннику, яку тримають цілими мілісекундами від початку 1970 року. |
+| <span id="time-Period-value">`Period`</span> | `interface` | — | Пробіг календарних днів. |
+| <span id="time-TimeZone-value">`TimeZone`</span> | `type` | — | Одна названа часова зона (time zone), така, якою її знає власна таблиця зон рантайму. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="time-addDays-procedure">`addDays`</span> | `(day: CalendarDay, days: number) => CalendarDay` | — | Рухає день на цілі дні. |
+| <span id="time-addMonths-procedure">`addMonths`</span> | `(day: CalendarDay, months: number) => CalendarDay` | — | Рухає день на цілі місяці і сідає на останній день місяця, надто короткого, щоб його вмістити. |
+| <span id="time-calendarDayFromHumanForm-procedure">`calendarDayFromHumanForm`</span> | `(text: string) => Either.Either<CalendarDay, NotACalendarDayError>` | — | Читає форму, якою день пише людина: `19.03.2026`. |
+| <span id="time-calendarDayFromIsoForm-procedure">`calendarDayFromIsoForm`</span> | `(text: string) => Either.Either<CalendarDay, NotACalendarDayError>` | — | Читає форму, якою день пише машина: `2026-03-19`. |
+| <span id="time-dateTimeOfInstant-procedure">`dateTimeOfInstant`</span> | `(instant: Instant) => DateTime.Utc` | — | Подає мить назад власним значенням UTC від Effect — для рядка бази, конверта чи будь-якого коду, який уже говорить тим типом. |
+| <span id="time-dayInHumanForm-procedure">`dayInHumanForm`</span> | `(day: CalendarDay) => string` | — | Пише день так, як його читає людина: `19.03.2026`. |
+| <span id="time-dayInIsoForm-procedure">`dayInIsoForm`</span> | `(day: CalendarDay) => string` | — | Пише день так, як його читає машина: `2026-03-19`. |
+| <span id="time-dayOfInstant-procedure">`dayOfInstant`</span> | `(instant: Instant, zone: TimeZone) => CalendarDay` | — | Календарний день, на який припадає мить для людини, що стоїть у тій зоні. |
+| <span id="time-daysBetween-procedure">`daysBetween`</span> | `(earlier: CalendarDay, later: CalendarDay) => number` | — | Рахує цілі дні від першого дня до другого. |
+| <span id="time-instantInHumanForm-procedure">`instantInHumanForm`</span> | `(instant: Instant, zone: TimeZone) => string` | — | Пише мить так, як її читає людина в тій зоні: `19.03.2026 14:05 +02:00`. |
+| <span id="time-instantOfDateTime-procedure">`instantOfDateTime`</span> | `(moment: DateTime.Utc) => Instant` | — | Бере мить, яку машинерія вже тримає власним значенням UTC від Effect. |
+| <span id="time-lastDayOfTheMonthOf-procedure">`lastDayOfTheMonthOf`</span> | `(day: CalendarDay) => CalendarDay` | — | Останній день місяця, на який припадає поданий день. |
+| <span id="time-lengthInDays-procedure">`lengthInDays`</span> | `(period: Period) => number` | — | Рахує дні, які тримає період, разом з обома краями. |
+| <span id="time-monthOf-procedure">`monthOf`</span> | `(day: CalendarDay) => Period` | — | Цілий календарний місяць, на який припадає поданий день, як період. |
+| <span id="time-monthsOf-procedure">`monthsOf`</span> | `(period: Period) => readonly Period[]` | — | Ріже період на одну частину для кожного календарного місяця, через який він біжить, по порядку. |
+| <span id="time-periodContains-procedure">`periodContains`</span> | `(period: Period, day: CalendarDay) => boolean` | — | Відповідає, чи день належить періоду. |
+| <span id="time-periodOf-procedure">`periodOf`</span> | `(from: CalendarDay, to: CalendarDay) => Either.Either<Period, PeriodEndsBeforeItStartsError>` | — | Бере два дні як період, раніший першим. |
+| <span id="time-periodsOverlap-procedure">`periodsOverlap`</span> | `(left: Period, right: Period) => boolean` | — | Відповідає, чи два періоди ділять хоч один день. |
+| <span id="time-startOfDay-procedure">`startOfDay`</span> | `(day: CalendarDay, zone: TimeZone) => Instant` | — | Мить, якою календарний день починається в тій зоні. |
+| <span id="time-todayIn-procedure">`todayIn`</span> | `(zone: TimeZone) => Effect.Effect<CalendarDay>` | — | Сьогодні, як його рахує календар тієї зони, прочитане з годинника, який сервіс уже поділяє. |
+| <span id="time-zoneIdOf-procedure">`zoneIdOf`</span> | `(zone: TimeZone) => string` | — | Читає назву IANA назад із зони — для рядка лога чи для рядка бази. |
+| <span id="time-zoneNamed-procedure">`zoneNamed`</span> | `(zoneId: string) => Either.Either<TimeZone, UnknownTimeZoneError>` | — | Бере назву зони IANA і відмовляє назві, якої рантайм не знає. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="time-NotACalendarDayError-failure">`NotACalendarDayError`</span> | `Data.TaggedError<{ readonly text: string; readonly reason: CalendarDayRefusalReason }>` | — | Текст, поданий читачеві, не називає дня, який тримає бодай один календар. |
+| <span id="time-PeriodEndsBeforeItStartsError-failure">`PeriodEndsBeforeItStartsError`</span> | `Data.TaggedError<{ readonly from: string; readonly to: string }>` | — | Два подані дні біжать назад. |
+| <span id="time-TimeFailure-failure">`TimeFailure`</span> | `type` | — | Кожен спосіб, яким цей механізм відмовляє значенню. |
+| <span id="time-UnknownTimeZoneError-failure">`UnknownTimeZoneError`</span> | `Data.TaggedError<{ readonly zoneId: string }>` | — | Рантайм не має зони під такою назвою. |
+
+## identifiers
+
+Імпорт із `@satorio/machinery/identifiers` — [ціла сторінка](../mechanisms/identifiers.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="identifiers-ClientCode-value">`ClientCode`</span> | `string & { readonly [clientCodeBrand]: 'ClientCode' }` | — | Номер, який клієнт диктує вам назад: вісім цифр, остання з яких перевіряє сім інших. |
+| <span id="identifiers-CreditorReference-value">`CreditorReference`</span> | `type` | — | Референс, який платник копіює в банківський переказ, із власними контрольними цифрами (check digit). |
+| <span id="identifiers-DocumentNumber-value">`DocumentNumber`</span> | `type` | — | Номер, надрукований на документі, у формі, якою його читає людина. |
+| <span id="identifiers-DocumentNumberParts-value">`DocumentNumberParts`</span> | `interface` | — | З чого складається номер документа. |
+| <span id="identifiers-DocumentNumbers-value">`DocumentNumbers`</span> | `interface` | — | Номери документів одного переліку серій (series): карбування, прив'язане до того переліку, читання, яке відмовляє будь-якій серії поза ним, і сам перелік. |
+| <span id="identifiers-newClientCode-value">`newClientCode`</span> | `Effect.Effect<ClientCode>` | — | Свіжий код клієнта, взятий із випадковості, яку сервіс уже поділяє. |
+| <span id="identifiers-newUlid-value">`newUlid`</span> | `Effect.Effect<Ulid>` | — | Свіжий ідентифікатор, викарбуваний із годинника й випадковості, які сервіс уже поділяє. |
+| <span id="identifiers-NextDocumentNumberInput-value">`NextDocumentNumberInput`</span> | `interface` | — | Який документ нумерувати: його серія, кому він іде і за який місяць звітує. |
+| <span id="identifiers-ulidsInOrder-value">`ulidsInOrder`</span> | `Effect.Effect<Effect.Effect<Ulid>>` | — | Породжувач ідентифікаторів, які тримають свій порядок навіть тоді, коли два з них падають в одну мілісекунду. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="identifiers-clientCodeFrom-procedure">`clientCodeFrom`</span> | `(text: string) => Either.Either<ClientCode, NotAClientCodeError>` | — | Читає код клієнта, який хтось набрав, прощаючи пробіли й дефіси, що їх людина ставить між групами. |
+| <span id="identifiers-clientCodeInGroupedForm-procedure">`clientCodeInGroupedForm`</span> | `(code: ClientCode) => string` | — | Форма, якою людина читає код із документа: дві групи по чотири. |
+| <span id="identifiers-clientCodeOfDocumentNumber-procedure">`clientCodeOfDocumentNumber`</span> | `(number: DocumentNumber) => ClientCode` | — | Код клієнта, надрукований усередині номера документа. |
+| <span id="identifiers-creditorReferenceFrom-procedure">`creditorReferenceFrom`</span> | `(text: string) => Either.Either<CreditorReference, NotACreditorReferenceError>` | — | Читає референс, який хтось набрав, прощаючи регістр, пробіли й дефіси, що їх людина копіює разом із ним. |
+| <span id="identifiers-creditorReferenceInGroupedForm-procedure">`creditorReferenceInGroupedForm`</span> | `(reference: CreditorReference) => string` | — | Форма, якою людина читає референс із документа і набирає його в банку: групи по чотири, як їх друкує ISO 11649. |
+| <span id="identifiers-creditorReferenceOf-procedure">`creditorReferenceOf`</span> | `(number: DocumentNumber) => CreditorReference` | — | Платіжний референс (creditor reference) для документа, який комусь треба сплатити. |
+| <span id="identifiers-dammCheckDigit-procedure">`dammCheckDigit`</span> | `(digits: string) => string \| null` | — | Контрольна цифра, яка робить пробіг цифр самоперевірним, за алгоритмом Дамма. |
+| <span id="identifiers-dammHolds-procedure">`dammHolds`</span> | `(digits: string) => boolean` | — | Чи пробіг цифр уже несе контрольну цифру, яка тримає. |
+| <span id="identifiers-digitsOfClientCode-procedure">`digitsOfClientCode`</span> | `(code: ClientCode) => string` | — | Вісім цифр без нічого між ними — та форма, з якої будують номер документа і платіжний референс. |
+| <span id="identifiers-digitsOfCreditorReference-procedure">`digitsOfCreditorReference`</span> | `(reference: CreditorReference) => string` | — | Цифри номера документа, на який показує цей референс. |
+| <span id="identifiers-digitsOfDocumentNumber-procedure">`digitsOfDocumentNumber`</span> | `(number: DocumentNumber) => string` | — | Цифри номера документа зі знятою серією і дефісами — те, над чим будують платіжний референс. |
+| <span id="identifiers-makeDocumentNumbers-procedure">`makeDocumentNumbers`</span> | `<const Series extends readonly string[]>(series: ClosedSet<Series>) => DocumentNumbers<Series>` | — | Прив'язує номери документів до серій, які видає один сервіс: які види документів існують — це канон того сервісу, а не цього пакета. |
+| <span id="identifiers-reportingMonthOf-procedure">`reportingMonthOf`</span> | `(day: CalendarDay) => string` | — | Дві цифри року і дві місяця, якими пишуть звітний період: березень 2026 читається як `2603`. |
+| <span id="identifiers-ulidOfSeed-procedure">`ulidOfSeed`</span> | `(moment: DateTime.Utc, seed: string) => Ulid` | — | Ідентифікатор, який мить і зерно завжди карбують однаково. |
+| <span id="identifiers-withDammCheckDigit-procedure">`withDammCheckDigit`</span> | `(digits: string) => string \| null` | — | Ті самі цифри з контрольною цифрою, дописаною в кінці. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="identifiers-IdentifierFailure-failure">`IdentifierFailure`</span> | `type` | — | Кожен спосіб, яким цей механізм відмовляє значенню. |
+| <span id="identifiers-NotAClientCodeError-failure">`NotAClientCodeError`</span> | `Data.TaggedError<{ readonly text: string }>` | — | Поданий текст не є кодом клієнта. |
+| <span id="identifiers-NotACreditorReferenceError-failure">`NotACreditorReferenceError`</span> | `Data.TaggedError<{ readonly text: string }>` | — | Поданий текст не є платіжним референсом, який видав цей механізм. |
+| <span id="identifiers-NotADocumentNumberError-failure">`NotADocumentNumberError`</span> | `Data.TaggedError<{ readonly text: string }>` | — | Подані частини не складають номера документа, або поданий текст не читається як номер. |
+
+## workflow
+
+Імпорт із `@satorio/machinery/workflow` — [ціла сторінка](../mechanisms/workflow.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="workflow-ClaimOnce-value">`ClaimOnce`</span> | `type` | — | Резервація рівно один раз: спільний ґрунт для кожної процедури, яка бере подію або команду один раз. |
+| <span id="workflow-DEFAULT-PUBLISH-PENDING-EVENTS-SETTINGS-value">`DEFAULT_PUBLISH_PENDING_EVENTS_SETTINGS`</span> | `PublishPendingEventsSettings` | — | Темп, який тримає трансмітер вихідних подій, коли сервіс не називає власного. |
+| <span id="workflow-OnClaimMatchers-value">`OnClaimMatchers`</span> | `interface` | — | Дві гілки, які бере `onClaim`: що робити, коли подію вже зарезервовано, і що робити, коли її резервує цей прогін. |
+| <span id="workflow-PublishPendingEventsSettings-value">`PublishPendingEventsSettings`</span> | `interface` | — | Як трансмітер вихідних подій задає собі темп: скільки повідомлень бере один такт і скільки він чекає між тактами. |
+| <span id="workflow-UpcastStep-value">`UpcastStep`</span> | `interface` | — | Один підйом, від названої версії до наступної вгору. |
+| <span id="workflow-VersionedEventDefinition-value">`VersionedEventDefinition`</span> | `interface` | — | Подію, збережену вчора, читає сьогоднішній код. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="workflow-claimAsProcessedAt-procedure">`claimAsProcessedAt`</span> | `(idempotencyKey: string, processedAt: DateTime.Utc) => ClaimOnce` | — | Резервує з `processedAt`, поданим викликачем, — для обробника, який уже прочитав годинник і мусить зберегти саме ту мить. |
+| <span id="workflow-claimAsProcessedNow-procedure">`claimAsProcessedNow`</span> | `(idempotencyKey: string) => ClaimOnce` | — | Резервує з поточним часом — для викликача, якому потрібна лише резервація. |
+| <span id="workflow-decodeStoredPayload-procedure">`decodeStoredPayload`</span> | `<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>, storedVersion: number, payload: unknown) => Effect.Effect<Schema.Schema.Type<S>, VersionedPayloadFailure \| ParseResult.ParseError>` | — | Підіймає збережений payload до поточної версії і декодує його поточною схемою. |
+| <span id="workflow-keepPublishingPendingEvents-procedure">`keepPublishingPendingEvents`</span> | `(settings: PublishPendingEventsSettings = DEFAULT_PUBLISH_PENDING_EVENTS_SETTINGS) => Effect.Effect<never, never, IntegrationEventOutbox \| EventPublisher>` | — | Крутить трансмітер вихідних подій стільки, скільки живе сервіс. |
+| <span id="workflow-onClaim-procedure">`onClaim`</span> | `<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>` | — | Розгалужується на стані резервації: `AlreadyProcessed` іде одним шляхом, `ClaimAccepted` — іншим. |
+| <span id="workflow-publishOneBatch-procedure">`publishOneBatch`</span> | `(batchLimit: number) => Effect.Effect<number, PublishPendingEventsFailure, IntegrationEventOutbox \| EventPublisher>` | — | Один такт трансмітера вихідних подій: узяти пачку недоставлених повідомлень, віддати її публікаторові, тоді позначити її відправленою. |
+| <span id="workflow-transactionally-procedure">`transactionally`</span> | `<A, E, R>(work: Effect.Effect<A, E, R>)` | — | Загортає роботу в межу транзакції: дістає `TransactionBoundary` з контексту і проганяє роботу крізь неї. |
+| <span id="workflow-upcastToCurrentVersion-procedure">`upcastToCurrentVersion`</span> | `<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>, storedVersion: number, payload: unknown) => Effect.Effect<unknown, VersionedPayloadFailure>` | — | Підіймає збережений payload від версії, якою його записали, до версії, яку читає цей код, по одному кроку на версію, по порядку. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="workflow-MissingUpcastStepError-failure">`MissingUpcastStepError`</span> | `Data.TaggedError<{ readonly eventType: string; readonly fromVersion: number; readonly currentVersion: number }>` | — | Одна версія між збереженим payload і поточною не має кроку підйому, тож підйом не доходить до кінця. |
+| <span id="workflow-PublishPendingEventsFailure-failure">`PublishPendingEventsFailure`</span> | `type` | — | Що може зустріти один такт трансмітера: буфер трансмітера не відповів або публікатор не відповів. |
+| <span id="workflow-SchemaVersionFromTheFutureError-failure">`SchemaVersionFromTheFutureError`</span> | `Data.TaggedError<{ readonly eventType: string; readonly storedVersion: number; readonly currentVersion: number }>` | — | Збережений payload каже, що його записала новіша версія цього коду, ніж та, що його читає. |
+| <span id="workflow-UpcastStepFailedError-failure">`UpcastStepFailedError`</span> | `Data.TaggedError<{ readonly eventType: string; readonly fromVersion: number; readonly cause: unknown }>` | — | Крок підйому кинув помилку, поки підіймав payload на версію вгору. |
+| <span id="workflow-VersionedPayloadFailure-failure">`VersionedPayloadFailure`</span> | `type` | — | Кожен спосіб, яким читання збереженого payload може відмовити. |
+
+## graphql
+
+Імпорт із `@satorio/machinery/graphql` — [ціла сторінка](../mechanisms/graphql.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="graphql-ENVIRONMENT-value">`ENVIRONMENT`</span> | `readonly EnvironmentEntry[]` | — | Кожна змінна, яку читає цей адаптер (adapter), і один стан, у якому стоїть кожна з них. |
+| <span id="graphql-EveryFailureIsClassified-value">`EveryFailureIsClassified`</span> | `type` | — | Доказ того, що кожну відмову, яку може підняти сервіс, замаплено на цій межі. |
+| <span id="graphql-graphiqlEnabledFromEnvironment-value">`graphiqlEnabledFromEnvironment`</span> | `Config.Config<boolean>` | — | Чи віддавати сторінку редактора. |
+| <span id="graphql-GraphiqlPage-value">`GraphiqlPage`</span> | `interface` | — | Сторінка GraphiQL: заголовок і наперед заповнений документ. |
+| <span id="graphql-GRAPHQL-ENDPOINT-value">`GRAPHQL_ENDPOINT`</span> | `const` | — | Єдиний шлях, на якому відповідає точка GraphQL. |
+| <span id="graphql-GraphQLContext-value">`GraphQLContext`</span> | `interface` | — | Що резолвер читає зі свого контексту: один виклик, який виконує програму процедури і відповідає її значенням або `GraphQLError`. |
+| <span id="graphql-graphqlPortFromEnvironment-value">`graphqlPortFromEnvironment`</span> | `Config.Config<number>` | — | Порт, на якому слухати. |
+| <span id="graphql-RunOperationsExit-value">`RunOperationsExit`</span> | `type` | — | Найменша спроможність, яку резолвер позичає в рантайму: виконати програму, що потребує `R`, і повернути її `Exit`. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="graphql-asGraphQLError-procedure">`asGraphQLError`</span> | `(failure: OperationFailure \| ParseResult.ParseError) => GraphQLError` | — | Мапить відмову GraphQL на `GraphQLError`: той самий канал відмов операції з трьох класів плюс відмови декодера входу — жодного другого каталогу. |
+| <span id="graphql-graphiqlExampleProblems-procedure">`graphiqlExampleProblems`</span> | `(schema: GraphQLSchema, page: GraphiqlPage) => readonly GraphiqlExampleProblem[]` | — | Звіряє типовий запит сторінки GraphiQL зі схемою. |
+| <span id="graphql-graphqlContextFrom-procedure">`graphqlContextFrom`</span> | `<R>(runExit: RunOperationsExit<R>) => GraphQLContext<R>` | — | Будує той контекст навколо власного `runPromiseExit` рантайму, тож резолвер ніколи не торкається рантайму напряму. |
+| <span id="graphql-makeSubGraphSchemaBuilder-procedure">`makeSubGraphSchemaBuilder`</span> | `<Context extends object>()` | — | Повертає фабрику будівників, яка несе тип контексту резолвера. |
+| <span id="graphql-makeYogaServer-procedure">`makeYogaServer`</span> | `<R>(options: GraphQLServerOptions<R>) => YogaServerInstance<Record<string, never>, GraphQLContext<R>>` | — | Будує GraphQL-сервер Yoga для Bun. |
+| <span id="graphql-serverCannotListen-procedure">`serverCannotListen`</span> | `(port: number, cause: unknown) => ServerCannotListenError` | — | Перетворює те, що кинув рантайм, відкриваючи сокет, на названу відмову, яку читає викликач. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="graphql-graphqlServerLive-adapter">`graphqlServerLive`</span> | `<R>(options: GraphQLRequestHandlerOptions<R>) => Layer.Layer<never, ConfigError.ConfigError \| ServerCannotListenError, R>` | — | Єдиний шар, який монтує цей механізм: сервер, що відповідає на ваші операції. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="graphql-OperationFailure-failure">`OperationFailure`</span> | `type` | — | Усе, чим резолвер може відмовити, як один чітко визначений перелік: не знайдено, відхилено або недоступно. |
+| <span id="graphql-OperationRejectedError-failure">`OperationRejectedError`</span> | `Data.TaggedError<{ readonly rule: string; readonly reason: string; readonly detail: string }>` | — | Правило резолвера відхилило операцію, і `reason` називає причину, яку воно розпізнало. |
+| <span id="graphql-OperationsUnavailableError-failure">`OperationsUnavailableError`</span> | `Data.TaggedError<{ readonly operation: string; readonly cause: unknown }>` | — | Власна залежність резолвера не відповіла; `cause` несе відмову самого порту. |
+| <span id="graphql-ServerCannotListenError-failure">`ServerCannotListenError`</span> | `Data.TaggedError<{ readonly port: number; readonly refusal: Refusal; readonly cause: unknown }>` | — | Сокет так і не відкрився. |
+| <span id="graphql-SubjectNotFoundError-failure">`SubjectNotFoundError`</span> | `Data.TaggedError<{ readonly subject: string; readonly id: string }>` | — | Один із рівно трьох класів відмови операції нижче — чітко визначений перелік, на який мапить резолвер. |
+
+### Змінні оточення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="graphql-GRAPHQL-PORT-environment-variable">`GRAPHQL_PORT`</span> | `falls back` | `4000` | Порт, на якому слухають точка GraphQL і проби готовності. |
+| <span id="graphql-GRAPHIQL-ENABLED-environment-variable">`GRAPHIQL_ENABLED`</span> | `falls back` | `true` | Чи віддається сторінка редактора GraphiQL на тій самій точці. |
+
+## integration
+
+Імпорт із `@satorio/machinery/integration` — [ціла сторінка](../mechanisms/integration.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="integration-DEFAULT-TIMEOUT-MILLIS-value">`DEFAULT_TIMEOUT_MILLIS`</span> | `const` | — | Скільки може тривати один виклик, коли ніхто не назвав числа. |
+| <span id="integration-defaultExternalRetrySchedule-value">`defaultExternalRetrySchedule`</span> | `Schedule.Schedule<unknown, unknown>` | — | Як виклик чекає і пробує знову: зростальні паузи, з джитером, на короткому бюджеті. |
+| <span id="integration-ENVIRONMENT-value">`ENVIRONMENT`</span> | `readonly EnvironmentEntry[]` | — | Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них. |
+| <span id="integration-ExternalServiceSettings-value">`ExternalServiceSettings`</span> | `interface` | — | Що потрібно клієнтові, перш ніж він подзвонить: адреса, під яку йде кожен запит, і скільки може тривати один виклик. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="integration-baseUrlVariable-procedure">`baseUrlVariable`</span> | `(variablePrefix: string) => string` | — | Будує назву змінної оточення з префікса, який застосунок дає під час монтування. |
+| <span id="integration-externalHttpClientUnavailableWithoutConfiguration-procedure">`externalHttpClientUnavailableWithoutConfiguration`</span> | `(service: string, refusal: Refusal) => ExternalHttpClientShape` | — | Клієнт, який стоїть замість справжнього, коли адресу ніхто не поставив, і гучно валить кожен виклик. |
+| <span id="integration-externalServiceSettings-procedure">`externalServiceSettings`</span> | `(variablePrefix: string) => Config.Config<ExternalServiceSettings>` | — | Читає кожну змінну з `ENVIRONMENT` під одним префіксом. |
+| <span id="integration-makeExternalHttpClient-procedure">`makeExternalHttpClient`</span> | `(service: string, settings: ExternalServiceSettings) => Effect.Effect<ExternalHttpClientShape, never, HttpClient.HttpClient>` | — | Готовий до вжитку клієнт із уже захопленим транспортом. |
+| <span id="integration-timeoutVariable-procedure">`timeoutVariable`</span> | `(variablePrefix: string) => string` | — | Будує назву змінної строку з того самого префікса, тож кожен зовнішній сервіс в одному процесі тримає власне терпіння. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="integration-externalHttpClientFromEnvironmentLive-adapter">`externalHttpClientFromEnvironmentLive`</span> | `(service: string, variablePrefix: string, transport: Layer.Layer<HttpClient.HttpClient> = FetchHttpClient.layer) => Layer.Layer<ExternalHttpClient, ConfigError.ConfigError>` | — | Клієнт, зібраний зі змінних оточення під одним префіксом. |
+| <span id="integration-externalHttpClientLive-adapter">`externalHttpClientLive`</span> | `(service: string, variablePrefix: string) => Layer.Layer<ExternalHttpClient, ConfigError.ConfigError>` | — | Один зовнішній сервіс на справжньому транспорті `fetch`, який читає змінні, названі його префіксом. |
+
+### Змінні оточення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="integration-PREFIX-BASE-URL-environment-variable">`<PREFIX>_BASE_URL`</span> | `refuses` | — | Адреса, під яку йде кожен виклик до цього зовнішнього сервісу. |
+| <span id="integration-PREFIX-TIMEOUT-MILLIS-environment-variable">`<PREFIX>_TIMEOUT_MILLIS`</span> | `falls back` | `3000` | Скільки мілісекунд може тривати один виклик, перш ніж рахуватись мережевою невдачею. |
+
+## postgres
+
+Імпорт із `@satorio/machinery/postgres` — [ціла сторінка](../mechanisms/postgres.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="postgres-AdvisoryLock-value">`AdvisoryLock`</span> | `interface` | — | Замок, який хтось інший може вже тримати: його назва, спроба взяти його і звільнення, що йде слідом. |
+| <span id="postgres-DEFAULT-APPLICATION-NAME-value">`DEFAULT_APPLICATION_NAME`</span> | `const` | — | Назва, під якою цей сервіс видно у власному списку з'єднань бази, коли її ніхто не називає. |
+| <span id="postgres-DEFAULT-AUTH-MODE-value">`DEFAULT_AUTH_MODE`</span> | `'iam' \| 'password'` | — | Як сервіс доводить, хто він, коли ніщо не каже інакше. |
+| <span id="postgres-DEFAULT-POSTGRES-PORT-value">`DEFAULT_POSTGRES_PORT`</span> | `const` | — | Порт, на якому слухає сервер Postgres, коли ніхто не каже інакше. |
+| <span id="postgres-DEFAULT-POSTGRES-SCHEMA-value">`DEFAULT_POSTGRES_SCHEMA`</span> | `const` | — | Схема, проти якої біжить кожен запит, коли ніхто її не називає. |
+| <span id="postgres-DEFAULT-POSTGRES-SSL-MODE-value">`DEFAULT_POSTGRES_SSL_MODE`</span> | `PostgresSslMode` | — | Як шифрується з'єднання, коли ніхто не каже інакше: ланцюг перевіряють, тож безпечний вибір — той, який ви дістаєте, не сказавши нічого. |
+| <span id="postgres-ENVIRONMENT-value">`ENVIRONMENT`</span> | `readonly EnvironmentEntry[]` | — | Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них. |
+| <span id="postgres-MACHINERY-MIGRATIONS-DIRECTORY-value">`MACHINERY_MIGRATIONS_DIRECTORY`</span> | `const` | — | Директорія зі спільними міграціями (migration) машинерії: реєстр відпрацьованих подій і буфер трансмітера. |
+| <span id="postgres-MIGRATION-LOCK-NAME-value">`MIGRATION_LOCK_NAME`</span> | `const` | — | Назва, з якої будують кожен замок міграцій, тож один читач знаходить їх усі. |
+| <span id="postgres-POSTGRES-SSL-MODES-value">`POSTGRES_SSL_MODES`</span> | `const` | — | Кожен спосіб зашифрувати й перевірити з'єднання — від жодного шифрування до цілком перевіреного ланцюга. |
+| <span id="postgres-PostgresAuthentication-value">`PostgresAuthentication`</span> | `type` | — | Два способи довести базі, хто ви: короткоживучий токен IAM або пароль. |
+| <span id="postgres-PostgresConnectionSettings-value">`PostgresConnectionSettings`</span> | `interface` | — | Усе, що потрібно одному з'єднанню, прочитане за раз: де сервер, хто під'єднується і як з'єднання доводять та шифрують. |
+| <span id="postgres-postgresConnectionSettings-value">`postgresConnectionSettings`</span> | `Config.Config<PostgresConnectionSettings>` | — | Кожна змінна з `ENVIRONMENT`, прочитана за раз. |
+| <span id="postgres-PostgresPorts-value">`PostgresPorts`</span> | `type` | — | Порти, які реалізує цей механізм, названі разом одним типом. |
+| <span id="postgres-PostgresSslMode-value">`PostgresSslMode`</span> | `(typeof POSTGRES_SSL_MODES)[number]` | — | Один зі способів зашифрувати й перевірити з'єднання. |
+| <span id="postgres-READINESS-QUERY-DEADLINE-MILLIS-value">`READINESS_QUERY_DEADLINE_MILLIS`</span> | `const` | — | Скільки проба чекає на свій запит, перш ніж звітувати «лежить». |
+| <span id="postgres-READINESS-REASON-WHEN-THE-DATABASE-STAYS-SILENT-value">`READINESS_REASON_WHEN_THE_DATABASE_STAYS_SILENT`</span> | `const` | — | Причина, про яку звітують, коли запит готовності відповідає відмовою. |
+| <span id="postgres-READINESS-REASON-WHEN-THE-QUERY-TIMES-OUT-value">`READINESS_REASON_WHEN_THE_QUERY_TIMES_OUT`</span> | `const` | — | Причина, про яку звітують, коли запитові готовності виходить строк. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="postgres-applyMigrations-procedure">`applyMigrations`</span> | `(directories: readonly string[] = [MACHINERY_MIGRATIONS_DIRECTORY])` | — | Застосовує міграції, що чекають, із поданих директорій: спершу власна директорія машинерії, тоді директорія викликача. |
+| <span id="postgres-configProviderPreferring-procedure">`configProviderPreferring`</span> | `(primary: ConfigProvider.ConfigProvider, fallbackKey: string, fallbackValue: string) => ConfigProvider.ConfigProvider` | — | Будує постачальника конфігурації, який читає з `primary` і падає на одне фіксоване значення, коли в `primary` такого ключа немає. |
+| <span id="postgres-firstRow-procedure">`firstRow`</span> | `<A>(rows: readonly A[]) => Option.Option<A>` | — | Повертає перший рядок або `Option.none()` для порожнього результату. |
+| <span id="postgres-holdingAdvisoryLock-procedure">`holdingAdvisoryLock`</span> | `<ELock, RLock, ScheduleOut, RSchedule>(lock: AdvisoryLock<ELock, RLock>, retryWhileBusy: Schedule.Schedule<ScheduleOut, unknown, RSchedule>)` | — | Виконує ефект, тримаючи замок, чекає за поданим розкладом, поки замок тримає хтось інший, і відпускає його, хай як ефект скінчиться. |
+| <span id="postgres-isUniqueViolation-procedure">`isUniqueViolation`</span> | `(error: SqlError) => boolean` | — | Чи ця відмова драйвера є дублем ключа, а не чимось іншим, чому база могла б відмовити. |
+| <span id="postgres-jsonbValue-procedure">`jsonbValue`</span> | `(sql: SqlClient.SqlClient, value: unknown) => Fragment` | — | Подає значення в колонку `jsonb` як JSON, хай яка в нього форма. |
+| <span id="postgres-migrationLockNameFor-procedure">`migrationLockNameFor`</span> | `(schema: string) => string` | — | Замок, який беруть міграції однієї схеми, тож два сервіси, що мігрують дві схеми, ніколи не чекають один одного. |
+| <span id="postgres-onUniqueViolation-procedure">`onUniqueViolation`</span> | `<Conflict, Unavailable>(operation: string, branches: { readonly unique: () => Conflict; readonly unavailable: ( operation: string, ) => (cause: unknown) => Unavailable })` | — | Ділить шлях запису на межі бази: порушення унікальності стає доменним конфліктом, будь-який інший `SqlError` стає «сховище недоступне». |
+| <span id="postgres-postgresAdvisoryLock-procedure">`postgresAdvisoryLock`</span> | `(name: string) => AdvisoryLock<SqlError.SqlError, SqlClient.SqlClient>` | — | Названий консультативний замок на власній базі цього з'єднання. |
+| <span id="postgres-readinessProbeAsking-procedure">`readinessProbeAsking`</span> | `(aQueryTheDatabaseMustAnswer: Effect.Effect<unknown, SqlError>)` | — | Будує пробу навколо одного запиту, на який має відповісти база, зі строком над ним, тож недосяжна база звітує «лежить», а не зависає. |
+| <span id="postgres-reportApplied-procedure">`reportApplied`</span> | `(applied: ReadonlyArray<readonly [number, string]>) => Effect.Effect<void>` | — | Каже одним рядком, що прогін застосував, або що база вже поточна. |
+| <span id="postgres-schemaDefaultingTo-procedure">`schemaDefaultingTo`</span> | `(schema: string) => ConfigProvider.ConfigProvider` | — | Схема за замовчуванням для одного сервісу, коли `PGSCHEMA` не поставлено. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="postgres-MigrationPgClientLive-adapter">`MigrationPgClientLive`</span> | `Layer.Layer<PgClient.PgClient \| SqlClient.SqlClient, ConfigError \| PlatformError \| SqlError, FileSystem.FileSystem>` | — | Клієнт, яким користується виконавець міграцій: одне з'єднання під власною назвою. |
+| <span id="postgres-PgDocumentNumberCounterLive-adapter">`PgDocumentNumberCounterLive`</span> | `Layer.Layer<DocumentNumberCounter, never, PgClient.PgClient>` | — | Лічильник номерів документів на справжній таблиці `document_number_counter`. |
+| <span id="postgres-PgIntegrationEventOutboxLive-adapter">`PgIntegrationEventOutboxLive`</span> | `Layer.Layer<IntegrationEventOutbox, never, PgClient.PgClient>` | — | Буфер трансмітера на справжній таблиці `integration_event_outbox`. |
+| <span id="postgres-PgProcessedEventRegistryLive-adapter">`PgProcessedEventRegistryLive`</span> | `Layer.Layer<ProcessedEventRegistry, never, PgClient.PgClient>` | — | Резервація рівно один раз на справжній таблиці `processed_event`. |
+| <span id="postgres-PgReadinessProbeLive-adapter">`PgReadinessProbeLive`</span> | `Layer.Layer<ReadinessProbe, never, SqlClient.SqlClient>` | — | Проба готовності на одному `SELECT 1` проти власного пулу сервісу. |
+| <span id="postgres-PgTransactionBoundaryLive-adapter">`PgTransactionBoundaryLive`</span> | `Layer.Layer<TransactionBoundary, never, SqlClient.SqlClient>` | — | Межа транзакції на справжній транзакції Postgres. |
+| <span id="postgres-PostgresClientLive-adapter">`PostgresClientLive`</span> | `Layer.Layer<PgClient.PgClient \| SqlClient.SqlClient, ConfigError \| PlatformError \| SqlError, FileSystem.FileSystem>` | — | Клієнт `@effect/sql-pg`, на якому стоїть кожен інший шар тут, відкритий з оточення, яке називає `settings.ts`. |
+| <span id="postgres-PostgresPortsLive-adapter">`PostgresPortsLive`</span> | `Layer.Layer<PostgresPorts \| PgClient.PgClient \| SqlClient.SqlClient, ConfigError \| PlatformError \| SqlError, FileSystem.FileSystem>` | — | Кожен порт, який реалізує цей механізм, на одному клієнті, для сервісу, що подає власну `FileSystem`. |
+| <span id="postgres-PostgresPortsOnBunLive-adapter">`PostgresPortsOnBunLive`</span> | `Layer.Layer<PostgresPorts \| PgClient.PgClient \| SqlClient.SqlClient, ConfigError \| PlatformError \| SqlError>` | — | Той самий набір на власній файловій системі Bun, і це вся частина машинерії з боку Postgres в одному шарі. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="postgres-MigrationLockBusyError-failure">`MigrationLockBusyError`</span> | `Data.TaggedError<{ readonly lockName: string }>` | — | Другий процес уже тримає замок міграцій і не відпустив його у вікні спроб. |
+
+### Змінні оточення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="postgres-PGHOST-environment-variable">`PGHOST`</span> | `refuses` | — | Хост, проти якого цей сервіс відкриває свій пул з'єднань. |
+| <span id="postgres-PGPORT-environment-variable">`PGPORT`</span> | `falls back` | `5432` | Порт TCP, на якому слухає база. |
+| <span id="postgres-PGUSER-environment-variable">`PGUSER`</span> | `refuses` | — | Роль Postgres, під якою під'єднується цей сервіс. |
+| <span id="postgres-PGDATABASE-environment-variable">`PGDATABASE`</span> | `refuses` | — | База, яку цей сервіс читає і пише. |
+| <span id="postgres-PGSCHEMA-environment-variable">`PGSCHEMA`</span> | `falls back` | `app` | Схема, проти якої біжить кожен запит, поставлена як `search_path` з'єднання. |
+| <span id="postgres-PGAPPNAME-environment-variable">`PGAPPNAME`</span> | `falls back` | `machinery` | Назва, під якою цей сервіс видно в `pg_stat_activity`. |
+| <span id="postgres-PGSSLMODE-environment-variable">`PGSSLMODE`</span> | `falls back` | `verify-full` | Як з'єднання шифрують і перевіряють; один із `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`. |
+| <span id="postgres-PGSSLROOTCERT-environment-variable">`PGSSLROOTCERT`</span> | `handed on` | — | Шлях до файлу центру сертифікації, проти якого перевіряють ланцюг бази. |
+| <span id="postgres-AUTH-MODE-environment-variable">`AUTH_MODE`</span> | `falls back` | `password` | Котрим із двох способів цей сервіс доводить, хто він: `iam` чи `password`. |
+| <span id="postgres-PGPASSWORD-environment-variable">`PGPASSWORD`</span> | `refuses` | — | Пароль бази, який читають у режимі `password` за замовчуванням. |
+| <span id="postgres-AWS-REGION-environment-variable">`AWS_REGION`</span> | `handed on` | — | Регіон, проти якого підписує підписувач токенів IAM; його читають при `AUTH_MODE=iam`. |
+
+## publishing
+
+Імпорт із `@satorio/machinery/publishing` — [ціла сторінка](../mechanisms/publishing.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="publishing-DEFAULT-EVENT-CHANNEL-value">`DEFAULT_EVENT_CHANNEL`</span> | `const` | — | Канал лога, під яким публікатор на stdout пише свої події, коли ніхто не назвав іншого. |
+| <span id="publishing-ENVIRONMENT-value">`ENVIRONMENT`</span> | `readonly EnvironmentEntry[]` | — | Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них. |
+| <span id="publishing-SnsPublisherSettings-value">`SnsPublisherSettings`</span> | `interface` | — | Що потрібно публікаторові SNS, перш ніж він надішле: один топік і дві змінні, які AWS SDK читає сам, коли їх ніхто не називає. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="publishing-snsMessageBodyOf-procedure">`snsMessageBodyOf`</span> | `(message: OutboxMessage) => string` | — | Тіло повідомлення, яке читає підписник: той самий конверт, що й рядок на stdout, без каналу — тут цю роль грає сам топік. |
+| <span id="publishing-snsPublisherSettings-procedure">`snsPublisherSettings`</span> | `(variablePrefix: string) => Config.Config<SnsPublisherSettings>` | — | Читає кожну змінну, потрібну публікаторові SNS, під одним префіксом. |
+| <span id="publishing-stdoutLineOf-procedure">`stdoutLineOf`</span> | `(channel: string, message: OutboxMessage) => string` | — | Найпростіший публікатор: подія мандрує одним рядком JSON на stdout, звідки її забирає збирач логів. |
+| <span id="publishing-topicArnVariable-procedure">`topicArnVariable`</span> | `(variablePrefix: string) => string` | — | Будує назву змінної оточення з префікса, який застосунок дає під час монтування. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="publishing-snsEventPublisherLive-adapter">`snsEventPublisherLive`</span> | `(variablePrefix: string) => Layer.Layer<EventPublisher, ConfigError.ConfigError>` | — | Публікатор SNS на справжньому транспорті AWS SDK, який читає змінні, названі цим префіксом. |
+| <span id="publishing-StdoutEventPublisherLive-adapter">`StdoutEventPublisherLive`</span> | `Layer.Layer<EventPublisher>` | — | Змонтований публікатор на stdout: один рядок JSON на подію під каналом, який називає `EVENT_CHANNEL`. |
+
+### Змінні оточення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="publishing-PREFIX-TOPIC-ARN-environment-variable">`<PREFIX>_TOPIC_ARN`</span> | `refuses` | — | Топік SNS, до якого цей публікатор надсилає події. |
+| <span id="publishing-EVENT-CHANNEL-environment-variable">`EVENT_CHANNEL`</span> | `falls back` | `machinery-integration-events` | Слово, за яким збирач логів фільтрує рядки публікатора на stdout. |
+| <span id="publishing-AWS-REGION-environment-variable">`AWS_REGION`</span> | `handed on` | — | Регіон, з яким говорить клієнт SNS. |
+| <span id="publishing-AWS-ENDPOINT-URL-environment-variable">`AWS_ENDPOINT_URL`</span> | `handed on` | — | Локальний стенд, з яким говорити замість справжнього SNS, наприклад localstack. |
+
+## queue
+
+Імпорт із `@satorio/machinery/queue` — [ціла сторінка](../mechanisms/queue.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="queue-defaultQueueRetrySchedule-value">`defaultQueueRetrySchedule`</span> | `QueueRetrySchedule` | — | Очікування, якого тримається робітник, коли сервіс не називає власного розкладу: зростальні паузи, з джитером, і межа на кількість спроб. |
+| <span id="queue-ENVIRONMENT-value">`ENVIRONMENT`</span> | `readonly EnvironmentEntry[]` | — | Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них. |
+| <span id="queue-EventDefinitionRegistry-value">`EventDefinitionRegistry`</span> | `interface` | — | Що пропонує власний список визначень подій сервісу: чи тип події відомий і яке визначення за ним стоїть. |
+| <span id="queue-IncomingQueueMessage-value">`IncomingQueueMessage`</span> | `interface` | — | Одне повідомлення таким, яким його зустрічає обробник: власні поля конверта і сама декодована подія. |
+| <span id="queue-PayloadDecoder-value">`PayloadDecoder`</span> | `type` | — | Те, що перетворює збережений payload якоїсь версії на подію, з якою працює обробник. |
+| <span id="queue-QueueConsumerSettings-value">`QueueConsumerSettings`</span> | `interface` | — | Що потрібно робітникові, перш ніж він отримає бодай одне повідомлення. |
+| <span id="queue-QueueMessageBody-value">`QueueMessageBody`</span> | `const` | — | Конверт таким, яким він мандрує: текст JSON на дроті, прочитаний і записаний однією схемою. |
+| <span id="queue-QueueMessageConsumerOptions-value">`QueueMessageConsumerOptions`</span> | `interface` | — | Що потрібно робітникові, щоб перетворити повідомлення черги на роботу. |
+| <span id="queue-QueueMessageOutcome-value">`QueueMessageOutcome`</span> | `type` | — | Доля одного повідомлення має рівно три кінці: підтверджено, лишено на перевідправку або відмовлено назавжди. |
+| <span id="queue-QueueProducerSettings-value">`QueueProducerSettings`</span> | `interface` | — | Що потрібно відправникові, перш ніж він надішле: черга і ті самі дві змінні, які SDK вирішує сам. |
+| <span id="queue-QueueRetrySchedule-value">`QueueRetrySchedule`</span> | `type` | — | Як робітник чекає і пробує знову, поки сама черга не відповідає. |
+| <span id="queue-RedeliveryReason-value">`RedeliveryReason`</span> | `type` | — | Чому повідомлення повертається в чергу: воно так і не декодувалось, або обробник його відхилив. |
+| <span id="queue-SchemaVersion-value">`SchemaVersion`</span> | `const` | — | Версія, якою надано форми збереженому payload: ціле число понад нуль і ніколи нічого іншого. |
+| <span id="queue-SQS-DEFAULT-VISIBILITY-TIMEOUT-SECONDS-value">`SQS_DEFAULT_VISIBILITY_TIMEOUT_SECONDS`</span> | `const` | — | Скільки отримане повідомлення лишається схованим, поки над ним працює обробник, коли ніхто не назвав числа. |
+| <span id="queue-StoredEventEnvelope-value">`StoredEventEnvelope`</span> | `const` | — | Спільний контракт черги, у якому мандрує кожне повідомлення. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="queue-consumeQueueMessages-procedure">`consumeQueueMessages`</span> | `<A, E, R>(options: QueueMessageConsumerOptions<A, E, R>) => Stream.Stream<QueueMessageOutcome, QueueMessageSourceUnavailableError, R \| QueueMessageSource>` | — | Читає повідомлення з черги і віддає кожне обробникові, відповідаючи долею кожного взятого повідомлення. |
+| <span id="queue-decodeQueueMessageBody-procedure">`decodeQueueMessageBody`</span> | `(body: string) => Effect.Effect<StoredEventEnvelope, QueueMessageNotDecodableError>` | — | Читає тіло повідомлення в конверт або відмовляє вже на конверті й каже, чого не змогло прочитати. |
+| <span id="queue-eventDefinitionRegistry-procedure">`eventDefinitionRegistry`</span> | `<S extends Schema.Schema.AnyNoContext>(definitions: readonly VersionedEventDefinition<S>[]) => EventDefinitionRegistry<S>` | — | Будує реєстр відомих визначень подій. |
+| <span id="queue-handlerRejectedMessage-procedure">`handlerRejectedMessage`</span> | `(error: unknown) => RedeliveryReason` | — | Причина для повідомлення, яке відхилив сам обробник. |
+| <span id="queue-messageAcknowledged-procedure">`messageAcknowledged`</span> | `(messageId: string) => QueueMessageOutcome` | — | Доля повідомлення, яке обробник узяв, тож черга може його викинути. |
+| <span id="queue-messageLeftForRedelivery-procedure">`messageLeftForRedelivery`</span> | `(messageId: string, reason: RedeliveryReason) => QueueMessageOutcome` | — | Доля повідомлення, яке повертається в чергу, разом із причиною, чому воно повернулось. |
+| <span id="queue-messageNotDecodable-procedure">`messageNotDecodable`</span> | `(error: QueueMessageNotDecodableError) => RedeliveryReason` | — | Причина для повідомлення, яке так і не декодувалось. |
+| <span id="queue-messageRefusedPermanently-procedure">`messageRefusedPermanently`</span> | `(messageId: string, eventId: string, refusal: unknown) => QueueMessageOutcome` | — | Доля повідомлення, якому не поможе жодна спроба, тож далі його бере власний redrive платформи. |
+| <span id="queue-payloadDecoderFor-procedure">`payloadDecoderFor`</span> | `<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>) => PayloadDecoder<Schema.Schema.Type<S>>` | — | Будує декодер payload для одного визначення події, підіймаючи збережений payload до версії, яку знає цей код. |
+| <span id="queue-queueConsumerSettings-procedure">`queueConsumerSettings`</span> | `(variablePrefix: string) => Config.Config<QueueConsumerSettings>` | — | Читає кожну змінну, потрібну робітникові, під одним префіксом. |
+| <span id="queue-queueMessageBodyOf-procedure">`queueMessageBodyOf`</span> | `(envelope: { readonly eventId: string; readonly eventType: string; readonly schemaVersion: number; readonly occurredAtIso: string; readonly payload: { readonly [key: string]: unknown } }) => string` | — | Будує той самий контракт конверта, але для надсилання: відправник ставить рівно ті поля, які очікує прочитати робітник. |
+| <span id="queue-queueProducerSettings-procedure">`queueProducerSettings`</span> | `(variablePrefix: string) => Config.Config<QueueProducerSettings>` | — | Читає кожну змінну, потрібну відправникові, під одним префіксом. |
+| <span id="queue-queueReadinessCheck-procedure">`queueReadinessCheck`</span> | `(variablePrefix: string) => Effect.Effect<Option.Option<Effect.Effect<void, QueueMessageSourceUnavailableError>>, ConfigError.ConfigError>` | — | Перевірка готовності для черги, відсутня тоді, коли жодної черги не змонтовано. |
+| <span id="queue-queueUrlVariable-procedure">`queueUrlVariable`</span> | `(variablePrefix: string) => string` | — | Будує назву змінної оточення з префікса, який застосунок дає під час монтування. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="queue-sqsQueueMessageProducerLive-adapter">`sqsQueueMessageProducerLive`</span> | `(variablePrefix: string) => Layer.Layer<QueueMessageProducer, ConfigError.ConfigError>` | — | Відправник повідомлень на справжньому транспорті AWS SDK, який читає змінні, названі цим префіксом. |
+| <span id="queue-sqsQueueMessageSourceLive-adapter">`sqsQueueMessageSourceLive`</span> | `(variablePrefix: string) => Layer.Layer<QueueMessageSource, ConfigError.ConfigError>` | — | Джерело повідомлень на справжньому транспорті AWS SDK, яке читає змінні, названі цим префіксом. |
+
+### Відмови
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="queue-QueueMessageNotDecodableError-failure">`QueueMessageNotDecodableError`</span> | `Data.TaggedError<{ readonly stage: QueueMessageDecodingStage; readonly cause: unknown }>` | — | Повідомлення, текст якого цей сервіс не може перетворити на подію. |
+| <span id="queue-UnknownEventTypeError-failure">`UnknownEventTypeError`</span> | `Data.TaggedError<{ readonly eventType: string }>` | — | Повідомлення, яке називає тип події, що його цей сервіс ніколи не реєстрував. |
+
+### Змінні оточення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="queue-PREFIX-QUEUE-URL-environment-variable">`<PREFIX>_QUEUE_URL`</span> | `refuses` | — | Черга, з якої отримує робітник і в яку надсилає відправник. |
+| <span id="queue-PREFIX-MAX-MESSAGES-PER-RECEIVE-environment-variable">`<PREFIX>_MAX_MESSAGES_PER_RECEIVE`</span> | `falls back` | `10` | Скільки повідомлень просить один виклик отримання. |
+| <span id="queue-PREFIX-WAIT-TIME-SECONDS-environment-variable">`<PREFIX>_WAIT_TIME_SECONDS`</span> | `falls back` | `20` | Скільки секунд виклик отримання чекає на повідомлення, перш ніж повернутись порожнім. |
+| <span id="queue-PREFIX-VISIBILITY-TIMEOUT-SECONDS-environment-variable">`<PREFIX>_VISIBILITY_TIMEOUT_SECONDS`</span> | `falls back` | `60` | Скільки секунд отримане повідомлення лишається схованим від інших робітників. |
+| <span id="queue-AWS-REGION-environment-variable">`AWS_REGION`</span> | `handed on` | — | Регіон, з яким говорить клієнт SQS. |
+| <span id="queue-AWS-ENDPOINT-URL-environment-variable">`AWS_ENDPOINT_URL`</span> | `handed on` | — | Локальний стенд, з яким говорити замість справжнього SQS, наприклад localstack. |
+
+## storage
+
+Імпорт із `@satorio/machinery/storage` — [ціла сторінка](../mechanisms/storage.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="storage-BlobStoreSettings-value">`BlobStoreSettings`</span> | `interface` | — | Що потрібно сховищу, перш ніж воно заговорить зі сховищем об'єктів. |
+| <span id="storage-ClosableS3Transport-value">`ClosableS3Transport`</span> | `interface` | — | Транспорт, який ще й закривається, тож клієнта за ним відпускають, коли скоуп навколо нього кінчається. |
+| <span id="storage-DEFAULT-CONTENT-TYPE-value">`DEFAULT_CONTENT_TYPE`</span> | `const` | — | Чим читається об'єкт, коли сховище не подає власного типу вмісту: просто байтами. |
+| <span id="storage-ENVIRONMENT-value">`ENVIRONMENT`</span> | `readonly EnvironmentEntry[]` | — | Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них. |
+| <span id="storage-S3FetchedObject-value">`S3FetchedObject`</span> | `interface` | — | Один об'єкт таким, яким його віддає сховище: його байти, а також тип вмісту й метадані, коли він їх несе. |
+| <span id="storage-S3KeyRequest-value">`S3KeyRequest`</span> | `interface` | — | Один названий об'єкт: бакет, у якому він сидить, і ключ, під яким він сидить. |
+| <span id="storage-S3ObjectTransport-value">`S3ObjectTransport`</span> | `interface` | — | Вузький зріз сховища об'єктів, який кличе сховище об'єктів: покласти, взяти, перевірити, видалити — і більш нічого. |
+| <span id="storage-S3PutRequest-value">`S3PutRequest`</span> | `interface` | — | Найвужчий зріз SDK, яким користується сховище: покласти, взяти, перевірити наявність, видалити. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="storage-blobStoreSettings-procedure">`blobStoreSettings`</span> | `(variablePrefix: string) => Config.Config<BlobStoreSettings>` | — | Читає кожну змінну з `ENVIRONMENT` під одним префіксом. |
+| <span id="storage-blobStoreUnavailableWithoutConfiguration-procedure">`blobStoreUnavailableWithoutConfiguration`</span> | `(refusal: Refusal) => BlobStoreShape` | — | Без поставленого бакета сховище не валить старт сервісу: воно монтує заглушку, яка гучно валить кожну операцію. |
+| <span id="storage-bucketVariable-procedure">`bucketVariable`</span> | `(variablePrefix: string) => string` | — | Будує назву змінної оточення з префікса, який застосунок дає під час монтування. |
+| <span id="storage-makeS3BlobStore-procedure">`makeS3BlobStore`</span> | `(transport: S3ObjectTransport, settings: BlobStoreSettings) => BlobStoreShape` | — | Будує сховище об'єктів над одним транспортом і одним бакетом, обертаючи власний спосіб сховища сигналити про відсутній ключ на відсутнє значення. |
+| <span id="storage-openS3Transport-procedure">`openS3Transport`</span> | `(settings: BlobStoreSettings) => ClosableS3Transport` | — | Відкриває справжнього клієнта сховища об'єктів під подані налаштування і є єдиним місцем, де того клієнта створюють. |
+| <span id="storage-scopedS3Transport-procedure">`scopedS3Transport`</span> | `(openTransport: () => ClosableS3Transport) => Effect.Effect<S3ObjectTransport, never, Scope.Scope>` | — | Відкриває транспорт, який закривається разом зі скоупом навколо нього, тож жоден клієнт не переживає роботи, яка його відкрила. |
+| <span id="storage-signalsAbsentKey-procedure">`signalsAbsentKey`</span> | `(error: unknown) => boolean` | — | S3 сигналить «немає такого ключа» помилкою, а не порожньою відповіддю: `GetObject` кидає `NoSuchKey`, `HeadObject` кидає `NotFound`. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="storage-blobStoreFromEnvironmentLive-adapter">`blobStoreFromEnvironmentLive`</span> | `(variablePrefix: string, openTransport: (settings: BlobStoreSettings) => ClosableS3Transport) => Layer.Layer<BlobStore, ConfigError.ConfigError>` | — | Сховище об'єктів, зібране зі змінних оточення з поданим префіксом. |
+| <span id="storage-s3BlobStoreLive-adapter">`s3BlobStoreLive`</span> | `(variablePrefix: string) => Layer.Layer<BlobStore, ConfigError.ConfigError>` | — | Сховище об'єктів на справжньому транспорті AWS SDK, яке читає змінні, названі цим префіксом. |
+
+### Змінні оточення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="storage-PREFIX-BUCKET-environment-variable">`<PREFIX>_BUCKET`</span> | `refuses` | — | Бакет, у який це сховище кладе об'єкти і з якого читає їх назад. |
+| <span id="storage-AWS-REGION-environment-variable">`AWS_REGION`</span> | `handed on` | — | Регіон, з яким говорить клієнт S3. |
+| <span id="storage-AWS-ENDPOINT-URL-environment-variable">`AWS_ENDPOINT_URL`</span> | `handed on` | — | Локальний стенд, з яким говорити замість справжнього S3, наприклад localstack. |
+
+## testing
+
+Імпорт із `@satorio/machinery/testing` — [ціла сторінка](../mechanisms/testing.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="testing-AnswersByPath-value">`AnswersByPath`</span> | `Readonly<Record<string, unknown>>` | — | Чим відповідає клієнт у пам'яті: одне вже декодоване тіло на кожен шлях. |
+| <span id="testing-BlobsByKey-value">`BlobsByKey`</span> | `ReadonlyMap<string, StoredBlob>` | — | Що тримає сховище об'єктів у пам'яті: кожен об'єкт, який йому дали, за ключем. |
+| <span id="testing-DispatchedMessageIds-value">`DispatchedMessageIds`</span> | `ReadonlySet<string>` | — | Що тримає буфер трансмітера в пам'яті з боку читання: ідентифікатори, які трансмітер уже позначив надісланими. |
+| <span id="testing-DocumentCountsByClientAndMonth-value">`DocumentCountsByClientAndMonth`</span> | `ReadonlyMap<string, number>` | — | Що тримає лічильник у пам'яті: скільки документів дістав кожен клієнт у кожен звітний місяць, за ключем із них двох. |
+| <span id="testing-InMemoryBlobStoreLive-value">`InMemoryBlobStoreLive`</span> | `const` | — | Змонтоване сховище об'єктів у пам'яті. |
+| <span id="testing-InMemoryDocumentNumberCounterLive-value">`InMemoryDocumentNumberCounterLive`</span> | `const` | — | Змонтований лічильник у пам'яті. |
+| <span id="testing-InMemoryEventPublisherLive-value">`InMemoryEventPublisherLive`</span> | `const` | — | Змонтований публікатор у пам'яті. |
+| <span id="testing-InMemoryIntegrationEventOutboxLive-value">`InMemoryIntegrationEventOutboxLive`</span> | `const` | — | Змонтований буфер трансмітера в пам'яті. |
+| <span id="testing-InMemoryProcessedEventRegistryLive-value">`InMemoryProcessedEventRegistryLive`</span> | `const` | — | Змонтований реєстр у пам'яті. |
+| <span id="testing-InMemoryQueueMessageProducerLive-value">`InMemoryQueueMessageProducerLive`</span> | `const` | — | Змонтований відправник у пам'яті. |
+| <span id="testing-InMemoryQueueMessageSourceLive-value">`InMemoryQueueMessageSourceLive`</span> | `const` | — | Змонтоване джерело повідомлень у пам'яті. |
+| <span id="testing-makeInMemoryBlobStore-value">`makeInMemoryBlobStore`</span> | `const` | — | Сховище об'єктів у пам'яті над власним `Ref`, порожнє на початку. |
+| <span id="testing-makeInMemoryDocumentNumberCounter-value">`makeInMemoryDocumentNumberCounter`</span> | `const` | — | Лічильник у пам'яті над власним `Ref`, де кожен місяць стоїть на нулі. |
+| <span id="testing-makeInMemoryEventPublisher-value">`makeInMemoryEventPublisher`</span> | `const` | — | Публікатор у пам'яті над власним `Ref`, порожній на початку. |
+| <span id="testing-makeInMemoryIntegrationEventOutbox-value">`makeInMemoryIntegrationEventOutbox`</span> | `const` | — | Буфер трансмітера в пам'яті над власними `Ref`, порожній на початку. |
+| <span id="testing-makeInMemoryProcessedEventRegistry-value">`makeInMemoryProcessedEventRegistry`</span> | `const` | — | Реєстр у пам'яті над власним `Ref`, порожній на початку. |
+| <span id="testing-makeInMemoryQueueMessageProducer-value">`makeInMemoryQueueMessageProducer`</span> | `const` | — | Відправник у пам'яті над власним `Ref`, чиїх повідомлень ніхто не отримує. |
+| <span id="testing-makeInMemoryQueueMessageSource-value">`makeInMemoryQueueMessageSource`</span> | `const` | — | Джерело повідомлень у пам'яті над власним `Ref`, порожнє на початку. |
+| <span id="testing-nowAsDateTime-value">`nowAsDateTime`</span> | `Effect.Effect<DateTime.Utc>` | — | Мить, яку годинник читає зараз, як мить на світовому годиннику. |
+| <span id="testing-nowAsIsoString-value">`nowAsIsoString`</span> | `Effect.Effect<string>` | — | Мить, яку годинник читає зараз, написана так, як вона мандрує дротом. |
+| <span id="testing-PendingQueueMessages-value">`PendingQueueMessages`</span> | `readonly RawQueueMessage[]` | — | Що тримає черга в пам'яті: повідомлення, які чекають на отримання, у тому порядку, в якому їх туди поклали. |
+| <span id="testing-ProcessedEventsById-value">`ProcessedEventsById`</span> | `ReadonlyMap<string, DateTime.Utc>` | — | Що тримає реєстр у пам'яті: мить, коли кожен ідентифікатор події зарезервували вперше. |
+| <span id="testing-PublishedMessages-value">`PublishedMessages`</span> | `readonly OutboxMessage[]` | — | Що тримає публікатор у пам'яті: кожне повідомлення, яке йому подали, у порядку, в якому приходили пачки. |
+| <span id="testing-QueuedOutboxMessages-value">`QueuedOutboxMessages`</span> | `readonly OutboxMessage[]` | — | Що тримає буфер трансмітера в пам'яті з боку запису: кожне поставлене в чергу повідомлення, у порядку, в якому воно прийшло. |
+| <span id="testing-QuietReporter-value">`QuietReporter`</span> | `class` | — | Репортер виконавця тестів (test runner), який друкує один підсумковий рядок на цілий прогін: скільки файлів, скільки тестів, скільки це тривало. |
+| <span id="testing-Scenario-value">`Scenario`</span> | `interface` | — | Історія, розказана даними: кроки, якими проходить світ, і числа, на яких той світ спиняється. |
+| <span id="testing-ScenarioPlayback-value">`ScenarioPlayback`</span> | `interface` | — | Що лишає по собі один прогін сценарію (scenario): мітка кожного кроку і знімок, на якому прогін скінчився. |
+| <span id="testing-ScenarioService-value">`ScenarioService`</span> | `interface` | — | Що сервіс дає програвачеві сценаріїв: як виконати крок і як зняти знімок того, що з нього вийшло. |
+| <span id="testing-ScenarioStep-value">`ScenarioStep`</span> | `interface` | — | Один крок у сценарії. |
+| <span id="testing-SUITES-THAT-START-A-STAND-value">`SUITES_THAT_START_A_STAND`</span> | `readonly string[]` | — | Сьюти, які піднімають живий стенд (live stand), за іменем файлу, яке дає їм `A11`. |
+| <span id="testing-TransactionalState-value">`TransactionalState`</span> | `interface` | — | Один учасник транзакції в пам'яті: він уміє захопити власний стан зараз і подати назад ефект, який його повертає. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="testing-advanceBy-procedure">`advanceBy`</span> | `(duration: Duration.DurationInput) => Effect.Effect<void>` | — | Рухає керований тестовий годинник на подану тривалість, тож тест доходить до пізнішої миті, не чекаючи на неї. |
+| <span id="testing-atTheMoment-procedure">`atTheMoment`</span> | `(isoTimestamp: string)` | — | Виконує подану роботу «в» подану мить: кожне читання годинника всередині бачить `isoTimestamp`. |
+| <span id="testing-clockPinnedAt-procedure">`clockPinnedAt`</span> | `(at: DateTime.Utc) => Clock.Clock` | — | Будує `Clock`, пришпилений до однієї миті: кожне читання часу всередині повертає ту мить, а `sleep` і далі чекає за справжнім годинником. |
+| <span id="testing-contextOf-procedure">`contextOf`</span> | `<Command, Snapshot, Context>(scenario: Scenario<Command, Snapshot, Context>) => Context` | — | Читає наскрізні дані сценарію, який їх оголошує. |
+| <span id="testing-distinctMomentsIn-procedure">`distinctMomentsIn`</span> | `(table: string, column: string) => Effect.Effect<readonly string[], never, SqlClient.SqlClient>` | — | Читає різні миті з однієї колонки часових позначок як відсортовані рядки ISO в тому самому вигляді, який `momentsOfSteps` повертає для сценарію. |
+| <span id="testing-emptiedTables-procedure">`emptiedTables`</span> | `(tables: readonly string[]) => Effect.Effect<void, never, SqlClient.SqlClient>` | — | Спорожнює подані таблиці на живому стенді, щоб сценарій починався з нуля так само, як щойно скинута база починається для сіяча (seeder). |
+| <span id="testing-ensureStepsAreInOrder-procedure">`ensureStepsAreInOrder`</span> | `<C, S, X>(scenario: Scenario<C, S, X>) => Effect.Effect<void>` | — | Гучно валить, коли кроки сценарію стоять не в строго зростальному порядку часу: це зламаний сценарій, а не результат прогону. |
+| <span id="testing-firstPassLabelsOf-procedure">`firstPassLabelsOf`</span> | `<C, S, X>(scenario: Scenario<C, S, X>) => readonly string[]` | — | Мітки, яких сценарій чекає першого разу, по порядку. |
+| <span id="testing-labelOf-procedure">`labelOf`</span> | `<R>(program: Effect.Effect<string, unknown, R>) => Effect.Effect<string, never, R>` | — | Виконує один крок і ставить йому мітку: що він повернув або як зветься відмова, яку він зустрів. |
+| <span id="testing-labelOfFailure-procedure">`labelOfFailure`</span> | `(cause: Cause.Cause<unknown>) => string` | — | Ставить мітку відмові, тож сценарій читається однаково на кожному прогоні. |
+| <span id="testing-makeInMemoryBlobStoreWith-procedure">`makeInMemoryBlobStoreWith`</span> | `(blobs: Ref.Ref<BlobsByKey>) => BlobStoreShape` | — | Сховище об'єктів у пам'яті над `Ref`, який ви тримаєте, тож тест засіває його перед прогоном і читає після. |
+| <span id="testing-makeInMemoryDocumentNumberCounterWith-procedure">`makeInMemoryDocumentNumberCounterWith`</span> | `(counts: Ref.Ref<DocumentCountsByClientAndMonth>) => DocumentNumberCounterShape` | — | Лічильник у пам'яті над посиланням, яке ви тримаєте, тож тест засіває його і читає назад. |
+| <span id="testing-makeInMemoryEventPublisherWith-procedure">`makeInMemoryEventPublisherWith`</span> | `(published: Ref.Ref<PublishedMessages>) => EventPublisherShape` | — | Публікатор у пам'яті над `Ref`, який ви тримаєте, тож тест читає опубліковане після прогону. |
+| <span id="testing-makeInMemoryExternalHttpClient-procedure">`makeInMemoryExternalHttpClient`</span> | `(answers: AnswersByPath) => Effect.Effect<ExternalHttpClientShape>` | — | Клієнт у пам'яті над власним `Ref`, засіяний відповідями, які ви йому подали. |
+| <span id="testing-makeInMemoryExternalHttpClientWith-procedure">`makeInMemoryExternalHttpClientWith`</span> | `(answers: Ref.Ref<AnswersByPath>) => ExternalHttpClientShape` | — | Клієнт у пам'яті над `Ref`, який ви тримаєте, тож тест переписує відповідь сервісу між двома викликами одного сценарію. |
+| <span id="testing-makeInMemoryIntegrationEventOutboxWith-procedure">`makeInMemoryIntegrationEventOutboxWith`</span> | `(queued: Ref.Ref<QueuedOutboxMessages>, dispatched: Ref.Ref<DispatchedMessageIds>) => IntegrationEventOutboxShape` | — | Буфер трансмітера в пам'яті над двома `Ref`, які ви тримаєте, тож тест засіває те, що чекає, і читає назад те, що трансмітер відправив. |
+| <span id="testing-makeInMemoryProcessedEventRegistryWith-procedure">`makeInMemoryProcessedEventRegistryWith`</span> | `(processed: Ref.Ref<ProcessedEventsById>) => ProcessedEventRegistryShape` | — | Реєстр у пам'яті над `Ref`, який ви тримаєте, тож тест засіває вже зарезервоване і читає назад додане прогоном. |
+| <span id="testing-makeInMemoryQueueMessageProducerWith-procedure">`makeInMemoryQueueMessageProducerWith`</span> | `(pending: Ref.Ref<PendingQueueMessages>) => QueueMessageProducerShape` | — | Відправник у пам'яті над тим самим посиланням, яке читає джерело в пам'яті. |
+| <span id="testing-makeInMemoryQueueMessageSourceWith-procedure">`makeInMemoryQueueMessageSourceWith`</span> | `(pending: Ref.Ref<PendingQueueMessages>) => QueueMessageSourceShape` | — | Джерело повідомлень у пам'яті над `Ref`, який ви тримаєте, тож тест засіває чергу перед прогоном і читає, що лишилось після. |
+| <span id="testing-makeInMemoryTransactionBoundary-procedure">`makeInMemoryTransactionBoundary`</span> | `(participants: readonly TransactionalState[]) => TransactionBoundaryShape` | — | Будує межу транзакції в пам'яті: вона захоплює стан кожного учасника на вході і повертає його, коли робота падає. |
+| <span id="testing-makeScriptedMessageSource-procedure">`makeScriptedMessageSource`</span> | `(script: readonly (readonly RawQueueMessage[])[]) => Effect.Effect<ScriptedQueue>` | — | Будує джерело за сценарієм і читача того, що воно підтвердило. |
+| <span id="testing-messageOf-procedure">`messageOf`</span> | `(messageId: string, body: string) => RawQueueMessage` | — | Одне сире повідомлення, збудоване так, як його віддає черга: ідентифікатор, квитанція, яку цитує підтвердження, і тіло. |
+| <span id="testing-momentsOfSteps-procedure">`momentsOfSteps`</span> | `<C, S, X>(scenario: Scenario<C, S, X>, chosen: (step: ScenarioStep<C>) => boolean) => readonly string[]` | — | Повертає миті обраних кроків рядками ISO, у тому вигляді, в якому їх повертає похід у базу і назад. |
+| <span id="testing-mutationSettings-procedure">`mutationSettings`</span> | `(options: MutationSettingsOptions) => MutationSettings` | — | Усе, що потрібно мутаційному прогону, з обмеженим очікуванням і без живих стендів. |
+| <span id="testing-playScenario-procedure">`playScenario`</span> | `<C, S, R, X>(scenario: Scenario<C, S, X>, service: ScenarioService<C, S, R, X>) => Effect.Effect<ScenarioPlayback<S>, never, R>` | — | Програє сценарій: кожен крок біжить у власну мить, а знімок беруть у мить останнього кроку. |
+| <span id="testing-quietReporters-procedure">`quietReporters`</span> | `(options: QuietReporterOptions & { readonly verbose?: boolean } = {}) => ('default' \| QuietReporter)[]` | — | Значення `reporters`, яке бере конфігурація виконавця тестів. |
+| <span id="testing-replayLabelsOf-procedure">`replayLabelsOf`</span> | `<C, S, X>(scenario: Scenario<C, S, X>) => readonly string[]` | — | Мітки, яких сценарій чекає, коли ті самі кроки біжать удруге, по порядку. |
+| <span id="testing-setNowTo-procedure">`setNowTo`</span> | `(isoTimestamp: string) => Effect.Effect<void>` | — | Ставить керований тестовий годинник на подану мить ISO. |
+| <span id="testing-stateOfRef-procedure">`stateOfRef`</span> | `<A>(ref: Ref.Ref<A>) => TransactionalState` | — | Робить `Ref` учасником, тож межа в пам'яті вміє повернути його туди, де він був, коли робота падає. |
+| <span id="testing-typedFailureOf-procedure">`typedFailureOf`</span> | `<A, E>(effect: Effect.Effect<A, E>) => Effect.Effect<E>` | — | Дістає типізовану відмову (Data.TaggedError) процедури через `Effect.exit` і `Cause`, а не звіркою тексту повідомлення про помилку. |
+| <span id="testing-verboseOutputWanted-procedure">`verboseOutputWanted`</span> | `(environment: Readonly<Record<string, string \| undefined>> = process.env) => boolean` | — | Чи має виконавець друкувати все. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="testing-BlobStoreUnavailableLive-adapter">`BlobStoreUnavailableLive`</span> | `Layer.Layer<BlobStore>` | — | Сховище об'єктів, яке ні на що не відповідає: кожна операція падає з `BlobStoreUnavailableError`. |
+| <span id="testing-DocumentNumberCounterUnavailableLive-adapter">`DocumentNumberCounterUnavailableLive`</span> | `Layer.Layer<DocumentNumberCounter>` | — | Лічильник, який нічого не рахує: кожен запит повертається відмовою. |
+| <span id="testing-EventPublisherUnavailableLive-adapter">`EventPublisherUnavailableLive`</span> | `Layer.Layer<EventPublisher>` | — | Публікатор, який нічого не бере: кожна публікація падає з `EventPublisherUnavailableError`. |
+| <span id="testing-ExternalHttpClientUnavailableLive-adapter">`ExternalHttpClientUnavailableLive`</span> | `Layer.Layer<ExternalHttpClient>` | — | Клієнт, який нікуди не дістає: кожен виклик падає з `ExternalServiceUnavailableError`. |
+| <span id="testing-inMemoryExternalHttpClientLive-adapter">`inMemoryExternalHttpClientLive`</span> | `(answers: AnswersByPath) => Layer.Layer<ExternalHttpClient>` | — | Змонтований клієнт у пам'яті, який відповідає на шляхи, якими ви його засіяли. |
+| <span id="testing-InMemoryReadinessProbeLive-adapter">`InMemoryReadinessProbeLive`</span> | `Layer.Layer<ReadinessProbe>` | — | Змонтована проба готовності в пам'яті. |
+| <span id="testing-inMemoryTransactionBoundaryLive-adapter">`inMemoryTransactionBoundaryLive`</span> | `(participants: readonly TransactionalState[]) => Layer.Layer<TransactionBoundary>` | — | Змонтована межа транзакції в пам'яті, над названими вами учасниками. |
+| <span id="testing-IntegrationEventOutboxUnavailableLive-adapter">`IntegrationEventOutboxUnavailableLive`</span> | `Layer.Layer<IntegrationEventOutbox>` | — | Буфер трансмітера, який нічого не приймає: `enqueue` відмовляє, тож запис процедури і її повідомлення падають разом. |
+| <span id="testing-IntegrationEventOutboxUnreadableLive-adapter">`IntegrationEventOutboxUnreadableLive`</span> | `Layer.Layer<IntegrationEventOutbox>` | — | Буфер трансмітера, який бере повідомлення і потім відмовляється їх віддати: `pending` падає, а `enqueue` вдається. |
+| <span id="testing-ProcessedEventRegistryUnavailableLive-adapter">`ProcessedEventRegistryUnavailableLive`</span> | `Layer.Layer<ProcessedEventRegistry>` | — | Реєстр, який нічого не резервує: кожна резервація повертається відмовою. |
+| <span id="testing-QueueMessageProducerUnavailableLive-adapter">`QueueMessageProducerUnavailableLive`</span> | `Layer.Layer<QueueMessageProducer>` | — | Відправник, який ні на що не відповідає: кожне надсилання падає з `QueueMessageProducerUnavailableError`. |
+| <span id="testing-QueueMessageSourceUnavailableLive-adapter">`QueueMessageSourceUnavailableLive`</span> | `Layer.Layer<QueueMessageSource>` | — | Джерело повідомлень, яке ні на що не відповідає: кожна операція падає з `QueueMessageSourceUnavailableError`. |
+| <span id="testing-ReadinessProbeUnavailableLive-adapter">`ReadinessProbeUnavailableLive`</span> | `Layer.Layer<ReadinessProbe>` | — | Проба, чия база ніколи не відповідає. |
+| <span id="testing-scriptedQueueMessageSourceLive-adapter">`scriptedQueueMessageSourceLive`</span> | `(script: readonly (readonly RawQueueMessage[])[]) => Layer.Layer<QueueMessageSource>` | — | Змонтоване джерело за сценарієм: кожен `receive` відповідає наступною пачкою сценарію. |
+| <span id="testing-TransactionBoundaryUnavailableLive-adapter">`TransactionBoundaryUnavailableLive`</span> | `Layer.Layer<TransactionBoundary>` | — | Межа транзакції, яка нічого не відкриває: робота ніколи не біжить, і викликач читає відмову. |
+
+## vitest
+
+Імпорт із `@satorio/machinery/vitest` — [ціла сторінка](../mechanisms/vitest.mdx).
+
+### Значення
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="vitest-AwsStand-value">`AwsStand`</span> | `interface` | — | Адреса і регіон живого стенда AWS, з яким говорить сьют. |
+| <span id="vitest-FILES-THAT-FORK-A-FIBER-AND-ADJUST-TEST-CLOCK-value">`FILES_THAT_FORK_A_FIBER_AND_ADJUST_TEST_CLOCK`</span> | `readonly string[]` | — | Тестові файли, яким потрібен власний свіжий стан модулів, бо вони форкають файбер і рухають годинник. |
+| <span id="vitest-LOCALSTACK-REGION-value">`LOCALSTACK_REGION`</span> | `const` | — | Єдиний регіон, про який домовляються кожен клієнт і кожен ресурс у сьюті. |
+| <span id="vitest-PortContractTester-value">`PortContractTester`</span> | `type` | — | Той підмножинний набір тестових методів vitest, якого контракт порту потребує від свого тестувальника. |
+| <span id="vitest-POSTGRES-IMAGE-value">`POSTGRES_IMAGE`</span> | `const` | — | Образ Postgres, який кожен тест на живому стенді піднімає через testcontainers. |
+| <span id="vitest-ReaderPortUnderTest-value">`ReaderPortUnderTest`</span> | `interface` | — | Що власний тест порту-читача подає контрактові. |
+| <span id="vitest-RecordedStubRequest-value">`RecordedStubRequest`</span> | `interface` | — | Один запит, який отримав стаб-сервер (stub server), у тому вигляді, в якому тест читає його назад: метод і шлях. |
+| <span id="vitest-StubResponse-value">`StubResponse`</span> | `interface` | — | Одна відповідь стаб-сервера: статус, тіло і тип вмісту, коли вони є, і затримка перед відповіддю. |
+| <span id="vitest-StubRoute-value">`StubRoute`</span> | `interface` | — | Один маршрут, який обслуговує стаб-сервер: метод, шлях і відповіді, які він дає по черзі. |
+
+### Процедури
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="vitest-blobStoreContract-procedure">`blobStoreContract`</span> | `(it: PortContractTester, implementationName: string, layer: Layer.Layer<BlobStore>, unavailable?: Layer.Layer<BlobStore>) => void` | — | Один контракт, кожне сховище об'єктів. |
+| <span id="vitest-documentNumberCounterContract-procedure">`documentNumberCounterContract`</span> | `(it: PortContractTester, implementationName: string, layer: Layer.Layer<DocumentNumberCounter>, unavailable?: Layer.Layer<DocumentNumberCounter>) => void` | — | Один контракт, кожна реалізація лічильника. |
+| <span id="vitest-eventPublisherContract-procedure">`eventPublisherContract`</span> | `(it: PortContractTester, implementationName: string, publisher: PublisherUnderTest, unavailable?: Layer.Layer<EventPublisher>) => void` | — | Один контракт, кожен публікатор подій. |
+| <span id="vitest-externalHttpClientContract-procedure">`externalHttpClientContract`</span> | `(it: PortContractTester, implementationName: string, service: ExternalServiceUnderTest, unavailable?: Layer.Layer<ExternalHttpClient>) => void` | — | Один контракт, кожен зовнішній HTTP-клієнт. |
+| <span id="vitest-integrationEventOutboxContract-procedure">`integrationEventOutboxContract`</span> | `(it: PortContractTester, implementationName: string, layer: Layer.Layer<IntegrationEventOutbox>, unavailable?: Layer.Layer<IntegrationEventOutbox>) => void` | — | Один контракт, кожен буфер трансмітера. |
+| <span id="vitest-onLocalstack-procedure">`onLocalstack`</span> | `(options: LocalstackSuiteOptions, subject: string, checks: SuiteChecks) => void` | — | Крутить сьют проти справжнього стенда AWS (localstack) для `subject`. |
+| <span id="vitest-onPostgres-procedure">`onPostgres`</span> | `(options: PostgresSuiteOptions, subject: string, checks: SuiteChecks) => void` | — | Крутить сьют проти справжнього Postgres — контейнера або зовні налаштованої бази, коли поставлено `PGHOST`. |
+| <span id="vitest-onPostgresContainer-procedure">`onPostgresContainer`</span> | `(options: PostgresSuiteOptions, subject: string, checks: SuiteChecks) => void` | — | Крутить сьют проти Postgres лише в контейнері, ігноруючи будь-які змінні оточення `PG*`. |
+| <span id="vitest-outboxEvent-procedure">`outboxEvent`</span> | `(messageId: string, payload: { readonly [key: string]: unknown }) => OutboxMessage` | — | Одне повідомлення, збудоване так, як його віддає буфер трансмітера. |
+| <span id="vitest-outboxMessage-procedure">`outboxMessage`</span> | `(messageId: string) => OutboxMessage` | — | Одне повідомлення буфера, яке контракт ставить у чергу і читає назад, тож кожній реалізації ставлять те саме питання. |
+| <span id="vitest-processedEventRegistryContract-procedure">`processedEventRegistryContract`</span> | `(it: PortContractTester, implementationName: string, layer: Layer.Layer<ProcessedEventRegistry>, unavailable?: Layer.Layer<ProcessedEventRegistry>) => void` | — | Один контракт, кожен реєстр відпрацьованих подій. |
+| <span id="vitest-queueMessageProducerContract-procedure">`queueMessageProducerContract`</span> | `(it: PortContractTester, implementationName: string, producer: ProducerUnderTest, unavailable?: Layer.Layer<QueueMessageProducer>) => void` | — | Один контракт, кожен відправник повідомлень. |
+| <span id="vitest-queueMessageSourceContract-procedure">`queueMessageSourceContract`</span> | `(it: PortContractTester, implementationName: string, queue: QueueUnderTest, unavailable?: Layer.Layer<QueueMessageSource>) => void` | — | Один контракт, кожне джерело повідомлень. |
+| <span id="vitest-readerPortContract-procedure">`readerPortContract`</span> | `<Subject, Value>(it: PortContractTester, port: ReaderPortUnderTest<Subject, Value>) => void` | — | Один контракт для порту, який лише читає. |
+| <span id="vitest-readinessProbeContract-procedure">`readinessProbeContract`</span> | `(it: PortContractTester, implementationName: string, layer: Layer.Layer<ReadinessProbe>, unavailable?: Layer.Layer<ReadinessProbe>) => void` | — | Один контракт, кожна проба готовності. |
+| <span id="vitest-repoCommittableFiles-procedure">`repoCommittableFiles`</span> | `(root: string = repoRoot()) => readonly string[]` | — | Кожен файл, який git закомітив би таким, яким той стоїть під `root`. |
+| <span id="vitest-repoFilesUnder-procedure">`repoFilesUnder`</span> | `(root: string, directories: readonly string[], extension: string) => readonly string[]` | — | Перелічує файли з розширенням `extension` рекурсивно під `directories`, відносно `root`. |
+| <span id="vitest-repoRoot-procedure">`repoRoot`</span> | `(cwd: string = process.cwd()) => string` | — | Корінь git-репозиторію, який містить `cwd` (за замовчуванням `process.cwd()`). |
+| <span id="vitest-scopedStubServer-procedure">`scopedStubServer`</span> | `(routes: readonly StubRoute[]) => Effect.Effect<StubServerShape, never, Scope.Scope>` | — | Крутить стаб-сервер стільки, скільки живе скоуп. |
+| <span id="vitest-settingsContract-procedure">`settingsContract`</span> | `<A>(mechanism: string, environment: readonly EnvironmentEntry[], settings: Config.Config<A>, variablePrefix = '') => void` | — | Один контракт, кожен адаптер, який називає змінні. |
+| <span id="vitest-storedBlob-procedure">`storedBlob`</span> | `(text: string) => StoredBlob` | — | Один об'єкт, який контракт зберігає і читає назад, тож кожній реалізації ставлять те саме питання. |
+| <span id="vitest-transactionBoundaryContract-procedure">`transactionBoundaryContract`</span> | `(it: PortContractTester, implementationName: string, layer: Layer.Layer<TransactionBoundary>, unavailable?: Layer.Layer<TransactionBoundary>) => void` | — | Один контракт, кожна межа транзакції. |
+| <span id="vitest-truncateTables-procedure">`truncateTables`</span> | `(tableNames: readonly string[]) => Effect.Effect<void, SqlError, SqlClient.SqlClient>` | — | Спорожнює названі таблиці одним запитом — для тесту, якому потрібен знайомий початковий стан. |
+
+### Адаптери
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="vitest-postgresInContainerLive-adapter">`postgresInContainerLive`</span> | `(options: PostgresSuiteOptions) => Layer.Layer<never>` | — | Будує шар Postgres для сьюта лише зі свіжого контейнера, ігноруючи будь-які змінні оточення `PG*`. |
+| <span id="vitest-PostgresPortsUnderTestLive-adapter">`PostgresPortsUnderTestLive`</span> | `Layer.Layer<PostgresPorts \| PgClient.PgClient \| SqlClient.SqlClient>` | — | Власні порти механізму postgres на базі цього сьюта. |
+| <span id="vitest-postgresUnderTestLive-adapter">`postgresUnderTestLive`</span> | `(options: PostgresSuiteOptions) => Layer.Layer<never>` | — | Шар Postgres, на якому біжить сьют: налаштована база, коли оточення її називає, свіжий контейнер, коли ні, і мігровані обидва. |
+
+### Перевірки збірки
+
+| Назва | Сигнатура або тип | За замовчуванням | Що це |
+| --- | --- | --- | --- |
+| <span id="vitest-oneEffectInstanceGuard-guard">`oneEffectInstanceGuard`</span> | `(options: SingleEffectInstanceOptions = {}) => void` | — | Реєструє сьют vitest, який валить прогін, коли дерево тримає більш ніж одну копію Effect. |
+| <span id="vitest-oneFastCheckInstanceGuard-guard">`oneFastCheckInstanceGuard`</span> | `() => void` | — | Реєструє сьют vitest, який валить прогін, коли бібліотека властивостей резолвиться у два примірники модуля. |
+| <span id="vitest-testclockForkIsolationGuard-guard">`testclockForkIsolationGuard`</span> | `(knownIsolatedFiles: readonly string[], options: TestclockForkIsolationOptions) => void` | — | Реєструє сьют vitest, який валить прогін, коли тест рухає годинник у форкнутому файбері поза власним списком. |
+
+## Підсумок
+
+Тепер у вас одне місце, де названо все, що дає цей пакет, і одне речення поруч із кожною назвою. Сторінку складено з самого коду, тому коли рухається код, разом із ним рухається й вона. Повертайтесь сюди щоразу, коли знаєте, чого хочете, і не знаєте, як воно зветься.