@mondaydotcomorg/monday-authorization 1.1.9-featureorcomonday-jwt-ts.472 → 1.1.9-featureyardenresource-attributes-api-support-authz-sdk.1565

package/CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.2.0] - 2024-01-05
+### Added
+ - `isAuthorized` now return the unauthorized objects - regardless to the unauthorized ids (which may be missing resource ids if resource has no id, like `feature` e.g.)
+
 ## [1.1.0] - 2023-08-09
 
 ### ⚠ BREAKING CHANGES

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

@@ -0,0 +1,11 @@
+import { ResourceAttributeAssignment } from 'lib/types/authorization-attributes-contracts';
+import { Resource } from 'lib/types/general';
+export declare class AuthorizationAttributesService {
+    static upsertResourceAttributesSync(accountId: number, userId: number, resourceAttributesAssignments: ResourceAttributeAssignment[]): Promise<{
+        attributes: any;
+    }>;
+    static deleteResourceAttributesSync(accountId: number, resource: Resource, attributeKeys: string[]): Promise<{
+        attributes: any;
+    }>;
+    private static getResourceAttributesUrl;
+}

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

@@ -0,0 +1,50 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthorizationAttributesService = void 0;
+const monday_fetch_1 = require("@mondaydotcomorg/monday-fetch");
+const authorization_internal_service_1 = require("lib/authorization-internal-service");
+// TODO : Delete this once done
+class AuthorizationAttributesService {
+    static upsertResourceAttributesSync(accountId, userId, resourceAttributesAssignments) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
+            const response = yield (0, monday_fetch_1.fetch)(this.getResourceAttributesUrl(accountId), {
+                method: 'POST',
+                headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
+                timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
+                body: JSON.stringify({ resourceAttributesAssignments }),
+            }, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
+            const responseBody = yield response.json();
+            authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'upsertResourceAttributesSync');
+            return { attributes: responseBody['attributes'] };
+        });
+    }
+    static deleteResourceAttributesSync(accountId, resource, attributeKeys) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, 0);
+            const url = `${this.getResourceAttributesUrl(accountId)}/${resource.type}/${resource.id}`;
+            const response = yield (0, monday_fetch_1.fetch)(url, {
+                method: 'DELETE',
+                headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
+                timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
+                body: JSON.stringify({ keys: attributeKeys }),
+            }, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
+            const responseBody = yield response.json();
+            authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'deleteResourceAttributesSync');
+            return { attributes: responseBody['attributes'] };
+        });
+    }
+    static getResourceAttributesUrl(accountId) {
+        return `${process.env.AUTHORIZATION_URL}/attributes/${accountId}/resource`;
+    }
+}
+exports.AuthorizationAttributesService = AuthorizationAttributesService;

package/dist/lib/authorization-internal-service.d.ts

@@ -1,6 +1,15 @@
+/// <reference types="bunyan" />
 import { Request } from 'express';
+import { fetch, MondayFetchOptions } from '@mondaydotcomorg/monday-fetch';
+import * as MondayLogger from '@mondaydotcomorg/monday-logger';
+export declare const logger: MondayLogger.Logger;
 export declare class AuthorizationInternalService {
     static skipAuthorization(requset: Request): void;
     static markAuthorized(request: Request): void;
     static failIfNotCoveredByAuthorization(request: Request): void;
+    static throwOnHttpErrorIfNeeded(response: Awaited<ReturnType<typeof fetch>>, placement: string): void;
+    static generateInternalAuthToken(accountId: number, userId: number): string;
+    static setRequestFetchOptions(customMondayFetchOptions: MondayFetchOptions): void;
+    static getRequestFetchOptions(): MondayFetchOptions;
+    static getRequestTimeout(): 60000 | 2000;
 }

package/dist/lib/authorization-internal-service.js

