pocketbase-zod-schema 0.7.2 → 1.0.0

package/dist/migration/snapshot.d.cts

@@ -1,49 +1,8 @@
-import { F as FieldDefinition, a as SchemaSnapshot, S as SchemaDefinition, C as CollectionSchema } from '../types-CnzfX6JH.cjs';
+import { E as EngineOptions, j as AppliedMigrationsSource } from '../types-upZBVMfb.cjs';
+import { a as SchemaSnapshot, S as SchemaDefinition } from '../types-CnzfX6JH.cjs';
 import '../fields-B96iGprI.cjs';
 import 'zod';
 
-/**
- * Migration File Parser
- * Parses PocketBase migration files to extract collection operations
- *
- * This module handles parsing migration files to extract:
- * - Collection creations (new Collection(...))
- * - Collection deletions (app.delete(...))
- * - Field modifications (field.property = value)
- */
-
-interface ParsedCollectionUpdate {
-    collectionName: string;
-    fieldsToAdd: FieldDefinition[];
-    fieldsToRemove: string[];
-    fieldsToUpdate: {
-        fieldName: string;
-        changes: Record<string, any>;
-    }[];
-    indexesToAdd: string[];
-    indexesToRemove: string[];
-    rulesToUpdate: Record<string, string | null>;
-    /** New SQL query for a view collection, when the migration updates one */
-    viewQuery?: string;
-}
-
-/**
- * PocketBase Format Converter
- * Converts PocketBase collection objects to our internal CollectionSchema format
- *
- * This module handles conversion between PocketBase's native collection format
- * (as found in migration files and snapshots) and our internal schema representation.
- */
-
-/**
- * Converts PocketBase migration format to SchemaSnapshot
- * Extracts the snapshot array from the migration file content
- *
- * @param migrationContent - Raw migration file content
- * @returns SchemaSnapshot with collections map
- */
-declare function convertPocketBaseMigration(migrationContent: string): SchemaSnapshot;
-
 /**
  * Snapshot Manager
  * Handles saving and loading schema snapshots from JSON files
@@ -81,6 +40,18 @@ interface SnapshotConfig {
      * Custom snapshot version for testing
      */
     version?: string;
+    /**
+     * Options forwarded to the execution engine, which reconstructs state by
+     * executing migration files in a simulated PocketBase JSVM.
+     */
+    engineOptions?: EngineOptions;
+    /**
+     * Migrations PocketBase has actually applied, read from its `_migrations`
+     * table (see `readAppliedMigrations`). When supplied, replay starts from
+     * the newest applied snapshot and stops at the applied set, so a migration
+     * written but not yet run does not leak into the reconstructed state.
+     */
+    appliedMigrations?: AppliedMigrationsSource | string[] | null;
 }
 /**
  * Gets the snapshot file path from configuration
@@ -133,32 +104,24 @@ declare function mergeSnapshots(baseSnapshot: SchemaSnapshot, customSnapshot: Sc
  */
 declare function findLatestSnapshot(migrationsPath: string): string | null;
 /**
- * Applies migration operations to a snapshot state
- * Creates new collections and deletes collections as specified
+ * Reconstructs the current database state: executes the snapshot migration and
+ * every migration after it in a simulated PocketBase JSVM.
  *
- * @param snapshot - Base snapshot state
- * @param operations - Migration operations to apply
- * @returns Updated snapshot with operations applied
- */
-declare function applyMigrationOperations(snapshot: SchemaSnapshot, operations: {
-    collectionsToCreate: CollectionSchema[];
-    collectionsToDelete: string[];
-    collectionsToUpdate: ParsedCollectionUpdate[];
-}): SchemaSnapshot;
-/**
- * Loads snapshot and applies all migrations that come after it
- * This gives us the current state of the database schema
+ * A migration that cannot be executed fails hard — continuing past it would
+ * silently reconstruct the wrong state and cause the generator to emit
+ * incorrect diffs.
  *
  * @param config - Snapshot configuration (must include migrationsPath)
- * @returns SchemaSnapshot object representing current state or null if snapshot doesn't exist
+ * @returns SchemaSnapshot representing the current state, or null when there is
+ *   nothing to replay (an empty database)
  */
 declare function loadSnapshotWithMigrations(config?: SnapshotConfig): SchemaSnapshot | null;
 /**
  * Loads snapshot if it exists, returns null for first run
  * Convenience method that handles missing snapshot gracefully
  * Finds the most recent snapshot file from migrations directory
- * NOTE: This function only loads the snapshot, not migrations after it.
- * Use loadSnapshotWithMigrations() if you need the current state including migrations.
+ * NOTE: This function only executes the snapshot file, not the migrations
+ * after it. Use loadSnapshotWithMigrations() for the current state.
  *
  * @param config - Snapshot configuration (must include migrationsPath)
  * @returns SchemaSnapshot object or null if snapshot doesn't exist
@@ -184,7 +147,6 @@ declare function validateSnapshot(snapshot: SchemaSnapshot): {
     valid: boolean;
     issues: string[];
 };
-
 /**
  * SnapshotManager class for object-oriented usage
  * Provides a stateful interface for snapshot management
@@ -208,10 +170,6 @@ declare class SnapshotManager {
      * Checks if a snapshot exists
      */
     snapshotExists(): boolean;
