@visulima/string 3.0.0-alpha.9 → 3.0.0

package/dist/case/pascal-case.d.ts

@@ -1,5 +1,19 @@
-import { C as CaseOptions, P as PascalCase } from "../packem_shared/types.d-DfgbcNKh.js";
-import "../packem_shared/types.d-BVNv675q.js";
-import "../packem_shared/lru-cache.d-BsP6kbVJ.js";
+import { b as CaseOptions, P as PascalCase } from "../packem_shared/types.d-fhe030jX.js";
+import "../packem_shared/types.d-CmNvyl4l.js";
+/**
+* Converts a string to PascalCase.
+* @param value The string to convert.
+* @param options Options for case conversion.
+* @returns The string in PascalCase.
+* @example
+* ```typescript
+* pascalCase('foo bar') // 'FooBar'
+* pascalCase('foo-bar') // 'FooBar'
+* pascalCase('foo_bar') // 'FooBar'
+* pascalCase('XMLHttpRequest') // 'XmlHttpRequest'
+* pascalCase('AJAXRequest') // 'AjaxRequest'
+* pascalCase('QueryXML123String') // 'QueryXml123String'
+* ```
+*/
 declare const pascalCase: <T extends string = string>(value?: T, options?: CaseOptions) => PascalCase<T>;
 export { pascalCase as default };

package/dist/case/pascal-case.js

@@ -1,48 +1 @@
-import { R as RE_FAST_ANSI } from '../packem_shared/constants-BsZS5f0z.js';
-import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
-import { splitByCase } from './split-by-case.js';
-import upperFirst from './upper-first.js';
-import { g as generateCacheKey } from '../packem_shared/generate-cache-key-DdayDfjV.js';
-import joinSegments from '../packem_shared/joinSegments-CvxSgKz0.js';
-import { n as normalizeGermanEszett } from '../packem_shared/normalize-german-eszett-4p3yKEzn.js';
-
-const defaultCacheStore = new LRUCache(1e3);
-const pascalCase = (value, options) => {
-  if (typeof value !== "string" || !value) {
-    return "";
-  }
-  const shouldCache = options?.cache ?? false;
-  const cacheStore = options?.cacheStore ?? defaultCacheStore;
-  let cacheKey;
-  if (shouldCache) {
-    cacheKey = generateCacheKey(value, options);
-  }
-  if (shouldCache && cacheKey && cacheStore.has(cacheKey)) {
-    return cacheStore.get(cacheKey);
-  }
-  const result = joinSegments(
-    splitByCase(value, {
-      handleAnsi: options?.handleAnsi,
-      handleEmoji: options?.handleEmoji,
-      knownAcronyms: options?.knownAcronyms,
-      locale: options?.locale,
-      normalize: options?.normalize,
-      separators: void 0,
-      stripAnsi: options?.stripAnsi,
-      stripEmoji: options?.stripEmoji
-    }).map((word) => {
-      if (options?.handleAnsi && RE_FAST_ANSI.test(word)) {
-        return word;
-      }
-      const split = options?.locale?.startsWith("de") ? normalizeGermanEszett(word) : word;
-      return upperFirst(options?.locale ? split.toLocaleLowerCase(options.locale) : split.toLowerCase(), { locale: options?.locale });
-    }),
-    ""
-  );
-  if (shouldCache && cacheKey) {
-    cacheStore.set(cacheKey, result);
-  }
-  return result;
-};
-
-export { pascalCase as default };
+import{c as e}from"../packem_shared/constants-aPzGW29R.js";import{i as m}from"../packem_shared/lru-cache-BtMSrYQJ.js";import{splitByCase as c}from"./split-by-case.js";import p from"./upper-first.js";import{n as f}from"../packem_shared/generate-cache-key-BqU1Cqwm.js";import h from"../packem_shared/joinSegments-CaHT-45s.js";import{a as A}from"../packem_shared/normalize-german-eszett-hNMwtGjd.js";const d=new m(1e3),L=(t,o)=>{if(typeof t!="string"||!t)return"";const n=o?.cache??!1,i=o?.cacheStore??d;let r;if(n&&(r=f(t,o)),n&&r&&i.has(r))return i.get(r);const a=h(c(t,{handleAnsi:o?.handleAnsi,handleEmoji:o?.handleEmoji,knownAcronyms:o?.knownAcronyms,locale:o?.locale,normalize:o?.normalize,separators:void 0,stripAnsi:o?.stripAnsi,stripEmoji:o?.stripEmoji}).map(s=>{if(o?.handleAnsi&&e.test(s))return s;const l=o?.locale?.startsWith("de")?A(s):s;return p(o?.locale?l.toLocaleLowerCase(o.locale):l.toLowerCase(),{locale:o?.locale})}),"");return n&&r&&i.set(r,a),a};export{L as default};

