Renaming

Author: uche789

docs/generated-data.md

@@ -7,20 +7,34 @@
 Each calendar month object has a `key` attribute ranging from 0 to 11 (January to December), a `name` attribute and a `data` attribute to generate each field in the calendar.
 
 ```typescript
+type ValueName = {
+    value:  number,
+    name: 'january' | 'febuary' | 'march' | 'april' | 'may' | 'june' | 'july' | 'august' | 'september' | 'october' | 'november' | 'december'
+}
+
 interface CalendarMonth {
-    key: number,
-    name: string, // january, febuary, march ...
-    data: Record<number, Array<{
+    date: {
+        object: Date,
+        currentDate: 31,
+        currentDay: 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun',
+        currentMonth: ValueName,
+        prevMonth: ValueName,
+        nextMonth: ValueName,
+        currentYear: 2022,
+        prevYear: number,
+        nextYear: number
+    },
+    calendarValues: Record<number, Array<{
         type: string, //prev, next or current
         value: number,
         dateValue: string
     }>>
 }
 ```
 
-### `data`
+### `calendarValues`
 
-The `data` attribute is an object with 6 keys ranging from 1-6. Each number indicates a row in the calendar. Each key (row) has an array of 7 data fields (columns) for the dates from Sunday to Saturday.
+The `calendarValues` attribute is an object with 6 keys ranging from 1-6. Each number indicates a row in the calendar. Each key (row) has an array of 7 data fields (columns) for the dates from Sunday to Saturday.
 
 |Sun|Mon|Tue|Wed|Thu|Fri|Sat|
 |:-:|:-:|:-:|:-:|:-:|:-:|:-:|
@@ -54,5 +68,17 @@ The `dateValue` attribute is the date string with the format `YYYY-MM-DD`.
 The `getCalendarYear` function returns the calendar year as an object with keys ranging from 0 - 11 (Jan - Feburary). The value corresponds to the data for the calendar month.
 
 ```typescript
-type CalendarYear = Record<number, CalendarMonth>
+interface YearCalendarMonth {
+    key: number,
+    name: string, // january, febuary, march ...
+    calendarValues: Record<number, Array<{
+        type: string, //prev, next or current
+        value: number,
+        dateValue: string
+    }>>
+}
+```
+
+```typescript
+type CalendarYear = Record<number, YearCalendarMonth>
 ```

examples/calendar.html

@@ -7,7 +7,7 @@ import dateConsts from './constants/days'
  * @typedef CalendarMonth
  * @property {number} key
  * @property {string} name
- * @property {CalendarValues} data
+ * @property {CalendarValues} calendarValues
  */
 
 /**
@@ -136,7 +136,7 @@ export default class Year {
             months[i] = {
                 key: i,
                 name: dateConsts.months[i],
-                data: this.generateCalendarValues(i)
+                calendarValues: this.generateCalendarValues(i)
             };
         }
 

src/year.js

@@ -22,10 +22,12 @@ describe('year.js', () => {
         const result = y.getCalendarYear();
 
         expect(Object.keys(result).length).toBe(12);
-        expect(Array.isArray(result[0].data[1])).toBeTruthy();
-        expect(result[0].data[1][0].dateValue).toBeTruthy();
-        expect(!!result[0].data[1][0].type).toBeTruthy();
-        expect(!!result[0].data[1][0].value).toBeTruthy();
+        expect(result[0].key).toEqual(0);
+        expect(result[0].name).toEqual('january');
+        expect(Array.isArray(result[0].calendarValues[1])).toBeTruthy();
+        expect(result[0].calendarValues[1][0].dateValue).toBeTruthy();
+        expect(!!result[0].calendarValues[1][0].type).toBeTruthy();
+        expect(!!result[0].calendarValues[1][0].value).toBeTruthy();
     })
 
     it('should correct fetch dates from previous year', () => {
@@ -36,7 +38,7 @@ describe('year.js', () => {
         // get last month
         expect(result[0].name).toEqual('january');
         // fetch first cell in first row of month calendar
-        expect(result[0].data[1][0].dateValue).toMatch(/2021-12-26/);
+        expect(result[0].calendarValues[1][0].dateValue).toMatch(/2021-12-26/);
     })
 
     it('should correct fetch dates from next year', () => {
@@ -47,6 +49,6 @@ describe('year.js', () => {
         // get last month
         expect(result[11].name).toEqual('december');
         // fetch last cell in last row of month calendar
-        expect(result[11].data[6][6].dateValue).toMatch(/2023-1-7/);
+        expect(result[11].calendarValues[6][6].dateValue).toMatch(/2023-1-7/);
     })
 });