@dropins/storefront-order 0.1.0-alpha9 → 1.0.0-beta2

package/data/models/order-details.d.ts

@@ -1,4 +1,5 @@
 import { AvailableActionsProps, MoneyProps, QueryType } from '../../types';
+import { OrdersReturnPropsModel } from './customer-orders-return';
 
 export type OrderAddressModel = {
     city: string;
@@ -18,7 +19,11 @@ export type OrderAddressModel = {
     }[];
 } | null;
 export type OrderItemProductModel = {
+    uid: string;
+    __typename: string;
+    stockStatus?: string;
     canonicalUrl?: string;
+    urlKey?: string;
     id: string;
     image?: string;
     imageAlt?: string;
@@ -31,27 +36,54 @@ export type OrderItemProductModel = {
     };
 };
 export type OrderItemModel = {
-    type: string;
-    discounted: boolean;
+    currentReturnOrderQuantity?: number;
+    eligibleForReturn: boolean;
+    productSku?: string;
+    type?: string;
+    discounted?: boolean;
     id: string;
-    productName: string;
-    regularPrice: MoneyProps;
+    productName?: string;
+    productUrlKey?: string;
+    regularPrice?: MoneyProps;
     price: MoneyProps;
-    product: OrderItemProductModel;
+    product?: OrderItemProductModel;
     selectedOptions?: Array<{
         label: string;
         value: any;
     }>;
-    totalQuantity: number;
-    thumbnail: {
+    thumbnail?: {
         label: string;
         url: string;
     };
+    downloadableLinks: {
+        count: number;
+        result: string;
+    } | null;
+    itemPrices: {
+        priceIncludingTax: MoneyProps;
+        originalPrice: MoneyProps;
+        originalPriceIncludingTax: MoneyProps;
+        price: MoneyProps;
+        discounts: [
+            {
+                label: string;
+                amount: {
+                    value: number;
+                };
+            }
+        ];
+    };
+    bundleOptions: Record<string, string> | null;
+    totalInclTax: MoneyProps;
+    priceInclTax: MoneyProps;
+    total: MoneyProps;
+    configurableOptions: Record<string, string | number | boolean> | undefined;
     giftCard?: {
         senderName: string;
         senderEmail: string;
         recipientEmail: string;
         recipientName: string;
+        message: string;
     };
     quantityCanceled: number;
     quantityInvoiced: number;
@@ -59,11 +91,16 @@ export type OrderItemModel = {
     quantityRefunded: number;
     quantityReturned: number;
     quantityShipped: number;
+    requestQuantity: number;
+    totalQuantity: number;
+    returnableQuantity?: number;
+    quantityReturnRequested: number;
 };
 export type ShipmentItemsModel = {
     id: string;
     productSku: string;
     productName: string;
+    quantityShipped: number;
     orderItem: OrderItemModel;
 };
 export type ShipmentsTracingModel = {
@@ -82,14 +119,24 @@ export type ShipmentsModel = {
     items: ShipmentItemsModel[];
 };
 export type OrderDataModel = {
+    placeholderImage?: string;
+    returnNumber: string;
+    id: string;
+    orderStatusChangeDate?: string;
     number: string;
-    email?: string;
+    email: string;
     token?: string;
     status: string;
     isVirtual: boolean;
     totalQuantity: number;
     shippingMethod?: string;
     carrier?: string;
+    orderDate: string;
+    returns: OrdersReturnPropsModel[];
+    discounts: {
+        amount: MoneyProps;
+        label: string;
+    }[];
     coupons: {
         code: string;
     }[];
@@ -104,12 +151,20 @@ export type OrderDataModel = {
     };
     shipments: ShipmentsModel[];
     items: OrderItemModel[];
+    totalGiftcard: MoneyProps;
     grandTotal: MoneyProps;
-    subtotal: MoneyProps;
+    totalShipping?: MoneyProps;
+    subtotalExclTax: MoneyProps;
+    subtotalInclTax: MoneyProps;
     totalTax: MoneyProps;
     shippingAddress: OrderAddressModel;
     billingAddress: OrderAddressModel;
     availableActions: AvailableActionsProps[];
+    taxes: {
+        amount: MoneyProps;
+        rate: number;
+        title: string;
+    }[];
 };
 export type TransformedData<T extends QueryType> = T extends 'orderData' ? OrderDataModel : null;
 //# sourceMappingURL=order-details.d.ts.map

package/data/models/request-return.d.ts

@@ -0,0 +1,7 @@
+export interface RequestReturnModel {
+    uid: string;
+    number: string;
+    status: string;
+    createdAt: string;
+}
+//# sourceMappingURL=request-return.d.ts.map

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

@@ -0,0 +1,15 @@
+export interface StoreConfigModel {
+    baseMediaUrl: string;
+    orderCancellationEnabled: boolean;
+    orderCancellationReasons: OrderCancellationReason[];
+    shoppingCartDisplayPrice: 1 | 2 | 3;
+    shoppingOrdersDisplayShipping: 1 | 2 | 3;
+    shoppingOrdersDisplaySubtotal: 1 | 2 | 3;
+    shoppingOrdersDisplayFullSummary: boolean;
+    shoppingOrdersDisplayGrandTotal: boolean;
+    shoppingOrdersDisplayZeroTax: boolean;
+}
+export interface OrderCancellationReason {
+    description: string;
+}
+//# sourceMappingURL=store-config.d.ts.map

package/data/transforms/index.d.ts

@@ -1,5 +1,11 @@
-export * from './transform-order-details';
-export * from './transform-guest-order';
+export * from './transform-acdl';
 export * from './transform-attributes-form';
 export * from './transform-customer';
+export * from './transform-customer-address-input';
+export * from './transform-customer-orders-returns';
+export * from './transform-guest-order';
+export * from './transform-order-details';
+export * from './transform-place-order';
+export * from './transform-store-config';
+export * from './transform-request-return';
 //# sourceMappingURL=index.d.ts.map

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

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

package/data/transforms/transform-attributes-form.d.ts

@@ -1,6 +1,7 @@
-import { GetAttributesFormResponse, ResponseAttributesFormItemsProps } from '../../types';
+import { AttributesListItems, ResponseAttributesFormItemsProps } from '../../types';
 import { AttributesFormModel } from '../models';
 
 export declare const cloneArrayIfExists: (fields: ResponseAttributesFormItemsProps[]) => any;
-export declare const transformAttributesForm: (response: GetAttributesFormResponse) => AttributesFormModel[];
+export declare const transformAttributesForm: (items?: ResponseAttributesFormItemsProps[] | AttributesListItems[] | [
+]) => AttributesFormModel[];
 //# sourceMappingURL=transform-attributes-form.d.ts.map

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

@@ -0,0 +1,22 @@
+import { OrderAddressModel } from '../models';
+
+export declare function transformCustomerAddressInput(address: OrderAddressModel): {
+    region: {
+        region_id: number | null;
+        region: string | undefined;
+    };
+    city: string | undefined;
+    company: string | undefined;
+    country_code: string | undefined;
+    firstname: string | undefined;
+    lastname: string | undefined;
+    middlename: string | undefined;
+    postcode: string | undefined;
+    street: string[] | undefined;
+    telephone: string | undefined;
+    custom_attributesV2: {
+        attribute_code: string;
+        value: string;
+    }[];
+};
+//# sourceMappingURL=transform-customer-address-input.d.ts.map

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

@@ -0,0 +1,5 @@
+import { OrdersReturnResponseProps } from '../../types';
+import { CustomerOrdersReturnModel } from '../models/customer-orders-return';
+
+export declare const transformCustomerOrdersReturns: (returns: OrdersReturnResponseProps) => CustomerOrdersReturnModel | null;
+//# sourceMappingURL=transform-customer-orders-returns.d.ts.map

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

@@ -1,6 +1,6 @@
 import { GuestOrderByTokenResponse, GuestOrderResponse } from '../../types';
 import { OrderDataModel } from '../models';
 
-export declare const transformGuestOrder: (response: GuestOrderResponse) => OrderDataModel | null;
-export declare const transformGuestOrderByToken: (response: GuestOrderByTokenResponse) => OrderDataModel | null;
+export declare const transformGuestOrder: (response: GuestOrderResponse, returnRef?: string) => OrderDataModel | null;
+export declare const transformGuestOrderByToken: (response: GuestOrderByTokenResponse, returnRef?: string) => OrderDataModel | null;
 //# sourceMappingURL=transform-guest-order.d.ts.map

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

@@ -1,7 +1,17 @@
 import { QueryType, ResponseData, OrderProps, OrderItemProps } from '../../types';
-import { TransformedData } from '../models';
+import { OrderItemModel, TransformedData } from '../models';
 
 export declare const transformConfigurableOptions: (item: OrderItemProps) => Record<string, string> | undefined;
-export declare const transformOrderData: (orderData: OrderProps) => any;
-export declare const transformOrderDetails: <T extends "orderData">(queryType: QueryType, response: ResponseData<T>) => TransformedData<T>;
+export declare const transformBundleOptions: (data: any) => {
+    [key: string]: any;
+} | null;
+export declare const transformLinks: (links: {
+    title: string;
+}[]) => {
+    count: number;
+    result: string;
+} | null;
+export declare const transformOrderItems: (items: OrderItemProps[]) => OrderItemModel[];
+export declare const transformOrderData: (orderData: OrderProps, returnRef?: string) => any;
+export declare const transformOrderDetails: <T extends "orderData">(queryType: QueryType, response: ResponseData<T>, returnRef?: string) => TransformedData<T>;
 //# sourceMappingURL=transform-order-details.d.ts.map

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

@@ -0,0 +1,5 @@
+import { PlaceOrderResponse } from '../../types';
+import { OrderDataModel } from '../models';
+
+export declare const transformPlaceOrder: (response: PlaceOrderResponse) => OrderDataModel | null;
+//# sourceMappingURL=transform-place-order.d.ts.map

package/data/transforms/transform-request-return.d.ts

@@ -0,0 +1,5 @@
+import { RequestReturnResponse } from '../../types';
+import { RequestReturnModel } from '../models';
+
+export declare const transformRequestReturn: (response: RequestReturnResponse) => RequestReturnModel | {};
+//# sourceMappingURL=transform-request-return.d.ts.map

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

@@ -0,0 +1,4 @@
+import { StoreConfigModel } from '../models';
+
+export declare function transformStoreConfig(data: any): StoreConfigModel | null;
+//# sourceMappingURL=transform-store-config.d.ts.map

package/fragments.d.ts

@@ -0,0 +1 @@
+export * from './api/fragments'

package/fragments.js

@@ -0,0 +1,306 @@
+/*! Copyright 2024 Adobe
+All Rights Reserved. */
+const R=`
+  fragment REQUEST_RETURN_ORDER_FRAGMENT on Return {
+    __typename
+    uid
+    status
+    number
+    created_at
+  }
+`,e=`
+  fragment ADDRESS_FRAGMENT on OrderAddress {
+    city
+    company
+    country_code
+    fax
+    firstname
+    lastname
+    middlename
+    postcode
+    prefix
+    region
+    region_id
+    street
+    suffix
+    telephone
+    vat_id
+  }
+`,t=`
+  fragment PRODUCT_DETAILS_FRAGMENT on ProductInterface {
+    __typename
+    canonical_url
+    url_key
+    uid
+    name
+    sku
+    only_x_left_in_stock
+    stock_status
+    thumbnail {
+      label
+      url
+    }
+    price_range {
+      maximum_price {
+        regular_price {
+          currency
+          value
+        }
+      }
+    }
+  }
+`,_=`
+  fragment PRICE_DETAILS_FRAGMENT on OrderItemInterface {
+    prices {
+      price_including_tax {
+        value
+        currency
+      }
+      original_price {
+        value
+        currency
+      }
+      original_price_including_tax {
+        value
+        currency
+      }
+      price {
+        value
+        currency
+      }
+    }
+  }
+`,r=`
+  fragment GIFT_CARD_DETAILS_FRAGMENT on GiftCardOrderItem {
+    ...PRICE_DETAILS_FRAGMENT
+    gift_message {
+      message
+    }
+    gift_card {
+      recipient_name
+      recipient_email
+      sender_name
+      sender_email
+      message
+    }
+  }
+`,n=`
+  fragment ORDER_ITEM_DETAILS_FRAGMENT on OrderItemInterface {
+    __typename
+    status
+    product_sku
+    eligible_for_return
+    product_name
+    product_url_key
+    id
+    quantity_ordered
+    quantity_shipped
+    quantity_canceled
+    quantity_invoiced
+    quantity_refunded
+    quantity_return_requested
+    product_sale_price {
+      value
+      currency
+    }
+    selected_options {
+      label
+      value
+    }
+    product {
+      ...PRODUCT_DETAILS_FRAGMENT
+    }
+    ...PRICE_DETAILS_FRAGMENT
+  }
+`,a=`
+  fragment BUNDLE_ORDER_ITEM_DETAILS_FRAGMENT on BundleOrderItem {
+    ...PRICE_DETAILS_FRAGMENT
+    bundle_options {
+      uid
+      label
+      values {
+        uid
+        product_name
+      }
+    }
+  }
+`,i=`
+  fragment ORDER_SUMMARY_FRAGMENT on OrderTotal {
+    grand_total {
+      value
+      currency
+    }
+    total_giftcard {
+      currency
+      value
+    }
+    subtotal_excl_tax {
+      currency
+      value
+    }
+    subtotal_incl_tax {
+      currency
+      value
+    }
+    taxes {
+      amount {
+        currency
+        value
+      }
+      rate
+      title
+    }
+    total_tax {
+      currency
+      value
+    }
+    total_shipping {
+      currency
+      value
+    }
+    discounts {
+      amount {
+        currency
+        value
+      }
+      label
+    }
+  }
+`,E=`
+  fragment RETURNS_FRAGMENT on Returns {
+    __typename
+    items {
+      number
+      status
+      created_at
+      shipping {
+        tracking {
+          status {
+            text
+            type
+          }
+          carrier {
+            uid
+            label
+          }
+          tracking_number
+        }
+      }
+      order {
+        number
+        token
+      }
+      items {
+        uid
+        quantity
+        status
+        request_quantity
+        order_item {
+          ...ORDER_ITEM_DETAILS_FRAGMENT
+          ... on GiftCardOrderItem {
+            ...GIFT_CARD_DETAILS_FRAGMENT
+            product {
+              ...PRODUCT_DETAILS_FRAGMENT
+            }
+          }
+        }
+      }
+    }
+  }
+`,u=`
+  fragment GUEST_ORDER_FRAGMENT on CustomerOrder {
+    email
+    id
+    number
+    order_date
+    order_status_change_date
+    status
+    token
+    carrier
+    shipping_method
+    printed_card_included
+    gift_receipt_included
+    available_actions
+    is_virtual
+    items_eligible_for_return {
+      ...ORDER_ITEM_DETAILS_FRAGMENT
+    }
+    returns {
+      ...RETURNS_FRAGMENT
+    }
+    payment_methods {
+      name
+      type
+    }
+    applied_coupons {
+      code
+    }
+    shipments {
+      id
+      tracking {
+        title
+        number
+        carrier
+      }
+      comments {
+        message
+        timestamp
+      }
+      items {
+        __typename
+        id
+        product_sku
+        product_name
+        order_item {
+          ...ORDER_ITEM_DETAILS_FRAGMENT
+          ... on GiftCardOrderItem {
+            ...GIFT_CARD_DETAILS_FRAGMENT
+            product {
+              ...PRODUCT_DETAILS_FRAGMENT
+            }
+          }
+        }
+      }
+    }
+    payment_methods {
+      name
+      type
+    }
+    shipping_address {
+      ...ADDRESS_FRAGMENT
+    }
+    billing_address {
+      ...ADDRESS_FRAGMENT
+    }
+    items {
+      ...ORDER_ITEM_DETAILS_FRAGMENT
+      ... on BundleOrderItem {
+        ...BUNDLE_ORDER_ITEM_DETAILS_FRAGMENT
+      }
+      ... on GiftCardOrderItem {
+        ...GIFT_CARD_DETAILS_FRAGMENT
+        product {
+          ...PRODUCT_DETAILS_FRAGMENT
+        }
+      }
+      ... on DownloadableOrderItem {
+        product_name
+        downloadable_links {
+          sort_order
+          title
+        }
+      }
+    }
+    total {
+      ...ORDER_SUMMARY_FRAGMENT
+    }
+  }
+  ${t}
+  ${_}
+  ${r}
+  ${n}
+  ${a}
+  ${i}
+  ${e}
+  ${E}
+`;export{e as ADDRESS_FRAGMENT,a as BUNDLE_ORDER_ITEM_DETAILS_FRAGMENT,r as GIFT_CARD_DETAILS_FRAGMENT,u as GUEST_ORDER_FRAGMENT,n as ORDER_ITEM_DETAILS_FRAGMENT,i as ORDER_SUMMARY_FRAGMENT,_ as PRICE_DETAILS_FRAGMENT,t as PRODUCT_DETAILS_FRAGMENT,R as REQUEST_RETURN_ORDER_FRAGMENT,E as RETURNS_FRAGMENT};

package/hooks/api/useGetStoreConfig.d.ts

@@ -0,0 +1,4 @@
+import { StoreConfigModel } from '../../data/models';
+
+export declare const useGetStoreConfig: () => StoreConfigModel | null;
+//# sourceMappingURL=useGetStoreConfig.d.ts.map

package/hooks/containers/useCreateReturn.d.ts

@@ -0,0 +1,65 @@
+import { AttributesFormModel, OrderItemModel } from '../../data/models';
+import { StepsTypes, UseCreateReturn } from '../../types';
+import { RefObject } from 'preact';
+
+export declare const useCreateReturn: ({ onSuccess, onError, handleSetInLineAlert, orderData, }: UseCreateReturn) => {
+    order: {
+        placeholderImage?: string | undefined;
+        returnNumber?: string | undefined;
+        id: string;
+        orderStatusChangeDate?: string | undefined;
+        number?: string | undefined;
+        email: string;
+        token?: string | undefined;
+        status?: string | undefined;
+        isVirtual?: boolean | undefined;
+        totalQuantity?: number | undefined;
+        shippingMethod?: string | undefined;
+        carrier?: string | undefined;
+        orderDate?: string | undefined;
+        returns?: import('../../data/models').OrdersReturnPropsModel[] | undefined;
+        discounts?: {
+            amount: import('../../types').MoneyProps;
+            label: string;
+        }[] | undefined;
+        coupons?: {
+            code: string;
+        }[] | undefined;
+        payments?: {
+            code: string;
+            name: string;
+        }[] | undefined;
+        shipping?: {
+            code: string;
+            amount: number;
+            currency: string;
+        } | undefined;
+        shipments?: import('../../data/models').ShipmentsModel[] | undefined;
+        items?: OrderItemModel[] | undefined;
+        totalGiftcard?: import('../../types').MoneyProps | undefined;
+        grandTotal?: import('../../types').MoneyProps | undefined;
+        totalShipping?: import('../../types').MoneyProps | undefined;
+        subtotalExclTax?: import('../../types').MoneyProps | undefined;
+        subtotalInclTax?: import('../../types').MoneyProps | undefined;
+        totalTax?: import('../../types').MoneyProps | undefined;
+        shippingAddress?: import('../../data/models').OrderAddressModel | undefined;
+        billingAddress?: import('../../data/models').OrderAddressModel | undefined;
+        availableActions?: import('../../types').AvailableActionsProps[] | undefined;
+        taxes?: {
+            amount: import('../../types').MoneyProps;
+            rate: number;
+            title: string;
+        }[] | undefined;
+    };
+    steps: StepsTypes;
+    loading: boolean;
+    formsRef: import('preact/hooks').MutableRef<RefObject<HTMLFormElement>[]>;
+    attributesList: [] | AttributesFormModel[];
+    selectedProductList: [] | OrderItemModel[];
+    itemsEligibleForReturn: OrderItemModel[];
+    handleSelectedProductList: (orderItem: OrderItemModel) => void;
+    handleSetQuantity: (value: number, productSku: string) => void;
+    handleChangeStep: (value: StepsTypes) => void;
+    onSubmit: (_: SubmitEvent, isValid: boolean) => Promise<void | null | undefined>;
+};
+//# sourceMappingURL=useCreateReturn.d.ts.map

package/hooks/containers/useCustomerDetails.d.ts

@@ -4,8 +4,8 @@ import { NormalizeAddressProps, UseCustomerDetails } from '../../types';
 export declare const useCustomerDetails: ({ orderData }: UseCustomerDetails) => {
     order: OrderDataModel | undefined;
     normalizeAddress: {
-        billingAddress: NormalizeAddressProps[][];
-        shippingAddress: NormalizeAddressProps[][];
+        billingAddress: [] | NormalizeAddressProps[];
+        shippingAddress: [] | NormalizeAddressProps[];
     };
     loading: boolean;
 };

package/hooks/containers/useOrderActions.d.ts

@@ -0,0 +1,12 @@
+import { UseOrderActionsProps } from '../../types';
+
+export declare const useOrderActions: ({ enableOrderCancellation, }: UseOrderActionsProps) => {
+    orderActionStatus: {
+        heading: string;
+        text: string;
+        status: 'success' | 'error' | 'warning' | undefined;
+    };
+    isDismissed: boolean;
+    onDismiss: () => void;
+};
+//# sourceMappingURL=useOrderActions.d.ts.map