lease-term-calculator 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sher Ghan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# lease-term-calculator
+
+Calculate lease term duration in years and days.
+
+## Installation
+
+```bash
+npm install lease-term-calculator
+```
+
+## Usage
+
+```typescript
+import calculator from 'lease-term-calculator';
+// or
+import { DateCalculator } from 'lease-term-calculator';
+
+const calc = new DateCalculator();
+```
+
+### parseUIDate
+
+Parses and validates date components.
+
+```typescript
+const date = calculator.parseUIDate(2024, 6, 15);
+// Returns: Date object, '' (empty input), or 'bad date'
+```
+
+### calculateTermOfLease
+
+Calculates the lease term between dates.
+
+```typescript
+const effective = new Date(2024, 0, 1);
+const start = new Date(2024, 0, 1);
+const end = new Date(2026, 5, 30);
+
+const result = calculator.calculateTermOfLease(effective, start, end);
+// Returns: { years: 2, days: 181, daysInPartialYear: 365 }
+```
+
+**Parameters:**
+- `effectiveDate` - The effective date (lease won't start before this)
+- `startDate` - The lease start date
+- `endDate` - The lease end date
+
+**Returns:**
+- `years` - Number of complete years
+- `days` - Number of additional days beyond complete years
+- `daysInPartialYear` - Total days in the partial year (for calculating fractions)
+
+## License
+
+MIT

package/dist/DateCalculator.d.ts

@@ -0,0 +1,10 @@
+export interface LeaseTermResult {
+    years: number;
+    days: number;
+    daysInPartialYear: number;
+}
+export type ParseDateResult = Date | '' | 'bad date';
+export declare class DateCalculator {
+    parseUIDate(year: string | number | null | undefined, month: string | number | null | undefined, day: string | number | null | undefined): ParseDateResult;
+    calculateTermOfLease(effectiveDate: Date, startDate: Date, endDate: Date): LeaseTermResult;
+}

package/dist/DateCalculator.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateCalculator = void 0;
+class DateCalculator {
+    parseUIDate(year, month, day) {
+        const yearStr = String(year || 'empty');
+        const monthStr = String(month || 'empty');
+        const dayStr = String(day || 'empty');
+        if (yearStr + monthStr + dayStr === 'emptyemptyempty') {
+            return '';
+        }
+        const date = new Date(Number(year), Number(month) - 1, Number(day));
+        if (isNaN(date.getTime())) {
+            return 'bad date';
+        }
+        if (!/^\d{4}$/.test(String(year))) {
+            return 'bad date';
+        }
+        if (date.getFullYear() !== Number(year) ||
+            date.getMonth() !== Number(month) - 1 ||
+            date.getDate() !== Number(day)) {
+            return 'bad date';
+        }
+        return date;
+    }
+    calculateTermOfLease(effectiveDate, startDate, endDate) {
+        let start = startDate;
+        const end = endDate;
+        let years = 0;
+        let days = 0;
+        let daysInPartialYear = 0;
+        if (startDate < effectiveDate) {
+            start = effectiveDate;
+        }
+        const addYearAndGetEndDate = (date, yearsToAdd) => {
+            const newDate = new Date(date.getFullYear() + yearsToAdd, date.getMonth(), date.getDate());
+            newDate.setDate(newDate.getDate() - 1);
+            return newDate;
+        };
+        let testDate = addYearAndGetEndDate(start, (years = 1));
+        while (testDate <= end) {
+            testDate = addYearAndGetEndDate(start, ++years);
+        }
+        years--;
+        testDate = addYearAndGetEndDate(start, years);
+        days = 1;
+        if (start.getDate() === 29 && start.getMonth() === 1 && years % 4 !== 0) {
+            testDate.setDate(testDate.getDate() - 1);
+        }
+        testDate.setDate(testDate.getDate() + 1);
+        while (testDate <= end) {
+            days++;
+            testDate.setDate(testDate.getDate() + 1);
+        }
+        days--;
+        if (days > 0) {
+            const yearEndDate = addYearAndGetEndDate(start, years + 1);
+            daysInPartialYear = 1;
+            testDate = addYearAndGetEndDate(start, years);
+            testDate.setDate(testDate.getDate() + 1);
+            while (testDate <= yearEndDate) {
+                daysInPartialYear++;
+                testDate.setDate(testDate.getDate() + 1);
+            }
+            daysInPartialYear--;
+        }
+        return {
+            years,
+            days,
+            daysInPartialYear,
+        };
+    }
+}
+exports.DateCalculator = DateCalculator;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { DateCalculator } from './DateCalculator';
+export { DateCalculator } from './DateCalculator';
+export type { LeaseTermResult, ParseDateResult } from './DateCalculator';
+declare const calculator: DateCalculator;
+export default calculator;

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateCalculator = void 0;
+const DateCalculator_1 = require("./DateCalculator");
+var DateCalculator_2 = require("./DateCalculator");
+Object.defineProperty(exports, "DateCalculator", { enumerable: true, get: function () { return DateCalculator_2.DateCalculator; } });
+const calculator = new DateCalculator_1.DateCalculator();
+exports.default = calculator;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "lease-term-calculator",
+  "version": "1.0.0",
+  "description": "Calculate lease term duration in years and days, with support for partial year calculations",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "lease",
+    "term",
+    "calculator",
+    "date",
+    "duration",
+    "rental",
+    "property",
+    "real-estate",
+    "accounting",
+    "finance",
+    "sdlt",
+    "hmrc"
+  ],
+  "author": {
+    "name": "Sher Ghan",
+    "url": "https://github.com/sherghan7",
+    "email": "sherghan7@gmail.com",
+    "github": "https://github.com/sherghan7",
+    "linkedin": "https://www.linkedin.com/in/bu-fahad/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sherghan7/lease-term-calculator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sherghan7/lease-term-calculator/issues"
+  },
+  "homepage": "https://github.com/sherghan7/lease-term-calculator#readme",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.0"
+  }
+}