first-commit

node_modules/@docsearch/css/README.md

@@ -0,0 +1,27 @@
+# @docsearch/css
+
+Style package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
+
+## Installation
+
+```bash
+yarn add @docsearch/css@3
+# or
+npm install @docsearch/css@3
+```
+
+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/css@3"></script>
+```
+
+## Get started
+
+```js
+import '@docsearch/css';
+```
+
+## Documentation
+
+[Read documentation →](https://docsearch.algolia.com/docs/styling)

node_modules/@docsearch/css/dist/_variables.css

@@ -0,0 +1,2 @@
+/*! @docsearch/css Variables 3.8.2 | MIT License | © Algolia, Inc. and contributors | https://docsearch.algolia.com */
+:root{--docsearch-primary-color:#5468ff;--docsearch-text-color:#1c1e21;--docsearch-spacing:12px;--docsearch-icon-stroke-width:1.4;--docsearch-highlight-color:var(--docsearch-primary-color);--docsearch-muted-color:#969faf;--docsearch-container-background:rgba(101,108,133,.8);--docsearch-logo-color:#5468ff;--docsearch-modal-width:560px;--docsearch-modal-height:600px;--docsearch-modal-background:#f5f6f7;--docsearch-modal-shadow:inset 1px 1px 0 0 hsla(0,0%,100%,.5),0 3px 8px 0 #555a64;--docsearch-searchbox-height:56px;--docsearch-searchbox-background:#ebedf0;--docsearch-searchbox-focus-background:#fff;--docsearch-searchbox-shadow:inset 0 0 0 2px var(--docsearch-primary-color);--docsearch-hit-height:56px;--docsearch-hit-color:#444950;--docsearch-hit-active-color:#fff;--docsearch-hit-background:#fff;--docsearch-hit-shadow:0 1px 3px 0 #d4d9e1;--docsearch-key-gradient:linear-gradient(-225deg,#d5dbe4,#f8f8f8);--docsearch-key-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 2px 1px rgba(30,35,90,.4);--docsearch-key-pressed-shadow:inset 0 -2px 0 0 #cdcde6,inset 0 0 1px 1px #fff,0 1px 1px 0 rgba(30,35,90,.4);--docsearch-footer-height:44px;--docsearch-footer-background:#fff;--docsearch-footer-shadow:0 -1px 0 0 #e0e3e8,0 -3px 6px 0 rgba(69,98,155,.12)}html[data-theme=dark]{--docsearch-text-color:#f5f6f7;--docsearch-container-background:rgba(9,10,17,.8);--docsearch-modal-background:#15172a;--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40,0 3px 8px 0 #000309;--docsearch-searchbox-background:#090a11;--docsearch-searchbox-focus-background:#000;--docsearch-hit-color:#bec3c9;--docsearch-hit-shadow:none;--docsearch-hit-background:#090a11;--docsearch-key-gradient:linear-gradient(-26.5deg,#565872,#31355b);--docsearch-key-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 2px 2px 0 rgba(3,4,9,.3);--docsearch-key-pressed-shadow:inset 0 -2px 0 0 #282d55,inset 0 0 1px 1px #51577d,0 1px 1px 0 #0304094d;--docsearch-footer-background:#1e2136;--docsearch-footer-shadow:inset 0 1px 0 0 rgba(73,76,106,.5),0 -4px 8px 0 rgba(0,0,0,.2);--docsearch-logo-color:#fff;--docsearch-muted-color:#7f8497}

node_modules/@docsearch/css/dist/button.css

@@ -0,0 +1,2 @@
+/*! @docsearch/css Button 3.8.2 | MIT License | © Algolia, Inc. and contributors | https://docsearch.algolia.com */
+.DocSearch-Button{align-items:center;background:var(--docsearch-searchbox-background);border:0;border-radius:40px;color:var(--docsearch-muted-color);cursor:pointer;display:flex;font-weight:500;height:36px;justify-content:space-between;margin:0 0 0 16px;padding:0 8px;user-select:none}.DocSearch-Button:active,.DocSearch-Button:focus,.DocSearch-Button:hover{background:var(--docsearch-searchbox-focus-background);box-shadow:var(--docsearch-searchbox-shadow);color:var(--docsearch-text-color);outline:none}.DocSearch-Button-Container{align-items:center;display:flex}.DocSearch-Search-Icon{stroke-width:1.6}.DocSearch-Button .DocSearch-Search-Icon{color:var(--docsearch-text-color)}.DocSearch-Button-Placeholder{font-size:1rem;padding:0 12px 0 6px}.DocSearch-Button-Keys{display:flex;min-width:calc(40px + .8em)}.DocSearch-Button-Key{align-items:center;background:var(--docsearch-key-gradient);border:0;border-radius:3px;box-shadow:var(--docsearch-key-shadow);color:var(--docsearch-muted-color);display:flex;height:18px;justify-content:center;margin-right:.4em;padding:0 0 2px;position:relative;top:-1px;width:20px}.DocSearch-Button-Key--pressed{box-shadow:var(--docsearch-key-pressed-shadow);transform:translate3d(0,1px,0)}@media (max-width:768px){.DocSearch-Button-Keys,.DocSearch-Button-Placeholder{display:none}}

node_modules/@docsearch/css/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@docsearch/css",
+  "description": "Styles for DocSearch.",
+  "version": "3.8.2",
+  "license": "MIT",
+  "homepage": "https://docsearch.algolia.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/docsearch.git",
+    "directory": "packages/docsearch-css"
+  },
+  "author": {
+    "name": "Algolia, Inc.",
+    "url": "https://www.algolia.com"
+  },
+  "files": [
+    "dist/"
+  ],
+  "main": "dist/style.css",
+  "unpkg": "dist/style.css",
+  "jsdelivr": "dist/style.css",
+  "scripts": {
+    "build:clean": "rm -rf ./dist",
+    "build:css": "node build-css.js",
+    "build": "yarn build:clean && mkdir dist && yarn build:css",
+    "watch": "watch \"yarn build:css\" --ignoreDirectoryPattern \"/dist/\""
+  }
+}

node_modules/@docsearch/js/README.md

@@ -0,0 +1,46 @@
+# @docsearch/js
+
+JavaScript package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
+
+## Installation
+
+```sh
+yarn add @docsearch/js@3
+# or
+npm install @docsearch/js@3
+```
+
+## Get started
+
+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@3"></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:
+
+```html
+<div id="docsearch"></div>
+```
+
+Then, insert DocSearch into it by calling the [`docsearch`](https://docsearch.algolia.com/docs/api) function and providing the container. It can be a [CSS selector](https://developer.mozilla.org/en-us/docs/web/css/css_selectors) or an [Element](https://developer.mozilla.org/en-us/docs/web/api/htmlelement).
+
+Make sure to provide a [`container`](https://docsearch.algolia.com/docs/api#container) (for example, a `div`), not an `input`. DocSearch generates a fully accessible search box for you.
+
+```js app.js
+import docsearch from '@docsearch/js';
+
+import '@docsearch/css';
+
+docsearch({
+  container: '#docsearch',
+  appId: 'YOUR_APP_ID',
+  indexName: 'YOUR_INDEX_NAME',
+  apiKey: 'YOUR_SEARCH_API_KEY',
+});
+```
+
+## Documentation
+
+[Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3)

node_modules/@docsearch/js/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+import { DocSearchProps as DocSearchProps$1 } from '@docsearch/react';
+
+interface DocSearchProps extends DocSearchProps$1 {
+    container: HTMLElement | string;
+    environment?: typeof window;
+}
+declare function docsearch(props: DocSearchProps): void;
+
+export { docsearch as default };

node_modules/@docsearch/js/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@docsearch/js",
+  "description": "JavaScript package for DocSearch, the best search experience for docs.",
+  "version": "3.8.2",
+  "license": "MIT",
+  "homepage": "https://docsearch.algolia.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/docsearch.git",
+    "directory": "packages/docsearch-js"
+  },
+  "author": {
+    "name": "Algolia, Inc.",
+    "url": "https://www.algolia.com"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
+  "source": "src/index.ts",
+  "types": "dist/esm/index.d.ts",
+  "module": "dist/esm/index.js",
+  "main": "dist/umd/index.js",
+  "umd:main": "dist/umd/index.js",
+  "unpkg": "dist/umd/index.js",
+  "jsdelivr": "dist/umd/index.js",
+  "scripts": {
+    "build:clean": "rm -rf ./dist",
+    "build:types": "tsc -p ./tsconfig.declaration.json --outDir ./dist/esm/types",
+    "build:clean-types": "rm -rf ./dist/esm/types",
+    "build": "yarn build:clean && yarn build:types && rollup --config --bundleConfigAsCjs && yarn build:clean-types",
+    "on:change": "yarn build",
+    "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
+  },
+  "dependencies": {
+    "@docsearch/react": "3.8.2",
+    "preact": "^10.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-replace": "6.0.1"
+  }
+}

node_modules/@docsearch/react/README.md

@@ -0,0 +1,43 @@
+# @docsearch/react
+
+React package for [DocSearch](http://docsearch.algolia.com/), the best search experience for docs.
+
+## Installation
+
+```bash
+yarn add @docsearch/react@3
+# or
+npm install @docsearch/react@3
+```
+
+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/react@3"></script>
+```
+
+## Get started
+
+DocSearch generates a fully accessible search box for you.
+
+```jsx App.js
+import { DocSearch } from '@docsearch/react';
+
+import '@docsearch/css';
+
+function App() {
+  return (
+    <DocSearch
+      appId="YOUR_APP_ID"
+      indexName="YOUR_INDEX_NAME"
+      apiKey="YOUR_SEARCH_API_KEY"
+    />
+  );
+}
+
+export default App;
+```
+
+## Documentation
+
+[Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3)

