@bgord/tools 0.14.1 → 0.14.3

package/dist/age.vo.d.ts

@@ -0,0 +1,27 @@
+import { z } from "zod/v4";
+import type { TimestampType } from "./timestamp.vo";
+export declare const AgeValueError: {
+    error: string;
+};
+export declare class Age {
+    private readonly value;
+    static readonly MIN = 1;
+    static readonly MAX = 130;
+    static readonly AgeValue: z.core.$ZodBranded<z.ZodNumber, "AgeValue">;
+    private constructor();
+    get(): number;
+    compare(other: Age): -1 | 0 | 1;
+    equals(another: Age): boolean;
+    isOlderThan(another: Age): boolean;
+    isYoungerThan(another: Age): boolean;
+    isAdult(minAge: Age): boolean;
+    static fromValue(candidate: number): Age;
+    static fromBirthdateTimestamp(params: {
+        birthdate: TimestampType;
+        now: TimestampType;
+    }): Age;
+    static fromBirthdate(params: {
+        birthdate: string;
+        now: TimestampType;
+    }): Age;
+}

package/dist/age.vo.js

@@ -0,0 +1,49 @@
+import { differenceInYears } from "date-fns";
+import { z } from "zod/v4";
+export const AgeValueError = { error: "invalid.age" };
+export class Age {
+    value;
+    static MIN = 1;
+    static MAX = 130;
+    static AgeValue = z
+        .number(AgeValueError)
+        .int(AgeValueError)
+        .min(Age.MIN, AgeValueError)
+        .max(Age.MAX, AgeValueError)
+        .brand("AgeValue");
+    constructor(value) {
+        this.value = value;
+    }
+    get() {
+        return this.value;
+    }
+    compare(other) {
+        return this.value === other.value ? 0 : this.value < other.value ? -1 : 1;
+    }
+    equals(another) {
+        return this.compare(another) === 0;
+    }
+    isOlderThan(another) {
+        return this.compare(another) === 1;
+    }
+    isYoungerThan(another) {
+        return this.compare(another) === -1;
+    }
+    isAdult(minAge) {
+        return this.equals(minAge) || this.isOlderThan(minAge);
+    }
+    static fromValue(candidate) {
+        return new Age(Age.AgeValue.parse(candidate));
+    }
+    static fromBirthdateTimestamp(params) {
+        if (params.birthdate > params.now)
+            throw new Error("invalid.birthdate_in_future");
+        return Age.fromValue(differenceInYears(params.now, params.birthdate));
+    }
+    static fromBirthdate(params) {
+        const birthdate = new Date(params.birthdate).getTime();
+        if (birthdate > params.now)
+            throw new Error("invalid.birthdate_in_future");
+        return Age.fromValue(differenceInYears(params.now, birthdate));
+    }
+}

package/dist/day.vo.d.ts

