@insforge/sdk 1.1.0-dev.2 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,259 +1,259 @@
1
- # insforge-sdk-js
2
-
3
- [![npm version](https://img.shields.io/npm/v/@insforge/sdk.svg)](https://www.npmjs.com/package/@insforge/sdk)
4
- [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
-
6
- Official TypeScript/JavaScript SDK for [InsForge](https://github.com/InsForge/InsForge) - A powerful, open-source Backend-as-a-Service (BaaS) platform.
7
-
8
- ## Features
9
-
10
- - **Authentication** - Email/password, OAuth (Google, GitHub), session management
11
- - **Database** - Full PostgreSQL database access with PostgREST
12
- - **Storage** - File upload and management with S3-compatible storage
13
- - **Edge Functions** - Serverless function invocation
14
- - **AI Integration** - Built-in AI capabilities
15
- - **TypeScript** - Full TypeScript support with type definitions
16
- - **Automatic OAuth Handling** - Seamless OAuth callback detection
17
-
18
- ## Installation
19
-
20
- ```bash
21
- npm install @insforge/sdk
22
- ```
23
-
24
- Or with yarn:
25
-
26
- ```bash
27
- yarn add @insforge/sdk
28
- ```
29
-
30
- ## Quick Start
31
-
32
- ### Initialize the Client
33
-
34
- ```javascript
35
- import { createClient } from '@insforge/sdk';
36
-
37
- const insforge = createClient({
38
- baseUrl: 'http://localhost:7130' // Your InsForge backend URL
39
- });
40
- ```
41
-
42
- ### Authentication
43
-
44
- ```javascript
45
- // Sign up a new user
46
- const { data, error } = await insforge.auth.signUp({
47
- email: 'user@example.com',
48
- password: 'securePassword123',
49
- name: 'John Doe' // optional
50
- });
51
-
52
- // Sign in with email/password
53
- const { data, error } = await insforge.auth.signInWithPassword({
54
- email: 'user@example.com',
55
- password: 'securePassword123'
56
- });
57
-
58
- // OAuth authentication (Google, GitHub)
59
- await insforge.auth.signInWithOAuth({
60
- provider: 'google',
61
- redirectTo: 'http://localhost:3000/dashboard'
62
- });
63
-
64
- // Get current user
65
- const { data: user } = await insforge.auth.getCurrentUser();
66
-
67
- // Get any user's profile by ID (public endpoint)
68
- const { data: profile, error } = await insforge.auth.getProfile('user-id-here');
69
-
70
- // Update current user's profile (requires authentication)
71
- const { data: updatedProfile, error } = await insforge.auth.setProfile({
72
- displayName: 'John Doe',
73
- bio: 'Software developer',
74
- avatarUrl: 'https://example.com/avatar.jpg'
75
- });
76
-
77
- // Sign out
78
- await insforge.auth.signOut();
79
- ```
80
-
81
- ### Database Operations
82
-
83
- ```javascript
84
- // Insert data
85
- const { data, error } = await insforge.database
86
- .from('posts')
87
- .insert([
88
- { title: 'My First Post', content: 'Hello World!' }
89
- ]);
90
-
91
- // Query data
92
- const { data, error } = await insforge.database
93
- .from('posts')
94
- .select('*')
95
- .eq('author_id', userId);
96
-
97
- // Update data
98
- const { data, error } = await insforge.database
99
- .from('posts')
100
- .update({ title: 'Updated Title' })
101
- .eq('id', postId);
102
-
103
- // Delete data
104
- const { data, error } = await insforge.database
105
- .from('posts')
106
- .delete()
107
- .eq('id', postId);
108
- ```
109
-
110
- ### File Storage
111
-
112
- ```javascript
113
- // Upload a file
114
- const file = document.querySelector('input[type="file"]').files[0];
115
- const { data, error } = await insforge.storage
116
- .from('avatars')
117
- .upload(file);
118
-
119
- // Download a file
120
- const { data, error } = await insforge.storage
121
- .from('avatars')
122
- .download('user-avatar.png');
123
-
124
- // Delete a file
125
- const { data, error } = await insforge.storage
126
- .from('avatars')
127
- .remove(['user-avatar.png']);
128
-
129
- // List files
130
- const { data, error } = await insforge.storage
131
- .from('avatars')
132
- .list();
133
- ```
134
-
135
- ### Edge Functions
136
-
137
- ```javascript
138
- // Invoke an edge function
139
- const { data, error } = await insforge.functions.invoke('my-function', {
140
- body: { key: 'value' }
141
- });
142
- ```
143
-
144
- ### AI Integration
145
-
146
- ```javascript
147
- // Generate text completion
148
- const { data, error } = await insforge.ai.completion({
149
- model: 'gpt-3.5-turbo',
150
- prompt: 'Write a hello world program'
151
- });
152
-
153
- // Analyze an image
154
- const { data, error } = await insforge.ai.vision({
155
- imageUrl: 'https://example.com/image.jpg',
156
- prompt: 'Describe this image'
157
- });
158
- ```
159
-
160
- ## Documentation
161
-
162
- For complete API reference and advanced usage, see:
163
-
164
- - **[SDK Reference](./SDK-REFERENCE.md)** - Complete API documentation
165
- - **[InsForge Main Repository](https://github.com/InsForge/InsForge)** - Backend platform and setup guides
166
-
167
- ## Configuration
168
-
169
- The SDK supports the following configuration options:
170
-
171
- ```javascript
172
- const insforge = createClient({
173
- baseUrl: 'http://localhost:7130', // Required: Your InsForge backend URL
174
- storageStrategy: 'localStorage' // Optional: 'localStorage' or 'memory' (default: 'localStorage')
175
- });
176
- ```
177
-
178
- ## TypeScript Support
179
-
180
- The SDK is written in TypeScript and provides full type definitions:
181
-
182
- ```typescript
183
- import { createClient, InsForgeClient, User, Session } from '@insforge/sdk';
184
-
185
- const insforge: InsForgeClient = createClient({
186
- baseUrl: 'http://localhost:7130'
187
- });
188
-
189
- // Type-safe API calls
190
- const response: { data: User | null; error: Error | null } =
191
- await insforge.auth.getCurrentUser();
192
- ```
193
-
194
- ## Error Handling
195
-
196
- All SDK methods return a consistent response format:
197
-
198
- ```javascript
199
- const { data, error } = await insforge.auth.signUp({...});
200
-
201
- if (error) {
202
- console.error('Error:', error.message);
203
- console.error('Status:', error.statusCode);
204
- } else {
205
- console.log('Success:', data);
206
- }
207
- ```
208
-
209
- ## Browser Support
210
-
211
- The SDK works in all modern browsers that support:
212
- - ES6+ features
213
- - Fetch API
214
- - LocalStorage (for session management)
215
-
216
- For Node.js environments, ensure you're using Node.js 18 or higher.
217
-
218
- ## Contributing
219
-
220
- We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
221
-
222
- ### Development Setup
223
-
224
- ```bash
225
- # Clone the repository
226
- git clone https://github.com/InsForge/insforge-sdk-js.git
227
- cd insforge-sdk-js
228
-
229
- # Install dependencies
230
- npm install
231
-
232
- # Build the SDK
233
- npm run build
234
-
235
- # Run tests
236
- npm test
237
-
238
- # Run integration tests
239
- npm run test:integration
240
- ```
241
-
242
- ## License
243
-
244
- This project is licensed under the Apache License 2.0 - see the [LICENSE](./LICENSE) file for details.
245
-
246
- ## Community & Support
247
-
248
- - **GitHub Issues**: [Report bugs or request features](https://github.com/InsForge/insforge-sdk-js/issues)
249
- - **Documentation**: [https://docs.insforge.com](https://docs.insforge.com)
250
- - **Main Repository**: [InsForge Backend Platform](https://github.com/InsForge/InsForge)
251
-
252
- ## Related Projects
253
-
254
- - **[InsForge](https://github.com/InsForge/InsForge)** - The main InsForge backend platform
255
- - **[InsForge MCP](https://github.com/InsForge/insforge-mcp)** - Model Context Protocol server for InsForge
256
-
257
- ---
258
-
259
- Built with ❤️ by the InsForge team
1
+ # insforge-sdk-js
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@insforge/sdk.svg)](https://www.npmjs.com/package/@insforge/sdk)
4
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
+
6
+ Official TypeScript/JavaScript SDK for [InsForge](https://github.com/InsForge/InsForge) - A powerful, open-source Backend-as-a-Service (BaaS) platform.
7
+
8
+ ## Features
9
+
10
+ - **Authentication** - Email/password, OAuth (Google, GitHub), session management
11
+ - **Database** - Full PostgreSQL database access with PostgREST
12
+ - **Storage** - File upload and management with S3-compatible storage
13
+ - **Edge Functions** - Serverless function invocation
14
+ - **AI Integration** - Built-in AI capabilities
15
+ - **TypeScript** - Full TypeScript support with type definitions
16
+ - **Automatic OAuth Handling** - Seamless OAuth callback detection
17
+
18
+ ## Installation
19
+
20
+ ```bash
21
+ npm install @insforge/sdk
22
+ ```
23
+
24
+ Or with yarn:
25
+
26
+ ```bash
27
+ yarn add @insforge/sdk
28
+ ```
29
+
30
+ ## Quick Start
31
+
32
+ ### Initialize the Client
33
+
34
+ ```javascript
35
+ import { createClient } from '@insforge/sdk';
36
+
37
+ const insforge = createClient({
38
+ baseUrl: 'http://localhost:7130' // Your InsForge backend URL
39
+ });
40
+ ```
41
+
42
+ ### Authentication
43
+
44
+ ```javascript
45
+ // Sign up a new user
46
+ const { data, error } = await insforge.auth.signUp({
47
+ email: 'user@example.com',
48
+ password: 'securePassword123',
49
+ name: 'John Doe' // optional
50
+ });
51
+
52
+ // Sign in with email/password
53
+ const { data, error } = await insforge.auth.signInWithPassword({
54
+ email: 'user@example.com',
55
+ password: 'securePassword123'
56
+ });
57
+
58
+ // OAuth authentication (Google, GitHub)
59
+ await insforge.auth.signInWithOAuth({
60
+ provider: 'google',
61
+ redirectTo: 'http://localhost:3000/dashboard'
62
+ });
63
+
64
+ // Get current user
65
+ const { data: user } = await insforge.auth.getCurrentUser();
66
+
67
+ // Get any user's profile by ID (public endpoint)
68
+ const { data: profile, error } = await insforge.auth.getProfile('user-id-here');
69
+
70
+ // Update current user's profile (requires authentication)
71
+ const { data: updatedProfile, error } = await insforge.auth.setProfile({
72
+ displayName: 'John Doe',
73
+ bio: 'Software developer',
74
+ avatarUrl: 'https://example.com/avatar.jpg'
75
+ });
76
+
77
+ // Sign out
78
+ await insforge.auth.signOut();
79
+ ```
80
+
81
+ ### Database Operations
82
+
83
+ ```javascript
84
+ // Insert data
85
+ const { data, error } = await insforge.database
86
+ .from('posts')
87
+ .insert([
88
+ { title: 'My First Post', content: 'Hello World!' }
89
+ ]);
90
+
91
+ // Query data
92
+ const { data, error } = await insforge.database
93
+ .from('posts')
94
+ .select('*')
95
+ .eq('author_id', userId);
96
+
97
+ // Update data
98
+ const { data, error } = await insforge.database
99
+ .from('posts')
100
+ .update({ title: 'Updated Title' })
101
+ .eq('id', postId);
102
+
103
+ // Delete data
104
+ const { data, error } = await insforge.database
105
+ .from('posts')
106
+ .delete()
107
+ .eq('id', postId);
108
+ ```
109
+
110
+ ### File Storage
111
+
112
+ ```javascript
113
+ // Upload a file
114
+ const file = document.querySelector('input[type="file"]').files[0];
115
+ const { data, error } = await insforge.storage
116
+ .from('avatars')
117
+ .upload(file);
118
+
119
+ // Download a file
120
+ const { data, error } = await insforge.storage
121
+ .from('avatars')
122
+ .download('user-avatar.png');
123
+
124
+ // Delete a file
125
+ const { data, error } = await insforge.storage
126
+ .from('avatars')
127
+ .remove(['user-avatar.png']);
128
+
129
+ // List files
130
+ const { data, error } = await insforge.storage
131
+ .from('avatars')
132
+ .list();
133
+ ```
134
+
135
+ ### Edge Functions
136
+
137
+ ```javascript
138
+ // Invoke an edge function
139
+ const { data, error } = await insforge.functions.invoke('my-function', {
140
+ body: { key: 'value' }
141
+ });
142
+ ```
143
+
144
+ ### AI Integration
145
+
146
+ ```javascript
147
+ // Generate text completion
148
+ const { data, error } = await insforge.ai.completion({
149
+ model: 'gpt-3.5-turbo',
150
+ prompt: 'Write a hello world program'
151
+ });
152
+
153
+ // Analyze an image
154
+ const { data, error } = await insforge.ai.vision({
155
+ imageUrl: 'https://example.com/image.jpg',
156
+ prompt: 'Describe this image'
157
+ });
158
+ ```
159
+
160
+ ## Documentation
161
+
162
+ For complete API reference and advanced usage, see:
163
+
164
+ - **[SDK Reference](./SDK-REFERENCE.md)** - Complete API documentation
165
+ - **[InsForge Main Repository](https://github.com/InsForge/InsForge)** - Backend platform and setup guides
166
+
167
+ ## Configuration
168
+
169
+ The SDK supports the following configuration options:
170
+
171
+ ```javascript
172
+ const insforge = createClient({
173
+ baseUrl: 'http://localhost:7130', // Required: Your InsForge backend URL
174
+ storageStrategy: 'localStorage' // Optional: 'localStorage' or 'memory' (default: 'localStorage')
175
+ });
176
+ ```
177
+
178
+ ## TypeScript Support
179
+
180
+ The SDK is written in TypeScript and provides full type definitions:
181
+
182
+ ```typescript
183
+ import { createClient, InsForgeClient, User, Session } from '@insforge/sdk';
184
+
185
+ const insforge: InsForgeClient = createClient({
186
+ baseUrl: 'http://localhost:7130'
187
+ });
188
+
189
+ // Type-safe API calls
190
+ const response: { data: User | null; error: Error | null } =
191
+ await insforge.auth.getCurrentUser();
192
+ ```
193
+
194
+ ## Error Handling
195
+
196
+ All SDK methods return a consistent response format:
197
+
198
+ ```javascript
199
+ const { data, error } = await insforge.auth.signUp({...});
200
+
201
+ if (error) {
202
+ console.error('Error:', error.message);
203
+ console.error('Status:', error.statusCode);
204
+ } else {
205
+ console.log('Success:', data);
206
+ }
207
+ ```
208
+
209
+ ## Browser Support
210
+
211
+ The SDK works in all modern browsers that support:
212
+ - ES6+ features
213
+ - Fetch API
214
+ - LocalStorage (for session management)
215
+
216
+ For Node.js environments, ensure you're using Node.js 18 or higher.
217
+
218
+ ## Contributing
219
+
220
+ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
221
+
222
+ ### Development Setup
223
+
224
+ ```bash
225
+ # Clone the repository
226
+ git clone https://github.com/InsForge/insforge-sdk-js.git
227
+ cd insforge-sdk-js
228
+
229
+ # Install dependencies
230
+ npm install
231
+
232
+ # Build the SDK
233
+ npm run build
234
+
235
+ # Run tests
236
+ npm test
237
+
238
+ # Run integration tests
239
+ npm run test:integration
240
+ ```
241
+
242
+ ## License
243
+
244
+ This project is licensed under the Apache License 2.0 - see the [LICENSE](./LICENSE) file for details.
245
+
246
+ ## Community & Support
247
+
248
+ - **GitHub Issues**: [Report bugs or request features](https://github.com/InsForge/insforge-sdk-js/issues)
249
+ - **Documentation**: [https://docs.insforge.com](https://docs.insforge.com)
250
+ - **Main Repository**: [InsForge Backend Platform](https://github.com/InsForge/InsForge)
251
+
252
+ ## Related Projects
253
+
254
+ - **[InsForge](https://github.com/InsForge/InsForge)** - The main InsForge backend platform
255
+ - **[InsForge MCP](https://github.com/InsForge/insforge-mcp)** - Model Context Protocol server for InsForge
256
+
257
+ ---
258
+
259
+ Built with ❤️ by the InsForge team
package/dist/index.d.mts CHANGED
@@ -395,6 +395,27 @@ declare class Database {
395
395
  * - Upserts
396
396
  */
397
397
  from(table: string): _supabase_postgrest_js.PostgrestQueryBuilder<any, any, any, string, unknown>;
398
+ /**
399
+ * Call a PostgreSQL function (RPC)
400
+ *
401
+ * @example
402
+ * // Call a function with parameters
403
+ * const { data, error } = await client.database
404
+ * .rpc('get_user_stats', { user_id: 123 });
405
+ *
406
+ * // Call a function with no parameters
407
+ * const { data, error } = await client.database
408
+ * .rpc('get_all_active_users');
409
+ *
410
+ * // With options (head, count, get)
411
+ * const { data, count } = await client.database
412
+ * .rpc('search_posts', { query: 'hello' }, { count: 'exact' });
413
+ */
414
+ rpc(fn: string, args?: Record<string, unknown>, options?: {
415
+ head?: boolean;
416
+ get?: boolean;
417
+ count?: 'exact' | 'planned' | 'estimated';
418
+ }): _supabase_postgrest_js.PostgrestFilterBuilder<any, any, any, any, string, null, "RPC">;
398
419
  }
399
420
 
400
421
  /**
package/dist/index.d.ts CHANGED
@@ -395,6 +395,27 @@ declare class Database {
395
395
  * - Upserts
396
396
  */
397
397
  from(table: string): _supabase_postgrest_js.PostgrestQueryBuilder<any, any, any, string, unknown>;
398
+ /**
399
+ * Call a PostgreSQL function (RPC)
400
+ *
401
+ * @example
402
+ * // Call a function with parameters
403
+ * const { data, error } = await client.database
404
+ * .rpc('get_user_stats', { user_id: 123 });
405
+ *
406
+ * // Call a function with no parameters
407
+ * const { data, error } = await client.database
408
+ * .rpc('get_all_active_users');
409
+ *
410
+ * // With options (head, count, get)
411
+ * const { data, count } = await client.database
412
+ * .rpc('search_posts', { query: 'hello' }, { count: 'exact' });
413
+ */
414
+ rpc(fn: string, args?: Record<string, unknown>, options?: {
415
+ head?: boolean;
416
+ get?: boolean;
417
+ count?: 'exact' | 'planned' | 'estimated';
418
+ }): _supabase_postgrest_js.PostgrestFilterBuilder<any, any, any, any, string, null, "RPC">;
398
419
  }
399
420
 
400
421
  /**
package/dist/index.js CHANGED
@@ -907,8 +907,10 @@ function createInsForgePostgrestFetch(httpClient, tokenManager) {
907
907
  return async (input, init) => {
908
908
  const url = typeof input === "string" ? input : input.toString();
909
909
  const urlObj = new URL(url);
910
- const tableName = urlObj.pathname.slice(1);
911
- const insforgeUrl = `${httpClient.baseUrl}/api/database/records/${tableName}${urlObj.search}`;
910
+ const pathname = urlObj.pathname.slice(1);
911
+ const rpcMatch = pathname.match(/^rpc\/(.+)$/);
912
+ const endpoint = rpcMatch ? `/api/database/rpc/${rpcMatch[1]}` : `/api/database/records/${pathname}`;
913
+ const insforgeUrl = `${httpClient.baseUrl}${endpoint}${urlObj.search}`;
912
914
  const token = tokenManager.getAccessToken();
913
915
  const httpHeaders = httpClient.getHeaders();
914
916
  const authToken = token || httpHeaders["Authorization"]?.replace("Bearer ", "");
@@ -968,6 +970,25 @@ var Database = class {
968
970
  from(table) {
969
971
  return this.postgrest.from(table);
970
972
  }
973
+ /**
974
+ * Call a PostgreSQL function (RPC)
975
+ *
976
+ * @example
977
+ * // Call a function with parameters
978
+ * const { data, error } = await client.database
979
+ * .rpc('get_user_stats', { user_id: 123 });
980
+ *
981
+ * // Call a function with no parameters
982
+ * const { data, error } = await client.database
983
+ * .rpc('get_all_active_users');
984
+ *
985
+ * // With options (head, count, get)
986
+ * const { data, count } = await client.database
987
+ * .rpc('search_posts', { query: 'hello' }, { count: 'exact' });
988
+ */
989
+ rpc(fn, args, options) {
990
+ return this.postgrest.rpc(fn, args, options);
991
+ }
971
992
  };
972
993
 
973
994
  // src/modules/storage.ts