@shipengine/elements 2.22.0 → 2.23.0

package/esm/hooks/use-configure-shipment.js

@@ -1,15 +1,13 @@
 import { __awaiter } from 'tslib';
-import { useQueryClient } from '@tanstack/react-query';
 import { getDefaultShipFromAddress } from '../utilities/shipengine/address.js';
 import { getIsCustomsRequiredForSalesOrder, getCustomsFromSalesOrder } from '../utilities/shipengine/sales-order.js';
-import { getShipmentByStatus, moveCustomsItemsToProducts } from '../utilities/shipengine/shipment.js';
+import { getShipmentByStatus } from '../utilities/shipengine/shipment.js';
 import { getDefaultWarehouse, getWarehouseById } from '../utilities/shipengine/warehouses.js';
 import { useMemo, useCallback, useEffect } from 'react';
-import { useListCarriers, useListWarehouses, useUpdateSalesOrderShipment, useCreateShipment, useGetShipmentByExternalId, useListSalesOrderShipments, useCreateSalesOrderShipment, CodedError } from '@shipengine/react-api';
+import { useListCarriers, useListWarehouses, useCreateShipment, useGetShipmentByExternalId, useListSalesOrderShipments, useCreateSalesOrderShipment, CodedError } from '@shipengine/react-api';
 import { useImportSalesOrder } from './use-import-sales-order.js';
 
 const useConfigureShipment = ({
-  onShipmentUpdated,
   onLoad,
   errorWhenShipmentCancelled: _errorWhenShipmentCancelled = false,
   externalOrderId,
@@ -22,7 +20,6 @@ const useConfigureShipment = ({
   warehouseId,
   useWarehouses: _useWarehouses = true
 }) => {
-  const queryClient = useQueryClient();
   // Queue of incomplete requirement keys (i.e., Ship From addresses, Warehouses, Carriers)
   const incompleteRequirementsKeys = useMemo(() => [], []);
   const {
@@ -50,10 +47,6 @@ const useConfigureShipment = ({
     orderSourceCode,
     salesOrderId
   });
-  const {
-    error: updateShipmentErrors,
-    mutate: updateShipment
-  } = useUpdateSalesOrderShipment();
   const {
     data: newV1Shipment,
     mutateAsync: createV1Shipment,
@@ -157,25 +150,6 @@ const useConfigureShipment = ({
       }
     }
   }), [createSalesOrderShipment, createV1Shipment, creatingSalesOrderShipment, creatingV1Shipment, defaultShipFromAddress, defaultWarehouse, externalOrderId, externalOrderNumber, externalShipmentId, incompleteRequirementsKeys, isExternalShipmentFetching, isExternalShipmentInitialLoading, isFetchingWarehouses, isInitialLoadingWarehouses, labelPurchasedSalesOrderShipment, listSalesOrderShipmentsInitiallyLoading, listSalesOrderShipmentsIsFetching, orderSourceCode, pendingSalesOrderShipment, refetchSalesOrderShipments, salesOrder, salesOrderId, salesOrderShipmentCreated, shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.length, shipmentId, _useWarehouses, v1shipmentCreated, warehouseId, warehouses]);
-  /**
-   * Update a shipment with deprecated customs items. Move items to the products array on the Shipment's packages array
-   *
-   * Invalidate useGetShipment's cache
-   */
-  const formatCustoms = useCallback(shipment => {
-    const formattedShipment = moveCustomsItemsToProducts(shipment);
-    updateShipment(formattedShipment, {
-      onSuccess(data) {
-        void (onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(data));
-        void queryClient.invalidateQueries(["useListSalesOrderShipments", {
-          shipmentId: data.shipmentId
-        }], {
-          exact: false
-        } // Invalidate queries with similar keys
-        );
-      }
-    });
-  }, [onShipmentUpdated, queryClient, updateShipment]);
   const refetchPendingSalesOrderShipments = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
     const {
       data: shipments
@@ -188,13 +162,6 @@ const useConfigureShipment = ({
       yield handleShipmentCreation();
     }))();
   }, [shipmentId, externalShipmentId, salesOrderId, salesOrder, warehouses, warehouseId, handleShipmentCreation]);
