astro-loader-pocketbase 2.6.2 → 2.7.0-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "2.6.2",
+  "version": "2.7.0-next.1",
   "description": "A content loader for Astro that uses the PocketBase API",
   "keywords": [
     "astro",
@@ -39,7 +39,8 @@
     "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"
+    "test:watch": "vitest watch",
+    "typecheck": "npx tsc --noEmit"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",

package/src/loader/cleanup-entries.ts

@@ -56,9 +56,16 @@ export async function cleanupEntries(
     if (!collectionRequest.ok) {
       // If the collection is locked, an superuser token is required
       if (collectionRequest.status === 403) {
-        context.logger.error(
-          `The collection is not accessible without superuser rights. Please provide superuser credentials in the config.`
-        );
+        if (
+          options.superuserCredentials &&
+          "impersonateToken" in options.superuserCredentials
+        ) {
+          context.logger.error("The given impersonate token is not valid.");
+        } else {
+          context.logger.error(
+            "The collection is not accessible without superuser rights. Please provide superuser credentials in the config."
+          );
+        }
       } else {
         const reason = await collectionRequest
           .json()

package/src/loader/load-entries.ts

@@ -9,8 +9,6 @@ import { parseEntry } from "./parse-entry";
  * @param context Context of the loader.
  * @param superuserToken Superuser token to access all resources.
  * @param lastModified Date of the last fetch to only update changed entries.
- *
- * @returns `true` if the collection has an updated column, `false` otherwise.
  */
 export async function loadEntries(
   options: PocketBaseLoaderOptions,
@@ -78,9 +76,16 @@ export async function loadEntries(
     if (!collectionRequest.ok) {
       // If the collection is locked, an superuser token is required
       if (collectionRequest.status === 403) {
-        throw new Error(
-          `The collection is not accessible without superuser rights. Please provide superuser credentials in the config.`
-        );
+        if (
+          options.superuserCredentials &&
+          "impersonateToken" in options.superuserCredentials
+        ) {
+          throw new Error("The given impersonate token is not valid.");
+        } else {
+          throw new Error(
+            "The collection is not accessible without superuser rights. Please provide superuser credentials in the config."
+          );
+        }
       }
 
       // Get the reason for the error

package/src/loader/loader.ts

@@ -1,15 +1,18 @@
 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";
 
+/**
+ * Load entries from a PocketBase collection.
+ */
 export async function loader(
   context: LoaderContext,
-  options: PocketBaseLoaderOptions
+  options: PocketBaseLoaderOptions,
+  token: string | undefined
 ): Promise<void> {
   context.logger.label = `pocketbase-loader:${options.collectionName}`;
 
@@ -59,16 +62,6 @@ export async function loader(
     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);

package/src/pocketbase-loader.ts

@@ -1,7 +1,9 @@
 import type { Loader } from "astro/loaders";
+import type { ZodSchema } from "astro/zod";
 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";
 
 /**
  * Loader for collections stored in PocketBase.
@@ -9,11 +11,38 @@ import type { PocketBaseLoaderOptions } from "./types/pocketbase-loader-options.
  * @param options Options for the loader. See {@link PocketBaseLoaderOptions} for more details.
  */
 export function pocketbaseLoader(options: PocketBaseLoaderOptions): Loader {
+  let tokenPromise: Promise<string | undefined>;
+  if (options.superuserCredentials) {
+    if ("impersonateToken" in options.superuserCredentials) {
+      // Impersonate token provided, so use it directly.
+      tokenPromise = Promise.resolve(
+        options.superuserCredentials.impersonateToken
+      );
+    } else {
+      // Email and password provided, so get a temporary superuser token.
+      tokenPromise = getSuperuserToken(
+        options.url,
+        options.superuserCredentials
+      );
+    }
+  } else {
+    // No credentials provided, so no token can be used.
+    tokenPromise = Promise.resolve(undefined);
+  }
+
   return {
     name: "pocketbase-loader",
-    // 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)
+    load: async (context): Promise<void> => {
+      const token = await tokenPromise;
+
+      // Load the entries from the collection
+      await loader(context, options, token);
+    },
+    schema: async (): Promise<ZodSchema> => {
+      const token = await tokenPromise;
+
+      // Generate the schema for the collection according to the API
+      return await generateSchema(options, token);
+    }
   };
 }

package/src/schema/generate-schema.ts

@@ -28,14 +28,18 @@ const VALID_ID_TYPES = ["text", "number", "email", "url", "date"];
  * If a path to a local schema file is provided, the schema is read from the file.
  *
  * @param options Options for the loader. See {@link PocketBaseLoaderOptions} for more details.
+ * @param token The superuser token to authenticate the request.
  */
 export async function generateSchema(
-  options: PocketBaseLoaderOptions
+  options: PocketBaseLoaderOptions,
+  token: string | undefined
 ): Promise<ZodSchema> {
   let collection: PocketBaseCollection | undefined;
 
-  // Try to get the schema directly from the PocketBase instance
-  collection = await getRemoteSchema(options);
+  if (token) {
+    // Try to get the schema directly from the PocketBase instance
+    collection = await getRemoteSchema(options, token);
+  }
 
   const hasSuperuserRights = !!collection || !!options.superuserCredentials;
 

package/src/schema/get-remote-schema.ts

@@ -1,30 +1,16 @@
 import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
 import type { PocketBaseCollection } from "../types/pocketbase-schema.type";
-import { getSuperuserToken } from "../utils/get-superuser-token";
 
 /**
  * Fetches the schema for the specified collection from the PocketBase instance.
  *
  * @param options Options for the loader. See {@link PocketBaseLoaderOptions} for more details.
+ * @param token The superuser token to authenticate the request.
  */
 export async function getRemoteSchema(
-  options: PocketBaseLoaderOptions
+  options: PocketBaseLoaderOptions,
+  token: string
 ): Promise<PocketBaseCollection | undefined> {
-  if (!options.superuserCredentials) {
-    return undefined;
-  }
-
-  // Get a superuser token
-  const token = await getSuperuserToken(
-    options.url,
-    options.superuserCredentials
-  );
-
-  // If the token is invalid try another method
-  if (!token) {
-    return undefined;
-  }
-
   // Build URL and headers for the schema request
   const schemaUrl = new URL(
     `api/collections/${options.collectionName}`,

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

@@ -58,16 +58,24 @@ export interface PocketBaseLoaderOptions {
    * Credentials of a superuser to get full access to the PocketBase instance.
    * This is required to get automatic type generation without a local schema, to access all resources even if they are not public and to fetch content of hidden fields.
    */
-  superuserCredentials?: {
-    /**
-     * Email of the superuser.
-     */
-    email: string;
-    /**
-     * Password of the superuser.
-     */
-    password: string;
-  };
+  superuserCredentials?:
+    | {
+        /**
+         * Email of the superuser.
+         */
+        email: string;
+        /**
+         * Password of the superuser.
+         */
+        password: string;
+      }
+    | {
+        /**
+         * Impersonate auth token of the superuser.
+         * This token will take precedence over the email and password.
+         */
+        impersonateToken: string;
+      };
   /**
    * File path to the local schema file.
    * This file will be used to generate the schema for the collection.