@friggframework/core 1.0.3-v1-alpha-package-update.6 → 1.1.0-v1-alpha.0

package/database/index.js

@@ -1,14 +1,20 @@
-const mongo = require('./mongo');
-const { mongoose } = require('./mongoose');
-const { IndividualUser } = require('./models/IndividualUser');
-const { OrganizationUser } = require('./models/OrganizationUser');
-const { State } = require('./models/State');
-const { Token } = require('./models/Token');
-const { UserModel } = require('./models/UserModel');
+const { mongoose} = require('./mongoose');
+const {
+    connectToDatabase,
+    disconnectFromDatabase,
+    createObjectId,
+} = require('./mongo');
+const {IndividualUser} = require('./models/IndividualUser');
+const {OrganizationUser} = require('./models/OrganizationUser');
+const {State} = require('./models/State');
+const {Token} = require('./models/Token');
+const {UserModel} = require('./models/UserModel');
 
 module.exports = {
-    ...mongo,
     mongoose,
+    connectToDatabase,
+    disconnectFromDatabase,
+    createObjectId,
     IndividualUser,
     OrganizationUser,
     State,

package/encrypt/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v1.1.8 (Fri Feb 02 2024)
+
+#### 🐛 Bug Fix
+
+- Added variable BYPASS_ENCRYPTION_STAGE to encrypt module [#248](https://github.com/friggframework/frigg/pull/248) ([@leofmds](https://github.com/leofmds))
+- Added variable BYPASS_ENCRYPTION_STAGE to encrypt module ([@leofmds](https://github.com/leofmds))
+
+#### Authors: 1
+
+- Leonardo Ferreira ([@leofmds](https://github.com/leofmds))
+
+---
+
 # v1.1.7 (Tue Apr 04 2023)
 
 :tada: This release contains work from a new contributor! :tada:

package/encrypt/README.md

@@ -1,3 +1,13 @@
 # encrypt
 
 This package exports the `encrypt` mongoose plugin used in [Frigg](https://friggframework.org). You can find its documentation [on Frigg's website](https://docs.friggframework.org/packages/encrypt).
+
+## Configuration
+
+| Environment variable    | Description                                                                                                |
+|-------------------------|------------------------------------------------------------------------------------------------------------|
+| KMS_KEY_ARN             | The AWS KMS Key ARN, if using it to encryption/decryption.                                                 |
+| AES_KEY                 | AES key, used in conjunction with AES_KEY_ID. AES option is mutually exclusive with KMS_KEY_ARN.           |
+| AES_KEY_ID              | AES key ID, used in conjunction with AES_KEY.                                                              |
+| STAGE                   | The stage in which the application is running. It is usually defined in Serverless configuration, if used. |
+| BYPASS_ENCRYPTION_STAGE | Stages to bypass encryption/decryption, separated by comma.                                                |

package/encrypt/encrypt.js

@@ -14,14 +14,22 @@ const findOneEvents = [
     'findOneAndReplace',
 ];
 
+const shouldBypassEncryption = (STAGE) => {
+    const defaultBypassStages = ['dev', 'test', 'local'];
+    const bypassStageEnv = process.env.BYPASS_ENCRYPTION_STAGE;
+    // If the env is set to anything or an empty string, use the env. Otherwise, use the default array
+    const useEnv = !String(bypassStageEnv) || !!bypassStageEnv;
+    const bypassStages = useEnv
+        ? bypassStageEnv.split(',').map((stage) => stage.trim())
+        : defaultBypassStages;
+    return bypassStages.includes(STAGE);
+};
+
 // The Mongoose plug-in function
 function Encrypt(schema, options) {
     const { STAGE, KMS_KEY_ARN, AES_KEY_ID } = process.env;
-    const isEnabledForStage =
-        ['staging', 'QA', 'prod', 'encryption-test'].indexOf(STAGE) > -1;
 
-    // No-op if not enabled
-    if (!isEnabledForStage) {
+    if (shouldBypassEncryption(STAGE)) {
         return;
     }
 

package/encrypt/encrypt.test.js

@@ -8,7 +8,7 @@ const {
     createModel,
     saveTestDocument,
 } = require('./test-encrypt');
-const { TestMongo } = require('../../devtools/test-environment');
+const { TestMongo } = require('@friggframework/devtools');
 
 const testMongo = new TestMongo();
 const originalEnv = process.env;
@@ -34,6 +34,7 @@ describe('Encrypt', () => {
             process.env = {
                 ...originalEnv,
                 STAGE: 'not-encryption-test',
+                BYPASS_ENCRYPTION_STAGE: 'not-encryption-test',
             };
 
             try {

package/encrypt/index.js

@@ -1,3 +1,4 @@
 const { Encrypt } = require('./encrypt');
+const { Cryptor } = require('./Cryptor');
 
-module.exports = { Encrypt };
+module.exports = { Encrypt, Cryptor };

package/errors/fetch-error.js

@@ -7,6 +7,8 @@ const { stripIndent } = require('common-tags');
 // https://developer.mozilla.org/en-US/docs/Web/API/fetch
 
 class FetchError extends BaseError {
+    response = null;
+
     constructor(options = {}) {
         const { resource, init, response, responseBody } = options;
         const method = init?.method ?? 'GET';
@@ -17,7 +19,7 @@ class FetchError extends BaseError {
                       return JSON.stringify({ init }, null, 2);
                   })()
                 : JSON.stringify({ init }, null, 2)
-            : '';
+            : '';        
 
         let responseBodyText = '<response body is unavailable>';
         if (typeof responseBody === 'string') {
@@ -59,6 +61,8 @@ class FetchError extends BaseError {
         ];
 
         super(messageParts.filter(Boolean).join('\n'));
+        
+        this.response = response;
     }
 
     static async create(options = {}) {

package/index.js

@@ -1,24 +1,124 @@
-
-const core = require('./core/index');
-const database = require('./database/index');
-const assertions = require('./assertions/index');
-const integrations = require('./integrations/index');
-const errors =  require('./errors/index');
-const encrypt = require('./encrypt/encrypt');
-const lambda = require('./lambda/index');
-const logs = require('./logs/index');
-const modulePlugin = require('./module-plugin/index');
+const {
+    expectShallowEqualDbObject,
+    get,
+    getAll,
+    verifyType,
+    getParamAndVerifyParamType,
+    getArrayParamAndVerifyParamType,
+    getAndVerifyType,
+} = require('./assertions/index');
+const  { Delegate, Worker, loadInstalledModules, createHandler } = require('./core/index');
+const {
+    mongoose,
+    connectToDatabase,
+    disconnectFromDatabase,
+    createObjectId,
+    IndividualUser,
+    OrganizationUser,
+    State,
+    Token,
+    UserModel
+} = require('./database/index');
+const { Encrypt, Cryptor } = require('./encrypt/encrypt');
+const {
+    BaseError,
+    FetchError,
+    HaltError,
+    RequiredPropertyError,
+    ParameterTypeError,
+} =  require('./errors/index');
+const {
+    IntegrationBase,
+    IntegrationModel,
+    Options,
+    IntegrationMapping,
+    IntegrationFactory,
+    IntegrationHelper,
+    createIntegrationRouter,
+    checkRequiredParams,
+    createFriggBackend
+} = require('./integrations/index');
+const { TimeoutCatcher } = require('./lambda/index');
+const {
+    debug,
+    initDebugLog,
+    flushDebugLog
+} = require('./logs/index');
+const {
+    Credential,
+    EntityManager,
+    Entity,
+    ModuleManager,
+    ApiKeyRequester,
+    BasicAuthRequester,
+    OAuth2Requester,
+    Requester,
+    ModuleConstants,
+    ModuleFactory,
+    Auther
+} = require('./module-plugin/index');
 
 // const {Sync } = require('./syncs/model');
 
 module.exports = {
-    ...core,
-    ...database,
-    ...assertions,
-    ...integrations,
-    ...errors,
-    ...encrypt,
-    ...lambda,
-    ...logs,
-    ...modulePlugin,
+    // assertions
+    expectShallowEqualDbObject,
+    get,
+    getAll,
+    verifyType,
+    getParamAndVerifyParamType,
+    getArrayParamAndVerifyParamType,
+    getAndVerifyType,
+    // core
+    Delegate,
+    Worker,
+    loadInstalledModules,
+    createHandler,
+    // database
+    mongoose,
+    connectToDatabase,
+    disconnectFromDatabase,
+    createObjectId,
+    IndividualUser,
+    OrganizationUser,
+    State,
+    Token,
+    UserModel,
+    // encrypt
+    Encrypt,
+    Cryptor,
+    // errors
+    BaseError,
+    FetchError,
+    HaltError,
+    RequiredPropertyError,
+    ParameterTypeError,
+    // integrations
+    IntegrationBase,
+    IntegrationModel,
+    Options,
+    IntegrationMapping,
+    IntegrationFactory,
+    IntegrationHelper,
+    checkRequiredParams,
+    createIntegrationRouter,
+    createFriggBackend,
+    // lambda
+    TimeoutCatcher,
+    // logs
+    debug,
+    initDebugLog,
+    flushDebugLog,
+    // module plugin
+    Credential,
+    EntityManager,
+    Entity,
+    ModuleManager,
+    ApiKeyRequester,
+    BasicAuthRequester,
+    OAuth2Requester,
+    Requester,
+    ModuleConstants,
+    ModuleFactory,
+    Auther
 }

package/integrations/jest-setup.js

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

package/integrations/jest-teardown.js

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

package/logs/logger.test.js

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

package/module-plugin/jest-setup.js

@@ -1,3 +1,3 @@
 require('dotenv').config();
-const { globalSetup } = require('../../devtools/test-environment');
+const { globalSetup } = require('@friggframework/devtools');
 module.exports = globalSetup;

package/module-plugin/jest-teardown.js

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

package/module-plugin/module-factory.js

@@ -27,7 +27,7 @@ class ModuleFactory {
     }
 
     getModuleDefinitionFromTypeName(typeName) {
-        return
+
     }
 
 

package/module-plugin/requester/requester.js

@@ -23,7 +23,8 @@ class Requester extends Delegate {
 
         if (
             contentType.match(/^application\/json/) ||
-            contentType.match(/^application\/vnd.api\+json/)
+            contentType.match(/^application\/vnd.api\+json/) ||
+            contentType.match(/^application\/hal\+json/)
         ) {
             return resp.json();
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "1.0.3-v1-alpha-package-update.6",
+  "version": "1.1.0-v1-alpha.0",
   "dependencies": {
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
@@ -9,14 +9,14 @@
     "common-tags": "^1.8.2",
     "express": "^4.18.2",
     "express-async-handler": "^1.2.0",
-    "jest-runner-groups": "^2.2.0",
     "lodash": "^4.17.21",
     "lodash.get": "^4.4.2",
-    "mongodb-memory-server": "^8.9.0",
     "mongoose": "6.11.6",
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
+    "@friggframework/devtools": "v1-alpha",
+    "@friggframework/prettier-config": "^1.0.6",
     "@types/lodash": "^4.14.191",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "chai": "^4.3.6",
@@ -26,6 +26,8 @@
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^28.1.3",
+    "jest-runner-groups": "^2.2.0",
+    "mongodb-memory-server": "^8.9.0",
     "prettier": "^2.8.5",
     "sinon": "^14.0.0",
     "typescript": "^5.0.2"
@@ -46,5 +48,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "527dbf1942413a3a1d3e3bfdda75a056b0003c7e"
+  "gitHead": "0900fdc8d00b013f41e24e08d827078bedd12d29"
 }

package/syncs/manager.js

@@ -8,7 +8,6 @@ const { Sync } = require("./model");
 
 class SyncManager {
   constructor(params) {
-    super(params);
     // TODO verify type????????
     // this.primaryModule = getAndVerifyType(params, 'primary', ModuleManager);
     // this.secondaryModule = getAndVerifyType(
@@ -36,7 +35,6 @@ class SyncManager {
 
     this.integration = get(params, "integration", null); // TODO Change to type validation
 
-    Sync = new Sync();
   }
 
   // calls getAllSyncObjects() on the modules and then finds the difference between each. The Primary Module