@openfn/language-mojatax 1.0.0

package/configuration-schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "baseUrl": {
+      "title": "Base URL",
+      "type": "string",
+      "description": "Mojatax base URL",
+      "format": "uri",
+      "minLength": 1,
+      "examples": [
+        "https://vfd-staging.mojatax.com"
+      ]
+    },
+    "clientId": {
+      "title": "Client Id",
+      "type": "string",
+      "description": "Your Mojatax client id",
+      "examples": [
+        "the-long-uuid-provided-by-mojatax"
+      ]
+    },
+    "password": {
+      "title": "Password",
+      "type": "string",
+      "description": "Your Mojatax password",
+      "writeOnly": true,
+      "examples": [
+        "@some(!)Str0ngp4ss0w0rd"
+      ]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "baseUrl",
+    "password",
+    "clientId"
+  ]
+}

package/dist/index.cjs

@@ -0,0 +1,191 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  cursor: () => import_language_common3.cursor,
+  dataPath: () => import_language_common3.dataPath,
+  dataValue: () => import_language_common3.dataValue,
+  dateFns: () => import_language_common3.dateFns,
+  default: () => src_default,
+  each: () => import_language_common3.each,
+  execute: () => execute,
+  field: () => import_language_common3.field,
+  fields: () => import_language_common3.fields,
+  fn: () => import_language_common3.fn,
+  lastReferenceValue: () => import_language_common3.lastReferenceValue,
+  merge: () => import_language_common3.merge,
+  post: () => post,
+  request: () => request2,
+  sourceValue: () => import_language_common3.sourceValue
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  cursor: () => import_language_common3.cursor,
+  dataPath: () => import_language_common3.dataPath,
+  dataValue: () => import_language_common3.dataValue,
+  dateFns: () => import_language_common3.dateFns,
+  each: () => import_language_common3.each,
+  execute: () => execute,
+  field: () => import_language_common3.field,
+  fields: () => import_language_common3.fields,
+  fn: () => import_language_common3.fn,
+  lastReferenceValue: () => import_language_common3.lastReferenceValue,
+  merge: () => import_language_common3.merge,
+  post: () => post,
+  request: () => request2,
+  sourceValue: () => import_language_common3.sourceValue
+});
+var import_util2 = 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 import_node_path = __toESM(require("path"), 1);
+var authorize = (state) => {
+  const auth = state.configuration ?? {};
+  if (auth.access_token) {
+    return state;
+  }
+  const { clientId: client_id, password } = auth;
+  const headers = {};
+  if (client_id && password) {
+    Object.assign(headers, {
+      "Content-Type": "application/json"
+    });
+    const body = {
+      client_id,
+      password
+    };
+    const options = {
+      body,
+      headers,
+      method: "POST",
+      parseAs: "json",
+      baseUrl: auth.baseUrl
+    };
+    return (0, import_util.request)("POST", "/api/v1/auth/clientLogin", options).then(
+      (response) => {
+        return {
+          ...state,
+          configuration: {
+            ...state.configuration,
+            access_token: response.body.access_token
+          }
+        };
+      }
+    );
+  } else {
+    throw new Error(
+      "Invalid authorization credentials. Include clientId and password in state.configuration"
+    );
+  }
+};
+var prepareNextState = (state, response, callback = (s) => s) => {
+  const { body, ...responseWithoutBody } = response;
+  const nextState = {
+    ...(0, import_language_common.composeNextState)(state, response.body),
+    response: responseWithoutBody
+  };
+  return callback(nextState);
+};
+var request = (configuration, method, path, options) => {
+  const { baseUrl, access_token } = configuration ?? {};
+  const { data, params = {} } = options;
+  const headers = {
+    Authorization: `Bearer ${access_token}`,
+    "content-type": "application/json"
+  };
+  (0, import_util.assertRelativeUrl)(path);
+  const opts = {
+    parseAs: "json",
+    body: data,
+    query: params,
+    baseUrl,
+    headers
+  };
+  const safePath = import_node_path.default.join("/api/v1", path);
+  return (0, import_util.request)(method, safePath, opts).then(import_util.logResponse);
+};
+
+// src/Adaptor.js
+var import_language_common2 = require("@openfn/language-common");
+var import_language_common3 = require("@openfn/language-common");
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return (0, import_language_common2.execute)(
+      authorize,
+      ...operations
+    )({
+      ...initialState,
+      ...state
+    });
+  };
+}
+function post(path, data, options, callback) {
+  return request2("POST", `/client/${path}`, data, options, callback);
+}
+function request2(method, path, body, options = {}, callback = (s) => s) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedData, resolvedoptions] = (0, import_util2.expandReferences)(state, method, path, body, options);
+    const response = await request(
+      state.configuration,
+      resolvedMethod,
+      resolvedPath,
+      {
+        data: resolvedData,
+        ...resolvedoptions
+      }
+    );
+    return prepareNextState(state, response, callback);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  execute,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  post,
+  request,
+  sourceValue
+});

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, {
+  cursor: () => cursor,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  dateFns: () => dateFns,
+  each: () => each,
+  execute: () => execute,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  lastReferenceValue: () => lastReferenceValue,
+  merge: () => merge,
+  post: () => post,
+  request: () => request2,
+  sourceValue: () => sourceValue
+});
+import { expandReferences } from "@openfn/language-common/util";
+
+// src/Utils.js
+import { composeNextState } from "@openfn/language-common";
+import {
+  request as commonRequest,
+  assertRelativeUrl,
+  logResponse
+} from "@openfn/language-common/util";
+import nodepath from "path";
+var authorize = (state) => {
+  const auth = state.configuration ?? {};
+  if (auth.access_token) {
+    return state;
+  }
+  const { clientId: client_id, password } = auth;
+  const headers = {};
+  if (client_id && password) {
+    Object.assign(headers, {
+      "Content-Type": "application/json"
+    });
+    const body = {
+      client_id,
+      password
+    };
+    const options = {
+      body,
+      headers,
+      method: "POST",
+      parseAs: "json",
+      baseUrl: auth.baseUrl
+    };
+    return commonRequest("POST", "/api/v1/auth/clientLogin", options).then(
+      (response) => {
+        return {
+          ...state,
+          configuration: {
+            ...state.configuration,
+            access_token: response.body.access_token
+          }
+        };
+      }
+    );
+  } else {
+    throw new Error(
+      "Invalid authorization credentials. Include clientId and password in state.configuration"
+    );
+  }
+};
+var prepareNextState = (state, response, callback = (s) => s) => {
+  const { body, ...responseWithoutBody } = response;
+  const nextState = {
+    ...composeNextState(state, response.body),
+    response: responseWithoutBody
+  };
+  return callback(nextState);
+};
+var request = (configuration, method, path, options) => {
+  const { baseUrl, access_token } = configuration ?? {};
+  const { data, params = {} } = options;
+  const headers = {
+    Authorization: `Bearer ${access_token}`,
+    "content-type": "application/json"
+  };
+  assertRelativeUrl(path);
+  const opts = {
+    parseAs: "json",
+    body: data,
+    query: params,
+    baseUrl,
+    headers
+  };
+  const safePath = nodepath.join("/api/v1", path);
+  return commonRequest(method, safePath, opts).then(logResponse);
+};
+
+// src/Adaptor.js
+import { execute as commonExecute } from "@openfn/language-common";
+import {
+  dataPath,
+  dataValue,
+  dateFns,
+  cursor,
+  each,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  sourceValue
+} from "@openfn/language-common";
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return commonExecute(
+      authorize,
+      ...operations
+    )({
+      ...initialState,
+      ...state
+    });
+  };
+}
+function post(path, data, options, callback) {
+  return request2("POST", `/client/${path}`, data, options, callback);
+}
+function request2(method, path, body, options = {}, callback = (s) => s) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedData, resolvedoptions] = expandReferences(state, method, path, body, options);
+    const response = await request(
+      state.configuration,
+      resolvedMethod,
+      resolvedPath,
+      {
+        data: resolvedData,
+        ...resolvedoptions
+      }
+    );
+    return prepareNextState(state, response, callback);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  src_default as default,
+  each,
+  execute,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  post,
+  request2 as request,
+  sourceValue
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@openfn/language-mojatax",
+  "version": "1.0.0",
+  "description": "OpenFn mojatax 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": "2.0.3"
+  },
+  "devDependencies": {
+    "assertion-error": "2.0.0",
+    "chai": "4.3.6",
+    "deep-eql": "4.1.1",
+    "esno": "^0.16.3",
+    "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 mojatax",
+    "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,91 @@
+/**
+ * State object
+ * @typedef {Object} MojataxHttpState
+ * @property data - The response body (as JSON)
+ * @property response - The HTTP response from the Mojatax server (excluding the body)
+ * @property references - An array of all previous data objects used in the Job
+ **/
+/**
+ * Options provided to Mojatax HTTP request
+ * @typedef {Object} MojataxRequestOptions
+ * @public
+ * @property {object|string} body - body data to append to the request. JSON will be converted to a string (but a content-type header will not be attached to the request).
+ * @property {object} errors - Map of errorCodes -> error messages, ie, `{ 404: 'Resource not found;' }`. Pass `false` to suppress errors for this code.
+ * @property {object} query - An object of query parameters to be encoded into the URL.
+ * @property {object} headers - An object of headers to append to the request.
+ * @property {string} parseAs - Parse the response body as json, text or stream. By default will use the response headers.
+ * @property {number} timeout - Request timeout in ms. Default: 300 seconds.
+ * @property {object} tls - TLS/SSL authentication options. See https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions
+ */
+/**
+ * Execute a sequence of operations.
+ * Wraps `language-common/execute` to make working with this API easier.
+ * @example
+ * execute(
+ *   create('foo'),
+ *   delete('bar')
+ * )(state)
+ * @private
+ * @param {Operations} operations - Operations to be performed.
+ * @returns {Operation}
+ */
+export function execute(...operations: Operations): Operation;
+/**
+ * Make a POST request to any Mojatax endpoint.
+ * @example <caption>Make a POST request to create an invoice</caption>
+ * post("CreateInvoice", {
+ * invoice_id: 'PID092',
+ * customerId: '102',
+ * items: [],
+ * });
+ * @function
+ * @public
+ * @param {string} path - Path to resource
+ * @param {object} data - Object which will be attached to the request body
+ * @param {MojataxRequestOptions} options - Optional request options
+ * @param {function} [callback] - Optional callback to handle the response
+ * @returns {Operation}
+ * @state {MojataxHttpState}
+ */
+export function post(path: string, data: object, options: MojataxRequestOptions, callback?: Function): Operation;
+/**
+ * Make a general HTTP request against the Mojatax server.
+ * @example <caption>Make a POST request to create an invoice</caption>
+ * request("POST", "/client/CreateInvoice", {
+ * invoice_id: 'PID092',
+ * customerId: '102',
+ * items: [],
+ * });
+ * @function
+ * @public
+ * @param {string} method - HTTP method to use
+ * @param {string} path - Path to resource
+ * @param {object} data - Object which will be attached to the POST body
+ * @param {MojataxRequestOptions} options - Optional request options
+ * @param {function} [callback] - Optional callback to handle the response
+ * @returns {Operation}
+ * @state {MojataxHttpState}
+ */
+export function request(method: string, path: string, body: any, options?: MojataxRequestOptions, callback?: Function): Operation;
+/**
+ * State object
+ */
+export type MojataxHttpState = {
+    /**
+     * - The response body (as JSON)
+     */
+    data: any;
+    /**
+     * - The HTTP response from the Mojatax server (excluding the body)
+     */
+    response: any;
+    /**
+     * - An array of all previous data objects used in the Job
+     */
+    references: any;
+};
+/**
+ * Options provided to Mojatax HTTP request
+ */
+export type MojataxRequestOptions = any;
+export { dataPath, dataValue, dateFns, cursor, each, field, fields, fn, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";

package/types/Utils.d.ts

@@ -0,0 +1,3 @@
+export function authorize(state: any): any;
+export function prepareNextState(state: any, response: any, callback?: (s: any) => any): any;
+export function request(configuration: any, method: any, path: any, options: any): any;

package/types/index.d.ts

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