node_modules/@docsearch/react/button.js

@@ -0,0 +1 @@
+export { DocSearchButton } from './dist/esm';

node_modules/@docsearch/react/dist/esm/index.d.ts

@@ -0,0 +1,208 @@
+import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
+import { LiteClient, SearchParamsObject } from 'algoliasearch/lite';
+import React from 'react';
+
+type ContentType = 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
+interface DocSearchHitAttributeHighlightResult {
+    value: string;
+    matchLevel: 'full' | 'none' | 'partial';
+    matchedWords: string[];
+    fullyHighlighted?: boolean;
+}
+interface DocSearchHitHighlightResultHierarchy {
+    lvl0: DocSearchHitAttributeHighlightResult;
+    lvl1: DocSearchHitAttributeHighlightResult;
+    lvl2: DocSearchHitAttributeHighlightResult;
+    lvl3: DocSearchHitAttributeHighlightResult;
+    lvl4: DocSearchHitAttributeHighlightResult;
+    lvl5: DocSearchHitAttributeHighlightResult;
+    lvl6: DocSearchHitAttributeHighlightResult;
+}
+interface DocSearchHitHighlightResult {
+    content: DocSearchHitAttributeHighlightResult;
+    hierarchy: DocSearchHitHighlightResultHierarchy;
+    hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
+}
+interface DocSearchHitAttributeSnippetResult {
+    value: string;
+    matchLevel: 'full' | 'none' | 'partial';
+}
+interface DocSearchHitSnippetResult {
+    content: DocSearchHitAttributeSnippetResult;
+    hierarchy: DocSearchHitHighlightResultHierarchy;
+    hierarchy_camel: DocSearchHitHighlightResultHierarchy[];
+}
+declare type DocSearchHit = {
+    objectID: string;
+    content: string | null;
+    url: string;
+    url_without_anchor: string;
+    type: ContentType;
+    anchor: string | null;
+    hierarchy: {
+        lvl0: string;
+        lvl1: string;
+        lvl2: string | null;
+        lvl3: string | null;
+        lvl4: string | null;
+        lvl5: string | null;
+        lvl6: string | null;
+    };
+    _highlightResult: DocSearchHitHighlightResult;
+    _snippetResult: DocSearchHitSnippetResult;
+    _rankingInfo?: {
+        promoted: boolean;
+        nbTypos: number;
+        firstMatchedWord: number;
+        proximityDistance?: number;
+        geoDistance: number;
+        geoPrecision?: number;
+        nbExactWords: number;
+        words: number;
+        filters: number;
+        userScore: number;
+        matchedGeoLocation?: {
+            lat: number;
+            lng: number;
+            distance: number;
+        };
+    };
+    _distinctSeqID?: number;
+    __autocomplete_indexName?: string;
+    __autocomplete_queryID?: string;
+    __autocomplete_algoliaCredentials?: {
+        appId: string;
+        apiKey: string;
+    };
+    __autocomplete_id?: number;
+};
+
+interface DocSearchContext extends AutocompleteContext {
+    algoliaInsightsPlugin?: {
+        insights: AutocompleteInsightsApi;
+    };
+}
+interface DocSearchState<TItem extends BaseItem> extends AutocompleteState<TItem> {
+    context: DocSearchContext;
+}
+
+type InternalDocSearchHit = DocSearchHit & {
+    __docsearch_parent: InternalDocSearchHit | null;
+};
+
+type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
+
+type DocSearchTranslations = Partial<{
+    button: ButtonTranslations;
+    modal: ModalTranslations;
+}>;
+type DocSearchTransformClient = {
+    search: LiteClient['search'];
+    addAlgoliaAgent: LiteClient['addAlgoliaAgent'];
+    transporter: Pick<LiteClient['transporter'], 'algoliaAgent'>;
+};
+interface DocSearchProps {
+    appId: string;
+    apiKey: string;
+    indexName: string;
+    placeholder?: string;
+    searchParameters?: SearchParamsObject;
+    maxResultsPerGroup?: number;
+    transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
+    hitComponent?: (props: {
+        hit: InternalDocSearchHit | StoredDocSearchHit;
+        children: React.ReactNode;
+    }) => JSX.Element;
+    resultsFooterComponent?: (props: {
+        state: AutocompleteState<InternalDocSearchHit>;
+    }) => JSX.Element | null;
+    transformSearchClient?: (searchClient: DocSearchTransformClient) => DocSearchTransformClient;
+    disableUserPersonalization?: boolean;
+    initialQuery?: string;
+    navigator?: AutocompleteOptions<InternalDocSearchHit>['navigator'];
+    translations?: DocSearchTranslations;
+    getMissingResultsUrl?: ({ query }: {
+        query: string;
+    }) => string;
+    insights?: AutocompleteOptions<InternalDocSearchHit>['insights'];
+}
+declare function DocSearch(props: DocSearchProps): JSX.Element;
+
+type ButtonTranslations = Partial<{
+    buttonText: string;
+    buttonAriaLabel: string;
+}>;
+type DocSearchButtonProps = React.ComponentProps<'button'> & {
+    translations?: ButtonTranslations;
+};
+declare const DocSearchButton: React.ForwardRefExoticComponent<Omit<DocSearchButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
+
+type FooterTranslations = Partial<{
+    selectText: string;
+    selectKeyAriaLabel: string;
+    navigateText: string;
+    navigateUpKeyAriaLabel: string;
+    navigateDownKeyAriaLabel: string;
+    closeText: string;
+    closeKeyAriaLabel: string;
+    searchByText: string;
+}>;
+
+type ErrorScreenTranslations = Partial<{
+    titleText: string;
+    helpText: string;
+}>;
+
+type NoResultsScreenTranslations = Partial<{
+    noResultsText: string;
+    suggestedQueryText: string;
+    reportMissingResultsText: string;
+    reportMissingResultsLinkText: string;
+}>;
+
+type StartScreenTranslations = Partial<{
+    recentSearchesTitle: string;
+    noRecentSearchesText: string;
+    saveRecentSearchButtonTitle: string;
+    removeRecentSearchButtonTitle: string;
+    favoriteSearchesTitle: string;
+    removeFavoriteSearchButtonTitle: string;
+}>;
+
+type ScreenStateTranslations = Partial<{
+    errorScreen: ErrorScreenTranslations;
+    startScreen: StartScreenTranslations;
+    noResultsScreen: NoResultsScreenTranslations;
+}>;
+
+type SearchBoxTranslations = Partial<{
+    resetButtonTitle: string;
+    resetButtonAriaLabel: string;
+    cancelButtonText: string;
+    cancelButtonAriaLabel: string;
+    searchInputLabel: string;
+}>;
+
+type ModalTranslations = Partial<{
+    searchBox: SearchBoxTranslations;
+    footer: FooterTranslations;
+}> & ScreenStateTranslations;
+type DocSearchModalProps = DocSearchProps & {
+    initialScrollY: number;
+    onClose?: () => void;
+    translations?: ModalTranslations;
+};
+declare function DocSearchModal({ appId, apiKey, indexName, placeholder, searchParameters, maxResultsPerGroup, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, }: DocSearchModalProps): JSX.Element;
+
+interface UseDocSearchKeyboardEventsProps {
+    isOpen: boolean;
+    onOpen: () => void;
+    onClose: () => void;
+    onInput?: (event: KeyboardEvent) => void;
+    searchButtonRef?: React.RefObject<HTMLButtonElement>;
+}
+declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
+
+declare const version = "3.8.2";
+
+export { type ButtonTranslations, DocSearch, DocSearchButton, type DocSearchButtonProps, type DocSearchHit, DocSearchModal, type DocSearchModalProps, type DocSearchProps, type DocSearchState, type DocSearchTransformClient, type DocSearchTranslations, type InternalDocSearchHit, type ModalTranslations, type StoredDocSearchHit, type UseDocSearchKeyboardEventsProps, useDocSearchKeyboardEvents, version };

