@mondaydotcomorg/monday-authorization 3.5.0-feat-shaime-support-entity-attributes-in-authorization-sdk-a98616f → 3.5.0-feat-shaime-support-entity-attributes-in-authorization-sdk-8d846f1

package/dist/esm/authorization-attributes-ms-service.mjs

@@ -10,6 +10,8 @@ import { APP_NAME } from './constants.mjs';
 const INTERNAL_APP_NAME = 'internal_ms';
 const UPSERT_RESOURCE_ATTRIBUTES_PATH = '/attributes/{accountId}/resource';
 const DELETE_RESOURCE_ATTRIBUTES_PATH = '/attributes/{accountId}/resource/{resourceType}/{resourceId}';
+const UPSERT_ENTITY_ATTRIBUTES_PATH = '/attributes/{accountId}/entity';
+const DELETE_ENTITY_ATTRIBUTES_PATH = '/attributes/{accountId}/entity/{entityType}/{entityId}';
 /**
  * Service class for managing resource attributes in the authorization microservice.
  * Provides synchronous HTTP operations to create/update and delete attributes on resources.
@@ -225,6 +227,169 @@ class AuthorizationAttributesMsService {
             throw err;
         }
     }
+    /**
+     * Creates or updates entity attributes synchronously.
+     * @param accountId The account ID
+     * @param entityAttributeAssignments Array of EntityAttributeAssignment objects
+     * @returns Promise<void>
+     */
+    static async upsertEntityAttributesSync(accountId, entityAttributeAssignments) {
+        // Skip HTTP requests in test environment
+        if (process.env.NODE_ENV === 'test') {
+            logger.debug({ tag: this.LOG_TAG, accountId, count: entityAttributeAssignments.length }, 'Skipping upsertEntityAttributesSync in test environment');
+            return;
+        }
+        // Validate inputs
+        if (!Number.isInteger(accountId)) {
+            throw new ArgumentError(`accountId must be an integer, got: ${accountId}`);
+        }
+        if (!Array.isArray(entityAttributeAssignments)) {
+            throw new ArgumentError('entityAttributeAssignments must be an array');
+        }
+        if (entityAttributeAssignments.length === 0) {
+            logger.warn({ tag: this.LOG_TAG, accountId }, 'upsertEntityAttributesSync called with empty array');
+            return;
+        }
+        // Validate each assignment
+        for (let i = 0; i < entityAttributeAssignments.length; i++) {
+            const assignment = entityAttributeAssignments[i];
+            if (!assignment.entityId || typeof assignment.entityId !== 'number') {
+                throw new ArgumentError(`entityAttributeAssignments[${i}].entityId is required and must be a number`);
+            }
+            if (!assignment.entityType || typeof assignment.entityType !== 'string') {
+                throw new ArgumentError(`entityAttributeAssignments[${i}].entityType is required and must be a string`);
+            }
+            if (!assignment.key || typeof assignment.key !== 'string') {
+                throw new ArgumentError(`entityAttributeAssignments[${i}].key is required and must be a string`);
+            }
+            if (assignment.value === undefined || typeof assignment.value !== 'string') {
+                throw new ArgumentError(`entityAttributeAssignments[${i}].value is required and must be a string`);
+            }
+        }
+        // Build request body
+        const requestBody = {
+            entityAttributeAssignments: entityAttributeAssignments.map(assignment => ({
+                entityId: assignment.entityId,
+                entityType: assignment.entityType,
+                key: assignment.key,
+                value: assignment.value,
+            })),
+        };
+        const httpClient = Api.getPart('httpClient');
+        if (!httpClient) {
+            throw new Error('AuthorizationAttributesMsService: HTTP client is not initialized');
+        }
+        const path = UPSERT_ENTITY_ATTRIBUTES_PATH.replace('{accountId}', accountId.toString());
+        const headers = this.getRequestHeaders(accountId);
+        try {
+            logger.info({ tag: this.LOG_TAG, accountId, count: entityAttributeAssignments.length }, 'Upserting entity attributes');
+            await httpClient.fetch({
+                url: {
+                    appName: APP_NAME,
+                    path,
+                },
+                method: 'POST',
+                headers,
+                body: JSON.stringify(requestBody),
+            }, {
+                timeout: AuthorizationInternalService.getRequestTimeout(),
+                retryPolicy: AuthorizationInternalService.getRetriesPolicy(),
+            });
+            logger.info({ tag: this.LOG_TAG, accountId, count: entityAttributeAssignments.length }, 'Successfully upserted entity attributes');
+        }
+        catch (err) {
+            logger.error({
+                tag: this.LOG_TAG,
+                accountId,
+                method: 'upsertEntityAttributesSync',
+                error: err instanceof Error ? err.message : String(err),
+            }, 'Failed to upsert entity attributes');
+            if (err instanceof HttpFetcherError) {
+                throw new Error(`AuthorizationAttributesMsService: [upsertEntityAttributesSync] request failed with status ${err.status}: ${err.message}`);
+            }
+            throw err;
+        }
+    }
+    /**
+     * Deletes specific attributes from an entity synchronously.
+     * @param accountId The account ID
+     * @param entityType The entity type
+     * @param entityId The entity ID
+     * @param attributeKeys Array of attribute key strings to delete
+     * @returns Promise<void>
+     */
+    static async deleteEntityAttributesSync(accountId, entityType, entityId, attributeKeys) {
+        // Skip HTTP requests in test environment
+        if (process.env.NODE_ENV === 'test') {
+            logger.debug({ tag: this.LOG_TAG, accountId, entityType, entityId, attributeKeys }, 'Skipping deleteEntityAttributesSync in test environment');
+            return;
+        }
+        // Validate inputs
+        if (!Number.isInteger(accountId)) {
+            throw new ArgumentError(`accountId must be an integer, got: ${accountId}`);
+        }
+        if (!entityType || typeof entityType !== 'string') {
+            throw new ArgumentError(`entityType must be a string, got: ${typeof entityType}`);
+        }
+        if (!Number.isInteger(entityId)) {
+            throw new ArgumentError(`entityId must be an integer, got: ${entityId}`);
+        }
+        if (!Array.isArray(attributeKeys)) {
+            throw new ArgumentError('attributeKeys must be an array');
+        }
+        if (attributeKeys.length === 0) {
+            logger.warn({ tag: this.LOG_TAG, accountId, entityType, entityId }, 'deleteEntityAttributesSync called with empty keys array');
+            return;
+        }
+        // Validate all keys are strings
+        for (let i = 0; i < attributeKeys.length; i++) {
+            if (typeof attributeKeys[i] !== 'string') {
+                throw new ArgumentError(`All attributeKeys must be strings, but item at index ${i} is not`);
+            }
+        }
+        // Build request body
+        const requestBody = {
+            keys: attributeKeys,
+        };
+        const httpClient = Api.getPart('httpClient');
+        if (!httpClient) {
+            throw new Error('AuthorizationAttributesMsService: HTTP client is not initialized');
+        }
+        const path = DELETE_ENTITY_ATTRIBUTES_PATH.replace('{accountId}', accountId.toString())
+            .replace('{entityType}', entityType)
+            .replace('{entityId}', entityId.toString());
+        const headers = this.getRequestHeaders(accountId);
+        try {
+            logger.info({ tag: this.LOG_TAG, accountId, entityType, entityId, keys: attributeKeys }, 'Deleting entity attributes');
+            await httpClient.fetch({
+                url: {
+                    appName: APP_NAME,
+                    path,
+                },
+                method: 'DELETE',
+                headers,
+                body: JSON.stringify(requestBody),
+            }, {
+                timeout: AuthorizationInternalService.getRequestTimeout(),
+                retryPolicy: AuthorizationInternalService.getRetriesPolicy(),
+            });
+            logger.info({ tag: this.LOG_TAG, accountId, entityType, entityId, keys: attributeKeys }, 'Successfully deleted entity attributes');
+        }
+        catch (err) {
+            logger.error({
+                tag: this.LOG_TAG,
+                accountId,
+                method: 'deleteEntityAttributesSync',
+                entityType,
+                entityId,
+                error: err instanceof Error ? err.message : String(err),
+            }, 'Failed to delete entity attributes');
+            if (err instanceof HttpFetcherError) {
+                throw new Error(`AuthorizationAttributesMsService: [deleteEntityAttributesSync] request failed with status ${err.status}: ${err.message}`);
+            }
+            throw err;
+        }
+    }
 }
 
 export { AuthorizationAttributesMsService };

