@prose-reader/enhancer-search 1.9.0 → 1.10.0

package/.test/coverage/clover.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1673253398633" clover="3.2.0">
-  <project timestamp="1673253398633" name="All files">
+<coverage generated="1674998297005" clover="3.2.0">
+  <project timestamp="1674998297005" name="All files">
     <metrics statements="0" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0" elements="0" coveredelements="0" complexity="0" loc="0" ncloc="0" packages="0" files="0" classes="0"/>
   </project>
 </coverage>

package/.test/coverage/index.html

@@ -86,7 +86,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2023-01-09T08:36:38.630Z
+                at 2023-01-29T13:18:17.002Z
             </div>
         <script src="prettify.js"></script>
         <script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/enhancer-search",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "type": "module",
   "main": "./dist/prose-reader-enhancer-search.umd.cjs",
   "module": "./dist/prose-reader-enhancer-search.js",
@@ -19,11 +19,11 @@
     "test": "vitest run --coverage"
   },
   "dependencies": {
-    "@prose-reader/core": "^1.9.0",
+    "@prose-reader/core": "^1.10.0",
     "@prose-reader/enhancer-scripts": "^1.8.0"
   },
   "peerDependencies": {
     "rxjs": "*"
   },
-  "gitHead": "e419ffe0deab682e8c52ea27fb7fa55208f26be1"
+  "gitHead": "5b0993fa7f5d80980e7f4eaf972e92235fea68ba"
 }

package/src/index.ts

@@ -1,7 +1,15 @@
-import { Enhancer } from "@prose-reader/core"
+import { Reader } from "@prose-reader/core"
 import { forkJoin, from, merge, Observable, of, Subject } from "rxjs"
 import { map, share, switchMap, takeUntil } from "rxjs/operators"
 
