crx-monkey-next 0.0.1

package/jest.config.js

@@ -0,0 +1,17 @@
+/** @type {import("jest").Config} **/
+export default {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  extensionsToTreatAsEsm: ['.ts'],
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+};

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "crx-monkey-next",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "",
+  "bin": {
+    "crx-monkey": "bin/crx-monkey"
+  },
+  "main": "./dist/node/main.js",
+  "types": "./dist/node/main.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/node/exports.d.ts",
+        "default": "./dist/node/exports.js"
+      }
+    },
+    "./client": {
+      "import": {
+        "types": "./dist/client/main.d.ts",
+        "default": "./dist/client/main.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "watch": "rollup --watch -c",
+    "test": "jest"
+  },
+  "author": "yakisova41 <yakisoba5emon@gmail.com> (https://yakisova.com/)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yakisova41/crx-monkey-next.git",
+    "directory": "packages/crx-monkey"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/bun": "^1.3.3",
+    "@types/chrome": "^0.0.268",
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "^11.0.4",
+    "@types/mock-fs": "^4.13.4",
+    "@types/moment": "^2.13.0",
+    "@types/murmurhash3js": "^3.0.7",
+    "@types/node": "^24.10.1",
+    "@types/source-map-support": "^0.5.10",
+    "@types/tampermonkey": "^5.0.2",
+    "@types/ws": "^8.5.10",
+    "cac": "^6.7.14",
+    "chalk": "^5.3.0",
+    "chokidar": "^3.6.0",
+    "consola": "^3.2.3",
+    "esbuild": "^0.24.0",
+    "esbuild-plugin-manifest": "^1.0.3",
+    "express": "^4.19.1",
+    "fs-extra": "^11.2.0",
+    "inversify": "^7.10.4",
+    "mock-fs": "^5.5.0",
+    "moment": "^2.30.1",
+    "murmurhash3js": "^3.0.1",
+    "node-html-parser": "^6.1.12",
+    "prettier": "^3.3.3",
+    "reflect-metadata": "^0.2.2",
+    "rollup": "^4.12.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-dts": "^6.1.0",
+    "sass": "^1.93.3",
+    "source-map-support": "^0.5.21",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.2",
+    "ws": "^8.16.0",
+    "@types/jest": "^30.0.0",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.5",
+    "ts-jest-mock-import-meta": "^1.3.1"
+  },
+  "dependencies": {}
+}

package/rollup.config.js

@@ -0,0 +1,101 @@
+// @ts-check
+import commonjs from '@rollup/plugin-commonjs';
+import typescript from '@rollup/plugin-typescript';
+import json from '@rollup/plugin-json';
+import { dts } from 'rollup-plugin-dts';
+import copy from 'rollup-plugin-copy';
+
+/** @typedef {import('rollup').RollupOptions} ConfigData */
+const plugins = (tsconfig, ts) => {
+  return [
+    commonjs({
+      include: ['node_modules/**'],
+    }),
+    json(),
+    ...(ts
+      ? [
+          typescript({
+            declaration: false,
+            tsconfig: tsconfig,
+            exclude: ['**/__tests__/**'],
+            sourceMap: true,
+          }),
+        ]
+      : []),
+  ];
+};
+
+/** @type {import('rollup').RollupOptions} */
+const nodeConfig = {
+  input: 'src/node/main.ts',
+  output: [
+    {
+      file: 'dist/node/main.js',
+      format: 'esm',
+      sourcemap: 'inline',
+    },
+  ],
+  plugins: [
+    plugins('./tsconfig.json', true),
+    copy({
+      targets: [{ src: 'src/node/static/files/*', dest: 'dist/node/static' }],
+    }),
+  ],
+};
+
+/** @type {import('rollup').RollupOptions} */
+const nodeExportsConfig = {
+  input: 'src/node/exports.ts',
+  output: [
+    {
+      file: 'dist/node/exports.js',
+      format: 'esm',
+      sourcemap: 'inline',
+    },
+  ],
+  plugins: [
+    plugins('./tsconfig.json', true),
+    copy({
+      targets: [{ src: 'src/node/static/files/*', dest: 'dist/node/static' }],
+    }),
+  ],
+};
+
+/** @type {import('rollup').RollupOptions} */
+const nodeExportsTypes = {
+  input: 'src/node/exports.ts',
+  output: [
+    {
+      file: 'dist/node/exports.d.ts',
+      format: 'esm',
+    },
+  ],
+  plugins: [plugins('./tsconfig.json', false), dts()],
+};
+
+/** @type {import('rollup').RollupOptions} */
+const clientConfig = {
+  input: 'src/client/main.ts',
+  output: [
+    {
+      file: 'dist/client/main.js',
+      format: 'esm',
+      sourcemap: 'inline',
+    },
+  ],
+  plugins: [plugins('./tsconfig.client.json', true)],
+};
+
+/** @type {import('rollup').RollupOptions} */
+const clientTypes = {
+  input: 'src/client/main.ts',
+  output: [
+    {
+      file: 'dist/client/main.d.ts',
+      format: 'esm',
+    },
+  ],
+  plugins: [plugins('./tsconfig.client.json', false), dts()],
+};
+
+export default [nodeConfig, nodeExportsConfig, nodeExportsTypes, clientConfig, clientTypes];

