1.0.49

.gitignore

@@ -1,6 +1,22 @@
 .nogit/
-node_modules/
+
-dist/
+# 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,4 +1,4 @@
-# gitzone standard
+# gitzone ci_default
 image: hosttoday/ht-docker-node:npmci
 
 cache:
@@ -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
@@ -109,10 +101,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   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

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+ignore: {}
+patch: {}

license

@@ -0,0 +1,19 @@
+Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.28",
+  "version": "1.0.49",
   "private": false,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",
@@ -9,15 +9,16 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
+    "testManual": "(tsrun test/test.ts)",
     "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tstest": "^1.0.20",
+    "@gitzone/tstest": "^1.0.24",
     "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^11.13.4",
+    "@types/node": "^12.0.6",
-    "tslint": "^5.15.0",
+    "tslint": "^5.17.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "peerDependencies": {
@@ -26,13 +27,24 @@
   "dependencies": {
     "@pushrocks/lik": "^3.0.5",
     "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smartexpress": "^3.0.18",
+    "@pushrocks/smartexpress": "^3.0.21",
     "@pushrocks/smartfile": "^7.0.2",
     "@pushrocks/smarthash": "^2.0.4",
     "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartrequest": "^1.1.14",
+    "@pushrocks/smartrequest": "^1.1.15",
     "@pushrocks/smartrx": "^2.0.3",
-    "@pushrocks/smartsocket": "^1.1.27",
+    "@pushrocks/smartsocket": "^1.1.37",
-    "@pushrocks/smarttime": "^3.0.7"
+    "@pushrocks/smarttime": "^3.0.7",
-  }
+    "@pushrocks/smartunique": "^3.0.1"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -20,6 +20,33 @@ messaging service for micro services
 
 Use TypeScript for best in class instellisense.
 
+### What is smartuniverse all about?
+
+Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in **private, shielded channels** without having to expose anything to the outside world. This allows the use of **reactive programming across your entire stack**.
+
+### Server side
+
+every universe has a server that manages messages.  
+Think Kafka, but without Kafka.
+
+```typescript
+import * as smartuniverse from '@pushrocks/smartuniverse';
+
+const myUniverse = new smartuniverse.Universe({
+  messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
+});
+
+// create as many channels as you like
+myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
+myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
+
+myUniverse.start(8765); // start the server and provide the port on which to listen on
+```
+
+### Client side
+
+All your microservices represents clients in the universe that may talk to each other using the universe server.
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -5,9 +5,19 @@ import * as smartuniverse from '../ts/index';
 import { Observable } from 'rxjs';
 
 let testUniverse: smartuniverse.Universe;
-let testUniverseClient: smartuniverse.ClientUniverse;
+let testClientUniverse: smartuniverse.ClientUniverse;
+let testClientUniverse2: smartuniverse.ClientUniverse;
 let testClientChannel: smartuniverse.ClientUniverseChannel;
 
