MV3 Collector Branch

.github/workflows/ci.yml

@@ -9,6 +9,7 @@ on:
   pull_request:
     branches:
       - main
+      - rc/3.0-mv3
 
 env:
   XDG_CACHE_HOME: ${{ github.workspace }}/.cache
@@ -43,17 +44,17 @@ jobs:
         id: cache
         with:
           path: ${{ github.workspace }}/.cache
-          key: ${{ runner.os }}-${{ hashFiles('package*json', 'package-lock.json', '*config.js') }}
+          key: ${{ runner.os }}-${{ hashFiles('**/package*json', '**/package-lock.json', '**/*config.js', '**/*.patch') }}
           restore-keys: |
-            ${{ runner.os }}-${{ hashFiles('package*json', 'package-lock.json', '*config.js') }}
+            ${{ runner.os }}-${{ hashFiles('**/package*json', '**/package-lock.json', '**/*config.js', '**/*.patch') }}
             ${{ runner.os }}-
 
       - name: Restore node_modules
         id: yarn-cache
         uses: actions/[email protected]
         with:
           path: node_modules
-          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ runner.os }}-${{ hashFiles('**/package*json', '**/package-lock.json', '**/*config.js', '**/*.patch') }}
 
       - name: Install dependencies
         if: steps.yarn-cache.outputs.cache-hit != 'true'
@@ -106,7 +107,9 @@ jobs:
   release-assets:
     runs-on: ubuntu-latest
     needs: [test]
-    if: contains(github.ref, 'refs/tags/') && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
+    if: |
+      (contains(github.ref, 'refs/tags/') || github.ref == 'refs/heads/rc/3.0-mv3') &&
+      (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
     steps:
       - name: Check out Git repository
         uses: actions/[email protected]
@@ -121,17 +124,17 @@ jobs:
         id: cache
         with:
           path: ${{ github.workspace }}/.cache
-          key: ${{ runner.os }}-${{ hashFiles('package*json', 'package-lock.json', '*config.js') }}
+          key: ${{ runner.os }}-${{ hashFiles('**/package*json', '**/package-lock.json', '**/*config.js', '**/*.patch') }}
           restore-keys: |
-            ${{ runner.os }}-${{ hashFiles('package*json', 'package-lock.json', '*config.js') }}
+            ${{ runner.os }}-${{ hashFiles('**/package*json', '**/package-lock.json', '**/*config.js', '**/*.patch') }}
             ${{ runner.os }}-
 
       - name: Restore node_modules
         id: yarn-cache
         uses: actions/[email protected]
         with:
           path: node_modules
-          key: ${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ runner.os }}-${{ hashFiles('**/package*json', '**/package-lock.json', '**/*config.js', '**/*.patch') }}
 
       - name: Install dependencies
         if: steps.yarn-cache.outputs.cache-hit != 'true'

.mocharc.json

@@ -0,0 +1,17 @@
+{
+  "diff": true,
+  "extensions": [".js", ".ts"],
+  "package": "./package.json",
+  "require": [
+    "ignore-styles",
+    "ts-node/register",
+    "tsconfig-paths/register"
+  ],
+  "exit": true,
+  "recursive": true,
+  "node-option": [
+    "es-module-specifier-resolution=node",
+    "experimental-specifier-resolution=node",
+    "loader=ts-node/esm"
+  ]
+}

.nvmrc

@@ -0,0 +1 @@
+v18.14.0

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18.12.1
+FROM node:18.14.0
 
 ARG USER_ID
 ARG GROUP_ID

README.md

