@searchstax-inc/searchstudio-ux-js 0.0.7 → 0.0.9

package/README.md

@@ -29,14 +29,23 @@ After importing Searchstax class a new instance needs to be created:
 
 ## Initialization
 Initialization object
+
 {
+
   `language: string;` - language code. Example: 'en'
+
   `searchURL: string;` - SeachStudio select endpoint
+
   `suggesterURL: string;` - SeachStudio suggest endpoint
+
   `trackApiKey: string;` - Api key used for tracking events
+
   `searchAuth: string;` - Authentication value. based on authType it's either a token value or basic auth value
+
   `authType: 'token' | 'basic';` - Type of authentication
+
 }
+
 Initialization example
 ```
 searchstax.initialize({
@@ -52,20 +61,35 @@ searchstax.initialize({
 
 ## Input widget
 Initialization properties
+
 a. id of container where widget will be rendered
+
 b. {
+
   `suggestAfterMinChars: number;` - controls how many characters the UI should accept at the minimum before showing suggestions
+
   `templates?: {` - optional object that defines template override options
+
     `mainTemplate?: string;` - main template in Mustache templating language
+
     `searchInputId?: string;` - id of search input within the mainTemplate
+
     `autosuggestItemTemplate?: string;` - autosuggest item template in Mustache
+
   `};`
+
   `hooks?: {` - optional object that provides various hook options
+
     `beforeSearch?: (props: ISearchstaxSearchProps) => ISearchstaxSearchProps | null;` - this function gets called before firing search. searchProps are being passed as a property and can be modified, if passed along further search will execute with modified properties, if null is returned then event gets canceled and search never fires.
+
     `afterSearch?: (results: ISearchstaxParsedResult[]) => ISearchstaxParsedResult[];` - this function gets called after firing search and before rendering. It needs to return array of results that are either modified or untouched.
+
     `beforeAutosuggest?: (props: ISearchstaxSuggestProps) => ISearchstaxSuggestProps | null;` - this function gets called before firing autosuggest. autosuggestProps are being passed as a property and can be modified, if passed along further search will execute with modified properties, if null is returned then event gets canceled and search never fires.
+
     `afterAutosuggest?: (result: ISearchstaxSuggestResponse) => ISearchstaxSuggestResponse;`- this function gets called after autosuggest has values but before rendering. It needs to return same type of data but it can be modified.
+
   `};`
+
 }
 
 
@@ -110,17 +134,29 @@ example of input widget initialization with various options
 ```
 ## Result widget
 Initialization properties
+
 a. id of container where widget will be rendered
+
 b. {
+
   `searchResultsContainerId?: string;` - this is needed only if mainTemplate is overridden. It points to an element in the template where results need to be rendered
+
   `searchResultUniqueIdAttribute?: string;` - this is needed only if searchResultTemplate is overridden. searchResultTemplate needs to have unique result id property. Default is data-searchstax-unique-result-id="{{uniqueId}}". see example below on how it is used
+
   `templates?: {` - optional object that defines template override options
+
     `mainTemplate?: string;` - main template in Mustache templating language.
+
     `searchResultTemplate?: string;` - result template using Mustache. ISearchstaxParsedResult is passed to the template and all its properties are available to be used when rendering
+
     `noSearchResultTemplate?: string;` - Mustache template for no results section override. spellingSuggestion and searchTerm are values available in the template
+
   `};`
+
   `hooks?: {` - optional object that provides various hook options
+
     `afterLinkClick?: (resultClicked: ISearchstaxParsedResult) => ISearchstaxParsedResult | null;` - function is called after user clicks result and passes that result as a property. when result is passed along tracking will execute and user will be navigated if null is returned events are canceled and nothing happens.
+
   `};`
 }
 

package/dist/@searchstax-inc/searchstudio-ux-js.d.mts

