@shipengine/elements 2.4.0 → 2.6.0

package/src/components/warehouse-form/warehouse-form-schema.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const getWarehouseSchema: (useStrict: boolean) => z.ZodDiscriminatedUnion<"returnToAddressIsDifferent", z.Primitive, z.ZodObject<{
+export declare const getWarehouseSchema: (useStrict: boolean, emailRequired?: boolean) => z.ZodDiscriminatedUnion<"returnToAddressIsDifferent", z.Primitive, z.ZodObject<{
     isDefault: z.ZodBoolean;
     name: z.ZodString;
     originAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<z.extendShape<{
@@ -16,6 +16,7 @@ export declare const getWarehouseSchema: (useStrict: boolean) => z.ZodDiscrimina
     }, {
         addressResidentialIndicator: z.ZodEffects<z.ZodEffects<z.ZodDefault<z.ZodBoolean>, "yes" | "no", boolean | undefined>, "yes" | "no", unknown>;
         companyName: z.ZodString;
+        email: z.ZodString | z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
         name: z.ZodString;
         phone: z.ZodString;
     }>, "strip", z.ZodTypeAny, {
@@ -129,6 +130,7 @@ export declare const getWarehouseSchema: (useStrict: boolean) => z.ZodDiscrimina
     }, {
         addressResidentialIndicator: z.ZodEffects<z.ZodEffects<z.ZodDefault<z.ZodBoolean>, "yes" | "no", boolean | undefined>, "yes" | "no", unknown>;
         companyName: z.ZodString;
+        email: z.ZodString | z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
         name: z.ZodString;
         phone: z.ZodString;
     }>, "strip", z.ZodTypeAny, {
@@ -306,6 +308,7 @@ export declare const getWarehouseSchema: (useStrict: boolean) => z.ZodDiscrimina
     }, {
         addressResidentialIndicator: z.ZodEffects<z.ZodEffects<z.ZodDefault<z.ZodBoolean>, "yes" | "no", boolean | undefined>, "yes" | "no", unknown>;
         companyName: z.ZodString;
+        email: z.ZodString | z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
         name: z.ZodString;
         phone: z.ZodString;
     }>, "strip", z.ZodTypeAny, {

package/src/components/warehouse-form/warehouse-form.d.ts

@@ -5,6 +5,7 @@ export type WarehouseFormProps<T = undefined> = {
     onCancel?: () => void;
     onDelete?: () => void;
     onSubmit: (payload: WarehousePayload) => void;
+    requireEmail?: boolean;
     shouldForceDefault?: boolean;
     submitButtonTitle: string;
     useStrictSchema?: boolean;
@@ -16,4 +17,4 @@ export type WarehouseFormProps<T = undefined> = {
     formId?: string;
     portalRef?: never;
 });
-export declare const WarehouseForm: <T extends Element>({ onCancel, formId, onDelete, onSubmit, portalRef, submitButtonTitle, warehouse, shouldForceDefault, useStrictSchema, }: WarehouseFormProps<T>) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const WarehouseForm: <T extends Element>({ onCancel, formId, onDelete, onSubmit, portalRef, requireEmail, submitButtonTitle, warehouse, shouldForceDefault, useStrictSchema, }: WarehouseFormProps<T>) => import("@emotion/react/jsx-runtime").JSX.Element;

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,18 +508,38 @@ 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;
@@ -551,6 +573,10 @@ export declare const Element: ({ resources, ...props }: object & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -751,6 +777,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -865,6 +892,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -889,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

@@ -5,6 +5,7 @@ export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter }: Labe
     clearAllFilters: () => void;
     filters: IGridFilters;
     isAnyFilterActive: boolean;
+    isError: boolean;
     isLoading: boolean;
     labels: {
         serviceName: string | null | undefined;
@@ -60,6 +61,7 @@ export declare const useLabelsGrid: ({ labelStatus, showShipmentIdFilter }: Labe
         };
         pagesAmount: number;
         pageSize: number;
+        showPagination: boolean;
         totalElements: number;
     };
     setFilters: import("react").Dispatch<import("react").SetStateAction<IGridFilters>>;

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

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { SE } from "@shipengine/js-api";
 export type LabelsGridProps = {
     /**
@@ -15,16 +16,26 @@ export type LabelsGridProps = {
      * `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 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: {
@@ -69,10 +80,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     approved: string;
                     rejected: 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.
-                 */
+                voidedOn: string;
             };
             "view-shipment": {
                 title: string;
@@ -92,10 +100,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     items: string;
                     orderDate: string;
                     orderValue: string;
-                    requestedShipping: string; /**
-                     * `labelStatus` is the status of the labels you wish to view.
-                     * If no value is defined, all labels will be rendered.
-                     */
+                    requestedShipping: string;
                     shipDate: string;
                     shipTo: string;
                     warehouse: string;
@@ -148,7 +153,6 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -156,7 +160,6 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -170,7 +173,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                             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: {
@@ -371,33 +377,31 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
             };
             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;
                 };
                 warehouse: {
                     title: string;
-                    subtitle: string; /**
-                     * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
-                     * `Print Label` button.
-                     */
+                    subtitle: string;
                     inlineMessage: string;
                 };
                 errors: {
                     noCarriers: {
                         title: string;
+                        /**
+                         * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
+                         * `Print Forms` button.
+                         */
                         subtitle: string;
                     };
                 };
@@ -407,7 +411,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     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;
@@ -432,6 +439,14 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -447,10 +462,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                 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;
@@ -470,15 +482,9 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     isLoading: string;
                     lowBalancePurchaseThreshold: string;
                     maximumPurchasesPerDay: string;
-                    purchaseAmount: string; /**
-                     * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
-                     * `Print Forms` button.
-                     */
+                    purchaseAmount: string;
                     readSettings: string;
-                }; /**
-                 * `onClickPrintLabel` is an optional callback function that will be invoked when the user clicks the
-                 * `Print Label` button.
-                 */
+                };
                 addFunds: {
                     custom: string;
                     error: {
@@ -490,6 +496,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         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: {
@@ -549,18 +559,38 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
             };
             "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;
@@ -594,6 +624,10 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -653,10 +687,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         addressLine1: string;
                         addressLine2: string;
                         cityLocality: string;
-                        stateProvince: string; /**
-                         * `onClickPrintForm` is an optional callback function that will be invoked when the user clicks the
-                         * `Print Forms` button.
-                         */
+                        stateProvince: string;
                         postalCode: string;
                         phone: string;
                         email: string;
@@ -797,6 +828,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -911,6 +943,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -935,6 +968,7 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -975,3 +1009,4 @@ export declare const Element: ({ resources, ...props }: LabelsGridProps & {
         };
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
+export type ElementProps = React.ComponentProps<typeof Element>;

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

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

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

@@ -141,7 +141,6 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -149,7 +148,6 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -163,7 +161,6 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -386,18 +383,15 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
             };
             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;
@@ -444,6 +438,14 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -552,18 +554,38 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
             };
             "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;
@@ -597,6 +619,10 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -819,6 +845,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -933,6 +960,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -957,6 +985,7 @@ export declare const Element: ({ resources, ...props }: ShipEngineCarriersProps
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;