@shipengine/elements 0.39.0 → 1.0.0

package/src/elements/void-label/void-label.d.ts

@@ -327,7 +327,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             onboarding: {
                 title: string;
                 inlineTitle: string;
-                landing: {
+                accountRegistration: {
                     action: string;
                     title: string;
                     subtitle: string;
@@ -336,15 +336,18 @@ 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;
-                    subtitle: string;
+                    subtitle: string; /**
+                     * `onComplete` is a callback function that will be invoked when the request to void a given
+                     * shipping label is completed.
+                     */
                     inlineMessage: string;
                 };
                 success: {
@@ -352,6 +355,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: {
@@ -489,11 +508,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     fields: {
                         name: string;
                         company: string;
+                        county: string;
                         countryCode: string;
                         addressLine1: string;
-                        addressLine2: string; /**
-                         * `features` is a set of feature flags you would like to enable or disable in this component.
-                         */
+                        addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
                         postalCode: string;
@@ -515,6 +533,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         modified: string;
                         title: string;
                         originalAddress: string;
+                        /**
+                         * `onViewShipment` is a callback function that will be invoked when the user clicks the
+                         * `View Shipment` button. This will take you back to the
+                         * {@link ViewShipment.Element | `View Shipment Element`} for the given shipment, where you
+                         * will be able to see the voided label listed.
+                         */
                         matchedAddress: string;
                         unableToValidate: string;
                         use: {
@@ -527,31 +551,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         validated: string;
                     };
                 };
-                /**
-                 * # Void Label Component
-                 *
-                 * - The `<VoidLabel />` component is used to void a given shipping label. When a label is voided,
-                 * you then get the option to view the associated shipment via the `View Shipment` Element, or
-                 * you can purchase another label for the shipment via the `Purchase Label` Element.
-                 *
-                 * @param ComponentProps The base props that will be passed into the `<VoidLabel />` component.
-                 *
-                 * @returns Element An EmotionJSX.Element that will render the `<VoidLabel />` 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 VoidLabel.Element | The **Element** created to render `<VoidLabel />`}
-                 */
                 billing: {
                     fields: {
                         differentBillingAddress: string;
@@ -630,6 +629,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
+                        fundingSourceMetadata: string;
                         label: string;
                         salesOrder: string;
                         shipment: string;
@@ -637,7 +637,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
-                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -663,6 +662,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     carrier: string;
                     carriers: string;
                     connectingCarriers: string;
+                    creatingFundingSource: string;
                     data: string;
                     importingSalesOrder: string;
                     label: string;
@@ -724,6 +724,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;
@@ -739,6 +747,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;

package/src/index.d.ts

@@ -6,3 +6,4 @@ export * from "./hooks";
 export * from "./schemas";
 export * from "./types";
 export * from "./utilities";
+export * from "./workflows";

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

@@ -226,7 +226,7 @@ declare const _default: {
     onboarding: {
         title: string;
         inlineTitle: string;
-        landing: {
+        accountRegistration: {
             action: string;
             title: string;
             subtitle: string;
@@ -235,11 +235,11 @@ declare const _default: {
             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;
@@ -251,6 +251,22 @@ declare const _default: {
             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: {
@@ -388,6 +404,7 @@ declare const _default: {
             fields: {
                 name: string;
                 company: string;
+                county: string;
                 countryCode: string;
                 addressLine1: string;
                 addressLine2: string;
@@ -502,6 +519,7 @@ declare const _default: {
                 autoFundingSettings: string;
                 carrier: string;
                 carriers: string;
+                fundingSourceMetadata: string;
                 label: string;
                 salesOrder: string;
                 shipment: string;
@@ -509,7 +527,6 @@ declare const _default: {
             };
             unknown: string;
             noRatesAvailable: string;
-            saveRateError: string;
         };
         errorTypes: {
             accountStatus: string;
@@ -535,6 +552,7 @@ declare const _default: {
             carrier: string;
             carriers: string;
             connectingCarriers: string;
+            creatingFundingSource: string;
             data: string;
             importingSalesOrder: string;
             label: string;
@@ -596,6 +614,14 @@ declare const _default: {
             platform: string;
             user: string;
         };
+        terms: {
+            fields: {
+                agreement: string;
+            };
+            agreeToTerms: string;
+            carriersTitle: string;
+            fundingSourceTitle: string;
+        };
         weight: {
             ounces: string;
             pounds_one: string;
@@ -611,6 +637,7 @@ declare const _default: {
             gram: string;
             kilogram: string;
         };
+        T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
         "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
         "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
         QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;

package/src/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./carrier-metadata";
+export * from "./patch";
 export * from "./shipping-preset";

package/src/types/patch.d.ts

@@ -0,0 +1,13 @@
+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 {
+}
+export type CarrierProfile = MetadataResponse["defaultRegionProfile"]["carrierProfiles"][number];
+export {};

package/src/utilities/assertions.d.ts

@@ -0,0 +1,2 @@
+export declare function assert(condition: any, errorMessage: string): asserts condition;
+export declare function raise(errorMessage: string): never;

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

@@ -146,7 +146,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", "dhl_express_walleted"];
+            readonly enabledCarriers: readonly ["stamps_com", "ups_walleted", "dhl_express_walleted", "ups", "hermes", "yodel_walleted"];
         };
         /**
          * All global `presentation` related feature flags.

package/src/utilities/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./assertions";
 export * from "./create-dictionary";
 export * from "./date";
 export * from "./error";

package/src/workflows/onboarding/components/account-registration-form/account-registration-form-schema.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+export declare const accountRegistrationFormSchema: z.ZodObject<{
+    email: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+}, {
+    email: string;
+}>;
+export type AccountRegistrationFormFields = z.input<typeof accountRegistrationFormSchema>;
+export type AccountRegistrationFormPayload = z.output<typeof accountRegistrationFormSchema>;

package/src/workflows/onboarding/components/account-registration-form/account-registration-form.d.ts

@@ -0,0 +1,4 @@
+export type AccountRegistrationFormProps = {
+    onSubmit: (payload: string) => void;
+};
+export declare const AccountRegistrationForm: ({ onSubmit }: AccountRegistrationFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/account-registration-form/index.d.ts

@@ -0,0 +1 @@
+export * from "./account-registration-form";

package/src/workflows/onboarding/components/account-registration-step/account-registration-step.d.ts

@@ -0,0 +1,5 @@
+export type AccountRegistrationStepProps = {
+    onSubmit: (payload: string) => void;
+    partnerName?: string;
+};
+export declare const AccountRegistrationStep: ({ onSubmit, partnerName, }: AccountRegistrationStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/account-registration-step/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./account-registration-step";
+export * from "./use-account-registration-step";

package/src/workflows/onboarding/components/account-registration-step/use-account-registration-step.d.ts

@@ -0,0 +1,7 @@
+export type UseAccountRegistrationStepProps = {
+    onStepComplete: () => void;
+};
+export declare const useAccountRegistrationStep: ({ onStepComplete }: UseAccountRegistrationStepProps) => {
+    email: string | undefined;
+    handleSubmitAccountRegistration: (email: string) => void;
+};