1.0.30

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,21 +37,11 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +53,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -117,8 +109,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
     - notpriv
@@ -128,3 +122,4 @@ pages:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

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.

npmextra.json

@@ -1,9 +1,17 @@
 {
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartuniverse",
+      "shortDescription": "messaging service for micro services",
+      "npmPackagename": "@pushrocks/smartuniverse",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts",
-      "ts-node"
-    ],
+    "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.24",
-  "private": true,
+  "version": "1.0.30",
+  "private": false,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -9,26 +9,30 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(npmts)",
+    "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.19"
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tstest": "^1.0.20",
+    "@pushrocks/tapbundle": "^3.0.9",
+    "@types/node": "^11.13.4",
+    "tslint": "^5.15.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "peerDependencies": {
     "rxjs": "*"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
-    "@pushrocks/smartdelay": "^2.0.2",
-    "@pushrocks/smartexpress": "^3.0.10",
-    "@pushrocks/smartfile": "^6.0.12",
+    "@pushrocks/lik": "^3.0.5",
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartexpress": "^3.0.18",
+    "@pushrocks/smartfile": "^7.0.2",
     "@pushrocks/smarthash": "^2.0.4",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/smartrequest": "^1.0.8",
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartrequest": "^1.1.14",
     "@pushrocks/smartrx": "^2.0.3",
-    "@pushrocks/smartsocket": "^1.1.24",
-    "@pushrocks/smarttime": "^3.0.5"
+    "@pushrocks/smartsocket": "^1.1.27",
+    "@pushrocks/smarttime": "^3.0.7"
   }
 }

readme.md

@@ -1,33 +1,28 @@
-# smartuniverse
+# @pushrocks/smartuniverse
+messaging service for micro services
 
-messaging service for your micro services
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartuniverse)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartuniverse)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartuniverse/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
+* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
 
 ## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://GitLab.com/pushrocks/smartuniverse/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartuniverse/commits/master)
+[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartuniverse/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartuniverse/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartuniverse/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartuniverse)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
 Use TypeScript for best in class instellisense.
 
-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.
 
-> licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,5 +1,5 @@
 // tslint:disable-next-line:no-implicit-dependencies
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartuniverse from '../ts/index';
 
 import { Observable } from 'rxjs';

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,3 @@
+export * from './http.interfaces';
+export * from './universechannel.interfaces';
+export * from './universemessage.interfaces';

ts/interfaces/universechannel.interfaces.ts

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

ts/interfaces/universemessage.interfaces.ts

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

ts/smartuniverse.classes.clientuniverse.ts

@@ -1,14 +1,14 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 import { Observable } from 'rxjs';
-import { Smartsocket, SmartsocketClient } from 'smartsocket';
+import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
 import * as url from 'url';
 
+import * as interfaces from './interfaces';
+
 import {
   ClientUniverseChannel,
-  IServerGetMessagesRequestBody,
-  IServerPutMessageRequestBody,
   UniverseMessage
 } from './';
 
@@ -37,7 +37,7 @@ export class ClientUniverse {
       payload: payloadArg
     };
     // TODO: User websocket connection if available
