shogun-core 3.3.6 → 3.3.8

package/dist/core.js

@@ -215,8 +215,8 @@ class ShogunCore {
      * @description Authenticates user using a GunDB pair directly.
      * Emits login event on success.
      */
-    async loginWithPair(pair) {
-        return this.authManager.loginWithPair(pair);
+    async loginWithPair(username, pair) {
+        return this.authManager.loginWithPair(username, pair);
     }
     /**
      * Register a new user with provided credentials
@@ -318,13 +318,12 @@ class ShogunCore {
     }
 }
 exports.ShogunCore = ShogunCore;
-ShogunCore.API_VERSION = "^3.0.11";
+ShogunCore.API_VERSION = "^3.3.8";
 // Global declarations are handled in the original core.ts file
 // to avoid conflicts, we only set the window properties here
 if (typeof window !== "undefined") {
-    window.SHOGUN_CORE = (config) => {
+    window.ShogunCore = (config) => {
         return new ShogunCore(config);
     };
-    window.SHOGUN_CORE_CLASS = ShogunCore;
 }
 exports.default = ShogunCore;

package/dist/examples/simple-api-test.js

@@ -1,87 +1,112 @@
 "use strict";
 /**
- * Esempio semplice che mostra le differenze principali tra i metodi API
+ * Example showing how to use the simplified ShogunCore API
+ *
+ * The API has been streamlined:
+ * - AutoQuickStart: Quick initialization helper
+ * - api.database: Direct access to DataBase for basic operations (get, put, set, remove, auth)
+ * - api helper methods: High-level helpers for profile, settings, collections, and array utilities
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.simpleAPITest = simpleAPITest;
 const api_1 = require("../gundb/api");
 async function simpleAPITest() {
-    console.log("🚀 Test semplice API ShogunCore\n");
-    // Setup
+    console.log("🚀 ShogunCore Simplified API Example\n");
+    // === QUICK START ===
+    console.log("📦 === INITIALIZATION ===\n");
+    // Use AutoQuickStart for easy setup
     const quickStart = new api_1.AutoQuickStart({
         peers: ["https://peer.wallie.io/gun"],
         appScope: "simple-test",
     });
     await quickStart.init();
+    // Access the API and database
     const api = quickStart.api;
-    // === DIFFERENZE PRINCIPALI ===
-    console.log("📊 === DIFFERENZE GET ===\n");
-    // 1. get() - restituisce dati direttamente
-    const data1 = await api.get("test/path");
-    console.log('get("test/path"):', data1); // null o dati
-    // 2. getNode() - restituisce nodo Gun per chaining
-    const node1 = api.getNode("test/path");
-    console.log('getNode("test/path"):', typeof node1); // "object" (Gun node)
-    // 3. node() - alias di getNode()
-    const node2 = api.node("test/path");
-    console.log('node("test/path"):', typeof node2); // "object" (Gun node)
-    // 4. chain() - wrapper con metodi di convenienza
-    const chain1 = api.chain("test/path");
-    console.log('chain("test/path"):', Object.keys(chain1)); // ['get', 'put', 'set', 'once', 'then', 'map']
-    console.log("\n💾 === DIFFERENZE PUT/SET ===\n");
+    const db = api.database; // Direct access to DataBase for basic operations
+    console.log("Initialized successfully!");
+    console.log("- api: provides helper methods");
+    console.log("- db (api.database): provides full DataBase functionality\n");
+    // === BASIC OPERATIONS (via database) ===
+    console.log("💾 === BASIC OPERATIONS (use api.database) ===\n");
     const testData = { message: "Hello World", timestamp: Date.now() };
-    // 1. put() - salva dati globali
-    const putResult = await api.put("global/data", testData);
-    console.log("put() result:", putResult); // true/false
-    // 2. set() - come put() ma semantica diversa
-    const setResult = await api.set("global/data2", {
-        ...testData,
-        method: "set",
-    });
-    console.log("set() result:", setResult); // true/false
-    // Verifica
-    const retrieved1 = await api.get("global/data");
-    const retrieved2 = await api.get("global/data2");
-    console.log("Retrieved put data:", retrieved1);
-    console.log("Retrieved set data:", retrieved2);
-    console.log("\n🗑️ === DIFFERENZE REMOVE ===\n");
-    // remove() - rimuove dati globali
-    const removeResult = await api.remove("global/data2");
-    console.log("remove() result:", removeResult); // true/false
-    const afterRemove = await api.get("global/data2");
-    console.log("Data after remove:", afterRemove); // null
-    console.log("\n🔐 === TEST AUTENTICAZIONE ===\n");
-    // Signup e login
+    // Use db for basic operations
+    await db.put("global/data", testData);
+    console.log("✓ Saved data with db.put()");
+    const retrieved = await db.getData("global/data");
+    console.log("✓ Retrieved data with db.getData():", retrieved);
+    await db.remove("global/data");
+    console.log("✓ Removed data with db.remove()\n");
+    // === AUTHENTICATION (via database) ===
+    console.log("🔐 === AUTHENTICATION (use api.database) ===\n");
     const username = "testuser_" + Date.now();
     const password = "testpass123";
-    const signupResult = await api.signup(username, password);
-    console.log("Signup result:", signupResult);
-    if (signupResult) {
-        const loginResult = await api.login(username, password);
-        console.log("Login result:", loginResult);
-        if (loginResult) {
-            console.log("\n👤 === OPERAZIONI UTENTE ===\n");
-            // getUserData() - per dati utente
-            const userData = await api.getUserData("profile");
-            console.log('getUserData("profile"):', userData); // null o dati utente
-            // putUserData() - salva dati utente
-            const profileData = { name: "Test User", email: "test@example.com" };
-            const putUserResult = await api.putUserData("profile", profileData);
-            console.log("putUserData() result:", putUserResult); // true/false
-            // Verifica dati utente
-            const retrievedProfile = await api.getUserData("profile");
-            console.log("Retrieved profile:", retrievedProfile);
-            // removeUserData() - rimuove dati utente
-            const removeUserResult = await api.removeUserData("profile");
-            console.log("removeUserData() result:", removeUserResult); // true/false
-            const afterRemoveUser = await api.getUserData("profile");
-            console.log("User data after remove:", afterRemoveUser); // null
+    const signupResult = await db.signUp(username, password);
+    console.log("✓ Signup:", signupResult.success ? "Success" : "Failed");
+    if (signupResult.success) {
+        const loginResult = await db.login(username, password);
+        console.log("✓ Login:", loginResult.success ? "Success" : "Failed");
+        if (loginResult.success) {
+            console.log("✓ Current user:", db.getCurrentUser()?.alias, "\n");
+            // === HELPER METHODS (via api) ===
+            console.log("⭐ === HELPER METHODS (use api helpers) ===\n");
+            // Profile helper
+            await api.updateProfile({
+                name: "Test User",
+                email: "test@example.com",
+                bio: "Testing the simplified API",
+            });
+            console.log("✓ Profile updated with api.updateProfile()");
+            const profile = await api.getProfile();
+            console.log("✓ Profile retrieved:", profile);
+            // Settings helper
+            await api.saveSettings({
+                theme: "dark",
+                language: "en",
+                notifications: true,
+            });
+            console.log("✓ Settings saved with api.saveSettings()");
+            const settings = await api.getSettings();
+            console.log("✓ Settings retrieved:", settings);
+            // Collections helper
+            await api.createCollection("favorites", {
+                item1: { id: "item1", title: "First Item" },
+                item2: { id: "item2", title: "Second Item" },
+            });
+            console.log("✓ Collection created with api.createCollection()");
+            await api.addToCollection("favorites", "item3", {
+                id: "item3",
+                title: "Third Item",
+            });
+            console.log("✓ Item added with api.addToCollection()");
+            const collection = await api.getCollection("favorites");
+            console.log("✓ Collection retrieved:", collection);
+            // === ARRAY UTILITIES ===
+            console.log("\n🔧 === ARRAY UTILITIES ===\n");
+            const items = [
+                { id: "1", name: "Item 1", value: 100 },
+                { id: "2", name: "Item 2", value: 200 },
+                { id: "3", name: "Item 3", value: 300 },
+            ];
+            // Convert array to GunDB-friendly indexed object
+            const indexed = api.arrayToIndexedObject(items);
+            console.log("✓ Array converted to indexed object:", indexed);
+            // Convert back to array
+            const restored = api.indexedObjectToArray(indexed);
+            console.log("✓ Indexed object converted back to array:", restored);
             // Logout
-            api.logout();
-            console.log("Logged out");
+            db.logout();
+            console.log("\n✓ Logged out");
         }
     }
-    console.log("\n✅ Test completato!");
+    console.log("\n✅ Example completed!");
+    console.log("\nSummary:");
+    console.log("- Use AutoQuickStart for easy initialization");
+    console.log("- Use api.database for basic operations (get, put, auth, etc.)");
+    console.log("- Use api helper methods for high-level operations:");
+    console.log("  • updateProfile(), getProfile()");
+    console.log("  • saveSettings(), getSettings()");
+    console.log("  • createCollection(), addToCollection(), getCollection()");
+    console.log("  • arrayToIndexedObject(), indexedObjectToArray()");
 }
 // Esegui il test
 if (require.main === module) {