oc-server 1.1.11 → 2.0.1

package/dist/Server.d.ts

@@ -1,4 +1,4 @@
-import { Prettify, ToJson, DataContext, DataProvider } from './types';
+import { Prettify, DataContext, DataProvider, ToPrettyJson } from './types';
 export type ServerContext<E = {
     name: string;
 }, P = any, S = any> = Omit<DataContext<any, E, P, S>, 'params' | 'action' | 'setEmptyResponse'>;
@@ -34,25 +34,30 @@ 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> {
+    stream?: S;
+}
 export declare class Server<E = {
     name: string;
-}, P = unknown, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any> {
+}, P = unknown, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any, Streaming extends boolean = false> {
+    private readonly _options;
     private _parameters;
     private _middleware;
-    constructor();
-    middleware<I = MiddlewareInput, O = MiddlewareOutput>(action: Action<I, O, E, P, unknown>): Omit<Server<E, P, A, InitialInput, InitialOutput, I, O>, 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>;
-    defineEnv<Env>(): P extends Record<string, any> ? Omit<Server<Env, P, A, InitialInput, InitialOutput>, 'defineEnv' | 'definePlugins'> : Omit<Server<Env, P, A, InitialInput, InitialOutput>, 'defineEnv'>;
-    definePlugins<Plugins>(): IsGeneralStringName<E> extends true ? Omit<Server<E, Plugins, A, InitialInput, InitialOutput>, 'definePlugins'> : Omit<Server<E, Plugins, A, InitialInput, InitialOutput>, 'definePlugins' | 'defineEnv'>;
-    handler<I = InitialInput, O = InitialOutput>(action: Action<I, O, E, P, MiddlewareOutput>): HandledServer<E, P, A, I, O, MiddlewareInput, MiddlewareOutput>;
+    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>;
+    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>;
 }
-declare class HandledServer<E, P, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any> {
+declare class HandledServer<E, P, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any, Streaming extends boolean = false> {
     readonly initial: Action<InitialInput, InitialOutput, E, P, MiddlewareOutput>;
     private readonly _middleware;
     private readonly _parameters;
+    private readonly _options;
     readonly actions: A;
-    constructor(initial: Action<InitialInput, InitialOutput, E, P, MiddlewareOutput>, _middleware?: Action<MiddlewareInput, MiddlewareOutput, E, P, unknown> | null, _parameters?: OcParameters);
-    action<ActionName extends string, I, O>(name: ActionName, action: Action<I, O, E, P, MiddlewareOutput>): HandledServer<E, P, Prettify<A & Record<ActionName, Action<I, O, E, P, MiddlewareOutput>>>, InitialInput, InitialOutput, MiddlewareInput, MiddlewareOutput>;
+    constructor(initial: Action<InitialInput, InitialOutput, E, P, MiddlewareOutput>, _middleware?: Action<MiddlewareInput, MiddlewareOutput, E, P, unknown> | null, _parameters?: OcParameters, _options?: ServerOptions<Streaming>);
+    action<ActionName extends string, I, O>(name: ActionName, action: Action<I, O, E, P, MiddlewareOutput>): HandledServer<E, P, Prettify<A & Record<ActionName, Action<I, O, E, P, MiddlewareOutput>>>, InitialInput, InitialOutput, MiddlewareInput, MiddlewareOutput, Streaming>;
     getData(): DataProvider<any, any, any>;
 }
 export interface Register {
@@ -62,7 +67,7 @@ export type RegisteredServer = Register extends {
     server: infer TServer extends AnyServer;
 } ? 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> ? Exclude<ToJson<O>, undefined | null> : 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;
 export type InitialData = GetInitialData<RegisteredServer>;
 export type ComponentSettings = {
     id: string;

package/dist/Server.js

@@ -2,9 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServerError = exports.getSettings = exports.getInitialData = exports.Server = void 0;
 class Server {
+    _options;
     _parameters = {};
     _middleware = null;
-    constructor() { }
+    constructor(_options = {}) {
+        this._options = _options;
+    }
     middleware(action) {
         this._middleware = action;
         return this;
@@ -20,7 +23,7 @@ class Server {
         return this;
     }
     handler(action) {
-        return new HandledServer(action, this._middleware, this._parameters);
+        return new HandledServer(action, this._middleware, this._parameters, this._options);
     }
 }
 exports.Server = Server;
@@ -28,11 +31,13 @@ class HandledServer {
     initial;
     _middleware;
     _parameters;
+    _options;
     actions = {};
-    constructor(initial, _middleware = null, _parameters = {}) {
+    constructor(initial, _middleware = null, _parameters = {}, _options = {}) {
         this.initial = initial;
         this._middleware = _middleware;
         this._parameters = _parameters;
+        this._options = _options;
     }
     action(name, action) {
         this.actions[name] = action;
@@ -58,6 +63,8 @@ class HandledServer {
                 cb(err);
                 return;
             }
+            const stream = !!this._options.stream;
+            res[context.streamSymbol] = stream;
             cb(null, res);
         };
     }

package/dist/serverClient.d.ts

@@ -1,9 +1,9 @@
 import { AnyServer, RegisteredServer, Action, GetMiddlewareInput } from './Server';
-import { Prettify, ToJson } from './types';
+import { Prettify, ToPrettyJson } from './types';
 type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
 type IsAny<T> = IfAny<T, true, never>;
 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> ? ToJson<O> : never;
+type InferOutput<R> = R extends Action<any, infer O, any, any, any> ? ToPrettyJson<O> : never;
 type ServerClient<TServer extends AnyServer> = {
     readonly [Property in keyof TServer['actions']]: (input: Prettify<InferInput<TServer['actions'][Property]> & (IsAny<GetMiddlewareInput<TServer>> extends never ? GetMiddlewareInput<TServer> : {})>) => Promise<InferOutput<TServer['actions'][Property]>>;
 };

package/dist/types.d.ts

@@ -2,9 +2,13 @@ export type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type JsonPrimitive = string | number | boolean | null;
-export type ToJson<T> = T extends Date | RegExp ? string : T extends Function ? never : T extends JsonPrimitive ? T : T extends Array<infer U> ? ToJson<U>[] : T extends object ? {
+type CleanNeverProperties<T> = {
+    [K in keyof T as T[K] extends never ? never : K]: T[K];
+};
+type ToJson<T> = T extends Date | RegExp ? string : T extends Function ? never : T extends Promise<any> ? {} : T extends JsonPrimitive ? T : T extends Array<infer U> ? ToJson<U>[] : T extends object ? {
     [K in keyof T]: ToJson<T[K]>;
 } : never;
+export type ToPrettyJson<T> = CleanNeverProperties<Prettify<ToJson<T>>>;
 export interface AcceptLanguage {
     code: string;
     script?: any;

package/package.json

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