@bgord/tools 0.12.25 → 0.13.0

package/dist/z-score.service.js

@@ -7,9 +7,8 @@ export class ZScore {
     standardDeviation;
     constructor(values, rounding = new RoundToDecimal(2)) {
         this.rounding = rounding;
-        if (values.length < 2) {
+        if (values.length < 2)
             throw new Error("At least two values are needed");
-        }
         this.mean = Mean.calculate(values);
         this.standardDeviation = PopulationStandardDeviation.calculate(values);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bgord/tools",
-  "version": "0.12.25",
+  "version": "0.13.0",
   "type": "module",
   "license": "MIT",
   "author": "Bartosz Gordon",
@@ -21,25 +21,25 @@
     "preinstall": "bunx only-allow bun"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.2.3",
+    "@biomejs/biome": "2.2.4",
     "@commitlint/cli": "19.8.1",
     "@commitlint/config-conventional": "19.8.1",
-    "@types/bun": "1.2.21",
+    "@types/bun": "1.2.22",
     "@types/mime-types": "3.0.1",
     "cspell": "9.2.1",
     "knip": "5.63.1",
-    "lefthook": "1.12.4",
+    "lefthook": "1.13.0",
     "only-allow": "1.2.1",
     "shellcheck": "4.1.0",
     "typescript": "5.9.2",
-    "zod": "4.1.5"
+    "zod": "4.1.8"
   },
   "dependencies": {
     "date-fns": "4.1.0",
     "mime-types": "3.0.1"
   },
   "peerDependencies": {
-    "zod": "4.1.5"
+    "zod": "4.1.8"
   },
   "sideEffects": false
 }

package/readme.md

@@ -26,7 +26,6 @@ Run the tests
 src/
 ├── api-key.vo.ts
 ├── basename.vo.ts
-├── build-version.vo.ts
 ├── clock.vo.ts
 ├── date-calculator.service.ts
 ├── date-formatter.service.ts
@@ -47,7 +46,6 @@ src/
 ├── filename-from-string.vo.ts
 ├── filename-suffix.vo.ts
 ├── filename.vo.ts
-├── filter.vo.ts
 ├── hour.vo.ts
 ├── iban-mask.service.ts
 ├── iban.vo.ts
@@ -89,6 +87,7 @@ src/
 ├── visually-unambiguous-characters-generator.service.ts
 ├── week-iso-id.vo.ts
 ├── week.vo.ts
