@cartbase/storefront 0.2.0 → 0.3.0

package/src/checkout/labels.ts

@@ -1,263 +1,263 @@
-/**
- * Checkout labels — default English copy.
- *
- * Ported from `@1click/ui/src/checkout/labels.ts` (v2.3.1) with the
- * Cartbase additions: gift-card tender labels (`giftCard*`) for the new
- * GiftCardSection (gift cards are a Cartbase feature with no @1click
- * equivalent — docs/storefront/gift-cards.md).
- *
- * Every user-facing string in the checkout module comes from a
- * `CheckoutLabels` object. Stores override strings by passing a partial
- * labels object to `CheckoutProvider`. English is the baseline; stores
- * wanting Bulgarian, German, etc. pass their own translations.
- */
-
-export type CheckoutLabels = {
-  // Section headings
-  deliveryInfo: string
-  shippingServices: string
-  paymentMethod: string
-  orderSummary: string
-
-  // Form fields
-  email: string
-  country: string
-  /**
-   * Localized name of the single-region country (e.g. "България"). When
-   * the checkout renders with exactly one country, the country select
-   * collapses to a readonly field showing this name instead of the
-   * dropdown's English `display_name`. Optional — falls back to the
-   * country's `display_name` when omitted.
-   */
-  singleCountryName?: string
-  firstName: string
-  lastName: string
-  address: string
-  apartment: string
-  city: string
-  postalCode: string
-  phone: string
-  province: string
-
-  // Buttons
-  saveAddress: string
-  updateAddress: string
-  addToOrder: string
-  addCode: string
-
-  // States / empty / disabled
-  deliveryDisabled: string
-  noShippingOptions: string
-  paymentDisabled: string
-  /** Shown above the shipping options when they render as a read-only
-   * price preview before the address is entered (stores that opt into
-   * `previewWhenAddressNotReady`). */
-  deliveryPreviewHint: string
-  /** Hint under the disabled Buy button explaining what's still missing. */
-  buyNeedsAddress: string
-  buyNeedsDelivery: string
-
-  // Payment tabs
-  codNote: string
-  /** Online-payment radio label. Covers every Stripe-enabled method
-   * (card + Apple Pay + Google Pay + Link + whatever else is turned on
-   * in the Stripe Dashboard). Replaces the old `payByCard`. */
-  payOnline: string
-  cashOnDelivery: string
-  termsText: string
-
-  // Address reuse
-  useSavedAddress: string
-  saveInfo: string
-
-  // Saved address picker
-  chooseAddress: string
-
-  // Order summary
-  items: string
-  qty: string
-  subtotal: string
-  shipping: string
-  shippingCalc: string
-  shippingFree: string
-  tax: string
-  taxTooltip: string
-  total: string
-  discount: string
-  discountCode: string
-  discountSub: string
-  /** Default label for the cash-on-delivery fee row. Used as the third-
-   *  level fallback when neither the cart's `cod_fee_label` (Cartbase
-   *  server truth) nor a per-store override is available. */
-  codFee: string
-  recommended: string
-  recommendedSoon: string
-  recommendedSoonSub: string
-  remove: string
-  secureCheckout: string
-
-  // Gift cards (Cartbase gift-card tender — docs/storefront/gift-cards.md)
-  giftCard: string
-  giftCardSub: string
-  giftCardPlaceholder: string
-  /** Row label for the summary's gift-card tender line ("Gift cards −X"). */
-  giftCardApplied: string
-  /** Label for the remainder row ("Remaining to pay"). Rendered only when
-   * gift cards cover part of the total (`gift_card_total > 0`). */
-  giftCardRemaining: string
-  /** Prefix for an applied card chip, followed by the masked last4
-   * (e.g. "Gift card ••••1234"). */
-  giftCardEnding: string
-
-  // Company invoice
-  companyInvoice: string
-  companyName: string
-  companyVat: string
-  companyMol: string
-  companyAddress: string
-
-  // Place order button
-  placeOrder: string
-  selectPaymentMethod: string
-
-  /**
-   * Processing-state messages shown beneath the spinning Buy button
-   * while `performBuyClick` is in flight. Cycle through with a fade
-   * transition every ~1.8s; on long flows (3DS challenges, slow
-   * networks) the cycle loops back to index 0.
-   *
-   * Two arrays so card and COD show different micro-narratives — card
-   * mentions the bank handshake (the slow part), COD jumps straight
-   * to delivery + order. The closing entry should be a brand-flavored
-   * line that's still honest to the "processing" moment (don't say
-   * "packing" — nothing is being packed yet).
-   */
-  processingCard: string[]
-  processingCod: string[]
-
-  // Econt office selector
-  econtLoadingOffices: string
-  econtNearestOffices: string
-  econtSearchAnother: string
-  econtSearchPlaceholder: string
-  econtNoResults: string
-  econtChange: string
-
-  // BoxNow locker selector
-  boxnowLoadingLockers: string
-  boxnowNearestLockers: string
-  boxnowSearchAnother: string
-  boxnowSearchPlaceholder: string
-  boxnowNoResults: string
-  boxnowChange: string
-  boxnowUnavailable: string
-  boxnowNoLockersInCity: string
-}
-
-export const defaultCheckoutLabels: CheckoutLabels = {
-  deliveryInfo: "Delivery information",
-  shippingServices: "Shipping method",
-  paymentMethod: "Payment method",
-  orderSummary: "Order summary",
-
-  email: "Email",
-  country: "Country",
-  singleCountryName: undefined,
-  firstName: "First name",
-  lastName: "Last name",
-  address: "Address",
-  apartment: "Apartment, suite, etc. (optional)",
-  city: "City",
-  postalCode: "Postal code",
-  phone: "Phone",
-  province: "State / province",
-
-  saveAddress: "Save and continue",
-  updateAddress: "Update address",
-  addToOrder: "+ Add to order",
-  addCode: "Apply",
-
-  deliveryDisabled:
-    "Enter your delivery address to see available shipping options.",
-  noShippingOptions: "No shipping options available for your address.",
-  paymentDisabled: "Select a shipping method to continue.",
-  deliveryPreviewHint: "Enter your address to choose a delivery method.",
-  buyNeedsAddress: "Enter your delivery address",
-  buyNeedsDelivery: "Choose a delivery method",
-
-  codNote: "Cash on delivery. Additional fees may apply.",
-  payOnline: "Pay online",
-  cashOnDelivery: "Cash on delivery",
-  termsText:
-    "By placing your order you accept our Terms and Privacy Policy.",
-
-  useSavedAddress: "Use a saved address?",
-  saveInfo: "Save this information for next time",
-
-  chooseAddress: "Choose an address",
-
-  items: "items",
-  qty: "Qty",
-  subtotal: "Subtotal",
-  shipping: "Shipping",
-  shippingCalc: "Calculated at checkout",
-  shippingFree: "Free",
-  tax: "VAT incl.",
-  taxTooltip: "20% VAT is included in prices",
-  total: "Total",
-  discount: "Discount",
-  discountCode: "Discount code",
-  discountSub: "Save with a promo code",
-  codFee: "Cash on delivery fee",
-  recommended: "Recommended for you",
-  recommendedSoon: "Coming soon",
-  recommendedSoonSub: "Personalized recommendations",
-  remove: "Remove",
-  secureCheckout: "Secure checkout",
-
-  giftCard: "Gift card",
-  giftCardSub: "Redeem a gift card",
-  giftCardPlaceholder: "GIFT-XXXX-XXXX",
-  giftCardApplied: "Gift cards",
-  giftCardRemaining: "Remaining to pay",
-  giftCardEnding: "Gift card ending in",
-
-  companyInvoice: "Company invoice",
-  companyName: "Company name",
-  companyVat: "VAT / Company number",
-  companyMol: "Responsible person",
-  companyAddress: "Company address",
-
-  placeOrder: "Place order",
-  selectPaymentMethod: "Select a payment method",
-
-  processingCard: [
-    "Connecting to the bank...",
-    "Confirming the payment...",
-    "Recording the order...",
-    "Attending to every detail...",
-  ],
-  processingCod: [
-    "Reserving the delivery...",
-    "Preparing the order...",
-    "Attending to every detail...",
-  ],
-
-  econtLoadingOffices: "Loading offices...",
-  econtNearestOffices: "Nearest offices",
-  econtSearchAnother: "Search for another office",
-  econtSearchPlaceholder: "Search by name, city, or address...",
-  econtNoResults: "No offices found for",
-  econtChange: "Change",
-
-  boxnowLoadingLockers: "Loading lockers...",
-  boxnowNearestLockers: "Nearest lockers",
-  boxnowSearchAnother: "Search for another locker",
-  boxnowSearchPlaceholder: "Search by name, address, or postal code...",
-  boxnowNoResults: "No lockers found for",
-  boxnowChange: "Change",
-  boxnowUnavailable:
-    "BoxNow is temporarily unavailable, please choose a different shipping method.",
-  boxnowNoLockersInCity:
-    "No BoxNow lockers found in your city. Please choose a different shipping method.",
-}
+/**
+ * Checkout labels — default English copy.
+ *
+ * Ported from `@1click/ui/src/checkout/labels.ts` (v2.3.1) with the
+ * Cartbase additions: gift-card tender labels (`giftCard*`) for the new
+ * GiftCardSection (gift cards are a Cartbase feature with no @1click
+ * equivalent — docs/storefront/gift-cards.md).
+ *
+ * Every user-facing string in the checkout module comes from a
+ * `CheckoutLabels` object. Stores override strings by passing a partial
+ * labels object to `CheckoutProvider`. English is the baseline; stores
+ * wanting Bulgarian, German, etc. pass their own translations.
+ */
+
+export type CheckoutLabels = {
+  // Section headings
+  deliveryInfo: string
+  shippingServices: string
+  paymentMethod: string
+  orderSummary: string
+
+  // Form fields
+  email: string
+  country: string
+  /**
+   * Localized name of the single-region country (e.g. "България"). When
+   * the checkout renders with exactly one country, the country select
+   * collapses to a readonly field showing this name instead of the
+   * dropdown's English `display_name`. Optional — falls back to the
+   * country's `display_name` when omitted.
+   */
+  singleCountryName?: string
+  firstName: string
+  lastName: string
+  address: string
+  apartment: string
+  city: string
+  postalCode: string
+  phone: string
+  province: string
+
+  // Buttons
+  saveAddress: string
+  updateAddress: string
+  addToOrder: string
+  addCode: string
+
+  // States / empty / disabled
+  deliveryDisabled: string
+  noShippingOptions: string
+  paymentDisabled: string
+  /** Shown above the shipping options when they render as a read-only
+   * price preview before the address is entered (stores that opt into
+   * `previewWhenAddressNotReady`). */
+  deliveryPreviewHint: string
+  /** Hint under the disabled Buy button explaining what's still missing. */
+  buyNeedsAddress: string
+  buyNeedsDelivery: string
+
+  // Payment tabs
+  codNote: string
+  /** Online-payment radio label. Covers every Stripe-enabled method
+   * (card + Apple Pay + Google Pay + Link + whatever else is turned on
+   * in the Stripe Dashboard). Replaces the old `payByCard`. */
+  payOnline: string
+  cashOnDelivery: string
+  termsText: string
+
+  // Address reuse
+  useSavedAddress: string
+  saveInfo: string
+
+  // Saved address picker
+  chooseAddress: string
+
+  // Order summary
+  items: string
+  qty: string
+  subtotal: string
+  shipping: string
+  shippingCalc: string
+  shippingFree: string
+  tax: string
+  taxTooltip: string
+  total: string
+  discount: string
+  discountCode: string
+  discountSub: string
+  /** Default label for the cash-on-delivery fee row. Used as the third-
+   *  level fallback when neither the cart's `payment_method_fee_label` (Cartbase
+   *  server truth) nor a per-store override is available. */
+  paymentMethodFee: string
+  recommended: string
+  recommendedSoon: string
+  recommendedSoonSub: string
+  remove: string
+  secureCheckout: string
+
+  // Gift cards (Cartbase gift-card tender — docs/storefront/gift-cards.md)
+  giftCard: string
+  giftCardSub: string
+  giftCardPlaceholder: string
+  /** Row label for the summary's gift-card tender line ("Gift cards −X"). */
+  giftCardApplied: string
+  /** Label for the remainder row ("Remaining to pay"). Rendered only when
+   * gift cards cover part of the total (`gift_card_total > 0`). */
+  giftCardRemaining: string
+  /** Prefix for an applied card chip, followed by the masked last4
+   * (e.g. "Gift card ••••1234"). */
+  giftCardEnding: string
+
+  // Company invoice
+  companyInvoice: string
+  companyName: string
+  companyVat: string
+  companyMol: string
+  companyAddress: string
+
+  // Place order button
+  placeOrder: string
+  selectPaymentMethod: string
+
+  /**
+   * Processing-state messages shown beneath the spinning Buy button
+   * while `performBuyClick` is in flight. Cycle through with a fade
+   * transition every ~1.8s; on long flows (3DS challenges, slow
+   * networks) the cycle loops back to index 0.
+   *
+   * Two arrays so card and COD show different micro-narratives — card
+   * mentions the bank handshake (the slow part), COD jumps straight
+   * to delivery + order. The closing entry should be a brand-flavored
+   * line that's still honest to the "processing" moment (don't say
+   * "packing" — nothing is being packed yet).
+   */
+  processingCard: string[]
+  processingCod: string[]
+
+  // Econt office selector
+  econtLoadingOffices: string
+  econtNearestOffices: string
+  econtSearchAnother: string
+  econtSearchPlaceholder: string
+  econtNoResults: string
+  econtChange: string
+
+  // BoxNow locker selector
+  boxnowLoadingLockers: string
+  boxnowNearestLockers: string
+  boxnowSearchAnother: string
+  boxnowSearchPlaceholder: string
+  boxnowNoResults: string
+  boxnowChange: string
+  boxnowUnavailable: string
+  boxnowNoLockersInCity: string
+}
+
+export const defaultCheckoutLabels: CheckoutLabels = {
+  deliveryInfo: "Delivery information",
+  shippingServices: "Shipping method",
+  paymentMethod: "Payment method",
+  orderSummary: "Order summary",
+
+  email: "Email",
+  country: "Country",
+  singleCountryName: undefined,
+  firstName: "First name",
+  lastName: "Last name",
+  address: "Address",
+  apartment: "Apartment, suite, etc. (optional)",
+  city: "City",
+  postalCode: "Postal code",
+  phone: "Phone",
+  province: "State / province",
+
+  saveAddress: "Save and continue",
+  updateAddress: "Update address",
+  addToOrder: "+ Add to order",
+  addCode: "Apply",
+
+  deliveryDisabled:
+    "Enter your delivery address to see available shipping options.",
+  noShippingOptions: "No shipping options available for your address.",
+  paymentDisabled: "Select a shipping method to continue.",
+  deliveryPreviewHint: "Enter your address to choose a delivery method.",
+  buyNeedsAddress: "Enter your delivery address",
+  buyNeedsDelivery: "Choose a delivery method",
+
+  codNote: "Cash on delivery. Additional fees may apply.",
+  payOnline: "Pay online",
+  cashOnDelivery: "Cash on delivery",
+  termsText:
+    "By placing your order you accept our Terms and Privacy Policy.",
+
+  useSavedAddress: "Use a saved address?",
+  saveInfo: "Save this information for next time",
+
+  chooseAddress: "Choose an address",
+
+  items: "items",
+  qty: "Qty",
+  subtotal: "Subtotal",
+  shipping: "Shipping",
+  shippingCalc: "Calculated at checkout",
+  shippingFree: "Free",
+  tax: "VAT incl.",
+  taxTooltip: "20% VAT is included in prices",
+  total: "Total",
+  discount: "Discount",
+  discountCode: "Discount code",
+  discountSub: "Save with a promo code",
+  paymentMethodFee: "Payment method fee",
+  recommended: "Recommended for you",
+  recommendedSoon: "Coming soon",
+  recommendedSoonSub: "Personalized recommendations",
+  remove: "Remove",
+  secureCheckout: "Secure checkout",
+
+  giftCard: "Gift card",
+  giftCardSub: "Redeem a gift card",
+  giftCardPlaceholder: "GIFT-XXXX-XXXX",
+  giftCardApplied: "Gift cards",
+  giftCardRemaining: "Remaining to pay",
+  giftCardEnding: "Gift card ending in",
+
+  companyInvoice: "Company invoice",
+  companyName: "Company name",
+  companyVat: "VAT / Company number",
+  companyMol: "Responsible person",
+  companyAddress: "Company address",
+
+  placeOrder: "Place order",
+  selectPaymentMethod: "Select a payment method",
+
+  processingCard: [
+    "Connecting to the bank...",
+    "Confirming the payment...",
+    "Recording the order...",
+    "Attending to every detail...",
+  ],
+  processingCod: [
+    "Reserving the delivery...",
+    "Preparing the order...",
+    "Attending to every detail...",
+  ],
+
+  econtLoadingOffices: "Loading offices...",
+  econtNearestOffices: "Nearest offices",
+  econtSearchAnother: "Search for another office",
+  econtSearchPlaceholder: "Search by name, city, or address...",
+  econtNoResults: "No offices found for",
+  econtChange: "Change",
+
+  boxnowLoadingLockers: "Loading lockers...",
+  boxnowNearestLockers: "Nearest lockers",
+  boxnowSearchAnother: "Search for another locker",
+  boxnowSearchPlaceholder: "Search by name, address, or postal code...",
+  boxnowNoResults: "No lockers found for",
+  boxnowChange: "Change",
+  boxnowUnavailable:
+    "BoxNow is temporarily unavailable, please choose a different shipping method.",
+  boxnowNoLockersInCity:
+    "No BoxNow lockers found in your city. Please choose a different shipping method.",
+}