@avleon/core 0.0.20 → 0.0.25

package/dist/index.d.ts

@@ -7,7 +7,7 @@
 import * as sw from "./swagger-schema";
 export * from "./icore";
 export * from "./testing";
-export { inject, validateRequestBody } from "./helpers";
+export { inject, validateRequestBody, pick, exclude } from "./helpers";
 export * from "./decorators";
 export * from "./middleware";
 export * from "./config";
@@ -20,7 +20,7 @@ export * from "./validation";
 export * from "./environment-variables";
 export * from "./collection";
 export * from "./queue";
-export * from "./security";
+export * from "./utils/hash";
 export * from "./multipart";
 export * from "./file-storage";
 export * from "./logger";

package/dist/index.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Container = exports.GetSchema = exports.validateRequestBody = exports.inject = void 0;
+exports.Container = exports.GetSchema = exports.exclude = exports.pick = exports.validateRequestBody = exports.inject = void 0;
 /**
  * @copyright 2024
  * @author Tareq Hossain
@@ -52,6 +52,8 @@ __exportStar(require("./testing"), exports);
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "inject", { enumerable: true, get: function () { return helpers_1.inject; } });
 Object.defineProperty(exports, "validateRequestBody", { enumerable: true, get: function () { return helpers_1.validateRequestBody; } });
+Object.defineProperty(exports, "pick", { enumerable: true, get: function () { return helpers_1.pick; } });
+Object.defineProperty(exports, "exclude", { enumerable: true, get: function () { return helpers_1.exclude; } });
 __exportStar(require("./decorators"), exports);
 __exportStar(require("./middleware"), exports);
 __exportStar(require("./config"), exports);
@@ -64,7 +66,7 @@ __exportStar(require("./validation"), exports);
 __exportStar(require("./environment-variables"), exports);
 __exportStar(require("./collection"), exports);
 __exportStar(require("./queue"), exports);
-__exportStar(require("./security"), exports);
+__exportStar(require("./utils/hash"), exports);
 __exportStar(require("./multipart"), exports);
 __exportStar(require("./file-storage"), exports);
 __exportStar(require("./logger"), exports);

package/dist/middleware.js

@@ -41,14 +41,6 @@ function Middleware(target) {
     }
     (0, typedi_1.Service)()(target);
 }
-// export function CurrentUser(): ParameterDecorator {
-//   return (target, propertyKey, parameterIndex) => {
-//     const existingMetadata =
-//       Reflect.getMetadata("currentUser:params", target, propertyKey!) || [];
-//     existingMetadata.push(parameterIndex);
-//     Reflect.defineMetadata("currentUser:params", existingMetadata, target, propertyKey!);
-//   };
-// }
 function UseMiddleware(options) {
     return function (target, propertyKey, descriptor) {
         const normalizeMiddleware = (middleware) => typeof middleware === "function" ? new middleware() : middleware;

package/dist/multipart.js

@@ -61,7 +61,10 @@ function UploadFileFromRequest(req, options) {
                 throw new exceptions_1.InternalErrorException("File already exists.");
             }
             await (0, promises_1.pipeline)(f.file, fs_1.default.createWriteStream(fname));
-            return Object.assign(Object.assign({}, f), { filename: (options === null || options === void 0 ? void 0 : options.saveAs) ? options.saveAs : f.filename });
+            return {
+                ...f,
+                filename: (options === null || options === void 0 ? void 0 : options.saveAs) ? options.saveAs : f.filename,
+            };
         }
     }));
 }

package/dist/openapi.d.ts

@@ -4,7 +4,7 @@
  * @email xtrinsic96@gmail.com
  * @url https://github.com/xtareq
  */
