@fungi.computer/agar 0.0.0-stage → 0.0.1

package/docs/api/git-rpc.md

@@ -0,0 +1,243 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/agar**](README.md)
+
+---
+
+[@fungi.computer/agar](modules.md) / git-rpc
+
+# git-rpc
+
+## Type Aliases
+
+### NativeGitOperation
+
+```ts
+type NativeGitOperation = "create" | "fork" | "read" | "write" | "exchange";
+```
+
+Host operation required before a native Git effect.
+
+## Variables
+
+### nativeGitCodecs
+
+```ts
+const nativeGitCodecs: object;
+```
+
+The native tuple and result grammar shared by the handle and frame entrypoint.
+
+#### Type Declaration
+
+| Name                                          | Type                                                                                                                                                                                                                                                                                                                                                                                                                 | Default value |
+| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
+| <a id="property-create"></a> `create`         | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `create.args`                                 | `ZodTuple`\<\[`ZodString`, `ZodOptional`\<`ZodObject`\<\{ `description`: `ZodOptional`\<`ZodString`\>; `defaultBranch`: `ZodOptional`\<`ZodString`\>; \}, `$strict`\>\>\], `null`\>                                                                                                                                                                                                                                  | -             |
+| `create.result`                               | `ZodObject`\<\{ `name`: `ZodString`; `defaultBranch`: `ZodString`; `lastPushAt`: `ZodNullable`\<`ZodString`\>; `source`: `ZodNullable`\<`ZodString`\>; \}, `$strict`\>                                                                                                                                                                                                                                               | `info`        |
+| <a id="property-fork"></a> `fork`             | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `fork.args`                                   | `ZodTuple`\<\[`ZodString`, `ZodString`, `ZodOptional`\<`ZodObject`\<\{ `description`: `ZodOptional`\<`ZodString`\>; \}, `$strict`\>\>\], `null`\>                                                                                                                                                                                                                                                                    | -             |
+| `fork.result`                                 | `ZodObject`\<\{ `name`: `ZodString`; `defaultBranch`: `ZodString`; `lastPushAt`: `ZodNullable`\<`ZodString`\>; `source`: `ZodNullable`\<`ZodString`\>; \}, `$strict`\>                                                                                                                                                                                                                                               | `info`        |
+| <a id="property-cloneurl"></a> `cloneUrl`     | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `cloneUrl.args`                               | `ZodTuple`\<\[`ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                                | -             |
+| `cloneUrl.result`                             | `ZodURL`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| <a id="property-info"></a> `info`             | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `info.args`                                   | `ZodTuple`\<\[`ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                                | -             |
+| `info.result`                                 | `ZodNullable`\<`ZodObject`\<\{ `name`: `ZodString`; `defaultBranch`: `ZodString`; `lastPushAt`: `ZodNullable`\<`ZodString`\>; `source`: `ZodNullable`\<`ZodString`\>; \}, `$strict`\>\>                                                                                                                                                                                                                              | -             |
+| <a id="property-delete"></a> `delete`         | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `delete.args`                                 | `ZodTuple`\<\[`ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                                | -             |
+| `delete.result`                               | `ZodBoolean`                                                                                                                                                                                                                                                                                                                                                                                                         | -             |
+| <a id="property-log"></a> `log`               | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `log.args`                                    | `ZodTuple`\<\[`ZodString`, `ZodObject`\<\{ `ref`: `ZodString`; `limit`: `ZodOptional`\<`ZodNumber`\>; `offset`: `ZodOptional`\<`ZodNumber`\>; \}, `$strict`\>\], `null`\>                                                                                                                                                                                                                                            | -             |
+| `log.result`                                  | `ZodArray`\<`ZodObject`\<\{ `hash`: `ZodString`; `treeHash`: `ZodString`; `message`: `ZodString`; `author`: `ZodObject`\<\{ `name`: `ZodString`; `email`: `ZodString`; \}, `$strict`\>; `committer`: `ZodObject`\<\{ `name`: `ZodString`; `email`: `ZodString`; \}, `$strict`\>; `parents`: `ZodArray`\<`ZodString`\>; `authoredAt`: `ZodNumber`; `committedAt`: `ZodNumber`; \}, `$strict`\>\>                      | -             |
+| <a id="property-readcommit"></a> `readCommit` | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `readCommit.args`                             | `ZodTuple`\<\[`ZodString`, `ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                   | -             |
+| `readCommit.result`                           | `ZodNullable`\<`ZodObject`\<\{ `hash`: `ZodString`; `treeHash`: `ZodString`; `message`: `ZodString`; `author`: `ZodObject`\<\{ `name`: `ZodString`; `email`: `ZodString`; \}, `$strict`\>; `committer`: `ZodObject`\<\{ `name`: `ZodString`; `email`: `ZodString`; \}, `$strict`\>; `parents`: `ZodArray`\<`ZodString`\>; `authoredAt`: `ZodNumber`; `committedAt`: `ZodNumber`; \}, `$strict`\>\>                   | -             |
+| <a id="property-readtree"></a> `readTree`     | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `readTree.args`                               | `ZodTuple`\<\[`ZodString`, `ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                   | -             |
+| `readTree.result`                             | `ZodNullable`\<`ZodArray`\<`ZodObject`\<\{ `name`: `ZodString`; `mode`: `ZodString`; `hash`: `ZodString`; `type`: `ZodEnum`\<\{ `blob`: `"blob"`; `tree`: `"tree"`; `commit`: `"commit"`; \}\>; \}, `$strict`\>\>\>                                                                                                                                                                                                  | -             |
+| <a id="property-readblob"></a> `readBlob`     | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `readBlob.args`                               | `ZodTuple`\<\[`ZodString`, `ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                   | -             |
+| `readBlob.result`                             | `ZodNullable`\<`ZodCustom`\<`Uint8Array`\<`ArrayBuffer`\>, `Uint8Array`\<`ArrayBuffer`\>\>\>                                                                                                                                                                                                                                                                                                                         | -             |
+| <a id="property-refs"></a> `refs`             | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `refs.args`                                   | `ZodTuple`\<\[`ZodString`\], `null`\>                                                                                                                                                                                                                                                                                                                                                                                | -             |
+| `refs.result`                                 | `ZodArray`\<`ZodObject`\<\{ `name`: `ZodString`; `hash`: `ZodString`; \}, `$strict`\>\>                                                                                                                                                                                                                                                                                                                              | -             |
+| <a id="property-exchange"></a> `exchange`     | `object`                                                                                                                                                                                                                                                                                                                                                                                                             | -             |
+| `exchange.args`                               | `ZodTuple`\<\[`ZodString`, `ZodObject`\<\{ `service`: `ZodEnum`\<\{ `upload-pack`: `"upload-pack"`; `receive-pack`: `"receive-pack"`; \}\>; `phase`: `ZodEnum`\<\{ `advertise`: `"advertise"`; `exchange`: `"exchange"`; \}\>; `body`: `ZodNullable`\<`ZodCustom`\<`Uint8Array`\<`ArrayBuffer`\>, `Uint8Array`\<`ArrayBuffer`\>\>\>; `headers`: `ZodRecord`\<`ZodString`, `ZodString`\>; \}, `$strict`\>\], `null`\> | -             |
+| `exchange.result`                             | `ZodObject`\<\{ `status`: `ZodNumber`; `headers`: `ZodRecord`\<`ZodString`, `ZodString`\>; `body`: `ZodCustom`\<`Uint8Array`\<`ArrayBuffer`\>, `Uint8Array`\<`ArrayBuffer`\>\>; \}, `$strict`\>                                                                                                                                                                                                                      | `response`    |
+
+---
+
+### nativeGitFrameMethods
+
+```ts
+const nativeGitFrameMethods: object;
+```
+
+Native Git preserves tuples and binary values through the shared frame factory.
+
+#### Type Declaration
+
+| Name                                            | Type                                                                                                                                                                                                                                                                              | Description                                                           |
+| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| <a id="property-create-1"></a> `create`         | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `create.decodeArgs()`                           | (`raw`) => \[`string`, \{ `description?`: `string`; `defaultBranch?`: `string`; \}?\]                                                                                                                                                                                             | Decode the native positional arguments with the method's tuple codec. |
+| `create.decodeResult()`                         | (`raw`) => `object`                                                                                                                                                                                                                                                               | Validate the native result, preserving binary values.                 |
+| `create.requiredOperations()`                   | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-fork-1"></a> `fork`             | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `fork.decodeArgs()`                             | (`raw`) => \[`string`, `string`, \{ `description?`: `string`; \}?\]                                                                                                                                                                                                               | Decode the native positional arguments with the method's tuple codec. |
+| `fork.decodeResult()`                           | (`raw`) => `object`                                                                                                                                                                                                                                                               | Validate the native result, preserving binary values.                 |
+| `fork.requiredOperations()`                     | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-cloneurl-1"></a> `cloneUrl`     | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `cloneUrl.decodeArgs()`                         | (`raw`) => \[`string`\]                                                                                                                                                                                                                                                           | Decode the native positional arguments with the method's tuple codec. |
+| `cloneUrl.decodeResult()`                       | (`raw`) => `string`                                                                                                                                                                                                                                                               | Validate the native result, preserving binary values.                 |
+| `cloneUrl.requiredOperations()`                 | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-info-1"></a> `info`             | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `info.decodeArgs()`                             | (`raw`) => \[`string`\]                                                                                                                                                                                                                                                           | Decode the native positional arguments with the method's tuple codec. |
+| `info.decodeResult()`                           | (`raw`) => \| \{ `name`: `string`; `defaultBranch`: `string`; `lastPushAt`: `string` \| `null`; `source`: `string` \| `null`; \} \| `null`                                                                                                                                        | Validate the native result, preserving binary values.                 |
+| `info.requiredOperations()`                     | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-delete-1"></a> `delete`         | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `delete.decodeArgs()`                           | (`raw`) => \[`string`\]                                                                                                                                                                                                                                                           | Decode the native positional arguments with the method's tuple codec. |
+| `delete.decodeResult()`                         | (`raw`) => `boolean`                                                                                                                                                                                                                                                              | Validate the native result, preserving binary values.                 |
+| `delete.requiredOperations()`                   | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-log-1"></a> `log`               | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `log.decodeArgs()`                              | (`raw`) => \[`string`, \{ `ref`: `string`; `limit?`: `number`; `offset?`: `number`; \}\]                                                                                                                                                                                          | Decode the native positional arguments with the method's tuple codec. |
+| `log.decodeResult()`                            | (`raw`) => `object`[]                                                                                                                                                                                                                                                             | Validate the native result, preserving binary values.                 |
+| `log.requiredOperations()`                      | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-readcommit-1"></a> `readCommit` | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `readCommit.decodeArgs()`                       | (`raw`) => \[`string`, `string`\]                                                                                                                                                                                                                                                 | Decode the native positional arguments with the method's tuple codec. |
+| `readCommit.decodeResult()`                     | (`raw`) => \| \{ `hash`: `string`; `treeHash`: `string`; `message`: `string`; `author`: \{ `name`: `string`; `email`: `string`; \}; `committer`: \{ `name`: `string`; `email`: `string`; \}; `parents`: `string`[]; `authoredAt`: `number`; `committedAt`: `number`; \} \| `null` | Validate the native result, preserving binary values.                 |
+| `readCommit.requiredOperations()`               | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-readtree-1"></a> `readTree`     | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `readTree.decodeArgs()`                         | (`raw`) => \[`string`, `string`\]                                                                                                                                                                                                                                                 | Decode the native positional arguments with the method's tuple codec. |
+| `readTree.decodeResult()`                       | (`raw`) => `object`[] \| `null`                                                                                                                                                                                                                                                   | Validate the native result, preserving binary values.                 |
+| `readTree.requiredOperations()`                 | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-readblob-1"></a> `readBlob`     | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `readBlob.decodeArgs()`                         | (`raw`) => \[`string`, `string`\]                                                                                                                                                                                                                                                 | Decode the native positional arguments with the method's tuple codec. |
+| `readBlob.decodeResult()`                       | (`raw`) => `Uint8Array`\<`ArrayBuffer`\> \| `null`                                                                                                                                                                                                                                | Validate the native result, preserving binary values.                 |
+| `readBlob.requiredOperations()`                 | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-refs-1"></a> `refs`             | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `refs.decodeArgs()`                             | (`raw`) => \[`string`\]                                                                                                                                                                                                                                                           | Decode the native positional arguments with the method's tuple codec. |
+| `refs.decodeResult()`                           | (`raw`) => `object`[]                                                                                                                                                                                                                                                             | Validate the native result, preserving binary values.                 |
+| `refs.requiredOperations()`                     | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+| <a id="property-exchange-1"></a> `exchange`     | `object`                                                                                                                                                                                                                                                                          | -                                                                     |
+| `exchange.decodeArgs()`                         | (`raw`) => \[`string`, \{ `service`: `"upload-pack"` \| `"receive-pack"`; `phase`: `"advertise"` \| `"exchange"`; `body`: `Uint8Array`\<`ArrayBuffer`\> \| `null`; `headers`: `Record`\<`string`, `string`\>; \}\]                                                                | Decode the native positional arguments with the method's tuple codec. |
+| `exchange.decodeResult()`                       | (`raw`) => `object`                                                                                                                                                                                                                                                               | Validate the native result, preserving binary values.                 |
+| `exchange.requiredOperations()`                 | (`args`) => readonly `string`[]                                                                                                                                                                                                                                                   | Operations the host must grant for these decoded arguments.           |
+
+---
+
+### nativeGitMethodNameSchema
+
+```ts
+const nativeGitMethodNameSchema: ZodEnum<{
+  info: "info";
+  create: "create";
+  log: "log";
+  delete: "delete";
+  exchange: "exchange";
+  fork: "fork";
+  cloneUrl: "cloneUrl";
+  readCommit: "readCommit";
+  readTree: "readTree";
+  readBlob: "readBlob";
+  refs: "refs";
+}>;
+```
+
+Native method identity is a source-owned refinement, not a transport parser.
+
+## Functions
+
+### invokeNativeGit()
+
+```ts
+function invokeNativeGit(
+  git,
+  method,
+  raw,
+): Promise<
+  | string
+  | boolean
+  | Uint8Array<ArrayBufferLike>
+  | object[]
+  | Readonly<{
+      status: number;
+      headers: Readonly<Record<string, string>>;
+      body: Uint8Array;
+    }>
+  | Readonly<{
+      name: string;
+      defaultBranch: string;
+      lastPushAt: string | null;
+      source: string | null;
+    }>
+  | Readonly<{
+      hash: string;
+      treeHash: string;
+      message: string;
+      author: {
+        name: string;
+        email: string;
+      };
+      committer: {
+        name: string;
+        email: string;
+      };
+      parents: string[];
+      authoredAt: number;
+      committedAt: number;
+    }>
+  | Readonly<{
+      hash: string;
+      treeHash: string;
+      message: string;
+      author: {
+        name: string;
+        email: string;
+      };
+      committer: {
+        name: string;
+        email: string;
+      };
+      parents: string[];
+      authoredAt: number;
+      committedAt: number;
+    }>[]
+  | Readonly<{
+      name: string;
+      mode: string;
+      hash: string;
+      type: "blob" | "tree" | "commit";
+    }>[]
+  | null
+>;
+```
+
+Dispatch owned tuples through the retained native handle without a JSON
+conversion.
+
+#### Parameters
+
+| Parameter | Type                              |
+| --------- | --------------------------------- |
+| `git`     | [`GitBinding`](git.md#gitbinding) |
+| `method`  | `string`                          |
+| `raw`     | readonly `unknown`[]              |
+
+#### Returns
+
+`Promise`\< \| `string` \| `boolean` \| `Uint8Array`\<`ArrayBufferLike`\> \|
+`object`[] \| `Readonly`\<\{ `status`: `number`; `headers`:
+`Readonly`\<`Record`\<`string`, `string`\>\>; `body`: `Uint8Array`; \}\> \|
+`Readonly`\<\{ `name`: `string`; `defaultBranch`: `string`; `lastPushAt`:
+`string` \| `null`; `source`: `string` \| `null`; \}\> \| `Readonly`\<\{ `hash`:
+`string`; `treeHash`: `string`; `message`: `string`; `author`: \{ `name`:
+`string`; `email`: `string`; \}; `committer`: \{ `name`: `string`; `email`:
+`string`; \}; `parents`: `string`[]; `authoredAt`: `number`; `committedAt`:
+`number`; \}\> \| `Readonly`\<\{ `hash`: `string`; `treeHash`: `string`;
+`message`: `string`; `author`: \{ `name`: `string`; `email`: `string`; \};
+`committer`: \{ `name`: `string`; `email`: `string`; \}; `parents`: `string`[];
+`authoredAt`: `number`; `committedAt`: `number`; \}\>[] \| `Readonly`\<\{
+`name`: `string`; `mode`: `string`; `hash`: `string`; `type`: `"blob"` \|
+`"tree"` \| `"commit"`; \}\>[] \| `null`\>