@apocaliss92/nodedreame 1.2.0 → 1.3.0

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { fetch } from 'undici';
+import { z } from 'zod';
 
 /** Public name of this library. */
 declare const LIBRARY_NAME = "nodedreame";
@@ -1794,4 +1795,339 @@ declare class MowerDevice extends BaseDevice {
     }];
 }
 
-export { BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceEvent, DreameApiError, DreameAuthError, type DreameCloudState, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, getMowerCapabilities, getVacuumCapabilities, renderMowerSvg, renderVacuumPng, resolveCapabilities };
+declare const DeviceDumpSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    library: z.ZodUnion<[z.ZodLiteral<"nodedreame">, z.ZodLiteral<"nodewitt">]>;
+    libraryVersion: z.ZodString;
+    device: z.ZodObject<{
+        model: z.ZodString;
+        firmware: z.ZodOptional<z.ZodString>;
+        region: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    }, {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    }>;
+    observations: z.ZodObject<{
+        properties: z.ZodRecord<z.ZodString, z.ZodObject<{
+            values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">;
+            unmapped: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">;
+            enum: z.ZodOptional<z.ZodString>;
+            count: z.ZodNumber;
+            firstSeen: z.ZodNumber;
+            lastSeen: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>>;
+        events: z.ZodArray<z.ZodObject<{
+            at: z.ZodNumber;
+            type: z.ZodString;
+            data: z.ZodOptional<z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            at: number;
+            type: string;
+            data?: unknown;
+        }, {
+            at: number;
+            type: string;
+            data?: unknown;
+        }>, "many">;
+        rawFrames: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            at: z.ZodNumber;
+            source: z.ZodString;
+            payload: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }, {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    }, {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    }>;
+    catalog: z.ZodObject<{
+        commands: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            siid: z.ZodOptional<z.ZodNumber>;
+            aiid: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }, {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }>, "many">>;
+        capabilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        sensors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            model: z.ZodString;
+            channel: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            model: string;
+            channel?: number | undefined;
+        }, {
+            model: string;
+            channel?: number | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    }, {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    }>;
+    meta: z.ZodObject<{
+        startedAt: z.ZodNumber;
+        durationMs: z.ZodNumber;
+        generatedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    }, {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    schemaVersion: 1;
+    library: "nodedreame" | "nodewitt";
+    libraryVersion: string;
+    device: {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    };
+    observations: {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    };
+    catalog: {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    };
+    meta: {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    };
+}, {
+    schemaVersion: 1;
+    library: "nodedreame" | "nodewitt";
+    libraryVersion: string;
+    device: {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    };
+    observations: {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    };
+    catalog: {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    };
+    meta: {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    };
+}>;
+/** Public shared dump type — inferred from the schema so the two never drift. */
+type DeviceDump = z.infer<typeof DeviceDumpSchema>;
+
+/** A property decoder: the enum NAME + a membership test for a raw number. */
+interface KeyDecoder {
+    enumName: string;
+    isMember(raw: number): boolean;
+}
+/** Tunables for a {@link Dumper}. All optional. */
+interface DumperOptions {
+    /** Capture raw event/property frames into `observations.rawFrames`. Default false. */
+    captureRawFrames?: boolean;
+    /** Cap on retained raw frames (ring). Default 500. */
+    maxRawFrames?: number;
+    /** Periodic cloud-shadow refresh interval (ms). Default 30000; 0 disables. */
+    refreshIntervalMs?: number;
+}
+/**
+ * The READ-ONLY slice of a device the {@link Dumper} consumes. Declaring it as
+ * an interface lets tests inject a fake with no cast (mirrors `PushLike`). A real
+ * `BaseDevice`/`VacuumDevice`/`MowerDevice` structurally satisfies it. NOTE it
+ * exposes NO action/command method — the dumper literally cannot execute one.
+ */
+interface DumperDevice {
+    readonly model: string;
+    readonly deviceId: string;
+    readonly capabilities: {
+        list(): readonly string[];
+        has(t: string): boolean;
+        model: string;
+    };
+    on(event: 'propertyChanged', cb: (e: PropertyChangedEvent) => void): this;
+    on(event: 'event', cb: (e: DeviceEvent) => void): this;
+    off(event: 'propertyChanged', cb: (e: PropertyChangedEvent) => void): this;
+    off(event: 'event', cb: (e: DeviceEvent) => void): this;
+    /** Cloud-shadow read; absent on a bare BaseDevice. Feature-detected. */
+    refreshFromCache?(): Promise<void>;
+}
+/**
+ * A passive, READ-ONLY observer that records what a Dreame device exposes while
+ * it operates. {@link start} hooks the device's `propertyChanged`/`event` stream,
+ * does an initial + periodic cloud-shadow {@link DumperDevice.refreshFromCache}
+ * read (feature-detected), and snapshots the static catalog at construction.
+ * {@link stop} detaches every listener + clears the timer (idempotent, no leaks).
+ * {@link export} assembles the ANONYMIZED, zod-valid {@link DeviceDump}. The
+ * dumper NEVER executes a device command/action.
+ */
+declare class Dumper {
+    #private;
+    constructor(device: DumperDevice, catalog: DeviceDump['catalog'], type: string, decoders: Record<string, KeyDecoder>, options?: DumperOptions);
+    /** Attach to the live stream + arm the periodic shadow refresh. Idempotent. */
+    start(): Promise<void>;
+    /** Detach every listener + clear the timer. Idempotent. */
+    stop(): Promise<void>;
+    /** Build the anonymized, schema-valid dump. Works live or after {@link stop}. */
+    export(): DeviceDump;
+    /** Deterministic pretty JSON of {@link export}. */
+    exportJson(): string;
+}
+/**
+ * Create a read-only {@link Dumper} for one device. The family-correct decoder
+ * table + catalog + `device.type` are chosen via cast-free `instanceof` checks;
+ * an unknown family records values with no enum/unmapped detection.
+ */
+declare function createDumper(target: DumperDevice, options?: DumperOptions): Dumper;
+/**
+ * Fan-out: one {@link Dumper} per discovered device on a {@link Nodreame} client
+ * (read-only). Each `BaseDevice` structurally satisfies {@link DumperDevice}.
+ */
+declare function createClientDumper(client: Nodreame, options?: DumperOptions): Dumper[];
+
+export { BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceDump, type DeviceEvent, DreameApiError, DreameAuthError, type DreameCloudState, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, type DumperOptions, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, createClientDumper, createDumper, getMowerCapabilities, getVacuumCapabilities, renderMowerSvg, renderVacuumPng, resolveCapabilities };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { fetch } from 'undici';
+import { z } from 'zod';
 
 /** Public name of this library. */
 declare const LIBRARY_NAME = "nodedreame";
