@mondaydotcomorg/monday-authorization 1.0.44-featureyoniadd-granted-feature-sdk-api.558 → 1.0.44-featureyoniadd-granted-feature-sdk-api.560

package/README.md

@@ -16,10 +16,6 @@ show is the action, post is the resource.
 yarn add @mondaydotcomorg/monday-authorization
 ```
 
-## Usage
-
-First init the package in order for it to work properly
-
 app.ts:
 
 ```ts
@@ -28,11 +24,24 @@ import * as MondayAuthorization from '@mondaydotcomorg/monday-authorization';
 
 ...
 
-MondayAuthorization.init({ prometheus: getPrometheus() });
+MondayAuthorization.init({
+  prometheus: getPrometheus(),
+  redisClient: redisClient,
+  grantedFeatureRedisExpirationInSeconds: 10 * 60
+});
 startServer(...)
 ```
 
-Then add this code to any route declaration:
+**Recommended** - optionally init authorization with redisClient so the granted feature results will be cached and reduce http calls.
+
+- grantedFeatureRedisExpirationInSeconds - (optional), redis TTL for cached granted features, default set to 5 minutes 
+
+
+## Usage
+
+### Use as Middleware
+
+Add this code to any route declaration:
 
 ```ts
 import { Router } from 'express';
@@ -80,3 +89,15 @@ function, that looks like this:
 Add `authorizationCheckMiddleware` to make sure that all routes are covered by authorization check. Put this
 middleware before you define the routes.
 If you want to skip authorization, use `skipAuthorizationMiddleware`.
+
+
+### Granted Features API
+
+Use `AuthorizationService.isUserGrantedWithFeature(accountId: number, userId: number, featureName: string): Promise<boolean>` to retrieve if a user is granted with a feature
+
+```ts
+import {AuthorizationService, init} from '@mondaydotcomorg/monday-authorization';
+
+let isFeatuerGranted = await AuthorizationService.isUserGrantedWithFeature(739628, 2, "unauthorized_content_change_message")
+```
+

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export interface InitOptions {
     prometheus?: any;
     mondayFetchOptions?: MondayFetchOptions;
     redisClient?: any;
+    grantedFeatureRedisExpirationInSeconds?: number;
 }
 export declare function init(options?: InitOptions): void;
 export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware, } from './lib/authorization-middleware';

package/dist/index.js

@@ -11,7 +11,7 @@ function init(options = {}) {
         authorization_service_1.setRequestFetchOptions(options.mondayFetchOptions);
     }
     if (options.redisClient) {
-        authorization_service_1.setRedisClient(options.redisClient);
+        authorization_service_1.setRedisClient(options.redisClient, options.grantedFeatureRedisExpirationInSeconds);
     }
 }
 exports.init = init;

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

@@ -5,10 +5,10 @@ export interface AuthorizeResponse {
     unauthorizedIds?: number[];
 }
 export declare function setRequestFetchOptions(customMondayFetchOptions: MondayFetchOptions): void;
-export declare function setRedisClient(client: any): void;
+export declare function setRedisClient(client: any, grantedFeatureRedisExpirationInSeconds?: number): void;
 export declare class AuthorizationService {
     static redisClient: any;
-    static cacheExpirationInSeconds: number;
+    static grantedFeatureRedisExpirationInSeconds: number;
     /**
      * @deprecated use the second form with authorizationRequestObjects instead,
      * support of this function will be dropped gradually

package/dist/lib/authorization-service.js

@@ -36,15 +36,6 @@ 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 RedisClient = require('@mondaydotcomorg/monday-redis');
-// const redis_options = {
-//   host: "https://top-secret-redis.com",
-//   port: 1234,
-//   password: "password" // Optional
-// };
-//
-// const redisClient = new RedisClient(redis_options);
 const defaultMondayFetchOptions = {
     retries: 3,
     callback: logOnFetchFail,
@@ -54,8 +45,11 @@ function setRequestFetchOptions(customMondayFetchOptions) {
     mondayFetchOptions = Object.assign(Object.assign({}, defaultMondayFetchOptions), customMondayFetchOptions);
 }
 exports.setRequestFetchOptions = setRequestFetchOptions;
-function setRedisClient(client) {
+function setRedisClient(client, grantedFeatureRedisExpirationInSeconds = 5 * 60) {
     AuthorizationService.redisClient = client;
+    if (grantedFeatureRedisExpirationInSeconds && grantedFeatureRedisExpirationInSeconds > 0) {
+        AuthorizationService.grantedFeatureRedisExpirationInSeconds = grantedFeatureRedisExpirationInSeconds;
+    }
 }
 exports.setRedisClient = setRedisClient;
 class AuthorizationService {
@@ -74,15 +68,17 @@ class AuthorizationService {
     }
     static isUserGrantedWithFeature(accountId, userId, featureName) {
         return __awaiter(this, void 0, void 0, function* () {
+            let cachedKey = this.getCachedKey(userId, featureName);
             if (this.redisClient) {
-                let grantedFeatureValue = yield this.redisClient.get(this.getCachedKey(userId, featureName));
+                let grantedFeatureValue = yield this.redisClient.get(cachedKey);
                 if (!(grantedFeatureValue === undefined || grantedFeatureValue === null)) {
-                    return grantedFeatureValue;
+                    // redis returns the value as string
+                    return grantedFeatureValue === 'true';
                 }
             }
             let grantedFeatureValue = yield this.fetchIsUserGrantedWithFeature(featureName, accountId, userId);
             if (this.redisClient) {
-                yield this.redisClient.set(this.getCachedKey(userId, featureName), grantedFeatureValue, 'EX', this.cacheExpirationInSeconds);
+                yield this.redisClient.set(cachedKey, grantedFeatureValue, 'EX', this.grantedFeatureRedisExpirationInSeconds);
             }
             return grantedFeatureValue;
         });
@@ -98,7 +94,7 @@ class AuthorizationService {
         });
     }
     static getCachedKey(userId, featureName) {
-        return `${userId}-granted-feature-${featureName}`;
+        return `granted-feature-${featureName}-${userId}`;
     }
     static isAuthorizedSingular(accountId, userId, resources, action) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -154,7 +150,6 @@ class AuthorizationService {
     }
 }
 exports.AuthorizationService = AuthorizationService;
-AuthorizationService.cacheExpirationInSeconds = 5 * 60;
 function createAuthorizationParams(resources, action) {
     const params = {
         authorizationObjects: resources.map((resource) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/monday-authorization",
-  "version": "1.0.44-featureyoniadd-granted-feature-sdk-api.558+2db7dbe4",
+  "version": "1.0.44-featureyoniadd-granted-feature-sdk-api.560+aa13dbf4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "BSD-3-Clause",
@@ -32,5 +32,5 @@
   "files": [
     "dist/"
   ],
-  "gitHead": "2db7dbe4642516131dfd137c959eef8abf05db96"
+  "gitHead": "aa13dbf433d5ef55c0b59c19fedab103d4d707b4"
 }