vovk 3.0.0-draft.85 → 3.0.0-draft.87

package/dist/VovkApp.js

@@ -81,12 +81,13 @@ class VovkApp {
             }
             const allMethodKeys = Object.keys(handlers);
             let methodKeys = [];
+            const pathStr = path.join('/');
             methodKeys = allMethodKeys
                 // First, try to match literal routes exactly.
                 .filter((p) => {
                 if (p.includes(':'))
                     return false; // Skip parameterized paths
-                return p === path.join('/');
+                return p === pathStr;
             });
             if (!methodKeys.length) {
                 methodKeys = allMethodKeys.filter((p) => {

package/dist/createDecorator.d.ts

@@ -1,4 +1,6 @@
 import type { VovkHandlerSchema, KnownAny, VovkController, VovkRequest } from './types';
 type Next = () => Promise<unknown>;
-export declare function createDecorator<ARGS extends unknown[], REQUEST = VovkRequest>(handler: null | ((this: VovkController, req: REQUEST, next: Next, ...args: ARGS) => unknown), initHandler?: (this: VovkController, ...args: ARGS) => Omit<VovkHandlerSchema, 'path' | 'httpMethod'> | ((handlerSchema: VovkHandlerSchema | null) => Omit<Partial<VovkHandlerSchema>, 'path' | 'httpMethod'>) | null | undefined): (...args: ARGS) => (target: KnownAny, propertyKey: string) => void;
+export declare function createDecorator<ARGS extends unknown[], REQUEST = VovkRequest>(handler: null | ((this: VovkController, req: REQUEST, next: Next, ...args: ARGS) => unknown), initHandler?: (this: VovkController, ...args: ARGS) => Omit<VovkHandlerSchema, 'path' | 'httpMethod'> | ((handlerSchema: VovkHandlerSchema | null, options: {
+    handlerName: string;
+}) => Omit<Partial<VovkHandlerSchema>, 'path' | 'httpMethod'>) | null | undefined): (...args: ARGS) => (target: KnownAny, propertyKey: string) => void;
 export {};

package/dist/createDecorator.js

@@ -23,7 +23,11 @@ function createDecorator(handler, initHandler) {
             originalMethod._controller = controller;
             const handlerSchema = controller._handlers?.[propertyKey] ?? null;
             const initResultReturn = initHandler?.call(controller, ...args);
-            const initResult = typeof initResultReturn === 'function' ? initResultReturn(handlerSchema) : initResultReturn;
+            const initResult = typeof initResultReturn === 'function'
+                ? initResultReturn(handlerSchema, {
+                    handlerName: propertyKey,
+                })
+                : initResultReturn;
             controller._handlers = {
                 ...controller._handlers,
                 [propertyKey]: {

package/dist/index.d.ts

@@ -1,13 +1,12 @@
 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 { 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 { 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, 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.setHandlerValidation = 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.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,8 +9,6 @@ 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/types.d.ts

@@ -50,7 +50,7 @@ export type DecoratorOptions = {
 export type RouteHandler = ((req: VovkRequest, params: Record<string, string>) => Response | Promise<Response> | Iterable<unknown> | AsyncIterable<unknown>) & {
     _options?: DecoratorOptions;
 };
-export interface VovkRequest<BODY = undefined, QUERY extends object | undefined = undefined> extends Omit<NextRequest, 'json' | 'nextUrl'> {
+export interface VovkRequest<BODY extends KnownAny = null, QUERY extends KnownAny = undefined, PARAMS extends KnownAny = undefined> extends Omit<NextRequest, 'json' | 'nextUrl'> {
     json: () => Promise<BODY>;
     nextUrl: Omit<NextRequest['nextUrl'], 'searchParams'> & {
         searchParams: Omit<NextRequest['nextUrl']['searchParams'], 'get' | 'getAll' | 'entries' | 'forEach' | 'keys' | 'values'> & {
@@ -67,7 +67,7 @@ export interface VovkRequest<BODY = undefined, QUERY extends object | undefined
         query: () => QUERY;
         meta: <T = Record<KnownAny, KnownAny>>(meta?: T | null) => T;
         form: <T = KnownAny>() => Promise<T>;
-        params: <T extends Record<string, string> = Record<string, string>>() => T;
+        params: () => PARAMS;
     };
 }
 export type ControllerStaticMethod<REQ extends VovkRequest<KnownAny, KnownAny> = VovkRequest<undefined, Record<string, KnownAny>>, PARAMS extends {
@@ -77,7 +77,7 @@ export type ControllerStaticMethod<REQ extends VovkRequest<KnownAny, KnownAny> =
 };
 export type VovkControllerBody<T extends (...args: KnownAny) => KnownAny> = Awaited<ReturnType<Parameters<T>[0]['vovk']['body']>>;
 export type VovkControllerQuery<T extends (...args: KnownAny) => KnownAny> = ReturnType<Parameters<T>[0]['vovk']['query']>;
-export type VovkControllerParams<T extends (...args: KnownAny) => KnownAny> = Parameters<T>[1];
+export type VovkControllerParams<T extends (...args: KnownAny) => KnownAny> = Parameters<T>[1] extends object ? Parameters<T>[1] : ReturnType<Parameters<T>[0]['vovk']['params']>;
 export type VovkControllerYieldType<T extends (req: VovkRequest<KnownAny, KnownAny>) => KnownAny> = T extends (...args: KnownAny[]) => AsyncGenerator<infer Y, KnownAny, KnownAny> ? Y : T extends (...args: KnownAny[]) => Generator<infer Y, KnownAny, KnownAny> ? Y : T extends (...args: KnownAny[]) => Promise<StreamJSONResponse<infer Y>> | StreamJSONResponse<infer Y> ? Y : never;
 export type VovkBody<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['body'];
 export type VovkQuery<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['query'];

package/dist/utils/getSchema.d.ts

@@ -1,4 +1,17 @@
-import type { VovkSchema, StaticClass } from '../types';
+import type { VovkSchema, VovkController, StaticClass } from '../types';
+export declare function getControllerSchema(controller: VovkController, controllerName: string, exposeValidation: boolean): {
+    controllerName: string;
+    originalControllerName: string;
+    prefix: string;
+    handlers: {
+        [x: string]: {
+            path: string;
+            httpMethod: string;
+            openapi?: import("openapi3-ts/oas31").OperationObject;
+            custom?: Record<string, import("../types").KnownAny>;
+        };
+    };
+};
 export default function getSchema(options: {
     emitSchema?: boolean;
     segmentName?: string;

package/dist/utils/getSchema.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getControllerSchema = getControllerSchema;
 exports.default = getSchema;
+function getControllerSchema(controller, controllerName, exposeValidation) {
+    return {
+        controllerName,
+        originalControllerName: controller.name,
+        prefix: controller._prefix ?? '',
+        handlers: {
+            ...(exposeValidation
+                ? controller._handlers
+                : Object.fromEntries(
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                Object.entries(controller._handlers ?? {}).map(([key, { validation: _v, ...value }]) => [key, value]))),
+        },
+    };
+}
 function getSchema(options) {
     const exposeValidation = options?.exposeValidation ?? true;
     const emitSchema = options.emitSchema ?? true;
@@ -12,18 +27,7 @@ function getSchema(options) {
     if (!emitSchema)
         return schema;
     for (const [controllerName, controller] of Object.entries(options.controllers)) {
-        schema.controllers[controllerName] = {
-            controllerName: controllerName,
-            originalControllerName: controller.name,
-            prefix: controller._prefix ?? '',
-            handlers: {
-                ...(exposeValidation
-                    ? controller._handlers
-                    : Object.fromEntries(
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                    Object.entries(controller._handlers ?? {}).map(([key, { validation: _v, ...value }]) => [key, value]))),
-            },
-        };
+        schema.controllers[controllerName] = getControllerSchema(controller, controllerName, exposeValidation);
     }
     return schema;
 }

package/package.json

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

package/dist/openapi/fromSchema.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1,30 +0,0 @@
-"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('/')
-                            .replace(/:([a-zA-Z0-9_]+)/g, '{$1}');
-                    paths[path] = paths[path] ?? {};
-                    paths[path][h.httpMethod.toLowerCase()] = { ...h.openapi };
-                }
-            }
-        }
-    }
-    return {
-        ...extendWith,
-        openapi: '3.1.0',
-        info: extendWith?.info ?? {
-            title: 'API',
-            version: '1.0.0',
-        },
-        paths,
-    };
-}

package/dist/openapi/index.d.ts

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

package/dist/openapi/index.js

@@ -1,5 +0,0 @@
-"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

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

package/dist/openapi/openapi.js

@@ -1,80 +0,0 @@
-"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) => {
-        const queryParameters = handlerSchema?.validation?.query &&
-            'type' in handlerSchema.validation.query &&
-            'properties' in handlerSchema.validation.query
-            ? Object.entries(handlerSchema.validation.query.properties).map(([propName, propSchema]) => ({
-                name: propName,
-                in: 'query',
-                required: handlerSchema.validation?.query.required
-                    ? handlerSchema.validation.query.required.includes(propName)
-                    : false,
-                schema: propSchema,
-            }))
-            : null;
-        const pathParameters = handlerSchema?.validation?.params &&
-            'type' in handlerSchema.validation.params &&
-            'properties' in handlerSchema.validation.params
-            ? Object.entries(handlerSchema.validation.params.properties).map(([propName, propSchema]) => ({
-                name: propName,
-                in: 'path',
-                required: handlerSchema.validation?.params.required
-                    ? handlerSchema.validation.params.required.includes(propName)
-                    : false,
-                schema: propSchema,
-            }))
-            : null;
-        return {
-            ...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,
-                                },
-                            },
-                        },
-                    }
-                    : {}),
-                ...(queryParameters || pathParameters
-                    ? { parameters: [...(queryParameters || []), ...(pathParameters || [])] }
-                    : {}),
-                ...openAPIOperationObject,
-            },
-        };
-    };
-});
-exports.openapi = openapiDecorator;
-exports.openapi.fromSchema = fromSchema_1.fromSchema;