@tarunzyraclavis/zyra-twilio-wrapper 1.0.0

package/types/interface.ts

@@ -0,0 +1,162 @@
+export interface Config {
+    serverUrl: string,
+    identity: string,
+    waitUrl ?: string
+}
+
+export interface TwilioConferenceParticipant {
+  accountSid: string;
+  callSid: string;
+  callSidToCoach: string | null;
+  coaching: boolean;
+  conferenceSid: string;
+  dateCreated: string; // ISO 8601 date string
+  dateUpdated: string; // ISO 8601 date string
+  endConferenceOnExit: boolean;
+  hold: boolean;
+  label: string | null;
+  muted: boolean;
+  queueTime: string | null; // Twilio may return seconds as a string or null
+  startConferenceOnEnter: boolean;
+  status: 'queued' | 'ringing' | 'in-progress' | 'connected' | 'completed' | string;
+  uri: string;
+}
+
+export interface TwilioConference {
+  conferenceSid: string; // Your own wrapper ID
+  conferences: TwilioConferenceDetails;
+}
+
+export interface TwilioConferenceDetails {
+  accountSid: string;
+  apiVersion: string;
+  callSidEndingConference: string | null;
+  dateCreated: string; // ISO 8601 date
+  dateUpdated: string; // ISO 8601 date
+  friendlyName: string;
+  reasonConferenceEnded: string | null;
+  region: string;
+  sid: string; // Conference SID (same as conferenceSid)
+  status: 'init' | 'in-progress' | 'completed' | 'terminated' | string;
+  subresourceUris: {
+    participants: string;
+    recordings: string;
+    [key: string]: string;
+  };
+  uri: string;
+}
+
+export interface TokenRequestPayload {
+    identity: string;
+    ttl: number;
+    incomingAllow: boolean;
+}
+
+export interface TokenResponse {
+  result: {
+    data: {
+      token: string;
+    };
+  };
+}
+
+export interface CallResult {
+  message: string;
+  status: boolean;
+}
+
+export interface HoldCallPayload {
+  callSid: string;
+  conferenceName: string;
+  waitUrl: string;
+}
+
+export interface ResumeCallPayload {
+  callSid: string;
+  conferenceName: string;
+}
+
+export interface HoldPayload {
+  callSid: string;
+  conferenceName: string;
+  waitUrl: string;
+}
+
+export interface AddParticipantPayload {
+  conferenceName: string;
+  newParticipantNo: string;
+}
+
+export interface HoldAndAddResult extends CallResult {
+  holdResponse?: any;
+  addParticipantResponse?: any;
+}
+
+export interface GetConferencePayload {
+  conferenceName: string;
+}
+
+export interface GetConferenceResult extends CallResult {
+  conferenceDetail?: TwilioConference;
+}
+
+export interface GetParticipantsPayload {
+  conferenceSid: string;
+}
+
+export interface GetParticipantsResult extends CallResult {
+  participants?: TwilioConferenceParticipant[];
+}
+
+export interface RemoveParticipantPayload {
+  conferenceSid: string;
+  callSid: string;
+}
+
+export interface RemoveParticipantResult extends CallResult {
+  // Optionally, you can include server response data
+  data?: any;
+}
+
+export type CallResponse<T = void> = 
+  | { success: true; message: string; data: T }
+  | { success: false; error: Error };
+
+
+
+
+
+
+
+
+//   const data = {
+//   Called: '+14159643849',
+//   ToState: 'CA',
+//   DialCallStatus: 'completed',
+//   CallerCountry: 'US',
+//   Direction: 'inbound',
+//   CallerState: '',
+//   ToZip: '94965',
+//   DialCallSid: 'CA825f011a791f34a69f1296ba692feccd',
+//   CallSid: 'CA97818ba8ca7429801a6079c41244f461',
+//   To: '+14159643849',
+//   CallerZip: '',
+//   ToCountry: 'US',
+//   CalledZip: '94965',
+//   ApiVersion: '2010-04-01',
+//   CalledCity: 'SAUSALITO',
+//   CallStatus: 'completed',
+//   From: '+18884359109',
+//   DialBridged: 'true',
+//   AccountSid: 'ACb1589cdb0710cb771f48b3414b62f9d3',
+//   DialCallDuration: '14',
+//   CalledCountry: 'US',
+//   CallerCity: '',
+//   ToCity: 'SAUSALITO',
+//   FromCountry: 'US',
+//   Caller: '+18884359109',
+//   FromCity: '',
+//   CalledState: 'CA',
+//   FromZip: '',
+//   FromState: ''
+// }

package/utils/errorHandler.ts

@@ -0,0 +1,37 @@
+import axios, { AxiosError } from "axios";
+
+/**
+ * Handles errors from Axios requests in a consistent way.
+ * 
+ * @param error - The error thrown by Axios or any other source.
+ * @param onErrorCallback - Optional callback to handle the error externally.
+ * @param contextMessage - Optional custom message to provide context for the error.
+ */
+export function handleAxiosError(
+  error: unknown,
+  onErrorCallback?: (error: Error) => void,
+  contextMessage = "Request failed"
+): void {
+  let finalError: Error;
+
+  if (axios.isAxiosError(error)) {
+    const axiosError = error as AxiosError;
+    const status = axiosError.response?.status ?? "Unknown";
+    const statusText = axiosError.response?.statusText ?? "No status text";
+    const responseData = axiosError.response?.data
+      ? JSON.stringify(axiosError.response.data)
+      : "No response data";
+
+    finalError = new Error(
+      `[AxiosError] ${contextMessage}: ${status} ${statusText} | Response: ${responseData}`
+    );
+  } else if (error instanceof Error) {
+    finalError = new Error(`[Error] ${contextMessage}: ${error.message}`);
+  } else {
+    finalError = new Error(`[Unknown Error] ${contextMessage}: ${String(error)}`);
+  }
+
+  console.error(finalError); // Optional: log for debugging
+  onErrorCallback?.(finalError);
+}
+

package/utils/helper.ts

@@ -0,0 +1,20 @@
+// src/utils/helper.ts
+
+import type { CallResponse } from "../types/interface"; // adjust path if needed
+
+/**
+ * Helper to create success result
+ */
+export function createSuccessResult<T>(message: string, data: T): CallResponse<T> {
+  return { success : true, message : message, data };
+}
+
+/**
+ * Helper to create error result
+ */
+export function createErrorResult<T = void>(error: Error | string): CallResponse<T> {
+  return {
+    success: false,
+    error: error instanceof Error ? error : new Error(error),
+  };
+}