@empathyco/x-components 7.3.0 → 7.4.0

package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts

@@ -0,0 +1,11 @@
+import type { BrowseXStoreModule } from '../types';
+/**
+ * Default implementation for the {@link BrowseActions.saveBrowseResponse}.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param response - The {@link @empathyco/x-types#BrowseResponse} to save.
+ * @public
+ */
+export declare const saveBrowseResponse: BrowseXStoreModule['actions']['saveBrowseResponse'];
+//# sourceMappingURL=save-browse-response.action.d.ts.map

package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"save-browse-response.action.d.ts","sourceRoot":"","sources":["../../../../../../../src/x-modules/browse/store/actions/save-browse-response.action.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAElD;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAoClF,CAAA"}

package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts

@@ -0,0 +1,11 @@
+import type { BrowseXStoreModule } from '../types';
+/**
+ * Default implementation for the {@link BrowseActions.saveOrigin}.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param queryOriginInit - The object to create the {@link QueryOrigin} with.
+ * @public
+ */
+export declare const saveOrigin: BrowseXStoreModule['actions']['saveOrigin'];
+//# sourceMappingURL=save-origin.action.d.ts.map

package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"save-origin.action.d.ts","sourceRoot":"","sources":["../../../../../../../src/x-modules/browse/store/actions/save-origin.action.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAGlD;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,YAAY,CAKlE,CAAA"}

package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts

@@ -0,0 +1,11 @@
+import type { BrowseXStoreModule } from '../types';
+/**
+ * Default implementation for the {@link BrowseActions.setUrlParams}.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param urlParams - List of params from the url.
+ * @public
+ */
+export declare const setUrlParams: BrowseXStoreModule['actions']['setUrlParams'];
+//# sourceMappingURL=set-url-params.action.d.ts.map

package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-url-params.action.d.ts","sourceRoot":"","sources":["../../../../../../../src/x-modules/browse/store/actions/set-url-params.action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAElD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,cAAc,CAetE,CAAA"}

package/types/src/x-modules/browse/store/emitters.d.ts

@@ -0,0 +1,35 @@
+/**
+ * {@link StoreEmitters} For the browse module.
+ *
+ * @internal
+ */
+export declare const browseEmitters: {
+    FacetsChanged: {
+        selector: (state: import("./types").BrowseState) => import("@empathyco/x-types").Facet[];
+        filter(newValue: import("@empathyco/x-types").Facet[], oldValue: import("@empathyco/x-types").Facet[]): boolean;
+    };
+    PageChanged: (state: import("./types").BrowseState) => number;
+    ResultsChanged: (state: import("./types").BrowseState) => import("@empathyco/x-types").Result[];
+    BrowseRequestChanged: (_: import("./types").BrowseState, getters: import("../../..").Returns<import("../../../store").GettersTree<import("./types").BrowseState, import("./types").BrowseGetters>>) => import("..").InternalBrowseRequest | null;
+    BrowseRequestUpdated: (_: import("./types").BrowseState, getters: import("../../..").Returns<import("../../../store").GettersTree<import("./types").BrowseState, import("./types").BrowseGetters>>) => import("..").InternalBrowseRequest | null;
+    BrowseResponseChanged: {
+        selector: (state: import("./types").BrowseState, getters: import("../../..").Returns<import("../../../store").GettersTree<import("./types").BrowseState, import("./types").BrowseGetters>>) => {
+            request: import("..").InternalBrowseRequest;
+            status: import("../../../store").RequestStatus;
+            banners: import("@empathyco/x-types").Banner[];
+            facets: import("@empathyco/x-types").Facet[];
+            promoteds: import("@empathyco/x-types").Promoted[];
+            browseTagging: import("@empathyco/x-types").TaggingRequest;
+            displayBrowseTagging: import("@empathyco/x-types").TaggingRequest;
+            results: import("@empathyco/x-types").Result[];
+            totalResults: number;
+        };
+        filter: (newValue: import("..").InternalBrowseResponse, oldValue: import("..").InternalBrowseResponse) => boolean;
+    };
+    BrowseTaggingChanged: {
+        selector: (state: import("./types").BrowseState) => import("@empathyco/x-types").TaggingRequest;
+        filter: ({ url }: import("@empathyco/x-types").TaggingRequest) => boolean;
+    };
+    SortChanged: (state: import("./types").BrowseState) => string;
+};
+//# sourceMappingURL=emitters.d.ts.map

