@botonic/shared 2.23.0

package/src/lib/hubtype-analytics-types.d.ts

@@ -0,0 +1,227 @@
+import { ToolExecution } from './ai-agents-types';
+export declare const EVENT_FORMAT_VERSION = 5;
+export declare enum EventAction {
+    AiAgent = "ai_agent",
+    FeedbackCase = "feedback_case",
+    FeedbackMessage = "feedback_message",
+    FeedbackConversation = "feedback_conversation",
+    FeedbackKnowledgebase = "feedback_knowledgebase",
+    FeedbackWebview = "feedback_webview",
+    FlowNode = "flow_node",
+    ConditionalCountry = "conditional_country",
+    ConditionalQueueStatus = "conditional_queue_status",
+    ConditionalCustom = "conditional_custom",
+    ConditionalChannel = "conditional_channel",
+    BotAction = "bot_action",
+    WebviewActionTriggered = "webview_action_triggered",
+    HandoffOption = "handoff_option",
+    HandoffSuccess = "handoff_success",
+    HandoffFail = "handoff_fail",
+    Keyword = "nlu_keyword",
+    IntentSmart = "nlu_intent_smart",
+    Knowledgebase = "knowledgebase",
+    Fallback = "fallback",
+    WebviewStep = "webview_step",
+    WebviewEnd = "webview_end",
+    Custom = "custom",
+    RedirectFlow = "redirect_flow",
+    CaptureUserInput = "capture_user_input"
+}
+export interface HtBaseEventProps {
+    action: EventAction;
+}
+export interface HtBaseEventAllFlowProps extends HtBaseEventProps {
+    flowThreadId: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    flowNodeIsMeaningful: boolean;
+}
+export interface EventFeedback extends HtBaseEventProps {
+    action: EventAction.FeedbackCase | EventAction.FeedbackConversation | EventAction.FeedbackMessage | EventAction.FeedbackWebview;
+    feedbackTargetId: string;
+    feedbackGroupId: string;
+    possibleOptions: string[];
+    possibleValues?: number[];
+    option: string;
+    value?: number;
+    comment?: string;
+}
+export interface EventFeedbackKnowledgebase extends HtBaseEventProps {
+    action: EventAction.FeedbackKnowledgebase;
+    knowledgebaseInferenceId: string;
+    feedbackBotInteractionId: string;
+    feedbackTargetId: string;
+    feedbackGroupId: string;
+    possibleOptions: string[];
+    possibleValues?: number[];
+    option: string;
+    value?: number;
+    comment?: string;
+}
+export interface EventFlow extends HtBaseEventProps {
+    action: EventAction.FlowNode;
+    flowThreadId: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    flowNodeIsMeaningful?: boolean;
+}
+export interface EventBotAction extends HtBaseEventAllFlowProps {
+    action: EventAction.BotAction;
+    payload: string;
+}
+export interface EventConditionalCountry extends HtBaseEventAllFlowProps {
+    action: EventAction.ConditionalCountry;
+    country: string;
+}
+export interface EventConditionalQueueStatus extends HtBaseEventAllFlowProps {
+    action: EventAction.ConditionalQueueStatus;
+    queueId: string;
+    queueName: string;
+    isQueueOpen: boolean;
+    isAvailableAgent: boolean;
+}
+export interface EventConditionalCustom extends HtBaseEventAllFlowProps {
+    action: EventAction.ConditionalCustom;
+    conditionalVariable: string;
+    variableFormat: string;
+}
+export interface EventConditionalChannel extends HtBaseEventAllFlowProps {
+    action: EventAction.ConditionalChannel;
+    channel: string;
+}
+export interface EventHandoff extends HtBaseEventProps {
+    action: EventAction.HandoffSuccess | EventAction.HandoffFail;
+    flowThreadId?: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    queueId: string;
+    queueName: string;
+    caseId?: string;
+    isQueueOpen?: boolean;
+    isAvailableAgent?: boolean;
+    isThresholdReached?: boolean;
+}
+export interface EventHandoffOption extends HtBaseEventProps {
+    action: EventAction.HandoffOption;
+    flowThreadId?: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    queueId?: string;
+    queueName?: string;
+}
+export interface EventKeyword extends HtBaseEventProps {
+    action: EventAction.Keyword;
+    flowThreadId: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    nluKeywordName: string;
+    nluKeywordIsRegex?: boolean;
+    nluKeywordMessageId: string;
+    userInput: string;
+}
+export interface EventIntentSmart extends HtBaseEventProps {
+    action: EventAction.IntentSmart;
+    flowThreadId: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    nluIntentSmartTitle: string;
+    nluIntentSmartNumUsed: number;
+    nluIntentSmartMessageId: string;
+    userInput: string;
+}
+export interface EventKnowledgeBase extends HtBaseEventProps {
+    action: EventAction.Knowledgebase;
+    flowThreadId: string;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    knowledgebaseInferenceId: string;
+    knowledgebaseFailReason?: KnowledgebaseFailReason;
+    knowledgebaseSourcesIds: string[];
+    knowledgebaseChunksIds: string[];
+    knowledgebaseMessageId: string;
+    userInput: string;
+}
+export declare enum KnowledgebaseFailReason {
+    NoKnowledge = "no_knowledge",
+    Hallucination = "hallucination"
+}
+export interface EventWebviewActionTriggered extends HtBaseEventAllFlowProps {
+    action: EventAction.WebviewActionTriggered;
+    webviewTargetId: string;
+    webviewName: string;
+}
+export interface EventAiAgent extends HtBaseEventAllFlowProps {
+    action: EventAction.AiAgent;
+    toolsExecuted: ToolExecution[];
+    inputMessageId: string;
+    memoryLength: number;
+    inputGuardrailsTriggered: string[];
+    outputGuardrailsTriggered: string[];
+    exit: boolean;
+    error: boolean;
+}
+export interface EventRedirectFlow extends HtBaseEventAllFlowProps {
+    action: EventAction.RedirectFlow;
+    flowTargetId: string;
+    flowTargetName: string;
+}
+export interface EventCaptureUserInput extends HtBaseEventAllFlowProps {
+    action: EventAction.CaptureUserInput;
+    fieldName: string;
+    userInput: string;
+    captureSuccess: boolean;
+    messageId: string;
+}
+export interface EventFallback extends HtBaseEventProps {
+    action: EventAction.Fallback;
+    flowId: string;
+    flowName: string;
+    flowNodeId: string;
+    flowNodeContentId: string;
+    userInput: string;
+    fallbackOut: number;
+    fallbackMessageId: string;
+}
+export interface EventWebviewStep extends HtBaseEventProps {
+    action: EventAction.WebviewStep;
+    flowThreadId?: string;
+    webviewThreadId: string;
+    webviewName: string;
+    webviewStepName: string;
+    webviewStepNumber: number;
+}
+export interface EventWebviewEnd extends HtBaseEventProps {
+    action: EventAction.WebviewEnd;
+    flowThreadId?: string;
+    webviewThreadId: string;
+    webviewName: string;
+    webviewStepName?: string;
+    webviewStepNumber?: number;
+    webviewEndFailType?: WebviewEndFailType;
+    webviewEndFailMessage?: string;
+}
+export declare enum WebviewEndFailType {
+    CanceledByUser = "canceled_by_user",
+    ApiError = "api_error",
+    NeedsEscalation = "needs_escalation"
+}
+export interface EventCustom extends HtBaseEventProps {
+    action: EventAction.Custom;
+    customFields?: Record<string, any>;
+    customSensitiveFields?: Record<string, any>;
+}
+export type HtEventProps = EventCaptureUserInput | EventFeedback | EventFeedbackKnowledgebase | EventFlow | EventBotAction | EventConditionalChannel | EventConditionalCountry | EventConditionalCustom | EventConditionalQueueStatus | EventHandoff | EventHandoffOption | EventKeyword | EventIntentSmart | EventKnowledgeBase | EventWebviewActionTriggered | EventFallback | EventWebviewStep | EventWebviewEnd | EventCustom | EventAiAgent | EventRedirectFlow;

