@friggframework/core 1.1.6--canary.307.644a753.0 → 1.1.7--canary.359.1946bb6.0

package/CHANGELOG.md

@@ -1,3 +1,100 @@
+# v1.2.2 (Fri Aug 09 2024)
+
+#### 🐛 Bug Fix
+
+- Add support for secrets loading from SECRET_ARN [#327](https://github.com/friggframework/frigg/pull/327) ([@seanspeaks](https://github.com/seanspeaks))
+- Adding support for secrets loading ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.2.1 (Thu Aug 08 2024)
+
+#### 🐛 Bug Fix
+
+- Fix bug during local running [#326](https://github.com/friggframework/frigg/pull/326) ([@seanspeaks](https://github.com/seanspeaks))
+- Adding toJSON so that the descriminator decorator will be evaluated/added to the mongoose model (currently undefined on initialization and first invocation) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# 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

package/README.md

@@ -0,0 +1,83 @@
+# 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.
+- **Infrastructure**: Frigg reads through your integration definitions and auto-generates the infrastructure your code needs to run smoothly.
+
+## 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
+- **Infrastructure**: @friggframework/core/infrastructure
+
+
+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/core/create-handler.js

@@ -3,6 +3,7 @@ require('source-map-support').install();
 
 const { connectToDatabase } = require('../database/mongo');
 const { initDebugLog, flushDebugLog } = require('../logs');
+const { secretsToEnv } = require('./secrets-to-env');
 
 const createHandler = (optionByName = {}) => {
     const {
@@ -20,6 +21,15 @@ const createHandler = (optionByName = {}) => {
         try {
             initDebugLog(eventName, event);
 
+            const requestMethod = event.httpMethod;
+            const requestPath = event.path;
+            if (requestMethod && requestPath) {
+                console.info(`${requestMethod} ${requestPath}`);
+            }
+
+            // If enabled (i.e. if SECRET_ARN is set in process.env) Fetch secrets from AWS Secrets Manager, and set them as environment variables.
+            await secretsToEnv();
+
             // Helps mongoose reuse the connection.  Lowers response times.
             context.callbackWaitsForEmptyEventLoop = false;
 

package/core/secrets-to-env.js

@@ -0,0 +1,61 @@
+const getSecretValue = async () => {
+    console.log('Fetching secrets...');
+
+    const httpPort = process.env.PARAMETERS_SECRETS_EXTENSION_HTTP_PORT || 2773;
+    const url = `http://localhost:${httpPort}/secretsmanager/get?secretId=${encodeURIComponent(
+        process.env.SECRET_ARN
+    )}`;
+    const options = {
+        headers: {
+            'X-Aws-Parameters-Secrets-Token': process.env.AWS_SESSION_TOKEN,
+        },
+        method: 'GET',
+    };
+
+    const response = await fetch(url, options);
+
+    if (!response.ok) {
+        const json = await response.json().catch((err) => err.message);
+        console.error('Invalid response - response:', JSON.stringify(response));
+        console.error('Invalid response - json:', json);
+        throw new Error(`Invalid ${response.status} response`);
+    }
+
+    const result = await response.json();
+
+    if (!result) {
+        throw new Error('Error getting secret', result);
+    }
+
+    return JSON.parse(result.SecretString);
+};
+
+const transformSecrets = (secrets) => {
+    Object.keys(secrets).forEach((key) => {
+        process.env[key] = secrets[key];
+    });
+};
+
+/**
+ * Middleware that gets the secrets from Lambda layer and transform into environment variables.
+ *
+ */
+const secretsToEnv = async () => {
+    if (!process.env.SECRET_ARN) {
+        return;
+    }
+    console.log('Secrets to env');
+
+    try {
+        const secrets = await getSecretValue();
+        transformSecrets(secrets);
+
+        return secrets;
+    } catch (err) {
+        throw err;
+    }
+};
+
+module.exports = {
+    secretsToEnv,
+};

package/integrations/integration-base.js

@@ -27,9 +27,7 @@ class IntegrationBase {
     }
 
     //psuedo delegate for backwards compatability
-    async receiveNotification(notifier, delegateString, object = null) {
-
-    }
+    async receiveNotification(notifier, delegateString, object = null) {}
 
     async notify(delegateString, object = null) {
         if (!this.delegateTypes.includes(delegateString)) {
@@ -37,11 +35,7 @@ class IntegrationBase {
                 `delegateString:${delegateString} is not defined in delegateTypes`
             );
         }
-        return this.receiveNotification(
-                this,
-                delegateString,
-                object
-        );
+        return this.receiveNotification(this, delegateString, object);
     }
 
     async validateConfig() {
@@ -130,8 +124,6 @@ class IntegrationBase {
         return this.userActions;
     }
 
-
-
     /**
      * CHILDREN CAN OVERRIDE THESE CONFIGURATION METHODS
      */
@@ -141,10 +133,9 @@ class IntegrationBase {
         return this.record;
     }
 
-    async onUpdate(params) {
-    }
+    async onUpdate(params) {}
 
-    async onDelete(params) { }
+    async onDelete(params) {}
 
     async getConfigOptions() {
         const options = {
@@ -158,8 +149,8 @@ class IntegrationBase {
         const options = {
             jsonSchema: {},
             uiSchema: {},
-        }
-        return options
+        };
+        return options;
     }
 
     async getUserActions() {
@@ -170,16 +161,16 @@ class IntegrationBase {
         const options = {
             jsonSchema: {},
             uiSchema: {},
-        }
-        return options
+        };
+        return options;
     }
 
     async refreshActionOptions(params) {
         const options = {
             jsonSchema: {},
             uiSchema: {},
-        }
-        return options
+        };
+        return options;
     }
 }
 

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

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/module-plugin/auther.js

@@ -203,7 +203,7 @@ class Auther extends Delegate {
         return valid;
     }
 
-    getAuthorizationRequirements(params) {
+    async getAuthorizationRequirements(params) {
         // TODO: How can this be more helpful both to implement and consume
         // this function must return a dictionary with the following format
         // node only url key is required. Data would be used for Base Authentication

package/module-plugin/module-factory.js

@@ -1,12 +1,10 @@
-const { Entity } = require("./entity");
+const { Entity } = require('./entity');
 const { Auther } = require('./auther');
 
 class ModuleFactory {
     constructor(...params) {
         this.moduleDefinitions = params;
-        this.moduleTypes = this.moduleDefinitions.map(
-            (def) => def.moduleName
-        );
+        this.moduleTypes = this.moduleDefinitions.map((def) => def.moduleName);
     }
 
     async getEntitiesForUser(userId) {
@@ -14,7 +12,7 @@ class ModuleFactory {
         for (const moduleDefinition of this.moduleDefinitions) {
             const moduleInstance = await Auther.getInstance({
                 userId,
-                definition: moduleDefinition
+                definition: moduleDefinition,
             });
             const list = await moduleInstance.getEntitiesForUserId(userId);
             results.push(...list);
@@ -27,33 +25,36 @@ class ModuleFactory {
     }
 
     getModuleDefinitionFromTypeName(typeName) {
-        return
+        return;
     }
 
-
     async getModuleInstanceFromEntityId(entityId, userId) {
         const entity = await Entity.findById(entityId);
         const moduleDefinition = this.moduleDefinitions.find(
-            (def) => entity['__t'] === Auther.getEntityModelFromDefinition(def).modelName
-        )
+            (def) =>
+                entity.toJSON()['__t'] ===
+                Auther.getEntityModelFromDefinition(def).modelName
+        );
         if (!moduleDefinition) {
-            throw new Error('Module definition not found for entity type: ' + entity['__t']);
+            throw new Error(
+                'Module definition not found for entity type: ' + entity['__t']
+            );
         }
         return await Auther.getInstance({
             userId,
             entityId,
-            definition: moduleDefinition
+            definition: moduleDefinition,
         });
     }
 
-     async getInstanceFromTypeName(typeName, userId) {
-        const moduleDefinition =this.moduleDefinitions.find(
+    async getInstanceFromTypeName(typeName, userId) {
+        const moduleDefinition = this.moduleDefinitions.find(
             (def) => def.getName() === typeName
         );
-         return await Auther.getInstance({
-             userId,
-             definition: moduleDefinition
-         });
+        return await Auther.getInstance({
+            userId,
+            definition: moduleDefinition,
+        });
     }
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "1.1.6--canary.307.644a753.0",
+  "version": "1.1.7--canary.359.1946bb6.0",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
@@ -15,22 +15,21 @@
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
-    "@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",
+    "@friggframework/eslint-config": "1.1.7--canary.359.1946bb6.0",
+    "@friggframework/prettier-config": "1.1.7--canary.359.1946bb6.0",
+    "@friggframework/test": "1.1.7--canary.359.1946bb6.0",
     "@types/lodash": "^4.14.191",
-    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
     "chai": "^4.3.6",
-    "eslint": "^8.36.0",
-    "eslint-config-standard-with-typescript": "^34.0.1",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^15.6.1",
-    "eslint-plugin-promise": "^6.1.1",
-    "jest": "^28.1.3",
+    "eslint": "^8.22.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^17.10.2",
+    "eslint-plugin-promise": "^7.0.0",
+    "jest": "^29.7.0",
     "jest-runner-groups": "^2.2.0",
     "mongodb-memory-server": "^8.9.0",
     "prettier": "^2.8.5",
-    "sinon": "^14.0.0",
+    "sinon": "^16.1.1",
     "typescript": "^5.0.2"
   },
   "scripts": {
@@ -49,5 +48,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "644a753c7290d814fae18a4f8b815ae650c0d936"
+  "gitHead": "1946bb6a964605c8b3482683bb53eed8d6ee2da6"
 }