@searchcraft/javascript-sdk 0.10.7 → 0.11.1

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

@@ -1,3 +1,3 @@
-export * from './SearchcraftStore';
+export * from './SearchcraftStoreFactory';
 export * from './SearchcraftStore.types';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/types/core-types/AdClientResponses.types.d.ts

@@ -0,0 +1,24 @@
+export interface ADMResponse {
+    partial_qt: string;
+    text_ads: ADMAd[];
+    product_ads: ADMAd[];
+}
+export interface AdClientResponseItem {
+    id: string;
+}
+export interface ADMClientResponseItem extends AdClientResponseItem {
+    admAdType: 'adm-text-ad' | 'adm-product-ad';
+    admAd?: ADMAd;
+}
+export interface ADMAd {
+    adv_id: number;
+    adv_name: string;
+    click_url?: string;
+    image_url?: string;
+    impression_url?: string;
+    price?: number;
+    price_currency?: string;
+    sale_price?: number;
+    term: string;
+}
+//# sourceMappingURL=AdClientResponses.types.d.ts.map

package/dist/types/types/core-types/Facets.types.d.ts

@@ -0,0 +1,39 @@
+export type Facet = {
+    /**
+     * The path of the facet. The path represents where in the facet tree structure
+     * this facet exists. There is an arbitrary number of levels in a facet tree.
+     *
+     * @example
+     *
+     * '/sports/college' - Represents that this is the facet node exists at [root] -> [sports] -> [college] in the facet tree.
+     * '/weather' - Represents that this facet exists at [root] -> [weather] in the facet tree
+     * '/news/local' - [root] -> [news] -> [local]
+     */
+    path: string;
+    /**
+     * The count value just represents an arbitrary `count` metadata for this facet node.
+     */
+    count: number;
+};
+export type FacetWithChildrenArray = Facet & {
+    children: FacetWithChildrenArray[] | null | undefined;
+};
+export type FacetWithChildrenObject = Facet & {
+    children: Record<string, FacetWithChildrenObject>;
+};
+/**
+ * A Facet object returned in a search response.
+ */
+export type FacetRoot = {
+    [key: string]: FacetWithChildrenArray[];
+};
+export type FacetPrime = FacetRoot[];
+/**
+ * A structured Facet tree.
+ *
+ * A Facet tree is the root node of a "complete view" of the facet node tree.
+ * Nodes are structured based on the `path` of each facet
+ *
+ */
+export type FacetTree = FacetWithChildrenObject;
+//# sourceMappingURL=Facets.types.d.ts.map

package/dist/types/types/core-types/Measure.types.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Types of measure requests that can be sent to the /measure/event endpoint.
+ */
+export type MeasureEventName = 'sdk_initialized' | 'search_requested' | 'search_response_received' | 'search_completed' | 'document_clicked';
+/**
+ * The type used for sending multiple measure events in a single network request.
+ * Uses /measure/batch request.
+ */
+export interface BatchMeasureRequest {
+    items: MeasureRequest[];
+}
+/**
+ * The type representing a measure request.
+ */
+export interface MeasureRequest {
+    event_name: MeasureEventName;
+    properties: MeasureRequestProperties;
+    user: MeasureRequestUser;
+}
+/**
+ * Properties attached to a measure request.
+ */
+export interface MeasureRequestProperties {
+    searchcraft_organization_id?: string;
+    searchcraft_application_id?: string;
+    searchcraft_index_names: string[];
+    search_term?: string;
+    number_of_documents?: number;
+    external_document_id?: string;
+    document_position?: number;
+    session_id?: string;
+}
+/**
+ * User properties attached to a measure request.
+ */
+export interface MeasureRequestUser {
+    user_id: string;
+    country?: string;
+    city?: string;
+    device_id?: string;
+    client_ip?: string;
+    locale?: string;
+    os?: string;
+    platform?: string;
+    region?: string;
+    sdk_name?: string;
+    sdk_version?: string;
+    user_agent?: string;
+    latitude?: number;
+    longitude?: number;
+}
+//# sourceMappingURL=Measure.types.d.ts.map

package/dist/types/types/core-types/SearchClient.types.d.ts

