@vaiftech/client 1.0.1 → 1.0.3

package/README.md

@@ -23,9 +23,34 @@ const vaif = createVaifClient({
 });
 ```
 
-## Features
-
-### Authentication
+## Modules
+
+The client provides access to the following modules:
+
+| Module | Description |
+|--------|-------------|
+| `vaif.auth` | Authentication (email, OAuth, MFA, magic link) |
+| `vaif.from()` | Database operations with query builder |
+| `vaif.mongodb` | MongoDB document database |
+| `vaif.realtime()` | Real-time subscriptions and presence |
+| `vaif.storage` | File storage and CDN |
+| `vaif.functions` | Edge functions |
+| `vaif.projects` | Project management |
+| `vaif.orgs` | Organization management |
+| `vaif.schema` | Database schema migrations |
+| `vaif.secrets` | Secret management |
+| `vaif.deployments` | Deployment management |
+| `vaif.integrations` | Webhooks and events |
+| `vaif.billing` | Billing and subscriptions |
+| `vaif.flags` | Feature flags |
+| `vaif.security` | Security and environment variables |
+| `vaif.ai` | AI-powered code generation |
+| `vaif.templates` | Project templates |
+| `vaif.oauth` | OAuth provider configuration |
+| `vaif.docs` | Documentation management |
+| `vaif.admin` | Admin operations |
+
+## Authentication
 
 ```typescript
 // Sign up
@@ -46,6 +71,13 @@ const { url } = await vaif.auth.signInWithOAuth({
   redirectTo: 'https://myapp.com/callback',
 });
 
+// Magic Link
+await vaif.auth.requestMagicLink({ email: 'user@example.com' });
+
+// MFA
+const { qrCode, secret } = await vaif.auth.setupMFA({ method: 'totp' });
+await vaif.auth.verifyMFA({ code: '123456' });
+
 // Get current user
 const user = await vaif.auth.getUser();
 
@@ -53,7 +85,31 @@ const user = await vaif.auth.getUser();
 await vaif.auth.signOut();
 ```
 
-### Database Operations
+### Standalone Auth Client
+
+For auth-only applications, use the standalone auth package:
+
+```typescript
+import { createAuthClient } from '@vaiftech/client';
+// or import directly: import { createAuthClient } from '@vaiftech/auth';
+
+const auth = createAuthClient({
+  url: 'https://api.vaif.studio',
+  apiKey: 'your-project-key',
+});
+
+// Full auth functionality
+await auth.signInWithPassword({ email, password });
+await auth.signInWithOAuth({ provider: 'google' });
+await auth.signInWithMagicLink({ email });
+
+// Session management
+auth.onAuthStateChange((event) => {
+  console.log('Auth event:', event.event);
+});
+```
+
+## Database Operations
 
 ```typescript
 // Define your types
@@ -93,12 +149,126 @@ await vaif.from<User>('users')
   .eq('id', 'user-123')
   .delete();
 
+// Batch operations
+await vaif.from<User>('users').batchCreate([
+  { email: 'user1@example.com', name: 'User 1' },
+  { email: 'user2@example.com', name: 'User 2' },
+]);
+
 // Pagination
 const { data, total, page, pageSize } = await vaif.from<User>('users')
   .paginate({ page: 1, pageSize: 20 });
+
+// Aggregations
+const stats = await vaif.from<User>('users')
+  .aggregate({ count: '*', avg: 'age' });
+```
+
+## MongoDB Operations
+
+Full MongoDB support for document-based data:
+
+```typescript
+// Get a collection reference
+const users = vaif.mongodb.collection<User>('users');
+
+// Find documents
+const activeUsers = await users.find({
+  filter: { status: 'active' },
+  sort: { createdAt: -1 },
+  limit: 10,
+});
+
+// Find one document
+const user = await users.findOne({ email: 'user@example.com' });
+
+// Find by ID
+const userById = await users.findById('507f1f77bcf86cd799439011');
+
+// Insert documents
+const newUser = await users.insertOne({
+  email: 'new@example.com',
+  name: 'New User',
+  createdAt: new Date(),
+});
+
+const manyUsers = await users.insertMany([
+  { email: 'user1@example.com', name: 'User 1' },
+  { email: 'user2@example.com', name: 'User 2' },
+]);
+
+// Update documents
+await users.updateOne(
+  { email: 'user@example.com' },
+  { $set: { name: 'Updated Name' } }
+);
+
+await users.updateMany(
+  { status: 'pending' },
+  { $set: { status: 'active' } }
+);
+
+// Atomic operations
+const updated = await users.findOneAndUpdate(
+  { email: 'user@example.com' },
+  { $inc: { loginCount: 1 } },
+  { returnDocument: 'after' }
+);
+
+// Delete documents
+await users.deleteOne({ email: 'old@example.com' });
+await users.deleteMany({ status: 'inactive' });
+
+// Aggregation pipeline
+const stats = await users.aggregate([
+  { $match: { status: 'active' } },
+  { $group: { _id: '$country', count: { $sum: 1 } } },
+  { $sort: { count: -1 } },
+]);
+
+// Count and distinct
+const totalUsers = await users.count({ status: 'active' });
+const countries = await users.distinct('country', { status: 'active' });
+
+// Index management
+const indexes = await users.listIndexes();
+await users.createIndex({ email: 1 }, { unique: true });
+await users.dropIndex('old_index');
+
+// Bulk operations
+await users.bulkWrite([
+  { insertOne: { document: { email: 'bulk@example.com' } } },
+  { updateOne: { filter: { email: 'old@example.com' }, update: { $set: { migrated: true } } } },
+  { deleteOne: { filter: { email: 'remove@example.com' } } },
+]);
+
+// Collection management
+const collections = await vaif.mongodb.listCollections();
+await vaif.mongodb.createCollection('logs');
 ```
 
-### Realtime Subscriptions
+### Cursor Support
+
+For large datasets, use cursors to paginate through results:
+
+```typescript
+const cursor = await users.findWithCursor({
+  filter: { status: 'active' },
+  batchSize: 100,
+});
+
+let batch = await cursor.next();
+while (batch.length > 0) {
+  for (const user of batch) {
+    console.log(user.email);
+  }
+  batch = await cursor.next();
+}
+
+await cursor.close();
+```
+
+## Realtime Subscriptions
 
 ```typescript
 const realtime = vaif.realtime();
