@doswiftly/storefront-operations 1.0.5 → 4.4.0

package/README.md

@@ -1,6 +1,8 @@
 # @doswiftly/storefront-operations
 
-Pre-built GraphQL operations for DoSwiftly e-commerce storefronts. Contains ready-to-use queries, mutations, and fragments for products, collections, cart, checkout, and customer management.
+Pre-built GraphQL operations and schema for DoSwiftly e-commerce storefronts. Contains the GraphQL schema file, ready-to-use queries, mutations, and fragments for products, collections, cart, checkout, and customer management.
+
+**No running backend needed for codegen** — the schema is included as a file.
 
 ## Installation
 
@@ -24,13 +26,8 @@ npm install @doswiftly/storefront-operations @graphql-codegen/cli @graphql-codeg
 import { CodegenConfig } from "@graphql-codegen/cli";
 
 const config: CodegenConfig = {
-  schema: {
-    [process.env.NEXT_PUBLIC_STOREFRONT_API_URL!]: {
-      headers: {
-        "X-Shop-Slug": process.env.NEXT_PUBLIC_SHOP_SLUG!,
-      },
-    },
-  },
+  // Schema from package — no running backend needed!
+  schema: "node_modules/@doswiftly/storefront-operations/schema.graphql",
   documents: [
     "node_modules/@doswiftly/storefront-operations/**/*.graphql",
     "src/**/*.{ts,tsx}", // Your custom operations (optional)
@@ -137,11 +134,16 @@ export function ProductList() {
 - `CustomerPasswordRecover` - Request password reset email
 - `CustomerPasswordReset` - Reset password with token
 
-## Environment Variables
+## Schema
 
-```env
-NEXT_PUBLIC_STOREFRONT_API_URL=https://api.doswiftly.pl/storefront/graphql
-NEXT_PUBLIC_SHOP_SLUG=your-shop-slug
+The package includes `schema.graphql` — the full GraphQL schema auto-generated from the backend (NestJS code-first). This enables **offline codegen** without a running backend.
+
+To update the schema after backend changes:
+
+```bash
+# From monorepo root (requires backend to have been started at least once)
+cd packages/@doswiftly/storefront-operations
+pnpm run sync
 ```
 
 ## TypeScript Support

package/fragments.graphql

@@ -34,10 +34,15 @@ fragment Money on Money {
   currencyCode
 }
 
-# Full price with conversion transparency (for price fields that support currency conversion)
-fragment PriceMoney on PriceMoney {
+# Lightweight price for listing views (cards, grids, search results)
+fragment Price on PriceMoney {
   amount
   currencyCode
+}
+
+# Full price with conversion transparency (for price fields that support currency conversion)
+fragment PriceMoney on PriceMoney {
+  ...Price
   baseAmount
   baseCurrencyCode
   exchangeRate
@@ -84,37 +89,50 @@ fragment ProductVariant on ProductVariant {
   position
 }
 
-fragment ProductBase on Product {
+# Minimal product data for listing views (cards, grids, search results).
+# Matches template-local ProductCardFields for consistent typing.
+fragment ProductCard on Product {
   id
   handle
   title
-  description
-  descriptionHtml
+  vendor
+  productType
+  availableForSale
+  averageRating
+  reviewCount
+  tags
   featuredImage {
     ...Image
   }
   priceRange {
     minVariantPrice {
-      ...PriceMoney
+      ...Price
     }
     maxVariantPrice {
-      ...PriceMoney
+      ...Price
     }
   }
-  originalPriceRange {
+  compareAtPriceRange {
     minVariantPrice {
-      ...Money
+      ...Price
     }
     maxVariantPrice {
-      ...Money
+      ...Price
     }
   }
-  compareAtPriceRange {
+}
+
+# Full product data for detail views and pages that need all fields.
+fragment ProductBase on Product {
+  ...ProductCard
+  description
+  descriptionHtml
+  originalPriceRange {
     minVariantPrice {
-      ...PriceMoney
+      ...Money
     }
     maxVariantPrice {
-      ...PriceMoney
+      ...Money
     }
   }
   originalCompareAtPriceRange {
@@ -126,16 +144,10 @@ fragment ProductBase on Product {
     }
   }
   totalInventory
-  vendor
-  productType
   type
   collectRecipientInfo
-  tags
   createdAt
   updatedAt
-  averageRating
-  reviewCount
-  availableForSale
 }
 
 fragment ProductFull on Product {
@@ -225,7 +237,7 @@ fragment Customer on Customer {
   displayName
   phone
   emailVerified
-  acceptsMarketing
+  emailMarketingState
   defaultAddress {
     ...MailingAddress
   }
@@ -252,43 +264,19 @@ fragment Order on Order {
   totalShipping {
     ...Money
   }
+  status
   financialStatus
   fulfillmentStatus
   processedAt
+  confirmedAt
+  cancelledAt
+  expiredAt
   shippingAddress {
     ...MailingAddress
   }
   lineItemsCount
 }
 
-# Order with shipments for tracking pages
-fragment OrderWithShipments on Order {
-  id
-  orderNumber
-  totalPrice {
-    ...Money
-  }
-  subtotalPrice {
-    ...Money
-  }
-  totalTax {
-    ...Money
-  }
-  totalShipping {
-    ...Money
-  }
-  financialStatus
-  fulfillmentStatus
-  processedAt
-  shippingAddress {
-    ...MailingAddress
-  }
-  lineItemsCount
-  shipments {
-    ...Shipment
-  }
-}
-
 # ============================================
 # Cart Fragments
 # ============================================
@@ -449,6 +437,22 @@ fragment ShopBranding on ShopBranding {
   }
 }
 
+fragment BotProtectionProvider on BotProtectionProviderInfo {
+  provider
+  siteKey
+  scriptUrl
+}
+
+fragment BotProtection on BotProtectionInfo {
+  primary {
+    ...BotProtectionProvider
+  }
+  fallback {
+    ...BotProtectionProvider
+  }
+  protectedOperations
+}
+
 fragment Shop on Shop {
   id
   name
@@ -457,6 +461,8 @@ fragment Shop on Shop {
   currencyCode
   supportedCurrencies
   paymentCurrencies
+  defaultLanguage
+  supportedLanguages
   logo {
     ...Image
   }
@@ -471,6 +477,9 @@ fragment Shop on Shop {
   branding {
     ...ShopBranding
   }
+  botProtection {
+    ...BotProtection
+  }
 }
 
 # ============================================
@@ -577,6 +586,9 @@ fragment CheckoutLineItem on CheckoutLineItem {
   variantId
   productId
   sku
+  image {
+    ...Image
+  }
 }
 
 # GAP-001: Gift Card Checkout Integration
@@ -797,17 +809,6 @@ fragment Return on Return {
   updatedAt
 }
 
-fragment ReturnBasic on Return {
-  id
-  returnNumber
-  orderId
-  orderNumber
-  status
-  reason
-  createdAt
-  updatedAt
-}
-
 fragment ReturnReasonOption on ReturnReasonOption {
   value
   label
@@ -1150,3 +1151,179 @@ fragment GenerateReferralCodePayload on GenerateReferralCodePayload {
   shareUrl
   userErrors
 }
+
+# ============================================
+# Review Fragments
+# ============================================
+
+fragment ProductReview on ProductReview {
+  id
+  productId
+  rating
+  title
+  content
+  pros
+  cons
+  images
+  authorName
+  isVerifiedPurchase
+  helpfulCount
+  response
+  responseAt
+  createdAt
+}
+
+fragment ReviewStats on ReviewStats {
+  averageRating
+  totalCount
+  fiveStarCount
+  fourStarCount
+  threeStarCount
+  twoStarCount
+  oneStarCount
+}
+
+# ============================================
+# Wishlist Fragments
+# ============================================
+
+fragment WishlistItem on WishlistItem {
+  id
+  productId
+  variantId
+  product {
+    ...ProductCard
+  }
+  priceAtAdd {
+    ...Money
+  }
+  notifyOnSale
+  notifyOnRestock
+  addedAt
+}
+
+fragment Wishlist on Wishlist {
+  id
+  name
+  isPublic
+  shareToken
+  items {
+    ...WishlistItem
+  }
+  itemCount
+  createdAt
+  updatedAt
+}
+
+# ============================================
+# Blog Fragments
+# ============================================
+
+fragment BlogCategory on BlogCategory {
+  id
+  name
+  slug
+  description
+  postCount
+}
+
+fragment BlogTag on BlogTag {
+  id
+  name
+  slug
+  postCount
+}
+
+fragment BlogPost on BlogPost {
+  id
+  title
+  slug
+  excerpt
+  content
+  contentType
+  featuredImage {
+    ...Image
+  }
+  author {
+    id
+    name
+    bio
+    avatar {
+      ...Image
+    }
+  }
+  category {
+    ...BlogCategory
+  }
+  tags {
+    ...BlogTag
+  }
+  publishedAt
+  readingTime
+  viewCount
+  commentCount
+  allowComments
+  isFeatured
+  status
+  seo {
+    title
+    description
+  }
+  createdAt
+  updatedAt
+}
+
+# ============================================
+# Recommendation Fragments
+# ============================================
+
+fragment ProductRecommendation on ProductRecommendation {
+  product {
+    ...ProductCard
+  }
+  type
+  score
+  reason
+}
+
+fragment CartRecommendation on CartRecommendations {
+  frequentlyBoughtTogether {
+    product {
+      ...ProductCard
+    }
+    type
+    score
+    reason
+  }
+  youMayAlsoLike {
+    product {
+      ...ProductCard
+    }
+    type
+    score
+    reason
+  }
+}
+
+# ============================================
+# Inventory Level Fragments (Multi-Warehouse)
+# ============================================
+
+fragment InventoryLevel on InventoryLevel {
+  locationId
+  locationName
+  locationType
+  available
+  onHand
+}
+
+fragment VariantInventoryLevels on ProductVariant {
+  id
+  title
+  sku
+  available
+  quantityAvailable
+  inventoryLevels {
+    ...InventoryLevel
+  }
+}

package/mutations.graphql

@@ -431,3 +431,69 @@ mutation GenerateReferralCode {
     ...GenerateReferralCodePayload
   }
 }
+
+# ============================================
+# Review Mutations
+# ============================================
+
+mutation ReviewCreate($input: ReviewCreateInput!) {
+  reviewCreate(input: $input) {
+    review {
+      ...ProductReview
+    }
+    userErrors {
+      ...UserError
+    }
+  }
+}
+
+mutation ReviewVote($reviewId: ID!, $isHelpful: Boolean!) {
+  reviewVote(reviewId: $reviewId, isHelpful: $isHelpful) {
+    review {
+      ...ProductReview
+    }
+    userErrors {
+      ...UserError
+    }
+  }
+}
+
+# ============================================
+# Wishlist Mutations
+# ============================================
+
+mutation WishlistCreate($input: WishlistCreateInput!) {
+  wishlistCreate(input: $input) {
+    wishlist {
+      ...Wishlist
+    }
+    userErrors
+  }
+}
+
+mutation WishlistAddItem($wishlistId: ID!, $input: WishlistItemInput!) {
+  wishlistAddItem(wishlistId: $wishlistId, input: $input) {
+    wishlist {
+      ...Wishlist
+    }
+    userErrors
+  }
+}
+
+mutation WishlistRemoveItem($wishlistId: ID!, $itemId: ID!) {
+  wishlistRemoveItem(wishlistId: $wishlistId, itemId: $itemId) {
+    wishlist {
+      ...Wishlist
+    }
+    userErrors
+  }
+}
+
+mutation WishlistDelete($wishlistId: ID!) {
+  wishlistDelete(wishlistId: $wishlistId) {
+    wishlist {
+      ...Wishlist
+    }
+    userErrors
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doswiftly/storefront-operations",
-  "version": "1.0.5",
+  "version": "4.4.0",
   "description": "GraphQL operations for DoSwiftly Storefront - SSOT from backend",
   "homepage": "https://doswiftly.pl",
   "publishConfig": {
@@ -8,6 +8,7 @@
   },
   "main": "index.js",
   "exports": {
+    "./schema.graphql": "./schema.graphql",
     "./queries.graphql": "./queries.graphql",
     "./mutations.graphql": "./mutations.graphql",
     "./fragments.graphql": "./fragments.graphql",
@@ -27,6 +28,7 @@
   "author": "DoSwiftly Team",
   "license": "MIT",
   "files": [
+    "schema.graphql",
     "queries.graphql",
     "mutations.graphql",
     "fragments.graphql",

package/queries.graphql

@@ -34,7 +34,7 @@ query Products(
   products(first: $first, after: $after, query: $query, sortKey: $sortKey, reverse: $reverse, filters: $filters) {
     edges {
       node {
-        ...ProductBase
+        ...ProductCard
       }
       cursor
     }
@@ -49,7 +49,7 @@ query ProductSearch($query: String!, $first: Int = 20, $after: String, $filters:
   products(query: $query, first: $first, after: $after, filters: $filters) {
     edges {
       node {
-        ...ProductBase
+        ...ProductCard
       }
       cursor
     }
@@ -70,7 +70,7 @@ query Collection($id: ID, $handle: String, $productsFirst: Int = 20, $productsAf
     products(first: $productsFirst, after: $productsAfter) {
       edges {
         node {
-          ...ProductBase
+          ...ProductCard
         }
         cursor
       }
@@ -82,8 +82,8 @@ query Collection($id: ID, $handle: String, $productsFirst: Int = 20, $productsAf
   }
 }
 
-query Collections($first: Int = 20, $after: String, $sortKey: CollectionSortKeys = TITLE, $reverse: Boolean = false) {
-  collections(first: $first, after: $after, sortKey: $sortKey, reverse: $reverse) {
+query Collections($first: Int = 20, $after: String, $query: String, $sortKey: CollectionSortKeys = TITLE, $reverse: Boolean = false) {
+  collections(first: $first, after: $after, query: $query, sortKey: $sortKey, reverse: $reverse) {
     edges {
       node {
         ...Collection
@@ -163,6 +163,21 @@ query Customer($customerAccessToken: String!) {
   }
 }
 
+# Lightweight customer profile query (no orders, no addresses list)
+# Use for settings/profile pages that only need basic customer info.
+query CustomerProfile($customerAccessToken: String!) {
+  customer(customerAccessToken: $customerAccessToken) {
+    ...Customer
+  }
+}
+
+# Single order query — more efficient than fetching all customer data
+query CustomerOrder($orderId: ID!, $customerAccessToken: String!) {
+  customerOrder(orderId: $orderId, customerAccessToken: $customerAccessToken) {
+    ...Order
+  }
+}
+
 # ============================================
 # Checkout
 # ============================================
@@ -353,3 +368,111 @@ query ReferralStats {
     ...ReferralStats
   }
 }
+
+# ============================================
+# Reviews
+# ============================================
+
+query ProductReviews($productId: ID!, $first: Int = 10, $after: String, $sortKey: ReviewSortKey = CREATED_AT, $reverse: Boolean = true) {
+  productReviews(productId: $productId, first: $first, after: $after, sortKey: $sortKey, reverse: $reverse) {
+    edges {
+      node {
+        ...ProductReview
+      }
+      cursor
+    }
+    pageInfo {
+      ...PageInfo
+    }
+    totalCount
+  }
+}
+
+query ReviewStats($productId: ID!) {
+  reviewStats(productId: $productId) {
+    ...ReviewStats
+  }
+}
+
+# ============================================
+# Wishlists
+# ============================================
+
+query Wishlists {
+  wishlists {
+    ...Wishlist
+  }
+}
+
+query WishlistById($id: ID!) {
+  wishlist(id: $id) {
+    ...Wishlist
+  }
+}
+
+# ============================================
+# Blog
+# ============================================
+
+query BlogPosts($first: Int = 20, $after: String, $categorySlug: String, $tagSlug: String, $featured: Boolean, $sortKey: BlogPostSortKey = PUBLISHED_AT, $reverse: Boolean = false) {
+  blogPosts(first: $first, after: $after, categorySlug: $categorySlug, tagSlug: $tagSlug, featured: $featured, sortKey: $sortKey, reverse: $reverse) {
+    edges {
+      node {
+        ...BlogPost
+      }
+      cursor
+    }
+    pageInfo {
+      ...PageInfo
+    }
+    totalCount
+  }
+}
+
+query BlogPost($id: ID, $slug: String) {
+  blogPost(id: $id, slug: $slug) {
+    ...BlogPost
+  }
+}
+
+query BlogCategories {
+  blogCategories {
+    ...BlogCategory
+  }
+}
+
+query BlogTags {
+  blogTags {
+    ...BlogTag
+  }
+}
+
+# ============================================
+# Recommendations
+# ============================================
+
+query ProductRecommendations($productId: ID!, $limit: Int = 8, $intent: RecommendationIntent = SIMILAR) {
+  productRecommendations(productId: $productId, limit: $limit, intent: $intent) {
+    ...ProductCard
+  }
+}
+
+query SimilarProducts($productId: String!, $first: Int = 6) {
+  similarProducts(productId: $productId, first: $first) {
+    items {
+      ...ProductCard
+    }
+    totalCount
+  }
+}
+
+query CartRecommendations($cartId: String!, $first: Int = 4) {
+  cartRecommendations(cartId: $cartId, first: $first) {
+    frequentlyBoughtTogether {
+      ...ProductCard
+    }
+    youMayAlsoLike {
+      ...ProductCard
+    }
+  }
+}