@opra/common 1.20.0 → 1.21.0

package/cjs/document/decorators/ws-param.decorator.js

@@ -17,6 +17,6 @@ function WsParam(type) {
             paramMetadata = [];
             Reflect.defineMetadata(constants_js_1.WS_PARAM_METADATA, paramMetadata, target, propertyKey);
         }
-        paramMetadata[parameterIndex] = type;
+        paramMetadata.push({ type, parameterIndex });
     };
 }

package/cjs/document/factory/ws-api.factory.js

@@ -104,6 +104,7 @@ class WSApiFactory {
                             type: undefined,
                             keyType: undefined,
                             arguments: undefined,
+                            response: undefined,
                         });
                         await this._initWSOperation(context, operation, operationMeta);
                         controller.operations.set(operationName, operation);
@@ -129,9 +130,19 @@ class WSApiFactory {
         if (metadata.arguments?.length) {
             await context.enterAsync('.arguments', async () => {
                 operation.arguments = [];
-                for (const x of metadata.arguments) {
-                    const t = await data_type_factory_js_1.DataTypeFactory.resolveDataType(context, operation, x);
-                    operation.arguments?.push(t);
+                let x;
+                for (x of metadata.arguments) {
+                    const xx = {};
+                    if (typeof x === 'object' && x.type && x.parameterIndex !== null) {
+                        Object.assign(xx, x);
+                    }
+                    else
+                        xx.type = x;
+                    const t = await data_type_factory_js_1.DataTypeFactory.resolveDataType(context, operation, xx.type);
+                    operation.arguments?.push({
+                        type: t,
+                        parameterIndex: xx.parameterIndex,
+                    });
                 }
             });
         }

package/cjs/document/ws/ws-operation.js

@@ -27,6 +27,7 @@ exports.WSOperation = function (...args) {
         throw new TypeError(`Invalid operation name (${initArgs.name})`);
     const _this = (0, ts_gems_1.asMutable)(this);
     _this.types = _this.node[constants_js_1.kDataTypeMap] = new data_type_map_js_1.DataTypeMap();
+    // noinspection JSConstantReassignment
     _this.name = initArgs.name;
     _this.description = initArgs.description;
     if (initArgs.event)
@@ -39,8 +40,15 @@ exports.WSOperation = function (...args) {
     else
         _this.event = this.name;
     if (initArgs?.arguments) {
-        _this.arguments = initArgs.arguments.map(arg => arg instanceof data_type_js_1.DataType ? arg : _this.owner.node.getDataType(arg));
+        _this.arguments = initArgs.arguments.map(arg => {
+            const type = arg.type instanceof data_type_js_1.DataType
+                ? arg.type
+                : _this.owner.node.getDataType(arg.type);
+            return { type, parameterIndex: arg.parameterIndex };
+        });
     }
+    else
+        _this.arguments = [];
     if (initArgs?.response)
         _this.response =
             initArgs.response instanceof data_type_js_1.DataType
@@ -56,7 +64,7 @@ class WSOperationClass extends document_element_js_1.DocumentElement {
             kind: index_js_1.OpraSchema.WSOperation.Kind,
             description: this.description,
             event: this.event,
-            arguments: this.arguments?.map(arg => arg.name ? arg.name : arg.toJSON()),
+            arguments: this.arguments?.map(arg => arg.type.name ? arg.type.name : arg.type.toJSON()),
         });
     }
 }

package/esm/document/decorators/ws-param.decorator.js

@@ -14,6 +14,6 @@ export function WsParam(type) {
             paramMetadata = [];
             Reflect.defineMetadata(WS_PARAM_METADATA, paramMetadata, target, propertyKey);
         }
-        paramMetadata[parameterIndex] = type;
+        paramMetadata.push({ type, parameterIndex });
     };
 }

package/esm/document/factory/ws-api.factory.js

@@ -101,6 +101,7 @@ export class WSApiFactory {
                             type: undefined,
                             keyType: undefined,
                             arguments: undefined,
+                            response: undefined,
                         });
                         await this._initWSOperation(context, operation, operationMeta);
                         controller.operations.set(operationName, operation);
