@lvce-editor/ipc 9.5.1 → 10.0.1

package/dist/browser.js

@@ -2,6 +2,65 @@ const getData$1 = event => {
   return event.data;
 };
 
+const walkValue = (value, transferrables, isTransferrable) => {
+  if (!value) {
+    return;
+  }
+  if (isTransferrable(value)) {
+    transferrables.push(value);
+    return;
+  }
+  if (Array.isArray(value)) {
+    for (const item of value) {
+      walkValue(item, transferrables, isTransferrable);
+    }
+    return;
+  }
+  if (typeof value === 'object') {
+    for (const property of Object.values(value)) {
+      walkValue(property, transferrables, isTransferrable);
+    }
+    return;
+  }
+};
+
+const isMessagePort = value => {
+  return value && value instanceof MessagePort;
+};
+
+const isMessagePortMain = value => {
+  return value && value.constructor && value.constructor.name === 'MessagePortMain';
+};
+
+const isOffscreenCanvas = value => {
+  return typeof OffscreenCanvas !== 'undefined' && value instanceof OffscreenCanvas;
+};
+
+const isInstanceOf = (value, constructorName) => {
+  return value?.constructor?.name === constructorName;
+};
+
+const isSocket = value => {
+  return isInstanceOf(value, 'Socket');
+};
+
+const transferrables = [isMessagePort, isMessagePortMain, isOffscreenCanvas, isSocket];
+
+const isTransferrable = value => {
+  for (const fn of transferrables) {
+    if (fn(value)) {
+      return true;
+    }
+  }
+  return false;
+};
+
+const getTransferrables = value => {
+  const transferrables = [];
+  walkValue(value, transferrables, isTransferrable);
+  return transferrables;
+};
+
 const attachEvents = that => {
   const handleMessage = (...args) => {
     const data = that.getData(...args);
@@ -44,7 +103,8 @@ class IpcChildWithModuleWorker extends Ipc {
     // @ts-ignore
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     // @ts-ignore
     this._rawIpc.postMessage(message, transfer);
   }
@@ -320,7 +380,8 @@ class IpcChildWithModuleWorkerAndMessagePort extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, transfer);
   }
   dispose() {
@@ -359,7 +420,8 @@ class IpcChildWithWindow extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, location.origin, transfer);
   }
   dispose() {
@@ -393,26 +455,15 @@ const IpcChildWithWindow$1 = {
   wrap: wrap$4
 };
 
-const isTransferrable = value => {
-  return value instanceof MessagePort;
-};
-
-const UntransferrableValue = {};
-
-const walkValue = (value, transferrables) => {
+const removeValues = (value, toRemove) => {
   if (!value) {
     return value;
   }
-  if (isTransferrable(value)) {
-    transferrables.push(value);
-    return UntransferrableValue;
-  }
   if (Array.isArray(value)) {
     const newItems = [];
     for (const item of value) {
-      const newItem = walkValue(item, transferrables);
-      if (newItem !== UntransferrableValue) {
-        newItems.push(newItem);
+      if (!toRemove.includes(item)) {
+        newItems.push(removeValues(item, toRemove));
       }
     }
     return newItems;
@@ -420,9 +471,8 @@ const walkValue = (value, transferrables) => {
   if (typeof value === 'object') {
     const newObject = Object.create(null);
     for (const [key, property] of Object.entries(value)) {
-      const newValue = walkValue(property, transferrables);
-      if (newValue !== UntransferrableValue) {
-        newObject[key] = newValue;
+      if (!toRemove.includes(property)) {
+        newObject[key] = removeValues(property, toRemove);
       }
     }
     return newObject;
@@ -434,8 +484,8 @@ const walkValue = (value, transferrables) => {
 // as parameters. If the transferrable object is a parameter, in electron
 // only an empty objected is received in the main process
 const fixElectronParameters = value => {
-  const transfer = [];
-  const newValue = walkValue(value, transfer);
+  const transfer = getTransferrables(value);
+  const newValue = removeValues(value, transfer);
   return {
     newValue,
     transfer
@@ -455,7 +505,7 @@ class IpcChildWithElectronWindow extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, _transfer) {
+  sendAndTransfer(message) {
     const {
       newValue,
       transfer
@@ -511,7 +561,8 @@ class IpcChildWithMessagePort extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, transfer);
   }
   dispose() {
@@ -663,7 +714,8 @@ class IpcParentWithModuleWorker extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, transfer);
   }
   dispose() {
@@ -727,7 +779,7 @@ class IpcParentWithWebSocket extends Ipc {
   send(message) {
     this._rawIpc.send(stringifyCompact(message));
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
     throw new Error('sendAndTransfer not supported');
   }
   dispose() {

package/dist/electron.js

@@ -26,12 +26,6 @@ const getType = value => {
       return 'unknown';
   }
 };
-const array = value => {
-  const type = getType(value);
-  if (type !== 'array') {
-    throw new AssertionError('expected value to be of type array');
-  }
-};
 const string = value => {
   const type = getType(value);
   if (type !== 'string') {
@@ -346,6 +340,65 @@ class IpcError extends VError {
   }
 }
 
+const walkValue = (value, transferrables, isTransferrable) => {
+  if (!value) {
+    return;
+  }
+  if (isTransferrable(value)) {
+    transferrables.push(value);
+    return;
+  }
+  if (Array.isArray(value)) {
+    for (const item of value) {
+      walkValue(item, transferrables, isTransferrable);
+    }
+    return;
+  }
+  if (typeof value === 'object') {
+    for (const property of Object.values(value)) {
+      walkValue(property, transferrables, isTransferrable);
+    }
+    return;
+  }
+};
+
+const isMessagePort = value => {
+  return value && value instanceof MessagePort;
+};
+
+const isMessagePortMain = value => {
+  return value && value.constructor && value.constructor.name === 'MessagePortMain';
+};
+
+const isOffscreenCanvas = value => {
+  return typeof OffscreenCanvas !== 'undefined' && value instanceof OffscreenCanvas;
+};
+
+const isInstanceOf = (value, constructorName) => {
+  return value?.constructor?.name === constructorName;
+};
+
+const isSocket = value => {
+  return isInstanceOf(value, 'Socket');
+};
+
+const transferrables = [isMessagePort, isMessagePortMain, isOffscreenCanvas, isSocket];
+
+const isTransferrable = value => {
+  for (const fn of transferrables) {
+    if (fn(value)) {
+      return true;
+    }
+  }
+  return false;
+};
+
+const getTransferrables = value => {
+  const transferrables = [];
+  walkValue(value, transferrables, isTransferrable);
+  return transferrables;
+};
+
 // @ts-ignore
 const create$2 = async ({
   path,
@@ -393,7 +446,8 @@ class IpcParentWithElectronUtilityProcess extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, transfer);
   }
   dispose() {
@@ -515,6 +569,14 @@ const getFirstNodeChildProcessEvent = async childProcess => {
   };
 };
 
+const getTransferrablesNode = value => {
+  const transferrables = getTransferrables(value);
+  if (transferrables.length === 0) {
+    throw new Error(`no transferrables found`);
+  }
+  return transferrables[0];
+};
+
 // @ts-ignore
 const create$1 = async ({
   path,
@@ -566,7 +628,8 @@ class IpcParentWithNodeForkedProcess extends Ipc {
   send(message) {
     this._rawIpc.send(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrablesNode(message);
     this._rawIpc.send(message, transfer);
   }
   dispose() {
@@ -697,8 +760,8 @@ const wrap = worker => {
       this.worker.postMessage(message);
     },
     // @ts-ignore
-    sendAndTransfer(message, transfer) {
-      array(transfer);
+    sendAndTransfer(message) {
+      const transfer = getTransferrablesNode(message);
       this.worker.postMessage(message, transfer);
     },
     dispose() {

package/dist/index.js

@@ -1,5 +1,101 @@
 import { VError } from '@lvce-editor/verror';
-import { string, array } from '@lvce-editor/assert';
+import { string } from '@lvce-editor/assert';
+
+const walkValue = (value, transferrables, isTransferrable) => {
+  if (!value) {
+    return;
+  }
+  if (isTransferrable(value)) {
+    transferrables.push(value);
+    return;
+  }
+  if (Array.isArray(value)) {
+    for (const item of value) {
+      walkValue(item, transferrables, isTransferrable);
+    }
+    return;
+  }
+  if (typeof value === 'object') {
+    for (const property of Object.values(value)) {
+      walkValue(property, transferrables, isTransferrable);
+    }
+    return;
+  }
+};
+
+const isMessagePort = value => {
+  return value && value instanceof MessagePort;
+};
+
+const isMessagePortMain = value => {
+  return value && value.constructor && value.constructor.name === 'MessagePortMain';
+};
+
+const isOffscreenCanvas = value => {
+  return typeof OffscreenCanvas !== 'undefined' && value instanceof OffscreenCanvas;
+};
+
+const isInstanceOf = (value, constructorName) => {
+  return value?.constructor?.name === constructorName;
+};
+
+const isSocket = value => {
+  return isInstanceOf(value, 'Socket');
+};
+
+const transferrables = [isMessagePort, isMessagePortMain, isOffscreenCanvas, isSocket];
+
+const isTransferrable = value => {
+  for (const fn of transferrables) {
+    if (fn(value)) {
+      return true;
+    }
+  }
+  return false;
+};
+
+const getTransferrables = value => {
+  const transferrables = [];
+  walkValue(value, transferrables, isTransferrable);
+  return transferrables;
+};
+
+const removeValues = (value, toRemove) => {
+  if (!value) {
+    return value;
+  }
+  if (Array.isArray(value)) {
+    const newItems = [];
+    for (const item of value) {
+      if (!toRemove.includes(item)) {
+        newItems.push(removeValues(item, toRemove));
+      }
+    }
+    return newItems;
+  }
+  if (typeof value === 'object') {
+    const newObject = Object.create(null);
+    for (const [key, property] of Object.entries(value)) {
+      if (!toRemove.includes(property)) {
+        newObject[key] = removeValues(property, toRemove);
+      }
+    }
+    return newObject;
+  }
+  return value;
+};
+
+// workaround for electron not supporting transferrable objects
+// as parameters. If the transferrable object is a parameter, in electron
+// only an empty objected is received in the main process
+const fixElectronParameters = value => {
+  const transfer = getTransferrables(value);
+  const newValue = removeValues(value, transfer);
+  return {
+    newValue,
+    transfer
+  };
+};
 
 const attachEvents = that => {
   const handleMessage = (...args) => {
@@ -168,10 +264,6 @@ class IpcError extends VError {
   }
 }
 
-const isMessagePortMain = value => {
-  return value && value.constructor && value.constructor.name === 'MessagePortMain';
-};
-
 const listen$8 = ({
   messagePort
 }) => {
@@ -206,8 +298,12 @@ class IpcChildWithElectronMessagePort extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
-    this._rawIpc.postMessage(message, transfer);
+  sendAndTransfer(message) {
+    const {
+      newValue,
+      transfer
+    } = fixElectronParameters(message);
+    this._rawIpc.postMessage(newValue, transfer);
   }
   dispose() {
     this._rawIpc.close();
@@ -267,8 +363,12 @@ class IpcChildWithElectronUtilityProcess extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
-    this._rawIpc.postMessage(message, transfer);
+  sendAndTransfer(message) {
+    const {
+      newValue,
+      transfer
+    } = fixElectronParameters(message);
+    this._rawIpc.postMessage(newValue, transfer);
   }
   dispose() {
     this._rawIpc.close();
@@ -313,7 +413,8 @@ class IpcChildWithModuleWorker extends Ipc {
     // @ts-ignore
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     // @ts-ignore
     this._rawIpc.postMessage(message, transfer);
   }
@@ -388,7 +489,8 @@ class IpcChildWithModuleWorkerAndMessagePort extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, transfer);
   }
   dispose() {
@@ -414,6 +516,14 @@ const IpcChildWithModuleWorkerAndMessagePort$1 = {
   wrap: wrap$8
 };
 
+const getTransferrablesNode = value => {
+  const transferrables = getTransferrables(value);
+  if (transferrables.length === 0) {
+    throw new Error(`no transferrables found`);
+  }
+  return transferrables[0];
+};
+
 const listen$4 = async () => {
   if (!process.send) {
     throw new Error('process.send must be defined');
@@ -448,7 +558,8 @@ class IpcChildWithNodeForkedProcess extends Ipc {
   onMessage(callback) {
     this._rawIpc.on('message', callback);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrablesNode(message);
     this._rawIpc.send(message, transfer);
   }
   dispose() {
@@ -466,10 +577,6 @@ const IpcChildWithNodeForkedProcess$1 = {
   wrap: wrap$7
 };
 
-const isMessagePort = value => {
-  return value && value instanceof MessagePort;
-};
-
 const listen$3 = async ({
   messagePort
 }) => {
@@ -584,7 +691,8 @@ class IpcChildWithRendererProcess2 extends Ipc {
   send(message) {
     this._rawIpc.postMessage(preloadChannelType, message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(preloadChannelType, message, transfer);
   }
   dispose() {
@@ -904,7 +1012,8 @@ class IpcParentWithElectronUtilityProcess extends Ipc {
   send(message) {
     this._rawIpc.postMessage(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrables(message);
     this._rawIpc.postMessage(message, transfer);
   }
   dispose() {
@@ -1077,7 +1186,8 @@ class IpcParentWithNodeForkedProcess extends Ipc {
   send(message) {
     this._rawIpc.send(message);
   }
-  sendAndTransfer(message, transfer) {
+  sendAndTransfer(message) {
+    const transfer = getTransferrablesNode(message);
     this._rawIpc.send(message, transfer);
   }
   dispose() {
@@ -1167,8 +1277,8 @@ const wrap = worker => {
       this.worker.postMessage(message);
     },
     // @ts-ignore
-    sendAndTransfer(message, transfer) {
-      array(transfer);
+    sendAndTransfer(message) {
+      const transfer = getTransferrablesNode(message);
       this.worker.postMessage(message, transfer);
     },
     dispose() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/ipc",
-  "version": "9.5.1",
+  "version": "10.0.1",
   "description": "Inter Process Communication for Lvce Editor",
   "main": "dist/index.js",
   "type": "module",