@doswiftly/storefront-operations 14.0.0 → 16.0.0

package/llms-full.txt

@@ -1,7 +1,7 @@
 # DoSwiftly Storefront Operations — Full Reference
 
-> Schema version: **14.0.0**
-> 50 queries · 40 mutations · 100 fragments
+> Schema version: **16.0.0**
+> 52 queries · 40 mutations · 102 fragments
 
 Auto-generated from `.graphql` source files. Do not edit by hand — this file is
 regenerated on every release to match the published schema.
@@ -37,6 +37,25 @@ query Shop {
 }
 ```
 
+### Query: `ShopConfig`
+
+**Section**: Shop
+
+**Description**: Minimal Shop payload for `<StorefrontProvider shopData={...}>` from `@doswiftly/storefront-sdk/react`. Returns exactly the fields the SDK's `ShopConfig` interface declares — currency setup (with `localeToCurrencyMap` for browser-locale-based currency detection), language setup, and bot protection. Cache for the session; refetch when the merchant updates currency / language settings or you want to pick up new bot-protection rules.
+
+**Variables**: none
+
+**Fragments used**: `ShopConfigFields`
+
+**GraphQL**:
+```graphql
+query ShopConfig {
+  shop {
+    ...ShopConfigFields
+  }
+}
+```
+
 ### Query: `Product`
 
 **Section**: Products
@@ -410,6 +429,33 @@ query CustomerProfile {
 }
 ```
 
+### Query: `CustomerAddresses`
+
+**Section**: Customer (requires auth)
+
+**Description**: Authenticated customer's saved address book — used on checkout to let the buyer pick a previously-used shipping / billing address instead of typing it. Each entry carries B2B invoicing fields (`taxId`, `vatNumber`) and the `isDefault` flag so the same list serves both as the shipping picker and as the billing/invoice picker. Returns up to 50 addresses (Relay Connection — buyers rarely keep more); for the unauthenticated case the connection is empty (no error). The default address is also surfaced as `Customer.defaultAddress`.
+
+**Variables**: none
+
+**Fragments used**: `MailingAddress`, `PageInfo`
+
+**GraphQL**:
+```graphql
+query CustomerAddresses {
+  customer {
+    addresses(first: 50) {
+      nodes {
+        ...MailingAddress
+      }
+      pageInfo {
+        ...PageInfo
+      }
+      totalCount
+    }
+  }
+}
+```
+
 ### Query: `CustomerOrder`
 
 **Section**: Customer (requires auth)
@@ -2744,11 +2790,29 @@ fragment Category on Category {
 }
 ```
 
+### Fragment: `PickupPoint` on `PickupPoint`
+
+**Section**: Customer
+
+**Description**: Selected pickup point (parcel locker or collection point) attached to a delivery address. Returned on `MailingAddress.pickupPoint` when the buyer chose a non-home delivery method (`deliveryType` other than `HOME`). Null for home delivery.
+
+**GraphQL**:
+```graphql
+fragment PickupPoint on PickupPoint {
+  provider
+  pointId
+  name
+  address
+}
+```
+
 ### Fragment: `MailingAddress` on `MailingAddress`
 
 **Section**: Customer
 
-**Description**: Customer mailing address — full street/city/state/country/postal code with names and phone. `isDefault` flips when this address is the default for shipping. Spread on the address book UI and order summaries.
+**Description**: Customer mailing address — full street/city/state/country/postal code with names and phone. `isDefault` flips when this address is the default for shipping. Carries B2B invoicing fields (`taxId`, `vatNumber`) and the selected `pickupPoint` for parcel locker / collection point deliveries. Spread on the address book UI, checkout shipping/billing forms, and order summaries.
+
+**Uses fragments**: `PickupPoint`
 
 **GraphQL**:
 ```graphql
@@ -2768,6 +2832,11 @@ fragment MailingAddress on MailingAddress {
   stateCode
   postalCode
   isDefault
+  taxId
+  vatNumber
+  pickupPoint {
+    ...PickupPoint
+  }
 }
 ```
 
@@ -2870,7 +2939,7 @@ fragment Order on Order {
 
 **Section**: Cart
 
-**Description**: Cart-level totals — subtotal, total, tax, duty, checkout charge. Spread inside the `Cart` fragment.
+**Description**: Cart-level totals — subtotal, total, tax, duty, discount, shipping, checkout charge. Spread inside the `Cart` fragment.
 
 **Uses fragments**: `Money`
 
@@ -2892,6 +2961,12 @@ fragment CartCost on CartCost {
   checkoutCharge {
     ...Money
   }
+  totalDiscount {
+    ...Money
+  }
+  totalShipping {
+    ...Money
+  }
 }
 ```
 
