@zairakai/js-utils 1.0.0

package/dist/str.d.cts

@@ -0,0 +1,282 @@
+/**
+ * Fluent string manipulation class inspired by Laravel's Str and Stringable
+ */
+declare class Stringable {
+    protected value: string;
+    constructor(value: unknown);
+    /**
+     * Get the raw string value
+     *
+     * @returns {string} The raw string
+     */
+    toString(): string;
+    /**
+     * Alias for toString()
+     *
+     * @returns {string} The raw string
+     */
+    get(): string;
+    /**
+     * Convert to title case
+     *
+     * @returns {this} The Stringable instance
+     */
+    title(): this;
+    /**
+     * Convert to slug
+     *
+     * @returns {this} The Stringable instance
+     */
+    slug(): this;
+    /**
+     * Convert to snake_case
+     *
+     * @returns {this} The Stringable instance
+     */
+    snake(): this;
+    /**
+     * Convert to kebab-case
+     *
+     * @returns {this} The Stringable instance
+     */
+    kebab(): this;
+    /**
+     * Convert to camelCase
+     *
+     * @returns {this} The Stringable instance
+     */
+    camel(): this;
+    /**
+     * Convert to StudlyCase
+     *
+     * @returns {this} The Stringable instance
+     */
+    studly(): this;
+    /**
+     * Limit the string length
+     *
+     * @param {number} size The maximum length
+     * @param {string} [end='…'] The string to append if limited
+     * @returns {this} The Stringable instance
+     */
+    limit(size: number, end?: string): this;
+    /**
+     * Append a value to the string
+     *
+     * @param {...unknown[]} values The values to append
+     * @returns {this} The Stringable instance
+     */
+    append(...values: unknown[]): this;
+    /**
+     * Prepend a value to the string
+     *
+     * @param {...unknown[]} values The values to prepend
+     * @returns {this} The Stringable instance
+     */
+    prepend(...values: unknown[]): this;
+    /**
+     * Cap the string with a value if it doesn't already end with it
+     *
+     * @param {string} cap The string to end with
+     * @returns {this} The Stringable instance
+     */
+    finish(cap: string): this;
+    /**
+     * Start the string with a value if it doesn't already start with it
+     *
+     * @param {string} prefix The string to start with
+     * @returns {this} The Stringable instance
+     */
+    start(prefix: string): this;
+    /**
+     * Replace the first occurrence of a value
+     *
+     * @param {string | RegExp} search The value to search for
+     * @param {string} replace The value to replace with
+     * @returns {this} The Stringable instance
+     */
+    replace(search: string | RegExp, replace: string): this;
+    /**
+     * Replace all occurrences of a value
+     *
+     * @param {string | RegExp} search The value to search for
+     * @param {string} replace The value to replace with
+     * @returns {this} The Stringable instance
+     */
+    replaceAll(search: string | RegExp, replace: string): this;
+    /**
+     * Reverse the string
+     *
+     * @returns {this} The Stringable instance
+     */
+    reverse(): this;
+    /**
+     * Mask a portion of the string
+     *
+     * @param {string} character The masking character
+     * @param {number} index The starting index
+     * @param {number} [length] The number of characters to mask
+     * @returns {this} The Stringable instance
+     */
+    mask(character: string, index: number, length?: number): this;
+    /**
+     * Trim the string
+     *
+     * @param {string} [chars] The characters to trim (defaults to whitespace)
+     * @returns {this} The Stringable instance
+     */
+    trim(chars?: string): this;
+    /**
+     * Convert to lower case
+     *
+     * @returns {this} The Stringable instance
+     */
+    lower(): this;
+    /**
+     * Convert to upper case
+     *
+     * @returns {this} The Stringable instance
+     */
+    upper(): this;
+    /**
+     * Capitalize the first letter
+     *
+     * @returns {this} The Stringable instance
+     */
+    capitalize(): this;
+    /**
+     * Check if string contains a value
+     *
+     * @param {string | string[]} needles The values to search for
+     * @returns {boolean} True if the string contains any of the values
+     */
+    contains(needles: string | string[]): boolean;
+    /**
+     * Check if string contains all values
+     *
+     * @param {string[]} needles The values to search for
+     * @returns {boolean} True if the string contains all values
+     */
+    containsAll(needles: string[]): boolean;
+    /**
+     * Check if string starts with a value
+     *
+     * @param {string | string[]} needles The values to check
+     * @returns {boolean} True if the string starts with any of the values
+     */
+    startsWith(needles: string | string[]): boolean;
+    /**
+     * Check if string ends with a value
+     *
+     * @param {string | string[]} needles The values to check
+     * @returns {boolean} True if the string ends with any of the values
+     */
+    endsWith(needles: string | string[]): boolean;
+    /**
+     * Execute a callback with the stringable and return the result
+     *
+     * @param {(str: this) => U} callback The callback to execute
+     * @returns {U} The result of the callback
+     */
+    pipe<U>(callback: (str: this) => U): U;
+    /**
+     * Conditionally execute a callback
+     *
+     * @param {boolean | (() => boolean)} condition The condition to check
+     * @param {(str: this) => void} callback The callback to execute
+     * @returns {this} The Stringable instance
+     */
+    when(condition: boolean | (() => boolean), callback: (str: this) => void): this;
+    /**
+     * Execute a callback and return the stringable (for side effects)
+     *
+     * @param {(str: this) => void} callback The callback to execute
+     * @returns {this} The Stringable instance
+     */
+    tap(callback: (str: this) => void): this;
+}
+/**
+ * Create a new fluent stringable instance
+ *
+ * @param {unknown} [value] The initial string value
+ * @returns {Stringable} A new Stringable instance
+ */
+declare const str: (value?: unknown) => Stringable;
+/**
+ * Static methods for string manipulation
+ */
+declare const Str: {
+    /**
+     * Create a new fluent stringable instance
+     *
+     * @param {unknown} value The initial string value
+     * @returns {Stringable} A new Stringable instance
+     */
+    of: (value: unknown) => Stringable;
+    /**
+     * Convert a string to a slug
+     *
+     * @param {string} value The string to slugify
+     * @returns {string} The slugified string
+     */
+    slug: (value: string) => string;
+    /**
+     * Convert a string to snake_case
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The snake_case string
+     */
+    snake: (value: string) => string;
+    /**
+     * Convert a string to kebab-case
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The kebab-case string
+     */
+    kebab: (value: string) => string;
+    /**
+     * Convert a string to camelCase
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The camelCase string
+     */
+    camel: (value: string) => string;
+    /**
+     * Convert a string to StudlyCase
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The StudlyCase string
+     */
+    studly: (value: string) => string;
+    /**
+     * Convert a string to title case
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The title case string
+     */
+    title: (value: string) => string;
+    /**
+     * Limit the length of a string
+     *
+     * @param {string} value The string to limit
+     * @param {number} size The maximum length
+     * @param {string} [end='…'] The string to append if limited
+     * @returns {string} The limited string
+     */
+    limit: (value: string, size: number, end?: string) => string;
+    /**
+     * Generate a random alphanumeric string
+     *
+     * @param {number} [length=16] The length of the random string
+     * @returns {string} The random string
+     */
+    random: (length?: number) => string;
+    /**
+     * Generate a UUID (version 4)
+     *
+     * @returns {string} The generated UUID
+     */
+    uuid: () => string;
+};
+
+export { Str, Stringable, str };

