@hypernym/utils 1.2.0 → 2.0.0

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Hypernym Studio, Ivo Dolenc
+Copyright (c) 2023 Ivo Dolenc, Hypernym Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,25 +4,19 @@ A collection of reusable utilities.
 
 <sub><a href="https://github.com/hypernym-studio/utils">Repository</a> | <a href="https://www.npmjs.com/package/@hypernym/utils">Package</a> | <a href="https://github.com/hypernym-studio/utils/releases">Releases</a> | <a href="https://github.com/hypernym-studio/utils/discussions">Discussions</a></sub>
 
+```sh
+npm i -D @hypernym/utils
+```
+
 ## Features
 
-- Supports CJS & ESM
 - TypeScript friendly
 - Fully tree-shakeable
 - No dependencies
 
-## Installation
-
-```sh
-npm i -D @hypernym/utils
-```
-
 ## Usage
 
 ```ts
-// CJS
-const { isNull, isString, ... } = require('@hypernym/utils')
-
 // ESM & TS
 import { isNull, isString, ... } from '@hypernym/utils'
 

package/dist/index.mjs

@@ -31,15 +31,4 @@ const isNodeListEmpty = (v) => isNodeList(v) && v.length === 0;
 const isHtmlCollection = (v) => v instanceof HTMLCollection;
 const isHtmlCollectionEmpty = (v) => isHtmlCollection(v) && v.length === 0;
 
-function formatBytes(bytes, options) {
-  const decimals = options?.decimals || 2;
-  const units = ["B", "KB", "MB", "GB", "TB"];
-  if (bytes === 0)
-    return `0 B`;
-  const k = 1024;
-  const dm = decimals < 0 ? 0 : decimals;
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${units[i]}`;
-}
-
-export { formatBytes, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };
+export { isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };

package/dist/node/index.mjs

@@ -1,77 +1,7 @@
-import { access, constants, readdir, stat } from 'node:fs/promises';
-import { resolve, basename, parse } from 'node:path';
+import { access, constants } from 'node:fs/promises';
 
 async function exists(path) {
   return await access(path, constants.F_OK).then(() => true).catch(() => false);
 }
 
-async function getDirStats(path, options) {
-  const dirPath = resolve(path);
-  const dirFiles = await readdir(dirPath);
-  const dirBase = basename(dirPath);
-  let dirStats = [];
-  const subdirList = [];
-  const fileList = [];
-  let dirSize = 0;
-  let dirIndex = 0;
-  let fileIndex = -1;
-  let subdirIndex = -1;
-  for (const file of dirFiles) {
-    const filePath = resolve(path, file);
-    const fileStat = await stat(filePath);
-    if (fileStat.isDirectory()) {
-      subdirIndex++;
-      subdirList.push({
-        index: subdirIndex,
-        path: filePath,
-        base: file
-      });
-      if (options?.recursive) {
-        const stats = await getDirStats(filePath);
-        const updateDirStats = { ...stats[0], ...{ index: dirIndex++ } };
-        dirStats = [...dirStats, updateDirStats];
-      }
-    } else {
-      const { base, name, ext } = parse(file);
-      const { size } = fileStat;
-      fileIndex++;
-      dirSize += size;
-      fileList.push({
-        index: fileIndex,
-        path: filePath,
-        base,
-        name,
-        ext,
-        size
-      });
-    }
-  }
-  dirStats.push({
-    index: dirIndex,
-    path: dirPath,
-    base: dirBase,
-    size: dirSize,
-    subdirs: subdirList,
-    files: fileList
-  });
-  return dirStats;
-}
-
-async function getDirFiles(path, options) {
-  const dirPath = resolve(path);
-  const dirFiles = await readdir(dirPath, { withFileTypes: true });
-  let fileList = [];
-  for (const file of dirFiles) {
-    const filePath = resolve(path, file.name);
-    if (file.isDirectory()) {
-      if (options?.recursive) {
-        fileList = [...fileList, ...await getDirFiles(filePath)];
-      }
-    } else {
-      fileList.push(filePath);
-    }
-  }
-  return fileList;
-}
-
-export { exists, getDirFiles, getDirStats };
+export { exists };

