@mondaydotcomorg/monday-authorization 1.2.10 → 1.2.11

package/README.md

@@ -138,7 +138,10 @@ const canActionInScopeMultipleResponse: ScopedActionResponseObject[] =
 ```
 
 ### Authorization Attributes API
+Authorization attributes have 2 options to get called: sync (http request) and async (send to SNS and consumed asynchronously).  
+When you have to make sure the change in the attributes applied before the function return, please use the sync method, otherwise use the async 
 
+#### Sync method
 Use `AuthorizationAttributesService.upsertResourceAttributesSync` to upsert multiple resource attributes in the authorization MS synchronously.
 
 ```ts
@@ -168,3 +171,25 @@ const attributeKeys: string[] = ['is_default_workspace', 'workspace_kind'];
 const response: ResourceAttributeResponse = await AuthorizationAttributesService.deleteResourceAttributesSync(accountId, userId, resource, attributeKeys);
 ```
 
+#### Async method
+use `AuthorizationAttributesService.updateResourceAttributesAsync` to upsert or delete multiple resource attributes at once.
+
+```ts
+import { AuthorizationAttributesService, ResourceAttributeAssignment, ResourceAttributeResponse } from '@mondaydotcomorg/monday-authorization';
+
+const accountId = 739630;
+const appName =  process.env.APP_NAME;
+const callerActionIdentifier = "actions_v2";
+const resourceAttributeOperations: ResourceAttributesOperation[] = [
+  { operationType: 'upsert', resourceId: 18, resourceType: 'workspace', key: 'is_default_workspace', value: 'true' },
+  { operationType: 'delete', resourceId: 23, resourceType: 'board', key: 'board_kind' }
+];
+
+const response: ResourceAttributeResponse = await AuthorizationAttributesService.updateResourceAttributesAsync(accountId, appName, callerActionIdentifier, resourceAttributeOperations);
+```
+
+Special notes for asynchronous operations:
+1. There is no guarantee about the order of the updates, so don't do multiple operations on the same key in the same resource.
+2. To update an existing key, just use upsert operation, it'll override previous value.
+3. Requests with a lot of operations might split to chunks that will be consumed either sequence or in parallel, so there might be a timeframe where some of the operations already applied and some not. Eventually all of them will be applied.
+4. If your MS depends on the access to the asynchronous operation, you can use a health check operation `asyncResourceAttributesHealthCheck` that will return false if it can't reach to SNS or can't find the required topic. Note it doesn't check write permissions so make sure your MS have permissions to write to the SNS topic.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/monday-authorization",
-  "version": "1.2.10",
+  "version": "1.2.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "BSD-3-Clause",
@@ -56,5 +56,5 @@
   "files": [
     "dist/"
   ],
-  "gitHead": "122b40d8b959019a580bf5f72ede54da86738abb"
+  "gitHead": "4db8fcacd3fe976b0e3fbc8e76d556f20f757d41"
 }