@friggframework/core 2.0.0--canary.396.607ab7a.0 → 2.0.0--canary.396.cb56ae3.0

package/index.js

@@ -46,7 +46,6 @@ const { TimeoutCatcher } = require('./lambda/index');
 const { debug, initDebugLog, flushDebugLog } = require('./logs/index');
 const {
     Credential,
-    EntityManager,
     Entity,
     ModuleManager,
     ApiKeyRequester,
@@ -120,7 +119,6 @@ module.exports = {
 
     // module plugin
     Credential,
-    EntityManager,
     Entity,
     ModuleManager,
     ApiKeyRequester,

package/integrations/integration-router.js

@@ -16,37 +16,6 @@ const {
     loadAppDefinition,
 } = require('../handlers/app-definition-loader');
 
-
-const { integrations } = loadAppDefinition();
-const moduleRepository = new ModuleRepository();
-const integrationRepository = new IntegrationRepository();
-const credentialRepository = new CredentialRepository();
-const moduleService = new ModuleService({ moduleRepository, moduleDefinitions: { ...getModules() } });
-const deleteIntegrationForUser = new DeleteIntegrationForUser({ integrationRepository });
-const getIntegrationForUser = new GetIntegrationForUser({ integrationRepository });
-const getIntegrationsForUser = new GetIntegrationsForUser({ integrationRepository });
-const getCredentialForUser = new GetCredentialForUser({ credentialRepository });
-const createIntegration = new CreateIntegration({
-    integrationRepository,
-    integrationClasses: integrations,
-    moduleService,
-});
-
-// todo: move this into a utils file
-const getModules = () => {
-    return [
-        ...new Set(
-            integrations
-                .map((integration) =>
-                    Object.values(integration.Definition.modules).map(
-                        (module) => module.definition
-                    )
-                )
-                .flat()
-        ),
-    ];
-}
-
 // todo: dont send moduleFactory and integrationFactory as a factory object, instead send them as separate params.
 // todo: this could be a use case class
 /**
@@ -60,12 +29,66 @@ const getModules = () => {
  * @returns {express.Router} Configured Express router with integration and entity routes
  */
 function createIntegrationRouter(params) {
+    const { integrations } = loadAppDefinition();
+    const moduleRepository = new ModuleRepository();
+    const integrationRepository = new IntegrationRepository();
+    const credentialRepository = new CredentialRepository();
+
+    // todo: move this into a utils file
+    const getModules = () => {
+        return [
+            ...new Set(
+                integrations
+                    .map((integration) =>
+                        Object.values(integration.Definition.modules).map(
+                            (module) => module.definition
+                        )
+                    )
+                    .flat()
+            ),
+        ];
+    };
+    const moduleService = new ModuleService({
+        moduleRepository,
+        moduleDefinitions: getModules(),
+    });
+    const deleteIntegrationForUser = new DeleteIntegrationForUser({
+        integrationRepository,
+    });
+    const getIntegrationForUser = new GetIntegrationForUser({
+        integrationRepository,
+    });
+    const getIntegrationsForUser = new GetIntegrationsForUser({
+        integrationRepository,
+    });
+    const getCredentialForUser = new GetCredentialForUser({
+        credentialRepository,
+    });
+    const createIntegration = new CreateIntegration({
+        integrationRepository,
+        integrationClasses: integrations,
+        moduleService,
+    });
+
+    const getEntitiesForUserUseCase = new GetEntitiesForUser({
+        moduleRepository,
+        moduleDefinitions: getModules(),
+    });
+
     const router = get(params, 'router', express());
     const factory = get(params, 'factory');
     const getUserFromBearerToken = get(params, 'getUserFromBearerToken');
 
-    setIntegrationRoutes(router, factory, getUserFromBearerToken);
-    setEntityRoutes(router, factory, getUserFromBearerToken);
+    // todo: moduleFactory in factory is not used here anymore, remove it
+    setIntegrationRoutes(router, factory, getUserFromBearerToken, {
+        createIntegration,
+        deleteIntegrationForUser,
+        getIntegrationsForUser,
+        getEntitiesForUserUseCase,
+    });
+    setEntityRoutes(router, factory, getUserFromBearerToken, {
+        getCredentialForUser,
+    });
     return router;
 }
 
@@ -99,8 +122,14 @@ function checkRequiredParams(params, requiredKeys) {
  * @param {Object} factory.integrationFactory - Factory for creating and managing integrations
  * @param {import('../user/use-cases/get-user-from-bearer-token').GetUserFromBearerToken} getUserFromBearerToken - Use case for retrieving a user from a bearer token
  */
-function setIntegrationRoutes(router, factory, getUserFromBearerToken) {
-    const { moduleFactory, integrationFactory } = factory;
+function setIntegrationRoutes(router, factory, getUserFromBearerToken, useCases) {
+    const { integrationFactory } = factory;
+    const {
+        createIntegration,
+        deleteIntegrationForUser,
+        getIntegrationsForUser,
+        getEntitiesForUserUseCase,
+    } = useCases;
 
     router.route('/api/integrations').get(
         catchAsyncError(async (req, res) => {
@@ -109,8 +138,7 @@ function setIntegrationRoutes(router, factory, getUserFromBearerToken) {
             );
             const userId = user.getId();
             const results = await integrationFactory.getIntegrationOptions();
-            results.entities.authorized =
-                await moduleFactory.getEntitiesForUser(userId);
+            results.entities.authorized = await getEntitiesForUserUseCase.execute(userId);
             results.integrations =
                 await getIntegrationsForUser.execute(userId);
 
@@ -404,8 +432,9 @@ function setIntegrationRoutes(router, factory, getUserFromBearerToken) {
  * @param {Object} factory - Factory object containing moduleFactory
  * @param {import('../user/use-cases/get-user-from-bearer-token').GetUserFromBearerToken} getUserFromBearerToken - Use case for retrieving a user from a bearer token
  */
-function setEntityRoutes(router, factory, getUserFromBearerToken) {
+function setEntityRoutes(router, factory, getUserFromBearerToken, useCases) {
     const { moduleFactory } = factory;
+    const { getCredentialForUser } = useCases;
     const getModuleInstance = async (userId, entityType) => {
         if (!moduleFactory.checkIsValidType(entityType)) {
             throw Boom.badRequest(
@@ -432,7 +461,7 @@ function setEntityRoutes(router, factory, getUserFromBearerToken) {
                 module.validateAuthorizationRequirements();
             if (!areRequirementsValid) {
                 throw new Error(
-                    `Error: EntityManager of type ${params.entityType} requires a valid url`
+                    `Error: Entity of type ${params.entityType} requires a valid url`
                 );
             }
 

package/module-plugin/index.js

@@ -1,5 +1,4 @@
 const { Credential } = require('./credential');
-const { EntityManager } = require('./entity-manager');
 const { Entity } = require('./entity');
 const { ModuleManager } = require('./manager');
 const { ApiKeyRequester } = require('./requester/api-key');
@@ -11,7 +10,6 @@ const { ModuleFactory } = require('./module-factory');
 
 module.exports = {
     Credential,
-    EntityManager,
     Entity,
     ModuleManager,
     ApiKeyRequester,

package/module-plugin/module-factory.js

@@ -13,19 +13,6 @@ class ModuleFactory {
         });
     }
 
-    async getEntitiesForUser(userId) {
-        let results = [];
-        for (const moduleDefinition of this.moduleDefinitions) {
-            const moduleInstance = new Module({
-                userId,
-                definition: moduleDefinition,
-            });
-            const list = await moduleInstance.getEntitiesForUserId(userId);
-            results.push(...list);
-        }
-        return results;
-    }
-
     checkIsValidType(entityType) {
         return this.moduleTypes.includes(entityType);
     }

package/module-plugin/module-repository.js

@@ -9,6 +9,14 @@ class ModuleRepository {
 
         return entity;
     }
+
+    async findEntitiesByUserId(userId) {
+        return Entity.find(
+            { user: userId },
+            '-dateCreated -dateUpdated -user -credentials -credential -__t -__v',
+            { lean: true }
+        );
+    }
 }
 
 module.exports = { ModuleRepository }; 

package/module-plugin/module.js

@@ -103,20 +103,21 @@ class Module extends Delegate {
         return this.CredentialModel;
     }
 
-    async getEntitiesForUserId(userId) {
-        // Only return non-internal fields. Leverages "select" and "options" to non-excepted fields and a pure object.
-        const list = await this.EntityModel.find(
-            { user: userId },
-            '-dateCreated -dateUpdated -user -credentials -credential -__t -__v',
-            { lean: true }
-        );
-        console.log('getEntitiesForUserId list', list, userId);
-        return list.map((entity) => ({
-            id: entity._id,
-            type: this.getName(),
-            ...entity,
-        }));
-    }
+    // todo: remove this method from all places
+    // async getEntitiesForUserId(userId) {
+    //     // Only return non-internal fields. Leverages "select" and "options" to non-excepted fields and a pure object.
+    //     const list = await this.EntityModel.find(
+    //         { user: userId },
+    //         '-dateCreated -dateUpdated -user -credentials -credential -__t -__v',
+    //         { lean: true }
+    //     );
+    //     console.log('getEntitiesForUserId list', list, userId);
+    //     return list.map((entity) => ({
+    //         id: entity._id,
+    //         type: this.getName(),
+    //         ...entity,
+    //     }));
+    // }
 
     async validateAuthorizationRequirements() {
         const requirements = await this.getAuthorizationRequirements();

package/module-plugin/use-cases/get-entities-for-user.js

@@ -0,0 +1,35 @@
+const { Module } = require('../module');
+
+class GetEntitiesForUser {
+    constructor({ moduleRepository, moduleDefinitions }) {
+        this.moduleRepository = moduleRepository;
+
+        this.definitionMap = new Map();
+        for (const definition of moduleDefinitions) {
+            const modelName =
+                Module.getEntityModelFromDefinition(definition).modelName;
+            this.definitionMap.set(modelName, definition);
+        }
+    }
+
+    async execute(userId) {
+        const entities = await this.moduleRepository.findEntitiesByUserId(
+            userId
+        );
+
+        return entities.map((entity) => {
+            const definition = this.definitionMap.get(entity.__t);
+            // todo: check if dont need to use this.
+            const type = definition ? definition.getName() : 'unknown';
+
+            const moduleInstance = new Module({
+                userId,
+                definition: definition,
+                entity: entity,
+            });
+            return moduleInstance;
+        });
+    }
+}
+
+module.exports = { GetEntitiesForUser }; 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "2.0.0--canary.396.607ab7a.0",
+  "version": "2.0.0--canary.396.cb56ae3.0",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
@@ -22,9 +22,9 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@friggframework/eslint-config": "2.0.0--canary.396.607ab7a.0",
-    "@friggframework/prettier-config": "2.0.0--canary.396.607ab7a.0",
-    "@friggframework/test": "2.0.0--canary.396.607ab7a.0",
+    "@friggframework/eslint-config": "2.0.0--canary.396.cb56ae3.0",
+    "@friggframework/prettier-config": "2.0.0--canary.396.cb56ae3.0",
+    "@friggframework/test": "2.0.0--canary.396.cb56ae3.0",
     "@types/lodash": "4.17.15",
     "@typescript-eslint/eslint-plugin": "^8.0.0",
     "chai": "^4.3.6",
@@ -53,5 +53,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "607ab7a7440562858c6d7440b8983a00931be283"
+  "gitHead": "cb56ae344c7fed00baa31a00970d27ea59d3dce5"
 }

package/types/integrations/index.d.ts

@@ -1,7 +1,6 @@
 declare module "@friggframework/integrations" {
   import { Delegate, IFriggDelegate } from "@friggframework/core";
   import { Model } from "mongoose";
-  import { EntityManager } from "@friggframework/module-plugin";
 
   export class Integration extends Model {
     entities: any[];
@@ -19,8 +18,7 @@ declare module "@friggframework/integrations" {
 
   export class IntegrationManager
     extends Delegate
-    implements IFriggIntegrationManager
-  {
+    implements IFriggIntegrationManager {
     integration: Integration;
     primaryInstance: any;
     targetInstance: any;
@@ -56,7 +54,6 @@ declare module "@friggframework/integrations" {
       entities: { id: string; user: any },
       userId: string,
       config: any,
-      EntityManager: EntityManager
     ): Promise<any>;
 
     static getFormattedIntegration(
@@ -116,8 +113,7 @@ declare module "@friggframework/integrations" {
   }
 
   export class IntegrationConfigManager
-    implements IFriggIntegrationConfigManager
-  {
+    implements IFriggIntegrationConfigManager {
     options: IntegrationOptions[];
     primary: any;
 

package/types/module-plugin/index.d.ts

@@ -9,21 +9,7 @@ declare module "@friggframework/module-plugin" {
     externalId: string;
   }
 
-  export class EntityManager implements IFriggEntityManager {
-    static primaryEntityClass: any;
-    static entityManagerClasses: any[];
-    static entityTypes: string[];
-    static getEntitiesForUser(userId: string): Promise<any[]>;
-    static checkIsValidType(entityType: string): boolean;
-    static getEntityManagerClass(entityType?: string): any;
-
-    static getEntityManagerInstanceFromEntityId(
-      entityId: string,
-      userId: string
-    ): Promise<any>;
-  }
-
-  interface IFriggEntityManager {}
+  interface IFriggEntityManager { }
 
   export class Entity extends Model {
     credentialId: string;
@@ -138,8 +124,7 @@ declare module "@friggframework/module-plugin" {
 
   export class ApiKeyRequester
     extends Requester
-    implements IFriggApiKeyRequester
-  {
+    implements IFriggApiKeyRequester {
     API_KEY_NAME: string;
     API_KEY_VALUE: any;
 
@@ -160,8 +145,7 @@ declare module "@friggframework/module-plugin" {
 
   export class BasicAuthRequester
     extends Requester
-    implements IFriggBasicAuthRequester
-  {
+    implements IFriggBasicAuthRequester {
     password: string;
     username: string;
 
@@ -189,8 +173,7 @@ declare module "@friggframework/module-plugin" {
 
   export class OAuth2Requester
     extends Requester
-    implements IFriggOAuth2Requester
-  {
+    implements IFriggOAuth2Requester {
     DLGT_TOKEN_DEAUTHORIZED: string;
     DLGT_TOKEN_UPDATE: string;
     accessTokenExpire: any;

package/module-plugin/entity-manager.js

@@ -1,70 +0,0 @@
-const { loadInstalledModules, Delegate } = require('../core');
-
-const { Entity } = require('./entity');
-const { ModuleManager } = require('./manager');
-
-class EntityManager {
-    static primaryEntityClass = null; //primaryEntity;
-
-    static entityManagerClasses = loadInstalledModules().map(
-        (m) => m.EntityManager
-    );
-
-    static entityTypes = EntityManager.entityManagerClasses.map(
-        (ManagerClass) => ManagerClass.getName()
-    );
-
-    static async getEntitiesForUser(userId) {
-        const results = [];
-        for (const Manager of this.entityManagerClasses) {
-            results.push(...(await Manager.getEntitiesForUserId(userId)));
-        }
-        return results;
-    }
-
-    static checkIsValidType(entityType) {
-        const indexOfEntity = EntityManager.entityTypes.indexOf(entityType);
-        return indexOfEntity >= 0;
-    }
-
-    static getEntityManagerClass(entityType = '') {
-        const normalizedType = entityType.toLowerCase();
-
-        const indexOfEntityType =
-            EntityManager.entityTypes.indexOf(normalizedType);
-        if (!EntityManager.checkIsValidType(normalizedType)) {
-            throw new Error(
-                `Error: Invalid entity type of ${normalizedType}, options are ${EntityManager.entityTypes.join(
-                    ', '
-                )}`
-            );
-        }
-
-        const managerClass =
-            EntityManager.entityManagerClasses[indexOfEntityType];
-
-        if (!(managerClass.prototype instanceof ModuleManager)) {
-            throw new Error('The Entity is not an instance of ModuleManager');
-        }
-
-        return managerClass;
-    }
-
-    static async getEntityManagerInstanceFromEntityId(entityId, userId) {
-        const entityMO = new Entity();
-        const entity = await entityMO.get(entityId);
-        let entityManagerClass;
-        for (const Manager of this.entityManagerClasses) {
-            if (entity instanceof Manager.Entity.Model) {
-                entityManagerClass = Manager;
-            }
-        }
-        const instance = await entityManagerClass.getInstance({
-            userId,
-            entityId,
-        });
-        return instance;
-    }
-}
-
-module.exports = { EntityManager };