feat: add dateTime helpers

.gitattributes

@@ -1,2 +1,2 @@
 # Hide generated files from PRs
-typedocs/* linguist-generated=true
+typedocs/**/* linguist-generated=true

src/helpers/datetime.ts

@@ -5,6 +5,12 @@ import {
     DateFormats,
 } from '../types/helpers/datetime';
 
+export class DateTime {
+    dateFormats = DateFormats;
+
+    localizeDate = localizeDate;
+}
+
 /**
  * Returns the time provided as a number
  * e.g) "22:00:00" to 220000

src/index.ts

@@ -8,6 +8,7 @@ import { Location } from './helpers/location';
 import { Customers } from './api/customers';
 import { Item } from './helpers/item';
 import { Money } from './helpers/money';
+import { DateTime } from './helpers/datetime';
 
 export interface InitConfig {
 	userId: number;
@@ -29,6 +30,7 @@ class SiteThemeSDK {
 		item: Item;
 		location: Location;
 		money: Money;
+		dateTime: DateTime;
 	};
 
     constructor(initObj: InitConfig) {
@@ -56,7 +58,8 @@ class SiteThemeSDK {
         this.helpers = {
             item: new Item(),
             location: new Location(),
-            money: new Money()
+            money: new Money(),
+            dateTime: new DateTime(),
         };
     }
 }

test/helpers.dateTime.test.ts

@@ -0,0 +1,47 @@
+import { describe, expect, it } from 'vitest';
+import { getTestSiteThemeSDK } from './helpers';
+import {
+    DateFormats,
+} from '../src/types/helpers/datetime';
+
+const sdk = getTestSiteThemeSDK();
+
+describe('provideDateFormats', () => {
+    it('should provide date formats', () => {
+        expect(sdk.helpers.dateTime.dateFormats).toBe(DateFormats);
+        expect(sdk.helpers.dateTime.dateFormats.weekdaySyearNmonthSdayNhourNminuteN)
+            .toBe(DateFormats.weekdaySyearNmonthSdayNhourNminuteN);
+    });
+});
+
+describe('localizeDate', () => {
+    it('should localize date', () => {
+        const date = new Date('2024-10-01T08:00:00.000-04:00');
+        let localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.weekdayShort, 'America/New_York');
+        expect(localizedDate).toBe('Tue');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.weekdayLong, 'America/New_York');
+        expect(localizedDate).toBe('Tuesday');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.hourNminuteN, 'America/New_York');
+        expect(localizedDate).toBe('8:00 AM');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.hourNminuteNsecondN, 'America/New_York');
+        expect(localizedDate).toBe('8:00:00 AM');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.yearNmonth2day2, 'America/New_York');
+        expect(localizedDate).toBe('10/01/2024');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.yearNmonthNdayN, 'America/New_York');
+        expect(localizedDate).toBe('10/1/2024');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.yearNmonthLdayN, 'America/New_York');
+        expect(localizedDate).toBe('October 1, 2024');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.yearNmonthSdayN, 'America/New_York');
+        expect(localizedDate).toBe('Oct 1, 2024');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.yearNmonthLdayNhourNminuteN, 'America/New_York');
+        expect(localizedDate).toBe('October 1, 2024 at 8:00 AM');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.yearNmonthSdayNhourNminuteN, 'America/New_York');
+        expect(localizedDate).toBe('Oct 1, 2024, 8:00 AM');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.weekdayLyearNmonthLdayNhourNminuteN, 'America/New_York');
+        expect(localizedDate).toBe('Tuesday, October 1, 2024 at 8:00 AM');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.weekdaySyearNmonthSdayNhourNminuteN, 'America/New_York');
+        expect(localizedDate).toBe('Tue, Oct 1, 2024, 8:00 AM');
+        localizedDate = sdk.helpers.dateTime.localizeDate(date, 'en-US', sdk.helpers.dateTime.dateFormats.weekdayLhourNminuteN, 'America/New_York');
+        expect(localizedDate).toBe('Tuesday 8:00 AM');
+    });
+});