@microlink/function 0.1.6 → 0.2.2

package/lightweight/index.d.ts

@@ -0,0 +1,33 @@
+import { MqlOptions } from '@microlink/mql'
+import { Page, HTTPResponse } from 'puppeteer-core'
+
+export type FunctionResponse = {
+  isFulfilled: true,
+  isRejected: false,
+  value: any
+}
+
+export type FunctionArgs = {
+  page: object;
+  response: object;
+  url: string;
+}
+
+export type FunctionInput = (args: {
+  page: Page;
+  response: HTTPResponse;
+  [key: string]: any;
+}) => any;
+
+
+declare function microlinkFunction(
+  fn: FunctionInput,
+  mqlOpts?: MqlOptions,
+  gotOpts?: object
+): (
+  url: string,
+  mqlOpts?: MqlOptions,
+  gotOpts?: object
+) => Promise<FunctionResponse>;
+
+export default microlinkFunction;

package/lightweight/index.js

@@ -0,0 +1 @@
+var t={exports:{}};const e=/^https?:\/\//i;var r={};function s(t,e,r,o,n){var i,a=n?n+r:n;if(null==o)e&&(t[n]=o);else if("object"!=typeof o)t[n]=o;else if(Array.isArray(o))for(i=0;i<o.length;i++)s(t,e,r,o[i],a+i);else for(i in o)s(t,e,r,o[i],a+i)}r.flattie=function(t,e,r){var o={};return"object"==typeof t&&s(o,!!r,e||".",t,""),o};const o={FREE:"https://api.microlink.io/",PRO:"https://pro.microlink.io/"},n=t=>null!==t&&"object"==typeof t;class i extends Error{constructor(t,e,r){const s=`${t.status||0===t.status?t.status:""} ${t.statusText||""}`.trim();super("Request failed with "+(s?`status code ${s}`:"an unknown error")),Object.defineProperty(this,"response",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"request",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this.name="HTTPError",this.response=t,this.request=e,this.options=r}}class a extends Error{constructor(t){super("Request timed out"),Object.defineProperty(this,"request",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this.name="TimeoutError",this.request=t}}const u=t=>null!==t&&"object"==typeof t,c=(...t)=>{for(const e of t)if((!u(e)||Array.isArray(e))&&void 0!==e)throw new TypeError("The `options` argument must be an object");return h({},...t)},l=(t={},e={})=>{const r=new globalThis.Headers(t),s=e instanceof globalThis.Headers,o=new globalThis.Headers(e);for(const[t,e]of o.entries())s&&"undefined"===e||void 0===e?r.delete(t):r.set(t,e);return r},h=(...t)=>{let e={},r={};for(const s of t)if(Array.isArray(s))Array.isArray(e)||(e=[]),e=[...e,...s];else if(u(s)){for(let[t,r]of Object.entries(s))u(r)&&t in e&&(r=h(e[t],r)),e={...e,[t]:r};u(s.headers)&&(r=l(r,s.headers),e.headers=r)}return e},p=(()=>{let t=!1,e=!1;const r="function"==typeof globalThis.ReadableStream,s="function"==typeof globalThis.Request;return r&&s&&(e=new globalThis.Request("https://empty.invalid",{body:new globalThis.ReadableStream,method:"POST",get duplex(){return t=!0,"half"}}).headers.has("Content-Type")),t&&!e})(),f="function"==typeof globalThis.AbortController,d="function"==typeof globalThis.ReadableStream,y="function"==typeof globalThis.FormData,b=["get","post","put","patch","head","delete"],m={json:"application/json",text:"text/*",formData:"multipart/form-data",arrayBuffer:"*/*",blob:"*/*"},_=2147483647,w=Symbol("stop"),g={json:!0,parseJson:!0,searchParams:!0,prefixUrl:!0,retry:!0,timeout:!0,hooks:!0,throwHttpErrors:!0,onDownloadProgress:!0,fetch:!0},T={method:!0,headers:!0,body:!0,mode:!0,credentials:!0,cache:!0,redirect:!0,referrer:!0,referrerPolicy:!0,integrity:!0,keepalive:!0,signal:!0,window:!0,dispatcher:!0,duplex:!0},R=t=>b.includes(t)?t.toUpperCase():t,v=[413,429,503],E={limit:2,methods:["get","put","head","delete","options","trace"],statusCodes:[408,413,429,500,502,503,504],afterStatusCodes:v,maxRetryAfter:Number.POSITIVE_INFINITY,backoffLimit:Number.POSITIVE_INFINITY,delay:t=>.3*2**(t-1)*1e3},q=(t={})=>{if("number"==typeof t)return{...E,limit:t};if(t.methods&&!Array.isArray(t.methods))throw new Error("retry.methods must be an array");if(t.statusCodes&&!Array.isArray(t.statusCodes))throw new Error("retry.statusCodes must be an array");return{...E,...t,afterStatusCodes:v}};class x{static create(t,e){const r=new x(t,e),s=async()=>{if("number"==typeof r._options.timeout&&r._options.timeout>_)throw new RangeError("The `timeout` option cannot be greater than 2147483647");await Promise.resolve();let t=await r._fetch();for(const e of r._options.hooks.afterResponse){const s=await e(r.request,r._options,r._decorateResponse(t.clone()));s instanceof globalThis.Response&&(t=s)}if(r._decorateResponse(t),!t.ok&&r._options.throwHttpErrors){let e=new i(t,r.request,r._options);for(const t of r._options.hooks.beforeError)e=await t(e);throw e}if(r._options.onDownloadProgress){if("function"!=typeof r._options.onDownloadProgress)throw new TypeError("The `onDownloadProgress` option must be a function");if(!d)throw new Error("Streams are not supported in your environment. `ReadableStream` is missing.");return r._stream(t.clone(),r._options.onDownloadProgress)}return t},o=r._options.retry.methods.includes(r.request.method.toLowerCase())?r._retry(s):s();for(const[t,s]of Object.entries(m))o[t]=async()=>{r.request.headers.set("accept",r.request.headers.get("accept")||s);const n=(await o).clone();if("json"===t){if(204===n.status)return"";if(0===(await n.clone().arrayBuffer()).byteLength)return"";if(e.parseJson)return e.parseJson(await n.text())}return n[t]()};return o}constructor(t,e={}){if(Object.defineProperty(this,"request",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"abortController",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_retryCount",{enumerable:!0,configurable:!0,writable:!0,value:0}),Object.defineProperty(this,"_input",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_options",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this._input=t,this._options={credentials:this._input.credentials||"same-origin",...e,headers:l(this._input.headers,e.headers),hooks:h({beforeRequest:[],beforeRetry:[],beforeError:[],afterResponse:[]},e.hooks),method:R(e.method??this._input.method),prefixUrl:String(e.prefixUrl||""),retry:q(e.retry),throwHttpErrors:!1!==e.throwHttpErrors,timeout:e.timeout??1e4,fetch:e.fetch??globalThis.fetch.bind(globalThis)},"string"!=typeof this._input&&!(this._input instanceof URL||this._input instanceof globalThis.Request))throw new TypeError("`input` must be a string, URL, or Request");if(this._options.prefixUrl&&"string"==typeof this._input){if(this._input.startsWith("/"))throw new Error("`input` must not begin with a slash when using `prefixUrl`");this._options.prefixUrl.endsWith("/")||(this._options.prefixUrl+="/"),this._input=this._options.prefixUrl+this._input}if(f){if(this.abortController=new globalThis.AbortController,this._options.signal){const t=this._options.signal;this._options.signal.addEventListener("abort",(()=>{this.abortController.abort(t.reason)}))}this._options.signal=this.abortController.signal}if(p&&(this._options.duplex="half"),this.request=new globalThis.Request(this._input,this._options),this._options.searchParams){const t="?"+("string"==typeof this._options.searchParams?this._options.searchParams.replace(/^\?/,""):new URLSearchParams(this._options.searchParams).toString()),e=this.request.url.replace(/(?:\?.*?)?(?=#|$)/,t);!(y&&this._options.body instanceof globalThis.FormData||this._options.body instanceof URLSearchParams)||this._options.headers&&this._options.headers["content-type"]||this.request.headers.delete("content-type"),this.request=new globalThis.Request(new globalThis.Request(e,{...this.request}),this._options)}void 0!==this._options.json&&(this._options.body=JSON.stringify(this._options.json),this.request.headers.set("content-type",this._options.headers.get("content-type")??"application/json"),this.request=new globalThis.Request(this.request,{body:this._options.body}))}_calculateRetryDelay(t){if(this._retryCount++,this._retryCount<this._options.retry.limit&&!(t instanceof a)){if(t instanceof i){if(!this._options.retry.statusCodes.includes(t.response.status))return 0;const e=t.response.headers.get("Retry-After");if(e&&this._options.retry.afterStatusCodes.includes(t.response.status)){let t=Number(e);return Number.isNaN(t)?t=Date.parse(e)-Date.now():t*=1e3,void 0!==this._options.retry.maxRetryAfter&&t>this._options.retry.maxRetryAfter?0:t}if(413===t.response.status)return 0}const e=this._options.retry.delay(this._retryCount);return Math.min(this._options.retry.backoffLimit,e)}return 0}_decorateResponse(t){return this._options.parseJson&&(t.json=async()=>this._options.parseJson(await t.text())),t}async _retry(t){try{return await t()}catch(e){const r=Math.min(this._calculateRetryDelay(e),_);if(0!==r&&this._retryCount>0){await async function(t,{signal:e}){return new Promise(((r,s)=>{function o(){clearTimeout(n),s(e.reason)}e&&(e.throwIfAborted(),e.addEventListener("abort",o,{once:!0}));const n=setTimeout((()=>{e?.removeEventListener("abort",o),r()}),t)}))}(r,{signal:this._options.signal});for(const t of this._options.hooks.beforeRetry)if(await t({request:this.request,options:this._options,error:e,retryCount:this._retryCount})===w)return;return this._retry(t)}throw e}}async _fetch(){for(const t of this._options.hooks.beforeRequest){const e=await t(this.request,this._options);if(e instanceof Request){this.request=e;break}if(e instanceof Response)return e}const t=((t,e)=>{const r={};for(const s in e)s in T||s in g||s in t||(r[s]=e[s]);return r})(this.request,this._options);return!1===this._options.timeout?this._options.fetch(this.request.clone(),t):async function(t,e,r,s){return new Promise(((o,n)=>{const i=setTimeout((()=>{r&&r.abort(),n(new a(t))}),s.timeout);s.fetch(t,e).then(o).catch(n).then((()=>{clearTimeout(i)}))}))}(this.request.clone(),t,this.abortController,this._options)}_stream(t,e){const r=Number(t.headers.get("content-length"))||0;let s=0;return 204===t.status?(e&&e({percent:1,totalBytes:r,transferredBytes:s},new Uint8Array),new globalThis.Response(null,{status:t.status,statusText:t.statusText,headers:t.headers})):new globalThis.Response(new globalThis.ReadableStream({async start(o){const n=t.body.getReader();e&&e({percent:0,transferredBytes:0,totalBytes:r},new Uint8Array),await async function t(){const{done:i,value:a}=await n.read();i?o.close():(e&&(s+=a.byteLength,e({percent:0===r?0:s/r,transferredBytes:s,totalBytes:r},a)),o.enqueue(a),await t())}()}}),{status:t.status,statusText:t.statusText,headers:t.headers})}}const P=t=>{const e=(e,r)=>x.create(e,c(t,r));for(const r of b)e[r]=(e,s)=>x.create(e,c(t,s,{method:r}));return e.create=t=>P(c(t)),e.extend=e=>P(c(t,e)),e.stop=w,e},j=P();var C=function(t){if(t.__esModule)return t;var e=t.default;if("function"==typeof e){var r=function t(){return this instanceof t?Reflect.construct(e,arguments,this.constructor):e.apply(this,arguments)};r.prototype=e.prototype}else r={};return Object.defineProperty(r,"__esModule",{value:!0}),Object.keys(t).forEach((function(e){var s=Object.getOwnPropertyDescriptor(t,e);Object.defineProperty(r,e,s.get?s:{enumerable:!0,get:function(){return t[e]}})})),r}(Object.freeze({__proto__:null,HTTPError:i,TimeoutError:a,default:j}));const{flattie:O}=r,A=({VERSION:t,MicrolinkError:e,urlHttp:r,got:s,flatten:i})=>{const a=t=>{if(!n(t))return;const e=i(t);return Object.keys(e).reduce(((t,r)=>(t[`data.${r}`]=e[r].toString(),t)),{})},u=async(t,r={})=>{try{const e=await s(t,r);return"buffer"===r.responseType?{body:e.body,response:e}:{...e.body,response:e}}catch(r){const{response:s={}}=r,{statusCode:i,body:a,headers:u={},url:c=t}=s,l=null!=(o=a)&&null!=o.constructor&&"function"==typeof o.constructor.isBuffer&&o.constructor.isBuffer(o),h=n(a)&&!l?a:((t,e,r)=>{try{return JSON.parse(t)}catch(s){const o=t||e.message;return{status:"error",data:{url:o},more:"https://microlink.io/efatalclient",code:"EFATALCLIENT",message:o,url:r}}})(l?a.toString():a,r,c);throw new e({...h,message:h.message,url:c,statusCode:i,headers:u})}var o},c=(t,{data:e,apiKey:r,endpoint:s,retry:n,cache:u,...c}={},{responseType:l="json",headers:h,...p}={})=>{const f=!!r;return[`${s||o[f?"PRO":"FREE"]}?${new URLSearchParams({url:t,...a(e),...i(c)}).toString()}`,{...p,responseType:l,cache:u,retry:n,headers:f?{...h,"x-api-key":r}:{...h}}]},l=t=>async(s,o,n)=>{((t="")=>{if(!r(t)){const r=`The \`url\` as \`${t}\` is not valid. Ensure it has protocol (http or https) and hostname.`;throw new e({status:"fail",data:{url:r},more:"https://microlink.io/docs/api/api-parameters/url",code:"EINVALURLCLIENT",message:r,url:t})}})(s);const[i,a]=c(s,o,{...t,...n});return u(i,a)},h=l();return h.MicrolinkError=e,h.getApiUrl=c,h.fetchFromApi=u,h.mapRules=a,h.version=t,h.stream=s.stream,h.buffer=l({responseType:"buffer"}),h},{default:k}=C;class S extends Error{constructor(t){super(),this.name="MicrolinkError",Object.assign(this,t),this.description=this.message,this.message=this.code?`${this.code}, ${this.description}`:this.description}}const U=A({MicrolinkError:S,urlHttp:t=>{try{const{href:r}=new URL(t);return e.test(r)&&r}catch(t){return!1}},got:async(t,e)=>{try{e.retry>0&&(e.retry=e.retry+1),void 0===e.timeout&&(e.timeout=!1);const r=await k(t,e),s=await r.json(),{headers:o,status:n}=r;return{url:r.url,body:s,headers:o,statusCode:n}}catch(t){if(t.response){const{response:e}=t;t.response={...e,headers:Array.from(e.headers.entries()).reduce(((t,[e,r])=>(t[e]=r,t)),{}),statusCode:e.status,body:await e.text()}}throw t}},flatten:O,VERSION:"0.11.7"});t.exports=U,t.exports.MicrolinkError=U.MicrolinkError,t.exports.getApiUrl=U.getApiUrl,t.exports.mapRules=U.mapRules,t.exports.version=U.version;var L=function(t){return t&&t.__esModule&&Object.prototype.hasOwnProperty.call(t,"default")?t.default:t}(t.exports);const N=(t,e,r)=>async(s,o)=>{const{data:n}=await L(s,{function:t.toString(),meta:!1,...e,...o},r);return n.function};N.mql=L,N.render=L.render,N.version="0.2.2";export{N as default};

