@multisetai/vps 1.0.5 → 1.0.6

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.
Files changed (2) hide show
  1. package/README.md +32 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -34,6 +34,38 @@ npm install @multisetai/vps three
34
34
  - Node.js 16+ and npm
35
35
  - TypeScript 5.8+ (for TypeScript projects)
36
36
 
37
+ ## Configuration
38
+
39
+ ### CORS Domain Whitelisting
40
+
41
+ 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.
42
+
43
+ **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.
44
+
45
+ #### How to Whitelist Your Domain
46
+
47
+ 1. Navigate to the [MultiSet Dashboard](https://docs.multiset.ai/basics/credentials/configuring-allowed-domains-cors)
48
+ 2. Go to **Credentials → Settings** tab
49
+ 3. Locate the **Domains** section
50
+ 4. Click the purple **Add +** button
51
+ 5. Enter your application's full origin (protocol + domain + port if applicable)
52
+
53
+ #### Recommended Setup
54
+
55
+ Add entries for both your local development and production environments:
56
+
57
+ **Local Development:**
58
+ - **Format:** `http://localhost:PORT` (e.g., `http://localhost:3000`, `http://localhost:5173`)
59
+ - **Note:** Use the exact port your development server runs on
60
+
61
+ **Production:**
62
+ - **Format:** `https://your-domain.com` (e.g., `https://www.myapp.com`)
63
+ - **Note:** Do not include trailing slashes
64
+
65
+ > **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.
66
+
67
+ For more details, see the [MultiSet CORS Configuration Documentation](https://docs.multiset.ai/basics/credentials/configuring-allowed-domains-cors).
68
+
37
69
  ## Quick Start
38
70
 
39
71
  ### 1. Import the SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@multisetai/vps",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "description": "Multiset VPS WebXR SDK - Core client and WebXR controller.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",