@shipengine/elements 2.3.1 → 2.4.0

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

@@ -1,8 +1,31 @@
-import { Label } from "@shipengine/react-api";
-type ComponentProps = {
-    onRowClick: (data: Label) => void;
+import { SE } from "@shipengine/js-api";
+export type LabelsGridProps = {
+    /**
+     * `labelStatus` is the status of the labels you wish to view.
+     * If no value is defined, all labels will be rendered.
+     */
+    labelStatus?: SE.LabelStatus;
+    /**
+     * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+     * `Print Forms` button.
+     */
+    onClickPrintForms?: () => void;
+    /**
+     * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
+     * `Print Label` button.
+     */
+    onClickPrintLabel?: () => void;
+    /**
+     * `onClickVoidLabel` is a callback function that controls the display of `Void Label` button and
+     *  will be invoked when the user clicks on it.
+     */
+    onClickVoidLabel?: (label: SE.Label) => void;
+    /**
+     * `showShipmentIdFilter` controls the display of the shipmentId search filter
+     */
+    showShipmentIdFilter?: boolean;
 };
-export declare const Element: ({ resources, ...props }: ComponentProps & {
+export declare const Element: ({ resources, ...props }: LabelsGridProps & {
     resources?: {
         en: {
             "wallet-history": {
@@ -46,7 +69,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     approved: string;
                     rejected: string;
                 };
-                voidedOn: string;
+                voidedOn: string; /**
+                 * `onClickVoidLabel` is a callback function that controls the display of `Void Label` button and
+                 *  will be invoked when the user clicks on it.
+                 */
             };
             "view-shipment": {
                 title: string;
@@ -66,7 +92,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     items: string;
                     orderDate: string;
                     orderValue: string;
-                    requestedShipping: string;
+                    requestedShipping: string; /**
+                     * `labelStatus` is the status of the labels you wish to view.
+                     * If no value is defined, all labels will be rendered.
+                     */
                     shipDate: string;
                     shipTo: string;
                     warehouse: string;
@@ -360,7 +389,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 warehouse: {
                     title: string;
-                    subtitle: string;
+                    subtitle: string; /**
+                     * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
+                     * `Print Label` button.
+                     */
                     inlineMessage: string;
                 };
                 errors: {
@@ -415,7 +447,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 setDefault: string;
                 shipFrom: string;
                 noWarehouses: string;
-            };
+            }; /**
+             * `labelStatus` is the status of the labels you wish to view.
+             * If no value is defined, all labels will be rendered.
+             */
             "manage-funding": {
                 actions: {
                     addFunds: string;
@@ -435,9 +470,15 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     isLoading: string;
                     lowBalancePurchaseThreshold: string;
                     maximumPurchasesPerDay: string;
-                    purchaseAmount: string;
+                    purchaseAmount: string; /**
+                     * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                     * `Print Forms` button.
+                     */
                     readSettings: string;
-                };
+                }; /**
+                 * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
+                 * `Print Label` button.
+                 */
                 addFunds: {
                     custom: string;
                     error: {
@@ -525,15 +566,33 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -594,7 +653,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         addressLine1: string;
                         addressLine2: string;
                         cityLocality: string;
-                        stateProvince: string;
+                        stateProvince: string; /**
+                         * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                         * `Print Forms` button.
+                         */
                         postalCode: string;
                         phone: string;
                         email: string;
@@ -753,6 +815,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -828,6 +897,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -905,4 +975,3 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
         };
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
-export {};

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

@@ -0,0 +1,5 @@
+export declare const styles: {
+    tableParagraph: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        margin: number;
+    };
+};

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

@@ -569,15 +569,33 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -819,6 +837,13 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -894,6 +919,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -569,15 +569,33 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -797,6 +815,13 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -872,6 +897,7 @@ export declare const Element: ({ resources, ...props }: ExternalCarriersProps &
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -524,15 +524,33 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -752,6 +770,13 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -827,6 +852,7 @@ export declare const Element: ({ resources, ...props }: ManageFundingProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -541,15 +541,33 @@ export declare const Element: ({ resources, ...props }: object & {
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -786,6 +804,13 @@ export declare const Element: ({ resources, ...props }: object & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -861,6 +886,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -524,15 +524,33 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -752,6 +770,13 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -827,6 +852,7 @@ export declare const Element: ({ resources, ...props }: PaymentMethodSettingsPro
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -728,15 +728,33 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -970,6 +988,13 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -1013,44 +1038,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 packageCategories: {
                     customPackages: string;
-                }; /**
-                 * # Registered Purchase Label Element
-                 *
-                 * @param ElementProps The props necessary to render the `<PurchaseLabel.Element />` for shipment
-                 * based or sales order based label purchasing.
-                 *
-                 * @example
-                 * The `<Component />` is the source JSX that is rendered when you make use of the `PurchaseLabel`
-                 * Element directly.
-                 * ```tsx
-                 * <PurchaseLabel.Element
-                 *   key={currentSalesOrderId}
-                 *   printLabelLayout='4x6'
-                 *   shippingPresets={presets}
-                 *   onShipmentUpdated={(shipment) => console.log('Shipment Updated', shipment)}
-                 *   onRateSaved={(
-                 *     shipment: SE.SalesOrderShipment,
-                 *     rate?: SE.Rate,
-                 *     rateOptions?: SE.Rate[]
-                 *   ) => console.log('Rate Saved', shipment, rate, rateOptions)}
-                 *   onRatesCalculated={() => console.log('Rates Calculated')}
-                 *   onBeforeLabelCreate={onBeforeLabelPurchase}
-                 *   onLabelCreateSuccess={onLabelPurchaseSuccess}
-                 *   onLabelCreateFailure={(rate) => console.log('Label Purchase Failed', rate)}
-                 *   warehouseId={defaultWarehouseId}
-                 * />
-                 * ```
-                 *
-                 * <br />
-                 *
-                 * - Once a label has been purchased using this Element, you can take the `shipmentId` for the
-                 * associated shipment and pass it into the `<ShipmentSummary.Element />` Element in order to view
-                 * the shipment details.
-                 *
-                 * @see {@link PurchaseLabel.PurchaseLabelCommonProps | The **Common props** used in `<PurchaseLabel.Element />`}
-                 *
-                 * @see {@link ShipmentSummary.Element | The next step in the label purchase workflow `<ShipmentSummary.Element />`}
-                 */
+                };
                 packageCodes: {
                     package: string;
                 };
@@ -1082,6 +1070,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;

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

@@ -618,15 +618,33 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 title: string;
                 headers: {
                     created: string;
-                    download: string;
-                    labelId: string;
-                    service: string;
-                    shipTo: string;
+                    shipmentId: string;
+                    parcels: string;
+                    recipient: string;
+                    shipping: string;
+                    shipDate: string;
+                    status: string;
+                };
+                empty: {
+                    title: string;
+                    subtitle: string;
+                };
+                emptyWithFilters: {
+                    title: string;
+                    subtitle: string;
+                    button: string;
+                };
+                status: {
+                    voided: string;
+                    error: string;
+                    completed: string;
+                    processing: string;
                 };
                 actions: {
-                    download: {
-                        pdf: string;
-                    };
+                    title: string;
+                    print: string;
+                    void: string;
+                    printForms: string;
                 };
             };
             "connect-carrier": {
@@ -848,6 +866,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "row-count_one": string;
                     "row-count_other": string;
                     rows: string;
+                    clearAll: string;
+                    shipmentId: string;
+                    shipmentIdFilter: string;
+                    apply: string;
+                    clear: string;
+                    search: string;
+                    shipmentIdHint: string;
                 };
                 insuranceProviders: {
                     carrier: string;
@@ -923,6 +948,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;