@fungi.computer/carrier 0.0.0-stage → 0.1.0

package/docs/api/post-d1.md

@@ -0,0 +1,184 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/carrier**](README.md)
+
+---
+
+[@fungi.computer/carrier](README.md) / post-d1
+
+# post-d1
+
+## Type Aliases
+
+### SqlPostOptions
+
+```ts
+type SqlPostOptions<R> = Readonly<{
+  routes: R;
+  failureDetail?: (cause) => string;
+  retry?: Readonly<{
+    maxAttempts: number;
+    baseDelayMs: number;
+    maxDelayMs: number;
+  }>;
+  now: () => number;
+  scheduleWake: (at) => Promise<void>;
+}>;
+```
+
+SQL native Carrier runtime configuration; route decisions remain in Post.
+
+#### Type Parameters
+
+| Type Parameter                                                                       |
+| ------------------------------------------------------------------------------------ |
+| `R` _extends_ `Record`\<`string`, [`PostRegistryRoute`](post.md#postregistryroute)\> |
+
+---
+
+### SqlPostRuntime
+
+```ts
+type SqlPostRuntime = Readonly<{
+  execute: (
+    job,
+    signal?,
+  ) => Promise<
+    Readonly<{
+      kind: "completed";
+    }>
+  >;
+  enqueueDue: (limit?, afterKey?) => Promise<string | undefined>;
+  read: (key) => Promise<PostRow | undefined>;
+}>;
+```
+
+Async inspection and Watchdog executor shared by D1 and PostgreSQL.
+
+---
+
+### D1PostSource
+
+```ts
+type D1PostSource = Readonly<{
+  text: string;
+  values: readonly (string | number | null)[];
+}>;
+```
+
+Trusted SELECT yielding post_key, envelope_json, queue_name, next_attempt_at and
+job_id.
+
+---
+
+### D1Post
+
+```ts
+type D1Post = SqlPostRuntime &
+  Readonly<{
+    send: (envelope) => readonly D1PreparedStatement[];
+    sendFromSelect: (source) => readonly D1PreparedStatement[];
+  }>;
+```
+
+Post admission statements; callers commit them with the originating D1 fact.
+
+---
+
+### D1PostErasureStatement
+
+```ts
+type D1PostErasureStatement = Readonly<{
+  text: string;
+  values: readonly (string | number | null)[];
+}>;
+```
+
+Native erasure statement; its values remain bound by the caller's D1 driver.
+
+## Variables
+
+### postD1Schema
+
+```ts
+const postD1Schema: readonly string[];
+```
+
+Carrier-owned D1 schema, applied by the deployment migration owner.
+
+## Functions
+
+### createD1Post()
+
+```ts
+function createD1Post<R>(options): D1Post;
+```
+
+Bind the Post registry to native D1 batch admission and the shared delivery
+engine.
+
+#### Type Parameters
+
+| Type Parameter                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `R` _extends_ `Record`\<`string`, `Readonly`\<\{ `addressKind`: `string`; `address`: `Codec`\<`unknown`, `unknown`\>; `event`: `Codec`\<`unknown`, `unknown`\>; `encodeEnvelope`: (`envelope`) => `object`; `parseDelivery`: (`envelope`) => `object`; `prepareEnvelope?`: (`envelope`, `signal`) => `Promise`\<\{ `key`: `string`; `kind`: `string`; `address`: `unknown`; `event`: `unknown`; \}\>; `recordDelivered?`: (`envelope`) => `void`; `nameOf`: (`envelope`) => `string`; `namespace`: `Readonly`\<\{ `getByName`: (`name`) => `Readonly`\<\{ `deliver`: (`envelope`) => `Promise`\<[`PostDeliveryResult`](post.md#postdeliveryresult)\>; \}\>; \}\>; `recordCursor?`: (`envelope`, `cursor`) => `void`; `recordRefused?`: (`envelope`) => `void`; \}\>\> |
+
+#### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                                                                                                 |
+| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | `Readonly`\<\{ `routes`: `R`; `failureDetail?`: (`cause`) => `string`; `retry?`: `Readonly`\<\{ `maxAttempts`: `number`; `baseDelayMs`: `number`; `maxDelayMs`: `number`; \}\>; `now`: () => `number`; `scheduleWake`: (`at`) => `Promise`\<`void`\>; \}\> & `Readonly`\<\{ `database`: `D1Database`; `watchdog`: `D1Watchdog`; \}\> |
+
+#### Returns
+
+[`D1Post`](#d1post)
+
+---
+
+### prepareD1PostAdmission()
+
+```ts
+function prepareD1PostAdmission(
+  database,
+  source,
+): readonly D1PreparedStatement[];
+```
+
+Prepare conditional envelopes and their jobs inside the producer's D1 batch.
+
+#### Parameters
+
+| Parameter  | Type                            |
+| ---------- | ------------------------------- |
+| `database` | `D1Database`                    |
+| `source`   | [`D1PostSource`](#d1postsource) |
+
+#### Returns
+
+readonly `D1PreparedStatement`[]
+
+---
+
+### purgeD1Post()
+
+```ts
+function purgeD1Post(source): readonly Readonly<{
+  text: string;
+  values: readonly (string | number | null)[];
+}>[];
+```
+
+Remove selected recipient queues, including every envelope and attempt,
+atomically. The trusted SELECT yields queue_name from producer/envelope facts,
+not job state.
+
+#### Parameters
+
+| Parameter | Type                                                |
+| --------- | --------------------------------------------------- |
+| `source`  | [`D1PostErasureStatement`](#d1posterasurestatement) |
+
+#### Returns
+
+readonly `Readonly`\<\{ `text`: `string`; `values`: readonly (`string` \|
+`number` \| `null`)[]; \}\>[]

package/docs/api/post-postgres.md

@@ -0,0 +1,108 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/carrier**](README.md)
+
+---
+
+[@fungi.computer/carrier](README.md) / post-postgres
+
+# post-postgres
+
+## Type Aliases
+
+### PostgresPost
+
+```ts
+type PostgresPost = SqlPostRuntime &
+  Readonly<{
+    send: (client, envelope) => Promise<void>;
+  }>;
+```
+
+Post on PostgreSQL; the producer retains ownership of BEGIN and COMMIT.
+
+---
+
+### PostgresPostErasureStatement
+
+```ts
+type PostgresPostErasureStatement = Readonly<{
+  text: string;
+  values: readonly (string | number | null)[];
+}>;
+```
+
+Parameterized native erasure; the producer controls BEGIN and COMMIT.
+
+## Variables
+
+### postPostgresSchema
+
+```ts
+const postPostgresSchema: readonly string[];
+```
+
+Carrier-owned PostgreSQL schema, applied by the deployment migration owner.
+
+## Functions
+
+### createPostgresPost()
+
+```ts
+function createPostgresPost<R>(options): PostgresPost;
+```
+
+Bind the Post registry to a PostgreSQL owner and the shared delivery engine.
+
+#### Type Parameters
+
+| Type Parameter                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `R` _extends_ `Record`\<`string`, `Readonly`\<\{ `addressKind`: `string`; `address`: `Codec`\<`unknown`, `unknown`\>; `event`: `Codec`\<`unknown`, `unknown`\>; `encodeEnvelope`: (`envelope`) => `object`; `parseDelivery`: (`envelope`) => `object`; `prepareEnvelope?`: (`envelope`, `signal`) => `Promise`\<\{ `key`: `string`; `kind`: `string`; `address`: `unknown`; `event`: `unknown`; \}\>; `recordDelivered?`: (`envelope`) => `void`; `nameOf`: (`envelope`) => `string`; `namespace`: `Readonly`\<\{ `getByName`: (`name`) => `Readonly`\<\{ `deliver`: (`envelope`) => `Promise`\<[`PostDeliveryResult`](post.md#postdeliveryresult)\>; \}\>; \}\>; `recordCursor?`: (`envelope`, `cursor`) => `void`; `recordRefused?`: (`envelope`) => `void`; \}\>\> |
+
+#### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                                                                                                                                     |
+| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | `Readonly`\<\{ `routes`: `R`; `failureDetail?`: (`cause`) => `string`; `retry?`: `Readonly`\<\{ `maxAttempts`: `number`; `baseDelayMs`: `number`; `maxDelayMs`: `number`; \}\>; `now`: () => `number`; `scheduleWake`: (`at`) => `Promise`\<`void`\>; \}\> & `Readonly`\<\{ `database`: `Pick`\<`Pool`, `"query"` \| `"connect"`\>; `watchdog`: `PostgresWatchdog`; \}\> |
+
+#### Returns
+
+[`PostgresPost`](#postgrespost)
+
+---
+
+### purgePostgresPost()
+
+```ts
+function purgePostgresPost(source): readonly Readonly<{
+  text: string;
+  values: readonly (string | number | null)[];
+}>[];
+```
+
+Purge selected recipient queues, including all envelopes and attempts. The
+trusted SELECT yields queue_name from producer/envelope facts, not job state.
+
+#### Parameters
+
+| Parameter | Type                                                            |
+| --------- | --------------------------------------------------------------- |
+| `source`  | [`PostgresPostErasureStatement`](#postgresposterasurestatement) |
+
+#### Returns
+
+readonly `Readonly`\<\{ `text`: `string`; `values`: readonly (`string` \|
+`number` \| `null`)[]; \}\>[]
+
+## References
+
+### SqlPostOptions
+
+Re-exports [SqlPostOptions](post-d1.md#sqlpostoptions)
+
+---
+
+### SqlPostRuntime
+
+Re-exports [SqlPostRuntime](post-d1.md#sqlpostruntime)