package/lightweight/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "types": "index-bundled.d.ts"
+}

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@microlink/function",
-  "homepage": "https://github.com/microlinkhq/function#readme",
-  "version": "0.1.6",
-  "main": "src/node.js",
-  "browser": "src/browser.js",
+  "description": "Browser functions as Service. Interacting with browser pages, remotely.",
+  "homepage": "https://function.microlink.io",
+  "version": "0.2.2",
+  "types": "lightweight/index.d.ts",
+  "exports": {
+    "require": "./src/node.js",
+    "default": "./lightweight/index.js"
+  },
   "author": {
-    "name": "Kiko Beats",
     "email": "josefrancisco.verdu@gmail.com",
-    "url": "https://kikobeats.com"
+    "name": "Kiko Beats",
+    "url": "https://github.com/Kikobeats"
   },
   "repository": {
     "type": "git",
@@ -27,48 +31,105 @@
     "serverless"
   ],
   "dependencies": {
-    "@microlink/mql": "~0.10.0",
+    "@microlink/mql": "~0.11.8",
     "base64-url": "~2.3.3"
   },
   "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",
-    "abort-controller": "latest",
+    "@rollup/plugin-terser": "latest",
+    "async-listen": "latest",
     "ava": "latest",
+    "c8": "latest",
+    "ci-publish": "latest",
     "conventional-github-releaser": "latest",
