@hichchi/utils 0.0.1-beta.2 → 0.0.2

package/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./utils"), exports);
-tslib_1.__exportStar(require("./interfaces"), exports);
-tslib_1.__exportStar(require("./types"), exports);
-tslib_1.__exportStar(require("./enums"), exports);
-tslib_1.__exportStar(require("./constants"), exports);
-//# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../libs/utils/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,uDAA6B;AAC7B,kDAAwB;AACxB,kDAAwB;AACxB,sDAA4B"}

package/interfaces/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./path-value-set.interface"), exports);
-tslib_1.__exportStar(require("./infinite-object.interface"), exports);
-tslib_1.__exportStar(require("./inflection-rule.interfaces"), exports);
-//# sourceMappingURL=index.js.map

package/interfaces/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/utils/src/interfaces/index.ts"],"names":[],"mappings":";;;AAAA,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C"}

package/interfaces/infinite-object.interface.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=infinite-object.interface.js.map

package/interfaces/infinite-object.interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"infinite-object.interface.js","sourceRoot":"","sources":["../../../../libs/utils/src/interfaces/infinite-object.interface.ts"],"names":[],"mappings":""}

package/interfaces/inflection-rule.interfaces.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=inflection-rule.interfaces.js.map

package/interfaces/inflection-rule.interfaces.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"inflection-rule.interfaces.js","sourceRoot":"","sources":["../../../../libs/utils/src/interfaces/inflection-rule.interfaces.ts"],"names":[],"mappings":""}

package/interfaces/path-value-set.interface.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=path-value-set.interface.js.map

package/interfaces/path-value-set.interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"path-value-set.interface.js","sourceRoot":"","sources":["../../../../libs/utils/src/interfaces/path-value-set.interface.ts"],"names":[],"mappings":""}

package/readme-top.md

