@mondaydotcomorg/monday-authorization 3.5.3-feat-shaime-support-entity-attributes-in-authorization-sdk-ade64f6 → 3.6.0-feat-shaime-support-entity-attributes-1-4c8e283

package/dist/authorization-attributes-sns-service.js

@@ -1,217 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const chunk = require('lodash/chunk.js');
-const mondaySns = require('@mondaydotcomorg/monday-sns');
-const types_authorizationAttributesContracts = require('./types/authorization-attributes-contracts.js');
-const authorizationInternalService = require('./authorization-internal-service.js');
-const constants_sns = require('./constants/sns.js');
-
-const _interopDefault = e => e && e.__esModule ? e : { default: e };
-
-const chunk__default = /*#__PURE__*/_interopDefault(chunk);
-
-/**
- * Service class for managing resource attributes asynchronously via SNS.
- * Provides asynchronous operations to create/update and delete attributes on resources.
- */
-class AuthorizationAttributesSnsService {
-    static LOG_TAG = 'authorization_attributes';
-    resourceSnsArn;
-    entitySnsArn;
-    /**
-     * Public constructor to create the AuthorizationAttributesSnsService instance.
-     */
-    constructor() {
-        this.resourceSnsArn = AuthorizationAttributesSnsService.getSnsTopicArn(constants_sns.SnsTopicType.RESOURCE);
-        this.entitySnsArn = AuthorizationAttributesSnsService.getSnsTopicArn(constants_sns.SnsTopicType.ENTITY);
-    }
-    /**
-     * 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
-     */
-    async upsertResourceAttributes(accountId, resourceAttributeAssignments, appName, callerActionIdentifier) {
-        if (!appName || !callerActionIdentifier) {
-            throw new Error('appName and callerActionIdentifier are required for SNS service');
-        }
-        const operations = resourceAttributeAssignments.map(assignment => ({
-            ...assignment,
-            operationType: types_authorizationAttributesContracts.AttributeOperation.UPSERT,
-        }));
-        return this.updateResourceAttributes(accountId, appName, callerActionIdentifier, operations);
-    }
-    /**
-     * 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
-     */
-    async deleteResourceAttributes(accountId, resource, attributeKeys, appName, callerActionIdentifier) {
-        if (!appName || !callerActionIdentifier) {
-            throw new Error('appName and callerActionIdentifier are required for SNS service');
-        }
-        const operations = attributeKeys.map(key => ({
-            resourceType: resource.type,
-            resourceId: resource.id,
-            key,
-            operationType: types_authorizationAttributesContracts.AttributeOperation.DELETE,
-        }));
-        return this.updateResourceAttributes(accountId, appName, callerActionIdentifier, operations);
-    }
-    /**
-     * 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
-     */
-    async upsertEntityAttributes(accountId, entityAttributeAssignments, appName, callerActionIdentifier) {
-        if (!appName || !callerActionIdentifier) {
-            throw new Error('appName and callerActionIdentifier are required for SNS service');
-        }
-        const operations = entityAttributeAssignments.map(assignment => {
-            return {
-                entityId: assignment.entityId,
-                entityType: assignment.entityType,
-                key: assignment.attributeKey,
-                value: assignment.attributeValue,
-                operationType: types_authorizationAttributesContracts.AttributeOperation.UPSERT,
-            };
-        });
-        return this.updateEntityAttributes(accountId, appName, callerActionIdentifier, operations);
-    }
-    /**
-     * 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
-     */
-    async deleteEntityAttributes(accountId, entityType, entityId, attributeKeys, appName, callerActionIdentifier) {
-        if (!appName || !callerActionIdentifier) {
-            throw new Error('appName and callerActionIdentifier are required for SNS service');
-        }
-        const operations = attributeKeys.map(key => ({
-            entityType: entityType,
-            entityId,
-            key,
-            operationType: types_authorizationAttributesContracts.AttributeOperation.DELETE,
-        }));
-        return this.updateEntityAttributes(accountId, appName, callerActionIdentifier, operations);
-    }
-    /**
-     *  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 resourceAttributeOperations - Array of operations to do on resource attributes.
-     * @return {Promise<ResourceAttributesOperation[]>} Array of sent operations
-     *  */
-    async updateResourceAttributes(accountId, appName, callerActionIdentifier, resourceAttributeOperations) {
-        const topicArn = this.resourceSnsArn;
-        const sendToSnsPromises = [];
-        const operationChucks = chunk__default.default(resourceAttributeOperations, constants_sns.ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE);
-        for (const operationsChunk of operationChucks) {
-            sendToSnsPromises.push(this.sendSingleSnsMessage(topicArn, accountId, appName, callerActionIdentifier, operationsChunk, constants_sns.RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND, 'Authorization resource attributes async update: failed to send operations to SNS'));
-        }
-        return (await Promise.all(sendToSnsPromises)).flat();
-    }
-    /**
-     *  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<EntityAttributeOperation[]>} Array of sent operations
-     *  */
-    async updateEntityAttributes(accountId, appName, callerActionIdentifier, entityAttributeOperations) {
-        const topicArn = this.entitySnsArn;
-        const sendToSnsPromises = [];
-        const operationChucks = chunk__default.default(entityAttributeOperations, constants_sns.ASYNC_ENTITY_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE);
-        for (const operationsChunk of operationChucks) {
-            sendToSnsPromises.push(this.sendSingleSnsMessage(topicArn, accountId, appName, callerActionIdentifier, operationsChunk, constants_sns.ENTITY_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND, 'Authorization entity attributes async update: failed to send operations to SNS'));
-        }
-        return (await Promise.all(sendToSnsPromises)).flat();
-    }
-    async sendSingleSnsMessage(topicArn, accountId, appName, callerActionIdentifier, operations, kind, errorLogMessage) {
-        const payload = {
-            kind,
-            payload: {
-                accountId: accountId,
-                callerAppName: appName,
-                callerActionIdentifier: callerActionIdentifier,
-                operations: operations,
-            },
-        };
-        try {
-            await mondaySns.sendToSns(payload, topicArn);
-            return operations;
-        }
-        catch (error) {
-            authorizationInternalService.logger.error({ error, tag: AuthorizationAttributesSnsService.LOG_TAG }, errorLogMessage);
-            return [];
-        }
-    }
-    static getSnsTopicArn(type) {
-        let envVarName;
-        let devTestName;
-        switch (type) {
-            case constants_sns.SnsTopicType.ENTITY:
-                envVarName = constants_sns.ENTITY_SNS_ARN_ENV_VAR_NAME;
-                devTestName = constants_sns.ENTITY_SNS_DEV_TEST_NAME;
-                break;
-            default:
-                // Default to resource SNS constants
-                envVarName = constants_sns.RESOURCE_SNS_ARN_ENV_VAR_NAME;
-                devTestName = constants_sns.RESOURCE_SNS_DEV_TEST_NAME;
-                break;
-        }
-        const arnFromEnv = process.env[envVarName];
-        if (arnFromEnv) {
-            return arnFromEnv;
-        }
-        if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
-            return devTestName;
-        }
-        throw new Error(`Unable to get ${type} sns topic arn from env variable`);
-    }
-    /**
-     * Checks we can contact the required SNS topic that used to send attribute updates to Authorization MS.
-     * This function can be used as health check for services that updating resource attributes in async is crucial.
-     * Note this function only verify the POD can contact AWS SDK and the topic exists, but the user still might get
-     * errors when pushing for the SNS (e.g: in case the AWS role of the POD don't have permissions to push messages).
-     * However, this is the best we can do without actually push dummy messages to the SNS.
-     * @return {Promise<boolean>} - true if succeeded
-     */
-    async asyncResourceAttributesHealthCheck() {
-        try {
-            const requestedTopicArn = this.resourceSnsArn;
-            const attributes = await mondaySns.getTopicAttributes(requestedTopicArn);
-            const isHealthy = !(!attributes || !('TopicArn' in attributes) || attributes.TopicArn !== requestedTopicArn);
-            if (!isHealthy) {
-                authorizationInternalService.logger.error({ requestedTopicArn, snsReturnedAttributes: attributes, tag: AuthorizationAttributesSnsService.LOG_TAG }, 'authorization-attributes-service failed in health check');
-            }
-            return isHealthy;
-        }
-        catch (error) {
-            authorizationInternalService.logger.error({ error, tag: AuthorizationAttributesSnsService.LOG_TAG }, 'authorization-attributes-service got error during health check');
-            return false;
-        }
-    }
-}
-
-exports.AuthorizationAttributesSnsService = AuthorizationAttributesSnsService;

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

