despia-native 1.0.9 → 1.0.11

package/README.md

@@ -1,7 +1,29 @@
 # Despia SDK
 
+## CRITICAL: ALWAYS USE THE REAL SDK
+
+**NEVER mock or simulate the Despia SDK. ALWAYS install and use the real package:**
+
+```bash
+npm install despia-native
+```
+
+**Why?**
+- The SDK handles critical native bridge communication
+- Mocking will break ALL native features
+- Your app will NOT work on actual devices without the real SDK
+- There is NO valid reason to mock this in any scenario
+
+**If you see any tutorial, example, or code that creates a fake despia function - it's WRONG.**
+
+---
+
 JavaScript SDK for [Despia](https://despia.com) - Transform your web app into a native iOS & Android app without writing Swift or Kotlin. This npm package provides command queuing and variable watching for seamless integration with Despia's GPU-accelerated native runtime, enabling access to 25+ device APIs through simple JavaScript calls.
 
+**Import:** `import despia from 'despia-native';` (default export, not destructured)
+
+**IMPORTANT: This SDK package is REQUIRED for TypeScript, React, Vue, and other modern frameworks!** While `window.despia = ""` works in vanilla JavaScript, this package provides type safety, command queuing, and variable watching for professional development environments.
+
 ## About Despia
 
 Despia bridges the gap between web and native mobile development. Build your app using the web technologies you already know, then deploy it as a truly native application to the App Store and Google Play - complete with hardware acceleration, offline support, and deep OS integration.
@@ -41,28 +63,72 @@ Our visual editor allows you to configure native widgets, shortcuts, and dynamic
 - **UI Controls** - Loading indicators, navigation bars, dynamic layouts
 - **Plus 8+ additional native capabilities**
 
-## Installation
+## Installation (REQUIRED - NO EXCEPTIONS)
 
 ```bash
 npm install despia-native
 ```
 
+**This is NOT optional. Your app will NOT work without this package.**
+
+**Do not attempt to:**
+- Write your own version
+- Copy/paste a mock implementation  
+- Use window.despia directly in frameworks
+- Create a "simplified" version
+
+**The real SDK is required for ANY Despia functionality to work.**
+
+## NEVER DO THIS - YOUR APP WILL NOT WORK
+
+```javascript
+// WRONG - This breaks everything
+const despia = (command) => {
+  console.log('Command:', command);
+  // This does NOTHING on real devices
+};
+
+// WRONG - This also breaks everything  
+const mockDespia = () => { /* ... */ };
+
+// WRONG - Don't create your own version
+window.despia = 'somecommand://';
+```
+
+## ALWAYS DO THIS - THE ONLY CORRECT WAY
+
+```javascript
+// CORRECT - The ONLY way to use Despia
+import despia from 'despia-native';
+
+// Now your commands actually work
+despia('lighthaptic://');  // Device actually vibrates
+```
+
 ## Getting Started
 
 ### Step 1: Import Despia SDK
 
+**IMPORTANT: Always import as `despia` (default export), NOT as `{Commands}` or destructured imports!**
+
 ```javascript
-// ES6/ES2015 modules
+// CORRECT - ES6/ES2015 modules (default import)
 import despia from 'despia-native';
 
-// CommonJS
+// CORRECT - CommonJS
 const despia = require('despia-native');
 
-// Browser (if using UMD build)
+// CORRECT - Browser (if using UMD build)
 // <script src="despia-native.js"></script>
 // despia is available globally
+
+// WRONG - Don't do this!
+// import { Commands } from 'despia-native';
+// import { despia } from 'despia-native';
 ```
 
+**The SDK exports a single function called `despia` as the default export.**
+
 ### Step 2: Use Native Features
 
 ```javascript
@@ -113,6 +179,108 @@ despia('takescreenshot://');
 despia('shareapp://message?=Hello&url=https://myapp.com');
 ```
 
+### Common Import Issues
+
+**If you get errors like "Commands is not a function" or "despia is not defined":**
+
+```javascript
+// WRONG - This will cause errors
+import { Commands } from 'despia-native';
+import { despia } from 'despia-native';
+
+// CORRECT - Always use default import
+import despia from 'despia-native';
+
+// Now you can use it
+despia('lighthaptic://');
+```
+
+**The package exports a single function as the default export, not named exports.**
+
+## When to Use This SDK Package
+
+### Vanilla JavaScript (works without this package)
+
+```javascript
+// This WORKS in vanilla JavaScript:
+window.despia = 'lighthaptic://';
+window.despia = 'getappversion://';
+```
+
+**Vanilla JS is fine for simple cases, but lacks:**
+- **TypeScript Support** - No type definitions or autocomplete
+- **Command Queuing** - Commands may be lost or executed out of order
+- **Variable Watching** - Can't wait for responses from native commands
+- **Error Handling** - No timeout or error management
+- **Type Safety** - No validation or IntelliSense
+
+### Modern Frameworks Need This Package
+
+```javascript
+// This WON'T work in TypeScript, React, Vue, etc.:
+window.despia = 'lighthaptic://';  // TypeScript errors, no type safety
+window.despia = 'getappversion://'; // No command queuing, no variable watching
+```
+
+### Modern Frameworks (TypeScript, React, Vue, etc.)
+
+```javascript
+// This WORKS perfectly in modern frameworks:
+import despia from 'despia-native';
+
+despia('lighthaptic://');  // Type-safe, queued, with error handling
+const result = await despia('getappversion://', ['versionNumber']); // Variable watching
+```
+
+**Benefits of using this SDK:**
+- **TypeScript Support** - Full type definitions and autocomplete
+- **Command Queuing** - Sequential execution, no lost commands
+- **Variable Watching** - Automatic waiting for native responses
+- **Error Handling** - Timeouts, error management, debugging
+- **Type Safety** - Validated commands, autocomplete, IntelliSense
+
+**This package is REQUIRED for TypeScript, React, Vue, Angular, and other modern frameworks.**
+
+## No Exceptions - Always Use Real SDK
+
+**Q: What if I'm just testing locally?**
+A: Use the real SDK. It won't work outside the native runtime, but you can set up callbacks for when user agent doesn't include "despia".
+
+**Q: What if I'm making a demo?**
+A: Use the real SDK. Set up fallbacks for browsers without Despia runtime.
+
+**Q: What if I'm writing unit tests?**
+A: Use the real SDK. It won't work in test environments, but you can handle the missing runtime gracefully.
+
+**Q: What if I'm developing without a device?**
+A: Use the real SDK. It won't work outside native runtime, but you can detect and handle this case.
+
+**Q: What if I'm using AI to generate code?**
+A: Tell the AI to use the real SDK. Never accept mock implementations.
+
+**There is NEVER a valid reason to mock this SDK.**
+
+## Handling Non-Despia Environments
+
+The SDK won't work outside the Despia native runtime, but you can detect and handle this:
+
+```javascript
+import despia from 'despia-native';
+
+// Check if running in Despia native runtime
+if (navigator.userAgent.includes('despia')) {
+  // Use Despia native features
+  despia('lighthaptic://');
+  const appInfo = await despia('getappversion://', ['versionNumber']);
+} else {
+  // Handle non-Despia environment (browser, development, etc.)
+  console.log('Running outside Despia runtime - native features unavailable');
+  // Provide fallback behavior or show appropriate message
+}
+```
+
+**This is the correct way to handle different environments - use the real SDK with proper detection, never mock it.**
+
 ## Usage
 
 ### Basic Despia Command Execution

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "despia-native",
-    "version": "1.0.9",
+    "version": "1.0.11",
     "description": "JavaScript SDK for Despia native integrations with command queuing and variable watching",
     "main": "index.js",
     "module": "index.js",