@@ -63,15 +63,6 @@ You can disable and re-enable local gateway redirects by several means:
 - Suspend redirects **per site** using the toggle under "Current tab" ([illustrated below](#toggle-gateway-redirects-on-a-per-website-basis)) or in IPFS Companion's preferences
 - Add `x-ipfs-companion-no-redirect` to the URL itself as a hash ([example](https://ipfs.io/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR#x-ipfs-companion-no-redirect)) or query parameter ([example](https://ipfs.io/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR?x-ipfs-companion-no-redirect))
 
-<!-- TODO: restore after https://github.com/ipfs-shipyard/ipfs-companion/issues/843 is closed
-### IPFS API as `window.ipfs`
-
-Your IPFS node is exposed as `window.ipfs` on every web page.
-Websites can detect if `window.ipfs` exists and opt-in to use it instead of creating their own `js-ipfs` node.
-It saves system resources and battery (on mobile), avoids the overhead of peer discovery/connection, enables shared repository access and more!
-Make sure to read our [notes on `window.ipfs`](https://github.com/ipfs-shipyard/ipfs-companion/blob/main/docs/window.ipfs.md), where we explain it in-depth and provide examples on how to use it your own dapp.
--->
-
 ### Access frequently-used IPFS actions from your browser bar
 
 IPFS Companion enables you to quickly and easily access common actions from your browser bar with just a few clicks:
@@ -108,9 +99,6 @@ IPFS Companion ships with a variety of experimental features. Some are disabled
     - `dweb:/ipfs/$cid`
     - `dweb:/ipns/$cid_or_fqdn`
 
-- Switch between the external HTTP API of your local IPFS node (default setting) and a js-ipfs node embedded in your browser (note that this has some [functionality limitations](https://docs.ipfs.io/how-to/companion-node-types/))
-[![screenshot of node type switch](https://gateway.ipfs.io/ipfs/QmPDxawBTEmH5Dk1anaqpryRyyaNwmqVPt5DsCf21eFWQz)](http://docs.ipfs.io/how-to/companion-node-types/)
-
 ## Install IPFS Companion
 
 ### Latest stable release

add-on/_locales/ar/messages.json

@@ -13,7 +13,7 @@
   },
   "panel_headerActiveToggleTitle": {
     "message": "قم بتبديل كافة تكاملات IPFS",
-    "description": "A label for an embedded IPFS node (panel_headerActiveToggleTitle)"
+    "description": "A label for an toggling all IPFS integrations (panel_headerActiveToggleTitle)"
   },
   "panel_statusOffline": {
     "message": "غير متصل",
@@ -92,8 +92,8 @@
     "description": "A menu item tooltip in Browser Action pop-up (panel_importCurrentIpfsAddressTooltip)"
   },
   "panelCopy_currentIpnsAddress": {
-  "message": "انسخ مسار IPNS",
-  "description": "A menu item in Browser Action pop-up and right-click context menu (panelCopy_currentIpnsAddress)"
+    "message": "انسخ مسار IPNS",
+    "description": "A menu item in Browser Action pop-up and right-click context menu (panelCopy_currentIpnsAddress)"
   },
   "panelCopy_currentIpnsAddressTooltip": {
     "message": "استخدم مسار المحتوى هذا مع أدوات وبوابات IPFS للوصول إلى أحدث إصدار تم تحديثه من محتوى علامة التبويب هذه.",
@@ -239,19 +239,15 @@
     "message": "فشل في إيقاف عقدة IPFS",
     "description": "System notification title displayed when stopping an IPFS node fails (notify_stopIpfsNodeErrorTitle)"
   },
-  "option_page_title" : {
+  "option_page_title": {
     "message": "التفضيلات | رفيق IPFS",
     "description": "Title of the Preferences page (option_page_title)"
   },
-  "option_page_header" : {
+  "option_page_header": {
     "message": "التفضيلات المصاحبة",
     "description": "Main header on the Preferences screen (option_page_header)"
   },
-  "option_legend_readMore" : {
-    "message": "اقرأ المزيد",
-    "description": "A generic link in option description on the Preferences screen (option_legend_readMore)"
-  },
-  "option_header_nodeType" : {
+  "option_header_nodeType": {
     "message": "عقدة IPFS",
     "description": "A section header on the Preferences screen (option_header_nodeType)"
   },
@@ -267,10 +263,6 @@
     "message": "اضبط على \"خارجي\" للاتصال بالعقدة المحلية باستخدام HTTP API.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_external_description)"
   },
-  "option_ipfsNodeType_embedded_description": {
-    "message": "اضبط على \"Embedded\" لتشغيل عقدة js-ipfs مباشرة في متصفحك. (انقر فوق \"قراءة المزيد\" للتعرف على قيود هذه الميزة التجريبية.)",
-    "description": "An option description on the Preferences screen (option_ipfsNodeType_embedded_description)"
-  },
   "option_ipfsNodeType_brave_description": {
     "message": "اضبط على \"المقدمة من Brave\" للاستفادة من دعم IPFS الأصلي لمتصفح Brave.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_brave_description)"
@@ -279,18 +271,10 @@
     "message": "تكوين عقدة IPFS",
     "description": "An option title on the Preferences screen (option_ipfsNodeConfig_title)"
   },
-  "option_ipfsNodeConfig_description": {
-    "message": "تكوين إضافي للعقدة JS IPFS المضمنة. يجب أن يكون JSON صالحًا.",
-    "description": "An option description on the Preferences screen (option_ipfsNodeConfig_description)"
-  },
   "option_ipfsNodeType_external": {
     "message": "خارجي",
     "description": "An option on the Preferences screen (option_ipfsNodeType_external)"
   },
-  "option_ipfsNodeType_embedded": {
-    "message": "المضمنة",
-    "description": "An option on the Preferences screen (option_ipfsNodeType_embedded)"
-  },
   "option_ipfsNodeType_brave": {
     "message": "مقدمة من Brave",
     "description": "An option on the Preferences screen (option_ipfsNodeType_brave)"

add-on/_locales/ca/messages.json

@@ -13,7 +13,7 @@
   },
   "panel_headerActiveToggleTitle": {
     "message": "Alterna totes les integracions IPFS",
-    "description": "A label for an embedded IPFS node (panel_headerActiveToggleTitle)"
+    "description": "A label for an toggling all IPFS integrations (panel_headerActiveToggleTitle)"
   },
   "panel_statusOffline": {
     "message": "Desconectat",
@@ -92,8 +92,8 @@
     "description": "A menu item tooltip in Browser Action pop-up (panel_importCurrentIpfsAddressTooltip)"
   },
   "panelCopy_currentIpnsAddress": {
-  "message": "Copy IPNS Path",
-  "description": "A menu item in Browser Action pop-up and right-click context menu (panelCopy_currentIpnsAddress)"
+    "message": "Copy IPNS Path",
+    "description": "A menu item in Browser Action pop-up and right-click context menu (panelCopy_currentIpnsAddress)"
   },
   "panelCopy_currentIpnsAddressTooltip": {
     "message": "Use this content path with IPFS tools and gateways to reach the most recently updated version of this tab's content.",
@@ -239,19 +239,19 @@
     "message": "Failed to Stop IPFS Node",
     "description": "System notification title displayed when stopping an IPFS node fails (notify_stopIpfsNodeErrorTitle)"
   },
-  "option_page_title" : {
+  "option_page_title": {
     "message": "Preferències | IPFS Companion",
     "description": "Title of the Preferences page (option_page_title)"
   },
-  "option_page_header" : {
+  "option_page_header": {
     "message": "Preferències de Companion",
     "description": "Main header on the Preferences screen (option_page_header)"
   },
-  "option_legend_readMore" : {
+  "option_legend_readMore": {
     "message": "Llegir més",
     "description": "A generic link in option description on the Preferences screen (option_legend_readMore)"
   },
-  "option_header_nodeType" : {
+  "option_header_nodeType": {
     "message": "Node IPFS",
     "description": "A section header on the Preferences screen (option_header_nodeType)"
   },
@@ -267,10 +267,6 @@
     "message": "Set to \"External\" to connect to a local node using the HTTP API.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_external_description)"
   },
-  "option_ipfsNodeType_embedded_description": {
-    "message": "Set to \"Embedded\" to run a js-ipfs node directly in your browser. (Click \"Read more\" to learn about the limitations of this experimental feature.)",
-    "description": "An option description on the Preferences screen (option_ipfsNodeType_embedded_description)"
-  },
   "option_ipfsNodeType_brave_description": {
     "message": "Set to \"Provided by Brave\" to leverage the Brave browser's native IPFS support.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_brave_description)"
@@ -279,18 +275,10 @@
     "message": "Configurar Node IPFS",
     "description": "An option title on the Preferences screen (option_ipfsNodeConfig_title)"
   },
-  "option_ipfsNodeConfig_description": {
-    "message": "Configuració addicional pel node incrustat JS IPFS. Ha de ser un JSON vàlid.",
-    "description": "An option description on the Preferences screen (option_ipfsNodeConfig_description)"
-  },
   "option_ipfsNodeType_external": {
     "message": "Extern",
     "description": "An option on the Preferences screen (option_ipfsNodeType_external)"
   },
-  "option_ipfsNodeType_embedded": {
-    "message": "Incrustat",
-    "description": "An option on the Preferences screen (option_ipfsNodeType_embedded)"
-  },
   "option_ipfsNodeType_brave": {
     "message": "Provided by Brave",
     "description": "An option on the Preferences screen (option_ipfsNodeType_brave)"

add-on/_locales/cs/messages.json

@@ -13,7 +13,7 @@
   },
   "panel_headerActiveToggleTitle": {
     "message": "Zapnout/vypnout IPFS integraci",
-    "description": "A label for an embedded IPFS node (panel_headerActiveToggleTitle)"
+    "description": "A label for an toggling all IPFS integrations (panel_headerActiveToggleTitle)"
   },
   "panel_statusOffline": {
     "message": "odpojený",
@@ -92,8 +92,8 @@
     "description": "A menu item tooltip in Browser Action pop-up (panel_importCurrentIpfsAddressTooltip)"
   },
   "panelCopy_currentIpnsAddress": {
-  "message": "Kopírovat IPNS cestu",
-  "description": "A menu item in Browser Action pop-up and right-click context menu (panelCopy_currentIpnsAddress)"
+    "message": "Kopírovat IPNS cestu",
+    "description": "A menu item in Browser Action pop-up and right-click context menu (panelCopy_currentIpnsAddress)"
   },
   "panelCopy_currentIpnsAddressTooltip": {
     "message": "Pomocí této cesty k obsahu se pomocí nástrojů a bran IPFS dostanete k poslední aktualizované verzi obsahu této karty.",
@@ -239,19 +239,15 @@
     "message": "Nepodařilo se zastavit uzel IPFS",
     "description": "System notification title displayed when stopping an IPFS node fails (notify_stopIpfsNodeErrorTitle)"
   },
-  "option_page_title" : {
+  "option_page_title": {
     "message": "Předvolby | IPFS Companion",
     "description": "Title of the Preferences page (option_page_title)"
   },
-  "option_page_header" : {
+  "option_page_header": {
     "message": "Předvolby Companion",
     "description": "Main header on the Preferences screen (option_page_header)"
   },
-  "option_legend_readMore" : {
-    "message": "Více informací",
-    "description": "A generic link in option description on the Preferences screen (option_legend_readMore)"
-  },
-  "option_header_nodeType" : {
+  "option_header_nodeType": {
     "message": "IPFS uzel",
     "description": "A section header on the Preferences screen (option_header_nodeType)"
   },
@@ -267,10 +263,6 @@
     "message": "Nastavením na hodnotu \"Externí\" se připojíte k místnímu uzlu pomocí rozhraní HTTP API.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_external_description)"
   },
-  "option_ipfsNodeType_embedded_description": {
-    "message": "Nastavením na \"Embedded\" spustíte uzel js-ipfs přímo v prohlížeči. (Kliknutím na \"Přečtěte si více\" se dozvíte o omezeních této experimentální funkce.)",
-    "description": "An option description on the Preferences screen (option_ipfsNodeType_embedded_description)"
-  },
   "option_ipfsNodeType_brave_description": {
     "message": "Nastavte možnost \"Provided by Brave\", abyste využili nativní podporu IPFS v prohlížeči Brave.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_brave_description)"
@@ -279,18 +271,10 @@
     "message": "Konfigurace IPFS uzlu",
     "description": "An option title on the Preferences screen (option_ipfsNodeConfig_title)"
   },
-  "option_ipfsNodeConfig_description": {
-    "message": "Další konfigurace pro embedovaný uzel JS IPFS. Musí to být platný JSON.",
-    "description": "An option description on the Preferences screen (option_ipfsNodeConfig_description)"
-  },
   "option_ipfsNodeType_external": {
     "message": "Externí",
     "description": "An option on the Preferences screen (option_ipfsNodeType_external)"
   },
-  "option_ipfsNodeType_embedded": {
-    "message": "Integrovaný",
-    "description": "An option on the Preferences screen (option_ipfsNodeType_embedded)"
-  },
   "option_ipfsNodeType_brave": {
     "message": "Poskytuje Brave",
     "description": "An option on the Preferences screen (option_ipfsNodeType_brave)"

add-on/_locales/da/messages.json

@@ -9,7 +9,7 @@
   },
   "panel_headerActiveToggleTitle": {
     "message": "Skift alle IPFS integrationer",
-    "description": "A label for an embedded IPFS node (panel_headerActiveToggleTitle)"
+    "description": "A label for an toggling all IPFS integrations (panel_headerActiveToggleTitle)"
   },
   "panel_statusOffline": {
     "message": "offline",
@@ -231,19 +231,15 @@
     "message": "Failed to Stop IPFS Node",
     "description": "System notification title displayed when stopping an IPFS node fails (notify_stopIpfsNodeErrorTitle)"
   },
-  "option_page_title" : {
+  "option_page_title": {
     "message": "Preferences | IPFS Companion",
     "description": "Title of the Preferences page (option_page_title)"
   },
-  "option_page_header" : {
+  "option_page_header": {
     "message": "Companion Preferences",
     "description": "Main header on the Preferences screen (option_page_header)"
   },
-  "option_legend_readMore" : {
-    "message": "Læs mere",
-    "description": "A generic link in option description on the Preferences screen (option_legend_readMore)"
-  },
-  "option_header_nodeType" : {
+  "option_header_nodeType": {
     "message": "IPFS-klient",
     "description": "A section header on the Preferences screen (option_header_nodeType)"
   },
@@ -259,34 +255,14 @@
     "message": "Set to \"External\" to connect to a local node using the HTTP API.",
     "description": "An option description on the Preferences screen (option_ipfsNodeType_description)"
   },
-  "option_ipfsNodeType_embedded_description": {
-    "message": "Set to \"Embedded\" to run a js-ipfs node directly in your browser. (Click \"Read more\" to learn about the limitations of this experimental feature.)",
-    "description": "An option description on the Preferences screen (option_ipfsNodeType_description)"
-  },
-  "option_ipfsNodeType_embedded_chromesockets_description": {
-    "message": "Embedded with Chrome Sockets: run js-ipfs node in your browser with access to chrome.sockets APIs (details under the link below)",
-    "description": "An option description on the Preferences screen (option_ipfsNodeType_description)"
-  },
   "option_ipfsNodeConfig_title": {
     "message": "IPFS-klient opsætning",
     "description": "An option title on the Preferences screen (option_ipfsNodeConfig_title)"
   },
-  "option_ipfsNodeConfig_description": {
-    "message": "Additional configuration for the embedded JS IPFS node. Must be valid JSON.",
-    "description": "An option description on the Preferences screen (option_ipfsNodeConfig_description)"
-  },
   "option_ipfsNodeType_external": {
     "message": "Ekstern",
     "description": "An option on the Preferences screen (option_ipfsNodeType_external)"
   },
-  "option_ipfsNodeType_embedded": {
-    "message": "Indlejret",
-    "description": "An option on the Preferences screen (option_ipfsNodeType_embedded)"
-  },
-  "option_ipfsNodeType_embedded_chromesockets": {
-    "message": "Indlejret + chrome.sockets",
-    "description": "An option on the Preferences screen (option_ipfsNodeType_embedded_chromesockets)"
-  },
   "option_header_gateways": {
     "message": "Gateways",
     "description": "A section header on the Preferences screen (option_header_gateways)"