@empathyco/x-components 6.0.0-alpha.36 → 6.0.0-alpha.38

package/types/x-modules/related-prompts/components/related-prompt.vue.d.ts

@@ -2,50 +2,27 @@ import { PropType } from 'vue';
 import { RelatedPrompt } from '@empathyco/x-types';
 /**
  * This component shows a suggested related prompt.
- *
- * It provides a slot to customize the related prompt button information.
- *
- * @public
  */
 declare const _default: import("vue").DefineComponent<{
     relatedPrompt: {
         type: PropType<RelatedPrompt>;
         required: true;
     };
-    isPromptVisible: {
+    selected: {
         type: BooleanConstructor;
         default: boolean;
     };
-    isSelected: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    index: {
-        type: NumberConstructor;
-        required: true;
-    };
-}, {
-    toggleSuggestion: (index: number) => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     relatedPrompt: {
         type: PropType<RelatedPrompt>;
         required: true;
     };
-    isPromptVisible: {
+    selected: {
         type: BooleanConstructor;
         default: boolean;
     };
-    isSelected: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    index: {
-        type: NumberConstructor;
-        required: true;
-    };
 }>>, {
-    isPromptVisible: boolean;
-    isSelected: boolean;
+    selected: boolean;
 }, {}>;
 export default _default;
 //# sourceMappingURL=related-prompt.vue?vue&type=script&lang.d.ts.map

package/types/x-modules/related-prompts/components/related-prompt.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"related-prompt.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/related-prompts/components/related-prompt.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACE,OAAO,EAAmB,QAAQ,EAAE,MAAM,KAAK,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAMnD;;;;;;GAMG;;;;;;;;;;;;;;;;;;;8BA6BkC,MAAM,KAAG,IAAI;;;;;;;;;;;;;;;;;;;;;;AA5BlD,wBAoCG"}
+{"version":3,"file":"related-prompt.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/related-prompts/components/related-prompt.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AACE,OAAO,EAAmB,QAAQ,EAAE,MAAM,KAAK,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKnD;;GAEG;;;;;;;;;;;;;;;;;;;;;;AACH,wBAmBG"}

package/types/x-modules/related-prompts/components/related-prompts-tag-list.vue.d.ts

@@ -1,14 +1,95 @@
+import { PropType } from 'vue';
+/**
+ * This component shows the list of `RelatedPrompts` components.
+ *
+ * If the default slot is reimplemented in the consumer, `onSelect` function will be
+ * necessary to handle the selection of the related prompt and to trigger the stagger-fade-slide animation.
+ *
+ * @public
+ */
 declare const _default: import("vue").DefineComponent<{
+    /**
+     * The CSS class for the left and right button of the sliding panel.
+     *
+     * @public
+     */
     buttonClass: StringConstructor;
+    /**
+     * The CSS class for all the related prompt wrapper elements.
+     *
+     * @public
+     */
+    tagClass: StringConstructor;
+    /**
+     * Array of colors to apply to the related prompts. It will be applied to tag
+     * elements cyclically according to their index in the nex way: `tagColors[index % tagColors.length]`.
+     *
+     * @public
+     */
+    tagColors: PropType<string[]>;
+    /**
+     * The duration of the total animation in milliseconds.
+     *
+     * @public
+     */
+    animationDurationInMs: {
+        type: NumberConstructor;
+        default: number;
+    };
 }, {
-    arePromptsVisible: import("vue").Ref<boolean>;
-    hidePrompt: (index: number) => boolean;
     isSelected: (index: number) => boolean;
-    relatedPrompts: import("vue").ComputedRef<any>;
-    selectedPrompt: import("vue").ComputedRef<any>;
-    slidingPanelContent: import("vue").Ref<Element | undefined>;
+    onSelect: (selectedIndex: number) => void;
+    onBeforeEnter: (el: Element) => void;
+    onEnter: (el: Element, done: () => void) => void;
+    onLeave: (el: Element, done: () => void) => void;
+    selectedPromptIndex: import("vue").ComputedRef<any>;
+    visibleRelatedPrompts: import("vue").ComputedRef<{
+        index: number;
+        relatedPromptNextQueries: import("@empathyco/x-types").RelatedPromptNextQuery[];
+        suggestionText: string;
+        type: string;
+        toolingDisplayTagging: import("@empathyco/x-types").TaggingRequest;
+        modelName: "RelatedPrompt";
+    }[]>;
+    listItems: import("vue").Ref<HTMLElement[]>;
+    isAnimating: import("vue").Ref<boolean>;
+    x: import("../../../composables").UseAliasAPI & {
+        on: <Event_1 extends keyof import("../../..").XEventsTypes, Metadata extends boolean>(event: Event_1, withMetadata: Metadata) => {
+            subscribe: (callback: (payload: Metadata extends true ? import("@empathyco/x-bus").SubjectPayload<import("@empathyco/x-bus").EventPayload<import("../../..").XEventsTypes, Event_1>, import("../../..").WireMetadata> : import("@empathyco/x-bus").EventPayload<import("../../..").XEventsTypes, Event_1>) => void) => void;
+        };
+        emit: <Event_2 extends keyof import("../../..").XEventsTypes>(event: Event_2, payload?: import("../../..").XEventPayload<Event_2> | undefined, metadata?: Omit<import("../../..").WireMetadata, "moduleName">) => Promise<import("@empathyco/x-bus").EmittedData<import("../../..").XEventsTypes, Event_2, import("../../..").WireMetadata>>;
+    };
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The CSS class for the left and right button of the sliding panel.
+     *
+     * @public
+     */
     buttonClass: StringConstructor;
-}>>, {}, {}>;
+    /**
+     * The CSS class for all the related prompt wrapper elements.
+     *
+     * @public
+     */
+    tagClass: StringConstructor;
+    /**
+     * Array of colors to apply to the related prompts. It will be applied to tag
+     * elements cyclically according to their index in the nex way: `tagColors[index % tagColors.length]`.
+     *
+     * @public
+     */
+    tagColors: PropType<string[]>;
+    /**
+     * The duration of the total animation in milliseconds.
+     *
+     * @public
+     */
+    animationDurationInMs: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>>, {
+    animationDurationInMs: number;
+}, {}>;
 export default _default;
 //# sourceMappingURL=related-prompts-tag-list.vue?vue&type=script&lang.d.ts.map

package/types/x-modules/related-prompts/components/related-prompts-tag-list.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"related-prompts-tag-list.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/related-prompts/components/related-prompts-tag-list.vue?vue&type=script&lang.ts"],"names":[],"mappings":";;;;wBAqCiC,MAAM,KAAG,OAAO;wBAFhB,MAAM,KAAG,OAAO;;;;;;;AA5B/C,wBA0CG"}
+{"version":3,"file":"related-prompts-tag-list.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/related-prompts/components/related-prompts-tag-list.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AAEE,OAAO,EAA6B,QAAQ,EAAc,MAAM,KAAK,CAAC;AAOtE;;;;;;;GAOG;;IAMC;;;;OAIG;;IAEH;;;;OAIG;;IAEH;;;;;OAKG;;IAEH;;;;OAIG;;;;;;wBAwLwB,MAAM,KAAG,OAAO;8BA5GV,MAAM,KAAG,IAAI;wBA8DnB,OAAO;kBAeb,OAAO,QAAQ,MAAM,IAAI;kBAkBzB,OAAO,QAAQ,MAAM,IAAI;;;;;;;;;;;;;;;;;;;IAlM9C;;;;OAIG;;IAEH;;;;OAIG;;IAEH;;;;;OAKG;;IAEH;;;;OAIG;;;;;;;;AA5BP,wBAuOG"}

