@unavatar/core 3.23.0 → 3.24.1

package/README.md

@@ -68,13 +68,14 @@ It's proudly powered by [microlink.io](https://microlink.io/), the headless brow
 
 The service is exposed in **unavatar.io** via provider endpoints:
 
-- an **email (auto-detect)**: [unavatar.io/hello@microlink.io](https://unavatar.io/hello@microlink.io) — tries Gravatar, then GitHub
+- an **email**: [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)
+- a **domain**: [unavatar.io/domain/reddit.com](https://unavatar.io/domain/reddit.com)
 - an **email** via Gravatar: [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)
 - an **email** via GitHub: [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)
 - an **username**: [unavatar.io/github/kikobeats](https://unavatar.io/github/kikobeats)
 - a **domain**: [unavatar.io/google/reddit.com](https://unavatar.io/google/reddit.com)
 
-Use `/:provider/:key` for provider-specific lookups, or pass an email as the only path segment for automatic resolution. You can read more in [Email avatars](https://unavatar.io/email) and [providers](https://unavatar.io/docs#providers).
+Use `/email/:key` and `/domain/:key` for type-based resolution. You can read more in [Email avatars](https://unavatar.io/email) and [providers](https://unavatar.io/docs#providers).
 
 ## Authentication
 
@@ -651,7 +652,7 @@ Available inputs:
 
 ### YouTube
 
-Get any YouTube channel's thumbnail by their handle, legacy username, or channel ID.
+Get any YouTube channel's thumbnail by their handle, username, or channel ID.
 
 e.g., [unavatar.io/youtube/casey](https://unavatar.io/youtube/casey)
 
@@ -745,4 +746,4 @@ Expected errors are known operational cases returned with stable codes.
 
 ## Contact
 
-If you have any suggestion or bug to report, please contact to ust mailing to [hello@unavatar.io](mailto:hello@unavatar.io).
+If you have any suggestion or bug to report, please contact to ust mailing to [hello@unavatar.io](mailto:hello@unavatar.io).

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

package/src/index.js

@@ -61,6 +61,11 @@ module.exports = ({ constants: userConstants, redis, onFetchHTML } = {}) => {
     unavatar[name] = input => getAvatar(providers[name], name, input, {})
   })
 
+  const createTypedAutoResolver = inputType => input => auto(inputType)(input, {})
+
+  unavatar.email = createTypedAutoResolver('email')
+  unavatar.domain = createTypedAutoResolver('domain')
+
   unavatar.auto = auto
   unavatar.getInputType = getInputType
   unavatar.getAvatar = getAvatar

package/src/providers/apple-music.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { $jsonld } = require('@metascraper/helpers')
-const memoize = require('@keyvhq/memoize')
+const { createGetSearchResults } = require('../util/itunes-search')
 
 const APPLE_MUSIC_ID_REGEX = /^\d+$/
 const APPLE_MUSIC_STOREFRONT = 'us'
@@ -36,26 +36,19 @@ const parseInput = input => {
 }
 
 module.exports = ({ createHtmlProvider, itunesSearchCache, got }) => {
-  const searchEntityId = memoize(
-    async ({ query, type }) => {
-      const entityConfig = APPLE_MUSIC_ENTITY_TYPES[type]
-      if (!entityConfig) return
-      const { entity, idKey } = entityConfig
-
-      const url = `https://itunes.apple.com/search?term=${encodeURIComponent(
-        query
-      )}&entity=${entity}&limit=1`
-      const body = await got(url, {
-        responseType: 'json',
-        resolveBodyOnly: true
-      })
-
-      const entityId = body?.results?.[0]?.[idKey]
-      return isNumericId(entityId) ? String(entityId) : null
-    },
-    itunesSearchCache,
-    { key: ({ query, type }) => `${type}:${query.trim().toLowerCase()}` }
-  )
+  const getSearchResults = createGetSearchResults({ got, itunesSearchCache })
+
+  const searchEntityId = async ({ query, type }) => {
+    const entityConfig = APPLE_MUSIC_ENTITY_TYPES[type]
+    if (!entityConfig) return
+    const { entity, idKey } = entityConfig
+
+    const [result] = await getSearchResults(
+      `term=${encodeURIComponent(query)}&entity=${entity}&limit=1`
+    )
+    const entityId = result?.[idKey]
+    return isNumericId(entityId) ? String(entityId) : null
+  }
 
   const appleMusicURI = async input => {
     const { hasExplicitType, type, id } = parseInput(input)

package/src/providers/apple-store.js

@@ -0,0 +1,126 @@
+'use strict'
+
+const { createGetSearchResults } = require('../util/itunes-search')
+
+const ITUNES_LOOKUP_URL = 'https://itunes.apple.com/lookup'
+const COUNTRY_CODE_REGEX = /^[a-z]{2}$/i
+
+const getArtworkUrl = result =>
+  result?.artworkUrl512 || result?.artworkUrl100 || result?.artworkUrl60
+
+const withCountry = ({ query, country }) =>
+  country ? `${query}&country=${encodeURIComponent(country)}` : query
+
+const parseInput = input => {
+  const separatorIndex = input.indexOf(':')
+  if (separatorIndex === -1) return { type: 'app', value: input }
+
+  return {
+    type: input.slice(0, separatorIndex),
+    value: input.slice(separatorIndex + 1)
+  }
+}
+
+const parseCountry = value => {
+  const separatorIndex = value.lastIndexOf('@')
+  if (separatorIndex === -1) return { value, country: undefined }
+
+  const country = value.slice(separatorIndex + 1)
+  if (!COUNTRY_CODE_REGEX.test(country)) return { value, country: undefined }
+
+  const nextValue = value.slice(0, separatorIndex)
+  if (!nextValue) return { value, country: undefined }
+
+  return {
+    value: nextValue,
+    country: country.toLowerCase()
+  }
+}
+
+const getLookupResults = async ({ got, query }) => {
+  const body = await got(`${ITUNES_LOOKUP_URL}?${query}`, {
+    responseType: 'json',
+    resolveBodyOnly: true
+  })
+  return body?.results ?? []
+}
+
+const getAppAvatar = async ({ got, id, country }) => {
+  const query = withCountry({
+    query: `id=${encodeURIComponent(id)}&entity=software&limit=1`,
+    country
+  })
+  const [result] = await getLookupResults({ got, query })
+  return getArtworkUrl(result)
+}
+
+const getDeveloperAvatar = async ({ got, id, country }) => {
+  const query = withCountry({
+    query: `id=${encodeURIComponent(id)}&entity=software&limit=200`,
+    country
+  })
+  const results = await getLookupResults({ got, query })
+  const softwareResult = results.find(result => result?.kind === 'software')
+  return getArtworkUrl(softwareResult)
+}
+
+const getBundleAvatar = async ({ got, bundleId, country }) => {
+  const query = withCountry({
+    query: `bundleId=${encodeURIComponent(bundleId)}&entity=software&limit=1`,
+    country
+  })
+  const [result] = await getLookupResults({ got, query })
+  return getArtworkUrl(result)
+}
+
+const getAppNameAvatar = async ({ got, name, country, searchResults }) => {
+  const getSearchResults = searchResults || createGetSearchResults({ got })
+  const query = withCountry({
+    query: `term=${encodeURIComponent(name)}&entity=software&limit=1`,
+    country
+  })
+  const [result] = await getSearchResults(query)
+  return getArtworkUrl(result)
+}
+
+const getDeveloperNameAvatar = async ({ got, name, country, searchResults }) => {
+  const getSearchResults = searchResults || createGetSearchResults({ got })
+  const query = withCountry({
+    query: `term=${encodeURIComponent(
+      name
+    )}&entity=software&attribute=softwareDeveloper&limit=1`,
+    country
+  })
+  const [result] = await getSearchResults(query)
+  return getArtworkUrl(result)
+}
+
+module.exports = ({ got, itunesSearchCache }) => {
+  const searchResults = createGetSearchResults({ got, itunesSearchCache })
+
+  return async function appleStore (input) {
+    const { type, value: rawValue } = parseInput(input)
+    const { value, country } = parseCountry(rawValue)
+
+    switch (type) {
+      case 'app':
+        return getAppAvatar({ got, id: value, country })
+      case 'dev':
+        return getDeveloperAvatar({ got, id: value, country })
+      case 'bundle':
+        return getBundleAvatar({ got, bundleId: value, country })
+      case 'app-name':
+        return getAppNameAvatar({ got, name: value, country, searchResults })
+      case 'dev-name':
+        return getDeveloperNameAvatar({ got, name: value, country, searchResults })
+      default:
+        throw new Error(`Unsupported Apple Store type: ${type}`)
+    }
+  }
+}
+
+module.exports.getAppAvatar = getAppAvatar
+module.exports.getDeveloperAvatar = getDeveloperAvatar
+module.exports.getBundleAvatar = getBundleAvatar
+module.exports.getAppNameAvatar = getAppNameAvatar
+module.exports.getDeveloperNameAvatar = getDeveloperNameAvatar

package/src/providers/flickr.js

@@ -4,24 +4,33 @@ const BUDDY_ICON_URL_PATTERN = /(?:https?:)?\/\/[^"'()\s]*\/buddyicons\/[^"'()\s
 const CSS_URL_PATTERN = /url\((['"]?)([^)'"]+)\1\)/i
 const unescapePathSlashes = value => value?.replace(/\\\//g, '/')
 
+const parseInput = input => {
+  const [first, second] = input.split(':')
+  return {
+    type: second ? first : 'user',
+    id: second ?? first
+  }
+}
+
 const getBuddyIconFromText = value => {
   const normalizedValue = unescapePathSlashes(value)
   if (typeof normalizedValue !== 'string') return
   return normalizedValue.match(BUDDY_ICON_URL_PATTERN)?.[0]
 }
 
+const getUserProfileUrl = userId => `https://www.flickr.com/photos/${userId}/`
+const getGroupProfileUrl = groupId => `https://www.flickr.com/groups/${groupId}/`
+
 const getAvatarUrl = input => {
-  const [first, second] = input.split(':')
-  const type = second ? first : 'user'
-  const id = second ?? first
+  const { type, id } = parseInput(input)
 
   switch (type) {
     case 'user':
     case 'photos':
-      return `https://www.flickr.com/photos/${id}/`
+      return getUserProfileUrl(id)
     case 'group':
     case 'groups':
-      return `https://www.flickr.com/groups/${id}/`
+      return getGroupProfileUrl(id)
     default:
       throw new Error(`Unsupported Flickr type: ${type}`)
   }

package/src/providers/index.js

@@ -4,6 +4,7 @@ const providersBy = {
   email: ['gravatar', 'github'],
   username: [
     'apple-music',
+    'apple-store',
     'behance',
     'bluesky',
     'buymeacoffee',
@@ -49,6 +50,7 @@ const providersBy = {
 module.exports = ctx => {
   const providers = {
     'apple-music': require('./apple-music')(ctx),
+    'apple-store': require('./apple-store')(ctx),
     behance: require('./behance')(ctx),
     bluesky: require('./bluesky')(ctx),
     buymeacoffee: require('./buymeacoffee')(ctx),

package/src/util/itunes-search.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const memoize = require('@keyvhq/memoize')
+
+const ITUNES_SEARCH_URL = 'https://itunes.apple.com/search'
+
+const getSearchResults = async ({ got, query }) => {
+  const body = await got(`${ITUNES_SEARCH_URL}?${query}`, {
+    responseType: 'json',
+    resolveBodyOnly: true
+  })
+  return body?.results ?? []
+}
+
+const createGetSearchResults = ({ got, itunesSearchCache }) => {
+  const searchResults = query => getSearchResults({ got, query })
+  if (!itunesSearchCache) return searchResults
+
+  return memoize(searchResults, itunesSearchCache, {
+    key: query => query.trim().toLowerCase()
+  })
+}
+
+module.exports = { createGetSearchResults }