@extrahorizon/javascript-sdk 8.4.1 → 8.5.0-dev-71-b217382

package/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.5.0]
+
+### Fixed
+- Corrected `functioName` field to `functionName` in the `TransitionActionTask` type
+- `exh.templates.findFirst`, `findById` and `findByName` now correctly state `undefined` can be returned
+
+### Added
+- Added `exh.data.documents.unlinkAllUsers` and `unlinkAllGroups` methods to unlink all users or groups from a document
+- Added `priority` field to the `TransitionActionTask` type
+- Added `TransitionActionTask` to the `AfterActions`
+- Added `TRANSITION_DOCUMENTS` permission to the `GlobalPermissionName` enum
+- Added `TRANSITION_DOCUMENTS` permission to the documentation of the transition document function
+
+### Changed
+- RQL `contains` and `excludes` now have their different variations better separated in the type definitions
+- `exh.data.documents.unlinkUsers` and `unlinkGroups` now also accept an array of user or group ids directly rather than nested in a request body object
+  - Thanks to `tran-simon` for the pointing out the initially incorrect `unlinkUsers` type definition!
+
+### Deprecated
+- `exh.data.documents.unlinkUsers` usage with an object is deprecated in favor of an array of ids directly or `unlinkAllUsers` for unlinking all users
+- `exh.data.documents.unlinkGroups` usage with an object is deprecated in favor of an array of ids directly or `unlinkAllGroups` for unlinking all groups
+
 ## [8.4.1]
 
 ### Fixed

package/build/index.cjs.js

@@ -1070,6 +1070,7 @@ exports.GlobalPermissionName = void 0;
     GlobalPermissionName["SEND_MAILS"] = "SEND_MAILS";
     GlobalPermissionName["SYNC_PROFILE_GROUPS"] = "SYNC_PROFILE_GROUPS";
     GlobalPermissionName["TRANSFER_PERIOD"] = "TRANSFER_PERIOD";
+    GlobalPermissionName["TRANSITION_DOCUMENTS"] = "TRANSITION_DOCUMENTS";
     GlobalPermissionName["TRIGGER_APP_STORE_SUBSCRIPTION_REEVALUATION"] = "TRIGGER_APP_STORE_SUBSCRIPTION_REEVALUATION";
     GlobalPermissionName["TRIGGER_PLAY_STORE_SUBSCRIPTION_REEVALUATION"] = "TRIGGER_PLAY_STORE_SUBSCRIPTION_REEVALUATION";
     GlobalPermissionName["UNLINK_USER_FROM_OIDC"] = "UNLINK_USER_FROM_OIDC";
@@ -1207,8 +1208,6 @@ exports.GlobalPermissionName = void 0;
     /** @deprecated Not in use any longer */
     GlobalPermissionName["MANAGE_SERVICE_ALERTS"] = "MANAGE_SERVICE_ALERTS";
     /** @deprecated Not in use any longer */
-    GlobalPermissionName["TRANSITION_DOCUMENTS"] = "TRANSITION_DOCUMENTS";
-    /** @deprecated Not in use any longer */
     GlobalPermissionName["VIEW_AWS_SES_STATISTICS"] = "VIEW_AWS_SES_STATISTICS";
     /** @deprecated Not in use any longer */
     GlobalPermissionName["CREATE_USER_PERIODS"] = "CREATE_USER_PERIODS";
@@ -3603,15 +3602,23 @@ var documents = (client, httpAuth) => {
         async linkGroups(schemaIdOrName, documentId, requestBody, options) {
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/linkGroups`, requestBody, options)).data;
         },
-        async unlinkGroups(schemaIdOrName, documentId, requestBody, options) {
+        async unlinkGroups(schemaIdOrName, documentId, data, options) {
+            const requestBody = Array.isArray(data) ? { groupIds: data } : data;
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/unlinkGroups`, requestBody, options)).data;
         },
