@ix-xs/node-comfort 1.2.0 → 2.1.0

package/index.js

@@ -1,39 +1,84 @@
-const Logger = require("./src/Logger");
-const FS = require("./src/FS");
-const Checker = require("./src/Checker");
-const Utils = require("./src/Utils");
-const SQLite = require("./src/SQLite");
-const str = require("./src/Str");
-const num = require("./src/Num");
-const arr = require("./src/Arr");
-const obj = require("./src/Obj");
-const func = require("./src/Func");
-const time = require("./src/Time");
-const id = require("./src/Id");
+"use strict";
+
+// Every namespace is loaded the first time you touch it, so requiring the
+// package costs almost nothing.
+
+const fs = require("node:fs");
+const path = require("node:path");
+
+// The .env file must be applied before any user code reads process.env.
+if (String(process.env.NODE_COMFORT_DOTENV).toLowerCase() !== "false" && fs.existsSync(path.join(process.cwd(), ".env"))) {
+  require("./src/Env.js");
+}
+
+/** @type {Record<string, () => any>} */
+const modules = {
+  logger: () => require("./src/Logger.js"),
+  fs: () => require("./src/FS.js"),
+  checker: () => require("./src/Checker.js"),
+  utils: () => require("./src/Utils.js"),
+  str: () => require("./src/Str.js"),
+  num: () => require("./src/Num.js"),
+  arr: () => require("./src/Arr.js"),
+  obj: () => require("./src/Obj.js"),
+  func: () => require("./src/Func.js"),
+  time: () => require("./src/Time.js"),
+  id: () => require("./src/Id.js"),
+  crypto: () => require("./src/Crypto.js"),
+  color: () => require("./src/Color.js"),
+  cli: () => require("./src/Cli.js"),
+  sys: () => require("./src/Sys.js"),
+  async: () => require("./src/Async.js"),
+  schema: () => require("./src/Schema.js"),
+  http: () => require("./src/Http.js"),
+  env: () => require("./src/Env.js"),
+  errors: () => require("./src/errors.js"),
+  SQLite: () => require("./src/SQLite.js"),
+  Cache: () => require("./src/Cache.js"),
+  Emitter: () => require("./src/Emitter.js"),
+};
+
+// Helpers that are also available at the top level (nc.info, nc.readJSON...).
+const flat = {
+  logger: ["log", "trace", "debug", "info", "success", "warn", "error", "fatal", "group", "groupEnd", "timeStart", "timeEnd", "table", "box", "divider", "setLevel", "getLevel", "isLevelEnabled", "configure", "setTimestamp", "setDelimiter", "createLogger"],
+  fs: ["getEnv", "createPath", "getFolder", "getFile", "getFoldersIn", "getFilesIn", "glob", "find", "findUp", "readFile", "readLines", "readJSON", "writeFile", "writeJSON", "appendFile", "createFile", "createFolder", "ensureFolder", "ensureFile", "touch", "deleteFolder", "deleteFile", "remove", "deleteFoldersIn", "deleteFilesIn", "emptyFolder", "copy", "move", "copyFoldersIn", "copyFolder", "copyFilesIn", "copyFile", "moveFoldersIn", "moveFolder", "moveFilesIn", "moveFile", "exists", "isFile", "isFolder", "stat", "fileSize", "folderSize", "hashFile", "tempFolder", "sanitizeFilename", "watch"],
+  checker: ["isArray", "isNumber", "isFinite", "isInteger", "isSafeInteger", "isFloat", "isPositive", "isNegative", "isBoolean", "isString", "isSymbol", "isBigInt", "isUndefined", "isNull", "isNil", "isDefined", "isPrimitive", "isFunction", "isAsyncFunction", "isGeneratorFunction", "isGenerator", "isClass", "isObject", "isPlainObject", "isPromise", "isRegExp", "isDate", "isValidDate", "isMap", "isSet", "isWeakMap", "isWeakSet", "isIterable", "isAsyncIterable", "isBuffer", "isTypedArray", "isError", "isEmpty", "isBlank", "isArrayOf", "isOneOf", "isEmail", "isURL", "isUUID", "isJSON", "isNumeric", "isIP", "isIPv4", "isIPv6", "isPort", "isHex", "isHexColor", "isBase64", "isSemver", "isISODate", "isSlug", "isAlpha", "isAlphanumeric", "isCreditCard", "isJWT", "isHostname", "isMACAddress", "isIBAN", "isE164", "isObjectId", "isULID", "isDataURL", "isMimeType", "isTimeZone", "isLocale", "isCron", "isASCII", "assert", "assertType"],
+  utils: ["wait", "when", "dontCrash", "JSONString", "JSONParse"],
+};
 
 /**
- * @ix-xs/node-comfort
- *
- * A zero-dependency comfort belt for Node.js: a colorful logger, a safe
- * filesystem helper, a tiny SQLite wrapper, runtime type checks, async/process
- * helpers, plus rich string, number, array, object, function, date and
- * id/crypto utilities.
+ * @param {string} name
+ * @param {() => unknown} load
  */
