@friggframework/api-module-pipedrive 0.11.1 → 1.0.1-canary.36.7e495fb.0

package/defaultConfig.json

@@ -1,9 +1,11 @@
 {
-    "name": "pipedrive",
-    "label": "PipeDrive CRM",
-    "productUrl": "https://pipedrive.com",
-    "apiDocs": "https://developer.pipedrive.com",
-    "logoUrl": "https://friggframework.org/assets/img/pipedrive.jpeg",
-    "categories": ["Sales"],
-    "description": "Pipedrive"
+  "name": "pipedrive",
+  "label": "PipeDrive CRM",
+  "productUrl": "https://pipedrive.com",
+  "apiDocs": "https://developer.pipedrive.com",
+  "logoUrl": "https://friggframework.org/assets/img/pipedrive-icon.png",
+  "categories": [
+    "Sales"
+  ],
+  "description": "Pipedrive"
 }

package/definition.js

@@ -0,0 +1,54 @@
+require('dotenv').config();
+const { Api } = require('./api');
+const { get } = require('@friggframework/core');
+const config = require('./defaultConfig.json');
+
+const Definition = {
+    API: Api,
+    getName: function () {
+        return config.name;
+    },
+    moduleName: config.name,
+    modelName: 'Pipedrive',
+    requiredAuthMethods: {
+        getAuthorizationRequirements: async function (params) {
+            return {
+                url: await this.api.getAuthUri(),
+                type: 'oauth2',
+            };
+        },
+        getToken: async function (api, params) {
+            const code = get(params.data, 'code');
+            return api.getTokenFromCode(code);
+        },
+        getEntityDetails: async function (api, callbackParams, tokenResponse, userId) {
+            const userDetails = await api.getUser();
+            return {
+                identifiers: { externalId: userDetails.data.id, user: userId },
+                details: { name: userDetails.data.name || userDetails.data.email }
+            };
+        },
+        apiPropertiesToPersist: {
+            credential: ['access_token', 'refresh_token', 'companyDomain'],
+            entity: []
+        },
+        getCredentialDetails: async function (api, userId) {
+            const userDetails = await api.getUser();
+            return {
+                identifiers: { externalId: userDetails.data.id, user: userId },
+                details: {}
+            };
+        },
+        testAuthRequest: async function (api) {
+            return api.getUser();
+        }
+    },
+    env: {
+        client_id: process.env.PIPEDRIVE_CLIENT_ID,
+        client_secret: process.env.PIPEDRIVE_CLIENT_SECRET,
+        scope: process.env.PIPEDRIVE_SCOPE,
+        redirect_uri: `${process.env.REDIRECT_URI}/pipedrive`
+    }
+};
+
+module.exports = { Definition }; 

package/index.js

@@ -1,6 +1,6 @@
-const { Api } = require('./api');
-const { Credential } = require('./models/credential');
-const { Entity } = require('./models/entity');
+const {Api} = require('./api');
+const {Credential} = require('./models/credential');
+const {Entity} = require('./models/entity');
 const ModuleManager = require('./manager');
 const Config = require('./defaultConfig');
 

package/jest-setup.js

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

package/jest-teardown.js

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

package/manager.js

