@seaverse/dataservice 1.6.2 → 1.8.0

package/README.md

@@ -24,6 +24,7 @@ This package uses a **factory pattern** for client creation. Here's what it expo
 **Functions:**
 - `createClient(config)` - Factory function to create a client instance (async)
 - `debugSetToken(token)` - Set debug token for testing (call before createClient)
+- `setAppId(appId)` - **[Deprecated]** Set application ID manually (not recommended)
 
 **Types (TypeScript):**
 - `DataServiceClient` - Type of the client instance (**not a constructor**)
@@ -55,10 +56,13 @@ const client = new DataServiceClient(); // This will fail!
 
 The SDK uses a **factory function pattern**. Always use `createClient()`:
 
+**Important:** The SDK automatically obtains the service host from the parent page via PostMessage (500ms timeout). If the fetch fails, it defaults to `https://dataservice-api.seaverse.ai`. No configuration is needed.
+
 ```typescript
 import { createClient, debugSetToken } from '@seaverse/dataservice';
 
-// Production: Auto-fetch token from parent page (when running in iframe)
+// Production: Auto-fetch token and serviceHost from parent page (when running in iframe)
+// Falls back to https://dataservice-api.seaverse.ai if fetch fails
 const client = await createClient({});
 
 // Development/Testing: Use debug token
@@ -134,6 +138,27 @@ Access the extracted ID:
 console.log(client.appId); // "app_8e5e867e-user_f4ed2364"
 ```
 
+**Manual Override (Not Recommended):**
+
+For special cases where auto-extraction doesn't work, you can manually set the appId using `setAppId()`:
+
+```typescript
+import { setAppId, createClient } from '@seaverse/dataservice';
+
+// Set manual appId before creating client (highest priority)
+setAppId('my-custom-app-id');
+
+// Client will use manual appId instead of auto-extraction
+const client = await createClient({});
+console.log(client.appId); // "my-custom-app-id"
+```
+
+⚠️ **Note:** `setAppId()` is deprecated and not recommended for normal use. The SDK automatically extracts appId from the URL, which is the recommended approach. Only use this for special cases where auto-extraction doesn't work.
+
+**AppId Priority (from highest to lowest):**
+1. `setAppId()` - Manual override (not recommended)
+2. URL extraction (browser) / Environment variable (Node.js) - Automatic and recommended
+
 ### Data Tables
 
 The SDK provides access to different data tables with different permission scopes:
