@lvce-editor/ipc 3.2.0 → 3.4.0

package/dist/browser.js

@@ -0,0 +1,340 @@
+const getData = event => {
+  return event.data;
+};
+
+const listen$1 = () => {
+  // @ts-ignore
+  if (typeof WorkerGlobalScope === 'undefined') {
+    throw new TypeError('module is not in web worker scope');
+  }
+  // @ts-ignore
+  globalThis.postMessage('ready');
+  return globalThis;
+};
+const signal = global => {
+  global.postMessage('ready');
+};
+const wrap$1 = global => {
+  return {
+    global,
+    /**
+     * @type {any}
+     */
+    listener: undefined,
+    send(message) {
+      this.global.postMessage(message);
+    },
+    sendAndTransfer(message, transferables) {
+      this.global.postMessage(message, transferables);
+    },
+    get onmessage() {
+      return this.listener;
+    },
+    set onmessage(listener) {
+      const wrappedListener = event => {
+        const data = getData(event);
+        // @ts-expect-error
+        listener({
+          data,
+          target: this
+        });
+      };
+      this.listener = listener;
+      this.global.onmessage = wrappedListener;
+    }
+  };
+};
+
+const IpcChildWithModuleWorker = {
+  __proto__: null,
+  listen: listen$1,
+  signal,
+  wrap: wrap$1
+};
+
+const E_INCOMPATIBLE_NATIVE_MODULE = 'E_INCOMPATIBLE_NATIVE_MODULE';
+const E_MODULES_NOT_SUPPORTED_IN_ELECTRON = 'E_MODULES_NOT_SUPPORTED_IN_ELECTRON';
+const ERR_MODULE_NOT_FOUND = 'ERR_MODULE_NOT_FOUND';
+
+const NewLine$1 = '\n';
+
+const joinLines = lines => {
+  return lines.join(NewLine$1);
+};
+
+const splitLines = lines => {
+  return lines.split(NewLine$1);
+};
+
+const RE_NATIVE_MODULE_ERROR = /^innerError Error: Cannot find module '.*.node'/;
+const RE_NATIVE_MODULE_ERROR_2 = /was compiled against a different Node.js version/;
+const RE_MESSAGE_CODE_BLOCK_START = /^Error: The module '.*'$/;
+const RE_MESSAGE_CODE_BLOCK_END = /^\s* at/;
+const RE_AT = /^\s+at/;
+const RE_AT_PROMISE_INDEX = /^\s*at async Promise.all \(index \d+\)$/;
+const isUnhelpfulNativeModuleError = stderr => {
+  return RE_NATIVE_MODULE_ERROR.test(stderr) && RE_NATIVE_MODULE_ERROR_2.test(stderr);
+};
+const isMessageCodeBlockStartIndex = line => {
+  return RE_MESSAGE_CODE_BLOCK_START.test(line);
+};
+const isMessageCodeBlockEndIndex = line => {
+  return RE_MESSAGE_CODE_BLOCK_END.test(line);
+};
+const getMessageCodeBlock = stderr => {
+  const lines = splitLines(stderr);
+  const startIndex = lines.findIndex(isMessageCodeBlockStartIndex);
+  const endIndex = startIndex + lines.slice(startIndex).findIndex(isMessageCodeBlockEndIndex, startIndex);
+  const relevantLines = lines.slice(startIndex, endIndex);
+  const relevantMessage = relevantLines.join(' ').slice('Error: '.length);
+  return relevantMessage;
+};
+const getNativeModuleErrorMessage = stderr => {
+  const message = getMessageCodeBlock(stderr);
+  return {
+    message: `Incompatible native node module: ${message}`,
+    code: E_INCOMPATIBLE_NATIVE_MODULE
+  };
+};
+const isModulesSyntaxError = stderr => {
+  if (!stderr) {
+    return false;
+  }
+  return stderr.includes('SyntaxError: Cannot use import statement outside a module');
+};
+const getModuleSyntaxError = () => {
+  return {
+    message: `ES Modules are not supported in electron`,
+    code: E_MODULES_NOT_SUPPORTED_IN_ELECTRON
+  };
+};
+const isModuleNotFoundError = stderr => {
+  if (!stderr) {
+    return false;
+  }
+  return stderr.includes('ERR_MODULE_NOT_FOUND');
+};
+const isModuleNotFoundMessage = line => {
+  return line.includes('ERR_MODULE_NOT_FOUND');
+};
+const getModuleNotFoundError = stderr => {
+  const lines = splitLines(stderr);
+  const messageIndex = lines.findIndex(isModuleNotFoundMessage);
+  const message = lines[messageIndex];
+  return {
+    message,
+    code: ERR_MODULE_NOT_FOUND
+  };
+};
+const isNormalStackLine = line => {
+  return RE_AT.test(line) && !RE_AT_PROMISE_INDEX.test(line);
+};
+const getDetails = lines => {
+  const index = lines.findIndex(isNormalStackLine);
+  if (index === -1) {
+    return {
+      actualMessage: joinLines(lines),
+      rest: []
+    };
+  }
+  let lastIndex = index - 1;
+  while (++lastIndex < lines.length) {
+    if (!isNormalStackLine(lines[lastIndex])) {
+      break;
+    }
+  }
+  return {
+    actualMessage: lines[index - 1],
+    rest: lines.slice(index, lastIndex)
+  };
+};
+const getHelpfulChildProcessError = (stdout, stderr) => {
+  if (isUnhelpfulNativeModuleError(stderr)) {
+    return getNativeModuleErrorMessage(stderr);
+  }
+  if (isModulesSyntaxError(stderr)) {
+    return getModuleSyntaxError();
+  }
+  if (isModuleNotFoundError(stderr)) {
+    return getModuleNotFoundError(stderr);
+  }
+  const lines = splitLines(stderr);
+  const {
+    actualMessage,
+    rest
+  } = getDetails(lines);
+  return {
+    message: `${actualMessage}`,
+    code: '',
+    stack: rest
+  };
+};
+
+const normalizeLine = line => {
+  if (line.startsWith('Error: ')) {
+    return line.slice(`Error: `.length);
+  }
+  if (line.startsWith('VError: ')) {
+    return line.slice(`VError: `.length);
+  }
+  return line;
+};
+const getCombinedMessage = (error, message) => {
+  const stringifiedError = normalizeLine(`${error}`);
+  if (message) {
+    return `${message}: ${stringifiedError}`;
+  }
+  return stringifiedError;
+};
+const NewLine = '\n';
+const getNewLineIndex = (string, startIndex = undefined) => {
+  return string.indexOf(NewLine, startIndex);
+};
+const mergeStacks = (parent, child) => {
+  if (!child) {
+    return parent;
+  }
+  const parentNewLineIndex = getNewLineIndex(parent);
+  const childNewLineIndex = getNewLineIndex(child);
+  if (childNewLineIndex === -1) {
+    return parent;
+  }
+  const parentFirstLine = parent.slice(0, parentNewLineIndex);
+  const childRest = child.slice(childNewLineIndex);
+  const childFirstLine = normalizeLine(child.slice(0, childNewLineIndex));
+  if (parentFirstLine.includes(childFirstLine)) {
+    return parentFirstLine + childRest;
+  }
+  return child;
+};
+class VError extends Error {
+  constructor(error, message) {
+    const combinedMessage = getCombinedMessage(error, message);
+    super(combinedMessage);
+    this.name = 'VError';
+    if (error instanceof Error) {
+      this.stack = mergeStacks(this.stack, error.stack);
+    }
+    if (error.codeFrame) {
+      // @ts-ignore
+      this.codeFrame = error.codeFrame;
+    }
+    if (error.code) {
+      // @ts-ignore
+      this.code = error.code;
+    }
+  }
+}
+
+class IpcError extends VError {
+  // @ts-ignore
+  constructor(message, stdout = '', stderr = '') {
+    if (stdout || stderr) {
+      // @ts-ignore
+      const {
+        message,
+        code,
+        stack
+      } = getHelpfulChildProcessError(stdout, stderr);
+      const cause = new Error(message);
+      // @ts-ignore
+      cause.code = code;
+      cause.stack = stack;
+      super(cause, message);
+    } else {
+      super(message);
+    }
+    // @ts-ignore
+    this.name = 'IpcError';
+    // @ts-ignore
+    this.stdout = stdout;
+    // @ts-ignore
+    this.stderr = stderr;
+  }
+}
+
+const withResolvers = () => {
+  let _resolve;
+  const promise = new Promise(resolve => {
+    _resolve = resolve;
+  });
+  return {
+    resolve: _resolve,
+    promise
+  };
+};
+
+const waitForFirstMessage = async port => {
+  const {
+    resolve,
+    promise
+  } = withResolvers();
+  const cleanup = value => {
+    port.onmessage = null;
+    resolve(value);
+  };
+  const handleMessage = event => {
+    cleanup(event);
+  };
+  port.onmessage = handleMessage;
+  const event = await promise;
+  // @ts-expect-error
+  return event.data;
+};
+
+const listen = async () => {
+  const parentIpcRaw = listen$1();
+  const parentIpc = wrap$1(parentIpcRaw);
+  const firstMessage = await waitForFirstMessage(parentIpc);
+  if (firstMessage.method !== 'initialize') {
+    throw new IpcError('unexpected first message');
+  }
+  const type = firstMessage.params[0];
+  if (type === 'message-port') {
+    const port = firstMessage.params[1];
+    return port;
+  }
+  return globalThis;
+};
+const wrap = port => {
+  return {
+    port,
+    /**
+     * @type {any}
+     */
+    wrappedListener: undefined,
+    send(message) {
+      this.port.postMessage(message);
+    },
+    sendAndTransfer(message, transferables) {
+      this.port.postMessage(message, transferables);
+    },
+    get onmessage() {
+      return this.wrappedListener;
+    },
+    set onmessage(listener) {
+      if (listener) {
+        // @ts-expect-error
+        this.wrappedListener = event => {
+          const data = getData(event);
+          // @ts-expect-error
+          listener({
+            data,
+            target: this
+          });
+        };
+      } else {
+        this.wrappedListener = undefined;
+      }
+      this.port.onmessage = this.wrappedListener;
+    }
+  };
+};
+
+const IpcChildWithModuleWorkerAndMessagePort = {
+  __proto__: null,
+  listen,
+  wrap
+};
+
+export { IpcChildWithModuleWorker, IpcChildWithModuleWorkerAndMessagePort };

