@foir/sdk 0.7.0 → 0.8.0

package/dist/transport/persisted-query.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Automatic persisted queries and the shared read lane — the `graphql`-free half
+ * of `graphql/cdn-route.ts`.
+ *
+ * Split out for the same reason `foir-http.ts` was split out of
+ * `graphql/foir-request.ts`: two surfaces need it and only one of them may
+ * import `graphql`. `@foir/sdk/client` prints a `TypedDocumentNode` and then
+ * hashes the text; `@foir/sdk/data` builds the text itself from a selection tree
+ * and must not drag the GraphQL parser into a storefront bundle. Everything
+ * below operates on a document STRING, so it belongs to neither.
+ *
+ * `graphql/cdn-route.ts` re-exports all of it unchanged, so that module's public
+ * surface is exactly what it always was; the only thing that stayed behind is
+ * the part that needs `print`.
+ */
+/**
+ * The shared, cacheable read path. Same schema, same executor, same auth as
+ * `/graphql` — what differs is that a CDN in front of the caller can store the
+ * response, because the request is a GET and the credential is in the URL.
+ */
+export declare const FOIR_CDN_GRAPHQL_PATH = "/cdn/graphql";
+/** The APQ handshake object, in Apollo's shape because every client uses it. */
+export declare function persistedQueryExtension(hash: string): {
+    persistedQuery: {
+        version: number;
+        sha256Hash: string;
+    };
+};
+/**
+ * Build the shared-endpoint URL for a read.
+ *
+ * The credential goes in the URL deliberately: a shared cache keys on the URL
+ * alone, so a key that rode only in a header would let two callers with
+ * different reach collide on one entry and be served each other's body. The
+ * server enforces this and names the refusal `NOT_SHAREABLE` with
+ * `condition: "credential"` when the key arrives only as a header.
+ */
+export declare function buildCdnUrl(endpoint: string, apiKey: string, hash: string, variables?: unknown): string;
+/**
+ * SHA-256 of the document text, hex encoded — the identity a persisted query is
+ * stored and retrieved under.
+ *
+ * Web Crypto rather than a bundled implementation: it is present in every
+ * runtime this SDK targets (workers, edge, Node 18+) and adds nothing to the
+ * caller's bundle. Reached through `globalThis`, never `import 'crypto'`, so
+ * the edge-safety assertion on `@foir/sdk/data`'s import graph still holds.
+ */
+export declare function documentHash(documentText: string): Promise<string>;
+/** The code the server answers with when it has never seen this hash. */
+export declare const PERSISTED_QUERY_NOT_FOUND = "PERSISTED_QUERY_NOT_FOUND";
+/** The code the shared endpoint refuses with, so a caller knows to retry. */
+export declare const NOT_SHAREABLE = "NOT_SHAREABLE";
+/**
+ * Whether a response carries any of the handshake codes above.
+ *
+ * The response is CLONED before the body is read. A Response body can only be
+ * consumed once, and reading it here to inspect the code would leave the caller
+ * holding an empty stream on every successful read — turning a working fast
+ * path into silent data loss.
+ *
+ * Status is deliberately not part of the test. A persisted-query miss comes back
+ * **HTTP 200** with an errors array (verified against deployed dev), while a
+ * shareability refusal comes back 400; keying on the code alone reads both.
+ *
+ * Several codes at once rather than one call per code, because both callers ask
+ * about two and each call costs another clone and another parse of the same body.
+ */
+export declare function hasFoirErrorCode(res: Response, ...codes: string[]): Promise<boolean>;

package/dist/transport/retry.d.ts

@@ -54,7 +54,7 @@ export declare function foirRetryDelayMs(error: unknown, attempt: number, policy
  * Run `fn`, retrying transient Foir failures.
  *
  * Deliberately takes a thunk rather than wrapping a specific request shape, so
- * the same policy covers `/graphql` and `/v1/query` and anything either grows
+ * the same policy covers `/graphql`, `/cdn/graphql` and anything either grows
  * later. Non-Foir errors propagate untouched on the first throw — this is not a
  * general-purpose retry helper and should not become one.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foir/sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Official Foir SDK — editor iframe client + server-side platform helpers",
   "type": "module",
   "publishConfig": {
@@ -61,6 +61,14 @@
       "types": "./dist/codegen/index.d.ts",
       "import": "./dist/codegen/index.js"
     },
+    "./codegen/item-registry": {
+      "types": "./dist/codegen/item-registry.d.ts",
+      "import": "./dist/codegen/item-registry.js"
+    },
+    "./codegen/item-scaffold": {
+      "types": "./dist/codegen/item-scaffold.d.ts",
+      "import": "./dist/codegen/item-scaffold.js"
+    },
     "./codegen/block-registry": {
       "types": "./dist/codegen/block-registry.d.ts",
       "import": "./dist/codegen/block-registry.js"
@@ -128,16 +136,20 @@
   },
   "devDependencies": {
     "@graphql-codegen/cli": "^5.0.7",
+    "@testing-library/react": "^16.2.0",
     "@types/react": "^19.2.0",
     "@types/react-dom": "^19.2.0",
+    "@types/ws": "^8.5.13",
     "blurhash": "^2.0.5",
     "graphql": "^16.10.0",
     "hls.js": "^1.6.16",
+    "jsdom": "^27.0.0",
     "react": "^19.2.0",
     "react-dom": "^19.2.0",
     "tsup": "^8.5.1",
     "typescript": "5.9.2",
     "vitest": "^3.2.4",
+    "ws": "^8.18.0",
     "y-websocket": "^3.0.0",
     "yjs": "^13.6.30"
   },

package/dist/chunk-ADO5FJNM.js

@@ -1,30 +0,0 @@
-// src/codegen/shared.ts
-import { isUnionType } from "graphql";
-var DEFAULT_UNIONS = ["Block"];
-var DEFAULT_GRAPHQL_IMPORT = "./graphql";
-var DEFAULT_SDK_IMPORT = "@foir/sdk/content";
-function collectBlockMembers(schema, unionNames) {
-  const members = /* @__PURE__ */ new Set();
-  const missing = [];
-  for (const name of unionNames) {
-    const type = schema.getType(name);
-    if (!type || !isUnionType(type)) {
-      missing.push(name);
-      continue;
-    }
-    for (const member of type.getTypes()) members.add(member.name);
-  }
-  if (members.size === 0) {
-    throw new Error(
-      `[foir codegen] no union members found. Looked for union(s): ${unionNames.join(", ")}` + (missing.length ? ` (not found or not a union: ${missing.join(", ")})` : "") + `. Run \`foir push\` and confirm the block union name.`
-    );
-  }
-  return [...members].sort();
-}
-
-export {
-  DEFAULT_UNIONS,
-  DEFAULT_GRAPHQL_IMPORT,
-  DEFAULT_SDK_IMPORT,
-  collectBlockMembers
-};