@@ -1,18 +1,20 @@
-const _ = require('lodash');
-const { Api } = require('./api.js');
-const { Entity } = require('./models/entity');
-const { Credential } = require('./models/credential');
 const {
     ModuleManager,
     ModuleConstants,
-} = require('@friggframework/module-plugin');
-const { flushDebugLog, debug } = require('@friggframework/logs');
+    flushDebugLog,
+    debug
+} = require('@friggframework/core');
+const {Api} = require('./api.js');
+const {Entity} = require('./models/entity');
+const {Credential} = require('./models/credential');
 const Config = require('./defaultConfig.json');
 
 class Manager extends ModuleManager {
-    static Entity = Entity;
+    static
+    Entity = Entity;
 
-    static Credential = Credential;
+    static
+    Credential = Credential;
 
     constructor(params) {
         super(params);
@@ -22,10 +24,11 @@ class Manager extends ModuleManager {
         return Config.name;
     }
 
-    static async getInstance(params) {
+    static
+    async getInstance(params) {
         const instance = new this(params);
 
-        const apiParams = { delegate: instance };
+        const apiParams = {delegate: instance};
         if (params.entityId) {
             instance.entity = await instance.entityMO.get(params.entityId);
             instance.credential = await instance.credentialMO.get(

package/mocks/apiMock.js

@@ -1,11 +1,13 @@
 class MockApi {
-    constructor() {}
+    constructor() {
+    }
 
     /** * Deals ** */
 
     async listDeals() {
         return require('./deals/listDeals');
     }
+
     /** * Activities ** */
 
     async createActivity() {

package/models/credential.js

@@ -1,5 +1,5 @@
+const {Credential: Parent} = require('@friggframework/core');
 const mongoose = require('mongoose');
-const { Credential: Parent } = require('@friggframework/module-plugin');
 
 const schema = new mongoose.Schema({
     accessToken: {
@@ -12,10 +12,10 @@ const schema = new mongoose.Schema({
         trim: true,
         lhEncrypt: true,
     },
-    companyDomain: { type: String },
+    companyDomain: {type: String},
 });
 
 const name = 'PipedriveCredential';
 const Credential =
     Parent.discriminators?.[name] || Parent.discriminator(name, schema);
-module.exports = { Credential };
+module.exports = {Credential};

package/models/entity.js

@@ -1,9 +1,9 @@
+const {Entity: Parent} = require('@friggframework/core');
 'use strict';
 const mongoose = require('mongoose');
-const { Entity: Parent } = require('@friggframework/module-plugin');
 
 const schema = new mongoose.Schema({});
 const name = 'PipedriveEntity';
 const Entity =
     Parent.discriminators?.[name] || Parent.discriminator(name, schema);
-module.exports = { Entity };
+module.exports = {Entity};

package/package.json

@@ -1,26 +1,27 @@
 {
-    "version": "0.11.1",
-    "name": "@friggframework/api-module-pipedrive",
-    "prettier": "@friggframework/prettier-config",
-    "description": "",
-    "main": "index.js",
-    "scripts": {
-        "lint:fix": "prettier --write --loglevel error . && eslint . --fix",
-        "test": "jest"
-    },
-    "author": "",
-    "license": "MIT",
-    "devDependencies": {
-        "@friggframework/eslint-config": "^1.0.8",
-        "@friggframework/test-environment": "^1.1.6",
-        "eslint": "^8.22.0",
-        "jest": "^28.1.3",
-        "prettier": "^2.7.1",
-        "sinon": "^14.0.0"
-    },
-    "dependencies": {
-        "@friggframework/assertions": "^1.0.8",
-        "@friggframework/module-plugin": "^1.1.3"
-    },
-    "gitHead": "a13c56185f26a9b5accc8be1286cd34f0139989f"
+  "name": "@friggframework/api-module-pipedrive",
+  "version": "1.0.1-canary.36.7e495fb.0",
+  "description": "Pipedrive CRM API module for Frigg Framework",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest --passWithNoTests"
+  },
+  "keywords": [
+    "frigg",
+    "api",
+    "pipedrive",
+    "crm",
+    "sales"
+  ],
+  "author": "Frigg Framework Team",
+  "license": "MIT",
+  "dependencies": {
+    "@friggframework/core": "^2.0.0-next.24",
+    "@friggframework/devtools": "^2.0.0-next.24",
+    "dotenv": "^16.0.0"
+  },
+  "devDependencies": {
+    "jest": "^29.0.0"
+  },
+  "gitHead": "7e495fbd0a1c9cd0836b2b0ec174ee36c1f59207"
 }