@absolutejs/voice 0.0.22-beta.107 → 0.0.22-beta.109

package/dist/campaign.d.ts

@@ -0,0 +1,466 @@
+import { Elysia } from 'elysia';
+export type VoiceCampaignStatus = 'canceled' | 'completed' | 'draft' | 'paused' | 'running';
+export type VoiceCampaignRecipientStatus = 'canceled' | 'completed' | 'failed' | 'pending' | 'queued';
+export type VoiceCampaignAttemptStatus = 'canceled' | 'failed' | 'queued' | 'running' | 'succeeded';
+export type VoiceCampaignRecipient = {
+    attempts: number;
+    completedAt?: number;
+    createdAt: number;
+    error?: string;
+    id: string;
+    metadata?: Record<string, unknown>;
+    name?: string;
+    phone: string;
+    status: VoiceCampaignRecipientStatus;
+    updatedAt: number;
+    variables?: Record<string, string | number | boolean | undefined>;
+};
+export type VoiceCampaignAttempt = {
+    campaignId: string;
+    completedAt?: number;
+    createdAt: number;
+    error?: string;
+    externalCallId?: string;
+    id: string;
+    metadata?: Record<string, unknown>;
+    recipientId: string;
+    startedAt?: number;
+    status: VoiceCampaignAttemptStatus;
+    updatedAt: number;
+};
+export type VoiceCampaign = {
+    createdAt: number;
+    description?: string;
+    id: string;
+    maxAttempts: number;
+    maxConcurrentAttempts: number;
+    metadata?: Record<string, unknown>;
+    name: string;
+    status: VoiceCampaignStatus;
+    updatedAt: number;
+};
+export type VoiceCampaignRecord = {
+    attempts: VoiceCampaignAttempt[];
+    campaign: VoiceCampaign;
+    recipients: VoiceCampaignRecipient[];
+};
+export type VoiceCampaignStore = {
+    get: (id: string) => Promise<VoiceCampaignRecord | undefined> | VoiceCampaignRecord | undefined;
+    list: () => Promise<VoiceCampaignRecord[]> | VoiceCampaignRecord[];
+    remove: (id: string) => Promise<void> | void;
+    set: (id: string, record: VoiceCampaignRecord) => Promise<void> | void;
+};
+export type VoiceCampaignDialerInput = {
+    attempt: VoiceCampaignAttempt;
+    campaign: VoiceCampaign;
+    recipient: VoiceCampaignRecipient;
+};
+export type VoiceCampaignDialerResult = {
+    externalCallId?: string;
+    metadata?: Record<string, unknown>;
+    status?: 'queued' | 'running' | 'succeeded';
+};
+export type VoiceCampaignDialer = (input: VoiceCampaignDialerInput) => Promise<VoiceCampaignDialerResult> | VoiceCampaignDialerResult;
+export type VoiceCampaignCreateInput = {
+    description?: string;
+    id?: string;
+    maxAttempts?: number;
+    maxConcurrentAttempts?: number;
+    metadata?: Record<string, unknown>;
+    name: string;
+};
+export type VoiceCampaignRecipientInput = {
+    id?: string;
+    metadata?: Record<string, unknown>;
+    name?: string;
+    phone: string;
+    variables?: VoiceCampaignRecipient['variables'];
+};
+export type VoiceCampaignAttemptResultInput = {
+    error?: string;
+    externalCallId?: string;
+    metadata?: Record<string, unknown>;
+    status: 'failed' | 'succeeded';
+};
+export type VoiceCampaignTickResult = {
+    attempted: number;
+    campaignId: string;
+    errors: Array<{
+        error: string;
+        recipientId: string;
+    }>;
+    started: VoiceCampaignAttempt[];
+};
+export type VoiceCampaignProofOptions = {
+    campaign?: VoiceCampaignCreateInput;
+    completeAttempts?: boolean;
+    recipients?: VoiceCampaignRecipientInput[];
+    runtime?: VoiceCampaignRuntime;
+    store?: VoiceCampaignStore;
+};
+export type VoiceCampaignProofReport = {
+    campaign: VoiceCampaignRecord;
+    created: VoiceCampaignRecord;
+    final: VoiceCampaignRecord;
+    proof: 'voice-campaign';
+    recipients: VoiceCampaignRecord;
+    summary: VoiceCampaignSummary;
+    tick: VoiceCampaignTickResult;
+};
+export type VoiceCampaignSummary = {
+    attempts: {
+        failed: number;
+        queued: number;
+        running: number;
+        succeeded: number;
+        total: number;
+    };
+    campaigns: {
+        canceled: number;
+        completed: number;
+        draft: number;
+        paused: number;
+        running: number;
+        total: number;
+    };
+    recipients: {
+        canceled: number;
+        completed: number;
+        failed: number;
+        pending: number;
+        queued: number;
+        total: number;
+    };
+};
+export type VoiceCampaignRuntimeOptions = {
+    dialer?: VoiceCampaignDialer;
+    store: VoiceCampaignStore;
+};
+export type VoiceCampaignRuntime = {
+    addRecipients: (campaignId: string, recipients: VoiceCampaignRecipientInput[]) => Promise<VoiceCampaignRecord>;
+    cancel: (campaignId: string) => Promise<VoiceCampaignRecord>;
+    completeAttempt: (campaignId: string, attemptId: string, result: VoiceCampaignAttemptResultInput) => Promise<VoiceCampaignRecord>;
+    create: (input: VoiceCampaignCreateInput) => Promise<VoiceCampaignRecord>;
+    enqueue: (campaignId: string) => Promise<VoiceCampaignRecord>;
+    get: (campaignId: string) => Promise<VoiceCampaignRecord | undefined>;
+    list: () => Promise<VoiceCampaignRecord[]>;
+    pause: (campaignId: string) => Promise<VoiceCampaignRecord>;
+    remove: (campaignId: string) => Promise<void>;
+    resume: (campaignId: string) => Promise<VoiceCampaignRecord>;
+    summarize: () => Promise<VoiceCampaignSummary>;
+    tick: (campaignId: string) => Promise<VoiceCampaignTickResult>;
+};
+export type VoiceCampaignRoutesOptions = VoiceCampaignRuntimeOptions & {
+    headers?: HeadersInit;
+    htmlPath?: false | string;
+    name?: string;
+    path?: string;
+    title?: string;
+};
+export declare const createVoiceMemoryCampaignStore: () => VoiceCampaignStore;
+export declare const summarizeVoiceCampaigns: (records: VoiceCampaignRecord[]) => VoiceCampaignSummary;
+export declare const createVoiceCampaign: (options: VoiceCampaignRuntimeOptions) => VoiceCampaignRuntime;
+export declare const runVoiceCampaignProof: (options?: VoiceCampaignProofOptions) => Promise<VoiceCampaignProofReport>;
+export declare const renderVoiceCampaignsHTML: (records: VoiceCampaignRecord[], options?: {
+    title?: string;
+}) => string;
+export declare const createVoiceCampaignRoutes: (options: VoiceCampaignRoutesOptions) => Elysia<"", {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {
+    [x: string]: {
+        get: {
+            body: unknown;
+            params: {};
+            query: unknown;
+            headers: unknown;
+            response: {
+                200: {
+                    campaigns: VoiceCampaignRecord[];
+                    summary: VoiceCampaignSummary;
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        post: {
+            body: unknown;
+            params: {};
+            query: unknown;
+            headers: unknown;
+            response: {
+                200: VoiceCampaignRecord;
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            get: {
+                body: unknown;
+                params: {
+                    campaignId: string;
+                } & {};
+                query: unknown;
+                headers: unknown;
+                response: {
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            delete: {
+                body: unknown;
+                params: {
+                    campaignId: string;
+                } & {};
+                query: unknown;
+                headers: unknown;
+                response: {
+                    200: {
+                        ok: boolean;
+                    };
+                    422: {
+                        type: "validation";
+                        on: string;
+                        summary?: string;
+                        message?: string;
+                        found?: unknown;
+                        property?: string;
+                        expected?: string;
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            recipients: {
+                post: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {};
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: VoiceCampaignRecord;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            enqueue: {
+                post: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {};
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: VoiceCampaignRecord;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            pause: {
+                post: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {};
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: VoiceCampaignRecord;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            resume: {
+                post: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {};
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: VoiceCampaignRecord;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            cancel: {
+                post: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {};
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: VoiceCampaignRecord;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            tick: {
+                post: {
+                    body: unknown;
+                    params: {
+                        campaignId: string;
+                    } & {};
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: VoiceCampaignTickResult;
+                        422: {
+                            type: "validation";
+                            on: string;
+                            summary?: string;
+                            message?: string;
+                            found?: unknown;
+                            property?: string;
+                            expected?: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    [x: string]: {
+        ":campaignId": {
+            attempts: {
+                ":attemptId": {
+                    result: {
+                        post: {
+                            body: unknown;
+                            params: {
+                                campaignId: string;
+                                attemptId: string;
+                            } & {};
+                            query: unknown;
+                            headers: unknown;
+                            response: {
+                                200: VoiceCampaignRecord;
+                                422: {
+                                    type: "validation";
+                                    on: string;
+                                    summary?: string;
+                                    message?: string;
+                                    found?: unknown;
+                                    property?: string;
+                                    expected?: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}>;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { voice } from './plugin';
 export { createVoiceAppKit, createVoiceAppKitRoutes, summarizeVoiceAppKitStatus } from './appKit';
+export { createVoiceCampaign, createVoiceCampaignRoutes, createVoiceMemoryCampaignStore, renderVoiceCampaignsHTML, runVoiceCampaignProof, summarizeVoiceCampaigns } from './campaign';
 export { createVoiceAssistant, createVoiceExperiment, summarizeVoiceAssistantRuns } from './assistant';
 export { createVoiceAssistantHealthHTMLHandler, createVoiceAssistantHealthJSONHandler, createVoiceAssistantHealthRoutes, renderVoiceAssistantHealthHTML, summarizeVoiceAssistantHealth } from './assistantHealth';
 export { createVoiceBargeInRoutes, renderVoiceBargeInHTML, summarizeVoiceBargeIn } from './bargeInRoutes';
@@ -53,6 +54,7 @@ export { resolveVoiceRuntimePreset } from './presets';
 export { resolveTurnDetectionConfig, TURN_PROFILE_DEFAULTS } from './turnProfiles';
 export { createVoiceCallReviewFromLiveTelephonyReport, createVoiceCallReviewRecorder, renderVoiceCallReviewHTML, renderVoiceCallReviewMarkdown } from './testing/review';
 export type { VoiceAppKitLink, VoiceAppKitRoutes, VoiceAppKitRoutesOptions, VoiceAppKitStatus, VoiceAppKitStatusOptions, VoiceAppKitStatusReport, VoiceAppKitSurface } from './appKit';
+export type { VoiceCampaign, VoiceCampaignAttempt, VoiceCampaignAttemptResultInput, VoiceCampaignAttemptStatus, VoiceCampaignCreateInput, VoiceCampaignDialer, VoiceCampaignDialerInput, VoiceCampaignDialerResult, VoiceCampaignProofOptions, VoiceCampaignProofReport, VoiceCampaignRecipient, VoiceCampaignRecipientInput, VoiceCampaignRecipientStatus, VoiceCampaignRecord, VoiceCampaignRoutesOptions, VoiceCampaignRuntime, VoiceCampaignRuntimeOptions, VoiceCampaignStatus, VoiceCampaignStore, VoiceCampaignSummary, VoiceCampaignTickResult } from './campaign';
 export type { VoiceBargeInReport, VoiceBargeInRoutesOptions } from './bargeInRoutes';
 export type { VoiceAssistant, VoiceAssistantArtifactPlan, VoiceAssistantExperiment, VoiceAssistantExperimentOptions, VoiceAssistantGuardrailInput, VoiceAssistantGuardrails, VoiceAssistantMemoryLifecycle, VoiceAssistantMemoryLifecycleInput, VoiceAssistantOptions, VoiceAssistantOutputGuardrailInput, VoiceAssistantPreset, VoiceAssistantRunsSummary, VoiceAssistantRunSummary, VoiceAssistantVariant } from './assistant';
 export type { VoiceAssistantHealthFailure, VoiceAssistantHealthHTMLHandlerOptions, VoiceAssistantHealthRoutesOptions, VoiceAssistantHealthSummary, VoiceAssistantHealthSummaryOptions } from './assistantHealth';