@friggframework/core 2.0.0--canary.397.fadaaf6.0 → 2.0.0--canary.397.b7e1978.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/integrations/integration-base.js

@@ -61,21 +61,7 @@ class IntegrationBase {
     static getCurrentVersion() {
         return this.Definition.version;
     }
-    loadModules() {
-        // Load all the modules defined in Definition.modules
-        const moduleNames = Object.keys(this.constructor.Definition.modules);
-        for (const moduleName of moduleNames) {
-            const { definition } =
-                this.constructor.Definition.modules[moduleName];
-            if (typeof definition.API === 'function') {
-                this[moduleName] = { api: new definition.API({}) };
-            } else {
-                throw new Error(
-                    `Module ${moduleName} must be a function that extends IntegrationModule`
-                );
-            }
-        }
-    }
+
     registerEventHandlers() {
         this.on = {
             ...this.defaultEvents,
@@ -119,7 +105,6 @@ class IntegrationBase {
                 handler: this.refreshActionOptions,
             },
         };
-        this.loadModules();
     }
 
     async send(event, object) {

package/integrations/integration-router.js

@@ -51,9 +51,11 @@ function createIntegrationRouter(params) {
         moduleService,
         moduleRepository,
     });
+
     const getCredentialForUser = new GetCredentialForUser({
         credentialRepository,
     });
+
     const createIntegration = new CreateIntegration({
         integrationRepository,
         integrationClasses,

package/integrations/integration.js

@@ -62,8 +62,14 @@ class Integration {
         // Integration behavior (strategy pattern)
         this.integrationClass = integrationClass;
 
-        // Loaded modules
-        this.modules = modules;
+        // Preserve the provided Module instances (array). We'll attach them
+        // as keyed modules after the behaviour instance is created so that
+        // `this.hubspot`, `this.salesforce`, etc. reference the fully-
+        // initialised objects with credentials.
+        this._moduleInstances = Array.isArray(modules) ? modules : [];
+
+        // Normalised map of modules keyed by module name (filled later)
+        this.modules = {};
 
         // Initialize basic behavior (sync parts only)
         this._initializeBasicBehavior();
@@ -110,10 +116,17 @@ class Integration {
             this.events = this.behavior.events || {};
             this.defaultEvents = this.behavior.defaultEvents || {};
 
+            // -----------------------------------------------------------------
+            // Inject the real Module instances (with credentials) so that any
+            // behaviour code accessing `this.<moduleName>.api` hits the
+            // correctly authenticated requester created by ModuleService.
+            // -----------------------------------------------------------------
+            for (const mod of this._moduleInstances) {
+                const key = typeof mod.getName === 'function' ? mod.getName() : mod.name;
+                if (!key) continue;
+                this.setModule(key, mod);
+            }
 
-            // Expose behaviour instance methods directly on the wrapper so that
-            // early-bound handlers (created before behaviour existed) can still
-            // access them without falling back through the Proxy. This prevents
             // `undefined` errors for methods like `loadDynamicUserActions` that
             // may be invoked inside default event-handlers.
             let proto = Object.getPrototypeOf(this.behavior);
@@ -217,4 +230,4 @@ class Integration {
     }
 }
 
-module.exports = { Integration }; 
+module.exports = { Integration };

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-service.js

@@ -27,10 +27,9 @@ class ModuleService {
             );
         }
 
-        const entityType = entity.type;
+        const moduleName = entity.moduleName;
         const moduleDefinition = this.moduleDefinitions.find((def) => {
-            const modelName = Module.getEntityModelFromDefinition(def).modelName;
-            return entityType === modelName;
+            return moduleName === def.modelName;
         });
 
         if (!moduleDefinition) {

package/modules/module.js

@@ -1,12 +1,11 @@
 const { Delegate } = require('../core');
-const { get } = require('../assertions');
 const _ = require('lodash');
 const { flushDebugLog } = require('../logs');
-const { Credential } = require('./credential');
-const { Entity } = require('./entity');
-const { mongoose } = require('../database/mongoose');
 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
@@ -30,12 +29,15 @@ 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();
 
-        Object.assign(this, this.definition.requiredAuthMethods);
-
-        this.CredentialModel = this.getCredentialModel();
-        this.EntityModel = this.getEntityModel();
+        // Repository responsible for entity persistence actions
+        const { ModuleRepository } = require('./module-repository');
+        this.moduleRepository = new ModuleRepository();
 
+        Object.assign(this, this.definition.requiredAuthMethods);
 
         const apiParams = {
             ...this.definition.env,
@@ -46,11 +48,6 @@ class Module extends Delegate {
         this.api = new this.apiClass(apiParams);
     }
 
-    static getEntityModelFromDefinition(definition) {
-        const partialModule = new this({ definition });
-        return partialModule.getEntityModel();
-    }
-
     getName() {
         return this.name;
     }
@@ -72,45 +69,6 @@ class Module extends Delegate {
         return _.pick(entity, ...this.apiPropertiesToPersist?.entity);
     }
 
-    getEntityModel() {
-        if (!this.EntityModel) {
-            const prefix = this.modelName ?? _.upperFirst(this.getName());
-            const arrayToDefaultObject = (array, defaultValue) =>
-                _.mapValues(_.keyBy(array), () => defaultValue);
-            const schema = new mongoose.Schema(
-                arrayToDefaultObject(this.apiPropertiesToPersist.entity, {
-                    type: mongoose.Schema.Types.Mixed,
-                    trim: true,
-                })
-            );
-            const name = `${prefix}Entity`;
-            this.EntityModel =
-                Entity.discriminators?.[name] ||
-                Entity.discriminator(name, schema);
-        }
-        return this.EntityModel;
-    }
-
-    getCredentialModel() {
-        if (!this.CredentialModel) {
-            const arrayToDefaultObject = (array, defaultValue) =>
-                _.mapValues(_.keyBy(array), () => defaultValue);
-            const schema = new mongoose.Schema(
-                arrayToDefaultObject(this.apiPropertiesToPersist.credential, {
-                    type: mongoose.Schema.Types.Mixed,
-                    trim: true,
-                    lhEncrypt: true,
-                })
-            );
-            const prefix = this.modelName ?? _.upperFirst(this.getName());
-            const name = `${prefix}Credential`;
-            this.CredentialModel =
-                Credential.discriminators?.[name] ||
-                Credential.discriminator(name, schema);
-        }
-        return this.CredentialModel;
-    }
-
     async validateAuthorizationRequirements() {
         const requirements = await this.getAuthorizationRequirements();
         let valid = true;
@@ -177,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) {
@@ -190,73 +150,43 @@ class Module extends Delegate {
         }
     }
 
-    async findOrCreateEntity(entityDetails) {
-        const identifiers = get(entityDetails, 'identifiers');
-        const details = get(entityDetails, 'details');
-        const search = await this.EntityModel.find(identifiers);
-        if (search.length > 1) {
-            throw new Error(
-                'Multiple entities found with the same identifiers: ' +
-                JSON.stringify(identifiers)
-            );
-        } else if (search.length === 0) {
-            this.entity = await this.EntityModel.create({
-                credential: this.credential.id,
-                ...details,
-                ...identifiers,
-            });
-        } else if (search.length === 1) {
-            this.entity = search[0];
-        }
-        if (this.entity.credential === undefined) {
-            this.entity.credential = this.credential.id;
-            await this.entity.save();
-        }
-    }
+    async markCredentialsInvalid() {
+        if (!this.credential) return;
 
-    async updateOrCreateCredential(credentialDetails) {
-        const identifiers = get(credentialDetails, 'identifiers');
-        const details = get(credentialDetails, 'details');
+        // 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;
 
-        if (!this.credential) {
-            const credentialSearch = await this.CredentialModel.find(
-                identifiers
-            );
-            if (credentialSearch.length > 1) {
-                throw new Error(
-                    `Multiple credentials found with same identifiers: ${identifiers}`
-                );
-            } else if (credentialSearch.length === 1) {
-                // found exactly one credential with these identifiers
-                this.credential = credentialSearch[0];
-            } else {
-                // found no credential with these identifiers (match none for insert)
-                this.credential = { $exists: false };
-            }
-        }
-        // update credential or create if none was found
-        this.credential = await this.CredentialModel.findOneAndUpdate(
-            { _id: this.credential },
-            { $set: { ...identifiers, ...details } },
-            { useFindAndModify: true, new: true, upsert: true }
+        await this.credentialRepository.updateAuthenticationStatus(
+            credentialId,
+            false
         );
-    }
 
-    async markCredentialsInvalid() {
-        if (this.credential) {
-            this.credential.auth_is_valid = false;
-            await this.credential.save();
-        }
+        // 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.fadaaf6.0",
+  "version": "2.0.0--canary.397.b7e1978.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.fadaaf6.0",
-    "@friggframework/prettier-config": "2.0.0--canary.397.fadaaf6.0",
-    "@friggframework/test": "2.0.0--canary.397.fadaaf6.0",
+    "@friggframework/eslint-config": "2.0.0--canary.397.b7e1978.0",
+    "@friggframework/prettier-config": "2.0.0--canary.397.b7e1978.0",
+    "@friggframework/test": "2.0.0--canary.397.b7e1978.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": "fadaaf6990abc87d718814725fbd94173b9ca2bc"
+  "gitHead": "b7e197879d90d5bd782c5299aa55f312eb7d4b63"
 }