@fungi.computer/knapsack 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jamstack Consulting LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE.codex

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 OpenAI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,141 @@
-# Temporary Holding Version
+# @fungi.computer/knapsack
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Knapsack collects Agent tool connections. A connection discovers one external
+capability provider and projects its advertised operations into a Mycelium
+`CapabilitySource`.
+
+The first connection is `Knapsack.computer`. A Computer provider continues to
+own its operation implementations, schemas, storage, and execution. Knapsack
+parses the provider's advertisement and forwards generic calls; Mycelium owns
+the resulting capability lifecycle and execute door.
+
+`Knapsack.computers` captures a host's Computer list. Computers are described
+concurrently under a timeout; one that rejects, hangs, or advertises an unusable
+schema is dropped and reported through `onUnavailable`, while the remaining
+Computers stay available. There is no implicit shared Files module. A connection
+may supply its own `files` port and `namespace: ["computers"]`; its advertised
+commands and nested `files.*` then share that Computer’s authority id under
+`env.computers.<name>`. Failed acquisition removes that Computer’s Files with
+its commands.
+
+`Knapsack.files` projects one bounded Files port as the `files` module and, when
+the host supplies a patch engine, the direct `apply_patch` tool. Both decode
+through the same Zod schemas.
+
+`Knapsack.mcpServers` connects a host-owned list of remote MCP servers with the
+maintained MCP SDK client over Streamable HTTP. Each server becomes the module
+`env.mcp.<name>`, one operation per advertised tool. A tool name maps onto the
+guest identifier grammar (`create-note` becomes `create_note`). Its input schema
+decodes through Forage's JSON Schema subset; a schema outside that subset still
+accepts a JSON object, and the server validates it. A tool replays only when the
+server marks it `readOnlyHint`. A call returns the tool's `structuredContent`,
+or `{ isError, content }` when there is none or the tool failed. The host
+supplies the `fetch` that carries every request and any headers, such as a
+bearer token; redirects are refused, and headers never reach the snapshot, the
+catalog or a result. Servers connect concurrently under a timeout. One that
+rejects, refuses its credential, times out or advertises an unusable list is
+dropped and reported through `onUnavailable`, while the others stay available.
+
+Knapsack does not own model loops, tool execution policy, Computer storage, or
+provider-specific operations.
+
+`@fungi.computer/knapsack/files-patch` exposes the same patch input/output
+contracts without loading tool connections or the agent runtime. Browser and
+transport consumers use this subpath.
+
+## Set up
+
+```sh
+npm install @fungi.computer/knapsack
+```
+
+The package is an ESM public candidate, not a claim of npm publication. It
+depends on Cairn, Forage, Mule, Mycelium, the MCP SDK client, Effect, Zod and
+`diff`. Its explicit file list contains compiled JavaScript and declarations,
+the API reference, this README and the license texts. It has no install scripts.
+
+## Quick start: validate a read request
+
+This example uses the same public decoder as the packed-consumer proof in
+[test/stranger/runtime.mjs](test/stranger/runtime.mjs). It validates a request;
+it does not grant file access or perform I/O.
+
+```ts
+import { readInputSchema } from "@fungi.computer/knapsack";
+
+export const request = readInputSchema.parse({
+  path: "notes.md",
+  offset: 0,
+  limit: 4,
+});
+```
+
+## Core concepts
+
+The host supplies an already admitted Computer or Files port. Knapsack does not
+mint credentials or choose a Team, member, Computer, path root or permission.
+`Knapsack.computer({ id, name, computer })` captures the Computer's advertised
+operations. `Knapsack.computers` subscribes to a host-owned connection list and
+invalidates its captured modules when that list changes.
+
+Computer calls preserve Mycelium's invocation context, including its execution
+identity, abort signal and deadline. Advertised Computer operations are marked
+unsafe to replay because their implementation can change external state. The
+host's provider remains responsible for admission on each call.
+
+`Knapsack.files({ port })` builds a Files module and direct tools from one port.
+Text edits use `port.replace` with the expected original content; the host must
+replace atomically or refuse a conflict. A native patch operation is available
+only when that port supplies a patch engine. Paths are validated, not confined
+by Knapsack: the captured host port enforces its own root and authority.
+
+## API reference
+
+The [generated reference](docs/api/README.md) covers every public entry:
+
+| Entry               | Use                                                                                         |
+| ------------------- | ------------------------------------------------------------------------------------------- |
+| Root                | Computer sources, Files connections, edit operations and their codecs.                      |
+| `/files-patch`      | Patch input/output codecs without the tool runtime.                                         |
+| `/files-read`       | Bounded text read schemas and shared path validation.                                       |
+| `/patch`            | Read Codex patch operations for presentation; the native engine validates and applies them. |
+| `/files-read-codec` | Encode read requests and adapt a framed host transport to the Files read port.              |
+
+## Examples and checks
+
+[Computer tests](test/computer.test.ts) exercise acquisition, invalidation,
+provider failures and invocation context. [Files tests](test/files.test.ts)
+exercise bounded reads and edits.
+[Read codec tests](test/files-read-codec.test.ts) exercise the framed transport.
+The packed-consumer runtime and typecheck fixtures import only the five public
+entries from an isolated tarball installation.
+
+From a configured repository checkout:
+
+```sh
+pnpm turbo:run run build --filter=@fungi.computer/knapsack
+pnpm --dir packages/knapsack run test
+pnpm --dir packages/knapsack run docs
+pnpm --dir packages/knapsack run stranger
+```
+
+## Limits and errors
+
+A Computer advertises at most 256 capabilities. Each advertisement read has a
+10-second default timeout; list acquisition describes at most eight Computers
+concurrently. An unavailable Computer is reported through `onUnavailable` and
+omitted without removing healthy ones. Cancelling acquisition rejects it.
+
+Files reads and patch inputs are bounded to 128 KiB of UTF-8 text. Listing and
+search results contain at most 256 entries and expose truncation. Schemas reject
+invalid requests and results. `FilesEditError` distinguishes conflicts, missing
+or ambiguous matches, oversized files and partial-character edits.
+
+## Contribute and license
+
+Knapsack's package license is [MIT](LICENSE). The retained Codex patch grammar
+in `src/patch-grammar.ts` carries its existing
+[Apache-2.0 license](LICENSE.codex), which is included in the tarball. Keep host
+authority separate from connection projection and run the package and
+packed-consumer checks before proposing a change. Publication is a separate
+release decision.

