@awell-health/awell-extensions 1.0.152 → 1.0.154

package/dist/extensions/collectData/index.js

@@ -6,15 +6,15 @@ const actions_1 = require("./v1/actions");
 const settings_1 = require("./settings");
 exports.CollectData = {
     key: 'collectData',
-    title: 'Collect Data',
+    title: 'Advanced data collection',
     icon_url: 'https://res.cloudinary.com/da7x4rzl4/image/upload/v1678870116/Awell%20Extensions/Awell_Logo.png',
-    description: 'Collect data from users to ingest into care flows',
+    description: 'This extension allows you to collect data from your users using a variety of more advanced input types and data sources.',
     category: extensions_core_1.Category.FORMS,
     author: {
         authorType: extensions_core_1.AuthorType.AWELL,
     },
     actions: {
-        remoteSingleSelect: actions_1.remoteSingleSelect
+        remoteSingleSelect: actions_1.remoteSingleSelect,
     },
     settings: settings_1.settings,
 };

package/dist/extensions/collectData/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../extensions/collectData/index.ts"],"names":[],"mappings":";;;AACA,mEAAoE;AACpE,0CAEqB;AACrB,yCAAqC;AAExB,QAAA,WAAW,GAAc;IACpC,GAAG,EAAE,aAAa;IAClB,KAAK,EAAE,cAAc;IACrB,QAAQ,EACN,iGAAiG;IACnG,WAAW,EACT,mDAAmD;IACrD,QAAQ,EAAE,0BAAQ,CAAC,KAAK;IACxB,MAAM,EAAE;QACN,UAAU,EAAE,4BAAU,CAAC,KAAK;KAC7B;IACD,OAAO,EAAE;QACP,kBAAkB,EAAlB,4BAAkB;KACnB;IACD,QAAQ,EAAR,mBAAQ;CACT,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../extensions/collectData/index.ts"],"names":[],"mappings":";;;AACA,mEAAoE;AACpE,0CAAiD;AACjD,yCAAqC;AAExB,QAAA,WAAW,GAAc;IACpC,GAAG,EAAE,aAAa;IAClB,KAAK,EAAE,0BAA0B;IACjC,QAAQ,EACN,iGAAiG;IACnG,WAAW,EACT,0HAA0H;IAC5H,QAAQ,EAAE,0BAAQ,CAAC,KAAK;IACxB,MAAM,EAAE;QACN,UAAU,EAAE,4BAAU,CAAC,KAAK;KAC7B;IACD,OAAO,EAAE;QACP,kBAAkB,EAAlB,4BAAkB;KACnB;IACD,QAAQ,EAAR,mBAAQ;CACT,CAAA"}

package/dist/extensions/collectData/v1/actions/remoteSingleSelect/config/fields.d.ts

@@ -8,6 +8,13 @@ export declare const fields: {
         type: FieldType.STRING;
         required: true;
     };
