@botonic/core 0.19.0 → 0.20.2-alpha.0

package/lib/esm/models/events/message/custom.js

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

package/lib/esm/models/events/message/custom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../../../../src/models/events/message/custom.ts"],"names":[],"mappings":""}

package/lib/esm/models/events/message/index.d.ts

@@ -0,0 +1,9 @@
+export * from './buttons';
+export * from './carousel';
+export * from './custom';
+export * from './location';
+export * from './media';
+export * from './message-event';
+export * from './postback';
+export * from './replies';
+export * from './text';

package/lib/esm/models/events/message/index.js

@@ -0,0 +1,10 @@
+export * from './buttons';
+export * from './carousel';
+export * from './custom';
+export * from './location';
+export * from './media';
+export * from './message-event';
+export * from './postback';
+export * from './replies';
+export * from './text';
+//# sourceMappingURL=index.js.map

package/lib/esm/models/events/message/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/models/events/message/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AACvB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,QAAQ,CAAA"}

package/lib/esm/models/events/message/location.d.ts

@@ -0,0 +1,6 @@
+import { BotonicMessageEvent, MessageEventTypes } from './message-event';
+export interface LocationMessageEvent extends BotonicMessageEvent {
+    type: MessageEventTypes.LOCATION;
+    lat: number;
+    long: number;
+}

package/lib/esm/models/events/message/location.js

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

package/lib/esm/models/events/message/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../../../src/models/events/message/location.ts"],"names":[],"mappings":""}

package/lib/esm/models/events/message/media.d.ts

@@ -0,0 +1,18 @@
+import { WithButtons } from './buttons';
+import { BotonicMessageEvent, MessageEventTypes } from './message-event';
+export declare const MEDIA_TYPES: MessageEventTypes[];
+export interface MediaMessageEvent extends BotonicMessageEvent, WithButtons {
+    src: string;
+}
+export interface AudioMessageEvent extends MediaMessageEvent {
+    type: MessageEventTypes.AUDIO;
+}
+export interface ImageMessageEvent extends MediaMessageEvent {
+    type: MessageEventTypes.IMAGE;
+}
+export interface DocumentMessageEvent extends MediaMessageEvent {
+    type: MessageEventTypes.DOCUMENT;
+}
+export interface VideoMessageEvent extends MediaMessageEvent {
+    type: MessageEventTypes.VIDEO;
+}

package/lib/esm/models/events/message/media.js

@@ -0,0 +1,8 @@
+import { MessageEventTypes } from './message-event';
+export const MEDIA_TYPES = [
+    MessageEventTypes.AUDIO,
+    MessageEventTypes.IMAGE,
+    MessageEventTypes.DOCUMENT,
+    MessageEventTypes.VIDEO,
+];
+//# sourceMappingURL=media.js.map

package/lib/esm/models/events/message/media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media.js","sourceRoot":"","sources":["../../../../../src/models/events/message/media.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAExE,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,iBAAiB,CAAC,KAAK;IACvB,iBAAiB,CAAC,KAAK;IACvB,iBAAiB,CAAC,QAAQ;IAC1B,iBAAiB,CAAC,KAAK;CACxB,CAAA"}

package/lib/esm/models/events/message/message-event.d.ts

@@ -0,0 +1,30 @@
+import { BaseEvent } from '../base-event';
+export declare enum MessageEventTypes {
+    AUDIO = "audio",
+    CAROUSEL = "carousel",
+    CUSTOM = "custom",
+    DOCUMENT = "document",
+    IMAGE = "image",
+    LOCATION = "location",
+    TEXT = "text",
+    POSTBACK = "postback",
+    VIDEO = "video"
+}
+export declare enum MessageEventAck {
+    DRAFT = "draft",
+    READ = "read",
+    RECEIVED = "received",
+    SENT = "sent"
+}
+export declare enum MessageEventFrom {
+    AGENT = "agent",
+    BOT = "bot",
+    USER = "user"
+}
+export interface BotonicMessageEvent extends BaseEvent {
+    ack: MessageEventAck;
+    from: MessageEventFrom;
+    type: MessageEventTypes;
+    typing: number;
+    delay: number;
+}

