@brillout/docpress 0.7.2 → 0.7.4

package/+config.ts

@@ -1,4 +1,4 @@
-import type { Config } from 'vike/types'
+import type { Config, ImportString } from 'vike/types'
 import type { Exports } from './config/resolvePageContext'
 
 export default {
@@ -7,6 +7,7 @@ export default {
   onRenderHtml: 'import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml',
   onRenderClient: 'import:@brillout/docpress/renderer/onRenderClient:onRenderClient',
   onBeforeRender: 'import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender',
+  Layout: 'import:@brillout/docpress/Layout:Layout',
   clientRouting: true,
   hydrationCanBeAborted: true,
   passToClient: ['pageContextResolved'],
@@ -14,6 +15,13 @@ export default {
     NavHeader: {
       env: { client: true, server: true },
     },
+    Layout: {
+      env: { client: true, server: true },
+    },
+  },
+  prefetch: {
+    staticAssets: 'hover',
+    pageContext: Infinity,
   },
 } satisfies Config
 
@@ -25,6 +33,7 @@ declare global {
       exports: Exports
     }
     interface Config {
+      Layout: ReactComponent | ImportString
       NavHeader?: {
         NavHeader: ReactComponent
         navHeaderWrapperStyle?: React.CSSProperties

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2020-present Romuald Brillout
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/{PageLayout.css → Layout.css}

@@ -40,3 +40,24 @@
     --main-view-padding: 10px;
   }
 }
+
+
+/* === noSideNavigation === */
+.page-layout:not(.noSideNavigation) #top-navigation {
+  display: none !important;
+}
+@media screen and (max-width: 1139px) {
+  #top-navigation {
+    display: none !important;
+  }
+}
+@media screen and (min-width: 1140px) {
+  html:not(.navigation-fullscreen) .page-layout.noSideNavigation #navigation-wrapper,
+  html:not(.navigation-fullscreen) .page-layout.noSideNavigation #navigation-fullscreen-button {
+    display: none !important;
+  }
+  .noSideNavigation .page-wrapper {
+    /* Maybe we can remove this after we remove the vertical fullscreen navigation toggler? */
+    margin-left: 0 !important;
+  }
+}

package/Layout.tsx

@@ -0,0 +1,92 @@
+export { Layout }
+
+import React from 'react'
+import { Navigation, NavigationMask } from './navigation/Navigation'
+import { MobileHeader } from './MobileHeader'
+import { EditPageNote } from './components/EditPageNote'
+import './Layout.css'
+import { NavigationFullscreenButton } from './navigation/navigation-fullscreen/NavigationFullscreenButton'
+import { parseTitle } from './parseTitle'
+import { usePageContext, usePageContext2 } from './renderer/usePageContext'
+import { Links } from './navigation/NavigationHeader'
+
+function Layout({ children }: { children: React.ReactNode }) {
+  const pageContext = usePageContext()
+  const pageContext2 = usePageContext2()
+  const { isLandingPage, pageTitle, navigationData, noSideNavigation, topNavigationList } = pageContext
+  const pageTitleParsed = pageTitle && parseTitle(pageTitle)
+  const { globalNote } = pageContext.config
+  const { NavHeader } = pageContext2.config.NavHeader!
+  return (
+    <>
+      {noSideNavigation && (
+        <div
+          id="top-navigation"
+          style={{
+            position: 'relative',
+            display: 'flex',
+            color: 'inherit',
+            alignItems: 'center',
+            justifyContent: 'space-between',
+            textDecoration: 'none',
+            maxWidth: 1024,
+            margin: 'auto',
+          }}
+        >
+          <a href="/" style={{ display: 'flex', alignItems: 'center', color: 'inherit' }}>
+            <NavHeader />
+          </a>
+          <div style={{ display: 'flex', alignItems: 'center' }}>
+            <TopNavigationLink id="doclink">Documentation</TopNavigationLink>
+            {topNavigationList.map(({ title, url }) => (
+              <TopNavigationLink href={url!} key={url}>
+                {title}
+              </TopNavigationLink>
+            ))}
+            <Links style={{ display: 'inline-flex', marginLeft: 10 }} />
+          </div>
+        </div>
+      )}
+      <div
+        className={['page-layout', isLandingPage ? 'landing-page' : 'doc-page', noSideNavigation && 'noSideNavigation']
+          .filter(Boolean)
+          .join(' ')}
+      >
+        <div id="navigation-wrapper">
+          <Navigation {...pageContext.navigationData} />
+        </div>
+        <NavigationFullscreenButton />
+        <div className="page-wrapper">
+          <div className="page-container">
+            <MobileHeader />
+            <div className="page-content">
+              {globalNote}
+              {pageTitleParsed && <h1 id={`${navigationData.currentUrl.replace('/', '')}`}>{pageTitleParsed}</h1>}
+              {children}
+              {!isLandingPage && <EditPageNote pageContext={pageContext} />}
+            </div>
+          </div>
+          <NavigationMask />
+        </div>
+      </div>
+    </>
+  )
+}
+
+function TopNavigationLink(props: React.AnchorHTMLAttributes<HTMLAnchorElement>) {
+  return (
+    <a
+      style={{
+        height: '100%',
+        display: 'inline-flex',
+        alignItems: 'center',
+        justifyContent: 'center',
+        padding: '20px 10px',
+        cursor: 'pointer',
+        color: '#666',
+        fontSize: '1.06em',
+      }}
+      {...props}
+    />
+  )
+}

