vovk 3.0.0-draft.116 → 3.0.0-draft.118

package/dist/VovkApp.js

@@ -125,7 +125,7 @@ class VovkApp {
         });
         const { handler, methodParams } = this.#getHandler({ handlers, path, params });
         if (!handler) {
-            return this.#respondWithError(types_1.HttpStatus.NOT_FOUND, `Route ${path.join('/')} is not found`);
+            return this.#respondWithError(types_1.HttpStatus.NOT_FOUND, `${Object.keys(handlers)} - Route ${path.join('/')} is not found`);
         }
         const { staticMethod, controller } = handler;
         req.vovk = {

package/dist/client/createRPC.js

@@ -39,11 +39,11 @@ const createRPC = (fullSchema, segmentName, controllerName, options) => {
             const fetcher = input.fetcher ?? settingsFetcher;
             const validate = async ({ body, query, params, endpoint, }) => {
                 const validateOnClient = input.validateOnClient ?? options?.validateOnClient;
-                if (validateOnClient) {
+                if (validateOnClient && validation) {
                     if (typeof validateOnClient !== 'function') {
                         throw new Error('validateOnClient must be a function');
                     }
-                    await validateOnClient({ body, query, params, endpoint }, validation ?? {}, fullSchema);
+                    await validateOnClient({ body, query, params, endpoint }, validation, fullSchema);
                 }
             };
             const internalOptions = {

package/dist/createDecorator.js

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

package/dist/createVovkApp.js

@@ -10,9 +10,10 @@ const getSchema_1 = __importDefault(require("./utils/getSchema"));
 const trimPath = (path) => path.trim().replace(/^\/|\/$/g, '');
 const isClass = (func) => typeof func === 'function' && /class/.test(func.toString());
 const toKebabCase = (str) => str
-    .replace(/([A-Z])/g, '-$1')
+    .replace(/([a-z0-9])([A-Z])/g, '$1-$2') // Add hyphen between lowercase/digit and uppercase
+    .replace(/([A-Z])([A-Z])(?=[a-z])/g, '$1-$2') // Add hyphen between uppercase letters if the second one is followed by a lowercase
     .toLowerCase()
-    .replace(/^-/, '');
+    .replace(/^-/, ''); // Remove leading hyphen
 const assignSchema = ({ controller, propertyKey, path, options, httpMethod, vovkApp, }) => {
     if (typeof window !== 'undefined') {
         throw new Error('Decorators are intended for server-side use only. You have probably imported a controller on the client-side.');
@@ -40,6 +41,13 @@ const assignSchema = ({ controller, propertyKey, path, options, httpMethod, vovk
     };
     methods[path] = controller[propertyKey];
     methods[path]._options = options;
+    controller._handlersMetadata = {
+        ...controller._handlersMetadata,
+        [propertyKey]: {
+            ...(controller._handlersMetadata ?? {})[propertyKey],
+            staticParams: options?.staticParams,
+        },
+    };
 };
 function createVovkApp() {
     const vovkApp = new VovkApp_1.VovkApp();

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { NextRequest } from 'next/server';
 import type { OperationObject } from 'openapi3-ts/oas31';
+import type { PackageJson } from 'type-fest';
 import type { JSONLinesResponse } from './JSONLinesResponse';
 import { VovkStreamAsyncIterable } from './client/types';
 export type KnownAny = any;
@@ -15,7 +16,7 @@ export type VovkHandlerSchema = {
         iteration?: KnownAny;
     };
     openapi?: OperationObject;
-    custom?: Record<string, KnownAny>;
+    misc?: Record<string, KnownAny>;
 };
 export type VovkControllerSchema = {
     controllerName: string;
@@ -38,6 +39,9 @@ export type VovkControllerInternal = {
     _controllerName?: VovkControllerSchema['controllerName'];
     _prefix?: VovkControllerSchema['prefix'];
     _handlers: VovkControllerSchema['handlers'];
+    _handlersMetadata?: Record<string, {
+        staticParams?: Record<string, string>[];
+    }>;
     _activated?: true;
     _onError?: (err: Error, req: VovkRequest) => void | Promise<void>;
 };
@@ -47,6 +51,7 @@ export type VovkController = StaticClass & VovkControllerInternal & {
 export type DecoratorOptions = {
     cors?: boolean;
     headers?: Record<string, string>;
+    staticParams?: Record<string, string>[];
     before?: (this: VovkController, req: VovkRequest) => unknown;
 };
 export type RouteHandler = ((req: VovkRequest, params: Record<string, string>) => Response | Promise<Response> | Iterable<unknown> | AsyncIterable<unknown>) & {
@@ -99,9 +104,6 @@ export type StreamAbortMessage = {
 type LogLevelNames = 'trace' | 'debug' | 'info' | 'warn' | 'error';
 export type VovkEnv = {
     PORT?: string;
-    VOVK_GENERATE_FULL_CLIENT?: string;
-    VOVK_GENERATE_SEGMENT_CLIENT?: string;
-    VOVK_CLIENT_OUT_DIR?: string;
     VOVK_SCHEMA_OUT_DIR?: string;
     VOVK_IMPORTS_FETCHER?: string;
     VOVK_IMPORTS_VALIDATE_ON_CLIENT?: string;
@@ -117,20 +119,40 @@ export type VovkEnv = {
     __VOVK_START_WATCHER_IN_STANDALONE_MODE__?: 'true';
     __VOVK_EXIT__?: 'true' | 'false';
 };
-export type GenerateFromTemplate = {
-    templateGlob: string | null;
+type ClientConfigCommon = {
+    enabled?: boolean;
     outDir?: string;
-    templateName?: string;
-    fullSchemaJSON?: string | boolean;
+    fromTemplates?: string[];
+} & ({
+    excludeSegments?: never;
+    includeSegments?: string[];
+} | {
+    excludeSegments?: string[];
+    includeSegments?: never;
+});
+type ClientConfigFull = ClientConfigCommon & {
+    package?: PackageJson;
+};
+type ClientConfigSegmented = ClientConfigCommon & {
+    packages?: Record<string, PackageJson>;
+};
+export type ClientTemplateDef = {
+    extends?: string;
+    templatePath: string;
     origin?: string | null;
+    fullClient?: Omit<ClientConfigFull, 'fromTemplates' | 'enabled'>;
+    segmentedClient?: Omit<ClientConfigSegmented, 'fromTemplates' | 'enabled'>;
+    segmentConfig?: false | Record<string, {
+        origin?: string;
+        rootEntry?: boolean;
+    }>;
+    requires?: Record<string, string>;
 };
-type GenerateFrom = (string | GenerateFromTemplate)[];
 export type VovkConfig = {
     emitConfig?: boolean | (keyof VovkStrictConfig)[];
-    clientOutDir?: string;
     schemaOutDir?: string;
-    generateFullClient?: boolean;
-    generateSegmentClient?: boolean;
+    fullClient?: ClientConfigFull;
+    segmentedClient?: ClientConfigSegmented;
     imports?: {
         fetcher?: string | [string, string] | [string];
         validateOnClient?: string | [string, string] | [string];
@@ -143,23 +165,28 @@ export type VovkConfig = {
     logLevel?: LogLevelNames;
     prettifyClient?: boolean;
     devHttps?: boolean;
-    generateFrom?: GenerateFrom | ((value: GenerateFrom) => GenerateFrom);
-    templates?: {
+    clientTemplateDefs?: Record<string, ClientTemplateDef>;
+    moduleTemplates?: {
         service?: string;
         controller?: string;
         [key: string]: string | undefined;
     };
     libs?: Record<string, KnownAny>;
+    segmentConfig?: false | Record<string, {
+        origin?: string;
+        rootEntry?: boolean;
+    }>;
 };
-export type VovkStrictConfig = Required<Omit<VovkConfig, 'emitConfig' | 'generateFrom' | 'libs' | 'imports'>> & {
+export type VovkStrictConfig = Required<Omit<VovkConfig, 'emitConfig' | 'libs' | 'imports' | 'fullClient' | 'segmentedClient'>> & {
     emitConfig: (keyof VovkStrictConfig)[];
     imports: {
         fetcher: [string, string] | [string];
         validateOnClient: [string, string] | [string] | null;
         createRPC: [string, string] | [string];
     };
-    generateFrom: GenerateFrom;
     libs: Record<string, KnownAny>;
+    fullClient: RequireFields<ClientConfigFull, 'enabled' | 'fromTemplates' | 'outDir'>;
+    segmentedClient: RequireFields<ClientConfigSegmented, 'enabled' | 'fromTemplates' | 'outDir'>;
 };
 export type VovkFullSchema = {
     config: Partial<VovkStrictConfig>;
@@ -226,4 +253,5 @@ export declare enum HttpStatus {
     GATEWAY_TIMEOUT = 504,
     HTTP_VERSION_NOT_SUPPORTED = 505
 }
+type RequireFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
 export {};

package/dist/utils/generateStaticAPI.js

@@ -9,9 +9,21 @@ function generateStaticAPI(c, slug = 'vovk') {
             .map((controller) => {
             const handlers = controller._handlers;
             const splitPrefix = controller._prefix?.split('/') ?? [];
-            return Object.values(handlers).map((handler) => {
-                return { [slug]: [...splitPrefix, ...handler.path.split('/')].filter(Boolean) };
-            });
+            return Object.entries(handlers)
+                .map(([name, handler]) => {
+                const staticParams = controller._handlersMetadata?.[name]?.staticParams;
+                if (staticParams?.length) {
+                    return staticParams.map((paramsItem) => {
+                        let path = handler.path;
+                        for (const [key, value] of Object.entries(paramsItem)) {
+                            path = path.replace(`:${key}`, value);
+                        }
+                        return { [slug]: [...splitPrefix, ...path.split('/')].filter(Boolean) };
+                    });
+                }
+                return [{ [slug]: [...splitPrefix, ...handler.path.split('/')].filter(Boolean) }];
+            })
+                .flat();
         })
             .flat(),
     ];

package/dist/utils/getSchema.d.ts

@@ -8,7 +8,7 @@ export declare function getControllerSchema(controller: VovkController, controll
             path: string;
             httpMethod: string;
             openapi?: import("openapi3-ts/oas31").OperationObject;
-            custom?: Record<string, import("../types").KnownAny>;
+            misc?: Record<string, import("../types").KnownAny>;
         };
     };
 };

package/dist/utils/withValidation.d.ts

@@ -1,8 +1,8 @@
 import { VovkValidationType, type KnownAny, type VovkRequest } from '../types';
-export declare function withValidation<T extends (req: KnownAny, params: KnownAny) => KnownAny, BODY_MODEL, QUERY_MODEL, PARAMS_MODEL, OUTPUT_MODEL, ITERATION_MODEL>({ disableServerSideValidation, skipSchemaEmission, validateEveryIteration, body, query, params, output, iteration, handle, getJSONSchemaFromModel, validate, }: {
+export declare function withValidation<T extends (req: KnownAny, params: KnownAny) => KnownAny, BODY_MODEL, QUERY_MODEL, PARAMS_MODEL, OUTPUT_MODEL, ITERATION_MODEL>({ disableServerSideValidation, skipSchemaEmission, validateEachIteration, body, query, params, output, iteration, handle, getJSONSchemaFromModel, validate, }: {
     disableServerSideValidation?: boolean | VovkValidationType[];
     skipSchemaEmission?: boolean | VovkValidationType[];
-    validateEveryIteration?: boolean;
+    validateEachIteration?: boolean;
     body?: BODY_MODEL;
     query?: QUERY_MODEL;
     params?: PARAMS_MODEL;

package/dist/utils/withValidation.js

@@ -5,7 +5,7 @@ const HttpException_1 = require("../HttpException");
 const types_1 = require("../types");
 const setHandlerSchema_1 = require("./setHandlerSchema");
 const validationTypes = ['body', 'query', 'params', 'output', 'iteration'];
-function withValidation({ disableServerSideValidation, skipSchemaEmission, validateEveryIteration, body, query, params, output, iteration, handle, getJSONSchemaFromModel, validate, }) {
+function withValidation({ disableServerSideValidation, skipSchemaEmission, validateEachIteration, body, query, params, output, iteration, handle, getJSONSchemaFromModel, validate, }) {
     const disableServerSideValidationKeys = disableServerSideValidation === false
         ? []
         : disableServerSideValidation === true
@@ -32,7 +32,7 @@ function withValidation({ disableServerSideValidation, skipSchemaEmission, valid
             return (async function* () {
                 let i = 0;
                 for await (const item of data) {
-                    if (validateEveryIteration || i === 0) {
+                    if (validateEachIteration || i === 0) {
                         await validate(item, iteration, { type: 'iteration', req, status: 200, i });
                     }
                     i++;
@@ -40,8 +40,8 @@ function withValidation({ disableServerSideValidation, skipSchemaEmission, valid
                 }
             })();
         }
-        else if (validateEveryIteration) {
-            throw new HttpException_1.HttpException(types_1.HttpStatus.INTERNAL_SERVER_ERROR, 'validateEveryIteration is set but iteration is not defined.');
+        else if (validateEachIteration) {
+            throw new HttpException_1.HttpException(types_1.HttpStatus.INTERNAL_SERVER_ERROR, 'validateEachIteration is set but iteration is not defined.');
         }
         return data;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.116",
+  "version": "3.0.0-draft.118",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "description": "RESTful RPC for Next.js - Transforms Next.js into a powerful REST API platform with RPC capabilities.",
@@ -30,6 +30,7 @@
     "next": "*"
   },
   "optionalDependencies": {
-    "openapi3-ts": "*"
+    "openapi3-ts": "*",
+    "type-fest": "*"
   }
 }