@shipengine/elements 0.39.0 → 1.1.0

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

@@ -290,7 +290,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             onboarding: {
                 title: string;
                 inlineTitle: string;
-                landing: {
+                accountRegistration: {
                     action: string;
                     title: string;
                     subtitle: string;
@@ -299,33 +299,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     partnerMessageLine1: string;
                     messageLine2: string;
                 };
-                steps: {
-                    register: string;
-                    carriers: string;
-                    /**
-                     * # Account Settings Component
-                     *
-                     * - The `<AccountSettings />` component is used to display the user's account settings, as well as
-                     * allowing them to make changes to various aspects of their account.
-                     *
-                     * @returns Element An EmotionJSX.Element that will render the `<AccountSettings />` 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 AccountSettings.Element | The **Element** created to render `<AccountSettings />`}
-                     */
-                    addresses: string;
-                    billing: string;
+                stepLabel: {
+                    accountRegistration: string;
+                    termsAgreement: string;
+                    shipFromAddress: string;
+                    fundingAndCarrierConnection: string;
                 };
                 warehouse: {
                     title: string;
@@ -337,6 +315,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     action: string;
                 };
+                termsAndAgreementLinkText: {
+                    aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
+                    aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
+                    "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
+                    "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
+                    aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+                };
+                termsAndAgreementTitles: {
+                    "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
+                    "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
+                    "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+                };
             };
             "manage-defaults": {
                 label: {
@@ -461,17 +455,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     cancel: string;
                     close: string;
                     confirm: string;
+                    connect: string;
                     continue: string;
                     delete: string;
                     edit: string;
                     hide: string;
-                    /**
-                     * # 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`}
-                     */
                     parse: string;
                     purchase: string;
                     remove: string;
@@ -484,6 +472,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     fields: {
                         name: string;
                         company: string;
+                        county: string;
                         countryCode: string;
                         addressLine1: string;
                         addressLine2: string;
@@ -598,6 +587,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
+                        fundingSourceMetadata: string;
                         label: string;
                         salesOrder: string;
                         shipment: string;
@@ -605,7 +595,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
-                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -620,6 +609,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     validation: string;
                 };
+                grid: {
+                    "row-count_one": string;
+                    "row-count_other": string;
+                    rows: string;
+                };
                 insuranceProviders: {
                     carrier: string;
                     none: string;
@@ -631,6 +625,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     carrier: string;
                     carriers: string;
                     connectingCarriers: string;
+                    creatingFundingSource: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;
@@ -692,6 +687,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     platform: string;
                     user: string;
                 };
+                terms: {
+                    fields: {
+                        agreement: string;
+                    };
+                    agreeToTerms: string;
+                    carriersTitle: string;
+                    fundingSourceTitle: string;
+                };
                 weight: {
                     ounces: string;
                     pounds_one: string;
@@ -707,6 +710,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -718,6 +722,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
+            "connect-carrier": {
+                registrationForm: {
+                    title: string;
+                    isLoading: string;
+                    betaWarning: string;
+                };
+            };
             "account-settings": {
                 title: string;
                 sections: {

package/src/elements/configure-shipment/hooks/use-rates-form.d.ts

@@ -24,11 +24,10 @@ export type UseRatesFormProps = {
 export declare const useRatesForm: ({ getPreferredRates, onBeforeRateSaved, onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, shipment, }: UseRatesFormProps) => {
     carriers: SE.Carrier[] | undefined;
     displayableRateErrors: string[] | undefined;
-    displayableSaveRateErrors: string[] | undefined;
     errors: SE.CodedError[] | undefined;
     isLoading: boolean;
     labelErrors: string[] | undefined;
-    labels: SE.Label[] | undefined;
+    labels: SE.Label[];
     labelsLoading: boolean;
     onSave: ({ carrierId, serviceCode }: Pick<SE.Rate, "carrierId" | "serviceCode">) => Promise<void>;
     onSubmit: (rateId: string) => Promise<void>;

package/src/elements/{onboarding/onboarding.d.ts → connect-carrier/connect-carrier.d.ts}

@@ -1,90 +1,6 @@
 /// <reference types="react" />
-import { OnboardingProps } from "../../components/templates/onboarding";
-/**
- * # Onboarding Component Props
- *
- * - These are the base props that will be passed into the `<Onboarding />` component.
- *
- * @see {@link Onboarding.Component | This prop types usage in the `<Onboarding />` component}
- */
-export type ComponentProps = {
-    /**
-     * `features` is a set of feature flags you would like to enable or disable in this component.
-     */
-    features?: OnboardingProps["features"];
-    /**
-     * `onboardingAddress` is the address that will be used to create the warehouse for the user
-     * during the onboarding process.
-     */
-    onboardingAddress?: OnboardingProps["onboardingAddress"];
-    /**
-     * `onCompleteOnboarding` is a callback function that will be invoked once the onboarding process
-     * is completed.
-     */
-    onCompleteOnboarding: () => void;
-    /**
-     * `partnerName` is the name of the partner that is using the Onboarding component. This is typically
-     * the name of the entity that owns the host application.
-     */
-    partnerName?: OnboardingProps["partnerName"];
-};
-/**
- * # Onboarding Component
- *
- * - The `<Onboarding />` component is used to onboard a new user to the ShipEngine platform. This
- * component will allow the user to create a warehouse, register a carrier, and create a funding
- * source for their account. This is everything a user needs to begin fulfilling their shipments
- * using the ShipEngine Platform.
- *
- * @param ComponentProps The base props that will be passed into the `<Onboarding />` component.
- *
- * @returns Element An EmotionJSX.Element that will render the `<Onboarding />` 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",
- *     overflow: "auto",
- *     scrollbarGutter: "stable both-edges",
- *     width: "100%",
- *   },
- *   resources: { en },
- * });
- * ```
- *
- * <br />
- *
- * @see {@link Onboarding.Element | The **Element** created to render `<Onboarding />`}
- */
-export declare const Component: ({ features, onboardingAddress, onCompleteOnboarding, partnerName, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
-/**
- * # 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}
- */
-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": {
@@ -148,10 +64,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     deliveryConfirmation: string;
                 };
                 highVolumeForms: string;
-                multipleShippingServices: string; /**
-                 * `onCompleteOnboarding` is a callback function that will be invoked once the onboarding process
-                 * is completed.
-                 */
+                multipleShippingServices: string;
                 sections: {
                     labels: string;
                 };
@@ -317,7 +230,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             onboarding: {
                 title: string;
                 inlineTitle: string;
-                landing: {
+                accountRegistration: {
                     action: string;
                     title: string;
                     subtitle: string;
@@ -326,11 +239,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     partnerMessageLine1: string;
                     messageLine2: string;
                 };
-                steps: {
-                    register: string;
-                    carriers: string;
-                    addresses: string;
-                    billing: string;
+                stepLabel: {
+                    accountRegistration: string;
+                    termsAgreement: string;
+                    shipFromAddress: string;
+                    fundingAndCarrierConnection: string;
                 };
                 warehouse: {
                     title: string;
@@ -342,6 +255,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     action: string;
                 };
+                termsAndAgreementLinkText: {
+                    aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
+                    "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9jb25kaXRpb25zLw==": string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS91cy9lbi9zdXBwb3J0L3NoaXBwaW5nLXN1cHBvcnQvc2hpcHBpbmctc3BlY2lhbC1jYXJlLXJlZ3VsYXRlZC1pdGVtcy9wcm9oaWJpdGVkLWl0ZW1zLnBhZ2U=": string;
+                    aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VQU19EQVBfVEMucGRm: string;
+                    "aHR0cHM6Ly93d3cudXBzLmNvbS9hc3NldHMvcmVzb3VyY2VzL21lZGlhL2VuX1VTL1VUQS5wZGY=": string;
+                    "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
+                    "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
+                    aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+                };
+                termsAndAgreementTitles: {
+                    "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
+                    "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
+                    "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+                };
             };
             "manage-defaults": {
                 label: {
@@ -369,9 +298,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     dimensions: {
                         title: string;
                         standard: string;
-                        metric: string; /**
-                         * `features` is a set of feature flags you would like to enable or disable in this component.
-                         */
+                        metric: string;
                     };
                     weight: {
                         title: string;
@@ -422,10 +349,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     error: {
                         title: string;
                         message: string;
-                    }; /**
-                     * `onCompleteOnboarding` is a callback function that will be invoked once the onboarding process
-                     * is completed.
-                     */
+                    };
                     isLoading: string;
                     labels: {
                         amount: string;
@@ -468,6 +392,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     cancel: string;
                     close: string;
                     confirm: string;
+                    connect: string;
                     continue: string;
                     delete: string;
                     edit: string;
@@ -484,15 +409,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     fields: {
                         name: string;
                         company: string;
+                        county: string;
                         countryCode: string;
                         addressLine1: string;
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
                         postalCode: string;
-                        phone: string; /**
-                         * `features` is a set of feature flags you would like to enable or disable in this component.
-                         */
+                        phone: string;
                         email: string;
                         addressResidentialIndicator: string;
                     };
@@ -600,6 +524,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
+                        fundingSourceMetadata: string;
                         label: string;
                         salesOrder: string;
                         shipment: string;
@@ -607,7 +532,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
-                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -622,6 +546,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     validation: string;
                 };
+                grid: {
+                    "row-count_one": string;
+                    "row-count_other": string;
+                    rows: string;
+                };
                 insuranceProviders: {
                     carrier: string;
                     none: string;
@@ -633,6 +562,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     carrier: string;
                     carriers: string;
                     connectingCarriers: string;
+                    creatingFundingSource: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;
@@ -694,6 +624,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     platform: string;
                     user: string;
                 };
+                terms: {
+                    fields: {
+                        agreement: string;
+                    };
+                    agreeToTerms: string;
+                    carriersTitle: string;
+                    fundingSourceTitle: string;
+                };
                 weight: {
                     ounces: string;
                     pounds_one: string;
@@ -709,6 +647,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
@@ -720,6 +659,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
+            "connect-carrier": {
+                registrationForm: {
+                    title: string;
+                    isLoading: string;
+                    betaWarning: string;
+                };
+            };
             "account-settings": {
                 title: string;
                 sections: {
@@ -736,9 +682,4 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
         };
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
-/**
- * # Onboarding Element Props
- *
- * @see {@link Onboarding.Element | See the full type that `typeof Element` will return}
- */
 export type ElementProps = React.ComponentProps<typeof Element>;

package/src/elements/connect-carrier/index.d.ts

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

package/src/elements/index.d.ts

@@ -1,7 +1,6 @@
 export * from "./account-settings";
 export * from "./list-carriers";
 export * from "./manage-warehouses";
-export * from "./onboarding";
 export * from "./purchase-label";
 export * from "./view-shipment";
 export * from "./void-label";

package/src/elements/labels-grid/index.d.ts

@@ -0,0 +1 @@
+export * as LabelsGrid from "./labels-grid";