package/src/lib/hubtype-analytics-types.js

@@ -0,0 +1,41 @@
+export const EVENT_FORMAT_VERSION = 5;
+export var EventAction;
+(function (EventAction) {
+    EventAction["AiAgent"] = "ai_agent";
+    EventAction["FeedbackCase"] = "feedback_case";
+    EventAction["FeedbackMessage"] = "feedback_message";
+    EventAction["FeedbackConversation"] = "feedback_conversation";
+    EventAction["FeedbackKnowledgebase"] = "feedback_knowledgebase";
+    EventAction["FeedbackWebview"] = "feedback_webview";
+    EventAction["FlowNode"] = "flow_node";
+    EventAction["ConditionalCountry"] = "conditional_country";
+    EventAction["ConditionalQueueStatus"] = "conditional_queue_status";
+    EventAction["ConditionalCustom"] = "conditional_custom";
+    EventAction["ConditionalChannel"] = "conditional_channel";
+    EventAction["BotAction"] = "bot_action";
+    EventAction["WebviewActionTriggered"] = "webview_action_triggered";
+    EventAction["HandoffOption"] = "handoff_option";
+    EventAction["HandoffSuccess"] = "handoff_success";
+    EventAction["HandoffFail"] = "handoff_fail";
+    EventAction["Keyword"] = "nlu_keyword";
+    EventAction["IntentSmart"] = "nlu_intent_smart";
+    EventAction["Knowledgebase"] = "knowledgebase";
+    EventAction["Fallback"] = "fallback";
+    EventAction["WebviewStep"] = "webview_step";
+    EventAction["WebviewEnd"] = "webview_end";
+    EventAction["Custom"] = "custom";
+    EventAction["RedirectFlow"] = "redirect_flow";
+    EventAction["CaptureUserInput"] = "capture_user_input";
+})(EventAction || (EventAction = {}));
+export var KnowledgebaseFailReason;
+(function (KnowledgebaseFailReason) {
+    KnowledgebaseFailReason["NoKnowledge"] = "no_knowledge";
+    KnowledgebaseFailReason["Hallucination"] = "hallucination";
+})(KnowledgebaseFailReason || (KnowledgebaseFailReason = {}));
+export var WebviewEndFailType;
+(function (WebviewEndFailType) {
+    WebviewEndFailType["CanceledByUser"] = "canceled_by_user";
+    WebviewEndFailType["ApiError"] = "api_error";
+    WebviewEndFailType["NeedsEscalation"] = "needs_escalation";
+})(WebviewEndFailType || (WebviewEndFailType = {}));
+//# sourceMappingURL=hubtype-analytics-types.js.map

