@vtex/faststore 0.0.8 → 0.0.11

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

@@ -0,0 +1,463 @@
+import { ContentValue, MessageLocaleProp } from "../../core/dist/define-content-type.js";
+import { ComponentDefinition } from "../../core/dist/define-component.js";
+import "../../core/dist/index.js";
+import { CustomerSavedCardStatus } from "../../sdk/generated/graphql.js";
+import { ComponentActions } from "../../sdk/actions/types.js";
+import { ComponentPropsWithRef, ReactNode } from "react";
+//#region src/matter/account-saved-cards/account-saved-cards.d.ts
+export declare const AccountSavedCardsHeadingContent: {
+  readonly id: "account-saved-cards-heading";
+  readonly title: "Account Saved Cards Heading";
+  readonly description: "Heading of the account's saved-cards section.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Heading";
+        readonly format: "icu-message";
+        readonly messageSource: "Saved cards";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardsEmptyContent: {
+  readonly id: "account-saved-cards-empty";
+  readonly title: "Account Saved Cards Empty";
+  readonly description: "Statement shown when the shopper has no saved cards.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Empty statement";
+        readonly format: "icu-message";
+        readonly messageSource: "You have no saved cards yet.";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardsLoadingContent: {
+  readonly id: "account-saved-cards-loading";
+  readonly title: "Account Saved Cards Loading";
+  readonly description: "Announcement read to assistive technology while the saved cards load.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Loading announcement";
+        readonly format: "icu-message";
+        readonly messageSource: "Loading your saved cards…";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardsErrorContent: {
+  readonly id: "account-saved-cards-error";
+  readonly title: "Account Saved Cards Error";
+  readonly description: "Messages shown when the saved cards cannot be read.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Load failure message";
+        readonly format: "icu-message";
+        readonly messageSource: "We couldn't load your saved cards. Please try again later.";
+      };
+      readonly sessionExpiredText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Session expired message";
+        readonly format: "icu-message";
+        readonly messageSource: "Your session has expired.";
+      };
+      readonly signInLabel: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Sign-in link label";
+        readonly format: "icu-message";
+        readonly messageSource: "Sign in again";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardExpiryContent: {
+  readonly id: "account-saved-card-expiry";
+  readonly title: "Account Saved Card Expiry";
+  readonly description: "A saved card's expiry line. The date follows the label and is never authored.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly expiresLabel: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Label before a working card's date";
+        readonly format: "icu-message";
+        readonly messageSource: "Expires";
+      };
+      readonly expiredLabel: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Label before an expired card's date";
+        readonly format: "icu-message";
+        readonly messageSource: "Expired";
+      };
+      readonly expiredText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Expired card with no date";
+        readonly format: "icu-message";
+        readonly messageSource: "Expired";
+      };
+      readonly unusableText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Unusable card";
+        readonly format: "icu-message";
+        readonly messageSource: "This card can't be used";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardRemoveTriggerContent: {
+  readonly id: "account-saved-card-remove-trigger";
+  readonly title: "Account Saved Card Remove Trigger";
+  readonly description: "Label of the control that opens a saved card's removal prompt, and the card's last digits read to assistive technology.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Trigger label";
+        readonly format: "icu-message";
+        readonly messageSource: "Remove";
+      };
+      readonly cardEndingIn: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Card last digits";
+        readonly description: "Read to assistive technology after the card name.";
+        readonly format: "icu-message";
+        readonly messageSource: "ending in {lastDigits}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly lastDigits: {
+              readonly type: "string";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly lastDigits: "4242";
+        };
+      };
+    };
+  };
+};
+export declare const AccountSavedCardRemoveTitleContent: {
+  readonly id: "account-saved-card-remove-title";
+  readonly title: "Account Saved Card Remove Title";
+  readonly description: "Question that titles the removal prompt.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Prompt title";
+        readonly format: "icu-message";
+        readonly messageSource: "Remove this card?";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardRemoveDescriptionContent: {
+  readonly id: "account-saved-card-remove-body";
+  readonly title: "Account Saved Card Remove Description";
+  readonly description: "What removing the card means, shown after the card in the removal prompt, and the card's last digits read to assistive technology.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Consequence";
+        readonly format: "icu-message";
+        readonly messageSource: "It will no longer be offered when you pay. This can't be undone.";
+      };
+      readonly cardEndingIn: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Card last digits";
+        readonly description: "Read to assistive technology after the card name.";
+        readonly format: "icu-message";
+        readonly messageSource: "ending in {lastDigits}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly lastDigits: {
+              readonly type: "string";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly lastDigits: "4242";
+        };
+      };
+    };
+  };
+};
+export declare const AccountSavedCardRemoveCancelContent: {
+  readonly id: "account-saved-card-remove-cancel";
+  readonly title: "Account Saved Card Remove Cancel";
+  readonly description: "Label of the control that keeps the card.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Cancel label";
+        readonly format: "icu-message";
+        readonly messageSource: "Cancel";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardRemoveConfirmContent: {
+  readonly id: "account-saved-card-remove-confirm";
+  readonly title: "Account Saved Card Remove Confirm";
+  readonly description: "Label of the control that removes the card, and its label while the removal runs.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Confirm label";
+        readonly format: "icu-message";
+        readonly messageSource: "Remove card";
+      };
+      readonly pendingText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Label while removing";
+        readonly format: "icu-message";
+        readonly messageSource: "Removing…";
+      };
+    };
+  };
+};
+export declare const AccountSavedCardsRemoveFeedbackContent: {
+  readonly id: "account-saved-cards-remove-feedback";
+  readonly title: "Account Saved Cards Remove Feedback";
+  readonly description: "Messages that tell the shopper how a card removal ended.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly successText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Card removed";
+        readonly format: "icu-message";
+        readonly messageSource: "The card was removed.";
+      };
+      readonly failureText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Card not removed";
+        readonly format: "icu-message";
+        readonly messageSource: "We couldn't remove the card. Please try again.";
+      };
+      readonly sessionExpiredText: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Session expired message";
+        readonly format: "icu-message";
+        readonly messageSource: "Your session has expired.";
+      };
+      readonly signInLabel: {
+        readonly type: "string";
+        readonly minLength: 1;
+        readonly title: "Sign-in link label";
+        readonly format: "icu-message";
+        readonly messageSource: "Sign in again";
+      };
+    };
+  };
+};
+/** The unwrapped `customerSavedCards` entity the reactive runtime delivers to the Root. */
+export type AccountSavedCardsData = {
+  id?: string | null;
+  cards?: ReadonlyArray<{
+    id: string;
+  }> | null;
+} | null;
+/** One card's slice, delivered per row by the reactive-list-item runtime. */
+export type AccountSavedCardItemData = {
+  id: string;
+  network: {
+    name: string;
+  };
+  lastDigits: string;
+  expiry?: {
+    month: number;
+    year: number;
+  } | null;
+  status: CustomerSavedCardStatus;
+} | null;
+/** The row a resolved AccountSavedCardItem provides to the parts inside it. */
+export type AccountSavedCardContextValue = NonNullable<AccountSavedCardItemData>;
+/** `idle` is a null slice with no query in flight, such as a render with no reactive root. */
+export type AccountSavedCardsState = 'idle' | 'loading' | 'error' | 'empty' | 'ready';
+export type AccountSavedCardRemovalOutcome = Readonly<{
+  kind: 'removed';
+}> | Readonly<{
+  kind: 'failed';
+  code: string;
+}>;
+export type AccountSavedCardsRemoval = Readonly<{
+  /** Card id of the removal in flight, or null. At most one per section. */
+  pendingId: string | null;
+  /** The last removal's outcome, or null before any and after begin(). */
+  outcome: AccountSavedCardRemovalOutcome | null;
+  /** Starts a removal. False, with no state change, while another is pending. */
+  begin: (id: string) => boolean;
+  /** Ends the pending removal with the action's userErrors (empty on success). */
+  settle: (id: string, userErrors: readonly {
+    code: string;
+  }[]) => void;
+}>;
+export type AccountSavedCardsContextValue = Readonly<{
+  state: AccountSavedCardsState;
+  cards: ReadonlyArray<{
+    id: string;
+  }>;
+  /** `extensions.code` of the read's error, or `null`. Set only in the `error` state. */
+  errorCode: string | null;
+  removal: AccountSavedCardsRemoval;
+}>;
+export type AccountSavedCardsRootProps = ComponentPropsWithRef<'div'> & {
+  $data?: AccountSavedCardsData;
+  /** Injected by the compiler from `actions: { savedCard: ['remove'] }`, for every remove control inside. */
+  $actions?: ComponentActions;
+};
+export type AccountSavedCardsHeadingLevel = 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export type AccountSavedCardsHeadingProps = ComponentPropsWithRef<'h2'> & MessageLocaleProp & {
+  /** Heading level. `h1` is excluded: the page title belongs to the page shell. Defaults to `h2`. */
+  as?: AccountSavedCardsHeadingLevel;
+  $content?: ContentValue<typeof AccountSavedCardsHeadingContent>;
+};
+export type AccountSavedCardsListProps = ComponentPropsWithRef<'ul'> & {
+  /** The per-row template, typically one AccountSavedCardItem. */
+  children?: ReactNode;
+};
+export type AccountSavedCardItemProps = ComponentPropsWithRef<'li'> & {
+  /** The row's parts. The item has no default anatomy. */
+  children: ReactNode;
+  /** Per-row slice from the reactive-list-item runtime; passed directly in tests. */
+  $data?: AccountSavedCardItemData;
+};
+export type AccountSavedCardExpiryProps = Omit<ComponentPropsWithRef<'p'>, 'children'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardExpiryContent>;
+};
+export type AccountSavedCardsEmptyProps = ComponentPropsWithRef<'p'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardsEmptyContent>;
+};
+export type AccountSavedCardsLoadingProps = Omit<ComponentPropsWithRef<'div'>, 'children'> & MessageLocaleProp & {
+  /** Placeholder rows shown while the cards load. Defaults to 2. */
+  skeletonCount?: number;
+  $content?: ContentValue<typeof AccountSavedCardsLoadingContent>;
+};
+export type AccountSavedCardsErrorProps = ComponentPropsWithRef<'div'> & MessageLocaleProp & {
+  /** Replaces the message for every error code and drops the sign-in link. */
+  children?: ReactNode;
+  $content?: ContentValue<typeof AccountSavedCardsErrorContent>;
+};
+/** The remove controller a row's prompt parts read. */
+export type AccountSavedCardRemoveValue = Readonly<{
+  id: string;
+  /** This card's removal is pending. */
+  pending: boolean;
+  /** Any removal in the section is pending. */
+  blocked: boolean;
+  close: () => void;
+}>;
+export type AccountSavedCardRemoveProps = {
+  /** One AlertDialogRoot to control. */
+  children: ReactNode;
+};
+export type AccountSavedCardRemoveTriggerProps = ComponentPropsWithRef<'button'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardRemoveTriggerContent>;
+};
+export type AccountSavedCardRemoveTitleProps = ComponentPropsWithRef<'h2'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardRemoveTitleContent>;
+};
+export type AccountSavedCardRemoveDescriptionProps = ComponentPropsWithRef<'p'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardRemoveDescriptionContent>;
+};
+export type AccountSavedCardRemoveCancelProps = ComponentPropsWithRef<'button'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardRemoveCancelContent>;
+};
+export type AccountSavedCardRemoveConfirmProps = ComponentPropsWithRef<'button'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardRemoveConfirmContent>;
+};
+export type AccountSavedCardsRemoveFeedbackProps = Omit<ComponentPropsWithRef<'div'>, 'children'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof AccountSavedCardsRemoveFeedbackContent>;
+};
+/** The section state the nearest AccountSavedCardsRoot publishes. Throws outside one. */
+export declare function useAccountSavedCards(): AccountSavedCardsContextValue;
+/** The card the nearest AccountSavedCardItem provides. Throws outside one. */
+export declare function useAccountSavedCard(): AccountSavedCardContextValue;
+/** The remove controller the nearest AccountSavedCardRemove provides. Throws outside one. */
+export declare function useAccountSavedCardRemove(): AccountSavedCardRemoveValue;
+export declare const AccountSavedCardsRootDefinition: ComponentDefinition<AccountSavedCardsRootProps>;
+export declare const AccountSavedCardsHeadingDefinition: ComponentDefinition<AccountSavedCardsHeadingProps>;
+export declare const AccountSavedCardsListDefinition: ComponentDefinition<AccountSavedCardsListProps>;
+export declare const AccountSavedCardItemDefinition: ComponentDefinition<AccountSavedCardItemProps>;
+export declare const AccountSavedCardExpiryDefinition: ComponentDefinition<AccountSavedCardExpiryProps>;
+export declare const AccountSavedCardsEmptyDefinition: ComponentDefinition<AccountSavedCardsEmptyProps>;
+export declare const AccountSavedCardsLoadingDefinition: ComponentDefinition<AccountSavedCardsLoadingProps>;
+export declare const AccountSavedCardsErrorDefinition: ComponentDefinition<AccountSavedCardsErrorProps>;
+export declare const AccountSavedCardRemoveDefinition: ComponentDefinition<AccountSavedCardRemoveProps>;
+export declare const AccountSavedCardRemoveTriggerDefinition: ComponentDefinition<AccountSavedCardRemoveTriggerProps>;
+export declare const AccountSavedCardRemoveTitleDefinition: ComponentDefinition<AccountSavedCardRemoveTitleProps>;
+export declare const AccountSavedCardRemoveDescriptionDefinition: ComponentDefinition<AccountSavedCardRemoveDescriptionProps>;
+export declare const AccountSavedCardRemoveCancelDefinition: ComponentDefinition<AccountSavedCardRemoveCancelProps>;
+export declare const AccountSavedCardRemoveConfirmDefinition: ComponentDefinition<AccountSavedCardRemoveConfirmProps>;
+export declare const AccountSavedCardsRemoveFeedbackDefinition: ComponentDefinition<AccountSavedCardsRemoveFeedbackProps>;
+export declare function AccountSavedCardsRoot({ $data: $dataProp, $actions: $actionsProp, className, children, ...props }: AccountSavedCardsRootProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountSavedCardsHeading({ as: Tag, $content, $locale, className, children, ...props }: AccountSavedCardsHeadingProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardsList({ className, children, ...props }: AccountSavedCardsListProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountSavedCardItem({ $data: $dataProp, className, children, ...props }: AccountSavedCardItemProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountSavedCardExpiry({ $content, $locale, className, ...props }: AccountSavedCardExpiryProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountSavedCardsEmpty({ $content, $locale, className, children, ...props }: AccountSavedCardsEmptyProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountSavedCardsLoading({ skeletonCount, $content, $locale, className, ...props }: AccountSavedCardsLoadingProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardsError({ $content, $locale, className, children, ...props }: AccountSavedCardsErrorProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function AccountSavedCardRemove({ children }: Readonly<AccountSavedCardRemoveProps>): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardRemoveTrigger({ $content, $locale, className, children, disabled, ...props }: AccountSavedCardRemoveTriggerProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardRemoveTitle({ $content, $locale, className, children, ...props }: AccountSavedCardRemoveTitleProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardRemoveDescription({ $content, $locale, className, children, ...props }: AccountSavedCardRemoveDescriptionProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardRemoveCancel({ $content, $locale, className, children, disabled, ...props }: AccountSavedCardRemoveCancelProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardRemoveConfirm({ $content, $locale, className, children, onClick, ...props }: AccountSavedCardRemoveConfirmProps): import("react/jsx-runtime").JSX.Element;
+export declare function AccountSavedCardsRemoveFeedback({ $content, $locale, className, ...props }: AccountSavedCardsRemoveFeedbackProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+//# sourceMappingURL=account-saved-cards.d.ts.map