oc-server 0.4.5 → 1.0.0

package/dist/Server.d.ts

@@ -1,23 +1,41 @@
 import { DataContext, DataProvider } from './types';
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
 export type ServerContext<E = {
     name: string;
-}, P = any> = Omit<DataContext<any, E, P>, 'params' | 'action' | 'setEmptyResponse'>;
-export type Action<I, O, E> = (params: I, ctx: ServerContext<E>) => Promise<O> | O;
-type AnyAction = Action<any, any, any>;
-export declare class Server<E, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any> {
-    readonly initial: Action<InitialInput, InitialOutput, E>;
+}, P = any, S = any> = Omit<DataContext<any, E, P, S>, 'params' | 'action' | 'setEmptyResponse'>;
+export type Action<I, O, E, P, S> = (params: I, ctx: ServerContext<E, P, S>) => Promise<O> | O;
+type AnyAction = Action<any, any, any, any, any>;
+type IsGeneralStringName<T> = T extends {
+    name: infer N;
+} ? N extends string ? string extends N ? true : false : false : false;
+export declare class Server<E = {
+    name: string;
+}, P = unknown, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any> {
+    private _middleware;
+    constructor();
+    middleware<I, O>(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'>;
+    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, O>(action: Action<I, O, E, P, MiddlewareOutput>): HandledServer<E, P, A, I, O, MiddlewareInput, MiddlewareOutput>;
+}
+declare class HandledServer<E, P, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any> {
+    readonly initial: Action<InitialInput, InitialOutput, E, P, MiddlewareOutput>;
+    private readonly _middleware;
     readonly actions: A;
-    constructor(initial: Action<InitialInput, InitialOutput, E>);
-    action<ActionName extends string, I, O>(name: ActionName, action: Action<I, O, E>): Server<E, A & Record<ActionName, Action<I, O, E>>, InitialInput, InitialOutput>;
+    constructor(initial: Action<InitialInput, InitialOutput, E, P, MiddlewareOutput>, _middleware?: Action<MiddlewareInput, MiddlewareOutput, E, P, unknown> | null);
+    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>;
     getData(): DataProvider<any, any, any>;
 }
 export interface Register {
 }
-export type AnyServer = Server<any, any>;
+export type AnyServer = HandledServer<any, any>;
 export type RegisteredServer = Register extends {
     server: infer TServer extends AnyServer;
 } ? TServer : AnyServer;
-type GetInitialData<TServer extends AnyServer> = TServer extends Server<any, any, any, infer O> ? Exclude<O, undefined | null> : any;
+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<O, undefined | null> : any;
 export type InitialData = GetInitialData<RegisteredServer>;
 export type ComponentSettings = {
     id: string;

package/dist/Server.js

@@ -2,10 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSettings = exports.getInitialData = exports.Server = void 0;
 class Server {
+    _middleware = null;
+    constructor() { }
+    middleware(action) {
+        this._middleware = action;
+        return this;
+    }
+    defineEnv() {
+        return this;
+    }
+    definePlugins() {
+        return this;
+    }
+    handler(action) {
+        return new HandledServer(action, this._middleware);
+    }
+}
+exports.Server = Server;
+class HandledServer {
     initial;
+    _middleware;
     actions = {};
-    constructor(initial) {
+    constructor(initial, _middleware = null) {
         this.initial = initial;
+        this._middleware = _middleware;
     }
     action(name, action) {
         this.actions[name] = action;
@@ -15,6 +35,10 @@ class Server {
         return async ({ action: actionName, params, setEmptyResponse, ...context }, cb) => {
             let res;
             try {
+                if (this._middleware) {
+                    const data = await this._middleware(params, context);
+                    context.state = data;
+                }
                 if (actionName && this.actions[actionName]) {
                     const data = params?.data ?? params;
                     res = await this.actions[actionName](data, context);
@@ -31,7 +55,6 @@ class Server {
         };
     }
 }
-exports.Server = Server;
 const getInitialData = () => typeof __$$oc_initialData__ !== 'undefined'
     ? __$$oc_initialData__
     : {};

package/dist/serverClient.d.ts

@@ -1,8 +1,13 @@
-import { AnyServer, RegisteredServer, Action } from './Server';
-type InferInput<R> = R extends Action<infer I, any, any> ? I : any;
-type InferOutput<R> = R extends Action<any, infer O, any> ? O : never;
+import { AnyServer, RegisteredServer, Action, GetMiddlewareInput } from './Server';
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+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> ? O : never;
 type ServerClient<TServer extends AnyServer> = {
-    readonly [Property in keyof TServer['actions']]: (input: InferInput<TServer['actions'][Property]>) => Promise<InferOutput<TServer['actions'][Property]>>;
+    readonly [Property in keyof TServer['actions']]: (input: Prettify<InferInput<TServer['actions'][Property]> & (IsAny<GetMiddlewareInput<TServer>> extends never ? GetMiddlewareInput<TServer> : {})>) => Promise<InferOutput<TServer['actions'][Property]>>;
 };
 export declare const serverClient: ServerClient<RegisteredServer>;
 export type ActionOutput<K extends keyof typeof serverClient> = Awaited<ReturnType<(typeof serverClient)[K]>>;

package/dist/types.d.ts

@@ -17,7 +17,7 @@ export interface Template {
     version: string;
     externals: External[];
 }
-export interface DataContext<T = any, E = Env, P = any> {
+export type DataContext<T = any, E = Env, P = any, S = unknown> = {
     action?: string;
     acceptLanguage: AcceptLanguage[];
     baseUrl: string;
@@ -30,7 +30,9 @@ export interface DataContext<T = any, E = Env, P = any> {
     setHeader: (header: string, value: string) => void;
     staticPath: string;
     templates: Template[];
-}
+} & (S extends Record<string, unknown> ? {
+    state: S;
+} : {});
 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;
 export {};

package/package.json

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