@satorio/machinery 0.2.1

package/dictionary/publishing.json

@@ -0,0 +1,131 @@
+{
+  "package": "@satorio/machinery",
+  "version": "0.2.1",
+  "mechanism": {
+    "mechanism": "publishing",
+    "import": "@satorio/machinery/publishing",
+    "kind": "adapter",
+    "page": "mechanisms/publishing",
+    "what": "Public entry to the publishing mechanism: the event publisher, bound to a topic or to one line on stdout.",
+    "whatUk": "Публічний вхід до механізму publishing: публікатор (publisher) подій, прив'язаний до топіка або до одного рядка на stdout.",
+    "rows": [
+      {
+        "name": "DEFAULT_EVENT_CHANNEL",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "The log channel the stdout publisher writes its events under when nobody names one.",
+        "captionUk": "Канал лога, під яким публікатор на stdout пише свої події, коли ніхто не назвав іншого.",
+        "anchor": "publishing-DEFAULT-EVENT-CHANNEL-value"
+      },
+      {
+        "name": "ENVIRONMENT",
+        "kind": "value",
+        "signature": "readonly EnvironmentEntry[]",
+        "fallback": "",
+        "caption": "Every variable this adapter reads, and the one state each of them stands in.",
+        "captionUk": "Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них.",
+        "anchor": "publishing-ENVIRONMENT-value"
+      },
+      {
+        "name": "SnsPublisherSettings",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "What the SNS publisher needs before it can send: one topic, and the two variables the AWS SDK reads for itself when nobody names them.",
+        "captionUk": "Що потрібно публікаторові SNS, перш ніж він надішле: один топік і дві змінні, які AWS SDK читає сам, коли їх ніхто не називає.",
+        "anchor": "publishing-SnsPublisherSettings-value"
+      },
+      {
+        "name": "snsMessageBodyOf",
+        "kind": "procedure",
+        "signature": "(message: OutboxMessage) => string",
+        "fallback": "",
+        "caption": "The message body a subscriber reads: the same envelope as the stdout line, minus the channel — here the topic itself plays that role.",
+        "captionUk": "Тіло повідомлення, яке читає підписник: той самий конверт, що й рядок на stdout, без каналу — тут цю роль грає сам топік.",
+        "anchor": "publishing-snsMessageBodyOf-procedure"
+      },
+      {
+        "name": "snsPublisherSettings",
+        "kind": "procedure",
+        "signature": "(variablePrefix: string) => Config.Config<SnsPublisherSettings>",
+        "fallback": "",
+        "caption": "Reads every variable the SNS publisher needs under one prefix.",
+        "captionUk": "Читає кожну змінну, потрібну публікаторові SNS, під одним префіксом.",
+        "anchor": "publishing-snsPublisherSettings-procedure"
+      },
+      {
+        "name": "stdoutLineOf",
+        "kind": "procedure",
+        "signature": "(channel: string, message: OutboxMessage) => string",
+        "fallback": "",
+        "caption": "The simplest publisher: an event travels as one JSON line on stdout, where a log collector picks it up.",
+        "captionUk": "Найпростіший публікатор: подія мандрує одним рядком JSON на stdout, звідки її забирає збирач логів.",
+        "anchor": "publishing-stdoutLineOf-procedure"
+      },
+      {
+        "name": "topicArnVariable",
+        "kind": "procedure",
+        "signature": "(variablePrefix: string) => string",
+        "fallback": "",
+        "caption": "Builds the environment variable name from the prefix the application gives at mount time.",
+        "captionUk": "Будує назву змінної оточення з префікса, який застосунок дає під час монтування.",
+        "anchor": "publishing-topicArnVariable-procedure"
+      },
+      {
+        "name": "snsEventPublisherLive",
+        "kind": "adapter",
+        "signature": "(variablePrefix: string) => Layer.Layer<EventPublisher, ConfigError.ConfigError>",
+        "fallback": "",
+        "caption": "The SNS publisher on the real AWS SDK transport, reading the variables this prefix names.",
+        "captionUk": "Публікатор SNS на справжньому транспорті AWS SDK, який читає змінні, названі цим префіксом.",
+        "anchor": "publishing-snsEventPublisherLive-adapter"
+      },
+      {
+        "name": "StdoutEventPublisherLive",
+        "kind": "adapter",
+        "signature": "Layer.Layer<EventPublisher>",
+        "fallback": "",
+        "caption": "The stdout publisher, mounted: one JSON line per event under the channel `EVENT_CHANNEL` names.",
+        "captionUk": "Змонтований публікатор на stdout: один рядок JSON на подію під каналом, який називає `EVENT_CHANNEL`.",
+        "anchor": "publishing-StdoutEventPublisherLive-adapter"
+      },
+      {
+        "name": "<PREFIX>_TOPIC_ARN",
+        "kind": "environment variable",
+        "signature": "refuses",
+        "fallback": "",
+        "caption": "The SNS topic this publisher sends events to.",
+        "captionUk": "Топік SNS, до якого цей публікатор надсилає події.",
+        "anchor": "publishing-PREFIX-TOPIC-ARN-environment-variable"
+      },
+      {
+        "name": "EVENT_CHANNEL",
+        "kind": "environment variable",
+        "signature": "falls back",
+        "fallback": "machinery-integration-events",
+        "caption": "The word a log collector filters the stdout publisher's lines by.",
+        "captionUk": "Слово, за яким збирач логів фільтрує рядки публікатора на stdout.",
+        "anchor": "publishing-EVENT-CHANNEL-environment-variable"
+      },
+      {
+        "name": "AWS_REGION",
+        "kind": "environment variable",
+        "signature": "handed on",
+        "fallback": "",
+        "caption": "The region the SNS client talks to.",
+        "captionUk": "Регіон, з яким говорить клієнт SNS.",
+        "anchor": "publishing-AWS-REGION-environment-variable"
+      },
+      {
+        "name": "AWS_ENDPOINT_URL",
+        "kind": "environment variable",
+        "signature": "handed on",
+        "fallback": "",
+        "caption": "A local stand to talk to instead of real SNS, such as localstack.",
+        "captionUk": "Локальний стенд, з яким говорити замість справжнього SNS, наприклад localstack.",
+        "anchor": "publishing-AWS-ENDPOINT-URL-environment-variable"
+      }
+    ]
+  }
+}

