@dropins/storefront-checkout 0.1.0-alpha4 → 0.1.0-alpha40

package/data/models/store-config.d.ts

@@ -0,0 +1,17 @@
+export declare enum TaxDisplay {
+    EXCLUDING_TAX = "EXCLUDING_TAX",
+    INCLUDING_EXCLUDING_TAX = "INCLUDING_AND_EXCLUDING_TAX",
+    INCLUDING_TAX = "INCLUDING_TAX"
+}
+export interface StoreConfig {
+    defaultCountry: string;
+    countriesWithRequiredRegion: string[];
+    displayStateIfOptional: boolean;
+    countriesWithOptionalZipCode: string[];
+    isGuestCheckoutEnabled: boolean;
+    isOnePageCheckoutEnabled: boolean;
+    shoppingCartDisplaySetting: {
+        shipping: TaxDisplay;
+    };
+}
+//# sourceMappingURL=store-config.d.ts.map

package/data/transforms/index.d.ts

@@ -0,0 +1,12 @@
+export * from './transform-acdl';
+export * from './transform-address-form-fields';
+export * from './transform-cart';
+export * from './transform-countries';
+export * from './transform-customer';
+export * from './transform-email-availability';
+export * from './transform-order';
+export * from './transform-regions';
+export * from './transform-shipping-estimate';
+export * from './transform-shipping-methods';
+export * from './transform-store-config';
+//# sourceMappingURL=index.d.ts.map

package/data/transforms/transform-acdl.d.ts

@@ -0,0 +1,6 @@
+import { OrderContext, ShoppingCartContext } from '../models/acdl';
+import { Order } from '../models/order';
+
+export declare const transformShoppingCartContext: (order: Order) => ShoppingCartContext;
+export declare const transformOrderContext: (order: Order) => OrderContext;
+//# sourceMappingURL=transform-acdl.d.ts.map

package/data/transforms/transform-address-form-fields.d.ts

@@ -0,0 +1,66 @@
+import { FetchAddressFormFieldsQuery, ValidationRuleEnum } from '../../__generated__/types';
+import { AddressFormField } from '../models';
+
+type AttributesForm = FetchAddressFormFieldsQuery['attributesForm'];
+declare const transformAddressFormFields: (data: ({
+    __typename?: "AttributeMetadata" | undefined;
+    frontend_input?: import('../../__generated__/types').AttributeFrontendInputEnum | null | undefined;
+    code: string;
+    label?: string | null | undefined;
+    default_value?: string | null | undefined;
+    is_required: boolean;
+    options: ({
+        __typename?: "AttributeOptionMetadata" | undefined;
+        label: string;
+        value: string;
+        is_default: boolean;
+    } | null)[];
+} | {
+    __typename?: "CatalogAttributeMetadata" | undefined;
+    frontend_input?: import('../../__generated__/types').AttributeFrontendInputEnum | null | undefined;
+    code: string;
+    label?: string | null | undefined;
+    default_value?: string | null | undefined;
+    is_required: boolean;
+    options: ({
+        __typename?: "AttributeOptionMetadata" | undefined;
+        label: string;
+        value: string;
+        is_default: boolean;
+    } | null)[];
+} | {
+    __typename?: "CustomerAttributeMetadata" | undefined;
+    multiline_count?: number | null | undefined;
+    sort_order?: number | null | undefined;
+    frontend_input?: import('../../__generated__/types').AttributeFrontendInputEnum | null | undefined;
+    code: string;
+    label?: string | null | undefined;
+    default_value?: string | null | undefined;
+    is_required: boolean;
+    validate_rules?: ({
+        __typename?: "ValidationRule" | undefined;
+        name?: ValidationRuleEnum | null | undefined;
+        value?: string | null | undefined;
+    } | null)[] | null | undefined;
+    options: ({
+        __typename?: "AttributeOptionMetadata" | undefined;
+        label: string;
+        value: string;
+        is_default: boolean;
+    } | null)[];
+} | {
+    __typename?: "ReturnItemAttributeMetadata" | undefined;
+    frontend_input?: import('../../__generated__/types').AttributeFrontendInputEnum | null | undefined;
+    code: string;
+    label?: string | null | undefined;
+    default_value?: string | null | undefined;
+    is_required: boolean;
+    options: ({
+        __typename?: "AttributeOptionMetadata" | undefined;
+        label: string;
+        value: string;
+        is_default: boolean;
+    } | null)[];
+} | null)[]) => AddressFormField[];
+export { AttributesForm, transformAddressFormFields };
+//# sourceMappingURL=transform-address-form-fields.d.ts.map

