reslib 1.0.0

package/build/utils/string.d.ts

@@ -0,0 +1,165 @@
+/**
+ * Removes all occurrences of the specified string from the left side of the current string.
+ *
+ * This function takes two parameters: the current string and the string to remove.
+ * If the string to remove is not provided, it defaults to an empty string and the function simply trims the current string.
+ *
+ * @param {string} current The string to modify.
+ * @param {string} [str=""] The string to remove from the left side of the current string.
+ * @returns {string} The modified string with all occurrences of the specified string removed from the left side.
+ * @example
+ * ```typescript
+ * console.log(ltrim("   hello world", " ")); // Output: "hello world"
+ * console.log(ltrim("hello world", " ")); // Output: "hello world"
+ * console.log(ltrim("   hello world")); // Output: "hello world"
+ * ```
+ */
+export declare const ltrim: (current: string, str?: string) => string;
+/**
+ * Removes all occurrences of the specified string from the right side of the current string.
+ *
+ * This function takes two parameters: the current string and the string to remove.
+ * If the string to remove is not provided, it defaults to an empty string and the function simply trims the current string.
+ *
+ * @param {string} current The string to modify.
+ * @param {string} [str=""] The string to remove from the right side of the current string.
+ * @returns {string} The modified string with all occurrences of the specified string removed from the right side.
+ * @example
+ * ```typescript
+ * console.log(rtrim("test heee", "e")); // Output: "test h"
+ * console.log(rtrim("hello world", " ")); // Output: "hello world"
+ * console.log(rtrim("   hello world")); // Output: "   hello world"
+ * ```
+ */
+export declare const rtrim: (current: string, str?: string) => string;
+/**
+ * Checks if the provided string consists only of numbers.
+ *
+ * This function takes two parameters: the string to check and an optional flag to indicate whether to consider decimal points.
+ *
+ * @param {string} str The string to check.
+ * @param {boolean} [withDecimal=true] Whether to consider decimal points in the check.
+ * @returns {boolean} True if the string consists only of numbers, false otherwise.
+ * @example
+ * ```typescript
+ * console.log(isStringNumber("123")); // Output: true
+ * console.log(isStringNumber("123.45")); // Output: true
+ * console.log(isStringNumber("123.45", false)); // Output: false
+ * console.log(isStringNumber("abc")); // Output: false
+ * ```
+ */
+export declare const isStringNumber: (str: string, withDecimal?: boolean) => boolean;
+/**
+ * Extends the String interface with additional methods for string manipulation.
+ */
+declare global {
+    interface String {
+        /**
+         * Removes all occurrences of the specified string from the left side of the string.
+         * @param {string} [str=""] The string to remove from the left side.
+         * @returns {string} The modified string with all occurrences of the specified string removed from the left side.
+         */
+        ltrim(str?: string): string;
+        /**
+         * Removes all occurrences of the specified string from the right side of the string.
+         * @param {string} [str=""] The string to remove from the right side.
+         * @returns {string} The modified string with all occurrences of the specified string removed from the right side.
+         */
+        rtrim(str?: string): string;
+        /**
+         * Checks if the string consists only of numbers.
+         * @param {boolean} [withDecimal=true] Whether to consider decimal points in the check.
+         * @returns {boolean} True if the string consists only of numbers, false otherwise.
+         */
+        isNumber(withDecimal?: boolean): boolean;
+        /**
+         * Converts the string to snake case (e.g. "hello world" becomes "hello_world").
+         * @returns {string} The string in snake case.
+         */
+        toSnakeCase(): string;
+        /**
+         * Converts the string to camel case (e.g. "hello world" becomes "helloWorld").
+         * @returns {string} The string in camel case.
+         */
+        toCamelCase(): string;
+        /**
+         * Converts the first character of the string to uppercase.
+         * @returns {string} The string with the first character in uppercase.
+         */
+        upperFirst(): string;
+        /**
+         * Converts the first character of the string to lowercase.
+         * @returns {string} The string with the first character in lowercase.
+         */
+        lowerFirst(): string;
+        /**
+         * Replaces all occurrences of the specified string with another string.
+         * @param {string} find The string to replace.
+         * @param {string} replace The string to replace with.
+         * @returns {string} The string with all occurrences replaced.
+         */
+        replaceAll(find: string, replace: string): string;
+    }
+}
+/**
+ * Converts a string from camel case to snake case (e.g. "addElementComponent" becomes "ADD_ELEMENT_COMPONENT").
+ *
+ * This function takes a string as input, trims it, and then replaces all occurrences of camel case with underscores.
+ * The resulting string is then converted to uppercase.
+ *
+ * @param {string} text The string to convert.
+ * @returns {string} The string in snake case.
+ * @example
+ * ```typescript
+ * console.log(toSnakeCase("thisISDifficult")); // Output: "THIS_IS_DIFFICULT"
+ * console.log(toSnakeCase("thisISNT")); // Output: "THIS_ISNT"
+ * console.log(toSnakeCase("addElementComponent")); // Output: "ADD_ELEMENT_COMPONENT"
+ * ```
+ */
+export declare const toSnakeCase: (text: string) => string;
+/**
+ * Converts a string from snake case to camel case (e.g. "ADD_ELEMENT_COMPONENT" becomes "addElementComponent").
+ *
+ * This function takes a string as input, trims it, and then replaces all occurrences of underscores with uppercase letters.
+ * The resulting string is then converted to camel case by making the first character lowercase.
+ *
+ * @param {string} text The string to convert.
+ * @returns {string} The string in camel case.
+ * @example
+ * ```typescript
+ * console.log(toCamelCase("THIS_IS_DIFFICULT")); // Output: "thisISDifficult"
+ * console.log(toCamelCase("THIS_ISNT")); // Output: "thisISNT"
+ * console.log(toCamelCase("ADD_ELEMENT_COMPONENT")); // Output: "addElementComponent"
+ * ```
+ */
+export declare const toCamelCase: (text: string) => string;
+/**
+ * Converts the first character of a string to uppercase.
+ *
+ * This function takes a string as input, trims it, and then converts the first character to uppercase.
+ *
+ * @param {string} str The string to modify.
+ * @returns {string} The modified string with the first character in uppercase.
+ * @example
+ * ```typescript
+ * console.log(upperFirst("hello world")); // Output: "Hello world"
+ * console.log(upperFirst("HELLO WORLD")); // Output: "HELLO WORLD"
+ * console.log(upperFirst("")); // Output: ""
+ * ```
+ */
+export declare const upperFirst: (str: string) => string;
+/**
+ * Converts the first character of a string to lowercase.
+ *
+ * This function takes a string as input, trims it, and then converts the first character to lowercase.
+ *
+ * @param {string} str The string to modify.
+ * @returns {string} The modified string with the first character in lowercase.
+ * @example
+ * ```typescript
+ * console.log(lowerFirst("Hello World")); // Output: "hello World"
+ * console.log(lowerFirst("HELLO WORLD")); // Output: "hello WORLD"
+ * console.log(lowerFirst("")); // Output: ""
+ * ```
+ */
+export declare const lowerFirst: (str: string) => string;

