@shipengine/elements 1.8.0 → 2.0.0

package/src/workflows/{connect-carrier/connect-carrier.d.ts → connect-external-carrier/connect-external-carrier.d.ts}

@@ -1,24 +1,20 @@
 /// <reference types="react" />
-export type ConnectCarrierFeatures = {
-    availableCarrierConnections?: string[];
-};
 /**
- * # Connect-Carrier Props
+ * # ConnectExternalCarrier Props
  *
- * @see {@link ConnectCarrier.Component | The `<ConnectCarrier />` component}
+ * @see {@link ConnectExternalCarrier.Component | The `<ConnectExternalCarrier />` component}
  */
 export type ComponentProps = {
     carrierName?: string;
-    features?: ConnectCarrierFeatures;
     onCancel?: () => void;
     onCarrierConnected?: (carrierId: string) => void;
 };
 /**
- * # Connect-Carriers Component
+ * # ConnectExternalCarrier Component
  *
- * @param ComponentProps The base props that will be passed into the `<ConnectCarrier />` component.
+ * @param ComponentProps The base props that will be passed into the `<ConnectExternalCarrier />` component.
  *
- * @returns Element A React element that renders the `<ConnectCarrier />` component allowing users
+ * @returns Element A React element that renders the `<ConnectExternalCarrier />` component allowing users
  * to connect their own existing carrier account. If no carrier is provided, the user may
  * select from a list of carriers specified by `features.availableCarrierConnections`.
  * This component is composed in the `<AccountSettings />` Element.
@@ -28,15 +24,15 @@ export type ComponentProps = {
  * (() => {
  *   const features = useFeatures("CarrierConnections");
  *
- *   return <ConnectCarrier.Component features={features} />;
+ *   return <ConnectExternalCarrier.Component features={features} />;
  * })();
  * ```
  *
  * <br />
  *
- * @see {@link ConnectCarrier.ComponentProps | The props that are passed into the `<ConnectCarrier />` component}
+ * @see {@link ConnectExternalCarrier.ComponentProps | The props that are passed into the `<ConnectExternalCarrier />` component}
  */