+├── weekday.vo.ts
 └── z-score.service.ts
 ```
 

package/src/clock.vo.ts

@@ -1,5 +1,6 @@
-import { type Hour, HourFormatters } from "./hour.vo";
-import type { Minute } from "./minute.vo";
+import { Hour, HourFormatters } from "./hour.vo";
+import { Minute } from "./minute.vo";
+import type { TimestampType } from "./timestamp.vo";
 
 export type ClockFormatter = (hour: Hour, minute: Minute) => string;
 
@@ -26,6 +27,12 @@ export class Clock {
     this.formatter = (formatter as ClockFormatter) ?? ClockFormatters.TWENTY_FOUR_HOURS;
   }
 
+  static fromUtcTimestamp(timestamp: TimestampType, formatter?: ClockFormatter) {
+    const hour = Hour.fromUtcTimestamp(timestamp);
+    const minute = Minute.fromUtcTimestamp(timestamp);
+    return new Clock(hour, minute, formatter);
+  }
+
   get(formatter?: ClockFormatter) {
     const format = formatter ?? this.formatter;
 

package/src/hour.vo.ts

@@ -1,3 +1,5 @@
+import type { TimestampType } from "./timestamp.vo";
+
 export type HourFormatter = (value: Hour["value"]) => string;
 
 export enum HourFormatterEnum {
@@ -14,13 +16,13 @@ export const HourFormatters: Record<HourFormatterEnum, HourFormatter> = {
   TWENTY_FOUR_HOURS_WO_PADDING: (value) => value.toString(),
 
   AM_PM: (value) => {
-    if (value < 12) return `${value.toString()} a.m.`;
-    return `${value.toString()} p.m.`;
+    const twelveHour = value % 12 || 12;
+    return `${twelveHour.toString()} ${value < 12 ? "a.m." : "p.m."}`;
   },
 
-  TWELVE_HOURS: (value) => (value % 12).toString().padStart(2, "0"),
+  TWELVE_HOURS: (value) => (value % 12 || 12).toString().padStart(2, "0"),
 
-  TWELVE_HOURS_WO_PADDING: (value) => (value % 12).toString(),
+  TWELVE_HOURS_WO_PADDING: (value) => (value % 12 || 12).toString(),
 } as const;
 
 export class Hour {
@@ -33,15 +35,9 @@ export class Hour {
   static readonly MAX = new Hour(23);
 
   constructor(candidate: number, formatter?: HourFormatter) {
-    if (!Number.isInteger(candidate)) {
-      throw new Error("Invalid hour");
-    }
-    if (candidate < 0) {
-      throw new Error("Invalid hour");
-    }
-    if (candidate >= 24) {
-      throw new Error("Invalid hour");
-    }
+    if (!Number.isInteger(candidate)) throw new Error("Invalid hour");
+    if (candidate < 0) throw new Error("Invalid hour");
+    if (candidate >= 24) throw new Error("Invalid hour");
 
     this.value = candidate;
     this.formatter = (formatter as HourFormatter) ?? HourFormatters.TWENTY_FOUR_HOURS;
@@ -65,6 +61,12 @@ export class Hour {
     return this.value < another.get().raw;
   }
 
+  static fromUtcTimestamp(timestamp: TimestampType, formatter?: HourFormatter): Hour {
+    const hours = new Date(timestamp).getUTCHours();
+
+    return new Hour(hours, formatter);
+  }
+
   static list(formatter?: HourFormatter) {
     return Array.from({ length: 24 }).map((_, index) => new Hour(index, formatter));
   }

package/src/index.ts

@@ -1,6 +1,5 @@
 export * from "./api-key.vo";
 export * from "./basename.vo";
-export * from "./build-version.vo";
 export * from "./clock.vo";
 export * from "./date-calculator.service";
 export * from "./date-formatter.service";
@@ -21,7 +20,6 @@ export * from "./file-path-relative-schema.vo";
 export * from "./filename.vo";
 export * from "./filename-from-string.vo";
 export * from "./filename-suffix.vo";
-export * from "./filter.vo";
 export * from "./hour.vo";
 export * from "./iban.vo";
 export * from "./iban-mask.service";
@@ -63,4 +61,5 @@ export * from "./ts-utils";
 export * from "./visually-unambiguous-characters-generator.service";
 export * from "./week.vo";
 export * from "./week-iso-id.vo";
+export * from "./weekday.vo";
 export * from "./z-score.service";

package/src/mean.service.ts

@@ -3,9 +3,7 @@ import { Sum } from "./sum.service";
 
 export class Mean {
   static calculate(values: number[], rounding: RoundingStrategy = new RoundToDecimal(2)): number {
-    if (values.length === 0) {
-      throw new Error("Values should not be empty");
-    }
+    if (values.length === 0) throw new Error("Values should not be empty");
 
     const mean = Sum.of(values) / values.length;
 

package/src/mime.vo.ts

@@ -2,9 +2,7 @@ import * as mime from "mime-types";
 import { ExtensionSchema, type ExtensionType } from "./extension.vo";
 
 export type MimeRawType = string;
-
 type MimeTypeType = string;
-
 type MimeSubtypeType = string;
 
 export class Mime {
@@ -15,13 +13,8 @@ export class Mime {
   constructor(value: MimeRawType) {
     const [type, subtype] = value.split("/");
 
-    if (typeof type !== "string" || type.length === 0) {
-      throw new InvalidMimeError();
-    }
-
-    if (typeof subtype !== "string" || subtype.length === 0) {
-      throw new InvalidMimeError();
-    }
+    if (typeof type !== "string" || type.length === 0) throw new InvalidMimeError();
+    if (typeof subtype !== "string" || subtype.length === 0) throw new InvalidMimeError();
 
     this.raw = value;
     this.type = type;

package/src/min-max-scaler.service.ts

@@ -26,13 +26,8 @@ export class MinMaxScaler {
     const lower = config.bound?.lower ?? 0;
     const upper = config.bound?.upper ?? 1;
 
-    if (config.max - config.min < 0) {
-      throw new Error("Invalid MinMaxScaler min-max config");
-    }
-
-    if (upper - lower <= 0) {
-      throw new Error("Invalid MinMaxScaler bound config");
-    }
+    if (config.max - config.min < 0) throw new Error("Invalid MinMaxScaler min-max config");
+    if (upper - lower <= 0) throw new Error("Invalid MinMaxScaler bound config");
 
     this.rounding = rounding;
 
@@ -45,9 +40,7 @@ export class MinMaxScaler {
   scale(value: MinMaxScalerValueType) {
     const { min, max, lower, upper } = this;
 
-    if (value < min || value > max) {
-      throw new Error("Value out of min/max range");
-    }
+    if (value < min || value > max) throw new Error("Value out of min/max range");
 
     if (min === max)
       return {
@@ -70,9 +63,7 @@ export class MinMaxScaler {
   descale(scaled: MinMaxScalerValueType) {
     const { min, max, lower, upper } = this;
 
-    if (scaled < lower || scaled > upper) {
-      throw new Error("Scaled value out of bounds");
-    }
+    if (scaled < lower || scaled > upper) throw new Error("Scaled value out of bounds");
 
     const result = ((scaled - lower) / (upper - lower)) * (max - min) + min;
 
@@ -85,9 +76,7 @@ export class MinMaxScaler {
   }
 
   static getMinMax(values: MinMaxScalerValueType[]) {
-    if (values.length === 0) {
-      throw new Error("An empty array supplied");
-    }
+    if (values.length === 0) throw new Error("An empty array supplied");
 
     return { min: Math.min(...values), max: Math.max(...values) };
   }

package/src/minute.vo.ts

@@ -6,26 +6,20 @@ export class Minute {
   static readonly MAX = new Minute(59);
 
   constructor(candidate: number) {
-    if (!Number.isInteger(candidate)) {
-      throw new Error("Invalid minute");
-    }
-
-    if (candidate < 0) {
-      throw new Error("Invalid minute");
-    }
-
-    if (candidate >= 60) {
-      throw new Error("Invalid minute");
-    }
+    if (!Number.isInteger(candidate)) throw new Error("Invalid minute");
+    if (candidate < 0) throw new Error("Invalid minute");
+    if (candidate >= 60) throw new Error("Invalid minute");
 
     this.value = candidate;
   }
 
+  static fromUtcTimestamp(timestamp: number): Minute {
+    const minutes = new Date(timestamp).getUTCMinutes();
+    return new Minute(minutes);
+  }
+
   get() {
-    return {
-      raw: this.value,
-      formatted: this.value.toString().padStart(2, "0"),
-    };
+    return { raw: this.value, formatted: this.value.toString().padStart(2, "0") };
   }
 
   equals(another: Minute): boolean {

package/src/money.vo.ts

@@ -55,17 +55,13 @@ export class Money {
   subtract(money: Money) {
     const result = this.rounding.round(this.amount - money.getAmount());
 
-    if (result < Money.ZERO) {
-      throw new Error("Less than zero");
-    }
+    if (result < Money.ZERO) throw new Error("Less than zero");
 
     return new Money(MoneyAmount.parse(result), this.rounding);
   }
 
   divide(factor: MoneyDivisionFactorType) {
-    if (factor === 0) {
-      throw new Error("Cannot divide by zero");
-    }
+    if (factor === 0) throw new Error("Cannot divide by zero");
 
     const result = this.rounding.round(this.amount / factor);
 

package/src/outlier-detector.service.ts

@@ -6,9 +6,7 @@ export class OutlierDetector {
   private readonly threshold: number;
 
   constructor(values: number[], threshold: number) {
-    if (values.length < 2) {
-      throw new Error("At least two values are needed");
-    }
+    if (values.length < 2) throw new Error("At least two values are needed");
 
     this.zScore = new ZScore(values);
     this.threshold = Math.abs(threshold);

package/src/percentage.service.ts

@@ -6,12 +6,8 @@ export class Percentage {
     denominator: number,
     rounding: RoundingStrategy = new RoundToNearest(),
   ): number {
-    if (denominator === 0) {
-      throw new Error("Invalid denominator");
-    }
-
+    if (denominator === 0) throw new Error("Invalid denominator");
     if (numerator === 0) return 0;
-
     return rounding.round((numerator / denominator) * 100);
   }
 }

package/src/population-standard-deviation.service.ts

@@ -4,9 +4,7 @@ import { Sum } from "./sum.service";
 
 export class PopulationStandardDeviation {
   static calculate(values: number[], rounding: RoundingStrategy = new RoundToDecimal(2)): number {
-    if (values.length < 2) {
-      throw new Error("At least two values are needed");
-    }
+    if (values.length < 2) throw new Error("At least two values are needed");
 
     const mean = Mean.calculate(values);
     const n = values.length;

package/src/random.service.ts

@@ -1,28 +1,14 @@
-type RandomGenerateConfigType = {
-  min: number;
-  max: number;
-};
+type RandomGenerateConfigType = { min: number; max: number };
 
 export class Random {
   static generate(config?: RandomGenerateConfigType) {
     const min = config?.min ?? 0;
     const max = config?.max ?? 1;
 
-    if (!Number.isInteger(min)) {
-      throw new Error("Minimum value is not an integer");
-    }
-
-    if (!Number.isInteger(max)) {
-      throw new Error("Maximum value is not an integer");
-    }
-
-    if (min === max) {
-      throw new Error("Minimum and maximum values cannot be equal");
-    }
-
-    if (min > max) {
-      throw new Error("Minimum value cannot be greater than maximum value");
-    }
+    if (!Number.isInteger(min)) throw new Error("Minimum value is not an integer");
+    if (!Number.isInteger(max)) throw new Error("Maximum value is not an integer");
+    if (min === max) throw new Error("Minimum and maximum values cannot be equal");
+    if (min > max) throw new Error("Minimum value cannot be greater than maximum value");
 
     return Math.floor(Math.random() * (max - min + 1)) + min;
   }

package/src/rate-limiter.service.ts

@@ -3,14 +3,8 @@ import { Timestamp, type TimestampType } from "./timestamp.vo";
 import type { Falsy } from "./ts-utils";
 
 type RateLimiterOptionsType = Pick<TimeResult, "ms">;
-
 type RateLimiterResultSuccessType = { allowed: true };
-
-type RateLimiterResultErrorType = {
-  allowed: false;
-  remainingMs: TimestampType;
-};
-
+type RateLimiterResultErrorType = { allowed: false; remainingMs: TimestampType };
 type RateLimiterResultType = RateLimiterResultSuccessType | RateLimiterResultErrorType;
 
 export class RateLimiter {
@@ -33,9 +27,6 @@ export class RateLimiter {
       return { allowed: true };
     }
 
-    return {
-      allowed: false,
-      remainingMs: Timestamp.parse(nextAllowedTimestampMs - currentTimestampMs),
-    };
+    return { allowed: false, remainingMs: Timestamp.parse(nextAllowedTimestampMs - currentTimestampMs) };
   }
 }

package/src/relative-date.vo.ts

@@ -16,9 +16,6 @@ export class RelativeDate {
   }
 
   private static _format(timestampMs: TimestampType): RelativeDateType {
-    return {
-      raw: timestampMs,
-      relative: DateFormatters.relative(timestampMs),
-    };
+    return { raw: timestampMs, relative: DateFormatters.relative(timestampMs) };
   }
 }

package/src/reordering.service.ts

@@ -63,10 +63,7 @@ export class ReorderingTransfer {
 
   readonly to: ReorderingPosition;
 
-  constructor(config: {
-    id: ReorderingItem["id"];
-    to: ReorderingItemPositionValueType;
-  }) {
+  constructor(config: { id: ReorderingItem["id"]; to: ReorderingItemPositionValueType }) {
     this.id = config.id;
     this.to = new ReorderingPosition(config.to);
   }
@@ -106,9 +103,8 @@ export class ReorderingCalculator {
 
   delete(id: ReorderingItem["id"]) {
     const item = this.dll.find((x) => x.data.eq(id));
-    if (!item) {
-      throw new Error("Cannot find Item");
-    }
+    if (!item) throw new Error("Cannot find Item");
+
     this.dll.remove(item);
     this.recalculate();
   }
@@ -117,12 +113,8 @@ export class ReorderingCalculator {
     const current = this.dll.find((node) => node.data.eq(transfer.id));
     const target = this.dll.find((node) => node.data.position.eq(transfer.to));
 
-    if (!current) {
-      throw new Error("Cannot find current Item");
-    }
-    if (!target) {
-      throw new Error("Cannot find target Item");
-    }
+    if (!current) throw new Error("Cannot find current Item");
+    if (!target) throw new Error("Cannot find target Item");
 
     const direction = transfer.getDirection(current.data.position);
 

package/src/revision.vo.ts

@@ -31,16 +31,12 @@ export class Revision {
   }
 
   static fromETag(etag: ETag | null): Revision {
-    if (!etag) {
-      throw new InvalidRevisionError();
-    }
+    if (!etag) throw new InvalidRevisionError();
     return new Revision(etag.revision);
   }
 
   static fromWeakETag(weakEtag: WeakETag | null): Revision {
-    if (!weakEtag) {
-      throw new InvalidRevisionError();
-    }
+    if (!weakEtag) throw new InvalidRevisionError();
     return new Revision(weakEtag.revision);
   }
 }

package/src/simple-linear-regression.service.ts

@@ -20,9 +20,7 @@ export class SimpleLinearRegression {
   static fromPairs(pairs: SLRPairType[], rounding?: RoundingStrategy) {
     const n = pairs.length;
 
-    if (n < 2) {
-      throw new Error("At least two pairs needed");
-    }
+    if (n < 2) throw new Error("At least two pairs needed");
 
     const x = pairs.map((pair) => pair.x);
     const y = pairs.map((pair) => pair.y);
@@ -30,30 +28,19 @@ export class SimpleLinearRegression {
     const xy = pairs.map((pair) => pair.x * pair.y);
 
     const sX = Sum.of(x);
-    if (sX >= Number.MAX_SAFE_INTEGER) {
-      throw new Error("Sum of x values is too big");
-    }
+    if (sX >= Number.MAX_SAFE_INTEGER) throw new Error("Sum of x values is too big");
 
     const sY = Sum.of(y);
-    if (sY >= Number.MAX_SAFE_INTEGER) {
-      throw new Error("Sum of y values is too big");
-    }
+    if (sY >= Number.MAX_SAFE_INTEGER) throw new Error("Sum of y values is too big");
 
     const sSX = Sum.of(xx);
-    if (sSX >= Number.MAX_SAFE_INTEGER) {
-      throw new Error("Sum of x squared values is too big");
-    }
+    if (sSX >= Number.MAX_SAFE_INTEGER) throw new Error("Sum of x squared values is too big");
 
     const sXY = Sum.of(xy);
-    if (sXY >= Number.MAX_SAFE_INTEGER) {
-      throw new Error("Sum of x times y values is too big");
-    }
+    if (sXY >= Number.MAX_SAFE_INTEGER) throw new Error("Sum of x times y values is too big");
 
     const bDenominator = sSX - sX ** 2 / n;
-
-    if (bDenominator === 0) {
-      throw new Error("Unable to create the model");
-    }
+    if (bDenominator === 0) throw new Error("Unable to create the model");
 
     const b = (sXY - (sX * sY) / n) / bDenominator;
     const a = (sY - b * sX) / n;

package/src/stepper.service.ts

@@ -10,14 +10,8 @@ export class Stepper {
   private readonly total: StepType;
 
   constructor(config: StepperConfigType) {
-    if (!Number.isInteger(config.total)) {
-      throw new Error("Total value is not an integer");
-    }
-
-    if (config.total <= Stepper.DEFAULT_CURRENT) {
-      throw new Error("Total value should be greater than one");
-    }
-
+    if (!Number.isInteger(config.total)) throw new Error("Total value is not an integer");
+    if (config.total <= Stepper.DEFAULT_CURRENT) throw new Error("Total value should be greater than one");
     this.total = config.total;
   }
 

package/src/stopwatch.service.ts

@@ -16,9 +16,7 @@ export class Stopwatch {
   constructor(private readonly startMs: TimestampType) {}
 
   stop(): StopwatchResultType {
-    if (this.state === StopwatchState.stopped) {
-      throw new Error("Stopwatch is already stopped");
-    }
+    if (this.state === StopwatchState.stopped) throw new Error("Stopwatch is already stopped");
 
     this.state = StopwatchState.stopped;
     this.stopMs = Timestamp.parse(Date.now());

package/src/timezone.vo.ts

@@ -6,17 +6,11 @@ export const Timezone = z
   .refine(
     (value) => {
       try {
-        // Create a dummy date and time format using the specified timezone
-        const dummyDate = new Date();
+        const date = new Date();
         const formatter = new Intl.DateTimeFormat("en-US", { timeZone: value });
-
-        // Format the dummy date
-        formatter.format(dummyDate);
-
-        // If the formatting succeeds without throwing an error, the timezone is valid
+        formatter.format(date);
         return true;
       } catch (_error) {
-        // An error occurred, indicating an invalid timezone
         return false;
       }
     },

package/src/visually-unambiguous-characters-generator.service.ts

@@ -31,10 +31,7 @@ export class VisuallyUnambiguousCharactersGenerator {
       .map(
         () =>
           VisuallyUnambiguousCharactersGenerator.chars[
-            Random.generate({
-              min: 0,
-              max: VisuallyUnambiguousCharactersGenerator.chars.length - 1,
-            })
+            Random.generate({ min: 0, max: VisuallyUnambiguousCharactersGenerator.chars.length - 1 })
           ],
       )
       .join("");