@autofleet/zehut 3.1.2 → 3.2.0

package/README.md

@@ -1,77 +1,3 @@
-# AutoFleet Node Common
-This respostory is made in order have as much of common code as we can.
+# AutoFleet Zehut
 
-Each line of code used in wrriten in this repo will be used in the enetire AutoFleet system.
-
-Make sure you have:
-* Tests
-* Docs
-
-## Consts
-
-Currently we suppurt:
-```
-  {
-    'OK'
-    'ERROR'
-    'FAIL'
-  }
-```
-
-## Network
-Server 2 Servers communication.
-
-Implemented:
-* Retriving service urls from environment
-* Retry - Using https://github.com/softonic/axios-retry
-* Caching - TBD
-* Syntatic response for fail - TBD
-* Circuit Breaking - TBD
-
-The API is just like [axios](https://github.com/axios/axios) api but the creation of new instance **must** have either `serviceName` or `serviceUrl` in options.
-
-In case `serviceName` used the constractor will look for an environment varible with the the name `<SERVICE_NAME>_SERVICE_HOST`.
-
-For Example:
-```
-const { Network } = require('@autofleet/node-common');
-
-n = new Network({ serviceName: 'TEST' });
-
-n.get('/posts/1');
-```
-.env file:
-```
-RIDE_SERVICE_HOST=jsonplaceholder.typicode.com
-```
-
-To learn more [click here](https://blog.risingstack.com/designing-microservices-architecture-for-failure/).
-
-## Settings
-
-### Adding settings
-For adding new setting you need to add it to the map.js file, please specify 
-* name - descriptive name
-* description - few words about what it does + unit
-* type - supportable types: 'number', 'string', 'json'
-* defaultValue - default value
-* context - 'security' and 'operation' will not show in the simulator configuration
-
-See example.
-
-## DeLorean
-
-Use this model to mock time on server - more info TBD.
-
-## Publish package
-
-bump the version number in package.json
-and run
-```
-npm publish
-```
-
-# Environment Variables 
-
-when using this package locally or outside autofleet-prod project you must set INTEGRATION_MS_SERVICE_HOST in .env file 
-# zehut
+This package handles authorization and authentication for AutoFleet services.

package/lib/check-permission.d.ts

@@ -1,6 +1,6 @@
 import ApiUser from './user/ApiUser';
 export declare const getUser: () => ApiUser | undefined;
 export declare const isUserExist: () => string;
-export declare const checkFleetPermission: (fleetId: any) => boolean;
-export declare const checkBusinessModelPermission: (businessModelId: any) => boolean;
-export declare const checkDemandSourcePermission: (demandSourceId: any) => boolean;
+export declare const checkFleetPermission: (fleetId: string) => boolean;
+export declare const checkBusinessModelPermission: (businessModelId: string) => boolean;
+export declare const checkDemandSourcePermission: (demandSourceId: string) => boolean;

package/lib/check-permission.js

@@ -2,34 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkDemandSourcePermission = exports.checkBusinessModelPermission = exports.checkFleetPermission = exports.isUserExist = exports.getUser = void 0;
 const tracer_1 = require("./tracer");
-const getUser = () => (0, tracer_1.getCurrentTrace)()?.context?.get('userObject');
+const user_1 = require("./user");
+const getUser = () => (0, tracer_1.getCurrentTrace)().context?.get(user_1.USER_OBJECT);
 exports.getUser = getUser;
-const isUserExist = () => {
-    const u = (0, exports.getUser)();
-    return u && u.id;
-};
+const isUserExist = () => (0, exports.getUser)()?.id;
 exports.isUserExist = isUserExist;
-const checkFleetPermission = (fleetId) => {
-    if ((0, exports.isUserExist)()) {
-        const user = (0, exports.getUser)();
-        return !user || Object.keys(user.permissions.fleets).includes(fleetId);
-    }
-    return true;
-};
+const checkUserPermissions = (entityId, entityType) => !(0, exports.isUserExist)() || Object.hasOwn((0, exports.getUser)().permissions[entityType], entityId);
+const checkFleetPermission = (fleetId) => checkUserPermissions(fleetId, 'fleets');
 exports.checkFleetPermission = checkFleetPermission;
-const checkBusinessModelPermission = (businessModelId) => {
-    if ((0, exports.isUserExist)()) {
-        const user = (0, exports.getUser)();
-        return !user || Object.keys(user.permissions.businessModels).includes(businessModelId);
-    }
-    return true;
-};
+const checkBusinessModelPermission = (businessModelId) => checkUserPermissions(businessModelId, 'businessModels');
 exports.checkBusinessModelPermission = checkBusinessModelPermission;
-const checkDemandSourcePermission = (demandSourceId) => {
-    if ((0, exports.isUserExist)()) {
-        const user = (0, exports.getUser)();
-        return !user || Object.keys(user.permissions.demandSources).includes(demandSourceId);
-    }
-    return true;
-};
+const checkDemandSourcePermission = (demandSourceId) => checkUserPermissions(demandSourceId, 'demandSources');
 exports.checkDemandSourcePermission = checkDemandSourcePermission;

package/lib/errors.d.ts

@@ -1,5 +1,5 @@
-import ApiUser from './user';
+import type ApiUser from './user';
 export declare class UnauthorizedAccessError extends Error {
-    user: ApiUser;
-    constructor(user?: any, message?: string);
+    user: ApiUser | null;
+    constructor(user?: ApiUser | null, message?: string);
 }

package/lib/errors.js

@@ -5,8 +5,8 @@ exports.UnauthorizedAccessError = void 0;
 class UnauthorizedAccessError extends Error {
     constructor(user = null, message = 'UnauthorizedAccessError') {
         super(message);
-        this.name = 'UnauthorizedAccessError';
         this.user = user;
+        this.name = 'UnauthorizedAccessError';
     }
 }
 exports.UnauthorizedAccessError = UnauthorizedAccessError;

package/lib/exceptions/appDoesNotExist.d.ts

@@ -1,3 +1,4 @@
 export default class AppDoesNotExist extends Error {
-    mesaage: 'app does not exist';
+    name: string;
+    message: string;
 }

package/lib/exceptions/appDoesNotExist.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class AppDoesNotExist extends Error {
+    constructor() {
+        super(...arguments);
+        this.name = 'AppDoesNotExist';
+        this.message = 'app does not exist';
+    }
 }
 exports.default = AppDoesNotExist;

package/lib/index.d.ts

@@ -1,5 +1,8 @@
+/// <reference types="express" />
+/// <reference types="qs" />
 import * as outbreak from '@autofleet/outbreak';
 import User, { middleware, eagerLoadPermissionsMiddleware, middlewareWithDecode, getDecodedBearer, appMiddleware, createOrSetRabbitTrace } from './user';
+import { type UserPayload, CONTEXTS_IDS_HEADER } from './user/ApiUser';
 import { newTrace, traceTypes } from './tracer';
 import { checkFleetPermission, checkBusinessModelPermission, checkDemandSourcePermission, isUserExist, getUser } from './check-permission';
 import { UnauthorizedAccessError } from './errors';
@@ -8,10 +11,11 @@ import { AUTHORIZATION_METHODS, getAuthorizationHeader } from './authorization';
 declare const getCurrentPayload: () => import("./tracer").Trace | {
     [x: string]: never;
 };
+type OutbreakOptions = Parameters<typeof outbreak.default>[0];
 declare const enableTracing: ({ outbreakOptions }?: {
-    outbreakOptions?: {};
+    outbreakOptions?: OutbreakOptions;
 }) => void;
-export { traceTypes, newTrace, enableTracing, User, middleware, middlewareWithDecode, eagerLoadPermissionsMiddleware, getCurrentPayload, getDecodedBearer, checkFleetPermission, checkBusinessModelPermission, checkDemandSourcePermission, isUserExist, getUser, getRefreshTokenSecret, getTokenSecret, UnauthorizedAccessError, appMiddleware, createOrSetRabbitTrace, outbreak, AUTHORIZATION_METHODS, getAuthorizationHeader, };
+export { traceTypes, newTrace, enableTracing, User, middleware, middlewareWithDecode, eagerLoadPermissionsMiddleware, getCurrentPayload, getDecodedBearer, checkFleetPermission, checkBusinessModelPermission, checkDemandSourcePermission, isUserExist, getUser, getRefreshTokenSecret, getTokenSecret, UnauthorizedAccessError, appMiddleware, createOrSetRabbitTrace, outbreak, AUTHORIZATION_METHODS, getAuthorizationHeader, type UserPayload, CONTEXTS_IDS_HEADER, };
 declare const _default: {
     traceTypes: {
         HTTP_REQUEST: string;
@@ -24,28 +28,28 @@ declare const _default: {
         eagerLoadUserPermissions?: boolean;
         eagerLoadUserPermissionsLegacy?: boolean;
         customPermissionLoader?: import("./user/ApiUser").CustomPermissionLoader;
-    }) => (req: any, res: any, next: any) => Promise<any>;
+    }) => import("express").Handler;
     middlewareWithDecode: (options?: {
         eagerLoadUserPermissions?: boolean;
         eagerLoadUserPermissionsLegacy?: boolean;
         returnErrorIfNoToken?: boolean;
-    }) => (req: any, res: any, next: any) => Promise<void>;
-    eagerLoadPermissionsMiddleware: (req: any, res: any, next: any) => Promise<any>;
+    }) => import("express").Handler;
+    eagerLoadPermissionsMiddleware: import("express").Handler;
     getCurrentPayload: () => import("./tracer").Trace | {
         [x: string]: never;
     };
-    getDecodedBearer: (req: any) => any;
-    checkFleetPermission: (fleetId: any) => boolean;
-    checkBusinessModelPermission: (businessModelId: any) => boolean;
-    checkDemandSourcePermission: (demandSourceId: any) => boolean;
+    getDecodedBearer: (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>) => any;
+    checkFleetPermission: (fleetId: string) => boolean;
+    checkBusinessModelPermission: (businessModelId: string) => boolean;
+    checkDemandSourcePermission: (demandSourceId: string) => boolean;
     isUserExist: () => string;
     getUser: () => User;
     UnauthorizedAccessError: typeof UnauthorizedAccessError;
     appMiddleware: (options: {
         appId: string;
         clientSecret: string;
-    }) => (req: any, res: any, next: any) => Promise<void>;
-    createOrSetRabbitTrace: (trace: any, userId: any) => Promise<void>;
+    }) => import("express").Handler;
+    createOrSetRabbitTrace: (trace: import("./tracer").Trace, userId: string) => Promise<void>;
     outbreak: typeof outbreak;
     AUTHORIZATION_METHODS: {
         NONE: string;
@@ -55,5 +59,6 @@ declare const _default: {
     getAuthorizationHeader: (authorizationSettings: {
         method: string;
     }) => string;
+    CONTEXTS_IDS_HEADER: string;
 };
 export default _default;

package/lib/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAuthorizationHeader = exports.AUTHORIZATION_METHODS = exports.outbreak = exports.createOrSetRabbitTrace = exports.appMiddleware = exports.UnauthorizedAccessError = exports.getTokenSecret = exports.getRefreshTokenSecret = exports.getUser = exports.isUserExist = exports.checkDemandSourcePermission = exports.checkBusinessModelPermission = exports.checkFleetPermission = exports.getDecodedBearer = exports.getCurrentPayload = exports.eagerLoadPermissionsMiddleware = exports.middlewareWithDecode = exports.middleware = exports.User = exports.enableTracing = exports.newTrace = exports.traceTypes = void 0;
+exports.CONTEXTS_IDS_HEADER = exports.getAuthorizationHeader = exports.AUTHORIZATION_METHODS = exports.outbreak = exports.createOrSetRabbitTrace = exports.appMiddleware = exports.UnauthorizedAccessError = exports.getTokenSecret = exports.getRefreshTokenSecret = exports.getUser = exports.isUserExist = exports.checkDemandSourcePermission = exports.checkBusinessModelPermission = exports.checkFleetPermission = exports.getDecodedBearer = exports.getCurrentPayload = exports.eagerLoadPermissionsMiddleware = exports.middlewareWithDecode = exports.middleware = exports.User = exports.enableTracing = exports.newTrace = exports.traceTypes = void 0;
 const outbreak = __importStar(require("@autofleet/outbreak"));
 exports.outbreak = outbreak;
 const user_1 = __importStar(require("./user"));
@@ -34,6 +34,8 @@ Object.defineProperty(exports, "middlewareWithDecode", { enumerable: true, get:
 Object.defineProperty(exports, "getDecodedBearer", { enumerable: true, get: function () { return user_1.getDecodedBearer; } });
 Object.defineProperty(exports, "appMiddleware", { enumerable: true, get: function () { return user_1.appMiddleware; } });
 Object.defineProperty(exports, "createOrSetRabbitTrace", { enumerable: true, get: function () { return user_1.createOrSetRabbitTrace; } });
+const ApiUser_1 = require("./user/ApiUser");
+Object.defineProperty(exports, "CONTEXTS_IDS_HEADER", { enumerable: true, get: function () { return ApiUser_1.CONTEXTS_IDS_HEADER; } });
 const tracer_1 = require("./tracer");
 Object.defineProperty(exports, "newTrace", { enumerable: true, get: function () { return tracer_1.newTrace; } });
 Object.defineProperty(exports, "traceTypes", { enumerable: true, get: function () { return tracer_1.traceTypes; } });
@@ -51,11 +53,10 @@ Object.defineProperty(exports, "getTokenSecret", { enumerable: true, get: functi
 const authorization_1 = require("./authorization");
 Object.defineProperty(exports, "AUTHORIZATION_METHODS", { enumerable: true, get: function () { return authorization_1.AUTHORIZATION_METHODS; } });
 Object.defineProperty(exports, "getAuthorizationHeader", { enumerable: true, get: function () { return authorization_1.getAuthorizationHeader; } });
-const headersTracer = outbreak.default;
 const getCurrentPayload = tracer_1.getCurrentTrace;
 exports.getCurrentPayload = getCurrentPayload;
 const enableTracing = ({ outbreakOptions = {} } = {}) => {
-    headersTracer({
+    outbreak.default({
         headersPrefix: 'x-af',
         ...outbreakOptions,
     });
@@ -82,4 +83,5 @@ exports.default = {
     outbreak,
     AUTHORIZATION_METHODS: authorization_1.AUTHORIZATION_METHODS,
     getAuthorizationHeader: authorization_1.getAuthorizationHeader,
+    CONTEXTS_IDS_HEADER: ApiUser_1.CONTEXTS_IDS_HEADER,
 };

package/lib/secret-getter.d.ts

@@ -1,2 +1,2 @@
-export declare const getRefreshTokenSecret: (token?: any) => string;
-export declare const getTokenSecret: (token?: any) => string;
+export declare const getRefreshTokenSecret: (token?: string) => string;
+export declare const getTokenSecret: (token?: string) => string;

package/lib/services.d.ts

@@ -1,2 +1,3 @@
-export declare const IdentityNetwork: any;
-export declare const AutofleetApiNetwork: any;
+import Network from '@autofleet/network';
+export declare const IdentityNetwork: Network;
+export declare const AutofleetApiNetwork: Network;

package/lib/tracer.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCurrentTrace = exports.traceTypes = exports.newTrace = exports.enable = exports.Trace = void 0;
 const async_hooks_1 = __importDefault(require("async_hooks"));
-const uuid_1 = require("uuid");
+const node_crypto_1 = require("node:crypto");
 const prevStates = {};
 const tracer = {
     currentTrace: null,
@@ -40,7 +40,7 @@ const hook = async_hooks_1.default.createHook({
 });
 class Trace {
     constructor(type) {
-        this.id = (0, uuid_1.v1)();
+        this.id = (0, node_crypto_1.randomUUID)();
         this.type = type;
         this.context = new Map();
     }

package/lib/user/ApiUser.d.ts

@@ -23,23 +23,21 @@ export interface PartialUserPayload {
 }
 export type CustomPermissionLoader = (string: any) => Promise<UserPayload>;
 export default class ApiUser {
-    id: string | undefined;
-    privatePermissions: UserPayload | undefined;
-    privateElevatedPermissionsHash: Map<string, PartialUserPayload | undefined>;
-    privatePermissionsLegacy: any;
-    appPermission: {
-        [key: string]: any;
-    };
-    emptyUser: boolean;
-    accountType: AccountType | undefined;
+    id?: string;
+    accountType?: AccountType;
     contextIds?: string[];
+    private privatePermissions;
+    private readonly privateElevatedPermissionsHash;
+    private privatePermissionsLegacy;
+    private readonly appPermission;
+    readonly emptyUser: boolean;
     constructor(id?: string, accountType?: AccountType, elevatedPermissions?: PartialUserPayload, contextIds?: string[]);
     getUserPermissions(): Promise<UserPayload>;
-    useCustomPermissionLoader(customPermissionLoader: any): Promise<UserPayload>;
+    useCustomPermissionLoader(customPermissionLoader: (userId: string) => UserPayload | PromiseLike<UserPayload>): Promise<UserPayload>;
     get businessModels(): string[] | undefined;
     get fleets(): string[] | undefined;
     get demandSources(): string[] | undefined;
-    getUserProperty(key: any): string[] | undefined;
+    private getUserProperty;
     get elevatedPermissions(): UserPayload;
     get permissions(): UserPayload | undefined;
     elevatePermissions(addedPermissions: PartialUserPayload): () => void;

package/lib/user/ApiUser.js

@@ -4,18 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONTEXTS_IDS_HEADER = exports.ELEVATED_PERMISSIONS_HEADER = void 0;
-/* eslint-disable consistent-return */
 const node_cache_1 = __importDefault(require("node-cache"));
 const object_hash_1 = __importDefault(require("object-hash"));
-const uuid_1 = require("uuid");
 const outbreak_1 = require("@autofleet/outbreak");
+const utils_1 = require("../utils");
 const services_1 = require("../services");
 exports.ELEVATED_PERMISSIONS_HEADER = 'x-af-elevated-permissions';
 exports.CONTEXTS_IDS_HEADER = 'x-af-context-ids';
 const userCache = new node_cache_1.default({ stdTTL: 10 });
 const mergePermissions = (target, sources) => {
     const permissions = {
-        ...(target || {}),
+        ...target,
         fleets: { ...target?.fleets },
         businessModels: { ...target?.businessModels },
         demandSources: { ...target?.demandSources },
@@ -37,20 +36,18 @@ const mergePermissions = (target, sources) => {
 class ApiUser {
     constructor(id, accountType, elevatedPermissions, contextIds) {
         this.id = id;
-        this.emptyUser = !!id;
-        this.appPermission = {};
-        this.privateElevatedPermissionsHash = new Map();
+        this.accountType = accountType;
         this.contextIds = contextIds;
+        this.privateElevatedPermissionsHash = new Map();
+        this.appPermission = {};
+        this.emptyUser = !!id;
         if (elevatedPermissions) {
-            this.privateElevatedPermissionsHash.set('initial', elevatedPermissions);
-        }
-        if (accountType) {
-            this.accountType = accountType;
+            this.privateElevatedPermissionsHash.set(Symbol('initial'), elevatedPermissions);
         }
     }
     async getUserPermissions() {
         if (!this.id) {
-            return;
+            return undefined;
         }
         if (this.privatePermissions) {
             return this.privatePermissions;
@@ -70,7 +67,7 @@ class ApiUser {
     }
     async useCustomPermissionLoader(customPermissionLoader) {
         if (!this.id) {
-            return;
+            return undefined;
         }
         if (this.privatePermissions) {
             return this.privatePermissions;
@@ -111,11 +108,13 @@ class ApiUser {
         return mergePermissions(this.privatePermissions, this.privateElevatedPermissionsHash.values());
     }
     elevatePermissions(addedPermissions) {
-        const elevationId = (0, uuid_1.v4)();
+        // @itayankri is concerned about memory consumption, so create a symbol with no description, to avoid assigning memory for the description string
+        // eslint-disable-next-line symbol-description
+        const elevationId = Symbol();
         // Validate that the added permissions are valid UUIDs
-        Object.keys(addedPermissions).forEach((entityType) => {
-            Object.keys(addedPermissions[entityType]).forEach((entityId) => {
-                if (!(0, uuid_1.validate)(entityId)) {
+        Object.values(addedPermissions).forEach((entityIds) => {
+            Object.keys(entityIds).forEach((entityId) => {
+                if (!(0, utils_1.validateUUID)(entityId)) {
                     throw new Error(`Entity id on elevatePermissions is not a valid UUID, provided: ${entityId}`);
                 }
             });
@@ -135,7 +134,7 @@ class ApiUser {
     }
     async getUserPermissionsLegacy() {
         if (!this.id) {
-            return;
+            return undefined;
         }
         if (this.privatePermissionsLegacy) {
             return this.privatePermissionsLegacy;
@@ -152,7 +151,7 @@ class ApiUser {
     }
     async getUserAppPermissions(appId, clientSecret) {
         if (!this.id || !appId || !clientSecret) {
-            return;
+            return undefined;
         }
         const currentAppPermission = this.appPermission[appId];
         if (currentAppPermission) {

package/lib/user/index.d.ts

@@ -1,19 +1,27 @@
+import type { Handler, Request } from 'express';
 import ApiUser, { CustomPermissionLoader } from './ApiUser';
+import { newTrace } from '../tracer';
+export declare const USER_OBJECT = "userObject";
+declare module 'express-serve-static-core' {
+    interface Request {
+        user: ApiUser;
+    }
+}
 export declare const middleware: (options?: {
     eagerLoadUserPermissions?: boolean;
     eagerLoadUserPermissionsLegacy?: boolean;
     customPermissionLoader?: CustomPermissionLoader;
-}) => (req: any, res: any, next: any) => Promise<any>;
+}) => Handler;
 export declare const middlewareWithDecode: (options?: {
     eagerLoadUserPermissions?: boolean;
     eagerLoadUserPermissionsLegacy?: boolean;
     returnErrorIfNoToken?: boolean;
-}) => (req: any, res: any, next: any) => Promise<void>;
+}) => Handler;
 export declare const appMiddleware: (options: {
     appId: string;
     clientSecret: string;
-}) => (req: any, res: any, next: any) => Promise<void>;
-export declare const eagerLoadPermissionsMiddleware: (req: any, res: any, next: any) => Promise<any>;
-export declare const getDecodedBearer: (req: any) => any;
-export declare const createOrSetRabbitTrace: (trace: any, userId: any) => Promise<void>;
+}) => Handler;
+export declare const eagerLoadPermissionsMiddleware: Handler;
+export declare const getDecodedBearer: (req: Request) => any;
+export declare const createOrSetRabbitTrace: (trace: ReturnType<typeof newTrace> | undefined, userId: string | undefined) => Promise<void>;
 export default ApiUser;