@hichchi/utils 0.0.1-alpha.1 → 0.0.1-beta.1

package/utils/object.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.utils.js","sourceRoot":"","sources":["../../../../libs/utils/src/utils/object.utils.ts"],"names":[],"mappings":";AAAA,uDAAuD;AACvD,qCAAqC;;;AAqBrC,4BAOC;AAuBD,8BAEC;AAqZD,oDAmBC;AAsED,oDAqCC;AA2XD,8BAEC;AAuGD,sCAOC;AA9iCD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,QAAQ,CAAI,GAAM;IAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAiB,CAAC;IAC7C,CAAC;SAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAiB,CAAC;IACjH,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,SAAS,CAAC,GAAyB,EAAE,KAAc;IAC/D,OAAO,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACI,MAAM,UAAU,GAAG,CAAC,GAAwB,EAAE,YAAoB,EAAY,EAAE;IACnF,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AARW,QAAA,UAAU,cAQrB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwGG;AACI,MAAM,OAAO,GAAG,CAAO,IAAc,EAAE,SAA0B,EAA2B,EAAE;IACjG,MAAM,GAAG,GAAG,IAAI,GAAG,EAAe,CAAC;IACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAChB,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QACzB,CAAC;aAAM,CAAC;YACJ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAZW,QAAA,OAAO,WAYlB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACI,MAAM,eAAe,GAAG,CAAC,GAAwB,EAAE,YAAoB,EAAY,EAAE;IACxF,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AARW,QAAA,eAAe,mBAQ1B;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACI,MAAM,cAAc,GAAG,CAAI,GAAmB,EAAE,IAAY,EAAiB,EAAE;IAClF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,uCAAuC;IAErE,IAAI,KAAK,GAAG,GAAG,CAAC;IAChB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,qCAAqC;QAErC,MAAM,MAAM,GAAG,kBAAkB,CAAC;QAClC,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,qCAAqC;QAE5E,IAAI,YAAY,EAAE,CAAC;YACf,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACjC,+DAA+D;YAC/D,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,IAAI,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC;gBAC7F,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,wCAAwC;YAC5E,CAAC;iBAAM,CAAC;gBACJ,OAAO,SAAS,CAAC,CAAC,iDAAiD;YACvE,CAAC;QACL,CAAC;aAAM,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;YAC5D,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,0CAA0C;QAClE,CAAC;aAAM,CAAC;YACJ,OAAO,SAAS,CAAC,CAAC,2CAA2C;QACjE,CAAC;IACL,CAAC;IAED,OAAO,KAAU,CAAC;AACtB,CAAC,CAAC;AA3BW,QAAA,cAAc,kBA2BzB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,oBAAoB,CAAC,GAAkB;IACnD,MAAM,MAAM,GAAiB,EAAE,CAAC;IAEhC,SAAS,QAAQ,CAAC,GAAkB,EAAE,OAAiB,EAAE;QACrD,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACpB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;gBACjD,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrD,QAAQ,CAAC,KAAsB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACJ,MAAM,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;gBAC7C,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,GAAG,CAAC,CAAC;IAEd,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,SAAgB,oBAAoB,CAAa,YAAiC;IAC9E,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,oCAAoC;IACpC,MAAM,WAAW,GAAG,CAAC,IAAY,EAAW,EAAE;QAC1C,MAAM,KAAK,GAAG,mBAAmB,CAAC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC;IAEF,2CAA2C;IAC3C,MAAM,cAAc,GAAG,CAAc,GAAwB,EAAE,IAAc,EAAE,KAAQ,EAAQ,EAAE;QAC7F,MAAM,CAAC,QAAQ,EAAE,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC;QAC1C,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,GAAG,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,6BAA6B;YACpD,OAAO;QACX,CAAC;QAED,yCAAyC;QACzC,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACpC,iEAAiE;QACjE,cAAc,CAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC,mCAAmC;QAC3F,gCAAgC;IACpC,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAC9B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,SAAS,CAAC,qBAAqB;YACnC,CAAC;YAED,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,uBAAuB;YACrD,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,oCAAoC;QAC7E,CAAC;IACL,CAAC;IAED,OAAO,MAAW,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8FG;AACI,MAAM,IAAI,GAAG,CAAuC,GAAe,EAAE,IAAkB,EAAc,EAAE;IAC1G,IAAI,GAAG,EAAE,CAAC;QACN,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;IACP,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC,CAAC;AAPW,QAAA,IAAI,QAOf;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiJG;AACI,MAAM,KAAK,GAAG,CAAI,GAAuB,EAAE,aAAuB,EAAK,EAAE;IAC5E,MAAM,QAAQ,GAAM,EAAO,CAAC;IAC5B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,QAAa,CAAC;IACzB,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,aAAa,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;YACnE,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACpD,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAA,aAAK,EAAC,GAAG,CAAC,GAAG,CAAC,EAAE,aAAa,CAAC,CAAC;YACnD,CAAC;iBAAM,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC;gBACxE,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,QAAa,CAAC;AACzB,CAAC,CAAC;AAhBW,QAAA,KAAK,SAgBhB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4GG;AACH,SAAgB,SAAS,CAAC,GAAiC,EAAE,KAAoB;IAC7E,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;AACH,SAAgB,aAAa,CAAmB,CAAI;IAChD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEhC,gEAAgE;IAChE,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IAE9D,OAAO,aAAa,CAAC,CAAC,CAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAkB,CAAC,CAAC,CAAE,MAAuB,CAAC;AAClH,CAAC"}

