@empathyco/x-components 3.0.0-alpha.413 → 3.0.0-alpha.415

package/report/x-adapter-platform.api.json

@@ -222,6 +222,256 @@
             "endIndex": 8
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!experienceControlsEndpointAdapter:var",
+          "docComment": "/**\n * . Default adapter for the experience controls endpoint.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "experienceControlsEndpointAdapter: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtendableEndpointAdapter",
+              "canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/endpoint-adapters/experience-controls.endpoint-adapter.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "experienceControlsEndpointAdapter",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!experienceControlsRequestMapper:var",
+          "docComment": "/**\n * Default implementation for the ExperienceControlsRequestMapper.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "experienceControlsRequestMapper: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Mapper",
+              "canonicalReference": "@empathyco/x-adapter!Mapper:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformExperienceControlsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/mappers/requests/experience-controls-request.mapper.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "experienceControlsRequestMapper",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!experienceControlsRequestSchema:var",
+          "docComment": "/**\n * Default implementation for the ExperienceControlsRequestSchema.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "experienceControlsRequestSchema: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "MutableSchema",
+              "canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformExperienceControlsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/schemas/requests/experience-controls-request.schema.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "experienceControlsRequestSchema",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!experienceControlsResponseMapper:var",
+          "docComment": "/**\n * Default implementation for the ExperienceControlsResponseMapper.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "experienceControlsResponseMapper: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Mapper",
+              "canonicalReference": "@empathyco/x-adapter!Mapper:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformExperienceControlsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/mappers/responses/experience-controls-response.mapper.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "experienceControlsResponseMapper",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-adapter-platform!experienceControlsResponseSchema:var",
+          "docComment": "/**\n * Default implementation for the ExperienceControlsResponseSchema.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "experienceControlsResponseSchema: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@empathyco/x-adapter\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "MutableSchema",
+              "canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformExperienceControlsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsResponse",
+              "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "dist/types/schemas/responses/experience-controls-response.schema.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "experienceControlsResponseSchema",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 8
+          }
+        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-adapter-platform!extractUrlParameters:function(1)",
@@ -1290,6 +1540,56 @@
           "name": "PlatformAdapter",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformAdapter#experienceControls:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "experienceControls: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ExtendableEndpointAdapter",
+                  "canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ExperienceControlsRequest",
+                  "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ExperienceControlsResponse",
+                  "canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "experienceControls",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 7
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-adapter-platform!PlatformAdapter#identifierResults:member",
@@ -1943,6 +2243,72 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsRequest:interface",
+          "docComment": "/**\n * Request for the `experience controls` endpoint.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PlatformExperienceControlsRequest extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "PlatformExtraParamsRequest",
+              "canonicalReference": "@empathyco/x-adapter-platform!~PlatformExtraParamsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "dist/types/types/requests/experience-controls-request.model.d.ts",
+          "releaseTag": "Public",
+          "name": "PlatformExperienceControlsRequest",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsResponse:interface",
+          "docComment": "/**\n * Response for the `experience controls` endpoint.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PlatformExperienceControlsResponse extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Dictionary",
+              "canonicalReference": "@empathyco/x-utils!Dictionary:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<unknown>"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "dist/types/types/responses/experience-controls-response.model.d.ts",
+          "releaseTag": "Public",
+          "name": "PlatformExperienceControlsResponse",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-adapter-platform!PlatformFacet:interface",

package/report/x-components.api.json

@@ -54229,6 +54229,34 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!setSearchSelectedFiltersFromPreview:var",
+          "docComment": "/**\n * Sets the search state `selectedFilters` with the selectedQueryPreview's filters.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "setSearchSelectedFiltersFromPreview: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../../wiring\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyWire",
+              "canonicalReference": "@empathyco/x-components!AnyWire:type"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/search/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "setSearchSelectedFiltersFromPreview",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!setSearchUrlParams:var",
@@ -54298,6 +54326,34 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!setSelectedFiltersFromPreview:var",
+          "docComment": "/**\n * Sets the filters of the facets module from a selectedQueryPreview's filters.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "setSelectedFiltersFromPreview: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../../wiring/wiring.types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyWire",
+              "canonicalReference": "@empathyco/x-components!AnyWire:type"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/facets/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "setSelectedFiltersFromPreview",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!setSelectedQueryPreviewWire:var",
@@ -54970,6 +55026,34 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!setUrlSelectedFiltersFromPreview:var",
+          "docComment": "/**\n * Sets the filters of the url module from a selectedQueryPreview's filters.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "setUrlSelectedFiltersFromPreview: "
+            },
+            {
+              "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": "setUrlSelectedFiltersFromPreview",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!setUrlSort:var",
@@ -66880,6 +66964,15 @@
               "kind": "Content",
               "text": ", "
             },
