@fluid-topics/ft-search-context 2.2.52 → 2.2.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,9 @@
1
1
  import { FtSearchPageState } from "./model";
2
2
  import { FtReduxStore, FtStateManager } from "@fluid-topics/ft-wc-utils";
3
3
  import { FtSearchPageStateReducers } from "./redux";
4
- import { FtDateFilterTypeKeys, FtMetadataFilter, FtPublicClusterSortCriterion, FtSearchKeywordMatch, FtSearchRequest, FtSearchScope, FtSearchSortCriterion, FtSuggestRequest, FtVirtualField } from "@fluid-topics/public-api";
4
+ import { FtDateFilterTypeKeys, FtMetadataFilter, FtPublicClusterSortCriterion, FtSearchKeywordMatch, FtSearchRequest, FtSearchResultClusterEntry, FtSearchScope, FtSearchSortCriterion, FtSuggestRequest, FtVirtualField } from "@fluid-topics/public-api";
5
5
  import { FtSearchService } from "./utils/FtSearchService";
6
+ import { ResultTargetBuilder, ResultUrlBuilder } from "../utils";
6
7
  export declare const searchInDocumentTitlesOnlySelector: (s: FtSearchPageState) => boolean;
7
8
  export declare const keywordMatchSelector: (s: FtSearchPageState) => boolean;
