@doswiftly/storefront-operations 22.5.1 → 22.8.0

package/AGENTS.md

@@ -27,7 +27,7 @@ consumer's `codegen.ts` references this package's `.graphql` files as
 live in the consumer's repo.
 
 <!-- AUTOGEN:STATS:BEGIN — auto-regenerated, do not edit by hand -->
-- **Schema version**: 22.5.1
+- **Schema version**: 22.8.0
 - **Queries**: 52
 - **Mutations**: 44
 - **Fragments**: 105

package/CHANGELOG.md

@@ -1,5 +1,78 @@
 # Changelog
 
+## 22.8.0
+
+### Minor Changes
+
+- 9039ba1: Add `getAssetPrefix()` for serving your build's static assets from a CDN domain.
+
+  **Why**: A build's JavaScript, CSS, and font files (`/_next/static/*`) are content-hashed and immutable. Serving them from a CDN domain — rather than your app origin — makes them cache-friendly and keeps them off your storefront server's request path.
+
+  **Additive (backward-compatible)**: a new export from `@doswiftly/storefront-sdk/next`. Nothing changes until you opt in.
+
+  **Usage** — add two lines to `next.config`:
+
+  ```ts
+  // next.config.ts
+  import { getAssetPrefix } from "@doswiftly/storefront-sdk/next";
+
+  const nextConfig = {
+    assetPrefix: getAssetPrefix(),
+    crossOrigin: "anonymous",
+    // ...your existing config
+  };
+  export default nextConfig;
+  ```
+
+  `getAssetPrefix()` returns the CDN base injected by the deploy pipeline (namespaced to your shop), or `undefined` in development and on deploys without a CDN configured — so `next dev` and un-provisioned deploys keep serving assets from the app origin. Pair it with `crossOrigin: 'anonymous'`: the assets then load cross-origin and the CDN sends the matching CORS header (required for fonts).
+
+  **Migration checklist for existing storefronts**:
+  - [ ] Add `assetPrefix: getAssetPrefix()` and `crossOrigin: 'anonymous'` to `next.config`.
+  - [ ] Redeploy — the next build's static assets are served from the CDN.
+
+  (`@doswiftly/storefront-operations` is version-synced with the SDK; no operation changes in this release.)
+
+## 22.6.0
+
+### Minor Changes
+
+- b1e622d: Add a zero-config Next.js image loader. Re-export `createImageLoader()` from the new
+  `@doswiftly/storefront-sdk/next` entry in your `images.loaderFile` and every `<Image>`
+  is routed through the image CDN: product images get a real responsive `srcset` (a width
+  per entry, so you can drop `transform: { maxWidth }`) and local `public/` images are
+  resized and format-negotiated (AVIF/WebP) instead of shipped at full size. Build assets,
+  external / protocol-relative URLs and `data:` URIs pass through untouched, and
+  `<Image quality>` is a no-op (quality is applied server-side; the format is auto-negotiated). The pure
+  `buildImageLoaderUrl` helper is also exported from the package root for non-`<Image>` use.
+
+  Usage:
+
+  ```ts
+  // lib/image-loader.ts
+  import { createImageLoader } from "@doswiftly/storefront-sdk/next";
+  export default createImageLoader();
+  ```
+
+  ```ts
+  // next.config.ts — bound the generated widths for fewer transforms / better cache hits
+  export default {
+    images: {
+      loader: "custom",
+      loaderFile: "./lib/image-loader.ts",
+      deviceSizes: [640, 750, 828, 1080, 1200, 1920],
+      imageSizes: [16, 32, 48, 64, 96, 128, 256, 384],
+    },
+  };
+  ```
+
+  Migration:
+  - New install — nothing to do; existing `<Image>` usage keeps working.
+  - Optional — drop `transform: { maxWidth }` from product-image queries; the loader now sets the width per `srcset` entry.
+
+### Patch Changes
+
+- 91c3b25: Ship TypeScript types for the codegen recipe (`@doswiftly/storefront-operations/codegen`). A `codegen.ts` that imports `createCodegenConfig` now type-checks under `strict` mode, so `next build` no longer fails with a missing-declaration (implicit `any`) error on the recipe import.
+
 ## 22.5.1
 
 ### Patch Changes

