@scalar/helpers 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/helpers
 
+## 0.1.1
+
+### Patch Changes
+
+- [#7289](https://github.com/scalar/scalar/pull/7289) [`9c9dbba`](https://github.com/scalar/scalar/commit/9c9dbbaa940667303f0ace59469fd78c2a741937) Thanks [@amritk](https://github.com/amritk)! - feat: move debounce to helpers and add max wait
+
+- [#7252](https://github.com/scalar/scalar/pull/7252) [`4bec1ba`](https://github.com/scalar/scalar/commit/4bec1ba332e919c4ee32dcfbfb07bd8ee42c4d74) Thanks [@hwkr](https://github.com/hwkr)! - fix(api-reference): improve wrapping of long strings
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/general/debounce.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Options for configuring the debounce behavior.
+ */
+export type DebounceOptions = {
+    /** The delay in milliseconds before executing the function. Defaults to 100ms. */
+    delay?: number;
+    /** Maximum time in milliseconds to wait before forcing execution, even with continuous calls. */
+    maxWait?: number;
+};
+/**
+ * Creates a debounced function executor that delays execution until after a specified time.
+ * Multiple calls with the same key will cancel previous pending executions.
+ *
+ * This is useful for batching rapid updates (like auto-save or API calls) to avoid
+ * unnecessary processing or network requests.
+ *
+ * @param options - Configuration options for delay, maxWait, and key separator
+ * @returns A function that accepts a key array and callback to execute
+ *
+ * @example
+ * const debouncedSave = debounce({ delay: 328 })
+ * debouncedSave.execute(['user', '123'], () => saveUser(user))
+ *
+ * @example
+ * // With maxWait to guarantee execution even with continuous calls
+ * const debouncedSave = debounce({ delay: 328, maxWait: 2000 })
+ * debouncedSave.execute(['user', '123'], () => saveUser(user))
+ */
+export declare const debounce: (options?: DebounceOptions) => {
+    execute: (key: string, fn: () => unknown | Promise<unknown>) => void;
+    cleanup: () => void;
+};
+//# sourceMappingURL=debounce.d.ts.map

package/dist/general/debounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../src/general/debounce.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,kFAAkF;IAClF,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,GAAI,UAAS,eAAoB;mBA6C9B,MAAM,MAAM,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAG,IAAI;mBAvCrD,IAAI;CAiEzB,CAAA"}

package/dist/general/debounce.js

@@ -0,0 +1,55 @@
+const debounce = (options = {}) => {
+  const { delay = 328, maxWait } = options;
+  const timeouts = /* @__PURE__ */ new Map();
+  const maxWaitTimeouts = /* @__PURE__ */ new Map();
+  const latestFunctions = /* @__PURE__ */ new Map();
+  const cleanup = () => {
+    timeouts.forEach(clearTimeout);
+    maxWaitTimeouts.forEach(clearTimeout);
+    timeouts.clear();
+    maxWaitTimeouts.clear();
+    latestFunctions.clear();
+  };
+  const executeAndCleanup = (key) => {
+    const fn = latestFunctions.get(key);
+    const timeout = timeouts.get(key);
+    if (timeout !== void 0) {
+      clearTimeout(timeout);
+      timeouts.delete(key);
+    }
+    const maxWaitTimeout = maxWaitTimeouts.get(key);
+    if (maxWaitTimeout !== void 0) {
+      clearTimeout(maxWaitTimeout);
+      maxWaitTimeouts.delete(key);
+    }
+    latestFunctions.delete(key);
+    if (fn !== void 0) {
+      try {
+        fn();
+      } catch {
+      }
+    }
+  };
+  const execute = (key, fn) => {
+    latestFunctions.set(key, fn);
+    const existingTimeout = timeouts.get(key);
+    if (existingTimeout !== void 0) {
+      clearTimeout(existingTimeout);
+    }
+    timeouts.set(
+      key,
+      setTimeout(() => executeAndCleanup(key), delay)
+    );
+    if (maxWait !== void 0 && !maxWaitTimeouts.has(key)) {
+      maxWaitTimeouts.set(
+        key,
+        setTimeout(() => executeAndCleanup(key), maxWait)
+      );
+    }
+  };
+  return { execute, cleanup };
+};
+export {
+  debounce
+};
+//# sourceMappingURL=debounce.js.map

package/dist/general/debounce.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/general/debounce.ts"],
+  "sourcesContent": ["/**\n * Options for configuring the debounce behavior.\n */\nexport type DebounceOptions = {\n  /** The delay in milliseconds before executing the function. Defaults to 100ms. */\n  delay?: number\n  /** Maximum time in milliseconds to wait before forcing execution, even with continuous calls. */\n  maxWait?: number\n}\n\n/**\n * Creates a debounced function executor that delays execution until after a specified time.\n * Multiple calls with the same key will cancel previous pending executions.\n *\n * This is useful for batching rapid updates (like auto-save or API calls) to avoid\n * unnecessary processing or network requests.\n *\n * @param options - Configuration options for delay, maxWait, and key separator\n * @returns A function that accepts a key array and callback to execute\n *\n * @example\n * const debouncedSave = debounce({ delay: 328 })\n * debouncedSave.execute(['user', '123'], () => saveUser(user))\n *\n * @example\n * // With maxWait to guarantee execution even with continuous calls\n * const debouncedSave = debounce({ delay: 328, maxWait: 2000 })\n * debouncedSave.execute(['user', '123'], () => saveUser(user))\n */\nexport const debounce = (options: DebounceOptions = {}) => {\n  const { delay = 328, maxWait } = options\n  const timeouts = new Map<string, ReturnType<typeof setTimeout>>()\n  const maxWaitTimeouts = new Map<string, ReturnType<typeof setTimeout>>()\n  const latestFunctions = new Map<string, () => unknown | Promise<unknown>>()\n\n  const cleanup = (): void => {\n    timeouts.forEach(clearTimeout)\n    maxWaitTimeouts.forEach(clearTimeout)\n    timeouts.clear()\n    maxWaitTimeouts.clear()\n    latestFunctions.clear()\n  }\n\n  /** Executes the function and cleans up all associated timeouts */\n  const executeAndCleanup = (key: string): void => {\n    // Get the latest function for this key\n    const fn = latestFunctions.get(key)\n\n    // Clear both timeout types\n    const timeout = timeouts.get(key)\n    if (timeout !== undefined) {\n      clearTimeout(timeout)\n      timeouts.delete(key)\n    }\n\n    const maxWaitTimeout = maxWaitTimeouts.get(key)\n    if (maxWaitTimeout !== undefined) {\n      clearTimeout(maxWaitTimeout)\n      maxWaitTimeouts.delete(key)\n    }\n\n    // Clear the latest function reference\n    latestFunctions.delete(key)\n\n    // Execute the function if it exists\n    if (fn !== undefined) {\n      try {\n        fn()\n      } catch {\n        // Errors are silently caught to prevent the debounce mechanism from breaking\n      }\n    }\n  }\n\n  const execute = (key: string, fn: () => unknown | Promise<unknown>): void => {\n    // Store the latest function for this key\n    latestFunctions.set(key, fn)\n\n    // Clear existing debounce timeout\n    const existingTimeout = timeouts.get(key)\n    if (existingTimeout !== undefined) {\n      clearTimeout(existingTimeout)\n    }\n\n    // Set debounce timeout\n    timeouts.set(\n      key,\n      setTimeout(() => executeAndCleanup(key), delay),\n    )\n\n    // Set maxWait timeout only if configured and this is a new sequence\n    if (maxWait !== undefined && !maxWaitTimeouts.has(key)) {\n      maxWaitTimeouts.set(\n        key,\n        setTimeout(() => executeAndCleanup(key), maxWait),\n      )\n    }\n  }\n\n  return { execute, cleanup }\n}\n"],
+  "mappings": "AA6BO,MAAM,WAAW,CAAC,UAA2B,CAAC,MAAM;AACzD,QAAM,EAAE,QAAQ,KAAK,QAAQ,IAAI;AACjC,QAAM,WAAW,oBAAI,IAA2C;AAChE,QAAM,kBAAkB,oBAAI,IAA2C;AACvE,QAAM,kBAAkB,oBAAI,IAA8C;AAE1E,QAAM,UAAU,MAAY;AAC1B,aAAS,QAAQ,YAAY;AAC7B,oBAAgB,QAAQ,YAAY;AACpC,aAAS,MAAM;AACf,oBAAgB,MAAM;AACtB,oBAAgB,MAAM;AAAA,EACxB;AAGA,QAAM,oBAAoB,CAAC,QAAsB;AAE/C,UAAM,KAAK,gBAAgB,IAAI,GAAG;AAGlC,UAAM,UAAU,SAAS,IAAI,GAAG;AAChC,QAAI,YAAY,QAAW;AACzB,mBAAa,OAAO;AACpB,eAAS,OAAO,GAAG;AAAA,IACrB;AAEA,UAAM,iBAAiB,gBAAgB,IAAI,GAAG;AAC9C,QAAI,mBAAmB,QAAW;AAChC,mBAAa,cAAc;AAC3B,sBAAgB,OAAO,GAAG;AAAA,IAC5B;AAGA,oBAAgB,OAAO,GAAG;AAG1B,QAAI,OAAO,QAAW;AACpB,UAAI;AACF,WAAG;AAAA,MACL,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AAEA,QAAM,UAAU,CAAC,KAAa,OAA+C;AAE3E,oBAAgB,IAAI,KAAK,EAAE;AAG3B,UAAM,kBAAkB,SAAS,IAAI,GAAG;AACxC,QAAI,oBAAoB,QAAW;AACjC,mBAAa,eAAe;AAAA,IAC9B;AAGA,aAAS;AAAA,MACP;AAAA,MACA,WAAW,MAAM,kBAAkB,GAAG,GAAG,KAAK;AAAA,IAChD;AAGA,QAAI,YAAY,UAAa,CAAC,gBAAgB,IAAI,GAAG,GAAG;AACtD,sBAAgB;AAAA,QACd;AAAA,QACA,WAAW,MAAM,kBAAkB,GAAG,GAAG,OAAO;AAAA,MAClD;AAAA,IACF;AAAA,EACF;AAEA,SAAO,EAAE,SAAS,QAAQ;AAC5B;",
+  "names": []
+}

package/dist/regex/find-variables.d.ts

@@ -1,5 +1,12 @@
 /**
  * Find all strings wrapped in {} or {{}} in value.
+ *
+ * @param value - The string to find variables in
+ * @param includePath - Whether to include path variables {single}
+ * @param includeEnv - Whether to include environment variables {{double}}
  */
-export declare const findVariables: (value: string) => (string | undefined)[];
+export declare const findVariables: (value: string, { includePath, includeEnv }?: {
+    includePath?: boolean;
+    includeEnv?: boolean;
+}) => string[];
 //# sourceMappingURL=find-variables.d.ts.map

package/dist/regex/find-variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"find-variables.d.ts","sourceRoot":"","sources":["../../src/regex/find-variables.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,2BACiE,CAAA"}
+{"version":3,"file":"find-variables.d.ts","sourceRoot":"","sources":["../../src/regex/find-variables.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GACxB,OAAO,MAAM,EACb,8BAA2C;IAAE,WAAW,CAAC,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,OAAO,CAAA;CAAO,KAC9F,MAAM,EAON,CAAA"}

package/dist/regex/find-variables.js

@@ -1,5 +1,7 @@
 import { REGEX } from "./regex-helpers.js";
-const findVariables = (value) => [...value.matchAll(REGEX.PATH), ...value.matchAll(REGEX.VARIABLES)].map((match) => match[1]?.trim()) || [];
+const findVariables = (value, { includePath = true, includeEnv = true } = {}) => [includePath && REGEX.PATH, includeEnv && REGEX.VARIABLES].flatMap(
+  (regex) => regex ? [...value.matchAll(regex)].map((match) => match[1]?.trim()).filter((variable) => variable !== void 0) : []
+);
 export {
   findVariables
 };

package/dist/regex/find-variables.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/regex/find-variables.ts"],
-  "sourcesContent": ["import { REGEX } from './regex-helpers'\n\n/**\n * Find all strings wrapped in {} or {{}} in value.\n */\nexport const findVariables = (value: string) =>\n  [...value.matchAll(REGEX.PATH), ...value.matchAll(REGEX.VARIABLES)].map((match) => match[1]?.trim()) || []\n"],
-  "mappings": "AAAA,SAAS,aAAa;AAKf,MAAM,gBAAgB,CAAC,UAC5B,CAAC,GAAG,MAAM,SAAS,MAAM,IAAI,GAAG,GAAG,MAAM,SAAS,MAAM,SAAS,CAAC,EAAE,IAAI,CAAC,UAAU,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC;",
+  "sourcesContent": ["import { REGEX } from './regex-helpers'\n\n/**\n * Find all strings wrapped in {} or {{}} in value.\n *\n * @param value - The string to find variables in\n * @param includePath - Whether to include path variables {single}\n * @param includeEnv - Whether to include environment variables {{double}}\n */\nexport const findVariables = (\n  value: string,\n  { includePath = true, includeEnv = true }: { includePath?: boolean; includeEnv?: boolean } = {},\n): string[] =>\n  [includePath && REGEX.PATH, includeEnv && REGEX.VARIABLES].flatMap((regex) =>\n    regex\n      ? [...value.matchAll(regex)]\n          .map((match) => match[1]?.trim())\n          .filter((variable): variable is string => variable !== undefined)\n      : [],\n  )\n"],
+  "mappings": "AAAA,SAAS,aAAa;AASf,MAAM,gBAAgB,CAC3B,OACA,EAAE,cAAc,MAAM,aAAa,KAAK,IAAqD,CAAC,MAE9F,CAAC,eAAe,MAAM,MAAM,cAAc,MAAM,SAAS,EAAE;AAAA,EAAQ,CAAC,UAClE,QACI,CAAC,GAAG,MAAM,SAAS,KAAK,CAAC,EACtB,IAAI,CAAC,UAAU,MAAM,CAAC,GAAG,KAAK,CAAC,EAC/B,OAAO,CAAC,aAAiC,aAAa,MAAS,IAClE,CAAC;AACP;",
   "names": []
 }

package/dist/regex/regex-helpers.d.ts

@@ -1,12 +1,19 @@
+/**
+ * Collection of regular expressions used throughout the application.
+ * These patterns handle URL parsing, variable detection, and reference path extraction.
+ */
 export declare const REGEX: {
     /** Checks for a valid scheme */
     readonly PROTOCOL: RegExp;
     /** Finds multiple slashes after the scheme to replace with a single slash */
     readonly MULTIPLE_SLASHES: RegExp;
+    /** Finds all variables wrapped in {{double}} */
     readonly VARIABLES: RegExp;
+    /** Finds all variables wrapped in {single} */
     readonly PATH: RegExp;
     /** Finds the name of the schema from the ref path */
     readonly REF_NAME: RegExp;
+    /** Finds template variables in multiple formats: {{var}}, {var}, or :var */
     readonly TEMPLATE_VARIABLE: RegExp;
 };
 //# sourceMappingURL=regex-helpers.d.ts.map

package/dist/regex/regex-helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"regex-helpers.d.ts","sourceRoot":"","sources":["../../src/regex/regex-helpers.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK;IAChB,gCAAgC;;IAEhC,6EAA6E;;;;IAI7E,qDAAqD;;;CAG7C,CAAA"}
+{"version":3,"file":"regex-helpers.d.ts","sourceRoot":"","sources":["../../src/regex/regex-helpers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,KAAK;IAChB,gCAAgC;;IAEhC,6EAA6E;;IAE7E,gDAAgD;;IAEhD,8CAA8C;;IAE9C,qDAAqD;;IAErD,4EAA4E;;CAEpE,CAAA"}

package/dist/regex/regex-helpers.js

@@ -3,10 +3,13 @@ const REGEX = {
   PROTOCOL: /^(?:https?|ftp|file|mailto|tel|data|wss?)*:\/\//,
   /** Finds multiple slashes after the scheme to replace with a single slash */
   MULTIPLE_SLASHES: /(?<!:)\/{2,}/g,
+  /** Finds all variables wrapped in {{double}} */
   VARIABLES: /{{((?:[^{}]|{[^{}]*})*)}}/g,
+  /** Finds all variables wrapped in {single} */
   PATH: /(?:{)([^{}]+)}(?!})/g,
   /** Finds the name of the schema from the ref path */
   REF_NAME: /\/([^\/]+)$/,
+  /** Finds template variables in multiple formats: {{var}}, {var}, or :var */
   TEMPLATE_VARIABLE: /{{\s*([^}\s]+?)\s*}}|{\s*([^}\s]+?)\s*}|:\b[\w.]+\b/g
 };
 export {

package/dist/regex/regex-helpers.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/regex/regex-helpers.ts"],
-  "sourcesContent": ["export const REGEX = {\n  /** Checks for a valid scheme */\n  PROTOCOL: /^(?:https?|ftp|file|mailto|tel|data|wss?)*:\\/\\//,\n  /** Finds multiple slashes after the scheme to replace with a single slash */\n  MULTIPLE_SLASHES: /(?<!:)\\/{2,}/g,\n  VARIABLES: /{{((?:[^{}]|{[^{}]*})*)}}/g,\n  PATH: /(?:{)([^{}]+)}(?!})/g,\n  /** Finds the name of the schema from the ref path */\n  REF_NAME: /\\/([^\\/]+)$/,\n  TEMPLATE_VARIABLE: /{{\\s*([^}\\s]+?)\\s*}}|{\\s*([^}\\s]+?)\\s*}|:\\b[\\w.]+\\b/g,\n} as const\n"],
-  "mappings": "AAAO,MAAM,QAAQ;AAAA;AAAA,EAEnB,UAAU;AAAA;AAAA,EAEV,kBAAkB;AAAA,EAClB,WAAW;AAAA,EACX,MAAM;AAAA;AAAA,EAEN,UAAU;AAAA,EACV,mBAAmB;AACrB;",
+  "sourcesContent": ["/**\n * Collection of regular expressions used throughout the application.\n * These patterns handle URL parsing, variable detection, and reference path extraction.\n */\nexport const REGEX = {\n  /** Checks for a valid scheme */\n  PROTOCOL: /^(?:https?|ftp|file|mailto|tel|data|wss?)*:\\/\\//,\n  /** Finds multiple slashes after the scheme to replace with a single slash */\n  MULTIPLE_SLASHES: /(?<!:)\\/{2,}/g,\n  /** Finds all variables wrapped in {{double}} */\n  VARIABLES: /{{((?:[^{}]|{[^{}]*})*)}}/g,\n  /** Finds all variables wrapped in {single} */\n  PATH: /(?:{)([^{}]+)}(?!})/g,\n  /** Finds the name of the schema from the ref path */\n  REF_NAME: /\\/([^\\/]+)$/,\n  /** Finds template variables in multiple formats: {{var}}, {var}, or :var */\n  TEMPLATE_VARIABLE: /{{\\s*([^}\\s]+?)\\s*}}|{\\s*([^}\\s]+?)\\s*}|:\\b[\\w.]+\\b/g,\n} as const\n"],
+  "mappings": "AAIO,MAAM,QAAQ;AAAA;AAAA,EAEnB,UAAU;AAAA;AAAA,EAEV,kBAAkB;AAAA;AAAA,EAElB,WAAW;AAAA;AAAA,EAEX,MAAM;AAAA;AAAA,EAEN,UAAU;AAAA;AAAA,EAEV,mBAAmB;AACrB;",
   "names": []
 }

