@dropins/storefront-order 0.1.0-alpha3 → 0.1.0-alpha30

package/types/api/getAttributesForm.types.d.ts

@@ -0,0 +1,31 @@
+export interface ResponseAttributesFormItemsProps {
+    code: string;
+    sort_order: string;
+    default_value: null | string;
+    entity_type: string;
+    frontend_class: null | string;
+    multiline_count: number;
+    frontend_input: string;
+    is_required: boolean;
+    is_unique: boolean;
+    label: string;
+    options: {
+        is_default: boolean;
+        label: string;
+        value: string;
+    }[];
+}
+export interface GetAttributesFormResponse {
+    data: {
+        attributesForm: {
+            errors?: {
+                message: string;
+            }[];
+            items?: ResponseAttributesFormItemsProps[];
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# sourceMappingURL=getAttributesForm.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/getCustomer.types.d.ts

@@ -0,0 +1,13 @@
+export interface getCustomerShortResponse {
+    data: {
+        customer: {
+            firstname: string;
+            lastname: string;
+            email: string;
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# sourceMappingURL=getCustomer.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

@@ -1,4 +1,4 @@
-export type QueryType = 'orderData' | 'orderSummary' | 'orderStatus' | 'orderCustomerInformation';
+export type QueryType = 'orderData';
 export interface UserAddressesProps {
     city?: string;
     company?: string;
@@ -16,21 +16,29 @@ export interface UserAddressesProps {
     telephone?: string;
     vat_id?: string;
 }
-interface SmallImageProps {
+interface ThumbnailImageProps {
     url?: string;
+    label?: string;
 }
-interface ProductProps {
-    small_image?: SmallImageProps;
-}
-export interface OrderItemProps {
-    status?: string;
-    product_name?: string;
-    id?: string;
-    product?: ProductProps;
+export interface ProductProps {
+    thumbnail?: ThumbnailImageProps;
+    image: ThumbnailImageProps;
+    canonical_url: string;
+    url_key: string;
+    id: string;
+    uid: string;
+    name: string;
+    __typename: string;
+    sku: string;
+    price_range: {
+        maximum_price: {
+            regular_price: MoneyProps;
+        };
+    };
 }
 export interface MoneyProps {
-    value?: number;
-    currency?: string;
+    value: number;
+    currency: string;
 }
 interface GrandTotalProps extends MoneyProps {
 }
@@ -48,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[];
@@ -72,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: {
@@ -89,7 +96,15 @@ export interface GiftWrappingProps {
         };
     };
 }
-interface OrderItemInterface {
+export interface giftCardProps {
+    sender_name: string;
+    sender_email: string;
+    recipient_email: string;
+    recipient_name: string;
+    message: string;
+}
+export interface OrderItemProps {
+    __typename: string;
     discounts: DiscountProps[];
     eligible_for_return: boolean;
     entered_options: {
@@ -111,13 +126,33 @@ interface OrderItemInterface {
     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 {
+export interface PaymentMethodsProps {
     name: string;
     type: string;
     additional_data: {
@@ -125,7 +160,60 @@ export interface paymentMethodsProps {
         value: string;
     }[];
 }
+export interface ShipmentsProps {
+    id: string;
+    number: string;
+    tracking: {
+        carrier: string;
+        number: string;
+        title: string;
+    }[];
+    comments: {
+        message: string;
+        timestamp: string;
+    }[];
+    items: {
+        id: string;
+        product_sku: string;
+        product_name: string;
+    };
+}
+export declare enum AvailableActionsProps {
+    CANCEL = "CANCEL",
+    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;
     status: string;
     token: string;
@@ -139,29 +227,17 @@ export interface OrderProps {
     applied_coupons: {
         code: string;
     }[];
-    shipments: {
-        id: string;
-        number: string;
-        tracking: {
-            carrier: string;
-            number: string;
-            title: string;
-        }[];
-        comments: {
-            message: string;
-            timestamp: string;
-        }[];
-    }[];
     returns: {
-        pageSize: number;
-        currentPage: number;
+        __typename: string;
+        items: ReturnsItemsProps[];
     };
-    items_eligible_for_return: OrderItemInterface[];
+    shipments: ShipmentsProps[];
+    items_eligible_for_return: OrderItemProps[];
+    items: OrderItemProps[];
     gift_wrapping: GiftWrappingProps;
     gift_message: GiftMessageProps;
-    payment_methods: paymentMethodsProps[];
+    payment_methods: PaymentMethodsProps[];
     invoices: InvoiceProps[];
-    items: OrderItemProps[];
     shipping_address: UserAddressesProps;
     billing_address: UserAddressesProps;
     total?: TotalProps;
@@ -171,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/guestOrderByToken.types.d.ts

@@ -0,0 +1,13 @@
+import { OrderProps } from '..';
+
+export interface GuestOrderByTokenProps extends OrderProps {
+}
+export interface GuestOrderByTokenResponse {
+    data: {
+        guestOrderByToken?: GuestOrderByTokenProps;
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# sourceMappingURL=guestOrderByToken.types.d.ts.map

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,33 @@
+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 ReturnProps {
+    uid: string;
+    number: string;
+    status: string;
+    created_at: string;
+}
+export interface RequestReturnResponse {
+    data: {
+        requestReturn: {
+            return: ReturnProps;
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+//# 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

@@ -0,0 +1,59 @@
+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;
+    orderNumber?: number;
+    label?: string | null;
+}
+export interface NormalizeAddressProps extends KeysSortOrderProps {
+    name: string;
+    orderNumber: number;
+    value?: string | string[];
+    label?: string | null;
+}
+export interface CustomerDetailsProps {
+    className?: 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: {
+        billingAddress: NormalizeAddressProps[][];
+        shippingAddress: NormalizeAddressProps[][];
+    };
+}
+export interface CustomerAddressesModel {
+    firstname?: string;
+    lastname?: string;
+    city?: string;
+    company?: string;
+    countryCode?: string;
+    region?: {
+        region: string;
+        regionCode: string;
+        regionId: string | number;
+    };
+    telephone?: string;
+    id?: string;
+    vatId?: string;
+    postcode?: string;
+    street?: string;
+    street_2?: string;
+    defaultShipping?: boolean;
+    defaultBilling?: boolean;
+}
+//# sourceMappingURL=customerDetails.types.d.ts.map

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

@@ -26,15 +26,15 @@ export interface FieldsProps {
     code: string;
     name: string;
     defaultValue: string | boolean | number;
-    entity_type: string;
+    entityType: string;
     required: boolean;
-    is_unique: boolean;
+    isUnique: boolean;
     label: string;
     orderNumber: number;
-    options: {
-        is_default: boolean;
-        label: string;
-        value: string;
+    options?: {
+        is_default?: boolean;
+        label?: string;
+        value?: string;
     }[];
 }
 export interface FormProps {

package/types/index.d.ts

@@ -1,5 +1,25 @@
-export * from './api/getOrderDetails.types';
+export * from './api/getAttributesForm.types';
+export * from './api/getAttributesList.types';
+export * from './api/getCustomer.types';
+export * from './api/getCustomerOrdersReturn.types';
 export * from './api/getGuestOrder.types';
-export * from './orderSearch.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 './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';
 //# 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 ConfirmCancelOrderProps {
+    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