astro-loader-pocketbase 2.3.0 → 2.3.1

package/package.json

@@ -1,41 +1,60 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "A content loader for Astro that uses the PocketBase API",
+  "keywords": [
+    "astro",
+    "astro-content-loader",
+    "astro-loader",
+    "pocketbase",
+    "withastro"
+  ],
+  "homepage": "https://github.com/pawcoding/astro-loader-pocketbase",
   "license": "MIT",
   "author": "Luis Wolf <development@pawcode.de> (https://pawcode.de)",
-  "homepage": "https://github.com/pawcoding/astro-loader-pocketbase",
   "type": "module",
   "exports": {
-    ".": "./index.ts"
+    ".": "./src/index.ts"
   },
   "files": [
-    "index.ts",
     "src"
   ],
   "scripts": {
-    "lint": "npx eslint",
-    "prepare": "husky"
-  },
-  "peerDependencies": {
-    "astro": "^5.0.0"
+    "format": "npx prettier . --write --cache",
+    "format:check": "npx prettier . --check --cache",
+    "lint": "npx eslint --cache",
+    "lint:fix": "npx eslint --fix --cache",
+    "prepare": "husky",
+    "test": "vitest run",
+    "test:e2e": "vitest run $(find test -name '*.e2e-spec.ts')",
+    "test:e2e:pocketbase": "npm run test:e2e:setup && ./.pocketbase/pocketbase serve",
+    "test:e2e:setup": "./scripts/setup-pocketbase.sh",
+    "test:e2e:watch": "vitest watch $(find test -name '*.e2e-spec.ts')",
+    "test:unit": "vitest run $(find test -name '*.spec.ts')",
+    "test:unit:watch": "vitest watch $(find test -name '*.spec.ts')",
+    "test:watch": "vitest watch"
   },
   "devDependencies": {
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
     "@eslint/js": "^9.19.0",
     "@stylistic/eslint-plugin": "^3.0.1",
     "@types/node": "^22.13.0",
+    "@vitest/coverage-v8": "^3.0.4",
     "astro": "^5.2.3",
     "eslint": "^9.19.0",
+    "eslint-config-prettier": "^10.0.1",
     "globals": "^15.14.0",
     "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
+    "prettier": "^3.4.2",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "prettier-plugin-packagejson": "^2.5.8",
     "typescript": "^5.7.3",
-    "typescript-eslint": "^8.22.0"
+    "typescript-eslint": "^8.22.0",
+    "vitest": "^3.0.4"
   },
-  "keywords": [
-    "astro",
-    "astro-content-loader",
-    "astro-loader",
-    "pocketbase",
-    "withastro"
-  ]
+  "peerDependencies": {
+    "astro": "^5.0.0"
+  }
 }

package/src/index.ts

@@ -0,0 +1,5 @@
+import { pocketbaseLoader } from "./pocketbase-loader";
+import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.type";
+
+export { pocketbaseLoader };
+export type { PocketBaseLoaderOptions };

package/src/{cleanup-entries.ts → loader/cleanup-entries.ts}

@@ -1,5 +1,5 @@
 import type { LoaderContext } from "astro/loaders";
