@shipengine/elements 2.4.0 → 2.6.0

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,18 +578,38 @@ 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;
@@ -554,6 +643,10 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -611,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;
@@ -754,6 +849,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -868,6 +964,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -892,6 +989,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
@@ -922,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;
@@ -932,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>;

package/src/elements/shipments-grid/shipments-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;
+    };
+};

package/src/elements/theme-creator/theme-creator.d.ts

@@ -130,7 +130,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -138,7 +137,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -152,7 +150,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -353,18 +350,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;
@@ -411,6 +405,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;
@@ -519,18 +521,38 @@ 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;
@@ -564,6 +586,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -764,6 +790,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -878,6 +905,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -902,6 +930,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

package/src/elements/transaction-history/transaction-history-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/unit-settings/unit-settings-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;