vovk 3.0.0-draft.3 → 3.0.0-draft.5

package/client/types.d.ts

@@ -41,7 +41,9 @@ type OmitNever<T> = {
 type _VovkClientWithNever<T, OPTS extends {
     [key: string]: KnownAny;
 }> = {
-    [K in keyof T]: T[K] extends (...args: KnownAny) => KnownAny ? ClientMethod<T[K], OPTS> : never;
+    [K in keyof T]: T[K] extends (...args: KnownAny) => KnownAny ? ClientMethod<T[K], OPTS> & {
+        __isClientMethod: boolean;
+    } : never;
 };
 export type _VovkClient<T, OPTS extends {
     [key: string]: KnownAny;

package/createSegment.d.ts

@@ -1,4 +1,4 @@
-import { type _KnownAny as KnownAny, type _DecoratorOptions as DecoratorOptions, type _VovkRequest as VovkRequest } from './types';
+import { type _KnownAny as KnownAny, type _DecoratorOptions as DecoratorOptions, type _VovkRequest as VovkRequest, type _StaticClass as StaticClass } from './types';
 export declare function _createSegment(): {
     get: {
         (givenPath?: string | undefined, options?: DecoratorOptions | undefined): ReturnType<(givenPath?: string, options?: DecoratorOptions) => (givenTarget: KnownAny, propertyKey: string) => void>;
@@ -31,8 +31,8 @@ export declare function _createSegment(): {
     prefix: (givenPath?: string) => (givenTarget: KnownAny) => any;
     initVovk: (options: {
         segmentName?: string;
-        controllers: Record<string, Function>;
-        workers?: Record<string, Function>;
+        controllers: Record<string, StaticClass>;
+        workers?: Record<string, StaticClass>;
         exposeValidation?: boolean;
         emitSchema?: boolean;
         onError?: (err: Error, req: VovkRequest) => void | Promise<void>;

package/createSegment.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._createSegment = _createSegment;
-/* eslint-disable no-console */
 const Segment_1 = require("./Segment");
 const types_1 = require("./types");
 const getSchema_1 = __importDefault(require("./utils/getSchema"));
@@ -76,7 +75,6 @@ function _createSegment() {
         return (givenTarget) => {
             const controller = givenTarget;
             controller._prefix = path;
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             return givenTarget;
         };
     };

package/generateStaticAPI.d.ts

@@ -1,3 +1,4 @@
-export declare function _generateStaticAPI(c: Record<string, Function>, slug?: string): {
+import { _StaticClass as StaticClass } from './types';
+export declare function _generateStaticAPI(c: Record<string, StaticClass>, slug?: string): {
     [x: string]: string[];
 }[];

package/generateStaticAPI.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._generateStaticAPI = _generateStaticAPI;
-// eslint-disable-next-line @typescript-eslint/ban-types
 function _generateStaticAPI(c, slug = 'vovk') {
     const controllers = c;
     return [

package/index.d.ts

@@ -1,12 +1,12 @@
 import { _createSegment as createSegment } from './createSegment';
-import { type _VovkErrorResponse as VovkErrorResponse, type _VovkRequest as VovkRequest, type _VovkControllerBody as VovkControllerBody, type _VovkControllerQuery as VovkControllerQuery, type _VovkControllerParams as VovkControllerParams, type _VovkControllerReturnType as VovkControllerReturnType, type _VovkControlerYieldType as VovkControlerYieldType, type _VovkBody as VovkBody, type _VovkQuery as VovkQuery, type _VovkParams as VovkParams, type _VovkReturnType as VovkReturnType, type _VovkYieldType as VovkYieldType, type _VovkSchema as VovkSchema, _HttpStatus as HttpStatus, _HttpMethod as HttpMethod } from './types';
+import { type _VovkErrorResponse as VovkErrorResponse, type _VovkRequest as VovkRequest, type _VovkBody as VovkBody, type _VovkQuery as VovkQuery, type _VovkParams as VovkParams, type _VovkReturnType as VovkReturnType, type _VovkYieldType as VovkYieldType, type _VovkSchema as VovkSchema, _HttpStatus as HttpStatus, _HttpMethod as HttpMethod } from './types';
 import type { _VovkClientOptions as VovkClientOptions, _VovkClientFetcher as VovkClientFetcher, _VovkDefaultFetcherOptions as VovkDefaultFetcherOptions, _VovkValidateOnClient as VovkValidateOnClient } from './client/types';
 import { _HttpException as HttpException } from './HttpException';
 import { _createDecorator as createDecorator } from './createDecorator';
 import { _StreamResponse as StreamResponse } from './StreamResponse';
 import { worker } from './worker';
 import { _generateStaticAPI as generateStaticAPI } from './generateStaticAPI';
-export { type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerReturnType, type VovkControlerYieldType, type VovkBody, type VovkQuery, type VovkParams, type VovkReturnType, type VovkYieldType, type VovkClientOptions, StreamResponse, HttpException, HttpStatus, HttpMethod, createSegment, createDecorator, worker, generateStaticAPI, };
+export { type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkSchema, type VovkErrorResponse, type VovkRequest, type VovkBody, type VovkQuery, type VovkParams, type VovkReturnType, type VovkYieldType, type VovkClientOptions, StreamResponse, HttpException, HttpStatus, HttpMethod, createSegment, createDecorator, worker, generateStaticAPI, };
 export declare const get: {
     (givenPath?: string | undefined, options?: import("./types")._DecoratorOptions | undefined): ReturnType<(givenPath?: string, options?: import("./types")._DecoratorOptions) => (givenTarget: import("./types")._KnownAny, propertyKey: string) => void>;
     auto: (options?: import("./types")._DecoratorOptions) => (givenTarget: import("./types")._KnownAny, propertyKey: string) => void;
@@ -30,8 +30,8 @@ export declare const get: {
     auto: (options?: import("./types")._DecoratorOptions) => (givenTarget: import("./types")._KnownAny, propertyKey: string) => void;
 }, prefix: (givenPath?: string) => (givenTarget: import("./types")._KnownAny) => any, initVovk: (options: {
     segmentName?: string;
-    controllers: Record<string, Function>;
-    workers?: Record<string, Function>;
+    controllers: Record<string, import("./types")._StaticClass>;
+    workers?: Record<string, import("./types")._StaticClass>;
     exposeValidation?: boolean;
     emitSchema?: boolean;
     onError?: (err: Error, req: VovkRequest) => void | Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.3",
+  "version": "3.0.0-draft.5",
   "description": "RESTful RPC for Next.js - Transforms Next.js into a powerful REST API platform with RPC capabilities.",
   "repository": {
     "type": "git",

package/types.d.ts

@@ -2,6 +2,7 @@ import type { NextRequest } from 'next/server';
 import type { _StreamResponse as StreamResponse } from './StreamResponse';
 import { _StreamAsyncIterator as StreamAsyncIterator } from './client/types';
 export type _KnownAny = any;
+export type _StaticClass = Function;
 export type _VovkSchema = {
     emitSchema: boolean;
     segmentName: string;
@@ -39,10 +40,10 @@ export type _VovkControllerInternal = _VovkControllerSchema & {
     _activated?: true;
     _onError?: (err: Error, req: _VovkRequest) => void | Promise<void>;
 };
-export type _VovkController = Function & _VovkControllerInternal & {
+export type _VovkController = _StaticClass & _VovkControllerInternal & {
     [key: string]: unknown;
 };
-export type _VovkWorker = Function & _VovkWorkerSchema & {
+export type _VovkWorker = _StaticClass & _VovkWorkerSchema & {
     [key: string]: unknown;
 };
 export type _DecoratorOptions = {
@@ -85,26 +86,44 @@ export type _VovkControllerQuery<T extends _ControllerStaticMethod<REQ, PARAMS>,
 export type _VovkControllerParams<T extends _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
     [key: string]: string;
 } = _KnownAny> = Parameters<T>[1];
-export type _VovkBody<T extends (options: OPTIONS) => _KnownAny, OPTIONS extends {
+export type _VovkControllerReturnType<T extends _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+    [key: string]: string;
+} = _KnownAny> = Awaited<ReturnType<T>>;
+export type _VovkControlerYieldType<T extends _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+    [key: string]: string;
+} = _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<StreamResponse<infer Y>> | StreamResponse<infer Y> ? Y : never;
+export type _VovkClientBody<T extends (options: OPTIONS) => _KnownAny, OPTIONS extends {
     body: B;
     [key: string]: _KnownAny;
 } = Parameters<T>[0], B = _KnownAny> = Parameters<T>[0]['body'];
-export type _VovkQuery<T extends (options: OPTIONS) => _KnownAny, OPTIONS extends {
+export type _VovkClientQuery<T extends (options: OPTIONS) => _KnownAny, OPTIONS extends {
     query: Q;
     [key: string]: _KnownAny;
 } = Parameters<T>[0], Q = _KnownAny> = Parameters<T>[0]['query'];
-export type _VovkParams<T extends (options: OPTIONS) => _KnownAny, OPTIONS extends {
+export type _VovkClientParams<T extends (options: OPTIONS) => _KnownAny, OPTIONS extends {
     params: P;
     [key: string]: _KnownAny;
 } = Parameters<T>[0], P = _KnownAny> = Parameters<T>[0]['params'];
-export type _VovkControllerReturnType<T extends _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+export type _VovkClientYieldType<T extends (...args: _KnownAny[]) => unknown> = T extends (...args: _KnownAny[]) => Promise<StreamAsyncIterator<infer Y>> ? Y : never;
+export type _VovkClientReturnType<T extends (...args: _KnownAny) => unknown> = Awaited<ReturnType<T>>;
+type ClientStaticMethod = ((...args: _KnownAny[]) => _KnownAny) & {
+    __isClientMethod: boolean;
+};
+export type _VovkBody<T extends ClientStaticMethod | _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
     [key: string]: string;
-} = _KnownAny> = Awaited<ReturnType<T>>;
-export type _VovkControlerYieldType<T extends _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+} = _KnownAny> = T extends ClientStaticMethod ? _VovkClientBody<T> : T extends _ControllerStaticMethod<REQ, PARAMS> ? _VovkControllerBody<T> : never;
+export type _VovkQuery<T extends ClientStaticMethod | _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
     [key: string]: string;
-} = _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<StreamResponse<infer Y>> | StreamResponse<infer Y> ? Y : never;
-export type _VovkReturnType<T extends (...args: _KnownAny) => unknown> = Awaited<ReturnType<T>>;
-export type _VovkYieldType<T extends (...args: _KnownAny[]) => unknown> = T extends (...args: _KnownAny[]) => Promise<StreamAsyncIterator<infer Y>> ? Y : never;
+} = _KnownAny> = T extends ClientStaticMethod ? _VovkClientQuery<T> : T extends _ControllerStaticMethod<REQ, PARAMS> ? _VovkControllerQuery<T> : never;
+export type _VovkParams<T extends ClientStaticMethod | _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+    [key: string]: string;
+} = _KnownAny> = T extends ClientStaticMethod ? _VovkClientParams<T> : T extends _ControllerStaticMethod<REQ, PARAMS> ? _VovkControllerParams<T> : never;
+export type _VovkYieldType<T extends ClientStaticMethod | _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+    [key: string]: string;
+} = _KnownAny> = T extends ClientStaticMethod ? _VovkClientYieldType<T> : T extends _ControllerStaticMethod<REQ, PARAMS> ? _VovkControlerYieldType<T> : never;
+export type _VovkReturnType<T extends ClientStaticMethod | _ControllerStaticMethod<REQ, PARAMS>, REQ extends _VovkRequest<undefined, _KnownAny> = Parameters<T>[0], PARAMS extends {
+    [key: string]: string;
+} = _KnownAny> = T extends ClientStaticMethod ? _VovkClientReturnType<T> : T extends _ControllerStaticMethod<REQ, PARAMS> ? _VovkControllerReturnType<T> : never;
 export type _StreamAbortMessage = {
     isError: true;
     reason: _KnownAny;
@@ -169,3 +188,4 @@ export declare enum _HttpStatus {
     GATEWAY_TIMEOUT = 504,
     HTTP_VERSION_NOT_SUPPORTED = 505
 }
+export {};

package/utils/getSchema.d.ts

@@ -1,8 +1,8 @@
-import { _VovkSchema as VovkSchema } from '../types';
-export default function (options: {
+import { _VovkSchema as VovkSchema, _StaticClass as StaticClass } from '../types';
+export default function getSchema(options: {
     emitSchema?: boolean;
     segmentName?: string;
-    controllers: Record<string, Function>;
-    workers?: Record<string, Function>;
+    controllers: Record<string, StaticClass>;
+    workers?: Record<string, StaticClass>;
     exposeValidation?: boolean;
 }): VovkSchema;

package/utils/getSchema.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
-function default_1(options) {
+exports.default = getSchema;
+function getSchema(options) {
     const exposeValidation = options?.exposeValidation ?? true;
     const emitSchema = options.emitSchema ?? true;
     const schema = {

package/worker/promisifyWorker.js

@@ -26,12 +26,10 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
     instance.fork = (worker) => {
         return _promisifyWorker(worker, givenWorkerService);
     };
-    for (const method of Object.keys(workerService._handlers)) {
-        const { isGenerator } = workerService._handlers[method];
-        const value = workerService[method];
+    for (const methodName of Object.keys(workerService._handlers)) {
+        const { isGenerator } = workerService._handlers[methodName];
         if (isGenerator) {
-            // @ts-expect-error TODO Fix this
-            instance[method] = (...args) => {
+            const method = (...args) => {
                 const key = callsKey;
                 callsKey += 1;
                 return {
@@ -43,8 +41,8 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
                         const messageQueue = [];
                         let messageResolver = null;
                         const onMessage = (e) => {
-                            const { method: m, key: k } = e.data;
-                            if (k !== key || m !== method) {
+                            const { methodName: m, key: k } = e.data;
+                            if (k !== key || m !== methodName) {
                                 return;
                             }
                             if (messageResolver) {
@@ -69,7 +67,7 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
                         };
                         w.addEventListener('message', onMessage);
                         w.addEventListener('error', onError);
-                        w.postMessage({ key, args, method });
+                        w.postMessage({ key, args, methodName });
                         try {
                             while (true) {
                                 let message = null;
@@ -101,10 +99,11 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
                     },
                 };
             };
+            // @ts-expect-error TODO
+            instance[methodName] = method;
         }
         else {
-            // @ts-expect-error TODO Fix this
-            instance[method] = (...args) => {
+            const method = (...args) => {
                 if (!instance.worker) {
                     throw new Error('Worker is not provided or terminated');
                 }
@@ -118,8 +117,8 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
                         reject(e);
                     };
                     const onMessage = (e) => {
-                        const { result, error, key: k, method: m } = e.data;
-                        if (k !== key || m !== method) {
+                        const { result, error, key: k, methodName: m } = e.data;
+                        if (k !== key || m !== methodName) {
                             return;
                         }
                         w.removeEventListener('message', onMessage);
@@ -133,9 +132,11 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
                     };
                     w.addEventListener('message', onMessage);
                     w.addEventListener('error', onError);
-                    w.postMessage({ key, args, method });
+                    w.postMessage({ key, args, methodName });
                 });
             };
+            // @ts-expect-error TODO
+            instance[methodName] = method;
         }
     }
     return instance;

package/worker/types.d.ts

@@ -17,15 +17,15 @@ export type _WorkerPromiseInstance<T> = OmitNever<_WorkerPromiseInstanceWithNeve
     [Symbol.dispose]: () => void;
 };
 export interface _WorkerInput {
-    method: string;
+    methodName: string;
     args: unknown[];
     key: number;
 }
 export interface _WorkerOutput {
+    methodName: string;
     result?: unknown;
     error?: unknown;
     done?: true;
     key: number;
-    method: string;
 }
 export {};

package/worker/worker.js

@@ -20,25 +20,24 @@ function _worker() {
         }
         if (typeof self === 'undefined')
             return; // no-op in non-worker environment
-        // eslint-disable-next-line no-undef
         const w = self;
         w.onmessage = async (evt) => {
-            const { method, args, key } = evt.data;
+            const { methodName, args, key } = evt.data;
             try {
-                const result = await target[method](...args);
+                const result = await target[methodName](...args);
                 if (result && typeof result === 'object' && 'next' in result && typeof result.next === 'function') {
                     const iterable = result;
                     for await (const result of iterable) {
-                        w.postMessage({ result, key, method });
+                        w.postMessage({ result, key, methodName });
                     }
-                    w.postMessage({ done: true, key, method });
+                    w.postMessage({ done: true, key, methodName });
                 }
                 else {
-                    w.postMessage({ result, key, method });
+                    w.postMessage({ result, key, methodName });
                 }
             }
             catch (e) {
-                w.postMessage({ error: e, key, method });
+                w.postMessage({ error: e, key, methodName });
             }
         };
     };