@universal-deploy/store

@universal-deploy/store

This package provides a global addEntry helper for registering server entries.

import { addEntry, getAllEntries } from "@universal-deploy/store";

// Registering — add entries to the store
addEntry(
  {
    id: "./src/server/api.ts",  
    route: "/api",
  },
);

// Retrieving
const entries = getAllEntries();

Entry Configuration

Each entry accepts the following options:

export interface EntryMeta {
  /**
   * Module identifier for this entry. This can be a filesystem path or a virtual module.
   */
  id: string;
  /**
   * HTTP method(s) to match. When omitted, matches all HTTP methods.
   */
  method?: HttpMethod | HttpMethod[];
  /**
   * Route pattern(s) for this entry.
   *
   * Should be a valid {@link https://github.com/h3js/rou3 | rou3} pattern.
   */
  route: string | string[];
  /**
   * The Vite environment for this entry.
   *
   * @default ssr
   */
  environment?: string;
}

Vite Plugins

catchAll

Creates a virtual:ud:catch-all entry that aggregates all store entries and handles routing between them.

devServer

Adds development middleware that invokes the catch-all entry and returns the response to the client.

compat

Provides compatibility for resolving SSR Rollup entries and automatically registers them in the global store.

hmr

Define route boundaries on server entries.

resolver

Keeps a mapping between unresolved and resolved module ids. Provides isServerEntry helper to query this mapping.