package/data/transforms/transform-address.d.ts

@@ -0,0 +1,89 @@
+import { GetCartQuery } from '../../__generated__/types';
+import { ShippingAddress as ShippingAddressModel, BillingAddress as BillingAddressModel } from '../models/address';
+import { CustomAttribute as CustomAttributeModel } from '../models';
+
+type ShippingAddresses = NonNullable<GetCartQuery['cart']>['shipping_addresses'];
+type ShippingAddress = ShippingAddresses[0];
+type NonNullableShippingAddress = NonNullable<ShippingAddress>;
+type BillingAddress = NonNullable<GetCartQuery['cart']>['billing_address'];
+type NonNullableBillingAddress = NonNullable<BillingAddress>;
+type CustomAttributes = NonNullableShippingAddress['custom_attributes'] | NonNullableBillingAddress['custom_attributes'];
+export declare const transformCustomAttributes: (data: CustomAttributes) => CustomAttributeModel[];
+declare const transformBillingAddress: (data: BillingAddress) => BillingAddressModel | undefined;
+declare const transformShippingAddresses: (data: ({
+    __typename?: "ShippingCartAddress" | undefined;
+    firstname: string;
+    lastname: string;
+    company?: string | null | undefined;
+    street: (string | null)[];
+    city: string;
+    postcode?: string | null | undefined;
+    vat_id?: string | null | undefined;
+    telephone?: string | null | undefined;
+    region?: {
+        __typename?: "CartAddressRegion" | undefined;
+        region_id?: number | null | undefined;
+        code?: string | null | undefined;
+        label?: string | null | undefined;
+    } | null | undefined;
+    country: {
+        __typename?: "CartAddressCountry" | undefined;
+        code: string;
+        label: string;
+    };
+    custom_attributes: ({
+        __typename?: "AttributeSelectedOptions" | undefined;
+    } | {
+        __typename?: "AttributeValue" | undefined;
+        code: string;
+        value: string;
+    } | null)[];
+    available_shipping_methods?: ({
+        __typename?: "AvailableShippingMethod" | undefined;
+        available: boolean;
+        carrier_code: string;
+        carrier_title: string;
+        error_message?: string | null | undefined;
+        method_code?: string | null | undefined;
+        method_title?: string | null | undefined;
+        amount: {
+            __typename?: "Money" | undefined;
+            currency?: import('../../__generated__/types').CurrencyEnum | null | undefined;
+            value?: number | null | undefined;
+        };
+        price_excl_tax: {
+            __typename?: "Money" | undefined;
+            value?: number | null | undefined;
+            currency?: import('../../__generated__/types').CurrencyEnum | null | undefined;
+        };
+        price_incl_tax: {
+            __typename?: "Money" | undefined;
+            value?: number | null | undefined;
+            currency?: import('../../__generated__/types').CurrencyEnum | null | undefined;
+        };
+    } | null)[] | null | undefined;
+    selected_shipping_method?: {
+        __typename?: "SelectedShippingMethod" | undefined;
+        carrier_code: string;
+        carrier_title: string;
+        method_code: string;
+        method_title: string;
+        amount: {
+            __typename?: "Money" | undefined;
+            value?: number | null | undefined;
+            currency?: import('../../__generated__/types').CurrencyEnum | null | undefined;
+        };
+        price_excl_tax: {
+            __typename?: "Money" | undefined;
+            value?: number | null | undefined;
+            currency?: import('../../__generated__/types').CurrencyEnum | null | undefined;
+        };
+        price_incl_tax: {
+            __typename?: "Money" | undefined;
+            value?: number | null | undefined;
+            currency?: import('../../__generated__/types').CurrencyEnum | null | undefined;
+        };
+    } | null | undefined;
+} | null)[]) => ShippingAddressModel[] | undefined;
+export { ShippingAddress, BillingAddress, transformBillingAddress, transformShippingAddresses, };
+//# sourceMappingURL=transform-address.d.ts.map

