@friggframework/core 1.1.3--canary.296.b068936.0 → 1.1.4--canary.301.c782f0f.0

package/CHANGELOG.md

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

@@ -155,7 +155,20 @@ 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);
+        })
+    );
+
+    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);
+            const results = await integration.refreshConfigOptions(
+                req.body
+            );
             res.json(results);
         })
     );
@@ -176,6 +189,23 @@ function setIntegrationRoutes(router, factory, getUserId) {
         })
     );
 
+    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);
+            const results = 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);
+        })
+    );
+
     router.route('/api/integrations/:integrationId/actions/:actionId').post(
         catchAsyncError(async (req, res) => {
             const params = checkRequiredParams(req.params, [
@@ -310,28 +340,6 @@ function setEntityRoutes(router, factory, getUserId) {
         })
     );
 
-    router.route('/api/entity').post(
-        catchAsyncError(async (req, res) => {
-            const params = checkRequiredParams(req.body, [
-                'entityType',
-                'data',
-            ]);
-            checkRequiredParams(req.body.data, ['credential_id']);
-
-            // May want to pass along the user ID as well so credential ID's can't be fished???
-            const credential = await IntegrationHelper.getCredentialById(
-                params.data.credential_id
-            );
-
-            if (!credential) {
-                throw Boom.badRequest('Invalid credential ID');
-            }
-
-            const module = await getModuleInstance(req, params.entityType);
-            res.json(await module.findOrCreateEntity(params.data));
-        })
-    );
-
     router.route('/api/entities/:entityId/test-auth').get(
         catchAsyncError(async (req, res) => {
             const params = checkRequiredParams(req.params, ['entityId']);
@@ -352,7 +360,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 +370,59 @@ 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/module-plugin/requester/requester.js

@@ -16,6 +16,7 @@ class Requester extends Delegate {
         // Allow passing in the fetch function
         // Instance methods can use this.fetch without differentiating
         this.fetch = get(params, 'fetch', fetch);
+
     }
 
     parsedBody = async (resp) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "1.1.3--canary.296.b068936.0",
+  "version": "1.1.4--canary.301.c782f0f.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.3--canary.296.b068936.0",
-    "@friggframework/prettier-config": "1.1.3--canary.296.b068936.0",
-    "@friggframework/test": "1.1.3--canary.296.b068936.0",
+    "@friggframework/eslint-config": "1.1.4--canary.301.c782f0f.0",
+    "@friggframework/prettier-config": "1.1.4--canary.301.c782f0f.0",
+    "@friggframework/test": "1.1.4--canary.301.c782f0f.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": "b0689366e283ca192f43cb6d03e0181bd3bb11c3"
+  "gitHead": "c782f0f412bf9bd865a62360ac7ce7ef444f4d12"
 }