@forthtilliath/ts-kit 0.4.0 → 0.6.0

package/README.md

@@ -1,8 +1,8 @@
 # @forthtilliath/ts-kit
 
 Framework-agnostic TypeScript utility functions — arrays, objects, strings,
-async control-flow, dates, numbers, browser file downloads, and a couple of
-`Array` extensions with better type-narrowing.
+async control-flow, dates, numbers, browser file downloads, changelog/version
+parsing, and a couple of `Array` extensions with better type-narrowing.
 
 ## Install
 
@@ -103,6 +103,21 @@ import { chunk } from "@forthtilliath/ts-kit/array/chunk";
 - `randomId()` — `crypto.randomUUID()` with fallbacks for older/insecure
   contexts.
 
+### `image`
+
+- `compressImage(file, { maxWidth?, quality? })` — browser-side compression
+  via the Canvas API: scales down to `maxWidth` (default 2400px, aspect ratio
+  kept) and converts to WebP (default quality 0.82). Non-image files are
+  returned unchanged.
+
+### `markdown`
+
+- `parseChangelogNotes(notes)` — parses a small subset of Markdown
+  (`### heading`, `- item`, `**bold**`) commonly found in GitHub release
+  notes into a list of typed blocks (`heading` / `item` / `text`, each with
+  `bold`-aware segments), ready for a UI layer to render without a full
+  Markdown dependency.
+
 ### `maths`
 
 - `sum(numbers)` — sum of an array of numbers.
@@ -144,6 +159,11 @@ import { chunk } from "@forthtilliath/ts-kit/array/chunk";
 - `escapeHtml(text)` — basic HTML entity escaping (`&`, `<`, `>`, `"`) for
   inserting user text into an HTML template.
 
