@unavatar/core 3.19.1 → 3.19.3

package/README.md

@@ -19,10 +19,12 @@
   - [Discord](#discord)
   - [Dribbble](#dribbble)
   - [DuckDuckGo](#duckduckgo)
+  - [Facebook](#facebook)
   - [GitHub](#github)
   - [GitLab](#gitlab)
   - [LinkedIn](#linkedin)
   - [Google](#google)
+  - [Gravatar](#gravatar)
   - [Instagram](#instagram)
   - [Ko-fi](#ko-fi)
   - [Medium](#medium)
@@ -33,6 +35,7 @@
   - [Patreon](#patreon)
   - [Pinterest](#pinterest)
   - [Printables](#printables)
+  - [PSN Profiles](#psn-profiles)
   - [Reddit](#reddit)
   - [Snapchat](#snapchat)
   - [SoundCloud](#soundcloud)
@@ -42,12 +45,16 @@
   - [Telegram](#telegram)
   - [Threads](#threads)
   - [TikTok](#tiktok)
+  - [Tumblr](#tumblr)
   - [Twitch](#twitch)
   - [Vimeo](#vimeo)
   - [WhatsApp](#whatsapp)
+  - [X/Twitter](#xtwitter)
+  - [Xbox Gamertag](#xbox-gamertag)
   - [YouTube](#youtube)
 - [Response Format](#response-format)
 - [Response Headers](#response-headers)
+- [Response Errors](#response-errors)
 
 ---
 
@@ -55,14 +62,6 @@
 
 Welcome to **unavatar.io**, the ultimate avatar service that offers everything you need to easily retrieve user avatars:
 
-- **Versatile**: A wide range of platforms and services including [TikTok](https://unavatar.io/docs#tiktok), [Instagram](https://unavatar.io/docs#instagram), [YouTube](https://unavatar.io/docs#youtube), [X/Twitter](https://unavatar.io/docs#xtwitter), [Gravatar](https://unavatar.io/docs#gravatar), etc., meaning you can rule all of them just querying against unavatar.
-
-- **Speed**: Designed to be fast and efficient with a 93% cache hit rate, serving 21.7 TB of data across 728M requests.
-
-- **Optimize**: All the images are not only compressed on-the-fly to reduce their size and save bandwith, but also optimized to maintain a high-quality ratio. They are ready for immediate use, enhancing the overall optimization of your website or application.
-
-- **Integration**: The service seamlessly incorporates into your current applications or websites with ease. We offer straightforward documentation and comprehensive support to ensure a quick and effortless onboarding experience.
-
 It's proudly powered by [microlink.io](https://microlink.io/), the headless browser API that handles all the heavy lifting behind the scenes to ensure your avatars are always ready.
 
 ## Quick start
@@ -350,6 +349,16 @@ Available inputs:
 
 - Domain, e.g., [unavatar.io/duckduckgo/microsoft.com](https://unavatar.io/duckduckgo/microsoft.com)
 
+### Facebook
+
+Get any Facebook user, page, or group profile picture by their username or ID.
+
+Available inputs:
+
+- Username, e.g., [unavatar.io/facebook/zuck](https://unavatar.io/facebook/zuck)
+- Page, e.g., [unavatar.io/facebook/windtodayco](https://unavatar.io/facebook/windtodayco)
+- Group ID, e.g., [unavatar.io/facebook/1426378481098002](https://unavatar.io/facebook/1426378481098002)
+
 ### GitHub
 
 Get any GitHub user or organization's profile picture by their username.
@@ -391,6 +400,8 @@ Available inputs:
 
 - Domain, e.g., [unavatar.io/google/stremio.com](https://unavatar.io/google/stremio.com)
 
+### Gravatar
+
 Get any user's avatar by their email address via Gravatar. The most widely used global avatar service — if your users have a Gravatar set up, this is the fastest way to retrieve it.
 
 Available inputs:
@@ -478,6 +489,14 @@ Available inputs:
 
 - Username, e.g., [unavatar.io/printables/DukeDoks](https://unavatar.io/printables/DukeDoks)
 
+### PSN Profiles
+
+Get any PlayStation Network user's profile picture by their PSN username.
+
+Available inputs:
+
+- Username, e.g., [unavatar.io/psnprofiles/P3](https://unavatar.io/psnprofiles/P3)
+
 ### Reddit
 
 Get any Reddit user's avatar by their username.
@@ -571,6 +590,14 @@ Available inputs:
 
 - Username, e.g., [unavatar.io/tiktok/carlosazaustre](https://unavatar.io/tiktok/carlosazaustre)
 
+### Tumblr
+
+Get any Tumblr blog's profile picture by their username.
+
+Available inputs:
+
+- Username, e.g., [unavatar.io/tumblr/nasa](https://unavatar.io/tumblr/nasa)
+
 ### Twitch
 
 Get any Twitch streamer's profile picture by their username.
@@ -603,12 +630,22 @@ Available URI format inputs:
 - `channel`: [unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m](https://unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m)
 - `chat`: [unavatar.io/whatsapp/chat:D2FFycjQXrEIKG8qQjbwZz](https://unavatar.io/whatsapp/chat:D2FFycjQXrEIKG8qQjbwZz)
 
+### X/Twitter
+
 Get any X (formerly Twitter) user's profile picture by their username.
 
 Available inputs:
 
 - Username, e.g., [unavatar.io/x/elonmusk](https://unavatar.io/x/elonmusk)
 
+### Xbox Gamertag
+
+Get any Xbox player's profile picture by their gamertag.
+
+Available inputs:
+
+- Gamertag, e.g., [unavatar.io/xboxgamertag/P3](https://unavatar.io/xboxgamertag/P3)
+
 ### YouTube
 
 Get any YouTube channel's thumbnail by their handle, legacy username, or channel ID.
@@ -668,6 +705,8 @@ x-rate-limit-remaining: 49
 x-rate-limit-reset: 1744243200
 ```
 
+## Response Errors
+
 Expected errors are known operational cases returned with stable codes.
 
 - **Client-side issues** return `status: "fail"` (HTTP `4xx`).

package/package.json

@@ -2,7 +2,7 @@
   "name": "@unavatar/core",
   "description": "Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube & more.",
   "homepage": "https://unavatar.io",
-  "version": "3.19.1",
+  "version": "3.19.3",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js",

package/src/index.js

@@ -29,16 +29,18 @@ module.exports = ({ constants: userConstants, redis, onFetchHTML } = {}) => {
   })
   const createBrowser = require('./util/browserless')(constants)
   const getHTML = require('./util/html-get')({ createBrowser, got })
-  const { createHtmlProvider, getOgImage } = require('./util/html-provider')({
-    ...constants,
-    getHTML,
-    onFetchHTML
-  })
+  const { createHtmlProvider, getOgImage, NOT_FOUND } =
+    require('./util/html-provider')({
+      ...constants,
+      getHTML,
+      onFetchHTML
+    })
 
   const providerCtx = {
     constants,
     createHtmlProvider,
     getOgImage,
+    NOT_FOUND,
     got,
     isReservedIp,
     itunesSearchCache: cache.itunesSearchCache

package/src/providers/psnprofiles.js

@@ -1,8 +1,15 @@
 'use strict'
 
-module.exports = ({ createHtmlProvider, getOgImage }) =>
+const getAvatarUrl = ({ $, getOgImage, NOT_FOUND }) => {
+  const ogImage = getOgImage($)
+  return ogImage === undefined ? NOT_FOUND : ogImage
+}
+
+module.exports = ({ createHtmlProvider, getOgImage, NOT_FOUND }) =>
   createHtmlProvider({
     name: 'psnprofiles',
     url: input => `https://psnprofiles.com/${input}`,
-    getter: getOgImage
+    getter: $ => getAvatarUrl({ $, getOgImage, NOT_FOUND })
   })
+
+module.exports.getAvatarUrl = getAvatarUrl

package/src/util/html-provider.js

@@ -28,22 +28,26 @@ const createProviderError = ({ provider, statusCode, cause, code }) =>
     message: 'Empty value returned by the provider.'
   })
 
+const createErrorCause = ({ html, headers, statusCode }) => ({
+  html,
+  headers,
+  statusCode
+})
+
 module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
   /**
    * @param {object} opts
    * @param {string} opts.name - Provider identifier used in logs and metrics.
    * @param {(input: string) => string | Promise<string>} opts.url - Builds the URL to fetch for a given input.
-   * @param {($: cheerio.CheerioAPI) => string | undefined} opts.getter
+   * @param {($: cheerio.CheerioAPI) => string | symbol | undefined} opts.getter
    *   Extracts the avatar URL from the fetched HTML.
-   *   - `string`    — avatar URL found (success).
+   *   - `string`     — avatar URL found (success).
+   *   - `NOT_FOUND`  — provider-level miss.
    *   - `undefined`  — avatar not found (normal failure, no retry).
-   * @param {(context: { $: cheerio.CheerioAPI, statusCode: number }) => boolean} [opts.isBlocked]
-   *   Optional provider-specific blocked-page detector, checked after the
-   *   default `is-antibot` check when getter returns empty/undefined.
    * @param {() => object} [opts.htmlOpts] - Returns extra options merged into the fetch call.
    */
-  const createHtmlProvider = ({ name, url, getter, isBlocked, htmlOpts }) => {
-    const provider = async function (input, context) {
+  const createHtmlProvider = ({ name, url, getter, htmlOpts }) => {
+    async function provider (input, context) {
       const providerUrl = await url(input)
 
       const attempt = async gotOpts => {
@@ -56,7 +60,8 @@ module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
           },
           timeout: PROXY_TIMEOUT
         }
-        const fetchOpts = gotOpts ? { ...defaultOpts, ...gotOpts } : defaultOpts
+        const fetchOpts = { ...defaultOpts, ...gotOpts }
+        const userAgent = fetchOpts.headers['user-agent']
         const tier = fetchOpts.tier ?? 'origin'
 
         const log = debug.duration({ provider: name, input, providerUrl, tier })
@@ -73,6 +78,11 @@ module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
             : undefined
         attempt.lastHeaders = responseHeaders
         attempt.lastStatusCode = statusCode
+        const errorCause = createErrorCause({
+          html: attempt.lastHtml,
+          headers: responseHeaders,
+          statusCode
+        })
 
         if (isStatusCodeMissing(statusCode)) {
           const code = EMPTY_PROVIDER_VALUE_CODE.MISSING_STATUS_CODE
@@ -80,67 +90,87 @@ module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
           throw createProviderError({
             provider: name,
             statusCode,
-            cause: {
-              html: attempt.lastHtml,
-              headers: responseHeaders,
-              statusCode
-            },
+            cause: errorCause,
             code
           })
         }
 
+        const result = getter($)
         if (statusCode === httpStatus.NOT_FOUND) {
           log.error({ statusCode, status: 'not_found' })
           return NOT_FOUND
         }
 
-        const result = getter($)
-        if (typeof result !== 'string' || result === '') {
-          const error = createProviderError({
+        function createEmptyGetterResultError () {
+          return createProviderError({
             provider: name,
             statusCode,
             code: EMPTY_PROVIDER_VALUE_CODE.EMPTY_GETTER_RESULT,
-            cause: {
-              html: attempt.lastHtml,
-              headers: responseHeaders,
-              statusCode
-            }
+            cause: errorCause
           })
+        }
 
+        function getBlockedStatus () {
           const isRateLimited = statusCode === httpStatus.TOO_MANY_REQUESTS
-          const providerBlocked = isBlocked?.({ $, statusCode })
+          if (isRateLimited) return { isBlocked: true, antibotProvider: null }
 
           const { detected: antibotDetected, provider: antibotProvider } =
-            isRateLimited || providerBlocked
-              ? { detected: false, provider: null }
-              : isAntibot({
-                url: providerUrl,
-                statusCode,
-                headers: responseHeaders,
-                body: attempt.lastHtml
-              })
-
-          if (isRateLimited || providerBlocked || antibotDetected) {
-            error.blocked = true
+            isAntibot({
+              url: providerUrl,
+              statusCode,
+              headers: responseHeaders,
+              body: attempt.lastHtml
+            })
+
+          return {
+            isBlocked: antibotDetected,
+            antibotProvider
           }
+        }
+
+        if (typeof result === 'string' && result !== '') {
+          const normalizedResult = normalizeUrl(providerUrl, result)
+          log({
+            statusCode,
+            status: 'success',
+            result: normalizedResult
+          })
+          return normalizedResult
+        }
+
+        // Some providers encode not-found via getter output. Check antibot
+        // first so challenge pages are retried as blocked, not treated as 404.
+        const { isBlocked: shouldMarkBlocked, antibotProvider } =
+          getBlockedStatus()
+
+        if (shouldMarkBlocked) {
+          const error = createEmptyGetterResultError()
+          error.blocked = true
 
           log.error({
             statusCode,
-            status: error.blocked ? 'blocked' : undefined,
+            status: 'blocked',
             antibot: antibotProvider ?? undefined,
-            userAgent: fetchOpts.headers['user-agent']
+            userAgent
           })
 
           throw error
         }
 
-        const normalizedResult = normalizeUrl(providerUrl, result)
-        log({
+        if (result === NOT_FOUND) {
+          log.error({ statusCode, status: 'not_found' })
+          return NOT_FOUND
+        }
+
+        const error = createEmptyGetterResultError()
+
+        log.error({
           statusCode,
-          status: 'success',
-          result: normalizedResult
+          antibot: antibotProvider ?? undefined,
+          userAgent
         })
-        return normalizedResult
+
+        throw error
       }
 
       if (typeof onFetchHTML === 'function') {
@@ -148,8 +178,7 @@ module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
       }
 
       const result = await attempt()
-      if (result === NOT_FOUND) return
-      return result
+      return result === NOT_FOUND ? undefined : result
     }
 
     provider.getUrl = url