@vtex/faststore 0.0.10 → 0.0.11

package/dist/matter/shipping-simulator/shipping-simulator.d.ts

@@ -1,10 +1,11 @@
+import { ContentValue, MessageLocaleProp } from "../../core/dist/define-content-type.js";
 import { ComponentDefinition } from "../../core/dist/define-component.js";
 import "../../core/dist/index.js";
-import "../../sdk/i18n/client.js";
 import { CartShippingSimulateInput, ShippingSimulateInput } from "../../sdk/generated/graphql.js";
 import "../../sdk/shipping/cart-operations.js";
 import "../../sdk/shipping/operations.js";
-import { ComponentPropsWithRef } from "react";
+import "../order-placed/order-placed-deliveries.js";
+import { ComponentPropsWithRef, ReactElement } from "react";
 //#region src/matter/shipping-simulator/shipping-simulator.d.ts
 type RawShippingSimulatorData = {
   variants: {
@@ -37,7 +38,7 @@ export type ShippingOption = {
   price: MoneyValue;
   listPrice: MoneyValue;
 };
-type ShippingSimulateErrorCode = 'INVALID_POSTAL_CODE' | 'UNKNOWN';
+type ShippingSimulateErrorCode = 'INVALID_POSTAL_CODE' | 'UNKNOWN' | 'CALCULATION_FAILED';
 export type ShippingSimulateError = {
   code: ShippingSimulateErrorCode;
   message: string;
@@ -65,50 +66,275 @@ export type CartShippingSimulatorRootProps = ComponentPropsWithRef<'div'> & {
   onResult?: (result: ShippingSimulationPayload) => void;
 };
 export type ShippingSimulatorFormProps = ComponentPropsWithRef<'form'>;
-export type ShippingSimulatorInputProps = Omit<ComponentPropsWithRef<'input'>, 'value' | 'onChange'> & {
+export type ShippingSimulatorInputProps = Omit<ComponentPropsWithRef<'input'>, 'value' | 'onChange' | 'placeholder' | 'aria-label'> & MessageLocaleProp & {
   format?: boolean;
+  $content?: ContentValue<typeof ShippingSimulatorInputContent>;
 };
 export type ShippingSimulatorSubmitProps = ComponentPropsWithRef<'button'>;
-export type ShippingSimulatorLoadingProps = ComponentPropsWithRef<'output'>;
-export type ShippingSimulatorErrorProps = ComponentPropsWithRef<'div'>;
+export type ShippingSimulatorLoadingProps = ComponentPropsWithRef<'output'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof ShippingSimulatorLoadingContent>;
+};
+export type ShippingSimulatorErrorProps = ComponentPropsWithRef<'div'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof ShippingSimulatorErrorContent>;
+};
 export type ShippingSimulatorOptionsProps = ComponentPropsWithRef<'ul'> & {
   sortBy?: 'price' | 'estimate';
   maxOptions?: number;
 };
+/** An option under `ShippingSimulatorOptions` renders an `li`. */
 export type ShippingSimulatorOptionProps = ComponentPropsWithRef<'li'>;
+/** An option outside `ShippingSimulatorOptions`, such as under `DeliveryOptionsRoot`, renders a `div`. */
+export type ShippingSimulatorOptionBlockProps = ComponentPropsWithRef<'div'>;
 export type ShippingSimulatorOptionNameProps = ComponentPropsWithRef<'span'>;
-export type ShippingSimulatorOptionEstimateProps = ComponentPropsWithRef<'span'>;
-export type ShippingSimulatorOptionPriceProps = ComponentPropsWithRef<'span'>;
-export type ShippingSimulatorOptionFreeBadgeProps = ComponentPropsWithRef<'span'>;
-export type ShippingSimulatorEmptyProps = ComponentPropsWithRef<'output'>;
+export type ShippingSimulatorOptionEstimateProps = ComponentPropsWithRef<'span'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof ShippingSimulatorOptionEstimateContent>;
+};
+export type ShippingSimulatorOptionPriceProps = ComponentPropsWithRef<'span'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof ShippingSimulatorOptionPriceContent>;
+};
+export type ShippingSimulatorOptionFreeBadgeProps = ComponentPropsWithRef<'span'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof ShippingSimulatorOptionFreeBadgeContent>;
+};
+export type ShippingSimulatorEmptyProps = ComponentPropsWithRef<'output'> & MessageLocaleProp & {
+  $content?: ContentValue<typeof ShippingSimulatorEmptyContent>;
+};
 export declare const ShippingSimulatorRootDefinition: ComponentDefinition<ShippingSimulatorRootProps>;
 export declare const CartShippingSimulatorRootDefinition: ComponentDefinition<CartShippingSimulatorRootProps>;
 export declare const ShippingSimulatorFormDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>>;
