@tsed/core 8.18.2 → 8.19.0

package/lib/esm/utils/isBuffer.js

@@ -1,7 +1,8 @@
 /**
- * Tests to see if the object is Buffer
- * @param target
- * @returns {boolean}
+ * Checks if a value is a Buffer or Uint8Array instance.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isBuffer(target) {
     // is Class
@@ -10,6 +11,12 @@ export function isBuffer(target) {
     }
     return isUint8Array(target);
 }
+/**
+ * Checks if a value is the Uint8Array constructor or a Uint8Array instance.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isUint8Array(target) {
     return !!(target && (target === Uint8Array || target instanceof Uint8Array));
 }

package/lib/esm/utils/isClass.js

@@ -6,6 +6,15 @@ import { isClassObject } from "./isPlainObject.js";
 import { isPrimitiveOrPrimitiveClass } from "./isPrimitive.js";
 import { isPromise } from "./isPromise.js";
 import { isSymbol } from "./isSymbol.js";
+/**
+ * Determines whether a given value represents a class (constructor function).
+ *
+ * This helper filters out common non-class values such as primitives, symbols,
+ * plain objects, dates, promises, arrays, buffers, and arrow functions.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isClass(target) {
     if (!target) {
         return false;

package/lib/esm/utils/isCollection.js

@@ -1,8 +1,11 @@
 import { isArrayOrArrayClass } from "./isArray.js";
 /**
- * Return true if the target.
- * @param target
- * @returns {boolean}
+ * Determines whether a value is a collection type (Array, Map, Set, WeakMap, WeakSet).
+ *
+ * Checks both the constructor itself and instances of these collection types.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isCollection(target) {
     return (isArrayOrArrayClass(target) ||

package/lib/esm/utils/isDate.js

@@ -1,7 +1,8 @@
 /**
+ * Checks if a value is the Date constructor or a valid Date instance.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export function isDate(target) {
     return target === Date || (target instanceof Date && !isNaN(+target));

package/lib/esm/utils/isEmpty.js

@@ -1,8 +1,9 @@
 import { isNil } from "./isNil.js";
 /**
- * Return true if the value is an empty string, null or undefined.
- * @param value
- * @returns {boolean}
+ * Checks if a value is an empty string, null, or undefined.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isEmpty(value) {
     return value === "" || isNil(value);

package/lib/esm/utils/isEnumerable.js

@@ -1,9 +1,10 @@
 import { classOf } from "./classOf.js";
 import { inheritedDescriptorOf } from "./inheritedDescriptorOf.js";
 /**
+ * Checks if a property is enumerable on an object, considering its prototype chain.
  *
- * @param obj
- * @param key
+ * @public
+ * @since v7.0.0
  */
 export function isEnumerable(obj, key) {
     const klass = classOf(obj);

package/lib/esm/utils/isFunction.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if a value is a function.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isFunction(target) {
     return typeof target === "function";
 }

package/lib/esm/utils/isInheritedFrom.js

@@ -1,6 +1,12 @@
 import { ancestorOf } from "./ancestorOf.js";
 import { classOf } from "./classOf.js";
 import { nameOf } from "./nameOf.js";
+/**
+ * Checks if a target class inherits from another class within a specified depth limit.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isInheritedFrom(target, from, deep = 5) {
     if (!target || !from) {
         return false;

package/lib/esm/utils/isMomentObject.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if an object is a Moment.js object by verifying the _isAMomentObject property.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isMomentObject(obj) {
     return !!(obj && obj?._isAMomentObject);
 }

package/lib/esm/utils/isMongooseObject.js

@@ -1,7 +1,19 @@
 import { hasJsonMethod } from "./hasJsonMethod.js";
+/**
+ * Checks if an object is a MongoDB ObjectID by verifying the _bsontype property.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isObjectID(obj) {
-    return obj && obj._bsontype;
+    return !!(obj && obj._bsontype);
 }
+/**
+ * Checks if an object is a Mongoose model or MongoDB ObjectID.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isMongooseObject(obj) {
     return !!((hasJsonMethod(obj) && obj.$isMongooseModelPrototype) || isObjectID(obj));
 }

package/lib/esm/utils/isNil.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if a value is null or undefined.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isNil(value) {
     return value === undefined || value === null;
 }

package/lib/esm/utils/isNumber.js

@@ -1,11 +1,18 @@
 /**
+ * Checks if a value is a number primitive.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export function isNumber(target) {
     return typeof target === "number";
 }
+/**
+ * Checks if a value is a number primitive, Number object, or the Number constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isNumberOrNumberClass(target) {
     return typeof target === "number" || target instanceof Number || target === Number;
 }

package/lib/esm/utils/isObject.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if a value is an object type.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isObject(target) {
     return typeof target === "object";
 }

package/lib/esm/utils/isObservable.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if an object is an RxJS Observable by verifying lift and subscribe methods.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isObservable(obj) {
     return !!obj && typeof obj.lift === "function" && typeof obj.subscribe === "function";
 }

package/lib/esm/utils/isPlainObject.js

@@ -1,12 +1,19 @@
 import { classOf } from "./classOf.js";
 /**
+ * Checks if a value is the Object constructor.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export function isClassObject(target) {
     return target === Object;
 }
+/**
+ * Checks if a value is a plain object (not a class instance or constructor).
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isPlainObject(target) {
     return isClassObject(classOf(target)) && target !== Object;
 }

package/lib/esm/utils/isPrimitive.js

@@ -2,22 +2,29 @@ import { isBoolean, isBooleanOrBooleanClass } from "./isBoolean.js";
 import { isNumber, isNumberOrNumberClass } from "./isNumber.js";
 import { isString, isStringOrStringClass } from "./isString.js";
 /**
- * Return true if the given obj is a primitive.
- * @param target
- * @returns {boolean}
- * @ignore
+ * Checks if a value is a primitive or primitive class constructor (String, Number, Boolean).
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isPrimitiveOrPrimitiveClass(target) {
     return isStringOrStringClass(target) || isNumberOrNumberClass(target) || isBooleanOrBooleanClass(target);
 }
 /**
- * Return true if the given obj is a primitive.
- * @param target
- * @returns {boolean}
+ * Checks if a value is a primitive type (string, number, or boolean).
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isPrimitive(target) {
     return isString(target) || isNumber(target) || isBoolean(target);
 }
+/**
+ * Checks if a value is a primitive class constructor (String, Number, or Boolean).
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isPrimitiveClass(target) {
     return [String, Number, Boolean].includes(target);
 }

package/lib/esm/utils/isPromise.js

@@ -1,8 +1,9 @@
 /**
- * Tests to see if the object is an ES2015 (ES6) Promise
+ * Checks if a value is a Promise by verifying the then method exists and it's not an Observable.
+ *
+ * @public
+ * @since v7.0.0
  * @see {@link https://www.ecma-international.org/ecma-262/6.0/#sec-promise-objects}
- * @param target
- * @returns {boolean}
  */
 export function isPromise(target) {
     return (target === Promise ||

package/lib/esm/utils/isProtectedKey.js

@@ -1,6 +1,8 @@
 /**
- * Prevent prototype pollution vulnerability
- * @param key
+ * Checks if a key is a protected property name to prevent prototype pollution vulnerabilities.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isProtectedKey(key) {
     return ["__proto__", "constructor", "prototype"].includes(key);

package/lib/esm/utils/isRegExp.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if a value is a RegExp instance.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isRegExp(target) {
     return target instanceof RegExp;
 }

package/lib/esm/utils/isSerializable.js

@@ -3,6 +3,12 @@ import { isNil } from "./isNil.js";
 import { isNumber } from "./isNumber.js";
 import { isStream } from "./isStream.js";
 import { isString } from "./isString.js";
+/**
+ * Checks if data requires serialization by excluding buffers, streams, and primitive types.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isSerializable(data) {
     return !(Buffer.isBuffer(data) || isStream(data) || isBoolean(data) || isNumber(data) || isString(data) || isNil(data));
 }

package/lib/esm/utils/isStream.js

@@ -1,3 +1,9 @@
+/**
+ * Checks if an object is a Node.js stream by verifying the pipe method exists.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isStream(obj) {
     return obj !== null && typeof obj === "object" && typeof obj.pipe === "function";
 }

package/lib/esm/utils/isString.js

@@ -1,10 +1,18 @@
 /**
- * @param target
- * @returns {boolean}
+ * Checks if a value is a string primitive.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function isString(target) {
     return typeof target === "string";
 }
+/**
+ * Checks if a value is a string primitive, String object, or the String constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isStringOrStringClass(target) {
     return typeof target === "string" || target instanceof String || target === String;
 }

package/lib/esm/utils/isSymbol.js

@@ -1,10 +1,18 @@
 /**
+ * Checks if a value is a symbol primitive.
  *
- * @param target
+ * @public
+ * @since v7.0.0
  */
 export function isSymbol(target) {
     return typeof target === "symbol";
 }
+/**
+ * Checks if a value is a symbol primitive, Symbol object, or the Symbol constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function isSymbolOrSymbolClass(target) {
     return typeof target === "symbol" || target instanceof Symbol || target === Symbol;
 }

package/lib/esm/utils/methodsOf.js

@@ -3,8 +3,10 @@ import { classOf } from "./classOf.js";
 import { isSymbol } from "./isSymbol.js";
 import { prototypeOf } from "./prototypeOf.js";
 /**
- * Return all methods for a given class.
- * @param target
+ * Returns all methods for a given class by traversing its prototype chain.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function methodsOf(target) {
     const methods = new Map();

package/lib/esm/utils/nameOf.js

@@ -1,17 +1,24 @@
 /**
- * Get the provide name.
- * @param targetClass
+ * Gets the name of a class from a constructor function or instance.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function nameOfClass(targetClass) {
     return typeof targetClass === "function" ? targetClass.name : targetClass.constructor.name;
 }
 /**
- * Get symbol name.
- * @param sym
+ * Extracts the name from a symbol by removing the Symbol() wrapper.
+ *
+ * @public
+ * @since v7.0.0
  */
 export const nameOfSymbol = (sym) => sym.toString().replace("Symbol(", "").replace(")", "");
 /**
- * Get object name
+ * Gets the name of any object including symbols, functions, and classes.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function nameOf(obj) {
     switch (typeof obj) {

package/lib/esm/utils/objectKeys.js

@@ -1,4 +1,10 @@
 import { isProtectedKey } from "./isProtectedKey.js";
+/**
+ * Returns object keys excluding protected keys like constructor and prototype.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function objectKeys(obj) {
     return Object.keys(obj).filter((key) => !isProtectedKey(key));
 }

package/lib/esm/utils/primitiveOf.js

@@ -1,6 +1,12 @@
 import { isBooleanOrBooleanClass } from "./isBoolean.js";
 import { isNumberOrNumberClass } from "./isNumber.js";
 import { isStringOrStringClass } from "./isString.js";
+/**
+ * Determines the primitive type name for a given target value or class.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function primitiveOf(target) {
     if (isStringOrStringClass(target)) {
         return "string";

package/lib/esm/utils/prototypeOf.js

@@ -1,8 +1,9 @@
 import { classOf } from "./classOf.js";
 /**
- * Return the prototype of the given class.
- * @param target
- * @returns {any}
+ * Returns the prototype of a given class or instance.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function prototypeOf(target) {
     return classOf(target) === target ? target.prototype : target;

package/lib/esm/utils/setValue.js

@@ -1,4 +1,24 @@
 import { isProtectedKey } from "./isProtectedKey.js";
+/**
+ * Sets a value on an object using a dot-notation expression path.
+ *
+ * Supports both plain objects and Map-like objects (with `.set()`, `.get()`, `.has()` methods).
+ * Automatically creates intermediate objects as needed. Protected keys (`__proto__`, `constructor`, `prototype`) are ignored for security.
+ *
+ * ```typescript
+ * const obj = {};
+ * setValue(obj, "user.name", "John");
+ * // obj is now { user: { name: "John" } }
+ * ```
+ *
+ * @param scope - The target object or Map to set the value on
+ * @param expression - Dot-notation path to the property (e.g., "user.profile.name")
+ * @param value - The value to set at the specified path
+ * @param separator - Path separator character (default: ".")
+ * @returns void
+ * @public
+ * @since v7.0.0
+ */
 export function setValue(scope, expression, value, separator = ".") {
     const keys = expression.split(separator);
     const setValue = (key, add) => {

package/lib/esm/utils/toMap.js

@@ -11,6 +11,12 @@ function createIdentityFn(keyOrFn) {
     }
     return keyOrFn;
 }
+/**
+ * Converts an array or object to a Map using a key extraction strategy.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function toMap(input, keyOrFn) {
     if (isArray(input)) {
         const identity = createIdentityFn(keyOrFn || "id");

package/lib/esm/utils/toStringConstructor.js

@@ -1,4 +1,14 @@
 import { constructorOf } from "./constructorOf.js";
+/**
+ * Returns the textual signature of a class/instance constructor.
+ *
+ * Example output: `constructor(id: string, name?: string)`.
+ * Useful for debugging and documentation generation.
+ *
+ * @param target Instance or constructor.
+ * @returns The constructor signature as a string.
+ * @public
+ */
 export function toStringConstructor(target) {
     const ctr = constructorOf(target);
     const strings = ctr.toString().split("\n");

package/lib/esm/utils/uniq.js

@@ -1,9 +1,18 @@
 /**
- * @param list
+ * Returns a new array with duplicate values removed.
+ *
+ * @public
+ * @since v7.0.0
  */
 export function uniq(list) {
     return Array.from(new Set(list).values());
 }
+/**
+ * Returns a new array with duplicate objects removed based on a specified property key.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function uniqBy(list, key = "id") {
     const map = new Map();
     list.forEach((item) => {

package/lib/esm/utils/useDecorators.js

@@ -1,3 +1,9 @@
+/**
+ * Combines multiple decorators into a single decorator function.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function useDecorators(...decorators) {
     return (...args) => {
         const isMethod = typeof args[2] === "object";

package/lib/esm/utils/useMethodDecorators.js

@@ -1,7 +1,19 @@
 import { descriptorOf } from "./descriptorOf.js";
+/**
+ * Wraps a decorator to ensure it receives the proper method descriptor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function useMethodDecorator(decorator) {
     return (target, propertyKey) => decorator(target, propertyKey, descriptorOf(target, propertyKey));
 }
+/**
+ * Combines multiple method decorators into a single decorator with proper descriptor handling.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export function useMethodDecorators(...decorators) {
     return (target, propertyKey) => {
         decorators.filter(Boolean).forEach((decorator) => decorator(target, propertyKey, descriptorOf(target, propertyKey)));

package/lib/types/decorators/storeFn.d.ts

@@ -1,9 +1,13 @@
 import { DecoratorParameters } from "../types/DecoratorParameters.js";
 import { Store } from "../types/Store.js";
 /**
- * Create a store correctly configured from the parameters given by the decorator.
- * The `fn` can return a decorator that will be initialized with the parameters (target, propertyKey, descriptor).
- * @param {(store: Store, parameters: DecoratorParameters) => void} fn
- * @returns {Function}
+ * Creates a decorator factory that initializes a Store from decorator parameters and invokes a callback.
+ *
+ * The callback receives both the Store instance and the original decorator parameters.
+ * If the callback returns a function, that function is invoked with the same decorator parameters.
+ *
+ * @public
+ * @since v7.0.0
+ * @see Store
  */
 export declare function StoreFn(fn: (store: Store, parameters: DecoratorParameters) => void): Function;

package/lib/types/decorators/storeMerge.d.ts

@@ -1 +1,11 @@
+/**
+ * Creates a decorator that merges a key-value pair into the target's Store metadata.
+ *
+ * Uses {@link Store.merge} internally to deep-merge the provided value with existing metadata.
+ *
+ * @public
+ * @since v7.0.0
+ * @see StoreFn
+ * @see Store
+ */
 export declare function StoreMerge(key: any, value: any): Function;

package/lib/types/decorators/storeSet.d.ts

@@ -1 +1,11 @@
+/**
+ * Creates a decorator that sets a key-value pair in the target's Store metadata.
+ *
+ * Uses {@link Store.set} internally to directly set the provided value (no merging).
+ *
+ * @public
+ * @since v7.0.0
+ * @see StoreFn
+ * @see Store
+ */
 export declare function StoreSet(key: any, value: any): Function;

package/lib/types/errors/UnsupportedDecoratorType.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Error thrown when a decorator is used in an unsupported location or context.
+ *
+ * Provides a descriptive message indicating where the decorator was applied and why it's invalid.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare class UnsupportedDecoratorType extends Error {
     name: "UNSUPPORTED_DECORATOR_TYPE";
     constructor(decorator: any, args: any[]);

package/lib/types/types/AnyDecorator.d.ts

@@ -1 +1,11 @@
+/**
+ * Utility union representing any decorator type supported by TypeScript.
+ *
+ * Used by Ts.ED to type APIs that accept class, method, property or parameter
+ * decorators. This type is handy when a helper must remain generic with regard
+ * to the decorated target.
+ *
+ * @public
+ * @since 8.0.0
+ */
 export type AnyDecorator = any | ClassDecorator | MethodDecorator | PropertyDescriptor | ParameterDecorator;