@dropins/storefront-checkout 0.1.0-alpha5 → 0.1.0-alpha50

package/data/models/acdl.d.ts

@@ -0,0 +1,115 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+/**
+ * This module contains the schema type definitions to build the ShoppingCart
+ * and Order contexts, which are required to trigger the "place-order" event.
+ *
+ * The following schema types have been extracted from the Adobe Commerce
+ * Events SDK package.
+ *
+ * ShoppingCart schema type @see https://github.com/adobe/commerce-events/blob/main/packages/storefront-events-sdk/src/types/schemas/shoppingCart.ts
+ * Order schema type @see https://github.com/adobe/commerce-events/blob/main/packages/storefront-events-sdk/src/types/schemas/order.ts
+ */
+type ShoppingCartItem = {
+    canApplyMsrp: boolean;
+    formattedPrice: string;
+    id: string;
+    prices: {
+        price: Price;
+    };
+    product: Product;
+    configurableOptions?: Array<ConfigurableOption>;
+    quantity: number;
+};
+type Price = {
+    value: number;
+    currency?: string;
+    regularPrice?: number;
+};
+type Product = {
+    productId: number;
+    name: string;
+    sku: string;
+    topLevelSku?: string | null;
+    specialToDate?: string | null;
+    specialFromDate?: string | null;
+    newToDate?: string | null;
+    newFromDate?: string | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    manufacturer?: string | null;
+    countryOfManufacture?: string | null;
+    categories?: string[] | null;
+    productType?: string | null;
+    pricing?: {
+        regularPrice: number;
+        minimalPrice?: number;
+        maximalPrice?: number;
+        specialPrice?: number;
+        tierPricing?: {
+            customerGroupId?: number | null;
+            qty: number;
+            value: number;
+        }[];
+        currencyCode: string | null;
+    };
+    canonicalUrl?: string | null;
+    mainImageUrl?: string | null;
+};
+type ConfigurableOption = {
+    id?: number;
+    optionLabel: string;
+    valueId?: number;
+    valueLabel: string;
+};
+type Payment = {
+    paymentMethodCode: string;
+    paymentMethodName: string;
+    total: number;
+};
+type Shipping = {
+    shippingMethod?: string;
+    shippingAmount?: number;
+};
+export type ShoppingCartContext = {
+    id: string | null;
+    items?: Array<ShoppingCartItem>;
+    prices?: {
+        subtotalExcludingTax?: Price;
+        subtotalIncludingTax?: Price;
+    };
+    totalQuantity: number;
+    possibleOnepageCheckout?: boolean;
+    giftMessageSelected?: boolean;
+    giftWrappingSelected?: boolean;
+    source?: string;
+};
+export type OrderContext = {
+    appliedCouponCode: string;
+    email: string;
+    grandTotal: number;
+    orderId: string;
+    orderType?: 'checkout' | 'instant_purchase';
+    otherTax: number;
+    payments?: Payment[];
+    salesTax: number;
+    shipping?: Shipping;
+    subtotalExcludingTax: number;
+    subtotalIncludingTax: number;
+};
+export {};
+//# sourceMappingURL=acdl.d.ts.map

package/data/models/address.d.ts

@@ -0,0 +1,17 @@
+import { Region, Country, CustomAttribute } from '.';
+
+export interface Address {
+    id?: number;
+    city: string;
+    company?: string;
+    country: Country;
+    customAttributes: CustomAttribute[];
+    firstName: string;
+    lastName: string;
+    postCode?: string;
+    region?: Region;
+    street: string[];
+    telephone?: string;
+    vatId?: string;
+}
+//# sourceMappingURL=address.d.ts.map

package/data/models/api.d.ts

@@ -0,0 +1,29 @@
+import { CustomAttribute } from './custom-attribute';
+
+export interface CartAddress {
+    city: string;
+    company?: string;
+    countryCode: string;
+    customAttributes: CustomAttribute[];
+    firstName: string;
+    lastName: string;
+    postcode?: string;
+    region?: string;
+    regionId?: number;
+    saveInAddressBook?: boolean;
+    street: string[];
+    telephone?: string;
+    vatId?: string;
+}
+export interface ShippingAddressInput {
+    address?: CartAddress;
+    customerAddressId?: number;
+    pickupLocationCode?: string;
+}
+export interface BillingAddressInput {
+    address?: CartAddress;
+    customerAddressId?: number;
+    sameAsShipping?: boolean;
+    useForShipping?: boolean;
+}
+//# sourceMappingURL=api.d.ts.map

