astro-loader-pocketbase 2.4.1 → 2.5.0-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "2.4.1",
+  "version": "2.5.0-next.1",
   "description": "A content loader for Astro that uses the PocketBase API",
   "keywords": [
     "astro",
@@ -10,6 +10,13 @@
     "withastro"
   ],
   "homepage": "https://github.com/pawcoding/astro-loader-pocketbase",
+  "bugs": {
+    "url": "https://github.com/pawcoding/astro-loader-pocketbase/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pawcoding/astro-loader-pocketbase.git"
+  },
   "license": "MIT",
   "author": "Luis Wolf <development@pawcode.de> (https://pawcode.de)",
   "type": "module",
@@ -35,26 +42,30 @@
     "test:watch": "vitest watch"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.7.1",
-    "@commitlint/config-conventional": "^19.7.1",
-    "@eslint/js": "^9.20.0",
-    "@stylistic/eslint-plugin": "^3.1.0",
-    "@types/node": "^22.13.4",
-    "@vitest/coverage-v8": "^3.0.5",
-    "astro": "^5.3.0",
-    "eslint": "^9.20.1",
-    "eslint-config-prettier": "^10.0.1",
-    "globals": "^15.15.0",
+    "@commitlint/cli": "^19.8.0",
+    "@commitlint/config-conventional": "^19.8.0",
+    "@eslint/js": "^9.23.0",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@types/node": "^22.13.14",
+    "@vitest/coverage-v8": "^3.0.9",
+    "astro": "^5.5.5",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "globals": "^16.0.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.4.3",
-    "prettier": "^3.5.1",
+    "lint-staged": "^15.5.0",
+    "prettier": "^3.5.3",
     "prettier-plugin-organize-imports": "^4.1.0",
-    "prettier-plugin-packagejson": "^2.5.8",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.24.0",
-    "vitest": "^3.0.5"
+    "prettier-plugin-packagejson": "^2.5.10",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0",
+    "vitest": "^3.0.9"
   },
   "peerDependencies": {
     "astro": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
   }
 }

package/src/loader/handle-realtime-updates.ts

@@ -12,6 +12,14 @@ export async function handleRealtimeUpdates(
   context: LoaderContext,
   options: PocketBaseLoaderOptions
 ): Promise<boolean> {
+  // Check if a custom filter is set
+  if (options.filter) {
+    // Updating an entry directly via realtime updates is not supported when using a custom filter.
+    // This is because the filter can only be applied via the get request and is not considered in the realtime updates.
+    // Updating the entry directly would bypass the filter and could lead to inconsistent data.
+    return false;
+  }
+
   // Check if data was provided via the refresh context
   if (!context.refreshContextData?.data) {
     return false;

package/src/loader/load-entries.ts

@@ -44,14 +44,31 @@ export async function loadEntries(
 
   // Fetch all (modified) entries
   do {
+    // Build search parameters
+    const searchParams = new URLSearchParams({
+      page: `${++page}`,
+      perPage: "100"
+    });
+
+    const filters = [];
+    if (lastModified && options.updatedField) {
+      // If `lastModified` is set, only fetch entries that have been modified since the last fetch
+      filters.push(`(${options.updatedField}>"${lastModified}")`);
+      // Sort by the updated field and id
+      searchParams.set("sort", `-${options.updatedField},id`);
+    }
+    if (options.filter) {
+      filters.push(`(${options.filter})`);
+    }
+
+    // Add filters to search parameters
+    if (filters.length > 0) {
+      searchParams.set("filter", filters.join("&&"));
+    }
+
     // Fetch entries from the collection
-    // If `lastModified` is set, only fetch entries that have been modified since the last fetch
     const collectionRequest = await fetch(
-      `${collectionUrl}?page=${++page}&perPage=100${
-        lastModified && options.updatedField
-          ? `&sort=-${options.updatedField},id&filter=(${options.updatedField}>"${lastModified}")`
-          : ""
-      }`,
+      `${collectionUrl}?${searchParams.toString()}`,
       {
         headers: collectionHeaders
       }

package/src/types/pocketbase-loader-options.type.ts

@@ -73,4 +73,21 @@ export interface PocketBaseLoaderOptions {
    * The PocketBase API does always return at least `0` or `false` as the default values, even though the fields are not marked as required in the schema.
    */
   improveTypes?: boolean;
+  /**
+   * Custom filter that is applied when loading data from PocketBase.
+   * Valid syntax can be found in the [PocketBase documentation](https://pocketbase.io/docs/api-records/#listsearch-records)
+   *
+   * The loader will also add it's own filters for incremental builds.
+   * These will be added to your custom filter query.
+   *
+   * Example:
+   * ```ts
+   * // config:
+   * filter: 'release >= @now && deleted = false'
+   *
+   * // request
+   * `?filter=(${loaderFilter})&&(release >= @now && deleted = false)`
+   * ```
+   */
+  filter?: string;
 }