+export declare const ShippingSimulatorInputContent: {
+  readonly id: "shipping-simulator-input";
+  readonly title: "Shipping Simulator Input";
+  readonly description: "The postal code input's accessible name and placeholder.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly ariaLabel: {
+        readonly type: "string";
+        readonly title: "Accessible name";
+        readonly format: "icu-message";
+        readonly messageSource: "Postal code";
+      };
+      readonly placeholder: {
+        readonly type: "string";
+        readonly title: "Placeholder";
+        readonly format: "icu-message";
+        readonly messageSource: "Enter your postal code";
+      };
+    };
+  };
+};
 export declare const ShippingSimulatorInputDefinition: ComponentDefinition<ShippingSimulatorInputProps>;
 export declare const ShippingSimulatorSubmitDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>>;
-export declare const ShippingSimulatorLoadingDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").OutputHTMLAttributes<HTMLOutputElement>, HTMLOutputElement>>;
-export declare const ShippingSimulatorErrorDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
+export declare const ShippingSimulatorLoadingContent: {
+  readonly id: "shipping-simulator-loading";
+  readonly title: "Shipping Simulator Loading";
+  readonly description: "Text shown while a simulation runs.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly title: "Loading text";
+        readonly format: "icu-message";
+        readonly messageSource: "Calculating…";
+      };
+    };
+  };
+};
+export declare const ShippingSimulatorLoadingDefinition: ComponentDefinition<ShippingSimulatorLoadingProps>;
+export declare const ShippingSimulatorErrorContent: {
+  readonly id: "shipping-simulator-error";
+  readonly title: "Shipping Simulator Error";
+  readonly description: "Messages shown when the shipping cannot be calculated, one per error code.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly calculationFailed: {
+        readonly type: "string";
+        readonly title: "Calculation failed message";
+        readonly description: "Shown when a store-supplied simulation callback fails.";
+        readonly format: "icu-message";
+        readonly messageSource: "Unable to calculate shipping. Try again.";
+      };
+      readonly invalidPostalCode: {
+        readonly type: "string";
+        readonly title: "Invalid postal code";
+        readonly description: "Shown when the postal code is not found or is rejected.";
+        readonly format: "icu-message";
+        readonly messageSource: "Enter a valid postal code.";
+      };
+      readonly genericErrorMessage: {
+        readonly type: "string";
+        readonly title: "Generic 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 calculate shipping. Try again.";
+      };
+    };
+  };
+};
+export declare const ShippingSimulatorErrorDefinition: ComponentDefinition<ShippingSimulatorErrorProps>;
 export declare const ShippingSimulatorOptionsDefinition: ComponentDefinition<ShippingSimulatorOptionsProps>;
 export declare const ShippingSimulatorOptionDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>>;
 export declare const ShippingSimulatorOptionNameDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>>;