package/types/src/x-modules/browse/store/emitters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emitters.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/browse/store/emitters.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;gHAGK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;CAiCrC,CAAA"}

package/types/src/x-modules/browse/store/getters/index.d.ts

@@ -0,0 +1,2 @@
+export { request as browseRequest } from './request.getter';
+//# sourceMappingURL=index.d.ts.map

package/types/src/x-modules/browse/store/getters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/x-modules/browse/store/getters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,kBAAkB,CAAA"}

package/types/src/x-modules/browse/store/getters/request.getter.d.ts

@@ -0,0 +1,13 @@
+import type { BrowseXStoreModule } from '../types';
+/**
+ * Default implementation for the {@link BrowseGetters.request} getter.
+ *
+ * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the browse
+ * module.
+ * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the
+ * browse module.
+ * @returns The browse request to fetch data from the API.
+ * @public
+ */
+export declare const request: BrowseXStoreModule['getters']['request'];
+//# sourceMappingURL=request.getter.d.ts.map

package/types/src/x-modules/browse/store/getters/request.getter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.getter.d.ts","sourceRoot":"","sources":["../../../../../../../src/x-modules/browse/store/getters/request.getter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAElD;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC,SAAS,CAoB5D,CAAA"}

package/types/src/x-modules/browse/store/index.d.ts

@@ -0,0 +1,6 @@
+export * from './actions';
+export * from './emitters';
+export * from './getters';
+export * from './module';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/types/src/x-modules/browse/store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/browse/store/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}

package/types/src/x-modules/browse/store/module.d.ts

@@ -0,0 +1,41 @@
+import type { Stats } from '@empathyco/x-types';
+import type { BrowseXStoreModule } from './types';
+/**
+ * {@link XStoreModule} For the browse module.
+ *
+ * @internal
+ */
+export declare const browseXStoreModule: BrowseXStoreModule;
+/**
+ * Function to return the "resettable" part of the state. This will be used in the `resetState`
+ * mutation to reset to the initial state.
+ *
+ * @returns The "resettable" part of the {@link BrowseState}.
+ *
+ * @internal
+ */
+export declare function resettableState(): {
+    selectedCategory: {
+        browseValue: string;
+        browseField: string;
+    };
+    results: never[];
+    facets: never[];
+    banners: never[];
+    promoteds: never[];
+    totalResults: number;
+    sort: string;
+    page: number;
+    origin: null;
+    isAppendResults: boolean;
+    browseTagging: {
+        url: string;
+        params: {};
+    };
+    displayBrowseTagging: {
+        url: string;
+        params: {};
+    };
+    stats: Stats;
+};
+//# sourceMappingURL=module.d.ts.map

package/types/src/x-modules/browse/store/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/browse/store/module.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAoBjD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAyGhC,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe;;;;;;;;;;;;;;;;;;;;;;WAuBd,KAAK;EAErB"}

package/types/src/x-modules/browse/store/types.d.ts