@@ -0,0 +1,158 @@
+// Generated by dts-bundle-generator v7.1.0
+
+export interface ISearchstaxParsedResult {
+	custom?: any;
+	ribbon: string | null;
+	paths: string | null;
+	url: string | null;
+	title: string | null;
+	promoted: boolean | null;
+	thumbnail: string | null;
+	date: string | null;
+	snippet: string | null;
+	description: string | null;
+	uniqueId: string;
+	position: number;
+	unmappedFields: {
+		key: string;
+		value: string | string[] | boolean;
+		isImage?: boolean;
+	}[];
+	allFields: {
+		key: string;
+		value: string | string[] | boolean;
+	}[];
+}
+export interface ISearchstaxSearchMetadata {
+	recordsPerPageValue: number;
+	startDocVal: number;
+	totalResultsValue: number;
+	latency: number;
+	endDocValue: number;
+	spellingSuggestion: string;
+}
+export interface ISearchstaxSuggestResponseHeader {
+	zkConnected: boolean;
+	status: number;
+	qTime: number;
+}
+export interface ISearchstaxSuggestion {
+	term: string;
+	weight: number;
+	payload: string;
+}
+export interface ISearchstaxSEARCHTERM {
+	numFound: number;
+	suggestions: ISearchstaxSuggestion[];
+}
+export interface ISearchstaxStudio_suggestor_LANG {
+	[key: string]: ISearchstaxSEARCHTERM;
+}
+export interface ISearchstaxSuggest {
+	[key: string]: ISearchstaxStudio_suggestor_LANG;
+}
+export interface ISearchstaxSuggestResponse {
+	responseHeader: ISearchstaxSuggestResponseHeader;
+	suggest: ISearchstaxSuggest;
+}
+declare class Observable {
+	value: any;
+	observers: Function[];
+	constructor(value: any);
+	subscribe(observer: (data: any) => void): void;
+	unsubscribe(observer: (data: any) => void): void;
+	setValue(value: any): void;
+	getValue(): any;
+	notify(): void;
+}
+declare class DataLAyer {
+	searchTermChangeObservable: Observable;
+	loadingChangeObservable: Observable;
+	searchResultsObservable: Observable;
+	searchResultsMetadataObservable: Observable;
+	searchAutosuggestObservable: Observable;
+	private currentPage;
+	private renderingEngine;
+	setSearchTerm(value: string): void;
+	setRenderingEngine(value: "mustache" | "vue" | "react"): void;
+	setCurrentPage(value: number): void;
+	setLoading(value: boolean): void;
+	setSearchResults(value: ISearchstaxParsedResult[]): void;
+	setSearchResultsMetadata(value: ISearchstaxSearchMetadata): void;
+	setSearchAutosuggest(value: ISearchstaxSuggestResponse): void;
+	get searchResultsValue(): ISearchstaxParsedResult[] | null;
+	get searchTermValue(): string;
+	get loadingValue(): boolean;
+	get searchAutosuggestValue(): ISearchstaxSuggestResponse | null;
+	get searchResultsMetadataValue(): ISearchstaxSearchMetadata | null;
+	get currentPageValue(): number;
+	get renderingEngineValue(): "mustache" | "vue" | "react";
+}
+export interface ISearchstaxConfig {
+	language: string;
+	searchURL: string;
+	suggesterURL: string;
+	trackApiKey: string;
+	searchAuth: string;
+	authType: "token" | "basic";
+}
+export interface ISearchstaxSearchProps {
+	term: string;
+	queryParams: string[];
+}
+export interface ISearchstaxSuggestProps {
+	term: string;
+	queryParams: string[];
+}
+export interface ISearchstaxSearchInputConfig {
+	suggestAfterMinChars: number;
+	templates?: {
+		mainTemplate?: string;
+		searchInputId?: string;
+		autosuggestItemTemplate?: string;
+	};
+	hooks?: {
+		beforeSearch?: (props: ISearchstaxSearchProps) => ISearchstaxSearchProps | null;
+		afterSearch?: (results: ISearchstaxParsedResult[]) => ISearchstaxParsedResult[];
+		beforeAutosuggest?: (props: ISearchstaxSuggestProps) => ISearchstaxSuggestProps | null;
+		afterAutosuggest?: (result: ISearchstaxSuggestResponse) => ISearchstaxSuggestResponse;
+	};
+}
+export interface ISearchstaxSearcResultsConfig {
+	searchResultsContainerId?: string;
+	searchResultUniqueIdAttribute?: string;
+	templates?: {
+		mainTemplate?: string;
+		searchResultTemplate?: string;
+		noSearchResultTemplate?: string;
+	};
+	hooks?: {
+		afterLinkClick?: (resultClicked: ISearchstaxParsedResult) => ISearchstaxParsedResult | null;
+	};
+}
+export declare class Searchstax {
+	private sessionId;
+	private searchstaxConfig?;
+	private searchHelper?;
+	private searchInputConfig?;
+	private searchResultsConfig?;
+	private searchInputWidget?;
+	private searchResultsWidget?;
+	dataLayer: DataLAyer;
+	constructor(renderEngine?: "mustache" | "vue" | "react");
+	setRenderingEngine(engine?: "mustache" | "vue" | "react"): void;
+	private handleHooks;
+	initialize(config: ISearchstaxConfig): void;
+	search(term: string, queryParams: string[]): void;
+	private parseSearchResultsResponse;
+	private parseSuggestSuggestResponse;
+	suggest(term: string, queryParams: string[]): void;
+	changeLanguage(language: string): void;
+	addSearchInputWidget(containerId: string, config: ISearchstaxSearchInputConfig): void;
+	addSearchResultsWidget(containerId: string, config: ISearchstaxSearcResultsConfig): void;
+	private executeSearch;
+	private executeSuggest;
+	executeLinkClick(uniqueId: string): void;
+}
+
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchstax-inc/searchstudio-ux-js",
   "private": false,
-  "version": "0.0.7",
+  "version": "0.0.9",
   "files": [
     "dist"
   ],
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "dev": "vite --host",
-    "build": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts && npm run sass && npm run makeDirectories && npm run compile:sass",
+    "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",
     "test": "vitest",
     "sass": "node-sass ./src/style.scss ./dist/styles/mainTheme.css",
     "test:coverage": "vitest --coverage",
@@ -43,6 +43,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
     "lint-staged": "^13.1.0",
+    "node-sass": "^8.0.0",
     "postcss": "^8.4.21",
     "postcss-scss": "^4.0.6",
     "prettier": "^2.8.3",

package/CHANGELOG.md

@@ -1,15 +0,0 @@
-# Change Log
-
-All notable changes to the "vite-vanilla-ts-lib-starter" project will be documented in this file.
-
-## [0.0.1] - 2023-01-18
-
-- Update all packages to the latest versions (update to vite 4.x)
-
-## [0.0.1] - 2022-09-08
-
-- Update all packages to the latest versions (update to vite 3.x)
-
-## [0.0.0] - 2022-03-28
-
-- Initial release