@shipengine/elements 2.3.1 → 2.5.0

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

@@ -206,7 +206,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -214,7 +213,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -228,15 +226,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
                             title: string;
-                            /**
-                             * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
-                             * `Void Label` button.
-                             */
                             description: string;
                         };
                         carrier: {
@@ -435,18 +428,15 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             onboarding: {
                 title: string;
-                inlineTitle: string;
-                accountRegistration: {
-                    action: string;
+                confirmation: {
                     title: string;
-                    subtitle: string;
-                    welcome: string;
-                    messageLine1: string;
-                    partnerMessageLine1: string;
-                    messageLine2: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
                 };
                 stepLabel: {
-                    accountRegistration: string;
+                    confirmation: string;
                     termsAgreement: string;
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
@@ -493,6 +483,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -601,32 +599,81 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "list-shipments": {
                 title: string;
+                none: string;
                 headers: {
                     created: string;
-                    download: string;
+                    modified: string;
+                    shipping: string;
                     shipmentId: string;
-                    shipDate: string;
-                    shipTo: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
                 };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
+                };
+                /**
+                 * # Shipment Summary Component Props
+                 *
+                 * - These are the base props that will be passed into the `<ShipmentSummary />` component.
+                 *
+                 * @see {@link ShipmentSummary.Component | This prop types usage in the `<ShipmentSummary />` component}
+                 */
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 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;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
                 };
             };
             "connect-carrier": {
@@ -830,6 +877,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -848,6 +896,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 +978,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -936,6 +992,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -960,6 +1017,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -0,0 +1,161 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/js-api";
+import { IGridFilters } from "../../../components";
+import { ShipmentsGridProps } from "../shipments-grid";
+export declare const useShipmentsGrid: ({ shipmentStatus, showShipmentIdFilter, }: ShipmentsGridProps) => {
+    clearAllFilters: () => void;
+    filters: IGridFilters;
+    getGridData: () => {
+        serviceName: string | null | undefined;
+        addressValidation?: SE.AddressValidation | undefined;
+        advancedOptions?: {
+            additionalHandling?: boolean | undefined;
+            ancillaryEndorsementsOption?: string | undefined;
+            billToAccount?: string | undefined;
+            billToCountryCode?: string | undefined;
+            billToParty?: SE.BillToParties | undefined;
+            billToPostalCode?: string | undefined;
+            collectOnDelivery?: {
+                paymentAmount: SE.Money;
+                paymentType: SE.PaymentTypes;
+            } | undefined;
+            containsAlcohol?: boolean | undefined;
+            customField1?: string | undefined;
+            customField2?: string | undefined;
+            customField3?: string | undefined;
+            deliveredDutyPaid?: boolean | undefined;
+            dryIce?: boolean | undefined;
+            dryIceWeight?: SE.WeightWithUnit | undefined;
+            eventNotification?: boolean | undefined;
+            fedexFreight?: {
+                bookingConfirmation?: string | undefined;
+                shipperLoadAndCount?: string | undefined;
+            } | undefined;
+            freightClass?: string | undefined;
+            limitedQuantity?: boolean | undefined;
+            nonMachinable?: boolean | undefined;
+            originType?: SE.OriginTypes | undefined;
+            ownDocumentUpload?: boolean | undefined;
+            returnPickupAttempts?: number | undefined;
+            saturdayDelivery?: boolean | undefined;
+            shipperRelease?: boolean | undefined;
+            thirdPartyConsignee?: boolean | undefined;
+            useUpsGroundFreightPricing?: boolean | undefined;
+        } | undefined;
+        carrierId: string;
+        comparisonRateType?: string | undefined;
+        confirmation: SE.ConfirmationType;
+        createdAt: string;
+        customs?: SE.Customs | undefined;
+        externalOrderId?: string | undefined;
+        externalShipmentId?: string | undefined;
+        insuranceProvider: SE.InsuranceProviderType;
+        isReturn?: boolean | undefined;
+        items: SE.ShipmentItem[];
+        modifiedAt: string;
+        orderSourceCode: SE.OrderSourceCode | null;
+        originType?: SE.OriginTypes | undefined;
+        packages: SE.ShipmentPackage[];
+        returnTo: SE.Address | null;
+        serviceCode: string | null;
+        shipDate?: string | undefined;
+        shipFrom: SE.Address | null;
+        shipmentId: string;
+        shipmentNumber?: string | undefined;
+        shipmentStatus: SE.ShipmentStatus;
+        shippingRuleId?: string | undefined;
+        shipTo: SE.Address;
+        tags: {
+            name: string;
+        }[];
+        taxIdentifiers?: SE.TaxIdentifier[] | undefined;
+        totalWeight: SE.WeightWithUnit;
+        validateAddress?: SE.AddressValidationOptions | undefined;
+        warehouseId?: string | undefined;
+    }[];
+    isAnyFilterActive: boolean;
+    isError: boolean;
+    isLoading: boolean;
+    pageConfig: {
+        currentPage: number;
+        pagerProps: {
+            currentPage: number;
+            currentPageSize: number;
+            onPageSelect: (page: number) => void;
+            onPageSizeSelect: (pageSize: number) => void;
+        };
+        pagesAmount: number;
+        pageSize: number;
+        totalElements: number;
+    };
+    setFilters: import("react").Dispatch<import("react").SetStateAction<IGridFilters>>;
+    shipments: {
+        serviceName: string | null | undefined;
+        addressValidation?: SE.AddressValidation | undefined;
+        advancedOptions?: {
+            additionalHandling?: boolean | undefined;
+            ancillaryEndorsementsOption?: string | undefined;
+            billToAccount?: string | undefined;
+            billToCountryCode?: string | undefined;
+            billToParty?: SE.BillToParties | undefined;
+            billToPostalCode?: string | undefined;
+            collectOnDelivery?: {
+                paymentAmount: SE.Money;
+                paymentType: SE.PaymentTypes;
+            } | undefined;
+            containsAlcohol?: boolean | undefined;
+            customField1?: string | undefined;
+            customField2?: string | undefined;
+            customField3?: string | undefined;
+            deliveredDutyPaid?: boolean | undefined;
+            dryIce?: boolean | undefined;
+            dryIceWeight?: SE.WeightWithUnit | undefined;
+            eventNotification?: boolean | undefined;
+            fedexFreight?: {
+                bookingConfirmation?: string | undefined;
+                shipperLoadAndCount?: string | undefined;
+            } | undefined;
+            freightClass?: string | undefined;
+            limitedQuantity?: boolean | undefined;
+            nonMachinable?: boolean | undefined;
+            originType?: SE.OriginTypes | undefined;
+            ownDocumentUpload?: boolean | undefined;
+            returnPickupAttempts?: number | undefined;
+            saturdayDelivery?: boolean | undefined;
+            shipperRelease?: boolean | undefined;
+            thirdPartyConsignee?: boolean | undefined;
+            useUpsGroundFreightPricing?: boolean | undefined;
+        } | undefined;
+        carrierId: string;
+        comparisonRateType?: string | undefined;
+        confirmation: SE.ConfirmationType;
+        createdAt: string;
+        customs?: SE.Customs | undefined;
+        externalOrderId?: string | undefined;
+        externalShipmentId?: string | undefined;
+        insuranceProvider: SE.InsuranceProviderType;
+        isReturn?: boolean | undefined;
+        items: SE.ShipmentItem[];
+        modifiedAt: string;
+        orderSourceCode: SE.OrderSourceCode | null;
+        originType?: SE.OriginTypes | undefined;
+        packages: SE.ShipmentPackage[];
+        returnTo: SE.Address | null;
+        serviceCode: string | null;
+        shipDate?: string | undefined;
+        shipFrom: SE.Address | null;
+        shipmentId: string;
+        shipmentNumber?: string | undefined;
+        shipmentStatus: SE.ShipmentStatus;
+        shippingRuleId?: string | undefined;
+        shipTo: SE.Address;
+        tags: {
+            name: string;
+        }[];
+        taxIdentifiers?: SE.TaxIdentifier[] | undefined;
+        totalWeight: SE.WeightWithUnit;
+        validateAddress?: SE.AddressValidationOptions | undefined;
+        warehouseId?: string | undefined;
+    }[] | undefined;
+    shouldShowFilters: boolean;
+};

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

@@ -1,8 +1,68 @@
-import { Shipment, ShipmentStatus } from "@shipengine/react-api";
-type ShipmentsGridProps = {
-    onRowClick?: (data: Shipment) => void;
-    shipmentStatus?: ShipmentStatus;
+/// <reference types="react" />
+import { SE } from "@shipengine/js-api";
+/**
+ * # Shipments Grid Props
+ *
+ * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
+ */
+export type ShipmentsGridProps = {
+    /**
+     * `onRowClick` callback invoked when a row is clicked.
+     */
+    onRowClick?: (data: SE.Shipment) => void;
+    /**
+     * `shipmentStatus` is the status of the shipments you wish to view.
+     * If no value is defined, all shipments will be rendered.
+     */
+    shipmentStatus?: SE.ShipmentStatus;
+    /**
+     * `showShipmentIdFilter` controls the display of the shipmentId search filter
+     */
+    showShipmentIdFilter?: boolean;
 };
+/**
+ * # Shipments Grid Component
+ *
+ * - The `<ShipmentsGrid />` component is used to view the user's list of shipments.
+ *
+ * @param ShipmentsGridProps The base props that will be passed into the `<ShipmentsGrid />` component.
+ *
+ * @returns Element An EmotionJSX.Element that will render the `<ShipmentsGrid />` component.
+ *
+ * @example
+ * You can see how the `<Component />` is used in the `createElement` function call below.
+ * ```tsx
+ * export const Element = createElement(Component, ErrorFallback, {
+ *   resources: { en },
+ * });
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link ShipmentsGrid.Element | The **Element** created to render `<ShipmentsGrid />`}
+ */
+export declare const Component: ({ onRowClick, shipmentStatus, showShipmentIdFilter, }: ShipmentsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * # 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 />`}
+ *
+ */
 export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
     resources?: {
         en: {
@@ -120,7 +180,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -128,7 +187,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -142,7 +200,6 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -198,11 +255,18 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     tax: string;
                     delivery: string;
                     handling: string;
+                    /**
+                     * # Shipments Grid Props
+                     *
+                     * @see {@link ShipmentsGrid.Element | This prop types usage in `<ShipmentsGrid />`}
+                     */
                     special_goods: string;
                     pickup: string;
                     location_fee: string;
                     oversize: string;
-                    returns: string;
+                    returns: string; /**
+                     * `onRowClick` callback invoked when a row is clicked.
+                     */
                     notifications: string;
                     tip: string;
                     duties_and_taxes: string;
@@ -343,18 +407,15 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
             };
             onboarding: {
                 title: string;
-                inlineTitle: string;
-                accountRegistration: {
-                    action: string;
+                confirmation: {
                     title: string;
-                    subtitle: string;
-                    welcome: string;
-                    messageLine1: string;
-                    partnerMessageLine1: string;
-                    messageLine2: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
                 };
                 stepLabel: {
-                    accountRegistration: string;
+                    confirmation: string;
                     termsAgreement: string;
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
@@ -401,6 +462,14 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -509,32 +578,74 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
             };
             "list-shipments": {
                 title: string;
+                none: string;
                 headers: {
                     created: string;
-                    download: string;
+                    modified: string;
+                    shipping: string;
                     shipmentId: string;
-                    shipDate: string;
-                    shipTo: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
+                };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
                 };
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 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;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
                 };
             };
             "connect-carrier": {
@@ -593,7 +704,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         county: string;
                         countryCode: string;
                         addressLine1: string;
-                        addressLine2: string;
+                        addressLine2: string; /**
+                         * `onRowClick` callback invoked when a row is clicked.
+                         */
                         cityLocality: string;
                         stateProvince: string;
                         postalCode: string;
@@ -736,6 +849,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -754,6 +868,13 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     "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;
@@ -829,6 +950,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -842,6 +964,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -866,6 +989,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -896,7 +1020,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     transactionHistory: string;
                     adjustmentHistory: string;
                     warehouses: string;
-                    carriers: string;
+                    carriers: string; /**
+                     * `onRowClick` callback invoked when a row is clicked.
+                     */
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
@@ -906,4 +1032,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
         };
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
-export {};
+/**
+ * # Shipments Grid Element Props
+ *
+ * @see {@link ShipmentsGrid.Element | See the full type that `typeof Element` will return}
+ */
+export type ElementProps = React.ComponentProps<typeof Element>;