vovk 3.0.0-draft.65 → 3.0.0-draft.69

package/dist/client/defaultFetcher.js

@@ -17,7 +17,12 @@ const defaultFetcher = async ({ httpMethod, getEndpoint, validate, defaultHandle
             if (e instanceof HttpException_1.HttpException)
                 throw e;
             // otherwise, throw HttpException with status 0
-            throw new HttpException_1.HttpException(types_1.HttpStatus.NULL, e.message ?? exports.DEFAULT_ERROR_MESSAGE, { body, query, params, endpoint });
+            throw new HttpException_1.HttpException(types_1.HttpStatus.NULL, e.message ?? exports.DEFAULT_ERROR_MESSAGE, {
+                body,
+                query,
+                params,
+                endpoint,
+            });
         }
     }
     const init = {
@@ -36,7 +41,12 @@ const defaultFetcher = async ({ httpMethod, getEndpoint, validate, defaultHandle
     }
     catch (e) {
         // handle network errors
-        throw new HttpException_1.HttpException(types_1.HttpStatus.NULL, e?.message ?? exports.DEFAULT_ERROR_MESSAGE, { body, query, params, endpoint });
+        throw new HttpException_1.HttpException(types_1.HttpStatus.NULL, e?.message ?? exports.DEFAULT_ERROR_MESSAGE, {
+            body,
+            query,
+            params,
+            endpoint,
+        });
     }
     const contentType = response.headers.get('content-type');
     if (contentType?.startsWith('application/json')) {

package/dist/client/types.d.ts

@@ -51,7 +51,7 @@ export type VovkClient<T, OPTS extends {
 }> = OmitNever<VovkClientWithNever<T, OPTS>>;
 export type VovkClientFetcher<OPTS extends Record<string, KnownAny> = Record<string, never>, T = KnownAny> = (options: {
     name: keyof T;
-    httpMethod: HttpMethod;
+    httpMethod: `${HttpMethod}`;
     getEndpoint: (data: {
         apiRoot: string;
         params: {

package/dist/createDecorator.js

@@ -19,6 +19,7 @@ function createDecorator(handler, initHandler) {
                     ...handlerSchema,
                     // avoid override of path and httpMethod
                     ...(initResult?.validation ? { validation: initResult.validation } : {}),
+                    ...(initResult?.openapi ? { openapi: initResult.openapi } : {}),
                     ...(initResult?.custom ? { custom: initResult.custom } : {}),
                 },
             };

package/dist/index.d.ts

@@ -1,12 +1,13 @@
 import { createVovkApp } from './createVovkApp';
 import { HttpStatus as HttpStatus, HttpMethod as HttpMethod, type KnownAny, type VovkErrorResponse, type VovkRequest, type VovkBody, type VovkQuery, type VovkParams, type VovkReturnType, type VovkYieldType, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkSchema, type VovkControllerSchema, type VovkHandlerSchema } from './types';
 import { type VovkClient, type VovkClientOptions, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkStreamAsyncIterable, createRPC } from './client';
+import { openapi } from './openapi';
 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, 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, };
 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.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.setClientValidatorsForHandler = 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");
@@ -9,6 +9,8 @@ Object.defineProperty(exports, "HttpStatus", { enumerable: true, get: function (
 Object.defineProperty(exports, "HttpMethod", { enumerable: true, get: function () { return types_1.HttpMethod; } });
 const client_1 = require("./client");
 Object.defineProperty(exports, "createRPC", { enumerable: true, get: function () { return client_1.createRPC; } });
+const openapi_1 = require("./openapi");
+Object.defineProperty(exports, "openapi", { enumerable: true, get: function () { return openapi_1.openapi; } });
 const HttpException_1 = require("./HttpException");
 Object.defineProperty(exports, "HttpException", { enumerable: true, get: function () { return HttpException_1.HttpException; } });
 const createDecorator_1 = require("./createDecorator");

package/dist/openapi/fromSchema.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIObject } from 'openapi3-ts/oas31';
+import type { VovkSchema } from '../types';
+export declare function fromSchema(apiRoot: string, vovkSchema: Record<string, VovkSchema>, extendWith?: Partial<OpenAPIObject>): OpenAPIObject;

package/dist/openapi/fromSchema.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromSchema = fromSchema;
+function fromSchema(apiRoot, vovkSchema, extendWith) {
+    const paths = {};
+    for (const [segmentName, schema] of Object.entries(vovkSchema)) {
+        for (const c of Object.values(schema.controllers)) {
+            for (const h of Object.values(c.handlers)) {
+                if (h.openapi) {
+                    const path = '/' + [apiRoot.replace(/^\/+|\/+$/g, ''), segmentName, c.prefix, h.path].filter(Boolean).join('/');
+                    paths[path] = paths[path] ?? {};
+                    paths[path][h.httpMethod.toLowerCase()] = { ...h.openapi };
+                }
+            }
+        }
+    }
+    return {
+        openapi: '3.1.0',
+        paths,
+        info: extendWith?.info ?? {
+            title: 'API',
+            version: '1.0.0',
+        },
+        ...extendWith,
+    };
+}

package/dist/openapi/index.d.ts

@@ -0,0 +1 @@
+export { openapi } from './openapi';

package/dist/openapi/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openapi = void 0;
+var openapi_1 = require("./openapi");
+Object.defineProperty(exports, "openapi", { enumerable: true, get: function () { return openapi_1.openapi; } });

package/dist/openapi/openapi.d.ts

@@ -0,0 +1,10 @@
+import type { OperationObject } from 'openapi3-ts/oas31';
+import { fromSchema } from './fromSchema';
+type OperationObjectWithCustomProperties = OperationObject & {
+    [key in `${'x' | 'X'}-${string}`]: any;
+};
+declare const openapiDecorator: (openAPIOperationObject?: OperationObjectWithCustomProperties | undefined) => (target: import("..").KnownAny, propertyKey: string) => void;
+export declare const openapi: typeof openapiDecorator & {
+    fromSchema: typeof fromSchema;
+};
+export {};

package/dist/openapi/openapi.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openapi = void 0;
+const createDecorator_1 = require("../createDecorator");
+const fromSchema_1 = require("./fromSchema");
+const openapiDecorator = (0, createDecorator_1.createDecorator)(null, (openAPIOperationObject = {}) => {
+    return (handlerSchema) => ({
+        ...handlerSchema,
+        openapi: {
+            ...handlerSchema?.openapi,
+            ...openAPIOperationObject,
+        },
+    });
+});
+exports.openapi = openapiDecorator;
+exports.openapi.fromSchema = fromSchema_1.fromSchema;

package/dist/types.d.ts

@@ -1,15 +1,17 @@
 import type { NextRequest } from 'next/server';
+import type { OperationObject } from 'openapi3-ts/oas31';
 import type { StreamJSONResponse } from './StreamJSONResponse';
 import { VovkStreamAsyncIterable } from './client/types';
 export type KnownAny = any;
 export type StaticClass = Function;
 export type VovkHandlerSchema = {
     path: string;
-    httpMethod: HttpMethod;
+    httpMethod: `${HttpMethod}`;
     validation?: {
         query?: KnownAny;
         body?: KnownAny;
     };
+    openapi?: OperationObject;
     custom?: Record<string, KnownAny>;
 };
 export type VovkControllerSchema = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.65",
+  "version": "3.0.0-draft.69",
   "main": "dist/index.js",
   "description": "RESTful RPC for Next.js - Transforms Next.js into a powerful REST API platform with RPC capabilities.",
   "repository": {
@@ -27,5 +27,8 @@
   "homepage": "https://vovk.dev",
   "peerDependencies": {
     "next": "*"
+  },
+  "optionalDependencies": {
+    "openapi3-ts": "^4.4.0"
   }
 }

package/src/VovkApp.ts

@@ -87,11 +87,7 @@ export class VovkApp {
     );
   };
 
-  #callMethod = async (
-    httpMethod: HttpMethod,
-    nextReq: NextRequest,
-    params: Record<string, string[]>
-  ) => {
+  #callMethod = async (httpMethod: HttpMethod, nextReq: NextRequest, params: Record<string, string[]>) => {
     const req = nextReq as unknown as VovkRequest;
     const controllers = this.routes[httpMethod];
     const methodParams: Record<string, string> = {};

package/src/client/defaultFetcher.ts

@@ -19,7 +19,12 @@ const defaultFetcher: VovkClientFetcher<VovkDefaultFetcherOptions> = async (
       // if HttpException is thrown, rethrow it
       if (e instanceof HttpException) throw e;
       // otherwise, throw HttpException with status 0
-      throw new HttpException(HttpStatus.NULL, (e as Error).message ?? DEFAULT_ERROR_MESSAGE, { body, query, params, endpoint });
+      throw new HttpException(HttpStatus.NULL, (e as Error).message ?? DEFAULT_ERROR_MESSAGE, {
+        body,
+        query,
+        params,
+        endpoint,
+      });
     }
   }
 
@@ -40,7 +45,12 @@ const defaultFetcher: VovkClientFetcher<VovkDefaultFetcherOptions> = async (
     response = await fetch(endpoint, init);
   } catch (e) {
     // handle network errors
-    throw new HttpException(HttpStatus.NULL, (e as Error)?.message ?? DEFAULT_ERROR_MESSAGE, { body, query, params, endpoint });
+    throw new HttpException(HttpStatus.NULL, (e as Error)?.message ?? DEFAULT_ERROR_MESSAGE, {
+      body,
+      query,
+      params,
+      endpoint,
+    });
   }
 
   const contentType = response.headers.get('content-type');

package/src/client/types.ts

@@ -81,7 +81,7 @@ export type VovkClient<T, OPTS extends { [key: string]: KnownAny }> = OmitNever<
 export type VovkClientFetcher<OPTS extends Record<string, KnownAny> = Record<string, never>, T = KnownAny> = (
   options: {
     name: keyof T;
-    httpMethod: HttpMethod;
+    httpMethod: `${HttpMethod}`;
     getEndpoint: (data: {
       apiRoot: string;
       params: { [key: string]: string };

package/src/createDecorator.ts

@@ -35,6 +35,7 @@ export function createDecorator<ARGS extends unknown[], REQUEST = VovkRequest>(
           ...handlerSchema,
           // avoid override of path and httpMethod
           ...(initResult?.validation ? { validation: initResult.validation } : {}),
+          ...(initResult?.openapi ? { openapi: initResult.openapi } : {}),
           ...(initResult?.custom ? { custom: initResult.custom } : {}),
         },
       };

package/src/index.ts

@@ -27,6 +27,7 @@ import {
   type VovkStreamAsyncIterable,
   createRPC,
 } from './client';
+import { openapi } from './openapi';
 import { HttpException } from './HttpException';
 import { createDecorator } from './createDecorator';
 import { StreamJSONResponse } from './StreamJSONResponse';
@@ -63,6 +64,7 @@ export {
   createDecorator,
   createRPC,
   generateStaticAPI,
+  openapi,
   setClientValidatorsForHandler,
 };
 

package/src/openapi/fromSchema.ts

@@ -0,0 +1,33 @@
+import type { OpenAPIObject, PathsObject } from 'openapi3-ts/oas31';
+import type { HttpMethod, VovkSchema } from '../types';
+
+export function fromSchema(
+  apiRoot: string,
+  vovkSchema: Record<string, VovkSchema>,
+  extendWith?: Partial<OpenAPIObject>
+): OpenAPIObject {
+  const paths: PathsObject = {};
+
+  for (const [segmentName, schema] of Object.entries(vovkSchema)) {
+    for (const c of Object.values(schema.controllers)) {
+      for (const h of Object.values(c.handlers)) {
+        if (h.openapi) {
+          const path =
+            '/' + [apiRoot.replace(/^\/+|\/+$/g, ''), segmentName, c.prefix, h.path].filter(Boolean).join('/');
+          paths[path] = paths[path] ?? {};
+          paths[path][h.httpMethod.toLowerCase() as Lowercase<HttpMethod>] = { ...h.openapi };
+        }
+      }
+    }
+  }
+
+  return {
+    openapi: '3.1.0',
+    paths,
+    info: extendWith?.info ?? {
+      title: 'API',
+      version: '1.0.0',
+    },
+    ...extendWith,
+  };
+}

package/src/openapi/index.ts

@@ -0,0 +1 @@
+export { openapi } from './openapi';

package/src/openapi/openapi.ts

@@ -0,0 +1,23 @@
+import type { OperationObject } from 'openapi3-ts/oas31';
+import { createDecorator } from '../createDecorator';
+import { fromSchema } from './fromSchema';
+
+type OperationObjectWithCustomProperties = OperationObject & {
+  [key in `${'x' | 'X'}-${string}`]: any;
+}
+
+const openapiDecorator = createDecorator(null, (openAPIOperationObject: OperationObjectWithCustomProperties = {}) => {
+  return (handlerSchema) => ({
+    ...handlerSchema,
+    openapi: {
+      ...handlerSchema?.openapi,
+      ...openAPIOperationObject,
+    },
+  });
+});
+
+export const openapi = openapiDecorator as typeof openapiDecorator & {
+  fromSchema: typeof fromSchema;
+};
+
+openapi.fromSchema = fromSchema;

package/src/types.ts

@@ -1,4 +1,5 @@
 import type { NextRequest } from 'next/server';
+import type { OperationObject } from 'openapi3-ts/oas31';
 import type { StreamJSONResponse } from './StreamJSONResponse';
 import { VovkStreamAsyncIterable } from './client/types';
 
@@ -8,8 +9,9 @@ export type StaticClass = Function; // eslint-disable-line @typescript-eslint/no
 
 export type VovkHandlerSchema = {
   path: string;
-  httpMethod: HttpMethod;
+  httpMethod: `${HttpMethod}`;
   validation?: { query?: KnownAny; body?: KnownAny };
+  openapi?: OperationObject;
   custom?: Record<string, KnownAny>;
 };