@xapp/stentor-service-generative-ai 1.83.0 → 1.89.0

package/lib/models/LeadAnalysis.d.ts

@@ -1,105 +0,0 @@
-/*! Copyright (c) 2024, XAPP AI */
-/**
- * Categorizes the nature of the customer's interaction with the business.
- *
- * See LEAD_ANALYSIS_GUIDE.md for detailed definitions and examples.
- *
- * @remarks
- * - BILLING_ISSUE: Concerns about charges, refunds, pricing discrepancies, or payments
- * - CANCELLATION: Asking to cancel an appointment, service, subscription, or contract
- * - COMPLAINT: Dissatisfaction with business, product, or service quality (excluding billing/scheduling)
- * - COMPLIMENT: Positive feedback about the business, staff, or product
- * - CONTACT_REQUEST: Request for contact without actionable details (use only for vague "call me" requests)
- * - EMPLOYMENT_INQUIRY: Questions about jobs, openings, hiring, or how to apply
- * - MISSED_APPOINTMENT: Reporting a no-show, missed call/visit, or confirmation confusion
- * - QUESTION: General inquiry about business/services without requesting service or quote
- * - QUOTE_REQUEST: Requesting a price, cost, estimate, quote, or ballpark figure
- * - RESCHEDULE_REQUEST: Asking to change date/time of existing appointment or scheduled service
- * - SERVICE_REQUEST: Requesting service, repair, installation, maintenance, inspection, or scheduling
- * - SPAM: Unsolicited, irrelevant, deceptive, or low-value content
- * - TEST: Test message, placeholder text, or internal system check
- * - OTHER: Content cannot be reasonably determined
- */
-export type ContactType = "BILLING_ISSUE" | "CANCELLATION" | "COMPLAINT" | "COMPLIMENT" | "CONTACT_REQUEST" | "EMPLOYMENT_INQUIRY" | "MISSED_APPOINTMENT" | "QUESTION" | "QUOTE_REQUEST" | "RESCHEDULE_REQUEST" | "SERVICE_REQUEST" | "SPAM" | "TEST" | "OTHER";
-/**
- * Describes what kind of work the customer is requesting (high-level categorization).
- *
- * See LEAD_ANALYSIS_GUIDE.md for detailed definitions and examples.
- *
- * @remarks
- * - CLEANING: Cleaning work (house, windows, ducts, carpet, gutters)
- * - CONSULTATION: Requesting advice or guidance only, not execution
- * - INSPECTION: Evaluation or assessment to check a condition or issue
- * - INSTALLATION: New installation of a product or system
- * - MAINTENANCE: Routine or recurring upkeep
- * - REFINISH: Refinishing surfaces (floors, cabinets, painting, staining)
- * - REMODEL: Renovating or improving an existing structure or space
- * - REPAIR: Fixing an existing product or system
- * - SUPPORT: Help with an issue or appointment related to service but not the work itself
- * - TRANSPORT: Moving, hauling, or delivering items
- * - TREATMENT: Active service to resolve or prevent an issue (pest control, mold remediation, etc.)
- * - OTHER: Work that doesn't fit the above categories
- */
-export type ServiceType = "CLEANING" | "CONSULTATION" | "INSPECTION" | "INSTALLATION" | "MAINTENANCE" | "REFINISH" | "REMODEL" | "REPAIR" | "SUPPORT" | "TRANSPORT" | "TREATMENT" | "OTHER";
-/**
- * Identifies the specific trade or industry relevant to the request.
- *
- * See LEAD_ANALYSIS_GUIDE.md for detailed definitions and examples.
- *
- * @remarks
- * Some categories have aliases (e.g., electrical/electrician, gutter/gutters) for flexibility.
- */
-export type JobType = "appliance_repair" | "blinds" | "carpentry" | "cleaning" | "construction" | "contractor" | "drywall" | "electrical" | "electrician" | "fencing" | "flooring" | "gutter" | "gutters" | "handyman" | "house_cleaning" | "hvac" | "junk_removal" | "landscaping" | "landscaper" | "legal_services" | "masonry" | "mold_remediation" | "moving" | "painting" | "painter" | "pest_control" | "plumbing" | "pressure_washing" | "remodeling" | "restoration" | "roofing" | "roofer" | "siding" | "tree_services" | "wildlife_control" | "window_cleaning" | "window_installation" | "windows_doors" | "other";
-/**
- * Indicates how quickly the issue should be addressed based on the nature of the problem.
- *
- * See LEAD_ANALYSIS_GUIDE.md for detailed definitions and examples.
- *
- * @remarks
- * - LOW: Not time-sensitive, can be addressed at business's convenience
- * - MEDIUM: Not time-sensitive, can be addressed within a couple of weeks
- * - HIGH: Not life-threatening but should be addressed within a few days (may lead to property damage)
- * - URGENT: Life-threatening or causing property damage, should be addressed ASAP (potentially same day)
- * - NOT_SPECIFIED: Urgency could not be determined from available information
- *
- * Note: Urgency is determined by the nature of the issue itself, not solely by customer's stated urgency.
- */
-export type UrgencyType = "LOW" | "MEDIUM" | "HIGH" | "URGENT" | "NOT_SPECIFIED";
-export interface LeadAnalysis {
-    /**
-     * The version of the analysis that was performed.  This changes when major changes are made to the analysis process.  It can be used to determine if the analysis is up to date and needs to be re-run.
-     */
-    analysisVersion?: string;
-    /**
-     * A description of the kind of message that was sent to the user.
-     */
-    contactType?: ContactType;
-    /**
-     * A description of the kind of service that the user is requesting.
-     */
-    serviceType?: ServiceType;
-    /**
-     * The type of job that the user is requesting.
-     */
-    jobType?: JobType;
-    /**
-     * The urgency of the message if it is necessary.
-     */
-    urgency?: UrgencyType;
-    /**
-     * Whether the lead is considered high value meaning it can generate significant revenue for the customer.
-     */
-    highValueLead?: boolean;
-    /**
-     * A summary of the conversation and the lead analysis.
-     */
-    summary?: string;
-    /**
-     * A 2 - 3 word concise summary of the lead, main use for this is in a word cloud and on the lead list item dashboard.
-     */
-    conciseSummary?: string;
-    /**
-     * An analysis of how the LLM came to its conclusion.
-     */
-    analysis?: string;
-}

