@microlink/mql 0.10.33 → 0.10.35

package/lightweight/index.d.ts

@@ -0,0 +1,172 @@
+type ColorScheme = | "dark" | "light";
+
+type WaitUntilEvent = "load" | "domcontentloaded" | "networkidle0" | "networkidle2";
+
+type PixelUnit = string | number;
+
+type ScreenshotOverlay = {
+  background?: string,
+  browser?: 'dark' | 'light'
+}
+
+type PdfMargin = {
+  top?: string | number;
+   bottom?: string | number;
+   left?: string | number;
+   right?: string | number;
+}
+
+type PdfOptions = {
+  format?: string;
+  height?: PixelUnit;
+  landscape?: string;
+  margin?: string | PdfMargin;
+  pageRanges?: string;
+  scale?: number;
+  width?: PixelUnit;
+}
+
+type ScreenshotOptions = {
+  codeScheme?: string;
+  omitBackground?: boolean;
+  type?: "jpeg" | "png";
+  element?: string;
+  fullPage?: boolean;
+  overlay?: ScreenshotOverlay
+}
+
+export type MqlOptions = {
+  endpoint?: string;
+  apiKey?: string;
+  retry?: number;
+  cache?: Map<string, any>;
+}
+
+type MqlQuery = {
+  [field: string]: MqlQueryOptions;
+}
+
+type MqlQueryOptions = {
+  attr?: string | string[] | MqlQuery;
+  evaluate?: string;
+  selector?: string | string[];
+  selectorAll?: string | string[];
+  type?: "audio" | "author" | "auto" | "boolean" | "date" | "description" | "email" | "image" | "ip" | "lang" | "logo" | "number" | "object" | "publisher" | "regexp" | "string" | "title" | "url" | "video";
+}
+
+export type MicrolinkApiOptions = {
+  adblock?: boolean;
+  animations?: boolean;
+  audio?: boolean;
+  click?: string | string[];
+  colorScheme?: ColorScheme;
+  data?: MqlQuery;
+  device?: string;
+  embed?: string;
+  filename?: string;
+  filter?: string;
+  force?: boolean;
+  function?: string;
+  headers?: Record<string, string>;
+  iframe?: boolean | { maxWidth?: number, maxHeight?: number };
+  insights?: boolean | { lighthouse?: boolean | object, technologies?: boolean };
+  javascript?: boolean;
+  mediaType?: string;
+  meta?: boolean | { logo: { square: boolean } };
+  modules?: string | string[];
+  palette?: boolean;
+  pdf?: boolean | PdfOptions;
+  ping?: boolean | object;
+  prerender?: boolean | "auto";
+  proxy?: string | { countryCode?: string };
+  retry?: number;
+  screenshot?: boolean | ScreenshotOptions;
+  scripts?: string | string[];
+  scroll?: string;
+  styles?: string | string[];
+  staleTtl?: string | number;
+  timeout?: number;
+  ttl?: string | number;
+  video?: boolean;
+  viewport?: object;
+  waitForSelector?: string;
+  waitForTimeout?: number;
+  waitUntil?: WaitUntilEvent | WaitUntilEvent[];
+}
+
+type IframeInfo = {
+  html: string;
+  scripts: Record<string, unknown>;
+}
+
+type MediaInfo = {
+  type?: string;
+  palette?: string[];
+  background_color?: string;
+  color?: string;
+  alternative_color?: string;
+  width?: number;
+  height?: number;
+   duration?: number;
+   duration_pretty?: string;
+}
+
+type MqlResponseData = {
+  // A human-readable representation of the author's name.
+  author?: string | null;
+  // An ISO 8601 representation of the date the article was published.
+  date?: string | null;
+  // The publisher's chosen description of the article.
+  description?: string | null;
+  // An ISO 639-1 representation of the url content language.
+  lang?: string | null;
+  // An image URL that best represents the publisher brand.
+  logo?: MediaInfo | null;
+  // A human-readable representation of the publisher's name.
+  publisher?: string | null;
+  // The publisher's chosen title of the article.
+  title?: string | null;
+  // The URL of the article.
+  url?: string;
+  image?: MediaInfo | null;
+  screenshot?: MediaInfo | null;
+  video?: MediaInfo | null;
+  audio?: MediaInfo | null;
+  iframe?: IframeInfo | null;
+  function?: MqlFunctionResult;
+}
+
+type MqlFunctionResult = {
+  isFulfilled: boolean;
+  isRejected: boolean;
+  value: any;
+};
+
+type MqlStatus = "success" | "fail" | "error";
+
+export type MqlPayload = {
+  status: MqlStatus;
+  data: MqlResponseData;
+  statusCode: number;
+  headers: { [key: string]: string };
+  more?: string,
+  code?: string,
+  url?: string
+}
+
+type MqlResponse = MqlPayload & {
+  response: {
+    url: string;
+    statusCode: number;
+    headers: Headers;
+    body: MqlPayload
+  };
+}
+
+declare function mql(
+  url: string,
+  opts?: MqlOptions & MicrolinkApiOptions,
+  gotOpts?: object
+): Promise<MqlResponse>;
+
+export default mql;

