3.0.17

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

npmextra.json

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

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@apiglobal/typedrequest-interfaces",
-  "version": "1.0.18",
+  "name": "@api.global/typedrequest-interfaces",
+  "version": "3.0.17",
   "private": false,
   "description": "interfaces for making typed requests",
   "main": "dist_ts/index.js",
@@ -14,11 +14,11 @@
     "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.2.39",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^18.11.5"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.44",
+    "@gitzone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.0.12",
+    "@types/node": "^20.4.6"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -1,27 +1,26 @@
-# @apiglobal/typedrequest-interfaces
+# @api.global/typedrequest-interfaces
 interfaces for making typed requests
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@apiglobal/typedrequest-interfaces)
-* [gitlab.com (source)](https://gitlab.com/apiglobal/typedrequest-interfaces)
-* [github.com (source mirror)](https://github.com/apiglobal/typedrequest-interfaces)
-* [docs (typedoc)](https://apiglobal.gitlab.io/typedrequest-interfaces/)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@api.global/typedrequest-interfaces)
+* [gitlab.com (source)](https://gitlab.com/api.global/typedrequest-interfaces)
+* [github.com (source mirror)](https://github.com/api.global/typedrequest-interfaces)
+* [docs (typedoc)](https://api.global.gitlab.io/typedrequest-interfaces/)
 
 ## Status for master
 
 Status Category | Status Badge
 -- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/apiglobal/typedrequest-interfaces/badges/master/pipeline.svg)](https://lossless.cloud)
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/apiglobal/typedrequest-interfaces/badges/master/coverage.svg)](https://lossless.cloud)
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiglobal/typedrequest-interfaces)](https://lossless.cloud)
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/apiglobal/typedrequest-interfaces)](https://lossless.cloud)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/api.global/typedrequest-interfaces/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/api.global/typedrequest-interfaces/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@api.global/typedrequest-interfaces)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/api.global/typedrequest-interfaces)](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-interfaces)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiglobal/typedrequest-interfaces)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiglobal/typedrequest-interfaces)](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)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@api.global/typedrequest-interfaces)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@api.global/typedrequest-interfaces)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@api.global/typedrequest-interfaces)](https://lossless.cloud)
 
 ## Usage
 
@@ -35,7 +34,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,4 +1,4 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 import * as typedrequestInterfaces from '../ts/index.js';
 
 interface IRequestSample

ts/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @pushrocks/commitinfo
  */
 export const commitinfo = {
-  name: '@apiglobal/typedrequest-interfaces',
-  version: '1.0.18',
+  name: '@api.global/typedrequest-interfaces',
+  version: '3.0.17',
   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,78 @@ export interface ITag {
 }
 
 export type implementsTag<T, U extends T> = {};
+
+
+// stream stuff
+export interface IVirtualStream<T = ArrayBufferLike> {
+  // Properties
+  side: 'requesting' | 'responding';
+  streamId: string;
+  sendMethod: any;
+  typedrouter: any;
+
+  // Methods
+  handleStreamTr(streamTrArg: IStreamRequest): Promise<IStreamRequest>;
+  cleanup(): Promise<void>;
+  sendData(dataArg: T): Promise<void>;
+  fetchData(): Promise<T>;
+  pipeWebStream(webStream: any): void; // Consider defining a more specific type for webStream if possible
+}
+
+export interface IUnifiedStreamDataPackage {
+  /**
+   * the stream id, so Virtual Streams can talk to each other
+   */
+  streamId: string;
+
+  /**
+   * stream data is sent in cycles. This id is used to match the request and response
+   */
+  cycleId: string;
+  cycle: 'request' | 'response';
+
+  /**
+   * the main purpose of the data package
+   * start: indicates the start of a stream
+   * chunk: indicates a binary chunk of data
+   * read: indicates the introduction to send data
+   * end: indicates the end of a stream
+   * feedback: indicates a feedback message
+   */
+  mainPurpose: 'start' | 'chunk' | 'read' | 'end' | 'feedback' | 'keepAlive';
+
+  /**
+   * the data package
+   */
+  chunkData?: any;
+  
+  /**
+   * feedback message
+   */
+  feedback?: {
+    message?: string;
+    data?: any;
+    sha265?: string;
+  };
+
+  /**
+   * keepAlive boolean
+   */
+  keepAlive?: boolean;
+
+  /**
+   * is backpressure detected on the readable side?
+   */
+  backpressure?: boolean;
+
+  /**
+   * does the writable side have more data scheduled to be sent?
+   */
+  next?: boolean;
+}
+
+export interface IStreamRequest extends implementsTR<ITypedRequest, IStreamRequest> {
+  method: '##VirtualStream##';
+  request: IUnifiedStreamDataPackage;
+  response: IUnifiedStreamDataPackage;
+}

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}