@bgord/tools 1.2.20 → 1.2.21

package/src/filename.vo.ts

@@ -1,92 +0,0 @@
-import { Basename, type BasenameType } from "./basename.vo";
-import { Extension, type ExtensionType } from "./extension.vo";
-import { FilenameAffix, FilenameAffixStrategy, type FilenameAffixType } from "./filename-affix.vo";
-import { FilenameFromString } from "./filename-from-string.vo";
-import { Mime } from "./mime.vo";
-
-export class Filename {
-  private constructor(
-    private readonly basename: BasenameType,
-    private readonly extension: ExtensionType,
-  ) {}
-
-  static fromParts(basename: string, extension: string): Filename {
-    return new Filename(Basename.parse(basename), Extension.parse(extension));
-  }
-
-  static fromPartsSafe(basename: BasenameType, extension: ExtensionType): Filename {
-    return new Filename(basename, extension);
-  }
-
-  static fromString(candidate: string): Filename {
-    const filename = FilenameFromString.parse(candidate);
-
-    return new Filename(filename.basename, filename.extension);
-  }
-
-  get(): string {
-    return `${this.basename}.${this.extension}`;
-  }
-
-  getBasename(): BasenameType {
-    return this.basename;
-  }
-
-  getExtension(): ExtensionType {
-    return this.extension;
-  }
-
-  getMime(): Mime {
-    return Mime.fromExtension(this.extension);
-  }
-
-  withExtension(extension: ExtensionType): Filename {
-    return new Filename(this.basename, extension);
-  }
-
-  withBasename(basename: BasenameType): Filename {
-    return new Filename(basename, this.extension);
-  }
-
-  withAffix(candidate: string, strategy: FilenameAffixStrategy): Filename {
-    const affix = FilenameAffix.parse(candidate);
-
-    if (strategy === FilenameAffixStrategy.prefix) {
-      return new Filename(Basename.parse(`${affix}${this.basename}`), this.extension);
-    }
-
-    return new Filename(Basename.parse(`${this.basename}${affix}`), this.extension);
-  }
-
-  withAffixSafe(affix: FilenameAffixType, strategy: FilenameAffixStrategy): Filename {
-    if (strategy === FilenameAffixStrategy.prefix) {
-      return new Filename(Basename.parse(`${affix}${this.basename}`), this.extension);
-    }
-
-    return new Filename(Basename.parse(`${this.basename}${affix}`), this.extension);
-  }
-
-  withSuffix(candidate: string) {
-    return this.withAffix(candidate, FilenameAffixStrategy.suffix);
-  }
-
-  withSuffixSafe(affix: FilenameAffixType): Filename {
-    return this.withAffix(affix, FilenameAffixStrategy.suffix);
-  }
-
-  withPrefix(candidate: string) {
-    return this.withAffix(candidate, FilenameAffixStrategy.prefix);
-  }
-
-  withPrefixSafe(affix: FilenameAffixType): Filename {
-    return this.withAffix(affix, FilenameAffixStrategy.prefix);
-  }
-
-  toString(): string {
-    return this.get();
-  }
-
-  toJSON(): string {
-    return this.get();
-  }
-}

package/src/height-milimiters.vo.ts

@@ -1,16 +0,0 @@
-import { z } from "zod/v4";
-
-export const HeightMillimetersError = {
-  Type: "height.millimeters.type",
-  Invalid: "height.millimeters.invalid",
-};
-
-// Stryker disable all
-export const HeightMillimeters = z
-  // Stryker restore all
-  .number(HeightMillimetersError.Type)
-  .int(HeightMillimetersError.Type)
-  .min(0, HeightMillimetersError.Invalid)
-  .brand("HeightMillimeters");
-
-export type HeightMillimetersType = z.infer<typeof HeightMillimeters>;

package/src/height.vo.ts