package/dist/esm/authorization-attributes-service.d.ts

@@ -1,35 +1,55 @@
-import { FetcherConfig, HttpClient } from '@mondaydotcomorg/trident-backend-api';
-import { RecursivePartial } from '@mondaydotcomorg/monday-fetch-api';
-import { ResourceAttributeAssignment, ResourceAttributeResponse, ResourceAttributesOperation, EntityAttributeAssignment, EntityAttributeResponse, ResourceType, EntityType, ResourceAttributeKeyType, EntityAttributeKeyType } from './types/authorization-attributes-contracts';
+import { ResourceAttributeAssignment, ResourceAttributesOperation, EntityAttributeAssignment, EntityAttributesOperation } from './types/authorization-attributes-contracts';
 import { Resource } from './types/general';
 export declare class AuthorizationAttributesService {
     private static LOG_TAG;
-    private static API_PATHS;
-    private httpClient;
-    private fetchOptions;
     private snsArn;
     /**
      * Public constructor to create the AuthorizationAttributesService instance.
-     * @param httpClient The HTTP client to use for API requests, if not provided, the default HTTP client from Api will be used.
-     * @param fetchOptions The fetch options to use for API requests, if not provided, the default fetch options will be used.
      */
-    constructor(httpClient?: HttpClient, fetchOptions?: RecursivePartial<FetcherConfig>);
+    constructor();
     /**
-     * Upsert resource attributes synchronously, performing http call to the authorization MS to assign the given attributes to the given resource.
-     * @param accountId
-     * @param resourceAttributeAssignments - Array of resource (resourceType, resourceId) and attribute (key, value) pairs to upsert in the authorization MS.
-     * e.g. [{ resourceType: 'board', resourceId: 123, key: 'board_kind', value: 'private' }]
-     * @returns ResourceAttributeResponse - The affected (created and updated_ resource attributes assignments in the `attributes` field.
+     * Async function to upsert resource attributes using SNS.
+     * Sends the updates request to SNS and returns before the change actually took place.
+     * @param accountId The account ID
+     * @param appName App name of the calling app
+     * @param callerActionIdentifier Action identifier
+     * @param resourceAttributeAssignments Array of resource attribute assignments to upsert
+     * @return Promise with array of sent operations
      */
-    upsertResourceAttributes(accountId: number, resourceAttributeAssignments: ResourceAttributeAssignment[]): Promise<ResourceAttributeResponse>;
+    upsertResourceAttributesAsync(accountId: number, appName: string, callerActionIdentifier: string, resourceAttributeAssignments: ResourceAttributeAssignment[]): Promise<ResourceAttributesOperation[]>;
     /**
-     * Delete resource attributes assignments synchronously, performing http call to the authorization MS to delete the given attributes from the given singular resource.
-     * @param accountId
-     * @param resource - The resource (resourceType, resourceId) to delete the attributes for.
-     * @param attributeKeys - Array of attribute keys to delete for the resource.
-     * @returns ResourceAttributeResponse - The affected (deleted) resource attributes assignments in the `attributes` field.
+     * Async function to delete resource attributes using SNS.
+     * Sends the updates request to SNS and returns before the change actually took place.
+     * @param accountId The account ID
+     * @param appName App name of the calling app
+     * @param callerActionIdentifier Action identifier
+     * @param resource The resource (resourceType, resourceId)
+     * @param attributeKeys Array of attribute keys to delete
+     * @return Promise with array of sent operations
+     */
+    deleteResourceAttributesAsync(accountId: number, appName: string, callerActionIdentifier: string, resource: Resource, attributeKeys: string[]): Promise<ResourceAttributesOperation[]>;
+    /**
+     * Async function to upsert entity attributes using SNS.
+     * Sends the updates request to SNS and returns before the change actually took place.
+     * @param accountId The account ID
+     * @param appName App name of the calling app
+     * @param callerActionIdentifier Action identifier
+     * @param entityAttributeAssignments Array of entity attribute assignments to upsert
+     * @return Promise with array of sent operations
+     */
+    upsertEntityAttributesAsync(accountId: number, appName: string, callerActionIdentifier: string, entityAttributeAssignments: EntityAttributeAssignment[]): Promise<EntityAttributesOperation[]>;
+    /**
+     * Async function to delete entity attributes using SNS.
+     * Sends the updates request to SNS and returns before the change actually took place.
+     * @param accountId The account ID
+     * @param appName App name of the calling app
+     * @param callerActionIdentifier Action identifier
+     * @param entityType The entity type
+     * @param entityId The entity ID
+     * @param attributeKeys Array of attribute keys to delete
+     * @return Promise with array of sent operations
      */
-    deleteResourceAttributes(accountId: number, resource: Resource, attributeKeys: string[]): Promise<ResourceAttributeResponse>;
+    deleteEntityAttributesAsync(accountId: number, appName: string, callerActionIdentifier: string, entityType: string, entityId: number, attributeKeys: string[]): Promise<EntityAttributesOperation[]>;
     /**
      *  Async function, this function only send the updates request to SNS and return before the change actually took place
      * @param accountId
@@ -39,7 +59,17 @@ export declare class AuthorizationAttributesService {
      * @return {Promise<ResourceAttributesOperation[]>} Array of sent operations
      *  */
     updateResourceAttributesAsync(accountId: number, appName: string, callerActionIdentifier: string, resourceAttributeOperations: ResourceAttributesOperation[]): Promise<ResourceAttributesOperation[]>;
-    private sendSingleSnsMessage;
+    /**
+     *  Async function, this function only send the updates request to SNS and return before the change actually took place
+     * @param accountId
+     * @param appName - App name of the calling app
+     * @param callerActionIdentifier - action identifier
+     * @param entityAttributeOperations - Array of operations to do on entity attributes.
+     * @return {Promise<EntityAttributesOperation[]>} Array of sent operations
+     *  */
+    updateEntityAttributesAsync(accountId: number, appName: string, callerActionIdentifier: string, entityAttributeOperations: EntityAttributesOperation[]): Promise<EntityAttributesOperation[]>;
+    private sendSingleResourceSnsMessage;
+    private sendSingleEntitySnsMessage;
     private static getSnsTopicArn;
     /**
      * Checks we can contact the required SNS topic that used to send attribute updates to Authorization MS.
@@ -50,49 +80,5 @@ export declare class AuthorizationAttributesService {
      * @return {Promise<boolean>} - true if succeeded
      */
     asyncResourceAttributesHealthCheck(): Promise<boolean>;
-    /**
-     * Validates resource attribute assignments array
-     */
-    private static validateResourceAttributeAssignments;
-    /**
-     * Validates entity attribute assignments array
-     */
-    private static validateEntityAttributeAssignments;
-    /**
-     * Upsert resource attributes synchronously.
-     * Matches API endpoint: POST /attributes/:accountId/resource
-     * @param accountId The account ID
-     * @param resourceAttributeAssignments Array of ResourceAttributeAssignment objects (1-100 items)
-     * @returns Promise with response containing affected attributes
-     */
-    static upsertResourceAttributesSync(accountId: number, resourceAttributeAssignments: ResourceAttributeAssignment[]): Promise<ResourceAttributeResponse>;
-    /**
-     * Delete resource attributes synchronously.
-     * Matches API endpoint: DELETE /attributes/:accountId/resource/:resourceType/:resourceId
-     * @param accountId The account ID
-     * @param resourceType The resource type
-     * @param resourceId The resource ID
-     * @param keys Array of attribute keys to delete
-     * @returns Promise with response containing affected attributes
-     */
-    static deleteResourceAttributesSync(accountId: number, resourceType: ResourceType, resourceId: number, keys: ResourceAttributeKeyType[]): Promise<ResourceAttributeResponse>;
-    /**
-     * Upsert entity attributes synchronously.
-     * Matches API endpoint: POST /attributes/:accountId/entity
-     * @param accountId The account ID
-     * @param entityAttributeAssignments Array of EntityAttributeAssignment objects (1-100 items)
-     * @returns Promise with response containing affected attributes
-     */
-    static upsertEntityAttributesSync(accountId: number, entityAttributeAssignments: EntityAttributeAssignment[]): Promise<EntityAttributeResponse>;
-    /**
-     * Delete entity attributes synchronously.
-     * Matches API endpoint: DELETE /attributes/:accountId/entity/:entityType/:entityId
-     * @param accountId The account ID
-     * @param entityType The entity type
-     * @param entityId The entity ID
-     * @param keys Array of attribute keys to delete
-     * @returns Promise with response containing affected attributes
-     */
-    static deleteEntityAttributesSync(accountId: number, entityType: EntityType, entityId: number, keys: EntityAttributeKeyType[]): Promise<EntityAttributeResponse>;
 }
 //# sourceMappingURL=authorization-attributes-service.d.ts.map