package/dist/case/pascal-snake-case.d.ts

@@ -1,5 +1,16 @@
-import { C as CaseOptions, f as PascalSnakeCase } from "../packem_shared/types.d-DfgbcNKh.js";
-import "../packem_shared/types.d-BVNv675q.js";
-import "../packem_shared/lru-cache.d-BsP6kbVJ.js";
+import { b as CaseOptions, f as PascalSnakeCase } from "../packem_shared/types.d-fhe030jX.js";
+import "../packem_shared/types.d-CmNvyl4l.js";
+/**
+* Converts a string to Pascal_Snake_Case.
+* @example
+* ```typescript
+* pascalSnakeCase("foo bar") // => "Foo_Bar"
+* pascalSnakeCase("foo-bar") // => "Foo_Bar"
+* pascalSnakeCase("foo_bar") // => "Foo_Bar"
+* pascalSnakeCase("XMLHttpRequest") // => "Xml_Http_Request"
+* pascalSnakeCase("AJAXRequest") // => "Ajax_Request"
+* pascalSnakeCase("QueryXML123String") // => "Query_Xml_123_String"
+* ```
+*/
 declare const pascalSnakeCase: <T extends string = string>(value?: T, options?: CaseOptions) => PascalSnakeCase<T>;
 export { pascalSnakeCase as default };

package/dist/case/pascal-snake-case.js

@@ -1,28 +1 @@
-import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
-import noCase from './no-case.js';
-import upperFirst from './upper-first.js';
-import { g as generateCacheKey } from '../packem_shared/generate-cache-key-DdayDfjV.js';
-
-const defaultCacheStore = new LRUCache(1e3);
-const pascalSnakeCase = (value, options) => {
-  if (typeof value !== "string") {
-    return "";
-  }
-  const shouldCache = options?.cache ?? false;
-  const cacheStore = options?.cacheStore ?? defaultCacheStore;
-  let cacheKey;
-  if (shouldCache) {
-    cacheKey = generateCacheKey(value, options);
-  }
-  if (shouldCache && cacheKey && cacheStore.has(cacheKey)) {
-    return cacheStore.get(cacheKey);
-  }
-  const words = noCase(value, { ...options, cache: false }).split(" ");
-  const result = words.map((word) => upperFirst(word, { locale: options?.locale })).join("_");
-  if (shouldCache && cacheKey) {
-    cacheStore.set(cacheKey, result);
-  }
-  return result;
-};
-
-export { pascalSnakeCase as default };
+import{i as n}from"../packem_shared/lru-cache-BtMSrYQJ.js";import l from"./no-case.js";import m from"./upper-first.js";import{n as p}from"../packem_shared/generate-cache-key-BqU1Cqwm.js";const s=new n(1e3),d=(r,t)=>{if(typeof r!="string")return"";const o=t?.cache??!1,c=t?.cacheStore??s;let e;if(o&&(e=p(r,t)),o&&e&&c.has(e))return c.get(e);const f=l(r,{...t,cache:!1}).split(" ").map(i=>m(i,{locale:t?.locale})).join("_");return o&&e&&c.set(e,f),f};export{d as default};

package/dist/case/path-case.d.ts

@@ -1,5 +1,16 @@
-import { C as CaseOptions, g as PathCase } from "../packem_shared/types.d-DfgbcNKh.js";
-import "../packem_shared/types.d-BVNv675q.js";
-import "../packem_shared/lru-cache.d-BsP6kbVJ.js";
+import { b as CaseOptions, g as PathCase } from "../packem_shared/types.d-fhe030jX.js";
+import "../packem_shared/types.d-CmNvyl4l.js";
+/**
+* Converts a string to path/case.
+* @example
+* ```typescript
+* pathCase("foo bar") // => "foo/bar"
+* pathCase("foo-bar") // => "foo/bar"
+* pathCase("foo_bar") // => "foo/bar"
+* pathCase("XMLHttpRequest") // => "xml/http/request"
+* pathCase("AJAXRequest") // => "ajax/request"
+* pathCase("QueryXML123String") // => "query/xml/123/string"
+* ```
+*/
 declare const pathCase: <T extends string = string>(value?: T, options?: CaseOptions) => PathCase<T>;
 export { pathCase as default };

package/dist/case/path-case.js

@@ -1,7 +1 @@
-import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
-import { kebabCase } from './kebab-case.js';
-
-const defaultCacheStore = new LRUCache(1e3);
-const pathCase = (value, options) => kebabCase(value, { cacheStore: defaultCacheStore, ...options, joiner: "/" });
-
-export { pathCase as default };
+import{i as r}from"../packem_shared/lru-cache-BtMSrYQJ.js";import{kebabCase as t}from"./kebab-case.js";const a=new r(1e3),c=(e,o)=>t(e,{cacheStore:a,...o,joiner:"/"});export{c as default};

