1.0.31

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,60 +18,66 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,33 +87,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:18-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,5 +123,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "apiglobal",

package.json

@@ -1,33 +1,41 @@
 {
   "name": "@apiglobal/typedrequest",
-  "version": "1.0.3",
+  "version": "1.0.31",
   "private": false,
   "description": "make typed requests towards apis",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/smartexpress": "^3.0.69",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.13",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "dependencies": {
+    "@apiglobal/typedrequest-interfaces": "^1.0.13",
+    "@pushrocks/lik": "^4.0.13",
+    "@pushrocks/smartdelay": "^2.0.9",
+    "@pushrocks/smartjson": "^3.0.10",
+    "@pushrocks/smartrequest": "^1.1.47"
   },
-  "dependencies": {},
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -8,16 +8,29 @@ make typed requests towards apis
 * [docs (typedoc)](https://apiglobal.gitlab.io/typedrequest/)
 
 ## Status for master
-[![build status](https://gitlab.com/apiglobal/typedrequest/badges/master/build.svg)](https://gitlab.com/apiglobal/typedrequest/commits/master)
-[![coverage report](https://gitlab.com/apiglobal/typedrequest/badges/master/coverage.svg)](https://gitlab.com/apiglobal/typedrequest/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@apiglobal/typedrequest.svg)](https://www.npmjs.com/package/@apiglobal/typedrequest)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@apiglobal/typedrequest/badge.svg)](https://snyk.io/test/npm/@apiglobal/typedrequest)
-[![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/typedrequest/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/apiglobal/typedrequest/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiglobal/typedrequest)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/apiglobal/typedrequest)](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/typedrequest)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiglobal/typedrequest)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiglobal/typedrequest)](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
 
+Use TypeScript for best in class intellisense.
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.ts

@@ -1,8 +1,65 @@
 import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartexpress from '@pushrocks/smartexpress';
+
 import * as typedrequest from '../ts/index';
 
-tap.test('first test', async () => {
-  console.log(typedrequest.standardExport);
+let testServer: smartexpress.Server;
+let testTypedHandler: typedrequest.TypedHandler<ITestReqRes>;
+
+interface ITestReqRes {
+  method: 'hi';
+  request: {
+    name: string;
+  };
+  response: {
+    surname: string;
+  };
+}
+
+tap.test('should create a typedHandler', async () => {
+  testTypedHandler = new typedrequest.TypedHandler<ITestReqRes>('hi', async reqArg => {
+    return {
+      surname: 'wow'
+    };
+  });
+});
+
+tap.test('should spawn a server to test with', async () => {
+  testServer = new smartexpress.Server({
+    cors: true,
+    forceSsl: false,
+    port: 3000
+  });
+});
+
+tap.test('should define a testHandler', async () => {
+  testServer.addRoute(
+    '/testroute',
+    new smartexpress.Handler('POST', async (req, res) => {
+      console.log(req.body);
+      res.json(await testTypedHandler.addResponse(req.body));
+    })
+  );
+});
+
+tap.test('should start the server', async () => {
+  await testServer.start();
+});
+
+tap.test('should fire a request', async () => {
+  const typedRequest = new typedrequest.TypedRequest<ITestReqRes>(
+    'http://localhost:3000/testroute',
+    'hi'
+  );
+  const response = await typedRequest.fire({
+    name: 'really'
+  });
+  console.log(response);
+  expect(response.surname).to.equal('wow');
+});
+
+tap.test('should end the server', async () => {
+  await testServer.stop();
 });
 
 tap.start();

ts/index.ts

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

ts/typedrequest.classes.typedhandler.ts

@@ -0,0 +1,33 @@
+import * as plugins from './typedrequest.plugins';
+
+type THandlerFunction<T extends plugins.typedRequestInterfaces.ITypedRequest> = (
+  requestArg: T['request']
+) => Promise<T['response']>;
+
+/**
+ * typed handler for dealing with typed requests
+ */
+export class TypedHandler<T extends plugins.typedRequestInterfaces.ITypedRequest> {
+  public method: string;
+  private handlerFunction: THandlerFunction<T>;
+
+  constructor(methodArg: T['method'], handlerFunctionArg: THandlerFunction<T>) {
+    this.method = methodArg;
+    this.handlerFunction = handlerFunctionArg;
+  }
+
+  /**
+   * adds a response to the typedRequest
+   * @param typedRequestArg
+   */
+  public async addResponse(typedRequestArg: T) {
+    if (typedRequestArg.method !== this.method) {
+      throw new Error(
+        'this handler has been given a wrong method to answer to. Please use a TypedRouter to filter requests'
+      );
+    }
+    const response = await this.handlerFunction(typedRequestArg.request);
+    typedRequestArg.response = response;
+    return typedRequestArg;
+  }
+}

ts/typedrequest.classes.typedrequest.ts

@@ -0,0 +1,38 @@
+import * as plugins from './typedrequest.plugins';
+
+export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest> {
+  public urlEndPoint: string;
+  public method: string;
+
+  // STATIC
+  constructor(urlEndPointArg: string, methodArg: T['method']) {
+    this.urlEndPoint = urlEndPointArg;
+    this.method = methodArg;
+  }
+
+  /**
+   * firest the request
+   */
+  public async fire(fireArg: T['request']): Promise<T['response']> {
+    const response = await plugins.smartrequest.postJson(this.urlEndPoint, {
+      requestBody: {
+        method: this.method,
+        request: fireArg,
+        response: null
+      }
+    });
+    const responseBody: T = response.body;
+    if (responseBody.error) {
+      console.log(responseBody.error.text);
+      console.log(responseBody.error.data);
+      return null;
+    }
+    if (responseBody.retry) {
+      console.log(`server requested retry for the following reason: ${responseBody.retry.reason}`);
+      await plugins.smartdelay.delayFor(responseBody.retry.waitForMs);
+      // tslint:disable-next-line: no-return-await
+      return await this.fire(fireArg);
+    }
+    return responseBody.response;
+  }
+}

ts/typedrequest.classes.typedrouter.ts

@@ -0,0 +1,108 @@
+import * as plugins from './typedrequest.plugins';
+
+import { TypedHandler } from './typedrequest.classes.typedhandler';
+
+/**
+ * A typed router decides on which typed handler to call based on the method
+ * specified in the typed request
+ * This is thought for reusing the same url endpoint for different methods
+ */
+export class TypedRouter {
+  public upstreamTypedRouter: TypedRouter;
+
+  public routerMap = new plugins.lik.ObjectMap<TypedRouter>();
+
+  public handlerMap = new plugins.lik.ObjectMap<
+    TypedHandler<plugins.typedRequestInterfaces.ITypedRequest>
+  >();
+
+  /**
+   * adds the handler to the routing map
+   * @param typedHandlerArg
+   */
+  public addTypedHandler<T extends plugins.typedRequestInterfaces.ITypedRequest>(
+    typedHandlerArg: TypedHandler<T>
+  ) {
+    // lets check for deduplication
+    const existingTypedHandler = this.getTypedHandlerForMethod(typedHandlerArg.method);
+    if (existingTypedHandler) {
+      throw new Error(
+        `a TypedHandler for ${typedHandlerArg.method} alredy exists! Can't add another one.`
+      );
+    }
+
+    this.handlerMap.add(typedHandlerArg);
+  }
+
+  /**
+   * adds another sub typedRouter
+   * @param typedRequest
+   */
+  public addTypedRouter(typedRouterArg: TypedRouter) {
+    this.routerMap.add(typedRouterArg);
+  }
+
+  public setUpstreamTypedRouter(typedRouterArg: TypedRouter) {
+    this.upstreamTypedRouter = typedRouterArg;
+  }
+
+  public checkForTypedHandler(methodArg: string): boolean {
+    return !!this.getTypedHandlerForMethod(methodArg);
+  }
+
+  /**
+   * gets a typed Router from the router chain, upstream and downstream
+   * @param methodArg
+   * @param checkUpstreamRouter
+   */
+  public getTypedHandlerForMethod(
+    methodArg: string,
+    checkUpstreamRouter = true
+  ): TypedHandler<any> {
+    let typedHandler: TypedHandler<any>;
+
+    if (this.upstreamTypedRouter && checkUpstreamRouter) {
+      typedHandler = this.upstreamTypedRouter.getTypedHandlerForMethod(methodArg);
+    } else {
+      typedHandler = this.handlerMap.find(handler => {
+        return handler.method === methodArg;
+      });
+
+      if (!typedHandler) {
+        this.routerMap.getArray().forEach(typedRouter => {
+          if (!typedHandler) {
+            typedHandler = typedRouter.getTypedHandlerForMethod(methodArg, false);
+          }
+        });
+      }
+    }
+
+    return typedHandler;
+  }
+
+  /**
+   * routes a typed request to a handler
+   * @param typedRequestArg
+   */
+  public async routeAndAddResponse(typedRequestArg: plugins.typedRequestInterfaces.ITypedRequest) {
+    const typedHandler = this.getTypedHandlerForMethod(typedRequestArg.method);
+
+    if (!typedHandler) {
+      const availableMethods: string[] = [];
+      await this.handlerMap.forEach(async handler => {
+        availableMethods.push(handler.method);
+      });
+      console.log(`Cannot find method for ${typedHandler}`);
+      console.log(`Available methods are:`);
+      console.log(availableMethods);
+      typedRequestArg.error = {
+        text: 'There is no available method for this call on the server side',
+        data: {}
+      };
+      return typedRequestArg;
+    }
+
+    typedRequestArg = await typedHandler.addResponse(typedRequestArg);
+    return typedRequestArg;
+  }
+}

ts/typedrequest.plugins.ts

@@ -1,2 +1,12 @@
-const removeme = {};
-export { removeme };
+// apiglobal scope
+import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
+
+export { typedRequestInterfaces };
+
+// pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartjson from '@pushrocks/smartjson';
+
+export { lik, smartdelay, smartrequest, smartjson };