-import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.type";
+import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
 
 /**
  * Cleanup entries that are no longer in the collection.

package/src/{handle-realtime-updates.ts → loader/handle-realtime-updates.ts}

@@ -1,7 +1,7 @@
 import type { LoaderContext } from "astro/loaders";
-import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.type";
-import { isRealtimeData } from "./utils/is-realtime-data";
-import { parseEntry } from "./utils/parse-entry";
+import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import { isRealtimeData } from "../utils/is-realtime-data";
+import { parseEntry } from "./parse-entry";
 
 /**
  * Handles realtime updates for the loader without making any new network requests.

package/src/{load-entries.ts → loader/load-entries.ts}

@@ -1,6 +1,6 @@
 import type { LoaderContext } from "astro/loaders";
-import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.type";
-import { parseEntry } from "./utils/parse-entry";
+import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import { parseEntry } from "./parse-entry";
 
 /**
  * Load (modified) entries from a PocketBase collection.

package/src/loader/loader.ts

@@ -0,0 +1,78 @@
+import type { LoaderContext } from "astro/loaders";
+import packageJson from "../../package.json";
+import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import { getSuperuserToken } from "../utils/get-superuser-token";
+import { shouldRefresh } from "../utils/should-refresh";
+import { cleanupEntries } from "./cleanup-entries";
+import { handleRealtimeUpdates } from "./handle-realtime-updates";
+import { loadEntries } from "./load-entries";
+
+export async function loader(
+  context: LoaderContext,
+  options: PocketBaseLoaderOptions
+): Promise<void> {
+  context.logger.label = `pocketbase-loader:${options.collectionName}`;
+
+  // Check if the collection should be refreshed.
+  const refresh = shouldRefresh(
+    context.refreshContextData,
+    options.collectionName
+  );
+  if (!refresh) {
+    return;
+  }
+
+  // Handle realtime updates
+  const handled = await handleRealtimeUpdates(context, options);
+  if (handled) {
+    return;
+  }
+
+  // Get the date of the last fetch to only update changed entries.
+  let lastModified = context.meta.get("last-modified");
+
+  // Check if the version has changed to force an update
+  const lastVersion = context.meta.get("version");
+  if (lastVersion !== packageJson.version) {
+    if (lastVersion) {
+      context.logger.info(
+        `PocketBase loader was updated from ${lastVersion} to ${packageJson.version}. All entries will be loaded again.`
+      );
+    }
+
+    // Disable incremental builds and clear the store
+    lastModified = undefined;
+    context.store.clear();
+  }
+
+  // Disable incremental builds if no updated field is provided
+  if (!options.updatedField) {
+    context.logger.info(
+      `No "updatedField" was provided. Incremental builds are disabled.`
+    );
+    lastModified = undefined;
+  }
+
+  // Try to get a superuser token to access all resources.
+  let token: string | undefined;
+  if (options.superuserCredentials) {
+    token = await getSuperuserToken(
+      options.url,
+      options.superuserCredentials,
+      context.logger
+    );
+  }
+
+  if (context.store.keys().length > 0) {
+    // Cleanup entries that are no longer in the collection
+    await cleanupEntries(options, context, token);
+  }
+
+  // Load the (modified) entries
+  await loadEntries(options, context, token, lastModified);
+
+  // Set the last modified date to the current date
+  context.meta.set("last-modified", new Date().toISOString().replace("T", " "));
+
+  context.meta.set("version", packageJson.version);
+}

package/src/{utils → loader}/parse-entry.ts

@@ -1,7 +1,7 @@
 import type { LoaderContext } from "astro/loaders";
 import type { PocketBaseEntry } from "../types/pocketbase-entry.type";
 import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
-import { slugify } from "./slugify";
+import { slugify } from "../utils/slugify";
 
 /**
  * Parse an entry from PocketBase to match the schema and store it in the store.

package/src/pocketbase-loader.ts

@@ -1,13 +1,7 @@
-import type { Loader, LoaderContext } from "astro/loaders";
-import type { ZodSchema } from "astro/zod";
-import packageJson from "./../package.json";
-import { cleanupEntries } from "./cleanup-entries";
-import { generateSchema } from "./generate-schema";
-import { handleRealtimeUpdates } from "./handle-realtime-updates";
-import { loadEntries } from "./load-entries";
+import type { Loader } from "astro/loaders";
+import { loader } from "./loader/loader";
+import { generateSchema } from "./schema/generate-schema";
 import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.type";
-import { getSuperuserToken } from "./utils/get-superuser-token";
-import { shouldRefresh } from "./utils/should-refresh";
 
 /**
  * Loader for collections stored in PocketBase.
@@ -17,78 +11,9 @@ import { shouldRefresh } from "./utils/should-refresh";
 export function pocketbaseLoader(options: PocketBaseLoaderOptions): Loader {
   return {
     name: "pocketbase-loader",
-    load: async (context: LoaderContext): Promise<void> => {
-      context.logger.label = `pocketbase-loader:${options.collectionName}`;
-
-      // Check if the collection should be refreshed.
-      const refresh = shouldRefresh(
-        context.refreshContextData,
-        options.collectionName
-      );
-      if (!refresh) {
-        return;
-      }
-
-      // Handle realtime updates
-      const handled = await handleRealtimeUpdates(context, options);
-      if (handled) {
-        return;
-      }
-
-      // Get the date of the last fetch to only update changed entries.
-      let lastModified = context.meta.get("last-modified");
-
-      // Check if the version has changed to force an update
-      const lastVersion = context.meta.get("version");
-      if (lastVersion !== packageJson.version) {
-        if (lastVersion) {
-          context.logger.info(
-            `PocketBase loader was updated from ${lastVersion} to ${packageJson.version}. All entries will be loaded again.`
-          );
-        }
-
-        // Disable incremental builds and clear the store
-        lastModified = undefined;
-        context.store.clear();
-      }
-
-      // Disable incremental builds if no updated field is provided
-      if (!options.updatedField) {
-        context.logger.info(
-          `No "updatedField" was provided. Incremental builds are disabled.`
-        );
-        lastModified = undefined;
-      }
-
-      // Try to get a superuser token to access all resources.
-      let token: string | undefined;
-      if (options.superuserCredentials) {
-        token = await getSuperuserToken(
-          options.url,
-          options.superuserCredentials,
-          context.logger
-        );
-      }
-
-      if (context.store.keys().length > 0) {
-        // Cleanup entries that are no longer in the collection
-        await cleanupEntries(options, context, token);
-      }
-
-      // Load the (modified) entries
-      await loadEntries(options, context, token, lastModified);
-
-      // Set the last modified date to the current date
-      context.meta.set(
-        "last-modified",
-        new Date().toISOString().replace("T", " ")
-      );
-
-      context.meta.set("version", packageJson.version);
-    },
-    schema: async (): Promise<ZodSchema> => {
-      // Generate the schema for the collection according to the API
-      return await generateSchema(options);
-    }
+    // Load the entries from the collection
+    load: async (context) => loader(context, options),
+    // Generate the schema for the collection according to the API
+    schema: async () => await generateSchema(options)
   };
 }

package/src/{generate-schema.ts → schema/generate-schema.ts}

@@ -1,11 +1,11 @@
 import type { ZodSchema } from "astro/zod";
 import { z } from "astro/zod";
-import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.type";
-import type { PocketBaseCollection } from "./types/pocketbase-schema.type";
-import { getRemoteSchema } from "./utils/get-remote-schema";
-import { parseSchema } from "./utils/parse-schema";
-import { readLocalSchema } from "./utils/read-local-schema";
-import { transformFiles } from "./utils/transform-files";
+import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import type { PocketBaseCollection } from "../types/pocketbase-schema.type";
+import { getRemoteSchema } from "./get-remote-schema";
+import { parseSchema } from "./parse-schema";
+import { readLocalSchema } from "./read-local-schema";
+import { transformFiles } from "./transform-files";
 
 /**
  * Basic schema for every PocketBase collection.

package/src/{utils → schema}/get-remote-schema.ts

@@ -1,6 +1,6 @@
 import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
 import type { PocketBaseCollection } from "../types/pocketbase-schema.type";
-import { getSuperuserToken } from "./get-superuser-token";
+import { getSuperuserToken } from "../utils/get-superuser-token";
 
 /**
  * Fetches the schema for the specified collection from the PocketBase instance.

package/src/{utils → schema}/transform-files.ts

@@ -56,7 +56,7 @@ export function transformFiles(
  * @param entryId ID of the entry.
  * @param file Name of the file.
  */
-function transformFileUrl(
+export function transformFileUrl(
   base: string,
   collectionName: string,
   entryId: string,

package/index.ts

@@ -1,5 +0,0 @@
-import { pocketbaseLoader } from "./src/pocketbase-loader";
-import type { PocketBaseLoaderOptions } from "./src/types/pocketbase-loader-options.type";
-
-export { pocketbaseLoader };
-export type { PocketBaseLoaderOptions };