@friggframework/core 1.0.3-v1-alpha-package-update.5 → 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('../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,30 +1,124 @@
-const testEnvironment = require('./test-environment/index');
-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 eslintConfig = require('./eslint-config')
-const prettierConfig = require('./prettier-config')
+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 = {
-    ...testEnvironment,
-    ...core,
-    ...database,
-    ...assertions,
-    ...integrations,
-    ...errors,
-    ...encrypt,
-    ...lambda,
-    ...logs,
-    ...modulePlugin,
-    eslintConfig,
-    prettierConfig
+    // 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('../test-environment');
+const { globalSetup } = require('@friggframework/devtools');
 module.exports = globalSetup;

package/integrations/jest-teardown.js

@@ -1,2 +1,2 @@
-const { globalTeardown } = require('../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('../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('../test-environment');
+const { globalSetup } = require('@friggframework/devtools');
 module.exports = globalSetup;

package/module-plugin/jest-teardown.js

@@ -1,2 +1,2 @@
-const { globalTeardown } = require('../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,32 +1,24 @@
 {
   "name": "@friggframework/core",
   "prettier": "@friggframework/prettier-config",
-  "version": "1.0.3-v1-alpha-package-update.5",
+  "version": "1.1.0-v1-alpha.0",
   "dependencies": {
-    "@babel/eslint-parser": "^7.18.9",
     "@hapi/boom": "^10.0.1",
     "aws-sdk": "^2.1200.0",
     "bcryptjs": "^2.4.3",
     "common-tags": "^1.8.2",
-    "eslint": "^8.22.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-markdown": "^3.0.0",
-    "eslint-plugin-no-only-tests": "^3.0.0",
-    "eslint-plugin-yaml": "^0.5.0",
     "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",
-    "aws-sdk": "^2.1339.0",
     "chai": "^4.3.6",
     "eslint": "^8.36.0",
     "eslint-config-standard-with-typescript": "^34.0.1",
@@ -34,8 +26,8 @@
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^28.1.3",
-    "lodash": "^4.17.21",
-    "open": "8.4.2",
+    "jest-runner-groups": "^2.2.0",
+    "mongodb-memory-server": "^8.9.0",
     "prettier": "^2.8.5",
     "sinon": "^14.0.0",
     "typescript": "^5.0.2"
@@ -56,5 +48,5 @@
   },
   "homepage": "https://github.com/friggframework/frigg#readme",
   "description": "",
-  "gitHead": "afc5c3626416838485a6cec57b98b2b4387dd775"
+  "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

package/eslint-config/.eslintrc.json

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

package/eslint-config/CHANGELOG.md

@@ -1,17 +0,0 @@
-# v1.0.8 (Mon Jan 09 2023)
-
-#### 🐛 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))
-- 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`
-
-- Refactored for more conventional naming (at least for packages) ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 1
-
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))

package/eslint-config/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/eslint-config/README.md

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

package/eslint-config/index.js

@@ -1,38 +0,0 @@
-module.exports = {
-    env: {
-        commonjs: true,
-        es2020: true,
-        jest: true,
-    },
-    extends: ['prettier', 'plugin:markdown/recommended'],
-    parser: '@babel/eslint-parser',
-    parserOptions: {
-        ecmaVersion: 11,
-        requireConfigFile: false,
-    },
-    plugins: ['no-only-tests'],
-    ignorePatterns: ['coverage/', '.nyc_output/'],
-    overrides: [
-        {
-            files: ['*.json'],
-            plugins: ['json'],
-            extends: ['plugin:json/recommended'],
-        },
-        {
-            files: ['*.yaml', '*.yml'],
-            plugins: ['yaml'],
-            extends: ['plugin:yaml/recommended'],
-        },
-    ],
-    rules: {
-        'no-only-tests/no-only-tests': ['error', { fix: false }],
-        'no-unused-vars': [
-            'warn',
-            { vars: 'all', args: 'after-used', ignoreRestSiblings: false },
-        ],
-        'no-console': ['warn'],
-        camelcase: ['warn'],
-        'no-mixed-requires': ['warn'],
-        'no-warning-comments': ['warn'],
-    },
-};

package/migrations/README.md

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

package/migrations/index.js

@@ -1,9 +0,0 @@
-const MigrationManager = require('./manager');
-const Migrator = require('./migrator');
-const MigrationOptions = require('./options');
-
-module.exports = {
-    MigrationManager,
-    Migrator,
-    MigrationOptions
-}

package/migrations/jest.config.js

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

package/migrations/manager.js

@@ -1,33 +0,0 @@
-const hubspotMigrator = require("./HubSpotMigrator");
-const salesforceMigrator = require("./SalesforceMigrator");
-
-class MigrationManager {
-  static migratorClasses = [hubspotMigrator, salesforceMigrator];
-
-  static integrationTypes = MigrationManager.migratorClasses.map(
-    (MigratorClass) => MigratorClass.getName()
-  );
-
-  constructor() {
-    // ...
-  }
-
-  static async getMigrator(params) {
-    const { integrationType, fromVersion, toVersion } = params;
-    const indexOfMigrator =
-      MigrationManager.integrationTypes.indexOf(integrationType);
-    if (indexOfMigrator < 0) {
-      throw new Error(
-        `Error: Invalid integration type of ${
-          params.integrationType
-        }, options are ${MigrationManager.integrationTypes.join(", ")}`
-      );
-    }
-    const instance = await MigrationManager.migratorClasses[
-      indexOfMigrator
-    ].getInstance();
-    return instance;
-  }
-}
-
-module.exports = MigrationManager;