@openfn/language-openhim 1.0.0 → 2.0.1

package/ast.json

@@ -112,7 +112,7 @@
       "valid": true
     },
     {
-      "name": "registerClient",
+      "name": "createClient",
       "params": [
         "body"
       ],
@@ -121,7 +121,7 @@
         "tags": [
           {
             "title": "example",
-            "description": "registerClient({\n roles: ['fhir'],\n clientID: 'fhir-server-7',\n name: 'FHIR Server',\n passwordAlgorithm: 'sha512',\n passwordSalt: '3e74a280c568f27241e48e938edf21bf',\n passwordHash:\n   '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',\n});",
+            "description": "createClient({\n roles: ['fhir'],\n clientID: 'fhir-server-7',\n name: 'FHIR Server',\n passwordAlgorithm: 'sha512',\n passwordSalt: '3e74a280c568f27241e48e938edf21bf',\n passwordHash:\n   '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',\n});",
             "caption": "Create a client record"
           },
           {
@@ -159,54 +159,6 @@
       },
       "valid": true
     },
-    {
-      "name": "updateClient",
-      "params": [
-        "body"
-      ],
-      "docs": {
-        "description": "Make a request to OpenHIM to update a client record",
-        "tags": [
-          {
-            "title": "example",
-            "description": "updateClient({\n _id:'6870c19870b851d7a22b8d27',\n roles: ['fhir', 'testing'],\n clientID: 'fhir-server-7',\n name: 'FHIR Server Testing',\n passwordAlgorithm: 'sha512',\n passwordSalt: '3e74a280c568f27241e48e938edf21bf',\n passwordHash:\n   '9a5158dc87a25da9d8822d48ed831a88bb4ba7fa636ddb6d6a725f73688546052cb7f2c355758e4839f9416e6cc0e37e1e3070f597af2836d39768a5ecc050db',\n});",
-            "caption": "Update a client record"
-          },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
-          {
-            "title": "public",
-            "description": null,
-            "type": null
-          },
-          {
-            "title": "param",
-            "description": "The client data to update.",
-            "type": {
-              "type": "NameExpression",
-              "name": "object"
-            },
-            "name": "body"
-          },
-          {
-            "title": "returns",
-            "description": null,
-            "type": {
-              "type": "NameExpression",
-              "name": "Operation"
-            }
-          },
-          {
-            "title": "state",
-            "description": "{HttpState}"
-          }
-        ]
-      },
-      "valid": true
-    },
     {
       "name": "getChannels",
       "params": [
@@ -318,9 +270,14 @@
         "tags": [
           {
             "title": "example",
-            "description": "getTasks({\n  filterLimit: 10,\n  filterPage: 0,\n  filters: '{}',\n});",
+            "description": "getTasks()",
             "caption": "Get all tasks"
           },
+          {
+            "title": "example",
+            "description": "getTasks({\n  filterLimit: 10,\n  filterPage: 0,\n  filters: '{}',\n});",
+            "caption": "Get all tasks with pagination options"
+          },
           {
             "title": "example",
             "description": "getTasks({\n  taskId: '6870fbf470b851d7a22e9f05',\n  filterLimit: 10,\n  filterPage: 0,\n  filters: '{}',\n});",
@@ -462,7 +419,7 @@
         "operation"
       ],
       "docs": {
-        "description": "A custom operation that will only execute the function if the condition returns true",
+        "description": "Execute a function only when the condition returns true",
         "tags": [
           {
             "title": "public",

package/dist/index.cjs

@@ -21,6 +21,7 @@ var src_exports = {};
 __export(src_exports, {
   as: () => import_language_common3.as,
   createChannel: () => createChannel,
+  createClient: () => createClient,
   createEncounter: () => createEncounter,
   createTask: () => createTask,
   cursor: () => import_language_common3.cursor,
@@ -42,9 +43,7 @@ __export(src_exports, {
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
   map: () => import_language_common3.map,
   merge: () => import_language_common3.merge,
-  registerClient: () => registerClient,
-  sourceValue: () => import_language_common3.sourceValue,
-  updateClient: () => updateClient
+  sourceValue: () => import_language_common3.sourceValue
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -53,6 +52,7 @@ var Adaptor_exports = {};
 __export(Adaptor_exports, {
   as: () => import_language_common3.as,
   createChannel: () => createChannel,
+  createClient: () => createClient,
   createEncounter: () => createEncounter,
   createTask: () => createTask,
   cursor: () => import_language_common3.cursor,
@@ -72,9 +72,7 @@ __export(Adaptor_exports, {
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
   map: () => import_language_common3.map,
   merge: () => import_language_common3.merge,
-  registerClient: () => registerClient,
-  sourceValue: () => import_language_common3.sourceValue,
-  updateClient: () => updateClient
+  sourceValue: () => import_language_common3.sourceValue
 });
 var import_language_common2 = require("@openfn/language-common");
 var import_util2 = require("@openfn/language-common/util");
@@ -167,7 +165,7 @@ function getClients(clientId) {
     return prepareNextState(state, response);
   };
 }
-function registerClient(body) {
+function createClient(body) {
   return async (state) => {
     const [resolvedBody] = (0, import_util2.expandReferences)(state, body);
     const response = await request(
@@ -182,22 +180,6 @@ function registerClient(body) {
     return prepareNextState(state, response);
   };
 }
-function updateClient(body) {
-  return async (state) => {
-    const [resolvedBody] = (0, import_util2.expandReferences)(state, body);
-    const { _id } = resolvedBody;
-    const response = await request(
-      state.configuration,
-      "PUT",
-      `/clients/${_id}`,
-      {
-        body: resolvedBody,
-        parseAs: "text"
-      }
-    );
-    return prepareNextState(state, response);
-  };
-}
 function getChannels(channelId) {
   return async (state) => {
     const [resolvedChannelId] = (0, import_util2.expandReferences)(state, channelId);
@@ -296,6 +278,7 @@ var src_default = Adaptor_exports;
 0 && (module.exports = {
   as,
   createChannel,
+  createClient,
   createEncounter,
   createTask,
   cursor,
@@ -316,7 +299,5 @@ var src_default = Adaptor_exports;
   lastReferenceValue,
   map,
   merge,
-  registerClient,
-  sourceValue,
-  updateClient
+  sourceValue
 });

package/dist/index.js

@@ -9,6 +9,7 @@ var Adaptor_exports = {};
 __export(Adaptor_exports, {
   as: () => as,
   createChannel: () => createChannel,
+  createClient: () => createClient,
   createEncounter: () => createEncounter,
   createTask: () => createTask,
   cursor: () => cursor,
@@ -28,9 +29,7 @@ __export(Adaptor_exports, {
   lastReferenceValue: () => lastReferenceValue,
   map: () => map,
   merge: () => merge,
-  registerClient: () => registerClient,
-  sourceValue: () => sourceValue,
-  updateClient: () => updateClient
+  sourceValue: () => sourceValue
 });
 import { execute as commonExecute } from "@openfn/language-common";
 import { expandReferences } from "@openfn/language-common/util";
@@ -142,7 +141,7 @@ function getClients(clientId) {
     return prepareNextState(state, response);
   };
 }
-function registerClient(body) {
+function createClient(body) {
   return async (state) => {
     const [resolvedBody] = expandReferences(state, body);
     const response = await request(
@@ -157,22 +156,6 @@ function registerClient(body) {
     return prepareNextState(state, response);
   };
 }
-function updateClient(body) {
-  return async (state) => {
-    const [resolvedBody] = expandReferences(state, body);
-    const { _id } = resolvedBody;
-    const response = await request(
-      state.configuration,
-      "PUT",
-      `/clients/${_id}`,
-      {
-        body: resolvedBody,
-        parseAs: "text"
-      }
-    );
-    return prepareNextState(state, response);
-  };
-}
 function getChannels(channelId) {
   return async (state) => {
     const [resolvedChannelId] = expandReferences(state, channelId);
@@ -270,6 +253,7 @@ var src_default = Adaptor_exports;
 export {
   as,
   createChannel,
+  createClient,
   createEncounter,
   createTask,
   cursor,
@@ -291,7 +275,5 @@ export {
   lastReferenceValue,
   map,
   merge,
-  registerClient,
-  sourceValue,
-  updateClient
+  sourceValue
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openfn/language-openhim",
   "label": "OpenHIM",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "description": "OpenFn adaptor for OpenHIM",
   "main": "dist/index.cjs",
   "author": "Open Function Group",
@@ -15,7 +15,7 @@
   "dependencies": {
     "JSONPath": "^0.10.0",
     "lodash-fp": "^0.10.4",
-    "@openfn/language-common": "3.0.2"
+    "@openfn/language-common": "3.0.3"
   },
   "devDependencies": {
     "assertion-error": "^1.1.0",

package/types/Adaptor.d.ts

@@ -74,7 +74,7 @@ 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({
+ * createClient({
  *  roles: ['fhir'],
  *  clientID: 'fhir-server-7',
  *  name: 'FHIR Server',
@@ -89,27 +89,7 @@ export function getClients(clientId: string): Operation;
  * @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;
+export function createClient(body: object): Operation;
 /**
  * Make a request to OpenHIM to get all channel records
  * @example <caption>Get all channels</caption>
@@ -167,6 +147,8 @@ export function createChannel(body: object): Operation;
 /**
  * Make a request to OpenHIM to get all tasks
  * @example <caption>Get all tasks</caption>
+ * getTasks()
+ * @example <caption>Get all tasks with pagination options</caption>
  * getTasks({
  *   filterLimit: 10,
  *   filterPage: 0,