mirror of
https://github.com/ThatGuySam/doesitarm.git
synced 2026-05-18 06:44:46 -07:00
feat(search): add pagefind provider support
Add Pagefind indexing and browser search adapters behind a provider switch. This lets prebuild generate either Stork or Pagefind search artifacts and lets the existing search UI run against Pagefind while preserving scoped filters, excerpts, and result metadata.
This commit is contained in:
parent
727f84e4c2
commit
e1da6eb880
12 changed files with 690 additions and 65 deletions
168
helpers/pagefind/browser.js
Normal file
168
helpers/pagefind/browser.js
Normal file
|
|
@ -0,0 +1,168 @@
|
|||
import {
|
||||
isNonEmptyString
|
||||
} from '~/helpers/check-types.js'
|
||||
import {
|
||||
pagefindBundleRelativeURL,
|
||||
pagefindScriptURL
|
||||
} from '~/helpers/pagefind/config.js'
|
||||
|
||||
function escapeHtml ( text = '' ) {
|
||||
return text
|
||||
.replaceAll('&', '&')
|
||||
.replaceAll('<', '<')
|
||||
.replaceAll('>', '>')
|
||||
.replaceAll('"', '"')
|
||||
.replaceAll("'", ''')
|
||||
}
|
||||
|
||||
function escapeRegExp ( value ) {
|
||||
return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
|
||||
}
|
||||
|
||||
export function makeHighlightedPagefindTitle ( title, terms = [] ) {
|
||||
const highlightedTerms = terms
|
||||
.filter( term => isNonEmptyString( term ) )
|
||||
.map( term => term.trim() )
|
||||
.filter( term => term.length > 0 )
|
||||
.sort( ( a, b ) => b.length - a.length )
|
||||
|
||||
const titleMarkup = escapeHtml( title || '' )
|
||||
|
||||
if ( highlightedTerms.length === 0 ) {
|
||||
return titleMarkup
|
||||
}
|
||||
|
||||
const pattern = highlightedTerms.map( escapeRegExp ).join('|')
|
||||
|
||||
return titleMarkup.replace(
|
||||
new RegExp(`(${ pattern })`, 'gi'),
|
||||
'<span class="stork-highlighted-text font-bold text-white bg-green-800 rounded px-1">$1</span>'
|
||||
)
|
||||
}
|
||||
|
||||
export function normalizePagefindExcerptMarkup ( excerptMarkup = '' ) {
|
||||
if ( !isNonEmptyString( excerptMarkup ) ) return ''
|
||||
|
||||
return excerptMarkup
|
||||
.replace(/<mark[^>]*>/g, '<span class="stork-highlighted-text font-bold text-white bg-green-800 rounded px-1">')
|
||||
.replace(/<\/mark>/g, '</span>')
|
||||
}
|
||||
|
||||
export function mapPagefindDataToListing ( resultData, {
|
||||
highlightTerms = []
|
||||
} = {} ) {
|
||||
const lastUpdatedTimestamp = Number( resultData.meta?.lastUpdatedTimestamp || 0 )
|
||||
|
||||
return {
|
||||
name: makeHighlightedPagefindTitle( resultData.meta?.title || resultData.url, highlightTerms ),
|
||||
text: resultData.meta?.text || resultData.url,
|
||||
endpoint: resultData.url,
|
||||
slug: resultData.meta?.slug || resultData.url,
|
||||
category: {
|
||||
slug: resultData.meta?.categorySlug || 'uncategorized'
|
||||
},
|
||||
lastUpdated: lastUpdatedTimestamp > 0 ? {
|
||||
timestamp: lastUpdatedTimestamp
|
||||
} : null,
|
||||
resultExcerptsMarkup: isNonEmptyString( resultData.excerpt ) ? [
|
||||
normalizePagefindExcerptMarkup( resultData.excerpt )
|
||||
] : []
|
||||
}
|
||||
}
|
||||
|
||||
export class PagefindClient {
|
||||
constructor ( options = {} ) {
|
||||
this.bundlePath = options.bundlePath || pagefindBundleRelativeURL
|
||||
this.pagefind = options.pagefind || null
|
||||
this.debounceMs = options.debounceMs || 100
|
||||
this.cancelCurrentQuery = null
|
||||
}
|
||||
|
||||
setupState = 'not-setup'
|
||||
|
||||
get isSetup () {
|
||||
return this.setupState === 'complete'
|
||||
}
|
||||
|
||||
waitForSetup () {
|
||||
return new Promise( resolve => {
|
||||
if ( this.isSetup ) resolve()
|
||||
|
||||
const timer = setInterval( () => {
|
||||
if ( this.isSetup ) {
|
||||
clearInterval( timer )
|
||||
resolve()
|
||||
}
|
||||
}, 50 )
|
||||
})
|
||||
}
|
||||
|
||||
async loadPagefindScript () {
|
||||
if ( this.pagefind ) return
|
||||
|
||||
const pagefindModule = await import(/* @vite-ignore */ pagefindScriptURL)
|
||||
this.pagefind = pagefindModule.default || pagefindModule
|
||||
|
||||
this.pagefind.options({
|
||||
bundlePath: this.bundlePath
|
||||
})
|
||||
}
|
||||
|
||||
async setup () {
|
||||
if ( this.setupState !== 'not-setup' ) {
|
||||
await this.waitForSetup()
|
||||
return
|
||||
}
|
||||
|
||||
this.setupState = 'pending'
|
||||
|
||||
await this.loadPagefindScript()
|
||||
|
||||
if ( typeof this.pagefind.init === 'function' ) {
|
||||
await this.pagefind.init()
|
||||
}
|
||||
|
||||
this.setupState = 'complete'
|
||||
}
|
||||
|
||||
async lazyQuery ( query, {
|
||||
filters = {},
|
||||
sort = {}
|
||||
} = {} ) {
|
||||
const searchOptions = {}
|
||||
|
||||
if ( Object.keys( filters ).length > 0 ) {
|
||||
searchOptions.filters = filters
|
||||
}
|
||||
|
||||
if ( Object.keys( sort ).length > 0 ) {
|
||||
searchOptions.sort = sort
|
||||
}
|
||||
|
||||
const trimmedQuery = query.trim()
|
||||
|
||||
const result = await new Promise( async ( resolve, reject ) => {
|
||||
if ( this.cancelCurrentQuery !== null ) {
|
||||
this.cancelCurrentQuery()
|
||||
}
|
||||
|
||||
this.cancelCurrentQuery = () => { reject({ message: `Cancelled previous query for ${ trimmedQuery }`, canceled: true }) }
|
||||
|
||||
if ( !this.isSetup ) await this.setup()
|
||||
|
||||
if ( trimmedQuery.length === 0 ) {
|
||||
resolve( await this.pagefind.search( null, searchOptions ) )
|
||||
return
|
||||
}
|
||||
|
||||
resolve( await this.pagefind.debouncedSearch( trimmedQuery, searchOptions, this.debounceMs ) )
|
||||
}).catch( err => {
|
||||
console.log('Query rejected', err)
|
||||
return null
|
||||
})
|
||||
|
||||
this.cancelCurrentQuery = null
|
||||
|
||||
return result
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue