@shipengine/elements 0.39.0 → 1.0.0

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

@@ -0,0 +1,24 @@
+export declare const styles: {
+    closeButton: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        marginRight: number;
+    };
+    container: {
+        alignItems: "center";
+        display: "flex";
+        flexDirection: "column";
+        justifyContent: "center";
+    };
+    expanderLink: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "inline-flex";
+        fontWeight: number;
+    };
+    termsWell: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        backgroundColor: string;
+        marginBottom: number;
+        padding: string;
+    };
+    termTypeDivider: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        margin: string;
+    };
+};

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

@@ -0,0 +1 @@
+export * from "./terms-agreement-step";

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

@@ -0,0 +1,8 @@
+import { MetadataRequiredTermWithLinks } from "../../../../types";
+export type TermsAgreementStepProps = {
+    carrierCodes: string[];
+    carrierTerms: MetadataRequiredTermWithLinks[];
+    fundingSourceTerms: MetadataRequiredTermWithLinks[];
+    onSubmit: (agreement: boolean) => void;
+};
+export declare const TermsAgreementStep: ({ carrierCodes, carrierTerms, fundingSourceTerms, onSubmit, }: TermsAgreementStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,17 @@
+export declare const styles: {
+    carrierLogos: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        display: "flex";
+        flexDirection: "row";
+        gap: number;
+        justifyContent: "center";
+        padding: string;
+    };
+    container: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "flex";
+        flexDirection: "column";
+        paddingBottom: number;
+        paddingTop: number;
+        textAlign: "center";
+    };
+};

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

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

package/src/{elements → workflows}/onboarding/onboarding.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { OnboardingProps } from "../../components/templates/onboarding";
+import { OnboardingWizardProps } from "./components/onboarding-wizard";
 /**
  * # Onboarding Component Props
  *
@@ -8,25 +8,14 @@ import { OnboardingProps } from "../../components/templates/onboarding";
  * @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"];
+    /** If provided, the address form will be pre-filled */
+    defaultShipFromAddress?: OnboardingWizardProps["defaultShipFromAddress"];
+    /** Flags to selectively enable / disable features. */
+    features?: OnboardingWizardProps["features"];
+    /** Invoked when the onboarding process is completed. */
+    onComplete: () => void;
+    /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
+    partnerName?: OnboardingWizardProps["partnerName"];
 };
 /**
  * # Onboarding Component
@@ -61,7 +50,7 @@ export type ComponentProps = {
  *
  * @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;
+export declare const Component: ({ defaultShipFromAddress, features, onComplete, partnerName, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Onboarding Element
  *
@@ -145,13 +134,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     warehouse: string;
                     weight: string;
                     insuredValue: string;
-                    deliveryConfirmation: string;
+                    deliveryConfirmation: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
                 };
                 highVolumeForms: string;
-                multipleShippingServices: string; /**
-                 * `onCompleteOnboarding` is a callback function that will be invoked once the onboarding process
-                 * is completed.
-                 */
+                multipleShippingServices: string;
                 sections: {
                     labels: string;
                 };
@@ -169,6 +155,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
+                        /** If provided, the address form will be pre-filled */
                         info: string;
                     };
                     carriers: {
@@ -177,7 +164,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     notifications: {
                         error: {
-                            title: string;
+                            title: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
                         };
                         info: {
                             title: string;
@@ -317,20 +304,20 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             onboarding: {
                 title: string;
                 inlineTitle: string;
-                landing: {
+                accountRegistration: {
                     action: string;
                     title: string;
                     subtitle: string;
                     welcome: string;
                     messageLine1: string;
                     partnerMessageLine1: string;
-                    messageLine2: string;
+                    messageLine2: string; /** Flags to selectively enable / disable features. */
                 };
-                steps: {
-                    register: string;
-                    carriers: string;
-                    addresses: string;
-                    billing: string;
+                stepLabel: {
+                    accountRegistration: string;
+                    termsAgreement: string;
+                    shipFromAddress: string;
+                    fundingAndCarrierConnection: string;
                 };
                 warehouse: {
                     title: string;
@@ -342,6 +329,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: {
@@ -368,13 +371,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     title: string;
                     dimensions: {
                         title: string;
-                        standard: string;
-                        metric: string; /**
-                         * `features` is a set of feature flags you would like to enable or disable in this component.
-                         */
+                        standard: string; /** Invoked when the onboarding process is completed. */
+                        metric: string;
                     };
                     weight: {
-                        title: string;
+                        title: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
                         standard: string;
                         g: string;
                         kg: string;
@@ -422,10 +423,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;
@@ -484,16 +482,15 @@ 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.
-                         */
-                        email: string;
+                        phone: string;
+                        email: string; /** The partner responsible for the currently onboarding seller. This is typically the name of the entity that owns the host application. */
                         addressResidentialIndicator: string;
                     };
                     noResults: string;
@@ -600,6 +597,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
+                        fundingSourceMetadata: string;
                         label: string;
                         salesOrder: string;
                         shipment: string;
@@ -607,7 +605,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
-                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -633,6 +630,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     carrier: string;
                     carriers: string;
                     connectingCarriers: string;
+                    creatingFundingSource: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;
@@ -694,6 +692,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 +715,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;