@asksuite/askflow-app-sdk 0.1.1 → 0.1.3

package/dist/default-fields.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Enum with default fields.
+ * @readonly
+ * @enum {string}
+ */
+export declare enum DefaultFieldEnum {
+    /** @member {string} */
+    /** Lead Name <string> */
+    name = "name",
+    /** @member {string} */
+    /** Lead Email <string> */
+    email = "email",
+    /** @member {string} */
+    /** Lead Tags <string[]> */
+    tags = "tags",
+    /** @member {string} */
+    /** Lead tags separated by comma <string> */
+    tagsString = "tagsString",
+    /** @member {string} */
+    /** Conversation channel <string> */
+    platform = "platform",
+    /** @member {string} */
+    /** Lead phone <string> */
+    phone = "phone",
+    /** @member {string} */
+    /** Lead city <string> */
+    city = "city",
+    /** @member {string} */
+    /** Lead state <string> */
+    state = "state",
+    /** @member {string} */
+    /** Lead country <string> */
+    country = "country",
+    /** @member {string} */
+    /** Lead arrival date <Date> */
+    arrivalDate = "arrivalDate",
+    /** @member {string} */
+    /** Lead departure date <Date> */
+    departureDate = "departureDate",
+    /** @member {string} */
+    /** Lead language <string> */
+    language = "language",
+    /** @member {string} */
+    /** Number of adults on the quote <integer> */
+    adults = "adults",
+    /** @member {string} */
+    /** Number of children on the quote <integer> */
+    children = "children",
+    /** @member {string} */
+    /** Last message date <Date> */
+    updatedAt = "updatedAt",
+    /** @member {string} */
+    /** Quotation <boolean> */
+    requestPrice = "requestPrice",
+    /** @member {string} */
+    /** Event quote <boolean> */
+    eventQuote = "eventQuote",
+    /** @member {string} */
+    /** Group quote <boolean> */
+    groupQuote = "groupQuote",
+    /** @member {string} */
+    /** Opened a quote link <boolean> */
+    linkQuotationOpened = "linkQuotationOpened",
+    /** @member {string} */
+    /** utm_source parameter on the conversation's url <string> */
+    utmSource = "utmSource",
+    /** @member {string} */
+    /** utm_medium parameter on the conversation's url <string> */
+    utmMedium = "utmMedium",
+    /** @member {string} */
+    /** utm_campaign parameter on the conversation's url <string> */
+    utmCampaign = "utmCampaign",
+    /** @member {string} */
+    /** Chat Origin <string> */
+    page = "page",
+    /** @member {string} */
+    /** Link to the conversation within the Asksuite platform <string> */
+    linkToLiveChat = "linkToLiveChat",
+    /** @member {string} */
+    /** Finished a reservation <boolean> */
+    hasReservation = "hasReservation",
+    /** @member {string} */
+    /** Total reservation value <string> */
+    totalReservation = "totalReservation",
+    /** @member {string} */
+    /** Price quote total value (Minimum) <string> */
+    minTotalValuePriceQuote = "minTotalValuePriceQuote",
+    /** @member {string} */
+    /** Price quote total value (Maximum) <string> */
+    maxTotalValuePriceQuote = "maxTotalValuePriceQuote",
+    /** @member {string} */
+    /** Price quote currency (Maximum) <string> */
+    currencyPriceQuote = "currencyPriceQuote",
+    /** @member {string} */
+    /** Name of the person who answered the conversation <string> */
+    attendant = "attendant",
+    /** @member {string} */
+    /** Email of the person who answered the conversation <string> */
+    attendantEmail = "attendantEmail",
+    /** @member {string} */
+    /** Company name <string> */
+    companyName = "companyName",
+    /** @member {string} */
+    /** Conversation ID <string> */
+    conversationId = "conversationId",
+    /** @member {string} */
+    /** ReservationCode <string> */
+    hotelReservationId = "hotelReservationId"
+}

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { IContext, IEvent, IManifest, IResponseDynamicData, IResponseEvent } from "./types";
+export type { IContext, IEvent, IManifest, IOutputData, IResponseEvent, II18nData, IArgument, ISource, IQueryItem, IDependsOn, ISelectItem, IResponseDynamicData } from "./types";
+export { ArgumentTypeEnum, EventTypeEnum, EventTriggerEnum } from "./types";
+export { DefaultFieldEnum } from "./default-fields";
+export declare abstract class AppFlow {
+    protected readonly context: IContext;
+    protected events: IEvent[];
+    protected eventsByKey: Map<string, IEvent>;
+    protected executors: Map<IEvent, (context: IContext) => Promise<IResponseEvent>>;
+    protected dynamicDataExecutors: Map<string, (context: IContext) => Promise<IResponseDynamicData>>;
+    protected constructor(context: IContext);
+    registerEvent(event: IEvent, executor: (context: IContext) => Promise<IResponseEvent>): void;
+    registerDynamicData(key: string, executor: (context: IContext) => Promise<IResponseDynamicData>): void;
+    abstract getManifest(): Promise<IManifest>;
+    abstract checkConnection(): Promise<boolean>;
+    listEvents(): IEvent[];
+    getEvent(key: string): IEvent | undefined;
+    executeEvent(event: IEvent | string): Promise<IResponseEvent>;
+    getDynamicData(key: string): Promise<IResponseDynamicData>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+var e,t,n,r;exports.ArgumentTypeEnum=void 0,(e=exports.ArgumentTypeEnum||(exports.ArgumentTypeEnum={})).string="string",e.url="url",e.email="email",e.phone="phone",e.number="number",e.boolean="boolean",e.select="select",e.selectItem="selectItem",e.multiselect="multiselect",e.date="date",e.timestamp="timestamp",exports.EventTriggerEnum=void 0,(t=exports.EventTriggerEnum||(exports.EventTriggerEnum={})).webhook="webhook",t.polling="polling",t.step="step",exports.EventTypeEnum=void 0,(n=exports.EventTypeEnum||(exports.EventTypeEnum={})).action="action",n.query="query",exports.DefaultFieldEnum=void 0,(r=exports.DefaultFieldEnum||(exports.DefaultFieldEnum={})).name="name",r.email="email",r.tags="tags",r.tagsString="tagsString",r.platform="platform",r.phone="phone",r.city="city",r.state="state",r.country="country",r.arrivalDate="arrivalDate",r.departureDate="departureDate",r.language="language",r.adults="adults",r.children="children",r.updatedAt="updatedAt",r.requestPrice="requestPrice",r.eventQuote="eventQuote",r.groupQuote="groupQuote",r.linkQuotationOpened="linkQuotationOpened",r.utmSource="utmSource",r.utmMedium="utmMedium",r.utmCampaign="utmCampaign",r.page="page",r.linkToLiveChat="linkToLiveChat",r.hasReservation="hasReservation",r.totalReservation="totalReservation",r.minTotalValuePriceQuote="minTotalValuePriceQuote",r.maxTotalValuePriceQuote="maxTotalValuePriceQuote",r.currencyPriceQuote="currencyPriceQuote",r.attendant="attendant",r.attendantEmail="attendantEmail",r.companyName="companyName",r.conversationId="conversationId",r.hotelReservationId="hotelReservationId",exports.AppFlow=/*#__PURE__*/function(){function e(e){this.context=void 0,this.events=[],this.eventsByKey=void 0,this.executors=new Map,this.dynamicDataExecutors=new Map,this.context=e,this.eventsByKey=new Map}var t=e.prototype;return t.registerEvent=function(e,t){this.events.push(e),this.eventsByKey.set(e.key,e),this.executors.set(e,t)},t.registerDynamicData=function(e,t){this.dynamicDataExecutors.set(e,t)},t.listEvents=function(){return this.events},t.getEvent=function(e){return this.eventsByKey.get(e)},t.executeEvent=function(e){try{var t,n,r=this,o=(n="string"==typeof e||e instanceof String?r.getEvent(String(e)):e)?r.executors.get(n):void 0;if(o)return Promise.resolve(o(r.context));throw new Error("Event "+((null==(t=n)?void 0:t.label)||e)+" not found")}catch(e){return Promise.reject(e)}},t.getDynamicData=function(e){try{var t=this.dynamicDataExecutors.get(e);if(t)return Promise.resolve(t(this.context));throw new Error("Dynamic data executor "+e+" not found")}catch(e){return Promise.reject(e)}},e}();

package/dist/index.m.js

@@ -0,0 +1 @@
+var t,e,n,a;!function(t){t.string="string",t.url="url",t.email="email",t.phone="phone",t.number="number",t.boolean="boolean",t.select="select",t.selectItem="selectItem",t.multiselect="multiselect",t.date="date",t.timestamp="timestamp"}(t||(t={})),function(t){t.webhook="webhook",t.polling="polling",t.step="step"}(e||(e={})),function(t){t.action="action",t.query="query"}(n||(n={})),function(t){t.name="name",t.email="email",t.tags="tags",t.tagsString="tagsString",t.platform="platform",t.phone="phone",t.city="city",t.state="state",t.country="country",t.arrivalDate="arrivalDate",t.departureDate="departureDate",t.language="language",t.adults="adults",t.children="children",t.updatedAt="updatedAt",t.requestPrice="requestPrice",t.eventQuote="eventQuote",t.groupQuote="groupQuote",t.linkQuotationOpened="linkQuotationOpened",t.utmSource="utmSource",t.utmMedium="utmMedium",t.utmCampaign="utmCampaign",t.page="page",t.linkToLiveChat="linkToLiveChat",t.hasReservation="hasReservation",t.totalReservation="totalReservation",t.minTotalValuePriceQuote="minTotalValuePriceQuote",t.maxTotalValuePriceQuote="maxTotalValuePriceQuote",t.currencyPriceQuote="currencyPriceQuote",t.attendant="attendant",t.attendantEmail="attendantEmail",t.companyName="companyName",t.conversationId="conversationId",t.hotelReservationId="hotelReservationId"}(a||(a={}));var o=/*#__PURE__*/function(){function t(t){this.context=void 0,this.events=[],this.eventsByKey=void 0,this.executors=new Map,this.dynamicDataExecutors=new Map,this.context=t,this.eventsByKey=new Map}var e=t.prototype;return e.registerEvent=function(t,e){this.events.push(t),this.eventsByKey.set(t.key,t),this.executors.set(t,e)},e.registerDynamicData=function(t,e){this.dynamicDataExecutors.set(t,e)},e.listEvents=function(){return this.events},e.getEvent=function(t){return this.eventsByKey.get(t)},e.executeEvent=function(t){try{var e,n,a=this,o=(n="string"==typeof t||t instanceof String?a.getEvent(String(t)):t)?a.executors.get(n):void 0;if(o)return Promise.resolve(o(a.context));throw new Error("Event "+((null==(e=n)?void 0:e.label)||t)+" not found")}catch(t){return Promise.reject(t)}},e.getDynamicData=function(t){try{var e=this.dynamicDataExecutors.get(t);if(e)return Promise.resolve(e(this.context));throw new Error("Dynamic data executor "+t+" not found")}catch(t){return Promise.reject(t)}},t}();export{o as AppFlow,t as ArgumentTypeEnum,a as DefaultFieldEnum,e as EventTriggerEnum,n as EventTypeEnum};

package/dist/index.modern.mjs

@@ -0,0 +1 @@
+var t,e,n,a;!function(t){t.string="string",t.url="url",t.email="email",t.phone="phone",t.number="number",t.boolean="boolean",t.select="select",t.selectItem="selectItem",t.multiselect="multiselect",t.date="date",t.timestamp="timestamp"}(t||(t={})),function(t){t.webhook="webhook",t.polling="polling",t.step="step"}(e||(e={})),function(t){t.action="action",t.query="query"}(n||(n={})),function(t){t.name="name",t.email="email",t.tags="tags",t.tagsString="tagsString",t.platform="platform",t.phone="phone",t.city="city",t.state="state",t.country="country",t.arrivalDate="arrivalDate",t.departureDate="departureDate",t.language="language",t.adults="adults",t.children="children",t.updatedAt="updatedAt",t.requestPrice="requestPrice",t.eventQuote="eventQuote",t.groupQuote="groupQuote",t.linkQuotationOpened="linkQuotationOpened",t.utmSource="utmSource",t.utmMedium="utmMedium",t.utmCampaign="utmCampaign",t.page="page",t.linkToLiveChat="linkToLiveChat",t.hasReservation="hasReservation",t.totalReservation="totalReservation",t.minTotalValuePriceQuote="minTotalValuePriceQuote",t.maxTotalValuePriceQuote="maxTotalValuePriceQuote",t.currencyPriceQuote="currencyPriceQuote",t.attendant="attendant",t.attendantEmail="attendantEmail",t.companyName="companyName",t.conversationId="conversationId",t.hotelReservationId="hotelReservationId"}(a||(a={}));class i{constructor(t){this.context=void 0,this.events=[],this.eventsByKey=void 0,this.executors=new Map,this.dynamicDataExecutors=new Map,this.context=t,this.eventsByKey=new Map}registerEvent(t,e){this.events.push(t),this.eventsByKey.set(t.key,t),this.executors.set(t,e)}registerDynamicData(t,e){this.dynamicDataExecutors.set(t,e)}listEvents(){return this.events}getEvent(t){return this.eventsByKey.get(t)}async executeEvent(t){var e;let n;n="string"==typeof t||t instanceof String?this.getEvent(String(t)):t;const a=n?this.executors.get(n):void 0;if(a)return a(this.context);throw new Error(`Event ${(null==(e=n)?void 0:e.label)||t} not found`)}async getDynamicData(t){const e=this.dynamicDataExecutors.get(t);if(e)return e(this.context);throw new Error(`Dynamic data executor ${t} not found`)}}export{i as AppFlow,t as ArgumentTypeEnum,a as DefaultFieldEnum,e as EventTriggerEnum,n as EventTypeEnum};

package/dist/index.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e||self).askflowAppSdk={})}(this,function(e){var t,n,a,i;e.ArgumentTypeEnum=void 0,(t=e.ArgumentTypeEnum||(e.ArgumentTypeEnum={})).string="string",t.url="url",t.email="email",t.phone="phone",t.number="number",t.boolean="boolean",t.select="select",t.selectItem="selectItem",t.multiselect="multiselect",t.date="date",t.timestamp="timestamp",e.EventTriggerEnum=void 0,(n=e.EventTriggerEnum||(e.EventTriggerEnum={})).webhook="webhook",n.polling="polling",n.step="step",e.EventTypeEnum=void 0,(a=e.EventTypeEnum||(e.EventTypeEnum={})).action="action",a.query="query",e.DefaultFieldEnum=void 0,(i=e.DefaultFieldEnum||(e.DefaultFieldEnum={})).name="name",i.email="email",i.tags="tags",i.tagsString="tagsString",i.platform="platform",i.phone="phone",i.city="city",i.state="state",i.country="country",i.arrivalDate="arrivalDate",i.departureDate="departureDate",i.language="language",i.adults="adults",i.children="children",i.updatedAt="updatedAt",i.requestPrice="requestPrice",i.eventQuote="eventQuote",i.groupQuote="groupQuote",i.linkQuotationOpened="linkQuotationOpened",i.utmSource="utmSource",i.utmMedium="utmMedium",i.utmCampaign="utmCampaign",i.page="page",i.linkToLiveChat="linkToLiveChat",i.hasReservation="hasReservation",i.totalReservation="totalReservation",i.minTotalValuePriceQuote="minTotalValuePriceQuote",i.maxTotalValuePriceQuote="maxTotalValuePriceQuote",i.currencyPriceQuote="currencyPriceQuote",i.attendant="attendant",i.attendantEmail="attendantEmail",i.companyName="companyName",i.conversationId="conversationId",i.hotelReservationId="hotelReservationId",e.AppFlow=/*#__PURE__*/function(){function e(e){this.context=void 0,this.events=[],this.eventsByKey=void 0,this.executors=new Map,this.dynamicDataExecutors=new Map,this.context=e,this.eventsByKey=new Map}var t=e.prototype;return t.registerEvent=function(e,t){this.events.push(e),this.eventsByKey.set(e.key,e),this.executors.set(e,t)},t.registerDynamicData=function(e,t){this.dynamicDataExecutors.set(e,t)},t.listEvents=function(){return this.events},t.getEvent=function(e){return this.eventsByKey.get(e)},t.executeEvent=function(e){try{var t,n,a=this,i=(n="string"==typeof e||e instanceof String?a.getEvent(String(e)):e)?a.executors.get(n):void 0;if(i)return Promise.resolve(i(a.context));throw new Error("Event "+((null==(t=n)?void 0:t.label)||e)+" not found")}catch(e){return Promise.reject(e)}},t.getDynamicData=function(e){try{var t=this.dynamicDataExecutors.get(e);if(t)return Promise.resolve(t(this.context));throw new Error("Dynamic data executor "+e+" not found")}catch(e){return Promise.reject(e)}},e}()});

