@js-utils-kit/valid 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sriman
+
+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/dist/index.cjs

@@ -0,0 +1 @@
+let e=require(`@js-utils-kit/types`);function t(e){return/[\p{P}]$/u.test(e)}function n(e){return/\s/.test(e)}function r(e){return/^[a-zA-Z]+$/.test(e)}function i(e){return e!=null}function a(e){return i(e)&&Array.isArray(e)}function o(){return typeof window<`u`&&window.document!==void 0}function s(e){return/^[a-z][a-zA-Z0-9]*$/.test(e)}function c(){return process.env.NODE_ENV===e.Environment.DEV}function l(e){if(typeof e!=`string`)throw TypeError(`Expected a string`);if(e.length>254)return!1;let t=e.split(`@`);if(t.length!==2)return!1;let[n,r]=t;return n.length===0||n.length>64||r.length===0||r.length>255?!1:!(!/^[a-zA-Z0-9_%+-]+(\.[a-zA-Z0-9_%+-]+)*$/.test(n)||!/^(?!.*\.\.)(?!-)[A-Za-z0-9-]{1,63}(?<!-)(\.[A-Za-z0-9-]{1,63}(?<!-))*\.[A-Za-z]{2,}$/.test(r))}function u(e){return typeof e==`object`&&!!e&&Object.keys(e).length===0&&!a(e)}function d(e){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(e)}function f(e){return/^[a-z]+$/.test(e)}function p(){return typeof process<`u`&&process.versions!==null&&process.versions.node!==null}function m(e){return typeof e==`object`&&!!e&&Object.keys(e).length>0&&!a(e)}function h(e){return e!=null&&typeof e==`string`}function g(e,t=!0){return h(e)?typeof e==`string`&&(t?e.trim().length>0:e.length>0):!1}function _(e){return!isNaN(Number(e))&&!isNaN(parseFloat(e))}function v(e){return i(e)&&typeof e==`object`&&!a(e)&&Object.getPrototypeOf(e)===Object.prototype}function y(e){return/^[A-Z][a-zA-Z0-9]*$/.test(e)}function b(){return process.env.NODE_ENV===e.Environment.PROD}function x(e){return/^[a-z0-9]+(_[a-z0-9]+)*$/.test(e)}function S(){return process.env.NODE_ENV===e.Environment.TEST}function C(e){return e==null}function w(e){return/^[A-Z]+$/.test(e)}function T(e){try{return new URL(e),!0}catch{return!1}}function E(e){return/^[A-Z]/.test(e)}exports.endsWithPunctuation=t,exports.hasWhitespace=n,exports.isAlphabetic=r,exports.isArray=a,exports.isBrowser=o,exports.isCamelCase=s,exports.isDefined=i,exports.isDev=c,exports.isEmail=l,exports.isEmptyObject=u,exports.isKebabCase=d,exports.isLowerCase=f,exports.isNode=p,exports.isNonEmptyObject=m,exports.isNonEmptyString=g,exports.isNumericString=_,exports.isObject=v,exports.isPascalCase=y,exports.isProd=b,exports.isSnakeCase=x,exports.isString=h,exports.isTest=S,exports.isURL=T,exports.isUndefinedOrNull=C,exports.isUpperCase=w,exports.startsWithUppercase=E,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,494 @@
+export * from "@js-utils-kit/types";
+
+//#region src/endsWithPunctuation.d.ts
+
+/**
+ * Checks if a string ends with any Unicode punctuation character.
+ *
+ * @returns True if the string ends with a punctuation character.
+ *
+ * @example
+ * ```ts
+ * endsWithPunctuation("Hi!") // true
+ * endsWithPunctuation("Hello—") // true
+ * endsWithPunctuation("Okay") // false
+ * ```
+ */
+declare function endsWithPunctuation(/** The string to check */
+value: string): boolean;
+//#endregion
+//#region src/hasWhitespace.d.ts
+/**
+ * Checks if a string contains any whitespace.
+ *
+ * @returns True if the string contains whitespace.
+ *
+ * @example
+ * ```ts
+ * hasWhitespace("Hello world") // true
+ * hasWhitespace("Nowordspace") // false
+ * ```
+ */
+declare function hasWhitespace(/** The string to check */
+value: string): boolean;
+//#endregion
+//#region src/isAlphabetic.d.ts
+/**
+ * Checks if a string contains only alphabetic characters (A–Z, a–z).
+ *
+ * @returns - `true` if the string contains only letters; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isAlphabetic("Hello"); // true
+ * isAlphabetic("world123"); // false
+ * isAlphabetic("Test!"); // false
+ * ```
+ */
+declare function isAlphabetic(/** The string to check */
+value: string): boolean;
+//#endregion
+//#region src/isArray.d.ts
+/**
+ * Checks if a value is a defined array.
+ *
+ * @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>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isBrowser.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isCamelCase.d.ts
+/**
+ * Checks if a string is in camelCase format.
+ *
+ * @returns True if the string is camelCase.
+ *
+ * @example
+ * ```ts
+ * isCamelCase("helloWorld") // true
+ * isCamelCase("HelloWorld") // false
+ * ```
+ */
+declare function isCamelCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isDefined.d.ts
+/**
+ * Checks if a value is neither null nor undefined.
+ *
+ * @returns True if the value is defined (not null or undefined), false otherwise.
+ *
+ * @example
+ * ```ts
+ * isDefined(42); // true
+ * isDefined("hello"); // true
+ * isDefined(null); // false
+ * isDefined(undefined); // false
+ * ```
+ */
+declare function isDefined<T>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isDev.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isEmail.d.ts
+/**
+ * Checks whether a given string is a valid email address.
+ *
+ * @remarks
+ * This function uses a practical regular expression to validate email addresses,
+ * allowing most common formats while ignoring edge cases defined by full RFC 5322.
+ * It requires the presence of an `@` symbol and at least one `.` after it.
+ *
+ * **Limits enforced**:
+ * - Local part (before `@`): 1–64 characters
+ * - Domain part (after `@`): 1–255 characters
+ * - Total email length: ≤ 254 characters
+ *
+ *
+ * @throws {TypeError} Throws if value is not a string.
+ *
+ * @returns - `true` if the string is a valid email; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isEmail('user@example.com'); // true
+ * isEmail('first.last@college.university.in'); // true
+ * isEmail('invalid-email'); // false
+ * isEmail('name@domain'); // false
+ * ```
+ */
+declare function isEmail(/** The string to validate as an email address */
+value: string): boolean;
+//#endregion
+//#region src/isEmptyObject.d.ts
+/**
+ * Checks if a value is an empty object (has no enumerable own properties).
+ *
+ * @returns True if the value is a non-null object with no enumerable own properties, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isEmptyObject({}); // true
+ * isEmptyObject({ key: 'value' }); // false
+ * isEmptyObject(null); // false
+ * isEmptyObject([]); // false
+ * ```
+ */
+declare function isEmptyObject(/** The value to check */
+value: object): boolean;
+//#endregion
+//#region src/isKebabCase.d.ts
+/**
+ * Checks if a string is in kebab-case format.
+ *
+ * @returns True if the string is kebab-case.
+ *
+ * @example
+ * ```ts
+ * isKebabCase("hello-world") // true
+ * isKebabCase("hello_world") // false
+ * ```
+ */
+declare function isKebabCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isLowerCase.d.ts
+/**
+ * Checks if a string contains only lowercase letters.
+ *
+ * @returns True if all letters are lowercase.
+ *
+ * @example
+ * ```ts
+ * isLowerCase("hello") // true
+ * isLowerCase("Hello") // false
+ * ```
+ */
+declare function isLowerCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isNode.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isNonEmptyObject.d.ts
+/**
+ * Checks if a value is a non-empty object (has at least one enumerable own property).
+ *
+ * @returns True if the value is a non-null object with at least one enumerable own property, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isNonEmptyObject({ key: 'value' }); // true
+ * isNonEmptyObject({}); // false
+ * isNonEmptyObject(null); // false
+ * isNonEmptyObject([]); // false
+ * ```
+ */
+declare function isNonEmptyObject(/** The value to check */
+value: object): boolean;
+//#endregion
+//#region src/isNonEmptyString.d.ts
+/**
+ * Determines whether the given value is a non-empty string.
+ *
+ * This function first checks if the input is a string using {@link isString}.
+ * If it is not a string, the function returns `false`.
+ * If it is a string, it then checks whether the string contains any non-empty content.
+ *
+ * By default, the function trims the string before checking its length,
+ * which means strings containing only whitespace (e.g., `"   "`) will be considered empty.
+ * This behavior can be controlled using the `trim` parameter.
+ *
+ * @template T - The type of the value being checked.
+ *
+ * @returns - A boolean indicating whether the input is a non-empty string.
+ *
+ * @example
+ * ```ts
+ * isNonEmptyString('hello'); // true
+ * isNonEmptyString('   '); // false (trim is true by default)
+ * isNonEmptyString('   ', false); // true (whitespace is counted)
+ * isNonEmptyString(123); // false
+ * isNonEmptyString(null); // false
+ * ```
+ */
+declare function isNonEmptyString<T>(/** The value to validate as a non-empty string */
+value: T,
+/**
+ * Whether to trim whitespace from the string before checking its length.
+ *
+ * @default true
+ */
+trim?: boolean): boolean;
+//#endregion
+//#region src/isNumericString.d.ts
+/**
+ * Checks whether a given string represents a valid numeric value.
+ *
+ * This function attempts to convert the input string to a number using
+ * both `Number()` and `parseFloat()`. It returns `true` only if both
+ * conversions do not result in `NaN`, ensuring that the input is
+ * a fully numeric string.
+ *
+ * Accepts integers, decimals, scientific notation (e.g. "1e5"), and
+ * ignores surrounding whitespace. Does not allow trailing or embedded characters
+ * like "123abc" or "abc123".
+ *
+ * @returns - `true` if the string represents a valid number; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isNumericString("42"); // true
+ * isNumericString("-3.14"); // true
+ * isNumericString("1e5"); // true
+ * isNumericString("  123 "); // true
+ * isNumericString("123abc"); // false
+ * isNumericString("abc123"); // false
+ * ```
+ * See also:
+ * - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number Number()}
+ * - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/parseFloat parseFloat()}
+ * - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isNaN isNaN()}
+ */
+declare function isNumericString(/** The string to validate */
+value: string): boolean;
+//#endregion
+//#region src/isObject.d.ts
+/**
+ * Checks if a value is a plain object (created by {} or new Object()).
+ *
+ * @returns True if the value is a plain object, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isObject({}); // true
+ * isObject(new Object()); // true
+ * isObject([]); // false
+ * isObject(new Date()); // false
+ * ```
+ */
+declare function isObject<T>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isPascalCase.d.ts
+/**
+ * Checks if a string is in PascalCase format.
+ *
+ * @returns True if the string is PascalCase.
+ *
+ * @example
+ * ```ts
+ * isPascalCase("HelloWorld") // true
+ * isPascalCase("helloWorld") // false
+ * ```
+ */
+declare function isPascalCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isProd.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isSnakeCase.d.ts
+/**
+ * Checks if a string is in snake_case format.
+ *
+ * @returns True if the string is snake_case.
+ *
+ * @example
+ * ```ts
+ * isSnakeCase("hello_world") // true
+ * isSnakeCase("hello-world") // false
+ * ```
+ */
+declare function isSnakeCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isString.d.ts
+/**
+ * Determines whether the provided value is a string.
+ *
+ * This function returns `true` if the input is a non-null, non-undefined
+ * primitive string. It acts as a type guard, so TypeScript will narrow
+ * the type to `string` when used in conditionals.
+ *
+ * @template T - The type of the input value.
+ *
+ * @returns - Whether the value is a string (`true`) or not (`false`).
+ *
+ * @example
+ * ```ts
+ * isString("hello"); // true
+ * isString(123);     // false
+ * isString(null);    // false
+ * isString(undefined); // false
+ *
+ * const value: unknown = "test";
+ * if (isString(value)) {
+ *   console.log(value.toUpperCase());
+ * }
+ * ```
+ */
+declare function isString<T>(/** The value to be checked */
+value: T): boolean;
+//#endregion
+//#region src/isTest.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isUndefinedOrNull.d.ts
+/**
+ * Checks if a value is either null or undefined.
+ *
+ * @returns True if the value is null or undefined, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isUndefinedOrNull(null); // true
+ * isUndefinedOrNull(undefined); // true
+ * isUndefinedOrNull(0); // false
+ * isUndefinedOrNull(""); // false
+ * ```
+ */
+declare function isUndefinedOrNull<T>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isUpperCase.d.ts
+/**
+ * Checks if a string contains only uppercase letters.
+ *
+ * @returns True if all letters are uppercase.
+ *
+ * @example
+ * ```ts
+ * isUpperCase("HELLO") // true
+ * isUpperCase("Hello") // false
+ * ```
+ */
+declare function isUpperCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isURL.d.ts
+/**
+ * Checks whether a given string is a valid absolute URL.
+ *
+ * This function uses the native `URL` constructor to determine if the input is a valid,
+ * absolute URL with a supported protocol (e.g., `http`, `https`, `ftp`, etc.).
+ *
+ * @returns - `true` if the string is a valid absolute URL; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isURL('https://example.com'); // true
+ * isURL('ftp://files.example.com'); // true
+ * isURL('invalid-url'); // false
+ * isURL('/relative/path'); // false
+ * ```
+ */
+declare function isURL(/** The string to validate as a URL */
+value: string): boolean;
+//#endregion
+//#region src/startsWithUppercase.d.ts
+/**
+ * Checks if a string starts with an uppercase letter.
+ *
+ * @returns True if the first character is uppercase, false otherwise.
+ *
+ * @example
+ * ```ts
+ * startsWithUppercase('Hello') // true
+ * startsWithUppercase('world') // false
+ * ```
+ */
+declare function startsWithUppercase(/** The input string to check */
+value: string): boolean;
+//#endregion
+export { endsWithPunctuation, hasWhitespace, isAlphabetic, isArray, isBrowser, isCamelCase, isDefined, isDev, isEmail, isEmptyObject, isKebabCase, isLowerCase, isNode, isNonEmptyObject, isNonEmptyString, isNumericString, isObject, isPascalCase, isProd, isSnakeCase, isString, isTest, isURL, isUndefinedOrNull, isUpperCase, startsWithUppercase };

