@commercelayer/app-elements 3.5.4 → 4.0.0

package/dist/helpers/date.d.ts

@@ -1,3 +1,4 @@
+import { I18NLocale } from '../providers/I18NProvider';
 import { Simplify } from 'type-fest';
 type Format = 'date' | 'time' | 'timeWithSeconds' | 'full' | 'fullWithSeconds' | 'distanceToNow';
 interface FormatDateOptions {
@@ -25,13 +26,18 @@ interface FormatDateOptions {
      * @default false
      */
     showCurrentYear?: boolean;
+    /**
+     * Locale to use for formatting the date.
+     * @default en
+     */
+    locale?: I18NLocale;
 }
 /**
  * Format the date as nice string also specifying a custom timezone
  * @param opts a set of `FormatDateOptions`
  * @returns a nice string representation. Example: 'Jul 21, 2022' or 'Jul 21, 2022 · 1:16 PM' if includeTime
  */
-export declare function formatDate({ isoDate, timezone, showCurrentYear, ...opts }: FormatDateOptions): string;
+export declare function formatDate({ isoDate, timezone, locale, showCurrentYear, ...opts }: FormatDateOptions): string;
 interface FormatDateWithPredicateOptions extends FormatDateOptions {
     /**
      * Date predicate verb string. Example: 'Created' or 'Updated'.
@@ -43,7 +49,7 @@ interface FormatDateWithPredicateOptions extends FormatDateOptions {
  * @param opts a set of `FormatDateOptions` along with a date verb predicate. In this method `format` prop has 'full' default value.
  * @returns a nice string representation of the predicate, followed by the proper separator and the formatted date. Examples: 'Created today · 1:16 PM', 'Updated on Jul 21, 2022 · 1:16 PM' or 'Updated at 1:16 PM'
  */
-export declare function formatDateWithPredicate({ isoDate, timezone, format, predicate }: FormatDateWithPredicateOptions): string;
+export declare function formatDateWithPredicate({ isoDate, timezone, format, predicate, locale }: FormatDateWithPredicateOptions): string;
 export declare const timeSeparator = ", ";
 type DateISOString = string;
 /**
@@ -94,13 +100,15 @@ export declare function getEventDateInfo({ startsAt, expiresAt, timezone }: {
  * Format a date range as a nice string also specifying a custom timezone
  * @returns a nice string representation. Example: '1-21 Jul, 2022' or 'Jul 21, 2022 - Jan 12, 2023'
  */
-export declare function formatDateRange({ rangeFrom, rangeTo, timezone }: {
+export declare function formatDateRange({ rangeFrom, rangeTo, timezone, locale }: {
     /** JavaScript ISO date string. Example '2022-10-06T11:59:30.371Z' */
     rangeFrom: DateISOString;
     /** JavaScript ISO date string. Example '2022-11-06T11:59:30.371Z' */
     rangeTo: DateISOString;
     /** Set a specific timezone, when not passed default value is 'UTC' */
     timezone?: string;
+    /** Locale to use for formatting the date. */
+    locale?: I18NLocale;
 }): string;
 export interface Event {
     date: string;
@@ -112,8 +120,9 @@ type Position = 'first' | 'other';
  * @param options
  * @returns
  */
-export declare function sortAndGroupByDate<T extends Event>(events: T[], { timezone, orders }?: {
+export declare function sortAndGroupByDate<T extends Event>(events: T[], { timezone, locale, orders }?: {
     timezone?: string;
+    locale?: I18NLocale;
     orders?: 'asc' | 'desc';
 }): Record<string, Array<Simplify<T & {
     position: Position;

package/dist/helpers/tracking.d.ts

@@ -59,26 +59,26 @@ declare const trackingDetailSchema: z.ZodObject<{
         zip: z.ZodNullable<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         object: "TrackingLocation";
-        country: string | null;
         city: string | null;
+        country: string | null;
         state: string | null;
         zip: string | null;
     }, {
         object: "TrackingLocation";
-        country: string | null;
         city: string | null;
+        country: string | null;
         state: string | null;
         zip: string | null;
     }>, SetNonNullable<{
         object: "TrackingLocation";
-        country: string | null;
         city: string | null;
+        country: string | null;
         state: string | null;
         zip: string | null;
     }, "city"> | null, {
         object: "TrackingLocation";
-        country: string | null;
         city: string | null;
+        country: string | null;
         state: string | null;
         zip: string | null;
     }>;
@@ -88,14 +88,14 @@ declare const trackingDetailSchema: z.ZodObject<{
     object: "TrackingDetail";
     description: string | null;
     source: string | null;
-    message: string | null;
     status: string | null;
+    message: string | null;
     status_detail: string | null;
     datetime: string | null;
     tracking_location: SetNonNullable<{
         object: "TrackingLocation";
-        country: string | null;
         city: string | null;
+        country: string | null;
         state: string | null;
         zip: string | null;
     }, "city"> | null;
@@ -104,14 +104,14 @@ declare const trackingDetailSchema: z.ZodObject<{
     object: "TrackingDetail";
     description: string | null;
     source: string | null;
-    message: string | null;
     status: string | null;
+    message: string | null;
     status_detail: string | null;
     datetime: string | null;
     tracking_location: {
         object: "TrackingLocation";
-        country: string | null;
         city: string | null;
+        country: string | null;
         state: string | null;
         zip: string | null;
     };
@@ -138,43 +138,43 @@ declare const rateSchema: z.ZodObject<{
     /** currency for the rate */
     currency: z.ZodString;
     /** delivery days for this service */
-    delivery_days: z.ZodNumber;
+    delivery_days: z.ZodOptional<z.ZodNumber>;
     /** date for delivery */
-    delivery_date: z.ZodString;
+    delivery_date: z.ZodOptional<z.ZodString>;
     /** *This field is deprecated and should be ignored. @deprecated */
-    est_delivery_days: z.ZodNumber;
+    est_delivery_days: z.ZodOptional<z.ZodNumber>;
     /** formatted date for delivery */
-    formatted_delivery_date: z.ZodString;
+    formatted_delivery_date: z.ZodOptional<z.ZodString>;
     /** the actual formatted rate quote for this service */
     formatted_rate: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     id: string;
     mode: "test" | "production";
+    currency: string;
+    rate: number;
     service: string;
     carrier: string;
     carrier_account_id: string;
     shipment_id: string;
-    rate: number;
-    currency: string;
-    delivery_days: number;
-    delivery_date: string;
-    est_delivery_days: number;
-    formatted_delivery_date: string;
     formatted_rate: string;
+    delivery_days?: number | undefined;
+    delivery_date?: string | undefined;
+    est_delivery_days?: number | undefined;
+    formatted_delivery_date?: string | undefined;
 }, {
     id: string;
     mode: "test" | "production";
+    currency: string;
+    rate: number;
     service: string;
     carrier: string;
     carrier_account_id: string;
     shipment_id: string;
-    rate: number;
-    currency: string;
-    delivery_days: number;
-    delivery_date: string;
-    est_delivery_days: number;
-    formatted_delivery_date: string;
     formatted_rate: string;
+    delivery_days?: number | undefined;
+    delivery_date?: string | undefined;
+    est_delivery_days?: number | undefined;
+    formatted_delivery_date?: string | undefined;
 }>;
 export type TrackingDetail = z.infer<typeof trackingDetailSchema>;
 export type Rate = z.infer<typeof rateSchema>;