☰

API for CustomElements in YouTube

A JavaScript tool to modify CustomElements in YouTube

当前为 2023-07-04 提交的版本，查看 最新版本。

此脚本不应直接安装。它是供其他脚本使用的外部库，要使用该库请加入元指令 // @require https://update.cn-greasyfork.org/scripts/465819/1215280/API%20for%20CustomElements%20in%20YouTube.js 

  1. // ==UserScript==
  2. // @name         API for CustomElements in YouTube
  3. // @namespace    http://tampermonkey.net/
  4. // @version      1.4.3
  5. // @description  A JavaScript tool to modify CustomElements in YouTube
  6. // @author       CY Fung
  7. // @grant        none
  8. // @license      MIT
  9. // ==/UserScript==
  10.  
  11. /*
  12.  
  13. MIT License
  14.  
  15. Copyright (c) 2023 cyfung1031
  16.  
  17. Permission is hereby granted, free of charge, to any person obtaining a copy
  18. of this software and associated documentation files (the "Software"), to deal
  19. in the Software without restriction, including without limitation the rights
  20. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  21. copies of the Software, and to permit persons to whom the Software is
  22. furnished to do so, subject to the following conditions:
  23.  
  24. The above copyright notice and this permission notice shall be included in all
  25. copies or substantial portions of the Software.
  26.  
  27. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  28. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  29. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  30. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  31. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  32. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  33. SOFTWARE.
  34.  
  35. */
  36.  
  37. var customYtElements = (function () {
  38.   'use strict';
  39.  
  40.   const injectorCreationForRegistered = ((fnHandler) => {
  41.     let mMapOfFuncs = new WeakMap();
  42.     if (!(mMapOfFuncs instanceof WeakMap) || (typeof fnHandler !== 'function')) return console.error('[ytI] Incorrect parameters');
  43.     const $callee = function (...args) {
  44.  
  45.       const f = fnHandler;
  46.       if (!f) return console.error('[ytI] the injector is already destroyed.');
  47.  
  48.       const isControllerExtraction = typeof this.forwardMethods === 'function' && typeof this._registered === 'undefined';
  49.       const isComponentRegister = typeof this._registered === 'function' && typeof this.forwardMethods === 'undefined';
  50.       let warning = '';
  51.       if (isControllerExtraction) {
  52.         if (typeof this.inst !== 'object') {
  53.           warning += '[ytI] Controller Extraction is enabled but the corresponding instance is not found.\n';
  54.         }
  55.       } else if (isComponentRegister) {
  56.         //
  57.       } else {
  58.         warning += "[ytI] customYtElement's definition is undefined.\n";
  59.       }
  60.       const fnTag = f.__ytHandlerFuncName__;
  61.       if (isControllerExtraction && fnTag !== 'forwardMethods') {
  62.         warning += "[ytI] Unknown Error in injectorCreationForRegistered. (0x3F01)\n";
  63.       }
  64.       if (isComponentRegister && fnTag !== '_registered') {
  65.         warning += "[ytI] Unknown Error in injectorCreationForRegistered. (0x3F02)\n";
  66.       }
  67.       const map = mMapOfFuncs;
  68.       // CE prototype has not yet been "Object.defineProperties()"
  69.       const res = f.call(this, ...args); // normally shall be undefined with no arguments
  70.       // CE prototype has been "Object.defineProperties()"
  71.       let funcs = null;
  72.       try {
  73.         if (warning) throw warning.trim();
  74.         const constructor = this.constructor || null;
  75.         if (!constructor || !constructor.prototype) throw '[ytI] CE constructor is not found or invalid.';
  76.         // constructor.prototype.${fnTag} = f; // restore to original
  77.         delete constructor.prototype[fnTag];
  78.         if (constructor.prototype[fnTag] !== f) {
  79.           constructor.prototype[fnTag] = f;
  80.         }
  81.         funcs = map.get(constructor) || 0;
  82.         if (typeof funcs.length !== 'number') throw '[ytI] This injection function call is invalid.';
  83.         console.debug(`[ytI] ${constructor.prototype.is}'s ${fnTag} has been called.`);
  84.         map.set(constructor, null); // invalidate
  85.         const proto = isControllerExtraction ? this.inst.constructor.prototype : constructor.prototype;
  86.         for (const func of funcs) {
  87.           func(proto); // developers might implement Promise, setTimeout, or requestAnimation inside the `func`.
  88.         }
  89.       } catch (e) {
  90.         console.warn(e);
  91.       } finally {
  92.         if (funcs) funcs.length = 0;
  93.       }
  94.       return res;
  95.     }
  96.     $callee.__ytHandlerFuncName__ = fnHandler.__ytHandlerFuncName__;
  97.     $callee.getMap = () => mMapOfFuncs; // for external
  98.     $callee.getOriginalFunction = () => fnHandler; // for external
  99.     $callee.destroyObject = function () {
  100.       // in addition to GC
  101.       mMapOfFuncs = null; // WeakMap does not require clear()
  102.       fnHandler = null;
  103.       this.__injector__ = null;
  104.       this.getMap = null;
  105.       this.getOriginalFunction = null;
  106.       this.destroyObject = null;
  107.     }
  108.     // after all injected ${fnHandler} are called,
  109.     // customElements.get('ytd-watch-flexy').prototype.${fnHandler}.__injector__.deref() will become undefined.
  110.     const wrapped = typeof WeakRef === 'function' ? new WeakRef($callee) : $callee;
  111.     $callee.__injector__ = wrapped; // for ${fnHandler}.__injector__
  112.     return $callee;
  113.   });
  114.  
  115.   const injectionPool = (ceProto, fnTag, actionFn) => { // delay prototype injection
  116.     if (!(fnTag in ceProto)) return console.warn(`[ytI] no ${fnTag} is found in proto`);
  117.     const fnHandler = ceProto[fnTag]; // make a copy in this nested closure.
  118.     if (typeof fnHandler !== 'function') return console.warn(`[ytI] proto.${fnTag} is not a function`);
  119.     let injector = null;
  120.     if (injector = fnHandler.__injector__) {
  121.       if (injector.deref) injector = injector.deref(); // null if ${fnTag} of all CEs are restored.
  122.     }
  123.     if (typeof fnHandler.__ytHandlerFuncName__ === 'string' && fnHandler.__ytHandlerFuncName__ !== fnTag) {
  124.       return console.warn(`[ytI] Injection Function Tag Mismatched: ${fnHandler.__ytHandlerFuncName__} & ${fnTag}`);
  125.     }
  126.     if (!injector) {
  127.       fnHandler.__ytHandlerFuncName__ = fnTag;
  128.       injector = injectorCreationForRegistered(fnHandler);
  129.       // injector.__ytHandlerFuncName__ = fnTag;
  130.       fnHandler.__injector__ = injector.__injector__;
  131.     } else if (typeof injector.__ytHandlerFuncName__ === 'string' && injector.__ytHandlerFuncName__ !== fnTag) {
  132.       return console.warn(`[ytI] Injected Function Tag Mismatched: ${injector.__ytHandlerFuncName__} & ${fnTag}`);
  133.     }
  134.     if (typeof (injector || 0).getMap !== 'function') return console.warn('[ytI] the injector function is invalid.');
  135.     const mapOfFuncs = injector.getMap();
  136.     const ceConstructor = ceProto.constructor || null;
  137.     if (!ceConstructor) return console.warn('[ytI] no constructor is found in proto');
  138.     let funcs;
  139.     if (!mapOfFuncs.has(ceConstructor)) {
  140.       mapOfFuncs.set(ceConstructor, funcs = []);
  141.       ceProto[fnTag] = injector;
  142.     } else {
  143.       funcs = mapOfFuncs.get(ceConstructor);
  144.     }
  145.     if (!funcs) return console.warn(`[ytI] ${fnTag} has already called. You can just override the properties.`);
  146.     funcs.push(actionFn);
  147.   }
  148.  
  149.   const postRegistered = (ytElmTag, f) => {
  150.     const ceElmConstrcutor = customElements.get(ytElmTag);
  151.     const proto = ((ceElmConstrcutor || 0).prototype || 0);
  152.     if (proto && ('forwardMethods' in proto) && !('_registered' in proto)) {
  153.       // under controller extraction, the register mechanism is different
  154.       // register is not done in first initialization
  155.       const createdElement = document.querySelector(ytElmTag);
  156.       const inst = (createdElement || 0).inst;
  157.       if (inst) {
  158.         f(inst.constructor.prototype);
  159.       } else {
  160.         injectionPool(proto, 'forwardMethods', f);
  161.       }
  162.     } else if (proto && ('__hasRegisterFinished' in proto)) {
  163.       f(proto);
  164.     } else if (proto && ('_registered' in proto) && !('forwardMethods' in proto)) {
  165.       injectionPool(proto, '_registered', f);
  166.     } else {
  167.       console.warn('[ytI] postRegistered is not supported.');
  168.     }
  169.   }
  170.  
  171.   const EVENT_KEY_ON_REGISTRY_READY = "ytI-ce-registry-created";
  172.  
  173.   const customYtElements = {
  174.     whenRegistered(ytElmTag, immediateCallback) {
  175.       return new Promise(resolve => {
  176.         if (typeof customElements !== 'object' || typeof customElements.whenDefined !== 'function' || typeof customElements.get !== 'function') console.error('[ytI] customElements (native or polyfill) is not available.');
  177.         const ceReady = () => { // ignore async result; the result in whenDefined is not the same as customElements.get
  178.           postRegistered(ytElmTag, (proto) => {
  179.             if (immediateCallback) immediateCallback(proto);
  180.             resolve(proto);
  181.           });
  182.         }
  183.         customElements.get(ytElmTag) ? ceReady() : customElements.whenDefined(ytElmTag).then(ceReady);
  184.       });
  185.     },
  186.     onRegistryReady(callback) {
  187.       if (typeof customElements === 'undefined') {
  188.         if (!('__CE_registry' in document)) {
  189.           // https://github.com/webcomponents/polyfills/
  190.           Object.defineProperty(document, '__CE_registry', {
  191.             get() {
  192.               // return undefined
  193.             },
  194.             set(nv) {
  195.               if (typeof nv == 'object') {
  196.                 delete this.__CE_registry;
  197.                 this.__CE_registry = nv;
  198.                 this.dispatchEvent(new CustomEvent(EVENT_KEY_ON_REGISTRY_READY));
  199.               }
  200.               return true;
  201.             },
  202.             enumerable: false,
  203.             configurable: true
  204.           })
  205.         }
  206.         let eventHandler = (evt) => {
  207.           document.removeEventListener(EVENT_KEY_ON_REGISTRY_READY, eventHandler, false);
  208.           const f = callback;
  209.           callback = null;
  210.           eventHandler = null;
  211.           f();
  212.         };
  213.         document.addEventListener(EVENT_KEY_ON_REGISTRY_READY, eventHandler, false);
  214.       } else {
  215.         callback();
  216.       }
  217.     }
  218.   }
  219.  
  220.   // Export to external environment
  221.   // try { window.customYtElements = customYtElements; } catch (error) { /* for Greasemonkey */ }
  222.   // try { module.customYtElements = customYtElements; } catch (error) { /* for CommonJS */ }
  223.  
  224.   return customYtElements;
  225.  
  226. })();