-export declare const ShippingSimulatorOptionEstimateDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>>;
-export declare const ShippingSimulatorOptionPriceDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>>;
-export declare const ShippingSimulatorOptionFreeBadgeDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>>;
-export declare const ShippingSimulatorEmptyDefinition: ComponentDefinition<import("react").DetailedHTMLProps<import("react").OutputHTMLAttributes<HTMLOutputElement>, HTMLOutputElement>>;
+export declare const ShippingSimulatorOptionEstimateContent: {
+  readonly id: "shipping-simulator-option-estimate";
+  readonly title: "Shipping Simulator Option Estimate";
+  readonly description: "Delivery estimate sentences, one per unit.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly today: {
+        readonly type: "string";
+        readonly title: "Arrives today";
+        readonly format: "icu-message";
+        readonly messageSource: "arrives today";
+      };
+      readonly inBusinessDays: {
+        readonly type: "string";
+        readonly title: "In business days";
+        readonly format: "icu-message";
+        readonly messageSource: "in {days, plural, one {# business day} other {# business days}}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly days: {
+              readonly type: "integer";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly days: 3;
+        };
+      };
+      readonly inDays: {
+        readonly type: "string";
+        readonly title: "In days";
+        readonly format: "icu-message";
+        readonly messageSource: "in {days, plural, one {# day} other {# days}}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly days: {
+              readonly type: "integer";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly days: 3;
+        };
+      };
+      readonly inHours: {
+        readonly type: "string";
+        readonly title: "In hours";
+        readonly format: "icu-message";
+        readonly messageSource: "in {hours, plural, one {# hour} other {# hours}}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly hours: {
+              readonly type: "integer";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly hours: 4;
+        };
+      };
+      readonly inMinutes: {
+        readonly type: "string";
+        readonly title: "In minutes";
+        readonly format: "icu-message";
+        readonly messageSource: "in {minutes, plural, one {# minute} other {# minutes}}";
+        readonly messageArguments: {
+          readonly type: "object";
+          readonly properties: {
+            readonly minutes: {
+              readonly type: "integer";
+            };
+          };
+        };
+        readonly messageExample: {
+          readonly minutes: 30;
+        };
+      };
+    };
+  };
+};
+export declare const ShippingSimulatorOptionEstimateDefinition: ComponentDefinition<ShippingSimulatorOptionEstimateProps>;
+export declare const ShippingSimulatorOptionPriceContent: {
+  readonly id: "shipping-simulator-option-price";
+  readonly title: "Shipping Simulator Option Price";
+  readonly description: "Text shown instead of a zero shipping price.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly freeLabel: {
+        readonly type: "string";
+        readonly title: "Free price label";
+        readonly format: "icu-message";
+        readonly messageSource: "Free";
+      };
+    };
+  };
+};
+export declare const ShippingSimulatorOptionPriceDefinition: ComponentDefinition<ShippingSimulatorOptionPriceProps>;
+export declare const ShippingSimulatorOptionFreeBadgeContent: {
+  readonly id: "shipping-simulator-option-free-badge";
+  readonly title: "Shipping Simulator Option Free Badge";
+  readonly description: "Badge text of a free shipping option.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly title: "Badge text";
+        readonly format: "icu-message";
+        readonly messageSource: "Free shipping";
+      };
+    };
+  };
+};
+export declare const ShippingSimulatorOptionFreeBadgeDefinition: ComponentDefinition<ShippingSimulatorOptionFreeBadgeProps>;
+export declare const ShippingSimulatorEmptyContent: {
+  readonly id: "shipping-simulator-empty";
+  readonly title: "Shipping Simulator Empty";
+  readonly description: "Message shown when a simulation returns no shipping options.";
+  readonly schema: {
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+      readonly text: {
+        readonly type: "string";
+        readonly title: "Empty message";
+        readonly format: "icu-message";
+        readonly messageSource: "No delivery options available for this address.";
+      };
+    };
+  };
+};
+export declare const ShippingSimulatorEmptyDefinition: ComponentDefinition<ShippingSimulatorEmptyProps>;
 export declare function ShippingSimulatorRoot({ country, quantity, variantId: variantIdProp, seller: sellerProp, $data: $dataProp, shippingOptions: shippingOptionsProp, userErrors: userErrorsProp, onSimulate: onSimulateProp, onResult, className, children, ...props }: ShippingSimulatorRootProps): import("react/jsx-runtime").JSX.Element;
 export declare function CartShippingSimulatorRoot({ country, shippingOptions: shippingOptionsProp, userErrors: userErrorsProp, onSimulate: onSimulateProp, onResult, className, children, ...props }: CartShippingSimulatorRootProps): import("react/jsx-runtime").JSX.Element;
 export declare function ShippingSimulatorForm({ className, children, ...props }: ShippingSimulatorFormProps): import("react/jsx-runtime").JSX.Element;
