feature/browser compatibility (#6)

meodai · zeke · web-flow · commit 6c88b6225807 · 2021-05-06T14:23:23.000-07:00
Co-authored-by: Zeke Sikelianos &lt;zeke@sikelianos.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/build.js b/build.js
@@ -0,0 +1,8 @@
+const fs = require('fs')
+
+const body = fs.readFileSync('index.js', 'utf8')
+const nodeTpl = fs.readFileSync('index.node.js.tpl', 'utf8')
+const browserTpl = fs.readFileSync('index.js.tpl', 'utf8')
+
+fs.writeFileSync('dist/index.node.js', nodeTpl.replace('{{body}}', body));
+fs.writeFileSync('dist/index.js', browserTpl.replace('{{body}}', body));
diff --git a/cli.js b/cli.js
@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-const lookup = require('.')
+const lookup = require('./dist/index.node')
 const query = process.argv.slice(2)
 const wrap = require('wordwrap')(80)
 
diff --git a/demo/index.html b/demo/index.html
@@ -0,0 +1,29 @@
+<!doctype html>
+
+<html lang=en>
+
+<head>
+  <meta charset=utf-8>
+  <title>Wikipedia TLDR Browser Demo</title>
+</head>
+
+<body>
+  <div class="result">
+
+  </div>
+
+  <script type="module">
+    import wikipediatldr from '../dist/index.js'
+    (async () => {
+      const results = await wikipediatldr('pink');
+      console.log(results);
+      document.querySelector('.result').innerHTML = `
+        <h1>${results.displaytitle}</h1>
+        <div>${results.extract_html}</div>
+        <img src="${results.originalimage.source}" alt="${results.displaytitle}" />
+      `
+    })()
+  </script>
+</body>
+
+</html>
diff --git a/dist/index.js b/dist/index.js
@@ -0,0 +1,54 @@
+const defaultUnwantedProps = [
+  'content_urls',
+  'dir',
+  'revision',
+  'tid',
+  'timestamp',
+  'pageid',
+  'namespace',
+  'titles',
+  'api_urls'
+]
+
+async function lookup (
+  query,
+  locale = 'en',
+  followRedirects = false,
+  unwantedProps = defaultUnwantedProps
+) {
+  const url = new URL(`https://${locale}.wikipedia.org`)
+  const params = { followRedirects }
+
+  url.pathname = `/api/rest_v1/page/summary/${encodeURIComponent(query)}`
+  url.search = new URLSearchParams(params).toString()
+
+  let body
+
+  try {
+    const res = await fetch(url).then(res => {
+      if (!res.ok) {
+        throw Error(res.statusText)
+      }
+      return res
+    })
+    body = await res.json()
+  } catch (err) {
+    return null
+  }
+
+  unwantedProps.forEach(prop => {
+    delete body[prop]
+  })
+
+  if (body.text) {
+    body.text = body.text
+      .trim()
+      .replace(/\[\d+\]/g, '')
+  } // remove footnotes like [1]
+
+  if (body.html) body.html = body.html.trim()
+
+  return Object.assign({}, { query: query }, body)
+}
+
+export default lookup
diff --git a/dist/index.node.js b/dist/index.node.js
@@ -0,0 +1,57 @@
+const fetch = require('node-fetch')
+const { URL, URLSearchParams } = require('url')
+
+const defaultUnwantedProps = [
+  'content_urls',
+  'dir',
+  'revision',
+  'tid',
+  'timestamp',
+  'pageid',
+  'namespace',
+  'titles',
+  'api_urls'
+]
+
+async function lookup (
+  query,
+  locale = 'en',
+  followRedirects = false,
+  unwantedProps = defaultUnwantedProps
+) {
+  const url = new URL(`https://${locale}.wikipedia.org`)
+  const params = { followRedirects }
+
+  url.pathname = `/api/rest_v1/page/summary/${encodeURIComponent(query)}`
+  url.search = new URLSearchParams(params).toString()
+
+  let body
+
+  try {
+    const res = await fetch(url).then(res => {
+      if (!res.ok) {
+        throw Error(res.statusText)
+      }
+      return res
+    })
+    body = await res.json()
+  } catch (err) {
+    return null
+  }
+
+  unwantedProps.forEach(prop => {
+    delete body[prop]
+  })
+
+  if (body.text) {
+    body.text = body.text
+      .trim()
+      .replace(/\[\d+\]/g, '')
+  } // remove footnotes like [1]
+
+  if (body.html) body.html = body.html.trim()
+
+  return Object.assign({}, { query: query }, body)
+}
+
+module.exports = lookup
diff --git a/index.js b/index.js
@@ -1,6 +1,4 @@
-const get = require('got')
-const URL = require('url')
-const unwantedProps = [
+const defaultUnwantedProps = [
   'content_urls',
   'dir',
   'revision',
@@ -12,17 +10,28 @@ const unwantedProps = [
   'api_urls'
 ]
 
-async function lookup (query, locale = 'en') {
-  const url = URL.format({
-    protocol: 'https',
-    hostname: `${locale}.wikipedia.org`,
-    pathname: `/api/rest_v1/page/summary/${encodeURIComponent(query)}`
-  })
+async function lookup (
+  query,
+  locale = 'en',
+  followRedirects = false,
+  unwantedProps = defaultUnwantedProps
+) {
+  const url = new URL(`https://${locale}.wikipedia.org`)
+  const params = { followRedirects }
+
+  url.pathname = `/api/rest_v1/page/summary/${encodeURIComponent(query)}`
+  url.search = new URLSearchParams(params).toString()
 
   let body
+
   try {
-    const res = await get(url, { json: true })
-    body = res.body
+    const res = await fetch(url).then(res => {
+      if (!res.ok) {
+        throw Error(res.statusText)
+      }
+      return res
+    })
+    body = await res.json()
   } catch (err) {
     return null
   }
@@ -41,5 +50,3 @@ async function lookup (query, locale = 'en') {
 
   return Object.assign({}, { query: query }, body)
 }
-
-module.exports = lookup
diff --git a/index.js.tpl b/index.js.tpl
@@ -0,0 +1,2 @@
+{{body}}
+export default lookup
diff --git a/index.node.js.tpl b/index.node.js.tpl
@@ -0,0 +1,5 @@
+const fetch = require('node-fetch')
+const { URL, URLSearchParams } = require('url')
+
+{{body}}
+module.exports = lookup
diff --git a/jest.config.js b/jest.config.js
@@ -1,5 +1,5 @@
 // https://jestjs.io/docs/en/configuration.html
 
 module.exports = {
-  testEnvironment: 'node'
+  testEnvironment: 'node',
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test.js b/test.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`// https://jestjs.io/docs/en/configuration.html`
`2`	`2`
`3`	`3`	`module.exports = {`
`4`		`- testEnvironment: 'node'`
	`4`	`+ testEnvironment: 'node',`
`5`	`5`	`}`