@openfn/language-satusehat 2.0.5 → 2.0.7

package/ast.json

@@ -8,7 +8,7 @@
         "callback"
       ],
       "docs": {
-        "description": "Make a GET request to Satusehat",
+        "description": "Make a GET request to Satusehat. Use this to fetch resources directly from the Satusehat REST API.\nYou can pass Satusehat query parameters as an object of key value pairs, which will map to parameters\nin the URL.",
         "tags": [
           {
             "title": "public",
@@ -17,7 +17,13 @@
           },
           {
             "title": "example",
-            "description": "get(\"Organization\", {\"name\": \"somename\"})"
+            "description": "get(\"Organization/abcde\")",
+            "caption": "Get a resource by Id. Equivalent to GET `<baseUrl>/Organization/abcde`"
+          },
+          {
+            "title": "example",
+            "description": "get('/Patient', {\n  identifier:'https://fhir.kemkes.go.id/id/nik|9271060312000001'\n});",
+            "caption": "Get resources with a query. Equivalent to GET `<baseUrl>/Patient?identifier=https://fhir.kemkes.go.id/id/nik|9271060312000001`"
           },
           {
             "title": "function",
@@ -35,7 +41,7 @@
           },
           {
             "title": "param",
-            "description": "Optional request params such as name.",
+            "description": "Optional object of query parameters to include in the request",
             "type": {
               "type": "NameExpression",
               "name": "object"
@@ -58,6 +64,10 @@
               "type": "NameExpression",
               "name": "Operation"
             }
+          },
+          {
+            "title": "state",
+            "description": "{SatusehatHttpState}"
           }
         ]
       },
