@vtex/faststore 0.0.7 → 0.0.10

package/CHANGELOG.md

@@ -4,6 +4,108 @@ Every published version of `@vtex/faststore` has a section here. From `0.0.2` on
 written when its release pull request opens, and reviewed alongside the API delta that justifies the
 version.
 
+## 0.0.10
+
+`0.0.9` was never published: its version and changelog landed with the Cart feature, outside a
+release pull request. This is the first release after `0.0.8`, and it carries that change too.
+
+**Breaking: cart line writes.** The `cartItemRemove`, `cartItemsRemove`, `cartItemQuantityIncrease`
+and `cartItemQuantityDecrease` mutations now take `lineId` (`lineIds` for `cartItemsRemove`) instead
+of `variantId` (`variantIds`), so a line is addressed by `CartItem.lineId` and two lines of one SKU no
+longer resolve to the first one. `@vtex/faststore` 0.0.2 to 0.0.8 still send `variantId`, so they
+fail on those four writes against the API once it ships. 0.0.10 is the release that fixes it: the
+cart actions read each line's `lineId` and send it. `cartItemAdd` is unchanged.
+
+**Changed in `./client` and `./components`.** A money `amount` is a `string`, not a `number`:
+`ShippingOption.price` and `listPrice`, and every price, total and discount value in the cart types.
+Parse it before doing arithmetic. `CartItemEntity` gains `lineId: string`.
+
+**Changed in `./components`.** `FreeShippingProgressRootProps.cartTotal` is gone; pass `itemsTotal`.
+`ToastRootProps.toast` is optional, and `ToastRoot` and `CartCount` may render nothing.
+`CartCountProps` gains `templateOne` and `CartCouponFormProps` gains `appliedMessage`.
+
+**Changed in `.` and `./components`.** `CartActions` gains `syncSalesChannel`, which moves the cart
+onto the active sales channel. A custom implementation of the whole `CartActions` type must add it;
+an override through `ComponentActions.cart` does not, since that field is partial.
+
+**Widened in `.`.** `FetchStrategy` gains `'lazy-on-mount'`: the client fetches the component's data
+when it mounts, outside the page query. `ShippingAddressInput.recipientName` is optional.
+`ComponentActions` gains `locale` and `savedCard`, and `LocaleActions` is exported.
+
+**Added to `./components`.** Three groups of components.
+- Cart: the destination block (`CartDestination*`, `useCartDestination`), coupon states
+  (`CartCouponEmpty`, `CartCouponSavings`, `CartCouponUnmatched`), `ClearCartButton`,
+  `ProductShelfOnMountRoot`, `ToastList` and `useOptionalToast`.
+- Saved cards in My Account: the `AccountSavedCards*` and `AccountSavedCard*` families with their
+  hooks, and the `CardSummary*` particle with `cardNetworkIcon`.
+- `BindingSwitcher`, which moves the shopper between the store's bindings, with
+  `bindingSwitcherOptions`.
+
+**Added to `./client`.** The message catalog gains `fs/card.ending-in` and the `fs/saved-cards.*` ids.
+
+`./graphql` and `./cli` have no change.
+
+**Changed in `./tailwind.css`.** This is not a snapshotted entry. The theme's `--color-brand` is now
+`--color-primary`, and `--color-brand-light` is gone, so the `brand` and `brand-light` utilities no
+longer exist. A store's theme variables follow the Foundation names: `--color-primary`,
+`--color-secondary`, `--color-neutral`, `--color-surface` and `--font-body` replace `--color-brand`,
+`--color-accent`, `--color-ink` and `--font-family`. `--color-muted` is dropped. No old name has an
+alias.
+
+Outside the four entries, this release also carries the Foundation in `sukima`: a store writes one
+version 2 `foundation.json` instead of `global.json`. The CLI takes `--foundation` instead of
+`--global`, and `generate`, `watch` and `dev` take `--account`. The napi option `globalSchemaPath` is
+now `foundationPath`. `generateApp`, `validateProject` and the compilers' `update` take a
+`foundation` instead of a `globalSchema`. Every compile entry point takes an optional `account`.
+The compiler loads only `version: 2`, refuses a key the format does not define, and points a
+typography use at its `next/font` variable when `fonts` loads it under the same role. It
+also carries decoded route params in generated pages, Global bindings inlined in element props, CMS
+publish seeding of composite entries, and the `cartSalesChannelSync` mutation and safer VTEX client
+retries in `storefront-api-core`.
+
+## 0.0.8
+
+**Removed from `./components`.** `OrderPlacedPaymentSummaryData.label` and
+`OrderPlacedPaymentSummaryProps.multiSellerNotice` are gone. A store that read either one must stop.
+
+**Changed in `.` and `./components`.** `PaymentActions.sendPayments` now returns
+`Promise<PaymentGatewayResult>`. It returned `Promise<readonly PaymentUserError[]>`. A custom
+implementation of `sendPayments` must return the new type.
+
+**Changed in `./cli`.** `buildExtension`, `runDev` and `runDevWatch` no longer take a `host`
+argument, and `RunnerHost` and `StorefrontTemplate` are removed. The entry now exports the storefront
+kind provider (`KindProvider`, `kinds`, `skills`, `templates`) and the extension lint and validation
+helpers.
+
+**Widened in `.`, `./client` and `./components`.** A link prop now accepts `PageRef | string`:
+`Logo.href`, `PlaceOrder.successHref`, `CartGoCheckout.href`, `CartRedirectOnAdd.href`,
+`AccountAccessGateNotice.signInHref`, and the link types of the navigation, footer, incentive and
+account-menu components. Existing string values keep working. `PropType` gains `'link'` and
+`PropSchemaField` gains `fills`, so a schema can declare a required page and the route params a
+component supplies. `ComponentActions` gains `address` and `order`.
+
+**Added to `./client` and `.`.** The navigation SDK: `StorefrontLink`, `useStorefrontRoute`,
+`useStorefrontNavigation` and `useStorefrontSearchParams`, with `PageRef`, `RouteMap` and
+`resolveStorefrontHref`. A component reads the current page from `useStorefrontRoute().page`
+instead of comparing a path. The client message catalog gains the `fs/address*`, `fs/order*` and
+`fs/toast*` ids.
+
+**Added to `./components`.** Three groups of components.
+- The My Account address book: the `AccountAddress*` family and `AddressCountry*`, with the
+  `useAccountAddressBook` and `useAccountAddressForm` hooks and address actions on `.`.
+- Orders: the order list (`OrderList*`, `OrderStatus`), the order details page
+  (`OrderDetails*`, `OrderProgress`, `OrderDelivery*`, `OrderPayment`, `OrderSummary`),
+  order cancel (`OrderCancel*`, `OrderActions`) and the `CopyText` particle. The order-placed page
+  gains deliveries, totals and customer rows.
+- Payments: `PaymentSection` takes the store country and a country list. The card document
+  check covers `SSN`, `SIN` and `RFC` next to `CPF`. `CardEntry`, `BillingAddress` and `PlaceOrder`
+  gain messages for an unaccepted card network and an invalid postal code.
+
+`./graphql` has no change.
+
+Outside the four entries, this release also carries the not-found page generation in `sukima`, the
+S3 supergraph store and request logging in `kramer`, and the standalone generated application.
+
 ## 0.0.7
 
 **Removed from `./components`.** The `ProductShelf` variables API is gone: `buildProductShelfVariables`,

