insforge 0.3.3 → 1.3.0

package/docs/deprecated/insforge-storage-sdk.md

@@ -1,159 +1,159 @@
-# InsForge Storage SDK
-
-## Setup
-```javascript
-import { createClient } from '@insforge/sdk';
-const client = createClient({ baseUrl: 'http://localhost:7130' });
-```
-
-## Bucket Operations
-
-### from(bucketName)
-```javascript
-const bucket = client.storage.from('avatars')  // Returns StorageBucket instance
-```
-
-## File Operations
-
-### upload
-```javascript
-// Upload with specific key
-const { data, error } = await client.storage
-  .from('avatars')
-  .upload('user-123.jpg', file);
-
-// data: StorageFileSchema { bucket, key, size, mimeType, uploadedAt, url }
-```
-
-### uploadAuto
-```javascript
-// Upload with auto-generated key
-const { data, error } = await client.storage
-  .from('avatars')
-  .uploadAuto(file);
-
-// Generated key format: filename-timestamp-random.ext
-```
-
-### download
-```javascript
-const { data: blob, error } = await client.storage
-  .from('avatars')
-  .download('user-123.jpg');
-
-// data: Blob (can convert to URL with URL.createObjectURL(blob))
-```
-
-### remove
-```javascript
-const { data, error } = await client.storage
-  .from('avatars')
-  .remove('user-123.jpg');
-```
-
-### list
-```javascript
-const { data, error } = await client.storage
-  .from('avatars')
-  .list({
-    prefix: 'users/',     // Filter by prefix
-    search: 'profile',    // Search in filenames
-    limit: 10,           // Max results (default: 100)
-    offset: 0            // Skip results
-  });
-
-// data: ListObjectsResponseSchema { bucketName, objects[], pagination }
-```
-
-### getPublicUrl
-```javascript
-// Get public URL (no API call)
-const url = client.storage
-  .from('avatars')
-  .getPublicUrl('user-123.jpg');
-
-// Returns: http://localhost:7130/api/storage/buckets/avatars/objects/user-123.jpg
-```
-
-## File Upload Examples
-
-### Upload File from Input
-```javascript
-// HTML: <input type="file" id="fileInput">
-const fileInput = document.getElementById('fileInput');
-const file = fileInput.files[0];
-
-const { data, error } = await client.storage
-  .from('uploads')
-  .upload(`photos/${file.name}`, file);
-```
-
-### Upload Blob
-```javascript
-const blob = new Blob(['Hello World'], { type: 'text/plain' });
-
-const { data, error } = await client.storage
-  .from('documents')
-  .upload('hello.txt', blob);
-```
-
-### Upload with Custom Name
-```javascript
-// Simple file upload - SDK handles FormData creation
-const file = fileInput.files[0];
-
-const { data, error } = await client.storage
-  .from('uploads')
-  .upload('custom-name.jpg', file);
-```
-
-## Download & Display
-
-### Download and Display Image
-```javascript
-const { data: blob, error } = await client.storage
-  .from('avatars')
-  .download('user-123.jpg');
-
-if (blob) {
-  const url = URL.createObjectURL(blob);
-  document.getElementById('avatar').src = url;
-  
-  // Clean up
-  URL.revokeObjectURL(url);
-}
-```
-
-### Direct URL for Public Buckets
-```javascript
-// For public buckets, use direct URL
-const url = client.storage
-  .from('public-avatars')
-  .getPublicUrl('user-123.jpg');
-
-document.getElementById('avatar').src = url;
-```
-
-## Error Handling
-```javascript
-const { data, error } = await client.storage
-  .from('avatars')
-  .upload('user-123.jpg', file);
-
-if (error) {
-  if (error.statusCode === 409) {
-    console.error('File already exists');
-  } else if (error.statusCode === 404) {
-    console.error('Bucket not found');
-  } else {
-    console.error(error.message);
-  }
-}
-```
-
-## Notes
-- Bucket creation/deletion handled via MCP tools, not SDK
-- Public buckets allow unauthenticated downloads
-- Private buckets require authentication for all operations
-- File keys can include paths (e.g., 'folder/subfolder/file.jpg')
+# InsForge Storage SDK
+
+## Setup
+```javascript
+import { createClient } from '@insforge/sdk';
+const client = createClient({ baseUrl: 'http://localhost:7130' });
+```
+
+## Bucket Operations
+
+### from(bucketName)
+```javascript
+const bucket = client.storage.from('avatars')  // Returns StorageBucket instance
+```
+
+## File Operations
+
+### upload
+```javascript
+// Upload with specific key
+const { data, error } = await client.storage
+  .from('avatars')
+  .upload('user-123.jpg', file);
+
+// data: StorageFileSchema { bucket, key, size, mimeType, uploadedAt, url }
+```
+
+### uploadAuto
+```javascript
+// Upload with auto-generated key
+const { data, error } = await client.storage
+  .from('avatars')
+  .uploadAuto(file);
+
+// Generated key format: filename-timestamp-random.ext
+```
+
+### download
+```javascript
+const { data: blob, error } = await client.storage
+  .from('avatars')
+  .download('user-123.jpg');
+
+// data: Blob (can convert to URL with URL.createObjectURL(blob))
+```
+
+### remove
+```javascript
+const { data, error } = await client.storage
+  .from('avatars')
+  .remove('user-123.jpg');
+```
+
+### list
+```javascript
+const { data, error } = await client.storage
+  .from('avatars')
+  .list({
+    prefix: 'users/',     // Filter by prefix
+    search: 'profile',    // Search in filenames
+    limit: 10,           // Max results (default: 100)
+    offset: 0            // Skip results
+  });
+
+// data: ListObjectsResponseSchema { bucketName, objects[], pagination }
+```
+
+### getPublicUrl
+```javascript
+// Get public URL (no API call)
+const url = client.storage
+  .from('avatars')
+  .getPublicUrl('user-123.jpg');
+
+// Returns: http://localhost:7130/api/storage/buckets/avatars/objects/user-123.jpg
+```
+
+## File Upload Examples
+
+### Upload File from Input
+```javascript
+// HTML: <input type="file" id="fileInput">
+const fileInput = document.getElementById('fileInput');
+const file = fileInput.files[0];
+
+const { data, error } = await client.storage
+  .from('uploads')
+  .upload(`photos/${file.name}`, file);
+```
+
+### Upload Blob
+```javascript
+const blob = new Blob(['Hello World'], { type: 'text/plain' });
+
+const { data, error } = await client.storage
+  .from('documents')
+  .upload('hello.txt', blob);
+```
+
+### Upload with Custom Name
+```javascript
+// Simple file upload - SDK handles FormData creation
+const file = fileInput.files[0];
+
+const { data, error } = await client.storage
+  .from('uploads')
+  .upload('custom-name.jpg', file);
+```
+
+## Download & Display
+
+### Download and Display Image
+```javascript
+const { data: blob, error } = await client.storage
+  .from('avatars')
+  .download('user-123.jpg');
+
+if (blob) {
+  const url = URL.createObjectURL(blob);
+  document.getElementById('avatar').src = url;
+  
+  // Clean up
+  URL.revokeObjectURL(url);
+}
+```
+
+### Direct URL for Public Buckets
+```javascript
+// For public buckets, use direct URL
+const url = client.storage
+  .from('public-avatars')
+  .getPublicUrl('user-123.jpg');
+
+document.getElementById('avatar').src = url;
+```
+
+## Error Handling
+```javascript
+const { data, error } = await client.storage
+  .from('avatars')
+  .upload('user-123.jpg', file);
+
+if (error) {
+  if (error.statusCode === 409) {
+    console.error('File already exists');
+  } else if (error.statusCode === 404) {
+    console.error('Bucket not found');
+  } else {
+    console.error(error.message);
+  }
+}
+```
+
+## Notes
+- Bucket creation/deletion handled via MCP tools, not SDK
+- Public buckets allow unauthenticated downloads
+- Private buckets require authentication for all operations
+- File keys can include paths (e.g., 'folder/subfolder/file.jpg')
 - Use `uploadAuto()` to prevent filename conflicts

