@blinkdotnew/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Blink Team
+
+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,343 @@
+# @blinkdotnew/sdk
+
+[![npm version](https://badge.fury.io/js/%40blinkdotnew%2Fsdk.svg)](https://badge.fury.io/js/%40blinkdotnew%2Fsdk)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+
+**Zero-boilerplate CRUD + auth for modern SaaS/AI apps**
+
+Blink SDK provides a Firebase/Supabase-like experience with built-in authentication, database operations, AI capabilities, and file storage. Works seamlessly on both client-side (React, Vue, etc.) and server-side (Node.js, Deno, Edge functions).
+
+## 🚀 Quick Start
+
+```bash
+npm install @blinkdotnew/sdk
+```
+
+```typescript
+import { createClient } from '@blinkdotnew/sdk'
+
+const blink = createClient({
+  projectId: 'your-project-id',
+  authRequired: true
+})
+
+// Authentication
+const user = await blink.auth.me()
+
+// Database operations
+const todos = await blink.db.todos.list({
+  where: { user_id: user.id },
+  orderBy: { created_at: 'desc' },
+  limit: 20
+})
+
+// AI operations
+const { text } = await blink.ai.generateText({
+  prompt: "Write a summary of the user's todos"
+})
+
+// Storage operations
+const { publicUrl } = await blink.storage.upload(
+  file,
+  `avatars/${user.id}.png`,
+  { upsert: true }
+)
+```
+
+## 📚 Features
+
+- **🔐 Authentication**: JWT-based auth with automatic token management
+- **🗄️ Database**: PostgREST-compatible CRUD operations with advanced filtering
+- **🤖 AI**: Text generation, object generation, image creation, speech synthesis, and transcription
+- **📁 Storage**: File upload, download, and management
+- **🌐 Universal**: Works on client-side and server-side
+- **📱 Framework Agnostic**: React, Vue, Svelte, vanilla JS, Node.js, Deno
+- **🔄 Real-time**: Built-in auth state management and token refresh
+
+## 🛠️ Installation & Setup
+
+### Client-side (React, Vue, etc.)
+
+```typescript
+import { createClient } from '@blinkdotnew/sdk'
+
+const blink = createClient({
+  projectId: 'your-project-id',
+  authRequired: true // Automatic auth redirect
+})
+```
+
+### Server-side (Node.js, Deno, Edge functions)
+
+```typescript
+import { createClient } from '@blinkdotnew/sdk'
+
+const blink = createClient({
+  projectId: 'your-project-id',
+  authRequired: false // Manual token management
+})
+
+// Set JWT manually
+blink.auth.setToken(jwtFromHeader)
+```
+
+## 📖 API Reference
+
+### Authentication
+
+```typescript
+// Login/logout
+blink.auth.login(nextUrl?)
+blink.auth.logout(redirectUrl?)
+
+// User management
+const user = await blink.auth.me()
+await blink.auth.updateMe({ displayName: 'New Name' })
+
+// Token management
+blink.auth.setToken(jwt, persist?)
+const isAuth = blink.auth.isAuthenticated()
+
+// Auth state listener
+const unsubscribe = blink.auth.onAuthStateChanged((state) => {
+  console.log('Auth state:', state)
+})
+```
+
+### Database Operations
+
+```typescript
+// Create
+const todo = await blink.db.todos.create({
+  title: 'Learn Blink SDK',
+  user_id: user.id
+})
+
+// Read with filtering
+const todos = await blink.db.todos.list({
+  where: {
+    AND: [
+      { user_id: user.id },
+      { OR: [{ status: 'open' }, { priority: 'high' }] }
+    ]
+  },
+  orderBy: { created_at: 'desc' },
+  limit: 20
+})
+
+// Update
+await blink.db.todos.update(todo.id, { completed: true })
+
+// Delete
+await blink.db.todos.delete(todo.id)
+
+// Bulk operations
+await blink.db.todos.createMany([...])
+await blink.db.todos.upsertMany([...])
+
+// Advanced queries
+const count = await blink.db.todos.count({ where: { user_id: user.id } })
+const exists = await blink.db.todos.exists({ where: { urgent: true } })
+
+// Raw SQL
+const result = await blink.db.sql('SELECT * FROM todos WHERE user_id = ?', [user.id])
+```
+
+### AI Operations
+
+```typescript
+// Text generation
+const { text } = await blink.ai.generateText({
+  prompt: 'Write a poem about coding',
+  model: 'gpt-4o-mini',
+  maxTokens: 150
+})
+
+// Structured object generation
+const { object } = await blink.ai.generateObject({
+  prompt: 'Generate a user profile',
+  schema: {
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      age: { type: 'number' }
+    }
+  }
+})
+
+// Image generation
+const { data } = await blink.ai.generateImage({
+  prompt: 'A serene landscape',
+  size: '1024x1024',
+  quality: 'hd'
+})
+
+// Speech synthesis
+const { url } = await blink.ai.generateSpeech({
+  text: 'Hello, world!',
+  voice: 'nova'
+})
+
+// Audio transcription
+const { text } = await blink.ai.transcribeAudio({
+  audio: audioFile,
+  language: 'en'
+})
+
+// Streaming support
+await blink.ai.streamText(
+  { prompt: 'Write a story...' },
+  (chunk) => console.log(chunk)
+)
+```
+
+### Storage Operations
+
+```typescript
+// Upload files
+const { publicUrl } = await blink.storage.upload(
+  file,
+  'path/to/file.jpg',
+  {
+    upsert: true,
+    onProgress: (percent) => console.log(`${percent}%`)
+  }
+)
+
+// List files
+const files = await blink.storage.list('folder/')
+
+// Get public URL
+const url = await blink.storage.getPublicUrl('path/to/file.jpg')
+
+// Remove files
+await blink.storage.remove('file1.jpg', 'file2.jpg')
+
+// Copy/move files
+await blink.storage.copy('source.jpg', 'destination.jpg')
+await blink.storage.move('old-path.jpg', 'new-path.jpg')
+```
+
+## 🔧 Advanced Usage
+
+### Error Handling
+
+```typescript
+import { BlinkAuthError, BlinkAIError, BlinkStorageError } from '@blinkdotnew/sdk'
+
+try {
+  const user = await blink.auth.me()
+} catch (error) {
+  if (error instanceof BlinkAuthError) {
+    // Handle auth errors
+    console.error('Auth error:', error.message)
+  }
+}
+```
+
+### Custom Configuration
+
+```typescript
+const blink = createClient({
+  projectId: 'your-project',
+  baseUrl: 'https://custom-api.example.com',
+  authRequired: true,
+  httpClient: {
+    timeout: 30000,
+    retries: 3
+  }
+})
+```
+
+### TypeScript Support
+
+The SDK is written in TypeScript and provides full type safety:
+
+```typescript
+interface Todo {
+  id: string
+  title: string
+  completed: boolean
+  user_id: string
+  created_at: string
+}
+
+const todos = await blink.db.todos.list<Todo>({
+  where: { completed: false }
+})
+// todos is fully typed as ListResponse<Todo>
+```
+
+## 🌍 Framework Examples
+
+### React
+
+```typescript
+import { createClient } from '@blinkdotnew/sdk'
+import { useState, useEffect } from 'react'
+
+const blink = createClient({ projectId: 'your-project', authRequired: true })
+
+function App() {
+  const [user, setUser] = useState(null)
+
+  useEffect(() => {
+    const unsubscribe = blink.auth.onAuthStateChanged((state) => {
+      setUser(state.user)
+    })
+    return unsubscribe
+  }, [])
+
+  if (!user) return <div>Please log in</div>
+
+  return <div>Welcome, {user.email}!</div>
+}
+```
+
+### Next.js API Routes
+
+```typescript
+// pages/api/todos.ts
+import { createClient } from '@blinkdotnew/sdk'
+
+const blink = createClient({ projectId: 'your-project', authRequired: false })
+
+export default async function handler(req, res) {
+  const jwt = req.headers.authorization?.replace('Bearer ', '')
+  blink.auth.setToken(jwt)
+
+  const todos = await blink.db.todos.list()
+  res.json(todos)
+}
+```
+
+### Deno Edge Function
+
+```typescript
+import { createClient } from '@blinkdotnew/sdk'
+
+const blink = createClient({ projectId: 'your-project', authRequired: false })
+
+Deno.serve(async (req) => {
+  const jwt = req.headers.get('authorization')?.replace('Bearer ', '')
+  blink.auth.setToken(jwt)
+
+  const todos = await blink.db.todos.list()
+  return Response.json(todos)
+})
+```
+
+## 🔗 Links
+
+- **Documentation**: [https://docs.blink.new](https://docs.blink.new)
+- **GitHub**: [https://github.com/ShadowWalker2014/blink-sdk](https://github.com/ShadowWalker2014/blink-sdk)
+- **Website**: [https://blink.new](https://blink.new)
+- **Discord**: [Join our community](https://discord.gg/blink)
+
+## 📄 License
+
+MIT © Blink Team
+
+---
+
+**Made with ❤️ by the Blink team**