@friggframework/devtools 1.0.1-v1-alpha-package-update.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+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/.eslintrc.json

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

package/eslint-config/CHANGELOG.md

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

@@ -0,0 +1,9 @@
+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

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

@@ -0,0 +1,38 @@
+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/index.js

@@ -0,0 +1,9 @@
+const eslintConfig = require('./eslint-config')
+const prettierConfig = require('./prettier-config')
+const testEnvironment = require('./test-environment/index');
+
+module.exports = {
+    eslintConfig,
+    prettierConfig,
+    ...testEnvironment
+}

package/migrations/README.md

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

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

package/migrations/jest.config.js

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

package/migrations/manager.js

@@ -0,0 +1,33 @@
+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;

package/migrations/migrator.js

@@ -0,0 +1,170 @@
+const { Delegate } = require('../../core/core');
+const { Integration } = require('../../core/integrations');
+const { get } = require('../../core/assertions');
+
+class Migrator extends Delegate {
+  constructor(params) {
+    super(params);
+    this.options = [];
+  }
+
+  static getInstance() {
+    const instance = new this();
+    return instance;
+  }
+
+  static getName() {
+    return this.integrationManager.getName();
+  }
+
+  async migrate(params) {
+    try {
+      const fromVersion = get(params, "fromVersion", null);
+      const toVersion = get(params, "toVersion");
+
+      console.log("Migrate called. First validating whether it can be done.");
+      if (
+        !this.integrationManager.Config.supportedVersions.some(
+          (version) => version === toVersion
+        )
+      ) {
+        return this.throwException(
+          `Attempting to migrate to an unsupported version. Current supported versions are ${this.integrationManager.Config.supportedVersions.join(
+            ", "
+          )}`,
+          "Migration Error"
+        );
+      }
+      const migrationOption = this.options
+        .map((val) => val.get())
+        .find(
+          (option) =>
+            option.fromVersion === fromVersion && option.toVersion === toVersion
+        );
+      if (!migrationOption)
+        return this.throwException(
+          `No migration option found for version ${fromVersion} to ${toVersion}`,
+          "Migration Error"
+        );
+      // Run all general functions
+      for (const generalFunct of migrationOption.generalFunctions) {
+        console.log("Running general functions first");
+        const res = await generalFunct();
+        console.log(res);
+      }
+      // Get all integration records based on fromVersion
+      const filter = {
+        "config.type": this.integrationManager.getName(),
+      };
+      console.log(
+        `Retrieved all ${this.integrationManager.getName()} integrations`
+      );
+
+      const integrations = await Integration.find(filter);
+      const filteredIntegrations = integrations.filter((int) => {
+        const isNotToVersion = int.version !== toVersion;
+        let isFromVersion = true;
+        if (fromVersion && fromVersion !== "*") {
+          isFromVersion = int.version === fromVersion;
+        }
+        return isNotToVersion && isFromVersion;
+      });
+      const results = {
+        integrationType: this.integrationManager.getName(),
+        totalIntegrations: integrations.length,
+        versionReport: {
+          startVersions: {},
+          endVersions: {},
+        },
+        statusReport: {
+          startStatuses: {},
+          endStatuses: {},
+        },
+        toMigrate: filteredIntegrations.length,
+        migrationResults: {
+          success: 0,
+          needsConfig: 0,
+          error: 0,
+        },
+      };
+
+      for (const integration of integrations) {
+        if (results.versionReport.startVersions[integration.version]) {
+          results.versionReport.startVersions[integration.version] += 1;
+        } else {
+          results.versionReport.startVersions[integration.version] = 1;
+        }
+        if (results.statusReport.startStatuses[integration.status]) {
+          results.statusReport.startStatuses[integration.status] += 1;
+        } else {
+          results.statusReport.startStatuses[integration.status] = 1;
+        }
+      }
+
+      // Instantiate the integrationManager based on integration ID, run all specific functions for each integration
+      for (const integration of filteredIntegrations) {
+        let integrationManagerInstance;
+        try {
+          integrationManagerInstance =
+            await this.integrationManager.getInstanceFromIntegrationId({
+              integrationId: integration.id,
+              userId: integration.user.id,
+            });
+        } catch (e) {
+          console.log(e);
+        }
+        // Test Auth
+        if (integrationManagerInstance) {
+          await integrationManagerInstance.testAuth();
+
+          // Run functions
+          if (integrationManagerInstance.integration.status !== "ERROR") {
+            for (const func of migrationOption.perIntegrationFunctions) {
+              const res = await func(integrationManagerInstance);
+              console.log(res);
+            }
+          }
+
+          // Validate Config
+          if (integrationManagerInstance.integration.status !== "ERROR") {
+            await integrationManagerInstance.validateConfig();
+          }
+
+          // Add to results tally
+          const currentStatus = integrationManagerInstance.integration.status;
+          if (currentStatus === "ENABLED") {
+            integrationManagerInstance.integration.version = toVersion;
+            await integrationManagerInstance.integration.save();
+            results.migrationResults.success += 1;
+          }
+          if (currentStatus === "NEEDS_CONFIG") {
+            integrationManagerInstance.integration.version = toVersion;
+            await integrationManagerInstance.integration.save();
+            results.migrationResults.needsConfig += 1;
+          }
+          if (currentStatus === "ERROR") results.migrationResults.error += 1;
+        }
+      }
+
+      const freshRetrieve = await Integration.find(filter);
+      for (const int of freshRetrieve) {
+        if (results.versionReport.endVersions[int.version]) {
+          results.versionReport.endVersions[int.version] += 1;
+        } else {
+          results.versionReport.endVersions[int.version] = 1;
+        }
+        if (results.statusReport.endStatuses[int.status]) {
+          results.statusReport.endStatuses[int.status] += 1;
+        } else {
+          results.statusReport.endStatuses[int.status] = 1;
+        }
+      }
+
+      return results;
+    } catch (e) {
+      this.throwException(e.message, "Migrate Error");
+    }
+  }
+}
+
+module.exports = Migrator;

package/migrations/options.js

@@ -0,0 +1,28 @@
+const IntegrationManager = require('../../core/integrations');
+const { get, getAndVerifyType } = require('../../core/assertions');
+
+class Options {
+  constructor(params) {
+    this.integrationManager = getAndVerifyType(
+      params,
+      "integrationManager",
+      IntegrationManager
+    );
+    this.fromVersion = get(params, "fromVersion");
+    this.toVersion = get(params, "toVersion");
+    this.generalFunctions = get(params, "generalFunctions", []);
+    this.perIntegrationFunctions = get(params, "perIntegrationFunctions", []);
+  }
+
+  get() {
+    return {
+      type: this.integrationManager.getName(),
+      fromVersion: this.fromVersion,
+      toVersion: this.toVersion,
+      generalFunctions: this.generalFunctions,
+      perIntegrationFunctions: this.perIntegrationFunctions,
+    };
+  }
+}
+
+module.exports = Options;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@friggframework/devtools",
+  "prettier": "@friggframework/prettier-config",
+  "version": "1.0.1-v1-alpha-package-update.0",
+  "dependencies": {
+    "@babel/eslint-parser": "^7.18.9",
+    "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",
+    "jest-runner-groups": "^2.2.0",
+    "mongodb-memory-server": "^8.9.0"
+  },
+  "devDependencies": {
+    "jest": "^28.1.3",
+    "prettier": "^2.7.1"
+  },
+  "scripts": {
+    "lint:fix": "prettier --write --loglevel error . && eslint . --fix",
+    "test": "jest --passWithNoTests # TODO"
+  },
+  "author": "",
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/friggframework/frigg.git"
+  },
+  "bugs": {
+    "url": "https://github.com/friggframework/frigg/issues"
+  },
+  "homepage": "https://github.com/friggframework/frigg#readme",
+  "description": "",
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "2f565b1c08c09828c97f07c351a40ae6e4480186"
+}

package/prettier-config/.eslintrc.json

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

package/prettier-config/CHANGELOG.md

@@ -0,0 +1,17 @@
+# v1.0.6 (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/prettier-config/LICENSE.md

@@ -0,0 +1,9 @@
+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/prettier-config/README.md

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

package/prettier-config/index.js

@@ -0,0 +1,6 @@
+module.exports = {
+    semi: true,
+    tabWidth: 4,
+    singleQuote: true,
+    useTabs: false,
+};

package/test-environment/.eslintrc.json

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

package/test-environment/Authenticator.js

@@ -0,0 +1,73 @@
+// "use strict";
+const http = require('http');
+const url = require('url');
+const open = require('open');
+
+class Authenticator {
+    static searchParamsToDictionary(params) {
+        const entries = params.entries();
+        const result = {};
+        for (const entry of entries) {
+            const [key, value] = entry;
+            result[key] = value;
+        }
+        return result;
+    }
+
+    static async oauth2(authorizeUrl, port = 3000) {
+        return new Promise((resolve, reject) => {
+            const server = http
+                .createServer(async (req, res) => {
+                    try {
+                        const qs = new url.URL(
+                            req.url,
+                            `http://localhost:${port}`
+                        ).searchParams;
+
+                        // gets the last parameter in the slash
+                        const urlPostfix = req.url.split('?')[0];
+
+                        const params =
+                            Authenticator.searchParamsToDictionary(qs);
+
+                        res.end(
+                            `<h1 style="position: absolute;top: 50%;left: 50%;transform: translate(-50%, -50%);">Feel free to close the Brow Brow now</h1>
+                                        <style>@media (prefers-color-scheme: dark) {
+                                            body {
+                                                color: #b0b0b0;
+                                                background-color: #101010;
+                                            }
+                                        </style>`
+                        );
+                        server.close();
+                        resolve({
+                            base: urlPostfix,
+                            data: params,
+                        });
+                    } catch (e) {
+                        reject(e);
+                    }
+                })
+                .listen(port, () => {
+                    // open the browser to the authorize url to start the workflow
+                    open(authorizeUrl).then((childProcess) => {
+                        childProcess.unref();
+                        clearTimeout(timeoutId);
+                    });
+                });
+
+            const timeoutId = setTimeout(() => {
+                if (server.listening) {
+                    try {
+                        server.close();
+                    } finally {
+                        throw new Error(
+                            'Authenticator timed out before authentication completed in the browser.'
+                        );
+                    }
+                }
+            }, 59_000);
+        });
+    }
+}
+module.exports = Authenticator;

package/test-environment/CHANGELOG.md

@@ -0,0 +1,46 @@
+# v1.1.6 (Tue Jan 31 2023)
+
+#### 🐛 Bug Fix
+
+- Updates/api module yotpo [#108](https://github.com/friggframework/frigg/pull/108) ([@seanspeaks](https://github.com/seanspeaks))
+- # mock-api.js Work in Progress ([@seanspeaks](https://github.com/seanspeaks))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.5 (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`
+
+- Merge branch 'main' into gitbook-updates ([@seanspeaks](https://github.com/seanspeaks))
+- Refactored for more conventional naming (at least for packages) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.4 (Mon Sep 19 2022)
+
+#### 🐛 Bug Fix
+
+- Test environment setup for all modules [#49](https://github.com/friggframework/frigg/pull/49) ([@seanspeaks](https://github.com/seanspeaks))
+- Test environment setup for all modules ([@seanspeaks](https://github.com/seanspeaks))
+- Merge remote-tracking branch 'origin/main' into gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))

package/test-environment/LICENSE.md

@@ -0,0 +1,9 @@
+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/test-environment/README.md

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

package/test-environment/auther-definition-method-tester.js

@@ -0,0 +1,45 @@
+const {flushDebugLog} = require('../../core/logs');
+
+async function testDefinitionRequiredAuthMethods(api, definition, authCallbackParams, tokenResponse, userId) {
+
+    // const response = await definition.getToken(api, authCallbackParams);
+    // expect(api.setTokens).toHaveBeenCalled();
+    // if (tokenResponse) {
+    //     expect(response).toMatchObject(tokenResponse);
+    // }
+
+    const entityDetails = await definition.requiredAuthMethods.getEntityDetails(api, authCallbackParams, tokenResponse, userId);
+    expect(entityDetails).toHaveProperty('identifiers');
+    expect(Object.values(entityDetails.identifiers).length).toBeGreaterThan(0);
+    for (const key of Object.keys(entityDetails.identifiers)){
+        expect(key).toBeDefined();
+        expect(entityDetails.identifiers[key]).toBeDefined();
+    }
+
+
+    const credentialDetails = await definition.requiredAuthMethods.getCredentialDetails(api);
+    expect(credentialDetails).toHaveProperty('identifiers');
+    expect(Object.values(entityDetails.identifiers).length).toBeGreaterThan(0);
+    for (const key of Object.keys(entityDetails.identifiers)){
+        expect(key).toBeDefined();
+        expect(entityDetails.identifiers[key]).toBeDefined();
+    }
+
+    const successResponse = await definition.requiredAuthMethods.testAuthRequest(api);
+    expect(successResponse).toBeTruthy();
+    const savedKeys = {};
+    for (const key of definition.requiredAuthMethods.apiPropertiesToPersist.credential){
+        savedKeys[key] = api[key];
+        delete api[key];
+    }
+    let validAuth = false;
+    try {
+        if (await definition.requiredAuthMethods.testAuthRequest(api)) validAuth = true;
+    } catch (e) {
+        flushDebugLog(e);
+    }
+    expect(validAuth).not.toBeTruthy();
+    Object.assign(api, savedKeys);
+}
+
+module.exports = { testDefinitionRequiredAuthMethods }