@enyo-energy/energy-app-sdk 0.0.37 → 0.0.39

package/dist/implementations/appliances/demo-appliance-manager.d.ts

@@ -0,0 +1,118 @@
+import type { EnergyApp } from "../../index.js";
+import { EnyoAppliance, EnyoApplianceConnectionType, EnyoApplianceMetadata, EnyoApplianceStateEnum, EnyoApplianceTypeEnum } from "../../types/enyo-appliance.js";
+import { ApplianceConfig, ApplianceManager, ApplianceManagerConfig, FindResult } from "./appliance-manager.js";
+import { IdentifierStrategy } from "./identifier-strategies.js";
+/**
+ * Demo implementation of ApplianceManager that stores all data in memory.
+ * This class provides the same interface as ApplianceManager but doesn't
+ * use energyApp.useAppliances() for persistence.
+ */
+export declare class DemoApplianceManager extends ApplianceManager {
+    private memoryStore;
+    private nextId;
+    private networkDevicesStore;
+    /**
+     * Creates a new DemoApplianceManager instance.
+     * @param energyApp The EnergyApp instance (not used for persistence in demo)
+     * @param config Configuration options for the manager
+     */
+    constructor(energyApp: EnergyApp, config?: ApplianceManagerConfig);
+    /**
+     * Creates or updates an appliance in memory.
+     * @param config The appliance configuration
+     * @param existingApplianceId Optional ID of an existing appliance to update
+     * @returns The ID of the created or updated appliance
+     */
+    createOrUpdateAppliance(config: ApplianceConfig, existingApplianceId?: string): Promise<string>;
+    /**
+     * Gets an appliance by ID from memory.
+     * @param applianceId The ID of the appliance
+     * @returns The appliance or null if not found
+     */
+    getApplianceById(applianceId: string): Promise<EnyoAppliance | null>;
+    /**
+     * Gets all appliances from memory.
+     * @returns Array of all appliances
+     */
+    getAllAppliances(): Promise<EnyoAppliance[]>;
+    /**
+     * Gets network devices associated with an appliance.
+     * @param appliance The appliance
+     * @returns Array of network devices
+     */
+    private getNetworkDevicesForAppliance;
+    /**
+     * Finds appliances by their identifier using the configured strategy.
+     * @param identifier The identifier to search for
+     * @returns Array of matching appliances
+     */
+    findByIdentifier(identifier: string): Promise<EnyoAppliance[]>;
+    /**
+     * Finds an appliance using multiple strategies.
+     * @param searchValue The value to search for
+     * @param strategies Array of strategies to try
+     * @returns The first matching result or undefined
+     */
+    findWithStrategies(searchValue: string, strategies: IdentifierStrategy[]): Promise<FindResult | undefined>;
+    /**
+     * Gets all appliances of a specific type.
+     * @param type The appliance type to filter by
+     * @returns Array of appliances of the specified type
+     */
+    getAppliancesByType(type: EnyoApplianceTypeEnum): Promise<EnyoAppliance[]>;
+    /**
+     * Updates the state of an appliance in memory.
+     * @param applianceId The ID of the appliance to update
+     * @param connectionType The new connection type
+     * @param state The new state
+     */
+    updateApplianceState(applianceId: string, connectionType: EnyoApplianceConnectionType, state: EnyoApplianceStateEnum): Promise<void>;
+    /**
+     * Updates metadata for an appliance in memory.
+     * @param applianceId The ID of the appliance
+     * @param metadata The metadata to update
+     */
+    updateApplianceMetadata(applianceId: string, metadata: Partial<EnyoApplianceMetadata> & {
+        connectionType: EnyoApplianceConnectionType;
+    }): Promise<void>;
+    /**
+     * Removes an appliance from memory.
+     * @param applianceId The ID of the appliance to remove
+     */
+    removeAppliance(applianceId: string): Promise<void>;
+    /**
+     * Performs a bulk update on multiple appliances in memory.
+     * @param updates Array of updates to perform
+     * @returns Results of the bulk update operation
+     */
+    bulkUpdate(updates: Array<{
+        applianceId: string;
+        data: Partial<Omit<EnyoAppliance, 'id'>>;
+    }>): Promise<{
+        succeeded: string[];
+        failed: string[];
+    }>;
+    /**
+     * Gets statistics about the managed appliances in memory.
+     * @returns Statistics object
+     */
+    getStatistics(): Promise<{
+        total: number;
+        byType: Record<string, number>;
+        byState: Record<string, number>;
+        cached: number;
+    }>;
+    /**
+     * Refreshes the cache with all appliances from memory.
+     */
+    refreshCache(): Promise<void>;
+    /**
+     * Clears all data from memory (for testing purposes).
+     */
+    clearAllData(): void;
+    /**
+     * Gets the current size of the memory store.
+     * @returns The number of appliances in memory
+     */
+    getMemoryStoreSize(): number;
+}

package/dist/implementations/appliances/demo-appliance-manager.js

@@ -0,0 +1,277 @@
+import { EnyoApplianceConnectionType, EnyoApplianceStateEnum } from "../../types/enyo-appliance.js";
+import { ApplianceManager } from "./appliance-manager.js";
+/**
+ * Demo implementation of ApplianceManager that stores all data in memory.
+ * This class provides the same interface as ApplianceManager but doesn't
+ * use energyApp.useAppliances() for persistence.
+ */
+export class DemoApplianceManager extends ApplianceManager {
+    memoryStore = new Map();
+    nextId = 1;
+    networkDevicesStore = new Map();
+    /**
+     * Creates a new DemoApplianceManager instance.
+     * @param energyApp The EnergyApp instance (not used for persistence in demo)
+     * @param config Configuration options for the manager
+     */
+    constructor(energyApp, config) {
+        super(energyApp, config);
+    }
+    /**
+     * Creates or updates an appliance in memory.
+     * @param config The appliance configuration
+     * @param existingApplianceId Optional ID of an existing appliance to update
+     * @returns The ID of the created or updated appliance
+     */
+    async createOrUpdateAppliance(config, existingApplianceId) {
+        const applianceId = existingApplianceId || `appliance_${this.nextId++}`;
+        // Build network device IDs list
+        const networkDeviceIds = config.networkDevices?.map(d => d.id) ?? [];
+        // Get existing metadata if updating
+        const existingAppliance = existingApplianceId ? this.memoryStore.get(existingApplianceId) : null;
+        // Merge metadata with defaults and existing values
+        const metadata = {
+            connectionType: config.metadata?.connectionType ||
+                existingAppliance?.metadata?.connectionType ||
+                EnyoApplianceConnectionType.Connector,
+            state: config.metadata?.state ||
+                existingAppliance?.metadata?.state ||
+                EnyoApplianceStateEnum.Connected,
+            ...config.metadata
+        };
+        // Build appliance data
+        const applianceData = {
+            id: applianceId,
+            name: config.name,
+            type: config.type,
+            networkDeviceIds,
+            metadata,
+            ...(config.topology && { topology: config.topology })
+        };
+        // Add type-specific metadata
+        if (config.typeMetadata) {
+            Object.assign(applianceData, config.typeMetadata);
+        }
+        // Save to memory store
+        this.memoryStore.set(applianceId, applianceData);
+        // Store network devices if provided
+        if (config.networkDevices) {
+            this.networkDevicesStore.set(applianceId, config.networkDevices);
+        }
+        // Update cache (from parent class)
+        this.updateCache(applianceData, config.networkDevices?.[0]);
+        console.log(`[DEMO] ${existingApplianceId ? 'Updated' : 'Created'} appliance ${applianceId} of type ${config.type}`);
+        return applianceId;
+    }
+    /**
+     * Gets an appliance by ID from memory.
+     * @param applianceId The ID of the appliance
+     * @returns The appliance or null if not found
+     */
+    async getApplianceById(applianceId) {
+        return this.memoryStore.get(applianceId) || null;
+    }
+    /**
+     * Gets all appliances from memory.
+     * @returns Array of all appliances
+     */
+    async getAllAppliances() {
+        return Array.from(this.memoryStore.values());
+    }
+    /**
+     * Gets network devices associated with an appliance.
+     * @param appliance The appliance
+     * @returns Array of network devices
+     */
+    async getNetworkDevicesForAppliance(appliance) {
+        return this.networkDevicesStore.get(appliance.id) || [];
+    }
+    /**
+     * Finds appliances by their identifier using the configured strategy.
+     * @param identifier The identifier to search for
+     * @returns Array of matching appliances
+     */
+    async findByIdentifier(identifier) {
+        const matches = [];
+        const strategy = this.getIdentifierStrategy();
+        for (const appliance of this.memoryStore.values()) {
+            const networkDevices = await this.getNetworkDevicesForAppliance(appliance);
+            const extractedId = strategy.extract(appliance, networkDevices[0]);
+            if (extractedId === identifier) {
+                matches.push(appliance);
+                this.updateCache(appliance, networkDevices[0]);
+            }
+        }
+        return matches;
+    }
+    /**
+     * Finds an appliance using multiple strategies.
+     * @param searchValue The value to search for
+     * @param strategies Array of strategies to try
+     * @returns The first matching result or undefined
+     */
+    async findWithStrategies(searchValue, strategies) {
+        for (const strategy of strategies) {
+            for (const appliance of this.memoryStore.values()) {
+                const networkDevices = await this.getNetworkDevicesForAppliance(appliance);
+                const identifier = strategy.extract(appliance, networkDevices[0]);
+                if (identifier === searchValue) {
+                    return {
+                        appliance,
+                        identifier,
+                        strategy: strategy.name
+                    };
+                }
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Gets all appliances of a specific type.
+     * @param type The appliance type to filter by
+     * @returns Array of appliances of the specified type
+     */
+    async getAppliancesByType(type) {
+        return Array.from(this.memoryStore.values()).filter(a => a.type === type);
+    }
+    /**
+     * Updates the state of an appliance in memory.
+     * @param applianceId The ID of the appliance to update
+     * @param connectionType The new connection type
+     * @param state The new state
+     */
+    async updateApplianceState(applianceId, connectionType, state) {
+        const appliance = this.memoryStore.get(applianceId);
+        if (appliance) {
+            appliance.metadata = {
+                ...appliance.metadata,
+                connectionType,
+                state
+            };
+            this.memoryStore.set(applianceId, appliance);
+            this.updateCache(appliance);
+            console.log(`[DEMO] Updated appliance ${applianceId} state to ${state}`);
+        }
+        else {
+            throw new Error(`Appliance ${applianceId} not found`);
+        }
+    }
+    /**
+     * Updates metadata for an appliance in memory.
+     * @param applianceId The ID of the appliance
+     * @param metadata The metadata to update
+     */
+    async updateApplianceMetadata(applianceId, metadata) {
+        const appliance = this.memoryStore.get(applianceId);
+        if (appliance) {
+            appliance.metadata = {
+                ...appliance.metadata,
+                ...metadata
+            };
+            this.memoryStore.set(applianceId, appliance);
+            this.updateCache(appliance);
+            console.log(`[DEMO] Updated metadata for appliance ${applianceId}`);
+        }
+        else {
+            throw new Error(`Appliance ${applianceId} not found`);
+        }
+    }
+    /**
+     * Removes an appliance from memory.
+     * @param applianceId The ID of the appliance to remove
+     */
+    async removeAppliance(applianceId) {
+        if (this.memoryStore.has(applianceId)) {
+            this.memoryStore.delete(applianceId);
+            this.networkDevicesStore.delete(applianceId);
+            // Clean up cache (from parent class)
+            this.clearCache();
+            console.log(`[DEMO] Removed appliance ${applianceId}`);
+        }
+        else {
+            throw new Error(`Appliance ${applianceId} not found`);
+        }
+    }
+    /**
+     * Performs a bulk update on multiple appliances in memory.
+     * @param updates Array of updates to perform
+     * @returns Results of the bulk update operation
+     */
+    async bulkUpdate(updates) {
+        const succeeded = [];
+        const failed = [];
+        for (const update of updates) {
+            try {
+                const appliance = this.memoryStore.get(update.applianceId);
+                if (appliance) {
+                    const updatedAppliance = {
+                        ...appliance,
+                        ...update.data,
+                        id: appliance.id // Ensure ID is preserved
+                    };
+                    this.memoryStore.set(update.applianceId, updatedAppliance);
+                    this.updateCache(updatedAppliance);
+                    succeeded.push(update.applianceId);
+                }
+                else {
+                    failed.push(update.applianceId);
+                }
+            }
+            catch (error) {
+                console.error(`[DEMO] Bulk update failed for ${update.applianceId}: ${error}`);
+                failed.push(update.applianceId);
+            }
+        }
+        console.log(`[DEMO] Bulk update completed: ${succeeded.length} succeeded, ${failed.length} failed`);
+        return { succeeded, failed };
+    }
+    /**
+     * Gets statistics about the managed appliances in memory.
+     * @returns Statistics object
+     */
+    async getStatistics() {
+        const appliances = Array.from(this.memoryStore.values());
+        const byType = {};
+        const byState = {};
+        for (const appliance of appliances) {
+            // Count by type
+            byType[appliance.type] = (byType[appliance.type] ?? 0) + 1;
+            // Count by state
+            const state = appliance.metadata?.state ?? 'unknown';
+            byState[state] = (byState[state] ?? 0) + 1;
+        }
+        return {
+            total: appliances.length,
+            byType,
+            byState,
+            cached: this.memoryStore.size
+        };
+    }
+    /**
+     * Refreshes the cache with all appliances from memory.
+     */
+    async refreshCache() {
+        this.clearCache();
+        for (const appliance of this.memoryStore.values()) {
+            const networkDevices = await this.getNetworkDevicesForAppliance(appliance);
+            this.updateCache(appliance, networkDevices[0]);
+        }
+    }
+    /**
+     * Clears all data from memory (for testing purposes).
+     */
+    clearAllData() {
+        this.memoryStore.clear();
+        this.networkDevicesStore.clear();
+        this.clearCache();
+        this.nextId = 1;
+        console.log('[DEMO] All data cleared from memory');
+    }
+    /**
+     * Gets the current size of the memory store.
+     * @returns The number of appliances in memory
+     */
+    getMemoryStoreSize() {
+        return this.memoryStore.size;
+    }
+}

package/dist/implementations/appliances/identifier-strategies.d.ts

@@ -0,0 +1,140 @@
+import type { EnyoAppliance } from "../../types/enyo-appliance.js";
+import type { EnyoNetworkDevice } from "../../types/enyo-network-device.js";
+/**
+ * Strategy interface for extracting unique identifiers from appliances.
+ * Allows flexible identification of appliances based on different criteria.
+ */
+export interface IdentifierStrategy {
+    /**
+     * Extract the unique identifier from an appliance or its associated data.
+     * @param appliance The appliance to extract the identifier from
+     * @param networkDevice Optional network device associated with the appliance
+     * @returns The extracted identifier string, or undefined if not available
+     */
+    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+    /**
+     * Name of the strategy for logging and debugging purposes.
+     */
+    name: string;
+}
+/**
+ * Strategy that uses the network device ID as the identifier.
+ * This is the default strategy for most appliances.
+ */
+export declare class NetworkDeviceIdStrategy implements IdentifierStrategy {
+    name: string;
+    /**
+     * Extracts the network device ID.
+     * @param appliance The appliance (not used in this strategy)
+     * @param networkDevice The network device to get the ID from
+     * @returns The network device ID or undefined
+     */
+    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+}
+/**
+ * Strategy that uses the appliance's serial number as the identifier.
+ * Useful when appliances can move between network devices.
+ */
+export declare class SerialNumberStrategy implements IdentifierStrategy {
+    name: string;
+    /**
+     * Extracts the serial number from the appliance metadata.
+     * @param appliance The appliance to extract the serial number from
+     * @returns The serial number or undefined
+     */
+    extract(appliance: Partial<EnyoAppliance>): string | undefined;
+}
+/**
+ * Strategy that uses a custom metadata field as the identifier.
+ * Allows using any field from the appliance metadata.
+ */
+export declare class CustomMetadataStrategy implements IdentifierStrategy {
+    private fieldName;
+    name: string;
+    /**
+     * Creates a strategy that uses a custom metadata field.
+     * @param fieldName The name of the metadata field to use as identifier
+     */
+    constructor(fieldName: keyof NonNullable<EnyoAppliance['metadata']>);
+    /**
+     * Extracts the custom field value from the appliance metadata.
+     * @param appliance The appliance to extract the field from
+     * @returns The field value or undefined
+     */
+    extract(appliance: Partial<EnyoAppliance>): string | undefined;
+}
+/**
+ * Strategy that combines multiple identifiers to create a composite key.
+ * Useful when a single identifier is not unique enough.
+ */
+export declare class CompositeIdentifierStrategy implements IdentifierStrategy {
+    private strategies;
+    private separator;
+    name: string;
+    /**
+     * Creates a strategy that combines multiple strategies.
+     * @param strategies The strategies to combine
+     * @param separator The separator to use between identifier parts
+     */
+    constructor(strategies: IdentifierStrategy[], separator?: string);
+    /**
+     * Extracts and combines identifiers from multiple strategies.
+     * @param appliance The appliance to extract identifiers from
+     * @param networkDevice The network device if available
+     * @returns The combined identifier or undefined if any part is missing
+     */
+    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+}
+/**
+ * Strategy that tries multiple strategies in order and uses the first available identifier.
+ * Useful for fallback scenarios.
+ */
+export declare class FallbackIdentifierStrategy implements IdentifierStrategy {
+    private strategies;
+    name: string;
+    /**
+     * Creates a strategy that tries multiple strategies in order.
+     * @param strategies The strategies to try in order
+     */
+    constructor(strategies: IdentifierStrategy[]);
+    /**
+     * Tries strategies in order and returns the first available identifier.
+     * @param appliance The appliance to extract identifiers from
+     * @param networkDevice The network device if available
+     * @returns The first available identifier or undefined
+     */
+    extract(appliance: Partial<EnyoAppliance>, networkDevice?: EnyoNetworkDevice): string | undefined;
+}
+/**
+ * Factory class for creating common identifier strategies.
+ */
+export declare class IdentifierStrategyFactory {
+    /**
+     * Creates the default network device ID strategy.
+     */
+    static networkDeviceId(): NetworkDeviceIdStrategy;
+    /**
+     * Creates a serial number strategy.
+     */
+    static serialNumber(): SerialNumberStrategy;
+    /**
+     * Creates a custom metadata field strategy.
+     * @param fieldName The metadata field to use
+     */
+    static customMetadata(fieldName: keyof NonNullable<EnyoAppliance['metadata']>): CustomMetadataStrategy;
+    /**
+     * Creates a composite strategy that combines multiple identifiers.
+     * @param strategies The strategies to combine
+     * @param separator The separator between parts
+     */
+    static composite(strategies: IdentifierStrategy[], separator?: string): CompositeIdentifierStrategy;
+    /**
+     * Creates a fallback strategy that tries multiple strategies in order.
+     * @param strategies The strategies to try
+     */
+    static fallback(strategies: IdentifierStrategy[]): FallbackIdentifierStrategy;
+    /**
+     * Creates a strategy that prefers serial number but falls back to network device ID.
+     */
+    static serialNumberOrDeviceId(): FallbackIdentifierStrategy;
+}