@@ -1,79 +0,0 @@
-import { HeightMillimeters, type HeightMillimetersType } from "./height-milimiters.vo";
-import type { RoundingStrategy } from "./rounding.strategy";
-import { RoundingDecimalStrategy } from "./rounding-decimal.strategy";
-import { RoundingToNearestStrategy } from "./rounding-to-nearest.strategy";
-
-export class Height {
-  private static readonly ZERO = HeightMillimeters.parse(0);
-
-  private static readonly MILLIMETERS_PER_CENTIMETER = 10;
-
-  private constructor(private readonly millimeters: HeightMillimetersType) {}
-
-  static fromMillimeters(millimeters: number): Height {
-    return new Height(HeightMillimeters.parse(millimeters));
-  }
-
-  static fromMillimetersSafe(millimeters: HeightMillimetersType): Height {
-    return new Height(millimeters);
-  }
-
-  static fromCentimeters(
-    centimeters: number,
-    rounding: RoundingStrategy = new RoundingToNearestStrategy(),
-  ): Height {
-    const millimeters = rounding.round(centimeters * Height.MILLIMETERS_PER_CENTIMETER);
-
-    return new Height(HeightMillimeters.parse(millimeters));
-  }
-
-  static zero(): Height {
-    return Height.fromMillimetersSafe(Height.ZERO);
-  }
-
-  get(): number {
-    return this.millimeters;
-  }
-
-  toMillimeters(): number {
-    return this.millimeters;
-  }
-
-  toCentimeters(rounding?: RoundingStrategy): number {
-    const centimeters = this.millimeters / Height.MILLIMETERS_PER_CENTIMETER;
-
-    if (rounding) return rounding.round(centimeters);
-    return centimeters;
-  }
-
-  format(rounding?: RoundingStrategy): string {
-    const chosen = rounding ?? new RoundingDecimalStrategy(1);
-    const value = this.toCentimeters(chosen);
-
-    return `${value} cm`;
-  }
-
-  toString(): string {
-    return this.format(new RoundingDecimalStrategy(1));
-  }
-
-  equals(another: Height): boolean {
-    return this.millimeters === another.millimeters;
-  }
-
-  greaterThan(another: Height): boolean {
-    return this.millimeters > another.millimeters;
-  }
-
-  lessThan(another: Height): boolean {
-    return this.millimeters < another.millimeters;
-  }
-
-  isZero(): boolean {
-    return this.millimeters === 0;
-  }
-
-  toJSON(): number {
-    return this.millimeters;
-  }
-}

package/src/hour-format.service.ts

@@ -1,22 +0,0 @@
-export type HourFormatter = (value: number) => string;
-
-enum HourFormatterEnum {
-  TWENTY_FOUR_HOURS = "TWENTY_FOUR_HOURS",
-  TWENTY_FOUR_HOURS_WO_PADDING = "TWENTY_FOUR_HOURS_WO_PADDING",
-  AM_PM = "AM_PM",
-  TWELVE_HOURS = "TWELVE_HOURS",
-  TWELVE_HOURS_WO_PADDING = "TWELVE_HOURS_WO_PADDING",
-}
-
-export const HourFormatters: Record<HourFormatterEnum, HourFormatter> = {
-  TWENTY_FOUR_HOURS: (value) => value.toString().padStart(2, "0"),
-  TWENTY_FOUR_HOURS_WO_PADDING: (value) => value.toString(),
-  AM_PM: (value) => {
-    const suffix = value < 12 ? "a.m." : "p.m.";
-    const twelveHourValue = value % 12 || 12;
-
-    return `${twelveHourValue} ${suffix}`;
-  },
-  TWELVE_HOURS: (value) => (value % 12 || 12).toString().padStart(2, "0"),
-  TWELVE_HOURS_WO_PADDING: (value) => (value % 12 || 12).toString(),
-};

package/src/hour-schema.vo.ts

@@ -1,14 +0,0 @@
-import { z } from "zod/v4";
-
-export const HourSchemaError = { Type: "hour.schema.type", Invalid: "hour.schema.invalid" };
-
-// Stryker disable all
-export const HourSchema = z
-  // Stryker restore all
-  .number(HourSchemaError.Type)
-  .int(HourSchemaError.Type)
-  .gte(0, HourSchemaError.Invalid)
-  .lte(23, HourSchemaError.Invalid)
-  .brand("HourSchema");
-
-export type HourSchemaType = z.infer<typeof HourSchema>;

package/src/hour.vo.ts