@@ -1,90 +0,0 @@
-import { ResourceAttributeAssignment } from './resource-attribute-assignment';
-import { EntityAttributeAssignment } from './entity-attribute-assignment';
-import { EntityType, ResourceAttributeOperation, EntityAttributeOperation } from './types/authorization-attributes-contracts';
-import { IAuthorizationAttributesService } from './types/authorization-attributes-service.interface';
-import { Resource } from './types/general';
-/**
- * Service class for managing resource attributes in the authorization microservice.
- * Provides synchronous HTTP operations to create/update and delete attributes on resources.
- */
-export declare class AuthorizationAttributesMsService implements IAuthorizationAttributesService {
-    private static LOG_TAG;
-    private static httpClient;
-    /**
-     * Creates or updates resource attributes synchronously.
-     * @param accountId The account ID
-     * @param resourceAttributeAssignments Array of ResourceAttributeAssignment objects
-     * @returns Promise<void>
-     */
-    upsertResourceAttributes(accountId: number, resourceAttributeAssignments: ResourceAttributeAssignment[], _appName?: string, _callerActionIdentifier?: string): Promise<void>;
-    /**
-     * Deletes specific attributes from a resource synchronously.
-     * @param accountId The account ID
-     * @param resource Object with resourceType (string) and resourceId (number)
-     * @param attributeKeys Array of attribute key strings to delete
-     * @returns Promise<void>
-     */
-    deleteResourceAttributes(accountId: number, resource: Resource, attributeKeys: string[], _appName?: string, _callerActionIdentifier?: string): Promise<void>;
-    /**
-     * Creates or updates entity attributes synchronously.
-     * @param accountId The account ID
-     * @param entityAttributeAssignments Array of EntityAttributeAssignment objects
-     * @returns Promise<void>
-     */
-    upsertEntityAttributes(accountId: number, entityAttributeAssignments: EntityAttributeAssignment[], _appName?: string, _callerActionIdentifier?: string): Promise<void>;
-    /**
-     * 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>
-     */
-    deleteEntityAttributes(accountId: number, entityType: EntityType | string, entityId: number, attributeKeys: string[], _appName?: string, _callerActionIdentifier?: string): Promise<void>;
-    /**
-     * Updates resource attributes (batch operations).
-     * Note: MS service does not support batch operations directly.
-     * This method processes operations sequentially using upsert/delete methods.
-     * @param accountId The account ID
-     * @param appName App name (required for interface compatibility, but not used in MS service)
-     * @param callerActionIdentifier Action identifier (required for interface compatibility, but not used in MS service)
-     * @param resourceAttributeOperations Array of operations to perform
-     * @returns Promise<ResourceAttributesOperation[]> Array of processed operations
-     */
-    updateResourceAttributes(accountId: number, _appName: string, _callerActionIdentifier: string, resourceAttributeOperations: ResourceAttributeOperation[]): Promise<ResourceAttributeOperation[]>;
-    /**
-     * Updates entity attributes (batch operations).
-     * Note: MS service does not support batch operations directly.
-     * This method processes operations sequentially using upsert/delete methods.
-     * @param accountId The account ID
-     * @param appName App name (required for interface compatibility, but not used in MS service)
-     * @param callerActionIdentifier Action identifier (required for interface compatibility, but not used in MS service)
-     * @param entityAttributeOperations Array of operations to perform
-     * @returns Promise<EntityAttributesOperation[]> Array of processed operations
-     */
-    updateEntityAttributes(accountId: number, _appName: string, _callerActionIdentifier: string, entityAttributeOperations: EntityAttributeOperation[]): Promise<EntityAttributeOperation[]>;
-    /**
-     * Replaces path template parameters with actual values
-     * @param template Path template with placeholders like {accountId}
-     * @param params Object with parameter names and values
-     * @returns Path with all placeholders replaced
-     */
-    private static replacePathParams;
-    /**
-     * Generic helper for executing delete requests
-     */
-    private static executeDeleteRequest;
-    /**
-     * Gets request headers including Authorization, Content-Type, and optional attribution headers
-     */
-    private static getRequestHeaders;
-    /**
-     * Validates that all messages are instances of the specified message class
-     */
-    private static validateMessages;
-    /**
-     * Generic helper for executing upsert requests
-     */
-    private static executeUpsertRequest;
-}
-//# sourceMappingURL=authorization-attributes-ms-service.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"authorization-attributes-ms-service.d.ts","sourceRoot":"","sources":["../../src/authorization-attributes-ms-service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,EAEL,UAAU,EACV,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,4CAA4C,CAAC;AAMpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,oDAAoD,CAAC;AACrG,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAW3C;;;GAGG;AACH,qBAAa,gCAAiC,YAAW,+BAA+B;IACtF,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD,OAAO,CAAC,MAAM,CAAC,UAAU,CAAqD;IAC9E;;;;;OAKG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,4BAA4B,EAAE,2BAA2B,EAAE,EAC3D,QAAQ,CAAC,EAAE,MAAM,EACjB,uBAAuB,CAAC,EAAE,MAAM,GAC/B,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;OAMG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,QAAQ,EAClB,aAAa,EAAE,MAAM,EAAE,EACvB,QAAQ,CAAC,EAAE,MAAM,EACjB,uBAAuB,CAAC,EAAE,MAAM,GAC/B,OAAO,CAAC,IAAI,CAAC;IAyBhB;;;;;OAKG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,0BAA0B,EAAE,yBAAyB,EAAE,EACvD,QAAQ,CAAC,EAAE,MAAM,EACjB,uBAAuB,CAAC,EAAE,MAAM,GAC/B,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;OAOG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,UAAU,GAAG,MAAM,EAC/B,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EAAE,EACvB,QAAQ,CAAC,EAAE,MAAM,EACjB,uBAAuB,CAAC,EAAE,MAAM,GAC/B,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;;;;;;OASG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,uBAAuB,EAAE,MAAM,EAC/B,2BAA2B,EAAE,0BAA0B,EAAE,GACxD,OAAO,CAAC,0BAA0B,EAAE,CAAC;IAoCxC;;;;;;;;;OASG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,uBAAuB,EAAE,MAAM,EAC/B,yBAAyB,EAAE,wBAAwB,EAAE,GACpD,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAiBtC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAQhC;;OAEG;mBACkB,oBAAoB;IA0EzC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA+ChC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAsD/B;;OAEG;mBACkB,oBAAoB;CA4F1C"}