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

package/report/x-components.api.json

@@ -2571,7 +2571,25 @@
             },
             {
               "kind": "Content",
-              "text": ">>;\n}, unknown, {}, {}, import(\"vue\")."
+              "text": ">>;\n    metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"moduleName\" | \"origin\" | \"location\">;\n}, unknown, {}, {}, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -2643,7 +2661,7 @@
           "name": "BaseAddToCart",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 28
+            "endIndex": 32
           }
         },
         {
@@ -12952,6 +12970,90 @@
           ],
           "name": "createTrackDisplayWire"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@empathyco/x-components!createTrackToolingAdd2CartWire:function(1)",
+          "docComment": "/**\n * Factory helper to create a wire for the track of the tooling display click.\n *\n * @returns A new wire for the tooling display add to cart of the taggable element.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function createTrackToolingAdd2CartWire(): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Wire",
+              "canonicalReference": "@empathyco/x-components!Wire:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Taggable",
+              "canonicalReference": "@empathyco/x-components!Taggable:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/tagging/wiring.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "createTrackToolingAdd2CartWire"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@empathyco/x-components!createTrackToolingDisplayWire:function(1)",
+          "docComment": "/**\n * Factory helper to create a wire for the track of the tooling display click.\n *\n * @returns A new wire for the tooling display click of the taggable element.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function createTrackToolingDisplayWire(): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Wire",
+              "canonicalReference": "@empathyco/x-components!Wire:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Taggable",
+              "canonicalReference": "@empathyco/x-components!Taggable:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/tagging/wiring.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "createTrackToolingDisplayWire"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-components!createTrackWire:function(1)",
@@ -22739,7 +22841,7 @@
             },
             {
               "kind": "Content",
-              "text": "'external' | 'my_history' | 'no_query' | 'results' | 'no_results' | 'low_results' | 'none' | 'predictive_layer' | 'pdp' | 'url_history' | 'url_history_pdp'"
+              "text": "'external' | 'my_history' | 'no_query' | 'results' | 'no_results' | 'low_results' | 'none' | 'predictive_layer' | 'pdp' | 'url_history' | 'url_history_pdp' | 'related-prompts'"
             },
             {
               "kind": "Content",
@@ -28360,6 +28462,42 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n            UserClickedARelatedPromptResult: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n            UserClickedARelatedPromptAdd2Cart: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n        }>>;\n        required: true;\n    };\n}, () => string, unknown, {}, {}, import(\"vue\")."
@@ -30511,6 +30649,42 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n            UserClickedARelatedPromptResult: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n            UserClickedARelatedPromptAdd2Cart: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n        }>>;\n        required: true;\n    };\n}>>, {}, {}>"
@@ -30522,7 +30696,7 @@
           "name": "GlobalXBus",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 950
+            "endIndex": 966
           }
         },
         {
@@ -31524,7 +31698,25 @@
             },
             {
               "kind": "Content",
-              "text": " | null | undefined;\n        UserSelectedARelatedPrompt?: number | undefined;\n        UserSelectedARelatedPromptQuery?: number | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": " | null | undefined;\n        UserSelectedARelatedPrompt?: number | undefined;\n        UserSelectedARelatedPromptQuery?: number | undefined;\n        UserClickedARelatedPromptResult?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedARelatedPromptAdd2Cart?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -31758,7 +31950,7 @@
           "name": "HierarchicalFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 244
+            "endIndex": 248
           }
         },
         {
@@ -47476,7 +47668,7 @@
             },
             {
               "kind": "Content",
-              "text": "'search_box' | 'url' | 'query_suggestion' | 'next_query' | 'popular_search' | 'history_query' | 'partial_result' | 'related_tag' | 'spellcheck' | 'customer' | 'semantics'"
+              "text": "'search_box' | 'url' | 'query_suggestion' | 'next_query' | 'popular_search' | 'history_query' | 'partial_result' | 'related_tag' | 'spellcheck' | 'customer' | 'semantics' | 'related-prompts'"
             },
             {
               "kind": "Content",
@@ -53095,7 +53287,25 @@
             },
             {
               "kind": "Content",
-              "text": "<{\n        index: number;\n        nextQueries: string[];\n        suggestionText: string;\n        type: string;\n        modelName: \"RelatedPrompt\";\n    }[]>;\n    listItems: import(\"vue\")."
+              "text": "<{\n        index: number;\n        relatedPromptNextQueries: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedPromptNextQuery",
+              "canonicalReference": "@empathyco/x-components!RelatedPromptNextQuery:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n        suggestionText: string;\n        type: string;\n        toolingDisplayTagging: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "TaggingRequest",
+              "canonicalReference": "@empathyco/x-components!TaggingRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n        modelName: \"RelatedPrompt\";\n    }[]>;\n    listItems: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -53356,7 +53566,7 @@
           "name": "RelatedPromptsTagList",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 78
+            "endIndex": 82
           }
         },
         {
@@ -53406,6 +53616,62 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!RelatedPromptsXEvents#UserClickedARelatedPromptAdd2Cart:member",
+              "docComment": "/**\n * The user has clicked one add to cart from a prompt. Payload: The result that the user clicked.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "UserClickedARelatedPromptAdd2Cart: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Result",
+                  "canonicalReference": "@empathyco/x-components!Result:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "UserClickedARelatedPromptAdd2Cart",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!RelatedPromptsXEvents#UserClickedARelatedPromptResult:member",
+              "docComment": "/**\n * The user has clicked one prompt. Payload: The result that the user clicked.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "UserClickedARelatedPromptResult: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Result",
+                  "canonicalReference": "@empathyco/x-components!Result:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "UserClickedARelatedPromptResult",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!RelatedPromptsXEvents#UserSelectedARelatedPrompt:member",
@@ -68450,7 +68716,25 @@
             },
             {
               "kind": "Content",
-              "text": " | null | undefined;\n        UserSelectedARelatedPrompt?: number | undefined;\n        UserSelectedARelatedPromptQuery?: number | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": " | null | undefined;\n        UserSelectedARelatedPrompt?: number | undefined;\n        UserSelectedARelatedPromptQuery?: number | undefined;\n        UserClickedARelatedPromptResult?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedARelatedPromptAdd2Cart?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -68594,7 +68878,7 @@
           "name": "SimpleFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 214
+            "endIndex": 218
           }
         },
         {
@@ -71571,6 +71855,42 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserClickedARelatedPromptResult: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserClickedARelatedPromptAdd2Cart: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Result",
+              "canonicalReference": "@empathyco/x-components!Result:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n    }>>;\n}, {}, {}, {}, import(\"vue\")."
@@ -71627,7 +71947,7 @@
           "name": "SnippetCallbacks",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 482
+            "endIndex": 490
           }
         },
         {
@@ -75987,6 +76307,80 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!trackToolingAdd2CartWire:var",
+          "docComment": "/**\n * Performs a track of a display result being clicked.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "trackToolingAdd2CartWire: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Wire",
+              "canonicalReference": "@empathyco/x-components!Wire:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Taggable",
+              "canonicalReference": "@empathyco/x-components!Taggable:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/tagging/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "trackToolingAdd2CartWire",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!trackToolingDisplayClickedWire:var",
+          "docComment": "/**\n * Performs a track of a display result being clicked.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "trackToolingDisplayClickedWire: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Wire",
+              "canonicalReference": "@empathyco/x-components!Wire:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Taggable",
+              "canonicalReference": "@empathyco/x-components!Taggable:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/tagging/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "trackToolingDisplayClickedWire",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-components!TypingOptions:interface",