@@ -0,0 +1,67 @@
+export interface FacetPathsForIndexField {
+    fieldName: string;
+    value: string;
+}
+export interface RangeValueForIndexField {
+    fieldName: string;
+    value: string;
+}
+export interface SearchClientQuery {
+    occur?: 'must' | 'should';
+    exact?: {
+        ctx: string;
+    };
+    fuzzy?: {
+        ctx: string;
+    };
+}
+export type SearchClientRequest = {
+    limit?: number;
+    offset?: number;
+    order_by?: string;
+    sort?: 'asc' | 'desc';
+    query: SearchClientQuery[];
+};
+export interface SearchClientRequestProperties {
+    /**
+     * The search mode, which can be either 'fuzzy' or 'exact'.
+     */
+    mode: 'fuzzy' | 'exact';
+    /**
+     * The starting point for the results, used for pagination.
+     * Optional parameter.
+     */
+    offset?: number;
+    /**
+     * The number of results returned.
+     * Optional parameter.
+     */
+    limit?: number;
+    /**
+     * The field to order the results by (e.g., 'date_published', 'title', etc.).
+     * Optional parameter.
+     */
+    order_by?: string | null;
+    /**
+     * The search term provided by the user.
+     */
+    searchTerm: string;
+    /**
+     * The sort order, which can be either 'asc' or 'desc'.
+     * Optional parameter.
+     */
+    sort?: 'asc' | 'desc' | null;
+    /**
+     * The facet path value(s) specified by the `facets` filter items that the `searchcraft-filter-panel` renders.
+     * There may be multiple rendered within a single filter panel.
+     * Optional parameter.
+     */
+    facetPathsForIndexFields?: Record<string, FacetPathsForIndexField>;
+    /**
+     * The date range slider value(s) specified by the `dateRange` filter items that the `searchcraft-filter-panel` renders.
+     * There may be multiple rendered within a single filter panel.
+     * Optional parameter.
+     */
+    rangeValueForIndexFields?: Record<string, RangeValueForIndexField>;
+}
+//# sourceMappingURL=SearchClient.types.d.ts.map

package/dist/types/types/core-types/SearchClientResponses.types.d.ts

@@ -0,0 +1,7 @@
+import type { SearchDocument } from './SearchcraftResponse.types';
+export interface SearchClientResponseItem {
+    id: string;
+    document: SearchDocument;
+    source_index?: string;
+}
+//# sourceMappingURL=SearchClientResponses.types.d.ts.map

package/dist/types/types/core-types/SearchcraftAdConfig.types.d.ts

@@ -0,0 +1,76 @@
+import type { ADMAdTemplate, CustomAdTemplate } from '../sdk-types';
+export interface CustomAdConfig {
+    /**
+     * The amount of debounce delay to add before calling the ad_container_rendered event
+     */
+    adContainerRenderedDebounceDelay?: number;
+    /**
+     * The number of custom ads to render at the start of the search results page.
+     */
+    adStartQuantity?: number;
+    /**
+     * The number of custom ads to render at the end of the search results page.
+     */
+    adEndQuantity?: number;
+    /**
+     * Renders a custom ad in between search results, at the specified interval.
+     */
+    adInterstitialInterval?: number;
+    /**
+     * Specifies the number of ads to be rendered in each interstitial in between search results.
+     */
+    adInterstitialQuantity?: number;
+    /**
+     * A callback function responsible for rendering the custom ad containers.
+     */
+    template: CustomAdTemplate;
+}
+export interface NativoAdConfig {
+    /**
+     * The placement id to use for Nativo ads.
+     */
+    placementId?: number;
+    /**
+     * The class name for nativo ad containers.
+     */
+    adClassName?: string;
+    /**
+     * The number of custom ads to render at the start of the search results page.
+     */
+    adStartQuantity?: number;
+    /**
+     * The number of custom ads to render at the end of the search results page.
+     */
+    adEndQuantity?: number;
+    /**
+     * Renders a custom ad in between search results, at the specified interval.
+     */
+    adInterstitialInterval?: number;
+    /**
+     * Specify how many normal search results to render before rendering the first interstitial ad grouping.
+     */
+    adInterstialStartIndex?: number;
+    /**
+     * Specifies the number of ads to be rendered in each interstitial in between search results.
+     */
+    adInterstitialQuantity?: number;
+}
+export interface ADMAdConfig {
+    /**
+     * The number of product ads to request.
+     */
+    productAdQuantity?: number;
+    /**
+     * The number of text ads to request.
+     */
+    textAdQuantity?: number;
+    /**
+     * The adm sub value.
+     */
+    sub?: string;
+    /**
+     * A callback function responsible for rendering the ADM ad containers.
+     */
+    template?: ADMAdTemplate;
+}
+//# sourceMappingURL=SearchcraftAdConfig.types.d.ts.map

