Merge pull request #16 from champ96k/release/v0.04

champ96k · web-flow · commit ba76a767e187 · 2025-05-28T03:20:48.000+05:30
release/v0.04 on pub.dev
diff --git a/.flutter-plugins-dependencies b/.flutter-plugins-dependencies
@@ -1 +1 @@
-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"path_provider_android","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_android-2.2.10/","native_build":true,"dependencies":[]}],"macos":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]}],"date_created":"2025-05-28 01:55:42.240198","version":"3.22.2"}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"path_provider_android","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_android-2.2.10/","native_build":true,"dependencies":[]}],"macos":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]}],"date_created":"2025-05-28 03:14:50.941691","version":"3.22.2"}
diff --git a/.gitignore b/.gitignore
@@ -27,5 +27,6 @@ migrate_working_dir/
 .dart_tool/
 build/
 
-# Local Netlify folder
-.netlify
+# Netlify
+documentation/.netlify/netlify.toml
+documentation/.netlify/state.json
diff --git a/.pubignore b/.pubignore
@@ -0,0 +1,28 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# Flutter/Dart/Pub related
+.dart_tool/
+build/
+.git/
+.gitignore
+.pubignore
+
+# Documentation related
+# Exclude Netlify state files but keep the configuration
+documentation/.netlify/state.json 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,18 +1,39 @@
 # Changelog
 
-## 0.0.1
+## 0.0.4
 
-- Initial release of QuantaDB
-- Implemented LSM-Tree based storage engine
-- Added basic CRUD operations
-- Added support for Flutter integration
-- Included code generation capabilities
+### Features
+- Added support for automatic schema migrations
+- Improved builder configuration for better code generation
+- Enhanced documentation coverage for public API
+
+### Dependencies
+- Updated analyzer to support version 7.x
+- Updated source_gen to support version 2.x
+- Updated other dependencies to their latest stable versions
+
+### Bug Fixes
+- Fixed builder configuration issues
+- Resolved dependency constraint warnings
+- Improved error handling in migration builder
+
+## 0.0.3
+
+### Features
+- Initial public release
+- Basic LSM-Tree implementation
+- Code generation support
+- Schema versioning
+- Encryption support
 
 ## 0.0.2
 
 - Readme updated
 
-## 0.0.3
+## 0.0.1
 
-- Documentation added
-- Improve pub score
+- Initial release of QuantaDB
+- Implemented LSM-Tree based storage engine
+- Added basic CRUD operations
+- Added support for Flutter integration
+- Included code generation capabilities
diff --git a/README.md b/README.md
@@ -111,7 +111,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yaml
 dependencies:
-  quanta_db: ^0.0.3
+  quanta_db: ^0.0.4
 ```
 
 2. **Install it**
@@ -170,6 +170,59 @@ void main() async {
 - Data is stored using a custom binary serialization format (DartBson).
 - Directory management is handled automatically for different platforms, ensuring secure storage locations.
 
+## Features in Detail
+
+### Automatic Schema Migrations
+
+QuantaDB automatically handles schema changes:
+
+```dart
+@QuantaEntity()
+class User {
+  final String id;
+  final String name;
+  final String email;
+  // Add new fields as needed
+  final String? phone; // New field
+}
+```
+
+The migration will be generated automatically when you run:
+
+```bash
+dart run build_runner build
+```
+
+### Encryption
+
+Secure sensitive data with field-level encryption:
+
+```dart
+@QuantaEntity()
+class User {
+  @QuantaEncrypted()
+  final String password;
+}
+```
+
+### Reactive Fields
+
+Get real-time updates for specific fields:
+
+```dart
+@QuantaEntity()
+class User {
+  @QuantaReactive()
+  final DateTime lastLogin;
+}
+
+// Watch for changes
+final stream = userDao.watchLastLogin(user);
+await for (final lastLogin in stream) {
+  print('User logged in at: $lastLogin');
+}
+```
+
 ## Contributing
 
 We welcome contributions! Please see the [CONTRIBUTING.md](https://github.com/champ96k/quanta_db/blob/master/CONTRIBUTING.md) for details.
diff --git a/build.yaml b/build.yaml
@@ -10,9 +10,15 @@ targets:
           exclude:
             - lib/annotations/**.dart
             - lib/src/generator/**.dart
-      quanta_db:
-        options:
-          generate_migrations: true
+      quanta_db|migration_builder:
+        enabled: true
+        generate_for:
+          include:
+            - lib/**.dart
+            - example/**.dart
+          exclude:
+            - lib/annotations/**.dart
+            - lib/src/generator/**.dart
 
 builders:
   quanta_generator:
@@ -22,10 +28,10 @@ builders:
     auto_apply: root_package
     build_to: source
     required_inputs: [".dart"]
-    runs_before: ["build_web_compilers|entrypoint"] 
-  quanta_db:
+    runs_before: ["build_web_compilers|entrypoint"]
+  migration_builder:
     import: "package:quanta_db/src/builders/migration_builder.dart"
-    builder_factories: ["MigrationBuilder"]
+    builder_factories: ["migrationBuilder"]
     build_extensions: {".dart": [".migration.dart"]}
     auto_apply: root_package
     build_to: source 
diff --git a/documentation/blog/quantadb-beta-announcement.md b/documentation/blog/quantadb-beta-announcement.md
@@ -59,7 +59,7 @@ Adding QuantaDB to your project is straightforward:
 
 ```yaml
 dependencies:
