@hypernym/utils 0.0.1

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# Utils
+
+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>
+
+## Features
+
+- TypeScript friendly
+- Zero dependencies
+
+## Installation
+
+```sh
+npm i @hypernym/utils
+```
+
+## Imports
+
+```ts
+// ESM & TS
+import { util } from '@hypernym/utils'
+
+// Types
+import type { Util } from '@hypernym/utils'
+```
+
+## API
+
+- [`is`](./src/is.ts) - Simple conditional utilities.
+
+### Types
+
+- [`Primitive`](./src/types/primitive.ts) - Matches any primitive value.
+- [`BuiltIn`](./src/types/built-in.ts) - Matches any `Primitive`, `Date` or `RegExp` value.
+- [`PartialDeep`](./src/types/partial-deep.ts) - Constructs a type by recursively setting all properties as optional.
+- [`RequiredDeep`](./src/types/required-deep.ts) - Constructs a type by recursively setting all properties as required.
+- [`IsNull`](./src/types/is.ts) - Returns a boolean if the given type is a `null`.
+- [`IsAny`](./src/types/is.ts) - Returns a boolean if the given type is a `any`.
+- [`IsNever`](./src/types/is.ts) - Returns a boolean if the given type is a `never`.
+
+## Community
+
+Feel free to use the official [discussions](https://github.com/hypernym-studio/utils/discussions) for any additional questions.
+
+## License
+
+Developed in 🇭🇷 Croatia
+
+Released under the [MIT](LICENSE.txt) license.
+
+© Hypernym Studio

package/dist/utils.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Matches any primitive value.
+ */
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+
+/**
+ * Matches any `Primitive`, `Date` or `RegExp` value.
+ */
+type BuiltIn = Primitive | Date | RegExp;
+
+/**
+ * Checks if the code is running in the browser.
+ */
+declare const isClient: boolean;
+/**
+ * An empty arrow function that performs no operation.
+ */
+declare const noop: () => void;
+/**
+ * Returns a boolean if the given value is a `null`.
+ */
+declare const isNull: (v: any) => v is null;
+/**
+ * Returns a boolean if the given value is a `undefined`.
+ */
+declare const isUndefined: (v: any) => v is undefined;
+/**
+ * Returns a boolean if the given value is a `string`.
+ */
+declare const isString: (v: any) => v is string;
+/**
+ * Returns a boolean if the given value is an empty `string`.
+ */
+declare const isStringEmpty: (v: any) => v is string;
+/**
+ * Returns a boolean if the given value is a `boolean`.
+ */
+declare const isBoolean: (v: any) => v is boolean;
+/**
+ * Returns a boolean if the given value is a `number`.
+ */
+declare const isNumber: (v: any) => v is number;
+/**
+ * Returns a boolean if the given value is a `array`.
+ */
+declare const isArray: (v: any) => v is any[];
+/**
+ * Returns a boolean if the given value is an empty `array`.
+ */
+declare const isArrayEmpty: (v: any) => v is any[];
+/**
+ * Returns a boolean if the given value is a `object`.
+ */
+declare const isObject: (v: any) => v is object;
+/**
+ * Returns a boolean if the given value is an empty `object`.
+ */
+declare const isObjectEmpty: (v: any) => v is object;
+/**
+ * Returns a boolean if the given value is a `Function`.
+ */
+declare const isFunction: (v: any) => v is (...args: any[]) => unknown;
+/**
+ * Returns a boolean if the given value is a `NaN`.
+ */
+declare const isNaNValue: (v: any) => v is number;
+/**
+ * Returns a boolean if the given value is a `RegExp`.
+ */
+declare const isRegExp: (v: any) => v is RegExp;
+/**
+ * Returns a boolean if the given value is a `map`.
+ */
+declare const isMap: (v: any) => v is Map<any, any>;
+/**
+ * Returns a boolean if the given value is a `set`.
+ */
+declare const isSet: (v: any) => v is Set<any>;
+/**
+ * Returns a boolean if the given value is a `symbol`.
+ */
+declare const isSymbol: (v: any) => v is symbol;
+/**
+ * Returns a boolean if the given value is a `Date`.
+ */
+declare const isDate: (v: any) => v is Date;
+/**
+ * Returns a boolean if the given value is a `bigint`.
+ */
+declare const isBigint: (v: any) => v is bigint;
+/**
+ * Returns a boolean if the given value is a `Infinity`.
+ */
+declare const isInfinity: (v: any) => v is number;
+/**
+ * Returns a boolean if the given value is a `URL`.
+ */
+declare const isURL: (v: any) => v is URL;
+/**
+ * Returns a boolean if the given value is a `Error`.
+ */
+declare const isError: (v: any) => v is Error;
+
+/**
+ * Returns a boolean if the given type is a `null`.
+ */
+type IsNull<T> = [T] extends [null] ? true : false;
+/**
+ * Returns a boolean if the given type is a `any`.
+ */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+/**
+ * Returns a boolean if the given type is a `never`.
+ */
+type IsNever<T> = [T] extends [never] ? true : false;
+
+type OptionsDeep = {
+    /**
+     * Enables recursive mode for arrays and tuples.
+     *
+     * @default true
+     */
+    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 = {
+    arrays: true;
+}> = T extends BuiltIn ? T : 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 | undefined, Options>> : Array<PartialDeep<V | undefined, Options>> : PartialObjectDeep<T, Options> : T : PartialObjectDeep<T, Options> : unknown;
+type PartialObjectDeep<T extends object, Options extends OptionsDeep = {
+    arrays: true;
+}> = {
+    [K in keyof T]?: PartialDeep<T[K], Options>;
+};
+
+/**
+ * Constructs a type by recursively setting all properties as required.
+ *
+ * Use `Required<T>` for one level.
+ */
+type RequiredDeep<T, Options extends OptionsDeep = {
+    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 = {
+    arrays: true;
+}> = {
+    [K in keyof T]-?: RequiredDeep<T[K], Options>;
+};
+
+export { BuiltIn, IsAny, IsNever, IsNull, PartialDeep, Primitive, RequiredDeep, isArray, isArrayEmpty, isBigint, isBoolean, isClient, isDate, isError, isFunction, isInfinity, isMap, isNaNValue, isNull, isNumber, isObject, isObjectEmpty, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop };

package/dist/utils.mjs

@@ -0,0 +1,27 @@
+const getType = (v) => Object.prototype.toString.call(v).slice(8, -1);
+const isClient = typeof window !== "undefined";
+const noop = () => {
+};
+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) => getType(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) => getType(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;
+
+export { isArray, isArrayEmpty, isBigint, isBoolean, isClient, isDate, isError, isFunction, isInfinity, isMap, isNaNValue, isNull, isNumber, isObject, isObjectEmpty, isRegExp, isSet, isString, isStringEmpty, isSymbol, isURL, isUndefined, noop };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@hypernym/utils",
+  "version": "0.0.1",
+  "author": "Hypernym Studio",
+  "description": "A collection of reusable utilities.",
+  "license": "MIT",
+  "repository": "hypernym-studio/utils",
+  "homepage": "https://github.com/hypernym-studio/utils",
+  "type": "module",
+  "module": "./dist/utils.mjs",
+  "types": "./dist/utils.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/utils.d.ts",
+      "import": "./dist/utils.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "typescript",
+    "collection",
+    "utilities",
+    "helpers",
+    "utils",
+    "types",
+    "kit"
+  ],
+  "scripts": {
+    "dev": "vite playgrounds/client",
+    "dev:node": "vite-node -w playgrounds/node/main.ts",
+    "build": "rollup -c",
+    "prepublishOnly": "npm run build",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "fix": "eslint --fix ."
+  },
+  "devDependencies": {
+    "@types/node": "^20.2.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
+    "prettier": "^2.8.8",
+    "rollup": "^3.23.0",
+    "rollup-plugin-dts": "^5.3.0",
+    "rollup-plugin-esbuild": "^5.0.0",
+    "typescript": "^5.0.4",
+    "vite": "^4.3.5",
+    "vite-node": "^0.31.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "eslintConfig": {
+    "extends": "./.config/eslint.config.cjs"
+  },
+  "prettier": "./.config/prettier.config.cjs"
+}