feat: add @icon metadata

Merge pull request #125 from Wupb/patch-1

.eslintrc

@@ -20,6 +20,8 @@
         "no-useless-constructor": "off",
         "@typescript-eslint/no-useless-constructor": "error",
         "no-dupe-class-members": "off",
+        "no-void": "off",
+        "no-use-before-define": "off",
         "@typescript-eslint/no-dupe-class-members": "error",
         "@typescript-eslint/no-floating-promises": "warn",
         "@typescript-eslint/member-delimiter-style": "warn",

.github/workflows/release.yml

@@ -78,7 +78,7 @@ jobs:
           cp dist/main.js $ARTIFACTS_DIR/musescore-downloader.user.js
           cp dist/ext.zip $ARTIFACTS_DIR/musescore-downloader.webextension.zip
           wget -q $CHROME_EXT_URL -P $ARTIFACTS_DIR/
-          wget -q https://github.com/Xmader/musescore-downloader/archive/$REF.tar.gz -P $ARTIFACTS_DIR/
+          wget -q https://github.com/Xmader/musescore-downloader/archive/$REF.tar.gz -O $ARTIFACTS_DIR/source.tar.gz
       - run: bash ./.github/workflows/get-signed-ext.sh
         env:
           EXT_ID: musescore-downloader

dist/main.js

@@ -5,7 +5,7 @@
 // @supportURL   https://github.com/Xmader/musescore-downloader/issues
 // @updateURL    https://msdl.librescore.org/install.user.js
 // @downloadURL  https://msdl.librescore.org/install.user.js
-// @version      0.23.13
+// @version      0.24.1
 // @description  download sheet music from musescore.com for free, no login or Musescore Pro required | 免登录、免 Musescore Pro，免费下载 musescore.com 上的曲谱
 // @author       Xmader
 // @match        https://musescore.com/*/*
@@ -331,7 +331,7 @@
             typeof GM[requiredMethod] !== 'undefined';
     };
 
-    const DISCORD_URL = 'https://discord.gg/kTyx6nUjMv';
+    const DISCORD_URL = 'https://discord.gg/gSsTUvJmD8';
     const escapeFilename = (s) => {
         return s.replace(/[\s<>:{}"/\\|?*~.\0\cA-\cZ]+/g, '_');
     };
@@ -26575,7 +26575,7 @@ Please pipe the document into a Node stream.\
     }
 
     /* eslint-disable no-extend-native */
-    const TYPE_REG = /id=(\d+)&type=(img|mp3|midi)/;
+    const TYPE_REG = /type=(img|mp3|midi)/;
     /**
      * I know this is super hacky.
      */
@@ -26596,8 +26596,9 @@ Please pipe the document into a Node stream.\
                                 const token = (_a = init === null || init === void 0 ? void 0 : init.headers) === null || _a === void 0 ? void 0 : _a.Authorization;
                                 if (typeof url === 'string' && token) {
                                     const m = url.match(TYPE_REG);
+                                    console$1.debug(url, token, m);
                                     if (m) {
-                                        const type = m[2];
+                                        const type = m[1];
                                         // eslint-disable-next-line no-unused-expressions
                                         (_b = l[type]) === null || _b === void 0 ? void 0 : _b.call(l, token);
                                     }
@@ -27036,7 +27037,8 @@ Please pipe the document into a Node stream.\
         },
     ];
 
