vortez 5.0.0-dev.18 → 5.0.0

package/build/utilities/schema/Schema.js

@@ -0,0 +1,241 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description Provides a comprehensive schema validation and processing system, allowing developers to define complex data structures.
+ * @license Apache-2.0
+ */
+import _SchemaError from './SchemaError.js';
+import _JSONSchema from './JSONSchema.js';
+import _Introspection from './Introspection.js';
+import _Validator from './Validator.js';
+export { SchemaError } from './SchemaError.js';
+export { JSONSchema } from './JSONSchema.js';
+export { Introspection } from './Introspection.js';
+export { Validator } from './Validator.js';
+export class Schema {
+    schema;
+    constructor(schema) {
+        this.schema = schema;
+        Schema.Validator.validateStructure(schema);
+    }
+    /**
+     * Get the inferred type of the schema.
+     *
+     * ⚠️ IMPORTANT: This getter returns an EMPTY object. It is designed ONLY for type inference.
+     *
+     * Usage: Use with `typeof` to extract the inferred type:
+     * ```typescript
+     * type infered = typeof schemaInstance.infer;
+     * ```
+     *
+     * DO NOT use the returned value at runtime - it's always an empty object.
+     * This is purely a TypeScript type utility.
+     *
+     * @returns An empty object with the inferred type
+     */
+    get infer() {
+        return {};
+    }
+    /**
+     * Get the inferred type of the schema for processing (i.e., before applying defaults and handling optional properties).
+     *
+     * ⚠️ IMPORTANT: This getter returns an EMPTY object. It is designed ONLY for type inference.
+     *
+     * Usage: Use with `typeof` to extract the inferred type for processing:
+     * ```typescript
+     * type inferedToProcess = typeof schemaInstance.inferToProcess;
+     * ```
+     *
+     * DO NOT use the returned value at runtime - it's always an empty object.
+     * This is purely a TypeScript type utility.
+     */
+    get inferToProcess() {
+        return {};
+    }
+    /**
+     * get the json schema as an object
+     * @returns the json schema
+     */
+    get jsonSchema() { return this.toJsonSchema(); }
+    /**
+     * get the json schema as a JSON string
+     * @returns the json schema as a string
+     */
+    get jsonSchemaJSON() { return JSON.stringify(this.jsonSchema); }
+    /**
+     * get the list of unique keys
+     * @returns the list of unique keys
+     */
+    get uniques() { return this.listUniques(); }
+    processData(data, partial = false) {
+        const result = {};
+        const iterable = partial ? data : this.schema;
+        for (const key in iterable) {
+            if (!this.isKeyOf(this.schema, key))
+                throw new Schema.SchemaError(`Unknown property ${String(key)}`);
+            const prop = this.schema[key];
+            const value = this.isKeyOf(data, key) ? data[key] : undefined;
+            result[key] = this.processProperty(value, prop, key, partial);
+            if (result[key] === undefined)
+                delete result[key];
+        }
+        return result;
+    }
+    processPartialData(data) {
+        const result = {};
+        let currentProp;
+        for (const key in data) {
+            const value = this.isKeyOf(data, key) ? data[key] : undefined;
+            const subKeys = key.split('.');
+            const firstKey = subKeys.shift();
+            if (!firstKey || !(firstKey in this.schema))
+                throw new Schema.SchemaError(`Unknown property ${firstKey}`);
+            currentProp = this.schema[firstKey];
+            if (subKeys.length === 0)
+                result[key] = this.processProperty(value, currentProp, key);
+            else {
+                if (currentProp.type !== 'object')
+                    throw new Schema.SchemaError(`Property ${key} is not an object`);
+                let objectProp = currentProp;
+                let usedKeys = [];
+                for (const subKey of subKeys) {
+                    usedKeys.push(subKey);
+                    if (!(subKey in objectProp.schema))
+                        throw new Schema.SchemaError(`Unknown property ${firstKey}.${usedKeys.join('.')}`);
+                    currentProp = objectProp.schema[subKey];
+                    if (currentProp.type === 'object')
+                        objectProp = currentProp;
+                }
+                result[key] = this.processProperty(value, currentProp, key);
+            }
+            if (result[key] === undefined)
+                delete result[key];
+        }
+        return result;
+    }
+    /**
+     * process a property
+     * @param data the data to process
+     * @param prop the property to process
+     * @param key the key of the property
+     * @param partial if the data is partial
+     * @returns the processed data
+     * @throws schemaError if the data is not valid
+     */
+    processProperty(data, prop, key, partial = false) {
+        if (data === undefined || data === null) {
+            if ('default' in prop)
+                return prop.default;
+            if (prop.nullable && prop.nullable === true)
+                return null;
+            if (prop.required && prop.required === true)
+                throw new Schema.SchemaError(`Property ${key} is required but not provided`);
+            else
+                return undefined;
+        }
+        switch (prop.type) {
+            case 'string':
+                Schema.Validator.validateString(data, prop, key);
+                return data;
+            case 'number':
+                Schema.Validator.validateNumber(data, prop, key);
+                return data;
+            case 'boolean':
+                Schema.Validator.validateBoolean(data, prop, key);
+                return data;
+            case 'array':
+                Schema.Validator.validateArray(data, prop, key);
+                return this.processArray(data, prop, key);
+            case 'object':
+                Schema.Validator.validateObject(data, prop, key);
+                return this.processObject(data, prop, key, partial);
+            default: throw new Schema.SchemaError(`Unknown type in property ${key}`);
+        }
+    }
+    /**
+     * validate a array
+     * @param value the value to validate
+     * @param prop the property to validate
+     * @param key the key of the property
+     * @returns the data
+     * @throws schemaError if the data is not valid
+     */
+    processArray(value, prop, key) {
+        try {
+            return value.map((item, index) => this.processProperty(item, prop.property, `${key}[${index}]`));
+        }
+        catch (error) {
+            throw new Schema.SchemaError(`Property ${key} is not valid: ${error}`);
+        }
+    }
+    /**
+     * validate a object
+     * @param value the value to validate
+     * @param prop the property to validate
+     * @param key the key of the property
+     * @returns the data
+     * @throws schemaError if the data is not valid
+     */
+    processObject(value, prop, key, partial = false) {
+        const handler = new Schema(prop.schema);
+        try {
+            return handler.processData(value, partial);
+        }
+        catch (error) {
+            throw new Schema.SchemaError(`Property ${key} is not valid: ${error}`);
+        }
+    }
+    /**
+     * validate a array
+     * @param value the value to validate
+     * @param prop the property to validate
+     * @param key the key of the property
+     * @throws schemaError if the data is not valid
+     */
+    validateArray(value, prop, key) {
+        if (value == null && prop.nullable === true)
+            return;
+        if (!Array.isArray(value))
+            throw new Schema.SchemaError(`Property ${key} must be an array`);
+        if (prop.minimum !== undefined && value.length < prop.minimum) {
+            throw new Schema.SchemaError(`Property ${key} must have at least ${prop.minimum} items`);
+        }
+        if (prop.maximum !== undefined && value.length > prop.maximum) {
+            throw new Schema.SchemaError(`Property ${key} must have at most ${prop.maximum} items`);
+        }
+    }
+    /**
+     * generate a list of unique keys
+     * @param doc the schema to validate
+     * @param parentKey the parent key of the schema
+     * @returns a list of unique keys
+    */
+    listUniques(doc, parentKey) {
+        const useDoc = doc ?? this.schema;
+        return Schema.Introspection.listUniques(useDoc, parentKey);
+    }
+    /**
+     * convert a schema to a JSON schema
+     * @param schema the schema to convert
+     * @returns the JSON schema
+    */
+    toJsonSchema(schema) {
+        const useSchema = schema ?? this.schema;
+        return Schema.Introspection.toJsonSchema(useSchema);
+    }
+    /**
+     * -- TYPE GUARD --
+     * verify if the key is in the schema
+     * @param doc the object to verify
+     * @param key the key to verify
+     * @returns true if the key is in the schema
+     */
+    isKeyOf(doc, key) { return key in doc; }
+}
+(function (Schema) {
+    Schema.SchemaError = _SchemaError;
+    Schema.JSONSchema = _JSONSchema;
+    Schema.Introspection = _Introspection;
+    Schema.Validator = _Validator;
+})(Schema || (Schema = {}));
+export default Schema;
+//# sourceMappingURL=Schema.js.map

