@forthtilliath/ts-kit 0.1.0 → 0.3.0

package/dist/object/groupBy.js

@@ -0,0 +1,18 @@
+/**
+ * Groups the elements of an array by a key derived from each element.
+ *
+ * @param array - The array to group.
+ * @param getKey - Computes the group key for an element.
+ * @returns A record mapping each key to the array of matching elements.
+ * @example
+ * groupBy([1, 2, 3, 4], (n) => (n % 2 === 0 ? "even" : "odd"));
+ * // => { odd: [1, 3], even: [2, 4] }
+ */
+export function groupBy(array, getKey) {
+    const result = {};
+    for (const item of array) {
+        const key = getKey(item);
+        (result[key] ??= []).push(item);
+    }
+    return result;
+}

package/dist/object/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./deepClone.js";
+export * from "./deepEqual.js";
+export * from "./groupBy.js";
+export * from "./mapValues.js";
+export * from "./omit.js";
+export * from "./pick.js";
+export * from "./uniqueBy.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/object/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC"}

package/dist/object/index.js

@@ -0,0 +1,7 @@
+export * from "./deepClone.js";
+export * from "./deepEqual.js";
+export * from "./groupBy.js";
+export * from "./mapValues.js";
+export * from "./omit.js";
+export * from "./pick.js";
+export * from "./uniqueBy.js";

package/dist/object/mapValues.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Creates a new object with the same keys, mapping each value through `fn`.
+ *
+ * @param obj - The source object.
+ * @param fn - Maps a value (and its key) to a new value.
+ * @returns A new object with transformed values.
+ * @example
+ * mapValues({ a: 1, b: 2 }, (n) => n * 2); // => { a: 2, b: 4 }
+ */
+export declare function mapValues<T extends object, R>(obj: T, fn: (value: T[keyof T], key: keyof T) => R): Record<keyof T, R>;
+//# sourceMappingURL=mapValues.d.ts.map

package/dist/object/mapValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapValues.d.ts","sourceRoot":"","sources":["../../src/object/mapValues.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAC3C,GAAG,EAAE,CAAC,EACN,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,GACzC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAMpB"}

package/dist/object/mapValues.js

@@ -0,0 +1,16 @@
+/**
+ * Creates a new object with the same keys, mapping each value through `fn`.
+ *
+ * @param obj - The source object.
+ * @param fn - Maps a value (and its key) to a new value.
+ * @returns A new object with transformed values.
+ * @example
+ * mapValues({ a: 1, b: 2 }, (n) => n * 2); // => { a: 2, b: 4 }
+ */
+export function mapValues(obj, fn) {
+    const result = {};
+    for (const key of Object.keys(obj)) {
+        result[key] = fn(obj[key], key);
+    }
+    return result;
+}

package/dist/object/omit.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Creates a new object without the specified keys.
+ *
+ * @param obj - The source object.
+ * @param keys - The keys to remove.
+ * @returns A new object without `keys`.
+ * @example
+ * omit({ a: 1, b: 2, c: 3 }, ["b"]); // => { a: 1, c: 3 }
+ */
+export declare function omit<T extends object, K extends keyof T>(obj: T, keys: readonly K[]): Omit<T, K>;
+//# sourceMappingURL=omit.d.ts.map

package/dist/object/omit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.d.ts","sourceRoot":"","sources":["../../src/object/omit.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,SAAS,CAAC,EAAE,GACjB,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAMZ"}

package/dist/object/omit.js

@@ -0,0 +1,16 @@
+/**
+ * Creates a new object without the specified keys.
+ *
+ * @param obj - The source object.
+ * @param keys - The keys to remove.
+ * @returns A new object without `keys`.
+ * @example
+ * omit({ a: 1, b: 2, c: 3 }, ["b"]); // => { a: 1, c: 3 }
+ */
+export function omit(obj, keys) {
+    const result = { ...obj };
+    for (const key of keys) {
+        Reflect.deleteProperty(result, key);
+    }
+    return result;
+}

package/dist/object/pick.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Creates a new object composed of only the specified keys.
+ *
+ * @param obj - The source object.
+ * @param keys - The keys to keep.
+ * @returns A new object containing only `keys`.
+ * @example
+ * pick({ a: 1, b: 2, c: 3 }, ["a", "c"]); // => { a: 1, c: 3 }
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: readonly K[]): Pick<T, K>;
+//# sourceMappingURL=pick.d.ts.map

package/dist/object/pick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.d.ts","sourceRoot":"","sources":["../../src/object/pick.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,SAAS,CAAC,EAAE,GACjB,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAQZ"}

package/dist/object/pick.js

