@multisetai/vps 1.0.4 → 1.0.6

package/README.md

@@ -1,16 +1,16 @@
-# Multiset VPS WebXR
+# MultiSet VPS WebXR
 
-Multiset VPS WebXR is a TypeScript SDK that enables developers to integrate Multiset's Visual Positioning System (VPS) capabilities into WebXR applications. It provides precise 6-DOF (6 degrees of freedom) localization by matching camera frames against cloud-hosted maps, allowing AR applications to understand their position and orientation in physical space.
+MultiSet VPS WebXR is a TypeScript SDK that enables developers to integrate MultiSet's Visual Positioning System (VPS) capabilities into WebXR applications. It provides precise 6-DOF (6 degrees of freedom) localization by matching camera frames against cloud-hosted maps, allowing AR applications to understand their position and orientation in physical space.
 
 ## Features
 
-- **Core Client** (`@multisetai/vps/core`) - Authentication and API client for Multiset VPS services
+- **Core Client** (`@multisetai/vps/core`) - Authentication and API client for MultiSet VPS services
 - **WebXR Controller** (`@multisetai/vps/webxr`) - Three.js WebXR session management and frame capture
 - **Framework-agnostic** - Works with React, Vue, Angular, or vanilla JavaScript
 - **TypeScript support** - Full type definitions included
 - **Event-driven architecture** - Comprehensive callbacks for all operations
 - **Precise localization** - 6-DOF pose estimation with position and rotation
-- **Cloud-based mapping** - Leverages Multiset's cloud infrastructure for map storage and matching
+- **Cloud-based mapping** - Leverages MultiSet's cloud infrastructure for map storage and matching
 
 ## Installation
 
@@ -34,6 +34,38 @@ npm install @multisetai/vps three
 - Node.js 16+ and npm
 - TypeScript 5.8+ (for TypeScript projects)
 
+## Configuration
+
+### CORS Domain Whitelisting
+
+Since this SDK makes direct API calls to MultiSet servers from browser-based applications, you **must** configure Cross-Origin Resource Sharing (CORS) by whitelisting your application's domain in the MultiSet dashboard.
+
+**Why is this required?** Browsers restrict cross-origin HTTP requests for security. By adding your domain to the MultiSet whitelist, you allow your web application to make API requests to MultiSet services.
+
+#### How to Whitelist Your Domain
+
+1. Navigate to the [MultiSet Dashboard](https://docs.multiset.ai/basics/credentials/configuring-allowed-domains-cors)
+2. Go to **Credentials → Settings** tab
+3. Locate the **Domains** section
+4. Click the purple **Add +** button
+5. Enter your application's full origin (protocol + domain + port if applicable)
+
+#### Recommended Setup
+
+Add entries for both your local development and production environments:
+
+**Local Development:**
+- **Format:** `http://localhost:PORT` (e.g., `http://localhost:3000`, `http://localhost:5173`)
+- **Note:** Use the exact port your development server runs on
+
+**Production:**
+- **Format:** `https://your-domain.com` (e.g., `https://www.myapp.com`)
+- **Note:** Do not include trailing slashes
+
+> **Important:** Without whitelisting your domain, API requests will be blocked by the browser's CORS policy, and you'll see errors in the browser console.
+
+For more details, see the [MultiSet CORS Configuration Documentation](https://docs.multiset.ai/basics/credentials/configuring-allowed-domains-cors).
+
 ## Quick Start
 
 ### 1. Import the SDK
@@ -47,9 +79,9 @@ import { WebxrController } from '@multisetai/vps/webxr';
 
 ```typescript
 const client = new MultisetClient({
-  clientId: 'your-client-id',
-  clientSecret: 'your-client-secret',
-  code: 'MAP_YOUR_MAP_CODE',
+  clientId: 'CLIENT_ID',
+  clientSecret: 'CLIENT_SECRET',
+  code: 'MAP_OUR_MAPSET_CODE',
   mapType: 'map', // or 'map-set'
   endpoints: DEFAULT_ENDPOINTS,
   onAuthorize: (token) => console.log('Authorized:', token),
@@ -87,7 +119,7 @@ if (result?.localizeData?.poseFound) {
 
 ### `MultisetClient`
 
-The core client handles authentication and API interactions with Multiset services.
+The core client handles authentication and API interactions with MultiSet services.
 
 #### Constructor
 
@@ -99,8 +131,8 @@ new MultisetClient(config: IMultisetSdkConfig)
 
 ```typescript
 interface IMultisetSdkConfig {
-  clientId: string;                    // Your Multiset client ID
-  clientSecret: string;                // Your Multiset client secret
+  clientId: string;                    // Your MultiSet client ID
+  clientSecret: string;                // Your MultiSet client secret
   code: string;                        // Map code (e.g., 'MAP_XXXXX')
   mapType: 'map' | 'map-set';         // Type of map to use
   endpoints?: Partial<IMultisetSdkEndpoints>; // Optional custom endpoints
@@ -116,7 +148,7 @@ interface IMultisetSdkConfig {
 
 ##### `authorize(): Promise<string>`
 
-Authenticates with Multiset services and obtains an access token. Must be called before making any API requests.
+Authenticates with MultiSet services and obtains an access token. Must be called before making any API requests.
 
 ```typescript
 const token = await client.authorize();
@@ -257,6 +289,12 @@ import type {
 
 ## Examples
 
+> **Full working examples**: This repository includes complete, runnable example applications in the [`examples/`](./examples) directory:
+> - **[React Example](./examples/react)** - Full React implementation with TypeScript
+> - **[Vanilla JavaScript Example](./examples/vanilla)** - Vanilla JavaScript implementation
+>
+> Each example includes setup instructions, configuration, and demonstrates the complete SDK integration workflow.
+
 ### Vanilla JavaScript
 
 ```javascript
@@ -265,9 +303,9 @@ import { MultisetClient, DEFAULT_ENDPOINTS } from '@multisetai/vps/core';
 import { WebxrController } from '@multisetai/vps/webxr';
 
 const client = new MultisetClient({
-  clientId: 'your-client-id',
-  clientSecret: 'your-client-secret',
-  code: 'MAP_YOUR_MAP_CODE',
+  clientId: 'CLIENT_ID',
+  clientSecret: 'CLIENT_SECRET',
+  code: 'MAP_OR_MAPSET_CODE',
   mapType: 'map',
   endpoints: DEFAULT_ENDPOINTS,
   onAuthorize: (token) => console.log('Authorized:', token),
@@ -318,9 +356,9 @@ export default function App() {
 
   useEffect(() => {
     clientRef.current = new MultisetClient({
-      clientId: 'your-client-id',
-      clientSecret: 'your-client-secret',
-      code: 'MAP_YOUR_MAP_CODE',
+      clientId: 'CLIENT_ID',
+      clientSecret: 'CLIENT_SECRET',
+      code: 'MAP_OR_MAPSET_CODE',
       mapType: 'map',
       endpoints: DEFAULT_ENDPOINTS,
     });

package/dist/core/index.d.ts

@@ -17,7 +17,7 @@ interface ILocalizeResponse {
     retrieval_scores: number[];
     num_matches: number[];
     confidence: number;
-    retreived_imgs: string[];
+    retrieved_imgs: string[];
     mapIds: string[];
 }
 interface IMapLocation {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multisetai/vps",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Multiset VPS WebXR SDK - Core client and WebXR controller.",
   "type": "module",
   "main": "dist/index.js",