@divyacon/piece-whatsapp 0.0.0-stage → 0.1.0

package/dist/lib/common/utils.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commonProps = exports.mediaTypeSupportsCaption = exports.capitalizeFirstLetter = exports.supportedMediaTypes = void 0;
+const tslib_1 = require("tslib");
+// Vendored from Activepieces packages/pieces/community/whatsapp/src/lib/common/utils.ts (MIT).
+// Generated by packages/scripts/vendor-ap.mjs - do not edit by hand.
+const pieces_common_1 = require("@agnocon/pieces-common");
+const auth_1 = require("../auth");
+const pieces_framework_1 = require("@agnocon/pieces-framework");
+exports.supportedMediaTypes = ['image', 'audio', 'document', 'sticker', 'video'];
+const capitalizeFirstLetter = (word) => word.charAt(0).toUpperCase() + word.slice(1);
+exports.capitalizeFirstLetter = capitalizeFirstLetter;
+const mediaTypeSupportsCaption = (type) => ['image', 'video', 'document'].includes(type);
+exports.mediaTypeSupportsCaption = mediaTypeSupportsCaption;
+exports.commonProps = {
+    phone_number_id: pieces_framework_1.Property.Dropdown({
+        auth: auth_1.whatsappAuth,
+        displayName: 'Phone Number ID',
+        description: 'Phone number ID that will be used to send the message.',
+        refreshers: [],
+        required: true,
+        options: (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ auth }) {
+            if (!auth) {
+                return {
+                    placeholder: 'Please connect account first',
+                    disabled: true,
+                    options: [],
+                };
+            }
+            const authValue = auth.props;
+            const options = [];
+            let hasMore = false;
+            let cursor;
+            do {
+                const qs = {
+                    fields: 'verified_name,id,display_phone_number',
+                    limit: '1',
+                };
+                if (cursor)
+                    qs['after'] = cursor;
+                const response = yield pieces_common_1.httpClient.sendRequest({
+                    method: pieces_common_1.HttpMethod.GET,
+                    url: `https://graph.facebook.com/v20.0/${authValue.businessAccountId}/phone_numbers`,
+                    authentication: {
+                        type: pieces_common_1.AuthenticationType.BEARER_TOKEN,
+                        token: authValue.access_token,
+                    },
+                    queryParams: qs,
+                });
+                for (const phoneNumber of response.body.data) {
+                    options.push({
+                        label: `${phoneNumber.verified_name} : ${phoneNumber.display_phone_number}`,
+                        value: phoneNumber.id,
+                    });
+                }
+                if (response.body.paging.next) {
+                    (hasMore = true), (cursor = response.body.paging.cursors.after);
+                }
+                else {
+                    hasMore = false;
+                }
+            } while (hasMore);
+            return {
+                disabled: false,
+                options,
+            };
+        }),
+    }),
+    message_template_id: pieces_framework_1.Property.Dropdown({
+        displayName: 'Message Template ID',
+        refreshers: [],
+        required: true,
+        auth: auth_1.whatsappAuth,
+        options: (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ auth }) {
+            if (!auth) {
+                return {
+                    placeholder: 'Please connect account first',
+                    disabled: true,
+                    options: [],
+                };
+            }
+            const authValue = auth.props;
+            const options = [];
+            let hasMore = false;
+            let cursor;
+            do {
+                const qs = {
+                    fields: 'id,name,language',
+                    limit: '1',
+                };
+                if (cursor)
+                    qs['after'] = cursor;
+                const response = yield pieces_common_1.httpClient.sendRequest({
+                    method: pieces_common_1.HttpMethod.GET,
+                    url: `https://graph.facebook.com/v20.0/${authValue.businessAccountId}/message_templates`,
+                    authentication: {
+                        type: pieces_common_1.AuthenticationType.BEARER_TOKEN,
+                        token: authValue.access_token,
+                    },
+                    queryParams: qs,
+                });
+                for (const template of response.body.data) {
+                    options.push({
+                        label: `${template.name} (${template.language})`,
+                        value: template.id,
+                    });
+                }
+                if (response.body.paging.next) {
+                    (hasMore = true), (cursor = response.body.paging.cursors.after);
+                }
+                else {
+                    hasMore = false;
+                }
+            } while (hasMore);
+            return {
+                disabled: false,
+                options,
+            };
+        }),
+    }),
+    message_template_fields: pieces_framework_1.Property.DynamicProperties({
+        displayName: 'Template Fields',
+        refreshers: ['message_template_id'],
+        required: true,
+        auth: auth_1.whatsappAuth,
+        props: (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ auth, message_template_id }) {
+            var _b, _c, _d, _e, _f, _g;
+            if (!auth)
+                return {};
+            if (!message_template_id)
+                return {};
+            const authValue = auth.props;
+            const templateId = message_template_id;
+            const response = yield pieces_common_1.httpClient.sendRequest({
+                url: `https://graph.facebook.com/v20.0/${templateId}`,
+                method: pieces_common_1.HttpMethod.GET,
+                authentication: {
+                    type: pieces_common_1.AuthenticationType.BEARER_TOKEN,
+                    token: authValue.access_token,
+                },
+            });
+            const bodyComponentFields = {};
+            const headerComponentFields = {};
+            const buttonComponentFields = {};
+            for (const component of response.body.components) {
+                if (component.type === 'BODY') {
+                    // https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components#syntax
+                    bodyComponentFields['BODY_markdown'] = pieces_framework_1.Property.MarkDown({
+                        value: `
+						**Body :**
+						${component.text}`,
+                    });
+                    const bodyTextVariables = (_c = (_b = component.text) === null || _b === void 0 ? void 0 : _b.match(/{{(\d+)}}/g)) !== null && _c !== void 0 ? _c : [];
+                    for (let i = 0; i < bodyTextVariables.length; i++) {
+                        bodyComponentFields[`body_{{${i + 1}}}`] = pieces_framework_1.Property.ShortText({
+                            displayName: `Body {{${i + 1}}}`,
+                            required: false,
+                        });
+                    }
+                }
+                else if (component.type === 'HEADER' && component.format === 'TEXT') {
+                    // https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components#text-headers
+                    headerComponentFields['HEADER_markdown'] = pieces_framework_1.Property.MarkDown({
+                        value: `
+						**Header :**
+						${component.text}`,
+                    });
+                    const headerTextVariables = (_e = (_d = component.text) === null || _d === void 0 ? void 0 : _d.match(/{{(\d+)}}/g)) !== null && _e !== void 0 ? _e : [];
+                    for (let i = 0; i < headerTextVariables.length; i++) {
+                        headerComponentFields[`header_{{${i + 1}}}`] = pieces_framework_1.Property.ShortText({
+                            displayName: `Header {{${i + 1}}}`,
+                            required: false,
+                        });
+                    }
+                }
+                else if (component.type === 'BUTTONS') {
+                    // https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components#url-buttons
+                    for (const button of component.buttons) {
+                        if (button.type === 'URL') {
+                            const buttonURLTextVariables = (_g = (_f = button.url) === null || _f === void 0 ? void 0 : _f.match(/{{(\d+)}}/g)) !== null && _g !== void 0 ? _g : [];
+                            for (let i = 0; i < buttonURLTextVariables.length; i++) {
+                                buttonComponentFields[`button_{{${i + 1}}}`] = pieces_framework_1.Property.ShortText({
+                                    displayName: button.text,
+                                    required: false,
+                                });
+                            }
+                        }
+                    }
+                }
+            }
+            const templateFields = Object.assign(Object.assign(Object.assign({}, headerComponentFields), bodyComponentFields), buttonComponentFields);
+            return templateFields;
+        }),
+    }),
+};
+//# sourceMappingURL=utils.js.map

