@goatlab/fluent-pouchdb 0.7.14 → 0.8.1

package/README.md

@@ -1,6 +1,6 @@
 # @goatlab/fluent-pouchdb
 
-PouchDB connector for the Goat Fluent query interface. Enables you to use PouchDB with the same unified API as other Fluent database connectors.
+PouchDB connector for the Goat Fluent query interface. Enables offline-first applications with automatic synchronization capabilities.
 
 ## Installation
 
@@ -16,25 +16,41 @@ pnpm add @goatlab/fluent-pouchdb
 
 ```typescript
 import { PouchDBConnector, PouchDB } from '@goatlab/fluent-pouchdb'
+import { f } from '@goatlab/fluent'
 import { z } from 'zod'
 
-// Define your schema
+// Define entity
+@f.entity('users')
+class UserEntity {
+  @f.id()
+  id?: string
+  
+  @f.property({ required: true })
+  name: string
+  
+  @f.property({ required: true })
+  email: string
+  
+  @f.created()
+  createdAt?: Date
+}
+
+// Define schema
 const UserSchema = z.object({
-  id: z.string(),
+  id: z.string().optional(),
   name: z.string(),
   email: z.string().email(),
-  created: z.date().optional()
+  createdAt: z.date().optional()
 })
 
 // Create PouchDB instance
-const db = new PouchDB('users', { adapter: 'memory' }) // or use 'leveldb' for persistence
+const db = new PouchDB('users')
 
 // Initialize connector
 const users = new PouchDBConnector({
-  entity: UserEntity, // Your entity class with decorators
+  entity: UserEntity,
   dataSource: db,
-  inputSchema: UserSchema,
-  outputSchema: UserSchema // optional, defaults to inputSchema
+  inputSchema: UserSchema
 })
 
 // Use Fluent API
@@ -43,20 +59,34 @@ const user = await users.insert({
   email: 'john@example.com' 
 })
 
+// Query data
 const found = await users.findMany({
   where: { email: { equals: 'john@example.com' } },
-  orderBy: [{ created: 'desc' }],
+  orderBy: [{ createdAt: 'desc' }],
   limit: 10
 })
+
+// Sync with CouchDB
+db.sync('http://localhost:5984/users', {
+  live: true,
+  retry: true
+})
 ```
 
 ## Key Features
 
+- **Offline-First** - Works without internet connection
+- **Automatic Sync** - Bidirectional replication with CouchDB
 - **Unified Fluent API** - Same query interface as other Fluent connectors
-- **Full CRUD operations** - insert, update, replace, delete with validation
-- **Advanced querying** - Complex where clauses with AND/OR logic
-- **Schema validation** - Input/output validation with Zod schemas
-- **In-memory sorting** - orderBy support without PouchDB indexes
-- **Pagination support** - Built-in pagination helpers
-- **PouchDB plugins** - Pre-configured with find, memory adapter, and json plugins
-- **Raw access** - Direct PouchDB database access via `.raw()` method
+- **Schema Validation** - Input/output validation with Zod
+- **Multiple Adapters** - IndexedDB, WebSQL, LevelDB, and in-memory
+- **Conflict Resolution** - Built-in handling for sync conflicts
+- **Raw Access** - Direct PouchDB database access via `.raw()` method
+
+## Documentation
+
+For comprehensive documentation, see the [Fluent PouchDB docs](https://docs.goatlab.io/0.1.x/connectors/pouchdb.html).
+
+## License
+
+MIT