astro-loader-pocketbase 2.9.0 → 2.10.0-live-expand.1

package/README.md

@@ -309,6 +309,50 @@ const blogLive = defineLiveCollection({
 });
 ```
 
+### Expanding relations
+
+The live loader supports expanding relation fields directly in the API request, which will include the related records in the response.
+This is useful when you need to access related data without making additional requests.
+
+```ts
+const blogLive = defineLiveCollection({
+  loader: experimentalPocketbaseLiveLoader({
+    ...options,
+    experimental: {
+      // Expand single relation field
+      expand: ["author"]
+
+      // Expand multiple relation fields
+      expand: ["author", "category"]
+
+      // Expand nested relations (up to 6 levels deep)
+      expand: ["author.profile", "category.parent"]
+    }
+  })
+});
+```
+
+When you fetch entries with expanded relations, the related records will be available in the `expand` property:
+
+```ts
+const entry = await getLiveEntry("blogLive", { id: "<entry-id>" });
+
+// Access expanded relation data
+console.log(entry.expand.author.name);
+console.log(entry.expand.category.name);
+
+// Access nested expanded relations
+console.log(entry.expand.author.expand.profile.bio);
+```
+
+> [!NOTE]
+> The expand parameter:
+>
+> - Supports up to 6 levels of nested relations (enforced by PocketBase)
+> - Must use separate array entries for each field (e.g., `["author", "category"]` not `["author,category"]`)
+> - Is not compatible with the `fields` option (yet)
+> - Does not support schema generation (yet) - expanded data will have `unknown | undefined` types
+
 ### Error handling
 
 The live content loader follows Astro's standard error handling conventions for live collections. For more information on how to handle errors in your components, see the [Astro documentation on error handling](https://docs.astro.build/en/reference/experimental-flags/live-content-collections/#error-handling).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "2.9.0",
+  "version": "2.10.0-live-expand.1",
   "description": "A content loader for Astro that uses the PocketBase API",
   "keywords": [
     "astro",

package/src/loader/fetch-collection.ts

@@ -9,8 +9,12 @@ import {
 } from "../types/pocketbase-api-response.type";
 import type { PocketBaseEntry } from "../types/pocketbase-entry.type";
 import type { ExperimentalPocketBaseLiveLoaderCollectionFilter } from "../types/pocketbase-live-loader-filter.type";
-import type { PocketBaseLoaderBaseOptions } from "../types/pocketbase-loader-options.type";
+import type {
+  ExperimentalPocketBaseLiveLoaderOptions,
+  PocketBaseLoaderOptions
+} from "../types/pocketbase-loader-options.type";
 import { combineFieldsForRequest } from "../utils/combine-fields-for-request";
+import { formatExpand } from "../utils/format-expand";
 import { formatFields } from "../utils/format-fields";
 
 /**
@@ -28,7 +32,7 @@ export type CollectionFilter = {
  * Fetches entries from a PocketBase collection, optionally filtering by modification date and supporting pagination.
  */
 export async function fetchCollection<TEntry extends PocketBaseEntry>(
-  options: PocketBaseLoaderBaseOptions,
+  options: PocketBaseLoaderOptions | ExperimentalPocketBaseLiveLoaderOptions,
   chunkLoaded: (entries: Array<TEntry>) => Promise<void>,
   token: string | undefined,
   collectionFilter: CollectionFilter | undefined
@@ -124,7 +128,9 @@ export async function fetchCollection<TEntry extends PocketBaseEntry>(
  * Build search parameters for the PocketBase collection request.
  */
 function buildSearchParams(
-  loaderOptions: PocketBaseLoaderBaseOptions,
+  loaderOptions:
+    | PocketBaseLoaderOptions
+    | ExperimentalPocketBaseLiveLoaderOptions,
   combinedFields: Array<string> | undefined,
   collectionFilter: CollectionFilter
 ): URLSearchParams {
@@ -173,5 +179,15 @@ function buildSearchParams(
     searchParams.set("fields", combinedFields.join(","));
   }
 
+  if (loaderOptions.experimental && "expand" in loaderOptions.experimental) {
+    const expandString = formatExpand(
+      loaderOptions.experimental.expand,
+      loaderOptions.collectionName
+    );
+    if (expandString) {
+      searchParams.set("expand", expandString);
+    }
+  }
+
   return searchParams;
 }

package/src/loader/fetch-entry.ts

@@ -6,8 +6,12 @@ import { PocketBaseAuthenticationError } from "../types/errors";
 import { pocketBaseErrorResponse } from "../types/pocketbase-api-response.type";
 import type { PocketBaseEntry } from "../types/pocketbase-entry.type";
 import { pocketBaseEntry } from "../types/pocketbase-entry.type";
-import type { ExperimentalPocketBaseLiveLoaderOptions } from "../types/pocketbase-loader-options.type";
+import type {
+  ExperimentalPocketBaseLiveLoaderOptions,
+  PocketBaseLoaderOptions
+} from "../types/pocketbase-loader-options.type";
 import { combineFieldsForRequest } from "../utils/combine-fields-for-request";
+import { formatExpand } from "../utils/format-expand";
 import { formatFields } from "../utils/format-fields";
 
 /**
@@ -15,7 +19,7 @@ import { formatFields } from "../utils/format-fields";
  */
 export async function fetchEntry<TEntry extends PocketBaseEntry>(
   id: string,
-  options: ExperimentalPocketBaseLiveLoaderOptions,
+  options: PocketBaseLoaderOptions | ExperimentalPocketBaseLiveLoaderOptions,
   token: string | undefined
 ): Promise<TEntry> {
   // Build the URL for the entry endpoint
@@ -31,6 +35,17 @@ export async function fetchEntry<TEntry extends PocketBaseEntry>(
     entryUrl.searchParams.set("fields", combinedFields.join(","));
   }
 
+  // Add expand parameter if specified in experimental options
+  if (options.experimental && "expand" in options.experimental) {
+    const expandString = formatExpand(
+      options.experimental.expand,
+      options.collectionName
+    );
+    if (expandString) {
+      entryUrl.searchParams.set("expand", expandString);
+    }
+  }
+
   // Create the headers for the request to append the token (if available)
   const entryHeaders = new Headers();
   if (token) {

package/src/schema/generate-schema.ts

@@ -84,7 +84,11 @@ export async function generateSchema(
   // Combine the basic schema with the parsed fields
   const schema = z.object({
     ...BASIC_SCHEMA,
-    ...fields
+    ...fields,
+    // Add expand field for live types only mode to support expanded relations
+    ...(options.experimental?.liveTypesOnly && {
+      expand: z.optional(z.unknown())
+    })
   });
 
   // Get all file fields

package/src/types/errors.ts

@@ -17,3 +17,21 @@ export class PocketBaseAuthenticationError extends LiveCollectionError {
     );
   }
 }
+
+/**
+ * Error thrown when there is a configuration issue with the loader.
+ */
+export class PocketBaseConfigurationError extends LiveCollectionError {
+  constructor(collection: string, message: string) {
+    super(collection, message);
+    this.name = "PocketBaseConfigurationError";
+  }
+
+  static is(error: unknown): error is PocketBaseConfigurationError {
+    // This is similar to the original implementation in Astro itself.
+    return (
+      // oxlint-disable-next-line no-unsafe-type-assertion
+      !!error && (error as Error)?.name === "PocketBaseConfigurationError"
+    );
+  }
+}

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

@@ -156,4 +156,33 @@ export type PocketBaseLoaderOptions = PocketBaseLoaderBaseOptions & {
  * @experimental Live content collections are still experimental
  */
 export type ExperimentalPocketBaseLiveLoaderOptions =
-  PocketBaseLoaderBaseOptions;
+  PocketBaseLoaderBaseOptions & {
+    /**
+     * Experimental options for the live loader.
+     *
+     * @experimental All of these options are experimental and may change in the future.
+     */
+    experimental?: {
+      /**
+       * Specify relations to auto expand in the API response.
+       * This can be an array of relation field names to expand.
+       * Supports dot notation for nested relations up to 6 levels deep.
+       *
+       * Note: This option is not compatible with the `fields` option.
+       *
+       * Example:
+       * ```ts
+       * // Using array format:
+       * expand: ['author', 'category']
+       *
+       * // Nested relations:
+       * expand: ['author.profile', 'category.parent']
+       * ```
+       *
+       * @see {@link https://pocketbase.io/docs/working-with-relations/#expanding-relations PocketBase documentation} for valid syntax
+       *
+       * @experimental This feature is experimental and may change in the future
+       */
+      expand?: Array<string>;
+    };
+  };

package/src/types/pocketbase-schema.type.ts

@@ -55,7 +55,12 @@ export const pocketBaseSchemaEntry = z.object({
    * Whether the field is updated when the entry is updated.
    * This is only present on "autodate" fields.
    */
-  onUpdate: z.optional(z.boolean())
+  onUpdate: z.optional(z.boolean()),
+  /**
+   * Id of the associated collection that the relation is referencing.
+   * This is only present on "relation" fields.
+   */
+  collectionId: z.optional(z.string())
 });
 
 /**
@@ -67,6 +72,10 @@ export type PocketBaseSchemaEntry = z.infer<typeof pocketBaseSchemaEntry>;
  * Schema for a PocketBase collection.
  */
 export const pocketBaseCollection = z.object({
+  /**
+   * Id of the collection.
+   */
+  id: z.string(),
   /**
    * Name of the collection.
    */

package/src/utils/format-expand.ts

@@ -0,0 +1,41 @@
+import { PocketBaseConfigurationError } from "../types/errors";
+
+/**
+ * Maximum nesting depth for expand relations as enforced by PocketBase
+ */
+const MAX_EXPAND_DEPTH = 6;
+
+/**
+ * Format and validate expand option for PocketBase API requests.
+ * Validates nesting depth and returns formatted expand string.
+ */
+export function formatExpand(
+  expand: Array<string> | undefined,
+  collectionName: string
+): string | undefined {
+  if (!expand || expand.length === 0) {
+    return undefined;
+  }
+
+  // Validate each expand field for maximum nesting depth and invalid characters
+  for (const field of expand) {
+    // Check for comma in field name
+    if (field.includes(",")) {
+      throw new PocketBaseConfigurationError(
+        collectionName,
+        `Expand field "${field}" contains a comma. Use separate array entries instead of comma-separated values.`
+      );
+    }
+
+    const depth = (field.match(/\./g) || []).length + 1;
+    if (depth > MAX_EXPAND_DEPTH) {
+      throw new PocketBaseConfigurationError(
+        collectionName,
+        `Expand field "${field}" exceeds maximum nesting depth of ${MAX_EXPAND_DEPTH} levels.`
+      );
+    }
+  }
+
+  // Join all expand fields with comma as required by PocketBase
+  return expand.join(",");
+}