@vtex/faststore 0.0.10 → 0.0.11

package/dist/matter/saved-cards/saved-cards.d.ts

@@ -1,29 +1,111 @@
+import { ContentValue, MessageLocaleProp } from "../../core/dist/define-content-type.js";
 import { ComponentDefinition } from "../../core/dist/define-component.js";
 import "../../core/dist/index.js";
 import { ComponentActions } from "../../sdk/actions/types.js";
 import { ComponentPropsWithRef, ReactNode } from "react";
 //#region src/matter/saved-cards/saved-cards.d.ts
-/** The minimal per-row identifiers `SavedCards` needs to iterate and to dispatch selection. */
+/**
+ * The minimal per-row facts `SavedCards` needs to iterate, to dispatch selection, and to tell whether the
+ * persisted selection is an expired card (which is never the radio group's value).
+ */
 export type SavedCardsListEntry = Readonly<{
   id: string;
   accountId: string;
   methodId: string;
   bin: string;
+  expired: boolean;
 }>;
 export type SavedCardsData = {
   savedCards?: readonly SavedCardsListEntry[];
 } | null;
-export type SavedCardsProps = ComponentPropsWithRef<'div'> & {
+export declare const SavedCardsContent: {
+  readonly id: "saved-cards";
+  readonly title: "Saved Cards";
+  readonly description: "Copy for the saved-card group legend and a refused card selection.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly legend: {
+        readonly type: "string";
+        readonly title: "Legend";
+        readonly description: "The radio group's visible accessible name.";
+        readonly format: "icu-message";
+        readonly messageSource: "Saved cards";
+      };
+      readonly savedCardUnavailableMessage: {
+        readonly type: "string";
+        readonly title: "Saved card unavailable message";
+        readonly description: "Shown when the picked saved card can no longer be used.";
+        readonly format: "icu-message";
+        readonly messageSource: "This saved card is no longer available. Choose another card.";
+      };
+      readonly genericErrorMessage: {
+        readonly type: "string";
+        readonly title: "Selection failure message";
+        readonly description: "Shown when a card selection fails: a network failure or a fault the shopper cannot fix.";
+        readonly format: "icu-message";
+        readonly messageSource: "Unable to select this card. Please try again.";
+      };
+    };
+  };
+};
+export declare const SavedCardCvvFieldContent: {
+  readonly id: "saved-card-cvv-field";
+  readonly title: "Saved Card CVV Field";
+  readonly description: "Copy for the security code input of a saved card.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly securityCodeLabel: {
+        readonly type: "string";
+        readonly title: "Security code label";
+        readonly description: "The input's accessible name; no visible label renders.";
+        readonly format: "icu-message";
+        readonly messageSource: "Security code";
+      };
+      readonly securityCodeDescription: {
+        readonly type: "string";
+        readonly title: "Security code description";
+        readonly description: "Helper text linked to the input; blank renders nothing.";
+        readonly format: "icu-message";
+        readonly messageSource: "The 3-4 digit number on your card";
+      };
+    };
+  };
+};
+export declare const SavedCardRemoveContent: {
+  readonly id: "saved-card-remove";
+  readonly title: "Saved Card Remove";
+  readonly description: "Copy for the remove control of an expired saved card.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly label: {
+        readonly type: "string";
+        readonly title: "Label";
+        readonly format: "icu-message";
+        readonly messageSource: "Remove card";
+      };
+      readonly failureMessage: {
+        readonly type: "string";
+        readonly title: "Failure message";
+        readonly description: "Rendered when the removal did not complete, never the server's text.";
+        readonly format: "icu-message";
+        readonly messageSource: "The card was not removed. Please try again.";
+      };
+    };
+  };
+};
+export type SavedCardsProps = ComponentPropsWithRef<'div'> & MessageLocaleProp & {
   /** Unwrapped `payment` value from the reactive runtime (arity-1 fragment, ADR-0015); `null` until resolved. */
   $data?: SavedCardsData;
   /** The per-row template, typically one `SavedCardOption`, repeated once per saved card. */
   children?: ReactNode;
-  /**
-   * The radio group's accessible name, rendered as a visible `Fieldset.Legend` (T38, Decision 1).
-   * Resolved through `resolveAuthoredCopy`: an authored empty or whitespace-only string falls back to
-   * the default rather than rendering a nameless group.
-   */
-  legend?: string;
+  /** Merchant-authored copy: the radio group's visible legend (T38). */
+  $content?: ContentValue<typeof SavedCardsContent>;
 };
 /** The full per-row slice `SavedCardOption` independently resolves via `reactive-list-item`. */
 export type SavedCardOptionSlice = Readonly<{
@@ -42,26 +124,28 @@ export type SavedCardOptionProps = ComponentPropsWithRef<'div'> & {
   /** Typically a `SavedCardCvvField`. */
   children?: ReactNode;
 };
-export type SavedCardCvvFieldProps = ComponentPropsWithRef<'input'> & {
+export type SavedCardCvvFieldProps = ComponentPropsWithRef<'input'> & MessageLocaleProp & {
   /** Compiler-injected action surface; carries `payment.sendPayments`. */
   $actions?: ComponentActions;
   /**
-   * Accessible name for the CVV input. No visible `<label>` renders (Accessibility Contract), so this
-   * is the input's only accessible name — authorable rather than a hardcoded English string.
-   */
-  securityCodeLabel?: string;
-  /**
-   * Helper copy rendered as a sibling `<p>` and linked to the input via `aria-describedby` (this
-   * component's root is the input itself, so there is no `Field.Root` to host a `Field.Description` —
-   * saved-cards.md Decision 3). An empty string renders nothing. Copy configuration only — never the
-   * security code itself.
+   * Merchant-authored copy. No visible `<label>` renders (Accessibility Contract), so
+   * `securityCodeLabel` is the input's only accessible name. `securityCodeDescription` renders as a
+   * sibling `<p>` linked through `aria-describedby` (the root is the input itself, so there is no
+   * `Field.Root` to host a `Field.Description` — saved-cards.md Decision 3).
    */
-  securityCodeDescription?: string;
+  $content?: ContentValue<typeof SavedCardCvvFieldContent>;
+};
+export type SavedCardRemoveProps = Omit<ComponentPropsWithRef<'button'>, 'children'> & MessageLocaleProp & {
+  /** Compiler-injected action surface; carries `savedCard.remove`. */
+  $actions?: ComponentActions;
+  /** Merchant-authored copy: the control's text and the message when the removal did not complete. */
+  $content?: ContentValue<typeof SavedCardRemoveContent>;
 };
 export declare const SavedCardsDefinition: ComponentDefinition<SavedCardsProps>;
 export declare const SavedCardOptionDefinition: ComponentDefinition<SavedCardOptionProps>;
 export declare const SavedCardCvvFieldDefinition: ComponentDefinition<SavedCardCvvFieldProps>;
-export declare function SavedCards({ $data: $dataProp, legend, className, children, ...props }: SavedCardsProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const SavedCardRemoveDefinition: ComponentDefinition<SavedCardRemoveProps>;
+export declare function SavedCards({ $data: $dataProp, $content, $locale, className, children, ...props }: SavedCardsProps): import("react/jsx-runtime").JSX.Element | null;
 export declare function SavedCardOption({ $data: $dataProp, className, children, ...props }: SavedCardOptionProps): import("react/jsx-runtime").JSX.Element | null;
 /**
  * The saved-card path's own client-synthesized refusal (T27, specs/place-order-preflight-card-
@@ -74,6 +158,14 @@ export declare function SavedCardOption({ $data: $dataProp, className, children,
  * `PaymentUserError` (spec NFR-1, Risk R9).
  */
 export declare const SAVED_CARD_INVALID_SECURITY_CODE = "INVALID_SECURITY_CODE";
-export declare function SavedCardCvvField({ $actions: $actionsProp, securityCodeLabel, securityCodeDescription, className, ...props }: SavedCardCvvFieldProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function SavedCardCvvField({ $actions: $actionsProp, $content, $locale, className, ...props }: SavedCardCvvFieldProps): import("react/jsx-runtime").JSX.Element | null;
+/**
+ * Removes an expired saved card (T216). Renders only for a row whose `expired` is the literal `true`. A
+ * success evicts the row's `SavedCard` entity, which is what the checkout list reads; the SDK action only
+ * updates the account's own `CustomerSavedCards` entity. Anything else, including a missing action, leaves
+ * the row and says so with its failureMessage, never the server's message. A caller's `onClick` runs first, and
+ * calling `event.preventDefault()` there cancels the removal.
+ */
+export declare function SavedCardRemove({ $actions: $actionsProp, $content, $locale, className, onClick, ...props }: SavedCardRemoveProps): import("react/jsx-runtime").JSX.Element | null;
 //#endregion
 //# sourceMappingURL=saved-cards.d.ts.map