package/src/lib/hubtype-analytics-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hubtype-analytics-types.js","sourceRoot":"","sources":["../../../../../../libs/botonic/shared/src/lib/hubtype-analytics-types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AAErC,MAAM,CAAN,IAAY,WA0BX;AA1BD,WAAY,WAAW;IACrB,mCAAoB,CAAA;IACpB,6CAA8B,CAAA;IAC9B,mDAAoC,CAAA;IACpC,6DAA8C,CAAA;IAC9C,+DAAgD,CAAA;IAChD,mDAAoC,CAAA;IACpC,qCAAsB,CAAA;IACtB,yDAA0C,CAAA;IAC1C,kEAAmD,CAAA;IACnD,uDAAwC,CAAA;IACxC,yDAA0C,CAAA;IAC1C,uCAAwB,CAAA;IACxB,kEAAmD,CAAA;IACnD,+CAAgC,CAAA;IAChC,iDAAkC,CAAA;IAClC,2CAA4B,CAAA;IAC5B,sCAAuB,CAAA;IACvB,+CAAgC,CAAA;IAChC,8CAA+B,CAAA;IAC/B,oCAAqB,CAAA;IACrB,2CAA4B,CAAA;IAC5B,yCAA0B,CAAA;IAC1B,gCAAiB,CAAA;IACjB,6CAA8B,CAAA;IAC9B,sDAAuC,CAAA;AACzC,CAAC,EA1BW,WAAW,KAAX,WAAW,QA0BtB;AAqJD,MAAM,CAAN,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,uDAA4B,CAAA;IAC5B,0DAA+B,CAAA;AACjC,CAAC,EAHW,uBAAuB,KAAvB,uBAAuB,QAGlC;AAgED,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,yDAAmC,CAAA;IACnC,4CAAsB,CAAA;IACtB,0DAAoC,CAAA;AACtC,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B"}

