@openfn/language-openelis 1.0.0

package/configuration-schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "baseUrl": {
+      "title": "Base URL",
+      "description": "The base URL for the OpenELIS instance",
+      "format": "uri",
+      "minLength": 1,
+      "examples": ["https://demo.openelis-global.org"]
+    },
+    "username": {
+      "title": "Username",
+      "type": "string",
+      "description": "Username",
+      "examples": ["admin"]
+    },
+    "password": {
+      "title": "Password",
+      "type": "string",
+      "description": "Password",
+      "writeOnly": true,
+      "examples": ["@some(!)Str0ngp4ss0w0rd"]
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["password", "username", "baseUrl"]
+}

package/dist/index.cjs

@@ -0,0 +1,193 @@
+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_common.as,
+  combine: () => import_language_common.combine,
+  cursor: () => import_language_common.cursor,
+  dataPath: () => import_language_common.dataPath,
+  dataValue: () => import_language_common.dataValue,
+  dateFns: () => import_language_common.dateFns,
+  default: () => src_default,
+  each: () => import_language_common.each,
+  field: () => import_language_common.field,
+  fields: () => import_language_common.fields,
+  fn: () => import_language_common.fn,
+  fnIf: () => import_language_common.fnIf,
+  group: () => import_language_common.group,
+  http: () => http_exports,
+  lastReferenceValue: () => import_language_common.lastReferenceValue,
+  map: () => import_language_common.map,
+  merge: () => import_language_common.merge,
+  scrubEmojis: () => import_language_common.scrubEmojis,
+  sourceValue: () => import_language_common.sourceValue,
+  util: () => import_language_common.util
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  as: () => import_language_common.as,
+  combine: () => import_language_common.combine,
+  cursor: () => import_language_common.cursor,
+  dataPath: () => import_language_common.dataPath,
+  dataValue: () => import_language_common.dataValue,
+  dateFns: () => import_language_common.dateFns,
+  each: () => import_language_common.each,
+  field: () => import_language_common.field,
+  fields: () => import_language_common.fields,
+  fn: () => import_language_common.fn,
+  fnIf: () => import_language_common.fnIf,
+  group: () => import_language_common.group,
+  lastReferenceValue: () => import_language_common.lastReferenceValue,
+  map: () => import_language_common.map,
+  merge: () => import_language_common.merge,
+  scrubEmojis: () => import_language_common.scrubEmojis,
+  sourceValue: () => import_language_common.sourceValue,
+  util: () => import_language_common.util
+});
+var import_language_common = require("@openfn/language-common");
+
+// src/http.js
+var http_exports = {};
+__export(http_exports, {
+  get: () => get,
+  post: () => post,
+  request: () => request2
+});
+var import_util2 = require("@openfn/language-common/util");
+
+// src/Utils.js
+var import_language_common2 = 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_common2.composeNextState)(state, response.body),
+    response: responseWithoutBody
+  };
+};
+var request = (configuration = {}, method, path, options) => {
+  const { baseUrl, username, password } = configuration;
+  let { body = {}, query = {}, headers = {}, parseAs = "json" } = options;
+  if (username && password) {
+    headers = (0, import_util.makeBasicAuthHeader)(username, password);
+  }
+  const opts = {
+    parseAs,
+    baseUrl,
+    body,
+    query,
+    headers: {
+      "content-type": "application/json",
+      ...headers
+    }
+  };
+  const safePath = import_node_path.default.join(`/api/OpenELIS-Global/rest/${path}`);
+  return (0, import_util.request)(method, safePath, opts).then(import_util.logResponse);
+};
+
+// src/http.js
+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,
+        body: {}
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function post(path, body, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedBody, resolvedOptions] = (0, import_util2.expandReferences)(
+      state,
+      path,
+      body,
+      options
+    );
+    const response = await request(
+      state.configuration,
+      "POST",
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedOptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function request2(method, path, body, options = {}) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedBody, resolvedoptions] = (0, import_util2.expandReferences)(state, method, path, body, options);
+    const response = await request(
+      state.configuration,
+      resolvedMethod,
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...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,
+  group,
+  http,
+  lastReferenceValue,
+  map,
+  merge,
+  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,
+  group: () => group,
+  lastReferenceValue: () => lastReferenceValue,
+  map: () => map,
+  merge: () => merge,
+  scrubEmojis: () => scrubEmojis,
+  sourceValue: () => sourceValue,
+  util: () => util
+});
+import {
+  as,
+  combine,
+  cursor,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  fnIf,
+  group,
+  lastReferenceValue,
+  map,
+  merge,
+  scrubEmojis,
+  sourceValue,
+  util
+} from "@openfn/language-common";
+
+// src/http.js
+var http_exports = {};
+__export(http_exports, {
+  get: () => get,
+  post: () => post,
+  request: () => request2
+});
+import { expandReferences } from "@openfn/language-common/util";
+
+// src/Utils.js
+import { composeNextState } from "@openfn/language-common";
+import {
+  request as commonRequest,
+  makeBasicAuthHeader,
+  logResponse
+} 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 { baseUrl, username, password } = configuration;
+  let { body = {}, query = {}, headers = {}, parseAs = "json" } = options;
+  if (username && password) {
+    headers = makeBasicAuthHeader(username, password);
+  }
+  const opts = {
+    parseAs,
+    baseUrl,
+    body,
+    query,
+    headers: {
+      "content-type": "application/json",
+      ...headers
+    }
+  };
+  const safePath = nodepath.join(`/api/OpenELIS-Global/rest/${path}`);
+  return commonRequest(method, safePath, opts).then(logResponse);
+};
+
+// src/http.js
+function get(path, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedOptions] = expandReferences(state, path, options);
+    const response = await request(
+      state.configuration,
+      "GET",
+      resolvedPath,
+      {
+        ...resolvedOptions,
+        body: {}
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function post(path, body, options) {
+  return async (state) => {
+    const [resolvedPath, resolvedBody, resolvedOptions] = expandReferences(
+      state,
+      path,
+      body,
+      options
+    );
+    const response = await request(
+      state.configuration,
+      "POST",
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...resolvedOptions
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
+function request2(method, path, body, options = {}) {
+  return async (state) => {
+    const [resolvedMethod, resolvedPath, resolvedBody, resolvedoptions] = expandReferences(state, method, path, body, options);
+    const response = await request(
+      state.configuration,
+      resolvedMethod,
+      resolvedPath,
+      {
+        body: resolvedBody,
+        ...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,
+  group,
+  http_exports as http,
+  lastReferenceValue,
+  map,
+  merge,
+  scrubEmojis,
+  sourceValue,
+  util
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@openfn/language-openelis",
+  "version": "1.0.0",
+  "description": "OpenFn openelis 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 openelis",
+    "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 @@
+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): any;

package/types/http.d.ts

@@ -0,0 +1,200 @@
+/**
+ * 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} 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.
+ */
+/**
+ * Make a GET request to an OpenELIS instance
+ * @example <caption>Get all orders in progress</caption>
+ * http.get('home-dashboard/ORDERS_IN_PROGRESS');
+ * @example <caption>Get all orders ready for validation</caption>
+ * http.get('home-dashboard/ORDERS_READY_FOR_VALIDATION');
+ * @example <caption>Get all the reasons why a lab order could be referred</caption>
+ * http.get('referral-reasons');
+ * @function
+ * @public
+ * @param {string} path - Path to resource
+ * @param {RequestOptions} options - Optional request options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function get(path: string, options: RequestOptions): Operation;
+/**
+ * Make a POST request to an OpenELIS instance
+ * @example <caption>Validate results for a lab order</caption>
+ * http.post('AccessionValidation', {
+    "formName": "ResultValidationForm",
+    "formMethod": "POST",
+    "cancelAction": "Home",
+    "submitOnCancel": false,
+    "cancelMethod": "POST",
+    "searchFinished": true,
+    "paging": {
+        "totalPages": "1",
+        "currentPage": "1",
+        "searchTermToPage": [
+            {
+                "id": "25RSH00005L",
+                "value": "1"
+            }
+        ]
+    },
+    "currentDate": "",
+    "resultList": [
+        {
+            "id": 4,
+            <more details>
+        }
+    ],
+    "testSection": "",
+    "accessionNumber": "25RSH00005L",
+    "testDate": "",
+    "testName": "",
+    "testSections": [
+        {
+            "id": "56",
+            "value": "Biochemistry"
+        }
+    ],
+    "testSectionsByName": [
+        {
+            "id": "56",
+            "value": "Biochemistry"
+        }
+    ],
+    "displayTestSections": true
+});
+ * @example <caption>Add results to an order</caption>
+ * http.post('LogbookResults', {
+    "formName": "LogbookResultsForm",
+    "formMethod": "POST",
+    "cancelAction": "Home",
+    "submitOnCancel": false,
+    "cancelMethod": "POST",
+    "paging": {
+        "totalPages": "1",
+        "currentPage": "1",
+        "searchTermToPage": [
+            {
+                "id": "DEV01260000000000003",
+                "value": "1"
+            }
+        ]
+    },
+    "accessionNumber": "DEV01260000000000003",
+    "singlePatient": false,
+    "currentDate": "09/02/2026",
+    "displayTestMethod": true,
+    "displayTestKit": false,
+    "testResult": [
+        {
+            "id": "0",
+            <more details>
+        }
+    ],
+    "inventoryItems": [],
+    "hivKits": [],
+    "syphilisKits": [],
+    "type": "",
+    "displayMethods": true,
+    "testSectionId": "",
+    "displayTestSections": true,
+    "searchByRange": false,
+    "searchFinished": true
+});
+ * @function
+ * @public
+ * @param {string} path - Path to resource
+ * @param {object} body - Object which will be attached to the POST body
+ * @param {RequestOptions} options - Optional request options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function post(path: string, body: object, options: RequestOptions): Operation;
+/**
+ * Make a general HTTP request
+ * @example <caption>Edit an existing patient's information</caption>
+ * http.request('POST', 'PatientManagement', {
+    "patientUpdateStatus": "UPDATE",
+    "nationalId": "1234567892",
+    "subjectNumber": "1234567892",
+    "lastName": "Lazic",
+    "firstName": "Aleksa",
+    "streetAddress": "",
+    "city": "",
+    "primaryPhone": "+255-45-89-63-21",
+    "gender": "F",
+    "birthDateForDisplay": "13/08/2000",
+    "commune": "",
+    "education": "",
+    "maritialStatus": "",
+    "nationality": "",
+    "healthDistrict": "",
+    "healthRegion": "",
+    "otherNationality": "",
+    "patientContact": {
+        "person": {
+            "firstName": "",
+            "lastName": "",
+            "primaryPhone": "",
+            "email": "",
+            "lastupdated": 1764586121386,
+            "id": "409"
+        },
+        "lastupdated": 1764536400000,
+        "id": "200",
+        "patientId": "202"
+    },
+    "patientPK": "202",
+    "guid": "c7e48932-2ed8-440a-9312-b68112e3873f",
+    "aka": "",
+    "mothersName": "",
+    "mothersInitial": "",
+    "addressDepartment": "",
+    "insuranceNumber": "",
+    "occupation": "",
+    "readOnly": false,
+    "stnumber": ""
+});
+ * @function
+ * @public
+ * @param {string} method - HTTP method to use
+ * @param {string} path - Path to resource
+ * @param {object} body - Object which will be attached to the POST body
+ * @param {RequestOptions} options - Optional request options
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function request(method: string, path: string, body: object, 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;

package/types/index.d.ts

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