package/lib/esm/models/events/message/message-event.js

@@ -0,0 +1,29 @@
+export var MessageEventTypes;
+(function (MessageEventTypes) {
+    MessageEventTypes["AUDIO"] = "audio";
+    MessageEventTypes["CAROUSEL"] = "carousel";
+    MessageEventTypes["CUSTOM"] = "custom";
+    MessageEventTypes["DOCUMENT"] = "document";
+    MessageEventTypes["IMAGE"] = "image";
+    MessageEventTypes["LOCATION"] = "location";
+    MessageEventTypes["TEXT"] = "text";
+    MessageEventTypes["POSTBACK"] = "postback";
+    MessageEventTypes["VIDEO"] = "video";
+    /**
+     * TODO: contact, buttonmessage?, webchatsettings, whatsapp template
+     */
+})(MessageEventTypes || (MessageEventTypes = {}));
+export var MessageEventAck;
+(function (MessageEventAck) {
+    MessageEventAck["DRAFT"] = "draft";
+    MessageEventAck["READ"] = "read";
+    MessageEventAck["RECEIVED"] = "received";
+    MessageEventAck["SENT"] = "sent";
+})(MessageEventAck || (MessageEventAck = {}));
+export var MessageEventFrom;
+(function (MessageEventFrom) {
+    MessageEventFrom["AGENT"] = "agent";
+    MessageEventFrom["BOT"] = "bot";
+    MessageEventFrom["USER"] = "user";
+})(MessageEventFrom || (MessageEventFrom = {}));
+//# sourceMappingURL=message-event.js.map

package/lib/esm/models/events/message/message-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-event.js","sourceRoot":"","sources":["../../../../../src/models/events/message/message-event.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,iBAaX;AAbD,WAAY,iBAAiB;IAC3B,oCAAe,CAAA;IACf,0CAAqB,CAAA;IACrB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,oCAAe,CAAA;IACf,0CAAqB,CAAA;IACrB,kCAAa,CAAA;IACb,0CAAqB,CAAA;IACrB,oCAAe,CAAA;IACf;;OAEG;AACL,CAAC,EAbW,iBAAiB,KAAjB,iBAAiB,QAa5B;AAED,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,gCAAa,CAAA;IACb,wCAAqB,CAAA;IACrB,gCAAa,CAAA;AACf,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B;AAED,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,+BAAW,CAAA;IACX,iCAAa,CAAA;AACf,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B"}

package/lib/esm/models/events/message/postback.d.ts

@@ -0,0 +1,4 @@
+import { BotonicMessageEvent } from './message-event';
+export interface PostbackMessageEvent extends BotonicMessageEvent {
+    payload: string;
+}

package/lib/esm/models/events/message/postback.js

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

package/lib/esm/models/events/message/postback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"postback.js","sourceRoot":"","sources":["../../../../../src/models/events/message/postback.ts"],"names":[],"mappings":""}

package/lib/esm/models/events/message/replies.d.ts

@@ -0,0 +1,7 @@
+export interface Reply {
+    title: string;
+    payload: string;
+}
+export interface WithReplies {
+    replies?: Reply[];
+}

package/lib/esm/models/events/message/replies.js

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

package/lib/esm/models/events/message/replies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replies.js","sourceRoot":"","sources":["../../../../../src/models/events/message/replies.ts"],"names":[],"mappings":""}

package/lib/esm/models/events/message/text.d.ts

@@ -0,0 +1,8 @@
+import { WithButtons } from './buttons';
+import { BotonicMessageEvent, MessageEventTypes } from './message-event';
+import { WithReplies } from './replies';
+export interface TextMessageEvent extends BotonicMessageEvent, WithReplies, WithButtons {
+    type: MessageEventTypes.TEXT;
+    markdown: boolean;
+    text: string;
+}

package/lib/esm/models/events/message/text.js

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

package/lib/esm/models/events/message/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../../src/models/events/message/text.ts"],"names":[],"mappings":""}

package/lib/esm/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './events';
+export * from './legacy-types';
+export * from './user';

package/lib/esm/models/index.js