@@ -3097,6 +3172,15 @@ fragment Cart on Cart {
   requiresShipping
   createdAt
   updatedAt
+  status
+  completedOrder {
+    id
+    orderNumber
+    accessToken
+    status
+    paymentStatus
+    fulfillmentStatus
+  }
 }
 ```
 
@@ -3123,13 +3207,14 @@ fragment CartShippingMethod on CartShippingMethod {
 
 **Section**: Cart
 
-**Description**: Gift card applied to a cart — masked code for display, last 4 chars for matching, applied amount + remaining balance. Balance NIE debited yet — actual deduction atomically at `cartComplete`.
+**Description**: Gift card applied to a cart — `id` is the stable handle the storefront passes to `cartRemoveGiftCard` (no need to keep the raw code around). Plus masked code for display, last 4 chars for matching, applied amount + remaining balance. Balance NIE debited yet — actual deduction atomically at `cartComplete`.
 
 **Uses fragments**: `Money`
 
 **GraphQL**:
 ```graphql
 fragment CartAppliedGiftCard on CartAppliedGiftCard {
+  id
   maskedCode
   lastCharacters
   appliedAmount {
@@ -3355,6 +3440,31 @@ fragment Shop on Shop {
 }
 ```
 
+### Fragment: `ShopConfigFields` on `Shop`
+
+**Section**: Shop
+
+**Description**: Minimal Shop fields consumed by `<StorefrontProvider shopData={...}>` from `@doswiftly/storefront-sdk/react`. Spread this in your `shop` query to get a response shape that matches the SDK `ShopConfig` interface 1:1 — no manual field selection, no drift when the SDK adds optional fields. Use the larger `Shop` fragment when you also need branding / contact / business hours for your UI.
+
+**Uses fragments**: `BotProtection`
+
+**GraphQL**:
+```graphql
+fragment ShopConfigFields on Shop {
+  currencyCode
+  supportedCurrencies
+  localeToCurrencyMap {
+    locale
+    currency
+  }
+  defaultLanguage
+  supportedLanguages
+  botProtection {
+    ...BotProtection
+  }
+}
+```
+
 ### Fragment: `PaymentMethod` on `PaymentMethod`
 
 **Section**: Payment Methods
@@ -3772,7 +3882,7 @@ fragment FreeShippingProgress on FreeShippingProgress {
 
 **Section**: Shipping Methods
 
-**Description**: One shipping method offered for the destination + cart — id, name, carrier, price, free-shipping progress, estimated delivery, sort order. Spread on the checkout shipping step.
+**Description**: One shipping method offered for the destination + cart — id, name, carrier, price, free-shipping progress, estimated delivery, sort order. `deliveryType` signals whether to render a pickup-point / locker picker (`HOME` vs `PICKUP_POINT` / `LOCKER`) so the storefront does not have to infer it from the method name. Spread on the checkout shipping step.
 
 **Uses fragments**: `DeliveryEstimate`, `FreeShippingProgress`, `Money`, `ShippingCarrier`
 
@@ -3782,6 +3892,7 @@ fragment AvailableShippingMethod on AvailableShippingMethod {
   id
   name
   description
+  deliveryType
   carrier {
     ...ShippingCarrier
   }

package/operations.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "14.0.0",
+  "schemaVersion": "16.0.0",
   "queries": [
     {
       "name": "Shop",
@@ -12,6 +12,17 @@
       ],
       "body": "query Shop {\n  shop {\n    ...Shop\n  }\n}"
     },
+    {
+      "name": "ShopConfig",
+      "kind": "query",
+      "section": "Shop",
+      "description": "Minimal Shop payload for `<StorefrontProvider shopData={...}>` from `@doswiftly/storefront-sdk/react`. Returns exactly the fields the SDK's `ShopConfig` interface declares — currency setup (with `localeToCurrencyMap` for browser-locale-based currency detection), language setup, and bot protection. Cache for the session; refetch when the merchant updates currency / language settings or you want to pick up new bot-protection rules.",
+      "variables": [],
+      "fragmentRefs": [
+        "ShopConfigFields"
+      ],
+      "body": "query ShopConfig {\n  shop {\n    ...ShopConfigFields\n  }\n}"
+    },
     {
       "name": "Product",
       "kind": "query",
@@ -307,6 +318,18 @@
       ],
       "body": "query CustomerProfile {\n  customer {\n    ...Customer\n  }\n}"
     },
+    {
+      "name": "CustomerAddresses",
+      "kind": "query",
+      "section": "Customer (requires auth)",
+      "description": "Authenticated customer's saved address book — used on checkout to let the buyer pick a previously-used shipping / billing address instead of typing it. Each entry carries B2B invoicing fields (`taxId`, `vatNumber`) and the `isDefault` flag so the same list serves both as the shipping picker and as the billing/invoice picker. Returns up to 50 addresses (Relay Connection — buyers rarely keep more); for the unauthenticated case the connection is empty (no error). The default address is also surfaced as `Customer.defaultAddress`.",
+      "variables": [],
+      "fragmentRefs": [
+        "MailingAddress",
+        "PageInfo"
+      ],
+      "body": "query CustomerAddresses {\n  customer {\n    addresses(first: 50) {\n      nodes {\n        ...MailingAddress\n      }\n      pageInfo {\n        ...PageInfo\n      }\n      totalCount\n    }\n  }\n}"
+    },
     {
       "name": "CustomerOrder",
       "kind": "query",
@@ -1999,13 +2022,25 @@
       "onType": "Category"
     },
     {
-      "name": "MailingAddress",
+      "name": "PickupPoint",
       "kind": "fragment",
       "section": "Customer",
-      "description": "Customer mailing address — full street/city/state/country/postal code with names and phone. `isDefault` flips when this address is the default for shipping. Spread on the address book UI and order summaries.",
+      "description": "Selected pickup point (parcel locker or collection point) attached to a delivery address. Returned on `MailingAddress.pickupPoint` when the buyer chose a non-home delivery method (`deliveryType` other than `HOME`). Null for home delivery.",
       "variables": [],
       "fragmentRefs": [],
-      "body": "fragment MailingAddress on MailingAddress {\n  id\n  streetLine1\n  streetLine2\n  city\n  company\n  country\n  countryCode\n  firstName\n  lastName\n  name\n  phone\n  state\n  stateCode\n  postalCode\n  isDefault\n}",
+      "body": "fragment PickupPoint on PickupPoint {\n  provider\n  pointId\n  name\n  address\n}",
+      "onType": "PickupPoint"
+    },
+    {
+      "name": "MailingAddress",
+      "kind": "fragment",
+      "section": "Customer",
+      "description": "Customer mailing address — full street/city/state/country/postal code with names and phone. `isDefault` flips when this address is the default for shipping. Carries B2B invoicing fields (`taxId`, `vatNumber`) and the selected `pickupPoint` for parcel locker / collection point deliveries. Spread on the address book UI, checkout shipping/billing forms, and order summaries.",
+      "variables": [],
+      "fragmentRefs": [
+        "PickupPoint"
+      ],
+      "body": "fragment MailingAddress on MailingAddress {\n  id\n  streetLine1\n  streetLine2\n  city\n  company\n  country\n  countryCode\n  firstName\n  lastName\n  name\n  phone\n  state\n  stateCode\n  postalCode\n  isDefault\n  taxId\n  vatNumber\n  pickupPoint {\n    ...PickupPoint\n  }\n}",
       "onType": "MailingAddress"
     },
     {
@@ -2048,12 +2083,12 @@
       "name": "CartCost",
       "kind": "fragment",
       "section": "Cart",
-      "description": "Cart-level totals — subtotal, total, tax, duty, checkout charge. Spread inside the `Cart` fragment.",
+      "description": "Cart-level totals — subtotal, total, tax, duty, discount, shipping, checkout charge. Spread inside the `Cart` fragment.",
       "variables": [],
       "fragmentRefs": [
         "Money"
       ],
-      "body": "fragment CartCost on CartCost {\n  total {\n    ...Money\n  }\n  subtotal {\n    ...Money\n  }\n  totalTax {\n    ...Money\n  }\n  totalDuty {\n    ...Money\n  }\n  checkoutCharge {\n    ...Money\n  }\n}",
+      "body": "fragment CartCost on CartCost {\n  total {\n    ...Money\n  }\n  subtotal {\n    ...Money\n  }\n  totalTax {\n    ...Money\n  }\n  totalDuty {\n    ...Money\n  }\n  checkoutCharge {\n    ...Money\n  }\n  totalDiscount {\n    ...Money\n  }\n  totalShipping {\n    ...Money\n  }\n}",
       "onType": "CartCost"
     },
     {
@@ -2142,7 +2177,7 @@
         "MailingAddress",
         "PageInfo"
       ],
-      "body": "fragment Cart on Cart {\n  id\n  checkoutUrl\n  totalQuantity\n  cost {\n    ...CartCost\n  }\n  lines(first: 100) {\n    edges {\n      cursor\n      node {\n        ... on CartLine {\n          ...CartLine\n        }\n      }\n    }\n    nodes {\n      ... on CartLine {\n        ...CartLine\n      }\n    }\n    pageInfo {\n      ...PageInfo\n    }\n    totalCount\n  }\n  buyerIdentity {\n    ...CartBuyerIdentity\n  }\n  discountCodes {\n    ...CartDiscountCode\n  }\n  discountAllocations {\n    ...CartDiscountAllocation\n  }\n  note\n  attributes {\n    key\n    value\n  }\n  email\n  phone\n  shippingAddress {\n    ...MailingAddress\n  }\n  billingAddress {\n    ...MailingAddress\n  }\n  selectedShippingMethod {\n    ...CartShippingMethod\n  }\n  selectedPaymentMethod {\n    ...CartSelectedPaymentMethod\n  }\n  appliedGiftCards {\n    ...CartAppliedGiftCard\n  }\n  requiresShipping\n  createdAt\n  updatedAt\n}",
+      "body": "fragment Cart on Cart {\n  id\n  checkoutUrl\n  totalQuantity\n  cost {\n    ...CartCost\n  }\n  lines(first: 100) {\n    edges {\n      cursor\n      node {\n        ... on CartLine {\n          ...CartLine\n        }\n      }\n    }\n    nodes {\n      ... on CartLine {\n        ...CartLine\n      }\n    }\n    pageInfo {\n      ...PageInfo\n    }\n    totalCount\n  }\n  buyerIdentity {\n    ...CartBuyerIdentity\n  }\n  discountCodes {\n    ...CartDiscountCode\n  }\n  discountAllocations {\n    ...CartDiscountAllocation\n  }\n  note\n  attributes {\n    key\n    value\n  }\n  email\n  phone\n  shippingAddress {\n    ...MailingAddress\n  }\n  billingAddress {\n    ...MailingAddress\n  }\n  selectedShippingMethod {\n    ...CartShippingMethod\n  }\n  selectedPaymentMethod {\n    ...CartSelectedPaymentMethod\n  }\n  appliedGiftCards {\n    ...CartAppliedGiftCard\n  }\n  requiresShipping\n  createdAt\n  updatedAt\n  status\n  completedOrder {\n    id\n    orderNumber\n    accessToken\n    status\n    paymentStatus\n    fulfillmentStatus\n  }\n}",
       "onType": "Cart"
     },
     {
@@ -2161,12 +2196,12 @@
       "name": "CartAppliedGiftCard",
       "kind": "fragment",
       "section": "Cart",
-      "description": "Gift card applied to a cart — masked code for display, last 4 chars for matching, applied amount + remaining balance. Balance NIE debited yet — actual deduction atomically at `cartComplete`.",
+      "description": "Gift card applied to a cart — `id` is the stable handle the storefront passes to `cartRemoveGiftCard` (no need to keep the raw code around). Plus masked code for display, last 4 chars for matching, applied amount + remaining balance. Balance NIE debited yet — actual deduction atomically at `cartComplete`.",
       "variables": [],
       "fragmentRefs": [
         "Money"
       ],
-      "body": "fragment CartAppliedGiftCard on CartAppliedGiftCard {\n  maskedCode\n  lastCharacters\n  appliedAmount {\n    ...Money\n  }\n  remainingBalance {\n    ...Money\n  }\n}",
+      "body": "fragment CartAppliedGiftCard on CartAppliedGiftCard {\n  id\n  maskedCode\n  lastCharacters\n  appliedAmount {\n    ...Money\n  }\n  remainingBalance {\n    ...Money\n  }\n}",
       "onType": "CartAppliedGiftCard"
     },
     {
@@ -2282,6 +2317,18 @@
       "body": "fragment Shop on Shop {\n  id\n  name\n  description\n  primaryDomain {\n    host\n    url\n    isSslEnabled\n  }\n  currencyCode\n  supportedCurrencies\n  paymentCurrencies\n  defaultLanguage\n  supportedLanguages\n  logo {\n    ...Image\n  }\n  contactEmail\n  contactPhone\n  address {\n    ...ShopAddress\n  }\n  businessHours {\n    ...BusinessHour\n  }\n  branding {\n    ...ShopBranding\n  }\n  botProtection {\n    ...BotProtection\n  }\n}",
       "onType": "Shop"
     },
+    {
+      "name": "ShopConfigFields",
+      "kind": "fragment",
+      "section": "Shop",
+      "description": "Minimal Shop fields consumed by `<StorefrontProvider shopData={...}>` from `@doswiftly/storefront-sdk/react`. Spread this in your `shop` query to get a response shape that matches the SDK `ShopConfig` interface 1:1 — no manual field selection, no drift when the SDK adds optional fields. Use the larger `Shop` fragment when you also need branding / contact / business hours for your UI.",
+      "variables": [],
+      "fragmentRefs": [
+        "BotProtection"
+      ],
+      "body": "fragment ShopConfigFields on Shop {\n  currencyCode\n  supportedCurrencies\n  localeToCurrencyMap {\n    locale\n    currency\n  }\n  defaultLanguage\n  supportedLanguages\n  botProtection {\n    ...BotProtection\n  }\n}",
+      "onType": "Shop"
+    },
     {
       "name": "PaymentMethod",
       "kind": "fragment",
@@ -2498,7 +2545,7 @@
       "name": "AvailableShippingMethod",
       "kind": "fragment",
       "section": "Shipping Methods",
-      "description": "One shipping method offered for the destination + cart — id, name, carrier, price, free-shipping progress, estimated delivery, sort order. Spread on the checkout shipping step.",
+      "description": "One shipping method offered for the destination + cart — id, name, carrier, price, free-shipping progress, estimated delivery, sort order. `deliveryType` signals whether to render a pickup-point / locker picker (`HOME` vs `PICKUP_POINT` / `LOCKER`) so the storefront does not have to infer it from the method name. Spread on the checkout shipping step.",
       "variables": [],
       "fragmentRefs": [
         "DeliveryEstimate",
@@ -2506,7 +2553,7 @@
         "Money",
         "ShippingCarrier"
       ],
-      "body": "fragment AvailableShippingMethod on AvailableShippingMethod {\n  id\n  name\n  description\n  carrier {\n    ...ShippingCarrier\n  }\n  price {\n    ...Money\n  }\n  isFree\n  estimatedDelivery {\n    ...DeliveryEstimate\n  }\n  freeShippingProgress {\n    ...FreeShippingProgress\n  }\n  sortOrder\n}",
+      "body": "fragment AvailableShippingMethod on AvailableShippingMethod {\n  id\n  name\n  description\n  deliveryType\n  carrier {\n    ...ShippingCarrier\n  }\n  price {\n    ...Money\n  }\n  isFree\n  estimatedDelivery {\n    ...DeliveryEstimate\n  }\n  freeShippingProgress {\n    ...FreeShippingProgress\n  }\n  sortOrder\n}",
       "onType": "AvailableShippingMethod"
     },
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doswiftly/storefront-operations",
-  "version": "14.0.0",
+  "version": "16.0.0",
   "description": "GraphQL operations for DoSwiftly Storefront - SSOT from backend",
   "homepage": "https://doswiftly.pl",
   "publishConfig": {

package/queries.graphql

@@ -14,6 +14,13 @@ query Shop {
   }
 }
 
+# Minimal Shop payload for `<StorefrontProvider shopData={...}>` from `@doswiftly/storefront-sdk/react`. Returns exactly the fields the SDK's `ShopConfig` interface declares — currency setup (with `localeToCurrencyMap` for browser-locale-based currency detection), language setup, and bot protection. Cache for the session; refetch when the merchant updates currency / language settings or you want to pick up new bot-protection rules.
+query ShopConfig {
+  shop {
+    ...ShopConfigFields
+  }
+}
+
 # ============================================
 # Products
 # ============================================
@@ -224,6 +231,21 @@ query CustomerProfile {
   }
 }
 
+# Authenticated customer's saved address book — used on checkout to let the buyer pick a previously-used shipping / billing address instead of typing it. Each entry carries B2B invoicing fields (`taxId`, `vatNumber`) and the `isDefault` flag so the same list serves both as the shipping picker and as the billing/invoice picker. Returns up to 50 addresses (Relay Connection — buyers rarely keep more); for the unauthenticated case the connection is empty (no error). The default address is also surfaced as `Customer.defaultAddress`.
+query CustomerAddresses {
+  customer {
+    addresses(first: 50) {
+      nodes {
+        ...MailingAddress
+      }
+      pageInfo {
+        ...PageInfo
+      }
+      totalCount
+    }
+  }
+}
+
 # Single order by `orderId`. Returns only orders that belong to the authenticated customer (cross-customer access returns null, not an error). Much cheaper than fetching the full `Customer` payload to access one order. Use on the order detail page.
 query CustomerOrder($orderId: ID!) {
   customerOrder(orderId: $orderId) {