package/dist/actions.json

@@ -1,4 +1,131 @@
 {
+  "address": {
+    "namespace": "address",
+    "description": "Mutation-backed writes against the shopper's saved addresses (create, update, remove).",
+    "provider": {
+      "name": "AddressActionProvider",
+      "importPath": "@vtex/faststore/internal/client"
+    },
+    "methods": {
+      "create": {
+        "description": "Save a new address and add it to the cached address book (async/pessimistic). Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "country",
+            "type": "string"
+          },
+          {
+            "name": "recipientName",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "street",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "number",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "complement",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "neighborhood",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "city",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "state",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "postalCode",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "reference",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      },
+      "update": {
+        "description": "Change a saved address (async/pessimistic). Omitted fields are kept; an empty string erases. Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "id",
+            "type": "string"
+          },
+          {
+            "name": "recipientName",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "street",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "number",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "complement",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "neighborhood",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "city",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "state",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "postalCode",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "reference",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      },
+      "remove": {
+        "description": "Remove a saved address once the server confirms (async/pessimistic). Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "id",
+            "type": "string"
+          }
+        ]
+      }
+    }
+  },
   "analytics": {
     "namespace": "analytics",
     "description": "Dispatcher-flavor namespace that pushes standard add_payment_info / purchase events to window.dataLayer. Never touches the Apollo cache.",
@@ -129,6 +256,10 @@
       "validate": {
         "description": "Re-check the active cart against the platform and adopt corrected availability (async, read-only upstream).",
         "payload": []
+      },
+      "syncSalesChannel": {
+        "description": "Moves the active cart onto the request's sales channel and reconciles its locale.",
+        "payload": []
       }
     }
   },
