3.0.0

.gitlab-ci.yml

@@ -12,20 +12,12 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
@@ -36,6 +28,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@@ -96,10 +89,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -119,11 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -3,10 +3,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "apiglobal",
+      "gitscope": "api.global",
       "gitrepo": "typedrequest",
-      "shortDescription": "make typed requests towards apis",
-      "npmPackagename": "@apiglobal/typedrequest",
+      "description": "make typed requests towards apis",
+      "npmPackagename": "@api.global/typedrequest",
       "license": "MIT",
       "projectDomain": "api.global"
     }

package.json

@@ -1,34 +1,35 @@
 {
-  "name": "@apiglobal/typedrequest",
-  "version": "1.0.55",
+  "name": "@api.global/typedrequest",
+  "version": "3.0.0",
   "private": false,
   "description": "make typed requests towards apis",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web && tsbundle npm)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/smartexpress": "^3.0.76",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.11.8",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@api.global/typedserver": "^3.0.1",
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsbundle": "^2.0.8",
+    "@gitzone/tsrun": "^1.2.44",
+    "@gitzone/tstest": "^1.0.77",
+    "@push.rocks/smartenv": "^5.0.3",
+    "@push.rocks/tapbundle": "^5.0.12",
+    "@types/node": "^20.4.7"
   },
   "dependencies": {
-    "@apiglobal/typedrequest-interfaces": "^1.0.15",
-    "@pushrocks/isounique": "^1.0.4",
-    "@pushrocks/lik": "^4.0.17",
-    "@pushrocks/smartdelay": "^2.0.10",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/webrequest": "^2.0.12"
+    "@api.global/typedrequest-interfaces": "^2.0.0",
+    "@push.rocks/isounique": "^1.0.5",
+    "@push.rocks/lik": "^6.0.3",
+    "@push.rocks/smartdelay": "^3.0.5",
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/webrequest": "^3.0.32"
   },
   "files": [
     "ts/**/*",

test/test.browser.ts

@@ -1,6 +1,6 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
-import * as typedrequest from '../ts/index';
+import * as typedrequest from '../ts/index.js';
 
 let testTypedHandler: typedrequest.TypedHandler<ITestReqRes>;
 

test/test.ts

@@ -1,9 +1,9 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartexpress from '@pushrocks/smartexpress';
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as typedserver from '@api.global/typedserver';
 
-import * as typedrequest from '../ts/index';
+import * as typedrequest from '../ts/index.js';
 
-let testServer: smartexpress.Server;
+let testServer: typedserver.servertools.Server;
 let testTypedHandler: typedrequest.TypedHandler<ITestReqRes>;
 
 // lets define an interface
@@ -27,7 +27,7 @@ tap.test('should create a typedHandler', async () => {
 });
 
 tap.test('should spawn a server to test with', async () => {
-  testServer = new smartexpress.Server({
+  testServer = new typedserver.servertools.Server({
     cors: true,
     forceSsl: false,
     port: 3000,
@@ -39,7 +39,7 @@ tap.test('should define a testHandler', async () => {
   testTypedRouter.addTypedHandler(testTypedHandler);
   testServer.addRoute(
     '/testroute',
-    new smartexpress.HandlerTypedRouter(testTypedRouter as any) // the "any" is testspecific, since smartexpress ships with its own version of typedrequest.
+    new typedserver.servertools.HandlerTypedRouter(testTypedRouter as any) // the "any" is testspecific, since smartexpress ships with its own version of typedrequest.
   );
 });
 
@@ -57,7 +57,7 @@ tap.test('should fire a request', async () => {
   });
   console.log('this is the response:');
   console.log(response);
-  expect(response.surname).to.equal('wow');
+  expect(response.surname).toEqual('wow');
 });
 
 tap.test('should end the server', async () => {

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@api.global/typedrequest',
+  version: '3.0.0',
+  description: 'make typed requests towards apis'
+}

ts/index.ts

@@ -1,4 +1,5 @@
-export * from './typedrequest.classes.typedrequest';
-export * from './typedrequest.classes.typedhandler';
-export * from './typedrequest.classes.typedrouter';
-export * from './typedrequest.classes.typedresponseerror';
+export * from './typedrequest.classes.typedrequest.js';
+export * from './typedrequest.classes.typedhandler.js';
+export * from './typedrequest.classes.typedrouter.js';
+export * from './typedrequest.classes.typedresponseerror.js';
+export * from './typedrequest.classes.typedtarget.js';

ts/typedrequest.classes.typedhandler.ts

@@ -1,5 +1,5 @@
-import * as plugins from './typedrequest.plugins';
-import { TypedResponseError } from './typedrequest.classes.typedresponseerror';
+import * as plugins from './typedrequest.plugins.js';
+import { TypedResponseError } from './typedrequest.classes.typedresponseerror.js';
 
 export type THandlerFunction<T extends plugins.typedRequestInterfaces.ITypedRequest> = (
   requestArg: T['request']
@@ -32,7 +32,7 @@ export class TypedHandler<T extends plugins.typedRequestInterfaces.ITypedRequest
       if (e instanceof TypedResponseError) {
         typedResponseError = e;
       } else {
-        throw e;
+        console.log(e);
       }
     });
 

ts/typedrequest.classes.typedrequest.ts

@@ -1,13 +1,11 @@
-import * as plugins from './typedrequest.plugins';
-import { TypedResponseError } from './typedrequest.classes.typedresponseerror';
-import { TypedRouter } from './typedrequest.classes.typedrouter';
-import { TypedTarget } from './typedrequest.classes.typedtarget';
+import * as plugins from './typedrequest.plugins.js';
+import { TypedResponseError } from './typedrequest.classes.typedresponseerror.js';
+import { TypedRouter } from './typedrequest.classes.typedrouter.js';
+import { TypedTarget } from './typedrequest.classes.typedtarget.js';
 
 const webrequestInstance = new plugins.webrequest.WebRequest();
 
 export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest> {
-
-
   /**
    * in case we post against a url endpoint
    */
@@ -21,9 +19,9 @@ export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest
   public method: string;
 
   /**
-   * note the overloading is thought to deak with promises
+   * note the overloading is thought to deal with promises
    * @param postEndPointArg
-   * @param methodArg 
+   * @param methodArg
    */
   constructor(postTarget: string | TypedTarget, methodArg: T['method']) {
     if (typeof postTarget === 'string') {
@@ -37,7 +35,7 @@ export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest
   /**
    * fires the request
    */
-  public async fire(fireArg: T['request']): Promise<T['response']> {
+  public async fire(fireArg: T['request'], useCacheArg: boolean = false): Promise<T['response']> {
     const payload: plugins.typedRequestInterfaces.ITypedRequest = {
       method: this.method,
       request: fireArg,
@@ -50,7 +48,7 @@ export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest
 
     let responseBody: plugins.typedRequestInterfaces.ITypedRequest;
     if (this.urlEndPoint) {
-      const response = await webrequestInstance.postJson(this.urlEndPoint, payload);
+      const response = await webrequestInstance.postJson(this.urlEndPoint, payload, useCacheArg);
       responseBody = response;
     } else {
       responseBody = await this.typedTarget.post(payload);

ts/typedrequest.classes.typedresponseerror.ts

@@ -1,4 +1,4 @@
-import * as plugins from './typedrequest.plugins';
+import * as plugins from './typedrequest.plugins.js';
 
 export class TypedResponseError {
   public errorText: string;

ts/typedrequest.classes.typedrouter.ts

@@ -1,7 +1,7 @@
-import * as plugins from './typedrequest.plugins';
+import * as plugins from './typedrequest.plugins.js';
 
-import { TypedHandler } from './typedrequest.classes.typedhandler';
-import { TypedRequest } from './typedrequest.classes.typedrequest';
+import { TypedHandler } from './typedrequest.classes.typedhandler.js';
+import { TypedRequest } from './typedrequest.classes.typedrequest.js';
 
 /**
  * A typed router decides on which typed handler to call based on the method
@@ -9,10 +9,7 @@ import { TypedRequest } from './typedrequest.classes.typedrequest';
  * 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<any & plugins.typedRequestInterfaces.ITypedRequest>
   >();
@@ -45,11 +42,11 @@ export class TypedRouter {
    * @param typedRequest
    */
   public addTypedRouter(typedRouterArg: TypedRouter) {
-    this.routerMap.add(typedRouterArg);
-  }
-
-  public setUpstreamTypedRouter(typedRouterArg: TypedRouter) {
-    this.upstreamTypedRouter = typedRouterArg;
+    const routerExists = this.routerMap.findSync((routerArg) => routerArg === typedRouterArg);
+    if (!routerExists) {
+      this.routerMap.add(typedRouterArg);
+      typedRouterArg.addTypedRouter(this);
+    }
   }
 
   public checkForTypedHandler(methodArg: string): boolean {
@@ -63,24 +60,22 @@ export class TypedRouter {
    */
   public getTypedHandlerForMethod(
     methodArg: string,
-    checkUpstreamRouter = true
+    checkedRouters: TypedRouter[] = []
   ): TypedHandler<any> {
+    checkedRouters.push(this);
+
     let typedHandler: TypedHandler<any>;
 
-    if (this.upstreamTypedRouter && checkUpstreamRouter) {
-      typedHandler = this.upstreamTypedRouter.getTypedHandlerForMethod(methodArg);
-    } else {
-      typedHandler = this.handlerMap.find((handler) => {
-        return handler.method === methodArg;
-      });
+    typedHandler = this.handlerMap.findSync((handler) => {
+      return handler.method === methodArg;
+    });
 
-      if (!typedHandler) {
-        this.routerMap.getArray().forEach((typedRouter) => {
-          if (!typedHandler) {
-            typedHandler = typedRouter.getTypedHandlerForMethod(methodArg, false);
-          }
-        });
-      }
+    if (!typedHandler) {
+      this.routerMap.getArray().forEach((typedRouterArg) => {
+        if (!typedHandler && !checkedRouters.includes(typedRouterArg)) {
+          typedHandler = typedRouterArg.getTypedHandlerForMethod(methodArg, checkedRouters);
+        }
+      });
     }
 
     return typedHandler;
@@ -91,8 +86,10 @@ export class TypedRouter {
    * if typedrequest object has correlation.phase === 'response' -> routes a typed request object to request fire event
    * @param typedRequestArg
    */
-  public async routeAndAddResponse(typedRequestArg: plugins.typedRequestInterfaces.ITypedRequest) {
-    if (!typedRequestArg?.correlation?.phase || typedRequestArg.correlation.phase === 'request') {
+  public async routeAndAddResponse<
+    T extends plugins.typedRequestInterfaces.ITypedRequest = plugins.typedRequestInterfaces.ITypedRequest
+  >(typedRequestArg: T, localRequestArg = false): Promise<T> {
+    if (typedRequestArg?.correlation?.phase === 'request' || localRequestArg) {
       const typedHandler = this.getTypedHandlerForMethod(typedRequestArg.method);
 
       if (!typedHandler) {
@@ -101,24 +98,21 @@ export class TypedRouter {
           text: 'There is no available method for this call on the server side',
           data: {},
         };
+        typedRequestArg.correlation.phase = 'response';
         return typedRequestArg;
       }
 
       typedRequestArg = await typedHandler.addResponse(typedRequestArg);
-    } else if (typedRequestArg.correlation.phase === 'response') {
+      return typedRequestArg;
+    } else if (typedRequestArg?.correlation?.phase === 'response') {
       this.fireEventInterestMap
         .findInterest(typedRequestArg.correlation.id)
         ?.fullfillInterest(typedRequestArg);
+      return null;
     } else {
       console.log('received weirdly shaped request');
       console.log(typedRequestArg);
-      return {}
+      return null;
     }
-    return {
-      ...typedRequestArg,
-      ...{
-        method: 'nullPathFromResponse',
-      },
-    };
   }
 }

ts/typedrequest.classes.typedtarget.ts

@@ -1,11 +1,12 @@
-import { TypedRouter } from './typedrequest.classes.typedrouter';
-import * as plugins from './typedrequest.plugins';
+import { TypedRouter } from './typedrequest.classes.typedrouter.js';
+import * as plugins from './typedrequest.plugins.js';
 
 export type IPostMethod = (
   typedRequestPostObject: plugins.typedRequestInterfaces.ITypedRequest
 ) => Promise<plugins.typedRequestInterfaces.ITypedRequest>;
 
 /**
+ * this is an alternative to a post url supplied in `new Typedrequest(new TypedTarget(...), 'someMethodName')`
  * enables the use of custom post functions
  * used for things like broadcast channels
  * e.g. @designestate/dees-comms
@@ -51,7 +52,9 @@ export class TypedTarget {
    */
   public isAsync: boolean;
 
-  public async post<T extends plugins.typedRequestInterfaces.ITypedRequest>(payloadArg: T): Promise<T> {
+  public async post<T extends plugins.typedRequestInterfaces.ITypedRequest>(
+    payloadArg: T
+  ): Promise<T> {
     let responseInterest: plugins.lik.Interest<
       string,
       plugins.typedRequestInterfaces.ITypedRequest

ts/typedrequest.plugins.ts

@@ -1,13 +1,13 @@
 // apiglobal scope
-import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
+import * as typedRequestInterfaces from '@api.global/typedrequest-interfaces';
 
 export { typedRequestInterfaces };
 
 // pushrocks scope
-import * as isounique from '@pushrocks/isounique';
-import * as lik from '@pushrocks/lik';
-import * as smartdelay from '@pushrocks/smartdelay';
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as webrequest from '@pushrocks/webrequest';
+import * as isounique from '@push.rocks/isounique';
+import * as lik from '@push.rocks/lik';
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as webrequest from '@push.rocks/webrequest';
 
 export { isounique, lik, smartdelay, smartpromise, webrequest };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "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"
-}