-    /**
-     * Converts a PocketBase migration to a snapshot
-     */
-    convertPocketBaseMigration(content: string): SchemaSnapshot;
     /**
      * Gets the snapshot file path
      */
@@ -225,4 +183,4 @@ declare class SnapshotManager {
     };
 }
 
-export { type SnapshotConfig, SnapshotManager, applyMigrationOperations, convertPocketBaseMigration, findLatestSnapshot, getSnapshotPath, getSnapshotVersion, loadBaseMigration, loadSnapshot, loadSnapshotIfExists, loadSnapshotWithMigrations, mergeSnapshots, saveSnapshot, snapshotExists, validateSnapshot };
+export { type SnapshotConfig, SnapshotManager, findLatestSnapshot, getSnapshotPath, getSnapshotVersion, loadBaseMigration, loadSnapshot, loadSnapshotIfExists, loadSnapshotWithMigrations, mergeSnapshots, saveSnapshot, snapshotExists, validateSnapshot };

package/dist/migration/snapshot.d.ts

@@ -1,49 +1,8 @@
-import { F as FieldDefinition, a as SchemaSnapshot, S as SchemaDefinition, C as CollectionSchema } from '../types-Do3jyFBm.js';
+import { E as EngineOptions, j as AppliedMigrationsSource } from '../types-B_MLb1Ob.js';
+import { a as SchemaSnapshot, S as SchemaDefinition } from '../types-Do3jyFBm.js';
 import '../fields-B96iGprI.js';
 import 'zod';
 
-/**
- * Migration File Parser
- * Parses PocketBase migration files to extract collection operations
- *
- * This module handles parsing migration files to extract:
- * - Collection creations (new Collection(...))
- * - Collection deletions (app.delete(...))
- * - Field modifications (field.property = value)
- */
-
-interface ParsedCollectionUpdate {
-    collectionName: string;
-    fieldsToAdd: FieldDefinition[];
-    fieldsToRemove: string[];
-    fieldsToUpdate: {
-        fieldName: string;
-        changes: Record<string, any>;
-    }[];
-    indexesToAdd: string[];
-    indexesToRemove: string[];
-    rulesToUpdate: Record<string, string | null>;
-    /** New SQL query for a view collection, when the migration updates one */
-    viewQuery?: string;
-}
-
-/**
- * PocketBase Format Converter
- * Converts PocketBase collection objects to our internal CollectionSchema format
- *
- * This module handles conversion between PocketBase's native collection format
- * (as found in migration files and snapshots) and our internal schema representation.
- */
-
-/**
- * Converts PocketBase migration format to SchemaSnapshot
- * Extracts the snapshot array from the migration file content
- *
- * @param migrationContent - Raw migration file content
- * @returns SchemaSnapshot with collections map
- */
-declare function convertPocketBaseMigration(migrationContent: string): SchemaSnapshot;
-
 /**
  * Snapshot Manager
  * Handles saving and loading schema snapshots from JSON files
@@ -81,6 +40,18 @@ interface SnapshotConfig {
      * Custom snapshot version for testing
      */
     version?: string;
