js-utils-kit 0.5.5 → 1.1.0

package/README.md

@@ -1,44 +1,9 @@
-<div align="center">
+# js-utils-kit
 
-<!-- [![img](https://capsule-render.vercel.app/api?type=waving&height=300&color=gradient&text=Js%20Utils%20Kit&section=footer&desc=Modular%20JavaScript%20utilities%20with%20type%20support%20for%20strings,%20objects,%20arrays,%20and%20more&descAlign=49&descAlignY=72&animation=fadeIn&textBg=false)](https://github.com/TenEplaysOfficial/js-utils-kit) -->
+> _Modular JavaScript utilities with type support_
 
-# Js Utils Kit
-
-_Modular JavaScript utilities with type support for strings, objects, arrays and more_
-
-[![Build](https://github.com/teneplaysofficial/js-utils-kit/actions/workflows/publish.yml/badge.svg)](https://github.com/TenEplaysOfficial/js-utils-kit)
-[![Test](https://github.com/teneplaysofficial/js-utils-kit/actions/workflows/test.yml/badge.svg)](https://github.com/TenEplaysOfficial/js-utils-kit)
-[![codecov](https://codecov.io/github/teneplaysofficial/js-utils-kit/graph/badge.svg?token=9CEFGKSU2S)](https://github.com/TenEplaysOfficial/js-utils-kit)
-[![npm version](https://img.shields.io/npm/v/js-utils-kit.svg?logo=npm)](https://www.npmjs.com/package/js-utils-kit)
-[![JSR](https://jsr.io/badges/@tene/js-utils-kit)](https://jsr.io/@tene/js-utils-kit)
-[![JSR Score](https://jsr.io/badges/@tene/js-utils-kit/score)](https://jsr.io/@tene/js-utils-kit)
-[![License](https://img.shields.io/github/license/TenEplaysOfficial/js-utils-kit.svg?logo=open-source-initiative)](https://github.com/TenEplaysOfficial/js-utils-kit/blob/main/LICENSE)
-[![GitHub stars](https://img.shields.io/github/stars/TenEplaysOfficial/js-utils-kit?style=flat&logo=github)](https://github.com/TenEplaysOfficial/js-utils-kit/stargazers)
-[![Issues](https://img.shields.io/github/issues/TenEplaysOfficial/js-utils-kit?logo=github)](https://github.com/TenEplaysOfficial/js-utils-kit/issues)
-[![PRs](https://img.shields.io/github/issues-pr/TenEplaysOfficial/js-utils-kit?logo=github)](https://github.com/TenEplaysOfficial/js-utils-kit/pulls)
-[![Last Commit](https://img.shields.io/github/last-commit/TenEplaysOfficial/js-utils-kit?logo=git)](https://github.com/TenEplaysOfficial/js-utils-kit/commits)
+[![npm version](https://img.shields.io/npm/v/js-utils-kit.svg?logo=npm&color=brightgreen)](https://www.npmjs.com/package/js-utils-kit)
 [![Downloads](https://img.shields.io/npm/dt/js-utils-kit?logo=npm)](https://www.npmjs.com/package/js-utils-kit)
-[![Type Support](https://img.shields.io/badge/type-support-blue?logo=typescript)](https://github.com/TenEplaysOfficial/js-utils-kit)
-[![Sponsor](https://img.shields.io/badge/funding-sponsor-yellow?logo=githubsponsors)](https://github.com/sponsors/TenEplaysOfficial)
-[![Follow @teneplays on X](https://img.shields.io/badge/follow-@teneplays-fff?logo=x)](https://x.com/teneplays)
-
-</div>
-
-## Overview
-
-**JS Utils Kit** is a compact and reliable library of essential JavaScript utility functions. It includes helpers for arrays, objects, numbers, promises, type checking, and more. Designed for performance and modularity, it integrates easily into JavaScript and TypeScript projects with minimal impact on bundle size.
-
-> Streamline your code with battle-tested, tree-shakable utilities.
-
-This package includes utilities designed for both browser and Node.js environments, clearly organized and optimized for cross-platform compatibility.
-
-## Features
-
-- Organized by category (e.g., `number`, `string`, `file`, etc.)
-- Fully typed in TypeScript
-- Thoroughly tested with Jest
-- Tree‑shakeable and supports both ESM and CJS
-- CLI-ready tools for file and system operations
 
 ## Installation
 
@@ -54,138 +19,32 @@ pnpm add js-utils-kit
 
 # via bun
 bun add js-utils-kit
-
-# via Deno (using npm)
-deno add npm:js-utils-kit
-
-# via Deno (using JSR)
-deno add jsr:@tene/js-utils-kit
-
-# via JSR
-npx jsr add @tene/js-utils-kit
 ```
 
 ## Usage
 
-`js-utils-kit` offers a modular structure for utilities across different categories like `number`, `string`, `array`, `object`, `env`, and more. You can use full or scoped imports depending on your preference and project setup.
-
-### Recommended Import
-
-Import only what you need by utility category:
-
 ```ts
-import number from 'js-utils-kit/number';
-import string from 'js-utils-kit/string';
-import array from 'js-utils-kit/array';
-import object from 'js-utils-kit/object';
-import env from 'js-utils-kit/env';
+import { capitalize, clamp, isBrowser, isEmpty, unique } from 'js-utils-kit';
 
-console.log(number.clamp(150, 0, 100)); // 100
-console.log(string.capitalize('hello world')); // 'Hello World'
-console.log(array.unique([1, 2, 2, 3])); // [1, 2, 3]
-console.log(object.isEmpty({})); // true
-console.log(env.isBrowser()); // true/false
+console.log(clamp(150, 0, 100)); // 100
+console.log(capitalize('hello world')); // 'Hello World'
+console.log(unique([1, 2, 2, 3])); // [1, 2, 3]
+console.log(isEmpty({})); // true
+console.log(isBrowser()); // true/false
 ```
 
-### Full Import (All utils in one namespace)
+or
 
 ```ts
 import * as kit from 'js-utils-kit';
 
-console.log(kit.number.clamp(150, 0, 100)); // 100
-console.log(kit.string.capitalize('hello')); // 'Hello'
-console.log(kit.array.unique([1, 1, 2])); // [1, 2]
-console.log(kit.object.isEmpty({})); // true
-console.log(kit.env.isNode()); // true/false
-```
-
-### Named Imports
-
-```ts
-import { number, string, env } from 'js-utils-kit';
-
-console.log(number.clamp(42, 0, 100)); // 42
-console.log(string.capitalize('js-utils-kit')); // 'Js-utils-kit'
-console.log(env.isDev()); // true/false
-```
-
-### Using JSR or Deno
-
-```ts
-import { number, string, env } from '@tene/js-utils-kit';
-// or
-import { number, string, env } from 'jsr:@tene/js-utils-kit';
-// or
-import number from '@tene/js-utils-kit/number';
-import string from '@tene/js-utils-kit/string';
-import array from '@tene/js-utils-kit/array';
-import object from '@tene/js-utils-kit/object';
-import env from '@tene/js-utils-kit/env';
-```
-
-### CommonJS Usage
-
-```js
-const { number, string, array, object, env } = require('js-utils-kit');
-
-console.log(number.clamp(150, 0, 100)); // 100
-console.log(string.capitalize('hello world')); // 'Hello World'
-console.log(array.unique([1, 2, 2, 3])); // [1, 2, 3]
-console.log(object.isEmpty({})); // true
-console.log(env.isBrowser()); // true/false
+console.log(kit.clamp(150, 0, 100)); // 100
+console.log(kit.capitalize('hello')); // 'Hello'
+console.log(kit.unique([1, 1, 2])); // [1, 2]
+console.log(kit.isEmpty({})); // true
+console.log(kit.isNode()); // true/false
 ```
 
 ## Documentation
 
-Full documentation available at [GitHub Pages](https://js-utils.js.org/modules.html)
-
-## Requirements
-
-- Node.js: Version `18.0.0` or higher
-- Yarn (or npm as an alternative)
-- TypeScript (optional, for TypeScript projects or development)
-- Browsers: Modern browsers for browser-based usage
-
-## Contributing
-
-We welcome contributions whether it's fixing bugs, adding utilities, improving docs, or writing tests. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and join our [GitHub Discussions](https://github.com/TenEplaysOfficial/js-utils-kit/discussions) to share ideas or propose features.
-
-## FAQ
-
-<details>
-<summary>Does it work in browsers?</summary>
-
-Yes, **JS Utils Kit** is compatible with modern browsers and Node.js.
-
-</details>
-
-<details>
-<summary>Do I need TypeScript?</summary>
-
-No, the library works in plain JavaScript, but TypeScript users benefit from full type definitions and editor support.
-
-</details>
-
-<details>
-<summary>How do I report a bug?</summary>
-
-Open an issue on [GitHub](https://github.com/TenEplaysOfficial/js-utils-kit/issues) or join the [Discussions](https://github.com/TenEplaysOfficial/js-utils-kit/discussions) to ask questions or share feedback.
-
-</details>
-
-<details>
-<summary>How can I optimize bundle size?</summary>
-
-Import only what you need:
-
-```ts
-import { clamp } from 'js-utils-kit/number';
-```
-
-This enables tree-shaking for smaller, optimized bundles.
-
-</details>
-
-## License
-
-Released under the [MIT License](LICENSE)
+Full documentation is available at [js-utils.js.org](https://js-utils.js.org/modules.html)

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var e=require("./array/index.cjs"),s=require("./char/index.cjs"),t=require("./env/index.cjs"),r=require("./file/index.cjs"),i=require("./number/index.cjs"),o=require("./object/index.cjs"),p=require("./string/index.cjs"),n=require("./validate-BKQ-HFTd.js");require("fs"),require("path"),require("archiver"),exports.array=e.default,exports.all=s.all,exports.char=s.default,exports.digits=s.digits,exports.lowercase=s.lowercase,exports.uppercase=s.uppercase,Object.defineProperty(exports,"Environment",{enumerable:!0,get:function(){return t.Environment}}),exports.env=t.default,exports.getRunTimeEnvironment=t.getRunTimeEnvironment,exports.isBrowser=t.isBrowser,exports.isDev=t.isDev,exports.isNode=t.isNode,exports.isProd=t.isProd,exports.isTest=t.isTest,exports.createArchive=r.createArchive,exports.file=r.default,exports.clamp=i.clamp,exports.getMilliseconds=i.getMilliseconds,exports.isEven=i.isEven,exports.isOdd=i.isOdd,exports.number=i.default,exports.randomFloat=i.randomFloat,exports.randomInt=i.randomInt,exports.isEmptyObject=o.isEmptyObject,exports.isNonEmptyObject=o.isNonEmptyObject,exports.isObject=o.isObject,exports.mergeObj=o.mergeObj,exports.object=o.default,exports.capitalize=p.capitalize,exports.containsWhitespace=p.containsWhitespace,exports.countChars=p.countChars,exports.countFrequencies=p.countFrequencies,exports.countLines=p.countLines,exports.countSubstring=p.countSubstring,exports.countWords=p.countWords,exports.endsWithPunctuation=p.endsWithPunctuation,exports.isAlphabetic=p.isAlphabetic,exports.isCamelCase=p.isCamelCase,exports.isEmail=p.isEmail,exports.isKebabCase=p.isKebabCase,exports.isLowerCase=p.isLowerCase,exports.isNonEmptyString=p.isNonEmptyString,exports.isNumericString=p.isNumericString,exports.isPascalCase=p.isPascalCase,exports.isSnakeCase=p.isSnakeCase,exports.isString=p.isString,exports.isURL=p.isURL,exports.isUpperCase=p.isUpperCase,exports.longestWord=p.longestWord,exports.longestWordLength=p.longestWordLength,exports.padLeft=p.padLeft,exports.padRight=p.padRight,exports.repeatString=p.repeatString,exports.shortestWord=p.shortestWord,exports.shortestWordLength=p.shortestWordLength,exports.splitString=p.splitString,exports.startsWithUppercase=p.startsWithUppercase,exports.string=p.default,exports.stripSymbols=p.stripSymbols,exports.trim=p.trim,exports.truncate=p.truncate,exports.uniqueChars=p.uniqueChars,exports.isArray=n.isArray,exports.isDefined=n.isDefined,exports.isUndefinedOrNull=n.isUndefinedOrNull;
+var e=require(`@js-utils-kit/core`);Object.keys(e).forEach(function(t){t!==`default`&&!Object.prototype.hasOwnProperty.call(exports,t)&&Object.defineProperty(exports,t,{enumerable:!0,get:function(){return e[t]}})});

package/dist/index.d.cts

@@ -0,0 +1 @@
+export * from "@js-utils-kit/core";

package/dist/index.d.mts

@@ -0,0 +1 @@
+export * from "@js-utils-kit/core";

package/dist/index.mjs

@@ -0,0 +1 @@
+export*from"@js-utils-kit/core";export{};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "js-utils-kit",
   "displayName": "JS Utils Kit",
-  "version": "0.5.5",
+  "version": "1.1.0",
   "description": "Essential JavaScript helpers",
   "license": "MIT",
   "private": false,
@@ -38,134 +38,21 @@
   ],
   "type": "module",
   "files": [
-    "dist/**/*"
+    "dist"
   ],
-  "bin": {
-    "js-utils-kit": "dist/cli/index.js"
-  },
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
       "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    },
-    "./array": {
-      "import": "./dist/array/index.js",
-      "require": "./dist/array/index.cjs",
-      "types": "./dist/array/index.d.ts"
-    },
-    "./char": {
-      "import": "./dist/char/index.js",
-      "require": "./dist/char/index.cjs",
-      "types": "./dist/char/index.d.ts"
-    },
-    "./cli": {
-      "import": "./dist/cli/index.js",
-      "require": "./dist/cli/index.cjs",
-      "types": "./dist/cli/index.d.ts"
-    },
-    "./env": {
-      "import": "./dist/env/index.js",
-      "require": "./dist/env/index.cjs",
-      "types": "./dist/env/index.d.ts"
-    },
-    "./file": {
-      "import": "./dist/file/index.js",
-      "require": "./dist/file/index.cjs",
-      "types": "./dist/file/index.d.ts"
-    },
-    "./number": {
-      "import": "./dist/number/index.js",
-      "require": "./dist/number/index.cjs",
-      "types": "./dist/number/index.d.ts"
-    },
-    "./object": {
-      "import": "./dist/object/index.js",
-      "require": "./dist/object/index.cjs",
-      "types": "./dist/object/index.d.ts"
-    },
-    "./string": {
-      "import": "./dist/string/index.js",
-      "require": "./dist/string/index.cjs",
-      "types": "./dist/string/index.d.ts"
+      "import": "./dist/index.mjs"
     }
   },
-  "lint-staged": {
-    "*.{js,mjs,ts,json,md}": "yarn lint:fix",
-    "*.{js,mjs,ts,json,md,yml}": "yarn format"
+  "dependencies": {
+    "@js-utils-kit/core": "1.2.0"
   },
   "scripts": {
-    "test": "jest",
-    "prebuild": "yarn gen:indexes",
-    "build": "rollup -c",
-    "postbuild": "yarn gen:exports && yarn docs",
-    "release": "release-it",
-    "watch": "rollup -c --watch",
-    "lint": "eslint .",
-    "lint:fix": "npx eslint --fix",
-    "format": "prettier --write",
-    "format:check": "prettier --check .",
-    "prepare": "husky",
-    "prepare:release": "yarn test && yarn prebuild && yarn build && yarn postbuild",
-    "docs": "typedoc",
-    "gen:exports": "node scripts/gen-exports.js",
-    "gen:indexes": "node scripts/gen-indexes.js"
-  },
-  "prettier": {
-    "semi": true,
-    "singleQuote": true,
-    "printWidth": 100,
-    "trailingComma": "all",
-    "tabWidth": 2
-  },
-  "jest": {
-    "preset": "ts-jest/presets/default-esm",
-    "testEnvironment": "node",
-    "extensionsToTreatAsEsm": [
-      ".ts"
-    ],
-    "moduleNameMapper": {
-      "^(\\.{1,2}/.*)\\.js": "$1"
-    }
-  },
-  "devDependencies": {
-    "@eslint/compat": "^1.4.0",
-    "@eslint/js": "^9.29.0",
-    "@eslint/json": "^0.13.0",
-    "@eslint/markdown": "^7.0.0",
-    "@release-it/conventional-changelog": "^10.0.1",
-    "@rollup/plugin-commonjs": "^28.0.6",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.3",
-    "@types/archiver": "^6.0.3",
-    "@types/jest": "^30.0.0",
-    "@types/node": "^24.0.4",
-    "eslint": "^9.29.0",
-    "globals": "^16.2.0",
-    "husky": "^9.1.7",
-    "jest": "^30.0.3",
-    "jest-environment-node": "^30.0.2",
-    "lint-staged": "^16.1.2",
-    "prettier": "^3.6.0",
-    "release-it": "^19.0.3",
-    "rollup": "^4.44.0",
-    "rollup-plugin-delete": "^3.0.1",
-    "rollup-plugin-dts": "^6.2.1",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "ts-jest": "^29.4.0",
-    "tslib": "^2.8.1",
-    "typedoc": "^0.28.5",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.35.0"
-  },
-  "dependencies": {
-    "archiver": "^7.0.1",
-    "commander": "^14.0.0",
-    "ora": "^8.2.0"
+    "build": "tsdown"
   }
-}
+}

package/dist/array/index.cjs

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var r=require("../validate-BKQ-HFTd.js"),e={isArray:r.isArray};exports.isArray=r.isArray,exports.default=e;

package/dist/array/index.d.ts

@@ -1,21 +0,0 @@
-/**
- * Checks if a value is a defined array.
- * @param value - The value to check.
- * @returns True if the value is a defined array, false otherwise.
- * @example
- * ```ts
- * console.log(isArray([1, 2, 3])); // true
- * console.log(isArray([])); // true
- * console.log(isArray({})); // false
- * console.log(isArray(null)); // false
- * console.log(isArray(undefined)); // false
- * console.log(isArray("hello")); // false
- * ```
- */
-declare function isArray<T>(value: T): boolean;
-
-declare const _default: {
-    isArray: typeof isArray;
-};
-
-export { _default as default, isArray };

package/dist/array/index.js

@@ -1 +0,0 @@
-import{i as a}from"../validate-D9J7otjc.js";var r={isArray:a};export{r as default,a as isArray};

package/dist/char/index.cjs

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const r=()=>Array.from({length:26},(r,e)=>String.fromCharCode(97+e)),e=()=>Array.from({length:26},(r,e)=>String.fromCharCode(65+e)),o=()=>Array.from({length:10},(r,e)=>String.fromCharCode(48+e)),t=()=>[...r(),...e(),...o()];var s={lowercase:r,uppercase:e,digits:o,all:t};exports.all=t,exports.default=s,exports.digits=o,exports.lowercase=r,exports.uppercase=e;

package/dist/char/index.d.ts

@@ -1,41 +0,0 @@
-/**
- * Generates an array of lowercase ASCII alphabet characters (a–z).
- *
- * @returns An array containing 'a' to 'z'.
- * @example
- * lowercase(); // ['a', 'b', ..., 'z']
- */
-declare const lowercase: () => string[];
-/**
- * Generates an array of uppercase ASCII alphabet characters (A–Z).
- *
- * @returns An array containing 'A' to 'Z'.
- * @example
- * uppercase(); // ['A', 'B', ..., 'Z']
- */
-declare const uppercase: () => string[];
-/**
- * Generates an array of ASCII digit characters (0–9).
- *
- * @returns An array containing '0' to '9'.
- * @example
- * digits(); // ['0', '1', ..., '9']
- */
-declare const digits: () => string[];
-/**
- * Combines lowercase, uppercase, and digit characters into a single array.
- *
- * @returns An array containing 'a'–'z', 'A'–'Z', and '0'–'9'.
- * @example
- * all(); // ['a', ..., 'z', 'A', ..., 'Z', '0', ..., '9']
- */
-declare const all: () => string[];
-
-declare const _default: {
-    lowercase: () => string[];
-    uppercase: () => string[];
-    digits: () => string[];
-    all: () => string[];
-};
-
-export { all, _default as default, digits, lowercase, uppercase };

package/dist/char/index.js

@@ -1 +0,0 @@
-const r=()=>Array.from({length:26},(r,a)=>String.fromCharCode(97+a)),a=()=>Array.from({length:26},(r,a)=>String.fromCharCode(65+a)),e=()=>Array.from({length:10},(r,a)=>String.fromCharCode(48+a)),o=()=>[...r(),...a(),...e()];var t={lowercase:r,uppercase:a,digits:e,all:o};export{o as all,t as default,e as digits,r as lowercase,a as uppercase};

package/dist/cli/index.js

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-import r from"ora";import{Command as e}from"commander";import o from"fs";import t from"path";import i from"archiver";var n="JS Utils Kit",s="0.5.4",c="Essential JavaScript helpers";const a=new e;a.name(n).description(c).version(s).enablePositionalOptions(),a.command("createArchive").description("Creates a archive from a specified directory").requiredOption("-f, --format <format>","Archive format (zip or tar)").requiredOption("-s, --source <source>","Source directory path").requiredOption("-d, --destination <destination>","Destination archive file").action(async e=>{const n=r("Creating archive...").start();try{await function({format:r,source:e,destination:n,options:s={},log:c=!0,onSuccess:a}){const d=t.resolve(e);if(!o.existsSync(d)||!o.statSync(d).isDirectory())throw new Error(`Source directory "${e}" does not exist or is not a directory.`);const m=o.createWriteStream(n);"zip"===r&&(s={...s,zlib:{level:9}});const p=i(r,s);return new Promise((r,o)=>{m.on("close",()=>{const e=p.pointer();c&&console.log(`${n} created: ${e} total bytes`),a&&a(e),r()}),p.on("error",r=>{o(r)}),p.pipe(m),p.directory(e,!1),p.finalize().catch(r=>o(r instanceof Error?r:new Error(String(r))))})}({format:e.format,source:e.source,destination:e.destination,log:!1,onSuccess:r=>{n.succeed(`Archive created successfully at ${e.destination} (${r} bytes).`)}})}catch(r){n.fail("Failed to create archive: "+(r instanceof Error?r.message:"Unknown error")),process.exit(1)}}),a.parse();

package/dist/env/index.cjs

@@ -1 +0,0 @@
-"use strict";var e;function n(){switch(process.env.NODE_ENV){case exports.Environment.PROD:return exports.Environment.PROD;case exports.Environment.DEV:return exports.Environment.DEV;case exports.Environment.TEST:return exports.Environment.TEST;default:return exports.Environment.UNKNOWN}}function r(){return process.env.NODE_ENV===exports.Environment.PROD}function o(){return process.env.NODE_ENV===exports.Environment.DEV}function t(){return process.env.NODE_ENV===exports.Environment.TEST}function s(){return"undefined"!=typeof process&&null!==process.versions&&null!==process.versions.node}function i(){return"undefined"!=typeof window&&void 0!==window.document}Object.defineProperty(exports,"__esModule",{value:!0}),exports.Environment=void 0,(e=exports.Environment||(exports.Environment={})).PROD="production",e.DEV="development",e.TEST="test",e.UNKNOWN="unknown";var p={getRunTimeEnvironment:n,isProd:r,isDev:o,isTest:t,isNode:s,isBrowser:i};exports.default=p,exports.getRunTimeEnvironment=n,exports.isBrowser=i,exports.isDev=o,exports.isNode=s,exports.isProd=r,exports.isTest=t;

package/dist/env/index.d.ts

@@ -1,128 +0,0 @@
-/**
- * Represents the standard runtime environments used in application development.
- *
- * This enum is typically used with `process.env.NODE_ENV` to determine
- * whether the app is running in development, production, or test mode.
- *
- * @example
- * ```ts
- * if (process.env.NODE_ENV === Environment.DEV) {
- *   console.log('Running in development mode');
- * }
- * ```
- */
-declare enum Environment {
-    /** Production environment (`"production"`) */
-    PROD = "production",
-    /** Development environment (`"development"`) */
-    DEV = "development",
-    /** Testing environment (`"test"`) */
-    TEST = "test",
-    /** Unknown or undefined environment */
-    UNKNOWN = "unknown"
-}
-/**
- * Returns the current runtime environment as one of the defined `Environment` enum values.
- *
- * @returns The current environment.
- *
- * @example
- * ```ts
- * const env = getRunTimeEnvironment();
- * if (env === "development") {
- *   console.log('Dev mode enabled');
- * }
- * ```
- */
-declare function getRunTimeEnvironment(): Environment;
-/**
- * Checks if the current environment is production.
- *
- * This is determined by comparing `process.env.NODE_ENV` with `'production'`.
- *
- * @returns `true` if `NODE_ENV` is set to production.
- *
- * @example
- * ```ts
- * if (isProd()) {
- *   enableAnalytics();
- * }
- * ```
- */
-declare function isProd(): boolean;
-/**
- * Checks if the current environment is development.
- *
- * This is determined by comparing `process.env.NODE_ENV` with `'development'`.
- *
- * @returns `true` if `NODE_ENV` is set to development.
- *
- * @example
- * ```ts
- * if (isDev()) {
- *   console.log('Dev mode enabled');
- * }
- * ```
- */
-declare function isDev(): boolean;
-/**
- * Checks if the current environment is testing.
- *
- * This is determined by comparing `process.env.NODE_ENV` with `'test'`.
- *
- * @returns `true` if `NODE_ENV` is set to test.
- *
- * @example
- * ```ts
- * if (isTest()) {
- *   mockDatabase();
- * }
- * ```
- */
-declare function isTest(): boolean;
-/**
- * Checks if the current runtime environment is Node.js.
- *
- * This function is useful to conditionally execute server-side logic.
- * It detects the Node.js environment by verifying the presence of the
- * global `process` object and its `versions.node` property.
- *
- * @returns `true` if running in Node.js, otherwise `false`.
- *
- * @example
- * ```ts
- * if (isNode()) {
- *   console.log('Running in Node.js environment');
- * }
- * ```
- *
- * @see {@link https://nodejs.org/api/process.html | Node.js process documentation}
- */
-declare function isNode(): boolean;
-/**
- * Checks if the current runtime environment is a browser.
- *
- * This function helps detect whether code is executing in a web browser
- * by confirming the existence of the global `window` and `document` objects.
- *
- * @returns `true` if running in a browser, otherwise `false`.
- *
- * @example
- * ```ts
- * if (isBrowser()) {
- *   console.log('Running in a browser environment');
- * }
- * ```
- */
-declare function isBrowser(): boolean;
-
-declare const _default: {
-    getRunTimeEnvironment: typeof getRunTimeEnvironment;
-    isProd: typeof isProd;
-    isDev: typeof isDev;
-    isTest: typeof isTest;
-    isNode: typeof isNode;
-    isBrowser: typeof isBrowser;
-};
-
-export { Environment, _default as default, getRunTimeEnvironment, isBrowser, isDev, isNode, isProd, isTest };

package/dist/env/index.js

@@ -1 +0,0 @@
-var n;function e(){switch(process.env.NODE_ENV){case n.PROD:return n.PROD;case n.DEV:return n.DEV;case n.TEST:return n.TEST;default:return n.UNKNOWN}}function r(){return process.env.NODE_ENV===n.PROD}function o(){return process.env.NODE_ENV===n.DEV}function s(){return process.env.NODE_ENV===n.TEST}function t(){return"undefined"!=typeof process&&null!==process.versions&&null!==process.versions.node}function u(){return"undefined"!=typeof window&&void 0!==window.document}!function(n){n.PROD="production",n.DEV="development",n.TEST="test",n.UNKNOWN="unknown"}(n||(n={}));var i={getRunTimeEnvironment:e,isProd:r,isDev:o,isTest:s,isNode:t,isBrowser:u};export{n as Environment,i as default,e as getRunTimeEnvironment,u as isBrowser,o as isDev,t as isNode,r as isProd,s as isTest};

package/dist/file/index.cjs

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("fs"),r=require("path"),t=require("archiver");function o({format:o,source:i,destination:c,options:s={},log:n=!0,onSuccess:a}){const l=r.resolve(i);if(!e.existsSync(l)||!e.statSync(l).isDirectory())throw new Error(`Source directory "${i}" does not exist or is not a directory.`);const u=e.createWriteStream(c);"zip"===o&&(s={...s,zlib:{level:9}});const p=t(o,s);return new Promise((e,r)=>{u.on("close",()=>{const r=p.pointer();n&&console.log(`${c} created: ${r} total bytes`),a&&a(r),e()}),p.on("error",e=>{r(e)}),p.pipe(u),p.directory(i,!1),p.finalize().catch(e=>r(e instanceof Error?e:new Error(String(e))))})}var i={createArchive:o};exports.createArchive=o,exports.default=i;