package/dist/case/sentence-case.d.ts

@@ -1,5 +1,16 @@
-import { C as CaseOptions, S as SentenceCase } from "../packem_shared/types.d-DfgbcNKh.js";
-import "../packem_shared/types.d-BVNv675q.js";
-import "../packem_shared/lru-cache.d-BsP6kbVJ.js";
+import { b as CaseOptions, S as SentenceCase } from "../packem_shared/types.d-fhe030jX.js";
+import "../packem_shared/types.d-CmNvyl4l.js";
+/**
+* Converts a string to Sentence case.
+* @example
+* ```typescript
+* sentenceCase("foo bar") // => "Foo bar"
+* sentenceCase("foo-bar") // => "Foo bar"
+* sentenceCase("foo_bar") // => "Foo bar"
+* sentenceCase("XMLHttpRequest") // => "Xml http request"
+* sentenceCase("AJAXRequest") // => "Ajax request"
+* sentenceCase("QueryXML123String") // => "Query xml 123 string"
+* ```
+*/
 declare const sentenceCase: <T extends string = string>(value?: T, options?: CaseOptions) => SentenceCase<T>;
 export { sentenceCase as default };

package/dist/case/sentence-case.js

@@ -1,54 +1 @@
-import { R as RE_FAST_ANSI } from '../packem_shared/constants-BsZS5f0z.js';
-import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
-import { splitByCase } from './split-by-case.js';
-import upperFirst from './upper-first.js';
-import { g as generateCacheKey } from '../packem_shared/generate-cache-key-DdayDfjV.js';
-import joinSegments from '../packem_shared/joinSegments-CvxSgKz0.js';
-import { n as normalizeGermanEszett } from '../packem_shared/normalize-german-eszett-4p3yKEzn.js';
-
-const defaultCacheStore = new LRUCache(1e3);
-const sentenceCase = (value, options) => {
-  if (typeof value !== "string") {
-    return "";
-  }
-  const shouldCache = options?.cache ?? false;
-  const cacheStore = options?.cacheStore ?? defaultCacheStore;
-  let cacheKey;
-  if (shouldCache) {
-    cacheKey = generateCacheKey(value, options);
-  }
-  if (shouldCache && cacheKey && cacheStore.has(cacheKey)) {
-    return cacheStore.get(cacheKey);
-  }
-  let firstWord = true;
-  const result = joinSegments(
-    splitByCase(value, {
-      handleAnsi: options?.handleAnsi,
-      handleEmoji: options?.handleEmoji,
-      knownAcronyms: options?.knownAcronyms,
-      locale: options?.locale,
-      normalize: options?.normalize,
-      separators: void 0,
-      stripAnsi: options?.stripAnsi,
-      stripEmoji: options?.stripEmoji
-    }).map((word) => {
-      if (options?.handleAnsi && RE_FAST_ANSI.test(word)) {
-        return word;
-      }
-      const normalized = options?.locale?.startsWith("de") ? normalizeGermanEszett(word) : word;
-      const lowered = options?.locale ? normalized.toLocaleLowerCase(options.locale) : normalized.toLowerCase();
-      if (firstWord) {
-        firstWord = false;
-        return upperFirst(lowered, options);
-      }
-      return lowered;
-    }),
-    " "
-  );
-  if (shouldCache && cacheKey) {
-    cacheStore.set(cacheKey, result);
-  }
-  return result;
-};
-
-export { sentenceCase as default };
+import{c}from"../packem_shared/constants-aPzGW29R.js";import{i as p}from"../packem_shared/lru-cache-BtMSrYQJ.js";import{splitByCase as f}from"./split-by-case.js";import h from"./upper-first.js";import{n as A}from"../packem_shared/generate-cache-key-BqU1Cqwm.js";import d from"../packem_shared/joinSegments-CaHT-45s.js";import{a as u}from"../packem_shared/normalize-german-eszett-hNMwtGjd.js";const w=new p(1e3),k=(s,o)=>{if(typeof s!="string")return"";const i=o?.cache??!1,a=o?.cacheStore??w;let r;if(i&&(r=A(s,o)),i&&r&&a.has(r))return a.get(r);let n=!0;const e=d(f(s,{handleAnsi:o?.handleAnsi,handleEmoji:o?.handleEmoji,knownAcronyms:o?.knownAcronyms,locale:o?.locale,normalize:o?.normalize,separators:void 0,stripAnsi:o?.stripAnsi,stripEmoji:o?.stripEmoji}).map(t=>{if(o?.handleAnsi&&c.test(t))return t;const l=o?.locale?.startsWith("de")?u(t):t,m=o?.locale?l.toLocaleLowerCase(o.locale):l.toLowerCase();return n?(n=!1,h(m,o)):m})," ");return i&&r&&a.set(r,e),e};export{k as default};

