vovk 3.0.0-draft.58 → 3.0.0-draft.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import type { StreamAsyncIterator } from './types';
1
+ import type { VovkStreamAsyncIterable } from './types';
2
2
  import '../utils/shim';
3
3
  export declare const DEFAULT_ERROR_MESSAGE = "Unknown error at defaultStreamHandler";
4
- export declare const defaultStreamHandler: (response: Response) => Promise<StreamAsyncIterator<unknown>>;
4
+ export declare const defaultStreamHandler: (response: Response) => Promise<VovkStreamAsyncIterable<unknown>>;
@@ -1,2 +1,2 @@
1
1
  export { default as createRPC } from './createRPC';
2
- export type { VovkClient, VovkClientFetcher, VovkClientOptions, VovkDefaultFetcherOptions, VovkValidateOnClient, } from './types';
2
+ export type { VovkClient, VovkClientFetcher, VovkClientOptions, VovkDefaultFetcherOptions, VovkValidateOnClient, VovkStreamAsyncIterable, } from './types';
@@ -17,7 +17,7 @@ export type StaticMethodInput<T extends ControllerStaticMethod> = (VovkControlle
17
17
  params: VovkControllerParams<T>;
18
18
  });
19
19
  type ToPromise<T> = T extends PromiseLike<unknown> ? T : Promise<T>;
20
- export type StreamAsyncIterator<T> = {
20
+ export type VovkStreamAsyncIterable<T> = {
21
21
  status: number;
22
22
  [Symbol.dispose](): Promise<void> | void;
23
23
  [Symbol.asyncDispose](): Promise<void> | void;
@@ -34,7 +34,7 @@ type ClientMethod<T extends (...args: KnownAny[]) => void | object | StreamJSONR
34
34
  params: StaticMethodInput<T>['params'];
35
35
  } : unknown : StaticMethodInput<T>) & (Partial<OPTS & {
36
36
  transform: (staticMethodReturn: Awaited<StaticMethodReturn<T>>) => R;
37
- }> | void)) => ReturnType<T> extends Promise<StreamJSONResponse<infer U>> | StreamJSONResponse<infer U> | Iterator<infer U> | AsyncIterator<infer U> ? Promise<StreamAsyncIterator<U>> : R extends object ? Promise<R> : StaticMethodReturnPromise<T>) & {
37
+ }> | void)) => ReturnType<T> extends Promise<StreamJSONResponse<infer U>> | StreamJSONResponse<infer U> | Iterator<infer U> | AsyncIterator<infer U> ? Promise<VovkStreamAsyncIterable<U>> : R extends object ? Promise<R> : StaticMethodReturnPromise<T>) & {
38
38
  schema: VovkHandlerSchema;
39
39
  controllerSchema: VovkControllerSchema;
40
40
  };
@@ -66,7 +66,7 @@ export type VovkClientFetcher<OPTS extends Record<string, KnownAny> = Record<str
66
66
  query?: unknown;
67
67
  endpoint: string;
68
68
  }) => void | Promise<void>;
69
- defaultStreamHandler: (response: Response) => Promise<StreamAsyncIterator<unknown>>;
69
+ defaultStreamHandler: (response: Response) => Promise<VovkStreamAsyncIterable<unknown>>;
70
70
  defaultHandler: (response: Response) => Promise<unknown>;
71
71
  }, input: {
72
72
  body: unknown;
package/dist/index.d.ts CHANGED
@@ -1,12 +1,12 @@
1
1
  import { createVovkApp } from './createVovkApp';
2
2
  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 VovkSchema, type VovkControllerSchema, type VovkHandlerSchema } from './types';
3
- import { type VovkClient, type VovkClientOptions, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, createRPC } from './client';
3
+ import { type VovkClient, type VovkClientOptions, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkValidateOnClient, type VovkStreamAsyncIterable, createRPC } from './client';
4
4
  import { HttpException } from './HttpException';
5
5
  import { createDecorator } from './createDecorator';
6
6
  import { StreamJSONResponse } from './StreamJSONResponse';
7
7
  import { generateStaticAPI } from './utils/generateStaticAPI';
8
8
  import { setClientValidatorsForHandler } from './utils/setClientValidatorsForHandler';
