@doswiftly/storefront-operations 5.4.0 → 5.5.0

package/CHANGELOG.md

@@ -0,0 +1,117 @@
+# Changelog
+
+## 5.5.0
+
+### Minor Changes
+
+- 9a715e2: `menu(handle:)` query now resolves `MenuItem.url` and `MenuItem.resource` server-side via a batched DataLoader (~1 SQL query per resource type, no N+1).
+
+  **What changed**
+  - `MenuItem.url` for `CATEGORY` / `COLLECTION` / `PAGE` / `PRODUCT` types is now computed from the linked resource's slug/handle and follows the convention `/categories/{slug}`, `/collections/{handle}`, `/pages/{handle}`, `/products/{slug}`. Previously this field returned `null` whenever the menu item only stored a `resourceId` (the common admin-created case), making the menu unusable for navigation rendering.
+  - `MenuItem.resource` is now populated with the actual `Category` / `Collection` / `ShopPage` / `Product` object. Previously it was always `null`. Resolution is batched per resource type — fetching a 50-item menu with mixed types triggers at most 4 service calls.
+  - `Menu.itemsCount` now returns the count of top-level items (equal to `items.length`), matching the Shopify Storefront API. Previously it returned a recursive count of all items across all nesting levels, which produced confusing mismatches with `items.length`.
+  - Static types (`HTTP` / `FRONTPAGE` / `SEARCH` / `CATALOG` / `BLOG`) and orphaned resource references are unchanged in shape but now have clearer field descriptions.
+
+  **Migration**
+
+  If you relied on `Menu.itemsCount` as a recursive total, switch to client-side counting:
+
+  ```ts
+  function countAllItems(items: MenuItem[]): number {
+    return items.reduce((acc, item) => acc + 1 + countAllItems(item.items), 0);
+  }
+  ```
+
+  If you previously worked around the missing `url` / `resource` by fetching each linked resource individually after reading the menu, you can now drop that code path.
+
+## 5.4.1
+
+### Patch Changes
+
+- 7846bdb: Fix `doswiftly dev` port pre-flight on Windows (and any host where another
+  process binds the port on IPv6 `::` only): the probe now checks IPv4 and
+  IPv6 in parallel and requires BOTH free before marking a port as available.
+  Previously an IPv6-only conflict (common on Windows, where Next.js binds
+  `::` by default) slipped past the IPv4-only probe — the banner advertised
+  `http://localhost:3000` and the framework immediately crashed with
+  `EADDRINUSE :::3000`. With this fix `doswiftly dev` falls back to the next
+  free port (3001, 3002, …) as documented.
+
+  Also ship `CHANGELOG.md` inside the npm tarball. Previous releases packed
+  only `dist`/`bin`/`templates` (and `schema.graphql`/operations for
+  `storefront-operations`, `dist` for `storefront-sdk`), so consumers who
+  `npm install @doswiftly/cli` got a version number with no user-visible
+  release notes.
+
+## 5.4.0
+
+### Minor Changes
+
+- 770fcd3: Added `Product.purchasable: Boolean!` to the storefront schema. The field mirrors `visibility === 'PUBLIC'` server-side and lets templates hide the "Add to cart" / "Buy now" path for component products that are only reachable through a parent product's configurator.
+
+  Templates can render a non-purchasable banner on the PDP instead of exposing a purchase action that the server will reject. Requesting the field is additive — operations that omit it keep working.
+
+All notable changes to @doswiftly/storefront-operations will be documented in this file.
+
+## [5.0.0] - 2026-04-12
+
+### Breaking
+
+- Removed `type InventoryLevel`, `fragment InventoryLevel`, `fragment VariantInventoryLevels`, and `query ProductInventory`.
+- Removed `ProductVariant.inventoryLevels(locationType)` field — replaced by `ProductVariant.storeAvailability`.
+
+### Added
+
+- Shopify-parity `StoreAvailability` surface on `ProductVariant`:
+  - `type StoreAvailability { available, quantityAvailable (token-gated), pickUpTime, location }`
+  - `type Location`, `LocationAddress`, `BusinessHours`, `BusinessHoursWindow` — full pickup-aware payload.
+  - `type StoreAvailabilityConnection` + `StoreAvailabilityEdge` — cursor-paginated, supports `near`, `locationType`, `@inContext(preferredLocationId)`.
+- Root-level queries: `locations(first, after, near, hasPickupEnabled, locationType)` and `location(id)`.
+- `directive @inContext(preferredLocationId: ID) on QUERY | MUTATION | SUBSCRIPTION` — Shopify operation directive for contextual hints (country / language / buyer to follow).
+- Fragments: `StoreAvailability`, `StoreAvailabilityConnection`, `Location`, `LocationAddress`, `BusinessHours`, `BusinessHoursWindow`, `VariantStoreAvailability`.
+- Queries: `ProductStoreAvailability`, `Locations`, `Location`.
+
+### Migration
+
+Replace:
+
+```graphql
+query ProductInventory($handle: String) {
+  product(handle: $handle) {
+    variants {
+      ...VariantInventoryLevels
+    }
+  }
+}
+```
+
+with:
+
+```graphql
+query ProductStoreAvailability($handle: String) {
+  product(handle: $handle) {
+    variants {
+      ...VariantStoreAvailability
+    }
+  }
+}
+```
+
+`quantityAvailable` is now token-gated (null for anonymous, Int when `x-customer-access-token` is sent) — matches Shopify Storefront API.
+
+## [1.0.0] - 2025-12-09
+
+### Added
+
+- Initial release of @doswiftly/storefront-operations package
+- GraphQL operations synced from backend SSOT
+- Queries: Shop, Product, Products, ProductSearch, Collection, Collections, Category, Categories, Cart, Customer
+- Mutations: Cart operations, Customer auth, Profile management, Address management, Password recovery
+- Fragments: All reusable fragments for products, collections, cart, customer, etc.
+- Sync script to copy operations from backend
+- Package exports for .graphql files
+- README with usage instructions
+
+### Purpose
+
+Enable direct GraphQL codegen approach for Next.js storefronts while maintaining Single Source of Truth from backend.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doswiftly/storefront-operations",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "GraphQL operations for DoSwiftly Storefront - SSOT from backend",
   "homepage": "https://doswiftly.pl",
   "publishConfig": {
@@ -28,7 +28,8 @@
     "queries.graphql",
     "mutations.graphql",
     "fragments.graphql",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "sync": "node scripts/sync-operations.js",

package/schema.graphql

@@ -2662,7 +2662,7 @@ type Menu {
   """Top-level menu items"""
   items: [MenuItem!]!
 
-  """Total count of items across all levels"""
+  """The count of top-level items on the menu (equal to items.length)"""
   itemsCount: Int!
 
   """Menu title"""
@@ -2680,7 +2680,9 @@ type MenuItem {
   """Child menu items (max 3 levels)"""
   items: [MenuItem!]!
 
-  """Linked resource object (lazy, via DataLoader)"""
+  """
+  Linked resource object resolved server-side via DataLoader (batched per resource type — no N+1). Null when type is HTTP/FRONTPAGE/SEARCH/CATALOG/BLOG, or when resourceId points to a deleted resource.
+  """
   resource: MenuItemResource
 
   """Linked resource ID"""
@@ -2692,7 +2694,9 @@ type MenuItem {
   """Link type"""
   type: MenuItemType!
 
-  """Resolved URL (always computed server-side)"""
+  """
+  Resolved URL path computed server-side (e.g., /categories/funko, /products/toy-1, /pages/about, /collections/sale). Static types resolve to /, /search, /products, /blog. HTTP type returns the manually stored URL. Null only when type is a resource link (CATEGORY/COLLECTION/PAGE/PRODUCT) and the resource was deleted.
+  """
   url: String
 }