package/src/client/i18n.ts

@@ -0,0 +1,42 @@
+import { runtime } from './runtime';
+
+/**
+ * Gets the localized string for the specified message. If the message is missing, this method returns an empty string (''). If the format of the getMessage() call is wrong — for example, messageName is not a string or the substitutions array has more than 9 elements — this method returns undefined.
+ * @param messageName
+ * @param substitutions
+ * @returns
+ */
+function getMessage(messageName: string, substitutions?: string | string[] | undefined) {
+  if (runtime.getRunningRuntime() === 'Extension') {
+    if (runtime.getRunningWorld() === 'ISOLATED') {
+      return chrome.i18n.getMessage(messageName, substitutions);
+    }
+  }
+}
+
+async function detectLanguage(text: string) {
+  if (runtime.getRunningRuntime() === 'Extension') {
+    if (runtime.getRunningWorld() === 'ISOLATED') {
+      return chrome.i18n.detectLanguage(text);
+    }
+  }
+}
+
+async function getAcceptLanguages() {
+  if (runtime.getRunningRuntime() === 'Extension') {
+    if (runtime.getRunningWorld() === 'ISOLATED') {
+      return chrome.i18n.getAcceptLanguages();
+    }
+  }
+}
+
+function getUILanguage() {
+  if (runtime.getRunningRuntime() === 'Extension') {
+    if (runtime.getRunningWorld() === 'ISOLATED') {
+      return chrome.i18n.getUILanguage();
+    }
+  }
+}
+
+export const i18n = { getMessage, detectLanguage, getAcceptLanguages, getUILanguage };
+export default i18n;

package/src/client/main.ts

@@ -0,0 +1,20 @@
+/**
+ * The main endpoint for client of crx-monkey.
+ * Modules and Types that are exported from this file are used by userside.
+ */
+
+import { IsolateConnectorEvent } from './message';
+
+export * from './message';
+export * from './i18n';
+export * from './runtime';
+
+declare global {
+  interface Window {
+    __CRX_CONTENT_BUILD_ID: string;
+  }
+
+  interface WindowEventMap {
+    'crx-isolated-connector-result': IsolateConnectorEvent<never>;
+  }
+}

package/src/client/message.ts

@@ -0,0 +1,118 @@
+export function waitResult<T = string>(
+  type: string,
+  actionId: string,
+  callback: (data: T) => void,
+) {
+  const onResult = (e: IsolateConnectorEvent<T>) => {
+    if (e.detail.type === type && e.detail.actionId === actionId) {
+      callback(e.detail.data);
+    }
+  };
+
+  window.addEventListener('crx-isolated-connector-result', onResult);
+
+  return {
+    remove: () => {
+      window.removeEventListener('crx-isolated-connector-result', onResult);
+    },
+  };
+}
+
+export async function waitResultOnce<T = string>(type: string, actionId: string): Promise<T> {
+  return new Promise((resolve) => {
+    const onResult = (e: IsolateConnectorEvent<T>) => {
+      if (e.detail.type === type && e.detail.actionId === actionId) {
+        window.removeEventListener('crx-isolated-connector-result', onResult);
+        resolve(e.detail.data);
+      }
+    };
+
+    window.addEventListener('crx-isolated-connector-result', onResult);
+  });
+}
+
+export type IsolateConnectorEvent<T> = CustomEvent<{
+  type: string;
+  actionId: string;
+  data: T;
+}>;
+
+/**
+ * Bypass `chrome.runtime.sendMessage`.
+ *
+ * You can send message to service worker.
+ * @param callback
+ */
+async function sendMessage<T = never, U = never>(
+  message: T,
+  options?: object,
+  callback?: (response: U) => void,
+) {
+  const actionId = crypto.randomUUID();
+
+  window.postMessage(
+    {
+      type: 'send-message',
+      crxContentBuildId: window.__CRX_CONTENT_BUILD_ID,
+      detail: { message, options },
+      actionId,
+    },
+    '*',
+  );
+
+  const data = await waitResultOnce<{ response: U }>('send-message', actionId);
+  if (callback !== undefined) {
+    callback(data.response);
+  }
+}
+
+/**
+ * Bypass `chrome.runtime.onMessage`.
+ *
+ * You can get a content of message receved the bypassing isolated content_script.
+ * @param callback
+ */
+function addListener<T = never>(
+  callback: (request: T, sender: chrome.runtime.MessageSender) => void,
+): {
+  remove: () => void;
+} {
+  const actionId = crypto.randomUUID();
+
+  window.postMessage(
+    {
+      type: 'on-message',
+      crxContentBuildId: window.__CRX_CONTENT_BUILD_ID,
+      detail: null,
+      actionId,
+    },
+    '*',
+  );
+
+  const waiter = waitResult<{ request: T; sender: { id: string; origin: string } }>(
+    'on-message',
+    actionId,
+    (data) => {
+      callback(data.request, data.sender);
+    },
+  );
+
+  return {
+    remove: () => {
+      waiter.remove();
+
+      window.postMessage(
+        {
+          type: 'remove-on-message',
+          crxContentBuildId: window.__CRX_CONTENT_BUILD_ID,
+          detail: null,
+          actionId,
+        },
+        '*',
+      );
+    },
+  };
+}
+
+export const message = { sendMessage, addListener };
+export default message;