+### `version`
+
+- `compareVersions(a, b)` — compares two `"x.y.z"` version strings, segment
+  by segment; `-1`/`0`/`1`.
+
 ## Scripts
 
 ```bash

package/dist/image/compressImage.d.ts

@@ -0,0 +1,12 @@
+export interface CompressImageOptions {
+    /** Images wider than this are scaled down, keeping their aspect ratio. */
+    maxWidth?: number;
+    /** WebP quality, between 0 and 1. */
+    quality?: number;
+}
+/**
+ * Compresses an image in the browser via the Canvas API and converts it to WebP.
+ * Non-image files are returned unchanged.
+ */
+export declare function compressImage(file: File, { maxWidth, quality }?: CompressImageOptions): Promise<File>;
+//# sourceMappingURL=compressImage.d.ts.map

package/dist/image/compressImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compressImage.d.ts","sourceRoot":"","sources":["../../src/image/compressImage.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,IAAI,EACV,EAAE,QAAe,EAAE,OAAc,EAAE,GAAE,oBAAyB,GAC7D,OAAO,CAAC,IAAI,CAAC,CAiDf"}

package/dist/image/compressImage.js

@@ -0,0 +1,43 @@
+/**
+ * Compresses an image in the browser via the Canvas API and converts it to WebP.
+ * Non-image files are returned unchanged.
+ */
+export async function compressImage(file, { maxWidth = 2400, quality = 0.82 } = {}) {
+    if (!file.type.startsWith("image/"))
+        return file;
+    return new Promise((resolve, reject) => {
+        const img = new Image();
+        const objectUrl = URL.createObjectURL(file);
+        img.onload = () => {
+            URL.revokeObjectURL(objectUrl);
+            let width = img.naturalWidth;
+            let height = img.naturalHeight;
+            if (width > maxWidth) {
+                height = Math.round((height * maxWidth) / width);
+                width = maxWidth;
+            }
+            const canvas = document.createElement("canvas");
+            canvas.width = width;
+            canvas.height = height;
+            const ctx = canvas.getContext("2d");
+            if (!ctx) {
+                reject(new Error("Canvas 2D context is not supported"));
+                return;
+            }
+            ctx.drawImage(img, 0, 0, width, height);
+            canvas.toBlob((blob) => {
+                if (!blob) {
+                    reject(new Error("Image compression failed"));
+                    return;
+                }
+                const name = file.name.replace(/\.[^.]+$/, ".webp");
+                resolve(new File([blob], name, { type: "image/webp" }));
+            }, "image/webp", quality);
+        };
+        img.onerror = () => {
+            URL.revokeObjectURL(objectUrl);
+            reject(new Error("Failed to load image"));
+        };
+        img.src = objectUrl;
+    });
+}

package/dist/image/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./compressImage.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/image/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/image/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/dist/image/index.js

@@ -0,0 +1 @@
+export * from "./compressImage.js";

package/dist/index.d.ts

@@ -4,8 +4,11 @@ export * from "./classes/index.js";
 export * from "./date/index.js";
 export * from "./files/index.js";
 export * from "./id/index.js";
+export * from "./image/index.js";
+export * from "./markdown/index.js";
 export * from "./maths/index.js";
 export * from "./number/index.js";
 export * from "./object/index.js";
 export * from "./string/index.js";
+export * from "./version/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -9,7 +9,10 @@ export * from "./classes/index.js";
 export * from "./date/index.js";
 export * from "./files/index.js";
 export * from "./id/index.js";
+export * from "./image/index.js";
+export * from "./markdown/index.js";
 export * from "./maths/index.js";
 export * from "./number/index.js";
 export * from "./object/index.js";
 export * from "./string/index.js";
+export * from "./version/index.js";

package/dist/markdown/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./parseChangelogNotes.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/markdown/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/markdown/index.js

@@ -0,0 +1 @@
+export * from "./parseChangelogNotes.js";

package/dist/markdown/parseChangelogNotes.d.ts

@@ -0,0 +1,16 @@
+export interface ChangelogSegment {
+    text: string;
+    bold: boolean;
+}
+export type ChangelogBlock = {
+    type: "heading";
+    text: string;
+} | {
+    type: "item";
+    segments: ChangelogSegment[];
+} | {
+    type: "text";
+    segments: ChangelogSegment[];
+};
+export declare function parseChangelogNotes(notes: string): ChangelogBlock[];
+//# sourceMappingURL=parseChangelogNotes.d.ts.map

package/dist/markdown/parseChangelogNotes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseChangelogNotes.d.ts","sourceRoot":"","sources":["../../src/markdown/parseChangelogNotes.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAAE,GAC9C;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAAE,CAAC;AAsBnD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,EAAE,CAiBnE"}

package/dist/markdown/parseChangelogNotes.js

@@ -0,0 +1,43 @@
+// GitHub release notes (and changelogs in general) are usually written in a
+// small subset of Markdown ("### Heading", "- item", "**bold**"). Rendered
+// as-is in a plain UI text node, the raw syntax shows up unstyled — this
+// parser turns it into a small set of typed blocks a UI layer can render
+// (heading / bullet item / plain text), without pulling in a full Markdown
+// dependency for this narrow use case.
+function parseInlineSegments(text) {
+    const segments = [];
+    const boldPattern = /\*\*(.+?)\*\*/g;
+    let lastIndex = 0;
+    let match;
+    while ((match = boldPattern.exec(text)) !== null) {
+        if (match.index > lastIndex) {
+            segments.push({ text: text.slice(lastIndex, match.index), bold: false });
+        }
+        // The capture group is mandatory in the pattern, so it always matches —
+        // the `?? ""` fallback is only here to satisfy `noUncheckedIndexedAccess`.
+        segments.push({ text: match[1] ?? "", bold: true });
+        lastIndex = boldPattern.lastIndex;
+    }
+    if (lastIndex < text.length) {
+        segments.push({ text: text.slice(lastIndex), bold: false });
+    }
+    return segments;
+}
+export function parseChangelogNotes(notes) {
+    return notes
+        .split("\n")
+        .map((line) => line.trim())
+        .filter((line) => line.length > 0)
+        .map((line) => {
+        if (line.startsWith("### ")) {
+            return { type: "heading", text: line.slice(4).trim() };
+        }
+        if (line.startsWith("- ")) {
+            return {
+                type: "item",
+                segments: parseInlineSegments(line.slice(2).trim()),
+            };
+        }
+        return { type: "text", segments: parseInlineSegments(line) };
+    });
+}

package/dist/version/compareVersions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Compares two "x.y.z" version strings, segment by segment.
+ *
+ * @returns -1 if `a` < `b`, 0 if they're equal, 1 if `a` > `b`.
+ */
+export declare function compareVersions(a: string, b: string): number;
+//# sourceMappingURL=compareVersions.d.ts.map

package/dist/version/compareVersions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compareVersions.d.ts","sourceRoot":"","sources":["../../src/version/compareVersions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAU5D"}

package/dist/version/compareVersions.js

@@ -0,0 +1,17 @@
+/**
+ * Compares two "x.y.z" version strings, segment by segment.
+ *
+ * @returns -1 if `a` < `b`, 0 if they're equal, 1 if `a` > `b`.
+ */
+export function compareVersions(a, b) {
+    const partsA = a.split(".").map(Number);
+    const partsB = b.split(".").map(Number);
+    const length = Math.max(partsA.length, partsB.length);
+    for (let i = 0; i < length; i++) {
+        const numA = partsA[i] ?? 0;
+        const numB = partsB[i] ?? 0;
+        if (numA !== numB)
+            return numA > numB ? 1 : -1;
+    }
+    return 0;
+}

package/dist/version/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./compareVersions.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/version/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/version/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/dist/version/index.js

@@ -0,0 +1 @@
+export * from "./compareVersions.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/ts-kit",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -21,11 +21,12 @@
     "./*": "./dist/*.js"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "4.1.10",
     "eslint": "10.7.0",
     "jsdom": "^29.1.1",
     "typescript": "^5.9.3",
     "vitest": "^4.1.10",
-    "@forthtilliath/eslint-config": "0.4.2",
+    "@forthtilliath/eslint-config": "0.5.0",
     "@forthtilliath/typescript-config": "0.0.0"
   },
   "scripts": {
@@ -35,6 +36,7 @@
     "lint": "eslint . --max-warnings 0",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage"
   }
 }