@microlink/mql 0.14.1 → 0.15.0

package/{lightweight → dist}/index.d.ts

@@ -42,7 +42,6 @@ type ScreenshotOptions = {
 
 type MqlClientOptions = {
   apiKey?: string
-  cache?: Map<string, any>
   endpoint?: string
   retry?: number
 }
@@ -232,8 +231,9 @@ interface mql {
     opts?: MqlOptions,
     gotOpts?: object
   ) => Promise<HTTPResponseRaw>
+  buffer: (url: string, opts?: MqlOptions, gotOpts?: object) => Promise<HTTPResponseRaw>
   extend: (gotOpts?: object) => mql
-  stream: (input: RequestInfo, init?: RequestInit) => ReadableStream
+  stream: (input: RequestInfo, init?: RequestInit) => Promise<ReadableStream | null>
   MicrolinkError: new (props: object) => MqlErrorProps
   version: string
 }

package/{lightweight → dist}/index.js

@@ -31,7 +31,7 @@ function getAugmentedNamespace(n) {
 	return a;
 }
 
-var lightweight = {exports: {}};
+var src = {exports: {}};
 
 var dist = {};
 
@@ -566,9 +566,6 @@ const deepMerge = (...sources) => {
             returnValue.signal = signals.at(-1);
         }
     }
-    if (returnValue.context === undefined) {
-        returnValue.context = {};
-    }
     return returnValue;
 };
 
@@ -1191,7 +1188,7 @@ const createInstance = (defaults) => {
     ky.retry = retry;
     return ky;
 };
-const ky$1 = createInstance();
+const ky = createInstance();
 // Intentionally not exporting this for now as it's just an implementation detail and we don't want to commit to a certain API yet at least.
 // export {NonError} from './errors/NonError.js';
 
