@vtex/faststore 0.0.6 → 0.0.8

package/CHANGELOG.md

@@ -4,6 +4,105 @@ 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.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`,
+`ProductsFilterInput` and `ProductShelfVariables`. `ProductShelfConfig` loses `itemsPerPage` and
+`specifications`, and `first`, `sort` and `availableOnly` are now required on it.
+`ProductShelfContextValue.variables` is now `config`. The `specifications` filter has no replacement,
+so a shelf can no longer filter by custom attributes. `ProductShelfRootProps` takes
+`Partial<ProductShelfConfig>` and an optional `itemsPerPage`, so every prop of `ProductShelfRoot` stays
+optional.
+
+**Changed in `./components`.** `ProductShelfRoot` reads its configuration from the store's content first.
+The `ProductShelfContent` content type, the `$content` prop and `PRODUCT_SHELF_SORT_MAP` carry it. The
+merchant's value wins per field, and the prop is the default. A store with no `cms` binding sees no
+change.
+
+`AccountEntryPoint` now links to `/pvt/account`, and the default sections of `AccountMenu` link to
+`/pvt/profile`, `/pvt/orders`, `/pvt/address`, `/pvt/payments` and `/pvt/security`. They pointed under
+`/account` before. No signature changes, but a store that authored its account pages under `account`
+must move them under `pvt`, or these links point at routes that do not exist.
+
+**Added to `./components`.** `AccountMenu` gains the `IndexRedirect` and `SignOut` parts, each with its
+`*Definition`, `*Props` and content type (`AccountMenuIndexRedirectContent`,
+`AccountMenuSignOutContent`). `AccountMenuIdentity` renders the signed-in shopper's identity from
+`AccountMenuIdentityData` (`id`, `firstName`, `lastName`, `email`), with `AccountMenuIdentitySkeleton`
+and its `*Definition` and `*Props` exports. `Avatar` joins the particles, with `AvatarDefinition` and
+`AvatarProps`.
+
+**Added to `.` and `./components`.** `ComponentDefinition` gains two optional fields. `hardened: true`
+is the author's claim that a component is hardened for card data; nothing verifies it. `variables`
+binds the variables of the component's fragment to its content or its props. `VariableBinding` and
+`VariableBindings` are new exports of `.`. `CardEntry`, `PaymentSectionController`,
+`PaymentSectionRoot` and `SavedCardCvvField` carry the marker.
+
+**Added to `./cli`.** The entry is new. It folds `@vtex/fs-graphql` into `@vtex/faststore`
+and exports `buildExtension`, `runDev`, `runDevWatch`, `validateExtension`, `lintExtension`,
+`buildSubgraph`, `printSubgraphSdl`, `resolveDeclarationEntry`, `templates`, `CompileError`,
+`ValidationGateError` and their types. `typescript` becomes an optional peer dependency. Only the
+capability lint and the type-check in `buildExtension` need it. Without it, those two fail with an
+error that names the package.
+
+`./client` and `./graphql` have no signature change. `./internal/server` adds `readServerSession` and
+`resolveSignInHref`, and `./internal/content` adds `readContentItem`. Only generated code calls them.
+
+In the Internal set, `@vtex/sukima` implements the page model. A page document now declares its
+access, discovery, bindings and aliases, content kind, standard name and variants. From them the
+compiler derives routing, gates `pvt` pages behind a server session read, emits Article and FAQPage
+JSON-LD from the content kind, writes a page manifest and exposes a rule catalog to the store editor.
+It reads a page's item by slug and binds `$content` on content-form pages, and it retires
+`dataSources` with coded diagnostics. Fragment variables come from content or props, which is what
+the `ProductShelfRoot` change above relies on. `global.json` takes a `responseHeaders` block that the
+generated app writes into its `next.config.ts`.
+
+Three checks are new, and each can fail a build that passed before: a card-bearing component placed
+without the `hardened` marker, a store-authored SVG icon that is unsafe, and a store-authored prop
+name that is not valid in the generated TSX.
+
 ## 0.0.6
 
 **Removed from `./components`.** The `ClientProfileForm` family is gone: the `ClientProfileForm`

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.",
@@ -232,6 +359,30 @@
       }
     }
   },
+  "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 +501,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",