colombian-holidays 4.0.1 → 4.1.0

package/README.md

@@ -17,7 +17,7 @@ npm install colombian-holidays
 
 ## Usage
 
-The default export is a function to get all the holidays for a given year, returning an array with the holidays for the requested year.
+The default export is a function to get all the holidays for a given year.
 
 The `year` should be between 1583 and 4099 (see [Pascua](https://github.com/MauricioRobayo/pascua) package).
 
@@ -231,9 +231,7 @@ If the year is omitted, by default the function will return the holidays for the
 
 ```js
 const currentYearHolidaysAsStrings = colombianHolidays();
-const currentYearHolidaysAsDates = colombianHolidays({
-  valueAsDate: true,
-});
+const currentYearHolidaysAsDates = colombianHolidays({ valueAsDate: true });
 ```
 
 ## Utils
@@ -242,12 +240,12 @@ The package provides two helper functions which can be imported from `lib/utils`
 
 ### isHoliday
 
-Returns true if the given date is a colombian holiday, otherwise returns false.
+Returns `true` if the given date is a colombian holiday, otherwise returns `false`.
 
 ```js
 import { isHoliday } from "colombian-holidays/lib/utils/isHoliday";
 
-const date = new Date("2018-01-01T05:00:00.000Z");
+const date = new Date("2018-01-01");
 
 if (isHoliday(date)) {
   console.log("it is a colombian holiday");
@@ -256,9 +254,35 @@ if (isHoliday(date)) {
 }
 ```
 
+### getHoliday
+
+Similar to `isHoliday` but will return the corresponding holiday for a given date or `null` if there is no matching holiday.
+
+```js
+import { getHoliday } from "colombian-holidays/lib/utils/getHoliday";
+
+const date = new Date("2018-01-01");
+
+const newYear = getHoliday(date);
+/*
+  {
+    celebrationDate: "2018-01-01",
+    date: "2018-01-01",
+    name: { en: "New Year's Day", es: "Año Nuevo" },
+    nextMonday: false,
+  }
+*/
+```
+
+To get the values as date use the options argument:
+
+```js
+const newYearAsDate = getHoliday(date, { valueAsDate: true });
+```
+
 ### holidaysWithinInterval
 
-Returns an with the colombian holidays within two dates:
+Returns an array with the colombian holidays within two dates:
 
 ```js
 import { holidaysWithinInterval } from "colombian-holidays/lib/utils/holidaysWithinInterval";
@@ -266,6 +290,7 @@ import { holidaysWithinInterval } from "colombian-holidays/lib/utils/holidaysWit
 const start = new Date("2021-01-01");
 const end = new Date("2021-01-11");
 const holidays = holidaysWithinInterval({ start, end });
+// const holidays = holidaysWithinInterval({ start, end, valueAsDate: true });
 ```
 
 returns:

package/lib/helpers.d.ts

@@ -1,5 +1,6 @@
 import type { Holiday, ColombianHoliday, ColombianHolidayWithNativeDate } from "./types";
 export declare const NEW_HOLIDAY_SCHEMA_START_YEAR = 1984;
+export declare function generateUtcStringFromDate(date: Date): string;
 declare function getHoliday(holiday: Holiday, options?: {
     year?: number;
     valueAsDate: false | undefined;

package/lib/helpers.js

@@ -3,7 +3,7 @@ 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;
+exports.generateUtcStringFromDate = 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
@@ -35,6 +35,7 @@ function generateUtcStringFromDateParts(year, month, day) {
 function generateUtcStringFromDate(date) {
     return generateUtcStringFromDateParts(date.getUTCFullYear(), date.getUTCMonth() + 1, date.getUTCDate());
 }
+exports.generateUtcStringFromDate = generateUtcStringFromDate;
 function getHoliday(holiday, { year = new Date().getUTCFullYear(), valueAsDate = false, } = {}) {
     const holidayDate = getHolidayDate(holiday, year);
     const celebrationDate = year >= exports.NEW_HOLIDAY_SCHEMA_START_YEAR && holiday.nextMonday

package/lib/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAQ5B,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,UAAU,CACnB,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC,CAC7D,CAAC;IACF,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,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;KACb;IAED,OAAO,IAAI,IAAI,CACb,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CACrC,IAAY,EACZ,KAAa,EACb,GAAW;IAEX,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CACtE,CAAC,EACD,GAAG,CACJ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAU;IAC3C,OAAO,8BAA8B,CACnC,IAAI,CAAC,cAAc,EAAE,EACrB,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,UAAU,EAAE,CAClB,CAAC;AACJ,CAAC;AAcD,SAAS,UAAU,CACjB,OAAgB,EAChB,EACE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAClC,WAAW,GAAG,KAAK,MACyB,EAAE;IAEhD,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;IAElB,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,yBAAyB,CAAC,WAAW,CAAC;QACxE,eAAe,EAAE,WAAW;YAC1B,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,yBAAyB,CAAC,eAAe,CAAC;QAC9C,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,UAAU,EAAE,IAAI,IAAI,qCAA6B,IAAI,OAAO,CAAC,UAAU;KACxE,CAAC;AACJ,CAAC;AAED,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAQ5B,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,UAAU,CACnB,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC,CAC7D,CAAC;IACF,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,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;KACb;IAED,OAAO,IAAI,IAAI,CACb,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CACrC,IAAY,EACZ,KAAa,EACb,GAAW;IAEX,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CACtE,CAAC,EACD,GAAG,CACJ,EAAE,CAAC;AACN,CAAC;AAED,SAAgB,yBAAyB,CAAC,IAAU;IAClD,OAAO,8BAA8B,CACnC,IAAI,CAAC,cAAc,EAAE,EACrB,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,UAAU,EAAE,CAClB,CAAC;AACJ,CAAC;AAND,8DAMC;AAcD,SAAS,UAAU,CACjB,OAAgB,EAChB,EACE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAClC,WAAW,GAAG,KAAK,MACyB,EAAE;IAEhD,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;IAElB,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,yBAAyB,CAAC,WAAW,CAAC;QACxE,eAAe,EAAE,WAAW;YAC1B,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,yBAAyB,CAAC,eAAe,CAAC;QAC9C,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/utils/getHoliday.d.ts

@@ -0,0 +1,7 @@
+import { ColombianHoliday, ColombianHolidayWithNativeDate } from "../types";
+export declare function getHoliday(date: Date, options: {
+    valueAsDate: true;
+}): ColombianHolidayWithNativeDate;
+export declare function getHoliday(date: Date, options?: undefined | {
+    valueAsDate: false;
+}): ColombianHoliday;

package/lib/utils/getHoliday.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHoliday = void 0;
+const __1 = __importDefault(require(".."));
+const helpers_1 = require("../helpers");
+const helpers_2 = require("./helpers");
+function getHoliday(date, options = { valueAsDate: false }) {
+    const { valueAsDate } = options;
+    const holiday = (0, __1.default)({
+        year: date.getUTCFullYear(),
+        valueAsDate: true,
+    }).find(({ celebrationDate }) => (0, helpers_2.isSameDate)(celebrationDate, date));
+    if (!holiday) {
+        return null;
+    }
+    if (valueAsDate) {
+        return holiday;
+    }
+    return {
+        ...holiday,
+        date: (0, helpers_1.generateUtcStringFromDate)(holiday.date),
+        celebrationDate: (0, helpers_1.generateUtcStringFromDate)(holiday.celebrationDate),
+    };
+}
+exports.getHoliday = getHoliday;
+//# sourceMappingURL=getHoliday.js.map

package/lib/utils/getHoliday.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getHoliday.js","sourceRoot":"","sources":["../../src/utils/getHoliday.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AACnC,wCAAuD;AAEvD,uCAAuC;AAUvC,SAAgB,UAAU,CACxB,IAAU,EACV,UAAoC,EAAE,WAAW,EAAE,KAAK,EAAE;IAE1D,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,OAAO,GAAG,IAAA,WAAiB,EAAC;QAChC,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE;QAC3B,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,IAAA,oBAAU,EAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,IAAI,CAAC;KACb;IAED,IAAI,WAAW,EAAE;QACf,OAAO,OAAO,CAAC;KAChB;IACD,OAAO;QACL,GAAG,OAAO;QACV,IAAI,EAAE,IAAA,mCAAyB,EAAC,OAAO,CAAC,IAAI,CAAC;QAC7C,eAAe,EAAE,IAAA,mCAAyB,EAAC,OAAO,CAAC,eAAe,CAAC;KACpE,CAAC;AACJ,CAAC;AArBD,gCAqBC"}

package/lib/utils/helpers.d.ts

@@ -0,0 +1 @@
+export declare function isSameDate(date1: Date, date2: Date): boolean;

package/lib/utils/helpers.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSameDate = void 0;
+function isSameDate(date1, date2) {
+    return (date1.getUTCDate() === date2.getUTCDate() &&
+        date1.getUTCMonth() === date2.getUTCMonth() &&
+        date1.getUTCFullYear() === date2.getUTCFullYear());
+}
+exports.isSameDate = isSameDate;
+//# sourceMappingURL=helpers.js.map

package/lib/utils/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":";;;AAAA,SAAgB,UAAU,CAAC,KAAW,EAAE,KAAW;IACjD,OAAO,CACL,KAAK,CAAC,UAAU,EAAE,KAAK,KAAK,CAAC,UAAU,EAAE;QACzC,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE;QAC3C,KAAK,CAAC,cAAc,EAAE,KAAK,KAAK,CAAC,cAAc,EAAE,CAClD,CAAC;AACJ,CAAC;AAND,gCAMC"}

package/lib/utils/isHoliday.js

@@ -5,13 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isHoliday = void 0;
 const __1 = __importDefault(require(".."));
+const helpers_1 = require("./helpers");
 function isHoliday(date) {
-    return (0, __1.default)({ year: date.getUTCFullYear() }).some(({ celebrationDate }) => {
-        const d = new Date(celebrationDate);
-        return (d.getUTCDate() === date.getUTCDate() &&
-            d.getUTCMonth() === date.getUTCMonth() &&
-            d.getUTCFullYear() === date.getUTCFullYear());
-    });
+    return (0, __1.default)({
+        year: date.getUTCFullYear(),
+        valueAsDate: true,
+    }).some(({ celebrationDate }) => (0, helpers_1.isSameDate)(celebrationDate, date));
 }
 exports.isHoliday = isHoliday;
 //# sourceMappingURL=isHoliday.js.map

package/lib/utils/isHoliday.js.map

@@ -1 +1 @@
-{"version":3,"file":"isHoliday.js","sourceRoot":"","sources":["../../src/utils/isHoliday.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AAEnC,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,IAAA,WAAiB,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,IAAI,CAC5D,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"}
+{"version":3,"file":"isHoliday.js","sourceRoot":"","sources":["../../src/utils/isHoliday.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AACnC,uCAAuC;AAEvC,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,IAAA,WAAiB,EAAC;QACvB,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE;QAC3B,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,IAAA,oBAAU,EAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;AACtE,CAAC;AALD,8BAKC"}

package/package.json

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