@@ -4,6 +4,9 @@ import { type TimestampType } from "./timestamp.vo";
 export declare class Day extends DateRange {
     private constructor();
     toIsoId(): DayIsoIdType;
+    previous(): Day;
+    next(): Day;
+    shift(count: number): Day;
     static fromTimestamp(timestamp: TimestampType): Day;
     static fromNow(now: TimestampType): Day;
     static fromIsoId(isoId: DayIsoIdType): Day;

package/dist/day.vo.js

@@ -1,4 +1,4 @@
-import { endOfDay, startOfDay } from "date-fns";
+import { addDays, endOfDay, startOfDay } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { DayIsoId } from "./day-iso-id.vo";
 import { Time } from "./time.service";
@@ -10,6 +10,18 @@ export class Day extends DateRange {
     toIsoId() {
         return new Date(this.getStart() + Time.Hours(12).ms).toISOString().slice(0, 10);
     }
+    previous() {
+        const shifted = addDays(new Date(this.getStart()), -1).getTime();
+        return Day.fromTimestamp(Timestamp.parse(shifted));
+    }
+    next() {
+        const shifted = addDays(new Date(this.getStart()), 1).getTime();
+        return Day.fromTimestamp(Timestamp.parse(shifted));
+    }
+    shift(count) {
+        const shifted = addDays(new Date(this.getStart()), count).getTime();
+        return Day.fromTimestamp(Timestamp.parse(shifted));
+    }
     static fromTimestamp(timestamp) {
         const start = Timestamp.parse(startOfDay(timestamp).getTime());
         const end = Timestamp.parse(endOfDay(timestamp).getTime());

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./age.vo";
 export * from "./api-key.vo";
 export * from "./basename.vo";
 export * from "./clock.vo";

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from "./age.vo";
 export * from "./api-key.vo";
 export * from "./basename.vo";
 export * from "./clock.vo";

package/dist/month.vo.d.ts

@@ -3,6 +3,9 @@ import { type MonthIsoIdType } from "./month-iso-id.vo";
 import { type TimestampType } from "./timestamp.vo";
 export declare class Month extends DateRange {
     toIsoId(): MonthIsoIdType;
+    previous(): Month;
+    next(): Month;
+    shift(count: number): Month;
     static fromTimestamp(timestamp: TimestampType): Month;
     static fromNow(now: TimestampType): Month;
     static fromIsoId(iso: MonthIsoIdType): Month;

package/dist/month.vo.js

@@ -1,4 +1,4 @@
-import { endOfMonth, startOfMonth } from "date-fns";
+import { addMonths, endOfMonth, startOfMonth } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { MonthIsoId } from "./month-iso-id.vo";
 import { Timestamp } from "./timestamp.vo";
@@ -6,6 +6,18 @@ export class Month extends DateRange {
     toIsoId() {
         return new Date(this.getStart()).toISOString().slice(0, 7);
     }
+    previous() {
+        const shifted = addMonths(new Date(this.getStart()), -1).getTime();
+        return Month.fromTimestamp(Timestamp.parse(shifted));
+    }
+    next() {
+        const shifted = addMonths(new Date(this.getStart()), 1).getTime();
+        return Month.fromTimestamp(Timestamp.parse(shifted));
+    }
+    shift(count) {
+        const shifted = addMonths(new Date(this.getStart()), count).getTime();
+        return Month.fromTimestamp(Timestamp.parse(shifted));
+    }
     static fromTimestamp(timestamp) {
         const start = Timestamp.parse(startOfMonth(timestamp).getTime());
         const end = Timestamp.parse(endOfMonth(timestamp).getTime());

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/api-key.vo.ts","../src/basename.vo.ts","../src/clock.vo.ts","../src/date-calculator.service.ts","../src/date-formatter.service.ts","../src/date-range.vo.ts","../src/dates-of-the-week.vo.ts","../src/day-iso-id.vo.ts","../src/day.vo.ts","../src/directory-path-absolute.vo.ts","../src/directory-path-relative.vo.ts","../src/dll.service.ts","../src/email-mask.service.ts","../src/etags.vo.ts","../src/extension.vo.ts","../src/feature-flag.vo.ts","../src/file-path-absolute-schema.vo.ts","../src/file-path-relative-schema.vo.ts","../src/file-path.vo.ts","../src/filename-from-string.vo.ts","../src/filename-suffix.vo.ts","../src/filename.vo.ts","../src/height.vo.ts","../src/hour.vo.ts","../src/iban-mask.service.ts","../src/iban.vo.ts","../src/image.vo.ts","../src/index.ts","../src/language.vo.ts","../src/mean.service.ts","../src/mime-types.vo.ts","../src/mime.vo.ts","../src/min-max-scaler.service.ts","../src/minute.vo.ts","../src/money.vo.ts","../src/month-iso-id.vo.ts","../src/month.vo.ts","../src/noop.service.ts","../src/notification-template.vo.ts","../src/object-key.vo.ts","../src/outlier-detector.service.ts","../src/package-version.vo.ts","../src/pagination.service.ts","../src/percentage.service.ts","../src/population-standard-deviation.service.ts","../src/quarter-iso-id.vo.ts","../src/quarter.vo.ts","../src/random.service.ts","../src/rate-limiter.service.ts","../src/relative-date.vo.ts","../src/reordering.service.ts","../src/revision.vo.ts","../src/rounding.service.ts","../src/simple-linear-regression.service.ts","../src/size.vo.ts","../src/stepper.service.ts","../src/stopwatch.service.ts","../src/streak-calculator.service.ts","../src/sum.service.ts","../src/thousands-separator.service.ts","../src/time-zone-offset-value.vo.ts","../src/time.service.ts","../src/timestamp.vo.ts","../src/timezone.vo.ts","../src/ts-utils.ts","../src/visually-unambiguous-characters-generator.service.ts","../src/week-iso-id.vo.ts","../src/week.vo.ts","../src/weekday.vo.ts","../src/weight.vo.ts","../src/year-iso-id.vo.ts","../src/year.vo.ts","../src/z-score.service.ts"],"version":"5.9.2"}
+{"root":["../src/age.vo.ts","../src/api-key.vo.ts","../src/basename.vo.ts","../src/clock.vo.ts","../src/date-calculator.service.ts","../src/date-formatter.service.ts","../src/date-range.vo.ts","../src/dates-of-the-week.vo.ts","../src/day-iso-id.vo.ts","../src/day.vo.ts","../src/directory-path-absolute.vo.ts","../src/directory-path-relative.vo.ts","../src/dll.service.ts","../src/email-mask.service.ts","../src/etags.vo.ts","../src/extension.vo.ts","../src/feature-flag.vo.ts","../src/file-path-absolute-schema.vo.ts","../src/file-path-relative-schema.vo.ts","../src/file-path.vo.ts","../src/filename-from-string.vo.ts","../src/filename-suffix.vo.ts","../src/filename.vo.ts","../src/height.vo.ts","../src/hour.vo.ts","../src/iban-mask.service.ts","../src/iban.vo.ts","../src/image.vo.ts","../src/index.ts","../src/language.vo.ts","../src/mean.service.ts","../src/mime-types.vo.ts","../src/mime.vo.ts","../src/min-max-scaler.service.ts","../src/minute.vo.ts","../src/money.vo.ts","../src/month-iso-id.vo.ts","../src/month.vo.ts","../src/noop.service.ts","../src/notification-template.vo.ts","../src/object-key.vo.ts","../src/outlier-detector.service.ts","../src/package-version.vo.ts","../src/pagination.service.ts","../src/percentage.service.ts","../src/population-standard-deviation.service.ts","../src/quarter-iso-id.vo.ts","../src/quarter.vo.ts","../src/random.service.ts","../src/rate-limiter.service.ts","../src/relative-date.vo.ts","../src/reordering.service.ts","../src/revision.vo.ts","../src/rounding.service.ts","../src/simple-linear-regression.service.ts","../src/size.vo.ts","../src/stepper.service.ts","../src/stopwatch.service.ts","../src/streak-calculator.service.ts","../src/sum.service.ts","../src/thousands-separator.service.ts","../src/time-zone-offset-value.vo.ts","../src/time.service.ts","../src/timestamp.vo.ts","../src/timezone.vo.ts","../src/ts-utils.ts","../src/visually-unambiguous-characters-generator.service.ts","../src/week-iso-id.vo.ts","../src/week.vo.ts","../src/weekday.vo.ts","../src/weight.vo.ts","../src/year-iso-id.vo.ts","../src/year.vo.ts","../src/z-score.service.ts"],"version":"5.9.3"}

package/dist/week.vo.d.ts

@@ -3,6 +3,9 @@ import { type TimestampType } from "./timestamp.vo";
 import { type WeekIsoIdType } from "./week-iso-id.vo";
 export declare class Week extends DateRange {
     toIsoId(): WeekIsoIdType;
+    previous(): Week;
+    next(): Week;
+    shift(count: number): Week;
     static fromTimestamp(timestamp: TimestampType): Week;
     static fromNow(now: TimestampType): Week;
     static fromIsoId(isoId: WeekIsoIdType): Week;

package/dist/week.vo.js

@@ -1,4 +1,4 @@
-import { endOfISOWeek, getISOWeek, getISOWeekYear, setISOWeek, startOfISOWeek } from "date-fns";
+import { addWeeks, endOfISOWeek, getISOWeek, getISOWeekYear, setISOWeek, startOfISOWeek } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { Timestamp } from "./timestamp.vo";
 import { WeekIsoId } from "./week-iso-id.vo";
@@ -8,6 +8,18 @@ export class Week extends DateRange {
         const week = getISOWeek(this.getStart()).toString().padStart(2, "0");
         return `${year}-W${week}`;
     }
+    previous() {
+        const shifted = addWeeks(new Date(this.getStart()), -1).getTime();
+        return Week.fromTimestamp(Timestamp.parse(shifted));
+    }
+    next() {
+        const shifted = addWeeks(new Date(this.getStart()), 1).getTime();
+        return Week.fromTimestamp(Timestamp.parse(shifted));
+    }
+    shift(count) {
+        const shifted = addWeeks(new Date(this.getStart()), count).getTime();
+        return Week.fromTimestamp(Timestamp.parse(shifted));
+    }
     static fromTimestamp(timestamp) {
         const start = Timestamp.parse(startOfISOWeek(timestamp).getTime());
         const end = Timestamp.parse(endOfISOWeek(timestamp).getTime());

package/dist/year.vo.d.ts

@@ -4,6 +4,9 @@ import { type YearIsoIdType } from "./year-iso-id.vo";
 export declare class Year extends DateRange {
     toIsoId(): YearIsoIdType;
     isLeapYear(): boolean;
+    previous(): Year;
+    next(): Year;
+    shift(count: number): Year;
     static fromTimestamp(timestamp: TimestampType): Year;
     static fromNow(now: TimestampType): Year;
     static fromNumber(value: number): Year;

package/dist/year.vo.js

@@ -1,4 +1,4 @@
-import { endOfYear, getYear, startOfYear } from "date-fns";
+import { addYears, endOfYear, getYear, startOfYear } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { Timestamp } from "./timestamp.vo";
 import { YearIsoId } from "./year-iso-id.vo";
@@ -10,6 +10,18 @@ export class Year extends DateRange {
         const year = getYear(this.getStart());
         return (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
     }
+    previous() {
+        const shifted = addYears(new Date(this.getStart()), -1).getTime();
+        return Year.fromTimestamp(Timestamp.parse(shifted));
+    }
+    next() {
+        const shifted = addYears(new Date(this.getStart()), 1).getTime();
+        return Year.fromTimestamp(Timestamp.parse(shifted));
+    }
+    shift(count) {
+        const shifted = addYears(new Date(this.getStart()), count).getTime();
+        return Year.fromTimestamp(Timestamp.parse(shifted));
+    }
     static fromTimestamp(timestamp) {
         const start = Timestamp.parse(startOfYear(timestamp).getTime());
         const end = Timestamp.parse(endOfYear(timestamp).getTime());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bgord/tools",
-  "version": "0.14.1",
+  "version": "0.14.3",
   "type": "module",
   "license": "MIT",
   "author": "Bartosz Gordon",
@@ -22,16 +22,16 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.2.4",
-    "@commitlint/cli": "20.0.0",
+    "@commitlint/cli": "20.1.0",
     "@commitlint/config-conventional": "20.0.0",
     "@types/bun": "1.2.23",
     "@types/mime-types": "3.0.1",
     "cspell": "9.2.1",
     "knip": "5.64.1",
-    "lefthook": "1.13.5",
+    "lefthook": "1.13.6",
     "only-allow": "1.2.1",
     "shellcheck": "4.1.0",
-    "typescript": "5.9.2",
+    "typescript": "5.9.3",
     "zod": "4.1.11"
   },
   "dependencies": {

package/readme.md

@@ -24,6 +24,7 @@ Run the tests
 
 ```
 src/
+├── age.vo.ts
 ├── api-key.vo.ts
 ├── basename.vo.ts
 ├── clock.vo.ts

package/src/age.vo.ts

@@ -0,0 +1,59 @@
+import { differenceInYears } from "date-fns";
+import { z } from "zod/v4";
+import type { TimestampType } from "./timestamp.vo";
+
+export const AgeValueError = { error: "invalid.age" };
+
+export class Age {
+  static readonly MIN = 1;
+  static readonly MAX = 130;
+
+  static readonly AgeValue = z
+    .number(AgeValueError)
+    .int(AgeValueError)
+    .min(Age.MIN, AgeValueError)
+    .max(Age.MAX, AgeValueError)
+    .brand("AgeValue");
+
+  private constructor(private readonly value: z.infer<typeof Age.AgeValue>) {}
+
+  get(): number {
+    return this.value as number;
+  }
+
+  compare(other: Age): -1 | 0 | 1 {
+    return this.value === other.value ? 0 : this.value < other.value ? -1 : 1;
+  }
+
+  equals(another: Age): boolean {
+    return this.compare(another) === 0;
+  }
+
+  isOlderThan(another: Age): boolean {
+    return this.compare(another) === 1;
+  }
+
+  isYoungerThan(another: Age): boolean {
+    return this.compare(another) === -1;
+  }
+
+  isAdult(minAge: Age): boolean {
+    return this.equals(minAge) || this.isOlderThan(minAge);
+  }
+
+  static fromValue(candidate: number): Age {
+    return new Age(Age.AgeValue.parse(candidate));
+  }
+
+  static fromBirthdateTimestamp(params: { birthdate: TimestampType; now: TimestampType }): Age {
+    if (params.birthdate > params.now) throw new Error("invalid.birthdate_in_future");
+    return Age.fromValue(differenceInYears(params.now, params.birthdate));
+  }
+
+  static fromBirthdate(params: { birthdate: string; now: TimestampType }): Age {
+    const birthdate = new Date(params.birthdate).getTime();
+
+    if (birthdate > params.now) throw new Error("invalid.birthdate_in_future");
+    return Age.fromValue(differenceInYears(params.now, birthdate));
+  }
+}

package/src/day.vo.ts

@@ -1,4 +1,4 @@
-import { endOfDay, startOfDay } from "date-fns";
+import { addDays, endOfDay, startOfDay } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { DayIsoId, type DayIsoIdType } from "./day-iso-id.vo";
 import { Time } from "./time.service";
@@ -13,6 +13,21 @@ export class Day extends DateRange {
     return new Date(this.getStart() + Time.Hours(12).ms).toISOString().slice(0, 10) as DayIsoIdType;
   }
 
+  previous(): Day {
+    const shifted = addDays(new Date(this.getStart()), -1).getTime();
+    return Day.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  next(): Day {
+    const shifted = addDays(new Date(this.getStart()), 1).getTime();
+    return Day.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  shift(count: number): Day {
+    const shifted = addDays(new Date(this.getStart()), count).getTime();
+    return Day.fromTimestamp(Timestamp.parse(shifted));
+  }
+
   static fromTimestamp(timestamp: TimestampType): Day {
     const start = Timestamp.parse(startOfDay(timestamp).getTime());
     const end = Timestamp.parse(endOfDay(timestamp).getTime());

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from "./age.vo";
 export * from "./api-key.vo";
 export * from "./basename.vo";
 export * from "./clock.vo";

package/src/month.vo.ts

@@ -1,4 +1,4 @@
-import { endOfMonth, startOfMonth } from "date-fns";
+import { addMonths, endOfMonth, startOfMonth } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { MonthIsoId, type MonthIsoIdType } from "./month-iso-id.vo";
 import { Timestamp, type TimestampType } from "./timestamp.vo";
@@ -8,6 +8,21 @@ export class Month extends DateRange {
     return new Date(this.getStart()).toISOString().slice(0, 7) as MonthIsoIdType;
   }
 
+  previous(): Month {
+    const shifted = addMonths(new Date(this.getStart()), -1).getTime();
+    return Month.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  next(): Month {
+    const shifted = addMonths(new Date(this.getStart()), 1).getTime();
+    return Month.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  shift(count: number): Month {
+    const shifted = addMonths(new Date(this.getStart()), count).getTime();
+    return Month.fromTimestamp(Timestamp.parse(shifted));
+  }
+
   static fromTimestamp(timestamp: TimestampType): Month {
     const start = Timestamp.parse(startOfMonth(timestamp).getTime());
     const end = Timestamp.parse(endOfMonth(timestamp).getTime());

package/src/week.vo.ts

@@ -1,4 +1,4 @@
-import { endOfISOWeek, getISOWeek, getISOWeekYear, setISOWeek, startOfISOWeek } from "date-fns";
+import { addWeeks, endOfISOWeek, getISOWeek, getISOWeekYear, setISOWeek, startOfISOWeek } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { Timestamp, type TimestampType } from "./timestamp.vo";
 import { WeekIsoId, type WeekIsoIdType } from "./week-iso-id.vo";
@@ -11,6 +11,21 @@ export class Week extends DateRange {
     return `${year}-W${week}`;
   }
 
+  previous(): Week {
+    const shifted = addWeeks(new Date(this.getStart()), -1).getTime();
+    return Week.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  next(): Week {
+    const shifted = addWeeks(new Date(this.getStart()), 1).getTime();
+    return Week.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  shift(count: number): Week {
+    const shifted = addWeeks(new Date(this.getStart()), count).getTime();
+    return Week.fromTimestamp(Timestamp.parse(shifted));
+  }
+
   static fromTimestamp(timestamp: TimestampType): Week {
     const start = Timestamp.parse(startOfISOWeek(timestamp).getTime());
     const end = Timestamp.parse(endOfISOWeek(timestamp).getTime());

package/src/year.vo.ts

@@ -1,4 +1,4 @@
-import { endOfYear, getYear, startOfYear } from "date-fns";
+import { addYears, endOfYear, getYear, startOfYear } from "date-fns";
 import { DateRange } from "./date-range.vo";
 import { Timestamp, type TimestampType } from "./timestamp.vo";
 import { YearIsoId, type YearIsoIdType } from "./year-iso-id.vo";
@@ -13,6 +13,21 @@ export class Year extends DateRange {
     return (year % 4 === 0 && year % 100 !== 0) || year % 400 === 0;
   }
 
+  previous(): Year {
+    const shifted = addYears(new Date(this.getStart()), -1).getTime();
+    return Year.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  next(): Year {
+    const shifted = addYears(new Date(this.getStart()), 1).getTime();
+    return Year.fromTimestamp(Timestamp.parse(shifted));
+  }
+
+  shift(count: number): Year {
+    const shifted = addYears(new Date(this.getStart()), count).getTime();
+    return Year.fromTimestamp(Timestamp.parse(shifted));
+  }
+
   static fromTimestamp(timestamp: TimestampType): Year {
     const start = Timestamp.parse(startOfYear(timestamp).getTime());
     const end = Timestamp.parse(endOfYear(timestamp).getTime());