@bgord/tools 1.1.9 → 1.1.12

package/dist/index.d.ts

@@ -75,6 +75,7 @@ export * from "./rounding.adapter";
 export * from "./rounding.port";
 export * from "./size.vo";
 export * from "./size-bytes.vo";
+export * from "./slug.service";
 export * from "./stopwatch.service";
 export * from "./sum.service";
 export * from "./thousands-separator.service";

package/dist/index.js

@@ -75,6 +75,7 @@ export * from "./rounding.adapter";
 export * from "./rounding.port";
 export * from "./size.vo";
 export * from "./size-bytes.vo";
+export * from "./slug.service";
 export * from "./stopwatch.service";
 export * from "./sum.service";
 export * from "./thousands-separator.service";

package/dist/mime.vo.d.ts

@@ -5,7 +5,8 @@ export declare const MimeError: {
 export declare class Mime {
     readonly type: string;
     readonly subtype: string;
-    constructor(candidate: string);
+    private constructor();
+    static fromString(candidate: string): Mime;
     static fromExtension(extension: ExtensionType): Mime;
     isSatisfiedBy(another: Mime): boolean;
     toExtension(): ExtensionType;

package/dist/mime.vo.js

@@ -5,13 +5,17 @@ export const MimeError = { NotAccepted: "mime.not.accepted" };
 export class Mime {
     type;
     subtype;
-    constructor(candidate) {
-        const { type, subtype } = MimeValue.parse(candidate);
+    constructor(type, subtype) {
         this.type = type;
         this.subtype = subtype;
     }
+    static fromString(candidate) {
+        const { type, subtype } = MimeValue.parse(candidate);
+        return new Mime(type, subtype);
+    }
     static fromExtension(extension) {
-        return new Mime(String(mime.contentType(extension)));
+        const { type, subtype } = MimeValue.parse(String(mime.contentType(extension)));
+        return new Mime(type, subtype);
     }
     isSatisfiedBy(another) {
         if (!(this.type === another.type || this.type === "*"))
@@ -29,8 +33,8 @@ export class Mime {
     }
 }
 export const MIMES = {
-    csv: new Mime("text/csv"),
-    text: new Mime("text/plain"),
-    markdown: new Mime("text/markdown"),
-    pdf: new Mime("application/pdf"),
+    csv: Mime.fromString("text/csv"),
+    text: Mime.fromString("text/plain"),
+    markdown: Mime.fromString("text/markdown"),
+    pdf: Mime.fromString("application/pdf"),
 };

package/dist/slug.service.d.ts

@@ -0,0 +1,4 @@
+export declare class Slug {
+    private static WHITELIST;
+    static generate(input: string, separator?: string): string;
+}

package/dist/slug.service.js

@@ -0,0 +1,15 @@
+export class Slug {
+    // Any letter or any number
+    static WHITELIST = /[\p{L}\p{N}]/u;
+    static generate(input, separator = "-") {
+        return (input
+            .split("")
+            .map((character) => (Slug.WHITELIST.test(character) ? character : separator))
+            .join("")
+            // Collapse multiple consecutive separators
+            .replace(new RegExp(`\\${separator}+`, "g"), separator)
+            // Trim leading and trailing separators
+            .replace(new RegExp(`^\\${separator}|\\${separator}$`, "g"), "")
+            .toLocaleLowerCase());
+    }
+}

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/age-years.vo.ts","../src/age.vo.ts","../src/api-key.vo.ts","../src/basename.vo.ts","../src/clock-format.service.ts","../src/clock.vo.ts","../src/date-calculator.service.ts","../src/date-formatter.service.ts","../src/date-range.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/division-factor.vo.ts","../src/dll.service.ts","../src/duration-ms.vo.ts","../src/duration.service.ts","../src/email-mask.service.ts","../src/etags.vo.ts","../src/extension.vo.ts","../src/feature-flag-value.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-affix.vo.ts","../src/filename-from-string.vo.ts","../src/filename.vo.ts","../src/height-milimiters.vo.ts","../src/height.vo.ts","../src/hour-format.service.ts","../src/hour-schema.vo.ts","../src/hour.vo.ts","../src/iban-mask.service.ts","../src/iban-schema.vo.ts","../src/iban.vo.ts","../src/image.vo.ts","../src/index.ts","../src/language.vo.ts","../src/linear-regression.service.ts","../src/mean.service.ts","../src/mime-types.vo.ts","../src/mime-value.vo.ts","../src/mime.vo.ts","../src/min-max-scaler.service.ts","../src/minute-schema.vo.ts","../src/minute.vo.ts","../src/money-amount.vo.ts","../src/money.vo.ts","../src/month-iso-id.vo.ts","../src/month.vo.ts","../src/multiplication-factor.vo.ts","../src/noop.service.ts","../src/notification-template.vo.ts","../src/object-key.vo.ts","../src/outlier-detector.service.ts","../src/package-version-schema.vo.ts","../src/package-version.vo.ts","../src/pagination-page.vo.ts","../src/pagination-skip.vo.ts","../src/pagination-take.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-item-position-value.vo.ts","../src/reordering.service.ts","../src/revision-value.vo.ts","../src/revision.vo.ts","../src/rounding.adapter.ts","../src/rounding.port.ts","../src/size-bytes.vo.ts","../src/size.vo.ts","../src/stopwatch.service.ts","../src/sum.service.ts","../src/thousands-separator.service.ts","../src/time-zone-offset-value.vo.ts","../src/timestamp-value.vo.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-grams.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"}
+{"root":["../src/age-years.vo.ts","../src/age.vo.ts","../src/api-key.vo.ts","../src/basename.vo.ts","../src/clock-format.service.ts","../src/clock.vo.ts","../src/date-calculator.service.ts","../src/date-formatter.service.ts","../src/date-range.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/division-factor.vo.ts","../src/dll.service.ts","../src/duration-ms.vo.ts","../src/duration.service.ts","../src/email-mask.service.ts","../src/etags.vo.ts","../src/extension.vo.ts","../src/feature-flag-value.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-affix.vo.ts","../src/filename-from-string.vo.ts","../src/filename.vo.ts","../src/height-milimiters.vo.ts","../src/height.vo.ts","../src/hour-format.service.ts","../src/hour-schema.vo.ts","../src/hour.vo.ts","../src/iban-mask.service.ts","../src/iban-schema.vo.ts","../src/iban.vo.ts","../src/image.vo.ts","../src/index.ts","../src/language.vo.ts","../src/linear-regression.service.ts","../src/mean.service.ts","../src/mime-types.vo.ts","../src/mime-value.vo.ts","../src/mime.vo.ts","../src/min-max-scaler.service.ts","../src/minute-schema.vo.ts","../src/minute.vo.ts","../src/money-amount.vo.ts","../src/money.vo.ts","../src/month-iso-id.vo.ts","../src/month.vo.ts","../src/multiplication-factor.vo.ts","../src/noop.service.ts","../src/notification-template.vo.ts","../src/object-key.vo.ts","../src/outlier-detector.service.ts","../src/package-version-schema.vo.ts","../src/package-version.vo.ts","../src/pagination-page.vo.ts","../src/pagination-skip.vo.ts","../src/pagination-take.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-item-position-value.vo.ts","../src/reordering.service.ts","../src/revision-value.vo.ts","../src/revision.vo.ts","../src/rounding.adapter.ts","../src/rounding.port.ts","../src/size-bytes.vo.ts","../src/size.vo.ts","../src/slug.service.ts","../src/stopwatch.service.ts","../src/sum.service.ts","../src/thousands-separator.service.ts","../src/time-zone-offset-value.vo.ts","../src/timestamp-value.vo.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-grams.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bgord/tools",
-  "version": "1.1.9",
+  "version": "1.1.12",
   "type": "module",
   "license": "MIT",
   "author": "Bartosz Gordon",
@@ -28,7 +28,7 @@
     "@types/mime-types": "3.0.1",
     "cspell": "9.4.0",
     "knip": "5.71.0",
-    "lefthook": "2.0.6",
+    "lefthook": "2.0.7",
     "only-allow": "1.2.2",
     "shellcheck": "4.1.0",
     "typescript": "5.9.3",

package/readme.md

@@ -100,6 +100,7 @@ src/
 ├── rounding.port.ts
 ├── size-bytes.vo.ts
 ├── size.vo.ts
+├── slug.service.ts
 ├── stopwatch.service.ts
 ├── sum.service.ts
 ├── thousands-separator.service.ts

package/src/index.ts

@@ -75,6 +75,7 @@ export * from "./rounding.adapter";
 export * from "./rounding.port";
 export * from "./size.vo";
 export * from "./size-bytes.vo";
+export * from "./slug.service";
 export * from "./stopwatch.service";
 export * from "./sum.service";
 export * from "./thousands-separator.service";

package/src/mime.vo.ts

@@ -5,18 +5,21 @@ import { MimeValue } from "./mime-value.vo";
 export const MimeError = { NotAccepted: "mime.not.accepted" } as const;
 
 export class Mime {
-  readonly type: string;
-  readonly subtype: string;
+  private constructor(
+    readonly type: string,
+    readonly subtype: string,
+  ) {}
 
-  constructor(candidate: string) {
+  static fromString(candidate: string): Mime {
     const { type, subtype } = MimeValue.parse(candidate);
 
-    this.type = type;
-    this.subtype = subtype;
+    return new Mime(type, subtype);
   }
 
   static fromExtension(extension: ExtensionType): Mime {
-    return new Mime(String(mime.contentType(extension)));
+    const { type, subtype } = MimeValue.parse(String(mime.contentType(extension)));
+
+    return new Mime(type, subtype);
   }
 
   isSatisfiedBy(another: Mime): boolean {
@@ -38,8 +41,8 @@ export class Mime {
 }
 
 export const MIMES = {
-  csv: new Mime("text/csv"),
-  text: new Mime("text/plain"),
-  markdown: new Mime("text/markdown"),
-  pdf: new Mime("application/pdf"),
+  csv: Mime.fromString("text/csv"),
+  text: Mime.fromString("text/plain"),
+  markdown: Mime.fromString("text/markdown"),
+  pdf: Mime.fromString("application/pdf"),
 };

package/src/slug.service.ts

@@ -0,0 +1,18 @@
+export class Slug {
+  // Any letter or any number
+  private static WHITELIST = /[\p{L}\p{N}]/u;
+
+  static generate(input: string, separator = "-"): string {
+    return (
+      input
+        .split("")
+        .map((character) => (Slug.WHITELIST.test(character) ? character : separator))
+        .join("")
+        // Collapse multiple consecutive separators
+        .replace(new RegExp(`\\${separator}+`, "g"), separator)
+        // Trim leading and trailing separators
+        .replace(new RegExp(`^\\${separator}|\\${separator}$`, "g"), "")
+        .toLocaleLowerCase()
+    );
+  }
+}