@findlane/browser 0.9.0 → 0.11.0

package/README.md

@@ -42,7 +42,7 @@ import "@findlane/browser/react/styles.css" // optional
 <SearchBox publicId="pub_your_public_id" getHref={(hit) => hit.record.url} action="/search" />
 ```
 
-`SearchDialog` is the same search box in a dialog that ⌘K opens, as on docs sites. A results page shares its state through `SearchProvider`, with `RefinementList`, `SortSelect`, `Hits`, `LoadMore`, and hooks such as `useRefinementList` and `useRange` for your own markup. With `routing`, the search is kept in the URL. `@findlane/browser/react/ssr` renders the first results on the server. Docs: https://findlane.dev/docs/react
+`SearchDialog` is the same search box in a dialog that ⌘K opens, as on docs sites. A results page shares its state through `SearchProvider`, with `RefinementList`, `SortSelect`, `Hits`, `LoadMore`, and hooks such as `useRefinementList` and `useRange` for your own markup. With `routing`, the search is kept in the URL. `@findlane/browser/react/ssr` renders the first results on the server. On a product page, `useProductView(objectID)`, or `<ProductView>` in a server component, sends the page's view for the index's Events page. Docs: https://findlane.dev/docs/react
 
 ## Search requests
 

package/dist/index.d.ts

@@ -149,6 +149,8 @@ export type ClickDetails = {
 /** Events from the page, sent in the background: a batch a second, and what's left when the page is
  * hidden or closed. They carry no cookie or ID. */
 export type BrowserEvents = {
+    /** A product's page was viewed. A repeat of the last view within 5 seconds is the same page view
+     * (React's double mount in development, a re-render), so it isn't sent. */
     view(objectID: string): void;
     click(objectID: string, details?: ClickDetails): void;
     addToCart(items: EventItem[], options?: {
@@ -177,6 +179,10 @@ export type BrowserClientOptions = {
     /** Whether `events` sends anything: true (the default), false, or "afterConsent" to hold events until
      * `events.consent(true)`. */
     events?: boolean | "afterConsent";
+    /** Where events go: the API, unless you relay them from a route on your own domain (the server SDK's
+     * `events.proxy`), such as "/findlane/events". Ad blockers block beacons to other sites, not to the
+     * page's own. */
+    eventsUrl?: string;
 };
 export declare class SearchBrowserClient {
     private readonly url;

package/dist/index.js

@@ -13,6 +13,7 @@ function eventSender(url, fetcher, mode) {
     let allowed = mode === "afterConsent" ? undefined : mode;
     let timer;
     let listening = false;
+    let lastView = { objectID: "", at: 0 };
     const flush = () => {
         clearTimeout(timer);
         timer = undefined;
@@ -37,7 +38,13 @@ function eventSender(url, fetcher, mode) {
         timer ??= setTimeout(flush, 1000);
     };
     return {
-        view: (objectID) => add({ type: "view", objectID }),
+        view(objectID) {
+            const now = Date.now();
+            if (objectID === lastView.objectID && now - lastView.at < 5000)
+                return;
+            lastView = { objectID, at: now };
+            add({ type: "view", objectID });
+        },
         click: (objectID, details) => add({ type: "click", objectID, ...details }),
         addToCart: (items, options) => add({ type: "addToCart", items, ...options }),
         purchase: (order) => add({ type: "purchase", ...order }),
@@ -61,7 +68,7 @@ export class SearchBrowserClient {
             throw new Error("A valid public index ID (pub_…) is required");
         this.url = `${(options.baseUrl ?? defaultBaseUrl).replace(/\/$/, "")}/api/public/indexes/${options.publicId}`;
         this.fetcher = options.fetch ?? ((input, init) => globalThis.fetch(input, init));
-        this.events = eventSender(`${this.url}/events`, options.fetch, options.events ?? true);
+        this.events = eventSender(options.eventsUrl ?? `${this.url}/events`, options.fetch, options.events ?? true);
     }
     async post(operation, request, signal) {
         const response = await this.fetcher(`${this.url}/${operation}`, {

package/dist/react/index.d.ts

@@ -3,6 +3,7 @@ export { useSearch, type UseSearchOptions, type UseSearchResult } from "./use-se
 export { useAutocomplete, type AutocompleteOptions } from "./use-autocomplete.js";
 export { useRecommendations, type UseRecommendationsOptions, type UseRecommendationsResult } from "./use-recommendations.js";
 export { Recommendations, type RecommendationsProps } from "./recommendations.js";
+export { ProductView, useProductView } from "./product-view.js";
 export { SearchProvider, useCurrentRefinements, useDidYouMean, useGeoSearch, useHits, useLoadMore, usePagination, useRange, useRefinementList, useSearchBox, useSearchState, useSortBy, useToggle, type Range, type Refinement, type SearchProviderProps, } from "./search-provider.js";
 export { CurrentRefinements, DefaultHit, DidYouMean, Hits, LoadMore, RefinementList, SearchBox, SearchInput, SortSelect, Stats, type HitsProps, type RefinementListProps, type SearchBoxProps, } from "./components.js";
 export { SearchDialog, type SearchDialogProps } from "./dialog.js";

package/dist/react/index.js

@@ -5,6 +5,7 @@ export { useSearch } from "./use-search.js";
 export { useAutocomplete } from "./use-autocomplete.js";
 export { useRecommendations } from "./use-recommendations.js";
 export { Recommendations } from "./recommendations.js";
+export { ProductView, useProductView } from "./product-view.js";
 export { SearchProvider, useCurrentRefinements, useDidYouMean, useGeoSearch, useHits, useLoadMore, usePagination, useRange, useRefinementList, useSearchBox, useSearchState, useSortBy, useToggle, } from "./search-provider.js";
 export { CurrentRefinements, DefaultHit, DidYouMean, Hits, LoadMore, RefinementList, SearchBox, SearchInput, SortSelect, Stats, } from "./components.js";
 export { SearchDialog } from "./dialog.js";

package/dist/react/product-view.d.ts

@@ -0,0 +1,10 @@
+import { type ClientOptions } from "./client.js";
+/** Sends a view of the product when its page shows, and again when `objectID` changes, for the index's
+ * Events page and popularity. Nothing is sent while `objectID` is empty. The client's `events` option
+ * turns views off, or holds them until consent. */
+export declare function useProductView(objectID: string | null | undefined, options?: ClientOptions): void;
+/** useProductView as a component that renders nothing, for pages that can't call hooks, such as a
+ * Next.js server component. */
+export declare function ProductView({ objectID, ...options }: ClientOptions & {
+    objectID: string;
+}): null;

package/dist/react/product-view.js

@@ -0,0 +1,19 @@
+"use client";
+import { useEffect } from "react";
+import { useClient } from "./client.js";
+/** Sends a view of the product when its page shows, and again when `objectID` changes, for the index's
+ * Events page and popularity. Nothing is sent while `objectID` is empty. The client's `events` option
+ * turns views off, or holds them until consent. */
+export function useProductView(objectID, options = {}) {
+    const client = useClient(options);
+    useEffect(() => {
+        if (objectID)
+            client.events.view(objectID);
+    }, [client, objectID]);
+}
+/** useProductView as a component that renders nothing, for pages that can't call hooks, such as a
+ * Next.js server component. */
+export function ProductView({ objectID, ...options }) {
+    useProductView(objectID, options);
+    return null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findlane/browser",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Findlane browser SDK: fast, typo-tolerant public search from the browser with an index's public ID, plus React hooks and components.",
   "keywords": ["findlane", "search", "full-text search", "typo tolerance", "instant search", "ecommerce search", "browser", "react", "autocomplete"],
   "license": "MIT",