@getlupa/vue 0.8.5 → 0.9.0

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.
@@ -18,14 +18,14 @@ export declare const useSearchBoxStore: import("pinia").StoreDefinition<"searchB
18
18
  } | {
19
19
  queryKey: string;
20
20
  count: number;
21
- panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel;
21
+ panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').RelatedSourcePanel;
22
22
  input: string;
23
23
  })[]>;
24
24
  totalCount: import("vue").ComputedRef<number>;
25
25
  highlightedItem: import("vue").ComputedRef<{
26
26
  queryKey: string;
27
27
  index: number;
28
- panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').SuggestionSearchBoxPanel;
28
+ panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').SuggestionSearchBoxPanel | import('../types/search-box/SearchBoxPanel').RelatedSourcePanel;
29
29
  }>;
30
30
  highlightedDocument: import("vue").ComputedRef<{
31
31
  doc: any;
@@ -88,14 +88,14 @@ export declare const useSearchBoxStore: import("pinia").StoreDefinition<"searchB
88
88
  } | {
89
89
  queryKey: string;
90
90
  count: number;
91
- panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel;
91
+ panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').RelatedSourcePanel;
92
92
  input: string;
93
93
  })[]>;
94
94
  totalCount: import("vue").ComputedRef<number>;
95
95
  highlightedItem: import("vue").ComputedRef<{
96
96
  queryKey: string;
97
97
  index: number;
98
- panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').SuggestionSearchBoxPanel;
98
+ panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').SuggestionSearchBoxPanel | import('../types/search-box/SearchBoxPanel').RelatedSourcePanel;
99
99
  }>;
100
100
  highlightedDocument: import("vue").ComputedRef<{
101
101
  doc: any;
@@ -158,14 +158,14 @@ export declare const useSearchBoxStore: import("pinia").StoreDefinition<"searchB
158
158
  } | {
159
159
  queryKey: string;
160
160
  count: number;
161
- panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel;
161
+ panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').RelatedSourcePanel;
162
162
  input: string;
163
163
  })[]>;
164
164
  totalCount: import("vue").ComputedRef<number>;
165
165
  highlightedItem: import("vue").ComputedRef<{
166
166
  queryKey: string;
167
167
  index: number;
168
- panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').SuggestionSearchBoxPanel;
168
+ panel: import('../types/search-box/SearchBoxPanel').DocumentSearchBoxPanel | import('../types/search-box/SearchBoxPanel').SuggestionSearchBoxPanel | import('../types/search-box/SearchBoxPanel').RelatedSourcePanel;
169
169
  }>;
170
170
  highlightedDocument: import("vue").ComputedRef<{
171
171
  doc: any;
@@ -1,4 +1,4 @@
1
- import type { Document, Suggestion, ReportableEventType } from '@getlupa/client-sdk/Types';
1
+ import type { Document, Suggestion, ReportableEventType, FilterGroup } from '@getlupa/client-sdk/Types';
2
2
  import type { AnalyticsEventType } from '../AnalyticsOptions';
3
3
  import type { SearchBoxPanelType } from './SearchBoxPanel';
4
4
  export type FetchedData = {
@@ -42,6 +42,7 @@ export type TrackableEventData = {
42
42
  options?: {
43
43
  allowEmptySearchQuery: boolean;
44
44
  };
45
+ filters?: FilterGroup;
45
46
  };
46
47
  export type HighlightedDocInfo = {
47
48
  doc?: Document;
@@ -3,12 +3,14 @@ import type { Document } from '@getlupa/client-sdk/Types';
3
3
  import { CustomDocumentHtmlAttributes } from '../General';
4
4
  export declare enum SearchBoxPanelType {
5
5
  SUGGESTION = "suggestion",
6
- DOCUMENT = "document"
6
+ DOCUMENT = "document",
7
+ RELATED_SOURCE = "related-source"
7
8
  }
8
9
  export type SearchBoxPanelLinks = {
9
10
  details: string;
10
11
  };
11
12
  export type SearchBoxPanelLabels = {
13
+ title?: string;
12
14
  topResultsTitle?: string;
13
15
  };
14
16
  export type SearchBoxPanelBase = {
@@ -16,6 +18,9 @@ export type SearchBoxPanelBase = {
16
18
  queryKey: string;
17
19
  limit: number;
18
20
  labels?: SearchBoxPanelLabels;
21
+ visibility?: {
22
+ showWhenKeyHasNoResults?: string;
23
+ };
19
24
  };
20
25
  export type DocumentSearchBoxPanel = SearchBoxPanelBase & {
21
26
  type: SearchBoxPanelType.DOCUMENT;
@@ -28,9 +33,19 @@ export type DocumentSearchBoxPanel = SearchBoxPanelBase & {
28
33
  isInStock?: (doc: Document) => boolean;
29
34
  customDocumentHtmlAttributes?: CustomDocumentHtmlAttributes;
30
35
  };
36
+ export type RelatedSourcePanel = Omit<DocumentSearchBoxPanel, 'type'> & {
37
+ type: SearchBoxPanelType.RELATED_SOURCE;
38
+ sourceIds: {
39
+ queryKey: string;
40
+ field: string;
41
+ };
42
+ target: {
43
+ queryKey: string;
44
+ };
45
+ };
31
46
  export type SuggestionSearchBoxPanel = SearchBoxPanelBase & {
32
47
  type: SearchBoxPanelType.SUGGESTION;
33
48
  highlight: boolean;
34
49
  customClassName?: string;
35
50
  };
36
- export type SearchBoxPanel = DocumentSearchBoxPanel | SuggestionSearchBoxPanel;
51
+ export type SearchBoxPanel = DocumentSearchBoxPanel | SuggestionSearchBoxPanel | RelatedSourcePanel;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getlupa/vue",
3
- "version": "0.8.5",
3
+ "version": "0.9.0",
4
4
  "main": "dist/lupaSearch.mjs",
5
5
  "module": "dist/lupaSearch.mjs",
6
6
  "types": "dist/src/index.d.ts",
@@ -23,7 +23,7 @@
23
23
  "vue": "^3.0.0"
24
24
  },
25
25
  "devDependencies": {
26
- "@getlupa/client-sdk": "^1.4.1",
26
+ "@getlupa/client-sdk": "^1.4.2",
27
27
  "@pinia/testing": "^0.1.2",
28
28
  "@rollup/plugin-babel": "5.3.0",
29
29
  "@rollup/plugin-commonjs": "^21.0.1",