@gtkx/utils 1.0.0-rc.1 → 1.0.0-rc.2

package/dist/util/package-version.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Reads the `version` field from the `package.json` next to the calling module.
+ *
+ * @param importMetaUrl - The caller's `import.meta.url`, used to resolve the sibling `package.json`.
+ * @returns The package's version string.
+ *
+ * @example
+ * packageVersion(import.meta.url); // "1.2.3"
+ */
+declare function packageVersion(importMetaUrl: string): string;
+export { packageVersion };
+//# sourceMappingURL=package-version.d.ts.map

package/dist/util/package-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-version.d.ts","sourceRoot":"","sources":["../../src/util/package-version.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,iBAAS,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/util/package-version.js

@@ -0,0 +1,15 @@
+import { createRequire } from "node:module";
+/**
+ * Reads the `version` field from the `package.json` next to the calling module.
+ *
+ * @param importMetaUrl - The caller's `import.meta.url`, used to resolve the sibling `package.json`.
+ * @returns The package's version string.
+ *
+ * @example
+ * packageVersion(import.meta.url); // "1.2.3"
+ */
+function packageVersion(importMetaUrl) {
+    return createRequire(importMetaUrl)("../package.json").version;
+}
+export { packageVersion };
+//# sourceMappingURL=package-version.js.map

package/dist/util/package-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-version.js","sourceRoot":"","sources":["../../src/util/package-version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;;;;;;GAQG;AACH,SAAS,cAAc,CAAC,aAAqB;IACzC,OAAQ,aAAa,CAAC,aAAa,CAAC,CAAC,iBAAiB,CAAyB,CAAC,OAAO,CAAC;AAC5F,CAAC;AAED,OAAO,EAAE,cAAc,EAAE,CAAC","sourcesContent":["import { createRequire } from \"node:module\";\n\n/**\n * Reads the `version` field from the `package.json` next to the calling module.\n *\n * @param importMetaUrl - The caller's `import.meta.url`, used to resolve the sibling `package.json`.\n * @returns The package's version string.\n *\n * @example\n * packageVersion(import.meta.url); // \"1.2.3\"\n */\nfunction packageVersion(importMetaUrl: string): string {\n    return (createRequire(importMetaUrl)(\"../package.json\") as { version: string }).version;\n}\n\nexport { packageVersion };\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gtkx/utils",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "description": "Cross-package utilities shared by the GTKX packages and toolchain: logging, error formatting, string and class helpers",
   "keywords": [
     "gtkx",
@@ -41,8 +41,6 @@
     "node": ">=24"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.lib.json",
-    "typecheck": "tsc -b --emitDeclarationOnly",
     "release": "tsx ../../scripts/release-package.ts"
   }
 }

package/src/array/index-before-or-end.ts

@@ -0,0 +1,27 @@
+/**
+ * Finds the index of the first item matching `before`, or `list.length` when `before` is `null` or
+ * nothing matches. Use it to resolve where a new item should be inserted so it lands before the
+ * referenced one, defaulting to the end.
+ *
+ * @template T - The list item type.
+ * @template B - The reference value type.
+ * @param list - The list to search.
+ * @param before - The item to insert before, or `null` to target the end.
+ * @param isMatch - Called with each item and the non-null `before`; return `true` on a match.
+ * @returns The matched index, or `list.length`.
+ */
+const indexBeforeOrEnd = <T, B>(
+    list: T[],
+    before: B | null,
+    isMatch: (item: T, before: B) => boolean,
+): number => {
+    if (before === null) {
+        return list.length;
+    }
+
+    const index = list.findIndex((item) => isMatch(item, before));
+
+    return index === -1 ? list.length : index;
+};
+
+export { indexBeforeOrEnd };

package/src/array/index.ts

@@ -0,0 +1,5 @@
+export { indexBeforeOrEnd } from "./index-before-or-end.js";
+export { remove } from "./remove.js";
+export { sortStringsBy } from "./sort-strings-by.js";
+export { sortStrings } from "./sort-strings.js";
+export { uniqBy } from "./uniq-by.js";

package/src/array/remove.ts

@@ -0,0 +1,20 @@
+/**
+ * Removes the first strictly-equal (`===`) occurrence of `value` from `arr` in place.
+ *
+ * @template T - The type of the array elements.
+ * @param arr - The array to mutate.
+ * @param value - The value to remove.
+ *
+ * @example
+ * const items = ["a", "b", "c"];
+ * remove(items, "b"); // items is now ["a", "c"]
+ */
+function remove<T>(arr: T[], value: T): void {
+    const index = arr.indexOf(value);
+
+    if (index !== -1) {
+        arr.splice(index, 1);
+    }
+}
+
+export { remove };