@@ -1794,4 +1795,339 @@ declare class MowerDevice extends BaseDevice {
     }];
 }
 
-export { BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceEvent, DreameApiError, DreameAuthError, type DreameCloudState, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, getMowerCapabilities, getVacuumCapabilities, renderMowerSvg, renderVacuumPng, resolveCapabilities };
+declare const DeviceDumpSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    library: z.ZodUnion<[z.ZodLiteral<"nodedreame">, z.ZodLiteral<"nodewitt">]>;
+    libraryVersion: z.ZodString;
+    device: z.ZodObject<{
+        model: z.ZodString;
+        firmware: z.ZodOptional<z.ZodString>;
+        region: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    }, {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    }>;
+    observations: z.ZodObject<{
+        properties: z.ZodRecord<z.ZodString, z.ZodObject<{
+            values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">;
+            unmapped: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">;
+            enum: z.ZodOptional<z.ZodString>;
+            count: z.ZodNumber;
+            firstSeen: z.ZodNumber;
+            lastSeen: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>>;
+        events: z.ZodArray<z.ZodObject<{
+            at: z.ZodNumber;
+            type: z.ZodString;
+            data: z.ZodOptional<z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            at: number;
+            type: string;
+            data?: unknown;
+        }, {
+            at: number;
+            type: string;
+            data?: unknown;
+        }>, "many">;
+        rawFrames: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            at: z.ZodNumber;
+            source: z.ZodString;
+            payload: z.ZodUnknown;
+        }, "strip", z.ZodTypeAny, {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }, {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    }, {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    }>;
+    catalog: z.ZodObject<{
+        commands: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            siid: z.ZodOptional<z.ZodNumber>;
+            aiid: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }, {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }>, "many">>;
+        capabilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        sensors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            model: z.ZodString;
+            channel: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            model: string;
+            channel?: number | undefined;
+        }, {
+            model: string;
+            channel?: number | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    }, {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    }>;
+    meta: z.ZodObject<{
+        startedAt: z.ZodNumber;
+        durationMs: z.ZodNumber;
+        generatedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    }, {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    schemaVersion: 1;
+    library: "nodedreame" | "nodewitt";
+    libraryVersion: string;
+    device: {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    };
+    observations: {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    };
+    catalog: {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    };
+    meta: {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    };
+}, {
+    schemaVersion: 1;
+    library: "nodedreame" | "nodewitt";
+    libraryVersion: string;
+    device: {
+        model: string;
+        type?: string | undefined;
+        region?: string | undefined;
+        firmware?: string | undefined;
+    };
+    observations: {
+        properties: Record<string, {
+            values: (string | number | boolean)[];
+            unmapped: (string | number | boolean)[];
+            count: number;
+            firstSeen: number;
+            lastSeen: number;
+            enum?: string | undefined;
+        }>;
+        events: {
+            at: number;
+            type: string;
+            data?: unknown;
+        }[];
+        rawFrames?: {
+            at: number;
+            source: string;
+            payload?: unknown;
+        }[] | undefined;
+    };
+    catalog: {
+        commands?: {
+            name: string;
+            siid?: number | undefined;
+            aiid?: number | undefined;
+        }[] | undefined;
+        capabilities?: Record<string, unknown> | undefined;
+        sensors?: {
+            model: string;
+            channel?: number | undefined;
+        }[] | undefined;
+    };
+    meta: {
+        startedAt: number;
+        durationMs: number;
+        generatedAt: number;
+    };
+}>;
+/** Public shared dump type — inferred from the schema so the two never drift. */
+type DeviceDump = z.infer<typeof DeviceDumpSchema>;
+
+/** A property decoder: the enum NAME + a membership test for a raw number. */
+interface KeyDecoder {
+    enumName: string;
+    isMember(raw: number): boolean;
+}
+/** Tunables for a {@link Dumper}. All optional. */
+interface DumperOptions {
+    /** Capture raw event/property frames into `observations.rawFrames`. Default false. */
+    captureRawFrames?: boolean;
+    /** Cap on retained raw frames (ring). Default 500. */
+    maxRawFrames?: number;
+    /** Periodic cloud-shadow refresh interval (ms). Default 30000; 0 disables. */
+    refreshIntervalMs?: number;
+}
+/**
+ * The READ-ONLY slice of a device the {@link Dumper} consumes. Declaring it as
+ * an interface lets tests inject a fake with no cast (mirrors `PushLike`). A real
+ * `BaseDevice`/`VacuumDevice`/`MowerDevice` structurally satisfies it. NOTE it
+ * exposes NO action/command method — the dumper literally cannot execute one.
+ */
+interface DumperDevice {
+    readonly model: string;
+    readonly deviceId: string;
+    readonly capabilities: {
+        list(): readonly string[];
+        has(t: string): boolean;
+        model: string;
+    };
+    on(event: 'propertyChanged', cb: (e: PropertyChangedEvent) => void): this;
+    on(event: 'event', cb: (e: DeviceEvent) => void): this;
+    off(event: 'propertyChanged', cb: (e: PropertyChangedEvent) => void): this;
+    off(event: 'event', cb: (e: DeviceEvent) => void): this;
+    /** Cloud-shadow read; absent on a bare BaseDevice. Feature-detected. */
+    refreshFromCache?(): Promise<void>;
+}
+/**
+ * A passive, READ-ONLY observer that records what a Dreame device exposes while
+ * it operates. {@link start} hooks the device's `propertyChanged`/`event` stream,
+ * does an initial + periodic cloud-shadow {@link DumperDevice.refreshFromCache}
+ * read (feature-detected), and snapshots the static catalog at construction.
+ * {@link stop} detaches every listener + clears the timer (idempotent, no leaks).
+ * {@link export} assembles the ANONYMIZED, zod-valid {@link DeviceDump}. The
+ * dumper NEVER executes a device command/action.
+ */
+declare class Dumper {
+    #private;
+    constructor(device: DumperDevice, catalog: DeviceDump['catalog'], type: string, decoders: Record<string, KeyDecoder>, options?: DumperOptions);
+    /** Attach to the live stream + arm the periodic shadow refresh. Idempotent. */
+    start(): Promise<void>;
+    /** Detach every listener + clear the timer. Idempotent. */
+    stop(): Promise<void>;
+    /** Build the anonymized, schema-valid dump. Works live or after {@link stop}. */
+    export(): DeviceDump;
+    /** Deterministic pretty JSON of {@link export}. */
+    exportJson(): string;
+}
+/**
+ * Create a read-only {@link Dumper} for one device. The family-correct decoder
+ * table + catalog + `device.type` are chosen via cast-free `instanceof` checks;
+ * an unknown family records values with no enum/unmapped detection.
+ */
+declare function createDumper(target: DumperDevice, options?: DumperOptions): Dumper;
+/**
+ * Fan-out: one {@link Dumper} per discovered device on a {@link Nodreame} client
+ * (read-only). Each `BaseDevice` structurally satisfies {@link DumperDevice}.
+ */
+declare function createClientDumper(client: Nodreame, options?: DumperOptions): Dumper[];
+
+export { BaseDevice, type BaseDeviceEvents, type BatchDeviceDataFetcher, type CapabilityResolver, ChargingStatus, type CleanOpts, CleaningMode, type CreateDeviceArgs, DefaultCapabilityResolver, type DeviceCapabilities, type DeviceDump, type DeviceEvent, DreameApiError, DreameAuthError, type DreameCloudState, type DreameDevice, DreameDeviceOfflineError, DreameError, type DreameRegion, type DreameSession, DreameTransportError, type DumperOptions, LIBRARY_NAME, MODEL_CAPABILITIES as MOWER_MODEL_CAPABILITIES, type MapBoundingBox, type MapCleanedAreaOverlay, type MapDimensions, type MapFrameType, type MapLayer, type MapLayerType, type MapLowLyingArea, type MapObstacle, type MapPath, type MapPathType, type MapPoint, type MapPose, type MapRestrictedArea, type MapRoom, type MapRoomWall, type MapRun, type MapSegment, type MapStorey, type MapVirtualWall, type MapWallsInfo, type MiotAction, MiotError, type MiotProp, MiotState, type MowerAvailableMap, type MowerCapabilities, MowerCapabilityResolver, MowerChargingStatus, type MowerContour, MowerControlAction, type MowerControlState, MowerDevice, type MowerDeviceInput, MowerFault, type MowerMap, type MowerMapBoundary, type MowerMowPath, type MowerPathEntry, type MowerPoint, type MowerSpotArea, MowerStatus, type MowerTaskDescriptor, MowerTaskStatus, type MowerZone, Nodreame, type NodreameDeps, type NodreameEvents, type NodreameOptions, type OssFetchInput, type OssFetcherLike, type PropertyChangedEvent, type PropertyResult, type PropertyState, type PropertyWrite, type RenderMowerSvgOptions, type RenderVacuumPngOptions, type StateChangedEvent, SuctionLevel, TaskStatus, MODEL_CAPABILITIES$1 as VACUUM_MODEL_CAPABILITIES, type VacuumCapabilities, VacuumCapabilityResolver, VacuumDevice, type VacuumGetMapInput, type VacuumMap, WaterVolume, createClientDumper, createDumper, getMowerCapabilities, getVacuumCapabilities, renderMowerSvg, renderVacuumPng, resolveCapabilities };