@empathyco/x-components 3.0.0-alpha.159 → 3.0.0-alpha.161

package/types/components/result/result-variant-selector.vue.d.ts

@@ -0,0 +1,64 @@
+import Vue from 'vue';
+import { Result, ResultVariant } from '@empathyco/x-types';
+/**
+ * Component to show and select the available variants of a product for a given nest level.
+ * TODO: Add logger warning on mount when result is not injected.
+ *
+ * @public
+ */
+export default class ResultVariantSelector extends Vue {
+    /**
+     * Callback to be called when a variant is selected.
+     *
+     * @public
+     */
+    selectResultVariant: (variant: ResultVariant, level?: number) => void;
+    /**
+     * The original result, used to retrieve the available variants for the level.
+     *
+     * @public
+     */
+    result: Result;
+    /**
+     * Array containing the selected variants.
+     *
+     * @public
+     */
+    selectedVariants: ResultVariant[];
+    /**
+     * The nest level of the variants to be rendered.
+     *
+     * @public
+     */
+    level: number;
+    /**
+     * It retrieves the available variants from the result.
+     *
+     * @returns - The variants of the result for the current level.
+     * @internal
+     */
+    protected get variants(): ResultVariant[] | undefined;
+    /**
+     * Gets the selected variant of the current level.
+     *
+     * @returns - The selected variant.
+     * @internal
+     */
+    protected get selectedVariant(): ResultVariant | undefined;
+    /**
+     * Calls the provided method to select a variant.
+     *
+     * @param variant - Variant to select.
+     * @internal
+     */
+    protected selectVariant(variant: ResultVariant): void;
+    /**
+     * Checks if a variant is selected.
+     *
+     * @param variant - Variant to check.
+     * @returns True if the variant is selected, false if not.
+     * @internal
+     */
+    protected variantIsSelected(variant: ResultVariant): boolean;
+}
+//# sourceMappingURL=result-variant-selector.vue?rollup-plugin-vue=script.d.ts.map

package/types/components/result/result-variant-selector.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result-variant-selector.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/result/result-variant-selector.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAmDA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAS3D;;;;;GAKG;AAMH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,GAAG;IACpD;;;;OAIG;IAEI,mBAAmB,EAAG,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAE9E;;;;OAIG;IAEI,MAAM,EAAG,MAAM,CAAC;IAEvB;;;;OAIG;IAEI,gBAAgB,EAAG,aAAa,EAAE,CAAC;IAE1C;;;;OAIG;IAII,KAAK,EAAG,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,SAAS,KAAK,QAAQ,IAAI,aAAa,EAAE,GAAG,SAAS,CAKpD;IAED;;;;;OAKG;IACH,SAAS,KAAK,eAAe,IAAI,aAAa,GAAG,SAAS,CAEzD;IAED;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAIrD;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO;CAG7D"}

package/types/components/result/result-variants-provider.vue.d.ts

@@ -0,0 +1,77 @@
+import Vue, { VNode, CreateElement } from 'vue';
+import { Result, ResultVariant } from '@empathyco/x-types';
+/**
+ * Component that exposes the result merged with its selected variant in the default slot.
+ *
+ * It receives the original result and keeps track of the selected variant.
+ *
+ * It provides the original result, the array containing the selected variants and a callback to
+ * set the selected variant to be used from a child.
+ *
+ * @public
+ */
+export default class ResultVariantsProvider extends Vue {
+    /**
+     * The original result containing the variants.
+     *
+     * @public
+     */
+    result: Result;
+    /**
+     * The provider by default will auto select the first variants of all levels.
+     * This prop allows to limit the number of variants auto selected when the provider is created.
+     * Take into account that the depth will be the variants level + 1, so, setting autoSelectDepth
+     * to 0 will not select any variant, setting it to 1 will select only the first variant of the
+     * first level, and so on.
+     */
+    autoSelectDepth: number;
+    /**
+     * Array to keep track of the selected variants of the result.
+     * Each position of the array is a nest level in the variants' hierarchy, so,
+     * the second position will contain a variant that is present inside the variant of the first
+     * position, and so on.
+     *
+     * @public
+     */
+    selectedVariants: ResultVariant[];
+    /**
+     * Selects a variant of the result.
+     * When called, it slices the array of selected variants to remove the selected child variants.
+     * Emits the {@link XEventsTypes.UserSelectedAResultVariant} when called.
+     *
+     * @param variant - The variant to set.
+     * @param level - The nest level where the variant is placed inside the result.
+     * @public
+     */
+    selectResultVariant(variant: ResultVariant, level?: number): void;
+    /**
+     * Render function of the provider.
+     * It exposes the result with the selected variant merged.
+     *
+     * @param createElement - Vue createElement method.
+     * @returns - The VNode of the first element passed in the slot.
+     * @public
+     */
+    render(createElement: CreateElement): VNode;
+    /**
+     * Resets the selected variants when the result changes.
+     * That includes doing the auto selection of the variants when the component is created
+     * and when the result is changed.
+     */
+    resetSelectedVariants(): void;
+    /**
+     * Merges the original result with the selected variant.
+     * The merge is done with all the selected variants of the array.
+     *
+     * @returns - The result with the selected variant merged.
+     * @public
+     */
+    get resultToProvide(): Result;
+    /**
+     * Adds to the selectedVariants array the variants up to the autoSelectDepth level.
+     *
+     * @param variant - Variant to add to the array.
+     */
+    selectFirstVariants(variant?: ResultVariant): void;
+}
+//# sourceMappingURL=result-variants-provider.vue?rollup-plugin-vue=script.d.ts.map

