@openfn/language-browserless 1.0.0

package/configuration-schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "baseUrl": {
+      "title": "Base URL",
+      "type":["string", "null"],
+      "description": "The Browserless base URL (e.g. https://production-sfo.browserless.io)",
+      "format": "uri",
+      "minLength": 1,
+      "examples": ["https://production-sfo.browserless.io"]
+    },
+    "token":{
+      "title": "API Token",
+      "type":"string",
+      "description": "Browserless API token",
+      "writeOnly": true,
+      "minLength": 1,
+      "examples": ["your-browserless-token"]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["baseUrl", "token"]
+}

package/dist/index.cjs

@@ -0,0 +1,188 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  as: () => import_language_common2.as,
+  combine: () => import_language_common2.combine,
+  createPDF: () => createPDF,
+  cursor: () => import_language_common2.cursor,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  default: () => src_default,
+  each: () => import_language_common2.each,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  fnIf: () => import_language_common2.fnIf,
+  group: () => import_language_common2.group,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  map: () => import_language_common2.map,
+  merge: () => import_language_common2.merge,
+  request: () => request2,
+  scrubEmojis: () => import_language_common2.scrubEmojis,
+  source: () => import_language_common2.source,
+  sourceValue: () => import_language_common2.sourceValue,
+  util: () => import_language_common2.util
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  as: () => import_language_common2.as,
+  combine: () => import_language_common2.combine,
+  createPDF: () => createPDF,
+  cursor: () => import_language_common2.cursor,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  each: () => import_language_common2.each,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  fnIf: () => import_language_common2.fnIf,
+  group: () => import_language_common2.group,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  map: () => import_language_common2.map,
+  merge: () => import_language_common2.merge,
+  request: () => request2,
+  scrubEmojis: () => import_language_common2.scrubEmojis,
+  source: () => import_language_common2.source,
+  sourceValue: () => import_language_common2.sourceValue,
+  util: () => import_language_common2.util
+});
+var import_util3 = require("@openfn/language-common/util");
+
+// src/Utils.js
+var import_language_common = require("@openfn/language-common");
+var import_util = require("@openfn/language-common/util");
+var request = async (configuration = {}, method, path, options) => {
+  var _a;
+  const { baseUrl = "https://production-sfo.browserless.io", token } = configuration;
+  const opts = {
+    parseAs: "json",
+    errors: { 404: "Page not found" },
+    ...options,
+    headers: {
+      "content-type": "application/json",
+      ...(options == null ? void 0 : options.headers) || {}
+    },
+    query: { ...(options == null ? void 0 : options.query) || {}, ...token ? { token } : {} }
+  };
+  const url = new URL(path, baseUrl).toString();
+  let response = await (0, import_util.request)(method, url, opts);
+  try {
+    const contentType = ((_a = response == null ? void 0 : response.headers) == null ? void 0 : _a["content-type"]) || "";
+    const isPDF = /application\/(pdf|octet-stream)/i.test(contentType);
+    if (isPDF && response.body) {
+      let buf;
+      if (typeof response.body === "string")
+        buf = Buffer.from(response.body, "binary");
+      else if (Buffer.isBuffer(response.body))
+        buf = response.body;
+      else if (response.body instanceof ArrayBuffer)
+        buf = Buffer.from(response.body);
+      else if (ArrayBuffer.isView(response.body))
+        buf = Buffer.from(response.body.buffer);
+      if (buf) {
+        response.body = buf.toString("base64");
+      }
+    } else if (response.body && Buffer.isBuffer(response.body)) {
+      if (/application\/json/i.test(contentType) || opts.parseAs === "json") {
+        try {
+          response.body = JSON.parse(response.body.toString("utf8"));
+        } catch {
+        }
+      }
+    }
+  } catch {
+  }
+  return response;
+};
+
+// src/http.js
+var import_util2 = require("@openfn/language-common/util");
+function request2(method, url, options) {
+  return async (state) => {
+    const [resolvedMethod, resolvedUrl, resolvedOptions] = (0, import_util2.expandReferences)(
+      state,
+      method,
+      url,
+      options
+    );
+    const response = await request(state.configuration, resolvedMethod, resolvedUrl, resolvedOptions);
+    const { body, ...responseWithoutBody } = response;
+    return {
+      ...state,
+      response: responseWithoutBody,
+      data: body
+    };
+  };
+}
+
+// src/Adaptor.js
+var import_language_common2 = require("@openfn/language-common");
+function createPDF(input, options) {
+  return async (state) => {
+    var _a;
+    const maybeBody = typeof input === "string" ? input.startsWith("http") ? { url: input } : { html: input } : input || {};
+    const [resolvedInput, resolvedOptions] = (0, import_util3.expandReferences)(state, maybeBody, options);
+    const response = await request(
+      state.configuration,
+      "POST",
+      "pdf",
+      { body: resolvedInput, ...resolvedOptions || {}, parseAs: "buffer" }
+    );
+    const pdfData = ((_a = response.body) == null ? void 0 : _a.pdf) ?? response.body;
+    return {
+      ...state,
+      data: pdfData,
+      response: { ...response, body: void 0 }
+    };
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  as,
+  combine,
+  createPDF,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  request,
+  scrubEmojis,
+  source,
+  sourceValue,
+  util
+});

