vovk 3.0.0-draft.95 → 3.0.0-draft.96

package/dist/index.d.ts

@@ -1,12 +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 VovkControllerOutput, type VovkSegmentSchema, type VovkControllerSchema, type VovkHandlerSchema, type VovkFullSchema, type VovkConfig, type VovkStrictConfig, type VovkEnv } from './types';
+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 VovkControllerOutput, type VovkSegmentSchema, type VovkControllerSchema, type VovkHandlerSchema, type VovkFullSchema, type VovkConfig, type VovkStrictConfig, type VovkEnv, type VovkValidationType } from './types';
 import { type VovkClient, type VovkClientOptions, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkStreamAsyncIterable, createRPC, fetcher } from './client';
 import { HttpException } from './HttpException';
 import { createDecorator } from './createDecorator';
 import { StreamJSONResponse } from './StreamJSONResponse';
 import { generateStaticAPI } from './utils/generateStaticAPI';
 import { withValidation } from './utils/withValidation';
-export { type KnownAny, type VovkClient, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkStreamAsyncIterable, type VovkValidateOnClient, type VovkSegmentSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkControllerOutput, type VovkBody, type VovkQuery, type VovkParams, type VovkYieldType, type VovkReturnType, type VovkClientOptions, type VovkControllerSchema, type VovkHandlerSchema, type VovkFullSchema, type VovkConfig, type VovkStrictConfig, type VovkEnv, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, createRPC, fetcher, generateStaticAPI, withValidation, };
+export { type KnownAny, type VovkClient, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkStreamAsyncIterable, type VovkValidateOnClient, type VovkSegmentSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkControllerOutput, type VovkBody, type VovkQuery, type VovkParams, type VovkYieldType, type VovkReturnType, type VovkClientOptions, type VovkControllerSchema, type VovkHandlerSchema, type VovkFullSchema, type VovkConfig, type VovkStrictConfig, type VovkEnv, type VovkValidationType, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, createRPC, fetcher, generateStaticAPI, withValidation, };
 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/types.d.ts

