astro-loader-pocketbase 3.0.0 → 3.1.0-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "3.0.0",
+  "version": "3.1.0-next.1",
   "description": "A content loader for Astro that uses the PocketBase API",
   "keywords": [
     "astro",
@@ -44,26 +44,26 @@
     "test:unit": "vitest run $(find test -name '*.spec.ts')",
     "test:unit:watch": "vitest watch $(find test -name '*.spec.ts')",
     "test:watch": "vitest watch",
-    "typecheck": "npx @typescript/native-preview --noEmit"
+    "typecheck": "npx @typescript/native-preview --noEmit -p src/tsconfig.json && npx @typescript/native-preview --noEmit -p test/tsconfig.json"
   },
   "devDependencies": {
     "@commitlint/cli": "20.5.0",
     "@commitlint/config-conventional": "20.5.0",
     "@types/node": "24.10.1",
-    "@vitest/coverage-v8": "4.1.0",
-    "astro": "6.0.8",
-    "globals": "17.4.0",
+    "@vitest/coverage-v8": "4.1.4",
+    "astro": "6.1.8",
+    "globals": "17.5.0",
     "husky": "9.1.7",
     "lint-staged": "16.4.0",
-    "oxfmt": "0.41.0",
-    "oxlint": "1.56.0",
-    "oxlint-tsgolint": "0.17.1",
-    "vitest": "4.1.0",
+    "oxfmt": "0.45.0",
+    "oxlint": "1.60.0",
+    "oxlint-tsgolint": "0.21.1",
+    "vitest": "4.1.4",
     "zod-to-ts": "2.0.0"
   },
   "peerDependencies": {
     "astro": "^6.0.0",
     "zod-to-ts": "^2.0.0"
   },
-  "packageManager": "npm@11.12.0"
+  "packageManager": "npm@11.12.1"
 }

package/src/pocketbase-loader.ts

@@ -43,7 +43,6 @@ export function pocketbaseLoader(options: PocketBaseLoaderOptions) {
       // Load the entries from the collection
       await loader(context, options, token);
     },
-    // oxlint-disable-next-line explicit-module-boundary-types
     createSchema: async () => {
       const token = await tokenPromise;
 

package/src/schema/generate-schema.ts

@@ -13,9 +13,19 @@ import { transformFiles } from "./transform-files";
  * Basic schema for every PocketBase collection.
  */
 const BASIC_SCHEMA = z.object({
-  id: z.string(),
-  collectionId: z.string(),
-  collectionName: z.string()
+  id: z.string().meta({
+    title: "id",
+    description: "The unique identifier for the entry."
+  }),
+  collectionId: z.string().meta({
+    title: "collectionId",
+    description:
+      "The unique identifier for the collection the entity belongs to."
+  }),
+  collectionName: z.string().meta({
+    title: "collectionName",
+    description: "The name of the collection the entity belongs to."
+  })
 });
 
 /**

package/src/schema/parse-schema.ts

@@ -45,7 +45,6 @@ export function parseSchema(
     let fieldType: z.ZodType;
 
     // Determine the field type and create the corresponding Zod type
-    // oxlint-disable-next-line switch-exhaustiveness-check
     switch (field.type) {
       case "number":
         fieldType = z.number();
@@ -93,13 +92,8 @@ export function parseSchema(
         fieldType = parseSingleOrMultipleValues(field, z.string());
         break;
       case "json":
-        if (customSchemas?.[field.name]) {
-          // Use the user defined custom schema for the field
-          fieldType = customSchemas[field.name];
-        } else {
-          // Parse the field as unknown JSON
-          fieldType = z.unknown();
-        }
+        // Use the user defined custom schema for the field or fallback to unknown
+        fieldType = customSchemas?.[field.name] ?? z.unknown();
         break;
       default:
         // Default to a string
@@ -125,7 +119,11 @@ export function parseSchema(
     }
 
     // Add the field to the fields object
-    fields[field.name] = fieldType;
+    fields[field.name] = fieldType.meta({
+      id: field.id,
+      title: field.name,
+      description: getFieldDescription(field)
+    });
   }
 
   return fields;
@@ -150,3 +148,23 @@ function parseSingleOrMultipleValues(
 
   return z.array(type);
 }
+
+/**
+ * Get the description for a field based on its help text and type.
+ */
+function getFieldDescription(field: PocketBaseSchemaEntry): string | undefined {
+  switch (true) {
+    case !!field.help:
+      return field.help;
+    case field.type === "autodate" && field.onUpdate:
+      return "Date when the entry was last updated. This field is automatically updated by PocketBase whenever the entry is updated.";
+    case field.type === "autodate" && field.onCreate:
+      return "Date when the entry was created. This field is automatically set by PocketBase when the entry is created.";
+    case field.name === "id":
+      return "The unique identifier for the entry.";
+    case field.hidden:
+      return "This field is hidden and may require superuser credentials to access.";
+    default:
+      return undefined;
+  }
+}

package/src/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "noUncheckedIndexedAccess": true
+  }
+}

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

@@ -9,10 +9,19 @@ export const pocketBaseSchemaEntry = z.object({
    * Hidden fields are not returned in the API response.
    */
   hidden: z.optional(z.boolean()),
+  /**
+   * Unique identifier for the field.
+   */
+  id: z.string(),
   /**
    * Name of the field.
    */
   name: z.string(),
+  /**
+   * Help text for the field.
+   * This is only present if the field has help text defined.
+   */
+  help: z.optional(z.string()),
   /**
    * Type of the field.
    */

package/src/utils/extract-field-names.ts

@@ -11,5 +11,5 @@ export function extractFieldNames(
     return undefined;
   }
 
-  return fields.map((field) => field.split(":")[0]);
+  return fields.map((field) => field.split(":").at(0) ?? field);
 }

package/src/utils/format-fields.ts

@@ -49,7 +49,10 @@ function splitFieldsString(fieldsString: string): Array<string> {
 
   const fields: Array<string> = [];
   for (let i = 0; i < initialSplit.length; i++) {
-    const part = initialSplit[i];
+    const part = initialSplit.at(i);
+    if (!part) {
+      continue;
+    }
 
     if (part.includes("(") && !part.includes(")")) {
       fields.push(`${part},${initialSplit[++i]}`);