@@ -0,0 +1,4 @@
+export * from './events';
+export * from './legacy-types';
+export * from './user';
+//# sourceMappingURL=index.js.map

package/lib/esm/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,QAAQ,CAAA"}

package/lib/esm/models/legacy-types.d.ts

@@ -0,0 +1,207 @@
+import { DataProvider } from '../data-provider';
+import { BotonicEvent } from './events';
+export declare type CaseStatusType = typeof CASE_STATUS.ATTENDING | typeof CASE_STATUS.IDLE | typeof CASE_STATUS.RESOLVED | typeof CASE_STATUS.WAITING;
+export declare type CaseResolution = typeof CASE_RESOLUTION.BANNED | typeof CASE_RESOLUTION.NOK | typeof CASE_RESOLUTION.NOT_SOLVED | typeof CASE_RESOLUTION.OK;
+export declare const PROVIDER: Readonly<{
+    DEV: string;
+    FACEBOOK: string;
+    GENERIC: string;
+    INTERCOM: string;
+    SMOOCH: string;
+    TELEGRAM: string;
+    TWITTER: string;
+    WEBCHAT: string;
+    WECHAT: string;
+    WHATSAPP: string;
+}>;
+export declare const INPUT: Readonly<{
+    TEXT: string;
+    POSTBACK: string;
+    AUDIO: string;
+    IMAGE: string;
+    VIDEO: string;
+    DOCUMENT: string;
+    LOCATION: string;
+    CONTACT: string;
+    BUTTON_MESSAGE: string;
+    CAROUSEL: string;
+    CUSTOM: string;
+    WEBCHAT_SETTINGS: string;
+    WHATSAPP_TEMPLATE: string;
+    RAW: string;
+}>;
+export declare const CASE_STATUS: Readonly<{
+    WAITING: string;
+    ATTENDING: string;
+    IDLE: string;
+    RESOLVED: string;
+}>;
+export declare const CASE_RESOLUTION: Readonly<{
+    OK: string;
+    NOK: string;
+    NOT_SOLVED: string;
+    BANNED: string;
+}>;
+export interface Locales {
+    [id: string]: string | string[] | Locales;
+}
+interface PluginConstructor<T> {
+    new (arg: T): Plugin;
+}
+export interface PluginConfig<T> {
+    id: string;
+    options?: T;
+    resolve: {
+        default: PluginConstructor<T>;
+    };
+}
+export declare type InputType = typeof INPUT.AUDIO | typeof INPUT.BUTTON_MESSAGE | typeof INPUT.CAROUSEL | typeof INPUT.CONTACT | typeof INPUT.CUSTOM | typeof INPUT.DOCUMENT | typeof INPUT.IMAGE | typeof INPUT.LOCATION | typeof INPUT.POSTBACK | typeof INPUT.TEXT | typeof INPUT.VIDEO | typeof INPUT.WEBCHAT_SETTINGS | typeof INPUT.WHATSAPP_TEMPLATE;
+export interface IntentResult {
+    intent: string;
+    confidence: number;
+}
+/** Generated by Translation plugins: GoogleTranslation **/
+export interface Translations {
+    [languageCode: string]: string;
+}
+/** Fields set by NLU plugins: Luis, Dialogflow, ... **/
+export interface NluResult {
+    confidence: number;
+    intent: string;
+    intents: IntentResult[];
+    language: string;
+    entities?: any;
+    translations: Translations;
+}
+export interface Input extends Partial<NluResult> {
+    text?: string;
+    src?: string;
+    data?: string;
+    path?: string;
+    payload?: string;
+    type: InputType;
+}
+export declare type ProviderType = typeof PROVIDER.DEV | typeof PROVIDER.FACEBOOK | typeof PROVIDER.GENERIC | typeof PROVIDER.INTERCOM | typeof PROVIDER.SMOOCH | typeof PROVIDER.TELEGRAM | typeof PROVIDER.TWITTER | typeof PROVIDER.WEBCHAT | typeof PROVIDER.WECHAT | typeof PROVIDER.WHATSAPP;
+export interface SessionUser {
+    id: string;
+    username?: string;
+    name?: string;
+    provider: ProviderType;
+    extra_data?: any;
+    imp_id?: string;
+    provider_id?: string;
+}
+export interface Session {
+    bot: {
+        id: string;
+        name?: string;
+    };
+    __locale?: string;
+    __retries: number;
+    is_first_interaction: boolean;
+    last_session?: any;
+    organization?: string;
+    user: SessionUser;
+    _hubtype_case_status?: CaseStatusType;
+    _hubtype_case_typification?: string;
+    _shadowing?: boolean;
+}
+export declare type InputMatcher = (input: Input) => boolean;
+export declare type ParamsMatcher = {
+    [key: string]: string;
+} | ((params: {
+    [key: string]: string;
+}) => boolean);
+export declare type SessionMatcher = (session: Session) => boolean;
+export declare type RequestMatcher = (request: BotRequest) => boolean;
+export declare type StringMatcher = RegExp | string | ((data: string) => boolean);
+export declare type RouteMatcher = InputMatcher | ParamsMatcher | RequestMatcher | SessionMatcher | StringMatcher;
+export interface Route {
+    action?: any;
+    childRoutes?: Route[];
+    lastRoutePath?: string;
+    ignoreRetry?: boolean;
+    path: RoutePath;
+    redirect?: string;
+    retry?: number;
+    input?: InputMatcher;
+    intent?: StringMatcher;
+    params?: ParamsMatcher;
+    payload?: StringMatcher;
+    request?: RequestMatcher;
+    session?: SessionMatcher;
+    text?: StringMatcher;
+    data?: StringMatcher;
+    type?: StringMatcher;
+}
+export declare type Routes<R = Route> = R[] | ((_: BotRequest) => R[]);
+export interface BotRequest {
+    input: Input;
+    lastRoutePath: RoutePath;
+    session: Session;
+    dataProvider?: DataProvider;
+}
+/** The response of the bot for the triggered actions, which can be
+ * the one matched by the routes, the default action and the retry actions.
+ * See Response at @botonic/react's index.d.ts for the React type
+ * */
+export interface BotResponse extends BotRequest {
+    response: any;
+    messageEvents: Partial<BotonicEvent>[] | null;
+}
+export interface PluginPreRequest extends BotRequest {
+    plugins: Plugin[];
+}
+export interface PluginPostRequest extends BotResponse {
+    plugins: Plugin[];
+}
+export interface Plugin {
+    post(request: PluginPostRequest): void;
+    pre(request: PluginPreRequest): void;
+}
+export interface Params {
+    [key: string]: any;
+}
+export declare const Providers: Readonly<{
+    Messaging: {
+        FACEBOOK: string;
+        GENERIC: string;
+        IMBEE: string;
+        INTERCOM: string;
+        SMOOCH_WEB: string;
+        SMOOCH: string;
+        TELEGRAM: string;
+        TWITTER: string;
+        WEBCHAT: string;
+        WECHAT: string;
+        WHATSAPP: string;
+    };
+}>;
+export declare type Nullable<T> = T | null;
+export declare type Action = Nullable<() => any>;
+export declare type RoutePath = Nullable<string>;
+export interface ProcessInputResult {
+    action: Action;
+    emptyAction: Action;
+    fallbackAction: Action;
+    lastRoutePath: RoutePath;
+    params: Params;
+}
+export declare type MatchedValue = boolean | RegExpExecArray | null;
+export declare type RoutingState = {
+    currentRoute: Nullable<Route>;
+    matchedRoute: Nullable<Route>;
+    params: Params;
+    isFlowBroken: boolean;
+};
+export interface RouteParams {
+    route: Nullable<Route>;
+    params: Params;
+}
+export interface PathParams {
+    path: RoutePath;
+    params: Params;
+}
+export declare type MatchingProp = 'text' | 'payload' | 'intent' | 'type' | 'input' | 'session' | 'request';
+export declare type Matcher = string | RegExp | ((args: any) => boolean);
+export {};

