@friggframework/core 2.0.0--canary.397.3862908.0 → 2.0.0--canary.397.155fecd.0

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

@@ -1,7 +1,19 @@
 const { Integration } = require('../integration');
 const { mapIntegrationClassToIntegrationDTO } = require('../utils/map-integration-dto');
 
+/**
+ * Use case for retrieving a single integration for a specific user.
+ * @class GetIntegrationForUser
+ */
 class GetIntegrationForUser {
+    /**
+     * Creates a new GetIntegrationForUser instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository - Repository for integration data operations.
+     * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes.
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management.
+     * @param {import('../../modules/module-repository').ModuleRepository} params.moduleRepository - Repository for module and entity data operations.
+     */
     constructor({ integrationRepository, integrationClasses, moduleFactory, moduleRepository }) {
 
         /**
@@ -14,9 +26,13 @@ class GetIntegrationForUser {
     }
 
     /**
-     * @param {string} integrationId
-     * @param {string} userId
-     * @returns {Promise<Integration>}
+     * Executes the retrieval of a single integration for a user.
+     * @async
+     * @param {string} integrationId - ID of the integration to retrieve.
+     * @param {string} userId - ID of the user requesting the integration.
+     * @returns {Promise<Object>} The integration DTO for the specified user.
+     * @throws {Boom.notFound} When integration with the specified ID does not exist.
+     * @throws {Boom.forbidden} When user does not have access to the integration.
      */
     async execute(integrationId, userId) {
         const integrationRecord = await this.integrationRepository.findIntegrationById(integrationId);
@@ -26,7 +42,7 @@ class GetIntegrationForUser {
             throw Boom.notFound(`Integration with id of ${integrationId} does not exist`);
         }
 
-        if (integrationRecord.user.toString() !== userId.toString()) {
+        if (integrationRecord.userId.toString() !== userId.toString()) {
             throw Boom.forbidden('User does not have access to this integration');
         }
 
@@ -38,14 +54,14 @@ class GetIntegrationForUser {
         for (const entity of entities) {
             const moduleInstance = await this.moduleFactory.getModuleInstance(
                 entity._id,
-                integrationRecord.user
+                integrationRecord.userId
             );
             modules.push(moduleInstance);
         }
 
         const integrationInstance = new Integration({
             id: integrationRecord._id,
-            userId: integrationRecord.user,
+            userId: integrationRecord.userId,
             entities: entities,
             config: integrationRecord.config,
             status: integrationRecord.status,

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

@@ -1,11 +1,14 @@
 const { Integration } = require('../integration');
 
+/**
+ * Use case for retrieving a single integration instance by ID and user.
+ * @class GetIntegrationInstance
+ */
 class GetIntegrationInstance {
 
     /**
-     * @class GetIntegrationInstance
-     * @description Use case for retrieving a single integration instance by ID and user.
-     * @param {Object} params
+     * Creates a new GetIntegrationInstance instance.
+     * @param {Object} params - Configuration parameters.
      * @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('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management
@@ -20,6 +23,14 @@ class GetIntegrationInstance {
         this.moduleFactory = moduleFactory;
     }
 
+    /**
+     * Executes the retrieval of a single integration instance.
+     * @async
+     * @param {string} integrationId - ID of the integration to retrieve.
+     * @param {string} userId - ID of the user requesting the integration.
+     * @returns {Promise<Integration>} The fully initialized integration instance.
+     * @throws {Error} When integration is not found, doesn't belong to user, or integration class is not found.
+     */
     async execute(integrationId, userId) {
         const integrationRecord = await this.integrationRepository.findIntegrationById(integrationId);
 

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

@@ -1,7 +1,19 @@
 const { Integration } = require('../integration');
 const { mapIntegrationClassToIntegrationDTO } = require('../utils/map-integration-dto');
 
+/**
+ * Use case for retrieving all integrations for a specific user.
+ * @class GetIntegrationsForUser
+ */
 class GetIntegrationsForUser {
+    /**
+     * Creates a new GetIntegrationsForUser instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository - Repository for integration data operations.
+     * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes.
+     * @param {import('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management.
+     * @param {import('../../modules/module-repository').ModuleRepository} params.moduleRepository - Repository for module and entity data operations.
+     */
     constructor({ integrationRepository, integrationClasses, moduleFactory, moduleRepository }) {
 
         /**
@@ -14,8 +26,10 @@ class GetIntegrationsForUser {
     }
 
     /**
-     * @param {string} userId
-     * @returns {Promise<Integration[]>}
+     * Executes the retrieval of all integrations for a user.
+     * @async
+     * @param {string} userId - ID of the user whose integrations to retrieve.
+     * @returns {Promise<Object[]>} Array of integration DTOs for the specified user.
      */
     async execute(userId) {
         const integrationRecords = await this.integrationRepository.findIntegrationsByUserId(userId);
@@ -40,7 +54,7 @@ class GetIntegrationsForUser {
 
             const integrationInstance = new Integration({
                 id: integrationRecord.id,
-                userId: integrationRecord.user,
+                userId: integrationRecord.userId,
                 entities: entities,
                 config: integrationRecord.config,
                 status: integrationRecord.status,

package/integrations/use-cases/get-possible-integrations.js

@@ -1,8 +1,22 @@
+/**
+ * Use case for retrieving all possible integration types that can be created.
+ * @class GetPossibleIntegrations
+ */
 class GetPossibleIntegrations {
+    /**
+     * Creates a new GetPossibleIntegrations instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {Array<import('../integration').Integration>} params.integrationClasses - Array of available integration classes.
+     */
     constructor({ integrationClasses }) {
         this.integrationClasses = integrationClasses;
     }
 
+    /**
+     * Executes the retrieval of all possible integration types.
+     * @async
+     * @returns {Promise<Object[]>} Array of integration option details for all available integration types.
+     */
     async execute() {
         return this.integrationClasses.map((integrationClass) =>
             integrationClass.getOptionDetails()

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

@@ -1,15 +1,26 @@
+/**
+ * Use case for updating messages associated with an integration.
+ * @class UpdateIntegrationMessages
+ */
 class UpdateIntegrationMessages {
+    /**
+     * Creates a new UpdateIntegrationMessages instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository - Repository for integration data operations.
+     */
     constructor({ integrationRepository }) {
         this.integrationRepository = integrationRepository;
     }
 
     /**
-     * @param {string} integrationId
-     * @param {string} messageType - 'errors', 'warnings', 'info' or 'logs'
-     * @param {string} messageTitle,
-     * @param {string} messageBody,
-     * @param {string} messageTimestamp,
-     * @returns {Promise<Object>}
+     * Executes the integration messages update.
+     * @async
+     * @param {string} integrationId - ID of the integration to update.
+     * @param {string} messageType - Type of message: 'errors', 'warnings', 'info', or 'logs'.
+     * @param {string} messageTitle - Title of the message.
+     * @param {string} messageBody - Body content of the message.
+     * @param {string} messageTimestamp - Timestamp when the message was created.
+     * @returns {Promise<Object>} The updated integration record.
      */
     async execute(integrationId, messageType, messageTitle, messageBody, messageTimestamp) {
         const integration = await this.integrationRepository.updateIntegrationMessages(integrationId, messageType, messageTitle, messageBody, messageTimestamp);

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

@@ -1,8 +1,24 @@
+/**
+ * Use case for updating the status of an integration.
+ * @class UpdateIntegrationStatus
+ */
 class UpdateIntegrationStatus {
+    /**
+     * Creates a new UpdateIntegrationStatus instance.
+     * @param {Object} params - Configuration parameters.
+     * @param {import('../integration-repository').IntegrationRepository} params.integrationRepository - Repository for integration data operations.
+     */
     constructor({ integrationRepository }) {
         this.integrationRepository = integrationRepository;
     }
 
+    /**
+     * Executes the integration status update.
+     * @async
+     * @param {string} integrationId - ID of the integration to update.
+     * @param {string} status - New status for the integration (e.g., 'ENABLED', 'DISABLED', 'ERROR').
+     * @returns {Promise<Object>} The updated integration record.
+     */
     async execute(integrationId, status) {
         const integration = await this.integrationRepository.updateIntegrationStatus(integrationId, status);
         return integration;

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

@@ -1,13 +1,15 @@
 const { Integration } = require('../integration');
 const { mapIntegrationClassToIntegrationDTO } = require('../utils/map-integration-dto');
 
-
+/**
+ * Use case for updating a single integration by ID and user.
+ * @class UpdateIntegration
+ */
 class UpdateIntegration {
 
     /**
-     * @class UpdateIntegration
-     * @description Use case for updating a single integration by ID and user.
-     * @param {Object} params
+     * Creates a new UpdateIntegration instance.
+     * @param {Object} params - Configuration parameters.
      * @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('../../modules/module-factory').ModuleFactory} params.moduleFactory - Service for module instantiation and management
@@ -22,6 +24,15 @@ class UpdateIntegration {
         this.moduleFactory = moduleFactory;
     }
 
+    /**
+     * Executes the integration update process.
+     * @async
+     * @param {string} integrationId - ID of the integration to update.
+     * @param {string} userId - ID of the user requesting the update.
+     * @param {Object} config - New configuration object for the integration.
+     * @returns {Promise<Object>} The updated integration DTO.
+     * @throws {Error} When integration is not found, doesn't belong to user, or integration class is not found.
+     */
     async execute(integrationId, userId, config) {
         // 1. Get integration record from repository
         const integrationRecord = await this.integrationRepository.findIntegrationById(integrationId);
@@ -56,12 +67,12 @@ class UpdateIntegration {
             modules.push(moduleInstance);
         }
 
-        // 4. Create the Integration domain entity with modules
+        // 4. Create the Integration domain entity with modules and updated config
         const integrationInstance = new Integration({
             id: integrationRecord.id,
             userId: integrationRecord.userId,
             entities: integrationRecord.entitiesIds,
-            config: integrationRecord.config,
+            config: config,
             status: integrationRecord.status,
             version: integrationRecord.version,
             messages: integrationRecord.messages,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "2.0.0--canary.397.3862908.0",
+  "version": "2.0.0--canary.397.155fecd.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.3862908.0",
-    "@friggframework/prettier-config": "2.0.0--canary.397.3862908.0",
-    "@friggframework/test": "2.0.0--canary.397.3862908.0",
+    "@friggframework/eslint-config": "2.0.0--canary.397.155fecd.0",
+    "@friggframework/prettier-config": "2.0.0--canary.397.155fecd.0",
+    "@friggframework/test": "2.0.0--canary.397.155fecd.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": "3862908989603188a6c3a404d456f4349c84e54b"
+  "gitHead": "155fecdabd27d01d1c1001261e9ec4b824826411"
 }

package/integrations/test/integration-base.test.js

@@ -1,144 +0,0 @@
-const _ = require('lodash');
-const { mongoose } = require('../../database/mongoose');
-const { expect } = require('chai');
-const { IntegrationBase } = require("../integration-base");
-const { Credential } = require('../../module-plugin/credential');
-const { Entity } = require('../../module-plugin/entity');
-const { IntegrationMapping } = require('../integration-mapping')
-const { IntegrationModel } = require("../integration-model");
-
-describe(`Should fully test the IntegrationBase Class`, () => {
-    let integrationRecord;
-    let userId;
-    const integration = new IntegrationBase;
-
-    beforeAll(async () => {
-        await mongoose.connect(process.env.MONGO_URI);
-        userId = new mongoose.Types.ObjectId();
-        const credential = await Credential.findOneAndUpdate(
-            {
-                user: this.userId,
-            },
-            { $set: { user: this.userId } },
-            {
-                new: true,
-                upsert: true,
-                setDefaultsOnInsert: true,
-            }
-        );
-        const entity1 = await Entity.findOneAndUpdate(
-            {
-                user: this.userId,
-            },
-            {
-                $set: {
-                    credential: credential.id,
-                    user: userId,
-                },
-            },
-            {
-                new: true,
-                upsert: true,
-                setDefaultsOnInsert: true,
-            }
-        );
-        const entity2 = await Entity.findOneAndUpdate(
-            {
-                user: userId,
-            },
-            {
-                $set: {
-                    credential: credential.id,
-                    user: userId,
-                },
-            },
-            {
-                new: true,
-                upsert: true,
-                setDefaultsOnInsert: true,
-            }
-        );
-        integrationRecord = await IntegrationModel.create({
-            entities: [entity1, entity2],
-            user: userId
-        });
-        integration.record = integrationRecord;
-    });
-
-    afterAll(async () => {
-        await Entity.deleteMany();
-        await Credential.deleteMany();
-        await IntegrationMapping.deleteMany();
-        await IntegrationModel.deleteMany();
-        await mongoose.disconnect();
-    });
-
-    beforeEach(() => {
-        integration.record = integrationRecord;
-    })
-
-    describe('getIntegrationMapping()', () => {
-        it('should return null if not found', async () => {
-            const mappings = await integration.getMapping('badId');
-            expect(mappings).to.be.null;
-        });
-
-        it('should return if valid ids', async () => {
-            await integration.upsertMapping('validId', {});
-            const mapping = await integration.getMapping('validId');
-            expect(mapping).to.eql({})
-        });
-    })
-
-    describe('upsertIntegrationMapping()', () => {
-        it('should throw error if sourceId is null', async () => {
-            try {
-                await integration.upsertMapping(null, {});
-                fail('should have thrown error')
-            } catch (err) {
-                expect(err.message).to.contain('sourceId must be set');
-            }
-        });
-
-        it('should return for empty mapping', async () => {
-            const mapping = await integration.upsertMapping('validId2', {});
-            expect(_.pick(mapping, ['integration', 'sourceId', 'mapping'])).to.eql({
-                integration: integrationRecord._id,
-                sourceId: 'validId2',
-                mapping: {}
-            })
-        });
-
-        it('should return for filled mapping', async () => {
-            const mapping = await integration.upsertMapping('validId3', {
-                name: 'someName',
-                value: 5
-            });
-            expect(_.pick(mapping, ['integration', 'sourceId', 'mapping'])).to.eql({
-                integration: integrationRecord._id,
-                sourceId: 'validId3',
-                mapping: {
-                    name: 'someName',
-                    value: 5
-                }
-            })
-        });
-
-        it('should allow upserting to same id', async () => {
-            await integration.upsertMapping('validId4', {});
-            const mapping = await integration.upsertMapping('validId4', {
-                name: 'trustMe',
-                thisWorks: true,
-            });
-            expect(_.pick(mapping, ['integration', 'sourceId', 'mapping'])).to.eql({
-                integration: integrationRecord._id,
-                sourceId: 'validId4',
-                mapping: {
-                    name: 'trustMe',
-                    thisWorks: true,
-                }
-            })
-        });
-    })
-
-});