pagefind - npm Package Compare versions

Comparing version 1.0.0-beta.2 to 1.0.0-beta.3

lib/index.js

@@ -107,3 +107,4 @@ import { PagefindService } from "./service.js";
             index_id: indexId,
-            file_path: file.path,
+            file_path: file.sourcePath,
+            url: file.url,
             file_contents: file.content
@@ -110,0 +111,0 @@ }, (response) => {

package.json

 {
   "name": "pagefind",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.3",
   "type": "module",
@@ -22,7 +22,7 @@ "description": "Implement search on any static website.",
   "optionalDependencies": {
-    "@pagefind/linux-x64": "1.0.0-beta.2",
-    "@pagefind/linux-arm64": "1.0.0-beta.2",
-    "@pagefind/darwin-x64": "1.0.0-beta.2",
-    "@pagefind/darwin-arm64": "1.0.0-beta.2",
-    "@pagefind/windows-x64": "1.0.0-beta.2"
+    "@pagefind/linux-x64": "1.0.0-beta.3",
+    "@pagefind/linux-arm64": "1.0.0-beta.3",
+    "@pagefind/darwin-x64": "1.0.0-beta.3",
+    "@pagefind/darwin-arm64": "1.0.0-beta.3",
+    "@pagefind/windows-x64": "1.0.0-beta.3"
   },
@@ -29,0 +29,0 @@ "keywords": [

types/index.d.ts

@@ -81,7 +81,20 @@ /**
     /** 
-     * The relative path to the HTML file if it were to exist on disk.
+     * The source path of the HTML file if it were to exist on disk. Must be a relative path.
      * Pagefind will compute the result URL from this path.
+     * 
+     * If not supplied, url must be supplied.
+     * 
      * @example "about/index.html"
+     * @example "/Users/user/Documents/site/about/index.html"
      */
-    path: string,
+    sourcePath?: string,
+    /** 
+     * An explicit URL to use, instead of having Pagefind
+     * compute the URL based on the sourcePath.
+     * 
+     * If not supplied, sourcePath must be supplied.
+     * 
+     * @example "/about/"
+     */
+    url?: string,
     /** The source HTML content of the file to be parsed */
@@ -88,0 +101,0 @@ content: string

types/internal.d.ts

@@ -40,3 +40,4 @@ // Requests to the backend.
     index_id: number,
-    file_path: string,
+    file_path?: string,
+    url?: string,
     file_contents: string
@@ -43,0 +44,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

41927

increased by1.07%

Lines of code

873

increased by1.75%

No dependency changes