@@ -72,11 +82,12 @@
         "callback"
       ],
       "docs": {
-        "description": "Make a POST request to Satusehat",
+        "description": "Make a POST request to Satusehat. Use this to send resources directly to Satusehat REST API.\nYou can pass Satusehat body data as a JSON FHIR object.",
         "tags": [
           {
             "title": "example",
-            "description": "post(\n  \"Organization\",\n { \"resourceType\": \"Organization\", \"active\": true,\n }\n);"
+            "description": "post('Encounter', { resourceType: 'Encounter', ...state.data });",
+            "caption": "Create an encounter resource. Equivalent to POST `<baseUrl>/Encounter`"
           },
           {
             "title": "function",
@@ -99,7 +110,7 @@
           },
           {
             "title": "param",
-            "description": "Object or JSON which defines data that will be used to create a given instance of resource",
+            "description": "JSON FHIR object to create a resource",
             "type": {
               "type": "NameExpression",
               "name": "object"
@@ -108,7 +119,7 @@
           },
           {
             "title": "param",
-            "description": "Optional request params.",
+            "description": "Optional object of query parameters to include in the request",
             "type": {
               "type": "NameExpression",
               "name": "Object"
@@ -134,6 +145,10 @@
               "type": "NameExpression",
               "name": "Operation"
             }
+          },
+          {
+            "title": "state",
+            "description": "{SatusehatHttpState}"
           }
         ]
       },
@@ -148,11 +163,12 @@
         "callback"
       ],
       "docs": {
-        "description": "Make a PUT request to Satusehat",
+        "description": "Make a PUT request to Satusehat. Use this to directly update resources on Satusehat REST API.\nYou can pass Satusehat body data as a JSON FHIR object. You can also pass Satusehat query parameters as an object of key value pairs, which will map to parameters\nin the URL.",
         "tags": [
           {
             "title": "example",
-            "description": "put(\n  \"Organization/123\",\n { \"resourceType\": \"Organization\", \"active\": false,\n }\n);"
+            "description": "put('Organization/abcde', { resourceType: 'Organization', active: false });",
+            "caption": "Update a resource. Equivalent to PUT `<baseurl>/Organization/abcde`"
           },
           {
             "title": "function",
@@ -175,7 +191,7 @@
           },
           {
             "title": "param",
-            "description": "Object or JSON which defines data that will be used to update a given instance of resource",
+            "description": "JSON FHIR object to update the resource",
             "type": {
               "type": "NameExpression",
               "name": "object"
@@ -184,7 +200,7 @@
           },
           {
             "title": "param",
-            "description": "Optional request params.",
+            "description": "Optional object of query parameters to include in the request",
             "type": {
               "type": "NameExpression",
               "name": "Object"
@@ -210,6 +226,10 @@
               "type": "NameExpression",
               "name": "Operation"
             }
+          },
+          {
+            "title": "state",
+            "description": "{SatusehatHttpState}"
           }
         ]
       },
@@ -224,11 +244,12 @@
         "callback"
       ],
       "docs": {
-        "description": "Make a PATCH request to Satusehat",
+        "description": "Make a PATCH request to Satusehat. Use this to directly update resources on Satusehat REST API.\nYou can pass Satusehat an array of objects which contains `op`, `path`, and `value` as the body. You can also pass Satusehat query parameters as an object of key value pairs, which will map to parameters\nin the URL.",
         "tags": [
           {
             "title": "example",
-            "description": "patch(\n  \"Organization/123\",\n   [{\n\"op\": \"replace\", // Operation - `replace` is the only one used to change a specific property or element\n \"path\": \"/language\", // Path - The name of property/element of resource to be replaced\n \"value\": \"id\" // Value- The value to be replaced\n}]\n\n);"
+            "description": "patch('Organization/abcde', [\n{\n op: 'replace',\n path: '/language', // Name of property/element of resource to be replaced\n value: 'id', // Value to be replaced\n},\n]);",
+            "caption": "Update a property of a resource. Equivalent to PATCH `<baseurl>/Organization/abcde`"
           },
           {
             "title": "function",
@@ -260,7 +281,7 @@
           },
           {
             "title": "param",
-            "description": "Optional request params.",
+            "description": "Optional object of query parameters to include in the request.",
             "type": {
               "type": "NameExpression",
               "name": "Object"
@@ -286,6 +307,10 @@
               "type": "NameExpression",
               "name": "Operation"
             }
+          },
+          {
+            "title": "state",
+            "description": "{SatusehatHttpState}"
           }
         ]
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-satusehat",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "OpenFn Satusehat adaptor",
   "type": "module",
   "exports": {
@@ -20,7 +20,7 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "2.1.1"
+    "@openfn/language-common": "2.2.0"
   },
   "devDependencies": {
     "assertion-error": "2.0.0",

package/types/Adaptor.d.ts

@@ -1,3 +1,10 @@
+/**
+ * State object
+ * @typedef {Object} SatusehatHttpState
+ * @property data - The response body (as JSON)
+ * @property response - The HTTP response from the Satusehat server (excluding the body)
+ * @property references - An array of all previous data objects used in the Job
+ */
 /**
  * Execute a sequence of operations.
  * Wraps `language-common/execute` to make working with this API easier.
@@ -12,70 +19,92 @@
  */
 export function execute(...operations: Operations): Operation;
 /**
- * Make a GET request to Satusehat
+ * Make a GET request to Satusehat. Use this to fetch resources directly from the Satusehat REST API.
+ * You can pass Satusehat query parameters as an object of key value pairs, which will map to parameters
+ * in the URL.
  * @public
- * @example
- * get("Organization", {"name": "somename"})
+ * @example  <caption>Get a resource by Id. Equivalent to GET `<baseUrl>/Organization/abcde`</caption>
+ * get("Organization/abcde")
+ * @example <caption>Get resources with a query. Equivalent to GET `<baseUrl>/Patient?identifier=https://fhir.kemkes.go.id/id/nik|9271060312000001`</caption>
+ * get('/Patient', {
+ *   identifier:'https://fhir.kemkes.go.id/id/nik|9271060312000001'
+ * });
  * @function
  * @param {string} path - Path to resource
- * @param {object} params - Optional request params such as name.
+ * @param {object} params - Optional object of query parameters to include in the request
  * @param {function} callback - An optional callback to handle the response
  * @returns {Operation}
+ * @state {SatusehatHttpState}
  */
 export function get(path: string, params?: object, callback?: Function): Operation;
 /**
- * Make a POST request to Satusehat
- * @example
- * post(
- *   "Organization",
- *  { "resourceType": "Organization", "active": true,
- *  }
- * );
+ * Make a POST request to Satusehat. Use this to send resources directly to Satusehat REST API.
+ * You can pass Satusehat body data as a JSON FHIR object.
+ * @example <caption>Create an encounter resource. Equivalent to POST `<baseUrl>/Encounter`</caption>
+ * post('Encounter', { resourceType: 'Encounter', ...state.data });
  * @function
  * @public
  * @param {string} path - Path to resource
- * @param {object} data - Object or JSON which defines data that will be used to create a given instance of resource
- * @param {Object} params - Optional request params.
+ * @param {object} data - JSON FHIR object to create a resource
+ * @param {Object} params - Optional object of query parameters to include in the request
  * @param {function} [callback] - Optional callback to handle the response
  * @returns {Operation}
+ * @state {SatusehatHttpState}
  */
 export function post(path: string, data: object, params?: any, callback?: Function): Operation;
 /**
- * Make a PUT request to Satusehat
- * @example
- * put(
- *   "Organization/123",
- *  { "resourceType": "Organization", "active": false,
- *  }
- * );
+ * Make a PUT request to Satusehat. Use this to directly update resources on Satusehat REST API.
+ * You can pass Satusehat body data as a JSON FHIR object. You can also pass Satusehat query parameters as an object of key value pairs, which will map to parameters
+ * in the URL.
+ * @example <caption>Update a resource. Equivalent to PUT `<baseurl>/Organization/abcde`</caption>
+ * put('Organization/abcde', { resourceType: 'Organization', active: false });
  * @function
  * @public
  * @param {string} path - Path to resource and exact item to be updated
- * @param {object} data - Object or JSON which defines data that will be used to update a given instance of resource
- * @param {Object} params - Optional request params.
+ * @param {object} data - JSON FHIR object to update the resource
+ * @param {Object} params - Optional object of query parameters to include in the request
  * @param {function} [callback] - Optional callback to handle the response
  * @returns {Operation}
+ * @state {SatusehatHttpState}
  */
 export function put(path: string, data: object, params?: any, callback?: Function): Operation;
 /**
- * Make a PATCH request to Satusehat
- * @example
- * patch(
- *   "Organization/123",
- *    [{
- * "op": "replace", // Operation - `replace` is the only one used to change a specific property or element
- *  "path": "/language", // Path - The name of property/element of resource to be replaced
- *  "value": "id" // Value- The value to be replaced
- *}]
- *
- * );
+ * Make a PATCH request to Satusehat. Use this to directly update resources on Satusehat REST API.
+ * You can pass Satusehat an array of objects which contains `op`, `path`, and `value` as the body. You can also pass Satusehat query parameters as an object of key value pairs, which will map to parameters
+ * in the URL.
+ * @example <caption>Update a property of a resource. Equivalent to PATCH `<baseurl>/Organization/abcde`</caption>
+ * patch('Organization/abcde', [
+ * {
+ *  op: 'replace',
+ *  path: '/language', // Name of property/element of resource to be replaced
+ *  value: 'id', // Value to be replaced
+ * },
+ * ]);
  * @function
  * @public
  * @param {string} path - Path to resource and exact item to be partially updated
  * @param {Array} data - An array of objects which defines data that will be used to partially update a given instance of resource
- * @param {Object} params - Optional request params.
+ * @param {Object} params - Optional object of query parameters to include in the request.
  * @param {function} [callback] - Optional callback to handle the response
  * @returns {Operation}
+ * @state {SatusehatHttpState}
  */
 export function patch(path: string, data: any[], params?: any, callback?: Function): Operation;
+/**
+ * State object
+ */
+export type SatusehatHttpState = {
+    /**
+     * - The response body (as JSON)
+     */
+    data: any;
+    /**
+     * - The HTTP response from the Satusehat server (excluding the body)
+     */
+    response: any;
+    /**
+     * - An array of all previous data objects used in the Job
+     */
+    references: any;
+};
 export { fn, fnIf, alterState, arrayToString, combine, dataPath, dataValue, each, field, fields, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";