@vaiftech/client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 VAIF Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,202 @@
+# @vaif/client
+
+The official TypeScript SDK for VAIF Studio - a Backend-as-a-Service platform.
+
+## Installation
+
+```bash
+npm install @vaif/client
+# or
+pnpm add @vaif/client
+# or
+yarn add @vaif/client
+```
+
+## Quick Start
+
+```typescript
+import { createVaifClient } from '@vaif/client';
+
+const vaif = createVaifClient({
+  baseUrl: 'https://api.myproject.vaif.io',
+  apiKey: 'vaif_pk_xxx',
+});
+```
+
+## Features
+
+### Authentication
+
+```typescript
+// Sign up
+const { user, session } = await vaif.auth.signUp({
+  email: 'user@example.com',
+  password: 'securepassword',
+});
+
+// Sign in
+const { user, session } = await vaif.auth.signIn({
+  email: 'user@example.com',
+  password: 'securepassword',
+});
+
+// OAuth
+const { url } = await vaif.auth.signInWithOAuth({
+  provider: 'google',
+  redirectTo: 'https://myapp.com/callback',
+});
+
+// Get current user
+const user = await vaif.auth.getUser();
+
+// Sign out
+await vaif.auth.signOut();
+```
+
+### Database Operations
+
+```typescript
+// Define your types
+interface User {
+  id: string;
+  email: string;
+  name: string;
+  createdAt: string;
+}
+
+// List with filters
+const users = await vaif.from<User>('users')
+  .select('id', 'name', 'email')
+  .eq('active', true)
+  .orderBy('createdAt', 'desc')
+  .limit(10)
+  .list();
+
+// Get single record
+const user = await vaif.from<User>('users')
+  .eq('id', 'user-123')
+  .single();
+
+// Create
+const newUser = await vaif.from<User>('users').create({
+  email: 'new@example.com',
+  name: 'New User',
+});
+
+// Update
+const updated = await vaif.from<User>('users')
+  .eq('id', 'user-123')
+  .update({ name: 'Updated Name' });
+
+// Delete
+await vaif.from<User>('users')
+  .eq('id', 'user-123')
+  .delete();
+
+// Pagination
+const { data, total, page, pageSize } = await vaif.from<User>('users')
+  .paginate({ page: 1, pageSize: 20 });
+```
+
+### Realtime Subscriptions
+
+```typescript
+const realtime = vaif.realtime();
+await realtime.connect();
+
+// Subscribe to table changes
+realtime.subscribe(
+  { table: 'messages', event: 'INSERT' },
+  (event) => {
+    console.log('New message:', event.new);
+  }
+);
+
+// Channel messaging
+const channel = realtime.channel('room-1');
+
+// Presence
+channel.presence.track({ userId: 'user-123', status: 'online' });
+channel.presence.onSync((state) => {
+  console.log('Online users:', Object.keys(state));
+});
+
+// Broadcast
+channel.broadcast.send('typing', { userId: 'user-123' });
+channel.broadcast.on('typing', (payload) => {
+  console.log('User typing:', payload.userId);
+});
+
+// Cleanup
+realtime.unsubscribe({ table: 'messages' });
+await realtime.disconnect();
+```
+
+### Storage
+
+```typescript
+// Upload file
+const result = await vaif.storage.upload('avatars/user-123.jpg', file, {
+  contentType: 'image/jpeg',
+  isPublic: true,
+});
+
+// Download file
+const blob = await vaif.storage.download('avatars/user-123.jpg');
+
+// Get public URL
+const url = vaif.storage.getPublicUrl('avatars/user-123.jpg');
+
+// Get signed URL (temporary access)
+const signedUrl = await vaif.storage.getSignedUrl('private/doc.pdf', {
+  expiresIn: 3600,
+});
+
+// List files
+const { files } = await vaif.storage.list({ prefix: 'avatars/' });
+
+// Delete file
+await vaif.storage.delete('avatars/old-avatar.jpg');
+```
+
+### Edge Functions
+
+```typescript
+// Invoke a function
+const result = await vaif.functions.invoke('send-email', {
+  to: 'user@example.com',
+  subject: 'Hello',
+  body: 'Welcome to VAIF!',
+});
+
+// List functions
+const functions = await vaif.functions.list({ projectId: 'proj-123' });
+```
+
+## TypeScript Support
+
+The SDK is fully typed. Use generics for type-safe database operations:
+
+```typescript
+interface Post {
+  id: string;
+  title: string;
+  content: string;
+  authorId: string;
+  createdAt: string;
+}
+
+// Full type inference
+const posts = await vaif.from<Post>('posts').list();
+// posts is Post[]
+```
+
+## Related Packages
+
+- [@vaif/react](https://www.npmjs.com/package/@vaif/react) - React hooks
+- [@vaif/sdk-expo](https://www.npmjs.com/package/@vaif/sdk-expo) - React Native/Expo SDK
+- [@vaif/cli](https://www.npmjs.com/package/@vaif/cli) - CLI tools
+
+## License
+
+MIT