package/build/utils/string.js

@@ -0,0 +1 @@
+'use strict';function n(t){return !!(t&&typeof t=="string")}var e=function(t,r=""){if(!t||typeof t!="string")return "";if(!r||typeof r!="string")return t.trim();let i=t.length;for(;t.startsWith(r)&&i>=0;)t=t.slice(r.length),--i;return t.toString()},o=function(t,r=""){if(!t||typeof t!="string")return "";if(!r||typeof r!="string")return t.trim();let i=t.length;for(;t.endsWith(r)&&i>=0;)t=t.slice(0,-r.length),--i;return t.toString()},s=(t,r=true)=>typeof t!="string"?false:r!==false?/^\d*\.?\d+$/.test(t):/^\d+$/.test(t);String.prototype.ltrim=function(t){return e(this.toString(),t)};String.prototype.rtrim=function(t){return o(this.toString(),t)};String.prototype.isNumber=function(t=true){return s(this.toString(),t)};String.prototype.replaceAll=function(t,r){return !n(t)||!n(r)?this.toString():this.toString().split(t).join(r)};var g=t=>n(t)?(t=t.trim(),t.replace(/(.)([A-Z][a-z]+)/,"$1_$2").replace(/([a-z0-9])([A-Z])/,"$1_$2").toUpperCase()):"";String.prototype.toSnakeCase=function(){return g(this.toString())};var p=t=>n(t)?(t=t.trim(),t.charAt(0)+t.replace(/(_\w)/g,r=>r[1].toUpperCase()).substring(1)):"";String.prototype.toCamelCase=function(){return p(this.toString())};var l=function(t){return !t||typeof t!="string"?"":(t=t.trim(),t.charAt(0).toUpperCase()+t.slice(1))};String.prototype.upperFirst=function(){return l(this.toString())};var a=function(t){return !t||typeof t!="string"?"":(t=t.trim(),t.charAt(0).toLowerCase()+t.slice(1))};String.prototype.lowerFirst=function(){return a(this.toString())};exports.isStringNumber=s;exports.lowerFirst=a;exports.ltrim=e;exports.rtrim=o;exports.toCamelCase=p;exports.toSnakeCase=g;exports.upperFirst=l;