package/types/x-modules/related-prompts/events.types.d.ts

@@ -1,4 +1,4 @@
-import { RelatedPromptsRequest } from '@empathyco/x-types';
+import { RelatedPromptsRequest, Result } from '@empathyco/x-types';
 /**
  * Dictionary of the events of RelatedPrompts XModule, where each key is the event name,
  * and the value is the event payload type or `void` if it has no payload.
@@ -22,5 +22,15 @@ export interface RelatedPromptsXEvents {
      * Payload: The index of the next query in the NextQueries list or -1 to remove selection.
      */
     UserSelectedARelatedPromptQuery: number;
+    /**
+     * The user has clicked one prompt.
+     * Payload: The result that the user clicked.
+     */
+    UserClickedARelatedPromptResult: Result;
+    /**
+     * The user has clicked one add to cart from a prompt.
+     * Payload: The result that the user clicked.
+     */
+    UserClickedARelatedPromptAdd2Cart: Result;
 }
 //# sourceMappingURL=events.types.d.ts.map

package/types/x-modules/related-prompts/events.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/related-prompts/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,4BAA4B,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC3D;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,+BAA+B,EAAE,MAAM,CAAC;CACzC"}
+{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/related-prompts/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,4BAA4B,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC3D;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,+BAA+B,EAAE,MAAM,CAAC;IACxC;;;OAGG;IACH,+BAA+B,EAAE,MAAM,CAAC;IACxC;;;OAGG;IACH,iCAAiC,EAAE,MAAM,CAAC;CAC3C"}

package/types/x-modules/tagging/store/module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/tagging/store/module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBA+BjC,CAAC"}
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/tagging/store/module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAmCjC,CAAC"}

package/types/x-modules/tagging/wiring.d.ts

@@ -1,4 +1,4 @@
-import { Taggable, Tagging, TaggingRequest } from '@empathyco/x-types';
+import { Result, Taggable, Tagging, TaggingRequest } from '@empathyco/x-types';
 import { Wire } from '../../wiring/wiring.types';
 /**
  * Sets the tagging state `consent`.
@@ -61,6 +61,18 @@ export declare const trackAddToCartWire: Wire<Taggable>;
  * @public
  */
 export declare const trackDisplayClickedWire: Wire<Taggable>;
+/**
+ * Performs a track of a display result being clicked.
+ *
+ * @public
+ */
+export declare const trackToolingDisplayClickedWire: Wire<Taggable>;
+/**
+ * Performs a track of a display result being clicked.
+ *
+ * @public
+ */
+export declare const trackToolingAdd2CartWire: Wire<Taggable>;
 /**
  * Performs a track of a display element appearing.
  *
@@ -99,6 +111,22 @@ export declare const trackNoResultsQueryWithSemanticsWireDebounced: Wire<any>;
  * @public
  */
 export declare function createTrackDisplayWire(property: keyof Tagging): Wire<Taggable>;
+/**
+ * Factory helper to create a wire for the track of the tooling display click.
+ *
+ * @returns A new wire for the tooling display click of the taggable element.
+ *
+ * @public
+ */
+export declare function createTrackToolingDisplayWire(): Wire<Taggable>;
+/**
+ * Factory helper to create a wire for the track of the tooling display click.
+ *
+ * @returns A new wire for the tooling display add to cart of the taggable element.
+ *
+ * @public
+ */
+export declare function createTrackToolingAdd2CartWire(): Wire<Taggable>;
 /**
  * Factory helper to create a wire to set the queryTagging.
  *
@@ -139,7 +167,7 @@ export declare const taggingWiring: {
     };
     UserClickedAResult: {
         trackResultClickedWire: Wire<Taggable>;
-        storeClickedResultWire: Wire<import("@empathyco/x-types").Result>;
+        storeClickedResultWire: Wire<Result>;
     };
     UserClickedResultAddToCart: {
         trackAddToCartWire: Wire<Taggable>;
@@ -161,5 +189,11 @@ export declare const taggingWiring: {
     ModuleRegistered: {
         setNoResultsTaggingEnabledWire: Wire<keyof import("../x-modules.types").XModulesTree>;
     };
+    UserClickedARelatedPromptResult: {
+        trackToolingDisplayClickedWire: Wire<Taggable>;
+    };
+    UserClickedARelatedPromptAdd2Cart: {
+        trackToolingAdd2CartWire: Wire<Taggable>;
+    };
 };
 //# sourceMappingURL=wiring.d.ts.map

package/types/x-modules/tagging/wiring.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/tagging/wiring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAStF,OAAO,EAAuB,IAAI,EAAE,MAAM,2BAA2B,CAAC;AA8EtE;;;;GAIG;AACH,eAAO,MAAM,UAAU,eAA2B,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,uDAA2C,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,8CAA4B,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,cAAc,yCAK1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,sBAa/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,gBAA0C,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,gBAA8B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,gBAAyC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,gBAAoC,CAAC;AAE3E;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAUvE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC,WAUhD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,6CAA6C,WAIzD,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAiB9E;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAQtE;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDxB,CAAC"}
+{"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/tagging/wiring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAS9F,OAAO,EAAuB,IAAI,EAAE,MAAM,2BAA2B,CAAC;AA8EtE;;;;GAIG;AACH,eAAO,MAAM,UAAU,eAA2B,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,uDAA2C,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,8CAA4B,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,cAAc,yCAK1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,sBAa/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,gBAA0C,CAAC;AAEvF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAA2B,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,gBAA8B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,gBAAyC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,gBAAkC,CAAC;AAE9E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,gBAAmC,CAAC;AAEzE;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,gBAAoC,CAAC;AAE3E;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAUvE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC,WAUhD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,6CAA6C,WAIzD,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAiB9E;AAsBD;;;;;;GAMG;AACH,wBAAgB,6BAA6B,IAAI,IAAI,CAAC,QAAQ,CAAC,CAY9D;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,IAAI,IAAI,CAAC,QAAQ,CAAC,CAY/D;AAED;;;;;;GAMG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAQtE;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuDxB,CAAC"}

package/docs/API-reference/api/x-types.relatedprompt.nextqueries.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [nextQueries](./x-types.relatedprompt.nextqueries.md)
-
-## RelatedPrompt.nextQueries property
-
-The next queries related to the prompt.
-
-**Signature:**
-
-```typescript
-nextQueries: string[];
-```