@serwist/utils 10.0.0-preview.1 → 10.0.0-preview.3

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { nonNullable } from "./nonNullable.js";
+import { parallel } from "./parallel.js";
+export { nonNullable, parallel };
+export { slash, toUnix, resolveBasePath, isAbsolute } from "./paths.js";
+export type * from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxE,mBAAmB,YAAY,CAAC"}

package/dist/index.js

@@ -26,8 +26,18 @@ const parallel = async (limit, array, func)=>{
     return results;
 };
 
+const slash = (str)=>{
+    return str.replace(/\\/g, "/");
+};
 const toUnix = (p)=>{
-    return p.replace(/\\/g, "/").replace(/(?<!^)\/+/g, "/");
+    return slash(p).replace(/(?<!^)\/+/g, "/");
+};
+const resolveBasePath = (base)=>{
+    if (isAbsolute(base)) return base;
+    return !base.startsWith("/") && !base.startsWith("./") ? `/${base}` : base;
+};
+const isAbsolute = (url)=>{
+    return url.match(/^(?:[a-z]+:)?\/\//i);
 };
 
-export { nonNullable, parallel, toUnix };
+export { isAbsolute, nonNullable, parallel, resolveBasePath, slash, toUnix };

package/dist/index.node.d.ts

@@ -0,0 +1,4 @@
+export { createLogger } from "./node/log.js";
+export type { LogType, LogLevel, LoggerOptions, Logger } from "./node/log.js";
+export { resolveEntry } from "./node/paths.js";
+//# sourceMappingURL=index.node.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.node.d.ts","sourceRoot":"","sources":["../src/index.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.node.js

@@ -0,0 +1,70 @@
+import fs, { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { red, yellow, cyan } from 'kolorist';
+import path from 'node:path';
+
+const LogLevels = {
+    silent: 0,
+    error: 1,
+    warn: 2,
+    info: 3
+};
+const require = createRequire(import.meta.url);
+const createLogger = (level = "info", options = {})=>{
+    const { prefix: _prefix = "serwist", showVersion = true, allowClearScreen = true } = options;
+    const packageJson = showVersion ? JSON.parse(readFileSync(require.resolve("@serwist/utils/package.json"), "utf-8")) : null;
+    const prefix = `${_prefix}${showVersion ? ` v${packageJson.version}` : ""}`;
+    const thresh = LogLevels[level];
+    const canClearScreen = allowClearScreen && process.stdout.isTTY && !process.env.CI;
+    const clear = canClearScreen ? console.clear : ()=>{};
+    const output = (type, msg, options = {})=>{
+        if (thresh >= LogLevels[type]) {
+            const method = type === "info" ? "log" : type;
+            if (options.clear) clear();
+            let tag = type === "error" ? red(prefix) : type === "warn" ? yellow(prefix) : cyan(prefix);
+            console[method](`${options.skipLine ? "\n" : ""}${tag} ${msg}`);
+        }
+    };
+    const warnedMessages = new Set();
+    return {
+        info (msg, opts) {
+            output("info", msg, opts);
+        },
+        warn (msg, opts) {
+            output("warn", msg, opts);
+        },
+        warnOnce (msg, opts) {
+            if (warnedMessages.has(msg)) return;
+            output("warn", msg, opts);
+            warnedMessages.add(msg);
+        },
+        error (msg, opts) {
+            output("error", msg, opts);
+        },
+        clearScreen (type) {
+            if (thresh >= LogLevels[type]) {
+                clear();
+            }
+        }
+    };
+};
+
+const resolveEntry = (entry)=>{
+    if (fs.existsSync(entry)) {
+        const stats = fs.statSync(entry);
+        if (stats.isDirectory()) {
+            return resolveEntry(path.join(entry, "index"));
+        }
+        return entry;
+    }
+    const dir = path.dirname(entry);
+    if (fs.existsSync(dir)) {
+        const base = path.basename(entry);
+        const files = fs.readdirSync(dir);
+        const found = files.find((file)=>file.replace(/\.[^.]+$/, "") === base);
+        if (found) return path.join(dir, found);
+    }
+    return null;
+};
+
+export { createLogger, resolveEntry };

package/dist/node/log.d.ts

@@ -0,0 +1,21 @@
+export type LogType = "error" | "warn" | "info";
+export type LogLevel = LogType | "silent";
+export interface LogOptions {
+    clear?: boolean;
+    skipLine?: boolean;
+}
+export declare const LogLevels: Record<LogLevel, number>;
+export interface LoggerOptions {
+    prefix?: string;
+    showVersion?: boolean;
+    allowClearScreen?: boolean;
+}
+export interface Logger {
+    info(msg: string, options?: LogOptions): void;
+    warn(msg: string, options?: LogOptions): void;
+    warnOnce(msg: string, options?: LogOptions): void;
+    error(msg: string, options?: LogOptions): void;
+    clearScreen(type: LogType): void;
+}
+export declare const createLogger: (level?: LogLevel, options?: LoggerOptions) => Logger;
+//# sourceMappingURL=log.d.ts.map

package/dist/node/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/node/log.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAChD,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;AAC1C,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AACD,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAK9C,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9C,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAClD,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC/C,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC;AAID,eAAO,MAAM,YAAY,GAAI,QAAO,QAAiB,EAAE,UAAS,aAAkB,KAAG,MAqCpF,CAAC"}

package/dist/node/paths.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Resolves a file path without extension. Also handles `/index` if the path
+ * actually points to a directory.
+ * @param ctx
+ * @param api
+ * @returns
+ */
+export declare const resolveEntry: (entry: string) => string | null;
+//# sourceMappingURL=paths.d.ts.map

package/dist/node/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/node/paths.ts"],"names":[],"mappings":"AAKA;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,MAAM,GAAG,IAqBrD,CAAC"}

package/dist/nonNullable.d.ts

@@ -0,0 +1,2 @@
+export declare const nonNullable: <T>(value: T) => value is NonNullable<T>;
+//# sourceMappingURL=nonNullable.d.ts.map

package/dist/nonNullable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nonNullable.d.ts","sourceRoot":"","sources":["../src/nonNullable.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,KAAK,IAAI,WAAW,CAAC,CAAC,CAA0C,CAAC"}

package/dist/parallel.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Executes many async functions in parallel. Returns the
+ * results from all functions as an array. Does not handle
+ * any error.
+ */
+export declare const parallel: <T, K>(limit: number, array: readonly T[], func: (item: T) => Promise<K>) => Promise<K[]>;
+//# sourceMappingURL=parallel.d.ts.map

package/dist/parallel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parallel.d.ts","sourceRoot":"","sources":["../src/parallel.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAU,CAAC,EAAE,CAAC,EAAE,OAAO,MAAM,EAAE,OAAO,SAAS,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,EAAE,CA4BnH,CAAC"}

package/dist/paths.d.ts

@@ -0,0 +1,5 @@
+export declare const slash: (str: string) => string;
+export declare const toUnix: (p: string) => string;
+export declare const resolveBasePath: (base: string) => string;
+export declare const isAbsolute: (url: string) => RegExpMatchArray | null;
+//# sourceMappingURL=paths.d.ts.map

package/dist/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK,GAAI,KAAK,MAAM,WAEhC,CAAC;AAEF,eAAO,MAAM,MAAM,GAAI,GAAG,MAAM,WAE/B,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,MAAM,MAAM,WAG3C,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,4BAErC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Makes certain fields in a object type required
+ *
+ * @example
+ *     interface A {
+ *         a?: string;
+ *         b?: string;
+ *         c?: string;
+ *     }
+ *     type B = RequiredFields<A, "b" | "c">;
+ *     const b: B = {
+ *         b: "hehe",
+ *         c: "hehe",
+ *     }; //valid
+ *     const b: B = { a: "hehe" }; //invalid
+ *     const c: B = { a: "hehe", b: "hehe" }; //invalid
+ */
+export type Require<T, U extends keyof T> = T & Required<Pick<T, U>>;
+/**
+ * Makes certain fields in a object type optional
+ *
+ * @example
+ *     interface A {
+ *         a: string;
+ *         b: string;
+ *         c: string;
+ *     }
+ *     type B = Optional<A, "b" | "c">;
+ *     const b: B = { a: "hehe" }; //valid
+ *     const b: B = {}; //invalid
+ */
+export type Optional<T, U extends keyof T> = Omit<T, U> & Partial<Pick<T, U>>;
+/**
+ * Makes an object type's hover overlay more readable
+ *
+ * @example
+ *
+ * interface A {
+ *   b: string;
+ *   c: boolean;
+ * }
+ *
+ * interface B {
+ *   c: number;
+ * }
+ *
+ * type D = A | B; // Displayed as is written
+ *
+ * type C = Prettify<A | B>; // { b: string; c: boolean; } | { c: number; }
+ */
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAErE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE9E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrB,GAAG,EAAE,CAAC"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@serwist/utils",
-  "version": "10.0.0-preview.1",
+  "version": "10.0.0-preview.3",
   "type": "module",
   "description": "This module contains internal utilities used by Serwist packages.",
   "files": [
-    "src"
+    "src",
+    "dist"
   ],
   "keywords": [
     "serwist",
@@ -19,22 +20,37 @@
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "node": {
+      "*": [
+        "./dist/index.node.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./node": {
+      "types": "./dist/index.node.d.ts",
+      "default": "./dist/index.node.js"
+    },
     "./package.json": "./package.json"
   },
+  "dependencies": {
+    "kolorist": "1.8.0"
+  },
   "devDependencies": {
-    "rollup": "4.34.8",
-    "typescript": "5.7.3",
-    "@serwist/configs": "10.0.0-preview.1"
+    "rollup": "4.40.0",
+    "typescript": "5.8.3",
+    "@serwist/configs": "10.0.0-preview.3"
   },
   "scripts": {
     "build": "rimraf dist && NODE_ENV=production rollup --config rollup.config.js",
     "dev": "rollup --config rollup.config.js --watch",
     "lint": "biome lint ./src",
+    "qcheck": "biome check ./src",
     "typecheck": "tsc"
   }
 }

package/src/index.node.ts

@@ -0,0 +1,3 @@
+export { createLogger } from "./node/log.js";
+export type { LogType, LogLevel, LoggerOptions, Logger } from "./node/log.js";
+export { resolveEntry } from "./node/paths.js";

package/src/index.ts

@@ -1,7 +1,6 @@
 import { nonNullable } from "./nonNullable.js";
 import { parallel } from "./parallel.js";
-import { toUnix } from "./toUnix.js";
-
-export { nonNullable, parallel, toUnix };
 
+export { nonNullable, parallel };
+export { slash, toUnix, resolveBasePath, isAbsolute } from "./paths.js";
 export type * from "./types.js";

package/src/node/log.ts

@@ -0,0 +1,71 @@
+import { readFileSync } from "node:fs";
+import { createRequire } from "node:module";
+import { cyan, yellow, red } from "kolorist";
+
+export type LogType = "error" | "warn" | "info";
+export type LogLevel = LogType | "silent";
+export interface LogOptions {
+  clear?: boolean;
+  skipLine?: boolean;
+}
+export const LogLevels: Record<LogLevel, number> = {
+  silent: 0,
+  error: 1,
+  warn: 2,
+  info: 3,
+};
+
+export interface LoggerOptions {
+  prefix?: string;
+  showVersion?: boolean;
+  allowClearScreen?: boolean;
+}
+
+export interface Logger {
+  info(msg: string, options?: LogOptions): void;
+  warn(msg: string, options?: LogOptions): void;
+  warnOnce(msg: string, options?: LogOptions): void;
+  error(msg: string, options?: LogOptions): void;
+  clearScreen(type: LogType): void;
+}
+
+const require = createRequire(import.meta.url);
+
+export const createLogger = (level: LogLevel = "info", options: LoggerOptions = {}): Logger => {
+  const { prefix: _prefix = "serwist", showVersion = true, allowClearScreen = true } = options;
+  const packageJson = showVersion ? JSON.parse(readFileSync(require.resolve("@serwist/utils/package.json"), "utf-8")) : null;
+  const prefix = `${_prefix}${showVersion ? ` v${packageJson.version}` : ""}`;
+  const thresh = LogLevels[level];
+  const canClearScreen = allowClearScreen && process.stdout.isTTY && !process.env.CI;
+  const clear = canClearScreen ? console.clear : () => {};
+  const output = (type: LogType, msg: string, options: LogOptions = {}) => {
+    if (thresh >= LogLevels[type]) {
+      const method = type === "info" ? "log" : type;
+      if (options.clear) clear();
+      let tag = type === "error" ? red(prefix) : type === "warn" ? yellow(prefix) : cyan(prefix);
+      console[method](`${options.skipLine ? "\n" : ""}${tag} ${msg}`);
+    }
+  };
+  const warnedMessages = new Set<string>();
+  return {
+    info(msg, opts) {
+      output("info", msg, opts);
+    },
+    warn(msg, opts) {
+      output("warn", msg, opts);
+    },
+    warnOnce(msg, opts) {
+      if (warnedMessages.has(msg)) return;
+      output("warn", msg, opts);
+      warnedMessages.add(msg);
+    },
+    error(msg, opts) {
+      output("error", msg, opts);
+    },
+    clearScreen(type) {
+      if (thresh >= LogLevels[type]) {
+        clear();
+      }
+    },
+  } satisfies Logger;
+};

package/src/node/paths.ts

@@ -0,0 +1,34 @@
+import fs from "node:fs";
+import path from "node:path";
+
+// Source: https://github.com/sveltejs/kit/blob/6419d3eaa7bf1b0a756b28f06a73f71fe042de0a/packages/kit/src/utils/filesystem.js
+// License: MIT
+/**
+ * Resolves a file path without extension. Also handles `/index` if the path
+ * actually points to a directory.
+ * @param ctx
+ * @param api
+ * @returns
+ */
+export const resolveEntry = (entry: string): string | null => {
+  if (fs.existsSync(entry)) {
+    const stats = fs.statSync(entry);
+    if (stats.isDirectory()) {
+      return resolveEntry(path.join(entry, "index"));
+    }
+
+    return entry;
+  }
+  const dir = path.dirname(entry);
+
+  if (fs.existsSync(dir)) {
+    const base = path.basename(entry);
+    const files = fs.readdirSync(dir);
+
+    const found = files.find((file) => file.replace(/\.[^.]+$/, "") === base);
+
+    if (found) return path.join(dir, found);
+  }
+
+  return null;
+};

package/src/paths.ts

@@ -0,0 +1,16 @@
+export const slash = (str: string) => {
+  return str.replace(/\\/g, "/");
+};
+
+export const toUnix = (p: string) => {
+  return slash(p).replace(/(?<!^)\/+/g, "/");
+};
+
+export const resolveBasePath = (base: string) => {
+  if (isAbsolute(base)) return base;
+  return !base.startsWith("/") && !base.startsWith("./") ? `/${base}` : base;
+};
+
+export const isAbsolute = (url: string) => {
+  return url.match(/^(?:[a-z]+:)?\/\//i);
+};

package/src/toUnix.ts

@@ -1,3 +0,0 @@
-export const toUnix = (p: string) => {
-  return p.replace(/\\/g, "/").replace(/(?<!^)\/+/g, "/");
-};