@@ -10,8 +10,9 @@ export type VovkHandlerSchema = {
     validation?: {
         query?: KnownAny;
         body?: KnownAny;
-        output?: KnownAny;
         params?: KnownAny;
+        output?: KnownAny;
+        iteration?: KnownAny;
     };
     openapi?: OperationObject;
     custom?: Record<string, KnownAny>;
@@ -82,6 +83,9 @@ export type VovkControllerYieldType<T extends (req: VovkRequest<KnownAny, KnownA
 export type VovkControllerOutput<T extends ((...args: KnownAny) => KnownAny) & {
     __output?: KnownAny;
 }> = T['__output'];
+export type VovkControllerIteration<T extends ((...args: KnownAny) => KnownAny) & {
+    __iteration?: KnownAny;
+}> = T['__iteration'];
 export type VovkBody<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['body'];
 export type VovkQuery<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['query'];
 export type VovkParams<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['params'];
@@ -150,6 +154,7 @@ export type VovkFullSchema = {
     config: Partial<VovkStrictConfig>;
     segments: Record<string, VovkSegmentSchema>;
 };
+export type VovkValidationType = 'body' | 'query' | 'params' | 'output' | 'iteration';
 export declare enum HttpMethod {
     GET = "GET",
     POST = "POST",

package/dist/utils/withValidation.d.ts

@@ -1,13 +1,20 @@
-import { VovkHandlerSchema, 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>({ body, query, params, output, handle, getHandlerSchema, validate, }: {
+import { VovkHandlerSchema, 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>({ skipServerSideValidation, skipSchemaEmission, validateEveryIteration, body, query, params, output, iteration, handle, getHandlerSchema, validate, }: {
+    skipServerSideValidation?: boolean | VovkValidationType[];
+    skipSchemaEmission?: boolean | VovkValidationType[];
+    validateEveryIteration?: boolean;
     body?: BODY_MODEL;
     query?: QUERY_MODEL;
     params?: PARAMS_MODEL;
     output?: OUTPUT_MODEL;
+    iteration?: ITERATION_MODEL;
     handle: T;
-    getHandlerSchema?: () => Omit<VovkHandlerSchema, 'httpMethod' | 'path'>;
-    validate: (data: KnownAny, model: NonNullable<BODY_MODEL | QUERY_MODEL | PARAMS_MODEL | OUTPUT_MODEL>, meta: {
-        type: 'body' | 'query' | 'params' | 'output';
+    getHandlerSchema?: (options: {
+        skipSchemaEmissionKeys: VovkValidationType[];
+    }) => Omit<VovkHandlerSchema, 'httpMethod' | 'path'>;
+    validate: (data: KnownAny, model: NonNullable<BODY_MODEL | QUERY_MODEL | PARAMS_MODEL | OUTPUT_MODEL | ITERATION_MODEL>, meta: {
+        type: VovkValidationType;
         req: VovkRequest<KnownAny, KnownAny>;
+        status?: number;
     }) => KnownAny;
 }): T;

package/dist/utils/withValidation.js

@@ -4,31 +4,61 @@ exports.withValidation = withValidation;
 const HttpException_1 = require("../HttpException");
 const types_1 = require("../types");
 const setHandlerSchema_1 = require("./setHandlerSchema");
-function withValidation({ body, query, params, output, handle, getHandlerSchema, validate, }) {
+const validationTypes = ['body', 'query', 'params', 'output', 'iteration'];
+function withValidation({ skipServerSideValidation, skipSchemaEmission, validateEveryIteration, body, query, params, output, iteration, handle, getHandlerSchema, validate, }) {
+    const skipServerSideValidationKeys = skipServerSideValidation === false
+        ? []
+        : skipServerSideValidation === true
+            ? validationTypes
+            : (skipServerSideValidation ?? []);
+    const skipSchemaEmissionKeys = skipSchemaEmission === false ? [] : skipSchemaEmission === true ? validationTypes : (skipSchemaEmission ?? []);
     const outputHandler = async (req, handlerParams) => {
         const data = await handle(req, handlerParams);
-        if (output) {
+        if (output && iteration) {
+            throw new HttpException_1.HttpException(types_1.HttpStatus.INTERNAL_SERVER_ERROR, "Output and iteration are mutually exclusive. You can't use them together.");
+        }
+        if (output && !skipServerSideValidationKeys.includes('output')) {
             if (!data) {
                 throw new HttpException_1.HttpException(types_1.HttpStatus.INTERNAL_SERVER_ERROR, 'Output is required. You probably forgot to return something from your handler.');
             }
             await validate(data, output, { type: 'output', req });
         }
+        if (iteration && !skipServerSideValidationKeys.includes('iteration')) {
+            // We assume `data` is an async iterable here; you might want to check that:
+            if (!data || typeof data[Symbol.asyncIterator] !== 'function') {
+                throw new HttpException_1.HttpException(types_1.HttpStatus.INTERNAL_SERVER_ERROR, 'Data is not an async iterable but iteration validation is defined.');
+            }
+            // Return a brand-new async generator that yields validated items
+            return (async function* () {
+                let i = 0;
+                for await (const item of data) {
+                    if (validateEveryIteration || i === 0) {
+                        await validate(item, iteration, { type: 'iteration', req, status: 200 });
+                    }
+                    i++;
+                    yield item;
+                }
+            })();
+        }
+        else if (validateEveryIteration) {
+            throw new HttpException_1.HttpException(types_1.HttpStatus.INTERNAL_SERVER_ERROR, 'validateEveryIteration is set but iteration is not defined.');
+        }
         return data;
     };
     const resultHandler = async (req, handlerParams) => {
-        if (body) {
+        if (body && !skipServerSideValidationKeys.includes('body')) {
             const data = await req.json();
             const instance = (await validate(data, body, { type: 'body', req })) ?? data;
             // redeclare to add ability to call req.json() again
             req.json = () => Promise.resolve(data);
             req.vovk.body = () => Promise.resolve(instance);
         }
-        if (query) {
+        if (query && !skipServerSideValidationKeys.includes('query')) {
             const data = req.vovk.query();
             const instance = (await validate(data, query, { type: 'query', req })) ?? data;
             req.vovk.query = () => instance;
         }
-        if (params) {
+        if (params && !skipServerSideValidationKeys.includes('params')) {
             const data = req.vovk.params();
             const instance = (await validate(data, params, { type: 'params', req })) ?? data;
             req.vovk.params = () => instance;
@@ -36,7 +66,7 @@ function withValidation({ body, query, params, output, handle, getHandlerSchema,
         return outputHandler(req, handlerParams);
     };
     if (getHandlerSchema) {
-        (0, setHandlerSchema_1.setHandlerSchema)(resultHandler, getHandlerSchema());
+        (0, setHandlerSchema_1.setHandlerSchema)(resultHandler, getHandlerSchema({ skipSchemaEmissionKeys }));
     }
     return resultHandler;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.95",
+  "version": "3.0.0-draft.96",
   "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.",