@@ -1,187 +0,0 @@
-<!--suppress ALL -->
-<div align="center">
-
-# 🛠️ @hichchi/utils
-
-**A comprehensive utility library with essential helper functions for JavaScript/TypeScript applications**
-
-[![npm version](https://img.shields.io/npm/v/@hichchi/utils?style=flat&color=blue)](https://www.npmjs.com/package/@hichchi/utils)
-[![npm downloads](https://img.shields.io/npm/dm/@hichchi/utils?style=flat&color=green)](https://www.npmjs.com/package/@hichchi/utils)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/hichchidev/hichchi/blob/main/LICENSE)
-[![TypeScript](https://img.shields.io/badge/typescript-5.0+-blue.svg)](https://www.typescriptlang.org/)
-
-*Part of the [Hichchi](https://github.com/hichchidev/hichchi) ecosystem - A powerful, scalable application built with Nx workspace*
-
-[📚 Jump to Documentation](#-api-documentation)
-
-</div>
-
----
-
-## 📋 Table Of Contents
-
-- [📦 Installation](#-installation)
-- [⚡ Quick Start](#-quick-start)
-- [📋 Prerequisites](#-prerequisites)
-- [🌟 Overview](#-overview)
-- [✨ Features](#-features)
-- [🛠️ Troubleshooting](#️-troubleshooting)
-- [🔧 Development](#-development)
-- [📖 API Documentation](#-api-documentation)
-
----
-
-## 📦 Installation
-
-```bash
-npm install @hichchi/utils
-```
-
-## ⚡ Quick Start
-
-Get up and running with powerful utility functions in just a few minutes:
-
-```typescript
-// 1. Install the package
-npm install @hichchi/utils
-
-// 2. Import utility functions
-import { pathValueSetToObject } from '@hichchi/utils';
-
-// 3. Use utility functions in your application
-const nestedObject = pathValueSetToObject({
-    "id": 123,
-    "name": "John Doe",
-    "profile.age": 30,
-    "profile.address.city": "New York",
-    "profile.address.zip": "10001"
-});
-
-Result:
-// {
-//   id: 123,
-//   name: "John Doe",
-//   profile: {
-//     age: 30,
-//     address: {
-//       city: "New York",
-//       zip: "10001"
-//     }
-//   }
-// }
-
-```
-
-## 📋 Prerequisites
-
-Before installing @hichchi/utils, ensure you have:
-
-### Required Dependencies
-- **Node.js**: >= 18.0.0
-- **TypeScript**: >= 5.0.0 (for TypeScript projects)
-
-
-## 🌟 Overview
-
-🎯 **Your essential toolkit** for JavaScript and TypeScript development. From string manipulation to file operations, from object utilities to URL handling - everything you need to streamline your development workflow with battle-tested, performance-optimized utility functions.
-
-## ✨ Features
-
-### 🔤 String Utilities
-- 🎨 **Case Conversion** - camelCase, PascalCase, snake_case, kebab-case transformations
-- 🔍 **String Analysis** - Pattern matching, validation, and content analysis
-- ✂️ **String Manipulation** - Truncation, padding, cleaning, and formatting
-- 🏷️ **Slug Generation** - URL-friendly string generation with customizable options
-- 📝 **Template Processing** - Advanced string templating with variable substitution
-
-### 🗂️ Object Utilities
-- 🔄 **Deep Operations** - Deep merge, clone, compare, and transformation
-- 🎯 **Property Access** - Safe property getting/setting with dot notation
-- 🔍 **Object Analysis** - Type checking, validation, and structure analysis
-- 📊 **Data Transformation** - Object flattening, nesting, and restructuring
-- 🧹 **Object Cleaning** - Remove null/undefined values, empty objects
-
-### 📝 String Template Utilities
-- 🎨 **Template Processing** - Advanced string templating with variable substitution
-- 🔄 **Dynamic Content** - Apply templates with custom prefixes and transformations
-- 🏷️ **Tag-based Processing** - Support for various template tags and formats
-
-### 🌐 URL Utilities
-- 🔒 **Redirect Validation** - Secure redirect URL validation against allowed domains
-- 🛡️ **Security Features** - Prevent open redirect vulnerabilities
-
-### ✅ Assertion Utilities
-- 🔍 **Type Guards** - TypeScript type guards for arrays and objects
-- 🎯 **Property Checking** - Check if objects have specific properties
-- 🛡️ **Safe Type Narrowing** - Runtime type validation with TypeScript support
-
-### 🎨 Developer Experience
-- 📝 **Full TypeScript Support** - Complete type definitions and IntelliSense
-- 🔧 **Tree Shaking** - Import only what you need for optimal bundle size
-- 📚 **Comprehensive Documentation** - Detailed JSDoc comments for all functions
-- 🧪 **Well Tested** - Extensive test coverage for reliability
-- 🚀 **Performance Optimized** - Efficient algorithms and minimal overhead
-
-## 🔒 Security Best Practices
-
-Detailed security best practices will be added here
-
-## 🛠️ Troubleshooting
-
-### Common Issues
-
-#### TypeScript Compilation Issues
-```bash
-# Ensure you have the correct TypeScript version
-npm install typescript@^5.0.0 --save-dev
-```
-
-## 🔧 Development
-
-### Building the Library
-```bash
-nx build utils
-```
-
-### Running Tests
-```bash
-nx test utils
-```
-
-### Linting
-```bash
-nx lint utils
-```
-
-### Performance Testing
-```bash
-nx run utils:benchmark
-```
-
----
-
-<div align="center">
-
-**Made with ❤️ by [Hichchi Dev](https://github.com/hichchidev)**
-
-[![Hichchi Ecosystem](https://img.shields.io/badge/🏠_Hichchi_Ecosystem-blue)](https://github.com/hichchidev/hichchi)
-[![Report Bug](https://img.shields.io/badge/🐛_Report_Bug-red)](https://github.com/hichchidev/hichchi/issues)
-[![Request Feature](https://img.shields.io/badge/✨_Request_Feature-green)](https://github.com/hichchidev/hichchi/issues)
-
-*Building the future of development utilities, one commit at a time*
-
-</div>
-
----
-
-# 📖 API Documentation
-
-Complete technical reference for all classes, interfaces, methods, and types in this library.
-
-**Auto-generated by TypeDoc** - Browse through detailed API references, code examples, and implementation guides below.
-
-<!-- TypeDoc generated documentation will be appended below this point -->
-
----
-
-## 📋 API Table of Contents

package/types/deep-partial.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=deep-partial.type.js.map

package/types/deep-partial.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deep-partial.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/deep-partial.type.ts"],"names":[],"mappings":""}

package/types/index.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-/**
- * Utility types for TypeScript development
- *
- * This module exports a collection of utility types that enhance TypeScript's
- * type system with additional functionality. These types help with common
- * type manipulation tasks and provide solutions for advanced typing scenarios.
- *
- * Key categories of types included:
- * - Object type utilities (DeepPartial, PartialWithNull, LiteralObject)
- * - Type predicates (IsEmpty, IsPrimitive, IsAlreadyInPath)
- * - Type transformation utilities (Prettify, LooseAutocomplete)
- * - Constructor and class utilities (Type)
- *
- * Import these types individually or from this barrel file to enhance
- * your TypeScript code with more expressive and precise type definitions.
- *
- * @example
- * ```typescript
- * // Import all types
- * import * as Types from '@hichchi/utils/types';
- *
- * // Or import specific types
- * import { DeepPartial, LiteralObject } from '@hichchi/utils/types';
- * ```
- */
-tslib_1.__exportStar(require("./type.type"), exports);
-tslib_1.__exportStar(require("./is-empty.type"), exports);
-tslib_1.__exportStar(require("./prettify.type"), exports);
-tslib_1.__exportStar(require("./deep-partial.type"), exports);
-tslib_1.__exportStar(require("./is-primitive.type"), exports);
-tslib_1.__exportStar(require("./literal-object.type"), exports);
-tslib_1.__exportStar(require("./partial-with-null.type"), exports);
-tslib_1.__exportStar(require("./is-already-in-path.type"), exports);
-tslib_1.__exportStar(require("./loose-autocomplete.type"), exports);
-//# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,sDAA4B;AAC5B,0DAAgC;AAChC,0DAAgC;AAChC,8DAAoC;AACpC,8DAAoC;AACpC,gEAAsC;AACtC,mEAAyC;AACzC,oEAA0C;AAC1C,oEAA0C"}

package/types/is-already-in-path.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=is-already-in-path.type.js.map

package/types/is-already-in-path.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-already-in-path.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/is-already-in-path.type.ts"],"names":[],"mappings":""}

package/types/is-empty.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=is-empty.type.js.map

package/types/is-empty.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-empty.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/is-empty.type.ts"],"names":[],"mappings":""}

package/types/is-primitive.type.js

@@ -1,4 +0,0 @@
-"use strict";
-// noinspection JSUnusedGlobalSymbols
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=is-primitive.type.js.map

package/types/is-primitive.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"is-primitive.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/is-primitive.type.ts"],"names":[],"mappings":";AAAA,qCAAqC"}

package/types/literal-object.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=literal-object.type.js.map

package/types/literal-object.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"literal-object.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/literal-object.type.ts"],"names":[],"mappings":""}

package/types/loose-autocomplete.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=loose-autocomplete.type.js.map

package/types/loose-autocomplete.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"loose-autocomplete.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/loose-autocomplete.type.ts"],"names":[],"mappings":""}

package/types/partial-with-null.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=partial-with-null.type.js.map

package/types/partial-with-null.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"partial-with-null.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/partial-with-null.type.ts"],"names":[],"mappings":""}

package/types/prettify.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=prettify.type.js.map

package/types/prettify.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"prettify.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/prettify.type.ts"],"names":[],"mappings":""}

package/types/type.type.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=type.type.js.map

package/types/type.type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.type.js","sourceRoot":"","sources":["../../../../libs/utils/src/types/type.type.ts"],"names":[],"mappings":""}

package/utils/assertions.utils.js

@@ -1,163 +0,0 @@
-"use strict";
-// noinspection JSUnusedGlobalSymbols
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isArray = isArray;
-exports.isObject = isObject;
-exports.isObjectWith = isObjectWith;
-/**
- * Type-safe utility to check if a value is an array of a specific type.
- *
- * This function acts as a type guard that not only checks if the provided value
- * is an array (using the native Array.isArray method), but also narrows the TypeScript
- * type to an array of the generic type T. This enables safer handling of potentially
- * array-typed values with full type inference in the conditional branches.
- *
- * @template T The expected element type of the array
- * @param {T | T[] | undefined} value The value to check, which could be a single item,
- *                                     an array of items, or undefined
- * @returns {value is T[]} Type predicate that narrows the type to T[] when true
- *
- * @remarks
- * While this function essentially wraps Array.isArray, its value comes from the
- * TypeScript type narrowing it provides, making it especially useful in code that
- * needs to handle both single items and collections of items with type safety.
- *
- * The function properly handles undefined values by returning false, making it safe
- * to use with optional parameters or potentially undefined values.
- *
- * @example
- * ```typescript
- * // Function that can accept either a single user or multiple users
- * async function createUser(userOrUsers: UserDto | UserDto[] | undefined): Promise<User | User[]> {
- *     // TypeScript knows userOrUsers is UserDto[] in this branch
- *     if (isArray<UserDto>(userOrUsers)) {
- *         return Promise.all(userOrUsers.map(user => userService.createUser(user)));
- *     }
- *     // TypeScript knows userOrUsers is UserDto or undefined in this branch
- *     else if (userOrUsers) {
- *         return userService.createUser(userOrUsers);
- *     }
- *     else {
- *         throw new BadRequestException('User data is required');
- *     }
- * }
- * ```
- */
-function isArray(value) {
-    return Array.isArray(value);
-}
-/**
- * Type-safe utility to check if a value is a non-array object of a specific type.
- *
- * This function serves as a type guard that checks if the provided value is an object
- * (but not an array) and narrows the TypeScript type to the generic type T. It properly
- * excludes null, arrays, and primitive values, focusing only on object instances.
- *
- * @template T The expected object type to narrow to when the check passes
- * @param {T | T[] | undefined} [value] The value to check, which could be a single object,
- *                                       an array of objects, or undefined
- * @returns {value is T} Type predicate that narrows the type to T when true
- *
- * @remarks
- * This function performs three checks to ensure the value is a proper object:
- * 1. It's not an array (using Array.isArray)
- * 2. It's of type "object" according to JavaScript's typeof operator
- * 3. It's not null (which would pass the typeof check but isn't a valid object)
- *
- * This is particularly useful when handling parameters that could be either an object
- * or a simpler identifier (like an ID), allowing for type-safe conditional logic.
- *
- * @example
- * ```typescript
- * // Function that can accept either a user ID or a user object
- * async function getUserInfo(userIdOrUser: number | User | undefined): Promise<UserInfo> {
- *     // TypeScript knows userIdOrUser is User in this branch
- *     if (isObject<User>(userIdOrUser)) {
- *         // Can safely access object properties
- *         return await userService.getUserInfo(userIdOrUser.id);
- *     }
- *     // TypeScript knows userIdOrUser is number or undefined in this branch
- *     else {
- *         return await userService.getUserInfo(userIdOrUser);
- *     }
- * }
- *
- * // Works with optional parameters too
- * function formatUserName(user?: User | string): string {
- *     if (isObject<User>(user)) {
- *         return `${user.firstName} ${user.lastName}`;
- *     }
- *     return user || 'Guest';
- * }
- * ```
- */
-function isObject(value) {
-    return !Array.isArray(value) && typeof value === "object" && value !== null;
-}
-/**
- * Type-safe utility to check if a value is an object with a specific property.
- *
- * This function acts as a type guard that determines if an unknown value is an object
- * that contains a specified property, and narrows the TypeScript type to the generic
- * type T when true. This provides a robust way to implement duck typing in TypeScript,
- * allowing for safe property access in the conditional branches.
- *
- * @template T The expected object type that should contain the property
- * @param {unknown} value Any value to check, with no type constraints
- * @param {keyof T} propertyName The name of the property that should exist on the object
- * @returns {value is T} Type predicate that narrows the type to T when true
- *
- * @remarks
- * This function uses Object.prototype.hasOwnProperty.call to safely check for property
- * existence, even if the object has a custom implementation of hasOwnProperty or if the
- * property is named 'hasOwnProperty'.
- *
- * Unlike the simpler isObject utility, this function can distinguish between different
- * object types based on their properties, making it ideal for discriminating between
- * different interface implementations or handling union types.
- *
- * @example
- * ```typescript
- * // Check if an object has the properties of a User interface
- * interface User {
- *   id: number;
- *   name: string;
- * }
- *
- * interface Order {
- *   orderNumber: string;
- *   items: string[];
- * }
- *
- * // Function that can handle different object types
- * function processEntity(entity: unknown): void {
- *   // Check if entity has 'id' property, indicating it's a User
- *   if (isObjectWith<User>(entity, 'id')) {
- *     // TypeScript knows entity is User in this branch
- *     console.log(`Processing user: ${entity.name}`);
- *   }
- *   // Check if entity has 'orderNumber' property, indicating it's an Order
- *   else if (isObjectWith<Order>(entity, 'orderNumber')) {
- *     // TypeScript knows entity is Order in this branch
- *     console.log(`Processing order: ${entity.orderNumber} with ${entity.items.length} items`);
- *   }
- *   else {
- *     console.log('Unknown entity type');
- *   }
- * }
- *
- * // Useful for API responses where types may vary
- * async function handleResponse(response: unknown): Promise<void> {
- *   if (isObjectWith<ErrorResponse>(response, 'errorCode')) {
- *     throw new ApiException(response.errorCode, response.message);
- *   }
- *   else if (isObjectWith<SuccessResponse>(response, 'data')) {
- *     await processData(response.data);
- *   }
- * }
- * ```
- */
-function isObjectWith(value, propertyName) {
-    return Object.prototype.hasOwnProperty.call(value, propertyName);
-}
-//# sourceMappingURL=assertions.utils.js.map

package/utils/assertions.utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"assertions.utils.js","sourceRoot":"","sources":["../../../../libs/utils/src/utils/assertions.utils.ts"],"names":[],"mappings":";AAAA,qCAAqC;;AAyCrC,0BAEC;AA+CD,4BAEC;AAiED,oCAEC;AA7JD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,SAAgB,OAAO,CAAI,KAA0B;IACjD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,SAAgB,QAAQ,CAAI,KAA2B;IACnD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,SAAgB,YAAY,CAAmB,KAAc,EAAE,YAAqB;IAChF,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACrE,CAAC"}