@framers/agentos-ext-voice-plivo 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,98 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+   Copyright (c) 2025 Framers
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

package/dist/PlivoVoiceProvider.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @fileoverview IVoiceCallProvider implementation for Plivo.
+ *
+ * Normalizes Plivo's webhook payloads (form-encoded, like Twilio) into the
+ * {@link NormalizedCallEvent} discriminated union consumed by {@link CallManager}.
+ *
+ * Plivo call statuses and hangup causes are mapped to the common event types:
+ *   - CallStatus 'ringing'                    -> 'call-ringing'
+ *   - CallStatus 'in-progress' / 'answered'   -> 'call-answered'
+ *   - CallStatus 'completed'                  -> 'call-completed'
+ *   - CallStatus 'failed'                     -> 'call-failed'
+ *   - CallStatus 'busy'                       -> 'call-busy'
+ *   - CallStatus 'no-answer'                  -> 'call-no-answer'
+ *   - CallStatus 'cancel'                     -> 'call-hangup-user'
+ *   - HangupCause maps to appropriate terminal state
+ *
+ * @module @framers/agentos-ext-voice-plivo/PlivoVoiceProvider
+ */
+import type { IVoiceCallProvider, InitiateCallInput, InitiateCallResult, HangupCallInput, PlayTtsInput } from '@framers/agentos';
+import type { VoiceProviderName, WebhookContext, WebhookParseResult, WebhookVerificationResult } from '@framers/agentos';
+import { PlivoVoiceService } from './PlivoVoiceService';
+export declare class PlivoVoiceProvider implements IVoiceCallProvider {
+    private readonly service;
+    readonly name: VoiceProviderName;
+    constructor(service: PlivoVoiceService);
+    /**
+     * Verify the authenticity of a Plivo webhook using V3 signature (HMAC-SHA256).
+     *
+     * Plivo sends:
+     *   - `X-Plivo-Signature-V3`: Base64-encoded HMAC-SHA256 signature
+     *   - `X-Plivo-Signature-V3-Nonce`: Random nonce used in signature computation
+     *
+     * The signature is computed as: HMAC-SHA256(authToken, requestUrl + nonce).
+     */
+    verifyWebhook(ctx: WebhookContext): WebhookVerificationResult;
+    /**
+     * Parse a Plivo webhook payload into normalized call events.
+     *
+     * Plivo sends form-encoded POST bodies with fields like CallUUID, CallStatus,
+     * HangupCause, From, To, Direction, Duration, Speech, Digits, etc.
+     */
+    parseWebhookEvent(ctx: WebhookContext): WebhookParseResult;
+    /**
+     * Initiate an outbound call via Plivo.
+     *
+     * For 'notify' mode: generates Plivo XML with <Speak> + <Hangup/> and hosts
+     * it at the answer URL.
+     *
+     * For 'conversation' mode: generates Plivo XML with <Speak> + <GetInput> +
+     * <Redirect> loop and hosts it at the answer URL.
+     *
+     * In both cases, Plivo fetches the answer URL when the callee picks up.
+     * The answer URL should be a publicly accessible endpoint that returns
+     * the pre-generated XML — this is handled by the webhook router in the
+     * hosting application.
+     */
+    initiateCall(input: InitiateCallInput): Promise<InitiateCallResult>;
+    /**
+     * Hang up an active call by its Plivo call UUID.
+     */
+    hangupCall(input: HangupCallInput): Promise<void>;
+    /**
+     * Play TTS speech into an active call via Plivo's Speak API.
+     */
+    playTts(input: PlayTtsInput): Promise<void>;
+    /**
+     * Extract a header value from the headers map (case-insensitive).
+     */
+    private getHeader;
+    /**
+     * Parse the webhook body from form-encoded or JSON format.
+     * Plivo sends form-encoded data by default (like Twilio).
+     */
+    private parseBody;
+    /**
+     * Get the auth token from the service config.
+     * Used for signature verification.
+     */
+    private getAuthToken;
+}
+/**
+ * Factory to create a PlivoVoiceProvider with the auth token accessible
+ * for webhook verification.
+ */
+export declare function createPlivoVoiceProvider(service: PlivoVoiceService, authToken: string): PlivoVoiceProvider;
+//# sourceMappingURL=PlivoVoiceProvider.d.ts.map