package/build/utilities/schema/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../../../src/utilities/schema/Schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,YAAY,MAAM,kBAAkB,CAAC;AAC5C,OAAO,WAAW,MAAM,iBAAiB,CAAC;AAC1C,OAAO,cAAc,MAAM,oBAAoB,CAAC;AAChD,OAAO,UAAU,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,MAAM,OAAO,MAAM;IAEK;IADpB,YACoB,MAAS;QAAT,WAAM,GAAN,MAAM,CAAG;QACzB,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAAC,CAAC;IACjD;;;;;;;;;;;;;;OAcG;IACH,IAAW,KAAK;QACZ,OAAO,EAAkC,CAAC;IAC9C,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,IAAW,cAAc;QACrB,OAAO,EAA2C,CAAC;IACvD,CAAC;IACD;;;OAGG;IACH,IAAW,UAAU,KAA+B,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IACjF;;;OAGG;IACH,IAAW,cAAc,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/E;;;OAGG;IACH,IAAW,OAAO,KAAe,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAUtD,WAAW,CAAC,IAAS,EAAE,UAAmB,KAAK;QAClD,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9C,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;gBAAE,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,oBAAoB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrG,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;YAC9D,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAcM,kBAAkB,CAAC,IAAS;QAC/B,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,WAA4B,CAAC;QACjC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC;gBAAE,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;YAC1G,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACpC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;iBACjF,CAAC;gBACF,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ;oBAAE,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,mBAAmB,CAAC,CAAC;gBACpG,IAAI,UAAU,GAAG,WAAW,CAAC;gBAC7B,IAAI,QAAQ,GAAa,EAAE,CAAA;gBAC3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;oBAC3B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACtB,IAAI,CAAC,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC;wBAAE,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,oBAAoB,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBACvH,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACxC,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ;wBAAE,UAAU,GAAG,WAAW,CAAC;gBAChE,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;YAChE,CAAC;YACD,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS;gBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;;OAQG;IACO,eAAe,CAAC,IAAS,EAAE,IAAqB,EAAE,GAAW,EAAE,UAAmB,KAAK;QAC7F,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACtC,IAAI,SAAS,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAC,OAAO,CAAC;YAC3C,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC;YACzD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;gBAAE,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,+BAA+B,CAAC,CAAC;;gBACrH,OAAO,SAAS,CAAC;QAC1B,CAAC;QACD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,QAAQ;gBAAE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,OAAO,IAAI,CAAC;YAC7E,KAAK,QAAQ;gBAAE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,OAAO,IAAI,CAAC;YAC7E,KAAK,SAAS;gBAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,OAAO,IAAI,CAAC;YAC/E,KAAK,OAAO;gBAAE,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACzG,KAAK,QAAQ;gBAAE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;YACrH,OAAO,CAAC,CAAC,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;QAC7E,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACO,YAAY,CAAC,KAAY,EAAE,IAA2B,EAAE,GAAW;QACzE,IAAI,CAAC;YAAC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAE,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;QAAC,CAAC;QAC1G,OAAO,KAAK,EAAE,CAAC;YAAC,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,kBAAkB,KAAK,EAAE,CAAC,CAAC;QAAC,CAAC;IAC7F,CAAC;IACD;;;;;;;OAOG;IACO,aAAa,CAAC,KAAU,EAAE,IAA4B,EAAE,GAAW,EAAE,UAAmB,KAAK;QACnG,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,CAAC;YAAC,OAAO,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAAC,CAAC;QACnD,OAAO,KAAK,EAAE,CAAC;YAAC,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,kBAAkB,KAAK,EAAE,CAAC,CAAC;QAAC,CAAC;IAC7F,CAAC;IACD;;;;;;OAMG;IACO,aAAa,CAAC,KAAU,EAAE,IAA2B,EAAE,GAAW;QACxE,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,OAAO;QACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,mBAAmB,CAAC,CAAC;QAC5F,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5D,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,uBAAuB,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5D,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,GAAG,sBAAsB,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAC;QAC5F,CAAC;IACL,CAAC;IACD;;;;;MAKE;IACQ,WAAW,CAAC,GAAmB,EAAE,SAAkB;QACzD,MAAM,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC;QAClC,OAAO,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IACD;;;;MAIE;IACQ,YAAY,CAAC,MAAsB;QACzC,MAAM,SAAS,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;QACxC,OAAO,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IACD;;;;;;OAMG;IACK,OAAO,CACX,GAAM,EACN,GAAQ,IACQ,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;CAC3C;AAED,WAAiB,MAAM;IACL,kBAAW,GAAG,YAAY,CAAC;IAC3B,iBAAU,GAAG,WAAW,CAAC;IACzB,oBAAa,GAAG,cAAc,CAAC;IAC/B,gBAAS,GAAG,UAAU,CAAC;AAwKzC,CAAC,EA5KgB,MAAM,KAAN,MAAM,QA4KtB;AACD,eAAe,MAAM,CAAC"}