package/dist/lib/common/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/common/utils.ts"],"names":[],"mappings":";;;;AAAA,+FAA+F;AAC/F,qEAAqE;AACrE,0DAKgC;AAChC,kCAAuC;AACvC,gEAKmC;AAEtB,QAAA,mBAAmB,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAC/E,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAAvF,QAAA,qBAAqB,yBAAkE;AAC7F,MAAM,wBAAwB,GAAG,CAAC,IAAY,EAAE,EAAE,CACxD,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AADlC,QAAA,wBAAwB,4BACU;AAElC,QAAA,WAAW,GAAG;IAC1B,eAAe,EAAE,2BAAQ,CAAC,QAAQ,CAAC;QAClC,IAAI,EAAE,mBAAY;QAClB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,wDAAwD;QACrE,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,KAAiB,EAAE,oDAAZ,EAAE,IAAI,EAAE;YACvB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACX,OAAO;oBACN,WAAW,EAAE,8BAA8B;oBAC3C,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE,EAAE;iBACX,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;YAE7B,MAAM,OAAO,GAA6B,EAAE,CAAC;YAE7C,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,MAAM,CAAC;YAEX,GAAG,CAAC;gBACH,MAAM,EAAE,GAAgB;oBACvB,MAAM,EAAE,uCAAuC;oBAC/C,KAAK,EAAE,GAAG;iBACV,CAAC;gBACF,IAAI,MAAM;oBAAE,EAAE,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;gBAEjC,MAAM,QAAQ,GAAG,MAAM,0BAAU,CAAC,WAAW,CAAC;oBAC7C,MAAM,EAAE,0BAAU,CAAC,GAAG;oBACtB,GAAG,EAAE,oCAAoC,SAAS,CAAC,iBAAiB,gBAAgB;oBACpF,cAAc,EAAE;wBACf,IAAI,EAAE,kCAAkB,CAAC,YAAY;wBACrC,KAAK,EAAE,SAAS,CAAC,YAAY;qBAC7B;oBACD,WAAW,EAAE,EAAE;iBACf,CAAC,CAAC;gBAEH,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC9C,OAAO,CAAC,IAAI,CAAC;wBACZ,KAAK,EAAE,GAAG,WAAW,CAAC,aAAuB,MAC5C,WAAW,CAAC,oBACb,EAAE;wBACF,KAAK,EAAE,WAAW,CAAC,EAAY;qBAC/B,CAAC,CAAC;gBACJ,CAAC;gBAED,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBAC/B,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjE,CAAC;qBAAM,CAAC;oBACP,OAAO,GAAG,KAAK,CAAC;gBACjB,CAAC;YACF,CAAC,QAAQ,OAAO,EAAE;YAElB,OAAO;gBACN,QAAQ,EAAE,KAAK;gBACf,OAAO;aACP,CAAC;QACH,CAAC,CAAA;KACD,CAAC;IACF,mBAAmB,EAAE,2BAAQ,CAAC,QAAQ,CAAC;QACtC,WAAW,EAAE,qBAAqB;QAClC,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,mBAAY;QAClB,OAAO,EAAE,KAAiB,EAAE,oDAAZ,EAAE,IAAI,EAAE;YACvB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACX,OAAO;oBACN,WAAW,EAAE,8BAA8B;oBAC3C,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE,EAAE;iBACX,CAAC;YACH,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;YAE7B,MAAM,OAAO,GAA6B,EAAE,CAAC;YAE7C,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,IAAI,MAAM,CAAC;YAEX,GAAG,CAAC;gBACH,MAAM,EAAE,GAAgB;oBACvB,MAAM,EAAE,kBAAkB;oBAC1B,KAAK,EAAE,GAAG;iBACV,CAAC;gBACF,IAAI,MAAM;oBAAE,EAAE,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;gBAEjC,MAAM,QAAQ,GAAG,MAAM,0BAAU,CAAC,WAAW,CAAC;oBAC7C,MAAM,EAAE,0BAAU,CAAC,GAAG;oBACtB,GAAG,EAAE,oCAAoC,SAAS,CAAC,iBAAiB,oBAAoB;oBACxF,cAAc,EAAE;wBACf,IAAI,EAAE,kCAAkB,CAAC,YAAY;wBACrC,KAAK,EAAE,SAAS,CAAC,YAAY;qBAC7B;oBACD,WAAW,EAAE,EAAE;iBACf,CAAC,CAAC;gBAEH,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC3C,OAAO,CAAC,IAAI,CAAC;wBACZ,KAAK,EAAE,GAAG,QAAQ,CAAC,IAAc,KAAK,QAAQ,CAAC,QAAkB,GAAG;wBACpE,KAAK,EAAE,QAAQ,CAAC,EAAY;qBAC5B,CAAC,CAAC;gBACJ,CAAC;gBAED,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;oBAC/B,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjE,CAAC;qBAAM,CAAC;oBACP,OAAO,GAAG,KAAK,CAAC;gBACjB,CAAC;YACF,CAAC,QAAQ,OAAO,EAAE;YAElB,OAAO;gBACN,QAAQ,EAAE,KAAK;gBACf,OAAO;aACP,CAAC;QACH,CAAC,CAAA;KACD,CAAC;IAEF,uBAAuB,EAAE,2BAAQ,CAAC,iBAAiB,CAAC;QACnD,WAAW,EAAE,iBAAiB;QAC9B,UAAU,EAAE,CAAC,qBAAqB,CAAC;QACnC,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,mBAAY;QACjB,KAAK,EAAE,KAAsC,EAAE,oDAAjC,EAAE,IAAI,EAAE,mBAAmB,EAAE;;YAC3C,IAAI,CAAC,IAAI;gBAAE,OAAO,EAAE,CAAC;YACrB,IAAI,CAAC,mBAAmB;gBAAE,OAAO,EAAE,CAAC;YAEpC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;YAC7B,MAAM,UAAU,GAAG,mBAAwC,CAAC;YAE5D,MAAM,QAAQ,GAAG,MAAM,0BAAU,CAAC,WAAW,CAAC;gBAC7C,GAAG,EAAE,oCAAoC,UAAU,EAAE;gBACrD,MAAM,EAAE,0BAAU,CAAC,GAAG;gBACtB,cAAc,EAAE;oBACf,IAAI,EAAE,kCAAkB,CAAC,YAAY;oBACrC,KAAK,EAAE,SAAS,CAAC,YAAY;iBAC7B;aACD,CAAC,CAAC;YAEH,MAAM,mBAAmB,GAAsB,EAAE,CAAC;YAClD,MAAM,qBAAqB,GAAsB,EAAE,CAAC;YACpD,MAAM,qBAAqB,GAAsB,EAAE,CAAC;YAEpD,KAAK,MAAM,SAAS,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClD,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC/B,4GAA4G;oBAC5G,mBAAmB,CAAC,eAAe,CAAC,GAAG,2BAAQ,CAAC,QAAQ,CAAC;wBACxD,KAAK,EAAE;;QAEL,SAAS,CAAC,IAAI,EAAE;qBAClB,CAAC,CAAC;oBAEH,MAAM,iBAAiB,GAAG,MAAA,MAAA,SAAS,CAAC,IAAI,0CAAE,KAAK,CAAC,YAAY,CAAC,mCAAI,EAAE,CAAC;oBAEpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBACnD,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,2BAAQ,CAAC,SAAS,CAAC;4BAC7D,WAAW,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI;4BAChC,QAAQ,EAAE,KAAK;yBACf,CAAC,CAAC;oBACJ,CAAC;gBACF,CAAC;qBAAM,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;oBACvE,kHAAkH;oBAClH,qBAAqB,CAAC,iBAAiB,CAAC,GAAG,2BAAQ,CAAC,QAAQ,CAAC;wBAC5D,KAAK,EAAE;;QAEL,SAAS,CAAC,IAAI,EAAE;qBAClB,CAAC,CAAC;oBAEH,MAAM,mBAAmB,GAAG,MAAA,MAAA,SAAS,CAAC,IAAI,0CAAE,KAAK,CAAC,YAAY,CAAC,mCAAI,EAAE,CAAC;oBAEtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;wBACrD,qBAAqB,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,2BAAQ,CAAC,SAAS,CAAC;4BACjE,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,IAAI;4BAClC,QAAQ,EAAE,KAAK;yBACf,CAAC,CAAC;oBACJ,CAAC;gBACF,CAAC;qBAAM,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;oBACzC,iHAAiH;oBACjH,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;wBACxC,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;4BAC3B,MAAM,sBAAsB,GAAG,MAAA,MAAA,MAAM,CAAC,GAAG,0CAAE,KAAK,CAAC,YAAY,CAAC,mCAAI,EAAE,CAAC;4BAErE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,sBAAsB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gCACxD,qBAAqB,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,2BAAQ,CAAC,SAAS,CAAC;oCACjE,WAAW,EAAE,MAAM,CAAC,IAAI;oCACxB,QAAQ,EAAE,KAAK;iCACf,CAAC,CAAC;4BACJ,CAAC;wBACF,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;YAED,MAAM,cAAc,iDAChB,qBAAqB,GACrB,mBAAmB,GACnB,qBAAqB,CACxB,CAAC;YAEF,OAAO,cAAc,CAAC;QACvB,CAAC,CAAA;KACD,CAAC;CACF,CAAC"}

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@divyacon/piece-whatsapp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "DivyaCon whatsapp connector",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "LICENSE.MIT-AP"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "vendor": "node ../scripts/vendor-ap.mjs piece-whatsapp"
+  },
+  "dependencies": {
+    "@agnocon/core-utils": "0.2.0",
+    "@agnocon/piece-types": "0.3.1",
+    "@agnocon/pieces-common": "0.12.8",
+    "@agnocon/pieces-framework": "0.36.0",
+    "tslib": "2.6.2"
+  },
+  "devDependencies": {
+    "@types/node": "20.17.6",
+    "typescript": "5.5.4"
+  },
+  "license": "MIT",
+  "agnocon": {
+    "originVersion": "0.2.6"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "keywords": [
+    "agnocon",
+    "connector"
+  ]
 }