package/data/models/cart.d.ts

@@ -0,0 +1,18 @@
+import { Address, PaymentMethod, ShippingMethod } from '.';
+
+export interface ShippingAddress extends Address {
+    availableShippingMethods?: ShippingMethod[];
+    selectedShippingMethod?: ShippingMethod;
+    sameAsBilling?: boolean;
+}
+export interface Cart {
+    availablePaymentMethods?: PaymentMethod[];
+    billingAddress?: Address;
+    email?: string;
+    id: string;
+    isEmpty: boolean;
+    isVirtual: boolean;
+    selectedPaymentMethod?: PaymentMethod;
+    shippingAddresses?: ShippingAddress[];
+}
+//# sourceMappingURL=cart.d.ts.map

package/data/models/country.d.ts

@@ -0,0 +1,21 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+export type Country = {
+    value: string;
+    label: string;
+};
+//# sourceMappingURL=country.d.ts.map

package/data/models/custom-attribute.d.ts

@@ -0,0 +1,21 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+export type CustomAttribute = {
+    code: string;
+    value: string;
+};
+//# sourceMappingURL=custom-attribute.d.ts.map

package/data/models/customer.d.ts

@@ -0,0 +1,14 @@
+import { Address } from '.';
+
+export interface CustomerAddress extends Address {
+    id: string;
+}
+export type Customer = {
+    firstName: string;
+    lastName: string;
+    email: string;
+    addresses: CustomerAddress[];
+    defaultBillingAddress?: CustomerAddress;
+    defaultShippingAddress?: CustomerAddress;
+};
+//# sourceMappingURL=customer.d.ts.map

package/data/models/email-availability.d.ts

@@ -0,0 +1,18 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+export type EmailAvailability = boolean;
+//# sourceMappingURL=email-availability.d.ts.map

package/data/models/index.d.ts

@@ -0,0 +1,32 @@
+/********************************************************************
+ * ADOBE CONFIDENTIAL
+ * __________________
+ *
+ *  Copyright 2024 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ *******************************************************************/
+export * from './acdl';
+export * from './address';
+export * from './api';
+export * from './cart';
+export * from './country';
+export * from './custom-attribute';
+export * from './customer';
+export * from './email-availability';
+export * from './order';
+export * from './payment-method';
+export * from './price';
+export * from './region';
+export * from './shipping-estimate';
+export * from './shipping-method';
+export * from './store-config';
+//# sourceMappingURL=index.d.ts.map

package/data/models/order.d.ts

@@ -0,0 +1,81 @@
+import { Price } from './price';
+
+type OrderPayment = {
+    code: string;
+    name: string;
+};
+type OrderCoupon = {
+    code: string;
+};
+export type OrderItemProduct = {
+    canonicalUrl?: string;
+    id: string;
+    image?: string;
+    imageAlt?: string;
+    name: string;
+    productType: string;
+    sku: string;
+};
+export type OrderItem = {
+    type: string;
+    discounted: boolean;
+    id: string;
+    regularPrice: Price;
+    price: Price;
+    product: OrderItemProduct;
+    selectedOptions?: Array<{
+        label: string;
+        value: any;
+    }>;
+    totalQuantity: number;
+    thumbnail: {
+        label: string;
+        url: string;
+    };
+    giftCard?: {
+        senderName: string;
+        senderEmail: string;
+        recipientEmail: string;
+        recipientName: string;
+    };
+};
+export type OrderAddress = {
+    city: string;
+    company: string;
+    country: string;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    postCode: string;
+    region: string;
+    regionId: string;
+    street: string[];
+    telephone: string;
+    customAttributes: {
+        code: string;
+        value: string;
+    }[];
+} | null;
+export type Order = {
+    status: string;
+    isVirtual: boolean;
+    coupons: OrderCoupon[];
+    email: string;
+    items: OrderItem[];
+    number: string;
+    payments: OrderPayment[];
+    shipping?: {
+        code: string;
+        amount: number;
+        currency: string;
+    };
+    grandTotal: Price;
+    subtotal: Price;
+    token: string;
+    totalQuantity: number;
+    totalTax: Price;
+    shippingAddress: OrderAddress;
+    billingAddress: OrderAddress;
+};
+export {};
+//# sourceMappingURL=order.d.ts.map

