@design.estate/dees-comms 1.0.24

package/dist_ts/00_commitinfo_data.d.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export declare const commitinfo: {
+    name: string;
+    version: string;
+    description: string;
+};

package/dist_ts/00_commitinfo_data.js

@@ -0,0 +1,9 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+    name: '@design.estate/dees-comms',
+    version: '1.0.24',
+    description: 'a comms module for communicating within the DOM'
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSwyQkFBMkI7SUFDakMsT0FBTyxFQUFFLFFBQVE7SUFDakIsV0FBVyxFQUFFLGlEQUFpRDtDQUMvRCxDQUFBIn0=

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

@@ -0,0 +1,22 @@
+import * as plugins from './dees-comms.plugins.js';
+/**
+ * a comm class for client side communication between workers and tabs.
+ */
+export declare class DeesComms {
+    private broadcastChannel;
+    typedrouter: plugins.typedrequest.TypedRouter;
+    typedtarget: plugins.typedrequest.TypedTarget;
+    constructor();
+    /**
+     * creates a typedrequest with this classes postMessage as postMethod
+     */
+    createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest>(methodName: T['method']): plugins.typedrequest.TypedRequest<T>;
+    /**
+     * posts a typedrequestmessage
+     */
+    postMessage<T = plugins.typedrequestInterfaces.ITypedRequest>(messageArg: T): Promise<void>;
+    /**
+     * subscribe to messages
+     */
+    createTypedHandler<T extends plugins.typedrequestInterfaces.ITypedRequest>(methodArg: T['method'], handlerFunction: plugins.typedrequest.THandlerFunction<T>): Promise<void>;
+}

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

