@extrahorizon/javascript-sdk 8.5.0-dev-76-d4ca7d4 → 8.5.0-dev-78-7b06d51

package/CHANGELOG.md

@@ -7,27 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [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
-- The `notifyAlgoQueueManager` transition action type no longer claims it has a `id` and `version` field
-- Transitions now correctly state `name` is optional and `id` is only a returned field.
-
 ### 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
-- Added a `name` field to the `exh.data.documents.transition` body, allowing a transition to be triggered by its name rather then its id
+- Data Service:
+  - Schema `createMode`, `readMode`, `updateMode` and `deleteMode` have been updated to accept multiple granular options, matching the revamped access mode changes in Data Service `1.4.0`
+  - Schema Transition Action `type: "task"` now supports the `priority` field
+  - Schema Transition `afterActions` now supports the `type: "task"` Action
+  - Access mode documentation has been revamped for the relevant `exh.data.documents.*` methods
+  - `exh.data.documents.transition` now accepts a `name` field the `requestBody`, allowing a Transition to be triggered by its `name`
+  - `exh.data.documents.unlinkAllUsers` and `unlinkAllGroups` methods added, to unlink all users or groups from a Document
+- `TRANSITION_DOCUMENTS` has been added as a supported permission
 
 ### 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
+- `exh.data.documents.unlinkUsers` and `unlinkGroups` now also accept an array of user or group ids directly
   - Thanks to `tran-simon` for the pointing out the initially incorrect `unlinkUsers` type definition!
-- Data service schemas `createMode`, `readMode`, `updateMode` and `deleteMode` accepted values updated
-  - Matching the access mode changes in Data Service 1.4.0
-  - `readMode`, `updateMode` and `deleteMode` now also accept an array of relational modes
+- The RQL `contains` and `excludes` methods type definitions have been improved
+
+### Fixed
+- Data Service Schema Transition:
+  - Now correctly states `name` is optional and `id` is only a returned field.
+  - Action `type: "task"` now correctly types `functioName` as `functionName` 
+  - Action `type: "notifyAlgoQueueManager"` no longer claims it has an `id` and `version` field
+- `exh.templates.findFirst`, `findById` and `findByName` now correctly defines `undefined` as a return type
 
 ### 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

package/build/index.cjs.js

@@ -5375,7 +5375,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.5.0-dev-76-d4ca7d4';
+const version = '8.5.0-dev-78-7b06d51';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -5345,7 +5345,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.5.0-dev-76-d4ca7d4';
+const version = '8.5.0-dev-78-7b06d51';
 
 /**
  * Create ExtraHorizon client.

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

@@ -384,13 +384,31 @@ export interface DataDocumentsService {
      */
     assertNonLockedState(schemaIdOrName: ObjectId | string, documentId: ObjectId, tries: number, retryTimeInMs: number, options?: OptionsBase): Promise<boolean>;
     /**
-     * Create a document
+     * # Create a document
      *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * none |  | Everyone can use this endpoint
-     *
-     * `CREATE_DOCUMENTS` | `global` | When the schema.createMode is set to permissionRequired then this permission is required to make a group
+     * `CREATE_DOCUMENTS` | `global` | Create a document for any schema
+     * `CREATE_DOCUMENTS:{SCHEMA_NAME}` | `global` | Create a document for the specified schema
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General createMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * `"allUsers"` | All users can create a document
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy createMode value | Description
+     * - | -
+     * `"default"` | Translates to the `"allUsers"` general access mode value
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param requestBody
      * @returns {Document} document
@@ -400,119 +418,267 @@ export interface DataDocumentsService {
         gzip?: boolean;
     }): Promise<Document<OutputData, CustomStatus>>;
     /**
-     * Request a list of documents
-     *
-     * ReadMode on schema is set to 'default' (or the property is not set at all on the schema):
+     * # Request a list of documents
      *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * none | | See your own documents
-     * none | `staff enlistment` | See the documents belonging to the group (and your own documents)
-     * `VIEW_DOCUMENTS` | `global` | See any document
-     *
-     * ReadMode on schema is set to 'allUsers':
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | See any document
-     *
-     * ReadMode on schema is set to 'enlistedInLinkedGroups':
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | `patient enlistment` | See the documents belonging to the group
-     * none | `staff enlistment` | See the documents belonging to the group
-     * `VIEW_DOCUMENTS` | `global` | See any document
+     * `VIEW_DOCUMENTS` | `global` | View any document
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `global` | View any document of the specified schema
+     * `VIEW_DOCUMENTS` | `staff_enlistment` | View any document belonging to the group
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | View any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General readMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * `"allUsers"` | All users can view any document of the specified schema
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational readMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can view the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can view the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can view the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can view the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"enlistedInLinkedGroups"` | Translates to `["linkedGroupPatients","linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @returns PagedResultWithPager<Document>
      */
     find<CustomData = null, CustomStatus = null>(schemaIdOrName: ObjectId | string, options?: OptionsWithRql): Promise<PagedResultWithPager<Document<CustomData, CustomStatus>>>;
     /**
-     * Request a list of all documents
+     * # Request a list of all documents
      *
      * Do not pass in an rql with limit operator!
      *
-     * ReadMode on schema is set to 'default' (or the property is not set at all on the schema):
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | See your own documents
-     * none | `staff enlistment` | See the documents belonging to the group (and your own documents)
-     * `VIEW_DOCUMENTS` | `global` | See any document
-     *
-     * ReadMode on schema is set to 'allUsers':
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | See any document
-     *
-     * ReadMode on schema is set to 'enlistedInLinkedGroups':
-     *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * none | `patient enlistment` | See the documents belonging to the group
-     * none | `staff enlistment` | See the documents belonging to the group
-     * `VIEW_DOCUMENTS` | `global` | See any document
+     * `VIEW_DOCUMENTS` | `global` | View any document
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `global` | View any document of the specified schema
+     * `VIEW_DOCUMENTS` | `staff_enlistment` | View any document belonging to the group
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | View any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General readMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * `"allUsers"` | All users can view any document of the specified schema
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational readMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can view the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can view the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can view the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can view the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"enlistedInLinkedGroups"` | Translates to `["linkedGroupPatients","linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @returns Document[]
      */
     findAll<CustomData = null, CustomStatus = null>(schemaIdOrName: ObjectId | string, options?: OptionsWithRql): Promise<Document<CustomData, CustomStatus>[]>;
     /**
-     * Request a list of all documents and return a generator
+     * # Request a list of all documents and return a generator
      *
-     * ReadMode on schema is set to 'default' (or the property is not set at all on the schema):
-     *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * none | | See your own documents
-     * none | `staff enlistment` | See the documents belonging to the group (and your own documents)
-     * `VIEW_DOCUMENTS` | `global` | See any document
-     *
-     * ReadMode on schema is set to 'allUsers':
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | See any document
-     *
-     * ReadMode on schema is set to 'enlistedInLinkedGroups':
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | `patient enlistment` | See the documents belonging to the group
-     * none | `staff enlistment` | See the documents belonging to the group
-     * `VIEW_DOCUMENTS` | `global` | See any document
+     * `VIEW_DOCUMENTS` | `global` | View any document
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `global` | View any document of the specified schema
+     * `VIEW_DOCUMENTS` | `staff_enlistment` | View any document belonging to the group
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | View any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General readMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * `"allUsers"` | All users can view any document of the specified schema
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational readMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can view the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can view the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can view the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can view the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"enlistedInLinkedGroups"` | Translates to `["linkedGroupPatients","linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @returns Document[]
      */
     findAllIterator<CustomData = null, CustomStatus = null>(schemaIdOrName: ObjectId | string, options?: OptionsWithRql): FindAllIterator<Document<CustomData, CustomStatus>>;
     /**
-     * Shortcut method to find a document by id
-     *
-     * Same Permissions as the find() method
+     * # Find a document by id
      *
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_DOCUMENTS` | `global` | View any document
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `global` | View any document of the specified schema
+     * `VIEW_DOCUMENTS` | `staff_enlistment` | View any document belonging to the group
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | View any document of the specified schema belonging to the group
+     * <br>
+  
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General readMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * `"allUsers"` | All users can view any document of the specified schema
+     * <br>
+  
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational readMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can view the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can view the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can view the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can view the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"enlistedInLinkedGroups"` | Translates to `["linkedGroupPatients","linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId the Id to search for
      * @returns {Document} document
      */
     findById<CustomData = null, CustomStatus = null>(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsWithRql): Promise<Document<CustomData, CustomStatus> | undefined>;
     /**
-     * Returns the first document that is found with the applied filter
+     * # Find the first document that matches the applied filter
      *
-     * Same Permissions as the find() method
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
+     * - | - | -
+     * `VIEW_DOCUMENTS` | `global` | View any document
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `global` | View any document of the specified schema
+     * `VIEW_DOCUMENTS` | `staff_enlistment` | View any document belonging to the group
+     * `VIEW_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | View any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General readMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * `"allUsers"` | All users can view any document of the specified schema
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational readMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can view the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can view the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can view the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can view the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"enlistedInLinkedGroups"` | Translates to `["linkedGroupPatients","linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @returns {Document} document
      */
     findFirst<CustomData = null, CustomStatus = null>(schemaIdOrName: ObjectId | string, options?: OptionsWithRql): Promise<Document<CustomData, CustomStatus> | undefined>;
     /**
-     * Update a document
+     * # Update a document
      *
-     * **Partially** update the selected document. Use a `null` value to clear a field.
+     * **Partially** update the selected document, provide `null` as a value to clear a field.
+     * <br>
+     * <br>
      *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * 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` | Update any document
+     * `UPDATE_DOCUMENTS:{SCHEMA_NAME}` | `global` | Update any document of the specified schema
+     * `UPDATE_DOCUMENTS` | `staff_enlistment` | Update any document belonging to the group
+     * `UPDATE_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | Update any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General updateMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational updateMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can update the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can update the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can update the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can update the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"creatorOnly"` | Translates to `["creator"]` relational access mode
+     * `"disabled"` | Translates to the `"permissionRequired"` general access mode value
+     * `"linkedGroupsStaffOnly"` | Translates to `["linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody Record<string, any>
@@ -520,36 +686,87 @@ export interface DataDocumentsService {
      */
     update<UpdateData = Record<string, any>>(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: UpdateData, options?: OptionsWithRql): Promise<AffectedRecords>;
     /**
-     * Delete a document
-     *
-     * DeleteMode on schema is set to 'permissionRequired':
+     * # Delete a document
      *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * `DELETE_DOCUMENTS` | `global` | **Required** for this endpoint
-     *
-     * DeleteMode on schema is set to 'linkedUsersOnly':
-     *
-     * Permission | Scope | Effect
-     * - | - | -
-     * none | | Delete the document if the userId is linked to the document
-     * none | `staff enlistment`  | Delete the document if the groupId is linked
-     * `DELETE_DOCUMENTS` | `global` | Delete the document
+     * `DELETE_DOCUMENTS` | `global` | Delete any document
+     * `DELETE_DOCUMENTS:{SCHEMA_NAME}` | `global` | Delete any document of the specified schema
+     * `DELETE_DOCUMENTS` | `staff_enlistment` | Delete any document belonging to the group
+     * `DELETE_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | Delete any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General deleteMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational deleteMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can delete the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can delete the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can delete the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can delete the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy deleteMode value | Description
+     * - | -
+     * `"linkedUsersOnly"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @returns AffectedRecords
      */
     remove(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
     /**
-     * Delete fields from a document
-     *
-     * Delete the specified fields from the selected document.
+     * # Delete the specified fields from the selected document.
      *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * 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` | Update any document
+     * `UPDATE_DOCUMENTS:{SCHEMA_NAME}` | `global` | Update any document of the specified schema
+     * `UPDATE_DOCUMENTS` | `staff_enlistment` | Update any document belonging to the group
+     * `UPDATE_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | Update any document of the specified schema belonging to the group
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General updateMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational updateMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can update the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can update the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can update the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can update the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"creatorOnly"` | Translates to `["creator"]` relational access mode
+     * `"disabled"` | Translates to the `"permissionRequired"` general access mode value
+     * `"linkedGroupsStaffOnly"` | Translates to `["linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody list of fields
@@ -559,26 +776,55 @@ export interface DataDocumentsService {
         fields: Array<string>;
     }, options?: OptionsWithRql): Promise<AffectedRecords>;
     /**
-     * Transition a document
+     * # Transition a document
      *
      * Start a transition manually for the selected document where the conditions of a manual transition are met.
      *
-     * Either the `id` or the `name` of a transition must be provided.
-     * If both are provided, they must match the same transition, otherwise a `ResourceUnknownError` will be thrown.
-     *
-     * If `name` is provided, multiple transitions could match.
-     * In this case, the first matching transition will be triggered:
-     * - The first transition with a `fromStatuses` matching the current status of the document
-     * - And all the transition its `conditions` are met
+     * Note: the `id` or `name` in the requestBody are the `id` or `name` of the transition.
      *
-     * Permission | Scope | Effect
+     * ## Access via permissions
+     * Regardless of how the access modes (described below) are set, a user is always able to perform an operation on a document if they are assigned a specific permission.  This permission can come from a global role of the user or a staff enlistment role the user has in the group of the document.
+     * Permission | Scopes | Effect
      * - | - | -
-     * none | | Update your own documents
-     * none | `staff enlistment`  | Update all the documents belonging to the group
-     * `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
+     * `UPDATE_DOCUMENTS` | `global` | Update any document
+     * `UPDATE_DOCUMENTS:{SCHEMA_NAME}` | `global` | Update any document of the specified schema
+     * `UPDATE_DOCUMENTS` | `staff_enlistment` | Update any document belonging to the group
+     * `UPDATE_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | Update any document of the specified schema belonging to the group
+     * `TRANSITION_DOCUMENTS` | `global` | Transition any document
+     * `TRANSITION_DOCUMENTS:{SCHEMA_NAME}` | `global` | Transition any document of the specified schema
+     * `TRANSITION_DOCUMENTS:{SCHEMA_NAME}:{TRANSITION_NAME}` | `global` | Transition any document of the specified schema with the specified transition name
+     * `TRANSITION_DOCUMENTS` | `staff_enlistment` | Transition any document belonging to the group
+     * `TRANSITION_DOCUMENTS:{SCHEMA_NAME}` | `staff_enlistment` | Transition any document of the specified schema belonging to the group
+     * `TRANSITION_DOCUMENTS:{SCHEMA_NAME}:{TRANSITION_NAME}` | `staff_enlistment` | Transition any document of the specified schema belonging to the group with the specified transition name
+     * <br>
+     *
+     * ## General access mode values
+     * The general access mode values determine if a user requires permission to perform the action for the Schema. A general access mode value is provided as one of the following strings.
+     * General updateMode value | Description
+     * - | -
+     * `"permissionRequired"` | The permissions above apply
+     * <br>
+     *
+     * ## Relational access mode values
+     * Relational access mode values are supplied as an array. When multiple relational access mode values are supplied, a user adhering to any relation in this array is allowed to perform the action on the document.
+     * Relational updateMode value | Description
+     * - | -
+     * `["creator"]` | The user that created the document can update the document.
+     * `["linkedUsers"]` |  All users where their user id is in the list of userIds of the document can update the document.
+     * `["linkedGroupPatients"]` | All users that have a patient enlistment in a group that is in the list of groupIds of the document can update the document.
+     * `["linkedGroupStaff"]` | All users that have a staff enlistment in a group that is in the list of groupIds of the document can update the document.
+     * <br>
+     *
+     * ## Legacy access mode values
+     * Listed below are the deprecated values with their current equivalent
+     * Legacy updateMode value | Description
+     * - | -
+     * `"default"` | Translates to `["linkedUsers","linkedGroupStaff"]` relational access mode
+     * `"creatorOnly"` | Translates to `["creator"]` relational access mode
+     * `"disabled"` | Translates to the `"permissionRequired"` general access mode value
+     * `"linkedGroupsStaffOnly"` | Translates to `["linkedGroupStaff"]` relational access mode
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody
@@ -588,13 +834,16 @@ export interface DataDocumentsService {
      */
     transition(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: TransitionDocumentInput, options?: OptionsWithRql): Promise<AffectedRecords>;
     /**
-     * Link groups to a document
+     * # Link groups to a document
      *
      * Link the specified groups to a document.
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Link groups to all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Link groups to the documents of the specified schema
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody list of groupIds
@@ -606,7 +855,7 @@ export interface DataDocumentsService {
     /**
      * @deprecated Use `unlinkGroups(schemaIdOrName, documentId, groupIds)` or `unlinkAllGroups(schemaIdOrName, documentId)` instead.
      *
-     * Unlink groups from a document
+     * # Unlink groups from a document
      *
      * Unlink the specified groups from a document
      *
@@ -616,7 +865,10 @@ export interface DataDocumentsService {
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Unlink groups for all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Unlink groups for the documents of the specified schema
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody list of groupIds
@@ -626,7 +878,7 @@ export interface DataDocumentsService {
         groupIds?: Array<ObjectId>;
     }, options?: OptionsBase): Promise<AffectedRecords>;
     /**
-     * Unlink groups from a document
+     * # Unlink groups from a document
      *
      * Unlink the specified groups from a document
      *
@@ -634,27 +886,43 @@ export interface DataDocumentsService {
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Unlink groups for all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Unlink groups for the documents of the specified schema
+     *
+     * # Interface
+     * @param schemaIdOrName The id or name of the targeted schema.
+     * @param documentId The id of the targeted document.
+     * @param groupIds list of groupIds
+     * @returns AffectedRecords
      */
     unlinkGroups(schemaIdOrName: ObjectId | string, documentId: ObjectId, groupIds: Array<ObjectId>, options?: OptionsBase): Promise<AffectedRecords>;
     /**
-     * Unlink all groups from a document
+     * # Unlink all groups from a document
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Unlink groups for all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Unlink groups for the documents of the specified schema
+     *
+     * # Interface
+     * @param schemaIdOrName The id or name of the targeted schema.
+     * @param documentId The id of the targeted document.
+     * @returns AffectedRecords
      */
     unlinkAllGroups(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
     /**
-     * Link users to a document
+     * # Link users to a document
      *
      * Link the specified users to a document.
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Link users to all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Link users to all documents of the specified schema
      *
      * 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 added to the document.
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody list of userIds
@@ -666,7 +934,7 @@ export interface DataDocumentsService {
     /**
      * @deprecated Use `unlinkUsers(schemaIdOrName, documentId, userIds)` or `unlinkAllUsers(schemaIdOrName, documentId)` instead.
      *
-     * Unlink users from a document
+     * # Unlink users from a document
      *
      * Unlink the specified users from a document.
      *
@@ -676,9 +944,12 @@ export interface DataDocumentsService {
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Unlink users to all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Unlink users to all documents of the specified schema
      *
      * 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.
+     *
+     * # Interface
      * @param schemaIdOrName The id or name of the targeted schema.
      * @param documentId The id of the targeted document.
      * @param requestBody list of userIds
@@ -688,7 +959,7 @@ export interface DataDocumentsService {
         userIds?: Array<ObjectId>;
     }, options?: OptionsBase): Promise<AffectedRecords>;
     /**
-     * Unlink users from a document
+     * # Unlink users from a document
      *
      * Unlink the specified users from a document.
      *
@@ -696,19 +967,34 @@ export interface DataDocumentsService {
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Unlink users to all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Unlink users to all documents of the specified schema
      *
      * 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.
+     *
+     * # Interface
+     * @param schemaIdOrName The id or name of the targeted schema.
+     * @param documentId The id of the targeted document.
+     * @param userIds list of userIds
+     * @param requestBody list of userIds
+     * @returns AffectedRecords
      */
     unlinkUsers(schemaIdOrName: ObjectId | string, documentId: ObjectId, userIds: Array<ObjectId>, options?: OptionsBase): Promise<AffectedRecords>;
     /**
-     * Unlink all users from a document
+     * # Unlink all users from a document
      *
      * Permission | Scope | Effect
      * - | - | -
-     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | **Required** for this endpoint
+     * `UPDATE_ACCESS_TO_DOCUMENT` | `global` | Unlink users to all documents
+     * `UPDATE_ACCESS_TO_DOCUMENT:{SCHEMA_NAME}` | `global` | Unlink users to all documents of the specified schema
      *
      * 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.
+     *
+     * # Interface
+     * @param schemaIdOrName The id or name of the targeted schema.
+     * @param documentId The id of the targeted document.
+     * @param requestBody list of userIds
+     * @returns AffectedRecords
      */
     unlinkAllUsers(schemaIdOrName: ObjectId | string, documentId: ObjectId, options?: OptionsBase): Promise<AffectedRecords>;
 }

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.5.0-dev-76-d4ca7d4";
+export declare const version = "8.5.0-dev-78-7b06d51";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.5.0-dev-76-d4ca7d4",
+  "version": "8.5.0-dev-78-7b06d51",
   "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",