3.0.4

.gitignore

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

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -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,38 +37,29 @@ 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 node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
   - notpriv
 
 release:
@@ -86,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/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -114,12 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv
@@ -130,13 +117,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

.vscode/launch.json

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

npmextra.json

@@ -2,5 +2,15 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "mojoio",
+      "gitrepo": "slack",
+      "shortDescription": "slack api abstraction for the mojo.io ecosystem",
+      "npmPackagename": "@mojoio/slack",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@mojoio/slack",
-  "version": "2.0.5",
+  "version": "3.0.4",
   "private": false,
-  "description": "API abstraction for mojoio",
+  "description": "slack api abstraction for the mojo.io ecosystem",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
@@ -12,14 +12,28 @@
     "build": "tsbuild"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/qenv": "^2.0.2",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.9.4"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/qenv": "^4.0.4",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.4",
+    "tslint": "^5.20.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "smartrequest": "^1.0.6"
-  }
+    "@pushrocks/smartpromise": "^3.0.5",
+    "@pushrocks/smartrequest": "^1.1.23"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

qenv.yml

@@ -1,2 +1,2 @@
-vars:
+required:
   - SLACK_TOKEN

readme.md

@@ -1,26 +1,20 @@
-# slackme
+# @mojoio/slack
+slack api abstraction for the mojo.io ecosystem
 