package/dist/files-patch.d.ts

@@ -0,0 +1,30 @@
+import * as z from "zod";
+/** Browser-safe patch contracts shared by native Files tools and Computer HTTP. */
+export declare const patchInputSchema: z.ZodObject<{
+    patch: z.ZodString;
+}, z.core.$strict>;
+/** Native patch completion, cancellation or failure, including an optional mismatch. */
+export declare const patchOutputSchema: z.ZodUnion<readonly [z.ZodObject<{
+    status: z.ZodEnum<{
+        completed: "completed";
+        failed: "failed";
+        cancelled: "cancelled";
+    }>;
+    exitCode: z.ZodNumber;
+    stdout: z.ZodString;
+    stderr: z.ZodString;
+    truncated: z.ZodBoolean;
+}, z.core.$strict>, z.ZodObject<{
+    status: z.ZodEnum<{
+        completed: "completed";
+        failed: "failed";
+        cancelled: "cancelled";
+    }>;
+    exitCode: z.ZodNumber;
+    stdout: z.ZodString;
+    stderr: z.ZodString;
+    truncated: z.ZodBoolean;
+    error: z.ZodObject<{
+        kind: z.ZodLiteral<"mismatch">;
+    }, z.core.$strict>;
+}, z.core.$strict>]>;

package/dist/files-patch.js

@@ -0,0 +1,22 @@
+import * as z from "zod";
+import { boundedTextSchema, maximumReadBytes } from "./files-read.js";
+/** Browser-safe patch contracts shared by native Files tools and Computer HTTP. */
+export const patchInputSchema = z.strictObject({
+    patch: boundedTextSchema(1).meta({
+        description: `Codex patch text, at most ${String(maximumReadBytes)} UTF-8 bytes.`,
+    }),
+});
+const patchResultSchema = z.strictObject({
+    status: z.enum(["completed", "failed", "cancelled"]),
+    exitCode: z.number().int(),
+    stdout: z.string(),
+    stderr: z.string(),
+    truncated: z.boolean(),
+});
+/** Native patch completion, cancellation or failure, including an optional mismatch. */
+export const patchOutputSchema = z.union([
+    patchResultSchema,
+    patchResultSchema.extend({
+        error: z.strictObject({ kind: z.literal("mismatch") }),
+    }),
+]);

package/dist/files-read-codec.d.ts

@@ -0,0 +1,10 @@
+import type { InvocationContext } from "@fungi.computer/mycelium";
+import { z } from "zod";
+import type { FilesPort } from "./files.js";
+import { readInputSchema } from "./files-read.js";
+/** Host transport carrying a framed Files read with its invocation context. */
+export type FilesReadTransport = (frame: string, context: InvocationContext) => Promise<string>;
+/** Validate and encode a bounded Files read request as a JSON frame. */
+export declare function encodeFilesReadRequest(input: z.input<typeof readInputSchema>): string;
+/** Adapt a framed transport to the Files read port; `Knapsack.files` owns the operation. */
+export declare function createFilesReadAdapter(transport: FilesReadTransport): Pick<FilesPort, "read">;

