@dropins/storefront-order 0.1.0-alpha4 → 0.1.0-alpha6

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,17 +16,23 @@ 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;
+    uid: string;
+    name: string;
+    __typename: string;
+    sku: string;
+    price_range: {
+        maximum_price: {
+            regular_price: MoneyProps;
+        };
+    };
 }
 export interface MoneyProps {
     value?: number;
@@ -89,7 +95,14 @@ export interface GiftWrappingProps {
         };
     };
 }
-interface OrderItemInterface {
+export interface giftCardProps {
+    sender_name: string;
+    sender_email: string;
+    recipient_email: string;
+    recipient_name: string;
+}
+export interface OrderItemProps {
+    __typename: string;
     discounts: DiscountProps[];
     eligible_for_return: boolean;
     entered_options: {
@@ -116,8 +129,9 @@ interface OrderItemInterface {
         value: string;
     }[];
     status: string;
+    gift_card?: giftCardProps;
 }
-export interface paymentMethodsProps {
+export interface PaymentMethodsProps {
     name: string;
     type: string;
     additional_data: {
@@ -125,7 +139,31 @@ 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 OrderProps {
+    available_actions: AvailableActionsProps[];
     shipping_method: string;
     status: string;
     token: string;
@@ -139,29 +177,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;
     };
-    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;

package/types/customerDetails.types.d.ts

@@ -0,0 +1,49 @@
+import { OrderDataModel } from '../data/models';
+
+export interface KeysSortOrderProps {
+    name: string;
+    orderNumber?: number;
+    label?: string | null;
+}
+export interface NormalizeAddressProps extends KeysSortOrderProps {
+    value: any;
+}
+export interface CustomerDetailsProps {
+    className?: string;
+    paymentIconsMap?: Record<string, string>;
+    orderData?: OrderDataModel;
+    withHeader?: boolean;
+    title?: string;
+}
+export interface UseCustomerDetails {
+    orderData?: OrderDataModel;
+}
+export interface CustomerDetailsContentProps extends Omit<CustomerDetailsProps, 'orderData' | 'className'> {
+    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/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;
     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,6 +1,10 @@
+export * from './api/guestOrderByToken.types';
 export * from './api/getOrderDetails.types';
 export * from './api/getGuestOrder.types';
+export * from './api/getAttributesForm.types';
 export * from './orderSearch.types';
 export * from './form.types';
-export * from './api/guestOrderByToken.types';
+export * from './orderStatus.types';
+export * from './shippingStatus.types';
+export * from './customerDetails.types';
 //# sourceMappingURL=index.d.ts.map

package/types/orderSearch.types.d.ts

@@ -14,16 +14,16 @@ export interface inLineAlertProps {
 }
 export interface OrderSearchProps {
     className?: string;
-    onError?: (errorInformation: errorInformationProps) => void;
+    onError?: (errorInformation: errorInformationProps) => boolean | Promise<boolean> | undefined;
 }
 export interface useOrderSearchProps {
-    onError?: (errorInformation: errorInformationProps) => void;
+    onError?: (errorInformation: errorInformationProps) => boolean | Promise<boolean> | undefined;
 }
-export interface OrderSearchFormProps extends Omit<OrderSearchProps, 'className' | 'onError'> {
+export interface OrderSearchFormProps {
     onSubmit?: (event: SubmitEvent, isValid: boolean) => Promise<void | null | undefined>;
-    loading: boolean;
+    loading?: boolean;
     inLineAlert: inLineAlertProps;
-    fieldsConfig: FieldsProps[];
+    fieldsConfig?: FieldsProps[];
 }
 export interface useOrderSearch extends Omit<OrderSearchProps, 'className'> {
 }

package/types/orderStatus.types.d.ts

@@ -0,0 +1,41 @@
+import { HTMLAttributes } from 'preact/compat';
+import { OrderDataModel } from '../data/models';
+import { SlotProps } from '@dropins/tools/types/elsie/src/lib';
+
+export declare enum StatusEnumProps {
+    PENDING = "pending",
+    SHIPPING = "shipping",
+    COMPLETE = "complete",
+    PROCESSING = "processing",
+    HOLD = "on hold",
+    CANCELED = "Canceled",
+    SUSPECTED_FRAUD = "suspected fraud",
+    PAYMENT_REVIEW = "payment review"
+}
+type DefaultSlotContext = {
+    orderData?: OrderDataModel;
+};
+export interface OrderStatusProps extends HTMLAttributes<HTMLDivElement> {
+    orderData?: OrderDataModel;
+    statusTitle?: string;
+    status?: StatusEnumProps;
+    slots?: {
+        OrderActions: SlotProps<DefaultSlotContext>;
+    };
+}
+export interface OrderStatusContentProps extends Omit<OrderStatusProps, 'statusTitle' | 'orderData' | 'status'> {
+    title?: string;
+    status?: StatusEnumProps;
+    orderData?: OrderDataModel;
+}
+export interface OrderActionsProps extends HTMLAttributes<HTMLDivElement> {
+    orderData?: OrderDataModel;
+    slots?: {
+        OrderActions: SlotProps<DefaultSlotContext>;
+    };
+}
+export interface UseOrderStatusProps {
+    orderData?: OrderDataModel;
+}
+export {};
+//# sourceMappingURL=orderStatus.types.d.ts.map

package/types/shippingStatus.types.d.ts

@@ -0,0 +1,18 @@
+import { HTMLAttributes } from 'preact/compat';
+import { SlotProps } from '@dropins/tools/types/elsie/src/lib';
+import { OrderDataModel } from '../data/models';
+
+export interface ShippingStatusProps extends HTMLAttributes<HTMLDivElement> {
+    orderData?: OrderDataModel;
+    collapseThreshold?: number;
+    slots?: {
+        DeliveryTimeLine?: SlotProps;
+        DeliveryTrackActions?: SlotProps;
+    };
+}
+export interface UseShippingStatusProps {
+    orderData?: OrderDataModel;
+}
+export interface ShippingStatusCardProps extends ShippingStatusProps {
+}
+//# sourceMappingURL=shippingStatus.types.d.ts.map

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

@@ -1,21 +0,0 @@
-import { DiscountProps, GuestOrderProps, MoneyProps, paymentMethodsProps, UserAddressesProps } from '../../types';
-
-export interface GuestOrderModel extends Omit<GuestOrderProps, 'shipping_address' | 'billing_address' | 'payment_methods' | 'gift_receipt_included' | 'order_date' | 'printed_card_included' | 'shipping_method' | 'total'> {
-    defaultShipping: UserAddressesProps;
-    defaultBulling: UserAddressesProps;
-    paymentMethods: paymentMethodsProps[];
-    giftReceiptIncluded: boolean;
-    orderDate: string;
-    printedCardIncluded: boolean;
-    shippingMethod: string;
-    total: {
-        discounts: DiscountProps[] | null;
-        subtotal: MoneyProps | null;
-        totalTax: MoneyProps | null;
-        totalShipping: MoneyProps | null;
-        grandTotal: MoneyProps | null;
-    };
-    token: string;
-}
-export type GuestOrderModelResponse = GuestOrderModel | null;
-//# sourceMappingURL=guest-order.d.ts.map