package/docs/docs.json

@@ -0,0 +1,232 @@
+{
+  "$schema": "https://mintlify.com/docs.json",
+  "theme": "mint",
+  "name": "InsForge Docs",
+  "colors": {
+    "primary": "#16A34A",
+    "light": "#07C983",
+    "dark": "#15803D"
+  },
+  "appearance": {
+    "default": "dark"
+  },
+  "styling": {
+    "eyebrows": "section"
+  },
+  "seo": {
+    "metatags": {
+      "og:site_name": "InsForge Docs"
+    },
+    "indexing": "navigable"
+  },
+  "search": {
+    "prompt": "Search InsForge docs..."
+  },
+  "favicon": "/favicon.svg",
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Docs",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "pages": ["introduction", "quickstart", "partnership"]
+          },
+          {
+            "group": "Core Concepts",
+            "pages": [
+              {
+                "group": "Database",
+                "pages": [
+                  "core-concepts/database/architecture",
+                  "core-concepts/database/sdk"
+                ]
+              },
+              {
+                "group": "Authentication",
+                "pages": [
+                  "core-concepts/authentication/architecture",
+                  "core-concepts/authentication/sdk",
+                  {
+                    "group": "UI Components",
+                    "pages": [
+                      "core-concepts/authentication/ui-components/nextjs",
+                      "core-concepts/authentication/ui-components/react",
+                      "core-concepts/authentication/ui-components/react-router",
+                      "core-concepts/authentication/ui-components/customization"
+                    ]
+                  }
+                ]
+              },
+              {
+                "group": "Storage",
+                "pages": [
+                  "core-concepts/storage/architecture",
+                  "core-concepts/storage/sdk"
+                ]
+              },
+              {
+                "group": "AI Integration",
+                "pages": [
+                  "core-concepts/ai/architecture",
+                  "core-concepts/ai/sdk"
+                ]
+              },
+              {
+                "group": "Functions",
+                "pages": [
+                  "core-concepts/functions/architecture",
+                  "core-concepts/functions/sdk"
+                ]
+              },
+              {
+                "group": "Realtime",
+                "pages": [
+                  "core-concepts/realtime/architecture",
+                  "core-concepts/realtime/sdk"
+                ]
+              },
+              {
+                "group": "Email (Private Preview)",
+                "pages": [
+                  "core-concepts/email/architecture",
+                  "core-concepts/email/sdk"
+                ]
+              }
+            ]
+          },
+          {
+            "group": "Changelog",
+            "pages": ["changelog"]
+          }
+        ]
+      },
+      {
+        "tab": "Examples",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "pages": ["examples/overview"]
+          },
+          {
+            "group": "Framework Guides",
+            "pages": [
+              "examples/framework-guides/nextjs",
+              "examples/framework-guides/react",
+              "examples/framework-guides/vue",
+              "examples/framework-guides/nuxt",
+              "examples/framework-guides/svelte"
+            ]
+          },
+          {
+            "group": "Community Showcase",
+            "pages": ["showcase"]
+          }
+        ]
+      },
+      {
+        "tab": "API Reference",
+        "groups": [
+          {
+            "group": "Tables",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/tables.yaml"
+          },
+          {
+            "group": "Authentication",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/auth.yaml"
+          },
+          {
+            "group": "Records",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/records.yaml"
+          },
+          {
+            "group": "Storage",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/storage.yaml"
+          },
+          {
+            "group": "AI Integration",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/ai.yaml"
+          },
+          {
+            "group": "Functions",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/functions.yaml"
+          },
+          {
+            "group": "Realtime",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/realtime.yaml"
+          },
+          {
+            "group": "Email",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/email.yaml"
+          },
+          {
+            "group": "Secrets",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/secrets.yaml"
+          },
+          {
+            "group": "Logs",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/logs.yaml"
+          },
+          {
+            "group": "Metadata",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/metadata.yaml"
+          },
+          {
+            "group": "Health",
+            "openapi": "https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/health.yaml"
+          }
+        ]
+      }
+    ],
+    "global": {
+      "anchors": [
+        {
+          "anchor": "Community",
+          "href": "https://discord.gg/MPxwj5xVvW",
+          "icon": "discord"
+        },
+        {
+          "anchor": "Blog",
+          "href": "https://insforge.dev/blog",
+          "icon": "newspaper"
+        },
+        {
+          "anchor": "Roadmap",
+          "href": "https://feedback.insforge.dev/roadmap",
+          "icon": "route"
+        }
+      ]
+    }
+  },
+  "logo": {
+    "light": "/logo/light.svg",
+    "dark": "/logo/dark.svg",
+    "href": "https://insforge.dev"
+  },
+  "navbar": {
+    "primary": {
+      "type": "button",
+      "label": "Get Started",
+      "href": "https://insforge.dev/auth/sign-up"
+    }
+  },
+  "contextual": {
+    "options": [
+      "copy",
+      "view",
+      "chatgpt",
+      "claude",
+      "perplexity",
+      "mcp",
+      "cursor",
+      "vscode"
+    ]
+  },
+  "footer": {
+    "socials": {
+      "x": "https://x.com/InsForge_dev",
+      "github": "https://github.com/insforge",
+      "linkedin": "https://linkedin.com/company/insforge"
+    }
+  }
+}