package/src/client/runtime.ts

@@ -0,0 +1,109 @@
+import { waitResultOnce } from './message';
+import { CrxmConfigRequired } from '../node/typeDefs';
+
+export function getRunningRuntime() {
+  if (typeof window.__CRX_CONTENT_BUILD_ID === 'undefined') {
+    return 'Userscript';
+  } else {
+    return 'Extension';
+  }
+}
+
+export function getRunningWorld() {
+  if (getRunningRuntime() === 'Userscript') {
+    throw new Error('Cannot be executed by userscripts');
+  }
+
+  if (typeof chrome.runtime.id === 'undefined') {
+    return 'MAIN';
+  } else {
+    return 'ISOLATED';
+  }
+}
+
+export async function getCrxmConfig() {
+  if (getRunningRuntime() === 'Userscript') {
+    throw new Error('Cannot be executed by userscripts');
+  }
+
+  const actionId = crypto.randomUUID();
+
+  window.postMessage(
+    {
+      type: 'get-conf',
+      crxContentBuildId: window.__CRX_CONTENT_BUILD_ID,
+      detail: null,
+      actionId,
+    },
+    '*',
+  );
+  return JSON.parse(await waitResultOnce<string>('get-conf', actionId)) as CrxmConfigRequired;
+}
+
+/**
+ * Get `chrome.runtime.id`.
+ *
+ * You can get the extension id everyworld if running script by chrome extension.
+ */
+export async function getExtensionId() {
+  if (getRunningRuntime() === 'Userscript') {
+    throw new Error('Cannot be executed by userscripts');
+  }
+
+  if (getRunningWorld() === 'ISOLATED') {
+    return chrome.runtime.id;
+  } else {
+    const actionId = crypto.randomUUID();
+
+    window.postMessage(
+      {
+        type: 'get-id',
+        crxContentBuildId: window.__CRX_CONTENT_BUILD_ID,
+        detail: null,
+        actionId,
+      },
+      '*',
+    );
+    return await waitResultOnce<string>('get-id', actionId);
+  }
+}
+
+/**
+ * You can check browser's console logs in your terminal at development mode.
+ * [ATTENSION] It's unstable future.
+ */
+export function attachConsole() {
+  const replaceOriginal = (original: (...args: string[]) => void, name: string) => {
+    return (...args: string[]) => {
+      original(...args);
+
+      const actionId = crypto.randomUUID();
+      window.postMessage(
+        {
+          type: name,
+          crxContentBuildId: window.__CRX_CONTENT_BUILD_ID,
+          detail: args.join(' '),
+          actionId,
+        },
+        '*',
+      );
+    };
+  };
+
+  const l = console.log;
+  const w = console.warn;
+  const e = console.error;
+
+  window.console.log = replaceOriginal(l, 'console-log');
+  window.console.warn = replaceOriginal(w, 'console-warn');
+  window.console.error = replaceOriginal(e, 'console-error');
+  console.log("[crxm] browser's console attached to your console.");
+}
+
+export const runtime = {
+  getRunningRuntime,
+  getRunningWorld,
+  getExtensionId,
+  getCrxmConfig,
+  attachConsole,
+};