@friggframework/core 1.2.0-canary.293.50b9cd8.0 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,144 @@
+# v1.2.0 (Tue Aug 06 2024)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Daniel Klotz ([@d-klotz](https://github.com/d-klotz)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Add READMEs that will need updating, but for version releasing [#324](https://github.com/friggframework/frigg/pull/324) ([@seanspeaks](https://github.com/seanspeaks))
+- Add READMEs that will need updating, but for version releasing ([@seanspeaks](https://github.com/seanspeaks))
+- small update to integration testing / tooling [#304](https://github.com/friggframework/frigg/pull/304) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- chore: bump deprecated npm package versions [#323](https://github.com/friggframework/frigg/pull/323) ([@d-klotz](https://github.com/d-klotz) [@seanspeaks](https://github.com/seanspeaks))
+- chore: bump deprecated package versions ([@d-klotz](https://github.com/d-klotz))
+- Bump version to: v1.1.8 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+- remove comment ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- use the factory methods for creating the mock integration so that everything is set up (mostly events and userActions) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- fix imports to not inadvertently call loadInstalledModules ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.5 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 3
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Daniel Klotz ([@d-klotz](https://github.com/d-klotz))
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.8 (Thu Jul 18 2024)
+
+#### 🐛 Bug Fix
+
+- Revert open to support commonjs [#319](https://github.com/friggframework/frigg/pull/319) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.6 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.7 (Mon Jul 15 2024)
+
+#### 🐛 Bug Fix
+
+- getAuthorizationRequirements() async [#318](https://github.com/friggframework/frigg/pull/318) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- getAuthorizationRequirements should be async, though it will only occasionally need to make requests ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.6 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.6 (Fri Apr 26 2024)
+
+#### 🐛 Bug Fix
+
+- Small fix to validation errors and cleanup [#307](https://github.com/friggframework/frigg/pull/307) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- remove excess files to centralize jest config and cleanup ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.5 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.5 (Tue Apr 09 2024)
+
+#### 🐛 Bug Fix
+
+- update router to include options and refresh [#301](https://github.com/friggframework/frigg/pull/301) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- consistent spacing ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add back the /api/entity POST of a credential with a tentative adjustment to implementation ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- be consistent about not using redundant variables for the response json ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- remove accidental newline ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- fixes to router and stubs ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- update router to include options and refresh for entities, integration config, and integration user actions ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.4 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+- Bump version to: v1.1.3 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.4 (Fri Apr 05 2024)
+
+#### 🐛 Bug Fix
+
+- Socket hang up / ECONNRESET error retry for requester [#297](https://github.com/friggframework/frigg/pull/297) ([@seanspeaks](https://github.com/seanspeaks))
+- Check linear task description for offending error. Unclear if this is the best approach. ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.3 (Tue Apr 02 2024)
+
+#### 🐛 Bug Fix
+
+- test release [#296](https://github.com/friggframework/frigg/pull/296) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add a commit to fix canary and workaround auto bug ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- bump to test release ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### Authors: 1
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+
+---
+
+# v2.0.0 (Sat Mar 30 2024)
+
+#### 🚀 Enhancement
+
+- Package redo [#294](https://github.com/friggframework/frigg/pull/294) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### 🐛 Bug Fix
+
+- update test related imports in core ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- missed one ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- create test, eslint-config and prettier-config packages as base shared dependencies ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Publish ([@seanspeaks](https://github.com/seanspeaks))
+- Bump node and npm version for the whole repo (Fix CI) [#274](https://github.com/friggframework/frigg/pull/274) ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
 # v1.1.0 (Wed Mar 20 2024)
 
 :tada: This release contains work from new contributors! :tada:

package/README.md

@@ -0,0 +1,80 @@
+# Frigg Core
+
+The `frigg-core` package is the heart of the Frigg Framework. It contains the core functionality and essential modules required to build and maintain integrations at scale.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Modules](#modules)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+The Frigg Core package provides the foundational components and utilities for the Frigg Framework. It is designed to be modular, extensible, and easy to integrate with other packages in the Frigg ecosystem.
+
+## Features
+
+- **Associations**: Manage relationships between different entities.
+- **Database**: Database utilities and connectors.
+- **Encryption**: Secure data encryption and decryption.
+- **Error Handling**: Standardized error handling mechanisms.
+- **Integrations**: Tools for building and managing integrations.
+- **Lambda**: Utilities for AWS Lambda functions.
+- **Logging**: Structured logging utilities.
+- **Module Plugin**: Plugin system for extending core functionality.
+- **Syncs**: Synchronization utilities for data consistency.
+
+## Installation
+
+To install the `frigg-core` package, use npm or yarn:
+
+```sh
+npm install @friggframework/core
+# or
+yarn add @friggframework/core
+```
+## Usage
+Here's a basic example of how to use the frigg-core package:
+```javascript
+const { encrypt, decrypt } = require('@friggframework/core/encrypt');
+const { logInfo } = require('@friggframework/core/logs');
+
+const secret = 'mySecret';
+const encrypted = encrypt(secret);
+const decrypted = decrypt(encrypted);
+
+logInfo(`Encrypted: ${encrypted}`);
+logInfo(`Decrypted: ${decrypted}`);
+```
+
+## Modules
+
+The frigg-core package is organized into several modules:
+
+- **Associations**: @friggframework/core/associations
+- **Database**: @friggframework/core/database
+- **Encryption**: @friggframework/core/encrypt
+- **Errors**: @friggframework/core/errors
+- **Integrations**: @friggframework/core/integrations
+- **Lambda**: @friggframework/core/lambda
+- **Logs**: @friggframework/core/logs
+- **Module Plugin**: @friggframework/core/module-plugin
+- **Syncs**: @friggframework/core/syncs
+
+
+Each module provides specific functionality and can be imported individually as needed.
+
+## Contributing
+
+We welcome contributions from the community! Please read our contributing guide to get started. Make sure to follow our code of conduct and use the provided pull request template.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE.md file for details.
+
+---
+Thank you for using Frigg Core! If you have any questions or need further assistance, feel free to reach out to our community on Slack or check out our GitHub issues page.

package/encrypt/encrypt.test.js

@@ -8,7 +8,7 @@ const {
     createModel,
     saveTestDocument,
 } = require('./test-encrypt');
-const { TestMongo } = require('../../../utils/test-environment');
+const { TestMongo } = require('@friggframework/test');
 
 const testMongo = new TestMongo();
 const originalEnv = process.env;

package/errors/validation-errors.js

@@ -3,7 +3,7 @@ const { BaseError } = require('./base-error');
 class RequiredPropertyError extends BaseError {
     constructor(options = {}, ...parentOptions) {
         const { parent, key = '' } = options;
-        const parentText = parent ? `(${parent.name}) ` : '';
+        const parentText = parent?.name ? `(${parent.name}) ` : '';
         const message = `${parentText}Key "${key}" is a required parameter.`;
         super(message, ...parentOptions);
     }
@@ -12,7 +12,7 @@ class RequiredPropertyError extends BaseError {
 class ParameterTypeError extends BaseError {
     constructor(options = {}, ...parentOptions) {
         const { parent, key = '', value = '', expectedType } = options;
-        const parentText = parent ? `(${parent.name}) ` : '';
+        const parentText = parent?.name ? `(${parent.name}) ` : '';
         const keyText = key ? `key "${key}" with ` : '';
         const typeName = expectedType?.name ?? '';
         const message = `${parentText}Expected ${keyText}value "${value}" to be of type "${typeName}"`;

package/index.js

@@ -36,9 +36,7 @@ const {
     IntegrationHelper,
     createIntegrationRouter,
     checkRequiredParams,
-    createFriggBackend,
-    createMockIntegration,
-    createMockApiObject
+    createFriggBackend
 } = require('./integrations/index');
 const { TimeoutCatcher } = require('./lambda/index');
 const {
@@ -57,9 +55,7 @@ const {
     Requester,
     ModuleConstants,
     ModuleFactory,
-    Auther,
-    testAutherDefinition,
-    testDefinitionRequiredAuthMethods
+    Auther
 } = require('./module-plugin/index');
 
 // const {Sync } = require('./syncs/model');

package/integrations/index.js

@@ -15,5 +15,5 @@ module.exports = {
     IntegrationHelper,
     createIntegrationRouter,
     checkRequiredParams,
-    createFriggBackend,
+    createFriggBackend
 };

package/integrations/integration-base.js

@@ -154,9 +154,33 @@ class IntegrationBase {
         return options;
     }
 
+    async refreshConfigOptions(params) {
+        const options = {
+            jsonSchema: {},
+            uiSchema: {},
+        }
+        return options
+    }
+
     async getUserActions() {
         return [];
     }
+
+    async getActionOptions() {
+        const options = {
+            jsonSchema: {},
+            uiSchema: {},
+        }
+        return options
+    }
+
+    async refreshActionOptions(params) {
+        const options = {
+            jsonSchema: {},
+            uiSchema: {},
+        }
+        return options
+    }
 }
 
 module.exports = { IntegrationBase };

package/integrations/integration-factory.js

@@ -87,18 +87,6 @@ class IntegrationFactory {
     }
 
     async createIntegration(entities, userId, config) {
-        // verify entity ids belong to the user
-        // for (const id of entities) {
-        //     const entity = await Entity.findById(id);
-        //     if (!entity) {
-        //         throw new Error(`Entity with ID ${id} does not exist.`);
-        //     }
-        //     if (entity.user.toString() !== userId.toString()) {
-        //         throw new Error('one or more the entities do not belong to the user');
-        //     }
-        // }
-
-        // build integration
         const integrationRecord = await IntegrationModel.create({
             entities: entities,
             user: userId,

package/integrations/integration-router.js

@@ -80,7 +80,6 @@ function setIntegrationRoutes(router, factory, getUserId) {
                     params.entities,
                     getUserId(req),
                     params.config,
-                    moduleFactory
                 );
 
             // post integration initialization
@@ -89,12 +88,9 @@ function setIntegrationRoutes(router, factory, getUserId) {
             );
             await integration.onCreate();
 
-            // filtered set for results
-            const response = await IntegrationHelper.getFormattedIntegration(
-                integration.record
+            res.status(201).json(
+                await IntegrationHelper.getFormattedIntegration(integration.record)
             );
-            res.status(201);
-            res.json(response);
         })
     );
 
@@ -114,11 +110,9 @@ function setIntegrationRoutes(router, factory, getUserId) {
             );
             await integration.onUpdate(params);
 
-            const response = await IntegrationHelper.getFormattedIntegration(
-                integration.record
+            res.json(
+                await IntegrationHelper.getFormattedIntegration(integration.record)
             );
-
-            res.json(response);
         })
     );
 
@@ -142,8 +136,7 @@ function setIntegrationRoutes(router, factory, getUserId) {
                 params.integrationId
             );
 
-            res.status(201);
-            res.json({});
+            res.status(201).json({});
         })
     );
 
@@ -154,9 +147,21 @@ function setIntegrationRoutes(router, factory, getUserId) {
             ]);
             const integration =
                 await integrationFactory.getInstanceFromIntegrationId(params);
-            const results = await integration.getConfigOptions();
-            // We could perhaps augment router with dynamic options? Haven't decided yet, but here may be the place
-            res.json(results);
+            res.json(await integration.getConfigOptions());
+        })
+    );
+
+    router.route('/api/integrations/:integrationId/config/options/refresh').post(
+        catchAsyncError(async (req, res) => {
+            const params = checkRequiredParams(req.params, [
+                'integrationId',
+            ]);
+            const integration =
+                await integrationFactory.getInstanceFromIntegrationId(params);
+
+            res.json(
+                await integration.refreshConfigOptions(req.body)
+            );
         })
     );
 
@@ -168,11 +173,25 @@ function setIntegrationRoutes(router, factory, getUserId) {
             ]);
             const integration =
                 await integrationFactory.getInstanceFromIntegrationId(params);
-            const results = await integration.getActionOptions(
-                params.actionId
+
+            res.json(
+                await integration.getActionOptions(params.actionId)
+            );
+        })
+    );
+
+    router.route('/api/integrations/:integrationId/actions/:actionId/options/refresh').post(
+        catchAsyncError(async (req, res) => {
+            const params = checkRequiredParams(req.params, [
+                'integrationId',
+                'actionId'
+            ]);
+            const integration =
+                await integrationFactory.getInstanceFromIntegrationId(params);
+
+            res.json(
+                await integration.refreshActionOptions(params.actionId, req.body)
             );
-            // We could perhaps augment router with dynamic options? Haven't decided yet, but here may be the place
-            res.json(results);
         })
     );
 
@@ -184,14 +203,12 @@ function setIntegrationRoutes(router, factory, getUserId) {
             ]);
             const integration =
                 await integrationFactory.getInstanceFromIntegrationId(params);
-            const results = await integration.notify(
-                params.actionId,
-                req.body
+
+            res.json(
+                await integration.notify(params.actionId, req.body)
             );
-            // We could perhaps augment router with dynamic options? Haven't decided yet, but here may be the place
-            res.json(results);
         })
-    )
+    );
 
     router.route('/api/integrations/:integrationId').get(
         catchAsyncError(async (req, res) => {
@@ -268,6 +285,7 @@ function setEntityRoutes(router, factory, getUserId) {
                     `Error: EntityManager of type ${params.entityType} requires a valid url`
                 );
             }
+
             res.json(await module.getAuthorizationRequirements());
         })
     );
@@ -278,35 +296,14 @@ function setEntityRoutes(router, factory, getUserId) {
                 'entityType',
                 'data',
             ]);
-            console.log('post authorize', params);
             const module = await getModuleInstance(req, params.entityType);
-            console.log('post authorize module', module);
-            const results = await module.processAuthorizationCallback({
-                userId: getUserId(req),
-                data: params.data,
-            });
-
-            res.json(results);
-        })
-    );
 
-    router.route('/api/entity/options/:credentialId').get(
-        catchAsyncError(async (req, res) => {
-            // TODO May want to pass along the user ID as well so credential ID's can't be fished???
-            // TODO **flagging this for review** -MW
-            const credential = await IntegrationHelper.getCredentialById(
-                req.params.credentialId
+            res.json(
+                await module.processAuthorizationCallback({
+                    userId: getUserId(req),
+                    data: params.data,
+                })
             );
-            if (credential.user._id.toString() !== getUserId(req)) {
-                throw Boom.forbidden('Credential does not belong to user');
-            }
-
-            const params = checkRequiredParams(req.query, [
-                'entityType',
-            ]);
-            const module = await getModuleInstance(req, params.entityType);
-
-            res.json(await module.getEntityOptions());
         })
     );
 
@@ -328,7 +325,36 @@ function setEntityRoutes(router, factory, getUserId) {
             }
 
             const module = await getModuleInstance(req, params.entityType);
-            res.json(await module.findOrCreateEntity(params.data));
+            const entityDetails = await module.getEntityDetails(
+                module.api,
+                null,
+                null,
+                getUserId(req)
+            )
+
+            res.json(
+                await module.findOrCreateEntity(entityDetails)
+            );
+        })
+    );
+
+    router.route('/api/entity/options/:credentialId').get(
+        catchAsyncError(async (req, res) => {
+            // TODO May want to pass along the user ID as well so credential ID's can't be fished???
+            // TODO **flagging this for review** -MW
+            const credential = await IntegrationHelper.getCredentialById(
+                req.params.credentialId
+            );
+            if (credential.user._id.toString() !== getUserId(req)) {
+                throw Boom.forbidden('Credential does not belong to user');
+            }
+
+            const params = checkRequiredParams(req.query, [
+                'entityType',
+            ]);
+            const module = await getModuleInstance(req, params.entityType);
+
+            res.json(await module.getEntityOptions());
         })
     );
 
