@searchcraft/javascript-sdk 0.1.1 → 0.1.3

package/dist/types/components.d.ts

@@ -26,19 +26,28 @@ export namespace Components {
         "rightToLeftOrientation": boolean;
     }
     interface SearchcraftBaseSearchResult {
-        "buttonCallbackFn": () => void;
-        "buttonLabel": string;
-        "callbackFn": () => void;
-        "imageAltText": string;
-        "imageSrc": string;
-        "interactiveResult": boolean;
-        "keyDownCallbackFn": () => void;
-        "resultBodyContent": string;
-        "resultHeading": string;
-        "resultSubheading": string;
-        "theme": 'light' | 'dark';
+        "buttonText": string;
+        "customStyles": string;
+        "headingText": string;
+        "imageDescription": string;
+        "imageSource": string;
+        "isInteractive": boolean;
+        "primaryContent": string;
+        "secondaryContent": string;
+        "subheadingText": string;
+        "tertiaryContent": string;
+        "themeMode": 'light' | 'dark';
     }
     interface SearchcraftBaseSearchResults {
+        /**
+          * Custom styles to apply to search results. Expected format: JSON string, e.g., '{"borderRadius": "10px", "padding": "16px"}'
+         */
+        "customStylesForResults": | string
+    | Record<string, Record<string, string>>;
+        /**
+          * Array of keys to dynamically extract properties from each document. Must be explicitly set by the parent component.
+         */
+        "searchKeys": string;
     }
     interface SearchcraftButton {
         "iconElement"?: Element;
@@ -112,6 +121,10 @@ export interface SearchcraftBaseSearchFormCustomEvent<T> extends CustomEvent<T>
     detail: T;
     target: HTMLSearchcraftBaseSearchFormElement;
 }
+export interface SearchcraftBaseSearchResultCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSearchcraftBaseSearchResultElement;
+}
 export interface SearchcraftButtonCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLSearchcraftButtonElement;
@@ -159,7 +172,20 @@ declare global {
         prototype: HTMLSearchcraftBaseSearchFormElement;
         new (): HTMLSearchcraftBaseSearchFormElement;
     };
