pocketbase-zod-schema 0.2.4 → 0.3.0

package/dist/type-mapper-DrQmtznD.d.cts

@@ -0,0 +1,208 @@
+import { z } from 'zod';
+import { P as PocketBaseFieldType } from './fields-UcOPu1OQ.cjs';
+
+/**
+ * Collection name pluralization utilities
+ */
+/**
+ * Pluralizes a singular noun to its plural form
+ * Handles special cases and common English pluralization rules
+ *
+ * @param singular - The singular form of the noun
+ * @returns The plural form of the noun
+ */
+declare function pluralize(singular: string): string;
+/**
+ * Converts a singular entity name to a collection name
+ * This is an alias for pluralize for better semantic clarity
+ *
+ * @param entityName - The singular entity name (e.g., "User", "Project")
+ * @returns The collection name (e.g., "Users", "Projects")
+ */
+declare function toCollectionName(entityName: string): string;
+/**
+ * Attempts to singularize a plural noun (reverse of pluralize)
+ * Note: This is a best-effort implementation and may not handle all edge cases
+ *
+ * @param plural - The plural form of the noun
+ * @returns The singular form of the noun
+ */
+declare function singularize(plural: string): string;
+
+/**
+ * Relation field detection utilities
+ */
+
+/**
+ * Detects if a field is a single relation based on naming convention
+ * Single relation: field name matches a collection name (e.g., "User" -> "Users" collection)
+ */
+declare function isSingleRelationField(fieldName: string, zodType: z.ZodTypeAny): boolean;
+/**
+ * Detects if a field is a multiple relation based on naming convention
+ * Multiple relation: field name is an array of strings ending with entity name
+ * (e.g., "SubscriberUsers" -> "Users" collection)
+ */
+declare function isMultipleRelationField(fieldName: string, zodType: z.ZodTypeAny): boolean;
+/**
+ * Resolves the target collection name from a relation field name
+ * Examples:
+ * - "User" -> "Users"
+ * - "SubscriberUsers" -> "Users"
+ * - "Author" -> "Authors"
+ * - "Category" -> "Categories"
+ */
+declare function resolveTargetCollection(fieldName: string): string;
+/**
+ * Detects if a field is any type of relation (single or multiple)
+ */
+declare function isRelationField(fieldName: string, zodType: z.ZodTypeAny): boolean;
+/**
+ * Gets the maximum number of relations allowed for a relation field
+ * Returns 1 for single relations, or the max constraint for multiple relations
+ */
+declare function getMaxSelect(fieldName: string, zodType: z.ZodTypeAny): number;
+/**
+ * Gets the minimum number of relations required for a relation field
+ * Returns 0 as default for all relation fields (single or multiple)
+ * PocketBase always expects minSelect to be defined for relation fields
+ */
+declare function getMinSelect(fieldName: string, zodType: z.ZodTypeAny): number;
+
+/**
+ * Zod to PocketBase type mapping utilities
+ *
+ * This module provides comprehensive mapping between Zod schema types
+ * and PocketBase field types, including support for all PocketBase field types:
+ * - text, email, url, editor
+ * - number, bool
+ * - date, autodate
+ * - select (single/multiple)
+ * - relation (single/multiple)
+ * - file (single/multiple)
+ * - json
+ * - geoPoint
+ */
+
+/**
+ * All supported PocketBase field types
+ */
+declare const POCKETBASE_FIELD_TYPES: readonly PocketBaseFieldType[];
+/**
+ * Field type metadata for documentation and validation
+ */
+interface FieldTypeInfo {
+    type: PocketBaseFieldType;
+    description: string;
+    zodTypes: string[];
+    supportsMultiple: boolean;
+}
+/**
+ * Metadata about each PocketBase field type
+ */
+declare const FIELD_TYPE_INFO: Record<PocketBaseFieldType, FieldTypeInfo>;
+/**
+ * Maps Zod string types to PocketBase field types
+ */
+declare function mapZodStringType(zodType: z.ZodString): PocketBaseFieldType;
+/**
+ * Maps Zod number types to PocketBase number type
+ */
+declare function mapZodNumberType(_zodType: z.ZodNumber): PocketBaseFieldType;
+/**
+ * Maps Zod boolean types to PocketBase bool type
+ */
+declare function mapZodBooleanType(_zodType: z.ZodBoolean): PocketBaseFieldType;
+/**
+ * Maps Zod enum types to PocketBase select type
+ */
+declare function mapZodEnumType(_zodType: z.ZodEnum<any>): PocketBaseFieldType;
+/**
+ * Maps Zod array types to appropriate PocketBase types
+ * Arrays of strings could be relations or file fields depending on context
+ */
+declare function mapZodArrayType(zodType: z.ZodArray<any>, _fieldName: string): PocketBaseFieldType;
+/**
+ * Maps Zod date types to PocketBase date type
+ */
+declare function mapZodDateType(_zodType: z.ZodDate): PocketBaseFieldType;
+/**
+ * Maps Zod record/object types to PocketBase JSON type
+ */
+declare function mapZodRecordType(_zodType: z.ZodRecord | z.ZodObject<any>): PocketBaseFieldType;
+/**
+ * Main type mapping function that determines PocketBase field type from Zod type
+ */
+declare function mapZodTypeToPocketBase(zodType: z.ZodTypeAny, fieldName: string): PocketBaseFieldType;
+/**
+ * Extracts field options from Zod type (min, max, pattern, etc.)
+ */
+declare function extractFieldOptions(zodType: z.ZodTypeAny): Record<string, any>;
+/**
+ * Determines if a Zod field is required (not optional)
+ */
+declare function isFieldRequired(zodType: z.ZodTypeAny): boolean;
+/**
+ * Unwraps a Zod type to get the inner type
+ * Handles optional, nullable, and default wrappers
+ */
+declare function unwrapZodType(zodType: z.ZodTypeAny): z.ZodTypeAny;
+/**
+ * Gets the default value from a Zod type if it has one
+ */
+declare function getDefaultValue(zodType: z.ZodTypeAny): any;
+/**
+ * Checks if a Zod type is an array type
+ */
+declare function isArrayType(zodType: z.ZodTypeAny): boolean;
+/**
+ * Gets the element type of an array Zod type
+ */
+declare function getArrayElementType(zodType: z.ZodTypeAny): z.ZodTypeAny | null;
+/**
+ * Checks if a Zod type represents a geo point (object with lon/lat)
+ */
+declare function isGeoPointType(zodType: z.ZodTypeAny): boolean;
+/**
+ * Complete field options extracted from a Zod type
+ */
+interface ExtractedFieldOptions {
+    min?: number;
+    max?: number;
+    pattern?: string;
+    values?: string[];
+    minSelect?: number;
+    maxSelect?: number;
+    mimeTypes?: string[];
+    maxSize?: number;
+    thumbs?: string[];
+}
+/**
+ * Extracts comprehensive field options from Zod type
+ * Includes all constraints that can be mapped to PocketBase field options
+ */
+declare function extractComprehensiveFieldOptions(zodType: z.ZodTypeAny): ExtractedFieldOptions;
+/**
+ * Determines if a field should be treated as an editor field
+ * based on field name conventions
+ */
+declare function isEditorField(fieldName: string): boolean;
+/**
+ * Determines if a field should be treated as a file field
+ * based on field name conventions
+ */
+declare function isFileFieldByName(fieldName: string): boolean;
+/**
+ * Gets the PocketBase field type with additional context
+ */
+interface FieldTypeResult {
+    type: PocketBaseFieldType;
+    isMultiple: boolean;
+    options: ExtractedFieldOptions;
+}
+/**
+ * Comprehensive type mapping that returns full field information
+ */
+declare function getFieldTypeInfo(zodType: z.ZodTypeAny, fieldName: string): FieldTypeResult;
+
+export { isEditorField as A, isFileFieldByName as B, type FieldTypeResult as C, getFieldTypeInfo as D, type ExtractedFieldOptions as E, type FieldTypeInfo as F, POCKETBASE_FIELD_TYPES as P, isMultipleRelationField as a, isRelationField as b, getMinSelect as c, FIELD_TYPE_INFO as d, mapZodNumberType as e, mapZodBooleanType as f, getMaxSelect as g, mapZodEnumType as h, isSingleRelationField as i, mapZodArrayType as j, mapZodDateType as k, mapZodRecordType as l, mapZodStringType as m, mapZodTypeToPocketBase as n, extractFieldOptions as o, pluralize as p, isFieldRequired as q, resolveTargetCollection as r, singularize as s, toCollectionName as t, unwrapZodType as u, getDefaultValue as v, isArrayType as w, getArrayElementType as x, isGeoPointType as y, extractComprehensiveFieldOptions as z };

