@opra/common 1.0.0-alpha.4 → 1.0.0-alpha.5

package/browser.js

@@ -2428,6 +2428,26 @@ function HttpControllerDecoratorFactory(options) {
     });
     return decorator;
   };
+  decorator.KeyParam = (name, arg1) => {
+    decoratorChain.push((meta) => {
+      if (!meta.path?.includes(":" + name))
+        meta.path = (meta.path || "") + "@:" + name;
+      const paramMeta = typeof arg1 === "string" || typeof arg1 === "function" ? {
+        name,
+        location: "path",
+        type: arg1,
+        keyParam: true
+      } : {
+        ...arg1,
+        name,
+        location: "path",
+        keyParam: true
+      };
+      meta.parameters = meta.parameters || [];
+      meta.parameters.push(paramMeta);
+    });
+    return decorator;
+  };
   decorator.UseType = (...type) => {
     decoratorChain.push((meta) => {
       meta.types = meta.types || [];
@@ -2530,20 +2550,20 @@ var HttpControllerClass = class extends DocumentElement {
     });
     if (this.operations.size) {
       out.operations = {};
-      for (const [name, v] of this.operations.entries()) {
-        out.operations[name] = v.toJSON();
+      for (const v of this.operations.values()) {
+        out.operations[v.name] = v.toJSON();
       }
     }
     if (this.controllers.size) {
       out.controllers = {};
-      for (const [name, v] of this.controllers.entries()) {
-        out.controllers[name] = v.toJSON();
+      for (const v of this.controllers.values()) {
+        out.controllers[v.name] = v.toJSON();
       }
     }
     if (this.types.size) {
       out.types = {};
-      for (const [name, v] of this.types.entries()) {
-        out.types[name] = v.toJSON();
+      for (const v of this.types.values()) {
+        out.types[v.name] = v.toJSON();
       }
     }
     if (this.parameters.length) {
@@ -2592,8 +2612,8 @@ var HttpApi = class extends ApiBase {
       url: this.url,
       controllers: {}
     };
-    for (const [name, v] of this.controllers.entries()) {
-      out.controllers[name] = v.toJSON();
+    for (const v of this.controllers.values()) {
+      out.controllers[v.name] = v.toJSON();
     }
     return out;
   }
@@ -3294,6 +3314,7 @@ var HttpParameter = /* @__PURE__ */ __name(function(owner, initArgs) {
   _this.deprecated = initArgs.deprecated;
   _this.required = initArgs.required;
   _this.arraySeparator = initArgs.arraySeparator;
+  _this.keyParam = initArgs.keyParam;
 }, "HttpParameter");
 var HttpParameterClass = class extends Value {
   static {
@@ -3305,6 +3326,7 @@ var HttpParameterClass = class extends Value {
       name: this.name,
       location: this.location,
       arraySeparator: this.arraySeparator,
+      keyParam: this.keyParam,
       required: this.required,
       deprecated: this.deprecated
     });
@@ -12710,11 +12732,21 @@ HttpOperation2.Entity.Delete = function(arg0, arg1) {
   if (typeof args.type === "function")
     decorator.UseType(args.type);
   decorator.KeyParam = (name, prmOptions) => {
-    decorator.PathParam(name, prmOptions);
+    const paramMeta = typeof prmOptions === "string" || typeof prmOptions === "function" ? {
+      name,
+      location: "path",
+      type: prmOptions,
+      keyParam: true
+    } : {
+      ...prmOptions,
+      name,
+      location: "path",
+      keyParam: true
+    };
+    decorator.PathParam(name, paramMeta);
     decoratorChain.push((meta) => {
-      meta.path = (meta.path || "") + "@:" + name;
-      meta.compositionOptions = meta.compositionOptions || {};
-      meta.compositionOptions.keyParameter = name;
+      if (!meta.path?.includes(":" + name))
+        meta.path = (meta.path || "") + "@:" + name;
     });
     return decorator;
   };
@@ -12880,11 +12912,21 @@ HttpOperation2.Entity.Get = function(arg0, arg1) {
   if (typeof args.type === "function")
     decorator.UseType(args.type);
   decorator.KeyParam = (name, prmOptions) => {
-    decorator.PathParam(name, prmOptions);
+    const paramMeta = typeof prmOptions === "string" || typeof prmOptions === "function" ? {
+      name,
+      location: "path",
+      type: prmOptions,
+      keyParam: true
+    } : {
+      ...prmOptions,
+      name,
+      location: "path",
+      keyParam: true
+    };
+    decorator.PathParam(name, paramMeta);
     decoratorChain.push((meta) => {
-      meta.path = (meta.path || "") + "@:" + name;
-      meta.compositionOptions = meta.compositionOptions || {};
-      meta.compositionOptions.keyParameter = name;
+      if (!meta.path?.includes(":" + name))
+        meta.path = (meta.path || "") + "@:" + name;
     });
     return decorator;
   };
@@ -12987,11 +13029,21 @@ HttpOperation2.Entity.Update = function(arg0, arg1) {
   if (typeof args.type === "function")
     decorator.UseType(args.type);
   decorator.KeyParam = (name, prmOptions) => {
-    decorator.PathParam(name, prmOptions);
+    const paramMeta = typeof prmOptions === "string" || typeof prmOptions === "function" ? {
+      name,
+      location: "path",
+      type: prmOptions,
+      keyParam: true
+    } : {
+      ...prmOptions,
+      name,
+      location: "path",
+      keyParam: true
+    };
+    decorator.PathParam(name, paramMeta);
     decoratorChain.push((meta) => {
-      meta.path = (meta.path || "") + "@:" + name;
-      meta.compositionOptions = meta.compositionOptions || {};
-      meta.compositionOptions.keyParameter = name;
+      if (!meta.path?.includes(":" + name))
+        meta.path = (meta.path || "") + "@:" + name;
     });
     return decorator;
   };

package/cjs/document/decorators/http-controller.decorator.js

@@ -102,6 +102,31 @@ function HttpControllerDecoratorFactory(options) {
         });
         return decorator;
     };
+    /**
+     *
+     */
+    decorator.KeyParam = (name, arg1) => {
+        decoratorChain.push((meta) => {
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
+            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
+                ? {
+                    name,
+                    location: 'path',
+                    type: arg1,
+                    keyParam: true,
+                }
+                : {
+                    ...arg1,
+                    name,
+                    location: 'path',
+                    keyParam: true,
+                };
+            meta.parameters = meta.parameters || [];
+            meta.parameters.push(paramMeta);
+        });
+        return decorator;
+    };
     /**
      *
      */

package/cjs/document/decorators/http-operation-entity.decorator.js

@@ -93,11 +93,23 @@ http_operation_js_1.HttpOperation.Entity.Delete = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };
@@ -296,11 +308,23 @@ http_operation_js_1.HttpOperation.Entity.Get = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };
@@ -425,11 +449,23 @@ http_operation_js_1.HttpOperation.Entity.Update = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };

package/cjs/document/http/http-api.js

@@ -31,8 +31,8 @@ class HttpApi extends api_base_js_1.ApiBase {
             url: this.url,
             controllers: {},
         };
-        for (const [name, v] of this.controllers.entries()) {
-            out.controllers[name] = v.toJSON();
+        for (const v of this.controllers.values()) {
+            out.controllers[v.name] = v.toJSON();
         }
         return out;
     }

package/cjs/document/http/http-controller.js

@@ -109,20 +109,20 @@ class HttpControllerClass extends document_element_js_1.DocumentElement {
         });
         if (this.operations.size) {
             out.operations = {};
-            for (const [name, v] of this.operations.entries()) {
-                out.operations[name] = v.toJSON();
+            for (const v of this.operations.values()) {
+                out.operations[v.name] = v.toJSON();
             }
         }
         if (this.controllers.size) {
             out.controllers = {};
-            for (const [name, v] of this.controllers.entries()) {
-                out.controllers[name] = v.toJSON();
+            for (const v of this.controllers.values()) {
+                out.controllers[v.name] = v.toJSON();
             }
         }
         if (this.types.size) {
             out.types = {};
-            for (const [name, v] of this.types.entries()) {
-                out.types[name] = v.toJSON();
+            for (const v of this.types.values()) {
+                out.types[v.name] = v.toJSON();
             }
         }
         if (this.parameters.length) {

package/cjs/document/http/http-parameter.js

@@ -25,6 +25,7 @@ exports.HttpParameter = function (owner, initArgs) {
     _this.deprecated = initArgs.deprecated;
     _this.required = initArgs.required;
     _this.arraySeparator = initArgs.arraySeparator;
+    _this.keyParam = initArgs.keyParam;
 };
 /**
  * @class HttpParameter
@@ -36,6 +37,7 @@ class HttpParameterClass extends value_js_1.Value {
             name: this.name,
             location: this.location,
             arraySeparator: this.arraySeparator,
+            keyParam: this.keyParam,
             required: this.required,
             deprecated: this.deprecated,
         });

package/esm/document/decorators/http-controller.decorator.js

@@ -98,6 +98,31 @@ export function HttpControllerDecoratorFactory(options) {
         });
         return decorator;
     };
+    /**
+     *
+     */
+    decorator.KeyParam = (name, arg1) => {
+        decoratorChain.push((meta) => {
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
+            const paramMeta = typeof arg1 === 'string' || typeof arg1 === 'function'
+                ? {
+                    name,
+                    location: 'path',
+                    type: arg1,
+                    keyParam: true,
+                }
+                : {
+                    ...arg1,
+                    name,
+                    location: 'path',
+                    keyParam: true,
+                };
+            meta.parameters = meta.parameters || [];
+            meta.parameters.push(paramMeta);
+        });
+        return decorator;
+    };
     /**
      *
      */

package/esm/document/decorators/http-operation-entity.decorator.js

@@ -91,11 +91,23 @@ HttpOperation.Entity.Delete = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };
@@ -294,11 +306,23 @@ HttpOperation.Entity.Get = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };
@@ -423,11 +447,23 @@ HttpOperation.Entity.Update = function (arg0, arg1) {
      *
      */
     decorator.KeyParam = (name, prmOptions) => {
-        decorator.PathParam(name, prmOptions);
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
         decoratorChain.push((meta) => {
-            meta.path = (meta.path || '') + '@:' + name;
-            meta.compositionOptions = meta.compositionOptions || {};
-            meta.compositionOptions.keyParameter = name;
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
         });
         return decorator;
     };

package/esm/document/http/http-api.js

@@ -28,8 +28,8 @@ export class HttpApi extends ApiBase {
             url: this.url,
             controllers: {},
         };
-        for (const [name, v] of this.controllers.entries()) {
-            out.controllers[name] = v.toJSON();
+        for (const v of this.controllers.values()) {
+            out.controllers[v.name] = v.toJSON();
         }
         return out;
     }

package/esm/document/http/http-controller.js

@@ -106,20 +106,20 @@ class HttpControllerClass extends DocumentElement {
         });
         if (this.operations.size) {
             out.operations = {};
-            for (const [name, v] of this.operations.entries()) {
-                out.operations[name] = v.toJSON();
+            for (const v of this.operations.values()) {
+                out.operations[v.name] = v.toJSON();
             }
         }
         if (this.controllers.size) {
             out.controllers = {};
-            for (const [name, v] of this.controllers.entries()) {
-                out.controllers[name] = v.toJSON();
+            for (const v of this.controllers.values()) {
+                out.controllers[v.name] = v.toJSON();
             }
         }
         if (this.types.size) {
             out.types = {};
-            for (const [name, v] of this.types.entries()) {
-                out.types[name] = v.toJSON();
+            for (const v of this.types.values()) {
+                out.types[v.name] = v.toJSON();
             }
         }
         if (this.parameters.length) {

package/esm/document/http/http-parameter.js

@@ -22,6 +22,7 @@ export const HttpParameter = function (owner, initArgs) {
     _this.deprecated = initArgs.deprecated;
     _this.required = initArgs.required;
     _this.arraySeparator = initArgs.arraySeparator;
+    _this.keyParam = initArgs.keyParam;
 };
 /**
  * @class HttpParameter
@@ -33,6 +34,7 @@ class HttpParameterClass extends Value {
             name: this.name,
             location: this.location,
             arraySeparator: this.arraySeparator,
+            keyParam: this.keyParam,
             required: this.required,
             deprecated: this.deprecated,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.5",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",

package/types/document/decorators/http-controller.decorator.d.ts

@@ -6,6 +6,7 @@ export interface HttpControllerDecorator<T extends HttpControllerDecorator<any>
     Header(name: string | RegExp, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync | false): T;
     QueryParam(name: string | RegExp, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync | false): T;
     PathParam(name: string | RegExp, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync | false): T;
+    KeyParam(name: string | RegExp, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync | false): T;
     UseType(...type: TypeThunkAsync[]): T;
 }
 export interface HttpControllerDecoratorFactory {

package/types/document/http/http-parameter.d.ts

@@ -12,6 +12,7 @@ export declare namespace HttpParameter {
     interface Metadata extends StrictOmit<OpraSchema.HttpParameter, 'type'> {
         name: string | RegExp;
         type?: string | TypeThunkAsync | EnumType.EnumObject | EnumType.EnumArray | object;
+        keyParam?: boolean;
     }
     interface Options extends Partial<StrictOmit<Metadata, 'type'>> {
         type?: string | TypeThunkAsync | object;
@@ -41,6 +42,7 @@ export declare const HttpParameter: HttpParameterStatic;
  */
 declare class HttpParameterClass extends Value {
     readonly owner: DocumentElement;
+    keyParam?: boolean;
     deprecated?: boolean | string;
     required?: boolean;
     arraySeparator?: string;

package/types/schema/http/http-parameter.interface.d.ts

@@ -13,6 +13,10 @@ export interface HttpParameter extends Value {
      * Name of the parameter. RegExp pattern can be used matching parameter name
      */
     name: string | RegExp;
+    /**
+     * Determines if parameter is key
+     */
+    keyParam?: boolean;
     /**
      * Defines array separator
      */