package/dist/string/add-word-breaks.d.ts

@@ -0,0 +1,32 @@
+/**
+ * A list of preset styles for word breaks
+ */
+declare const PRESETS: {
+    /** Breaks on `/` and `-` for urls or file paths */
+    readonly path: RegExp;
+    /**
+     * Breaks on capitals, `_` and `.` for properties written in
+     * camel, pascal or snake case
+     */
+    readonly property: RegExp;
+};
+/** Word break options */
+type WordBreakOptions = {
+    /**
+     * Presets for word wrapping
+     */
+    preset?: keyof typeof PRESETS;
+    /**
+     * Explicit regex to allow wrapping on, overrides any `preset`
+     */
+    regex?: RegExp;
+};
+/**
+ * String utility to add word break opportunities
+ *
+ * Adds a zero-width space before certain characters to allow improved
+ * line wrapping in the. Allows wrapping on "/" and * "-" by default.
+ */
+export declare const addWordBreaks: (label: string, opts?: WordBreakOptions) => string;
+export {};
+//# sourceMappingURL=add-word-breaks.d.ts.map

package/dist/string/add-word-breaks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-word-breaks.d.ts","sourceRoot":"","sources":["../../src/string/add-word-breaks.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,QAAA,MAAM,OAAO;IACX,mDAAmD;;IAEnD;;;OAGG;;CAEsC,CAAA;AAE3C,yBAAyB;AACzB,KAAK,gBAAgB,GAAG;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,OAAO,OAAO,CAAA;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,EAAE,OAAM,gBAAqB,KAAG,MAI1E,CAAA"}