package/dist/index.d.ts

@@ -7,8 +7,6 @@ export const IpcChildWithElectronMessagePort: IpcChild
 export const IpcChildWithElectronUtilityProcess: IpcChild
 export const IpcChildWithNodeForkedProcess: IpcChild
 export const IpcChildWithWebSocket: IpcChild
-export const IpcChildWithModuleWorkerAndMessagePort: IpcChild
-export const IpcChildWithModuleWorker: IpcChild
 
 interface IpcParent {
   readonly create: any

package/dist/index.js

@@ -151,7 +151,7 @@ const isMessagePortMain = value => {
 };
 
 // @ts-ignore
-const listen$5 = ({
+const listen$6 = ({
   messagePort
 }) => {
   if (!isMessagePortMain(messagePort)) {
@@ -176,7 +176,7 @@ const getActualData$1 = event => {
 };
 
 // @ts-ignore
-const wrap$8 = messagePort => {
+const wrap$9 = messagePort => {
   return {
     messagePort,
     // @ts-ignore
@@ -213,8 +213,8 @@ const wrap$8 = messagePort => {
 
 const IpcChildWithElectronMessagePort = {
   __proto__: null,
-  listen: listen$5,
-  wrap: wrap$8
+  listen: listen$6,
+  wrap: wrap$9
 };
 
 // @ts-ignore
@@ -232,7 +232,7 @@ const getUtilityProcessPortData = event => {
   };
 };
 
-const listen$4 = () => {
+const listen$5 = () => {
   // @ts-ignore
   const {
     parentPort
@@ -249,7 +249,7 @@ const signal$2 = parentPort => {
 };
 
 // @ts-ignore
-const wrap$7 = parentPort => {
+const wrap$8 = parentPort => {
   return {
     parentPort,
     // @ts-ignore
@@ -287,16 +287,16 @@ const wrap$7 = parentPort => {
 
 const IpcChildWithElectronUtilityProcess = {
   __proto__: null,
-  listen: listen$4,
+  listen: listen$5,
   signal: signal$2,
-  wrap: wrap$7
+  wrap: wrap$8
 };
 
 const getData = event => {
   return event.data;
 };
 
-const listen$3 = () => {
+const listen$4 = () => {
   // @ts-ignore
   if (typeof WorkerGlobalScope === 'undefined') {
     throw new TypeError('module is not in web worker scope');
@@ -308,7 +308,7 @@ const listen$3 = () => {
 const signal$1 = global => {
   global.postMessage('ready');
 };
-const wrap$6 = global => {
+const wrap$7 = global => {
   return {
     global,
     /**
@@ -341,9 +341,9 @@ const wrap$6 = global => {
 
 const IpcChildWithModuleWorker = {
   __proto__: null,
-  listen: listen$3,
+  listen: listen$4,
   signal: signal$1,
-  wrap: wrap$6
+  wrap: wrap$7
 };
 
 const withResolvers = () => {
@@ -375,9 +375,9 @@ const waitForFirstMessage = async port => {
   return event.data;
 };
 
-const listen$2 = async () => {
-  const parentIpcRaw = listen$3();
-  const parentIpc = wrap$6(parentIpcRaw);
+const listen$3 = async () => {
+  const parentIpcRaw = listen$4();
+  const parentIpc = wrap$7(parentIpcRaw);
   const firstMessage = await waitForFirstMessage(parentIpc);
   if (firstMessage.method !== 'initialize') {
     throw new IpcError('unexpected first message');
@@ -389,7 +389,7 @@ const listen$2 = async () => {
   }
   return globalThis;
 };
-const wrap$5 = port => {
+const wrap$6 = port => {
   return {
     port,
     /**
@@ -426,11 +426,11 @@ const wrap$5 = port => {
 
 const IpcChildWithModuleWorkerAndMessagePort = {
   __proto__: null,
-  listen: listen$2,
-  wrap: wrap$5
+  listen: listen$3,
+  wrap: wrap$6
 };
 
-const listen$1 = async () => {
+const listen$2 = async () => {
   if (!process.send) {
     throw new Error('process.send must be defined');
   }
@@ -454,7 +454,7 @@ const getActualData = (message, handle) => {
 };
 
 // @ts-ignore
-const wrap$4 = process => {
+const wrap$5 = process => {
   return {
     process,
     // @ts-ignore
@@ -486,8 +486,47 @@ const wrap$4 = process => {
 
 const IpcChildWithNodeForkedProcess = {
   __proto__: null,
-  listen: listen$1,
+  listen: listen$2,
   signal,
+  wrap: wrap$5
+};
+
+const isMessagePort = value => {
+  return value && value instanceof MessagePort;
+};
+
+const listen$1 = async ({
+  messagePort
+}) => {
+  if (!isMessagePort(messagePort)) {
+    throw new IpcError(`port must be of type MessagePort`);
+  }
+  return messagePort;
+};
+const wrap$4 = port => {
+  return {
+    port,
+    on(event, listener) {
+      this.port.on(event, listener);
+    },
+    off(event, listener) {
+      this.port.off(event, listener);
+    },
+    send(message) {
+      this.port.postMessage(message);
+    },
+    dispose() {
+      this.port.close();
+    },
+    start() {
+      this.port.start();
+    }
+  };
+};
+
+const IpcChildWithNodeMessagePort = {
+  __proto__: null,
+  listen: listen$1,
   wrap: wrap$4
 };
 
@@ -1037,4 +1076,4 @@ const IpcParentWithNodeWorker = {
   wrap
 };
 
-export { IpcChildWithElectronMessagePort, IpcChildWithElectronUtilityProcess, IpcChildWithModuleWorker, IpcChildWithModuleWorkerAndMessagePort, IpcChildWithNodeForkedProcess, IpcChildWithWebSocket, IpcParentWithElectronUtilityProcess, IpcParentWithNodeForkedProcess, IpcParentWithNodeWorker };
+export { IpcChildWithElectronMessagePort, IpcChildWithElectronUtilityProcess, IpcChildWithModuleWorker, IpcChildWithModuleWorkerAndMessagePort, IpcChildWithNodeForkedProcess, IpcChildWithNodeMessagePort, IpcChildWithWebSocket, IpcParentWithElectronUtilityProcess, IpcParentWithNodeForkedProcess, IpcParentWithNodeWorker };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/ipc",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "Inter Process Communication for Lvce Editor",
   "main": "dist/index.js",
   "type": "module",
@@ -21,5 +21,6 @@
   "engines": {
     "node": ">=18"
   },
-  "types": "dist/index.d.ts"
+  "types": "dist/index.d.ts",
+  "browser": "dist/browser.js"
 }