package/dist/PlivoVoiceProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlivoVoiceProvider.d.ts","sourceRoot":"","sources":["../src/PlivoVoiceProvider.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,YAAY,EACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAEV,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAqHxD,qBAAa,kBAAmB,YAAW,kBAAkB;IAG/C,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAW;gBAEd,OAAO,EAAE,iBAAiB;IAIvD;;;;;;;;OAQG;IACH,aAAa,CAAC,GAAG,EAAE,cAAc,GAAG,yBAAyB;IA6B7D;;;;;OAKG;IACH,iBAAiB,CAAC,GAAG,EAAE,cAAc,GAAG,kBAAkB;IA+D1D;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA2CzE;;OAEG;IACG,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;OAEG;IACH,OAAO,CAAC,SAAS;IAcjB;;;OAGG;IACH,OAAO,CAAC,SAAS;IAwBjB;;;OAGG;IACH,OAAO,CAAC,YAAY;CAOrB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,iBAAiB,EAC1B,SAAS,EAAE,MAAM,GAChB,kBAAkB,CAIpB"}

package/dist/PlivoVoiceProvider.js

@@ -0,0 +1,306 @@
+"use strict";
+// @ts-nocheck
+/**
+ * @fileoverview IVoiceCallProvider implementation for Plivo.
+ *
+ * Normalizes Plivo's webhook payloads (form-encoded, like Twilio) into the
+ * {@link NormalizedCallEvent} discriminated union consumed by {@link CallManager}.
+ *
+ * Plivo call statuses and hangup causes are mapped to the common event types:
+ *   - CallStatus 'ringing'                    -> 'call-ringing'
+ *   - CallStatus 'in-progress' / 'answered'   -> 'call-answered'
+ *   - CallStatus 'completed'                  -> 'call-completed'
+ *   - CallStatus 'failed'                     -> 'call-failed'
+ *   - CallStatus 'busy'                       -> 'call-busy'
+ *   - CallStatus 'no-answer'                  -> 'call-no-answer'
+ *   - CallStatus 'cancel'                     -> 'call-hangup-user'
+ *   - HangupCause maps to appropriate terminal state
+ *
+ * @module @framers/agentos-ext-voice-plivo/PlivoVoiceProvider
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlivoVoiceProvider = void 0;
+exports.createPlivoVoiceProvider = createPlivoVoiceProvider;
+const node_crypto_1 = require("node:crypto");
+// ============================================================================
+// Status Mapping
+// ============================================================================
+/**
+ * Map Plivo CallStatus values to NormalizedCallEvent kinds.
+ */
+function mapCallStatus(status, hangupCause) {
+    switch (status.toLowerCase()) {
+        case 'ringing':
+        case 'early':
+            return 'call-ringing';
+        case 'in-progress':
+        case 'answered':
+            return 'call-answered';
+        case 'completed':
+        case 'hangup':
+            // Inspect HangupCause for more specific mapping
+            return mapHangupCause(hangupCause) ?? 'call-completed';
+        case 'failed':
+            return 'call-failed';
+        case 'busy':
+            return 'call-busy';
+        case 'no-answer':
+        case 'timeout':
+            return 'call-no-answer';
+        case 'cancel':
+        case 'canceled':
+            return 'call-hangup-user';
+        default:
+            return null;
+    }
+}
+/**
+ * Map Plivo HangupCause values to more specific event kinds.
+ * Plivo uses SIP-style hangup cause strings.
+ *
+ * @see https://www.plivo.com/docs/voice/api/call/#hangup-causes
+ */
+function mapHangupCause(cause) {
+    if (!cause)
+        return null;
+    switch (cause.toUpperCase()) {
+        case 'NORMAL_CLEARING':
+        case 'NORMAL_CALL_CLEARING':
+            return 'call-completed';
+        case 'ORIGINATOR_CANCEL':
+        case 'NORMAL_UNSPECIFIED':
+            return 'call-hangup-user';
+        case 'USER_BUSY':
+            return 'call-busy';
+        case 'NO_ANSWER':
+        case 'NO_USER_RESPONSE':
+        case 'ALLOTTED_TIMEOUT':
+            return 'call-no-answer';
+        case 'CALL_REJECTED':
+        case 'UNALLOCATED_NUMBER':
+        case 'NUMBER_CHANGED':
+        case 'INVALID_NUMBER_FORMAT':
+            return 'call-failed';
+        case 'DESTINATION_OUT_OF_ORDER':
+        case 'NETWORK_OUT_OF_ORDER':
+        case 'SERVICE_UNAVAILABLE':
+        case 'RECOVERY_ON_TIMER_EXPIRE':
+            return 'call-error';
+        default:
+            return null;
+    }
+}
+// ============================================================================
+// Provider Implementation
+// ============================================================================
+class PlivoVoiceProvider {
+    constructor(service) {
+        this.service = service;
+        this.name = 'plivo';
+    }
+    // ── Webhook Processing ──
+    /**
+     * Verify the authenticity of a Plivo webhook using V3 signature (HMAC-SHA256).
+     *
+     * Plivo sends:
+     *   - `X-Plivo-Signature-V3`: Base64-encoded HMAC-SHA256 signature
+     *   - `X-Plivo-Signature-V3-Nonce`: Random nonce used in signature computation
+     *
+     * The signature is computed as: HMAC-SHA256(authToken, requestUrl + nonce).
+     */
+    verifyWebhook(ctx) {
+        const signature = this.getHeader(ctx.headers, 'x-plivo-signature-v3');
+        const nonce = this.getHeader(ctx.headers, 'x-plivo-signature-v3-nonce');
+        if (!signature || !nonce) {
+            // Plivo also supports V2 (legacy) signatures — for V3-only enforcement,
+            // missing headers indicate an unsigned or tampered request.
+            // In development, allow unsigned webhooks to simplify testing.
+            if (process.env.NODE_ENV === 'development' || process.env.PLIVO_SKIP_SIGNATURE === 'true') {
+                return { valid: true };
+            }
+            return {
+                valid: false,
+                error: 'Missing X-Plivo-Signature-V3 or X-Plivo-Signature-V3-Nonce header',
+            };
+        }
+        const valid = this.service.verifySignature(ctx.url, nonce, signature, this.getAuthToken());
+        return valid
+            ? { valid: true }
+            : { valid: false, error: 'Plivo HMAC-SHA256 signature mismatch' };
+    }
+    /**
+     * Parse a Plivo webhook payload into normalized call events.
+     *
+     * Plivo sends form-encoded POST bodies with fields like CallUUID, CallStatus,
+     * HangupCause, From, To, Direction, Duration, Speech, Digits, etc.
+     */
+    parseWebhookEvent(ctx) {
+        const body = this.parseBody(ctx);
+        const events = [];
+        const callUuid = body.CallUUID;
+        if (!callUuid) {
+            return { events, rawData: body };
+        }
+        const timestamp = Date.now();
+        // Handle speech recognition results from GetInput
+        if (body.Speech) {
+            events.push({
+                kind: 'transcript',
+                eventId: `plivo-speech-${callUuid}-${timestamp}`,
+                providerCallId: callUuid,
+                timestamp,
+                text: body.Speech,
+                isFinal: true,
+            });
+        }
+        // Handle call status events
+        if (body.CallStatus) {
+            const kind = mapCallStatus(body.CallStatus, body.HangupCause);
+            if (kind) {
+                const eventId = `plivo-${kind}-${callUuid}-${(0, node_crypto_1.randomUUID)().slice(0, 8)}`;
+                const baseEvent = { eventId, providerCallId: callUuid, timestamp };
+                switch (kind) {
+                    case 'call-completed': {
+                        const duration = body.Duration ? parseInt(body.Duration, 10) : undefined;
+                        events.push({ ...baseEvent, kind: 'call-completed', duration });
+                        break;
+                    }
+                    case 'call-failed':
+                        events.push({
+                            ...baseEvent,
+                            kind: 'call-failed',
+                            reason: body.HangupCause ?? 'Unknown failure',
+                        });
+                        break;
+                    case 'call-error':
+                        events.push({
+                            ...baseEvent,
+                            kind: 'call-error',
+                            error: body.HangupCause ?? 'Unknown error',
+                        });
+                        break;
+                    default:
+                        // Simple event kinds with no extra fields
+                        events.push({ ...baseEvent, kind });
+                        break;
+                }
+            }
+        }
+        return { events, rawData: body };
+    }
+    // ── Call Control ──
+    /**
+     * Initiate an outbound call via Plivo.
+     *
+     * For 'notify' mode: generates Plivo XML with <Speak> + <Hangup/> and hosts
+     * it at the answer URL.
+     *
+     * For 'conversation' mode: generates Plivo XML with <Speak> + <GetInput> +
+     * <Redirect> loop and hosts it at the answer URL.
+     *
+     * In both cases, Plivo fetches the answer URL when the callee picks up.
+     * The answer URL should be a publicly accessible endpoint that returns
+     * the pre-generated XML — this is handled by the webhook router in the
+     * hosting application.
+     */
+    async initiateCall(input) {
+        try {
+            // Generate the appropriate XML response for the answer URL
+            let _answerXml;
+            if (input.mode === 'notify') {
+                _answerXml = this.service.generateNotifyXml(input.message ?? 'Hello, this is an automated message.', input.notifyVoice);
+            }
+            else {
+                _answerXml = this.service.generateConversationXml(input.webhookUrl, input.message, input.notifyVoice);
+            }
+            // Store the XML so the webhook endpoint can serve it.
+            // The answer URL is the webhook URL; when Plivo GETs/POSTs it,
+            // the application should return this XML.
+            // The callId is passed as a query parameter for routing.
+            const answerUrl = `${input.webhookUrl}?callId=${encodeURIComponent(input.callId)}&mode=${input.mode}`;
+            const response = await this.service.createCall(input.fromNumber, input.toNumber, answerUrl, 'POST');
+            return {
+                providerCallId: response.requestUuid,
+                success: true,
+            };
+        }
+        catch (err) {
+            return {
+                providerCallId: '',
+                success: false,
+                error: err instanceof Error ? err.message : String(err),
+            };
+        }
+    }
+    /**
+     * Hang up an active call by its Plivo call UUID.
+     */
+    async hangupCall(input) {
+        await this.service.hangupCall(input.providerCallId);
+    }
+    /**
+     * Play TTS speech into an active call via Plivo's Speak API.
+     */
+    async playTts(input) {
+        await this.service.speakText(input.providerCallId, input.text, input.voice);
+    }
+    // ── Internal Helpers ──
+    /**
+     * Extract a header value from the headers map (case-insensitive).
+     */
+    getHeader(headers, name) {
+        // Headers may be stored with varying casing
+        const key = Object.keys(headers).find((k) => k.toLowerCase() === name.toLowerCase());
+        if (!key)
+            return undefined;
+        const value = headers[key];
+        return Array.isArray(value) ? value[0] : value;
+    }
+    /**
+     * Parse the webhook body from form-encoded or JSON format.
+     * Plivo sends form-encoded data by default (like Twilio).
+     */
+    parseBody(ctx) {
+        // Prefer pre-parsed body if available
+        if (ctx.parsedBody) {
+            return ctx.parsedBody;
+        }
+        const bodyStr = typeof ctx.body === 'string' ? ctx.body : ctx.body.toString('utf-8');
+        // Try JSON first
+        try {
+            return JSON.parse(bodyStr);
+        }
+        catch {
+            // Fall through to form-encoded parsing
+        }
+        // Parse application/x-www-form-urlencoded
+        const params = new URLSearchParams(bodyStr);
+        const result = {};
+        for (const [key, value] of params.entries()) {
+            result[key] = value;
+        }
+        return result;
+    }
+    /**
+     * Get the auth token from the service config.
+     * Used for signature verification.
+     */
+    getAuthToken() {
+        // Access the service's config through a known property.
+        // The service exposes verifySignature which needs the token,
+        // but we also need it here for the provider-level verify.
+        // We store it during construction via the factory.
+        return this._authToken ?? '';
+    }
+}
+exports.PlivoVoiceProvider = PlivoVoiceProvider;
+/**
+ * Factory to create a PlivoVoiceProvider with the auth token accessible
+ * for webhook verification.
+ */
+function createPlivoVoiceProvider(service, authToken) {
+    const provider = new PlivoVoiceProvider(service);
+    provider._authToken = authToken;
+    return provider;
+}
+//# sourceMappingURL=PlivoVoiceProvider.js.map

