@docsearch/js 4.6.2 → 5.0.0-beta.0

package/README.md

@@ -5,9 +5,7 @@ JavaScript package for [DocSearch](http://docsearch.algolia.com/), the best sear
 ## Installation
 
 ```sh
-yarn add @docsearch/js@4
-# or
-npm install @docsearch/js@4
+npm install @docsearch/js@5
 ```
 
 ## Get started
@@ -15,7 +13,7 @@ npm install @docsearch/js@4
 If you don’t want to use a package manager, you can use a standalone endpoint:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@4"></script>
+<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@5"></script>
 ```
 
 To get started, you need a [`container`](https://docsearch.algolia.com/docs/api#container) for your DocSearch component to go in. If you don’t have one already, you can insert one into your markup:
@@ -41,6 +39,41 @@ docsearch({
 });
 ```
 
+The default entry includes keyword search and Ask AI. Configure `askAi` or call `openAskAi()` on the returned instance when using Ask AI.
+
+## Keyword-only entry
+
+Use the `docsearch` subpath when your integration only needs keyword search. This entry excludes Ask AI code.
+
+```js app.js
+import docsearch from '@docsearch/js/docsearch';
+
+import '@docsearch/css';
+
+docsearch({
+  container: '#docsearch',
+  appId: 'YOUR_APP_ID',
+  indexName: 'YOUR_INDEX_NAME',
+  apiKey: 'YOUR_SEARCH_API_KEY',
+});
+```
+
+For a standalone keyword-only script, load the explicit UMD file:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@5/dist/umd/docsearch.js"></script>
+<script>
+  window.docsearch({
+    container: '#docsearch',
+    appId: 'YOUR_APP_ID',
+    indexName: 'YOUR_INDEX_NAME',
+    apiKey: 'YOUR_SEARCH_API_KEY',
+  });
+</script>
+```
+
+Both UMD entries expose callable `window.docsearch`. Load only one of them: the package default loads the AI-capable `dist/umd/index.js`, while `dist/umd/docsearch.js` is keyword-only.
+
 ## Documentation
 
 [Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3)

package/dist/esm/docsearch.d.ts

@@ -0,0 +1,36 @@
+/*! @docsearch/js 5.0.0-beta.0 (UNRELEASED 1b6607c) | MIT License | © Algolia, Inc. and contributors | https://docsearch.algolia.com */
+import { DocSearchProps as DocSearchProps$1 } from "@docsearch/react";
+import { InitialAskAiMessage } from "@docsearch/core";
+//#region ../../node_modules/.bun/preact@11.0.0-beta.0/node_modules/preact/src/index.d.ts
+import JSX = JSXInternal;
+//#endregion
+//#region src/createDocSearch.d.ts
+interface DocSearchInstance {
+  readonly isReady: boolean;
+  readonly isOpen: boolean;
+  open(): void;
+  close(): void;
+  openAskAi(initialMessage?: InitialAskAiMessage): void;
+  destroy(): void;
+}
+interface DocSearchCallbacks {
+  onReady?: () => void;
+  onOpen?: () => void;
+  onClose?: () => void;
+  interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
+}
+type DocSearchProps$2<TProps> = DocSearchCallbacks & Omit<TProps, 'onSidepanelClose' | 'onSidepanelOpen'> & {
+  container: HTMLElement | string;
+  environment?: typeof window;
+};
+declare const html: (strings: TemplateStringsArray, ...values: unknown[]) => JSX.Element;
+type TemplateHelpers = Record<string, unknown> & {
+  html: typeof html;
+};
+//#endregion
+//#region src/docsearchComponent.d.ts
+type DocSearchProps = DocSearchProps$2<DocSearchProps$1>;
+declare const docsearch: (allProps: DocSearchProps) => DocSearchInstance;
+//#endregion
+export { type DocSearchCallbacks, type DocSearchInstance, type DocSearchProps, type TemplateHelpers, docsearch as default };
+//# sourceMappingURL=docsearch.d.ts.map