-export declare function ShippingSimulatorInput({ className, placeholder, 'aria-label': ariaLabel, format, ...props }: ShippingSimulatorInputProps): import("react/jsx-runtime").JSX.Element;
+export declare function ShippingSimulatorInput({ $content, $locale, className, format, ...props }: ShippingSimulatorInputProps): import("react/jsx-runtime").JSX.Element;
 export declare function ShippingSimulatorSubmit({ className, children, disabled, ...props }: ShippingSimulatorSubmitProps): import("react/jsx-runtime").JSX.Element;
-export declare function ShippingSimulatorLoading({ className, children, ...props }: ShippingSimulatorLoadingProps): import("react/jsx-runtime").JSX.Element | null;
-export declare function ShippingSimulatorError({ className, children, ...props }: ShippingSimulatorErrorProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function ShippingSimulatorLoading({ $content, $locale, className, children, ...props }: ShippingSimulatorLoadingProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function ShippingSimulatorError({ $content, $locale, className, children, ...props }: ShippingSimulatorErrorProps): import("react/jsx-runtime").JSX.Element | null;
 export declare function ShippingSimulatorOptions({ sortBy, maxOptions, className, children, ...props }: ShippingSimulatorOptionsProps): import("react/jsx-runtime").JSX.Element | null;
-export declare function ShippingSimulatorOption({ className, children, ...props }: ShippingSimulatorOptionProps): import("react/jsx-runtime").JSX.Element;
+export declare function ShippingSimulatorOption(props: ShippingSimulatorOptionProps): ReactElement;
+export declare function ShippingSimulatorOption(props: ShippingSimulatorOptionBlockProps): ReactElement;
 export declare function ShippingSimulatorOptionName({ className, children, ...props }: ShippingSimulatorOptionNameProps): import("react/jsx-runtime").JSX.Element;
-export declare function ShippingSimulatorOptionEstimate({ className, children, ...props }: ShippingSimulatorOptionEstimateProps): import("react/jsx-runtime").JSX.Element;
-export declare function ShippingSimulatorOptionPrice({ className, children, ...props }: ShippingSimulatorOptionPriceProps): import("react/jsx-runtime").JSX.Element;
-export declare function ShippingSimulatorOptionFreeBadge({ className, children, ...props }: ShippingSimulatorOptionFreeBadgeProps): import("react/jsx-runtime").JSX.Element | null;
-export declare function ShippingSimulatorEmpty({ className, children, ...props }: ShippingSimulatorEmptyProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function ShippingSimulatorOptionEstimate({ $content, $locale, className, children, ...props }: ShippingSimulatorOptionEstimateProps): import("react/jsx-runtime").JSX.Element;
+export declare function ShippingSimulatorOptionPrice({ $content, $locale, className, children, ...props }: ShippingSimulatorOptionPriceProps): import("react/jsx-runtime").JSX.Element;
+export declare function ShippingSimulatorOptionFreeBadge({ $content, $locale, className, children, ...props }: ShippingSimulatorOptionFreeBadgeProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function ShippingSimulatorEmpty({ $content, $locale, className, children, ...props }: ShippingSimulatorEmptyProps): import("react/jsx-runtime").JSX.Element | null;
 export declare const ShippingSimulator: {
   Root: typeof ShippingSimulatorRoot;
   Form: typeof ShippingSimulatorForm;