package/src/index.ts

@@ -0,0 +1,30 @@
+import { createPiece, PieceAuth, Property } from '@agnocon/pieces-framework';
+import { sendMessage } from './lib/actions/send-message';
+import { sendMedia } from './lib/actions/send-media';
+import { sendTemplateMessageAction } from './lib/actions/send-from-template';
+import { whatsappAuth } from './lib/auth';
+
+const markdown = `
+To Obtain a Phone Number ID and a Permanent System User Access Token, follow these steps:
+
+1. Go to https://developers.facebook.com/
+2. Make a new app, Select Other for usecase.
+3. Choose Business as the type of app.
+4. Add new Product -> WhatsApp.
+5. Navigate to WhatsApp Settings > API Setup.
+6. Copy the Business Account ID.
+7. Login to your [Meta Business Manager](https://business.facebook.com/).
+8. Click on Settings.
+9. Create a new System User with access over the app and copy the access token.
+`;
+
+export const whatsapp = createPiece({
+	displayName: 'WhatsApp Business',
+	description: 'Manage your WhatsApp business account',
+	auth: whatsappAuth,
+	minimumSupportedRelease: '0.30.0',
+	logoUrl: 'https://cdn.activepieces.com/pieces/whatsapp.png',
+	authors: ['LevwTech', 'kishanprmr'],
+	actions: [sendMessage, sendMedia, sendTemplateMessageAction],
+	triggers: [],
+});