package/lightweight/package.json

@@ -1,4 +1,4 @@
 {
-  "main": "../src/browser.js",
-  "types": "../index.d.ts"
+  "main": "../src/lightweight.js",
+  "types": "index.d.ts"
 }

package/package.json

@@ -2,8 +2,8 @@
   "name": "@microlink/mql",
   "description": "Microlink Query Language. The official HTTP client to interact with Microlink API for Node.js, browsers & Deno.",
   "homepage": "https://nicedoc.io/microlinkhq/mql",
-  "version": "0.10.33",
-  "browser": "src/browser.js",
+  "version": "0.10.35",
+  "browser": "src/lightweight.js",
   "main": "src/node.js",
   "author": {
     "email": "josefrancisco.verdu@gmail.com",
@@ -51,25 +51,20 @@
   "devDependencies": {
     "@commitlint/cli": "latest",
     "@commitlint/config-conventional": "latest",
+    "@ksmithut/prettier-standard": "latest",
     "@rollup/plugin-commonjs": "latest",
     "@rollup/plugin-node-resolve": "latest",
     "@rollup/plugin-replace": "latest",
     "@rollup/plugin-terser": "latest",
-    "abort-controller": "latest",
+    "async-listen": "latest",
     "ava": "3",
-    "beauty-error": "latest",
     "c8": "latest",
-    "chalk": "latest",
     "ci-publish": "latest",
     "conventional-github-releaser": "latest",
-    "eachdir": "latest",
     "esm": "latest",
-    "exists-file": "latest",
     "git-authors-cli": "latest",
     "ky": "latest",
-    "meow": "latest",
     "nano-staged": "latest",
-    "node-fetch": "2",
     "npm-check-updates": "latest",
     "prettier-standard": "latest",
     "rollup": "latest",
@@ -80,8 +75,7 @@
     "standard-markdown": "latest",
     "standard-version": "latest",
     "stream-to-promise": "latest",
-    "test-listen": "latest",
-    "web-streams-polyfill": "latest"
+    "tsd": "latest"
   },
   "engines": {
     "node": ">= 12"
@@ -99,7 +93,7 @@
     "clean:build": "rm -rf dist",
     "contributors": "(npx git-authors-cli && npx finepack --sort-ignore-object-at ava && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
     "dev": "npm run build -- -w",
-    "lint": "standard",
+    "lint": "standard && tsd",
     "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
     "prebuild": "npm run clean:build && npm run build:kys",
     "prerelease": "npm run update:check",
@@ -130,7 +124,8 @@
   },
   "nano-staged": {
     "*.js,!*.min.js,": [
-      "prettier-standard"
+      "prettier-standard",
+      "standard --fix"
     ],
     "*.md": [
       "standard-markdown"
@@ -154,6 +149,9 @@
       "postbump": "npm run build"
     }
   },
+  "tsd": {
+    "directory": "test"
+  },
   "types": "index.d.ts",
   "umd:main": "dist/mql.js",
   "unpkg": "dist/mql.js"

package/src/factory.js

@@ -52,7 +52,7 @@ const factory = ({ VERSION, MicrolinkError, urlHttp, got, flatten }) => {
     }, {})
   }
 
-  const fetchFromApi = async (apiUrl, opts = {}, retryCount = 0) => {
+  const fetchFromApi = async (apiUrl, opts = {}) => {
     try {
       const response = await got(apiUrl, opts)
       return opts.responseType === 'buffer'
@@ -73,10 +73,6 @@ const factory = ({ VERSION, MicrolinkError, urlHttp, got, flatten }) => {
           ? rawBody
           : parseBody(isBodyBuffer ? rawBody.toString() : rawBody, err, uri)
 
-      if (body.code === 'EFATALCLIENT' && retryCount++ < 2) {
-        return fetchFromApi(apiUrl, opts, retryCount)
-      }
-
       throw new MicrolinkError({
         ...body,
         message: body.message,