@@ -352,7 +378,7 @@ function setEntityRoutes(router, factory, getUserId) {
                     errors: [
                         {
                             title: 'Authentication Error',
-                            message: `There was an error with your ${module.constructor.getName()} Entity.  Please reconnect/re-authenticate, or reach out to Support for assistance.`,
+                            message: `There was an error with your ${module.getName()} Entity.  Please reconnect/re-authenticate, or reach out to Support for assistance.`,
                             timestamp: Date.now(),
                         },
                     ],
@@ -362,6 +388,60 @@ function setEntityRoutes(router, factory, getUserId) {
             }
         })
     );
+
+    router.route('/api/entities/:entityId').get(
+        catchAsyncError(async (req, res) => {
+            const params = checkRequiredParams(req.params, ['entityId']);
+            const module = await moduleFactory.getModuleInstanceFromEntityId(
+                params.entityId,
+                getUserId(req)
+            );
+
+            if (!module) {
+                throw Boom.notFound();
+            }
+
+            res.json(module.entity);
+        })
+    );
+
+    router.route('/api/entities/:entityId/options').post(
+        catchAsyncError(async (req, res) => {
+            const params = checkRequiredParams(req.params, [
+                'entityId',
+                getUserId(req)
+            ]);
+            const module = await moduleFactory.getModuleInstanceFromEntityId(
+                params.entityId,
+                getUserId(req)
+            );
+
+            if (!module) {
+                throw Boom.notFound();
+            }
+
+            res.json(await module.getEntityOptions());
+        })
+    );
+
+    router.route('/api/entities/:entityId/options/refresh').post(
+        catchAsyncError(async (req, res) => {
+            const params = checkRequiredParams(req.params, [
+                'entityId',
+                getUserId(req)
+            ]);
+            const module = await moduleFactory.getModuleInstanceFromEntityId(
+                params.entityId,
+                getUserId(req)
+            );
+
+            if (!module) {
+                throw Boom.notFound();
+            }
+
+            res.json(await module.refreshEntityOptions(req.body));
+        })
+    );
 }
 
 module.exports = { createIntegrationRouter, checkRequiredParams };

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