package/lib/esm/models/legacy-types.js

@@ -0,0 +1,57 @@
+// TODO: This file contains all the legacy types we had in index.ts. After some refactors, we should be able to get rid of many of them.
+export const PROVIDER = Object.freeze({
+    DEV: 'dev',
+    FACEBOOK: 'facebook',
+    GENERIC: 'generic',
+    INTERCOM: 'intercom',
+    SMOOCH: 'smooch',
+    TELEGRAM: 'telegram',
+    TWITTER: 'twitter',
+    WEBCHAT: 'webchat',
+    WECHAT: 'wechat',
+    WHATSAPP: 'whatsapp',
+});
+export const INPUT = Object.freeze({
+    TEXT: 'text',
+    POSTBACK: 'postback',
+    AUDIO: 'audio',
+    IMAGE: 'image',
+    VIDEO: 'video',
+    DOCUMENT: 'document',
+    LOCATION: 'location',
+    CONTACT: 'contact',
+    BUTTON_MESSAGE: 'buttonmessage',
+    CAROUSEL: 'carousel',
+    CUSTOM: 'custom',
+    WEBCHAT_SETTINGS: 'webchatsettings',
+    WHATSAPP_TEMPLATE: 'whatsapptemplate',
+    RAW: 'raw',
+});
+export const CASE_STATUS = Object.freeze({
+    WAITING: 'status_waiting',
+    ATTENDING: 'status_attending',
+    IDLE: 'status_idle',
+    RESOLVED: 'status_resolved',
+});
+export const CASE_RESOLUTION = Object.freeze({
+    OK: 'result_ok',
+    NOK: 'result_nok',
+    NOT_SOLVED: 'result_not_solved',
+    BANNED: 'result_banned',
+});
+export const Providers = Object.freeze({
+    Messaging: {
+        FACEBOOK: 'facebook',
+        GENERIC: 'generic',
+        IMBEE: 'imbee',
+        INTERCOM: 'intercom',
+        SMOOCH_WEB: 'smooch_web',
+        SMOOCH: 'smooch',
+        TELEGRAM: 'telegram',
+        TWITTER: 'twitter',
+        WEBCHAT: 'webchat',
+        WECHAT: 'wechat',
+        WHATSAPP: 'whatsapp',
+    },
+});
+//# sourceMappingURL=legacy-types.js.map

