@empathyco/x-components 8.4.0 → 8.5.0

package/report/x-components.api.json

@@ -37144,7 +37144,25 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": " | undefined;\n        VendorBannersChanged?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorBanner",
+              "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"modelName\">[] | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -37414,7 +37432,7 @@
           "name": "HierarchicalFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 306
+            "endIndex": 310
           }
         },
         {
@@ -72163,6 +72181,34 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!setBanners:var",
+          "docComment": "/**\n * Sets the vendor banners of the {@link VendorXModule}.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "setBanners: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../../wiring\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyWire",
+              "canonicalReference": "@empathyco/x-components!AnyWire:type"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/vendor/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "setBanners",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!setBrowseCategory:var",
@@ -76371,7 +76417,25 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": " | undefined;\n        VendorBannersChanged?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorBanner",
+              "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"modelName\">[] | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -76542,7 +76606,7 @@
           "name": "SimpleFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 274
+            "endIndex": 278
           }
         },
         {
@@ -79802,6 +79866,33 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        VendorBannersChanged: (payload: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorBanner",
+              "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"modelName\">[], metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n    }>>;\n}, {}, {}, {}, import(\"vue\")."
@@ -79876,7 +79967,7 @@
           "name": "SnippetCallbacks",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 586
+            "endIndex": 592
           }
         },
         {
@@ -89854,6 +89945,298 @@
           "members": [],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-components!VendorBanner:interface",
+          "docComment": "/**\n * The interface for a vendor banner, extending the base Banner interface. The optional position means: - If the position is defined, the banner will be displayed in that position inside the grid. - If the position is undefined, the banner will be displayed on top of the grid and full width.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface VendorBanner extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Banner",
+              "canonicalReference": "@empathyco/x-components!Banner_2:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", 'modelName'>"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "NamedModel",
+              "canonicalReference": "@empathyco/x-components!NamedModel:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<'VendorBanner'>"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/x-modules/vendor/types.ts",
+          "releaseTag": "Public",
+          "name": "VendorBanner",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorBanner#position:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "position?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "position",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            },
+            {
+              "startIndex": 6,
+              "endIndex": 8
+            }
+          ]
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!VendorBannersList:var",
+          "docComment": "/**\n * It renders a {@link ItemsList} list of vendor banners from {@link VendorState.banners}.\n *\n * The component provides a default slot which wraps the whole component with the `vendorBanners` plus the `injectedListItems` which also contains the injected list items from the ancestor.\n *\n * It also provides the parent slots to customize the items.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "_default: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "DefineComponent",
+              "canonicalReference": "@vue/runtime-core!DefineComponent:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtractPropTypes",
+              "canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n    animation: {\n        type: ("
+            },
+            {
+              "kind": "Reference",
+              "text": "StringConstructor",
+              "canonicalReference": "!StringConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "ObjectConstructor",
+              "canonicalReference": "!ObjectConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "FunctionConstructor",
+              "canonicalReference": "!FunctionConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ")[];\n        default: string;\n    };\n}>, () => import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VNode",
+              "canonicalReference": "@vue/runtime-core!VNode:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "RendererNode",
+              "canonicalReference": "@vue/runtime-core!RendererNode:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "RendererElement",
+              "canonicalReference": "@vue/runtime-core!RendererElement:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", {\n    [key: string]: any;\n}>, {}, {}, {}, import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentOptionsMixin",
+              "canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentOptionsMixin",
+              "canonicalReference": "@vue/runtime-core!ComponentOptionsMixin:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", {}, string, import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "PublicProps",
+              "canonicalReference": "@vue/runtime-core!PublicProps:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtractPropTypes",
+              "canonicalReference": "@vue/runtime-core!ExtractPropTypes:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n    animation: {\n        type: ("
+            },
+            {
+              "kind": "Reference",
+              "text": "StringConstructor",
+              "canonicalReference": "!StringConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "ObjectConstructor",
+              "canonicalReference": "!ObjectConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "FunctionConstructor",
+              "canonicalReference": "!FunctionConstructor:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ")[];\n        default: string;\n    };\n}>> & "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<{}>, {\n    animation: string | "
+            },
+            {
+              "kind": "Reference",
+              "text": "Function",
+              "canonicalReference": "!Function:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, any>;\n}, {}, {}, {}, string, import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentProvideOptions",
+              "canonicalReference": "@vue/runtime-core!ComponentProvideOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", true, {}, any>"
+            }
+          ],
+          "fileUrlPath": "dist/types/src/x-modules/vendor/components/vendor-banners-list.vue.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "VendorBannersList",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 42
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-components!VendorGetters:interface",
@@ -89886,6 +90269,42 @@
           "name": "VendorMutations",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorMutations#setBanners:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setBanners: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(banners: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorBanner",
+                  "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setBanners",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorMutations#setResults:member",
@@ -90359,6 +90778,38 @@
           "name": "VendorState",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorState#banners:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "banners: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorBanner",
+                  "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "banners",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorState#results:member",
@@ -90493,6 +90944,47 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorBannersChanged:member",
+              "docComment": "/**\n * The x consumer has provided vendor banners to be inserted in the result grid. Payload: The array of vendor banner inputs with their items and positions. modelName is excluded since it is an internal field, and we will assign it under the hood.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "VendorBannersChanged: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Omit",
+                  "canonicalReference": "!Omit:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorBanner",
+                  "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", 'modelName'>[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "VendorBannersChanged",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorResultsChanged:member",

package/report/x-components.api.md

@@ -3981,6 +3981,7 @@ VendorResultsChanged?: Omit<VendorResult, "modelName">[] | undefined;
 UserViewedAVendorResult?: VendorResult | undefined;
 UserClickedAVendorResult?: VendorResult | undefined;
 UserClickedVendorResultAddToCart?: VendorResult | undefined;
+VendorBannersChanged?: Omit<VendorBanner, "modelName">[] | undefined;
 }>;
 innerCssClasses: ComputedRef<(string | Dictionary<boolean>)[]>;
 renderedChildrenFilters: ComputedRef<HierarchicalFilter_2[]>;
