@fora-protocol/sdk 1.0.3

package/package.json

@@ -0,0 +1,164 @@
+{
+  "name": "@fora-protocol/sdk",
+  "version": "1.0.3",
+  "description": "FORA protocol SDK for TypeScript: the generated wire schemas (Zod) and vocabulary, the IO-free protocol mechanics (signing, verification, canonicalization), the key/endpoint resolvers and the Connect-unary JSON client.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FORA-Protocol/protocol.git",
+    "directory": "sdk/ts"
+  },
+  "homepage": "https://fora-protocol.org",
+  "type": "module",
+  "files": [
+    "gen",
+    "sdk"
+  ],
+  "exports": {
+    "./base64url": {
+      "types": "./sdk/ts/src/base64url.d.ts",
+      "default": "./sdk/ts/src/base64url.js"
+    },
+    "./thumbprint": {
+      "types": "./sdk/ts/src/thumbprint.d.ts",
+      "default": "./sdk/ts/src/thumbprint.js"
+    },
+    "./verify": {
+      "types": "./sdk/ts/src/verify.d.ts",
+      "default": "./sdk/ts/src/verify.js"
+    },
+    "./signurl": {
+      "types": "./sdk/ts/src/signurl.d.ts",
+      "default": "./sdk/ts/src/signurl.js"
+    },
+    "./offer-sign": {
+      "types": "./sdk/ts/src/offer-sign.d.ts",
+      "default": "./sdk/ts/src/offer-sign.js"
+    },
+    "./pop": {
+      "types": "./sdk/ts/src/pop.d.ts",
+      "default": "./sdk/ts/src/pop.js"
+    },
+    "./crossfield": {
+      "types": "./sdk/ts/src/crossfield.d.ts",
+      "default": "./sdk/ts/src/crossfield.js"
+    },
+    "./errordetail": {
+      "types": "./sdk/ts/src/errordetail.d.ts",
+      "default": "./sdk/ts/src/errordetail.js"
+    },
+    "./money": {
+      "types": "./sdk/ts/src/money.d.ts",
+      "default": "./sdk/ts/src/money.js"
+    },
+    "./idempotency": {
+      "types": "./sdk/ts/src/idempotency.d.ts",
+      "default": "./sdk/ts/src/idempotency.js"
+    },
+    "./scopes": {
+      "types": "./sdk/ts/src/scopes.d.ts",
+      "default": "./sdk/ts/src/scopes.js"
+    },
+    "./hashurl": {
+      "types": "./sdk/ts/src/hashurl.d.ts",
+      "default": "./sdk/ts/src/hashurl.js"
+    },
+    "./hosts": {
+      "types": "./sdk/ts/src/hosts.d.ts",
+      "default": "./sdk/ts/src/hosts.js"
+    },
+    "./regschema": {
+      "types": "./sdk/ts/src/regschema.d.ts",
+      "default": "./sdk/ts/src/regschema.js"
+    },
+    "./licenseterm": {
+      "types": "./sdk/ts/src/licenseterm.d.ts",
+      "default": "./sdk/ts/src/licenseterm.js"
+    },
+    "./wire": {
+      "types": "./sdk/ts/src/wire.d.ts",
+      "default": "./sdk/ts/src/wire.js"
+    },
+    "./core": {
+      "types": "./sdk/ts/core/verifier.d.ts",
+      "default": "./sdk/ts/core/verifier.js"
+    },
+    "./core/wire-canon": {
+      "types": "./sdk/ts/core/wire-canon.d.ts",
+      "default": "./sdk/ts/core/wire-canon.js"
+    },
+    "./core/sign": {
+      "types": "./sdk/ts/core/sign.d.ts",
+      "default": "./sdk/ts/core/sign.js"
+    },
+    "./core/sign-request": {
+      "types": "./sdk/ts/core/sign-request.d.ts",
+      "default": "./sdk/ts/core/sign-request.js"
+    },
+    "./core/signing-transport": {
+      "types": "./sdk/ts/core/signing-transport.d.ts",
+      "default": "./sdk/ts/core/signing-transport.js"
+    },
+    "./core/verify-request": {
+      "types": "./sdk/ts/core/verify-request.d.ts",
+      "default": "./sdk/ts/core/verify-request.js"
+    },
+    "./core/verify-multisig-request": {
+      "types": "./sdk/ts/core/verify-multisig-request.d.ts",
+      "default": "./sdk/ts/core/verify-multisig-request.js"
+    },
+    "./core/window": {
+      "types": "./sdk/ts/core/window.d.ts",
+      "default": "./sdk/ts/core/window.js"
+    },
+    "./hono": {
+      "types": "./sdk/ts/hono/middleware.d.ts",
+      "default": "./sdk/ts/hono/middleware.js"
+    },
+    "./acceptance": {
+      "types": "./sdk/ts/src/acceptance.d.ts",
+      "default": "./sdk/ts/src/acceptance.js"
+    },
+    "./resolvers": {
+      "types": "./sdk/ts/resolvers/index.d.ts",
+      "default": "./sdk/ts/resolvers/index.js"
+    },
+    "./client": {
+      "types": "./sdk/ts/client/index.d.ts",
+      "default": "./sdk/ts/client/index.js"
+    },
+    "./wire/schemas": {
+      "types": "./gen/ts/wire/schemas.ts",
+      "default": "./gen/ts/wire/schemas.js"
+    },
+    "./wire/base": {
+      "types": "./gen/ts/wire/base.ts",
+      "default": "./gen/ts/wire/base.js"
+    },
+    "./wire/names": {
+      "types": "./gen/ts/wire/names.ts",
+      "default": "./gen/ts/wire/names.js"
+    },
+    "./vocab/*": {
+      "types": "./gen/ts/vocab/*.ts",
+      "default": "./gen/ts/vocab/*.js"
+    }
+  },
+  "dependencies": {
+    "ajv": "^8.20.0",
+    "canonicalize": "^3.0.0",
+    "undici": "^6.27.0"
+  },
+  "peerDependencies": {
+    "hono": "^4.7.0",
+    "zod": "^3.23.0 || ^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "hono": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/sdk/ts/client/content.d.ts

@@ -0,0 +1,74 @@
+import { type Dispatcher } from "undici";
+import type { Window } from "../core/window.ts";
+/**
+ * DEFAULT_CONTENT_TIMEOUT_MS bounds one content fetch. An agent is blocked on the call
+ * that triggered it, so a fetch that has not answered by now is more useful as a reported
+ * failure than as a hang.
+ */
+export declare const DEFAULT_CONTENT_TIMEOUT_MS = 30000;
+/**
+ * DEFAULT_MAX_CONTENT_BYTES caps one fetched body at 8 MiB. A memory bound on the
+ * fetching process, not a judgement about how large licensed content may be: the body is
+ * buffered whole and held for the life of the call, and a batch fetches one per item.
+ */
+export declare const DEFAULT_MAX_CONTENT_BYTES: number;
+/** One fetched resource. */
+export interface Content {
+    /** The signed delivery URL that was fetched, echoed back so a caller correlating a
+     * batch does not have to keep its own map. */
+    url: string;
+    /** The media type the edge served, parameters stripped. */
+    mimeType: string;
+    /** The fetched bytes. */
+    body: Uint8Array;
+}
+/** What the content leg needs to mint one proof and dial once. */
+export interface ContentFetchOptions {
+    /** The agent keypair the delivery URL is bound to. Both halves are required and
+     * neither can be derived from the other: the private half signs, the public half is
+     * presented alongside. */
+    keyPair: CryptoKeyPair;
+    /** The freshness window stamped on the proof. Short on purpose, and deliberately NOT
+     * the signed URL's own expiry, which can be hours: the proof covers only the method
+     * and the URL, so for as long as the window is open anyone who observes the request
+     * can repeat it. */
+    window?: Window;
+    timeoutMs?: number;
+    maxBytes?: number;
+    requestId?: () => string;
+    /** The dialing seam, guarded by default. An edge runtime with no undici injects its
+     * own; the same obligations come with it — no redirects, the address pin, and a body
+     * whose socket is released even when this leg refuses without reading it. */
+    dispatcher?: Dispatcher;
+}
+/**
+ * fetchContent retrieves the content at signedURL, presenting the proof of possession
+ * minted for it.
+ *
+ * Redirects are REFUSED. Following one would either replay a proof bound to the old URL,
+ * which the edge's own check rejects, or hand a fresh proof of possession of the agent's
+ * key to whatever host the first hop named.
+ *
+ * The URL is taken as given. Whether it is one this agent bought, and whether its
+ * agent_id matches this agent's key, are the CALLER's checks to make — the SDK exports
+ * verifyEd25519SignedUrl and the proof-of-possession verifier for exactly that, and
+ * running them first turns an edge 403 into a local answer. Worth doing when the URL
+ * reached the caller from anywhere but its own execute response: a proof is minted for
+ * whatever URL is passed in.
+ */
+export declare function fetchContent(signedURL: string, opts: ContentFetchOptions): Promise<Content>;
+/**
+ * mimeTypeOf reduces a Content-Type to its media type, dropping parameters such as
+ * charset. The charset belongs to whoever decodes the bytes; the content carries the
+ * media type alone.
+ *
+ * The parameters are DISCARDED WITHOUT BEING PARSED, and the media type's shape is checked
+ * rather than delegated to a parser, because the three SDKs must answer one thing for one
+ * header. Go's stdlib parser reports a malformed PARAMETER as an error beside a perfectly
+ * good media type — honouring that answers "unknown" for `text/plain; ;`, discarding the one
+ * thing the field carries because of the part this is defined to ignore — and it accepts a
+ * bare token with no slash, which is not a media type at all. The rule is stated instead:
+ * the text before the first `;`, trimmed and lowercased, must be token "/" token over RFC
+ * 9110's token characters.
+ */
+export declare function mimeTypeOf(header: string | undefined): string;