@fonoster/common 0.8.26 → 0.8.28

package/dist/assistants/LanguageModelProvider.d.ts

@@ -0,0 +1,6 @@
+declare enum LanguageModelProvider {
+    OPENAI = "openai",
+    GROQ = "groq",
+    OLLAMA = "ollama"
+}
+export { LanguageModelProvider };

package/dist/assistants/LanguageModelProvider.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LanguageModelProvider = void 0;
+/*
+ * Copyright (C) 2024 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.
+ */
+var LanguageModelProvider;
+(function (LanguageModelProvider) {
+    LanguageModelProvider["OPENAI"] = "openai";
+    LanguageModelProvider["GROQ"] = "groq";
+    LanguageModelProvider["OLLAMA"] = "ollama";
+})(LanguageModelProvider || (exports.LanguageModelProvider = LanguageModelProvider = {}));

package/dist/assistants/assistantSchema.d.ts

@@ -0,0 +1,411 @@
+import { z } from "zod";
+declare const assistantSchema: z.ZodObject<{
+    conversationSettings: z.ZodObject<{
+        firstMessage: z.ZodOptional<z.ZodString>;
+        systemTemplate: z.ZodString;
+        goodbyeMessage: z.ZodString;
+        systemErrorMessage: z.ZodString;
+        initialDtmf: z.ZodOptional<z.ZodString>;
+        maxSpeechWaitTimeout: z.ZodNumber;
+        transferOptions: z.ZodOptional<z.ZodObject<{
+            phoneNumber: z.ZodString;
+            message: z.ZodString;
+            timeout: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            message?: string;
+            phoneNumber?: string;
+            timeout?: number;
+        }, {
+            message?: string;
+            phoneNumber?: string;
+            timeout?: number;
+        }>>;
+        idleOptions: z.ZodOptional<z.ZodObject<{
+            message: z.ZodString;
+            timeout: z.ZodNumber;
+            maxTimeoutCount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        }, {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        }>>;
+        vad: 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;
+        systemTemplate?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSpeechWaitTimeout?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+            timeout?: number;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        vad?: {
+            pathToModel?: string;
+            activationThreshold?: number;
+            deactivationThreshold?: number;
+            debounceFrames?: number;
+        };
+    }, {
+        firstMessage?: string;
+        systemTemplate?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSpeechWaitTimeout?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+            timeout?: number;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        vad?: {
+            pathToModel?: string;
+            activationThreshold?: number;
+            deactivationThreshold?: number;
+            debounceFrames?: number;
+        };
+    }>;
+    languageModel: z.ZodObject<{
+        provider: z.ZodNativeEnum<typeof import("./LanguageModelProvider").LanguageModelProvider>;
+        apiKey: z.ZodOptional<z.ZodString>;
+        model: z.ZodString;
+        temperature: z.ZodNumber;
+        maxTokens: z.ZodNumber;
+        baseUrl: z.ZodOptional<z.ZodString>;
+        knowledgeBase: 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.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.ZodString>;
+                    pattern: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }>, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }>>;
+                required: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            }, {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            }>;
+            requestStartMessage: z.ZodOptional<z.ZodString>;
+            operation: z.ZodEffects<z.ZodObject<{
+                type: z.ZodNativeEnum<typeof import("./tools/AllowedOperations").AllowedOperations>;
+                url: z.ZodOptional<z.ZodString>;
+                waitForResponse: z.ZodOptional<z.ZodBoolean>;
+                headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            }, "strip", z.ZodTypeAny, {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            }, {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            }>, {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            }, {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            };
+        }, {
+            name?: string;
+            description?: string;
+            parameters?: {
+                type?: "object" | "array";
+                properties?: Record<string, {
+                    type?: string;
+                    format?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            };
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        provider?: import("./LanguageModelProvider").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?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            };
+        }[];
+    }, {
+        provider?: import("./LanguageModelProvider").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?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            };
+        }[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    conversationSettings?: {
+        firstMessage?: string;
+        systemTemplate?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSpeechWaitTimeout?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+            timeout?: number;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        vad?: {
+            pathToModel?: string;
+            activationThreshold?: number;
+            deactivationThreshold?: number;
+            debounceFrames?: number;
+        };
+    };
+    languageModel?: {
+        provider?: import("./LanguageModelProvider").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?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            };
+        }[];
+    };
+}, {
+    conversationSettings?: {
+        firstMessage?: string;
+        systemTemplate?: string;
+        goodbyeMessage?: string;
+        systemErrorMessage?: string;
+        initialDtmf?: string;
+        maxSpeechWaitTimeout?: number;
+        transferOptions?: {
+            message?: string;
+            phoneNumber?: string;
+            timeout?: number;
+        };
+        idleOptions?: {
+            message?: string;
+            timeout?: number;
+            maxTimeoutCount?: number;
+        };
+        vad?: {
+            pathToModel?: string;
+            activationThreshold?: number;
+            deactivationThreshold?: number;
+            debounceFrames?: number;
+        };
+    };
+    languageModel?: {
+        provider?: import("./LanguageModelProvider").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?: string;
+                    pattern?: string;
+                }>;
+                required?: string[];
+            };
+            requestStartMessage?: string;
+            operation?: {
+                type?: import("./tools/AllowedOperations").AllowedOperations;
+                url?: string;
+                waitForResponse?: boolean;
+                headers?: Record<string, string>;
+            };
+        }[];
+    };
+}>;
+export { assistantSchema };