@@ -1200,7 +1197,7 @@ var distribution = /*#__PURE__*/Object.freeze({
 	ForceRetryError: ForceRetryError,
 	HTTPError: HTTPError,
 	TimeoutError: TimeoutError,
-	default: ky$1,
+	default: ky,
 	isForceRetryError: isForceRetryError,
 	isHTTPError: isHTTPError,
 	isKyError: isKyError,
@@ -1209,14 +1206,13 @@ var distribution = /*#__PURE__*/Object.freeze({
 
 var require$$1 = /*@__PURE__*/getAugmentedNamespace(distribution);
 
-const VERSION$1 = '0.14.1';
+const VERSION = '0.15.0';
 
 var constants = {
-  VERSION: VERSION$1,
-  USER_AGENT: `mql/${VERSION$1}`,
+  VERSION,
+  USER_AGENT: `mql/${VERSION}`,
   /**
-   * Based on require('got').defaults.options.retry.statusCodes
-   * but without 429 (too many requests)
+   * Retry status codes, excluding 429 (too many requests).
    */
   RETRY_STATUS_CODES: [408, 413, 500, 502, 503, 504, 521, 522, 524]
 };
@@ -1259,7 +1255,7 @@ const isURL = url => {
   }
 };
 
-const factory$1 = streamResponseType => ({
+const factory = streamResponseType => ({
   VERSION,
   MicrolinkError,
   got,
@@ -1364,78 +1360,82 @@ const factory$1 = streamResponseType => ({
   return mql
 };
 
-var factory_1 = factory$1;
-
-const { flattie: flatten } = dist;
-const { default: ky } = require$$1;
+var factory_1 = factory;
 
-const { VERSION, USER_AGENT, RETRY_STATUS_CODES } = constants;
-
-const kyInstance = ky.extend({
-  headers: { 'user-agent': USER_AGENT },
-  retry: { statusCodes: RETRY_STATUS_CODES }
-});
+(function (module) {
 
-const factory = factory_1('arrayBuffer');
-
-class MicrolinkError extends Error {
-  constructor (props) {
-    super();
-    this.name = 'MicrolinkError';
-    Object.assign(this, props);
-    this.description = this.message;
-    this.message = this.code
-      ? `${this.code}, ${this.description}`
-      : this.description;
-  }
-}
-
-const got = async (url, { responseType, ...opts }) => {
-  try {
-    if (opts.timeout === undefined) opts.timeout = false;
-    const response = await kyInstance(url, opts);
-    const body = await response[responseType]();
-    const { headers, status: statusCode } = response;
-    return { url: response.url, body, headers, statusCode }
-  } catch (error) {
-    if (error.response) {
-      const { response } = error;
-      error.response = {
-        ...response,
-        headers: Array.from(response.headers.entries()).reduce(
-          (acc, [key, value]) => {
-            acc[key] = value;
-            return acc
-          },
-          {}
-        ),
-        statusCode: response.status,
-        body: await response.text()
-      };
-    }
-    throw error
-  }
-};
+	const { flattie: flatten } = dist;
+	const { default: ky } = require$$1;
 
-got.stream = (...args) => kyInstance(...args).then(res => res.body);
+	const { VERSION, USER_AGENT, RETRY_STATUS_CODES } = constants;
 
-const mql = factory({
-  MicrolinkError,
-  got,
-  flatten,
-  VERSION
-});
+	const kyInstance = ky.extend({
+	  headers: { 'user-agent': USER_AGENT },
+	  retry: { statusCodes: RETRY_STATUS_CODES }
+	});
 
-lightweight.exports = mql;
-var arrayBuffer = lightweight.exports.arrayBuffer = mql.extend({ responseType: 'arrayBuffer' });
-var extend = lightweight.exports.extend = mql.extend;
-var fetchFromApi = lightweight.exports.fetchFromApi = mql.fetchFromApi;
-var getApiUrl = lightweight.exports.getApiUrl = mql.getApiUrl;
-var mapRules = lightweight.exports.mapRules = mql.mapRules;
-var MicrolinkError_1 = lightweight.exports.MicrolinkError = mql.MicrolinkError;
-var version = lightweight.exports.version = mql.version;
+	const factory = factory_1('arrayBuffer');
+
+	class MicrolinkError extends Error {
+	  constructor (props) {
+	    super();
+	    this.name = 'MicrolinkError';
+	    Object.assign(this, props);
+	    this.description = this.message;
+	    this.message = this.code
+	      ? `${this.code}, ${this.description}`
+	      : this.description;
+	  }
+	}
 
-var lightweightExports = lightweight.exports;
-var lightweight_default = /*@__PURE__*/getDefaultExportFromCjs(lightweightExports);
+	const got = async (url, { responseType, ...opts }) => {
+	  try {
+	    if (opts.timeout === undefined) opts.timeout = false;
+	    const response = await kyInstance(url, opts);
+	    const body = await response[responseType]();
+	    const { headers, status: statusCode } = response;
+	    return { url: response.url, body, headers, statusCode }
+	  } catch (error) {
+	    if (error.response) {
+	      const { response } = error;
+	      error.response = {
+	        ...response,
+	        headers: Array.from(response.headers.entries()).reduce(
+	          (acc, [key, value]) => {
+	            acc[key] = value;
+	            return acc
+	          },
+	          {}
+	        ),
+	        statusCode: response.status,
+	        body: await response.text()
+	      };
+	    }
+	    throw error
+	  }
+	};
+
+	got.stream = (...args) => kyInstance(...args).then(res => res.body);
+
+	const mql = factory({
+	  MicrolinkError,
+	  got,
+	  flatten,
+	  VERSION
+	});
 
-export { MicrolinkError_1 as MicrolinkError, arrayBuffer, lightweight_default as default, extend, fetchFromApi, getApiUrl, mapRules, version };
+	module.exports = mql;
+	module.exports.arrayBuffer = mql.extend({ responseType: 'arrayBuffer' });
+	module.exports.buffer = module.exports.arrayBuffer;
+	module.exports.extend = mql.extend;
+	module.exports.fetchFromApi = mql.fetchFromApi;
+	module.exports.getApiUrl = mql.getApiUrl;
+	module.exports.mapRules = mql.mapRules;
+	module.exports.MicrolinkError = mql.MicrolinkError;
+	module.exports.version = mql.version; 
+} (src));
+
+var srcExports = src.exports;
+var index = /*@__PURE__*/getDefaultExportFromCjs(srcExports);
+
+export { index as default };

package/{lightweight → dist}/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-	typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
-	typeof define === 'function' && define.amd ? define(['exports'], factory) :
-	(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.mql = {}));
-})(this, (function (exports) { 'use strict';
+	typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+	typeof define === 'function' && define.amd ? define(factory) :
+	(global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.mql = factory());
+})(this, (function () { 'use strict';
 
 	function getDefaultExportFromCjs (x) {
 		return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -37,7 +37,7 @@
 		return a;
 	}
 
-	var lightweight = {exports: {}};
+	var src = {exports: {}};
 
 	var dist = {};
 
@@ -572,9 +572,6 @@
 	            returnValue.signal = signals.at(-1);
 	        }
 	    }
-	    if (returnValue.context === undefined) {
-	        returnValue.context = {};
-	    }
 	    return returnValue;
 	};
 
@@ -1197,7 +1194,7 @@
 	    ky.retry = retry;
 	    return ky;
 	};
-	const ky$1 = createInstance();
+	const ky = createInstance();
 	// Intentionally not exporting this for now as it's just an implementation detail and we don't want to commit to a certain API yet at least.
 	// export {NonError} from './errors/NonError.js';
 
@@ -1206,7 +1203,7 @@
 		ForceRetryError: ForceRetryError,
 		HTTPError: HTTPError,
 		TimeoutError: TimeoutError,
-		default: ky$1,
+		default: ky,
 		isForceRetryError: isForceRetryError,
 		isHTTPError: isHTTPError,
 		isKyError: isKyError,
@@ -1215,14 +1212,13 @@
 
 	var require$$1 = /*@__PURE__*/getAugmentedNamespace(distribution);
 
-	const VERSION$1 = '0.14.1';
+	const VERSION = '0.15.0';
 
 	var constants = {
-	  VERSION: VERSION$1,
-	  USER_AGENT: `mql/${VERSION$1}`,
+	  VERSION,
+	  USER_AGENT: `mql/${VERSION}`,
 	  /**
-	   * Based on require('got').defaults.options.retry.statusCodes
-	   * but without 429 (too many requests)
+	   * Retry status codes, excluding 429 (too many requests).
 	   */
 	  RETRY_STATUS_CODES: [408, 413, 500, 502, 503, 504, 521, 522, 524]
 	};
@@ -1265,7 +1261,7 @@
 	  }
 	};
 
-	const factory$1 = streamResponseType => ({
+	const factory = streamResponseType => ({
 	  VERSION,
 	  MicrolinkError,
 	  got,
@@ -1370,89 +1366,84 @@
 	  return mql
 	};
 
-	var factory_1 = factory$1;
+	var factory_1 = factory;
 
-	const { flattie: flatten } = dist;
-	const { default: ky } = require$$1;
+	(function (module) {
 
-	const { VERSION, USER_AGENT, RETRY_STATUS_CODES } = constants;
-
-	const kyInstance = ky.extend({
-	  headers: { 'user-agent': USER_AGENT },
-	  retry: { statusCodes: RETRY_STATUS_CODES }
-	});
+		const { flattie: flatten } = dist;
+		const { default: ky } = require$$1;
 
-	const factory = factory_1('arrayBuffer');
-
-	class MicrolinkError extends Error {
-	  constructor (props) {
-	    super();
-	    this.name = 'MicrolinkError';
-	    Object.assign(this, props);
-	    this.description = this.message;
-	    this.message = this.code
-	      ? `${this.code}, ${this.description}`
-	      : this.description;
-	  }
-	}
+		const { VERSION, USER_AGENT, RETRY_STATUS_CODES } = constants;
 
-	const got = async (url, { responseType, ...opts }) => {
-	  try {
-	    if (opts.timeout === undefined) opts.timeout = false;
-	    const response = await kyInstance(url, opts);
-	    const body = await response[responseType]();
-	    const { headers, status: statusCode } = response;
-	    return { url: response.url, body, headers, statusCode }
-	  } catch (error) {
-	    if (error.response) {
-	      const { response } = error;
-	      error.response = {
-	        ...response,
-	        headers: Array.from(response.headers.entries()).reduce(
-	          (acc, [key, value]) => {
-	            acc[key] = value;
-	            return acc
-	          },
-	          {}
-	        ),
-	        statusCode: response.status,
-	        body: await response.text()
-	      };
-	    }
-	    throw error
-	  }
-	};
+		const kyInstance = ky.extend({
+		  headers: { 'user-agent': USER_AGENT },
+		  retry: { statusCodes: RETRY_STATUS_CODES }
+		});
 
-	got.stream = (...args) => kyInstance(...args).then(res => res.body);
+		const factory = factory_1('arrayBuffer');
+
+		class MicrolinkError extends Error {
+		  constructor (props) {
+		    super();
+		    this.name = 'MicrolinkError';
+		    Object.assign(this, props);
+		    this.description = this.message;
+		    this.message = this.code
+		      ? `${this.code}, ${this.description}`
+		      : this.description;
+		  }
+		}
 
-	const mql = factory({
-	  MicrolinkError,
-	  got,
-	  flatten,
-	  VERSION
-	});
+		const got = async (url, { responseType, ...opts }) => {
+		  try {
+		    if (opts.timeout === undefined) opts.timeout = false;
+		    const response = await kyInstance(url, opts);
+		    const body = await response[responseType]();
+		    const { headers, status: statusCode } = response;
+		    return { url: response.url, body, headers, statusCode }
+		  } catch (error) {
+		    if (error.response) {
+		      const { response } = error;
+		      error.response = {
+		        ...response,
+		        headers: Array.from(response.headers.entries()).reduce(
+		          (acc, [key, value]) => {
+		            acc[key] = value;
+		            return acc
+		          },
+		          {}
+		        ),
+		        statusCode: response.status,
+		        body: await response.text()
+		      };
+		    }
+		    throw error
+		  }
+		};
+
+		got.stream = (...args) => kyInstance(...args).then(res => res.body);
+
+		const mql = factory({
+		  MicrolinkError,
+		  got,
+		  flatten,
+		  VERSION
+		});
 
-	lightweight.exports = mql;
-	var arrayBuffer = lightweight.exports.arrayBuffer = mql.extend({ responseType: 'arrayBuffer' });
-	var extend = lightweight.exports.extend = mql.extend;
-	var fetchFromApi = lightweight.exports.fetchFromApi = mql.fetchFromApi;
-	var getApiUrl = lightweight.exports.getApiUrl = mql.getApiUrl;
-	var mapRules = lightweight.exports.mapRules = mql.mapRules;
-	var MicrolinkError_1 = lightweight.exports.MicrolinkError = mql.MicrolinkError;
-	var version = lightweight.exports.version = mql.version;
-
-	var lightweightExports = lightweight.exports;
-	var lightweight_default = /*@__PURE__*/getDefaultExportFromCjs(lightweightExports);
-
-	exports.MicrolinkError = MicrolinkError_1;
-	exports.arrayBuffer = arrayBuffer;
-	exports.default = lightweight_default;
-	exports.extend = extend;
-	exports.fetchFromApi = fetchFromApi;
-	exports.getApiUrl = getApiUrl;
-	exports.mapRules = mapRules;
-	exports.version = version;
-
-	Object.defineProperty(exports, '__esModule', { value: true });
+		module.exports = mql;
+		module.exports.arrayBuffer = mql.extend({ responseType: 'arrayBuffer' });
+		module.exports.buffer = module.exports.arrayBuffer;
+		module.exports.extend = mql.extend;
+		module.exports.fetchFromApi = mql.fetchFromApi;
+		module.exports.getApiUrl = mql.getApiUrl;
+		module.exports.mapRules = mql.mapRules;
+		module.exports.MicrolinkError = mql.MicrolinkError;
+		module.exports.version = mql.version; 
+	} (src));
+
+	var srcExports = src.exports;
+	var index = /*@__PURE__*/getDefaultExportFromCjs(srcExports);
+
+	return index;
 
 }));

package/package.json

@@ -2,11 +2,11 @@
   "name": "@microlink/mql",
   "description": "Microlink Query Language. The official HTTP client to interact with Microlink API for Node.js, browsers & Deno.",
   "homepage": "https://microlink.io/mql",
-  "version": "0.14.1",
-  "types": "lightweight/index.d.ts",
+  "version": "0.15.0",
+  "types": "dist/index.d.ts",
   "exports": {
-    "require": "./src/node.js",
-    "default": "./lightweight/index.js"
+    "default": "./src/main.mjs",
+    "types": "./dist/index.d.ts"
   },
   "author": {
     "email": "josefrancisco.verdu@gmail.com",
@@ -47,8 +47,7 @@
   ],
   "dependencies": {
     "flattie": "~1.1.1",
-    "got": "~11.8.6",
-    "whoops": "~5.1.0"
+    "ky": "~1.14.3"
   },
   "devDependencies": {
     "@commitlint/cli": "latest",
@@ -59,37 +58,35 @@
     "@rollup/plugin-replace": "latest",
     "@rollup/plugin-terser": "latest",
     "async-listen": "latest",
-    "ava": "5",
+    "ava": "7",
     "c8": "latest",
     "ci-publish": "latest",
     "git-authors-cli": "latest",
     "github-generate-release": "latest",
-    "ky": "latest",
     "nano-staged": "latest",
     "prettier-standard": "latest",
     "rollup": "latest",
     "rollup-plugin-filesize": "latest",
-    "rollup-plugin-rewrite": "latest",
-    "rollup-plugin-visualizer": "latest",
     "simple-git-hooks": "latest",
     "standard": "latest",
     "standard-markdown": "latest",
     "standard-version": "latest",
-    "stream-to-promise": "latest",
     "tsd": "latest"
   },
   "engines": {
     "node": ">= 18"
   },
   "files": [
-    "lightweight",
+    "dist",
+    "src/constants.js",
     "src/factory.js",
-    "src/node.js"
+    "src/index.js",
+    "src/main.mjs"
   ],
   "scripts": {
     "build": "rollup -c rollup.config.js --bundleConfigAsCjs",
     "clean": "rm -rf node_modules",
-    "clean:build": "rm -rf lightweight/index.js",
+    "clean:build": "rm -rf dist/index.js",
     "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
     "dev": "npm run build -- -w",
     "lint": "standard && tsd",
@@ -138,12 +135,19 @@
   },
   "standard": {
     "ignore": [
-      "lightweight/index.js",
-      "lightweight/index.umd.js",
-      "src/node.mjs"
+      "dist/index.js",
+      "dist/index.umd.js"
     ]
   },
   "tsd": {
+    "compilerOptions": {
+      "baseUrl": ".",
+      "paths": {
+        "@microlink/mql": [
+          "./dist/index.d.ts"
+        ]
+      }
+    },
     "directory": "test"
   }
 }

package/src/constants.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const VERSION = require('../package.json').version
+
+module.exports = {
+  VERSION,
+  USER_AGENT: `mql/${VERSION}`,
+  /**
+   * Retry status codes, excluding 429 (too many requests).
+   */
+  RETRY_STATUS_CODES: [408, 413, 500, 502, 503, 504, 521, 522, 524]
+}

package/src/index.js

@@ -0,0 +1,71 @@
+'use strict'
+
+const { flattie: flatten } = require('flattie')
+const { default: ky } = require('ky')
+
+const { VERSION, USER_AGENT, RETRY_STATUS_CODES } = require('./constants')
+
+const kyInstance = ky.extend({
+  headers: { 'user-agent': USER_AGENT },
+  retry: { statusCodes: RETRY_STATUS_CODES }
+})
+
+const factory = require('./factory')('arrayBuffer')
+
+class MicrolinkError extends Error {
+  constructor (props) {
+    super()
+    this.name = 'MicrolinkError'
+    Object.assign(this, props)
+    this.description = this.message
+    this.message = this.code
+      ? `${this.code}, ${this.description}`
+      : this.description
+  }
+}
+
+const got = async (url, { responseType, ...opts }) => {
+  try {
+    if (opts.timeout === undefined) opts.timeout = false
+    const response = await kyInstance(url, opts)
+    const body = await response[responseType]()
+    const { headers, status: statusCode } = response
+    return { url: response.url, body, headers, statusCode }
+  } catch (error) {
+    if (error.response) {
+      const { response } = error
+      error.response = {
+        ...response,
+        headers: Array.from(response.headers.entries()).reduce(
+          (acc, [key, value]) => {
+            acc[key] = value
+            return acc
+          },
+          {}
+        ),
+        statusCode: response.status,
+        body: await response.text()
+      }
+    }
+    throw error
+  }
+}
+
+got.stream = (...args) => kyInstance(...args).then(res => res.body)
+
+const mql = factory({
+  MicrolinkError,
+  got,
+  flatten,
+  VERSION
+})
+
+module.exports = mql
+module.exports.arrayBuffer = mql.extend({ responseType: 'arrayBuffer' })
+module.exports.buffer = module.exports.arrayBuffer
+module.exports.extend = mql.extend
+module.exports.fetchFromApi = mql.fetchFromApi
+module.exports.getApiUrl = mql.getApiUrl
+module.exports.mapRules = mql.mapRules
+module.exports.MicrolinkError = mql.MicrolinkError
+module.exports.version = mql.version

package/src/main.mjs

@@ -0,0 +1,13 @@
+import mql from '../dist/index.js'
+
+export const arrayBuffer = mql.arrayBuffer
+export const buffer = mql.buffer
+export const extend = mql.extend
+export const fetchFromApi = mql.fetchFromApi
+export const getApiUrl = mql.getApiUrl
+export const mapRules = mql.mapRules
+export const MicrolinkError = mql.MicrolinkError
+export const stream = mql.stream
+export const version = mql.version
+
+export default mql

package/src/node.js

@@ -1,24 +0,0 @@
-'use strict'
-
-const got = require('got')
-
-const { VERSION, USER_AGENT, RETRY_STATUS_CODES } = require('./constants')
-
-const mql = require('./factory')('buffer')({
-  MicrolinkError: require('whoops')('MicrolinkError'),
-  got: got.extend({
-    headers: { 'user-agent': USER_AGENT },
-    retry: { statusCodes: RETRY_STATUS_CODES }
-  }),
-  flatten: require('flattie').flattie,
-  VERSION
-})
-
-module.exports = mql
-module.exports.buffer = mql.extend({ responseType: 'buffer' })
-module.exports.render = (input, { width = '650px' } = {}) => {
-  if (input && input.url && input.type) {
-    return `<img width="${width}" src="${input.url}" />`
-  }
-  return input
-}