package/dist/string/add-word-breaks.js

@@ -0,0 +1,19 @@
+const ZWSP = "\u200B";
+const PRESETS = {
+  /** Breaks on `/` and `-` for urls or file paths */
+  "path": /[\/-]/,
+  /**
+   * Breaks on capitals, `_` and `.` for properties written in
+   * camel, pascal or snake case
+   */
+  "property": /[A-Z\_\.-]/
+};
+const addWordBreaks = (label, opts = {}) => {
+  const { preset = "path", regex } = opts;
+  const wrapRegex = new RegExp(regex ?? PRESETS[preset], "g");
+  return label.replace(wrapRegex, `${ZWSP}$&`);
+};
+export {
+  addWordBreaks
+};
+//# sourceMappingURL=add-word-breaks.js.map

package/dist/string/add-word-breaks.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/string/add-word-breaks.ts"],
+  "sourcesContent": ["/**\n * Unicode character for zero-width space\n *\n * @see https://en.wikipedia.org/wiki/Zero-width_space\n */\nconst ZWSP = '\\u200B'\n\n/**\n * A list of preset styles for word breaks\n */\nconst PRESETS = {\n  /** Breaks on `/` and `-` for urls or file paths */\n  'path': /[\\/-]/,\n  /**\n   * Breaks on capitals, `_` and `.` for properties written in\n   * camel, pascal or snake case\n   */\n  'property': /[A-Z\\_\\.-]/,\n} as const satisfies Record<string, RegExp>\n\n/** Word break options */\ntype WordBreakOptions = {\n  /**\n   * Presets for word wrapping\n   */\n  preset?: keyof typeof PRESETS\n  /**\n   * Explicit regex to allow wrapping on, overrides any `preset`\n   */\n  regex?: RegExp\n}\n\n/**\n * String utility to add word break opportunities\n *\n * Adds a zero-width space before certain characters to allow improved\n * line wrapping in the. Allows wrapping on \"/\" and * \"-\" by default.\n */\nexport const addWordBreaks = (label: string, opts: WordBreakOptions = {}): string => {\n  const { preset = 'path', regex } = opts\n  const wrapRegex = new RegExp(regex ?? PRESETS[preset], 'g')\n  return label.replace(wrapRegex, `${ZWSP}$&`)\n}\n"],
+  "mappings": "AAKA,MAAM,OAAO;AAKb,MAAM,UAAU;AAAA;AAAA,EAEd,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,YAAY;AACd;AAoBO,MAAM,gBAAgB,CAAC,OAAe,OAAyB,CAAC,MAAc;AACnF,QAAM,EAAE,SAAS,QAAQ,MAAM,IAAI;AACnC,QAAM,YAAY,IAAI,OAAO,SAAS,QAAQ,MAAM,GAAG,GAAG;AAC1D,SAAO,MAAM,QAAQ,WAAW,GAAG,IAAI,IAAI;AAC7C;",
+  "names": []
+}

