@mondaydotcomorg/monday-authorization 1.1.9-featureliorshonehourjwttoken.465 → 1.1.9-featuremosheauthorizationesm.3695

package/dist/types/general.js

@@ -0,0 +1 @@
+

package/dist/types/scoped-actions-contracts.d.ts

@@ -0,0 +1,38 @@
+export interface WorkspaceScope {
+    workspaceId: number;
+}
+export interface BoardScope {
+    boardId: number;
+}
+export interface PulseScope {
+    pulseId: number;
+}
+export interface AccountProductScope {
+    accountProductId: number;
+}
+export interface AccountScope {
+    accountId: number;
+}
+export type ScopeOptions = WorkspaceScope | BoardScope | PulseScope | AccountProductScope | AccountScope;
+export interface Translation {
+    key: string;
+    [option: string]: string;
+}
+export declare enum PermitTechnicalReason {
+    NO_REASON = 0,
+    NOT_ELIGIBLE = 1,
+    BY_ROLE_IN_SCOPE = 2
+}
+export interface ScopedActionPermit {
+    can: boolean;
+    reason: Translation;
+    technicalReason: PermitTechnicalReason;
+}
+export interface ScopedAction {
+    action: string;
+    scope: ScopeOptions;
+}
+export interface ScopedActionResponseObject {
+    scopedAction: ScopedAction;
+    permit: ScopedActionPermit;
+}

package/dist/{lib/types → types}/scoped-actions-contracts.js

@@ -1,9 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
 exports.PermitTechnicalReason = void 0;
-var PermitTechnicalReason;
 (function (PermitTechnicalReason) {
     PermitTechnicalReason[PermitTechnicalReason["NO_REASON"] = 0] = "NO_REASON";
     PermitTechnicalReason[PermitTechnicalReason["NOT_ELIGIBLE"] = 1] = "NOT_ELIGIBLE";
     PermitTechnicalReason[PermitTechnicalReason["BY_ROLE_IN_SCOPE"] = 2] = "BY_ROLE_IN_SCOPE";
-})(PermitTechnicalReason || (exports.PermitTechnicalReason = PermitTechnicalReason = {}));
+})(exports.PermitTechnicalReason || (exports.PermitTechnicalReason = {}));

package/package.json

@@ -1,36 +1,59 @@
 {
   "name": "@mondaydotcomorg/monday-authorization",
-  "version": "1.1.9-featureliorshonehourjwttoken.465+164eb3b11",
+  "version": "1.1.9-featuremosheauthorizationesm.3695+dabe70b1e",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "BSD-3-Clause",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "scripts": {
-    "test": "mocha -r ts-node/register -r tsconfig-paths/register './tests/*.test.ts' --timeout 5000 --exit",
-    "build": "tsc --build"
+    "test": "trident-library test",
+    "lint": "trident-library lint",
+    "build": "trident-library build",
+    "watch": "trident-library build -w"
   },
   "dependencies": {
     "@mondaydotcomorg/monday-fetch": "^0.0.7",
-    "@mondaydotcomorg/monday-jwt": "^3.0.9-featureliorshonehourjwttoken.465+164eb3b11",
-    "@mondaydotcomorg/monday-logger": "^3.0.10",
+    "@mondaydotcomorg/monday-jwt": "^3.0.14",
+    "@mondaydotcomorg/monday-logger": "^4.0.11",
+    "@mondaydotcomorg/monday-sns": "^1.0.6",
+    "@mondaydotcomorg/trident-backend-api": "^0.23.10",
+    "@types/lodash": "^4.17.10",
+    "lodash": "^4.17.21",
     "node-fetch": "^2.6.7",
+    "on-headers": "^1.0.2",
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
+    "@mondaydotcomorg/trident-library": "^0.6.53",
     "@types/express": "^4.17.20",
+    "@types/jest": "^27.4.1",
     "@types/mocha": "^8.2.2",
     "@types/on-headers": "^1.0.0",
     "@types/supertest": "^2.0.11",
     "express": "^4.17.1",
     "ioredis": "^5.2.4",
     "ioredis-mock": "^8.2.2",
+    "jest": "^27.5.1",
     "mocha": "^9.0.1",
-    "on-headers": "^1.0.2",
     "supertest": "^6.1.3",
+    "ts-jest": "^27.1.3",
     "tsconfig-paths": "^3.9.0",
     "typescript": "^5.1.6"
   },
   "files": [
     "dist/"
   ],
-  "gitHead": "164eb3b11392586ed8175eaa15ec61c914a85234"
+  "trident": {
+    "build": {
+      "esmMjsRename": true
+    }
+  },
+  "gitHead": "dabe70b1ee6b4bee07fdd8ca06eb4944d62a4c96"
 }

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

