1.0.11

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/sdk",
-  "version": "1.0.2",
+  "version": "1.0.11",
   "private": false,
   "description": "an sdk package for api.global",
   "main": "dist_ts/index.js",
@@ -8,20 +8,20 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.33",
     "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
+    "@types/node": "^14.0.14",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@tsclass/tsclass": "^3.0.13"
+    "@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)
+Status Category | Status Badge
-[![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)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/apiglobal/sdk/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/apiglobal/sdk/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiglobal/sdk)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+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

@@ -1,8 +1,43 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as sdk from '../ts/index';
+import { ISimpleRequest } from '@tsclass/tsclass/dist_ts/network';
+import { TypedRouter } from '@apiglobal/typedrequest';
 
-tap.test('first test', async () => {
+
-  console.log(sdk.standardExport);
+tap.test('should create a valid Handler', async () => {
+  class MyHandler extends sdk.AAgHandler<any> {
+    public slug: 'testapi';
+    public typedrouter = new TypedRouter();
+
+    public async checkReqirements() {
+      return {
+        allOk: true,
+        reason: '',
+      };
+    }
+
+    public async start() {}
+
+    public async stop() {}
+
+    public async checkRequirements(): Promise<sdk.IRequirementResult> {
+      return {
+        allOk: true,
+        reason: ''
+      }
+    }
+  }
+
+  // tslint:disable-next-line: max-classes-per-file
+  class AgEnvironement extends sdk.AgEnvironment {
+    public async getEnvVar(nameArg: string) {
+      return '';
+    }
+  }
+
+  const myHandlerInstance = new MyHandler(new AgEnvironement());
+
+  expect(myHandlerInstance).to.be.instanceOf(sdk.AAgHandler);
 });
 
 tap.start();

ts/index.ts

@@ -1,3 +1,3 @@
-import * as plugins from './sdk.plugins';
+export * from './sdk.classes.agenvironment';
-
+export * from './sdk.classes.aghandler';
-export let standardExport = 'Hi there! :) This is an exported string';
+export * from './sdk.classes.authinfo';

ts/interfaces/index.ts

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

ts/sdk.classes.agenvironment.ts

@@ -0,0 +1,8 @@
+import * as plugins from './sdk.plugins';
+
+/**
+ * AgEnvironment handles the provision of environment variables to handlers
+ */
+export abstract class AgEnvironment {
+  public abstract async getEnvVar(envVarName: string): Promise<string>;
+}

ts/sdk.classes.aghandler.ts

@@ -0,0 +1,29 @@
+import * as plugins from './sdk.plugins';
+import { AuthInfo } from './sdk.classes.authinfo';
+import { AgEnvironment } from './sdk.classes.agenvironment';
+
+export interface IRequirementResult {
+  allOk: boolean;
+  reason: string;
+}
+
+export abstract class AAgHandler<TClaim> {
+  public agEnvironment: AgEnvironment;
+
+  /**
+   * a slug that separates the handler from other handlers
+   */
+  public abstract slug: string;
+  public abstract typedrouter: plugins.typedrequest.TypedRouter; 
+  public abstract checkRequirements(): Promise<IRequirementResult>;
+
+  constructor(agEnvironmentArg: AgEnvironment) {
+    this.agEnvironment = agEnvironmentArg;
+  };
+
+  /**
+   * start the ag-handler
+   */
+  public abstract start(): Promise<any>;
+  public abstract stop(): Promise<any>;
+}

ts/sdk.classes.authinfo.ts

@@ -0,0 +1,19 @@
+import * as plugins from './sdk.plugins';
+
+/**
+ * AuthInfo is created for every single incoming request
+ */
+export abstract class AuthInfo<TClaim> {
+  /**
+   * wether the request is generally authenticated
+   */
+  public abstract authenticated: boolean;
+
+  /**
+   * A heuristic analysis result wether the request might be fishy.
+   * Note: DDOS attacks should never make it anywhere near your code and are filtered by api.global itself.
+   */
+  public abstract potentiallyMalicious: boolean;
+
+  public abstract claim: TClaim;
+}

ts/sdk.plugins.ts

@@ -1,6 +1,13 @@
 // node native scope
 import * as path from 'path';
 
+// @apiglobal scope
+import * as typedrequest from '@apiglobal/typedrequest';
+
+export {
+  typedrequest
+};
+
 // @tsclass scope
 import * as tsclass from '@tsclass/tsclass';