1.0.46

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/typedrequest",
-  "version": "1.0.41",
+  "version": "1.0.46",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apiglobal/typedrequest",
-  "version": "1.0.41",
+  "version": "1.0.46",
   "private": false,
   "description": "make typed requests towards apis",
   "main": "dist_ts/index.js",

readme.md

@@ -27,6 +27,76 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 
 Use TypeScript for best in class intellisense.
 
+```typescript
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartexpress from '@pushrocks/smartexpress';
+
+import * as typedrequest from '../ts/index';
+
+let testServer: smartexpress.Server;
+let testTypedHandler: typedrequest.TypedHandler<ITestReqRes>;
+
+// lets define an interface
+interface ITestReqRes {
+  method: 'hi';
+  request: {
+    name: string;
+  };
+  response: {
+    surname: string;
+  };
+}
+
+tap.test('should create a typedHandler', async () => {
+  // lets use the interface in a TypedHandler
+  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 () => {
+  const testTypedRouter = new typedrequest.TypedRouter(); // typed routers can broker typedrequests between handlers
+  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.
+  );
+});
+
+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('this is the response:');
+  console.log(response);
+  expect(response.surname).to.equal('wow');
+});
+
+tap.test('should end the server', async () => {
+  await testServer.stop();
+});
+
+tap.start();
+```
+
 ## 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). :)

test/test.ts

@@ -6,6 +6,7 @@ import * as typedrequest from '../ts/index';
 let testServer: smartexpress.Server;
 let testTypedHandler: typedrequest.TypedHandler<ITestReqRes>;
 
+// lets define an interface
 interface ITestReqRes {
   method: 'hi';
   request: {
@@ -17,6 +18,7 @@ interface ITestReqRes {
 }
 
 tap.test('should create a typedHandler', async () => {
+  // lets use the interface in a TypedHandler
   testTypedHandler = new typedrequest.TypedHandler<ITestReqRes>('hi', async reqArg => {
     return {
       surname: 'wow'
@@ -33,11 +35,11 @@ tap.test('should spawn a server to test with', async () => {
 });
 
 tap.test('should define a testHandler', async () => {
-  const testTypedRouter = new typedrequest.TypedRouter();
+  const testTypedRouter = new typedrequest.TypedRouter(); // typed routers can broker typedrequests between handlers
   testTypedRouter.addTypedHandler(testTypedHandler);
   testServer.addRoute(
     '/testroute',
-    new smartexpress.HandlerTypedRouter(testTypedRouter as any)
+    new smartexpress.HandlerTypedRouter(testTypedRouter as any) // the "any" is testspecific, since smartexpress ships with its own version of typedrequest.
   );
 });
 

ts/typedrequest.classes.typedhandler.ts

@@ -47,7 +47,7 @@ export class TypedHandler<T extends plugins.typedRequestInterfaces.ITypedRequest
       typedRequestArg.response = response;
     }
 
-    typedRequestArg.correlation.phase = 'response';
+    typedRequestArg?.correlation?.phase ? typedRequestArg.correlation.phase = 'response' : null;
 
     return typedRequestArg;
   }

ts/typedrequest.classes.typedrequest.ts

@@ -7,6 +7,9 @@ export type IPostMethod = (
 ) => void | Promise<plugins.typedRequestInterfaces.ITypedRequest>;
 
 export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest> {
+  /**
+   * this typedrouter allows us to have easy async request response cycles
+   */
   public typedRouterRef: TypedRouter;
   public webrequest = new plugins.webrequest.WebRequest();
 
@@ -59,6 +62,7 @@ export class TypedRequest<T extends plugins.typedRequestInterfaces.ITypedRequest
           string,
           plugins.typedRequestInterfaces.ITypedRequest
       >;
+      // having a typedrouter allows us to work with async request response cycles.
       if (this.typedRouterRef) {
         responseInterest = await this.typedRouterRef.fireEventInterestMap.addInterest(
           payload.correlation.id,

ts/typedrequest.classes.typedrouter.ts

@@ -92,7 +92,7 @@ export class TypedRouter {
    * @param typedRequestArg
    */
   public async routeAndAddResponse(typedRequestArg: plugins.typedRequestInterfaces.ITypedRequest) {
-    if (typedRequestArg.correlation.phase === 'request') {
+    if (!typedRequestArg?.correlation?.phase || typedRequestArg.correlation.phase === 'request') {
       const typedHandler = this.getTypedHandlerForMethod(typedRequestArg.method);
 
       if (!typedHandler) {