@algolia/autocomplete-shared 1.8.3 → 1.9.0

package/dist/esm/preset-algolia/createRequester.d.ts

@@ -0,0 +1,89 @@
+import { UserAgent } from '../UserAgent';
+import { MultipleQueriesQuery, SearchClient, SearchForFacetValuesResponse, SearchResponse } from './algoliasearch';
+export interface SearchParams {
+    /**
+     * The initialized Algolia search client.
+     */
+    searchClient: SearchClient;
+    /**
+     * A list of queries to execute.
+     */
+    queries: MultipleQueriesQuery[];
+    /**
+     * A list of user agents to add to the search client.
+     *
+     * This is useful to track usage of an integration.
+     */
+    userAgents?: UserAgent[];
+}
+export declare type Fetcher = <TRecord>({ searchClient, queries, userAgents, }: SearchParams) => Promise<Array<SearchForFacetValuesResponse | SearchResponse<TRecord>>>;
+declare type FacetHit = {
+    label: string;
+    count: number;
+    _highlightResult: {
+        label: {
+            value: string;
+        };
+    };
+};
+export declare type FetcherParams = Pick<Parameters<Fetcher>[0], 'searchClient' | 'queries'>;
+export declare type RequesterParams<THit> = {
+    transformResponse(response: TransformResponseParams<THit>): TransformedRequesterResponse<THit>;
+};
+declare type TransformResponseParams<THit> = {
+    results: Array<SearchResponse<THit> | SearchForFacetValuesResponse>;
+    hits: Array<SearchResponse<THit>['hits']>;
+    facetHits: FacetHit[][];
+};
+export declare type TransformedRequesterResponse<THit> = Array<SearchResponse<THit>['hits']> | SearchResponse<THit>['hits'] | FacetHit[][] | FacetHit[];
+export declare type TransformResponse<THit> = (response: TransformResponseParams<THit>) => TransformedRequesterResponse<THit>;
+declare type FetcherParamsQuery<THit> = {
+    query: MultipleQueriesQuery;
+    sourceId: string;
+    transformResponse: TransformResponse<THit>;
+};
+export declare type ExecuteParams<THit> = {
+    searchClient: SearchClient;
+    requests: Array<FetcherParamsQuery<THit>>;
+};
+export declare type Execute<THit> = (params: ExecuteParams<THit>) => Promise<ExecuteResponse<THit>>;
+export declare type ExecuteResponse<THit> = Array<{
+    items: SearchResponse<THit> | SearchForFacetValuesResponse;
+    sourceId: string;
+    transformResponse: TransformResponse<THit>;
+}>;
+export declare type RequestParams<THit> = FetcherParams & {
+    /**
+     * The function to transform the Algolia response before passing it to the Autocomplete state. You have access to the full Algolia results, as well as the pre-computed hits and facet hits.
+     *
+     * This is useful to manipulate the hits, or store data from the results in the [context](https://www.algolia.com/doc/ui-libraries/autocomplete/core-concepts/context/).
+     */
+    transformResponse?: TransformResponse<THit>;
+};
+export declare type RequesterDescription<THit> = {
+    /**
+     * The search client used for this request. Multiple queries with the same client are batched (if `requesterId` is also the same).
+     */
+    searchClient: SearchClient;
+    /**
+     * Identifies requesters to confirm their queries should be batched.
+     * This ensures that requesters with the same client but different
+     * post-processing functions don't get batched.
+     * When falsy, batching is disabled.
+     * For example, the Algolia requesters use "algolia".
+     */
+    requesterId?: string;
+    /**
+     * The search parameters used for this query.
+     */
+    queries: MultipleQueriesQuery[];
+    /**
+     * Transforms the response of this search before returning it to the caller.
+     */
+    transformResponse: TransformResponse<THit>;
+    /**
+     * Post-processing function for multi-queries.
+     */
+    execute: Execute<THit>;
+};
+export {};

package/dist/esm/preset-algolia/createRequester.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/safelyRunOnBrowser.d.ts

@@ -0,0 +1,8 @@
+declare type BrowserCallback<TReturn> = (params: {
+    window: typeof window;
+}) => TReturn;
+/**
+ * Safely runs code meant for browser environments only.
+ */
+export declare function safelyRunOnBrowser<TReturn>(callback: BrowserCallback<TReturn>): TReturn | undefined;
+export {};

package/dist/esm/safelyRunOnBrowser.js

@@ -0,0 +1,11 @@
+/**
+ * Safely runs code meant for browser environments only.
+ */
+export function safelyRunOnBrowser(callback) {
+  if (typeof window !== 'undefined') {
+    return callback({
+      window: window
+    });
+  }
+  return undefined;
+}

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.8.3";
+export declare const version = "1.9.0";

package/dist/esm/version.js

@@ -1 +1 @@
-export var version = '1.8.3';
+export var version = '1.9.0';

package/dist/esm/warn.js

@@ -1,26 +1,24 @@
 export var warnCache = {
   current: {}
 };
+
 /**
  * Logs a warning if the condition is not met.
  * This is used to log issues in development environment only.
  */
-
 export function warn(condition, message) {
   if (!(process.env.NODE_ENV !== 'production')) {
     return;
   }
-
   if (condition) {
     return;
   }
-
   var sanitizedMessage = message.trim();
   var hasAlreadyPrinted = warnCache.current[sanitizedMessage];
-
   if (!hasAlreadyPrinted) {
-    warnCache.current[sanitizedMessage] = true; // eslint-disable-next-line no-console
+    warnCache.current[sanitizedMessage] = true;
 
+    // eslint-disable-next-line no-console
     console.warn("[Autocomplete] ".concat(sanitizedMessage));
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@algolia/autocomplete-shared",
   "description": "Shared utils for Autocomplete packages.",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "license": "MIT",
   "homepage": "https://github.com/algolia/autocomplete",
   "repository": "algolia/autocomplete",
@@ -25,5 +25,13 @@
     "on:change": "concurrently \"yarn build:esm\" \"yarn build:types\"",
     "prepare": "yarn build:esm && yarn build:types",
     "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
+  },
+  "devDependencies": {
+    "@algolia/client-search": "4.16.0",
+    "algoliasearch": "4.16.0"
+  },
+  "peerDependencies": {
+    "@algolia/client-search": ">= 4.9.1 < 6",
+    "algoliasearch": ">= 4.9.1 < 6"
   }
 }