package/dist/types.d.ts

@@ -0,0 +1,136 @@
+export declare enum ArgumentTypeEnum {
+    'string' = "string",
+    'url' = "url",
+    'email' = "email",
+    'phone' = "phone",
+    'number' = "number",
+    'boolean' = "boolean",
+    'select' = "select",
+    'selectItem' = "selectItem",
+    'multiselect' = "multiselect",
+    'date' = "date",
+    'timestamp' = "timestamp"
+}
+export declare type II18nData = {
+    pt_br?: string;
+    en_us?: string;
+    es_es?: string;
+    text: string;
+} | {
+    pt_br: string;
+    en_us: string;
+    es_es: string;
+    text?: string;
+};
+export declare type ISource = {
+    key: string;
+    type: 'dynamic';
+    dependsOn?: IDependsOn[];
+} | {
+    type: 'fixed';
+    options: ISelectItem[];
+};
+export declare type IDependsOn = {
+    argumentKey: string;
+};
+export declare type IArgument = {
+    key: string;
+    label: II18nData;
+    description?: II18nData;
+    type: ArgumentTypeEnum;
+    required: boolean;
+    defaultValue?: any;
+    defaultField?: string;
+    source?: ISource;
+    expose?: boolean;
+};
+export declare enum EventTriggerEnum {
+    'webhook' = "webhook",
+    'polling' = "polling",
+    'step' = "step"
+}
+export declare enum EventTypeEnum {
+    'action' = "action",
+    'query' = "query"
+}
+export declare type IEvent = {
+    key: string;
+    type: EventTypeEnum.action;
+    trigger: EventTriggerEnum.step;
+    label: II18nData;
+    description?: II18nData;
+    arguments?: IArgument[];
+} | {
+    key: string;
+    type: EventTypeEnum.query;
+    trigger: EventTriggerEnum.webhook;
+    label: II18nData;
+    description?: II18nData;
+    arguments?: IArgument[];
+} | {
+    key: string;
+    type: EventTypeEnum.query;
+    trigger: EventTriggerEnum.polling;
+    /**
+     * Time in minutes
+     */
+    pollMinInterval: number;
+    label: II18nData;
+    description?: II18nData;
+    arguments?: IArgument[];
+};
+export declare type IContext = {
+    connection: {
+        connectionParams: Map<string, any>;
+    };
+    workflowStep?: any;
+    arguments: Map<string, any>;
+    pushQueryItem: (item: IQueryItem) => Promise<boolean>;
+};
+export declare type IManifest = {
+    key: string;
+    version: string;
+    runtimeVersion: string;
+    name: II18nData;
+    description?: II18nData;
+    url: string;
+    iconUrl: string;
+    docUrl: string;
+    primaryColor: string;
+    connectionParams?: IArgument[];
+};
+export declare type IQueryItem = {
+    raw: any;
+    meta?: {
+        uniqueId: string | undefined;
+    };
+};
+export declare type IOutputData = {
+    key: string;
+    label?: II18nData;
+    description?: II18nData;
+    type: ArgumentTypeEnum;
+    value?: any;
+    defaultField?: string;
+};
+export declare type ISelectItem = {
+    key: string;
+    label: II18nData;
+    description?: II18nData;
+    value?: any;
+};
+export declare type IResponseEvent = {
+    data: IOutputData[];
+    success: true;
+} | {
+    data?: IOutputData[];
+    success: false;
+    error: string;
+};
+export declare type IResponseDynamicData = {
+    data: ISelectItem[];
+    success: true;
+} | {
+    success: false;
+    error: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asksuite/askflow-app-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "main": "dist/index.js",
   "module": "dist/index.m.js",
   "unpkg": "dist/index.umd.js",