package/dist/types/types/core-types/SearchcraftConfig.types.d.ts

@@ -0,0 +1,65 @@
+import type { ADMAdConfig, CustomAdConfig, NativoAdConfig } from './SearchcraftAdConfig.types';
+/**
+ * The SearchcraftConfig object is used to initialize the Searchcraft JavaScript SDK in your front-end application. See the [getting started page](https://docs.searchcraft.io/sdks/javascript/getting-started/) for a guide on how and where to use this configuration object.
+ */
+export interface SearchcraftConfig {
+    /**
+     * The read key value to use when sending Searchcraft search requests. This value needs read key-specific permissions. If you are using Searchcraft Cloud, this value can be configured in Vektron.
+     */
+    readKey: string;
+    /**
+     * The endpoint url of your Searchcraft cluster where your specified search index exists. If you are using Searchcraft Cloud, this value can be found within the Vektron dashboard in the Code Snippets section when configuring a search index.
+     */
+    endpointURL: string;
+    /**
+     * Name of the Searchcraft search index to search for results within. If you are using Searchcraft Cloud, this value can be found within the Vektron dashboard in the Code Snippets section when configuring a search index.
+     */
+    indexName: string;
+    /**
+     * The initial search query to call when Searchcraft is first initialized in your front-end application. This parameter can be used when you want to populate a page with an initial set of search results based on a query.
+     *
+     * This value is a stringified Search query object. For a more in-depth reference on search queries, see the [search endpoint documentation](https://docs.searchcraft.io/api/search/).
+     */
+    initialQuery?: string;
+    /**
+     * The maximum number of documents to return per page of results.
+     */
+    searchResultsPerPage?: number;
+    /**
+     * The URL pointing towards Searchcraft Cloud's semantic search and RAG summary processing layer. When using a `searchcraft-summary-box` component, this value must be specified.
+     */
+    cortexURL?: string;
+    /**
+     * Instructions provided to the LLM when creating search result summaries.
+     */
+    summaryInstructionsPrompt?: string;
+    /**
+     * The amount of delay, in milliseconds, to debounce summary requests. Defaults to `1000`
+     */
+    summaryDebounceDelay?: number;
+    /**
+     * Name of the ad source to use.
+     */
+    searchDebounceDelay?: number;
+    /**
+     * A unique user identifier for end users of your product. This would typically correspond to a user id
+     * in your consuming application's database. Used for data analysis and visualizations on Vektron.
+     */
+    measureUserIdentifier?: string;
+    /**
+     * This object allows you to configure the quantity, number, template, and positioning of custom ad containers within your search results.
+     *
+     * To see more information on how to configure custom ads, see [the custom ads guide](https://docs.searchcraft.io/sdks/javascript/custom-ads/)
+     */
+    customAdConfig?: CustomAdConfig;
+    nativoConfig?: NativoAdConfig;
+    admAdConfig?: ADMAdConfig;
+}
+/**
+ * Used internally by consuming packages as part of the core sdk constructor.
+ */
+export interface SearchcraftSDKInfo {
+    sdkName: string;
+    sdkVersion: string;
+}
+//# sourceMappingURL=SearchcraftConfig.types.d.ts.map

package/dist/types/types/core-types/SearchcraftResponse.types.d.ts

@@ -0,0 +1,46 @@
+import type { FacetPrime } from './Facets.types';
+/**
+ * The structure of a response returned from a Searchcraft operation.
+ */
+export interface SearchcraftResponse {
+    status: number;
+    data: SearchcraftResponseData | SearchcraftResponseError;
+}
+/**
+ * Error returned when a search is unsuccessful.
+ */
+export type SearchcraftResponseError = {
+    status: number;
+    message?: string;
+    code?: number;
+    hits?: [];
+    facets?: null;
+    count?: number;
+    time_taken?: number;
+};
+/**
+ * Top-level result returned when a search is successful.
+ */
+export interface SearchcraftResponseData {
+    count?: number;
+    facets?: FacetPrime;
+    hits?: SearchIndexHit[];
+    time_taken?: number;
+}
+/**
+ * Represents an entry in the search index returned as part of a search result.
+ */
+export interface SearchIndexHit {
+    doc?: SearchDocument;
+    document_id?: string;
+    score?: number;
+    source_index?: string;
+}
+/**
+ * Data document returned within a SearchResult.
+ */
+export interface SearchDocument extends Record<string, string | number> {
+    id: number;
+    [key: string]: string | number;
+}
+//# sourceMappingURL=SearchcraftResponse.types.d.ts.map

