@vtex/faststore 0.0.10 → 0.0.11

package/dist/schema.graphql

@@ -326,9 +326,10 @@ extend type Query {
 
 extend type Query {
   """
-  Resolve the active cart from the request context (x-order-form-id header,
-  then cookie). When no cart context is present, a new cart is created and
-  the x-order-form-id cookie is set on the response.
+  Resolve the active cart from the request context: the order form id in the
+  `checkout.vtex.com=__ofid=<id>` cookie. When no cart context is present, a
+  new cart is created and the `checkout.vtex.com` cookie that names it is set
+  on the response.
   """
   cart: Cart!
 }
@@ -344,8 +345,8 @@ extend type Query {
     input: ShippingSimulateInput!
   ): ShippingSimulationPayload!
   """
-  Simulate shipping options for the entire active cart. Reads the cart from the
-  x-order-form-id context and simulates all of its items against the
+  Simulate shipping options for the entire active cart. Reads the cart named by the
+  `checkout.vtex.com` cookie and simulates all of its items against the
   destination, returning the options common to every item with prices summed
   across items. Never mints a cart: absent context returns a MISSING_CART_CONTEXT
   userError.
@@ -375,8 +376,8 @@ extend type Query {
   """
   shipping: Shipping!
   """
-  Resolve the shopper's session state from the active order form (x-order-form-id
-  header, then cookie). Projects from the same order form fetch as `cart`.
+  Resolve the shopper's session state from the active order form (the one the
+  `checkout.vtex.com` cookie names). Projects from the same order form fetch as `cart`.
   """
   session: Session!
 }