package/src/lib/index.d.ts

@@ -0,0 +1,6 @@
+export { MessagingChannel } from './shared-types';
+export * from './services/webchat-api';
+export * from './ai-agents-types';
+export * from './hubtype-analytics-types';
+export * from './domain';
+export * from './utils';

package/src/lib/index.js

@@ -0,0 +1,13 @@
+// Export base types first
+export { MessagingChannel } from './shared-types'; // InputType, HelpdeskEvent already exported in domain
+// Export services
+export * from './services/webchat-api';
+// Export AI agents types
+export * from './ai-agents-types';
+// Export Hubtype analytics types
+export * from './hubtype-analytics-types';
+// Export domain types
+export * from './domain';
+// Export utils
+export * from './utils';
+//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/botonic/shared/src/lib/index.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA,CAAC,sDAAsD;AAExG,kBAAkB;AAClB,cAAc,wBAAwB,CAAA;AAEtC,yBAAyB;AACzB,cAAc,mBAAmB,CAAA;AAEjC,iCAAiC;AACjC,cAAc,2BAA2B,CAAA;AAEzC,sBAAsB;AACtB,cAAc,UAAU,CAAA;AAExB,eAAe;AACf,cAAc,SAAS,CAAA"}

package/src/lib/services/webchat-api.d.ts

@@ -0,0 +1,16 @@
+import { UserInputMessage } from '../domain/webchat';
+export type HubtypeUserLocale = {
+    locale?: string;
+    country?: string;
+    system_locale?: string;
+};
+export type HubtypeUser = {
+    id: string;
+    username?: string;
+    name?: string;
+    extra_data?: Record<string, any>;
+} & HubtypeUserLocale;
+export interface HubtypeMessage {
+    sender: HubtypeUser;
+    message: UserInputMessage;
+}

package/src/lib/services/webchat-api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=webchat-api.js.map

package/src/lib/services/webchat-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webchat-api.js","sourceRoot":"","sources":["../../../../../../../libs/botonic/shared/src/lib/services/webchat-api.ts"],"names":[],"mappings":""}

package/src/lib/shared-types.d.ts

@@ -0,0 +1,28 @@
+export declare enum MessagingChannel {
+    Webchat = "webchat",
+    Whatsapp = "whatsapp",
+    Facebook = "facebook",
+    Telegram = "telegram",
+    Instagram = "instagram",
+    Twitter = "twitter",// TODO: Review if we need this
+    Dev = "dev"
+}
+export declare enum HelpdeskEvent {
+    StatusChanged = "status_changed",
+    AgentMessageCreated = "agent_message_created",
+    QueuePositionChanged = "queue_position_changed"
+}
+export declare enum InputType {
+    Text = "text",
+    Image = "image",
+    Video = "video",
+    Audio = "audio",
+    Document = "document",
+    Location = "location",
+    Contact = "contact",
+    Custom = "custom",
+    Raw = "raw",
+    CaseEventQueuePosition = "case_event_queue_position",
+    Postback = "postback",
+    Event = "event"
+}

package/src/lib/shared-types.js