package/data/transforms/transform-cart.d.ts

@@ -0,0 +1,7 @@
+import { GetCartQuery } from '../../__generated__/types';
+import { Cart as CartModel } from '../models';
+
+type Cart = NonNullable<GetCartQuery['cart']>;
+declare const transformCart: (cart: Cart) => CartModel;
+export { Cart, transformCart };
+//# sourceMappingURL=transform-cart.d.ts.map

package/data/transforms/transform-countries.d.ts

@@ -0,0 +1,5 @@
+import { Country as CountryModel } from '../models/country';
+import { GetCountriesQuery } from '../../__generated__/types';
+
+export declare const transformCountries: (data: GetCountriesQuery['countries']) => CountryModel[] | undefined;
+//# sourceMappingURL=transform-countries.d.ts.map

package/data/transforms/transform-customer.d.ts

@@ -0,0 +1,14 @@
+import { GetCustomerQuery } from '../../__generated__/types';
+import { Customer as CustomerModel, CustomAttribute as CustomAttributeModel } from '../models';
+
+type Customer = GetCustomerQuery['customer'];
+export declare const transformCustomAttributesV2: (data: ({
+    __typename?: "AttributeSelectedOptions" | undefined;
+} | {
+    __typename?: "AttributeValue" | undefined;
+    code: string;
+    value: string;
+} | null)[]) => CustomAttributeModel[];
+declare const transformCustomer: (data: Customer) => CustomerModel | undefined;
+export { transformCustomer };
+//# sourceMappingURL=transform-customer.d.ts.map

package/data/transforms/transform-email-availability.d.ts

@@ -0,0 +1,6 @@
+import { IsEmailAvailableQuery } from '../../__generated__/types';
+import { EmailAvailability } from '../models';
+
+declare const transformEmailAvailability: (data: IsEmailAvailableQuery['isEmailAvailable']) => EmailAvailability;
+export { transformEmailAvailability };
+//# sourceMappingURL=transform-email-availability.d.ts.map

package/data/transforms/transform-order.d.ts

@@ -0,0 +1,7 @@
+import { Order as OrderModel } from '../models/order';
+import { PlaceOrderMutation } from '../../__generated__/types';
+
+type Order = NonNullable<NonNullable<PlaceOrderMutation['placeOrder']>['orderV2']>;
+export declare const transformOrder: (order: Order) => OrderModel;
+export {};
+//# sourceMappingURL=transform-order.d.ts.map

package/data/transforms/transform-payment-methods.d.ts

@@ -0,0 +1,9 @@
+import { GetCartQuery } from '../../__generated__/types';
+import { PaymentMethod } from '../models/payment-method';
+
+type SelectedPaymentMethod = NonNullable<GetCartQuery['cart']>['selected_payment_method'];
+type AvailablePaymentMethods = NonNullable<GetCartQuery['cart']>['available_payment_methods'];
+declare const transformSelectedPaymentMethod: (data: SelectedPaymentMethod) => PaymentMethod | undefined;
+declare const transformAvailablePaymentMethods: (data: AvailablePaymentMethods) => PaymentMethod[] | undefined;
+export { transformAvailablePaymentMethods, transformSelectedPaymentMethod };
+//# sourceMappingURL=transform-payment-methods.d.ts.map

package/data/transforms/transform-regions.d.ts

