@absolutejs/voice 0.0.22-beta.76 → 0.0.22-beta.77

package/dist/index.d.ts

@@ -81,7 +81,9 @@ export type { VoiceS3ReviewStoreClient, VoiceS3ReviewStoreFile, VoiceS3ReviewSto
 export type { VoiceSQLiteRuntimeStorage, VoiceSQLiteStoreOptions } from './sqliteStore';
 export type { StoredVoiceIntegrationEvent, StoredVoiceExternalObjectMap, StoredVoiceOpsTask, VoiceExternalObjectMap, VoiceExternalObjectMapStore, VoiceOpsTaskAgeBucket, VoiceOpsTaskAnalyticsOptions, VoiceOpsTaskAnalyticsSummary, VoiceOpsTaskAssignmentRule, VoiceOpsTaskAssignmentRuleCondition, VoiceOpsTaskAssignmentRules, VoiceOpsTaskAssigneeAnalytics, VoiceOpsDispositionTaskPolicies, VoiceOpsSLABreachPolicy, VoiceIntegrationDeliveryStatus, VoiceIntegrationEvent, VoiceIntegrationEventStore, VoiceIntegrationSinkDelivery, VoiceIntegrationEventType, VoiceIntegrationWebhookConfig, VoiceOpsTask, VoiceOpsTaskHistoryEntry, VoiceOpsTaskKind, VoiceOpsTaskPolicy, VoiceOpsTaskPriority, VoiceOpsTaskStatus, VoiceOpsTaskStore, VoiceOpsTaskSummary, VoiceOpsTaskWorkerAnalytics } from './ops';
 export { createTwilioMediaStreamBridge, createTwilioVoiceRoutes, createTwilioVoiceResponse, decodeTwilioMulawBase64, encodeTwilioMulawBase64, transcodePCMToTwilioOutboundPayload, transcodeTwilioInboundPayloadToPCM16 } from './telephony/twilio';
+export { evaluateVoiceTelephonyContract } from './telephony/contract';
 export type { TwilioInboundMessage, TwilioMediaStreamBridge, TwilioMediaStreamBridgeOptions, TwilioMediaStreamSocket, TwilioOutboundClearMessage, TwilioOutboundMarkMessage, TwilioOutboundMediaMessage, TwilioOutboundMessage, TwilioVoiceRouteParameters, TwilioVoiceResponseOptions, TwilioVoiceSmokeCheck, TwilioVoiceSmokeOptions, TwilioVoiceSmokeReport, TwilioVoiceSetupOptions, TwilioVoiceSetupStatus, TwilioVoiceRoutesOptions } from './telephony/twilio';
+export type { VoiceTelephonyContractIssue, VoiceTelephonyContractOptions, VoiceTelephonyContractReport, VoiceTelephonyContractRequirement, VoiceTelephonyProvider, VoiceTelephonySetupStatus, VoiceTelephonySmokeCheck, VoiceTelephonySmokeReport } from './telephony/contract';
 export { shapeTelephonyAssistantText } from './telephony/response';
 export type { TelephonyResponseShapeMode, TelephonyResponseShapeOptions } from './telephony/response';
 export * from './types';

package/dist/index.js

@@ -15904,6 +15904,85 @@ var createTwilioVoiceRoutes = (options) => {
     return report;
   });
 };
