@shipengine/elements 1.9.0 → 2.1.0

package/src/elements/{view-shipment/view-shipment.d.ts → shipment-summary/shipment-summary.d.ts}

@@ -1,19 +1,18 @@
 /// <reference types="react" />
-import { SE } from "@shipengine/alchemy";
-import { ShipmentFeatures } from "../../components/templates/shipment";
-import { VatSettingsFeatures } from "../../features";
+import { SE } from "@shipengine/react-api";
+import { ShipmentSummaryFeatures } from "../../utilities";
 /**
- * # View Shipment Component Props
+ * # Shipment Summary Component Props
  *
- * - These are the base props that will be passed into the `<ViewShipment />` component.
+ * - These are the base props that will be passed into the `<ShipmentSummary />` component.
  *
- * @see {@link ViewShipment.Component | This prop types usage in the `<ViewShipment />` component}
+ * @see {@link ShipmentSummary.Component | This prop types usage in the `<ShipmentSummary />` component}
  */
 export type ComponentProps = {
     /**
      * `features` is a set of feature flags you would like to enable or disable in this component.
      */
-    features?: ShipmentFeatures & VatSettingsFeatures;
+    features?: ShipmentSummaryFeatures;
     /**
      * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
      * `Print Label` button.
@@ -35,21 +34,21 @@ export type ComponentProps = {
     shipmentId?: string;
 };
 /**
- * # View Shipment Component
+ * # Shipment Summary Component
  *
- * - The `<ViewShipment />` component is used to for viewing the shipment's tracking number, printing the label that
+ * - The `<ShipmentSummary />` component is used to for viewing the shipment's tracking number, printing the label that
  * was created, and the option to void the label. When a label is voided, you can see a list of the
  * previously voided labels for a given shipment using this component.
  *
- * @param ComponentProps The base props that will be passed into the `<ViewShipment />` component.
+ * @param ComponentProps The base props that will be passed into the `<ShipmentSummary />` component.
  *
- * @returns Element An EmotionJSX.Element that will render the `<ViewShipment />` component
+ * @returns Element An EmotionJSX.Element that will render the `<ShipmentSummary />` component
  * with all the appropriate wrappers.
  *
  * @example
  * You can see how the `<Component />` is used in the `createElement` function call below.
  * ```tsx
- * export const Element = alchemy.createElement(Component, ErrorFallback, {
+ * export const Element = createElement(Component, ErrorFallback, {
  *   css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
  *   resources: { en },
  * });
@@ -57,23 +56,23 @@ export type ComponentProps = {
  *
  * <br />
  *
- * @see {@link ViewShipment.Element | The **Element** created to render `<ViewShipment />`}
+ * @see {@link ShipmentSummary.Element | The **Element** created to render `<ShipmentSummary />`}
  */
 export declare const Component: ({ features, onClickPrintLabel, onClickPurchaseLabel, onClickVoidLabel, shipmentId, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
- * # Registered View Shipment Element
+ * # Registered Shipment Summary Element
  *
- * - This is the registered `<ViewShipment />` element that will be used to render the
- * `<ViewShipment.Element />` component.
+ * - This is the registered `<ShipmentSummary />` element that will be used to render the
+ * `<ShipmentSummary.Element />` component.
  *
  * @param ElementProps The props, callbacks, and resources necessary to render
- * the `<ViewShipment.Element />` component.
+ * the `<ShipmentSummary.Element />` component.
  *
  * @example
- * The `<Component />` is the source JSX that is rendered when you make use of the `ViewShipment`
+ * The `<Component />` is the source JSX that is rendered when you make use of the `ShipmentSummary`
  * Element directly. Here is a brief example of how you would use it within your application.
  * ```tsx
- * <ViewShipment.Element
+ * <ShipmentSummary.Element
  *   onClickPurchaseLabel={({ salesOrderId }) => {
  *     console.log('sales order ID', salesOrderId);
  *   }}
@@ -86,7 +85,7 @@ export declare const Component: ({ features, onClickPrintLabel, onClickPurchaseL
  *
  * <br />
  *
- * @see {@link ViewShipment.ComponentProps | The **props** that can be passed into the `<ViewShipment.Element />` component}
+ * @see {@link ShipmentSummary.ComponentProps | The **props** that can be passed into the `<ShipmentSummary.Element />` component}
  *
  * @see {@link VoidLabel.Element | The next step in the label purchase workflow `<VoidLabel.Element />`}
  **/
@@ -158,9 +157,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipDate: string;
                     shipTo: string;
                     warehouse: string;
-                    weight: string; /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
+                    weight: string;
                     insuredValue: string;
                     deliveryConfirmation: string;
                 };
@@ -168,10 +165,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
-                    shipmentSummary: string; /**
-                     * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
-                     * `Void Label` button.
-                     */
+                    shipmentSummary: string;
                 };
                 noLabels: string;
             };
@@ -193,7 +187,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     genericText: string;
                 };
             };
-            "shipengine-carriers": {
+            "manage-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -239,6 +233,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         };
                         poBox: {
                             title: string;
+                            /**
+                             * `onClickVoidLabel` is a callback function that will be invoked when the user clicks the
+                             * `Void Label` button.
+                             */
                             description: string;
                         };
                         carrier: {
@@ -271,6 +269,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -295,13 +294,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     oversize: string;
                     returns: string;
                     notifications: string;
-                    tip: string;
+                    tip: string; /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                     duties_and_taxes: string;
                     brokerage_fee: string;
-                    admin_fee: string; /**
-                     * `onClickPrintLabel` is a callback function that will be invoked when the user clicks the
-                     * `Print Label` button.
-                     */
+                    admin_fee: string;
                     adjustment: string;
                     auctane_service_fee: string;
                     product_price: string;
@@ -418,7 +416,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     today: string;
                     viewMap: string;
                     otherLocations: string;
-                    noServicePointsForService: string;
+                    noServicePointsForService: string; /**
+                     * # Shipment Summary Element Props
+                     *
+                     * - These are the base props that will be passed into the `<ShipmentSummary />` element.
+                     *
+                     * @see {@link ShipmentSummary.Element | See the full type that `typeof Element` will return}
+                     */
                     error: string;
                     paperless: string;
                     localTimeDisclaimer: string;
@@ -458,6 +462,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -503,6 +513,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -517,30 +528,19 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     error: {
                         title: string;
                         message: string;
-                    }; /**
-                     * # View Shipment Component Props
-                     *
-                     * - These are the base props that will be passed into the `<ViewShipment />` component.
-                     *
-                     * @see {@link ViewShipment.Component | This prop types usage in the `<ViewShipment />` component}
-                     */
+                    };
                     isEnabledCTA: string;
                     isEnabled: string;
                     isLoading: string;
                     lowBalancePurchaseThreshold: string;
-                    maximumPurchasesPerDay: string; /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
+                    maximumPurchasesPerDay: string;
                     purchaseAmount: string;
                     readSettings: string;
                 };
                 addFunds: {
                     custom: string;
                     error: {
-                        title: string; /**
-                         * `onClickPurchaseLabel` is a callback function that will be invoked when the user clicks the
-                         * `Purchase Label` button.
-                         */
+                        title: string;
                         message: string;
                     };
                     isLoading: string;
@@ -561,6 +561,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -660,6 +661,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -709,7 +713,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         modified: string;
                         title: string;
                         originalAddress: string;
-                        matchedAddress: string;
+                        matchedAddress: string; /**
+                         * `shipmentId` is the unique identifier for the shipment you wish to view.
+                         */
                         unableToValidate: string;
                         use: {
                             originalAddress: string;
@@ -762,6 +768,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -769,6 +776,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -786,6 +801,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -798,13 +818,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     parsingFailure: string;
                     incompleteLabelPurchaseRequirements: string;
-                    /**
-                     * # View Shipment Element Props
-                     *
-                     * - These are the base props that will be passed into the `<ViewShipment />` element.
-                     *
-                     * @see {@link ViewShipment.Element | See the full type that `typeof Element` will return}
-                     */
                     shipmentCancelled: string;
                     unableToLoad: {
                         accountSettings: string;
@@ -865,6 +878,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -943,6 +958,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -958,7 +983,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {
@@ -978,10 +1007,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
- * # View Shipment Element Props
+ * # Shipment Summary Element Props
  *
- * - These are the base props that will be passed into the `<ViewShipment />` element.
+ * - These are the base props that will be passed into the `<ShipmentSummary />` element.
  *
- * @see {@link ViewShipment.Element | See the full type that `typeof Element` will return}
+ * @see {@link ShipmentSummary.Element | See the full type that `typeof Element` will return}
  */
 export type ElementProps = React.ComponentProps<typeof Element>;

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

@@ -1,4 +1,4 @@
-import { Shipment, ShipmentStatus } from "@shipengine/alchemy";
+import { Shipment, ShipmentStatus } from "@shipengine/react-api";
 type ShipmentsGridProps = {
     onRowClick?: (data: Shipment) => void;
     shipmentStatus?: ShipmentStatus;
@@ -101,7 +101,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     genericText: string;
                 };
             };
-            "shipengine-carriers": {
+            "manage-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -179,6 +179,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -363,6 +364,12 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -408,6 +415,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -455,6 +463,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -554,6 +563,9 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -656,6 +668,7 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -663,6 +676,14 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -680,6 +701,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -752,6 +778,8 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -830,6 +858,16 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -845,7 +883,11 @@ export declare const Element: ({ resources, ...props }: ShipmentsGridProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

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

@@ -111,7 +111,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     genericText: string;
                 };
             };
-            "shipengine-carriers": {
+            "manage-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -189,6 +189,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -373,6 +374,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -418,6 +425,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -465,6 +473,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -564,6 +573,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -666,6 +678,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -673,6 +686,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -690,6 +711,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -762,6 +788,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -840,6 +868,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -855,7 +893,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

package/src/elements/transaction-history/index.d.ts

@@ -0,0 +1 @@
+export * as TransactionHistory from "./transaction-history-element";