+    interface HTMLSearchcraftBaseSearchResultElementEventMap {
+        "buttonCallback": any;
+        "keyDownCallback": any;
+        "resultCallback": any;
+    }
     interface HTMLSearchcraftBaseSearchResultElement extends Components.SearchcraftBaseSearchResult, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLSearchcraftBaseSearchResultElementEventMap>(type: K, listener: (this: HTMLSearchcraftBaseSearchResultElement, ev: SearchcraftBaseSearchResultCustomEvent<HTMLSearchcraftBaseSearchResultElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLSearchcraftBaseSearchResultElementEventMap>(type: K, listener: (this: HTMLSearchcraftBaseSearchResultElement, ev: SearchcraftBaseSearchResultCustomEvent<HTMLSearchcraftBaseSearchResultElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     }
     var HTMLSearchcraftBaseSearchResultElement: {
         prototype: HTMLSearchcraftBaseSearchResultElement;
@@ -317,19 +343,31 @@ declare namespace LocalJSX {
         "rightToLeftOrientation"?: boolean;
     }
     interface SearchcraftBaseSearchResult {
-        "buttonCallbackFn"?: () => void;
-        "buttonLabel"?: string;
-        "callbackFn"?: () => void;
-        "imageAltText"?: string;
-        "imageSrc"?: string;
-        "interactiveResult"?: boolean;
-        "keyDownCallbackFn"?: () => void;
-        "resultBodyContent"?: string;
-        "resultHeading"?: string;
-        "resultSubheading"?: string;
-        "theme"?: 'light' | 'dark';
+        "buttonText"?: string;
+        "customStyles"?: string;
+        "headingText"?: string;
+        "imageDescription"?: string;
+        "imageSource"?: string;
+        "isInteractive"?: boolean;
+        "onButtonCallback"?: (event: SearchcraftBaseSearchResultCustomEvent<any>) => void;
+        "onKeyDownCallback"?: (event: SearchcraftBaseSearchResultCustomEvent<any>) => void;
+        "onResultCallback"?: (event: SearchcraftBaseSearchResultCustomEvent<any>) => void;
+        "primaryContent"?: string;
+        "secondaryContent"?: string;
+        "subheadingText"?: string;
+        "tertiaryContent"?: string;
+        "themeMode"?: 'light' | 'dark';
     }
     interface SearchcraftBaseSearchResults {
+        /**
+          * Custom styles to apply to search results. Expected format: JSON string, e.g., '{"borderRadius": "10px", "padding": "16px"}'
+         */
+        "customStylesForResults"?: | string
+    | Record<string, Record<string, string>>;
+        /**
+          * Array of keys to dynamically extract properties from each document. Must be explicitly set by the parent component.
+         */
+        "searchKeys"?: string;
     }
     interface SearchcraftButton {
         "iconElement"?: Element;

package/dist/types/index.d.ts

@@ -8,5 +8,5 @@
  * to consume components of this package as outlined in the `README.md`.
  */
 export type * from './components';
-export { parseCustomStyles } from './utils/utils';
+export { extractDynamicProperties, parseCustomStyles, parseSearchKeys, } from './utils/utils';
 export { useSearchcraftStore, useThemeStore } from './provider/store';

package/dist/types/provider/store.d.ts

@@ -1,10 +1,10 @@
-import { type SearchError, type SearchResult, type CoreSDK as SearchcraftCore } from '@searchcraft/core';
+import { type CoreSDK as SearchcraftCore, type SearchcraftResponse } from '@searchcraft/core';
 interface SearchcraftState {
     query: string;
     isRequesting: boolean;
-    searchResults: SearchResult | SearchError | null;
+    searchResults: SearchcraftResponse | null;
     setQuery: (query: string) => void;
-    setSearchResults: (results: SearchResult | SearchError | null) => void;
+    setSearchResults: (results: SearchcraftResponse | null) => void;
     setIsRequesting: (isRequesting: boolean) => void;
     search: () => Promise<void>;
     initialize: (searchcraft: SearchcraftCore, debug?: boolean) => void;

package/dist/types/utils/utils.d.ts

@@ -1,6 +1,4 @@
-/**
- * Utility function to parse custom styles from a string or object.
- * @param styles - Custom styles as a stringified JSON or an object.
- * @returns {Record<string, string>} - Parsed styles as an object.
- */
 export declare function parseCustomStyles(styles: string | Record<string, string>): Record<string, string>;
+export declare function parseSearchKeys(searchKeys: string): string[];
+export declare function extractDynamicProperties(document: Record<string, string | number>, keys: string[]): Record<string, string | number>;
+export declare function serializeStyles(styles: Record<string, Record<string, string>>): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchcraft/javascript-sdk",
   "private": false,
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Searchcraft Javascript SDK",
   "author": "Searchcraft",
   "license": "Apache-2.0",

package/dist/cjs/app-globals-3a1e7e63.js

@@ -1,7 +0,0 @@
-'use strict';
-
-const globalScripts = () => {};
-
-exports.globalScripts = globalScripts;
-
-//# sourceMappingURL=app-globals-3a1e7e63.js.map

package/dist/cjs/app-globals-3a1e7e63.js.map

@@ -1 +0,0 @@
-{"file":"app-globals-3a1e7e63.js","mappings":";;AAAY,MAAC,aAAa,GAAG,MAAM;;;;","names":[],"sources":["@stencil/core/internal/app-globals"],"sourcesContent":["export const globalScripts = () => {};\n"],"version":3}

package/dist/cjs/index-5b0b9d4c.js

@@ -1,84 +0,0 @@
-'use strict';
-
-var classnames = {exports: {}};
-
-/*!
-	Copyright (c) 2018 Jed Watson.
-	Licensed under the MIT License (MIT), see
-	http://jedwatson.github.io/classnames
-*/
-
-(function (module) {
-/* global define */
-
-(function () {
-
-	var hasOwn = {}.hasOwnProperty;
-
-	function classNames () {
-		var classes = '';
-
-		for (var i = 0; i < arguments.length; i++) {
-			var arg = arguments[i];
-			if (arg) {
-				classes = appendClass(classes, parseValue(arg));
-			}
-		}
-
-		return classes;
-	}
-
-	function parseValue (arg) {
-		if (typeof arg === 'string' || typeof arg === 'number') {
-			return arg;
-		}
-
-		if (typeof arg !== 'object') {
-			return '';
-		}
-
-		if (Array.isArray(arg)) {
-			return classNames.apply(null, arg);
-		}
-
-		if (arg.toString !== Object.prototype.toString && !arg.toString.toString().includes('[native code]')) {
-			return arg.toString();
-		}
-
-		var classes = '';
-
-		for (var key in arg) {
-			if (hasOwn.call(arg, key) && arg[key]) {
-				classes = appendClass(classes, key);
-			}
-		}
-
-		return classes;
-	}
-
-	function appendClass (value, newClass) {
-		if (!newClass) {
-			return value;
-		}
-	
-		if (value) {
-			return value + ' ' + newClass;
-		}
-	
-		return value + newClass;
-	}
-
-	if (module.exports) {
-		classNames.default = classNames;
-		module.exports = classNames;
-	} else {
-		window.classNames = classNames;
-	}
-}());
-}(classnames));
-
-const classNames = classnames.exports;
-
-exports.classNames = classNames;
-
-//# sourceMappingURL=index-5b0b9d4c.js.map

package/dist/cjs/index-5b0b9d4c.js.map

@@ -1 +0,0 @@
-{"file":"index-5b0b9d4c.js","mappings":";;;;;;;;;;;AAKA;AACA;AACA,CAAC,YAAY;AAEb;AACA,CAAC,IAAI,MAAM,GAAG,EAAE,CAAC,cAAc,CAAC;AAChC;AACA,CAAC,SAAS,UAAU,IAAI;AACxB,EAAE,IAAI,OAAO,GAAG,EAAE,CAAC;AACnB;AACA,EAAE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;AAC7C,GAAG,IAAI,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAC1B,GAAG,IAAI,GAAG,EAAE;AACZ,IAAI,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACpD,IAAI;AACJ,GAAG;AACH;AACA,EAAE,OAAO,OAAO,CAAC;AACjB,EAAE;AACF;AACA,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE;AAC3B,EAAE,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;AAC1D,GAAG,OAAO,GAAG,CAAC;AACd,GAAG;AACH;AACA,EAAE,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;AAC/B,GAAG,OAAO,EAAE,CAAC;AACb,GAAG;AACH;AACA,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;AAC1B,GAAG,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AACtC,GAAG;AACH;AACA,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC,SAAS,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;AACxG,GAAG,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACzB,GAAG;AACH;AACA,EAAE,IAAI,OAAO,GAAG,EAAE,CAAC;AACnB;AACA,EAAE,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;AACvB,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE;AAC1C,IAAI,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACxC,IAAI;AACJ,GAAG;AACH;AACA,EAAE,OAAO,OAAO,CAAC;AACjB,EAAE;AACF;AACA,CAAC,SAAS,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE;AACxC,EAAE,IAAI,CAAC,QAAQ,EAAE;AACjB,GAAG,OAAO,KAAK,CAAC;AAChB,GAAG;AACH;AACA,EAAE,IAAI,KAAK,EAAE;AACb,GAAG,OAAO,KAAK,GAAG,GAAG,GAAG,QAAQ,CAAC;AACjC,GAAG;AACH;AACA,EAAE,OAAO,KAAK,GAAG,QAAQ,CAAC;AAC1B,EAAE;AACF;AACA,CAAC,IAAqC,MAAM,CAAC,OAAO,EAAE;AACtD,EAAE,UAAU,CAAC,OAAO,GAAG,UAAU,CAAC;AAClC,EAAE,iBAAiB,UAAU,CAAC;AAC9B,EAAE,MAKM;AACR,EAAE,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;AACjC,EAAE;AACF,CAAC,EAAE;;;;;;;","names":[],"sources":["../../node_modules/classnames/index.js"],"sourcesContent":["/*!\n\tCopyright (c) 2018 Jed Watson.\n\tLicensed under the MIT License (MIT), see\n\thttp://jedwatson.github.io/classnames\n*/\n/* global define */\n\n(function () {\n\t'use strict';\n\n\tvar hasOwn = {}.hasOwnProperty;\n\n\tfunction classNames () {\n\t\tvar classes = '';\n\n\t\tfor (var i = 0; i < arguments.length; i++) {\n\t\t\tvar arg = arguments[i];\n\t\t\tif (arg) {\n\t\t\t\tclasses = appendClass(classes, parseValue(arg));\n\t\t\t}\n\t\t}\n\n\t\treturn classes;\n\t}\n\n\tfunction parseValue (arg) {\n\t\tif (typeof arg === 'string' || typeof arg === 'number') {\n\t\t\treturn arg;\n\t\t}\n\n\t\tif (typeof arg !== 'object') {\n\t\t\treturn '';\n\t\t}\n\n\t\tif (Array.isArray(arg)) {\n\t\t\treturn classNames.apply(null, arg);\n\t\t}\n\n\t\tif (arg.toString !== Object.prototype.toString && !arg.toString.toString().includes('[native code]')) {\n\t\t\treturn arg.toString();\n\t\t}\n\n\t\tvar classes = '';\n\n\t\tfor (var key in arg) {\n\t\t\tif (hasOwn.call(arg, key) && arg[key]) {\n\t\t\t\tclasses = appendClass(classes, key);\n\t\t\t}\n\t\t}\n\n\t\treturn classes;\n\t}\n\n\tfunction appendClass (value, newClass) {\n\t\tif (!newClass) {\n\t\t\treturn value;\n\t\t}\n\t\n\t\tif (value) {\n\t\t\treturn value + ' ' + newClass;\n\t\t}\n\t\n\t\treturn value + newClass;\n\t}\n\n\tif (typeof module !== 'undefined' && module.exports) {\n\t\tclassNames.default = classNames;\n\t\tmodule.exports = classNames;\n\t} else if (typeof define === 'function' && typeof define.amd === 'object' && define.amd) {\n\t\t// register as 'classnames', consistent with npm package name\n\t\tdefine('classnames', [], function () {\n\t\t\treturn classNames;\n\t\t});\n\t} else {\n\t\twindow.classNames = classNames;\n\t}\n}());\n"],"version":3}