@nikala-ui/folio-algolia 0.2.0 → 0.3.0

package/README.md

@@ -10,7 +10,7 @@ Folio.
 
 ## Requirements
 
-- Folio `0.14.0` or newer;
+- Folio `0.15.0` or newer;
 - an Algolia index containing the same page URLs used by Folio;
 - an Algolia Search-Only API key.
 
@@ -43,6 +43,10 @@ export default {
 The adapter implements Folio's `SearchAdapter` contract. The configuration
 contains no Algolia request logic and no indexing code.
 
+The adapter also declares a browser runtime descriptor. Folio uses that
+descriptor to load only the browser-safe adapter module; the consumer's full
+`docs.config.ts` and server-only indexing code are not bundled into the site.
+
 ## Environment variables
 
 Create a `.env` file in the documentation project:
@@ -163,10 +167,10 @@ Most Folio sites should use the exported `algoliaAdapter` instance instead.
 
 ## Migration from 0.1.x
 
-Version `0.2.0` adds the server-only indexing entrypoint at
-`@nikala-ui/folio-algolia/indexing` and requires Folio `0.14.0` or newer for
-the configured content-directory workflow. Existing browser-side adapter
-configuration remains compatible:
+Version `0.3.0` adds the browser runtime descriptor and requires Folio
+`0.15.0` or newer. The server-only indexing entrypoint from `0.2.0` remains
+available at `@nikala-ui/folio-algolia/indexing`. Existing browser-side
+adapter configuration remains compatible:
 
 ```ts
 import { algoliaAdapter } from "@nikala-ui/folio-algolia";

package/dist/adapter.js

@@ -1,8 +1,17 @@
 import { getAlgoliaEnv } from "./env.js";
 import { searchAlgolia } from "./client.js";
+const BROWSER_RUNTIME_MODULE = "@nikala-ui/folio-algolia/browser";
+function browserRuntime(options) {
+    return {
+        module: BROWSER_RUNTIME_MODULE,
+        exportName: "createAlgoliaAdapter",
+        options,
+    };
+}
 export function createAlgoliaAdapter(options) {
     return {
         name: "algolia",
+        runtime: browserRuntime(options),
         async search({ query, pages }) {
             const normalizedQuery = query.trim();
             if (!normalizedQuery)
@@ -16,6 +25,10 @@ export function createAlgoliaAdapterFromEnv() {
 }
 export const algoliaAdapter = {
     name: "algolia",
+    runtime: {
+        module: BROWSER_RUNTIME_MODULE,
+        exportName: "createAlgoliaAdapterFromEnv",
+    },
     search(context) {
         return createAlgoliaAdapterFromEnv().search(context);
     },

package/dist/browser.d.ts

@@ -0,0 +1 @@
+export { createAlgoliaAdapter, createAlgoliaAdapterFromEnv } from "./adapter.js";

package/dist/browser.js

@@ -0,0 +1 @@
+export { createAlgoliaAdapter, createAlgoliaAdapterFromEnv } from "./adapter.js";

package/dist/types.d.ts

@@ -22,5 +22,10 @@ export interface FolioSearchContext {
 export interface FolioSearchAdapter {
     name: string;
     search: (context: FolioSearchContext) => PageData[] | Promise<PageData[]>;
+    runtime?: {
+        module: string;
+        exportName: string;
+        options?: unknown;
+    };
 }
 export type FolioPage = PageData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nikala-ui/folio-algolia",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Algolia search adapter for Folio documentation sites",
   "license": "MIT",
   "type": "module",
@@ -24,6 +24,10 @@
     "./indexing": {
       "types": "./dist/indexing/index.d.ts",
       "import": "./dist/indexing/index.js"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.ts",
+      "import": "./dist/browser.js"
     }
   },
   "files": ["dist"],
@@ -35,7 +39,7 @@
     "package:check": "bun run check && npm pack --dry-run"
   },
   "peerDependencies": {
-    "@nikala-ui/folio": ">=0.14.0"
+    "@nikala-ui/folio": ">=0.15.0"
   },
   "devDependencies": {
     "@nikala-ui/folio": "^0.14.0",