PreMiD Presence Metadata Test Suite reference page

metadata-test-suite-reference.md

Reference (v0.1.0)

Required Values

• Author present
  Checks if author present.
• Author valid
  Checks if author' values are valid.
  • Author name present
    Checks if name present on the author object.
  • Author name valid
    Checks if name's value (on the author object) is a string.
  • Author ID present
    Checks if id present on the author object.
  • Author ID valid
    Checks if name's value (on the author object) is a string containing only numbers.
• Service present
  Checks if service present.
• Service valid
  Checks if author's value is a string.
• Description present
  Checks if description present.
• Description valid
  Checks if description' values are valid.
  • Language [language code] valid
    Checks if the language code is present on the accepted language list. (https://api.premid.app/v2/langFile/list)
• URL present
  Checks if url present.
• URL valid
  Checks if the array on url are valid.
  • URL [url] valid
    Checks if one of the strings on the array on url is a URL without the protocol. (http://, https://)
• Version present
  Checks if version present.
• Version valid
  Checks if version's value is a string containing the version of the presence that complies with the Semantic Versioning 2.0.0 specification with only three numbers.
• Logo present
  Checks if logo present.
• Logo valid
  Checks if logo's value is a string containing an URL.
• Thumbnail present
  Checks if thumbnail present.
• Thumbnail valid
  Checks if thumbnail's value is a string containing an URL.
• Color present
  Checks if color present.
• Color valid
  Checks if thumbnail's value is a string containig a color hash.
• Tags present
  Checks if tags present.
• Tags present
  Checks if tags's is an array.
• Category present
  Checks if category present.
• Category valid
  Checks if tags's is a string containing either anime, games, music, socials, videos, or other.

Optional Values

• Contributors present
  Checks if contributors present.
• Contributors valid
  Checks if contributors' values are valid.
  • Contributor name present
    Checks if name present on one of the arrays of the contributors object.
  • Contributor name valid
    Checks if name's value (on one of the arrays of the contributors object) is a string.
  • Contributor ID present
    Checks if id present on one of the arrays of the contributors object.
  • Contributor ID valid
    Checks if id's value (on one of the arrays of the contributors object) is a string containing only numbers.
• regExp present
  Checks if regExp present.
• regExp valid
  Checks if regExp value is a string.
• iFrameRegExp present
  Checks if iFrameRegExp present.
• iFrameRegExp valid
  Checks if iFrameRegExp's value is a string.
• iframe present
  Checks if iframe present.
• iframe valid
  Checks if iframe's value is a string.
• Settings present
  Checks if settings present.
• Settings valid
  Checks if settings' values are valid.
  • Setting ID present
    Checks if id present on one of the arrays of the settings object.
  • Setting ID valid
    Checks if id's value (on one of the arrays of the settings object) is a string.
  • Setting title present
    Checks if title present on one of the arrays of the settings object.
  • Setting title valid
    Checks if title's value (on one of the arrays of the settings object) is a string.
  • Setting icon present
    Checks if icon present on one of the arrays of the settings object.
  • Setting icon valid
    Checks if icon (present on one of the arrays of the settings object) is a class value from free Font Awesome icons. (starts with fas fa- or fab fa-)
  • Setting value present
    Checks if value present on one of the arrays of the settings object.
  • Setting value valid
    Checks if value's value (on one of the arrays of the settings object) is either a string or a boolean.
  • Setting if present
    Checks if if present on one of the arrays of the settings object.
  • Setting if valid
    Checks if if's value (on one of the arrays of the settings object) is an object.
  • Setting placeholder present
    Checks if placeholder present on one of the arrays of the settings object.
  • Setting placeholder valid
    Checks if placeholder's value (on one of the arrays of the settings object) is a string.
  • Setting values present
    Checks if values present on one of the arrays of the settings object.
  • Setting values valid
    Checks if title's value (on one of the arrays of the settings object) is an array.