@@ -0,0 +1,8 @@
+import { Region as RegionModel } from '../models/region';
+import { GetRegionsQuery } from '../../__generated__/types';
+
+type RegionsCountry = NonNullable<GetRegionsQuery['country']>;
+type AvailableRegions = RegionsCountry['available_regions'];
+declare const transformRegions: (data: RegionsCountry['available_regions']) => RegionModel[] | undefined;
+export { AvailableRegions, transformRegions };
+//# sourceMappingURL=transform-regions.d.ts.map

package/data/transforms/transform-shipping-estimate.d.ts

@@ -0,0 +1,5 @@
+import { ShippingEstimatePartialAddress, ShippingEstimateShippingMethod, ShippingMethod } from '../models';
+
+export declare const transformShippingEstimatePartialAddress: (data: Record<string, string>) => ShippingEstimatePartialAddress;
+export declare const transformShippingEstimateShippingMethod: (data: ShippingMethod) => ShippingEstimateShippingMethod;
+//# sourceMappingURL=transform-shipping-estimate.d.ts.map

package/data/transforms/transform-shipping-methods.d.ts

@@ -0,0 +1,14 @@
+import { GetCartQuery } from '../../__generated__/types';
+import { ShippingMethod } from '../models/shipping-method';
+
+type Cart = NonNullable<GetCartQuery['cart']>;
+type ShippingAddresses = Cart['shipping_addresses'];
+type ShippingAddress = NonNullable<NonNullable<ShippingAddresses>[number]>;
+type AvailableShippingMethods = ShippingAddress['available_shipping_methods'];
+type AvailableShippingMethod = NonNullable<AvailableShippingMethods>[number];
+type SelectedShippingMethod = ShippingAddress['selected_shipping_method'];
+export declare const transformSelectedShippingMethod: (data: SelectedShippingMethod) => ShippingMethod | undefined;
+export declare const transformAvailableShippingMethod: (data: AvailableShippingMethod) => ShippingMethod | undefined;
+export declare const transformShippingMethods: (data: AvailableShippingMethods) => ShippingMethod[] | undefined;
+export {};
+//# sourceMappingURL=transform-shipping-methods.d.ts.map

package/data/transforms/transform-store-config.d.ts

@@ -0,0 +1,6 @@
+import { GetStoreConfigQuery } from '../../__generated__/types';
+import { StoreConfig, TaxDisplay } from '../models';
+
+export declare function transformTaxDisplay(data: number | null | undefined): TaxDisplay;
+export declare function transformStoreConfig(data: GetStoreConfigQuery['storeConfig']): StoreConfig;
+//# sourceMappingURL=transform-store-config.d.ts.map

package/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './useBreakpoint';
+export * from './useLockScroll';
+export * from './useValidity';
+//# sourceMappingURL=index.d.ts.map

package/hooks/useBreakpoint/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useBreakpoint';
+//# sourceMappingURL=index.d.ts.map

package/hooks/useBreakpoint/useBreakpoint.d.ts

@@ -0,0 +1,2 @@
+export declare const useBreakpoint: () => "small" | "medium" | "large" | "xlarge" | "xxlarge";
+//# sourceMappingURL=useBreakpoint.d.ts.map

package/hooks/useLockScroll/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useLockScroll';
+//# sourceMappingURL=index.d.ts.map

package/hooks/useLockScroll/useLockScroll.d.ts

@@ -0,0 +1,5 @@
+export declare const useScrollLock: () => {
+    lockScroll: () => void;
+    unlockScroll: () => void;
+};
+//# sourceMappingURL=useLockScroll.d.ts.map

package/hooks/useValidity/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useValidity';
+//# sourceMappingURL=index.d.ts.map

package/hooks/useValidity/useValidity.d.ts

@@ -0,0 +1,19 @@
+export type Translations = {
+    badInput: string;
+    patternMismatch: string;
+    rangeOverflow: string;
+    rangeUnderflow: string;
+    tooLong: string;
+    tooShort: string;
+    typeMismatch: string;
+    valueMissing: string;
+};
+type FormElement = HTMLInputElement | HTMLSelectElement;
+export declare const useValidity: (translations: Translations) => {
+    errors: Record<string, string>;
+    dismissError: (code: string) => void;
+    validateFormElement: (formElement: FormElement) => void;
+    resetErrors: () => void;
+};
+export {};
+//# sourceMappingURL=useValidity.d.ts.map

