@forthtilliath/ts-kit 0.5.0 → 0.7.0

package/README.md

@@ -46,6 +46,9 @@ import { chunk } from "@forthtilliath/ts-kit/array/chunk";
 - `rankByNameMatch(items, query, getName)` — ranks `items` by relevance to
   `query`: earlier match position first, then shorter name — for a
   search-as-you-type list.
+- `swapItems(items, i, j)` — copy of `items` with the elements at `i` and `j`
+  swapped (e.g. moving an item up/down) — a plain copy if either position is
+  out of bounds.
 
 ### `async`
 
@@ -103,6 +106,13 @@ 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

package/dist/array/index.d.ts

@@ -3,4 +3,5 @@ export * from "./flattenDeep.js";
 export * from "./getMostRecentIds.js";
 export * from "./nextInCycle.js";
 export * from "./rankByNameMatch.js";
+export * from "./swapItems.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/array/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC"}

package/dist/array/index.js

@@ -3,3 +3,4 @@ export * from "./flattenDeep.js";
 export * from "./getMostRecentIds.js";
 export * from "./nextInCycle.js";
 export * from "./rankByNameMatch.js";
+export * from "./swapItems.js";

package/dist/array/swapItems.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns a copy of `items` with the elements at positions `i` and `j`
+ * swapped (e.g. moving an item up or down in a reorderable list). Never
+ * mutates `items`, and stays sound under `noUncheckedIndexedAccess`.
+ *
+ * @param items - The array to copy.
+ * @param i - The position of the first element.
+ * @param j - The position of the second element.
+ * @returns A new array with both elements swapped, or a plain copy if either
+ * position is out of bounds.
+ * @example
+ * swapItems(["a", "b", "c"], 0, 2); // => ["c", "b", "a"]
+ * swapItems(["a", "b", "c"], 0, 5); // => ["a", "b", "c"]
+ */
+export declare function swapItems<T>(items: readonly T[], i: number, j: number): T[];
+//# sourceMappingURL=swapItems.d.ts.map

package/dist/array/swapItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swapItems.d.ts","sourceRoot":"","sources":["../../src/array/swapItems.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,CAQ3E"}

package/dist/array/swapItems.js

@@ -0,0 +1,24 @@
+/**
+ * Returns a copy of `items` with the elements at positions `i` and `j`
+ * swapped (e.g. moving an item up or down in a reorderable list). Never
+ * mutates `items`, and stays sound under `noUncheckedIndexedAccess`.
+ *
+ * @param items - The array to copy.
+ * @param i - The position of the first element.
+ * @param j - The position of the second element.
+ * @returns A new array with both elements swapped, or a plain copy if either
+ * position is out of bounds.
+ * @example
+ * swapItems(["a", "b", "c"], 0, 2); // => ["c", "b", "a"]
+ * swapItems(["a", "b", "c"], 0, 5); // => ["a", "b", "c"]
+ */
+export function swapItems(items, i, j) {
+    const next = [...items];
+    const a = next[i];
+    const b = next[j];
+    if (a === undefined || b === undefined)
+        return next;
+    next[i] = b;
+    next[j] = a;
+    return next;
+}

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,6 +4,7 @@ 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";

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,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,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,6 +9,7 @@ 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";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/ts-kit",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -21,12 +21,13 @@
     "./*": "./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/typescript-config": "0.0.0"
+    "@forthtilliath/typescript-config": "0.1.1",
+    "@forthtilliath/eslint-config": "0.7.0"
   },
   "scripts": {
     "dev": "tsc --watch -p tsconfig.build.json",
@@ -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"
   }
 }