@fungi.computer/puffball 0.0.0-stage → 0.0.1

package/docs/api/git-representation.md

@@ -0,0 +1,56 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/puffball**](README.md)
+
+---
+
+[@fungi.computer/puffball](README.md) / git-representation
+
+# git-representation
+
+## Variables
+
+### gitRepositoryNameSchema
+
+```ts
+const gitRepositoryNameSchema: ZodString;
+```
+
+Local repository name; the host maps it into the installation's namespace.
+
+---
+
+### gitSha1Schema
+
+```ts
+const gitSha1Schema: ZodString;
+```
+
+A lowercase Git SHA-1 object ID, including the zero ID for creation/deletion.
+
+---
+
+### gitRefUpdateSchema
+
+```ts
+const gitRefUpdateSchema: ZodObject<
+  {
+    ref: ZodString;
+    before: ZodString;
+    after: ZodString;
+  },
+  $strict
+>;
+```
+
+One ref update, bounded before a host asks the App or forwards the push.
+
+---
+
+### gitPushEventIdSchema
+
+```ts
+const gitPushEventIdSchema: ZodString;
+```
+
+Host push event IDs include the Computer and local event identity.

package/docs/api/inbox.md

@@ -0,0 +1,289 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/puffball**](README.md)
+
+---
+
+[@fungi.computer/puffball](README.md) / inbox
+
+# inbox
+
+## Type Aliases
+
+### MemberInboxSession
+
+```ts
+type MemberInboxSession = typeof memberInboxSessionSchema.Type;
+```
+
+Parsed Session facts in the shared Inbox vocabulary.
+
+---
+
+### WorkflowReviewKey
+
+```ts
+type WorkflowReviewKey = typeof workflowReviewKeySchema.Type;
+```
+
+The run, node and iteration that identify one human review.
+
+---
+
+### WorkflowReviewInboxItem
+
+```ts
+type WorkflowReviewInboxItem = typeof workflowReviewInboxItemSchema.Type;
+```
+
+A reviewer-visible projection of a saved Workflow review.
+
+---
+
+### MemberInboxItem
+
+```ts
+type MemberInboxItem = typeof memberInboxItemSchema.Type;
+```
+
+An Inbox row is a Session or a human Workflow review.
+
+---
+
+### MemberInboxDeltaItem
+
+```ts
+type MemberInboxDeltaItem = typeof memberInboxDeltaItemSchema.Type;
+```
+
+One record carried by an Inbox row delta.
+
+## Variables
+
+### memberInboxSessionSchema
+
+```ts
+const memberInboxSessionSchema: Union<
+  readonly [
+    Struct<{
+      agentId: String;
+      sessionId: String;
+      title: String;
+      triggerId: optionalKey<String>;
+      createdAt: Number;
+      lastActivityAt: Number;
+      settledAt: optionalKey<Number>;
+      visitedAt: optionalKey<Number>;
+      state: Literals<readonly ["needs_you", "running", "errored", "done"]>;
+    }>,
+    Struct<{
+      agentId: String;
+      sessionId: String;
+      state: Literal<"unavailable">;
+    }>,
+  ]
+>;
+```
+
+One Session, projected by its Agent owner, with this member's visit.
+
+---
+
+### workflowReviewKeySchema
+
+```ts
+const workflowReviewKeySchema: Struct<{
+  runId: String;
+  nodeId: String;
+  iteration: String;
+}>;
+```
+
+A review's engine identity, independent of its native delivery coordinates.
+
+---
+
+### workflowReviewInboxItemSchema
+
+```ts
+const workflowReviewInboxItemSchema: Struct<{
+  kind: Literal<"workflow-review">;
+  key: Struct<{
+    runId: String;
+    nodeId: String;
+    iteration: String;
+  }>;
+  installationId: String;
+  workflowId: NullOr<String>;
+  workflowTitle: String;
+  reviewTitle: String;
+  reviewers: Literals<readonly ["runner", "owners"]>;
+  show: $Array<Codec<Json, Json, never, never>>;
+  choices: optionalKey<$Array<String>>;
+  openedAt: Number;
+  expiresAt: Number;
+  state: Literals<
+    readonly ["pending", "answered", "delivered", "timed_out", "closed"]
+  >;
+}>;
+```
+
+Facts delivered to an admitted reviewer by the run owner, never a fake Session.
+
+---
+
+### memberInboxItemSchema
+
+```ts
+const memberInboxItemSchema: Union<
+  readonly [
+    Union<
+      readonly [
+        Struct<{
+          agentId: String;
+          sessionId: String;
+          title: String;
+          triggerId: optionalKey<String>;
+          createdAt: Number;
+          lastActivityAt: Number;
+          settledAt: optionalKey<Number>;
+          visitedAt: optionalKey<Number>;
+          state: Literals<readonly ["needs_you", "running", "errored", "done"]>;
+        }>,
+        Struct<{
+          agentId: String;
+          sessionId: String;
+          state: Literal<"unavailable">;
+        }>,
+      ]
+    >,
+    Struct<{
+      kind: Literal<"workflow-review">;
+      key: Struct<{
+        runId: String;
+        nodeId: String;
+        iteration: String;
+      }>;
+      installationId: String;
+      workflowId: NullOr<String>;
+      workflowTitle: String;
+      reviewTitle: String;
+      reviewers: Literals<readonly ["runner", "owners"]>;
+      show: $Array<Codec<Json, Json, never, never>>;
+      choices: optionalKey<$Array<String>>;
+      openedAt: Number;
+      expiresAt: Number;
+      state: Literals<
+        readonly ["pending", "answered", "delivered", "timed_out", "closed"]
+      >;
+    }>,
+  ]
+>;
+```
+
+The INBOX wire has one vocabulary on every host and App client.
+
+---
+
+### memberInboxDeltaItemSchema
+
+```ts
+const memberInboxDeltaItemSchema: Union<
+  readonly [
+    Union<
+      readonly [
+        Union<
+          readonly [
+            Struct<{
+              agentId: String;
+              sessionId: String;
+              title: String;
+              triggerId: optionalKey<String>;
+              createdAt: Number;
+              lastActivityAt: Number;
+              settledAt: optionalKey<Number>;
+              visitedAt: optionalKey<Number>;
+              state: Literals<
+                readonly ["needs_you", "running", "errored", "done"]
+              >;
+            }>,
+            Struct<{
+              agentId: String;
+              sessionId: String;
+              state: Literal<"unavailable">;
+            }>,
+          ]
+        >,
+        Struct<{
+          kind: Literal<"workflow-review">;
+          key: Struct<{
+            runId: String;
+            nodeId: String;
+            iteration: String;
+          }>;
+          installationId: String;
+          workflowId: NullOr<String>;
+          workflowTitle: String;
+          reviewTitle: String;
+          reviewers: Literals<readonly ["runner", "owners"]>;
+          show: $Array<Codec<Json, Json, never, never>>;
+          choices: optionalKey<$Array<String>>;
+          openedAt: Number;
+          expiresAt: Number;
+          state: Literals<
+            readonly ["pending", "answered", "delivered", "timed_out", "closed"]
+          >;
+        }>,
+      ]
+    >,
+    Struct<{
+      agentId: String;
+      sessionId: String;
+      deleted: Literal<true>;
+    }>,
+  ]
+>;
+```
+
+A row replacement or an Agent-owned Session deletion.
+
+## Functions
+
+### memberInboxKey()
+
+```ts
+function memberInboxKey(agentId, sessionId): string;
+```
+
+Stable identity of one Session across Agents.
+
+#### Parameters
+
+| Parameter   | Type     |
+| ----------- | -------- |
+| `agentId`   | `string` |
+| `sessionId` | `string` |
+
+#### Returns
+
+`string`
+
+---
+
+### memberInboxItemKey()
+
+```ts
+function memberInboxItemKey(item): string;
+```
+
+Stable placement across review transitions; Map iterations remain distinct.
+
+#### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `item`    | \| \{ `agentId`: `string`; `sessionId`: `string`; `title`: `string`; `triggerId?`: `string`; `createdAt`: `number`; `lastActivityAt`: `number`; `settledAt?`: `number`; `visitedAt?`: `number`; `state`: `"running"` \| `"done"` \| `"errored"` \| `"needs_you"`; \} \| \{ `agentId`: `string`; `sessionId`: `string`; `state`: `"unavailable"`; \} \| \{ `kind`: `"workflow-review"`; `key`: \{ `runId`: `string`; `nodeId`: `string`; `iteration`: `string`; \}; `installationId`: `string`; `workflowId`: `string` \| `null`; `workflowTitle`: `string`; `reviewTitle`: `string`; `reviewers`: `"owners"` \| `"runner"`; `show`: readonly `Json`[]; `choices?`: readonly `string`[]; `openedAt`: `number`; `expiresAt`: `number`; `state`: `"closed"` \| `"pending"` \| `"answered"` \| `"delivered"` \| `"timed_out"`; \} \| \{ `agentId`: `string`; `sessionId`: `string`; `deleted`: `true`; \} |
+
+#### Returns
+
+`string`