package/algolia/DocSearch.css

@@ -14,9 +14,7 @@
 }
 .DocSearch-Button {
   background: transparent !important;
-  padding: 0 !important;
-  position: relative;
-  top: -1px;
+  padding: 3px !important;
   outline: none !important;
   border: none !important;
   box-shadow: none !important;
@@ -26,6 +24,5 @@
   width: 21px !important;
 }
 .DocSearch-Button {
-  margin-right: 3px !important;
-  margin-left: 1px !important;
+  margin: 0 !important;
 }

package/components/Algolia/Hit.tsx

@@ -0,0 +1,67 @@
+export { Hit }
+
+import React from 'react'
+import { DocSearch } from '@docsearch/react'
+import type { InternalDocSearchHit } from './types'
+import { Snippet } from './Snippet'
+import { SourceIcon } from './SourceIcon'
+import { SelectIcon } from './SelectIcon'
+
+type HitProps = Parameters<typeof DocSearch>[0]['hitComponent']
+type ContentType = 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6'
+
+const Hit: HitProps = ({ hit }) => {
+  return (
+    <a href={hit.url}>
+      <div className="DocSearch-Hit-Container">
+        {(hit as InternalDocSearchHit).__docsearch_parent && (
+          <svg className="DocSearch-Hit-Tree" viewBox="0 0 24 54">
+            <g stroke="currentColor" fill="none" fillRule="evenodd" strokeLinecap="round" strokeLinejoin="round">
+              {!(hit as InternalDocSearchHit).__docsearch_parent ? (
+                <path d="M8 6v21M20 27H8.3" />
+              ) : (
+                <path d="M8 6v42M20 27H8.3" />
+              )}
+            </g>
+          </svg>
+        )}
+
+        <div className="DocSearch-Hit-icon">
+          <SourceIcon type={hit.type} />
+        </div>
+        {hit.hierarchy[hit.type as ContentType] && hit.type === 'lvl1' && (
+          <div className="DocSearch-Hit-content-wrapper">
+            <Snippet className="DocSearch-Hit-title" hit={hit} attribute="hierarchy.lvl1" />
+            {hit.content && <Snippet className="DocSearch-Hit-path" hit={hit} attribute="content" />}
+          </div>
+        )}
+
+        {hit.hierarchy[hit.type as ContentType] &&
+          (hit.type === 'lvl2' ||
+            hit.type === 'lvl3' ||
+            hit.type === 'lvl4' ||
+            hit.type === 'lvl5' ||
+            hit.type === 'lvl6') && (
+            <div className="DocSearch-Hit-content-wrapper">
+              <Snippet className="DocSearch-Hit-title" hit={hit} attribute={`hierarchy.${hit.type}`} />
+              <Snippet
+                className="DocSearch-Hit-path"
+                hit={hit}
+                attribute={hit.content ? 'content' : 'hierarchy.lvl1'}
+              />
+            </div>
+          )}
+
+        {hit.type === 'content' && (
+          <div className="DocSearch-Hit-content-wrapper">
+            <Snippet className="DocSearch-Hit-title" hit={hit} attribute="content" />
+            <Snippet className="DocSearch-Hit-path" hit={hit} attribute="hierarchy.lvl1" />
+          </div>
+        )}
+        <div className="DocSearch-Hit-action">
+          <SelectIcon />
+        </div>
+      </div>
+    </a>
+  )
+}

package/components/Algolia/README.md

