@openfn/language-openhim 0.1.2 → 0.1.4

package/README.md

@@ -138,15 +138,12 @@ openhim API.
 }
 ```
 
-## Sample configuration
+### Configuration
 
-```json
-{
-  "apiUrl": "http://openhim.com/api",
-  "username": "admin@openhim",
-  "password": "supersecretopenhimpassword"
-}
-```
+View all the required and optional properties for `state.configuration` in the
+official
+[configuration-schema](https://docs.openfn.org/adaptors/packages/openhim-configuration-schema/)
+definition.
 
 ## Development
 

package/ast.json

@@ -2,6 +2,49 @@
   "operations": [],
   "exports": [],
   "common": [
+    {
+      "name": "fn",
+      "params": [
+        "func"
+      ],
+      "docs": {
+        "description": "Creates a custom step (or operation) for more flexible job writing.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "fn(state => {\n  // do some things to state\n  return state;\n});"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "is the function",
+            "type": {
+              "type": "NameExpression",
+              "name": "Function"
+            },
+            "name": "func"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
     {
       "name": "sourceValue",
       "params": [
@@ -32,6 +75,14 @@
               "name": "String"
             },
             "name": "path"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
           }
         ]
       },
@@ -110,6 +161,14 @@
               "name": "String"
             },
             "name": "path"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
           }
         ]
       },
@@ -145,6 +204,14 @@
               "name": "String"
             },
             "name": "path"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
           }
         ]
       },
@@ -190,6 +257,14 @@
               "name": "Value"
             },
             "name": "value"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Field"
+            }
           }
         ]
       },

package/dist/index.cjs

@@ -0,0 +1,111 @@
+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, {
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  default: () => src_default,
+  encounter: () => encounter,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  sourceValue: () => import_language_common2.sourceValue
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  encounter: () => encounter,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  sourceValue: () => import_language_common2.sourceValue
+});
+var import_language_common = require("@openfn/language-common");
+
+// src/Client.js
+var import_superagent = __toESM(require("superagent"), 1);
+function post({ username, password, body, url }) {
+  return new Promise((resolve, reject) => {
+    import_superagent.default.post(url).type("json").accept("json").auth(username, password).send(JSON.stringify(body)).end((error, res) => {
+      if (!!error || !res.ok) {
+        reject(error);
+      }
+      resolve(res);
+    });
+  });
+}
+
+// src/Adaptor.js
+var import_url = require("url");
+var import_language_common2 = require("@openfn/language-common");
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return (0, import_language_common.execute)(...operations)({ ...initialState, ...state });
+  };
+}
+function encounter(encounterData) {
+  return (state) => {
+    const body = (0, import_language_common.expandReferences)(encounterData)(state);
+    const { username, password, apiUrl } = state.configuration;
+    const url = (0, import_url.resolve)(apiUrl + "/", "chw/encounter");
+    console.log("Posting encounter:");
+    console.log(JSON.stringify(body, null, 2));
+    return post({ username, password, body, url }).then((result) => {
+      console.log("Success:", result);
+      return { ...state, references: [result, ...state.references] };
+    });
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  dataPath,
+  dataValue,
+  encounter,
+  execute,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  sourceValue
+});

package/dist/index.js

@@ -0,0 +1,88 @@
+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, {
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  encounter: () => encounter,
+  execute: () => execute,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  lastReferenceValue: () => lastReferenceValue,
+  merge: () => merge,
+  sourceValue: () => sourceValue
+});
+import {
+  execute as commonExecute,
+  expandReferences
+} from "@openfn/language-common";
+
+// src/Client.js
+import request from "superagent";
+function post({ username, password, body, url }) {
+  return new Promise((resolve, reject) => {
+    request.post(url).type("json").accept("json").auth(username, password).send(JSON.stringify(body)).end((error, res) => {
+      if (!!error || !res.ok) {
+        reject(error);
+      }
+      resolve(res);
+    });
+  });
+}
+
+// src/Adaptor.js
+import { resolve as resolveUrl } from "url";
+import {
+  fn,
+  field,
+  fields,
+  sourceValue,
+  merge,
+  dataPath,
+  dataValue,
+  lastReferenceValue
+} from "@openfn/language-common";
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return commonExecute(...operations)({ ...initialState, ...state });
+  };
+}
+function encounter(encounterData) {
+  return (state) => {
+    const body = expandReferences(encounterData)(state);
+    const { username, password, apiUrl } = state.configuration;
+    const url = resolveUrl(apiUrl + "/", "chw/encounter");
+    console.log("Posting encounter:");
+    console.log(JSON.stringify(body, null, 2));
+    return post({ username, password, body, url }).then((result) => {
+      console.log("Success:", result);
+      return { ...state, references: [result, ...state.references] };
+    });
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  dataPath,
+  dataValue,
+  src_default as default,
+  encounter,
+  execute,
+  field,
+  fields,
+  fn,
+  lastReferenceValue,
+  merge,
+  sourceValue
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-openhim",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "openhim Language Pack for OpenFn",
   "main": "dist/index.cjs",
   "author": "Open Function Group",
@@ -13,7 +13,7 @@
   ],
   "dependencies": {
     "JSONPath": "^0.10.0",
-    "@openfn/language-common": "^1.7.5",
+    "@openfn/language-common": "^1.7.6",
     "lodash-fp": "^0.10.2",
     "superagent": "^3.7.0"
   },
@@ -47,7 +47,7 @@
   },
   "types": "types/index.d.ts",
   "scripts": {
-    "build": "pnpm clean && build-adaptor mssql",
+    "build": "pnpm clean && build-adaptor openhim",
     "test": "mocha --experimental-specifier-resolution=node --no-warnings",
     "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
     "clean": "rimraf dist types docs",

package/types/Adaptor.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Execute a sequence of operations.
+ * Wraps `language-common/execute`, and prepends initial state for openhim.
+ * @example
+ * execute(
+ *   create('foo'),
+ *   delete('bar')
+ * )(state)
+ * @private
+ * @param {Operations} operations - Operations to be performed.
+ * @returns {Operation}
+ */
+export function execute(...operations: Operations): Operation;
+/**
+ * Create an encounter
+ * @example
+ * execute(
+ *   encounter(data)
+ * )(state)
+ * @function
+ * @param {object} encounterData - Payload data for the encounter
+ * @returns {Operation}
+ */
+export function encounter(encounterData: object): Operation;
+export { fn, field, fields, sourceValue, merge, dataPath, dataValue, lastReferenceValue } from "@openfn/language-common";

package/types/Client.d.ts

@@ -0,0 +1,6 @@
+export function post({ username, password, body, url }: {
+    username: any;
+    password: any;
+    body: any;
+    url: any;
+}): Promise<any>;

package/types/index.d.ts

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