@shipengine/elements 0.37.1 → 0.37.3

package/src/elements/onboarding/onboarding.d.ts

@@ -586,6 +586,29 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     parsingFailure: string;
                     incompleteLabelPurchaseRequirements: string;
+                    shipmentCancelled: string;
+                    /**
+                     * # Registered Onboarding Element
+                     *
+                     * - This is the registered `<Onboarding />` element that will be used to render the
+                     * `<Onboarding.Element />` component.
+                     *
+                     * @param ElementProps The props, callbacks, and resources necessary to render
+                     * the `<Onboarding.Element />` component.
+                     *
+                     * @example
+                     * The `<Component />` is the source JSX that is rendered when you make use of the `Onboarding`
+                     * Element directly. Here is a brief example of how you would use it within your application.
+                     * ```tsx
+                     * <Onboarding.Element
+                     *   onCompleteOnboarding={() => console.log('Onboarding Complete!')}
+                     * />
+                     * ```
+                     *
+                     * <br />
+                     *
+                     * @see {@link Onboarding.ComponentProps | The **props** that can be passed into the `<Onboarding.Element />` component}
+                     */
                     unableToLoad: {
                         accountSettings: string;
                         autoFundingSettings: string;
@@ -606,6 +629,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     purchase: string;
                     rateInvalid: string;
                     security: string;
+                    shipmentStatus: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -664,7 +688,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidAddressNameStrict: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
-                    invalidExpiration: string;
+                    invalidExpirationDate: string;
                     invalidPostalCode: string;
                     invalidStateProvince: string;
                     invalidString: string;

package/src/elements/purchase-label/hooks/use-configure-shipment.d.ts

@@ -2,13 +2,14 @@ import { SE } from "@shipengine/alchemy";
 import { ConfigureShipmentProps } from "../../configure-shipment";
 import { UsePendingShipmentProps } from "./use-pending-shipment";
 export type UseConfigureShipmentProps = {
+    errorWhenShipmentCancelled?: boolean;
     onLoad?: UsePendingShipmentProps["onLoad"];
     onShipmentUpdated?: ConfigureShipmentProps["onShipmentUpdated"];
     printLabelLayout?: SE.LabelLayout;
     salesOrder?: SE.SalesOrder;
     warehouseId?: UsePendingShipmentProps["warehouseId"];
 };
-export declare const useConfigureShipment: ({ onLoad, onShipmentUpdated, salesOrder, warehouseId, printLabelLayout, }: UseConfigureShipmentProps) => {
+export declare const useConfigureShipment: ({ onLoad, errorWhenShipmentCancelled, onShipmentUpdated, salesOrder, warehouseId, printLabelLayout, }: UseConfigureShipmentProps) => {
     errors: SE.CodedError[] | undefined;
     isLoading: boolean;
     onShipmentUpdated: (shipment: SE.SalesOrderShipment) => Promise<void>;

package/src/elements/purchase-label/hooks/use-pending-shipment.d.ts

@@ -1,12 +1,13 @@
-import { SE } from "@shipengine/alchemy";
+import { CodedError, SE } from "@shipengine/alchemy";
 export type UsePendingShipmentProps = {
+    breakOnCancelledShipment?: boolean;
     onLoad?: (salesOrder: SE.SalesOrder, shipments: SE.SalesOrderShipment[], pendingShipment?: SE.SalesOrderShipment) => Promise<void> | void;
     salesOrder?: SE.SalesOrder;
     warehouseId?: string;
 };
-export declare const usePendingShipment: ({ onLoad, salesOrder, warehouseId, }: UsePendingShipmentProps) => {
+export declare const usePendingShipment: ({ breakOnCancelledShipment, onLoad, salesOrder, warehouseId, }: UsePendingShipmentProps) => {
     isPendingShipmentLoading: boolean;
     pendingShipment: SE.SalesOrderShipment | undefined;
-    pendingShipmentErrors: SE.CodedError[] | undefined;
+    pendingShipmentErrors: CodedError[] | undefined;
     reloadPendingShipment: () => Promise<SE.SalesOrderShipment | undefined>;
 };

package/src/elements/purchase-label/purchase-label.d.ts

@@ -705,17 +705,12 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     invalidNameOrCompany: string;
                     parsingFailure: string;
                     incompleteLabelPurchaseRequirements: string;
+                    shipmentCancelled: string;
                     unableToLoad: {
                         accountSettings: string;
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
-                        /**
-                         * `onToggleAddressPreferenceDisclosure` is an async/sync callback function that will be invoked
-                         * each time the user toggles the `Address Preference` disclosure. This disclosure component
-                         * allows the user to select whether they would like to use the address they entered, or
-                         * the formatted address that we return after validation.
-                         */
                         label: string;
                         salesOrder: string;
                         shipment: string;
@@ -731,6 +726,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     purchase: string;
                     rateInvalid: string;
                     security: string;
+                    shipmentStatus: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -748,10 +744,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     connectingCarriers: string;
                     data: string;
                     importingSalesOrder: string;
-                    label: string; /**
-                     * `warehouseId` is a string that represents a previously configured warehouse you would
-                     * like to use as the `Ship From Address` when purchasing a label.
-                     */
+                    label: string;
                     onboarding: string;
                     salesOrder: string;
                     shipment: string;
@@ -769,6 +762,30 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     september: string;
                     october: string;
                     november: string;
+                    /**
+                     * # Purchase Label Component
+                     *
+                     * The `<PurchaseLabel />` component is used to purchase shipping labels from various carriers
+                     *
+                     * @param ElementProps The props necessary to render the `<PurchaseLabel />` component for shipment
+                     * based or sales order based label purchasing.
+                     *
+                     * @returns Element An EmotionJSX.Element that will render the `<PurchaseLabel />` 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, {
+                     *   css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
+                     *   resources: { en },
+                     * });
+                     * ```
+                     *
+                     * <br />
+                     *
+                     * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
+                     */
                     december: string;
                 };
                 packageCategories: {
@@ -792,7 +809,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     invalidAddressNameStrict: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
-                    invalidExpiration: string;
+                    invalidExpirationDate: string;
                     invalidPostalCode: string;
                     invalidStateProvince: string;
                     invalidString: string;

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

@@ -621,9 +621,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     parsingFailure: string;
                     incompleteLabelPurchaseRequirements: string;
+                    shipmentCancelled: string;
                     unableToLoad: {
                         accountSettings: string;
                         autoFundingSettings: 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}
+                         */
                         carrier: string;
                         carriers: string;
                         label: string;
@@ -641,6 +649,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     purchase: string;
                     rateInvalid: string;
                     security: string;
+                    shipmentStatus: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -699,7 +708,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidAddressNameStrict: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
-                    invalidExpiration: string;
+                    invalidExpirationDate: string;
                     invalidPostalCode: string;
                     invalidStateProvince: string;
                     invalidString: string;

package/src/elements/void-label/void-label.d.ts

@@ -624,6 +624,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidNameOrCompany: string;
                     parsingFailure: string;
                     incompleteLabelPurchaseRequirements: string;
+                    shipmentCancelled: string;
                     unableToLoad: {
                         accountSettings: string;
                         autoFundingSettings: string;
@@ -644,6 +645,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     purchase: string;
                     rateInvalid: string;
                     security: string;
+                    shipmentStatus: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -702,7 +704,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     invalidAddressNameStrict: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
-                    invalidExpiration: string;
+                    invalidExpirationDate: string;
                     invalidPostalCode: string;
                     invalidStateProvince: string;
                     invalidString: string;

package/src/locales/en/index.d.ts

@@ -496,6 +496,7 @@ declare const _default: {
             invalidNameOrCompany: string;
             parsingFailure: string;
             incompleteLabelPurchaseRequirements: string;
+            shipmentCancelled: string;
             unableToLoad: {
                 accountSettings: string;
                 autoFundingSettings: string;
@@ -516,6 +517,7 @@ declare const _default: {
             purchase: string;
             rateInvalid: string;
             security: string;
+            shipmentStatus: string;
             system: string;
             unknown: string;
             validation: string;
@@ -574,7 +576,7 @@ declare const _default: {
             invalidAddressNameStrict: string;
             invalidAddressPoBox: string;
             invalidCreditCardType: string;
-            invalidExpiration: string;
+            invalidExpirationDate: string;
             invalidPostalCode: string;
             invalidStateProvince: string;
             invalidString: string;

package/src/utilities/feature-flags.d.ts

@@ -51,6 +51,15 @@ export declare const featureFlags: {
          * Elements.
          */
         readonly compatibleCountryCodes: readonly ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"];
+        /**
+         * `configureShipment` is a group of flags related to the useConfigureShipment functionality
+         */
+        readonly configureShipment: {
+            /**
+             * `enableErrorWhenShipmentCancelled` when enabled will modify the default behavior of creating a new shipment for a salesorder to throwing an error
+             */
+            readonly enableErrorWhenShipmentCancelled: false;
+        };
         /**
          * @internal
          *

package/src/utilities/shipengine/shipment.d.ts

@@ -18,8 +18,24 @@ export declare const getIsCustomsRequiredForShipment: ({ shipFrom, shipTo }: SE.
 /**
  * @internal
  *
+ * @deprecated please use getShipmentByStatus instead
  * # Shipment Utilities - getPendingShipment
  *
  * @category Utilities
  */
 export declare const getPendingShipment: (shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
+/**
+ *
+ * @deprecated please use getShipmentByStatus instead
+ * @internal
+ * @param shipments
+ * @returns the latest created shipment whose status is `cancelled`
+ */
+export declare const getCancelledShipment: (shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
+/**
+ *
+ * @param status string containing one of the following values - "pending", "processing", "label_purchased", "cancelled"
+ * @param shipments optional list of shipments to filter from
+ * @returns latest created shipment whose shipmentStatus matches the param status
+ */
+export declare const getShipmentByStatus: (status: SE.ShipmentStatus, shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;