@commercelayer/app-elements 1.9.7 → 1.10.1

package/dist/dictionaries/promotions.d.ts

@@ -0,0 +1,7 @@
+import type { Promotion } from '@commercelayer/sdk';
+import type { DisplayStatus } from './types';
+interface PromotionDisplayStatus extends DisplayStatus {
+    status: 'disabled' | 'active' | 'upcoming' | 'expired';
+}
+export declare function getPromotionDisplayStatus(promotion: Omit<Promotion, 'type'>): PromotionDisplayStatus;
+export {};

package/dist/helpers/date.d.ts

@@ -74,6 +74,29 @@ export declare function getIsoDateAtDaysBefore({ isoString, days, timezone }: {
     days: number;
     timezone?: string;
 }): string | undefined;
+/**
+ * Given the event date (`startsAt` and `expiresAt`) it returns whether the the event is `active`, `past` or `upcoming`.
+ */
+export declare function getEventDateInfo({ startsAt, expiresAt, timezone }: {
+    /** The activation date/time of the event (ISO date string. Example '2022-10-06T11:59:30.371Z'). */
+    startsAt: DateISOString;
+    /** The expiration date/time of the promotion (must be after startsAt) (ISO date string. Example '2022-10-06T11:59:30.371Z'). */
+    expiresAt: DateISOString;
+    /** Set a specific timezone, when not passed default value is 'UTC' */
+    timezone?: string;
+}): 'active' | 'past' | 'upcoming';
+/**
+ * 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 }: {
+    /** 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;
+}): string;
 export interface Event {
     date: string;
 }