1.0.7

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/sdk",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "private": false,
   "description": "an sdk package for api.global",
   "main": "dist_ts/index.js",
@@ -8,21 +8,20 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)",
-    "format": "(gitzone format)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tstest": "^1.0.33",
     "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^13.9.3",
-    "tslint": "^6.1.0",
+    "@types/node": "^14.0.14",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@apiglobal/typedrequest": "^1.0.28",
-    "@tsclass/tsclass": "^3.0.16"
+    "@apiglobal/typedrequest": "^1.0.38",
+    "@tsclass/tsclass": "^3.0.18"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -8,13 +8,20 @@ an sdk package for api.global
 * [docs (typedoc)](https://apiglobal.gitlab.io/sdk/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/apiglobal/sdk/badges/master/pipeline.svg)](https://gitlab.com/apiglobal/sdk/commits/master)
-[![coverage report](https://gitlab.com/apiglobal/sdk/badges/master/coverage.svg)](https://gitlab.com/apiglobal/sdk/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@apiglobal/sdk.svg)](https://www.npmjs.com/package/@apiglobal/sdk)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@apiglobal/sdk/badge.svg)](https://snyk.io/test/npm/@apiglobal/sdk)
-[![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/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/apiglobal/sdk/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/apiglobal/sdk/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiglobal/sdk)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/apiglobal/sdk)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@apiglobal/sdk)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiglobal/sdk)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiglobal/sdk)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 

test/test.ts

@@ -10,6 +10,16 @@ tap.test('should create a valid Handler', async () => {
       let response: any;
       return response;
     }
+    public async checkReqirements() {
+      return {
+        allOk: true,
+        reason: '',
+      };
+    }
+
+    public async start() {}
+
+    public async stop() {}
   }
 
   const myHandlerInstance = new MyHandler();

ts/interfaces/index.ts

@@ -1 +1 @@
-export {};
+export {};

ts/sdk.classes.aghandler.ts

@@ -1,14 +1,26 @@
 import * as plugins from './sdk.plugins';
 import { AuthInfo } from './sdk.classes.authinfo';
 
+export interface IRequirementResult {
+  allOk: boolean;
+  reason: string;
+}
+
 export abstract class AAgHandler<TClaim> {
   /**
    * a slug that separates the handler from other handlers
    */
   public abstract slug: string;
 
-  public abstract handleRequest (authInfoArg: AuthInfo<TClaim>, request: plugins.tsclass.network.ISimpleRequest): Promise<plugins.tsclass.network.ISimpleResponse>;
+  public abstract handleRequest(
+    authInfoArg: AuthInfo<TClaim>,
+    request: plugins.tsclass.network.ISimpleRequest
+  ): Promise<plugins.tsclass.network.ISimpleResponse>;
+  public abstract checkReqirements(): Promise<IRequirementResult>;
 
+  /**
+   * start the ag-handler
+   */
   public abstract start(): Promise<any>;
   public abstract stop(): Promise<any>;
-}
+}