2.0.18

.gitlab-ci.yml

@@ -12,40 +12,36 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
+# ====================
+# security stage
+# ====================
 # ====================
 # 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
   script:
-    - npmci npm prepare
-    - npmci command npm install --production --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
+    - lossless
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -56,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -67,10 +62,9 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
-    - npmci command npm run build
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -96,10 +90,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 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
+    - npmci node install stable
     - 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

@@ -5,7 +5,7 @@
       "githost": "gitlab.com",
       "gitscope": "apiglobal",
       "gitrepo": "typedsocket",
-      "shortDescription": "a typedrequest extension supporting websockets",
+      "description": "a typedrequest extension supporting websockets",
       "npmPackagename": "@apiglobal/typedsocket",
       "license": "MIT",
       "projectDomain": "api.global"

package.json

@@ -1,32 +1,34 @@
 {
   "name": "@apiglobal/typedsocket",
-  "version": "1.0.9",
+  "version": "2.0.18",
   "private": false,
   "description": "a typedrequest extension supporting websockets",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.14.22",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsbundle": "^2.0.6",
+    "@gitzone/tsrun": "^1.2.39",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/smartenv": "^5.0.4",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.11.18"
   },
   "dependencies": {
-    "@apiglobal/typedrequest": "^1.0.56",
-    "@apiglobal/typedrequest-interfaces": "^1.0.15",
-    "@pushrocks/isohash": "^1.0.2",
-    "@pushrocks/smartexpress": "^3.0.100",
-    "@pushrocks/smartsocket": "^1.2.1",
-    "@pushrocks/smartstring": "^3.0.24"
+    "@apiglobal/typedrequest": "^2.0.8",
+    "@apiglobal/typedrequest-interfaces": "2.0.1",
+    "@pushrocks/isohash": "^2.0.0",
+    "@pushrocks/smartjson": "^5.0.5",
+    "@pushrocks/smartsocket": "^2.0.13",
+    "@pushrocks/smartstring": "^4.0.2"
   },
   "browserslist": [
     "last 1 chrome versions"

readme.md

@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
 PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@apiglobal/typedsocket)](https://lossless.cloud)
 PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiglobal/typedsocket)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiglobal/typedsocket)](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
 
@@ -37,7 +36,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-inactive/test.browser.ts

@@ -1,6 +1,6 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as typedsocket from '../ts/index';
+import * as typedsocket from '../ts/index.js';
 
 tap.test('should create a client', async () => {
   console.log('Browser test') // TODO: implement browser tests

test/test.ts

@@ -2,20 +2,20 @@ import { expect, tap } from '@pushrocks/tapbundle';
 import * as typedrequest from '@apiglobal/typedrequest';
 import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
 
-import * as typedsocket from '../ts/index';
-import { request } from 'http';
+import * as typedsocket from '../ts/index.js';
 
-interface IRequest_Client_Server extends typedrequestInterfaces.implementsTR<
-  typedrequestInterfaces.ITypedRequest,
-  IRequest_Client_Server
-> {
+interface IRequest_Client_Server
+  extends typedrequestInterfaces.implementsTR<
+    typedrequestInterfaces.ITypedRequest,
+    IRequest_Client_Server
+  > {
   method: 'sayhi';
   request: {
     greeting: string;
   };
   response: {
-    answer: string
-  }
+    answer: string;
+  };
 }
 
 let testTypedSocketServer: typedsocket.TypedSocket;
@@ -24,38 +24,52 @@ let testTypedSocketClient: typedsocket.TypedSocket;
 const testTypedRouter = new typedrequest.TypedRouter();
 
 tap.test('should add some handlers', async () => {
-  testTypedRouter.addTypedHandler<IRequest_Client_Server>(new typedrequest.TypedHandler('sayhi', async requestData => {
-    return {
-      answer: `ok, got it : ${requestData.greeting}`
-    }
-  }));
-})
+  testTypedRouter.addTypedHandler<IRequest_Client_Server>(
+    new typedrequest.TypedHandler('sayhi', async (requestData) => {
+      return {
+        answer: `ok, got it : ${requestData.greeting}`,
+      };
+    })
+  );
+});
 
 tap.test('should create Server and Client', async (tools) => {
   testTypedSocketServer = await typedsocket.TypedSocket.createServer(testTypedRouter);
-  testTypedSocketClient = await typedsocket.TypedSocket.createClient(testTypedRouter, 'http://localhost');
+  testTypedSocketClient = await typedsocket.TypedSocket.createClient(
+    testTypedRouter,
+    'http://localhost:3000'
+  );
+  console.log('test: waiting 5 seconds');
+  await tools.delayFor(5000);
+  await testTypedSocketServer.stop();
+
+  // lets create another server
+  testTypedSocketServer = await typedsocket.TypedSocket.createServer(testTypedRouter);
+
+  // lets see if auto reconnect works
+  console.log('test: waiting 21 seconds for reconnect');
+  await tools.delayFor(21000);
 });
 
 tap.test('should process messages from both sides', async () => {
-  const myServerSideTypedRequest = testTypedSocketServer.createTypedRequest<IRequest_Client_Server>('sayhi');
-  const myClientSideTypedRequest = testTypedSocketClient.createTypedRequest<IRequest_Client_Server>('sayhi');
+  const myServerSideTypedRequest =
+    testTypedSocketServer.createTypedRequest<IRequest_Client_Server>('sayhi');
+  const myClientSideTypedRequest =
+    testTypedSocketClient.createTypedRequest<IRequest_Client_Server>('sayhi');
   const response = await myClientSideTypedRequest.fire({
-    greeting: 'that is a greeting from the client'
+    greeting: 'that is a greeting from the client',
   });
   console.log(response);
   const response2 = await myServerSideTypedRequest.fire({
-    greeting: 'that is a greeting from the server'
+    greeting: 'that is a greeting from the server',
   });
   console.log(response2);
-})
+});
 