@@ -1,64 +0,0 @@
-import { type HourFormatter, HourFormatters } from "./hour-format.service";
-import { HourSchema, type HourSchemaType } from "./hour-schema.vo";
-import { Timestamp } from "./timestamp.vo";
-import type { TimestampValueType } from "./timestamp-value.vo";
-
-export class Hour {
-  private constructor(private readonly value: HourSchemaType) {}
-
-  static fromValue(candidate: number): Hour {
-    return new Hour(HourSchema.parse(candidate));
-  }
-
-  static fromValueSafe(candidate: HourSchemaType) {
-    return new Hour(candidate);
-  }
-
-  static fromTimestamp(timestamp: Timestamp): Hour {
-    return new Hour(HourSchema.parse(new Date(timestamp.ms).getUTCHours()));
-  }
-
-  static fromTimestampValue(timestamp: TimestampValueType): Hour {
-    return Hour.fromTimestamp(Timestamp.fromValue(timestamp));
-  }
-
-  static zero(): Hour {
-    return Hour.fromValue(0);
-  }
-
-  static max(): Hour {
-    return Hour.fromValue(23);
-  }
-
-  get(): HourSchemaType {
-    return this.value;
-  }
-
-  format(formatter: HourFormatter): string {
-    return formatter(this.value);
-  }
-
-  equals(another: Hour): boolean {
-    return this.value === another.value;
-  }
-
-  isAfter(another: Hour): boolean {
-    return this.value > another.value;
-  }
-
-  isBefore(another: Hour): boolean {
-    return this.value < another.value;
-  }
-
-  static list(): readonly Hour[] {
-    return Array.from({ length: 24 }, (_, index) => Hour.fromValue(index));
-  }
-
-  toString(): string {
-    return HourFormatters.TWENTY_FOUR_HOURS(this.value);
-  }
-
-  toJSON(): number {
-    return this.value;
-  }
-}

package/src/iban-mask.service.ts

@@ -1,18 +0,0 @@
-import type { IBAN } from "./iban.vo";
-
-export class IbanMask {
-  static censor(iban: IBAN): string {
-    const value = iban.format();
-
-    const FIRST_SPACE_INDEX = 4;
-    const LAST_SPACE_INDEX = value.length - 5;
-
-    const start = value.slice(0, FIRST_SPACE_INDEX);
-    const middle = value.slice(FIRST_SPACE_INDEX + 1, LAST_SPACE_INDEX);
-    const end = value.slice(-4);
-
-    const maskedMiddle = middle.replace(/[A-Z0-9]/g, "*");
-
-    return `${start} ${maskedMiddle} ${end}`;
-  }
-}

package/src/iban-schema.vo.ts

@@ -1,17 +0,0 @@
-import { z } from "zod/v4";
-
-export const IbanSchemaError = { Type: "iban.schema.type", Invalid: "iban.schema.invalid" };
-
-// Two letters for country code, two digits, 11–30 uppercase letters or digits
-const IBAN_CHARS_WHITELIST = /^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/;
-
-// Stryker disable all
-export const IbanSchema = z
-  // Stryker restore all
-  .string(IbanSchemaError.Type)
-  .toUpperCase()
-  .transform((value) => value.replaceAll(" ", ""))
-  .refine((value) => IBAN_CHARS_WHITELIST.test(value), IbanSchemaError.Invalid)
-  .brand("IbanSchema");
-
-export type IbanSchemaType = z.infer<typeof IbanSchema>;

package/src/iban.vo.ts

@@ -1,28 +0,0 @@
-import { IbanSchema, type IbanSchemaType } from "./iban-schema.vo";
-
-export class IBAN {
-  private readonly value: IbanSchemaType;
-
-  constructor(candidate: string) {
-    this.value = IbanSchema.parse(candidate);
-  }
-
-  toString(): IbanSchemaType {
-    return this.value;
-  }
-
-  format(): string {
-    // (.{4}) - capture any four characters
-    // (?=.) - positive lookahead, at least one more character after the match
-    // "$1 " - replace each match with the group and a space
-    return this.value.replace(/(.{4})(?=.)/g, "$1 ");
-  }
-
-  get countryCode(): string {
-    return this.value.slice(0, 2);
-  }
-
-  equals(other: IBAN): boolean {
-    return this.value === other.value;
-  }
-}

package/src/image.vo.ts

