@shipengine/elements 2.22.0 → 2.24.1

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

@@ -1,206 +0,0 @@
-import { CountryCode } from "../../constants";
-export type EnabledExternalCarriers = ("apc" | "asendia" | "better_trucks" | "canpar" | "chronopost" | "couriers_please" | "courierpost" | "dpd" | "hermes_germany" | "intelliquick_delivery" | "lso" | "ontrac" | "seko" | "ups" | "yodel")[];
-export type EnabledShipEngineCarriers = ("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 RateFormFeatures = {
-    /**
-     * Enables the `funding` section of the rate form.
-     */
-    enableFunding?: boolean;
-    /**
-     * Enables the Pick Up/Drop Off tabs UI in the Rate Form to separate rates with PUDO capability by type.
-     */
-    enablePudoUI?: boolean;
-    /**
-     * Enables the `label layout` section of the Purchase Label element.
-     */
-    labelLayout?: boolean;
-    /**
-     * Enables showing the `carrier nickname` when rates are fetched.
-     */
-    nicknameRate?: boolean;
-    /**
-     * Enables the `DHL terms acknowledgement` when rates are fetched.
-     */
-    requireDhlTermsAcknowledgement?: boolean;
-    /**
-     * Enables the `save rate` button in the rate form. This allows users to save a `rateId` for a shipment to be purchased later.
-     */
-    saveRate?: boolean;
-};
-export type ShipmentFormFeatures = {
-    /**
-     * 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.
-     */
-    addOns?: boolean;
-    /**
-     * 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.
-     */
-    browseRates?: boolean;
-    /**
-     * Enables the `carrier insurance` feature, allowing users to select carrier insurance when insuring their shipment.
-     */
-    includeCarrierInsurance?: boolean;
-    /**
-     * Enables the `shipsurance insurance` feature, allowing users to select Shipsurance when insuring their shipment.
-     */
-    includeShipsuranceInsurance?: boolean;
-    /**
-     * Enables the `third party insurance` feature, allowing users to opt for third party insurance when insuring their shipment.
-     */
-    includeThirdPartyInsurance?: boolean;
-    /**
-     * Enables the `select service` feature, allowing users to select a service when rate shopping across multiple carrier providers.
-     */
-    selectService?: boolean;
-    /**
-     * 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.
-     */
-    shippingPresets?: boolean;
-    /**
-     * When disabled the Purchase Label element will not use the Seller's saved warehouses during Shipment creation or expose the warehouses in the ship from drop down.
-     */
-    useWarehouses?: boolean;
-};
-export type ShipmentSummaryFeatures = {
-    schedulePickup?: boolean;
-};
-export type PurchaseLabelFeatures = {
-    /**
-     * Feature still in beta. When enabled, the Windsor Framework will display forms, messaging, and error messages if a shipment requires specific Windsor Framework features.
-     */
-    betaEnableWindsorFramework?: boolean;
-    /**
-     * List of all supported `countries` available in ShipEngine Elements.
-     */
-    compatibleCountryCodes?: CountryCode[];
-    /**
-     * Rates for any service codes included here will not be available for purchase.
-     * The property should be of the form { "carrier_code": ["service_code1", "service_code2"] }
-     */
-    disabledShippingServices?: Record<string, string[]>;
-    /**
-     * When enabled will modify the default behavior of creating a new shipment for a salesorder to throwing an error
-     */
-    enableErrorWhenShipmentCancelled?: boolean;
-    /**
-     * @internal
-     *
-     * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
-     */
-    partnerMessages?: {
-        incompleteLabelPurchaseRequirements?: string;
-    };
-    /**
-     * All scoped feature flags for the `rate form` section of the PurchaseLabel element.
-     */
-    rateForm?: RateFormFeatures;
-    /**
-     * All scoped feature flags for the `shipment form` section of the PurchaseLabel element.
-     */
-    shipmentForm?: ShipmentFormFeatures;
-};
-export type AccountSettingsFeatures = {
-    /**
-     * Whether or not to display the Add Funds settings within the ShipEngine Carriers section.
-     */
-    enableFunding?: boolean;
-    /**
-     * Whether or not to display the ShipEngine Carriers section on the Account Settings element.
-     */
-    showCarrierServices?: boolean;
-    /**
-     * Whether or not to display the External Carriers section on the Account Settings element.
-     */
-    showExternalCarriers?: boolean;
-    /**
-     * Whether or not to display the Shipping Label Layout section on the Account Settings element.
-     */
-    showLabelLayout?: boolean;
-    /**
-     * Whether or not to display the Ship From Locations section on the Account Settings element.
-     */
-    showManageWarehouses?: boolean;
-    /**
-     * Whether or not to display the Units of Measure section on the Account Settings element.
-     */
-    showUnitSettings?: boolean;
-    /**
-     * Whether or not to display the Taxes section on the Account Settings element.
-     */
-    showVatSettings?: boolean;
-};
-export type LabelColumnName = "shipmentId" | "labelId" | "externalOrderId" | "externalShipmentId" | "shipmentNumber" | "packages" | "recipient" | "shippingService" | "createdDate" | "shipDate" | "status" | "trackingStatus";
-export type BaseLabelColumnConfig = {
-    /**
-     * The name identifying the column
-     */
-    name: Exclude<LabelColumnName, "shipmentId" | "labelId">;
-    nickname?: string;
-};
-export type FilterableLabelColumnConfig = {
-    /**
-     * Allow filtering by this column
-     */
-    allowFilter?: boolean;
-    /**
-     * The name identifying the column
-     */
-    name: Extract<LabelColumnName, "shipmentId" | "labelId" | "trackingStatus">;
-    nickname?: string;
-};
-export type LabelColumnConfig = BaseLabelColumnConfig | FilterableLabelColumnConfig;
-export type LabelsGridFeatures = {
-    /**
-     * Configure label grid columns
-     */
-    columns?: LabelColumnConfig[];
-    /**
-     * Configure label grid columns
-     */
-    showActions?: boolean;
-};
-export type GlobalFeatures = {
-    /**
-     * Disable default usage of  Shadow DOM for all elements
-     */
-    disableShadowDOM?: boolean;
-    /**
-     * Availible "Bring your own carrier" carrier codes for carriers that may be added. If this is omitted, new carriers may not be added by this element.
-     */
-    enabledExternalCarriers?: EnabledExternalCarriers;
-    /**
-     * list of all walleted carriers that are enabled for use in Elements.
-     */
-    enabledShipEngineCarriers?: EnabledShipEngineCarriers;
-    /**
-     * Enable parcel guard related features for the different parts of UI
-     */
-    enableParcelGuard?: boolean;
-    /**
-     * Use Elements in Sandbox mode. Requires a sandbox partner.
-     */
-    isSandbox?: boolean;
-    /**
-     * Enables the `Powered by ShipEngine` logo in the footer various elements.
-     */
-    poweredByShipEngine?: boolean;
-    /**
-     * Enable the VAT settings to be shown
-     */
-    showVatSettings?: boolean;
-    /**
-     * The support email that will be referenced in error messages.
-     * Defaults to platform@shipengine.com if not specified.
-     */
-    supportEmailAddress?: string;
-};
-export type ElementsFeatureFlags = {
-    accountSettingsFeatures?: AccountSettingsFeatures;
-    globalFeatures?: GlobalFeatures;
-    labelsGridFeatures?: LabelsGridFeatures;
-    purchaseLabelFeatures?: PurchaseLabelFeatures;
-    shipmentSummaryFeatures?: ShipmentSummaryFeatures;
-};

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

