shogun-core 3.3.4 → 3.3.5

package/dist/types/ship/implementation/SHIP_06.d.ts

@@ -1,66 +1,101 @@
 /**
- * SHIP-06: Ephemeral P2P Messaging Implementation
+ * SHIP-06: Secure Vault Implementation
  *
- * Two modes:
- * 1. Standalone: new SHIP_06(gunPeers[], roomId) - NO authentication!
- *    - Uses ShogunCore internally with silent: true, disableAutoRecall: true
- *    - Zero logs, zero storage, pure relay communication
- *    - Room hashed with Web Crypto API SHA-256 for deterministic IDs
+ * Vault crittografato decentralizzato che dipende da SHIP-00 per l'identità.
  *
- * 2. With Identity: new SHIP_06(ISHIP_00, roomId) - Authenticated sessions
- *    - Uses existing Gun instance from SHIP-00
- *    - All ShogunCore features available
+ * Dipendenze:
+ * - SHIP-00 (Identity & Authentication) - per gestione utenti e chiavi
+ * - GunDB - per storage decentralizzato P2P
+ * - SEA - per crittografia AES-256-GCM
  *
- * Architecture:
- * - Gun Relay for P2P communication (no WebRTC complexity!)
- * - SEA for ephemeral key generation and ECDH encryption
- * - Pure relay mode: radisk: false, localStorage: false, multicast: false
+ * Ispirato a: https://github.com/draeder/gunsafe
  */
 import type { ISHIP_00 } from "../interfaces/ISHIP_00";
-import type { ISHIP_06, EphemeralMessage, EphemeralConfig, PeerInfo } from "../interfaces/ISHIP_06";
-import type { SEAPair } from "../interfaces/ISHIP_00";
+import type { ISHIP_06, VaultRecord, VaultResult, VaultStats, RecordMetadata, GetOptions, ListOptions, ImportOptions, ExportOptions } from "../interfaces/ISHIP_06";
+/**
+ * SHIP-06 Reference Implementation
+ *
+ * Questa implementazione dipende da ISHIP_00 per tutte le operazioni di identità.
+ * Si concentra esclusivamente sulla logica del vault crittografato.
+ */
 declare class SHIP_06 implements ISHIP_06 {
     private identity;
-    private roomId;
-    private config;
-    private connected;
-    private swarmId;
-    private myAddress;
-    private myPair;
-    private gun;
-    private sea;
-    private roomNode;
-    private presenceNode;
-    private messagesNode;
-    private peers;
-    private messageHandlers;
-    private encryptedMessageHandlers;
-    private peerSeenHandlers;
-    private peerLeftHandlers;
-    private heartbeatInterval;
-    private processedMessages;
-    constructor(identityOrPeers: ISHIP_00 | string[], roomId: string, config?: Partial<EphemeralConfig> | {
-        debug?: boolean;
-    });
+    private initialized;
+    private vaultNodeName;
+    private vaultNode;
+    private recordsNode;
+    private metadataNode;
+    private static readonly VAULT_VERSION;
+    private static readonly DEFAULT_NODE_NAME;
+    /**
+     * Constructor
+     * @param identity ISHIP_00 instance for identity operations
+     * @param vaultNodeName Optional custom vault node name
+     */
+    constructor(identity: ISHIP_00, vaultNodeName?: string);
+    /**
+     * Get identity provider
+     */
     getIdentity(): ISHIP_00;
-    connect(): Promise<void>;
-    disconnect(): void;
-    isConnected(): boolean;
-    getSwarmId(): string;
-    getAddress(): string;
-    private announcePresence;
-    private startHeartbeat;
-    private listenForPeers;
-    sendBroadcast(message: string): Promise<void>;
-    sendDirect(peerAddress: string, message: string): Promise<void>;
-    private listenForMessages;
-    onMessage(callback: (message: EphemeralMessage) => void): void;
-    onPeerSeen(callback: (address: string) => void): void;
-    onPeerLeft(callback: (address: string) => void): void;
-    onEncryptedMessage(callback: (address: string, data: any) => void): void;
-    getPeers(): string[];
-    getPeerInfo(address: string): PeerInfo | null;
-    getEphemeralPair(): Promise<SEAPair>;
-    setEphemeralPair(pair: SEAPair): Promise<void>;
+    /**
+     * Initialize vault
+     */
+    initialize(): Promise<void>;
+    /**
+     * Check if vault is initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Store encrypted record in vault
+     */
+    put(name: string, data: any, metadata?: RecordMetadata): Promise<VaultResult>;
+    /**
+     * Retrieve and decrypt record from vault
+     */
+    get(name: string, options?: GetOptions): Promise<VaultRecord | null>;
+    /**
+     * Delete record from vault (soft delete)
+     */
+    delete(name?: string): Promise<VaultResult>;
+    /**
+     * List all record names in vault
+     */
+    list(options?: ListOptions): Promise<string[]>;
+    /**
+     * Check if record exists
+     */
+    exists(name: string): Promise<boolean>;
+    /**
+     * Update existing record
+     */
+    update(name: string, data: any): Promise<VaultResult>;
+    /**
+     * Export entire vault (encrypted)
+     */
+    export(password?: string, options?: ExportOptions): Promise<string>;
+    /**
+     * Import vault from backup
+     */
+    import(backupData: string, password?: string, options?: ImportOptions): Promise<VaultResult>;
+    /**
+     * Get vault statistics
+     */
+    getStats(): Promise<VaultStats>;
+    /**
+     * Clear all records (soft delete all)
+     */
+    clear(): Promise<VaultResult>;
+    /**
+     * Compact vault (remove deleted records permanently)
+     */
+    compact(): Promise<VaultResult>;
+    /**
+     * Search records by content
+     */
+    search(query: string): Promise<string[]>;
+    /**
+     * Update record count in metadata
+     */
+    private updateRecordCount;
 }
 export { SHIP_06 };