-tap.test('should run without problems for a little bit', async tools => {
-  await tools.delayFor(5000);
-})
-
-tap.test('should disconnect', async () => {
+tap.test('should disconnect', async (tools) => {
   await testTypedSocketClient.stop();
   await testTypedSocketServer.stop();
-})
+  tools.delayFor(1000).then(() => process.exit(0));
+});
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@apiglobal/typedsocket',
+  version: '2.0.18',
+  description: 'a typedrequest extension supporting websockets'
+}

ts/index.ts

@@ -1 +1 @@
-export * from './typedsocket.classes.typedsocket';
+export * from './typedsocket.classes.typedsocket.js';

ts/typedsocket.classes.typedsocket.ts

@@ -1,9 +1,10 @@
-import * as plugins from './typedsocket.plugins';
-import type * as smartexpress from '@pushrocks/smartexpress';
+import * as plugins from './typedsocket.plugins.js';
 
 const publicRoleName = 'publicRoleName';
 const publicRolePass = 'publicRolePass';
 
+export type TTypedSocketSide = 'server' | 'client';
+
 export class TypedSocket {
   // STATIC
   /**
@@ -12,29 +13,26 @@ export class TypedSocket {
    */
   public static async createServer(
     typedrouterArg: plugins.typedrequest.TypedRouter,
-    smartexpressServerArg?: smartexpress.Server
+    smartexpressServerArg?: any
   ): Promise<TypedSocket> {
     const smartsocketServer = new plugins.smartsocket.Smartsocket({
+      alias: 'typedsocketServer',
       port: 3000,
     });
     if (smartexpressServerArg) {
       smartsocketServer.setExternalServer('smartexpress', smartexpressServerArg);
     }
-    const publicRole = new plugins.smartsocket.SocketRole({
-      name: publicRoleName,
-      passwordHash: await plugins.isohash.sha256FromString(publicRolePass),
-    });
-    smartsocketServer.addSocketRoles([publicRole]);
+
     smartsocketServer.socketFunctions.add(
       new plugins.smartsocket.SocketFunction({
         funcName: 'processMessage',
-        allowedRoles: [publicRole],
         funcDef: async (dataArg, socketConnectionArg) => {
           return typedrouterArg.routeAndAddResponse(dataArg);
         },
       })
     );
     const typedsocket = new TypedSocket(
+      'server',
       typedrouterArg,
       async <T extends plugins.typedrequestInterfaces.ITypedRequest>(
         dataArg: T,
@@ -47,21 +45,20 @@ export class TypedSocket {
             );
             targetConnectionArg = smartsocketServer.socketConnections.getArray()[0];
           } else {
-            throw new Error('you need to specify the wanted targetConnection');
+            throw new Error(
+              'you need to specify the wanted targetConnection. Currently no target is selectable automatically.'
+            );
           }
         }
-        const response: T = await smartsocketServer.clientCall(
+        const response: T = (await smartsocketServer.clientCall(
           'processMessage',
           dataArg,
           targetConnectionArg
-        ) as any;
+        )) as any;
         return response;
       },
       smartsocketServer
     );