@@ -1,2 +0,0 @@
-import { CarrierService, Rate } from "@shipengine/react-api";
-export declare const isShippingServiceServiceDisabled: (service: CarrierService | Rate, disabledShippingServices?: Record<string, string[]>) => boolean;

package/types/src/utilities/form-logger.d.ts

@@ -1,20 +0,0 @@
-import { FieldValues, ResolverResult, UseFormHandleSubmit } from "react-hook-form";
-/**
- * @internal
- *
- * # Form Logger
- *
- * @description
- * This will log the values that are submitted to the validation resolver
- * (only REGISTERED form fields) and the results of that validation.
- *
- * @usage Wrap the submission:
- * `<form onSubmit={formLogger.capture(handleSubmit)}>`
- *
- * @category Utilities
- */
-export declare const formLogger: {
-    capture(handleSubmit: ReturnType<UseFormHandleSubmit<any>>): (e?: React.BaseSyntheticEvent) => void;
-    isSubmitting: boolean;
-    log: <U extends FieldValues>(getValidationResult: () => Promise<ResolverResult<U>>, sensitiveValues?: string[]) => Promise<ResolverResult<U>>;
-};

package/types/src/utilities/formatString.d.ts

@@ -1,12 +0,0 @@
-/**
- * @internal
- *
- * # Capitalize First Letter Utility Function
- *
- * - This is a utility function that `capitalizes` the first letter of a given string.
- */
-export declare const capitalizeFirstLetter: (str: string) => string;
-export declare const capitalizeFirstLetterOfEachWord: (str: string) => string;
-export declare const pascalize: (str: string) => string;
-export declare const replaceSpacesWithDashes: (str?: string) => string | undefined;
-export declare const addSpaceBetweenWords: (str: string) => string;

