1.1.43

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
+public/
 pages/
 
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -50,13 +50,13 @@ testLTS:
   - docker
   - notpriv
 
-testSTABLE:
+testBuild:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm install
-  - npmci npm test
+  - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
@@ -65,7 +65,7 @@ testSTABLE:
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -78,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm install
-        --env SOURCE_CODE="$PWD"
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
   - docker
   - priv
@@ -106,13 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:18-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv

.snyk

@@ -1,4 +1,13 @@
 # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
-version: v1.13.3
+version: v1.13.5
-ignore: {}
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-JSYAML-173999:
+    - '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
+        reason: None given
+        expires: '2019-05-24T15:16:11.291Z'
+  SNYK-JS-JSYAML-174129:
+    - '@pushrocks/smartexpress > @pushrocks/smartfile > js-yaml':
+        reason: None given
+        expires: '2019-05-24T15:16:11.291Z'
 patch: {}

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

README.md

@@ -106,6 +106,6 @@ mySmartsocketClient.serverCall('function', functionCallData).then(functionRespon
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartsocket",
-  "version": "1.1.29",
+  "version": "1.1.43",
   "description": "easy and secure websocket communication",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -19,9 +19,10 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartsocket#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.5",
+    "@pushrocks/lik": "^3.0.10",
     "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smarthash": "^2.0.4",
+    "@pushrocks/smartexpress": "^3.0.38",
+    "@pushrocks/smarthash": "^2.0.6",
     "@pushrocks/smartlog": "^2.0.19",
     "@pushrocks/smartpromise": "^3.0.2",
     "@types/shortid": "0.0.29",
@@ -32,11 +33,24 @@
     "socket.io-client": "^2.2.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.5",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.20",
+    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^11.13.7"
+    "@types/node": "^12.7.1",
+    "tslint": "^5.18.0",
+    "tslint-config-prettier": "^1.18.0"
   },
-  "private": false
+  "private": false,
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/common/test.ts

@@ -0,0 +1 @@
+console.log('TODO');

test/test.expressserver.ts

@@ -0,0 +1,104 @@
+// tslint:disable-next-line:no-implicit-dependencies
+import { expect, tap } from '@pushrocks/tapbundle';
+
+import * as smarthash from '@pushrocks/smarthash';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartexpress from '@pushrocks/smartexpress';
+
+import socketIoClient = require('socket.io-client');
+import smartsocket = require('../ts/index');
+
+let testSmartsocket: smartsocket.Smartsocket;
+let testSmartsocketClient: smartsocket.SmartsocketClient;
+let testSocketRole1: smartsocket.SocketRole;
+let testSocketFunction1: smartsocket.SocketFunction;
+let myseServer: smartexpress.Server;
+
+const testConfig = {
+  port: 3000
+};
+
+// class smartsocket
+tap.test('should create a new smartsocket', async () => {
+  testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
+  expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
+});
+
+tap.test('Should accept an smartExpressServer as server', async () => {
+  myseServer = new smartexpress.Server({
+    cors: true,
+    forceSsl: false,
+    port: testConfig.port
+  });
+
+  testSmartsocket.setExternalServer('smartexpress', myseServer);
+
+  await myseServer.start();
+});
+
+// class socketrole
+tap.test('should add a socketrole', async () => {
+  testSocketRole1 = new smartsocket.SocketRole({
+    name: 'testRole1',
+    passwordHash: smarthash.sha256FromStringSync('testPassword')
+  });
+  testSmartsocket.addSocketRoles([testSocketRole1]);
+});
+
+// class SocketFunction
+tap.test('should register a new Function', async () => {
+  testSocketFunction1 = new smartsocket.SocketFunction({
+    allowedRoles: [testSocketRole1],
+    funcDef: async (dataArg, socketConnectionArg) => {
+      return dataArg;
+    },
+    funcName: 'testFunction1'
+  });
+  testSmartsocket.addSocketFunction(testSocketFunction1);
+  console.log(testSmartsocket.socketFunctions);
+});
+
+tap.test('should start listening when .started is called', async () => {
+  await testSmartsocket.start();
+});
+
+// class SmartsocketClient
+tap.test('should react to a new websocket connection from client', async () => {
+  testSmartsocketClient = new smartsocket.SmartsocketClient({
+    port: testConfig.port,
+    url: 'http://localhost',
+    password: 'testPassword',
+    alias: 'testClient1',
+    role: 'testRole1'
+  });
+  testSmartsocketClient.addSocketFunction(testSocketFunction1);
+  console.log(testSmartsocketClient.socketFunctions);
+  await testSmartsocketClient.connect();
+});
+
+tap.test('client should disconnect and reconnect', async tools => {
+  await testSmartsocketClient.disconnect();
+  await tools.delayFor(100);
+  await testSmartsocketClient.connect();
+});
+
+tap.test('2 clients should connect in parallel', async () => {
+  // TODO: implement parallel test
+});
+
+tap.test('should be able to make a functionCall from client to server', async () => {
+  const response = await testSmartsocketClient.serverCall('testFunction1', {
+    value1: 'hello'
+  });
+  console.log(response);
+});
+
+tap.test('should be able to make a functionCall from server to client', async () => {});
+
+// terminate
+tap.test('should close the server', async () => {
+  await testSmartsocket.stop();
+  await myseServer.stop();
+});
+
+tap.start();