@@ -0,0 +1,32 @@
+export var MessagingChannel;
+(function (MessagingChannel) {
+    MessagingChannel["Webchat"] = "webchat";
+    MessagingChannel["Whatsapp"] = "whatsapp";
+    MessagingChannel["Facebook"] = "facebook";
+    MessagingChannel["Telegram"] = "telegram";
+    MessagingChannel["Instagram"] = "instagram";
+    MessagingChannel["Twitter"] = "twitter";
+    MessagingChannel["Dev"] = "dev";
+})(MessagingChannel || (MessagingChannel = {}));
+export var HelpdeskEvent;
+(function (HelpdeskEvent) {
+    HelpdeskEvent["StatusChanged"] = "status_changed";
+    HelpdeskEvent["AgentMessageCreated"] = "agent_message_created";
+    HelpdeskEvent["QueuePositionChanged"] = "queue_position_changed";
+})(HelpdeskEvent || (HelpdeskEvent = {}));
+export var InputType;
+(function (InputType) {
+    InputType["Text"] = "text";
+    InputType["Image"] = "image";
+    InputType["Video"] = "video";
+    InputType["Audio"] = "audio";
+    InputType["Document"] = "document";
+    InputType["Location"] = "location";
+    InputType["Contact"] = "contact";
+    InputType["Custom"] = "custom";
+    InputType["Raw"] = "raw";
+    InputType["CaseEventQueuePosition"] = "case_event_queue_position";
+    InputType["Postback"] = "postback";
+    InputType["Event"] = "event";
+})(InputType || (InputType = {}));
+//# sourceMappingURL=shared-types.js.map

package/src/lib/shared-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-types.js","sourceRoot":"","sources":["../../../../../../libs/botonic/shared/src/lib/shared-types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,yCAAqB,CAAA;IACrB,yCAAqB,CAAA;IACrB,yCAAqB,CAAA;IACrB,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,+BAAW,CAAA;AACb,CAAC,EARW,gBAAgB,KAAhB,gBAAgB,QAQ3B;AAED,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,8DAA6C,CAAA;IAC7C,gEAA+C,CAAA;AACjD,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAED,MAAM,CAAN,IAAY,SAaX;AAbD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,wBAAW,CAAA;IACX,iEAAoD,CAAA;IACpD,kCAAqB,CAAA;IACrB,4BAAe,CAAA;AACjB,CAAC,EAbW,SAAS,KAAT,SAAS,QAapB"}

package/src/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './logging';

package/src/lib/utils/index.js

@@ -0,0 +1,2 @@
+export * from './logging';
+//# sourceMappingURL=index.js.map

package/src/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../libs/botonic/shared/src/lib/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/src/lib/utils/logging.d.ts

@@ -0,0 +1 @@
+export declare function structuredLog(label: string, obj: unknown, logLevel?: 'info' | 'error'): void;

package/src/lib/utils/logging.js

@@ -0,0 +1,22 @@
+export function structuredLog(label, obj, logLevel = 'info') {
+    const safeStringify = (value) => {
+        try {
+            return JSON.stringify(value, (_key, val) => {
+                // Remove circular references by skipping problematic objects
+                if (typeof val === 'object' && val !== null) {
+                    if (val instanceof Map)
+                        return Object.fromEntries(val);
+                    if (val instanceof Set)
+                        return Array.from(val);
+                }
+                return val;
+            }, 2);
+        }
+        catch (_a) {
+            return '[Unserializable Object]';
+        }
+    };
+    console[logLevel](label);
+    console[logLevel](`\n${safeStringify(obj)}`);
+}
+//# sourceMappingURL=logging.js.map

package/src/lib/utils/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../../../../../../libs/botonic/shared/src/lib/utils/logging.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,aAAa,CAC3B,KAAa,EACb,GAAY,EACZ,WAA6B,MAAM;IAEnC,MAAM,aAAa,GAAG,CAAC,KAAc,EAAU,EAAE;QAC/C,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,EACL,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;gBACZ,6DAA6D;gBAC7D,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;oBAC5C,IAAI,GAAG,YAAY,GAAG;wBAAE,OAAO,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;oBACtD,IAAI,GAAG,YAAY,GAAG;wBAAE,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAChD,CAAC;gBACD,OAAO,GAAG,CAAA;YACZ,CAAC,EACD,CAAC,CACF,CAAA;QACH,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,yBAAyB,CAAA;QAClC,CAAC;IACH,CAAC,CAAA;IAED,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAA;IACxB,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;AAC9C,CAAC"}