@@ -1,6 +1,46 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthorizationInternalService = void 0;
+exports.AuthorizationInternalService = exports.logger = void 0;
+const monday_jwt_1 = require("@mondaydotcomorg/monday-jwt");
+const MondayLogger = __importStar(require("@mondaydotcomorg/monday-logger"));
+const INTERNAL_APP_NAME = 'internal_ms';
+const defaultMondayFetchOptions = {
+    retries: 3,
+    callback: logOnFetchFail,
+};
+function logOnFetchFail(retriesLeft, error) {
+    if (retriesLeft == 0) {
+        exports.logger.error({ retriesLeft, error }, 'Authorization attempt failed due to network issues');
+    }
+    else {
+        exports.logger.info({ retriesLeft, error }, 'Authorization attempt failed due to network issues, trying again');
+    }
+}
+let mondayFetchOptions = defaultMondayFetchOptions;
+exports.logger = MondayLogger.getLogger();
 class AuthorizationInternalService {
     static skipAuthorization(requset) {
         requset.authorizationSkipPerformed = true;
@@ -13,5 +53,26 @@ class AuthorizationInternalService {
             throw 'Endpoint is not covered by authorization check';
         }
     }
+    static throwOnHttpErrorIfNeeded(response, placement) {
+        if (response.ok) {
+            return;
+        }
+        const status = response.status;
+        exports.logger.error({ tag: 'authorization-service', placement, status }, 'AuthorizationService: authorization request failed');
+        throw new Error(`AuthorizationService: [${placement}] authorization request failed with status ${status}`);
+    }
+    static generateInternalAuthToken(accountId, userId) {
+        return (0, monday_jwt_1.signAuthorizationHeader)({ appName: INTERNAL_APP_NAME, accountId, userId });
+    }
+    static setRequestFetchOptions(customMondayFetchOptions) {
+        mondayFetchOptions = Object.assign(Object.assign({}, defaultMondayFetchOptions), customMondayFetchOptions);
+    }
+    static getRequestFetchOptions() {
+        return mondayFetchOptions;
+    }
+    static getRequestTimeout() {
+        const isDevEnv = process.env.NODE_ENV === 'development';
+        return isDevEnv ? 60000 : 2000;
+    }
 }
 exports.AuthorizationInternalService = AuthorizationInternalService;

package/dist/lib/authorization-service.d.ts

@@ -4,6 +4,7 @@ import { ScopedAction, ScopedActionPermit, ScopedActionResponseObject, ScopeOpti
 export interface AuthorizeResponse {
     isAuthorized: boolean;
     unauthorizedIds?: number[];
+    unauthorizedObjects?: AuthorizationObject[];
 }
 export declare function setRequestFetchOptions(customMondayFetchOptions: MondayFetchOptions): void;
 export declare function setRedisClient(client: any, grantedFeatureRedisExpirationInSeconds?: number): void;

package/dist/lib/authorization-service.js

@@ -1,27 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -35,20 +12,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthorizationService = exports.setRedisClient = exports.setRequestFetchOptions = void 0;
 const lodash_1 = require("lodash");
 const perf_hooks_1 = require("perf_hooks");
-const monday_jwt_1 = require("@mondaydotcomorg/monday-jwt");
-const MondayLogger = __importStar(require("@mondaydotcomorg/monday-logger"));
 const monday_fetch_1 = require("@mondaydotcomorg/monday-fetch");
 const prometheus_service_1 = require("./prometheus-service");
-const INTERNAL_APP_NAME = 'internal_ms';
-const logger = MondayLogger.getLogger();
+const authorization_internal_service_1 = require("lib/authorization-internal-service");
 const GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS = 5 * 60;
-const defaultMondayFetchOptions = {
-    retries: 3,
-    callback: logOnFetchFail,
-};
-let mondayFetchOptions = defaultMondayFetchOptions;
 function setRequestFetchOptions(customMondayFetchOptions) {
-    mondayFetchOptions = Object.assign(Object.assign({}, defaultMondayFetchOptions), customMondayFetchOptions);
+    authorization_internal_service_1.AuthorizationInternalService.setRequestFetchOptions(customMondayFetchOptions);
 }
 exports.setRequestFetchOptions = setRequestFetchOptions;
 function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS) {
@@ -57,7 +26,7 @@ function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = GRANTED
         AuthorizationService.grantedFeatureRedisExpirationInSeconds = grantedFeatureRedisExpirationInSeconds;
     }
     else {
-        logger.warn({ grantedFeatureRedisExpirationInSeconds }, 'Invalid input for grantedFeatureRedisExpirationInSeconds, must be positive number. using default ttl.');
+        authorization_internal_service_1.logger.warn({ grantedFeatureRedisExpirationInSeconds }, 'Invalid input for grantedFeatureRedisExpirationInSeconds, must be positive number. using default ttl.');
         AuthorizationService.grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS;
     }
 }
