@tabulariumai/aurora-search
v2.0.0
Published
Shared Tabularium browser and CommonJS search package.
Maintainers
Readme
@tabulariumai/aurora-search
Shared Tabularium search runtime for Node.js and browser hosts.
Install
npm install @tabulariumai/aurora-searchCommonJS
const AuroraSearch = require("@tabulariumai/aurora-search");The package exports buildIndex, create, mount, and search. In CommonJS,
the search runtime uses the packaged search_index.json and the declared
fuse.js dependency.
Browser assets
The published runtime assets are available at these package subpaths:
@tabulariumai/aurora-search@tabulariumai/aurora-search/styles.css@tabulariumai/aurora-search/search_index.json
When index.js is loaded as a browser script, it exposes
window.AuroraSearch. The host must load Fuse.js first and provide the URL of
the copied search index:
window.assetManifest = {
auroraSearchIndexJson: "/assets/search_index.json",
};Development
npm test rebuilds the joined Company and Support search index and runs the
Node.js test suite. The index builder reads the sibling company_web and
support_web repositories, so those repositories must be present beside this
checkout when regenerating search_index.json.
Public Repository Notes
Generated package archives, dependency folders, and local environment files are not part of the public repository surface. Source, tests, documentation, the generated search index, and package metadata are public.
