@gravito/flux 3.0.1 → 3.0.2

package/dist/bun.d.ts

@@ -1,74 +1,113 @@
 import { Database } from 'bun:sqlite';
-import { o as WorkflowStorage, m as WorkflowState, l as WorkflowFilter } from './types-CZwYGpou.js';
+import { p as WorkflowStorage, a as WorkflowState, n as WorkflowFilter } from './types-CRz5XdLd.js';
 
 /**
- * @fileoverview Bun SQLite Storage Adapter
- *
- * High-performance storage using Bun's built-in SQLite.
- *
- * @module @gravito/flux/storage
- */
-
-/**
- * SQLite Storage Options
+ * Configuration options for the Bun SQLite storage adapter.
  */
 interface BunSQLiteStorageOptions {
-    /** Database file path (default: ':memory:') */
+    /**
+     * Path to the SQLite database file.
+     * Use ':memory:' for an ephemeral in-memory database.
+     */
     path?: string;
-    /** Table name (default: 'flux_workflows') */
+    /**
+     * Name of the table used to store workflow states.
+     */
     tableName?: string;
 }
 /**
- * Bun SQLite Storage
+ * BunSQLiteStorage provides a persistent storage backend for Flux workflows using Bun's native SQLite module.
  *
- * High-performance storage adapter using Bun's built-in SQLite.
+ * It handles automatic table creation, indexing for performance, and serialization of workflow state
+ * into a relational format.
  *
  * @example
  * ```typescript
- * const engine = new FluxEngine({
- *   storage: new BunSQLiteStorage({ path: './data/flux.db' })
- * })
+ * const storage = new BunSQLiteStorage({
+ *   path: './workflows.db',
+ *   tableName: 'my_workflows'
+ * });
+ * await storage.init();
  * ```
  */
 declare class BunSQLiteStorage implements WorkflowStorage {
     private db;
     private tableName;
     private initialized;
+    /**
+     * Creates a new instance of BunSQLiteStorage.
+     *
+     * @param options - Configuration for the database connection and table naming.
+     */
     constructor(options?: BunSQLiteStorageOptions);
     /**
-     * Initialize storage (create tables)
+     * Initializes the database schema and required indexes.
+     *
+     * This method is idempotent and will be called automatically by other operations if not invoked manually.
+     *
+     * @throws {Error} If the database schema cannot be created or indexes fail to initialize.
      */
     init(): Promise<void>;
     /**
-     * Save workflow state
+     * Persists or updates a workflow state in the database.
+     *
+     * Uses an "INSERT OR REPLACE" strategy to ensure the latest state is always stored for a given ID.
+     *
+     * @param state - The current state of the workflow to be saved.
+     * @throws {Error} If the database write operation fails or serialization errors occur.
      */
     save(state: WorkflowState): Promise<void>;
     /**
-     * Load workflow state by ID
+     * Retrieves a workflow state by its unique identifier.
+     *
+     * @param id - The unique ID of the workflow to load.
+     * @returns The reconstructed workflow state, or null if no record is found.
+     * @throws {Error} If the database query fails or deserialization of stored JSON fails.
      */
     load(id: string): Promise<WorkflowState | null>;
     /**
-     * List workflow states with optional filter
+     * Lists workflow states based on the provided filtering criteria.
+     *
+     * Results are returned in descending order of creation time.
+     *
+     * @param filter - Criteria for filtering and paginating the results.
+     * @returns An array of workflow states matching the filter.
+     * @throws {Error} If the database query fails.
      */
     list(filter?: WorkflowFilter): Promise<WorkflowState[]>;
     /**
-     * Delete workflow state
+     * Deletes a workflow state from the database.
+     *
+     * @param id - The unique ID of the workflow to delete.
+     * @throws {Error} If the database deletion fails.
      */
     delete(id: string): Promise<void>;
     /**
-     * Close database connection
+     * Closes the database connection and resets the initialization state.
+     *
+     * @throws {Error} If the database connection cannot be closed cleanly.
      */
     close(): Promise<void>;
     /**
-     * Convert SQLite row to WorkflowState
+     * Converts a raw database row into a structured WorkflowState object.
+     *
+     * @param row - The raw SQLite row data.
+     * @returns The parsed workflow state.
+     * @private
      */
     private rowToState;
     /**
-     * Get raw database (for advanced usage)
+     * Provides direct access to the underlying Bun SQLite Database instance.
+     *
+     * Useful for performing custom queries or maintenance tasks.
+     *
+     * @returns The raw Database instance.
      */
     getDatabase(): Database;
     /**
-     * Run a vacuum to optimize database
+     * Performs a VACUUM operation to reclaim unused space and defragment the database.
+     *
+     * @throws {Error} If the VACUUM operation fails.
      */
     vacuum(): void;
 }

package/dist/bun.js

@@ -1,6 +1,6 @@
 import {
   BunSQLiteStorage
-} from "./chunk-ZAMVC732.js";
+} from "./chunk-NAIVO7RR.js";
 export {
   BunSQLiteStorage
 };