package/dictionary/publishing.toon

@@ -0,0 +1,23 @@
+package: @satorio/machinery
+version: 0.2.1
+mechanism:
+  mechanism: publishing
+  import: @satorio/machinery/publishing
+  kind: adapter
+  page: mechanisms/publishing
+  what: "Public entry to the publishing mechanism: the event publisher, bound to a topic or to one line on stdout."
+  whatUk: "Публічний вхід до механізму publishing: публікатор (publisher) подій, прив'язаний до топіка або до одного рядка на stdout."
+  rows[13]{name,kind,signature,fallback,caption,captionUk,anchor}:
+    DEFAULT_EVENT_CHANNEL,value,const,"",The log channel the stdout publisher writes its events under when nobody names one.,"Канал лога, під яким публікатор на stdout пише свої події, коли ніхто не назвав іншого.",publishing-DEFAULT-EVENT-CHANNEL-value
+    ENVIRONMENT,value,"readonly EnvironmentEntry[]","","Every variable this adapter reads, and the one state each of them stands in.","Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них.",publishing-ENVIRONMENT-value
+    SnsPublisherSettings,value,interface,"","What the SNS publisher needs before it can send: one topic, and the two variables the AWS SDK reads for itself when nobody names them.","Що потрібно публікаторові SNS, перш ніж він надішле: один топік і дві змінні, які AWS SDK читає сам, коли їх ніхто не називає.",publishing-SnsPublisherSettings-value
+    snsMessageBodyOf,procedure,"(message: OutboxMessage) => string","","The message body a subscriber reads: the same envelope as the stdout line, minus the channel — here the topic itself plays that role.","Тіло повідомлення, яке читає підписник: той самий конверт, що й рядок на stdout, без каналу — тут цю роль грає сам топік.",publishing-snsMessageBodyOf-procedure
+    snsPublisherSettings,procedure,"(variablePrefix: string) => Config.Config<SnsPublisherSettings>","",Reads every variable the SNS publisher needs under one prefix.,"Читає кожну змінну, потрібну публікаторові SNS, під одним префіксом.",publishing-snsPublisherSettings-procedure
+    stdoutLineOf,procedure,"(channel: string, message: OutboxMessage) => string","","The simplest publisher: an event travels as one JSON line on stdout, where a log collector picks it up.","Найпростіший публікатор: подія мандрує одним рядком JSON на stdout, звідки її забирає збирач логів.",publishing-stdoutLineOf-procedure
+    topicArnVariable,procedure,"(variablePrefix: string) => string","",Builds the environment variable name from the prefix the application gives at mount time.,"Будує назву змінної оточення з префікса, який застосунок дає під час монтування.",publishing-topicArnVariable-procedure
+    snsEventPublisherLive,adapter,"(variablePrefix: string) => Layer.Layer<EventPublisher, ConfigError.ConfigError>","","The SNS publisher on the real AWS SDK transport, reading the variables this prefix names.","Публікатор SNS на справжньому транспорті AWS SDK, який читає змінні, названі цим префіксом.",publishing-snsEventPublisherLive-adapter
+    StdoutEventPublisherLive,adapter,Layer.Layer<EventPublisher>,"","The stdout publisher, mounted: one JSON line per event under the channel `EVENT_CHANNEL` names.","Змонтований публікатор на stdout: один рядок JSON на подію під каналом, який називає `EVENT_CHANNEL`.",publishing-StdoutEventPublisherLive-adapter
+    <PREFIX>_TOPIC_ARN,environment variable,refuses,"",The SNS topic this publisher sends events to.,"Топік SNS, до якого цей публікатор надсилає події.",publishing-PREFIX-TOPIC-ARN-environment-variable
+    EVENT_CHANNEL,environment variable,falls back,machinery-integration-events,The word a log collector filters the stdout publisher's lines by.,"Слово, за яким збирач логів фільтрує рядки публікатора на stdout.",publishing-EVENT-CHANNEL-environment-variable
+    AWS_REGION,environment variable,handed on,"",The region the SNS client talks to.,"Регіон, з яким говорить клієнт SNS.",publishing-AWS-REGION-environment-variable
+    AWS_ENDPOINT_URL,environment variable,handed on,"","A local stand to talk to instead of real SNS, such as localstack.","Локальний стенд, з яким говорити замість справжнього SNS, наприклад localstack.",publishing-AWS-ENDPOINT-URL-environment-variable

