@dropins/storefront-order 0.1.0-alpha8 → 1.0.0-beta1

package/types/api/confirmGuestReturn.types.d.ts

@@ -0,0 +1,18 @@
+import { OrderDataModel } from '../../data/models';
+import { ReturnProps } from './requestReturn.types';
+
+interface ErrorsProps {
+    message: string;
+}
+export interface GuestConfirmReturnResponse {
+    data: {
+        confirmReturn: {
+            return: ReturnProps & {
+                order: OrderDataModel;
+            };
+        };
+    };
+    errors?: ErrorsProps[];
+}
+export {};
+//# sourceMappingURL=confirmGuestReturn.types.d.ts.map

package/types/api/getAttributesList.types.d.ts

@@ -0,0 +1,28 @@
+export type AttributesListItems = {
+    code: string;
+    sort_order: string;
+    default_value: null | string;
+    frontend_class: null | string;
+    multiline_count: number;
+    entity_type: string;
+    frontend_input: string;
+    is_required: boolean;
+    is_unique: boolean;
+    label: string;
+    options: {
+        is_default: boolean;
+        label: string;
+        value: string;
+    }[];
+};
+export interface GetAttributesListResponse {
+    data: {
+        attributesList: {
+            items: AttributesListItems[];
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# sourceMappingURL=getAttributesList.types.d.ts.map

package/types/api/getCustomerOrdersReturn.types.d.ts

@@ -0,0 +1,21 @@
+import { ReturnsItemsProps } from './getOrderDetails.types';
+
+export interface OrdersReturnResponseProps {
+    page_info?: {
+        page_size: number;
+        total_pages: number;
+        current_page: number;
+    };
+    items?: ReturnsItemsProps[];
+}
+export interface GetCustomerOrdersReturnResponse {
+    data: {
+        customer: {
+            returns: OrdersReturnResponseProps;
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# sourceMappingURL=getCustomerOrdersReturn.types.d.ts.map

package/types/api/getOrderDetails.types.d.ts

@@ -24,6 +24,8 @@ export interface ProductProps {
     thumbnail?: ThumbnailImageProps;
     image: ThumbnailImageProps;
     canonical_url: string;
+    url_key: string;
+    id: string;
     uid: string;
     name: string;
     __typename: string;
@@ -35,8 +37,8 @@ export interface ProductProps {
     };
 }
 export interface MoneyProps {
-    value?: number;
-    currency?: string;
+    value: number;
+    currency: string;
 }
 interface GrandTotalProps extends MoneyProps {
 }
@@ -54,10 +56,11 @@ interface TaxDetailProps {
     title?: string;
 }
 export interface DiscountProps {
-    amount?: MoneyProps;
-    label?: string;
+    amount: MoneyProps;
+    label: string;
 }
 export interface TotalProps {
+    total_giftcard?: MoneyProps;
     grand_total?: GrandTotalProps;
     subtotal?: SubtotalProps;
     taxes?: TaxDetailProps[];
@@ -78,11 +81,9 @@ interface InvoiceProps {
     }[];
 }
 export interface GiftMessageProps {
-    gift_message: {
-        form: string;
-        message: string;
-        to: string;
-    };
+    form: string;
+    message: string;
+    to: string;
 }
 export interface GiftWrappingProps {
     gift_wrapping: {
@@ -100,6 +101,7 @@ export interface giftCardProps {
     sender_email: string;
     recipient_email: string;
     recipient_name: string;
+    message: string;
 }
 export interface OrderItemProps {
     __typename: string;
@@ -124,12 +126,31 @@ export interface OrderItemProps {
     quantity_refunded: number;
     quantity_returned: number;
     quantity_shipped: number;
+    quantity_return_requested: number;
     selected_options: {
         label: string;
         value: string;
     }[];
+    bundle_options: any;
     status: string;
     gift_card?: giftCardProps;
+    downloadable_links: {
+        title: string;
+    }[];
+    prices: {
+        price_including_tax: MoneyProps;
+        original_price: MoneyProps;
+        original_price_including_tax: MoneyProps;
+        price: MoneyProps;
+        discounts: [
+            {
+                label: string;
+                amount: {
+                    value: number;
+                };
+            }
+        ];
+    };
 }
 export interface PaymentMethodsProps {
     name: string;
@@ -162,6 +183,35 @@ export declare enum AvailableActionsProps {
     RETURN = "RETURN",
     REORDER = "REORDER"
 }
+export interface ReturnsItemsProps {
+    number: string;
+    status: string;
+    created_at: string;
+    order: {
+        number: string;
+        token: string;
+    };
+    shipping: {
+        tracking: {
+            status: {
+                text: string;
+                type: string;
+            };
+            carrier: {
+                uid: string;
+                label: string;
+            };
+            tracking_number: string;
+        }[];
+    };
+    items: {
+        quantity: number;
+        status: string;
+        uid: string;
+        request_quantity: number;
+        order_item: OrderItemProps;
+    }[];
+}
 export interface OrderProps {
     available_actions: AvailableActionsProps[];
     shipping_method: string;
@@ -178,8 +228,8 @@ export interface OrderProps {
         code: string;
     }[];
     returns: {
-        pageSize: number;
-        currentPage: number;
+        __typename: string;
+        items: ReturnsItemsProps[];
     };
     shipments: ShipmentsProps[];
     items_eligible_for_return: OrderItemProps[];
@@ -197,6 +247,14 @@ export interface ErrorProps {
         message?: string;
     }[];
 }
+type GetOrderDetailsByParams<T extends QueryType> = {
+    orderId?: string;
+    returnRef?: string;
+    queryType: T;
+    returnsPageSize?: number;
+};
+export interface GetOrderDetailsByIdProps extends GetOrderDetailsByParams<QueryType> {
+}
 export interface OrdersResponse extends ErrorProps {
     data?: {
         customer?: {

package/types/api/placeOrder.types.d.ts

@@ -0,0 +1,19 @@
+import { OrderProps } from '..';
+
+export interface PlaceOrderProps extends OrderProps {
+}
+export interface PlaceOrderResponse {
+    data: {
+        placeOrder?: {
+            errors?: {
+                code: string;
+                message: string;
+            }[];
+            orderV2?: PlaceOrderProps;
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# sourceMappingURL=placeOrder.types.d.ts.map

package/types/api/reorderItems.types.d.ts

@@ -0,0 +1,27 @@
+export interface UserInputErrorProps {
+    code: string;
+    message: string;
+    path: [string];
+}
+export interface ReorderItemsResponse {
+    data: {
+        reorderItems: {
+            cart: {
+                itemsV2: {
+                    items: {
+                        uid: string;
+                    }[];
+                };
+            };
+            userInputErrors: UserInputErrorProps[];
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+export interface ReorderItemsProps {
+    success: boolean;
+    userInputErrors: UserInputErrorProps[];
+}
+//# sourceMappingURL=reorderItems.types.d.ts.map

package/types/api/requestReturn.types.d.ts

@@ -0,0 +1,47 @@
+export interface RequestReturnProps {
+    orderUid?: string;
+    contactEmail: string;
+    items: {
+        orderItemUid: string;
+        quantityToReturn: number;
+        selectedCustomAttributes?: {
+            attribute_code: string;
+            value: string;
+        }[];
+        enteredCustomAttributes?: {
+            attribute_code: string;
+            value: string;
+        }[];
+    }[];
+}
+export interface RequestGuestReturnProps extends RequestReturnProps {
+    token: string;
+    commentText: string;
+}
+export interface ReturnProps {
+    uid: string;
+    number: string;
+    status: string;
+    created_at: string;
+}
+interface ErrorsProps {
+    message: string;
+}
+export interface RequestReturnResponse {
+    data: {
+        requestReturn: {
+            return: ReturnProps;
+        };
+    };
+    errors?: ErrorsProps[];
+}
+export interface RequestGuestReturnResponse {
+    data: {
+        requestGuestReturn: {
+            return: ReturnProps;
+        };
+    };
+    errors?: ErrorsProps[];
+}
+export {};
+//# sourceMappingURL=requestReturn.types.d.ts.map

package/types/createReturn.types.d.ts

@@ -0,0 +1,71 @@
+import { AttributesFormModel, OrderDataModel, OrderItemModel } from '../data/models';
+import { InLineAlertProps, TaxTypes } from '.';
+import { SlotProps } from '@dropins/tools/types/elsie/src/lib';
+import { RefObject } from 'preact';
+import { MutableRefObject } from 'preact/compat';
+
+type options = Record<string, string | number | boolean>;
+export type StepsTypes = 'products' | 'attributes' | 'success' | 'error';
+type onSuccessTypes = {
+    uid: string;
+    number: string;
+    status: string;
+    createdAt: string;
+};
+export interface CreateReturnProps {
+    orderData?: OrderDataModel;
+    slots?: {
+        ReturnOrderItem: SlotProps;
+        ReturnFormActions: SlotProps<{
+            handleChangeStep: (value: StepsTypes) => void;
+        }>;
+    };
+    className: string;
+    onSuccess?: (response: onSuccessTypes) => void;
+    onError?: (message: string) => void;
+    routeReturnSuccess?: () => string;
+    showConfigurableOptions?: (options: options | {}) => options;
+}
+export interface ReturnOrderProductListProps {
+    placeholderImage: string;
+    slots?: {
+        ReturnOrderItem: SlotProps;
+    };
+    itemsEligibleForReturn: OrderItemModel[];
+    loading: boolean;
+    taxConfig: TaxTypes;
+    translations: Record<string, string>;
+    selectedProductList: OrderItemModel[] | [];
+    handleSelectedProductList: (product: any) => void;
+    showConfigurableOptions?: (options: options | {}) => options;
+    handleSetQuantity: (value: number, productSku: string) => void;
+    handleChangeStep: (value: StepsTypes) => void;
+}
+export interface ReturnReasonFormProps {
+    placeholderImage: string;
+    slots?: {
+        ReturnFormActions: SlotProps<{
+            handleChangeStep: (value: StepsTypes) => void;
+        }>;
+    };
+    formsRef: MutableRefObject<RefObject<HTMLFormElement>[]>;
+    loading: boolean;
+    translations: Record<string, string>;
+    fieldsConfig: AttributesFormModel[] | [];
+    selectedProductList: OrderItemModel[] | [];
+    handleChangeStep: (value: StepsTypes) => void;
+    onSubmit?: (event: SubmitEvent, isValid: boolean) => Promise<void | null | undefined>;
+}
+export interface ReturnOrderMessageProps {
+    translations: Record<string, string>;
+    routeReturnSuccess?: (orderData?: OrderDataModel) => string;
+    orderData?: OrderDataModel;
+}
+export interface UseCreateReturn {
+    orderData?: OrderDataModel;
+    onSuccess?: (response: onSuccessTypes) => void;
+    onError?: (message: string) => void;
+    handleSetInLineAlert: (value?: InLineAlertProps) => void;
+}
+export {};
+//# sourceMappingURL=createReturn.types.d.ts.map

package/types/customerDetails.types.d.ts

@@ -1,4 +1,6 @@
-import { OrderDataModel } from '../data/models';
+import { SlotProps } from '@dropins/tools/types/elsie/src/lib';
+import { OrderDataModel, OrdersReturnPropsModel } from '../data/models';
+import { IconNode, IconType } from '@dropins/tools/types/elsie/src/components';
 
 export interface KeysSortOrderProps {
     name: string;
@@ -13,18 +15,23 @@ export interface NormalizeAddressProps extends KeysSortOrderProps {
 }
 export interface CustomerDetailsProps {
     className?: string;
-    paymentIconsMap?: Record<string, string>;
+    paymentIconsMap?: Record<string, IconType | IconNode>;
     orderData?: OrderDataModel;
     withHeader?: boolean;
     title?: string;
+    slots?: {
+        OrderReturnInformation: SlotProps<OrdersReturnPropsModel | undefined>;
+        PaymentMethodIcon: SlotProps<Record<string, string>>;
+    };
 }
 export interface UseCustomerDetails {
     orderData?: OrderDataModel;
 }
 export interface CustomerDetailsContentProps extends Omit<CustomerDetailsProps, 'orderData' | 'className'> {
+    translations: Record<string, string>;
     loading: boolean;
     order?: OrderDataModel;
-    normalizeAddress?: {
+    normalizeAddress: {
         billingAddress: NormalizeAddressProps[][];
         shippingAddress: NormalizeAddressProps[][];
     };

package/types/emptyList.types.d.ts

@@ -0,0 +1,7 @@
+export interface EmptyListProps {
+    isEmpty: boolean;
+    typeList: 'orders';
+    minifiedView: boolean;
+    message: string;
+}
+//# sourceMappingURL=emptyList.types.d.ts.map

package/types/form.types.d.ts

@@ -28,7 +28,7 @@ export interface FieldsProps {
     defaultValue: string | boolean | number;
     entityType: string;
     required: boolean;
-    is_unique: boolean;
+    isUnique: boolean;
     label: string;
     orderNumber: number;
     options?: {

package/types/index.d.ts

@@ -1,11 +1,27 @@
-export * from './api/guestOrderByToken.types';
-export * from './api/getOrderDetails.types';
-export * from './api/getGuestOrder.types';
 export * from './api/getAttributesForm.types';
+export * from './api/getAttributesList.types';
 export * from './api/getCustomer.types';
-export * from './orderSearch.types';
+export * from './api/getCustomerOrdersReturn.types';
+export * from './api/getGuestOrder.types';
+export * from './api/getOrderDetails.types';
+export * from './api/guestOrderByToken.types';
+export * from './api/placeOrder.types';
+export * from './api/reorderItems.types';
+export * from './api/requestReturn.types';
+export * from './api/confirmGuestReturn.types';
+export * from './createReturn.types';
+export * from './customerDetails.types';
+export * from './emptyList.types';
 export * from './form.types';
+export * from './notification.types';
+export * from './orderCancel.types';
+export * from './orderCostSummary.types';
+export * from './orderHeader.types';
+export * from './orderProductList.types';
+export * from './orderSearch.types';
 export * from './orderStatus.types';
+export * from './reorder.types';
+export * from './returnsList.types';
 export * from './shippingStatus.types';
-export * from './customerDetails.types';
+export * from './orderEmailActionHandler.types';
 //# sourceMappingURL=index.d.ts.map

package/types/notification.types.d.ts

@@ -0,0 +1,14 @@
+import { VNode } from 'preact';
+import { HTMLAttributes } from 'preact/compat';
+
+export type AdditionalActionsAlertProps = Array<{
+    label: string;
+    onClick: (event: Event) => void;
+}>;
+export interface InLineAlertProps {
+    type: 'success' | 'warning' | 'error';
+    heading: string;
+    icon?: VNode<HTMLAttributes<SVGSVGElement>>;
+}
+export type statusTypes = '' | 'success' | 'error' | 'pending';
+//# sourceMappingURL=notification.types.d.ts.map

package/types/orderCancel.types.d.ts

@@ -0,0 +1,16 @@
+import { ButtonProps, PickerProps } from '@dropins/tools/types/elsie/src/src/components';
+import { PickerOption } from '@dropins/tools/types/elsie/src/components';
+
+export interface OrderCancelProps {
+    orderRef: string;
+}
+export interface OrderCancelFormProps {
+    orderRef: string;
+    pickerProps?: PickerProps;
+    submitButtonProps?: ButtonProps;
+    cancelReasons: PickerOption[];
+}
+export interface UseOrderActionsProps {
+    enableOrderCancellation: boolean | undefined;
+}
+//# sourceMappingURL=orderCancel.types.d.ts.map

package/types/orderCostSummary.types.d.ts

@@ -0,0 +1,29 @@
+import { HTMLAttributes } from 'preact/compat';
+import { OrderDataModel, StoreConfigModel } from '../data/models';
+
+type TaxTypes = {
+    taxIncluded: boolean;
+    taxExcluded: boolean;
+};
+export interface StoreConfigProps extends Omit<StoreConfigModel, 'orderCancellationEnabled' | 'orderCancellationReasons' | 'shoppingCartDisplayPrice' | 'shoppingOrdersDisplayShipping' | 'shoppingOrdersDisplaySubtotal'> {
+    shoppingCartDisplayPrice: TaxTypes;
+    shoppingOrdersDisplayShipping: TaxTypes;
+    shoppingOrdersDisplaySubtotal: TaxTypes;
+}
+export interface OrderCostSummaryProps extends HTMLAttributes<HTMLDivElement> {
+    orderData?: OrderDataModel;
+    withHeader?: boolean;
+}
+export interface OrderCostSummaryContentProps {
+    order?: OrderDataModel;
+    withHeader?: boolean;
+    loading?: boolean;
+    storeConfig: StoreConfigProps | null;
+    translations: Record<string, string>;
+}
+export interface UseOrderCostSummaryProps {
+    orderData?: OrderDataModel;
+    config: StoreConfigModel | null;
+}
+export {};
+//# sourceMappingURL=orderCostSummary.types.d.ts.map

package/types/orderEmailActionHandler.types.d.ts

@@ -0,0 +1,4 @@
+export interface OrderEmailActionHandlerProps {
+    routeRedirect: (orderToken: string, orderNumber: string, orderData: any) => string;
+}
+//# sourceMappingURL=orderEmailActionHandler.types.d.ts.map

package/types/orderHeader.types.d.ts

@@ -0,0 +1,19 @@
+import { OrderDataModel } from '../data/models';
+
+export interface SignUpContext {
+    inputsDefaultValueSet: DefaultValues;
+    addressesData: any[];
+}
+type DefaultValues = {
+    code: string;
+    defaultValue: string;
+}[];
+export interface OrderHeaderProps {
+    handleEmailAvailability?: (email: string) => Promise<boolean>;
+    handleSignUpClick?: (ctx: SignUpContext) => void;
+    orderData?: OrderDataModel;
+}
+export interface UseOrderHeaderProps extends OrderHeaderProps {
+}
+export {};
+//# sourceMappingURL=orderHeader.types.d.ts.map

package/types/orderProductList.types.d.ts

@@ -0,0 +1,36 @@
+import { OrderDataModel, OrderItemModel } from '../data/models';
+
+type options = Record<string, string | number | boolean>;
+export type TaxTypes = {
+    taxIncluded: boolean;
+    taxExcluded: boolean;
+};
+export interface OrderProductListProps {
+    orderData?: OrderDataModel;
+    className?: string;
+    withHeader?: boolean;
+    showConfigurableOptions?: (options: options | {}) => options;
+    routeProductDetails?: (product: any) => string;
+}
+export interface OrderProductListContentProps extends Omit<OrderProductListProps, 'className'> {
+    placeholderImage: string;
+    order?: OrderDataModel;
+    taxConfig: TaxTypes;
+    loading: boolean;
+}
+export interface CartSummaryItemProps {
+    placeholderImage?: string;
+    disabledIncrementer?: boolean;
+    loading: boolean;
+    itemType: string;
+    translations: Record<string, string>;
+    product: OrderItemModel;
+    taxConfig: TaxTypes;
+    onQuantity?: (value: number) => void;
+    showConfigurableOptions?: (options: options | {}) => options;
+    routeProductDetails?: (product: any) => string;
+}
+export interface UseOrderProductListProps extends Omit<OrderProductListProps, 'className' | 'withHeader' | 'showConfigurableOptions'> {
+}
+export {};
+//# sourceMappingURL=orderProductList.types.d.ts.map

package/types/orderStatus.types.d.ts

@@ -1,6 +1,6 @@
-import { HTMLAttributes } from 'preact/compat';
-import { OrderDataModel } from '../data/models';
+import { OrderDataModel, OrdersReturnPropsModel } from '../data/models';
 import { SlotProps } from '@dropins/tools/types/elsie/src/lib';
+import { UserInputErrorProps } from '.';
 
 export declare enum StatusEnumProps {
     PENDING = "pending",
@@ -15,24 +15,32 @@ export declare enum StatusEnumProps {
 type DefaultSlotContext = {
     orderData?: OrderDataModel;
 };
-export interface OrderStatusProps extends HTMLAttributes<HTMLDivElement> {
+export interface OrderStatusProps {
+    className?: string;
     orderData?: OrderDataModel;
     statusTitle?: string;
     status?: StatusEnumProps;
     slots?: {
         OrderActions: SlotProps<DefaultSlotContext>;
     };
+    routeCreateReturn?: (orderReturn: OrdersReturnPropsModel) => string;
+    routeOnSuccess?: () => string;
+    onError?: (errorInformation: UserInputErrorProps[] | string) => void;
 }
 export interface OrderStatusContentProps extends Omit<OrderStatusProps, 'statusTitle' | 'orderData' | 'status'> {
     title?: string;
     status?: StatusEnumProps;
     orderData?: OrderDataModel;
 }
-export interface OrderActionsProps extends HTMLAttributes<HTMLDivElement> {
+export interface OrderActionsProps {
+    className?: string;
     orderData?: OrderDataModel;
     slots?: {
         OrderActions: SlotProps<DefaultSlotContext>;
     };
+    routeCreateReturn?: (orderReturn: OrdersReturnPropsModel) => string;
+    routeOnSuccess?: () => string;
+    onError?: (errorInformation: UserInputErrorProps[] | string) => void;
 }
 export interface UseOrderStatusProps {
     orderData?: OrderDataModel;

package/types/reorder.types.d.ts

@@ -0,0 +1,9 @@
+import { OrderDataModel } from '../data/models';
+import { UserInputErrorProps } from '.';
+
+export interface ReorderProps {
+    orderData?: OrderDataModel;
+    routeOnSuccess?: () => string;
+    onError?: (errorInformation: UserInputErrorProps[] | string) => void;
+}
+//# sourceMappingURL=reorder.types.d.ts.map