@@ -1,28 +0,0 @@
-import { z } from "zod/v4";
-
-export const ImageWidthError = { Type: "image.width.type", Length: "image.width.length" };
-export const ImageHeightError = { Type: "image.height.type", Length: "image.height.length" };
-
-const IMAGE_DIMENSIONS_CONSTRAINTS = { min: 1, max: 10_000 };
-
-// Stryker disable all
-export const ImageWidth = z
-  // Stryker restore all
-  .number(ImageWidthError.Type)
-  .int(ImageWidthError.Type)
-  .min(IMAGE_DIMENSIONS_CONSTRAINTS.min, ImageWidthError.Length)
-  .max(IMAGE_DIMENSIONS_CONSTRAINTS.max, ImageWidthError.Length)
-  .brand("ImageWidth");
-
-export type ImageWidthType = z.infer<typeof ImageWidth>;
-
-// Stryker disable all
-export const ImageHeight = z
-  // Stryker restore all
-  .number(ImageHeightError.Type)
-  .int(ImageHeightError.Type)
-  .min(IMAGE_DIMENSIONS_CONSTRAINTS.min, ImageHeightError.Length)
-  .max(IMAGE_DIMENSIONS_CONSTRAINTS.max, ImageHeightError.Length)
-  .brand("ImageHeight");
-
-export type ImageHeightType = z.infer<typeof ImageHeight>;

package/src/index.ts

@@ -1,105 +0,0 @@
-export * from "./age.vo";
-export * from "./age-years.vo";
-export * from "./api-key.vo";
-export * from "./basename.vo";
-export * from "./clock.vo";
-export * from "./clock-format.service";
-export * from "./date-calculator.service";
-export * from "./date-formatter.service";
-export * from "./date-range.vo";
-export * from "./day.vo";
-export * from "./day-iso-id.vo";
-export * from "./directory-path-absolute.vo";
-export * from "./directory-path-relative.vo";
-export * from "./distance.vo";
-export * from "./distance-value.vo";
-export * from "./division-factor.vo";
-export * from "./dll.service";
-export * from "./duration.service";
-export * from "./duration-ms.vo";
-export * from "./email.vo";
-export * from "./email-mask.service";
-export * from "./etags.vo";
-export * from "./extension.vo";
-export * from "./feature-flag.vo";
-export * from "./feature-flag-value.vo";
-export * from "./file-path.vo";
-export * from "./file-path-absolute-schema.vo";
-export * from "./file-path-relative-schema.vo";
-export * from "./filename.vo";
-export * from "./filename-affix.vo";
-export * from "./filename-from-string.vo";
-export * from "./height.vo";
-export * from "./height-milimiters.vo";
-export * from "./hour.vo";
-export * from "./hour-format.service";
-export * from "./hour-schema.vo";
-export * from "./iban.vo";
-export * from "./iban-mask.service";
-export * from "./iban-schema.vo";
-export * from "./image.vo";
-export * from "./index";
-export * from "./integer.vo";
-export * from "./integer-non-negative.vo";
-export * from "./integer-positive.vo";
-export * from "./language.vo";
-export * from "./linear-regression.service";
-export * from "./mean.service";
-export * from "./mime.vo";
-export * from "./mime-types.vo";
-export * from "./mime-value.vo";
-export * from "./min-max-scaler.service";
-export * from "./minute.vo";
-export * from "./minute-schema.vo";
-export * from "./money.vo";
-export * from "./money-amount.vo";
-export * from "./month.vo";
-export * from "./month-iso-id.vo";
-export * from "./multiplication-factor.vo";
-export * from "./noop.service";
-export * from "./notification-template.vo";
-export * from "./object-key.vo";
-export * from "./outlier-detector.service";
-export * from "./package-version.vo";
-export * from "./package-version-schema.vo";
-export * from "./pagination.service";
-export * from "./pagination-page.vo";
-export * from "./pagination-skip.vo";
-export * from "./pagination-take.vo";
-export * from "./percentage.service";
-export * from "./population-standard-deviation.service";
-export * from "./quarter.vo";
-export * from "./quarter-iso-id.vo";
-export * from "./random.service";
-export * from "./rate-limiter.service";
-export * from "./relative-date.vo";
-export * from "./reordering.service";
-export * from "./reordering-item-position-value.vo";
-export * from "./revision.vo";
-export * from "./revision-value.vo";
-export * from "./rounding.strategy";
-export * from "./rounding-decimal.strategy";
-export * from "./rounding-down.strategy";
-export * from "./rounding-to-nearest.strategy";
-export * from "./rounding-up.strategy";
-export * from "./size.vo";
-export * from "./size-bytes.vo";
-export * from "./slug.service";
-export * from "./sum.service";
-export * from "./thousands-separator.service";
-export * from "./time-zone-offset-value.vo";
-export * from "./timestamp.vo";
-export * from "./timestamp-value.vo";
-export * from "./timezone.vo";
-export * from "./ts-utils";
-export * from "./url-with-slash.vo";
-export * from "./url-without-slash.vo";
-export * from "./visually-unambiguous-characters-generator.service";
-export * from "./week.vo";
-export * from "./week-iso-id.vo";
-export * from "./weekday.vo";
-export * from "./weight.vo";
-export * from "./weight-grams.vo";
-export * from "./year.vo";
-export * from "./year-iso-id.vo";
-export * from "./z-score.service";

