@friggframework/core 0.2.31-v1-alpha-package-update.0 → 1.0.1-canary.278.7b20420.0

package/index.js

@@ -1,6 +1,124 @@
-const { Delegate } = require('./Delegate');
-const { Worker } = require('./Worker');
-const { loadInstalledModules } = require('./load-installed-modules');
-const { createHandler } = require('./create-handler');
+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');
 
-module.exports = { Delegate, Worker, loadInstalledModules, createHandler };
+// const {Sync } = require('./syncs/model');
+
+module.exports = {
+    // 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/.eslintrc.json

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

package/integrations/CHANGELOG.md

@@ -0,0 +1,244 @@
+# v1.2.0 (Wed Sep 06 2023)
+
+#### 🚀 Enhancement
+
+- Slack lookup by externalId, remove the user requirement from Mongoose DB models [#218](https://github.com/friggframework/frigg/pull/218) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### 🐛 Bug Fix
+
+- Looking good ([@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.4 (Thu Aug 03 2023)
+
+#### 🐛 Bug Fix
+
+- remove check in Options [#206](https://github.com/friggframework/frigg/pull/206) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- remove check in Options ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.3 (Thu Jun 15 2023)
+
+#### 🐛 Bug Fix
+
+- return the mapping object directly from getIntegrationMapping [#157](https://github.com/friggframework/frigg/pull/157) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- potential change to return the mapping object directly from getIntegrationMapping. this is only to provide for cleaner assignment of the mapping when getIntegrationMapping is used. ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.2 (Thu Jun 08 2023)
+
+#### 🐛 Bug Fix
+
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.1 (Thu May 25 2023)
+
+#### 🐛 Bug Fix
+
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.0 (Wed Apr 26 2023)
+
+#### 🚀 Enhancement
+
+- Add refreshIntegration method for config retrieval inside the integra… [#151](https://github.com/friggframework/frigg/pull/151) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### 🐛 Bug Fix
+
+- Add refreshIntegration method for config retrieval inside the integrationManager ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.24 (Thu Apr 13 2023)
+
+#### 🐛 Bug Fix
+
+- Fix Slack getChannelHistory call [#147](https://github.com/friggframework/frigg/pull/147) ([@debbie-yu](https://github.com/debbie-yu))
+- Merge branch 'main' of https://github.com/friggframework/frigg into debbie.yu/fix-slack-history [#145](https://github.com/friggframework/frigg/pull/145) ([@debbie-yu](https://github.com/debbie-yu))
+- improve error thrown for invalid integration ([@debbie-yu](https://github.com/debbie-yu))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@debbie-yu](https://github.com/debbie-yu)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.23 (Tue Apr 04 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, null[@debbie-yu](https://github.com/debbie-yu), for all your work!
+
+#### 🐛 Bug Fix
+
+- Adding new IntegrationMapping collection [#142](https://github.com/friggframework/frigg/pull/142) ([@debbie-yu](https://github.com/debbie-yu))
+- Merge branch 'main' of https://github.com/friggframework/frigg into debbie.yu/integration-mapping ([@debbie-yu](https://github.com/debbie-yu))
+- addressing PR feedback and adding unit tests around IntegrationMapping ([@debbie-yu](https://github.com/debbie-yu))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@debbie-yu](https://github.com/debbie-yu)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.22 (Tue Feb 21 2023)
+
+#### 🐛 Bug Fix
+
+- Merge branch 'main' into hubspot-updates ([@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.0.20 (Tue Jan 31 2023)
+
+#### 🐛 Bug Fix
+
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.18 (Thu Jan 12 2023)
+
+#### 🐛 Bug Fix
+
+- Slack, Ironclad, and "IntegrationManager" updates [#92](https://github.com/friggframework/frigg/pull/92) ([@seanspeaks](https://github.com/seanspeaks))
+- Fix the output from entity hydration on the getFormattedIntegration method ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.17 (Wed Jan 11 2023)
+
+#### 🐛 Bug Fix
+
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 1
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.16 (Tue Jan 10 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Merge branch 'main' of github.com:friggframework/frigg into doc-updates ([@joncodo](https://github.com/joncodo))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- Jonathan O'Donnell ([@joncodo](https://github.com/joncodo))
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.0.15 (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))
+- Updates to managers [#24](https://github.com/friggframework/frigg/pull/24) ([@seanspeaks](https://github.com/seanspeaks))
+- integrations bump ([@seanspeaks](https://github.com/seanspeaks))
+- Update integrationManager createIntegration function to accept EntityManager param (WIP) (Could be improved) ([@seanspeaks](https://github.com/seanspeaks))
+- Bumped versions with patches ([@seanspeaks](https://github.com/seanspeaks))
+- A lot of changes all rolled into one [#21](https://github.com/friggframework/frigg/pull/21) ([@seanspeaks](https://github.com/seanspeaks))
+- Update integrations (Options) to include module reference/argument ([@seanspeaks](https://github.com/seanspeaks))
+- Weird class, probably needs cleanup ([@seanspeaks](https://github.com/seanspeaks))
+- Mongoose models tweak for sls offline as per https://nesin.io/blog/fix-mongoose-cannot-overwrite-model-once-compiled-error ([@seanspeaks](https://github.com/seanspeaks))
+- Continued updating of references and refactoring API modules ([@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.0.12 (Tue Dec 06 2022)
+
+#### 🐛 Bug Fix
+
+- fix modules to @friggframework [#74](https://github.com/friggframework/frigg/pull/74) ([@sheehantoufiq](https://github.com/sheehantoufiq))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+- Sheehan Toufiq Khan ([@sheehantoufiq](https://github.com/sheehantoufiq))
+
+---
+
+# v1.0.9 (Mon Sep 19 2022)
+
+#### 🐛 Bug Fix
+
+- 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/integrations/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/integrations/README.md

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

package/integrations/create-frigg-backend.js

@@ -0,0 +1,31 @@
+const {IntegrationFactory, IntegrationHelper} = require('./integration-factory');
+const User = require('./integration-user');
+
+function createFriggBackend(appDefinition) {
+    const {integrations = [], user=null} = appDefinition
+    const integrationFactory = new IntegrationFactory(integrations);
+    if (user) {
+        if (user.usePassword) {
+            User.usePassword = true;
+        }
+        if (user.primary === 'organization') {
+            User.primary = User.OrganizationUser
+        }
+        if (user.individualUserRequired !== undefined) {
+            User.individualUserRequired = user.individualUserRequired
+        }
+        if (user.organizationUserRequired !== undefined) {
+            User.organizationUserRequired = user.organizationUserRequired
+        }
+
+    }
+    const backend = {
+        integrationFactory,
+        moduleFactory: integrationFactory.moduleFactory,
+        IntegrationHelper,
+        User: User
+    }
+    return backend
+}
+
+module.exports = { createFriggBackend }

package/integrations/index.js

@@ -0,0 +1,19 @@
+const { IntegrationBase } = require('./integration-base');
+const { IntegrationModel } = require('./integration-model');
+const { Options } = require('./options');
+const { IntegrationMapping } = require('./integration-mapping');
+const { IntegrationFactory, IntegrationHelper } = require('./integration-factory');
+const { createIntegrationRouter, checkRequiredParams } = require('./integration-router');
+const { createFriggBackend } = require('./create-frigg-backend');
+
+module.exports = {
+    IntegrationBase,
+    IntegrationModel,
+    Options,
+    IntegrationMapping,
+    IntegrationFactory,
+    IntegrationHelper,
+    createIntegrationRouter,
+    checkRequiredParams,
+    createFriggBackend
+};

package/integrations/integration-base.js

@@ -0,0 +1,162 @@
+const { IntegrationMapping } = require('./integration-mapping');
+
+class IntegrationBase {
+    /**
+     * CHILDREN SHOULD SPECIFY A CONFIG
+     */
+    static Config = {
+        name: 'Integration Name',
+        version: '0.0.0', // Integration Version, used for migration and storage purposes, as well as display
+        supportedVersions: [], // Eventually usable for deprecation and future test version purposes
+
+        // an array of events that are process(able) by this Integration
+        events: [],
+    };
+
+    static getName() {
+        return this.Config.name;
+    }
+
+    static getCurrentVersion() {
+        return this.Config.version;
+    }
+
+    constructor(params) {
+        this.delegateTypes = [];
+        this.userActions = [];
+    }
+
+    //psuedo delegate for backwards compatability
+    async receiveNotification(notifier, delegateString, object = null) {
+
+    }
+
+    async notify(delegateString, object = null) {
+        if (!this.delegateTypes.includes(delegateString)) {
+            throw new Error(
+                `delegateString:${delegateString} is not defined in delegateTypes`
+            );
+        }
+        return this.receiveNotification(
+                this,
+                delegateString,
+                object
+        );
+    }
+
+    async validateConfig() {
+        const configOptions = await this.getConfigOptions();
+        const currentConfig = this.record.config;
+        let needsConfig = false;
+        for (const option of configOptions) {
+            if (option.required) {
+                // For now, just make sure the key exists. We should add more dynamic/better validation later.
+                if (
+                    !Object.prototype.hasOwnProperty.call(
+                        currentConfig,
+                        option.key
+                    )
+                ) {
+                    needsConfig = true;
+                    this.record.messages.warnings.push({
+                        title: 'Config Validation Error',
+                        message: `Missing required field of ${option.label}`,
+                        timestamp: Date.now(),
+                    });
+                }
+            }
+        }
+        if (needsConfig) {
+            this.record.status = 'NEEDS_CONFIG';
+            await this.record.save();
+        }
+    }
+
+    async testAuth() {
+        let didAuthPass = true;
+
+        try {
+            await this.primary.testAuth();
+        } catch {
+            didAuthPass = false;
+            this.record.messages.errors.push({
+                title: 'Authentication Error',
+                message: `There was an error with your ${this.primary.constructor.getName()} Entity.
+                Please reconnect/re-authenticate, or reach out to Support for assistance.`,
+                timestamp: Date.now(),
+            });
+        }
+
+        try {
+            await this.target.testAuth();
+        } catch {
+            didAuthPass = false;
+            this.record.messages.errors.push({
+                title: 'Authentication Error',
+                message: `There was an error with your ${this.target.constructor.getName()} Entity.
+            Please reconnect/re-authenticate, or reach out to Support for assistance.`,
+                timestamp: Date.now(),
+            });
+        }
+
+        if (!didAuthPass) {
+            this.record.status = 'ERROR';
+            this.record.markModified('messages.error');
+            await this.record.save();
+        }
+    }
+
+    async getMapping(sourceId) {
+        return IntegrationMapping.findBy(this.record.id, sourceId);
+    }
+
+    async upsertMapping(sourceId, mapping) {
+        if (!sourceId) {
+            throw new Error(`sourceId must be set`);
+        }
+        return await IntegrationMapping.upsert(
+            this.record.id,
+            sourceId,
+            mapping
+        );
+    }
+
+    async getAndSetUserActions() {
+        this.userActions = await this.getUserActions();
+        if (this.record?.config) {
+            this.record.config.userActions = this.userActions;
+            await this.record.save();
+        }
+        return this.userActions;
+    }
+
+
+
+    /**
+     * CHILDREN CAN OVERRIDE THESE CONFIGURATION METHODS
+     */
+    async onCreate(params) {
+        this.record.status = 'ENABLED';
+        await this.record.save();
+        return this.record;
+    }
+
+    async onUpdate(params) {
+    }
+
+    async onDelete(params) { }
+
+    async getConfigOptions() {
+        const options = {
+            jsonSchema: {},
+            uiSchema: {},
+        };
+        return options;
+    }
+
+    async getUserActions() {
+        return [];
+    }
+}
+
+module.exports = { IntegrationBase };