@fungi.computer/knapsack 0.0.0-stage → 0.0.2

package/docs/api/files-patch.md

@@ -0,0 +1,72 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/knapsack**](README.md)
+
+---
+
+[@fungi.computer/knapsack](README.md) / files-patch
+
+# files-patch
+
+## Variables
+
+### patchInputSchema
+
+```ts
+const patchInputSchema: ZodObject<
+  {
+    patch: ZodString;
+  },
+  $strict
+>;
+```
+
+Browser-safe patch contracts shared by native Files tools and Computer HTTP.
+
+---
+
+### patchOutputSchema
+
+```ts
+const patchOutputSchema: ZodUnion<
+  readonly [
+    ZodObject<
+      {
+        status: ZodEnum<{
+          completed: "completed";
+          failed: "failed";
+          cancelled: "cancelled";
+        }>;
+        exitCode: ZodNumber;
+        stdout: ZodString;
+        stderr: ZodString;
+        truncated: ZodBoolean;
+      },
+      $strict
+    >,
+    ZodObject<
+      {
+        status: ZodEnum<{
+          completed: "completed";
+          failed: "failed";
+          cancelled: "cancelled";
+        }>;
+        exitCode: ZodNumber;
+        stdout: ZodString;
+        stderr: ZodString;
+        truncated: ZodBoolean;
+        error: ZodObject<
+          {
+            kind: ZodLiteral<"mismatch">;
+          },
+          $strict
+        >;
+      },
+      $strict
+    >,
+  ]
+>;
+```
+
+Native patch completion, cancellation or failure, including an optional
+mismatch.

package/docs/api/files-read-codec.md

@@ -0,0 +1,74 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/knapsack**](README.md)
+
+---
+
+[@fungi.computer/knapsack](README.md) / files-read-codec
+
+# files-read-codec
+
+## Type Aliases
+
+### FilesReadTransport
+
+```ts
+type FilesReadTransport = (frame, context) => Promise<string>;
+```
+
+Host transport carrying a framed Files read with its invocation context.
+
+#### Parameters
+
+| Parameter | Type                |
+| --------- | ------------------- |
+| `frame`   | `string`            |
+| `context` | `InvocationContext` |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+## Functions
+
+### encodeFilesReadRequest()
+
+```ts
+function encodeFilesReadRequest(input): string;
+```
+
+Validate and encode a bounded Files read request as a JSON frame.
+
+#### Parameters
+
+| Parameter       | Type                                                             |
+| --------------- | ---------------------------------------------------------------- |
+| `input`         | \{ `path`: `string`; `offset?`: `number`; `limit?`: `number`; \} |
+| `input.path`    | `string`                                                         |
+| `input.offset?` | `number`                                                         |
+| `input.limit?`  | `number`                                                         |
+
+#### Returns
+
+`string`
+
+---
+
+### createFilesReadAdapter()
+
+```ts
+function createFilesReadAdapter(transport): Pick<FilesPort, "read">;
+```
+
+Adapt a framed transport to the Files read port; `Knapsack.files` owns the
+operation.
+
+#### Parameters
+
+| Parameter   | Type                                        |
+| ----------- | ------------------------------------------- |
+| `transport` | [`FilesReadTransport`](#filesreadtransport) |
+
+#### Returns
+
+`Pick`\<[`FilesPort`](index.md#filesport), `"read"`\>

package/docs/api/files-read.md

@@ -0,0 +1,94 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/knapsack**](README.md)
+
+---
+
+[@fungi.computer/knapsack](README.md) / files-read
+
+# files-read
+
+## Variables
+
+### maximumReadBytes
+
+```ts
+const maximumReadBytes: number;
+```
+
+Maximum UTF-8 byte length of a Files text page.
+
+---
+
+### pathSchema
+
+```ts
+const pathSchema: ZodString;
+```
+
+Nonempty file path bounded to 4,096 characters, without null bytes.
+
+---
+
+### readInputSchema
+
+```ts
+const readInputSchema: ZodObject<
+  {
+    path: ZodString;
+    offset: ZodDefault<ZodNumber>;
+    limit: ZodDefault<ZodNumber>;
+  },
+  $strict
+>;
+```
+
+Canonical bounded Files read request and result, shared with display consumers.
+
+---
+
+### readOutputSchema
+
+```ts
+const readOutputSchema: ZodObject<
+  {
+    path: ZodString;
+    content: ZodString;
+    offset: ZodNumber;
+    nextOffset: ZodNullable<ZodNumber>;
+    truncated: ZodBoolean;
+    file: ZodExactOptional<
+      ZodObject<
+        {
+          computerId: ZodString;
+          path: ZodString;
+        },
+        $strict
+      >
+    >;
+  },
+  $strict
+>;
+```
+
+Bounded text page, continuation offset and optional hosted file identity.
+
+## Functions
+
+### boundedTextSchema()
+
+```ts
+function boundedTextSchema(minimumLength?): ZodString;
+```
+
+Validate text against a minimum character length and the Files UTF-8 byte limit.
+
+#### Parameters
+
+| Parameter       | Type     | Default value |
+| --------------- | -------- | ------------- |
+| `minimumLength` | `number` | `0`           |
+
+#### Returns
+
+`ZodString`