@shipengine/elements 1.6.0 → 1.7.0

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

@@ -1 +1,9 @@
-export declare const UnitSettings: () => import("@emotion/react/jsx-runtime").JSX.Element;
+import { SE } from "@shipengine/alchemy";
+export type UnitSettingsProps = {
+    accountSettings?: SE.AccountSettings;
+    getAccountSettingsErrors?: 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;

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

@@ -0,0 +1,10 @@
+import { SE } from "@shipengine/alchemy";
+export declare const useUnitSettings: () => {
+    accountSettings: SE.AccountSettings | undefined;
+    getAccountSettingsErrors: 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[]>>;
+    updateAccountSettings: (newAccountSetting: Partial<SE.AccountSettings>) => Promise<void>;
+    updateUnitSettingsErrors: SE.CodedError[] | null;
+};

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

@@ -78,6 +78,7 @@ declare const _default: {
             setup: {
                 title: string;
                 subtitle: string;
+                hiddenTermsSubtitle: string;
                 descriptionTitle: string;
                 description: string;
             };
@@ -207,6 +208,7 @@ declare const _default: {
             needToAcknowledge: string;
         };
         rates: {
+            requestedShippingNotification: string;
             uspsMediaMailAcknowledgement: string;
             uspsFirstClassMailAcknowledgement_leof: string;
             rateSavings: string;
@@ -289,6 +291,8 @@ declare const _default: {
             aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
             "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
             aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
+            aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
+            aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
         };
         termsAndAgreementTitles: {
             "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -296,6 +300,8 @@ declare const _default: {
             "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
             RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
             "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
+            "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
+            UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
         };
     };
     "manage-defaults": {
@@ -431,7 +437,7 @@ declare const _default: {
             };
         };
     };
-    "list-carriers": {
+    "shipengine-carriers": {
         title: string;
         headers: {
             accountCarriers: string;

package/src/types/carrier-metadata.d.ts

@@ -21,6 +21,9 @@ export type CarrierTerms = {
     links: CarrierTerm[];
     title: string;
 };
+export type CarrierMetadataMapping = {
+    [countryCode: string]: CarrierMetadata[];
+};
 /**
  * @internal
  *

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

@@ -82,7 +82,7 @@ export declare const featureFlags: {
             /**
              * `enableFunding` enables the `funding` section of the rate form.
              */
-            readonly enableFunding: false;
+            readonly enableFunding: true;
             /**
              * `enableGlobalPostFiltering` enables the `global post filtering` on all rates fetched
              * in the rates form.
@@ -161,7 +161,7 @@ export declare const featureFlags: {
              * `enabledCarriers` is a list of all `carriers` that are enabled for use in ShipEngine
              * Elements.
              */
-            readonly enabledCarriers: readonly ["stamps_com", "ups_walleted", "dhl_express_walleted", "ups", "hermes", "yodel_walleted", "dpdwallet", "globalpost"];
+            readonly enabledCarriers: readonly ["aramex_au_walleted", "canada_post_walleted", "canpar_walleted", "couriersplease_walleted", "dhl_express_walleted", "dpd_germany_walleted", "dpdwallet", "globalpost", "hermes", "purolator_walleted", "sendle_walleted", "stamps_com", "ups_walleted", "ups", "yodel_walleted"];
         };
         /**
          * All global `presentation` related feature flags.
@@ -217,3 +217,6 @@ export declare const getFeatures: (...element: string[]) => any;
  * @see {@link featureFlags | All available `Feature Flags`}
  */
 export declare const useFeatures: (...element: string[]) => any;
+export type FeatureObject = Record<string, unknown>;
+export declare const isObject: (item: unknown) => item is FeatureObject;
+export declare function deepMergeFeatures<T extends FeatureObject>(defaults: T, custom?: T): T;

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
-import { ListCarriersFeatures } from "../../features";
+import { ShipEngineCarriersFeatures } from "../../features";
 import { ConnectCarrier } from "../connect-carrier";
-export type AccountSettingsFeatures = ListCarriersFeatures & ConnectCarrier.ConnectCarrierFeatures;
+export type AccountSettingsFeatures = ShipEngineCarriersFeatures & ConnectCarrier.ConnectCarrierFeatures;
 /**
  * # Account Settings Component Props
  *
@@ -14,13 +14,8 @@ export type ComponentProps = {
      * Feature flags controlling operation of various sub components.
      */
     features?: AccountSettingsFeatures;
-    /**
-     * This callback function will be used to house the logic you wish to execute when the
-     * user saves new changes to their account settings.
-     */
-    onSaveSettings: () => void;
 };
-export declare const Component: ({ onSaveSettings, features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Account Settings Element
  *
@@ -40,7 +35,7 @@ export declare const Component: ({ onSaveSettings, features }: ComponentProps) =
  * <br />
  *
  * @see {@link AccountSettings.ComponentProps | The **props** that can be passed into the `<AccountSettings.Element />` component}
- * @see {@link ListCarriers.Component | The `<List-Carriers />` component used to view connected carriers}
+ * @see {@link ManageWalletWorkflow.Element | The `<Manage-Wallet-Workflow />` 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}
@@ -127,6 +122,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
+                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -199,7 +195,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     customsItemsRequired: string;
                     invalidAddress: string;
                     noRates: string;
-                    salesOrderNotLoaded: string;
+                    salesOrderNotLoaded: string; /**
+                     * Feature flags controlling operation of various sub components.
+                     */
                     unsupportedAddress: string;
                     saveRateFailedMessage: string;
                     saveRateFailedTitle: string;
@@ -256,6 +254,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     needToAcknowledge: string;
                 };
                 rates: {
+                    requestedShippingNotification: string;
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
                     rateSavings: string;
@@ -338,6 +337,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
                     aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -345,6 +346,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
                     "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
+                    "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
+                    UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
             };
             "manage-defaults": {
@@ -480,7 +483,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                 };
             };
-            "list-carriers": {
+            "shipengine-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;

package/src/workflows/account-settings/use-get-panel-props.d.ts

@@ -1,4 +1,10 @@
 import { CollapsiblePanelProps } from "../../components";
+import { UnitSettingsProps } from "../../features";
+import { LabelLayoutSettingsProps } from "../../features/label-layout/label-layout";
+import { ManageWarehousesProps } from "../../features/manage-warehouses/";
+type SettingProps = LabelLayoutSettingsProps | UnitSettingsProps | ManageWarehousesProps;
+export type SettingPropsIntersection = LabelLayoutSettingsProps & UnitSettingsProps & ManageWarehousesProps;
 export declare const useGetPanelProps: () => {
-    getSettingPanelProps: (setting: string) => CollapsiblePanelProps;
+    getSettingPanelProps: (setting: string) => [panelProps?: CollapsiblePanelProps, settingProps?: SettingProps];
 };
+export {};

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

@@ -119,6 +119,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
+                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -248,6 +249,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     needToAcknowledge: string;
                 };
                 rates: {
+                    requestedShippingNotification: string;
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
                     rateSavings: string;
@@ -330,6 +332,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
                     aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
@@ -337,6 +341,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
                     "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
+                    "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
+                    UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
             };
             "manage-defaults": {
@@ -472,7 +478,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                 };
             };
-            "list-carriers": {
+            "shipengine-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;

package/src/workflows/manage-wallet-workflow/index.d.ts

@@ -0,0 +1 @@
+export * as ManageWalletWorkflow from "./manage-wallet-workflow";