@friggframework/core 1.1.4 → 1.1.6--canary.307.644a753.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 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

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/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-router.js

@@ -89,12 +89,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 +111,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 +137,7 @@ function setIntegrationRoutes(router, factory, getUserId) {
                 params.integrationId
             );
 
-            res.status(201);
-            res.json({});
+            res.status(201).json({});
         })
     );
 
@@ -154,9 +148,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 +174,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 +204,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 +286,7 @@ function setEntityRoutes(router, factory, getUserId) {
                     `Error: EntityManager of type ${params.entityType} requires a valid url`
                 );
             }
+
             res.json(await module.getAuthorizationRequirements());
         })
     );
@@ -278,35 +297,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 +326,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 +379,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 +389,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/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/module-plugin/auther.js

@@ -88,6 +88,12 @@ class Auther extends Delegate {
         const definition = get(params, 'definition');
         Auther.validateDefinition(definition);
         Object.assign(this, definition.requiredAuthMethods);
+        if (definition.getEntityOptions) {
+            this.getEntityOptions = definition.getEntityOptions;
+        }
+        if (definition.refreshEntityOptions) {
+            this.refreshEntityOptions = definition.refreshEntityOptions;
+        }
         this.name = definition.moduleName;
         this.modelName = definition.modelName;
         this.apiClass = definition.API;
@@ -263,12 +269,14 @@ class Auther extends Delegate {
     }
 
     async getEntityOptions() {
-        // May not be needed if the callback already creates the entity, such as in situations
-        // like HubSpot where the account is determined in the authorization flow.
-        // This should only be used in situations such as FreshBooks where the user needs to make
-        // an account decision on the front end.
         throw new Error(
-            'Entity requirement method getEntityOptions() is not defined in the class'
+            'Method getEntityOptions() is not defined in the class'
+        );
+    }
+
+    async refreshEntityOptions() {
+        throw new Error(
+            'Method refreshEntityOptions() is not defined in the class'
         );
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "1.1.4",
+  "version": "1.1.6--canary.307.644a753.0",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
@@ -15,9 +15,9 @@
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
-    "@friggframework/eslint-config": "^1.1.4",
-    "@friggframework/prettier-config": "^1.1.4",
-    "@friggframework/test": "^1.1.4",
+    "@friggframework/eslint-config": "1.1.6--canary.307.644a753.0",
+    "@friggframework/prettier-config": "1.1.6--canary.307.644a753.0",
+    "@friggframework/test": "1.1.6--canary.307.644a753.0",
     "@types/lodash": "^4.14.191",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "chai": "^4.3.6",
@@ -49,5 +49,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "29600061d60d711eaf83ca7016f18949e67f0c8c"
+  "gitHead": "644a753c7290d814fae18a4f8b815ae650c0d936"
 }

package/assertions/CHANGELOG.md

@@ -1,87 +0,0 @@
-# v1.0.8 (Tue Apr 04 2023)
-
-:tada: This release contains work from a new contributor! :tada:
-
-Thank you, null[@debbie-yu](https://github.com/debbie-yu), for all your work!
-
-#### 🐛 Bug Fix
-
-- Adding new IntegrationMapping collection [#142](https://github.com/friggframework/frigg/pull/142) ([@debbie-yu](https://github.com/debbie-yu))
-- Merge branch 'main' of https://github.com/friggframework/frigg into debbie.yu/integration-mapping ([@debbie-yu](https://github.com/debbie-yu))
-- addressing PR feedback and adding unit tests around IntegrationMapping ([@debbie-yu](https://github.com/debbie-yu))
-- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 2
-
-- [@debbie-yu](https://github.com/debbie-yu)
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
-
----
-
-# v1.0.7 (Tue Jan 10 2023)
-
-:tada: This release contains work from a new contributor! :tada:
-
-Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all your work!
-
-#### 🐛 Bug Fix
-
-- strKey is not defined [#90](https://github.com/friggframework/frigg/pull/90) ([@seanspeaks](https://github.com/seanspeaks))
-- strKey is not defined ([@seanspeaks](https://github.com/seanspeaks))
-- Merge branch 'main' of github.com:friggframework/frigg into doc-updates ([@joncodo](https://github.com/joncodo))
-- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 2
-
-- Jonathan O'Donnell ([@joncodo](https://github.com/joncodo))
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
-
----
-
-# v1.0.6 (Mon Jan 09 2023)
-
-:tada: This release contains work from new contributors! :tada:
-
-Thanks for all your work!
-
-:heart: null[@cgenesoniSouthWorks](https://github.com/cgenesoniSouthWorks)
-
-:heart: Gregorio Martin ([@gregoriomartin](https://github.com/gregoriomartin))
-
-#### 🐛 Bug Fix
-
-- Merge remote-tracking branch 'origin/main' into gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
-- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
-- Updates to managers [#24](https://github.com/friggframework/frigg/pull/24) ([@seanspeaks](https://github.com/seanspeaks))
-- replace local references [#22](https://github.com/friggframework/frigg/pull/22) ([@cgenesoniSouthWorks](https://github.com/cgenesoniSouthWorks) [@gregoriomartin](https://github.com/gregoriomartin))
-- replace local references ([@cgenesoniSouthWorks](https://github.com/cgenesoniSouthWorks))
-- Merge remote-tracking branch 'origin/main' into simplify-mongoose-models ([@seanspeaks](https://github.com/seanspeaks))
-- Add READMEs for all packages and api-modules [#20](https://github.com/friggframework/frigg/pull/20) ([@seanspeaks](https://github.com/seanspeaks))
-- Add READMEs for all packages and api-modules ([@seanspeaks](https://github.com/seanspeaks))
-
-#### ⚠️ Pushed to `main`
-
-- Merge branch 'main' into gitbook-updates ([@seanspeaks](https://github.com/seanspeaks))
-- Add lodash.get as a dependency ([@seanspeaks](https://github.com/seanspeaks))
-- Refactored for more conventional naming (at least for packages) ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 3
-
-- [@cgenesoniSouthWorks](https://github.com/cgenesoniSouthWorks)
-- Gregorio Martin ([@gregoriomartin](https://github.com/gregoriomartin))
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
-
----
-
-# v1.0.5 (Thu Oct 13 2022)
-
-#### 🐛 Bug Fix
-
-- Bf/ironclad credential entity bug [#54](https://github.com/friggframework/frigg/pull/54) ([@JonathanEdMoore](https://github.com/JonathanEdMoore) [@sheehantoufiq](https://github.com/sheehantoufiq))
-- merge conflicts ([@sheehantoufiq](https://github.com/sheehantoufiq))
-- slack module changes ([@sheehantoufiq](https://github.com/sheehantoufiq))
-
-#### Authors: 2
-
-- Jonathan Moore ([@JonathanEdMoore](https://github.com/JonathanEdMoore))
-- Sheehan Toufiq Khan ([@sheehantoufiq](https://github.com/sheehantoufiq))

package/assertions/LICENSE.md

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Left Hook Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/assertions/README.md

@@ -1,3 +0,0 @@
-# assertions
-
-This package exports the `assertions` helpers used in [Frigg](https://friggframework.org). You can find its documentation [on Frigg's website](https://docs.friggframework.org/packages/assertions).

package/assertions/bump.txt

@@ -1 +0,0 @@
-0

package/associations/LICENSE.md

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Left Hook Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/associations/README.md

@@ -1,3 +0,0 @@
-# associations
-
-This package exports the `associations` mongoose model used in [Frigg](https://friggframework.org). You can find its documentation [on Frigg's website](https://docs.friggframework.org/packages/associations).

package/associations/jest.config.js

@@ -1,5 +0,0 @@
-module.exports = async () => {
-  return {
-    preset: "@friggframework/test-environment",
-  };
-};

package/bump.txt

@@ -1 +0,0 @@
-2

package/core/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-    "extends": "@friggframework/eslint-config"
-}