package/lib/esm/models/legacy-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legacy-types.js","sourceRoot":"","sources":["../../../src/models/legacy-types.ts"],"names":[],"mappings":"AAAA,wIAAwI;AAiBxI,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACrB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,cAAc,EAAE,eAAe;IAC/B,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,gBAAgB,EAAE,iBAAiB;IACnC,iBAAiB,EAAE,kBAAkB;IACrC,GAAG,EAAE,KAAK;CACX,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC,OAAO,EAAE,gBAAgB;IACzB,SAAS,EAAE,kBAAkB;IAC7B,IAAI,EAAE,aAAa;IACnB,QAAQ,EAAE,iBAAiB;CAC5B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,WAAW;IACf,GAAG,EAAE,YAAY;IACjB,UAAU,EAAE,mBAAmB;IAC/B,MAAM,EAAE,eAAe;CACxB,CAAC,CAAA;AAiLF,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,SAAS,EAAE;QACT,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE,SAAS;QAClB,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,UAAU;QACpB,UAAU,EAAE,YAAY;QACxB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,UAAU;QACpB,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,UAAU;KACrB;CACF,CAAC,CAAA"}

package/lib/esm/models/user.d.ts

@@ -0,0 +1,10 @@
+import { Session } from './legacy-types';
+export interface User {
+    id: string;
+    providerId?: string;
+    websocketId?: string;
+    session: Session;
+    route: string;
+    isOnline: boolean;
+    locationInfo: string;
+}

package/lib/esm/models/user.js

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

package/lib/esm/models/user.js.map

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

package/lib/esm/output-parser/botonic-output-parser.d.ts