package/src/lib/actions/send-from-template.ts

@@ -0,0 +1,108 @@
+import { whatsappAuth } from '../auth';
+import { AuthenticationType, httpClient, HttpMethod } from '@agnocon/pieces-common';
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { commonProps } from '../common/utils';
+
+export const sendTemplateMessageAction = createAction({
+	auth: whatsappAuth,
+	name: 'send-template-message',
+	displayName: 'Send Template Message',
+	description: 'Sends a template message.',
+	audience: 'both',
+	aiMetadata: { description: 'Sends a pre-approved WhatsApp message template to a recipient, filling its header, body, and button placeholders from the supplied fields. Choose this to initiate conversations outside the 24-hour customer service window or for notifications/marketing where a registered template is required; the template must already be approved in the WhatsApp Business account. Requires the sender phone number ID, recipient phone number, and the template ID (its name and language are resolved automatically). Not idempotent — each call delivers a new message.', idempotent: false },
+	props: {
+		phone_number_id: commonProps.phone_number_id,
+		to: Property.ShortText({
+			displayName: 'To',
+			description: 'Recipient phone number.',
+			required: true,
+		}),
+		message_template_id: commonProps.message_template_id,
+		message_template_fields: commonProps.message_template_fields,
+	},
+	async run(context) {
+		const phoneNumberId = context.propsValue.phone_number_id as string;
+		const recipientPhoneNumber = context.propsValue.to as string;
+		const templateId = context.propsValue.message_template_id as string;
+		const templateFields = context.propsValue.message_template_fields;
+
+		// construct components object
+		// https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#components-object
+		const components = [];
+		const headerParameters = [];
+		const bodyParameters = [];
+		const buttonParameters = [];
+
+		for (const [key, value] of Object.entries(templateFields)) {
+			if (key.startsWith('header_')) {
+				headerParameters.push({ type: 'text', text: value });
+			} else if (key.startsWith('body_')) {
+				bodyParameters.push({ type: 'text', text: value });
+			} else if (key.startsWith('button_')) {
+				buttonParameters.push({ type: 'text', text: value });
+			}
+		}
+
+		if (headerParameters.length) {
+			components.push({
+				type: 'header',
+				parameters: headerParameters,
+			});
+		}
+		if (bodyParameters.length) {
+			components.push({
+				type: 'body',
+				parameters: bodyParameters,
+			});
+		}
+		if (buttonParameters.length) {
+			components.push({
+				type: 'button',
+				sub_type: 'url',
+				index: 0,
+				parameters: buttonParameters,
+			});
+		}
+
+		// fetch template language code
+		const templateData = await httpClient.sendRequest({
+			method: HttpMethod.GET,
+			url: `https://graph.facebook.com/v20.0/${templateId}`,
+			authentication: {
+				type: AuthenticationType.BEARER_TOKEN,
+				token: context.auth.props.access_token,
+			},
+			queryParams: {
+				fields: 'id,name,language',
+			},
+		});
+
+		const templateLanguage = templateData.body['language'];
+		const templateName = templateData.body['name'];
+
+		// https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates/#text-based
+		const response = await httpClient.sendRequest({
+			method: HttpMethod.POST,
+			url: `https://graph.facebook.com/v20.0/${phoneNumberId}/messages`,
+			authentication: {
+				type: AuthenticationType.BEARER_TOKEN,
+				token: context.auth.props.access_token,
+			},
+			body: {
+				messaging_product: 'whatsapp',
+				recipient_type: 'individual',
+				to: recipientPhoneNumber,
+				type: 'template',
+				template: {
+					name: templateName,
+					language: {
+						code: templateLanguage,
+					},
+					components,
+				},
+			},
+		});
+
+		return response.body;
+	},
+});