@@ -0,0 +1,273 @@
+import type { Banner, BrowsableRequest, BrowseRequest, BrowseResponse, Facet, Filter, Promoted, Result, Sort, Stats, TaggingRequest } from '@empathyco/x-types';
+import type { Dictionary } from '@empathyco/x-utils';
+import type { StatusMutations, StatusState, XActionContext, XStoreModule } from '../../../store';
+import type { ConfigMutations } from '../../../store/utils/config-store.utils';
+import type { QueryOrigin, QueryOriginInit, UrlParams } from '../../../types';
+import type { BrowseConfig } from '../config.types';
+import type { InternalBrowseRequest, WatchedInternalBrowseRequest } from '../types';
+/**
+ * Browse store state.
+ *
+ * @public
+ */
+export interface BrowseState extends StatusState {
+    /** The list of the banners, related to the `browseCategory` property of the state. */
+    banners: Banner[];
+    /** The configuration of the browse module. */
+    config: BrowseConfig;
+    /** The list of the facets, related to the `query` property of the state. */
+    facets: Facet[];
+    /** A flag to indicate if new results are append to the current instead of replacing them. */
+    isAppendResults: boolean;
+    /** Flag indicating if there is a no results situation. */
+    isNoResults: boolean;
+    /** Flag indicating if there is a no results situation with filters selected. */
+    fromNoResultsWithFilters: boolean;
+    /** The origin property of the request. */
+    origin: QueryOrigin | null;
+    /** The current page of the request. */
+    page: number;
+    /** The extra params property of the state. */
+    params: Dictionary<unknown>;
+    /** The list of the promoted, related to the `query` property of the state. */
+    promoteds: Promoted[];
+    /** The browse tagging used to track the browse events. */
+    browseTagging: TaggingRequest;
+    /** The display tagging used to track the browse events. */
+    displayBrowseTagging: TaggingRequest;
+    /** The list of the results, related to the `query` property of the state. */
+    results: Result[];
+    /**
+     * The dictionary of selected filters, used to perform the browse request.
+     * The key is the facet id, and the value the list of filters for that facet.
+     */
+    selectedFilters: Dictionary<Filter[]>;
+    /** The way of ordering the results. */
+    sort: Sort;
+    /** The stats of the results. */
+    stats: Stats;
+    /** The total number of results, related to the `query` property of the state. */
+    totalResults: number;
+    /** The current selected category of the request  */
+    selectedCategory: BrowsableRequest;
+}
+/**
+ * Browse store getters.
+ *
+ * @public
+ */
+export interface BrowseGetters {
+    /**
+     * The adapter request object for retrieving the results, or null if there is no
+     * valid data to create a request.
+     */
+    request: InternalBrowseRequest | null;
+}
+/**
+ * Browse store mutations.
+ *
+ * @public
+ */
+export interface BrowseMutations extends StatusMutations, ConfigMutations<BrowseState> {
+    /**
+     * Append the results to the results state.
+     *
+     * @param results - Results array.
+     */
+    appendResults: (results: Result[]) => void;
+    /**
+     * Resets the "resettable" part of the Browse state to the initial state. See the
+     * {@link BrowseXStoreModule} for details.
+     */
+    resetState: () => void;
+    /**
+     * Resets the "resettable" part of the Browse state like {@link BrowseMutations.resetState} but
+     * maintains the values required to perform the browse request again.
+     */
+    resetStateForReload: () => void;
+    /**
+     * Sets the banners of the module.
+     *
+     * @param banners - The new banners to save to the state.
+     */
+    setBanners: (banners: Banner[]) => void;
+    /**
+     * Sets the facets of the module.
+     *
+     * @param facets - The new facets to save to the state.
+     */
+    setFacets: (facets: Facet[]) => void;
+    /**
+     * Set the `isAppendResuls` flag value.
+     *
+     * @param isAppendResults - The new flag value.
+     */
+    setIsAppendResults: (isAppendResults: boolean) => void;
+    /**
+     * Sets the `isNoResults` flag value.
+     *
+     * @param isNoResults - The new flag value.
+     */
+    setIsNoResults: (isNoResults: boolean) => void;
+    /**
+     * Sets the `fromNoResultsWithFilters` flag value.
+     *
+     * @param fromNoResultsWithFilters - The new flag value.
+     */
+    setFromNoResultsWithFilters: (fromNoResultsWithFilters: boolean) => void;
+    /**
+     * Sets the origin of the module.
+     *
+     * @param origin - The new origin.
+     */
+    setOrigin: (origin: QueryOrigin | undefined | null) => void;
+    /**
+     * Sets the page of the module.
+     *
+     * @param page - The new page.
+     */
+    setPage: (page: number) => void;
+    /** Sets the selected category of the module.
+     *
+     * @param selectedCategory - The new selectedCategory.
+     */
+    setSelectedCategory: (selectedCategory: BrowsableRequest) => void;
+    /**
+     * Sets the extra params of the module.
+     *
+     * @param params - The new extra params.
+     */
+    setParams: (params: Dictionary<unknown>) => void;
+    /**
+     * Sets the promoteds of the module.
+     *
+     * @param promoteds - The new promoted to save to the state.
+     */
+    setPromoteds: (promoteds: Promoted[]) => void;
+    /**
+     * Sets the browse tagging of the module, which is used to track the query.
+     *
+     * @param browseTagging - The new query tagging object to save to the state.
+     */
+    setBrowseTagging: (browseTagging: TaggingRequest) => void;
+    /**
+     * Sets the display tagging of the module.
+     *
+     * @param displayBrowseTagging - The new display tagging object to save to the state.
+     */
+    setDisplayBrowseTagging: (displayBrowseTagging: TaggingRequest) => void;
+    /**
+     * Sets the results of the module.
+     *
+     * @param results - The new results to save to the state.
+     */
+    setResults: (results: Result[]) => void;
+    /**
+     * Sets the selected filters of the module.
+     *
+     * @param selectedFilters - The new selected filters to save to the state.
+     */
+    setSelectedFilters: (selectedFilters: Filter[]) => void;
+    /**
+     * Sets the selected sort option of the module.
+     *
+     * @param sort - The new sort.
+     */
+    setSort: (sort: Sort) => void;
+    /**
+     * Sets the stats of the module.
+     *
+     * @param stats - The new stats to save to the state.
+     */
+    setStats: (stats: Stats) => void;
+    /**
+     * Sets the total results of the module.
+     *
+     * @param totalResults - The new total results to save to the state.
+     */
+    setTotalResults: (totalResults: number) => void;
+    /**
+     * Updates a result with new fields.
+     *
+     * @param result - A result containing at least an id, and the properties to modify.
+     */
+    updateResult: (result: Partial<Result> & Pick<Result, 'id'>) => void;
+    /**
+     * Updates the results with the enrichment results.
+     *
+     * @param enrichmentResults - The enrichment results.
+     */
+    updateResultsFromEnrichment: (enrichmentResults: any[]) => void;
+}
+/**
+ * Browse store actions.
+ *
+ * @public
+ */
+export interface BrowseActions {
+    /**
+     * Batches state resets in a single action after {@link BrowseGetters.request} parameters update.
+     *
+     * @param watchedRequest - The watched internal browse request object.
+     */
+    resetRequestOnRefinement: (watchedRequest: WatchedInternalBrowseRequest) => void;
+    /**
+     * Cancels / interrupt {@link BrowseActions.fetchAndSaveBrowseResponse} synchronous promise.
+     */
+    cancelFetchAndSaveBrowseResponse: () => void;
+    /**
+     * Fetches a new browse response and stores them in the module state.
+     */
+    fetchAndSaveBrowseResponse: (request: InternalBrowseRequest | null) => void;
+    /**
+     * Fetches the browse response and returns them.
+     *
+     * @returns The new browse response.
+     */
+    fetchBrowseResponse: (request: BrowseRequest) => BrowseResponse;
+    /**
+     * Requests and stores the enrichment results for the results.
+     *
+     * @param results - The results.
+     */
+    fetchAndSaveResultsEnrichment: (results: Result[]) => void;
+    /**
+     * Checks if there are more pages of results to load. If there are, then increases the page
+     * number in state and set to `true` the {@link BrowseState.isAppendResults} flag.
+     *
+     * @remarks This action is to implement the infinite scroll behaviour. To increase the page
+     * for other purposes, please use the {@link BrowseMutations.setPage} mutation.
+     */
+    increasePageAppendingResults: () => void;
+    /**
+     * Checks if the url has params on it and then updates the state with these values.
+     *
+     * @param urlParams - List of params from the url.
+     */
+    setUrlParams: (urlParams: UrlParams) => void;
+    /**
+     * Creates a {@link QueryOrigin} and saves it.
+     *
+     * @param originInit - The object to create the origin with.
+     */
+    saveOrigin: (originInit: QueryOriginInit) => void;
+    /**
+     * Saves the {@link @empathyco/x-types#BrowseResponse}.
+     *
+     * @param response - The {@link @empathyco/x-types#BrowseResponse} to save.
+     */
+    saveBrowseResponse: (response: BrowseResponse) => void;
+}
+/**
+ * Browse type safe store module.
+ *
+ * @public
+ */
+export type BrowseXStoreModule = XStoreModule<BrowseState, BrowseGetters, BrowseMutations, BrowseActions>;
+/**
+ * Alias type for actions context of the {@link BrowseXStoreModule}.
+ *
+ * @public
+ */
+export type BrowseActionContext = XActionContext<BrowseState, BrowseGetters, BrowseMutations, BrowseActions>;
+//# sourceMappingURL=types.d.ts.map