@@ -0,0 +1,16 @@
+import { BotonicEvent } from '../models';
+import { MessageParsingFactory } from './factory';
+export declare const TEXT_NODE_NAME = "text";
+export declare class BotonicOutputParser {
+    private readonly factory;
+    private static OPTIONS;
+    constructor(factory?: MessageParsingFactory);
+    xmlToMessageEvents(html: string): Partial<BotonicEvent>[];
+    /**
+     * Right now, when saving BotonicEvents to DataProvider, we need the standarized Botonic event
+     * to be saved. This is, converting a botonic input like: '{id: 'msgId', data: 'rawData', payload: 'somePayload'}'
+     * into a BotonicEvent with the expected properties.
+     */
+    parseFromUserInput(input: any): Partial<BotonicEvent>;
+    private xmlToJSONMessages;
+}

package/lib/esm/output-parser/botonic-output-parser.js

@@ -0,0 +1,33 @@
+// eslint-disable-next-line import/named
+import { parse } from 'fast-xml-parser';
+import { decode } from 'html-entities';
+import { MessageParsingFactory } from './factory';
+export const TEXT_NODE_NAME = 'text';
+export class BotonicOutputParser {
+    constructor(factory = new MessageParsingFactory()) {
+        this.factory = factory;
+    }
+    xmlToMessageEvents(html) {
+        const jsonMessages = this.xmlToJSONMessages(html);
+        return jsonMessages.map(msgToParse => this.factory.parse(msgToParse));
+    }
+    /**
+     * Right now, when saving BotonicEvents to DataProvider, we need the standarized Botonic event
+     * to be saved. This is, converting a botonic input like: '{id: 'msgId', data: 'rawData', payload: 'somePayload'}'
+     * into a BotonicEvent with the expected properties.
+     */
+    parseFromUserInput(input) {
+        return this.factory.parse(input);
+    }
+    xmlToJSONMessages(html) {
+        return parse(html, BotonicOutputParser.OPTIONS).message;
+    }
+}
+BotonicOutputParser.OPTIONS = {
+    ignoreAttributes: false,
+    attributeNamePrefix: '',
+    textNodeName: TEXT_NODE_NAME,
+    arrayMode: true,
+    attrValueProcessor: a => decode(a),
+};
+//# sourceMappingURL=botonic-output-parser.js.map

package/lib/esm/output-parser/botonic-output-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"botonic-output-parser.js","sourceRoot":"","sources":["../../../src/output-parser/botonic-output-parser.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,OAAO,EAAE,KAAK,EAAc,MAAM,iBAAiB,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAGtC,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEjD,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAA;AAEpC,MAAM,OAAO,mBAAmB;IAS9B,YAA6B,UAAU,IAAI,qBAAqB,EAAE;QAArC,YAAO,GAAP,OAAO,CAA8B;IAAG,CAAC;IAEtE,kBAAkB,CAAC,IAAY;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QACjD,OAAO,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAA;IACvE,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,KAAU;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAEO,iBAAiB,CAAC,IAAS;QACjC,OAAO,KAAK,CAAC,IAAI,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC,OAAO,CAAA;IACzD,CAAC;;AA1Bc,2BAAO,GAAwB;IAC5C,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,EAAE;IACvB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,IAAI;IACf,kBAAkB,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;CACnC,CAAA"}

package/lib/esm/output-parser/factory.d.ts

@@ -0,0 +1,4 @@
+import { BotonicEvent } from '../models';
+export declare class MessageParsingFactory {
+    parse(msgToParse: any): Partial<BotonicEvent>;
+}

package/lib/esm/output-parser/factory.js

@@ -0,0 +1,28 @@
+import { MEDIA_TYPES, MessageEventTypes } from '../models';
+import { parseButtons, parseCarousel, parseCustom, parseLocation, parseMedia, parseMessage, parsePostback, parseReplies, parseText, } from './parsers';
+export class MessageParsingFactory {
+    parse(msgToParse) {
+        const type = msgToParse.type;
+        const parsedMessage = parseMessage({ toParse: msgToParse });
+        if (type === MessageEventTypes.TEXT) {
+            return parseText(parseReplies(parseButtons(parsedMessage))).parsed;
+        }
+        if (type === MessageEventTypes.POSTBACK) {
+            return parsePostback(parsedMessage).parsed;
+        }
+        if (MEDIA_TYPES.includes(type)) {
+            return parseMedia(parseButtons(parsedMessage)).parsed;
+        }
+        if (type === MessageEventTypes.LOCATION) {
+            return parseLocation(parsedMessage).parsed;
+        }
+        if (type === MessageEventTypes.CAROUSEL) {
+            return parseCarousel(parsedMessage).parsed;
+        }
+        if (type === MessageEventTypes.CUSTOM) {
+            return parseCustom(parseReplies(parsedMessage)).parsed;
+        }
+        throw new Error(`Parsing for type: '${type}' not implemented.`);
+    }
+}
+//# sourceMappingURL=factory.js.map