+    /**
+     * Options forwarded to the execution engine, which reconstructs state by
+     * executing migration files in a simulated PocketBase JSVM.
+     */
+    engineOptions?: EngineOptions;
+    /**
+     * Migrations PocketBase has actually applied, read from its `_migrations`
+     * table (see `readAppliedMigrations`). When supplied, replay starts from
+     * the newest applied snapshot and stops at the applied set, so a migration
+     * written but not yet run does not leak into the reconstructed state.
+     */
+    appliedMigrations?: AppliedMigrationsSource | string[] | null;
 }
 /**
  * Gets the snapshot file path from configuration
@@ -133,32 +104,24 @@ declare function mergeSnapshots(baseSnapshot: SchemaSnapshot, customSnapshot: Sc
  */
 declare function findLatestSnapshot(migrationsPath: string): string | null;
 /**
- * Applies migration operations to a snapshot state
- * Creates new collections and deletes collections as specified
+ * Reconstructs the current database state: executes the snapshot migration and
+ * every migration after it in a simulated PocketBase JSVM.
  *
- * @param snapshot - Base snapshot state
- * @param operations - Migration operations to apply
- * @returns Updated snapshot with operations applied
- */
-declare function applyMigrationOperations(snapshot: SchemaSnapshot, operations: {
-    collectionsToCreate: CollectionSchema[];
-    collectionsToDelete: string[];
-    collectionsToUpdate: ParsedCollectionUpdate[];
-}): SchemaSnapshot;
-/**
- * Loads snapshot and applies all migrations that come after it
- * This gives us the current state of the database schema
+ * A migration that cannot be executed fails hard — continuing past it would
+ * silently reconstruct the wrong state and cause the generator to emit
+ * incorrect diffs.
  *
  * @param config - Snapshot configuration (must include migrationsPath)
- * @returns SchemaSnapshot object representing current state or null if snapshot doesn't exist
+ * @returns SchemaSnapshot representing the current state, or null when there is
+ *   nothing to replay (an empty database)
  */
 declare function loadSnapshotWithMigrations(config?: SnapshotConfig): SchemaSnapshot | null;
 /**
  * Loads snapshot if it exists, returns null for first run
  * Convenience method that handles missing snapshot gracefully
  * Finds the most recent snapshot file from migrations directory
- * NOTE: This function only loads the snapshot, not migrations after it.
- * Use loadSnapshotWithMigrations() if you need the current state including migrations.
+ * NOTE: This function only executes the snapshot file, not the migrations
+ * after it. Use loadSnapshotWithMigrations() for the current state.
  *
  * @param config - Snapshot configuration (must include migrationsPath)
  * @returns SchemaSnapshot object or null if snapshot doesn't exist
@@ -184,7 +147,6 @@ declare function validateSnapshot(snapshot: SchemaSnapshot): {
     valid: boolean;
     issues: string[];
 };
-
 /**
  * SnapshotManager class for object-oriented usage
  * Provides a stateful interface for snapshot management
@@ -208,10 +170,6 @@ declare class SnapshotManager {
      * Checks if a snapshot exists
      */
     snapshotExists(): boolean;
-    /**
-     * Converts a PocketBase migration to a snapshot
-     */
-    convertPocketBaseMigration(content: string): SchemaSnapshot;
     /**
      * Gets the snapshot file path
      */
@@ -225,4 +183,4 @@ declare class SnapshotManager {
     };
 }
 
-export { type SnapshotConfig, SnapshotManager, applyMigrationOperations, convertPocketBaseMigration, findLatestSnapshot, getSnapshotPath, getSnapshotVersion, loadBaseMigration, loadSnapshot, loadSnapshotIfExists, loadSnapshotWithMigrations, mergeSnapshots, saveSnapshot, snapshotExists, validateSnapshot };
+export { type SnapshotConfig, SnapshotManager, findLatestSnapshot, getSnapshotPath, getSnapshotVersion, loadBaseMigration, loadSnapshot, loadSnapshotIfExists, loadSnapshotWithMigrations, mergeSnapshots, saveSnapshot, snapshotExists, validateSnapshot };