@design.estate/dees-comms 1.0.30 → 1.0.31

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@design.estate/dees-comms',
-    version: '1.0.30',
+    version: '1.0.31',
     description: 'A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSwyQkFBMkI7SUFDakMsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLCtHQUErRztDQUM3SCxDQUFBIn0=

package/dist_ts/dees-comms.classes.deescomms.d.ts

@@ -4,7 +4,7 @@ import * as plugins from './dees-comms.plugins.js';
  */
 export declare class DeesComms {
     private broadcastChannel;
-    typedrouter: plugins.typedrequest.TypedRouter;
+    typedrouter: plugins.typedrequest.TypedRouter<plugins.typedrequestInterfaces.ITypedRequest>;
     typedtarget: plugins.typedrequest.TypedTarget;
     constructor();
     /**

package/dist_ts/dees-comms.classes.deescomms.js

@@ -20,16 +20,14 @@ export class DeesComms {
         });
         this.broadcastChannel.onmessage = async (eventArg) => {
             const message = eventArg.method ? eventArg : eventArg.data;
-            console.log(JSON.stringify(message));
             // Skip hooks for broadcast-received messages to prevent infinite loops
             // when traffic logging hooks are set up globally
-            const response = await this.typedrouter.routeAndAddResponse(message, { skipHooks: true });
+            const response = await this.typedrouter.routeAndAddResponse(message, {
+                skipHooks: true,
+            });
             if (response && !response.error) {
                 this.postMessage(response);
             }
-            else {
-                // console.log(response);
-            }
         };
     }
     /**
@@ -52,4 +50,4 @@ export class DeesComms {
         this.typedrouter.addTypedHandler(new plugins.typedrequest.TypedHandler(methodArg, handlerFunction));
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVlcy1jb21tcy5jbGFzc2VzLmRlZXNjb21tcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2RlZXMtY29tbXMuY2xhc3Nlcy5kZWVzY29tbXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSx5QkFBeUIsQ0FBQztBQUVuRCxJQUFJLGdCQUFnQixHQUFHLFVBQVUsQ0FBQyxnQkFBZ0IsQ0FBQztBQUNuRCxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQztJQUN0QixnQkFBZ0IsR0FBRyxPQUFPLENBQUMsd0JBQStCLENBQUM7QUFDN0QsQ0FBQztBQUVEOztHQUVHO0FBQ0gsTUFBTSxPQUFPLFNBQVM7SUFZcEIscUJBQXFCO0lBQ3JCO1FBWlEscUJBQWdCLEdBQUcsSUFBSSxnQkFBZ0IsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUU5RCxtQkFBbUI7UUFDWixnQkFBVyxHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUNyRCxnQkFBVyxHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUM7WUFDeEQseUJBQXlCLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRSxFQUFFO2dCQUM5QyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1lBQy9CLENBQUM7WUFDRCxjQUFjLEVBQUUsSUFBSSxDQUFDLFdBQVc7U0FDakMsQ0FBQyxDQUFDO1FBSUQsSUFBSSxDQUFDLGdCQUFnQixDQUFDLFNBQVMsR0FBRyxLQUFLLEVBQUUsUUFBUSxFQUFFLEVBQUU7WUFDbkQsTUFBTSxPQUFPLEdBQUksUUFBZ0IsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQztZQUNwRSxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztZQUNyQyx1RUFBdUU7WUFDdkUsaURBQWlEO1lBQ2pELE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBSSxDQUFDLFdBQVcsQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztZQUMxRixJQUFJLFFBQVEsSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsQ0FBQztnQkFDaEMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUM3QixDQUFDO2lCQUFNLENBQUM7Z0JBQ04seUJBQXlCO1lBQzNCLENBQUM7UUFDSCxDQUFDLENBQUM7SUFDSixDQUFDO0lBRUQ7O09BRUc7SUFDSSxrQkFBa0IsQ0FDdkIsVUFBdUI7UUFFdkIsTUFBTSxZQUFZLEdBQUcsSUFBSSxPQUFPLENBQUMsWUFBWSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBQ3pGLE9BQU8sWUFBWSxDQUFDO0lBQ3RCLENBQUM7SUFFRDs7T0FFRztJQUNJLEtBQUssQ0FBQyxXQUFXLENBQ3RCLFVBQWE7UUFFYixJQUFJLENBQUMsZ0JBQWdCLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFFRDs7T0FFRztJQUNJLEtBQUssQ0FBQyxrQkFBa0IsQ0FDN0IsU0FBc0IsRUFDdEIsZUFBeUQ7UUFFekQsSUFBSSxDQUFDLFdBQVcsQ0FBQyxlQUFlLENBQzlCLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUksU0FBUyxFQUFFLGVBQWUsQ0FBQyxDQUNyRSxDQUFDO0lBQ0osQ0FBQztDQUNGIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVlcy1jb21tcy5jbGFzc2VzLmRlZXNjb21tcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2RlZXMtY29tbXMuY2xhc3Nlcy5kZWVzY29tbXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSx5QkFBeUIsQ0FBQztBQUVuRCxJQUFJLGdCQUFnQixHQUFHLFVBQVUsQ0FBQyxnQkFBZ0IsQ0FBQztBQUNuRCxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsQ0FBQztJQUN0QixnQkFBZ0IsR0FBRyxPQUFPLENBQUMsd0JBQStCLENBQUM7QUFDN0QsQ0FBQztBQUVEOztHQUVHO0FBQ0gsTUFBTSxPQUFPLFNBQVM7SUFZcEIscUJBQXFCO0lBQ3JCO1FBWlEscUJBQWdCLEdBQUcsSUFBSSxnQkFBZ0IsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUU5RCxtQkFBbUI7UUFDWixnQkFBVyxHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUNyRCxnQkFBVyxHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUM7WUFDeEQseUJBQXlCLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRSxFQUFFO2dCQUM5QyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1lBQy9CLENBQUM7WUFDRCxjQUFjLEVBQUUsSUFBSSxDQUFDLFdBQVc7U0FDakMsQ0FBQyxDQUFDO1FBSUQsSUFBSSxDQUFDLGdCQUFnQixDQUFDLFNBQVMsR0FBRyxLQUFLLEVBQUUsUUFBUSxFQUFFLEVBQUU7WUFDbkQsTUFBTSxPQUFPLEdBQUksUUFBZ0IsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQztZQUNwRSx1RUFBdUU7WUFDdkUsaURBQWlEO1lBQ2pELE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBSSxDQUFDLFdBQVcsQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUU7Z0JBQ25FLFNBQVMsRUFBRSxJQUFJO2FBQ2hCLENBQUMsQ0FBQztZQUNILElBQUksUUFBUSxJQUFJLENBQUMsUUFBUSxDQUFDLEtBQUssRUFBRSxDQUFDO2dCQUNoQyxJQUFJLENBQUMsV0FBVyxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQzdCLENBQUM7UUFDSCxDQUFDLENBQUM7SUFDSixDQUFDO0lBRUQ7O09BRUc7SUFDSSxrQkFBa0IsQ0FDdkIsVUFBdUI7UUFFdkIsTUFBTSxZQUFZLEdBQUcsSUFBSSxPQUFPLENBQUMsWUFBWSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBQ3pGLE9BQU8sWUFBWSxDQUFDO0lBQ3RCLENBQUM7SUFFRDs7T0FFRztJQUNJLEtBQUssQ0FBQyxXQUFXLENBQ3RCLFVBQWE7UUFFYixJQUFJLENBQUMsZ0JBQWdCLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFFRDs7T0FFRztJQUNJLEtBQUssQ0FBQyxrQkFBa0IsQ0FDN0IsU0FBc0IsRUFDdEIsZUFBeUQ7UUFFekQsSUFBSSxDQUFDLFdBQVcsQ0FBQyxlQUFlLENBQzlCLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUksU0FBUyxFQUFFLGVBQWUsQ0FBQyxDQUNyRSxDQUFDO0lBQ0osQ0FBQztDQUNGIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@design.estate/dees-comms",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "private": false,
   "description": "A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.",
   "main": "dist_ts/index.js",
@@ -9,16 +9,15 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "devDependencies": {
-    "@git.zone/tsbuild": "^3.1.2",
-    "@git.zone/tsbundle": "^2.6.3",
-    "@git.zone/tsrun": "^2.0.0",
-    "@git.zone/tstest": "^3.1.3",
-    "@push.rocks/tapbundle": "^6.0.3",
-    "@types/node": "^24.10.1"
+    "@git.zone/tsbuild": "^4.4.2",
+    "@git.zone/tsbundle": "^2.11.3",
+    "@git.zone/tsrun": "^2.0.6",
+    "@git.zone/tstest": "^3.6.7",
+    "@types/node": "^26.1.1"
   },
   "dependencies": {
-    "@api.global/typedrequest": "^3.2.3",
-    "@api.global/typedrequest-interfaces": "^3.0.19",
+    "@api.global/typedrequest": "^3.8.0",
+    "@api.global/typedrequest-interfaces": "^4.0.0",
     "@push.rocks/smartdelay": "^3.0.5",
     "broadcast-channel": "^7.2.0"
   },
@@ -31,7 +30,7 @@
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
-    "npmextra.json",
+    ".smartconfig.json",
     "readme.md"
   ],
   "browserslist": [
@@ -51,6 +50,6 @@
   ],
   "scripts": {
     "test": "(tstest test/ --verbose)",
-    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)"
+    "build": "(tsbuild --web && tsbundle)"
   }
 }

package/readme.md

@@ -1,11 +1,17 @@
 # @design.estate/dees-comms
+
 a comms module for communicating within the DOM
 
+## Issue Reporting and Security
+
+For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
+
 ## Install
+
 To integrate `@design.estate/dees-comms` into your project, run the following command in your terminal:
 
 ```bash
-npm install @design.estate/dees-comms --save
+pnpm add @design.estate/dees-comms
 ```
 
 This will add the package to your project dependencies. 
@@ -20,6 +26,16 @@ First, make sure to import the module in your TypeScript file:
 
 ```typescript
 import { DeesComms } from '@design.estate/dees-comms';
+
+interface IMyMessage {
+  method: 'myMethod';
+  request: {
+    someData: string;
+  };
+  response: {
+    reply: string;
+  };
+}
 ```
 
 ### Initializing the Communication Module
@@ -35,21 +51,14 @@ const myDeesComms = new DeesComms();
 To send messages, you'll need to create a typed request. Let's assume we are sending a message that requires a response:
 
 ```typescript
-// Define the message type
-interface MyMessageType {
-  method: 'myMethod';
-  someData: string;
-}
-
 // Creating a typed request
-const myTypedRequest = myDeesComms.createTypedRequest<MyMessageType>('myMethod');
+const myTypedRequest = myDeesComms.createTypedRequest<IMyMessage>('myMethod');
 
 // Firing the request
-myTypedRequest.fire({
+const response = await myTypedRequest.fire({
   someData: 'Hello, World!',
-}).then(response => {
-  console.log('Received response:', response);
 });
+console.log('Received response:', response.reply);
 ```
 
 ### Receiving and Handling Messages
@@ -58,14 +67,14 @@ To handle incoming messages, you need to define handlers for the types of messag
 
 ```typescript
 // Define the handler for the 'myMethod' message
-myDeesComms.createTypedHandler<MyMessageType>('myMethod', async (incomingMessage) => {
-  console.log('Message received:', incomingMessage);
+myDeesComms.createTypedHandler<IMyMessage>('myMethod', async (request) => {
+  console.log('Message received:', request.someData);
   
   // Process the incoming message...
   
   // Return a response (if needed)
   return {
-    response: 'Message received loud and clear!'
+    reply: 'Message received loud and clear!'
   };
 });
 ```
@@ -74,15 +83,6 @@ myDeesComms.createTypedHandler<MyMessageType>('myMethod', async (incomingMessage
 
 `@design.estate/dees-comms` uses the Broadcast Channel API and a polyfill for environments where it's not available, enabling seamless communication between different contexts like tabs, iframes, or web workers.
 
-### Clean Up
-
-When you're done with communication, or before creating a new instance for any reason, ensure you clean up properly to prevent memory leaks or other unexpected behaviors:
-
-```typescript
-// Currently, the cleanup should be handled according to the specific needs of your application
-// e.g., closing or nullifying references to the DeesComms instance.
-```
-
 ### Complete Example
 
 Putting it all together, let's create a small application that sends a message and listens for a response:
@@ -90,38 +90,49 @@ Putting it all together, let's create a small application that sends a message a
 ```typescript
 import { DeesComms } from '@design.estate/dees-comms';
 
+interface IGreetRequest {
+  method: 'greet';
+  request: {
+    name: string;
+  };
+  response: {
+    reply: string;
+  };
+}
+
 const appDeesComms = new DeesComms();
 
 // Setting up the listener
-appDeesComms.createTypedHandler<{ method: 'greet'; name: string }>('greet', async (message) => {
-  console.log(`Greetings received from ${message.name}`);
-  return { reply: `Hello ${message.name}, nice to meet you!` };
+appDeesComms.createTypedHandler<IGreetRequest>('greet', async (request) => {
+  console.log(`Greetings received from ${request.name}`);
+  return { reply: `Hello ${request.name}, nice to meet you!` };
 });
 
 // Sending a greeting message
-const greetRequest = appDeesComms.createTypedRequest<{ method: 'greet'; name: string }>('greet');
-greetRequest.fire({ name: 'Alice' }).then(response => {
-  console.log(response.reply); // Expected output: "Hello Alice, nice to meet you!"
-});
+const greetRequest = appDeesComms.createTypedRequest<IGreetRequest>('greet');
+const response = await greetRequest.fire({ name: 'Alice' });
+console.log(response.reply); // Expected output: "Hello Alice, nice to meet you!"
 ```
 
 This module provides a powerful and flexible way to handle communications within the DOM, leveraging modern JavaScript features and patterns. The usage of TypeScript ensures type safety and enhances code understandability and maintainability.
 
 ## License and Legal Information
 
-This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.
 
 **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
 
 ### Trademarks
 
-This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
 
 ### Company Information
 
-Task Venture Capital GmbH  
-Registered at District court Bremen HRB 35230 HB, Germany
+Task Venture Capital GmbH<br>
+Registered at District Court Bremen HRB 35230 HB, Germany
 
-For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
 
 By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@design.estate/dees-comms',
-  version: '1.0.30',
+  version: '1.0.31',
   description: 'A communications module for enabling DOM-based messaging and synchronization across browser tabs and workers.'
 }

package/ts/dees-comms.classes.deescomms.ts

@@ -24,14 +24,13 @@ export class DeesComms {
   constructor() {
     this.broadcastChannel.onmessage = async (eventArg) => {
       const message = (eventArg as any).method ? eventArg : eventArg.data;
-      console.log(JSON.stringify(message));
       // Skip hooks for broadcast-received messages to prevent infinite loops
       // when traffic logging hooks are set up globally
-      const response = await this.typedrouter.routeAndAddResponse(message, { skipHooks: true });
+      const response = await this.typedrouter.routeAndAddResponse(message, {
+        skipHooks: true,
+      });
       if (response && !response.error) {
         this.postMessage(response);
-      } else {
-        // console.log(response);
       }
     };
   }