colombian-holidays 1.8.0 → 1.8.1

package/README.md

@@ -66,23 +66,71 @@ The content of the `colombianHolidays2015` variable will be the following array:
 ```
 <!-- prettier-ignore-end -->
 
+You can opt-in to have the function return native JavaScript dates instead of strings for the `date` and `celebrationDate` properties by using the `returnNativeDate` option:
+
+<!-- prettier-ignore-start -->
+
+```js
+const colombianHolidays2015 = colombianHolidays(2015, { returnNativeDate });
+```
+
 If the year is omitted, by default the function will return the holidays for the current year:
 
 ```js
 const currentYearHolidays = colombianHolidays();
 ```
 
-### TypeScript
+## Utils
 
-The module is written in TypeScript and type definitions files are included.
+The package provides two helper functions which can be imported from `lib/utils`:
+
+### isHoliday
 
-## Contributing
+Returns true if the given date is a colombian holiday, otherwise returns false.
 
-Contributions, issues and feature requests are welcome!
+```js
+import { isHoliday } from 'colombian-holidays/lib/utils/isHoliday`
+
+const date = new Date("2018-01-01T05:00:00.000Z")
 
-## Show your support
+if (isHoliday(date)) {
+  console.log('it is a colombian holiday');
+} else {
+  console.log('it is NOT a colombian holiday');
+}
+```
 
-Give a ⭐️ if you like this project!
+### holidaysWithinInterval
+
+Returns an with the colombian holidays within two dates:
+
+```js
+import { holidaysWithinInterval } from 'colombian-holidays/lib/utils/holidaysWithinInterval`
+
+const start = new Date("2021-01-01");
+const end = new Date("2021-01-11");
+const holidays = holidaysWithinInterval({ start, end });
+/*
+[
+  {
+    celebrationDate: "2021-01-01",
+    date: "2021-01-01",
+    name: "Año Nuevo",
+    nextMonday: false,
+  },
+  {
+    celebrationDate: "2021-01-11",
+    date: "2021-01-06",
+    name: "Reyes Magos",
+    nextMonday: true,
+  },
+]
+*/
+```
+
+### TypeScript
+
+The module is written in TypeScript and type definitions files are included.
 
 ## License
 

package/lib/helpers.d.ts

@@ -0,0 +1,4 @@
+import type { Holiday, ColombianHoliday } from "./types";
+export declare const NEW_HOLIDAY_SCHEMA_START_YEAR = 1984;
+declare function getHoliday(holiday: Holiday, year: number): ColombianHoliday;
+export default getHoliday;

package/lib/helpers.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NEW_HOLIDAY_SCHEMA_START_YEAR = void 0;
+const pascua_1 = __importDefault(require("pascua"));
+// 1984 is the year when the current holidays scheme is enforced
+// http://www.alcaldiabogota.gov.co/sisjur/normas/Norma1.jsp?i=4954
+exports.NEW_HOLIDAY_SCHEMA_START_YEAR = 1984;
+function getNextDayOfWeek(date, dayOfWeek) {
+    const resultDate = new Date(date);
+    resultDate.setDate(date.getDate() + ((7 + dayOfWeek - date.getDay()) % 7));
+    return resultDate;
+}
+function getNextMonday(date) {
+    const MONDAY = 1;
+    return getNextDayOfWeek(date, MONDAY);
+}
+function isEasterHoliday(holiday) {
+    return "offset" in holiday;
+}
+function getHolidayDate(holiday, year) {
+    if (isEasterHoliday(holiday)) {
+        const { month, day } = (0, pascua_1.default)(year);
+        return new Date(year, month - 1, day + holiday.offset);
+    }
+    const [month, day] = holiday.date.split("-");
+    return new Date(year, Number(month) - 1, Number(day));
+}
+function formatDate(date) {
+    const year = date.getFullYear();
+    const month = String(date.getMonth() + 1).padStart(2, "0");
+    const day = String(date.getDate()).padStart(2, "0");
+    return `${year}-${month}-${day}`;
+}
+function getHoliday(holiday, year) {
+    const holidayDate = getHolidayDate(holiday, year);
+    const celebrationDate = year >= exports.NEW_HOLIDAY_SCHEMA_START_YEAR && holiday.nextMonday
+        ? getNextMonday(holidayDate)
+        : holidayDate;
+    return {
+        date: formatDate(holidayDate),
+        celebrationDate: formatDate(celebrationDate),
+        name: holiday.name,
+        nextMonday: year >= exports.NEW_HOLIDAY_SCHEMA_START_YEAR && holiday.nextMonday,
+    };
+}
+exports.default = getHoliday;
+//# sourceMappingURL=helpers.js.map

package/lib/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAG5B,gEAAgE;AAChE,mEAAmE;AACtD,QAAA,6BAA6B,GAAG,IAAI,CAAC;AAElD,SAAS,gBAAgB,CAAC,IAAU,EAAE,SAAiB;IACrD,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3E,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,aAAa,CAAC,IAAU;IAC/B,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,OAAO,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,eAAe,CAAC,OAAgB;IACvC,OAAO,QAAQ,IAAI,OAAO,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,OAAgB,EAAE,IAAY;IACpD,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE;QAC5B,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;QACpC,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;KACxD;IAED,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7C,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,UAAU,CAAC,IAAU;IAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpD,OAAO,GAAG,IAAI,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CAAC,OAAgB,EAAE,IAAY;IAChD,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClD,MAAM,eAAe,GACnB,IAAI,IAAI,qCAA6B,IAAI,OAAO,CAAC,UAAU;QACzD,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC;QAC5B,CAAC,CAAC,WAAW,CAAC;IAClB,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC;QAC7B,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;QAC5C,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,UAAU,EAAE,IAAI,IAAI,qCAA6B,IAAI,OAAO,CAAC,UAAU;KACxE,CAAC;AACJ,CAAC;AAED,kBAAe,UAAU,CAAC"}

package/lib/holidays.d.ts

@@ -0,0 +1,3 @@
+import type { DateHoliday, EasterHoliday } from "./types";
+declare const _default: (DateHoliday | EasterHoliday)[];
+export default _default;

package/lib/holidays.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dateHolidays = [
+    { date: "01-01", name: "Año Nuevo", nextMonday: false },
+    { date: "05-01", name: "Día del Trabajo", nextMonday: false },
+    { date: "07-20", name: "Grito de la Independencia", nextMonday: false },
+    { date: "08-07", name: "Batalla de Boyacá", nextMonday: false },
+    { date: "12-08", name: "Inmaculada Concepción", nextMonday: false },
+    { date: "12-25", name: "Navidad", nextMonday: false },
+    { date: "01-06", name: "Reyes Magos", nextMonday: true },
+    { date: "03-19", name: "San José", nextMonday: true },
+    { date: "06-29", name: "San Pedro y San Pablo", nextMonday: true },
+    { date: "08-15", name: "Asunción de la Virgen", nextMonday: true },
+    { date: "10-12", name: "Día de la Raza", nextMonday: true },
+    { date: "11-01", name: "Todos los Santos", nextMonday: true },
+    { date: "11-11", name: "Independencia de Cartagena", nextMonday: true },
+];
+// We could simplify the calculation by setting the offset to match Monday.
+// For example, the date for the 'Corpus Christi' is 60 days after Easter
+// and that's the date it is celebrated in most countries. In Colombia,
+// that date is moved to the next monday, hence, we use 60 for the offset
+// and then get the next monday instead of directly using 64 as the offset.
+// https://www.alcaldiabogota.gov.co/sisjur/normas/Norma1.jsp?i=4954
+const easterHolidays = [
+    { offset: -3, name: "Jueves Santo", nextMonday: false },
+    { offset: -2, name: "Viernes Santo", nextMonday: false },
+    { offset: 39, name: "Ascensión del Señor", nextMonday: true },
+    { offset: 60, name: "Corpus Christi", nextMonday: true },
+    { offset: 68, name: "Sagrado Corazón de Jesús", nextMonday: true },
+];
+exports.default = [...dateHolidays, ...easterHolidays];
+//# sourceMappingURL=holidays.js.map

package/lib/holidays.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"holidays.js","sourceRoot":"","sources":["../src/holidays.ts"],"names":[],"mappings":";;AAEA,MAAM,YAAY,GAAkB;IAClC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,EAAE;IACvD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAE,UAAU,EAAE,KAAK,EAAE;IAC7D,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,2BAA2B,EAAE,UAAU,EAAE,KAAK,EAAE;IACvE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,UAAU,EAAE,KAAK,EAAE;IAC/D,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,UAAU,EAAE,KAAK,EAAE;IACnE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE;IACrD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,IAAI,EAAE;IACxD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE;IACrD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,UAAU,EAAE,IAAI,EAAE;IAClE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,UAAU,EAAE,IAAI,EAAE;IAClE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE;IAC3D,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,UAAU,EAAE,IAAI,EAAE;IAC7D,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,4BAA4B,EAAE,UAAU,EAAE,IAAI,EAAE;CACxE,CAAC;AAEF,2EAA2E;AAC3E,yEAAyE;AACzE,uEAAuE;AACvE,yEAAyE;AACzE,2EAA2E;AAC3E,oEAAoE;AACpE,MAAM,cAAc,GAAoB;IACtC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,KAAK,EAAE;IACvD,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,UAAU,EAAE,KAAK,EAAE;IACxD,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,UAAU,EAAE,IAAI,EAAE;IAC7D,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE;IACxD,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,UAAU,EAAE,IAAI,EAAE;CACnE,CAAC;AAEF,kBAAe,CAAC,GAAG,YAAY,EAAE,GAAG,cAAc,CAAC,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+import { ColombianHoliday } from "./types";
+export declare const FIRST_HOLIDAY_YEAR = 1583;
+export declare const LAST_HOLIDAY_YEAR = 4099;
+declare function colombianHolidays(year?: number): ColombianHoliday[];
+export default colombianHolidays;

package/lib/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LAST_HOLIDAY_YEAR = exports.FIRST_HOLIDAY_YEAR = void 0;
+const helpers_1 = __importDefault(require("./helpers"));
+const holidays_1 = __importDefault(require("./holidays"));
+// pascua package year limits
+exports.FIRST_HOLIDAY_YEAR = 1583;
+exports.LAST_HOLIDAY_YEAR = 4099;
+function colombianHolidays(year = new Date().getFullYear()) {
+    if (year < exports.FIRST_HOLIDAY_YEAR || year > exports.LAST_HOLIDAY_YEAR) {
+        throw new Error(`The year should be between ${exports.FIRST_HOLIDAY_YEAR} and ${exports.LAST_HOLIDAY_YEAR}`);
+    }
+    return holidays_1.default
+        .map((holiday) => (0, helpers_1.default)(holiday, year))
+        .sort((a, b) => a.celebrationDate.localeCompare(b.celebrationDate));
+}
+exports.default = colombianHolidays;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAmC;AACnC,0DAAkC;AAGlC,6BAA6B;AAChB,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAC1B,QAAA,iBAAiB,GAAG,IAAI,CAAC;AAEtC,SAAS,iBAAiB,CACxB,OAAe,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;IAEvC,IAAI,IAAI,GAAG,0BAAkB,IAAI,IAAI,GAAG,yBAAiB,EAAE;QACzD,MAAM,IAAI,KAAK,CACb,8BAA8B,0BAAkB,QAAQ,yBAAiB,EAAE,CAC5E,CAAC;KACH;IAED,OAAO,kBAAQ;SACZ,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,iBAAU,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAC3C,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,kBAAe,iBAAiB,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,15 @@
+export interface BasicHoliday {
+    name: string;
+    nextMonday: boolean;
+}
+export interface DateHoliday extends BasicHoliday {
+    date: string;
+}
+export interface EasterHoliday extends BasicHoliday {
+    offset: number;
+}
+export interface ColombianHoliday extends BasicHoliday {
+    date: string;
+    celebrationDate: string;
+}
+export type Holiday = DateHoliday | EasterHoliday;

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib/utils.d.ts

@@ -0,0 +1 @@
+export declare function isHoliday(date: Date): boolean;

package/lib/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHoliday = void 0;
+const _1 = __importDefault(require("."));
+function isHoliday(date) {
+    return (0, _1.default)(date.getUTCFullYear()).some(({ celebrationDate }) => {
+        const d = new Date(celebrationDate);
+        return (d.getUTCDate() === date.getUTCDate() &&
+            d.getUTCMonth() === date.getUTCMonth() &&
+            d.getUTCFullYear() === date.getUTCFullYear());
+    });
+}
+exports.isHoliday = isHoliday;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAkC;AAElC,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,IAAA,UAAiB,EAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAClD,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE;QACtB,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;QACpC,OAAO,CACL,CAAC,CAAC,UAAU,EAAE,KAAK,IAAI,CAAC,UAAU,EAAE;YACpC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE;YACtC,CAAC,CAAC,cAAc,EAAE,KAAK,IAAI,CAAC,cAAc,EAAE,CAC7C,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAXD,8BAWC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "colombian-holidays",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "description": "Colombian holidays",
   "main": "lib/index.js",
   "scripts": {