@foir/sdk 0.5.0 → 0.8.0

package/dist/chunk-IGNLWT3H.js

@@ -0,0 +1,35 @@
+import {
+  DEFAULT_GRAPHQL_IMPORT,
+  DEFAULT_SDK_IMPORT,
+  collectItemMembers
+} from "./chunk-TAL5H6VA.js";
+
+// src/codegen/item-registry.ts
+var plugin = (schema, _documents, config = {}) => {
+  const members = collectItemMembers(schema, config.unions);
+  const graphqlImport = config.graphqlImport ?? DEFAULT_GRAPHQL_IMPORT;
+  const sdkImport = config.sdkImport ?? DEFAULT_SDK_IMPORT;
+  const registryName = config.registryName ?? "ItemRegistry";
+  return [
+    "/* eslint-disable */",
+    "// Generated by @foir/sdk/codegen/item-registry. Do not edit by hand.",
+    "// Regenerated on every codegen run \u2014 omitting an item type is a compile error.",
+    `import type { ItemComponent } from '${sdkImport}';`,
+    `import type {`,
+    ...members.map((m) => `  ${m},`),
+    `} from '${graphqlImport}';`,
+    "",
+    `/**`,
+    ` * Exhaustive map of every item \`__typename\` in the project schema to the`,
+    ` * component that renders it. Pass an instance to \`createContentRenderer\`.`,
+    ` */`,
+    `export type ${registryName}<Ctx = unknown> = {`,
+    ...members.map((m) => `  ${m}: ItemComponent<${m}, Ctx>;`),
+    `};`,
+    ""
+  ].join("\n");
+};
+
+export {
+  plugin
+};

package/dist/chunk-OHYVKTGB.js

@@ -0,0 +1,45 @@
+import {
+  DEFAULT_GRAPHQL_IMPORT,
+  DEFAULT_SDK_IMPORT,
+  collectItemMembers
+} from "./chunk-TAL5H6VA.js";
+
+// src/codegen/item-scaffold.ts
+var plugin = (schema, _documents, config = {}) => {
+  const members = collectItemMembers(schema, config.unions);
+  const graphqlImport = config.graphqlImport ?? DEFAULT_GRAPHQL_IMPORT;
+  const sdkImport = config.sdkImport ?? DEFAULT_SDK_IMPORT;
+  const registryImport = config.registryImport ?? "./item-registry";
+  const ctx = config.ctxType ?? "unknown";
+  const stub = (m) => [
+    `function ${m}View(props: ItemComponentProps<${m}, ${ctx}>) {`,
+    `  // TODO: render ${m} from props.item (props.ctx, props.priority available)`,
+    `  void props;`,
+    `  return null;`,
+    `}`
+  ].join("\n");
+  return [
+    "/* eslint-disable */",
+    "// Scaffolded once by @foir/sdk/codegen/item-scaffold \u2014 you own this file.",
+    "// Implement each stub; the build stays green until you do.",
+    `import { createContentRenderer, type ItemComponentProps } from '${sdkImport}';`,
+    `import type { ItemRegistry } from '${registryImport}';`,
+    `import type {`,
+    ...members.map((m) => `  ${m},`),
+    `} from '${graphqlImport}';`,
+    ...config.ctxImport ? ["", config.ctxImport] : [],
+    "",
+    ...members.map(stub),
+    "",
+    `export const itemRegistry: ItemRegistry<${ctx}> = {`,
+    ...members.map((m) => `  ${m}: ${m}View,`),
+    `};`,
+    "",
+    `export const ContentRenderer = createContentRenderer<${ctx}>(itemRegistry);`,
+    ""
+  ].join("\n");
+};
+
+export {
+  plugin
+};

package/dist/chunk-TAL5H6VA.js

