vovk 3.0.0-beta.21 → 3.0.0-beta.22

package/Segment.js

@@ -128,7 +128,7 @@ class _Segment {
         req.vovk = {
             body: () => req.json(),
             query: () => (0, reqQuery_1.default)(req),
-            meta: (metadata) => (0, reqMeta_1.default)(req, metadata),
+            meta: (meta) => (0, reqMeta_1.default)(req, meta),
         };
         try {
             const result = await staticMethod.call(controller, req, methodParams);

package/client/clientizeController.d.ts

@@ -1,4 +1,4 @@
-import { type _VovkControllerMetadata as VovkControllerMetadata, type _KnownAny as KnownAny } from '../types';
+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: VovkControllerMetadata, segmentName?: string, options?: VovkClientOptions<OPTS>) => VovkClient<T, OPTS>;
+export declare const _clientizeController: <T, OPTS extends Record<string, KnownAny> = VovkDefaultFetcherOptions>(givenController: VovkControllerSchema, segmentName?: string, options?: VovkClientOptions<OPTS>) => VovkClient<T, OPTS>;

package/client/clientizeController.js

@@ -38,13 +38,13 @@ const _clientizeController = (givenController, segmentName, options) => {
     const controller = givenController;
     const client = {};
     if (!controller)
-        throw new Error(`Unable to clientize. Controller metadata is not provided`);
-    const metadata = controller._handlers;
-    if (!metadata)
-        throw new Error(`Unable to clientize. No metadata for controller ${String(controller?._controllerName)}`);
+        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 ?? '');
     const { fetcher: settingsFetcher = defaultFetcher_1.default } = options ?? {};
-    for (const [staticMethodName, { path, httpMethod, clientValidators }] of Object.entries(metadata)) {
+    for (const [staticMethodName, { path, httpMethod, clientValidators }] of Object.entries(schema)) {
         const getEndpoint = ({ prefix, params, query, }) => {
             const mainPrefix = (prefix.startsWith('http://') || prefix.startsWith('https://') || prefix.startsWith('/') ? '' : '/') +
                 (prefix.endsWith('/') ? prefix : `${prefix}/`) +
@@ -70,7 +70,6 @@ const _clientizeController = (givenController, segmentName, options) => {
                 body: input.body ?? null,
                 query: input.query ?? {},
                 params: input.params ?? {},
-                segmentName,
                 // TS workaround
                 fetcher: undefined,
                 validateOnClient: undefined,

package/client/types.d.ts

@@ -51,7 +51,6 @@ export type _VovkClientFetcher<OPTS extends Record<string, KnownAny> = Record<st
     httpMethod: HttpMethod;
     getEndpoint: (data: {
         prefix: string;
-        segmentName?: string;
         params: {
             [key: string]: string;
         };

package/createDecorator.d.ts

@@ -1,4 +1,4 @@
-import type { _HandlerMetadata as HandlerMetadata, _KnownAny as KnownAny, _VovkController as VovkController, _VovkRequest as VovkRequest } from './types';
+import type { _HandlerSchema as HandlerSchema, _KnownAny as KnownAny, _VovkController as VovkController, _VovkRequest as 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<HandlerMetadata, 'path' | 'httpMethod'> | ((handlerMetadata: HandlerMetadata | null) => Omit<HandlerMetadata, '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<HandlerSchema, 'path' | 'httpMethod'> | ((handlerSchema: HandlerSchema | null) => Omit<HandlerSchema, 'path' | 'httpMethod'>) | null | undefined): (...args: ARGS) => (target: KnownAny, propertyKey: string) => void;
 export {};

package/createDecorator.js

@@ -10,16 +10,16 @@ function _createDecorator(handler, initHandler) {
                 throw new Error(`Unable to decorate: ${propertyKey} is not a function`);
             }
             const sourceMethod = originalMethod._sourceMethod ?? originalMethod;
-            const handlerMetadata = controller._handlers?.[propertyKey] ?? null;
+            const handlerSchema = controller._handlers?.[propertyKey] ?? null;
             const initResultReturn = initHandler?.call(controller, ...args);
-            const initResult = typeof initResultReturn === 'function' ? initResultReturn(handlerMetadata) : initResultReturn;
+            const initResult = typeof initResultReturn === 'function' ? initResultReturn(handlerSchema) : initResultReturn;
             controller._handlers = {
                 ...controller._handlers,
                 [propertyKey]: {
-                    ...handlerMetadata,
+                    ...handlerSchema,
                     // avoid override of path and httpMethod
                     ...(initResult?.clientValidators ? { clientValidators: initResult.clientValidators } : {}),
-                    ...(initResult?.customMetadata ? { customMetadata: initResult.customMetadata } : {}),
+                    ...(initResult?.customSchema ? { customSchema: initResult.customSchema } : {}),
                 },
             };
             const method = function method(req, params) {

package/createSegment.d.ts

@@ -34,7 +34,7 @@ export declare function _createSegment(): {
         controllers: Record<string, Function>;
         workers?: Record<string, Function>;
         exposeValidation?: boolean;
-        emitMetadata?: boolean;
+        emitSchema?: boolean;
         onError?: (err: Error, req: VovkRequest) => void | Promise<void>;
     }) => {
         GET: (req: VovkRequest, data: {

package/createSegment.js

@@ -17,7 +17,7 @@ const toKebabCase = (str) => {
 function _createSegment() {
     const segment = new Segment_1._Segment();
     const getDecoratorCreator = (httpMethod) => {
-        const assignMetadata = (controller, propertyKey, path, options) => {
+        const assignSchema = (controller, propertyKey, path, options) => {
             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.');
             }
@@ -47,7 +47,7 @@ function _createSegment() {
             const path = trimPath(givenPath);
             function decorator(givenTarget, propertyKey) {
                 const target = givenTarget;
-                assignMetadata(target, propertyKey, path, options);
+                assignSchema(target, propertyKey, path, options);
             }
             return decorator;
         }
@@ -63,7 +63,7 @@ function _createSegment() {
                         httpMethod,
                     },
                 };
-                assignMetadata(controller, propertyKey, toKebabCase(propertyKey), options);
+                assignSchema(controller, propertyKey, toKebabCase(propertyKey), options);
             }
             return decorator;
         };
@@ -80,19 +80,19 @@ function _createSegment() {
             return givenTarget;
         };
     };
-    const getMetadata = (options) => {
+    const getSchema = (options) => {
         const exposeValidation = options?.exposeValidation ?? true;
-        const emitMetadata = options.emitMetadata ?? true;
-        const metadata = {
-            emitMetadata,
+        const emitSchema = options.emitSchema ?? true;
+        const schema = {
+            emitSchema,
             segmentName: options.segmentName ?? '',
             controllers: {},
             workers: {},
         };
-        if (!emitMetadata)
-            return metadata;
+        if (!emitSchema)
+            return schema;
         for (const [controllerName, controller] of Object.entries(options.controllers)) {
-            metadata.controllers[controllerName] = {
+            schema.controllers[controllerName] = {
                 _controllerName: controllerName,
                 _prefix: controller._prefix ?? '',
                 _handlers: {
@@ -106,12 +106,12 @@ function _createSegment() {
             };
         }
         for (const [workerName, worker] of Object.entries(options.workers ?? {})) {
-            metadata.workers[workerName] = {
+            schema.workers[workerName] = {
                 _workerName: workerName,
                 _handlers: { ...worker._handlers },
             };
         }
-        return metadata;
+        return schema;
     };
     const initVovk = (options) => {
         for (const [controllerName, controller] of Object.entries(options.controllers)) {
@@ -122,10 +122,10 @@ function _createSegment() {
         async function GET_DEV(req, data) {
             const { params } = data;
             if (params[Object.keys(params)[0]]?.[0] === '_schema_') {
-                // Wait for metadata to be set (it can be set after decorators are called with another setTimeout)
+                // Wait for schema to be set (it can be set after decorators are called with another setTimeout)
                 await new Promise((resolve) => setTimeout(resolve, 10));
-                const metadata = getMetadata(options);
-                return segment.respond(200, { metadata });
+                const schema = getSchema(options);
+                return segment.respond(200, { schema });
             }
             return segment.GET(req, data);
         }

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 _VovkMetadata as VovkMetadata, _HttpStatus as HttpStatus, _HttpMethod as HttpMethod } from './types';
+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 { _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 VovkMetadata, 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 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 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;
@@ -33,7 +33,7 @@ export declare const get: {
     controllers: Record<string, Function>;
     workers?: Record<string, Function>;
     exposeValidation?: boolean;
-    emitMetadata?: boolean;
+    emitSchema?: boolean;
     onError?: (err: Error, req: VovkRequest) => void | Promise<void>;
 }) => {
     GET: (req: VovkRequest, data: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vovk",
-  "version": "3.0.0-beta.21",
+  "version": "3.0.0-beta.22",
   "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,45 +2,45 @@ 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 _VovkMetadata = {
-    emitMetadata: boolean;
+export type _VovkSchema = {
+    emitSchema: boolean;
     segmentName: string;
-    workers: Record<string, _VovkWorkerMetadata>;
-    controllers: Record<string, _VovkControllerMetadata>;
+    workers: Record<string, _VovkWorkerSchema>;
+    controllers: Record<string, _VovkControllerSchema>;
 };
 export type _VovkErrorResponse = {
     statusCode: _HttpStatus;
     message: string;
     isError: true;
 };
-export type _HandlerMetadata = {
+export type _HandlerSchema = {
     path: string;
     httpMethod: _HttpMethod;
     clientValidators?: {
         query?: _KnownAny;
         body?: _KnownAny;
     };
-    customMetadata?: Record<string, _KnownAny>;
+    customSchema?: Record<string, _KnownAny>;
 };
-export type _VovkControllerMetadata = {
+export type _VovkControllerSchema = {
     _controllerName: string;
     _prefix?: string;
-    _handlers: Record<string, _HandlerMetadata>;
+    _handlers: Record<string, _HandlerSchema>;
 };
-export type _VovkWorkerMetadata = {
+export type _VovkWorkerSchema = {
     _workerName: string;
     _handlers: Record<string, {
         isGenerator?: true;
     }>;
 };
-export type _VovkControllerInternal = _VovkControllerMetadata & {
+export type _VovkControllerInternal = _VovkControllerSchema & {
     _activated?: true;
     _onError?: (err: Error, req: _VovkRequest) => void | Promise<void>;
 };
 export type _VovkController = Function & _VovkControllerInternal & {
     [key: string]: unknown;
 };
-export type _VovkWorker = Function & _VovkWorkerMetadata & {
+export type _VovkWorker = Function & _VovkWorkerSchema & {
     [key: string]: unknown;
 };
 export type _DecoratorOptions = {
@@ -66,7 +66,7 @@ export interface _VovkRequest<BODY = undefined, QUERY extends object | undefined
     vovk: {
         body: () => Promise<BODY>;
         query: () => QUERY;
-        meta: <T = Record<_KnownAny, _KnownAny>>(metadata?: T | null) => T;
+        meta: <T = Record<_KnownAny, _KnownAny>>(meta?: T | null) => T;
     };
 }
 export type _ControllerStaticMethod<REQ extends _VovkRequest<undefined, _KnownAny> = _VovkRequest<undefined, Record<string, string | string[]>>, PARAMS extends {

package/utils/reqMeta.d.ts

@@ -1,3 +1,3 @@
 import { VovkRequest } from 'vovk';
 import { _KnownAny as KnownAny } from '../types';
-export default function reqMeta<T = Record<KnownAny, KnownAny>>(req: VovkRequest<KnownAny, KnownAny>, metadata?: T | null): T;
+export default function reqMeta<T = Record<KnownAny, KnownAny>>(req: VovkRequest<KnownAny, KnownAny>, meta?: T | null): T;

package/utils/reqMeta.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = reqMeta;
-const metadataMap = new WeakMap();
-function reqMeta(req, metadata) {
-    if (metadata) {
-        metadataMap.set(req, { ...metadataMap.get(req), ...metadata });
+const metaMap = new WeakMap();
+function reqMeta(req, meta) {
+    if (meta) {
+        metaMap.set(req, { ...metaMap.get(req), ...meta });
     }
-    else if (metadata === null) {
-        metadataMap.delete(req);
+    else if (meta === null) {
+        metaMap.delete(req);
     }
-    return (metadataMap.get(req) ?? {});
+    return (metaMap.get(req) ?? {});
 }

package/worker/promisifyWorker.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports._promisifyWorker = _promisifyWorker;
 function _promisifyWorker(currentWorker, givenWorkerService) {
     if (!givenWorkerService)
-        throw new Error('Worker metadata is not provided');
+        throw new Error('Worker schema is not provided');
     const workerService = givenWorkerService;
     const instance = {
         worker: currentWorker,

package/worker/worker.js

@@ -5,7 +5,7 @@ function _worker() {
     return (t) => {
         const target = t;
         target._handlers = {};
-        // Experimental: You can pass Worker Service instead of metadata to prommisify worker
+        // 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') {