package/dist/type-mapper-n231Fspm.d.ts

@@ -0,0 +1,208 @@
+import { z } from 'zod';
+import { P as PocketBaseFieldType } from './fields-UcOPu1OQ.js';
+
+/**
+ * Collection name pluralization utilities
+ */
+/**
+ * Pluralizes a singular noun to its plural form
+ * Handles special cases and common English pluralization rules
+ *
+ * @param singular - The singular form of the noun
+ * @returns The plural form of the noun
+ */
+declare function pluralize(singular: string): string;
+/**
+ * Converts a singular entity name to a collection name
+ * This is an alias for pluralize for better semantic clarity
+ *
+ * @param entityName - The singular entity name (e.g., "User", "Project")
+ * @returns The collection name (e.g., "Users", "Projects")
+ */
+declare function toCollectionName(entityName: string): string;
+/**
+ * Attempts to singularize a plural noun (reverse of pluralize)
+ * Note: This is a best-effort implementation and may not handle all edge cases
+ *
+ * @param plural - The plural form of the noun
+ * @returns The singular form of the noun
+ */
+declare function singularize(plural: string): string;
+
+/**
+ * Relation field detection utilities
+ */
+
+/**
+ * Detects if a field is a single relation based on naming convention
+ * Single relation: field name matches a collection name (e.g., "User" -> "Users" collection)
+ */
+declare function isSingleRelationField(fieldName: string, zodType: z.ZodTypeAny): boolean;
+/**
+ * Detects if a field is a multiple relation based on naming convention
+ * Multiple relation: field name is an array of strings ending with entity name
+ * (e.g., "SubscriberUsers" -> "Users" collection)
+ */
+declare function isMultipleRelationField(fieldName: string, zodType: z.ZodTypeAny): boolean;
+/**
+ * Resolves the target collection name from a relation field name
+ * Examples:
+ * - "User" -> "Users"
+ * - "SubscriberUsers" -> "Users"
+ * - "Author" -> "Authors"
+ * - "Category" -> "Categories"
+ */
+declare function resolveTargetCollection(fieldName: string): string;
+/**
+ * Detects if a field is any type of relation (single or multiple)
+ */
+declare function isRelationField(fieldName: string, zodType: z.ZodTypeAny): boolean;
+/**
+ * Gets the maximum number of relations allowed for a relation field
+ * Returns 1 for single relations, or the max constraint for multiple relations
+ */
+declare function getMaxSelect(fieldName: string, zodType: z.ZodTypeAny): number;
+/**
+ * Gets the minimum number of relations required for a relation field
+ * Returns 0 as default for all relation fields (single or multiple)
+ * PocketBase always expects minSelect to be defined for relation fields
+ */
+declare function getMinSelect(fieldName: string, zodType: z.ZodTypeAny): number;
+
+/**
+ * Zod to PocketBase type mapping utilities
+ *
+ * This module provides comprehensive mapping between Zod schema types
+ * and PocketBase field types, including support for all PocketBase field types:
+ * - text, email, url, editor
+ * - number, bool
+ * - date, autodate
+ * - select (single/multiple)
+ * - relation (single/multiple)
+ * - file (single/multiple)
+ * - json
+ * - geoPoint
+ */
+
+/**
+ * All supported PocketBase field types
+ */
+declare const POCKETBASE_FIELD_TYPES: readonly PocketBaseFieldType[];
+/**
+ * Field type metadata for documentation and validation
+ */
+interface FieldTypeInfo {
+    type: PocketBaseFieldType;
+    description: string;
+    zodTypes: string[];
+    supportsMultiple: boolean;
+}
+/**
+ * Metadata about each PocketBase field type
+ */
+declare const FIELD_TYPE_INFO: Record<PocketBaseFieldType, FieldTypeInfo>;
+/**
+ * Maps Zod string types to PocketBase field types
+ */
+declare function mapZodStringType(zodType: z.ZodString): PocketBaseFieldType;
+/**
+ * Maps Zod number types to PocketBase number type
+ */
+declare function mapZodNumberType(_zodType: z.ZodNumber): PocketBaseFieldType;
+/**
+ * Maps Zod boolean types to PocketBase bool type
+ */
+declare function mapZodBooleanType(_zodType: z.ZodBoolean): PocketBaseFieldType;
+/**
+ * Maps Zod enum types to PocketBase select type
+ */
+declare function mapZodEnumType(_zodType: z.ZodEnum<any>): PocketBaseFieldType;
+/**
+ * Maps Zod array types to appropriate PocketBase types
+ * Arrays of strings could be relations or file fields depending on context
+ */
+declare function mapZodArrayType(zodType: z.ZodArray<any>, _fieldName: string): PocketBaseFieldType;
+/**
+ * Maps Zod date types to PocketBase date type
+ */
+declare function mapZodDateType(_zodType: z.ZodDate): PocketBaseFieldType;
+/**
+ * Maps Zod record/object types to PocketBase JSON type
+ */
+declare function mapZodRecordType(_zodType: z.ZodRecord | z.ZodObject<any>): PocketBaseFieldType;
+/**
+ * Main type mapping function that determines PocketBase field type from Zod type
+ */
+declare function mapZodTypeToPocketBase(zodType: z.ZodTypeAny, fieldName: string): PocketBaseFieldType;
+/**
+ * Extracts field options from Zod type (min, max, pattern, etc.)
+ */
+declare function extractFieldOptions(zodType: z.ZodTypeAny): Record<string, any>;
+/**
+ * Determines if a Zod field is required (not optional)
+ */
+declare function isFieldRequired(zodType: z.ZodTypeAny): boolean;
+/**
+ * Unwraps a Zod type to get the inner type
+ * Handles optional, nullable, and default wrappers
+ */
+declare function unwrapZodType(zodType: z.ZodTypeAny): z.ZodTypeAny;
+/**
+ * Gets the default value from a Zod type if it has one
+ */
+declare function getDefaultValue(zodType: z.ZodTypeAny): any;
+/**
+ * Checks if a Zod type is an array type
+ */
+declare function isArrayType(zodType: z.ZodTypeAny): boolean;
+/**
+ * Gets the element type of an array Zod type
+ */
+declare function getArrayElementType(zodType: z.ZodTypeAny): z.ZodTypeAny | null;
+/**
+ * Checks if a Zod type represents a geo point (object with lon/lat)
+ */
+declare function isGeoPointType(zodType: z.ZodTypeAny): boolean;
+/**
+ * Complete field options extracted from a Zod type
+ */
+interface ExtractedFieldOptions {
+    min?: number;
+    max?: number;
+    pattern?: string;
+    values?: string[];
+    minSelect?: number;
+    maxSelect?: number;
+    mimeTypes?: string[];
+    maxSize?: number;
+    thumbs?: string[];
+}
+/**
+ * Extracts comprehensive field options from Zod type
+ * Includes all constraints that can be mapped to PocketBase field options
+ */
+declare function extractComprehensiveFieldOptions(zodType: z.ZodTypeAny): ExtractedFieldOptions;
+/**
+ * Determines if a field should be treated as an editor field
+ * based on field name conventions
+ */
+declare function isEditorField(fieldName: string): boolean;
+/**
+ * Determines if a field should be treated as a file field
+ * based on field name conventions
+ */
+declare function isFileFieldByName(fieldName: string): boolean;
+/**
+ * Gets the PocketBase field type with additional context
+ */
+interface FieldTypeResult {
+    type: PocketBaseFieldType;
+    isMultiple: boolean;
+    options: ExtractedFieldOptions;
+}
+/**
+ * Comprehensive type mapping that returns full field information
+ */
+declare function getFieldTypeInfo(zodType: z.ZodTypeAny, fieldName: string): FieldTypeResult;
+
+export { isEditorField as A, isFileFieldByName as B, type FieldTypeResult as C, getFieldTypeInfo as D, type ExtractedFieldOptions as E, type FieldTypeInfo as F, POCKETBASE_FIELD_TYPES as P, isMultipleRelationField as a, isRelationField as b, getMinSelect as c, FIELD_TYPE_INFO as d, mapZodNumberType as e, mapZodBooleanType as f, getMaxSelect as g, mapZodEnumType as h, isSingleRelationField as i, mapZodArrayType as j, mapZodDateType as k, mapZodRecordType as l, mapZodStringType as m, mapZodTypeToPocketBase as n, extractFieldOptions as o, pluralize as p, isFieldRequired as q, resolveTargetCollection as r, singularize as s, toCollectionName as t, unwrapZodType as u, getDefaultValue as v, isArrayType as w, getArrayElementType as x, isGeoPointType as y, extractComprehensiveFieldOptions as z };