package/dist/index.d.mts

@@ -0,0 +1,494 @@
+export * from "@js-utils-kit/types";
+
+//#region src/endsWithPunctuation.d.ts
+
+/**
+ * Checks if a string ends with any Unicode punctuation character.
+ *
+ * @returns True if the string ends with a punctuation character.
+ *
+ * @example
+ * ```ts
+ * endsWithPunctuation("Hi!") // true
+ * endsWithPunctuation("Hello—") // true
+ * endsWithPunctuation("Okay") // false
+ * ```
+ */
+declare function endsWithPunctuation(/** The string to check */
+value: string): boolean;
+//#endregion
+//#region src/hasWhitespace.d.ts
+/**
+ * Checks if a string contains any whitespace.
+ *
+ * @returns True if the string contains whitespace.
+ *
+ * @example
+ * ```ts
+ * hasWhitespace("Hello world") // true
+ * hasWhitespace("Nowordspace") // false
+ * ```
+ */
+declare function hasWhitespace(/** The string to check */
+value: string): boolean;
+//#endregion
+//#region src/isAlphabetic.d.ts
+/**
+ * Checks if a string contains only alphabetic characters (A–Z, a–z).
+ *
+ * @returns - `true` if the string contains only letters; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isAlphabetic("Hello"); // true
+ * isAlphabetic("world123"); // false
+ * isAlphabetic("Test!"); // false
+ * ```
+ */
+declare function isAlphabetic(/** The string to check */
+value: string): boolean;
+//#endregion
+//#region src/isArray.d.ts
+/**
+ * Checks if a value is a defined array.
+ *
+ * @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>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isBrowser.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isCamelCase.d.ts
+/**
+ * Checks if a string is in camelCase format.
+ *
+ * @returns True if the string is camelCase.
+ *
+ * @example
+ * ```ts
+ * isCamelCase("helloWorld") // true
+ * isCamelCase("HelloWorld") // false
+ * ```
+ */
+declare function isCamelCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isDefined.d.ts
+/**
+ * Checks if a value is neither null nor undefined.
+ *
+ * @returns True if the value is defined (not null or undefined), false otherwise.
+ *
+ * @example
+ * ```ts
+ * isDefined(42); // true
+ * isDefined("hello"); // true
+ * isDefined(null); // false
+ * isDefined(undefined); // false
+ * ```
+ */
+declare function isDefined<T>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isDev.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isEmail.d.ts
+/**
+ * Checks whether a given string is a valid email address.
+ *
+ * @remarks
+ * This function uses a practical regular expression to validate email addresses,
+ * allowing most common formats while ignoring edge cases defined by full RFC 5322.
+ * It requires the presence of an `@` symbol and at least one `.` after it.
+ *
+ * **Limits enforced**:
+ * - Local part (before `@`): 1–64 characters
+ * - Domain part (after `@`): 1–255 characters
+ * - Total email length: ≤ 254 characters
+ *
+ *
+ * @throws {TypeError} Throws if value is not a string.
+ *
+ * @returns - `true` if the string is a valid email; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isEmail('user@example.com'); // true
+ * isEmail('first.last@college.university.in'); // true
+ * isEmail('invalid-email'); // false
+ * isEmail('name@domain'); // false
+ * ```
+ */
+declare function isEmail(/** The string to validate as an email address */
+value: string): boolean;
+//#endregion
+//#region src/isEmptyObject.d.ts
+/**
+ * Checks if a value is an empty object (has no enumerable own properties).
+ *
+ * @returns True if the value is a non-null object with no enumerable own properties, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isEmptyObject({}); // true
+ * isEmptyObject({ key: 'value' }); // false
+ * isEmptyObject(null); // false
+ * isEmptyObject([]); // false
+ * ```
+ */
+declare function isEmptyObject(/** The value to check */
+value: object): boolean;
+//#endregion
+//#region src/isKebabCase.d.ts
+/**
+ * Checks if a string is in kebab-case format.
+ *
+ * @returns True if the string is kebab-case.
+ *
+ * @example
+ * ```ts
+ * isKebabCase("hello-world") // true
+ * isKebabCase("hello_world") // false
+ * ```
+ */
+declare function isKebabCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isLowerCase.d.ts
+/**
+ * Checks if a string contains only lowercase letters.
+ *
+ * @returns True if all letters are lowercase.
+ *
+ * @example
+ * ```ts
+ * isLowerCase("hello") // true
+ * isLowerCase("Hello") // false
+ * ```
+ */
+declare function isLowerCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isNode.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isNonEmptyObject.d.ts
+/**
+ * Checks if a value is a non-empty object (has at least one enumerable own property).
+ *
+ * @returns True if the value is a non-null object with at least one enumerable own property, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isNonEmptyObject({ key: 'value' }); // true
+ * isNonEmptyObject({}); // false
+ * isNonEmptyObject(null); // false
+ * isNonEmptyObject([]); // false
+ * ```
+ */
+declare function isNonEmptyObject(/** The value to check */
+value: object): boolean;
+//#endregion
+//#region src/isNonEmptyString.d.ts
+/**
+ * Determines whether the given value is a non-empty string.
+ *
+ * This function first checks if the input is a string using {@link isString}.
+ * If it is not a string, the function returns `false`.
+ * If it is a string, it then checks whether the string contains any non-empty content.
+ *
+ * By default, the function trims the string before checking its length,
+ * which means strings containing only whitespace (e.g., `"   "`) will be considered empty.
+ * This behavior can be controlled using the `trim` parameter.
+ *
+ * @template T - The type of the value being checked.
+ *
+ * @returns - A boolean indicating whether the input is a non-empty string.
+ *
+ * @example
+ * ```ts
+ * isNonEmptyString('hello'); // true
+ * isNonEmptyString('   '); // false (trim is true by default)
+ * isNonEmptyString('   ', false); // true (whitespace is counted)
+ * isNonEmptyString(123); // false
+ * isNonEmptyString(null); // false
+ * ```
+ */
+declare function isNonEmptyString<T>(/** The value to validate as a non-empty string */
+value: T,
+/**
+ * Whether to trim whitespace from the string before checking its length.
+ *
+ * @default true
+ */
+trim?: boolean): boolean;
+//#endregion
+//#region src/isNumericString.d.ts
+/**
+ * Checks whether a given string represents a valid numeric value.
+ *
+ * This function attempts to convert the input string to a number using
+ * both `Number()` and `parseFloat()`. It returns `true` only if both
+ * conversions do not result in `NaN`, ensuring that the input is
+ * a fully numeric string.
+ *
+ * Accepts integers, decimals, scientific notation (e.g. "1e5"), and
+ * ignores surrounding whitespace. Does not allow trailing or embedded characters
+ * like "123abc" or "abc123".
+ *
+ * @returns - `true` if the string represents a valid number; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isNumericString("42"); // true
+ * isNumericString("-3.14"); // true
+ * isNumericString("1e5"); // true
+ * isNumericString("  123 "); // true
+ * isNumericString("123abc"); // false
+ * isNumericString("abc123"); // false
+ * ```
+ * See also:
+ * - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number Number()}
+ * - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/parseFloat parseFloat()}
+ * - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isNaN isNaN()}
+ */
+declare function isNumericString(/** The string to validate */
+value: string): boolean;
+//#endregion
+//#region src/isObject.d.ts
+/**
+ * Checks if a value is a plain object (created by {} or new Object()).
+ *
+ * @returns True if the value is a plain object, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isObject({}); // true
+ * isObject(new Object()); // true
+ * isObject([]); // false
+ * isObject(new Date()); // false
+ * ```
+ */
+declare function isObject<T>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isPascalCase.d.ts
+/**
+ * Checks if a string is in PascalCase format.
+ *
+ * @returns True if the string is PascalCase.
+ *
+ * @example
+ * ```ts
+ * isPascalCase("HelloWorld") // true
+ * isPascalCase("helloWorld") // false
+ * ```
+ */
+declare function isPascalCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isProd.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isSnakeCase.d.ts
+/**
+ * Checks if a string is in snake_case format.
+ *
+ * @returns True if the string is snake_case.
+ *
+ * @example
+ * ```ts
+ * isSnakeCase("hello_world") // true
+ * isSnakeCase("hello-world") // false
+ * ```
+ */
+declare function isSnakeCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isString.d.ts
+/**
+ * Determines whether the provided value is a string.
+ *
+ * This function returns `true` if the input is a non-null, non-undefined
+ * primitive string. It acts as a type guard, so TypeScript will narrow
+ * the type to `string` when used in conditionals.
+ *
+ * @template T - The type of the input value.
+ *
+ * @returns - Whether the value is a string (`true`) or not (`false`).
+ *
+ * @example
+ * ```ts
+ * isString("hello"); // true
+ * isString(123);     // false
+ * isString(null);    // false
+ * isString(undefined); // false
+ *
+ * const value: unknown = "test";
+ * if (isString(value)) {
+ *   console.log(value.toUpperCase());
+ * }
+ * ```
+ */
+declare function isString<T>(/** The value to be checked */
+value: T): boolean;
+//#endregion
+//#region src/isTest.d.ts
+/**
+ * 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;
+//#endregion
+//#region src/isUndefinedOrNull.d.ts
+/**
+ * Checks if a value is either null or undefined.
+ *
+ * @returns True if the value is null or undefined, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isUndefinedOrNull(null); // true
+ * isUndefinedOrNull(undefined); // true
+ * isUndefinedOrNull(0); // false
+ * isUndefinedOrNull(""); // false
+ * ```
+ */
+declare function isUndefinedOrNull<T>(/** The value to check */
+value: T): boolean;
+//#endregion
+//#region src/isUpperCase.d.ts
+/**
+ * Checks if a string contains only uppercase letters.
+ *
+ * @returns True if all letters are uppercase.
+ *
+ * @example
+ * ```ts
+ * isUpperCase("HELLO") // true
+ * isUpperCase("Hello") // false
+ * ```
+ */
+declare function isUpperCase(/** The input string */
+value: string): boolean;
+//#endregion
+//#region src/isURL.d.ts
+/**
+ * Checks whether a given string is a valid absolute URL.
+ *
+ * This function uses the native `URL` constructor to determine if the input is a valid,
+ * absolute URL with a supported protocol (e.g., `http`, `https`, `ftp`, etc.).
+ *
+ * @returns - `true` if the string is a valid absolute URL; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * isURL('https://example.com'); // true
+ * isURL('ftp://files.example.com'); // true
+ * isURL('invalid-url'); // false
+ * isURL('/relative/path'); // false
+ * ```
+ */
+declare function isURL(/** The string to validate as a URL */
+value: string): boolean;
+//#endregion
+//#region src/startsWithUppercase.d.ts
+/**
+ * Checks if a string starts with an uppercase letter.
+ *
+ * @returns True if the first character is uppercase, false otherwise.
+ *
+ * @example
+ * ```ts
+ * startsWithUppercase('Hello') // true
+ * startsWithUppercase('world') // false
+ * ```
+ */
+declare function startsWithUppercase(/** The input string to check */
+value: string): boolean;
+//#endregion
+export { endsWithPunctuation, hasWhitespace, isAlphabetic, isArray, isBrowser, isCamelCase, isDefined, isDev, isEmail, isEmptyObject, isKebabCase, isLowerCase, isNode, isNonEmptyObject, isNonEmptyString, isNumericString, isObject, isPascalCase, isProd, isSnakeCase, isString, isTest, isURL, isUndefinedOrNull, isUpperCase, startsWithUppercase };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{Environment as e}from"@js-utils-kit/types";export*from"@js-utils-kit/types";function t(e){return/[\p{P}]$/u.test(e)}function n(e){return/\s/.test(e)}function r(e){return/^[a-zA-Z]+$/.test(e)}function i(e){return e!=null}function a(e){return i(e)&&Array.isArray(e)}function o(){return typeof window<`u`&&window.document!==void 0}function s(e){return/^[a-z][a-zA-Z0-9]*$/.test(e)}function c(){return process.env.NODE_ENV===e.DEV}function l(e){if(typeof e!=`string`)throw TypeError(`Expected a string`);if(e.length>254)return!1;let t=e.split(`@`);if(t.length!==2)return!1;let[n,r]=t;return n.length===0||n.length>64||r.length===0||r.length>255?!1:!(!/^[a-zA-Z0-9_%+-]+(\.[a-zA-Z0-9_%+-]+)*$/.test(n)||!/^(?!.*\.\.)(?!-)[A-Za-z0-9-]{1,63}(?<!-)(\.[A-Za-z0-9-]{1,63}(?<!-))*\.[A-Za-z]{2,}$/.test(r))}function u(e){return typeof e==`object`&&!!e&&Object.keys(e).length===0&&!a(e)}function d(e){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(e)}function f(e){return/^[a-z]+$/.test(e)}function p(){return typeof process<`u`&&process.versions!==null&&process.versions.node!==null}function m(e){return typeof e==`object`&&!!e&&Object.keys(e).length>0&&!a(e)}function h(e){return e!=null&&typeof e==`string`}function g(e,t=!0){return h(e)?typeof e==`string`&&(t?e.trim().length>0:e.length>0):!1}function _(e){return!isNaN(Number(e))&&!isNaN(parseFloat(e))}function v(e){return i(e)&&typeof e==`object`&&!a(e)&&Object.getPrototypeOf(e)===Object.prototype}function y(e){return/^[A-Z][a-zA-Z0-9]*$/.test(e)}function b(){return process.env.NODE_ENV===e.PROD}function x(e){return/^[a-z0-9]+(_[a-z0-9]+)*$/.test(e)}function S(){return process.env.NODE_ENV===e.TEST}function C(e){return e==null}function w(e){return/^[A-Z]+$/.test(e)}function T(e){try{return new URL(e),!0}catch{return!1}}function E(e){return/^[A-Z]/.test(e)}export{t as endsWithPunctuation,n as hasWhitespace,r as isAlphabetic,a as isArray,o as isBrowser,s as isCamelCase,i as isDefined,c as isDev,l as isEmail,u as isEmptyObject,d as isKebabCase,f as isLowerCase,p as isNode,m as isNonEmptyObject,g as isNonEmptyString,_ as isNumericString,v as isObject,y as isPascalCase,b as isProd,x as isSnakeCase,h as isString,S as isTest,T as isURL,C as isUndefinedOrNull,w as isUpperCase,E as startsWithUppercase};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@js-utils-kit/valid",
+  "version": "1.0.0",
+  "description": "Validation utilities",
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teneplaysofficial/js-utils-kit",
+    "directory": "packages/valid"
+  },
+  "bugs": {
+    "url": "https://github.com/teneplaysofficial/js-utils-kit/issues"
+  },
+  "author": {
+    "name": "Sriman",
+    "email": "136729116+TenEplaysOfficial@users.noreply.github.com",
+    "url": "https://tene.vercel.app"
+  },
+  "keywords": [
+    "validation",
+    "predicate",
+    "checks",
+    "utility"
+  ],
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@js-utils-kit/types": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}