package/build/utilities/schema/SchemaError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description Defines a custom error class for handling schema-related errors in the schema validation and processing system.
+ * @license Apache-2.0
+ */
+export declare class SchemaError extends Error {
+    constructor(message: string);
+}
+export declare namespace SchemaError { }
+export default SchemaError;

package/build/utilities/schema/SchemaError.js

@@ -0,0 +1,13 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description Defines a custom error class for handling schema-related errors in the schema validation and processing system.
+ * @license Apache-2.0
+ */
+export class SchemaError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'schemaError';
+    }
+}
+export default SchemaError;
+//# sourceMappingURL=SchemaError.js.map

package/build/utilities/schema/SchemaError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaError.js","sourceRoot":"","sources":["../../../src/utilities/schema/SchemaError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,OAAO,WAAY,SAAQ,KAAK;IAClC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC9B,CAAC;CACJ;AAED,eAAe,WAAW,CAAC"}

package/build/utilities/schema/Validator.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description Provides utilities for validating the structure of a schema, ensuring that property definitions are consistent and valid according to their types and constraints.
+ * @license Apache-2.0
+ */
+import type { Schema } from './Schema.js';
+export declare class Validator {
+    /**
+     * Validates the structure of a schema, used for validating the structure of a schema and nested objects.
+     * @param schema The schema to validate
+     * @param parentKey The parent key of the schema, used for error messages
+     */
+    static validateStructure(schema: Schema.Schema, parentKey?: string): void;
+    /**
+     * Validates a property definition, used for validating the structure of a schema and nested objects.
+     * @param prop The property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateProperty(prop: Schema.property, key: string): void;
+    /**
+     * Validates a default value against a property definition, used for validating default values.
+     * @param prop The property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateDefaultValue(prop: Schema.property, key: string): void;
+    /**
+     * Validates a string property definition, used for validating nested objects.
+     * @param prop The string property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateStringProperty(prop: Schema.Property.String, key: string): void;
+    /**
+     * Validates a number property definition, used for validating nested objects.
+     * @param prop The number property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateNumberProperty(prop: Schema.Property.Number, key: string): void;
+    /**
+     * Validates an array property definition, used for validating nested arrays.
+     * @param prop The array property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateArrayProperty(prop: Schema.Property.Array, key: string): void;
+    /**
+     * Validates an object property definition, used for validating nested objects.
+     * @param prop The object property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateObjectProperty(prop: Schema.Property.Object, key: string): void;
+    /**
+     * Validates a string value against a string property definition, used for validating default values and nested objects.
+     * @param value The value to validate
+     * @param prop The string property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateString(value: string, prop: Schema.Property.String, key: string): void;
+    /**
+     * Validates a number value against a number property definition, used for validating default values.
+     * @param value The value to validate
+     * @param prop The number property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateNumber(value: number, prop: Schema.Property.Number, key: string): void;
+    /**
+     * Validates a boolean value against a boolean property definition, used for validating default values.
+     * @param value The value to validate
+     * @param prop The boolean property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateBoolean(value: boolean, prop: Schema.Property.Boolean, key: string): void;
+    /**
+     * Validates an object value against an object property definition, used for validating default values and nested objects.
+     * @param value The value to validate
+     * @param prop The object property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateObject(value: any, prop: Schema.Property.Object, key: string): void;
+    /**
+     * Validates an array value against an array property definition, used for validating default values and array items.
+     * @param value The value to validate
+     * @param prop The array property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateArray(value: any, prop: Schema.Property.Array, key: string): void;
+    /**
+     * Validates a value against a property definition, used for validating default values and array items.
+     * @param value The value to validate
+     * @param prop The property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateValue(value: any, prop: Schema.property, key: string): void;
+}
+export declare namespace Validator { }
+export default Validator;

package/build/utilities/schema/Validator.js

@@ -0,0 +1,246 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description Provides utilities for validating the structure of a schema, ensuring that property definitions are consistent and valid according to their types and constraints.
+ * @license Apache-2.0
+ */
+import { SchemaError } from './SchemaError.js';
+export class Validator {
+    /**
+     * Validates the structure of a schema, used for validating the structure of a schema and nested objects.
+     * @param schema The schema to validate
+     * @param parentKey The parent key of the schema, used for error messages
+     */
+    static validateStructure(schema, parentKey) {
+        for (const key in schema) {
+            const prop = schema[key];
+            this.validateProperty(prop, parentKey ? `${parentKey}.${key}` : key);
+        }
+    }
+    /**
+     * Validates a property definition, used for validating the structure of a schema and nested objects.
+     * @param prop The property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateProperty(prop, key) {
+        switch (prop.type) {
+            case 'string':
+                this.validateStringProperty(prop, key);
+                break;
+            case 'number':
+                this.validateNumberProperty(prop, key);
+                break;
+            case 'boolean': break;
+            case 'array':
+                this.validateArrayProperty(prop, key);
+                break;
+            case 'object':
+                this.validateObjectProperty(prop, key);
+                break;
+            default: throw new SchemaError(`Unknown type for property '${key}'`);
+        }
+        if ('default' in prop)
+            this.validateDefaultValue(prop, key);
+    }
+    /**
+     * Validates a default value against a property definition, used for validating default values.
+     * @param prop The property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateDefaultValue(prop, key) {
+        if (prop.default === undefined) {
+            if (!prop.required)
+                return;
+            throw new SchemaError(`Property '${key}' default value cannot be undefined`);
+        }
+        if (prop.default === null) {
+            if (prop.nullable)
+                return;
+            throw new SchemaError(`Property '${key}' default value cannot be null`);
+        }
+        switch (prop.type) {
+            case 'string':
+                this.validateString(prop.default, prop, key);
+                break;
+            case 'number':
+                this.validateNumber(prop.default, prop, key);
+                break;
+            case 'boolean':
+                this.validateBoolean(prop.default, prop, key);
+                break;
+            case 'array':
+                this.validateArray(prop.default, prop, key);
+                break;
+            case 'object':
+                this.validateObject(prop.default, prop, key);
+                break;
+            default: throw new SchemaError(`Unknown type for property '${key}'`);
+        }
+    }
+    /**
+     * Validates a string property definition, used for validating nested objects.
+     * @param prop The string property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateStringProperty(prop, key) {
+        if (prop.enum !== undefined) {
+            if (!Array.isArray(prop.enum) || prop.enum.length === 0) {
+                throw new SchemaError(`Property '${key}' enum must be a non-empty array`);
+            }
+            if (prop.enum.some((value) => typeof value !== 'string')) {
+                throw new SchemaError(`Property '${key}' enum values must be strings`);
+            }
+        }
+        if (prop.maxLength !== undefined && prop.minLength !== undefined && prop.maxLength < prop.minLength) {
+            throw new SchemaError(`Property '${key}' maxLength must be greater than or equal to minLength`);
+        }
+        if (prop.pattern !== undefined && !(prop.pattern instanceof RegExp)) {
+            throw new SchemaError(`Property '${key}' pattern must be a RegExp`);
+        }
+    }
+    /**
+     * Validates a number property definition, used for validating nested objects.
+     * @param prop The number property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateNumberProperty(prop, key) {
+        if (prop.maximum !== undefined && prop.minimum !== undefined && prop.maximum < prop.minimum) {
+            throw new SchemaError(`Property '${key}' maximum must be greater than or equal to minimum`);
+        }
+    }
+    /**
+     * Validates an array property definition, used for validating nested arrays.
+     * @param prop The array property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateArrayProperty(prop, key) {
+        if (prop.maximum !== undefined && prop.minimum !== undefined && prop.maximum < prop.minimum) {
+            throw new SchemaError(`Property '${key}' maximum must be greater than or equal to minimum`);
+        }
+        this.validateProperty(prop.property, `${key}[]`);
+    }
+    /**
+     * Validates an object property definition, used for validating nested objects.
+     * @param prop The object property definition to validate
+     * @param key The key of the property, used for error messages
+     */
+    static validateObjectProperty(prop, key) {
+        this.validateStructure(prop.schema, key);
+    }
+    /**
+     * Validates a string value against a string property definition, used for validating default values and nested objects.
+     * @param value The value to validate
+     * @param prop The string property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateString(value, prop, key) {
+        if (value == null && prop.nullable === true)
+            return;
+        if (typeof value !== 'string')
+            throw new SchemaError(`Property ${key} must be a string`);
+        if (prop.enum !== undefined && !prop.enum.includes(value)) {
+            throw new SchemaError(`Property ${key} must be one of: ${prop.enum.join(', ')}`);
+        }
+        if (prop.minLength !== undefined && value.length < prop.minLength) {
+            throw new SchemaError(`Property ${key} must have a minimum length of ${prop.minLength}`);
+        }
+        if (prop.maxLength !== undefined && value.length > prop.maxLength) {
+            throw new SchemaError(`Property ${key} must have a maximum length of ${prop.maxLength}`);
+        }
+        if (prop.pattern && !prop.pattern.test(value)) {
+            throw new SchemaError(`Property ${key} must match the pattern ${prop.pattern}`);
+        }
+    }
+    /**
+     * Validates a number value against a number property definition, used for validating default values.
+     * @param value The value to validate
+     * @param prop The number property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateNumber(value, prop, key) {
+        if (value == null && prop.nullable === true)
+            return;
+        if (typeof value !== 'number')
+            throw new SchemaError(`Property ${key} must be a number`);
+        if (prop.minimum !== undefined && value < prop.minimum) {
+            throw new SchemaError(`Property ${key} must be greater than or equal to ${prop.minimum}`);
+        }
+        if (prop.maximum !== undefined && value > prop.maximum) {
+            throw new SchemaError(`Property ${key} must be less than or equal to ${prop.maximum}`);
+        }
+    }
+    /**
+     * Validates a boolean value against a boolean property definition, used for validating default values.
+     * @param value The value to validate
+     * @param prop The boolean property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateBoolean(value, prop, key) {
+        if (value == null && prop.nullable === true)
+            return;
+        if (typeof value !== 'boolean')
+            throw new SchemaError(`Property ${key} must be a boolean`);
+    }
+    /**
+     * Validates an object value against an object property definition, used for validating default values and nested objects.
+     * @param value The value to validate
+     * @param prop The object property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateObject(value, prop, key) {
+        if (value == null && prop.nullable === true)
+            return;
+        if (typeof value !== 'object' || Array.isArray(value)) {
+            throw new SchemaError(`Property ${key} must be an object`);
+        }
+        this.validateStructure(prop.schema, key);
+    }
+    /**
+     * Validates an array value against an array property definition, used for validating default values and array items.
+     * @param value The value to validate
+     * @param prop The array property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateArray(value, prop, key) {
+        if (value == null && prop.nullable === true)
+            return;
+        if (!Array.isArray(value))
+            throw new SchemaError(`Property ${key} must be an array`);
+        if (prop.minimum !== undefined && value.length < prop.minimum) {
+            throw new SchemaError(`Property ${key} must have at least ${prop.minimum} items`);
+        }
+        if (prop.maximum !== undefined && value.length > prop.maximum) {
+            throw new SchemaError(`Property ${key} must have at most ${prop.maximum} items`);
+        }
+        value.forEach((item, index) => {
+            this.validateValue(item, prop.property, `${key}[${index}]`);
+        });
+    }
+    /**
+     * Validates a value against a property definition, used for validating default values and array items.
+     * @param value The value to validate
+     * @param prop The property definition to validate against
+     * @param key The key of the property, used for error messages
+     */
+    static validateValue(value, prop, key) {
+        switch (prop.type) {
+            case 'string':
+                this.validateString(value, prop, key);
+                break;
+            case 'number':
+                this.validateNumber(value, prop, key);
+                break;
+            case 'boolean':
+                this.validateBoolean(value, prop, key);
+                break;
+            case 'array':
+                this.validateArray(value, prop, key);
+                break;
+            case 'object':
+                this.validateObject(value, prop, key);
+                break;
+            default: throw new SchemaError(`Unknown type for property '${key}'`);
+        }
+    }
+}
+export default Validator;
+//# sourceMappingURL=Validator.js.map

package/build/utilities/schema/Validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.js","sourceRoot":"","sources":["../../../src/utilities/schema/Validator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,OAAO,SAAS;IAClB;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAqB,EAAE,SAAkB;QACrE,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACzB,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAqB,EAAE,GAAW;QAC7D,QAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,QAAQ;gBAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC7D,KAAK,QAAQ;gBAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC7D,KAAK,SAAS,CAAC,CAAC,MAAM;YACtB,KAAK,OAAO;gBAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC3D,KAAK,QAAQ;gBAAE,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC7D,OAAO,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC,8BAA8B,GAAG,GAAG,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,SAAS,IAAI,IAAI;YAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAChE,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,IAAqB,EAAE,GAAW;QACjE,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAC3B,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,qCAAqC,CAAC,CAAA;QAChF,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ;gBAAE,OAAO;YAC1B,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,gCAAgC,CAAC,CAAC;QAC5E,CAAC;QACD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YACnE,KAAK,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YACnE,KAAK,SAAS;gBAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YACrE,KAAK,OAAO;gBAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YACjE,KAAK,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YACnE,OAAO,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC,8BAA8B,GAAG,GAAG,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAA4B,EAAE,GAAW;QAC1E,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtD,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,kCAAkC,CAAC,CAAC;YAC9E,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;gBACvD,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,+BAA+B,CAAC,CAAC;YAC3E,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAClG,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,wDAAwD,CAAC,CAAC;QACpG,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,YAAY,MAAM,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,4BAA4B,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAA4B,EAAE,GAAW;QAC1E,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1F,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,oDAAoD,CAAC,CAAC;QAChG,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,IAA2B,EAAE,GAAW;QACxE,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC1F,MAAM,IAAI,WAAW,CAAC,aAAa,GAAG,oDAAoD,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;IACrD,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,IAA4B,EAAE,GAAW;QAC1E,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,KAAa,EAAE,IAA4B,EAAE,GAAW;QACjF,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,OAAO;QACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,mBAAmB,CAAC,CAAC;QACzF,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,oBAAoB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAChE,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,kCAAkC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAChE,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,kCAAkC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,2BAA2B,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACpF,CAAC;IACL,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,KAAa,EAAE,IAA4B,EAAE,GAAW;QACjF,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,OAAO;QACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,mBAAmB,CAAC,CAAC;QACzF,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YACrD,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,qCAAqC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YACrD,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,kCAAkC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3F,CAAC;IACL,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,IAA6B,EAAE,GAAW;QACpF,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,OAAO;QACpD,IAAI,OAAO,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,oBAAoB,CAAC,CAAC;IAC/F,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,KAAU,EAAE,IAA4B,EAAE,GAAW;QAC9E,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,OAAO;QACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,oBAAoB,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,KAAU,EAAE,IAA2B,EAAE,GAAW;QAC5E,IAAI,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,OAAO;QACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,mBAAmB,CAAC,CAAC;QACrF,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5D,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,uBAAuB,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAC;QACtF,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5D,MAAM,IAAI,WAAW,CAAC,YAAY,GAAG,sBAAsB,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAC;QACrF,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,GAAG,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,KAAU,EAAE,IAAqB,EAAE,GAAW;QACtE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC5D,KAAK,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC5D,KAAK,SAAS;gBAAE,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC9D,KAAK,OAAO;gBAAE,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC1D,KAAK,QAAQ;gBAAE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;gBAAC,MAAM;YAC5D,OAAO,CAAC,CAAC,MAAM,IAAI,WAAW,CAAC,8BAA8B,GAAG,GAAG,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;CACJ;AAED,eAAe,SAAS,CAAC"}

package/changes.md

@@ -32,6 +32,10 @@
 - **(Server/WebSocket)**: Overhauled the WebSocket connection lifecycle for improved security and developer experience.
   - The `WebSocket` class no longer accepts connections in its constructor. Instead, it waits in a `pending` state.
   - Added `accept()` and `reject()` methods to give the framework full control over the connection handshake.
+- **(Server/Response)**: The `send()`, `sendJson()`, `sendFile()`, `sendFolder()`, and `sendTemplate()` methods are now **async** and return `Promise<void>`. **This is a breaking change.**
+  - All response methods now require `await` in calling code for proper error handling.
+  - Added `sendReadable()` for streaming responses with backpressure support via `stream/promises`.
+  - HTTP range requests (206 Partial Content) are now properly handled in streaming contexts.
 
 # version (4.1.0)
 ## ➕ Added