package/src/array/sort-strings-by.ts

@@ -0,0 +1,17 @@
+/**
+ * Returns the items sorted by a string key using locale-aware comparison.
+ *
+ * @template T - The type of items being sorted.
+ * @param items - The items to sort.
+ * @param key - Maps an item to the string its order is decided by.
+ * @returns A new array of the items in ascending locale order of their keys.
+ *
+ * @example
+ * sortStringsBy([{ name: "b" }, { name: "a" }], (item) => item.name);
+ * // [{ name: "a" }, { name: "b" }]
+ */
+function sortStringsBy<T>(items: Iterable<T>, key: (item: T) => string): T[] {
+    return [...items].toSorted((a, b) => key(a).localeCompare(key(b)));
+}
+
+export { sortStringsBy };

package/src/array/sort-strings.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns the values sorted as strings using locale-aware comparison.
+ *
+ * @param values - The strings to sort.
+ * @returns A new array of the values in ascending locale order.
+ *
+ * @example
+ * sortStrings(["b", "a", "c"]); // ["a", "b", "c"]
+ */
+function sortStrings(values: Iterable<string>): string[] {
+    return [...values].toSorted((a, b) => a.localeCompare(b));
+}
+
+export { sortStrings };

package/src/array/uniq-by.ts

@@ -0,0 +1,33 @@
+/**
+ * Returns a new array of the unique elements of `arr`, keyed by the value the `mapper` returns.
+ *
+ * When two elements map to the same key the first occurrence is kept and later ones discarded,
+ * preserving first-seen order.
+ *
+ * @template T - The type of elements in the array.
+ * @param arr - The array to deduplicate.
+ * @param mapper - Maps an element to the key its uniqueness is decided by.
+ * @returns A new array containing only the first element seen for each distinct key.
+ *
+ * @example
+ * uniqBy([2.1, 1.2, 2.3], Math.floor); // [2.1, 1.2]
+ * uniqBy([{ id: "a" }, { id: "a" }, { id: "b" }], (item) => item.id); // [{ id: "a" }, { id: "b" }]
+ */
+function uniqBy<T>(arr: T[], mapper: (item: T, index: number, array: T[]) => unknown): T[] {
+    const seen: Map<unknown, T> = new Map();
+    let index = 0;
+
+    for (const item of arr) {
+        const key = mapper(item, index, arr);
+
+        if (!seen.has(key)) {
+            seen.set(key, item);
+        }
+
+        index++;
+    }
+
+    return seen.values().toArray();
+}
+
+export { uniqBy };

package/src/class/any-class.ts

@@ -0,0 +1,10 @@
+/**
+ * A constructor value of any (possibly abstract) class producing instances of `T`.
+ */
+type AnyClass<T extends object = object> = (abstract new (
+    ...args: never[]
+) => T) & {
+    prototype: T;
+};
+
+export { type AnyClass };

package/src/class/get-parent-class.ts

@@ -0,0 +1,15 @@
+import type { AnyClass } from "./any-class.js";
+
+/**
+ * Returns the direct superclass of `cls`, or `null` when it has no class ancestor.
+ *
+ * @param cls - The class whose prototype parent to inspect.
+ * @returns The parent class, or `null` when there is none.
+ */
+function getParentClass(cls: AnyClass): AnyClass | null {
+    const parent: unknown = Object.getPrototypeOf(cls);
+
+    return typeof parent === "function" && parent !== Function.prototype ? (parent as AnyClass) : null;
+}
+
+export { getParentClass };

package/src/class/index.ts

@@ -0,0 +1,3 @@
+export type { AnyClass } from "./any-class.js";
+export { getParentClass } from "./get-parent-class.js";
+export { walkClassChain } from "./walk-class-chain.js";

package/src/class/walk-class-chain.ts

@@ -0,0 +1,29 @@
+import type { AnyClass } from "./any-class.js";
+import { getParentClass } from "./get-parent-class.js";
+
+/**
+ * Walks the class chain from `cls` up through its ancestors, calling `visit` on each and returning
+ * the first result that is not `undefined`.
+ *
+ * @template T - The type produced by the visitor.
+ * @param cls - The class to start from, or `null` to visit nothing.
+ * @param visit - Called with each class in the chain; a defined return value stops the walk.
+ * @returns The first defined result from `visit`, or `undefined` when none was produced.
+ */
+function walkClassChain<T>(cls: AnyClass | null, visit: (ancestor: AnyClass) => T | undefined): T | undefined {
+    let current = cls;
+
+    while (current !== null) {
+        const result = visit(current);
+
+        if (result !== undefined) {
+            return result;
+        }
+
+        current = getParentClass(current);
+    }
+
+    return undefined;
+}
+
+export { walkClassChain };

