1.0.6

starting with updating tests to use both server and client side to mimic operation

README.md

@@ -1,11 +1,12 @@
 # smartsocket
-easy and secure websocket communication
+easy and secure websocket communication, Typescript ready
 
 ## Status
 [![build status](https://gitlab.com/pushrocks/smartsocket/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsocket/commits/master)
 
 ## Usage
 We recommend the use of typescript.
+Under the hood we use socket.io and shortid for managed data exchange.
 
 ### Serverside
 ```typescript
@@ -50,7 +51,6 @@ let mySmartsocketClient = new smartsocket.SmartsocketClient({
 let mySocketFunction2 = new smartsocket.SocketFunction({
     name:"restart",
     func:(data) => {}, the function to execute
-    roles: [mySocketRole] // all roles that have access to a specific function
 });
 
 mySmartsocketClient.registerFunction(mySocketFunction2);
@@ -59,4 +59,9 @@ mySmartsocketClient.serverCall("newService",data)
     .then((responseData) => {
         
     });;
-```
+```
+
+> **NOTE:**  
+you can easily chain dependent requests on eiter the server or client side with promises.  
+`data` is always a js object that you can design for your specific needs.  
+It supports buffers for large binary data network exchange.  

dist/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./smartsocket.classes.smartsocket";
 export * from "./smartsocket.classes.smartsocketclient";
+export * from "./smartsocket.classes.socketfunction";
+export * from "./smartsocket.classes.socketrole";

dist/index.js

@@ -4,4 +4,7 @@ function __export(m) {
 }
 __export(require("./smartsocket.classes.smartsocket"));
 __export(require("./smartsocket.classes.smartsocketclient"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsbUNBQW1DLENBQUMsRUFBQTtBQUNsRCxpQkFBYyx5Q0FBeUMsQ0FBQyxFQUFBIn0=
+__export(require("./smartsocket.classes.socketfunction"));
+__export(require("./smartsocket.classes.socketrole"));
+// need something more exposed? Create an issue on GitLab!
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsbUNBQW1DLENBQUMsRUFBQTtBQUNsRCxpQkFBYyx5Q0FBeUMsQ0FBQyxFQUFBO0FBQ3hELGlCQUFjLHNDQUFzQyxDQUFDLEVBQUE7QUFDckQsaUJBQWMsa0NBQWtDLENBQUMsRUFBQTtBQUVqRCwwREFBMEQifQ==

dist/smartsocket.classes.smartsocket.d.ts

@@ -1,29 +1,22 @@
 /// <reference types="socket.io" />
 import { Objectmap } from "lik";
-import { SocketRole } from "./smartsocket.classes.socketrole";
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
-export interface ISocketObject {
-    alias?: string;
-    authenticated: boolean;
-    role?: string;
-    socket: SocketIO.Socket;
-}
 export interface ISmartsocketConstructorOptions {
     port: number;
 }
 export declare class Smartsocket {
     options: ISmartsocketConstructorOptions;
     io: SocketIO.Server;
-    openSockets: Objectmap;
+    openSockets: Objectmap<SocketConnection>;
-    registeredRoles: Objectmap;
     constructor(optionsArg: ISmartsocketConstructorOptions);
     /**
      * the standard handler for new socket connections
      */
-    private _handleSocket(socket);
+    private _handleSocketConnection(socketArg);
-    registerFunctions(socketRoleArg: SocketRole): void;
     /**
      * starts listening to incling sockets:
      */
     startServer: () => void;
     closeServer: () => void;
+    clientCall(): void;
 }

dist/smartsocket.classes.smartsocket.js

@@ -1,21 +1,19 @@
 "use strict";
 const plugins = require("./smartsocket.plugins");
-const helpers = require("./smartsocket.helpers");
 // classes
 const lik_1 = require("lik");
-;
+const smartsocket_classes_socketconnection_1 = require("./smartsocket.classes.socketconnection");
 ;
 class Smartsocket {
     constructor(optionsArg) {
         this.openSockets = new lik_1.Objectmap();
-        this.registeredRoles = new lik_1.Objectmap();
         /**
          * starts listening to incling sockets:
          */
         this.startServer = () => {
             this.io = plugins.socketIo(this.options.port);
-            this.io.on('connection', (socketArg) => {
+            this.io.on("connection", (socketArg) => {
-                this._handleSocket(socketArg);
+                this._handleSocketConnection(socketArg);
             });
         };
         this.closeServer = () => {
@@ -32,20 +30,23 @@ class Smartsocket {
     /**
      * the standard handler for new socket connections
      */
-    _handleSocket(socket) {
+    _handleSocketConnection(socketArg) {
-        let socketObject = {
+        let socketConnection = new smartsocket_classes_socketconnection_1.SocketConnection({
-            socket: socket,
+            alias: undefined,
-            authenticated: false
+            authenticated: false,
-        };
+            role: undefined,
+            socket: socketArg
+        });
         plugins.beautylog.log("Socket connected. Trying to authenticate...");
-        this.openSockets.add(socketObject);
+        this.openSockets.add(socketConnection);
-        helpers.authenticateSocket(socketObject)
+        socketConnection.authenticate()
-            .then();
+            .then(socketConnection.listenToFunctionRequests);
-    }
-    registerFunctions(socketRoleArg) {
-        this.registeredRoles.add(socketRoleArg);
     }
     ;
+    // communication
+    clientCall() {
+        // TODO: target specific client and initiate response        
+    }
 }
 exports.Smartsocket = Smartsocket;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zbWFydHNvY2tldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc21hcnRzb2NrZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFDakQsTUFBWSxPQUFPLFdBQU0sdUJBQXVCLENBQUMsQ0FBQTtBQUVqRCxVQUFVO0FBQ1Ysc0JBQTBCLEtBQUssQ0FBQyxDQUFBO0FBVS9CLENBQUM7QUFLRCxDQUFDO0FBRUY7SUFLSSxZQUFZLFVBQTBDO1FBRnRELGdCQUFXLEdBQUcsSUFBSSxlQUFTLEVBQUUsQ0FBQztRQUM5QixvQkFBZSxHQUFHLElBQUksZUFBUyxFQUFFLENBQUM7UUF3QmxDOztXQUVHO1FBRUgsZ0JBQVcsR0FBRztZQUNWLElBQUksQ0FBQyxFQUFFLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzlDLElBQUksQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLFlBQVksRUFBRSxDQUFDLFNBQVM7Z0JBQy9CLElBQUksQ0FBQyxhQUFhLENBQUMsU0FBUyxDQUFDLENBQUM7WUFDbEMsQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUE7UUFDRCxnQkFBVyxHQUFHO1lBQ1YsSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxlQUE4QjtnQkFDcEQsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsa0NBQWtDLGVBQWUsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDO2dCQUNqRixlQUFlLENBQUMsTUFBTSxDQUFDLFVBQVUsRUFBRSxDQUFDO1lBQ3hDLENBQUMsQ0FBQyxDQUFDO1lBQ0gsSUFBSSxDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztZQUN4QixJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3BCLENBQUMsQ0FBQTtRQXZDRyxJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQztJQUM5QixDQUFDOztJQUVEOztPQUVHO0lBQ0ssYUFBYSxDQUFDLE1BQU07UUFDeEIsSUFBSSxZQUFZLEdBQWtCO1lBQzlCLE1BQU0sRUFBRSxNQUFNO1lBQ2QsYUFBYSxFQUFFLEtBQUs7U0FDdkIsQ0FBQztRQUNGLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLDZDQUE2QyxDQUFDLENBQUE7UUFDcEUsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDbkMsT0FBTyxDQUFDLGtCQUFrQixDQUFDLFlBQVksQ0FBQzthQUNuQyxJQUFJLEVBQUUsQ0FBQztJQUNoQixDQUFDO0lBRUQsaUJBQWlCLENBQUMsYUFBd0I7UUFDdEMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLENBQUMsYUFBYSxDQUFDLENBQUM7SUFDNUMsQ0FBQzs7QUFxQkwsQ0FBQztBQTlDWSxtQkFBVyxjQThDdkIsQ0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zbWFydHNvY2tldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc21hcnRzb2NrZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFHakQsVUFBVTtBQUNWLHNCQUEwQixLQUFLLENBQUMsQ0FBQTtBQUdoQyx1REFBaUMsd0NBQXdDLENBQUMsQ0FBQTtBQUt6RSxDQUFDO0FBRUY7SUFJSSxZQUFZLFVBQTBDO1FBRHRELGdCQUFXLEdBQUcsSUFBSSxlQUFTLEVBQW9CLENBQUM7UUFxQmhEOztXQUVHO1FBRUgsZ0JBQVcsR0FBRztZQUNWLElBQUksQ0FBQyxFQUFFLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzlDLElBQUksQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLFlBQVksRUFBRSxDQUFDLFNBQVM7Z0JBQy9CLElBQUksQ0FBQyx1QkFBdUIsQ0FBQyxTQUFTLENBQUMsQ0FBQztZQUM1QyxDQUFDLENBQUMsQ0FBQztRQUNQLENBQUMsQ0FBQTtRQUNELGdCQUFXLEdBQUc7WUFDVixJQUFJLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxDQUFDLGVBQWlDO2dCQUN2RCxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxrQ0FBa0MsZUFBZSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUM7Z0JBQ2pGLGVBQWUsQ0FBQyxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDeEMsQ0FBQyxDQUFDLENBQUM7WUFDSCxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksRUFBRSxDQUFDO1lBQ3hCLElBQUksQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDcEIsQ0FBQyxDQUFDO1FBcENFLElBQUksQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDO0lBQzlCLENBQUM7O0lBRUQ7O09BRUc7SUFDSyx1QkFBdUIsQ0FBQyxTQUFTO1FBQ3JDLElBQUksZ0JBQWdCLEdBQXNCLElBQUksdURBQWdCLENBQUM7WUFDM0QsS0FBSyxFQUFDLFNBQVM7WUFDZixhQUFhLEVBQUMsS0FBSztZQUNuQixJQUFJLEVBQUMsU0FBUztZQUNkLE1BQU0sRUFBQyxTQUFTO1NBQ25CLENBQUMsQ0FBQztRQUNILE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLDZDQUE2QyxDQUFDLENBQUE7UUFDcEUsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUN2QyxnQkFBZ0IsQ0FBQyxZQUFZLEVBQUU7YUFDMUIsSUFBSSxDQUFDLGdCQUFnQixDQUFDLHdCQUF3QixDQUFDLENBQUM7SUFDekQsQ0FBQzs7SUFxQkQsZ0JBQWdCO0lBQ2hCLFVBQVU7UUFFTiw2REFBNkQ7SUFDakUsQ0FBQztBQUNMLENBQUM7QUFoRFksbUJBQVcsY0FnRHZCLENBQUEifQ==

dist/smartsocket.classes.smartsocketclient.d.ts

@@ -1,10 +1,29 @@
+/// <reference types="q" />
+import * as plugins from "./smartsocket.plugins";
+import { ISocketFunctionCall } from "./smartsocket.classes.socketfunction";
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
 /**
  * interface for class SmartsocketClient
  */
 export interface ISmartsocketClientOptions {
     port: number;
     url: string;
+    alias: string;
+    role: string;
+    password: string;
 }
 export declare class SmartsocketClient {
-    constructor();
+    alias: string;
+    role: string;
+    socketConnection: SocketConnection;
+    serverUrl: string;
+    serverPort: number;
+    serverPassword: string;
+    constructor(optionsArg: ISmartsocketClientOptions);
+    /**
+     * connect the client to the server
+     */
+    connect(): plugins.q.Promise<{}>;
+    disconnect(): plugins.q.Promise<{}>;
+    serverCall(functionNameArg: string, dataArg: ISocketFunctionCall): plugins.q.Promise<{}>;
 }

dist/smartsocket.classes.smartsocketclient.js

@@ -1,7 +1,71 @@
 "use strict";
+const plugins = require("./smartsocket.plugins");
+// import classes
+const smartsocket_classes_socketconnection_1 = require("./smartsocket.classes.socketconnection");
+const smartsocket_classes_socketrequest_1 = require("./smartsocket.classes.socketrequest");
 class SmartsocketClient {
-    constructor() {
+    constructor(optionsArg) {
+        this.alias = optionsArg.alias;
+        this.role = optionsArg.role;
+        this.serverUrl = optionsArg.url;
+        this.serverPort = optionsArg.port;
+        this.serverPassword = optionsArg.password;
     }
+    ;
+    /**
+     * connect the client to the server
+     */
+    connect() {
+        let done = plugins.q.defer();
+        plugins.beautylog.log("trying to connect...");
+        let socketUrl = `${this.serverUrl}:${this.serverPort}`;
+        this.socketConnection = new smartsocket_classes_socketconnection_1.SocketConnection({
+            alias: this.alias,
+            authenticated: false,
+            role: undefined,
+            socket: plugins.socketIoClient(socketUrl, { multiplex: false })
+        });
+        this.socketConnection.socket.on("requestAuth", () => {
+            console.log("server requested authentication");
+            this.socketConnection.socket.emit("dataAuth", {
+                role: this.role,
+                password: this.serverPassword,
+                alias: this.alias
+            });
+            this.socketConnection.socket.on("authenticated", () => {
+                console.log("client is authenticated");
+                done.resolve();
+            });
+        });
+        return done.promise;
+    }
+    ;
+    disconnect() {
+        let done = plugins.q.defer();
+        this.socketConnection.socket.disconnect();
+        this.socketConnection = undefined;
+        plugins.beautylog.ok("disconnected!");
+        done.resolve();
+        return done.promise;
+    }
+    serverCall(functionNameArg, dataArg) {
+        let done = plugins.q.defer();
+        let socketRequest = new smartsocket_classes_socketrequest_1.SocketRequest({
+            side: "requesting",
+            originSocketConnection: this.socketConnection,
+            shortId: plugins.shortid.generate(),
+            funcCallData: {
+                funcName: functionNameArg,
+                funcDataArg: dataArg
+            }
+        });
+        socketRequest.dispatch()
+            .then(() => {
+            done.resolve();
+        });
+        return done.promise;
+    }
+    ;
 }
 exports.SmartsocketClient = SmartsocketClient;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zbWFydHNvY2tldGNsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc21hcnRzb2NrZXRjbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQVVBO0lBQ0k7SUFFQSxDQUFDO0FBQ0wsQ0FBQztBQUpZLHlCQUFpQixvQkFJN0IsQ0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zbWFydHNvY2tldGNsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc21hcnRzb2NrZXRjbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUl6QixDQUFDLENBSitDO0FBT2hELGlCQUFpQjtBQUNqQix1REFBaUMsd0NBQXdDLENBQUMsQ0FBQTtBQUUxRSxvREFBOEIscUNBQXFDLENBQUMsQ0FBQTtBQVlwRTtJQU9JLFlBQVksVUFBb0M7UUFDNUMsSUFBSSxDQUFDLEtBQUssR0FBRyxVQUFVLENBQUMsS0FBSyxDQUFDO1FBQzlCLElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQztRQUM1QixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUE7UUFDL0IsSUFBSSxDQUFDLFVBQVUsR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDO1FBQ2xDLElBQUksQ0FBQyxjQUFjLEdBQUcsVUFBVSxDQUFDLFFBQVEsQ0FBQTtJQUM3QyxDQUFDOztJQUVEOztPQUVHO0lBQ0gsT0FBTztRQUNILElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDN0IsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsc0JBQXNCLENBQUMsQ0FBQztRQUM5QyxJQUFJLFNBQVMsR0FBRyxHQUFHLElBQUksQ0FBQyxTQUFTLElBQUksSUFBSSxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQ3ZELElBQUksQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLHVEQUFnQixDQUFDO1lBQ3pDLEtBQUssRUFBQyxJQUFJLENBQUMsS0FBSztZQUNoQixhQUFhLEVBQUMsS0FBSztZQUNuQixJQUFJLEVBQUMsU0FBUztZQUNkLE1BQU0sRUFBRSxPQUFPLENBQUMsY0FBYyxDQUFDLFNBQVMsRUFBQyxFQUFDLFNBQVMsRUFBQyxLQUFLLEVBQUMsQ0FBQztTQUM5RCxDQUFDLENBQUM7UUFDSCxJQUFJLENBQUMsZ0JBQWdCLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxhQUFhLEVBQUU7WUFDM0MsT0FBTyxDQUFDLEdBQUcsQ0FBQyxpQ0FBaUMsQ0FBQyxDQUFDO1lBQy9DLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtnQkFDMUMsSUFBSSxFQUFFLElBQUksQ0FBQyxJQUFJO2dCQUNmLFFBQVEsRUFBRSxJQUFJLENBQUMsY0FBYztnQkFDN0IsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLO2FBQ3BCLENBQUMsQ0FBQztZQUNILElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLGVBQWUsRUFBQztnQkFDNUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyx5QkFBeUIsQ0FBQyxDQUFDO2dCQUN2QyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDbkIsQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUMsQ0FBQztRQUNILE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQ3hCLENBQUM7O0lBQ0QsVUFBVTtRQUNOLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDN0IsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE1BQU0sQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUMxQyxJQUFJLENBQUMsZ0JBQWdCLEdBQUcsU0FBUyxDQUFDO1FBQ2xDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ3RDLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztRQUNmLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQ3hCLENBQUM7SUFDRCxVQUFVLENBQUMsZUFBc0IsRUFBQyxPQUEyQjtRQUN6RCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzdCLElBQUksYUFBYSxHQUFHLElBQUksaURBQWEsQ0FBQztZQUNsQyxJQUFJLEVBQUMsWUFBWTtZQUNqQixzQkFBc0IsRUFBQyxJQUFJLENBQUMsZ0JBQWdCO1lBQzVDLE9BQU8sRUFBQyxPQUFPLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRTtZQUNsQyxZQUFZLEVBQUM7Z0JBQ1QsUUFBUSxFQUFFLGVBQWU7Z0JBQ3pCLFdBQVcsRUFBQyxPQUFPO2FBQ3RCO1NBQ0osQ0FBQyxDQUFDO1FBQ0gsYUFBYSxDQUFDLFFBQVEsRUFBRTthQUNuQixJQUFJLENBQUM7WUFDRixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDbkIsQ0FBQyxDQUFDLENBQUM7UUFDUCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN4QixDQUFDOztBQUVMLENBQUM7QUFwRVkseUJBQWlCLG9CQW9FN0IsQ0FBQSJ9

dist/smartsocket.classes.socketconnection.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="socket.io" />
+/// <reference types="socket.io-client" />
+/// <reference types="q" />
+import * as plugins from "./smartsocket.plugins";
+import { SocketRole } from "./smartsocket.classes.socketrole";
+/**
+ * interface for constructor of class SocketConnection
+ */
+export interface ISocketConnectionConstructorOptions {
+    alias: string;
+    authenticated: boolean;
+    role: SocketRole;
+    socket: SocketIO.Socket | SocketIOClient.Socket;
+}
+/**
+ * interface for authentication data
+ */
+export interface ISocketConnectionAuthenticationObject {
+    role: "coreflowContainer";
+    password: "somePassword";
+    alias: "coreflow1";
+}
+/**
+ * class SocketConnection represents a websocket connection
+ */
+export declare class SocketConnection {
+    alias: string;
+    authenticated: boolean;
+    role: SocketRole;
+    socket: SocketIO.Socket | SocketIOClient.Socket;
+    constructor(optionsArg: ISocketConnectionConstructorOptions);
+    /**
+     * authenticate the socket
+     */
+    authenticate(): plugins.q.Promise<{}>;
+    /**
+     * listen to function requests
+     */
+    listenToFunctionRequests(): plugins.q.Promise<{}>;
+}

dist/smartsocket.classes.socketconnection.js

@@ -0,0 +1,90 @@
+"use strict";
+const plugins = require("./smartsocket.plugins");
+const helpers = require("./smartsocket.helpers");
+const smartsocket_classes_socketrequest_1 = require("./smartsocket.classes.socketrequest");
+;
+// export classes
+/**
+ * class SocketConnection represents a websocket connection
+ */
+class SocketConnection {
+    constructor(optionsArg) {
+        this.alias = optionsArg.alias;
+        this.authenticated = optionsArg.authenticated;
+        this.role = optionsArg.role;
+        this.socket = optionsArg.socket;
+        // standard behaviour that is always true
+        this.socket.on("disconnect", () => {
+            plugins.beautylog.info(`Client ${this.alias} disconnected`);
+        });
+    }
+    ;
+    // authenticating --------------------------
+    /**
+     * authenticate the socket
+     */
+    authenticate() {
+        let done = plugins.q.defer();
+        this.socket.on("dataAuth", dataArg => {
+            plugins.beautylog.log("received authentication data. now hashing and comparing...");
+            this.socket.removeListener("dataAuth", () => { });
+            if ((true)) {
+                this.alias = dataArg.alias;
+                this.authenticated = true;
+                this.role = helpers.getSocketRoleByName(dataArg.role);
+                this.socket.emit("authenticated");
+                plugins.beautylog.ok(`socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`);
+                done.resolve(this);
+            }
+            else {
+                this.socket.disconnect();
+                done.reject("not authenticated");
+            }
+            ;
+        });
+        this.socket.emit("requestAuth");
+        return done.promise;
+    }
+    ;
+    // listening -------------------------------
+    /**
+     * listen to function requests
+     */
+    listenToFunctionRequests() {
+        let done = plugins.q.defer();
+        if (this.authenticated) {
+            this.socket.on("function", (dataArg) => {
+                // check if requested function is available to the socket's scope
+                let referencedFunction = this.role.allowedFunctions.find((socketFunctionArg) => {
+                    return socketFunctionArg.name === dataArg.funcCallData.funcName;
+                });
+                if (referencedFunction !== undefined) {
+                    let localSocketRequest = new smartsocket_classes_socketrequest_1.SocketRequest({
+                        side: "responding",
+                        originSocketConnection: this,
+                        shortId: dataArg.shortId,
+                        funcCallData: dataArg.funcCallData
+                    });
+                    localSocketRequest.createResponse(); // takes care of creating response and sending it back 
+                }
+                else {
+                    plugins.beautylog.warn("function not existent or out of access scope");
+                }
+                ;
+            });
+            this.socket.on("functionResponse", (dataArg) => {
+                let targetSocketRequest = helpers.getSocketRequestById(dataArg.shortId);
+                targetSocketRequest.handleResponse(dataArg);
+            });
+        }
+        else {
+            done.reject("socket needs to be authenticated first");
+        }
+        ;
+        return done.promise;
+    }
+    ;
+}
+exports.SocketConnection = SocketConnection;
+;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRjb25uZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRjb25uZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSx1QkFBdUIsQ0FBQyxDQUFBO0FBQ2pELE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFJakQsb0RBQTJFLHFDQUFxQyxDQUFDLENBQUE7QUFhaEgsQ0FBQztBQVdGLGlCQUFpQjtBQUVqQjs7R0FFRztBQUNIO0lBS0ksWUFBWSxVQUErQztRQUN2RCxJQUFJLENBQUMsS0FBSyxHQUFHLFVBQVUsQ0FBQyxLQUFLLENBQUM7UUFDOUIsSUFBSSxDQUFDLGFBQWEsR0FBRyxVQUFVLENBQUMsYUFBYSxDQUFDO1FBQzlDLElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQztRQUM1QixJQUFJLENBQUMsTUFBTSxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUM7UUFFaEMseUNBQXlDO1FBQ3pDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLFlBQVksRUFBRTtZQUN6QixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxVQUFVLElBQUksQ0FBQyxLQUFLLGVBQWUsQ0FBQyxDQUFDO1FBQ2hFLENBQUMsQ0FBQyxDQUFDO0lBQ1AsQ0FBQzs7SUFFRCw0Q0FBNEM7SUFFNUM7O09BRUc7SUFDSCxZQUFZO1FBQ1IsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUM3QixJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxVQUFVLEVBQUUsT0FBTztZQUM5QixPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyw0REFBNEQsQ0FBQyxDQUFDO1lBQ3BGLElBQUksQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLFVBQVUsRUFBRSxRQUFRLENBQUMsQ0FBQyxDQUFDO1lBQ2xELEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNULElBQUksQ0FBQyxLQUFLLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQTtnQkFDMUIsSUFBSSxDQUFDLGFBQWEsR0FBRyxJQUFJLENBQUM7Z0JBQzFCLElBQUksQ0FBQyxJQUFJLEdBQUcsT0FBTyxDQUFDLG1CQUFtQixDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztnQkFDdEQsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7Z0JBQ2xDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLHVCQUF1QixJQUFJLENBQUMsS0FBSyxXQUFXLElBQUksQ0FBQyxJQUFJLG9CQUFvQixDQUFDLENBQUM7Z0JBQ2hHLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDdkIsQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNKLElBQUksQ0FBQyxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7Z0JBQ3pCLElBQUksQ0FBQyxNQUFNLENBQUMsbUJBQW1CLENBQUMsQ0FBQztZQUNyQyxDQUFDO1lBQUEsQ0FBQztRQUNOLENBQUMsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDaEMsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7SUFDeEIsQ0FBQzs7SUFFRCw0Q0FBNEM7SUFFNUM7O09BRUc7SUFDSCx3QkFBd0I7UUFDcEIsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUM3QixFQUFFLENBQUEsQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLENBQUEsQ0FBQztZQUNuQixJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxVQUFVLEVBQUUsQ0FBQyxPQUFnQztnQkFDeEQsaUVBQWlFO2dCQUNqRSxJQUFJLGtCQUFrQixHQUFrQixJQUFJLENBQUMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxDQUFDLGlCQUFpQjtvQkFDdEYsTUFBTSxDQUFDLGlCQUFpQixDQUFDLElBQUksS0FBSyxPQUFPLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQztnQkFDcEUsQ0FBQyxDQUFDLENBQUM7Z0JBQ0gsRUFBRSxDQUFBLENBQUMsa0JBQWtCLEtBQUssU0FBUyxDQUFDLENBQUEsQ0FBQztvQkFDakMsSUFBSSxrQkFBa0IsR0FBRyxJQUFJLGlEQUFhLENBQUM7d0JBQ3ZDLElBQUksRUFBQyxZQUFZO3dCQUNqQixzQkFBc0IsRUFBQyxJQUFJO3dCQUMzQixPQUFPLEVBQUMsT0FBTyxDQUFDLE9BQU87d0JBQ3ZCLFlBQVksRUFBQyxPQUFPLENBQUMsWUFBWTtxQkFDcEMsQ0FBQyxDQUFDO29CQUNILGtCQUFrQixDQUFDLGNBQWMsRUFBRSxDQUFDLENBQUMsdURBQXVEO2dCQUNoRyxDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNKLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLDhDQUE4QyxDQUFDLENBQUM7Z0JBQzNFLENBQUM7Z0JBQUEsQ0FBQztZQUNOLENBQUMsQ0FBQyxDQUFDO1lBQ0gsSUFBSSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsa0JBQWtCLEVBQUUsQ0FBQyxPQUFnQztnQkFDaEUsSUFBSSxtQkFBbUIsR0FBRyxPQUFPLENBQUMsb0JBQW9CLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO2dCQUN4RSxtQkFBbUIsQ0FBQyxjQUFjLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDaEQsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixJQUFJLENBQUMsTUFBTSxDQUFDLHdDQUF3QyxDQUFDLENBQUM7UUFDMUQsQ0FBQztRQUFBLENBQUM7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN4QixDQUFDOztBQUlMLENBQUM7QUFoRlksd0JBQWdCLG1CQWdGNUIsQ0FBQTtBQUFBLENBQUMifQ==

dist/smartsocket.classes.socketfunction.d.ts

@@ -1,12 +1,46 @@
+/// <reference types="q" />
+import * as plugins from "./smartsocket.plugins";
+import { Objectmap } from "lik";
 import { SocketRole } from "./smartsocket.classes.socketrole";
-export interface SocketFunctionOptions {
+/**
-    name: string;
+ * interface of the contructor options of class SocketFunction
-    func: any;
+ */
-    roles: SocketRole[];
+export interface ISocketFunctionConstructorOptions {
+    funcName: string;
+    funcDef: any;
+    allowedRoles: SocketRole[];
 }
+/**
+ * interface of the Socket Function call, in other words the object that routes a call to a function
+ */
+export interface ISocketFunctionCall {
+    funcName: string;
+    funcDataArg: any;
+}
+/**
+ * interface for function definition of SocketFunction
+ */
+export interface IFuncDef {
+    (dataArg: any): PromiseLike<any>;
+}
+export declare let allSocketFunctions: Objectmap<SocketFunction>;
+/**
+ * class that respresents a function that can be transparently called using a SocketConnection
+ */
 export declare class SocketFunction {
     name: string;
-    func: any;
+    funcDef: IFuncDef;
     roles: SocketRole[];
-    constructor(optionsArg: SocketFunctionOptions);
+    /**
+     * the constructor for SocketFunction
+     */
+    constructor(optionsArg: ISocketFunctionConstructorOptions);
+    /**
+     * notifies a role about access to this SocketFunction
+     */
+    private _notifyRole(socketRoleArg);
+    /**
+     * invokes the function of this SocketFunction
+     */
+    invoke(dataArg: ISocketFunctionCall): plugins.q.Promise<any>;
 }

dist/smartsocket.classes.socketfunction.js

@@ -1,12 +1,53 @@
 "use strict";
+const plugins = require("./smartsocket.plugins");
+// import classes
+const lik_1 = require("lik");
 ;
+;
+// export objects
+exports.allSocketFunctions = new lik_1.Objectmap();
+// export classes
+/**
+ * class that respresents a function that can be transparently called using a SocketConnection
+ */
 class SocketFunction {
+    /**
+     * the constructor for SocketFunction
+     */
     constructor(optionsArg) {
-        this.name = optionsArg.name;
+        this.name = optionsArg.funcName;
-        this.func = optionsArg.func;
+        this.funcDef = optionsArg.funcDef;
-        this.roles = optionsArg.roles;
+        this.roles = optionsArg.allowedRoles;
+        for (let socketRoleArg of this.roles) {
+            this._notifyRole(socketRoleArg);
+        }
+        ;
+        exports.allSocketFunctions.add(this); // map instance with Objectmap
+    }
+    ;
+    /**
+     * notifies a role about access to this SocketFunction
+     */
+    _notifyRole(socketRoleArg) {
+        socketRoleArg.addSocketFunction(this);
+    }
+    /**
+     * invokes the function of this SocketFunction
+     */
+    invoke(dataArg) {
+        let done = plugins.q.defer();
+        if (dataArg.funcName === this.name) {
+            this.funcDef(dataArg.funcDataArg)
+                .then((resultData) => {
+                done.resolve(resultData);
+            });
+        }
+        else {
+            throw new Error("SocketFunction.name does not match the data argument's .name!");
+        }
+        return done.promise;
     }
     ;
 }
 exports.SocketFunction = SocketFunction;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRmdW5jdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc29ja2V0ZnVuY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQVlDLENBQUM7QUFFRjtJQUlJLFlBQVksVUFBaUM7UUFDekMsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDO1FBQzVCLElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQztRQUM1QixJQUFJLENBQUMsS0FBSyxHQUFHLFVBQVUsQ0FBQyxLQUFLLENBQUM7SUFDbEMsQ0FBQzs7QUFDTCxDQUFDO0FBVFksc0JBQWMsaUJBUzFCLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRmdW5jdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmNsYXNzZXMuc29ja2V0ZnVuY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFFakQsaUJBQWlCO0FBQ2pCLHNCQUEwQixLQUFLLENBQUMsQ0FBQTtBQVkvQixDQUFDO0FBUUQsQ0FBQztBQVNGLGlCQUFpQjtBQUNOLDBCQUFrQixHQUFHLElBQUksZUFBUyxFQUFrQixDQUFDO0FBRWhFLGlCQUFpQjtBQUVqQjs7R0FFRztBQUNIO0lBS0k7O09BRUc7SUFDSCxZQUFZLFVBQTZDO1FBQ3JELElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLFFBQVEsQ0FBQztRQUNoQyxJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQUM7UUFDbEMsSUFBSSxDQUFDLEtBQUssR0FBRyxVQUFVLENBQUMsWUFBWSxDQUFDO1FBQ3JDLEdBQUcsQ0FBQyxDQUFDLElBQUksYUFBYSxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQSxDQUFDO1lBQ2xDLElBQUksQ0FBQyxXQUFXLENBQUMsYUFBYSxDQUFDLENBQUM7UUFDcEMsQ0FBQztRQUFBLENBQUM7UUFDRiwwQkFBa0IsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyw4QkFBOEI7SUFDaEUsQ0FBQzs7SUFFRDs7T0FFRztJQUNLLFdBQVcsQ0FBQyxhQUF3QjtRQUN4QyxhQUFhLENBQUMsaUJBQWlCLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDMUMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsTUFBTSxDQUFDLE9BQTJCO1FBQzlCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDN0IsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLFFBQVEsS0FBSyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUEsQ0FBQztZQUMvQixJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUM7aUJBQzVCLElBQUksQ0FBQyxDQUFDLFVBQWM7Z0JBQ2pCLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7WUFDN0IsQ0FBQyxDQUFDLENBQUM7UUFFWCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixNQUFNLElBQUksS0FBSyxDQUFDLCtEQUErRCxDQUFDLENBQUM7UUFDckYsQ0FBQztRQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQ3hCLENBQUM7O0FBRUwsQ0FBQztBQTFDWSxzQkFBYyxpQkEwQzFCLENBQUEifQ==

dist/smartsocket.classes.socketrequest.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="q" />
+import * as plugins from "./smartsocket.plugins";
+import { ISocketFunctionCall } from "./smartsocket.classes.socketfunction";
+import { Objectmap } from "lik";
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
+export declare type TSocketRequestStatus = "new" | "pending" | "finished";
+export declare type TSocketRequestSide = "requesting" | "responding";
+/**
+ * interface of constructor of class SocketRequest
+ */
+export interface SocketRequestConstructorOptions {
+    side: TSocketRequestSide;
+    originSocketConnection: SocketConnection;
+    shortId: string;
+    funcCallData?: ISocketFunctionCall;
+}
+/**
+ * request object that is sent initially and may or may not receive a response
+ */
+export interface ISocketRequestDataObject {
+    funcCallData: ISocketFunctionCall;
+    shortId: string;
+    responseTimeout?: number;
+}
+export declare let allSocketRequests: Objectmap<SocketRequest>;
+export declare class SocketRequest {
+    status: TSocketRequestStatus;
+    side: TSocketRequestSide;
+    shortid: string;
+    originSocketConnection: SocketConnection;
+    funcCallData: ISocketFunctionCall;
+    done: plugins.q.Deferred<{}>;
+    constructor(optionsArg: SocketRequestConstructorOptions);
+    /**
+     * dispatches a socketrequest from the requesting to the receiving side
+     */
+    dispatch(): plugins.q.Promise<{}>;
+    /**
+     * handles the response that is received by the requesting side
+     */
+    handleResponse(responseDataArg: ISocketRequestDataObject): void;
+    /**
+     * creates the response on the responding side
+     */
+    createResponse(): void;
+}

dist/smartsocket.classes.socketrequest.js

@@ -0,0 +1,60 @@
+"use strict";
+const plugins = require("./smartsocket.plugins");
+const helpers = require("./smartsocket.helpers");
+// import classes
+const lik_1 = require("lik");
+;
+;
+//export objects
+exports.allSocketRequests = new lik_1.Objectmap();
+// export classes
+class SocketRequest {
+    constructor(optionsArg) {
+        this.status = "new";
+        this.done = plugins.q.defer();
+        this.side = optionsArg.side;
+        this.shortid = optionsArg.shortId;
+        this.funcCallData = optionsArg.funcCallData;
+        exports.allSocketRequests.add(this);
+    }
+    ;
+    // requesting --------------------------
+    /**
+     * dispatches a socketrequest from the requesting to the receiving side
+     */
+    dispatch() {
+        let requestData = {
+            funcCallData: this.funcCallData,
+            shortId: this.shortid
+        };
+        this.originSocketConnection.socket.emit("function", requestData);
+        return this.done.promise;
+    }
+    ;
+    /**
+     * handles the response that is received by the requesting side
+     */
+    handleResponse(responseDataArg) {
+        this.done.resolve(responseDataArg);
+        exports.allSocketRequests.remove(this);
+    }
+    // responding --------------------------
+    /**
+     * creates the response on the responding side
+     */
+    createResponse() {
+        let targetSocketFunction = helpers.getSocketFunctionByName(this.funcCallData.funcName);
+        targetSocketFunction.invoke(this.funcCallData)
+            .then((resultData) => {
+            let requestData = {
+                funcCallData: resultData,
+                shortId: this.shortid
+            };
+            this.originSocketConnection.socket.emit("functionResponse", requestData);
+            exports.allSocketRequests.remove(this);
+        });
+    }
+}
+exports.SocketRequest = SocketRequest;
+;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyZXF1ZXN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyZXF1ZXN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSx1QkFBdUIsQ0FBQyxDQUFBO0FBQ2pELE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFLakQsaUJBQWlCO0FBQ2pCLHNCQUEwQixLQUFLLENBQUMsQ0FBQTtBQWdCL0IsQ0FBQztBQVNELENBQUM7QUFFRixnQkFBZ0I7QUFDTCx5QkFBaUIsR0FBRyxJQUFJLGVBQVMsRUFBaUIsQ0FBQztBQUU5RCxpQkFBaUI7QUFDakI7SUFPSSxZQUFZLFVBQTJDO1FBTnZELFdBQU0sR0FBeUIsS0FBSyxDQUFDO1FBS3JDLFNBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBRXJCLElBQUksQ0FBQyxJQUFJLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQztRQUM1QixJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQUM7UUFDbEMsSUFBSSxDQUFDLFlBQVksR0FBRyxVQUFVLENBQUMsWUFBWSxDQUFDO1FBQzVDLHlCQUFpQixDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNoQyxDQUFDOztJQUVELHdDQUF3QztJQUV4Qzs7T0FFRztJQUNILFFBQVE7UUFDSixJQUFJLFdBQVcsR0FBNkI7WUFDeEMsWUFBWSxFQUFFLElBQUksQ0FBQyxZQUFZO1lBQy9CLE9BQU8sRUFBRSxJQUFJLENBQUMsT0FBTztTQUN4QixDQUFBO1FBQ0QsSUFBSSxDQUFDLHNCQUFzQixDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxFQUFFLFdBQVcsQ0FBQyxDQUFDO1FBQ2pFLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUM3QixDQUFDOztJQUVEOztPQUVHO0lBQ0gsY0FBYyxDQUFDLGVBQXlDO1FBQ3BELElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ25DLHlCQUFpQixDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNuQyxDQUFDO0lBRUQsd0NBQXdDO0lBRXhDOztPQUVHO0lBQ0gsY0FBYztRQUNWLElBQUksb0JBQW9CLEdBQW1CLE9BQU8sQ0FBQyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQ3ZHLG9CQUFvQixDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDO2FBQ3pDLElBQUksQ0FBQyxDQUFDLFVBQVU7WUFDYixJQUFJLFdBQVcsR0FBNkI7Z0JBQ3hDLFlBQVksRUFBRSxVQUFVO2dCQUN4QixPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU87YUFDeEIsQ0FBQTtZQUNELElBQUksQ0FBQyxzQkFBc0IsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLGtCQUFrQixFQUFDLFdBQVcsQ0FBQyxDQUFDO1lBQ3hFLHlCQUFpQixDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNuQyxDQUFDLENBQUMsQ0FBQztJQUNYLENBQUM7QUFDTCxDQUFDO0FBckRZLHFCQUFhLGdCQXFEekIsQ0FBQTtBQUFBLENBQUMifQ==

dist/smartsocket.classes.socketrole.d.ts

@@ -1,3 +1,6 @@
+import { Objectmap } from "lik";
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
+export declare let allSocketRoles: Objectmap<SocketRole>;
 /**
  * interface for class SocketRole
  */
@@ -11,5 +14,7 @@ export interface SocketRoleOptions {
 export declare class SocketRole {
     name: string;
     passwordHash: string;
+    allowedFunctions: Objectmap<SocketFunction>;
     constructor(optionsArg: SocketRoleOptions);
+    addSocketFunction(socketFunctionArg: SocketFunction): void;
 }

dist/smartsocket.classes.socketrole.js

@@ -1,12 +1,21 @@
 "use strict";
+// import classes
+const lik_1 = require("lik");
+exports.allSocketRoles = new lik_1.Objectmap();
 /**
  * A socketrole defines access to certain routines.
  */
 class SocketRole {
     constructor(optionsArg) {
+        this.allowedFunctions = new lik_1.Objectmap();
         this.name = optionsArg.name;
         this.passwordHash = optionsArg.passwordHash;
+        exports.allSocketRoles.add(this);
+    }
+    ;
+    addSocketFunction(socketFunctionArg) {
+        this.allowedFunctions.add(socketFunctionArg);
     }
 }
 exports.SocketRole = SocketRole;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyb2xlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyb2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFjQTs7R0FFRztBQUNIO0lBR0ksWUFBWSxVQUE0QjtRQUNwQyxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7UUFDNUIsSUFBSSxDQUFDLFlBQVksR0FBRyxVQUFVLENBQUMsWUFBWSxDQUFDO0lBQ2hELENBQUM7QUFDTCxDQUFDO0FBUFksa0JBQVUsYUFPdEIsQ0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyb2xlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRzb2NrZXQuY2xhc3Nlcy5zb2NrZXRyb2xlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFFQSxpQkFBaUI7QUFDakIsc0JBQTBCLEtBQUssQ0FBQyxDQUFBO0FBSXJCLHNCQUFjLEdBQUcsSUFBSSxlQUFTLEVBQWMsQ0FBQztBQVd4RDs7R0FFRztBQUNIO0lBSUksWUFBWSxVQUE2QjtRQUR6QyxxQkFBZ0IsR0FBRyxJQUFJLGVBQVMsRUFBa0IsQ0FBQztRQUUvQyxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7UUFDNUIsSUFBSSxDQUFDLFlBQVksR0FBRyxVQUFVLENBQUMsWUFBWSxDQUFDO1FBQzVDLHNCQUFjLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQzdCLENBQUM7O0lBQ0QsaUJBQWlCLENBQUMsaUJBQWdDO1FBQzlDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxHQUFHLENBQUMsaUJBQWlCLENBQUMsQ0FBQztJQUNqRCxDQUFDO0FBQ0wsQ0FBQztBQVpZLGtCQUFVLGFBWXRCLENBQUEifQ==

dist/smartsocket.helpers.d.ts

@@ -1,7 +1,12 @@
-/// <reference types="q" />
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
-import * as plugins from "./smartsocket.plugins";
+import { SocketRequest, TSocketRequestSide } from "./smartsocket.classes.socketrequest";
-import { ISocketObject } from "./smartsocket.classes.smartsocket";
+import { SocketRole } from "./smartsocket.classes.socketrole";
+export declare let getSocketFunctionByName: (functionNameArg: string) => SocketFunction;
 /**
- * authenticate a socket
+ * get corresponding Socketrequest instance by shortId
  */
-export declare let authenticateSocket: (socketObjectArg: ISocketObject) => plugins.q.Promise<{}>;
+export declare let getSocketRequestById: (shortIdArg: string, requestSide?: TSocketRequestSide) => SocketRequest;
+/**
+ * get corresponding SocketRole instance by name
+ */
+export declare let getSocketRoleByName: (socketRoleNameArg: string) => SocketRole;

dist/smartsocket.helpers.js

@@ -1,28 +1,23 @@
 "use strict";
-const plugins = require("./smartsocket.plugins");
+const smartsocket_classes_socketfunction_1 = require("./smartsocket.classes.socketfunction");
-/**
+const smartsocket_classes_socketrequest_1 = require("./smartsocket.classes.socketrequest");
- * authenticate a socket
+const smartsocket_classes_socketrole_1 = require("./smartsocket.classes.socketrole");
- */
+// SocketFunction helpers
-exports.authenticateSocket = (socketObjectArg) => {
+exports.getSocketFunctionByName = (functionNameArg) => {
-    let done = plugins.q.defer();
+    return smartsocket_classes_socketfunction_1.allSocketFunctions.find((socketFunctionArg) => { return socketFunctionArg.name === functionNameArg; });
-    socketObjectArg.socket.on("dataAuth", dataArg => {
-        plugins.beautylog.log("received authentication data. now hashing and comparing...");
-        socketObjectArg.socket.removeListener("dataAuth", () => { });
-        if ((true)) {
-            socketObjectArg.alias = dataArg.alias;
-            socketObjectArg.authenticated = true;
-            socketObjectArg.role = dataArg.role;
-            socketObjectArg.socket.emit("authenticated");
-            plugins.beautylog.ok(`socket with >>alias ${socketObjectArg.alias} >>role ${socketObjectArg.role} is authenticated!`);
-            done.resolve(socketObjectArg);
-        }
-        else {
-            socketObjectArg.socket.disconnect();
-            done.reject("not authenticated");
-        }
-        ;
-    });
-    socketObjectArg.socket.emit("requestAuth");
-    return done.promise;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmhlbHBlcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHVCQUF1QixDQUFDLENBQUE7QUFRakQ7O0dBRUc7QUFDUSwwQkFBa0IsR0FBRyxDQUFDLGVBQThCO0lBQzNELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsZUFBZSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsVUFBVSxFQUFFLE9BQU87UUFDekMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsNERBQTRELENBQUMsQ0FBQztRQUNwRixlQUFlLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQztRQUM3RCxFQUFFLENBQUEsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUNQLGVBQWUsQ0FBQyxLQUFLLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQTtZQUNyQyxlQUFlLENBQUMsYUFBYSxHQUFHLElBQUksQ0FBQztZQUNyQyxlQUFlLENBQUMsSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7WUFDcEMsZUFBZSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7WUFDN0MsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsdUJBQXVCLGVBQWUsQ0FBQyxLQUFLLFdBQVcsZUFBZSxDQUFDLElBQUksb0JBQW9CLENBQUMsQ0FBQTtZQUNySCxJQUFJLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQ2xDLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLGVBQWUsQ0FBQyxNQUFNLENBQUMsVUFBVSxFQUFFLENBQUM7WUFDcEMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1FBQ3JDLENBQUM7UUFBQSxDQUFDO0lBQ04sQ0FBQyxDQUFDLENBQUM7SUFDSCxlQUFlLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUMzQyxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUMifQ==
+// SocketRequest helpers
+/**
+ * get corresponding Socketrequest instance by shortId
+ */
+exports.getSocketRequestById = (shortIdArg, requestSide) => {
+    return smartsocket_classes_socketrequest_1.allSocketRequests.find((socketRequestArg) => { return socketRequestArg.shortid === shortIdArg; });
+};
+// SocketRole helpers
+/**
+ * get corresponding SocketRole instance by name
+ */
+exports.getSocketRoleByName = (socketRoleNameArg) => {
+    return smartsocket_classes_socketrole_1.allSocketRoles.find((socketRoleArg) => { return socketRoleArg.name === socketRoleNameArg; });
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQuaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LmhlbHBlcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUlBLHFEQUFtRCxzQ0FBc0MsQ0FBQyxDQUFBO0FBRTFGLG9EQUFxRSxxQ0FBcUMsQ0FBQyxDQUFBO0FBQzNHLGlEQUEyQyxrQ0FBa0MsQ0FBQyxDQUFBO0FBRTlFLHlCQUF5QjtBQUNkLCtCQUF1QixHQUFHLENBQUMsZUFBdUI7SUFDekQsTUFBTSxDQUFDLHVEQUFrQixDQUFDLElBQUksQ0FBQyxDQUFDLGlCQUFpQixPQUFPLE1BQU0sQ0FBQyxpQkFBaUIsQ0FBQyxJQUFJLEtBQUssZUFBZSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDakgsQ0FBQyxDQUFBO0FBRUQsd0JBQXdCO0FBRXhCOztHQUVHO0FBQ1EsNEJBQW9CLEdBQUcsQ0FBQyxVQUFpQixFQUFDLFdBQStCO0lBQ2hGLE1BQU0sQ0FBQyxxREFBaUIsQ0FBQyxJQUFJLENBQUMsQ0FBQyxnQkFBZ0IsT0FBTSxNQUFNLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxLQUFLLFVBQVUsQ0FBQSxDQUFBLENBQUMsQ0FBQyxDQUFBO0FBQ3pHLENBQUMsQ0FBQTtBQUVELHFCQUFxQjtBQUVyQjs7R0FFRztBQUNRLDJCQUFtQixHQUFHLENBQUMsaUJBQXlCO0lBQ3ZELE1BQU0sQ0FBQywrQ0FBYyxDQUFDLElBQUksQ0FBQyxDQUFDLGFBQWEsT0FBTyxNQUFNLENBQUMsYUFBYSxDQUFDLElBQUksS0FBSyxpQkFBaUIsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO0FBQ3RHLENBQUMsQ0FBQyJ9

dist/smartsocket.plugins.d.ts

@@ -2,6 +2,7 @@ import "typings-global";
 export import beautylog = require("beautylog");
 export import lik = require("lik");
 export import q = require("q");
+export import shortid = require("shortid");
 export import socketIo = require("socket.io");
 export import socketIoClient = require("socket.io-client");
 export import taskbuffer = require("taskbuffer");

dist/smartsocket.plugins.js

@@ -3,7 +3,8 @@ require("typings-global");
 exports.beautylog = require("beautylog");
 exports.lik = require("lik");
 exports.q = require("q");
+exports.shortid = require("shortid");
 exports.socketIo = require("socket.io");
 exports.socketIoClient = require("socket.io-client");
 exports.taskbuffer = require("taskbuffer");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsV0FBRyxXQUFZLEtBQUssQ0FBQyxDQUFDO0FBQ3RCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixnQkFBUSxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2hDLHNCQUFjLFdBQVcsa0JBQWtCLENBQUMsQ0FBQztBQUM3QyxrQkFBVSxXQUFXLFlBQVksQ0FBQyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzb2NrZXQucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c29ja2V0LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsV0FBRyxXQUFZLEtBQUssQ0FBQyxDQUFDO0FBQ3RCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixlQUFPLFdBQVcsU0FBUyxDQUFDLENBQUM7QUFDN0IsZ0JBQVEsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNoQyxzQkFBYyxXQUFXLGtCQUFrQixDQUFDLENBQUM7QUFDN0Msa0JBQVUsV0FBVyxZQUFZLENBQUMsQ0FBQyJ9

npmextra.json

@@ -0,0 +1,5 @@
+{
+    "npmts":{
+        "coverageTreshold":50
+    }
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "smartsocket",
-  "version": "1.0.2",
+  "version": "1.0.6",
-  "description": "easy and secure websocket communication",
+  "description": "easy and secure websocket communication, Typescript ready",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
@@ -19,17 +19,20 @@
   "homepage": "https://gitlab.com/pushrocks/smartsocket#README",
   "dependencies": {
     "@types/q": "0.x.x",
+    "@types/shortid": "0.0.27",
     "@types/socket.io": "^1.4.26",
     "@types/socket.io-client": "^1.4.26",
     "beautylog": "^5.0.20",
-    "lik": "^1.0.10",
+    "lik": "^1.0.15",
     "q": "^1.4.1",
+    "shortid": "^2.2.6",
     "socket.io": "^1.4.8",
     "socket.io-client": "^1.4.8",
     "taskbuffer": "^1.0.7"
   },
   "devDependencies": {
-    "should": "^10.0.0",
+    "npmts-g": "^5.2.8",
+    "should": "^11.0.0",
     "typings-test": "^1.0.1"
   }
 }

test/test.js

@@ -1,37 +1,75 @@
 "use strict";
 require("typings-test");
 require("should");
-const socketIoClient = require("socket.io-client");
 const smartsocket = require("../dist/index");
+const q = require("q");
 let testSmartsocket;
+let testSmartsocketClient;
+let testSocketFunction1;
+let testConfig = {
+    port: 3000
+};
 describe("smartsocket", function () {
-    it("should create a new smartsocket", function () {
+    describe("class Smartsocket", function () {
-        testSmartsocket = new smartsocket.Smartsocket({ port: 3000 });
+        it("should create a new smartsocket", function () {
-        testSmartsocket.should.be.instanceOf(smartsocket.Smartsocket);
+            testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
+            testSmartsocket.should.be.instanceOf(smartsocket.Smartsocket);
+        });
+        it("should start listening when .started is called", function () {
+            testSmartsocket.startServer();
+        });
     });
-    it("should register a new Function", function () {
+    describe("class SocketRole", function () {
     });
-    it("should start listening when .started is called", function () {
+    describe("class SocketFunction", function () {
-        testSmartsocket.startServer();
+        it("should register a new Function", function () {
-    });
+            testSocketFunction1 = new smartsocket.SocketFunction({
-    it("should react to a new websocket connection", function (done) {
+                funcName: "testFunction1",
-        this.timeout(10000);
+                funcDef: () => {
-        let socket = socketIoClient("http://localhost:3000", {});
+                    let done = q.defer();
-        socket.on("requestAuth", function () {
+                    return done.promise;
-            console.log("server requested authentication");
+                },
-            socket.emit("dataAuth", {
+                allowedRoles: []
-                role: "coreflowContainer",
-                password: "somePassword",
-                alias: "coreflow1"
-            });
-            socket.on("authenticated", () => {
-                console.log("client is authenticated");
-                done();
             });
         });
     });
-    it("should close the server", function () {
+    describe("class SmartsocketClient", function () {
-        testSmartsocket.closeServer();
+        it("should react to a new websocket connection from client", function (done) {
+            this.timeout(10000);
+            testSmartsocketClient = new smartsocket.SmartsocketClient({
+                port: testConfig.port,
+                url: "http://localhost",
+                password: "testPassword",
+                alias: "testClient1",
+                role: undefined
+            });
+            testSmartsocketClient.connect()
+                .then(() => {
+                done();
+            });
+        });
+        it("client should disconnect and reconnect", function (done) {
+            this.timeout(10000);
+            testSmartsocketClient.disconnect()
+                .then(() => {
+                let done = q.defer();
+                setTimeout(() => {
+                    testSmartsocketClient.connect()
+                        .then(done.resolve);
+                }, 0);
+                return done.promise;
+            })
+                .then(() => {
+                done();
+            });
+        });
+        it("2 clients should connect in parallel", function () {
+        });
+    });
+    describe("terminating smartsocket", function () {
+        it("should close the server", function () {
+            testSmartsocket.closeServer();
+        });
     });
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQixNQUFPLGNBQWMsV0FBVyxrQkFBa0IsQ0FBQyxDQUFDO0FBQ3BELE1BQU8sV0FBVyxXQUFXLGVBQWUsQ0FBQyxDQUFDO0FBRTlDLElBQUksZUFBd0MsQ0FBQztBQUU3QyxRQUFRLENBQUMsYUFBYSxFQUFFO0lBQ3BCLEVBQUUsQ0FBQyxpQ0FBaUMsRUFBRTtRQUNsQyxlQUFlLEdBQUcsSUFBSSxXQUFXLENBQUMsV0FBVyxDQUFDLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7UUFDOUQsZUFBZSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNsRSxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyxnQ0FBZ0MsRUFBQztJQUVwQyxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxnREFBZ0QsRUFBQztRQUNoRCxlQUFlLENBQUMsV0FBVyxFQUFFLENBQUM7SUFDbEMsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNENBQTRDLEVBQUUsVUFBVSxJQUFJO1FBQzNELElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDcEIsSUFBSSxNQUFNLEdBQUcsY0FBYyxDQUFDLHVCQUF1QixFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ3pELE1BQU0sQ0FBQyxFQUFFLENBQUMsYUFBYSxFQUFFO1lBQ3JCLE9BQU8sQ0FBQyxHQUFHLENBQUMsaUNBQWlDLENBQUMsQ0FBQztZQUMvQyxNQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtnQkFDcEIsSUFBSSxFQUFFLG1CQUFtQjtnQkFDekIsUUFBUSxFQUFFLGNBQWM7Z0JBQ3hCLEtBQUssRUFBRSxXQUFXO2FBQ3JCLENBQUMsQ0FBQztZQUNILE1BQU0sQ0FBQyxFQUFFLENBQUMsZUFBZSxFQUFDO2dCQUN0QixPQUFPLENBQUMsR0FBRyxDQUFDLHlCQUF5QixDQUFDLENBQUM7Z0JBQ3ZDLElBQUksRUFBRSxDQUFDO1lBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUMsQ0FBQztJQUNQLENBQUMsQ0FBQyxDQUFDO0lBQ0gsRUFBRSxDQUFDLHlCQUF5QixFQUFDO1FBQ3pCLGVBQWUsQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUNsQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFdBQVcsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUM5QyxNQUFPLENBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUV4QixJQUFJLGVBQXdDLENBQUM7QUFDN0MsSUFBSSxxQkFBb0QsQ0FBQztBQUN6RCxJQUFJLG1CQUE4QyxDQUFDO0FBRW5ELElBQUksVUFBVSxHQUFHO0lBQ2IsSUFBSSxFQUFFLElBQUk7Q0FDYixDQUFBO0FBRUQsUUFBUSxDQUFDLGFBQWEsRUFBRTtJQUNwQixRQUFRLENBQUMsbUJBQW1CLEVBQUU7UUFDMUIsRUFBRSxDQUFDLGlDQUFpQyxFQUFFO1lBQ2xDLGVBQWUsR0FBRyxJQUFJLFdBQVcsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsVUFBVSxDQUFDLElBQUksRUFBRSxDQUFDLENBQUM7WUFDekUsZUFBZSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNsRSxDQUFDLENBQUMsQ0FBQztRQUNILEVBQUUsQ0FBQyxnREFBZ0QsRUFBRTtZQUNqRCxlQUFlLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDbEMsQ0FBQyxDQUFDLENBQUM7SUFDUCxDQUFDLENBQUMsQ0FBQztJQUNILFFBQVEsQ0FBQyxrQkFBa0IsRUFBRTtJQUU3QixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxzQkFBc0IsRUFBRTtRQUM3QixFQUFFLENBQUMsZ0NBQWdDLEVBQUU7WUFDakMsbUJBQW1CLEdBQUcsSUFBSSxXQUFXLENBQUMsY0FBYyxDQUFDO2dCQUNqRCxRQUFRLEVBQUMsZUFBZTtnQkFDeEIsT0FBTyxFQUFFO29CQUNMLElBQUksSUFBSSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztvQkFDckIsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7Z0JBQ3hCLENBQUM7Z0JBQ0QsWUFBWSxFQUFDLEVBQUU7YUFDbEIsQ0FBQyxDQUFDO1FBQ1AsQ0FBQyxDQUFDLENBQUM7SUFDUCxDQUFDLENBQUMsQ0FBQztJQUNILFFBQVEsQ0FBQyx5QkFBeUIsRUFBRTtRQUNoQyxFQUFFLENBQUMsd0RBQXdELEVBQUUsVUFBVSxJQUFJO1lBQ3ZFLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDcEIscUJBQXFCLEdBQUcsSUFBSSxXQUFXLENBQUMsaUJBQWlCLENBQUM7Z0JBQ3RELElBQUksRUFBRSxVQUFVLENBQUMsSUFBSTtnQkFDckIsR0FBRyxFQUFFLGtCQUFrQjtnQkFDdkIsUUFBUSxFQUFFLGNBQWM7Z0JBQ3hCLEtBQUssRUFBRSxhQUFhO2dCQUNwQixJQUFJLEVBQUUsU0FBUzthQUNsQixDQUFDLENBQUM7WUFDSCxxQkFBcUIsQ0FBQyxPQUFPLEVBQUU7aUJBQzFCLElBQUksQ0FBQztnQkFDRixJQUFJLEVBQUUsQ0FBQztZQUNYLENBQUMsQ0FBQyxDQUFDO1FBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDSCxFQUFFLENBQUMsd0NBQXdDLEVBQUUsVUFBVSxJQUFJO1lBQ3ZELElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDcEIscUJBQXFCLENBQUMsVUFBVSxFQUFFO2lCQUM3QixJQUFJLENBQUM7Z0JBQ0YsSUFBSSxJQUFJLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO2dCQUNyQixVQUFVLENBQUM7b0JBQ1AscUJBQXFCLENBQUMsT0FBTyxFQUFFO3lCQUMxQixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFBO2dCQUMzQixDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUE7Z0JBQ0wsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7WUFDeEIsQ0FBQyxDQUFDO2lCQUNELElBQUksQ0FBQztnQkFDRixJQUFJLEVBQUUsQ0FBQztZQUNYLENBQUMsQ0FBQyxDQUFDO1FBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDSCxFQUFFLENBQUMsc0NBQXNDLEVBQUU7UUFFM0MsQ0FBQyxDQUFDLENBQUM7SUFDUCxDQUFDLENBQUMsQ0FBQztJQUNILFFBQVEsQ0FBQyx5QkFBeUIsRUFBRTtRQUNoQyxFQUFFLENBQUMseUJBQXlCLEVBQUU7WUFDMUIsZUFBZSxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQ2xDLENBQUMsQ0FBQyxDQUFDO0lBQ1AsQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQyJ9

test/test.ts

@@ -2,37 +2,78 @@ import "typings-test";
 import "should";
 import socketIoClient = require("socket.io-client");
 import smartsocket = require("../dist/index");
+import q = require("q");
 
 let testSmartsocket: smartsocket.Smartsocket;
+let testSmartsocketClient: smartsocket.SmartsocketClient;
+let testSocketFunction1:smartsocket.SocketFunction;
+
+let testConfig = {
+    port: 3000
+}
 
 describe("smartsocket", function () {
-    it("should create a new smartsocket", function () {
+    describe("class Smartsocket", function () {
-        testSmartsocket = new smartsocket.Smartsocket({ port: 3000 });
+        it("should create a new smartsocket", function () {
-        testSmartsocket.should.be.instanceOf(smartsocket.Smartsocket);
+            testSmartsocket = new smartsocket.Smartsocket({ port: testConfig.port });
+            testSmartsocket.should.be.instanceOf(smartsocket.Smartsocket);
+        });
+        it("should start listening when .started is called", function () {
+            testSmartsocket.startServer();
+        });
     });
-    it("should register a new Function",function(){
+    describe("class SocketRole", function(){
-        
+
     })
-    it("should start listening when .started is called",function(){
+    describe("class SocketFunction", function () {
-        testSmartsocket.startServer();
+        it("should register a new Function", function () {
-    })
+            testSocketFunction1 = new smartsocket.SocketFunction({
-    it("should react to a new websocket connection", function (done) {
+                funcName:"testFunction1",
-        this.timeout(10000);
+                funcDef: () => {
-        let socket = socketIoClient("http://localhost:3000", {});
+                    let done = q.defer();
-        socket.on("requestAuth", function () {
+                    return done.promise;
-            console.log("server requested authentication");
+                },
-            socket.emit("dataAuth", {
+                allowedRoles:[]
-                role: "coreflowContainer",
-                password: "somePassword",
-                alias: "coreflow1"
-            });
-            socket.on("authenticated",() => {
-                console.log("client is authenticated");
-                done();
             });
         });
     });
-    it("should close the server",function(){
+    describe("class SmartsocketClient", function () {
-        testSmartsocket.closeServer();
+        it("should react to a new websocket connection from client", function (done) {
+            this.timeout(10000);
+            testSmartsocketClient = new smartsocket.SmartsocketClient({
+                port: testConfig.port,
+                url: "http://localhost",
+                password: "testPassword",
+                alias: "testClient1",
+                role: undefined
+            });
+            testSmartsocketClient.connect()
+                .then(() => {
+                    done();
+                });
+        });
+        it("client should disconnect and reconnect", function (done) {
+            this.timeout(10000);
+            testSmartsocketClient.disconnect()
+                .then(() => {
+                    let done = q.defer();
+                    setTimeout(() => {
+                        testSmartsocketClient.connect()
+                            .then(done.resolve)
+                    }, 0)
+                    return done.promise;
+                })
+                .then(() => {
+                    done();
+                });
+        });
+        it("2 clients should connect in parallel", function () {
+
+        });
+    });
+    describe("terminating smartsocket", function () {
+        it("should close the server", function () {
+            testSmartsocket.closeServer();
+        });
     })
 });

ts/index.ts

@@ -2,3 +2,7 @@ import * as plugins from "./smartsocket.plugins";
 
 export * from "./smartsocket.classes.smartsocket";
 export * from "./smartsocket.classes.smartsocketclient";
+export * from "./smartsocket.classes.socketfunction";
+export * from "./smartsocket.classes.socketrole";
+
+// need something more exposed? Create an issue on GitLab!

ts/smartsocket.classes.smartsocket.ts

@@ -3,16 +3,9 @@ import * as helpers from "./smartsocket.helpers";
 
 // classes
 import { Objectmap } from "lik";
-import {SocketRole} from "./smartsocket.classes.socketrole";
+import { SocketRole } from "./smartsocket.classes.socketrole";
-import {SocketFunction} from "./smartsocket.classes.socketfunction";
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
-
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
-
-export interface ISocketObject {
-    alias?:string;
-    authenticated: boolean
-    role?:string,
-    socket: SocketIO.Socket,
-};
 
 export interface ISmartsocketConstructorOptions {
     port: number;
@@ -20,10 +13,9 @@ export interface ISmartsocketConstructorOptions {
 };
 
 export class Smartsocket {
-    options:ISmartsocketConstructorOptions
+    options: ISmartsocketConstructorOptions
     io: SocketIO.Server;
-    openSockets = new Objectmap();
+    openSockets = new Objectmap<SocketConnection>();
-    registeredRoles = new Objectmap();
     constructor(optionsArg: ISmartsocketConstructorOptions) {
         this.options = optionsArg;
     };
@@ -31,38 +23,41 @@ export class Smartsocket {
     /**
      * the standard handler for new socket connections
      */
-    private _handleSocket(socket) {
+    private _handleSocketConnection(socketArg) {
-        let socketObject: ISocketObject = {
+        let socketConnection: SocketConnection =  new SocketConnection({
-            socket: socket,
+            alias:undefined,
-            authenticated: false
+            authenticated:false,
-        };
+            role:undefined,
+            socket:socketArg
+        });
         plugins.beautylog.log("Socket connected. Trying to authenticate...")
-        this.openSockets.add(socketObject);
+        this.openSockets.add(socketConnection);
-        helpers.authenticateSocket(socketObject)
+        socketConnection.authenticate()
-            .then();
+            .then(socketConnection.listenToFunctionRequests);
-    }
-
-    registerFunctions(socketRoleArg:SocketRole){
-        this.registeredRoles.add(socketRoleArg);
     };
 
-
     /**
      * starts listening to incling sockets:
      */
 
     startServer = () => {
         this.io = plugins.socketIo(this.options.port);
-        this.io.on('connection', (socketArg) => {
+        this.io.on("connection", (socketArg) => {
-            this._handleSocket(socketArg);
+            this._handleSocketConnection(socketArg);
         });
     }
     closeServer = () => {
-        this.openSockets.forEach((socketObjectArg: ISocketObject) => {
+        this.openSockets.forEach((socketObjectArg: SocketConnection) => {
             plugins.beautylog.log(`disconnect socket with >>alias ${socketObjectArg.alias}`);
             socketObjectArg.socket.disconnect();
         });
         this.openSockets.wipe();
         this.io.close();
+    };
+
+    // communication
+    clientCall(){
+        
+        // TODO: target specific client and initiate response        
     }
 }

ts/smartsocket.classes.smartsocketclient.ts

@@ -1,15 +1,91 @@
 import * as plugins from "./smartsocket.plugins"
 
+
+// import interfaces
+import { ISocketFunctionCall } from "./smartsocket.classes.socketfunction";
+import { ISocketRequestDataObject } from "./smartsocket.classes.socketrequest"
+
+// import classes
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
+import { SocketRequest } from "./smartsocket.classes.socketrequest";
 /**
  * interface for class SmartsocketClient
  */
 export interface ISmartsocketClientOptions {
-    port:number;
+    port: number;
-    url:string;
+    url: string;
+    alias:string; // an alias makes it easier to identify this client in a multo client environment
+    role:string;
+    password: string; // by setting a password access to functions can be limited
 }
 
 export class SmartsocketClient {
-    constructor(){
+    alias:string;
+    role:string;
+    socketConnection:SocketConnection;
+    serverUrl:string;
+    serverPort:number;
+    serverPassword:string;
+    constructor(optionsArg:ISmartsocketClientOptions){
+        this.alias = optionsArg.alias;
+        this.role = optionsArg.role;
+        this.serverUrl = optionsArg.url
+        this.serverPort = optionsArg.port;
+        this.serverPassword = optionsArg.password
+    };
 
+    /**
+     * connect the client to the server
+     */
+    connect(){
+        let done = plugins.q.defer();
+        plugins.beautylog.log("trying to connect...");
+        let socketUrl = `${this.serverUrl}:${this.serverPort}`;
+        this.socketConnection = new SocketConnection({
+            alias:this.alias,
+            authenticated:false,
+            role:undefined,
+            socket: plugins.socketIoClient(socketUrl,{multiplex:false})
+        });
+        this.socketConnection.socket.on("requestAuth", () => {
+            console.log("server requested authentication");
+            this.socketConnection.socket.emit("dataAuth", {
+                role: this.role,
+                password: this.serverPassword,
+                alias: this.alias
+            });
+            this.socketConnection.socket.on("authenticated",() => {
+                console.log("client is authenticated");
+                done.resolve();
+            });
+        });
+        return done.promise;
+    };
+    disconnect(){
+        let done = plugins.q.defer();
+        this.socketConnection.socket.disconnect();
+        this.socketConnection = undefined;
+        plugins.beautylog.ok("disconnected!");
+        done.resolve();
+        return done.promise;
     }
+    serverCall(functionNameArg:string,dataArg:ISocketFunctionCall){
+        let done = plugins.q.defer();
+        let socketRequest = new SocketRequest({
+            side:"requesting",
+            originSocketConnection:this.socketConnection,
+            shortId:plugins.shortid.generate(),
+            funcCallData:{
+                funcName: functionNameArg,
+                funcDataArg:dataArg
+            }
+        });
+        socketRequest.dispatch()
+            .then(() => {
+                done.resolve();
+            });
+        return done.promise;
+    };
+    
 }

ts/smartsocket.classes.socketconnection.ts

@@ -0,0 +1,115 @@
+import * as plugins from "./smartsocket.plugins";
+import * as helpers from "./smartsocket.helpers";
+
+// import classes
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
+import { SocketRequest, ISocketRequestDataObject, allSocketRequests } from "./smartsocket.classes.socketrequest";
+import { SocketRole } from "./smartsocket.classes.socketrole";
+
+// export interfaces
+
+/**
+ * interface for constructor of class SocketConnection
+ */
+export interface ISocketConnectionConstructorOptions {
+    alias: string;
+    authenticated: boolean;
+    role: SocketRole;
+    socket: SocketIO.Socket | SocketIOClient.Socket;
+};
+
+/**
+ * interface for authentication data
+ */
+export interface ISocketConnectionAuthenticationObject {
+    role: "coreflowContainer",
+    password: "somePassword",
+    alias: "coreflow1"
+}
+
+// export classes
+
+/**
+ * class SocketConnection represents a websocket connection
+ */
+export class SocketConnection {
+    alias: string;
+    authenticated: boolean;
+    role: SocketRole;
+    socket: SocketIO.Socket | SocketIOClient.Socket;
+    constructor(optionsArg: ISocketConnectionConstructorOptions) {
+        this.alias = optionsArg.alias;
+        this.authenticated = optionsArg.authenticated;
+        this.role = optionsArg.role;
+        this.socket = optionsArg.socket;
+        
+        // standard behaviour that is always true
+        this.socket.on("disconnect", () => {
+            plugins.beautylog.info(`Client ${this.alias} disconnected`);
+        });
+    };
+
+    // authenticating --------------------------
+
+    /**
+     * authenticate the socket
+     */
+    authenticate() {
+        let done = plugins.q.defer();
+        this.socket.on("dataAuth", dataArg => {
+            plugins.beautylog.log("received authentication data. now hashing and comparing...");
+            this.socket.removeListener("dataAuth", () => { });
+            if ((true)) { // TODO: authenticate password
+                this.alias = dataArg.alias
+                this.authenticated = true;
+                this.role = helpers.getSocketRoleByName(dataArg.role);
+                this.socket.emit("authenticated");
+                plugins.beautylog.ok(`socket with >>alias ${this.alias} >>role ${this.role} is authenticated!`);
+                done.resolve(this);
+            } else {
+                this.socket.disconnect();
+                done.reject("not authenticated");
+            };
+        });
+        this.socket.emit("requestAuth");
+        return done.promise;
+    };
+
+    // listening -------------------------------
+
+    /**
+     * listen to function requests
+     */
+    listenToFunctionRequests() {
+        let done = plugins.q.defer();
+        if(this.authenticated){
+            this.socket.on("function", (dataArg:ISocketRequestDataObject) => {
+                // check if requested function is available to the socket's scope
+                let referencedFunction:SocketFunction = this.role.allowedFunctions.find((socketFunctionArg) => {
+                    return socketFunctionArg.name === dataArg.funcCallData.funcName;
+                });
+                if(referencedFunction !== undefined){
+                    let localSocketRequest = new SocketRequest({
+                        side:"responding",
+                        originSocketConnection:this,
+                        shortId:dataArg.shortId,
+                        funcCallData:dataArg.funcCallData
+                    });
+                    localSocketRequest.createResponse(); // takes care of creating response and sending it back 
+                } else {
+                    plugins.beautylog.warn("function not existent or out of access scope");
+                };
+            });
+            this.socket.on("functionResponse", (dataArg:ISocketRequestDataObject) => {
+                let targetSocketRequest = helpers.getSocketRequestById(dataArg.shortId);
+                targetSocketRequest.handleResponse(dataArg);
+            })
+        } else {
+            done.reject("socket needs to be authenticated first");
+        };
+        return done.promise;
+    };
+
+    // sending ----------------------
+    
+};

ts/smartsocket.classes.socketfunction.ts

@@ -1,24 +1,83 @@
 import * as plugins from "./smartsocket.plugins";
 
 // import classes
-import { Stringmap } from "lik";
+import { Objectmap } from "lik";
 import { SocketRole } from "./smartsocket.classes.socketrole";
 
+// export interfaces
 
-
+/**
-export interface SocketFunctionOptions {
+ * interface of the contructor options of class SocketFunction
-    name: string;
+ */
-    func: any;
+export interface ISocketFunctionConstructorOptions {
-    roles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
+    funcName: string;
+    funcDef: any;
+    allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
 };
 
+/**
+ * interface of the Socket Function call, in other words the object that routes a call to a function
+ */
+export interface ISocketFunctionCall {
+    funcName:string;
+    funcDataArg:any;
+};
+
+/**
+ * interface for function definition of SocketFunction
+ */
+export interface IFuncDef {
+    (dataArg:any):PromiseLike<any>
+}
+
+// export objects
+export let allSocketFunctions = new Objectmap<SocketFunction>();
+
+// export classes
+
+/**
+ * class that respresents a function that can be transparently called using a SocketConnection
+ */
 export class SocketFunction {
     name: string;
-    func: any;
+    funcDef: IFuncDef;
     roles: SocketRole[];
-    constructor(optionsArg: SocketFunctionOptions) {
+
-        this.name = optionsArg.name;
+    /**
-        this.func = optionsArg.func;
+     * the constructor for SocketFunction
-        this.roles = optionsArg.roles;
+     */
+    constructor(optionsArg: ISocketFunctionConstructorOptions) {
+        this.name = optionsArg.funcName;
+        this.funcDef = optionsArg.funcDef;
+        this.roles = optionsArg.allowedRoles;
+        for (let socketRoleArg of this.roles){
+            this._notifyRole(socketRoleArg);
+        };
+        allSocketFunctions.add(this); // map instance with Objectmap
     };
+
+    /** 
+     * notifies a role about access to this SocketFunction
+     */
+    private _notifyRole(socketRoleArg:SocketRole){
+        socketRoleArg.addSocketFunction(this);
+    }
+    
+    /**
+     * invokes the function of this SocketFunction
+     */
+    invoke(dataArg:ISocketFunctionCall):plugins.q.Promise<any> {
+        let done = plugins.q.defer();
+        if(dataArg.funcName === this.name){
+            this.funcDef(dataArg.funcDataArg)
+                .then((resultData:any) => {
+                    done.resolve(resultData);
+                });
+                
+        } else {
+            throw new Error("SocketFunction.name does not match the data argument's .name!");
+        }
+        return done.promise;        
+    };
+
 }

ts/smartsocket.classes.socketrequest.ts

@@ -0,0 +1,92 @@
+import * as plugins from "./smartsocket.plugins";
+import * as helpers from "./smartsocket.helpers";
+
+// import interfaces
+import { ISocketFunctionCall } from "./smartsocket.classes.socketfunction";
+
+// import classes
+import { Objectmap } from "lik";
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
+
+// export interfaces
+export type TSocketRequestStatus = "new" | "pending" | "finished";
+export type TSocketRequestSide = "requesting" | "responding";
+
+/**
+ * interface of constructor of class SocketRequest
+ */
+export interface SocketRequestConstructorOptions {
+    side: TSocketRequestSide;
+    originSocketConnection: SocketConnection;
+    shortId: string;
+    funcCallData?: ISocketFunctionCall;
+};
+
+/**
+ * request object that is sent initially and may or may not receive a response
+ */
+export interface ISocketRequestDataObject {
+    funcCallData: ISocketFunctionCall;
+    shortId: string;
+    responseTimeout?: number;
+};
+
+//export objects
+export let allSocketRequests = new Objectmap<SocketRequest>();
+
+// export classes
+export class SocketRequest {
+    status: TSocketRequestStatus = "new";
+    side: TSocketRequestSide;
+    shortid: string;
+    originSocketConnection: SocketConnection;
+    funcCallData: ISocketFunctionCall
+    done = plugins.q.defer();
+    constructor(optionsArg: SocketRequestConstructorOptions) {
+        this.side = optionsArg.side;
+        this.shortid = optionsArg.shortId;
+        this.funcCallData = optionsArg.funcCallData;
+        allSocketRequests.add(this);
+    };
+
+    // requesting --------------------------
+
+    /**
+     * dispatches a socketrequest from the requesting to the receiving side
+     */
+    dispatch() {
+        let requestData: ISocketRequestDataObject = {
+            funcCallData: this.funcCallData,
+            shortId: this.shortid
+        }
+        this.originSocketConnection.socket.emit("function", requestData);
+        return this.done.promise;
+    };
+
+    /**
+     * handles the response that is received by the requesting side
+     */
+    handleResponse(responseDataArg: ISocketRequestDataObject) {
+        this.done.resolve(responseDataArg);
+        allSocketRequests.remove(this);
+    }
+
+    // responding --------------------------
+
+    /**
+     * creates the response on the responding side
+     */
+    createResponse() {
+        let targetSocketFunction: SocketFunction = helpers.getSocketFunctionByName(this.funcCallData.funcName);
+        targetSocketFunction.invoke(this.funcCallData)
+            .then((resultData) => {
+                let requestData: ISocketRequestDataObject = {
+                    funcCallData: resultData,
+                    shortId: this.shortid
+                }
+                this.originSocketConnection.socket.emit("functionResponse",requestData);
+                allSocketRequests.remove(this);
+            });
+    }
+};

ts/smartsocket.classes.socketrole.ts

@@ -1,25 +1,34 @@
 import * as plugins from "./smartsocket.plugins";
 
 // import classes
-import { Stringmap } from "lik";
+import { Objectmap } from "lik";
+import { SocketFunction } from "./smartsocket.classes.socketfunction";
+
+
+export let allSocketRoles = new Objectmap<SocketRole>();
+
 
 /**
  * interface for class SocketRole
  */
 export interface SocketRoleOptions {
-    name:string;
+    name: string;
-    passwordHash:string;
+    passwordHash: string;
 }
 
-
 /**
  * A socketrole defines access to certain routines.
  */
 export class SocketRole {
-    name:string;
+    name: string;
-    passwordHash:string;
+    passwordHash: string;
-    constructor(optionsArg:SocketRoleOptions){
+    allowedFunctions = new Objectmap<SocketFunction>();
+    constructor(optionsArg: SocketRoleOptions) {
         this.name = optionsArg.name;
         this.passwordHash = optionsArg.passwordHash;
+        allSocketRoles.add(this);
+    };
+    addSocketFunction(socketFunctionArg:SocketFunction){
+        this.allowedFunctions.add(socketFunctionArg);
     }
 }

ts/smartsocket.helpers.ts

@@ -1,31 +1,32 @@
 import * as plugins from "./smartsocket.plugins";
 
-// interfaces
+// classes
-import {ISocketObject} from "./smartsocket.classes.smartsocket";
+import { Smartsocket } from "./smartsocket.classes.smartsocket";
-
+import { SocketFunction, allSocketFunctions } from "./smartsocket.classes.socketfunction";
+import { SocketConnection } from "./smartsocket.classes.socketconnection";
+import { SocketRequest, allSocketRequests, TSocketRequestSide } from "./smartsocket.classes.socketrequest";
+import { SocketRole, allSocketRoles } from "./smartsocket.classes.socketrole";
 
+// SocketFunction helpers
+export let getSocketFunctionByName = (functionNameArg: string):SocketFunction => {
+    return allSocketFunctions.find((socketFunctionArg) => { return socketFunctionArg.name === functionNameArg });
+}
 
+// SocketRequest helpers
 
 /**
- * authenticate a socket
+ * get corresponding Socketrequest instance by shortId
  */
-export let authenticateSocket = (socketObjectArg: ISocketObject) => {
+export let getSocketRequestById = (shortIdArg:string,requestSide?:TSocketRequestSide):SocketRequest => {
-    let done = plugins.q.defer();
+    return allSocketRequests.find((socketRequestArg) => {return socketRequestArg.shortid === shortIdArg})
-    socketObjectArg.socket.on("dataAuth", dataArg => {
+}
-        plugins.beautylog.log("received authentication data. now hashing and comparing...");
+
-        socketObjectArg.socket.removeListener("dataAuth", () => { });
+// SocketRole helpers
-        if((true)){ // TODO: authenticate password
+
-            socketObjectArg.alias = dataArg.alias 
+/**
-            socketObjectArg.authenticated = true;
+ * get corresponding SocketRole instance by name
-            socketObjectArg.role = dataArg.role;
+ */
-            socketObjectArg.socket.emit("authenticated");
+export let getSocketRoleByName = (socketRoleNameArg: string): SocketRole => {
-            plugins.beautylog.ok(`socket with >>alias ${socketObjectArg.alias} >>role ${socketObjectArg.role} is authenticated!`)
+    return allSocketRoles.find((socketRoleArg) => { return socketRoleArg.name === socketRoleNameArg })
-            done.resolve(socketObjectArg);
+};
-        } else {
+
-            socketObjectArg.socket.disconnect();
-            done.reject("not authenticated");
-        };
-    });
-    socketObjectArg.socket.emit("requestAuth");
-    return done.promise;
-};

ts/smartsocket.plugins.ts

@@ -2,6 +2,7 @@ import "typings-global";
 export import beautylog = require("beautylog");
 export import lik  = require("lik");
 export import q = require("q");
+export import shortid = require("shortid");
 export import socketIo = require("socket.io");
 export import socketIoClient = require("socket.io-client");
 export import taskbuffer = require("taskbuffer");