+const testServerData = {
+  serverAddress: 'http://localhost:8765'
+};
+
+const testChannelData = {
+  channelName: 'awesomeTestChannel',
+  channelPass: 'awesomeChannelPAss'
+};
+
 tap.test('first test', async () => {
   testUniverse = new smartuniverse.Universe({
     messageExpiryInMilliseconds: 1000
@@ -15,36 +25,53 @@ tap.test('first test', async () => {
 });
 
 tap.test('add a message to the SmartUniverse', async () => {
-  await testUniverse.initServer(8765);
+  await testUniverse.start(8765);
 });
 
 // testing message handling
 tap.test('create smartuniverse client', async () => {
-  testUniverseClient = new smartuniverse.ClientUniverse({
+  testClientUniverse = new smartuniverse.ClientUniverse({
-    serverAddress: 'http://localhost:8765'
+    serverAddress: testServerData.serverAddress
   });
-  expect(testUniverseClient).to.be.instanceof(smartuniverse.ClientUniverse);
+  expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
 });
 
 tap.test('should add a channel to the universe', async () => {
-  await testUniverse.addChannel('testChannel', 'testPassword');
+  await testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
+});
+
+tap.test('should add the same channel to the client universe in the same way', async () => {
+  await testClientUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
 });
 
 tap.test('should get a observable correctly', async () => {
-  testClientChannel = await testUniverseClient.getChannel('testChannel');
+  testClientChannel = await testClientUniverse.getChannel(testChannelData.channelName);
   expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
 });
 
 tap.test('should send a message correctly', async () => {
-  await testUniverseClient.sendMessage('greeting', {
+  await testClientUniverse.sendMessage({
-    anyBool: true
+    messageText: 'hello',
+    targetChannelName: testChannelData.channelName
   });
 });
 
+tap.test('universe should contain the sent message', async () => {
+  expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
+});
+
+tap.test('a second client should be able to subscibe', async () => {
+  testClientUniverse2 = new smartuniverse.ClientUniverse({
+    serverAddress: testServerData.serverAddress
+  });
+
+  testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
+});
+
 tap.test('should receive a message correctly', async () => {});
 
 tap.test('should disconnect the client correctly', async () => {
-  testUniverseClient.close();
+  testClientUniverse.close();
 });
 
 tap.test('should end the server correctly', async tools => {

ts/index.ts

@@ -7,4 +7,5 @@ export * from './smartuniverse.classes.universe';
 export * from './smartuniverse.classes.universecache';
 export * from './smartuniverse.classes.universechannel';
 export * from './smartuniverse.classes.universemessage';
-export * from './smartuniverse.interfaces';
+
+export * from './interfaces';

ts/interfaces/http.interfaces.ts

@@ -0,0 +1,15 @@
+export interface IServerGetMessagesRequestBody {
+  channel: string;
+  topic?: string;
+  youngerThan: number;
+}
+
+/**
+ * the interface for a standard request
+ */
+export interface IServerPutMessageRequestBody {
+  channel: string;
+  passphrase: string;
+  message: string;
+  payload: any;
+}

ts/interfaces/index.ts

@@ -0,0 +1,4 @@
+export * from './http.interfaces';
+export * from './universechannel.interfaces';
+export * from './universemessage.interfaces';
+export * from './universeactions.interfaces';

ts/interfaces/universeactions.interfaces.ts

@@ -0,0 +1,13 @@
+export type IServerCallActions = 'subscribe' | 'sendmessage' | 'unsubscribe';
+
+/**
+ * the interface for a subscription
+ */
+export interface IServerCallSubscribeActionPayload {
+  name: string;
+  passphrase: string;
+}
+
+export interface IServerUnsubscribeActionPayload {
+  name: string;
+}

ts/interfaces/universechannel.interfaces.ts

@@ -0,0 +1 @@
+export interface IUniverseChannel {}

ts/interfaces/universemessage.interfaces.ts

@@ -0,0 +1,15 @@
+export interface IMessageCreator {
+  messageText: string;
+  payload?: string | number | any;
+  payloadStringType?: 'Buffer' | 'string' | 'object';
+  targetChannelName: string;
+}
+
+export interface IUniverseMessage extends IMessageCreator {
+  id: string;
+  /**
+   * time of creation
+   */
+  timestamp: number;
+  passphrase: string;
+}

ts/smartuniverse.classes.clientuniverse.ts

@@ -5,12 +5,10 @@ import { Observable } from 'rxjs';
 import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
 import * as url from 'url';
 
-import {
+import * as interfaces from './interfaces';
-  ClientUniverseChannel,
+
-  IServerGetMessagesRequestBody,
+import { ClientUniverseChannel, UniverseMessage } from './';
-  IServerPutMessageRequestBody,
+import { ClientUniverseCache } from './smartuniverse.classes.clientuniversecache';
-  UniverseMessage
-} from './';
 
 export interface IClientOptions {
   serverAddress: string;
@@ -22,52 +20,108 @@ export interface IClientOptions {
  */
 export class ClientUniverse {
   public options;
-  public socketClient: plugins.smartsocket.SmartsocketClient;
+  public smartsocketClient: plugins.smartsocket.SmartsocketClient;
   public observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
 
-  public channelCache = new Objectmap<ClientUniverseChannel>();
+  public channelStore = new Objectmap<ClientUniverseChannel>();
+  public clientUniverseCache = new ClientUniverseCache();
 
   constructor(optionsArg: IClientOptions) {
     this.options = optionsArg;
   }
 
-  public async sendMessage(messageArg, payloadArg) {
+  /**
-    const requestBody = {
+   * adds a channel to the channelcache
-      message: messageArg,
+   * TODO: verify channel before adding it to the channel cache
-      payload: payloadArg
+   */
-    };
+  public async addChannel(channelNameArg: string, passphraseArg: string) {
-    // TODO: User websocket connection if available
+    const existingChannel = await this.getChannel(channelNameArg);
-    await plugins.smartrequest.postJson(this.options.serverAddress, {
+
-      requestBody
+    if (existingChannel) {
-    });
+      throw new Error('channel exists');
+    }
+
+    // lets create the channel
+    ClientUniverseChannel.createClientUniverseChannel(this, channelNameArg, passphraseArg);
   }
 
+  /**
+   * gets a channel from the channelcache
+   * @param channelName
+   * @param passphraseArg
+   */
   public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
     await this.checkConnection();
-    const clientUniverseChannel = await ClientUniverseChannel.createClientUniverseChannel(
+    const clientUniverseChannel = this.channelStore.find(channel => {
-      this,
+      return channel.name === channelName;
-      channelName
+    });
-    );
-    this.channelCache.add(clientUniverseChannel);
     return clientUniverseChannel;
   }
 
-  public close() {
+  /**
-    this.socketClient.disconnect();
+   * remove a a achannel
+   * @param messageArg
+   */
+  public removeChannel(channelNameArg, notifyServer = true) {
+    const clientUniverseChannel = this.channelStore.findOneAndRemove(channelItemArg => {
+      return channelItemArg.name === channelNameArg;
+    });
   }
 
-  private async checkConnection() {
+  /**
-    if (!this.socketClient && !this.observableIntake) {
+   * sends a message towards the server
+   * @param messageArg
+   */
+  public async sendMessage(messageArg: interfaces.IMessageCreator) {
+    await this.checkConnection();
+    const requestBody: interfaces.IUniverseMessage = {
+      id: plugins.smartunique.shortId(),
+      timestamp: Date.now(),
+      passphrase: (await this.getChannel(messageArg.targetChannelName)).passphrase,
+      ...messageArg
+    };
+    // TODO: User websocket connection if available
+  }
+
+  public close() {
+    this.smartsocketClient.disconnect();
+  }
+
+  /**
+   * checks the connection towards a universe server
+   * since password validation is done through other means, a connection should always be possible
+   */
+  private async checkConnection(): Promise<void> {
+    if (!this.smartsocketClient && !this.observableIntake) {
       const parsedURL = url.parse(this.options.serverAddress);
-      this.socketClient = new SmartsocketClient({
+      const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
         alias: process.env.SOCKET_ALIAS || 'someclient',
         password: 'UniverseClient',
         port: parseInt(parsedURL.port, 10),
         role: 'UniverseClient',
-        url: parsedURL.hostname
+        url: parsedURL.protocol + '//' + parsedURL.hostname
-      });
+      };
+      console.log(socketConfig);
+      this.smartsocketClient = new SmartsocketClient(socketConfig);
       this.observableIntake = new plugins.smartrx.ObservableIntake();
-      this.socketClient.connect();
+
+      // lets define some basic actions
+
+      /**
+       * should handle a forced unsubscription by the server
+       */
+      const unsubscribe = new plugins.smartsocket.SocketFunction({
+        funcName: 'unsubscribe',
+        allowedRoles: [],
+        funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {}
+      });
+
+      /**
+       * should handle a message reception
+       */
+      const receiveMessage = async () => {};
+
+      await this.smartsocketClient.connect();
     }
   }
 }

ts/smartuniverse.classes.clientuniversecache.ts

@@ -0,0 +1,8 @@
+import * as plugins from './smartuniverse.plugins';
+
+/**
+ * a cache for clients
+ * keeps track of which messages have already been received
+ * good for deduplication in mesh environments
+ */
+export class ClientUniverseCache {}

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -1,17 +1,30 @@
 import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
 
-import { ClientUniverse, IUniverseChannel } from './';
+import { ClientUniverse } from './';
 
-export class ClientUniverseChannel implements IUniverseChannel {
+export class ClientUniverseChannel implements interfaces.IUniverseChannel {
   // ======
   // STATIC
   // ======
+  /**
+   * creates a channel and adds it to the cache of clientUniverseArg
+   * @param clientUniverseArg
+   * @param channelNameArg
+   * @param passphraseArg
+   */
   public static async createClientUniverseChannel(
     clientUniverseArg: ClientUniverse,
-    channelName: string
+    channelNameArg: string,
+    passphraseArg: string
   ): Promise<ClientUniverseChannel> {
-    const clientChannel = new ClientUniverseChannel(clientUniverseArg);
+    const clientChannel = new ClientUniverseChannel(
-    await clientChannel.transmitSubscription();
+      clientUniverseArg,
+      channelNameArg,
+      passphraseArg
+    );
+    clientUniverseArg.channelStore.add(clientChannel);
+    await clientChannel.subscribe();
     return clientChannel;
   }
 
@@ -19,16 +32,29 @@ export class ClientUniverseChannel implements IUniverseChannel {
   // INSTANCE
   // ========
 
+  // properties
+  public name: string;
+  public passphrase: string;
+
+  // refs
   public clientUniverse: ClientUniverse;
 
-  constructor(clientUniverseArg: ClientUniverse) {
+  constructor(clientUniverseArg: ClientUniverse, nameArg: string, passphraseArg: string) {
     this.clientUniverse = clientUniverseArg;
+    this.name = nameArg;
+    this.passphrase = passphraseArg;
   }
 
   /**
+   * subscribes to a channel
    * tells the universe about this instances interest into a channel
    */
-  public async transmitSubscription() {
+  public async subscribe() {
-    this.clientUniverse.socketClient;
+    const serverCallActionName: interfaces.IServerCallActions = 'subscribe';
+    const serverCallActionPayload: interfaces.IServerCallSubscribeActionPayload = {
+      name: this.name,
+      passphrase: this.passphrase
+    };
+    this.clientUniverse.smartsocketClient.serverCall(serverCallActionName, serverCallActionPayload);
   }
 }

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -1,15 +1,34 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { IUniverseMessage } from './';
+import * as interfaces from './interfaces';
+import { IUniverseMessage } from './interfaces';
 
-export class ClientUniverseMessage implements IUniverseMessage {
+export class ClientUniverseMessage implements interfaces.IUniverseMessage {
   // ======
   // STATIC
   // ======
-  createMessage(messageArg: string, payloadArg: any) {}
+  public static createMessageFromPayload(messageDescriptor: interfaces.IUniverseMessage) {}
 
   // ========
   // INSTANCE
   // ========
-  constructor(messageArg, payloadArg) {}
+
+  // properties
+  public id: string;
+
+  public timestamp: number;
+  public smartTimestamp: plugins.smarttime.TimeStamp;
+  public messageText: string;
+  public passphrase: string;
+  public payload: any;
+  public payloadStringType;
+  public targetChannelName: string;
+
+  constructor(messageArg: IUniverseMessage, payloadArg) {
+    for (const key of Object.keys(messageArg)) {
+      this[key] = messageArg[key];
+    }
+  }
+
+  getAsJsonForPayload() {}
 }

ts/smartuniverse.classes.universe.ts

@@ -5,39 +5,51 @@ import { UniverseCache, UniverseChannel, UniverseMessage } from './';
 
 import * as paths from './smartuniverse.paths';
 
+import * as interfaces from './interfaces';
+import { UniverseConnectionManager } from './smartuniverse.classes.universeconnectionmanager';
+import { UniverseConnection } from './smartuniverse.classes.universeconnection';
+
 export interface ISmartUniverseConstructorOptions {
   messageExpiryInMilliseconds: number;
 }
 
-export interface IServerGetMessagesRequestBody {
-  channel: string;
-  topic?: string;
-  youngerThan: number;
-}
-
-/**
- * the interface for a standard request
- */
-export interface IServerPutMessageRequestBody {
-  channel: string;
-  passphrase: string;
-  message: string;
-  payload: any;
-}
-
 /**
  * main class that setsup a Universe
  */
 export class Universe {
   // subinstances
   public universeCache: UniverseCache;
+  public universeConnectionManager: UniverseConnectionManager;
 
   // options
   private options: ISmartUniverseConstructorOptions;
 
-  // Store version handling
+  /**
+   * the smartexpress server used
+   */
+  private smartexpressServer: plugins.smartexpress.Server;
+
+  /**
+   * the smartsocket used
+   */
+  private smartsocket: plugins.smartsocket.Smartsocket;
+
+  constructor(optionsArg: ISmartUniverseConstructorOptions) {
+    this.options = optionsArg;
+    this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
+    this.universeConnectionManager = new UniverseConnectionManager();
+  }
+
+  /**
+   * stores the version of the universe server running
+   * this is done since the version is exposed through the api and multiple fs actions are avoided this way.
+   */
   private universeVersionStore: string;
-  private get universeVersion() {
+
+  /**
+   * get the currently running version of smartuniverse
+   */
+  public getUniverseVersion() {
     if (this.universeVersionStore) {
       return this.universeVersionStore;
     } else {
@@ -47,60 +59,65 @@ export class Universe {
     }
   }
 
-  private smartexpressServer: plugins.smartexpress.Server;
-  private smartsocket: plugins.smartsocket.Smartsocket;
-
-  constructor(optionsArg: ISmartUniverseConstructorOptions) {
-    this.options = optionsArg;
-    this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
-  }
-
   /**
    * adds a channel to the Universe
    */
   public async addChannel(nameArg: string, passphraseArg: string) {
-    const newChannel = new UniverseChannel(this.universeCache, nameArg, passphraseArg);
+    const newChannel = UniverseChannel.createChannel(this.universeCache, nameArg, passphraseArg);
-    this.universeCache.channelMap.add(newChannel);
   }
 
   /**
    * initiates a server
    */
-  public async initServer(portArg: number | string) {
+  public async start(portArg: number) {
+    // lets create the base smartexpress server
     this.smartexpressServer = new plugins.smartexpress.Server({
       cors: true,
       defaultAnswer: async () => {
-        return `smartuniverse server ${this.universeVersion}`;
+        return `smartuniverse server ${this.getUniverseVersion()}`;
       },
       forceSsl: false,
       port: portArg
     });
 
     // add websocket upgrade
-    this.smartsocket = new plugins.smartsocket.Smartsocket({
+    this.smartsocket = new plugins.smartsocket.Smartsocket({});
-      port: 12345 // fix this within smartsocket
-    });
 
+    // add a role for the clients
     const ClientRole = new plugins.smartsocket.SocketRole({
-      name: 'clientuniverse',
+      name: 'UniverseClient',
-      passwordHash: 'clientuniverse' // authentication happens on another level
+      passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
     });
 
+    // add the role to smartsocket
     this.smartsocket.addSocketRoles([ClientRole]);
 
     const SubscriptionSocketFunction = new plugins.smartsocket.SocketFunction({
-      allowedRoles: [ClientRole],
+      allowedRoles: [ClientRole], // there is only one client role, Authentication happens on another level
       funcName: 'channelSubscription',
-      funcDef: () => {}
+      funcDef: async (dataArg, socketConnectionArg) => {
+        // run in "this context" of this class
+        (() => {
+          // TODO: properly add the connection
+          const universeConnection = new UniverseConnection({
+            
+          })
+          this.universeConnectionManager.addConnection();
+        })();
+      }
     });
 
-    this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
+    // add smartsocket to the running smartexpress app
-    // should work with express as well
+    this.smartsocket.setExternalServer('smartexpress', this.smartexpressServer as any);
-    this.smartsocket.start();
+    // start everything
-
     await this.smartexpressServer.start();
+    await this.smartsocket.start();
+    console.log('started universe');
   }
 
+  /**
+   * stop everything
+   */
   public async stopServer() {
     await this.smartsocket.stop();
     await this.smartexpressServer.stop();

ts/smartuniverse.classes.universecache.ts

@@ -39,7 +39,7 @@ export class UniverseCache {
   }
 
   /**
-   * add a message to the UniverseStore
+   * add a message to the UniverseCache
    * @param messageArg
    * @param attachedPayloadArg
    */
@@ -50,12 +50,15 @@ export class UniverseCache {
   }
 
   /**
-   * Read a message from the UniverseStore
+   * Read a message from the UniverseCache
    */
-  public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
+  public readMessagesYoungerThan(
+    unixTimeArg?: number,
+    channelName?: string
+  ): Observable<UniverseMessage> {
     const messageObservable = from(this.messageMap.getArray()).pipe(
       filter(messageArg => {
-        return messageArg.timestamp.isYoungerThanMilliSeconds(this.destructionTime);
+        return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
       })
     );
     return messageObservable;

ts/smartuniverse.classes.universechannel.ts

@@ -23,6 +23,7 @@ export class UniverseChannel {
     passphraseArg: string
   ) {
     const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
+    universeCacheArg.channelMap.add(newChannel);
     return newChannel;
   }
 
@@ -82,8 +83,8 @@ export class UniverseChannel {
    */
   public authenticate(universeMessageArg: UniverseMessage): boolean {
     return (
-      this.name === universeMessageArg.requestedChannelName &&
+      this.name === universeMessageArg.targetChannelName &&
-      this.passphrase === universeMessageArg.requestedChannelPassphrase
+      this.passphrase === universeMessageArg.passphrase
     );
   }
 

ts/smartuniverse.classes.universeconnection.ts

@@ -0,0 +1,26 @@
+import * as plugins from './smartuniverse.plugins';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+
+/**
+ * represents a connection to the universe
+ */
+export class UniverseConnection {
+  /**
+   * the socketClient to ping
+   */
+  public socketConnection: plugins.smartsocket.SocketConnection;
+  public authenticationRequests = []
+  public subscribedChannels: UniverseChannel[] = [];
+  public authenticatedChannels: UniverseChannel[] = [];
+  public failedToJoinChannels: UniverseChannel[] = [];
+
+  public terminateConnection () {
+    this.socketConnection
+  }
+
+  constructor(optionsArg: {
+    socketConnection: plugins.smartsocket.SocketConnection;
+  }) {
+    this.socketConnection,
+  }
+}

ts/smartuniverse.classes.universeconnectionmanager.ts

@@ -0,0 +1,11 @@
+import * as plugins from './smartuniverse.plugins';
+import { UniverseConnection } from './smartuniverse.classes.universeconnection';
+
+/**
+ * manages connections to a universe
+ */
+export class UniverseConnectionManager {
+  public connectionMap = new plugins.lik.Objectmap<UniverseConnection>();
+
+  public addConnection() {}
+}

ts/smartuniverse.classes.universemessage.ts

@@ -1,4 +1,5 @@
 import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
 
 import { Objectmap } from '@pushrocks/lik';
 
@@ -6,31 +7,29 @@ import { Timer, TimeStamp } from '@pushrocks/smarttime';
 import { Universe } from './smartuniverse.classes.universe';
 import { UniverseChannel } from './smartuniverse.classes.universechannel';
 import { UniverseCache } from './smartuniverse.classes.universecache';
+import { IUniverseMessage } from './interfaces';
 
 /**
  * represents a message within a universe
  * acts as a container to save message states like authentication status
  */
-export class UniverseMessage {
+export class UniverseMessage implements interfaces.IUniverseMessage {
-  /**
+  public id: string;
-   * public and unique id
+
-   * numeric ascending
+  public timestamp: number;
-   * adheres to time in milliseconds
+  public smartTimestamp: TimeStamp;
-   * avoids duplications though
+
-   */
+  public messageText: string;
-  public id: number;
+  public passphrase: string;
+  public payload: any;
+  public payloadStringType;
+  public targetChannelName: string;
 
   /**
    * the UniverseCache the message is attached to
    */
   public universeCache: UniverseCache;
 
-  /**
-   * requestedChannelName
-   */
-  public requestedChannelName: string;
-  public requestedChannelPassphrase: string;
-
   /**
    * enables unprotected grouping of messages for efficiency purposes.
    */
@@ -42,19 +41,8 @@ export class UniverseMessage {
   public authenticated: boolean = null;
 
   /**
-   * time of creation
+   * a destruction timer for this message
    */
-  public timestamp: TimeStamp;
-
-  /**
-   * the actual message
-   */
-  public message: string;
-
-  /**
-   * any attached payloads. Can be of binary format.
-   */
-  public attachedPayload: any;
   public destructionTimer: Timer; // a timer to take care of message destruction
 
   /**
@@ -62,17 +50,12 @@ export class UniverseMessage {
    * @param messageArg
    * @param attachedPayloadArg
    */
-  constructor(
+  constructor(messageDescriptor: IUniverseMessage) {
-    messageArg: string,
+    this.smartTimestamp = new TimeStamp(this.timestamp);
-    requestedChannelNameArg: string,
+    this.messageText = messageDescriptor.messageText;
-    passphraseArg: string,
+    this.targetChannelName = messageDescriptor.targetChannelName;
-    attachedPayloadArg: any
+    this.passphrase = messageDescriptor.passphrase;
-  ) {
+    this.payload = messageDescriptor.payload;
-    this.timestamp = new TimeStamp();
-    this.message = messageArg;
-    this.requestedChannelName = requestedChannelNameArg;
-    this.requestedChannelPassphrase = passphraseArg;
-    this.attachedPayload = attachedPayloadArg;
     // prevent memory issues
     this.fallBackDestruction();
   }
@@ -98,7 +81,7 @@ export class UniverseMessage {
   /**
    * handles bad messages for further analysis
    */
-  handleAsBadMessage() {
+  public handleAsBadMessage() {
     console.log('received a bad message');
   }
 

ts/smartuniverse.interfaces.ts

@@ -1,3 +0,0 @@
-export interface IUniverseChannel {}
-
-export interface IUniverseMessage {}

ts/smartuniverse.plugins.ts

@@ -14,6 +14,7 @@ import * as smartrequest from '@pushrocks/smartrequest';
 import * as smartrx from '@pushrocks/smartrx';
 import * as smartsocket from '@pushrocks/smartsocket';
 import * as smarttime from '@pushrocks/smarttime';
+import * as smartunique from '@pushrocks/smartunique';
 
 export {
   lik,
@@ -25,5 +26,6 @@ export {
   smartrx,
   smartrequest,
   smartsocket,
-  smarttime
+  smarttime,
+  smartunique
 };