vovk 3.0.0-draft.48 → 3.0.0-draft.50

package/.npmignore

@@ -1,2 +1,3 @@
 !*
-tsconfig.*
+tsconfig.*
+eslint.config.js

package/.turbo/turbo-build.log

@@ -0,0 +1,6 @@
+
+
+> vovk@3.0.0-draft.50 build
+> tsc
+
+\

package/.turbo/turbo-ncu.log

@@ -0,0 +1,9 @@
+
+
+> vovk@3.0.0-draft.49 ncu
+> npm-check-updates -u
+
+Upgrading /Users/andriigubanov/Work/vovk/packages/vovk/package.json
+
+No dependencies.
+\

package/.turbo/turbo-tsc.log

@@ -0,0 +1,6 @@
+
+
+> vovk@3.0.0-draft.49 tsc
+> tsc --noEmit
+
+\

package/README.md

@@ -1,112 +1 @@
-<p align="center"> 
-  <picture>
-    <source width="300" media="(prefers-color-scheme: dark)" srcset="https://vovk.dev/vovk-logo-white.svg">
-    <source width="300" media="(prefers-color-scheme: light)" srcset="https://vovk.dev/vovk-logo.svg">
-    <img width="300" alt="vovk" src="https://vovk.dev/vovk-logo.svg">
-  </picture><br>
-  <strong>RESTful RPC for Next.js</strong>
-  
-</p>
-
-<p align="center">
-  Transforms <a href="https://nextjs.org/docs/app">Next.js</a> into a powerful REST API platform with RPC capabilities. 
-  <br><br>
-  ℹ️ Improved syntax for Zod and DTO validation is coming soon. Stay tuned!
-</p>
-
-<p align="center">
-  <a href="https://vovk.dev/">Documentation</a>&nbsp;&nbsp;&nbsp;&nbsp;
-  <a href="https://discord.gg/qdT8WEHUuP">Discord</a>&nbsp;&nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/finom/vovk-examples">Code Examples</a>&nbsp;&nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/finom/vovk-zod">vovk-zod</a>&nbsp;&nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/finom/vovk-hello-world">vovk-hello-world</a>&nbsp;&nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/finom/vovk-react-native-example">vovk-react-native-example</a>
-</p>
-<p align="center">
-  <a href="https://www.npmjs.com/package/vovk"><img src="https://badge.fury.io/js/vovk.svg" alt="npm version" /></a>&nbsp;
-  <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" alt="TypeScript" /></a>&nbsp;
-  <a href="https://github.com/finom/vovk/actions/workflows/main.yml"><img src="https://github.com/finom/vovk/actions/workflows/main.yml/badge.svg" alt="Build status" /></a>
-</p>
-
- <br />
-
-Example back-end Controller Class:
-
-```ts
-// /src/modules/post/PostController.ts
-import { get, prefix, type VovkRequest } from 'vovk';
-import PostService from './PostService';
-
-@prefix('posts')
-export default class PostController {
-  /**
-   * Create a comment on a post
-   * POST /api/posts/:postId/comments
-   */
-  @post(':postId/comments')
-  static async createComment(
-    // decorate NextRequest type with body and query types
-    req: VovkRequest<{ content: string; userId: string }, { notificationType: 'push' | 'email' }>,
-    { postId }: { postId: string } // params
-  ) {
-    // use standard Next.js API to get body and query
-    const { content, userId } = await req.json();
-    const notificationType = req.nextUrl.searchParams.get('notificationType');
-
-    // perform the request to the database in a custom service
-    return PostService.createComment({
-      postId,
-      content,
-      userId,
-      notificationType,
-    });
-  }
-}
-```
-
-Example component that uses the auto-generated client library:
-
-```tsx
-'use client';
-import { useState } from 'react';
-import { PostController } from 'vovk-client';
-import type { VovkReturnType } from 'vovk';
-
-export default function Example() {
-  const [response, setResponse] = useState<VovkReturnType<typeof PostController.createComment>>();
-
-  return (
-    <>
-      <button
-        onClick={async () =>
-          setResponse(
-            await PostController.createComment({
-              body: {
-                content: 'Hello, World!',
-                userId: '1',
-              },
-              params: { postId: '69' },
-              query: { notificationType: 'push' },
-            })
-          )
-        }
-      >
-        Post a comment
-      </button>
-      <div>{JSON.stringify(response)}</div>
-    </>
-  );
-}
-```
-
-Alternatively, the resource can be fetched wit the regular `fetch` function:
-
-```ts
-fetch('/api/posts/69?notificationType=push', {
-  method: 'POST',
-  body: JSON.stringify({
-    content: 'Hello, World!',
-    userId: '1',
-  }),
-});
-```
+Description is coming soon.

package/{StreamJSONResponse.d.ts → dist/StreamJSONResponse.d.ts}

@@ -1,4 +1,4 @@
-import { KnownAny, StreamAbortMessage } from './types';
+import type { KnownAny, StreamAbortMessage } from './types';
 import './utils/shim';
 export declare class StreamJSONResponse<T> extends Response {
     static defaultHeaders: {

package/dist/client/createRPC.d.ts

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

package/{client/clientizeController.js → dist/client/createRPC.js}

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.clientizeController = exports.ARRAY_QUERY_KEY = void 0;
+exports.createRPC = exports.ARRAY_QUERY_KEY = void 0;
 const defaultFetcher_1 = __importDefault(require("./defaultFetcher"));
 const defaultHandler_1 = require("./defaultHandler");
 const defaultStreamHandler_1 = require("./defaultStreamHandler");
@@ -37,7 +37,7 @@ const getHandlerPath = (endpoint, params, query) => {
     }
     return `${result}${hasQuery ? '?' : ''}${searchParams.toString()}`;
 };
-const clientizeController = (controllerSchema, segmentName, options) => {
+const createRPC = (controllerSchema, segmentName, options) => {
     const schema = controllerSchema;
     const client = {};
     if (!schema)
@@ -90,4 +90,4 @@ const clientizeController = (controllerSchema, segmentName, options) => {
     }
     return client;
 };
-exports.clientizeController = clientizeController;
+exports.createRPC = createRPC;

package/dist/client/index.d.ts

@@ -0,0 +1,4 @@
+import { createRPC } from './createRPC';
+import type { VovkClientFetcher, VovkClientOptions, VovkDefaultFetcherOptions, VovkValidateOnClient } from './types';
+export { createRPC };
+export type { VovkClientFetcher, VovkClientOptions, VovkDefaultFetcherOptions, VovkValidateOnClient };

package/dist/client/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRPC = void 0;
+const createRPC_1 = require("./createRPC");
+Object.defineProperty(exports, "createRPC", { enumerable: true, get: function () { return createRPC_1.createRPC; } });

package/{index.d.ts → dist/index.d.ts}

@@ -1,12 +1,13 @@
 import { createVovkApp } from './createVovkApp';
-import { HttpStatus as HttpStatus, HttpMethod as HttpMethod, type VovkErrorResponse, type VovkRequest, type VovkBody, type VovkQuery, type VovkParams, type VovkReturnType, type VovkYieldType, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkSchema } from './types';
-import type { VovkClientOptions as VovkClientOptions, VovkClientFetcher as VovkClientFetcher, VovkDefaultFetcherOptions as VovkDefaultFetcherOptions, VovkValidateOnClient as VovkValidateOnClient } from './client/types';
+import { HttpStatus as HttpStatus, HttpMethod as HttpMethod, type VovkErrorResponse, type VovkRequest, type VovkBody, type VovkQuery, type VovkParams, type VovkReturnType, type VovkYieldType, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkSchema, type VovkWorkerSchema, type VovkControllerSchema } from './types';
+import { type VovkClientOptions, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, createRPC } from './client';
 import { HttpException } from './HttpException';
 import { createDecorator } from './createDecorator';
 import { StreamJSONResponse } from './StreamJSONResponse';
-import { worker } from './worker';
+import { worker, createWPC } from './worker';
 import { generateStaticAPI } from './utils/generateStaticAPI';
-export { type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkBody, type VovkQuery, type VovkParams, type VovkYieldType, type VovkReturnType, type VovkClientOptions, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, worker, generateStaticAPI, };
+import { setClientValidatorsForHandler } from './utils/setClientValidatorsForHandler';
+export { type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkSchema, type VovkErrorResponse, type VovkRequest, type VovkControllerBody, type VovkControllerQuery, type VovkControllerParams, type VovkControllerYieldType, type VovkBody, type VovkQuery, type VovkParams, type VovkYieldType, type VovkReturnType, type VovkClientOptions, type VovkWorkerSchema, type VovkControllerSchema, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, worker, createWPC, createRPC, generateStaticAPI, setClientValidatorsForHandler, };
 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;

package/{index.js → dist/index.js}

@@ -1,12 +1,14 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initVovk = exports.prefix = exports.options = exports.head = exports.del = exports.patch = exports.put = exports.post = exports.get = exports.generateStaticAPI = exports.worker = exports.createDecorator = exports.createVovkApp = exports.HttpMethod = exports.HttpStatus = exports.HttpException = exports.StreamJSONResponse = void 0;
+exports.initVovk = exports.prefix = exports.options = exports.head = exports.del = exports.patch = exports.put = exports.post = exports.get = exports.setClientValidatorsForHandler = exports.generateStaticAPI = exports.createRPC = exports.createWPC = exports.worker = exports.createDecorator = exports.createVovkApp = exports.HttpMethod = exports.HttpStatus = exports.HttpException = exports.StreamJSONResponse = void 0;
 const createVovkApp_1 = require("./createVovkApp");
 Object.defineProperty(exports, "createVovkApp", { enumerable: true, get: function () { return createVovkApp_1.createVovkApp; } });
 const types_1 = require("./types");
 Object.defineProperty(exports, "HttpStatus", { enumerable: true, get: function () { return types_1.HttpStatus; } });
 Object.defineProperty(exports, "HttpMethod", { enumerable: true, get: function () { return types_1.HttpMethod; } });
+const client_1 = require("./client");
+Object.defineProperty(exports, "createRPC", { enumerable: true, get: function () { return client_1.createRPC; } });
 const HttpException_1 = require("./HttpException");
 Object.defineProperty(exports, "HttpException", { enumerable: true, get: function () { return HttpException_1.HttpException; } });
 const createDecorator_1 = require("./createDecorator");
@@ -15,6 +17,9 @@ const StreamJSONResponse_1 = require("./StreamJSONResponse");
 Object.defineProperty(exports, "StreamJSONResponse", { enumerable: true, get: function () { return StreamJSONResponse_1.StreamJSONResponse; } });
 const worker_1 = require("./worker");
 Object.defineProperty(exports, "worker", { enumerable: true, get: function () { return worker_1.worker; } });
+Object.defineProperty(exports, "createWPC", { enumerable: true, get: function () { return worker_1.createWPC; } });
 const generateStaticAPI_1 = require("./utils/generateStaticAPI");
 Object.defineProperty(exports, "generateStaticAPI", { enumerable: true, get: function () { return generateStaticAPI_1.generateStaticAPI; } });
+const setClientValidatorsForHandler_1 = require("./utils/setClientValidatorsForHandler");
+Object.defineProperty(exports, "setClientValidatorsForHandler", { enumerable: true, get: function () { return setClientValidatorsForHandler_1.setClientValidatorsForHandler; } });
 _a = (0, createVovkApp_1.createVovkApp)(), exports.get = _a.get, exports.post = _a.post, exports.put = _a.put, exports.patch = _a.patch, exports.del = _a.del, exports.head = _a.head, exports.options = _a.options, exports.prefix = _a.prefix, exports.initVovk = _a.initVovk;

package/{utils → dist/utils}/generateStaticAPI.d.ts

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

package/{utils → dist/utils}/getSchema.d.ts

@@ -1,4 +1,4 @@
-import { VovkSchema as VovkSchema, StaticClass as StaticClass } from '../types';
+import type { VovkSchema, StaticClass } from '../types';
 export default function getSchema(options: {
     emitSchema?: boolean;
     segmentName?: string;

package/{utils → dist/utils}/reqForm.d.ts

@@ -1,3 +1,2 @@
-import { VovkRequest } from 'vovk';
-import { KnownAny as KnownAny } from '../types';
+import type { KnownAny, VovkRequest } from '../types';
 export default function reqForm<T = KnownAny>(req: VovkRequest<KnownAny, KnownAny>): Promise<T>;

package/{utils → dist/utils}/reqMeta.d.ts

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

package/{utils → dist/utils}/reqQuery.d.ts

@@ -1,3 +1,2 @@
-import { KnownAny as KnownAny } from '../types';
-import { VovkRequest } from 'vovk';
+import type { KnownAny, VovkRequest } from '../types';
 export default function reqQuery<T extends object | undefined>(req: VovkRequest<KnownAny, T>): T;

package/{utils → dist/utils}/reqQuery.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = reqQuery;
-const clientizeController_1 = require("../client/clientizeController");
+const createRPC_1 = require("../client/createRPC");
 function reqQuery(req) {
-    const queryArr = req.nextUrl.searchParams.get(clientizeController_1.ARRAY_QUERY_KEY)?.split(',') ?? null;
+    const queryArr = req.nextUrl.searchParams.get(createRPC_1.ARRAY_QUERY_KEY)?.split(',') ?? null;
     const entries = [...req.nextUrl.searchParams.entries()];
     const query = entries.reduce((acc, [key, value]) => {
-        if (key === clientizeController_1.ARRAY_QUERY_KEY)
+        if (key === createRPC_1.ARRAY_QUERY_KEY)
             return acc;
         if (queryArr?.includes(key)) {
             if (!(key in acc)) {

package/dist/utils/setClientValidatorsForHandler.d.ts

@@ -0,0 +1,5 @@
+import type { KnownAny } from '../types';
+export declare function setClientValidatorsForHandler(h: (...args: KnownAny[]) => KnownAny, validation: {
+    body: unknown;
+    query: unknown;
+}): Promise<void>;

package/{utils → dist/utils}/setClientValidatorsForHandler.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = setClientValidatorsForHandler;
+exports.setClientValidatorsForHandler = setClientValidatorsForHandler;
 function setClientValidatorsForHandler(h, validation) {
     return new Promise((resolve) => {
+        // the setTimeout is necessary to ensure that the _controller is already defined
         setTimeout(() => {
             const controller = h._controller;
             if (!controller) {

package/dist/worker/createWPC.d.ts

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

package/{worker/promisifyWorker.js → dist/worker/createWPC.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promisifyWorker = promisifyWorker;
-function promisifyWorker(currentWorker, workerSchema) {
+exports.createWPC = createWPC;
+function createWPC(currentWorker, workerSchema) {
     if (!workerSchema)
         throw new Error('Worker schema is not provided');
     const schema = workerSchema;
@@ -23,7 +23,7 @@ function promisifyWorker(currentWorker, workerSchema) {
         instance.worker = worker;
         return instance;
     };
-    instance.fork = (worker) => promisifyWorker(worker, schema);
+    instance.fork = (worker) => createWPC(worker, schema);
     for (const methodName of Object.keys(schema.handlers)) {
         const { isGenerator } = schema.handlers[methodName];
         if (isGenerator) {

package/dist/worker/index.d.ts

@@ -0,0 +1,3 @@
+import { worker } from './worker';
+import { createWPC } from './createWPC';
+export { worker, createWPC };

package/dist/worker/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWPC = exports.worker = void 0;
+const worker_1 = require("./worker");
+Object.defineProperty(exports, "worker", { enumerable: true, get: function () { return worker_1.worker; } });
+const createWPC_1 = require("./createWPC");
+Object.defineProperty(exports, "createWPC", { enumerable: true, get: function () { return createWPC_1.createWPC; } });

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "vovk",
-  "version": "3.0.0-draft.48",
+  "version": "3.0.0-draft.50",
+  "main": "dist/index.js",
   "description": "RESTful RPC for Next.js - Transforms Next.js into a powerful REST API platform with RPC capabilities.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/finom/vovk.git"
   },
   "scripts": {
-    "build": "shx rm -rf dist && tsc && shx cp package.json LICENSE .npmignore dist && shx cp ../../README.md dist",
+    "build": "tsc",
+    "rm-dist": "shx rm -rf dist",
     "lint": "eslint . --fix",
     "tsc": "tsc --noEmit",
     "npm-publish": "if [ -z \"$NPM_TAG\" ]; then echo 'Error: NPM_TAG is not set'; exit 1; fi; cd ./dist && npm publish --tag=$NPM_TAG && cd ..",

package/src/HttpException.ts

@@ -0,0 +1,16 @@
+import type { HttpStatus } from './types';
+
+export class HttpException extends Error {
+  statusCode: HttpStatus;
+
+  message: string;
+
+  cause?: unknown;
+
+  constructor(statusCode: HttpStatus, message: string, cause?: unknown) {
+    super(message);
+    this.statusCode = statusCode;
+    this.message = message;
+    this.cause = cause;
+  }
+}

package/src/StreamJSONResponse.ts

@@ -0,0 +1,62 @@
+import type { KnownAny, StreamAbortMessage } from './types';
+import './utils/shim';
+
+export class StreamJSONResponse<T> extends Response {
+  public static defaultHeaders = {
+    'content-type': 'text/plain; charset=utf-8',
+    'x-vovk-stream': 'true',
+  };
+
+  public isClosed = false;
+
+  public controller?: ReadableStreamDefaultController;
+
+  public readonly encoder: TextEncoder;
+
+  public readonly readableStream: ReadableStream;
+
+  constructor(init?: ResponseInit) {
+    const encoder = new TextEncoder();
+    let readableController: ReadableStreamDefaultController;
+
+    const readableStream = new ReadableStream({
+      cancel: () => {
+        this.isClosed = true;
+      },
+      start: (controller) => {
+        readableController = controller;
+      },
+    });
+
+    super(readableStream, {
+      ...init,
+      headers: init?.headers ?? StreamJSONResponse.defaultHeaders,
+    });
+
+    this.readableStream = readableStream;
+    this.encoder = encoder;
+    this.controller = readableController!;
+  }
+
+  public send(data: T | StreamAbortMessage) {
+    const { controller, encoder } = this;
+    if (this.isClosed) return;
+    return controller?.enqueue(encoder.encode(JSON.stringify(data) + '\n'));
+  }
+
+  public close() {
+    const { controller } = this;
+    if (this.isClosed) return;
+    this.isClosed = true;
+    controller?.close();
+  }
+
+  public throw(e: KnownAny) {
+    this.send({ isError: true, reason: e instanceof Error ? e.message : (e as unknown) });
+    return this.close();
+  }
+
+  public [Symbol.dispose]() {
+    this.close();
+  }
+}