@shipengine/elements 2.3.1 → 2.5.0

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

@@ -117,7 +117,6 @@ export declare const Element: ({ resources, ...props }: object & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -125,7 +124,6 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -139,7 +137,6 @@ export declare const Element: ({ resources, ...props }: object & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -340,18 +337,15 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             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;
@@ -398,6 +392,14 @@ export declare const Element: ({ resources, ...props }: object & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -506,32 +508,74 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             "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": {
@@ -733,6 +777,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -751,6 +796,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;
@@ -826,6 +878,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -839,6 +892,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -863,6 +917,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -0,0 +1,68 @@
+/// <reference types="react" />
+import { LabelsGridProps } from "../";
+import { IGridFilters } from "../../../components";
+export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter }: LabelsGridProps) => {
+    clearAllFilters: () => void;
+    filters: IGridFilters;
+    isAnyFilterActive: boolean;
+    isError: boolean;
+    isLoading: boolean;
+    labels: {
+        serviceName: string | null | undefined;
+        alternativeIdentifiers?: string[] | undefined;
+        batchId: string;
+        carrierCode: string;
+        carrierId: string;
+        chargeEvent: import("@shipengine/react-api").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;
+        isInternational: boolean;
+        isReturnLabel: boolean;
+        labelDownload: import("@shipengine/react-api").Download;
+        labelFormat: import("@shipengine/react-api").LabelFormat;
+        labelId: string;
+        labelImageId: string;
+        labelLayout: import("@shipengine/react-api").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[];
+        relayPoints: {
+            shipFrom: import("@shipengine/react-api").RelayPoint;
+            shipTo: import("@shipengine/react-api").RelayPoint;
+        };
+        requestedComparisonAmount?: import("@shipengine/react-api").Money | undefined;
+        rmaNumber: string;
+        serviceCode: string;
+        shipDate: string;
+        shipmentCost: import("@shipengine/react-api").Money;
+        shipmentId: string;
+        shippingRuleId: string | null;
+        shipTo: import("@shipengine/react-api").Address;
+        status: import("@shipengine/react-api").LabelStatus;
+        trackable: boolean;
+        trackingNumber: string;
+        trackingStatus: string;
+        trackingUrl: string;
+        voided: boolean;
+        voidedAt: string | null;
+    }[];
+    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>>;
+    shouldShowFilters: boolean;
+};

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

@@ -1 +1,2 @@
 export * as LabelsGrid from "./labels-grid";
+export type { LabelsGridProps } from "./labels-grid";

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

@@ -1,8 +1,42 @@
-import { Label } from "@shipengine/react-api";
-type ComponentProps = {
-    onRowClick: (data: Label) => void;
+/// <reference types="react" />
+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;
+    /**
+     * `onViewDetails` is a callback function that controls the "View Details" action button and
+     *  will be invoked when the user clicks on it.
+     */
+    onClickViewDetails?: (label: SE.Label) => 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;
+    /**
+     * `onRowClick` callback invoked when a row is clicked.
+     */
+    onRowClick?: (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 Component: ({ labelStatus, showShipmentIdFilter, onClickPrintLabel, onClickVoidLabel, onClickPrintForms, onClickViewDetails, onRowClick, }: LabelsGridProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ resources, ...props }: LabelsGridProps & {
     resources?: {
         en: {
             "wallet-history": {
@@ -119,7 +153,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -127,7 +160,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -141,7 +173,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
+                            /**
+                             * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                             * `Print Forms` button.
+                             */
                             description: string;
                         };
                         poBox: {
@@ -342,18 +377,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;
@@ -366,6 +398,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     noCarriers: {
                         title: string;
+                        /**
+                         * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                         * `Print Forms` button.
+                         */
                         subtitle: string;
                     };
                 };
@@ -375,7 +411,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     action: string;
                 };
                 termsAndAgreementLinkText: {
-                    shipEngineToS: string;
+                    shipEngineToS: string; /**
+                     * `onViewDetails` is a callback function that controls the "View Details" action button and
+                     *  will be invoked when the user clicks on it.
+                     */
                     auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
@@ -400,6 +439,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;
@@ -449,6 +496,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         amount: string;
                     };
                     minimumPurchaseAmount: string;
+                    /**
+                     * `onClickVoidLabel` is a callback function that controls the display of `Void Label` button and
+                     *  will be invoked when the user clicks on it.
+                     */
                     other: string;
                 };
                 fundAndPurchase: {
@@ -508,32 +559,74 @@ 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;
                 };
                 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": {
@@ -735,6 +828,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -753,6 +847,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 +929,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     requiredList: string;
                     tooFewCharacters: string;
                     tooManyCharacters: string;
+                    requiredShipmentId: string;
                 };
                 shippingPresets: {
                     apply: string;
@@ -841,6 +943,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -865,6 +968,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -905,4 +1009,4 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
         };
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
-export {};
+export type ElementProps = React.ComponentProps<typeof Element>;

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

@@ -0,0 +1,11 @@
+export declare const styles: {
+    errorState: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        border?: string | undefined;
+        borderRadius?: string | undefined;
+        boxShadow?: string | undefined;
+        backgroundColor: string;
+    };
+    tableParagraph: {
+        margin: number;
+    };
+};