@@ -1,6 +0,0 @@
-import { Request } from 'express';
-export declare class AuthorizationInternalService {
-    static skipAuthorization(requset: Request): void;
-    static markAuthorized(request: Request): void;
-    static failIfNotCoveredByAuthorization(request: Request): void;
-}

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

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthorizationInternalService = void 0;
-class AuthorizationInternalService {
-    static skipAuthorization(requset) {
-        requset.authorizationSkipPerformed = true;
-    }
-    static markAuthorized(request) {
-        request.authorizationCheckPerformed = true;
-    }
-    static failIfNotCoveredByAuthorization(request) {
-        if (!request.authorizationCheckPerformed && !request.authorizationSkipPerformed) {
-            throw 'Endpoint is not covered by authorization check';
-        }
-    }
-}
-exports.AuthorizationInternalService = AuthorizationInternalService;

package/dist/lib/authorization-middleware.js

@@ -1,54 +0,0 @@
-"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());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.authorizationCheckMiddleware = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = void 0;
-const on_headers_1 = __importDefault(require("on-headers"));
-const authorization_internal_service_1 = require("./authorization-internal-service");
-const authorization_service_1 = require("./authorization-service");
-function getAuthorizationMiddleware(action, resourceGetter, contextGetter) {
-    return function authorizationMiddleware(request, response, next) {
-        return __awaiter(this, void 0, void 0, function* () {
-            contextGetter || (contextGetter = defaultContextGetter);
-            const { userId, accountId } = contextGetter(request);
-            const resources = resourceGetter(request);
-            const { isAuthorized } = yield authorization_service_1.AuthorizationService.isAuthorized(accountId, userId, resources, action);
-            authorization_internal_service_1.AuthorizationInternalService.markAuthorized(request);
-            if (!isAuthorized) {
-                response.status(403).json({ message: 'Access denied' });
-                return;
-            }
-            next();
-        });
-    };
-}
-exports.getAuthorizationMiddleware = getAuthorizationMiddleware;
-function skipAuthorizationMiddleware(request, response, next) {
-    authorization_internal_service_1.AuthorizationInternalService.skipAuthorization(request);
-    next();
-}
-exports.skipAuthorizationMiddleware = skipAuthorizationMiddleware;
-function authorizationCheckMiddleware(request, response, next) {
-    if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
-        (0, on_headers_1.default)(response, function () {
-            if (response.statusCode < 400) {
-                authorization_internal_service_1.AuthorizationInternalService.failIfNotCoveredByAuthorization(request);
-            }
-        });
-    }
-    next();
-}
-exports.authorizationCheckMiddleware = authorizationCheckMiddleware;
-function defaultContextGetter(request) {
-    return request.payload;
-}

package/dist/lib/authorization-service.js

