@bitbeater/ecma-utils 2.7.0 → 2.9.0

package/README.md

@@ -1,6 +1,6 @@
 # ecma-utils
 
-[See Documentation](https://bitbeater.github.io/)
+[See Documentation](https://bitbeater.github.io/ecma-utils/)
 
 Simple, lightweight, dependenciesless, TypeScript generic helper library.
 

package/dist/collection/CircularArray.d.ts

@@ -2,7 +2,7 @@
  * A circular array implementation that allows for wrapping around the ends.
  * @example
  * ```ts
- * import { collection } from 'iggs-utils';
+ * import { collection } from '@bitbeater/ecma-utils';
  *
  * const circularArray = new collection.CircularArray<string>(monday, tuesday, wednesday, thursday, friday, saturday, sunday);
  *

package/dist/collection/CircularArray.js

@@ -5,7 +5,7 @@ exports.CircularArray = void 0;
  * A circular array implementation that allows for wrapping around the ends.
  * @example
  * ```ts
- * import { collection } from 'iggs-utils';
+ * import { collection } from '@bitbeater/ecma-utils';
  *
  * const circularArray = new collection.CircularArray<string>(monday, tuesday, wednesday, thursday, friday, saturday, sunday);
  *

package/dist/strings.d.ts

@@ -12,5 +12,63 @@ export declare function isJson(str: string): boolean;
  * @returns
  */
 export declare function templateToString(template: TemplateStringsArray, ...expressions: TemplateExpression[]): string;
+type SplitTuple = [delimiterRun: string, token: string];
+/**
+ * Separates text into an array of [whitespace, word] tuples, preserving the whitespace.
+ * @example
+ * ```ts
+ * spacedWords('\t Hello \n world ')`
+ * // Returns:
+ * // [
+ * //   ['\t ', 'Hello'],
+ * //   [' \n ', 'world'],
+ * //   [' ', '']
+ * // ]
+ * ```
+ * @param text
+ * @returns [[whitespace, word], ...]
+ */
+export declare function spacedWords(text: string): SplitTuple[];
+/**
+ * Splits a string into pairs of `[delimiterRun, token]`, preserving contiguous
+ * delimiter runs.
+ *
+ * @param {string} text - The input string to split.
+ * @param {(char: string, index: number, text: string) => boolean} isDelimiter
+ *   Predicate to determine whether a character is a delimiter.
+ * @returns {[string, string][]} Array of tuples: `[delimiterRun, token]`.
+ *
+ * @example
+ * ```ts
+ * // Split on spaces and punctuation
+ * const isDelim = (ch) => ch === ' ' || ch === '-' || ch === '!';
+ *
+ * splitRuns('hello world', isDelim);
+ * [
+ *    ["", "hello"],
+ *    [" ", "world"],
+ * ]
+ *
+ * splitRuns('hello world!', isDelim);
+ * [
+ *    ["", "hello"],
+ *    [" ", "world"],
+ *    ["!", ""]
+ * ]
+ *
+ * splitRuns('- hello world!', isDelim);
+ * [
+ *    ["- ", "hello"],
+ *    [" ", "world"],
+ *    ["!", ""]
+ * ]
+ * ```
+ * */
+export declare function splitRuns(text: string, isDelimiter: (char: string, index?: number, text?: string) => boolean): SplitTuple[];
+export declare function isUpperCase(str: string): boolean;
+export declare const isWhitespace: (char: string) => boolean;
+export declare function isPunctuation(char: string): boolean;
+export declare function isNumber(char: string): boolean;
 export type TemplateExpression = string | number | Array<string | number>;
+export {};
 //# sourceMappingURL=strings.d.ts.map

package/dist/strings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAO3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,GAAG,WAAW,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAS7G;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC"}
+{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":"AAAA,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAO3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,GAAG,WAAW,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAS7G;AAED,KAAK,UAAU,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAExD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAEtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkCK;AAEL,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO,GAAG,UAAU,EAAE,CAgC3H;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,OAE3C,CAAC;AAEF,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE9C;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC"}

package/dist/strings.js

@@ -1,7 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWhitespace = void 0;
 exports.isJson = isJson;
 exports.templateToString = templateToString;
+exports.spacedWords = spacedWords;
+exports.splitRuns = splitRuns;
+exports.isUpperCase = isUpperCase;
+exports.isPunctuation = isPunctuation;
+exports.isNumber = isNumber;
 function isJson(str) {
     try {
         JSON.parse(str);
@@ -31,4 +37,99 @@ function templateToString(template, ...expressions) {
     }
     return merged.join('');
 }
+/**
+ * Separates text into an array of [whitespace, word] tuples, preserving the whitespace.
+ * @example
+ * ```ts
+ * spacedWords('\t Hello \n world ')`
+ * // Returns:
+ * // [
+ * //   ['\t ', 'Hello'],
+ * //   [' \n ', 'world'],
+ * //   [' ', '']
+ * // ]
+ * ```
+ * @param text
+ * @returns [[whitespace, word], ...]
+ */
+function spacedWords(text) {
+    return splitRuns(text, exports.isWhitespace);
+}
+/**
+ * Splits a string into pairs of `[delimiterRun, token]`, preserving contiguous
+ * delimiter runs.
+ *
+ * @param {string} text - The input string to split.
+ * @param {(char: string, index: number, text: string) => boolean} isDelimiter
+ *   Predicate to determine whether a character is a delimiter.
+ * @returns {[string, string][]} Array of tuples: `[delimiterRun, token]`.
+ *
+ * @example
+ * ```ts
+ * // Split on spaces and punctuation
+ * const isDelim = (ch) => ch === ' ' || ch === '-' || ch === '!';
+ *
+ * splitRuns('hello world', isDelim);
+ * [
+ *    ["", "hello"],
+ *    [" ", "world"],
+ * ]
+ *
+ * splitRuns('hello world!', isDelim);
+ * [
+ *    ["", "hello"],
+ *    [" ", "world"],
+ *    ["!", ""]
+ * ]
+ *
+ * splitRuns('- hello world!', isDelim);
+ * [
+ *    ["- ", "hello"],
+ *    [" ", "world"],
+ *    ["!", ""]
+ * ]
+ * ```
+ * */
+function splitRuns(text, isDelimiter) {
+    const result = [];
+    if (!text)
+        return result;
+    let inDelimiter = null;
+    const delimiterBuf = [];
+    const wordBuf = [];
+    const flush = () => {
+        result.push([delimiterBuf.join(''), wordBuf.join('')]);
+        delimiterBuf.length = 0;
+        wordBuf.length = 0;
+    };
+    for (let i = 0; i < text.length; i++) {
+        const ch = text[i];
+        if (isDelimiter(ch, i, text)) {
+            // entering a delimiter run after a word => flush the word+match pair
+            if (inDelimiter === false)
+                flush();
+            delimiterBuf.push(ch);
+            inDelimiter = true;
+            continue;
+        }
+        wordBuf.push(ch);
+        inDelimiter = false;
+    }
+    // flush trailing tuple (captures trailing delimiter run or last word)
+    flush();
+    return result;
+}
+function isUpperCase(str) {
+    return str === str.toUpperCase();
+}
+const isWhitespace = (char) => {
+    return /\s/.test(char);
+};
+exports.isWhitespace = isWhitespace;
+function isPunctuation(char) {
+    return /[.,\/#!$%\^&\*;:{}=\-_`~()]/.test(char);
+}
+function isNumber(char) {
+    return /[0-9]/.test(char);
+}
 //# sourceMappingURL=strings.js.map

package/dist/strings.js.map

@@ -1 +1 @@
-{"version":3,"file":"strings.js","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":";;AAAA,wBAOC;AAcD,4CASC;AA9BD,SAAgB,MAAM,CAAC,GAAW;IACjC,IAAI,CAAC;QACJ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAAC,QAA8B,EAAE,GAAG,WAAiC;IACpG,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxB,CAAC"}
+{"version":3,"file":"strings.js","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":";;;AAAA,wBAOC;AAcD,4CASC;AAmBD,kCAEC;AAsCD,8BAgCC;AAED,kCAEC;AAMD,sCAEC;AAED,4BAEC;AAzID,SAAgB,MAAM,CAAC,GAAW;IACjC,IAAI,CAAC;QACJ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAAC,QAA8B,EAAE,GAAG,WAAiC;IACpG,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxB,CAAC;AAID;;;;;;;;;;;;;;GAcG;AACH,SAAgB,WAAW,CAAC,IAAY;IACvC,OAAO,SAAS,CAAC,IAAI,EAAE,oBAAY,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkCK;AAEL,SAAgB,SAAS,CAAC,IAAY,EAAE,WAAqE;IAC5G,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,IAAI,CAAC,IAAI;QAAE,OAAO,MAAM,CAAC;IAEzB,IAAI,WAAW,GAAmB,IAAI,CAAC;IACvC,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,KAAK,GAAG,GAAG,EAAE;QAClB,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACvD,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;QACxB,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACpB,CAAC,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,IAAI,WAAW,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;YAC9B,qEAAqE;YACrE,IAAI,WAAW,KAAK,KAAK;gBAAE,KAAK,EAAE,CAAC;YAEnC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtB,WAAW,GAAG,IAAI,CAAC;YACnB,SAAS;QACV,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,WAAW,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,sEAAsE;IACtE,KAAK,EAAE,CAAC;IACR,OAAO,MAAM,CAAC;AACf,CAAC;AAED,SAAgB,WAAW,CAAC,GAAW;IACtC,OAAO,GAAG,KAAK,GAAG,CAAC,WAAW,EAAE,CAAC;AAClC,CAAC;AAEM,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE;IACrD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB;AAEF,SAAgB,aAAa,CAAC,IAAY;IACzC,OAAO,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED,SAAgB,QAAQ,CAAC,IAAY;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC"}

package/dist/time/timer.d.ts

@@ -3,7 +3,7 @@ import { Duration } from './time';
  * A simple timer that can be started, paused, and resumed.
  * @example
  * ```js
- * import { Timer } from 'iggs-utils/time/timer';
+ * import { Timer } from '@bitbeater/ecma-utils/time/timer';
  *
  * const timer = new Timer(5000, (totalDuration) => {
  *     console.log(`Timer completed in ${totalDuration} ms`);

package/dist/time/timer.js

@@ -18,7 +18,7 @@ const time_1 = require("./time");
  * A simple timer that can be started, paused, and resumed.
  * @example
  * ```js
- * import { Timer } from 'iggs-utils/time/timer';
+ * import { Timer } from '@bitbeater/ecma-utils/time/timer';
  *
  * const timer = new Timer(5000, (totalDuration) => {
  *     console.log(`Timer completed in ${totalDuration} ms`);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bitbeater/ecma-utils",
-	"version": "2.7.0",
+	"version": "2.9.0",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"sideEffects": false,