@@ -2,7 +2,8 @@ const _ = require('lodash');
 const { mongoose } = require('../../database/mongoose');
 const { expect } = require('chai');
 const { IntegrationBase } = require("../integration-base");
-const {Credential, Entity} = require('../../module-plugin');
+const {Credential} = require('../../module-plugin/credential');
+const {Entity} = require('../../module-plugin/entity');
 const { IntegrationMapping } = require('../integration-mapping')
 const {IntegrationModel} = require("../integration-model");
 

package/jest-setup.js

@@ -0,0 +1,2 @@
+const {globalSetup} = require('@friggframework/test');
+module.exports = globalSetup;

package/jest-teardown.js

@@ -0,0 +1,2 @@
+const {globalTeardown} = require('@friggframework/test');
+module.exports = globalTeardown;

package/{module-plugin/jest.config.js → jest.config.js}

@@ -2,8 +2,9 @@
  * For a detailed explanation regarding each configuration property, visit:
  * https://jestjs.io/docs/configuration
  */
+
 module.exports = {
-    // preset: '@friggframework/test-environment',
+    // preset: '@friggframework/test',
     coverageThreshold: {
         global: {
             statements: 13,

package/logs/logger.test.js

@@ -3,7 +3,7 @@ const sinon = require('sinon');
 const {
     overrideEnvironment,
     restoreEnvironment,
-} = require('../../../utils/test-environment');
+} = require('@friggframework/test');
 
 /* eslint-disable no-console */