pocketbase-zod-schema 0.3.0 → 0.3.2

package/dist/cli/utils/index.d.cts

@@ -1,6 +1,6 @@
 import { Ora } from 'ora';
-import { e as SchemaDiff } from '../../types-YoBjsa-A.cjs';
-import '../../fields-UcOPu1OQ.cjs';
+import { e as SchemaDiff } from '../../types-CVxPCgWX.cjs';
+import '../../fields-DBBm06VU.cjs';
 import 'zod';
 import '../../permissions-ZHafVSIx.cjs';
 

package/dist/cli/utils/index.d.ts

@@ -1,6 +1,6 @@
 import { Ora } from 'ora';
-import { e as SchemaDiff } from '../../types-Ds3NQvny.js';
-import '../../fields-UcOPu1OQ.js';
+import { e as SchemaDiff } from '../../types-Dfp-NP2D.js';
+import '../../fields-DBBm06VU.js';
 import 'zod';
 import '../../permissions-ZHafVSIx.js';
 

package/dist/{fields-UcOPu1OQ.d.cts → fields-DBBm06VU.d.cts}

@@ -116,6 +116,15 @@ interface SelectFieldOptions {
      */
     maxSelect?: number;
 }
+/**
+ * Human-friendly byte size input.
+ *
+ * - Use a number for raw bytes (e.g. `5242880`)
+ * - Use a string with unit suffix for kibibytes/mebibytes/gibibytes (e.g. `"5M"`, `"1G"`)
+ *
+ * Supported suffixes: `K`, `M`, `G` (case-insensitive).
+ */
+type ByteSize = number | `${number}${"K" | "M" | "G" | "k" | "m" | "g"}`;
 /**
  * File field configuration options
  */
@@ -126,12 +135,23 @@ interface FileFieldOptions {
      */
     mimeTypes?: string[];
     /**
-     * Maximum file size in bytes
+     * Maximum file size.
+     *
+     * - Provide a number for raw bytes
+     * - Or use a string with `K`, `M`, `G` suffix (case-insensitive)
+     *
+     * Max allowed is `8G`.
+     *
+     * @example
+     * maxSize: 5242880
+     * maxSize: "5M"
+     * maxSize: "1G"
      */
-    maxSize?: number;
+    maxSize?: ByteSize;
     /**
      * Thumbnail sizes to generate
      * Example: ["100x100", "200x200"]
+     * Set to null to explicitly disable thumbnails
      */
     thumbs?: string[];
     /**
@@ -298,29 +318,37 @@ declare function SelectField<T extends [string, ...string[]]>(values: T, options
  * Maps to PocketBase 'file' field type with maxSelect=1
  *
  * @param options - Optional file constraints
- * @returns Zod File schema with PocketBase metadata
+ * @returns Zod schema that accepts File on input and returns string when reading from database
  *
  * @example
  * const ProductSchema = z.object({
  *   thumbnail: FileField({ mimeTypes: ["image/*"], maxSize: 5242880 }),
  *   document: FileField({ mimeTypes: ["application/pdf"] }),
  * });
+ *
+ * @remarks
+ * - When creating/updating records: accepts File objects
+ * - When reading from PocketBase: returns string (filename)
  */
-declare function FileField(options?: FileFieldOptions): z.ZodType<File>;
+declare function FileField(options?: FileFieldOptions): z.ZodType<string, z.ZodTypeDef, File | string>;
 /**
  * Creates a multiple files field schema
  * Maps to PocketBase 'file' field type with maxSelect>1
  *
  * @param options - Optional file constraints
- * @returns Zod array of File schema with PocketBase metadata
+ * @returns Zod array schema that accepts File[] on input and returns string[] when reading from database
  *
  * @example
  * const ProductSchema = z.object({
  *   images: FilesField({ mimeTypes: ["image/*"], maxSelect: 5 }),
  *   attachments: FilesField({ minSelect: 1, maxSelect: 10 }),
  * });
+ *
+ * @remarks
+ * - When creating/updating records: accepts File[]
+ * - When reading from PocketBase: returns string[] (filenames)
  */
-declare function FilesField(options?: FilesFieldOptions): z.ZodArray<z.ZodType<File>>;
+declare function FilesField(options?: FilesFieldOptions): z.ZodType<string[], z.ZodTypeDef, (File | string)[]>;
 /**
  * Creates a JSON field schema with optional inner schema validation
  * Maps to PocketBase 'json' field type
@@ -361,4 +389,4 @@ declare function GeoPointField(): z.ZodObject<{
     lat: z.ZodNumber;
 }>;
 
-export { type AutodateFieldOptions as A, BoolField as B, type DateFieldOptions as D, EmailField as E, FIELD_METADATA_KEY as F, GeoPointField as G, JSONField as J, type NumberFieldOptions as N, type PocketBaseFieldType as P, type SelectFieldOptions as S, type TextFieldOptions as T, URLField as U, type FieldMetadata as a, type FileFieldOptions as b, type FilesFieldOptions as c, NumberField as d, extractFieldMetadata as e, TextField as f, EditorField as g, DateField as h, AutodateField as i, SelectField as j, FileField as k, FilesField as l };
+export { type AutodateFieldOptions as A, type ByteSize as B, type DateFieldOptions as D, EmailField as E, FIELD_METADATA_KEY as F, GeoPointField as G, JSONField as J, type NumberFieldOptions as N, type PocketBaseFieldType as P, type SelectFieldOptions as S, type TextFieldOptions as T, URLField as U, type FieldMetadata as a, type FileFieldOptions as b, type FilesFieldOptions as c, BoolField as d, extractFieldMetadata as e, NumberField as f, TextField as g, EditorField as h, DateField as i, AutodateField as j, SelectField as k, FileField as l, FilesField as m };

package/dist/{fields-UcOPu1OQ.d.ts → fields-DBBm06VU.d.ts}

@@ -116,6 +116,15 @@ interface SelectFieldOptions {
      */
     maxSelect?: number;
 }
