@shipengine/elements 1.3.0 → 1.3.2

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

@@ -382,6 +382,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     weightGroup: string;
                     today: string;
                 };
+                /**
+                 * `onBeforeLabelCreate` is an async/sync callback function that will be invoked before every
+                 * label purchase.
+                 */
                 hints: {
                     contentDescription: string;
                 };
@@ -407,7 +411,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 requirements: {
                     noWarehouse: string;
-                    noCarrier: string;
+                    noCarrier: string; /**
+                     * `onLoad` is an async/sync callback provided by the host application that is invoked after the
+                     * element is loaded. (This may be useful to grab the shipmentId of a one-off label)
+                     */
                     noWarehouseOrCarrier: string;
                 };
                 shipToAddressFormFields: string;
@@ -441,6 +448,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     fundingAndCarrierConnection: string;
                 };
                 warehouse: {
+                    /**
+                     * # Purchase Label Component Props
+                     *
+                     * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
+                     * for either shipment-based or sales order-based label purchasing.
+                     *
+                     * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
+                     */
                     title: string;
                     subtitle: string;
                     inlineMessage: string;
@@ -449,7 +464,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     title: string;
                     subtitle: string;
                     action: string;
-                };
+                }; /**
+                 * `features` is a set of feature flags you would like to enable or disable in this component.
+                 */
                 termsAndAgreementLinkText: {
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
@@ -552,6 +569,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     minimumPurchaseAmount: string;
                     other: string;
                 };
+                /**
+                 *`getPreferredRates is an async/sync optional callback function that will be invoked each time rates are caculated.
+                 * This is an optional callback function that returns an array of ShipEngine rates. The rates from this response will
+                 * be spliced into the normal get rates response the Elements makes internally. If a service code matches a service
+                 * code on a rate returned from getPreferredRates, the rate returned from getPreferredRates will not be shown in the
+                 * rate form. These preferred rates will be displayed with a set of UI enhancements that incude a dynamic cost savings
+                 * flag and green checkmark when the rate is selected.
+                 */
                 fundAndPurchase: {
                     finalBalance: string;
                     insufficientFunds: string;
@@ -565,11 +590,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     unableToFindBalance: string;
                 };
                 currentBalance: string;
