@openfn/language-openhim 0.3.16 → 1.0.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@openfn/language-openhim",
   "label": "OpenHIM",
-  "version": "0.3.16",
-  "description": "openhim Language Pack for OpenFn",
+  "version": "1.0.0",
+  "description": "OpenFn adaptor for OpenHIM",
   "main": "dist/index.cjs",
   "author": "Open Function Group",
   "license": "LGPLv3",
@@ -14,21 +14,20 @@
   ],
   "dependencies": {
     "JSONPath": "^0.10.0",
-    "lodash-fp": "^0.10.2",
-    "superagent": "^3.7.0",
-    "@openfn/language-common": "3.0.1"
+    "lodash-fp": "^0.10.4",
+    "@openfn/language-common": "3.0.2"
   },
   "devDependencies": {
-    "assertion-error": "^1.0.1",
+    "assertion-error": "^1.1.0",
     "babel-cli": "^6.26.0",
-    "babel-core": "^6.1.2",
-    "babel-preset-es2015": "^6.1.2",
-    "babel-preset-stage-0": "^6.3.13",
-    "chai": "^3.4.0",
+    "babel-core": "^6.26.3",
+    "babel-preset-es2015": "^6.24.1",
+    "babel-preset-stage-0": "^6.24.1",
+    "chai": "4.3.6",
     "deep-eql": "^0.1.3",
+    "mocha": "^10.8.2",
     "rimraf": "^3.0.2",
-    "sinon": "^1.17.2",
-    "superagent-mock": "^1.10.0"
+    "sinon": "^1.17.7"
   },
   "repository": {
     "type": "git",

package/types/Adaptor.d.ts

@@ -1,3 +1,11 @@
+/**
+ * State object
+ * @typedef {Object} HttpState
+ * @private
+ * @property data - the parsed response body
+ * @property response - the response from the OpenHIM server, including headers, statusCode, etc
+ * @property references - an array of all previous data objects used in the Job
+ **/
 /**
  * Execute a sequence of operations.
  * Wraps `language-common/execute`, and prepends initial state for openhim.
@@ -13,11 +21,200 @@
 export function execute(...operations: Operations): Operation;
 /**
  * Create an encounter
- * @example <caption>Create an encounter</caption
- * encounter(encounterData)
+ * @example <caption>Create an encounter</caption>
+ * createEncounter(encounterData)
  * @function
  * @param {object} encounterData - Payload data for the encounter
  * @returns {Operation}
  */
-export function encounter(encounterData: object): Operation;
-export { fn, fnIf, field, fields, sourceValue, merge, dataPath, dataValue, lastReferenceValue } from "@openfn/language-common";
+export function createEncounter(encounterData: object): Operation;
+/**
+ * Get transactions query options
+ * @typedef {Object} OpenHIMGetTransactionsOptions
+ * @public
+ * @property {string} transactionId - The ID of the transaction to retrieve. If provided, only this transaction will be returned.
+ * @property {number} filterLimit - The maximum number of transactions to return. Defaults to 100.
+ * @property {number} filterPage - The page to return (used in conjunction with filterLimit).
+ * @property {object} filterRepresentation - Determines how much information for a transaction to return.
+ * @property {object} filters - Advanced filters to apply to the transactions. This is a JSON object that can include properties like `response.status` or `properties.prop`.
+ */
+/**
+ * Make a request to OpenHIM to get transactions
+ * @example <caption>Get all transactions</caption>
+ * getTransactions()
+ * @example <caption>Get a specific transaction</caption>
+ * getTransactions({transactionId:"686f56e070b851d7a21898f5"})
+ * @example <caption>Get transactions with filters</caption>
+ * getTransactions({
+ *   filterLimit: 5,
+ *   filterPage: 0,
+ *   filterRepresentation: 'full',
+ *   filters: '{"response.status":"200"}',
+ * });
+ * @function
+ * @public
+ * @param {OpenHIMGetTransactionsOptions} options - Optional request options. See [OpenHIM Transactions docs](https://openhim.org/docs/api/transactions/read/#read-all-transactions)
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function getTransactions(options?: OpenHIMGetTransactionsOptions): Operation;
+/**
+ * Make a request to OpenHIM to get all registered client records
+ * @example <caption>Get all clients</caption>
+ * getClients()
+ * @example <caption>Get a specific client</caption>
+ * getClients('6823172670b851d7a222075a');
+ * @function
+ * @public
+ * @param {string} clientId - Optional clientID to return a specific client.
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function getClients(clientId: string): Operation;
+/**
+ * Make a request to OpenHIM to create a new client record
+ * @example <caption>Create a client record</caption>
+ * registerClient({
+ *  roles: ['fhir'],
+ *  clientID: 'fhir-server-7',
+ *  name: 'FHIR Server',
+ *  passwordAlgorithm: 'sha512',
+ *  passwordSalt: '3e74a280c568f27241e48e938edf21bf',
+ *  passwordHash:
+ *    '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',
+ * });
+ * @function
+ * @public
+ * @param {object} body - The client data to register.
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function registerClient(body: object): Operation;
+/**
+ * Make a request to OpenHIM to update a client record
+ * @example <caption>Update a client record</caption>
+ * updateClient({
+ *  _id:'6870c19870b851d7a22b8d27',
+ *  roles: ['fhir', 'testing'],
+ *  clientID: 'fhir-server-7',
+ *  name: 'FHIR Server Testing',
+ *  passwordAlgorithm: 'sha512',
+ *  passwordSalt: '3e74a280c568f27241e48e938edf21bf',
+ *  passwordHash:
+ *    '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',
+ * });
+ * @function
+ * @public
+ * @param {object} body - The client data to update.
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function updateClient(body: object): Operation;
+/**
+ * Make a request to OpenHIM to get all channel records
+ * @example <caption>Get all channels</caption>
+ * getChannels()
+ * @example <caption>Get a specific channel</caption>
+ * getChannels('67dac5fd70b851d7a26d1274');
+ * @function
+ * @public
+ * @param {string} channelId - Optional channelId to return a specific channel.
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function getChannels(channelId: string): Operation;
+/**
+ * Make a request to OpenHIM to create a new channel. See [OpenHIM Channels docs](https://openhim.org/docs/api/channels/create#create-channel)
+ * @example <caption>Create a channel</caption>
+ * createChannel({
+ *   type: 'http',
+ *   authType: 'public',
+ *   status: 'enabled',
+ *   routes: [
+ *     {
+ *       name: 'FHIR Server Testing',
+ *       secured: false,
+ *       host: 'localhost',
+ *       port: '3447',
+ *       primary: true,
+ *     },
+ *   ],
+ *   requestBody: true,
+ *   responseBody: true,
+ *   name: 'FHIR Server Testing',
+ *   urlPattern: '^/fhir/.*$',
+ *   methods: [
+ *     'GET',
+ *     'POST',
+ *   ],
+ * });
+ * @function
+ * @public
+ * @param {object} body - The channel data to create.
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function createChannel(body: object): Operation;
+/**
+ * Get tasks query options
+ * @typedef {Object} OpenHIMGetTasksOptions
+ * @public
+ * @property {string} taskId - The ID of the task to retrieve. If provided, only this task will be returned.
+ * @property {number} filterLimit - The maximum number of tasks to return. Defaults to 100.
+ * @property {number} filterPage - The page to return (used in conjunction with filterLimit).
+ * @property {object} filters - Advanced filters to apply to the tasks. This is a JSON object that can include properties like `response.status` or `properties.prop`.
+ */
+/**
+ * Make a request to OpenHIM to get all tasks
+ * @example <caption>Get all tasks</caption>
+ * getTasks({
+ *   filterLimit: 10,
+ *   filterPage: 0,
+ *   filters: '{}',
+ * });
+ * @example <caption>Get a specific task</caption>
+ * getTasks({
+ *   taskId: '6870fbf470b851d7a22e9f05',
+ *   filterLimit: 10,
+ *   filterPage: 0,
+ *   filters: '{}',
+ * });
+ * @function
+ * @public
+ * @param {OpenHIMGetTasksOptions} options - Required request options for each request. See [OpenHIM Tasks docs](https://openhim.org/docs/api/tasks/read/#read-all-tasks)
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function getTasks(options: OpenHIMGetTasksOptions): Operation;
+/**
+ * Make a request to OpenHIM to create a new task
+ * @example <caption>Create a task record</caption>
+ * createTask({
+ *   tids: [
+ *     '5bb777777bbb66cc5d4444ee',
+ *     '5ceec0bb3ca344f9a30df633',
+ *     '5af732d1cbf94ba88b8f0bc0',
+ *   ],
+ *   batchSize: 2,
+ *   paused: true,
+ * });
+ * @function
+ * @public
+ * @param {object} body - The task data to create.
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function createTask(body: object): Operation;
+/**
+ * State object
+ */
+export type HttpState = any;
+/**
+ * Get transactions query options
+ */
+export type OpenHIMGetTransactionsOptions = any;
+/**
+ * Get tasks query options
+ */
+export type OpenHIMGetTasksOptions = any;
+export { fnIf, dataPath, dataValue, dateFns, cursor, each, field, fields, fn, lastReferenceValue, merge, sourceValue, as, map } from "@openfn/language-common";

package/types/Util.d.ts

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

package/types/http.d.ts

@@ -0,0 +1,139 @@
+/**
+ * State object
+ * @typedef {Object} OpenHIMHttpState
+ * @private
+ * @property data - the parsed response body
+ * @property response - the response from the OpenHIM server, including headers, statusCode, etc
+ * @property references - an array of all previous data objects used in the Job
+ **/
+/**
+ * Options provided to the OpenHIM request
+ * @typedef {Object} RequestOptions
+ * @public
+ * @property {object|string} body - body data to append to the request. JSON will be converted to a string.
+ * @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 - The format to parse the response body as. Defaults to `json`. Accepted values: `json`, `stream`, and `text`.
+ */
+/**
+ * Make a GET request to OpenHIM
+ * @example <caption>Get all transactions</caption>
+ * http.get('/transactions')
+ * @function
+ * @public
+ * @param {string} path - Path to resource
+ * @param {RequestOptions} options - Optional request options
+ * @returns {Operation}
+ * @state {OpenHIMHttpState}
+ */
+export function get(path: string, options: RequestOptions): Operation;
+/**
+ * Make a POST request to OpenHIM
+ * @example <caption>Create a client </caption>
+ * http.post(
+  '/clients',
+  {
+    roles: ['fhir'],
+    clientID: 'fhir-server-5',
+    name: 'FHIR Server',
+    passwordAlgorithm: 'sha512',
+    passwordSalt: '3e74a280c568f27241e48e938edf21bf',
+    passwordHash:
+      '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',
+  },
+  {
+    parseAs: 'text',
+  }
+);
+ * @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 {OpenHIMHttpState}
+ */
+export function post(path: string, body: object, options: RequestOptions): Operation;
+/**
+ * Make a PUT request to OpenHIM
+ * @example <caption>Update an existing client</caption>
+ * http.put(
+  '/clients/686fb79470b851d7a21dad76',
+  {
+    _id: '686fb79470b851d7a21dad76',
+    roles: ['fhir', 'testing'],
+    clientID: 'fhir-server-5',
+    name: 'FHIR Server',
+    passwordAlgorithm: 'sha512',
+    passwordSalt: '3e74a280c568f27241e48e938edf21bf',
+    passwordHash:
+      '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',
+  },
+  {
+    parseAs: 'text',
+  }
+);
+ * @function
+ * @public
+ * @param {string} path - Path to resource with the id of the resource to update
+ * @param {object} body - Object which will be attached to the PUT body
+ * @param {RequestOptions} options - Optional request options
+ * @returns {Operation}
+ * @state {OpenHIMHttpState}
+ */
+export function put(path: string, body: object, options: RequestOptions): Operation;
+/**
+ * Make a DELETE request to OpenHIM
+ * @example <caption>Delete an existing client</caption>
+ * http.delete('/clients/686fb65870b851d7a21d9ca0', {
+  parseAs: 'text',
+});
+ * @function
+ * @alias delete
+ * @public
+ * @param {string} path - Path to resource with the id of the resource to delete
+ * @param {RequestOptions} options - Optional request options
+ * @returns {Operation}
+ * @state {OpenHIMHttpState}
+ */
+export function _delete(path: string, options: RequestOptions): Operation;
+/**
+ * Make a general HTTP request to OpenHIM
+ * @example <caption>Create a client</caption>
+ * http.request(
+  'POST',
+  '/clients',
+  {
+    roles: ['fhir'],
+    clientID: 'fhir-server-2',
+    name: 'FHIR Server',
+    passwordAlgorithm: 'sha512',
+    passwordSalt: '3e74a280c568f27241e48e938edf21bf',
+    passwordHash:
+      '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',
+  },
+  {
+    parseAs: 'text',
+  }
+);
+ * @example <caption>Get all transactions</caption>
+ * http.request('GET','/transactions')
+ * @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 {OpenHIMHttpState}
+ */
+export function request(method: string, path: string, body: object, options?: RequestOptions): Operation;
+/**
+ * State object
+ */
+export type OpenHIMHttpState = any;
+/**
+ * Options provided to the OpenHIM request
+ */
+export type RequestOptions = any;

package/types/index.d.ts

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

package/types/Client.d.ts

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