@farm.js/search 0.1.0-beta.2 → 0.1.0-beta.3

package/dist/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../src/build.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAmF1F;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAKhF;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAGnE;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKpE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKrE;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKtD;AAYD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAwB3E"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../src/build.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAoF1F;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAKhF;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAGnE;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKpE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKrE;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKtD;AAYD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAwB3E"}

package/dist/build.js

@@ -53,6 +53,7 @@ export async function writeSearchIndex(input) {
             }
             indexedRoutes.push(route);
         }
+        await assertOutputPathIsOwned(outputPath);
         await rm(outputPath, { recursive: true, force: true });
         await mkdir(path.dirname(outputPath), { recursive: true });
         const written = await index.writeFiles({ outputPath });
@@ -183,6 +184,51 @@ function resolveOutputPath(publicDir, bundlePath) {
     }
     return outputPath;
 }
+/**
+ * Refuse to delete prerendered pages that happen to live where the index goes.
+ *
+ * The index directory is wiped before it is rewritten, and it comes from the
+ * `output` option, so `output: "search"` on a site that also prerenders a
+ * `/search` page pointed the wipe at the app's own pages. `collectHtmlFiles`
+ * skips this directory, so those pages were left out of the index and then
+ * deleted from the deploy output, with a success log and a zero exit.
+ *
+ * Only HTML is treated as the app's: a previous bundle leaves non-HTML files
+ * behind, and clearing those is this function's normal job.
+ */
+async function assertOutputPathIsOwned(outputPath) {
+    const pages = await findHtmlFile(outputPath);
+    if (!pages)
+        return;
+    throw new Error(`The search index directory ${outputPath} contains a prerendered page (${path.relative(outputPath, pages)}), ` +
+        `so it will not be replaced. Give \`search({ output })\` a directory of its own, ` +
+        `or move the conflicting route, then build again.`);
+}
+/** The first HTML file at any depth, or undefined when there is none. */
+async function findHtmlFile(directory) {
+    let entries;
+    try {
+        entries = await readdir(directory, { withFileTypes: true });
+    }
+    catch (error) {
+        // Nothing there yet is the ordinary first build.
+        if (error.code === "ENOENT")
+            return undefined;
+        throw error;
+    }
+    for (const entry of entries) {
+        const entryPath = path.join(directory, entry.name);
+        if (entry.isDirectory()) {
+            const nested = await findHtmlFile(entryPath);
+            if (nested)
+                return nested;
+        }
+        else if (entry.isFile() && entry.name.toLowerCase().endsWith(".html")) {
+            return entryPath;
+        }
+    }
+    return undefined;
+}
 async function assertOutputPathInside(publicDir, outputPath) {
     const realPublicDir = await realpath(publicDir);
     let existingAncestor = outputPath;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { type SearchOptions } from "./config.js";
+import type { FarmSearchPublicConfig } from "./types.js";
 export type { ResolvedSearchOptions, SearchOptions } from "./config.js";
 export type { FarmSearchClient, SearchClientOptions, SearchFilterCounts, SearchFilterExpression, SearchFilterPrimitive, SearchFilters, SearchQueryOptions, SearchResponse, SearchResult, SearchSort, SearchSubResult, SearchTimings, } from "./types.js";
 /** Build a static Pagefind index from Farm's emitted HTML pages. */
-export declare function search(options?: SearchOptions): import("@farm.js/core/plugin").FarmPlugin;
+export declare function search(options?: SearchOptions): import("@farm.js/core/plugin").FarmPlugin<undefined, Record<string, never>, void, FarmSearchPublicConfig, unknown, false, import("@farm.js/core/plugin").PluginRoutes>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAGvE,YAAY,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,YAAY,EACV,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,eAAe,EACf,aAAa,GACd,MAAM,YAAY,CAAC;AAEpB,oEAAoE;AACpE,wBAAgB,MAAM,CAAC,OAAO,GAAE,aAAkB,6CAkGjD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEzD,YAAY,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACxE,YAAY,EACV,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,eAAe,EACf,aAAa,GACd,MAAM,YAAY,CAAC;AAEpB,oEAAoE;AACpE,wBAAgB,MAAM,CAAC,OAAO,GAAE,aAAkB,0KAkGjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farm.js/search",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.3",
   "description": "Build-time static page search for Farm.js applications",
   "keywords": [
     "farm.js",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "pagefind": "^1.5.2",
-    "@farm.js/core": "0.1.0-beta.105"
+    "@farm.js/core": "0.1.0-beta.108"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",