-  // useEffect to handle formating customs
-  useEffect(() => {
-    var _a, _b;
-    if ((_b = (_a = pendingSalesOrderShipment === null || pendingSalesOrderShipment === void 0 ? void 0 : pendingSalesOrderShipment.customs) === null || _a === void 0 ? void 0 : _a.customsItems) === null || _b === void 0 ? void 0 : _b.length) {
-      formatCustoms(pendingSalesOrderShipment);
-    }
-  }, [formatCustoms, pendingSalesOrderShipment]);
   // useEffect to check and run the onLoad prop
   useEffect(() => {
     if ((salesOrderShipments === null || salesOrderShipments === void 0 ? void 0 : salesOrderShipments.length) && salesOrderShipments.every(s => s.shipmentStatus === "label_purchased")) {
@@ -206,7 +173,7 @@ const useConfigureShipment = ({
     if (isInitialLoadingCarriers || isFetchingCarriers) return;
     if ((carriers === null || carriers === void 0 ? void 0 : carriers.length) === 0) incompleteRequirementsKeys.push("no_carriers");
   }, [carriers, incompleteRequirementsKeys, isFetchingCarriers, isInitialLoadingCarriers]);
-  const errors = [...(listWarehouseErrors !== null && listWarehouseErrors !== void 0 ? listWarehouseErrors : []), ...(createSalesOrderShipmentErrors !== null && createSalesOrderShipmentErrors !== void 0 ? createSalesOrderShipmentErrors : []), ...(createV1ShipmentErrors !== null && createV1ShipmentErrors !== void 0 ? createV1ShipmentErrors : []), ...(listSalesOrderShipmentsErrors !== null && listSalesOrderShipmentsErrors !== void 0 ? listSalesOrderShipmentsErrors : []), ...(getExternalShipmentErrors !== null && getExternalShipmentErrors !== void 0 ? getExternalShipmentErrors : []), ...(importSalesOrderErrors !== null && importSalesOrderErrors !== void 0 ? importSalesOrderErrors : []), ...(updateShipmentErrors !== null && updateShipmentErrors !== void 0 ? updateShipmentErrors : []), ...(_errorWhenShipmentCancelled && cancelledShipment ? [new CodedError("shipment_cancelled", {
+  const errors = [...(listWarehouseErrors !== null && listWarehouseErrors !== void 0 ? listWarehouseErrors : []), ...(createSalesOrderShipmentErrors !== null && createSalesOrderShipmentErrors !== void 0 ? createSalesOrderShipmentErrors : []), ...(createV1ShipmentErrors !== null && createV1ShipmentErrors !== void 0 ? createV1ShipmentErrors : []), ...(listSalesOrderShipmentsErrors !== null && listSalesOrderShipmentsErrors !== void 0 ? listSalesOrderShipmentsErrors : []), ...(getExternalShipmentErrors !== null && getExternalShipmentErrors !== void 0 ? getExternalShipmentErrors : []), ...(importSalesOrderErrors !== null && importSalesOrderErrors !== void 0 ? importSalesOrderErrors : []), ...(_errorWhenShipmentCancelled && cancelledShipment ? [new CodedError("shipment_cancelled", {
     errorCode: "invalid_status",
     errorSource: "elements",
     errorType: "business_rules"

package/esm/index.js

@@ -39,6 +39,7 @@ export { useHelpers } from './hooks/use-helpers.js';
 export { useConfigureShipment } from './hooks/use-configure-shipment.js';
 export { useImportSalesOrder } from './hooks/use-import-sales-order.js';
 export { useBalanceServices } from './hooks/use-balance-services.js';
+export { RootPortalProvider, useRootPortal } from './hooks/use-root-portal.js';
 export { CanadaDeliveredDutyOptions } from './types/canada-ddp.js';
 export { PudoType } from './types/pudo.js';
 import * as onboarding from './workflows/onboarding/onboarding.js';
@@ -52,3 +53,4 @@ export { connectExternalCarrier as ConnectExternalCarrier };
 export { ElementsContext, ElementsContextProvider, useElements } from './elements-provider/elements-context-provider.js';
 export { ElementsProvider } from './elements-provider/elements-provider.js';
 export { ElementsTestProvider } from './elements-provider/elements-test-provider.js';
+export { createElement } from './create-element/create-element.js';

package/esm/locales/en/common.js

@@ -218,7 +218,8 @@ var common = {
 		shipmentId: "Shipment ID",
 		labelId: "Label ID",
 		labelIdFilter: "{{name}}: {{labelId}}",
-		filteredTrackingStatus: "Delivery Status: {{filter}}",
+		filteredStatus: "{{name}}: {{filter}}",
+		filteredTrackingStatus: "{{name}}: {{filter}}",
 		more: ", +{{count}} more",
 		createdDate: "Created Date",
 		shipmentIdFilter: "{{name}}: {{shipmentId}}",

package/esm/locales/en/purchase-label.js

@@ -33,7 +33,8 @@ var purchaseLabel = {
 		results: "No results returned"
 	},
 	fields: {
-		"requires-additional-handling": "This package requires <Link>additional handling</Link>",
+		"requires-additional-handling-link": "This package requires <Link>additional handling</Link>",
+		"requires-additional-handling": "This package requires additional handling",
 		addOns: "Add-Ons",
 		contentDescription: "Contents Description",
 		confirmation: "Delivery Confirmation",

package/esm/package.js

@@ -1,3 +1,3 @@
-var version = "2.22.0";
+var version = "2.23.0";
 
 export { version };

package/esm/workflows/label-workflow/label-workflow.js

@@ -52,7 +52,6 @@ const Component = _a => {
     carriers
   } = useConfigureShipment(Object.assign(Object.assign({}, _multiplexedId), {
     onLoad: onLoad,
-    onShipmentUpdated: onShipmentUpdated,
     shipFromAddresses,
     useWarehouses: (_b = propFeatures === null || propFeatures === void 0 ? void 0 : propFeatures.shipmentForm) === null || _b === void 0 ? void 0 : _b.useWarehouses,
     warehouseId

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "2.22.0",
+  "version": "2.23.0",
   "module": "./index.js",
   "main": "./index.js",
   "types": "./src/index.d.ts",
@@ -39,7 +39,7 @@
       }
     },
     "./labels-grid": {
-      "source": "./src/elements-provider/index.ts",
+      "source": "./src/elements/labels-grid/index.ts",
       "import": {
         "types": "./types/src/elements/labels-grid/index.d.ts",
         "default": "./esm/elements/labels-grid/index.js"
@@ -49,6 +49,17 @@
         "default": "./cjs/elements/labels-grid/index.cjs"
       }
     },
+    "./create-element": {
+      "source": "./src/create-element/index.ts",
+      "import": {
+        "types": "./types/src/create-element/index.d.ts",
+        "default": "./esm/create-element/index.js"
+      },
+      "require": {
+        "types": "./types/src/create-element/index.d.ts",
+        "default": "./cjs/create-element/index.cjs"
+      }
+    },
     "./manage-carriers": {
       "source": "./src/elements/manage-carriers/index.ts",
       "import": {

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

@@ -8,6 +8,8 @@ type GridDataType = object & {
     bodyCellStyles?: Interpolation<Theme>;
     /** Flag to disable (false by default) the onClick handler of the TableRow */
     disableOnRowClick?: boolean;
+    /** Flag to set the row as loading */
+    isLoading?: boolean;
 };
 /**
  * @internal

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

@@ -1,4 +1,5 @@
 export { ShipmentIdFilter } from "./shipment-id-filter";
 export { CreatedDateFilter } from "./created-date-filter";
 export { LabelIdFilter } from "./label-id-filter";
+export { LabelStatusFilter } from "./label-status-filter";
 export { TrackingStatusFilter } from "./tracking-status-filter";

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

@@ -0,0 +1 @@
+export * from "./label-status-filter";

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

@@ -0,0 +1,12 @@
+import { z } from "zod";
+import { SE } from "@shipengine/react-api";
+export declare const labelStatusFormSchema: z.ZodObject<{
+    labelStatus: z.ZodUnion<[z.ZodLiteral<SE.LabelStatus>, z.ZodLiteral<SE.LabelStatus>, z.ZodLiteral<SE.LabelStatus>, z.ZodLiteral<SE.LabelStatus>, z.ZodLiteral<"">]>;
+}, "strip", z.ZodTypeAny, {
+    labelStatus: "" | SE.LabelStatus;
+}, {
+    labelStatus: "" | SE.LabelStatus;
+}>;
+export type LabelStatusFormFields = {
+    labelStatus: SE.LabelStatus | "";
+};

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

@@ -0,0 +1,24 @@
+import { IGridFilters } from "../../grid-filters";
+/**
+ * @internal
+ *
+ * # Status Filter Props
+ *
+ * @see {@link StatusFilter | The `<StatusFilter />` component}
+ */
+type LabelStatusFilterProps = {
+    disabled?: boolean;
+    filters: IGridFilters;
+    onFiltersUpdated: (params: IGridFilters) => void;
+};
+/**
+ * @internal
+ *
+ * # StatusFilter
+ *
+ * - The `<StatusFilter />` component handles the label status filter used in Labels Grid.
+ *
+ * @see {@link StatusFilterProps | The props for the `<StatusFilter />` component}
+ */
+export declare const LabelStatusFilter: ({ disabled, filters, onFiltersUpdated, }: LabelStatusFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,13 @@
+export declare const styles: {
+    buttons: (theme: import("../../../../utilities/styles").ScopedGigerTheme) => {
+        display: "flex";
+        gap: number;
+        justifyContent: "end";
+        paddingTop: number;
+    };
+    radioGroup: (theme: import("../../../../utilities/styles").ScopedGigerTheme) => {
+        display: "flex";
+        flexDirection: "column";
+        gap: number;
+    };
+};

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

@@ -1,4 +1,5 @@
 import { LabelTrackingStatus } from "@shipengine/js-api";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *
@@ -25,6 +26,7 @@ export interface IGridFilters {
     }>;
     labelId?: IGridFilter<string>;
     shipmentId: IGridFilter<string>;
+    status?: IGridFilter<SE.LabelStatus | "">;
     trackingStatus?: IGridFilter<LabelTrackingStatusWithVoided[]>;
 }
 /**

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

@@ -2,11 +2,12 @@ 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: ({ labelStatus, showShipmentIdFilter, showLabelIdFilter, showTrackingStatusFilter, fetchShipments, sortDir, }: {
+export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter, showLabelIdFilter, showStatusFilter, showTrackingStatusFilter, fetchShipments, sortDir, }: {
     fetchShipments?: boolean | undefined;
     labelStatus: LabelsGridProps["labelStatus"];
     showLabelIdFilter?: boolean | undefined;
     showShipmentIdFilter?: boolean | undefined;
+    showStatusFilter?: boolean | undefined;
     showTrackingStatusFilter?: boolean | undefined;
     sortDir?: SE.SortableQuery["sortDir"];
 }) => {

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

@@ -334,6 +334,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -363,10 +364,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                         fractional: string;
                     };
                     weightGroup: 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.
-                     */
+                    today: string;
                 };
                 hints: {
                     contentDescription: string;
@@ -992,6 +990,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & import
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -296,6 +296,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -934,6 +935,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -295,6 +295,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -977,6 +978,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -273,6 +273,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -911,6 +912,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -289,6 +289,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -945,6 +946,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -272,6 +272,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -910,6 +911,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

package/types/src/elements/purchase-label/hooks/use-rates-form.d.ts

@@ -8,6 +8,7 @@ export type UseRatesFormProps = {
     onBeforeLabelCreate?: (rate: SE.Rate, shipment: SE.SalesOrderShipment) => Promise<void> | Promise<{
         error?: SE.CodedError;
         rate?: SE.Rate;
+        labelMessages?: SE.SalesOrderShipment["packages"][0]["labelMessages"];
     } | undefined> | void;
     onBeforeRateSaved?: (carrierId: string, serviceCode: string) => Promise<void> | Promise<{
         data?: {

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

@@ -517,6 +517,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -570,6 +571,10 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
                     rateSavings: string;
+                    /**
+                     * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
+                     * saves a rate.
+                     */
                     upsGroundSaverTermsAcknowledgement: string;
                     dhlExpressTermsAcknowledgement: string;
                     noRateService: string;
@@ -600,23 +605,19 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     moreLocations: string;
                     nearestLocation: string;
                     open: string;
-                    nextOpeningDay: string; /**
-                     * `onRateSaved` is an async/sync callback function that will be invoked each time a rate is
-                     * saved by the user when rate shopping in the host application.
-                     */
+                    nextOpeningDay: string;
                     until: string;
                     selected: string;
                     select: string;
                     today: string;
-                    viewMap: string;
+                    viewMap: string; /**
+                     * `onRatesCalculated` is an async/sync callback function that will be invoked each time rates
+                     * are calculated for a given shipment.
+                     */
                     otherLocations: string;
                     noServicePointsForService: string;
                     error: string;
                     paperless: string;
-                    /**
-                     * `onShipmentUpdated` is an async/sync callback function that will be invoked each time a
-                     * shipment is updated with a new `ShipTo/ShipFrom Address`, `rate`, `preset`, etc.
-                     */
                     localTimeDisclaimer: string;
                 };
                 shipToAddressFormFields: string;
@@ -1169,6 +1170,7 @@ export declare const Element: ({ resources, ...props }: PurchaseLabelCommonProps
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -271,6 +271,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -909,6 +910,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -364,6 +364,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -1038,6 +1039,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -1,17 +1,19 @@
+/// <reference types="react" />
 import { IGridFilters } from "../../../components/grid-filters";
 import { SE } from "@shipengine/js-api";
-import { ShipmentsGridProps } from "../shipments-grid";
-export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, sortBy, sortDir, }: {
-    shipmentStatus: ShipmentsGridProps["shipmentStatus"];
-    showCreatedDateFilter: ShipmentsGridProps["showCreatedDateFilter"];
-    showShipmentIdFilter: ShipmentsGridProps["showShipmentIdFilter"];
+type ShipmentsGridHookProps = {
+    shipmentStatus?: SE.ShipmentStatus;
+    showCreatedDateFilter?: boolean;
+    showShipmentIdFilter?: boolean;
     sortBy?: SE.SortableQuery["sortBy"];
     sortDir?: SE.SortableQuery["sortDir"];
-}) => {
+};
+export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, sortBy, sortDir, }: ShipmentsGridHookProps) => {
     clearAllFilters: () => void;
     filters: IGridFilters;
     getGridData: () => {
         disableOnRowClick: boolean;
+        isLoading: boolean;
         serviceName: string | null | undefined;
         addressValidation?: SE.AddressValidation | undefined;
         advancedOptions?: {
@@ -109,9 +111,11 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
         showPagination: boolean;
         totalElements: number;
     };
+    setActiveShipmentId: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     setFilters: (newFilters: IGridFilters) => void;
     shipments: {
         disableOnRowClick: boolean;
+        isLoading: boolean;
         serviceName: string | null | undefined;
         addressValidation?: SE.AddressValidation | undefined;
         advancedOptions?: {
@@ -194,3 +198,4 @@ export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter,
     }[] | undefined;
     shouldShowFilters: boolean;
 };
+export {};

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

@@ -12,9 +12,11 @@ export type ShipmentsGridProps = {
      */
     onClickCancelShipment?: (shipment: SE.Shipment) => void;
     /**
-     * `onRowClick` callback invoked when a row is clicked.
+     * `onRowClick` callback invoked when a row is clicked. You can pass a Promise, when you do the selected Shipment
+     * will be marked as "active", and we’ll wait for the Promise to resolve before removing that "active" state.
+     * An "active" Shipment is displayed in a "loading" state within the table.
      */
-    onRowClick?: (data: SE.Shipment) => void;
+    onRowClick?: (data: SE.Shipment) => void | Promise<void>;
     /**
      * `shipmentStatus` is the status of the shipments you wish to view.
      * If no value is defined, all shipments will be rendered.
@@ -50,7 +52,7 @@ export type ShipmentsGridProps = {
  *
  * @see {@link ShipmentsGrid.Element | The **Element** created to render `<ShipmentsGrid />`}
  */
-export declare const Component: ({ onRowClick, onClickCancelShipment, shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ onRowClick: onRowClickProp, onClickCancelShipment, shipmentStatus, showShipmentIdFilter, showCreatedDateFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Shipments Grid Element
  *
@@ -348,6 +350,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -504,7 +507,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     shipEngineToS: string;
                     auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
-                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string; /**
+                     * `showCreatedDateFilter` controls the display of the Created Date filter
+                     */
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
                     "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
                     aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
@@ -989,6 +994,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;
@@ -1010,7 +1016,27 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & imp
                     none: string;
                     parcelguard: string;
                     shipsurance: string;
-                    thirdParty: string;
+                    thirdParty: string; /**
+                     * # Registered Shipments Grid Element
+                     *
+                     * @param ShipmentsGridProps The props necessary to render the `<ShipmentsGrid.Element />`.
+                     *
+                     * @example
+                     * The `<Component />` is the source JSX that is rendered when you make use of the `ShipmentsGrid`
+                     * Element directly.
+                     *
+                     * ```tsx
+                     * <ShipmentsGrid.Element
+                     *    shipmentStatus="pending"
+                     *    onRowClick={(shipment) => console.log('Row clicked', shipment)}
+                     * />
+                     * ```
+                     *
+                     * <br />
+                     *
+                     * @see {@link ShipmentsGrid.ShipmentsGridProps | The **Base props** used in `<ShipmentsGrid.Element />`}
+                     *
+                     */
                     x_cover: string;
                 };
                 loading: {

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

@@ -273,6 +273,7 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -911,6 +912,7 @@ export declare const Element: ({ resources, ...props }: ConfigureThemeProps & im
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;

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

@@ -271,6 +271,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -909,6 +910,7 @@ export declare const Element: ({ resources, ...props }: import("../../create-ele
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;