package/lib/models/LeadAnalysis.js

@@ -1,4 +0,0 @@
-"use strict";
-/*! Copyright (c) 2024, XAPP AI */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=LeadAnalysis.js.map

package/lib/models/LeadAnalysis.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LeadAnalysis.js","sourceRoot":"","sources":["../../src/models/LeadAnalysis.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/models/Prompt.d.ts

@@ -1,37 +0,0 @@
-/*! Copyright (c) 2024, XAPP AI */
-export type PromptType = "completions";
-export interface Prompt {
-    type: PromptType;
-}
-export type CompletionContentMessageType = "text" | "json_object";
-export interface CompletionResponseFormatText {
-    type: "text";
-}
-export interface CompletionResponseFormatJSONObject {
-    type: "json_object";
-}
-export interface CompletionResponseFormatJSONSchema {
-    type: "json_schema";
-    /**
-     * JSON schema for the response following the JSON schema specification
-     */
-    json_schema: object;
-}
-export type CompletionResponseFormat = CompletionResponseFormatText | CompletionResponseFormatJSONObject | CompletionResponseFormatJSONSchema;
-export type CompletionContentMessage = string;
-export interface CompletionMessage {
-    role: string;
-    content: CompletionContentMessage;
-}
-export interface CompletionPrompt extends Prompt {
-    type: "completions";
-    messages: CompletionMessage[];
-    model: string;
-    response_format: CompletionResponseFormat;
-    max_tokens: number;
-    temperature: number;
-    top_p: number;
-    frequency_penalty: number;
-    presence_penalty: number;
-}
-export declare function isCompletionPrompt(prompt: Prompt): prompt is CompletionPrompt;

package/lib/models/Prompt.js