@@ -0,0 +1,39 @@
+// src/codegen/shared.ts
+import { isUnionType } from "graphql";
+var DEFAULT_GRAPHQL_IMPORT = "./graphql";
+var DEFAULT_SDK_IMPORT = "@foir/sdk/content";
+var PASSAGE = "Passage";
+function collectItemMembers(schema, unionNames) {
+  const members = /* @__PURE__ */ new Set();
+  const missing = [];
+  if (unionNames && unionNames.length > 0) {
+    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);
+    }
+  } else {
+    for (const type of Object.values(schema.getTypeMap())) {
+      if (!isUnionType(type)) continue;
+      const names = type.getTypes().map((m) => m.name);
+      if (!names.includes(PASSAGE)) continue;
+      for (const name of names) members.add(name);
+    }
+  }
+  members.delete(PASSAGE);
+  if (members.size === 0) {
+    throw new Error(
+      `[foir codegen] no item members found. ` + (unionNames && unionNames.length > 0 ? `Looked for union(s): ${unionNames.join(", ")}` + (missing.length ? ` (not found or not a union: ${missing.join(", ")})` : "") : `No prose entries union (a union containing Passage) exists in the schema`) + `. Run \`foir push\`, then confirm the schema has a prose field that places models \u2014 a prose field's entries union is named by its materialised member set.`
+    );
+  }
+  return [...members].sort();
+}
+
+export {
+  DEFAULT_GRAPHQL_IMPORT,
+  DEFAULT_SDK_IMPORT,
+  collectItemMembers
+};

package/dist/client/platform-client.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Fetch-based GraphQL client for the EIDE platform API.
+ *
+ * Zero dependencies — uses the native Fetch API.
+ */
+import type { PlatformClient, PlatformClientOptions } from '../types';
+/** Error thrown when a platform API request fails. */
+export declare class PlatformClientError extends Error {
+    status?: number | undefined;
+    response?: unknown | undefined;
+    constructor(message: string, status?: number | undefined, response?: unknown | undefined);
+}
+/**
+ * Create a PlatformClient instance.
+ *
+ * @example
+ * ```ts
+ * const client = createPlatformClient({
+ *   apiUrl: 'https://api.example.com/graphql',
+ *   apiKey: 'sk_test_...',
+ * });
+ *
+ * const { data } = await client.query(
+ *   `query GetProduct($id: ID!) { product(id: $id) { title } }`,
+ *   { id: '123' }
+ * );
+ * ```
+ */
+export declare function createPlatformClient(options: PlatformClientOptions): PlatformClient;

package/dist/client.js

@@ -1,13 +1,15 @@
 // src/graphql/foir-request.ts
+import { print as print2 } from "graphql";
+
+// src/graphql/cdn-route.ts
 import { print } from "graphql";
+
+// src/transport/foir-http.ts
 function isFoirPreview(env) {
   return env.FOIR_PREVIEW === "true";
 }