+// src/telephony/contract.ts
+var DEFAULT_REQUIREMENTS = [
+  "stream-url",
+  "wss-stream",
+  "webhook-url",
+  "signed-webhook",
+  "smoke-pass"
+];
+var hasFailingSmokeCheck = (smoke) => smoke?.checks.some((check) => check.status === "fail") ?? false;
+var evaluateVoiceTelephonyContract = (input) => {
+  const requirements = input.options?.requirements ?? DEFAULT_REQUIREMENTS;
+  const issues = [];
+  const hasRequirement = (requirement) => requirements.includes(requirement);
+  if (hasRequirement("stream-url") && !input.setup.urls.stream) {
+    issues.push({
+      message: "Missing media stream URL.",
+      requirement: "stream-url",
+      severity: "error"
+    });
+  }
+  if (hasRequirement("wss-stream") && !input.setup.urls.stream.startsWith("wss://")) {
+    issues.push({
+      message: "Media stream URL must use wss://.",
+      requirement: "wss-stream",
+      severity: "error"
+    });
+  }
+  if (hasRequirement("webhook-url") && !input.setup.urls.webhook) {
+    issues.push({
+      message: "Missing carrier webhook URL.",
+      requirement: "webhook-url",
+      severity: "error"
+    });
+  }
+  if (hasRequirement("signed-webhook") && !input.setup.signing.configured) {
+    issues.push({
+      message: "Carrier webhook signature verification is not configured.",
+      requirement: "signed-webhook",
+      severity: "error"
+    });
+  }
+  if (hasRequirement("smoke-pass")) {
+    if (!input.smoke) {
+      issues.push({
+        message: "Missing telephony smoke test report.",
+        requirement: "smoke-pass",
+        severity: "error"
+      });
+    } else if (!input.smoke.pass || hasFailingSmokeCheck(input.smoke)) {
+      issues.push({
+        message: "Telephony smoke test did not pass.",
+        requirement: "smoke-pass",
+        severity: "error"
+      });
+    }
+  }
+  for (const warning of input.setup.warnings) {
+    issues.push({
+      message: warning,
+      requirement: "stream-url",
+      severity: "warning"
+    });
+  }
+  for (const name of input.setup.missing) {
+    issues.push({
+      message: `${name} is missing.`,
+      requirement: "webhook-url",
+      severity: "error"
+    });
+  }
+  return {
+    issues,
+    pass: issues.every((issue) => issue.severity !== "error"),
+    provider: input.setup.provider,
+    requirements,
+    setup: input.setup,
+    smoke: input.smoke
+  };
+};
 // src/telephony/response.ts
 var normalizeWhitespace = (value) => value.replace(/\s+/g, " ").trim();
 var DEFAULT_MAX_WORDS = 12;