package/dist/PlivoVoiceProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlivoVoiceProvider.js","sourceRoot":"","sources":["../src/PlivoVoiceProvider.ts"],"names":[],"mappings":";AAAA,cAAc;AACd;;;;;;;;;;;;;;;;;GAiBG;;;AA+XH,4DAOC;AApYD,6CAAyC;AAyCzC,+EAA+E;AAC/E,iBAAiB;AACjB,+EAA+E;AAE/E;;GAEG;AACH,SAAS,aAAa,CACpB,MAAc,EACd,WAAoB;IAEpB,QAAQ,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7B,KAAK,SAAS,CAAC;QACf,KAAK,OAAO;YACV,OAAO,cAAc,CAAC;QAExB,KAAK,aAAa,CAAC;QACnB,KAAK,UAAU;YACb,OAAO,eAAe,CAAC;QAEzB,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ;YACX,gDAAgD;YAChD,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,gBAAgB,CAAC;QAEzD,KAAK,QAAQ;YACX,OAAO,aAAa,CAAC;QAEvB,KAAK,MAAM;YACT,OAAO,WAAW,CAAC;QAErB,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS;YACZ,OAAO,gBAAgB,CAAC;QAE1B,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU;YACb,OAAO,kBAAkB,CAAC;QAE5B;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IAExB,QAAQ,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QAC5B,KAAK,iBAAiB,CAAC;QACvB,KAAK,sBAAsB;YACzB,OAAO,gBAAgB,CAAC;QAE1B,KAAK,mBAAmB,CAAC;QACzB,KAAK,oBAAoB;YACvB,OAAO,kBAAkB,CAAC;QAE5B,KAAK,WAAW;YACd,OAAO,WAAW,CAAC;QAErB,KAAK,WAAW,CAAC;QACjB,KAAK,kBAAkB,CAAC;QACxB,KAAK,kBAAkB;YACrB,OAAO,gBAAgB,CAAC;QAE1B,KAAK,eAAe,CAAC;QACrB,KAAK,oBAAoB,CAAC;QAC1B,KAAK,gBAAgB,CAAC;QACtB,KAAK,uBAAuB;YAC1B,OAAO,aAAa,CAAC;QAEvB,KAAK,0BAA0B,CAAC;QAChC,KAAK,sBAAsB,CAAC;QAC5B,KAAK,qBAAqB,CAAC;QAC3B,KAAK,0BAA0B;YAC7B,OAAO,YAAY,CAAC;QAEtB;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,0BAA0B;AAC1B,+EAA+E;AAE/E,MAAa,kBAAkB;IAG7B,YAA6B,OAA0B;QAA1B,YAAO,GAAP,OAAO,CAAmB;QAF9C,SAAI,GAAsB,OAAO,CAAC;IAEe,CAAC;IAE3D,2BAA2B;IAE3B;;;;;;;;OAQG;IACH,aAAa,CAAC,GAAmB;QAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;QACtE,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;QAExE,IAAI,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,wEAAwE;YACxE,4DAA4D;YAC5D,+DAA+D;YAC/D,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAoB,KAAK,MAAM,EAAE,CAAC;gBAC1F,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACzB,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,KAAK,EAAE,mEAAmE;aAC3E,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CACxC,GAAG,CAAC,GAAG,EACP,KAAK,EACL,SAAS,EACT,IAAI,CAAC,YAAY,EAAE,CACpB,CAAC;QAEF,OAAO,KAAK;YACV,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE;YACjB,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,sCAAsC,EAAE,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,GAAmB;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,MAAM,GAA0B,EAAE,CAAC;QAEzC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QACnC,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,kDAAkD;QAClD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,gBAAgB,QAAQ,IAAI,SAAS,EAAE;gBAChD,cAAc,EAAE,QAAQ;gBACxB,SAAS;gBACT,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;QACL,CAAC;QAED,4BAA4B;QAC5B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,OAAO,GAAG,SAAS,IAAI,IAAI,QAAQ,IAAI,IAAA,wBAAU,GAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACxE,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;gBAEnE,QAAQ,IAAI,EAAE,CAAC;oBACb,KAAK,gBAAgB,CAAC,CAAC,CAAC;wBACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;wBACzE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,CAAC;wBAChE,MAAM;oBACR,CAAC;oBACD,KAAK,aAAa;wBAChB,MAAM,CAAC,IAAI,CAAC;4BACV,GAAG,SAAS;4BACZ,IAAI,EAAE,aAAa;4BACnB,MAAM,EAAE,IAAI,CAAC,WAAW,IAAI,iBAAiB;yBAC9C,CAAC,CAAC;wBACH,MAAM;oBACR,KAAK,YAAY;wBACf,MAAM,CAAC,IAAI,CAAC;4BACV,GAAG,SAAS;4BACZ,IAAI,EAAE,YAAY;4BAClB,KAAK,EAAE,IAAI,CAAC,WAAW,IAAI,eAAe;yBAC3C,CAAC,CAAC;wBACH,MAAM;oBACR;wBACE,0CAA0C;wBAC1C,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,SAAS,EAAE,IAAI,EAAyB,CAAC,CAAC;wBAC3D,MAAM;gBACV,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,qBAAqB;IAErB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,YAAY,CAAC,KAAwB;QACzC,IAAI,CAAC;YACH,2DAA2D;YAC3D,IAAI,UAAkB,CAAC;YACvB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5B,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CACzC,KAAK,CAAC,OAAO,IAAI,sCAAsC,EACvD,KAAK,CAAC,WAAW,CAClB,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAC/C,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,WAAW,CAClB,CAAC;YACJ,CAAC;YAED,sDAAsD;YACtD,+DAA+D;YAC/D,0CAA0C;YAC1C,yDAAyD;YACzD,MAAM,SAAS,GAAG,GAAG,KAAK,CAAC,UAAU,WAAW,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,KAAK,CAAC,IAAI,EAAE,CAAC;YAEtG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5C,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,QAAQ,EACd,SAAS,EACT,MAAM,CACP,CAAC;YAEF,OAAO;gBACL,cAAc,EAAE,QAAQ,CAAC,WAAW;gBACpC,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO;gBACL,cAAc,EAAE,EAAE;gBAClB,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACxD,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,KAAsB;QACrC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,KAAmB;QAC/B,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9E,CAAC;IAED,yBAAyB;IAEzB;;OAEG;IACK,SAAS,CACf,OAAsD,EACtD,IAAY;QAEZ,4CAA4C;QAC5C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAC9C,CAAC;QACF,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAC;QAE3B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACjD,CAAC;IAED;;;OAGG;IACK,SAAS,CAAC,GAAmB;QACnC,sCAAsC;QACtC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC,UAAyC,CAAC;QACvD,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAErF,iBAAiB;QACjB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAqB,CAAC;QACjD,CAAC;QAAC,MAAM,CAAC;YACP,uCAAuC;QACzC,CAAC;QAED,0CAA0C;QAC1C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;QACD,OAAO,MAAqC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACK,YAAY;QAClB,wDAAwD;QACxD,6DAA6D;QAC7D,0DAA0D;QAC1D,mDAAmD;QACnD,OAAQ,IAAY,CAAC,UAAU,IAAI,EAAE,CAAC;IACxC,CAAC;CACF;AAnPD,gDAmPC;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CACtC,OAA0B,EAC1B,SAAiB;IAEjB,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAChD,QAAgB,CAAC,UAAU,GAAG,SAAS,CAAC;IACzC,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/PlivoVoiceService.d.ts

