types: validators

Author: icebob

src/cachers/base.js

@@ -16,6 +16,7 @@ const { isObject, isFunction, isDate } = require("../utils");
 /**
  * Import types
  *
+ * @typedef {import("../service-broker")} ServiceBroker
  * @typedef {import("../context")} Context
  * @typedef {import("./base").CacherOptions} CacherOptions
  * @typedef {import("./base")} CacherBaseClass
@@ -50,7 +51,7 @@ class Cacher {
 	/**
 	 * Initialize cacher
 	 *
-	 * @param {any} broker
+	 * @param {ServiceBroker} broker
 	 *
 	 * @memberof Cacher
 	 */

src/cachers/memory.js

@@ -30,7 +30,7 @@ class MemoryCacher extends BaseCacher {
 	/**
 	 * Creates an instance of MemoryCacher.
 	 *
-	 * @param {MemoryCacherOptions} opts
+	 * @param {MemoryCacherOptions?} opts
 	 *
 	 * @memberof MemoryCacher
 	 */

src/validators/base.d.ts

@@ -5,21 +5,27 @@ declare namespace BaseValidator {
 	export type ValidatorNames = "Fastest";
 
 	export interface ValidatorOptions {
-		type: string;
-		options?: Record<string, any>;
+		paramName?: string;
 	}
+
+	export type CheckerFunction = Function & { async: boolean };
 }
+
 declare abstract class BaseValidator {
-	constructor();
+	constructor(opts: BaseValidator.ValidatorOptions);
+
+	broker: ServiceBroker;
+	opts: BaseValidator.ValidatorOptions;
 
 	init(broker: ServiceBroker): void;
 
-	compile(schema: Record<string, any>): Function;
+	abstract compile(schema: Record<string, any>): BaseValidator.CheckerFunction;
+
+	abstract validate(params: Record<string, any>, schema: Record<string, any>): boolean;
 
-	validate(params: Record<string, any>, schema: Record<string, any>): boolean;
+	abstract convertSchemaToMoleculer(schema: any): Record<string, any>;
 
-	middleware(): (handler: ActionHandler, action: ActionSchema) => any;
+	middleware(broker: ServiceBroker);
 
-	convertSchemaToMoleculer(schema: any): Record<string, any>;
 }
 export = BaseValidator;

src/validators/base.js

@@ -1,58 +1,94 @@
 /*
  * moleculer
- * Copyright (c) 2020 MoleculerJS (https://github.com/moleculerjs/moleculer)
+ * Copyright (c) 2023 MoleculerJS (https://github.com/moleculerjs/moleculer)
  * MIT Licensed
  */
 
+/* eslint-disable no-unused-vars */
+
 "use strict";
 
 const { ValidationError } = require("../errors");
 const _ = require("lodash");
 
+/**
+ * Import types
+ *
+ * @typedef {import("../service-broker")} ServiceBroker
+ * @typedef {import("../context")} Context
+ * @typedef {import("./base")} BaseValidatorClass
+ * @typedef {import("./base").ValidatorOptions} ValidatorOptions
+ * @typedef {import("./base").CheckerFunction} CheckerFunction
+ */
+
+/**
+ * Abstract validator class
+ *
+ * @implements {BaseValidatorClass}
+ */
 class BaseValidator {
+	/**
+	 * Creates an instance of Validator.
+	 *
+	 * @param {ValidatorOptions} opts
+	 *
+	 * @memberof Cacher
+	 */
 	constructor(opts) {
+		/** @type {ValidatorOptions} */
 		this.opts = _.defaultsDeep(opts, {
 			paramName: "params"
 		});
 	}
 
+	/**
+	 * Initialize cacher
+	 *
+	 * @param {ServiceBroker} broker
+	 *
+	 * @memberof Cacher
+	 */
 	init(broker) {
 		this.broker = broker;
 	}
 
 	/**
 	 * Compile a validation schema to a checker function.
-	 * @param {any} schema
-	 * @returns {Function}
+	 *
+	 * @param {Record<string, any>} schema
+	 * @returns {CheckerFunction}
 	 */
-	compile(/*schema*/) {
+	compile(schema) {
 		throw new Error("Abstract method");
 	}
 
 	/**
 	 * Validate params againt the schema
-	 * @param {any} params
-	 * @param {any} schema
+	 *
+	 * @param {Record<string, any>} params
+	 * @param {Record<string, any>} schema
 	 * @returns {boolean}
 	 */
-	validate(/*params, schema*/) {
+	validate(params, schema) {
 		throw new Error("Abstract method");
 	}
 
 	/**
 	 * Convert the specific validation schema to
 	 * the Moleculer (fastest-validator) validation schema format.
 	 *
-	 * @param {any} schema
+	 * @param {Record<string, any>} schema
 	 * @returns {Object}
 	 */
-	convertSchemaToMoleculer(/*schema*/) {
+	convertSchemaToMoleculer(schema) {
 		throw new Error("Abstract method");
 	}
 
 	/**
 	 * Register validator as a middleware
 	 *
+	 * @param {ServiceBroker} broker
+	 *
 	 * @memberof BaseValidator
 	 */
 	middleware(broker) {

src/validators/fastest.d.ts

@@ -1,4 +1,22 @@
 import type BaseValidator = require("./base");
 
-declare class FastestValidator extends BaseValidator {}
+declare namespace FastestValidator {
+	export type ValidatorNames = "Fastest";
+
+	export interface FastestValidatorOptions extends BaseValidator.ValidatorOptions {
+		useNewCustomCheckerFunction?: string;
+		[key: string]: any;
+	}
+}
+
+declare class FastestValidator extends BaseValidator {
+	constructor(opts?: FastestValidator.FastestValidatorOptions);
+
+	opts: FastestValidator.FastestValidatorOptions;
+
+	compile(schema: Record<string, any>): BaseValidator.CheckerFunction;
+	validate(params: Record<string, any>, schema: Record<string, any>): boolean;
+	convertSchemaToMoleculer(schema: any): Record<string, any>;
+
+}
 export = FastestValidator;

src/validators/fastest.js

@@ -1,6 +1,6 @@
 /*
  * moleculer
- * Copyright (c) 2020 MoleculerJS (https://github.com/moleculerjs/moleculer)
+ * Copyright (c) 2023 MoleculerJS (https://github.com/moleculerjs/moleculer)
  * MIT Licensed
  */
 
@@ -11,30 +11,57 @@ const { ValidationError } = require("../errors");
 const BaseValidator = require("./base");
 const _ = require("lodash");
 
+/**
+ * Import types
+ *
+ * @typedef {import("../service-broker")} ServiceBroker
+ * @typedef {import("../context")} Context
+ * @typedef {import("./fastest")} FastestValidatorClass
+ * @typedef {import("./fastest").FastestValidatorOptions} FastestValidatorOptions
+ * @typedef {import("./base").CheckerFunction} CheckerFunction
+ * @typedef {import("fastest-validator").default} Validator
+ */
+
+/**
+ * Fastest validator class
+ *
+ * @implements {FastestValidatorClass}
+ */
 class FastestValidator extends BaseValidator {
+	/**
+	 * Creates an instance of FastestValidator.
+	 *
+	 * @param {FastestValidatorOptions} opts
+	 *
+	 */
 	constructor(opts) {
 		super(opts);
+		/** @type {FastestValidatorOptions} */
 		this.opts = _.defaultsDeep(this.opts, {
 			useNewCustomCheckerFunction: true
 		});
+
+		/** @type {Validator} */
+		// @ts-ignore
 		this.validator = new Validator(this.opts);
 	}
 
 	/**
 	 * Compile a validation schema to a checker function.
 	 * Need a clone because FV manipulate the schema (removing $$... props)
 	 *
-	 * @param {any} schema
-	 * @returns {Function}
+	 * @param {Record<string, any>} schema
+	 * @returns {CheckerFunction}
 	 */
 	compile(schema) {
 		return this.validator.compile(_.cloneDeep(schema));
 	}
 
 	/**
 	 * Validate params against the schema
-	 * @param {any} params
-	 * @param {any} schema
+	 *
+	 * @param {Record<string, any>} params
+	 * @param {Record<string, any>} schema
 	 * @returns {boolean}
 	 */
 	validate(params, schema) {
@@ -48,7 +75,7 @@ class FastestValidator extends BaseValidator {
 	 * Convert the specific validation schema to
 	 * the Moleculer (fastest-validator) validation schema format.
 	 *
-	 * @param {any} schema
+	 * @param {Record<string, any>} schema
 	 * @returns {Object}
 	 */
 	convertSchemaToMoleculer(schema) {

src/validators/index.d.ts

@@ -1,5 +1,8 @@
-import BaseValidator = require("./base");
+import Validator = require("./base");
 import type { ValidatorNames, ValidatorOptions } from "./base";
 import FastestValidator = require("./fastest");
 
-export { BaseValidator as Base, FastestValidator as Fastest, ValidatorNames, ValidatorOptions };
+export { Validator as Base, FastestValidator as Fastest, ValidatorNames, ValidatorOptions };
+
+export declare function resolve(opt: Record<string,any>|string): Validator;
+export declare function register(name: string, value: Validator): void;

src/validators/index.js

@@ -1,6 +1,6 @@
 /*
  * moleculer
- * Copyright (c) 2020 MoleculerJS (https://github.com/moleculerjs/moleculer)
+ * Copyright (c) 2023 MoleculerJS (https://github.com/moleculerjs/moleculer)
  * MIT Licensed
  */
 
@@ -25,8 +25,8 @@ function getByName(name) {
 /**
  * Resolve validator by name
  *
- * @param {object|string} opt
- * @returns {Validator}
+ * @param {Record<string,any>|string} opt
+ * @returns {any}
  * @memberof ServiceBroker
  */
 function resolve(opt) {
@@ -49,6 +49,12 @@ function resolve(opt) {
 	return new Validators.Fastest();
 }
 
+/**
+ * Register a custom validator
+ *
+ * @param {string} name
+ * @param {any} value
+ */
 function register(name, value) {
 	Validators[name] = value;
 }