@searchstax-inc/searchstudio-ux-js 0.0.8 → 0.0.9
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.
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
// Generated by dts-bundle-generator v7.1.0
|
|
2
|
+
|
|
3
|
+
export interface ISearchstaxParsedResult {
|
|
4
|
+
custom?: any;
|
|
5
|
+
ribbon: string | null;
|
|
6
|
+
paths: string | null;
|
|
7
|
+
url: string | null;
|
|
8
|
+
title: string | null;
|
|
9
|
+
promoted: boolean | null;
|
|
10
|
+
thumbnail: string | null;
|
|
11
|
+
date: string | null;
|
|
12
|
+
snippet: string | null;
|
|
13
|
+
description: string | null;
|
|
14
|
+
uniqueId: string;
|
|
15
|
+
position: number;
|
|
16
|
+
unmappedFields: {
|
|
17
|
+
key: string;
|
|
18
|
+
value: string | string[] | boolean;
|
|
19
|
+
isImage?: boolean;
|
|
20
|
+
}[];
|
|
21
|
+
allFields: {
|
|
22
|
+
key: string;
|
|
23
|
+
value: string | string[] | boolean;
|
|
24
|
+
}[];
|
|
25
|
+
}
|
|
26
|
+
export interface ISearchstaxSearchMetadata {
|
|
27
|
+
recordsPerPageValue: number;
|
|
28
|
+
startDocVal: number;
|
|
29
|
+
totalResultsValue: number;
|
|
30
|
+
latency: number;
|
|
31
|
+
endDocValue: number;
|
|
32
|
+
spellingSuggestion: string;
|
|
33
|
+
}
|
|
34
|
+
export interface ISearchstaxSuggestResponseHeader {
|
|
35
|
+
zkConnected: boolean;
|
|
36
|
+
status: number;
|
|
37
|
+
qTime: number;
|
|
38
|
+
}
|
|
39
|
+
export interface ISearchstaxSuggestion {
|
|
40
|
+
term: string;
|
|
41
|
+
weight: number;
|
|
42
|
+
payload: string;
|
|
43
|
+
}
|
|
44
|
+
export interface ISearchstaxSEARCHTERM {
|
|
45
|
+
numFound: number;
|
|
46
|
+
suggestions: ISearchstaxSuggestion[];
|
|
47
|
+
}
|
|
48
|
+
export interface ISearchstaxStudio_suggestor_LANG {
|
|
49
|
+
[key: string]: ISearchstaxSEARCHTERM;
|
|
50
|
+
}
|
|
51
|
+
export interface ISearchstaxSuggest {
|
|
52
|
+
[key: string]: ISearchstaxStudio_suggestor_LANG;
|
|
53
|
+
}
|
|
54
|
+
export interface ISearchstaxSuggestResponse {
|
|
55
|
+
responseHeader: ISearchstaxSuggestResponseHeader;
|
|
56
|
+
suggest: ISearchstaxSuggest;
|
|
57
|
+
}
|
|
58
|
+
declare class Observable {
|
|
59
|
+
value: any;
|
|
60
|
+
observers: Function[];
|
|
61
|
+
constructor(value: any);
|
|
62
|
+
subscribe(observer: (data: any) => void): void;
|
|
63
|
+
unsubscribe(observer: (data: any) => void): void;
|
|
64
|
+
setValue(value: any): void;
|
|
65
|
+
getValue(): any;
|
|
66
|
+
notify(): void;
|
|
67
|
+
}
|
|
68
|
+
declare class DataLAyer {
|
|
69
|
+
searchTermChangeObservable: Observable;
|
|
70
|
+
loadingChangeObservable: Observable;
|
|
71
|
+
searchResultsObservable: Observable;
|
|
72
|
+
searchResultsMetadataObservable: Observable;
|
|
73
|
+
searchAutosuggestObservable: Observable;
|
|
74
|
+
private currentPage;
|
|
75
|
+
private renderingEngine;
|
|
76
|
+
setSearchTerm(value: string): void;
|
|
77
|
+
setRenderingEngine(value: "mustache" | "vue" | "react"): void;
|
|
78
|
+
setCurrentPage(value: number): void;
|
|
79
|
+
setLoading(value: boolean): void;
|
|
80
|
+
setSearchResults(value: ISearchstaxParsedResult[]): void;
|
|
81
|
+
setSearchResultsMetadata(value: ISearchstaxSearchMetadata): void;
|
|
82
|
+
setSearchAutosuggest(value: ISearchstaxSuggestResponse): void;
|
|
83
|
+
get searchResultsValue(): ISearchstaxParsedResult[] | null;
|
|
84
|
+
get searchTermValue(): string;
|
|
85
|
+
get loadingValue(): boolean;
|
|
86
|
+
get searchAutosuggestValue(): ISearchstaxSuggestResponse | null;
|
|
87
|
+
get searchResultsMetadataValue(): ISearchstaxSearchMetadata | null;
|
|
88
|
+
get currentPageValue(): number;
|
|
89
|
+
get renderingEngineValue(): "mustache" | "vue" | "react";
|
|
90
|
+
}
|
|
91
|
+
export interface ISearchstaxConfig {
|
|
92
|
+
language: string;
|
|
93
|
+
searchURL: string;
|
|
94
|
+
suggesterURL: string;
|
|
95
|
+
trackApiKey: string;
|
|
96
|
+
searchAuth: string;
|
|
97
|
+
authType: "token" | "basic";
|
|
98
|
+
}
|
|
99
|
+
export interface ISearchstaxSearchProps {
|
|
100
|
+
term: string;
|
|
101
|
+
queryParams: string[];
|
|
102
|
+
}
|
|
103
|
+
export interface ISearchstaxSuggestProps {
|
|
104
|
+
term: string;
|
|
105
|
+
queryParams: string[];
|
|
106
|
+
}
|
|
107
|
+
export interface ISearchstaxSearchInputConfig {
|
|
108
|
+
suggestAfterMinChars: number;
|
|
109
|
+
templates?: {
|
|
110
|
+
mainTemplate?: string;
|
|
111
|
+
searchInputId?: string;
|
|
112
|
+
autosuggestItemTemplate?: string;
|
|
113
|
+
};
|
|
114
|
+
hooks?: {
|
|
115
|
+
beforeSearch?: (props: ISearchstaxSearchProps) => ISearchstaxSearchProps | null;
|
|
116
|
+
afterSearch?: (results: ISearchstaxParsedResult[]) => ISearchstaxParsedResult[];
|
|
117
|
+
beforeAutosuggest?: (props: ISearchstaxSuggestProps) => ISearchstaxSuggestProps | null;
|
|
118
|
+
afterAutosuggest?: (result: ISearchstaxSuggestResponse) => ISearchstaxSuggestResponse;
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
export interface ISearchstaxSearcResultsConfig {
|
|
122
|
+
searchResultsContainerId?: string;
|
|
123
|
+
searchResultUniqueIdAttribute?: string;
|
|
124
|
+
templates?: {
|
|
125
|
+
mainTemplate?: string;
|
|
126
|
+
searchResultTemplate?: string;
|
|
127
|
+
noSearchResultTemplate?: string;
|
|
128
|
+
};
|
|
129
|
+
hooks?: {
|
|
130
|
+
afterLinkClick?: (resultClicked: ISearchstaxParsedResult) => ISearchstaxParsedResult | null;
|
|
131
|
+
};
|
|
132
|
+
}
|
|
133
|
+
export declare class Searchstax {
|
|
134
|
+
private sessionId;
|
|
135
|
+
private searchstaxConfig?;
|
|
136
|
+
private searchHelper?;
|
|
137
|
+
private searchInputConfig?;
|
|
138
|
+
private searchResultsConfig?;
|
|
139
|
+
private searchInputWidget?;
|
|
140
|
+
private searchResultsWidget?;
|
|
141
|
+
dataLayer: DataLAyer;
|
|
142
|
+
constructor(renderEngine?: "mustache" | "vue" | "react");
|
|
143
|
+
setRenderingEngine(engine?: "mustache" | "vue" | "react"): void;
|
|
144
|
+
private handleHooks;
|
|
145
|
+
initialize(config: ISearchstaxConfig): void;
|
|
146
|
+
search(term: string, queryParams: string[]): void;
|
|
147
|
+
private parseSearchResultsResponse;
|
|
148
|
+
private parseSuggestSuggestResponse;
|
|
149
|
+
suggest(term: string, queryParams: string[]): void;
|
|
150
|
+
changeLanguage(language: string): void;
|
|
151
|
+
addSearchInputWidget(containerId: string, config: ISearchstaxSearchInputConfig): void;
|
|
152
|
+
addSearchResultsWidget(containerId: string, config: ISearchstaxSearcResultsConfig): void;
|
|
153
|
+
private executeSearch;
|
|
154
|
+
private executeSuggest;
|
|
155
|
+
executeLinkClick(uniqueId: string): void;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@searchstax-inc/searchstudio-ux-js",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.9",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist"
|
|
7
7
|
],
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
},
|
|
17
17
|
"scripts": {
|
|
18
18
|
"dev": "vite --host",
|
|
19
|
-
"build": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts && npm run sass && npm run makeDirectories && npm run compile:sass",
|
|
19
|
+
"build": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts && npm run sass && npm run makeDirectories && npm run compile:sass && cp ./dist/@searchstax-inc/searchstudio-ux-js.d.ts ./dist/@searchstax-inc/searchstudio-ux-js.d.mts",
|
|
20
20
|
"test": "vitest",
|
|
21
21
|
"sass": "node-sass ./src/style.scss ./dist/styles/mainTheme.css",
|
|
22
22
|
"test:coverage": "vitest --coverage",
|
|
@@ -43,6 +43,7 @@
|
|
|
43
43
|
"eslint-plugin-prettier": "^4.2.1",
|
|
44
44
|
"husky": "^8.0.3",
|
|
45
45
|
"lint-staged": "^13.1.0",
|
|
46
|
+
"node-sass": "^8.0.0",
|
|
46
47
|
"postcss": "^8.4.21",
|
|
47
48
|
"postcss-scss": "^4.0.6",
|
|
48
49
|
"prettier": "^2.8.3",
|
package/CHANGELOG.md
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Change Log
|
|
2
|
-
|
|
3
|
-
All notable changes to the "vite-vanilla-ts-lib-starter" project will be documented in this file.
|
|
4
|
-
|
|
5
|
-
## [0.0.1] - 2023-01-18
|
|
6
|
-
|
|
7
|
-
- Update all packages to the latest versions (update to vite 4.x)
|
|
8
|
-
|
|
9
|
-
## [0.0.1] - 2022-09-08
|
|
10
|
-
|
|
11
|
-
- Update all packages to the latest versions (update to vite 3.x)
|
|
12
|
-
|
|
13
|
-
## [0.0.0] - 2022-03-28
|
|
14
|
-
|
|
15
|
-
- Initial release
|