+        async unlinkAllGroups(schemaIdOrName, documentId, options) {
+            return await this.unlinkGroups(schemaIdOrName, documentId, {}, options); // Empty object to remove all groups
+        },
         async linkUsers(schemaIdOrName, documentId, requestBody, options) {
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/linkUsers`, requestBody, options)).data;
         },
-        async unlinkUsers(schemaIdOrName, documentId, requestBody, options) {
+        async unlinkUsers(schemaIdOrName, documentId, data, options) {
+            const requestBody = Array.isArray(data) ? { userIds: data } : data;
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/unlinkUsers`, requestBody, options)).data;
         },
+        async unlinkAllUsers(schemaIdOrName, documentId, options) {
+            return await this.unlinkUsers(schemaIdOrName, documentId, {}, options); // Empty object to remove all users
+        },
     };
 };
 
@@ -5368,7 +5375,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.4.1';
+const version = '8.5.0-dev-71-b217382';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -1040,6 +1040,7 @@ var GlobalPermissionName;
     GlobalPermissionName["SEND_MAILS"] = "SEND_MAILS";
     GlobalPermissionName["SYNC_PROFILE_GROUPS"] = "SYNC_PROFILE_GROUPS";
     GlobalPermissionName["TRANSFER_PERIOD"] = "TRANSFER_PERIOD";
+    GlobalPermissionName["TRANSITION_DOCUMENTS"] = "TRANSITION_DOCUMENTS";
     GlobalPermissionName["TRIGGER_APP_STORE_SUBSCRIPTION_REEVALUATION"] = "TRIGGER_APP_STORE_SUBSCRIPTION_REEVALUATION";
     GlobalPermissionName["TRIGGER_PLAY_STORE_SUBSCRIPTION_REEVALUATION"] = "TRIGGER_PLAY_STORE_SUBSCRIPTION_REEVALUATION";
     GlobalPermissionName["UNLINK_USER_FROM_OIDC"] = "UNLINK_USER_FROM_OIDC";
@@ -1177,8 +1178,6 @@ var GlobalPermissionName;
     /** @deprecated Not in use any longer */
     GlobalPermissionName["MANAGE_SERVICE_ALERTS"] = "MANAGE_SERVICE_ALERTS";
     /** @deprecated Not in use any longer */
-    GlobalPermissionName["TRANSITION_DOCUMENTS"] = "TRANSITION_DOCUMENTS";
-    /** @deprecated Not in use any longer */
     GlobalPermissionName["VIEW_AWS_SES_STATISTICS"] = "VIEW_AWS_SES_STATISTICS";
     /** @deprecated Not in use any longer */
     GlobalPermissionName["CREATE_USER_PERIODS"] = "CREATE_USER_PERIODS";
@@ -3573,15 +3572,23 @@ var documents = (client, httpAuth) => {
         async linkGroups(schemaIdOrName, documentId, requestBody, options) {
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/linkGroups`, requestBody, options)).data;
         },
-        async unlinkGroups(schemaIdOrName, documentId, requestBody, options) {
+        async unlinkGroups(schemaIdOrName, documentId, data, options) {
+            const requestBody = Array.isArray(data) ? { groupIds: data } : data;
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/unlinkGroups`, requestBody, options)).data;
         },