-    "node-fetch": "2",
+    "execa": "latest",
+    "git-authors-cli": "latest",
+    "nano-staged": "latest",
     "npm-check-updates": "latest",
-    "nyc": "latest",
+    "prettier-standard": "latest",
+    "puppeteer-core": "latest",
     "rollup": "latest",
     "rollup-plugin-filesize": "latest",
-    "rollup-plugin-shim": "latest",
-    "rollup-plugin-terser": "latest",
-    "rollup-plugin-visualizer": "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",
+    "tsup": "latest"
   },
   "engines": {
-    "node": ">= 12"
+    "node": ">= 18"
   },
   "files": [
-    "dist",
-    "src"
+    "lightweight",
+    "src/factory.js",
+    "src/node.js"
   ],
   "scripts": {
-    "build": "rollup -c rollup.config.js",
-    "postversion": "pnpm run build",
+    "build": "npm run build:rollup && npm run build:tsup",
+    "build:rollup": "rollup -c rollup.config.js --bundleConfigAsCjs",
+    "build:tsup": "npx tsup --entry.index-bundled lightweight/index.d.ts --dts-only --dts-resolve --out-dir lightweight/",
+    "clean": "rm -rf node_modules",
+    "clean:build": "rm -rf lightweight/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",
-    "test": "nyc ava --verbose"
+    "lint": "standard && tsd",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
+    "prebuild": "npm run clean:build",
+    "prepublishOnly": "npm run build",
+    "prerelease": "npm run update:check",
+    "pretest": "npm run lint && npm run build",
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 ava --verbose",
+    "update": "ncu -u",
+    "update:check": "ncu -- --error-level 2"
   },
   "license": "MIT",
   "ava": {
     "files": [
       "test/**/*",
-      "!test/browser-globals.js",
-      "!test/clients.js"
+      "!test/clients.mjs"
     ],
     "timeout": "1m"
   },