package/utils/string-template.utils.d.ts

@@ -0,0 +1,169 @@
+/**
+ * Applies a value to a template string containing transformation tags.
+ *
+ * This function replaces template tags in a string with transformed versions of a provided value.
+ * It's particularly useful for creating dynamic messages, error notifications, or any text
+ * that needs to include the same value in different formats.
+ *
+ * Each template tag is replaced with the result of applying the corresponding transformation
+ * function to the provided value. If a tag isn't present in the template string, that
+ * transformation is skipped.
+ *
+ * Available template tags:
+ * - `#{upperCase}` - Converts to UPPERCASE ("USER")
+ * - `#{snakeCase}` - Converts to snake_case ("user_profile")
+ * - `#{upperSnakeCase}` - Converts to UPPER_SNAKE_CASE ("USER_PROFILE")
+ * - `#{lowerCase}` - Converts to lowercase ("user")
+ * - `#{sentenceCase}` - Converts to Sentence case ("User profile")
+ * - `#{firstCase}` - Converts to First case ("User")
+ * - `#{camelCase}` - Converts to camelCase ("userProfile")
+ * - `#{pascalCase}` - Converts to PascalCase ("UserProfile")
+ * - `#{kebabCase}` - Converts to kebab-case ("user-profile")
+ * - `#{upperKebabCase}` - Converts to KEBAB-CASE ("USER-PROFILE")
+ * - `#{titleCase}` - Converts to Title Case ("User Profile")
+ * - `#{lowerCaseBreak}` - Breaks words and converts to lowercase ("user profile")
+ * - `#{upperCaseBreak}` - Breaks words and converts to UPPERCASE ("USER PROFILE")
+ * - `#{firstCaseBreak}` - Breaks words and applies First case ("User profile")
+ * - `#{singular}` - Converts plural to singular form ("users" → "user")
+ * - `#{number}` - Converts to a number if possible ("123" → 123)
+ * - `#{htmlToText}` - Removes HTML tags ("<b>User</b>" → "User")
+ * - `#{format}` - Formats a string with placeholders (used with additional parameters)
+ *
+ * @example
+ * ```typescript
+ * // Error message with different versions of the same term
+ * applyTemplate(
+ *     'Cannot create a #{lowerCase} with this email. #{sentenceCase} already exists.',
+ *     'User'
+ * );
+ * // Output: "Cannot create a user with this email. User already exists."
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using multiple transformations of the same value
+ * applyTemplate(
+ *     'Model: #{pascalCase}\nTable: #{snakeCase}\nAPI Path: #{kebabCase}',
+ *     'blogPost'
+ * );
+ * // Output:
+ * //     Model: BlogPost
+ * //     Table: blog_post
+ * //     API Path: blog-post
+ * ```
+ *
+ * @param {string} str - Template string containing transformation tags
+ * @param {string} prefix - The prefix to update with
+ * @returns {string} - The template with all tags replaced by transformed values
+ *
+ * @see {@link TemplateTag} For the full list of available template tags
+ * @see {@link applyTemplates} For applying multiple different values to a template
+ */
+export declare function applyTemplate(str: string, prefix: string): string;
+/**
+ * Applies multiple named template transformations to a string with different values for each prefix.
+ *
+ * This advanced templating function allows you to use multiple different values within a single
+ * template string, each with their own set of transformation tags. Unlike `applyTemplate` which
+ * applies one value to all tags, this function lets you specify different values for different
+ * prefixes, enabling complex template scenarios with multiple entities.
+ *
+ * Each prefix in the template is identified by a namespace (e.g., `user`, `post`) followed by
+ * a dot and the transformation tag (e.g., `#{user.lowerCase}`, `#{post.titleCase}`). This allows
+ * for sophisticated template generation where different parts of the text need different source
+ * values with various transformations applied.
+ *
+ * This is particularly useful for generating complex messages, code templates, documentation,
+ * or any text that involves multiple entities that need to be formatted differently within
+ * the same template.
+ *
+ * @param {string} str - Template string containing namespaced transformation tags in the format
+ *                       `#{prefix.transformationType}` where prefix matches keys in the prefixes object
+ * @param {Record<string, string>} prefixes - Object mapping prefix names to their corresponding values.
+ *                                            Each key becomes a namespace in the template, and the value
+ *                                            is the string that will be transformed according to the tags.
+ * @returns {string} The template string with all namespaced tags replaced by their transformed values
+ *
+ * @example
+ * ```typescript
+ * // Multi-entity message generation
+ * const message = applyTemplates(
+ *     'User #{user.lowerCase} created a new #{entity.sentenceCase} titled "#{title.titleCase}"',
+ *     {
+ *         user: 'JohnDoe',
+ *         entity: 'blogPost',
+ *         title: 'my first programming tutorial'
+ *     }
+ * );
+ * // Returns: "User johndoe created a new Blog post titled "My First Programming Tutorial""
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Code generation with multiple entities
+ * const codeTemplate = applyTemplates(
+ *     `class #{model.pascalCase} {
+ *   constructor(private #{service.camelCase}: #{service.pascalCase}Service) {}
+ *
+ *   async create#{model.pascalCase}(data: #{model.pascalCase}Data): Promise<#{model.pascalCase}> {
+ *     return this.#{service.camelCase}.create(data);
+ *   }
+ * }`,
+ *     {
+ *         model: 'user-profile',
+ *         service: 'database'
+ *     }
+ * );
+ * // Generates a complete class with proper naming conventions
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // API documentation generation
+ * const apiDoc = applyTemplates(
+ *     `## #{endpoint.titleCase}
+ *
+ * **URL:** \`/api/#{endpoint.kebabCase}\`
+ * **Method:** #{method.upperCase}
+ * **Model:** #{model.pascalCase}
+ *
+ * Creates a new #{model.lowerCaseBreak} in the system.`,
+ *     {
+ *         endpoint: 'userProfiles',
+ *         method: 'post',
+ *         model: 'UserProfile'
+ *     }
+ * );
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Database migration script generation
+ * const migration = applyTemplates(
+ *     `CREATE TABLE #{table.snakeCase} (
+ *   id SERIAL PRIMARY KEY,
+ *   #{field.snakeCase} VARCHAR(255) NOT NULL,
+ *   created_at TIMESTAMP DEFAULT NOW()
+ * );
+ *
+ * CREATE INDEX idx_#{table.snakeCase}_#{field.snakeCase} ON #{table.snakeCase}(#{field.snakeCase});`,
+ *     {
+ *         table: 'UserProfiles',
+ *         field: 'emailAddress'
+ *     }
+ * );
+ * ```
+ *
+ * @remarks
+ * - Each prefix in the prefixes object becomes a namespace in the template
+ * - Template tags must follow the format `#{prefix.transformationType}`
+ * - All transformation types available in `applyTemplate` are supported
+ * - If a prefixed tag is not found in the template, it's simply ignored
+ * - The function processes all prefixes and their transformations in the order they appear
+ * - Supports the same transformation types as the TemplateTag enum
+ * - More flexible than `applyTemplate` but with slightly more complex syntax
+ *
+ * @see {@link applyTemplate} For applying a single value to multiple transformation tags
+ * @see {@link TemplateTag} For the complete list of available transformation types
+ */
+export declare function applyTemplates(str: string, prefixes: Record<string, string>): string;

