@friggframework/core 2.0.0--canary.397.05c9b19.0 → 2.0.0--canary.397.1b51778.0

package/credential/credential-repository.js

@@ -4,6 +4,39 @@ class CredentialRepository {
     async findCredentialById(id) {
         return Credential.findById(id);
     }
+
+    async updateAuthenticationStatus(credentialId, authIsValid) {
+        return Credential.updateOne({ _id: credentialId }, { $set: { auth_is_valid: authIsValid } });
+    }
+
+    /**
+     * Permanently remove a credential document.
+     * @param {string} credentialId
+     * @returns {Promise<import('mongoose').DeleteResult>}
+     */
+    async deleteCredentialById(credentialId) {
+        return Credential.deleteOne({ _id: credentialId });
+    }
+
+    /**
+     * Create a new credential or update an existing one matching the identifiers.
+     * `credentialDetails` format: { identifiers: { ... }, details: { ... } }
+     * Identifiers are used in the query filter; details are merged into the document.
+     * @param {{identifiers: Object, details: Object}} credentialDetails
+     * @returns {Promise<Object>} The persisted credential (lean object)
+     */
+    async upsertCredential(credentialDetails) {
+        const { identifiers, details } = credentialDetails;
+        if (!identifiers) throw new Error('identifiers required to upsert credential');
+
+        const query = { ...identifiers };
+
+        const update = { $set: { ...details } };
+
+        const options = { upsert: true, new: true, setDefaultsOnInsert: true, lean: true };
+
+        return Credential.findOneAndUpdate(query, update, options);
+    }
 }
 
 module.exports = { CredentialRepository };

package/credential/use-cases/update-authentication-status.js

@@ -0,0 +1,15 @@
+class UpdateAuthenticationStatus {
+    constructor({ credentialRepository }) {
+        this.credentialRepository = credentialRepository;
+    }
+
+    /**
+     * @param {string} credentialId
+     * @param {boolean} authIsValid
+     */
+    async execute(credentialId, authIsValid) {
+        await this.credentialRepository.updateAuthenticationStatus(credentialId, authIsValid);
+    }
+}
+
+module.exports = { UpdateAuthenticationStatus };

package/handlers/backend-utils.js

@@ -2,8 +2,10 @@ const { Router } = require('express');
 const { Worker } = require('@friggframework/core');
 const { loadAppDefinition } = require('./app-definition-loader');
 const { IntegrationRepository } = require('../integrations/integration-repository');
-const { ModuleService } = require('../modules/module-service');
+const { ModuleFactory } = require('../modules/module-factory');
 const { GetIntegrationInstance } = require('../integrations/use-cases/get-integration-instance');
+const { getModulesDefinitionFromIntegrationClasses } = require('../integrations/utils/map-integration-dto');
+const { ModuleRepository } = require('../modules/module-repository');
 
 const loadRouterFromObject = (IntegrationClass, routerObject) => {
     const router = Router();
@@ -42,12 +44,16 @@ const createQueueWorker = (integrationClass) => {
                 } else {
                     const { integrations: integrationClasses } = loadAppDefinition();
                     const integrationRepository = new IntegrationRepository();
-                    const moduleService = new ModuleService();
+                    const moduleRepository = new ModuleRepository();
+                    const moduleFactory = new ModuleFactory({
+                        moduleRepository,
+                        moduleDefinitions: getModulesDefinitionFromIntegrationClasses(integrationClasses),
+                    });
 
                     const getIntegrationInstance = new GetIntegrationInstance({
                         integrationRepository,
                         integrationClasses,
-                        moduleService,
+                        moduleFactory,
                     });
 
                     // todo: are we going to have the userId available here?

package/integrations/integration-router.js

@@ -8,7 +8,7 @@ const { GetIntegrationsForUser } = require('./use-cases/get-integrations-for-use
 const { CredentialRepository } = require('../credential/credential-repository');
 const { GetCredentialForUser } = require('../credential/use-cases/get-credential-for-user');
 const { CreateIntegration } = require('./use-cases/create-integration');
-const { ModuleService } = require('../modules/module-service');
+const { ModuleFactory } = require('../modules/module-factory');
 const { ModuleRepository } = require('../modules/module-repository');
 const { GetEntitiesForUser } = require('../modules/use-cases/get-entities-for-user');
 const { loadAppDefinition } = require('../handlers/app-definition-loader');
@@ -36,7 +36,7 @@ function createIntegrationRouter(params) {
     const integrationRepository = new IntegrationRepository();
     const credentialRepository = new CredentialRepository();
 
-    const moduleService = new ModuleService({
+    const moduleFactory = new ModuleFactory({
         moduleRepository,
         moduleDefinitions: getModulesDefinitionFromIntegrationClasses(integrationClasses),
     });
@@ -48,7 +48,7 @@ function createIntegrationRouter(params) {
     const getIntegrationsForUser = new GetIntegrationsForUser({
         integrationRepository,
         integrationClasses,
-        moduleService,
+        moduleFactory,
         moduleRepository,
     });
 
@@ -59,7 +59,7 @@ function createIntegrationRouter(params) {
     const createIntegration = new CreateIntegration({
         integrationRepository,
         integrationClasses,
-        moduleService,
+        moduleFactory,
     });
 
     const getEntitiesForUser = new GetEntitiesForUser({
@@ -70,13 +70,13 @@ function createIntegrationRouter(params) {
     const getIntegrationInstance = new GetIntegrationInstance({
         integrationRepository,
         integrationClasses,
-        moduleService,
+        moduleFactory,
     });
 
     const updateIntegration = new UpdateIntegration({
         integrationRepository,
         integrationClasses,
-        moduleService,
+        moduleFactory,
     });
 
     const getModuleInstanceFromType = new GetModuleInstanceFromType({

package/integrations/integration.js

@@ -119,7 +119,7 @@ class Integration {
             // -----------------------------------------------------------------
             // Inject the real Module instances (with credentials) so that any
             // behaviour code accessing `this.<moduleName>.api` hits the
-            // correctly authenticated requester created by ModuleService.
+            // correctly authenticated requester created by ModuleFactory.
             // -----------------------------------------------------------------
             for (const mod of this._moduleInstances) {
                 const key = typeof mod.getName === 'function' ? mod.getName() : mod.name;

package/integrations/use-cases/create-integration.js

@@ -6,12 +6,12 @@ class CreateIntegration {
      * @param {Object} params
      * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository
      * @param {import('../integration-classes').IntegrationClasses} params.integrationClasses
-     * @param {import('../../modules/module-service').ModuleService} params.moduleService
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory
      */
-    constructor({ integrationRepository, integrationClasses, moduleService }) {
+    constructor({ integrationRepository, integrationClasses, moduleFactory }) {
         this.integrationRepository = integrationRepository;
         this.integrationClasses = integrationClasses;
-        this.moduleService = moduleService;
+        this.moduleFactory = moduleFactory;
     }
 
     async execute(entities, userId, config) {
@@ -28,7 +28,7 @@ class CreateIntegration {
 
         const modules = [];
         for (const entityId of integrationRecord.entitiesIds) {
-            const moduleInstance = await this.moduleService.getModuleInstance(
+            const moduleInstance = await this.moduleFactory.getModuleInstance(
                 entityId,
                 integrationRecord.userId
             );

package/integrations/use-cases/get-integration-for-user.js

@@ -2,14 +2,14 @@ const { Integration } = require('../integration');
 const { mapIntegrationClassToIntegrationDTO } = require('../utils/map-integration-dto');
 
 class GetIntegrationForUser {
-    constructor({ integrationRepository, integrationClasses, moduleService, moduleRepository }) {
+    constructor({ integrationRepository, integrationClasses, moduleFactory, moduleRepository }) {
 
         /**
          * @type {import('../integration-repository').IntegrationRepository}
          */
         this.integrationRepository = integrationRepository;
         this.integrationClasses = integrationClasses;
-        this.moduleService = moduleService;
+        this.moduleFactory = moduleFactory;
         this.moduleRepository = moduleRepository;
     }
 
@@ -36,7 +36,7 @@ class GetIntegrationForUser {
 
         const modules = [];
         for (const entity of entities) {
-            const moduleInstance = await this.moduleService.getModuleInstance(
+            const moduleInstance = await this.moduleFactory.getModuleInstance(
                 entity._id,
                 integrationRecord.user
             );

package/integrations/use-cases/get-integration-instance.js

@@ -8,16 +8,16 @@ class GetIntegrationInstance {
      * @param {Object} params
      * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository - Repository for integration data access
      * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes
-     * @param {import('../module-plugin/module-service').ModuleService} params.moduleService - Service for module instantiation and management
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management
      */
     constructor({
         integrationRepository,
         integrationClasses,
-        moduleService,
+        moduleFactory,
     }) {
         this.integrationRepository = integrationRepository;
         this.integrationClasses = integrationClasses;
-        this.moduleService = moduleService;
+        this.moduleFactory = moduleFactory;
     }
 
     async execute(integrationId, userId) {
@@ -44,7 +44,7 @@ class GetIntegrationInstance {
 
         const modules = [];
         for (const entityId of integrationRecord.entitiesIds) {
-            const moduleInstance = await this.moduleService.getModuleInstance(
+            const moduleInstance = await this.moduleFactory.getModuleInstance(
                 entityId,
                 integrationRecord.userId
             );

package/integrations/use-cases/get-integrations-for-user.js

@@ -2,14 +2,14 @@ const { Integration } = require('../integration');
 const { mapIntegrationClassToIntegrationDTO } = require('../utils/map-integration-dto');
 
 class GetIntegrationsForUser {
-    constructor({ integrationRepository, integrationClasses, moduleService, moduleRepository }) {
+    constructor({ integrationRepository, integrationClasses, moduleFactory, moduleRepository }) {
 
         /**
          * @type {import('../integration-repository').IntegrationRepository}
          */
         this.integrationRepository = integrationRepository;
         this.integrationClasses = integrationClasses;
-        this.moduleService = moduleService;
+        this.moduleFactory = moduleFactory;
         this.moduleRepository = moduleRepository;
     }
 
@@ -31,7 +31,7 @@ class GetIntegrationsForUser {
 
             const modules = [];
             for (const entity of entities) {
-                const moduleInstance = await this.moduleService.getModuleInstance(
+                const moduleInstance = await this.moduleFactory.getModuleInstance(
                     entity.id,
                     integrationRecord.userId
                 );

package/integrations/use-cases/update-integration.js

@@ -10,16 +10,16 @@ class UpdateIntegration {
      * @param {Object} params
      * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository - Repository for integration data access
      * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes
-     * @param {import('../module-plugin/module-service').ModuleService} params.moduleService - Service for module instantiation and management
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management
      */
     constructor({
         integrationRepository,
         integrationClasses,
-        moduleService,
+        moduleFactory,
     }) {
         this.integrationRepository = integrationRepository;
         this.integrationClasses = integrationClasses;
-        this.moduleService = moduleService;
+        this.moduleFactory = moduleFactory;
     }
 
     async execute(integrationId, userId, config) {
@@ -49,7 +49,7 @@ class UpdateIntegration {
         // 3. Load modules based on entity references
         const modules = [];
         for (const entityId of integrationRecord.entitiesIds) {
-            const moduleInstance = await this.moduleService.getModuleInstance(
+            const moduleInstance = await this.moduleFactory.getModuleInstance(
                 entityId,
                 integrationRecord.userId
             );

package/modules/{module-service.js → module-factory.js}

@@ -1,6 +1,11 @@
 const { Module } = require('./module');
 
-class ModuleService {
+/**
+ * Acts as a factory for fully-hydrated domain Module instances.
+ * Provides methods to retrieve and construct Module objects with their associated
+ * entity and definition.
+ */
+class ModuleFactory {
     /**
      * @param {Object} params - Configuration parameters.
      * @param {import('./module-repository').ModuleRepository} params.moduleRepository - Repository for module data operations.
@@ -46,4 +51,4 @@ class ModuleService {
     }
 }
 
-module.exports = { ModuleService }; 
+module.exports = { ModuleFactory };

package/modules/module-repository.js

@@ -42,7 +42,7 @@ class ModuleRepository {
     async findEntitiesByUserId(userId) {
         const entitiesRecords = await Entity.find(
             { user: userId },
-            '-dateCreated -dateUpdated -user -credentials -credential -__t -__v',
+            '',
             { lean: true }
         ).populate('credential');
 
@@ -76,6 +76,16 @@ class ModuleRepository {
             moduleName: e.moduleName,
         }));
     }
+
+    /**
+     * Remove the credential reference from an Entity document without loading a full Mongoose instance.
+     * Useful when a credential has been revoked/deleted (e.g. via Module.deauthorize).
+     * @param {string} entityId
+     * @returns {Promise<import('mongoose').UpdateWriteOpResult>}
+     */
+    async unsetCredential(entityId) {
+        return Entity.updateOne({ _id: entityId }, { $unset: { credential: "" } });
+    }
 }
 
 module.exports = { ModuleRepository }; 

package/modules/module.js

@@ -3,6 +3,9 @@ const _ = require('lodash');
 const { flushDebugLog } = require('../logs');
 const { ModuleConstants } = require('./ModuleConstants');
 
+// todo: this class should be a Domain class, and the Delegate function is preventing us from
+// doing that, we probably have to get rid of the Delegate class as well as the event based 
+// calls since they go against the Domain Driven Design principles (eg. a domain class should not call repository methods or use cases)
 class Module extends Delegate {
 
     //todo: entity should be replaced with actual entity properties
@@ -26,6 +29,13 @@ class Module extends Delegate {
         this.modelName = this.definition.modelName;
         this.apiClass = this.definition.API;
 
+        // Repository used for persistence operations related to credentials.
+        const { CredentialRepository } = require('../credential/credential-repository');
+        this.credentialRepository = new CredentialRepository();
+
+        // Repository responsible for entity persistence actions
+        const { ModuleRepository } = require('./module-repository');
+        this.moduleRepository = new ModuleRepository();
 
         Object.assign(this, this.definition.requiredAuthMethods);
 
@@ -125,7 +135,9 @@ class Module extends Delegate {
             this.apiParamsFromCredential(this.api)
         );
         credentialDetails.details.auth_is_valid = true;
-        await this.updateOrCreateCredential(credentialDetails);
+
+        const persisted = await this.credentialRepository.upsertCredential(credentialDetails);
+        this.credential = persisted;
     }
 
     async receiveNotification(notifier, delegateString, object = null) {
@@ -139,20 +151,42 @@ class Module extends Delegate {
     }
 
     async markCredentialsInvalid() {
-        if (this.credential) {
-            this.credential.auth_is_valid = false;
-            await this.credential.save();
-        }
+        if (!this.credential) return;
+
+        // Persist flag change through repository – works even when the
+        // credential object is a plain JavaScript object (lean query).
+        const credentialId = this.credential._id || this.credential.id;
+        if (!credentialId) return;
+
+        await this.credentialRepository.updateAuthenticationStatus(
+            credentialId,
+            false
+        );
+
+        // Keep the in-memory snapshot consistent so that callers can read the
+        // updated state without another fetch.
+        this.credential.auth_is_valid = false;
     }
 
     async deauthorize() {
         this.api = new this.apiClass();
+
+        // Remove persisted credential (if any)
         if (this.entity?.credential) {
-            await this.CredentialModel.deleteOne({
-                _id: this.entity.credential,
-            });
+            const credentialId =
+                this.entity.credential._id || this.entity.credential.id || this.entity.credential;
+
+            // Delete credential via repository
+            await this.credentialRepository.deleteCredentialById(credentialId);
+
+            // Unset credential reference on the Entity document
+            const entityId = this.entity._id || this.entity.id;
+            if (entityId) {
+                await this.moduleRepository.unsetCredential(entityId);
+            }
+
+            // Keep in-memory snapshot consistent
             this.entity.credential = undefined;
-            await this.entity.save();
         }
     }
 

package/modules/utils/map-module-dto.js

@@ -6,7 +6,7 @@ function mapModuleClassToModuleDTO(moduleInstance) {
     if (!moduleInstance) return null;
 
     return {
-        id: moduleInstance.entity._id.toString(),
+        id: moduleInstance.entity.id,
         name: moduleInstance.name,
         userId: moduleInstance.userId,
         entity: moduleInstance.entity,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "2.0.0--canary.397.05c9b19.0",
+  "version": "2.0.0--canary.397.1b51778.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.397.05c9b19.0",
-    "@friggframework/prettier-config": "2.0.0--canary.397.05c9b19.0",
-    "@friggframework/test": "2.0.0--canary.397.05c9b19.0",
+    "@friggframework/eslint-config": "2.0.0--canary.397.1b51778.0",
+    "@friggframework/prettier-config": "2.0.0--canary.397.1b51778.0",
+    "@friggframework/test": "2.0.0--canary.397.1b51778.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": "05c9b19a8f1f2d8e7ef49983786c1fd622fa376a"
+  "gitHead": "1b51778697149cbb26c6ba4de50e507461663f48"
 }