refactor: port server-variable model to ts (#507)

src/models/server-variable.ts

@@ -0,0 +1,11 @@
+import {BaseModel} from './base';
+import { DescriptionMixinInterface, ExtensionsMixinInterface } from './mixins';
+
+export interface ServerVariableInterface extends BaseModel, DescriptionMixinInterface, ExtensionsMixinInterface {
+    id(): string;
+    hasDefaultValue(): boolean;
+    defaultValue(): string | undefined;
+    hasAllowedValue(): boolean;
+    allowedValue(): any[]
+    examples(): Array<string>
+}

src/models/server-variables.ts

@@ -0,0 +1,4 @@
+import { Collection } from './collection';
+import { ServerVariableInterface } from './server-variable';
+
+export interface ServerVariablesInterface extends Collection<ServerVariableInterface> { }

src/models/server.ts

@@ -1,10 +1,12 @@
 import type { BaseModel } from "./base";
 import type { BindingsMixinInterface, DescriptionMixinInterface, ExtensionsMixinInterface } from './mixins';
+import { ServerVariablesInterface } from "./server-variables";
 
 export interface ServerInterface extends BaseModel, DescriptionMixinInterface, BindingsMixinInterface, ExtensionsMixinInterface {
   id(): string
   url(): string;
   protocol(): string | undefined;
   protocolVersion(): string;
   hasProtocolVersion(): boolean;
+  variables(): ServerVariablesInterface
 }

src/models/v2/server-variable.ts

@@ -0,0 +1,35 @@
+import { BaseModel, ModelMetadata } from '../base';
+import { Mixin } from '../utils';
+import { ServerVariableInterface } from '../server-variable';
+import { DescriptionMixin } from './mixins/description';
+import { ExtensionsMixin } from './mixins/extensions';
+
+
+export class ServerVariable extends Mixin(BaseModel, DescriptionMixin, ExtensionsMixin) implements ServerVariableInterface {
+    constructor(
+        private readonly _id: string,
+        _json: Record<string,any>,
+        _meta: ModelMetadata = {} as any
+    ){
+        super(_json, _meta);
+    }
+    id(): string {
+        return this._id;
+    }
+    hasDefaultValue(): boolean {
+        return !!this._json.default
+    }
+    defaultValue(): string | undefined {
+        return this._json.default;
+    }
+    hasAllowedValue(): boolean {
+        return !!this._json.enum;
+    }
+    allowedValue(): any[] {
+        return this._json.enum;
+    }
+    examples(): string[] {
+        return this._json.examples
+    }
+
+}

src/models/v2/server-variables.ts

@@ -0,0 +1,15 @@
+import { ServerVariablesInterface } from '../server-variables';
+import { Collection } from '../collection';
+import { ServerVariableInterface } from '../server-variable';
+
+export class ServerVariables extends Collection<ServerVariableInterface> implements ServerVariablesInterface {
+    get(id: string): ServerVariableInterface | undefined {
+        return this.collections.find(serverVariable => serverVariable.id() === id);
+    }
+
+    has(id: string): boolean {
+        return this.collections.some(serverVariable => serverVariable.id() === id);
+    }
+
+}
+

src/models/v2/server.ts

@@ -7,6 +7,9 @@ import { ExtensionsMixin } from './mixins/extensions';
 
 import type { ModelMetadata } from "../base";
 import type { ServerInterface } from '../server';
+import { ServerVariablesInterface } from '../server-variables';
+import { ServerVariables } from './server-variables';
+import { ServerVariable } from './server-variable';
 
 export class Server extends Mixin(BaseModel, BindingsMixin, DescriptionMixin, ExtensionsMixin) implements ServerInterface {
   constructor(
@@ -36,4 +39,18 @@ export class Server extends Mixin(BaseModel, BindingsMixin, DescriptionMixin, Ex
   protocolVersion(): string {
     return this._json.protocolVersion;
   }
+
+  variables(): ServerVariablesInterface {
+    return new ServerVariables(
+      Object.entries(
+        this._json.variables
+      ).map(
+        ([serverVariableName, serverVariable]) => this.createModel(
+          ServerVariable, serverVariable, {
+            id: serverVariableName,
+            pointer: `${this._meta.pointer}/variables/${serverVariableName}`
+        }
+        )
+      ))
+  }
 }

src/models/v3/server-variable.ts

@@ -0,0 +1,28 @@
+import { BaseModel } from '../base';
+import { Mixin } from '../utils';
+import { ServerVariableInterface } from '../server-variable';
+import { DescriptionMixin } from './mixins/description';
+import { ExtensionsMixin } from './mixins/extensions';
+
+
+export class ServerVariable extends Mixin(BaseModel, DescriptionMixin, ExtensionsMixin) implements ServerVariableInterface {
+    id(): string {
+        throw new Error('Method not implemented.');
+    }
+    hasDefaultValue(): boolean {
+        return !!this._json.default
+    }
+    defaultValue(): string | undefined {
+        return this._json.default;
+    }
+    hasAllowedValue(): boolean {
+        return !!this._json.enum
+    }
+    allowedValue(): any[] {
+        return this._json.enum
+    }
+    examples(): string[] {
+        return this._json.examples
+    }
+
+}

src/models/v3/server-variables.ts

@@ -0,0 +1,14 @@
+import { ServerVariablesInterface } from '../server-variables';
+import { Collection } from '../collection';
+import { ServerVariableInterface } from '../server-variable';
+
+export class ServerVariables extends Collection<ServerVariableInterface> implements ServerVariablesInterface {
+    get(id: string): ServerVariableInterface | undefined {
+        return this.collections.find(serverVariable => serverVariable.id() === id);
+    }
+
+    has(id: string): boolean {
+        return this.collections.some(serverVariable => serverVariable.id() === id);
+    }
+
+}

src/models/v3/server.ts

@@ -4,6 +4,9 @@ import { Mixin } from '../utils';
 import { BindingsMixin } from './mixins/bindings';
 import { DescriptionMixin } from './mixins/description';
 import { ExtensionsMixin } from './mixins/extensions';
+import { ServerVariable } from './server-variable';
+import { ServerVariables } from './server-variables';
+import { ServerVariablesInterface } from '../server-variables';
 
 import type { ModelMetadata } from "../base";
 import type { ServerInterface } from '../server';
@@ -36,4 +39,18 @@ export class Server extends Mixin(BaseModel, BindingsMixin, DescriptionMixin, Ex
   protocolVersion(): string {
     return this._json.protocolVersion;
   }
+
+  variables(): ServerVariablesInterface {
+    return new ServerVariables(
+      Object.entries(
+        this._json.variables
+      ).map(
+        ([serverVariableName, serverVariable]) => this.createModel(
+          ServerVariable, serverVariable, {
+            id: serverVariableName,
+            pointer: `${this._meta.pointer}/variables/${serverVariableName}`
+        }
+        )
+      ))
+  }
 }

test/models/v2/server-variable.ts

@@ -0,0 +1,39 @@
+import {ServerVariable} from '../../../src/models/v2/server-variable';
+
+const doc = {
+    description: 'Secure connection (TLS) is available through port 8883.',
+    default: '1883',
+    enum: ['1883', '8883']
+}
+
+const sv = new ServerVariable('doc', doc);
+
+describe('server variable ', function() {
+    describe('.id()', function() {
+        expect(sv.id()).toMatch('doc');
+    })
+
+    describe('.hasDefaultValue()', function() {
+        it('should return true if default value is passed', function(){
+            expect(sv.hasDefaultValue()).toBeTruthy();
+        })
+    })
+
+    describe('.defaultValue()', function(){
+        it('should return default value', function() {
+            expect(sv.defaultValue()).toMatch(doc.default);
+        })
+    })
+
+    describe('.hasAllowedValue()', function() {
+        it('should return true when enum is passed', function(){
+            expect(sv.hasAllowedValue()).toBeTruthy();
+        })
+    })
+
+    describe('.allowedValue()', function(){
+        it('should return enum object', function(){
+            expect(sv.allowedValue()).toEqual(doc.enum)
+        })
+    })
+})

test/models/v2/server.spec.ts

@@ -1,4 +1,5 @@
 import { Server } from '../../../src/models/v2/server';
+import {ServerVariables} from '../../../src/models/v2/server-variables';
 
 import { 
   assertDescriptionMixinInheritance,
@@ -9,7 +10,13 @@ const doc = {
   'development': {
     protocol: 'mqtt',
     protocolVersion: '1.0.0',
-    url: 'development.gigantic-server.com'
+    url: 'development.gigantic-server.com',
+    variables: {
+      username: {
+        default: 'demo',
+        description: 'This value is assigned by the service provider, in this example `gigantic-server.com`'
+      }
+    }
   }
 };
 const docItem = new Server('development', doc.development);
@@ -54,6 +61,12 @@ describe('Server Model', function () {
     });
   });
 
+  describe('.servers()', function(){
+    it('should return ServerVariables object', function(){
+      expect(docItem.variables() instanceof ServerVariables).toBeTruthy();
+    })
+  })
+
   describe('mixins inheritance', function() {
     assertDescriptionMixinInheritance(Server);
     assertExtensionsMixinInheritance(Server);