package/src/error/error-like.ts

@@ -0,0 +1,19 @@
+import { isRecord } from "../predicate/is-record.js";
+
+function isErrorLike(value: unknown): value is { message: string } {
+    return isRecord(value) && "message" in value && typeof value.message === "string";
+}
+
+function readStream(value: unknown): string {
+    if (typeof value === "string") {
+        return value;
+    }
+
+    if (value instanceof Uint8Array || Buffer.isBuffer(value)) {
+        return value.toString();
+    }
+
+    return "";
+}
+
+export { isErrorLike, readStream };

package/src/error/error-message.ts

@@ -0,0 +1,17 @@
+import { isErrorLike } from "./error-like.js";
+
+/**
+ * Extracts a human-readable message from an unknown thrown value, falling back to its string form.
+ *
+ * @param error - The caught value to describe.
+ * @returns The value's message when it has one, otherwise its string form.
+ *
+ * @example
+ * errorMessage(new Error("boom")); // "boom"
+ * errorMessage(42); // "42"
+ */
+function errorMessage(error: unknown): string {
+    return Error.isError(error) || isErrorLike(error) ? error.message : String(error);
+}
+
+export { errorMessage };

package/src/error/format-child-process-error.ts

@@ -0,0 +1,24 @@
+import { isRecord } from "../predicate/is-record.js";
+import { readStream } from "./error-like.js";
+
+/**
+ * Combines the `stderr` and `stdout` of a failed child-process error into a single trimmed string.
+ *
+ * @param error - The child-process error to read output from.
+ * @returns The joined output, or `undefined` when neither stream carried any text.
+ *
+ * @example
+ * formatChildProcessError({ stderr: "boom" }); // "boom"
+ */
+function formatChildProcessError(error: unknown): string | undefined {
+    if (!isRecord(error)) {
+        return undefined;
+    }
+
+    const { stderr, stdout } = error;
+    const details = [readStream(stderr), readStream(stdout)].filter(Boolean).join("\n").trim();
+
+    return details.length > 0 ? details : undefined;
+}
+
+export { formatChildProcessError };

package/src/error/index.ts

@@ -0,0 +1,3 @@
+export { errorMessage } from "./error-message.js";
+export { formatChildProcessError } from "./format-child-process-error.js";
+export { normalizeError } from "./normalize-error.js";

package/src/error/normalize-error.ts

@@ -0,0 +1,22 @@
+import { isErrorLike } from "./error-like.js";
+import { errorMessage } from "./error-message.js";
+
+/**
+ * Coerces an unknown thrown value into an `Error`, reusing it when it already is one and otherwise
+ * wrapping its message while copying any error-like own properties.
+ *
+ * @param error - The caught value to normalize.
+ * @returns The value itself when it is an `Error`, otherwise a new `Error` carrying its message.
+ *
+ * @example
+ * normalizeError("boom"); // Error: boom
+ */
+function normalizeError(error: unknown): Error {
+    if (Error.isError(error)) {
+        return error;
+    }
+
+    return Object.assign(new Error(errorMessage(error)), isErrorLike(error) ? error : {});
+}
+
+export { normalizeError };

package/src/function/call-method.ts

@@ -0,0 +1,22 @@
+/**
+ * Calls the named method on `target` with the given arguments, returning `undefined` when the
+ * property is missing or not callable.
+ *
+ * @param target - The object to read the method from and bind as `this`.
+ * @param method - The name of the method to look up.
+ * @param args - The arguments passed to the method.
+ * @returns The method's return value, or `undefined` when it is not a function.
+ *
+ * @example
+ * callMethod(console, "log", ["hi"]); // logs "hi"; returns undefined
+ */
+const isCallable = (value: unknown): value is (this: object, ...args: unknown[]) => unknown =>
+    typeof value === "function";
+
+function callMethod(target: object, method: string, args: unknown[]): unknown {
+    const fn: unknown = Reflect.get(target, method);
+
+    return isCallable(fn) ? Reflect.apply(fn, target, args) : undefined;
+}
+
+export { callMethod };

package/src/function/index.ts

@@ -0,0 +1 @@
+export { callMethod } from "./call-method.js";

package/src/index.ts