@@ -0,0 +1,18 @@
+/**
+ * Creates a new object composed of only the specified keys.
+ *
+ * @param obj - The source object.
+ * @param keys - The keys to keep.
+ * @returns A new object containing only `keys`.
+ * @example
+ * pick({ a: 1, b: 2, c: 3 }, ["a", "c"]); // => { a: 1, c: 3 }
+ */
+export function pick(obj, keys) {
+    const result = {};
+    for (const key of keys) {
+        if (Object.prototype.hasOwnProperty.call(obj, key)) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}

package/dist/object/uniqueBy.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Removes duplicate elements from an array, keeping the first occurrence for
+ * each computed key.
+ *
+ * @param array - The array to deduplicate.
+ * @param getKey - Computes the uniqueness key for an element.
+ * @returns A new array with only the first element for each key.
+ * @example
+ * uniqueBy([{ id: 1 }, { id: 2 }, { id: 1 }], (item) => item.id);
+ * // => [{ id: 1 }, { id: 2 }]
+ */
+export declare function uniqueBy<T>(array: readonly T[], getKey: (item: T) => unknown): T[];
+//# sourceMappingURL=uniqueBy.d.ts.map

package/dist/object/uniqueBy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniqueBy.d.ts","sourceRoot":"","sources":["../../src/object/uniqueBy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EACxB,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,GAC3B,CAAC,EAAE,CAWL"}

package/dist/object/uniqueBy.js

@@ -0,0 +1,23 @@
+/**
+ * Removes duplicate elements from an array, keeping the first occurrence for
+ * each computed key.
+ *
+ * @param array - The array to deduplicate.
+ * @param getKey - Computes the uniqueness key for an element.
+ * @returns A new array with only the first element for each key.
+ * @example
+ * uniqueBy([{ id: 1 }, { id: 2 }, { id: 1 }], (item) => item.id);
+ * // => [{ id: 1 }, { id: 2 }]
+ */
+export function uniqueBy(array, getKey) {
+    const seen = new Set();
+    const result = [];
+    for (const item of array) {
+        const key = getKey(item);
+        if (!seen.has(key)) {
+            seen.add(key);
+            result.push(item);
+        }
+    }
+    return result;
+}

package/dist/string/capitalize.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Capitalizes the first character of a string and lower-cases the rest.
+ *
+ * @param str - The string to capitalize.
+ * @returns The capitalized string.
+ * @example
+ * capitalize("hello world"); // => "Hello world"
+ * capitalize("HELLO"); // => "Hello"
+ */
+export declare function capitalize(str: string): string;
+//# sourceMappingURL=capitalize.d.ts.map

package/dist/string/capitalize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capitalize.d.ts","sourceRoot":"","sources":["../../src/string/capitalize.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAG9C"}

package/dist/string/capitalize.js

@@ -0,0 +1,14 @@
+/**
+ * Capitalizes the first character of a string and lower-cases the rest.
+ *
+ * @param str - The string to capitalize.
+ * @returns The capitalized string.
+ * @example
+ * capitalize("hello world"); // => "Hello world"
+ * capitalize("HELLO"); // => "Hello"
+ */
+export function capitalize(str) {
+    if (str.length === 0)
+        return str;
+    return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+}

package/dist/string/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./capitalize.js";
+export * from "./pluralize.js";
+export * from "./slugify.js";
+export * from "./truncate.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC"}

package/dist/string/index.js

@@ -0,0 +1,4 @@
+export * from "./capitalize.js";
+export * from "./pluralize.js";
+export * from "./slugify.js";
+export * from "./truncate.js";

package/dist/string/pluralize.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Pluralizes a word based on a count, with a naive English default (`s`
+ * suffix, `y` → `ies`, `es` after `s`/`x`/`z`/`sh`/`ch`) or an explicit
+ * plural form for irregular words.
+ *
+ * @param count - The count driving singular vs. plural.
+ * @param singular - The singular form.
+ * @param plural - An explicit plural form (overrides the naive default).
+ * @returns `singular` when `count` is 1 or -1, otherwise the plural form.
+ * @example
+ * pluralize(1, "item"); // => "item"
+ * pluralize(3, "item"); // => "items"
+ * pluralize(3, "city"); // => "cities"
+ * pluralize(2, "child", "children"); // => "children"
+ */
+export declare function pluralize(count: number, singular: string, plural?: string): string;
+//# sourceMappingURL=pluralize.d.ts.map

package/dist/string/pluralize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluralize.d.ts","sourceRoot":"","sources":["../../src/string/pluralize.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,GACd,MAAM,CAMR"}

package/dist/string/pluralize.js

