[luxon-business-days] New type definitions

types/luxon-business-days/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/luxon-business-days/index.d.ts

@@ -0,0 +1,40 @@
+import { DateTime } from "luxon";
+
+export type BusinessDayNumbers = 1 | 2 | 3 | 4 | 5 | 6 | 7;
+export type BusinessDays = BusinessDayNumbers[];
+
+export type HolidayMatcher = (inst: DateTime<boolean>) => boolean;
+export interface HolidayMatchersDict {
+    [key: string]: HolidayMatcher;
+}
+
+export type HolidayHelper = (...args: any[]) => any;
+export interface HolidayHelpersDict {
+    [key: string]: HolidayHelper;
+}
+
+declare module "luxon" {
+    interface DateTime<IsValid extends boolean> {
+        holidayHelpers: HolidayHelper[] | undefined;
+        holidayMatchers: HolidayMatcher[] | undefined;
+        availableHolidayHelpers: HolidayHelpersDict;
+        availableHolidayMatchers: HolidayMatchersDict;
+
+        setupBusiness(opts?: {
+            businessDays?: BusinessDays;
+            holidayMatchers?: HolidayMatcher[];
+        }): void;
+
+        clearBusinessSetup(): void;
+
+        isHoliday(...args: any[]): boolean;
+
+        isBusinessDay(): boolean;
+
+        plusBusiness(opts?: { days?: number }): this;
+
+        minusBusiness(opts?: { days?: number }): this;
+    }
+}
+
+export { DateTime };

types/luxon-business-days/luxon-business-days-tests.ts

@@ -0,0 +1,28 @@
+import { DateTime } from "luxon-business-days";
+
+const now = DateTime.now(); // $ExpectType DateTime<true>
+
+now.isBusinessDay(); // $ExpectType boolean
+now.isHoliday(); // $ExpectType boolean
+now.isHoliday("args"); // $ExpectType boolean
+
+// @ts-expect-error
+now.plusBusiness(5);
+now.plusBusiness(); // $ExpectType DateTime<true>
+now.plusBusiness({ days: 1 }); // $ExpectType DateTime<true>
+
+// @ts-expect-error
+now.minusBusiness(1);
+now.minusBusiness(); // $ExpectType DateTime<true>
+now.minusBusiness({ days: 1 }); // $ExpectType DateTime<true>
+
+now.setupBusiness(); // $ExpectType void
+now.setupBusiness({ businessDays: [1, 2, 3] }); // $ExpectType void
+now.setupBusiness({ holidayMatchers: [(d: DateTime) => false] }); // $ExpectType void
+now.setupBusiness({ businessDays: [1, 2, 3], holidayMatchers: [(d: DateTime) => false] }); // $ExpectType void
+now.clearBusinessSetup(); // $ExpectType void
+
+now.holidayHelpers; // $ExpectType HolidayHelper[] | undefined
+now.holidayMatchers; // $ExpectType HolidayMatcher[] | undefined
+now.availableHolidayHelpers; // $ExpectType HolidayHelpersDict
+now.availableHolidayMatchers; // $ExpectType HolidayMatchersDict

types/luxon-business-days/package.json

@@ -0,0 +1,21 @@
+{
+    "private": true,
+    "name": "@types/luxon-business-days",
+    "version": "3.0.9999",
+    "minimumTypeScriptVersion": "4.9",
+    "projects": [
+        "https://github.com/amaidah/luxon-business-days#readme"
+    ],
+    "dependencies": {
+        "@types/luxon": "*"
+    },
+    "devDependencies": {
+        "@types/luxon-business-days": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Bradley C Bailey",
+            "githubUsername": "bcbailey"
+        }
+    ]
+}

types/luxon-business-days/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "luxon-business-days-tests.ts"
+    ]
+}