@@ -1,233 +0,0 @@
-"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) {
-        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.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 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);
-}
-exports.setRequestFetchOptions = setRequestFetchOptions;
-function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS) {
-    AuthorizationService.redisClient = client;
-    if (grantedFeatureRedisExpirationInSeconds && grantedFeatureRedisExpirationInSeconds > 0) {
-        AuthorizationService.grantedFeatureRedisExpirationInSeconds = grantedFeatureRedisExpirationInSeconds;
-    }
-    else {
-        logger.warn({ grantedFeatureRedisExpirationInSeconds }, 'Invalid input for grantedFeatureRedisExpirationInSeconds, must be positive number. using default ttl.');
-        AuthorizationService.grantedFeatureRedisExpirationInSeconds = GRANTED_FEATURE_CACHE_EXPIRATION_SECONDS;
-    }
-}
-exports.setRedisClient = setRedisClient;
-class AuthorizationService {
-    static isAuthorized(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (args.length === 3) {
-                return this.isAuthorizedMultiple(args[0], args[1], args[2]);
-            }
-            else if (args.length == 4) {
-                return this.isAuthorizedSingular(args[0], args[1], args[2], args[3]);
-            }
-            else {
-                throw new Error('isAuthorized accepts either 3 or 4 arguments');
-            }
-        });
-    }
-    static isUserGrantedWithFeature(accountId, userId, featureName, options = {}) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            let cachedKey = this.getCachedKeyName(userId, featureName);
-            const shouldSkipCache = (_a = options.shouldSkipCache) !== null && _a !== void 0 ? _a : false;
-            if (this.redisClient && !shouldSkipCache) {
-                let grantedFeatureValue = yield this.redisClient.get(cachedKey);
-                if (!(grantedFeatureValue === undefined || grantedFeatureValue === null)) {
-                    // redis returns the value as string
-                    return grantedFeatureValue === 'true';
-                }
-            }
-            let grantedFeatureValue = yield this.fetchIsUserGrantedWithFeature(featureName, accountId, userId);
-            if (this.redisClient) {
-                yield this.redisClient.set(cachedKey, grantedFeatureValue, 'EX', this.grantedFeatureRedisExpirationInSeconds);
-            }
-            return grantedFeatureValue;
-        });
-    }
-    static fetchIsUserGrantedWithFeature(featureName, accountId, userId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let authorizationObject = {
-                action: featureName,
-                resource_type: 'feature',
-            };
-            let authorizeResponsePromise = yield this.isAuthorized(accountId, userId, [authorizationObject]);
-            return authorizeResponsePromise.isAuthorized;
-        });
-    }
-    static getCachedKeyName(userId, featureName) {
-        return `granted-feature-${featureName}-${userId}`;
-    }
-    static canActionInScope(accountId, userId, action, scope) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const scopedActions = [{ action, scope }];
-            const scopedActionResponseObjects = yield this.canActionInScopeMultiple(accountId, userId, scopedActions);
-            return scopedActionResponseObjects[0].permit;
-        });
-    }
-    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 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(),
-                body: JSON.stringify({
-                    user_id: userId,
-                    scoped_actions: scopedActionsPayload,
-                }),
-            }, mondayFetchOptions);
-            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 => {
-                const { scopedAction, permit } = responseObject;
-                const { scope } = scopedAction;
-                const transformKeys = (obj) => camelCaseKeys(obj);
-                return Object.assign(Object.assign({}, responseObject), { scopedAction: Object.assign(Object.assign({}, scopedAction), { scope: transformKeys(scope) }), permit: transformKeys(permit) });
-            });
-            return scopedActionsResponseObjects;
-        });
-    }
-    static isAuthorizedSingular(accountId, userId, resources, action) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { authorizationObjects } = createAuthorizationParams(resources, action);
-            return this.isAuthorizedMultiple(accountId, userId, authorizationObjects);
-        });
-    }
-    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 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(),
-                body: JSON.stringify({
-                    user_id: userId,
-                    authorize_request_objects: authorizationRequestObjects,
-                }),
-            }, mondayFetchOptions);
-            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');
-            const responseBody = yield response.json();
-            const unauthorizedObjects = [];
-            responseBody.result.forEach(function (isAuthorized, index) {
-                const authorizationObject = authorizationRequestObjects[index];
-                if (!isAuthorized) {
-                    unauthorizedObjects.push(authorizationObject);
-                }
-                (0, prometheus_service_1.sendAuthorizationCheckResponseTimeMetric)(authorizationObject.resource_type, authorizationObject.action, isAuthorized, responseStatus, time);
-            });
-            if (unauthorizedObjects.length > 0) {
-                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: true };
-        });
-    }
-}
-exports.AuthorizationService = AuthorizationService;
-function createAuthorizationParams(resources, action) {
-    const params = {
-        authorizationObjects: resources.map((resource) => {
-            const authorizationObject = {
-                resource_id: resource.id,
-                resource_type: resource.type,
-                action,
-            };
-            if (resource.wrapperData) {
-                authorizationObject.wrapper_data = resource.wrapperData;
-            }
-            return authorizationObject;
-        }),
-    };
-    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/express.js

@@ -1 +0,0 @@
-"use strict";

package/dist/lib/types/general.js

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