@goatlab/fluent-formio 0.7.0 → 0.7.1

package/README.md

@@ -1,6 +1,6 @@
 # @goatlab/fluent-formio
 
-A fluent query interface connector for Form.io that provides a consistent API for CRUD operations with Form.io data sources. Currently includes a mock in-memory implementation for testing and development.
+A fluent query interface connector for Form.io that provides a type-safe, consistent API for CRUD operations with Form.io data sources.
 
 ## Installation
 
@@ -17,50 +17,39 @@ pnpm add @goatlab/fluent-formio
 ```typescript
 import { FormioConnector } from '@goatlab/fluent-formio'
 
-// Define your entity types
-interface User {
-  id?: string
-  name: string
-  email: string
-  age: number
-}
-
 // Create a connector instance
-const userConnector = new FormioConnector<User>({
-  baseEndPoint: 'http://localhost:3001/users',
-  token: 'your-formio-token' // optional
+const userConnector = new FormioConnector({
+  baseEndPoint: 'https://api.form.io/project/users',
+  token: 'your-formio-jwt-token'
 })
 
-// Insert a single record
+// Perform CRUD operations
 const user = await userConnector.insert({
-  name: 'John Doe',
-  email: 'john@example.com',
-  age: 30
+  data: {
+    name: 'John Doe',
+    email: 'john@example.com'
+  }
 })
 
-// Find records with fluent query syntax
-const adults = await userConnector.findMany({
-  where: { age: { greaterOrEqualThan: 18 } },
-  orderBy: [{ age: 'desc' }],
+const users = await userConnector.findMany({
+  where: { 'data.status': 'active' },
   limit: 10
 })
-
-// Find by ID
-const foundUser = await userConnector.findById(user.id)
-
-// Update a record
-await userConnector.updateById(user.id, {
-  age: 31
-})
 ```
 
 ## Key Features
 
-- **Fluent Query Interface** - Chain methods for complex queries with TypeScript support
-- **Form.io Compatible** - Designed to work with Form.io REST APIs
-- **In-Memory Mock Storage** - Built-in mock implementation for testing
-- **Type-Safe** - Full TypeScript support with generic types
-- **Standard CRUD Operations** - insert, findById, findMany, updateById, deleteById
-- **Advanced Queries** - Support for where clauses, ordering, pagination
-- **Batch Operations** - insertMany for bulk inserts
-- **Utility Methods** - findFirst, requireById, requireFirst, pluck
+- **Form.io REST API Integration** - Full support for Form.io submission and form APIs
+- **Type-Safe Queries** - TypeScript support with auto-completion
+- **Fluent Query Builder** - Chainable query methods for complex operations
+- **Built-in Mock Storage** - In-memory implementation for testing and development
+- **Form.io Authentication** - JWT token and API key support
+- **Advanced Filtering** - Support for nested properties, date ranges, and complex conditions
+
+## Documentation
+
+For comprehensive documentation, see the [Form.io Connector Guide](https://docs.goatlab.io/connectors/formio).
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goatlab/fluent-formio",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Readable query Interface & API generator for TS and Node",
   "homepage": "https://docs.goatlab.io",
   "main": "dist/index.js",
@@ -19,8 +19,8 @@
   "author": "ignacio.cabrera@goatlab.io",
   "license": "MIT",
   "dependencies": {
-    "@goatlab/fluent": "0.8.0",
-    "@goatlab/js-utils": "0.9.0"
+    "@goatlab/js-utils": "0.9.0",
+    "@goatlab/fluent": "0.8.1"
   },
   "devDependencies": {
     "@types/node": "^17.0.23",