#130 Release 0.0.10 #131

#130 Release 0.0.10

Author: matthewbub

README.md

@@ -1,7 +1,7 @@
 # calendar-widgets
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-![Current bundle size: 32.11 kB](https://img.shields.io/badge/Bundle_Size-32.11_kB-green.svg)
+![Current bundle size: 171.23 kB](https://img.shields.io/badge/Bundle_Size-171.23_kB-green.svg)
 
 Working with dates sucks, working with calendars sucks even more. Here's an attempt at making things less sucky. Website: [http://www.calendar-widgets.com/](http://www.calendar-widgets.com/)
 
@@ -35,8 +35,9 @@ pnpm install calendar-widgets
 Once the package is installed, you'll have access to an array of helpers and utilities that do a lot of the heavy lifting when it comes to dates and calendars. 
 
 ### Helpers
-- [`getCalendarYear`](https://calendar-widgets.com/helpers/getCalendarYear) function
+- [`listCalendarYear`](https://calendar-widgets.com/helpers/listCalendarYear) function
 - [`listDaysInMonth`](https://calendar-widgets.com/helpers/listDaysInMonth) function
+- `listLocalizedMonths` function
 
 ### Utilities
 - [`formatDate`](https://calendar-widgets.com/utilities/formatDate) function

package.json

@@ -15,6 +15,10 @@
     "install:docs": "cd ./workspaces/docs && pnpm install",
     "install:tests": "cd ./workspaces/tests && pnpm install",
     "install:calendar-widgets": "cd ./workspaces/calendar-widgets && pnpm install",
-    "new": "pnpm run install:tests && pnpm run install:calendar-widgets && pnpm run install:docs"
+    "new": "pnpm run install:tests && pnpm run install:calendar-widgets && pnpm run install:docs",
+    "lint:calendar-widgets": "cd ./workspaces/calendar-widgets && pnpm run lint",
+    "lint:fix:calendar-widgets": "cd ./workspaces/calendar-widgets && pnpm run lint:fix",
+    "build:tests": "cd ./workspaces/tests && pnpm run build:tests",
+    "build:prepublish": "pnpm run build:tests && pnpm run lint:calendar-widgets"
   }
 }

workspaces/calendar-widgets/@types/calendar-widgets/index.d.ts

@@ -0,0 +1,8 @@
+export declare function formatDate(month: number, day: number, year: number, locale?: string, options?: Intl.DateTimeFormatOptions): string;
+export declare function listCalendarYear(year: number, locale: string): { [key: string]: string[] };
+export declare function getDaysInMonth(year: number, month: number): number;
+export declare function listDaysInMonth(year: number, month: number): string[];
+export declare function isValidYear(year: number): boolean;
+export declare function isValidDay(day: number): boolean;
+export declare function isValidMonth(month: number): boolean;
+export declare function Hello(): void;

workspaces/calendar-widgets/README.md

@@ -26,9 +26,9 @@ pnpm install calendar-widgets
 Once the package is installed, you'll have access to an array of helpers and utilities that do a lot of the heavy lifting when it comes to dates and calendars. 
 
 ### Helpers
-- [`getCalendarYear`](https://calendar-widgets.com/helpers/getCalendarYear) function
+- [`listCalendarYear`](https://calendar-widgets.com/helpers/listCalendarYear) function
 - [`listDaysInMonth`](https://calendar-widgets.com/helpers/listDaysInMonth) function
-
+- `listLocalizedMonths` function
 ### Utilities
 - [`formatDate`](https://calendar-widgets.com/utilities/formatDate) function
 - [`getDaysInMonth`](https://calendar-widgets.com/utilities/getDaysInMonth) function

workspaces/calendar-widgets/package.json

@@ -1,9 +1,10 @@
 {
   "name": "calendar-widgets",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "main": "./dist/bundle.js",
   "type": "module",
   "module": "./src/index.js",
+  "types": "@types/calendar-widgets/index.d.ts",
   "scripts": {
     "lint": "eslint -c .eslintrc.cjs ./src --ext .ts,.tsx",
     "lint:debug": "eslint -c .eslintrc.cjs ./src --ext .ts,.tsx --debug",
@@ -12,7 +13,8 @@
   },
   "keywords": [
     "calendar",
-    "calendar SDK"
+    "calendar SDK",
+    "calendar widgets"
   ],
   "dependencies": {
     "react": "18.2.0",
@@ -36,5 +38,13 @@
     "tslib": "^2.5.0",
     "typescript": "^5.0.4"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/9mbs/calendar-widgets"
+  },
+  "bugs": {
+    "url": "https://github.com/9mbs/calendar-widgets/issues"
+  },
+  "homepage": "https://www.calendar-widgets.com/"
 }

workspaces/calendar-widgets/src/utils/getCalendarYear.ts workspaces/calendar-widgets/src/helpers/listCalendarYear.ts

@@ -1,5 +1,5 @@
 import { listDaysInMonth } from './listDaysInMonth.js';
-import { isValidYear } from './isValidYear.js';
+import { isValidYear } from '../utils/isValidYear.js';
 import { locale as localeConstants } from '../locale/index.js';
 import { ONE } from '../constants.js';
 
@@ -9,7 +9,7 @@ import { ONE } from '../constants.js';
  * @param {number} year - The year for which to generate the calendar (e.g. 2023).
  * @returns {object} An object representing a calendar year with a list of days for each month.
  */
-export const getCalendarYear = (year: number, locale = 'en-US') => {
+export const listCalendarYear = (year: number, locale = 'en-US'): { [key: string]: string[] } => {
   if (!isValidYear(year)) {
     throw new Error('Invalid year, must be between 1900 and 2100.');
   }

workspaces/calendar-widgets/src/utils/listDaysInMonth.ts workspaces/calendar-widgets/src/helpers/listDaysInMonth.ts

@@ -1,7 +1,7 @@
 import { ONE, ZERO } from '../constants';
-import { formatDate } from './formatDate';
-import { isValidMonth } from './isValidMonth';
-import { isValidYear } from './isValidYear';
+import { formatDate } from '../utils/formatDate';
+import { isValidMonth } from '../utils/isValidMonth';
+import { isValidYear } from '../utils/isValidYear';
 
 /**
  * Generates an array of formatted date strings representing each day in a given month and year.

workspaces/calendar-widgets/src/index.ts

@@ -1,21 +1,23 @@
 import { getDaysInMonth } from './utils/getDaysInMonth';
 import { isValidYear } from './utils/isValidYear';
-import { listDaysInMonth } from './utils/listDaysInMonth';
+import { listDaysInMonth } from './helpers/listDaysInMonth';
 import { locale } from './locale/index';
-import { getCalendarYear } from './utils/getCalendarYear';
+import { listCalendarYear } from './helpers/listCalendarYear';
 import { formatDate } from './utils/formatDate';
 import { isValidDay } from './utils/isValidDay';
 import { isValidMonth } from './utils/isValidMonth';
+import { listLocalizedMonths } from './helpers/listLocalizedMonths';
 import { Hello } from './components/Hello';
 
 export {
-  getDaysInMonth,
   listDaysInMonth,
-  locale,
-  getCalendarYear,
+  listCalendarYear,
+  listLocalizedMonths,
+  getDaysInMonth,
   formatDate,
   isValidYear,
   isValidDay,
   isValidMonth,
+  locale,
   Hello
 };

workspaces/docs/docs/Helpers/getCalendarYear.mdx workspaces/docs/docs/Helpers/listCalendarYear.mdx

@@ -1,19 +1,21 @@
 ---
-title: getCalendarYear
-slug: /helpers/getCalendarYear
+
+title: listCalendarYear
+slug: /helpers/listCalendarYear
 ---
 
 import {ArgDescriptor} from '../../src/components/ArgDescriptor';
 
-# `getCalendarYear`  
+# `listCalendarYear`  
 
-The getCalendarYear function generates an object representing a calendar year with a list of days for each month.
+The listCalendarYear function generates an object representing a calendar year with a list of days for each month.
 
 ## Usage Example
+
 ```js
-import { getCalendarYear } from 'calendar-widgets';
+import { listCalendarYear } from 'calendar-widgets';
 
-const calendar = getCalendarYear(2023);
+const calendar = listCalendarYear(2023);
 console.log(calendar);
 /*
 Output:

workspaces/docs/docs/changelog.md

@@ -11,11 +11,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## 0.0.10
+
+### Changed
+- [Changed `getCalendarYear` to `listCalendarYear`](https://github.com/9mbs/calendar-widgets/issues/130)
 - [Changed build output from `es` to `umd` for better support](https://github.com/9mbs/calendar-widgets/issues/120)
-- [Added React to Rollup configuration for module bundling](https://github.com/9mbs/calendar-widgets/issues/121)
+- [Changed ESLint Rules](https://github.com/9mbs/calendar-widgets/issues/97). Thanks, [@giri-madhan](https://github.com/giri-madhan)
+
+### Added
 - [Added new method `listLocalizedMonths`](https://github.com/9mbs/calendar-widgets/issues/121)
+- [Added MIT License to NPM package](https://github.com/9mbs/calendar-widgets/issues/125). Thanks, [@bajibpathan](https://github.com/bajibpathan)!
+- [Added React to Rollup configuration for module bundling](https://github.com/9mbs/calendar-widgets/issues/121)
 
-## 0.0.8
+## 0.0.8 & 0.0.9
 
 ### Added 
 

workspaces/docs/docs/introduction.md

@@ -33,8 +33,9 @@ pnpm install calendar-widgets
 Once the package is installed, you'll have access to an array of helpers and utilities that do a lot of the heavy lifting when it comes to dates and calendars. 
 
 ## Helpers
-- [`getCalendarYear`](helpers/getCalendarYear) function
+- [`listCalendarYear`](helpers/listCalendarYear) function
 - [`listDaysInMonth`](helpers/listDaysInMonth) function
+- `listLocalizedMonths` function
 
 ## Utilities
 - [`formatDate`](utilities/formatDate) function

workspaces/docs/docs/road-map.md

@@ -10,7 +10,7 @@ slug: /road-map
 **Goal:** Launch the `calendar-widgets` SDK for production use. Develop three slightly opinionated React-based widgets, including the Calendar Widget, Interactive Calendar Widget, and Draggable Timeline Widget, while localizing the interfaces and documentation for each widget.
 
 - [ ] Lift helpers and utilities for use in Production
-  - [ ] [`getCalendarYear`](helpers/getCalendarYear) function
+  - [ ] [`listCalendarYear`](helpers/listCalendarYear) function
   - [ ] [`listDaysInMonth`](helpers/listDaysInMonth) function
   - [ ] [`formatDate`](utilities/formatDate) function
   - [ ] [`getDaysInMonth`](utilities/getDaysInMonth) function

workspaces/tests/pnpm-lock.yaml

@@ -1,19 +1,19 @@
 /** Dependencies */
 import {
-  getCalendarYear,
+  listCalendarYear,
   listDaysInMonth,
   locale
 } from 'calendar-widgets';
 
-describe('getCalendarYear', () => {
+describe('listCalendarYear', () => {
   it('should throw an Error for an invalid year', () => {
     const invalidYear = 1850;
-    expect(() => getCalendarYear(invalidYear)).toThrow(Error, 'Invalid year, must be between 1900 and 2100.');
+    expect(() => listCalendarYear(invalidYear)).toThrow(Error, 'Invalid year, must be between 1900 and 2100.');
   });
 
   it('should return a calendar object for a valid year', () => {
     const validYear = 2022;
-    const result = getCalendarYear(validYear);
+    const result = listCalendarYear(validYear);
     expect(result).toBeInstanceOf(Object);
 
     for (let month = 1; month <= 12; month++) {