package/docs/examples/framework-guides/nextjs.mdx

@@ -0,0 +1,131 @@
+---
+title: Next.js
+description: Learn how to create an InsForge project and build a Next.js app using AI
+---
+
+Learn how to create an InsForge project and build a Next.js app using AI tools like Cursor.
+
+## 1. Create an InsForge project
+
+Create a new InsForge project at [insforge.dev](https://insforge.dev).
+
+## 2. Connect InsForge MCP
+
+Follow the [quickstart guide](/quickstart) to connect your AI assistant to your InsForge backend. This allows AI tools like Claude and Cursor to directly interact with your database, storage, and other InsForge services.
+
+## 3. Build your app with one prompt
+
+In Cursor or your AI assistant, use this prompt:
+
+```
+Create a new Next.js app with TypeScript and Tailwind CSS 3.4.
+Install the InsForge SDK and set up the client configuration.
+
+In my InsForge database, create a sports table with id and name columns.
+Add sample data: basketball, soccer, and tennis. Make it publicly readable.
+
+Create a page at /sports that fetches and displays all sports from the database.
+```
+
+Your AI will generate the complete application including database setup and UI. No need to write code manually - the AI creates everything for you.
+
+## 4. What the AI generates
+
+Your AI assistant will automatically create files like these. You don't need to touch them manually.
+
+**InsForge client** at `lib/insforge.ts`:
+
+```typescript lib/insforge.ts
+import { createClient } from '@insforge/sdk';
+
+export const insforge = createClient({
+  baseUrl: 'https://your-project.us-east.insforge.app',
+  anonKey: 'your-anon-key',
+});
+```
+
+**Sports page** at `app/sports/page.tsx`:
+
+```typescript app/sports/page.tsx
+import { insforge } from '@/lib/insforge';
+
+export default async function SportsPage() {
+  const { data: sports, error } = await insforge.database
+    .from('sports')
+    .select();
+
+  if (error) {
+    return (
+      <div className="min-h-screen flex items-center justify-center">
+        <div className="text-red-600">
+          <h1 className="text-2xl font-bold mb-2">Error</h1>
+          <p>{error.message}</p>
+        </div>
+      </div>
+    );
+  }
+
+  return (
+    <div className="min-h-screen p-8">
+      <div className="max-w-4xl mx-auto">
+        <h1 className="text-4xl font-bold mb-8">Sports</h1>
+
+        {sports && sports.length > 0 ? (
+          <div className="grid gap-4 md:grid-cols-2 lg:grid-cols-3">
+            {sports.map((sport: { id: string; name: string }) => (
+              <div
+                key={sport.id}
+                className="p-6 bg-white rounded-lg shadow-md border border-gray-200 hover:shadow-lg transition-shadow"
+              >
+                <h2 className="text-xl font-semibold text-gray-800 capitalize">
+                  {sport.name}
+                </h2>
+                <p className="text-sm text-gray-500 mt-2">ID: {sport.id}</p>
+              </div>
+            ))}
+          </div>
+        ) : (
+          <p className="text-gray-600">No sports found.</p>
+        )}
+      </div>
+    </div>
+  );
+}
+```
+
+## 5. Start the app
+
+Run the development server, go to [http://localhost:3000/sports](http://localhost:3000/sports) in a browser and you should see the list of sports.
+
+```bash
+npm run dev
+```
+
+## Next: Extend your app with more prompts
+
+Try these prompts to add more features to your app:
+
+```
+Add a form to create new sports and save them to the database.
+Include validation and error handling.
+```
+
+```
+Add user authentication with sign up and login pages.
+Only allow authenticated users to add new sports.
+```
+
+```
+Add a favorites feature where users can mark their favorite sports.
+Store favorites in a user_favorites table with user_id and sport_id.
+```
+
+```
+Add images to each sport using InsForge Storage.
+Allow users to upload sport images and display them in the grid.
+```
+
+```
+Add an AI chat feature that can answer questions about sports.
+Use InsForge AI with streaming responses.
+```