@vtex/faststore 0.0.8 → 0.0.11

package/dist/matter/cart-destination/cart-destination.d.ts

@@ -0,0 +1,233 @@
+import { ContentValue, MessageLocaleProp } from "../../core/dist/define-content-type.js";
+import { ComponentDefinition } from "../../core/dist/define-component.js";
+import "../../core/dist/index.js";
+import { ShippingAddressUpdateErrorEntity } from "../../sdk/shipping/shipping-operations.js";
+import { ComponentActions } from "../../sdk/actions/types.js";
+import { CountryRules } from "../../sdk/address/types.js";
+import { ComponentPropsWithRef, ReactNode } from "react";
+//#region src/matter/cart-destination/cart-destination.d.ts
+export declare const CartDestinationValueContent: {
+  readonly id: "cart-destination-value";
+  readonly title: "Cart Destination Value";
+  readonly description: "Copy that precedes the destination in read mode.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly prefix: {
+        readonly type: "string";
+        readonly title: "Prefix";
+      };
+    };
+  };
+};
+export declare const CartDestinationChangeContent: {
+  readonly id: "cart-destination-change";
+  readonly title: "Cart Destination Change";
+  readonly description: "Copy for the control that opens edit mode.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly label: {
+        readonly type: "string";
+        readonly title: "Button label";
+      };
+    };
+  };
+};
+export declare const CartDestinationSubmitContent: {
+  readonly id: "cart-destination-submit";
+  readonly title: "Cart Destination Submit";
+  readonly description: "Copy for the control that writes the destination.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly label: {
+        readonly type: "string";
+        readonly title: "Button label";
+      };
+      readonly pendingLabel: {
+        readonly type: "string";
+        readonly title: "Pending label";
+      };
+    };
+  };
+};
+export declare const CartDestinationCancelContent: {
+  readonly id: "cart-destination-cancel";
+  readonly title: "Cart Destination Cancel";
+  readonly description: "Copy for the control that closes edit mode without writing.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly label: {
+        readonly type: "string";
+        readonly title: "Button label";
+      };
+    };
+  };
+};
+export declare const CartDestinationErrorContent: {
+  readonly id: "cart-destination-error";
+  readonly title: "Cart Destination Error";
+  readonly description: "Messages shown when the destination write is refused, one per error code the shopper can act on.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly genericMessage: {
+        readonly type: "string";
+        readonly title: "Failure message";
+        readonly description: "Shown for a network failure and for every refusal the shopper cannot act on.";
+        readonly format: "icu-message";
+        readonly messageSource: "Unable to update the delivery location. Please try again.";
+      };
+      readonly invalidPostalCodeMessage: {
+        readonly type: "string";
+        readonly title: "Invalid postal code message";
+        readonly description: "Shown when the server rejects the postal code.";
+        readonly format: "icu-message";
+        readonly messageSource: "Enter a valid postal code.";
+      };
+    };
+  };
+};
+/**
+ * The `shipping` slice forwarded by the reactive runtime: the value of the `shipping` top-level field
+ * of `CartDestinationData on Query`, `null` while it has not resolved.
+ */
+export type CartDestinationEntity = {
+  __typename?: 'Shipping';
+  id?: string;
+  address?: {
+    __typename?: 'Address';
+    id?: string | null;
+    postalCode?: string | null;
+    country?: string | null;
+    city?: string | null;
+    state?: string | null;
+  } | null;
+};
+export type CartDestinationRootProps = ComponentPropsWithRef<'div'> & {
+  /** Country used while the cart has no address yet. */
+  defaultCountry?: string;
+  $data?: CartDestinationEntity | null;
+  /** Injected by the compiler from `actions: { shipping: ['setAddress'] }`. */
+  $actions?: ComponentActions;
+  children?: ReactNode;
+};
+export type CartDestinationReadProps = ComponentPropsWithRef<'div'>;
+/** Children are omitted: what this renders is the cart's destination, never authored content. */
+export type CartDestinationValueProps = Omit<ComponentPropsWithRef<'span'>, 'children'> & {
+  prefix?: string;
+  /** Merchant-authored copy; wins over the prop when present. */
+  $content?: ContentValue<typeof CartDestinationValueContent>;
+};
+export type CartDestinationUnsetProps = ComponentPropsWithRef<'button'>;
+export type CartDestinationChangeProps = ComponentPropsWithRef<'button'> & {
+  label?: string;
+  $content?: ContentValue<typeof CartDestinationChangeContent>;
+};
+export type CartDestinationFormProps = ComponentPropsWithRef<'form'>;
+export type CartDestinationPostalCodeControlProps = {
+  className?: string;
+  label?: string;
+  /** Wins over the example the country's rules give. */
+  placeholder?: string;
+  /** The field's own message for a draft that fails the country's postal code rules. */
+  invalidMessage?: string;
+};
+export type CartDestinationSubmitProps = ComponentPropsWithRef<'button'> & {
+  label?: string;
+  pendingLabel?: string;
+  $content?: ContentValue<typeof CartDestinationSubmitContent>;
+};
+export type CartDestinationCancelProps = ComponentPropsWithRef<'button'> & {
+  label?: string;
+  $content?: ContentValue<typeof CartDestinationCancelContent>;
+};
+/** Children are omitted: what this renders is the message for the write's error code. */
+export type CartDestinationErrorProps = Omit<ComponentPropsWithRef<'div'>, 'children'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof CartDestinationErrorContent>;
+};
+export type CartDestinationContextValue = Readonly<{
+  /** The cart's postal code, from `$data` only; null until a destination is set. */
+  postalCode: string | null;
+  city: string | null;
+  state: string | null;
+  /** The address country, else the root's `defaultCountry`. */
+  country: string;
+  /** The root query is in flight and no address is cached yet. */
+  loading: boolean;
+  /** Edit mode. Local to the root, `false` on mount. */
+  editing: boolean;
+  startEditing: () => void;
+  /** Closes edit mode and discards the draft and the errors; writes nothing. */
+  cancel: () => void;
+  draft: string;
+  setDraft: (value: string) => void;
+  /**
+   * The country's rules for edit mode. `null` while they load, and when the load failed or the
+   * country is outside the library: the draft is then free text and nothing validates it.
+   */
+  rules: CountryRules | null;
+  /** The rules are still loading: the field and Submit stay disabled. */
+  rulesLoading: boolean;
+  /** The draft is valid for the country, different from the current one, and no write is pending. */
+  canSubmit: boolean;
+  pending: boolean;
+  errors: readonly ShippingAddressUpdateErrorEntity[];
+  /** The last submit was refused locally. */
+  invalid: boolean;
+  submit: () => void;
+}>;
+/**
+ * Read the destination and the edit-mode state from the nearest `CartDestinationRoot`. Throws outside
+ * one: a misplaced part is a composition bug the author should see at once.
+ */
+export declare function useCartDestination(): CartDestinationContextValue;
+export declare const CartDestinationRootDefinition: ComponentDefinition<CartDestinationRootProps>;
+export declare const CartDestinationReadDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+export declare const CartDestinationValueDefinition: ComponentDefinition<CartDestinationValueProps>;
+export declare const CartDestinationUnsetDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>>;
+export declare const CartDestinationChangeDefinition: ComponentDefinition<CartDestinationChangeProps>;
+export declare const CartDestinationFormDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>>;
+export declare const CartDestinationPostalCodeControlDefinition: ComponentDefinition<CartDestinationPostalCodeControlProps>;
+export declare const CartDestinationSubmitDefinition: ComponentDefinition<CartDestinationSubmitProps>;
+export declare const CartDestinationCancelDefinition: ComponentDefinition<CartDestinationCancelProps>;
+export declare const CartDestinationErrorDefinition: ComponentDefinition<CartDestinationErrorProps>;
+/**
+ * Reads the cart destination reactively and publishes it, the edit-mode flag, the draft and the write
+ * state as `cartDestination` context.
+ *
+ * The destination is never copied into state: the Value renders only what `$data` resolves, and a
+ * successful write updates it solely by the mutation payload normalizing into the Apollo cache. A
+ * rejected write therefore needs no rollback.
+ */
+export declare function CartDestinationRoot({ defaultCountry, $data: $dataProp, $actions: $actionsProp, className, children, ...props }: CartDestinationRootProps): import("react/jsx-runtime").JSX.Element;
+export declare function CartDestinationRead({ className, children, ...props }: CartDestinationReadProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function CartDestinationValue({ prefix, $content, className, ...props }: CartDestinationValueProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function CartDestinationUnset({ className, children, onClick, ...props }: CartDestinationUnsetProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function CartDestinationChange({ label, $content, className, children, ...props }: CartDestinationChangeProps): import("react/jsx-runtime").JSX.Element;
+export declare function CartDestinationForm({ className, children, ...props }: CartDestinationFormProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function CartDestinationPostalCodeControl({ className, label, placeholder, invalidMessage }: Readonly<CartDestinationPostalCodeControlProps>): import("react/jsx-runtime").JSX.Element;
+export declare function CartDestinationSubmit({ label, pendingLabel, $content, className, children, ...props }: CartDestinationSubmitProps): import("react/jsx-runtime").JSX.Element;
+export declare function CartDestinationCancel({ label, $content, className, children, ...props }: CartDestinationCancelProps): import("react/jsx-runtime").JSX.Element;
+export declare function CartDestinationError({ $content, $locale, className, ...props }: CartDestinationErrorProps): import("react/jsx-runtime").JSX.Element | null;
+export declare const CartDestination: {
+  Root: typeof CartDestinationRoot;
+  Read: typeof CartDestinationRead;
+  Value: typeof CartDestinationValue;
+  Unset: typeof CartDestinationUnset;
+  Change: typeof CartDestinationChange;
+  Form: typeof CartDestinationForm;
+  PostalCodeControl: typeof CartDestinationPostalCodeControl;
+  Submit: typeof CartDestinationSubmit;
+  Cancel: typeof CartDestinationCancel;
+  Error: typeof CartDestinationError;
+};
+//#endregion
+//# sourceMappingURL=cart-destination.d.ts.map