package/src/lib/actions/send-media.ts

@@ -0,0 +1,79 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { httpClient, HttpMethod } from '@agnocon/pieces-common';
+import { whatsappAuth } from '../auth';
+import {
+	supportedMediaTypes,
+	capitalizeFirstLetter,
+	mediaTypeSupportsCaption,
+	commonProps,
+} from '../common/utils';
+
+export const sendMedia = createAction({
+	auth: whatsappAuth,
+	name: 'sendMedia',
+	displayName: 'Send Media',
+	description: 'Send a media message through WhatsApp',
+	audience: 'both',
+	aiMetadata: { description: 'Sends an image, video, audio, document, or sticker to a WhatsApp recipient by referencing the media via a public URL. Choose this when the message payload is a file rather than plain text; captions are supported for media types that allow them and a filename can be set for documents. Requires the sender phone number ID, recipient phone number, media type, and a reachable media URL; subject to WhatsApp messaging-window rules. Not idempotent — each call delivers a new message.', idempotent: false },
+	props: {
+		phone_number_id: commonProps.phone_number_id,
+		to: Property.ShortText({
+			displayName: 'To',
+			description: 'The recipient of the message',
+			required: true,
+		}),
+		type: Property.Dropdown({
+			auth: whatsappAuth,
+			displayName: 'Type',
+			description: 'The type of media to send',
+			required: true,
+			options: async () => {
+				return {
+					options: supportedMediaTypes.map((type) => ({
+						label: capitalizeFirstLetter(type),
+						value: type,
+					})),
+				};
+			},
+			refreshers: [],
+		}),
+		media: Property.ShortText({
+			displayName: 'Media URL',
+			description: 'The URL of the media to send',
+			required: true,
+		}),
+		caption: Property.LongText({
+			displayName: 'Caption',
+			description: 'A caption for the media',
+			required: false,
+		}),
+		filename: Property.LongText({
+			displayName: 'Filename',
+			description: 'Filename of the document to send',
+			required: false,
+		}),
+	},
+	async run(context) {
+		const { to, caption, media, type, filename, phone_number_id } = context.propsValue;
+		const { access_token } = context.auth.props;
+		const body = {
+			messaging_product: 'whatsapp',
+			recipient_type: 'individual',
+			to,
+			type,
+			[type]: {
+				link: media,
+			},
+		};
+		if (caption && mediaTypeSupportsCaption(type)) (body[type] as any).caption = caption;
+		if (filename && type === 'document') (body[type] as any).filename = filename;
+		return await httpClient.sendRequest({
+			method: HttpMethod.POST,
+			url: `https://graph.facebook.com/v17.0/${phone_number_id}/messages`,
+			headers: {
+				Authorization: 'Bearer ' + access_token,
+			},
+			body,
+		});
+	},
+});