-module.exports = {
-  ...Logger,
-  ...FS,
-  ...Checker,
-  ...Utils,
-  SQLite,
-  str,
-  num,
-  arr,
-  obj,
-  func,
-  time,
-  id,
-  logger: Logger,
-  fs: FS,
-  checker: Checker,
-  utils: Utils,
+const lazy = (name, load) => {
+  let loaded = false;
+  /** @type {unknown} */
+  let value;
+  Object.defineProperty(exports, name, {
+    get: () => {
+      if (!loaded) {
+        value = load();
+        loaded = true;
+      }
+      return value;
+    },
+    set: (replacement) => {
+      value = replacement;
+      loaded = true;
+    },
+    enumerable: true,
+    configurable: true,
+  });
 };
+
+for (const [namespace, names] of Object.entries(flat)) {
+  for (const name of names) lazy(name, () => modules[namespace]()[name]);
+}
+for (const [name, load] of Object.entries(modules)) lazy(name, load);
+
+exports.nc = exports;
+exports.nodeComfort = exports;
+
+// Never runs. Node reads this line to know the named exports of the package
+// when it is imported from an ES module.
+0 && (module.exports = { log, trace, debug, info, success, warn, error, fatal, group, groupEnd, timeStart, timeEnd, table, box, divider, setLevel, getLevel, isLevelEnabled, configure, setTimestamp, setDelimiter, createLogger, getEnv, createPath, getFolder, getFile, getFoldersIn, getFilesIn, glob, find, findUp, readFile, readLines, readJSON, writeFile, writeJSON, appendFile, createFile, createFolder, ensureFolder, ensureFile, touch, deleteFolder, deleteFile, remove, deleteFoldersIn, deleteFilesIn, emptyFolder, copy, move, copyFoldersIn, copyFolder, copyFilesIn, copyFile, moveFoldersIn, moveFolder, moveFilesIn, moveFile, exists, isFile, isFolder, stat, fileSize, folderSize, hashFile, tempFolder, sanitizeFilename, watch, isArray, isNumber, isFinite, isInteger, isSafeInteger, isFloat, isPositive, isNegative, isBoolean, isString, isSymbol, isBigInt, isUndefined, isNull, isNil, isDefined, isPrimitive, isFunction, isAsyncFunction, isGeneratorFunction, isGenerator, isClass, isObject, isPlainObject, isPromise, isRegExp, isDate, isValidDate, isMap, isSet, isWeakMap, isWeakSet, isIterable, isAsyncIterable, isBuffer, isTypedArray, isError, isEmpty, isBlank, isArrayOf, isOneOf, isEmail, isURL, isUUID, isJSON, isNumeric, isIP, isIPv4, isIPv6, isPort, isHex, isHexColor, isBase64, isSemver, isISODate, isSlug, isAlpha, isAlphanumeric, isCreditCard, isJWT, isHostname, isMACAddress, isIBAN, isE164, isObjectId, isULID, isDataURL, isMimeType, isTimeZone, isLocale, isCron, isASCII, assert, assertType, wait, when, dontCrash, JSONString, JSONParse, logger, fs, checker, utils, str, num, arr, obj, func, time, id, crypto, color, cli, sys, async, schema, http, env, errors, SQLite, Cache, Emitter, nc, nodeComfort });

package/package.json

@@ -1,74 +1,202 @@
 {
   "name": "@ix-xs/node-comfort",
-  "version": "1.2.0",
-  "description": "Zero-dependency comfort belt for Node.js: colorful logger, filesystem helper, SQLite wrapper, runtime type checks, async/process helpers, plus rich string, number, array, object, function, date and id/crypto utilities.",
-  "main": "index.js",
-  "types": "types/index.d.ts",
-  "type": "commonjs",
+  "version": "2.1.0",
+  "description": "The zero-dependency standard library for Node.js: logger, filesystem, SQLite, schema validation, HTTP client, CLI toolkit, cache, env, async pools, colors, events, i18n dates, ids, crypto and hundreds of fully typed helpers.",
   "keywords": [
     "utils",
     "utilities",
     "helpers",
     "toolkit",
+    "stdlib",
+    "standard-library",
+    "zero-dependency",
+    "no-dependencies",
+    "typescript",
     "logger",
-    "console",
     "colors",
     "ansi",
+    "cli",
+    "spinner",
+    "progress-bar",
+    "prompt",
     "filesystem",
     "fs",
+    "glob",
     "sqlite",
     "database",
-    "type-check",
-    "guards",
+    "schema",
     "validation",
+    "http",
+    "fetch",
+    "retry",
+    "cache",
+    "lru",
+    "env",
+    "dotenv",
+    "async",
+    "concurrency",
+    "queue",
+    "events",
+    "emitter",
+    "date",
+    "i18n",
+    "timezone",
+    "duration",
     "string",
     "slugify",
-    "camelcase",
-    "number",
-    "format-bytes",
     "array",
     "object",
-    "deep-clone",
     "deep-merge",
     "debounce",
     "throttle",
     "memoize",
-    "retry",
-    "date",
-    "duration",
     "uuid",
     "ulid",
     "nanoid",
-    "hash",
     "crypto",
-    "zero-dependency",
-    "no-dependencies"
+    "encryption",
+    "password-hashing"
   ],
-  "author": "ix-xs",
+  "homepage": "https://ix-xs.github.io/node-comfort/",
+  "bugs": {
+    "url": "https://github.com/ix-xs/node-comfort/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ix-xs/node-comfort.git"
+  },
   "license": "MIT",
-  "engines": {
-    "node": ">=20.12.0"
+  "author": "ix-xs",
+  "type": "commonjs",
+  "main": "./index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./index.js"
+    },
+    "./logger": {
+      "types": "./types/src/Logger.d.ts",
+      "default": "./src/Logger.js"
+    },
+    "./fs": {
+      "types": "./types/src/FS.d.ts",
+      "default": "./src/FS.js"
+    },
+    "./checker": {
+      "types": "./types/src/Checker.d.ts",
+      "default": "./src/Checker.js"
+    },
+    "./utils": {
+      "types": "./types/src/Utils.d.ts",
+      "default": "./src/Utils.js"
+    },
+    "./str": {
+      "types": "./types/src/Str.d.ts",
+      "default": "./src/Str.js"
+    },
+    "./num": {
+      "types": "./types/src/Num.d.ts",
+      "default": "./src/Num.js"
+    },
+    "./arr": {
+      "types": "./types/src/Arr.d.ts",
+      "default": "./src/Arr.js"
+    },
+    "./obj": {
+      "types": "./types/src/Obj.d.ts",
+      "default": "./src/Obj.js"
+    },
+    "./func": {
+      "types": "./types/src/Func.d.ts",
+      "default": "./src/Func.js"
+    },
+    "./time": {
+      "types": "./types/src/Time.d.ts",
+      "default": "./src/Time.js"
+    },
+    "./id": {
+      "types": "./types/src/Id.d.ts",
+      "default": "./src/Id.js"
+    },
+    "./crypto": {
+      "types": "./types/src/Crypto.d.ts",
+      "default": "./src/Crypto.js"
+    },
+    "./color": {
+      "types": "./types/src/Color.d.ts",
+      "default": "./src/Color.js"
+    },
+    "./cli": {
+      "types": "./types/src/Cli.d.ts",
+      "default": "./src/Cli.js"
+    },
+    "./sys": {
+      "types": "./types/src/Sys.d.ts",
+      "default": "./src/Sys.js"
+    },
+    "./async": {
+      "types": "./types/src/Async.d.ts",
+      "default": "./src/Async.js"
+    },
+    "./schema": {
+      "types": "./types/src/Schema.d.ts",
+      "default": "./src/Schema.js"
+    },
+    "./http": {
+      "types": "./types/src/Http.d.ts",
+      "default": "./src/Http.js"
+    },
+    "./env": {
+      "types": "./types/src/Env.d.ts",
+      "default": "./src/Env.js"
+    },
+    "./errors": {
+      "types": "./types/src/errors.d.ts",
+      "default": "./src/errors.js"
+    },
+    "./sqlite": {
+      "types": "./types/src/SQLite.d.ts",
+      "default": "./src/SQLite.js"
+    },
+    "./cache": {
+      "types": "./types/src/Cache.d.ts",
+      "default": "./src/Cache.js"
+    },
+    "./emitter": {
+      "types": "./types/src/Emitter.d.ts",
+      "default": "./src/Emitter.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "index.js",
     "src/",
     "types/",
     "README.md",
+    "CHANGELOG.md",
     "LICENSE"
   ],
-  "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
-  },
-  "devDependencies": {
-    "typescript": "^5.6.0"
+  "engines": {
+    "node": ">=22.13.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ix-xs/node-comfort.git"
+  "publishConfig": {
+    "access": "public"
   },
-  "bugs": {
-    "url": "https://github.com/ix-xs/node-comfort/issues"
+  "scripts": {
+    "build": "node scripts/build-types.js && node scripts/build-reference.js",
+    "build:types": "node scripts/build-types.js",
+    "build:reference": "node scripts/build-reference.js",
+    "test": "node --test --test-reporter=spec --test-timeout=120000 \"test/**/*.test.js\"",
+    "test:types": "node scripts/check-types.js",
+    "docs:install": "npm ci --prefix docs",
+    "docs:dev": "npm run dev --prefix docs",
+    "docs:build": "npm run build --prefix docs && npm run check-links --prefix docs && npm run check-translation --prefix docs",
+    "check": "npm run build && npm test && npm run test:types",
+    "prepublishOnly": "npm run check"
   },
-  "homepage": "https://github.com/ix-xs/node-comfort#readme"
+  "devDependencies": {
+    "@types/node": "^22.13.0",
+    "typescript": "~6.0.3"
+  }
 }