package/dictionary/queue.json

@@ -0,0 +1,365 @@
+{
+  "package": "@satorio/machinery",
+  "version": "0.2.1",
+  "mechanism": {
+    "mechanism": "queue",
+    "import": "@satorio/machinery/queue",
+    "kind": "adapter",
+    "page": "mechanisms/queue",
+    "what": "Public entry to the queue mechanism: the envelope a message travels in, and the consumer that decides its fate.",
+    "whatUk": "Публічний вхід до механізму queue: конверт, у якому мандрує повідомлення, і робітник (consumer), який вирішує його долю.",
+    "rows": [
+      {
+        "name": "defaultQueueRetrySchedule",
+        "kind": "value",
+        "signature": "QueueRetrySchedule",
+        "fallback": "",
+        "caption": "The waiting a consumer keeps when a service names no schedule of its own: growing pauses, jittered, and a limit on how often it tries.",
+        "captionUk": "Очікування, якого тримається робітник, коли сервіс не називає власного розкладу: зростальні паузи, з джитером, і межа на кількість спроб.",
+        "anchor": "queue-defaultQueueRetrySchedule-value"
+      },
+      {
+        "name": "ENVIRONMENT",
+        "kind": "value",
+        "signature": "readonly EnvironmentEntry[]",
+        "fallback": "",
+        "caption": "Every variable this adapter reads, and the one state each of them stands in.",
+        "captionUk": "Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них.",
+        "anchor": "queue-ENVIRONMENT-value"
+      },
+      {
+        "name": "EventDefinitionRegistry",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "What a service's own list of event definitions offers: whether an event type is known, and the definition behind it.",
+        "captionUk": "Що пропонує власний список визначень подій сервісу: чи тип події відомий і яке визначення за ним стоїть.",
+        "anchor": "queue-EventDefinitionRegistry-value"
+      },
+      {
+        "name": "IncomingQueueMessage",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "One message as a handler meets it: the envelope's own fields, and the decoded event itself.",
+        "captionUk": "Одне повідомлення таким, яким його зустрічає обробник: власні поля конверта і сама декодована подія.",
+        "anchor": "queue-IncomingQueueMessage-value"
+      },
+      {
+        "name": "PayloadDecoder",
+        "kind": "value",
+        "signature": "type",
+        "fallback": "",
+        "caption": "What turns a stored payload of some version into the event a handler works with.",
+        "captionUk": "Те, що перетворює збережений payload якоїсь версії на подію, з якою працює обробник.",
+        "anchor": "queue-PayloadDecoder-value"
+      },
+      {
+        "name": "QueueConsumerSettings",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "What a consumer needs before it can receive a single message.",
+        "captionUk": "Що потрібно робітникові, перш ніж він отримає бодай одне повідомлення.",
+        "anchor": "queue-QueueConsumerSettings-value"
+      },
+      {
+        "name": "QueueMessageBody",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "The envelope as it travels: the JSON text on the wire, read and written through one schema.",
+        "captionUk": "Конверт таким, яким він мандрує: текст JSON на дроті, прочитаний і записаний однією схемою.",
+        "anchor": "queue-QueueMessageBody-value"
+      },
+      {
+        "name": "QueueMessageConsumerOptions",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "What a consumer needs to turn a queue message into work.",
+        "captionUk": "Що потрібно робітникові, щоб перетворити повідомлення черги на роботу.",
+        "anchor": "queue-QueueMessageConsumerOptions-value"
+      },
+      {
+        "name": "QueueMessageOutcome",
+        "kind": "value",
+        "signature": "type",
+        "fallback": "",
+        "caption": "The fate of one message has exactly three endings: acknowledged, left for redelivery, or refused permanently.",
+        "captionUk": "Доля одного повідомлення має рівно три кінці: підтверджено, лишено на перевідправку або відмовлено назавжди.",
+        "anchor": "queue-QueueMessageOutcome-value"
+      },
+      {
+        "name": "QueueProducerSettings",
+        "kind": "value",
+        "signature": "interface",
+        "fallback": "",
+        "caption": "What a producer needs before it can send: the queue, and the same two variables the SDK decides for itself.",
+        "captionUk": "Що потрібно відправникові, перш ніж він надішле: черга і ті самі дві змінні, які SDK вирішує сам.",
+        "anchor": "queue-QueueProducerSettings-value"
+      },
+      {
+        "name": "QueueRetrySchedule",
+        "kind": "value",
+        "signature": "type",
+        "fallback": "",
+        "caption": "How a consumer waits and tries again while the queue itself does not answer.",
+        "captionUk": "Як робітник чекає і пробує знову, поки сама черга не відповідає.",
+        "anchor": "queue-QueueRetrySchedule-value"
+      },
+      {
+        "name": "RedeliveryReason",
+        "kind": "value",
+        "signature": "type",
+        "fallback": "",
+        "caption": "Why a message goes back on the queue: it never decoded, or the handler rejected it.",
+        "captionUk": "Чому повідомлення повертається в чергу: воно так і не декодувалось, або обробник його відхилив.",
+        "anchor": "queue-RedeliveryReason-value"
+      },
+      {
+        "name": "SchemaVersion",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "The version a stored payload was shaped by: a whole number above zero, and never anything else.",
+        "captionUk": "Версія, якою надано форми збереженому payload: ціле число понад нуль і ніколи нічого іншого.",
+        "anchor": "queue-SchemaVersion-value"
+      },
+      {
+        "name": "SQS_DEFAULT_VISIBILITY_TIMEOUT_SECONDS",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "How long a received message stays hidden while a handler works on it, when nobody names a number.",
+        "captionUk": "Скільки отримане повідомлення лишається схованим, поки над ним працює обробник, коли ніхто не назвав числа.",
+        "anchor": "queue-SQS-DEFAULT-VISIBILITY-TIMEOUT-SECONDS-value"
+      },
+      {
+        "name": "StoredEventEnvelope",
+        "kind": "value",
+        "signature": "const",
+        "fallback": "",
+        "caption": "The shared queue contract every message travels in.",
+        "captionUk": "Спільний контракт черги, у якому мандрує кожне повідомлення.",
+        "anchor": "queue-StoredEventEnvelope-value"
+      },
+      {
+        "name": "consumeQueueMessages",
+        "kind": "procedure",
+        "signature": "<A, E, R>(options: QueueMessageConsumerOptions<A, E, R>) => Stream.Stream<QueueMessageOutcome, QueueMessageSourceUnavailableError, R | QueueMessageSource>",
+        "fallback": "",
+        "caption": "Reads messages off the queue and hands each one to the handler, answering with the fate of every message it took.",
+        "captionUk": "Читає повідомлення з черги і віддає кожне обробникові, відповідаючи долею кожного взятого повідомлення.",
+        "anchor": "queue-consumeQueueMessages-procedure"
+      },
+      {
+        "name": "decodeQueueMessageBody",
+        "kind": "procedure",
+        "signature": "(body: string) => Effect.Effect<StoredEventEnvelope, QueueMessageNotDecodableError>",
+        "fallback": "",
+        "caption": "Reads a message body into an envelope, or refuses at the envelope stage and says what it could not read.",
+        "captionUk": "Читає тіло повідомлення в конверт або відмовляє вже на конверті й каже, чого не змогло прочитати.",
+        "anchor": "queue-decodeQueueMessageBody-procedure"
+      },
+      {
+        "name": "eventDefinitionRegistry",
+        "kind": "procedure",
+        "signature": "<S extends Schema.Schema.AnyNoContext>(definitions: readonly VersionedEventDefinition<S>[]) => EventDefinitionRegistry<S>",
+        "fallback": "",
+        "caption": "Builds a registry of known event definitions.",
+        "captionUk": "Будує реєстр відомих визначень подій.",
+        "anchor": "queue-eventDefinitionRegistry-procedure"
+      },
+      {
+        "name": "handlerRejectedMessage",
+        "kind": "procedure",
+        "signature": "(error: unknown) => RedeliveryReason",
+        "fallback": "",
+        "caption": "The reason for a message the handler itself rejected.",
+        "captionUk": "Причина для повідомлення, яке відхилив сам обробник.",
+        "anchor": "queue-handlerRejectedMessage-procedure"
+      },
+      {
+        "name": "messageAcknowledged",
+        "kind": "procedure",
+        "signature": "(messageId: string) => QueueMessageOutcome",
+        "fallback": "",
+        "caption": "The fate of a message the handler took, so the queue may drop it.",
+        "captionUk": "Доля повідомлення, яке обробник узяв, тож черга може його викинути.",
+        "anchor": "queue-messageAcknowledged-procedure"
+      },
+      {
+        "name": "messageLeftForRedelivery",
+        "kind": "procedure",
+        "signature": "(messageId: string, reason: RedeliveryReason) => QueueMessageOutcome",
+        "fallback": "",
+        "caption": "The fate of a message that goes back on the queue, with the reason it did.",
+        "captionUk": "Доля повідомлення, яке повертається в чергу, разом із причиною, чому воно повернулось.",
+        "anchor": "queue-messageLeftForRedelivery-procedure"
+      },
+      {
+        "name": "messageNotDecodable",
+        "kind": "procedure",
+        "signature": "(error: QueueMessageNotDecodableError) => RedeliveryReason",
+        "fallback": "",
+        "caption": "The reason for a message that never decoded.",
+        "captionUk": "Причина для повідомлення, яке так і не декодувалось.",
+        "anchor": "queue-messageNotDecodable-procedure"
+      },
+      {
+        "name": "messageRefusedPermanently",
+        "kind": "procedure",
+        "signature": "(messageId: string, eventId: string, refusal: unknown) => QueueMessageOutcome",
+        "fallback": "",
+        "caption": "The fate of a message no retry can help, so the platform's own redrive takes it from here.",
+        "captionUk": "Доля повідомлення, якому не поможе жодна спроба, тож далі його бере власний redrive платформи.",
+        "anchor": "queue-messageRefusedPermanently-procedure"
+      },
+      {
+        "name": "payloadDecoderFor",
+        "kind": "procedure",
+        "signature": "<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>) => PayloadDecoder<Schema.Schema.Type<S>>",
+        "fallback": "",
+        "caption": "Builds the payload decoder for one event definition, climbing a stored payload up to the version this code knows.",
+        "captionUk": "Будує декодер payload для одного визначення події, підіймаючи збережений payload до версії, яку знає цей код.",
+        "anchor": "queue-payloadDecoderFor-procedure"
+      },
+      {
+        "name": "queueConsumerSettings",
+        "kind": "procedure",
+        "signature": "(variablePrefix: string) => Config.Config<QueueConsumerSettings>",
+        "fallback": "",
+        "caption": "Reads every variable a consumer needs under one prefix.",
+        "captionUk": "Читає кожну змінну, потрібну робітникові, під одним префіксом.",
+        "anchor": "queue-queueConsumerSettings-procedure"
+      },
+      {
+        "name": "queueMessageBodyOf",
+        "kind": "procedure",
+        "signature": "(envelope: { readonly eventId: string; readonly eventType: string; readonly schemaVersion: number; readonly occurredAtIso: string; readonly payload: { readonly [key: string]: unknown } }) => string",
+        "fallback": "",
+        "caption": "Builds the same envelope contract, but for sending: the producer sets exactly the fields the consumer expects to read.",
+        "captionUk": "Будує той самий контракт конверта, але для надсилання: відправник ставить рівно ті поля, які очікує прочитати робітник.",
+        "anchor": "queue-queueMessageBodyOf-procedure"
+      },
+      {
+        "name": "queueProducerSettings",
+        "kind": "procedure",
+        "signature": "(variablePrefix: string) => Config.Config<QueueProducerSettings>",
+        "fallback": "",
+        "caption": "Reads every variable a producer needs under one prefix.",
+        "captionUk": "Читає кожну змінну, потрібну відправникові, під одним префіксом.",
+        "anchor": "queue-queueProducerSettings-procedure"
+      },
+      {
+        "name": "queueReadinessCheck",
+        "kind": "procedure",
+        "signature": "(variablePrefix: string) => Effect.Effect<Option.Option<Effect.Effect<void, QueueMessageSourceUnavailableError>>, ConfigError.ConfigError>",
+        "fallback": "",
+        "caption": "The readiness check for a queue, absent when no queue is mounted at all.",
+        "captionUk": "Перевірка готовності для черги, відсутня тоді, коли жодної черги не змонтовано.",
+        "anchor": "queue-queueReadinessCheck-procedure"
+      },
+      {
+        "name": "queueUrlVariable",
+        "kind": "procedure",
+        "signature": "(variablePrefix: string) => string",
+        "fallback": "",
+        "caption": "Builds the environment variable name from the prefix the application gives at mount time.",
+        "captionUk": "Будує назву змінної оточення з префікса, який застосунок дає під час монтування.",
+        "anchor": "queue-queueUrlVariable-procedure"
+      },
+      {
+        "name": "sqsQueueMessageProducerLive",
+        "kind": "adapter",
+        "signature": "(variablePrefix: string) => Layer.Layer<QueueMessageProducer, ConfigError.ConfigError>",
+        "fallback": "",
+        "caption": "The message producer on the real AWS SDK transport, reading the variables this prefix names.",
+        "captionUk": "Відправник повідомлень на справжньому транспорті AWS SDK, який читає змінні, названі цим префіксом.",
+        "anchor": "queue-sqsQueueMessageProducerLive-adapter"
+      },
+      {
+        "name": "sqsQueueMessageSourceLive",
+        "kind": "adapter",
+        "signature": "(variablePrefix: string) => Layer.Layer<QueueMessageSource, ConfigError.ConfigError>",
+        "fallback": "",
+        "caption": "The message source on the real AWS SDK transport, reading the variables this prefix names.",
+        "captionUk": "Джерело повідомлень на справжньому транспорті AWS SDK, яке читає змінні, названі цим префіксом.",
+        "anchor": "queue-sqsQueueMessageSourceLive-adapter"
+      },
+      {
+        "name": "QueueMessageNotDecodableError",
+        "kind": "failure",
+        "signature": "Data.TaggedError<{ readonly stage: QueueMessageDecodingStage; readonly cause: unknown }>",
+        "fallback": "",
+        "caption": "A message whose text this service cannot turn into an event.",
+        "captionUk": "Повідомлення, текст якого цей сервіс не може перетворити на подію.",
+        "anchor": "queue-QueueMessageNotDecodableError-failure"
+      },
+      {
+        "name": "UnknownEventTypeError",
+        "kind": "failure",
+        "signature": "Data.TaggedError<{ readonly eventType: string }>",
+        "fallback": "",
+        "caption": "A message naming an event type this service never registered.",
+        "captionUk": "Повідомлення, яке називає тип події, що його цей сервіс ніколи не реєстрував.",
+        "anchor": "queue-UnknownEventTypeError-failure"
+      },
+      {
+        "name": "<PREFIX>_QUEUE_URL",
+        "kind": "environment variable",
+        "signature": "refuses",
+        "fallback": "",
+        "caption": "The queue a consumer receives from and a producer sends to.",
+        "captionUk": "Черга, з якої отримує робітник і в яку надсилає відправник.",
+        "anchor": "queue-PREFIX-QUEUE-URL-environment-variable"
+      },
+      {
+        "name": "<PREFIX>_MAX_MESSAGES_PER_RECEIVE",
+        "kind": "environment variable",
+        "signature": "falls back",
+        "fallback": "10",
+        "caption": "How many messages one receive call asks for.",
+        "captionUk": "Скільки повідомлень просить один виклик отримання.",
+        "anchor": "queue-PREFIX-MAX-MESSAGES-PER-RECEIVE-environment-variable"
+      },
+      {
+        "name": "<PREFIX>_WAIT_TIME_SECONDS",
+        "kind": "environment variable",
+        "signature": "falls back",
+        "fallback": "20",
+        "caption": "How many seconds a receive call waits for a message before it comes back empty.",
+        "captionUk": "Скільки секунд виклик отримання чекає на повідомлення, перш ніж повернутись порожнім.",
+        "anchor": "queue-PREFIX-WAIT-TIME-SECONDS-environment-variable"
+      },
+      {
+        "name": "<PREFIX>_VISIBILITY_TIMEOUT_SECONDS",
+        "kind": "environment variable",
+        "signature": "falls back",
+        "fallback": "60",
+        "caption": "How many seconds a received message stays hidden from other consumers.",
+        "captionUk": "Скільки секунд отримане повідомлення лишається схованим від інших робітників.",
+        "anchor": "queue-PREFIX-VISIBILITY-TIMEOUT-SECONDS-environment-variable"
+      },
+      {
+        "name": "AWS_REGION",
+        "kind": "environment variable",
+        "signature": "handed on",
+        "fallback": "",
+        "caption": "The region the SQS client talks to.",
+        "captionUk": "Регіон, з яким говорить клієнт SQS.",
+        "anchor": "queue-AWS-REGION-environment-variable"
+      },
+      {
+        "name": "AWS_ENDPOINT_URL",
+        "kind": "environment variable",
+        "signature": "handed on",
+        "fallback": "",
+        "caption": "A local stand to talk to instead of real SQS, such as localstack.",
+        "captionUk": "Локальний стенд, з яким говорити замість справжнього SQS, наприклад localstack.",
+        "anchor": "queue-AWS-ENDPOINT-URL-environment-variable"
+      }
+    ]
+  }
+}