+    mandatory: {
+        id: string;
+        label: string;
+        description: string;
+        type: FieldType.BOOLEAN;
+        required: true;
+    };
     url: {
         id: string;
         label: string;
@@ -29,13 +36,6 @@ export declare const fields: {
         type: FieldType.STRING;
         required: false;
     };
-    mandatory: {
-        id: string;
-        label: string;
-        description: string;
-        type: FieldType.BOOLEAN;
-        required: true;
-    };
 };
 export declare const FieldsValidationSchema: z.ZodObject<{
     label: z.ZodString;

package/dist/extensions/collectData/v1/actions/remoteSingleSelect/config/fields.js

@@ -7,39 +7,39 @@ const validation_1 = require("../../../../../sendbird/v1/validation");
 exports.fields = {
     label: {
         id: 'label',
-        label: 'Label text',
+        label: 'Select - Label',
         description: 'Enter the label text that will be displayed before the selector.',
         type: extensions_core_1.FieldType.STRING,
         required: true,
     },
+    mandatory: {
+        id: 'mandatory',
+        label: 'Select - Response required?',
+        description: 'The user must select an option before continuing.',
+        type: extensions_core_1.FieldType.BOOLEAN,
+        required: true,
+    },
     url: {
         id: 'url',
-        label: 'Options endpoint URL',
-        description: 'Enter the URL where the options to display in the selector can be fetched. The endpoint must return an array of objects with the following properties: `label` and `value`.',
+        label: 'Options - Endpoint URL',
+        description: 'Enter the URL (starting with `https://`) where the options to display can be fetched. The endpoint must return an array of objects with the following properties: `id`, `label` and `value`.',
         type: extensions_core_1.FieldType.STRING,
         required: true,
     },
     headers: {
         id: 'headers',
-        label: 'Options endpoint headers',
+        label: 'Options - Headers',
         description: 'Enter the headers to send to the options source URL. The headers must be in JSON format.',
         type: extensions_core_1.FieldType.JSON,
         required: false,
     },
     queryParam: {
         id: 'queryParam',
-        label: 'Options endpoint search query param key',
+        label: 'Options - Search query param',
         description: 'Enter the key of the free text search query param if the endpoint supports this e.g. `search` for `https://example.com/options?search=foo`.',
         type: extensions_core_1.FieldType.STRING,
         required: false,
     },
-    mandatory: {
-        id: 'mandatory',
-        label: 'Is response required?',
-        description: 'The user must select an option before continuing.',
-        type: extensions_core_1.FieldType.BOOLEAN,
-        required: true,
-    },
 };
 exports.FieldsValidationSchema = zod_1.z.object({
     label: zod_1.z.string().nonempty(),

package/dist/extensions/collectData/v1/actions/remoteSingleSelect/config/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../../../../extensions/collectData/v1/actions/remoteSingleSelect/config/fields.ts"],"names":[],"mappings":";;;AAAA,6BAAwC;AACxC,mEAIsC;AACtC,sEAAkF;AAErE,QAAA,MAAM,GAAG;IACpB,KAAK,EAAE;QACL,EAAE,EAAE,OAAO;QACX,KAAK,EAAE,YAAY;QACnB,WAAW,EACT,kEAAkE;QACpE,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;KACf;IACD,GAAG,EAAE;QACH,EAAE,EAAE,KAAK;QACT,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EACT,6KAA6K;QAC/K,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,EAAE,EAAE,SAAS;QACb,KAAK,EAAE,0BAA0B;QACjC,WAAW,EACT,0FAA0F;QAC5F,IAAI,EAAE,2BAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,KAAK;KAChB;IACD,UAAU,EAAE;QACV,EAAE,EAAE,YAAY;QAChB,KAAK,EAAE,yCAAyC;QAChD,WAAW,EACT,6IAA6I;QAC/I,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,KAAK;KAChB;IACD,SAAS,EAAE;QACT,EAAE,EAAE,WAAW;QACf,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EAAE,mDAAmD;QAChE,IAAI,EAAE,2BAAS,CAAC,OAAO;QACvB,QAAQ,EAAE,IAAI;KACf;CAC8B,CAAA;AAEpB,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,OAAO,EAAE,IAAA,oCAAkB,EAAC,uCAA0B,CAAC;IACvD,UAAU,EAAE,IAAA,oCAAkB,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAC1C,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;CAC2B,CAAC,CAAA;AAE7C,MAAM,oBAAoB,GAAG,CAClC,MAAe,EACyB,EAAE;IAC1C,MAAM,UAAU,GAAG,8BAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAEvD,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AANY,QAAA,oBAAoB,wBAMhC"}
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../../../../extensions/collectData/v1/actions/remoteSingleSelect/config/fields.ts"],"names":[],"mappings":";;;AAAA,6BAAwC;AACxC,mEAIsC;AACtC,sEAAkF;AAErE,QAAA,MAAM,GAAG;IACpB,KAAK,EAAE;QACL,EAAE,EAAE,OAAO;QACX,KAAK,EAAE,gBAAgB;QACvB,WAAW,EACT,kEAAkE;QACpE,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,EAAE,EAAE,WAAW;QACf,KAAK,EAAE,6BAA6B;QACpC,WAAW,EAAE,mDAAmD;QAChE,IAAI,EAAE,2BAAS,CAAC,OAAO;QACvB,QAAQ,EAAE,IAAI;KACf;IACD,GAAG,EAAE;QACH,EAAE,EAAE,KAAK;QACT,KAAK,EAAE,wBAAwB;QAC/B,WAAW,EACT,8LAA8L;QAChM,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,EAAE,EAAE,SAAS;QACb,KAAK,EAAE,mBAAmB;QAC1B,WAAW,EACT,0FAA0F;QAC5F,IAAI,EAAE,2BAAS,CAAC,IAAI;QACpB,QAAQ,EAAE,KAAK;KAChB;IACD,UAAU,EAAE;QACV,EAAE,EAAE,YAAY;QAChB,KAAK,EAAE,8BAA8B;QACrC,WAAW,EACT,6IAA6I;QAC/I,IAAI,EAAE,2BAAS,CAAC,MAAM;QACtB,QAAQ,EAAE,KAAK;KAChB;CAC8B,CAAA;AAEpB,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,OAAO,EAAE,IAAA,oCAAkB,EAAC,uCAA0B,CAAC;IACvD,UAAU,EAAE,IAAA,oCAAkB,EAAC,OAAC,CAAC,MAAM,EAAE,CAAC;IAC1C,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE;CAC2B,CAAC,CAAA;AAE7C,MAAM,oBAAoB,GAAG,CAClC,MAAe,EACyB,EAAE;IAC1C,MAAM,UAAU,GAAG,8BAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAEvD,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AANY,QAAA,oBAAoB,wBAMhC"}

package/dist/extensions/collectData/v1/actions/remoteSingleSelect/remoteSingleSelect.js

@@ -8,8 +8,8 @@ const zod_validation_error_1 = require("zod-validation-error");
 const zod_1 = require("zod");
 exports.remoteSingleSelect = {
     key: 'remoteSingleSelect',
-    title: 'Remote Single Select',
-    description: 'Allow a stakeholder to select a single option from a set fetched from an API endpoint',
+    title: 'Dynamic choice selector',
+    description: 'The dynamic choice selector allow you to set up a select question where the available choices are dynamically populated through an API lookup',
     category: extensions_core_1.Category.FORMS,
     fields: config_1.fields,
     dataPoints: config_1.dataPoints,
@@ -23,6 +23,9 @@ exports.remoteSingleSelect = {
     onActivityCreated: async (payload, onComplete, onError) => {
         try {
             (0, fields_1.validateActionFields)(payload.fields);
+            /**
+             * Completion happens in Awell Hosted Pages
+             */
         }
         catch (err) {
             if (err instanceof zod_1.ZodError) {

package/dist/extensions/collectData/v1/actions/remoteSingleSelect/remoteSingleSelect.js.map

@@ -1 +1 @@
-{"version":3,"file":"remoteSingleSelect.js","sourceRoot":"","sources":["../../../../../../extensions/collectData/v1/actions/remoteSingleSelect/remoteSingleSelect.ts"],"names":[],"mappings":";;;AACA,qCAA6C;AAC7C,mEAAwD;AAExD,4CAAsD;AACtD,+DAAmD;AACnD,6BAA8B;AAEjB,QAAA,kBAAkB,GAA2C;IACxE,GAAG,EAAE,oBAAoB;IACzB,KAAK,EAAE,sBAAsB;IAC7B,WAAW,EACT,uFAAuF;IACzF,QAAQ,EAAE,0BAAQ,CAAC,KAAK;IACxB,MAAM,EAAN,eAAM;IACN,UAAU,EAAV,mBAAU;IACV,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;SACf;KACF;IACD,WAAW,EAAE,KAAK;IAClB,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE;QACxD,IAAI;YACF,IAAA,6BAAoB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SACrC;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,cAAQ,EAAE;gBAC3B,MAAM,KAAK,GAAG,IAAA,mCAAY,EAAC,GAAG,CAAC,CAAA;gBAC/B,MAAM,OAAO,CAAC;oBACZ,MAAM,EAAE;wBACN;4BACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;4BAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE;4BACxB,KAAK,EAAE;gCACL,QAAQ,EAAE,aAAa;gCACvB,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE;6BAC5B;yBACF;qBACF;iBACF,CAAC,CAAA;gBACF,OAAM;aACP;YAED,MAAM,KAAK,GAAG,GAAY,CAAA;YAC1B,MAAM,OAAO,CAAC;gBACZ,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,qDAAqD,EAAE;wBACnE,KAAK,EAAE;4BACL,QAAQ,EAAE,cAAc;4BACxB,OAAO,EAAE,KAAK,CAAC,OAAO;yBACvB;qBACF;iBACF;aACF,CAAC,CAAA;SACH;IACH,CAAC;CACF,CAAA"}
+{"version":3,"file":"remoteSingleSelect.js","sourceRoot":"","sources":["../../../../../../extensions/collectData/v1/actions/remoteSingleSelect/remoteSingleSelect.ts"],"names":[],"mappings":";;;AACA,qCAA6C;AAC7C,mEAAwD;AAExD,4CAAsD;AACtD,+DAAmD;AACnD,6BAA8B;AAEjB,QAAA,kBAAkB,GAA2C;IACxE,GAAG,EAAE,oBAAoB;IACzB,KAAK,EAAE,yBAAyB;IAChC,WAAW,EACT,+IAA+I;IACjJ,QAAQ,EAAE,0BAAQ,CAAC,KAAK;IACxB,MAAM,EAAN,eAAM;IACN,UAAU,EAAV,mBAAU;IACV,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;SACf;KACF;IACD,WAAW,EAAE,KAAK;IAClB,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE;QACxD,IAAI;YACF,IAAA,6BAAoB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAEpC;;eAEG;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,cAAQ,EAAE;gBAC3B,MAAM,KAAK,GAAG,IAAA,mCAAY,EAAC,GAAG,CAAC,CAAA;gBAC/B,MAAM,OAAO,CAAC;oBACZ,MAAM,EAAE;wBACN;4BACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;4BAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,IAAI,EAAE;4BACxB,KAAK,EAAE;gCACL,QAAQ,EAAE,aAAa;gCACvB,OAAO,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE;6BAC5B;yBACF;qBACF;iBACF,CAAC,CAAA;gBACF,OAAM;aACP;YAED,MAAM,KAAK,GAAG,GAAY,CAAA;YAC1B,MAAM,OAAO,CAAC;gBACZ,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;wBAC9B,IAAI,EAAE,EAAE,EAAE,EAAE,qDAAqD,EAAE;wBACnE,KAAK,EAAE;4BACL,QAAQ,EAAE,cAAc;4BACxB,OAAO,EAAE,KAAK,CAAC,OAAO;yBACvB;qBACF;iBACF;aACF,CAAC,CAAA;SACH;IACH,CAAC;CACF,CAAA"}

package/dist/extensions/markdown.json

@@ -28,7 +28,7 @@
     "changelog": "# CM.com changelog\n"
   },
   "collectData": {
-    "readme": "---\ntitle: Collect Data\ndescription: Collect data from your users using a variety of input types and data sources\n---\n\n# Collect Data\n\nThe Collect Data extension allows you to collect data from your users using a variety of input types and data sources.\n\n## Extension settings\n\nIn order to set up this extension, no settings are required.\n\n## Custom Actions\n\n### Remote Single Select\n\nThe Remote Single Select action allows you to create a single select input that is populated with data from a remote data source. The data source must be a REST API.\n",
+    "readme": "---\ntitle: Advanced data collection\ndescription: Collect data from your users using a variety of input types and data sources\n---\n\nThis extension allows you to collect data from your users using a variety of more advanced input types and data sources.\n\n## Extension settings\n\nIn order to set up this extension, no settings are required.\n\n## Custom Actions\n\n### Remote Single Select\n\nStandard select questions in Awell forms have a discrete set of choices to select from that are defined at the time that the form is created. If the list of choices to present to your responders isn't known at the time the form is being built, or changes often, this action allows you to load choices dynamically from a remote data source.\n\nDynamically-loaded choices must adhere to the following format in a list form (i.e. an array):\n\n```json\n{\n  \"id\": \"unique-id\",\n  \"label\": \"Choice label\",\n  \"value\": \"Choice value\"\n}\n```\n\nAdditionally, you can specify a free text search field (`Options - Search query param` field) to allow users to search through the choices. This is optional but highly recommended. If not specified, the choices will be fetched on question load and presented in a static list that cannot be filtered.\n\nAs an example, using the endpoint `https://example.com/choices` with a query parameter `search` (e.g. `https://example.com/choices?search=QUERY` where `QUERY` is whatever the user typed into the input), then the API is expected to return the choices based on that match the search term.\n\nWe recommend that your search logic returns an _alphabetically-sorted_ list of all options where the _lowercase_ label names _contain_ the _lowercase_ search term.\n\n```js\n// Example search logic\nconst searchTerm = req.query.search\nconst results = []\n\noptions.forEach((option) => {\n  if (option.label.toLowerCase().includes(searchTerm.toLowerCase())) {\n    results.push({\n      label: option.label,\n      value: option.value,\n      id: option.id,\n    })\n  }\n})\n\nconst sortedResults = results.sort((a, b) => a.label.localeCompare(b.label))\nres.json(results)\n```\n",
     "changelog": "# Collect Data changelog\n"
   },
   "docuSign": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awell-health/awell-extensions",
-  "version": "1.0.152",
+  "version": "1.0.154",
   "packageManager": "yarn@3.4.1",
   "main": "dist/src/index.js",
   "repository": {