@shipengine/elements 1.8.0 → 2.0.0

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

@@ -0,0 +1,141 @@
+import { CountryCode } from "../../constants";
+export type EnabledExternalCarriers = ("apc" | "asendia" | "better_trucks" | "canpar" | "chronopost" | "couriers_please" | "courierpost" | "dpd" | "hermes_germany" | "intelliquick_delivery" | "lso" | "ontrac" | "seko" | "ups" | "yodel")[];
+export type EnabledShipEngineCarriers = ("aramex_au_walleted" | "canada_post_walleted" | "canpar_walleted" | "couriersplease_walleted" | "sendle_walleted" | "dhl_express_walleted" | "dhl_express_worldwide" | "dpd_germany_walleted" | "dpdwallet" | "globalpost" | "hermes" | "purolator_walleted" | "stamps_com" | "ups_walleted" | "ups" | "yodel_walleted")[];
+export type RateFormFeatures = {
+    /**
+     * Enables the `funding` section of the rate form.
+     */
+    enableFunding?: boolean;
+    /**
+     * Enables the `global post filtering` on all rates fetched in the rates form.
+     */
+    enableGlobalPostFiltering?: boolean;
+    /**
+     * Enables the Pick Up/Drop Off tabs UI in the Rate Form to separate rates with PUDO capability by type.
+     */
+    enablePudoUI?: boolean;
+    /**
+     * Enables the `label layout` section of the Purchase Label element.
+     */
+    labelLayout?: boolean;
+    /**
+     * Enables showing the `carrier nickname` when rates are fetched.
+     */
+    nicknameRate?: boolean;
+    /**
+     * Enables the `DHL terms acknowledgement` when rates are fetched.
+     */
+    requireDhlTermsAcknowledgement?: boolean;
+    /**
+     * Enables the `save rate` button in the rate form. This allows users to save a `rateId` for a shipment to be purchased later.
+     */
+    saveRate?: boolean;
+};
+export type ShipmentFormFeatures = {
+    /**
+     * Enables the `Add-Ons` section of the shipment form. This allows users to add additional services to their shipment such as
+     * delivery confirmation and insurance.
+     */
+    addOns?: boolean;
+    /**
+     * Enables the `browse rates` button in the shipment form. This allows users to browse rates for a shipment with
+     * varying shipment configurations. This is useful for rate shopping.
+     */
+    browseRates?: boolean;
+    /**
+     * Enables the `shipsurance insurance` feature, allowing users to select Shipsurance when insuring their shipment.
+     */
+    includeShipsuranceInsurance?: boolean;
+    /**
+     * Enables the `third party insurance` feature, allowing users to opt for third party insurance when insuring their shipment.
+     */
+    includeThirdPartyInsurance?: boolean;
+    /**
+     * Enables the `select service` feature, allowing users to select a service when rate shopping across multiple carrier providers.
+     */
+    selectService?: boolean;
+    /**
+     * Enables the `shipping presets` feature, allowing users to pass in a set of shipping presets they wish to use within the
+     * shipment form of the PurchaseLabel element.
+     */
+    shippingPresets?: boolean;
+};
+export type ShipmentSummaryFeatures = {
+    schedulePickup?: boolean;
+};
+export type PurchaseLabelFeatures = {
+    /**
+     * List of all supported `countries` available in ShipEngine Elements.
+     */
+    compatibleCountryCodes?: CountryCode[];
+    /**
+     * When enabled will modify the default behavior of creating a new shipment for a salesorder to throwing an error
+     */
+    enableErrorWhenShipmentCancelled?: boolean;
+    /**
+     * @internal
+     *
+     * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
+     */
+    partnerMessages?: {
+        incompleteLabelPurchaseRequirements?: string;
+    };
+    /**
+     * All scoped feature flags for the `rate form` section of the PurchaseLabel element.
+     */
+    rateForm?: RateFormFeatures;
+    /**
+     * All scoped feature flags for the `shipment form` section of the PurchaseLabel element.
+     */
+    shipmentForm?: ShipmentFormFeatures;
+};
+export type AccountSettingsFeatures = {
+    /**
+     * Whether or not to display the ShipEngine Carriers section on the Account Settings element.
+     */
+    showCarrierServices?: boolean;
+    /**
+     * Whether or not to display the External Carriers section on the Account Settings element.
+     */
+    showExternalCarriers?: boolean;
+    /**
+     * Whether or not to display the Shipping Label Layout section on the Account Settings element.
+     */
+    showLabelLayout?: boolean;
+    /**
+     * Whether or not to display the Ship From Locations section on the Account Settings element.
+     */
+    showManageWarehouses?: boolean;
+    /**
+     * Whether or not to display the Units of Measure section on the Account Settings element.
+     */
+    showUnitSettings?: boolean;
+    /**
+     * Whether or not to display the Taxes section on the Account Settings element.
+     */
+    showVatSettings?: boolean;
+};
+export type GlobalFeatures = {
+    /**
+     * Availible "Bring your own carrier" carrier codes for carriers that may be added. If this is omitted, new carriers may not be added by this element.
+     */
+    enabledExternalCarriers?: EnabledExternalCarriers;
+    /**
+     * list of all walleted carriers that are enabled for use in Elements.
+     */
+    enabledShipEngineCarriers?: EnabledShipEngineCarriers;
+    /**
+     * Enables the `Powered by ShipEngine` logo in the footer various elements.
+     */
+    poweredByShipEngine?: boolean;
+    /**
+     * Enable the VAT settings to be shown
+     */
+    showVatSettings?: boolean;
+};
+export type ElementsFeatureFlags = {
+    accountSettingsFeatures?: AccountSettingsFeatures;
+    globalFeatures?: GlobalFeatures;
+    purchaseLabelFeatures?: PurchaseLabelFeatures;
+    shipmentSummaryFeatures?: ShipmentSummaryFeatures;
+};