9
- export { type KnownAny, type VovkClient, 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 VovkControllerSchema, type VovkHandlerSchema, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, createRPC, generateStaticAPI, setClientValidatorsForHandler, };
9
+ export { type KnownAny, type VovkClient, type VovkClientFetcher, type VovkDefaultFetcherOptions, type VovkStreamAsyncIterable, 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 VovkControllerSchema, type VovkHandlerSchema, StreamJSONResponse, HttpException, HttpStatus, HttpMethod, createVovkApp, createDecorator, createRPC, generateStaticAPI, setClientValidatorsForHandler, };
10
10
  export declare const get: {
11
11
  (givenPath?: string | undefined, options?: import("./types").DecoratorOptions | undefined): ReturnType<(givenPath?: string, options?: import("./types").DecoratorOptions) => (givenTarget: KnownAny, propertyKey: string) => void>;
12
12
  auto: (options?: import("./types").DecoratorOptions) => (givenTarget: KnownAny, propertyKey: string) => void;
package/dist/types.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { NextRequest } from 'next/server';
2
2
  import type { StreamJSONResponse } from './StreamJSONResponse';
3
- import { StreamAsyncIterator } from './client/types';
3
+ import { VovkStreamAsyncIterable } from './client/types';
4
4
  export type KnownAny = any;
5
5
  export type StaticClass = Function;
6
6
  export type VovkHandlerSchema = {
@@ -77,7 +77,7 @@ export type VovkControllerYieldType<T extends (req: VovkRequest<KnownAny, KnownA
77
77
  export type VovkBody<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['body'];
78
78
  export type VovkQuery<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['query'];
79
79
  export type VovkParams<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['params'];
80
- export type VovkYieldType<T extends (...args: KnownAny[]) => unknown> = T extends (...args: KnownAny[]) => Promise<StreamAsyncIterator<infer Y>> ? Y : never;
80
+ export type VovkYieldType<T extends (...args: KnownAny[]) => unknown> = T extends (...args: KnownAny[]) => Promise<VovkStreamAsyncIterable<infer Y>> ? Y : never;
81
81
  export type VovkReturnType<T extends (...args: KnownAny) => unknown> = Awaited<ReturnType<T>>;
82
82
  export type StreamAbortMessage = {
83
83
  isError: true;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vovk",
3
- "version": "3.0.0-draft.58",
3
+ "version": "3.0.0-draft.60",
4
4
  "main": "dist/index.js",
5
5
  "description": "RESTful RPC for Next.js - Transforms Next.js into a powerful REST API platform with RPC capabilities.",
6
6
  "repository": {
@@ -1,11 +1,11 @@
1
1
  import { HttpStatus, type VovkErrorResponse } from '../types';
2
- import type { StreamAsyncIterator } from './types';
2
+ import type { VovkStreamAsyncIterable } from './types';
3
3
  import { HttpException } from '../HttpException';
4
4
  import '../utils/shim';
5
5
 
6
6
  export const DEFAULT_ERROR_MESSAGE = 'Unknown error at defaultStreamHandler';
7
7
 
8
- export const defaultStreamHandler = async (response: Response): Promise<StreamAsyncIterator<unknown>> => {
8
+ export const defaultStreamHandler = async (response: Response): Promise<VovkStreamAsyncIterable<unknown>> => {
9
9
  if (!response.ok) {
10
10
  let result: unknown;
11
11
  try {
@@ -5,4 +5,5 @@ export type {
5
5
  VovkClientOptions,
6
6
  VovkDefaultFetcherOptions,
7
7
  VovkValidateOnClient,
8
+ VovkStreamAsyncIterable,
8
9
  } from './types';
@@ -21,7 +21,7 @@ export type StaticMethodInput<T extends ControllerStaticMethod> = (VovkControlle
21
21
 
22
22
  type ToPromise<T> = T extends PromiseLike<unknown> ? T : Promise<T>;
23
23
 
24
- export type StreamAsyncIterator<T> = {
24
+ export type VovkStreamAsyncIterable<T> = {
25
25
  status: number;
26
26
  [Symbol.dispose](): Promise<void> | void;
27
27
  [Symbol.asyncDispose](): Promise<void> | void;
@@ -60,7 +60,7 @@ type ClientMethod<
60
60
  | StreamJSONResponse<infer U>
61
61
  | Iterator<infer U>
62
62
  | AsyncIterator<infer U>
63
- ? Promise<StreamAsyncIterator<U>>
63
+ ? Promise<VovkStreamAsyncIterable<U>>
64
64
  : R extends object
65
65
  ? Promise<R>
66
66
  : StaticMethodReturnPromise<T>) & {
@@ -88,7 +88,7 @@ export type VovkClientFetcher<OPTS extends Record<string, KnownAny> = Record<str
88
88
  query: { [key: string]: string };
89
89
  }) => string;
90
90
  validate: (input: { body?: unknown; query?: unknown; endpoint: string }) => void | Promise<void>;
91
- defaultStreamHandler: (response: Response) => Promise<StreamAsyncIterator<unknown>>;
91
+ defaultStreamHandler: (response: Response) => Promise<VovkStreamAsyncIterable<unknown>>;
92
92
  defaultHandler: (response: Response) => Promise<unknown>;
93
93
  },
94
94
  input: {
package/src/index.ts CHANGED
@@ -24,6 +24,7 @@ import {
24
24
  type VovkClientFetcher,
25
25
  type VovkDefaultFetcherOptions,
26
26
  type VovkValidateOnClient,
27
+ type VovkStreamAsyncIterable,
27
28
  createRPC,
28
29
  } from './client';
29
30
  import { HttpException } from './HttpException';
@@ -37,6 +38,7 @@ export {
37
38
  type VovkClient,
38
39
  type VovkClientFetcher,
39
40
  type VovkDefaultFetcherOptions,
41
+ type VovkStreamAsyncIterable,
40
42
  type VovkValidateOnClient,
41
43
  type VovkSchema,
42
44
  type VovkErrorResponse,
package/src/types.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { NextRequest } from 'next/server';
2
2
  import type { StreamJSONResponse } from './StreamJSONResponse';
3
- import { StreamAsyncIterator } from './client/types';
3
+ import { VovkStreamAsyncIterable } from './client/types';
4
4
 
5
5
  export type KnownAny = any; // eslint-disable-line @typescript-eslint/no-explicit-any
6
6
 
@@ -124,7 +124,7 @@ export type VovkParams<T extends (...args: KnownAny[]) => unknown> = Parameters<
124
124
 
125
125
  export type VovkYieldType<T extends (...args: KnownAny[]) => unknown> = T extends (
126
126
  ...args: KnownAny[]
127
- ) => Promise<StreamAsyncIterator<infer Y>>
127
+ ) => Promise<VovkStreamAsyncIterable<infer Y>>
128
128
  ? Y
129
129
  : never;
130
130