package/dist/assistants/assistantSchema.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assistantSchema = void 0;
+/*
+ * Copyright (C) 2024 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 conversationSettingsSchema_1 = require("./conversationSettingsSchema");
+const languageModelConfigSchema_1 = require("./languageModelConfigSchema");
+const assistantSchema = zod_1.z.object({
+    conversationSettings: conversationSettingsSchema_1.conversationSettingsSchema,
+    languageModel: languageModelConfigSchema_1.languageModelConfigSchema
+});
+exports.assistantSchema = assistantSchema;

package/dist/assistants/conversationSettingsSchema.d.ts

@@ -0,0 +1,98 @@
+import { z } from "zod";
+declare const conversationSettingsSchema: z.ZodObject<{
+    firstMessage: z.ZodOptional<z.ZodString>;
+    systemTemplate: z.ZodString;
+    goodbyeMessage: z.ZodString;
+    systemErrorMessage: z.ZodString;
+    initialDtmf: z.ZodOptional<z.ZodString>;
+    maxSpeechWaitTimeout: z.ZodNumber;
+    transferOptions: z.ZodOptional<z.ZodObject<{
+        phoneNumber: z.ZodString;
+        message: z.ZodString;
+        timeout: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        message?: string;
+        phoneNumber?: string;
+        timeout?: number;
+    }, {
+        message?: string;
+        phoneNumber?: string;
+        timeout?: number;
+    }>>;
+    idleOptions: z.ZodOptional<z.ZodObject<{
+        message: z.ZodString;
+        timeout: z.ZodNumber;
+        maxTimeoutCount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    }, {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    }>>;
+    vad: 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;
+    systemTemplate?: string;
+    goodbyeMessage?: string;
+    systemErrorMessage?: string;
+    initialDtmf?: string;
+    maxSpeechWaitTimeout?: number;
+    transferOptions?: {
+        message?: string;
+        phoneNumber?: string;
+        timeout?: number;
+    };
+    idleOptions?: {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    };
+    vad?: {
+        pathToModel?: string;
+        activationThreshold?: number;
+        deactivationThreshold?: number;
+        debounceFrames?: number;
+    };
+}, {
+    firstMessage?: string;
+    systemTemplate?: string;
+    goodbyeMessage?: string;
+    systemErrorMessage?: string;
+    initialDtmf?: string;
+    maxSpeechWaitTimeout?: number;
+    transferOptions?: {
+        message?: string;
+        phoneNumber?: string;
+        timeout?: number;
+    };
+    idleOptions?: {
+        message?: string;
+        timeout?: number;
+        maxTimeoutCount?: number;
+    };
+    vad?: {
+        pathToModel?: string;
+        activationThreshold?: number;
+        deactivationThreshold?: number;
+        debounceFrames?: number;
+    };
+}>;
+export { conversationSettingsSchema };

package/dist/assistants/conversationSettingsSchema.js

@@ -0,0 +1,113 @@
+"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) 2024 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 NUMBER_BETWEEN_0_AND_1 = "Must be a number between 0 and 1";
+const conversationSettingsSchema = zod_1.z.object({
+    firstMessage: zod_1.z.string().optional(),
+    systemTemplate: 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(),
+    maxSpeechWaitTimeout: zod_1.z
+        .number()
+        .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
+        .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE }),
+    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 })
+            .optional()
+    })
+        .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 }),
+        maxTimeoutCount: zod_1.z
+            .number()
+            .int({ message: Messages.POSITIVE_INTEGER_MESSAGE })
+            .positive({ message: Messages.POSITIVE_INTEGER_MESSAGE })
+    })
+        .optional(),
+    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 })
+    })
+});
+exports.conversationSettingsSchema = conversationSettingsSchema;

package/dist/assistants/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./tools";
+export * from "./assistantSchema";
+export * from "./LanguageModelProvider";
+export * from "./conversationSettingsSchema";
+export * from "./languageModelConfigSchema";