package/dist/types/types/core-types/SubscriptionEvents.types.d.ts

@@ -0,0 +1,51 @@
+export interface SubscriptionEventMap {
+    ad_container_rendered: AdContainerRenderedSubscriptionEvent;
+    ad_container_viewed: AdContainerViewedSubscriptionEvent;
+    query_fetched: QueryFetchedEvent;
+    query_submitted: QuerySubmittedEvent;
+    initialized: InitializedEvent;
+    input_cleared: InputClearedEvent;
+    no_results_returned: NoResultsReturnedEvent;
+}
+export interface AdContainerRenderedSubscriptionEvent extends SubscriptionEvent {
+    name: 'ad_container_rendered';
+    data: {
+        adContainerId: string;
+        searchTerm: string;
+    };
+}
+export interface AdContainerViewedSubscriptionEvent extends SubscriptionEvent {
+    name: 'ad_container_viewed';
+    data: {
+        adContainerId: string;
+        searchTerm: string;
+    };
+}
+export interface QuerySubmittedEvent extends SubscriptionEvent {
+    name: 'query_submitted';
+    data: {
+        searchTerm: string;
+    };
+}
+export interface QueryFetchedEvent extends SubscriptionEvent {
+    name: 'query_fetched';
+    data: {
+        searchTerm: string;
+    };
+}
+export interface InputClearedEvent extends SubscriptionEvent {
+    name: 'input_cleared';
+}
+export interface NoResultsReturnedEvent extends SubscriptionEvent {
+    name: 'no_results_returned';
+}
+export interface InitializedEvent extends SubscriptionEvent {
+    name: 'initialized';
+}
+export type SubscriptionEventName = keyof SubscriptionEventMap;
+export type SubscriptionEventCallback<T extends SubscriptionEventName> = (event: SubscriptionEventMap[T]) => void;
+export type UnsubscribeFunction = () => void;
+export interface SubscriptionEvent {
+    name: SubscriptionEventName;
+}
+//# sourceMappingURL=SubscriptionEvents.types.d.ts.map

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

