@shipengine/elements 2.8.1 → 2.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "2.8.1",
+  "version": "2.9.1",
   "peerDependencies": {
     "@emotion/react": "11.x",
     "react-i18next": "11.x",

package/src/components/field/select/select.d.ts

@@ -8,7 +8,7 @@ export type SelectOption = {
     value: string;
 };
 type SelectProps = {
-    onChange?: (value?: string) => void;
+    onSelectChange?: (value?: string) => void;
     options?: SelectOption[];
 };
 export declare const Select: ControlledField<NativeSelectProps, SelectProps>;

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

@@ -1,2 +1,3 @@
 export { ShipmentIdFilter } from "./shipment-id-filter";
 export { CreatedDateFilter } from "./created-date-filter";
+export { LabelIdFilter } from "./label-id-filter";

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

@@ -0,0 +1 @@
+export { LabelIdFilter } from "./label-id-filter";

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

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const labelIdFormSchema: z.ZodObject<{
+    labelId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    labelId: string;
+}, {
+    labelId: string;
+}>;
+export type LabelIdFormFields = z.input<typeof labelIdFormSchema>;

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

@@ -0,0 +1,23 @@
+import { IGridFilters } from "../../grid-filters";
+/**
+ * @internal
+ *
+ * # Label Id Filter Props
+ *
+ * @see {@link LabelIdFilter | The `<LabelIdFilter />` component}
+ */
+type LabelIdFilterProps = {
+    filters: IGridFilters;
+    onFiltersUpdated: (params: IGridFilters) => void;
+};
+/**
+ * @internal
+ *
+ * # LabelIdFilter
+ *
+ * - The `<LabelIdFilter />` component handle label id filter used in Labels Grid.
+ *
+ * @see {@link LabelIdFilterProps | The props for the `<LabelIdFilter />` component}
+ */
+export declare const LabelIdFilter: ({ filters, onFiltersUpdated }: LabelIdFilterProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,7 @@
+export declare const styles: {
+    getButtons: (theme: any) => {
+        display: "flex";
+        gap: any;
+        justifyContent: "flex-end";
+    };
+};

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

@@ -19,6 +19,7 @@ export interface IGridFilters {
         end: Date;
         start: Date;
     }>;
+    labelId?: IGridFilter<string>;
     shipmentId: IGridFilter<string>;
 }
 /**

package/src/components/templates/shipment-form/shipment-form.styles.d.ts

@@ -2,6 +2,16 @@ export declare const styles: {
     header: {
         textAlign: "left";
     };
+    shipFromEditButton: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        border: number;
+        fontWeight: number;
+        marginTop: number;
+    };
+    shipFromSelectContainer: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        display: "flex";
+        gap: number;
+        justifyContent: "space-between";
+    };
     well: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
         backgroundColor: string;
         padding: number;

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

@@ -552,6 +552,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -805,6 +806,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -812,6 +815,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -893,6 +897,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -1,9 +1,53 @@
-/// <reference types="react" />
+import { SE } from "@shipengine/react-api";
 import { LabelsGridProps } from "../";
 import { IGridFilters } from "../../../components";
-export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter }: LabelsGridProps) => {
+export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter, showLabelIdFilter, }: Pick<LabelsGridProps, "labelStatus" | "showShipmentIdFilter" | "showLabelIdFilter">) => {
     clearAllFilters: () => void;
     filters: IGridFilters;
+    getGridData: () => {
+        serviceName: string | null | undefined;
+        alternativeIdentifiers?: string[] | undefined;
+        batchId: string;
+        carrierCode: string;
+        carrierId: string;
+        chargeEvent: SE.LabelChargeEvent;
+        createdAt: string;
+        displayScheme: SE.LabelDisplayScheme;
+        formDownload: SE.LinkedResource;
+        insuranceClaim: SE.LinkedResource;
+        insuranceCost: SE.Money;
+        isInternational: boolean;
+        isReturnLabel: boolean;
+        labelDownload: SE.Download;
+        labelFormat: SE.LabelFormat;
+        labelId: string;
+        labelImageId: string;
+        labelLayout: SE.LabelLayout;
+        packageCode: string;
+        packages: SE.ShipmentPackage[];
+        paperlessDownload: SE.PaperlessDownload | null;
+        qrCodeDownload?: SE.LinkedResource | undefined;
+        rateDetails: SE.RateDetail[];
+        relayPoints: {
+            shipFrom: SE.RelayPoint;
+            shipTo: SE.RelayPoint;
+        };
+        requestedComparisonAmount?: SE.Money | undefined;
+        rmaNumber: string;
+        serviceCode: string;
+        shipDate: string;
+        shipmentCost: SE.Money;
+        shipmentId: string;
+        shippingRuleId: string | null;
+        shipTo: SE.Address;
+        status: SE.LabelStatus;
+        trackable: boolean;
+        trackingNumber: string;
+        trackingStatus: SE.LabelTrackingStatus;
+        trackingUrl: string;
+        voided: boolean;
+        voidedAt: string | null;
+    }[];
     isAnyFilterActive: boolean;
     isError: boolean;
     isLoading: boolean;
@@ -13,40 +57,40 @@ export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter }: Labe
         batchId: string;
         carrierCode: string;
         carrierId: string;
-        chargeEvent: import("@shipengine/react-api").LabelChargeEvent;
+        chargeEvent: SE.LabelChargeEvent;
         createdAt: string;
-        displayScheme: import("@shipengine/react-api").LabelDisplayScheme;
-        formDownload: import("@shipengine/react-api").LinkedResource;
-        insuranceClaim: import("@shipengine/react-api").LinkedResource;
-        insuranceCost: import("@shipengine/react-api").Money;
+        displayScheme: SE.LabelDisplayScheme;
+        formDownload: SE.LinkedResource;
+        insuranceClaim: SE.LinkedResource;
+        insuranceCost: SE.Money;
         isInternational: boolean;
         isReturnLabel: boolean;
-        labelDownload: import("@shipengine/react-api").Download;
-        labelFormat: import("@shipengine/react-api").LabelFormat;
+        labelDownload: SE.Download;
+        labelFormat: SE.LabelFormat;
         labelId: string;
         labelImageId: string;
-        labelLayout: import("@shipengine/react-api").LabelLayout;
+        labelLayout: SE.LabelLayout;
         packageCode: string;
-        packages: import("@shipengine/react-api").ShipmentPackage[];
-        paperlessDownload: import("@shipengine/react-api").PaperlessDownload | null;
-        qrCodeDownload?: import("@shipengine/react-api").LinkedResource | undefined;
-        rateDetails: import("@shipengine/react-api").RateDetail[];
+        packages: SE.ShipmentPackage[];
+        paperlessDownload: SE.PaperlessDownload | null;
+        qrCodeDownload?: SE.LinkedResource | undefined;
+        rateDetails: SE.RateDetail[];
         relayPoints: {
-            shipFrom: import("@shipengine/react-api").RelayPoint;
-            shipTo: import("@shipengine/react-api").RelayPoint;
+            shipFrom: SE.RelayPoint;
+            shipTo: SE.RelayPoint;
         };
-        requestedComparisonAmount?: import("@shipengine/react-api").Money | undefined;
+        requestedComparisonAmount?: SE.Money | undefined;
         rmaNumber: string;
         serviceCode: string;
         shipDate: string;
-        shipmentCost: import("@shipengine/react-api").Money;
+        shipmentCost: SE.Money;
         shipmentId: string;
         shippingRuleId: string | null;
-        shipTo: import("@shipengine/react-api").Address;
-        status: import("@shipengine/react-api").LabelStatus;
+        shipTo: SE.Address;
+        status: SE.LabelStatus;
         trackable: boolean;
         trackingNumber: string;
-        trackingStatus: import("@shipengine/react-api").LabelTrackingStatus;
+        trackingStatus: SE.LabelTrackingStatus;
         trackingUrl: string;
         voided: boolean;
         voidedAt: string | null;
@@ -64,6 +108,6 @@ export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter }: Labe
         showPagination: boolean;
         totalElements: number;
     };
-    setFilters: import("react").Dispatch<import("react").SetStateAction<IGridFilters>>;
+    setFilters: (newFilters: IGridFilters) => void;
     shouldShowFilters: boolean;
 };

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

@@ -30,12 +30,16 @@ export type LabelsGridProps = {
      * `onRowClick` callback invoked when a row is clicked.
      */
     onRowClick?: (label: SE.Label) => void;
+    /**
+     * `showLabelIdFilter` controls the display of the label Id search filter
+     */
+    showLabelIdFilter?: boolean;
     /**
      * `showShipmentIdFilter` controls the display of the shipmentId search filter
      */
     showShipmentIdFilter?: boolean;
 };
