@posx/core 5.5.228 → 5.5.229

package/build/index.d.ts

@@ -1,3 +1,226 @@
+declare module '@posx/core/helpers/helpers.register' {
+  /**
+   * String Helpers Registration - Following handlebars-helpers API pattern
+   *
+   * This module follows the same API as the original handlebars-helpers library:
+   * helpers({ handlebars: Handlebars })
+   */
+  interface HelperOptions {
+      handlebars?: any;
+      hbs?: any;
+  }
+  /**
+   * Register string helpers with Handlebars
+   *
+   * @param options - Options object with handlebars instance
+   * @returns The registered helpers object
+   *
+   * @example
+   * ```typescript
+   * import Handlebars from 'handlebars';
+   * import helpers from '@posx/core/helpers/string-helpers-register/index';
+   *
+   * // Register all string helpers
+   * helpers({ handlebars: Handlebars });
+   *
+   * const template = Handlebars.compile('{{camelcase "foo bar baz"}}');
+   * console.log(template({})); // 'fooBarBaz'
+   * ```
+   */
+  function helpers(options?: HelperOptions): any;
+  /**
+   * Export default following the original API pattern
+   */
+  export default helpers;
+
+}
+declare module '@posx/core/helpers/string.helpers' {
+  /**
+   * String Helpers for Handlebars
+   * Browser-compatible string manipulation utilities
+   */
+  export interface StringHelpers {
+      camelcase: (str: string) => string;
+      capitalize: (str: string) => string;
+      capitalizeAll: (str: string) => string;
+      dashcase: (str: string) => string;
+      dotcase: (str: string) => string;
+      downcase: (str: string) => string;
+      lowercase: (str: string) => string;
+      pascalcase: (str: string) => string;
+      pathcase: (str: string) => string;
+      sentence: (str: string) => string;
+      snakecase: (str: string) => string;
+      titleize: (str: string) => string;
+      upcase: (str: string) => string;
+      uppercase: (str: string) => string;
+      append: (str: string, suffix: string) => string;
+      center: (str: string, spaces: number) => string;
+      chop: (str: string) => string;
+      hyphenate: (str: string) => string;
+      plusify: (str: string, ch?: string) => string;
+      prepend: (str: string, prefix: string) => string;
+      remove: (str: string, substring: string) => string;
+      removeFirst: (str: string, substring: string) => string;
+      replace: (str: string, a: string, b: string) => string;
+      replaceFirst: (str: string, a: string, b: string) => string;
+      reverse: (str: string) => string;
+      split: (str: string, ch?: string) => string[];
+      ellipsis: (str: string, limit: number) => string;
+      trim: (str: string) => string;
+      trimLeft: (str: string) => string;
+      trimRight: (str: string) => string;
+      truncate: (str: string, limit: number, suffix?: string) => string;
+      truncateWords: (str: string, count: number, suffix?: string) => string;
+      isString: (value: any) => boolean;
+      occurrences: (str: string, substring: string) => number;
+  }
+  /**
+   * camelCase the characters in the given string
+   */
+  export const camelcase: (str: string) => string;
+  /**
+   * Capitalize the first word in a sentence
+   */
+  export const capitalize: (str: string) => string;
+  /**
+   * Capitalize all words in a string
+   */
+  export const capitalizeAll: (str: string) => string;
+  /**
+   * dash-case the characters in string
+   */
+  export const dashcase: (str: string) => string;
+  /**
+   * dot.case the characters in string
+   */
+  export const dotcase: (str: string) => string;
+  /**
+   * Lowercase all characters (alias for lowercase)
+   */
+  export const downcase: (str: string) => string;
+  /**
+   * Lowercase all characters in the given string
+   */
+  export const lowercase: (str: string) => string;
+  /**
+   * PascalCase the characters in string
+   */
+  export const pascalcase: (str: string) => string;
+  /**
+   * path/case the characters in string
+   */
+  export const pathcase: (str: string) => string;
+  /**
+   * Sentence case the given string
+   */
+  export const sentence: (str: string) => string;
+  /**
+   * snake_case the characters in the given string
+   */
+  export const snakecase: (str: string) => string;
+  /**
+   * Title case the given string
+   */
+  export const titleize: (str: string) => string;
+  /**
+   * Uppercase all characters (alias for uppercase)
+   */
+  export const upcase: (str: string) => string;
+  /**
+   * Uppercase all of the characters in the given string
+   */
+  export const uppercase: (str: string) => string;
+  /**
+   * Append the specified suffix to the given string
+   */
+  export const append: (str: string, suffix: string) => string;
+  /**
+   * Center a string using non-breaking spaces
+   */
+  export const center: (str: string, spaces: number) => string;
+  /**
+   * Remove whitespace and non-word characters from beginning and end
+   */
+  export const chop: (str: string) => string;
+  /**
+   * Replace spaces in a string with hyphens
+   */
+  export const hyphenate: (str: string) => string;
+  /**
+   * Replace spaces (or custom character) with pluses
+   */
+  export const plusify: (str: string, ch?: string) => string;
+  /**
+   * Prepend the given string with the specified prefix
+   */
+  export const prepend: (str: string, prefix: string) => string;
+  /**
+   * Remove all occurrences of substring from the given string
+   */
+  export const remove: (str: string, substring: string) => string;
+  /**
+   * Remove the first occurrence of substring from the given string
+   */
+  export const removeFirst: (str: string, substring: string) => string;
+  /**
+   * Replace all occurrences of substring a with substring b
+   */
+  export const replace: (str: string, a: string, b: string) => string;
+  /**
+   * Replace the first occurrence of substring a with substring b
+   */
+  export const replaceFirst: (str: string, a: string, b: string) => string;
+  /**
+   * Reverse a string
+   */
+  export const reverse: (str: string) => string;
+  /**
+   * Split string by the given character
+   */
+  export const split: (str: string, ch?: string) => string[];
+  /**
+   * Truncate string and append ellipsis
+   */
+  export const ellipsis: (str: string, limit: number) => string;
+  /**
+   * Remove extraneous whitespace from beginning and end
+   */
+  export const trim: (str: string) => string;
+  /**
+   * Remove extraneous whitespace from the beginning
+   */
+  export const trimLeft: (str: string) => string;
+  /**
+   * Remove extraneous whitespace from the end
+   */
+  export const trimRight: (str: string) => string;
+  /**
+   * Truncate a string to the specified length
+   */
+  export const truncate: (str: string, limit: number, suffix?: string) => string;
+  /**
+   * Truncate a string to have the specified number of words
+   */
+  export const truncateWords: (str: string, count: number, suffix?: string) => string;
+  /**
+   * Check if value is a string
+   */
+  export const isString: (value: any) => value is string;
+  /**
+   * Return the number of occurrences of substring within the given string
+   */
+  export const occurrences: (str: string, substring: string) => number;
+  /**
+   * Export all helpers as a single object
+   */
+  export const stringHelpers: StringHelpers;
+  /**
+   * Default export
+   */
+  export default stringHelpers;
+
+}
 declare module '@posx/core/index' {
   export * from '@posx/core/types/auto.query.type';
   export * from '@posx/core/types/wyo.customer.type';