package/src/utilities/money.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *

package/src/utilities/rates.d.ts

@@ -1,4 +1,4 @@
-import { Rate, SE } from "@shipengine/alchemy";
+import { Rate, SE } from "@shipengine/react-api";
 /**
  * @internal
  *

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

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *

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

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *
@@ -23,3 +23,11 @@ export declare const isUpsCarrier: (carrierCode: string) => boolean;
  * @category Utilities
  */
 export declare const getCarrierIdByCarrierCode: (carriers: SE.Carrier[] | undefined, carrierCode: string) => string | undefined;
+/**
+ * @internal
+ *
+ * # Carrier Utilities - getLogoOrIconByCarrierCode
+ *
+ * @category Utilities
+ */
+export declare const getLogoOrIconByCarrierCode: (carrierCode: string, type: "logo" | "icon") => string;

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

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *

package/src/utilities/shipengine/sales-order.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *

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

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *

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

@@ -1,2 +1,2 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 export declare const getDefaultWarehouse: (warehouses: SE.Warehouse[]) => SE.Warehouse;

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

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *

package/src/workflows/account-settings/account-settings.d.ts

@@ -1,17 +1,8 @@
 /// <reference types="react" />
-import { ShipEngineCarriersFeatures, VatSettingsFeatures } from "../../features";
-import { ConnectCarrier } from "../connect-carrier";
-export type AccountSettingsFeatures = ShipEngineCarriersFeatures & ConnectCarrier.ConnectCarrierFeatures & VatSettingsFeatures;
-/**
- * # Account Settings Component Props
- *
- * - These are the base props that will be passed into the `<AccountSettings />` component.
- *
- * @see {@link AccountSettings.Component | This prop types usage in the `<AccountSettings /> component`}
- */
+import { AccountSettingsFeatures } from "../../utilities";
 export type ComponentProps = {
     /**
-     * Feature flags controlling operation of various sub components.
+     * `features` is a set of feature flags you would like to enable or disable in this component.
      */
     features?: AccountSettingsFeatures;
 };
@@ -35,7 +26,7 @@ export declare const Component: ({ features }: ComponentProps) => import("@emoti
  * <br />
  *
  * @see {@link AccountSettings.ComponentProps | The **props** that can be passed into the `<AccountSettings.Element />` component}
- * @see {@link ManageWalletWorkflow.Element | The `<Manage-Wallet-Workflow />` component used to view connected carriers and manage funding}
+ * @see {@link CarrierServices.Element | The `<CarrierServices />` component used to view connected carriers and manage funding}
  * @see {@link ManageWarehouses.Component | The `<ManageWarehouses />` component used to add, update, or remove warehouses}
  * @see {@link PaymentMethodSettings | The `<PaymentMethodSettings />` component used to manage payment methods}
  * @see {@link ManageFunding | The `<ManageFunding />` component used to manage funding rules and add funds to a carrier account}
@@ -96,6 +87,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     schedulePickup: string;
                     showItems: string;
                     void: string;
+                    download: string;
                 };
                 fields: {
                     dimensions: string;
@@ -115,6 +107,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
+                    shipmentSummary: string;
                 };
                 noLabels: string;
             };
@@ -136,7 +129,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     genericText: string;
                 };
             };
-            "shipengine-carriers": {
+            "manage-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -204,8 +197,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;
@@ -228,7 +261,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     addPackageDetails: string;
                 };
                 errorMessages: {
-                    customsItemsRequired: string;
+                    customsItemsRequired: string; /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                     invalidAddress: string;
                     noRates: string;
                     salesOrderNotLoaded: string;
@@ -318,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: {
@@ -822,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/{manage-wallet-workflow/manage-wallet-workflow.d.ts → carrier-services/carrier-services.d.ts}

@@ -1,22 +1,10 @@
 /// <reference types="react" />
-import { ShipEngineCarriersFeatures } from "../../features/shipengine-carriers";
-/**
- * # Manage-Wallet-Workflow Props
- *
- * @see {@link ManageWalletWorkflow.Element | The `<Manage-Wallet-Workflow />` component}
- */
-export type ComponentProps = {
-    /**
-     * `features` is a set of feature flags you would like to enable or disable in this component.
-     */
-    features?: ShipEngineCarriersFeatures;
-};
 /**
  * # Manage-Wallet-Workflow Component
  *
- * @param ComponentProps The base props that will be passed into the `<Manage-Wallet-Workflow />` component.
+ * @param ComponentProps The base props that will be passed into the `<CarrierServices />` component.
  *
- * @returns Element A React element that renders the `<Manage-Wallet-Workflow />` component allowing users
+ * @returns Element A React element that renders the `<CarrierServices />` component allowing users
  * to view a list of carriers that are connected to their ShipEngine account, add funds to their wallet, view transaction history, and manage their payment method. This component is
  * composed in the `<AccountSettings />` Element.
  *
@@ -25,17 +13,17 @@ export type ComponentProps = {
  * (() => {
  *   const features = useFeatures("Global");
  *
- *   return <ManageWalletWorkflow.Element features={features} />;
+ *   return <CarrierServices.Element features={features} />;
  * })();
  * ```
  *
  * <br />
  *
- * @see {@link ManageWalletWorkflow.ComponentProps | The props that are passed into the `<Manage-Wallet-Workflow />` component}
+ * @see {@link CarrierServices.ComponentProps | The props that are passed into the `<Manage-Wallet-Workflow />` component}
  * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<Manage-Wallet-Workflow />` component}
  */
-export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
-export declare const Element: ({ resources, ...props }: ComponentProps & {
+export declare const Component: () => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ resources, ...props }: object & {
     resources?: {
         en: {
             "wallet-history": {
@@ -91,6 +79,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     schedulePickup: string;
                     showItems: string;
                     void: string;
+                    download: string;
                 };
                 fields: {
                     dimensions: string;
@@ -110,6 +99,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
+                    shipmentSummary: string;
                 };
                 noLabels: string;
             };
@@ -131,7 +121,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     genericText: string;
                 };
             };
-            "shipengine-carriers": {
+            "manage-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -156,6 +146,29 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     billing: {
                         title: string;
+                        /**
+                         * # Manage-Wallet-Workflow Component
+                         *
+                         * @param ComponentProps The base props that will be passed into the `<CarrierServices />` component.
+                         *
+                         * @returns Element A React element that renders the `<CarrierServices />` component allowing users
+                         * to view a list of carriers that are connected to their ShipEngine account, add funds to their wallet, view transaction history, and manage their payment method. This component is
+                         * composed in the `<AccountSettings />` Element.
+                         *
+                         * @example
+                         * ```tsx
+                         * (() => {
+                         *   const features = useFeatures("Global");
+                         *
+                         *   return <CarrierServices.Element features={features} />;
+                         * })();
+                         * ```
+                         *
+                         * <br />
+                         *
+                         * @see {@link CarrierServices.ComponentProps | The props that are passed into the `<Manage-Wallet-Workflow />` component}
+                         * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<Manage-Wallet-Workflow />` component}
+                         */
                         cardSubTitle: string;
                         addressSubTitle: string;
                         info: string;
@@ -199,8 +212,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;
@@ -313,7 +366,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: {
@@ -340,9 +396,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     messageLine2: string;
                 };
                 stepLabel: {
-                    /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
                     accountRegistration: string;
                     termsAgreement: string;
                     shipFromAddress: string;
@@ -820,6 +873,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;

package/src/workflows/carrier-services/index.d.ts

@@ -0,0 +1 @@
+export * as CarrierServices from "./carrier-services";