package/dist/esm/authorization-attributes-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authorization-attributes-service.d.ts","sourceRoot":"","sources":["../../src/authorization-attributes-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAO,aAAa,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAEtF,OAAO,EAAoB,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACvF,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,UAAU,EACV,wBAAwB,EACxB,sBAAsB,EACvB,MAAM,4CAA4C,CAAC;AAEpD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAW3C,qBAAa,8BAA8B;IACzC,OAAO,CAAC,MAAM,CAAC,OAAO,CAA8B;IACpD,OAAO,CAAC,MAAM,CAAC,SAAS,CAKb;IACX,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,UAAU,CAAC,EAAE,UAAU,EAAE,YAAY,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAqBnF;;;;;;OAMG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,4BAA4B,EAAE,2BAA2B,EAAE,GAC1D,OAAO,CAAC,yBAAyB,CAAC;IA6BrC;;;;;;OAMG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CAAC,yBAAyB,CAAC;IAkCrC;;;;;;;UAOM;IACA,6BAA6B,CACjC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,2BAA2B,EAAE,2BAA2B,EAAE,GACzD,OAAO,CAAC,2BAA2B,EAAE,CAAC;YAY3B,oBAAoB;IA4BlC,OAAO,CAAC,MAAM,CAAC,cAAc;IAW7B;;;;;;;OAOG;IACG,kCAAkC,IAAI,OAAO,CAAC,OAAO,CAAC;IAqB5D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,oCAAoC;IA2BnD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,kCAAkC;IA2BjD;;;;;;OAMG;WACU,4BAA4B,CACvC,SAAS,EAAE,MAAM,EACjB,4BAA4B,EAAE,2BAA2B,EAAE,GAC1D,OAAO,CAAC,yBAAyB,CAAC;IA6CrC;;;;;;;;OAQG;WACU,4BAA4B,CACvC,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,YAAY,EAC1B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,wBAAwB,EAAE,GAC/B,OAAO,CAAC,yBAAyB,CAAC;IA0DrC;;;;;;OAMG;WACU,0BAA0B,CACrC,SAAS,EAAE,MAAM,EACjB,0BAA0B,EAAE,yBAAyB,EAAE,GACtD,OAAO,CAAC,uBAAuB,CAAC;IA6CnC;;;;;;;;OAQG;WACU,0BAA0B,CACrC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,sBAAsB,EAAE,GAC7B,OAAO,CAAC,uBAAuB,CAAC;CAyDpC"}
+{"version":3,"file":"authorization-attributes-service.d.ts","sourceRoot":"","sources":["../../src/authorization-attributes-service.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,2BAA2B,EAC3B,2BAA2B,EAC3B,yBAAyB,EACzB,yBAAyB,EAG1B,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAY3C,qBAAa,8BAA8B;IACzC,OAAO,CAAC,MAAM,CAAC,OAAO,CAA8B;IACpD,OAAO,CAAC,MAAM,CAAS;IAEvB;;OAEG;;IAKH;;;;;;;;OAQG;IACG,6BAA6B,CACjC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,4BAA4B,EAAE,2BAA2B,EAAE,GAC1D,OAAO,CAAC,2BAA2B,EAAE,CAAC;IAQzC;;;;;;;;;OASG;IACG,6BAA6B,CACjC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CAAC,2BAA2B,EAAE,CAAC;IAUzC;;;;;;;;OAQG;IACG,2BAA2B,CAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,0BAA0B,EAAE,yBAAyB,EAAE,GACtD,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAQvC;;;;;;;;;;OAUG;IACG,2BAA2B,CAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAUvC;;;;;;;UAOM;IACA,6BAA6B,CACjC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,2BAA2B,EAAE,2BAA2B,EAAE,GACzD,OAAO,CAAC,2BAA2B,EAAE,CAAC;IAYzC;;;;;;;UAOM;IACA,2BAA2B,CAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,sBAAsB,EAAE,MAAM,EAC9B,yBAAyB,EAAE,yBAAyB,EAAE,GACrD,OAAO,CAAC,yBAAyB,EAAE,CAAC;YAYzB,4BAA4B;YA4B5B,0BAA0B;IA4BxC,OAAO,CAAC,MAAM,CAAC,cAAc;IAW7B;;;;;;;OAOG;IACG,kCAAkC,IAAI,OAAO,CAAC,OAAO,CAAC;CAoB7D"}