@empathyco/x-components 6.0.0-alpha.180 → 6.0.0-alpha.181

package/report/x-components.api.json

@@ -3676,6 +3676,77 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@empathyco/x-components!applyHierarchicalSelection:function(1)",
+          "docComment": "/**\n * Recursively applies the selected state to hierarchical filters and their children.\n *\n * @param filters - The hierarchical filters to update.\n *\n * @param selectedIds - The set of selected filter ids.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function applyHierarchicalSelection(filters: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HierarchicalFilter",
+              "canonicalReference": "@empathyco/x-components!HierarchicalFilter_2:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ", selectedIds: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Set",
+              "canonicalReference": "!Set:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<string | number>"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/facets/utils.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 7,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "filters",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "selectedIds",
+              "parameterTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 6
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "applyHierarchicalSelection"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-components!areFiltersDifferent:function(1)",
@@ -23184,7 +23255,148 @@
           "releaseTag": "Public",
           "name": "FacetsActions",
           "preserveMemberOrder": false,
-          "members": [],
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsActions#cancelFetchAndSaveFacetsResponse:member",
+              "docComment": "/**\n * Cancels / interrupt {@link FacetsActions.cancelFetchAndSaveFacetsResponse} synchronous promise.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "cancelFetchAndSaveFacetsResponse: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "cancelFetchAndSaveFacetsResponse",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsActions#fetchAndSaveFacetsResponse:member",
+              "docComment": "/**\n * Fetches a new facets response and stores them in the module state.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "fetchAndSaveFacetsResponse: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(request: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FacetsRequest",
+                  "canonicalReference": "@empathyco/x-components!FacetsRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "fetchAndSaveFacetsResponse",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsActions#fetchFacetsResponse:member",
+              "docComment": "/**\n * Fetches the facets response and returns them.\n *\n * @returns The new search response.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "fetchFacetsResponse: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(request: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FacetsRequest",
+                  "canonicalReference": "@empathyco/x-components!FacetsRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FacetsResponse",
+                  "canonicalReference": "@empathyco/x-components!FacetsResponse:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "fetchFacetsResponse",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsActions#saveOrigin:member",
+              "docComment": "/**\n * Creates a {@link QueryOrigin} and saves it.\n *\n * @param originInit - The object to create the origin with.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "saveOrigin: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(originInit: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "QueryOriginInit",
+                  "canonicalReference": "@empathyco/x-components!QueryOriginInit:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "saveOrigin",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            }
+          ],
           "extendsTokenRanges": []
         },
         {
@@ -23365,6 +23577,38 @@
                 "endIndex": 7
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsGetters#request:member",
+              "docComment": "/**\n * The adapter request object for retrieving the facets, or null if there is no valid data to create a request.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "request: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "FacetsRequest",
+                  "canonicalReference": "@empathyco/x-components!FacetsRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "request",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!FacetsGetters#selectedFilters:member",
@@ -23546,6 +23790,15 @@
               "kind": "Content",
               "text": "export interface FacetsMutations extends "
             },
+            {
+              "kind": "Reference",
+              "text": "StatusMutations",
+              "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
             {
               "kind": "Reference",
               "text": "QueryMutations",
@@ -23898,6 +24151,78 @@
                 "endIndex": 4
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsMutations#setOrigin:member",
+              "docComment": "/**\n * Sets the origin of the module.\n *\n * @param origin - The new origin.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setOrigin: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(origin: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "QueryOrigin",
+                  "canonicalReference": "@empathyco/x-components!QueryOrigin:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined | null) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setOrigin",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsMutations#setParams:member",
+              "docComment": "/**\n * Sets the extra params of the module.\n *\n * @param params - The new extra params.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setParams: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(params: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Dictionary",
+                  "canonicalReference": "@empathyco/x-utils!Dictionary:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<unknown>) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!FacetsMutations#setPreselectedFilters:member",
@@ -23978,7 +24303,11 @@
             },
             {
               "startIndex": 3,
-              "endIndex": 7
+              "endIndex": 4
+            },
+            {
+              "startIndex": 5,
+              "endIndex": 9
             }
           ]
         },
@@ -24552,7 +24881,25 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface FacetsState "
+              "text": "export interface FacetsState extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "StatusState",
+              "canonicalReference": "@empathyco/x-components!StatusState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "fileUrlPath": "src/x-modules/facets/store/types.ts",
@@ -24749,21 +25096,21 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@empathyco/x-components!FacetsState#preselectedFilters:member",
-              "docComment": "/**\n * Record of preselected filters indexed by its id.\n */\n",
+              "canonicalReference": "@empathyco/x-components!FacetsState#origin:member",
+              "docComment": "/**\n * The origin property of the request.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "preselectedFilters: "
+                  "text": "origin: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "RawFilter",
-                  "canonicalReference": "@empathyco/x-components!RawFilter:interface"
+                  "text": "QueryOrigin",
+                  "canonicalReference": "@empathyco/x-components!QueryOrigin:type"
                 },
                 {
                   "kind": "Content",
-                  "text": "[]"
+                  "text": " | null"
                 },
                 {
                   "kind": "Content",
@@ -24773,7 +25120,7 @@
               "isReadonly": false,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "preselectedFilters",
+              "name": "origin",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 3
@@ -24781,16 +25128,21 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@empathyco/x-components!FacetsState#query:member",
-              "docComment": "/**\n * The current query {@link FacetsState.query}.\n */\n",
+              "canonicalReference": "@empathyco/x-components!FacetsState#params:member",
+              "docComment": "/**\n * The extra params property of the state.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "query: "
+                  "text": "params: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Dictionary",
+                  "canonicalReference": "@empathyco/x-utils!Dictionary:type"
                 },
                 {
                   "kind": "Content",
-                  "text": "string"
+                  "text": "<unknown>"
                 },
                 {
                   "kind": "Content",
@@ -24800,10 +25152,42 @@
               "isReadonly": false,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "query",
+              "name": "params",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 2
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!FacetsState#preselectedFilters:member",
+              "docComment": "/**\n * Record of preselected filters indexed by its id.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "preselectedFilters: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RawFilter",
+                  "canonicalReference": "@empathyco/x-components!RawFilter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "preselectedFilters",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
               }
             },
             {
@@ -24857,7 +25241,16 @@
               }
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 4
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -28793,6 +29186,61 @@
           ],
           "name": "flatHierarchicalFilters"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@empathyco/x-components!flattenAllFilters:function(1)",