-  quanta_db: ^0.0.2
+  quanta_db: ^0.0.4
 ```
 
 Basic usage example:
diff --git a/documentation/docs/installation.md b/documentation/docs/installation.md
@@ -8,7 +8,7 @@ To start using QuantaDB, add the dependency to your `pubspec.yaml` file:
 
 ```yaml
 dependencies:
-  quanta_db: ^0.0.2 # Use the latest version
+  quanta_db: ^0.0.4 # Use the latest version
 ```
 
 Then, run `dart pub get` or `flutter pub get`.
@@ -17,4 +17,4 @@ Import the package in your Dart code:
 
 ```dart
 import 'package:quanta_db/quanta_db.dart';
-``` 
+```
diff --git a/documentation/docs/intro.md b/documentation/docs/intro.md
@@ -41,7 +41,7 @@ To start using QuantaDB, add the dependency to your `pubspec.yaml` file:
 
 ```yaml
 dependencies:
-  quanta_db: ^0.0.2 # Use the latest version
+  quanta_db: ^0.0.4 # Use the latest version
 ```
 
 Then, run `dart pub get` or `flutter pub get`.
diff --git a/example/database_benchmark/pubspec.lock b/example/database_benchmark/pubspec.lock
@@ -5,18 +5,18 @@ packages:
     dependency: transitive
     description:
       name: _fe_analyzer_shared
-      sha256: ae92f5d747aee634b87f89d9946000c2de774be1d6ac3e58268224348cd0101a
+      sha256: "0b2f2bd91ba804e53a61d757b986f89f1f9eaed5b11e4b2f5a2468d86d6c9fc7"
       url: "https://pub.dev"
     source: hosted
-    version: "61.0.0"
+    version: "67.0.0"
   analyzer:
     dependency: transitive
     description:
       name: analyzer
-      sha256: ea3d8652bda62982addfd92fdc2d0214e5f82e43325104990d4f4c4a2a313562
+      sha256: "37577842a27e4338429a1cbc32679d508836510b056f1eedf0c8d20e39c1383d"
       url: "https://pub.dev"
     source: hosted
-    version: "5.13.0"
+    version: "6.4.1"
   args:
     dependency: transitive
     description:
@@ -513,7 +513,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.0.1"
+    version: "0.0.3"
   shelf:
     dependency: transitive
     description:
diff --git a/example/demo_example/.flutter-plugins b/example/demo_example/.flutter-plugins
@@ -0,0 +1,6 @@
+# This is a generated file; do not edit or check into version control.
+path_provider=/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider-2.1.5/
+path_provider_android=/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_android-2.2.10/
+path_provider_foundation=/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/
+path_provider_linux=/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/
+path_provider_windows=/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/
diff --git a/example/demo_example/.flutter-plugins-dependencies b/example/demo_example/.flutter-plugins-dependencies
@@ -0,0 +1 @@
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"path_provider_android","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_android-2.2.10/","native_build":true,"dependencies":[]}],"macos":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]}],"date_created":"2025-05-28 03:11:48.487150","version":"3.22.2"}
diff --git a/example/demo_example/pubspec.lock b/example/demo_example/pubspec.lock
@@ -444,7 +444,7 @@ packages:
       path: "../.."
       relative: true
     source: path
-    version: "0.0.2"
+    version: "0.0.3"
   shelf:
     dependency: transitive
     description:
diff --git a/lib/annotations/encrypted.dart b/lib/annotations/encrypted.dart
@@ -1,4 +1,12 @@
+/// Annotation to mark a field as encrypted with a specific encryption algorithm
 class Encrypted {
+  /// Creates a new [Encrypted] annotation with the specified encryption algorithm
+  ///
+  /// The [algorithm] parameter specifies which encryption algorithm to use
+  /// for encrypting the annotated field. Currently supported algorithms:
+  /// - "aes-256-gcm": AES-256 encryption in GCM mode
   const Encrypted({required this.algorithm});
+
+  /// The encryption algorithm to use for this field
   final String algorithm;
 }
diff --git a/lib/annotations/quanta_annotations.dart b/lib/annotations/quanta_annotations.dart
@@ -93,6 +93,20 @@ class QuantaManyToMany {
 }
 
 /// Annotation to mark a field as encrypted