package/dist/string/truncate.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Truncates a string to a specified length and adds an ellipsis if it's longer in JS
+ *
+ * @param str - The string to truncate
+ * @param maxLength - The maximum length before truncation (default: 18)
+ * @returns The truncated string with ellipsis if needed
+ *
+ * @example
+ * truncate('Very long name that needs truncation') // 'Very long name th…'
+ * truncate('Short') // 'Short'
+ */
+export declare const truncate: (str: string, maxLength?: number) => string;
+//# sourceMappingURL=truncate.d.ts.map

package/dist/string/truncate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"truncate.d.ts","sourceRoot":"","sources":["../../src/string/truncate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,MAAM,EAAE,kBAAc,KAAG,MAKtD,CAAA"}

package/dist/string/truncate.js

@@ -0,0 +1,10 @@
+const truncate = (str, maxLength = 18) => {
+  if (str.length <= maxLength) {
+    return str;
+  }
+  return str.slice(0, maxLength) + "\u2026";
+};
+export {
+  truncate
+};
+//# sourceMappingURL=truncate.js.map

package/dist/string/truncate.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/string/truncate.ts"],
+  "sourcesContent": ["/**\n * Truncates a string to a specified length and adds an ellipsis if it's longer in JS\n *\n * @param str - The string to truncate\n * @param maxLength - The maximum length before truncation (default: 18)\n * @returns The truncated string with ellipsis if needed\n *\n * @example\n * truncate('Very long name that needs truncation') // 'Very long name th\u2026'\n * truncate('Short') // 'Short'\n */\nexport const truncate = (str: string, maxLength = 18): string => {\n  if (str.length <= maxLength) {\n    return str\n  }\n  return str.slice(0, maxLength) + '\u2026'\n}\n"],
+  "mappings": "AAWO,MAAM,WAAW,CAAC,KAAa,YAAY,OAAe;AAC/D,MAAI,IAAI,UAAU,WAAW;AAC3B,WAAO;AAAA,EACT;AACA,SAAO,IAAI,MAAM,GAAG,SAAS,IAAI;AACnC;",
+  "names": []
+}

package/package.json

@@ -14,7 +14,7 @@
     "helpers",
     "js"
   ],
-  "version": "0.1.0",
+  "version": "0.1.1",
   "engines": {
     "node": ">=20"
   },