@@ -1,19 +1,13 @@
-export { type AnyClass, getParentClass, walkClassChain } from "./class.js";
-export { isSameArray, isShallowEqual, sortStrings, sortStringsBy, uniqBy } from "./collection.js";
-export { errorMessage, formatChildProcessError, normalizeError } from "./error.js";
-export { exitCodeForSignal, installGracefulShutdown } from "./graceful-shutdown.js";
-export {
-    createLogger,
-    debug,
-    error,
-    info,
-    Logger,
-    type LoggerOptions,
-    logger,
-    type OutputStream,
-    warn,
-} from "./log.js";
-export { packageVersion } from "./package-version.js";
-export { callMethod } from "./reflect.js";
-export { sanitizeIdentifier, sourceStringLiteral, toCamelIdentifier } from "./source.js";
-export { lowerFirst, toCamelCase, toKebabCase, toPascalCase, upperFirst } from "./string.js";
+export * from "./array/index.js";
+export * from "./class/index.js";
+export * from "./error/index.js";
+export * from "./function/index.js";
+export * from "./log/index.js";
+export * from "./map/index.js";
+export * from "./object/index.js";
+export * from "./predicate/index.js";
+export * from "./process/index.js";
+export * from "./set/index.js";
+export * from "./source/index.js";
+export * from "./string/index.js";
+export * from "./util/index.js";

package/src/log/create-logger.ts

@@ -0,0 +1,18 @@
+import { Logger, type LoggerOptions } from "./logger.js";
+
+/**
+ * Creates a {@link Logger} scoped to the given namespace.
+ *
+ * @param namespace - Namespace added to the log prefix and matched against debug configuration.
+ * @param options - Further logger options, excluding the namespace.
+ * @returns A new namespaced logger.
+ *
+ * @example
+ * const log = createLogger("react");
+ * log.info("mounted");
+ */
+function createLogger(namespace: string, options: Omit<LoggerOptions, "namespace"> = {}): Logger {
+    return new Logger({ ...options, namespace });
+}
+
+export { createLogger };

package/src/log/default-logger.ts

@@ -0,0 +1,49 @@
+import { Logger } from "./logger.js";
+
+/**
+ * The default namespace-less {@link Logger} backing the module-level {@link info}, {@link warn},
+ * {@link error}, and {@link debug} functions.
+ */
+const logger: Logger = new Logger();
+
+/**
+ * Writes an informational line through the shared {@link logger}.
+ *
+ * @param message - The message text.
+ * @param rest - Extra values appended after the message, formatted for display.
+ */
+function info(message: string, ...rest: unknown[]): void {
+    logger.info(message, ...rest);
+}
+
+/**
+ * Writes a warning line through the shared {@link logger}.
+ *
+ * @param message - The message text.
+ * @param rest - Extra values appended after the message, formatted for display.
+ */
+function warn(message: string, ...rest: unknown[]): void {
+    logger.warn(message, ...rest);
+}
+
+/**
+ * Writes an error line through the shared {@link logger}.
+ *
+ * @param message - The message text.
+ * @param rest - Extra values appended after the message, formatted for display.
+ */
+function error(message: string, ...rest: unknown[]): void {
+    logger.error(message, ...rest);
+}
+
+/**
+ * Writes a debug line through the shared {@link logger} when debug output is enabled.
+ *
+ * @param message - The message text.
+ * @param rest - Extra values appended after the message, formatted for display.
+ */
+function debug(message: string, ...rest: unknown[]): void {
+    logger.debug(message, ...rest);
+}
+
+export { logger, info, warn, error, debug };

package/src/log/index.ts

@@ -0,0 +1,3 @@
+export { createLogger } from "./create-logger.js";
+export { debug, error, info, logger, warn } from "./default-logger.js";
+export { Logger, type LoggerOptions, type OutputStream } from "./logger.js";

package/src/log/logger.ts

