@unavatar/core 3.12.0 → 3.13.0

package/README.md

@@ -12,6 +12,7 @@
   - [Apple Music](#apple-music)
   - [Bluesky](#bluesky)
   - [DeviantArt](#deviantart)
+  - [Discord](#discord)
   - [Dribbble](#dribbble)
   - [DuckDuckGo](#duckduckgo)
   - [GitHub](#github)
@@ -57,6 +58,7 @@
   - [Apple Music](#apple-music)
   - [Bluesky](#bluesky)
   - [DeviantArt](#deviantart)
+  - [Discord](#discord)
   - [Dribbble](#dribbble)
   - [DuckDuckGo](#duckduckgo)
   - [GitHub](#github)
@@ -238,6 +240,14 @@ Available inputs:
 
 - slug, e.g., [unavatar.io/deviantart/spyed](https://unavatar.io/deviantart/spyed)
 
+### Discord
+
+Get any Discord server icon by invite code.
+
+Available inputs:
+
+- Invite code, e.g., [unavatar.io/discord/eret](https://unavatar.io/discord/eret)
+
 ### Dribbble
 
 Get any Dribbble designer's profile picture by their username.

package/bin/index.js

@@ -28,7 +28,9 @@ module.exports = ({ baseUrl }) => {
   const customHeaders = parseHeaders(flags.header)
 
   if (!input) {
-    console.error('Usage: unavatar <input> | unavatar <provider>/<key> | unavatar ping')
+    console.error(
+      'Usage: unavatar <input> | unavatar <provider>/<key> | unavatar ping'
+    )
     console.error(
       'Examples: unavatar reddit.com | unavatar hello@microlink.io | unavatar x/kikobeats | unavatar ping'
     )
@@ -39,7 +41,9 @@ module.exports = ({ baseUrl }) => {
   const normalizeInput = value => {
     try {
       const url = new URL(value)
-      if (url.protocol === 'http:' || url.protocol === 'https:') return url.hostname
+      if (url.protocol === 'http:' || url.protocol === 'https:') {
+        return url.hostname
+      }
     } catch (_) {}
     return value
   }
@@ -57,7 +61,9 @@ module.exports = ({ baseUrl }) => {
           const key = keyParts.join('/')
 
           if (!provider || !key) {
-            console.error('Invalid input format. Expected: <input>, <provider>/<key>, or "ping"')
+            console.error(
+              'Invalid input format. Expected: <input>, <provider>/<key>, or "ping"'
+            )
             console.error(
               'Examples: unavatar reddit.com | unavatar hello@microlink.io | unavatar x/kikobeats | unavatar ping'
             )
@@ -78,15 +84,22 @@ module.exports = ({ baseUrl }) => {
   let durationInfo = null
   let apiHeaders = null
   let apiStatusCode = null
+  let apiHttpVersion = null
 
   const logMeta = () => {
     if (apiHeaders) {
       const headerEntries = Object.entries(apiHeaders)
       if (headerEntries.length > 0) {
-        const maxHeaderLength = Math.max(...headerEntries.map(([key]) => key.toLowerCase().length))
+        const maxHeaderLength = Math.max(
+          ...headerEntries.map(([key]) => key.toLowerCase().length)
+        )
 
         console.error()
-        console.error(`HTTP/1.1 ${apiStatusCode} ${STATUS_CODES[apiStatusCode]}`)
+        console.error(
+          `HTTP/${apiHttpVersion || '1.1'} ${apiStatusCode} ${
+            STATUS_CODES[apiStatusCode]
+          }`
+        )
         headerEntries
           .sort(([a], [b]) => a.toLowerCase().localeCompare(b.toLowerCase()))
           .forEach(([key, value]) => {
@@ -106,13 +119,16 @@ module.exports = ({ baseUrl }) => {
   if (flags.apiKey) requestHeaders['x-api-key'] = flags.apiKey
 
   got(apiUrl.toString(), { headers: requestHeaders, responseType: 'json' })
-    .then(({ body, headers, statusCode, timings }) => {
+    .then(({ body, headers, statusCode, timings, httpVersion }) => {
       apiHeaders = headers
       apiStatusCode = statusCode
+      apiHttpVersion = httpVersion
 
       const duration = Date.now() - startTime
       const timeToFirstByte =
-        timings?.response && timings?.start ? Math.round(timings.response - timings.start) : null
+        timings?.response && timings?.start
+          ? Math.round(timings.response - timings.start)
+          : null
 
       durationInfo = timeToFirstByte
         ? `Duration: ${duration}ms (TTFB: ${timeToFirstByte}ms)`
@@ -123,7 +139,7 @@ module.exports = ({ baseUrl }) => {
         console.error(`${apiUrl.toString()}\n`)
         console.error(body)
         logMeta()
-        return null
+        return
       }
 
       if (!body || !body.url) {
@@ -152,6 +168,7 @@ output: ${imageUrl}
       if (response) {
         apiHeaders = response.headers
         apiStatusCode = response.statusCode
+        apiHttpVersion = response.httpVersion
       }
 
       if (!durationInfo) {
@@ -166,7 +183,9 @@ output: ${imageUrl}
         if (typeof body === 'object') {
           console.error(JSON.stringify(body, null, 2))
         } else {
-          const rawBody = Buffer.isBuffer(body) ? body.toString('utf8') : String(body)
+          const rawBody = Buffer.isBuffer(body)
+            ? body.toString('utf8')
+            : String(body)
           try {
             console.error(JSON.stringify(JSON.parse(rawBody), null, 2))
           } catch (_) {

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.12.0",
+  "version": "3.13.0",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js",

package/src/providers/apple-music.js

@@ -39,7 +39,7 @@ module.exports = ({ createHtmlProvider, itunesSearchCache, got }) => {
   const searchEntityId = memoize(
     async ({ query, type }) => {
       const entityConfig = APPLE_MUSIC_ENTITY_TYPES[type]
-      if (!entityConfig) return null
+      if (!entityConfig) return
       const { entity, idKey } = entityConfig
 
       const url = `https://itunes.apple.com/search?term=${encodeURIComponent(
@@ -63,7 +63,7 @@ module.exports = ({ createHtmlProvider, itunesSearchCache, got }) => {
     if (!hasExplicitType) {
       for (const searchType of APPLE_MUSIC_SEARCH_TYPES) {
         const entityId = await searchEntityId({ query: id, type: searchType })
-        if (entityId) return `${APPLE_MUSIC_STOREFRONT}/${searchType}/${entityId}`
+        if (entityId) { return `${APPLE_MUSIC_STOREFRONT}/${searchType}/${entityId}` }
       }
 
       return `${APPLE_MUSIC_STOREFRONT}/search?term=${encodeURIComponent(id)}`
@@ -76,7 +76,9 @@ module.exports = ({ createHtmlProvider, itunesSearchCache, got }) => {
     if (isNumericId(id)) return `${APPLE_MUSIC_STOREFRONT}/${type}/${id}`
 
     const entityId = await searchEntityId({ query: id, type })
-    return `${APPLE_MUSIC_STOREFRONT}/${type}/${entityId || encodeURIComponent(id)}`
+    return `${APPLE_MUSIC_STOREFRONT}/${type}/${
+      entityId || encodeURIComponent(id)
+    }`
   }
 
   return createHtmlProvider({

package/src/providers/discord.js

@@ -0,0 +1,96 @@
+'use strict'
+
+const DISCORD_INVITE_HOST_RE =
+  /^(?:www\.)?(?:discord\.gg|discord(?:app)?\.com)$/i
+
+const DISCORD_GUILD_ID_RE =
+  /^https:\/\/cdn\.discordapp\.com\/splashes\/(\d+)\/[^/?#]+\.[^/?#]+(?:\?[^#]+)?(?:#.*)?$/
+
+const DISCORD_INVITE_URL_BASE = 'https://discord.com/invite/'
+
+const getInviteCode = input => {
+  if (typeof input !== 'string') return
+
+  const value = input.trim()
+  if (value === '') return
+
+  const hasProtocol = value.includes('://')
+  const hasPath = value.includes('/')
+
+  if (!hasProtocol && !hasPath) return value
+
+  const normalizedInput = hasProtocol ? value : `https://${value}`
+
+  let url
+  try {
+    url = new URL(normalizedInput)
+  } catch {
+    return
+  }
+
+  if (!DISCORD_INVITE_HOST_RE.test(url.hostname)) return
+
+  const [firstSegment, secondSegment] = url.pathname.split('/').filter(Boolean)
+  if (!firstSegment) return
+
+  if (url.hostname.includes('discord.gg')) return firstSegment
+
+  if (firstSegment === 'invite' || firstSegment === 'invites') {
+    return secondSegment
+  }
+}
+
+const buildInviteUrl = inviteCode => `${DISCORD_INVITE_URL_BASE}${inviteCode}`
+
+const getInviteUrl = input => {
+  const inviteCode = getInviteCode(input)
+  return inviteCode ? buildInviteUrl(inviteCode) : undefined
+}
+
+const getInviteApiUrl = inviteCode =>
+  `https://discord.com/api/v9/invites/${encodeURIComponent(
+    inviteCode
+  )}?with_counts=true&with_expiration=true`
+
+const getGuildIdFromOgImage = ogImage =>
+  ogImage?.match(DISCORD_GUILD_ID_RE)?.[1]
+
+const getAvatarUrl = ({ guildId, ogImage, iconHash }) => {
+  const resolvedGuildId = guildId || getGuildIdFromOgImage(ogImage)
+  if (!resolvedGuildId || !iconHash) return
+  return `https://cdn.discordapp.com/icons/${resolvedGuildId}/${iconHash}.webp`
+}
+
+module.exports = ({ createHtmlProvider, getOgImage, got }) => {
+  const fromInvite = createHtmlProvider({
+    name: 'discord',
+    url: buildInviteUrl,
+    getter: getOgImage
+  })
+
+  return async function discord (input, context) {
+    const inviteCode = getInviteCode(input)
+    if (!inviteCode) return
+
+    const ogImage = await fromInvite(inviteCode, context)
+    if (!ogImage) return
+
+    const metadataResponse = await got(getInviteApiUrl(inviteCode), {
+      responseType: 'json',
+      throwHttpErrors: false
+    })
+
+    if (metadataResponse.statusCode >= 400) return
+
+    const guild = metadataResponse.body?.guild
+    const iconHash = guild?.icon
+    const guildId = guild?.id
+
+    return getAvatarUrl({ guildId, ogImage, iconHash })
+  }
+}
+
+module.exports.getAvatarUrl = getAvatarUrl
+module.exports.getGuildIdFromOgImage = getGuildIdFromOgImage
+module.exports.getInviteCode = getInviteCode
+module.exports.getInviteUrl = getInviteUrl

package/src/providers/index.js

@@ -6,6 +6,7 @@ const providersBy = {
     'apple-music',
     'bluesky',
     'deviantart',
+    'discord',
     'dribbble',
     'github',
     'gitlab',
@@ -40,6 +41,7 @@ module.exports = ctx => {
     'apple-music': require('./apple-music')(ctx),
     bluesky: require('./bluesky')(ctx),
     deviantart: require('./deviantart')(ctx),
+    discord: require('./discord')(ctx),
     dribbble: require('./dribbble')(ctx),
     duckduckgo: require('./duckduckgo')(ctx),
     github: require('./github')(ctx),

package/src/providers/mastodon.js

@@ -18,15 +18,15 @@ const isValidServer = server => {
 }
 
 const parseMastodonInput = input => {
-  if (typeof input !== 'string') return null
+  if (typeof input !== 'string') return
 
   const cleaned = input.startsWith('@') ? input.slice(1) : input
   const parts = cleaned.split('@')
-  if (parts.length !== 2) return null
+  if (parts.length !== 2) return
 
   const [username, server] = parts
-  if (!username || !server) return null
-  if (!isValidServer(server)) return null
+  if (!username || !server) return
+  if (!isValidServer(server)) return
 
   return {
     username,
@@ -37,11 +37,11 @@ const parseMastodonInput = input => {
 module.exports = ({ got, isReservedIp }) => {
   const mastodon = async function (input) {
     const parsed = parseMastodonInput(input)
-    if (!parsed) return undefined
+    if (!parsed) return
 
     const { username, server } = parsed
 
-    if (await isReservedIp(server)) return undefined
+    if (await isReservedIp(server)) return
 
     const { body } = await got(
       `https://${server}/api/v1/accounts/lookup?acct=${encodeURIComponent(

package/src/providers/x.js

@@ -12,17 +12,14 @@ const toHighResolution = url => {
   return url
 }
 
-const getProfileImage = $ =>
-  toHighResolution(
-    $jsonld('mainEntity.image.contentUrl')($) ||
-      $('meta[property="og:image"]').attr('content')
-  )
+const getProfileImage = ($, getOgImage) =>
+  toHighResolution($jsonld('mainEntity.image.contentUrl')($) || getOgImage($))
 
-module.exports = ({ createHtmlProvider }) =>
+module.exports = ({ createHtmlProvider, getOgImage }) =>
   createHtmlProvider({
     name: 'x',
     url: input => `https://x.com/${input}`,
-    getter: getProfileImage
+    getter: $ => getProfileImage($, getOgImage)
   })
 
 module.exports.getProfileImage = getProfileImage

package/src/util/get-og-image.js

@@ -0,0 +1,3 @@
+module.exports = $ =>
+  $('meta[property="og:image"]').attr('content') ||
+  $('meta[name="og:image"]').attr('content')

package/src/util/html-provider.js

@@ -5,6 +5,7 @@ const debug = require('debug-logfmt')('html-provider')
 const isAntibot = require('is-antibot')
 
 const randomCrawlerAgent = require('./crawler-agent')
+const getOgImage = require('./get-og-image')
 const httpStatus = require('./http-status')
 const ExtendableError = require('./error')
 
@@ -27,10 +28,6 @@ const createProviderError = ({ provider, statusCode, cause, code }) =>
     message: 'Empty value returned by the provider.'
   })
 
-const getOgImage = $ =>
-  $('meta[property="og:image"]').attr('content') ||
-  $('meta[name="og:image"]').attr('content')
-
 module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
   /**
    * @param {object} opts
@@ -151,7 +148,7 @@ module.exports = ({ PROXY_TIMEOUT, getHTML, onFetchHTML }) => {
       }
 
       const result = await attempt()
-      if (result === NOT_FOUND) return undefined
+      if (result === NOT_FOUND) return
       return result
     }