package/build/utils/stringify.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Converts a variable to a string representation.
+ *
+ * This function takes a variable as input and returns a string representation of it.
+ * It works similarly to the JSON.stringify function, but with additional options.
+ *
+ * @param {any} obj The variable to convert to a string.
+ * @param {{parenthesis: boolean}} [options] Additional options.
+ * @param {boolean} [options.parenthesis=false] Whether to wrap the result in parentheses.
+ * @param {boolean} [options.escapeString=true] Whether to escape quotes and other special characters in the string representation.
+ * @returns {string} The string representation of the variable.
+ * @example
+ * ```typescript
+ * console.log(stringify({ a: 1, b: 2 })); // Output: "{a:1,b:2}"
+ * console.log(stringify({ a: 1, b: 2 }, { parenthesis: true })); // Output: "({a:1,b:2})"
+ * console.log(stringify(null)); // Output: "null"
+ * console.log(stringify(undefined)); // Output: "undefined"
+ * ```
+ */
+export declare function stringify(obj: any, options?: {
+    parenthesis?: boolean;
+    escapeString?: boolean;
+}): string;

package/build/utils/stringify.js

@@ -0,0 +1 @@
+'use strict';function f(r){return !!(r&&typeof r=="string")}function u(...r){for(var e in r){let t=r[e];if(f(t))return t}return ""}function g(r){return typeof r=="number"&&!isNaN(r)&&isFinite(r)}function p(r){return u(r).replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(/\n/g,"\\n").replace(/\r/g,"\\r").replace(/\t/g,"\\t").replace(/\v/g,"\\v").replace(/[\b]/g,"\\b").replace(/\f/g,"\\f")}function i(r,e){var t=Object.prototype.toString.call(r);return t==="[object "+e+"]"}function a(r,e){if(["boolean","undefined"].includes(typeof r)||r===null)return String(r);if(g(r))return r.formatNumber();if(r instanceof Date)return r.toFormat();if(r instanceof Error)return r==null?void 0:r.toString();e=Object.assign({},e);let{parenthesis:t}=e,c=t?"(":"",s=t?")":"";return typeof r=="string"?(e==null?void 0:e.escapeString)!==false?"'"+p(r)+"'":r:i(r,"RegExp")||i(r,"Number")||i(r,"Boolean")?r.toString():i(r,"Date")?"new Date("+r.getTime()+")":Array.isArray(r)?"["+r.map(n=>a(n,e)).join(",")+"]":typeof r=="object"?c+"{"+Object.keys(r).map(n=>{var l=r[n];return a(n,e)+":"+a(l,e)}).join(",")+"}"+s:r&&typeof(r==null?void 0:r.toString)=="function"?r==null?void 0:r.toString():String(r)}exports.stringify=a;

package/build/utils/uniqid.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generates a unique identifier.
+ *
+ * This function takes three parameters: a prefix, a maximum length, and a separator.
+ * It generates a unique identifier with the specified prefix, length, and separator.
+ *
+ * @param {string} [prefix=""] The prefix to use for the identifier.
+ * @param {number} [idStrLen=16] The maximum length of the identifier.
+ * @param {string} [separator=""] The separator to use in the identifier.
+ * @returns {string} The generated unique identifier.
+ * @example
+ * ```typescript
+ * console.log(uniqid()); // Output: a random unique identifier
+ * console.log(uniqid("prefix", 16)); // Output: a unique identifier with prefix and length 16
+ * console.log(uniqid("prefix", 16, "-")); // Output: a unique identifier with prefix, length 16, and separator "-"
+ * ```
+ */
+export declare function uniqid(prefix: string, idStrLen?: number, separator?: string): string;

package/build/utils/uniqid.js

@@ -0,0 +1 @@
+'use strict';function h(g,t=16,n=""){n=n||"",g=g||"",t<=0&&(t=16),t=Math.floor(t);var o=g+(Math.floor(Math.random()*25)+10).toString(36)+n;o+=new Date().getTime().toString(36)+n;do o+=Math.floor(Math.random()*35).toString(36);while(o.length<t);return o}exports.uniqid=h;

package/build/utils/uri/index.d.ts

