@doswiftly/storefront-sdk 22.5.0 → 22.6.0

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
+## 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
+
+- 6ca2a5f: Corrected the GraphQL schema descriptions for the `CartStatus` enum and the `Cart.status` field so they match the cart's actual behaviour: an `ABANDONED` cart is revived in place by any deliberate buyer edit (it is not locked), editing an `EXPIRED` cart returns `CART_NOT_FOUND`, and only `CONVERTED` / completed carts return `ALREADY_COMPLETED`. Documentation only — no type or API changes.
+
 ## 22.5.0
 
 ### Minor Changes

package/README.md

@@ -229,6 +229,7 @@ retried.
 | `@doswiftly/storefront-sdk` | Core: transport, middleware, clients, recovery, errors, format, enums, cookie contracts | **0** |
 | `@doswiftly/storefront-sdk/react` | Providers, hooks, stores, pre-built UI components | react, zustand |
 | `@doswiftly/storefront-sdk/react/server` | Server client factory, SDK-BFF auth route, cookie readers | react (peer; `getInitialAuth` additionally requires Next.js) |
+| `@doswiftly/storefront-sdk/next` | Zero-config Next.js adapters — `createImageLoader()` for `images.loaderFile` | **0** |
 | `@doswiftly/storefront-sdk/cache` | Cache strategy functions | **0** |
 
 ## Authentication
@@ -735,6 +736,57 @@ import { Money, PriceDisplay, CartCount } from '@doswiftly/storefront-sdk/react'
 <CartCount count={3} label="items" />
 ```
 
+## Images — zero-config `next/image` loader
+
+`createImageLoader()` is a drop-in loader for Next.js `images.loaderFile`. It
+routes every `<Image>` through the image CDN so each one is resized to the
+viewport (real responsive `srcset`) and format-negotiated (AVIF/WebP from the
+browser `Accept` header) — no per-image configuration.
+
+Create the loader file (zero arguments):
+
+```ts
+// lib/image-loader.ts
+import { createImageLoader } from '@doswiftly/storefront-sdk/next';
+
+export default createImageLoader();
+```
+
+Point Next.js at it, and bound the generated sizes so a fixed set of widths is
+produced (fewer transforms, better cache hit rate):
+
+```ts
+// next.config.ts
+const nextConfig = {
+  images: {
+    loader: 'custom',
+    loaderFile: './lib/image-loader.ts',
+    deviceSizes: [640, 750, 828, 1080, 1200, 1920],
+    imageSizes: [16, 32, 48, 64, 96, 128, 256, 384],
+  },
+};
+export default nextConfig;
+```
+
+The loader is global and handles each `<Image src>` by category:
+
+| `src` | Handling |
+|-------|----------|
+| Product image (CDN URL from the GraphQL API) | Width set per `srcset` entry — drop `transform: { maxWidth }`, the loader owns the width |
+| Local `public/` image (e.g. `/hero.webp`) | Routed through the CDN, resized + format-negotiated |
+| Build asset (`/_next/*`), absolute external URL, `data:` URI | Returned unchanged |
+
+The loader reads `NEXT_PUBLIC_SHOP_ID`, `NEXT_PUBLIC_DEPLOYMENT_COMMIT`, and
+`NEXT_PUBLIC_IMGPROXY_BASE` — all injected by the platform at build/deploy time. When
+they are absent (e.g. local `doswiftly dev`, where `public/` images are served by the
+dev server) the loader leaves local `public/` images untouched; product images, being
+absolute CDN URLs, are unaffected. `<Image quality>` is a no-op — quality is applied
+server-side (the format is still auto-negotiated AVIF/WebP). Pass explicit overrides only for non-standard setups:
+`createImageLoader({ shopId, version, cdnBase })`.
+
+For non-`<Image>` usage (CSS backgrounds, raw `<img>`), build CDN URLs yourself
+with the pure helper `buildImageLoaderUrl` from `@doswiftly/storefront-sdk`.
+
 ## Middleware pipeline
 
 Default order (wired automatically by `StorefrontProvider`):

package/dist/core/generated/operation-types.d.ts

@@ -551,7 +551,7 @@ export type Cart = Node & {
     selectedShippingMethod?: Maybe<CartShippingMethod>;
     /** Shipping address attached to the cart via `cartSetShippingAddress`. Null until set. */
     shippingAddress?: Maybe<MailingAddress>;
-    /** Lifecycle status — `ACTIVE` for the editable working cart, terminal otherwise. Check this on SSR before rendering the checkout form: a non-`ACTIVE` cart should redirect (typically to the order confirmation when `completedOrder` is populated) instead of presenting a form whose first mutation fails with `CartErrorCode.ALREADY_COMPLETED`. */
+    /** Lifecycle status — `ACTIVE` / `RECOVERED` are editable; `ABANDONED` is a recovery flag a deliberate buyer action revives in place; `CONVERTED` / `EXPIRED` are terminal. Check this on SSR before rendering the checkout form: a `CONVERTED` cart should redirect (typically to the order confirmation when `completedOrder` is populated) instead of presenting a form whose first mutation fails with `CartErrorCode.ALREADY_COMPLETED`. */
     status: CartStatus;
     /** Sum of `quantity` across all lines — the badge number for the cart icon. */
     totalQuantity: Scalars['Int']['output'];