@pagefind/component-ui 1.5.0-alpha.3

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@pagefind/component-ui",
+  "version": "1.5.0-alpha.3",
+  "type": "module",
+  "sideEffects": [
+    "*.css",
+    "./component-ui.ts",
+    "./components/*.ts",
+    "./npm_dist/**/*.mjs",
+    "./npm_dist/**/*.cjs"
+  ],
+  "main": "npm_dist/cjs/component-ui.cjs",
+  "module": "npm_dist/mjs/component-ui.mjs",
+  "types": "types-entry.ts",
+  "scripts": {
+    "start": "PAGEFIND_DEV=true node ./build.js",
+    "build": "node ./build.js",
+    "typecheck": "tsc --noEmit"
+  },
+  "author": "Pagefind",
+  "license": "MIT",
+  "dependencies": {
+    "adequate-little-templates": "^1.0.2",
+    "bcp-47": "^2.1.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.0",
+    "esbuild-plugin-import-glob": "^0.1.1",
+    "typescript": "^5.0.0"
+  },
+  "files": [
+    "npm_dist/**",
+    "css/pagefind-component-ui.css",
+    "types.ts",
+    "types-entry.ts",
+    "core/**/*.ts",
+    "components/**/*.ts"
+  ],
+  "exports": {
+    ".": {
+      "types": "./types-entry.ts",
+      "import": "./npm_dist/mjs/component-ui.mjs",
+      "require": "./npm_dist/cjs/component-ui.cjs"
+    },
+    "./css": "./css/pagefind-component-ui.css",
+    "./css/pagefind-component-ui.css": "./css/pagefind-component-ui.css"
+  }
+}

package/types-entry.ts

@@ -0,0 +1,27 @@
+// Type-only entry point for TypeScript consumers
+// (avoids triggering side effects from component registration)
+
+export {
+  getInstanceManager,
+  configureInstance,
+} from "./components/instance-manager";
+
+// Component class types (using `export type` avoids executing the module)
+export type { PagefindElement } from "./components/base-element";
+export type { PagefindConfig } from "./components/pagefind-config";
+export type { PagefindInput } from "./components/pagefind-input";
+export type { PagefindSummary } from "./components/pagefind-summary";
+export type { PagefindResults } from "./components/pagefind-results";
+export type { PagefindFilterPane } from "./components/pagefind-filter-pane";
+export type { PagefindFilterDropdown } from "./components/pagefind-filter-dropdown";
+export type { PagefindModal } from "./components/pagefind-modal";
+export type { PagefindModalTrigger } from "./components/pagefind-modal-trigger";
+export type { PagefindModalHeader } from "./components/pagefind-modal-header";
+export type { PagefindModalBody } from "./components/pagefind-modal-body";
+export type { PagefindModalFooter } from "./components/pagefind-modal-footer";
+export type { PagefindKeyboardHints } from "./components/pagefind-keyboard-hints";
+export type { PagefindSearchbox } from "./components/pagefind-searchbox";
+
+export type { Instance } from "./core/instance";
+
+export type * from "./types";

package/types.ts

@@ -0,0 +1,126 @@
+export type AnnouncerPriority = "polite" | "assertive";
+
+// Pagefind search results (from WASM)
+export interface PagefindSearchResult {
+  results: PagefindRawResult[];
+  filters?: FilterCounts;
+  totalFilters?: FilterCounts;
+  unfilteredTotalCount?: number;
+}
+
+export interface PagefindRawResult {
+  id: string;
+  data: () => Promise<PagefindResultData>;
+}
+
+export interface PagefindResultData {
+  url: string;
+  excerpt: string;
+  meta: Record<string, string>;
+  sub_results?: PagefindSubResult[];
+  locations?: number[];
+  weighted_locations?: WeightedLocation[];
+  filters?: Record<string, string[]>;
+  anchors?: PagefindAnchor[];
+  content?: string;
+  word_count?: number;
+}
+
+export interface PagefindSubResult {
+  url: string;
+  title: string;
+  excerpt: string;
+  locations?: number[];
+  weighted_locations?: WeightedLocation[];
+  anchors?: PagefindAnchor[];
+}
+
+export interface WeightedLocation {
+  weight: number;
+  balanced_score: number;
+  location: number;
+}
+
+export interface PagefindAnchor {
+  element: string;
+  id: string;
+  text?: string;
+  location?: number;
+}
+
+export type FilterCounts = Record<string, Record<string, number>>;
+export type FilterSelection = Record<string, string[]>;
+
+export interface InstanceOptions {
+  bundlePath?: string;
+  mergeIndex?: MergeIndexConfig[];
+  [key: string]: unknown;
+}
+
+export interface MergeIndexConfig {
+  bundlePath: string;
+  [key: string]: unknown;
+}
+
+export type InstanceEventMap = {
+  search: [term: string, filters: FilterSelection];
+  filters: [data: { available: FilterCounts; total: FilterCounts }];
+  loading: [];
+  results: [results: PagefindSearchResult];
+  error: [error: PagefindError];
+  translations: [translations: TranslationStrings, direction: TextDirection];
+};
+
+export type InstanceEvent = keyof InstanceEventMap;
+
+export interface PagefindError {
+  type?: string;
+  message: string;
+  bundlePath?: string;
+  error?: Error;
+}
+
+export type TextDirection = "ltr" | "rtl";
+
+export interface TranslationStrings {
+  language: string;
+  direction: TextDirection;
+  [key: string]: string | TextDirection;
+}
+
+export interface TranslationFile {
+  thanks_to?: string;
+  comments?: string;
+  direction?: TextDirection;
+  strings: Record<string, string>;
+}
+
+export interface ComponentCapabilities {
+  keyboardNavigation?: boolean;
+  announcements?: boolean;
+  [key: string]: unknown;
+}
+
+export interface Shortcut {
+  label: string;
+  description: string;
+  owner?: Element;
+}
+
+export type HookCallback = (...args: unknown[]) => void;
+
+export interface HookEntry {
+  callback: HookCallback;
+  owner?: Element;
+}
+
+export interface PagefindAPI {
+  options: (opts: Record<string, unknown>) => Promise<void>;
+  search: (
+    term: string | null,
+    options?: { filters?: FilterSelection },
+  ) => Promise<PagefindSearchResult>;
+  filters: () => Promise<FilterCounts>;
+  mergeIndex: (url: string, options?: Record<string, unknown>) => Promise<void>;
+  destroy?: () => void;
+}