@@ -0,0 +1,333 @@
+import { IParseBaseOptions, IStringifyBaseOptions } from 'qs';
+import { Dictionary } from '../../types';
+/**
+ * Returns the query string from a given URL.
+ *
+ * This function takes a URL and an optional flag as input.
+ * It parses the URL to extract the query string, which is the part of the URL after the `?` character.
+ * If the `addQuestionSeparator` flag is true, the query string is returned with a leading `?` character.
+ *
+ * @param uri The URL to extract the query string from.
+ * @param addQuestionSeparator Whether to include the `?` character in the returned query string (default: true).
+ * @returns The query string associated with the given URL.
+ * @example
+ * ```typescript
+ * const url = 'https://example.com/path?a=1&b=2';
+ * console.log(extractQueryString(url)); // Output: "?a=1&b=2"
+ * console.log(extractQueryString(url, false)); // Output: "a=1&b=2"
+ * ```
+ */
+export declare const extractQueryString: (uri?: string, addQuestionSeparator?: boolean) => string;
+/**
+ * Returns the query parameters from a given URL as an object.
+ *
+ * This function takes a URL and an optional options object as input.
+ * It extracts the query string from the URL using the `extractQueryString` function and then parses it into an object using the `queryString.parse` method.
+ * The `queryString.parse` method is configured to allow sparse arrays and to merge the provided options with the default options.
+ *
+ * @param uri The URL to extract the query parameters from.
+ * @param queryStringOpts Options for the `queryString.parse` method (default: {}).
+ * @returns An object containing the query parameters.
+ * @example
+ * ```typescript
+ * const url = 'https://example.com/path?a=1&b=2&c[]=3&c[]=4';
+ * console.log(getQueryParams(url)); // Output: { a: '1', b: '2', c: [ '3', '4' ] }
+ * ```
+ */
+export declare const getQueryParams: (uri: string | null | undefined, queryStringOpts?: IParseBaseOptions) => Dictionary;
+/**
+ * Removes the query string from a given URL and returns the resulting URL.
+ *
+ * This function takes a URL and an optional flag as input.
+ * It removes the query string and any fragment identifier from the URL using regular expressions.
+ * If the `_decodeURIComponent` flag is true, the resulting URL is decoded using the `decodeURIComponent` function.
+ *
+ * @param uri The URL to remove the query string from.
+ * @param _decodeURIComponent Whether to decode the resulting URL using `decodeURIComponent` (default: false).
+ * @returns The URL with the query string removed.
+ * @example
+ * ```typescript
+ * const url = 'https://example.com/path?a=1&b=2#fragment';
+ * console.log(removeQueryString(url)); // Output: "https://example.com/path"
+ * console.log(removeQueryString(url, true)); // Output: "https://example.com/path" (decoded)
+ * ```
+ */
+export declare const removeQueryString: (uri: string | undefined | null, _decodeURIComponent?: boolean) => string;
+/**
+ * Adds query parameters to a given URL.
+ *
+ * This function takes a URL, a key-value pair or an object of key-value pairs, and optional options as input.
+ * It removes any existing query string from the URL, merges the new query parameters with the existing ones, and then appends the resulting query string to the URL.
+ *
+ * @param url The URL to add query parameters to.
+ * @param key A string key or an object of key-value pairs to add to the query string.
+ * @param value The value associated with the key, only applicable when key is a string.
+ * @param options Options for the `queryString.stringify` method (default: {}).
+ * @returns The URL with the query parameters added.
+ * @example
+ * ```typescript
+ * const url = 'https://example.com/path';
+ * console.log(setQueryParams(url, 'a', 1)); // Output: "https://example.com/path?a=1"
+ * console.log(setQueryParams(url, { a: 1, b: 2 })); // Output: "https://example.com/path?a=1&b=2"
+ * ```
+ */
+export declare function setQueryParams(url: string | undefined | null, key: any, value?: any, options?: IStringifyBaseOptions): string;
+/**
+ * Converts an object to a query string.
+ *
+ * This function takes an object and an optional flag as input.
+ * It recursively iterates through the object's properties and converts them to a query string format.
+ * If the `encodeURI` flag is true, the values are encoded using the `encodeURIComponent` function.
+ *
+ * @param o The object to convert to a query string.
+ * @param encodeURI Whether to encode the values using `encodeURIComponent` (default: false).
+ * @returns The object converted to a query string.
+ * @example
+ * ```typescript
+ * const obj = { a: 1, b: 2, c: { d: 3, e: 4 } };
+ * console.log(objectToQueryString(obj)); // Output: "a=1&b=2&c[d]=3&c[e]=4"
+ * console.log(objectToQueryString(obj, true)); // Output: "a=1&b=2&c%5Bd%5D=3&c%5Be%5D=4"
+ * ```
+ */
+export declare function objectToQueryString(o: any, encodeURI?: boolean): string;
+/**
+ * Parses a URI and returns the parsed object.
+ *
+ * This function takes a URI as input and returns an object containing the parsed components of the URI.
+ * The object includes properties for the hash, host, hostname, href, origin, pathname, port, protocol, search, username, and password.
+ *
+ * @param uri The URI to parse.
+ * @returns The parsed URI object.
+ * @example
+ * ```typescript
+ * const uri = 'http://username:password@localhost:257/deploy/?asd=asd#asd';
+ * console.log(parseURI(uri));
+ * // Output:
+ * // {
+ * //   hash: "#asd",
+ * //   host: "localhost:257",
+ * //   hostname: "localhost",
+ * //   href: "http://username:password@localhost:257/deploy/?asd=asd#asd",
+ * //   origin: "http://username:password@localhost:257",
+ * //   pathname: "/deploy/",
+ * //   port: "257",
+ * //   protocol: "http:",
+ * //   search: "?asd=asd",
+ * //   username: "username",
+ * //   password: "password"
+ * // }
+ * ```
+ */
+export declare const parseURI: (uri: string | null | undefined) => {
+    hash?: string;
+    host?: string;
+    hostname?: string;
+    href?: string;
+    origin?: string;
+    pathname?: string;
+    port?: string;
+    protocol?: string;
+    search?: string;
+    username?: string;
+    password?: string;
+};
+/**
+ * Options for configuring URL validation behavior.
+ *
+ * @public
+ */
+export interface IsUrlOptions {
+    /**
+     * If true, only allows protocols that require a hostname (http, https, ftp, etc.).
+     * If false, allows all valid protocols including mailto, tel, data, etc.
+     *
+     * @defaultValue true
+     */
+    requireHost?: boolean;
+    /**
+     * List of allowed protocols. If provided, only URLs with these protocols are considered valid.
+     * Protocols should be specified without the trailing colon (e.g., 'http', not 'http:').
+     *
+     * @defaultValue undefined (all protocols allowed based on requireHost setting)
+     *
+     * @example
+     * ```typescript
+     * // Only allow HTTPS URLs
+     * isUrl('https://example.com', { allowedProtocols: ['https'] }); // true
+     * isUrl('http://example.com', { allowedProtocols: ['https'] }); // false
+     * ```
+     */
+    allowedProtocols?: string[];
+}
+/**
+ * Validates whether a given string is a valid, full URL.
+ *
+ * @remarks
+ * This function uses a dual-approach validation strategy:
+ * 1. First attempts to use the native URL constructor if available (modern environments)
+ * 2. Falls back to a comprehensive regex pattern for environments without URL support
+ *
+ * By default, a valid full URL must include:
+ * - A protocol (http, https, ftp, etc.)
+ * - A domain/host (for protocols that require one)
+ * - Optional path, query parameters, and hash fragments
+ *
+ * The function can be configured to:
+ * - Accept only host-requiring protocols (default)
+ * - Accept any valid URI including mailto:, tel:, data:, etc.
+ * - Restrict to specific protocols only
+ *
+ * @param value - The string to test for URL validity
+ * @param options - Optional configuration for validation behavior
+ *
+ * @returns `true` if the string is a valid full URL, `false` otherwise
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * isUrl('https://example.com'); // true
+ * isUrl('example.com'); // false (missing protocol)
+ * isUrl('mailto:user@example.com'); // false (default requires host)
+ * ```
+ *
+ * @example
+ * Allow all valid URIs:
+ * ```typescript
+ * isUrl('mailto:user@example.com', { requireHost: false }); // true
+ * isUrl('tel:+1234567890', { requireHost: false }); // true
+ * isUrl('data:text/plain,hello', { requireHost: false }); // true
+ * ```
+ *
+ * @example
+ * Restrict to specific protocols:
+ * ```typescript
+ * isUrl('https://example.com', { allowedProtocols: ['https'] }); // true
+ * isUrl('http://example.com', { allowedProtocols: ['https'] }); // false
+ * ```
+ *
+ * @public
+ */
+export declare function isUrl(value: string, options?: IsUrlOptions): boolean;
+/**
+ * Detects if a URL string has been encoded using encodeURIComponent.
+ *
+ * This function uses multiple heuristics to determine if a string has been
+ * encoded with encodeURIComponent. It checks for:
+ * 1. Presence of valid encoded character sequences (%XX where XX are hex digits)
+ * 2. Whether decoding changes the string (indicating encoded content)
+ * 3. Handles mixed encoded/unencoded content properly
+ *
+ * @param {any} str - The string to check for encoding
+ * @returns {boolean} - Returns true if the string appears to be encoded, false otherwise
+ *
+ * @example
+ * console.log(isUriEncoded('hello%20world')); // true
+ * console.log(isUriEncoded('hello world')); // false
+ * console.log(isUriEncoded('hello%2Bworld')); // true
+ * console.log(isUriEncoded('hello+world')); // false
+ * console.log(isUriEncoded('https%3A%2F%2Fexample.com')); // true
+ * console.log(isUriEncoded('https://example.com')); // false
+ * console.log(isUriEncoded('hello%20world%21normal')); // true (mixed)
+ */
+export declare const isUriEncoded: (str: string) => boolean;
+/**
+ * Options for configuring Data URL validation behavior.
+ *
+ * @public
+ */
+export interface IsDataUrlOptions {
+    /**
+     * List of allowed MIME types. If provided, only Data URLs with these MIME types are considered valid.
+     * MIME types should be specified in lowercase (e.g., 'image/png', 'text/plain').
+     *
+     * @defaultValue undefined (all MIME types allowed)
+     *
+     * @example
+     * ```typescript
+     * // Only allow image Data URLs
+     * isDataUrl('data:image/png;base64,ABC', { allowedMimeTypes: ['image/png', 'image/jpeg'] }); // true
+     * isDataUrl('data:text/plain;base64,ABC', { allowedMimeTypes: ['image/png'] }); // false
+     * ```
+     */
+    allowedMimeTypes?: string[];
+    /**
+     * If true, requires the Data URL to use base64 encoding.
+     * If false, allows both base64 and URL-encoded data.
+     *
+     * @defaultValue false
+     *
+     * @example
+     * ```typescript
+     * isDataUrl('data:text/plain;base64,SGVsbG8=', { requireBase64: true }); // true
+     * isDataUrl('data:text/plain,Hello', { requireBase64: true }); // false
+     * ```
+     */
+    requireBase64?: boolean;
+    /**
+     * If true, validates that base64-encoded data appears to be valid base64.
+     * Performs basic validation of base64 character set and padding.
+     *
+     * @defaultValue false
+     *
+     * @example
+     * ```typescript
+     * isDataUrl('data:text/plain;base64,SGVsbG8=', { validateBase64: true }); // true
+     * isDataUrl('data:text/plain;base64,!!!invalid', { validateBase64: true }); // false
+     * ```
+     */
+    validateBase64?: boolean;
+}
+/**
+ * Validates whether a given string is a valid Data URL (RFC 2897).
+ *
+ * @remarks
+ * Data URLs allow embedding small files inline in documents using the format:
+ * `data:[<mediatype>][;base64],<data>`
+ *
+ * This function validates:
+ * - Proper data: protocol prefix
+ * - Valid MIME type format (if present)
+ * - Proper encoding declaration (base64 or URL-encoded)
+ * - Data payload presence
+ *
+ * Components of a Data URL:
+ * - Protocol: Always "data:"
+ * - Media type (optional): MIME type like "text/plain" or "image/png" (defaults to "text/plain;charset=US-ASCII")
+ * - Encoding (optional): ";base64" for base64 encoding (defaults to URL encoding)
+ * - Data: The actual content after the comma
+ *
+ * The function uses a dual-approach validation strategy:
+ * 1. First attempts to use the native URL constructor if available (modern environments)
+ * 2. Falls back to a comprehensive regex pattern for environments without URL support
+ *
+ * @param value - The string to test for Data URL validity
+ * @param options - Optional configuration for validation behavior
+ *
+ * @returns `true` if the string is a valid Data URL, `false` otherwise
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * isDataUrl('data:text/plain,Hello%20World'); // true
+ * isDataUrl('data:text/plain;base64,SGVsbG8gV29ybGQ='); // true
+ * isDataUrl('data:image/png;base64,iVBORw0KG...'); // true
+ * isDataUrl('not a data url'); // false
+ * ```
+ *
+ * @example
+ * With MIME type filtering:
+ * ```typescript
+ * isDataUrl('data:image/png;base64,ABC', { allowedMimeTypes: ['image/png'] }); // true
+ * isDataUrl('data:text/plain,Hello', { allowedMimeTypes: ['image/png'] }); // false
+ * ```
+ *
+ * @example
+ * Require base64 encoding:
+ * ```typescript
+ * isDataUrl('data:text/plain;base64,SGVsbG8=', { requireBase64: true }); // true
+ * isDataUrl('data:text/plain,Hello', { requireBase64: true }); // false
+ * ```
+ *
+ * @public
+ */
+export declare function isDataUrl(value: string, options?: IsDataUrlOptions): boolean;