8
9
  export declare class FtSearchStateManager extends FtStateManager {
@@ -10,6 +11,8 @@ export declare class FtSearchStateManager extends FtStateManager {
10
11
  static build(id: string, service?: FtSearchService): FtSearchStateManager;
11
12
  readonly service: FtSearchService;
12
13
  errorHandler?: (e: Error) => void;
14
+ resultUrlBuilder?: ResultUrlBuilder;
15
+ resultTargetBuilder?: ResultTargetBuilder;
13
16
  ignoreEmptyQuery: boolean;
14
17
  canUpdateUiLocale: boolean;
15
18
  openExternalDocumentInNewTab: boolean;
@@ -51,7 +54,7 @@ export declare class FtSearchStateManager extends FtStateManager {
51
54
  addPropagatedFacet(facetId: string): void;
52
55
  /** @deprecated */
53
56
  setFilter(key: string, values: string[]): void;
54
- setValueFilter(key: string, values: string[]): void;
57
+ setValueFilter(key: string, values: string[], negative?: boolean): void;
55
58
  setDateFilter(key: string, dateType: FtDateFilterTypeKeys): void;
56
59
  removeDateFilter(key: string): void;
57
60
  setRangeFilter(key: string, from: string, to: string): void;
@@ -80,4 +83,6 @@ export declare class FtSearchStateManager extends FtStateManager {
80
83
  private fetchSuggestData;
81
84
  clear(): void;
82
85
  clearResults(): void;
86
+ getResultUrl(result: FtSearchResultClusterEntry, filters?: FtMetadataFilter[]): string | undefined;
87
+ getResultTarget(result: FtSearchResultClusterEntry, openExternalDocumentInNewTab: boolean | undefined): string | typeof import("lit").nothing;
83
88
  }
@@ -1,9 +1,9 @@
1
1
  import { FtSearchStateResourceRequest, } from "./model";
2
- import { cancelable, CanceledPromiseError, Debouncer, deepCopy, FtStateManager, minmax, ReduxWatcher, QueryHistoryStorage, } from "@fluid-topics/ft-wc-utils";
2
+ import { cancelable, CanceledPromiseError, Debouncer, deepCopy, FtStateManager, minmax, QueryHistoryStorage, ReduxWatcher, } from "@fluid-topics/ft-wc-utils";
3
3
  import { createSearchPageStore, } from "./redux";
4
4
  import { FtSearchKeywordMatch, FtSearchScope, FtUserRole, FtVirtualField, userHasRole, } from "@fluid-topics/public-api";
5
5
  import { FtSearchService } from "./utils/FtSearchService";
6
- import { ClearAllFiltersEvent } from "../utils";
6
+ import { ClearAllFiltersEvent, getResultTarget, getResultUrl, } from "../utils";
7
7
  import { AuthenticationChangeEvent, ftAppInfoStore, ftAppStateManager, } from "@fluid-topics/ft-app-context";
8
8
  export const searchInDocumentTitlesOnlySelector = (s) => s.request.virtualField === FtVirtualField.TITLE_ONLY
9
9
  && s.request.scope === FtSearchScope.DOCUMENTS;
@@ -265,13 +265,13 @@ export class FtSearchStateManager extends FtStateManager {
265
265
  setFilter(key, values) {
266
266
  this.setValueFilter(key, values);
267
267
  }
268
- setValueFilter(key, values) {
268
+ setValueFilter(key, values, negative) {
269
269
  const existingFilters = this.store.getState().request.metadataFilters;
270
270
  const newFilter = {
271
271
  key: key,
272
272
  valueFilter: {
273
273
  values: values,
274
- negative: false,
274
+ negative: negative !== null && negative !== void 0 ? negative : false,
275
275
  },
276
276
  };
277
277
  const filters = [
@@ -440,4 +440,14 @@ export class FtSearchStateManager extends FtStateManager {
440
440
  this.store.actions.facets(undefined);
441
441
  this.store.actions.spellcheck(undefined);
442
442
  }
443
+ getResultUrl(result, filters) {
444
+ var _a;
445
+ var _b;
446
+ return (_b = (_a = this.resultUrlBuilder) === null || _a === void 0 ? void 0 : _a.call(this, result, filters)) !== null && _b !== void 0 ? _b : getResultUrl(result, filters);
447
+ }
448
+ getResultTarget(result, openExternalDocumentInNewTab) {
449
+ var _a;
450
+ var _b;
451
+ return (_b = (_a = this.resultTargetBuilder) === null || _a === void 0 ? void 0 : _a.call(this, result, openExternalDocumentInNewTab)) !== null && _b !== void 0 ? _b : getResultTarget(result, openExternalDocumentInNewTab);
452
+ }
443
453
  }
package/build/utils.d.ts CHANGED
@@ -1,6 +1,7 @@
1
- import { FtSearchRequest, FtSearchResultClusterEntry, FtSearchResultsPageInfo, FtSpellcheck } from "@fluid-topics/public-api";
1
+ import { FtMetadataFilter, FtSearchRequest, FtSearchResultClusterEntry, FtSearchResultsPageInfo, FtSpellcheck } from "@fluid-topics/public-api";
2
2
  import { FtSearchResultsChangeEventDetail } from "./store/model";
3
3
  import { EnrichedFtSearchRequest } from "@fluid-topics/ft-wc-utils";
4
+ import { nothing } from "lit";
4
5
  export declare class SearchResultClickEvent extends CustomEvent<{
5
6
  result: FtSearchResultClusterEntry;
6
7
  rank: number;
@@ -26,3 +27,8 @@ export declare class ClearAllFiltersEvent extends Event {
26
27
  static eventName: string;
27
28
  constructor();
28
29
  }
30
+ export declare function isOpenModeExternal(result: FtSearchResultClusterEntry): boolean;
31
+ export declare function getResultUrl(result: FtSearchResultClusterEntry, filters?: FtMetadataFilter[]): string | undefined;
32
+ export declare function getResultTarget(result: FtSearchResultClusterEntry, openExternalDocumentInNewTab: boolean | undefined): string | typeof nothing;
33
+ export type ResultUrlBuilder = typeof getResultUrl;
34
+ export type ResultTargetBuilder = typeof getResultTarget;
package/build/utils.js CHANGED
@@ -1,3 +1,6 @@
1
+ import { FtOpenMode, } from "@fluid-topics/public-api";
2
+ import { accessResult, accessResultUrl, } from "@fluid-topics/ft-wc-utils";
3
+ import { ifDefined } from "lit/directives/if-defined.js";
1
4
  export class SearchResultClickEvent extends CustomEvent {
2
5
  constructor(result, rank) {
3
6
  super("ft-search-result-click", { detail: { result, rank }, bubbles: true, composed: true });
@@ -29,3 +32,17 @@ export class ClearAllFiltersEvent extends Event {
29
32
  }
30
33
  }
31
34
  ClearAllFiltersEvent.eventName = "search-context-clear-all-filters";
35
+ export function isOpenModeExternal(result) {
36
+ var _a;
37
+ const openMode = (_a = accessResult(result)) === null || _a === void 0 ? void 0 : _a.openMode;
38
+ return openMode === FtOpenMode.EXTERNAL;
39
+ }
40
+ export function getResultUrl(result, filters) {
41
+ if (isOpenModeExternal(result)) {
42
+ return accessResult(result).originUrl;
43
+ }
44
+ return accessResultUrl(result, filters);
45
+ }
46
+ export function getResultTarget(result, openExternalDocumentInNewTab) {
47
+ return ifDefined(openExternalDocumentInNewTab && isOpenModeExternal(result) ? "_blank" : undefined);
48
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fluid-topics/ft-search-context",
3
- "version": "2.2.52",
3
+ "version": "2.2.53",
4
4
  "description": "Context block for integrated search components",
5
5
  "keywords": [
6
6
  "Lit"
@@ -19,13 +19,13 @@
19
19
  "url": "ssh://git@scm.mrs.antidot.net:2222/fluidtopics/ft-web-components.git"
20
20
  },
21
21
  "dependencies": {
22
- "@fluid-topics/ft-app-context": "2.2.52",
23
- "@fluid-topics/ft-wc-utils": "2.2.52",
22
+ "@fluid-topics/ft-app-context": "2.2.53",
23
+ "@fluid-topics/ft-wc-utils": "2.2.53",
24
24
  "@reduxjs/toolkit": "2.14.0",
25
25
  "lit": "3.3.3"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@fluid-topics/public-api": "1.0.152"
29
29
  },
30
- "gitHead": "2ea51fda4d842d1ca7f264eae31c1eea3d64b5f6"
30
+ "gitHead": "be48d03182a89687bfa9fab685f19f76d68dfbb7"
31
31
  }