vovk 3.0.0-draft.70 → 3.0.0-draft.71

package/dist/createDecorator.js

@@ -10,6 +10,18 @@ function createDecorator(handler, initHandler) {
                 throw new Error(`Unable to decorate: ${propertyKey} is not a function`);
             }
             const sourceMethod = originalMethod._sourceMethod ?? originalMethod;
+            const method = function method(req, params) {
+                const next = async () => {
+                    return (await originalMethod.call(controller, req, params));
+                };
+                return handler ? handler.call(controller, req, next, ...args) : next();
+            };
+            controller[propertyKey] = method;
+            method._controller = controller;
+            method._sourceMethod = sourceMethod;
+            // TODO define internal method type
+            originalMethod._controller = controller;
+            originalMethod?._onSettled?.(controller);
             const handlerSchema = controller._handlers?.[propertyKey] ?? null;
             const initResultReturn = initHandler?.call(controller, ...args);
             const initResult = typeof initResultReturn === 'function' ? initResultReturn(handlerSchema) : initResultReturn;
@@ -23,17 +35,6 @@ function createDecorator(handler, initHandler) {
                     ...(initResult?.custom ? { custom: initResult.custom } : {}),
                 },
             };
-            const method = function method(req, params) {
-                const next = async () => {
-                    return (await originalMethod.call(controller, req, params));
-                };
-                return handler ? handler.call(controller, req, next, ...args) : next();
-            };
-            method._controller = controller;
-            // TODO define internal method type
-            originalMethod._controller = controller;
-            controller[propertyKey] = method;
-            method._sourceMethod = sourceMethod;
         };
     };
 }

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { HttpException } from './HttpException';
 import { createDecorator } from './createDecorator';
 import { StreamJSONResponse } from './StreamJSONResponse';
 import { generateStaticAPI } from './utils/generateStaticAPI';