@@ -132,7 +302,7 @@ realtime.unsubscribe({ table: 'messages' });
 await realtime.disconnect();
 ```
 
-### Storage
+## Storage
 
 ```typescript
 // Upload file
@@ -157,9 +327,15 @@ const { files } = await vaif.storage.list({ prefix: 'avatars/' });
 
 // Delete file
 await vaif.storage.delete('avatars/old-avatar.jpg');
+
+// Multipart uploads for large files
+const upload = await vaif.storage.createMultipartUpload('large-file.zip');
+await vaif.storage.uploadPart(upload.uploadId, 1, chunk1);
+await vaif.storage.uploadPart(upload.uploadId, 2, chunk2);
+await vaif.storage.completeMultipartUpload(upload.uploadId, parts);
 ```
 
-### Edge Functions
+## Edge Functions
 
 ```typescript
 // Invoke a function
@@ -169,13 +345,57 @@ const result = await vaif.functions.invoke('send-email', {
   body: 'Welcome to VAIF!',
 });
 
+// Invoke with options
+const result = await vaif.functions.invoke('process-data', payload, {
+  timeout: 30000,
+  retry: { attempts: 3, backoff: 'exponential' },
+});
+
+// Batch invoke
+const results = await vaif.functions.batchInvoke([
+  { name: 'func1', payload: { data: 1 } },
+  { name: 'func2', payload: { data: 2 } },
+]);
+
 // List functions
 const functions = await vaif.functions.list({ projectId: 'proj-123' });
+
+// Deploy a function
+await vaif.functions.deploy('my-function', {
+  code: functionCode,
+  runtime: 'node20',
+});
+```
+
+## Integrations (Webhooks & Events)
+
+```typescript
+// Create a webhook subscription
+const subscription = await vaif.integrations.createSubscription({
+  type: 'webhook',
+  url: 'https://myapp.com/webhooks',
+  events: ['user.created', 'user.updated'],
+  secret: 'whsec_xxx',
+});
+
+// Publish custom events
+await vaif.integrations.publish({
+  name: 'order.completed',
+  data: { orderId: '123', amount: 99.99 },
+});
+
+// List webhook deliveries
+const deliveries = await vaif.integrations.listDeliveries({
+  subscriptionId: 'sub-123',
+});
+
+// Retry failed delivery
+await vaif.integrations.retryDelivery('delivery-123');
 ```
 
 ## TypeScript Support
 
-The SDK is fully typed. Use generics for type-safe database operations:
+The SDK is fully typed. Use generics for type-safe operations:
 
 ```typescript
 interface Post {
@@ -189,10 +409,39 @@ interface Post {
 // Full type inference
 const posts = await vaif.from<Post>('posts').list();
 // posts is Post[]
+
+// MongoDB with types
+const users = vaif.mongodb.collection<User>('users');
+const user = await users.findOne({ email: 'test@example.com' });
+// user is User | null
+```
+
+## Error Handling
+
+```typescript
+import {
+  VaifError,
+  VaifAuthError,
+  VaifNotFoundError,
+  isVaifError
+} from '@vaiftech/client';
+
+try {
+  await vaif.from('users').eq('id', 'invalid').single();
+} catch (error) {
+  if (error instanceof VaifNotFoundError) {
+    console.log('User not found');
+  } else if (error instanceof VaifAuthError) {
+    console.log('Authentication failed');
+  } else if (isVaifError(error)) {
+    console.log('VAIF error:', error.message);
+  }
+}
 ```
 
 ## Related Packages
 
+- [@vaiftech/auth](https://www.npmjs.com/package/@vaiftech/auth) - Standalone authentication client
 - [@vaiftech/react](https://www.npmjs.com/package/@vaiftech/react) - React hooks
 - [@vaiftech/sdk-expo](https://www.npmjs.com/package/@vaiftech/sdk-expo) - React Native/Expo SDK
 - [@vaiftech/cli](https://www.npmjs.com/package/@vaiftech/cli) - CLI tools