vovk 3.0.0-draft.20 → 3.0.0-draft.21

package/client/clientizeController.d.ts

@@ -1,4 +1,4 @@
 import { type _VovkControllerSchema as VovkControllerSchema, type _KnownAny as KnownAny } from '../types';
 import { type _VovkClientOptions as VovkClientOptions, type _VovkClient as VovkClient, type _VovkDefaultFetcherOptions as VovkDefaultFetcherOptions } from './types';
 export declare const ARRAY_QUERY_KEY = "_vovkarr";
-export declare const _clientizeController: <T, OPTS extends Record<string, KnownAny> = VovkDefaultFetcherOptions>(givenController: VovkControllerSchema, segmentName?: string, options?: VovkClientOptions<OPTS>) => VovkClient<T, OPTS>;
+export declare const _clientizeController: <T, OPTS extends Record<string, KnownAny> = VovkDefaultFetcherOptions>(controllerSchema: VovkControllerSchema, segmentName?: string, options?: VovkClientOptions<OPTS>) => VovkClient<T, OPTS>;

package/client/clientizeController.js

@@ -36,17 +36,16 @@ const getHandlerPath = (endpoint, params, query) => {
     }
     return `${result}${hasQuery ? '?' : ''}${searchParams.toString()}`;
 };
-const _clientizeController = (givenController, segmentName, options) => {
-    const controller = givenController;
+const _clientizeController = (controllerSchema, segmentName, options) => {
+    const schema = controllerSchema;
     const client = {};
-    if (!controller)
-        throw new Error(`Unable to clientize. Controller schema is not provided`);
-    const schema = controller._handlers;
     if (!schema)
-        throw new Error(`Unable to clientize. No schema for controller ${String(controller?._controllerName)}`);
-    const controllerPrefix = trimPath(controller._prefix ?? '');
+        throw new Error(`Unable to clientize. Controller schema is not provided`);
+    if (!schema.handlers)
+        throw new Error(`Unable to clientize. No schema for controller ${String(schema?.controllerName)}`);
+    const controllerPrefix = trimPath(schema.prefix ?? '');
     const { fetcher: settingsFetcher = defaultFetcher_1.default } = options ?? {};
-    for (const [staticMethodName, { path, httpMethod, clientValidators }] of Object.entries(schema)) {
+    for (const [staticMethodName, { path, httpMethod, validation }] of Object.entries(schema.handlers)) {
         const getEndpoint = ({ apiRoot, params, query, }) => {
             const mainPrefix = (apiRoot.startsWith('http://') || apiRoot.startsWith('https://') || apiRoot.startsWith('/') ? '' : '/') +
                 (apiRoot.endsWith('/') ? apiRoot : `${apiRoot}/`) +
@@ -56,7 +55,7 @@ const _clientizeController = (givenController, segmentName, options) => {
         const handler = (input = {}) => {
             const fetcher = input.fetcher ?? settingsFetcher;
             const validate = async ({ body, query, endpoint }) => {
-                await (input.validateOnClient ?? options?.validateOnClient)?.({ body, query, endpoint }, clientValidators ?? {});
+                await (input.validateOnClient ?? options?.validateOnClient)?.({ body, query, endpoint }, validation ?? {});
             };
             const internalOptions = {
                 name: staticMethodName,

package/createDecorator.js

@@ -18,8 +18,8 @@ function _createDecorator(handler, initHandler) {
                 [propertyKey]: {
                     ...handlerSchema,
                     // avoid override of path and httpMethod
-                    ...(initResult?.clientValidators ? { clientValidators: initResult.clientValidators } : {}),
-                    ...(initResult?.customSchema ? { customSchema: initResult.customSchema } : {}),
+                    ...(initResult?.validation ? { validation: initResult.validation } : {}),
+                    ...(initResult?.custom ? { custom: initResult.custom } : {}),
                 },
             };
             const method = function method(req, params) {

package/package.json

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

@@ -17,33 +17,37 @@ export type _VovkErrorResponse = {
 export type _HandlerSchema = {
     path: string;
     httpMethod: _HttpMethod;
-    clientValidators?: {
+    validation?: {
         query?: _KnownAny;
         body?: _KnownAny;
     };
-    customSchema?: Record<string, _KnownAny>;
+    custom?: Record<string, _KnownAny>;
 };
 export type _VovkControllerSchema = {
-    _controllerName: string;
-    _originalControllerName: string;
-    _prefix?: string;
-    _handlers: Record<string, _HandlerSchema>;
+    controllerName: string;
+    originalControllerName: string;
+    prefix?: string;
+    handlers: Record<string, _HandlerSchema>;
 };
 export type _VovkWorkerSchema = {
-    _workerName: string;
-    _originalWorkerName: string;
-    _handlers: Record<string, {
+    workerName: string;
+    originalWorkerName: string;
+    handlers: Record<string, {
         isGenerator?: true;
     }>;
 };
-export type _VovkControllerInternal = _VovkControllerSchema & {
+export type _VovkControllerInternal = {
+    _controllerName?: _VovkControllerSchema['controllerName'];
+    _prefix?: _VovkControllerSchema['prefix'];
+    _handlers: _VovkControllerSchema['handlers'];
     _activated?: true;
     _onError?: (err: Error, req: _VovkRequest) => void | Promise<void>;
 };
 export type _VovkController = _StaticClass & _VovkControllerInternal & {
     [key: string]: unknown;
 };
-export type _VovkWorker = _StaticClass & _VovkWorkerSchema & {
+export type _VovkWorker = _StaticClass & {
+    _handlers: _VovkWorkerSchema['handlers'];
     [key: string]: unknown;
 };
 export type _DecoratorOptions = {

package/utils/getSchema.js

@@ -14,24 +14,24 @@ function getSchema(options) {
         return schema;
     for (const [controllerName, controller] of Object.entries(options.controllers)) {
         schema.controllers[controllerName] = {
-            _controllerName: controllerName,
-            _originalControllerName: controller.name,
-            _prefix: controller._prefix ?? '',
-            _handlers: {
+            controllerName: controllerName,
+            originalControllerName: controller.name,
+            prefix: controller._prefix ?? '',
+            handlers: {
                 ...(exposeValidation
                     ? controller._handlers
                     : Object.fromEntries(Object.entries(controller._handlers).map(([key, value]) => [
                         key,
-                        { ...value, clientValidators: undefined },
+                        { ...value, validation: undefined },
                     ]))),
             },
         };
     }
     for (const [workerName, worker] of Object.entries(options.workers ?? {})) {
         schema.workers[workerName] = {
-            _workerName: workerName,
-            _originalWorkerName: worker.name,
-            _handlers: { ...worker._handlers },
+            workerName,
+            originalWorkerName: worker.name,
+            handlers: { ...worker._handlers },
         };
     }
     return schema;

package/utils/setClientValidatorsForHandler.js

@@ -16,7 +16,7 @@ function setClientValidatorsForHandler(h, validators) {
                 ...controller._handlers,
                 [handlerName]: {
                     ...controller._handlers[handlerName],
-                    clientValidators: {
+                    validation: {
                         body: validators.body,
                         query: validators.query,
                     },

package/worker/promisifyWorker.d.ts

@@ -1,2 +1,2 @@
 import type { _WorkerPromiseInstance as WorkerPromiseInstance } from './types';
-export declare function _promisifyWorker<T extends object>(currentWorker: Worker | null, givenWorkerService: object): WorkerPromiseInstance<T>;
+export declare function _promisifyWorker<T extends object>(currentWorker: Worker | null, workerSchema: object): WorkerPromiseInstance<T>;

package/worker/promisifyWorker.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._promisifyWorker = _promisifyWorker;
-function _promisifyWorker(currentWorker, givenWorkerService) {
-    if (!givenWorkerService)
+function _promisifyWorker(currentWorker, workerSchema) {
+    if (!workerSchema)
         throw new Error('Worker schema is not provided');
-    const workerService = givenWorkerService;
+    const schema = workerSchema;
     const instance = {
         worker: currentWorker,
     };
@@ -23,11 +23,9 @@ function _promisifyWorker(currentWorker, givenWorkerService) {
         instance.worker = worker;
         return instance;
     };
-    instance.fork = (worker) => {
-        return _promisifyWorker(worker, givenWorkerService);
-    };
-    for (const methodName of Object.keys(workerService._handlers)) {
-        const { isGenerator } = workerService._handlers[methodName];
+    instance.fork = (worker) => _promisifyWorker(worker, schema);
+    for (const methodName of Object.keys(schema.handlers)) {
+        const { isGenerator } = schema.handlers[methodName];
         if (isGenerator) {
             const method = (...args) => {
                 const key = callsKey;

package/worker/worker.js

@@ -5,7 +5,6 @@ function _worker() {
     return (t) => {
         const target = t;
         target._handlers = {};
-        // TODO: Experimental: You can pass Worker Service instead of schema to prommisify worker
         for (const key of Object.getOwnPropertyNames(target)) {
             const member = target[key];
             if (typeof member === 'function') {