@stati/core 1.19.0 → 1.20.1

package/dist/types/search.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Search index generation configuration and type definitions.
+ * @module types/search
+ */
+/**
+ * Search index generation configuration.
+ * When enabled, Stati generates a JSON search index at build time.
+ *
+ * @example
+ * ```typescript
+ * const config: StatiConfig = {
+ *   search: {
+ *     enabled: true,
+ *     indexName: 'search-index',
+ *     hashFilename: true,
+ *     maxContentLength: 1000,
+ *     maxPreviewLength: 500,
+ *     headingLevels: [2, 3, 4],
+ *     exclude: ['/private/**'],
+ *     includeHomePage: false,
+ *     autoInjectMetaTag: true,
+ *   }
+ * };
+ * ```
+ */
+export interface SearchConfig {
+    /** Enable search index generation. @default false */
+    enabled: boolean;
+    /** Base filename for the search index (without extension). @default 'search-index' */
+    indexName?: string;
+    /** Include content hash in filename for cache busting. @default true */
+    hashFilename?: boolean;
+    /** Maximum content length per section (in characters). @default 1000 */
+    maxContentLength?: number;
+    /** Maximum preview length for page-level entries (in characters). @default 500 */
+    maxPreviewLength?: number;
+    /** Heading levels to include in the index. @default [2, 3, 4, 5, 6] */
+    headingLevels?: number[];
+    /** Glob patterns for pages to exclude from the search index. @default [] */
+    exclude?: string[];
+    /** Include the home page (index) in the search index. @default false */
+    includeHomePage?: boolean;
+    /** Auto-inject search index meta tag into rendered HTML. @default true */
+    autoInjectMetaTag?: boolean;
+}
+/**
+ * A searchable document representing a page section.
+ * Each document is a searchable unit in the search index.
+ *
+ * @example
+ * ```typescript
+ * const doc: SearchDocument = {
+ *   id: '/getting-started/installation#prerequisites',
+ *   url: '/getting-started/installation',
+ *   anchor: 'prerequisites',
+ *   title: 'Installation',
+ *   heading: 'Prerequisites',
+ *   level: 2,
+ *   content: 'Before installing Stati, ensure you have Node.js 22 or later...',
+ *   breadcrumb: 'Getting Started > Installation',
+ *   tags: ['setup', 'installation']
+ * };
+ * ```
+ */
+export interface SearchDocument {
+    /** Unique identifier (page URL + section anchor) */
+    id: string;
+    /** Page URL path */
+    url: string;
+    /** Section anchor (heading ID), empty string for page-level entry */
+    anchor: string;
+    /** Page title from frontmatter */
+    title: string;
+    /** Section heading text */
+    heading: string;
+    /** Heading level (1 for page title, 2-6 for headings) */
+    level: number;
+    /** Text content of the section (stripped of HTML) */
+    content: string;
+    /** Breadcrumb path for display */
+    breadcrumb: string;
+    /** Optional tags from frontmatter */
+    tags?: string[];
+}
+/**
+ * The complete search index structure written to JSON.
+ * This is the output format for the generated search index file.
+ *
+ * @example
+ * ```typescript
+ * const index: SearchIndex = {
+ *   version: '1.0.0',
+ *   generatedAt: '2025-01-15T10:30:00.000Z',
+ *   documentCount: 150,
+ *   documents: [...]
+ * };
+ * ```
+ */
+export interface SearchIndex {
+    /** Schema version for forward compatibility */
+    version: string;
+    /** ISO timestamp when the index was generated */
+    generatedAt: string;
+    /** Total document count */
+    documentCount: number;
+    /** Array of searchable documents */
+    documents: SearchDocument[];
+}
+/**
+ * Metadata about the generated search index.
+ * Used to pass search index information to templates and other parts of the build.
+ */
+export interface SearchIndexMetadata {
+    /** Whether search index was generated */
+    enabled: boolean;
+    /** Full path to the search index file (e.g., '/search-index-a1b2c3d4.json') */
+    indexPath: string;
+    /** Document count in the index */
+    documentCount: number;
+}
+//# sourceMappingURL=search.d.ts.map

package/dist/types/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/types/search.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,YAAY;IAC3B,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAC;IAEjB,sFAAsF;IACtF,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wEAAwE;IACxE,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,kFAAkF;IAClF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,wEAAwE;IACxE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC7B,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,WAAW;IAC1B,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yCAAyC;IACzC,OAAO,EAAE,OAAO,CAAC;IACjB,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,aAAa,EAAE,MAAM,CAAC;CACvB"}

package/dist/types/search.js

@@ -0,0 +1,5 @@
+/**
+ * Search index generation configuration and type definitions.
+ * @module types/search
+ */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stati/core",
-  "version": "1.19.0",
+  "version": "1.20.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",