package/data/models/payment-method.d.ts

@@ -0,0 +1,21 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+export type PaymentMethod = {
+    code: string;
+    title: string;
+};
+//# sourceMappingURL=payment-method.d.ts.map

package/data/models/price.d.ts

@@ -0,0 +1,21 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+export type Price = {
+    value: number;
+    currency: string;
+};
+//# sourceMappingURL=price.d.ts.map

package/data/models/region.d.ts

@@ -0,0 +1,22 @@
+/********************************************************************
+ * ADOBE CONFIDENTIAL
+ * __________________
+ *
+ *  Copyright 2024 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ *******************************************************************/
+export type Region = {
+    code: string;
+    id?: number;
+    name: string;
+};
+//# sourceMappingURL=region.d.ts.map

package/data/models/shipping-estimate.d.ts

@@ -0,0 +1,17 @@
+import { Price } from './price';
+
+export interface ShippingEstimatePartialAddress {
+    countryCode: string;
+    postCode?: string;
+    region?: string;
+    regionCode?: string;
+    regionId?: number;
+}
+export interface ShippingEstimateShippingMethod {
+    amount: Price;
+    carrierCode: string;
+    methodCode: string;
+    amountExclTax?: Price;
+    amountInclTax?: Price;
+}
+//# sourceMappingURL=shipping-estimate.d.ts.map

package/data/models/shipping-method.d.ts

@@ -0,0 +1,19 @@
+import { Price } from './price';
+
+type Code = string;
+type Title = string;
+type Carrier = {
+    code: Code;
+    title: Title;
+};
+export type ShippingMethod = {
+    amount: Price;
+    carrier: Carrier;
+    code: Code;
+    title: Title;
+    value: string;
+    amountExclTax?: Price;
+    amountInclTax?: Price;
+};
+export {};
+//# sourceMappingURL=shipping-method.d.ts.map

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

@@ -0,0 +1,30 @@
+/********************************************************************
+* ADOBE CONFIDENTIAL
+* __________________
+*
+*  Copyright 2024 Adobe
+*  All Rights Reserved.
+*
+* NOTICE:  All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+*******************************************************************/
+export declare enum TaxDisplay {
+    EXCLUDING_TAX = "EXCLUDING_TAX",
+    INCLUDING_EXCLUDING_TAX = "INCLUDING_AND_EXCLUDING_TAX",
+    INCLUDING_TAX = "INCLUDING_TAX"
+}
+export interface StoreConfig {
+    defaultCountry: string;
+    isGuestCheckoutEnabled: boolean;
+    isOnePageCheckoutEnabled: boolean;
+    shoppingCartDisplaySetting: {
+        shipping: TaxDisplay;
+    };
+}
+//# sourceMappingURL=store-config.d.ts.map

package/data/transforms/index.d.ts

@@ -0,0 +1,26 @@
+/********************************************************************
+ * ADOBE CONFIDENTIAL
+ * __________________
+ *
+ *  Copyright 2024 Adobe
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Adobe and its suppliers, if any. The intellectual
+ * and technical concepts contained herein are proprietary to Adobe
+ * and its suppliers and are protected by all applicable intellectual
+ * property laws, including trade secret and copyright laws.
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Adobe.
+ *******************************************************************/
+export * from './transform-acdl';
+export * from './transform-address';
+export * from './transform-cart';
+export * from './transform-customer';
+export * from './transform-email-availability';
+export * from './transform-order';
+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.d.ts

@@ -0,0 +1,91 @@
+import { CartAddressInput, GetCartQuery } from '../../__generated__/types';
+import { Address as AddressModel, CustomAttribute as CustomAttributeModel, ShippingAddress as ShippingAddressModel, CartAddress as CartAddressModel } 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) => AddressModel | undefined;
+declare const transformShippingAddresses: (data: ({
+    __typename?: "ShippingCartAddress" | undefined;
+    id?: number | null | 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;
+    same_as_billing: boolean;
+    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;
+declare const transformCartAddressModelToInput: (address: CartAddressModel) => CartAddressInput;
+export { BillingAddress, ShippingAddress, transformCartAddressModelToInput, 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-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