-                /**
-                 * `onAddressValidation` is an async/sync callback function that will be invoked on each Address
-                 * validation request. For example, whenever you update the `Ship To Address` or
-                 * `Ship From Address` for a given shipment.
-                 */
                 maximumBalanceAmount: string;
             };
             "list-carriers": {
@@ -632,7 +652,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         confirm: string;
                         addressNotValidated: string;
                         modified: string;
-                        title: string;
+                        title: string; /**
+                         *`getPreferredRates is an async/sync optional callback function that will be invoked each time rates are caculated.
+                         * This is an optional callback function that returns an array of ShipEngine rates. The rates from this response will
+                         * be spliced into the normal get rates response the Elements makes internally. If a service code matches a service
+                         * code on a rate returned from getPreferredRates, the rate returned from getPreferredRates will not be shown in the
+                         * rate form. These preferred rates will be displayed with a set of UI enhancements that incude a dynamic cost savings
+                         * flag and green checkmark when the rate is selected.
+                         */
                         originalAddress: string;
                         matchedAddress: string;
                         unableToValidate: string;
@@ -680,13 +707,13 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     adultSignature: string;
                     delivery: string;
                     deliveryMailed: string;
+                    directSignature: string;
+                    none: string;
+                    signature: string;
                     /**
                      * `onChangeShipmentFormMode` is an async/sync callback function that will be invoked each time
                      * the user toggles the `Shipment Form Mode` between `Browse Rates` and `Selected Rate`.
                      */
-                    directSignature: string;
-                    none: string;
-                    signature: string;
                     verbalConfirmation: string;
                 };
                 customs: {
@@ -826,44 +853,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     tooManyCharacters: string;
                 };
                 shippingPresets: {
-                    /**
-                     * # Registered Purchase Label Element
-                     *
-                     * @param ElementProps The props necessary to render the `<PurchaseLabel.Element />` for shipment
-                     * based or sales order based label purchasing.
-                     *
-                     * @example
-                     * The `<Component />` is the source JSX that is rendered when you make use of the `PurchaseLabel`
-                     * Element directly.
-                     * ```tsx
-                     * <PurchaseLabel.Element
-                     *   key={currentSalesOrderId}
-                     *   printLabelLayout='4x6'
-                     *   shippingPresets={presets}
-                     *   onShipmentUpdated={(shipment) => console.log('Shipment Updated', shipment)}
-                     *   onRateSaved={(
-                     *     shipment: SE.SalesOrderShipment,
-                     *     rate?: SE.Rate,
-                     *     rateOptions?: SE.Rate[]
-                     *   ) => console.log('Rate Saved', shipment, rate, rateOptions)}
-                     *   onRatesCalculated={() => console.log('Rates Calculated')}
-                     *   onBeforeLabelCreate={onBeforeLabelPurchase}
-                     *   onLabelCreateSuccess={onLabelPurchaseSuccess}
-                     *   onLabelCreateFailure={(rate) => console.log('Label Purchase Failed', rate)}
-                     *   warehouseId={defaultWarehouseId}
-                     * />
-                     * ```
-                     *
-                     * <br />
-                     *
-                     * - Once a label has been purchased using this Element, you can take the `shipmentId` for the
-                     * associated shipment and pass it into the `<ViewShipment.Element />` Element in order to view
-                     * the shipment details.
-                     *
-                     * @see {@link PurchaseLabel.PurchaseLabelCommonProps | The **Common props** used in `<PurchaseLabel.Element />`}
-                     *
-                     * @see {@link ViewShipment.Element | The next step in the label purchase workflow `<ViewShipment.Element />`}
-                     */
                     apply: string;
                     platform: string;
                     user: string;

package/src/utilities/date.d.ts

@@ -1,11 +1,35 @@
 /**
  * @internal
  *
- * # Date Utils - getDaysInMonth
+ * # Date Utils - Formats a date to the current locale
  *
  * @category Utilities
  */
 export declare const formatDate: (date: string, locale?: string) => string;
+/**
+ * @internal
+ * Get the locale data for a given locale string.
+ * @param locale string i.e. "en-US"
+ * @returns locale data
+ */
+export declare const findDateLocale: (locale?: string) => Locale;
+/**
+ * @internal
+ * Given a date and a locale, format the date to the locale's date format.
+ * @param date
+ * @param locale string i.e. "en-US"
+ * @param dateFormat string. See https://date-fns.org/v3.3.1/docs/format
+ * @returns formatted date string
+ */
+export declare const formatByDateAndLocale: (date: Date, locale?: string, dateFormat?: string) => string;
+/**
+ * @internal
+ * Parse a string in the CURRENT locale into a Date object.
+ * @param date string
+ * @param locale
+ * @returns date
+ */
+export declare const parseLocaleDate: (date: string, locale?: string, dateFormat?: string) => Date;
 /**
  * @internal
  *
@@ -17,7 +41,24 @@ export declare const formatDateDDMMYY: (date: string, locale?: string) => string
 /**
  * @internal
  *
- * # Date Utils - getDaysInMonth
+ * # Date Utils - formatDateDDMMYYYY
+ *
+ * @category Utilities
+ */
+export declare const formatDateDDMMYYYY: (date: string, locale?: string) => string;
+/**
+ * @internal
+ *
+ * Get the date format in the current locale i.e., "MM/DD/YYYY"
+ *
+ * @category Utilities
+ * @returns Date format as string
+ */
+export declare const getlocaleDateStringFormat: (locale?: string) => string;
+/**
+ * @internal
+ *
+ * # Date Utils - Get the date a number of days after a given date
  *
  * @category Utilities
  */
@@ -25,7 +66,7 @@ export declare const daysAfter: (days: number, date?: Date) => Date;
 /**
  * @internal
  *
- * # Date Utils - getDaysInMonth
+ * # Date Utils - Get a cutoff date for a given date or the current date
  *
  * @category Utilities
  */
@@ -33,7 +74,7 @@ export declare const nextDayCutoff: (cutoff: number, date?: Date) => Date;
 /**
  * @internal
  *
- * # Date Utils - getDaysInMonth
+ * # Date Utils - get the most recent date from a list of dates
  *
  * @category Utilities
  */
@@ -41,7 +82,7 @@ export declare const mostRecent: (...dates: Date[]) => Date;
 /**
  * @internal
  *
- * # Date Utils - getDaysInMonth
+ * # Date Utils - Given a date, return a new date with the time set to 00:00:00
  *
  * @category Utilities
  */

package/src/utilities/i18nDateUtils.d.ts

@@ -1,16 +0,0 @@
-export declare const LOCALE: string;
-/**
- * Parse a string in the CURRENT locale into a Date object.
- * current locale is determined by navigator.language for now
- * @param dateString
- */
-export declare const parseLocaleDate: (dateString: string | null) => Date | null;
-export declare const parseUSADate: (dateString: string) => Date | null;
-/**
- *
- * Format a date into a string in the CURRENT locale.
- * current locale is determined by navigator.language for now
- * @param date
- */
-export declare const formatLocaleDate: (date: Date | null) => string | null;
-export declare const formatUSADate: (date: Date | null) => string | null;