@@ -0,0 +1,118 @@
+/**
+ * @fileoverview Wrapper around the Plivo Voice API SDK.
+ *
+ * Handles Plivo client lifecycle, call control operations (create, hangup,
+ * speak), Plivo XML generation for notify/conversation modes, and webhook
+ * signature verification.
+ *
+ * @module @framers/agentos-ext-voice-plivo/PlivoVoiceService
+ */
+export interface PlivoServiceConfig {
+    /** Plivo Auth ID. */
+    authId: string;
+    /** Plivo Auth Token. */
+    authToken: string;
+    /** Default outbound caller ID (E.164). */
+    fromNumber: string;
+}
+export declare class PlivoVoiceService {
+    private client;
+    private readonly config;
+    constructor(config: PlivoServiceConfig);
+    /**
+     * Initialize the Plivo SDK client via dynamic import.
+     * Plivo's Node SDK is CommonJS; dynamic import avoids bundling issues.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Gracefully shut down the service and release resources.
+     */
+    shutdown(): Promise<void>;
+    /** Whether the service has been initialized. */
+    get isInitialized(): boolean;
+    /**
+     * Create an outbound call via the Plivo Calls API.
+     *
+     * @param from   - E.164 caller ID.
+     * @param to     - E.164 destination number.
+     * @param answerUrl    - URL Plivo fetches when the call is answered.
+     * @param answerMethod - HTTP method for the answer URL (GET or POST).
+     * @returns The Plivo API response containing `requestUuid` (call UUID).
+     */
+    createCall(from: string, to: string, answerUrl: string, answerMethod?: 'GET' | 'POST'): Promise<{
+        requestUuid: string;
+        apiId: string;
+        message: string;
+    }>;
+    /**
+     * Hang up an active call by its UUID.
+     *
+     * @param callUuid - The Plivo call UUID to terminate.
+     */
+    hangupCall(callUuid: string): Promise<void>;
+    /**
+     * Play TTS speech into an active call via the Plivo Speak API.
+     *
+     * @param callUuid - The Plivo call UUID.
+     * @param text     - Text to speak.
+     * @param voice    - Plivo voice name (default: Polly.Joanna).
+     */
+    speakText(callUuid: string, text: string, voice?: string): Promise<void>;
+    /**
+     * Generate Plivo XML for "notify" mode: speak a message then hang up.
+     *
+     * @param message - The message text to speak.
+     * @param voice   - Plivo TTS voice (default: Polly.Joanna).
+     * @returns Plivo XML string.
+     *
+     * @example
+     * ```xml
+     * <?xml version="1.0" encoding="UTF-8"?>
+     * <Response>
+     *   <Speak voice="Polly.Joanna">Hello, your appointment is confirmed.</Speak>
+     *   <Hangup/>
+     * </Response>
+     * ```
+     */
+    generateNotifyXml(message: string, voice?: string): string;
+    /**
+     * Generate Plivo XML for "conversation" mode: speak a greeting,
+     * gather DTMF/speech input, then redirect back to the webhook URL
+     * for a multi-turn loop.
+     *
+     * @param webhookUrl - URL to redirect to after gathering input.
+     * @param greeting   - Optional greeting to speak before gathering.
+     * @param voice      - Plivo TTS voice (default: Polly.Joanna).
+     * @returns Plivo XML string.
+     *
+     * @example
+     * ```xml
+     * <?xml version="1.0" encoding="UTF-8"?>
+     * <Response>
+     *   <Speak voice="Polly.Joanna">Hello, how can I help you?</Speak>
+     *   <GetInput action="https://example.com/voice/webhook/plivo"
+     *             method="POST" inputType="speech" executionTimeout="30">
+     *     <Speak voice="Polly.Joanna">I am listening.</Speak>
+     *   </GetInput>
+     *   <Redirect method="POST">https://example.com/voice/webhook/plivo</Redirect>
+     * </Response>
+     * ```
+     */
+    generateConversationXml(webhookUrl: string, greeting?: string, voice?: string): string;
+    /**
+     * Verify a Plivo webhook signature (V3 — HMAC-SHA256).
+     *
+     * Plivo V3 signatures are computed as:
+     *   HMAC-SHA256(authToken, requestUrl + nonce)
+     * and sent via the `X-Plivo-Signature-V3` header.
+     *
+     * @param url       - The full request URL (including query string).
+     * @param nonce     - The nonce from `X-Plivo-Signature-V3-Nonce` header.
+     * @param signature - The signature from `X-Plivo-Signature-V3` header.
+     * @param authToken - The Plivo auth token used as the HMAC key.
+     * @returns Whether the signature is valid.
+     */
+    verifySignature(url: string, nonce: string, signature: string, authToken: string): boolean;
+    private ensureInitialized;
+}
+//# sourceMappingURL=PlivoVoiceService.d.ts.map

package/dist/PlivoVoiceService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlivoVoiceService.d.ts","sourceRoot":"","sources":["../src/PlivoVoiceService.ts"],"names":[],"mappings":"AACA;;;;;;;;GAQG;AASH,MAAM,WAAW,kBAAkB;IACjC,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAC;CACpB;AASD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;gBAEhC,MAAM,EAAE,kBAAkB;IAMtC;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBjC;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,gDAAgD;IAChD,IAAI,aAAa,IAAI,OAAO,CAE3B;IAID;;;;;;;;OAQG;IACG,UAAU,CACd,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,KAAK,GAAG,MAAe,GACpC,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAcnE;;;;OAIG;IACG,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjD;;;;;;OAMG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9E;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM;IAY1D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,uBAAuB,CACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,MAAM;IAyBT;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO;IAiBV,OAAO,CAAC,iBAAiB;CAO1B"}