package/dist/case/snake-case.d.ts

@@ -1,5 +1,16 @@
-import { C as CaseOptions, h as SnakeCase } from "../packem_shared/types.d-DfgbcNKh.js";
-import "../packem_shared/types.d-BVNv675q.js";
-import "../packem_shared/lru-cache.d-BsP6kbVJ.js";
+import { b as CaseOptions, h as SnakeCase } from "../packem_shared/types.d-fhe030jX.js";
+import "../packem_shared/types.d-CmNvyl4l.js";
+/**
+* Converts a string to snake_case.
+* @example
+* ```typescript
+* snakeCase("fooBar") // => "foo_bar"
+* snakeCase("foo bar") // => "foo_bar"
+* snakeCase("foo-bar") // => "foo_bar"
+* snakeCase("XMLHttpRequest") // => "xml_http_request"
+* snakeCase("AJAXRequest") // => "ajax_request"
+* snakeCase("QueryXML123String") // => "query_xml_123_string"
+* ```
+*/
 declare const snakeCase: <T extends string = string>(value?: T, options?: CaseOptions) => SnakeCase<T>;
 export { snakeCase as default };

package/dist/case/snake-case.js

@@ -1,7 +1 @@
-import LRUCache from '../packem_shared/LRUCache-3r3SovvR.js';
-import { kebabCase } from './kebab-case.js';
-
-const defaultCacheStore = new LRUCache(1e3);
-const snakeCase = (value, options) => kebabCase(value, { cacheStore: defaultCacheStore, ...options, joiner: "_" });
-
-export { snakeCase as default };
+import{i as r}from"../packem_shared/lru-cache-BtMSrYQJ.js";import{kebabCase as t}from"./kebab-case.js";const a=new r(1e3),n=(e,o)=>t(e,{cacheStore:a,...o,joiner:"_"});export{n as default};

package/dist/case/split-by-case.d.ts

@@ -1,14 +1,40 @@
-import { L as LocaleOptions, i as SplitByCase } from "../packem_shared/types.d-DfgbcNKh.js";
-import "../packem_shared/types.d-BVNv675q.js";
-import "../packem_shared/lru-cache.d-BsP6kbVJ.js";
+import { L as LocaleOptions, i as SplitByCase } from "../packem_shared/types.d-fhe030jX.js";
+import "../packem_shared/types.d-CmNvyl4l.js";
+/** Options for the `splitByCase` function. */
 interface SplitOptions extends LocaleOptions {
+  /** Whether to handle ANSI escape sequences. (default: false) */
   handleAnsi?: boolean;
+  /** Whether to handle emoji sequences. (default: false) */
   handleEmoji?: boolean;
+  /** A list of known acronyms to preserve casing for. */
   knownAcronyms?: ReadonlyArray<string>;
+  /** Whether to normalize case (convert all‑upper tokens not in knownAcronyms to title case). */
   normalize?: boolean;
+  /** List of additional separators to split on. */
   separators?: ReadonlyArray<string> | RegExp;
+  /** Whether to strip ANSI escape sequences. (default: false) */
   stripAnsi?: boolean;
+  /** Whether to strip emoji sequences. (default: false) */
   stripEmoji?: boolean;
 }
+/**
+* Splits a string into segments based on various criteria including case changes,
+* separators, Unicode scripts, ANSI codes, and emojis.
+*
+* This is the core splitting logic used by various case conversion functions.
+* @template T - The specific literal type of the input string, if known.
+* @param input The string to split.
+* @param options Configuration options for splitting behavior.
+* @returns An array of string segments.
+* @example
+* ```typescript
+* splitByCase("fooBarBaz") // => ["foo", "Bar", "Baz"]
+* splitByCase("foo_bar-baz") // => ["foo", "bar", "baz"]
+* splitByCase("HTMLElement") // => ["HTML", "Element"]
+* splitByCase("HTMLElement", { knownAcronyms: ["HTML"] }) // => ["HTML", "Element"]
+* splitByCase("\u001B[31mhello\u001B[0mWorld", { handleAnsi: true }) // => ["\u001B[31m", "hello", "\u001B[0m", "World"]
+* splitByCase("hello🌍world", { handleEmoji: true }) // => ["hello", "🌍", "world"]
+* ```
+*/
 declare const splitByCase: <T extends string = string>(input: T, options?: SplitOptions) => SplitByCase<T>;
 export { SplitOptions, splitByCase };