+const supportedContentType = [
+  `application/xhtml+xml` as const,
+  `application/xml` as const,
+  `image/svg+xml` as const,
+  `text/html` as const,
+  `text/xml` as const,
+]
+
 type ResultItem = {
   spineItemIndex: number
   startCfi: string
@@ -12,168 +20,161 @@ type ResultItem = {
   endOffset: number
 }
 
-const supportedContentType = [
-  `application/xhtml+xml` as const,
-  `application/xml` as const,
-  `image/svg+xml` as const,
-  `text/html` as const,
-  `text/xml` as const,
-]
-
 export type SearchResult = ResultItem[]
 
 /**
  *
  */
-export const searchEnhancer: Enhancer<
-  Record<string, never>,
-  {
+export const searchEnhancer =
+  <InheritOptions, InheritOutput extends Reader>(next: (options: InheritOptions) => InheritOutput) =>
+  (
+    options: InheritOptions
+  ): InheritOutput & {
     search: {
       search: (text: string) => void
       $: {
         search$: Observable<{ type: `start` } | { type: `end`; data: SearchResult }>
       }
     }
-  }
-> = (next) => (options) => {
-  const reader = next(options)
+  } => {
+    const reader = next(options)
 
-  const searchSubject$ = new Subject<string>()
+    const searchSubject$ = new Subject<string>()
 
-  const searchNodeContainingText = (node: Node, text: string) => {
-    const nodeList = node.childNodes
+    const searchNodeContainingText = (node: Node, text: string) => {
+      const nodeList = node.childNodes
 
-    if (node.nodeName === `head`) return []
+      if (node.nodeName === `head`) return []
 
-    const rangeList: {
-      startNode: Node
-      start: number
-      endNode: Node
-      end: number
-    }[] = []
-    for (let i = 0; i < nodeList.length; i++) {
-      const subNode = nodeList[i]
+      const rangeList: {
+        startNode: Node
+        start: number
+        endNode: Node
+        end: number
+      }[] = []
+      for (let i = 0; i < nodeList.length; i++) {
+        const subNode = nodeList[i]
 
-      if (!subNode) {
-        continue
-      }
+        if (!subNode) {
+          continue
+        }
 
-      if (subNode?.hasChildNodes()) {
-        rangeList.push(...searchNodeContainingText(subNode, text))
-      }
+        if (subNode?.hasChildNodes()) {
+          rangeList.push(...searchNodeContainingText(subNode, text))
+        }
 
-      if (subNode.nodeType === 3) {
-        const content = (subNode as Text).data.toLowerCase()
-        if (content) {
-          let match
-          const regexp = RegExp(`(${text})`, `g`)
-
-          while ((match = regexp.exec(content)) !== null) {
-            if (match.index >= 0 && subNode.ownerDocument) {
-              const range = subNode.ownerDocument.createRange()
-              range.setStart(subNode, match.index)
-              range.setEnd(subNode, match.index + text.length)
-              rangeList.push({
-                startNode: subNode,
-                start: match.index,
-                endNode: subNode,
-                end: match.index + text.length,
-              })
+        if (subNode.nodeType === 3) {
+          const content = (subNode as Text).data.toLowerCase()
+          if (content) {
+            let match
+            const regexp = RegExp(`(${text})`, `g`)
+
+            while ((match = regexp.exec(content)) !== null) {
+              if (match.index >= 0 && subNode.ownerDocument) {
+                const range = subNode.ownerDocument.createRange()
+                range.setStart(subNode, match.index)
+                range.setEnd(subNode, match.index + text.length)
+                rangeList.push({
+                  startNode: subNode,
+                  start: match.index,
+                  endNode: subNode,
+                  end: match.index + text.length,
+                })
+              }
             }
           }
         }
       }
+
+      return rangeList
     }
 
-    return rangeList
-  }
+    const searchForItem = (index: number, text: string) => {
+      const item = reader.getSpineItem(index)
 
-  const searchForItem = (index: number, text: string) => {
-    const item = reader.getSpineItem(index)
+      if (!item) {
+        return of([])
+      }
 
-    if (!item) {
-      return of([])
-    }
+      return from(item.getResource()).pipe(
+        switchMap((response) => {
+          // small optimization since we already know DOMParser only accept some documents only
+          // the reader returns us a valid HTML document anyway so it is not ultimately necessary.
+          // however we can still avoid doing unnecessary HTML generation for images resources, etc.
+          if (!supportedContentType.includes(response?.headers.get(`Content-Type`) || (`` as any))) return of([])
+
+          return from(item.getHtmlFromResource(response)).pipe(
+            map((html) => {
+              const parser = new DOMParser()
+              const doc = parser.parseFromString(html, `application/xhtml+xml`)
+
+              const ranges = searchNodeContainingText(doc, text)
+              const newResults = ranges.map((range) => {
+                const { end, start } = reader.generateCfi(range, item.item)
+                const { node, offset, spineItemIndex } = reader.resolveCfi(start) || {}
+                const pageIndex =
+                  node && spineItemIndex !== undefined
+                    ? reader.locator.getSpineItemPageIndexFromNode(node, offset, spineItemIndex)
+                    : undefined
+
+                return {
+                  spineItemIndex: index,
+                  startCfi: start,
+                  endCfi: end,
+                  pageIndex,
+                  contextText: range.startNode.parentElement?.textContent || ``,
+                  startOffset: range.start,
+                  endOffset: range.end,
+                }
+              })
 
-    return from(item.getResource()).pipe(
-      switchMap((response) => {
-        // small optimization since we already know DOMParser only accept some documents only
-        // the reader returns us a valid HTML document anyway so it is not ultimately necessary.
-        // however we can still avoid doing unnecessary HTML generation for images resources, etc.
-        if (!supportedContentType.includes(response?.headers.get(`Content-Type`) || (`` as any))) return of([])
-
-        return from(item.getHtmlFromResource(response)).pipe(
-          map((html) => {
-            const parser = new DOMParser()
-            const doc = parser.parseFromString(html, `application/xhtml+xml`)
-
-            const ranges = searchNodeContainingText(doc, text)
-            const newResults = ranges.map((range) => {
-              const { end, start } = reader.generateCfi(range, item.item)
-              const { node, offset, spineItemIndex } = reader.resolveCfi(start) || {}
-              const pageIndex =
-                node && spineItemIndex !== undefined
-                  ? reader.locator.getSpineItemPageIndexFromNode(node, offset, spineItemIndex)
-                  : undefined
-
-              return {
-                spineItemIndex: index,
-                startCfi: start,
-                endCfi: end,
-                pageIndex,
-                contextText: range.startNode.parentElement?.textContent || ``,
-                startOffset: range.start,
-                endOffset: range.end,
-              }
+              return newResults
             })
+          )
+        })
+      )
+    }
 
-            return newResults
-          })
-        )
-      })
-    )
-  }
+    const search = (text: string) => {
+      searchSubject$.next(text)
+    }
 
-  const search = (text: string) => {
-    searchSubject$.next(text)
-  }
+    /**
+     * Main search process stream
+     */
+    const search$ = merge(
+      searchSubject$.asObservable().pipe(map(() => ({ type: `start` as const }))),
+      searchSubject$.asObservable().pipe(
+        switchMap((text) => {
+          if (text === ``) {
+            return of([])
+          }
 
-  /**
-   * Main search process stream
-   */
-  const search$ = merge(
-    searchSubject$.asObservable().pipe(map(() => ({ type: `start` as const }))),
-    searchSubject$.asObservable().pipe(
-      switchMap((text) => {
-        if (text === ``) {
-          return of([])
-        }
+          const searches$ = reader.context.getManifest()?.spineItems.map((_, index) => searchForItem(index, text)) || []
 
-        const searches$ = reader.context.getManifest()?.spineItems.map((_, index) => searchForItem(index, text)) || []
-
-        return forkJoin(searches$).pipe(
-          map((results) => {
-            return results.reduce((acc, value) => [...acc, ...value], [])
-          })
-        )
-      }),
-      map((data) => ({ type: `end` as const, data }))
-    )
-  ).pipe(share(), takeUntil(reader.$.destroy$))
-
-  const destroy = () => {
-    searchSubject$.complete()
-    reader.destroy()
-  }
+          return forkJoin(searches$).pipe(
+            map((results) => {
+              return results.reduce((acc, value) => [...acc, ...value], [])
+            })
+          )
+        }),
+        map((data) => ({ type: `end` as const, data }))
+      )
+    ).pipe(share(), takeUntil(reader.$.destroy$))
+
+    const destroy = () => {
+      searchSubject$.complete()
+      reader.destroy()
+    }
 
-  return {
-    ...reader,
-    destroy,
-    search: {
-      search,
-      $: {
-        search$,
+    return {
+      ...reader,
+      destroy,
+      search: {
+        search,
+        $: {
+          search$,
+        },
       },
-    },
+    }
   }
-}