@unvired/turboforms-embed-sdk 1.0.14 → 1.0.16

package/README.md

@@ -309,6 +309,41 @@ When a user crops or annotates an existing server image or local image, the SDK
 
 This process simplifies the architecture: edits simply generate brand new files, offloading any complex diffing logic to the main application server layer.
 
+## ⚡ Performance Optimization
+
+### Pre-initializing SmartStorage (IndexedDB)
+
+Opening an IndexedDB connection can sometimes introduce a slight delay (lag) during the first file upload or image capture. To eliminate this, the SDK dispatches a `smartStorageReady` event as soon as the storage provider is registered.
+
+You can listen for this event in your host application and call `preInitialize()` to "warm up" the database connection immediately during page load, ensuring the first upload is instantaneous.
+
+#### Implementation Example
+
+```javascript
+// Proper event-driven initialization in your host application
+(function() {
+    const initDb = (SmartStorage) => {
+        if (SmartStorage && typeof SmartStorage.preInitialize === 'function') {
+            console.log("⚡ Pre-initializing SmartStorage IndexedDB...");
+            SmartStorage.preInitialize();
+        }
+    };
+
+    // 1. Check if already loaded in Formio provider registry
+    const existing = window.Formio?.providers?.storage?.SmartStorage || 
+                   window.Formio?.Providers?.providers?.storage?.SmartStorage;
+    
+    if (existing) {
+        initDb(existing);
+    } else {
+        // 2. Otherwise listen for the SDK's "ready" event dispatched on document
+        document.addEventListener('smartStorageReady', (e) => {
+            initDb(e.detail.SmartStorage);
+        }, { once: true });
+    }
+})();
+```
+
 ## 🔧 Form Instance Methods
 
 The `loadUnviredForms` function returns a FormInstance object with the following methods: