orator-serviceserver-restify 2.0.9 → 2.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "orator-serviceserver-restify",
-    "version": "2.0.9",
+    "version": "2.0.10",
     "description": "Restify Service Server for Orator",
     "main": "source/Orator-ServiceServer-Restify.js",
     "scripts": {
@@ -46,7 +46,7 @@
     },
     "homepage": "https://github.com/stevenvelozo/orator-serviceserver-restify#readme",
     "dependencies": {
-        "orator-serviceserver-base": "^1.0.6",
+        "orator-serviceserver-base": "^1.0.7",
         "restify": "^11.1.0"
     },
     "devDependencies": {
@@ -54,12 +54,13 @@
         "@types/jquery": "^3.5.33",
         "@types/mocha": "^10.0.10",
         "@types/node": "^16.18.126",
+        "@types/restify": "^8.5.12",
         "@types/sinon": "^17.0.4",
         "eslint": "^9.39.1",
-        "fable": "^3.1.61",
+        "fable": "^3.1.67",
         "globals": "^16.5.0",
-        "orator": "^6.0.2",
-        "quackage": "^1.0.58",
+        "orator": "^6.0.4",
+        "quackage": "^1.0.65",
         "typescript": "^5.9.3"
     }
 }

package/source/Orator-ServiceServer-Restify.js

@@ -5,6 +5,9 @@ const _DefaultRestifyConfiguration =
 {
 	maxParamLength: Number.MAX_SAFE_INTEGER,
 };
+/**
+ * @extends {libOratorServiceServerBase<import('restify').Request, import('restify').Response, import('restify').Server>}
+ */
 class OratorServiceServerRestify extends libOratorServiceServerBase
 {
 	/**
@@ -22,7 +25,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 			(this.fable.settings.hasOwnProperty('RestifyConfiguration')) ? this.fable.settings.RestifyConfiguration :
 			{};
 
-		/** @type {libRestify} */
+		/** @type {import('restify').Server} */
 		this.server = libRestify.createServer(Object.assign({}, _DefaultRestifyConfiguration, tmpRestifyConfiguration));
 	}
 
@@ -68,7 +71,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	/**
 	 * Registers a global handler function to be used by the Orator service server.
 	 *
-	 * @param {import('orator-serviceserver-base').RequestHandler} fHandlerFunction - The handler function to be registered. It should have the prototype function(Request, Response, Next).
+	 * @param {import('orator-serviceserver-base').RequestHandler<import('restify').Request, import('restify').Response>} fHandlerFunction - The handler function to be registered. It should have the prototype function(Request, Response, Next).
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	use(fHandlerFunction)
@@ -85,7 +88,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	/**
 	 * Registers a global handler function to be used by the Orator service server that runs before routing.
 	 *
-	 * @param {function} fHandlerFunction - The handler function to be registered. It should have the prototype function(Request, Response, Next).
+	 * @param {import('orator-serviceserver-base').RequestHandler<import('restify').Request, import('restify').Response>} fHandlerFunction - The handler function to be registered. It should have the prototype function(Request, Response, Next).
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	pre(fHandlerFunction)
@@ -103,7 +106,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Middleware function for parsing the request body.
 	 *
 	 * @param {Record<string, any>} [pOptions] - The options for the body parser.
-	 * @return {import('orator-serviceserver-base').RequestHandler} - The middleware function.
+	 * @return {import('restify').RequestHandler[]} - The middleware function.
 	 */
 	bodyParser(pOptions)
 	{
@@ -143,7 +146,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles HTTP GET requests -- this is a base function that does nothing; override by the serviceserver is expected.
 	 *
 	 * @param {string} pRoute - The route of the request.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions for the route.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions for the route.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doGet(pRoute, ...fRouteProcessingFunctions)
@@ -155,7 +158,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles HTTP PUT requests -- this is a base function that does nothing; override by the serviceserver is expected.
 	 *
 	 * @param {string} pRoute - The route to handle.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions to execute for the route.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to execute for the route.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doPut(pRoute, ...fRouteProcessingFunctions)
@@ -167,7 +170,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles the HTTP POST request for a specific route.
 	 *
 	 * @param {string} pRoute - The route to handle the POST request for.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions to execute for the route.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to execute for the route.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doPost(pRoute, ...fRouteProcessingFunctions)
@@ -179,7 +182,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles HTTP DELETE requests -- this is a base function that does nothing; override by the serviceserver is expected.
 	 *
 	 * @param {string} pRoute - The route of the resource to delete.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions to be executed to delete the resource.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to be executed to delete the resource.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doDel(pRoute, ...fRouteProcessingFunctions)
@@ -191,7 +194,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles HTTP PATCH requests -- this is a base function that does nothing; override by the serviceserver is expected.
 	 *
 	 * @param {string} pRoute - The route to send the PATCH request to.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions to apply to the route.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to apply to the route.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doPatch(pRoute, ...fRouteProcessingFunctions)
@@ -203,7 +206,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles HTTP OPT requests -- this is a base function that does nothing; override by the serviceserver is expected.
 	 *
 	 * @param {string} pRoute - The route.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions to apply to the route.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to apply to the route.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doOpts(pRoute, ...fRouteProcessingFunctions)
@@ -215,7 +218,7 @@ class OratorServiceServerRestify extends libOratorServiceServerBase
 	 * Handles HTTP HEAD requests -- this is a base function that does nothing; override by the serviceserver is expected.
 	 *
 	 * @param {string} pRoute - The route to handle the HEAD request for.
-	 * @param {...Function} fRouteProcessingFunctions - The processing functions to execute for the route.
+	 * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to execute for the route.
 	 * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
 	 */
 	doHead(pRoute, ...fRouteProcessingFunctions)

package/types/Orator-ServiceServer-Restify.d.ts

@@ -1,7 +1,80 @@
 export = OratorServiceServerRestify;
-declare class OratorServiceServerRestify extends libOratorServiceServerBase {
-    /** @type {libRestify} */
-    server: libRestify;
+/**
+ * @extends {libOratorServiceServerBase<import('restify').Request, import('restify').Response, import('restify').Server>}
+ */
+declare class OratorServiceServerRestify extends libOratorServiceServerBase<libRestify.Request, libRestify.Response, libRestify.Server> {
+    /**
+     * @param {import('fable')|Record<string, any>} [pFable] - (optional) The fable instance, or the options object if there is no fable
+     * @param {Record<string, any>|string} [pOptions] - (optional) The options object, or the service hash if there is no fable
+     * @param {string} [pServiceHash] - (optional) The service hash to identify this service instance
+     */
+    constructor(pFable?: any | Record<string, any>, pOptions?: Record<string, any> | string, pServiceHash?: string);
+    /** @type {import('restify').Server} */
+    server: import("restify").Server;
+    /**
+     * Middleware function for parsing the request body.
+     *
+     * @param {Record<string, any>} [pOptions] - The options for the body parser.
+     * @return {import('restify').RequestHandler[]} - The middleware function.
+     */
+    bodyParser(pOptions?: Record<string, any>): import("restify").RequestHandler[];
+    /**
+     * Handles HTTP GET requests -- this is a base function that does nothing; override by the serviceserver is expected.
+     *
+     * @param {string} pRoute - The route of the request.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions for the route.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doGet(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
+    /**
+     * Handles HTTP PUT requests -- this is a base function that does nothing; override by the serviceserver is expected.
+     *
+     * @param {string} pRoute - The route to handle.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to execute for the route.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doPut(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
+    /**
+     * Handles the HTTP POST request for a specific route.
+     *
+     * @param {string} pRoute - The route to handle the POST request for.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to execute for the route.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doPost(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
+    /**
+     * Handles HTTP DELETE requests -- this is a base function that does nothing; override by the serviceserver is expected.
+     *
+     * @param {string} pRoute - The route of the resource to delete.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to be executed to delete the resource.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doDel(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
+    /**
+     * Handles HTTP PATCH requests -- this is a base function that does nothing; override by the serviceserver is expected.
+     *
+     * @param {string} pRoute - The route to send the PATCH request to.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to apply to the route.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doPatch(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
+    /**
+     * Handles HTTP OPT requests -- this is a base function that does nothing; override by the serviceserver is expected.
+     *
+     * @param {string} pRoute - The route.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to apply to the route.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doOpts(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
+    /**
+     * Handles HTTP HEAD requests -- this is a base function that does nothing; override by the serviceserver is expected.
+     *
+     * @param {string} pRoute - The route to handle the HEAD request for.
+     * @param {...import('restify').RequestHandlerType} fRouteProcessingFunctions - The processing functions to execute for the route.
+     * @returns {any} - The result of adding the route to the concrete service provider (ex. a route object, a boolean).
+     */
+    doHead(pRoute: string, ...fRouteProcessingFunctions: import("restify").RequestHandlerType[]): any;
 }
+import libRestify = require("restify");
 import libOratorServiceServerBase = require("orator-serviceserver-base");
 //# sourceMappingURL=Orator-ServiceServer-Restify.d.ts.map

package/types/Orator-ServiceServer-Restify.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Orator-ServiceServer-Restify.d.ts","sourceRoot":"","sources":["../source/Orator-ServiceServer-Restify.js"],"names":[],"mappings":";AAOA;IAiBE,yBAAyB;IACzB,QADW,UAAU,CAC0F;CA0MhH"}
+{"version":3,"file":"Orator-ServiceServer-Restify.d.ts","sourceRoot":"","sources":["../source/Orator-ServiceServer-Restify.js"],"names":[],"mappings":";AAOA;;GAEG;AACH;IAEC;;;;OAIG;IACH,qBAJW,GAAe,GAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,aACnC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAC,MAAM,iBAC1B,MAAM,EAchB;IAFA,uCAAuC;IACvC,QADW,OAAO,SAAS,EAAE,MAAM,CAC4E;IA4EhH;;;;;OAKG;IACH,sBAHW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAClB,OAAO,SAAS,EAAE,cAAc,EAAE,CA+B7C;IAKD;;;;;;OAMG;IACH,cAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;IAED;;;;;;OAMG;IACH,cAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;IAED;;;;;;OAMG;IACH,eAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;IAED;;;;;;OAMG;IACH,cAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;IAED;;;;;;OAMG;IACH,gBAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;IAED;;;;;;OAMG;IACH,eAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;IAED;;;;;;OAMG;IACH,eAJW,MAAM,gCACH,OAAO,SAAS,EAAE,kBAAkB,EAAA,GACrC,GAAG,CAKf;CAID"}