3.0.8

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api.global/typedrequest-interfaces",
-  "version": "3.0.1",
+  "version": "3.0.8",
   "private": false,
   "description": "interfaces for making typed requests",
   "main": "dist_ts/index.js",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@api.global/typedrequest-interfaces',
-  version: '3.0.1',
+  version: '3.0.8',
   description: 'interfaces for making typed requests'
 }

ts/index.ts

@@ -11,6 +11,14 @@ export interface ITypedRequest {
     jwt: string;
   };
 
+  /**
+   * localData tracks things within typedrequest.
+   * needed for VirtualStreams
+   */
+  localData?: {
+    firstTypedrouter?: any;
+  }
+
   /**
    * server data that is added for dealing with the request server side. Will be omitted when sending the response
    */
@@ -44,6 +52,8 @@ export interface ITypedRequest {
 
   /**
    * a correlation id that
+   * used for matching request and response
+   * !important. Don't remove.
    */
   correlation?: {
     id: string;
@@ -65,3 +75,24 @@ export interface ITag {
 }
 
 export type implementsTag<T, U extends T> = {};
+
+export interface IStreamRequest extends implementsTR<
+  ITypedRequest,
+  IStreamRequest
+> {
+  method: '##VirtualStream##';
+  request: {
+    streamId: string;
+    type: 'start' | 'binaryChunk' | 'object' | 'end' | 'keepAlive';
+    streamChunk?: any;
+    keepAlive?: boolean;
+    next?: boolean;
+  };
+  response: {
+    streamId: string;
+    type: 'start' | 'binaryChunk' | 'object' | 'end' | 'keepAlive';
+    streamChunk?: any;
+    keepAlive?: boolean;
+    next?: boolean;
+  };
+}

tsconfig.json

@@ -3,9 +3,12 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "ES2022",
-    "moduleResolution": "nodenext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true,
-  }
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
 }