@solid-nestjs/common 0.2.0 → 0.2.1

package/dist/decorators/wrapped.decorator.d.ts

@@ -1,2 +1,26 @@
+/**
+ * Method decorator that wraps the target method with a custom asynchronous wrapper function.
+ *
+ * @param wrapper - An asynchronous function that receives the injectable object,
+ *   a `next` function to invoke the original method, and the method arguments.
+ *   It should return a Promise with the result.
+ * @param options - Optional configuration object that will be merged with an `injectable` reference.
+ * @returns A method decorator that replaces the original method with the wrapped version.
+ *
+ * @example
+ * ```typescript
+ * class ExampleService {
+ *   @WrappedBy(async (obj, next, args) => {
+ *     // Pre-processing
+ *     const result = await next(...args);
+ *     // Post-processing
+ *     return result;
+ *   })
+ *   async myMethod(param: string) {
+ *     // ...
+ *   }
+ * }
+ * ```
+ */
 export declare function WrappedBy(wrapper: (obj: any, next: (...args: any[]) => Promise<any>, args: any[]) => Promise<any>, options?: any): MethodDecorator;
 //# sourceMappingURL=wrapped.decorator.d.ts.map

package/dist/decorators/wrapped.decorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wrapped.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/wrapped.decorator.ts"],"names":[],"mappings":"AA+CA,wBAAgB,SAAS,CACrB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACxF,OAAO,CAAC,EAAE,GAAG,GACd,eAAe,CAgBjB"}
+{"version":3,"file":"wrapped.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/wrapped.decorator.ts"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,SAAS,CACrB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACxF,OAAO,CAAC,EAAE,GAAG,GACd,eAAe,CAgBjB"}

package/dist/decorators/wrapped.decorator.js

@@ -1,11 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WrappedBy = WrappedBy;
+/**
+ * Wraps a function with a custom asynchronous wrapper, allowing additional logic to be executed
+ * before or after the original function call.
+ *
+ * @template T - The type of the function to wrap.
+ * @param options - Arbitrary options to be passed to the wrapper.
+ * @param fn - The original function to be wrapped.
+ * @param wrapper - An asynchronous function that receives the options, a `next` function to invoke the original function,
+ *   and the arguments for the original function. It should return a Promise of the original function's return type.
+ * @returns A Promise that resolves to a new function. When invoked, this function calls the wrapper with the provided options,
+ *   a `next` function to execute the original function, and the arguments.
+ */
 async function wrap(options, fn, wrapper) {
     return async (...args) => {
         return wrapper(options, () => Promise.resolve(fn(...args)), args);
     };
 }
+/**
+ * Method decorator that wraps the target method with a custom asynchronous wrapper function.
+ *
+ * @param wrapper - An asynchronous function that receives the injectable object,
+ *   a `next` function to invoke the original method, and the method arguments.
+ *   It should return a Promise with the result.
+ * @param options - Optional configuration object that will be merged with an `injectable` reference.
+ * @returns A method decorator that replaces the original method with the wrapped version.
+ *
+ * @example
+ * ```typescript
+ * class ExampleService {
+ *   @WrappedBy(async (obj, next, args) => {
+ *     // Pre-processing
+ *     const result = await next(...args);
+ *     // Post-processing
+ *     return result;
+ *   })
+ *   async myMethod(param: string) {
+ *     // ...
+ *   }
+ * }
+ * ```
+ */
 function WrappedBy(wrapper, options) {
     return function (target, propertyKey, descriptor) {
         const originalMethod = descriptor.value;

package/dist/decorators/wrapped.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"wrapped.decorator.js","sourceRoot":"","sources":["../../src/decorators/wrapped.decorator.ts"],"names":[],"mappings":";;AA+CA,8BAmBC;AArDD,KAAK,UAAU,IAAI,CACf,OAAY,EACZ,EAAK,EACL,OAAoH;IAEpH,OAAO,KAAK,EAAE,GAAG,IAAmB,EAAE,EAAE;QACpC,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC;AACN,CAAC;AA0BD,SAAgB,SAAS,CACrB,OAAwF,EACxF,OAAa;IAGb,OAAO,UAAU,MAAM,EAAE,WAAW,EAAE,UAA8B;QAEhE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAAW;YAE7C,MAAM,UAAU,GAAG,IAAI,CAAC;YACxB,MAAM,UAAU,GAAG,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,CAAA;YAE7C,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC/E,OAAO,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;QAEhC,CAAC,CAAC;IACN,CAAC,CAAC;AACN,CAAC"}
+{"version":3,"file":"wrapped.decorator.js","sourceRoot":"","sources":["../../src/decorators/wrapped.decorator.ts"],"names":[],"mappings":";;AA+CA,8BAmBC;AAjED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,IAAI,CACf,OAAY,EACZ,EAAK,EACL,OAAoH;IAEpH,OAAO,KAAK,EAAE,GAAG,IAAmB,EAAE,EAAE;QACpC,OAAO,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,SAAS,CACrB,OAAwF,EACxF,OAAa;IAGb,OAAO,UAAU,MAAM,EAAE,WAAW,EAAE,UAA8B;QAEhE,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAAW;YAE7C,MAAM,UAAU,GAAG,IAAI,CAAC;YACxB,MAAM,UAAU,GAAG,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,CAAA;YAE7C,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YAC/E,OAAO,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;QAEhC,CAAC,CAAC;IACN,CAAC,CAAC;AACN,CAAC"}

package/dist/helpers/pipe-transform.helper.d.ts

@@ -1,6 +1,16 @@
 import { Type, PipeTransform } from '@nestjs/common';
 import { Constructor } from '../types';
 type ConstructorOrFunction = Function | Constructor;
+/**
+ * Retrieves the appropriate `PipeTransform` type for a given constructor or function type.
+ *
+ * @param type - The constructor or function to get the pipe transform for.
+ * @returns The corresponding `PipeTransform` type if found; otherwise, `undefined`.
+ *
+ * @remarks
+ * - Special handling is provided for UUID strings, returning `ParseUUIDPipe` if the type is `String` and matches a UUID type.
+ * - Otherwise, the function looks up the type in the `TypePipeMap`.
+ */
 export declare function getPipeTransformForType(type: ConstructorOrFunction): Type<PipeTransform> | undefined;
 export {};
 //# sourceMappingURL=pipe-transform.helper.d.ts.map

package/dist/helpers/pipe-transform.helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pipe-transform.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/pipe-transform.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,IAAI,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGvC,KAAK,qBAAqB,GAAG,QAAQ,GAAG,WAAW,CAAC;AAmBpD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,SAAS,CAOpG"}
+{"version":3,"file":"pipe-transform.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/pipe-transform.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,IAAI,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACjG,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGvC,KAAK,qBAAqB,GAAG,QAAQ,GAAG,WAAW,CAAC;AASpD;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,SAAS,CAOpG"}

package/dist/helpers/pipe-transform.helper.js

@@ -8,13 +8,26 @@ const TypePipeMap = new Map([
     [String, undefined],
     [Boolean, common_1.ParseBoolPipe],
 ]);
+/**
+ * Retrieves the appropriate `PipeTransform` type for a given constructor or function type.
+ *
+ * @param type - The constructor or function to get the pipe transform for.
+ * @returns The corresponding `PipeTransform` type if found; otherwise, `undefined`.
+ *
+ * @remarks
+ * - Special handling is provided for UUID strings, returning `ParseUUIDPipe` if the type is `String` and matches a UUID type.
+ * - Otherwise, the function looks up the type in the `TypePipeMap`.
+ */
 function getPipeTransformForType(type) {
+    // Handle UUID strings
     if (type === String && isUUIDType(type)) {
         return common_1.ParseUUIDPipe;
     }
     return TypePipeMap.get(type);
 }
 function isUUIDType(type) {
+    // You might want to implement your own logic to detect UUID types
+    // For example, checking for decorators or metadata
     return false;
 }
 //# sourceMappingURL=pipe-transform.helper.js.map

package/dist/helpers/pipe-transform.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipe-transform.helper.js","sourceRoot":"","sources":["../../src/helpers/pipe-transform.helper.ts"],"names":[],"mappings":";;AAuBA,0DAOC;AA9BD,2CAAiG;AAMjG,MAAM,WAAW,GAAG,IAAI,GAAG,CAA2C;IAClE,CAAC,MAAM,EAAE,qBAAY,CAAC;IACtB,CAAC,MAAM,EAAE,qBAAY,CAAC;IACtB,CAAC,MAAM,EAAE,SAAS,CAAC;IACnB,CAAC,OAAO,EAAE,sBAAa,CAAC;CAC3B,CAAC,CAAC;AAYH,SAAgB,uBAAuB,CAAC,IAA2B;IAE/D,IAAI,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,sBAAa,CAAC;IACzB,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,UAAU,CAAC,IAA2B;IAG3C,OAAO,KAAK,CAAC;AACjB,CAAC"}
+{"version":3,"file":"pipe-transform.helper.js","sourceRoot":"","sources":["../../src/helpers/pipe-transform.helper.ts"],"names":[],"mappings":";;AAuBA,0DAOC;AA9BD,2CAAiG;AAMjG,MAAM,WAAW,GAAG,IAAI,GAAG,CAA2C;IAClE,CAAC,MAAM,EAAE,qBAAY,CAAC;IACtB,CAAC,MAAM,EAAE,qBAAY,CAAC;IACtB,CAAC,MAAM,EAAE,SAAS,CAAC;IACnB,CAAC,OAAO,EAAE,sBAAa,CAAC;CAC3B,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CAAC,IAA2B;IAC/D,sBAAsB;IACtB,IAAI,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,sBAAa,CAAC;IACzB,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,UAAU,CAAC,IAA2B;IAC3C,kEAAkE;IAClE,mDAAmD;IACnD,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/dist/helpers/types.helper.d.ts

@@ -1,4 +1,22 @@
 import { Constructor } from "../types";
+/**
+ * Returns the name of a type, given either a string or a constructor function.
+ *
+ * @param type - The type to get the name of. Can be a string or a constructor function.
+ * @returns The name of the type as a string.
+ * @throws {Error} If the provided type is neither a string nor a constructor function.
+ */
 export declare function getTypeName(type: string | Function): string;
+/**
+ * Retrieves the design type metadata of a specified property from a class constructor.
+ *
+ * @param constructor - The class constructor from which to retrieve the property type.
+ * @param field - The name of the property whose type metadata is to be retrieved.
+ * @returns The type metadata of the specified property, or `undefined` if not found.
+ *
+ * @remarks
+ * This function relies on TypeScript's "emitDecoratorMetadata" feature and the Reflect Metadata API.
+ * Ensure that the "reflect-metadata" polyfill is imported and that "emitDecoratorMetadata" is enabled in your tsconfig.
+ */
 export declare function getPropertyType(constructor: Constructor, field: string): any;
 //# sourceMappingURL=types.helper.d.ts.map

package/dist/helpers/types.helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/types.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AASvC,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAWzD;AAaH,wBAAgB,eAAe,CAAC,WAAW,EAAC,WAAW,EAAE,KAAK,EAAC,MAAM,OAGpE"}
+{"version":3,"file":"types.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/types.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAWzD;AAEH;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAC,WAAW,EAAE,KAAK,EAAC,MAAM,OAGpE"}

package/dist/helpers/types.helper.js

@@ -2,15 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTypeName = getTypeName;
 exports.getPropertyType = getPropertyType;
+/**
+ * Returns the name of a type, given either a string or a constructor function.
+ *
+ * @param type - The type to get the name of. Can be a string or a constructor function.
+ * @returns The name of the type as a string.
+ * @throws {Error} If the provided type is neither a string nor a constructor function.
+ */
 function getTypeName(type) {
     if (typeof type === 'string') {
         return type;
     }
+    // Handle constructor functions/classes
     if (typeof type === 'function') {
         return type.name;
     }
     throw new Error('Type must be a string or a constructor function');
 }
+/**
+ * Retrieves the design type metadata of a specified property from a class constructor.
+ *
+ * @param constructor - The class constructor from which to retrieve the property type.
+ * @param field - The name of the property whose type metadata is to be retrieved.
+ * @returns The type metadata of the specified property, or `undefined` if not found.
+ *
+ * @remarks
+ * This function relies on TypeScript's "emitDecoratorMetadata" feature and the Reflect Metadata API.
+ * Ensure that the "reflect-metadata" polyfill is imported and that "emitDecoratorMetadata" is enabled in your tsconfig.
+ */
 function getPropertyType(constructor, field) {
     return Reflect.getMetadata('design:type', constructor.prototype, field);
 }

package/dist/helpers/types.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.helper.js","sourceRoot":"","sources":["../../src/helpers/types.helper.ts"],"names":[],"mappings":";;AASA,kCAWG;AAaH,0CAGC;AA3BD,SAAgB,WAAW,CAAC,IAAuB;IAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAGD,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;AACrE,CAAC;AAaH,SAAgB,eAAe,CAAC,WAAuB,EAAE,KAAY;IAEnE,OAAO,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC1E,CAAC"}
+{"version":3,"file":"types.helper.js","sourceRoot":"","sources":["../../src/helpers/types.helper.ts"],"names":[],"mappings":";;AASA,kCAWG;AAaH,0CAGC;AAlCD;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,IAAuB;IAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uCAAuC;IACvC,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;AACrE,CAAC;AAEH;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,WAAuB,EAAE,KAAY;IAEnE,OAAO,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC1E,CAAC"}

package/dist/interfaces/services/crud-service.interface.d.ts

@@ -1,12 +1,59 @@
 import { DeepPartial } from '../../types';
 import { Context, IdTypeFrom, Entity } from "../misc";
 import { DataService } from "./data-service.interface";
+/**
+ * Interface defining Create, Update, and Delete (CUD) operations for a service.
+ *
+ * @typeParam IdType - The type of the entity's identifier.
+ * @typeParam EntityType - The type of the entity managed by the service.
+ * @typeParam CreateInputType - The type of the input used for creating an entity.
+ * @typeParam UpdateInputType - The type of the input used for updating an entity.
+ * @typeParam ContextType - The type of the context passed to each operation (defaults to `Context`).
+ *
+ * @remarks
+ * This interface abstracts the basic CUD operations for entities, allowing implementations to define
+ * how entities are created, updated, and removed (both soft and hard deletes).
+ *
+ * @method create - Creates a new entity using the provided input and context.
+ * @param context - The operation context.
+ * @param createInput - The data required to create the entity.
+ * @returns A promise resolving to the created entity.
+ *
+ * @method update - Updates an existing entity identified by `id` with the provided input and context.
+ * @param context - The operation context.
+ * @param id - The identifier of the entity to update.
+ * @param updateInput - The data to update the entity with.
+ * @returns A promise resolving to the updated entity.
+ *
+ * @method remove - Performs a soft delete of the entity identified by `id` in the given context.
+ * @param context - The operation context.
+ * @param id - The identifier of the entity to remove.
+ * @returns A promise resolving to the removed entity.
+ *
+ * @method hardRemove - Permanently deletes the entity identified by `id` in the given context.
+ * @param context - The operation context.
+ * @param id - The identifier of the entity to hard remove.
+ * @returns A promise resolving to the hard-removed entity.
+ */
 export interface CudService<IdType extends IdTypeFrom<EntityType>, EntityType extends Entity<unknown>, CreateInputType extends DeepPartial<EntityType>, UpdateInputType extends DeepPartial<EntityType>, ContextType extends Context = Context> {
     create(context: ContextType, createInput: CreateInputType): Promise<EntityType>;
     update(context: ContextType, id: IdType, updateInput: UpdateInputType): Promise<EntityType>;
     remove(context: ContextType, id: IdType): Promise<EntityType>;
     hardRemove(context: ContextType, id: IdType): Promise<EntityType>;
 }
+/**
+ * Generic interface for a CRUD (Create, Read, Update, Delete) service.
+ *
+ * @typeParam IdType - The type of the entity's identifier, derived from the entity type.
+ * @typeParam EntityType - The type of the entity managed by the service, extending `Entity<unknown>`.
+ * @typeParam CreateInputType - The type used for creating new entities, typically a partial of `EntityType`.
+ * @typeParam UpdateInputType - The type used for updating entities, typically a partial of `EntityType`.
+ * @typeParam ContextType - The context type for the service, defaults to `Context`.
+ *
+ * @remarks
+ * This interface extends both `DataService` and `CudService`, combining read and write operations
+ * for entities. It is intended to be implemented by services that provide full CRUD functionality.
+ */
 export interface CrudService<IdType extends IdTypeFrom<EntityType>, EntityType extends Entity<unknown>, CreateInputType extends DeepPartial<EntityType>, UpdateInputType extends DeepPartial<EntityType>, ContextType extends Context = Context> extends DataService<IdType, EntityType, ContextType>, CudService<IdType, EntityType, CreateInputType, UpdateInputType, ContextType> {
 }
 //# sourceMappingURL=crud-service.interface.d.ts.map

package/dist/interfaces/services/crud-service.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"crud-service.interface.d.ts","sourceRoot":"","sources":["../../../src/interfaces/services/crud-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAoCvD,MAAM,WAAW,UAAU,CACnB,MAAM,SAAS,UAAU,CAAC,UAAU,CAAC,EACrC,UAAU,SAAS,MAAM,CAAC,OAAO,CAAC,EAClC,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,WAAW,SAAS,OAAO,GAAG,OAAO;IAGjC,MAAM,CACF,OAAO,EAAC,WAAW,EACnB,WAAW,EAAE,eAAe,GACzB,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3B,MAAM,CACF,OAAO,EAAC,WAAW,EACnB,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,eAAe,GACzB,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3B,MAAM,CACF,OAAO,EAAC,WAAW,EACnB,EAAE,EAAE,MAAM,GACP,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3B,UAAU,CACN,OAAO,EAAC,WAAW,EACnB,EAAE,EAAE,MAAM,GACP,OAAO,CAAC,UAAU,CAAC,CAAC;CAE9B;AAeT,MAAM,WAAW,WAAW,CACpB,MAAM,SAAS,UAAU,CAAC,UAAU,CAAC,EACrC,UAAU,SAAS,MAAM,CAAC,OAAO,CAAC,EAClC,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,WAAW,SAAS,OAAO,GAAG,OAAO,CACnC,SAAQ,WAAW,CAAC,MAAM,EAAC,UAAU,EAAC,WAAW,CAAC,EACxC,UAAU,CAAC,MAAM,EAAC,UAAU,EAAC,eAAe,EAAC,eAAe,EAAC,WAAW,CAAC;CAGpF"}
+{"version":3,"file":"crud-service.interface.d.ts","sourceRoot":"","sources":["../../../src/interfaces/services/crud-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,UAAU,CACnB,MAAM,SAAS,UAAU,CAAC,UAAU,CAAC,EACrC,UAAU,SAAS,MAAM,CAAC,OAAO,CAAC,EAClC,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,WAAW,SAAS,OAAO,GAAG,OAAO;IAGjC,MAAM,CACF,OAAO,EAAC,WAAW,EACnB,WAAW,EAAE,eAAe,GACzB,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3B,MAAM,CACF,OAAO,EAAC,WAAW,EACnB,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,eAAe,GACzB,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3B,MAAM,CACF,OAAO,EAAC,WAAW,EACnB,EAAE,EAAE,MAAM,GACP,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3B,UAAU,CACN,OAAO,EAAC,WAAW,EACnB,EAAE,EAAE,MAAM,GACP,OAAO,CAAC,UAAU,CAAC,CAAC;CAE9B;AAET;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,WAAW,CACpB,MAAM,SAAS,UAAU,CAAC,UAAU,CAAC,EACrC,UAAU,SAAS,MAAM,CAAC,OAAO,CAAC,EAClC,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,eAAe,SAAS,WAAW,CAAC,UAAU,CAAC,EAC/C,WAAW,SAAS,OAAO,GAAG,OAAO,CACnC,SAAQ,WAAW,CAAC,MAAM,EAAC,UAAU,EAAC,WAAW,CAAC,EACxC,UAAU,CAAC,MAAM,EAAC,UAAU,EAAC,eAAe,EAAC,eAAe,EAAC,WAAW,CAAC;CAGpF"}

package/dist/interfaces/services/data-service.interface.d.ts

@@ -1,6 +1,25 @@
 import { BooleanType, NotNullableIf, If } from '../../types';
 import { Context, IdTypeFrom, Entity, FindArgs, PaginationResult } from '../misc';
 import { Where } from '../../types/find-args.type';
+/**
+ * Generic interface for a data service that provides CRUD-like operations and transactional support.
+ *
+ * @typeParam IdType - The type of the entity's identifier.
+ * @typeParam EntityType - The type of the entity managed by the service.
+ * @typeParam ContextType - The type of the context object, defaults to `Context`.
+ *
+ * @remarks
+ * This interface abstracts common data access patterns, including retrieval, pagination,
+ * transactional execution, and auditing. It is designed to be implemented by concrete data
+ * service classes that interact with a data source.
+ *
+ * @method findAll - Retrieves all entities matching the given arguments, optionally with pagination.
+ * @method pagination - Retrieves pagination metadata for entities matching the given arguments.
+ * @method findOne - Retrieves a single entity by its identifier, optionally throwing if not found.
+ * @method findOneBy - Retrieves a single entity by a custom condition, optionally throwing if not found.
+ * @method runInTransaction - Executes a function within a transactional context.
+ * @method audit - Records an audit log entry for a specified action.
+ */
 export interface DataService<IdType extends IdTypeFrom<EntityType>, EntityType extends Entity<unknown>, ContextType extends Context = Context> {
     findAll<TBool extends BooleanType = false>(context: ContextType, args?: FindArgs<EntityType>, withPagination?: TBool): Promise<If<TBool, {
         data: EntityType[];

package/dist/interfaces/services/data-service.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-service.interface.d.ts","sourceRoot":"","sources":["../../../src/interfaces/services/data-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAG,QAAQ,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAqBnD,MAAM,WAAW,WAAW,CAC1B,MAAM,SAAS,UAAU,CAAC,UAAU,CAAC,EACrC,UAAU,SAAS,MAAM,CAAC,OAAO,CAAC,EAClC,WAAW,SAAS,OAAO,GAAG,OAAO;IAGrC,OAAO,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EACvC,OAAO,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,EAC3B,cAAc,CAAC,EAAC,KAAK,GACpB,OAAO,CAAE,EAAE,CAAC,KAAK,EAAC;QAAE,IAAI,EAAC,UAAU,EAAE,CAAC;QAAC,UAAU,EAAC,gBAAgB,CAAA;KAAE,EAAC,UAAU,EAAE,CAAC,CAAE,CAAC;IAExF,UAAU,CACR,OAAO,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B,OAAO,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EACvC,OAAO,EAAE,WAAW,EACpB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,KAAK,GACb,OAAO,CAAC,aAAa,CAAC,KAAK,EAAC,UAAU,CAAC,CAAC,CAAC;IAE5C,SAAS,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EACzC,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,MAAM,CAAC,EAAE,KAAK,GACb,OAAO,CAAC,aAAa,CAAC,KAAK,EAAC,UAAU,CAAC,CAAC,CAAC;IAE5C,gBAAgB,CAAC,UAAU,EACzB,OAAO,EAAE,WAAW,EACpB,EAAE,EAAC,CAAC,OAAO,EAAC,WAAW,KAAK,OAAO,CAAC,UAAU,CAAC,GAC/C,OAAO,CAAC,UAAU,CAAC,CAAC;IAEtB,KAAK,CACH,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB"}
+{"version":3,"file":"data-service.interface.d.ts","sourceRoot":"","sources":["../../../src/interfaces/services/data-service.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAG,QAAQ,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACnF,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAEnD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,WAAW,CAC1B,MAAM,SAAS,UAAU,CAAC,UAAU,CAAC,EACrC,UAAU,SAAS,MAAM,CAAC,OAAO,CAAC,EAClC,WAAW,SAAS,OAAO,GAAG,OAAO;IAGrC,OAAO,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EACvC,OAAO,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,EAC3B,cAAc,CAAC,EAAC,KAAK,GACpB,OAAO,CAAE,EAAE,CAAC,KAAK,EAAC;QAAE,IAAI,EAAC,UAAU,EAAE,CAAC;QAAC,UAAU,EAAC,gBAAgB,CAAA;KAAE,EAAC,UAAU,EAAE,CAAC,CAAE,CAAC;IAExF,UAAU,CACR,OAAO,EAAE,WAAW,EACpB,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAE7B,OAAO,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EACvC,OAAO,EAAE,WAAW,EACpB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,KAAK,GACb,OAAO,CAAC,aAAa,CAAC,KAAK,EAAC,UAAU,CAAC,CAAC,CAAC;IAE5C,SAAS,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EACzC,OAAO,EAAE,WAAW,EACpB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,EACxB,MAAM,CAAC,EAAE,KAAK,GACb,OAAO,CAAC,aAAa,CAAC,KAAK,EAAC,UAAU,CAAC,CAAC,CAAC;IAE5C,gBAAgB,CAAC,UAAU,EACzB,OAAO,EAAE,WAAW,EACpB,EAAE,EAAC,CAAC,OAAO,EAAC,WAAW,KAAK,OAAO,CAAC,UAAU,CAAC,GAC/C,OAAO,CAAC,UAAU,CAAC,CAAC;IAEtB,KAAK,CACH,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB"}

package/dist/pipes/query-transform.pipe.d.ts

@@ -1,4 +1,22 @@
 import { PipeTransform, ArgumentMetadata } from '@nestjs/common';
+/**
+ * A NestJS pipe that transforms query parameters by attempting to parse string values as JSON.
+ * If parsing fails and the value is a numeric string, it converts it to a number.
+ * Otherwise, the original value is retained.
+ *
+ * @implements {PipeTransform}
+ *
+ * @example
+ * // Given a query: ?filter={"name":"John"}&limit="10"
+ * // The pipe will transform:
+ * // { filter: '{"name":"John"}', limit: "10" }
+ * // into:
+ * // { filter: { name: "John" }, limit: 10 }
+ *
+ * @param value - The incoming value to be transformed, typically an object of query parameters.
+ * @param metadata - Metadata about the value being transformed.
+ * @returns The transformed object with parsed values where possible.
+ */
 export declare class QueryTransformPipe implements PipeTransform {
     transform(value: any, metadata: ArgumentMetadata): any;
 }

package/dist/pipes/query-transform.pipe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-transform.pipe.d.ts","sourceRoot":"","sources":["../../src/pipes/query-transform.pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAc,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAqB7E,qBACa,kBAAmB,YAAW,aAAa;IAEtD,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB;CAmBjD"}
+{"version":3,"file":"query-transform.pipe.d.ts","sourceRoot":"","sources":["../../src/pipes/query-transform.pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAc,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAG7E;;;;;;;;;;;;;;;;;GAiBG;AACH,qBACa,kBAAmB,YAAW,aAAa;IAEtD,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB;CAmBjD"}

package/dist/pipes/query-transform.pipe.js

@@ -8,6 +8,24 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryTransformPipe = void 0;
 const common_1 = require("@nestjs/common");
+/**
+ * A NestJS pipe that transforms query parameters by attempting to parse string values as JSON.
+ * If parsing fails and the value is a numeric string, it converts it to a number.
+ * Otherwise, the original value is retained.
+ *
+ * @implements {PipeTransform}
+ *
+ * @example
+ * // Given a query: ?filter={"name":"John"}&limit="10"
+ * // The pipe will transform:
+ * // { filter: '{"name":"John"}', limit: "10" }
+ * // into:
+ * // { filter: { name: "John" }, limit: 10 }
+ *
+ * @param value - The incoming value to be transformed, typically an object of query parameters.
+ * @param metadata - Metadata about the value being transformed.
+ * @returns The transformed object with parsed values where possible.
+ */
 let QueryTransformPipe = class QueryTransformPipe {
     transform(value, metadata) {
         if (!value)
@@ -18,6 +36,7 @@ let QueryTransformPipe = class QueryTransformPipe {
                 transformed[key] = typeof val === 'string' ? JSON.parse(val) : val;
             }
             catch (e) {
+                // Handle numeric strings
                 if (typeof val === 'string' && !isNaN(Number(val))) {
                     transformed[key] = Number(val);
                 }

package/dist/pipes/query-transform.pipe.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-transform.pipe.js","sourceRoot":"","sources":["../../src/pipes/query-transform.pipe.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA6E;AAsBtE,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAE7B,SAAS,CAAC,KAAU,EAAE,QAA0B;QAC9C,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QAEzB,MAAM,WAAW,GAAG,EAAE,CAAC;QAEvB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC;gBACH,WAAW,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YACrE,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBAEb,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBACjD,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,WAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;gBACzB,CAAC;YACH,CAAC;QACL,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF,CAAA;AArBY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,mBAAU,GAAE;GACA,kBAAkB,CAqB9B"}
+{"version":3,"file":"query-transform.pipe.js","sourceRoot":"","sources":["../../src/pipes/query-transform.pipe.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA6E;AAG7E;;;;;;;;;;;;;;;;;GAiBG;AAEI,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAE7B,SAAS,CAAC,KAAU,EAAE,QAA0B;QAC9C,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QAEzB,MAAM,WAAW,GAAG,EAAE,CAAC;QAEvB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC;gBACH,WAAW,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;YACrE,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,yBAAyB;gBAC3B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBACjD,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACN,WAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;gBACzB,CAAC;YACH,CAAC;QACL,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF,CAAA;AArBY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,mBAAU,GAAE;GACA,kBAAkB,CAqB9B"}

package/dist/types/boolean.type.d.ts

@@ -1,4 +1,22 @@
+/**
+ * Represents a boolean type, restricted to `true` or `false`.
+ */
 export type BooleanType = true | false;
+/**
+ * Conditionally makes a type nullable based on a boolean type.
+ *
+ * @typeParam TBool - A boolean type (`true` or `false`). Defaults to `false`.
+ * @typeParam TType - The type to conditionally make nullable. Defaults to `any`.
+ * @returns `TType` if `TBool` is `true`, otherwise `TType | null`.
+ */
 export type NotNullableIf<TBool extends BooleanType = false, TType = any> = TBool extends true ? TType : TType | null;
+/**
+ * Conditional type that selects between two types based on a boolean type.
+ *
+ * @typeParam TBool - A boolean type (`true` or `false`). Defaults to `false`.
+ * @typeParam TType1 - The type to use if `TBool` is `true`. Defaults to `any`.
+ * @typeParam TType2 - The type to use if `TBool` is `false`. Defaults to `any`.
+ * @returns `TType1` if `TBool` is `true`, otherwise `TType2`.
+ */
 export type If<TBool extends BooleanType = false, TType1 = any, TType2 = any> = TBool extends true ? TType1 : TType2;
 //# sourceMappingURL=boolean.type.d.ts.map

package/dist/types/boolean.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"boolean.type.d.ts","sourceRoot":"","sources":["../../src/types/boolean.type.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,KAAK,CAAC;AASvC,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EAAE,KAAK,GAAG,GAAG,IAAI,KAAK,SAAS,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAUtH,MAAM,MAAM,EAAE,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,KAAK,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"boolean.type.d.ts","sourceRoot":"","sources":["../../src/types/boolean.type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,GAAG,KAAK,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EAAE,KAAK,GAAG,GAAG,IAAI,KAAK,SAAS,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;AAEtH;;;;;;;GAOG;AACH,MAAM,MAAM,EAAE,CAAC,KAAK,SAAS,WAAW,GAAG,KAAK,EAAE,MAAM,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,KAAK,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/types/constructor.type.d.ts

@@ -1,3 +1,15 @@
 export type Constructor = (new (...args: any[]) => any);
+/**
+ * Represents a type that can be constructed with the `new` keyword.
+ *
+ * @typeParam Type - The type of the instance that will be created. Defaults to `object`.
+ *
+ * @example
+ * ```typescript
+ * class MyClass {}
+ * const ctor: Constructable<MyClass> = MyClass;
+ * const instance = new ctor();
+ * ```
+ */
 export type Constructable<Type = object> = new (...args: any[]) => Type;
 //# sourceMappingURL=constructor.type.d.ts.map

package/dist/types/constructor.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constructor.type.d.ts","sourceRoot":"","sources":["../../src/types/constructor.type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAC;AAcxD,MAAM,MAAM,aAAa,CAAC,IAAI,GAAG,MAAM,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC"}
+{"version":3,"file":"constructor.type.d.ts","sourceRoot":"","sources":["../../src/types/constructor.type.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,CAAC;AAExD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,GAAG,MAAM,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC"}

package/dist/types/deep-partial.type.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Recursively makes all properties of a type optional, including nested objects, arrays, maps, and sets.
+ *
+ * - For objects, all properties become optional and are recursively made DeepPartial.
+ * - For arrays, the element type is recursively made DeepPartial.
+ * - For maps, both keys and values are recursively made DeepPartial.
+ * - For sets, the element type is recursively made DeepPartial.
+ * - For primitive types, the type itself is returned.
+ *
+ * @template T The type to make deeply partial.
+ */
 export type DeepPartial<T> = T | (T extends Array<infer U> ? DeepPartial<U>[] : T extends Map<infer K, infer V> ? Map<DeepPartial<K>, DeepPartial<V>> : T extends Set<infer M> ? Set<DeepPartial<M>> : T extends object ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : T);

package/dist/types/deep-partial.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deep-partial.type.d.ts","sourceRoot":"","sources":["../../src/types/deep-partial.type.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG;KACrN,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,GAAG,CAAC,CAAC,CAAC"}
+{"version":3,"file":"deep-partial.type.d.ts","sourceRoot":"","sources":["../../src/types/deep-partial.type.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG;KACrN,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,GAAG,CAAC,CAAC,CAAC"}

package/dist/types/find-args.type.d.ts

@@ -1,12 +1,54 @@
+import { OrderByTypes } from '../enums';
 import { StringFilter, NumberFilter, DateFilter } from './../interfaces/misc/filters.interfaces';
+/**
+ * Represents a flexible filter type for a given field type `T` in query operations.
+ *
+ * - For `string` fields, allows a string, an array of strings, or a `StringFilter` object.
+ * - For `number` fields, allows a number, an array of numbers, or a `NumberFilter` object.
+ * - For `Date` fields, allows a `Date`, an array of `Date`s, or a `DateFilter` object.
+ * - For `boolean` fields, allows a boolean value.
+ * - For all other types, recursively applies the `Where<T>` type.
+ *
+ * This utility type is typically used to define the shape of "where" filter arguments in query builders or ORM-like APIs.
+ *
+ * @template T - The type of the field to generate a filter for.
+ */
 type WhereField<T> = T extends string ? string | string[] | StringFilter : T extends number ? number | number[] | NumberFilter : T extends Date ? Date | Date[] | DateFilter : T extends boolean ? boolean : Where<T>;
+/**
+ * Represents a flexible filter type for querying objects of type `T`.
+ *
+ * - Each property of `T` can be filtered using a corresponding `WhereField`.
+ * - Supports logical composition with `_and` and `_or` operators, allowing for nested and/or conditions.
+ *
+ * @template T The type of the object to filter.
+ * @property {WhereField<T[K]>} [K] Optional filter for each property of `T`.
+ * @property {Where<T> | Where<T>[]} [_and] Optional logical AND composition of filters.
+ * @property {Where<T> | Where<T>[]} [_or] Optional logical OR composition of filters.
+ */
 export type Where<T> = {
     [K in keyof T]?: WhereField<T[K]>;
 } & {
     _and?: Where<T> | Where<T>[];
     _or?: Where<T> | Where<T>[];
 };
-type OrderByField<T> = T extends string ? string : T extends number ? number : T extends Date ? Date : T extends boolean ? boolean : OrderBy<T>;
+/**
+ * Infers the appropriate ordering type for a given field type `T`.
+ *
+ * - If `T` is a `string`, the type is `string`.
+ * - If `T` is a `number`, the type is `number`.
+ * - If `T` is a `Date`, the type is `Date`.
+ * - If `T` is a `boolean`, the type is `boolean`.
+ * - Otherwise, falls back to `OrderBy<T>`, allowing for nested ordering.
+ *
+ * @template T - The type of the field to determine the order-by type for.
+ */
+type OrderByField<T> = T extends string ? OrderByTypes : T extends number ? OrderByTypes : T extends Date ? OrderByTypes : T extends boolean ? OrderByTypes : OrderBy<T>;
+/**
+ * Represents an object for specifying sorting order for each property of type `T`.
+ * Each key of `T` can be optionally assigned an `OrderByField` value to indicate the sort direction.
+ *
+ * @template T - The type whose properties can be used for ordering.
+ */
 export type OrderBy<T> = {
     [K in keyof T]?: OrderByField<T[K]>;
 };

package/dist/types/find-args.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"find-args.type.d.ts","sourceRoot":"","sources":["../../src/types/find-args.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAA;AAehG,KAAK,UAAU,CAAC,CAAC,IACb,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,GACnD,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,GACnD,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,GAAG,UAAU,GAC3C,CAAC,SAAS,OAAO,GAAG,OAAO,GAC3B,KAAK,CAAC,CAAC,CAAC,CAAC;AAab,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;KAClB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpC,GAAG;IACA,IAAI,CAAC,EAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAE;IAC7B,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;CAC/B,CAAC;AAaF,KAAK,YAAY,CAAC,CAAC,IACf,CAAC,SAAS,MAAM,GAAG,MAAM,GACzB,CAAC,SAAS,MAAM,GAAG,MAAM,GACzB,CAAC,SAAS,IAAI,GAAG,IAAI,GACrB,CAAC,SAAS,OAAO,GAAG,OAAO,GAC3B,OAAO,CAAC,CAAC,CAAC,CAAC;AAQf,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACtC,CAAC"}
+{"version":3,"file":"find-args.type.d.ts","sourceRoot":"","sources":["../../src/types/find-args.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAA;AAEhG;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,CAAC,CAAC,IACb,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,GACnD,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,GACnD,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,GAAG,UAAU,GAC3C,CAAC,SAAS,OAAO,GAAG,OAAO,GAC3B,KAAK,CAAC,CAAC,CAAC,CAAC;AAEb;;;;;;;;;;GAUG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI;KAClB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpC,GAAG;IACA,IAAI,CAAC,EAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAE;IAC7B,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,KAAK,YAAY,CAAC,CAAC,IACf,CAAC,SAAS,MAAM,GAAG,YAAY,GAC/B,CAAC,SAAS,MAAM,GAAG,YAAY,GAC/B,CAAC,SAAS,IAAI,GAAG,YAAY,GAC7B,CAAC,SAAS,OAAO,GAAG,YAAY,GAChC,OAAO,CAAC,CAAC,CAAC,CAAC;AAEf;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACtC,CAAC"}

package/dist/utils/decorators.utils.d.ts

@@ -1,3 +1,33 @@
+/**
+ * Applies an array of method decorators to a target method.
+ *
+ * @param decorators - An array of functions that return a `MethodDecorator`.
+ * If the array is falsy, no decorators are applied.
+ * @returns A composite decorator that applies all provided method decorators.
+ */
 export declare function applyMethodDecorators(decorators: (() => MethodDecorator)[]): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+/**
+ * Conditionally applies an array of method decorators based on a boolean value or a function returning a boolean.
+ *
+ * @param condition - A boolean or a function returning a boolean that determines whether the decorators should be applied.
+ * @param decorators - An array of functions that return method decorators to be applied if the condition is true.
+ * @returns The result of applying the decorators if the condition is true; otherwise, returns an empty decorator.
+ */
+export declare function applyMethodDecoratorsIf(condition: boolean | (() => boolean), decorators: (() => MethodDecorator)[]): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+/**
+ * Applies an array of class decorators to a target class.
+ *
+ * @param decorators - An array of functions that return a `ClassDecorator`.
+ * If the array is falsy, no decorators are applied.
+ * @returns A composite decorator that applies all provided class decorators.
+ */
 export declare function applyClassDecorators(decorators: (() => ClassDecorator)[]): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+/**
+ * Conditionally applies an array of class decorators based on a boolean value or a function returning a boolean.
+ *
+ * @param condition - A boolean or a function returning a boolean that determines whether the decorators should be applied.
+ * @param decorators - An array of functions, each returning a `ClassDecorator`, to be applied if the condition is true.
+ * @returns The result of applying the decorators if the condition is true; otherwise, returns the result of `applyDecorators()`.
+ */
+export declare function applyClassDecoratorsIf(condition: boolean | (() => boolean), decorators: (() => ClassDecorator)[]): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
 //# sourceMappingURL=decorators.utils.d.ts.map

package/dist/utils/decorators.utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.utils.d.ts","sourceRoot":"","sources":["../../src/utils/decorators.utils.ts"],"names":[],"mappings":"AAQA,wBAAgB,qBAAqB,CAAC,UAAU,EAAC,CAAC,MAAM,eAAe,CAAC,EAAE,+IAMzE;AASD,wBAAgB,oBAAoB,CAAC,UAAU,EAAC,CAAC,MAAM,cAAc,CAAC,EAAE,+IAMvE"}
+{"version":3,"file":"decorators.utils.d.ts","sourceRoot":"","sources":["../../src/utils/decorators.utils.ts"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,CAAC,MAAM,eAAe,CAAC,EAAE,+IAK1E;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC,MAAM,eAAe,CAAC,EAAE,+IAOlH;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,CAAC,MAAM,cAAc,CAAC,EAAE,+IAKxE;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC,MAAM,cAAc,CAAC,EAAE,+IAOhH"}

package/dist/utils/decorators.utils.js

@@ -1,16 +1,58 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyMethodDecorators = applyMethodDecorators;
+exports.applyMethodDecoratorsIf = applyMethodDecoratorsIf;
 exports.applyClassDecorators = applyClassDecorators;
+exports.applyClassDecoratorsIf = applyClassDecoratorsIf;
 const common_1 = require("@nestjs/common");
+/**
+ * Applies an array of method decorators to a target method.
+ *
+ * @param decorators - An array of functions that return a `MethodDecorator`.
+ * If the array is falsy, no decorators are applied.
+ * @returns A composite decorator that applies all provided method decorators.
+ */
 function applyMethodDecorators(decorators) {
     if (!decorators)
         return (0, common_1.applyDecorators)();
     return (0, common_1.applyDecorators)(...(decorators?.map((decorator) => decorator())));
 }
+/**
+ * Conditionally applies an array of method decorators based on a boolean value or a function returning a boolean.
+ *
+ * @param condition - A boolean or a function returning a boolean that determines whether the decorators should be applied.
+ * @param decorators - An array of functions that return method decorators to be applied if the condition is true.
+ * @returns The result of applying the decorators if the condition is true; otherwise, returns an empty decorator.
+ */
+function applyMethodDecoratorsIf(condition, decorators) {
+    condition = (typeof condition === 'function') ? condition() : condition;
+    if (!condition)
+        return (0, common_1.applyDecorators)();
+    return applyMethodDecorators(decorators);
+}
+/**
+ * Applies an array of class decorators to a target class.
+ *
+ * @param decorators - An array of functions that return a `ClassDecorator`.
+ * If the array is falsy, no decorators are applied.
+ * @returns A composite decorator that applies all provided class decorators.
+ */
 function applyClassDecorators(decorators) {
     if (!decorators)
         return (0, common_1.applyDecorators)();
     return (0, common_1.applyDecorators)(...(decorators?.map((decorator) => decorator())));
 }
+/**
+ * Conditionally applies an array of class decorators based on a boolean value or a function returning a boolean.
+ *
+ * @param condition - A boolean or a function returning a boolean that determines whether the decorators should be applied.
+ * @param decorators - An array of functions, each returning a `ClassDecorator`, to be applied if the condition is true.
+ * @returns The result of applying the decorators if the condition is true; otherwise, returns the result of `applyDecorators()`.
+ */
+function applyClassDecoratorsIf(condition, decorators) {
+    condition = (typeof condition === 'function') ? condition() : condition;
+    if (!condition)
+        return (0, common_1.applyDecorators)();
+    return applyClassDecorators(decorators);
+}
 //# sourceMappingURL=decorators.utils.js.map

package/dist/utils/decorators.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.utils.js","sourceRoot":"","sources":["../../src/utils/decorators.utils.ts"],"names":[],"mappings":";;AAQA,sDAMC;AASD,oDAMC;AA7BD,2CAAiD;AAQjD,SAAgB,qBAAqB,CAAC,UAAoC;IAEtE,IAAG,CAAC,UAAU;QACV,OAAO,IAAA,wBAAe,GAAE,CAAC;IAE7B,OAAO,IAAA,wBAAe,EAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AASD,SAAgB,oBAAoB,CAAC,UAAmC;IAEpE,IAAG,CAAC,UAAU;QACV,OAAO,IAAA,wBAAe,GAAE,CAAC;IAE7B,OAAO,IAAA,wBAAe,EAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC"}
+{"version":3,"file":"decorators.utils.js","sourceRoot":"","sources":["../../src/utils/decorators.utils.ts"],"names":[],"mappings":";;AAQA,sDAKC;AASD,0DAOC;AASD,oDAKC;AASD,wDAOC;AA3DD,2CAAiD;AACjD;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,UAAqC;IACvE,IAAI,CAAC,UAAU;QACX,OAAO,IAAA,wBAAe,GAAE,CAAC;IAE7B,OAAO,IAAA,wBAAe,EAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,uBAAuB,CAAC,SAAoC,EAAE,UAAqC;IAC/G,SAAS,GAAG,CAAC,OAAO,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAExE,IAAI,CAAC,SAAS;QACV,OAAO,IAAA,wBAAe,GAAE,CAAC;IAE7B,OAAO,qBAAqB,CAAC,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,UAAoC;IACrE,IAAI,CAAC,UAAU;QACX,OAAO,IAAA,wBAAe,GAAE,CAAC;IAE7B,OAAO,IAAA,wBAAe,EAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,SAAoC,EAAE,UAAoC;IAC7G,SAAS,GAAG,CAAC,OAAO,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAExE,IAAI,CAAC,SAAS;QACV,OAAO,IAAA,wBAAe,GAAE,CAAC;IAE7B,OAAO,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAC5C,CAAC"}

package/dist/utils/http-status.utils.d.ts

@@ -1,3 +1,12 @@
 import { HttpStatus } from "@nestjs/common";
+/**
+ * Returns a human-readable description for a given HTTP status code.
+ *
+ * If the description for the provided status code is not already cached,
+ * it will be generated, formatted, and stored for future use.
+ *
+ * @param status - The HTTP status code from the `HttpStatus` enum.
+ * @returns The formatted description of the HTTP status, or 'Unknown Status' if not found.
+ */
 export declare function getHttpStatusDescription(status: HttpStatus): string;
 //# sourceMappingURL=http-status.utils.d.ts.map

package/dist/utils/http-status.utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http-status.utils.d.ts","sourceRoot":"","sources":["../../src/utils/http-status.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAoB5C,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAOnE"}
+{"version":3,"file":"http-status.utils.d.ts","sourceRoot":"","sources":["../../src/utils/http-status.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAW5C;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAOnE"}

package/dist/utils/http-status.utils.js

@@ -9,6 +9,15 @@ function formatStatusDescription(status) {
         .replace(/_/g, ' ')
         .replace(/\b\w/g, l => l.toUpperCase());
 }
+/**
+ * Returns a human-readable description for a given HTTP status code.
+ *
+ * If the description for the provided status code is not already cached,
+ * it will be generated, formatted, and stored for future use.
+ *
+ * @param status - The HTTP status code from the `HttpStatus` enum.
+ * @returns The formatted description of the HTTP status, or 'Unknown Status' if not found.
+ */
 function getHttpStatusDescription(status) {
     if (!httpStatusDescriptions.has(status)) {
         const description = formatStatusDescription(status);

package/dist/utils/http-status.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-status.utils.js","sourceRoot":"","sources":["../../src/utils/http-status.utils.ts"],"names":[],"mappings":";;AAoBA,4DAOC;AA3BD,2CAA4C;AAE5C,MAAM,sBAAsB,GAA4B,IAAI,GAAG,EAAsB,CAAC;AAEtF,SAAS,uBAAuB,CAAC,MAAkB;IAC/C,OAAO,mBAAU,CAAC,MAAM,CAAC;SACpB,WAAW,EAAE;SACb,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;SAClB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAChD,CAAC;AAWD,SAAgB,wBAAwB,CAAC,MAAkB;IACvD,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,MAAM,WAAW,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACpD,sBAAsB,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC;AAClE,CAAC"}
+{"version":3,"file":"http-status.utils.js","sourceRoot":"","sources":["../../src/utils/http-status.utils.ts"],"names":[],"mappings":";;AAoBA,4DAOC;AA3BD,2CAA4C;AAE5C,MAAM,sBAAsB,GAA4B,IAAI,GAAG,EAAsB,CAAC;AAEtF,SAAS,uBAAuB,CAAC,MAAkB;IAC/C,OAAO,mBAAU,CAAC,MAAM,CAAC;SACpB,WAAW,EAAE;SACb,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;SAClB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CAAC,MAAkB;IACvD,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,MAAM,WAAW,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACpD,sBAAsB,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,sBAAsB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC;AAClE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solid-nestjs/common",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "solid-nestjs common utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",