@friggframework/api-module-zoho-crm 2.0.0-next.0 → 2.0.0-next.2

package/dist/types.d.ts

@@ -0,0 +1,356 @@
+export interface ZohoConfig {
+    client_id: string;
+    client_secret: string;
+    scope: string;
+    redirect_uri: string;
+    access_token?: string | null;
+    refresh_token?: string | null;
+}
+export interface PaginationInfo {
+    per_page: number;
+    count: number;
+    page: number;
+    more_records: boolean;
+    next_page_token?: string;
+}
+export interface ZohoUser {
+    id: string;
+    first_name?: string;
+    last_name?: string;
+    full_name?: string;
+    email: string;
+    role?: {
+        name: string;
+        id: string;
+    };
+    profile?: {
+        name: string;
+        id: string;
+    };
+    status?: string;
+}
+export interface ZohoRole {
+    id: string;
+    name: string;
+    description?: string;
+}
+export interface ZohoProfile {
+    id: string;
+    name: string;
+    description?: string;
+}
+export interface ZohoContact {
+    id: string;
+    First_Name?: string;
+    Last_Name?: string;
+    Email?: string;
+    Phone?: string;
+    Account_Name?: {
+        name: string;
+        id: string;
+    };
+    Owner?: {
+        name: string;
+        id: string;
+    };
+    Lead_Source?: string;
+    Created_Time?: string;
+    Modified_Time?: string;
+    [key: string]: any;
+}
+export interface ZohoLead {
+    id: string;
+    First_Name?: string;
+    Last_Name?: string;
+    Email?: string;
+    Phone?: string;
+    Mobile?: string;
+    Company?: string;
+    Industry?: string;
+    Lead_Source?: string;
+    Lead_Status?: string;
+    Owner?: {
+        name: string;
+        id: string;
+    };
+    Converted__s?: boolean;
+    Converted_Date_Time?: string;
+    Created_Time?: string;
+    Modified_Time?: string;
+    [key: string]: any;
+}
+export interface ZohoAccount {
+    id: string;
+    Account_Name?: string;
+    Account_Number?: string;
+    Account_Type?: string;
+    Industry?: string;
+    Annual_Revenue?: number;
+    Rating?: string;
+    Phone?: string;
+    Fax?: string;
+    Website?: string;
+    Ticker_Symbol?: string;
+    Ownership?: string;
+    Employees?: number;
+    SIC_Code?: string;
+    Billing_Street?: string;
+    Billing_City?: string;
+    Billing_State?: string;
+    Billing_Code?: string;
+    Billing_Country?: string;
+    Shipping_Street?: string;
+    Shipping_City?: string;
+    Shipping_State?: string;
+    Shipping_Code?: string;
+    Shipping_Country?: string;
+    Parent_Account?: {
+        name: string;
+        id: string;
+    };
+    Owner?: {
+        name: string;
+        id: string;
+    };
+    Description?: string;
+    Created_Time?: string;
+    Modified_Time?: string;
+    Created_By?: {
+        name: string;
+        id: string;
+    };
+    Modified_By?: {
+        name: string;
+        id: string;
+    };
+    [key: string]: any;
+}
+export interface UsersResponse {
+    users: ZohoUser[];
+    info?: PaginationInfo;
+}
+export interface RolesResponse {
+    roles: ZohoRole[];
+}
+export interface ProfilesResponse {
+    profiles: ZohoProfile[];
+}
+export interface ContactsResponse {
+    data: ZohoContact[];
+    info?: PaginationInfo;
+}
+export interface ContactResponse {
+    data: ZohoContact[];
+}
+export interface LeadsResponse {
+    data: ZohoLead[];
+    info?: PaginationInfo;
+}
+export interface LeadResponse {
+    data: ZohoLead[];
+}
+export interface AccountsResponse {
+    data: ZohoAccount[];
+    info?: PaginationInfo;
+}
+export interface AccountResponse {
+    data: ZohoAccount[];
+}
+export interface CreateResponse {
+    code: string;
+    details: {
+        id: string;
+        Created_Time: string;
+        Modified_Time: string;
+        Created_By?: {
+            name: string;
+            id: string;
+        };
+        Modified_By?: {
+            name: string;
+            id: string;
+        };
+    };
+    message: string;
+    status: string;
+}
+export interface UpdateResponse {
+    code: string;
+    details: {
+        id: string;
+        Modified_Time: string;
+        Modified_By?: {
+            name: string;
+            id: string;
+        };
+    };
+    message: string;
+    status: string;
+}
+export interface DeleteResponse {
+    code: string;
+    details: {
+        id: string;
+    };
+    message: string;
+    status: string;
+}
+export interface ZohoNote {
+    id: string;
+    Note_Title?: string;
+    Note_Content: string;
+    Parent_Id?: {
+        module: {
+            api_name: string;
+            id: string;
+        };
+        id: string;
+    };
+    Owner?: {
+        name: string;
+        id: string;
+    };
+    Created_Time?: string;
+    Modified_Time?: string;
+    Created_By?: {
+        name: string;
+        id: string;
+    };
+    Modified_By?: {
+        name: string;
+        id: string;
+    };
+    [key: string]: any;
+}
+export interface CreateNoteData {
+    Note_Content: string;
+    Note_Title?: string;
+}
+export interface NotesResponse {
+    data: Array<{
+        code: string;
+        details: {
+            id: string;
+            Created_Time: string;
+            Modified_Time: string;
+            Created_By?: {
+                name: string;
+                id: string;
+            };
+            Modified_By?: {
+                name: string;
+                id: string;
+            };
+        };
+        message: string;
+        status: string;
+    }>;
+}
+export interface NoteListResponse {
+    data: ZohoNote[];
+    info?: PaginationInfo;
+}
+export interface QueryParams {
+    fields?: string;
+    per_page?: number;
+    page?: number;
+    sort_by?: string;
+    sort_order?: 'asc' | 'desc';
+    cvid?: string;
+    page_token?: string;
+    type?: 'ActiveUsers' | 'CurrentUser' | 'AdminUsers' | 'AllUsers';
+}
+export interface SearchParams {
+    email?: string;
+    phone?: string;
+    criteria?: string;
+    word?: string;
+    fields?: string;
+    per_page?: number;
+}
+export interface TokenResponse {
+    access_token: string;
+    refresh_token: string;
+    api_domain: string;
+    token_type: string;
+    expires_in: number;
+}
+/**
+ * Configuration for a single notification watch item
+ */
+export interface NotificationWatchItem {
+    /** Unique channel ID (use timestamp or UUID) */
+    channel_id: number | string;
+    /** Events to watch in format: "Module.operation" (e.g., "Contacts.all", "Contacts.create", "Accounts.edit") */
+    events: string[];
+    /** Callback URL to receive notifications */
+    notify_url: string;
+    /** Optional verification token (max 50 characters) */
+    token?: string;
+    /** Channel expiry time (ISO 8601 format, max 1 week from now) */
+    channel_expiry?: string;
+    /** Include field changes in callback payload */
+    return_affected_field_values?: boolean;
+    /** Trigger notifications on related record actions */
+    notify_on_related_action?: boolean;
+}
+/**
+ * Request body for enabling notifications
+ */
+export interface NotificationWatchConfig {
+    watch: NotificationWatchItem[];
+}
+/**
+ * Response from notification API operations
+ */
+export interface NotificationResponse {
+    watch: Array<{
+        code: string;
+        details: {
+            channel_id: number | string;
+            events: string[];
+            channel_expiry: string;
+            resource_uri: string;
+            resource_id: string;
+            resource_name: string;
+        };
+        message: string;
+        status: string;
+    }>;
+}
+/**
+ * Response from getting notification details
+ */
+export interface NotificationDetailsResponse {
+    watch: Array<{
+        channel_id: number | string;
+        events: string[];
+        channel_expiry: string;
+        notify_url: string;
+        resource_uri: string;
+        resource_id: string;
+        resource_name: string;
+        token?: string;
+    }>;
+}
+/**
+ * Payload received in notification callback
+ */
+export interface NotificationCallbackPayload {
+    /** Server timestamp */
+    server_time: number;
+    /** Module name (e.g., "Contacts", "Accounts") */
+    module: string;
+    /** Resource URI */
+    resource_uri: string;
+    /** Array of affected record IDs */
+    ids: string[];
+    /** Fields that were affected (if return_affected_field_values enabled) */
+    affected_fields?: string[];
+    /** Operation type: "insert", "update", or "delete" */
+    operation: 'insert' | 'update' | 'delete';
+    /** Channel ID that triggered this notification */
+    channel_id: number | string;
+    /** Verification token (if provided during setup) */
+    token?: string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,29 +1,40 @@
 {
   "name": "@friggframework/api-module-zoho-crm",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0-next.2",
   "prettier": "@friggframework/prettier-config",
   "description": "Zoho CRM API module that lets the Frigg Framework interact with Zoho CRM",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
     "lint:fix": "prettier --write --loglevel error . && eslint . --fix",
-    "test": "jest"
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
+  "files": [
+    "dist/**/*",
+    "defaultConfig.json",
+    "README.md",
+    "LICENSE.md"
+  ],
   "author": "",
   "license": "MIT",
   "devDependencies": {
-    "@friggframework/devtools": "^1.1.2",
-    "@friggframework/test": "^1.1.2",
+    "@friggframework/devtools": "^2.0.0-next.16",
+    "@friggframework/test": "^2.0.0-next.16",
+    "@types/node": "^20.8.0",
     "dotenv": "^16.0.3",
     "eslint": "^8.22.0",
-    "jest": "^28.1.3",
-    "jest-environment-jsdom": "^28.1.3",
-    "prettier": "^2.7.1"
+    "prettier": "^2.7.1",
+    "typescript": "^5.4.0",
+    "vitest": "^1.0.0"
   },
   "dependencies": {
-    "@friggframework/core": "^1.1.2"
+    "@friggframework/core": "^2.0.0-next.16"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "62b0e5a36d3df54945134203c548c023b2edceae"
+  "gitHead": "fa3f5ec40cbb9300511849233bddb0c463bfab2a"
 }

package/.env.example

@@ -1,4 +0,0 @@
-ZOHO_CRM_CLIENT_ID=
-ZOHO_CRM_CLIENT_SECRET=
-ZOHO_CRM_SCOPE=ZohoCRM.users.ALL,ZohoCRM.org.ALL,ZohoCRM.settings.roles.ALL,ZohoCRM.settings.profiles.ALL
-REDIRECT_URI=http://localhost:3000/redirect

package/CHANGELOG.md

@@ -1,50 +0,0 @@
-# v1.0.2 (Tue Aug 06 2024)
-
-:tada: This release contains work from a new contributor! :tada:
-
-Thank you, Fer Riffel ([@FerRiffel-LeftHook](https://github.com/FerRiffel-LeftHook)), for all your work!
-
-#### 🐛 Bug Fix
-
-- Updated icons for all Frigg API modules [#14](https://github.com/friggframework/api-module-library/pull/14) ([@FerRiffel-LeftHook](https://github.com/FerRiffel-LeftHook))
-- Update icons for all Frigg API modules ([@FerRiffel-LeftHook](https://github.com/FerRiffel-LeftHook))
-
-#### Authors: 1
-
-- Fer Riffel ([@FerRiffel-LeftHook](https://github.com/FerRiffel-LeftHook))
-
----
-
-# v1.0.1 (Mon Jul 15 2024)
-
-:tada: This release contains work from new contributors! :tada:
-
-Thanks for all your work!
-
-:heart: Igor Schechtel ([@igorschechtel](https://github.com/igorschechtel))
-
-:heart: Armando Alvarado ([@aaj](https://github.com/aaj))
-
-#### 🐛 Bug Fix
-
-- Unbabel Projects, Asana, and Zoho CRM [#10](https://github.com/friggframework/api-module-library/pull/10) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
-- add public publish access for zoho-crm ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
-- Add API module for Asana [#2](https://github.com/friggframework/api-module-library/pull/2) ([@igorschechtel](https://github.com/igorschechtel))
-- Added Zoho CRM API module [#4](https://github.com/friggframework/api-module-library/pull/4) ([@aaj](https://github.com/aaj))
-- Update README.md ([@aaj](https://github.com/aaj))
-- Added README ([@aaj](https://github.com/aaj))
-- Use single quotes ([@aaj](https://github.com/aaj))
-- Added test for listProfile, left stumps for all the other tests ([@aaj](https://github.com/aaj))
-- Better comments ([@aaj](https://github.com/aaj))
-- Added missing scope ([@aaj](https://github.com/aaj))
-- Added tests for all endpoints ([@aaj](https://github.com/aaj))
-- Added all CRUD endpoints for User and Role entities ([@aaj](https://github.com/aaj))
-- Added .env.example ([@aaj](https://github.com/aaj))
-- Added JSON headers, added createRole ([@aaj](https://github.com/aaj))
-- Initial Zoho CRM api module ([@aaj](https://github.com/aaj))
-
-#### Authors: 3
-
-- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
-- Armando Alvarado ([@aaj](https://github.com/aaj))
-- Igor Schechtel ([@igorschechtel](https://github.com/igorschechtel))

package/api.js

@@ -1,169 +0,0 @@
-const FormData = require('form-data');
-const {OAuth2Requester, get} = require('@friggframework/core');
-
-class Api extends OAuth2Requester {
-    constructor(params) {
-        super(params);
-        // The majority of the properties for OAuth are default loaded by OAuth2Requester.
-        // This includes the `client_id`, `client_secret`, `scopes`, and `redirect_uri`.
-        this.baseUrl = 'https://www.zohoapis.com/crm/v6';
-        this.authorizationUri = encodeURI(
-            `https://accounts.zoho.com/oauth/v2/auth?scope=${this.scope}&client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code&access_type=offline`
-        );
-        this.tokenUri = 'https://accounts.zoho.com/oauth/v2/token';
-        this.access_token = get(params, 'access_token', null);
-        this.refresh_token = get(params, 'refresh_token', null);
-
-        this.URLs = {
-            // Users
-            users: '/users',
-            user: (userId) => `/users/${userId}`,
-
-            // Roles
-            roles: '/settings/roles',
-            role: (roleId) => `/settings/roles/${roleId}`,
-
-            // Profiles
-            profiles: '/settings/profiles',
-        };
-    }
-
-    getAuthUri() {
-        return this.authorizationUri;
-    }
-
-    async getTokenFromCode(code) {
-        // I had to override OAuth2Requester.getTokenFromCode method so I could send a form-data,
-        // as described in the docs: https://www.zoho.com/crm/developer/docs/api/v6/access-refresh.html
-        const formData = new FormData();
-        formData.append('grant_type', 'authorization_code');
-        formData.append('client_id', this.client_id);
-        formData.append('client_secret', this.client_secret);
-        formData.append('redirect_uri', this.redirect_uri);
-        formData.append('scope', this.scope);
-        formData.append('code', code);
-        const options = {
-            body: formData,
-            headers: formData.getHeaders(),
-            url: this.tokenUri,
-        };
-        const response = await this._post(options, false);
-        await this.setTokens(response);
-        return response;
-    }
-
-    addJsonHeaders(options) {
-        const jsonHeaders = {
-            'content-type': 'application/json',
-            Accept: 'application/json',
-        };
-        options.headers = {
-            ...jsonHeaders,
-            ...options.headers,
-        }
-    }
-
-    async _get(options, stringify) {
-        this.addJsonHeaders(options);
-        return super._get(options, stringify);
-    }
-
-    async _post(options, stringify) {
-        this.addJsonHeaders(options);
-        return super._post(options, stringify);
-    }
-
-    async _put(options, stringify) {
-        this.addJsonHeaders(options);
-        return super._put(options, stringify);
-    }
-
-    async _delete(options) {
-        this.addJsonHeaders(options);
-        const response = await super._delete(options);
-        return await this.parsedBody(response);
-    }
-
-    // **************************   Users   **********************************
-    // https://www.zoho.com/crm/developer/docs/api/v6/get-users.html
-
-    async listUsers(queryParams = {}) {
-        return this._get({
-            url: this.baseUrl + this.URLs.users,
-            query: {...queryParams},
-        });
-    }
-
-    async getUser(userId) {
-        return this._get({
-            url: this.baseUrl + this.URLs.user(userId),
-        });
-    }
-
-    async createUser(body = {}) {
-        return this._post({
-            url: this.baseUrl + this.URLs.users,
-            body: body
-        });
-    }
-
-    async updateUser(userId, body = {}) {
-        return this._put({
-            url: this.baseUrl + this.URLs.user(userId),
-            body: body,
-        });
-    }
-
-    async deleteUser(userId) {
-        return this._delete({
-            url: this.baseUrl + this.URLs.user(userId),
-        });
-    }
-
-    // **************************   Roles   **********************************
-    // https://www.zoho.com/crm/developer/docs/api/v6/get-roles.html
-    
-    async listRoles() {
-        return this._get({
-            url: this.baseUrl + this.URLs.roles
-        });
-    }
-
-    async getRole(roleId) {
-        return this._get({
-            url: this.baseUrl + this.URLs.role(roleId)
-        });
-    }
-
-    async createRole(body = {}) {
-        return this._post({
-            url: this.baseUrl + this.URLs.roles,
-            body: body
-        });
-    }
-
-    async updateRole(roleId, body = {}) {
-        return this._put({
-            url: this.baseUrl + this.URLs.role(roleId),
-            body: body,
-        });
-    }
-
-    async deleteRole(roleId, queryParams = {}) {
-        return this._delete({
-            url: this.baseUrl + this.URLs.role(roleId),
-            query: {...queryParams},
-        });
-    }
-
-    // **************************   Profiles   **********************************
-    // https://www.zoho.com/crm/developer/docs/api/v6/get-profiles.html
-
-    async listProfiles() {
-        return this._get({
-            url: this.baseUrl + this.URLs.profiles
-        });
-    }
-}
-
-module.exports = {Api};

package/defaultConfig.json

@@ -1,13 +0,0 @@
-{
-  "name": "zoho-crm",
-  "label": "Zoho CRM",
-  "productUrl": "https://www.zoho.com/crm/",
-  "apiDocs": "https://www.zoho.com/crm/developer/docs/",
-  "logoUrl": "https://friggframework.org/assets/img/zoho-icon.png",
-  "categories": [
-    "Sales",
-    "Marketing",
-    "CRM"
-  ],
-  "description": "Zoho CRM acts as a single repository to bring your sales, marketing, and customer support activities together, and streamline your process, policy, and people in one platform."
-}

package/definition.js

@@ -1,51 +0,0 @@
-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,
-    requiredAuthMethods: {
-        getToken: async function(api, params) {
-            const code = get(params.data, 'code'); 
-            await api.getTokenFromCode(code);
-        },
-	    apiPropertiesToPersist: {
-            credential: ['access_token', 'refresh_token'],
-            entity: [],
-        },
-        getCredentialDetails: async function (api, userId) {
-            const response = await api.listUsers({type: 'CurrentUser'});
-            const currentUser = response.users[0];
-            return {
-                identifiers: {externalId: currentUser.id, user: userId},
-                details: {},
-            };
-        },
-        getEntityDetails: async function (api, callbackParams, tokenResponse, userId) {
-            const response = await api.listUsers({type: 'CurrentUser'});
-            const currentUser = response.users[0];
-            return {
-                identifiers: {externalId: currentUser.id, user: userId},
-                details: {
-                    name: currentUser.email
-                },
-            }
-        },
-        testAuthRequest: async function(api) {
-            return  await api.listUsers();
-        },
-    },
-    env: {
-        client_id: process.env.ZOHO_CRM_CLIENT_ID,
-        client_secret: process.env.ZOHO_CRM_CLIENT_SECRET,
-        scope: process.env.ZOHO_CRM_SCOPE,
-        redirect_uri: `${process.env.REDIRECT_URI}/zoho-crm`,
-    }
-};
-
-module.exports = {Definition};