package/codegen.d.ts

@@ -0,0 +1,47 @@
+import type { CodegenConfig } from '@graphql-codegen/cli';
+
+/**
+ * Options for {@link createCodegenConfig}.
+ */
+export interface CreateCodegenConfigOptions {
+  /** Glob(s) pointing at the files where you write your GraphQL operations (`gql(...)`). */
+  documents: string | string[];
+  /** Output directory for the generated code. Defaults to `./src/gql/`. */
+  outDir?: string;
+  /**
+   * Name of the generated operation tag. Defaults to `gql`. Override (e.g.
+   * `'graphql'`) when your project already imports a `gql` from another GraphQL
+   * client (Apollo, urql, graphql-request) to avoid a name clash.
+   */
+  gqlTagName?: string;
+}
+
+/**
+ * Build a `graphql-codegen` configuration (client preset + persisted documents)
+ * pointed at this package's schema. Generated operation ids use the Storefront
+ * API's trusted-document format (`sha256:<hex>`), so the published manifest is
+ * accepted verbatim and the runtime `documentId` resolves server-side, which is
+ * what lets public reads be served from cache at the edge.
+ *
+ * `export default` the result from your codegen file.
+ *
+ * @example
+ *   // codegen.ts
+ *   import { createCodegenConfig } from '@doswiftly/storefront-operations/codegen';
+ *   export default createCodegenConfig({ documents: 'src/**\/*.{ts,tsx}' });
+ */
+export declare function createCodegenConfig(options: CreateCodegenConfigOptions): CodegenConfig;
+
+/**
+ * Compute a persisted-document id for a printed GraphQL document, in the exact
+ * format the Storefront API stores and validates: `sha256:` followed by the
+ * lowercase hex SHA-256 of the document body. Useful to assert a generated
+ * manifest matches what the API expects.
+ *
+ * @param documentBody - the printed GraphQL document (operation + its fragments).
+ * @returns `sha256:` followed by 64 hex characters.
+ */
+export declare function trustedDocumentHash(documentBody: string): string;
+
+/** Absolute path to the GraphQL schema file shipped in this package. */
+export declare const SCHEMA_PATH: string;

package/llms-full.txt

@@ -1,6 +1,6 @@
 # DoSwiftly Storefront Operations — Full Reference
 
-> Schema version: **22.5.1**
+> Schema version: **22.8.0**
 > 52 queries · 44 mutations · 105 fragments
 
 Auto-generated from `.graphql` source files. Do not edit by hand — this file is

package/operations.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "22.5.1",
+  "schemaVersion": "22.8.0",
   "queries": [
     {
       "name": "Shop",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doswiftly/storefront-operations",
-  "version": "22.5.1",
+  "version": "22.8.0",
   "description": "GraphQL operations for DoSwiftly Storefront - SSOT from backend",
   "homepage": "https://doswiftly.pl",
   "publishConfig": {
@@ -13,7 +13,10 @@
     "./mutations.graphql": "./mutations.graphql",
     "./fragments.graphql": "./fragments.graphql",
     "./operations.json": "./operations.json",
-    "./codegen": "./codegen.js",
+    "./codegen": {
+      "types": "./codegen.d.ts",
+      "default": "./codegen.js"
+    },
     "./*.graphql": "./*.graphql"
   },
   "devDependencies": {
@@ -35,6 +38,7 @@
     "fragments.graphql",
     "operations.json",
     "codegen.js",
+    "codegen.d.ts",
     "README.md",
     "AGENTS.md",
     "llms-full.txt",