@friggframework/core 1.1.4 → 1.1.5

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/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/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.5",
   "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.5",
+    "@friggframework/prettier-config": "^1.1.5",
+    "@friggframework/test": "^1.1.5",
     "@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": "1a53bc7153b3735729e4d881ca9d7677964293c9"
 }