@@ -7758,6 +7759,9 @@ export const sessionHistoryQueries: HistoryQueriesXStoreModule['getters']['sessi
 // @public
 export const setAiUrlParams: AiXStoreModule['actions']['setUrlParams'];
 
+// @public
+export const setBanners: AnyWire;
+
 // @public
 export const setBrowseCategory: Wire<BrowsableRequest>;
 
@@ -8236,6 +8240,7 @@ VendorResultsChanged?: Omit<VendorResult, "modelName">[] | undefined;
 UserViewedAVendorResult?: VendorResult | undefined;
 UserClickedAVendorResult?: VendorResult | undefined;
 UserClickedVendorResultAddToCart?: VendorResult | undefined;
+VendorBannersChanged?: Omit<VendorBanner, "modelName">[] | undefined;
 }>;
 innerCssClasses: ComputedRef<(string | Dictionary<boolean>)[]>;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
@@ -8578,6 +8583,7 @@ VendorResultsChanged: (payload: Omit<VendorResult, "modelName">[], metadata: Wir
 UserViewedAVendorResult: (payload: VendorResult, metadata: WireMetadata) => unknown;
 UserClickedAVendorResult: (payload: VendorResult, metadata: WireMetadata) => unknown;
 UserClickedVendorResultAddToCart: (payload: VendorResult, metadata: WireMetadata) => unknown;
+VendorBannersChanged: (payload: Omit<VendorBanner, "modelName">[], metadata: WireMetadata) => unknown;
 }>>;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {
 GlobalXBus: DefineComponent<    {}, {}, any>;
@@ -9583,6 +9589,29 @@ export function useXBus(): {
 export interface VendorActions {
 }
 
+// @public
+export interface VendorBanner extends Omit<Banner_2, 'modelName'>, NamedModel<'VendorBanner'> {
+    // (undocumented)
+    position?: number;
+}
+
+// @public
+export const VendorBannersList: DefineComponent<ExtractPropTypes<    {
+animation: {
+type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+default: string;
+};
+}>, () => VNode<RendererNode, RendererElement, {
+[key: string]: any;
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+animation: {
+type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+default: string;
+};
+}>> & Readonly<{}>, {
+animation: string | Function | Record<string, any>;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
 // @internal
 export const vendorEmitters: {};
 
@@ -9592,6 +9621,8 @@ export interface VendorGetters {
 
 // @public (undocumented)
 export interface VendorMutations {
+    // (undocumented)
+    setBanners: (banners: VendorBanner[]) => void;
     // (undocumented)
     setResults: (results: VendorResult[]) => void;
 }
@@ -9633,6 +9664,8 @@ export interface VendorResultTagging {
 
 // @public (undocumented)
 export interface VendorState {
+    // (undocumented)
+    banners: VendorBanner[];
     // (undocumented)
     results: VendorResult[];
 }
@@ -9651,8 +9684,12 @@ export const vendorWiring: {
     UserClickedVendorResultAddToCart: {
         trackResultAddToCart: Wire<VendorResult>;
     };
+    VendorBannersChanged: {
+        setBanners: AnyWire;
+    };
     SearchRequestChanged: {
         resetResults: AnyWire;
+        resetBanners: AnyWire;
     };
 };
 
@@ -9661,6 +9698,7 @@ export interface VendorXEvents {
     UserClickedAVendorResult: VendorResult;
     UserClickedVendorResultAddToCart: VendorResult;
     UserViewedAVendorResult: VendorResult;
+    VendorBannersChanged: Omit<VendorBanner, 'modelName'>[];
     VendorResultsChanged: Omit<VendorResult, 'modelName'>[];
 }
 

package/types/src/components/base-grid.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-grid.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../src/components/base-grid.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAQjD;;;;;;;;;GASG;;IAIC,sEAAsE;;;;;IAKtE;;;OAGG;;;;;IAKH;;;;OAIG;;cAEc,QAAQ,CAAC,QAAQ,EAAE,CAAC;;;;;;;aAM9B,WAAW;;aAAX,WAAW;;;;;;IAzBlB,sEAAsE;;;;;IAKtE;;;OAGG;;;;;IAKH;;;;OAIG;;cAEc,QAAQ,CAAC,QAAQ,EAAE,CAAC;;;;;;AAtBzC,wBAqIE"}
+{"version":3,"file":"base-grid.vue?vue&type=script&lang.d.ts","sourceRoot":"","sources":["../../../../src/components/base-grid.vue?vue&type=script&lang.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAQjD;;;;;;;;;GASG;;IAIC,sEAAsE;;;;;IAKtE;;;OAGG;;;;;IAKH;;;;OAIG;;cAEc,QAAQ,CAAC,QAAQ,EAAE,CAAC;;;;;;;aAM9B,WAAW;;aAAX,WAAW;;;;;;IAzBlB,sEAAsE;;;;;IAKtE;;;OAGG;;;;;IAKH;;;;OAIG;;cAEc,QAAQ,CAAC,QAAQ,EAAE,CAAC;;;;;;AAtBzC,wBAyIE"}