-var FOIR_CDN_BASE = "https://cdn.foir.dev/";
-function absolutiseFoirMediaUrl(url, cdnBase = FOIR_CDN_BASE) {
-  if (!url) return void 0;
-  if (/^https?:\/\//i.test(url)) return url;
-  return cdnBase + url.replace(/^\/+/, "");
+function resolveFoirApiKey(env) {
+  return isFoirPreview(env) ? env.PLATFORM_PREVIEW_API_KEY ?? env.PLATFORM_API_KEY : env.PLATFORM_API_KEY;
 }
 var FoirRequestError = class extends Error {
   /** HTTP status code, when the request failed at the HTTP layer. */
@@ -22,41 +24,95 @@ var FoirRequestError = class extends Error {
     this.status = options?.status;
     this.graphQLErrors = options?.graphQLErrors;
   }
+  /**
+   * The code of the first error, if the response carried one.
+   *
+   * A getter rather than a stored field so it stays correct for an error
+   * constructed anywhere, including by a caller in a test.
+   */
+  get code() {
+    return this.graphQLErrors?.[0]?.extensions?.code;
+  }
+  /** The correlation id, if the response carried one. */
+  get requestId() {
+    return this.graphQLErrors?.[0]?.extensions?.requestId;
+  }
+  /**
+   * Whether retrying this request could succeed.
+   *
+   * The 429 is the one that has to be in here and is easy to leave out: it sits
+   * among the 4xx statuses that are otherwise permanent, so a policy written as
+   * "retry 5xx, never retry 4xx" excludes exactly the failure that clears on its
+   * own. A storefront wrote that policy, its key saturated, and every read
+   * failed on the first attempt for an hour.
+   */
+  get retryable() {
+    if (this.status === void 0) return true;
+    if (this.status === 429 || this.code === "RATE_LIMITED") return true;
+    if (this.status >= 500) return true;
+    return this.code === "UNAVAILABLE" || this.code === "TIMEOUT";
+  }
+  /**
+   * How long to wait before retrying, in milliseconds, when the server said.
+   * Undefined when it did not, which means the caller picks its own backoff.
+   */
+  get retryAfterMs() {
+    const seconds = this.graphQLErrors?.[0]?.extensions?.retryAfter;
+    return typeof seconds === "number" && seconds > 0 ? seconds * 1e3 : void 0;
+  }
 };
-async function foirRequest(env, document, variables, options) {
-  const endpoint = env.PLATFORM_API_URL;
-  const apiKey = isFoirPreview(env) ? env.PLATFORM_PREVIEW_API_KEY ?? env.PLATFORM_API_KEY : env.PLATFORM_API_KEY;
-  if (!endpoint || !apiKey) {
-    throw new FoirRequestError(
-      "[foir] PLATFORM_API_URL or PLATFORM_API_KEY is not set \u2014 add them to .env"
-    );
+function isFoirRateLimited(err) {
+  return err instanceof FoirRequestError && (err.status === 429 || err.code === "RATE_LIMITED");
+}
+function isFoirUnauthenticated(err) {
+  return err instanceof FoirRequestError && (err.status === 401 || err.code === "UNAUTHENTICATED");
+}
+function isFoirForbidden(err) {
+  return err instanceof FoirRequestError && (err.status === 403 || err.code === "PERMISSION_DENIED");
+}
+function isFoirNotFound(err) {
+  return err instanceof FoirRequestError && err.code === "NOT_FOUND";
+}
+function readFoirRateLimit(headers) {
+  const raw = {
+    limit: headers.get("X-RateLimit-Limit"),
+    remaining: headers.get("X-RateLimit-Remaining"),
+    resetAt: headers.get("X-RateLimit-Reset")
+  };
+  if (raw.limit === null || raw.remaining === null || raw.resetAt === null) {
+    return void 0;
   }
+  const limit = Number(raw.limit);
+  const remaining = Number(raw.remaining);
+  const resetAt = Number(raw.resetAt);
+  if (!Number.isFinite(limit) || !Number.isFinite(remaining) || !Number.isFinite(resetAt)) {
+    return void 0;
+  }
+  return { limit, remaining, resetAt };
+}
+function readFoirRetryAfterMs(headers) {
+  const seconds = Number(headers.get("Retry-After"));
+  return Number.isFinite(seconds) && seconds > 0 ? seconds * 1e3 : void 0;
+}
+function buildFoirHeaders(input) {
   const headers = {
     "Content-Type": "application/json",
-    "x-api-key": apiKey
+    "x-api-key": input.apiKey
   };
-  if (isFoirPreview(env)) {
+  if (input.draftChannel) {
     headers["X-Foir-Schema-Channel"] = "draft";
   }
-  if (options?.bearerToken) {
-    headers["Authorization"] = `Bearer ${options.bearerToken}`;
+  if (input.bearerToken) {
+    headers["Authorization"] = `Bearer ${input.bearerToken}`;
   }
-  let res;
-  try {
-    res = await fetch(endpoint, {
-      method: "POST",
-      headers,
-      body: JSON.stringify({ query: print(document), variables })
-    });
-  } catch (err) {
-    throw new FoirRequestError("[foir] network error", { cause: err });
-  }
-  if (!res.ok) {
-    throw new FoirRequestError(`[foir] HTTP ${res.status} ${res.statusText}`, {
-      status: res.status
-    });
+  if (input.extra) {
+    for (const [key, value] of Object.entries(input.extra)) {
+      headers[key] = value;
+    }
   }
-  const json = await res.json();
+  return headers;
+}
+function readFoirEnvelope(json) {
   if (json.errors?.length) {
     const msg = json.errors.map((e) => e.message).join("; ");
     if (json.data) {
@@ -73,15 +129,190 @@ async function foirRequest(env, document, variables, options) {
   return json.data;
 }
 
+// src/transport/persisted-query.ts
+var FOIR_CDN_GRAPHQL_PATH = "/cdn/graphql";
+function persistedQueryExtension(hash) {
+  return { persistedQuery: { version: 1, sha256Hash: hash } };
+}
+function buildCdnUrl(endpoint, apiKey, hash, variables) {
+  const url = new URL(endpoint);
+  url.pathname = url.pathname.replace(/\/graphql\/?$/, "") + FOIR_CDN_GRAPHQL_PATH;
+  url.searchParams.set("key", apiKey);
+  url.searchParams.set("extensions", JSON.stringify(persistedQueryExtension(hash)));
+  if (variables && Object.keys(variables).length > 0) {
+    url.searchParams.set("variables", JSON.stringify(variables));
+  }
+  return url.toString();
+}
+async function documentHash(documentText) {
+  const digest = await crypto.subtle.digest("SHA-256", new TextEncoder().encode(documentText));
+  return Array.from(new Uint8Array(digest)).map((b) => b.toString(16).padStart(2, "0")).join("");
+}
+var PERSISTED_QUERY_NOT_FOUND = "PERSISTED_QUERY_NOT_FOUND";
+var NOT_SHAREABLE = "NOT_SHAREABLE";
+async function hasFoirErrorCode(res, ...codes) {
+  try {
+    const body = await res.clone().json();
+    return body.errors?.some((e) => e.extensions?.code !== void 0 && codes.includes(e.extensions.code)) ?? false;
+  } catch {
+    return false;
+  }
+}
+
+// src/graphql/cdn-route.ts
+function isCdnEligible(env, documentText, bearerToken) {
+  if (bearerToken) return false;
+  if (isFoirPreview(env)) return false;
+  const apiKey = resolveFoirApiKey(env);
+  if (!apiKey?.startsWith("pk_")) return false;
+  return !/\bmutation\b/.test(documentText);
+}
+
+// src/transport/retry.ts
+var DEFAULT_ATTEMPTS = 3;
+var DEFAULT_BASE_DELAY_MS = 200;
+var DEFAULT_MAX_DELAY_MS = 2e4;
+var defaultSleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+function foirRetryDelayMs(error, attempt, policy = {}) {
+  if (!(error instanceof FoirRequestError) || !error.retryable) return null;
+  const max = policy.maxDelayMs ?? DEFAULT_MAX_DELAY_MS;
+  const stated = error.retryAfterMs;
+  if (stated !== void 0) return Math.min(stated, max);
+  const base = policy.baseDelayMs ?? DEFAULT_BASE_DELAY_MS;
+  return Math.min(base * 2 ** (attempt - 1), max);
+}
+async function withFoirRetry(fn, policy = {}) {
+  const attempts = Math.max(1, policy.attempts ?? DEFAULT_ATTEMPTS);
+  const sleep = policy.sleep ?? defaultSleep;
+  for (let attempt = 1; ; attempt += 1) {
+    try {
+      return await fn();
+    } catch (error) {
+      const delayMs = attempt >= attempts ? null : foirRetryDelayMs(error, attempt, policy);
+      if (delayMs === null) throw error;
+      policy.onRetry?.({ attempt, delayMs, error });
+      await sleep(delayMs);
+    }
+  }
+}
+
+// src/graphql/foir-request.ts
+var FOIR_CDN_BASE = "https://cdn.foir.dev/";
+function absolutiseFoirMediaUrl(url, cdnBase = FOIR_CDN_BASE) {
+  if (!url) return void 0;
+  if (/^https?:\/\//i.test(url)) return url;
+  return cdnBase + url.replace(/^\/+/, "");
+}
+async function foirRequest(env, document, variables, options) {
+  const endpoint = env.PLATFORM_API_URL;
+  const apiKey = resolveFoirApiKey(env);
+  if (!endpoint || !apiKey) {
+    throw new FoirRequestError(
+      "[foir] PLATFORM_API_URL or PLATFORM_API_KEY is not set \u2014 add them to .env"
+    );
+  }
+  const headers = buildFoirHeaders({
+    apiKey,
+    draftChannel: isFoirPreview(env),
+    bearerToken: options?.bearerToken
+  });
+  const documentText = print2(document);
+  let res;
+  try {
+    if (isCdnEligible(env, documentText, options?.bearerToken)) {
+      const hash = await documentHash(documentText);
+      let shared = await fetch(buildCdnUrl(endpoint, apiKey, hash, variables), {
+        method: "GET",
+        headers
+      });
+      if (await isPersistedQueryMiss(shared)) {
+        shared = await fetch(buildCdnUrl(endpoint, apiKey, hash, variables), {
+          method: "POST",
+          headers,
+          body: JSON.stringify({
+            query: documentText,
+            variables,
+            extensions: persistedQueryExtension(hash)
+          })
+        });
+      }
+      if (await isSharedRefusal(shared)) {
+        res = await fetch(endpoint, {
+          method: "POST",
+          headers,
+          body: JSON.stringify({ query: documentText, variables })
+        });
+      } else {
+        res = shared;
+      }
+    } else {
+      res = await fetch(endpoint, {
+        method: "POST",
+        headers,
+        body: JSON.stringify({ query: documentText, variables })
+      });
+    }
+  } catch (err) {
+    throw new FoirRequestError("[foir] network error", { cause: err });
+  }
+  options?.onRateLimit?.(readFoirRateLimit(res.headers));
+  if (!res.ok) {
+    const errors = await readErrorEnvelope(res);
+    const first = errors?.[0]?.message;
+    throw new FoirRequestError(
+      first ? `[foir] HTTP ${res.status} ${res.statusText}: ${first}` : `[foir] HTTP ${res.status} ${res.statusText}`,
+      { status: res.status, graphQLErrors: errors }
+    );
+  }
+  const json = await res.json();
+  return readFoirEnvelope(json);
+}
+async function readErrorEnvelope(res) {
+  let errors;
+  try {
+    const body = await res.json();
+    errors = body.errors;
+  } catch {
+    errors = void 0;
+  }
+  const headerRetryMs = readFoirRetryAfterMs(res.headers);
+  if (headerRetryMs === void 0) return errors;
+  const seconds = Math.round(headerRetryMs / 1e3);
+  if (!errors?.length) {
+    return [
+      {
+        message: res.statusText || `HTTP ${res.status}`,
+        extensions: { code: "RATE_LIMITED", retryAfter: seconds }
+      }
+    ];
+  }
+  if (errors[0].extensions?.retryAfter === void 0) {
+    errors[0] = {
+      ...errors[0],
+      extensions: { ...errors[0].extensions, retryAfter: seconds }
+    };
+  }
+  return errors;
+}
+async function isSharedRefusal(res) {
+  return hasFoirErrorCode(res, NOT_SHAREABLE);
+}
+async function isPersistedQueryMiss(res) {
+  return hasFoirErrorCode(res, PERSISTED_QUERY_NOT_FOUND);
+}
+
 // src/graphql/content-client.ts
 function createFoirContentClient(config) {
   return {
     async request(document, variables, options) {
-      const bound = config.getToken ? await config.getToken() : null;
-      return foirRequest(config.env, document, variables, {
-        ...options,
-        bearerToken: options?.bearerToken ?? bound ?? void 0
-      });
+      return withFoirRetry(async () => {
+        const bound = config.getToken ? await config.getToken() : null;
+        return foirRequest(config.env, document, variables, {
+          ...options,
+          bearerToken: options?.bearerToken ?? bound ?? void 0,
+          onRateLimit: options?.onRateLimit ?? config.onRateLimit
+        });
+      }, config.retry);
     }
   };
 }
@@ -91,5 +322,12 @@ export {
   absolutiseFoirMediaUrl,
   createFoirContentClient,
   foirRequest,
-  isFoirPreview
+  foirRetryDelayMs,
+  isFoirForbidden,
+  isFoirNotFound,
+  isFoirPreview,
+  isFoirRateLimited,
+  isFoirUnauthenticated,
+  readFoirRateLimit,
+  withFoirRetry
 };

package/dist/codegen/block-registry.d.ts

@@ -1,27 +1,17 @@
-import { GraphQLSchema } from 'graphql';
-import { B as BlockPluginConfig } from '../shared-DkWlEd2Z.js';
-
 /**
- * `@foir/sdk/codegen/block-registry` — a graphql-codegen plugin.
+ * `@foir/sdk/codegen/block-registry` — DEPRECATED alias.
  *
- * Introspects the project's public schema, collects every member of the block
- * union(s), and emits an EXHAUSTIVE `BlockRegistry` type — one key per block
- * `__typename`, each typed `BlockComponent<ThatBlock, Ctx>`. Because the type
- * requires every key, a project that adds an inline model (→ a new block
- * `__typename`) breaks the consumer's build until the new component is wired:
- * exhaustiveness by construction, replacing the hand-synced switch the
- * storefront's `BlockDigester` used to carry.
+ * `block` was one project's name for a flexible field, never a platform
+ * concept (TTS-1391). The plugin moved to `@foir/sdk/codegen/item-registry`;
+ * this path re-exports it unchanged so an existing `codegen.ts` keeps working.
+ * Repoint the `plugins:` entry when convenient — this will be removed in a
+ * future major.
  *
- * Wired automatically by `foirCodegen()`. The generated file imports the block
- * types from the codegen output (`./graphql`) and `BlockComponent` from
- * `@foir/sdk/content`, so it pairs directly with `createContentRenderer`.
+ * Note that the emitted type is now named `ItemRegistry` by default and its
+ * components are typed `ItemComponent`. If you import the generated
+ * `BlockRegistry` by name, either pass `registryName: 'BlockRegistry'` or
+ * update the import; `@foir/sdk/content` still exports `BlockRegistry` as a
+ * deprecated alias of `ItemRegistry`, so the types remain compatible.
  */
-
-interface BlockRegistryConfig extends BlockPluginConfig {
-    /** Name of the generated registry type. Default `BlockRegistry`. */
-    registryName?: string;
-}
-/** graphql-codegen plugin entrypoint. */
-declare const plugin: (schema: GraphQLSchema, _documents: unknown, config?: BlockRegistryConfig) => string;
-
-export { type BlockRegistryConfig, plugin };
+export { plugin } from './item-registry';
+export type { ItemRegistryConfig, BlockRegistryConfig, } from './item-registry';

package/dist/codegen/block-registry.js

@@ -1,35 +1,7 @@
 import {
-  DEFAULT_GRAPHQL_IMPORT,
-  DEFAULT_SDK_IMPORT,
-  DEFAULT_UNIONS,
-  collectBlockMembers
-} from "../chunk-ADO5FJNM.js";
-
-// src/codegen/block-registry.ts
-var plugin = (schema, _documents, config = {}) => {
-  const members = collectBlockMembers(schema, config.unions ?? DEFAULT_UNIONS);
-  const graphqlImport = config.graphqlImport ?? DEFAULT_GRAPHQL_IMPORT;
-  const sdkImport = config.sdkImport ?? DEFAULT_SDK_IMPORT;
-  const registryName = config.registryName ?? "BlockRegistry";
-  return [
-    "/* eslint-disable */",
-    "// Generated by @foir/sdk/codegen/block-registry. Do not edit by hand.",
-    "// Regenerated on every codegen run \u2014 omitting a block type is a compile error.",
-    `import type { BlockComponent } from '${sdkImport}';`,
-    `import type {`,
-    ...members.map((m) => `  ${m},`),
-    `} from '${graphqlImport}';`,
-    "",
-    `/**`,
-    ` * Exhaustive map of every block \`__typename\` in the project schema to the`,
-    ` * component that renders it. Pass an instance to \`createContentRenderer\`.`,
-    ` */`,
-    `export type ${registryName}<Ctx = unknown> = {`,
-    ...members.map((m) => `  ${m}: BlockComponent<${m}, Ctx>;`),
-    `};`,
-    ""
-  ].join("\n");
-};
+  plugin
+} from "../chunk-IGNLWT3H.js";
+import "../chunk-TAL5H6VA.js";
 export {
   plugin
 };

package/dist/codegen/block-scaffold.d.ts

@@ -1,28 +1,15 @@
-import { GraphQLSchema } from 'graphql';
-import { B as BlockPluginConfig } from '../shared-DkWlEd2Z.js';
-
 /**
- * `@foir/sdk/codegen/block-scaffold` — a one-shot graphql-codegen plugin.
+ * `@foir/sdk/codegen/block-scaffold` — DEPRECATED alias.
  *
- * Emits a ContentRenderer shell: a stub component per block `__typename`, a
- * `blockRegistry` of the (exhaustive) `BlockRegistry` type, and a
- * `createContentRenderer` wiring. Unlike the block-registry plugin (which
- * regenerates every run), this is a STARTING POINT the dev then owns — run it
- * once via `foirScaffold()`, then implement each stub. It compiles out of the
- * box (each stub is a typed no-op) so the build stays green while you fill them
- * in. Adding a new block type later surfaces as a compile error on
- * `blockRegistry` (via the regenerated `BlockRegistry` type), not here.
+ * `block` was one project's name for a flexible field, never a platform
+ * concept (TTS-1391). The plugin moved to `@foir/sdk/codegen/item-scaffold`;
+ * this path re-exports it unchanged so an existing `codegen.ts` keeps working.
+ * Repoint the `plugins:` entry when convenient — this will be removed in a
+ * future major.
+ *
+ * The scaffold is a one-shot generator, so a file scaffolded under the old name
+ * is yours and is untouched by this. Newly scaffolded files export
+ * `itemRegistry` rather than `blockRegistry` and take `props.item`.
  */
-
-interface BlockScaffoldConfig extends BlockPluginConfig {
-    /** Import path for the generated registry type. Default `./block-registry`. */
-    registryImport?: string;
-    /** Render-context type name threaded to every component. Default `unknown`. */
-    ctxType?: string;
-    /** Optional import line for the ctx type, e.g. `import type { Ctx } from '~/ctx'`. */
-    ctxImport?: string;
-}
-/** graphql-codegen plugin entrypoint. */
-declare const plugin: (schema: GraphQLSchema, _documents: unknown, config?: BlockScaffoldConfig) => string;
-
-export { type BlockScaffoldConfig, plugin };
+export { plugin } from './item-scaffold';
+export type { ItemScaffoldConfig, BlockScaffoldConfig, } from './item-scaffold';

package/dist/codegen/block-scaffold.js

@@ -1,45 +1,7 @@
 import {
-  DEFAULT_GRAPHQL_IMPORT,
-  DEFAULT_SDK_IMPORT,
-  DEFAULT_UNIONS,
-  collectBlockMembers
-} from "../chunk-ADO5FJNM.js";
-
-// src/codegen/block-scaffold.ts
-var plugin = (schema, _documents, config = {}) => {
-  const members = collectBlockMembers(schema, config.unions ?? DEFAULT_UNIONS);
-  const graphqlImport = config.graphqlImport ?? DEFAULT_GRAPHQL_IMPORT;
-  const sdkImport = config.sdkImport ?? DEFAULT_SDK_IMPORT;
-  const registryImport = config.registryImport ?? "./block-registry";
-  const ctx = config.ctxType ?? "unknown";
-  const stub = (m) => [
-    `function ${m}View(props: BlockComponentProps<${m}, ${ctx}>) {`,
-    `  // TODO: render ${m} from props.block (props.ctx, props.priority available)`,
-    `  void props;`,
-    `  return null;`,
-    `}`
-  ].join("\n");
-  return [
-    "/* eslint-disable */",
-    "// Scaffolded once by @foir/sdk/codegen/block-scaffold \u2014 you own this file.",
-    "// Implement each stub; the build stays green until you do.",
-    `import { createContentRenderer, type BlockComponentProps } from '${sdkImport}';`,
-    `import type { BlockRegistry } from '${registryImport}';`,
-    `import type {`,
-    ...members.map((m) => `  ${m},`),
-    `} from '${graphqlImport}';`,
-    ...config.ctxImport ? ["", config.ctxImport] : [],
-    "",
-    ...members.map(stub),
-    "",
-    `export const blockRegistry: BlockRegistry<${ctx}> = {`,
-    ...members.map((m) => `  ${m}: ${m}View,`),
-    `};`,
-    "",
-    `export const ContentRenderer = createContentRenderer<${ctx}>(blockRegistry);`,
-    ""
-  ].join("\n");
-};
+  plugin
+} from "../chunk-OHYVKTGB.js";
+import "../chunk-TAL5H6VA.js";
 export {
   plugin
 };