@@ -0,0 +1,142 @@
+import pc from "picocolors";
+
+type Colors = ReturnType<typeof pc.createColors>;
+
+/**
+ * Minimal writable-stream shape a {@link Logger} writes formatted lines to.
+ */
+type OutputStream = {
+    write(chunk: string): unknown;
+    /** Whether the stream is a terminal, used to decide if colored output is emitted. */
+    isTTY?: boolean | undefined;
+};
+
+/**
+ * Options for constructing a {@link Logger}.
+ */
+type LoggerOptions = {
+    /** Namespace appended to the log prefix and matched against debug configuration. */
+    namespace?: string | undefined;
+    /** Stream to write log lines to; defaults to `process.stderr`. */
+    stream?: OutputStream | undefined;
+    /** Forces debug output on or off; when omitted it is resolved from `--debug` and `GTKX_DEBUG`. */
+    debugEnabled?: boolean | undefined;
+};
+
+const BASE_PREFIX = "[gtkx]";
+
+function getColors(stream: OutputStream): Colors {
+    return pc.createColors(pc.isColorSupported && stream.isTTY === true);
+}
+
+function formatValue(value: unknown): string {
+    if (typeof value === "string") {
+        return value;
+    }
+
+    if (value instanceof Error) {
+        return value.stack ?? value.message;
+    }
+
+    try {
+        return JSON.stringify(value);
+    } catch {
+        return String(value);
+    }
+}
+
+function isDebugEnabled(namespace: string | undefined, argv: string[], env: NodeJS.ProcessEnv): boolean {
+    if (argv.includes("--debug")) {
+        return true;
+    }
+
+    const spec = env.GTKX_DEBUG;
+
+    if (!spec) {
+        return false;
+    }
+
+    const names = new Set(spec.split(/[\s,]+/).filter((name) => name.length > 0));
+
+    if (names.has("1") || names.has("*")) {
+        return true;
+    }
+
+    return namespace !== undefined && names.has(namespace);
+}
+
+function getPrefix(namespace: string | undefined): string {
+    return namespace === undefined ? BASE_PREFIX : `[gtkx:${namespace}]`;
+}
+
+/**
+ * Writes prefixed, optionally colored log lines to an output stream, with debug lines gated by
+ * command-line and environment configuration.
+ */
+class Logger {
+    private stream: OutputStream;
+    private prefix: string;
+    private debugEnabled: boolean;
+    private colors: Colors;
+
+    /**
+     * @param options - Namespace, target stream, and debug configuration for the logger.
+     */
+    constructor(options: LoggerOptions = {}) {
+        this.stream = options.stream ?? process.stderr;
+        this.prefix = getPrefix(options.namespace);
+        this.debugEnabled = options.debugEnabled ?? isDebugEnabled(options.namespace, process.argv, process.env);
+        this.colors = getColors(this.stream);
+    }
+
+    private write(message: string, rest: unknown[]): void {
+        const suffix = rest.length === 0 ? "" : ` ${rest.map((value) => formatValue(value)).join(" ")}`;
+        this.stream.write(`${this.prefix} ${message}${suffix}\n`);
+    }
+
+    /**
+     * Writes an informational line.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    info(message: string, ...rest: unknown[]): void {
+        this.write(message, rest);
+    }
+
+    /**
+     * Writes a line marked as a warning.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    warn(message: string, ...rest: unknown[]): void {
+        this.write(`${this.colors.yellow("warn")} ${message}`, rest);
+    }
+
+    /**
+     * Writes a line marked as an error.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    error(message: string, ...rest: unknown[]): void {
+        this.write(`${this.colors.red("error")} ${message}`, rest);
+    }
+
+    /**
+     * Writes a line only when debug output is enabled for this logger.
+     *
+     * @param message - The message text.
+     * @param rest - Extra values appended after the message, formatted for display.
+     */
+    debug(message: string, ...rest: unknown[]): void {
+        if (!this.debugEnabled) {
+            return;
+        }
+
+        this.write(message, rest);
+    }
+}
+
+export { Logger, type OutputStream, type LoggerOptions };

package/src/map/get-or-insert.ts

@@ -0,0 +1,33 @@
+type GetSet<K, V> = {
+    get(key: K): V | undefined;
+    set(key: K, value: V): unknown;
+    has(key: K): boolean;
+};
+
+/**
+ * Returns the value stored under `key`, or inserts and returns the value produced by `factory` when
+ * the key is absent. Works with both `Map` and `WeakMap`, and caches a computed `undefined` value.
+ *
+ * @template K - The key type.
+ * @template V - The value type.
+ * @param map - The `Map` or `WeakMap` to read from and populate.
+ * @param key - The key to look up.
+ * @param factory - Produces the value to insert when `key` is absent; called at most once.
+ * @returns The existing or newly-inserted value.
+ *
+ * @example
+ * const counts = new Map<string, number[]>();
+ * getOrInsert(counts, "a", () => []).push(1); // counts is Map { "a" => [1] }
+ */
+function getOrInsert<K, V>(map: GetSet<K, V>, key: K, factory: (key: K) => V): V {
+    if (map.has(key)) {
+        return map.get(key) as V;
+    }
+
+    const value = factory(key);
+    map.set(key, value);
+
+    return value;
+}
+
+export { getOrInsert, type GetSet };

package/src/map/index.ts

@@ -0,0 +1 @@
+export { getOrInsert } from "./get-or-insert.js";

package/src/object/index.ts

@@ -0,0 +1,3 @@
+export { omit } from "./omit.js";
+export { pickBy } from "./pick-by.js";
+export { structuredClone } from "./structured-clone.js";