oembed-spec 1.3.32 → 1.4.0

package/README.md

@@ -13,7 +13,7 @@
 
 ## Features
 
-- Always on sync with [oEmbed providers](https://oembed.com/providers.json) (as npm postinstall hook).
+- Always on sync with [oEmbed providers](https://oembed.com/providers.json) (updated weekly via GitHub Actions).
 - Handle http/https & www/non-www URLs variations.
 - Ability to pass extra oEmbed parameters.
 - Built for speed (see [benchmarks](benchmarks/README.md)).

package/package.json

@@ -2,7 +2,8 @@
   "name": "oembed-spec",
   "description": "A parser for oEmbed specification",
   "homepage": "https://github.com/microlinkhq/oembed-spec",
-  "version": "1.3.32",
+  "version": "1.4.0",
+  "types": "src/index.d.ts",
   "main": "src/index.js",
   "author": {
     "email": "hello@microlink.io",
@@ -21,6 +22,10 @@
     {
       "name": "Rémi Berson",
       "email": "remi@cliqz.com"
+    },
+    {
+      "name": "Michael Lip",
+      "email": "51033404+theluckystrike@users.noreply.github.com"
     }
   ],
   "repository": {
@@ -57,7 +62,6 @@
     "oembed-parser": "latest",
     "simple-git-hooks": "latest",
     "standard": "latest",
-    "standard-markdown": "latest",
     "standard-version": "latest"
   },
   "engines": {
@@ -67,6 +71,18 @@
     "scripts",
     "src"
   ],
+  "scripts": {
+    "benchmark": "node ./benchmarks/benchmark.js",
+    "clean": "rm -rf node_modules",
+    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "lint": "standard",
+    "postrelease": "pnpm release:tags && pnpm release:github && (ci-publish || npm publish --access=public)",
+    "pretest": "pnpm lint",
+    "release": "standard-version -a",
+    "release:github": "github-generate-release",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 ava"
+  },
   "license": "MIT",
   "ava": {
     "files": [
@@ -89,9 +105,6 @@
       "prettier-standard",
       "standard --fix"
     ],
-    "*.md": [
-      "standard-markdown"
-    ],
     "package.json": [
       "finepack"
     ]
@@ -99,18 +112,5 @@
   "simple-git-hooks": {
     "commit-msg": "npx commitlint --edit",
     "pre-commit": "npx nano-staged"
-  },
-  "scripts": {
-    "benchmark": "node ./benchmarks/benchmark.js",
-    "clean": "rm -rf node_modules",
-    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
-    "lint": "standard-markdown README.md && standard",
-    "postinstall": "node scripts/postinstall.js",
-    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
-    "pretest": "npm run lint",
-    "release": "standard-version -a",
-    "release:github": "github-generate-release",
-    "release:tags": "git push --follow-tags origin HEAD:master",
-    "test": "c8 ava"
   }
-}
+}

package/scripts/{postinstall.js → fetch-providers.js}

@@ -117,11 +117,19 @@ function buildIndex (providers) {
   }
 }
 
-fetch(PROVIDERS_URL)
-  .then(json =>
-    writeFile(
-      path.resolve(__dirname, '../src/providers.json'),
-      JSON.stringify(buildIndex(normalizeProviders(json)), null, 2)
-    )
+async function main () {
+  const json = await fetch(PROVIDERS_URL)
+  const providers = normalizeProviders(json)
+  const data = buildIndex(providers)
+  await writeFile(
+    path.resolve(__dirname, '../src/providers.json'),
+    JSON.stringify(data, null, 2)
   )
-  .catch(error => console.error(error) || process.exit(1))
+}
+
+main()
+  .then(() => process.exit(0))
+  .catch(error => {
+    console.error(error)
+    process.exit(1)
+  })

package/src/find-provider.js

@@ -50,19 +50,15 @@ const matchSchemes = (url, schemes) => {
 }
 
 const matchProvider = (url, provider) => {
-  const {
-    schemes,
-    domainWithoutSuffixOfOembedUrl,
-    domainWithoutSuffixOfUrl
-  } = provider
+  const { schemes, domainWithoutSuffixOfOembedUrl, domainWithoutSuffixOfUrl } =
+    provider
 
   if (schemes.length !== 0) {
     return matchSchemes(url, schemes) === true ? provider : undefined
   }
 
   // Since the URL doesn't have an scheme to match, try to match over oEmbed/url
-  // domain. These are pre-computed during postinstall so that no redundant work
-  // is needed.
+  // domain. These are pre-computed so that no redundant work is needed.
   const domain = getDomainWithoutSuffix(url)
   if (
     domain !== null &&
@@ -96,7 +92,7 @@ module.exports = url => {
   // work is needed. In case of a match, we usually have a list of one or two
   // candidates, which is very quick to match against.
   //
-  // For more details about `index`, see documentation in `scripts/postinstall.js`.
+  // For more details about `index`, see documentation in `scripts/fetch-providers.js`.
   const indicesOfCandidates = new Set()
   for (const token of tokenize(baseUrl)) {
     const providersForToken = index[token]

package/src/index.d.ts

@@ -0,0 +1,64 @@
+'use strict'
+
+interface Provider {
+  name: string
+  url: string
+  oembedUrl: string
+}
+
+interface OembedOptions {
+  maxwidth?: number
+  maxheight?: number
+  [key: string]: string | number | undefined
+}
+
+interface OembedResponse {
+  type: string
+  version: string
+  title?: string
+  author_name?: string
+  author_url?: string
+  provider_name?: string
+  provider_url?: string
+  cache_age?: number
+  thumbnail_url?: string
+  thumbnail_width?: number
+  thumbnail_height?: number
+  html?: string
+  width?: number
+  height?: number
+  url?: string
+}
+
+/**
+ * oembed-spec - A parser for oEmbed specification
+ * 
+ * @param url - The URL to get oembed data for
+ * @param opts - Optional oembed parameters
+ * @param gotOpts - Optional got library options for HTTP requests
+ * @returns Promise resolving to oembed response data, or undefined if no provider found
+ */
+declare function oembed(
+  url: string,
+  opts?: OembedOptions,
+  gotOpts?: Record<string, any>
+): Promise<OembedResponse | undefined>
+
+declare namespace oembed {
+  /**
+   * Find an oEmbed provider for a given URL
+   */
+  function findProvider(url: string): Provider | undefined
+
+  /**
+   * Fetch oEmbed data from a specific provider
+   */
+  function fetchProvider(
+    provider: Provider,
+    url: string,
+    opts?: OembedOptions,
+    gotOpts?: Record<string, any>
+  ): Promise<OembedResponse>
+}
+
+export = oembed