-  "umd:main": "dist/microlink-function.js",
-  "unpkg": "dist/microlink-function.js",
-  "gitHead": "09d3b07a27a4fccbd26a823bfacc25bb1df46c05"
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "nano-staged": {
+    "*.js": [
+      "prettier-standard",
+      "standard --fix"
+    ],
+    "*.md": [
+      "standard-markdown"
+    ],
+    "package.json": [
+      "finepack"
+    ]
+  },
+  "simple-git-hooks": {
+    "commit-msg": "npx commitlint --edit",
+    "pre-commit": "npx nano-staged"
+  },
+  "standard": {
+    "ignore": [
+      "lightweight/index.js",
+      "src/node.mjs"
+    ]
+  },
+  "tsd": {
+    "directory": "test"
+  }
 }

package/src/node.js

@@ -12,8 +12,27 @@ const toCompress = code =>
     data => `br#${escape(data.toString('base64'))}`
   )
 
-module.exports = require('./factory')({
-  mql,
-  toCompress,
-  VERSION: require('../package.json').version
-})
+const fn = (code, mqlOpts, gotOpts) => {
+  const compress = toCompress(code)
+
+  return async (url, opts) => {
+    const { data } = await mql(
+      url,
+      {
+        function: await compress,
+        meta: false,
+        ...mqlOpts,
+        ...opts
+      },
+      gotOpts
+    )
+
+    return data.function
+  }
+}
+
+fn.mql = mql
+fn.render = mql.render
+fn.version = require('../package.json').version
+
+module.exports = fn