@@ -308,7 +333,6 @@ interface DataRecord<T> {
 import { createClient } from '@seaverse/dataservice';
 
 const client = await createClient({
-  url?: string;             // PostgREST API URL (default: https://dataservice-api.seaverse.ai)
   options?: {
     timeout?: number;       // Request timeout in ms (default: 30000)
     tokenFetchTimeout?: number; // Token fetch timeout in ms (default: 5000)
@@ -317,6 +341,14 @@ const client = await createClient({
 });
 ```
 
+**ServiceHost Auto-Detection:**
+
+The SDK automatically fetches the service host from the parent page via PostMessage:
+- **Timeout**: 500ms (hardcoded, not configurable)
+- **Protocol**: Sends `{ type: 'seaverse:get_service_host', payload: { serviceName: 'dataservice' } }`
+- **Fallback**: If fetch fails, defaults to `https://dataservice-api.seaverse.ai`
+- **No user configuration**: ServiceHost is managed internally to prevent request failures
+
 **Token Authentication Priority:**
 
 The SDK uses the following priority order for obtaining authentication tokens:
@@ -325,18 +357,31 @@ The SDK uses the following priority order for obtaining authentication tokens:
 2. **Parent Page Token** - Auto-fetched via PostMessage when in iframe
 3. **No Token** - Client created without authentication (API calls will fail with 401)
 
+**AppId Configuration Priority:**
+
+The SDK uses the following priority order for determining the application ID:
+
+1. **Manual AppId (Highest Priority)** - Set via `setAppId()` (not recommended, deprecated)
+2. **Auto-extraction** - Extracted from URL (browser) or environment variable (Node.js)
+
 **Production Usage (Auto-fetch from parent):**
 
-The SDK automatically fetches the authentication token from the parent page via PostMessage when running in an iframe:
+The SDK automatically fetches the authentication token and service host from the parent page via PostMessage when running in an iframe:
 
 ```typescript
-// No token needed - auto-fetches from parent
+// No configuration needed - auto-fetches token and serviceHost from parent
 const client = await createClient({});
 
 // Parent page should respond to PostMessage:
+// Token request:
 // Send: { type: 'seaverse:get_token' }
 // Receive: { type: 'seaverse:token', payload: { accessToken: string, expiresIn: number } }
 // Error: { type: 'seaverse:error', error: string }
+
+// ServiceHost request:
+// Send: { type: 'seaverse:get_service_host', payload: { serviceName: 'dataservice' } }
+// Receive: { type: 'seaverse:service_host', payload: { serviceHost: string } }
+// Error: { type: 'seaverse:error', error: string }
 ```
 
 **Development/Testing (Debug Token):**
@@ -353,12 +398,43 @@ debugSetToken('your-test-token');
 const client = await createClient({});
 ```
 
+**Manual AppId Override (Not Recommended):**
+
+For special cases, you can force a specific appId using `setAppId()`, which will override auto-extraction:
+
+```typescript
+import { setAppId, createClient } from '@seaverse/dataservice';
+
+// Current URL: https://app_auto_extracted.app.seaverse.ai
+// Without setAppId, client.appId would be "app_auto_extracted"
+
+// Force specific appId (overrides auto-extraction)
+setAppId('my-custom-app-id');
+
+const client = await createClient({});
+console.log(client.appId); // "my-custom-app-id" (not "app_auto_extracted")
+
+// All operations will use the manual appId
+await client.userData.collection('test').insert({ foo: 'bar' });
+// ↑ This record will be stored with app_id = "my-custom-app-id"
+```
+
+⚠️ **Warning:** `setAppId()` is deprecated. Only use it when:
+- Testing in environments where URL-based extraction doesn't work
+- Debugging issues with specific appIds
+- Working around temporary limitations
+
+In production, always rely on automatic appId extraction from the URL.
+
 **Graceful Degradation:**
 
-If token fetching fails (e.g., not in an iframe, parent doesn't respond), the SDK will create a client without a token. API calls that require authentication will return 401 errors:
+If token or serviceHost fetching fails, the SDK gracefully handles the failure:
+
+- **Token fetch failure**: Creates client without authentication (API calls will return 401)
+- **ServiceHost fetch failure**: Falls back to default `https://dataservice-api.seaverse.ai`
 
 ```typescript
-// Client creation never throws, even if token fetch fails
+// Client creation never throws, even if fetch fails
 const client = await createClient({});
 
 try {
@@ -372,15 +448,6 @@ try {
 }
 ```
 
-**Custom Endpoint:**
-
-```typescript
-// Use custom API endpoint
-const client = await createClient({
-  url: 'https://your-custom-api.example.com',
-});
-```
-
 ### DataTable Methods
 
 ```typescript

package/dist/index.d.mts

@@ -12,13 +12,13 @@
  * @example
  * ```typescript
  * const config: ClientConfig = {
- *   url: 'https://dataservice-api.seaverse.ai',
+ *   options: {
+ *     timeout: 10000,
+ *   }
  * };
  * ```
  */
 interface ClientConfig {
-    /** PostgREST API base URL (default: https://dataservice-api.seaverse.ai) */
-    url?: string;
     /** Optional configuration */
     options?: {
         /** Custom fetch implementation (useful for Node.js < 18) */
@@ -278,24 +278,47 @@ interface DataServiceClient {
  * ```
  */
 declare function debugSetToken(token: string): void;
+/**
+ * Set application ID manually (not recommended)
+ *
+ * @deprecated This function is not recommended for normal use.
+ * The SDK automatically extracts appId from the URL, which is the recommended approach.
+ * Only use this for special cases where auto-extraction doesn't work.
+ *
+ * When set, this appId will take highest priority over auto-extracted appId.
+ *
+ * @param appId The application ID to use
+ *
+ * @example
+ * ```typescript
+ * import { setAppId, createClient } from '@seaverse/dataservice';
+ *
+ * // Set manual appId before creating client (highest priority)
+ * setAppId('my-custom-app-id');
+ *
+ * // Client will use manual appId instead of auto-extraction
+ * const client = await createClient({});
+ * console.log(client.appId); // "my-custom-app-id"
+ * ```
+ */
+declare function setAppId(appId: string): void;
 /**
  * Create a new Data Service client
  *
+ * The SDK automatically obtains the service host from the parent page via PostMessage (500ms timeout).
+ * If the fetch fails, it falls back to the default host: https://dataservice-api.seaverse.ai
+ *
  * AI-friendly: Single entry point with clear configuration
  *
- * @param config - Client configuration
+ * @param config - Client configuration (optional)
  * @returns DataServiceClient instance
  *
  * @example
  * ```typescript
- * // Auto-fetch token from parent page (iframe)
+ * // Auto-fetch token and serviceHost from parent page (iframe)
+ * // ServiceHost fetch: 500ms timeout, falls back to https://dataservice-api.seaverse.ai
  * const client = await createClient({});
  *
- * // Custom endpoint
- * const client = await createClient({
- *   url: 'https://your-postgrest-api.example.com',
- * });
- *
  * // For development/testing, use debugSetToken
  * import { debugSetToken, createClient } from '@seaverse/dataservice';
  * debugSetToken('your-test-token');
@@ -354,6 +377,6 @@ declare function createClient(config?: ClientConfig): Promise<DataServiceClient>
  * ```
  */
 
-declare const VERSION = "1.6.2";
+declare const VERSION = "1.8.0";
 
-export { type APIError, type ClientConfig, type Collection, type DataRecord, type DataServiceClient, DataServiceError, type DataTable, type OrderOptions, type QueryBuilder, type QueryFilter, type UserDataStats, VERSION, createClient, debugSetToken };
+export { type APIError, type ClientConfig, type Collection, type DataRecord, type DataServiceClient, DataServiceError, type DataTable, type OrderOptions, type QueryBuilder, type QueryFilter, type UserDataStats, VERSION, createClient, debugSetToken, setAppId };

package/dist/index.d.ts

@@ -12,13 +12,13 @@
  * @example
  * ```typescript
  * const config: ClientConfig = {
- *   url: 'https://dataservice-api.seaverse.ai',
+ *   options: {
+ *     timeout: 10000,
+ *   }
  * };
  * ```
  */
 interface ClientConfig {
-    /** PostgREST API base URL (default: https://dataservice-api.seaverse.ai) */
-    url?: string;
     /** Optional configuration */
     options?: {
         /** Custom fetch implementation (useful for Node.js < 18) */
@@ -278,24 +278,47 @@ interface DataServiceClient {
  * ```
  */
 declare function debugSetToken(token: string): void;
+/**
+ * Set application ID manually (not recommended)
+ *
+ * @deprecated This function is not recommended for normal use.
+ * The SDK automatically extracts appId from the URL, which is the recommended approach.
+ * Only use this for special cases where auto-extraction doesn't work.
+ *
+ * When set, this appId will take highest priority over auto-extracted appId.
+ *
+ * @param appId The application ID to use
+ *
+ * @example
+ * ```typescript
+ * import { setAppId, createClient } from '@seaverse/dataservice';
+ *
+ * // Set manual appId before creating client (highest priority)
+ * setAppId('my-custom-app-id');
+ *
+ * // Client will use manual appId instead of auto-extraction
+ * const client = await createClient({});
+ * console.log(client.appId); // "my-custom-app-id"
+ * ```
+ */
+declare function setAppId(appId: string): void;
 /**
  * Create a new Data Service client
  *
+ * The SDK automatically obtains the service host from the parent page via PostMessage (500ms timeout).
+ * If the fetch fails, it falls back to the default host: https://dataservice-api.seaverse.ai
+ *
  * AI-friendly: Single entry point with clear configuration
  *
- * @param config - Client configuration
+ * @param config - Client configuration (optional)
  * @returns DataServiceClient instance
  *
  * @example
  * ```typescript
- * // Auto-fetch token from parent page (iframe)
+ * // Auto-fetch token and serviceHost from parent page (iframe)
+ * // ServiceHost fetch: 500ms timeout, falls back to https://dataservice-api.seaverse.ai
  * const client = await createClient({});
  *
- * // Custom endpoint
- * const client = await createClient({
- *   url: 'https://your-postgrest-api.example.com',
- * });
- *
  * // For development/testing, use debugSetToken
  * import { debugSetToken, createClient } from '@seaverse/dataservice';
  * debugSetToken('your-test-token');
@@ -354,6 +377,6 @@ declare function createClient(config?: ClientConfig): Promise<DataServiceClient>
  * ```
  */
 
-declare const VERSION = "1.6.2";
+declare const VERSION = "1.8.0";
 
-export { type APIError, type ClientConfig, type Collection, type DataRecord, type DataServiceClient, DataServiceError, type DataTable, type OrderOptions, type QueryBuilder, type QueryFilter, type UserDataStats, VERSION, createClient, debugSetToken };
+export { type APIError, type ClientConfig, type Collection, type DataRecord, type DataServiceClient, DataServiceError, type DataTable, type OrderOptions, type QueryBuilder, type QueryFilter, type UserDataStats, VERSION, createClient, debugSetToken, setAppId };

package/dist/index.js

@@ -23,7 +23,8 @@ __export(src_exports, {
   DataServiceError: () => DataServiceError,
   VERSION: () => VERSION,
   createClient: () => createClient,
-  debugSetToken: () => debugSetToken
+  debugSetToken: () => debugSetToken,
+  setAppId: () => setAppId
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -41,9 +42,13 @@ var DataServiceError = class extends Error {
 
 // src/client.ts
 var debugToken = null;
+var manualAppId = null;
 function debugSetToken(token) {
   debugToken = token;
 }
+function setAppId(appId) {
+  manualAppId = appId;
+}
 function isInIframe() {
   try {
     return typeof globalThis !== "undefined" && "window" in globalThis && globalThis.window.self !== globalThis.window.top;
@@ -88,6 +93,43 @@ async function getTokenFromParent(timeout = 5e3) {
     }
   });
 }
+async function getServiceHostFromParent(timeout = 500, serviceName = "dataservice") {
+  if (!isInIframe()) {
+    return null;
+  }
+  return new Promise((resolve) => {
+    const messageHandler = (event) => {
+      if (event.data && event.data.type === "seaverse:service_host") {
+        cleanup();
+        const serviceHost = event.data.payload?.serviceHost;
+        resolve(serviceHost || null);
+      } else if (event.data && event.data.type === "seaverse:error") {
+        cleanup();
+        console.warn("[SeaVerse DataService SDK] Error getting serviceHost from parent:", event.data.error);
+        resolve(null);
+      }
+    };
+    const timeoutId = setTimeout(() => {
+      cleanup();
+      resolve(null);
+    }, timeout);
+    const cleanup = () => {
+      clearTimeout(timeoutId);
+      globalThis.window.removeEventListener("message", messageHandler);
+    };
+    globalThis.window.addEventListener("message", messageHandler);
+    try {
+      globalThis.window.parent.postMessage(
+        { type: "seaverse:get_service_host", payload: { serviceName } },
+        "*"
+        // Allow any origin, supports cross-domain scenarios
+      );
+    } catch (e) {
+      cleanup();
+      resolve(null);
+    }
+  });
+}
 function extractAppId() {
   if (typeof globalThis !== "undefined" && "location" in globalThis) {
     const location = globalThis.location;
@@ -106,8 +148,9 @@ var HTTPClient = class {
   fetchFn;
   timeout;
   tokenPromise = null;
-  constructor(config, token) {
-    this.baseUrl = (config.url || "https://dataservice-api.seaverse.ai").replace(/\/$/, "");
+  constructor(config, token, serviceHost) {
+    const defaultHost = "https://dataservice-api.seaverse.ai";
+    this.baseUrl = (serviceHost || defaultHost).replace(/\/$/, "");
     const customFetch = config.options?.fetch;
     this.fetchFn = customFetch ? customFetch.bind(customFetch) : globalThis.fetch.bind(globalThis);
     this.timeout = config.options?.timeout || 3e4;
@@ -408,6 +451,7 @@ var DataServiceClientImpl = class {
 };
 async function createClient(config = {}) {
   let token = null;
+  let serviceHost = null;
   if (debugToken) {
     token = debugToken;
   } else {
@@ -419,17 +463,24 @@ async function createClient(config = {}) {
       token = null;
     }
   }
-  const httpClient = new HTTPClient(config, token || void 0);
-  const appId = extractAppId();
+  try {
+    serviceHost = await getServiceHostFromParent(500, "dataservice");
+  } catch (error) {
+    console.warn("[SeaVerse DataService SDK] Failed to fetch serviceHost:", error);
+    serviceHost = null;
+  }
+  const httpClient = new HTTPClient(config, token || void 0, serviceHost || void 0);
+  const appId = manualAppId || extractAppId();
   return new DataServiceClientImpl(httpClient, appId);
 }
 
 // src/index.ts
-var VERSION = "1.6.2";
+var VERSION = "1.8.0";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DataServiceError,
   VERSION,
   createClient,
-  debugSetToken
+  debugSetToken,
+  setAppId
 });

package/dist/index.mjs

@@ -12,9 +12,13 @@ var DataServiceError = class extends Error {
 
 // src/client.ts
 var debugToken = null;
+var manualAppId = null;
 function debugSetToken(token) {
   debugToken = token;
 }
+function setAppId(appId) {
+  manualAppId = appId;
+}
 function isInIframe() {
   try {
     return typeof globalThis !== "undefined" && "window" in globalThis && globalThis.window.self !== globalThis.window.top;
@@ -59,6 +63,43 @@ async function getTokenFromParent(timeout = 5e3) {
     }
   });
 }
+async function getServiceHostFromParent(timeout = 500, serviceName = "dataservice") {
+  if (!isInIframe()) {
+    return null;
+  }
+  return new Promise((resolve) => {
+    const messageHandler = (event) => {
+      if (event.data && event.data.type === "seaverse:service_host") {
+        cleanup();
+        const serviceHost = event.data.payload?.serviceHost;
+        resolve(serviceHost || null);
+      } else if (event.data && event.data.type === "seaverse:error") {
+        cleanup();
+        console.warn("[SeaVerse DataService SDK] Error getting serviceHost from parent:", event.data.error);
+        resolve(null);
+      }
+    };
+    const timeoutId = setTimeout(() => {
+      cleanup();
+      resolve(null);
+    }, timeout);
+    const cleanup = () => {
+      clearTimeout(timeoutId);
+      globalThis.window.removeEventListener("message", messageHandler);
+    };
+    globalThis.window.addEventListener("message", messageHandler);
+    try {
+      globalThis.window.parent.postMessage(
+        { type: "seaverse:get_service_host", payload: { serviceName } },
+        "*"
+        // Allow any origin, supports cross-domain scenarios
+      );
+    } catch (e) {
+      cleanup();
+      resolve(null);
+    }
+  });
+}
 function extractAppId() {
   if (typeof globalThis !== "undefined" && "location" in globalThis) {
     const location = globalThis.location;
@@ -77,8 +118,9 @@ var HTTPClient = class {
   fetchFn;
   timeout;
   tokenPromise = null;
-  constructor(config, token) {
-    this.baseUrl = (config.url || "https://dataservice-api.seaverse.ai").replace(/\/$/, "");
+  constructor(config, token, serviceHost) {
+    const defaultHost = "https://dataservice-api.seaverse.ai";
+    this.baseUrl = (serviceHost || defaultHost).replace(/\/$/, "");
     const customFetch = config.options?.fetch;
     this.fetchFn = customFetch ? customFetch.bind(customFetch) : globalThis.fetch.bind(globalThis);
     this.timeout = config.options?.timeout || 3e4;
@@ -379,6 +421,7 @@ var DataServiceClientImpl = class {
 };
 async function createClient(config = {}) {
   let token = null;
+  let serviceHost = null;
   if (debugToken) {
     token = debugToken;
   } else {
@@ -390,16 +433,23 @@ async function createClient(config = {}) {
       token = null;
     }
   }
-  const httpClient = new HTTPClient(config, token || void 0);
-  const appId = extractAppId();
+  try {
+    serviceHost = await getServiceHostFromParent(500, "dataservice");
+  } catch (error) {
+    console.warn("[SeaVerse DataService SDK] Failed to fetch serviceHost:", error);
+    serviceHost = null;
+  }
+  const httpClient = new HTTPClient(config, token || void 0, serviceHost || void 0);
+  const appId = manualAppId || extractAppId();
   return new DataServiceClientImpl(httpClient, appId);
 }
 
 // src/index.ts
-var VERSION = "1.6.2";
+var VERSION = "1.8.0";
 export {
   DataServiceError,
   VERSION,
   createClient,
-  debugSetToken
+  debugSetToken,
+  setAppId
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seaverse/dataservice",
-  "version": "1.6.2",
+  "version": "1.8.0",
   "description": "AI-Friendly Universal Data Storage SDK for TypeScript/JavaScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",