+///
+/// When applied to a field, this annotation indicates that the field's value
+/// should be encrypted at rest. The encryption is handled automatically by
+/// QuantaDB using the configured encryption algorithm.
+///
+/// Example:
+/// ```dart
+/// class User {
+///   @QuantaEncrypted()
+///   final String password;
+///
+///   User({required this.password});
+/// }
+/// ```
 class QuantaEncrypted {
   const QuantaEncrypted();
 }
diff --git a/lib/builder.dart b/lib/builder.dart
@@ -6,6 +6,13 @@ import 'src/generator/quanta_generator.dart';
 /// Creates a builder that generates code using the QuantaGenerator.
 ///
 /// This builder is used to generate `.g.dart` files containing the generated code
-/// from the QuantaGenerator.
+/// from the QuantaGenerator. The generated code includes:
+/// - Type adapters for serialization
+/// - Data access objects (DAOs) for database operations
+/// - Validation logic for entity fields
+/// - Index and reactive field support
+///
+/// The builder is configured in `build.yaml` to run on all Dart files except
+/// those in the `lib/annotations` and `lib/src/generator` directories.
 Builder quantaBuilder(BuilderOptions options) =>
     PartBuilder([QuantaGenerator()], '.g.dart');
diff --git a/lib/quanta_db_imp.dart b/lib/quanta_db_imp.dart
@@ -4,16 +4,24 @@ import 'dart:io';
 
 /// The main database class that provides a high-level interface to the LSM storage engine
 class QuantaDB {
-  /// Create a new QuantaDB instance
+  /// Private constructor for QuantaDB that initializes the storage engine and query engine
   ///
-  /// `dbName` is the name of the database
-  /// The database will be stored in a platform-specific secure location
+  /// [storage] The LSM storage engine instance that handles data persistence
   QuantaDB._(this.storage) : queryEngine = QueryEngine(storage);
 
+  /// The LSM storage engine instance that handles data persistence
   final LSMStorage storage;
+
+  /// The query engine instance that handles data retrieval and filtering
   final QueryEngine queryEngine;
+
+  /// Flag indicating whether the database has been initialized
   bool _isInitialized = false;
 
+  /// Creates and initializes a new QuantaDB instance
+  ///
+  /// [dbName] The name of the database to create/open
+  /// Returns a [Future] that completes with the initialized [QuantaDB] instance
   static Future<QuantaDB> open(String dbName) async {
     String dbDir;
 
diff --git a/lib/src/builders/migration_builder.dart b/lib/src/builders/migration_builder.dart
@@ -1,10 +1,22 @@
 import 'package:build/build.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
-import 'package:quanta_db/src/migration/migration_generator.dart';
-import 'package:quanta_db/src/storage/schema_storage.dart';
-import 'package:quanta_db/src/schema/schema_version_manager.dart';
-
+import 'package:quanta_db/quanta_db.dart';
+
+/// Creates a builder that generates migration scripts for schema changes.
+Builder migrationBuilder(BuilderOptions options) =>
+    MigrationBuilder(SchemaStorage(LSMStorage('migrations')));
+
+/// A builder that generates migration scripts for schema changes in QuantaDB entities.
+///
+/// This builder is used to automatically generate migration scripts when schema changes
+/// are detected in classes annotated with [QuantaEntity]. It handles:
+/// - Field additions, modifications, and removals
+/// - Index changes
+/// - Schema version management
+///
+/// The generated migrations include both up and down migrations to support
+/// both forward and rollback operations.
 class MigrationBuilder implements Builder {
   MigrationBuilder(this._schemaStorage)
       : _versionManager = SchemaVersionManager(_schemaStorage.storage);
diff --git a/lib/src/generator/quanta_generator.dart b/lib/src/generator/quanta_generator.dart
diff --git a/lib/src/schema/schema_version_manager.dart b/lib/src/schema/schema_version_manager.dart
diff --git a/lib/src/storage/schema_storage.dart b/lib/src/storage/schema_storage.dart
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"path_provider_android","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_android-2.2.10/","native_build":true,"dependencies":[]}],"macos":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]}],"date_created":"2025-05-28 01:55:42.240198","version":"3.22.2"}
	`1`	+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"android":[{"name":"path_provider_android","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_android-2.2.10/","native_build":true,"dependencies":[]}],"macos":[{"name":"path_provider_foundation","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_foundation-2.4.1/","shared_darwin_source":true,"native_build":true,"dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_linux-2.2.1/","native_build":false,"dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/tusharnikam/.pub-cache/hosted/pub.dev/path_provider_windows-2.3.0/","native_build":false,"dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"path_provider","dependencies":["path_provider_android","path_provider_foundation","path_provider_linux","path_provider_windows"]},{"name":"path_provider_android","dependencies":[]},{"name":"path_provider_foundation","dependencies":[]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_windows","dependencies":[]}],"date_created":"2025-05-28 03:14:50.941691","version":"3.22.2"}