@fungi.computer/agar 0.0.0-stage → 0.0.1

package/docs/api/read-copy.md

@@ -0,0 +1,204 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/agar**](README.md)
+
+---
+
+[@fungi.computer/agar](modules.md) / read-copy
+
+# read-copy
+
+## Classes
+
+### ReadCopyBudgetExceeded
+
+A rebuild stops before dispatching the first call beyond its budget.
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+##### Constructor
+
+```ts
+new ReadCopyBudgetExceeded(): ReadCopyBudgetExceeded;
+```
+
+###### Returns
+
+[`ReadCopyBudgetExceeded`](#readcopybudgetexceeded)
+
+###### Overrides
+
+```ts
+Error.constructor;
+```
+
+## Type Aliases
+
+### ReadCopySql
+
+```ts
+type ReadCopySql = object;
+```
+
+A facet's synchronous SQLite port, shared by Workers and local proofs.
+
+#### Methods
+
+##### exec()
+
+```ts
+exec(query, ...bindings): object;
+```
+
+Execute immediately, as ctx.storage.sql does.
+
+###### Parameters
+
+| Parameter     | Type                                                |
+| ------------- | --------------------------------------------------- |
+| `query`       | `string`                                            |
+| ...`bindings` | (`string` \| `number` \| `ArrayBuffer` \| `null`)[] |
+
+###### Returns
+
+| Name        | Type                       | Description                                          |
+| ----------- | -------------------------- | ---------------------------------------------------- |
+| `toArray()` | () => readonly `unknown`[] | Decode the returned SQLite rows at the App boundary. |
+
+---
+
+### ReadCopyLimits
+
+```ts
+type ReadCopyLimits = object;
+```
+
+App-selected shape and retention bounds; changing version discards old
+representations.
+
+#### Properties
+
+##### version
+
+```ts
+version: number;
+```
+
+App copy-shape version, changed by a clean representation break.
+
+##### maxRows
+
+```ts
+maxRows: number;
+```
+
+Maximum retained document rows across this facet.
+
+##### maxValueBytes
+
+```ts
+maxValueBytes: number;
+```
+
+Maximum UTF-8 JSON bytes per row.
+
+##### maxBlobBytes
+
+```ts
+maxBlobBytes: number;
+```
+
+Maximum bytes of one immutable blob.
+
+##### maxBlobTotalBytes
+
+```ts
+maxBlobTotalBytes: number;
+```
+
+Maximum total retained blob bytes, oldest objects evicted first.
+
+---
+
+### ReadCopyResult
+
+```ts
+type ReadCopyResult<T> =
+  | {
+      kind: "ready";
+      head: string | null;
+      value: T;
+    }
+  | {
+      kind: "missing";
+    }
+  | {
+      kind: "rebuilding";
+    };
+```
+
+A screen reads this projection without asking Git whether it is current.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Functions
+
+### countingGit()
+
+```ts
+function countingGit(binding, options): object;
+```
+
+Count binding operations, never authority or results. The signal is the caller's
+frame lifetime.
+
+#### Parameters
+
+| Parameter        | Type                                              |
+| ---------------- | ------------------------------------------------- |
+| `binding`        | [`GitBinding`](git.md#gitbinding)                 |
+| `options`        | \{ `limit`: `number`; `signal`: `AbortSignal`; \} |
+| `options.limit`  | `number`                                          |
+| `options.signal` | `AbortSignal`                                     |
+
+#### Returns
+
+| Name       | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Description                                  |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| `git`      | `Readonly`\<\{ `create`: `Promise`\<`Readonly`\<\{ `name`: `string`; `defaultBranch`: `string`; `lastPushAt`: `string` \| `null`; `source`: `string` \| `null`; \}\>\>; `fork`: `Promise`\<`Readonly`\<\{ `name`: `string`; `defaultBranch`: `string`; `lastPushAt`: `string` \| `null`; `source`: `string` \| `null`; \}\>\>; `cloneUrl`: `Promise`\<`string`\>; `info`: `Promise`\< \| `Readonly`\<\{ `name`: `string`; `defaultBranch`: `string`; `lastPushAt`: `string` \| `null`; `source`: `string` \| `null`; \}\> \| `null`\>; `delete`: `Promise`\<`boolean`\>; `log`: `Promise`\<`Readonly`\<\{ `hash`: `string`; `treeHash`: `string`; `message`: `string`; `author`: \{ `name`: `string`; `email`: `string`; \}; `committer`: \{ `name`: `string`; `email`: `string`; \}; `parents`: `string`[]; `authoredAt`: `number`; `committedAt`: `number`; \}\>[]\>; `readCommit`: `Promise`\< \| `Readonly`\<\{ `hash`: `string`; `treeHash`: `string`; `message`: `string`; `author`: \{ `name`: `string`; `email`: `string`; \}; `committer`: \{ `name`: `string`; `email`: `string`; \}; `parents`: `string`[]; `authoredAt`: `number`; `committedAt`: `number`; \}\> \| `null`\>; `readTree`: `Promise`\< \| `Readonly`\<\{ `name`: `string`; `mode`: `string`; `hash`: `string`; `type`: `"blob"` \| `"tree"` \| `"commit"`; \}\>[] \| `null`\>; `readBlob`: `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `null`\>; `refs`: `Promise`\<`object`[]\>; `exchange`: `Promise`\<`Readonly`\<\{ `status`: `number`; `headers`: `Readonly`\<`Record`\<`string`, `string`\>\>; `body`: `Uint8Array`; \}\>\>; \}\> | -                                            |
+| `total()`  | () => `number`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Number of dispatched operations.             |
+| `counts()` | () => `object`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Dispatch counts by maintained Git operation. |
+
+---
+
+### createReadCopies()
+
+```ts
+function createReadCopies(sql, limits): object;
+```
+
+Own bounded rows and content-addressed bytes in the App facet, not a
+host/provider cache.
+
+#### Parameters
+
+| Parameter | Type                                |
+| --------- | ----------------------------------- |
+| `sql`     | [`ReadCopySql`](#readcopysql)       |
+| `limits`  | [`ReadCopyLimits`](#readcopylimits) |
+
+#### Returns
+
+| Name         | Type                                                    | Description                                                                                  |
+| ------------ | ------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `open()`     | \<`T`\>(`copy`, `schema`) => `object`                   | Bind a namespace to its maintained App decoder. Bind an App-owned schema and copy namespace. |
+| `putBlob()`  | (`hash`, `bytes`) => `void`                             | Store immutable provider-identified bytes; enforce per-object and total retention bounds.    |
+| `readBlob()` | (`hash`) => `Uint8Array`\<`ArrayBufferLike`\> \| `null` | A blob miss never performs I/O; the App decides which bounded rebuild owns it.               |

package/docs/api/rpc.md

@@ -0,0 +1,128 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/agar**](README.md)
+
+---
+
+[@fungi.computer/agar](modules.md) / rpc
+
+# rpc
+
+## Variables
+
+### rpcVoid
+
+```ts
+const rpcVoid: ZodFunction<
+  $ZodFunctionArgs,
+  ZodPromise<ZodPipe<ZodUnknown, ZodTransform<void, unknown>>>
+>;
+```
+
+A method that decodes and releases an empty RPC result.
+
+## Functions
+
+### rpcHandleSchema()
+
+```ts
+function rpcHandleSchema<S>(
+  methods,
+): ZodPipe<
+  ZodUnknown,
+  ZodTransform<
+    Awaited<
+      $InferObjectOutput<
+        { -readonly [P in string | number | symbol]: S[P] },
+        {}
+      > &
+        object
+    >,
+    unknown
+  >
+>;
+```
+
+Cap'n Web stubs are callable proxies, not records. Select only owner methods and
+bind their receiver before the maintained function schemas wrap them.
+
+#### Type Parameters
+
+| Type Parameter                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------- |
+| `S` _extends_ `Readonly`\<\{ \[`k`: `string`\]: `$ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>; \}\> |
+
+#### Parameters
+
+| Parameter | Type |
+| --------- | ---- |
+| `methods` | `S`  |
+
+#### Returns
+
+`ZodPipe`\<`ZodUnknown`, `ZodTransform`\<`Awaited`\<`$InferObjectOutput`\<\{
+-readonly \[P in string \| number \| symbol\]: S\[P\] \}, \{ \}\> & `object`\>,
+`unknown`\>\>
+
+---
+
+### rpcDataSchema()
+
+```ts
+function rpcDataSchema<T>(
+  result,
+): ZodPipe<ZodUnknown, ZodTransform<Awaited<T>, unknown>>;
+```
+
+Copy an owned data result through its domain decoder, then release the RPC
+envelope. Live resources use their own handle schemas instead.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type             |
+| --------- | ---------------- |
+| `result`  | `ZodType`\<`T`\> |
+
+#### Returns
+
+`ZodPipe`\<`ZodUnknown`, `ZodTransform`\<`Awaited`\<`T`\>, `unknown`\>\>
+
+---
+
+### rpcMethod()
+
+```ts
+function rpcMethod<T>(
+  result,
+): ZodFunction<
+  $ZodFunctionArgs,
+  ZodPromise<ZodPipe<ZodUnknown, ZodTransform<Awaited<T>, unknown>>>
+>;
+```
+
+Wrap an RPC method's result schema into a Zod function schema: the decoded value
+resolves on success, and a malformed result is rethrown as a PROTOCOL AppError
+after releasing the raw RPC envelope.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type             |
+| --------- | ---------------- |
+| `result`  | `ZodType`\<`T`\> |
+
+#### Returns
+
+`ZodFunction`\<`$ZodFunctionArgs`, `ZodPromise`\<`ZodPipe`\<`ZodUnknown`,
+`ZodTransform`\<`Awaited`\<`T`\>, `unknown`\>\>\>\>