@@ -117,20 +86,20 @@ class AuthorizationService {
     }
     static canActionInScopeMultiple(accountId, userId, scopedActions) {
         return __awaiter(this, void 0, void 0, function* () {
-            const internalAuthToken = (0, monday_jwt_1.signAuthorizationHeader)({ appName: INTERNAL_APP_NAME, accountId, userId });
+            const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
             const scopedActionsPayload = scopedActions.map(scopedAction => {
                 return Object.assign(Object.assign({}, scopedAction), { scope: (0, lodash_1.mapKeys)(scopedAction.scope, (_, key) => (0, lodash_1.snakeCase)(key)) }); // for example: { workspaceId: 1 } => { workspace_id: 1 }
             });
             const response = yield (0, monday_fetch_1.fetch)(getCanActionsInScopesUrl(), {
                 method: 'POST',
                 headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
-                timeout: getRequestTimeout(),
+                timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
                 body: JSON.stringify({
                     user_id: userId,
                     scoped_actions: scopedActionsPayload,
                 }),
-            }, mondayFetchOptions);
-            throwOnHttpErrorIfNeeded(response, 'canActionInScopeMultiple');
+            }, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
+            authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'canActionInScopeMultiple');
             const responseBody = yield response.json();
             const camelCaseKeys = (obj) => Object.fromEntries(Object.entries(obj).map(([key, value]) => [(0, lodash_1.camelCase)(key), value]));
             const scopedActionsResponseObjects = responseBody.result.map(responseObject => {
@@ -150,22 +119,22 @@ class AuthorizationService {
     }
     static isAuthorizedMultiple(accountId, userId, authorizationRequestObjects) {
         return __awaiter(this, void 0, void 0, function* () {
-            const internalAuthToken = (0, monday_jwt_1.signAuthorizationHeader)({ appName: INTERNAL_APP_NAME, accountId, userId });
+            const internalAuthToken = authorization_internal_service_1.AuthorizationInternalService.generateInternalAuthToken(accountId, userId);
             const startTime = perf_hooks_1.performance.now();
             const response = yield (0, monday_fetch_1.fetch)(getAuthorizeUrl(), {
                 method: 'POST',
                 headers: { Authorization: internalAuthToken, 'Content-Type': 'application/json' },
-                timeout: getRequestTimeout(),
+                timeout: authorization_internal_service_1.AuthorizationInternalService.getRequestTimeout(),
                 body: JSON.stringify({
                     user_id: userId,
                     authorize_request_objects: authorizationRequestObjects,
                 }),
-            }, mondayFetchOptions);
+            }, authorization_internal_service_1.AuthorizationInternalService.getRequestFetchOptions());
             const endTime = perf_hooks_1.performance.now();
             const time = endTime - startTime;
             const responseStatus = response.status;
             (0, prometheus_service_1.sendAuthorizationChecksPerRequestMetric)(responseStatus, authorizationRequestObjects.length);
-            throwOnHttpErrorIfNeeded(response, 'isAuthorizedMultiple');
+            authorization_internal_service_1.AuthorizationInternalService.throwOnHttpErrorIfNeeded(response, 'isAuthorizedMultiple');
             const responseBody = yield response.json();
             const unauthorizedObjects = [];
             responseBody.result.forEach(function (isAuthorized, index) {
@@ -176,13 +145,13 @@ class AuthorizationService {
                 (0, prometheus_service_1.sendAuthorizationCheckResponseTimeMetric)(authorizationObject.resource_type, authorizationObject.action, isAuthorized, responseStatus, time);
             });
             if (unauthorizedObjects.length > 0) {
-                logger.info({
+                authorization_internal_service_1.logger.info({
                     resources: JSON.stringify(unauthorizedObjects),
                 }, 'AuthorizationService: resource is unauthorized');
                 const unauthorizedIds = unauthorizedObjects
                     .filter(obj => !!obj.resource_id)
                     .map(obj => obj.resource_id);
-                return { isAuthorized: false, unauthorizedIds };
+                return { isAuthorized: false, unauthorizedIds, unauthorizedObjects };
             }
             return { isAuthorized: true };
         });
@@ -205,29 +174,9 @@ function createAuthorizationParams(resources, action) {
     };
     return params;
 }
-function logOnFetchFail(retriesLeft, error) {
-    if (retriesLeft == 0) {
-        logger.error({ retriesLeft, error }, 'Authorization attempt failed due to network issues');
-    }
-    else {
-        logger.info({ retriesLeft, error }, 'Authorization attempt failed due to network issues, trying again');
-    }
-}
 function getAuthorizeUrl() {
     return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/authorize`;
 }
 function getCanActionsInScopesUrl() {
     return `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/can_actions_in_scopes`;
 }
-function getRequestTimeout() {
-    const isDevEnv = process.env.NODE_ENV === 'development';
-    return isDevEnv ? 60000 : 2000;
-}
-function throwOnHttpErrorIfNeeded(response, placement) {
-    if (response.ok) {
-        return;
-    }
-    const status = response.status;
-    logger.error({ tag: 'authorization-service', placement, status }, 'AuthorizationService: authorization request failed');
-    throw new Error(`AuthorizationService: [${placement}] authorization request failed with status ${status}`);
-}

package/dist/lib/types/authorization-attributes-contracts.d.ts

@@ -0,0 +1,7 @@
+import { Resource } from 'lib/types/general';
+export interface ResourceAttributeAssignment {
+    resourceType: Resource['type'];
+    resourceId: Resource['id'];
+    key: string;
+    value: string;
+}

package/dist/lib/types/authorization-attributes-contracts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/monday-authorization",
-  "version": "1.1.9-featureorcomonday-jwt-ts.472+0053951b7",
+  "version": "1.1.9-featureyardenresource-attributes-api-support-authz-sdk.1565+f9c972a7f",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "BSD-3-Clause",
@@ -10,9 +10,10 @@
   },
   "dependencies": {
     "@mondaydotcomorg/monday-fetch": "^0.0.7",
-    "@mondaydotcomorg/monday-jwt": "^3.0.9-featureorcomonday-jwt-ts.472+0053951b7",
+    "@mondaydotcomorg/monday-jwt": "^3.0.10",
     "@mondaydotcomorg/monday-logger": "^3.0.10",
     "node-fetch": "^2.6.7",
+    "on-headers": "^1.0.2",
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
@@ -24,7 +25,6 @@
     "ioredis": "^5.2.4",
     "ioredis-mock": "^8.2.2",
     "mocha": "^9.0.1",
-    "on-headers": "^1.0.2",
     "supertest": "^6.1.3",
     "tsconfig-paths": "^3.9.0",
     "typescript": "^5.1.6"
@@ -32,5 +32,5 @@
   "files": [
     "dist/"
   ],
-  "gitHead": "0053951b70f13ef040d8646d709dd3cdcce11168"
+  "gitHead": "f9c972a7f2c5b339d0c7a012bc8e4d2568d44549"
 }