@shipengine/elements 2.21.0 → 2.22.0

package/types/src/components/grid-filters/components/label-id-filter/label-id-filter.d.ts

@@ -7,6 +7,7 @@ import { IGridFilters } from "../../grid-filters";
  * @see {@link LabelIdFilter | The `<LabelIdFilter />` component}
  */
 type LabelIdFilterProps = {
+    disabled?: boolean;
     filters: IGridFilters;
     onFiltersUpdated: (params: IGridFilters) => void;
 };
@@ -19,5 +20,5 @@ type LabelIdFilterProps = {
  *
  * @see {@link LabelIdFilterProps | The props for the `<LabelIdFilter />` component}
  */
-export declare const LabelIdFilter: ({ filters, onFiltersUpdated }: LabelIdFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const LabelIdFilter: ({ disabled, filters, onFiltersUpdated, }: LabelIdFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

package/types/src/components/grid-filters/components/shipment-id-filter/shipment-id-filter.d.ts

@@ -7,6 +7,7 @@ import { IGridFilters } from "../../grid-filters";
  * @see {@link ShipmentIdFilter | The `<ShipmentIdFilter />` component}
  */
 type ShipmentIdFilterProps = {
+    disabled?: boolean;
     filters: IGridFilters;
     onFiltersUpdated: (params: IGridFilters) => void;
 };
@@ -19,5 +20,5 @@ type ShipmentIdFilterProps = {
  *
  * @see {@link ShipmentIdFilterProps | The props for the `<ShipmentIdFilter />` component}
  */
-export declare const ShipmentIdFilter: ({ filters, onFiltersUpdated }: ShipmentIdFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ShipmentIdFilter: ({ disabled, filters, onFiltersUpdated, }: ShipmentIdFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

package/types/src/components/grid-filters/components/tracking-status-filter/tracking-status-filter.d.ts

@@ -7,6 +7,7 @@ import { IGridFilters } from "../../grid-filters";
  * @see {@link TrackingStatusFilter | The `<TrackingStatusFilter />` component}
  */
 type TrackingStatusFilterProps = {
+    disabled?: boolean;
     filters: IGridFilters;
     onFiltersUpdated: (params: IGridFilters) => void;
 };
@@ -19,5 +20,5 @@ type TrackingStatusFilterProps = {
  *
  * @see {@link TrackingStatusFilterProps | The props for the `<TrackingStatusFilter />` component}
  */
-export declare const TrackingStatusFilter: ({ filters, onFiltersUpdated }: TrackingStatusFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const TrackingStatusFilter: ({ disabled, filters, onFiltersUpdated, }: TrackingStatusFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

package/types/src/components/grid-filters/grid-filters.d.ts

@@ -8,6 +8,7 @@ import { LabelTrackingStatus } from "@shipengine/js-api";
  */
 type GridFilterProps = {
     filters: IGridFilters;
+    filtersDisabled?: boolean;
     onClearAllFilters: () => void;
     onFiltersUpdated: (params: IGridFilters) => void;
 };
@@ -35,5 +36,5 @@ export interface IGridFilters {
  *
  * @see {@link GridFiltersProps | The props for the `<GridFilters />` component}
  */
-export declare const GridFilters: ({ filters, onFiltersUpdated, onClearAllFilters }: GridFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const GridFilters: ({ filters, onFiltersUpdated, filtersDisabled, onClearAllFilters, }: GridFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

package/types/src/elements/labels-grid/hooks/use-labels-grid.d.ts

@@ -1,15 +1,14 @@
-import { SortDirection } from "../../../components/grid-controller";
 import { IGridFilters } from "../../../components/grid-filters";
 import { LabelTrackingStatus, SE } from "@shipengine/react-api";
 import { LabelsGridProps } from "../";
 import { Label } from "../labels-grid";
-export declare const useLabelsGrid: ({ createdDateSortBy, labelStatus, showShipmentIdFilter, showLabelIdFilter, showTrackingStatusFilter, fetchShipments, }: {
-    createdDateSortBy?: SortDirection | undefined;
+export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter, showLabelIdFilter, showTrackingStatusFilter, fetchShipments, sortDir, }: {
     fetchShipments?: boolean | undefined;
     labelStatus: LabelsGridProps["labelStatus"];
     showLabelIdFilter?: boolean | undefined;
     showShipmentIdFilter?: boolean | undefined;
     showTrackingStatusFilter?: boolean | undefined;
+    sortDir?: SE.SortableQuery["sortDir"];
 }) => {
     clearAllFilters: () => void;
     filters: IGridFilters;
@@ -62,8 +61,10 @@ export declare const useLabelsGrid: ({ createdDateSortBy, labelStatus, showShipm
         voided: boolean;
         voidedAt: string | null;
     }[];
+    hasMoreUnfetchedResults: boolean | undefined;
     isAnyFilterActive: boolean;
     isError: boolean | undefined;
+    isFetchingNextPage: boolean;
     isLoading: boolean | undefined;
     labels: Label[];
     pageConfig: {

package/types/src/elements/labels-grid/hooks/use-tracking-status-filter.d.ts

@@ -0,0 +1,25 @@
+import { LabelTrackingStatus, SE } from "@shipengine/js-api";
+export declare const useTrackingStatusFilter: ({ isActive, labelStatus, shipmentId, trackingStatusFilters, sortDir, currentPage, pageSize, }: {
+    currentPage: number;
+    isActive: boolean;
+    labelStatus?: SE.LabelStatus | undefined;
+    pageSize: number;
+    shipmentId?: string | undefined;
+    sortDir: SE.SortableQuery["sortDir"];
+    trackingStatusFilters: LabelTrackingStatus[];
+}) => {
+    allLabelsCount: number;
+    fetchNextPage: (options?: import("@tanstack/query-core").FetchNextPageOptions | undefined) => Promise<import("@tanstack/query-core").InfiniteQueryObserverResult<SE.ListLabelsResult, SE.CodedError[]>>;
+    filteredLabelsCount: number;
+    hasMorePages: boolean | undefined;
+    hasMoreUnfetchedResults: boolean | undefined;
+    isFetchingNextPage: boolean;
+    isLoading: boolean;
+    labels: SE.Label[];
+    paginationInfo: {
+        currentPage: number;
+        pageSize: number;
+        totalCount: number;
+        totalPages: number;
+    };
+};

package/types/src/elements/labels-grid/labels-grid.d.ts

@@ -143,18 +143,14 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                         };
                         registerSuccess: {
                             title: string;
-                            description: string;
-                        }; /**
-                         * `onClickExternalOrderId` is an optional callback function that will be invoked when the user clicks the id number within the
-                         * `External Order ID` column, if present.
-                         */
+                            description: string; /**
+                             * `onClickExternalOrderId` is an optional callback function that will be invoked when the user clicks the id number within the
+                             * `External Order ID` column, if present.
+                             */
+                        };
                     };
                 };
                 highVolumeForms: string;
-                /**
-                 * `onClickExternalShipmentId` is an optional callback function that will be invoked when the user clicks the id number within
-                 * `External Shipment Id` column, if present.
-                 */
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
@@ -234,10 +230,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                         };
                         poBox: {
                             title: string;
-                            description: string; /**
-                             * `onClickExternalOrderId` is an optional callback function that will be invoked when the user clicks the id number within the
-                             * `External Order ID` column, if present.
-                             */
+                            description: string;
                         };
                         carrier: {
                             title: string;
@@ -255,10 +248,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                         title: string;
                         subtitleCard: string;
                         subtitleBilling: string;
-                    }; /**
-                     * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
-                     * `Print Label` button.
-                     */
+                    };
                 };
             };
             "register-carrier": {
@@ -336,6 +326,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                     saveRateFailedMessage: string;
                     saveRateFailedTitle: string;
                 };
+                /**
+                 * `onClickExternalOrderId` is an optional callback function that will be invoked when the user clicks the id number within the
+                 * `External Order ID` column, if present.
+                 */
                 errorTypes: {
                     results: string;
                 };
@@ -369,7 +363,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                         fractional: string;
                     };
                     weightGroup: string;
-                    today: string;
+                    today: string; /**
+                     * `onViewDetails` is a callback function that controls the "View Details" action button and
+                     *  will be invoked when the user clicks on it.
+                     */
                 };
                 hints: {
                     contentDescription: string;
@@ -713,7 +710,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                     printForms: string;
                 };
                 errorMessages: {
-                    title: string;
+                    title: string; /**
+                     * `labelStatus` is the status of the labels you wish to view.
+                     * If no value is defined, all labels will be rendered.
+                     */
                     subtitle: string;
                 };
             };
@@ -746,7 +746,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                 settingsModal: {
                     closeDialog: string;
                     header: string;
-                };
+                }; /**
+                 * `features` provides optional feature configuration for the Element
+                 * If no value is defined, default configuration will be used.
+                 */
                 status: {
                     connected: string;
                 };
@@ -804,9 +807,17 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                     paste: string;
                     preference: {
                         confirm: string;
+                        /**
+                         * `features` provides optional feature configuration for the Element
+                         * If no value is defined, default configuration will be used.
+                         */
                         addressNotValidated: string;
                         modified: string;
                         title: string;
+                        /**
+                         * `labelStatus` is the status of the labels you wish to view.
+                         * If no value is defined, all labels will be rendered.
+                         */
                         originalAddress: string;
                         matchedAddress: string;
                         unableToValidate: string;
@@ -830,7 +841,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                         cvvPlaceholder: string;
                         expirationPlaceholder: string;
                         cardNumberPlaceholder: string;
-                    };
+                    }; /**
+                     * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
+                     * `Print Label` button.
+                     */
                 };
                 carriers: {
                     fields: {
@@ -972,6 +986,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/elements/manage-carriers/manage-carriers.d.ts

@@ -928,6 +928,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/elements/manage-external-carriers/manage-external-carriers.d.ts

@@ -971,6 +971,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/elements/manage-funding/manage-funding-element.d.ts

@@ -905,6 +905,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/elements/manage-warehouses/manage-warehouses.d.ts

@@ -939,6 +939,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -904,6 +904,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/elements/purchase-label/components/fund-and-purchase/fund-and-purchase.d.ts

@@ -16,7 +16,7 @@ export type FundAndPurchaseProps = {
     isFundingEnabled?: boolean;
     isInvalidatedByError?: boolean;
     onPurchase: () => void;
-    onSave: () => Promise<void>;
+    onSave?: () => Promise<void>;
     onVatRegistrationComplete?: () => void;
     rateData?: {
         isPreferredRate?: boolean;
@@ -35,4 +35,4 @@ export type FundAndPurchaseProps = {
  *
  * @see {@link FundAndPurchaseProps | The props that are passed into the `<FundAndPurchase />` component}
  */
-export declare const FundAndPurchase: ({ control, currency, disabled, isFundingEnabled, showVatSettings, onSave, onPurchase, onVatRegistrationComplete, isInvalidatedByError, rateData, }: FundAndPurchaseProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const FundAndPurchase: ({ control, currency, disabled, isFundingEnabled, isInvalidatedByError, onPurchase, onSave, onVatRegistrationComplete, rateData, showVatSettings, }: FundAndPurchaseProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1163,6 +1163,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/elements/select-label-layout/select-label-layout-element.d.ts

@@ -903,6 +903,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -1032,6 +1032,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -1,7 +1,13 @@
 import { IGridFilters } from "../../../components/grid-filters";
 import { SE } from "@shipengine/js-api";
 import { ShipmentsGridProps } from "../shipments-grid";
-export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => {
+export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, sortBy, sortDir, }: {
+    shipmentStatus: ShipmentsGridProps["shipmentStatus"];
+    showCreatedDateFilter: ShipmentsGridProps["showCreatedDateFilter"];
+    showShipmentIdFilter: ShipmentsGridProps["showShipmentIdFilter"];
+    sortBy?: SE.SortableQuery["sortBy"];
+    sortDir?: SE.SortableQuery["sortDir"];
+}) => {
     clearAllFilters: () => void;
     filters: IGridFilters;
     getGridData: () => {

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

@@ -187,6 +187,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     invalidFieldValue: string;
                     verificationFailure: string;
                     forbidden: string;
+                    /**
+                     * # Shipments Grid Props
+                     *
+                     * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
+                     */
                     connectionNotSupported: string;
                     genericText: string;
                 };
@@ -804,7 +809,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     parserFields: {
                         fullAddress: string;
                     };
-                    paste: string;
+                    paste: string; /**
+                     * `onClickCancelShipment` is a callback function that controls the display of `Cancel shipment` option and
+                     *  will be invoked when the user clicks on it.
+                     */
                     preference: {
                         confirm: string;
                         addressNotValidated: string;
@@ -975,6 +983,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -905,6 +905,7 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -903,6 +903,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -903,6 +903,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -903,6 +903,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -1003,6 +1003,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/hooks/use-sortable-query.d.ts

@@ -0,0 +1,13 @@
+import { SE } from "@shipengine/js-api";
+export declare const useSortableQuery: ({ defaultSortBy, defaultSortDir }: {
+    defaultSortBy?: string | undefined;
+    defaultSortDir?: string | undefined;
+}) => {
+    sortState: {
+        by: "modified_at" | "created_at" | undefined;
+        createdAtDir: "desc" | "asc" | undefined;
+        dir: "desc" | "asc" | undefined;
+        modifiedAtDir: "desc" | "asc" | undefined;
+    };
+    toggleSort: (sortQuery: SE.SortableQuery["sortBy"]) => void;
+};

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

@@ -899,6 +899,7 @@ declare const _default: {
         grid: {
             "row-count_one": string;
             "row-count_other": string;
+            "row-count-plus_other": string;
             rows: string;
             clearAll: string;
             shipmentId: string;

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

@@ -935,6 +935,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

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

@@ -930,6 +930,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & i
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/workflows/connect-external-carrier/connect-external-carrier.d.ts

@@ -936,6 +936,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/workflows/label-workflow/label-workflow.d.ts

@@ -1010,6 +1010,7 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;

package/types/src/workflows/onboarding/onboarding.d.ts

@@ -998,6 +998,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 grid: {
                     "row-count_one": string;
                     "row-count_other": string;
+                    "row-count-plus_other": string;
                     rows: string;
                     clearAll: string;
                     shipmentId: string;