package/lib/esm/output-parser/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../src/output-parser/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AACxE,OAAO,EACL,YAAY,EACZ,aAAa,EACb,WAAW,EACX,aAAa,EACb,UAAU,EACV,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,SAAS,GACV,MAAM,WAAW,CAAA;AAElB,MAAM,OAAO,qBAAqB;IAChC,KAAK,CAAC,UAAe;QACnB,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;QAC5B,MAAM,aAAa,GAAG,YAAY,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAA;QAC3D,IAAI,IAAI,KAAK,iBAAiB,CAAC,IAAI,EAAE;YACnC,OAAO,SAAS,CAAC,YAAY,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;SACnE;QACD,IAAI,IAAI,KAAK,iBAAiB,CAAC,QAAQ,EAAE;YACvC,OAAO,aAAa,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;SAC3C;QACD,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC9B,OAAO,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAA;SACtD;QACD,IAAI,IAAI,KAAK,iBAAiB,CAAC,QAAQ,EAAE;YACvC,OAAO,aAAa,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;SAC3C;QACD,IAAI,IAAI,KAAK,iBAAiB,CAAC,QAAQ,EAAE;YACvC,OAAO,aAAa,CAAC,aAAa,CAAC,CAAC,MAAM,CAAA;SAC3C;QACD,IAAI,IAAI,KAAK,iBAAiB,CAAC,MAAM,EAAE;YACrC,OAAO,WAAW,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAA;SACvD;QACD,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,oBAAoB,CAAC,CAAA;IACjE,CAAC;CACF"}

package/lib/esm/output-parser/index.d.ts

@@ -0,0 +1,3 @@
+export * from './botonic-output-parser';
+export * from './factory';
+export * from './parsers';

package/lib/esm/output-parser/index.js

@@ -0,0 +1,4 @@
+export * from './botonic-output-parser';
+export * from './factory';
+export * from './parsers';
+//# sourceMappingURL=index.js.map

package/lib/esm/output-parser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/output-parser/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA"}

package/lib/esm/output-parser/parsers.d.ts

@@ -0,0 +1,22 @@
+import { AudioMessageEvent, BotonicMessageEvent, Button, CarouselElement, CarouselMessageEvent, CustomMessageEvent, DocumentMessageEvent, ImageMessageEvent, LocationMessageEvent, PostbackMessageEvent, Reply, TextMessageEvent, VideoMessageEvent, WithButtons, WithReplies } from '../models';
+export declare function parseNumber(strNumber: string): number;
+export declare function parseBoolean(strNumber: string): boolean;
+export declare type ParseFunction<Out> = (args: {
+    toParse: any;
+    parsed?: any;
+}) => {
+    toParse: any;
+    parsed: Partial<Out>;
+};
+export declare const parseMessage: ParseFunction<BotonicMessageEvent>;
+export declare const parseButton: (button: any) => Button;
+export declare const parseButtons: ParseFunction<WithButtons>;
+export declare const parseReply: (reply: any) => Reply;
+export declare const parseReplies: ParseFunction<WithReplies>;
+export declare const parseText: ParseFunction<TextMessageEvent>;
+export declare const parsePostback: ParseFunction<PostbackMessageEvent>;
+export declare const parseMedia: ParseFunction<AudioMessageEvent | DocumentMessageEvent | ImageMessageEvent | VideoMessageEvent>;
+export declare const parseLocation: ParseFunction<LocationMessageEvent>;
+export declare const parseElement: (element: any) => CarouselElement;
+export declare const parseCarousel: ParseFunction<CarouselMessageEvent>;
+export declare const parseCustom: ParseFunction<CustomMessageEvent>;