@shipengine/elements 1.8.0 → 2.0.0

package/src/components/templates/add-carrier-form/add-carrier-form-test.d.ts

@@ -1 +0,0 @@
-export {};

package/src/components/templates/add-carrier-form/add-carrier-form.d.ts

@@ -1,10 +0,0 @@
-import { CodedError } from "@shipengine/alchemy";
-import { CarrierTerms } from "../../../types";
-import { AddCarrierFormPayload } from "./add-carrier-form-schema";
-export type AddCarrierFormProps = {
-    carrierTerms?: CarrierTerms;
-    onCancel?: () => void;
-    onSubmit: (payload: AddCarrierFormPayload) => Promise<void>;
-    registerCarrierErrors?: CodedError[] | null;
-};
-export declare const AddCarrierForm: ({ carrierTerms, onCancel, onSubmit, registerCarrierErrors, }: AddCarrierFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/templates/add-carrier-form/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./add-carrier-form";
-export * from "./add-carrier-form-schema";

package/src/components/templates/connect-carrier-form/connect-carrier-form.d.ts

@@ -1,12 +0,0 @@
-import { RJSFSchema, UiSchema } from "@rjsf/utils";
-export type ConnectCarrierFormProps = {
-    carrierName: string;
-    displayName: string;
-    iconUrl: string;
-    isBeta?: boolean;
-    jsonSchema: RJSFSchema;
-    onCancel?: () => void;
-    onCarrierConnected?: (carrierId: string) => void;
-    uiSchema: UiSchema;
-};
-export declare const ConnectCarrierForm: ({ carrierName, displayName, iconUrl, isBeta, jsonSchema, uiSchema, onCancel, onCarrierConnected, }: ConnectCarrierFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/templates/connect-carrier-form/index.d.ts

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

package/src/components/templates/pudo-rate-tabs/service-points-search-bar/index.d.ts

@@ -1 +0,0 @@
-export * from "./service-points-search-bar";

package/src/components/templates/pudo-rate-tabs/service-points-search-bar/service-points-search-bar.d.ts

@@ -1,6 +0,0 @@
-type ServicePointsSearchBarProps = {
-    onSearch: (postalCode: string) => void | Promise<void>;
-    postalCode?: string;
-};
-export declare const ServicePointsSearchBar: ({ postalCode, onSearch }: ServicePointsSearchBarProps) => import("@emotion/react/jsx-runtime").JSX.Element;
-export {};

package/src/elements/external-carriers/index.d.ts

@@ -1 +0,0 @@
-export * as ExternalCarriers from "./external-carriers";

package/src/elements/shipengine-carriers/index.d.ts

@@ -1 +0,0 @@
-export * as ShipEngineCarriers from "./shipengine-carriers";

package/src/elements/view-shipment/index.d.ts

@@ -1 +0,0 @@
-export * as ViewShipment from "./view-shipment";

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

@@ -1 +0,0 @@
-export * as WalletHistory from "./wallet-history-element";

package/src/features/external-carriers/external-carriers.d.ts

@@ -1,10 +0,0 @@
-import { ConnectCarrier } from "../../workflows";
-export type ExternalCarriersFeatures = ConnectCarrier.ConnectCarrierFeatures;
-export type ExternalCarriersProps = {
-    /**
-     * `availableCarrierConnections` is a set of carrier codes for carriers that may be added. If this is omitted,
-     * new carriers may not be added by this element.
-     */
-    features?: ExternalCarriersFeatures;
-};
-export declare const ExternalCarriers: ({ features }: ExternalCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/external-carriers/index.d.ts

@@ -1 +0,0 @@
-export * from "./external-carriers";

package/src/features/shipengine-carriers/hooks/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./use-carrier-metadata";
-export * from "./use-list-connected-carriers";

package/src/features/shipengine-carriers/hooks/use-carrier-metadata.d.ts

@@ -1,13 +0,0 @@
-import { CarrierConnection } from "@shipengine/alchemy";
-export type CarrierMetadataHook = {
-    carrierCodes?: CarrierConnection["carrierCode"][];
-    countryCode?: string;
-};
-/**
- * @internal
- *
- * # Carrier Metadata Hook
- *
- * @category Hooks
- */
-export declare const useCarrierMetadata: ({ carrierCodes, countryCode }: CarrierMetadataHook) => import("../../../types").CarrierMetadata[];

package/src/features/shipengine-carriers/hooks/use-list-connected-carriers.d.ts

@@ -1,11 +0,0 @@
-import { CarrierMetadata } from "../../../types";
-export type ConnectedCarrierMetadata = {
-    carrier: CarrierMetadata;
-    isConnected: boolean;
-};
-export declare const useListConnectedCarriers: () => {
-    data: ConnectedCarrierMetadata[];
-    error: import("@shipengine/alchemy").CodedError[] | null;
-    isLoading: boolean;
-    refetch: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/alchemy").Carrier[], import("@shipengine/alchemy").CodedError[]>>;
-};

package/src/features/shipengine-carriers/index.d.ts

@@ -1 +0,0 @@
-export * from "./shipengine-carriers";

package/src/features/shipengine-carriers/shipengine-carriers-row/index.d.ts

@@ -1 +0,0 @@
-export * from "./shipengine-carriers-row";

package/src/features/shipengine-carriers/shipengine-carriers-row/shipengine-carriers-row.d.ts

@@ -1,9 +0,0 @@
-import { CodedError } from "@shipengine/alchemy";
-import { AddCarrierFormPayload } from "../../../components/templates/add-carrier-form";
-import { ConnectedCarrierMetadata } from "../hooks/use-list-connected-carriers";
-export type ShipEngineCarriersRowProps = {
-    connectedCarrier: ConnectedCarrierMetadata;
-    registerCarrier: (payload?: AddCarrierFormPayload) => Promise<void>;
-    registerCarrierErrors?: CodedError[] | null;
-};
-export declare const ShipEngineCarriersRow: ({ connectedCarrier: { carrier, isConnected }, registerCarrier, registerCarrierErrors, }: ShipEngineCarriersRowProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/shipengine-carriers/shipengine-carriers.d.ts

@@ -1,10 +0,0 @@
-export type ShipEngineCarriersFeatures = {
-    carriers: {
-        enabledCarriers: ("aramex_au_walleted" | "canada_post_walleted" | "canpar_walleted" | "couriersplease_walleted" | "sendle_walleted" | "dhl_express_walleted" | "dhl_express_worldwide" | "dpd_germany_walleted" | "dpdwallet" | "globalpost" | "hermes" | "purolator_walleted" | "stamps_com" | "ups_walleted" | "ups" | "yodel_walleted")[];
-    };
-};
-export type ShipEngineCarriersProps = {
-    features?: ShipEngineCarriersFeatures;
-    showFunds?: boolean;
-};
-export declare const ShipEngineCarriers: ({ features, showFunds, }: ShipEngineCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/wallet-history/index.d.ts

@@ -1 +0,0 @@
-export * from "./wallet-history";

package/src/features/wallet-history/wallet-history.d.ts

@@ -1,6 +0,0 @@
-/**
- * @namespace WalletHistory
- *
- * # Wallet History
- */
-export declare const WalletHistory: () => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/hooks/use-elements.d.ts

@@ -1,35 +0,0 @@
-/// <reference types="react" />
-import { ShipEngineProps } from "@shipengine/alchemy";
-export type ElementsEnvironment = `dde:${string}` | "development" | "staging" | "production";
-export type ElementsErrorHandler = (err: Error, context: {
-    componentStack: string;
-    element?: string;
-}) => void;
-export interface ElementsContextValue {
-    environment: ElementsEnvironment;
-    onError?: ElementsErrorHandler;
-}
-/**
- * @category Contexts
- */
-export declare const ElementsContext: import("react").Context<ElementsContextValue | undefined>;
-export interface ElementsProviderProps {
-    baseURL?: string;
-    children: JSX.Element;
-    environment?: ElementsEnvironment;
-    getToken: ShipEngineProps["getToken"];
-    onError?: ElementsErrorHandler;
-    proxyTarget?: string;
-}
-/**
- * @category Providers
- */
-export declare const ElementsProvider: ({ baseURL, children, environment, getToken, onError, }: ElementsProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
-/**
- * Must be used within {@link ElementsProvider}
- *
- * @category Elements Hooks
- *
- * @see {@link registerElement}
- */
-export declare const useElements: () => ElementsContextValue;

package/src/types/patch.d.ts

@@ -1,2 +0,0 @@
-import { MetadataResponse } from "@shipengine/alchemy";
-export type CarrierProfile = MetadataResponse["defaultRegionProfile"]["carrierProfiles"][number];

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

@@ -1,232 +0,0 @@
-/**
- * @namespace featureFlags
- *
- * - The `featureFlags` namespace contains all the feature flags available throughout the
- * application. All features are scoped by name to the component they are intended for.
- *
- * @example
- * ```tsx
- * export const featureFlags = {
- *   ConfigureSalesOrderShipment: {
- *     compatibleCountryCodes: ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"],
- *     rateForm: {
- *       enableFunding: false,
- *       enableGlobalPostFiltering: false,
- *       labelLayout: false,
- *       nicknameRate: true,
- *       saveRate: true,
- *     },
- *     shipmentForm: {
- *       browseRates: true,
- *       includeShipsuranceInsurance: true,
- *       includeThirdPartyInsurance: true,
- *       selectService: true,
- *       shippingPresets: false,
- *     },
- *   },
- *   Global: {
- *     carriers: {
- *       enabledCarriers: ["stamps_com", "ups", "dhl_express_walleted"],
- *     },
- *     presentation: {
- *       poweredByShipEngine: false,
- *     },
- *   },
- *   ViewShipment: {
- *     shipment: {
- *       schedulePickup: true,
- *     },
- *   },
- * } as const;
- * ```
- */
-export declare const featureFlags: {
-    /**
-     * `CarrierConnections` all scoped feature flags for "Bring your own carrier" connections.
-     */
-    readonly CarrierConnections: {
-        readonly availableCarrierConnections: readonly ["apc", "asendia", "better_trucks", "canpar", "chronopost", "couriers_please", "courierpost", "dpd", "hermes_germany", "intelliquick_delivery", "lso", "ontrac", "seko", "ups", "yodel"];
-    };
-    /**
-     * `ConfigureSalesOrderShipment` all scoped feature flags for the shipment configuration
-     * section of the `<PurchaseLabel />` element.
-     */
-    readonly ConfigureSalesOrderShipment: {
-        /**
-         * `compatibleCountryCodes` is a list of all supported `countries` available in ShipEngine
-         * Elements.
-         */
-        readonly compatibleCountryCodes: readonly ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"];
-        /**
-         * `configureShipment` is a group of flags related to the useConfigureShipment functionality
-         */
-        readonly configureShipment: {
-            /**
-             * `enableErrorWhenShipmentCancelled` when enabled will modify the default behavior of creating a new shipment for a salesorder to throwing an error
-             */
-            readonly enableErrorWhenShipmentCancelled: false;
-        };
-        /**
-         * @internal
-         *
-         * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
-         */
-        readonly partnerMessages: {
-            readonly incompleteLabelPurchaseRequirements: undefined;
-        };
-        /**
-         *  `rateForm` all scoped feature flags for the `rate form` section of the `<PurchaseLabel />`
-         *  element.
-         */
-        readonly rateForm: {
-            /**
-             * `enableFunding` enables the `funding` section of the rate form.
-             */
-            readonly enableFunding: true;
-            /**
-             * `enableGlobalPostFiltering` enables the `global post filtering` on all rates fetched
-             * in the rates form.
-             */
-            readonly enableGlobalPostFiltering: false;
-            /**
-            `enablePudoUI` enables the Pick Up/Drop Off tabs UI in the Rate Form to separate rates with PUDO capability by type.
-             */
-            readonly enablePudoUI: false;
-            /**
-             * `labelLayout` enables the `label layout` section of the `<PurchaseLabel /> element.
-             */
-            readonly labelLayout: false;
-            /**
-             * `nicknameRate` enables showing the `carrier nickname` when rates are fetched.
-             */
-            readonly nicknameRate: true;
-            /**
-             * `requireDhlTermsAcknowledgement` enables the `DHL terms acknowledgement` when rates are fetched.
-             */
-            readonly requireDhlTermsAcknowledgement: false;
-            /**
-             * `saveRate` enables the `save rate` button in the rate form. This allows users to save a
-             * `rateId` for a shipment to be purchased later.
-             */
-            readonly saveRate: true;
-        };
-        /**
-         * `shipmentForm` all scoped feature flags for the `shipment form` section of the
-         * `<PurchaseLabel />` element.
-         */
-        readonly shipmentForm: {
-            /**
-             * `addOns` enables the `Add-Ons` section of the shipment form. This allows users to
-             * add additional services to their shipment such as delivery confirmation and insurance.
-             */
-            readonly addOns: true;
-            /**
-             * `browseRates` enables the `browse rates` button in the shipment form. This allows users
-             * to browse rates for a shipment with varying shipment configurations. This is useful for
-             * rate shopping.
-             */
-            readonly browseRates: true;
-            /**
-             * `includeShipsuranceInsurance` enables the `shipsurance insurance` feature, allowing users
-             * to select Shipsurance when insuring their shipment.
-             */
-            readonly includeShipsuranceInsurance: true;
-            /**
-             * `includeThirdPartyInsurance` enables the `third party insurance` feature, allowing users
-             * to opt for third party insurance when insuring their shipment.
-             */
-            readonly includeThirdPartyInsurance: true;
-            /**
-             * `selectService` enables the `select service` feature, allowing users to select a service
-             * when rate shopping across multiple carrier providers.
-             */
-            readonly selectService: true;
-            /**
-             * `shippingPresets` enables the `shipping presets` feature, allowing users to pass in a set
-             * of shipping presets they wish to use within the shipment form of the `<PurchaseLabel />`
-             * element.
-             */
-            readonly shippingPresets: false;
-        };
-    };
-    /**
-     * `Global` all feature flags that are intended for use anywhere in ShipEngine Elements.
-     */
-    readonly Global: {
-        /**
-         * All global `carrier` related feature flags.
-         */
-        readonly carriers: {
-            /**
-             * `enabledCarriers` is a list of all `carriers` that are enabled for use in ShipEngine
-             * Elements.
-             */
-            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.
-         */
-        readonly presentation: {
-            /**
-             * `poweredByShipEngine` enables the `powered by ShipEngine` logo in the footer various
-             * elements.
-             */
-            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.
-     */
-    readonly ViewShipment: {
-        /**
-         * `shipment` all shipment related features available in the `<ViewShipment />` element.
-         */
-        readonly shipment: {
-            /**
-             * `schedulePickup` enables the `schedule pickup` button in the `<ViewShipment />` element,
-             * allowing users to schedule pick-ups for their shipments.
-             */
-            readonly schedulePickup: true;
-        };
-    };
-};
-/**
- * @internal
- *
- * # Feature Flags - featureFlagComponentNameLookup
- */
-export declare const featureFlagComponentNameLookup: (componentName: string) => string;
-/**
- * @internal
- *
- * # Feature Flags - getFeatures
- */
-export declare const getFeatures: (...element: string[]) => any;
-/**
- * # Feature Flags - useFeatures
- *
- * - The `useFeatures` hook is used to retrieve the feature flags for a given component.
- *
- * @example
- * ```tsx
- * const features = useFeatures("Global");
- * ```
- *
- * <br />
- *
- * @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/connect-carrier/index.d.ts

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

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

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

package/src/workflows/purchase-label-workflow/index.d.ts

@@ -1 +0,0 @@
-export * as PurchaseLabelWorkflow from "./purchase-label-workflow";