npm - iureiure - Versions diffs - 1.0.0 - Mend

iureiure 1.0.0

Files changed (1410) hide show

package/examples/chrome-extension/background-script/service-worker.js ADDED Viewed

@@ -0,0 +1,28 @@
+// This is the service worker script, which executes in its own context
+// when the extension is installed or refreshed (or when you access its console).
+// It would correspond to the background script in chrome extensions v2.
+console.log('This prints to the console of the service worker (background script)');
+// Importing and using functionality from external files is also possible.
+import { Analytics } from './rudderAnalytics.js';
+console.log(Analytics);
+const rudderClient = new Analytics('<writeKey>', '<dataPlaneURL>/v1/batch', {
+  logLevel: 'silly',
+});
+chrome.tabs.onUpdated.addListener((tabId, tab) => {
+  if (tab.url) {
+    rudderClient.track({
+      userId: '123456',
+      event: 'Event Name',
+      properties: {
+        data: {
+          url: tab.url,
+        },
+      },
+    });
+  }
+});

package/examples/chrome-extension/background-script/settings/settings.css ADDED Viewed

@@ -0,0 +1,8 @@
+body {
+  background-color: #222;
+  color: #eee;
+}
+.special-text {
+  color: red;
+}

package/examples/chrome-extension/background-script/settings/settings.html ADDED Viewed

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <link rel="stylesheet" href="settings.css" />
+    <title>Rudderstack SDK: Chrome Extension Background Script Sample: Settings</title>
+  </head>
+  <body>
+    This is the <span class="special-text">settings</span> page for the addon.
+  </body>
+</html>

package/examples/chrome-extension/background-script-websockets/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2021 RudderStack
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/examples/chrome-extension/background-script-websockets/README.md ADDED Viewed