package/types/src/x-modules/browse/store/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/browse/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,KAAK,EACL,MAAM,EACN,QAAQ,EACR,MAAM,EACN,IAAI,EACJ,KAAK,EACL,cAAc,EACf,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAChG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAA;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAA;AAEnF;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,sFAAsF;IACtF,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,8CAA8C;IAC9C,MAAM,EAAE,YAAY,CAAA;IACpB,4EAA4E;IAC5E,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,6FAA6F;IAC7F,eAAe,EAAE,OAAO,CAAA;IACxB,0DAA0D;IAC1D,WAAW,EAAE,OAAO,CAAA;IACpB,gFAAgF;IAChF,wBAAwB,EAAE,OAAO,CAAA;IACjC,0CAA0C;IAC1C,MAAM,EAAE,WAAW,GAAG,IAAI,CAAA;IAC1B,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,8CAA8C;IAC9C,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAA;IAC3B,8EAA8E;IAC9E,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,0DAA0D;IAC1D,aAAa,EAAE,cAAc,CAAA;IAC7B,2DAA2D;IAC3D,oBAAoB,EAAE,cAAc,CAAA;IACpC,6EAA6E;IAC7E,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB;;;OAGG;IACH,eAAe,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAA;IACrC,uCAAuC;IACvC,IAAI,EAAE,IAAI,CAAA;IACV,gCAAgC;IAChC,KAAK,EAAE,KAAK,CAAA;IACZ,iFAAiF;IACjF,YAAY,EAAE,MAAM,CAAA;IACpB,oDAAoD;IACpD,gBAAgB,EAAE,gBAAgB,CAAA;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAA;CACtC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe,EAAE,eAAe,CAAC,WAAW,CAAC;IACpF;;;;OAIG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IAC1C;;;OAGG;IACH,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB;;;OAGG;IACH,mBAAmB,EAAE,MAAM,IAAI,CAAA;IAC/B;;;;OAIG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IACvC;;;;OAIG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,IAAI,CAAA;IACpC;;;;OAIG;IACH,kBAAkB,EAAE,CAAC,eAAe,EAAE,OAAO,KAAK,IAAI,CAAA;IACtD;;;;OAIG;IACH,cAAc,EAAE,CAAC,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;IAC9C;;;;OAIG;IACH,2BAA2B,EAAE,CAAC,wBAAwB,EAAE,OAAO,KAAK,IAAI,CAAA;IACxE;;;;OAIG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI,KAAK,IAAI,CAAA;IAC3D;;;;OAIG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/B;;;OAGG;IACH,mBAAmB,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,KAAK,IAAI,CAAA;IACjE;;;;OAIG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;IAChD;;;;OAIG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,IAAI,CAAA;IAC7C;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,aAAa,EAAE,cAAc,KAAK,IAAI,CAAA;IACzD;;;;OAIG;IACH,uBAAuB,EAAE,CAAC,oBAAoB,EAAE,cAAc,KAAK,IAAI,CAAA;IACvE;;;;OAIG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IACvC;;;;OAIG;IACH,kBAAkB,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IACvD;;;;OAIG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IAChC;;;;OAIG;IACH,eAAe,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/C;;;;OAIG;IACH,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,IAAI,CAAA;IACpE;;;;OAIG;IACH,2BAA2B,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CAChE;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,wBAAwB,EAAE,CAAC,cAAc,EAAE,4BAA4B,KAAK,IAAI,CAAA;IAChF;;OAEG;IACH,gCAAgC,EAAE,MAAM,IAAI,CAAA;IAC5C;;OAEG;IACH,0BAA0B,EAAE,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,KAAK,IAAI,CAAA;IAC3E;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,cAAc,CAAA;IAC/D;;;;OAIG;IACH,6BAA6B,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,IAAI,CAAA;IAC1D;;;;;;OAMG;IACH,4BAA4B,EAAE,MAAM,IAAI,CAAA;IACxC;;;;OAIG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAA;IAC5C;;;;OAIG;IACH,UAAU,EAAE,CAAC,UAAU,EAAE,eAAe,KAAK,IAAI,CAAA;IACjD;;;;OAIG;IACH,kBAAkB,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;CACvD;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAC3C,WAAW,EACX,aAAa,EACb,eAAe,EACf,aAAa,CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,CAC9C,WAAW,EACX,aAAa,EACb,eAAe,EACf,aAAa,CACd,CAAA"}

