feat: add types for packages (#677)

* feat: add types for packages

Closes #676

* refactor(types): use declare

packages/metascraper-amazon/package.json

@@ -3,7 +3,8 @@
   "description": "Metascraper integration with Amazon",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-amazon",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-amazon/src/index.d.ts

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

packages/metascraper-amazon/index.js → packages/metascraper-amazon/src/index.js

@@ -11,7 +11,8 @@ const {
   url
 } = require('@metascraper/helpers')
 
-const REGEX_AMAZON_URL = /https?:\/\/(.*amazon\..*\/.*|.*amzn\..*\/.*|.*a\.co\/.*)/i
+const REGEX_AMAZON_URL =
+  /https?:\/\/(.*amazon\..*\/.*|.*amzn\..*\/.*|.*a\.co\/.*)/i
 
 const test = memoizeOne(url => REGEX_AMAZON_URL.test(url))
 

packages/metascraper-audio/package.json

@@ -3,7 +3,8 @@
   "description": "Get audio property from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-audio",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-audio/src/index.d.ts

@@ -0,0 +1,11 @@
+type IframeAttributes = {
+  src: string
+}
+
+type Options = {
+  getIframe?: (url: string, htmlDom: import('cheerio').CheerioAPI, iframeAttributes: IframeAttributes) => string;
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;
+

packages/metascraper-audio/index.js → packages/metascraper-audio/src/index.js

@@ -78,7 +78,12 @@ module.exports = ({ getIframe = _getIframe } = {}) => {
   return {
     audio: audioRules.concat(
       async ({ htmlDom: $, url }) => {
-        const srcs = [...new $('iframe').map((_, element) => $(element).attr('src')).get().map(src => normalizeUrl(url, src))]
+        const srcs = [
+          ...new $('iframe')
+            .map((_, element) => $(element).attr('src'))
+            .get()
+            .map(src => normalizeUrl(url, src))
+        ]
         if (srcs.length === 0) return
         return pReflect(
           Promise.any(

packages/metascraper-audio/test/index.js

@@ -3,7 +3,7 @@
 const test = require('ava')
 
 const createMetascraper = (...args) =>
-  require('metascraper')([require('..')(...args)])
+  require('metascraper')([require('../src')(...args)])
 
 test('og:audio', async t => {
   const html =

packages/metascraper-author/package.json

@@ -3,7 +3,8 @@
   "description": "Get author property from HTML markup",
   "homepage": "https://metascraper.js.org",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-author/src/index.d.ts

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

packages/metascraper-clearbit/package.json

@@ -3,7 +3,8 @@
   "description": "Metascraper integration with Clearbit Logo API",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-clearbit",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-clearbit/src/index.d.ts

@@ -0,0 +1,21 @@
+type Options = {
+  /**
+   * https://github.com/sindresorhus/got#options
+   */
+  gotOpts?: import('got').Options,
+  /**
+   * https://github.com/microlinkhq/keyv/tree/master/packages/memoize#keyvoptions
+   */
+  keyvOpts?: import('@keyvhq/core').Options,
+  /**
+   * https://dashboard.clearbit.com/docs#logo-api
+   */
+  logoOpts?: {
+    size: number,
+    format: "png" | "jpg"
+    greyscale: false
+  }
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;

packages/metascraper-clearbit/test/index.js

@@ -3,7 +3,7 @@
 const test = require('ava')
 
 const createMetascraper = (...args) =>
-  require('metascraper')([require('..')(...args)])
+  require('metascraper')([require('../src')(...args)])
 
 test('provide `keyvOpts`', async t => {
   const cache = new Map()

packages/metascraper-date/package.json

@@ -3,7 +3,8 @@
   "description": "Get date property from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-date",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "scripts/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-date/src/index.d.ts

@@ -0,0 +1,15 @@
+type Options = {
+  /**
+   * Whether to add the date published and date modified to the result.
+   * @default true
+   */
+  datePublished?: boolean,
+  /**
+   * Whether to add the date published and date modified to the result.
+   * @default true
+   */
+  dateModified?: boolean
+}
+
+declare function rules(options?: Options = defaultOptions): import('metascraper').Rules;
+export = rules;

packages/metascraper-description/package.json

@@ -3,7 +3,8 @@
   "description": "Get description property from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-description",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-description/src/index.d.ts

@@ -0,0 +1,30 @@
+type Options = {
+  /**
+   * The maximum length of the description.
+   * @default Number.MAX_SAFE_INTEGER
+   */
+  truncateLength?: number,
+  /**
+   * The string to append if the description is truncated.
+   * @default '…'
+   */
+  ellipsis?: string,
+  /**
+   * Whether to remove the byline from the description.
+   * @default false
+   */
+  removeBy?: boolean,
+  /**
+   * Whether to remove the separator from the description.
+   * @default false
+   */
+  removeSeparator?: boolean,
+  /**
+   * Whether to capitalize the description.
+   * @default false
+   */
+  capitalize?: boolean
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;

packages/metascraper-feed/package.json

@@ -3,7 +3,8 @@
   "description": "Get RSS/Atom feed URL from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-description",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-feed/src/index.d.ts

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

packages/metascraper-iframe/package.json

@@ -4,6 +4,7 @@
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-iframe",
   "version": "5.40.0",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-iframe/src/index.d.ts

@@ -0,0 +1,9 @@
+type Options = {
+  /**
+   * https://github.com/sindresorhus/got#options
+   */
+  gotOpts?: import('got').Options,
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;

packages/metascraper-image/package.json

@@ -3,7 +3,8 @@
   "description": "Get image property from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-image",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-image/src/index.d.ts

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

packages/metascraper-instagram/package.json

@@ -3,7 +3,8 @@
   "description": "Metascraper integration for Instagram",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-instagram",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-instagram/src/index.d.ts

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

packages/metascraper-lang/package.json

@@ -3,7 +3,8 @@
   "description": "Get lang property from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-lang",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-lang/src/index.d.ts

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

packages/metascraper-lang/test/index.js

@@ -4,7 +4,7 @@ const { readFile } = require('fs/promises')
 const { resolve } = require('path')
 const test = require('ava')
 
-const metascraper = require('metascraper')([require('..')()])
+const metascraper = require('metascraper')([require('../src')()])
 
 test('html lang property', async t => {
   const html = await readFile(resolve(__dirname, 'fixtures/html-lang.html'))

packages/metascraper-logo-favicon/package.json

@@ -3,7 +3,8 @@
   "description": "metascraper logo favicon fallback",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-logo-favicon",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "types/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-logo-favicon/src/index.d.ts

@@ -0,0 +1,36 @@
+type DOMNOdeAtributes = Record<string, any>
+
+type Options = {
+  /**
+   * Enable favicon.ico detection
+   * @default true
+   */
+  favicon?: boolean,
+  /**
+   * Enable favicon.ico using the root domain for subdomains
+   * @default true
+   */
+  rootFavicon?: boolean | RegExp,
+  /**
+   * Enable retrieve logo from Google API.
+   * @default true
+   */
+  google?: boolean,
+  /**
+   * https://github.com/sindresorhus/got#options
+   */
+  gotOpts?: import('got').Options,
+  /**
+   * https://github.com/microlinkhq/keyv/tree/master/packages/memoize#keyvoptions
+   */
+  keyvOpts?: import('@keyvhq/core').Options,
+  /**
+   * The function to pick the favicon from the list of favicons.
+   */
+  pickFn?: (sizes: DOMNOdeAtributes[]) => DOMNOdeAtributes,
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;
+
+

packages/metascraper-logo/package.json

@@ -3,7 +3,8 @@
   "description": "Get logo property from HTML markup",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-logo",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-logo/src/index.d.ts

@@ -0,0 +1,6 @@
+type Options = {
+  filter?: (url: string) => boolean
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;

packages/metascraper-manifest/package.json

@@ -3,7 +3,8 @@
   "description": "Metascraper integration for detecting PWA Web app manifest",
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-manifest",
   "version": "5.40.0",
-  "main": "index.js",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",

packages/metascraper-manifest/src/index.d.ts

@@ -0,0 +1,13 @@
+type Options = {
+  /**
+   * https://github.com/sindresorhus/got#options
+   */
+  gotOpts?: import('got').Options,
+  /**
+   * https://github.com/microlinkhq/keyv/tree/master/packages/memoize#keyvoptions
+   */
+  keyvOpts?: import('@keyvhq/core').Options,
+}
+
+declare function rules(options?: Options): import('metascraper').Rules;
+export = rules;

packages/metascraper-manifest/index.js → packages/metascraper-manifest/src/index.js

@@ -9,12 +9,7 @@ const memoize = require('@keyvhq/memoize')
 const got = require('got')
 
 const parseSize = str => {
-  const parse = Number(
-    chain(str)
-      .split('x')
-      .first()
-      .value()
-  )
+  const parse = Number(chain(str).split('x').first().value())
   return Number.isNaN(parse) ? 0 : parse
 }
 

packages/metascraper-media-provider/package.json

@@ -4,6 +4,7 @@
   "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-media-provider",
   "version": "5.40.0",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "author": {
     "email": "[email protected]",
     "name": "microlink.io",
@@ -32,7 +33,7 @@
     "p-reflect": "~2.1.0",
     "p-retry": "~4.6.1",
     "p-timeout": "~4.1.0",
-    "youtube-dl-exec": "~2.4.12"
+    "youtube-dl-exec": "~2.5.2"
   },
   "devDependencies": {
     "@kikobeats/time-span": "latest",