@brillout/docpress 0.12.1 → 0.12.3

package/components/Algolia/Hit.tsx

@@ -1,16 +1,18 @@
 export { Hit }
 
 import React from 'react'
-import { DocSearch } from '@docsearch/react'
-import type { InternalDocSearchHit } from './types'
+import type { DocSearchHit, InternalDocSearchHit, StoredDocSearchHit } from '@docsearch/react'
 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'
+type HitProps = {
+  hit: InternalDocSearchHit | StoredDocSearchHit
+  children: React.ReactNode
+}
+type HierarchyType = Exclude<DocSearchHit['type'], 'content'>
 
-const Hit: HitProps = ({ hit }) => {
+function Hit({ hit }: HitProps) {
   return (
     <a href={hit.type === 'lvl1' ? hit.url.split('#')[0] : hit.url}>
       <div className="DocSearch-Hit-Container">
@@ -29,14 +31,14 @@ const Hit: HitProps = ({ hit }) => {
         <div className="DocSearch-Hit-icon">
           <SourceIcon type={hit.type} />
         </div>
-        {hit.hierarchy[hit.type as ContentType] && hit.type === 'lvl1' && (
+        {hit.hierarchy[hit.type as HierarchyType] && 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.hierarchy[hit.type as HierarchyType] &&
           (hit.type === 'lvl2' ||
             hit.type === 'lvl3' ||
             hit.type === 'lvl4' ||

package/components/Algolia/Snippet.tsx

@@ -1,5 +1,5 @@
 import { createElement } from 'react'
-import { StoredDocSearchHit } from './types'
+import { InternalDocSearchHit, StoredDocSearchHit } from '@docsearch/react'
 
 function getPropertyByPath(object: Record<string, any>, path: string): any {
   const parts = path.split('.')
@@ -17,7 +17,7 @@ interface SnippetProps<TItem> {
   [prop: string]: unknown
 }
 
-export function Snippet<TItem extends StoredDocSearchHit>({
+export function Snippet<TItem extends InternalDocSearchHit | StoredDocSearchHit>({
   hit,
   attribute,
   tagName = 'span',
@@ -26,7 +26,7 @@ export function Snippet<TItem extends StoredDocSearchHit>({
   let title = ''
   let lvl2 = ''
 
-  if (!hit.__docsearch_parent && hit.type !== 'lvl1' && attribute !== 'content') {
+  if (!(hit as InternalDocSearchHit).__docsearch_parent && hit.type !== 'lvl1' && attribute !== 'content') {
     if (hit.type === 'content') {
       lvl2 = getPropertyByPath(hit, `_snippetResult.hierarchy.lvl2.value`) || getPropertyByPath(hit, 'hierarchy.lvl2')
       lvl2 = lvl2 ? ` > ${lvl2}` : ''

package/components/Link.tsx

@@ -82,7 +82,7 @@ function getLinkTextData(href: string, pageContext: PageContextResolved, doNotIn
   const { hrefPathname, hrefHash } = parseHref(href)
 
   const linkData = findLinkData(hrefPathname || pageContext.urlPathname, pageContext)
-  assert(linkData)
+  if (!linkData) return null
   const isLinkOnSamePage = linkData.url === pageContext.urlPathname
   if (!hrefPathname) assert(isLinkOnSamePage)
 

package/dist/components/Link.js

@@ -54,7 +54,8 @@ function getLinkText(_a) {
 function getLinkTextData(href, pageContext, doNotInferSectionTitle) {
     var _a = parseHref(href), hrefPathname = _a.hrefPathname, hrefHash = _a.hrefHash;
     var linkData = findLinkData(hrefPathname || pageContext.urlPathname, pageContext);
-    assert(linkData);
+    if (!linkData)
+        return null;
     var isLinkOnSamePage = linkData.url === pageContext.urlPathname;
     if (!hrefPathname)
         assert(isLinkOnSamePage);

package/dist/utils/assert.d.ts

@@ -3,4 +3,7 @@ export { assertUsage };
 export { assertWarning };
 declare function assert(condition: unknown, debugInfo?: unknown): asserts condition;
 declare function assertUsage(condition: unknown, msg: string): asserts condition;
-declare function assertWarning(condition: unknown, msg: string): void;
+declare function assertWarning(condition: unknown, msg: string, { onlyOnce, showStackTrace }?: {
+    onlyOnce?: boolean | string;
+    showStackTrace?: true;
+}): void;

package/dist/utils/assert.js

@@ -1,7 +1,11 @@
 export { assert };
 export { assertUsage };
 export { assertWarning };
+import { getGlobalObject } from './getGlobalObject';
 var devModeKey = '__docpress_dev_mode';
+var globalObject = getGlobalObject('utils/assert.ts', {
+    alreadyLogged: new Set(),
+});
 if (isBrowser()) {
     ;
     window.toggleDevMode = toggleDevMode;
@@ -66,18 +70,31 @@ function toggleDevMode() {
     }
     console.log("DEV MODE ".concat(isEnabled() ? 'enabled' : 'disabled'));
 }
-function assertWarning(condition, msg) {
+function assertWarning(condition, msg, _a) {
+    var _b = _a === void 0 ? {} : _a, _c = _b.onlyOnce, onlyOnce = _c === void 0 ? true : _c, showStackTrace = _b.showStackTrace;
     if (condition) {
         return;
     }
-    msg = '[DocPress][Warning] ' + msg;
     var err = new Error(msg);
-    if (import.meta.env.DEV) {
-        console.warn(err);
-        if (isDevMode())
-            window.alert(err);
+    if (!import.meta.env.DEV) {
+        throw err;
     }
     else {
-        throw err;
+        if (onlyOnce) {
+            var alreadyLogged = globalObject.alreadyLogged;
+            var key = onlyOnce === true ? msg : onlyOnce;
+            if (alreadyLogged.has(key))
+                return;
+            alreadyLogged.add(key);
+        }
+        msg = '[DocPress][Warning] ' + msg;
+        if (!showStackTrace) {
+            console.warn(msg);
+        }
+        else {
+            console.warn(err);
+        }
+        if (isDevMode())
+            window.alert(err);
     }
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.12.1",
+  "version": "0.12.3",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",
-    "@docsearch/css": "3.6.1",
-    "@docsearch/react": "3.6.1",
+    "@docsearch/css": "3.9.0",
+    "@docsearch/react": "3.9.0",
     "@mdx-js/mdx": "3.0.1",
     "@mdx-js/react": "3.0.1",
     "@mdx-js/rollup": "3.0.1",

package/utils/assert.ts

@@ -2,7 +2,11 @@ export { assert }
 export { assertUsage }
 export { assertWarning }
 
+import { getGlobalObject } from './getGlobalObject'
 const devModeKey = '__docpress_dev_mode'
+const globalObject = getGlobalObject('utils/assert.ts', {
+  alreadyLogged: new Set<string>(),
+})
 
 if (isBrowser()) {
   ;(window as any).toggleDevMode = toggleDevMode
@@ -70,16 +74,30 @@ function toggleDevMode() {
   console.log(`DEV MODE ${isEnabled() ? 'enabled' : 'disabled'}`)
 }
 
-function assertWarning(condition: unknown, msg: string) {
+function assertWarning(
+  condition: unknown,
+  msg: string,
+  { onlyOnce = true, showStackTrace }: { onlyOnce?: boolean | string; showStackTrace?: true } = {},
+) {
   if (condition) {
     return
   }
-  msg = '[DocPress][Warning] ' + msg
   const err = new Error(msg)
-  if (import.meta.env.DEV) {
-    console.warn(err)
-    if (isDevMode()) window.alert(err)
-  } else {
+  if (!import.meta.env.DEV) {
     throw err
+  } else {
+    if (onlyOnce) {
+      const { alreadyLogged } = globalObject
+      const key = onlyOnce === true ? msg : onlyOnce
+      if (alreadyLogged.has(key)) return
+      alreadyLogged.add(key)
+    }
+    msg = '[DocPress][Warning] ' + msg
+    if (!showStackTrace) {
+      console.warn(msg)
+    } else {
+      console.warn(err)
+    }
+    if (isDevMode()) window.alert(err)
   }
 }

package/components/Algolia/types.ts

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