-import { setClientValidatorsForHandler } from './utils/setClientValidatorsForHandler';
-export { type KnownAny, type VovkClient, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkStreamAsyncIterable, type VovkValidateOnClient, type VovkSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkBody, type VovkQuery, type VovkParams, type VovkYieldType, type VovkReturnType, type VovkClientOptions, type VovkControllerSchema, type VovkHandlerSchema, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, createRPC, generateStaticAPI, openapi, setClientValidatorsForHandler, };
+import { setHandlerValidation } from './utils/setHandlerValidation';
+export { type KnownAny, type VovkClient, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkStreamAsyncIterable, type VovkValidateOnClient, type VovkSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkBody, type VovkQuery, type VovkParams, type VovkYieldType, type VovkReturnType, type VovkClientOptions, type VovkControllerSchema, type VovkHandlerSchema, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, createRPC, generateStaticAPI, openapi, setHandlerValidation, };
 export declare const get: {
     (givenPath?: string | undefined, options?: import("./types").DecoratorOptions | undefined): ReturnType<(givenPath?: string, options?: import("./types").DecoratorOptions) => (givenTarget: KnownAny, propertyKey: string) => void>;
     auto: (options?: import("./types").DecoratorOptions) => (givenTarget: KnownAny, propertyKey: string) => void;

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initVovk = exports.prefix = exports.options = exports.head = exports.del = exports.patch = exports.put = exports.post = exports.get = exports.setClientValidatorsForHandler = exports.openapi = exports.generateStaticAPI = exports.createRPC = exports.createDecorator = exports.createVovkApp = exports.HttpMethod = exports.HttpStatus = exports.HttpException = exports.StreamJSONResponse = void 0;
+exports.initVovk = exports.prefix = exports.options = exports.head = exports.del = exports.patch = exports.put = exports.post = exports.get = exports.setHandlerValidation = exports.openapi = exports.generateStaticAPI = exports.createRPC = exports.createDecorator = exports.createVovkApp = exports.HttpMethod = exports.HttpStatus = exports.HttpException = exports.StreamJSONResponse = void 0;
 const createVovkApp_1 = require("./createVovkApp");
 Object.defineProperty(exports, "createVovkApp", { enumerable: true, get: function () { return createVovkApp_1.createVovkApp; } });
 const types_1 = require("./types");
@@ -19,6 +19,6 @@ const StreamJSONResponse_1 = require("./StreamJSONResponse");
 Object.defineProperty(exports, "StreamJSONResponse", { enumerable: true, get: function () { return StreamJSONResponse_1.StreamJSONResponse; } });
 const generateStaticAPI_1 = require("./utils/generateStaticAPI");
 Object.defineProperty(exports, "generateStaticAPI", { enumerable: true, get: function () { return generateStaticAPI_1.generateStaticAPI; } });
-const setClientValidatorsForHandler_1 = require("./utils/setClientValidatorsForHandler");
-Object.defineProperty(exports, "setClientValidatorsForHandler", { enumerable: true, get: function () { return setClientValidatorsForHandler_1.setClientValidatorsForHandler; } });
+const setHandlerValidation_1 = require("./utils/setHandlerValidation");
+Object.defineProperty(exports, "setHandlerValidation", { enumerable: true, get: function () { return setHandlerValidation_1.setHandlerValidation; } });
 _a = (0, createVovkApp_1.createVovkApp)(), exports.get = _a.get, exports.post = _a.post, exports.put = _a.put, exports.patch = _a.patch, exports.del = _a.del, exports.head = _a.head, exports.options = _a.options, exports.prefix = _a.prefix, exports.initVovk = _a.initVovk;

package/dist/openapi/openapi.js

@@ -8,6 +8,60 @@ const openapiDecorator = (0, createDecorator_1.createDecorator)(null, (openAPIOp
         ...handlerSchema,
         openapi: {
             ...handlerSchema?.openapi,
+            ...(handlerSchema?.validation?.output &&
+                'type' in handlerSchema.validation.output &&
+                'properties' in handlerSchema.validation.output
+                ? {
+                    responses: {
+                        200: {
+                            description: 'description' in handlerSchema.validation.output
+                                ? handlerSchema.validation.output.description
+                                : 'Success',
+                            content: {
+                                'application/json': {
+                                    schema: handlerSchema.validation.output,
+                                },
+                            },
+                        },
+                    },
+                }
+                : {}),
+            ...(handlerSchema?.validation?.body &&
+                'type' in handlerSchema.validation.body &&
+                'properties' in handlerSchema.validation.body
+                ? {
+                    requestBody: {
+                        description: 'description' in handlerSchema.validation.body
+                            ? handlerSchema.validation.body.description
+                            : 'Request body',
+                        required: true,
+                        content: {
+                            'application/json': {
+                                schema: handlerSchema.validation.body,
+                            },
+                        },
+                    },
+                }
+                : {}),
+            ...(handlerSchema?.validation?.query &&
+                'type' in handlerSchema.validation.query &&
+                'properties' in handlerSchema.validation.query
+                ? {
+                    parameters: Object.entries(handlerSchema.validation.query.properties)
+                        .filter(([, propSchema]) => propSchema.type === 'string')
+                        .map(([propName, propSchema]) => ({
+                        name: propName,
+                        in: 'query',
+                        description: propSchema.description || '',
+                        required: handlerSchema.validation?.query.required
+                            ? handlerSchema.validation.query.required.includes(propName)
+                            : false,
+                        schema: {
+                            type: 'string',
+                        },
+                    })),
+                }
+                : {}),
             ...openAPIOperationObject,
         },
     });

package/dist/types.d.ts

@@ -10,6 +10,7 @@ export type VovkHandlerSchema = {
     validation?: {
         query?: KnownAny;
         body?: KnownAny;
+        output?: KnownAny;
     };
     openapi?: OperationObject;
     custom?: Record<string, KnownAny>;

package/dist/utils/setHandlerValidation.d.ts

@@ -0,0 +1,4 @@
+import type { KnownAny, VovkController, VovkHandlerSchema } from '../types';
+export declare function setHandlerValidation(h: ((...args: KnownAny[]) => KnownAny) & {
+    _onSettled?: (controller: VovkController) => void;
+}, validation: Pick<Exclude<VovkHandlerSchema['validation'], undefined>, 'body' | 'query' | 'output'>): Promise<void>;

package/dist/utils/setHandlerValidation.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setHandlerValidation = setHandlerValidation;
+async function setHandlerValidation(h, validation) {
+    h._onSettled = (controller) => {
+        if (!controller) {
+            throw new Error('Error setting client validators. Controller not found. Did you forget to use an HTTP decorator?');
+        }
+        const handlerName = Object.getOwnPropertyNames(controller).find((key) => controller[key]._sourceMethod === h);
+        if (!handlerName) {
+            throw new Error('Error setting client validators. Handler not found.');
+        }
+        controller._handlers = {
+            ...controller._handlers,
+            [handlerName]: {
+                ...controller._handlers[handlerName],
+                validation,
+            },
+        };
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.70",
+  "version": "3.0.0-draft.71",
   "main": "dist/index.js",
   "description": "RESTful RPC for Next.js - Transforms Next.js into a powerful REST API platform with RPC capabilities.",
   "repository": {

package/src/createDecorator.ts

@@ -18,13 +18,30 @@ export function createDecorator<ARGS extends unknown[], REQUEST = VovkRequest>(
       const controller = target as VovkController;
 
       const originalMethod = controller[propertyKey] as ((...args: KnownAny) => KnownAny) & {
-        _sourceMethod?: (...args: KnownAny) => KnownAny;
+        _sourceMethod?: ((...args: KnownAny) => KnownAny);
+        _onSettled?: (controller: VovkController) => void;
       };
       if (typeof originalMethod !== 'function') {
         throw new Error(`Unable to decorate: ${propertyKey} is not a function`);
       }
       const sourceMethod = originalMethod._sourceMethod ?? originalMethod;
 
+      const method = function method(req: REQUEST, params?: unknown) {
+        const next: Next = async () => {
+          return (await originalMethod.call(controller, req, params)) as unknown;
+        };
+
+        return handler ? handler.call(controller, req, next, ...args) : next();
+      };
+
+      controller[propertyKey] = method;
+
+      method._controller = controller;
+      method._sourceMethod = sourceMethod;
+      // TODO define internal method type
+      (originalMethod as unknown as { _controller: VovkController })._controller = controller;
+      originalMethod?._onSettled?.(controller);
+
       const handlerSchema: VovkHandlerSchema | null = controller._handlers?.[propertyKey] ?? null;
       const initResultReturn = initHandler?.call(controller, ...args);
       const initResult = typeof initResultReturn === 'function' ? initResultReturn(handlerSchema) : initResultReturn;
@@ -39,23 +56,6 @@ export function createDecorator<ARGS extends unknown[], REQUEST = VovkRequest>(
           ...(initResult?.custom ? { custom: initResult.custom } : {}),
         },
       };
-
-      const method = function method(req: REQUEST, params?: unknown) {
-        const next: Next = async () => {
-          return (await originalMethod.call(controller, req, params)) as unknown;
-        };
-
-        return handler ? handler.call(controller, req, next, ...args) : next();
-      };
-
-      method._controller = controller;
-
-      // TODO define internal method type
-      (originalMethod as unknown as { _controller: VovkController })._controller = controller;
-
-      controller[propertyKey] = method;
-
-      method._sourceMethod = sourceMethod;
     };
   };
 }

package/src/index.ts

@@ -32,7 +32,7 @@ import { HttpException } from './HttpException';
 import { createDecorator } from './createDecorator';
 import { StreamJSONResponse } from './StreamJSONResponse';
 import { generateStaticAPI } from './utils/generateStaticAPI';
-import { setClientValidatorsForHandler } from './utils/setClientValidatorsForHandler';
+import { setHandlerValidation } from './utils/setHandlerValidation';
 
 export {
   type KnownAny,
@@ -65,7 +65,7 @@ export {
   createRPC,
   generateStaticAPI,
   openapi,
-  setClientValidatorsForHandler,
+  setHandlerValidation,
 };
 
 export const { get, post, put, patch, del, head, options, prefix, initVovk } = createVovkApp();

package/src/openapi/openapi.ts

@@ -4,13 +4,75 @@ import { fromSchema } from './fromSchema';
 
 type OperationObjectWithCustomProperties = OperationObject & {
   [key in `${'x' | 'X'}-${string}`]: any;
-}
+};
+
+type SimpleJsonSchema = {
+  type: 'object';
+  properties: Record<string, any>;
+  required?: string[];
+};
 
 const openapiDecorator = createDecorator(null, (openAPIOperationObject: OperationObjectWithCustomProperties = {}) => {
   return (handlerSchema) => ({
     ...handlerSchema,
     openapi: {
       ...handlerSchema?.openapi,
+      ...(handlerSchema?.validation?.output &&
+      'type' in handlerSchema.validation.output &&
+      'properties' in handlerSchema.validation.output
+        ? {
+            responses: {
+              200: {
+                description:
+                  'description' in handlerSchema.validation.output
+                    ? handlerSchema.validation.output.description
+                    : 'Success',
+                content: {
+                  'application/json': {
+                    schema: handlerSchema.validation.output,
+                  },
+                },
+              },
+            },
+          }
+        : {}),
+      ...(handlerSchema?.validation?.body &&
+      'type' in handlerSchema.validation.body &&
+      'properties' in handlerSchema.validation.body
+        ? {
+            requestBody: {
+              description:
+                'description' in handlerSchema.validation.body
+                  ? handlerSchema.validation.body.description
+                  : 'Request body',
+              required: true,
+              content: {
+                'application/json': {
+                  schema: handlerSchema.validation.body,
+                },
+              },
+            },
+          }
+        : {}),
+      ...(handlerSchema?.validation?.query &&
+      'type' in handlerSchema.validation.query &&
+      'properties' in handlerSchema.validation.query
+        ? {
+            parameters: Object.entries((handlerSchema.validation.query as SimpleJsonSchema).properties)
+              .filter(([, propSchema]) => propSchema.type === 'string')
+              .map(([propName, propSchema]) => ({
+                name: propName,
+                in: 'query',
+                description: propSchema.description || '',
+                required: handlerSchema.validation?.query.required
+                  ? handlerSchema.validation.query.required.includes(propName)
+                  : false,
+                schema: {
+                  type: 'string',
+                },
+              })),
+          }
+        : {}),
       ...openAPIOperationObject,
     },
   });

package/src/types.ts

@@ -10,7 +10,7 @@ export type StaticClass = Function; // eslint-disable-line @typescript-eslint/no
 export type VovkHandlerSchema = {
   path: string;
   httpMethod: string; // HttpMethod type makes JSON incompatible with VovkHandlerSchema type
-  validation?: { query?: KnownAny; body?: KnownAny };
+  validation?: { query?: KnownAny; body?: KnownAny; output?: KnownAny };
   openapi?: OperationObject;
   custom?: Record<string, KnownAny>;
 };

package/src/utils/setHandlerValidation.ts

@@ -0,0 +1,35 @@
+import type { KnownAny, VovkController, VovkHandlerSchema } from '../types';
+
+export async function setHandlerValidation(
+  h: ((...args: KnownAny[]) => KnownAny) & { _onSettled?: (controller: VovkController) => void },
+  validation: Pick<Exclude<VovkHandlerSchema['validation'], undefined>, 'body' | 'query' | 'output'>
+) {
+  h._onSettled = (controller) => {
+    if (!controller) {
+      throw new Error(
+        'Error setting client validators. Controller not found. Did you forget to use an HTTP decorator?'
+      );
+    }
+
+    const handlerName = Object.getOwnPropertyNames(controller).find(
+      (key) =>
+        (
+          controller[key] as {
+            _sourceMethod?: unknown;
+          }
+        )._sourceMethod === h
+    );
+
+    if (!handlerName) {
+      throw new Error('Error setting client validators. Handler not found.');
+    }
+
+    controller._handlers = {
+      ...controller._handlers,
+      [handlerName]: {
+        ...controller._handlers[handlerName],
+        validation,
+      },
+    };
+  };
+}

package/dist/utils/setClientValidatorsForHandler.d.ts

@@ -1,5 +0,0 @@
-import type { KnownAny } from '../types';
-export declare function setClientValidatorsForHandler(h: (...args: KnownAny[]) => KnownAny, validation: {
-    body: unknown;
-    query: unknown;
-}): Promise<void>;

package/dist/utils/setClientValidatorsForHandler.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setClientValidatorsForHandler = setClientValidatorsForHandler;
-function setClientValidatorsForHandler(h, validation) {
-    return new Promise((resolve) => {
-        // the setTimeout is necessary to ensure that the _controller is already defined
-        setTimeout(() => {
-            const controller = h._controller;
-            if (!controller) {
-                throw new Error('Error setting client validators. Controller not found. Did you forget to use an HTTP decorator?');
-            }
-            const handlerName = Object.getOwnPropertyNames(controller).find((key) => controller[key]._sourceMethod === h);
-            if (!handlerName) {
-                throw new Error('Error setting client validators. Handler not found.');
-            }
-            controller._handlers = {
-                ...controller._handlers,
-                [handlerName]: {
-                    ...controller._handlers[handlerName],
-                    validation,
-                },
-            };
-            resolve();
-        }, 0);
-    });
-}

package/src/utils/setClientValidatorsForHandler.ts

@@ -1,45 +0,0 @@
-import type { KnownAny, VovkController } from '../types';
-
-export function setClientValidatorsForHandler(
-  h: (...args: KnownAny[]) => KnownAny,
-  validation: {
-    body: unknown;
-    query: unknown;
-  }
-) {
-  return new Promise<void>((resolve) => {
-    // the setTimeout is necessary to ensure that the _controller is already defined
-    setTimeout(() => {
-      const controller = (h as unknown as { _controller: VovkController })._controller;
-
-      if (!controller) {
-        throw new Error(
-          'Error setting client validators. Controller not found. Did you forget to use an HTTP decorator?'
-        );
-      }
-
-      const handlerName = Object.getOwnPropertyNames(controller).find(
-        (key) =>
-          (
-            controller[key] as {
-              _sourceMethod?: unknown;
-            }
-          )._sourceMethod === h
-      );
-
-      if (!handlerName) {
-        throw new Error('Error setting client validators. Handler not found.');
-      }
-
-      controller._handlers = {
-        ...controller._handlers,
-        [handlerName]: {
-          ...controller._handlers[handlerName],
-          validation,
-        },
-      };
-
-      resolve();
-    }, 0);
-  });
-}