@@ -232,6 +363,49 @@
       }
     }
   },
+  "locale": {
+    "namespace": "locale",
+    "description": "Switches the whole binding (locale, currency, sales channel) by a document navigation to the equivalent URL, or to the destination home with a notice.",
+    "provider": {
+      "name": "LocaleActionProvider",
+      "importPath": "@vtex/faststore/internal/client"
+    },
+    "methods": {
+      "set": {
+        "description": "Switch to another binding: navigates to the equivalent URL of the current page, or to the destination home with fs_notice=no-equivalent.",
+        "payload": [
+          {
+            "name": "bindingId",
+            "type": "string"
+          }
+        ]
+      }
+    }
+  },
+  "order": {
+    "namespace": "order",
+    "description": "Mutation-backed cancellation of one of the shopper's orders.",
+    "provider": {
+      "name": "OrderActionProvider",
+      "importPath": "@vtex/faststore/internal/client"
+    },
+    "methods": {
+      "cancel": {
+        "description": "Request cancellation of one order (async/pessimistic). Resolves the payload, including a null order after an accepted write.",
+        "payload": [
+          {
+            "name": "id",
+            "type": "string"
+          },
+          {
+            "name": "reason",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      }
+    }
+  },
   "payment": {
     "namespace": "payment",
     "description": "Mutation-backed payment writes against the VTEX orderForm paymentData/invoiceData, plus a façade that posts card data directly to the payment gateway (never through our GraphQL layer or cache).",
@@ -350,7 +524,7 @@
         ]
       },
       "sendPayments": {
-        "description": "Façade: post the card directly from the browser to the payment gateway. Issues no GraphQL operation and writes nothing to the cache. The card number and CVV are runtime-only arguments and are deliberately absent from this payload — they are never a bindable field (RFC D13).",
+        "description": "Façade: post the card directly from the browser to the payment gateway. Issues no GraphQL operation and writes nothing to the cache. Resolves { reachedGateway, userErrors }: reachedGateway is false only when no request was issued. The card number and CVV are runtime-only arguments and are deliberately absent from this payload — they are never a bindable field (RFC D13).",
         "payload": [
           {
             "name": "gatewayUrl",
@@ -395,6 +569,25 @@
       }
     }
   },
+  "savedCard": {
+    "namespace": "savedCard",
+    "description": "Mutation-backed writes against the signed-in shopper's saved cards.",
+    "provider": {
+      "name": "SavedCardActionProvider",
+      "importPath": "@vtex/faststore/internal/client"
+    },
+    "methods": {
+      "remove": {
+        "description": "Remove one saved card (async strategy). The row stays until the server answers.",
+        "payload": [
+          {
+            "name": "id",
+            "type": "string"
+          }
+        ]
+      }
+    }
+  },
   "session": {
     "namespace": "session",
     "description": "Mutation-backed authentication writes against the VTEX ID session (login, access code, logout).",