package/dist/{types-z1Dkjg8m.d.ts → types-Ds3NQvny.d.ts}

@@ -1,9 +1,9 @@
+import { P as PocketBaseFieldType } from './fields-UcOPu1OQ.js';
 import { A as APIRuleType } from './permissions-ZHafVSIx.js';
 
 /**
  * Shared types for migration tool
  */
-type PocketBaseFieldType = "text" | "email" | "url" | "number" | "bool" | "date" | "select" | "relation" | "file" | "json" | "editor" | "geoPoint" | "autodate";
 
 interface FieldDefinition {
     name: string;
@@ -21,6 +21,13 @@ interface FieldDefinition {
 interface CollectionSchema {
     name: string;
     type: "base" | "auth";
+    /**
+     * Pre-generated collection ID for use in migrations
+     * Format: pb_ followed by 15 alphanumeric lowercase characters
+     * Special case: "_pb_users_auth_" for users collection
+     * This ID is generated during migration creation to avoid runtime lookups
+     */
+    id?: string;
     fields: FieldDefinition[];
     indexes?: string[];
     rules?: {
@@ -87,5 +94,29 @@ interface SchemaDiff {
     collectionsToDelete: any[];
     collectionsToModify: CollectionModification[];
 }
+/**
+ * Represents a single collection operation for file splitting
+ * Each operation will generate a separate migration file
+ */
+interface CollectionOperation {
+    /**
+     * Type of operation being performed
+     */
+    type: "create" | "modify" | "delete";
+    /**
+     * Collection being operated on
+     * For create/modify: CollectionSchema
+     * For delete: collection name as string
+     */
+    collection: CollectionSchema | string;
+    /**
+     * Modifications to apply (only for 'modify' operations)
+     */
+    modifications?: CollectionModification;
+    /**
+     * Timestamp for this operation's migration file
+     */
+    timestamp: string;
+}
 
-export type { CollectionSchema as C, FieldDefinition as F, PocketBaseFieldType as P, RuleUpdate as R, SchemaDefinition as S, SchemaSnapshot as a, FieldChange as b, FieldModification as c, PermissionChange as d, CollectionModification as e, SchemaDiff as f };
+export type { CollectionSchema as C, FieldDefinition as F, PermissionChange as P, RuleUpdate as R, SchemaDefinition as S, SchemaSnapshot as a, FieldChange as b, FieldModification as c, CollectionModification as d, SchemaDiff as e, CollectionOperation as f };

package/dist/{types-BbTgmg6H.d.cts → types-YoBjsa-A.d.cts}

@@ -1,9 +1,9 @@
+import { P as PocketBaseFieldType } from './fields-UcOPu1OQ.cjs';
 import { A as APIRuleType } from './permissions-ZHafVSIx.cjs';
 
 /**
  * Shared types for migration tool
  */
-type PocketBaseFieldType = "text" | "email" | "url" | "number" | "bool" | "date" | "select" | "relation" | "file" | "json" | "editor" | "geoPoint" | "autodate";
 
 interface FieldDefinition {
     name: string;
@@ -21,6 +21,13 @@ interface FieldDefinition {
 interface CollectionSchema {
     name: string;
     type: "base" | "auth";
+    /**
+     * Pre-generated collection ID for use in migrations
+     * Format: pb_ followed by 15 alphanumeric lowercase characters
+     * Special case: "_pb_users_auth_" for users collection
+     * This ID is generated during migration creation to avoid runtime lookups
+     */
+    id?: string;
     fields: FieldDefinition[];
     indexes?: string[];
     rules?: {
@@ -87,5 +94,29 @@ interface SchemaDiff {
     collectionsToDelete: any[];
     collectionsToModify: CollectionModification[];
 }
+/**
+ * Represents a single collection operation for file splitting
+ * Each operation will generate a separate migration file
+ */
+interface CollectionOperation {
+    /**
+     * Type of operation being performed
+     */
+    type: "create" | "modify" | "delete";
+    /**
+     * Collection being operated on
+     * For create/modify: CollectionSchema
+     * For delete: collection name as string
+     */
+    collection: CollectionSchema | string;
+    /**
+     * Modifications to apply (only for 'modify' operations)
+     */
+    modifications?: CollectionModification;
+    /**
+     * Timestamp for this operation's migration file
+     */
+    timestamp: string;
+}
 
-export type { CollectionSchema as C, FieldDefinition as F, PocketBaseFieldType as P, RuleUpdate as R, SchemaDefinition as S, SchemaSnapshot as a, FieldChange as b, FieldModification as c, PermissionChange as d, CollectionModification as e, SchemaDiff as f };
+export type { CollectionSchema as C, FieldDefinition as F, PermissionChange as P, RuleUpdate as R, SchemaDefinition as S, SchemaSnapshot as a, FieldChange as b, FieldModification as c, CollectionModification as d, SchemaDiff as e, CollectionOperation as f };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pocketbase-zod-schema",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "PocketBase migration generator using Zod schemas for type-safe database migrations",
   "type": "module",
   "main": "dist/index.js",