package/dist/index.js

@@ -0,0 +1,168 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  as: () => as,
+  combine: () => combine,
+  createPDF: () => createPDF,
+  cursor: () => cursor,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  dateFns: () => dateFns,
+  each: () => each,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  fnIf: () => fnIf,
+  group: () => group,
+  lastReferenceValue: () => lastReferenceValue,
+  map: () => map,
+  merge: () => merge,
+  request: () => request2,
+  scrubEmojis: () => scrubEmojis,
+  source: () => source,
+  sourceValue: () => sourceValue,
+  util: () => util
+});
+import { expandReferences as expandReferences2 } from "@openfn/language-common/util";
+
+// src/Utils.js
+import { composeNextState } from "@openfn/language-common";
+import { request as commonRequest } from "@openfn/language-common/util";
+var request = async (configuration = {}, method, path, options) => {
+  var _a;
+  const { baseUrl = "https://production-sfo.browserless.io", token } = configuration;
+  const opts = {
+    parseAs: "json",
+    errors: { 404: "Page not found" },
+    ...options,
+    headers: {
+      "content-type": "application/json",
+      ...(options == null ? void 0 : options.headers) || {}
+    },
+    query: { ...(options == null ? void 0 : options.query) || {}, ...token ? { token } : {} }
+  };
+  const url = new URL(path, baseUrl).toString();
+  let response = await commonRequest(method, url, opts);
+  try {
+    const contentType = ((_a = response == null ? void 0 : response.headers) == null ? void 0 : _a["content-type"]) || "";
+    const isPDF = /application\/(pdf|octet-stream)/i.test(contentType);
+    if (isPDF && response.body) {
+      let buf;
+      if (typeof response.body === "string")
+        buf = Buffer.from(response.body, "binary");
+      else if (Buffer.isBuffer(response.body))
+        buf = response.body;
+      else if (response.body instanceof ArrayBuffer)
+        buf = Buffer.from(response.body);
+      else if (ArrayBuffer.isView(response.body))
+        buf = Buffer.from(response.body.buffer);
+      if (buf) {
+        response.body = buf.toString("base64");
+      }
+    } else if (response.body && Buffer.isBuffer(response.body)) {
+      if (/application\/json/i.test(contentType) || opts.parseAs === "json") {
+        try {
+          response.body = JSON.parse(response.body.toString("utf8"));
+        } catch {
+        }
+      }
+    }
+  } catch {
+  }
+  return response;
+};
+
+// src/http.js
+import { expandReferences } from "@openfn/language-common/util";
+function request2(method, url, options) {
+  return async (state) => {
+    const [resolvedMethod, resolvedUrl, resolvedOptions] = expandReferences(
+      state,
+      method,
+      url,
+      options
+    );
+    const response = await request(state.configuration, resolvedMethod, resolvedUrl, resolvedOptions);
+    const { body, ...responseWithoutBody } = response;
+    return {
+      ...state,
+      response: responseWithoutBody,
+      data: body
+    };
+  };
+}
+
+// src/Adaptor.js
+import {
+  as,
+  combine,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  scrubEmojis,
+  source,
+  sourceValue,
+  util
+} from "@openfn/language-common";
+function createPDF(input, options) {
+  return async (state) => {
+    var _a;
+    const maybeBody = typeof input === "string" ? input.startsWith("http") ? { url: input } : { html: input } : input || {};
+    const [resolvedInput, resolvedOptions] = expandReferences2(state, maybeBody, options);
+    const response = await request(
+      state.configuration,
+      "POST",
+      "pdf",
+      { body: resolvedInput, ...resolvedOptions || {}, parseAs: "buffer" }
+    );
+    const pdfData = ((_a = response.body) == null ? void 0 : _a.pdf) ?? response.body;
+    return {
+      ...state,
+      data: pdfData,
+      response: { ...response, body: void 0 }
+    };
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  as,
+  combine,
+  createPDF,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  src_default as default,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  request2 as request,
+  scrubEmojis,
+  source,
+  sourceValue,
+  util
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@openfn/language-browserless",
+  "version": "1.0.0",
+  "description": "OpenFn browserless adaptor",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "author": "Open Function Group",
+  "license": "LGPLv3",
+  "files": [
+    "dist/",
+    "types/",
+    "ast.json",
+    "configuration-schema.json"
+  ],
+  "dependencies": {
+    "@openfn/language-common": "3.2.2"
+  },
+  "devDependencies": {
+    "assertion-error": "2.0.0",
+    "chai": "4.3.6",
+    "deep-eql": "4.1.1",
+    "mocha": "^10.7.3",
+    "rimraf": "3.0.2",
+    "undici": "^5.22.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfn/adaptors.git"
+  },
+  "types": "types/index.d.ts",
+  "main": "dist/index.cjs",
+  "scripts": {
+    "build": "pnpm clean && build-adaptor browserless",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "clean": "rimraf dist types docs",
+    "pack": "pnpm pack --pack-destination ../../dist",
+    "lint": "eslint src"
+  }
+}

package/types/Adaptor.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Create a PDF from HTML or URL.
+ * @public
+ * @param {string} input - HTML string or URL string
+ * @param {object} options - Optional request options
+ * @returns {Operation} Returns state with base64 string directly
+ */
+export function createPDF(input: string, options: object): Operation;
+export { request } from "./http.js";
+export { as, combine, cursor, dataPath, dataValue, dateFns, each, field, fields, fn, fnIf, group, lastReferenceValue, map, merge, scrubEmojis, source, sourceValue, util } from "@openfn/language-common";

package/types/Utils.d.ts

@@ -0,0 +1,2 @@
+export function prepareNextState(state: object, response: object): object;
+export function request(configuration: object, method: string, path: string, options: object): Promise<object>;

package/types/http.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Make a Browserless-authenticated HTTP request operation.
+ * This operation always sends requests to the configured Browserless 'baseUrl'.
+ * @public
+ * @function
+ * @param {string} method - HTTP method (e.g. 'GET', 'POST').
+ * @param {string} path - API Path (e.g. 'pdf, 'content) joined to the configured 'baseUrl'.
+ * @param {object} options - Request options (body, headers, query, parseAs).
+ * @state {HttpState}
+ * @returns {Operation} an OpenFn operation returning a state with `data` and `response`.
+ */
+export function request(method: string, url: any, options: object): Operation;

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export default Adaptor;
+export * from "./Adaptor";
+import * as Adaptor from "./Adaptor";