-API abstraction for mojoio
-
-## Availabililty
-
-[![npm](https://mojoio.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/slackme)
-[![git](https://mojoio.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/mojoio/slackme)
-[![git](https://mojoio.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/mojoio/slackme)
-[![docs](https://mojoio.gitlab.io/assets/repo-button-docs.svg)](https://mojoio.gitlab.io/slackme/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/slack)
+* [gitlab.com (source)](https://gitlab.com/mojoio/slack)
+* [github.com (source mirror)](https://github.com/mojoio/slack)
+* [docs (typedoc)](https://mojoio.gitlab.io/slack/)
 
 ## Status for master
-
-[![build status](https://GitLab.com/mojoio/slackme/badges/master/build.svg)](https://GitLab.com/mojoio/slackme/commits/master)
-[![coverage report](https://GitLab.com/mojoio/slackme/badges/master/coverage.svg)](https://GitLab.com/mojoio/slackme/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/slackme.svg)](https://www.npmjs.com/package/slackme)
-[![Dependency Status](https://david-dm.org/mojoio/slackme.svg)](https://david-dm.org/mojoio/slackme)
-[![bitHound Dependencies](https://www.bithound.io/github/mojoio/slackme/badges/dependencies.svg)](https://www.bithound.io/github/mojoio/slackme/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/mojoio/slackme/badges/code.svg)](https://www.bithound.io/github/mojoio/slackme)
-[![Known Vulnerabilities](https://snyk.io/test/npm/slackme/badge.svg)](https://snyk.io/test/npm/slackme)
-[![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)](https://standardjs.com/)
+[![build status](https://gitlab.com/mojoio/slack/badges/master/build.svg)](https://gitlab.com/mojoio/slack/commits/master)
+[![coverage report](https://gitlab.com/mojoio/slack/badges/master/coverage.svg)](https://gitlab.com/mojoio/slack/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/slack.svg)](https://www.npmjs.com/package/@mojoio/slack)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/slack/badge.svg)](https://snyk.io/test/npm/@mojoio/slack)
+[![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
 
@@ -104,9 +98,9 @@ mySlackMessage.title = 'another Title'
 mySlackMessage.sendToRoom('anotherroom')
 ```
 
-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.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://mojo.io)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -5,38 +5,126 @@ let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
 
 import * as slackme from '../ts/index';
 
-let testSlackme: slackme.Slackme;
+let testSlackAccount: slackme.SlackAccount;
 let testSlackMessage: slackme.SlackMessage;
 
-tap.test('should create a valid slackme instance', async () => {
-  testSlackme = new slackme.Slackme(process.env.SLACK_TOKEN);
+tap.test('should create a valid slackme instance', async tools => {
+  testSlackAccount = new slackme.SlackAccount(testQenv.getEnvVarOnDemand('SLACK_TOKEN'));
 });
 
-tap.test('should send a message to Slack', async () => {
-  testSlackMessage = new slackme.SlackMessage(
-    {
-      author_name: 'GitLab CI',
-      author_link: 'https://gitlab.com/',
-      pretext: '*Good News*: Build successfull!',
-      color: '#3cb371',
-      fields: [
-        {
-          title: 'Branch',
-          value: 'Lossless Cloud',
-          short: true
-        },
-        {
-          title: 'Product ID',
-          value: 'pushrocks',
-          short: true
-        }
-      ],
-      ts: new Date().getTime() / 1000
-    },
-    testSlackme
-  );
-  testSlackme.sendMessage(testSlackMessage.messageOptions, 'random');
-  testSlackMessage.sendToRoom('random');
+tap.test('should send a message to Slack', async tools => {
+  const messageOptions = {
+    author_name: 'GitLab CI',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Cloud',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'pushrocks',
+        short: true
+      }
+    ]
+  };
+  await testSlackAccount.sendMessage({
+    channelArg: 'random',
+    messageOptions: messageOptions,
+    mode: 'new'
+  });
+});
+
+tap.test('should send a message to Slack by directly calling the message', async tools => {
+  testSlackMessage = new slackme.SlackMessage(testSlackAccount, {
+    author_name: 'GitLab CI',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Cloud',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'pushrocks',
+        short: true
+      }
+    ]
+  });
+  await testSlackMessage.sendToRoom('random');
+  await tools.delayFor(1000);
+  await testSlackMessage.updateAndSend({
+    author_name: 'GitLab CI',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Studio',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'pushrocks',
+        short: true
+      }
+    ]
+  });
+  await testSlackMessage.updateAndSend({
+    author_name: 'GitLab CI',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Studio',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'onboard.me',
+        short: true
+      }
+    ]
+  });
+  await testSlackMessage.startThread({
+    author_name: 'Lossless Compliance',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Studio',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'pushrocks',
+        short: true
+      }
+    ]
+  });
+});
+
+tap.test('should send logs', async () => {
+  const slackLog = new slackme.SlackLog({
+    slackAccount: testSlackAccount,
+    channelName: 'random'
+  });
+  for (let i = 0; i < 30; i++) {
+    await slackLog.sendLogLine('hi there');
+    await slackLog.sendLogLine('so awesome');
+    await slackLog.sendLogLine('really');
+  }
 });
 
 tap.start();

ts/index.ts

@@ -1,2 +1,3 @@
-export * from './slack.classes.slackme';
+export * from './slack.classes.slackaccount';
 export * from './slack.classes.slackmessage';
+export * from './slack.classes.slacklog';

ts/slack.classes.slackaccount.ts

@@ -0,0 +1,63 @@
+import * as plugins from './slack.plugins';
+import { IMessageOptions } from './slack.classes.slackmessage';
+
+export class SlackAccount {
+  private postUrl = 'https://slack.com/api/chat.postMessage';
+  private updateUrl = 'https://slack.com/api/chat.update';
+  private slackToken: string;
+  constructor(slackTokenArg: string) {
+    this.slackToken = slackTokenArg;
+  }
+
+  async sendMessage(optionsArg: {
+    messageOptions: IMessageOptions;
+    channelArg: string;
+    ts?: string;
+    mode: 'new' | 'threaded' | 'update';
+  }) {
+    let requestBody: any = {
+      channel: optionsArg.channelArg,
+      text: optionsArg.messageOptions.text
+    };
+
+    if (optionsArg.messageOptions.fields) {
+      requestBody = {
+        ...requestBody,
+        attachments: [
+          {
+            pretext: optionsArg.messageOptions.pretext,
+            fields: optionsArg.messageOptions.fields,
+            ts: optionsArg.messageOptions.ts,
+            color: optionsArg.messageOptions.color
+          }
+        ]
+      };
+    }
+
+    let postUrl = this.postUrl;
+
+    switch (true) {
+      case optionsArg.ts && optionsArg.mode === 'update':
+        requestBody = {
+          ...requestBody,
+          ts: optionsArg.ts
+        };
+        postUrl = this.updateUrl;
+        break;
+      case optionsArg.ts && optionsArg.mode === 'threaded':
+        requestBody = {
+          ...requestBody,
+          thread_ts: optionsArg.ts
+        };
+        break;
+    }
+
+    const response = await plugins.smartrequest.postJson(postUrl, {
+      headers: {
+        Authorization: `Bearer ${this.slackToken}`
+      },
+      requestBody
+    });
+    return response;
+  }
+}

ts/slack.classes.slacklog.ts

@@ -0,0 +1,29 @@
+import { SlackAccount } from './slack.classes.slackaccount';
+import { SlackMessage } from './slack.classes.slackmessage';
+
+export class SlackLog {
+  public slackAccount: SlackAccount;
+  public slackMessage: SlackMessage;
+  public channelName: string;
+
+  public completeLog = ``;
+
+  constructor(optionsArg: { slackAccount: SlackAccount; channelName: string }) {
+    this.slackAccount = optionsArg.slackAccount;
+    this.channelName = optionsArg.channelName;
+  }
+  public async sendLogLine(logText: string) {
+    if (!this.slackMessage) {
+      this.slackMessage = new SlackMessage(this.slackAccount, {
+        text: '``` log is loading... ```'
+      });
+      await this.slackMessage.sendToRoom(this.channelName);
+    }
+    const date = new Date();
+    this.completeLog +=
+      `${date.getHours()}:${date.getMinutes()}:${date.getSeconds()} - ` + logText + '\n';
+    await this.slackMessage.updateAndSend({
+      text: '```\n' + this.completeLog + '\n```'
+    });
+  }
+}

ts/slack.classes.slackme.ts

@@ -1,22 +0,0 @@
-import * as plugins from './slack.plugins';
-import { IMessageOptions } from './slack.classes.slackmessage';
-
-export class Slackme {
-  private baseUrl = 'https://hooks.slack.com/services/';
-  private postRoute: string;
-  constructor(postRouteArg: string) {
-    this.postRoute = postRouteArg;
-  }
-
-  sendMessage(messageOptionsArg: IMessageOptions, channelArg: string = 'general') {
-    plugins.smartrequest.post(`${this.baseUrl}${this.postRoute}`, {
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      requestBody: {
-        channel: channelArg,
-        attachments: [messageOptionsArg]
-      }
-    });
-  }
-}

ts/slack.classes.slackmessage.ts

@@ -1,5 +1,5 @@
 import * as plugins from './slack.plugins';
-import { Slackme } from './slack.classes.slackme';
+import { SlackAccount } from './slack.classes.slackaccount';
 
 export interface IAttachmentField {
   title: string;
@@ -49,24 +49,50 @@ export interface IMessageOptions {
   thumb_url?: string;
   footer?: string;
   footer_icon?: string;
-  /**
-   * timestamp as epoch time
-   */
   ts?: number;
 }
 
 export class SlackMessage {
-  slackmeRef: Slackme;
-  messageOptions: IMessageOptions;
-  constructor(messageOptionsArg: IMessageOptions, slackmeArg?: Slackme) {
-    if (slackmeArg) {
-      this.slackmeRef = slackmeArg;
+  public slackAccountRef: SlackAccount;
+  public messageOptions: IMessageOptions;
+  public channel: string;
+  public ts: string;
+
+  public requestRunning = plugins.smartpromise.defer();
+
+  constructor(slackAccountArg: SlackAccount, messageOptionsArg: IMessageOptions) {
+    if (slackAccountArg) {
+      this.slackAccountRef = slackAccountArg;
     }
     this.messageOptions = messageOptionsArg;
+    this.requestRunning.resolve();
   }
-  sendToRoom(roomNameArg: string) {
-    if (this.slackmeRef) {
-      this.slackmeRef.sendMessage(this.messageOptions, roomNameArg);
+
+  async updateAndSend(messageOptionsArg: IMessageOptions) {
+    this.messageOptions = messageOptionsArg;
+    await this.sendToRoom(this.channel, 'update');
+  }
+
+  async startThread(messageOptionsArg: IMessageOptions) {
+    this.messageOptions = messageOptionsArg;
+    this.sendToRoom(this.channel, 'threaded');
+  }
+
+  async sendToRoom(channelNameArg: string, modeArg: 'new' | 'update' | 'threaded' = 'new') {
+    this.channel = channelNameArg;
+    if (this.slackAccountRef) {
+      const response = await this.slackAccountRef.sendMessage({
+        channelArg: this.channel,
+        messageOptions: this.messageOptions,
+        mode: modeArg,
+        ts: this.ts
+      });
+      if (modeArg === 'new') {
+        this.ts = response.body.message.ts;
+        this.channel = response.body.channel;
+      }
+    } else {
+      throw new Error('you need to set a slackRef before sending the message!');
     }
   }
 }

ts/slack.plugins.ts

@@ -1,3 +1,5 @@
-import * as smartrequest from 'smartrequest';
+// pushrocks scope
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
 
-export { smartrequest };
+export { smartpromise, smartrequest };

tslint.json

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