@shipengine/elements 1.7.0 → 1.8.0

package/src/elements/wallet-history/wallet-history-element.d.ts

@@ -36,6 +36,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 resultMessages: {
                     approved: string;
                     rejected: string;
+                    dpdwallet: string;
                 };
                 refund_process: string;
                 refund_rules: string;
@@ -77,6 +78,38 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 noLabels: string;
             };
+            "vat-settings": {
+                addNew: string;
+                vatNumber: string;
+                vatRegistrationTooltip: string;
+                vatFormText: string;
+                vatFormRegisterLater: string;
+                vatNumberInputHint: string;
+                vatNumberInputPlaceholder: string;
+                verifiedVat: string;
+                vatFormErrors: {
+                    invalidFieldValue: string;
+                    verificationFailure: string;
+                    forbidden: string;
+                    connectionNotSupported: string;
+                    genericTitle: string;
+                    genericText: string;
+                };
+            };
+            "shipengine-carriers": {
+                title: string;
+                headers: {
+                    accountCarriers: string;
+                    carriers: string;
+                    settings: string;
+                };
+                actions: {
+                    status: {
+                        connected: string;
+                        notConnected: string;
+                    };
+                };
+            };
             "register-wallet": {
                 sections: {
                     setup: {
@@ -92,6 +125,9 @@ export declare const Element: ({ resources, ...props }: object & {
                         addressSubTitle: string;
                         info: string;
                     };
+                    vatSettings: {
+                        title: string;
+                    };
                     carriers: {
                         title: string;
                         subtitle: string;
@@ -218,6 +254,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     rateSavings: string;
                     upsGroundSaverTermsAcknowledgement: string;
                     dhlExpressTermsAcknowledgement: string;
+                    noRateService: string;
                 };
                 requirements: {
                     noWarehouse: string;
@@ -284,6 +321,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     action: string;
                 };
                 termsAndAgreementLinkText: {
+                    shipEngineToS: string;
+                    auctanePrivacyPolicy: string;
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -308,42 +347,6 @@ export declare const Element: ({ resources, ...props }: object & {
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
             };
-            "manage-defaults": {
-                label: {
-                    title: string;
-                    letter: {
-                        title: string;
-                        description: string;
-                    };
-                    purchase: {
-                        title: string;
-                        description: string;
-                    };
-                    thermal: {
-                        title: string;
-                        description: string;
-                    };
-                };
-                status: {
-                    saving: string;
-                    saved: string;
-                    savingFailed: string;
-                };
-                units: {
-                    title: string;
-                    dimensions: {
-                        title: string;
-                        standard: string;
-                        metric: string;
-                    };
-                    weight: {
-                        title: string;
-                        standard: string;
-                        g: string;
-                        kg: string;
-                    };
-                };
-            };
             "manage-warehouses": {
                 title: string;
                 addNew: string;
@@ -411,6 +414,42 @@ export declare const Element: ({ resources, ...props }: object & {
                 currentBalance: string;
                 maximumBalanceAmount: string;
             };
+            "manage-defaults": {
+                label: {
+                    title: string;
+                    letter: {
+                        title: string;
+                        description: string;
+                    };
+                    purchase: {
+                        title: string;
+                        description: string;
+                    };
+                    thermal: {
+                        title: string;
+                        description: string;
+                    };
+                };
+                status: {
+                    saving: string;
+                    saved: string;
+                    savingFailed: string;
+                };
+                units: {
+                    title: string;
+                    dimensions: {
+                        title: string;
+                        standard: string;
+                        metric: string;
+                    };
+                    weight: {
+                        title: string;
+                        standard: string;
+                        g: string;
+                        kg: string;
+                    };
+                };
+            };
             "list-shipments": {
                 title: string;
                 headers: {
@@ -441,18 +480,31 @@ export declare const Element: ({ resources, ...props }: object & {
                     };
                 };
             };
-            "shipengine-carriers": {
-                title: string;
-                headers: {
-                    accountCarriers: string;
-                    carriers: string;
-                    settings: string;
-                };
+            "connect-carrier": {
                 actions: {
-                    status: {
-                        connected: string;
-                        notConnected: string;
-                    };
+                    cancel: string;
+                    carrierSettings: string;
+                    connectCarriers: string;
+                    disconnect: string;
+                    disconnectCarrier: string;
+                };
+                noCarriersDescription: string;
+                registrationForm: {
+                    error: string;
+                    title: string;
+                    betaWarning: string;
+                };
+                search: string;
+                settingsModal: {
+                    closeDialog: string;
+                    header: string;
+                };
+                status: {
+                    connected: string;
+                };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
                 };
             };
             common: {
@@ -639,6 +691,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     accountSettings: string;
                     carrier: string;
                     carriers: string;
+                    carrierServices: string;
                     connectCarrierForm: string;
                     connectingCarriers: string;
                     creatingFundingSource: string;
@@ -741,33 +794,6 @@ export declare const Element: ({ resources, ...props }: object & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
-            "connect-carrier": {
-                actions: {
-                    cancel: string;
-                    carrierSettings: string;
-                    connectCarriers: string;
-                    disconnect: string;
-                    disconnectCarrier: string;
-                };
-                noCarriersDescription: string;
-                registrationForm: {
-                    error: string;
-                    title: string;
-                    betaWarning: string;
-                };
-                search: string;
-                settingsModal: {
-                    closeDialog: string;
-                    header: string;
-                };
-                status: {
-                    connected: string;
-                };
-                disconnectDropdown: {
-                    toastTitle: string;
-                    toastBody: string;
-                };
-            };
             "account-settings": {
                 messages: {
                     noFundingSources: string;
@@ -783,6 +809,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
+                    vatSettings: string;
                 };
             };
         };

package/src/features/index.d.ts

@@ -1,8 +1,9 @@
-export * from "./wallet-history";
+export * from "./external-carriers";
 export * from "./label-layout";
 export * from "./manage-funding";
-export * from "./unit-settings";
-export * from "./payment-method-settings";
 export * from "./manage-warehouses";
+export * from "./payment-method-settings";
 export * from "./shipengine-carriers";
-export * from "./external-carriers";
+export * from "./unit-settings";
+export * from "./vat-settings";
+export * from "./wallet-history";

package/src/features/unit-settings/unit-settings.d.ts

@@ -1,9 +1,9 @@
 import { SE } from "@shipengine/alchemy";
 export type UnitSettingsProps = {
     accountSettings?: SE.AccountSettings;
-    getAccountSettingsErrors?: SE.CodedError[] | null;
+    getVatSettingsErrors?: SE.CodedError[] | null;
     isLoading: boolean;
     refreshAccountSettings: () => void;
     updateAccountSettings: (payload: Partial<SE.AccountSettings>) => void;
 };
-export declare const UnitSettings: ({ accountSettings, getAccountSettingsErrors: errors, isLoading, refreshAccountSettings, updateAccountSettings, }: UnitSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const UnitSettings: ({ accountSettings, getVatSettingsErrors: errors, isLoading, refreshAccountSettings, updateAccountSettings, }: UnitSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/unit-settings/use-unit-settings.d.ts

@@ -1,7 +1,7 @@
 import { SE } from "@shipengine/alchemy";
 export declare const useUnitSettings: () => {
     accountSettings: SE.AccountSettings | undefined;
-    getAccountSettingsErrors: SE.CodedError[] | null;
+    getVatSettingsErrors: SE.CodedError[] | null;
     isLoading: boolean;
     isUpdatingUnitSettings: boolean;
     refreshAccountSettings: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<SE.AccountSettings, SE.CodedError[]>>;

package/src/features/vat-settings/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./vat-settings";
+export * from "./use-vat-settings";

package/src/features/vat-settings/use-vat-settings.d.ts

@@ -0,0 +1,8 @@
+export declare const useVatSettings: () => {
+    getVatSettingsErrors: import("@shipengine/alchemy").CodedError[] | null;
+    isLoading: boolean;
+    refreshVatSettings: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/alchemy").AccountSettings, import("@shipengine/alchemy").CodedError[]>>;
+    updateVatSettings: import("@tanstack/react-query").UseMutateAsyncFunction<import("@shipengine/alchemy").AccountSettings, import("@shipengine/alchemy").CodedError[], Partial<import("@shipengine/alchemy").AccountSettings>, unknown>;
+    updateVatSettingsErrors: import("@shipengine/alchemy").CodedError[] | null;
+    vatSettings: import("@shipengine/alchemy").AccountSettings | undefined;
+};

package/src/features/vat-settings/vat-settings.d.ts

@@ -0,0 +1,9 @@
+export type VatSettingsFeatures = {
+    vatSettings: {
+        showVatSettings?: boolean;
+    };
+};
+export type VatSettingsProps = {
+    showRegisterLaterText?: boolean;
+};
+export declare const VatSettings: ({ showRegisterLaterText }: VatSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/vat-settings/vat-settings.styles.d.ts

@@ -0,0 +1,29 @@
+export declare const styles: {
+    addVatSection: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "flex";
+        justifyContent: "space-between";
+        paddingBottom: number;
+    };
+    buttonIcon: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        marginLeft: number;
+    };
+    infoIcon: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        color: string;
+    };
+    registrationText: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "flex";
+        gap: number;
+        minHeight: number;
+        width: string;
+    };
+    tooltipContainer: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        maxWidth: string;
+    };
+    vatText: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "flex";
+        gap: number;
+    };
+};

package/src/hooks/index.d.ts

@@ -1,9 +1,9 @@
 export * from "./options";
+export * from "./use-address-validation";
+export * from "./use-black-box-detection";
 export * from "./use-nested-form";
 export * from "./use-page-layout";
 export * from "./use-root-portal";
 export * from "./use-run-once-on-true";
-export * from "./use-toggle";
-export * from "./use-address-validation";
-export * from "./use-black-box-detection";
 export * from "./use-scrub-errors";
+export * from "./use-toggle";

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

@@ -32,6 +32,7 @@ declare const _default: {
         resultMessages: {
             approved: string;
             rejected: string;
+            dpdwallet: string;
         };
         refund_process: string;
         refund_rules: string;
@@ -73,6 +74,38 @@ declare const _default: {
         };
         noLabels: string;
     };
+    "vat-settings": {
+        addNew: string;
+        vatNumber: string;
+        vatRegistrationTooltip: string;
+        vatFormText: string;
+        vatFormRegisterLater: string;
+        vatNumberInputHint: string;
+        vatNumberInputPlaceholder: string;
+        verifiedVat: string;
+        vatFormErrors: {
+            invalidFieldValue: string;
+            verificationFailure: string;
+            forbidden: string;
+            connectionNotSupported: string;
+            genericTitle: string;
+            genericText: string;
+        };
+    };
+    "shipengine-carriers": {
+        title: string;
+        headers: {
+            accountCarriers: string;
+            carriers: string;
+            settings: string;
+        };
+        actions: {
+            status: {
+                connected: string;
+                notConnected: string;
+            };
+        };
+    };
     "register-wallet": {
         sections: {
             setup: {
@@ -88,6 +121,9 @@ declare const _default: {
                 addressSubTitle: string;
                 info: string;
             };
+            vatSettings: {
+                title: string;
+            };
             carriers: {
                 title: string;
                 subtitle: string;
@@ -214,6 +250,7 @@ declare const _default: {
             rateSavings: string;
             upsGroundSaverTermsAcknowledgement: string;
             dhlExpressTermsAcknowledgement: string;
+            noRateService: string;
         };
         requirements: {
             noWarehouse: string;
@@ -280,6 +317,8 @@ declare const _default: {
             action: string;
         };
         termsAndAgreementLinkText: {
+            shipEngineToS: string;
+            auctanePrivacyPolicy: string;
             aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
             "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
             "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
@@ -304,42 +343,6 @@ declare const _default: {
             UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
         };
     };
-    "manage-defaults": {
-        label: {
-            title: string;
-            letter: {
-                title: string;
-                description: string;
-            };
-            purchase: {
-                title: string;
-                description: string;
-            };
-            thermal: {
-                title: string;
-                description: string;
-            };
-        };
-        status: {
-            saving: string;
-            saved: string;
-            savingFailed: string;
-        };
-        units: {
-            title: string;
-            dimensions: {
-                title: string;
-                standard: string;
-                metric: string;
-            };
-            weight: {
-                title: string;
-                standard: string;
-                g: string;
-                kg: string;
-            };
-        };
-    };
     "manage-warehouses": {
         title: string;
         addNew: string;
@@ -407,6 +410,42 @@ declare const _default: {
         currentBalance: string;
         maximumBalanceAmount: string;
     };
+    "manage-defaults": {
+        label: {
+            title: string;
+            letter: {
+                title: string;
+                description: string;
+            };
+            purchase: {
+                title: string;
+                description: string;
+            };
+            thermal: {
+                title: string;
+                description: string;
+            };
+        };
+        status: {
+            saving: string;
+            saved: string;
+            savingFailed: string;
+        };
+        units: {
+            title: string;
+            dimensions: {
+                title: string;
+                standard: string;
+                metric: string;
+            };
+            weight: {
+                title: string;
+                standard: string;
+                g: string;
+                kg: string;
+            };
+        };
+    };
     "list-shipments": {
         title: string;
         headers: {
@@ -437,18 +476,31 @@ declare const _default: {
             };
         };
     };
-    "shipengine-carriers": {
-        title: string;
-        headers: {
-            accountCarriers: string;
-            carriers: string;
-            settings: string;
-        };
+    "connect-carrier": {
         actions: {
-            status: {
-                connected: string;
-                notConnected: string;
-            };
+            cancel: string;
+            carrierSettings: string;
+            connectCarriers: string;
+            disconnect: string;
+            disconnectCarrier: string;
+        };
+        noCarriersDescription: string;
+        registrationForm: {
+            error: string;
+            title: string;
+            betaWarning: string;
+        };
+        search: string;
+        settingsModal: {
+            closeDialog: string;
+            header: string;
+        };
+        status: {
+            connected: string;
+        };
+        disconnectDropdown: {
+            toastTitle: string;
+            toastBody: string;
         };
     };
     common: {
@@ -635,6 +687,7 @@ declare const _default: {
             accountSettings: string;
             carrier: string;
             carriers: string;
+            carrierServices: string;
             connectCarrierForm: string;
             connectingCarriers: string;
             creatingFundingSource: string;
@@ -737,33 +790,6 @@ declare const _default: {
         "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
         "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
     };
-    "connect-carrier": {
-        actions: {
-            cancel: string;
-            carrierSettings: string;
-            connectCarriers: string;
-            disconnect: string;
-            disconnectCarrier: string;
-        };
-        noCarriersDescription: string;
-        registrationForm: {
-            error: string;
-            title: string;
-            betaWarning: string;
-        };
-        search: string;
-        settingsModal: {
-            closeDialog: string;
-            header: string;
-        };
-        status: {
-            connected: string;
-        };
-        disconnectDropdown: {
-            toastTitle: string;
-            toastBody: string;
-        };
-    };
     "account-settings": {
         messages: {
             noFundingSources: string;
@@ -779,6 +805,7 @@ declare const _default: {
             externalCarriers: string;
             labelLayout: string;
             unitSettings: string;
+            vatSettings: string;
         };
     };
 };

package/src/types/patch.d.ts

@@ -1,13 +1,2 @@
-import { MetadataRequiredTerm, MetadataResponse } from "@shipengine/alchemy";
-interface TermsLink {
-    link: string;
-    locale: string;
-    title: string;
-}
-export interface MetadataTermsLinks {
-    links: TermsLink[];
-}
-export interface MetadataRequiredTermWithLinks extends MetadataRequiredTerm, MetadataTermsLinks {
-}
+import { MetadataResponse } from "@shipengine/alchemy";
 export type CarrierProfile = MetadataResponse["defaultRegionProfile"]["carrierProfiles"][number];
-export {};

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

@@ -173,6 +173,16 @@ export declare const featureFlags: {
              */
             readonly poweredByShipEngine: false;
         };
+        /**
+         * All global `vatSettings` related feature flags.
+         */
+        readonly vatSettings: {
+            /**
+             * `showVatSettings` enables the `vatSettings feature` in AccountSettings/Onboarding/LabelPurchase
+             * This flag is meant to be used while development and removed once the feature is live
+             */
+            readonly showVatSettings: true;
+        };
     };
     /**
      * `ViewShipment` all scoped feature flags for the `<ViewShipment />` element.

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

@@ -5,3 +5,4 @@ export * from "./sales-order";
 export * from "./shipment";
 export * from "./weight";
 export * from "./package";
+export * from "./warehouses";

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

@@ -39,3 +39,14 @@ export declare const getCancelledShipment: (shipments?: SE.SalesOrderShipment[])
  * @returns latest created shipment whose shipmentStatus matches the param status
  */
 export declare const getShipmentByStatus: (status: SE.ShipmentStatus, shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
+/**
+ * @internal
+ *
+ * # Shipment Utilities - map customsItems to products and delete customsItems from the customs object
+ *
+ * @category Utilities
+ * @param shipment
+ * @returns the shipment with customsItems moved to products
+ * @see https://www.shipengine.com/docs/shipping/international/#the-customs-object:~:text=New%20products%20array%20replaces%20the%20customs_items%20array
+ */
+export declare const moveCustomsItemsToProducts: (shipment: SE.SalesOrderShipment) => SE.SalesOrderShipment;