@vtex/faststore 0.0.5 → 0.0.7

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.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`
+namespace, `ClientProfileFormRoot`, `ClientProfileFormFieldset`, the `EmailField`, `FirstNameField`,
+`LastNameField`, `PhoneField`, `DocumentField`, `NewsletterCheckbox` and `SavePersonalDataCheckbox`
+parts, `ClientProfileFormError`, `ClientProfileFormConfirmation`, `ClientProfileFormSubmitButton`, and
+their `*Definition` and `*Props` exports, plus `ClientProfileFormData`. `ClientProfileFieldset` and
+`ClientPreferencesFieldset` replace them, each with its own controls
+(`ClientProfileFirstNameControl`, `ClientProfileLastNameControl`, `ClientProfileFieldsetPhoneControl`,
+`ClientProfileDocumentControl`, `ClientPreferencesNewsletterControl`,
+`ClientPreferencesSavePersonalDataControl`), skeletons and `*Data` types. An author who composed the
+old form must move to the fieldsets and compose a `Form` around them.
+
+`DocumentField` drops its `required` prop. `requirement: 'mandatory' | 'optional'` replaces it.
+Requiredness is now a baseline that an author may raise, never lower. An unset phone requirement
+raises nothing, so a phone field that used to demand a value no longer does. `FormRegistryContext`
+is no longer exported from the barrel.
+
+**Changed in `./components`.** `DocumentFieldProps` and `CheckboxRootProps` now extend
+`ComponentPropsWithRef`, so `DocumentField` and `CheckboxRoot` accept the standard element props.
+`DocumentField` returns `ReactNode` instead of `JSX.Element`.
+
+**Added to `./components`.**
+
+- Forms: `Form`, `FormRoot`, `FormSubmit`, `FormReset`, `FormClear`, `FormError` and
+  `FormEnterSubmit`. They come with `FieldBinding`, `FieldCheckbox`, `FieldSelect` and its parts,
+  `FieldRule`, `FieldContract` and the field registry types. A fieldset composes an entity form from
+  these.
+- `AlertDialog`: root, trigger, portal, backdrop, viewport, popup, title, description and close.
+- The credit-card payment surface: `CardEntry`, `CardholderDocument`, `BillingAddress`,
+  `Installments` and `InstallmentsSelect`, `PaymentMethodList`, `PaymentMethodBadges`,
+  `AcceptedPaymentMethodBadges` and `OrderPlacedPaymentSummary`, with their validators
+  (`isValidLuhn`, `isExpirationFormatValid`, `isExpirationInFuture`) and error codes.
+- `AddressSummaryName`, `AddressSummaryCountry` and `AddressSummaryField`.
+
+**Added to `./client`.** `AnalyticsDestinationProvider` sets the analytics destination for its
+children. Three message keys join the catalog: `fs/form.clear`, `fs/form.reset` and `fs/form.submit`.
+
+`.` and `./graphql` have no signature change.
+
+In the Internal set, `@vtex/sukima` now runs content preflight across every active locale, names the
+locales it checked when preflight fails, and reports a non-object Data Plane entry. It fills a
+missing title template from `seo.titleTemplate`. `@vtex/fs-storefront-api-core` adds the catalog
+route equivalence contract and picks the representative SKU for product routes.
+
 ## 0.0.5
 
 `./components` adds `AccountAccessGate`, the single access decision for the account pages, placed

package/dist/actions.json

@@ -1,4 +1,41 @@
 {
+  "analytics": {
+    "namespace": "analytics",
+    "description": "Dispatcher-flavor namespace that pushes standard add_payment_info / purchase events to window.dataLayer. Never touches the Apollo cache.",
+    "provider": {
+      "name": "AnalyticsActionProvider",
+      "importPath": "@vtex/faststore/internal/client"
+    },
+    "methods": {
+      "track": {
+        "description": "Push a standard analytics event (add_payment_info | purchase) to window.dataLayer. Fire-and-forget; never throws.",
+        "payload": [
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "currencyCode",
+            "type": "string"
+          },
+          {
+            "name": "amount",
+            "type": "number"
+          },
+          {
+            "name": "paymentType",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "transactionId",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      }
+    }
+  },
   "cart": {
     "namespace": "cart",
     "description": "Mutation-backed writes against the current cart (consolidates useCartMutations / CartRoot).",
@@ -195,6 +232,150 @@
       }
     }
   },
+  "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).",
+    "provider": {
+      "name": "PaymentActionProvider",
+      "importPath": "@vtex/faststore/internal/client"
+    },
+    "methods": {
+      "setMethod": {
+        "description": "Select a payment method, optionally identifying a new card by BIN or a saved card by account (async/pessimistic). Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "methodId",
+            "type": "string"
+          },
+          {
+            "name": "bin",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "accountId",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      },
+      "setInstallments": {
+        "description": "Select an installment count for the current method (async/pessimistic). The response recomputes the cart total with interest. Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "count",
+            "type": "number"
+          }
+        ]
+      },
+      "setBillingAddress": {
+        "description": "Persist the billing address, or fall back to the delivery address with sameAsDelivery (async/pessimistic). Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "sameAsDelivery",
+            "type": "boolean"
+          },
+          {
+            "name": "addressType",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "postalCode",
+            "type": "string",
+            "optional": true
+          },
+          {
+            "name": "country",
+            "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": "reference",
+            "type": "string",
+            "optional": true
+          }
+        ]
+      },
+      "saveCard": {
+        "description": "Record the data-storage consent a saved card requires, reusing the existing clientPreferencesUpdate write. Does not itself save the card — the save flag and label travel on sendPayments.",
+        "payload": [
+          {
+            "name": "enabled",
+            "type": "boolean"
+          }
+        ]
+      },
+      "startTransaction": {
+        "description": "Open a VTEX transaction from the persisted payment selection. Takes no arguments; resolves the transaction identifiers the gateway call needs.",
+        "payload": []
+      },
+      "gatewayCallback": {
+        "description": "Finalize the transaction after the gateway accepted the card. Resolves the payload userErrors.",
+        "payload": [
+          {
+            "name": "orderGroup",
+            "type": "string"
+          }
+        ]
+      },
+      "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).",
+        "payload": [
+          {
+            "name": "gatewayUrl",
+            "type": "string"
+          },
+          {
+            "name": "transactionId",
+            "type": "string"
+          },
+          {
+            "name": "merchantName",
+            "type": "string"
+          },
+          {
+            "name": "orderGroup",
+            "type": "string"
+          },
+          {
+            "name": "userProfileId",
+            "type": "string"
+          }
+        ]
+      }
+    }
+  },
   "region": {
     "namespace": "region",
     "description": "Mutation-backed writes against the shopper's active region (postal code).",