@@ -126,9 +127,19 @@ export class WSApiFactory {
         if (metadata.arguments?.length) {
             await context.enterAsync('.arguments', async () => {
                 operation.arguments = [];
-                for (const x of metadata.arguments) {
-                    const t = await DataTypeFactory.resolveDataType(context, operation, x);
-                    operation.arguments?.push(t);
+                let x;
+                for (x of metadata.arguments) {
+                    const xx = {};
+                    if (typeof x === 'object' && x.type && x.parameterIndex !== null) {
+                        Object.assign(xx, x);
+                    }
+                    else
+                        xx.type = x;
+                    const t = await DataTypeFactory.resolveDataType(context, operation, xx.type);
+                    operation.arguments?.push({
+                        type: t,
+                        parameterIndex: xx.parameterIndex,
+                    });
                 }
             });
         }

package/esm/document/ws/ws-operation.js

@@ -24,6 +24,7 @@ export const WSOperation = function (...args) {
         throw new TypeError(`Invalid operation name (${initArgs.name})`);
     const _this = asMutable(this);
     _this.types = _this.node[kDataTypeMap] = new DataTypeMap();
+    // noinspection JSConstantReassignment
     _this.name = initArgs.name;
     _this.description = initArgs.description;
     if (initArgs.event)
@@ -36,8 +37,15 @@ export const WSOperation = function (...args) {
     else
         _this.event = this.name;
     if (initArgs?.arguments) {
-        _this.arguments = initArgs.arguments.map(arg => arg instanceof DataType ? arg : _this.owner.node.getDataType(arg));
+        _this.arguments = initArgs.arguments.map(arg => {
+            const type = arg.type instanceof DataType
+                ? arg.type
+                : _this.owner.node.getDataType(arg.type);
+            return { type, parameterIndex: arg.parameterIndex };
+        });
     }
+    else
+        _this.arguments = [];
     if (initArgs?.response)
         _this.response =
             initArgs.response instanceof DataType
@@ -53,7 +61,7 @@ class WSOperationClass extends DocumentElement {
             kind: OpraSchema.WSOperation.Kind,
             description: this.description,
             event: this.event,
-            arguments: this.arguments?.map(arg => arg.name ? arg.name : arg.toJSON()),
+            arguments: this.arguments?.map(arg => arg.type.name ? arg.type.name : arg.type.toJSON()),
         });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",

package/types/document/ws/ws-operation.d.ts

@@ -11,7 +11,10 @@ import { WSController } from './ws-controller.js';
  */
 export declare namespace WSOperation {
     interface Metadata extends Pick<OpraSchema.WSOperation, 'description' | 'event'> {
-        arguments?: (ThunkAsync<Type | EnumType.EnumObject | EnumType.EnumArray> | string)[];
+        arguments?: {
+            type: ThunkAsync<Type | EnumType.EnumObject | EnumType.EnumArray> | string;
+            parameterIndex: number;
+        }[];
         types?: ThunkAsync<Type | EnumType.EnumObject | EnumType.EnumArray>[];
         response?: ThunkAsync<Type | EnumType.EnumObject | EnumType.EnumArray>[];
     }
@@ -22,7 +25,10 @@ export declare namespace WSOperation {
     interface InitArguments extends Combine<{
         name: string;
         types?: DataType[];
-        arguments?: (DataType | string | Type)[];
+        arguments?: {
+            type: DataType | string | Type;
+            parameterIndex: number;
+        }[];
     }, Pick<Metadata, 'description'>> {
         event?: string | RegExp;
         response?: DataType | string | Type;
@@ -62,7 +68,10 @@ declare class WSOperationClass extends DocumentElement {
     readonly name: string;
     description?: string;
     event: string | RegExp;
-    arguments?: DataType[];
+    arguments: {
+        type: DataType;
+        parameterIndex: number;
+    }[];
     types: DataTypeMap;
     response?: DataType;
     toJSON(): OpraSchema.WSOperation;

package/types/schema/ws/ws-api.interface.d.ts

@@ -6,6 +6,10 @@ import { WSController } from './ws-controller.interface.js';
  */
 export interface WSApi extends Api {
     transport: 'ws';
+    /**
+     * Name of the platform. (Socketio, ...)
+     */
+    platform?: string;
     description?: string;
     controllers: Record<string, WSController>;
 }