package/i18n/en_US.json.d.ts

@@ -0,0 +1,97 @@
+declare const _default: {
+  "Checkout": {
+    "title": "Checkout",
+    "LoginForm": {
+      "title": "Contact details",
+      "account": "Already have an account?",
+      "ariaLabel": "Email",
+      "invalidEmailError": "Please enter a valid email address.",
+      "missingEmailError": "Enter an email address.",
+      "emailExists": {
+        "alreadyHaveAccount": "It looks like you already have an account.",
+        "signInButton": "Sign in",
+        "forFasterCheckout": "for a faster checkout."
+      },
+      "floatingLabel": "Email *",
+      "placeholder": "Enter your email address",
+      "signIn": "Sign In",
+      "switch": "Do you want to switch account?",
+      "signOut": "Sign Out"
+    },
+    "ShippingMethods": {
+      "title": "Shipping options",
+      "emptyState": "This order can't be shipped to the address provided. Please review the address details you entered and make sure they're correct."
+    },
+    "ShippingAddress": {
+      "title": "Delivery"
+    },
+    "BillingAddress": {
+      "title": "Billing Address"
+    },
+    "AddressForm": {
+      "Validity": {
+        "badInput": "Provide a valid {field}.",
+        "patternMismatch": "Ensure you have entered a correct {field} format.",
+        "rangeOverflow": "Choose a valid {field} within the allowed range.",
+        "rangeUnderflow": "Choose a valid {field} within the allowed range.",
+        "tooLong": "This entry is too long. Keep it under {field} characters.",
+        "tooShort": "Use at least {field} characters.",
+        "typeMismatch": "Enter a valid {field}.",
+        "valueMissing": "Enter a {field}, this field is required."
+      }
+    },
+    "BillToShippingAddress": {
+      "title": "Bill to shipping address"
+    },
+    "PaymentMethods": {
+      "title": "Payment",
+      "emptyState": "No payment methods available"
+    },
+    "OutOfStock": {
+      "title": "Your cart contains items that are out of stock",
+      "message": "The following items are out of stock:",
+      "actions": {
+        "reviewCart": "Review cart",
+        "removeOutOfStock": "Remove out of stock items"
+      },
+      "lowInventory": {
+        "one": "Last item!",
+        "many": "Only {{count}} left!"
+      },
+      "alert": "Out of stock!"
+    },
+    "PlaceOrder": {
+      "button": "Place Order"
+    },
+    "ServerError": {
+      "title": "We were unable to process your order",
+      "contactSupport": "If you continue to have issues, please contact support.",
+      "unexpected": "An unexpected error occurred while processing your order. Please try again later.",
+      "button": "Try again"
+    },
+    "EmptyCart": {
+      "title": "Your cart is empty",
+      "button": "Start shopping"
+    },
+    "ErrorBanner": {
+      "genericMessage": "Server error detected. Please check your connection and try again."
+    },
+    "MergedCartBanner": {
+      "items": {
+        "one": "1 item from a previous session was added to your cart. Please review your new subtotal.",
+        "many": "{{count}} items from a previous session were added to your cart. Please review your new subtotal."
+      }
+    },
+    "EstimateShipping": {
+      "estimated": "Estimated Shipping",
+      "freeShipping": "Free",
+      "label": "Shipping",
+      "taxToBeDetermined": "TBD",
+      "withTaxes": "Including taxes",
+      "withoutTaxes": "Excluding taxes"
+    }
+  }
+}
+;
+
+export default _default;

package/lib/acdl.d.ts

