oc-server 1.1.10 → 1.1.11

package/dist/Server.d.ts

@@ -7,21 +7,51 @@ 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;
+type OcParameter = {
+    description?: string;
+    mandatory?: boolean;
+} & ({
+    type: 'string';
+    example?: string;
+    default?: string;
+} | {
+    type: 'boolean';
+    example?: boolean;
+    default?: boolean;
+} | {
+    type: 'number';
+    example?: number;
+    default?: number;
+});
+type OcParameters = Record<string, OcParameter>;
+type TransformStringifiedTypeToType<T> = T extends 'string' ? string : T extends 'number' ? number : T extends 'boolean' ? boolean : never;
+type TransformOcParameters<T extends OcParameters> = Prettify<Pick<{
+    [K in keyof T]: TransformStringifiedTypeToType<T[K]['type']>;
+}, {
+    [K in keyof T]: T[K]['mandatory'] extends true ? K : never;
+}[keyof T]> & Partial<Pick<{
+    [K in keyof T]: TransformStringifiedTypeToType<T[K]['type']>;
+}, {
+    [K in keyof T]: T[K]['mandatory'] extends true ? never : K;
+}[keyof T]>>>;
 export declare class Server<E = {
     name: string;
 }, P = unknown, A extends Record<string, AnyAction> = {}, InitialInput = any, InitialOutput = any, MiddlewareInput = any, MiddlewareOutput = any> {
+    private _parameters;
     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'>;
+    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, O>(action: Action<I, O, E, P, MiddlewareOutput>): HandledServer<E, P, A, I, O, MiddlewareInput, MiddlewareOutput>;
+    handler<I = InitialInput, O = InitialOutput>(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;
+    private readonly _parameters;
     readonly actions: A;
-    constructor(initial: Action<InitialInput, InitialOutput, E, P, MiddlewareOutput>, _middleware?: Action<MiddlewareInput, MiddlewareOutput, E, P, unknown> | null);
+    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>;
     getData(): DataProvider<any, any, any>;
 }

package/dist/Server.js

@@ -2,12 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServerError = exports.getSettings = exports.getInitialData = exports.Server = void 0;
 class Server {
+    _parameters = {};
     _middleware = null;
     constructor() { }
     middleware(action) {
         this._middleware = action;
         return this;
     }
+    withParameters(params) {
+        this._parameters = params;
+        return this;
+    }
     defineEnv() {
         return this;
     }
@@ -15,17 +20,19 @@ class Server {
         return this;
     }
     handler(action) {
-        return new HandledServer(action, this._middleware);
+        return new HandledServer(action, this._middleware, this._parameters);
     }
 }
 exports.Server = Server;
 class HandledServer {
     initial;
     _middleware;
+    _parameters;
     actions = {};
-    constructor(initial, _middleware = null) {
+    constructor(initial, _middleware = null, _parameters = {}) {
         this.initial = initial;
         this._middleware = _middleware;
+        this._parameters = _parameters;
     }
     action(name, action) {
         this.actions[name] = action;

package/package.json

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