@vtex/faststore 0.0.8 → 0.0.11

package/CHANGELOG.md

@@ -4,6 +4,107 @@ 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.11
+
+**Breaking in `./client`: no `react-intl`.** `FormattedMessage`, `useIntl`, `MessageId` and `Messages`
+are gone, and so are the bundled message catalogs. Component text now comes from content message
+fields. `./client` gains `MessageFormatter` and `useMessageFormatter` to format one.
+
+**Breaking in `./components`: the access-code sign-in is rebuilt.** `AccessCodeEmailControl`,
+`AccessCodeEmailControlDefinition`, `AccessCodeEmailControlProps`, `AccessCodeSignInSlice`,
+`SignInFormSlice`, `SignInFormMessages`, `mapSessionErrorMessage`, `LABEL_DEFAULT` and
+`NOTICE_DEFAULT` are removed. Use `AccessCodeCorrectEmailControl`, `AccessCodeResendControl`,
+`AccessCodeSentNotice` and the new `*Content` parts. A shopper can now sign in with a password or an
+emailed access code from one shared email field.
+
+**Breaking in `./cli` and `./graphql`: identity comes from the manifests.** `buildSubgraph` and
+`printSubgraphSdl` take `vendor` as a second argument. `SubgraphDefinition` no longer has `vendor` or
+`secrets`; both are read from the extension's manifest. `validateExtension`, `BuildOptions`,
+`DevWatchOptions` and `RunDevOptions` accept an optional `identity`. New in `./cli`: `AssetIdentity`,
+`readAssetIdentity`, `vendorPrefixToken` and `ValidateOptions`.
+
+**Changed in `./components`: copy is content.** About 190 `*Content` components and the `*Content`
+props that carry their messages are added across the cart, checkout, account, address book, carousel,
+breadcrumb and binding switcher. The messages are ICU messages with typed arguments, and
+`createMessageFormatter` is exported from `./components`. Components no longer ship default copy.
+A store must supply the message fields. `sukima` checks them at generation, warns on a locale with
+no catalog, and fills absent fields when `cms publish` reuses an entry.
+
+**Added in `.`: the message vocabulary.** `MessageArguments`, `MessageArgumentSchema`,
+`MessageArgumentsSchema`, `MessageFieldName`, `MessageLocaleProp` and `MessageTagName`. A content
+type property gains `messageArguments`, `messageTags`, `messageExample`, `messageSource` and
+`messageOptional`. `searchTerm` and `canonicalFor` are new optional page fields.
+
+**Widened in `.`: payment.** `PaymentActions.gatewayCallback` takes an optional second argument,
+`{ acceptChallenges }`. The start-transaction and callback results gain `orderNodeId`, and the
+callback result gains `redirectUrl`. They pair with the `storefront-api-core` schema, where
+`Query.order` now takes `id: ID!` and `PaymentInstallment.total` is `totalAmount`.
+
+**Added to `./components`: cart.** Unavailable lines sit in their own section
+(`CartAvailableItems`, `CartUnavailableItems`, `CartAllUnavailable`), and a line explains a quantity
+the platform lowered. My Account gains an order documents view with invoices and tracking links.
+
+`./graphql` otherwise changes only as described under `./cli`.
+
+## 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

package/README.md

@@ -59,7 +59,6 @@ importing it:
 | `@vtex/faststore/catalog.json` | every component's editor metadata and prop schema |
 | `@vtex/faststore/actions.json` | the declared actions |
 | `@vtex/faststore/content-types.json` | the declared content types |
-| `@vtex/faststore/message-locales.json` | the shipped message locales |
 | `@vtex/faststore/tailwind.css` | the Tailwind theme the components style against |
 
 These carry no snapshot. Treat their shape as unstable while the package is pre-1.0.

package/dist/actions.json

@@ -256,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": []
       }
     }
   },
@@ -359,6 +363,25 @@
       }
     }
   },
+  "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.",
@@ -411,7 +434,7 @@
         ]
       },
       "setInstallments": {
-        "description": "Select an installment count for the current method (async/pessimistic). The response recomputes the cart total with interest. Resolves the payload userErrors.",
+        "description": "Select an installment count for the current method (async/pessimistic). The response carries the cart, whose total is the greater of the order form value and the selected payment value, so it includes the interest of the picked tier. Resolves the payload userErrors.",
         "payload": [
           {
             "name": "count",
@@ -497,6 +520,11 @@
           {
             "name": "orderGroup",
             "type": "string"
+          },
+          {
+            "name": "acceptChallenges",
+            "type": "boolean",
+            "optional": true
           }
         ]
       },
@@ -546,6 +574,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).",