@@ -1,8 +0,0 @@
-"use strict";
-/*! Copyright (c) 2024, XAPP AI */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCompletionPrompt = isCompletionPrompt;
-function isCompletionPrompt(prompt) {
-    return (prompt === null || prompt === void 0 ? void 0 : prompt.type) === "completions";
-}
-//# sourceMappingURL=Prompt.js.map

package/lib/models/Prompt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Prompt.js","sourceRoot":"","sources":["../../src/models/Prompt.ts"],"names":[],"mappings":";AAAA,kCAAkC;;AA+ClC,gDAEC;AAFD,SAAgB,kBAAkB,CAAC,MAAc;IAC7C,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,MAAK,aAAa,CAAC;AAC1C,CAAC"}

package/lib/models/PromptGenerator.d.ts

@@ -1,6 +0,0 @@
-/*! Copyright (c) 2024, XAPP AI */
-import { Prompt } from "./Prompt";
-/**
- * A generator that can return a prompt that is intended to be sent to an LLM Service.
- */
-export type PromptGenerator<PromptOptions, LLMOverrides extends object = {}, ReturnPrompt = Prompt> = (opts: PromptOptions, overrides?: LLMOverrides) => ReturnPrompt;

package/lib/models/PromptGenerator.js

@@ -1,4 +0,0 @@
-"use strict";
-/*! Copyright (c) 2024, XAPP AI */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=PromptGenerator.js.map

package/lib/models/PromptGenerator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PromptGenerator.js","sourceRoot":"","sources":["../../src/models/PromptGenerator.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/models/ResponseParser.d.ts

@@ -1,5 +0,0 @@
-/*! Copyright (c) 2024, XAPP AI */
-/**
- * A parser that can parse a response from a service
- */
-export type ResponseParser<T> = (response: string) => T;

package/lib/models/ResponseParser.js

@@ -1,4 +0,0 @@
-"use strict";
-/*! Copyright (c) 2024, XAPP AI */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ResponseParser.js.map

package/lib/models/ResponseParser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ResponseParser.js","sourceRoot":"","sources":["../../src/models/ResponseParser.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/models/WebsiteAnalysis.d.ts

@@ -1,48 +0,0 @@
-/*! Copyright (c) 2025, XAPP AI */
-export type BusinessCategory = "business-coaching" | "consulting" | "contact-capture" | "financial-services" | "home-services-cleaning" | "home-services-contractors" | "home-services-outdoor" | "insurance" | "legal-services" | "life-coaching" | "radio" | "real-estate" | "technology-services" | "travel";
-export interface BusinessAddress {
-    /**
-     * The full address as it was found on the website.
-     */
-    formatted?: string;
-    /**
-     * Street address, street number and street name.
-     */
-    streetAddress?: string;
-    /**
-     * The postal (zip) code
-     */
-    postalCode?: string;
-    /**
-     * City, Town or Locality.  This is typically from the "city" of "city", "state"
-     */
-    locality?: string;
-    /**
-     * Typically the state.
-     */
-    region?: string;
-    /**
-     * The country
-     */
-    country?: string;
-}
-export interface WebsiteAnalysis {
-    organization_name?: string;
-    parked_domain?: boolean;
-    email?: {
-        email: string;
-        purpose?: string;
-    }[];
-    phone_numbers?: {
-        number: string;
-        purpose?: string;
-    }[];
-    addresses?: BusinessAddress[];
-    services?: string[];
-    calls_to_action?: {
-        url?: string;
-        callToAction: string;
-    }[];
-    description?: string;
-    industry_category?: BusinessCategory;
-}

package/lib/models/WebsiteAnalysis.js

@@ -1,4 +0,0 @@
-"use strict";
-/*! Copyright (c) 2025, XAPP AI */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=WebsiteAnalysis.js.map

package/lib/models/WebsiteAnalysis.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebsiteAnalysis.js","sourceRoot":"","sources":["../../src/models/WebsiteAnalysis.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/lib/models/errors.d.ts

@@ -1,7 +0,0 @@
-/*! Copyright (c) 2024, XAPP AI */
-/**
- * Error thrown when an unknown prompt type is provided to an LLM service
- */
-export declare class InvalidPromptTypeError extends Error {
-    constructor(type: string);
-}