-    const _getLink = (scorepack) => {
+    const _getLink = (indexingInfo) => {
+        const { scorepack } = JSON.parse(indexingInfo);
         return `https://librescore.org/score/${scorepack}`;
     };
     const getLibreScoreLink = (scoreinfo, _fetch = getFetch()) => __awaiter(void 0, void 0, void 0, function* () {
@@ -27055,7 +27057,7 @@ Please pipe the document into a Node stream.\
         return _getLink(res);
     });
 
-    var btnListCss = "div {\n  width: 422px;\n  right: 0;\n  margin: 0 18px 18px 0;\n\n  text-align: center;\n  align-items: center;\n  font-family: 'Open Sans', 'Roboto', 'Helvetica neue', Helvetica, sans-serif;\n  position: absolute;\n  z-index: 9999;\n  background: #f6f6f6;\n  min-width: 230px;\n\n  /* pass the scroll event through the btns background */\n  pointer-events: none;\n}\n\n@media screen and (max-width: 950px) {\n  div {\n    width: auto !important;\n  }\n}\n\nbutton {\n  width: 205px !important;\n  min-width: 205px;\n  height: 38px;\n\n  color: #fff;\n  background: #1f74bd;\n\n  cursor: pointer;\n  pointer-events: auto;\n\n  margin-bottom: 4px;\n  margin-right: 4px;\n  padding: 4px 12px;\n\n  justify-content: start;\n  align-self: center;\n\n  font-size: 16px;\n  border-radius: 2px;\n  border: 0;\n\n  display: inline-flex;\n  position: relative;\n\n  font-family: inherit;\n}\n\n/* fix `View in LibreScore` button text overflow */\nbutton:last-of-type {\n  width: unset !important;\n}\n\nsvg {\n  display: inline-block;\n  margin-right: 5px;\n  width: 20px;\n  height: 20px;\n  margin-top: auto;\n  margin-bottom: auto;\n}\n\nspan {\n  margin-top: auto;\n  margin-bottom: auto;\n}";
+    var btnListCss = "div {\n  width: 422px;\n  right: 0;\n  margin: 0 18px 18px 0;\n\n  text-align: center;\n  align-items: center;\n  font-family: 'Inter', 'Helvetica neue', Helvetica, sans-serif;\n  position: absolute;\n  z-index: 9999;\n  background: #f6f6f6;\n  min-width: 230px;\n\n  /* pass the scroll event through the btns background */\n  pointer-events: none;\n}\n\n@media screen and (max-width: 950px) {\n  div {\n    width: auto !important;\n  }\n}\n\nbutton {\n  width: 178px !important;\n  min-width: 178px;\n  height: 40px;\n\n  color: #fff;\n  background: #2e68c0;\n\n  cursor: pointer;\n  pointer-events: auto;\n\n  margin-bottom: 8px;\n  margin-right: 8px;\n  padding: 4px 12px;\n\n  justify-content: start;\n  align-self: center;\n\n  font-size: 16px;\n  border-radius: 6px;\n  border: 0;\n\n  display: inline-flex;\n  position: relative;\n\n  font-family: inherit;\n}\n\n/* fix `View in LibreScore` button text overflow */\nbutton:last-of-type {\n  width: unset !important;\n}\n\nbutton:hover {\n  background: #1a4f9f;\n}\n\n/* light theme btn */\nbutton.light {\n  color: #2e68c0;\n  background: #e1effe;\n}\n\nbutton.light:hover {\n  background: #c3ddfd;\n}\n\nsvg {\n  display: inline-block;\n  margin-right: 5px;\n  width: 20px;\n  height: 20px;\n  margin-top: auto;\n  margin-bottom: auto;\n}\n\nspan {\n  margin-top: auto;\n  margin-bottom: auto;\n}";
 
     var ICON;
     (function (ICON) {
@@ -27075,15 +27077,17 @@ Please pipe the document into a Node stream.\
             throw new Error('btn parent not found');
         return btnParent;
     };
-    const buildDownloadBtn = (icon) => {
+    const buildDownloadBtn = (icon, lightTheme = false) => {
         const btn = document.createElement('button');
         btn.type = 'button';
+        if (lightTheme)
+            btn.className = 'light';
         // build icon svg element
         const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
         svg.setAttribute('viewBox', '0 0 24 24');
         const svgPath = document.createElementNS('http://www.w3.org/2000/svg', 'path');
         svgPath.setAttribute('d', icon);
-        svgPath.setAttribute('fill', '#fff');
+        svgPath.setAttribute('fill', lightTheme ? '#2e68c0' : '#fff');
         svg.append(svgPath);
         const textNode = document.createElement('span');
         btn.append(svg, textNode);
@@ -27102,6 +27106,22 @@ Please pipe the document into a Node stream.\
             return getScrollParent(node.parentNode);
         }
     }
+    function onPageRendered(getEl) {
+        return new Promise((resolve) => {
+            var _a;
+            const observer = new MutationObserver(() => {
+                try {
+                    const el = getEl();
+                    if (el) {
+                        observer.disconnect();
+                        resolve(el);
+                    }
+                }
+                catch (_a) { }
+            });
+            observer.observe((_a = document.querySelector('div > section')) !== null && _a !== void 0 ? _a : document.body, { childList: true, subtree: true });
+        });
+    }
     var BtnListMode;
     (function (BtnListMode) {
         BtnListMode[BtnListMode["InPage"] = 0] = "InPage";
@@ -27114,7 +27134,7 @@ Please pipe the document into a Node stream.\
         }
         add(options) {
             var _a;
-            const btnTpl = buildDownloadBtn((_a = options.icon) !== null && _a !== void 0 ? _a : ICON.DOWNLOAD);
+            const btnTpl = buildDownloadBtn((_a = options.icon) !== null && _a !== void 0 ? _a : ICON.DOWNLOAD, options.lightTheme);
             const setText = (btn) => {
                 const textNode = btn.querySelector('span');
                 return (str) => {
@@ -27166,10 +27186,9 @@ Please pipe the document into a Node stream.\
             const newParent = document.createElement('div');
             newParent.append(...this.list.map(e => cloneBtn(e)));
             shadow.append(newParent);
-            // default position 
-            newParent.style.top = '0px';
-            try {
-                const anchorDiv = this.getBtnParent();
+            // default position
+            newParent.style.top = `${window.innerHeight - newParent.getBoundingClientRect().height}px`;
+            void onPageRendered(this.getBtnParent).then((anchorDiv) => {
                 const pos = () => this._positionBtns(anchorDiv, newParent);
                 pos();
                 // reposition btns when window resizes
@@ -27177,10 +27196,7 @@ Please pipe the document into a Node stream.\
                 // reposition btns when scrolling
                 const scroll = getScrollParent(anchorDiv);
                 scroll.addEventListener('scroll', pos, { passive: true });
-            }
-            catch (err) {
-                console$1.error(err);
-            }
+            });
             return btnParent;
         }
         /**
@@ -27313,7 +27329,7 @@ Please pipe the document into a Node stream.\
     class ScoreInfo {
         constructor() {
             this.RADIX = 20;
-            this.INDEX_RADIX = 128;
+            this.INDEX_RADIX = 32;
             this.store = new Map();
         }
         get idLastDigit() {
@@ -27329,7 +27345,7 @@ Please pipe the document into a Node stream.\
             return `https://ipfs.infura.io:5001/api/v0/block/stat?arg=${this.getMsczIpfsRef(mainCid)}`;
         }
         getScorepackRef(mainCid) {
-            return `/ipfs/${mainCid}/index/${(+this.id) % this.INDEX_RADIX}/${this.id}/scorepack`;
+            return `/ipfs/${mainCid}/index/${(+this.id) % this.INDEX_RADIX}/${this.id}`;
         }
     }
     class ScoreInfoInPage extends ScoreInfo {
@@ -27428,7 +27444,7 @@ Please pipe the document into a Node stream.\
             action: BtnAction.process(() => downloadPDF(scoreinfo, new SheetInfoInPage(document)), fallback, 3 * 60 * 1000 /* 3min */),
         });
         btnList.add({
-            name: i18n('DOWNLOAD')('MusicXML'),
+            name: i18n('DOWNLOAD')('MXL'),
             action: BtnAction.mscoreWindow(scoreinfo, (w, score) => __awaiter(void 0, void 0, void 0, function* () {
                 const mxl = yield score.saveMxl();
                 const data = new Blob([mxl]);
@@ -27508,7 +27524,9 @@ Please pipe the document into a Node stream.\
             action: BtnAction.openUrl(() => getLibreScoreLink(scoreinfo)),
             tooltip: 'BETA',
             icon: ICON.LIBRESCORE,
+            lightTheme: true,
         });
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         btnList.commit(BtnListMode.InPage);
     };
     // eslint-disable-next-line @typescript-eslint/no-floating-promises

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "musescore-downloader",
-  "version": "0.23.13",
+  "version": "0.24.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "musescore-downloader",
-  "version": "0.23.13",
+  "version": "0.24.1",
   "description": "download sheet music from musescore.com for free, no login or Musescore Pro required | 免登录、免 Musescore Pro，免费下载 musescore.com 上的曲谱",
   "main": "dist/main.js",
   "bin": "dist/cli.js",

src/btn.css

@@ -5,7 +5,7 @@ div {
 
   text-align: center;
   align-items: center;
-  font-family: 'Open Sans', 'Roboto', 'Helvetica neue', Helvetica, sans-serif;
+  font-family: 'Inter', 'Helvetica neue', Helvetica, sans-serif;
   position: absolute;
   z-index: 9999;
   background: #f6f6f6;
@@ -22,25 +22,25 @@ div {
 }
 
 button {
-  width: 205px !important;
-  min-width: 205px;
-  height: 38px;
+  width: 178px !important;
+  min-width: 178px;
+  height: 40px;
 
   color: #fff;
-  background: #1f74bd;
+  background: #2e68c0;
 
   cursor: pointer;
   pointer-events: auto;
 
-  margin-bottom: 4px;
-  margin-right: 4px;
+  margin-bottom: 8px;
+  margin-right: 8px;
   padding: 4px 12px;
 
   justify-content: start;
   align-self: center;
 
   font-size: 16px;
-  border-radius: 2px;
+  border-radius: 6px;
   border: 0;
 
   display: inline-flex;
@@ -54,6 +54,20 @@ button:last-of-type {
   width: unset !important;
 }
 
+button:hover {
+  background: #1a4f9f;
+}
+
+/* light theme btn */
+button.light {
+  color: #2e68c0;
+  background: #e1effe;
+}
+
+button.light:hover {
+  background: #c3ddfd;
+}
+
 svg {
   display: inline-block;
   margin-right: 5px;

src/btn.ts

@@ -25,16 +25,17 @@ const getBtnContainer = (): HTMLDivElement => {
   return btnParent
 }
 
-const buildDownloadBtn = (icon: ICON) => {
+const buildDownloadBtn = (icon: ICON, lightTheme = false) => {
   const btn = document.createElement('button')
   btn.type = 'button'
+  if (lightTheme) btn.className = 'light'
 
   // build icon svg element
   const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg')
   svg.setAttribute('viewBox', '0 0 24 24')
   const svgPath = document.createElementNS('http://www.w3.org/2000/svg', 'path')
   svgPath.setAttribute('d', icon)
-  svgPath.setAttribute('fill', '#fff')
+  svgPath.setAttribute('fill', lightTheme ? '#2e68c0' : '#fff')
   svg.append(svgPath)
 
   const textNode = document.createElement('span')
@@ -57,12 +58,28 @@ function getScrollParent (node: HTMLElement): HTMLElement {
   }
 }
 
+function onPageRendered (getEl: () => HTMLElement) {
+  return new Promise<HTMLElement>((resolve) => {
+    const observer = new MutationObserver(() => {
+      try {
+        const el = getEl()
+        if (el) {
+          observer.disconnect()
+          resolve(el)
+        }
+      } catch { }
+    })
+    observer.observe(document.querySelector('div > section') ?? document.body, { childList: true, subtree: true })
+  })
+}
+
 interface BtnOptions {
   readonly name: string;
   readonly action: BtnAction;
   readonly disabled?: boolean;
   readonly tooltip?: string;
   readonly icon?: ICON;
+  readonly lightTheme?: boolean;
 }
 
 export enum BtnListMode {
@@ -76,7 +93,7 @@ export class BtnList {
   constructor (private getBtnParent: () => HTMLDivElement = getBtnContainer) { }
 
   add (options: BtnOptions): BtnElement {
-    const btnTpl = buildDownloadBtn(options.icon ?? ICON.DOWNLOAD)
+    const btnTpl = buildDownloadBtn(options.icon ?? ICON.DOWNLOAD, options.lightTheme)
     const setText = (btn: BtnElement) => {
       const textNode = btn.querySelector('span')
       return (str: string): void => {
@@ -139,10 +156,10 @@ export class BtnList {
     newParent.append(...this.list.map(e => cloneBtn(e)))
     shadow.append(newParent)
 
-    // default position 
-    newParent.style.top = '0px'
-    try {
-      const anchorDiv = this.getBtnParent()
+    // default position
+    newParent.style.top = `${window.innerHeight - newParent.getBoundingClientRect().height}px`
+
+    void onPageRendered(this.getBtnParent).then((anchorDiv: HTMLDivElement) => {
       const pos = () => this._positionBtns(anchorDiv, newParent)
       pos()
 
@@ -152,9 +169,7 @@ export class BtnList {
       // reposition btns when scrolling
       const scroll = getScrollParent(anchorDiv)
       scroll.addEventListener('scroll', pos, { passive: true })
-    } catch (err) {
-      console.error(err)
-    }
+    })
 
     return btnParent
   }

src/file.ts

@@ -6,7 +6,7 @@ import { console } from './utils'
 
 type FileType = 'img' | 'mp3' | 'midi'
 
-const TYPE_REG = /id=(\d+)&type=(img|mp3|midi)/
+const TYPE_REG = /type=(img|mp3|midi)/
 
 /**
  * I know this is super hacky.
@@ -31,8 +31,9 @@ const magicHookConstr = (() => {
               const token = init?.headers?.Authorization
               if (typeof url === 'string' && token) {
                 const m = url.match(TYPE_REG)
+                console.debug(url, token, m)
                 if (m) {
-                  const type = m[2]
+                  const type = m[1]
                   // eslint-disable-next-line no-unused-expressions
                   l[type]?.(token)
                 }

src/librescore-link.ts

@@ -2,8 +2,9 @@ import { assertRes, getFetch } from './utils'
 import { getMainCid } from './mscz'
 import { ScoreInfo } from './scoreinfo'
 
-const _getLink = (scorepack: string) => {
-  return `https://librescore.org/score/${scorepack}`
+const _getLink = (indexingInfo: string) => {
+  const { scorepack } = JSON.parse(indexingInfo)
+  return `https://librescore.org/score/${scorepack as string}`
 }
 
 export const getLibreScoreLink = async (scoreinfo: ScoreInfo, _fetch = getFetch()): Promise<string> => {

src/main.ts

@@ -38,7 +38,7 @@ const main = (): void => {
   })
 
   btnList.add({
-    name: i18n('DOWNLOAD')('MusicXML'),
+    name: i18n('DOWNLOAD')('MXL'),
     action: BtnAction.mscoreWindow(scoreinfo, async (w, score) => {
       const mxl = await score.saveMxl()
       const data = new Blob([mxl])
@@ -137,8 +137,10 @@ const main = (): void => {
     action: BtnAction.openUrl(() => getLibreScoreLink(scoreinfo)),
     tooltip: 'BETA',
     icon: ICON.LIBRESCORE,
+    lightTheme: true,
   })
 
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
   btnList.commit(BtnListMode.InPage)
 }
 

src/meta.js

@@ -8,6 +8,7 @@
 // @version      %VERSION%
 // @description  download sheet music from musescore.com for free, no login or Musescore Pro required | 免登录、免 Musescore Pro，免费下载 musescore.com 上的曲谱
 // @author       Xmader
+// @icon         https://librescore.org/img/icons/logo.svg
 // @match        https://musescore.com/*/*
 // @match        https://s.musescore.com/*/*
 // @license      MIT

src/scoreinfo.ts

@@ -4,7 +4,7 @@ import { getMainCid } from './mscz'
 
 export abstract class ScoreInfo {
   private readonly RADIX = 20;
-  private readonly INDEX_RADIX = 128;
+  private readonly INDEX_RADIX = 32;
 
   abstract id: number;
   abstract title: string;
@@ -28,7 +28,7 @@ export abstract class ScoreInfo {
   }
 
   public getScorepackRef (mainCid: string): string {
-    return `/ipfs/${mainCid}/index/${(+this.id) % this.INDEX_RADIX}/${this.id}/scorepack`
+    return `/ipfs/${mainCid}/index/${(+this.id) % this.INDEX_RADIX}/${this.id}`
   }
 }
 

src/utils.ts

@@ -2,7 +2,7 @@
 import isNodeJs from 'detect-node'
 import { isGmAvailable, _GM } from './gm'
 
-export const DISCORD_URL = 'https://discord.gg/kTyx6nUjMv'
+export const DISCORD_URL = 'https://discord.gg/gSsTUvJmD8'
 
 export const escapeFilename = (s: string): string => {
   return s.replace(/[\s<>:{}"/\\|?*~.\0\cA-\cZ]+/g, '_')