@@ -0,0 +1,10 @@
+export * from './AdClientResponses.types';
+export * from './Facets.types';
+export * from './Measure.types';
+export * from './SearchcraftConfig.types';
+export * from './SearchClient.types';
+export * from './SearchClientResponses.types';
+export * from './SearchcraftResponse.types';
+export * from './SubscriptionEvents.types';
+export * from './SearchcraftAdConfig.types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,3 @@
+export * from './core-types';
+export * from './sdk-types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,4 @@
+export * from './result-mappings.types';
+export * from './searchcraft-filter-panel.types';
+export * from './templates.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/sdk-types/result-mappings.types.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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;
+    /**
+     * The locale to use when formatting dataType: `date`.
+     */
+    dateFormatLocale?: string;
+    /**
+     * If it's a date, the date format to apply.
+     * Reference: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat
+     */
+    dateFormatOptions?: Intl.DateTimeFormatOptions;
+};
+/**
+ * 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;
+};
+export type PopoverResultMappings = {
+    title?: SearchResultMapping;
+    subtitle?: SearchResultMapping;
+    imageSource?: SearchResultMapping;
+    imageAlt?: SearchResultMapping;
+    href?: SearchResultMapping;
+};
+//# sourceMappingURL=result-mappings.types.d.ts.map

package/dist/types/types/sdk-types/searchcraft-filter-panel.types.d.ts

@@ -0,0 +1,44 @@
+export interface FilterItem {
+    type: 'facets' | 'dateRange' | 'numericRange' | 'exactMatchToggle' | 'mostRecentToggle';
+    label: string;
+    options: object | null;
+}
+export interface FacetsFilterItem extends FilterItem {
+    fieldName: string;
+    type: 'facets';
+    options: {
+        showSublevel: boolean;
+    };
+}
+export interface NumericFilterItem extends FilterItem {
+    fieldName: string;
+    type: 'numericRange';
+    options: {
+        min: number;
+        max: number;
+        granularity: number;
+    };
+}
+export interface DateRangeFilterItem extends FilterItem {
+    fieldName: string;
+    type: 'dateRange';
+    options: {
+        minDate: Date;
+        maxDate?: Date;
+        granularity: 'year' | 'month' | 'day' | 'hour';
+    };
+}
+export interface ExactMatchToggleFilterItem extends FilterItem {
+    type: 'exactMatchToggle';
+    options: {
+        subLabel?: string;
+    };
+}
+export interface MostRecentToggleFilterItem extends FilterItem {
+    fieldName: string;
+    type: 'mostRecentToggle';
+    options: {
+        subLabel?: string;
+    };
+}
+//# sourceMappingURL=searchcraft-filter-panel.types.d.ts.map

package/dist/types/types/sdk-types/templates.types.d.ts

@@ -0,0 +1,29 @@
+import type { ADMAd } from '..';
+export type TemplateHtml = (strings: TemplateStringsArray, ...values: (string | number | undefined)[]) => string;
+export type SearchResultTemplate<T> = (data: T, index: number, utils: {
+    html: TemplateHtml;
+    source_index?: string;
+}) => string;
+export type SearchResultTemplateData = any;
+export type ResultsInfoTemplate = (data: {
+    range: [number, number];
+    count: number;
+    responseTime: string;
+}, utils: {
+    html: TemplateHtml;
+}) => string;
+export type CustomAdTemplate = (data: {
+    adContainerId: string;
+    searchTerm: string;
+}, utils: {
+    html: TemplateHtml;
+}) => string;
+export type PopoverButtonTemplate = (data: {
+    isPopoverVisible: boolean;
+}, utils: {
+    html: TemplateHtml;
+}) => string;
+export type ADMAdTemplate = (data: ADMAd, utils: {
+    html: TemplateHtml;
+}) => string;
+//# sourceMappingURL=templates.types.d.ts.map

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

@@ -0,0 +1,3 @@
+export * from './url';
+export * from './sanitize';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/core-utils/sanitize.d.ts

@@ -0,0 +1,2 @@
+export declare const sanitize: (str: string) => string;
+//# sourceMappingURL=sanitize.d.ts.map

package/dist/types/utils/core-utils/url.d.ts

@@ -0,0 +1,2 @@
+export declare const removeTrailingSlashFromURL: (endpointURL: string) => string;
+//# sourceMappingURL=url.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { FacetTree, FacetWithChildrenArray, FacetWithChildrenObject } from '@searchcraft/core';
+import type { FacetTree, FacetWithChildrenArray, FacetWithChildrenObject } from "../types/index";
 /**
  * Helper function for getting a Node (FacetWithChildrenObject)
  * at a given path. Traverses the node tree to get the node.

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

@@ -1,4 +1,4 @@
-import type { TemplateHtml } from '@searchcraft/core';
+import type { TemplateHtml } from "../types/index";
 /**
  * This allows you to parse a template string with a function.
  */

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

@@ -1,4 +1,4 @@
-import type { SearchResultMapping } from '@searchcraft/core';
+import type { SearchResultMapping } from "../types/index";
 /**
  * Given a document and a SearchResultMapping, return a mapped value from the document.
  * Applies formatting based on the values specified in the `SearchResultFieldName` values.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchcraft/javascript-sdk",
   "private": false,
-  "version": "0.10.7",
+  "version": "0.11.1",
   "description": "Searchcraft Javascript SDK",
   "author": "Searchcraft Inc.",
   "license": "Apache-2.0",
@@ -41,16 +41,18 @@
   "dependencies": {
     "classnames": "^2.3.2",
     "dompurify": "^3.2.4",
+    "marked": "^15.0.12",
     "nanoid": "^5.0.9"
   },
   "devDependencies": {
-    "@searchcraft/core": "^0.10.7",
     "@stencil/core": "^4.7.0",
     "@stencil/react-output-target": "^0.8.2",
     "@stencil/sass": "^3.0.12",
     "@stencil/vue-output-target": "^0.9.2",
+    "@thumbmarkjs/thumbmarkjs": "^0.16.1",
     "@types/node": "^16.18.11",
+    "nanoid": "^5.0.9",
     "zustand": "^5.0.1"
   },
-  "gitHead": "4d1205a1002012ffcb08cd3afe4bfdf7da52d6c1"
+  "gitHead": "a76993be3f9de0f8dd0a1d8326a43435e794ec7d"
 }