Brazen Item Attributes Resolver

Item attributes resolution helper class

Per 10-11-2022. Zie de nieuwste versie.

Dit script moet niet direct worden geïnstalleerd - het is een bibliotheek voor andere scripts om op te nemen met de meta-richtlijn // @require https://update.greasyfork.org/scripts/429587/1115639/Brazen%20Item%20Attributes%20Resolver.js

Voor het installeren van scripts heb je een extensie nodig, zoals Tampermonkey, Greasemonkey of Violentmonkey.

Voor het installeren van scripts heb je een extensie nodig, zoals Tampermonkey of Violentmonkey.

Voor het installeren van scripts heb je een extensie nodig, zoals Tampermonkey of Violentmonkey.

Voor het installeren van scripts heb je een extensie nodig, zoals Tampermonkey of Userscripts.

Voor het installeren van scripts heb je een extensie nodig, zoals {tampermonkey_link:Tampermonkey}.

Voor het installeren van scripts heb je een gebruikersscriptbeheerder nodig.

(Ik heb al een user script manager, laat me het downloaden!)

Voor het installeren van gebruikersstijlen heb je een extensie nodig, zoals {stylus_link:Stylus}.

Voor het installeren van gebruikersstijlen heb je een extensie nodig, zoals {stylus_link:Stylus}.

Voor het installeren van gebruikersstijlen heb je een extensie nodig, zoals {stylus_link:Stylus}.

Voor het installeren van gebruikersstijlen heb je een gebruikersstijlbeheerder nodig.

Voor het installeren van gebruikersstijlen heb je een gebruikersstijlbeheerder nodig.

Voor het installeren van gebruikersstijlen heb je een gebruikersstijlbeheerder nodig.

(Ik heb al een beheerder - laat me doorgaan met de installatie!)

// ==UserScript==
// @name         Brazen Item Attributes Resolver
// @namespace    brazenvoid
// @version      2.1.0
// @author       brazenvoid
// @license      GPL-3.0-only
// @description  Item attributes resolution helper class
// ==/UserScript==

class BrazenItemAttributesResolver
{
    /**
     * @typedef {{itemLinkSelector: JQuery.Selector, itemDeepAnalysisSelector: JQuery.Selector, requestDelay: number,
     *            onDeepAttributesResolution: Function}} ItemAttributesResolverConfiguration
     */
    
    /**
     * @callback ItemAttributesResolverCallback
     * @param {JQuery} item
     * @return {*}
     */
    
    /**
     * @param {ItemAttributesResolverConfiguration} configuration
     */
    constructor(configuration)
    {
        /**
         * @type {{}}
         * @private
         */
        this._attributes = {}
        
        /**
         * @type {{}}
         * @private
         */
        this._deepAttributes = {}
        
        /**
         * @type {boolean}
         * @private
         */
        this._hasDeepAttributes = false
        
        /**
         * @type {JQuery.Selector}
         * @protected
         */
        this._itemLinkSelector = configuration.itemLinkSelector
        
        /**
         * @type {JQuery.Selector}
         * @protected
         */
        this._itemDeepAnalysisSelector = configuration.itemDeepAnalysisSelector
    
        /**
         * @type {Function}
         * @private
         */
        this._onDeepAttributesResolution = configuration.onDeepAttributesResolution
        
        /**
         * @type {number}
         * @private
         */
        this._requestDelay = configuration.requestDelay
        
        /**
         * @type {number}
         * @private
         */
        this._requestIteration = 1
        
        /**
         * @type {JQuery<HTMLElement> | jQuery | HTMLElement}
         * @private
         */
        this._sandbox = $('<div id="brazen-item-attributes-resolver-sandbox" hidden/>').appendTo('body')
    }
    
    /**
     * @param {string} attribute
     * @returns {string}
     * @private
     */
    _formatAttributeName(attribute)
    {
        return attribute.toLowerCase().replaceAll(' ', '_')
    }
    
    /**
     * @param {string} attribute
     * @param {ItemAttributesResolverCallback} resolutionCallback
     * @returns {this}
     */
    addAttribute(attribute, resolutionCallback)
    {
        this._attributes[this._formatAttributeName(attribute)] = resolutionCallback
        return this
    }
    
    /**
     * @param {string} attribute
     * @param {ItemAttributesResolverCallback} resolutionCallback
     * @returns {this}
     */
    addDeepAttribute(attribute, resolutionCallback)
    {
        this._deepAttributes[this._formatAttributeName(attribute)] = resolutionCallback
        this._hasDeepAttributes = true
        return this
    }
    
    /**
     * @returns {BrazenItemAttributesResolver}
     */
    completeResolutionRun()
    {
        this._requestIteration = 1;
        return this
    }
    
    /**
     * @param {JQuery} item
     * @param {string} attribute
     * @returns {*}
     */
    get(item, attribute)
    {
        let attributesBag = item[0].scriptAttributes
        if (typeof attributesBag !== 'undefined') {
            let attributeValue = attributesBag[this._formatAttributeName(attribute)]
            if (typeof attributeValue !== 'undefined') {
                return attributeValue
            }
        }
        return null
    }
    
    /**
     * @param {JQuery} item
     * @param {Function|null} afterResolutionCallback
     */
    resolveAttributes(item, afterResolutionCallback = null)
    {
        let attributesBag = {}
        item[0].scriptAttributes = attributesBag
        
        for (const attributeName in this._attributes) {
            attributesBag[attributeName] = this._attributes[attributeName](item)
        }
        if (this._hasDeepAttributes) {
            let url = item.find(this._itemLinkSelector).attr('href')
            if (url) {
                Utilities.sleep(this._requestIteration * this._requestDelay).then(() => {
                    try {
                        this._sandbox.load(url + ' ' + this._itemDeepAnalysisSelector, () => {
                            for (const attributeName in this._deepAttributes) {
                                attributesBag[attributeName] = this._deepAttributes[attributeName](this._sandbox)
                            }
                            this._onDeepAttributesResolution(item)
                            this._sandbox.empty()
                        })
                    } catch (error) {
                        console.error('Deep attributes loading failed.')
                    }
                })
                this._requestIteration++
            }
        }
    }
    
    /**
     * @param {JQuery} item
     * @param {string} attribute
     * @param {*} value
     * @returns {BrazenItemAttributesResolver}
     */
    set(item, attribute, value)
    {
        item[0].scriptAttributes[this._formatAttributeName(attribute)] = value
        return this
    }
}