package/dist/str.d.ts

@@ -0,0 +1,282 @@
+/**
+ * Fluent string manipulation class inspired by Laravel's Str and Stringable
+ */
+declare class Stringable {
+    protected value: string;
+    constructor(value: unknown);
+    /**
+     * Get the raw string value
+     *
+     * @returns {string} The raw string
+     */
+    toString(): string;
+    /**
+     * Alias for toString()
+     *
+     * @returns {string} The raw string
+     */
+    get(): string;
+    /**
+     * Convert to title case
+     *
+     * @returns {this} The Stringable instance
+     */
+    title(): this;
+    /**
+     * Convert to slug
+     *
+     * @returns {this} The Stringable instance
+     */
+    slug(): this;
+    /**
+     * Convert to snake_case
+     *
+     * @returns {this} The Stringable instance
+     */
+    snake(): this;
+    /**
+     * Convert to kebab-case
+     *
+     * @returns {this} The Stringable instance
+     */
+    kebab(): this;
+    /**
+     * Convert to camelCase
+     *
+     * @returns {this} The Stringable instance
+     */
+    camel(): this;
+    /**
+     * Convert to StudlyCase
+     *
+     * @returns {this} The Stringable instance
+     */
+    studly(): this;
+    /**
+     * Limit the string length
+     *
+     * @param {number} size The maximum length
+     * @param {string} [end='…'] The string to append if limited
+     * @returns {this} The Stringable instance
+     */
+    limit(size: number, end?: string): this;
+    /**
+     * Append a value to the string
+     *
+     * @param {...unknown[]} values The values to append
+     * @returns {this} The Stringable instance
+     */
+    append(...values: unknown[]): this;
+    /**
+     * Prepend a value to the string
+     *
+     * @param {...unknown[]} values The values to prepend
+     * @returns {this} The Stringable instance
+     */
+    prepend(...values: unknown[]): this;
+    /**
+     * Cap the string with a value if it doesn't already end with it
+     *
+     * @param {string} cap The string to end with
+     * @returns {this} The Stringable instance
+     */
+    finish(cap: string): this;
+    /**
+     * Start the string with a value if it doesn't already start with it
+     *
+     * @param {string} prefix The string to start with
+     * @returns {this} The Stringable instance
+     */
+    start(prefix: string): this;
+    /**
+     * Replace the first occurrence of a value
+     *
+     * @param {string | RegExp} search The value to search for
+     * @param {string} replace The value to replace with
+     * @returns {this} The Stringable instance
+     */
+    replace(search: string | RegExp, replace: string): this;
+    /**
+     * Replace all occurrences of a value
+     *
+     * @param {string | RegExp} search The value to search for
+     * @param {string} replace The value to replace with
+     * @returns {this} The Stringable instance
+     */
+    replaceAll(search: string | RegExp, replace: string): this;
+    /**
+     * Reverse the string
+     *
+     * @returns {this} The Stringable instance
+     */
+    reverse(): this;
+    /**
+     * Mask a portion of the string
+     *
+     * @param {string} character The masking character
+     * @param {number} index The starting index
+     * @param {number} [length] The number of characters to mask
+     * @returns {this} The Stringable instance
+     */
+    mask(character: string, index: number, length?: number): this;
+    /**
+     * Trim the string
+     *
+     * @param {string} [chars] The characters to trim (defaults to whitespace)
+     * @returns {this} The Stringable instance
+     */
+    trim(chars?: string): this;
+    /**
+     * Convert to lower case
+     *
+     * @returns {this} The Stringable instance
+     */
+    lower(): this;
+    /**
+     * Convert to upper case
+     *
+     * @returns {this} The Stringable instance
+     */
+    upper(): this;
+    /**
+     * Capitalize the first letter
+     *
+     * @returns {this} The Stringable instance
+     */
+    capitalize(): this;
+    /**
+     * Check if string contains a value
+     *
+     * @param {string | string[]} needles The values to search for
+     * @returns {boolean} True if the string contains any of the values
+     */
+    contains(needles: string | string[]): boolean;
+    /**
+     * Check if string contains all values
+     *
+     * @param {string[]} needles The values to search for
+     * @returns {boolean} True if the string contains all values
+     */
+    containsAll(needles: string[]): boolean;
+    /**
+     * Check if string starts with a value
+     *
+     * @param {string | string[]} needles The values to check
+     * @returns {boolean} True if the string starts with any of the values
+     */
+    startsWith(needles: string | string[]): boolean;
+    /**
+     * Check if string ends with a value
+     *
+     * @param {string | string[]} needles The values to check
+     * @returns {boolean} True if the string ends with any of the values
+     */
+    endsWith(needles: string | string[]): boolean;
+    /**
+     * Execute a callback with the stringable and return the result
+     *
+     * @param {(str: this) => U} callback The callback to execute
+     * @returns {U} The result of the callback
+     */
+    pipe<U>(callback: (str: this) => U): U;
+    /**
+     * Conditionally execute a callback
+     *
+     * @param {boolean | (() => boolean)} condition The condition to check
+     * @param {(str: this) => void} callback The callback to execute
+     * @returns {this} The Stringable instance
+     */
+    when(condition: boolean | (() => boolean), callback: (str: this) => void): this;
+    /**
+     * Execute a callback and return the stringable (for side effects)
+     *
+     * @param {(str: this) => void} callback The callback to execute
+     * @returns {this} The Stringable instance
+     */
+    tap(callback: (str: this) => void): this;
+}
+/**
+ * Create a new fluent stringable instance
+ *
+ * @param {unknown} [value] The initial string value
+ * @returns {Stringable} A new Stringable instance
+ */
+declare const str: (value?: unknown) => Stringable;
+/**
+ * Static methods for string manipulation
+ */
+declare const Str: {
+    /**
+     * Create a new fluent stringable instance
+     *
+     * @param {unknown} value The initial string value
+     * @returns {Stringable} A new Stringable instance
+     */
+    of: (value: unknown) => Stringable;
+    /**
+     * Convert a string to a slug
+     *
+     * @param {string} value The string to slugify
+     * @returns {string} The slugified string
+     */
+    slug: (value: string) => string;
+    /**
+     * Convert a string to snake_case
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The snake_case string
+     */
+    snake: (value: string) => string;
+    /**
+     * Convert a string to kebab-case
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The kebab-case string
+     */
+    kebab: (value: string) => string;
+    /**
+     * Convert a string to camelCase
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The camelCase string
+     */
+    camel: (value: string) => string;
+    /**
+     * Convert a string to StudlyCase
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The StudlyCase string
+     */
+    studly: (value: string) => string;
+    /**
+     * Convert a string to title case
+     *
+     * @param {string} value The string to convert
+     * @returns {string} The title case string
+     */
+    title: (value: string) => string;
+    /**
+     * Limit the length of a string
+     *
+     * @param {string} value The string to limit
+     * @param {number} size The maximum length
+     * @param {string} [end='…'] The string to append if limited
+     * @returns {string} The limited string
+     */
+    limit: (value: string, size: number, end?: string) => string;
+    /**
+     * Generate a random alphanumeric string
+     *
+     * @param {number} [length=16] The length of the random string
+     * @returns {string} The random string
+     */
+    random: (length?: number) => string;
+    /**
+     * Generate a UUID (version 4)
+     *
+     * @returns {string} The generated UUID
+     */
+    uuid: () => string;
+};
+
+export { Str, Stringable, str };

package/dist/str.js

@@ -0,0 +1,11 @@
+import {
+  Str,
+  Stringable,
+  str
+} from "./chunk-27YHP2CK.js";
+import "./chunk-F6RSTW65.js";
+export {
+  Str,
+  Stringable,
+  str
+};

package/dist/types.cjs

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/dist/types.d.cts

@@ -0,0 +1,13 @@
+/**
+ * Common type definitions for the helpers package
+ */
+/**
+ * A generic record object with string keys and unknown values
+ */
+type GenericRecord = Record<string, unknown>;
+/**
+ * A type that can be an object record or an array
+ */
+type DataContainer = GenericRecord | unknown[];
+
+export type { DataContainer, GenericRecord };

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Common type definitions for the helpers package
+ */
+/**
+ * A generic record object with string keys and unknown values
+ */
+type GenericRecord = Record<string, unknown>;
+/**
+ * A type that can be an object record or an array
+ */
+type DataContainer = GenericRecord | unknown[];
+
+export type { DataContainer, GenericRecord };

package/dist/types.js

@@ -0,0 +1 @@
+import "./chunk-6F4PWJZI.js";