osra 0.0.1 → 0.0.4

package/README.md

@@ -0,0 +1,60 @@
+# osra
+what that? https://github.com/GoogleChromeLabs/comlink but nicer to use.
+thats about it
+
+how to?
+register your functions in the other context like so
+```ts
+import { makeCallListener, registerListener } from 'osra'
+
+const resolvers = {
+  'test': makeCallListener(async (myData) => {
+    // do work...
+    return {
+      foo: 1,
+      bar: 'bar',
+      baz: () => true
+    }
+  })
+}
+
+registerListener({ target: globalThis, resolvers })
+```
+
+and on your current context you can call it easily like
+```ts
+import { call } from 'osra'
+
+const worker = new Worker('/worker.js', { type: 'module' })
+
+call(worker)('test', { theDataThatWillBeSentToTheOtherContext: 1 })
+      .then(({ foo, bar, baz }) => {
+        // foo === 1
+        // bar === 'bar'
+        // baz === callable function that will return a promise with its response
+      })
+```
+
+all types of data supported by osra that will be correctly proxied/sent to the other context in addition of functions:
+
+```ts
+export type TransferableObject =
+  ArrayBuffer | MessagePort | ReadableStream | WritableStream |
+  TransformStream | /* AudioData | */ ImageBitmap /* | VideoFrame | OffscreenCanvas */
+
+export interface StructuredCloneObject {
+  [key: string | number | symbol]: StructuredCloneType
+}
+
+export type StructuredCloneType =
+  boolean | null | undefined | number | BigInt | string | Date | RegExp | Blob | File | FileList | ArrayBuffer | ArrayBufferView |
+  ImageBitmap | ImageData | Array<StructuredCloneType> | StructuredCloneObject | Map<StructuredCloneType, StructuredCloneType> | Set<StructuredCloneType>
+
+export interface StructruredCloneTransferableObject {
+  [key: string | number | symbol]: StructruredCloneTransferableType
+}
+
+export type StructruredCloneTransferableType =
+  StructuredCloneType | TransferableObject | Array<StructruredCloneTransferableType> | StructruredCloneTransferableObject |
+  Map<StructruredCloneTransferableType, StructruredCloneTransferableType> | Set<StructruredCloneTransferableType>
+```

package/build/index.js

