@friggframework/api-module-pipedrive 1.0.1-v1-alpha.5 → 2.1.0-canary.56.2dc58f9.0

package/LICENSE.md

@@ -2,8 +2,15 @@ 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:
+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 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.
+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/README.md

@@ -1,5 +1,6 @@
 # pipedrive
-    
-This is the API Module for pipedrive that allows the [Frigg](https://friggframework.org) code to talk to the pipedrive API.
+
+This is the API Module for pipedrive that allows the [Frigg](https://friggframework.org) code to talk to the pipedrive
+API.
 
 Read more on the [Frigg documentation site](https://docs.friggframework.org/api-modules/list/pipedrive

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/dist/api.d.ts

@@ -0,0 +1,59 @@
+import { OAuth2Requester } from '@friggframework/core';
+import { OAuth2RequesterOptions, ActivityParams, ListActivitiesParams, ListDealsParams, ListPersonsParams, GetPersonParams, PipedriveResponse, PipedriveUser, PipedriveTokenResponse } from './types';
+export declare class Api extends OAuth2Requester {
+    companyDomain: string | null;
+    URLs: {
+        activities: string;
+        activityFields: string;
+        activityById: (activityId: string | number) => string;
+        getUser: string;
+        users: string;
+        deals: string;
+        persons: string;
+        personById: (personId: string | number) => string;
+    };
+    constructor(params: OAuth2RequesterOptions);
+    /**
+     * Sets OAuth tokens and captures the Pipedrive company domain
+     * @param params - Token response from OAuth provider
+     * @param params.api_domain - The Pipedrive company-specific API domain (e.g., 'https://company.pipedrive.com')
+     * @returns Token response
+     */
+    setTokens(params: PipedriveTokenResponse): Promise<PipedriveTokenResponse>;
+    /**
+     * Sets the company domain and updates the base URL for API requests
+     * @param companyDomain - The Pipedrive company domain (e.g., 'https://company.pipedrive.com' or 'company.pipedrive.com')
+     */
+    setCompanyDomain(companyDomain: string): Promise<void>;
+    /**
+     * List deals with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with deal data array and pagination cursor
+     */
+    listDeals(params?: ListDealsParams): Promise<PipedriveResponse>;
+    listActivityFields(): Promise<PipedriveResponse>;
+    /**
+     * List activities with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with activity data array and pagination cursor
+     */
+    listActivities(params?: ListActivitiesParams): Promise<PipedriveResponse>;
+    deleteActivity(activityId: string | number): Promise<PipedriveResponse>;
+    updateActivity(activityId: string | number, task: Partial<ActivityParams>): Promise<PipedriveResponse>;
+    createActivity(params: ActivityParams): Promise<PipedriveResponse>;
+    getUser(): Promise<PipedriveUser>;
+    listUsers(): Promise<PipedriveResponse>;
+    /**
+     * List persons with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with person data array and pagination cursor
+     */
+    listPersons(params?: ListPersonsParams): Promise<PipedriveResponse>;
+    /**
+     * Get a single person by ID
+     * @param personId - The ID of the person to retrieve
+     * @param params - Query parameters for additional fields
+     * @returns Response with person data
+     */
+    getPerson(personId: string | number, params?: GetPersonParams): Promise<PipedriveResponse>;
+}

package/dist/api.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = void 0;
+const core_1 = require("@friggframework/core");
+class Api extends core_1.OAuth2Requester {
+    constructor(params) {
+        super(params);
+        this.companyDomain = (0, core_1.get)(params, 'companyDomain', null);
+        if (this.companyDomain) {
+            this.baseUrl = `${this.companyDomain}/api`;
+        }
+        this.URLs = {
+            activities: '/v2/activities',
+            activityFields: '/v1/activityFields',
+            activityById: (activityId) => `/v2/activities/${activityId}`,
+            getUser: '/v1/users/me',
+            users: '/v1/users',
+            deals: '/v2/deals',
+            persons: '/v2/persons',
+            personById: (personId) => `/v2/persons/${personId}`,
+        };
+        this.authorizationUri = encodeURI(`https://oauth.pipedrive.com/oauth/authorize?client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code&scope=${this.scope}`);
+        this.tokenUri = 'https://oauth.pipedrive.com/oauth/token';
+    }
+    /**
+     * Sets OAuth tokens and captures the Pipedrive company domain
+     * @param params - Token response from OAuth provider
+     * @param params.api_domain - The Pipedrive company-specific API domain (e.g., 'https://company.pipedrive.com')
+     * @returns Token response
+     */
+    async setTokens(params) {
+        if (params.api_domain) {
+            await this.setCompanyDomain(params.api_domain);
+        }
+        else if (!this.companyDomain) {
+            throw new Error('Pipedrive api_domain not provided in token response');
+        }
+        return super.setTokens(params);
+    }
+    /**
+     * Sets the company domain and updates the base URL for API requests
+     * @param companyDomain - The Pipedrive company domain (e.g., 'https://company.pipedrive.com' or 'company.pipedrive.com')
+     */
+    async setCompanyDomain(companyDomain) {
+        if (!companyDomain) {
+            throw new Error('Company domain is required for Pipedrive API');
+        }
+        const formattedDomain = companyDomain.startsWith('http')
+            ? companyDomain
+            : `https://${companyDomain}`;
+        this.companyDomain = formattedDomain;
+        this.baseUrl = `${this.companyDomain}/api`;
+    }
+    // **************************   Deals   **********************************
+    /**
+     * List deals with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with deal data array and pagination cursor
+     */
+    async listDeals(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.deals,
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
+    // **************************   Activities   **********************************
+    async listActivityFields() {
+        const options = {
+            url: this.baseUrl + this.URLs.activityFields,
+        };
+        return this._get(options);
+    }
+    /**
+     * List activities with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with activity data array and pagination cursor
+     */
+    async listActivities(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.activities,
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
+    async deleteActivity(activityId) {
+        const options = {
+            url: this.baseUrl + this.URLs.activityById(activityId),
+        };
+        return this._delete(options);
+    }
+    async updateActivity(activityId, task) {
+        const options = {
+            url: this.baseUrl + this.URLs.activityById(activityId),
+            body: task,
+        };
+        return this._patch(options);
+    }
+    async createActivity(params) {
+        const dealId = (0, core_1.get)(params, 'dealId', null);
+        const subject = (0, core_1.get)(params, 'subject');
+        const type = (0, core_1.get)(params, 'type');
+        const options = {
+            url: this.baseUrl + this.URLs.activities,
+            body: { ...params },
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        };
+        return this._post(options);
+    }
+    // **************************   Users   **********************************
+    async getUser() {
+        const options = {
+            url: this.baseUrl + this.URLs.getUser,
+        };
+        return this._get(options);
+    }
+    async listUsers() {
+        const options = {
+            url: this.baseUrl + this.URLs.users,
+        };
+        return this._get(options);
+    }
+    // **************************   Persons   **********************************
+    /**
+     * List persons with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with person data array and pagination cursor
+     */
+    async listPersons(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.persons,
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
+    /**
+     * Get a single person by ID
+     * @param personId - The ID of the person to retrieve
+     * @param params - Query parameters for additional fields
+     * @returns Response with person data
+     */
+    async getPerson(personId, params) {
+        const options = {
+            url: this.baseUrl + this.URLs.personById(personId),
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
+}
+exports.Api = Api;

package/dist/definition.d.ts

@@ -0,0 +1,4 @@
+import 'dotenv/config';
+import { FriggModuleAuthDefinition } from '@friggframework/core';
+declare const Definition: FriggModuleAuthDefinition;
+export { Definition };

package/dist/definition.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Definition = void 0;
+require("dotenv/config");
+const api_1 = require("./api");
+const core_1 = require("@friggframework/core");
+const defaultConfig_json_1 = __importDefault(require("../defaultConfig.json"));
+const Definition = {
+    API: api_1.Api,
+    getName: () => defaultConfig_json_1.default.name,
+    moduleName: defaultConfig_json_1.default.name,
+    modelName: 'Pipedrive',
+    requiredAuthMethods: {
+        getToken: async (api, params) => {
+            const code = (0, core_1.get)(params.data, 'code', '');
+            if (!code) {
+                throw new Error('Authorization code is required');
+            }
+            return api.getTokenFromCode(code);
+        },
+        getEntityDetails: async (api, callbackParams, tokenResponse, userId) => {
+            try {
+                const userProfile = await api.getUser();
+                if (!userProfile || !userProfile.data) {
+                    throw new Error(`Pipedrive /v1/users/me failed to return valid user info. Response: ${JSON.stringify(userProfile)}`);
+                }
+                return {
+                    identifiers: {
+                        externalId: String(userProfile.data.company_id),
+                        user: userId
+                    },
+                    details: {
+                        name: userProfile.data.company_name || 'Unknown Company'
+                    },
+                };
+            }
+            catch (error) {
+                throw new Error(`Failed to get Pipedrive entity details: ${error.message}`);
+            }
+        },
+        apiPropertiesToPersist: {
+            credential: [
+                'access_token',
+                'refresh_token',
+                'companyDomain'
+            ],
+            entity: [],
+        },
+        getCredentialDetails: async (api, userId) => {
+            try {
+                const userProfile = await api.getUser();
+                if (!userProfile || !userProfile.data) {
+                    throw new Error(`Pipedrive /v1/users/me failed to return valid user info. Response: ${JSON.stringify(userProfile)}`);
+                }
+                return {
+                    identifiers: {
+                        externalId: String(userProfile.data.id),
+                        user: userId
+                    },
+                    details: {}
+                };
+            }
+            catch (error) {
+                throw new Error(`Failed to get Pipedrive credential details: ${error.message}`);
+            }
+        },
+        testAuthRequest: async (api) => 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`,
+    }
+};
+exports.Definition = Definition;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { Api } from './api';
+import { Definition } from './definition';
+export { Api, Definition };
+export { Api as PipedriveAPI };
+export default Definition;

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipedriveAPI = exports.Definition = exports.Api = void 0;
+const api_1 = require("./api");
+Object.defineProperty(exports, "Api", { enumerable: true, get: function () { return api_1.Api; } });
+Object.defineProperty(exports, "PipedriveAPI", { enumerable: true, get: function () { return api_1.Api; } });
+const definition_1 = require("./definition");
+Object.defineProperty(exports, "Definition", { enumerable: true, get: function () { return definition_1.Definition; } });
+exports.default = definition_1.Definition;

package/package.json

@@ -1,23 +1,33 @@
 {
-    "version": "1.0.1-v1-alpha.5",
-    "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": {
-        "eslint": "^8.22.0",
-        "jest": "^28.1.3",
-        "prettier": "^2.7.1",
-        "sinon": "^14.0.0"
-    },
-    "dependencies": {
-        "@friggframework/core": "1.0.1-v1-alpha.5"
-    },
-    "gitHead": "866cdecac7b599ec734f8772a5774112da1e8f7a"
+  "name": "@friggframework/api-module-pipedrive",
+  "version": "2.1.0-canary.56.2dc58f9.0",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint ."
+  },
+  "files": [
+    "dist/**/*",
+    "defaultConfig.json",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "dependencies": {
+    "@friggframework/core": "^2.0.0",
+    "dotenv": "^16.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "2dc58f950aad42005d2a4d536615fff6420f6a1d"
 }

package/.eslintrc.json

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

package/CHANGELOG.md

@@ -1,171 +0,0 @@
-# v0.9.0 (Wed Sep 06 2023)
-
-#### 🐛 Bug Fix
-
-- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 1
-
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
-
----
-
-# v0.8.26 (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))
-
----
-
-# v0.8.25 (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))
-
----
-
-# v0.8.24 (Tue Apr 04 2023)
-
-#### 🐛 Bug Fix
-
-- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 1
-
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
-
----
-
-# v0.8.23 (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))
-
----
-
-# v0.8.21 (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))
-
----
-
-# v0.8.19 (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))
-
----
-
-# v0.8.18 (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))
-
----
-
-# v0.8.17 (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))
-- A lot of changes all rolled into one [#21](https://github.com/friggframework/frigg/pull/21) ([@seanspeaks](https://github.com/seanspeaks))
-- Updated API modules with support for sls offline, and made sure optional chaining with discriminators was in place ([@seanspeaks](https://github.com/seanspeaks))
-- Fixing dependencies across all API Modules ([@seanspeaks](https://github.com/seanspeaks))
-- More import issues (Exports are named objects, imports needed to object destructure) ([@seanspeaks](https://github.com/seanspeaks))
-- Updates to API Modules for proper export/imports ([@seanspeaks](https://github.com/seanspeaks))
-- Merge remote-tracking branch 'origin/main' into simplify-mongoose-models ([@seanspeaks](https://github.com/seanspeaks))
-- Update all api modules to use module-plugin 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))
-- Finish initial formatting and publishing of all modules ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 1
-
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
-
----
-
-# v0.8.14 (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))
-
----
-
-# v0.8.11 (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))
-
----
-
-# v0.8.10 (Thu Sep 01 2022)
-
-#### 🐛 Bug Fix
-
-- version bumped to address tag issue [#43](https://github.com/friggframework/frigg/pull/43) ([@seanspeaks](https://github.com/seanspeaks))
-- version bumped ([@seanspeaks](https://github.com/seanspeaks))
-- Publish ([@seanspeaks](https://github.com/seanspeaks))
-- Add nx and licenses [#37](https://github.com/friggframework/frigg/pull/37) ([@seanspeaks](https://github.com/seanspeaks))
-- MIT to all packages ([@seanspeaks](https://github.com/seanspeaks))
-
-#### Authors: 1
-
-- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))