package/lib/models/errors.js

@@ -1,15 +0,0 @@
-"use strict";
-/*! Copyright (c) 2024, XAPP AI */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidPromptTypeError = void 0;
-/**
- * Error thrown when an unknown prompt type is provided to an LLM service
- */
-class InvalidPromptTypeError extends Error {
-    constructor(type) {
-        super(`Unknown prompt type: ${type}`);
-        this.name = "InvalidPromptTypeError";
-    }
-}
-exports.InvalidPromptTypeError = InvalidPromptTypeError;
-//# sourceMappingURL=errors.js.map

package/lib/models/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/models/errors.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;AAElC;;GAEG;AACH,MAAa,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,IAAY;QACpB,KAAK,CAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACzC,CAAC;CACJ;AALD,wDAKC"}

package/lib/models/index.d.ts

@@ -1,9 +0,0 @@
-/*! Copyright (c) 2026, XAPP AI */
-export * from "./EmailAnalysis";
-export * from "./errors";
-export * from './GenerativeAIService';
-export * from './LeadAnalysis';
-export * from "./LLMService";
-export * from "./Prompt";
-export * from "./PromptGenerator";
-export * from "./ResponseParser";

package/lib/models/index.js

@@ -1,26 +0,0 @@
-"use strict";
-/*! Copyright (c) 2026, XAPP AI */
-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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./EmailAnalysis"), exports);
-__exportStar(require("./errors"), exports);
-__exportStar(require("./GenerativeAIService"), exports);
-__exportStar(require("./LeadAnalysis"), exports);
-__exportStar(require("./LLMService"), exports);
-__exportStar(require("./Prompt"), exports);
-__exportStar(require("./PromptGenerator"), exports);
-__exportStar(require("./ResponseParser"), exports);
-//# sourceMappingURL=index.js.map

package/lib/models/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;;;;;;;;;;;;;;AAElC,kDAAgC;AAChC,2CAAyB;AACzB,wDAAsC;AACtC,iDAA+B;AAC/B,+CAA6B;AAC7B,2CAAyB;AACzB,oDAAkC;AAClC,mDAAiC"}

package/lib/prompts/AnalyzeEmail.d.ts

@@ -1,36 +0,0 @@
-/*! Copyright (c) 2026, XAPP AI */
-import type { CompletionPrompt, PromptGenerator, ResponseParser } from "../models";
-import type { EmailAnalysisInput, EmailLeadAnalysis } from "../models/EmailAnalysis";
-export declare const ANALYZE_EMAIL_VERSION = "1.1.0";
-export interface AnalyzeEmailProps {
-    businessDescription?: string;
-    highValueLeadDescription?: string;
-    email: EmailAnalysisInput;
-}
-export type AnalyzeEmailLLMOverrides = Partial<Pick<CompletionPrompt, "model" | "max_tokens" | "temperature" | "top_p" | "frequency_penalty" | "presence_penalty">>;
-/**
- * Converts an email (with optional thread history) into the messages array for an LLM completion prompt.
- *
- * Thread history messages are prepended in order, with customer messages as "user" and
- * agent/FSM-CRM messages as "assistant". The current email is always the final "user" message.
- *
- * @param system - The system instruction message.
- * @param email - The email to analyze.
- */
-export declare function emailThreadToMessages(system: string, email: EmailAnalysisInput): {
-    role: "system" | "user" | "assistant";
-    content: string;
-}[];
-/**
- * Generates a prompt that can be used in an LLM to analyze an inbound email for a business.
- *
- * Combines lead classification (contactType, serviceType, jobType, urgency) with contact
- * information extraction in a single LLM call, returning an `EmailLeadAnalysis`.
- *
- * Handles:
- * - Direct customer emails
- * - FSM/CRM lead notification emails (Jobber, ServiceTitan, Housecall Pro, etc.)
- * - Email threads with prior conversation history
- */
-export declare const generateAnalyzeEmail: PromptGenerator<AnalyzeEmailProps, AnalyzeEmailLLMOverrides, CompletionPrompt>;
-export declare const analyzeEmailResponseParse: ResponseParser<EmailLeadAnalysis>;