@insforge/sdk 0.0.58-dev.0 → 0.0.58-dev.10

package/README.md

@@ -1,249 +1,249 @@
-# insforge-sdk-js
-
-[![npm version](https://img.shields.io/npm/v/@insforge/sdk.svg)](https://www.npmjs.com/package/@insforge/sdk)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-
-Official TypeScript/JavaScript SDK for [InsForge](https://github.com/InsForge/InsForge) - A powerful, open-source Backend-as-a-Service (BaaS) platform.
-
-## Features
-
-- **Authentication** - Email/password, OAuth (Google, GitHub), session management
-- **Database** - Full PostgreSQL database access with PostgREST
-- **Storage** - File upload and management with S3-compatible storage
-- **Edge Functions** - Serverless function invocation
-- **AI Integration** - Built-in AI capabilities
-- **TypeScript** - Full TypeScript support with type definitions
-- **Automatic OAuth Handling** - Seamless OAuth callback detection
-
-## Installation
-
-```bash
-npm install @insforge/sdk
-```
-
-Or with yarn:
-
-```bash
-yarn add @insforge/sdk
-```
-
-## Quick Start
-
-### Initialize the Client
-
-```javascript
-import { createClient } from '@insforge/sdk';
-
-const insforge = createClient({
-  baseUrl: 'http://localhost:7130' // Your InsForge backend URL
-});
-```
-
-### Authentication
-
-```javascript
-// Sign up a new user
-const { data, error } = await insforge.auth.signUp({
-  email: 'user@example.com',
-  password: 'securePassword123',
-  name: 'John Doe' // optional
-});
-
-// Sign in with email/password
-const { data, error } = await insforge.auth.signInWithPassword({
-  email: 'user@example.com',
-  password: 'securePassword123'
-});
-
-// OAuth authentication (Google, GitHub)
-await insforge.auth.signInWithOAuth({
-  provider: 'google',
-  redirectTo: 'http://localhost:3000/dashboard'
-});
-
-// Get current user
-const { data: user } = await insforge.auth.getCurrentUser();
-
-// Sign out
-await insforge.auth.signOut();
-```
-
-### Database Operations
-
-```javascript
-// Insert data
-const { data, error } = await insforge.database
-  .from('posts')
-  .insert([
-    { title: 'My First Post', content: 'Hello World!' }
-  ]);
-
-// Query data
-const { data, error } = await insforge.database
-  .from('posts')
-  .select('*')
-  .eq('author_id', userId);
-
-// Update data
-const { data, error } = await insforge.database
-  .from('posts')
-  .update({ title: 'Updated Title' })
-  .eq('id', postId);
-
-// Delete data
-const { data, error } = await insforge.database
-  .from('posts')
-  .delete()
-  .eq('id', postId);
-```
-
-### File Storage
-
-```javascript
-// Upload a file
-const file = document.querySelector('input[type="file"]').files[0];
-const { data, error } = await insforge.storage
-  .from('avatars')
-  .upload(file);
-
-// Download a file
-const { data, error } = await insforge.storage
-  .from('avatars')
-  .download('user-avatar.png');
-
-// Delete a file
-const { data, error } = await insforge.storage
-  .from('avatars')
-  .remove(['user-avatar.png']);
-
-// List files
-const { data, error } = await insforge.storage
-  .from('avatars')
-  .list();
-```
-
-### Edge Functions
-
-```javascript
-// Invoke an edge function
-const { data, error } = await insforge.functions.invoke('my-function', {
-  body: { key: 'value' }
-});
-```
-
-### AI Integration
-
-```javascript
-// Generate text completion
-const { data, error } = await insforge.ai.completion({
-  model: 'gpt-3.5-turbo',
-  prompt: 'Write a hello world program'
-});
-
-// Analyze an image
-const { data, error } = await insforge.ai.vision({
-  imageUrl: 'https://example.com/image.jpg',
-  prompt: 'Describe this image'
-});
-```
-
-## Documentation
-
-For complete API reference and advanced usage, see:
-
-- **[SDK Reference](./SDK-REFERENCE.md)** - Complete API documentation
-- **[InsForge Main Repository](https://github.com/InsForge/InsForge)** - Backend platform and setup guides
-
-## Configuration
-
-The SDK supports the following configuration options:
-
-```javascript
-const insforge = createClient({
-  baseUrl: 'http://localhost:7130',  // Required: Your InsForge backend URL
-  storageStrategy: 'localStorage'     // Optional: 'localStorage' or 'memory' (default: 'localStorage')
-});
-```
-
-## TypeScript Support
-
-The SDK is written in TypeScript and provides full type definitions:
-
-```typescript
-import { createClient, InsForgeClient, User, Session } from '@insforge/sdk';
-
-const insforge: InsForgeClient = createClient({
-  baseUrl: 'http://localhost:7130'
-});
-
-// Type-safe API calls
-const response: { data: User | null; error: Error | null } =
-  await insforge.auth.getCurrentUser();
-```
-
-## Error Handling
-
-All SDK methods return a consistent response format:
-
-```javascript
-const { data, error } = await insforge.auth.signUp({...});
-
-if (error) {
-  console.error('Error:', error.message);
-  console.error('Status:', error.statusCode);
-} else {
-  console.log('Success:', data);
-}
-```
-
-## Browser Support
-
-The SDK works in all modern browsers that support:
-- ES6+ features
-- Fetch API
-- LocalStorage (for session management)
-
-For Node.js environments, ensure you're using Node.js 18 or higher.
-
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
-
-### Development Setup
-
-```bash
-# Clone the repository
-git clone https://github.com/InsForge/insforge-sdk-js.git
-cd insforge-sdk-js
-
-# Install dependencies
-npm install
-
-# Build the SDK
-npm run build
-
-# Run tests
-npm test
-
-# Run integration tests
-npm run test:integration
-```
-
-## License
-
-This project is licensed under the Apache License 2.0 - see the [LICENSE](./LICENSE) file for details.
-
-## Community & Support
-
-- **GitHub Issues**: [Report bugs or request features](https://github.com/InsForge/insforge-sdk-js/issues)
-- **Documentation**: [https://docs.insforge.com](https://docs.insforge.com)
-- **Main Repository**: [InsForge Backend Platform](https://github.com/InsForge/InsForge)
-
-## Related Projects
-
-- **[InsForge](https://github.com/InsForge/InsForge)** - The main InsForge backend platform
-- **[InsForge MCP](https://github.com/InsForge/insforge-mcp)** - Model Context Protocol server for InsForge
-
----
-
-Built with ❤️ by the InsForge team
+# insforge-sdk-js
+
+[![npm version](https://img.shields.io/npm/v/@insforge/sdk.svg)](https://www.npmjs.com/package/@insforge/sdk)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Official TypeScript/JavaScript SDK for [InsForge](https://github.com/InsForge/InsForge) - A powerful, open-source Backend-as-a-Service (BaaS) platform.
+
+## Features
+
+- **Authentication** - Email/password, OAuth (Google, GitHub), session management
+- **Database** - Full PostgreSQL database access with PostgREST
+- **Storage** - File upload and management with S3-compatible storage
+- **Edge Functions** - Serverless function invocation
+- **AI Integration** - Built-in AI capabilities
+- **TypeScript** - Full TypeScript support with type definitions
+- **Automatic OAuth Handling** - Seamless OAuth callback detection
+
+## Installation
+
+```bash
+npm install @insforge/sdk
+```
+
+Or with yarn:
+
+```bash
+yarn add @insforge/sdk
+```
+
+## Quick Start
+
+### Initialize the Client
+
+```javascript
+import { createClient } from '@insforge/sdk';
+
+const insforge = createClient({
+  baseUrl: 'http://localhost:7130' // Your InsForge backend URL
+});
+```
+
+### Authentication
+
+```javascript
+// Sign up a new user
+const { data, error } = await insforge.auth.signUp({
+  email: 'user@example.com',
+  password: 'securePassword123',
+  name: 'John Doe' // optional
+});
+
+// Sign in with email/password
+const { data, error } = await insforge.auth.signInWithPassword({
+  email: 'user@example.com',
+  password: 'securePassword123'
+});
+
+// OAuth authentication (Google, GitHub)
+await insforge.auth.signInWithOAuth({
+  provider: 'google',
+  redirectTo: 'http://localhost:3000/dashboard'
+});
+
+// Get current user
+const { data: user } = await insforge.auth.getCurrentUser();
+
+// Sign out
+await insforge.auth.signOut();
+```
+
+### Database Operations
+
+```javascript
+// Insert data
+const { data, error } = await insforge.database
+  .from('posts')
+  .insert([
+    { title: 'My First Post', content: 'Hello World!' }
+  ]);
+
+// Query data
+const { data, error } = await insforge.database
+  .from('posts')
+  .select('*')
+  .eq('author_id', userId);
+
+// Update data
+const { data, error } = await insforge.database
+  .from('posts')
+  .update({ title: 'Updated Title' })
+  .eq('id', postId);
+
+// Delete data
+const { data, error } = await insforge.database
+  .from('posts')
+  .delete()
+  .eq('id', postId);
+```
+
+### File Storage
+
+```javascript
+// Upload a file
+const file = document.querySelector('input[type="file"]').files[0];
+const { data, error } = await insforge.storage
+  .from('avatars')
+  .upload(file);
+
+// Download a file
+const { data, error } = await insforge.storage
+  .from('avatars')
+  .download('user-avatar.png');
+
+// Delete a file
+const { data, error } = await insforge.storage
+  .from('avatars')
+  .remove(['user-avatar.png']);
+
+// List files
+const { data, error } = await insforge.storage
+  .from('avatars')
+  .list();
+```
+
+### Edge Functions
+
+```javascript
+// Invoke an edge function
+const { data, error } = await insforge.functions.invoke('my-function', {
+  body: { key: 'value' }
+});
+```
+
+### AI Integration
+
+```javascript
+// Generate text completion
+const { data, error } = await insforge.ai.completion({
+  model: 'gpt-3.5-turbo',
+  prompt: 'Write a hello world program'
+});
+
+// Analyze an image
+const { data, error } = await insforge.ai.vision({
+  imageUrl: 'https://example.com/image.jpg',
+  prompt: 'Describe this image'
+});
+```
+
+## Documentation
+
+For complete API reference and advanced usage, see:
+
+- **[SDK Reference](./SDK-REFERENCE.md)** - Complete API documentation
+- **[InsForge Main Repository](https://github.com/InsForge/InsForge)** - Backend platform and setup guides
+
+## Configuration
+
+The SDK supports the following configuration options:
+
+```javascript
+const insforge = createClient({
+  baseUrl: 'http://localhost:7130',  // Required: Your InsForge backend URL
+  storageStrategy: 'localStorage'     // Optional: 'localStorage' or 'memory' (default: 'localStorage')
+});
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and provides full type definitions:
+
+```typescript
+import { createClient, InsForgeClient, User, Session } from '@insforge/sdk';
+
+const insforge: InsForgeClient = createClient({
+  baseUrl: 'http://localhost:7130'
+});
+
+// Type-safe API calls
+const response: { data: User | null; error: Error | null } =
+  await insforge.auth.getCurrentUser();
+```
+
+## Error Handling
+
+All SDK methods return a consistent response format:
+
+```javascript
+const { data, error } = await insforge.auth.signUp({...});
+
+if (error) {
+  console.error('Error:', error.message);
+  console.error('Status:', error.statusCode);
+} else {
+  console.log('Success:', data);
+}
+```
+
+## Browser Support
+
+The SDK works in all modern browsers that support:
+- ES6+ features
+- Fetch API
+- LocalStorage (for session management)
+
+For Node.js environments, ensure you're using Node.js 18 or higher.
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/InsForge/insforge-sdk-js.git
+cd insforge-sdk-js
+
+# Install dependencies
+npm install
+
+# Build the SDK
+npm run build
+
+# Run tests
+npm test
+
+# Run integration tests
+npm run test:integration
+```
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](./LICENSE) file for details.
+
+## Community & Support
+
+- **GitHub Issues**: [Report bugs or request features](https://github.com/InsForge/insforge-sdk-js/issues)
+- **Documentation**: [https://docs.insforge.com](https://docs.insforge.com)
+- **Main Repository**: [InsForge Backend Platform](https://github.com/InsForge/InsForge)
+
+## Related Projects
+
+- **[InsForge](https://github.com/InsForge/InsForge)** - The main InsForge backend platform
+- **[InsForge MCP](https://github.com/InsForge/insforge-mcp)** - Model Context Protocol server for InsForge
+
+---
+
+Built with ❤️ by the InsForge team

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { UserSchema, CreateUserRequest, CreateUserResponse, CreateSessionRequest, CreateSessionResponse, OAuthProvidersSchema, StorageFileSchema, ListObjectsResponseSchema, ChatCompletionRequest, ImageGenerationRequest } from '@insforge/shared-schemas';
+import { UserSchema, CreateUserRequest, CreateUserResponse, CreateSessionRequest, CreateSessionResponse, OAuthProvidersSchema, GetPublicAuthConfigResponse, UserIdSchema, EmailSchema, RoleSchema, StorageFileSchema, ListObjectsResponseSchema, ChatCompletionRequest, ImageGenerationRequest } from '@insforge/shared-schemas';
 export { AuthErrorResponse, CreateSessionRequest, CreateUserRequest, UserSchema } from '@insforge/shared-schemas';
 import * as _supabase_postgrest_js from '@supabase/postgrest-js';
 
@@ -106,6 +106,21 @@ declare class TokenManager {
  * Uses shared schemas for type safety
  */
 
+/**
+ * Dynamic profile type - represents flexible profile data from database
+ * Fields can vary based on database schema configuration.
+ * All fields are converted from snake_case (database) to camelCase (API)
+ */
+type ProfileData = Record<string, any> & {
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+};
+/**
+ * Dynamic profile update type - for updating profile fields
+ * Supports any fields that exist in the profile table
+ */
+type UpdateProfileData = Partial<Record<string, any>>;
 declare class Auth {
     private http;
     private tokenManager;
@@ -151,23 +166,47 @@ declare class Auth {
     signOut(): Promise<{
         error: InsForgeError | null;
     }>;
+    /**
+     * Get all public authentication configuration (OAuth + Email)
+     * Returns both OAuth providers and email authentication settings in one request
+     * This is a public endpoint that doesn't require authentication
+     *
+     * @returns Complete public authentication configuration including OAuth providers and email auth settings
+     *
+     * @example
+     * ```ts
+     * const { data, error } = await insforge.auth.getPublicAuthConfig();
+     * if (data) {
+     *   console.log(`OAuth providers: ${data.oauth.data.length}`);
+     *   console.log(`Password min length: ${data.email.passwordMinLength}`);
+     * }
+     * ```
+     */
+    getPublicAuthConfig(): Promise<{
+        data: GetPublicAuthConfigResponse | null;
+        error: InsForgeError | null;
+    }>;
     /**
      * Get the current user with full profile information
-     * Returns both auth info (id, email, role) and profile data (nickname, avatar_url, bio, etc.)
+     * Returns both auth info (id, email, role) and profile data (dynamic fields from users table)
      */
     getCurrentUser(): Promise<{
         data: {
-            user: any;
-            profile: any;
+            user: {
+                id: UserIdSchema;
+                email: EmailSchema;
+                role: RoleSchema;
+            };
+            profile: ProfileData | null;
         } | null;
         error: any | null;
     }>;
     /**
      * Get any user's profile by ID
-     * Returns profile information from the users table (nickname, avatar_url, bio, etc.)
+     * Returns profile information from the users table (dynamic fields)
      */
     getProfile(userId: string): Promise<{
-        data: any | null;
+        data: ProfileData | null;
         error: any | null;
     }>;
     /**
@@ -182,24 +221,19 @@ declare class Auth {
     };
     /**
      * Set/Update the current user's profile
-     * Updates profile information in the users table (nickname, avatar_url, bio, etc.)
-     */
-    setProfile(profile: {
-        nickname?: string;
-        avatar_url?: string;
-        bio?: string;
-        birthday?: string;
-        [key: string]: any;
-    }): Promise<{
-        data: any | null;
+     * Updates profile information in the users table (supports any dynamic fields)
+     */
+    setProfile(profile: UpdateProfileData): Promise<{
+        data: ProfileData | null;
         error: any | null;
     }>;
     /**
-     * Send email verification code or link
-     * @param type - 'code' for numeric OTP (6 digits) or 'link' for verification link
-     * @param email - Email address to send verification to
+     * Send password reset code to user's email
+     * Always returns success to prevent user enumeration
      */
-    sendEmailVerification(type: 'code' | 'link', email: string): Promise<{
+    sendPasswordResetCode(request: {
+        email: string;
+    }): Promise<{
         data: {
             success: boolean;
             message: string;
@@ -207,38 +241,39 @@ declare class Auth {
         error: InsForgeError | null;
     }>;
     /**
-     * Verify email with OTP
-     * @param otp - 6-digit numeric code (with email) or 64-char hex token (without email)
-     * @param email - Optional email address (required for code verification)
-     */
-    verifyEmail(otp: string, email?: string): Promise<{
-        data: CreateSessionResponse | null;
-        error: InsForgeError | null;
-    }>;
-    /**
-     * Send password reset code or link
-     * @param type - 'code' for numeric OTP (6 digits) or 'link' for reset link
-     * @param email - Email address to send reset instructions to
+     * Reset password with OTP token
+     * Token can be from magic link or from code verification
      */
-    sendResetPasswordEmail(type: 'code' | 'link', email: string): Promise<{
+    resetPassword(request: {
+        newPassword: string;
+        otp: string;
+    }): Promise<{
         data: {
-            success: boolean;
             message: string;
+            redirectTo?: string;
         } | null;
         error: InsForgeError | null;
     }>;
     /**
-     * Reset password with OTP
-     * @param otp - 6-digit numeric code (with email) or 64-char hex token (without email)
-     * @param newPassword - New password to set
-     * @param email - Optional email address (required for code-based reset)
+     * Verify email with OTP token
+     * If email is provided: uses numeric OTP verification (6-digit code)
+     * If email is NOT provided: uses link OTP verification (64-char token)
      */
-    resetPassword(otp: string, newPassword: string, email?: string): Promise<{
+    verifyEmail(request: {
+        email?: string;
+        otp: string;
+    }): Promise<{
         data: {
-            message: string;
+            accessToken: string;
+            user?: any;
         } | null;
         error: InsForgeError | null;
     }>;
+    /**
+     * Set the current session
+     * This is used to set the session from the OAuth callback
+     */
+    setSession(session: AuthSession): Promise<void>;
 }
 
 /**
@@ -572,4 +607,4 @@ declare class InsForgeClient {
 
 declare function createClient(config: InsForgeConfig): InsForgeClient;
 
-export { AI, type ApiError, Auth, type AuthSession, type InsForgeConfig as ClientOptions, Database, type FunctionInvokeOptions, Functions, HttpClient, InsForgeClient, type InsForgeConfig, InsForgeError, Storage, StorageBucket, type StorageResponse, TokenManager, type TokenStorage, createClient, InsForgeClient as default };
+export { AI, type ApiError, Auth, type AuthSession, type InsForgeConfig as ClientOptions, Database, type FunctionInvokeOptions, Functions, HttpClient, InsForgeClient, type InsForgeConfig, InsForgeError, type ProfileData, Storage, StorageBucket, type StorageResponse, TokenManager, type TokenStorage, type UpdateProfileData, createClient, InsForgeClient as default };