+/**
+ * Human-friendly byte size input.
+ *
+ * - Use a number for raw bytes (e.g. `5242880`)
+ * - Use a string with unit suffix for kibibytes/mebibytes/gibibytes (e.g. `"5M"`, `"1G"`)
+ *
+ * Supported suffixes: `K`, `M`, `G` (case-insensitive).
+ */
+type ByteSize = number | `${number}${"K" | "M" | "G" | "k" | "m" | "g"}`;
 /**
  * File field configuration options
  */
@@ -126,12 +135,23 @@ interface FileFieldOptions {
      */
     mimeTypes?: string[];
     /**
-     * Maximum file size in bytes
+     * Maximum file size.
+     *
+     * - Provide a number for raw bytes
+     * - Or use a string with `K`, `M`, `G` suffix (case-insensitive)
+     *
+     * Max allowed is `8G`.
+     *
+     * @example
+     * maxSize: 5242880
+     * maxSize: "5M"
+     * maxSize: "1G"
      */
-    maxSize?: number;
+    maxSize?: ByteSize;
     /**
      * Thumbnail sizes to generate
      * Example: ["100x100", "200x200"]
+     * Set to null to explicitly disable thumbnails
      */
     thumbs?: string[];
     /**
@@ -298,29 +318,37 @@ declare function SelectField<T extends [string, ...string[]]>(values: T, options
  * Maps to PocketBase 'file' field type with maxSelect=1
  *
  * @param options - Optional file constraints
- * @returns Zod File schema with PocketBase metadata
+ * @returns Zod schema that accepts File on input and returns string when reading from database
  *
  * @example
  * const ProductSchema = z.object({
  *   thumbnail: FileField({ mimeTypes: ["image/*"], maxSize: 5242880 }),
  *   document: FileField({ mimeTypes: ["application/pdf"] }),
  * });
+ *
+ * @remarks
+ * - When creating/updating records: accepts File objects
+ * - When reading from PocketBase: returns string (filename)
  */
-declare function FileField(options?: FileFieldOptions): z.ZodType<File>;
+declare function FileField(options?: FileFieldOptions): z.ZodType<string, z.ZodTypeDef, File | string>;
 /**
  * Creates a multiple files field schema
  * Maps to PocketBase 'file' field type with maxSelect>1
  *
  * @param options - Optional file constraints
- * @returns Zod array of File schema with PocketBase metadata
+ * @returns Zod array schema that accepts File[] on input and returns string[] when reading from database
  *
  * @example
  * const ProductSchema = z.object({
  *   images: FilesField({ mimeTypes: ["image/*"], maxSelect: 5 }),
  *   attachments: FilesField({ minSelect: 1, maxSelect: 10 }),
  * });
+ *
+ * @remarks
+ * - When creating/updating records: accepts File[]
+ * - When reading from PocketBase: returns string[] (filenames)
  */
-declare function FilesField(options?: FilesFieldOptions): z.ZodArray<z.ZodType<File>>;
+declare function FilesField(options?: FilesFieldOptions): z.ZodType<string[], z.ZodTypeDef, (File | string)[]>;
 /**
  * Creates a JSON field schema with optional inner schema validation
  * Maps to PocketBase 'json' field type
@@ -361,4 +389,4 @@ declare function GeoPointField(): z.ZodObject<{
     lat: z.ZodNumber;
 }>;
 
-export { type AutodateFieldOptions as A, BoolField as B, type DateFieldOptions as D, EmailField as E, FIELD_METADATA_KEY as F, GeoPointField as G, JSONField as J, type NumberFieldOptions as N, type PocketBaseFieldType as P, type SelectFieldOptions as S, type TextFieldOptions as T, URLField as U, type FieldMetadata as a, type FileFieldOptions as b, type FilesFieldOptions as c, NumberField as d, extractFieldMetadata as e, TextField as f, EditorField as g, DateField as h, AutodateField as i, SelectField as j, FileField as k, FilesField as l };
+export { type AutodateFieldOptions as A, type ByteSize as B, type DateFieldOptions as D, EmailField as E, FIELD_METADATA_KEY as F, GeoPointField as G, JSONField as J, type NumberFieldOptions as N, type PocketBaseFieldType as P, type SelectFieldOptions as S, type TextFieldOptions as T, URLField as U, type FieldMetadata as a, type FileFieldOptions as b, type FilesFieldOptions as c, BoolField as d, extractFieldMetadata as e, NumberField as f, TextField as g, EditorField as h, DateField as i, AutodateField as j, SelectField as k, FileField as l, FilesField as m };