2.0.7

.gitlab-ci.yml

@@ -36,6 +36,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

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,30 +1,33 @@
 {
   "name": "@apiglobal/typedsocket",
-  "version": "1.0.5",
+  "version": "2.0.7",
   "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)"
   },
   "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.16",
-    "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.72",
+    "@pushrocks/smartenv": "^5.0.2",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.3"
   },
   "dependencies": {
-    "@apiglobal/typedrequest": "^1.0.56",
+    "@apiglobal/typedrequest": "^2.0.8",
     "@apiglobal/typedrequest-interfaces": "^1.0.15",
-    "@pushrocks/isohash": "^1.0.2",
-    "@pushrocks/smartsocket": "^1.2.0"
+    "@pushrocks/isohash": "^2.0.0",
+    "@pushrocks/smartjson": "^5.0.2",
+    "@pushrocks/smartsocket": "^2.0.7",
+    "@pushrocks/smartstring": "^4.0.2"
   },
   "browserslist": [
     "last 1 chrome versions"

readme.md

@@ -25,7 +25,11 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 
 ## Usage
 
-Use TypeScript for best in class intellisense
+Use TypeScript for best in class intellisense.
+
+TypedSocket is the typedrequest you love, just in a bidirectional way.
+
+See the following examples from our test for reference:
 
 ## Contribution
 

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,8 +2,7 @@ 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,
@@ -33,7 +32,17 @@ tap.test('should add some handlers', async () => {
 
 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 () => {
@@ -49,13 +58,10 @@ tap.test('should process messages from both sides', async () => {
   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.7',
+  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,8 +1,10 @@
-import * as plugins from './typedsocket.plugins';
+import * as plugins from './typedsocket.plugins.js';
 
 const publicRoleName = 'publicRoleName';
 const publicRolePass = 'publicRolePass';
 
+export type TTypedSocketSide = 'server' | 'client';
+
 export class TypedSocket {
   // STATIC
   /**
@@ -14,26 +16,23 @@ export class TypedSocket {
     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,
@@ -46,19 +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
     );
-
     await smartsocketServer.start();
 
     return typedsocket;
@@ -66,29 +66,33 @@ export class TypedSocket {
 
   public static async createClient(
     typedrouterArg: plugins.typedrequest.TypedRouter,
-    serverUrl: string
+    serverUrlArg: string,
+    aliasArg = 'clientArg'
   ): Promise<TypedSocket> {
-    const smartsocketClient = new plugins.smartsocket.SmartsocketClient({
-      alias: 'client1',
-      role: publicRoleName,
-      password: publicRolePass,
-      port: 3000,
-      url: serverUrl,
+    const domain = new plugins.smartstring.Domain(serverUrlArg);
+
+    const socketOptions: plugins.smartsocket.ISmartsocketClientOptions = {
+      alias: aliasArg,
+      port: domain.port || 3000,
+      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
@@ -100,23 +104,42 @@ 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(keyArg: string, payloadArg: any) {
+    if (
+      this.side === 'client' &&
+      this.socketServerOrClient instanceof plugins.smartsocket.SmartsocketClient
+    ) {
+      this.socketServerOrClient.socketConnection.addTag({
+        id: keyArg,
+        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
@@ -133,21 +156,60 @@ 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(keyArg: string, payloadArg?: any) {
+    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(keyArg: string, payloadArg?: any) {
+    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

@@ -9,9 +9,13 @@ export {
 
 // @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
+  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"
-}