-    await plugins.smartrequest.post(this.options.serverAddress, {
+    await plugins.smartrequest.postJson(this.options.serverAddress, {
       requestBody
     });
   }

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -1,8 +1,9 @@
 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
   // ======

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -1,15 +1,21 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { IUniverseMessage } from './';
+import * as interfaces from './interfaces';
 
-export class ClientUniverseMessage implements IUniverseMessage {
+export class ClientUniverseMessage implements interfaces.IUniverseMessage {
   // ======
   // STATIC
   // ======
-  createMessage(messageArg: string, payloadArg: any) {}
+  public static createMessageFromPayload(messageArg: string, payloadArg: any) {
+
+  };
 
   // ========
   // INSTANCE
   // ========
   constructor(messageArg, payloadArg) {}
+
+  getAsJsonForPayload () {
+
+  }
 }

ts/smartuniverse.classes.universe.ts

@@ -1,29 +1,17 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Handler, Route, Server } from 'smartexpress';
+import { Handler, Route, Server } from '@pushrocks/smartexpress';
 import { UniverseCache, UniverseChannel, UniverseMessage } from './';
 
 import * as paths from './smartuniverse.paths';
 
+import * as interfaces from './interfaces';
+
 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
@@ -35,9 +23,16 @@ export class Universe {
   // options
   private options: ISmartUniverseConstructorOptions;
 
-  // Store version handling
+  /**
+   * 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 get universeVersion() {
     if (this.universeVersionStore) {
       return this.universeVersionStore;
     } else {
@@ -47,7 +42,14 @@ export class Universe {
     }
   }
 
+  /**
+   * the smartexpress server used
+   */
   private smartexpressServer: plugins.smartexpress.Server;
+
+  /**
+   * the smartsocket used
+   */
   private smartsocket: plugins.smartsocket.Smartsocket;
 
   constructor(optionsArg: ISmartUniverseConstructorOptions) {
@@ -59,46 +61,61 @@ export class Universe {
    * adds a channel to the Universe
    */
   public async addChannel(nameArg: string, passphraseArg: string) {
-    const newChannel = new UniverseChannel(this.universeCache, nameArg, passphraseArg);
-    this.universeCache.channelMap.add(newChannel);
+    const newChannel = UniverseChannel.createChannel(this.universeCache, nameArg, passphraseArg);
   }
 
   /**
    * initiates a server
    */
   public async initServer(portArg: number | string) {
+    // lets create the base smartexpress server
     this.smartexpressServer = new plugins.smartexpress.Server({
       cors: true,
-      defaultAnswer: `smartuniverse server ${this.universeVersion}`,
+      defaultAnswer: async () => {
+        return `smartuniverse server ${this.universeVersion}`;
+      },
       forceSsl: false,
       port: portArg
     });
 
+    // lets create the http request route
+    this.smartexpressServer.addRoute('/sendmessage', new Handler('POST', async (req, res) => {
+      this.universeCache.addMessage(req.body);
+    }));
+
     // add websocket upgrade
     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',
       passwordHash: 'clientuniverse' // authentication happens on another level
     });
 
+    // add the role to smartsocket
     this.smartsocket.addSocketRoles([ClientRole]);
 
     const SubscriptionSocketFunction = new plugins.smartsocket.SocketFunction({
       allowedRoles: [ClientRole],
       funcName: 'channelSubscription',
-      funcDef: () => {}
+      funcDef: () => {} // TODO: implement an action upon connection of clients
     });
 
+    // add smartsocket to the running smartexpress app
     this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
-    // should work with express as well
+
+    // start the socket
     this.smartsocket.start();
 
+    // start the smartexpress instance
     await this.smartexpressServer.start();
   }
 
+  /**
+   * stop everything
+   */
   public async stopServer() {
     await this.smartsocket.stop();
     await this.smartexpressServer.stop();

ts/smartuniverse.classes.universecache.ts

@@ -3,10 +3,11 @@ import * as plugins from './smartuniverse.plugins';
 import { UniverseChannel } from './smartuniverse.classes.universechannel';
 import { UniverseMessage } from './smartuniverse.classes.universemessage';
 
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 
-import { Observable } from 'rxjs';
-import { rxjs } from 'smartrx';
+import { Observable, from } from 'rxjs';
+import { filter } from 'rxjs/operators';
+import { rxjs } from '@pushrocks/smartrx';
 
 /**
  * universe store handles the creation, storage and retrieval of messages.
@@ -38,7 +39,7 @@ export class UniverseCache {
   }
 
   /**
-   * add a message to the UniverseStore
+   * add a message to the UniverseCache
    * @param messageArg
    * @param attachedPayloadArg
    */
@@ -49,13 +50,13 @@ export class UniverseCache {
   }
 
   /**
-   * Read a message from the UniverseStore
+   * Read a message from the UniverseCache
    */
   public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
-    const messageObservable = rxjs.Observable.from(this.messageMap.getArray()).filter(
-      messageArg => {
+    const messageObservable = from(this.messageMap.getArray()).pipe(
+      filter(messageArg => {
         return messageArg.timestamp.isYoungerThanMilliSeconds(this.destructionTime);
-      }
+      })
     );
     return messageObservable;
   }

ts/smartuniverse.classes.universechannel.ts

@@ -1,6 +1,6 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 import { UniverseCache } from './smartuniverse.classes.universecache';
 import { UniverseMessage } from './smartuniverse.classes.universemessage';
 
@@ -23,6 +23,7 @@ export class UniverseChannel {
     passphraseArg: string
   ) {
     const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
+    universeCacheArg.channelMap.add(newChannel);
     return newChannel;
   }
 

ts/smartuniverse.classes.universemessage.ts

@@ -1,8 +1,8 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 
-import { Timer, TimeStamp } from 'smarttime';
+import { Timer, TimeStamp } from '@pushrocks/smarttime';
 import { Universe } from './smartuniverse.classes.universe';
 import { UniverseChannel } from './smartuniverse.classes.universechannel';
 import { UniverseCache } from './smartuniverse.classes.universecache';

ts/smartuniverse.interfaces.ts

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

ts/smartuniverse.plugins.ts

@@ -1,23 +1,27 @@
-import * as lik from 'lik';
-import * as nodehash from 'nodehash';
+// node native
 import * as path from 'path';
-import * as smartdelay from 'smartdelay';
-import * as smartexpress from 'smartexpress';
-import * as smartfile from 'smartfile';
-import * as smartq from 'smartq';
-import * as smartrequest from 'smartrequest';
-import * as smartrx from 'smartrx';
-import * as smartsocket from 'smartsocket';
-import * as smarttime from 'smarttime';
+
+export { path };
+
+// pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smarthash from '@pushrocks/smarthash';
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartrx from '@pushrocks/smartrx';
+import * as smartsocket from '@pushrocks/smartsocket';
+import * as smarttime from '@pushrocks/smarttime';
 
 export {
   lik,
-  nodehash,
-  path,
+  smarthash,
   smartdelay,
   smartexpress,
   smartfile,
-  smartq,
+  smartpromise,
   smartrx,
   smartrequest,
   smartsocket,

tslint.json

@@ -1,6 +1,17 @@
 {
   "extends": ["tslint:latest", "tslint-config-prettier"],
   "rules": {
-    "semicolon": [true, "always"]
-  }
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }