@friggframework/core 0.1.1 → 0.2.1

package/Delegate.js

@@ -1,4 +1,4 @@
-const { get } = require('@friggframework/assertions');
+const { get } = require('..//assertions');
 
 class Delegate {
     constructor(params) {
@@ -26,4 +26,4 @@ class Delegate {
     }
 }
 
-module.exports = Delegate;
+module.exports = { Delegate };

package/Worker.js

@@ -1,18 +1,12 @@
 const AWS = require('aws-sdk');
 const _ = require('lodash');
-const {
-    RequiredPropertyError,
-} = require('@friggframework/errors/ValidationErrors');
-const { get } = require('@friggframework/assertions');
+const { RequiredPropertyError } = require('../errors');
+const { get } = require('../assertions');
 
 AWS.config.update({ region: process.env.AWS_REGION });
 const sqs = new AWS.SQS({ apiVersion: '2012-11-05' });
 
 class Worker {
-    constructor(params) {
-        super(params);
-    }
-
     async getQueueURL(params) {
         // Passing params in because there will be multiple QueueNames
         // let params = {
@@ -88,4 +82,4 @@ class Worker {
     // }
 }
 
-module.exports = Worker;
+module.exports = { Worker };

package/index.js

@@ -0,0 +1,5 @@
+const { Delegate } = require('./Delegate');
+const { Worker } = require('./Worker');
+const { loadInstalledModules } = require('./load-installed-modules');
+
+module.exports = { Delegate, Worker, loadInstalledModules };

package/jest.config.js

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

package/load-installed-modules.js

@@ -0,0 +1,26 @@
+const { readFileSync } = require('fs');
+const { join: joinPathParts } = require('path');
+
+const loadInstalledModules = () => {
+    const pathToPackage = joinPathParts(process.cwd(), 'package.json');
+    const contents = readFileSync(pathToPackage);
+    const pkg = JSON.parse(contents);
+    const dependencyNames = Object.keys(pkg.dependencies);
+    const installedNames = dependencyNames.filter((name) => {
+        const withoutOrganization = name.split('/').pop();
+        return withoutOrganization.startsWith('frigg-module-');
+    });
+    const manifests = installedNames.map((name) => {
+        // TODO could require them here, but that doesn;'t play well with webpack......... maybe need to put them in a .friggrc.js file...
+        const pathToManifest = joinPathParts(
+            process.cwd(),
+            'node_modules',
+            name
+        );
+        const manifestContents = readFileSync(pathToManifest);
+        return JSON.parse(manifestContents);
+    });
+    return manifests;
+};
+
+module.exports = { loadInstalledModules };

package/package.json

@@ -1,32 +1,32 @@
 {
-  "name": "@friggframework/core",
-  "prettier": "@friggframework/prettier-config",
-  "version": "0.1.1",
-  "devDependencies": {
-    "@friggframework/eslint-config": "^1.0.0",
-    "eslint": "^7.32.0",
-    "jest": "^27.4.7",
-    "prettier": "^2.5.1"
-  },
-  "scripts": {
-    "lint:fix": "prettier --write --loglevel error . && eslint . --fix",
-    "test": "jest --passWithNoTests # TODO"
-  },
-  "author": "",
-  "license": "MIT",
-  "main": "   ",
-  "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",
-  "dependencies": {
-    "@friggframework/assertions": "^1.0.0",
-    "moment": "^2.29.1",
-    "node-fetch": "^2.6.7"
-  },
-  "description": ""
+    "name": "@friggframework/core",
+    "prettier": "@friggframework/prettier-config",
+    "version": "0.2.1",
+    "devDependencies": {
+        "@friggframework/eslint-config": "^1.0.0",
+        "eslint": "^7.32.0",
+        "jest": "^27.4.7",
+        "prettier": "^2.5.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",
+    "dependencies": {
+        "@friggframework/assertions": "^1.0.0",
+        "moment": "^2.29.1",
+        "node-fetch": "^2.6.7"
+    },
+    "description": ""
 }

package/Requester.js

@@ -1,153 +0,0 @@
-const fetch = require('node-fetch');
-const Delegate = require('./Delegate');
-const { FetchError } = require('@friggframework/errors/FetchError');
-const { get } = require('@friggframework/assertions');
-
-class Requester extends Delegate {
-    constructor(params) {
-        super(params);
-        this.backOff = get(params, 'backOff', [1, 3, 10, 30, 60, 180]);
-        this.isRefreshable = false;
-        this.refreshCount = 0;
-        this.DLGT_INVALID_AUTH = 'INVALID_AUTH';
-        this.delegateTypes.push(this.DLGT_INVALID_AUTH);
-
-        // Allow passing in the fetch function
-        // Instance methods can use this.fetch without differentiating
-        this.fetch = get(params, 'fetch', fetch);
-    }
-
-    parsedBody = async (resp) => {
-        const contentType = resp.headers.get('Content-Type') || '';
-
-        if (
-            contentType.match(/^application\/json/) ||
-            contentType.match(/^application\/vnd.api\+json/)
-        ) {
-            return resp.json();
-        }
-
-        return resp.text();
-    };
-
-    async _request(url, options, i = 0) {
-        let encodedUrl = encodeURI(url);
-        if (options.query) {
-            let queryBuild = '?';
-            for (const key in options.query) {
-                queryBuild += `${encodeURIComponent(key)}=${encodeURIComponent(
-                    options.query[key]
-                )}&`;
-            }
-            encodedUrl += queryBuild.slice(0, -1);
-        }
-
-        options.headers = await this.addAuthHeaders(options.headers);
-
-        const response = await this.fetch(encodedUrl, options);
-        const { status } = response;
-
-        // If the status is retriable and there are back off requests left, retry the request
-        if ((status === 429 || status >= 500) && i < this.backOff.length) {
-            const delay = this.backOff[i] * 1000;
-            await new Promise((resolve) => setTimeout(resolve, delay));
-            return this._request(url, options, i + 1);
-        } else if (status === 401) {
-            if (!this.isRefreshable || this.refreshCount > 0) {
-                await this.notify(this.DLGT_INVALID_AUTH);
-            } else {
-                this.refreshCount++;
-                // this.isRefreshable = false; // Set so that if we 401 during refresh request, we hit the above block
-                await this.refreshAuth();
-                // this.isRefreshable = true;// Set so that we can retry later? in case it's a fast expiring auth
-                this.refreshCount = 0;
-                return this._request(url, options, i + 1); // Retries
-            }
-        }
-
-        // If the error wasn't retried, throw.
-        if (status >= 400) {
-            throw await FetchError.create({
-                resource: encodedUrl,
-                init: options,
-                response,
-            });
-        }
-
-        return options.returnFullRes
-            ? response
-            : await this.parsedBody(response);
-    }
-
-    async _get(options) {
-        const fetchOptions = {
-            method: 'GET',
-            credentials: 'include',
-            headers: options.headers || {},
-            query: options.query || {},
-            returnFullRes: options.returnFullRes || false,
-        };
-
-        const res = await this._request(options.url, fetchOptions);
-        return res;
-    }
-
-    async _post(options, stringify = true) {
-        const fetchOptions = {
-            method: 'POST',
-            credentials: 'include',
-            headers: options.headers || {},
-            query: options.query || {},
-            body: JSON.stringify(options.body),
-            returnFullRes: options.returnFullRes || false,
-        };
-        if (!stringify) {
-            fetchOptions.body = options.body;
-        }
-        const res = await this._request(options.url, fetchOptions);
-        return res;
-    }
-
-    async _patch(options) {
-        const fetchOptions = {
-            method: 'PATCH',
-            credentials: 'include',
-            headers: options.headers || {},
-            query: options.query || {},
-            body: JSON.stringify(options.body),
-            returnFullRes: options.returnFullRes || false,
-        };
-        const res = await this._request(options.url, fetchOptions);
-        return res;
-    }
-
-    async _put(options) {
-        const fetchOptions = {
-            method: 'PUT',
-            credentials: 'include',
-            headers: options.headers || {},
-            query: options.query || {},
-            body: JSON.stringify(options.body),
-            returnFullRes: options.returnFullRes || false,
-        };
-        const res = await this._request(options.url, fetchOptions);
-        return res;
-    }
-
-    async _delete(options) {
-        const fetchOptions = {
-            method: 'DELETE',
-            credentials: 'include',
-            headers: options.headers || {},
-            query: options.query || {},
-            returnFullRes: options.returnFullRes || true,
-        };
-        return this._request(options.url, fetchOptions);
-    }
-
-    async refreshAuth() {
-        throw new Error('refreshAuth not yet defined in child of Requester');
-    }
-}
-
-module.exports = Requester;

package/auth/ApiKeyBase.js

@@ -1,30 +0,0 @@
-const Requester = require('../Requester.js');
-
-class ApiKeyBase extends Requester {
-    constructor(params) {
-        super(params);
-        this.API_KEY_NAME = 'key';
-        this.API_KEY_VALUE = null;
-    }
-
-    async addAuthHeaders(headers) {
-        if (this.API_KEY_VALUE) {
-            headers[this.API_KEY_NAME] = this.API_KEY_VALUE;
-        }
-        return headers;
-    }
-
-    isAuthenticated() {
-        return (
-            this.API_KEY_VALUE !== null &&
-            this.API_KEY_VALUE !== undefined &&
-            this.API_KEY_VALUE.trim().length() > 0
-        );
-    }
-
-    setApiKey(api_key) {
-        this.API_KEY_VALUE = api_key;
-    }
-}
-
-module.exports = ApiKeyBase;

package/auth/OAuth2Base.js

@@ -1,203 +0,0 @@
-const moment = require('moment');
-const Requester = require('../Requester.js');
-const { get } = require('@friggframework/assertions');
-
-class OAuth2Base extends Requester {
-    constructor(params) {
-        super(params);
-        this.DLGT_TOKEN_UPDATE = 'TOKEN_UPDATE';
-        this.DLGT_TOKEN_DEAUTHORIZED = 'TOKEN_DEAUTHORIZED';
-
-        this.delegateTypes.push(this.DLGT_TOKEN_UPDATE);
-        this.delegateTypes.push(this.DLGT_TOKEN_DEAUTHORIZED);
-
-        this.grantType = get(params, 'grantType', 'authorization_code');
-        this.key = get(params, 'key', null);
-        this.secret = get(params, 'secret', null);
-        this.redirectUri = get(params, 'redirectUri', null);
-        this.authorizationUri = get(params, 'authorizationUri', null);
-        this.baseURL = get(params, 'baseURL', null);
-        this.access_token = get(params, 'access_token', null);
-        this.refresh_token = get(params, 'refresh_token', null);
-        this.accessTokenExpire = get(params, 'accessTokenExpire', null);
-        this.refreshTokenExpire = get(params, 'refreshTokenExpire', null);
-        this.audience = get(params, 'audience', null);
-        this.username = get(params, 'username', null);
-        this.password = get(params, 'password', null);
-
-        this.isRefreshable = true;
-    }
-
-    async setTokens(params) {
-        this.access_token = get(params, 'access_token');
-        this.refresh_token = get(params, 'refresh_token', null);
-        const accessExpiresIn = get(params, 'expires_in', null);
-        const refreshExpiresIn = get(
-            params,
-            'x_refresh_token_expires_in',
-            null
-        );
-
-        this.accessTokenExpire = moment().add(accessExpiresIn, 'seconds');
-        this.refreshTokenExpire = moment().add(refreshExpiresIn, 'seconds');
-
-        await this.notify(this.DLGT_TOKEN_UPDATE);
-    }
-
-    getAuthorizationUri() {
-        return this.authorizationUri;
-    }
-
-    // this.client_id, this.client_secret, this.redirect_uri, and this.tokenUri
-    // will need to be defined in the child class before super(params)
-    async getTokenFromCode(code) {
-        const params = new URLSearchParams();
-        params.append('grant_type', 'authorization_code');
-        params.append('client_id', this.client_id);
-        params.append('client_secret', this.client_secret);
-        params.append('redirect_uri', this.redirect_uri);
-        params.append('code', code);
-        const options = {
-            body: params,
-            headers: {
-                'Content-Type': 'application/x-www-form-urlencoded',
-            },
-            url: this.tokenUri,
-        };
-        const response = await this._post(options, false);
-        await this.setTokens(response);
-        return response;
-    }
-
-    // REPLACE getTokenFromCode IN THE CHILD IF NEEDED
-    // this.client_id, this.client_secret, this.redirect_uri, and this.tokenUri
-    // will need to be defined in the child class before super(params)
-    async getTokenFromCodeBasicAuthHeader(code) {
-        const params = new URLSearchParams();
-        params.append('grant_type', 'authorization_code');
-        params.append('client_id', this.client_id);
-        params.append('redirect_uri', this.redirect_uri);
-        params.append('code', code);
-
-        const options = {
-            body: params,
-            headers: {
-                'Content-Type': 'application/x-www-form-urlencoded',
-                Authorization: `Basic ${Buffer.from(
-                    `${this.client_id}:${this.client_secret}`
-                ).toString('base64')}`,
-            },
-            url: this.tokenUri,
-        };
-
-        const response = await this._post(options, false);
-        await this.setTokens(response);
-        return response;
-    }
-
-    // this.client_id, this.client_secret, this.redirect_uri, and this.tokenUri
-    // will need to be defined in the child class before super(params)
-    async refreshAccessToken(refreshTokenObject) {
-        this.access_token = undefined;
-        const params = new URLSearchParams();
-        params.append('grant_type', 'refresh_token');
-        params.append('client_id', this.client_id);
-        params.append('client_secret', this.client_secret);
-        params.append('refresh_token', refreshTokenObject.refresh_token);
-        params.append('redirect_uri', this.redirect_uri);
-
-        const options = {
-            body: params,
-            url: this.tokenUri,
-        };
-        const response = await this._post(options, false);
-        await this.setTokens(response);
-        return response;
-    }
-
-    async addAuthHeaders(headers) {
-        if (this.access_token) {
-            headers.Authorization = `Bearer ${this.access_token}`;
-        }
-
-        return headers;
-    }
-
-    isAuthenticated() {
-        return (
-            this.accessToken !== null &&
-            this.refreshToken !== null &&
-            this.accessTokenExpire &&
-            this.refreshTokenExpire
-        );
-    }
-
-    async refreshAuth() {
-        try {
-            if (this.grantType !== 'client_credentials') {
-                await this.refreshAccessToken({
-                    refresh_token: this.refresh_token,
-                });
-            } else {
-                await this.getTokenFromClientCredentials();
-            }
-        } catch {
-            await this.notify(this.DLGT_INVALID_AUTH);
-        }
-    }
-
-    async getTokenFromUsernamePassword() {
-        try {
-            const url = this.tokenUri;
-
-            const body = {
-                username: this.username,
-                password: this.password,
-                grant_type: 'password',
-            };
-            const headers = {
-                'Content-Type': 'application/json',
-            };
-
-            const tokenRes = await this._post({
-                url,
-                body,
-                headers,
-            });
-
-            await this.setTokens(tokenRes);
-            return tokenRes;
-        } catch {
-            await this.notify(this.DLGT_INVALID_AUTH);
-        }
-    }
-
-    async getTokenFromClientCredentials() {
-        try {
-            const url = this.tokenUri;
-
-            const body = {
-                audience: this.audience,
-                client_id: this.client_id,
-                client_secret: this.client_secret,
-                grant_type: 'client_credentials',
-            };
-            const headers = {
-                'Content-Type': 'application/json',
-            };
-
-            const tokenRes = await this._post({
-                url,
-                body,
-                headers,
-            });
-
-            await this.setTokens(tokenRes);
-            return tokenRes;
-        } catch {
-            await this.notify(this.DLGT_INVALID_AUTH);
-        }
-    }
-}
-
-module.exports = OAuth2Base;

package/managers/IntegrationConfigManager.js

@@ -1,22 +0,0 @@
-const Delegate = require('../Delegate');
-
-class IntegrationConfigManager extends Delegate {
-    constructor(params) {
-        super(params);
-        this.primary = null;
-        this.options = [];
-    }
-
-    async getIntegrationOptions() {
-        return {
-            entities: {
-                primary: this.primary.getName(),
-                options: this.options.map((val) => val.get()),
-                authorized: [],
-            },
-            integrations: [],
-        };
-    }
-}
-
-module.exports = IntegrationConfigManager;