+          "docComment": "/**\n * Flattens all filters from an array of facets, including hierarchical filters.\n *\n * @param facets - The list of facets to extract filters from.\n *\n * @returns A flat array of all filters from all facets.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function flattenAllFilters(facets: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Facet",
+              "canonicalReference": "@empathyco/x-components!Facet:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Filter",
+              "canonicalReference": "@empathyco/x-components!Filter:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/facets/utils.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 4,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "facets",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "flattenAllFilters"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!FOCUSABLE_SELECTORS:var",

package/report/x-components.api.md

@@ -471,6 +471,11 @@ export type AnyXStoreModule = XStoreModule<any, any, any, any>;
 // @public
 export type AnyXStoreModuleOption = XStoreModuleOptions<AnyXStoreModule>;
 
+// Warning: (ae-forgotten-export) The symbol "HierarchicalFilter_2" needs to be exported by the entry point index.d.ts
+//
+// @public
+export function applyHierarchicalSelection(filters: HierarchicalFilter_2[], selectedIds: Set<string | number>): void;
+
 // @public
 export function areFiltersDifferent(someFilters: Filter[], anotherFilters: Filter[]): boolean;
 
@@ -2811,6 +2816,12 @@ export const facets: FacetsXStoreModule['getters']['facets'];
 
 // @public
 export interface FacetsActions {
+    cancelFetchAndSaveFacetsResponse: () => void;
+    // Warning: (ae-forgotten-export) The symbol "FacetsRequest" needs to be exported by the entry point index.d.ts
+    fetchAndSaveFacetsResponse: (request: FacetsRequest | null) => void;
+    // Warning: (ae-forgotten-export) The symbol "FacetsResponse" needs to be exported by the entry point index.d.ts
+    fetchFacetsResponse: (request: FacetsRequest) => FacetsResponse;
+    saveOrigin: (originInit: QueryOriginInit) => void;
 }
 
 // @public
@@ -2846,6 +2857,7 @@ export const facetsEmitters: {
 // @public
 export interface FacetsGetters {
     facets: Record<Facet['id'], Facet>;
+    request: FacetsRequest | null;
     selectedFilters: Filter[];
     selectedFiltersByFacet: FiltersByFacet;
     selectedFiltersForRequest: Filter[];
@@ -2858,7 +2870,7 @@ export interface FacetsGroup {
 }
 
 // @public
-export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsState> {
+export interface FacetsMutations extends StatusMutations, QueryMutations, ConfigMutations<FacetsState> {
     clearStickyFilters: () => void;
     mutateFilter: (payload: MutateFilterPayload) => void;
     removeFacet: (facet: Facet) => void;
@@ -2868,6 +2880,8 @@ export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsS
     setFacet: (facet: Facet) => void;
     setFacetGroup: (facetGroupEntry: FacetGroupEntry) => void;
     setFilters: (filters: Filter[]) => void;
+    setOrigin: (origin: QueryOrigin | undefined | null) => void;
+    setParams: (params: Dictionary<unknown>) => void;
     setPreselectedFilters: (filters: RawFilter[]) => void;
     setStickyFilter: (filter: RawFilter) => void;
 }
@@ -2913,13 +2927,14 @@ export interface FacetsService {
 }
 
 // @public
-export interface FacetsState {
+export interface FacetsState extends StatusState, QueryState {
     config: FacetsConfig;
     facets: Record<Facet['id'], Omit<Facet, 'filters'>>;
     filters: Record<Filter['id'], Filter>;
     groups: Record<Facet['id'], GroupId>;
+    origin: QueryOrigin | null;
+    params: Dictionary<unknown>;
     preselectedFilters: RawFilter[];
-    query: string;
     stickyFilters: Record<Filter['id'], Filter>;
 }
 
@@ -2988,7 +3003,6 @@ export interface FacetsXEvents {
     SelectedFiltersForRequestChanged: Filter[];
     UserChangedSelectedFilters: Filter[];
     UserClickedAFilter: Filter;
-    // Warning: (ae-forgotten-export) The symbol "HierarchicalFilter_2" needs to be exported by the entry point index.d.ts
     UserClickedAHierarchicalFilter: HierarchicalFilter_2;
     UserClickedAllFilter: [Facet['id']];
     // Warning: (ae-forgotten-export) The symbol "NumberRangeFilter_2" needs to be exported by the entry point index.d.ts
@@ -3329,6 +3343,9 @@ devMode: boolean;
 // @public
 export function flatHierarchicalFilters(hierarchicalFilters: HierarchicalFilter_2[]): HierarchicalFilter_2[];
 
+// @public
+export function flattenAllFilters(facets: Facet[]): Filter[];
+
 // @public
 export const FOCUSABLE_SELECTORS = "a[href], button:not([disabled]), details, input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex=\"-1\"])";