@robosystems/client 0.2.21 → 0.2.22

package/extensions/hooks.d.ts

@@ -121,7 +121,6 @@ export declare function useSDKClients(): {
  * const handleFileUpload = async (file: File) => {
  *   const result = await upload('Entity', file, {
  *     onProgress: (msg) => console.log(msg),
- *     fixLocalStackUrl: true,
  *   })
  *
  *   if (result?.success) {
@@ -129,6 +128,15 @@ export declare function useSDKClients(): {
  *   }
  * }
  * ```
+ *
+ * @remarks
+ * For local development with LocalStack, configure s3EndpointUrl when initializing RoboSystemsExtensions:
+ * ```tsx
+ * const extensions = new RoboSystemsExtensions({
+ *   baseUrl: 'http://localhost:8000',
+ *   s3EndpointUrl: 'http://localhost:4566', // LocalStack endpoint
+ * })
+ * ```
  */
 export declare function useTableUpload(graphId: string): {
     upload: (tableName: string, fileOrBuffer: FileInput, options?: FileUploadOptions) => Promise<FileUploadResult | null>;

package/extensions/hooks.js

@@ -396,7 +396,6 @@ function useSDKClients() {
  * const handleFileUpload = async (file: File) => {
  *   const result = await upload('Entity', file, {
  *     onProgress: (msg) => console.log(msg),
- *     fixLocalStackUrl: true,
  *   })
  *
  *   if (result?.success) {
@@ -404,6 +403,15 @@ function useSDKClients() {
  *   }
  * }
  * ```
+ *
+ * @remarks
+ * For local development with LocalStack, configure s3EndpointUrl when initializing RoboSystemsExtensions:
+ * ```tsx
+ * const extensions = new RoboSystemsExtensions({
+ *   baseUrl: 'http://localhost:8000',
+ *   s3EndpointUrl: 'http://localhost:4566', // LocalStack endpoint
+ * })
+ * ```
  */
 function useTableUpload(graphId) {
     const [loading, setLoading] = (0, react_1.useState)(false);

package/extensions/hooks.ts

@@ -474,7 +474,6 @@ export function useSDKClients() {
  * const handleFileUpload = async (file: File) => {
  *   const result = await upload('Entity', file, {
  *     onProgress: (msg) => console.log(msg),
- *     fixLocalStackUrl: true,
  *   })
  *
  *   if (result?.success) {
@@ -482,6 +481,15 @@ export function useSDKClients() {
  *   }
  * }
  * ```
+ *
+ * @remarks
+ * For local development with LocalStack, configure s3EndpointUrl when initializing RoboSystemsExtensions:
+ * ```tsx
+ * const extensions = new RoboSystemsExtensions({
+ *   baseUrl: 'http://localhost:8000',
+ *   s3EndpointUrl: 'http://localhost:4566', // LocalStack endpoint
+ * })
+ * ```
  */
 export function useTableUpload(graphId: string) {
   const [loading, setLoading] = useState(false)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robosystems/client",
-  "version": "0.2.21",
+  "version": "0.2.22",
   "description": "TypeScript client library for RoboSystems Financial Knowledge Graph API",
   "main": "index.js",
   "types": "index.d.ts",

package/sdk-extensions/README.md

@@ -114,7 +114,6 @@ const result = await tableClient.uploadParquetFile(
     onProgress: (message) => {
       console.log(`Upload progress: ${message}`)
     },
-    fixLocalStackUrl: true, // Auto-fix for local development
   }
 )
 
@@ -248,7 +247,6 @@ import { readFileSync } from 'fs'
 const fileBuffer = readFileSync('data/entities.parquet')
 const result = await tableClient.uploadParquetFile('graph-id', 'Entity', Buffer.from(fileBuffer), {
   onProgress: (msg) => console.log(msg),
-  fixLocalStackUrl: true, // Auto-fix for local development
 })
 
 if (result.success) {
@@ -673,14 +671,15 @@ NEXT_PUBLIC_PREFER_STREAMING=true
 ### Custom Configuration
 
 ```typescript
-import { createSSEClient } from '@robosystems/client/extensions'
+import { RoboSystemsExtensions } from '@robosystems/client/extensions'
 
-const sseClient = createSSEClient({
+const extensions = new RoboSystemsExtensions({
   // API Configuration
   baseUrl: process.env.NEXT_PUBLIC_ROBOSYSTEMS_API_URL,
 
   // Authentication
   credentials: 'include', // For cookies
+  token: 'your-jwt-token', // Or use JWT token
   headers: {
     'X-API-Key': process.env.ROBOSYSTEMS_API_KEY,
   },
@@ -688,12 +687,29 @@ const sseClient = createSSEClient({
   // Connection Settings
   maxRetries: 5,
   retryDelay: 1000,
-  heartbeatInterval: 30000,
 
-  // Advanced Options
-  eventSourceOptions: {
-    withCredentials: true,
-  },
+  // S3 Configuration (for local development with LocalStack)
+  s3EndpointUrl: process.env.S3_ENDPOINT_URL, // e.g., 'http://localhost:4566'
+})
+```
+
+#### Local Development with LocalStack
+
+For local development using LocalStack, configure the S3 endpoint URL:
+
+```typescript
+import { RoboSystemsExtensions } from '@robosystems/client/extensions'
+
+const extensions = new RoboSystemsExtensions({
+  baseUrl: 'http://localhost:8000',
+  credentials: 'include',
+  // Override S3 endpoint for LocalStack
+  s3EndpointUrl: 'http://localhost:4566',
+})
+
+// File uploads will now use LocalStack instead of AWS S3
+const result = await extensions.files.upload('graph-id', 'TableName', fileBuffer, {
+  onProgress: (msg) => console.log(msg),
 })
 ```
 

package/sdk-extensions/hooks.d.ts

@@ -121,7 +121,6 @@ export declare function useSDKClients(): {
  * const handleFileUpload = async (file: File) => {
  *   const result = await upload('Entity', file, {
  *     onProgress: (msg) => console.log(msg),
- *     fixLocalStackUrl: true,
  *   })
  *
  *   if (result?.success) {
@@ -129,6 +128,15 @@ export declare function useSDKClients(): {
  *   }
  * }
  * ```
+ *
+ * @remarks
+ * For local development with LocalStack, configure s3EndpointUrl when initializing RoboSystemsExtensions:
+ * ```tsx
+ * const extensions = new RoboSystemsExtensions({
+ *   baseUrl: 'http://localhost:8000',
+ *   s3EndpointUrl: 'http://localhost:4566', // LocalStack endpoint
+ * })
+ * ```
  */
 export declare function useTableUpload(graphId: string): {
     upload: (tableName: string, fileOrBuffer: FileInput, options?: FileUploadOptions) => Promise<FileUploadResult | null>;

package/sdk-extensions/hooks.js

@@ -396,7 +396,6 @@ function useSDKClients() {
  * const handleFileUpload = async (file: File) => {
  *   const result = await upload('Entity', file, {
  *     onProgress: (msg) => console.log(msg),
- *     fixLocalStackUrl: true,
  *   })
  *
  *   if (result?.success) {
@@ -404,6 +403,15 @@ function useSDKClients() {
  *   }
  * }
  * ```
+ *
+ * @remarks
+ * For local development with LocalStack, configure s3EndpointUrl when initializing RoboSystemsExtensions:
+ * ```tsx
+ * const extensions = new RoboSystemsExtensions({
+ *   baseUrl: 'http://localhost:8000',
+ *   s3EndpointUrl: 'http://localhost:4566', // LocalStack endpoint
+ * })
+ * ```
  */
 function useTableUpload(graphId) {
     const [loading, setLoading] = (0, react_1.useState)(false);

package/sdk-extensions/hooks.ts

@@ -474,7 +474,6 @@ export function useSDKClients() {
  * const handleFileUpload = async (file: File) => {
  *   const result = await upload('Entity', file, {
  *     onProgress: (msg) => console.log(msg),
- *     fixLocalStackUrl: true,
  *   })
  *
  *   if (result?.success) {
@@ -482,6 +481,15 @@ export function useSDKClients() {
  *   }
  * }
  * ```
+ *
+ * @remarks
+ * For local development with LocalStack, configure s3EndpointUrl when initializing RoboSystemsExtensions:
+ * ```tsx
+ * const extensions = new RoboSystemsExtensions({
+ *   baseUrl: 'http://localhost:8000',
+ *   s3EndpointUrl: 'http://localhost:4566', // LocalStack endpoint
+ * })
+ * ```
  */
 export function useTableUpload(graphId: string) {
   const [loading, setLoading] = useState(false)