@@ -0,0 +1,101 @@
+<div align="center">
+    <img src="https://raw.githubusercontent.com/SimGus/chrome-addon-v3-starter/master/logo/logo-128.png"/>
+    <h1>Chrome Extension v3 Starter</h1>
+    <h3>A minimal template of a Chrome v3 addon</h3>
+</div>
+This repository contains a minimal Chrome/Chromium extension that uses the newest version of the manifest (v3).
+You can use it as a basis to develop an extension.
+It can also give you more insights about how to turn a v2 extension to v3.
+In other words, this is a **working, installable v3 extension** example meant for you to **jumpstart** the development of your own extension.
+## Installation
+- **Fork** this repo, then **clone your forked repo locally**. If you don't have a github account, you can simply download a zip of the repo and unzip it on your computer.
+- **Open [the extensions page](chrome://extensions)** in your browser: `chrome://extensions`. This link works on any chromium-based browser.
+- If you did not do it already, **toggle the "developer mode"**. This is usually a toggle button at the top right of the extensions page.
+- Click the button **_load unpacked extension_**.
+- In the window that pops up, **select the folder that contains this minimal extension**, then **click _ok_**.
+- **Done!** A new extension called _Chrome Addon v3 Starter_ should have appeared in the list.
+## Q&A
+> Does this work only on Chrome or on **other web browsers** as well?
+At the moment, this works on every chromium-based web browser that supports v3 extensions.
+Therefore, you should be able to install this extension on any of the following browsers (as long as they are up-to-date):
+- _Free and open-source browsers_:
+    - Chromium
+    - Brave
+- _Proprietary browsers_:
+    - Chrome
+    - Edge
+    - Vivaldi
+    - Opera
+> So it doesn't work on **Firefox** or **Safari**?
+No, Firefox uses a different extension format. That being said, it is usually not too hard to port extensions from Chrome to Firefox.
+Read [their porting documentation](https://extensionworkshop.com/documentation/develop/porting-a-google-chrome-extension/) for more information.
+Safari uses yet another extension format and porting is usually harder.
+You can find more information [here](https://bartsolutions.github.io/2020/11/20/safari-extension/).
+> Does this work on **Chrome for Android/iOS**?
+Chrome for mobile doesn't currently support extensions.
+> I don't need a **popup tool** for my extension! Can I remove it?
+Yes, simply delete the `popup` folder and remove the `default_popup` property from the manifest.
+> I changed some code in the extension, but my **changes aren't taken into account**!
+For most of the changes you make, you will need to reload your extension for the changes to be applied.
+To do that, go to the chrome://extensions page and click the reload button of your extension.
+Note that most of the changes you will make to the settings page or the popup don't require reloading the extension.
+> Can I follow a **tutorial about a v2 extension** with this?
+Most of what you will find in those tutorials still holds with v3.
+However, a few things (notably best practices) have changed.
+You should read the [official migration page (v2 to v3)](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-migration/) before following such a tutorial.
+> When I make an erroneous change in my service worker, the extension doesn't load! How can I **debug a service worker**?
+Using the debugger if your service worker is not loaded is not possible.
+However, if you want to test some piece of code before putting it in your service worker, you can:
+- load your extension with a working version of the service worker.
+- click on "service worker" on the page _chrome://extensions_. This will open the console attached to the service worker.
+- paste your code in the console and see if any error is logged.
+Note that in this console, you have access to anything your service worker has access to, including its variables, functions and chrome APIs.
+> How do I **uninstall** this extension from my browser?
+- Go to the [extensions page](chrome://extensions): chrome://extensions.
+  There should be a card with the name of this extension as title.
+  If you don't see such a card, it means the extension is not installed.
+- Simply click the _Delete_ button at the bottom of the card. Click _ok_ if a popup asks you for confirmation. The extension is now uninstalled.
+> I want to **push my changes to my own repo**, how do I do this?
+- If you forked this repo and cloned your own fork locally, git will push to your fork on your account automatically (i.e. use the command `git push` or `git push origin <your-branch>`).
+- If you downloaded a zip or simply cloned this repo locally, do the following:
+    - Create a github account if you don't already have one and install git on your machine.
+    - Create a new (empty) repo on your github and copy its url.
+    - Open a terminal in the folder where the extension is cloned.
+    - Run the command `git init`, then `git commit -am "Initial commit"`
+    - Run the command `git remote add origin <url-of-your-repo>`
+    - Run `git push -u origin master`. The extension code is now on your repo, on brnach _master_.
+    - If you want, you can make the _master_ branch the default one and delete the _main_ branch in the settings of your repo.
+## External resources
+- [Official feature summary for manifest v3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-overview/)
+- [Migrating from v2 to v3](https://developer.chrome.com/docs/extensions/mv3/intro/mv3-migration/) + [very useful checklist once you think you are done](https://developer.chrome.com/docs/extensions/mv3/mv3-migration-checklist/)
+- [Excellent write-ups of a migration](https://github.com/kentbrew/learning-manifest-v3)
+- [Another example of a v3 extension (older code)](https://gist.github.com/dotproto/3a328d6b187621b445499ba503599dc0)

package/examples/chrome-extension/background-script-websockets/foreground.js ADDED Viewed

@@ -0,0 +1,7 @@
+// This script gets injected into any opened page
+// whose URL matches the pattern defined in the manifest
+// (see "content_script" key).
+// Several foreground scripts can be declared
+// and injected into the same or different pages.
+console.log("This prints to the console of the page (injected only if the page url matched)")

package/examples/chrome-extension/background-script-websockets/logo/logo-128.png ADDED Viewed

Binary file

package/examples/chrome-extension/background-script-websockets/logo/logo-16.png ADDED Viewed

Binary file

package/examples/chrome-extension/background-script-websockets/logo/logo-48.png ADDED Viewed

Binary file

package/examples/chrome-extension/background-script-websockets/logo/logo.svg ADDED Viewed

@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="5.8741975mm"
+   height="5.8741975mm"
+   viewBox="0 0 5.8741975 5.8741975"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.3 (2405546, 2018-03-11)"
+   sodipodi:docname="logo.svg"
+   inkscape:export-filename="/home/simon/Lien vers Files/Programming/Browser-addons/chrome-addon-v3-starter/logo/logo-128.png"
+   inkscape:export-xdpi="553.47137"
+   inkscape:export-ydpi="553.47137">
+  <defs
+     id="defs2">
+    <linearGradient
+       id="linearGradient992"
+       inkscape:collect="always">
+      <stop
+         id="stop988"
+         offset="0"
+         style="stop-color:#6dd47e;stop-opacity:1" />
+      <stop
+         id="stop990"
+         offset="1"
+         style="stop-color:#ffd55a;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient
+       inkscape:collect="always"
+       id="linearGradient982">
+      <stop
+         style="stop-color:#6dd47e;stop-opacity:1"
+         offset="0"
+         id="stop978" />
+      <stop
+         style="stop-color:#ffd55a;stop-opacity:1"
+         offset="1"
+         id="stop980" />
+    </linearGradient>
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient982"
+       id="linearGradient984"
+       x1="29.799274"
+       y1="65.80043"
+       x2="32.461639"
+       y2="61.674587"
+       gradientUnits="userSpaceOnUse" />
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#linearGradient992"
+       id="linearGradient986"
+       x1="125.58246"
+       y1="241.31987"
+       x2="130.39503"
+       y2="233.86185"
+       gradientUnits="userSpaceOnUse" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="32"
+     inkscape:cx="9.4060156"
+     inkscape:cy="10.261868"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:window-width="1920"
+     inkscape:window-height="1056"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="0" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Calque 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-27.740484,-61.108589)"
+     style="opacity:1">
+    <g
+       aria-label="v"
+       transform="matrix(0.39299767,0,0,0.35804726,-14.850221,-22.602919)"
+       style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:13.33347988px;line-height:1.25;font-family:'Fira Code';-inkscape-font-specification:'Fira Code, Medium';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
+       id="flowRoot815" />
+    <g
+       aria-label="3"
+       transform="matrix(0.55320903,0,0,0.55320903,-39.674075,-67.699903)"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.33333397px;line-height:1.25;font-family:'Fira Code';-inkscape-font-specification:'Fira Code, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.28696206;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none"
+       id="flowRoot823">
+      <g
+         id="g859"
+         style="stroke:none;stroke-width:0.28696206;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;fill:#000000">
+        <g
+           id="g997">
+          <path
+             style="opacity:1;font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:13.33347988px;line-height:1.25;font-family:'Fira Code';-inkscape-font-specification:'Fira Code, Medium';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:url(#linearGradient984);fill-opacity:1;stroke:none;stroke-width:0.15875001;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none"
+             inkscape:connector-curvature="0"
+             id="path834"
+             d="m 29.571182,65.570738 h -0.704043 l -0.999637,-2.585312 h 0.644929 l 0.720168,2.129944 0.722853,-2.129944 h 0.615367 z"
+             transform="matrix(1.807635,0,0,1.807635,71.716248,122.37671)" />
+          <path
+             style="stroke:none;stroke-width:0.28696206;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;fill:url(#linearGradient986);fill-opacity:1"
+             d="m 129.05656,233.2864 q 0.86154,0 1.51795,0.32137 0.66325,0.31453 1.0188,0.8547 0.35556,0.53333 0.35556,1.17607 0,0.55384 -0.25299,1.02564 -0.24616,0.46496 -0.67009,0.77265 -0.41709,0.30085 -0.91624,0.39658 0.57436,0.0479 1.05983,0.32821 0.48547,0.2735 0.77949,0.77948 0.30085,0.50599 0.30085,1.19658 0,0.81368 -0.41709,1.47009 -0.41026,0.64957 -1.15556,1.02564 -0.73846,0.37607 -1.69572,0.37607 -0.83419,0 -1.60684,-0.31453 -0.77265,-0.31453 -1.28547,-0.94359 l 0.77265,-0.62906 q 0.38974,0.45812 0.94359,0.69744 0.55384,0.23931 1.14872,0.23931 0.64957,0 1.12136,-0.23248 0.4718,-0.23248 0.71795,-0.66324 0.25299,-0.43761 0.25299,-1.02565 0,-1.78461 -1.94871,-1.78461 h -0.79317 l 0.14359,-0.9094 h 0.55385 q 0.47179,0 0.88205,-0.17778 0.41026,-0.18462 0.65641,-0.55385 0.25299,-0.37607 0.25299,-0.9094 0,-0.50598 -0.23931,-0.86154 -0.23248,-0.36239 -0.6359,-0.54701 -0.40342,-0.19145 -0.90256,-0.19145 -0.59488,0 -1.053,0.21197 -0.45812,0.20513 -0.94359,0.65641 l -0.63589,-0.70428 q 1.14871,-1.08034 2.6735,-1.08034 z"
+             id="path831"
+             inkscape:connector-curvature="0" />
+        </g>
+      </g>
+    </g>
+  </g>
+</svg>

package/examples/chrome-extension/background-script-websockets/manifest.json ADDED Viewed

@@ -0,0 +1,37 @@
+{
+    // Comments are accepted in the manifest, even though it is JSON.
+    "manifest_version": 3,
+    "name": "Rudderstack SDK: Chrome Extension Background Script Sample",
+    "description": "A minimal example of a chrome extension using manifest v3",
+    "version": "0.0.1",
+    "icons": {
+        "16": "logo/logo-16.png",
+        "48": "logo/logo-48.png",
+        "128": "logo/logo-128.png"
+    },
+    "options_page": "settings/settings.html",
+    "action": {
+        "default_title": "Rudderstack SDK: Chrome Extension Background Script Sample",
+        "default_popup": "popup/popup.html"
+    },
+    "permissions": ["storage", "tabs"],
+    "host_permissions": [
+        "https://*.dataplane.rudderstack.com/*",
+        "https://*.rudderlabs.com/*",
+        "*://*/*"
+    ],
+    "externally_connectable": {
+        "matches": [
+            "https://*.dataplane.rudderstack.com/*",
+            "https://*.rudderlabs.com/*"
+        ]
+    },
+    "background": {
+        "service_worker": "service-worker.js",
+        "type": "module"
+    },
+    "content_scripts": [{
+        "js": ["foreground.js"],
+        "matches": ["https://github.com/*"]
+    }]
+}

package/examples/chrome-extension/background-script-websockets/popup/popup.css ADDED Viewed

@@ -0,0 +1,11 @@
+body {
+    background-color: #222;
+    color: #eee;
+    width: 16rem;
+    height: 4rem;
+}
+.special-text {
+    color: red;
+}

package/examples/chrome-extension/background-script-websockets/popup/popup.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <link rel="stylesheet" href="popup.css">
+    <title>Rudderstack SDK: Chrome Extension Background Script Sample</title>
+</head>
+<body>
+    This is the <span class="special-text">HTML</span> body of the addon.
+</body>
+</html>