package/dist/{index.d.ts → types/index.d.ts}

@@ -142,16 +142,7 @@ type IsAny<T> = 0 extends 1 & T ? true : false;
  */
 type IsNever<T> = [T] extends [never] ? true : false;
 
-/**
- * Converts bytes to a _human-readable_ size and appends a units suffix.
- */
-declare function formatBytes(bytes: number, options?: FormatBytesOptions): string;
-
-interface FormatBytesOptions {
-    decimals?: number;
-}
-
-type OptionsDeep = {
+type PartialOptions = {
     /**
      * Enables recursive mode for arrays and tuples.
      *
@@ -159,33 +150,40 @@ type OptionsDeep = {
      */
     readonly arrays?: boolean;
 };
-
 /**
  * Constructs a type by recursively setting all properties as optional.
  *
  * Use `Partial<T>` for one level.
  */
-type PartialDeep<T, Options extends OptionsDeep = {
+type PartialDeep<T, Options extends PartialOptions = {
     arrays: true;
 }> = T extends BuiltIn ? T | undefined : T extends Map<infer K, infer V> ? Map<PartialDeep<K, Options>, PartialDeep<V, Options>> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<PartialDeep<K, Options>, PartialDeep<V, Options>> : T extends WeakMap<infer K, infer V> ? WeakMap<PartialDeep<K, Options>, PartialDeep<V, Options>> : T extends Set<infer V> ? Set<PartialDeep<V, Options>> : T extends ReadonlySet<infer V> ? ReadonlySet<PartialDeep<V, Options>> : T extends WeakSet<infer V> ? WeakSet<PartialDeep<V, Options>> : T extends Promise<infer V> ? Promise<PartialDeep<V, Options>> : T extends (...args: any[]) => unknown ? T | undefined : T extends object ? T extends ReadonlyArray<infer V> ? Options['arrays'] extends true ? V[] extends T ? readonly V[] extends T ? ReadonlyArray<PartialDeep<V, Options>> : Array<PartialDeep<V, Options>> : PartialObjectDeep<T, Options> : T | undefined : PartialObjectDeep<T, Options> : unknown;
-type PartialObjectDeep<T extends object, Options extends OptionsDeep = {
+type PartialObjectDeep<T extends object, Options extends PartialOptions = {
     arrays: true;
 }> = {
     [K in keyof T]?: PartialDeep<T[K], Options>;
 };
 
+type RequiredOptions = {
+    /**
+     * Enables recursive mode for arrays and tuples.
+     *
+     * @default true
+     */
+    readonly arrays?: boolean;
+};
 /**
  * Constructs a type by recursively setting all properties as required.
  *
  * Use `Required<T>` for one level.
  */
-type RequiredDeep<T, Options extends OptionsDeep = {
+type RequiredDeep<T, Options extends RequiredOptions = {
     arrays: true;
 }> = T extends BuiltIn ? Exclude<T, undefined> : T extends Map<infer K, infer V> ? Map<RequiredDeep<K, Options>, RequiredDeep<V, Options>> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<RequiredDeep<K, Options>, RequiredDeep<V, Options>> : T extends WeakMap<infer K, infer V> ? WeakMap<RequiredDeep<K, Options>, RequiredDeep<V, Options>> : T extends Set<infer V> ? Set<RequiredDeep<V, Options>> : T extends ReadonlySet<infer V> ? ReadonlySet<RequiredDeep<V, Options>> : T extends WeakSet<infer V> ? WeakSet<RequiredDeep<V, Options>> : T extends Promise<infer V> ? Promise<RequiredDeep<V, Options>> : T extends (...args: any[]) => unknown ? Exclude<T, undefined> : T extends object ? T extends ReadonlyArray<infer V> ? Options['arrays'] extends true ? V[] extends T ? readonly V[] extends T ? ReadonlyArray<RequiredDeep<Exclude<V, undefined>, Options>> : Array<RequiredDeep<Exclude<V, undefined>, Options>> : RequiredObjectDeep<T, Options> : Exclude<T, undefined> : RequiredObjectDeep<T, Options> : unknown;
-type RequiredObjectDeep<T extends object, Options extends OptionsDeep = {
+type RequiredObjectDeep<T extends object, Options extends RequiredOptions = {
     arrays: true;
 }> = {
     [K in keyof T]-?: RequiredDeep<T[K], Options>;
 };
 
-export { BuiltIn, FormatBytesOptions, IsAny, IsNever, IsNull, OptionsDeep, PartialDeep, Primitive, RequiredDeep, formatBytes, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };
+export { type BuiltIn, type IsAny, type IsNever, type IsNull, type PartialDeep, type Primitive, type RequiredDeep, isArray, isArrayEmpty, isBigint, isBoolean, isBrowser, isDate, isElement, isError, isFunction, isHtmlCollection, isHtmlCollectionEmpty, isInfinity, isMap, isNaNValue, isNodeList, isNodeListEmpty, isNull, isNumber, isObject, isObjectEmpty, isPrimitive, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop, toString };

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

@@ -0,0 +1,6 @@
+/**
+ * Checks if the file exists.
+ */
+declare function exists(path: string): Promise<boolean>;
+
+export { exists };

package/package.json

@@ -1,34 +1,25 @@
 {
   "name": "@hypernym/utils",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "author": "Hypernym Studio",
-  "maintainers": [
-    "Ivo Dolenc (https://github.com/ivodolenc)"
-  ],
   "description": "A collection of reusable utilities.",
   "license": "MIT",
-  "funding": "https://github.com/sponsors/ivodolenc",
   "repository": "hypernym-studio/utils",
   "homepage": "https://github.com/hypernym-studio/utils",
+  "funding": "https://github.com/sponsors/ivodolenc",
   "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.mjs"
     },
     "./node": {
-      "types": "./dist/node/index.d.ts",
-      "import": "./dist/node/index.mjs",
-      "require": "./dist/node/index.cjs"
+      "types": "./dist/types/node/index.d.ts",
+      "import": "./dist/node/index.mjs"
     }
   },
   "files": [
-    "dist",
-    "*.d.ts"
+    "dist"
   ],
   "keywords": [
     "typescript",
@@ -42,32 +33,26 @@
   "scripts": {
     "dev": "vite playgrounds/client",
     "dev:node": "vite-node -w playgrounds/node/main.ts",
-    "build": "rollup -c ./.config/rollup.config.js",
+    "build": "rolli",
+    "bump": "bummp",
     "test:types": "vitest -c ./.config/vitest.config.ts typecheck",
-    "prepublishOnly": "npm run build",
-    "format": "prettier --write .",
-    "lint": "eslint .",
-    "fix": "eslint --fix ."
+    "lint": "ESLINT_USE_FLAT_CONFIG=true eslint -c .config/eslint.config.js .",
+    "lint:fix": "ESLINT_USE_FLAT_CONFIG=true eslint -c .config/eslint.config.js --fix .",
+    "format": "prettier --config .config/prettier.config.js --write .",
+    "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@hypernym/eslint-config": "^1.0.1",
-    "@hypernym/prettier-config": "^1.0.1",
-    "@types/node": "^20.4.1",
-    "eslint": "^8.44.0",
-    "prettier": "^2.8.8",
-    "rollup": "^3.26.2",
-    "rollup-plugin-dts": "^5.3.0",
-    "rollup-plugin-esbuild": "^5.0.0",
-    "typescript": "^5.0.4",
-    "vite": "^4.4.3",
-    "vite-node": "^0.33.0",
-    "vitest": "^0.33.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "eslintConfig": {
-    "extends": "./.config/eslint.config.cjs"
-  },
-  "prettier": "@hypernym/prettier-config"
+    "@hypernym/eslint-config": "^2.0.0",
+    "@hypernym/prettier-config": "^2.0.0",
+    "@hypernym/tsconfig": "^1.0.1",
+    "@types/node": "^20.6.2",
+    "bummp": "^0.2.0",
+    "eslint": "^8.49.0",
+    "prettier": "^3.0.3",
+    "rolli": "^0.6.1",
+    "typescript": "^5.1.6",
+    "vite": "^4.4.9",
+    "vite-node": "^0.34.4",
+    "vitest": "^0.34.4"
+  }
 }

package/dist/index.cjs

@@ -1,77 +0,0 @@
-'use strict';
-
-const noop = () => {
-};
-const toString = (v) => Object.prototype.toString.call(v).slice(8, -1);
-
-const isBrowser = typeof window !== "undefined";
-const isNull = (v) => v === null;
-const isUndefined = (v) => typeof v === "undefined";
-const isString = (v) => typeof v === "string";
-const isStringEmpty = (v) => isString(v) && v.trim().length === 0;
-const isBoolean = (v) => typeof v === "boolean";
-const isNumber = (v) => typeof v === "number" && !isNaN(v);
-const isArray = (v) => Array.isArray(v);
-const isArrayEmpty = (v) => isArray(v) && v.length === 0;
-const isObject = (v) => toString(v) === "Object";
-const isObjectEmpty = (v) => isObject(v) && Object.keys(v).length === 0;
-const isFunction = (v) => v instanceof Function;
-const isNaNValue = (v) => typeof v === "number" && isNaN(v);
-const isRegExp = (v) => v instanceof RegExp;
-const isMap = (v) => v instanceof Map;
-const isSet = (v) => v instanceof Set;
-const isSymbol = (v) => toString(v) === "Symbol";
-const isDate = (v) => v instanceof Date && !isNaN(v.valueOf());
-const isBigint = (v) => typeof v === "bigint";
-const isInfinity = (v) => v === Infinity || v === -Infinity;
-const isURL = (v) => v instanceof URL;
-const isError = (v) => v instanceof Error;
-const isPrimitive = (v) => isString(v) || isNumber(v) || isBigint(v) || isBoolean(v) || isSymbol(v) || isNull(v) || isUndefined(v);
-const isElement = (v) => v instanceof Element;
-const isNodeList = (v) => v instanceof NodeList;
-const isNodeListEmpty = (v) => isNodeList(v) && v.length === 0;
-const isHtmlCollection = (v) => v instanceof HTMLCollection;
-const isHtmlCollectionEmpty = (v) => isHtmlCollection(v) && v.length === 0;
-
-function formatBytes(bytes, options) {
-  const decimals = options?.decimals || 2;
-  const units = ["B", "KB", "MB", "GB", "TB"];
-  if (bytes === 0)
-    return `0 B`;
-  const k = 1024;
-  const dm = decimals < 0 ? 0 : decimals;
-  const i = Math.floor(Math.log(bytes) / Math.log(k));
-  return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${units[i]}`;
-}
-
-exports.formatBytes = formatBytes;
-exports.isArray = isArray;
-exports.isArrayEmpty = isArrayEmpty;
-exports.isBigint = isBigint;
-exports.isBoolean = isBoolean;
-exports.isBrowser = isBrowser;
-exports.isDate = isDate;
-exports.isElement = isElement;
-exports.isError = isError;
-exports.isFunction = isFunction;
-exports.isHtmlCollection = isHtmlCollection;
-exports.isHtmlCollectionEmpty = isHtmlCollectionEmpty;
-exports.isInfinity = isInfinity;
-exports.isMap = isMap;
-exports.isNaNValue = isNaNValue;
-exports.isNodeList = isNodeList;
-exports.isNodeListEmpty = isNodeListEmpty;
-exports.isNull = isNull;
-exports.isNumber = isNumber;
-exports.isObject = isObject;
-exports.isObjectEmpty = isObjectEmpty;
-exports.isPrimitive = isPrimitive;
-exports.isRegExp = isRegExp;
-exports.isSet = isSet;
-exports.isString = isString;
-exports.isStringEmpty = isStringEmpty;
-exports.isSymbol = isSymbol;
-exports.isURL = isURL;
-exports.isUndefined = isUndefined;
-exports.noop = noop;
-exports.toString = toString;

package/dist/node/index.cjs

@@ -1,81 +0,0 @@
-'use strict';
-
-var promises = require('node:fs/promises');
-var node_path = require('node:path');
-
-async function exists(path) {
-  return await promises.access(path, promises.constants.F_OK).then(() => true).catch(() => false);
-}
-
-async function getDirStats(path, options) {
-  const dirPath = node_path.resolve(path);
-  const dirFiles = await promises.readdir(dirPath);
-  const dirBase = node_path.basename(dirPath);
-  let dirStats = [];
-  const subdirList = [];
-  const fileList = [];
-  let dirSize = 0;
-  let dirIndex = 0;
-  let fileIndex = -1;
-  let subdirIndex = -1;
-  for (const file of dirFiles) {
-    const filePath = node_path.resolve(path, file);
-    const fileStat = await promises.stat(filePath);
-    if (fileStat.isDirectory()) {
-      subdirIndex++;
-      subdirList.push({
-        index: subdirIndex,
-        path: filePath,
-        base: file
-      });
-      if (options?.recursive) {
-        const stats = await getDirStats(filePath);
-        const updateDirStats = { ...stats[0], ...{ index: dirIndex++ } };
-        dirStats = [...dirStats, updateDirStats];
-      }
-    } else {
-      const { base, name, ext } = node_path.parse(file);
-      const { size } = fileStat;
-      fileIndex++;
-      dirSize += size;
-      fileList.push({
-        index: fileIndex,
-        path: filePath,
-        base,
-        name,
-        ext,
-        size
-      });
-    }
-  }
-  dirStats.push({
-    index: dirIndex,
-    path: dirPath,
-    base: dirBase,
-    size: dirSize,
-    subdirs: subdirList,
-    files: fileList
-  });
-  return dirStats;
-}
-
-async function getDirFiles(path, options) {
-  const dirPath = node_path.resolve(path);
-  const dirFiles = await promises.readdir(dirPath, { withFileTypes: true });
-  let fileList = [];
-  for (const file of dirFiles) {
-    const filePath = node_path.resolve(path, file.name);
-    if (file.isDirectory()) {
-      if (options?.recursive) {
-        fileList = [...fileList, ...await getDirFiles(filePath)];
-      }
-    } else {
-      fileList.push(filePath);
-    }
-  }
-  return fileList;
-}
-
-exports.exists = exists;
-exports.getDirFiles = getDirFiles;
-exports.getDirStats = getDirStats;

package/dist/node/index.d.ts

@@ -1,49 +0,0 @@
-/**
- * Checks if the file exists.
- */
-declare function exists(path: string): Promise<boolean>;
-
-/**
- * Scans the specified directory and gets details for each subdirectory and file.
- *
- * By default, recursive mode is disabled so only one level is scanned.
- */
-declare function getDirStats(path: string, options?: DirStatsOptions): Promise<DirStats[]>;
-
-interface SubdirDetails {
-    index: number;
-    path: string;
-    base: string;
-}
-interface FileDetails {
-    index: number;
-    path: string;
-    base: string;
-    name: string;
-    ext: string;
-    size: number;
-}
-interface DirStats {
-    index: number;
-    path: string;
-    base: string;
-    size: number;
-    subdirs: SubdirDetails[];
-    files: FileDetails[];
-}
-interface DirStatsOptions {
-    recursive?: boolean;
-}
-
-/**
- * Scans the specified directory and returns a list of all files.
- *
- * By default, recursive mode is disabled so only one level is scanned.
- */
-declare function getDirFiles(path: string, options?: DirFilesOptions): Promise<string[]>;
-
-interface DirFilesOptions {
-    recursive?: boolean;
-}
-
-export { DirFilesOptions, DirStats, DirStatsOptions, exists, getDirFiles, getDirStats };

package/node.d.ts

@@ -1 +0,0 @@
-export * from './dist/node'