-    if (smartexpressServerArg && smartexpressServerArg.serverStatus !== 'running') {
-      await smartexpressServerArg.start()
-    }
     await smartsocketServer.start();
 
     return typedsocket;
@@ -74,28 +71,28 @@ export class TypedSocket {
   ): Promise<TypedSocket> {
     const domain = new plugins.smartstring.Domain(serverUrlArg);
 
-
-    const smartsocketClient = new plugins.smartsocket.SmartsocketClient({
+    const socketOptions: plugins.smartsocket.ISmartsocketClientOptions = {
       alias: aliasArg,
-      role: publicRoleName,
-      password: publicRolePass,
       port: domain.port || 3000,
-      url: `${domain.nodeParsedUrl.protocol}//${domain.nodeParsedUrl.host}`,
+      url: `${domain.nodeParsedUrl.protocol}//${domain.nodeParsedUrl.hostname}`,
       autoReconnect: true,
-    });
+    };
+    console.log(`starting typedsocket with the following settings:`);
+    console.log(socketOptions);
+    const smartsocketClient = new plugins.smartsocket.SmartsocketClient(socketOptions);
     smartsocketClient.addSocketFunction(
       new plugins.smartsocket.SocketFunction({
         funcName: 'processMessage',
-        allowedRoles: [],
         funcDef: async (dataArg, socketConnectionArg) => {
           return typedrouterArg.routeAndAddResponse(dataArg);
         },
       })
     );
     const typedsocket = new TypedSocket(
+      'client',
       typedrouterArg,
       async <T extends plugins.typedrequestInterfaces.ITypedRequest>(dataArg: T): Promise<T> => {
-        const response: T = (smartsocketClient.serverCall('processMessage', dataArg) as any) as T;
+        const response: T = smartsocketClient.serverCall('processMessage', dataArg) as any as T;
         return response;
       },
       smartsocketClient
@@ -107,23 +104,45 @@ export class TypedSocket {
   }
 
   // INSTANCE
+  public side: TTypedSocketSide;
   public typedrouter: plugins.typedrequest.TypedRouter;
   private postMethod: plugins.typedrequest.IPostMethod &
     ((
       typedRequestPostObject: plugins.typedrequestInterfaces.ITypedRequest,
       socketConnectionArg?: plugins.smartsocket.SocketConnection
     ) => Promise<plugins.typedrequestInterfaces.ITypedRequest>);
-  private socketServerOrClient: plugins.smartsocket.Smartsocket | plugins.smartsocket.SmartsocketClient;
+  private socketServerOrClient:
+    | plugins.smartsocket.Smartsocket
+    | plugins.smartsocket.SmartsocketClient;
   constructor(
+    sideArg: TTypedSocketSide,
     typedrouterArg: plugins.typedrequest.TypedRouter,
     postMethodArg: plugins.typedrequest.IPostMethod,
     socketServerOrClientArg: plugins.smartsocket.Smartsocket | plugins.smartsocket.SmartsocketClient
   ) {
+    this.side = sideArg;
     this.typedrouter = typedrouterArg;
     this.postMethod = postMethodArg;
     this.socketServerOrClient = socketServerOrClientArg;
   }
 
+  public addTag<T extends plugins.typedrequestInterfaces.ITag = any>(
+    nameArg: T['name'],
+    payloadArg: T['payload']
+  ) {
+    if (
+      this.side === 'client' &&
+      this.socketServerOrClient instanceof plugins.smartsocket.SmartsocketClient
+    ) {
+      this.socketServerOrClient.socketConnection.addTag({
+        id: nameArg,
+        payload: payloadArg,
+      });
+    } else {
+      throw new Error('tagging is only supported on clients');
+    }
+  }
+
   public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest>(
     methodName: T['method'],
     targetConnection?: plugins.smartsocket.SocketConnection
@@ -140,21 +159,65 @@ export class TypedSocket {
     return typedrequest;
   }
 
-  public async findTargetConnection(
-    findFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => boolean
+  /**
+   * returns all matching target connection
+   * @param asyncFindFuncArg
+   * @returns
+   */
+  public async findAllTargetConnections(
+    asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
   ) {
     if (this.socketServerOrClient instanceof plugins.smartsocket.Smartsocket) {
+      const matchingSockets: plugins.smartsocket.SocketConnection[] = [];
       for (const socketConnection of this.socketServerOrClient.socketConnections.getArray()) {
-        if (findFuncArg(socketConnection)) {
-          return socketConnection;
+        if (await asyncFindFuncArg(socketConnection)) {
+          matchingSockets.push(socketConnection);
         }
       }
+      return matchingSockets;
     } else {
-      console.warn('this method >>findTargetConnection<< is only available from the server');
+      throw new Error('this method >>findTargetConnection<< is only available from the server');
     }
   }
 
+  /**
+   * returns a single target connection by returning the first one of all matching ones
+   * @param asyncFindFuncArg
+   * @returns
+   */
+  public async findTargetConnection(
+    asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
+  ) {
+    const allMatching = await this.findAllTargetConnections(asyncFindFuncArg);
+    return allMatching[0];
+  }
+
+  public async findAllTargetConnectionsByTag<
+    TTag extends plugins.typedrequestInterfaces.ITag = any
+  >(keyArg: TTag['name'], payloadArg?: TTag['payload']) {
+    return this.findAllTargetConnections(async (socketConnectionArg) => {
+      let result: boolean;
+      if (!payloadArg) {
+        result = !!(await socketConnectionArg.getTagById(keyArg));
+      } else {
+        result = !!(
+          plugins.smartjson.stringify((await socketConnectionArg.getTagById(keyArg))?.payload) ===
+          plugins.smartjson.stringify(payloadArg)
+        );
+      }
+      return result;
+    });
+  }
+
+  public async findTargetConnectionByTag<TTag extends plugins.typedrequestInterfaces.ITag = any>(
+    keyArg: TTag['name'],
+    payloadArg?: TTag['payload']
+  ) {
+    const allResults = await this.findAllTargetConnectionsByTag(keyArg, payloadArg);
+    return allResults[0];
+  }
+
   public async stop() {
-    await this.socketServerOrClient.stop()
+    await this.socketServerOrClient.stop();
   }
 }

ts/typedsocket.plugins.ts

@@ -2,18 +2,12 @@
 import * as typedrequest from '@apiglobal/typedrequest';
 import * as typedrequestInterfaces from '@apiglobal/typedrequest-interfaces';
 
-export {
-  typedrequest,
-  typedrequestInterfaces,
-}
+export { typedrequest, typedrequestInterfaces };
 
 // @pushrocks scope
 import * as isohash from '@pushrocks/isohash';
+import * as smartjson from '@pushrocks/smartjson';
 import * as smartsocket from '@pushrocks/smartsocket';
 import * as smartstring from '@pushrocks/smartstring';
 
-export {
-  isohash,
-  smartsocket,
-  smartstring
-}
+export { isohash, smartjson, smartsocket, smartstring };

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"
-}