@fonoster/common 0.27.0 → 0.30.0

package/dist/assistants/assistantSchema.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assistantSchema = void 0;
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * 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.
- */
-const zod_1 = require("zod");
-const audioFiltersSchema_1 = require("./audioFiltersSchema");
-const conversationSettingsSchema_1 = require("./conversationSettingsSchema");
-const eventsHookSchema_1 = require("./eventsHookSchema");
-const languageModelConfigSchema_1 = require("./languageModelConfigSchema");
-const testCasesSchema_1 = require("./testCasesSchema");
-const assistantSchema = zod_1.z.object({
-    // Audio filters the Media Server runs on the caller's audio, before speech
-    // recognition and voice activity detection. Optional; none by default.
-    audioFilters: audioFiltersSchema_1.audioFiltersSchema,
-    conversationSettings: conversationSettingsSchema_1.conversationSettingsSchema,
-    languageModel: languageModelConfigSchema_1.languageModelConfigSchema,
-    eventsHook: eventsHookSchema_1.eventsHookSchema.optional(),
-    testCases: testCasesSchema_1.testCasesSchema.optional()
-});
-exports.assistantSchema = assistantSchema;

package/dist/assistants/conversationSettingsSchema.d.ts

@@ -1,122 +0,0 @@
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * 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.
- */
-import { z } from "zod";
-declare const conversationSettingsSchema: z.ZodObject<{
-    firstMessage: z.ZodOptional<z.ZodString>;
-    systemPrompt: z.ZodString;
-    goodbyeMessage: z.ZodString;
-    systemErrorMessage: z.ZodString;
-    initialDtmf: z.ZodOptional<z.ZodString>;
-    maxSessionDuration: z.ZodDefault<z.ZodNumber>;
-    maxSpeechWaitTimeout: z.ZodDefault<z.ZodNumber>;
-    transferOptions: z.ZodOptional<z.ZodObject<{
-        phoneNumber: z.ZodString;
-        message: z.ZodString;
-        timeout: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        message?: string;
-        phoneNumber?: string;
-        timeout?: number;
-    }, {
-        message?: string;
-        phoneNumber?: string;
-        timeout?: number;
-    }>>;
-    idleOptions: z.ZodObject<{
-        message: z.ZodString;
-        timeout: z.ZodDefault<z.ZodNumber>;
-        maxTimeoutCount: z.ZodDefault<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        message?: string;
-        timeout?: number;
-        maxTimeoutCount?: number;
-    }, {
-        message?: string;
-        timeout?: number;
-        maxTimeoutCount?: number;
-    }>;
-    allowUserBargeIn: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    vad: z.ZodDefault<z.ZodObject<{
-        pathToModel: z.ZodOptional<z.ZodString>;
-        activationThreshold: z.ZodNumber;
-        deactivationThreshold: z.ZodNumber;
-        debounceFrames: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        pathToModel?: string;
-        activationThreshold?: number;
-        deactivationThreshold?: number;
-        debounceFrames?: number;
-    }, {
-        pathToModel?: string;
-        activationThreshold?: number;
-        deactivationThreshold?: number;
-        debounceFrames?: number;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    firstMessage?: string;
-    systemPrompt?: string;
-    goodbyeMessage?: string;
-    systemErrorMessage?: string;
-    initialDtmf?: string;
-    maxSessionDuration?: number;
-    maxSpeechWaitTimeout?: number;
-    transferOptions?: {
-        message?: string;
-        phoneNumber?: string;
-        timeout?: number;
-    };
-    idleOptions?: {
-        message?: string;
-        timeout?: number;
-        maxTimeoutCount?: number;
-    };
-    allowUserBargeIn?: boolean;
-    vad?: {
-        pathToModel?: string;
-        activationThreshold?: number;
-        deactivationThreshold?: number;
-        debounceFrames?: number;
-    };
-}, {
-    firstMessage?: string;
-    systemPrompt?: string;
-    goodbyeMessage?: string;
-    systemErrorMessage?: string;
-    initialDtmf?: string;
-    maxSessionDuration?: number;
-    maxSpeechWaitTimeout?: number;
-    transferOptions?: {
-        message?: string;
-        phoneNumber?: string;
-        timeout?: number;
-    };
-    idleOptions?: {
-        message?: string;
-        timeout?: number;
-        maxTimeoutCount?: number;
-    };
-    allowUserBargeIn?: boolean;
-    vad?: {
-        pathToModel?: string;
-        activationThreshold?: number;
-        deactivationThreshold?: number;
-        debounceFrames?: number;
-    };
-}>;
-export { conversationSettingsSchema };

package/dist/assistants/conversationSettingsSchema.js

@@ -1,133 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.conversationSettingsSchema = void 0;
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * 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.
- */
-const zod_1 = require("zod");
-const Messages = __importStar(require("../messages"));
-const ZERO_OR_GREATER_THAN_ZERO = "Must be a number greater than or equal to 0";
-const NUMBER_BETWEEN_0_AND_1 = "Must be a number between 0 and 1";
-const MAX_SPEECH_WAIT_TIMEOUT = 0;
-const IDLE_OPTIONS_TIMEOUT = 30000;
-const IDLE_OPTIONS_MAX_TIMEOUT_COUNT = 2;
-const VAD_ACTIVATION_THRESHOLD = 0.4;
-const VAD_DEACTIVATION_THRESHOLD = 0.25;
-const VAD_DEBOUNCE_FRAMES = 4;
-const conversationSettingsSchema = zod_1.z.object({
-    firstMessage: zod_1.z.string().optional(),
-    systemPrompt: zod_1.z.string(),
-    goodbyeMessage: zod_1.z.string(),
-    systemErrorMessage: zod_1.z.string(),
-    initialDtmf: zod_1.z
-        .string()
-        .regex(/^[0-9*#]+$/, { message: Messages.VALID_DTMF })
-        .optional(),
-    maxSessionDuration: zod_1.z
-        .number()
-        .int()
-        .positive()
-        .default(30 * 60 * 1000), // 30 minutes
-    maxSpeechWaitTimeout: zod_1.z
-        .number()
-        .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-        .gte(0, { message: ZERO_OR_GREATER_THAN_ZERO })
-        .default(MAX_SPEECH_WAIT_TIMEOUT),
-    transferOptions: zod_1.z
-        .object({
-        phoneNumber: zod_1.z.string(),
-        message: zod_1.z.string(),
-        timeout: zod_1.z
-            .number()
-            .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .default(30000)
-    })
-        .optional(),
-    idleOptions: zod_1.z.object({
-        message: zod_1.z.string(),
-        timeout: zod_1.z
-            .number()
-            .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .default(IDLE_OPTIONS_TIMEOUT),
-        maxTimeoutCount: zod_1.z
-            .number()
-            .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .default(IDLE_OPTIONS_MAX_TIMEOUT_COUNT)
-    }),
-    allowUserBargeIn: zod_1.z.boolean().optional().default(true),
-    vad: zod_1.z
-        .object({
-        pathToModel: zod_1.z.string().optional(),
-        activationThreshold: zod_1.z
-            .number()
-            .max(1)
-            .min(0)
-            .positive({ message: NUMBER_BETWEEN_0_AND_1 }),
-        deactivationThreshold: zod_1.z
-            .number()
-            .max(1)
-            .min(0)
-            .positive({ message: NUMBER_BETWEEN_0_AND_1 }),
-        debounceFrames: zod_1.z
-            .number()
-            .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-            .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-    })
-        .default({
-        activationThreshold: VAD_ACTIVATION_THRESHOLD,
-        deactivationThreshold: VAD_DEACTIVATION_THRESHOLD,
-        debounceFrames: VAD_DEBOUNCE_FRAMES
-    })
-});
-exports.conversationSettingsSchema = conversationSettingsSchema;

package/dist/assistants/eventsHookSchema.d.ts

@@ -1,38 +0,0 @@
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * 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.
- */
-import { z } from "zod";
-declare enum EventsHookAllowedEvents {
-    ALL = "all",
-    CONVERSATION_STARTED = "conversation.started",
-    CONVERSATION_ENDED = "conversation.ended"
-}
-declare const eventsHookSchema: z.ZodObject<{
-    url: z.ZodString;
-    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    events: z.ZodDefault<z.ZodArray<z.ZodNativeEnum<typeof EventsHookAllowedEvents>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    url?: string;
-    headers?: Record<string, string>;
-    events?: EventsHookAllowedEvents[];
-}, {
-    url?: string;
-    headers?: Record<string, string>;
-    events?: EventsHookAllowedEvents[];
-}>;
-export { eventsHookSchema, EventsHookAllowedEvents };

package/dist/assistants/languageModelConfigSchema.d.ts

@@ -1,206 +0,0 @@
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * 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.
- */
-import { z } from "zod";
-import { LanguageModelProvider } from "./LanguageModelProvider";
-declare const languageModelConfigSchema: z.ZodObject<{
-    provider: z.ZodNativeEnum<typeof LanguageModelProvider>;
-    apiKey: z.ZodOptional<z.ZodString>;
-    model: z.ZodString;
-    temperature: z.ZodNumber;
-    maxTokens: z.ZodNumber;
-    baseUrl: z.ZodOptional<z.ZodString>;
-    knowledgeBase: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<["s3"]>;
-        title: z.ZodString;
-        document: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        type?: "s3";
-        title?: string;
-        document?: string;
-    }, {
-        type?: "s3";
-        title?: string;
-        document?: string;
-    }>, "many">>;
-    tools: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        description: z.ZodString;
-        parameters: z.ZodObject<{
-            type: z.ZodEnum<["object", "array"]>;
-            properties: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
-                type: z.ZodString;
-                format: z.ZodOptional<z.ZodEnum<["enum", "date-time"]>>;
-                pattern: z.ZodOptional<z.ZodString>;
-            }, "strip", z.ZodTypeAny, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>>;
-            required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        }, "strip", z.ZodTypeAny, {
-            type?: "object" | "array";
-            properties?: Record<string, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>;
-            required?: string[];
-        }, {
-            type?: "object" | "array";
-            properties?: Record<string, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>;
-            required?: string[];
-        }>;
-        requestStartMessage: z.ZodOptional<z.ZodString>;
-        operation: z.ZodObject<{
-            method: z.ZodDefault<z.ZodNativeEnum<typeof import("..").AllowedHttpMethod>>;
-            url: z.ZodString;
-            waitForResponse: z.ZodDefault<z.ZodBoolean>;
-            headers: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodString>, Record<string, string>, Record<string, string>>>;
-        }, "strip", z.ZodTypeAny, {
-            url?: string;
-            method?: import("..").AllowedHttpMethod;
-            headers?: Record<string, string>;
-            waitForResponse?: boolean;
-        }, {
-            url?: string;
-            method?: import("..").AllowedHttpMethod;
-            headers?: Record<string, string>;
-            waitForResponse?: boolean;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        description?: string;
-        parameters?: {
-            type?: "object" | "array";
-            properties?: Record<string, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>;
-            required?: string[];
-        };
-        requestStartMessage?: string;
-        operation?: {
-            url?: string;
-            method?: import("..").AllowedHttpMethod;
-            headers?: Record<string, string>;
-            waitForResponse?: boolean;
-        };
-    }, {
-        name?: string;
-        description?: string;
-        parameters?: {
-            type?: "object" | "array";
-            properties?: Record<string, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>;
-            required?: string[];
-        };
-        requestStartMessage?: string;
-        operation?: {
-            url?: string;
-            method?: import("..").AllowedHttpMethod;
-            headers?: Record<string, string>;
-            waitForResponse?: boolean;
-        };
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    provider?: LanguageModelProvider;
-    apiKey?: string;
-    model?: string;
-    temperature?: number;
-    maxTokens?: number;
-    baseUrl?: string;
-    knowledgeBase?: {
-        type?: "s3";
-        title?: string;
-        document?: string;
-    }[];
-    tools?: {
-        name?: string;
-        description?: string;
-        parameters?: {
-            type?: "object" | "array";
-            properties?: Record<string, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>;
-            required?: string[];
-        };
-        requestStartMessage?: string;
-        operation?: {
-            url?: string;
-            method?: import("..").AllowedHttpMethod;
-            headers?: Record<string, string>;
-            waitForResponse?: boolean;
-        };
-    }[];
-}, {
-    provider?: LanguageModelProvider;
-    apiKey?: string;
-    model?: string;
-    temperature?: number;
-    maxTokens?: number;
-    baseUrl?: string;
-    knowledgeBase?: {
-        type?: "s3";
-        title?: string;
-        document?: string;
-    }[];
-    tools?: {
-        name?: string;
-        description?: string;
-        parameters?: {
-            type?: "object" | "array";
-            properties?: Record<string, {
-                type?: string;
-                format?: "enum" | "date-time";
-                pattern?: string;
-            }>;
-            required?: string[];
-        };
-        requestStartMessage?: string;
-        operation?: {
-            url?: string;
-            method?: import("..").AllowedHttpMethod;
-            headers?: Record<string, string>;
-            waitForResponse?: boolean;
-        };
-    }[];
-}>;
-export { languageModelConfigSchema };

package/dist/assistants/languageModelConfigSchema.js

@@ -1,91 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.languageModelConfigSchema = void 0;
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * 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.
- */
-const zod_1 = require("zod");
-const Messages = __importStar(require("../messages"));
-const LanguageModelProvider_1 = require("./LanguageModelProvider");
-const tools_1 = require("./tools");
-const NUMBER_BETWEEN_0_AND_2 = "Must be a number between 0 and 2";
-const languageModelConfigSchema = zod_1.z.object({
-    provider: zod_1.z.nativeEnum(LanguageModelProvider_1.LanguageModelProvider, {
-        message: "Invalid language model provider."
-    }),
-    apiKey: zod_1.z.string().optional(),
-    model: zod_1.z.string(),
-    temperature: zod_1.z
-        .number()
-        .max(2, { message: NUMBER_BETWEEN_0_AND_2 })
-        .min(0, { message: NUMBER_BETWEEN_0_AND_2 }),
-    maxTokens: zod_1.z
-        .number()
-        .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
-        .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE }),
-    baseUrl: zod_1.z
-        .string()
-        .url({
-        message: Messages.VALID_URL
-    })
-        .optional(),
-    knowledgeBase: zod_1.z
-        .array(zod_1.z.object({
-        type: zod_1.z.enum(["s3"]),
-        title: zod_1.z.string(),
-        document: zod_1.z.string().regex(/\.pdf$/, {
-            message: "Document must be a pdf file"
-        })
-    }))
-        .default([]),
-    tools: zod_1.z.array(tools_1.toolSchema).default([])
-});
-exports.languageModelConfigSchema = languageModelConfigSchema;

package/dist/identity/tokenHasAccessKeyId.d.ts

@@ -1,2 +0,0 @@
-declare function tokenHasAccessKeyId(token: string, accessKeyId: string): boolean;
-export { tokenHasAccessKeyId };