astro-loader-pocketbase 2.8.0-next.4 → 2.8.0-next.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "2.8.0-next.4",
+  "version": "2.8.0-next.6",
   "description": "A content loader for Astro that uses the PocketBase API",
   "keywords": [
     "astro",
@@ -47,11 +47,11 @@
     "@commitlint/config-conventional": "^19.8.1",
     "@types/node": "^22.14.1",
     "@vitest/coverage-v8": "^3.2.4",
-    "astro": "^5.13.2",
+    "astro": "^5.13.5",
     "globals": "^16.3.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.1.5",
-    "oxlint": "^1.12.0",
+    "oxlint": "^1.14.0",
     "prettier": "^3.6.2",
     "prettier-plugin-organize-imports": "^4.2.0",
     "prettier-plugin-packagejson": "^2.5.19",

package/src/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 { PocketBaseLoaderBaseOptions } from "../types/pocketbase-loader-options.type";
 
 /**
  * Cleanup entries that are no longer in the collection.
@@ -9,7 +9,7 @@ import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options
  * @param superuserToken Superuser token to access all resources.
  */
 export async function cleanupEntries(
-  options: PocketBaseLoaderOptions,
+  options: PocketBaseLoaderBaseOptions,
   context: LoaderContext,
   superuserToken: string | undefined
 ): Promise<void> {

package/src/loader/fetch-collection.ts

@@ -1,6 +1,6 @@
 import type { PocketBaseEntry } from "../types/pocketbase-entry.type";
 import type { ExperimentalPocketBaseLiveLoaderCollectionFilter } from "../types/pocketbase-live-loader-filter.type";
-import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import type { PocketBaseLoaderBaseOptions } from "../types/pocketbase-loader-options.type";
 import { combineFieldsForRequest } from "../utils/combine-fields-for-request";
 import { formatFields } from "../utils/format-fields";
 
@@ -19,15 +19,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: Pick<
-    PocketBaseLoaderOptions,
-    | "collectionName"
-    | "url"
-    | "updatedField"
-    | "filter"
-    | "fields"
-    | "superuserCredentials"
-  >,
+  options: PocketBaseLoaderBaseOptions,
   chunkLoaded: (entries: Array<TEntry>) => Promise<void>,
   token: string | undefined,
   collectionFilter: CollectionFilter | undefined
@@ -108,7 +100,7 @@ export async function fetchCollection<TEntry extends PocketBaseEntry>(
  * Build search parameters for the PocketBase collection request.
  */
 function buildSearchParams(
-  loaderOptions: Pick<PocketBaseLoaderOptions, "updatedField" | "filter">,
+  loaderOptions: PocketBaseLoaderBaseOptions,
   combinedFields: Array<string> | undefined,
   collectionFilter: CollectionFilter
 ): URLSearchParams {

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

@@ -8,7 +8,7 @@ import type { PocketBaseCollection } from "../types/pocketbase-schema.type";
  * @param token The superuser token to authenticate the request.
  */
 export async function getRemoteSchema(
-  options: PocketBaseLoaderOptions,
+  options: Pick<PocketBaseLoaderOptions, "collectionName" | "url">,
   token: string
 ): Promise<PocketBaseCollection | undefined> {
   // Build URL and headers for the schema request

package/src/types/pocketbase-live-loader-filter.type.ts

@@ -20,8 +20,6 @@ export interface ExperimentalPocketBaseLiveLoaderCollectionFilter {
    * Additional filter to apply to the collection.
    * This will be added to the filter supplied in the {@link ExperimentalPocketBaseLiveLoaderOptions}.
    *
-   * Valid syntax can be found in the [PocketBase documentation](https://pocketbase.io/docs/api-records/#listsearch-records)
-   *
    * Example:
    * ```ts
    * // config:
@@ -30,6 +28,8 @@ export interface ExperimentalPocketBaseLiveLoaderCollectionFilter {
    * // request
    * `?filter=(${loaderFilter})&&(release >= @now && deleted = false)`
    * ```
+   *
+   * @see {@link https://pocketbase.io/docs/api-records/#listsearch-records PocketBase documentation} for valid syntax
    */
   filter?: string;
   /**
@@ -44,8 +44,6 @@ export interface ExperimentalPocketBaseLiveLoaderCollectionFilter {
   /**
    * Sort order in which the entries should be returned.
    *
-   * Valid syntax can be found in the [PocketBase documentation](https://pocketbase.io/docs/api-records/#listsearch-records)
-   *
    * Example:
    * ```ts
    * // config:
@@ -54,6 +52,8 @@ export interface ExperimentalPocketBaseLiveLoaderCollectionFilter {
    * // request
    * `?sort=-created,id`
    * ```
+   *
+   * @see {@link https://pocketbase.io/docs/api-records/#listsearch-records PocketBase documentation} for valid syntax
    */
   sort?: string;
 }

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

@@ -1,9 +1,9 @@
 import type { z } from "astro/zod";
 
 /**
- * Options for the PocketBase loader.
+ * Options for both build time and live collection loader
  */
-export interface PocketBaseLoaderOptions {
+export interface PocketBaseLoaderBaseOptions {
   /**
    * URL of the PocketBase instance.
    */
@@ -12,15 +12,6 @@ export interface PocketBaseLoaderOptions {
    * Name of the collection in PocketBase.
    */
   collectionName: string;
-  /**
-   * Field that should be used as the unique identifier for the collection.
-   * This must be the name of a field in the collection that contains unique values.
-   * If not provided, the `id` field will be used.
-   * The value of this field will be used in `getEntry` and `getEntries` to load the entry or entries.
-   *
-   * If the field is a string, it will be slugified to be used in the URL.
-   */
-  idField?: string;
   /**
    * Name of the field(s) containing the content of an entry.
    * This must be the name of a field in the PocketBase collection that contains the content.
@@ -34,7 +25,8 @@ export interface PocketBaseLoaderOptions {
   /**
    * Name of the field containing the last update date of an entry.
    * Ideally, this field should be of type `autodate` and have the value "Update" or "Create/Update".
-   * This field is used to only fetch entries that have been modified since the last build.
+   * For the build time loader, this field is used to only fetch entries that have been modified since the last build.
+   * For the live collection loader, this field is used to set the `lastModified` cache hint.
    */
   updatedField?: string;
   /**
@@ -105,6 +97,21 @@ export interface PocketBaseLoaderOptions {
          */
         impersonateToken: string;
       };
+}
+
+/**
+ * Options for the PocketBase loader.
+ */
+export type PocketBaseLoaderOptions = PocketBaseLoaderBaseOptions & {
+  /**
+   * Field that should be used as the unique identifier for the collection.
+   * This must be the name of a field in the collection that contains unique values.
+   * If not provided, the `id` field will be used.
+   * The value of this field will be used in `getEntry` and `getEntries` to load the entry or entries.
+   *
+   * If the field is a string, it will be slugified to be used in the URL.
+   */
+  idField?: string;
   /**
    * File path to the local schema file.
    * This file will be used to generate the schema for the collection.
@@ -141,20 +148,12 @@ export interface PocketBaseLoaderOptions {
      */
     liveTypesOnly?: boolean;
   };
-}
+};
 
 /**
  * Options for the PocketBase live loader.
  *
  * @experimental Live content collections are still experimental
  */
-export type ExperimentalPocketBaseLiveLoaderOptions = Pick<
-  PocketBaseLoaderOptions,
-  | "url"
-  | "collectionName"
-  | "contentFields"
-  | "updatedField"
-  | "filter"
-  | "fields"
-  | "superuserCredentials"
->;
+export type ExperimentalPocketBaseLiveLoaderOptions =
+  PocketBaseLoaderBaseOptions;

package/src/utils/combine-fields-for-request.ts

@@ -1,4 +1,7 @@
-import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import type {
+  PocketBaseLoaderBaseOptions,
+  PocketBaseLoaderOptions
+} from "../types/pocketbase-loader-options.type";
 
 /**
  * Combine basic, special, and user-specified fields for PocketBase API requests.
@@ -10,10 +13,8 @@ import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options
  */
 export function combineFieldsForRequest(
   userFields: Array<string> | undefined,
-  options: Pick<
-    PocketBaseLoaderOptions,
-    "idField" | "updatedField" | "contentFields"
-  >
+  options: Pick<PocketBaseLoaderBaseOptions, "updatedField" | "contentFields"> &
+    Pick<PocketBaseLoaderOptions, "idField">
 ): Array<string> | undefined {
   // If no fields specified, return undefined to get all fields
   if (!userFields) {

package/src/utils/create-token-promise.ts

@@ -1,11 +1,11 @@
-import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import type { PocketBaseLoaderBaseOptions } from "../types/pocketbase-loader-options.type";
 import { getSuperuserToken } from "./get-superuser-token";
 
 /**
  * Creates a promise that resolves to a superuser token or undefined.
  */
 export async function createTokenPromise(
-  options: Pick<PocketBaseLoaderOptions, "url" | "superuserCredentials">
+  options: Pick<PocketBaseLoaderBaseOptions, "superuserCredentials" | "url">
 ): Promise<string | undefined> {
   if (options.superuserCredentials) {
     if ("impersonateToken" in options.superuserCredentials) {

package/src/utils/format-fields.ts

@@ -1,4 +1,4 @@
-import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options.type";
+import type { PocketBaseLoaderBaseOptions } from "../types/pocketbase-loader-options.type";
 
 /**
  * Format fields option into an array and validate for expand usage.
@@ -8,7 +8,7 @@ import type { PocketBaseLoaderOptions } from "../types/pocketbase-loader-options
  * @returns Formatted fields array, or undefined if no fields specified or "*" wildcard is used
  */
 export function formatFields(
-  fields: PocketBaseLoaderOptions["fields"]
+  fields: PocketBaseLoaderBaseOptions["fields"]
 ): Array<string> | undefined {
   if (!fields || fields.length === 0) {
     return undefined;