@@ -0,0 +1,21 @@
+# Components: Algolia
+
+## Overview
+
+This directory contains a custom components for integrating Algolia's search functionality into our application. The components here are tailored to meet our specific requirements, ensuring a seamless user experience.
+
+## Creation Process
+
+The `components/Algolia/` directory was created to address our need for a custom search implementation using Algolia Docsearch. Here’s a brief overview of how this directory was created:
+
+1. **Source Files**: 
+  We sourced most of the files from [Algolia's DocSearch repository](https://github.com/algolia/docsearch/tree/9733ba9a503e18a27d5fef3470fde8b3bb54ec79/packages/docsearch-react/src), specifically extracting the base for our `<Hit>` component from their [Results.tsx](https://github.com/algolia/docsearch/blob/9733ba9a503e18a27d5fef3470fde8b3bb54ec79/packages/docsearch-react/src/Results.tsx#L113-L169) file, which includes the core rendering logic and styles.
+
+1. **Customization**: 
+   - The components were modified to fit our needs. This included changing specific functionalities and adapting styles to match our application's design.
+   - Most notably, we created a custom `<Hit>` component to tailor the display of search results.
+
+2. **Removal of Unused Code**: We eliminated unnecessary parts of the original codebase that were not required and were incompatible with our implementation.
+
+3. **Minor adaptation**:
+   - While copying the original source code, we encountered issues with types that were not exported, requiring additional modifications to the components to ensure compatibility.

package/components/Algolia/SelectIcon.tsx

@@ -0,0 +1,12 @@
+import React from 'react'
+
+export function SelectIcon() {
+  return (
+    <svg className="DocSearch-Hit-Select-Icon" width="20" height="20" viewBox="0 0 20 20">
+      <g stroke="currentColor" fill="none" fillRule="evenodd" strokeLinecap="round" strokeLinejoin="round">
+        <path d="M18 3v4c0 2-2 4-4 4H2" />
+        <path d="M8 17l-6-6 6-6" />
+      </g>
+    </svg>
+  )
+}

package/components/Algolia/Snippet.tsx

@@ -0,0 +1,32 @@
+import { createElement } from 'react'
+import { StoredDocSearchHit } from './types'
+
+function getPropertyByPath(object: Record<string, any>, path: string): any {
+  const parts = path.split('.')
+
+  return parts.reduce((prev, current) => {
+    if (prev?.[current]) return prev[current]
+    return null
+  }, object)
+}
+
+interface SnippetProps<TItem> {
+  hit: TItem
+  attribute: string
+  tagName?: string
+  [prop: string]: unknown
+}
+
+export function Snippet<TItem extends StoredDocSearchHit>({
+  hit,
+  attribute,
+  tagName = 'span',
+  ...rest
+}: SnippetProps<TItem>) {
+  return createElement(tagName, {
+    ...rest,
+    dangerouslySetInnerHTML: {
+      __html: getPropertyByPath(hit, `_snippetResult.${attribute}.value`) || getPropertyByPath(hit, attribute),
+    },
+  })
+}

package/components/Algolia/SourceIcon.tsx

@@ -0,0 +1,55 @@
+import React from 'react'
+
+const LvlIcon: React.FC = () => {
+  return (
+    <svg width="20" height="20" viewBox="0 0 20 20">
+      <path
+        d="M17 6v12c0 .52-.2 1-1 1H4c-.7 0-1-.33-1-1V2c0-.55.42-1 1-1h8l5 5zM14 8h-3.13c-.51 0-.87-.34-.87-.87V4"
+        stroke="currentColor"
+        fill="none"
+        fillRule="evenodd"
+        strokeLinejoin="round"
+      />
+    </svg>
+  )
+}
+
+export function SourceIcon(props: { type: string }) {
+  switch (props.type) {
+    case 'lvl1':
+      return <LvlIcon />
+    case 'content':
+      return <ContentIcon />
+    default:
+      return <AnchorIcon />
+  }
+}
+
+function AnchorIcon() {
+  return (
+    <svg width="20" height="20" viewBox="0 0 20 20">
+      <path
+        d="M13 13h4-4V8H7v5h6v4-4H7V8H3h4V3v5h6V3v5h4-4v5zm-6 0v4-4H3h4z"
+        stroke="currentColor"
+        fill="none"
+        fillRule="evenodd"
+        strokeLinecap="round"
+        strokeLinejoin="round"
+      />
+    </svg>
+  )
+}
+
+function ContentIcon() {
+  return (
+    <svg width="20" height="20" viewBox="0 0 20 20">
+      <path
+        d="M17 5H3h14zm0 5H3h14zm0 5H3h14z"
+        stroke="currentColor"
+        fill="none"
+        fillRule="evenodd"
+        strokeLinejoin="round"
+      />
+    </svg>
+  )
+}

package/components/Algolia/types.ts

@@ -0,0 +1,86 @@
+export type InternalDocSearchHit = DocSearchHit & {
+  __docsearch_parent: InternalDocSearchHit | null
+}
+
+export type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>
+
+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[]
+}
+
+export 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
+}

