@shipengine/elements 0.34.0 → 0.36.0

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

@@ -1,26 +1,57 @@
 import { SE } from "@shipengine/alchemy";
 /**
+ * @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;

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

@@ -1,4 +1,25 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @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 - isFedexCarrier
+ *
+ * @category Utilities
+ */
 export declare const getCarrierIdByCarrierCode: (carriers: SE.Carrier[] | undefined, carrierCode: string) => string | undefined;

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

@@ -1,10 +1,33 @@
 import { SE } from "@shipengine/alchemy";
-type ConvertDimensionsOptions = {
+/**
+ * @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 function convertDimensions(dimensions: SE.Dimensions): SE.DimensionsWithUnit;
-export declare function convertDimensions(dimensions: SE.DimensionsWithUnit, options?: ConvertDimensionsOptions): SE.Dimensions;
-export {};
+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/src/utilities/shipengine/package.d.ts

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

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

@@ -1,20 +1,46 @@
 import { SE } from "@shipengine/alchemy";
 /**
+ * @internal
+ *
+ * # Sales Order Utilities - getCustomsFromSalesOrder
+ *
  * @category Utilities
  */
 export declare const getCustomsFromSalesOrder: (salesOrder: SE.SalesOrder, warehouse: SE.Warehouse) => SE.Customs;
 /**
+ * @internal
+ *
+ * # Sales Order Utilities - getIsCustomsRequiredForSalesOrder
+ *
  * @category Utilities
  */
 export declare const getIsCustomsRequiredForSalesOrder: ({ shipTo }: SE.SalesOrder, { originAddress }: SE.Warehouse) => 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;

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

@@ -1,13 +1,25 @@
 import { SE } from "@shipengine/alchemy";
 /**
+ * @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
+ *
+ * # Shipment Utilities - getPendingShipment
+ *
  * @category Utilities
  */
 export declare const getPendingShipment: (shipments?: SE.SalesOrderShipment[]) => SE.SalesOrderShipment | undefined;

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

@@ -1,13 +1,103 @@
 import { SE } from "@shipengine/alchemy";
 /**
+ * @internal
+ *
+ * # Weight Utilities - isMetricWeightUnit
+ *
+ * - This utility function checks if the weight unit is `metric` and returns a `boolean`
+ * indicating if it is metric or not.
+ *
+ * @param unit The weight unit to check (optional).
+ *
+ * @returns boolean Indicating if the weight unit is `metric`.
+ *
  * @category Utilities
  */
+export declare const isMetricWeightUnit: (unit?: SE.WeightUnit) => unit is "gram" | "kilogram";
+/**
+ * @internal
+ *
+ * # Weight Utilities - isDecimalWeight
+ *
+ * - This utility function checks if the weight is a `decimal` weight and returns a `boolean`
+ * indicating if it is decimal or not.
+ *
+ * @param weight The weight to `check for a decimal` (optional).
+ *
+ * @returns boolean Indicating if the weight is a decimal weight.
+ *
+ * @category Utilities
+ */
+export declare const isDecimalWeight: (weight: SE.WeightWithUnit | SE.FractionalWeight) => weight is SE.WeightWithUnit;
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertPoundsAndOuncesToOunces
+ *
+ * - This utility function converts `pounds and ounces` to a `total of ounces`.
+ *
+ * @param weight The `pound + ounce` weight to convert to ounces.
+ *
+ * @returns number The total weight in `ounces`.
+ *
+ * @category Utilities
+ */
+export declare const convertPoundsAndOuncesToOunces: (weight: SE.FractionalWeight) => number;
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertFractionalWeightToDecimalWeight
+ *
+ * - This utility function converts a `fractional weight` to a `decimal weight`.
+ *
+ * @param weight The fractional weight to convert to a decimal weight.
+ * @param unit The target weight unit to convert to (optional).
+ *
+ * @returns WeightWithUnit The decimal weight with its unit.
+ *
+ * @category Utilities
+ */
+export declare const convertFractionalWeightToDecimalWeight: (weight: SE.FractionalWeight, unit?: SE.WeightUnit) => SE.WeightWithUnit;
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertDecimalWeightToFractionalWeight
+ *
+ * - This utility function converts a `decimal weight` to a `fractional weight`.
+ *
+ * @param weight The decimal weight to convert to a fractional weight.
+ *
+ * @returns FractionalWeight The converted fractional weight.
+ *
+ * @category Utilities
+ */
+export declare const convertDecimalWeightToFractionalWeight: (weight: SE.WeightWithUnit) => SE.FractionalWeight;
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertWeight/1
+ */
 export declare function convertWeight(weight: SE.WeightWithUnit): SE.FractionalWeight;
-export declare function convertWeight(weight: SE.FractionalWeight): SE.WeightWithUnit;
 /**
+ * @internal
+ *
+ * # Weight Utilities - convertWeight/2
+ */
+export declare function convertWeight(weight: SE.FractionalWeight, unit?: SE.WeightUnit): SE.WeightWithUnit;
+/**
+ * @internal
+ *
+ * # Weight Utilities - formatFractionalWeight
+ *
+ * - This utility function formats a `fractional weight` for ease of use.
+ *
+ * @param weight The fractional weight to be formatted.
+ *
+ * @return FractionalWeight The formatted fractional weight.
+ *
  * @category Utilities
  */
 export declare function formatFractionalWeight(weight: {
     fractional?: number | null;
     whole?: number | null;
-} | undefined | null): SE.FractionalWeight;
+} | undefined | null, unit?: SE.WeightUnit): SE.FractionalWeight;

package/src/utilities/string.d.ts

@@ -1 +1,8 @@
+/**
+ * @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;

package/src/utilities/styles.d.ts

@@ -15,6 +15,8 @@ type NotGETUP = `get${Uncapitalize<string>}`;
 type NotGetterKey = NotG | NotGE | NotGET | NotGETUP;
 type StylesConstraint = Record<GetterKey, GetterFunction> & Record<`${NotGetterKey}${string}`, Interpolation<Theme>>;
 /**
+ * @internal
+ *
  * Creates a Record of Emotion styles; eliminating the need to explicitly type styles
  * while remaining fully typesafe w/ autocomplete.
  *
@@ -34,6 +36,8 @@ type StylesConstraint = Record<GetterKey, GetterFunction> & Record<`${NotGetterK
  *   }),
  * });
  * ```
+ *
+ * @category Utilities
  */
 export declare const createStyles: <T extends StylesConstraint>(styles: T) => T;
 export {};

package/src/utilities/validation.d.ts

@@ -1,10 +1,18 @@
 import { Resolver } from "@hookform/resolvers/zod";
 import { z } from "zod";
 /**
+ * @internal
+ *
+ * # Error Map
+ *
  * @category Utilities
  */
 export declare const errorMap: z.ZodErrorMap;
 /**
+ * @internal
+ *
+ * # Validation Resolver
+ *
  * @category Utilities
  */
 export declare const validationResolver: <T extends z.ZodType<any, any, any>>(schema: T) => ReturnType<Resolver>;