node_modules/@docsearch/react/modal.js

@@ -0,0 +1 @@
+export { DocSearchModal } from './dist/esm';

node_modules/@docsearch/react/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@docsearch/react",
+  "description": "React package for DocSearch, the best search experience for docs.",
+  "version": "3.8.2",
+  "license": "MIT",
+  "homepage": "https://docsearch.algolia.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/algolia/docsearch.git",
+    "directory": "packages/docsearch-react"
+  },
+  "author": {
+    "name": "Algolia, Inc.",
+    "url": "https://www.algolia.com"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/",
+    "style/",
+    "button.js",
+    "modal.js"
+  ],
+  "source": "src/index.ts",
+  "types": "dist/esm/index.d.ts",
+  "module": "dist/esm/index.js",
+  "main": "dist/umd/index.js",
+  "umd:main": "dist/umd/index.js",
+  "unpkg": "dist/umd/index.js",
+  "jsdelivr": "dist/umd/index.js",
+  "scripts": {
+    "build:clean": "rm -rf ./dist",
+    "build:clean-types": "rm -rf ./dist/esm/types",
+    "build:types": "tsc -p ./tsconfig.declaration.json --outDir ./dist/esm/types",
+    "build": "yarn build:clean && yarn build:types && rollup --config --bundleConfigAsCjs && yarn build:clean-types",
+    "on:change": "yarn build",
+    "watch": "watch \"yarn on:change\" --ignoreDirectoryPattern \"/dist/\""
+  },
+  "dependencies": {
+    "@algolia/autocomplete-core": "1.17.7",
+    "@algolia/autocomplete-preset-algolia": "1.17.7",
+    "@docsearch/css": "3.8.2",
+    "algoliasearch": "^5.14.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-replace": "6.0.1",
+    "@testing-library/jest-dom": "6.6.3",
+    "@testing-library/react": "16.0.1",
+    "vitest": "2.1.5"
+  },
+  "peerDependencies": {
+    "@types/react": ">= 16.8.0 < 19.0.0",
+    "react": ">= 16.8.0 < 19.0.0",
+    "react-dom": ">= 16.8.0 < 19.0.0",
+    "search-insights": ">= 1 < 3"
+  },
+  "peerDependenciesMeta": {
+    "@types/react": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    },
+    "search-insights": {
+      "optional": true
+    }
+  }
+}

node_modules/@docsearch/react/style/button.js

@@ -0,0 +1 @@
+export * from '@docsearch/css/dist/button.css';

node_modules/@docsearch/react/style/index.js

@@ -0,0 +1 @@
+export * from '@docsearch/css';

node_modules/@docsearch/react/style/modal.js

@@ -0,0 +1 @@
+export * from '@docsearch/css/dist/modal.css';

node_modules/@docsearch/react/style/variables.js

@@ -0,0 +1 @@
+export * from '@docsearch/css/dist/_variables.css';