@empathyco/x-components 8.3.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
           }
         },
         {
@@ -63292,6 +63310,34 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!resetUrlQuery:var",
+          "docComment": "/**\n * Sets to empathy string the query of the url module.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "resetUrlQuery: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyWire",
+              "canonicalReference": "@empathyco/x-components!AnyWire:type"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/url/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "resetUrlQuery",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@empathyco/x-components!ResultFeature:type",
@@ -72135,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",
@@ -76343,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",
@@ -76514,7 +76606,7 @@
           "name": "SimpleFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 274
+            "endIndex": 278
           }
         },
         {
@@ -79774,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\")."
@@ -79848,7 +79967,7 @@
           "name": "SnippetCallbacks",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 586
+            "endIndex": 592
           }
         },
         {
@@ -89826,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",
@@ -89858,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",
@@ -90331,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",
@@ -90465,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",