@@ -0,0 +1,53 @@
+import * as plugins from './dees-comms.plugins.js';
+let BroadcastChannel = globalThis.BroadcastChannel;
+if (!BroadcastChannel) {
+    BroadcastChannel = plugins.BroadCastChannelPolyfill;
+}
+/**
+ * a comm class for client side communication between workers and tabs.
+ */
+export class DeesComms {
+    // receiving messages
+    constructor() {
+        this.broadcastChannel = new BroadcastChannel('dees-comms');
+        // sending messages
+        this.typedrouter = new plugins.typedrequest.TypedRouter();
+        this.typedtarget = new plugins.typedrequest.TypedTarget({
+            postMethodWithTypedRouter: async (messageArg) => {
+                this.postMessage(messageArg);
+            },
+            typedRouterRef: this.typedrouter,
+        });
+        this.broadcastChannel.onmessage = async (eventArg) => {
+            const message = eventArg.method ? eventArg : eventArg.data;
+            console.log(JSON.stringify(message));
+            const response = await this.typedrouter.routeAndAddResponse(message);
+            if (response && !response.error) {
+                this.postMessage(response);
+            }
+            else {
+                // console.log(response);
+            }
+        };
+    }
+    /**
+     * creates a typedrequest with this classes postMessage as postMethod
+     */
+    createTypedRequest(methodName) {
+        const typedrequest = new plugins.typedrequest.TypedRequest(this.typedtarget, methodName);
+        return typedrequest;
+    }
+    /**
+     * posts a typedrequestmessage
+     */
+    async postMessage(messageArg) {
+        this.broadcastChannel.postMessage(messageArg);
+    }
+    /**
+     * subscribe to messages
+     */
+    async createTypedHandler(methodArg, handlerFunction) {
+        this.typedrouter.addTypedHandler(new plugins.typedrequest.TypedHandler(methodArg, handlerFunction));
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVlcy1jb21tcy5jbGFzc2VzLmRlZXNjb21tcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2RlZXMtY29tbXMuY2xhc3Nlcy5kZWVzY29tbXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE9BQU8sTUFBTSx5QkFBeUIsQ0FBQztBQUVuRCxJQUFJLGdCQUFnQixHQUFHLFVBQVUsQ0FBQyxnQkFBZ0IsQ0FBQztBQUNuRCxJQUFJLENBQUMsZ0JBQWdCLEVBQUU7SUFDckIsZ0JBQWdCLEdBQUcsT0FBTyxDQUFDLHdCQUErQixDQUFDO0NBQzVEO0FBRUQ7O0dBRUc7QUFDSCxNQUFNLE9BQU8sU0FBUztJQVlwQixxQkFBcUI7SUFDckI7UUFaUSxxQkFBZ0IsR0FBRyxJQUFJLGdCQUFnQixDQUFDLFlBQVksQ0FBQyxDQUFDO1FBRTlELG1CQUFtQjtRQUNaLGdCQUFXLEdBQUcsSUFBSSxPQUFPLENBQUMsWUFBWSxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQ3JELGdCQUFXLEdBQUcsSUFBSSxPQUFPLENBQUMsWUFBWSxDQUFDLFdBQVcsQ0FBQztZQUN4RCx5QkFBeUIsRUFBRSxLQUFLLEVBQUUsVUFBVSxFQUFFLEVBQUU7Z0JBQzlDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7WUFDL0IsQ0FBQztZQUNELGNBQWMsRUFBRSxJQUFJLENBQUMsV0FBVztTQUNqQyxDQUFDLENBQUM7UUFJRCxJQUFJLENBQUMsZ0JBQWdCLENBQUMsU0FBUyxHQUFHLEtBQUssRUFBRSxRQUFRLEVBQUUsRUFBRTtZQUNuRCxNQUFNLE9BQU8sR0FBSSxRQUFnQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDO1lBQ3BFLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO1lBQ3JDLE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBSSxDQUFDLFdBQVcsQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLENBQUMsQ0FBQztZQUNyRSxJQUFJLFFBQVEsSUFBSSxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUU7Z0JBQy9CLElBQUksQ0FBQyxXQUFXLENBQUMsUUFBUSxDQUFDLENBQUM7YUFDNUI7aUJBQU07Z0JBQ0wseUJBQXlCO2FBQzFCO1FBQ0gsQ0FBQyxDQUFDO0lBQ0osQ0FBQztJQUVEOztPQUVHO0lBQ0ksa0JBQWtCLENBQ3ZCLFVBQXVCO1FBRXZCLE1BQU0sWUFBWSxHQUFHLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsRUFBRSxVQUFVLENBQUMsQ0FBQztRQUN6RixPQUFPLFlBQVksQ0FBQztJQUN0QixDQUFDO0lBRUQ7O09BRUc7SUFDSSxLQUFLLENBQUMsV0FBVyxDQUN0QixVQUFhO1FBRWIsSUFBSSxDQUFDLGdCQUFnQixDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUNoRCxDQUFDO0lBRUQ7O09BRUc7SUFDSSxLQUFLLENBQUMsa0JBQWtCLENBQzdCLFNBQXNCLEVBQ3RCLGVBQXlEO1FBRXpELElBQUksQ0FBQyxXQUFXLENBQUMsZUFBZSxDQUM5QixJQUFJLE9BQU8sQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFJLFNBQVMsRUFBRSxlQUFlLENBQUMsQ0FDckUsQ0FBQztJQUNKLENBQUM7Q0FDRiJ9

package/dist_ts/dees-comms.deescommsmessage.d.ts

@@ -0,0 +1,5 @@
+/**
+ * a message that can be sent
+ */
+export declare class DeesCommsMessage {
+}

package/dist_ts/dees-comms.deescommsmessage.js

@@ -0,0 +1,7 @@
+import * as plugins from './dees-comms.plugins.js';
+/**
+ * a message that can be sent
+ */
+export class DeesCommsMessage {
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVlcy1jb21tcy5kZWVzY29tbXNtZXNzYWdlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvZGVlcy1jb21tcy5kZWVzY29tbXNtZXNzYWdlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxPQUFPLE1BQU0seUJBQXlCLENBQUM7QUFFbkQ7O0dBRUc7QUFDSCxNQUFNLE9BQU8sZ0JBQWdCO0NBQUcifQ==

package/dist_ts/dees-comms.plugins.d.ts

@@ -0,0 +1,6 @@
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
+import * as typedrequest from '@api.global/typedrequest';
+export { smartdelay, typedrequestInterfaces, typedrequest };
+import { BroadcastChannel as BroadCastChannelPolyfill } from 'broadcast-channel';
+export { BroadCastChannelPolyfill };

package/dist_ts/dees-comms.plugins.js

@@ -0,0 +1,9 @@
+// pushrocks scope
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
+import * as typedrequest from '@api.global/typedrequest';
+export { smartdelay, typedrequestInterfaces, typedrequest };
+// third party scope
+import { BroadcastChannel as BroadCastChannelPolyfill } from 'broadcast-channel';
+export { BroadCastChannelPolyfill };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVlcy1jb21tcy5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvZGVlcy1jb21tcy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGtCQUFrQjtBQUNsQixPQUFPLEtBQUssVUFBVSxNQUFNLHdCQUF3QixDQUFDO0FBQ3JELE9BQU8sS0FBSyxzQkFBc0IsTUFBTSxxQ0FBcUMsQ0FBQztBQUM5RSxPQUFPLEtBQUssWUFBWSxNQUFNLDBCQUEwQixDQUFDO0FBRXpELE9BQU8sRUFBRSxVQUFVLEVBQUUsc0JBQXNCLEVBQUUsWUFBWSxFQUFFLENBQUM7QUFFNUQsb0JBQW9CO0FBQ3BCLE9BQU8sRUFBRSxnQkFBZ0IsSUFBSSx3QkFBd0IsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBRWpGLE9BQU8sRUFDTCx3QkFBd0IsRUFDekIsQ0FBQSJ9

package/dist_ts/index.d.ts

@@ -0,0 +1 @@
+export * from './dees-comms.classes.deescomms.js';

package/dist_ts/index.js

@@ -0,0 +1,2 @@
+export * from './dees-comms.classes.deescomms.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLG1DQUFtQyxDQUFDIn0=

package/license

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/npmextra.json

@@ -0,0 +1,18 @@
+{
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "design.estate",
+      "gitrepo": "dees-comms",
+      "shortDescription": "a comms module for communicating within the DOM",
+      "npmPackagename": "@design.estate/dees-comms",
+      "license": "MIT",
+      "projectDomain": "design.estate"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@design.estate/dees-comms",
+  "version": "1.0.24",
+  "private": false,
+  "description": "a comms module for communicating within the DOM",
+  "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 --allowimplicitany && tsbundle npm)"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsbundle": "^2.0.8",
+    "@gitzone/tsrun": "^1.2.44",
+    "@gitzone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.0.12",
+    "@types/node": "^20.4.8"
+  },
+  "dependencies": {
+    "@api.global/typedrequest": "^3.0.1",
+    "@api.global/typedrequest-interfaces": "^3.0.1",
+    "@push.rocks/smartdelay": "^3.0.5",
+    "broadcast-channel": "^3.7.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
+}

package/readme.md

@@ -0,0 +1,39 @@
+# @designestate/dees-comms
+a comms module for communicating within the DOM
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@designestate/dees-comms)
+* [gitlab.com (source)](https://gitlab.com/designestate/dees-comms)
+* [github.com (source mirror)](https://github.com/designestate/dees-comms)
+* [docs (typedoc)](https://designestate.gitlab.io/dees-comms/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/designestate/dees-comms/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/designestate/dees-comms/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@designestate/dees-comms)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/designestate/dees-comms)](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/@designestate/dees-comms)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@designestate/dees-comms)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@designestate/dees-comms)](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
+
+Use TypeScript for best in class intellisense
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| 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)

package/ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@design.estate/dees-comms',
+  version: '1.0.24',
+  description: 'a comms module for communicating within the DOM'
+}

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

@@ -0,0 +1,67 @@
+import * as plugins from './dees-comms.plugins.js';
+
+let BroadcastChannel = globalThis.BroadcastChannel;
+if (!BroadcastChannel) {
+  BroadcastChannel = plugins.BroadCastChannelPolyfill as any;
+}
+
+/**
+ * a comm class for client side communication between workers and tabs.
+ */
+export class DeesComms {
+  private broadcastChannel = new BroadcastChannel('dees-comms');
+  
+  // sending messages
+  public typedrouter = new plugins.typedrequest.TypedRouter();
+  public typedtarget = new plugins.typedrequest.TypedTarget({
+    postMethodWithTypedRouter: async (messageArg) => {
+      this.postMessage(messageArg);
+    },
+    typedRouterRef: this.typedrouter,
+  });
+
+  // receiving messages
+  constructor() {
+    this.broadcastChannel.onmessage = async (eventArg) => {
+      const message = (eventArg as any).method ? eventArg : eventArg.data;
+      console.log(JSON.stringify(message));
+      const response = await this.typedrouter.routeAndAddResponse(message);
+      if (response && !response.error) {
+        this.postMessage(response);
+      } else {
+        // console.log(response);
+      }
+    };
+  }
+
+  /**
+   * creates a typedrequest with this classes postMessage as postMethod
+   */
+  public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest>(
+    methodName: T['method']
+  ): plugins.typedrequest.TypedRequest<T> {
+    const typedrequest = new plugins.typedrequest.TypedRequest(this.typedtarget, methodName);
+    return typedrequest;
+  }
+
+  /**
+   * posts a typedrequestmessage
+   */
+  public async postMessage<T = plugins.typedrequestInterfaces.ITypedRequest>(
+    messageArg: T
+  ): Promise<void> {
+    this.broadcastChannel.postMessage(messageArg);
+  }
+
+  /**
+   * subscribe to messages
+   */
+  public async createTypedHandler<T extends plugins.typedrequestInterfaces.ITypedRequest>(
+    methodArg: T['method'],
+    handlerFunction: plugins.typedrequest.THandlerFunction<T>
+  ) {
+    this.typedrouter.addTypedHandler(
+      new plugins.typedrequest.TypedHandler<T>(methodArg, handlerFunction)
+    );
+  }
+}

package/ts/dees-comms.deescommsmessage.ts

@@ -0,0 +1,6 @@
+import * as plugins from './dees-comms.plugins.js';
+
+/**
+ * a message that can be sent
+ */
+export class DeesCommsMessage {}

package/ts/dees-comms.plugins.ts

@@ -0,0 +1,13 @@
+// pushrocks scope
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
+import * as typedrequest from '@api.global/typedrequest';
+
+export { smartdelay, typedrequestInterfaces, typedrequest };
+
+// third party scope
+import { BroadcastChannel as BroadCastChannelPolyfill } from 'broadcast-channel';
+
+export {
+  BroadCastChannelPolyfill
+}

package/ts/index.ts

@@ -0,0 +1 @@
+export * from './dees-comms.classes.deescomms.js';