+            {
+              "kind": "Reference",
+              "text": "ExperienceControlsXEvents",
+              "canonicalReference": "@empathyco/x-components!~ExperienceControlsXEvents:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
             {
               "kind": "Reference",
               "text": "UrlXEvents",
@@ -67817,6 +67910,10 @@
             {
               "startIndex": 35,
               "endIndex": 36
+            },
+            {
+              "startIndex": 37,
+              "endIndex": 38
             }
           ]
         },
@@ -68701,6 +68798,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!XModulesTree#experienceControls:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "experienceControls: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ExperienceControlsXModule",
+                  "canonicalReference": "@empathyco/x-components!~ExperienceControlsXModule:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "experienceControls",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!XModulesTree#extraParams:member",

package/report/x-components.api.md

@@ -1929,6 +1929,9 @@ export const facetsWiring: {
     SearchResponseChanged: {
         clearStickyFilters: Wire<InternalSearchResponse>;
     };
+    UserAcceptedAQueryPreview: {
+        setSelectedFiltersFromPreview: AnyWire;
+    };
 };
 
 // @public
@@ -4809,6 +4812,7 @@ export const searchWiring: {
     UserAcceptedAQueryPreview: {
         setSearchQueryFromPreview: AnyWire;
         setSearchExtraParamsFromPreview: AnyWire;
+        setSearchSelectedFiltersFromPreview: AnyWire;
         saveOriginWire: AnyWire;
     };
     QueryPreviewUnselected: {
@@ -5114,12 +5118,18 @@ export const setSearchQuery: Wire<string>;
 // @public
 export const setSearchQueryFromPreview: AnyWire;
 
+// @public
+export const setSearchSelectedFiltersFromPreview: AnyWire;
+
 // @public
 export const setSearchUrlParams: SearchXStoreModule['actions']['setUrlParams'];
 
 // @public
 export const setSelectedFilters: Wire<Filter[]>;
 
+// @public
+export const setSelectedFiltersFromPreview: AnyWire;
+
 // @public
 export const setSelectedQueryPreviewWire: Wire<QueryPreviewInfo | null>;
 
@@ -5174,6 +5184,9 @@ export const setUrlRelatedTags: Wire<RelatedTag_2[]>;
 // @public
 export const setUrlScroll: Wire<string>;
 
+// @public
+export const setUrlSelectedFiltersFromPreview: AnyWire;
+
 // @public
 export const setUrlSort: Wire<string>;
 
@@ -5869,6 +5882,7 @@ export const urlWiring: {
     UserAcceptedAQueryPreview: {
         setUrlQueryFromPreview: AnyWire;
         setUrlParamsFromPreview: AnyWire;
+        setUrlSelectedFiltersFromPreview: AnyWire;
     };
     UserClearedQuery: {
         setUrlQuery: Wire<string>;
@@ -6173,8 +6187,10 @@ export type XEventPayload<Event extends XEvent> = XEventsTypes[Event] extends vo
 // @public
 export type XEventsOf<Type> = PropsWithType<XEventsTypes, Type>;
 
+// Warning: (ae-forgotten-export) The symbol "ExperienceControlsXEvents" needs to be exported by the entry point index.d.ts
+//
 // @public
-export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, UrlXEvents {
+export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents {
     ColumnsNumberProvided: number;
     ModuleRegistered: XModuleName;
     RenderedColumnsNumberChanged: number;
@@ -6293,6 +6309,10 @@ export interface XModulesTree {
     device: DeviceXModule;
     // (undocumented)
     empathize: EmpathizeXModule;
+    // Warning: (ae-forgotten-export) The symbol "ExperienceControlsXModule" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    experienceControls: ExperienceControlsXModule;
     // (undocumented)
     extraParams: ExtraParamsXModule;
     // (undocumented)