package/types/src/utilities/index.d.ts

@@ -1,3 +0,0 @@
-export { type ElementsFeatureFlags, getDefaultFeatures } from "./feature-flags";
-export { scopeTheme, createStyles } from "./styles";
-export { isOnboarded, getSellerIdFromToken, validateShipFromAddress } from "./checks";

package/types/src/utilities/money.d.ts

@@ -1,38 +0,0 @@
-import { SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Money Utils - currency Symbol
- */
-export declare const currencySymbol: Record<SE.Currency, string>;
-/**
- * @internal
- *
- * # Money Utils - formatMoney
- */
-export declare const formatMoney: (value: SE.Money, locale?: string) => string;
-/**
- * @internal
- *
- * # Money Utils - calculateTotal
- */
-export declare const calculateTotal: (...values: SE.Money[]) => number;
-/**
- * @internal
- *
- * # Money Utils - formatCreditCardNumber
- */
-export declare const formatCreditCardNumber: (cc: string) => string;
-/**
- * @internal
- *
- * # Money Utils - formatExpiration
- */
-export declare const formatExpiration: (exp: string) => string;
-/**
- * @internal
- *
- * # Money Utils - getCurrencyFromString
- */
-export declare const getCurrencyFromString: (currency?: string) => SE.Currency;
-export declare const getCurrencySymbolFromString: (currency?: string) => string | undefined;

package/types/src/utilities/predicates/index.d.ts

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

package/types/src/utilities/predicates/isString.d.ts

@@ -1,8 +0,0 @@
-/**
- * @internal
- *
- * # String Predicate Utilities
- *
- * @category Utilities
- */
-export declare const isString: (x: unknown) => x is string;

package/types/src/utilities/pudo.d.ts

@@ -1,3 +0,0 @@
-import { Rate } from "@shipengine/js-api";
-export declare const isPudoEligibleRate: (rate: Rate) => boolean;
-export declare const isCollectionService: (carrier: string, serviceCode: string) => boolean;

package/types/src/utilities/rate-details.d.ts

@@ -1,15 +0,0 @@
-import { SE } from "@shipengine/js-api";
-export type RateDetailItem = {
-    amount: number;
-    currency: SE.Currency;
-    rateDetailAttributes: SE.RateDetailAttributes | null;
-    rateDetailType: SE.RateDetailType;
-};
-export declare const aggregateRateDetailItems: (rateDetails: SE.RateDetail[]) => RateDetailItem[];
-export declare const calculateRateDetailBreakdown: (aggregatedRates: RateDetailItem[]) => {
-    hasTax: boolean;
-    items: RateDetailItem[];
-    subtotal: number;
-    tax: RateDetailItem[];
-    total: number;
-};

package/types/src/utilities/rates.d.ts

@@ -1,31 +0,0 @@
-import { SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Rates Utilities - getRateRequiresAcknowledgement
- *
- * @category Utilities
- */
-export declare const getRateRequiresAcknowledgement: (serviceCode: string, packageType: string, requireDhlTermsAcknowledgement: boolean) => boolean;
-/**
- * @internal
- *
- * # Rates Utilities - getTotalRateAmount
- *
- * @category Utilities
- */
-export declare const getTotalRateAmount: (rateCosts?: {
-    confirmationAmount?: SE.Money;
-    insuranceAmount?: SE.Money;
-    otherAmount?: SE.Money;
-    shippingAmount?: SE.Money;
-    taxAmount?: SE.Money;
-}) => number;
-/**
- * @internal
- *
- * # Rates Utilities - overrideCarrierCodes
- *
- * @category Utilities
- */
-export declare const overrideCarrierCodes: (carrier: string, overrides: object) => never;

package/types/src/utilities/shipengine/address.d.ts

@@ -1,98 +0,0 @@
-import { SE } from "@shipengine/react-api";
-import { ShipFromAddress } from "../../types";
-/**
- * @internal
- *
- * # Address Utilities - isDomesticAddress
- *
- * @category Utilities
- */
-export declare const isDomesticAddress: (address: Pick<SE.Address, "countryCode">) => boolean | undefined;
-/**
- * @internal
- *
- * # Address Utilities - isMilitaryAddress
- *
- * @category Utilities
- */
-export declare const isMilitaryAddress: (address: SE.Address) => boolean;
-/**
- * @internal
- *
- * # Address Utilities - isUnitedStatesTerritory
- *
- * @category Utilities
- */
-export declare const isUnitedStatesTerritory: (address: SE.Address) => boolean;
-/**
- * @internal
- *
- * # Address Utilities - isUnsupportedByUps
- *
- * @category Utilities
- */
-export declare const isUnsupportedByUps: (address: SE.Address) => boolean;
-/**
- * @internal
- *
- * # Address Utilities - isPoBox
- *
- * @category Utilities
- */
-export declare const isPoBox: (addressLine: string) => boolean;
-/**
- * @internal
- *
- * # Address Utilities - isPoBoxAddress
- *
- * @category Utilities
- */
-export declare const isPoBoxAddress: (address: SE.Address) => boolean;
-/**
- * @internal
- *
- * # Address Utilities - isEmptyAddress
- *
- * @category Utilities
- */
-export declare const isEmptyAddress: (address?: SE.Address) => boolean;
-/**
- * @internal
- *
- * # Address Utilities - addEmailToValidation
- *  Even though the documentation says otherwise, the email is dropped from the returned address validation object
- *
- * @category Utilities
- */
-export declare const addEmailToValidation: (addressValidation: SE.AddressValidation, email?: string) => SE.AddressValidation;
-/**
- * @internal
- *
- * # Address Utilities - getDefaultShipFromAddress
- *  Gets the default ship from address from an array of ship from addresses
- *
- * @category Utilities
- */
-export declare const getDefaultShipFromAddress: (addresses?: ShipFromAddress[]) => ShipFromAddress | undefined;
-/**
- * @internal
- *
- * # Address Utilities - getSavedShipFromAddressId
- *  Gets the address ID of the Ship From Address on the shipment if it is a saved address and not a warehouse
- *
- * @category Utilities
- */
-export declare const getSavedShipFromAddressId: (shipment?: SE.SalesOrderShipment, shipFromAddresses?: (ShipFromAddress & {
-    addressId: string;
-})[]) => string | undefined;
-/**
- * @internal
- *
- * # Address Utilities - getIsShipmentUsingSavedShipFromAddress
- *  Returns true if the shipment is using a saved ship from address
- *
- * @category Utilities
- */
-export declare const getIsShipmentUsingSavedShipFromAddress: (shipment?: SE.SalesOrderShipment, shipFromAddresses?: (ShipFromAddress & {
-    addressId: string;
-})[]) => boolean | undefined;

package/types/src/utilities/shipengine/carrier.d.ts

@@ -1,52 +0,0 @@
-import { MetadataCarrierProfile, SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Carrier Utilities - isUspsCarrier
- *
- * @category Utilities
- */
-export declare const isUspsCarrier: (carrierCode: string) => boolean;
-/**
- * @internal
- *
- * # Carrier Utilities - isUpsCarrier
- *
- * @category Utilities
- */
-export declare const isUpsCarrier: (carrierCode: string) => boolean;
-/**
- * @internal
- *
- * # Carrier Utilities - isYodelCarrier
- *
- * @category Utilities
- */
-export declare const isYodelCarrier: (carrierCode: string) => boolean;
-/**
- * @internal
- *
- * # Carrier Utilities - isEvriCarrier
- *
- * @category Utilities
- */
-export declare const isEvriCarrier: (carrierCode: string) => boolean;
-/**
- * @internal
- *
- * # Carrier Utilities - isFedexCarrier
- *
- * @category Utilities
- */
-export declare const getCarrierIdByCarrierCode: (carriers: SE.Carrier[] | undefined, carrierCode: string) => string | undefined;
-/**
- * @internal
- *
- * # Carrier Utilities - getLogoOrIconByCarrierCode
- *
- * @category Utilities
- */
-export declare const getLogoOrIconByCarrierCode: (carrierCode: string, type: "logo" | "icon") => string;
-export declare const isGlobalPostEligible: (region?: string) => boolean;
-export declare const isSendleEligible: (region?: string) => boolean;
-export declare const filterFundingSourceCarriers: (carriers?: MetadataCarrierProfile[], fundingSourceRegion?: string) => MetadataCarrierProfile[] | undefined;

package/types/src/utilities/shipengine/dimensions.d.ts

@@ -1,33 +0,0 @@
-import { SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Convert Dimensions Options Type
- *
- * @see {@link convertDimensions | The Convert Dimensions Utility Function}
- */
-export type ConvertDimensionsOptions = {
-    /**
-     * `allowAllZeroes` indicates if you want to allow zeros in the returned dimensions.
-     */
-    allowAllZeroes?: boolean;
-};
-/**
- * @internal
- *
- * # Convert Dimensions Utility Function
- *
- * @category Utilities
- */
-export declare const formatDimensions: (dimensions: SE.DimensionsWithUnit) => string;
-export declare function convertDimensions(dimensions: SE.DimensionsWithUnit, { allowAllZeroes }?: ConvertDimensionsOptions): {
-    unit: SE.DimensionUnit;
-    girth?: number | undefined;
-    height: number;
-    length: number;
-    lengthPlusGirth?: number | undefined;
-    noThreeSidesExceed?: number | undefined;
-    noTwoSidesExceed?: number | undefined;
-    volume?: number | undefined;
-    width: number;
-} | undefined;

package/types/src/utilities/shipengine/index.d.ts

@@ -1,9 +0,0 @@
-export * from "./address";
-export * from "./carrier";
-export * from "./dimensions";
-export * from "./sales-order";
-export * from "./shipment";
-export * from "./weight";
-export * from "./package";
-export * from "./warehouses";
-export * from "./insurance";

package/types/src/utilities/shipengine/insurance.d.ts

@@ -1,17 +0,0 @@
-import { SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Insurance Utilities - getInsuranceProviderWithFriendlyName
- *
- * @category Utilities
- */
-export declare const getInsuranceProviderWithFriendlyName: (termType: string) => import("../../types").InsuranceProviderWithFriendlyName;
-/**
- * @internal
- *
- * # Insurance Utilities - getIsInsuraceProviderAccepted
- *
- * @category Utilities
- */
-export declare const getIsInsuraceProviderAccepted: (termType: string, acceptedTerms?: SE.Term[]) => boolean;

package/types/src/utilities/shipengine/package.d.ts

@@ -1,8 +0,0 @@
-/**
- * @internal
- *
- * # Package Utilities - isFlatRatePackageCode
- *
- * @category Utilities
- */
-export declare const isFlatRatePackageCode: (packageCode: string | null | undefined) => boolean;

package/types/src/utilities/shipengine/sales-order.d.ts

@@ -1,52 +0,0 @@
-import { SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Sales Order Utilities - getCustomsFromSalesOrder
- *
- * @category Utilities
- */
-export declare const getCustomsFromSalesOrder: (salesOrder: SE.SalesOrder, originAddress: SE.Address) => {
-    customs: SE.Customs;
-    products: SE.Product[];
-};
-/**
- * @internal
- *
- * # Sales Order Utilities - getIsCustomsRequiredForSalesOrder
- *
- * @category Utilities
- */
-export declare const getIsCustomsRequiredForSalesOrder: ({ shipTo }: SE.SalesOrder, originAddress?: SE.Address) => boolean;
-/**
- * @internal
- *
- * # Sales Order Utilities - getRequestedServices
- *
- * @category Utilities
- */
-export declare const getRequestedServices: (salesOrder: SE.SalesOrder | undefined) => string[];
-/**
- * @internal
- *
- * # Sales Order Shipment Type
- *
- * @category Utilities
- */
-type SalesOrderOrShipment = {
-    salesOrder?: SE.SalesOrder;
-    shipment?: SE.SalesOrderShipment;
-};
-/**
- * @internal
- *
- * # Sales Order Utilities - getSalesOrderItemsFromSalesOrderOrShipment
- *
- * @category Utilities
- */
-export declare const getSalesOrderItemsFromSalesOrderOrShipment: ({ salesOrder, shipment, }: SalesOrderOrShipment) => {
-    detail: string;
-    name: string;
-    quantity: number;
-}[];
-export {};

package/types/src/utilities/shipengine/shipment.d.ts

@@ -1,52 +0,0 @@
-import { SE } from "@shipengine/react-api";
-/**
- * @internal
- *
- * # Shipment Utilities - getIsInternationalShipment
- *
- * @category Utilities
- */
-export declare const getIsInternationalShipment: ({ shipFrom, shipTo }: SE.SalesOrderShipment) => boolean;
-/**
- * @internal
- *
- * # Shipment Utilities - getIsCustomsRequiredForShipment
- *
- * @category Utilities
- */
-export declare const getIsCustomsRequiredForShipment: ({ shipFrom, shipTo }: SE.SalesOrderShipment) => boolean;
-/**
- * @internal
- *
- * @deprecated please use getShipmentByStatus instead
- * # Shipment Utilities - getPendingShipment
- *
- * @category Utilities
- */
-export declare const getPendingShipment: (shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
-/**
- *
- * @deprecated please use getShipmentByStatus instead
- * @internal
- * @param shipments
- * @returns the latest created shipment whose status is `cancelled`
- */
-export declare const getCancelledShipment: (shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
-/**
- *
- * @param status string containing one of the following values - "pending", "processing", "label_purchased", "cancelled"
- * @param shipments optional list of shipments to filter from
- * @returns latest created shipment whose shipmentStatus matches the param status
- */
-export declare const getShipmentByStatus: (status: SE.ShipmentStatus, shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;
-/**
- * @internal
- *
- * # Shipment Utilities - map customsItems to products and delete customsItems from the customs object
- *
- * @category Utilities
- * @param shipment
- * @returns the shipment with customsItems moved to products
- * @see https://www.shipengine.com/docs/shipping/international/#the-customs-object:~:text=New%20products%20array%20replaces%20the%20customs_items%20array
- */
-export declare const moveCustomsItemsToProducts: (shipment: SE.SalesOrderShipment) => SE.SalesOrderShipment;