package/src/integer-non-negative.vo.ts

@@ -1,16 +0,0 @@
-import { z } from "zod/v4";
-
-export const IntegerNonNegativeError = {
-  Type: "integer.non.negative.type",
-  Invalid: "integer.non.negative.invalid",
-};
-
-// Stryker disable all
-export const IntegerNonNegative = z
-  // Stryker restore all
-  .number(IntegerNonNegativeError.Type)
-  .int(IntegerNonNegativeError.Type)
-  .min(0, IntegerNonNegativeError.Invalid)
-  .brand("IntegerNonNegative");
-
-export type IntegerNonNegativeType = z.infer<typeof IntegerNonNegative>;

package/src/integer-positive.vo.ts

@@ -1,13 +0,0 @@
-import { z } from "zod/v4";
-
-export const IntegerPositiveError = { Type: "integer.positive.type", Invalid: "integer.positive.invalid" };
-
-// Stryker disable all
-export const IntegerPositive = z
-  // Stryker restore all
-  .number(IntegerPositiveError.Type)
-  .int(IntegerPositiveError.Type)
-  .min(1, IntegerPositiveError.Invalid)
-  .brand("IntegerPositive");
-
-export type IntegerPositiveType = z.infer<typeof IntegerPositive>;

package/src/integer.vo.ts

@@ -1,9 +0,0 @@
-import { z } from "zod/v4";
-
-export const IntegerError = { Type: "integer.type" };
-
-// Stryker disable all
-export const Integer = z.number(IntegerError.Type).int(IntegerError.Type).brand("Integer");
-// Stryker restore all
-
-export type IntegerType = z.infer<typeof Integer>;

package/src/language.vo.ts

@@ -1,13 +0,0 @@
-import { z } from "zod/v4";
-
-export const LanguageError = { Type: "language.type", BadChars: "language.bad.chars" };
-
-// Two lowercase letters
-const LANGUAGE_CHARS_WHITELIST = /^[a-z]{2}$/;
-
-export const Language = z
-  .string(LanguageError.Type)
-  .toLowerCase()
-  .regex(LANGUAGE_CHARS_WHITELIST, LanguageError.BadChars);
-
-export type LanguageType = z.infer<typeof Language>;

package/src/linear-regression.service.ts