@@ -16046,6 +16125,7 @@ export {
   failVoiceOpsTask,
   exportVoiceTrace,
   evaluateVoiceTrace,
+  evaluateVoiceTelephonyContract,
   evaluateVoiceQuality,
   encodeTwilioMulawBase64,
   deliverVoiceTraceEventsToSinks,

package/dist/telephony/contract.d.ts

@@ -0,0 +1,61 @@
+export type VoiceTelephonyProvider = 'generic' | 'plivo' | 'telnyx' | 'twilio';
+export type VoiceTelephonySetupStatus<TProvider extends VoiceTelephonyProvider = VoiceTelephonyProvider> = {
+    generatedAt: number;
+    missing: string[];
+    provider: TProvider;
+    ready: boolean;
+    signing: {
+        configured: boolean;
+        mode: 'custom' | 'none' | 'provider-signature' | 'twilio-signature';
+        verificationUrl?: string;
+    };
+    urls: {
+        stream: string;
+        twiml?: string;
+        webhook: string;
+    };
+    warnings: string[];
+};
+export type VoiceTelephonySmokeCheck = {
+    details?: Record<string, unknown>;
+    message?: string;
+    name: string;
+    status: 'fail' | 'pass' | 'warn';
+};
+export type VoiceTelephonySmokeReport<TProvider extends VoiceTelephonyProvider = VoiceTelephonyProvider> = {
+    checks: VoiceTelephonySmokeCheck[];
+    generatedAt: number;
+    pass: boolean;
+    provider: TProvider;
+    setup: VoiceTelephonySetupStatus<TProvider>;
+    twiml?: {
+        status: number;
+        streamUrl?: string;
+    };
+    webhook?: {
+        body?: unknown;
+        status: number;
+    };
+};
+export type VoiceTelephonyContractRequirement = 'signed-webhook' | 'smoke-pass' | 'stream-url' | 'webhook-url' | 'wss-stream';
+export type VoiceTelephonyContractIssue = {
+    requirement: VoiceTelephonyContractRequirement;
+    severity: 'error' | 'warning';
+    message: string;
+};
+export type VoiceTelephonyContractReport<TProvider extends VoiceTelephonyProvider = VoiceTelephonyProvider> = {
+    issues: VoiceTelephonyContractIssue[];
+    pass: boolean;
+    provider: TProvider;
+    requirements: VoiceTelephonyContractRequirement[];
+    setup: VoiceTelephonySetupStatus<TProvider>;
+    smoke?: VoiceTelephonySmokeReport<TProvider>;
+};
+export type VoiceTelephonyContractOptions = {
+    requirements?: VoiceTelephonyContractRequirement[];
+};
+export declare const evaluateVoiceTelephonyContract: <TProvider extends VoiceTelephonyProvider>(input: {
+    options?: VoiceTelephonyContractOptions;
+    setup: VoiceTelephonySetupStatus<TProvider>;
+    smoke?: VoiceTelephonySmokeReport<TProvider>;
+}) => VoiceTelephonyContractReport<TProvider>;

package/dist/telephony/twilio.d.ts

@@ -1,4 +1,5 @@
 import { Elysia } from 'elysia';
+import type { VoiceTelephonySetupStatus, VoiceTelephonySmokeCheck, VoiceTelephonySmokeReport } from './contract';
 import { type VoiceTelephonyOutcomePolicy, type VoiceTelephonyWebhookRoutesOptions } from '../telephonyOutcome';
 import { type VoiceCallReviewArtifact, type VoiceCallReviewConfig } from '../testing/review';
 import type { AudioFormat, VoiceLogger, VoicePluginConfig, VoiceSessionRecord, VoiceServerMessage } from '../types';
@@ -113,48 +114,19 @@ export type TwilioVoiceRouteParameters = Record<string, string | number | boolea
     query: Record<string, unknown>;
     request: Request;
 }) => Promise<Record<string, string | number | boolean | undefined>> | Record<string, string | number | boolean | undefined>);
-export type TwilioVoiceSetupStatus = {
-    generatedAt: number;
-    missing: string[];
-    provider: 'twilio';
-    ready: boolean;
-    signing: {
-        configured: boolean;
-        mode: 'custom' | 'none' | 'twilio-signature';
-        verificationUrl?: string;
-    };
-    urls: {
-        stream: string;
+export type TwilioVoiceSetupStatus = VoiceTelephonySetupStatus<'twilio'> & {
+    urls: VoiceTelephonySetupStatus<'twilio'>['urls'] & {
         twiml: string;
-        webhook: string;
     };
-    warnings: string[];
 };
 export type TwilioVoiceSetupOptions = {
     path?: false | string;
     requiredEnv?: Record<string, string | undefined>;
     title?: string;
 };
-export type TwilioVoiceSmokeCheck = {
-    details?: Record<string, unknown>;
-    message?: string;
-    name: string;
-    status: 'fail' | 'pass' | 'warn';
-};
-export type TwilioVoiceSmokeReport = {
-    checks: TwilioVoiceSmokeCheck[];
-    generatedAt: number;
-    pass: boolean;
-    provider: 'twilio';
+export type TwilioVoiceSmokeCheck = VoiceTelephonySmokeCheck;
+export type TwilioVoiceSmokeReport = VoiceTelephonySmokeReport<'twilio'> & {
     setup: TwilioVoiceSetupStatus;
-    twiml?: {
-        status: number;
-        streamUrl?: string;
-    };
-    webhook?: {
-        body?: unknown;
-        status: number;
-    };
 };
 export type TwilioVoiceSmokeOptions = {
     callSid?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@absolutejs/voice",
-	"version": "0.0.22-beta.76",
+	"version": "0.0.22-beta.77",
 	"description": "Voice primitives and Elysia plugin for AbsoluteJS",
 	"repository": {
 		"type": "git",