xypriss 9.12.18 → 9.12.19

package/dist/cjs/src/xhsc/UtilsApi.js

@@ -70,9 +70,42 @@ var LoggerUtils = require('./utils/LoggerUtils.js');
  */
 class UtilsApi {
     constructor() {
-        /** **String Utilities** (`slugify`, `truncate`, `randomString`, etc.) */
+        /**
+         * **StringUtils — XyPriss String Utilities**
+         *
+         * A collection of dependency-free helpers for everyday string manipulation:
+         * case conversion (`camelCase`, `kebab-case`, `snake_case`, `Title Case`),
+         * sanitization (HTML escaping/stripping, accent stripping, whitespace
+         * normalization), validation (emails, URLs, palindromes), extraction
+         * (emails, URLs, substrings between markers), masking of sensitive data,
+         * fuzzy comparison (Levenshtein distance, similarity score), text layout
+         * (word wrap, chunking), and generation (random strings, UUIDs).
+         *
+         * All methods are pure functions with no side effects and no external
+         * dependencies — instantiate once and reuse across your application.
+         *
+         * @remarks
+         * The public API surface of this class is conventionally exposed as `str.**`
+         * (e.g. `str.slugify(...)`, `str.toCamelCase(...)`) in XyPriss.
+         *
+         * @example
+         * ```ts
+         * import { StringUtils } from "xypriss";
+         *
+         * const str = new StringUtils();
+         *
+         * str.slugify("Hello World!");       // "hello-world"
+         * str.toCamelCase("hello-world");    // "helloWorld"
+         * str.truncate("A very long text", 10); // "A very ..."
+         * str.mask("4111111111111111", { visibleStart: 4, visibleEnd: 4 }); // "4111********1111"
+         * ```
+         * @see https://xypriss.nehonix.com/docs/system/utils/strings
+         *
+         */
         this.str = new StringUtils.StringUtils();
-        /** **Number & Math Utilities** (`clamp`, `lerp`, `formatBytes`, etc.) */
+        /** **Number & Math Utilities** (`clamp`, `lerp`, `formatBytes`, etc.)
+         * @see https://xypriss.nehonix.com/docs/system/utils/numbers
+         */
         this.num = new NumberUtils.NumberUtils();
         /**
          * @file DateUtils.ts
@@ -95,6 +128,7 @@ class UtilsApi {
          * du.formatDuration(3_661_000);    // "1h 1m 1s"
          * du.startOf("month");             // 2026-04-01T00:00:00.000Z
          * ```
+         * @see https://xypriss.nehonix.com/docs/system/utils/dates
          */
         this.date = new DateUtils.DateUtils();
         /**
@@ -123,17 +157,28 @@ class UtilsApi {
          *   .pick(["a", "b"])
          *   .value(); // { a: 1, b: 2 }
          * ```
+         * @see https://xypriss.nehonix.com/docs/system/utils/data#object-utilities
          */
         this.obj = new ObjectUtils.ObjectUtils();
-        /** **Array Utilities** (`chunk`, `unique`, `groupBy`, etc.) */
+        /** **Array Utilities** (`chunk`, `unique`, `groupBy`, etc.)
+         * @see https://xypriss.nehonix.com/docs/system/utils/data#array-utilities
+         */
         this.arr = new ArrayUtils.ArrayUtils();
-        /** **Async & Control Flow Utilities** (`sleep`, `retry`, `debounce`, etc.) */
+        /** **Async & Control Flow Utilities** (`sleep`, `retry`, `debounce`, etc.)
+         * @see https://xypriss.nehonix.com/docs/system/utils/logic#async-utilities
+         */
         this.async = new AsyncUtils.AsyncUtils();
-        /** **Validation Utilities** (`email`, `url`, `nullish`) */
+        /** **Validation Utilities** (`email`, `url`, `nullish`)
+         * @see https://xypriss.nehonix.com/docs/system/utils/logic#validation-utilities
+         */
         this.is = new ValidationUtils.ValidationUtils();
-        /** **Identity Utilities** (`uuid`) */
+        /** **Identity Utilities** (`uuid`)
+         * @see https://xypriss.nehonix.com/docs/system/utils/primitives#identity-utilities
+         */
         this.id = new IdUtils.IdUtils();
-        /** **Functional Utilities** (`memo`) */
+        /** **Functional Utilities** (`memo`)
+         * @see https://xypriss.nehonix.com/docs/system/utils/primitives#functional-utilities
+         */
         this.fn = new FunctionUtils.FunctionUtils();
         /**
          * **Logger Utilities** — Structured, colorful console logger.
@@ -147,6 +192,7 @@ class UtilsApi {
          * __sys__.utils.log.warn("Low memory", { freeKb: 128 });
          * __sys__.utils.log.error("Crash", new Error("OOM"));
          * ```
+         * @see https://xypriss.nehonix.com/docs/system/utils/logger
          */
         this.log = new LoggerUtils.LoggerUtils();
     }
@@ -164,6 +210,7 @@ class UtilsApi {
      * // Plain mode — no ANSI colors (great for log files / CI)
      * const ciLog = __sys__.utils.createLogger({ namespace: "CI", plain: true });
      * ```
+     * @see https://xypriss.nehonix.com/docs/system/utils/logger#scoped-loggers
      */
     createLogger(opts = {}) {
         return new LoggerUtils.LoggerUtils(opts);

package/dist/cjs/src/xhsc/UtilsApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"UtilsApi.js","sources":["../../../../src/xhsc/UtilsApi.ts"],"sourcesContent":[null],"names":["StringUtils","NumberUtils","DateUtils","ObjectUtils","ArrayUtils","AsyncUtils","ValidationUtils","IdUtils","FunctionUtils","LoggerUtils"],"mappings":";;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;AAsBiF;AACjF;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCG;MACU,QAAQ,CAAA;AAArB,IAAA,WAAA,GAAA;;AAEoB,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIA,uBAAW,EAAE;;AAGvB,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,uBAAW,EAAE;AAEvC;;;;;;;;;;;;;;;;;;;;;AAqBG;AACa,QAAA,IAAA,CAAA,IAAI,GAAG,IAAIC,mBAAS,EAAE;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,uBAAW,EAAE;;AAGvB,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,qBAAU,EAAE;;AAGtB,QAAA,IAAA,CAAA,KAAK,GAAG,IAAIC,qBAAU,EAAE;;AAGxB,QAAA,IAAA,CAAA,EAAE,GAAG,IAAIC,+BAAe,EAAE;;AAG1B,QAAA,IAAA,CAAA,EAAE,GAAG,IAAIC,eAAO,EAAE;;AAGlB,QAAA,IAAA,CAAA,EAAE,GAAG,IAAIC,2BAAa,EAAE;AAExC;;;;;;;;;;;;AAYG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,uBAAW,EAAE;IAsB3C;AApBI;;;;;;;;;;;;;;AAcG;IACI,YAAY,CACf,OAAqD,EAAE,EAAA;AAEvD,QAAA,OAAO,IAAIA,uBAAW,CAAC,IAAI,CAAC;IAChC;AACH;;;;"}
+{"version":3,"file":"UtilsApi.js","sources":["../../../../src/xhsc/UtilsApi.ts"],"sourcesContent":[null],"names":["StringUtils","NumberUtils","DateUtils","ObjectUtils","ArrayUtils","AsyncUtils","ValidationUtils","IdUtils","FunctionUtils","LoggerUtils"],"mappings":";;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;AAsBiF;AACjF;AAaA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCG;MACU,QAAQ,CAAA;AAArB,IAAA,WAAA,GAAA;AACI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIA,uBAAW,EAAE;AAEvC;;AAEG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,uBAAW,EAAE;AAEvC;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACa,QAAA,IAAA,CAAA,IAAI,GAAG,IAAIC,mBAAS,EAAE;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,uBAAW,EAAE;AAEvC;;AAEG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,qBAAU,EAAE;AAEtC;;AAEG;AACa,QAAA,IAAA,CAAA,KAAK,GAAG,IAAIC,qBAAU,EAAE;AAExC;;AAEG;AACa,QAAA,IAAA,CAAA,EAAE,GAAG,IAAIC,+BAAe,EAAE;AAE1C;;AAEG;AACa,QAAA,IAAA,CAAA,EAAE,GAAG,IAAIC,eAAO,EAAE;AAElC;;AAEG;AACa,QAAA,IAAA,CAAA,EAAE,GAAG,IAAIC,2BAAa,EAAE;AAExC;;;;;;;;;;;;;AAaG;AACa,QAAA,IAAA,CAAA,GAAG,GAAG,IAAIC,uBAAW,EAAE;IAuB3C;AArBI;;;;;;;;;;;;;;;AAeG;IACI,YAAY,CACf,OAAqD,EAAE,EAAA;AAEvD,QAAA,OAAO,IAAIA,uBAAW,CAAC,IAAI,CAAC;IAChC;AACH;;;;"}