@@ -390,16 +391,17 @@ extend type Query {
 
 extend type Query {
   """
-  A settled order's payment recap, keyed on the order group
-  paymentStartTransaction / paymentGatewayCallback return. Null when the
-  order group does not resolve to a settled order — never a fabricated empty
-  projection (contrast Query.payment, which always resolves).
+  A settled order's payment recap, keyed on the order's Node ID. Null when the
+  id is malformed, of another type, or does not resolve to a settled order —
+  never a fabricated empty projection (contrast Query.payment, which always
+  resolves).
   """
   order(
     """
-    The order group returned by paymentStartTransaction / paymentGatewayCallback.
+    The Relay Node ID of the order: `Order.id`, or `orderNodeId` from paymentStartTransaction /
+    paymentGatewayCallback.
     """
-    orderGroup: String!
+    id: ID!
   ): Order
 }
 
@@ -662,7 +664,7 @@ extend type Mutation {
     input: PaymentMethodSelectInput!
   ): PaymentMethodSelectPayload!
   """
-  Select an installment count for the currently-selected method. Recomputes the cart total.
+  Select an installment count for the currently-selected method. The returned cart's `total` is the greater of the order form's value and the selected payment's value.
   """
   paymentInstallmentSelect(
     """Installment count to select."""
@@ -1246,7 +1248,7 @@ type Rating {
 A curated group of products. Maps to VTEX Collection (Beta) entity.
 Collections can be used for seasonal promotions, editorial picks, etc.
 """
-type Collection implements Node {
+type Collection implements Node @cacheControl(maxAge: 300, scope: PUBLIC) {
   """Globally unique identifier."""
   id: ID!
   """Collection title."""
@@ -1812,7 +1814,13 @@ type Cart implements Node @cacheControl(maxAge: 0, scope: PRIVATE) {
   items: [CartItem!]!
   """Aggregated totals (items, shipping, discounts, etc.)."""
   totalizers: [CartTotalizer!]!
-  """Total cart value."""
+  """
+  Total cart value: the greater of the order form's value and the selected payment's value.
+  While an installment tier with interest is selected, the payment's value is the larger of
+  the two and the total includes the interest, so it matches what the transaction charges.
+  Without a selected payment it is the order form's value. Totalizer lines do not include an
+  interest line, so they may not add up to this total.
+  """
   total: Money!
   """
   Server messages from cart processing (e.g. promotions applied, stock warnings).
@@ -2307,7 +2315,7 @@ input CartCouponRemoveInput {
 
 """Error codes for cart item add operations."""
 enum CartItemAddErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The quantity must be a positive integer."""
   INVALID_QUANTITY
@@ -2321,7 +2329,7 @@ enum CartItemAddErrorCode {
 
 """Error codes for cart item remove operations."""
 enum CartItemRemoveErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The specified line was not found in the cart."""
   ITEM_NOT_FOUND
@@ -2333,7 +2341,7 @@ enum CartItemRemoveErrorCode {
 
 """Error codes for cart items batch remove operations."""
 enum CartItemsRemoveErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """None of the specified lines were found in the cart."""
   ITEM_NOT_FOUND
@@ -2347,7 +2355,7 @@ enum CartItemsRemoveErrorCode {
 
 """Error codes for cart item quantity increase operations."""
 enum CartItemQuantityIncreaseErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The quantity must be a positive integer."""
   INVALID_QUANTITY
@@ -2361,7 +2369,7 @@ enum CartItemQuantityIncreaseErrorCode {
 
 """Error codes for cart item quantity decrease operations."""
 enum CartItemQuantityDecreaseErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The quantity must be a positive integer."""
   INVALID_QUANTITY
@@ -2455,7 +2463,7 @@ type CartItemQuantityDecreasePayload {
 
 """Error codes for cart coupon apply operations."""
 enum CartCouponApplyErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -2472,7 +2480,7 @@ enum CartCouponApplyErrorCode {
 
 """Error codes for cart coupon remove operations."""
 enum CartCouponRemoveErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -2518,7 +2526,7 @@ type CartCouponRemovePayload {
 
 """Error codes for cart validation operations."""
 enum CartValidateErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -2546,7 +2554,7 @@ type CartValidatePayload {
 
 """Error codes for moving a cart onto the active sales channel."""
 enum CartSalesChannelSyncErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -2698,7 +2706,7 @@ enum ShippingSimulateErrorCode {
   """The provided seller ID is not a valid Seller Node ID."""
   INVALID_SELLER_ID
   """
-  No active cart in context: the cartShippingSimulation query requires an x-order-form-id and never mints a cart.
+  No active cart in context: the cartShippingSimulation query requires the `checkout.vtex.com` cart cookie and never mints a cart.
   """
   MISSING_CART_CONTEXT
   """
@@ -2742,8 +2750,8 @@ input ShippingSimulateInput {
 
 """
 Input for simulating shipping for the whole active cart. Carries the
-destination only; items are sourced from the cart in the x-order-form-id
-context, so there is no variant, quantity, or seller.
+destination only; items are sourced from the cart named by the
+`checkout.vtex.com` cookie, so there is no variant, quantity, or seller.
 """
 input CartShippingSimulateInput {
   """Postal code of the delivery destination."""
@@ -2832,7 +2840,7 @@ input ClientPreferencesUpdateInput {
 
 """Error codes for client profile update operations."""
 enum ClientProfileUpdateErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -2842,7 +2850,7 @@ enum ClientProfileUpdateErrorCode {
 
 """Error codes for client preferences update operations."""
 enum ClientPreferencesUpdateErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3001,7 +3009,7 @@ input ShippingAddressUpdateInput {
 
 """Error codes for shipping address update operations."""
 enum ShippingAddressUpdateErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3048,7 +3056,7 @@ input ShippingOptionSelectInput {
 
 """Error codes for shipping option select operations."""
 enum ShippingOptionSelectErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3180,7 +3188,17 @@ type PaymentMethod {
   """
   name: String!
   """
-  Payment-system group (e.g. "creditCardPaymentGroup", "debitCardPaymentGroup"). Store-configured; kept as a string, not an enum.
+  The vendor-neutral kind of this method: the closed set `PaymentType` defines. Derived
+  from `groupName`; `OTHER` covers every group that is not mapped, including store-specific
+  groups and wallets other than PayPal. Never null. Read it to decide which payment UI a
+  method gets; read `groupName` to tell two `OTHER` methods apart.
+  """
+  type: PaymentType!
+  """
+  The payment-system group exactly as the order form carries it (e.g. "creditCardPaymentGroup",
+  "custom201PaymentGroupPaymentGroup"). Store-configured and open-ended, so kept as a string, not an
+  enum. It is the gateway transport value: the Send Payments request needs this literal, and the
+  gateway rejects anything else. Prefer `type` to classify a method.
   """
   groupName: String!
   """
@@ -3217,13 +3235,26 @@ type PaymentMethodValidator {
   cvvMask: String
   """Regex validating the security-code (CVV) input. Null when unused."""
   cvvRegex: String
-  """Whether this method requires the security code (CVV)."""
+  """
+  Whether this method requires the security code (CVV). False when the order form carries no
+  validator for the method: a method with no validator, such as Cash or Bank Invoice,
+  legitimately resolves false, and this field cannot tell that from an upstream that omitted the flag.
+  """
   cvvRequired: Boolean!
-  """Whether this method requires an expiration date."""
+  """
+  Whether this method requires an expiration date. False when the order form carries no
+  validator for the method: a method with no validator, such as Cash, legitimately resolves false.
+  """
   expirationRequired: Boolean!
-  """Whether this method requires the cardholder name."""
+  """
+  Whether this method requires the cardholder name. False when the order form carries no
+  validator for the method: a method with no validator, such as Cash, legitimately resolves false.
+  """
   holderNameRequired: Boolean!
-  """Whether this method requires a billing address."""
+  """
+  Whether this method requires a billing address. False when the order form carries no
+  validator for the method: a method with no validator, such as Cash, legitimately resolves false.
+  """
   billingAddressRequired: Boolean!
   """
   Whether a cardholder document field is displayable for this method. Distinct from documentRequired.
@@ -3238,19 +3269,29 @@ type PaymentMethodValidator {
 """
 One installment tier: a specific installment count at a given per-installment
 value and total. Keyed by count within its parent PaymentInstallmentOption — a
-non-normalized value object (ADR-0012).
+non-normalized value object (ADR-0012). Field names match the catalog's
+`Installment`, so one selection reads either; nullability of `interestRate` and
+`interestFree` differs by design.
 """
 type PaymentInstallment {
   """Number of installments (1 = single payment, no interest)."""
   count: Int!
   """Amount per installment."""
   value: Money!
-  """Total amount across all installments, including any interest."""
-  total: Money!
+  """
+  The whole-plan amount: the total across all installments, including any interest.
+  """
+  totalAmount: Money!
   """
   Interest rate in hundredths of a percent, exactly as the VTEX order form carries it (100 = 1%; 0 = interest-free).
+  Null when the order form did not say what the rate is — which is not the same as 0 (interest-free).
   """
-  interestRate: Float!
+  interestRate: Float
+  """
+  Whether this tier is interest-free: true when the rate is 0, false for any other rate. Null exactly
+  when `interestRate` is null. The synthesized `count: 1` tier is 0 and true, a stated fact.
+  """
+  interestFree: Boolean
 }
 
 """
@@ -3293,20 +3334,31 @@ type SavedCard @cacheControl(maxAge: 0, scope: PRIVATE) {
   The saved card's payment-system id (PaymentMethod.id), for cross-referencing validator config and installment options.
   """
   methodId: String!
-  """Card network / issuer display name (e.g. "Visa")."""
+  """
+  Card network / issuer display name (e.g. "Visa"). An empty string when the order form carries no
+  network name for the card: nothing to show.
+  """
   network: String!
-  """Last four digits of the card number."""
+  """
+  Last four digits of the card number. An empty string when the order form carries no card number
+  for the account: nothing to show.
+  """
   lastFourDigits: String!
-  """BIN of the saved card, for installment-option lookup by network."""
+  """
+  BIN of the saved card, for installment-option lookup by network. An empty string when the order
+  form carries no BIN for the account: nothing to look up.
+  """
   bin: String!
   """Shopper-assigned custom label, when set."""
   label: String
   """
-  Whether the card is expired. Expired cards are still returned; non-selectable is a UI concern downstream.
+  Whether the card is expired. Expired cards are still returned. Fails closed: true when the
+  order form does not report the expiry, so a card of unknown expiry is never offered as usable.
   """
   expired: Boolean!
   """
-  Whether completing payment with this card requires the shopper to enter the CVV.
+  Whether completing payment with this card requires the shopper to enter the CVV. True is the
+  default: it is what the field resolves to when the order form omits `useCvvForAuthorization`.
   """
   cvvRequired: Boolean!
 }
@@ -3323,7 +3375,9 @@ input PaymentMethodSelectInput {
   """The method to select (PaymentMethod.id)."""
   methodId: String!
   """
-  A newly-entered card's BIN, once detected. Omit for a saved card or a non-card method.
+  A newly-entered card's BIN, once the full 8 digits are known: omit it, send null or "" until then.
+  Anything else is rejected with INVALID_BIN_FORMAT. With an accountId, the saved card's own BIN (1 to 8
+  digits) may be restated. Omit for a non-card method.
   """
   bin: String
   """
@@ -3334,7 +3388,7 @@ input PaymentMethodSelectInput {
 
 """Error codes for the paymentMethodSelect mutation."""
 enum PaymentMethodSelectErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3345,7 +3399,8 @@ enum PaymentMethodSelectErrorCode {
   """The bin does not match the BIN of the saved card named by accountId."""
   MISMATCHED_BIN_FOR_SAVED_CARD
   """
-  The bin is not 1 to 8 numeric digits — a BIN identifies an issuer range, never a card number.
+  The bin is not in an accepted format — a BIN identifies an issuer range, never a card number. A new
+  card (no accountId) carries no bin or exactly 8 digits; with an accountId, a bin is 1 to 8 digits.
   """
   INVALID_BIN_FORMAT
   """
@@ -3386,7 +3441,7 @@ input PaymentInstallmentSelectInput {
 
 """Error codes for the paymentInstallmentSelect mutation."""
 enum PaymentInstallmentSelectErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3417,7 +3472,7 @@ type PaymentInstallmentSelectPayload {
   """The updated payment state, or null if errors occurred."""
   payment: Payment
   """
-  The recomputed cart, or null if errors occurred. Carries the order total with any installment interest applied.
+  The updated cart, or null if errors occurred. Its `total` is the greater of the order form's value and the selected payment's value, so it includes the selected tier's interest.
   """
   cart: Cart
   """
@@ -3468,7 +3523,7 @@ input PaymentBillingAddressUpdateInput {
 
 """Error codes for the paymentBillingAddressUpdate mutation."""
 enum PaymentBillingAddressUpdateErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3509,7 +3564,7 @@ are never in this enum — per ADR-00007 they surface as top-level GraphQL
 errors (UNAUTHORIZED / UPSTREAM_ERROR), not userErrors.
 """
 enum PaymentStartTransactionErrorCode {
-  """No cart context was provided (x-order-form-id header/cookie)."""
+  """No cart context was provided (no valid `checkout.vtex.com` cookie)."""
   MISSING_CART_CONTEXT
   """The cart was not found."""
   CART_NOT_FOUND
@@ -3565,6 +3620,11 @@ type PaymentStartTransactionPayload {
   The order group, needed for the gateway call's orderId parameter and for gatewayCallback's input.
   """
   orderGroup: String
+  """
+  The Relay Node ID of the order for this order group, for Query.order(id:). Null if errors occurred
+  or the transaction carried no order group.
+  """
+  orderNodeId: ID
   """The shopper's user profile id, needed for the gateway call."""
   userProfileId: String
   """
@@ -3619,6 +3679,14 @@ enum PaymentGatewayCallbackErrorCode {
   VTEX answered 428: the payment needs a challenge step. When `redirectUrl` is set the shopper must be sent there; when it is null the challenge uses a mechanism this API does not hand over (for example a payment app).
   """
   REDIRECT_REQUIRED
+  """
+  The payment gateway answered the callback and refused the payment: a 400, 402, 422 or 500 response whose body carries a VTEX `error` object (not a login-required code). The message is a fixed sentence; nothing the gateway said is forwarded. A response that is not shaped like a gateway answer (502-504, an unreadable body, a timeout) is a top-level `UPSTREAM_ERROR` instead.
+  """
+  PAYMENT_DECLINED
+  """
+  The order group sent is not the one this session's `paymentStartTransaction` returned, or this session started none. The message is a fixed sentence that does not say which, and nothing was sent to VTEX.
+  """
+  ORDER_GROUP_MISMATCH
 }
 
 """A domain error returned from the paymentGatewayCallback mutation."""
@@ -3636,6 +3704,10 @@ type PaymentGatewayCallbackPayload {
   """
   orderId: String
   """
+  The Relay Node ID of the finalized order, for Query.order(id:). Null if errors occurred.
+  """
+  orderNodeId: ID
+  """
   The bank's challenge page; set only when VTEX answered 428 with a usable http(s) URL.
   """
   redirectUrl: String
@@ -3953,6 +4025,14 @@ type PostalCodeAddress @cacheControl(maxAge: 0, scope: PRIVATE) {
 The authentication methods an account enables, read before rendering a sign-in form.
 """
 type SessionAuthProviders {
+  """
+  Stable identifier for this account's sign-in configuration, as
+  base64("SessionAuthProviders:<account>"). It identifies the account's
+  configuration, never a shopper: it is what lets a client cache normalize the
+  type and read it outside a page's server-side fetch. Not a Relay Node: node(id)
+  on this value resolves to null, because the configuration is read as a whole.
+  """
+  id: ID!
   """Whether classic email and password sign-in is enabled."""
   passwordAuthentication: Boolean!
   """Whether email access-code (passwordless) sign-in is enabled."""
@@ -4483,6 +4563,10 @@ type CustomerOrder implements Node @cacheControl(maxAge: 0, scope: PRIVATE) {
   """Timestamp when the order was invoiced."""
   invoiceDate: DateTime
   """
+  Invoice files the merchant sent. Oldest issue date first. Empty when none qualify.
+  """
+  invoices: [CustomerOrderInvoice!]!
+  """
   Order delivery channel. The order-level value when OMS supplies it, otherwise
   the channel every logistics entry agrees on. Null when those entries differ.
   """
@@ -4558,13 +4642,33 @@ type CustomerOrderItem {
 }
 
 """A custom value recorded on an order line."""
-type CustomerOrderItemCustomField {
+type CustomerOrderItemCustomField @cacheControl(maxAge: 0, scope: PRIVATE) {
   """Custom field name."""
   name: String!
   """Custom field value as recorded on the order."""
   value: String!
 }
 
+"""Sale or return, from the OMS package type."""
+enum CustomerOrderInvoiceKind {
+  """An Output invoice, the sale document."""
+  SALE
+  """An Input invoice, the return document."""
+  RETURN
+}
+
+"""One invoice file the merchant sent on the order."""
+type CustomerOrderInvoice {
+  """Merchant file address. http or https."""
+  url: String!
+  """
+  Package issuance date. Null when OMS omitted it or sent a value that is not a date.
+  """
+  issuedAt: DateTime
+  """SALE for an Output invoice. RETURN for an Input invoice."""
+  kind: CustomerOrderInvoiceKind!
+}
+
 """Products that share one selected delivery option."""
 type CustomerOrderDeliveryOption {
   """Selected service-level agreement name."""
@@ -4579,10 +4683,14 @@ type CustomerOrderDeliveryOption {
   address: CustomerOrderAddress
   """Product lines assigned to this option."""
   items: [CustomerOrderItem!]!
+  """
+  Distinct http or https tracking addresses for invoices whose items fall in this option.
+  """
+  trackingLinks: [String!]!
 }
 
 """Historical delivery address recorded on an order."""
-type CustomerOrderAddress {
+type CustomerOrderAddress @cacheControl(maxAge: 0, scope: PRIVATE) {
   """Recipient name."""
   receiverName: String
   """Postal code."""
@@ -4606,7 +4714,7 @@ type CustomerOrderAddress {
 }
 
 """One payment recorded on a placed order."""
-type CustomerOrderPayment {
+type CustomerOrderPayment @cacheControl(maxAge: 0, scope: PRIVATE) {
   """Shopper-facing payment method name."""
   methodName: String
   """

package/dist/sdk/address/address-fields.js

@@ -1,12 +1,12 @@
 import { ACCOUNT_MAX_LENGTH, isCountryField } from "./constants.js";
-import { resolveLabelId, resolvePlaceholder } from "./messages.js";
+import { resolveLabelKey, resolvePlaceholder } from "./messages.js";
 import { declaredMaxLength, toFormValues } from "./schema.js";
 import { getVisibleFields, resolveFieldInputMode, resolveFieldLabel, resolveFieldOptions, resolveFieldPlaceholder } from "@vtex/country-forms";
 //#region src/sdk/address/address-fields.ts
 /**
 * The fields a country's form shows for the values typed so far, in the form's order. A country the
-* library does not cover lists `street` alone. Labels and placeholders are message ids for the
-* caller's i18n; option labels are proper names and are not translated.
+* library does not cover lists `street` alone. Labels and placeholders are keys the caller words
+* with its own messages; option labels are proper names and are not translated.
 */
 function addressFields(rules, values) {
 	const text = toFormValues(values);
@@ -21,7 +21,7 @@ function addressFields(rules, values) {
 			control: field.type === "select" ? "select" : "text",
 			required: field.required,
 			maxLength: declaredMaxLength(field) ?? ACCOUNT_MAX_LENGTH[name],
-			labelId: resolveLabelId(resolveFieldLabel(field, text), name, rules.country),
+			label: resolveLabelKey(resolveFieldLabel(field, text), name, rules.country),
 			...inputMode && { inputMode },
 			...placeholder && { placeholder },
 			...options && { options: options.map(({ value, displayValue }) => ({

package/dist/sdk/address/address-fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"address-fields.js","names":[],"sources":["../../../src/sdk/address/address-fields.ts"],"sourcesContent":["import {\n  getVisibleFields,\n  resolveFieldInputMode,\n  resolveFieldLabel,\n  resolveFieldOptions,\n  resolveFieldPlaceholder,\n} from '@vtex/country-forms';\nimport { ACCOUNT_MAX_LENGTH, isCountryField } from './constants.js';\nimport { resolveLabelId, resolvePlaceholder } from './messages.js';\nimport { declaredMaxLength, toFormValues } from './schema.js';\nimport type { AddressFieldDescriptor, AddressValues, CountryRules } from './types.js';\n\n/**\n * The fields a country's form shows for the values typed so far, in the form's order. A country the\n * library does not cover lists `street` alone. Labels and placeholders are message ids for the\n * caller's i18n; option labels are proper names and are not translated.\n */\nexport function addressFields(rules: CountryRules, values: AddressValues): readonly AddressFieldDescriptor[] {\n  const text = toFormValues(values);\n\n  return getVisibleFields(rules.schema, text).flatMap((field): AddressFieldDescriptor[] => {\n    const { name, dependsOn } = field;\n    if (!isCountryField(name)) {\n      return [];\n    }\n\n    const inputMode = resolveFieldInputMode(field, text);\n    const placeholder = resolvePlaceholder(resolveFieldPlaceholder(field, text), rules.country);\n    const options = field.type === 'select' ? (resolveFieldOptions(field, text) ?? []) : undefined;\n\n    return [\n      {\n        name,\n        control: field.type === 'select' ? 'select' : 'text',\n        required: field.required,\n        maxLength: declaredMaxLength(field) ?? ACCOUNT_MAX_LENGTH[name],\n        labelId: resolveLabelId(resolveFieldLabel(field, text), name, rules.country),\n        ...(inputMode && { inputMode }),\n        ...(placeholder && { placeholder }),\n        ...(options && { options: options.map(({ value, displayValue }) => ({ value, label: displayValue })) }),\n        ...(dependsOn && isCountryField(dependsOn) && { dependsOn }),\n      },\n    ];\n  });\n}\n"],"mappings":";;;;;;;;;;AAiBA,SAAgB,cAAc,OAAqB,QAA0D;CAC3G,MAAM,OAAO,aAAa,MAAM;CAEhC,OAAO,iBAAiB,MAAM,QAAQ,IAAI,CAAC,CAAC,SAAS,UAAoC;EACvF,MAAM,EAAE,MAAM,cAAc;EAC5B,IAAI,CAAC,eAAe,IAAI,GACtB,OAAO,CAAC;EAGV,MAAM,YAAY,sBAAsB,OAAO,IAAI;EACnD,MAAM,cAAc,mBAAmB,wBAAwB,OAAO,IAAI,GAAG,MAAM,OAAO;EAC1F,MAAM,UAAU,MAAM,SAAS,WAAY,oBAAoB,OAAO,IAAI,KAAK,CAAC,IAAK,KAAA;EAErF,OAAO,CACL;GACE;GACA,SAAS,MAAM,SAAS,WAAW,WAAW;GAC9C,UAAU,MAAM;GAChB,WAAW,kBAAkB,KAAK,KAAK,mBAAmB;GAC1D,SAAS,eAAe,kBAAkB,OAAO,IAAI,GAAG,MAAM,MAAM,OAAO;GAC3E,GAAI,aAAa,EAAE,UAAU;GAC7B,GAAI,eAAe,EAAE,YAAY;GACjC,GAAI,WAAW,EAAE,SAAS,QAAQ,KAAK,EAAE,OAAO,oBAAoB;IAAE;IAAO,OAAO;GAAa,EAAE,EAAE;GACrG,GAAI,aAAa,eAAe,SAAS,KAAK,EAAE,UAAU;EAC5D,CACF;CACF,CAAC;AACH"}
+{"version":3,"file":"address-fields.js","names":[],"sources":["../../../src/sdk/address/address-fields.ts"],"sourcesContent":["import {\n  getVisibleFields,\n  resolveFieldInputMode,\n  resolveFieldLabel,\n  resolveFieldOptions,\n  resolveFieldPlaceholder,\n} from '@vtex/country-forms';\nimport { ACCOUNT_MAX_LENGTH, isCountryField } from './constants.js';\nimport { resolveLabelKey, resolvePlaceholder } from './messages.js';\nimport { declaredMaxLength, toFormValues } from './schema.js';\nimport type { AddressFieldDescriptor, AddressValues, CountryRules } from './types.js';\n\n/**\n * The fields a country's form shows for the values typed so far, in the form's order. A country the\n * library does not cover lists `street` alone. Labels and placeholders are keys the caller words\n * with its own messages; option labels are proper names and are not translated.\n */\nexport function addressFields(rules: CountryRules, values: AddressValues): readonly AddressFieldDescriptor[] {\n  const text = toFormValues(values);\n\n  return getVisibleFields(rules.schema, text).flatMap((field): AddressFieldDescriptor[] => {\n    const { name, dependsOn } = field;\n    if (!isCountryField(name)) {\n      return [];\n    }\n\n    const inputMode = resolveFieldInputMode(field, text);\n    const placeholder = resolvePlaceholder(resolveFieldPlaceholder(field, text), rules.country);\n    const options = field.type === 'select' ? (resolveFieldOptions(field, text) ?? []) : undefined;\n\n    return [\n      {\n        name,\n        control: field.type === 'select' ? 'select' : 'text',\n        required: field.required,\n        maxLength: declaredMaxLength(field) ?? ACCOUNT_MAX_LENGTH[name],\n        label: resolveLabelKey(resolveFieldLabel(field, text), name, rules.country),\n        ...(inputMode && { inputMode }),\n        ...(placeholder && { placeholder }),\n        ...(options && { options: options.map(({ value, displayValue }) => ({ value, label: displayValue })) }),\n        ...(dependsOn && isCountryField(dependsOn) && { dependsOn }),\n      },\n    ];\n  });\n}\n"],"mappings":";;;;;;;;;;AAiBA,SAAgB,cAAc,OAAqB,QAA0D;CAC3G,MAAM,OAAO,aAAa,MAAM;CAEhC,OAAO,iBAAiB,MAAM,QAAQ,IAAI,CAAC,CAAC,SAAS,UAAoC;EACvF,MAAM,EAAE,MAAM,cAAc;EAC5B,IAAI,CAAC,eAAe,IAAI,GACtB,OAAO,CAAC;EAGV,MAAM,YAAY,sBAAsB,OAAO,IAAI;EACnD,MAAM,cAAc,mBAAmB,wBAAwB,OAAO,IAAI,GAAG,MAAM,OAAO;EAC1F,MAAM,UAAU,MAAM,SAAS,WAAY,oBAAoB,OAAO,IAAI,KAAK,CAAC,IAAK,KAAA;EAErF,OAAO,CACL;GACE;GACA,SAAS,MAAM,SAAS,WAAW,WAAW;GAC9C,UAAU,MAAM;GAChB,WAAW,kBAAkB,KAAK,KAAK,mBAAmB;GAC1D,OAAO,gBAAgB,kBAAkB,OAAO,IAAI,GAAG,MAAM,MAAM,OAAO;GAC1E,GAAI,aAAa,EAAE,UAAU;GAC7B,GAAI,eAAe,EAAE,YAAY;GACjC,GAAI,WAAW,EAAE,SAAS,QAAQ,KAAK,EAAE,OAAO,oBAAoB;IAAE;IAAO,OAAO;GAAa,EAAE,EAAE;GACrG,GAAI,aAAa,eAAe,SAAS,KAAK,EAAE,UAAU;EAC5D,CACF;CACF,CAAC;AACH"}

package/dist/sdk/address/constants.js

@@ -18,11 +18,6 @@ const ACCOUNT_FIELDS = [
 	"reference",
 	"name"
 ];
-const ACCOUNT_FIELD_LABELS = {
-	recipientName: "fs/address.field.recipient-name",
-	reference: "fs/address.field.reference",
-	name: "fs/address.field.name"
-};
 /**
 * Each maximum is at least the largest limit any covered schema declares for that field, and at
 * most the size of the Master Data `AD` column that stores it.
@@ -55,6 +50,6 @@ const POSTAL_CODE_LOOKUP_COUNTRIES = [
 	"USA"
 ];
 //#endregion
-export { ACCOUNT_FIELDS, ACCOUNT_FIELD_LABELS, ACCOUNT_MAX_LENGTH, CHECKOUT_MINIMUMS, COUNTRY_FIELDS, POSTAL_CODE_LOOKUP_COUNTRIES, isCountryField };
+export { ACCOUNT_FIELDS, ACCOUNT_MAX_LENGTH, CHECKOUT_MINIMUMS, COUNTRY_FIELDS, POSTAL_CODE_LOOKUP_COUNTRIES, isCountryField };
 
 //# sourceMappingURL=constants.js.map

package/dist/sdk/address/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","names":[],"sources":["../../../src/sdk/address/constants.ts"],"sourcesContent":["import type { MessageId } from '../i18n/client.js';\nimport type { AccountFieldName, AddressFieldName, CheckoutMinimum, CountryFieldName } from './types.js';\n\n/** In the order a country's form lists them when it does not say otherwise. */\nexport const COUNTRY_FIELDS: readonly CountryFieldName[] = [\n  'postalCode',\n  'street',\n  'number',\n  'complement',\n  'neighborhood',\n  'state',\n  'city',\n];\n\nconst COUNTRY_FIELD_NAMES: ReadonlySet<string> = new Set(COUNTRY_FIELDS);\n\nexport function isCountryField(name: string): name is CountryFieldName {\n  return COUNTRY_FIELD_NAMES.has(name);\n}\n\nexport const ACCOUNT_FIELDS: readonly AccountFieldName[] = ['recipientName', 'reference', 'name'];\n\nexport const ACCOUNT_FIELD_LABELS: Readonly<Record<AccountFieldName, MessageId>> = {\n  recipientName: 'fs/address.field.recipient-name',\n  reference: 'fs/address.field.reference',\n  name: 'fs/address.field.name',\n};\n\n/**\n * Each maximum is at least the largest limit any covered schema declares for that field, and at\n * most the size of the Master Data `AD` column that stores it.\n */\nexport const ACCOUNT_MAX_LENGTH: Readonly<Record<AddressFieldName, number>> = {\n  recipientName: 200,\n  name: 50,\n  reference: 750,\n  street: 750,\n  number: 750,\n  complement: 750,\n  neighborhood: 100,\n  city: 100,\n  state: 100,\n  postalCode: 20,\n};\n\n/** What the checkout needs in a profile before it offers the shopper's saved addresses. */\nexport const CHECKOUT_MINIMUMS: readonly CheckoutMinimum[] = ['homePhone'];\n\n/**\n * Countries for which the checkout's postal-code lookup filled at least the city and the state of a\n * valid sample code. An unknown code is an empty success, so a country missing here costs nothing.\n */\nexport const POSTAL_CODE_LOOKUP_COUNTRIES: readonly string[] = ['ARG', 'BRA', 'CAN', 'ESP', 'FRA', 'MEX', 'USA'];\n"],"mappings":";;AAIA,MAAa,iBAA8C;CACzD;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAM,sBAA2C,IAAI,IAAI,cAAc;AAEvE,SAAgB,eAAe,MAAwC;CACrE,OAAO,oBAAoB,IAAI,IAAI;AACrC;AAEA,MAAa,iBAA8C;CAAC;CAAiB;CAAa;AAAM;AAEhG,MAAa,uBAAsE;CACjF,eAAe;CACf,WAAW;CACX,MAAM;AACR;;;;;AAMA,MAAa,qBAAiE;CAC5E,eAAe;CACf,MAAM;CACN,WAAW;CACX,QAAQ;CACR,QAAQ;CACR,YAAY;CACZ,cAAc;CACd,MAAM;CACN,OAAO;CACP,YAAY;AACd;;AAGA,MAAa,oBAAgD,CAAC,WAAW;;;;;AAMzE,MAAa,+BAAkD;CAAC;CAAO;CAAO;CAAO;CAAO;CAAO;CAAO;AAAK"}
+{"version":3,"file":"constants.js","names":[],"sources":["../../../src/sdk/address/constants.ts"],"sourcesContent":["import type { AccountFieldName, AddressFieldName, CheckoutMinimum, CountryFieldName } from './types.js';\n\n/** In the order a country's form lists them when it does not say otherwise. */\nexport const COUNTRY_FIELDS: readonly CountryFieldName[] = [\n  'postalCode',\n  'street',\n  'number',\n  'complement',\n  'neighborhood',\n  'state',\n  'city',\n];\n\nconst COUNTRY_FIELD_NAMES: ReadonlySet<string> = new Set(COUNTRY_FIELDS);\n\nexport function isCountryField(name: string): name is CountryFieldName {\n  return COUNTRY_FIELD_NAMES.has(name);\n}\n\nexport const ACCOUNT_FIELDS: readonly AccountFieldName[] = ['recipientName', 'reference', 'name'];\n\n/**\n * Each maximum is at least the largest limit any covered schema declares for that field, and at\n * most the size of the Master Data `AD` column that stores it.\n */\nexport const ACCOUNT_MAX_LENGTH: Readonly<Record<AddressFieldName, number>> = {\n  recipientName: 200,\n  name: 50,\n  reference: 750,\n  street: 750,\n  number: 750,\n  complement: 750,\n  neighborhood: 100,\n  city: 100,\n  state: 100,\n  postalCode: 20,\n};\n\n/** What the checkout needs in a profile before it offers the shopper's saved addresses. */\nexport const CHECKOUT_MINIMUMS: readonly CheckoutMinimum[] = ['homePhone'];\n\n/**\n * Countries for which the checkout's postal-code lookup filled at least the city and the state of a\n * valid sample code. An unknown code is an empty success, so a country missing here costs nothing.\n */\nexport const POSTAL_CODE_LOOKUP_COUNTRIES: readonly string[] = ['ARG', 'BRA', 'CAN', 'ESP', 'FRA', 'MEX', 'USA'];\n"],"mappings":";;AAGA,MAAa,iBAA8C;CACzD;CACA;CACA;CACA;CACA;CACA;CACA;AACF;AAEA,MAAM,sBAA2C,IAAI,IAAI,cAAc;AAEvE,SAAgB,eAAe,MAAwC;CACrE,OAAO,oBAAoB,IAAI,IAAI;AACrC;AAEA,MAAa,iBAA8C;CAAC;CAAiB;CAAa;AAAM;;;;;AAMhG,MAAa,qBAAiE;CAC5E,eAAe;CACf,MAAM;CACN,WAAW;CACX,QAAQ;CACR,QAAQ;CACR,YAAY;CACZ,cAAc;CACd,MAAM;CACN,OAAO;CACP,YAAY;AACd;;AAGA,MAAa,oBAAgD,CAAC,WAAW;;;;;AAMzE,MAAa,+BAAkD;CAAC;CAAO;CAAO;CAAO;CAAO;CAAO;CAAO;AAAK"}