-export declare const Component: ({ carrierName, features, onCancel, onCarrierConnected, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ carrierName, onCancel, onCarrierConnected }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const Element: ({ resources, ...props }: ComponentProps & {
     resources?: {
         en: {
@@ -93,6 +89,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     schedulePickup: string;
                     showItems: string;
                     void: string;
+                    download: string;
                 };
                 fields: {
                     dimensions: string;
@@ -112,6 +109,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
+                    shipmentSummary: string;
                 };
                 noLabels: string;
             };
@@ -133,7 +131,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     genericText: string;
                 };
             };
-            "shipengine-carriers": {
+            "manage-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -201,8 +199,48 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
             };
             "register-carrier": {
-                formTitle: string;
-                agreeToTerms: string;
+                formTitle: {
+                    default: string;
+                    new: string;
+                    edit: string;
+                };
+                notifications: {
+                    error: {
+                        title: string;
+                    };
+                };
+            };
+            "rate-details": {
+                total: string;
+                subtotal: string;
+                registerVat: string;
+                concepts: {
+                    confirmation: string;
+                    uncategorized: string;
+                    shipping: string;
+                    insurance: string;
+                    confirm: string;
+                    discount: string;
+                    fuel_charge: string;
+                    additional_fees: string;
+                    tariff: string;
+                    tax: string;
+                    delivery: string;
+                    handling: string;
+                    special_goods: string;
+                    pickup: string;
+                    location_fee: string;
+                    oversize: string;
+                    returns: string;
+                    notifications: string;
+                    tip: string;
+                    duties_and_taxes: string;
+                    brokerage_fee: string;
+                    admin_fee: string;
+                    adjustment: string;
+                    auctane_service_fee: string;
+                    product_price: string;
+                };
             };
             "purchase-label": {
                 title: string;
@@ -315,7 +353,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     today: string;
                     viewMap: string;
                     otherLocations: string;
-                    noServicePointsFound: string;
+                    noServicePointsForService: string;
+                    error: string;
+                    paperless: string;
+                    localTimeDisclaimer: string;
                 };
                 shipToAddressFormFields: string;
                 sections: {
@@ -576,29 +617,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         postalCode: string;
                         phone: string;
                         email: string;
-                        /**
-                         * # Connect-Carriers Component
-                         *
-                         * @param ComponentProps The base props that will be passed into the `<ConnectCarrier />` component.
-                         *
-                         * @returns Element A React element that renders the `<ConnectCarrier />` component allowing users
-                         * to connect their own existing carrier account. If no carrier is provided, the user may
-                         * select from a list of carriers specified by `features.availableCarrierConnections`.
-                         * This component is composed in the `<AccountSettings />` Element.
-                         *
-                         * @example
-                         * ```tsx
-                         * (() => {
-                         *   const features = useFeatures("CarrierConnections");
-                         *
-                         *   return <ConnectCarrier.Component features={features} />;
-                         * })();
-                         * ```
-                         *
-                         * <br />
-                         *
-                         * @see {@link ConnectCarrier.ComponentProps | The props that are passed into the `<ConnectCarrier />` component}
-                         */
                         addressResidentialIndicator: string;
                     };
                     noResults: string;
@@ -842,6 +860,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;

package/src/workflows/connect-external-carrier/index.d.ts

@@ -0,0 +1 @@
+export * as ConnectExternalCarrier from "./connect-external-carrier";

package/src/workflows/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./onboarding";
-export * from "./purchase-label-workflow";
+export * from "./label-workflow";
 export * from "./account-settings";
-export * from "./connect-carrier";
+export * from "./connect-external-carrier";
+export * from "./carrier-services";

package/src/workflows/label-workflow/index.d.ts

@@ -0,0 +1 @@
+export * as LabelWorkflow from "./label-workflow";

package/src/workflows/{purchase-label-workflow/purchase-label-workflow.d.ts → label-workflow/label-workflow.d.ts}

@@ -1,16 +1,16 @@
 /// <reference types="react" />
 import { Shipment } from "@shipengine/js-api";
-import { PurchaseLabel, ViewShipment, VoidLabel } from "../../elements";
+import { PurchaseLabelFeatures, ShipmentSummaryFeatures } from "../../utilities";
 /**
  * @internal
  *
  * # Label Workflow Props
  *
- * - These are the base props that will be passed into the `<PurchaseLabelWorkflow />` component.
+ * - These are the base props that will be passed into the `<LabelWorkflow />` component.
  *
- * @see {@link PurchaseLabelWorkflow.Element | The `<PurchaseLabelWorkflow.Element />` component}
+ * @see {@link LabelWorkflow.Element | The `<LabelWorkflow.Element />` component}
  */
-export type PurchaseLabelWorkflowProps = {
+export type LabelWorkflowProps = {
     /**
      * `callbacks` is an optional set of callbacks that will be invoked at various points in the
      * label purchasing workflow.
@@ -27,11 +27,7 @@ export type PurchaseLabelWorkflowProps = {
     /**
      * `features` is a set of feature flags you would like to enable or disable in this component.
      */
-    features: PurchaseLabel.PurchaseLabelCommonProps["features"] & ViewShipment.ComponentProps["features"] & VoidLabel.ComponentProps["features"];
-    /**
-     * `labelId` is the unique identifier for the label you wish to view.
-     */
-    labelId?: string;
+    features: PurchaseLabelFeatures & ShipmentSummaryFeatures;
     /**
      * `multiplexedId` is the unique pattern of props that help index which Element is being displayed.
      */
@@ -64,7 +60,7 @@ export type PurchaseLabelWorkflowProps = {
  *     setLabelId,
  *     setShipmentId,
  *     setIsVoidingLabel,
- *   } = usePurchaseLabelWorkflow({
+ *   } = useLabelWorkflow({
  *     _labelId,
  *     _multiplexedId,
  *   });
@@ -72,9 +68,9 @@ export type PurchaseLabelWorkflowProps = {
  *
  * <br />
  *
- * @see {@link PurchaseLabelWorkflow.Element | The `<PurchaseLabelWorkflow.Element />` component using this hook}
+ * @see {@link LabelWorkflow.Element | The `<LabelWorkflow.Element />` component using this hook}
  */
-export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
+export declare const useLabelWorkflow: ({ _multiplexedId, }: {
     _callbacks?: {
         /**
          * `onLabelCreateSuccess` is an optional callback function that will be invoked when a label
@@ -84,7 +80,6 @@ export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
             labelId: string;
         }, shipment: Shipment) => void) | undefined;
     } | undefined;
-    _labelId?: string | undefined;
     _multiplexedId: ({
         orderSourceCode: string;
     } & ({
@@ -115,20 +110,7 @@ export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
         oneOff: true;
     };
     setIsVoidingLabel: import("react").Dispatch<import("react").SetStateAction<boolean>>;
-    setLabelId: (nextLabelId: PurchaseLabelWorkflowProps["labelId"]) => void;
-    setMultiplexedId: import("react").Dispatch<import("react").SetStateAction<({
-        orderSourceCode: string;
-    } & ({
-        externalOrderNumber: string;
-    } | {
-        externalOrderId: string;
-    })) | {
-        salesOrderId: string;
-    } | {
-        shipmentId: string;
-    } | {
-        oneOff: true;
-    }>>;
+    setLabelId: (nextLabelId?: string) => void;
     setShipmentId: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     shipmentId: string | undefined;
 };
@@ -137,17 +119,17 @@ export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
  *
  * # Label Workflow Element
  *
- * - The `<PurchaseLabelWorkflow.Element />` component is a composition of the PurchaseLabel, ViewShipment,
+ * - The `<LabelWorkflow.Element />` component is a composition of the PurchaseLabel, ShipmentSummary,
  * and VoidLabel elements that allows users to purchase a label, view the shipment details, and optionally void their shipping label.
  *
- * @param PurchaseLabelWorkflowProps The props necessary to render the `<PurchaseLabelWorkflow.Element />` for shipment
+ * @param LabelWorkflowProps The props necessary to render the `<LabelWorkflow.Element />` for shipment
  * based or sales order based label purchasing.
  *
- * @returns Element A React Element that will render the `<PurchaseLabelWorkflow />` component.
+ * @returns Element A React Element that will render the `<LabelWorkflow />` component.
  *
  * @example
  * ```tsx
- * <PurchaseLabelWorkflow
+ * <LabelWorkflow
  *       {...elementProps}
  *       callbacks={{ onLabelCreateSuccess }}
  *       multiplexedId={elementIdProps}
@@ -156,7 +138,7 @@ export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
  *
  * <br />
  *
- * @see {@link PurchaseLabelWorkflowProps | The props that are passed into the `<PurchaseLabelWorkflow />` component}
- * @see {@link PurchaseLabelWorkflow.usePurchaseLabelWorkflow | The `hook` that is used to manage the state of the `<PurchaseLabelWorkflow />` component}
+ * @see {@link LabelWorkflowProps | The props that are passed into the `<LabelWorkflow />` component}
+ * @see {@link LabelWorkflow.useLabelWorkflow | The `hook` that is used to manage the state of the `<LabelWorkflow />` component}
  */
-export declare const Element: ({ multiplexedId: _multiplexedId, labelId: _labelId, features: propFeatures, callbacks, }: PurchaseLabelWorkflowProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ multiplexedId: _multiplexedId, features: propFeatures, callbacks }: LabelWorkflowProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/carrier-recovery-form/carrier-recovery-form.d.ts

@@ -1,13 +1,12 @@
-import { SE } from "@shipengine/alchemy";
-import { CarrierMetadata } from "../../../../types";
+import { SE } from "@shipengine/react-api";
+import { CarrierMetadataFromFundingSource } from "../../../../types";
 import { CarrierRecoveryFormPayload } from "./carrier-recovery-form-schema";
 export type CarrierRecoveryFormProps = {
     address?: SE.Address;
-    carrierFriendlyName: string;
-    carrierMetadata: CarrierMetadata;
+    carrierMetadata: CarrierMetadataFromFundingSource;
     errors?: SE.CodedError[] | null;
     fundingSourceId: string;
     onSkip?: () => void;
     onSubmit: (fundingSourceId: string, payload: CarrierRecoveryFormPayload) => Promise<void>;
 };
-export declare const CarrierRecoveryForm: ({ address, carrierFriendlyName, carrierMetadata, errors, fundingSourceId, onSkip, onSubmit, }: CarrierRecoveryFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const CarrierRecoveryForm: ({ address, carrierMetadata, errors, fundingSourceId, onSkip, onSubmit, }: CarrierRecoveryFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/funding-and-carrier-connection-step/funding-and-carrier-connection-step.d.ts

@@ -1,11 +1,9 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 import { WalletPayload } from "../../../../components/templates/wallet-form";
-import { VatSettingsFeatures } from "../../../../features";
 export type FundingAndCarrierConnectionStepProps = {
     address: SE.Address;
     createFundingSourceErrors: SE.CodedError[] | null;
-    features?: VatSettingsFeatures;
     onSubmit: (payload: WalletPayload) => Promise<void>;
     registerCarrierErrors: SE.CodedError[] | null;
 };
-export declare const FundingAndCarrierConnectionStep: ({ address, createFundingSourceErrors, onSubmit, registerCarrierErrors, features, }: FundingAndCarrierConnectionStepProps) => import("@emotion/react/jsx-runtime").JSX.Element | null;
+export declare const FundingAndCarrierConnectionStep: ({ address, createFundingSourceErrors, onSubmit, registerCarrierErrors, }: FundingAndCarrierConnectionStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/funding-and-carrier-connection-step/use-funding-and-carrier-connection-step.d.ts

@@ -1,13 +1,12 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 import { WalletPayload } from "../../../../components/templates/wallet-form";
-import { CarrierProfile } from "../../../../types";
 type UseFundingAndCarrierConnectionStepProps = {
     isUpsEnabled: boolean;
     onStepComplete: () => void;
 };
 export declare const useFundingAndCarrierConnectionStep: ({ isUpsEnabled, onStepComplete, }: UseFundingAndCarrierConnectionStepProps) => {
     createFundingAndCarrierConnectionSubmissionHandler: ({ carrierProfiles, defaultWarehouse, email, fundingSourceTerms, }: {
-        carrierProfiles: CarrierProfile[];
+        carrierProfiles: SE.MetadataCarrierProfile[];
         defaultWarehouse: SE.Warehouse;
         email: string;
         fundingSourceTerms: SE.MetadataRequiredTerm[];

package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts

@@ -1,5 +1,4 @@
-import { SE } from "@shipengine/alchemy";
-import { ShipEngineCarriersFeatures, VatSettingsFeatures } from "../../../../features";
+import { SE } from "@shipengine/react-api";
 import { ShipFromAddressStepProps } from "../ship-from-address-step";
 export type ValidateWarehouse = {
     type: "warehouse";
@@ -13,15 +12,9 @@ export type ValidateBilling = {
     type: "billing";
 };
 export type ValidateAddress = ValidateWarehouse | ValidateBilling;
-export type OnboardingWizardFeatures = ShipEngineCarriersFeatures & {
-    presentation: {
-        poweredByShipEngine?: boolean;
-    };
-} & VatSettingsFeatures;
 export type OnboardingWizardProps = {
     defaultShipFromAddress?: ShipFromAddressStepProps["defaultShipFromAddress"];
-    features?: Partial<OnboardingWizardFeatures>;
     onComplete: () => void;
     partnerName?: string;
 };
-export declare const OnboardingWizard: ({ defaultShipFromAddress, features: customizedFeatures, onComplete: onWizardComplete, partnerName, }: OnboardingWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const OnboardingWizard: ({ defaultShipFromAddress, onComplete: onWizardComplete, partnerName, }: OnboardingWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/ship-from-address-step/ship-from-address-step.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 import { WarehousePayload } from "../../../../components";
 export type ShipFromAddressStepProps = {
     defaultShipFromAddress?: Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;

package/src/workflows/onboarding/components/ship-from-address-step/use-ship-from-address-step.d.ts

@@ -3,7 +3,7 @@ export type UseShipFromAddressStepProps = {
     onStepComplete: () => void;
 };
 export declare const useShipFromAddressStep: ({ onStepComplete }: UseShipFromAddressStepProps) => {
-    defaultWarehouse: import("@shipengine/alchemy").Warehouse | undefined;
+    defaultWarehouse: import("@shipengine/react-api").Warehouse | undefined;
     handleSubmitShipFromAddress: (payload: WarehousePayload) => Promise<void>;
     isLoadingWarehouses: boolean;
 };

package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/js-api";
 export type TermsAgreementFormProps = {
     carrierTerms: SE.MetadataRequiredTerm[];
     hideTerms: boolean;

package/src/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/js-api";
 export type TermsAgreementStepProps = {
     carrierCodes: string[];
     carrierTerms: SE.MetadataRequiredTerm[];

package/src/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.d.ts

@@ -1,16 +1,11 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 export type UseTermsAgreementStepProps = {
     enabledCarriers: string[];
     onStepComplete: () => void;
 };
 export declare const useTermsAgreementStep: ({ enabledCarriers, onStepComplete, }: UseTermsAgreementStepProps) => {
     carrierCodes: string[] | undefined;
-    carrierProfiles: {
-        capabilities: SE.MetadataCapability[] | null;
-        carrierCode: string;
-        registrationRequirements: SE.MetadataRegistrationRequirement[];
-        requiredTerms: SE.MetadataRequiredTerm[];
-    }[] | undefined;
+    carrierProfiles: SE.MetadataCarrierProfile[] | undefined;
     carrierTerms: SE.MetadataRequiredTerm[] | undefined;
     fundingSourceMetadata: import("@tanstack/react-query").UseQueryResult<SE.MetadataResponse, SE.CodedError[]>;
     fundingSourceTerms: SE.MetadataRequiredTerm[] | undefined;