package/dictionary/queue.toon

@@ -0,0 +1,49 @@
+package: @satorio/machinery
+version: 0.2.1
+mechanism:
+  mechanism: queue
+  import: @satorio/machinery/queue
+  kind: adapter
+  page: mechanisms/queue
+  what: "Public entry to the queue mechanism: the envelope a message travels in, and the consumer that decides its fate."
+  whatUk: "Публічний вхід до механізму queue: конверт, у якому мандрує повідомлення, і робітник (consumer), який вирішує його долю."
+  rows[39]{name,kind,signature,fallback,caption,captionUk,anchor}:
+    defaultQueueRetrySchedule,value,QueueRetrySchedule,"","The waiting a consumer keeps when a service names no schedule of its own: growing pauses, jittered, and a limit on how often it tries.","Очікування, якого тримається робітник, коли сервіс не називає власного розкладу: зростальні паузи, з джитером, і межа на кількість спроб.",queue-defaultQueueRetrySchedule-value
+    ENVIRONMENT,value,"readonly EnvironmentEntry[]","","Every variable this adapter reads, and the one state each of them stands in.","Кожна змінна, яку читає цей адаптер, і один стан, у якому стоїть кожна з них.",queue-ENVIRONMENT-value
+    EventDefinitionRegistry,value,interface,"","What a service's own list of event definitions offers: whether an event type is known, and the definition behind it.","Що пропонує власний список визначень подій сервісу: чи тип події відомий і яке визначення за ним стоїть.",queue-EventDefinitionRegistry-value
+    IncomingQueueMessage,value,interface,"","One message as a handler meets it: the envelope's own fields, and the decoded event itself.","Одне повідомлення таким, яким його зустрічає обробник: власні поля конверта і сама декодована подія.",queue-IncomingQueueMessage-value
+    PayloadDecoder,value,type,"",What turns a stored payload of some version into the event a handler works with.,"Те, що перетворює збережений payload якоїсь версії на подію, з якою працює обробник.",queue-PayloadDecoder-value
+    QueueConsumerSettings,value,interface,"",What a consumer needs before it can receive a single message.,"Що потрібно робітникові, перш ніж він отримає бодай одне повідомлення.",queue-QueueConsumerSettings-value
+    QueueMessageBody,value,const,"","The envelope as it travels: the JSON text on the wire, read and written through one schema.","Конверт таким, яким він мандрує: текст JSON на дроті, прочитаний і записаний однією схемою.",queue-QueueMessageBody-value
+    QueueMessageConsumerOptions,value,interface,"",What a consumer needs to turn a queue message into work.,"Що потрібно робітникові, щоб перетворити повідомлення черги на роботу.",queue-QueueMessageConsumerOptions-value
+    QueueMessageOutcome,value,type,"","The fate of one message has exactly three endings: acknowledged, left for redelivery, or refused permanently.","Доля одного повідомлення має рівно три кінці: підтверджено, лишено на перевідправку або відмовлено назавжди.",queue-QueueMessageOutcome-value
+    QueueProducerSettings,value,interface,"","What a producer needs before it can send: the queue, and the same two variables the SDK decides for itself.","Що потрібно відправникові, перш ніж він надішле: черга і ті самі дві змінні, які SDK вирішує сам.",queue-QueueProducerSettings-value
+    QueueRetrySchedule,value,type,"",How a consumer waits and tries again while the queue itself does not answer.,"Як робітник чекає і пробує знову, поки сама черга не відповідає.",queue-QueueRetrySchedule-value
+    RedeliveryReason,value,type,"","Why a message goes back on the queue: it never decoded, or the handler rejected it.","Чому повідомлення повертається в чергу: воно так і не декодувалось, або обробник його відхилив.",queue-RedeliveryReason-value
+    SchemaVersion,value,const,"","The version a stored payload was shaped by: a whole number above zero, and never anything else.","Версія, якою надано форми збереженому payload: ціле число понад нуль і ніколи нічого іншого.",queue-SchemaVersion-value
+    SQS_DEFAULT_VISIBILITY_TIMEOUT_SECONDS,value,const,"","How long a received message stays hidden while a handler works on it, when nobody names a number.","Скільки отримане повідомлення лишається схованим, поки над ним працює обробник, коли ніхто не назвав числа.",queue-SQS-DEFAULT-VISIBILITY-TIMEOUT-SECONDS-value
+    StoredEventEnvelope,value,const,"",The shared queue contract every message travels in.,"Спільний контракт черги, у якому мандрує кожне повідомлення.",queue-StoredEventEnvelope-value
+    consumeQueueMessages,procedure,"<A, E, R>(options: QueueMessageConsumerOptions<A, E, R>) => Stream.Stream<QueueMessageOutcome, QueueMessageSourceUnavailableError, R | QueueMessageSource>","","Reads messages off the queue and hands each one to the handler, answering with the fate of every message it took.","Читає повідомлення з черги і віддає кожне обробникові, відповідаючи долею кожного взятого повідомлення.",queue-consumeQueueMessages-procedure
+    decodeQueueMessageBody,procedure,"(body: string) => Effect.Effect<StoredEventEnvelope, QueueMessageNotDecodableError>","","Reads a message body into an envelope, or refuses at the envelope stage and says what it could not read.","Читає тіло повідомлення в конверт або відмовляє вже на конверті й каже, чого не змогло прочитати.",queue-decodeQueueMessageBody-procedure
+    eventDefinitionRegistry,procedure,"<S extends Schema.Schema.AnyNoContext>(definitions: readonly VersionedEventDefinition<S>[]) => EventDefinitionRegistry<S>","",Builds a registry of known event definitions.,Будує реєстр відомих визначень подій.,queue-eventDefinitionRegistry-procedure
+    handlerRejectedMessage,procedure,"(error: unknown) => RedeliveryReason","",The reason for a message the handler itself rejected.,"Причина для повідомлення, яке відхилив сам обробник.",queue-handlerRejectedMessage-procedure
+    messageAcknowledged,procedure,"(messageId: string) => QueueMessageOutcome","","The fate of a message the handler took, so the queue may drop it.","Доля повідомлення, яке обробник узяв, тож черга може його викинути.",queue-messageAcknowledged-procedure
+    messageLeftForRedelivery,procedure,"(messageId: string, reason: RedeliveryReason) => QueueMessageOutcome","","The fate of a message that goes back on the queue, with the reason it did.","Доля повідомлення, яке повертається в чергу, разом із причиною, чому воно повернулось.",queue-messageLeftForRedelivery-procedure
+    messageNotDecodable,procedure,"(error: QueueMessageNotDecodableError) => RedeliveryReason","",The reason for a message that never decoded.,"Причина для повідомлення, яке так і не декодувалось.",queue-messageNotDecodable-procedure
+    messageRefusedPermanently,procedure,"(messageId: string, eventId: string, refusal: unknown) => QueueMessageOutcome","","The fate of a message no retry can help, so the platform's own redrive takes it from here.","Доля повідомлення, якому не поможе жодна спроба, тож далі його бере власний redrive платформи.",queue-messageRefusedPermanently-procedure
+    payloadDecoderFor,procedure,"<S extends Schema.Schema.AnyNoContext>(definition: VersionedEventDefinition<S>) => PayloadDecoder<Schema.Schema.Type<S>>","","Builds the payload decoder for one event definition, climbing a stored payload up to the version this code knows.","Будує декодер payload для одного визначення події, підіймаючи збережений payload до версії, яку знає цей код.",queue-payloadDecoderFor-procedure
+    queueConsumerSettings,procedure,"(variablePrefix: string) => Config.Config<QueueConsumerSettings>","",Reads every variable a consumer needs under one prefix.,"Читає кожну змінну, потрібну робітникові, під одним префіксом.",queue-queueConsumerSettings-procedure
+    queueMessageBodyOf,procedure,"(envelope: { readonly eventId: string; readonly eventType: string; readonly schemaVersion: number; readonly occurredAtIso: string; readonly payload: { readonly [key: string]: unknown } }) => string","","Builds the same envelope contract, but for sending: the producer sets exactly the fields the consumer expects to read.","Будує той самий контракт конверта, але для надсилання: відправник ставить рівно ті поля, які очікує прочитати робітник.",queue-queueMessageBodyOf-procedure
+    queueProducerSettings,procedure,"(variablePrefix: string) => Config.Config<QueueProducerSettings>","",Reads every variable a producer needs under one prefix.,"Читає кожну змінну, потрібну відправникові, під одним префіксом.",queue-queueProducerSettings-procedure
+    queueReadinessCheck,procedure,"(variablePrefix: string) => Effect.Effect<Option.Option<Effect.Effect<void, QueueMessageSourceUnavailableError>>, ConfigError.ConfigError>","","The readiness check for a queue, absent when no queue is mounted at all.","Перевірка готовності для черги, відсутня тоді, коли жодної черги не змонтовано.",queue-queueReadinessCheck-procedure
+    queueUrlVariable,procedure,"(variablePrefix: string) => string","",Builds the environment variable name from the prefix the application gives at mount time.,"Будує назву змінної оточення з префікса, який застосунок дає під час монтування.",queue-queueUrlVariable-procedure
+    sqsQueueMessageProducerLive,adapter,"(variablePrefix: string) => Layer.Layer<QueueMessageProducer, ConfigError.ConfigError>","","The message producer on the real AWS SDK transport, reading the variables this prefix names.","Відправник повідомлень на справжньому транспорті AWS SDK, який читає змінні, названі цим префіксом.",queue-sqsQueueMessageProducerLive-adapter
+    sqsQueueMessageSourceLive,adapter,"(variablePrefix: string) => Layer.Layer<QueueMessageSource, ConfigError.ConfigError>","","The message source on the real AWS SDK transport, reading the variables this prefix names.","Джерело повідомлень на справжньому транспорті AWS SDK, яке читає змінні, названі цим префіксом.",queue-sqsQueueMessageSourceLive-adapter
+    QueueMessageNotDecodableError,failure,"Data.TaggedError<{ readonly stage: QueueMessageDecodingStage; readonly cause: unknown }>","",A message whose text this service cannot turn into an event.,"Повідомлення, текст якого цей сервіс не може перетворити на подію.",queue-QueueMessageNotDecodableError-failure
+    UnknownEventTypeError,failure,"Data.TaggedError<{ readonly eventType: string }>","",A message naming an event type this service never registered.,"Повідомлення, яке називає тип події, що його цей сервіс ніколи не реєстрував.",queue-UnknownEventTypeError-failure
+    <PREFIX>_QUEUE_URL,environment variable,refuses,"",The queue a consumer receives from and a producer sends to.,"Черга, з якої отримує робітник і в яку надсилає відправник.",queue-PREFIX-QUEUE-URL-environment-variable
+    <PREFIX>_MAX_MESSAGES_PER_RECEIVE,environment variable,falls back,"10",How many messages one receive call asks for.,Скільки повідомлень просить один виклик отримання.,queue-PREFIX-MAX-MESSAGES-PER-RECEIVE-environment-variable
+    <PREFIX>_WAIT_TIME_SECONDS,environment variable,falls back,"20",How many seconds a receive call waits for a message before it comes back empty.,"Скільки секунд виклик отримання чекає на повідомлення, перш ніж повернутись порожнім.",queue-PREFIX-WAIT-TIME-SECONDS-environment-variable
+    <PREFIX>_VISIBILITY_TIMEOUT_SECONDS,environment variable,falls back,"60",How many seconds a received message stays hidden from other consumers.,Скільки секунд отримане повідомлення лишається схованим від інших робітників.,queue-PREFIX-VISIBILITY-TIMEOUT-SECONDS-environment-variable
+    AWS_REGION,environment variable,handed on,"",The region the SQS client talks to.,"Регіон, з яким говорить клієнт SQS.",queue-AWS-REGION-environment-variable
+    AWS_ENDPOINT_URL,environment variable,handed on,"","A local stand to talk to instead of real SQS, such as localstack.","Локальний стенд, з яким говорити замість справжнього SQS, наприклад localstack.",queue-AWS-ENDPOINT-URL-environment-variable