metascraper-x 5.45.6-0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2019 Microlink <hello@microlink.io> (microlink.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+<div align="center">
+  <br>
+  <img style="width: 500px; margin:3rem 0 1.5rem;" src="https://metascraper.js.org/static/logo-banner.png" alt="metascraper">
+  <br>
+  <br>
+  <p align="center"><strong>metascraper-x</strong>: Metascraper integration for x.com.</p>
+  <p align="center">See our <a href="https://metascraper.js.org" target='_blank' rel='noopener noreferrer'>website</a> for more information.</p>
+  <br>
+</div>
+
+## Install
+
+```bash
+$ npm install metascraper-x --save
+```
+
+## API
+
+### metascraper-x([options])
+
+#### options
+
+##### gotOpts
+
+Type: `object`
+
+Any option provided here will passed to [got#options](https://github.com/sindresorhus/got#options).
+
+##### resolveUrls
+
+Type: `boolean`
+
+Set to `true` if you want to resolve `t.co` URLs into the final URL.
+
+##### resolveUrl
+
+Type: `function`
+
+A decorator to be called after `t.co` is resolved. It doesn't do anything by default.
+
+## License
+
+**metascraper-x** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/metascraper/blob/master/LICENSE.md) License.<br>
+Authored and maintained by [Microlink](https://microlink.io) with help from [contributors](https://github.com/microlinkhq/metascraper/contributors).
+
+> [microlink.io](https://microlink.io) · GitHub [microlinkhq](https://github.com/microlinkhq) · Twitter [@microlinkhq](https://twitter.com/microlinkhq)

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "metascraper-x",
+  "description": "Metascraper integration for x.com",
+  "homepage": "https://github.com/microlinkhq/metascraper/packages/metascraper-x",
+  "version": "5.45.6-0",
+  "types": "src/index.d.ts",
+  "main": "src/index.js",
+  "author": {
+    "email": "hello@microlink.io",
+    "name": "microlink.io",
+    "url": "https://microlink.io"
+  },
+  "repository": {
+    "directory": "packages/metascraper-x",
+    "type": "git",
+    "url": "git+https://github.com/microlinkhq/metascraper.git"
+  },
+  "bugs": {
+    "url": "https://github.com/microlinkhq/metascraper/issues"
+  },
+  "keywords": [
+    "audio",
+    "metascraper",
+    "spotify"
+  ],
+  "dependencies": {
+    "@metascraper/helpers": "^5.45.6",
+    "get-urls": "~10.0.1"
+  },
+  "devDependencies": {
+    "ava": "5"
+  },
+  "engines": {
+    "node": ">= 16"
+  },
+  "files": [
+    "src"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "test": "NODE_PATH=.. TZ=UTC ava --timeout 15s"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+declare function rules(): import('metascraper').Rules;
+export = rules;

package/src/index.js

@@ -0,0 +1,87 @@
+'use strict'
+
+const reachableUrl = require('reachable-url')
+const getUrls = require('get-urls')
+
+const {
+  author,
+  image,
+  memoizeOne,
+  parseUrl,
+  title,
+  toRule,
+  description,
+  url
+} = require('@metascraper/helpers')
+
+const toAuthor = toRule(author)
+const toImage = toRule(image)
+const toTitle = toRule(title)
+const toDescription = toRule(description)
+const toUrl = toRule(url)
+
+const test = memoizeOne(url =>
+  ['twitter', 'x'].includes(parseUrl(url).domainWithoutSuffix)
+)
+
+module.exports = ({
+  gotOpts,
+  resolveUrls = false,
+  resolveUrl = url => url
+} = {}) => {
+  const rules = {
+    author: [
+      toAuthor($ => {
+        const author = $('meta[property="og:title"]').attr('content')
+        return author?.includes(' on X') ? author.split(' on X')[0] : author
+      })
+    ],
+    title: [toTitle(($, url) => `@${url.split('/')[3]} on X`)],
+    url: [
+      toUrl($ =>
+        $('link[rel="canonical"]').attr('href').replace('twitter.com', 'x.com')
+      )
+    ],
+    description: [
+      toDescription(async $ => {
+        let description = $('meta[property="og:description"]').attr('content')
+        if (!resolveUrls) return description
+
+        const urls = Array.from(getUrls(description))
+
+        const resolvedUrls = await Promise.all(
+          urls.map(async url => {
+            const response = await reachableUrl(url, gotOpts)
+            if (reachableUrl.isReachable(response)) {
+              return resolveUrl(response.url)
+            }
+            return url
+          })
+        )
+
+        for (const [index, url] of resolvedUrls.entries()) {
+          const original = urls[index]
+          description = description.replace(original, url)
+        }
+
+        return description
+      })
+    ],
+    image: [
+      toImage($ => {
+        let imageUrl = $('meta[property="og:image"]').attr('content')
+        if (imageUrl.endsWith('_200x200.jpg')) {
+          imageUrl = imageUrl.replace('_200x200.jpg', '_400x400.jpg')
+        }
+        return imageUrl
+      })
+    ],
+    publisher: () => 'X'
+  }
+
+  rules.test = ({ url }) => test(url)
+
+  return rules
+}
+
+module.exports.test = test