@shipengine/elements 2.6.0 → 2.8.0

package/src/elements/payment-method-settings/payment-method-settings-element.d.ts

@@ -552,6 +552,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -568,6 +569,12 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -799,11 +806,18 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/elements/purchase-label/purchase-label.d.ts

@@ -748,6 +748,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -764,6 +765,12 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -1009,11 +1016,18 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -1082,11 +1096,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     invalidStateProvince: string;
                     invalidString: string;
                     nonnegative: string;
-                    /**
-                     * # Purchase Label Component Props
-                     *
-                     * @see {@link PurchaseLabel.Component | The **Common Props** used in the `<PurchaseLabel /> component`}
-                     */
                     nonnegativeList: string;
                     positive: string;
                     positiveList: string;

package/src/elements/shipment-summary/shipment-summary.d.ts

@@ -649,6 +649,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -665,6 +666,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -898,11 +905,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/elements/shipments-grid/hooks/use-shipments-grid.d.ts

@@ -1,8 +1,7 @@
-/// <reference types="react" />
 import { SE } from "@shipengine/js-api";
 import { IGridFilters } from "../../../components";
 import { ShipmentsGridProps } from "../shipments-grid";
-export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, }: ShipmentsGridProps) => {
+export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => {
     clearAllFilters: () => void;
     filters: IGridFilters;
     getGridData: () => {
@@ -89,7 +88,7 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
         showPagination: boolean;
         totalElements: number;
     };
-    setFilters: import("react").Dispatch<import("react").SetStateAction<IGridFilters>>;
+    setFilters: (newFilters: IGridFilters) => void;
     shipments: {
         serviceName: string | null | undefined;
         addressValidation?: SE.AddressValidation | undefined;

package/src/elements/shipments-grid/shipments-grid.d.ts

@@ -15,6 +15,10 @@ export type ShipmentsGridProps = {
      * If no value is defined, all shipments will be rendered.
      */
     shipmentStatus?: SE.ShipmentStatus;
+    /**
+     * `showCreatedDateFilter` controls the display of the Created Date filter
+     */
+    showCreatedDateFilter?: boolean;
     /**
      * `showShipmentIdFilter` controls the display of the shipmentId search filter
      */
@@ -41,7 +45,7 @@ export type ShipmentsGridProps = {
  *
  * @see {@link ShipmentsGrid.Element | The **Element** created to render `<ShipmentsGrid />`}
  */
-export declare const Component: ({ onRowClick, shipmentStatus, showShipmentIdFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ onRowClick, shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Shipments Grid Element
  *
@@ -105,7 +109,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 refund_rules: string;
                 resultTitles: {
                     approved: string;
-                    rejected: string;
+                    rejected: string; /**
+                     * `showCreatedDateFilter` controls the display of the Created Date filter
+                     */
                 };
                 voidedOn: string;
             };
@@ -155,7 +161,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 vatFormErrors: {
                     invalidFieldValue: string;
                     verificationFailure: string;
-                    forbidden: string;
+                    forbidden: string; /**
+                     * `shipmentStatus` is the status of the shipments you wish to view.
+                     * If no value is defined, all shipments will be rendered.
+                     */
                     connectionNotSupported: string;
                     genericTitle: string;
                     genericText: string;
@@ -204,7 +213,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         };
                         poBox: {
                             title: string;
-                            description: string;
+                            description: string; /**
+                             * `showCreatedDateFilter` controls the display of the Created Date filter
+                             */
                         };
                         carrier: {
                             title: string;
@@ -255,18 +266,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     tax: string;
                     delivery: string;
                     handling: string;
-                    /**
-                     * # Shipments Grid Props
-                     *
-                     * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
-                     */
                     special_goods: string;
                     pickup: string;
                     location_fee: string;
                     oversize: string;
-                    returns: string; /**
-                     * `onRowClick` callback invoked when a row is clicked.
-                     */
+                    returns: string;
                     notifications: string;
                     tip: string;
                     duties_and_taxes: string;
@@ -514,7 +518,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         title: string;
                         message: string;
                     };
-                    isLoading: string;
+                    isLoading: string; /**
+                     * `showShipmentIdFilter` controls the display of the shipmentId search filter
+                     */
                     labels: {
                         amount: string;
                     };
@@ -621,6 +627,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -637,6 +644,12 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -704,9 +717,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         county: string;
                         countryCode: string;
                         addressLine1: string;
-                        addressLine2: string; /**
-                         * `onRowClick` callback invoked when a row is clicked.
-                         */
+                        addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
                         postalCode: string;
@@ -870,11 +881,18 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -1020,9 +1038,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string; /**
-                     * `onRowClick` callback invoked when a row is clicked.
-                     */
+                    carriers: string;
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;

package/src/elements/shipments-grid/utils/created-date-value.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This functions receive an start and end Dates and prepare an object that can be passed to the API.
+ */
+export declare const getCreatedDateFilterValue: (start: Date | undefined, end: Date | undefined) => {
+    createdAtEnd?: undefined;
+    createdAtStart?: undefined;
+} | {
+    createdAtEnd: string;
+    createdAtStart: string;
+};
+/**
+ * Given an start/end Dates and the Shipment Creation date we check if the Shipment creation date
+ * its the same as the one selected by the user or within an interval
+ */
+export declare const filterDateAndShipmentDateIsSameOrWithinInterval: (start: Date, end: Date, shipmentCreationDate: string) => boolean;

package/src/elements/shipments-grid/utils/index.d.ts

@@ -0,0 +1 @@
+export { getCreatedDateFilterValue, filterDateAndShipmentDateIsSameOrWithinInterval, } from "./created-date-value";

package/src/elements/theme-creator/theme-creator.d.ts

@@ -564,6 +564,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -580,6 +581,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -811,11 +818,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/elements/theme-creator/themeData/themeData.d.ts

@@ -1,2 +1,2 @@
 import { CustomThemeData } from "@shipengine/giger-theme";
-export declare const themeData: CustomThemeData;
+export declare const auctaneThemeData: CustomThemeData;

package/src/elements/transaction-history/transaction-history-element.d.ts

@@ -551,6 +551,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -567,6 +568,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -798,11 +805,18 @@ export declare const Element: ({ resources, ...props }: object & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/elements/unit-settings/unit-settings-element.d.ts

@@ -551,6 +551,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -567,6 +568,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -798,11 +805,18 @@ export declare const Element: ({ resources, ...props }: object & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/elements/vat-settings/vat-settings-element.d.ts

@@ -551,6 +551,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -567,6 +568,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -798,11 +805,18 @@ export declare const Element: ({ resources, ...props }: object & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/elements/void-label/void-label.d.ts

@@ -684,6 +684,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -700,6 +701,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -936,11 +943,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/locales/en/index.d.ts

@@ -547,6 +547,7 @@ declare const _default: {
             shipping: string;
             shipDate: string;
             status: string;
+            trackingStatus: string;
         };
         empty: {
             title: string;
@@ -563,6 +564,12 @@ declare const _default: {
             completed: string;
             processing: string;
         };
+        trackingStatus: {
+            unknown: string;
+            inTransit: string;
+            delivered: string;
+            error: string;
+        };
         actions: {
             title: string;
             print: string;
@@ -794,11 +801,18 @@ declare const _default: {
             rows: string;
             clearAll: string;
             shipmentId: string;
+            createdDate: string;
             shipmentIdFilter: string;
+            createdDateFilter: string;
             apply: string;
             clear: string;
             search: string;
             shipmentIdHint: string;
+            dateFilterToday: string;
+            dateFilterLast7Days: string;
+            dateFilterLast30Days: string;
+            dateFilterLast12Months: string;
+            dateFilterCustom: string;
         };
         insuranceProviders: {
             carrier: string;

package/src/utilities/date.d.ts

@@ -120,7 +120,7 @@ export declare const sortByCreationDate: (a: HasCreationDate, b: HasCreationDate
  *
  * @category Utilities
  */
-export declare const isNowOrInTheFuture: (shipDate?: string) => boolean;
+export declare const isNowOrInTheFuture: (date?: string | Date) => boolean;
 /**
  * @internal
  *

package/src/workflows/account-settings/account-settings.d.ts

@@ -585,6 +585,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -601,6 +602,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -832,11 +839,18 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;

package/src/workflows/carrier-services/carrier-services.d.ts

@@ -577,6 +577,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     shipping: string;
                     shipDate: string;
                     status: string;
+                    trackingStatus: string;
                 };
                 empty: {
                     title: string;
@@ -593,6 +594,12 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     completed: string;
                     processing: string;
                 };
+                trackingStatus: {
+                    unknown: string;
+                    inTransit: string;
+                    delivered: string;
+                    error: string;
+                };
                 actions: {
                     title: string;
                     print: string;
@@ -824,11 +831,18 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    createdDate: string;
                     shipmentIdFilter: string;
+                    createdDateFilter: string;
                     apply: string;
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    dateFilterToday: string;
+                    dateFilterLast7Days: string;
+                    dateFilterLast30Days: string;
+                    dateFilterLast12Months: string;
+                    dateFilterCustom: string;
                 };
                 insuranceProviders: {
                     carrier: string;