Merge pull request #410 from CloudCannon/feat/last-node-api-fixups

Last Node API fixups

pagefind/src/fossick/mod.rs

@@ -422,11 +422,14 @@ impl Fossicker {
 
 fn build_url(page_url: &Path, relative_to: Option<&Path>, options: &SearchOptions) -> String {
     let prefix = relative_to.unwrap_or(&options.site_source);
-    let trimmed = page_url.strip_prefix(prefix);
-    let Ok(url) = trimmed else {
+
+    let url = if let Ok(trimmed) = page_url.strip_prefix(prefix) {
+        trimmed
+    } else if page_url.is_relative() {
+        page_url
+    } else {
         options.logger.error(format!(
-            "File was found that does not start with the source directory: {}\nSource: {:?}\nFile: {:?}",
-            trimmed.err().unwrap(),
+            "Absolute file was found that does not start with the source directory. Source: {:?}\nFile: {:?}",
             prefix,
             page_url
         ));

pagefind/src/lib.rs

@@ -58,7 +58,7 @@ impl SearchState {
     }
 
     pub async fn fossick_many(&mut self, dir: PathBuf, glob: String) -> Result<usize, ()> {
-        let files = self.walk_for_files(dir, glob).await;
+        let files = self.walk_for_files(dir.clone(), glob).await;
         let log = &self.options.logger;
 
         log.info(format!(
@@ -322,6 +322,15 @@ impl SearchState {
                 .into_iter(),
         );
 
+        // SyntheticFiles should only return the relative path to the file
+        // _within_ the bundle directory — placing them in a final location
+        // is left to the API consumer.
+        for file in files.iter_mut() {
+            if let Ok(relative_path) = file.filename.strip_prefix(outdir) {
+                file.filename = relative_path.to_path_buf();
+            }
+        }
+
         files
     }
 

pagefind/src/service/mod.rs

@@ -237,13 +237,13 @@ pub async fn run_service() {
             }
             RequestAction::WriteFiles {
                 index_id,
-                bundle_path,
+                output_path,
             } => {
                 if let Some(index) = get_index(&mut indexes, index_id, err) {
                     index.build_indexes().await;
-                    let bundle_path = index.write_files(bundle_path.map(Into::into)).await;
+                    let resolved_output_path = index.write_files(output_path.map(Into::into)).await;
                     send(ResponseAction::WriteFiles {
-                        bundle_path: bundle_path.to_string_lossy().into(),
+                        output_path: resolved_output_path.to_string_lossy().into(),
                     });
                 }
             }

pagefind/src/service/requests.rs

@@ -39,7 +39,7 @@ pub(super) enum RequestAction {
     },
     WriteFiles {
         index_id: u32,
-        bundle_path: Option<String>,
+        output_path: Option<String>,
     },
     GetFiles {
         index_id: u32,

pagefind/src/service/responses.rs

@@ -27,7 +27,7 @@ pub(super) enum ResponseAction {
     },
     BuildIndex {},
     WriteFiles {
-        bundle_path: String,
+        output_path: String,
     },
     GetFiles {
         files: Vec<SyntheticFileResponse>,

wrappers/node/README.md

@@ -47,7 +47,7 @@ await index.getFiles();
 
 // Write the index to disk
 await index.writeFiles({
-    bundlePath: "./public/pagefind"
+    outputPath: "./public/pagefind"
 });
 ```
 
@@ -152,32 +152,32 @@ If successful, the `file` object is returned containing some metadata about the
 
 ### index.getFiles
 
-Get buffers of all files in the Pagefind index. Useful for integrating a Pagefind index into the development mode of a static site generator and hosting these files yourself.
+Get raw data of all files in the Pagefind index. Useful for integrating a Pagefind index into the development mode of a static site generator and hosting these files yourself.
 
 ```js
 const { errors, files } = await index.getFiles();
 
 for (const file of files) {
     console.log(file.path);
-    // do something with file.content
+    // do something with the file.content Uint8Array
 }
 ```
 
 A response with an `errors` array containing error messages indicates that Pagefind failed to action this request.
 
-If successful, `files` will be an array containing file objects. Each object contains a `path` key, which is the URL this file should be served at, and a `content` key containing the raw Buffer of this file.
+If successful, `files` will be an array containing file objects. Each object contains a `path` key, which is the URL this file should be served at, and a `content` key containing the raw data as a Uint8Array.
 
 ### index.writeFiles
 
 Writes the index files to disk, as they would be written when running the standard Pagefind binary directly.
 
 ```js
 const { errors } = await index.writeFiles({
-    bundlePath: "./public/pagefind"
+    outputPath: "./public/pagefind"
 });
 ```
 
-The `bundlePath` option should contain the path to the desired Pagefind bundle directory. If relative, is relative to the current working directory of your Node process.
+The `outputPath` option should contain the path to the desired Pagefind bundle directory. If relative, is relative to the current working directory of your Node process.
 
 A response with an `errors` array containing error messages indicates that Pagefind failed to action this request.
 

wrappers/node/lib/encoding.js

@@ -0,0 +1,27 @@
+/**
+ *
+ * @param {string} b64
+ * @returns {Uint8Array}
+ */
+export const decode = (b64) => {
+  let binString;
+  if (typeof Buffer !== "undefined" && typeof Buffer.from === "function") {
+    return Buffer.from(b64, "base64");
+  } else if (
+    typeof window !== "undefined" &&
+    typeof window.atob === "function"
+  ) {
+    binString = window.atob(b64);
+  } else if (typeof atob === "function") {
+    binString = atob(b64);
+  } else {
+    throw new Error("Unable to decode base64 data");
+  }
+
+  const size = binString.length;
+  const bytes = new Uint8Array(size);
+  for (let i = 0; i < size; i++) {
+    bytes[i] = binString.charCodeAt(i);
+  }
+  return bytes;
+};

wrappers/node/lib/index.js

@@ -1,4 +1,5 @@
 import { PagefindService } from "./service.js";
+import { decode } from "./encoding.js";
 
 /**
  * @typedef {import('pagefindInternal').InternalResponseCallback} InternalResponseCallback
@@ -212,7 +213,7 @@ const writeFiles = (indexId, options) => new Promise((resolve, reject) => {
         {
             type: action,
             index_id: indexId,
-            bundle_path: options?.bundlePath
+            output_path: options?.outputPath
         }, (response) => {
             /** @type {function(InternalResponsePayload): Omit<WriteFilesResponse, 'errors'>?} */
             const successCallback = (success) => {
@@ -222,7 +223,7 @@ const writeFiles = (indexId, options) => new Promise((resolve, reject) => {
                 }
 
                 return {
-                    bundlePath: success.bundle_path
+                    outputPath: success.output_path
                 }
             };
             handleApiResponse(resolve, reject, response, successCallback);
@@ -254,7 +255,7 @@ const getFiles = (indexId) => new Promise((resolve, reject) => {
                     files: success.files.map(file => {
                         return {
                             path: file.path,
-                            content: Buffer.from(file.content, 'base64')
+                            content: decode(file.content)
                         }
                     })
                 }

wrappers/node/types/index.d.ts

@@ -162,13 +162,13 @@ export interface WriteOptions {
      * If relative, is relative to the cwd.
      * @example "./public/pagefind"
      */
-    bundlePath: string
+    outputPath: string
 }
 
 
 export interface WriteFilesResponse {
     errors: string[],
-    bundlePath: string
+    outputPath: string
 }
 
 /**
@@ -183,7 +183,7 @@ export interface GetFilesResponse {
 
 export interface IndexFile {
     path: string,
-    content: Buffer
+    content: Uint8Array
 }
 
 /**

wrappers/node/types/internal.d.ts

@@ -62,7 +62,7 @@ export interface InternalAddDirRequest {
 export interface InternalWriteFilesRequest {
     type: 'WriteFiles',
     index_id: number,
-    bundle_path?: string
+    output_path?: string
 }
 
 export interface InternalGetFilesRequest {
@@ -124,7 +124,7 @@ export interface InternalIndexedDirResponse {
 
 export interface InternalWriteFilesResponse {
     type: 'WriteFiles',
-    bundle_path: string,
+    output_path: string,
 }
 
 export interface InternalGetFilesResponse {