@shipengine/elements 2.22.0 → 2.23.0

package/types/src/elements/unit-settings/unit-settings-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/vat-settings/vat-settings-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/void-label/void-label.d.ts

@@ -371,6 +371,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;
@@ -441,6 +442,37 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                 };
                 requirements: {
                     noWarehouse: string;
+                    /**
+                     * # Registered Void Label Element
+                     *
+                     * - This is the registered `<VoidLabel />` element that will be used to render the
+                     * `<VoidLabel.Element />` component.
+                     *
+                     * @param ElementProps The props, callbacks, and resources necessary to render
+                     * the `<VoidLabel.Element />` component.
+                     *
+                     * @example
+                     * The `<Component />` is the source JSX that is rendered when you make use of the `VoidLabel`
+                     * Element directly. Here is a brief example of how you would use it within your application.
+                     * ```tsx
+                     * <VoidLabel.Element
+                     *   labelId="se-1234567"
+                     *   onComplete={() => console.log('onComplete')}
+                     *   onSuccess={(_, { salesOrderIds: [salesOrderId] }) =>
+                     *     console.log('sales order ID', salesOrderId)
+                     *   }
+                     *   onViewShipment={({ shipmentId }) => {
+                     *     console.log('onViewShipment', shipmentId);
+                     *   }}
+                     * />
+                     * ```
+                     *
+                     * <br />
+                     *
+                     * @see {@link VoidLabel.ComponentProps | The **props** that can be passed into the `<VoidLabel.Element />` component}
+                     *
+                     * @see {@link PurchaseLabel.Element | Go back to the frst step in the label purchase workflow `<PurchaseLabel.Element />`}
+                     */
                     noCarrier: string;
                     noWarehouseOrCarrier: string;
                 };
@@ -1009,6 +1041,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/hooks/index.d.ts

@@ -3,3 +3,4 @@ export * from "./use-helpers";
 export * from "./use-configure-shipment";
 export * from "./use-import-sales-order";
 export * from "./use-balance-services";
+export * from "./use-root-portal";

package/types/src/hooks/use-configure-shipment.d.ts

@@ -6,7 +6,6 @@ export type UseConfigureShipmentProps = {
     externalOrderNumber?: string;
     externalShipmentId?: string;
     onLoad?: (shipments: SE.SalesOrderShipment[], salesOrder?: SE.SalesOrder, pendingShipment?: SE.SalesOrderShipment) => Promise<void> | void;
-    onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     orderSourceCode?: string;
     salesOrderId?: string;
     shipFromAddresses?: ShipFromAddress[];
@@ -14,7 +13,7 @@ export type UseConfigureShipmentProps = {
     useWarehouses?: boolean;
     warehouseId?: string;
 };
-export declare const useConfigureShipment: ({ onShipmentUpdated, onLoad, errorWhenShipmentCancelled, externalOrderId, externalOrderNumber, externalShipmentId, orderSourceCode, salesOrderId, shipFromAddresses, shipmentId, warehouseId, useWarehouses, }: UseConfigureShipmentProps) => {
+export declare const useConfigureShipment: ({ onLoad, errorWhenShipmentCancelled, externalOrderId, externalOrderNumber, externalShipmentId, orderSourceCode, salesOrderId, shipFromAddresses, shipmentId, warehouseId, useWarehouses, }: UseConfigureShipmentProps) => {
     carriers: SE.Carrier[] | undefined;
     errors: CodedError[] | undefined;
     isLoading: boolean;

package/types/src/index.d.ts

@@ -6,3 +6,8 @@ export * from "./workflows";
 export * from "./elements-provider";
 export { scopeTheme, createStyles, getDefaultFeatures, getSellerIdFromToken, isOnboarded, validateShipFromAddress, type ElementsFeatureFlags, } from "./utilities";
 export * from "@shipengine/react-api";
+/**
+ * ToDo: This export can be removed once RateCardManager stop using Elements
+ * https://auctane.atlassian.net/browse/ENGINE-9001
+ */
+export * from "./create-element";

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

@@ -267,6 +267,7 @@ declare const _default: {
             results: string;
         };
         fields: {
+            "requires-additional-handling-link": string;
             "requires-additional-handling": string;
             addOns: string;
             contentDescription: string;
@@ -905,6 +906,7 @@ declare const _default: {
             shipmentId: string;
             labelId: string;
             labelIdFilter: string;
+            filteredStatus: string;
             filteredTrackingStatus: string;
             more: string;
             createdDate: string;

package/types/src/utilities/feature-flags/types.d.ts

@@ -28,6 +28,10 @@ export type RateFormFeatures = {
     saveRate?: boolean;
 };
 export type ShipmentFormFeatures = {
+    /**
+     * Href to the `additional handling` link. This link will be used in the `additional handling` toggle of the shipment form.
+     */
+    additionalHandlingHref?: string;
     /**
      * Enables the `Add-Ons` section of the shipment form. This allows users to add additional services to their shipment such as
      * delivery confirmation and insurance.
@@ -148,7 +152,7 @@ export type FilterableLabelColumnConfig = {
     /**
      * The name identifying the column
      */
-    name: Extract<LabelColumnName, "shipmentId" | "labelId" | "trackingStatus">;
+    name: Extract<LabelColumnName, "shipmentId" | "labelId" | "trackingStatus" | "status">;
     nickname?: string;
 };
 export type LabelColumnConfig = BaseLabelColumnConfig | FilterableLabelColumnConfig;

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

@@ -303,6 +303,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;
@@ -941,6 +942,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/workflows/carrier-services/carrier-services.d.ts

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

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

@@ -304,6 +304,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;
@@ -942,6 +943,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/workflows/label-workflow/label-workflow.d.ts

@@ -373,6 +373,7 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     results: string;
                 };
                 fields: {
+                    "requires-additional-handling-link": string;
                     "requires-additional-handling": string;
                     addOns: string;
                     contentDescription: string;
@@ -388,7 +389,9 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     insuranceProvider: string;
                     insuredValue: string;
                     items: string;
-                    orderDate: string;
+                    orderDate: string; /**
+                     * `multiplexedId` is the unique pattern of props that help index which Element is being displayed.
+                     */
                     orderValue: string;
                     packageCode: string;
                     requestedShipping: string;
@@ -1016,9 +1019,15 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;
+                    /**
+                     * # Label Workflow Element Props
+                     *
+                     * @see {@link LabelWorkflow.Element | See the full type that `typeof Element` will return}
+                     */
                     shipmentIdFilter: string;
                     createdDateFilter: string;
                     apply: string;

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

@@ -359,6 +359,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;
@@ -1004,6 +1005,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & import(
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredStatus: string;
                     filteredTrackingStatus: string;
                     more: string;
                     createdDate: string;