package/types/components/result/result-variants-provider.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result-variants-provider.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/result/result-variants-provider.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AACA,OAAO,GAAG,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAQ3D;;;;;;;;;GASG;AAEH,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,GAAG;IACrD;;;;OAIG;IAKI,MAAM,EAAG,MAAM,CAAC;IAEvB;;;;;;OAMG;IAII,eAAe,EAAG,MAAM,CAAC;IAEhC;;;;;;;OAOG;IAEI,gBAAgB,EAAE,aAAa,EAAE,CAAM;IAE9C;;;;;;;;OAQG;IAEH,mBAAmB,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,SAAI,GAAG,IAAI;IAY5D;;;;;;;OAOG;IACH,MAAM,CAAC,aAAa,EAAE,aAAa,GAAG,KAAK;IAQ3C;;;;OAIG;IAEH,qBAAqB,IAAI,IAAI;IAK7B;;;;;;OAMG;IACH,IAAW,eAAe,IAAI,MAAM,CAYnC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI;CAMnD"}

package/types/wiring/events.types.d.ts

@@ -1,4 +1,4 @@
-import { Result, Suggestion } from '@empathyco/x-types';
+import { Result, ResultVariant, Suggestion } from '@empathyco/x-types';
 import { ExtractPayload } from '../store/index';
 import { ArrowKey, PropsWithType } from '../utils';
 import { DeviceXEvents } from '../x-modules/device';
@@ -162,6 +162,16 @@ export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraPara
      * Payload: none.
      */
     UserReachedEmpathizeTop: void;
+    /**
+     * The user selected a result variant.
+     * Payload: And object containing the result, the selected variant and the level of the selected
+     * variant.
+     */
+    UserSelectedAResultVariant: {
+        result: Result;
+        variant: ResultVariant;
+        level: number;
+    };
     /**
      * User selected any kind of suggestion (query-suggestion, popular-search...)
      * Payload: The {@link @empathyco/x-types#Suggestion | suggestion} that the user selected.

package/types/wiring/events.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,YACf,SAAQ,aAAa,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,UAAU;IACZ;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,oBAAoB,EAAE,UAAU,EAAE,CAAC;IACnC;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,0BAA0B,EAAE,IAAI,CAAC;IACjC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,gBAAgB,EAAE,IAAI,CAAC;IACvB;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,mBAAmB,EAAE,QAAQ,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,EAAE,IAAI,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,EAAE,UAAU,CAAC;IACpC;;;;OAIG;IACH,uBAAuB,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,cAAc,EAAE,OAAO,CAAC;QACxB,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;QAChC,QAAQ,EAAE,YAAY,CAAC;KACxB,CAAC;CACH;AAED;;;;GAIG;AACH,oBAAY,MAAM,GAAG,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,oBAAY,SAAS,CAAC,IAAI,IAAI,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,oBAAY,aAAa,CAAC,KAAK,SAAS,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,IAAI,GAC9E,SAAS,GACT,YAAY,CAAC,KAAK,CAAC,CAAC"}
+{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,2CAA2C,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,YACf,SAAQ,aAAa,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,UAAU;IACZ;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,oBAAoB,EAAE,UAAU,EAAE,CAAC;IACnC;;;OAGG;IACH,uBAAuB,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,iBAAiB,EAAE,IAAI,CAAC;IACxB;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,0BAA0B,EAAE,IAAI,CAAC;IACjC;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,gBAAgB,EAAE,IAAI,CAAC;IACvB;;;OAGG;IACH,2BAA2B,EAAE,IAAI,CAAC;IAClC;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,4BAA4B,EAAE,MAAM,CAAC;IACrC;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,mBAAmB,EAAE,QAAQ,CAAC;IAC9B;;;OAGG;IACH,uBAAuB,EAAE,IAAI,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF;;;OAGG;IACH,uBAAuB,EAAE,UAAU,CAAC;IACpC;;;;OAIG;IACH,uBAAuB,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,cAAc,EAAE,OAAO,CAAC;QACxB,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;QAChC,QAAQ,EAAE,YAAY,CAAC;KACxB,CAAC;CACH;AAED;;;;GAIG;AACH,oBAAY,MAAM,GAAG,MAAM,YAAY,CAAC;AAExC;;;;;GAKG;AACH,oBAAY,SAAS,CAAC,IAAI,IAAI,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;AAEhE;;;;;GAKG;AACH,oBAAY,aAAa,CAAC,KAAK,SAAS,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,IAAI,GAC9E,SAAS,GACT,YAAY,CAAC,KAAK,CAAC,CAAC"}