+        async unlinkAllGroups(schemaIdOrName, documentId, options) {
+            return await this.unlinkGroups(schemaIdOrName, documentId, {}, options); // Empty object to remove all groups
+        },
         async linkUsers(schemaIdOrName, documentId, requestBody, options) {
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/linkUsers`, requestBody, options)).data;
         },
-        async unlinkUsers(schemaIdOrName, documentId, requestBody, options) {
+        async unlinkUsers(schemaIdOrName, documentId, data, options) {
+            const requestBody = Array.isArray(data) ? { userIds: data } : data;
             return (await client.post(httpAuth, `/${schemaIdOrName}/documents/${documentId}/unlinkUsers`, requestBody, options)).data;
         },
+        async unlinkAllUsers(schemaIdOrName, documentId, options) {
+            return await this.unlinkUsers(schemaIdOrName, documentId, {}, options); // Empty object to remove all users
+        },
     };
 };
 
@@ -5338,7 +5345,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.4.1';
+const version = '8.5.0-dev-71-b217382';
 
 /**
  * Create ExtraHorizon client.

package/build/types/mockType.d.ts

@@ -132,8 +132,10 @@ export declare type MockClientOAuth1<MockFn> = {
             transition: MockFn;
             linkGroups: MockFn;
             unlinkGroups: MockFn;
+            unlinkAllGroups: MockFn;
             linkUsers: MockFn;
             unlinkUsers: MockFn;
+            unlinkAllUsers: MockFn;
         };
         transitions: {
             updateCreation: MockFn;
@@ -661,8 +663,10 @@ export declare type MockClientOAuth2<MockFn> = {
             transition: MockFn;
             linkGroups: MockFn;
             unlinkGroups: MockFn;
+            unlinkAllGroups: MockFn;
             linkUsers: MockFn;
             unlinkUsers: MockFn;
+            unlinkAllUsers: MockFn;
         };
         transitions: {
             updateCreation: MockFn;
@@ -1190,8 +1194,10 @@ export declare type MockClientProxy<MockFn> = {
             transition: MockFn;
             linkGroups: MockFn;
             unlinkGroups: MockFn;
+            unlinkAllGroups: MockFn;
             linkUsers: MockFn;
             unlinkUsers: MockFn;
+            unlinkAllUsers: MockFn;
         };
         transitions: {
             updateCreation: MockFn;

package/build/types/rql/types.d.ts

@@ -95,14 +95,15 @@ export interface RQLBuilder {
      */
     or: (...conditions: RQLString[]) => RQLBuilder;
     /**
-     * @description `contains(field)` only returns records having this field as property
+     * @description Only returns records having this field as property
      * @example
-     * await exh.data.documents.find(
-     *   schemaId,
-     *   { rql: rqlBuilder().contains('data.indicator').build()
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder().contains('data.indicator').build()
      * });
      * @returns returns documents containing the `data.indicator` field
-     *
+     */
+    contains(field: string): RQLBuilder;
+    /**
      * @description Filters for objects where the specified property's value is an array and the array contains
      * any value that equals the provided value or satisfies the provided condition.
      * `contains(field, itemField > 30)` only returns records having a property `field` which have a prop `itemField` for which the condition is valid
@@ -113,34 +114,39 @@ export interface RQLBuilder {
      *         .contains(
      *              "data",
      *              rqlBuilder().gt("heartrate", "60").intermediate(),
-     *                rqlBuilder().lt("heartrate", "90").intermediate()
+     *              rqlBuilder().lt("heartrate", "90").intermediate()
      *          )
-     *          .build();
+     *          .build(),
      * });
      * @return Only returns documents with a data object containing `heartrate > 60` and `heartrate > 90`
      */
-    contains: (field: string, ...conditions: RQLString[]) => RQLBuilder;
+    contains(field: string, ...conditions: RQLString[]): RQLBuilder;
     /**
-     * @description `excludes(field)` only returns records not having this field as property
+     * @description Only returns records not having this field as property
      * @example
-     * await exh.data.documents.find(
-     *   schemaId,
-     *   { rql: rqlBuilder().excludes('data.indicator').build()
+     * await exh.data.documents.find(schemaId, {
+     *   rql: rqlBuilder().excludes('data.indicator').build()
      * });
      * @returns returns documents not containing the `data.indicator` field
-     *
+     */
+    excludes(field: string): RQLBuilder;
+    /**
      * @description Filters for objects where the specified property's value is an array and the array excludes
      * any value that equals the provided value or satisfies the provided condition.
      * `excludes(field, itemField > 30)` only returns records having a property `field` which have a prop `itemField` for which the condition is invalid
      * @example
      * await exh.data.documents.find(schemaId, {
      *   rql: rqlBuilder()
-     *     .excludes("data", rqlBuilder().gt("heartrate", "60").intermediate())
-     *     .build(),
+     *         .excludes(
+     *              "data",
+     *              rqlBuilder().gt("heartrate", "60").intermediate(),
+     *              rqlBuilder().lt("heartrate", "90").intermediate()
+     *          )
+     *          .build(),
      * });
-     * @return Only returns documents excluding documents where `data.heartrate > 60`
+     * @return Only returns documents excluding documents where `heartrate > 60` and `heartrate > 90`
      */
-    excludes: (field: string, ...conditions: RQLString[]) => RQLBuilder;
+    excludes(field: string, ...conditions: RQLString[]): RQLBuilder;
     /**
      * @description skipCount() Skips the record counting step of a request to increase performance.
      *

package/build/types/services/data/types.d.ts

@@ -133,7 +133,8 @@ export interface TransitionActionRemoveItems {
 }
 export interface TransitionActionTask {
     type: 'task';
-    functioName: string;
+    functionName: string;
+    priority?: number;
     data: Record<string, unknown>;
 }
 export interface TransitionActionLinkCreator {
@@ -155,15 +156,22 @@ export interface TransitionActionDelay {
     type: 'delay';
     time: number;
 }
+/**
+ * @deprecated Legacy action, should not be used in new projects
+ */
 export interface TransitionActionMeasurementReviewedNotification {
     type: 'measurementReviewedNotification';
 }
-export declare type TransitionAction = TransitionActionSet | TransitionActionUnset | TransitionActionAddItems | TransitionActionRemoveItems | TransitionActionTask | TransitionActionLinkCreator | TransitionActionLinkEnlistedGroups | TransitionActionLinkUserFromData | TransitionActionLinkGroupFromData | TransitionActionDelay | TransitionActionMeasurementReviewedNotification;
-export interface TransitionAfterAction {
+/**
+ * @deprecated Legacy action, the AlgoQueueManager does not exist anymore
+ */
+export interface TransitionActionNotifyAlgoQueueManager {
     type: 'notifyAlgoQueueManager';
     id: string;
     version: string;
 }
+export declare type TransitionAction = TransitionActionSet | TransitionActionUnset | TransitionActionAddItems | TransitionActionRemoveItems | TransitionActionTask | TransitionActionLinkCreator | TransitionActionLinkEnlistedGroups | TransitionActionLinkUserFromData | TransitionActionLinkGroupFromData | TransitionActionDelay | TransitionActionMeasurementReviewedNotification;
+export declare type TransitionAfterAction = TransitionActionNotifyAlgoQueueManager | TransitionActionTask;
 export interface CreationTransition {
     toStatus: string;
     type: CreationTransitionType;
@@ -534,7 +542,10 @@ export interface DataDocumentsService {
      * - | - | -
      * none | | Update your own documents
      * none | `staff enlistment`  | Update all the documents belonging to the group
-     * `UPDATE_DOCUMENTS` | `global` | Update all the documents
+     * `UPDATE_DOCUMENTS` | `global` | Transition all the documents
+     * `TRANSITION_DOCUMENTS` | `global` | Transition all the documents
+     * `TRANSITION_DOCUMENTS:{SCHEMA_NAME}` | `global` | Transition all the documents of the specified schema
+     * `TRANSITION_DOCUMENTS:{SCHEMA_NAME}:{TRANSITION_NAME}` | `global` | Transition all the documents of the specified schema with the specified transition name
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody
@@ -563,6 +574,8 @@ export interface DataDocumentsService {
         groupIds: Array<ObjectId>;
     }, options?: OptionsBase): Promise<AffectedRecords>;
     /**
+     * @deprecated Use `unlinkGroups(schemaIdOrName, documentId, groupIds)` or `unlinkAllGroups(schemaIdOrName, documentId)` instead.
+     *
      * Unlink groups from a document
      *
      * Unlink the specified groups from a document
@@ -582,6 +595,26 @@ export interface DataDocumentsService {
     unlinkGroups(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: {
         groupIds?: Array<ObjectId>;
     }, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Unlink groups from a document
+     *
+     * Unlink the specified groups from a document
+     *
+     * Specifying an **empty** `groupIds` array will have **no effect** on the document.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     */
+    unlinkGroups(schemaIdOrName: ObjectId | string, documentId: ObjectId, groupIds: Array<ObjectId>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Unlink all groups from a document
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     */
+    unlinkAllGroups(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
     /**
      * Link users to a document
      *
@@ -601,6 +634,8 @@ export interface DataDocumentsService {
         userIds: Array<ObjectId>;
     }, options?: OptionsBase): Promise<AffectedRecords>;
     /**
+     * @deprecated Use `unlinkUsers(schemaIdOrName, documentId, userIds)` or `unlinkAllUsers(schemaIdOrName, documentId)` instead.
+     *
      * Unlink users from a document
      *
      * Unlink the specified users from a document.
@@ -620,8 +655,32 @@ export interface DataDocumentsService {
      * @returns AffectedRecords
      */
     unlinkUsers(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: {
-        userIds: Array<ObjectId>;
+        userIds?: Array<ObjectId>;
     }, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Unlink users from a document
+     *
+     * Unlink the specified users from a document.
+     *
+     * Specifying an **empty** `userIds` array will have **no effect** on the document.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     *
+     * Note: When GroupSyncMode.LINKED_USERS_PATIENT_ENLISTMENT is set for a document, all the groups where the specified user is enlisted as patient will also be removed from the document.
+     */
+    unlinkUsers(schemaIdOrName: ObjectId | string, documentId: ObjectId, userIds: Array<ObjectId>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Unlink all users from a document
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     *
+     * Note: When GroupSyncMode.LINKED_USERS_PATIENT_ENLISTMENT is set for a document, all the groups where the specified user is enlisted as patient will also be removed from the document.
+     */
+    unlinkAllUsers(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
 }
 export interface DataIndexesService {
     /**

package/build/types/services/templates/types.d.ts

@@ -89,23 +89,20 @@ export interface TemplatesService {
     /**
      * Find By Id
      * @param id the Id to search for
-     * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<TemplateOut>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<TemplateOut | undefined>;
     /**
      * Find By Name
      * @param name the name to search for
-     * @param rql an optional rql string
      * @returns the first element found
      */
-    findByName(name: string, options?: OptionsWithRql): Promise<TemplateOut>;
+    findByName(name: string, options?: OptionsWithRql): Promise<TemplateOut | undefined>;
     /**
      * Find First
-     * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<TemplateOut>;
+    findFirst(options?: OptionsWithRql): Promise<TemplateOut | undefined>;
     /**
      * Create a new template
      *

package/build/types/services/users/types.d.ts

@@ -210,6 +210,7 @@ export declare enum GlobalPermissionName {
     SEND_MAILS = "SEND_MAILS",
     SYNC_PROFILE_GROUPS = "SYNC_PROFILE_GROUPS",
     TRANSFER_PERIOD = "TRANSFER_PERIOD",
+    TRANSITION_DOCUMENTS = "TRANSITION_DOCUMENTS",
     TRIGGER_APP_STORE_SUBSCRIPTION_REEVALUATION = "TRIGGER_APP_STORE_SUBSCRIPTION_REEVALUATION",
     TRIGGER_PLAY_STORE_SUBSCRIPTION_REEVALUATION = "TRIGGER_PLAY_STORE_SUBSCRIPTION_REEVALUATION",
     UNLINK_USER_FROM_OIDC = "UNLINK_USER_FROM_OIDC",
@@ -347,8 +348,6 @@ export declare enum GlobalPermissionName {
     /** @deprecated Not in use any longer */
     MANAGE_SERVICE_ALERTS = "MANAGE_SERVICE_ALERTS",
     /** @deprecated Not in use any longer */
-    TRANSITION_DOCUMENTS = "TRANSITION_DOCUMENTS",
-    /** @deprecated Not in use any longer */
     VIEW_AWS_SES_STATISTICS = "VIEW_AWS_SES_STATISTICS",
     /** @deprecated Not in use any longer */
     CREATE_USER_PERIODS = "CREATE_USER_PERIODS",

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.4.1";
+export declare const version = "8.5.0-dev-71-b217382";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.4.1",
+  "version": "8.5.0-dev-71-b217382",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",