@openfn/language-zata 1.0.0

package/configuration-schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "apiToken": {
+      "title": "API token",
+      "type": "string",
+      "description": "The Zata API token",
+      "writeOnly": true,
+      "minLength": 1,
+      "examples": ["EAAZAq6ZBYUd64BO83b46fn2MdraueL5s9I5IRZCtWUpYsfmEZARN2HDmL8BE5UhFf98EuTnpkhZBWTR9xippoN1a9MzY8Giw3pjSp55YMAF1nowqsy9aLODz48dm8TpXk8ZADUt6qX3vnYJzcn4OH9jrOIiW5ivt3By0beSjbX0E32ZCUMQpS9xRirepvc7qgGKurWQKIcPLPVSGjXQlZCSZBmLdCL8IW07qfjISupZA3HIniORAZDZD"]
+    },
+
+    "apiVersion": {
+      "title": "API Version",
+      "type": "string",
+      "description": "The Zata API version",
+      "examples": ["v1"]
+    },
+    "baseUrl": {
+      "title": "Base URL",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "The base URL (http://www.example.com)",
+      "format": "uri",
+      "minLength": 1,
+      "examples": ["https://example.com"]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["apiToken"]
+}

package/dist/index.cjs

@@ -0,0 +1,200 @@
+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, {
+  as: () => import_language_common2.as,
+  combine: () => import_language_common2.combine,
+  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,
+  get: () => get,
+  group: () => import_language_common2.group,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  map: () => import_language_common2.map,
+  merge: () => import_language_common2.merge,
+  post: () => post,
+  put: () => put,
+  request: () => request2,
+  scrubEmojis: () => import_language_common2.scrubEmojis,
+  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,
+  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,
+  get: () => get,
+  group: () => import_language_common2.group,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  map: () => import_language_common2.map,
+  merge: () => import_language_common2.merge,
+  post: () => post,
+  put: () => put,
+  request: () => request2,
+  scrubEmojis: () => import_language_common2.scrubEmojis,
+  sourceValue: () => import_language_common2.sourceValue,
+  util: () => import_language_common2.util
+});
+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 prepareNextState = (state, response) => {
+  const { body, ...responseWithoutBody } = response;
+  if (!state.references) {
+    state.references = [];
+  }
+  return {
+    ...(0, import_language_common.composeNextState)(state, response.body),
+    response: responseWithoutBody
+  };
+};
+var request = (configuration = {}, method, path, options = {}) => {
+  const { apiToken, apiVersion = "v1", baseUrl = "https://ebm.zata.rw/api" } = configuration;
+  const { headers = {} } = options;
+  const errors = {
+    404: "Page not found"
+  };
+  const opts = {
+    parseAs: "json",
+    errors,
+    baseUrl,
+    ...options,
+    headers: {
+      "content-type": "application/json",
+      "Authorization": `Bearer ${apiToken}`,
+      ...headers
+    }
+  };
+  const safePath = import_node_path.default.join(apiVersion, path);
+  return (0, import_util.request)(method, safePath, opts);
+};
+
+// src/Adaptor.js
+var import_language_common2 = require("@openfn/language-common");
+function get(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedOptions] = (0, import_util2.expandReferences)(state, path, options);
+    const response = await request(
+      state.configuration,
+      "GET",
+      resolvedPath,
+      resolvedOptions
+    );
+    return prepareNextState(state, response);
+  };
+}
+function post(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedBody, resolvedOptions] = (0, import_util2.expandReferences)(state, path, options);
+    const response = await request(
+      state.configuration,
+      "POST",
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedOptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function put(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedBody, resolvedOptions] = (0, import_util2.expandReferences)(state, path, options);
+    const response = await request(
+      state.configuration,
+      "PUT",
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedOptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function request2(method, path, options = {}) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedOptions] = (0, import_util2.expandReferences)(state, method, path, options);
+    const response = await request(
+      state.configuration,
+      resolvedMethod,
+      resolvedPath,
+      resolvedOptions
+    );
+    return prepareNextState(state, response);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  as,
+  combine,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  get,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  post,
+  put,
+  request,
+  scrubEmojis,
+  sourceValue,
+  util
+});