package/build/utils/uri/index.js

@@ -0,0 +1,2 @@
+'use strict';var R=require('qs');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var R__default=/*#__PURE__*/_interopDefault(R);var L=Object.defineProperty;var P=Object.getOwnPropertySymbols;var T=Object.prototype.hasOwnProperty,B=Object.prototype.propertyIsEnumerable;var A=(t,e,r)=>e in t?L(t,e,{enumerable:true,configurable:true,writable:true,value:r}):t[e]=r,w=(t,e)=>{for(var r in e||(e={}))T.call(e,r)&&A(t,r,e[r]);if(P)for(var r of P(e))B.call(e,r)&&A(t,r,e[r]);return t};function g(t){return !!(t&&typeof t=="string")}var U=function(t,e=""){if(!t||typeof t!="string")return "";if(!e||typeof e!="string")return t.trim();let r=t.length;for(;t.startsWith(e)&&r>=0;)t=t.slice(e.length),--r;return t.toString()},C=function(t,e=""){if(!t||typeof t!="string")return "";if(!e||typeof e!="string")return t.trim();let r=t.length;for(;t.endsWith(e)&&r>=0;)t=t.slice(0,-e.length),--r;return t.toString()},N=(t,e=true)=>typeof t!="string"?false:e!==false?/^\d*\.?\d+$/.test(t):/^\d+$/.test(t);String.prototype.ltrim=function(t){return U(this.toString(),t)};String.prototype.rtrim=function(t){return C(this.toString(),t)};String.prototype.isNumber=function(t=true){return N(this.toString(),t)};String.prototype.replaceAll=function(t,e){return !g(t)||!g(e)?this.toString():this.toString().split(t).join(e)};var q=t=>g(t)?(t=t.trim(),t.replace(/(.)([A-Z][a-z]+)/,"$1_$2").replace(/([a-z0-9])([A-Z])/,"$1_$2").toUpperCase()):"";String.prototype.toSnakeCase=function(){return q(this.toString())};var D=t=>g(t)?(t=t.trim(),t.charAt(0)+t.replace(/(_\w)/g,e=>e[1].toUpperCase()).substring(1)):"";String.prototype.toCamelCase=function(){return D(this.toString())};var F=function(t){return !t||typeof t!="string"?"":(t=t.trim(),t.charAt(0).toUpperCase()+t.slice(1))};String.prototype.upperFirst=function(){return F(this.toString())};var M=function(t){return !t||typeof t!="string"?"":(t=t.trim(),t.charAt(0).toLowerCase()+t.slice(1))};String.prototype.lowerFirst=function(){return M(this.toString())};var W=(t,e=true)=>{if(typeof t!="string")return "";let r=V(t);return t=typeof r.search=="string"?r.search:"",e&&t?"?"+U(t,"?"):(t=C(U(t.trim(),"?"),"?"),t)},Z=function(t,e={}){return typeof t!="string"?{}:R__default.default.parse(W(t,false),w({allowSparse:true,decoder:r=>decodeURIComponent(r.replace(/\+/g," "))},Object.assign({},e)))},E=function(t,e=false){return typeof t!="string"?"":(t=t.replace(/#.*$/,"").replace(/\?.*$/,""),e===true?decodeURIComponent(t):t)},Q={indices:true,encodeValuesOnly:false,skipNulls:false,arrayFormat:"indices",encoder:t=>encodeURIComponent(t).replace(/%5B/g,"[").replace(/%5D/g,"]")};function rt(t,e,r,s={}){if(typeof t!="string")return "";t||(t="");let i=Z(t),n=t.split("#"),a=n[0],d=n[1]?"#"+n[1]:"";t=E(a),typeof e=="object"?(e||(e={}),s=typeof s=="object"&&s?s:typeof r=="object"&&r?r:{}):typeof e=="string"&&(e={[e]:r}),typeof e=="object"&&e&&!Array.isArray(e)&&Object.assign(i,e);let u=R__default.default.stringify(i,w(w({},Q),Object.assign({},s)));return t+(u?"?"+u:"")+d}function nt(t,e=false){if(t==null||typeof t!="object")return "";function r(i,n){if(Array.isArray(i)){i.forEach(function(a){r(a,n+"[]");});return}if(i!==null&&typeof i=="object"){Object.keys(i).forEach(function(a){r(i[a],n+"["+a+"]");});return}s.push((e?encodeURIComponent(n):n)+"="+(e?encodeURIComponent(i):i));}let s=[];return Object.keys(t).forEach(function(i){r(t[i],i);}),s.join("&")}var V=t=>{if(typeof t!="string")return {};if(typeof URL!="undefined"&&URL&&H(t))try{return new URL(t)}catch(s){}t=_(t)?decodeURIComponent(t):t;var e=t.match(/^(([^:\\/?#]+:)?(?:\/\/((?:([^\\/?#:]*):([^\\/?#:]*)@)?([^\\/?#:]*)(?::([^\\/?#:]*))?)))?([^?#]*)(\?[^#]*)?(#.*)?$/);let r=e?{hash:e[10]||"",host:e[3]||"",hostname:e[6]||"",href:e[0]||"",origin:e[1]||"",pathname:e[8]||(e[1]?"/":""),port:e[7]||"",protocol:e[2]||"",search:e[9]||"",username:e[4]||"",password:e[5]||""}:{};return r.protocol&&r.protocol.length==2&&(r.protocol="file:///"+r.protocol.toUpperCase(),r.origin=r.protocol+"//"+r.host),r.protocol&&(r.href=r.origin+r.pathname+r.search+r.hash),r};function H(t,e={}){let{requireHost:r=true,allowedProtocols:s}=Object.assign({},e);if(!g(t)||!g(t.trim()))return  false;let i=t;if(typeof URL!="undefined"&&URL)try{let n=new URL(i);if(!n.protocol||n.protocol===":")return !1;let a=n.protocol.slice(0,-1);if(s&&s.length>0&&!s.includes(a))return !1;if(r)if(["http","https","ftp","ftps","ws","wss"].includes(a)){if(!g(n.hostname)||!n.hostname.trim()||!g(n.host)||!n.host.trim())return !1;let u=`${a}://`;if(!i.startsWith(u)||i.slice(u.length).startsWith("/"))return !1;let p=/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/,h=n.hostname.match(p);if(h&&!h.slice(1,5).map(Number).every(o=>o>=0&&o<=255))return !1}else return !1;return !0}catch(n){return  false}if(r){let n=i.indexOf("://");if(n===-1)return  false;let a=i.slice(0,n);if(!a||s&&s.length>0&&!s.includes(a))return  false;let d=i.slice(n+3);if(d==="")return  false;let u=d.indexOf("@"),c=u>=0?d.slice(u+1):d;if(c===""||c.startsWith("/"))return  false;let p=c.indexOf("/"),h=c.indexOf("?"),x=c.indexOf("#"),b=Math.min(p>=0?p:c.length,h>=0?h:c.length,x>=0?x:c.length),o=c.slice(0,b);if(!o)return  false;let l=o;if(o.startsWith("[")){let f=o.indexOf("]");if(f===-1)return  false;l=o.slice(0,f+1);let m=o.slice(f+1);if(m&&!m.startsWith(":"))return  false}else {let f=o.indexOf(":");f>=0&&(l=o.slice(0,f));}if(!l)return  false;if(l==="localhost")return  true;if(/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.test(l))return !l.split(".").map(Number).some(m=>m>255||m<0);if(/^\[.*\]$/.test(l)){let f=l.slice(1,-1);return !(!f||f.includes(":::"))}return !!(/^[a-zA-Z\d-]*(\.[a-zA-Z\d-]+)*$/.test(l)&&l!=="")}else {let n="[a-zA-Z][a-zA-Z\\d+\\-.]*";return s&&s.length>0&&(n=`(?:${s.join("|")})`),new RegExp(`^(${n}):.+$`).test(i)}}var _=t=>{if(!g(t)||!t.includes("%"))return  false;let e=/%[0-9A-Fa-f]{2}/g;if(!t.match(e))return  false;try{let s=decodeURIComponent(t);if(s!==t)return !0;try{if(decodeURIComponent(s)!==s)return !0}catch(i){return !0}}catch(s){return  false}return  false};function st(t,e={}){let{allowedMimeTypes:r,requireBase64:s=false,validateBase64:i=false}=Object.assign({},e);if(typeof t!="string"||t.trim()==="")return  false;let n=t.trim();if(!n.toLowerCase().startsWith("data:"))return  false;if(typeof URL!="undefined")try{if(new URL(n).protocol!=="data:")return !1;let o=/^data:([^,;]*)(;[^,]*)?,(.*)$/i,l=n.match(o);if(!l)return !1;let[,f,m,y]=l;if(y===void 0||y.length===0)return !1;let I=(f||"text/plain").trim().toLowerCase();if(f&&f.trim()!==""&&!/^[a-z]+\/[a-z0-9][a-z0-9\-+.]*$/i.test(I)||r&&r.length>0&&!r.some(S=>S.toLowerCase()===I))return !1;let O=(m==null?void 0:m.toLowerCase().includes("base64"))||!1;if(s&&!O)return !1;if(i&&O){if(!/^[A-Za-z0-9+/]*={0,2}$/.test(y)||y.length%4!==0)return !1;let S=y.match(/=+$/);if(S&&S[0].length>2)return !1;if(y.includes("=")){let j=y.indexOf("="),z=y.slice(j);if(!/^=+$/.test(z))return !1}}return !0}catch(b){return  false}let a=/^data:([^,;]*)(;[^,]*)?,(.+)$/i,d=n.match(a);if(!d)return  false;let[,u,c,p]=d,h=(u||"text/plain").trim().toLowerCase();if(u&&u.trim()!==""&&!/^[a-z]+\/[a-z0-9][a-z0-9\-+.]*$/i.test(h)||r&&r.length>0&&!r.some(o=>o.toLowerCase()===h))return  false;let x=(c==null?void 0:c.toLowerCase().includes("base64"))||false;if(s&&!x)return  false;if(i&&x){if(!/^[A-Za-z0-9+/]*={0,2}$/.test(p)||p.length%4!==0)return  false;let o=p.match(/=+$/);if(o&&o[0].length>2)return  false;if(p.includes("=")){let l=p.indexOf("="),f=p.slice(l);if(!/^=+$/.test(f))return  false}}return  true}
+exports.extractQueryString=W;exports.getQueryParams=Z;exports.isDataUrl=st;exports.isUriEncoded=_;exports.isUrl=H;exports.objectToQueryString=nt;exports.parseURI=V;exports.removeQueryString=E;exports.setQueryParams=rt;

package/build/validator/index.d.ts

@@ -0,0 +1,4 @@
+import 'reflect-metadata';
+export * from './rules';
+export * from './types';
+export * from './validator';