npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@afcms/vite-plugin-opensearch

v0.2.1

Published

Generate OpenSearch 1.1 browser search descriptions with Vite

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

afcmafcm

Keywords

browser-searchopensearchvite-pluginxml

Readme

@afcms/vite-plugin-opensearch

A build-only Vite plugin that generates browser-compatible OpenSearch 1.1 description documents.

This package implements the browser search protocol, not the OpenSearch search server derived from Elasticsearch.

Installation

pnpm add --save-dev @afcms/vite-plugin-opensearch

The package requires Vite 8.

Basic usage

Add the plugin to vite.config.ts:

import { defineConfig } from "vite";
import openSearch from "@afcms/vite-plugin-opensearch";

export default defineConfig({
  plugins: [
    openSearch({
      baseURL: "https://example.com/",
      descriptions: [
        {
          fileName: "opensearch.xml",
          shortName: "Example Search",
          description: "Search example.com.",
          urls: [
            {
              type: "text/html",
              template: "/search?q={searchTerms}",
            },
          ],
          images: [
            {
              url: "/favicon.ico",
              width: 16,
              height: 16,
              type: "image/x-icon",
            },
          ],
          inputEncodings: ["UTF-8"],
        },
      ],
    }),
  ],
});

The build emits opensearch.xml at the root of Vite's output directory. The relative search and image URLs become https://example.com/search?... and https://example.com/favicon.ico in the generated document.

Multiple search engines

Every description has its own exact output path, so a domain can publish multiple search engines:

openSearch({
  baseURL: "https://example.com/",
  descriptions: [
    {
      fileName: "search/articles.xml",
      shortName: "Articles",
      description: "Search articles.",
      urls: [
        {
          type: "text/html",
          template: "/articles?q={searchTerms}",
        },
      ],
    },
    {
      fileName: "search/people.xml",
      shortName: "People",
      description: "Search people.",
      urls: [
        {
          type: "text/html",
          template: "/people?q={searchTerms}",
        },
      ],
    },
  ],
});

This emits search/articles.xml and search/people.xml. Output paths must be unique, relative POSIX paths and may use any file extension.

URL resolution

baseURL must be an absolute HTTP or HTTPS URL. URL templates and image URLs are resolved with the standard URL constructor:

  • /search resolves from the origin root.
  • search resolves relative to the path in baseURL.
  • Absolute URLs remain absolute.
  • data: image URLs remain data: URLs.

OpenSearch template placeholders such as {searchTerms} and {startPage?} are preserved. Query-string ampersands and other XML-sensitive characters are escaped in the emitted document.

Optional OpenSearch fields

The typed API supports all core OpenSearch description fields: contact, tags, long name, images, example queries, developer, attribution, syndication rights, adult-content status, languages, and input/output encodings. Every public input has JSDoc describing its limits and defaults.

The plugin rejects invalid OpenSearch data and unsafe output paths before it emits any files. A valid description without a text/html results URL produces a build warning because common browsers may reject it.

Browser autodiscovery

The plugin generates description files but does not modify HTML. Add one link for each engine to the page's <head>:

<link
  rel="search"
  type="application/opensearchdescription+xml"
  title="Articles"
  href="https://example.com/search/articles.xml"
/>
<link
  rel="search"
  type="application/opensearchdescription+xml"
  title="People"
  href="https://example.com/search/people.xml"
/>

The link title should match the description's shortName.

Configure the production server or CDN to serve generated descriptions with Content-Type: application/opensearchdescription+xml. The plugin only runs during Vite builds; it does not add development-server routes.