shogun-core 3.0.3 → 3.0.4

package/dist/types/gundb/types.d.ts

@@ -1,264 +0,0 @@
-/**
- * Type definitions for GunDB to replace 'any' usage
- */
-export type GunType = (config?: any) => IGunInstance<any>;
-export type SEAType = any;
-export type GunUser = IGunUserInstance<any>;
-export type UserInfo = {
-    pub: string;
-    alias?: string;
-    timestamp?: number;
-    user?: GunUser;
-};
-export type AuthCallback = (user: GunUser) => void;
-export type AuthResult = {
-    success: boolean;
-    userPub?: string;
-    error?: string;
-    ack?: any;
-    sea?: {
-        pub: string;
-        priv: string;
-        epub: string;
-        epriv: string;
-    };
-};
-export type GunData = any;
-export type GunNode = any;
-export type GunCallback = any;
-export type GunDataCallback = any;
-export type GunMapCallback = any;
-export interface UsernameLookupResult {
-    pub?: string;
-    userPub?: string;
-    username?: string;
-    source: string;
-    immutable: boolean;
-    hash?: string;
-    [key: string]: any;
-}
-export interface UserMetadata {
-    username: string;
-    pub: string;
-    createdAt: number;
-    lastLogin: number;
-}
-export interface MappingData {
-    username: string;
-    userPub: string;
-    createdAt: number;
-}
-export interface SecurityData {
-    questions: string;
-    hint: string;
-}
-export interface FrozenData {
-    data: any;
-    timestamp: number;
-    description: string;
-    metadata: Record<string, any>;
-}
-export interface FrozenSpaceOptions {
-    namespace?: string;
-    path?: string;
-    description?: string;
-    metadata?: Record<string, any>;
-}
-export interface ConnectivityTestResult {
-    peers: {
-        [peer: string]: {
-            connected: boolean;
-            status: string;
-        };
-    };
-    gunInstance: boolean;
-    userInstance: boolean;
-    canWrite: boolean;
-    canRead: boolean;
-    testWriteResult?: any;
-    testReadResult?: any;
-}
-export interface LoginResult {
-    success: boolean;
-    userPub?: string;
-    username?: string;
-    error?: string;
-}
-export interface SignupResult {
-    success: boolean;
-    userPub?: string;
-    username?: string;
-    message?: string;
-    error?: string;
-    sea?: {
-        pub: string;
-        priv: string;
-        epub: string;
-        epriv: string;
-    };
-}
-export interface PostAuthResult {
-    success: boolean;
-    userPub?: string;
-    username?: string;
-    error?: string;
-}
-export interface PasswordHintResult {
-    success: boolean;
-    hint?: string;
-    error?: string;
-}
-export interface P256Keys {
-    pub: string;
-    priv: string;
-    epub: string;
-    epriv: string;
-}
-export interface Secp256k1Keys {
-    pub: string;
-    priv: string;
-    address: string;
-}
-export interface DeriveResult {
-    p256?: P256Keys;
-    secp256k1Bitcoin?: Secp256k1Keys;
-    secp256k1Ethereum?: Secp256k1Keys;
-}
-export interface FrozenSpaceResult {
-    hash: string;
-    fullPath: string;
-    data: FrozenData;
-}
-export interface VerificationResult {
-    verified: boolean;
-    frozenData?: FrozenData;
-    error?: string;
-}
-export interface SessionRestorationResult {
-    success: boolean;
-    userPub?: string;
-    error?: string;
-}
-export interface UserExistenceResult {
-    exists: boolean;
-    userPub?: string;
-    error?: string;
-}
-export interface UserCreationResult {
-    success: boolean;
-    pub?: string;
-    error?: string;
-}
-export type EventData = any;
-export type EventListener = (data: EventData) => void;
-export interface GunOperationResult {
-    success: boolean;
-    error?: string;
-}
-/**
- * Improved type definitions to reduce 'any' usage while maintaining GunDB compatibility
- */
-import type { IGunUserInstance, IGunInstance, IGunChain, ISEAPair } from "gun/types";
-export type GunInstance = IGunInstance<any>;
-export type GunUserInstance = IGunUserInstance<any>;
-export type GunChain = IGunChain<any, IGunInstance<any>, IGunInstance<any>, string>;
-export interface GunAckCallback {
-    (ack: {
-        err?: string;
-        ok?: number;
-        pub?: string;
-    }): void;
-}
-export interface TypedGunOperationResult<T = unknown> {
-    success: boolean;
-    data?: T;
-    error?: string;
-    ack?: {
-        err?: string;
-        ok?: number;
-        pub?: string;
-    };
-}
-export interface TypedUserInfo {
-    pub: string;
-    alias?: string;
-    timestamp?: number;
-    user?: GunUserInstance;
-    metadata?: Record<string, unknown>;
-}
-export interface TypedAuthCallback {
-    (user: GunUserInstance): void;
-}
-export interface TypedAuthResult {
-    success: boolean;
-    userPub?: string;
-    username?: string;
-    error?: string;
-    ack?: {
-        err?: string;
-        ok?: number;
-        pub?: string;
-        sea?: ISEAPair;
-    };
-    sea?: ISEAPair;
-}
-export interface TypedGunConfig {
-    peers?: string[];
-    localStorage?: boolean;
-    radisk?: boolean;
-    file?: string;
-    uuid?: () => string;
-    [key: string]: unknown;
-}
-export interface TypedEventData {
-    type: string;
-    data: unknown;
-    timestamp: number;
-    source?: string;
-}
-export type GunPath = string | string[];
-export interface PathOperation<T = unknown> {
-    path: GunPath;
-    data?: T;
-    callback?: GunAckCallback;
-}
-export interface TypedRxJSObservable<T = unknown> {
-    subscribe: (observer: {
-        next: (value: T) => void;
-        error?: (error: Error) => void;
-        complete?: () => void;
-    }) => {
-        unsubscribe: () => void;
-    };
-}
-export interface TypedPluginConfig {
-    name: string;
-    version: string;
-    enabled: boolean;
-    config?: Record<string, unknown>;
-}
-export interface TypedStorageData {
-    key: string;
-    value: unknown;
-    timestamp: number;
-    ttl?: number;
-}
-export interface TypedGunError extends Error {
-    code?: string;
-    type: "GUN_ERROR" | "AUTH_ERROR" | "NETWORK_ERROR" | "VALIDATION_ERROR";
-    context?: Record<string, unknown>;
-}
-export type GunOperation = "get" | "put" | "set" | "remove" | "once" | "on" | "off";
-export type GunAuthMethod = "password" | "pair" | "webauthn" | "web3" | "nostr";
-export interface TypedGunWrapper<T = Record<string, unknown>> {
-    gun: GunInstance;
-    user: GunUserInstance | null;
-    get(path: GunPath): Promise<T>;
-    put(path: GunPath, data: T): Promise<TypedGunOperationResult<T>>;
-    set(path: GunPath, data: T): Promise<TypedGunOperationResult<T>>;
-    remove(path: GunPath): Promise<TypedGunOperationResult>;
-    getUserData(path: string): Promise<T>;
-    putUserData(path: string, data: T): Promise<void>;
-    login(username: string, password: string): Promise<TypedAuthResult>;
-    signUp(username: string, password: string): Promise<TypedAuthResult>;
-}

package/dist/types/index.d.ts

@@ -1,14 +0,0 @@
-import { ShogunCore } from "./core";
-import { IGunUserInstance, IGunInstance, GunDataEventData, GunPeerEventData, DeriveOptions } from "./gundb/db";
-import { SEA, RxJS, crypto, derive, GunErrors, DataBase } from "./gundb/db";
-import { SimpleGunAPI, QuickStart, quickStart, createSimpleAPI, GunInstance, GunUserInstance, TypedGunOperationResult, TypedAuthResult } from "./gundb";
-import Gun from "./gundb/db";
-export * from "./utils/errorHandler";
-export * from "./plugins";
-export * from "./interfaces/shogun";
-export type * from "./interfaces/plugin";
-export * from "./config/simplified-config";
-export type { IGunUserInstance, IGunInstance, GunDataEventData, GunPeerEventData, DeriveOptions, GunInstance, GunUserInstance, TypedGunOperationResult, TypedAuthResult, };
-export { SEA, RxJS, crypto, derive, GunErrors, DataBase, SimpleGunAPI, QuickStart, quickStart, createSimpleAPI, };
-export { Gun };
-export { ShogunCore };

package/dist/types/interfaces/common.d.ts

@@ -1,85 +0,0 @@
-/**
- * Base event interface
- */
-export interface BaseEvent {
-    type: string;
-    data: Record<string, unknown>;
-    timestamp: number;
-}
-/**
- * Base configuration interface
- */
-export interface BaseConfig {
-    timeout?: number;
-    maxRetries?: number;
-    retryDelay?: number;
-}
-/**
- * Base cache entry interface
- */
-export interface BaseCacheEntry<T = unknown> {
-    timestamp: number;
-    data?: T;
-}
-/**
- * Base operation result
- */
-export interface BaseResult {
-    success: boolean;
-    error?: string;
-}
-/**
- * Base authentication result
- */
-export interface BaseAuthResult extends BaseResult {
-    username?: string;
-    password?: string;
-}
-/**
- * Common log levels
- */
-export type LogLevel = "info" | "error" | "debug" | "warn";
-/**
- * Base log message
- */
-export interface BaseLogMessage {
-    timestamp: string;
-    level: LogLevel;
-    message: string;
-    data?: Record<string, unknown>;
-}
-/**
- * Base device info
- */
-export interface BaseDeviceInfo {
-    deviceId: string;
-    timestamp: number;
-    name: string;
-    platform: string;
-    lastUsed?: number;
-}
-/**
- * Base backup options
- */
-export interface BaseBackupOptions {
-    encryptionPassword?: string;
-    includeHistory?: boolean;
-}
-/**
- * Base import options
- */
-export interface BaseImportOptions {
-    decryptionPassword?: string;
-    validateData?: boolean;
-    overwriteExisting?: boolean;
-}
-/**
- * Basic error information
- */
-export interface ErrorInfo {
-    message: string;
-    code?: string;
-    name?: string;
-    stack?: string;
-    [key: string]: unknown;
-}

package/dist/types/interfaces/events.d.ts

@@ -1,131 +0,0 @@
-import { EventEmitter } from "../utils/eventEmitter";
-/**
- * Interface representing authentication event data
- * @interface AuthEventData
- * @property {string} [userPub] - The user's public key (optional)
- * @property {string} [username] - Optional username
- * @property {"password" | "webauthn" | "web3" | "nostr" | "oauth" | "bitcoin" } method - Authentication method used
- * @property {string} [provider] - Optional provider name (for OAuth)
- */
-export interface AuthEventData {
-    userPub?: string;
-    username?: string;
-    method: "password" | "webauthn" | "web3" | "nostr" | "oauth" | "bitcoin";
-    provider?: string;
-}
-/**
- * Interface representing wallet event data
- * @interface WalletEventData
- * @property {string} address - The wallet address
- * @property {string} [path] - Optional derivation path
- */
-export interface WalletEventData {
-    address: string;
-    path?: string;
-}
-/**
- * Interface representing error event data
- * @interface ErrorEventData
- * @property {string} action - Error action/code
- * @property {string} message - Error message
- * @property {string} type - Error type
- * @property {unknown} [details] - Optional additional error details
- */
-export interface ErrorEventData {
-    action: string;
-    message: string;
-    type: string;
-    details?: unknown;
-}
-/**
- * Interface representing Gun data operation event data
- * @interface GunDataEventData
- * @property {string} path - The path where the operation occurred
- * @property {any} [data] - The data involved in the operation
- * @property {boolean} success - Whether the operation was successful
- * @property {string} [error] - Error message if operation failed
- * @property {number} timestamp - Timestamp of the operation
- */
-export interface GunDataEventData {
-    path: string;
-    data?: any;
-    success: boolean;
-    error?: string;
-    timestamp: number;
-}
-/**
- * Interface representing Gun peer event data
- * @interface GunPeerEventData
- * @property {string} peer - The peer URL
- * @property {string} action - The action performed (add, remove, connect, disconnect)
- * @property {number} timestamp - Timestamp of the event
- */
-export interface GunPeerEventData {
-    peer: string;
-    action: "add" | "remove" | "connect" | "disconnect";
-    timestamp: number;
-}
-/**
- * Type defining all available Shogun event listeners
- */
-export type ShogunEventMap = {
-    "auth:login": AuthEventData;
-    "auth:logout": void;
-    "auth:signup": AuthEventData;
-    "auth:username_changed": {
-        oldUsername?: string;
-        newUsername?: string;
-        userPub?: string;
-    };
-    "wallet:created": WalletEventData;
-    "gun:put": GunDataEventData;
-    "gun:get": GunDataEventData;
-    "gun:set": GunDataEventData;
-    "gun:remove": GunDataEventData;
-    "gun:peer:add": GunPeerEventData;
-    "gun:peer:remove": GunPeerEventData;
-    "gun:peer:connect": GunPeerEventData;
-    "gun:peer:disconnect": GunPeerEventData;
-    "plugin:registered": {
-        name: string;
-        version?: string;
-        category?: string;
-    };
-    "plugin:unregistered": {
-        name: string;
-    };
-    debug: {
-        action: string;
-        [key: string]: any;
-    };
-    error: ErrorEventData;
-};
-/**
- * Extended EventEmitter class with typed events for Shogun
- * @class ShogunEventEmitter
- * @extends EventEmitter
- */
-export declare class ShogunEventEmitter extends EventEmitter<ShogunEventMap> {
-    /**
-     * Emit a typed Shogun event
-     * @template K - Event key type
-     * @param {K} event - Event name
-     * @param {ShogunEventMap[K]} data - Event data
-     * @returns {boolean} - Returns true if the event had listeners, false otherwise
-     */
-    emit<K extends keyof ShogunEventMap>(event: K, data?: ShogunEventMap[K] extends void ? never : ShogunEventMap[K]): boolean;
-    /**
-     * Register a listener for a typed Shogun event
-     * @template K - Event key type
-     * @param {K} event - Event name
-     * @param {(data: ShogunEventMap[K]) => void} listener - Event listener function
-     */
-    on<K extends keyof ShogunEventMap>(event: K, listener: ShogunEventMap[K] extends void ? () => void : (data: ShogunEventMap[K]) => void): void;
-    /**
-     * Remove a listener for a typed Shogun event
-     * @template K - Event key type
-     * @param {K} event - Event name
-     * @param {(data: ShogunEventMap[K]) => void} listener - Event listener function to remove
-     */
-    off<K extends keyof ShogunEventMap>(event: K, listener: ShogunEventMap[K] extends void ? () => void : (data: ShogunEventMap[K]) => void): void;
-}

package/dist/types/interfaces/plugin.d.ts

@@ -1,162 +0,0 @@
-import { ShogunCore } from "../core";
-import { PluginCategory } from "./shogun";
-/**
- * Interfaccia di base per tutti i plugin di ShogunCore
- */
-export interface ShogunPlugin {
-    /** Nome univoco del plugin */
-    name: string;
-    /** Versione del plugin */
-    version: string;
-    /** Descrizione opzionale del plugin */
-    description?: string;
-    /** Categoria del plugin (opzionale) */
-    _category?: PluginCategory;
-    /**
-     * Metodo opzionale per inizializzare il plugin
-     * @param core Istanza di ShogunCore
-     */
-    initialize(core: ShogunCore): void;
-    /**
-     * Metodo opzionale per distruggere il plugin e liberare risorse
-     */
-    destroy?(): void;
-}
-/**
- * Interfaccia per la gestione dei plugin in ShogunCore
- */
-export interface PluginManager {
-    /**
-     * Registra un nuovo plugin
-     * @param plugin Il plugin da registrare
-     */
-    register(plugin: ShogunPlugin): void;
-    /**
-     * Cancella la registrazione di un plugin
-     * @param pluginName Nome del plugin da cancellare
-     */
-    unregister(pluginName: string): void;
-    /**
-     * Recupera un plugin registrato per nome
-     * @param name Nome del plugin
-     * @returns Il plugin richiesto o undefined se non trovato
-     * @template T Tipo del plugin o dell'interfaccia pubblica del plugin
-     */
-    getPlugin<T = ShogunPlugin>(name: string): T | undefined;
-    /**
-     * Verifica se un plugin è registrato
-     * @param name Nome del plugin da verificare
-     * @returns true se il plugin è registrato, false altrimenti
-     */
-    hasPlugin(name: string): boolean;
-    /**
-     * Ottiene tutti i plugin di una determinata categoria
-     * @param category Categoria di plugin da filtrare
-     * @returns Array di plugin della categoria specificata
-     */
-    getPluginsByCategory(category: PluginCategory): ShogunPlugin[];
-    /**
-     * Ottiene informazioni su tutti i plugin registrati
-     * @returns Array di oggetti con informazioni sui plugin
-     */
-    getPluginsInfo(): Array<{
-        name: string;
-        version: string;
-        category?: PluginCategory;
-        description?: string;
-    }>;
-    /**
-     * Ottiene il numero totale di plugin registrati
-     * @returns Numero di plugin registrati
-     */
-    getPluginCount(): number;
-    /**
-     * Verifica se tutti i plugin sono inizializzati correttamente
-     * @returns Oggetto con stato di inizializzazione per ogni plugin
-     */
-    getPluginsInitializationStatus(): Record<string, {
-        initialized: boolean;
-        error?: string;
-    }>;
-    /**
-     * Valida l'integrità del sistema di plugin
-     * @returns Oggetto con risultati della validazione
-     */
-    validatePluginSystem(): {
-        totalPlugins: number;
-        initializedPlugins: number;
-        failedPlugins: string[];
-        warnings: string[];
-    };
-    /**
-     * Tenta di reinizializzare i plugin falliti
-     * @returns Oggetto con risultati della reinizializzazione
-     */
-    reinitializeFailedPlugins(): {
-        success: string[];
-        failed: Array<{
-            name: string;
-            error: string;
-        }>;
-    };
-    /**
-     * Verifica la compatibilità dei plugin con la versione corrente di ShogunCore
-     * @returns Oggetto con informazioni sulla compatibilità
-     */
-    checkPluginCompatibility(): {
-        compatible: Array<{
-            name: string;
-            version: string;
-        }>;
-        incompatible: Array<{
-            name: string;
-            version: string;
-            reason: string;
-        }>;
-        unknown: Array<{
-            name: string;
-            version: string;
-        }>;
-    };
-    /**
-     * Ottiene informazioni complete di debug sul sistema di plugin
-     * @returns Informazioni complete di debug del sistema di plugin
-     */
-    getPluginSystemDebugInfo(): {
-        shogunCoreVersion: string;
-        totalPlugins: number;
-        plugins: Array<{
-            name: string;
-            version: string;
-            category?: PluginCategory;
-            description?: string;
-            initialized: boolean;
-            error?: string;
-        }>;
-        initializationStatus: Record<string, {
-            initialized: boolean;
-            error?: string;
-        }>;
-        validation: {
-            totalPlugins: number;
-            initializedPlugins: number;
-            failedPlugins: string[];
-            warnings: string[];
-        };
-        compatibility: {
-            compatible: Array<{
-                name: string;
-                version: string;
-            }>;
-            incompatible: Array<{
-                name: string;
-                version: string;
-                reason: string;
-            }>;
-            unknown: Array<{
-                name: string;
-                version: string;
-            }>;
-        };
-    };
-}