@extrahorizon/javascript-sdk 8.4.1-dev-65-8ee48f9 → 8.4.1-dev-66-34d7111

package/CHANGELOG.md

@@ -7,8 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- `exh.data.documents.unlinkAllUsers` and `unlinkAllGroups` methods to unlink all users or groups from a document
+
 ### 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]
 

package/build/index.cjs.js

@@ -3603,15 +3603,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 +5376,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.4.1-dev-65-8ee48f9';
+const version = '8.4.1-dev-66-34d7111';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -3573,15 +3573,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 +5346,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.4.1-dev-65-8ee48f9';
+const version = '8.4.1-dev-66-34d7111';
 
 /**
  * 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/services/data/types.d.ts

@@ -563,6 +563,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 +584,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 +623,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.
@@ -622,6 +646,30 @@ export interface DataDocumentsService {
     unlinkUsers(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: {
         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/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.4.1-dev-65-8ee48f9";
+export declare const version = "8.4.1-dev-66-34d7111";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.4.1-dev-65-8ee48f9",
+  "version": "8.4.1-dev-66-34d7111",
   "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",