package/types/src/x-modules/browse/types.d.ts

@@ -0,0 +1,35 @@
+import type { BrowseRequest, BrowseResponse } from '@empathyco/x-types';
+import type { RequestStatus } from '../../store/utils/status-store.utils';
+/**
+ * An internal browse request containing the page used to calculate the start and rows properties of
+ * a {@link @empathyco/x-types#BrowseRequest}.
+ *
+ * @public
+ */
+export interface InternalBrowseRequest extends BrowseRequest {
+    /** The page number. */
+    page: number;
+}
+/**
+ * A representation of a watched {@link InternalBrowseRequest} object, wrapping its new and old
+ * values.
+ *
+ * @public
+ */
+export interface WatchedInternalBrowseRequest {
+    newRequest: InternalBrowseRequest;
+    oldRequest: InternalBrowseRequest;
+}
+/**
+ * An internal browse response containing the {@link InternalBrowseRequest} performed to get a
+ * {@link @empathyco/x-types#BrowseResponse} and its {@link RequestStatus}.
+ *
+ * @public
+ */
+export interface InternalBrowseResponse extends BrowseResponse {
+    /** The browse request. */
+    request: InternalBrowseRequest;
+    /** The response status. */
+    status: RequestStatus;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/src/x-modules/browse/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/browse/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAA;AAEzE;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,EAAE,qBAAqB,CAAA;IACjC,UAAU,EAAE,qBAAqB,CAAA;CAClC;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D,0BAA0B;IAC1B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,2BAA2B;IAC3B,MAAM,EAAE,aAAa,CAAA;CACtB"}

package/types/src/x-modules/browse/wiring.d.ts

@@ -0,0 +1,172 @@
+import type { InternalBrowseRequest } from './types';
+/**
+ * Cancels the {@link BrowseActions.fetchAndSaveBrowseResponse} request promise.
+ *
+ * @public
+ */
+export declare const cancelFetchAndSaveBrowseResponseWire: import("../../wiring").AnyWire;
+/**
+ * Sets the browse state `origin`.
+ *
+ * @public
+ */
+export declare const saveOriginWire: import("../../wiring").AnyWire;
+/**
+ * Requests and stores the browse response.
+ *
+ * @public
+ */
+export declare const fetchAndSaveBrowseResponseWire: import("../../wiring").Wire<InternalBrowseRequest | null>;
+/**
+ * Requests and stores the enrichment results for the results.
+ *
+ * @public
+ */
+export declare const fetchAndSaveResultsEnrichmentWire: import("../../wiring").Wire<import("@empathyco/x-types").Result[]>;
+/**
+ * Sets the browse state `selectedCategory`.
+ *
+ * @public
+ */
+export declare const setBrowseCategory: import("../../wiring").Wire<import("@empathyco/x-types").BrowsableRequest>;
+/**
+ * Clears the browse state `selectedCategory`.
+ *
+ * @public
+ */
+export declare const clearBrowseQuery: import("../../wiring").AnyWire;
+/**
+ * Sets the browse state `selectedFilters`.
+ *
+ * @public
+ */
+export declare const setSelectedFilters: import("../../wiring").Wire<import("@empathyco/x-types").Filter[]>;
+/**
+ * Sets the browse state `sort`.
+ *
+ * @public
+ */
+export declare const setSort: import("../../wiring").Wire<string>;
+/**
+ * Sets the browse state `query`.
+ *
+ * @public
+ */
+export declare const setUrlParams: import("../../wiring").Wire<import("../..").UrlParams>;
+/**
+ * Sets the browse state `page`.
+ *
+ * @public
+ */
+export declare const setBrowsePage: import("../../wiring").Wire<number>;
+/**
+ * Sets the browse state `params`.
+ *
+ * @public
+ */
+export declare const setBrowseExtraParams: import("../../wiring").Wire<import("@empathyco/x-utils").Dictionary<unknown>>;
+/**
+ * Resets the browse state to reload the current browse.
+ *
+ * @public
+ */
+export declare const resetStateForReloadWire: import("../../wiring").AnyWire;
+/**
+ * Resets the browse state `isNoResults`.
+ *
+ * @public
+ */
+export declare const resetIsNoResults: import("../../wiring").AnyWire;
+/**
+ * Resets the browse state `fromNoResultsWithFilters`.
+ *
+ * @public
+ */
+export declare const resetFromNoResultsWithFilters: import("../../wiring").AnyWire;
+/**
+ * Increases the current browse state `page` by one.
+ *
+ * @public
+ */
+export declare const increasePageAppendingResultsWire: import("../../wiring").AnyWire;
+/**
+ * Resets the browse state `isAppendingResults`.
+ *
+ * @public
+ */
+export declare const resetAppending: import("../../wiring").AnyWire;
+/**
+ * Resets the {@link BrowseGetters.request} parameters when refining request and before the actual
+ * request is launched.
+ *
+ * @public
+ */
+export declare const resetRequestOnRefinementWire: import("../../wiring").AnyWire;
+/**
+ * Resets the browse state when the request is changed to null. See the
+ * {@link BrowseXStoreModule} for details.
+ *
+ * @public
+ */
+export declare const resetStateIfNoRequestWire: import("../../wiring").Wire<InternalBrowseRequest | null>;
+/**
+ * Browse wiring.
+ *
+ * @internal
+ */
+export declare const browseWiring: {
+    ParamsLoadedFromUrl: {
+        setUrlParams: import("../../wiring").Wire<import("../..").UrlParams>;
+        saveOriginWire: import("../../wiring").AnyWire;
+    };
+    UserClickedABrowseSort: {
+        setSort: import("../../wiring").Wire<string>;
+    };
+    UserReachedResultsListEnd: {
+        increasePageAppendingResultsWire: import("../../wiring").AnyWire;
+    };
+    BrowseRequestUpdated: {
+        resetStateIfNoRequestWire: import("../../wiring").Wire<InternalBrowseRequest | null>;
+        fetchAndSaveBrowseResponseWire: import("../../wiring").Wire<InternalBrowseRequest | null>;
+    };
+    BrowseRequestChanged: {
+        resetRequestOnRefinementWire: import("../../wiring").AnyWire;
+    };
+    SelectedFiltersForRequestChanged: {
+        setSelectedFilters: import("../../wiring").Wire<import("@empathyco/x-types").Filter[]>;
+    };
+    ResultsChanged: {
+        resetAppending: import("../../wiring").AnyWire;
+        fetchAndSaveResultsEnrichmentWire: import("../../wiring").Wire<import("@empathyco/x-types").Result[]>;
+    };
+    ReloadBrowseRequested: {
+        resetStateForReloadWire: import("../../wiring").AnyWire;
+    };
+    SelectedSortProvided: {
+        setSort: import("../../wiring").Wire<string>;
+    };
+    ExtraParamsChanged: {
+        setBrowseExtraParams: import("../../wiring").Wire<import("@empathyco/x-utils").Dictionary<unknown>>;
+    };
+    UserClickedCloseX: {
+        clearBrowseQuery: import("../../wiring").AnyWire;
+        resetStateForReloadWire: import("../../wiring").AnyWire;
+        cancelFetchAndSaveBrowseResponseWire: import("../../wiring").AnyWire;
+    };
+    UserClickedOpenX: {
+        clearBrowseQuery: import("../../wiring").AnyWire;
+        resetStateForReloadWire: import("../../wiring").AnyWire;
+        cancelFetchAndSaveBrowseResponseWire: import("../../wiring").AnyWire;
+    };
+    UserClickedOutOfMainModal: {
+        clearBrowseQuery: import("../../wiring").AnyWire;
+    };
+    UserSelectedAPage: {
+        setBrowsePage: import("../../wiring").Wire<number>;
+        resetAppending: import("../../wiring").AnyWire;
+    };
+    UserBrowsedToCategory: {
+        setBrowseCategory: import("../../wiring").Wire<import("@empathyco/x-types").BrowsableRequest>;
+    };
+};
+//# sourceMappingURL=wiring.d.ts.map