package/config/resolveHeadingsData.ts

@@ -79,12 +79,18 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
     }
   }
 
+  const topNavigationList = headingsResolved
+    .filter((heading) => heading.topNavigation)
+    .map((h) => ({ title: typeof h.topNavigation === 'string' ? h.topNavigation : h.title, url: h.url }))
+
   const pageContextAddendum = {
     navigationData,
     linksAll,
     isLandingPage,
     pageTitle,
     documentTitle,
+    noSideNavigation: activeHeading.noSideNavigation,
+    topNavigationList,
   }
   return pageContextAddendum
 }
@@ -166,10 +172,12 @@ function getActiveHeading(
     throw new Error(
       [
         `URL ${pc.bold(urlPathname)} not found in following URLs:`,
-        ...headingsResolved
-          .map((h) => `  ${h.url}`)
+        [...headingsResolved, ...headingsDetachedResolved]
           .filter(Boolean)
-          .sort(),
+          .map((h) => h.url)
+          .sort()
+          .map((url) => `  ${url}`)
+          .join('\n'),
       ].join('\n'),
     )
   }

package/dist/+config.d.ts

@@ -1,9 +1,11 @@
+import type { ImportString } from 'vike/types';
 import type { Exports } from './config/resolvePageContext';
 declare const _default: {
     name: string;
     onRenderHtml: "import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml";
     onRenderClient: "import:@brillout/docpress/renderer/onRenderClient:onRenderClient";
     onBeforeRender: "import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender";
+    Layout: "import:@brillout/docpress/Layout:Layout";
     clientRouting: true;
     hydrationCanBeAborted: true;
     passToClient: string[];
@@ -14,6 +16,16 @@ declare const _default: {
                 server: true;
             };
         };
+        Layout: {
+            env: {
+                client: true;
+                server: true;
+            };
+        };
+    };
+    prefetch: {
+        staticAssets: "hover";
+        pageContext: number;
     };
 };
 export default _default;
