astro-loader-pocketbase 2.1.0 → 2.2.0-next.1

package/README.md

@@ -108,6 +108,24 @@ The loader will also automatically convert the value into a slug to be easily us
 It's recommended to use e.g. the title of the entry to be easily searchable and readable.
 **Do not use e.g. rich text fields as ids.**
 
+### Improved type safety
+
+By default PocketBase reports `number` and `boolean` fields as not required.
+This means that the loader will add `undefined` to the type of these fields.
+If you want to enforce that these fields are always present, you can set the `improveTypes` option to `true`.
+
+```ts
+const blog = defineCollection({
+  loader: pocketbaseLoader({
+    ...options,
+    improveTypes: true
+  })
+});
+```
+
+This will remove `undefined` from the type of these fields and provide default values with `0` and `false` respectively.
+PocketBase will also use these default values when creating new entries in the dashboard.
+
 ## Type generation
 
 The loader can automatically generate types for your collection.
@@ -167,6 +185,7 @@ This manual schema will **always override the automatic type generation**.
 | `superuserCredentials` | `{ email: string, password: string }` |          | The email and password of the superuser of the PocketBase instance. This is used for automatic type generation. |
 | `localSchema`          | `string`                              |          | The path to a local schema file. This is used for automatic type generation.                                    |
 | `jsonSchemas`          | `Record<string, z.ZodSchema>`         |          | A record of Zod schemas to use for type generation of `json` fields.                                            |
+| `improveTypes`         | `boolean`                             |          | Whether to improve the types of `number` and `boolean` fields, removing `undefined` from them.                  |
 
 ## Special cases
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-loader-pocketbase",
-  "version": "2.1.0",
+  "version": "2.2.0-next.1",
   "description": "A content loader for Astro that uses the PocketBase API",
   "license": "MIT",
   "author": "Luis Wolf <development@pawcode.de> (https://pawcode.de)",

package/src/generate-schema.ts

@@ -60,7 +60,8 @@ export async function generateSchema(
   const fields = parseSchema(
     collection,
     options.jsonSchemas,
-    hasSuperuserRights
+    hasSuperuserRights,
+    options.improveTypes ?? false
   );
 
   // Check if custom id field is present

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

@@ -65,4 +65,13 @@ export interface PocketBaseLoaderOptions {
    * Note that this will only be used for fields of type `json`.
    */
   jsonSchemas?: Record<string, z.ZodSchema>;
+  /**
+   * Whether to improve the types of the generated schema.
+   * This includes providing `0` or `false` as default values for number and boolean fields, respectively.
+   * With this option enabled, the schema will not generate `undefined` as possible value for number and boolean fields.
+   *
+   * Why do we need this option?
+   * PocketBase does use these values as the default values, even though it's not specified in the schema.
+   */
+  improveTypes?: boolean;
 }

package/src/utils/parse-schema.ts

@@ -7,7 +7,8 @@ import type {
 export function parseSchema(
   collection: PocketBaseCollection,
   customSchemas: Record<string, z.ZodType> | undefined,
-  hasSuperuserRights: boolean
+  hasSuperuserRights: boolean,
+  improveTypes: boolean
 ): Record<string, z.ZodType> {
   // Prepare the schemas fields
   const fields: Record<string, z.ZodType> = {};
@@ -73,9 +74,26 @@ export function parseSchema(
         break;
     }
 
-    // Check if the field is required (onCreate autodate fields are always set)
     const isRequired =
-      field.required || (field.type === "autodate" && field.onCreate);
+      // Check if the field is required
+      field.required ||
+      // `onCreate autodate` fields are always set
+      (field.type === "autodate" && field.onCreate) ||
+      // Improve number and boolean types by providing default values
+      (improveTypes && (field.type === "number" || field.type === "bool"));
+
+    if (improveTypes) {
+      switch (field.type) {
+        case "number":
+          // If the field is a number, provide a default value of 0
+          fieldType = fieldType.default(0);
+          break;
+        case "bool":
+          // If the field is a boolean, provide a default value of false
+          fieldType = fieldType.default(false);
+          break;
+      }
+    }
 
     // If the field is not required, mark it as optional
     if (!isRequired) {