-export declare const Component: ({ labelStatus, showShipmentIdFilter, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ labelStatus, showShipmentIdFilter, showLabelIdFilter, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const Element: ({ resources, ...props }: LabelsGridProps & {
     resources?: {
         en: {
@@ -594,6 +598,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -605,10 +610,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     button: string;
                 };
                 status: {
-                    voided: string; /**
-                     * `labelStatus` is the status of the labels you wish to view.
-                     * If no value is defined, all labels will be rendered.
-                     */
+                    voided: string;
                     error: string;
                     completed: string;
                     processing: string;
@@ -622,10 +624,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 actions: {
                     title: string;
                     print: string;
-                    void: string; /**
-                     * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
-                     * `Print Label` button.
-                     */
+                    void: string;
                     printForms: string;
                 };
                 errorMessages: {
@@ -856,6 +855,8 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -863,6 +864,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -944,6 +946,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -598,6 +598,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -873,6 +874,8 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -880,6 +883,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -961,6 +965,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -619,6 +619,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -872,6 +873,8 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -879,6 +882,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -960,6 +964,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -553,6 +553,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -806,6 +807,8 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -813,6 +816,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -894,6 +898,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -570,6 +570,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -840,6 +841,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -847,6 +850,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -928,6 +932,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -553,6 +553,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -806,6 +807,8 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -813,6 +816,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -894,6 +898,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

package/src/elements/purchase-label/hooks/use-get-or-create-shipment.d.ts

@@ -8,6 +8,6 @@ export type UseGetOrCreateShipmentProps = {
 export declare const useGetOrCreateShipment: ({ externalShipmentId, shipmentId, onShipmentUpdated, }: UseGetOrCreateShipmentProps) => {
     errors: SE.CodedError[] | undefined;
     isLoading: boolean;
-    refetchShipment: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<SE.SalesOrderShipment, SE.CodedError[]>>;
+    refetchShipment: () => Promise<void>;
     shipment: SE.SalesOrderShipment;
 };

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

@@ -749,6 +749,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -1016,6 +1017,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -1023,6 +1026,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -1104,6 +1108,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -650,6 +650,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipDate: string;
                     status: string;
                     trackingStatus: string;
+                    labelId: string;
                 };
                 empty: {
                     title: string;
@@ -676,6 +677,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     title: string;
                     print: string;
                     void: string;
+                    /**
+                     * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
+                     * `Purchase Label` button.
+                     */
                     printForms: string;
                 };
                 errorMessages: {
@@ -905,6 +910,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     rows: string;
                     clearAll: string;
                     shipmentId: string;
+                    labelId: string;
+                    labelIdFilter: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -912,6 +919,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     clear: string;
                     search: string;
                     shipmentIdHint: string;
+                    labelIdHint: string;
                     dateFilterToday: string;
                     dateFilterLast7Days: string;
                     dateFilterLast30Days: string;
@@ -993,6 +1001,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     tooFewCharacters: string;
                     tooManyCharacters: string;
                     requiredShipmentId: string;
+                    requiredLabelId: string;
                 };
                 shippingPresets: {
                     apply: string;