@@ -6,6 +6,7 @@ var registerListener = ({
   target,
   resolvers,
   filter,
+  map,
   key = MESSAGE_SOURCE_KEY
 }) => {
   const listener = async (event) => {
@@ -19,7 +20,10 @@ var registerListener = ({
     const resolver = resolvers[type];
     if (!resolver)
       throw new Error(`Osra received a message of type "${type}" but no resolver was found for type.`);
-    resolver(data, { event, type, port });
+    if (map)
+      resolver(...map(data, { event, type, port }));
+    else
+      resolver(data, { event, type, port });
   };
   target.addEventListener("message", listener);
   return {
@@ -29,7 +33,7 @@ var registerListener = ({
 };
 
 // src/utils.ts
-var isTransferable = (value) => value instanceof ArrayBuffer ? true : value instanceof MessagePort ? true : value instanceof ReadableStream ? true : value instanceof WritableStream ? true : value instanceof TransformStream ? true : value instanceof ImageBitmap ? true : false;
+var isTransferable = (value) => globalThis.ArrayBuffer && value instanceof globalThis.ArrayBuffer ? true : globalThis.MessagePort && value instanceof globalThis.MessagePort ? true : globalThis.ReadableStream && value instanceof globalThis.ReadableStream ? true : globalThis.WritableStream && value instanceof globalThis.WritableStream ? true : globalThis.TransformStream && value instanceof globalThis.TransformStream ? true : globalThis.ImageBitmap && value instanceof globalThis.ImageBitmap ? true : false;
 var getTransferableObjects = (value) => {
   const transferables = [];
   const recurse = (value2) => isTransferable(value2) ? transferables.push(value2) : Array.isArray(value2) ? value2.map(recurse) : value2 && typeof value2 === "object" ? Object.values(value2).map(recurse) : void 0;
@@ -39,11 +43,15 @@ var getTransferableObjects = (value) => {
 var PROXY_FUNCTION_PROPERTY = "__proxyFunctionPort__";
 var makeProxyFunction = (func) => {
   const { port1, port2 } = new MessageChannel();
-  port1.addEventListener("message", (ev) => {
-    const result = func(...ev.data);
-    const proxiedResult = proxyObjectFunctions(result);
-    const transferables = getTransferableObjects(proxiedResult);
-    port1.postMessage(proxiedResult, { transfer: transferables });
+  port1.addEventListener("message", async (ev) => {
+    try {
+      const result = await func(...ev.data);
+      const proxiedResult = proxyObjectFunctions(result);
+      const transferables = getTransferableObjects(proxiedResult);
+      port1.postMessage({ result: proxiedResult }, { transfer: transferables });
+    } catch (err) {
+      port1.postMessage({ error: err });
+    }
   });
   port1.start();
   return port2;
@@ -56,7 +64,10 @@ var makeProxiedFunction = (port) => (...args) => new Promise((resolve, reject) =
   const proxiedArguments = proxyObjectFunctions(args);
   const transferables = getTransferableObjects(proxiedArguments);
   port.addEventListener("message", (ev) => {
-    resolve(makeObjectProxiedFunctions(ev.data));
+    if (ev.data.error)
+      reject(ev.data.error);
+    else
+      resolve(makeObjectProxiedFunctions(ev.data.result));
   });
   port.start();
   port.postMessage(proxiedArguments, { transfer: transferables });
@@ -67,11 +78,15 @@ var makeObjectProxiedFunctions = (value) => isTransferable(value) ? value : valu
 ])) : value;
 
 // src/call.ts
-var call = (target, { key = MESSAGE_SOURCE_KEY } = { key: MESSAGE_SOURCE_KEY }) => (type, data) => new Promise((resolve) => {
+var call = (target, { key = MESSAGE_SOURCE_KEY } = { key: MESSAGE_SOURCE_KEY }) => (type, data) => new Promise((resolve, reject) => {
   const { port1, port2 } = new MessageChannel();
   port1.addEventListener("message", ({ data: data2 }) => {
-    const proxiedData2 = makeObjectProxiedFunctions(data2);
-    resolve(proxiedData2);
+    if (data2.error) {
+      reject(data2.error);
+    } else {
+      const proxiedData2 = makeObjectProxiedFunctions(data2.result);
+      resolve(proxiedData2);
+    }
     port1.close();
     port2.close();
   }, { once: true });
@@ -81,7 +96,7 @@ var call = (target, { key = MESSAGE_SOURCE_KEY } = { key: MESSAGE_SOURCE_KEY })
   target.postMessage({
     source: key,
     type,
-    data,
+    data: proxiedData,
     port: port2
   }, {
     targetOrigin: "*",
@@ -91,12 +106,18 @@ var call = (target, { key = MESSAGE_SOURCE_KEY } = { key: MESSAGE_SOURCE_KEY })
 var makeCallListener = (func) => async (data, extra) => {
   const { port } = extra;
   const proxiedData = makeObjectProxiedFunctions(data);
-  const result = await func(proxiedData, extra);
-  const proxyData = proxyObjectFunctions(result);
-  const transferables = getTransferableObjects(proxyData);
-  port.postMessage(proxyData, { transfer: transferables });
-  port.close();
-  return result;
+  try {
+    const result = await func(proxiedData, extra);
+    const proxyData = proxyObjectFunctions(result);
+    const transferables = getTransferableObjects(proxyData);
+    port.postMessage({ result: proxyData }, { transfer: transferables });
+    port.close();
+    return result;
+  } catch (error) {
+    port.postMessage({ error });
+    port.close();
+    throw error;
+  }
 };
 export {
   call,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "osra",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "Easy communication between workers",
   "files": [
     "./build"
@@ -11,7 +11,12 @@
     "type-check-watch": "tsc --watch --incremental",
     "build": "esbuild ./src/index.ts --format=esm --bundle --outfile=build/index.js && npm run type-check",
     "build-watch": "esbuild --watch ./src/index.ts --format=esm --bundle --outfile=build/index.js",
-    "dev": "concurrently \"npm run build-watch\" \"npm run type-check-watch\""
+    "dev": "concurrently \"npm run build-watch\" \"npm run type-check-watch\"",
+    "copy-tests-html": "copyfiles -u 1 ./tests/*/index.html tests/build",
+    "build-tests": "npm run copy-tests-html && esbuild ./tests/call/iframe.ts ./tests/event-channel/iframe.ts --format=esm --bundle --outdir=tests/build",
+    "build-tests-watch": "npm run copy-tests-html && esbuild --watch ./tests/call/iframe.ts ./tests/event-channel/iframe.ts --format=esm --bundle --outdir=tests/build",
+    "test": "epk",
+    "test-watch": "epk -w"
   },
   "repository": {
     "type": "git",
@@ -24,8 +29,15 @@
   },
   "homepage": "https://github.com/Banou26/osra#readme",
   "devDependencies": {
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/node": "^17.0.35",
+    "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
     "concurrently": "^7.0.0",
+    "copyfiles": "^2.4.1",
+    "epk": "^0.16.0",
     "esbuild": "^0.14.28",
+    "mime": "^3.0.0",
     "typescript": "^4.6.3"
   }
 }