@@ -0,0 +1,18 @@
+import { Order } from '../data/models/order';
+
+/**
+ * See: https://github.com/adobe/commerce-events/blob/main/packages/storefront-events-sdk/src/contexts.ts
+ */
+export declare const contexts: {
+    SHOPPING_CART_CONTEXT: string;
+    ORDER_CONTEXT: string;
+};
+/**
+ * See: https://github.com/adobe/commerce-events/blob/main/packages/storefront-events-sdk/src/events.ts
+ */
+export declare const events: {
+    PLACE_ORDER: string;
+};
+export declare function getAdobeDataLayer(): any;
+export declare function publishPlaceOrderEvent(order: Order): void;
+//# sourceMappingURL=acdl.d.ts.map

package/lib/backup-data.d.ts

@@ -0,0 +1,4 @@
+export declare const createBackup: <T>(key: string, value: T) => void;
+export declare const restoreBackup: <T>(key: string) => T | null;
+export declare const removeBackup: (key: string) => void;
+//# sourceMappingURL=backup-data.d.ts.map

package/lib/fetch-error.d.ts

@@ -0,0 +1,7 @@
+export declare const handleFetchErrors: (errors?: Array<{
+    message: string;
+    extensions: {
+        category: string;
+    };
+}>) => void;
+//# sourceMappingURL=fetch-error.d.ts.map

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './fetch-error';
+export * from './redirect';
+//# sourceMappingURL=index.d.ts.map

package/lib/network-error.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A function which can be attached to fetchGraphQL to handle thrown errors in
+ * a generic way.
+ */
+export declare const handleNetworkError: (error: Error) => never;
+//# sourceMappingURL=network-error.d.ts.map

package/lib/redirect.d.ts

@@ -0,0 +1,2 @@
+export declare function redirect(location: string): void;
+//# sourceMappingURL=redirect.d.ts.map

package/lib/state.d.ts

@@ -0,0 +1,7 @@
+type State = {
+    cartId: string | null;
+    authenticated: boolean;
+};
+export declare const state: State;
+export {};
+//# sourceMappingURL=state.d.ts.map

package/msw/browser.d.ts

@@ -0,0 +1,2 @@
+export declare const worker: import('msw/browser').SetupWorker;
+//# sourceMappingURL=browser.d.ts.map

package/msw/fixtures/fragments/american-regions.d.ts

@@ -0,0 +1,4 @@
+import { GetRegionsQuery } from '../../../__generated__/types';
+
+export declare const americanRegionsFixture: NonNullable<GetRegionsQuery['country']>['available_regions'];
+//# sourceMappingURL=american-regions.d.ts.map

package/msw/fixtures/fragments/available-shipping-methods.d.ts

@@ -0,0 +1,23 @@
+import { CurrencyEnum } from '../../../__generated__/types';
+
+export declare const availableShippingMethodsFixture: {
+    amount: {
+        currency: CurrencyEnum;
+        value: number;
+    };
+    available: boolean;
+    carrier_code: string;
+    carrier_title: string;
+    error_message: string;
+    method_code: string;
+    method_title: string;
+    price_excl_tax: {
+        value: number;
+        currency: CurrencyEnum;
+    };
+    price_incl_tax: {
+        value: number;
+        currency: CurrencyEnum;
+    };
+}[];
+//# sourceMappingURL=available-shipping-methods.d.ts.map

package/msw/fixtures/fragments/billing-address.d.ts

@@ -0,0 +1,36 @@
+export declare const billingAddressFixture: {
+    firstname: string;
+    lastname: string;
+    company: null;
+    street: string[];
+    city: string;
+    postcode: string;
+    vat_id: null;
+    country: {
+        code: string;
+        label: string;
+    };
+    region: {
+        region_id: number;
+        code: string;
+        label: string;
+    };
+    telephone: string;
+    custom_attributes: {}[];
+};
+export declare const ukBillingAddressFixture: {
+    firstname: string;
+    lastname: string;
+    company: null;
+    street: string[];
+    city: string;
+    postcode: string;
+    vat_id: null;
+    country: {
+        code: string;
+        label: string;
+    };
+    telephone: string;
+    custom_attributes: {}[];
+};
+//# sourceMappingURL=billing-address.d.ts.map