test/test.ts

@@ -1,8 +1,8 @@
 // tslint:disable-next-line:no-implicit-dependencies
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as nodehash from '@pushrocks/smarthash';
+import * as smarthash from '@pushrocks/smarthash';
-import * as smartq from '@pushrocks/smartpromise';
+import * as smartpromise from '@pushrocks/smartpromise';
 
 import socketIoClient = require('socket.io-client');
 import smartsocket = require('../ts/index');
@@ -10,7 +10,8 @@ import smartsocket = require('../ts/index');
 let testSmartsocket: smartsocket.Smartsocket;
 let testSmartsocketClient: smartsocket.SmartsocketClient;
 let testSocketRole1: smartsocket.SocketRole;
-let testSocketFunction1: smartsocket.SocketFunction;
+let testSocketFunctionServer: smartsocket.SocketFunction;
+let testSocketFunctionClient: smartsocket.SocketFunction;
 
 const testConfig = {
   port: 3000
@@ -22,33 +23,43 @@ tap.test('should create a new smartsocket', async () => {
   expect(testSmartsocket).be.instanceOf(smartsocket.Smartsocket);
 });
 
-tap.test('should start listening when .started is called', async () => {
-  await testSmartsocket.start();
-});
-
 // class socketrole
 tap.test('should add a socketrole', async () => {
   testSocketRole1 = new smartsocket.SocketRole({
     name: 'testRole1',
-    passwordHash: nodehash.sha256FromStringSync('testPassword')
+    passwordHash: smarthash.sha256FromStringSync('testPassword')
   });
   testSmartsocket.addSocketRoles([testSocketRole1]);
 });
 
 // class SocketFunction
 tap.test('should register a new Function', async () => {
-  testSocketFunction1 = new smartsocket.SocketFunction({
+  testSocketFunctionServer = new smartsocket.SocketFunction({
     allowedRoles: [testSocketRole1],
-    funcDef: async dataArg => {
+    funcDef: async (dataArg, socketConnectionArg) => {
       return dataArg;
     },
     funcName: 'testFunction1'
   });
+  testSmartsocket.addSocketFunction(testSocketFunctionServer);
+
+  testSocketFunctionClient = new smartsocket.SocketFunction({
+    allowedRoles: [],
+    funcDef: async (dataArg, socketConnectionArg) => {
+      return dataArg;
+    },
+    funcName: 'testFunction1'
+  });
+  testSmartsocket.addSocketFunction(testSocketFunctionServer);
+  console.log(testSmartsocket.socketFunctions);
+});
+
+tap.test('should start listening when .started is called', async () => {
+  await testSmartsocket.start();
 });
 
 // class SmartsocketClient
 tap.test('should react to a new websocket connection from client', async () => {
-  const done = smartq.defer();
   testSmartsocketClient = new smartsocket.SmartsocketClient({
     port: testConfig.port,
     url: 'http://localhost',
@@ -56,26 +67,15 @@ tap.test('should react to a new websocket connection from client', async () => {
     alias: 'testClient1',
     role: 'testRole1'
   });
-  testSmartsocketClient.connect().then(() => {
+  testSmartsocketClient.addSocketFunction(testSocketFunctionClient);
-    done.resolve();
+  console.log(testSmartsocketClient.socketFunctions);
-  });
+  await testSmartsocketClient.connect();
-  await done.promise;
 });
-tap.test('client should disconnect and reconnect', async () => {
+
-  let done = smartq.defer();
+tap.test('client should disconnect and reconnect', async tools => {
-  testSmartsocketClient
+  await testSmartsocketClient.disconnect();
-    .disconnect()
+  await tools.delayFor(100);
-    .then(() => {
+  await testSmartsocketClient.connect();
-      let done = smartq.defer();
-      setTimeout(() => {
-        testSmartsocketClient.connect().then(done.resolve);
-      }, 0);
-      return done.promise;
-    })
-    .then(() => {
-      done.resolve();
-    });
-  await done.promise;
 });
 
 tap.test('2 clients should connect in parallel', async () => {
@@ -83,37 +83,17 @@ tap.test('2 clients should connect in parallel', async () => {
 });
 
 tap.test('should be able to make a functionCall from client to server', async () => {
-  let done = smartq.defer();
+  const response = await testSmartsocketClient.serverCall('testFunction1', {
-  testSmartsocketClient
-    .serverCall('testFunction1', {
     value1: 'hello'
-    })
-    .then(dataArg => {
-      console.log(dataArg);
-      done.resolve();
   });
-  await done.promise;
+  console.log(response);
 });
 
 tap.test('should be able to make a functionCall from server to client', async () => {
-  let done = smartq.defer();
+  const response = await testSmartsocketClient.serverCall('testFunction1', {
-  let targetSocket = (() => {
+    hi: 'hi there from client'
-    return smartsocket.allSocketConnections.find(socketConnectionArg => {
-      return socketConnectionArg.alias === 'testClient1';
-    });
-  })();
-  testSmartsocket
-    .clientCall(
-      'testFunction1',
-      {
-        value1: 'helloFromServer'
-      },
-      targetSocket
-    )
-    .then(dataArg => {
-      console.log(dataArg);
-      done.resolve();
   });
+  console.log(response);
 });
 
 // terminate

ts/smartsocket.classes.smartsocket.ts

@@ -1,5 +1,4 @@
 import * as plugins from './smartsocket.plugins';
-import * as helpers from './smartsocket.helpers';
 
 // classes
 import { Objectmap } from '@pushrocks/lik';
@@ -21,6 +20,8 @@ export class Smartsocket {
   public io: SocketIO.Server;
   public openSockets = new Objectmap<SocketConnection>();
   public socketRoles = new Objectmap<SocketRole>();
+  public socketFunctions = new Objectmap<SocketFunction>();
+  public socketRequests = new Objectmap<SocketRequest>();
 
   private socketServer = new SocketServer(this);
 
@@ -29,7 +30,9 @@ export class Smartsocket {
   }
 
   // tslint:disable-next-line:member-ordering
-  public setExternalServer = this.socketServer.setExternalServer;
+  public async setExternalServer(serverType: 'smartexpress', serverArg: any) {
+    await this.socketServer.setExternalServer(serverType, serverArg);
+  }
 
   /**
    * starts smartsocket
@@ -72,7 +75,7 @@ export class Smartsocket {
     targetSocketConnectionArg: SocketConnection
   ) {
     const done = plugins.smartpromise.defer();
-    const socketRequest = new SocketRequest({
+    const socketRequest = new SocketRequest(this, {
       funcCallData: {
         funcDataArg: dataArg,
         funcName: functionNameArg
@@ -81,8 +84,8 @@ export class Smartsocket {
       shortId: plugins.shortid.generate(),
       side: 'requesting'
     });
-    socketRequest.dispatch().then((dataArg: ISocketFunctionCall) => {
+    socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
-      done.resolve(dataArg.funcDataArg);
+      done.resolve(dataArg2.funcDataArg);
     });
     const result = await done.promise;
     return result;
@@ -98,6 +101,10 @@ export class Smartsocket {
     return;
   }
 
+  public addSocketFunction(socketFunction: SocketFunction) {
+    this.socketFunctions.add(socketFunction);
+  }
+
   /**
    * the standard handler for new socket connections
    */

ts/smartsocket.classes.smartsocketclient.ts

@@ -3,6 +3,7 @@ import * as plugins from './smartsocket.plugins';
 import { SocketConnection } from './smartsocket.classes.socketconnection';
 import { ISocketFunctionCall, SocketFunction } from './smartsocket.classes.socketfunction';
 import { ISocketRequestDataObject, SocketRequest } from './smartsocket.classes.socketrequest';
+import { SocketRole } from './smartsocket.classes.socketrole';
 
 /**
  * interface for class SmartsocketClient
@@ -16,12 +17,17 @@ export interface ISmartsocketClientOptions {
 }
 
 export class SmartsocketClient {
-  alias: string;
+  public alias: string;
-  role: string;
+  public role: string;
-  socketConnection: SocketConnection;
+  public socketConnection: SocketConnection;
-  serverUrl: string;
+  public serverUrl: string;
-  serverPort: number;
+  public serverPort: number;
-  serverPassword: string;
+  public serverPassword: string;
+
+  public socketFunctions = new plugins.lik.Objectmap<SocketFunction>();
+  public socketRequests = new plugins.lik.Objectmap<SocketRequest>();
+  public socketRoles = new plugins.lik.Objectmap<SocketRole>();
+
   constructor(optionsArg: ISmartsocketClientOptions) {
     this.alias = optionsArg.alias;
     this.role = optionsArg.role;
@@ -30,19 +36,23 @@ export class SmartsocketClient {
     this.serverPassword = optionsArg.password;
   }
 
+  public addSocketFunction(socketFunction: SocketFunction) {
+    this.socketFunctions.add(socketFunction);
+  }
+
   /**
    * connect the client to the server
    */
-  connect() {
+  public connect() {
-    let done = plugins.smartpromise.defer();
+    const done = plugins.smartpromise.defer();
     plugins.smartlog.defaultLogger.log('info', 'trying to connect...');
-    let socketUrl = `${this.serverUrl}:${this.serverPort}`;
+    const socketUrl = `${this.serverUrl}:${this.serverPort}`;
     this.socketConnection = new SocketConnection({
       alias: this.alias,
       authenticated: false,
       role: undefined,
       side: 'client',
-      smartsocketHost: null,
+      smartsocketHost: this,
       socket: plugins.socketIoClient(socketUrl, { multiplex: false })
     });
     this.socketConnection.socket.on('requestAuth', () => {
@@ -62,8 +72,8 @@ export class SmartsocketClient {
     return done.promise;
   }
 
-  disconnect() {
+  public disconnect() {
-    let done = plugins.smartpromise.defer();
+    const done = plugins.smartpromise.defer();
     this.socketConnection.socket.disconnect();
     this.socketConnection = undefined;
     plugins.smartlog.defaultLogger.log('ok', 'disconnected!');
@@ -71,9 +81,9 @@ export class SmartsocketClient {
     return done.promise;
   }
 
-  serverCall(functionNameArg: string, dataArg: any) {
+  public serverCall(functionNameArg: string, dataArg: any) {
-    let done = plugins.smartpromise.defer();
+    const done = plugins.smartpromise.defer();
-    let socketRequest = new SocketRequest({
+    const socketRequest = new SocketRequest(this, {
       side: 'requesting',
       originSocketConnection: this.socketConnection,
       shortId: plugins.shortid.generate(),
@@ -82,8 +92,8 @@ export class SmartsocketClient {
         funcDataArg: dataArg
       }
     });
-    socketRequest.dispatch().then((dataArg: ISocketFunctionCall) => {
+    socketRequest.dispatch().then((dataArg2: ISocketFunctionCall) => {
-      done.resolve(dataArg.funcDataArg);
+      done.resolve(dataArg2.funcDataArg);
     });
     return done.promise;
   }

ts/smartsocket.classes.socketconnection.ts

@@ -1,20 +1,16 @@
 import * as plugins from './smartsocket.plugins';
-import * as helpers from './smartsocket.helpers';
 
 import { Objectmap } from '@pushrocks/lik';
 
 // import classes
 import { Smartsocket } from './smartsocket.classes.smartsocket';
 import { SocketFunction } from './smartsocket.classes.socketfunction';
-import {
+import { SocketRequest, ISocketRequestDataObject } from './smartsocket.classes.socketrequest';
-  SocketRequest,
-  ISocketRequestDataObject,
-  allSocketRequests
-} from './smartsocket.classes.socketrequest';
 import { SocketRole } from './smartsocket.classes.socketrole';
 
 // socket.io
 import * as SocketIO from 'socket.io';
+import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
 
 // export interfaces
 
@@ -31,7 +27,7 @@ export interface ISocketConnectionConstructorOptions {
   authenticated: boolean;
   role: SocketRole;
   side: TSocketConnectionSide;
-  smartsocketHost: Smartsocket;
+  smartsocketHost: Smartsocket | SmartsocketClient;
   socket: SocketIO.Socket | SocketIOClient.Socket;
 }
 
@@ -51,18 +47,18 @@ export let allSocketConnections = new Objectmap<SocketConnection>();
  * class SocketConnection represents a websocket connection
  */
 export class SocketConnection {
-  alias: string;
+  public alias: string;
-  side: TSocketConnectionSide;
+  public side: TSocketConnectionSide;
-  authenticated: boolean = false;
+  public authenticated: boolean = false;
-  role: SocketRole;
+  public role: SocketRole;
-  smartsocketHost: Smartsocket;
+  public smartsocketRef: Smartsocket | SmartsocketClient;
-  socket: any; // SocketIO.Socket | SocketIOClient.Socket
+  public socket: SocketIO.Socket | SocketIOClient.Socket;
   constructor(optionsArg: ISocketConnectionConstructorOptions) {
     this.alias = optionsArg.alias;
     this.authenticated = optionsArg.authenticated;
     this.role = optionsArg.role;
     this.side = optionsArg.side;
-    this.smartsocketHost = optionsArg.smartsocketHost;
+    this.smartsocketRef = optionsArg.smartsocketHost;
     this.socket = optionsArg.socket;
 
     // standard behaviour that is always true
@@ -82,19 +78,19 @@ export class SocketConnection {
   /**
    * authenticate the socket
    */
-  authenticate() {
+  public authenticate() {
-    let done = plugins.smartpromise.defer();
+    const done = plugins.smartpromise.defer();
     this.socket.on('dataAuth', (dataArg: ISocketConnectionAuthenticationObject) => {
       plugins.smartlog.defaultLogger.log(
         'info',
         'received authentication data. now hashing and comparing...'
       );
       this.socket.removeListener('dataAuth', () => {});
-      if (helpers.checkPasswordForRole(dataArg, this.smartsocketHost)) {
+      if (SocketRole.checkPasswordForRole(dataArg, this.smartsocketRef)) {
         // TODO: authenticate password
         this.alias = dataArg.alias;
         this.authenticated = true;
-        this.role = helpers.getSocketRoleByName(dataArg.role, this.smartsocketHost);
+        this.role = SocketRole.getSocketRoleByName(this.smartsocketRef, dataArg.role);
         this.socket.emit('authenticated');
         plugins.smartlog.defaultLogger.log(
           'ok',
@@ -116,20 +112,20 @@ export class SocketConnection {
   /**
    * listen to function requests
    */
-  listenToFunctionRequests() {
+  public listenToFunctionRequests() {
-    let done = plugins.smartpromise.defer();
+    const done = plugins.smartpromise.defer();
     if (this.authenticated) {
       this.socket.on('function', (dataArg: ISocketRequestDataObject) => {
         // check if requested function is available to the socket's scope
         plugins.smartlog.defaultLogger.log('info', 'function request received');
-        let referencedFunction: SocketFunction = this.role.allowedFunctions.find(
+        const referencedFunction: SocketFunction = this.role.allowedFunctions.find(
           socketFunctionArg => {
             return socketFunctionArg.name === dataArg.funcCallData.funcName;
           }
         );
         if (referencedFunction !== undefined) {
           plugins.smartlog.defaultLogger.log('ok', 'function in access scope');
-          let localSocketRequest = new SocketRequest({
+          const localSocketRequest = new SocketRequest(this.smartsocketRef, {
             side: 'responding',
             originSocketConnection: this,
             shortId: dataArg.shortId,
@@ -148,7 +144,10 @@ export class SocketConnection {
           'info',
           `received response for request with id ${dataArg.shortId}`
         );
-        let targetSocketRequest = helpers.getSocketRequestById(dataArg.shortId);
+        const targetSocketRequest = SocketRequest.getSocketRequestById(
+          this.smartsocketRef,
+          dataArg.shortId
+        );
         targetSocketRequest.handleResponse(dataArg);
       });
       plugins.smartlog.defaultLogger.log(
@@ -157,7 +156,7 @@ export class SocketConnection {
       );
       done.resolve(this);
     } else {
-      let errMessage: 'socket needs to be authenticated first';
+      const errMessage = 'socket needs to be authenticated first';
       plugins.smartlog.defaultLogger.log('error', errMessage);
       done.reject(errMessage);
     }

ts/smartsocket.classes.socketfunction.ts

@@ -3,6 +3,9 @@ import * as plugins from './smartsocket.plugins';
 // import classes
 import { Objectmap } from '@pushrocks/lik';
 import { SocketRole } from './smartsocket.classes.socketrole';
+import { SocketConnection } from './smartsocket.classes.socketconnection';
+import { Smartsocket } from './smartsocket.classes.smartsocket';
+import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
 
 // export interfaces
 
@@ -11,7 +14,7 @@ import { SocketRole } from './smartsocket.classes.socketrole';
  */
 export interface ISocketFunctionConstructorOptions {
   funcName: string;
-  funcDef: any;
+  funcDef: TFuncDef;
   allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
 }
 
@@ -26,12 +29,7 @@ export interface ISocketFunctionCall {
 /**
  * interface for function definition of SocketFunction
  */
-export interface IFuncDef {
+export type TFuncDef = (dataArg: any, connectionArg: SocketConnection) => PromiseLike<any>;
-  (dataArg: any): PromiseLike<any>;
-}
-
-// export objects
-export let allSocketFunctions = new Objectmap<SocketFunction>();
 
 // export classes
 
@@ -39,9 +37,21 @@ export let allSocketFunctions = new Objectmap<SocketFunction>();
  * class that respresents a function that can be transparently called using a SocketConnection
  */
 export class SocketFunction {
-  name: string;
+  // STATIC
-  funcDef: IFuncDef;
+  public static getSocketFunctionByName(
-  roles: SocketRole[];
+    smartsocketRefArg: Smartsocket | SmartsocketClient,
+    functionNameArg: string
+  ): SocketFunction {
+    console.log(smartsocketRefArg.socketFunctions);
+    return smartsocketRefArg.socketFunctions.find(socketFunctionArg => {
+      return socketFunctionArg.name === functionNameArg;
+    });
+  }
+
+  // INSTANCE
+  public name: string;
+  public funcDef: TFuncDef;
+  public roles: SocketRole[];
 
   /**
    * the constructor for SocketFunction
@@ -50,20 +60,19 @@ export class SocketFunction {
     this.name = optionsArg.funcName;
     this.funcDef = optionsArg.funcDef;
     this.roles = optionsArg.allowedRoles;
-    for (let socketRoleArg of this.roles) {
+    for (const socketRoleArg of this.roles) {
       this._notifyRole(socketRoleArg);
     }
-    allSocketFunctions.add(this); // map instance with Objectmap
   }
 
   /**
    * invokes the function of this SocketFunction
    */
-  invoke(dataArg: ISocketFunctionCall): Promise<any> {
+  public invoke(dataArg: ISocketFunctionCall, socketConnectionArg: SocketConnection): Promise<any> {
-    let done = plugins.smartpromise.defer();
+    const done = plugins.smartpromise.defer();
     if (dataArg.funcName === this.name) {
-      this.funcDef(dataArg.funcDataArg).then((resultData: any) => {
+      this.funcDef(dataArg.funcDataArg, socketConnectionArg).then((resultData: any) => {
-        let funcResponseData: ISocketFunctionCall = {
+        const funcResponseData: ISocketFunctionCall = {
           funcName: this.name,
           funcDataArg: resultData
         };

ts/smartsocket.classes.socketrequest.ts

@@ -1,13 +1,14 @@
 import * as plugins from './smartsocket.plugins';
-import * as helpers from './smartsocket.helpers';
 
 // import interfaces
-import { ISocketFunctionCall } from './smartsocket.classes.socketfunction';
+import { SocketFunction, ISocketFunctionCall } from './smartsocket.classes.socketfunction';
 
 // import classes
 import { Objectmap } from '@pushrocks/lik';
-import { SocketFunction } from './smartsocket.classes.socketfunction';
 import { SocketConnection } from './smartsocket.classes.socketconnection';
+import { defaultLogger } from '@pushrocks/smartlog';
+import { Smartsocket } from './smartsocket.classes.smartsocket';
+import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
 
 // export interfaces
 export type TSocketRequestStatus = 'new' | 'pending' | 'finished';
@@ -32,23 +33,38 @@ export interface ISocketRequestDataObject {
   responseTimeout?: number;
 }
 
-// export objects
-export let allSocketRequests = new Objectmap<SocketRequest>();
-
 // export classes
 export class SocketRequest {
-  status: TSocketRequestStatus = 'new';
+  // STATIC
-  side: TSocketRequestSide;
+  public static getSocketRequestById(
-  shortid: string;
+    smartsocketRef: Smartsocket | SmartsocketClient,
-  originSocketConnection: SocketConnection;
+    shortIdArg: string
-  funcCallData: ISocketFunctionCall;
+  ): SocketRequest {
-  done = plugins.smartpromise.defer();
+    return smartsocketRef.socketRequests.find(socketRequestArg => {
-  constructor(optionsArg: SocketRequestConstructorOptions) {
+      return socketRequestArg.shortid === shortIdArg;
+    });
+  }
+
+  // INSTANCE
+  public status: TSocketRequestStatus = 'new';
+  public side: TSocketRequestSide;
+  public shortid: string;
+  public originSocketConnection: SocketConnection;
+  public funcCallData: ISocketFunctionCall;
+  public done = plugins.smartpromise.defer();
+
+  public smartsocketRef: Smartsocket | SmartsocketClient;
+
+  constructor(
+    smartsocketRefArg: Smartsocket | SmartsocketClient,
+    optionsArg: SocketRequestConstructorOptions
+  ) {
+    this.smartsocketRef = smartsocketRefArg;
     this.side = optionsArg.side;
     this.shortid = optionsArg.shortId;
     this.funcCallData = optionsArg.funcCallData;
     this.originSocketConnection = optionsArg.originSocketConnection;
-    allSocketRequests.add(this);
+    this.smartsocketRef.socketRequests.add(this);
   }
 
   // requesting --------------------------
@@ -56,8 +72,8 @@ export class SocketRequest {
   /**
    * dispatches a socketrequest from the requesting to the receiving side
    */
-  dispatch() {
+  public dispatch() {
-    let requestData: ISocketRequestDataObject = {
+    const requestData: ISocketRequestDataObject = {
       funcCallData: this.funcCallData,
       shortId: this.shortid
     };
@@ -68,10 +84,10 @@ export class SocketRequest {
   /**
    * handles the response that is received by the requesting side
    */
-  handleResponse(responseDataArg: ISocketRequestDataObject) {
+  public handleResponse(responseDataArg: ISocketRequestDataObject) {
     plugins.smartlog.defaultLogger.log('info', 'handling response!');
     this.done.resolve(responseDataArg.funcCallData);
-    allSocketRequests.remove(this);
+    this.smartsocketRef.socketRequests.remove(this);
   }
 
   // responding --------------------------
@@ -79,19 +95,29 @@ export class SocketRequest {
   /**
    * creates the response on the responding side
    */
-  createResponse() {
+  public async createResponse(): Promise<void> {
-    let targetSocketFunction: SocketFunction = helpers.getSocketFunctionByName(
+    const targetSocketFunction: SocketFunction = SocketFunction.getSocketFunctionByName(
+      this.smartsocketRef,
       this.funcCallData.funcName
     );
+
+    if (!targetSocketFunction) {
+      defaultLogger.log(
+        'warn',
+        `There is no SocketFunction defined for ${this.funcCallData.funcName}`
+      );
+      defaultLogger.log('warn', `So now response is being sent.`);
+      return;
+    }
     plugins.smartlog.defaultLogger.log('info', `invoking ${targetSocketFunction.name}`);
-    targetSocketFunction.invoke(this.funcCallData).then(resultData => {
+    targetSocketFunction.invoke(this.funcCallData, this.originSocketConnection).then(resultData => {
       plugins.smartlog.defaultLogger.log('info', 'got resultData. Sending it to requesting party.');
-      let requestData: ISocketRequestDataObject = {
+      const requestData: ISocketRequestDataObject = {
         funcCallData: resultData,
         shortId: this.shortid
       };
       this.originSocketConnection.socket.emit('functionResponse', requestData);
-      allSocketRequests.remove(this);
+      this.smartsocketRef.socketRequests.remove(this);
     });
   }
 }

ts/smartsocket.classes.socketrole.ts

@@ -3,6 +3,9 @@ import * as plugins from './smartsocket.plugins';
 // import classes
 import { Objectmap } from '@pushrocks/lik';
 import { SocketFunction } from './smartsocket.classes.socketfunction';
+import { Smartsocket } from './smartsocket.classes.smartsocket';
+import { SmartsocketClient } from './smartsocket.classes.smartsocketclient';
+import { ISocketConnectionAuthenticationObject } from './smartsocket.classes.socketconnection';
 
 /**
  * interface for class SocketRole
@@ -16,14 +19,35 @@ export interface SocketRoleOptions {
  * A socketrole defines access to certain routines.
  */
 export class SocketRole {
-  name: string;
+  // STATIC
-  passwordHash: string;
+  public static getSocketRoleByName(
-  allowedFunctions = new Objectmap<SocketFunction>();
+    referenceSmartsocket: Smartsocket | SmartsocketClient,
+    socketRoleNameArg: string
+  ): SocketRole {
+    return referenceSmartsocket.socketRoles.find(socketRoleArg => {
+      return socketRoleArg.name === socketRoleNameArg;
+    });
+  }
+
+  public static checkPasswordForRole(
+    dataArg: ISocketConnectionAuthenticationObject,
+    referenceSmartsocket: Smartsocket | SmartsocketClient
+  ): boolean {
+    const targetPasswordHash = SocketRole.getSocketRoleByName(referenceSmartsocket, dataArg.role)
+      .passwordHash;
+    const computedCompareHash = plugins.smarthash.sha256FromStringSync(dataArg.password);
+    return targetPasswordHash === computedCompareHash;
+  }
+
+  // INSTANCE
+  public name: string;
+  public passwordHash: string;
+  public allowedFunctions = new Objectmap<SocketFunction>();
   constructor(optionsArg: SocketRoleOptions) {
     this.name = optionsArg.name;
     this.passwordHash = optionsArg.passwordHash;
   }
-  addSocketFunction(socketFunctionArg: SocketFunction) {
+  public addSocketFunction(socketFunctionArg: SocketFunction) {
     this.allowedFunctions.add(socketFunctionArg);
   }
 }

ts/smartsocket.classes.socketserver.ts

@@ -23,12 +23,12 @@ export class SocketServer {
    * starts the server with another server
    * also works with an express style server
    */
-  public async setExternalServer(serverType: 'express' | 'http', serverArg: any) {
+  public async setExternalServer(
-    if (serverType === 'http') {
+    serverType: 'smartexpress',
-      this.httpServer = serverArg;
+    serverArg: plugins.smartexpress.Server
-    } else if (serverType === 'express') {
+  ) {
-      this.expressServer = serverArg;
+    await serverArg.startedPromise;
-    }
+    this.httpServer = serverArg.httpServer;
   }
 
   /**
@@ -37,14 +37,10 @@ export class SocketServer {
   public getServerForSocketIo() {
     if (this.httpServer) {
       return this.httpServer;
-    } else if (this.expressServer) {
+    } else {
-      return this.expressServer;
-    } else if (!this.httpServer && !this.expressServer) {
       this.httpServer = new http.Server();
       this.standaloneServer = true;
       return this.httpServer;
-    } else {
-      throw new Error('no server specified!');
     }
   }
 
@@ -58,8 +54,8 @@ export class SocketServer {
     // in case an external server has been set "this.standaloneServer" should be false
     if (this.httpServer && this.standaloneServer) {
       if (!this.smartsocket.options.port) {
-        console.log('there should be a port specifed for smartsocket!')
+        console.log('there should be a port specifed for smartsocket!');
-        throw new Error('there should be a port specified for smartsocket')
+        throw new Error('there should be a port specified for smartsocket');
       }
       this.httpServer.listen(this.smartsocket.options.port, () => {
         console.log(`Server started in standalone mode on ${this.smartsocket.options.port}`);

ts/smartsocket.helpers.ts

@@ -1,60 +0,0 @@
-import * as plugins from './smartsocket.plugins';
-
-// classes
-import { Smartsocket } from './smartsocket.classes.smartsocket';
-import { SocketFunction, allSocketFunctions } from './smartsocket.classes.socketfunction';
-import {
-  SocketConnection,
-  ISocketConnectionAuthenticationObject
-} from './smartsocket.classes.socketconnection';
-import {
-  SocketRequest,
-  allSocketRequests,
-  TSocketRequestSide
-} from './smartsocket.classes.socketrequest';
-import { SocketRole } from './smartsocket.classes.socketrole';
-
-// SocketConnection helpers
-export let checkPasswordForRole = (
-  dataArg: ISocketConnectionAuthenticationObject,
-  referenceSmartsocket: Smartsocket
-): boolean => {
-  let targetPasswordHash = getSocketRoleByName(dataArg.role, referenceSmartsocket).passwordHash;
-  let computedCompareHash = plugins.smarthash.sha256FromStringSync(dataArg.password);
-  return targetPasswordHash === computedCompareHash;
-};
-
-// SocketFunction helpers
-export let getSocketFunctionByName = (functionNameArg: string): SocketFunction => {
-  return allSocketFunctions.find(socketFunctionArg => {
-    return socketFunctionArg.name === functionNameArg;
-  });
-};
-
-// SocketRequest helpers
-
-/**
- * get corresponding Socketrequest instance by shortId
- */
-export let getSocketRequestById = (
-  shortIdArg: string,
-  requestSide?: TSocketRequestSide
-): SocketRequest => {
-  return allSocketRequests.find(socketRequestArg => {
-    return socketRequestArg.shortid === shortIdArg;
-  });
-};
-
-// SocketRole helpers
-
-/**
- * get corresponding SocketRole instance by name
- */
-export let getSocketRoleByName = (
-  socketRoleNameArg: string,
-  referenceSmartsocket: Smartsocket
-): SocketRole => {
-  return referenceSmartsocket.socketRoles.find(socketRoleArg => {
-    return socketRoleArg.name === socketRoleNameArg;
-  });
-};

ts/smartsocket.plugins.ts

@@ -2,9 +2,20 @@ import * as lik from '@pushrocks/lik';
 import * as smartlog from '@pushrocks/smartlog';
 import * as smarthash from '@pushrocks/smarthash';
 import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartexpress from '@pushrocks/smartexpress';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as shortid from 'shortid';
-import * as socketIo from 'socket.io';
+import socketIo from 'socket.io';
-import * as socketIoClient from 'socket.io-client';
+import socketIoClient from 'socket.io-client';
 
-export { lik, smartlog, smarthash, smartdelay, smartpromise, shortid, socketIo, socketIoClient };
+export {
+  lik,
+  smartlog,
+  smarthash,
+  smartdelay,
+  smartexpress,
+  smartpromise,
+  shortid,
+  socketIo,
+  socketIoClient
+};