package/src/lib/actions/send-message.ts

@@ -0,0 +1,46 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { httpClient, HttpMethod } from '@agnocon/pieces-common';
+import { whatsappAuth } from '../auth';
+import { commonProps } from '../common/utils';
+
+export const sendMessage = createAction({
+	auth: whatsappAuth,
+	name: 'sendMessage',
+	displayName: 'Send Message',
+	description: 'Send a text message through WhatsApp',
+	audience: 'both',
+	aiMetadata: { description: 'Sends a plain text WhatsApp message from a business phone number to a single recipient via the WhatsApp Cloud API. Choose this for free-form text replies or notifications when no media or pre-approved template is needed; for media use Send Media and for marketing/utility templates use Send Template Message. Requires the sender phone number ID and the recipient phone number in international format; outside the 24-hour customer service window only template messages are deliverable. Not idempotent — each call delivers a new message.', idempotent: false },
+	props: {
+		phone_number_id: commonProps.phone_number_id,
+		to: Property.ShortText({
+			displayName: 'To',
+			description: 'The recipient of the message',
+			required: true,
+		}),
+		text: Property.LongText({
+			displayName: 'Message',
+			description: 'The message to send',
+			required: true,
+		}),
+	},
+	async run(context) {
+		const { to, text, phone_number_id } = context.propsValue;
+		const { access_token } = context.auth.props;
+		return await httpClient.sendRequest({
+			method: HttpMethod.POST,
+			url: `https://graph.facebook.com/v17.0/${phone_number_id}/messages`,
+			headers: {
+				Authorization: 'Bearer ' + access_token,
+			},
+			body: {
+				messaging_product: 'whatsapp',
+				recipient_type: 'individual',
+				to,
+				type: 'text',
+				text: {
+					body: text,
+				},
+			},
+		});
+	},
+});

package/src/lib/auth.ts

@@ -0,0 +1,32 @@
+import { PieceAuth, Property } from '@agnocon/pieces-framework';
+
+const markdown = `
+To Obtain a Phone Number ID and a Permanent System User Access Token, follow these steps:
+
+1. Go to https://developers.facebook.com/
+2. Make a new app, Select Other for usecase.
+3. Choose Business as the type of app.
+4. Add new Product -> WhatsApp.
+5. Navigate to WhatsApp Settings > API Setup.
+6. Copy the Business Account ID.
+7. Login to your [Meta Business Manager](https://business.facebook.com/).
+8. Click on Settings.
+9. Create a new System User with access over the app and copy the access token.
+`;
+
+export const whatsappAuth = PieceAuth.CustomAuth({
+	required: true,
+	description: markdown,
+	props: {
+		access_token: PieceAuth.SecretText({
+			displayName: 'System User Access Token',
+			description: 'The system user access token of your WhatsApp business account.',
+			required: true,
+		}),
+		businessAccountId: Property.ShortText({
+			displayName: 'Business Account ID',
+			description: 'The business account ID of your WhatsApp business account.',
+			required: true,
+		}),
+	},
+});