@@ -0,0 +1,26 @@
+/**
+ * Pluralizes a word based on a count, with a naive English default (`s`
+ * suffix, `y` → `ies`, `es` after `s`/`x`/`z`/`sh`/`ch`) or an explicit
+ * plural form for irregular words.
+ *
+ * @param count - The count driving singular vs. plural.
+ * @param singular - The singular form.
+ * @param plural - An explicit plural form (overrides the naive default).
+ * @returns `singular` when `count` is 1 or -1, otherwise the plural form.
+ * @example
+ * pluralize(1, "item"); // => "item"
+ * pluralize(3, "item"); // => "items"
+ * pluralize(3, "city"); // => "cities"
+ * pluralize(2, "child", "children"); // => "children"
+ */
+export function pluralize(count, singular, plural) {
+    if (Math.abs(count) === 1)
+        return singular;
+    if (plural !== undefined)
+        return plural;
+    if (/[sxz]$|[cs]h$/i.test(singular))
+        return `${singular}es`;
+    if (/[^aeiou]y$/i.test(singular))
+        return `${singular.slice(0, -1)}ies`;
+    return `${singular}s`;
+}

package/dist/string/slugify.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Converts a string into a URL-friendly slug: lower-cased, accents removed,
+ * non-alphanumeric runs collapsed into single hyphens.
+ *
+ * @param str - The string to slugify.
+ * @returns The slugified string.
+ * @example
+ * slugify("Héllo, World!"); // => "hello-world"
+ * slugify("  Multiple   spaces  "); // => "multiple-spaces"
+ */
+export declare function slugify(str: string): string;
+//# sourceMappingURL=slugify.d.ts.map

package/dist/string/slugify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slugify.d.ts","sourceRoot":"","sources":["../../src/string/slugify.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO3C"}

package/dist/string/slugify.js

@@ -0,0 +1,18 @@
+/**
+ * Converts a string into a URL-friendly slug: lower-cased, accents removed,
+ * non-alphanumeric runs collapsed into single hyphens.
+ *
+ * @param str - The string to slugify.
+ * @returns The slugified string.
+ * @example
+ * slugify("Héllo, World!"); // => "hello-world"
+ * slugify("  Multiple   spaces  "); // => "multiple-spaces"
+ */
+export function slugify(str) {
+    return str
+        .normalize("NFKD")
+        .replace(/[̀-ͯ]/g, "")
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "-")
+        .replace(/^-+|-+$/g, "");
+}

package/dist/string/truncate.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Truncates a string to a maximum length, appending a suffix when it was cut.
+ *
+ * @param str - The string to truncate.
+ * @param maxLength - The maximum length of the result, suffix included.
+ * @param suffix - Appended when the string is truncated (defaults to `"…"`).
+ * @returns `str` unchanged if it already fits, otherwise the truncated string.
+ * @example
+ * truncate("Hello world", 8); // => "Hello w…"
+ * truncate("Hi", 8); // => "Hi"
+ */
+export declare function truncate(str: string, maxLength: number, suffix?: string): string;
+//# sourceMappingURL=truncate.d.ts.map

package/dist/string/truncate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"truncate.d.ts","sourceRoot":"","sources":["../../src/string/truncate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,SAAM,GAAG,MAAM,CAI7E"}

package/dist/string/truncate.js

@@ -0,0 +1,17 @@
+/**
+ * Truncates a string to a maximum length, appending a suffix when it was cut.
+ *
+ * @param str - The string to truncate.
+ * @param maxLength - The maximum length of the result, suffix included.
+ * @param suffix - Appended when the string is truncated (defaults to `"…"`).
+ * @returns `str` unchanged if it already fits, otherwise the truncated string.
+ * @example
+ * truncate("Hello world", 8); // => "Hello w…"
+ * truncate("Hi", 8); // => "Hi"
+ */
+export function truncate(str, maxLength, suffix = "…") {
+    if (str.length <= maxLength)
+        return str;
+    const sliceLength = Math.max(0, maxLength - suffix.length);
+    return str.slice(0, sliceLength) + suffix;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/ts-kit",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -17,6 +17,7 @@
     "dist"
   ],
   "exports": {
+    ".": "./dist/index.js",
     "./*": "./dist/*.js"
   },
   "devDependencies": {
@@ -24,7 +25,7 @@
     "jsdom": "^29.1.1",
     "typescript": "^5.9.3",
     "vitest": "^4.1.10",
-    "@forthtilliath/eslint-config": "0.0.0",
+    "@forthtilliath/eslint-config": "0.4.2",
     "@forthtilliath/typescript-config": "0.0.0"
   },
   "scripts": {