@@ -1,73 +0,0 @@
-import type { RoundingStrategy } from "./rounding.strategy";
-import { RoundingToNearestStrategy } from "./rounding-to-nearest.strategy";
-
-export type LinearRegressionPairType = { x: number; y: number };
-export type LinearRegressionParamsType = { a: number; b: number };
-export type LinearRegressionPredictionType = number;
-
-export const LinearRegressionError = {
-  MinPairs: "linear.regression.min.pairs",
-  SumXTooBig: "linear.regression.sum.x.too.big",
-  SumYTooBig: "linear.regression.sum.y.too.big",
-  SumXSquaredTooBig: "linear.regression.sum.x.squared.too.big",
-  SumXTimesYTooBig: "linear.regression.sum.x.times.y.too.big",
-  ModelCreation: "linear.regression.model.creation",
-};
-
-export class LinearRegression {
-  private static readonly DEFAULT_ROUNDING: RoundingStrategy = new RoundingToNearestStrategy();
-
-  private readonly params: LinearRegressionParamsType;
-  private readonly rounding: RoundingStrategy;
-
-  constructor(params: LinearRegressionParamsType, rounding?: RoundingStrategy) {
-    this.params = params;
-    this.rounding = rounding ?? LinearRegression.DEFAULT_ROUNDING;
-  }
-
-  static fromPairs(pairs: LinearRegressionPairType[], rounding?: RoundingStrategy): LinearRegression {
-    const count = pairs.length;
-
-    if (count < 2) throw new Error(LinearRegressionError.MinPairs);
-
-    let sumX = 0;
-    let sumY = 0;
-    let sumXX = 0;
-    let sumXY = 0;
-
-    for (let index = 0; index < count; index++) {
-      const pair = pairs[index];
-      sumX += pair.x;
-      sumY += pair.y;
-      sumXX += pair.x * pair.x;
-      sumXY += pair.x * pair.y;
-    }
-
-    if (Math.abs(sumX) >= Number.MAX_SAFE_INTEGER) throw new Error(LinearRegressionError.SumXTooBig);
-    if (Math.abs(sumY) >= Number.MAX_SAFE_INTEGER) throw new Error(LinearRegressionError.SumYTooBig);
-    // Stryker disable all
-    if (Math.abs(sumXY) >= Number.MAX_SAFE_INTEGER) throw new Error(LinearRegressionError.SumXTimesYTooBig);
-    if (Math.abs(sumXX) >= Number.MAX_SAFE_INTEGER) throw new Error(LinearRegressionError.SumXSquaredTooBig);
-    // Stryker restore all
-
-    const bDenominator = sumXX - sumX ** 2 / count;
-
-    if (bDenominator === 0) throw new Error(LinearRegressionError.ModelCreation);
-
-    const b = (sumXY - (sumX * sumY) / count) / bDenominator;
-    const a = (sumY - b * sumX) / count;
-
-    return new LinearRegression({ a, b }, rounding);
-  }
-
-  predict(x: LinearRegressionPairType["x"], rounding?: RoundingStrategy): LinearRegressionPredictionType {
-    const chosen = rounding ?? this.rounding;
-    const prediction = this.params.b * x + this.params.a;
-
-    return chosen.round(prediction);
-  }
-
-  inspect(): LinearRegression["params"] {
-    return this.params;
-  }
-}

package/src/mean.service.ts

@@ -1,18 +0,0 @@
-import type { RoundingStrategy } from "./rounding.strategy";
-import { RoundingDecimalStrategy } from "./rounding-decimal.strategy";
-import { Sum } from "./sum.service";
-
-export const MeanError = { NotEnoughValues: "mean.not.enough.values" };
-
-export class Mean {
-  private static readonly DEFAULT_ROUNDING: RoundingStrategy = new RoundingDecimalStrategy(2);
-
-  static calculate(values: number[], rounding?: RoundingStrategy): number {
-    if (values.length === 0) throw new Error(MeanError.NotEnoughValues);
-
-    const sum = Sum.of(values);
-    const mean = sum / values.length;
-
-    return (rounding ?? Mean.DEFAULT_ROUNDING).round(mean);
-  }
-}

package/src/mime-types.vo.ts

@@ -1,7 +0,0 @@
-export const MIME_TYPES = {
-  wildcard: ["*/*"],
-  jpeg: ["image/jpeg"],
-  png: ["image/png"],
-  wav: ["audio/x-wav", "audio/wav"],
-  mp4: ["video/mp4"],
-} as const;

package/src/mime-value.vo.ts

@@ -1,14 +0,0 @@
-import { z } from "zod/v4";
-
-export const MimeValueError = { Type: "mime.value.type", Invalid: "mime.value.invalid" };
-
-// One to twenty four lowercase letters, asterisk or hyphen, forward slash, one to twenty four lowercase letters, asterisk or hyphen
-const MIME_VALUE_CHARS_WHITELIST = /^[a-z*-]{1,24}\/[a-z*-]{1,24}$/;
-
-// Stryker disable all
-export const MimeValue = z
-  // Stryker restore all
-  .string(MimeValueError.Type)
-  .regex(MIME_VALUE_CHARS_WHITELIST, MimeValueError.Invalid)
-  .transform((value) => ({ type: value.split("/")[0], subtype: value.split("/")[1] }))
-  .brand("MimeValue");