@searchcraft/javascript-sdk 0.5.3 → 0.6.0

package/dist/types/index.d.ts

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

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

@@ -9,11 +9,11 @@ export interface SearchcraftState {
     removeFacetPathsForIndexField: (fieldName: string) => void;
     addRangeValueForIndexField: (data: RangeValueForIndexField) => void;
     removeRangeValueForIndexField: (fieldName: string) => void;
-    setSearchMode: (mode: 'fuzzy' | 'normal') => void;
+    setSearchMode: (mode: 'fuzzy' | 'exact') => void;
     setSortType: (type: 'asc' | 'desc') => void;
     facetPathsForIndexFields: Record<string, FacetPathsForIndexField>;
     rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
-    searchMode: 'fuzzy' | 'normal';
+    searchMode: 'fuzzy' | 'exact';
     sortType: 'asc' | 'desc';
     facets: FacetPrime | null;
     getSearchcraftInstance: () => SearchcraftCore | null;
@@ -26,6 +26,8 @@ export interface SearchcraftState {
     setIsRequesting: (isRequesting: boolean) => void;
     setQuery: (query: string) => void;
     setSearchResults: (results: SearchcraftResponse | null) => void;
+    setPopoverVisibility: (isVisible: boolean) => void;
+    isPopoverVisible: boolean;
 }
 declare const useSearchcraftStore: import("zustand").UseBoundStore<import("zustand").StoreApi<SearchcraftState>>;
 declare const useThemeStore: import("zustand").UseBoundStore<import("zustand").StoreApi<ThemeState>>;

package/dist/types/types/_shared.types.d.ts

@@ -0,0 +1,45 @@
+/**
+ * A data type representing an index field value, along with properties
+ * describing how to format and display the index field value.
+ */
+export type SearchResultFieldName = {
+    /**
+     * The index field name.
+     */
+    fieldName: string;
+    /**
+     * The data type to treat this index field as.
+     */
+    dataType: 'text' | 'date' | 'number';
+    /**
+     * The locale to use when formatting dataType: `number`
+     */
+    numberFormatLocale?: string;
+    /**
+     * If it's a number, the number format to apply.
+     * reference: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat
+     */
+    numberFormatOptions?: Intl.NumberFormatOptions;
+    /**
+     * A scale factor to apply to a `number` value.
+     */
+    numberScale?: number;
+    /**
+     * TODO: Implement DateFormatOptions, for date formatting
+     */
+    dateFormatOptions?: unknown;
+};
+/**
+ * A data type representing the mapping of index fields, for the purpose of rendering them
+ * in search result item.
+ */
+export type SearchResultMapping = {
+    /**
+     * The fields to map to.
+     */
+    fieldNames: SearchResultFieldName[];
+    /**
+     * The delimiter used to join them.
+     */
+    delimiter?: string;
+};

package/dist/types/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './_shared.types';
 export * from './searchcraft-base-search-results.types';
 export * from './searchcraft-filter-panel.types';
 export * from './searchcraft-popover-form.types';

package/dist/types/types/searchcraft-base-search-results.types.d.ts

@@ -1,11 +1,4 @@
-export type SearchResultFieldName = {
-    fieldName: string;
-    dataType: 'text' | 'date';
-};
-export type SearchResultMapping = {
-    fieldNames: SearchResultFieldName[];
-    delimiter?: string;
-};
+import type { SearchResultMapping } from './_shared.types';
 export type SearchResultMappings = {
     body?: SearchResultMapping;
     buttonHref?: SearchResultMapping;

package/dist/types/types/searchcraft-popover-form.types.d.ts

@@ -1,7 +1,8 @@
-import type { SearchResultMapping } from './searchcraft-base-search-results.types';
+import type { SearchResultMapping } from './_shared.types';
 export type PopoverResultMappings = {
     title?: SearchResultMapping;
     subtitle?: SearchResultMapping;
     imageSource?: SearchResultMapping;
+    imageAlt?: SearchResultMapping;
     href?: SearchResultMapping;
 };

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

@@ -0,0 +1,6 @@
+import type { FacetRoot } from '@searchcraft/core';
+/**
+ * Given an array of facet paths, removes parent facet paths.
+ */
+export declare function removeSubstringMatches(arr: string[]): string[];
+export declare function mergeFacetRoots(fieldName: string, currentRoot: FacetRoot, incomingRoot: FacetRoot): FacetRoot;

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

@@ -0,0 +1,3 @@
+export * from './facets';
+export * from './units';
+export * from './styles';

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

@@ -0,0 +1,2 @@
+export declare function parseCustomStyles(styles: string | Record<string, string>): Record<string, string>;
+export declare function serializeStyles(styles: Record<string, Record<string, string>>): string;

package/dist/types/utils/{utils.d.ts → units.d.ts}

@@ -1,28 +1,21 @@
-import type { FacetRoot } from '@searchcraft/core';
 import type { SearchResultMapping } from "../types/index";
-export declare function parseCustomStyles(styles: string | Record<string, string>): Record<string, string>;
-export declare function serializeStyles(styles: Record<string, Record<string, string>>): string;
-/**
- * Given a timestamp value, returns a formatted time string for the time
- * since now.
- *
- * @param timestamp
- * @returns {string} Formatted string value
- */
-export declare function getFormattedTimeFromNow(timestamp: string): string;
-export declare function filterPaths(paths: any): any;
-export declare function formatNumberWithCommas(number: any): any;
-export declare function getMillis(unit: 'year' | 'month' | 'day' | 'hour'): number;
-/**
- * Given an array of facet paths, removes parent facet paths.
- */
-export declare function removeSubstringMatches(arr: string[]): string[];
 /**
  * Given a document and a SearchResultMapping, return a mapped value from the document.
  *
+ * Applies formatting based on the values specified in the `SearchResultFieldName` values.
+ *
  * @param document
  * @param {SearchResultMapping} mapping
  * @returns {string | undefined}
  */
 export declare function getDocumentValueFromSearchResultMapping(document: Record<string, unknown> | undefined, mapping: SearchResultMapping | undefined): string | undefined;
-export declare function mergeFacetRoots(fieldName: string, currentRoot: FacetRoot, incomingRoot: FacetRoot): FacetRoot;
+export declare function getMillis(unit: 'year' | 'month' | 'day' | 'hour'): number;
+export declare function formatNumberWithCommas(number: any): any;
+/**
+ * Given a timestamp value, returns a formatted time string for the time
+ * since now.
+ *
+ * @param timestamp
+ * @returns {string} Formatted string value
+ */
+export declare function getFormattedTimeFromNow(timestamp: string): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchcraft/javascript-sdk",
   "private": false,
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "Searchcraft Javascript SDK",
   "author": "Searchcraft",
   "license": "Apache-2.0",
@@ -35,7 +35,9 @@
     "type": "git",
     "url": "https://bitbucket.org/madebychalk/searchcraft-javascript-sdks/"
   },
-  "files": ["dist/"],
+  "files": [
+    "dist/"
+  ],
   "scripts": {
     "build": "stencil build",
     "dev": "stencil build --dev --watch",
@@ -47,12 +49,13 @@
     "classnames": "^2.3.2"
   },
   "devDependencies": {
-    "@searchcraft/core": "*",
+    "@searchcraft/core": "^0.6.0",
     "@searchcraft/javascript-sdk": "*",
     "@stencil/core": "^4.7.0",
     "@stencil/react-output-target": "^0.8.2",
     "@stencil/sass": "^3.0.12",
     "@types/node": "^16.18.11",
     "zustand": "^5.0.1"
-  }
+  },
+  "gitHead": "99e5b59f253bea37bd85059bd62d0b0f57c0307f"
 }