package/dist/files-read-codec.js

@@ -0,0 +1,26 @@
+import { z } from "zod";
+import { readInputSchema, readOutputSchema } from "./files-read.js";
+const readRequestSchema = z.strictObject({
+    operation: z.literal("read"),
+    input: readInputSchema,
+});
+const readResponseSchema = z.discriminatedUnion("status", [
+    z.object({ status: z.literal("ok"), result: readOutputSchema }),
+    z.object({ status: z.literal("error"), message: z.string().min(1) }),
+]);
+/** Validate and encode a bounded Files read request as a JSON frame. */
+export function encodeFilesReadRequest(input) {
+    return JSON.stringify(readRequestSchema.parse({ operation: "read", input }));
+}
+function decodeFilesReadResponse(input) {
+    const parsed = readResponseSchema.parse(JSON.parse(input));
+    if (parsed.status === "error")
+        throw new Error(parsed.message);
+    return parsed.result;
+}
+/** Adapt a framed transport to the Files read port; `Knapsack.files` owns the operation. */
+export function createFilesReadAdapter(transport) {
+    return Object.freeze({
+        read: async (input, context) => decodeFilesReadResponse(await transport(encodeFilesReadRequest(input), context)),
+    });
+}

package/dist/files-read.d.ts

@@ -0,0 +1,25 @@
+import * as z from "zod";
+/** Maximum UTF-8 byte length of a Files text page. */
+export declare const maximumReadBytes: number;
+/** Nonempty file path bounded to 4,096 characters, without null bytes. */
+export declare const pathSchema: z.ZodString;
+/** Validate text against a minimum character length and the Files UTF-8 byte limit. */
+export declare function boundedTextSchema(minimumLength?: number): z.ZodString;
+/** Canonical bounded Files read request and result, shared with display consumers. */
+export declare const readInputSchema: z.ZodObject<{
+    path: z.ZodString;
+    offset: z.ZodDefault<z.ZodNumber>;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>;
+/** Bounded text page, continuation offset and optional hosted file identity. */
+export declare const readOutputSchema: z.ZodObject<{
+    path: z.ZodString;
+    content: z.ZodString;
+    offset: z.ZodNumber;
+    nextOffset: z.ZodNullable<z.ZodNumber>;
+    truncated: z.ZodBoolean;
+    file: z.ZodExactOptional<z.ZodObject<{
+        computerId: z.ZodString;
+        path: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;

package/dist/files-read.js

@@ -0,0 +1,43 @@
+import * as z from "zod";
+/** Maximum UTF-8 byte length of a Files text page. */
+export const maximumReadBytes = 128 * 1_024;
+const utf8 = new TextEncoder();
+/** Nonempty file path bounded to 4,096 characters, without null bytes. */
+export const pathSchema = z
+    .string()
+    .min(1)
+    .max(4_096)
+    .refine((path) => !path.includes("\0"), "Path cannot contain null bytes");
+/** Validate text against a minimum character length and the Files UTF-8 byte limit. */
+export function boundedTextSchema(minimumLength = 0) {
+    return z
+        .string()
+        .min(minimumLength)
+        .refine((content) => utf8.encode(content).byteLength <= maximumReadBytes, `Text exceeds the ${String(maximumReadBytes)}-byte Files bound`);
+}
+/** Canonical bounded Files read request and result, shared with display consumers. */
+export const readInputSchema = z.strictObject({
+    path: pathSchema,
+    offset: z.number().int().min(0).default(0),
+    limit: z
+        .number()
+        .int()
+        .min(4)
+        .max(maximumReadBytes)
+        .default(maximumReadBytes),
+});
+/** Bounded text page, continuation offset and optional hosted file identity. */
+export const readOutputSchema = z.strictObject({
+    path: pathSchema,
+    content: boundedTextSchema(),
+    offset: z.number().int().min(0),
+    nextOffset: z.number().int().min(0).nullable(),
+    truncated: z.boolean(),
+    /** Captured hosted file identity; a local Files host may have no Computer identity. */
+    file: z
+        .strictObject({
+        computerId: z.string().min(1).max(256),
+        path: pathSchema.refine((path) => path.startsWith("/"), "Computer file paths must be absolute"),
+    })
+        .exactOptional(),
+});