oc-server 2.0.4 → 2.0.6

package/dist/Server.d.ts

@@ -35,6 +35,13 @@ type TransformOcParameters<T extends OcParameters> = Prettify<Pick<{
     [K in keyof T]: T[K]['mandatory'] extends true ? never : K;
 }[keyof T]>>>;
 interface ServerOptions<S extends boolean> {
+    /**
+     * If true, the server will stream the response to the client.
+     * This is useful for long polling or streaming responses.
+     * It will also serialize data structures like Map, Set, etc.
+     *
+     * @default false
+     */
     stream?: S;
 }
 export declare class Server<E = {
@@ -45,7 +52,7 @@ export declare class Server<E = {
     private _middleware;
     constructor(_options?: ServerOptions<Streaming>);
     middleware<I = MiddlewareInput, O = MiddlewareOutput>(action: Action<I, O, E, P, unknown>): Omit<Server<E, P, A, InitialInput, InitialOutput, I, O, Streaming>, P extends Record<string, unknown> ? IsGeneralStringName<E> extends false ? 'middleware' | 'definePlugins' | 'defineEnv' : 'middleware' | 'definePlugins' : IsGeneralStringName<E> extends false ? 'middleware' | 'defineEnv' : 'middleware'>;
-    withParameters<T extends OcParameters>(params: T): Server<E, P, A, TransformOcParameters<T>, InitialOutput, TransformOcParameters<T>, MiddlewareOutput, Streaming>;
+    withParameters<T extends OcParameters>(params: T): Server<E, P, A, TransformOcParameters<T>, InitialOutput, MiddlewareInput, MiddlewareOutput, Streaming>;
     defineEnv<Env>(): P extends Record<string, any> ? Omit<Server<Env, P, A, InitialInput, InitialOutput, MiddlewareInput, MiddlewareOutput, Streaming>, 'defineEnv' | 'definePlugins'> : Omit<Server<Env, P, A, InitialInput, InitialOutput, MiddlewareInput, MiddlewareOutput, Streaming>, 'defineEnv'>;
     definePlugins<Plugins>(): IsGeneralStringName<E> extends true ? Omit<Server<E, Plugins, A, InitialInput, InitialOutput, MiddlewareInput, MiddlewareOutput, Streaming>, 'definePlugins'> : Omit<Server<E, Plugins, A, InitialInput, InitialOutput, MiddlewareInput, MiddlewareOutput, Streaming>, 'definePlugins' | 'defineEnv'>;
     handler<I = InitialInput, O = InitialOutput>(action: Action<I, O, E, P, MiddlewareOutput>): HandledServer<E, P, A, I, O, MiddlewareInput, MiddlewareOutput, Streaming>;
@@ -68,6 +75,8 @@ export type RegisteredServer = Register extends {
 } ? TServer : AnyServer;
 export type GetMiddlewareInput<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, any, any, infer I> ? I : any;
 type GetInitialData<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, any, infer O, any, any, infer Streaming> ? Streaming extends true ? Exclude<O, undefined | null> : Exclude<ToPrettyJson<O>, undefined | null> : any;
+type GetHandlerParameters<TServer extends AnyServer> = TServer extends HandledServer<any, any, any, infer I, any, any, any, any> ? I : any;
+export type HandlerParameters = GetHandlerParameters<RegisteredServer>;
 export type InitialData = GetInitialData<RegisteredServer>;
 export type ComponentSettings = {
     id: string;

package/dist/serverClient.d.ts

@@ -1,7 +1,5 @@
 import { AnyServer, RegisteredServer, Action, GetMiddlewareInput } from './Server';
-import { Prettify, ToPrettyJson } from './types';
-type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
-type IsAny<T> = IfAny<T, true, never>;
+import { IsAny, Prettify, ToPrettyJson } from './types';
 type InferInput<R> = R extends Action<infer I, any, any, any, any> ? I : any;
 type InferOutput<R> = R extends Action<any, infer O, any, any, any> ? ToPrettyJson<O> : never;
 type IsEmptyObject<T> = keyof T extends never ? true : false;

package/dist/types.d.ts

@@ -46,4 +46,6 @@ export type DataContext<T = any, E = Env, P = any, S = unknown> = {
 } : {});
 type Callback<D, E = Error> = (error: E | null, data?: D) => void;
 export type DataProvider<Parameters = any, Return = any, Environment = Env> = (context: DataContext<Parameters, Environment>, callback: Callback<Return>) => void;
+type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
+export type IsAny<T> = IfAny<T, true, never>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oc-server",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",