@@ -25,6 +37,7 @@ declare global {
             exports: Exports;
         }
         interface Config {
+            Layout: ReactComponent | ImportString;
             NavHeader?: {
                 NavHeader: ReactComponent;
                 navHeaderWrapperStyle?: React.CSSProperties;

package/dist/+config.js

@@ -4,6 +4,7 @@ export default {
     onRenderHtml: 'import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml',
     onRenderClient: 'import:@brillout/docpress/renderer/onRenderClient:onRenderClient',
     onBeforeRender: 'import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender',
+    Layout: 'import:@brillout/docpress/Layout:Layout',
     clientRouting: true,
     hydrationCanBeAborted: true,
     passToClient: ['pageContextResolved'],
@@ -11,5 +12,12 @@ export default {
         NavHeader: {
             env: { client: true, server: true },
         },
+        Layout: {
+            env: { client: true, server: true },
+        },
+    },
+    prefetch: {
+        staticAssets: 'hover',
+        pageContext: Infinity,
     },
 };

package/dist/components/Algolia/Hit.d.ts

@@ -0,0 +1,4 @@
+export { Hit };
+import { DocSearch } from '@docsearch/react';
+type HitProps = Parameters<typeof DocSearch>[0]['hitComponent'];
+declare const Hit: HitProps;

package/dist/components/Algolia/Hit.js

@@ -0,0 +1,30 @@
+export { Hit };
+import React from 'react';
+import { Snippet } from './Snippet';
+import { SourceIcon } from './SourceIcon';
+import { SelectIcon } from './SelectIcon';
+var Hit = function (_a) {
+    var hit = _a.hit;
+    return (React.createElement("a", { href: hit.url },
+        React.createElement("div", { className: "DocSearch-Hit-Container" },
+            hit.__docsearch_parent && (React.createElement("svg", { className: "DocSearch-Hit-Tree", viewBox: "0 0 24 54" },
+                React.createElement("g", { stroke: "currentColor", fill: "none", fillRule: "evenodd", strokeLinecap: "round", strokeLinejoin: "round" }, !hit.__docsearch_parent ? (React.createElement("path", { d: "M8 6v21M20 27H8.3" })) : (React.createElement("path", { d: "M8 6v42M20 27H8.3" }))))),
+            React.createElement("div", { className: "DocSearch-Hit-icon" },
+                React.createElement(SourceIcon, { type: hit.type })),
+            hit.hierarchy[hit.type] && hit.type === 'lvl1' && (React.createElement("div", { className: "DocSearch-Hit-content-wrapper" },
+                React.createElement(Snippet, { className: "DocSearch-Hit-title", hit: hit, attribute: "hierarchy.lvl1" }),
+                hit.content && React.createElement(Snippet, { className: "DocSearch-Hit-path", hit: hit, attribute: "content" }))),
+            hit.hierarchy[hit.type] &&
+                (hit.type === 'lvl2' ||
+                    hit.type === 'lvl3' ||
+                    hit.type === 'lvl4' ||
+                    hit.type === 'lvl5' ||
+                    hit.type === 'lvl6') && (React.createElement("div", { className: "DocSearch-Hit-content-wrapper" },
+                React.createElement(Snippet, { className: "DocSearch-Hit-title", hit: hit, attribute: "hierarchy.".concat(hit.type) }),
+                React.createElement(Snippet, { className: "DocSearch-Hit-path", hit: hit, attribute: hit.content ? 'content' : 'hierarchy.lvl1' }))),
+            hit.type === 'content' && (React.createElement("div", { className: "DocSearch-Hit-content-wrapper" },
+                React.createElement(Snippet, { className: "DocSearch-Hit-title", hit: hit, attribute: "content" }),
+                React.createElement(Snippet, { className: "DocSearch-Hit-path", hit: hit, attribute: "hierarchy.lvl1" }))),
+            React.createElement("div", { className: "DocSearch-Hit-action" },
+                React.createElement(SelectIcon, null)))));
+};

package/dist/components/Algolia/SelectIcon.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare function SelectIcon(): React.JSX.Element;

package/dist/components/Algolia/SelectIcon.js

@@ -0,0 +1,7 @@
+import React from 'react';
+export function SelectIcon() {
+    return (React.createElement("svg", { className: "DocSearch-Hit-Select-Icon", width: "20", height: "20", viewBox: "0 0 20 20" },
+        React.createElement("g", { stroke: "currentColor", fill: "none", fillRule: "evenodd", strokeLinecap: "round", strokeLinejoin: "round" },
+            React.createElement("path", { d: "M18 3v4c0 2-2 4-4 4H2" }),
+            React.createElement("path", { d: "M8 17l-6-6 6-6" }))));
+}

package/dist/components/Algolia/Snippet.d.ts

@@ -0,0 +1,13 @@
+import { StoredDocSearchHit } from './types';
+interface SnippetProps<TItem> {
+    hit: TItem;
+    attribute: string;
+    tagName?: string;
+    [prop: string]: unknown;
+}
+export declare function Snippet<TItem extends StoredDocSearchHit>({ hit, attribute, tagName, ...rest }: SnippetProps<TItem>): import("react").DOMElement<{
+    dangerouslySetInnerHTML: {
+        __html: any;
+    };
+}, Element>;
+export {};

package/dist/components/Algolia/Snippet.js

@@ -0,0 +1,37 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { createElement } from 'react';
+function getPropertyByPath(object, path) {
+    var parts = path.split('.');
+    return parts.reduce(function (prev, current) {
+        if (prev === null || prev === void 0 ? void 0 : prev[current])
+            return prev[current];
+        return null;
+    }, object);
+}
+export function Snippet(_a) {
+    var hit = _a.hit, attribute = _a.attribute, _b = _a.tagName, tagName = _b === void 0 ? 'span' : _b, rest = __rest(_a, ["hit", "attribute", "tagName"]);
+    return createElement(tagName, __assign(__assign({}, rest), { dangerouslySetInnerHTML: {
+            __html: getPropertyByPath(hit, "_snippetResult.".concat(attribute, ".value")) || getPropertyByPath(hit, attribute),
+        } }));
+}

package/dist/components/Algolia/SourceIcon.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare function SourceIcon(props: {
+    type: string;
+}): React.JSX.Element;