package/dist/index.js

@@ -0,0 +1,172 @@
+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,
+  cursor: () => cursor,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  dateFns: () => dateFns,
+  each: () => each,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  fnIf: () => fnIf,
+  get: () => get,
+  group: () => group,
+  lastReferenceValue: () => lastReferenceValue,
+  map: () => map,
+  merge: () => merge,
+  post: () => post,
+  put: () => put,
+  request: () => request2,
+  scrubEmojis: () => scrubEmojis,
+  sourceValue: () => sourceValue,
+  util: () => util
+});
+import { expandReferences } from "@openfn/language-common/util";
+
+// src/Utils.js
+import { composeNextState } from "@openfn/language-common";
+import { request as commonRequest } from "@openfn/language-common/util";
+import nodepath from "path";
+var prepareNextState = (state, response) => {
+  const { body, ...responseWithoutBody } = response;
+  if (!state.references) {
+    state.references = [];
+  }
+  return {
+    ...composeNextState(state, response.body),
+    response: responseWithoutBody
+  };
+};
+var request = (configuration = {}, method, path, options = {}) => {
+  const { apiToken, apiVersion = "v1", baseUrl = "https://ebm.zata.rw/api" } = configuration;
+  const { headers = {} } = options;
+  const errors = {
+    404: "Page not found"
+  };
+  const opts = {
+    parseAs: "json",
+    errors,
+    baseUrl,
+    ...options,
+    headers: {
+      "content-type": "application/json",
+      "Authorization": `Bearer ${apiToken}`,
+      ...headers
+    }
+  };
+  const safePath = nodepath.join(apiVersion, path);
+  return commonRequest(method, safePath, opts);
+};
+
+// src/Adaptor.js
+import {
+  as,
+  combine,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  scrubEmojis,
+  sourceValue,
+  util
+} from "@openfn/language-common";
+function get(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedOptions] = expandReferences(state, path, options);
+    const response = await request(
+      state.configuration,
+      "GET",
+      resolvedPath,
+      resolvedOptions
+    );
+    return prepareNextState(state, response);
+  };
+}
+function post(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedBody, resolvedOptions] = expandReferences(state, path, options);
+    const response = await request(
+      state.configuration,
+      "POST",
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedOptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function put(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedBody, resolvedOptions] = expandReferences(state, path, options);
+    const response = await request(
+      state.configuration,
+      "PUT",
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedOptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function request2(method, path, options = {}) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedOptions] = expandReferences(state, method, path, options);
+    const response = await request(
+      state.configuration,
+      resolvedMethod,
+      resolvedPath,
+      resolvedOptions
+    );
+    return prepareNextState(state, response);
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  as,
+  combine,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  src_default as default,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  get,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  post,
+  put,
+  request2 as request,
+  scrubEmojis,
+  sourceValue,
+  util
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@openfn/language-zata",
+  "version": "1.0.0",
+  "description": "An OpenFn adaptor for Zata tax compliance",
+  "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.0.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 zata",
+    "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,162 @@
+/**
+ * State object
+ * @typedef {Object} HttpState
+ * @property data - the parsed response body
+ * @property response - the response from the HTTP server, including headers, statusCode, body, etc
+ * @property references - an array of all previous data objects used in the Job
+ **/
+/**
+ * Options provided to the HTTP request
+ * @typedef {Object} RequestOptions
+ * @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} form - Pass a JSON object to be serialised into a multipart HTML form (as FormData) in the body.
+ * @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
+ */
+/**
+ * Make a GET request to the Zata API
+ * @example <caption>Get all product types</caption>
+ * get('data/product-type')
+ * @example <caption>Test Zata API connectivity</caption>
+ * get('test')
+ * @function
+ * @public
+ * @param {string} path - Path to resource
+ * @param {RequestOptions} options - Additional request options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function get(path: string, options: RequestOptions): Operation;
+/**
+ * Make a POST request to the Zata API
+ * @example <caption> Create a sale transaction</caption>
+ * post('transaction/sale', {
+ *  body: {
+ *     "purchaseCode": "43034",
+ *     "paymentMethodID": 1,
+ *     "customerID": 1,
+ *     "transactionDate": "2024-01-01",
+ *     "note": "string",
+ *     "customerTIN": "123456789",
+ *     "customerName": "John Doe",
+ *     "customerPhone": "123456789",
+ *     "items": [
+ *       {
+ *         "productID": 1,
+ *         "units": 12.5,
+ *         "unitPrice": 1000,
+ *         "discountRate": 100,
+ *         "batchNumber": "string"
+ *       }
+ *     ]
+ *    },
+ *  header: {
+ *    companyId: 1,
+ *    branchId: 1
+ *  }
+ *})
+ * @example <caption>Create a company </caption>
+ * post('company', {
+ *  body: {
+ *    name: "Zata Point Global Service",
+ *    address: "No 1, Zata Point Street, Zata Point",
+ *    phone: "08012345678",
+ *    email: "sample@sample.com",
+ *    tin: "123456789"
+ *  }
+ * })
+ * @function
+ * @public
+ * @param {string} path
+ * @param {RequestOptions} options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function post(path: string, options: RequestOptions): Operation;
+/**
+ * Make a PUT request to the Zata API
+ * @example <caption>Reduce product quantity</caption>
+ * put('product/reduce-quantity/{productId}', {
+ *  body: {
+ *    quantity: 10,
+ *    description: 'reason for reducing quantity',
+ *    batchNumber: 'Batch Number'
+ *  },
+ *  header: {
+ *    companyId: 1,
+ *    branchId: 1
+ *  }
+ * })
+ * @function
+ * @public
+ * @param {string} path
+ * @param {RequestOptions} options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function put(path: string, options: RequestOptions): Operation;
+/**
+ * Make a general HTTP request
+ * @example <caption>Create a new sale transaction</caption>
+ * request("POST", "transaction/sale",
+ *  {
+ *      body: {
+ *          "purchaseCode": "43034",
+ *          "paymentMethodID": 1,
+ *          "customerID": 1,
+ *          "transactionDate": "2024-01-01",
+ *          "note": "string",
+ *          "customerTIN": "123456789",
+ *          "customerName": "John Doe",
+ *          "customerPhone": "12345678910",
+ *          "items": [
+ *              {
+ *                  "productID": 1,
+ *                  "units": 12.5,
+ *                  "unitPrice": 1000,
+ *                  "discountRate": 100,
+ *                  "batchNumber": "string"
+ *              }
+ *          ]
+ *      },
+ *      headers: {
+ *          companyId: 1,
+ *          branchId: 1
+ *      }
+ *  });
+ * @function
+ * @public
+ * @param {string} method - HTTP method to use
+ * @param {string} path - Path to resource
+ * @param {RequestOptions} options - Additional request options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function request(method: string, path: string, options?: RequestOptions): Operation;
+/**
+ * State object
+ */
+export type HttpState = {
+    /**
+     * - the parsed response body
+     */
+    data: any;
+    /**
+     * - the response from the HTTP server, including headers, statusCode, body, etc
+     */
+    response: any;
+    /**
+     * - an array of all previous data objects used in the Job
+     */
+    references: any;
+};
+/**
+ * Options provided to the HTTP request
+ */
+export type RequestOptions = any;
+export { as, combine, cursor, dataPath, dataValue, dateFns, each, field, fields, fn, fnIf, group, lastReferenceValue, map, merge, scrubEmojis, sourceValue, util } from "@openfn/language-common";

package/types/Utils.d.ts

@@ -0,0 +1,2 @@
+export function prepareNextState(state: any, response: any): any;
+export function request(configuration: {}, method: any, path: any, options?: {}): any;

package/types/index.d.ts

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