package/utils/string-template.utils.js

@@ -0,0 +1,269 @@
+"use strict";
+// noinspection JSUnusedGlobalSymbols
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyTemplate = applyTemplate;
+exports.applyTemplates = applyTemplates;
+const string_utils_1 = require("./string.utils");
+const enums_1 = require("../enums");
+/**
+ * Applies a value to a template string containing transformation tags.
+ *
+ * This function replaces template tags in a string with transformed versions of a provided value.
+ * It's particularly useful for creating dynamic messages, error notifications, or any text
+ * that needs to include the same value in different formats.
+ *
+ * Each template tag is replaced with the result of applying the corresponding transformation
+ * function to the provided value. If a tag isn't present in the template string, that
+ * transformation is skipped.
+ *
+ * Available template tags:
+ * - `#{upperCase}` - Converts to UPPERCASE ("USER")
+ * - `#{snakeCase}` - Converts to snake_case ("user_profile")
+ * - `#{upperSnakeCase}` - Converts to UPPER_SNAKE_CASE ("USER_PROFILE")
+ * - `#{lowerCase}` - Converts to lowercase ("user")
+ * - `#{sentenceCase}` - Converts to Sentence case ("User profile")
+ * - `#{firstCase}` - Converts to First case ("User")
+ * - `#{camelCase}` - Converts to camelCase ("userProfile")
+ * - `#{pascalCase}` - Converts to PascalCase ("UserProfile")
+ * - `#{kebabCase}` - Converts to kebab-case ("user-profile")
+ * - `#{upperKebabCase}` - Converts to KEBAB-CASE ("USER-PROFILE")
+ * - `#{titleCase}` - Converts to Title Case ("User Profile")
+ * - `#{lowerCaseBreak}` - Breaks words and converts to lowercase ("user profile")
+ * - `#{upperCaseBreak}` - Breaks words and converts to UPPERCASE ("USER PROFILE")
+ * - `#{firstCaseBreak}` - Breaks words and applies First case ("User profile")
+ * - `#{singular}` - Converts plural to singular form ("users" → "user")
+ * - `#{number}` - Converts to a number if possible ("123" → 123)
+ * - `#{htmlToText}` - Removes HTML tags ("<b>User</b>" → "User")
+ * - `#{format}` - Formats a string with placeholders (used with additional parameters)
+ *
+ * @example
+ * ```typescript
+ * // Error message with different versions of the same term
+ * applyTemplate(
+ *     'Cannot create a #{lowerCase} with this email. #{sentenceCase} already exists.',
+ *     'User'
+ * );
+ * // Output: "Cannot create a user with this email. User already exists."
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using multiple transformations of the same value
+ * applyTemplate(
+ *     'Model: #{pascalCase}\nTable: #{snakeCase}\nAPI Path: #{kebabCase}',
+ *     'blogPost'
+ * );
+ * // Output:
+ * //     Model: BlogPost
+ * //     Table: blog_post
+ * //     API Path: blog-post
+ * ```
+ *
+ * @param {string} str - Template string containing transformation tags
+ * @param {string} prefix - The prefix to update with
+ * @returns {string} - The template with all tags replaced by transformed values
+ *
+ * @see {@link TemplateTag} For the full list of available template tags
+ * @see {@link applyTemplates} For applying multiple different values to a template
+ */
+function applyTemplate(str, prefix) {
+    // Apply all available template tags
+    return str
+        .replace(enums_1.TemplateTag.UPPER_CASE, (0, string_utils_1.toUpperCase)(prefix))
+        .replace(enums_1.TemplateTag.SNAKE_CASE, (0, string_utils_1.toSnakeCase)(prefix))
+        .replace(enums_1.TemplateTag.UPPER_SNAKE_CASE, (0, string_utils_1.toSnakeCase)(prefix, true))
+        .replace(enums_1.TemplateTag.LOWER_CASE, (0, string_utils_1.toLowerCase)(prefix))
+        .replace(enums_1.TemplateTag.SENTENCE_CASE, (0, string_utils_1.toSentenceCase)(prefix))
+        .replace(enums_1.TemplateTag.FIRST_CASE, (0, string_utils_1.toFirstCase)(prefix))
+        .replace(enums_1.TemplateTag.CAMEL_CASE, (0, string_utils_1.toCamelCase)(prefix))
+        .replace(enums_1.TemplateTag.PASCAL_CASE, (0, string_utils_1.toPascalCase)(prefix))
+        .replace(enums_1.TemplateTag.KEBAB_CASE, (0, string_utils_1.toKebabCase)(prefix))
+        .replace(enums_1.TemplateTag.UPPER_KEBAB_CASE, (0, string_utils_1.toKebabCase)(prefix, true))
+        .replace(enums_1.TemplateTag.TITLE_CASE, (0, string_utils_1.toTitleCase)(prefix))
+        .replace(enums_1.TemplateTag.LOWER_CASE_BREAK, (0, string_utils_1.toLowerCaseBreak)(prefix))
+        .replace(enums_1.TemplateTag.UPPER_CASE_BREAK, (0, string_utils_1.toUpperCaseBreak)(prefix))
+        .replace(enums_1.TemplateTag.FIRST_CASE_BREAK, (0, string_utils_1.toFirstCaseBreak)(prefix))
+        .replace(enums_1.TemplateTag.SINGULAR, (0, string_utils_1.singular)(prefix))
+        .replace(enums_1.TemplateTag.NUMBER, String((0, string_utils_1.toNumber)(prefix) ?? prefix))
+        .replace(enums_1.TemplateTag.HTML_TO_TEXT, (0, string_utils_1.htmlToText)(prefix));
+}
+/**
+ * Applies multiple named template transformations to a string with different values for each prefix.
+ *
+ * This advanced templating function allows you to use multiple different values within a single
+ * template string, each with their own set of transformation tags. Unlike `applyTemplate` which
+ * applies one value to all tags, this function lets you specify different values for different
+ * prefixes, enabling complex template scenarios with multiple entities.
+ *
+ * Each prefix in the template is identified by a namespace (e.g., `user`, `post`) followed by
+ * a dot and the transformation tag (e.g., `#{user.lowerCase}`, `#{post.titleCase}`). This allows
+ * for sophisticated template generation where different parts of the text need different source
+ * values with various transformations applied.
+ *
+ * This is particularly useful for generating complex messages, code templates, documentation,
+ * or any text that involves multiple entities that need to be formatted differently within
+ * the same template.
+ *
+ * @param {string} str - Template string containing namespaced transformation tags in the format
+ *                       `#{prefix.transformationType}` where prefix matches keys in the prefixes object
+ * @param {Record<string, string>} prefixes - Object mapping prefix names to their corresponding values.
+ *                                            Each key becomes a namespace in the template, and the value
+ *                                            is the string that will be transformed according to the tags.
+ * @returns {string} The template string with all namespaced tags replaced by their transformed values
+ *
+ * @example
+ * ```typescript
+ * // Multi-entity message generation
+ * const message = applyTemplates(
+ *     'User #{user.lowerCase} created a new #{entity.sentenceCase} titled "#{title.titleCase}"',
+ *     {
+ *         user: 'JohnDoe',
+ *         entity: 'blogPost',
+ *         title: 'my first programming tutorial'
+ *     }
+ * );
+ * // Returns: "User johndoe created a new Blog post titled "My First Programming Tutorial""
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Code generation with multiple entities
+ * const codeTemplate = applyTemplates(
+ *     `class #{model.pascalCase} {
+ *   constructor(private #{service.camelCase}: #{service.pascalCase}Service) {}
+ *
+ *   async create#{model.pascalCase}(data: #{model.pascalCase}Data): Promise<#{model.pascalCase}> {
+ *     return this.#{service.camelCase}.create(data);
+ *   }
+ * }`,
+ *     {
+ *         model: 'user-profile',
+ *         service: 'database'
+ *     }
+ * );
+ * // Generates a complete class with proper naming conventions
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // API documentation generation
+ * const apiDoc = applyTemplates(
+ *     `## #{endpoint.titleCase}
+ *
+ * **URL:** \`/api/#{endpoint.kebabCase}\`
+ * **Method:** #{method.upperCase}
+ * **Model:** #{model.pascalCase}
+ *
+ * Creates a new #{model.lowerCaseBreak} in the system.`,
+ *     {
+ *         endpoint: 'userProfiles',
+ *         method: 'post',
+ *         model: 'UserProfile'
+ *     }
+ * );
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Database migration script generation
+ * const migration = applyTemplates(
+ *     `CREATE TABLE #{table.snakeCase} (
+ *   id SERIAL PRIMARY KEY,
+ *   #{field.snakeCase} VARCHAR(255) NOT NULL,
+ *   created_at TIMESTAMP DEFAULT NOW()
+ * );
+ *
+ * CREATE INDEX idx_#{table.snakeCase}_#{field.snakeCase} ON #{table.snakeCase}(#{field.snakeCase});`,
+ *     {
+ *         table: 'UserProfiles',
+ *         field: 'emailAddress'
+ *     }
+ * );
+ * ```
+ *
+ * @remarks
+ * - Each prefix in the prefixes object becomes a namespace in the template
+ * - Template tags must follow the format `#{prefix.transformationType}`
+ * - All transformation types available in `applyTemplate` are supported
+ * - If a prefixed tag is not found in the template, it's simply ignored
+ * - The function processes all prefixes and their transformations in the order they appear
+ * - Supports the same transformation types as the TemplateTag enum
+ * - More flexible than `applyTemplate` but with slightly more complex syntax
+ *
+ * @see {@link applyTemplate} For applying a single value to multiple transformation tags
+ * @see {@link TemplateTag} For the complete list of available transformation types
+ */
+function applyTemplates(str, prefixes) {
+    let result = str;
+    // Process each prefix
+    for (const [key, prefix] of Object.entries(prefixes)) {
+        // Replace all possible template tags for this prefix
+        // eslint-disable-next-line no-loop-func
+        Object.values(enums_1.TemplateTag).forEach(tag => {
+            // Convert #{tag} to #{prefix.tag}
+            const prefixedTag = tag.replace("#{", `#{${key}.`);
+            if (result.includes(prefixedTag)) {
+                // Get the transformation function name
+                const templateFunction = tag.replace(/#{(.+)}/, "$1");
+                // Apply the appropriate transformation based on the tag
+                let replacement = prefix;
+                switch (templateFunction) {
+                    case enums_1.TemplateTag.UPPER_CASE:
+                        replacement = (0, string_utils_1.toUpperCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.SNAKE_CASE:
+                        replacement = (0, string_utils_1.toSnakeCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.UPPER_SNAKE_CASE:
+                        replacement = (0, string_utils_1.toSnakeCase)(prefix, true);
+                        break;
+                    case enums_1.TemplateTag.LOWER_CASE:
+                        replacement = (0, string_utils_1.toLowerCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.SENTENCE_CASE:
+                        replacement = (0, string_utils_1.toSentenceCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.FIRST_CASE:
+                        replacement = (0, string_utils_1.toFirstCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.CAMEL_CASE:
+                        replacement = (0, string_utils_1.toCamelCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.PASCAL_CASE:
+                        replacement = (0, string_utils_1.toPascalCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.KEBAB_CASE:
+                        replacement = (0, string_utils_1.toKebabCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.UPPER_KEBAB_CASE:
+                        replacement = (0, string_utils_1.toKebabCase)(prefix, true);
+                        break;
+                    case enums_1.TemplateTag.TITLE_CASE:
+                        replacement = (0, string_utils_1.toTitleCase)(prefix);
+                        break;
+                    case enums_1.TemplateTag.LOWER_CASE_BREAK:
+                        replacement = (0, string_utils_1.toLowerCaseBreak)(prefix);
+                        break;
+                    case enums_1.TemplateTag.UPPER_CASE_BREAK:
+                        replacement = (0, string_utils_1.toUpperCaseBreak)(prefix);
+                        break;
+                    case enums_1.TemplateTag.FIRST_CASE_BREAK:
+                        replacement = (0, string_utils_1.toFirstCaseBreak)(prefix);
+                        break;
+                    case enums_1.TemplateTag.SINGULAR:
+                        replacement = (0, string_utils_1.singular)(prefix);
+                        break;
+                    case enums_1.TemplateTag.NUMBER:
+                        replacement = String((0, string_utils_1.toNumber)(prefix) ?? prefix);
+                        break;
+                    case enums_1.TemplateTag.HTML_TO_TEXT:
+                        replacement = (0, string_utils_1.htmlToText)(prefix);
+                        break;
+                }
+                result = result.replace(prefixedTag, replacement);
+            }
+        });
+    }
+    return result;
+}
+//# sourceMappingURL=string-template.utils.js.map

package/utils/string-template.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"string-template.utils.js","sourceRoot":"","sources":["../../../../libs/utils/src/utils/string-template.utils.ts"],"names":[],"mappings":";AAAA,qCAAqC;;AAkFrC,sCAoBC;AA4GD,wCA4EC;AA5RD,iDAgBwB;AACxB,oCAAuC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,SAAgB,aAAa,CAAC,GAAW,EAAE,MAAc;IACrD,oCAAoC;IACpC,OAAO,GAAG;SACL,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,gBAAgB,EAAE,IAAA,0BAAW,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAChE,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,aAAa,EAAE,IAAA,6BAAc,EAAC,MAAM,CAAC,CAAC;SAC1D,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,WAAW,EAAE,IAAA,2BAAY,EAAC,MAAM,CAAC,CAAC;SACtD,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,gBAAgB,EAAE,IAAA,0BAAW,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;SAChE,OAAO,CAAC,mBAAW,CAAC,UAAU,EAAE,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;SACpD,OAAO,CAAC,mBAAW,CAAC,gBAAgB,EAAE,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC;SAC/D,OAAO,CAAC,mBAAW,CAAC,gBAAgB,EAAE,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC;SAC/D,OAAO,CAAC,mBAAW,CAAC,gBAAgB,EAAE,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC;SAC/D,OAAO,CAAC,mBAAW,CAAC,QAAQ,EAAE,IAAA,uBAAQ,EAAC,MAAM,CAAC,CAAC;SAC/C,OAAO,CAAC,mBAAW,CAAC,MAAM,EAAE,MAAM,CAAC,IAAA,uBAAQ,EAAC,MAAM,CAAC,IAAI,MAAM,CAAC,CAAC;SAC/D,OAAO,CAAC,mBAAW,CAAC,YAAY,EAAE,IAAA,yBAAU,EAAC,MAAM,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,SAAgB,cAAc,CAAC,GAAW,EAAE,QAAgC;IACxE,IAAI,MAAM,GAAW,GAAG,CAAC;IAEzB,sBAAsB;IACtB,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnD,qDAAqD;QACrD,wCAAwC;QACxC,MAAM,CAAC,MAAM,CAAC,mBAAW,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACrC,kCAAkC;YAClC,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,GAAG,CAAC,CAAC;YACnD,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/B,uCAAuC;gBACvC,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBACtD,wDAAwD;gBACxD,IAAI,WAAW,GAAG,MAAM,CAAC;gBAEzB,QAAQ,gBAAgB,EAAE,CAAC;oBACvB,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,gBAAgB;wBAC7B,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;wBACxC,MAAM;oBACV,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,aAAa;wBAC1B,WAAW,GAAG,IAAA,6BAAc,EAAC,MAAM,CAAC,CAAC;wBACrC,MAAM;oBACV,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,WAAW;wBACxB,WAAW,GAAG,IAAA,2BAAY,EAAC,MAAM,CAAC,CAAC;wBACnC,MAAM;oBACV,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,gBAAgB;wBAC7B,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;wBACxC,MAAM;oBACV,KAAK,mBAAW,CAAC,UAAU;wBACvB,WAAW,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;wBAClC,MAAM;oBACV,KAAK,mBAAW,CAAC,gBAAgB;wBAC7B,WAAW,GAAG,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC;wBACvC,MAAM;oBACV,KAAK,mBAAW,CAAC,gBAAgB;wBAC7B,WAAW,GAAG,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC;wBACvC,MAAM;oBACV,KAAK,mBAAW,CAAC,gBAAgB;wBAC7B,WAAW,GAAG,IAAA,+BAAgB,EAAC,MAAM,CAAC,CAAC;wBACvC,MAAM;oBACV,KAAK,mBAAW,CAAC,QAAQ;wBACrB,WAAW,GAAG,IAAA,uBAAQ,EAAC,MAAM,CAAC,CAAC;wBAC/B,MAAM;oBACV,KAAK,mBAAW,CAAC,MAAM;wBACnB,WAAW,GAAG,MAAM,CAAC,IAAA,uBAAQ,EAAC,MAAM,CAAC,IAAI,MAAM,CAAC,CAAC;wBACjD,MAAM;oBACV,KAAK,mBAAW,CAAC,YAAY;wBACzB,WAAW,GAAG,IAAA,yBAAU,EAAC,MAAM,CAAC,CAAC;wBACjC,MAAM;gBACd,CAAC;gBAED,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACtD,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC"}