-interface InfoObject {
+export interface InfoObject {
     title: string;
     description?: string;
     termsOfService?: string;
@@ -12,23 +12,23 @@ interface InfoObject {
     license?: LicenseObject;
     version: string;
 }
-interface ContactObject {
+export interface ContactObject {
     name?: string;
     url?: string;
     email?: string;
 }
-interface LicenseObject {
+export interface LicenseObject {
     name: string;
     url?: string;
 }
-interface ServerObject {
+export interface ServerObject {
     url: string;
     description?: string;
     variables?: {
         [variable: string]: ServerVariableObject;
     };
 }
-interface ServerVariableObject {
+export interface ServerVariableObject {
     enum?: string[];
     default: string;
     description?: string;
@@ -50,7 +50,7 @@ export type OpenApiUiOptions = {
     "x-express-openapi-additional-middleware"?: (((request: any, response: any, next: any) => Promise<void>) | ((request: any, response: any, next: any) => void))[];
     "x-express-openapi-validation-strict"?: boolean;
 };
-interface PathsObject<T extends {} = {}, P extends {} = {}> {
+export interface PathsObject<T extends {} = {}, P extends {} = {}> {
     [pattern: string]: (PathItemObject<T> & P) | undefined;
 }
 declare enum HttpMethods {
@@ -63,7 +63,7 @@ declare enum HttpMethods {
     PATCH = "patch",
     TRACE = "trace"
 }
-type PathItemObject<T extends {} = {}> = {
+export type PathItemObject<T extends {} = {}> = {
     $ref?: string;
     summary?: string;
     description?: string;
@@ -72,7 +72,7 @@ type PathItemObject<T extends {} = {}> = {
 } & {
     [method in HttpMethods]?: OperationObject<T>;
 };
-type OperationObject<T extends {} = {}> = {
+export type OperationObject<T extends {} = {}> = {
     tags?: string[];
     summary?: string;
     description?: string;
@@ -88,17 +88,17 @@ type OperationObject<T extends {} = {}> = {
     security?: SecurityRequirementObject[];
     servers?: ServerObject[];
 } & T;
-interface ExternalDocumentationObject {
+export interface ExternalDocumentationObject {
     description?: string;
     url: string;
 }
-interface ParameterObject extends ParameterBaseObject {
+export interface ParameterObject extends ParameterBaseObject {
     name: string;
     in: string;
 }
-interface HeaderObject extends ParameterBaseObject {
+export interface HeaderObject extends ParameterBaseObject {
 }
-interface ParameterBaseObject {
+export interface ParameterBaseObject {
     description?: string;
     required?: boolean;
     deprecated?: boolean;
@@ -115,17 +115,17 @@ interface ParameterBaseObject {
         [media: string]: MediaTypeObject;
     };
 }
-type NonArraySchemaObjectType = "boolean" | "object" | "number" | "string" | "integer";
-type ArraySchemaObjectType = "array";
-type SchemaObject = ArraySchemaObject | NonArraySchemaObject;
-interface ArraySchemaObject extends BaseSchemaObject {
+export type NonArraySchemaObjectType = "boolean" | "object" | "number" | "string" | "integer";
+export type ArraySchemaObjectType = "array";
+export type SchemaObject = ArraySchemaObject | NonArraySchemaObject;
+export interface ArraySchemaObject extends BaseSchemaObject {
     type: ArraySchemaObjectType;
     items: ReferenceObject | SchemaObject;
 }
-interface NonArraySchemaObject extends BaseSchemaObject {
+export interface NonArraySchemaObject extends BaseSchemaObject {
     type?: NonArraySchemaObjectType;
 }
-interface BaseSchemaObject {
+export interface BaseSchemaObject {
     title?: string;
     description?: string;
     format?: string;
@@ -162,29 +162,29 @@ interface BaseSchemaObject {
     example?: any;
     deprecated?: boolean;
 }
-interface DiscriminatorObject {
+export interface DiscriminatorObject {
     propertyName: string;
     mapping?: {
         [value: string]: string;
     };
 }
-interface XMLObject {
+export interface XMLObject {
     name?: string;
     namespace?: string;
     prefix?: string;
     attribute?: boolean;
     wrapped?: boolean;
 }
-interface ReferenceObject {
+export interface ReferenceObject {
     $ref: string;
 }
-interface ExampleObject {
+export interface ExampleObject {
     summary?: string;
     description?: string;
     value?: any;
     externalValue?: string;
 }
-interface MediaTypeObject {
+export interface MediaTypeObject {
     schema?: ReferenceObject | SchemaObject;
     example?: any;
     examples?: {
@@ -194,7 +194,7 @@ interface MediaTypeObject {
         [media: string]: EncodingObject;
     };
 }
-interface EncodingObject {
+export interface EncodingObject {
     contentType?: string;
     headers?: {
         [header: string]: ReferenceObject | HeaderObject;
@@ -203,17 +203,17 @@ interface EncodingObject {
     explode?: boolean;
     allowReserved?: boolean;
 }
-interface RequestBodyObject {
+export interface RequestBodyObject {
     description?: string;
     content: {
         [media: string]: MediaTypeObject;
     };
     required?: boolean;
 }
-interface ResponsesObject {
+export interface ResponsesObject {
     [code: string]: ReferenceObject | ResponseObject;
 }
-interface ResponseObject {
+export interface ResponseObject {
     description: string;
     headers?: {
         [header: string]: ReferenceObject | HeaderObject;
@@ -225,7 +225,7 @@ interface ResponseObject {
         [link: string]: ReferenceObject | LinkObject;
     };
 }
-interface LinkObject {
+export interface LinkObject {
     operationRef?: string;
     operationId?: string;
     parameters?: {
@@ -235,13 +235,13 @@ interface LinkObject {
     description?: string;
     server?: ServerObject;
 }
-interface CallbackObject {
+export interface CallbackObject {
     [url: string]: PathItemObject;
 }
-interface SecurityRequirementObject {
+export interface SecurityRequirementObject {
     [name: string]: string[];
 }
-interface ComponentsObject {
+export interface ComponentsObject {
     schemas?: {
         [key: string]: ReferenceObject | SchemaObject;
     };
@@ -270,20 +270,20 @@ interface ComponentsObject {
         [key: string]: ReferenceObject | CallbackObject;
     };
 }
-type SecuritySchemeObject = HttpSecurityScheme | ApiKeySecurityScheme | OAuth2SecurityScheme | OpenIdSecurityScheme;
-interface HttpSecurityScheme {
+export type SecuritySchemeObject = HttpSecurityScheme | ApiKeySecurityScheme | OAuth2SecurityScheme | OpenIdSecurityScheme;
+export interface HttpSecurityScheme {
     type: "http";
     description?: string;
     scheme: string;
     bearerFormat?: string;
 }
-interface ApiKeySecurityScheme {
+export interface ApiKeySecurityScheme {
     type: "apiKey";
     description?: string;
     name: string;
     in: string;
 }
-interface OAuth2SecurityScheme {
+export interface OAuth2SecurityScheme {
     type: "oauth2";
     description?: string;
     flows: {
@@ -318,12 +318,12 @@ interface OAuth2SecurityScheme {
         };
     };
 }
-interface OpenIdSecurityScheme {
+export interface OpenIdSecurityScheme {
     type: "openIdConnect";
     description?: string;
     openIdConnectUrl: string;
 }
-interface TagObject {
+export interface TagObject {
     name: string;
     description?: string;
     externalDocs?: ExternalDocumentationObject;

package/dist/params.js

@@ -24,8 +24,8 @@ function createParamDecorator(type) {
                 index: parameterIndex,
                 key: key ? key : "all",
                 name: paramNames[parameterIndex],
-                required: options.required || false,
-                validate: options.validate || true,
+                required: options.required == undefined ? true : options.required,
+                validate: options.validate == undefined ? true : options.validate,
                 dataType: (0, helpers_1.getDataType)(paramDataType),
                 validatorClass: (0, helpers_1.isClassValidatorClass)(paramDataType),
                 schema: (0, helpers_1.isClassValidatorClass)(paramDataType)

package/dist/response.js

@@ -27,8 +27,12 @@ class HttpResponse {
                 excludeExtraneousValues: true,
             });
             const transformedResult = isPaginated
-                ? Object.assign(Object.assign({}, obj), { data: (0, class_transformer_1.instanceToPlain)(transformedData) }) : { data: (0, class_transformer_1.instanceToPlain)(transformedData) };
-            return Object.assign({ message: "success" }, transformedResult);
+                ? { ...obj, data: (0, class_transformer_1.instanceToPlain)(transformedData) }
+                : { data: (0, class_transformer_1.instanceToPlain)(transformedData) };
+            return {
+                message: "success",
+                ...transformedResult,
+            };
         }
         return { message: "success", data: obj };
     }

package/dist/route-methods.js

@@ -35,7 +35,7 @@ function createRouteDecorator(method = "GET") {
             Reflect.defineMetadata("route:path", path, target, propertyKey);
             Reflect.defineMetadata("route:method", method || "GET", target, propertyKey);
             Reflect.getMetadata(container_1.CONTROLLER_META_KEY, target.constructor);
-            Reflect.defineMetadata(container_1.ROUTE_META_KEY, Object.assign(Object.assign({}, options), { method, path, controller: target.constructor.name }), target, propertyKey);
+            Reflect.defineMetadata(container_1.ROUTE_META_KEY, { ...options, method, path, controller: target.constructor.name }, target, propertyKey);
             if (options) {
                 Reflect.defineMetadata("route:options", options, target, propertyKey);
             }

package/dist/swagger-schema.js

@@ -56,7 +56,10 @@ function generateSwaggerSchema(classType) {
         }
         // Apply OpenApi metadata if present
         if (openApiMeta) {
-            swaggerProperty = Object.assign(Object.assign({}, swaggerProperty), extractOpenApiFields(openApiMeta));
+            swaggerProperty = {
+                ...swaggerProperty,
+                ...extractOpenApiFields(openApiMeta),
+            };
         }
         schema.properties[propertyName] = swaggerProperty;
     });

package/dist/testing.js

@@ -19,7 +19,10 @@ class AvleonTestUtility {
         }
         // Initialize test database if options provided
         if (options === null || options === void 0 ? void 0 : options.dataSourceOptions) {
-            this.testDataSource = new typeorm_1.DataSource(Object.assign(Object.assign({}, options.dataSourceOptions), { logging: false }));
+            this.testDataSource = new typeorm_1.DataSource({
+                ...options.dataSourceOptions,
+                logging: false, // Disable logging during tests
+            });
             await this.testDataSource.initialize();
             await this.testDataSource.synchronize(true); // Create schema
         }
@@ -91,7 +94,7 @@ class AvleonTestBuilder {
      * @param options Test configuration options
      */
     setOptions(options) {
-        this.testOptions = Object.assign(Object.assign({}, this.testOptions), options);
+        this.testOptions = { ...this.testOptions, ...options };
         return this;
     }
     /**
@@ -112,7 +115,7 @@ class AvleonTestBuilder {
             dataSourceOptions: this.testOptions.dataSourceOptions,
         });
         // Map controllers
-        app.mapControllers(this.controllers);
+        app.useControllers(this.controllers);
         // Get test application
         return app.getTestApp();
     }

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './hash';
+export * from './optional-require';

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./hash"), exports);
+__exportStar(require("./optional-require"), exports);

package/dist/utils/optional-require.d.ts

@@ -0,0 +1,8 @@
+export declare function optionalRequire<T = any>(moduleName: string, options?: {
+    failOnMissing?: boolean;
+    customMessage?: string;
+}): T | undefined;
+export declare function optionalImport<T = any>(moduleName: string, options?: {
+    failOnMissing?: boolean;
+    customMessage?: string;
+}): Promise<T | undefined>;

package/dist/utils/optional-require.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optionalRequire = optionalRequire;
+exports.optionalImport = optionalImport;
+function optionalRequire(moduleName, options = {}) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return require(moduleName);
+    }
+    catch (err) {
+        if (err.code === "MODULE_NOT_FOUND" && err.message.includes(moduleName)) {
+            if (options.failOnMissing) {
+                throw new Error(options.customMessage ||
+                    `Optional dependency "${moduleName}" is not installed.\nInstall it with:\n\n  npm install ${moduleName}`);
+            }
+            return undefined;
+        }
+        throw err;
+    }
+}
+async function optionalImport(moduleName, options = {}) {
+    try {
+        const mod = await Promise.resolve(`${moduleName}`).then(s => __importStar(require(s)));
+        return mod;
+    }
+    catch (err) {
+        if ((err.code === "ERR_MODULE_NOT_FOUND" || err.code === "MODULE_NOT_FOUND") &&
+            err.message.includes(moduleName)) {
+            if (options.failOnMissing) {
+                throw new Error(options.customMessage ||
+                    `Optional dependency "${moduleName}" is not installed.\nInstall it with:\n\n  npm install ${moduleName}`);
+            }
+            return undefined;
+        }
+        throw err;
+    }
+}

package/dist/validation.d.ts

@@ -25,5 +25,8 @@ export type ValidationRule = StringRule | NumberRule | BooleanRule;
 export type ValidationProps = {
     [key: string]: ValidationRule;
 };
-export declare function validateOrThrow<T extends {}>(obj: T, rules: ValidationProps): any;
+export type ValidateOptons = {
+    location?: 'header' | 'queryparam' | 'param' | 'body' | 'custom';
+};
+export declare function validateOrThrow<T extends {}>(obj: T, rules: ValidationProps, options?: ValidateOptons): any;
 export {};

package/dist/validation.js

@@ -16,9 +16,13 @@ class PValidationRule {
     }
 }
 class Validator {
-    constructor(obj) {
+    constructor(obj, options) {
         this.rules = [];
+        this.options = {};
         this.init(obj);
+        if (options) {
+            this.options = options;
+        }
     }
     init(obj) {
         Object.keys(obj).forEach((key) => {
@@ -26,7 +30,7 @@ class Validator {
             this.rules.push(new PValidationRule(key, rule.type, rule.message));
         });
     }
-    validate(obj) {
+    validate(obj, options) {
         const erors = [];
         this.rules.forEach((k) => {
             const r = Object.keys(obj).find((key) => key == k.name);
@@ -64,7 +68,8 @@ class Validator {
             if (messages.length > 0) {
                 erors.push({
                     path: k.name,
-                    messages: messages,
+                    ...(this.options.location ? { location: this.options.location } : {}),
+                    constraints: messages,
                 });
             }
         });
@@ -94,8 +99,8 @@ const parseBoolean = (val) => {
     }
     return false; // Default for unsupported types (null, undefined, objects, etc.)
 };
-function validateOrThrow(obj, rules) {
-    const valid = new Validator(rules);
+function validateOrThrow(obj, rules, options) {
+    const valid = new Validator(rules, options);
     const errors = valid.validate(obj);
     if (errors[0].length > 0) {
         throw new exceptions_1.BadRequestException(errors[0]);

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@avleon/core",
-  "version": "0.0.20",
+  "version": "0.0.25",
   "main": "./dist/index.js",
+  "types": ["./dist/icore.d.ts"],
   "scripts": {
-    "build": "rimraf dist && tsc",
+    "build": "npm run clean && tsc",
+    "clean": "rimraf dist",
     "watch": "tsc-watch",
     "test": "jest",
     "test:watch": "jest --watch"
   },
-  "keywords": [],
+  "keywords": ["restapi", "avleon", "backend","fastify"],
   "author": "Tareq Hossain",
   "license": "ISC",
   "devDependencies": {
@@ -16,6 +18,7 @@
     "@types/node": "^20.17.25",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
+    "ioredis": "^5.6.1",
     "jest": "^29.7.0",
     "nodemon": "^3.1.7",
     "sharp": "^0.33.5",
@@ -31,21 +34,31 @@
     "@fastify/static": "^8.1.1",
     "@fastify/swagger": "^9.4.0",
     "@fastify/swagger-ui": "^5.1.0",
+    "@fastify/view": "^11.0.0",
     "bcryptjs": "^3.0.2",
     "dotenv": "^16.4.7",
     "fastify": "^5.1.0",
+    "highlight.js": "^11.9.0",
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0",
     "reflect-metadata": "^0.2.2",
     "typedi": "^0.10.0"
   },
   "peerDependencies": {
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "typeorm": "^0.3.20"
+    "@scalar/fastify-api-reference": "*",
+    "ioredis": "*",
+    "sharp": "*"
   },
-  "optionalDependencies": {
-    "@scalar/fastify-api-reference": "^1.25.119"
+  "peerDependenciesMeta": {
+    "@scalar/fastify-api-reference": {
+      "optional": true
+    },
+    "ioredis": {
+      "optional": true
+    },
+    "sharp": {
+      "optional": true
+    }
   },
   "directories": {
     "test": "tests"
@@ -54,5 +67,9 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/avleonjs/avleon-core"
-  }
+  },
+  "files": [
+    "dist",
+    "src"
+  ]
 }