@capgo/capacitor-device-info 8.0.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,612 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+/**
+ * CPU snapshot for the current device.
+ *
+ * All frequency values are reported in hertz. `usagePercent` is `null` when a
+ * platform needs at least two samples to calculate CPU usage.
+ *
+ * @since 8.0.0
+ */
+export interface CpuInfo {
+    /**
+     * Total logical CPU cores visible to the app.
+     *
+     * @since 8.0.0
+     */
+    cores: number;
+    /**
+     * Logical CPU cores currently active, when the platform exposes it.
+     *
+     * @since 8.0.0
+     */
+    activeCores?: number;
+    /**
+     * CPU architecture, for example `arm64` or `x86_64`.
+     *
+     * @since 8.0.0
+     */
+    architecture?: string;
+    /**
+     * CPU or SoC model identifier when available.
+     *
+     * @since 8.0.0
+     */
+    model?: string;
+    /**
+     * System CPU usage from 0 to 100.
+     *
+     * @since 8.0.0
+     */
+    usagePercent?: number | null;
+    /**
+     * Highest CPU frequency exposed by the platform.
+     *
+     * @since 8.0.0
+     */
+    maxFrequencyHz?: number;
+    /**
+     * CPU temperature in Celsius when the platform exposes an onboard thermal sensor.
+     *
+     * Android reads this as a best-effort value from device thermal zones. iOS does
+     * not expose raw CPU temperature through public APIs.
+     *
+     * @since 8.0.0
+     */
+    temperatureCelsius?: number;
+}
+/**
+ * Memory snapshot for the current device and app process.
+ *
+ * All size values are reported in bytes.
+ *
+ * @since 8.0.0
+ */
+export interface MemoryInfo {
+    /**
+     * Total physical memory on the device.
+     *
+     * @since 8.0.0
+     */
+    totalBytes?: number;
+    /**
+     * Memory available to the system.
+     *
+     * @since 8.0.0
+     */
+    freeBytes?: number;
+    /**
+     * Memory currently used by the system.
+     *
+     * @since 8.0.0
+     */
+    usedBytes?: number;
+    /**
+     * Memory usage from 0 to 100.
+     *
+     * @since 8.0.0
+     */
+    usedPercent?: number;
+    /**
+     * Memory used by the current app process.
+     *
+     * @since 8.0.0
+     */
+    appUsedBytes?: number;
+    /**
+     * Heap limit visible to the current app process.
+     *
+     * @since 8.0.0
+     */
+    appLimitBytes?: number;
+    /**
+     * Whether the OS currently reports low-memory pressure.
+     *
+     * @since 8.0.0
+     */
+    lowMemory?: boolean;
+    /**
+     * Platform memory pressure label.
+     *
+     * @since 8.0.0
+     */
+    pressure?: 'normal' | 'warning' | 'critical' | 'unknown';
+}
+/**
+ * Storage snapshot for the app data volume.
+ *
+ * All size values are reported in bytes.
+ *
+ * @since 8.0.0
+ */
+export interface StorageInfo {
+    /**
+     * Total bytes on the app data volume.
+     *
+     * @since 8.0.0
+     */
+    totalBytes?: number;
+    /**
+     * Free bytes on the app data volume.
+     *
+     * @since 8.0.0
+     */
+    freeBytes?: number;
+    /**
+     * Used bytes on the app data volume.
+     *
+     * @since 8.0.0
+     */
+    usedBytes?: number;
+    /**
+     * Storage usage from 0 to 100.
+     *
+     * @since 8.0.0
+     */
+    usedPercent?: number;
+}
+/**
+ * GPU snapshot for the primary graphics device.
+ *
+ * @since 8.0.0
+ */
+export interface GpuInfo {
+    /**
+     * Graphics API used to query the GPU.
+     *
+     * @since 8.0.0
+     */
+    api?: 'metal' | 'opengl' | 'webgl' | 'unknown';
+    /**
+     * GPU vendor when available.
+     *
+     * @since 8.0.0
+     */
+    vendor?: string;
+    /**
+     * GPU renderer or model name when available.
+     *
+     * @since 8.0.0
+     */
+    renderer?: string;
+    /**
+     * Graphics API version string when available.
+     *
+     * @since 8.0.0
+     */
+    version?: string;
+    /**
+     * Maximum texture size reported by the graphics API.
+     *
+     * @since 8.0.0
+     */
+    maxTextureSize?: number;
+    /**
+     * GPU temperature in Celsius when the platform exposes an onboard thermal sensor.
+     *
+     * Android reads this as a best-effort value from device thermal zones. iOS does
+     * not expose raw GPU temperature through public APIs.
+     *
+     * @since 8.0.0
+     */
+    temperatureCelsius?: number;
+}
+/**
+ * Thermal state reported by the platform.
+ *
+ * @since 8.0.0
+ */
+export type ThermalState = 'nominal' | 'fair' | 'serious' | 'critical' | 'unknown';
+/**
+ * Description of an onboard hardware sensor exposed by the platform.
+ *
+ * @since 8.0.0
+ */
+export interface OnboardSensorDescriptor {
+    /**
+     * Stable sensor type label, for example `pressure`, `ambientTemperature`, or `accelerometer`.
+     *
+     * @since 8.0.0
+     */
+    type: string;
+    /**
+     * Platform sensor name when available.
+     *
+     * @since 8.0.0
+     */
+    name?: string;
+    /**
+     * Sensor vendor when available.
+     *
+     * @since 8.0.0
+     */
+    vendor?: string;
+    /**
+     * Android sensor type id when available.
+     *
+     * @since 8.0.0
+     */
+    platformType?: number;
+    /**
+     * Maximum sensor range when available.
+     *
+     * @since 8.0.0
+     */
+    maximumRange?: number;
+    /**
+     * Sensor resolution when available.
+     *
+     * @since 8.0.0
+     */
+    resolution?: number;
+    /**
+     * Sensor power draw in milliamps when available.
+     *
+     * @since 8.0.0
+     */
+    powerMilliamp?: number;
+    /**
+     * Minimum sensor delay in microseconds when available.
+     *
+     * @since 8.0.0
+     */
+    minDelayMicroseconds?: number;
+    /**
+     * Whether this is a wake-up sensor when available.
+     *
+     * @since 8.0.0
+     */
+    wakeUp?: boolean;
+}
+/**
+ * Instant onboard sensor reading.
+ *
+ * @since 8.0.0
+ */
+export interface OnboardSensorReading {
+    /**
+     * Stable sensor type label.
+     *
+     * @since 8.0.0
+     */
+    type: string;
+    /**
+     * Human-readable unit, for example `celsius`, `percent`, `hPa`, `lux`, or `cm`.
+     *
+     * @since 8.0.0
+     */
+    unit: string;
+    /**
+     * Sensor value.
+     *
+     * @since 8.0.0
+     */
+    value: number;
+    /**
+     * Platform sensor name when available.
+     *
+     * @since 8.0.0
+     */
+    name?: string;
+    /**
+     * Reading timestamp as Unix epoch milliseconds.
+     *
+     * @since 8.0.0
+     */
+    timestamp?: number;
+}
+/**
+ * Onboard sensors snapshot.
+ *
+ * This only reports hardware sensors exposed by the device or operating system.
+ * It does not fetch weather data or any external temperature/humidity source.
+ *
+ * @since 8.0.0
+ */
+export interface OnboardSensorsInfo {
+    /**
+     * Sensors available to the app.
+     *
+     * @since 8.0.0
+     */
+    availableSensors?: OnboardSensorDescriptor[];
+    /**
+     * Instant sensor readings captured for common environmental sensors.
+     *
+     * @since 8.0.0
+     */
+    readings?: OnboardSensorReading[];
+    /**
+     * Battery temperature in Celsius when available.
+     *
+     * @since 8.0.0
+     */
+    batteryTemperatureCelsius?: number;
+    /**
+     * Ambient air temperature from an onboard sensor in Celsius when available.
+     *
+     * @since 8.0.0
+     */
+    ambientTemperatureCelsius?: number;
+    /**
+     * Relative humidity from an onboard sensor as a percentage when available.
+     *
+     * @since 8.0.0
+     */
+    relativeHumidityPercent?: number;
+    /**
+     * Atmospheric pressure from an onboard barometer in hectopascals when available.
+     *
+     * @since 8.0.0
+     */
+    pressureHpa?: number;
+    /**
+     * Ambient light from an onboard light sensor in lux when available.
+     *
+     * @since 8.0.0
+     */
+    illuminanceLux?: number;
+    /**
+     * Proximity distance from an onboard proximity sensor in centimeters when available.
+     *
+     * @since 8.0.0
+     */
+    proximityDistanceCm?: number;
+}
+/**
+ * Instant device snapshot returned by {@link DeviceInfoPlugin.getInfo}.
+ *
+ * @since 8.0.0
+ */
+export interface DeviceInfoSnapshot {
+    /**
+     * Snapshot timestamp as Unix epoch milliseconds.
+     *
+     * @since 8.0.0
+     */
+    timestamp: number;
+    /**
+     * Platform implementation that produced the snapshot.
+     *
+     * @since 8.0.0
+     */
+    platform: 'ios' | 'android' | 'web';
+    /**
+     * CPU information and usage.
+     *
+     * @since 8.0.0
+     */
+    cpu: CpuInfo;
+    /**
+     * Memory information and usage.
+     *
+     * @since 8.0.0
+     */
+    memory: MemoryInfo;
+    /**
+     * Storage information and usage.
+     *
+     * @since 8.0.0
+     */
+    storage: StorageInfo;
+    /**
+     * GPU information when the platform exposes it.
+     *
+     * @since 8.0.0
+     */
+    gpu?: GpuInfo;
+    /**
+     * Thermal state when the platform exposes it.
+     *
+     * @since 8.0.0
+     */
+    thermalState?: ThermalState;
+    /**
+     * Low-power mode state when the platform exposes it.
+     *
+     * @since 8.0.0
+     */
+    lowPowerMode?: boolean;
+    /**
+     * Onboard sensor availability and readings.
+     *
+     * @since 8.0.0
+     */
+    sensors?: OnboardSensorsInfo;
+}
+/**
+ * Options used to start periodic device snapshots.
+ *
+ * @since 8.0.0
+ */
+export interface MonitoringOptions {
+    /**
+     * Time between samples in milliseconds.
+     *
+     * Values below 250ms are clamped to 250ms to avoid excessive native work.
+     * Defaults to 1000ms.
+     *
+     * @since 8.0.0
+     */
+    intervalMs?: number;
+    /**
+     * Stop automatically after this duration in milliseconds.
+     *
+     * @since 8.0.0
+     */
+    durationMs?: number;
+    /**
+     * Stop automatically after this number of emitted samples.
+     *
+     * @since 8.0.0
+     */
+    sampleCount?: number;
+    /**
+     * Emit one sample immediately when monitoring starts.
+     *
+     * Defaults to `true`.
+     *
+     * @since 8.0.0
+     */
+    emitImmediately?: boolean;
+}
+/**
+ * Result returned when monitoring starts.
+ *
+ * @since 8.0.0
+ */
+export interface StartMonitoringResult {
+    /**
+     * Whether monitoring is active.
+     *
+     * @since 8.0.0
+     */
+    monitoring: boolean;
+    /**
+     * Effective interval in milliseconds.
+     *
+     * @since 8.0.0
+     */
+    intervalMs: number;
+    /**
+     * Monitoring start timestamp as Unix epoch milliseconds.
+     *
+     * @since 8.0.0
+     */
+    startedAt: number;
+}
+/**
+ * Result returned by {@link DeviceInfoPlugin.stopMonitoring}.
+ *
+ * @since 8.0.0
+ */
+export interface StopMonitoringResult {
+    /**
+     * Whether monitoring remains active after the stop request.
+     *
+     * @since 8.0.0
+     */
+    monitoring: boolean;
+}
+/**
+ * Current monitoring state.
+ *
+ * @since 8.0.0
+ */
+export interface MonitoringState {
+    /**
+     * Whether monitoring is active.
+     *
+     * @since 8.0.0
+     */
+    monitoring: boolean;
+    /**
+     * Effective interval in milliseconds when monitoring is active.
+     *
+     * @since 8.0.0
+     */
+    intervalMs?: number;
+    /**
+     * Monitoring start timestamp as Unix epoch milliseconds.
+     *
+     * @since 8.0.0
+     */
+    startedAt?: number;
+    /**
+     * Number of samples emitted by the active monitoring session.
+     *
+     * @since 8.0.0
+     */
+    samplesEmitted?: number;
+}
+/**
+ * Periodic event payload emitted while monitoring is active.
+ *
+ * @since 8.0.0
+ */
+export interface DeviceInfoUpdate extends DeviceInfoSnapshot {
+    /**
+     * One-based sample sequence for the active monitoring session.
+     *
+     * @since 8.0.0
+     */
+    sequence: number;
+    /**
+     * Monitoring start timestamp as Unix epoch milliseconds.
+     *
+     * @since 8.0.0
+     */
+    startedAt: number;
+    /**
+     * Elapsed milliseconds since monitoring started.
+     *
+     * @since 8.0.0
+     */
+    elapsedMs: number;
+}
+/**
+ * Plugin version payload.
+ *
+ * @since 8.0.0
+ */
+export interface PluginVersionResult {
+    /**
+     * Version identifier returned by the platform implementation.
+     *
+     * @since 8.0.0
+     */
+    version: string;
+}
+/**
+ * Capacitor plugin contract for reading device CPU, memory, GPU, storage, and onboard sensor metrics.
+ *
+ * @since 8.0.0
+ */
+export interface DeviceInfoPlugin {
+    /**
+     * Read one CPU, memory, GPU, storage, thermal, and onboard sensor snapshot.
+     *
+     * @since 8.0.0
+     */
+    getInfo(): Promise<DeviceInfoSnapshot>;
+    /**
+     * Start periodic device snapshots.
+     *
+     * Listen to `deviceInfoUpdate` to receive samples. Calling this while monitoring
+     * is already active restarts monitoring with the new options.
+     *
+     * @since 8.0.0
+     */
+    startMonitoring(options?: MonitoringOptions): Promise<StartMonitoringResult>;
+    /**
+     * Stop periodic device snapshots.
+     *
+     * @since 8.0.0
+     */
+    stopMonitoring(): Promise<StopMonitoringResult>;
+    /**
+     * Return current periodic monitoring state.
+     *
+     * @since 8.0.0
+     */
+    isMonitoring(): Promise<MonitoringState>;
+    /**
+     * Listen for periodic device snapshots.
+     *
+     * @param eventName Only the `deviceInfoUpdate` event is supported.
+     * @param listenerFunc Callback invoked with each snapshot.
+     * @since 8.0.0
+     */
+    addListener(eventName: 'deviceInfoUpdate', listenerFunc: (event: DeviceInfoUpdate) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners that have been registered on the plugin.
+     *
+     * @since 8.0.0
+     */
+    removeAllListeners(): Promise<void>;
+    /**
+     * Get the native Capacitor plugin version.
+     *
+     * @since 8.0.0
+     */
+    getPluginVersion(): Promise<PluginVersionResult>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * CPU snapshot for the current device.\n *\n * All frequency values are reported in hertz. `usagePercent` is `null` when a\n * platform needs at least two samples to calculate CPU usage.\n *\n * @since 8.0.0\n */\nexport interface CpuInfo {\n  /**\n   * Total logical CPU cores visible to the app.\n   *\n   * @since 8.0.0\n   */\n  cores: number;\n\n  /**\n   * Logical CPU cores currently active, when the platform exposes it.\n   *\n   * @since 8.0.0\n   */\n  activeCores?: number;\n\n  /**\n   * CPU architecture, for example `arm64` or `x86_64`.\n   *\n   * @since 8.0.0\n   */\n  architecture?: string;\n\n  /**\n   * CPU or SoC model identifier when available.\n   *\n   * @since 8.0.0\n   */\n  model?: string;\n\n  /**\n   * System CPU usage from 0 to 100.\n   *\n   * @since 8.0.0\n   */\n  usagePercent?: number | null;\n\n  /**\n   * Highest CPU frequency exposed by the platform.\n   *\n   * @since 8.0.0\n   */\n  maxFrequencyHz?: number;\n\n  /**\n   * CPU temperature in Celsius when the platform exposes an onboard thermal sensor.\n   *\n   * Android reads this as a best-effort value from device thermal zones. iOS does\n   * not expose raw CPU temperature through public APIs.\n   *\n   * @since 8.0.0\n   */\n  temperatureCelsius?: number;\n}\n\n/**\n * Memory snapshot for the current device and app process.\n *\n * All size values are reported in bytes.\n *\n * @since 8.0.0\n */\nexport interface MemoryInfo {\n  /**\n   * Total physical memory on the device.\n   *\n   * @since 8.0.0\n   */\n  totalBytes?: number;\n\n  /**\n   * Memory available to the system.\n   *\n   * @since 8.0.0\n   */\n  freeBytes?: number;\n\n  /**\n   * Memory currently used by the system.\n   *\n   * @since 8.0.0\n   */\n  usedBytes?: number;\n\n  /**\n   * Memory usage from 0 to 100.\n   *\n   * @since 8.0.0\n   */\n  usedPercent?: number;\n\n  /**\n   * Memory used by the current app process.\n   *\n   * @since 8.0.0\n   */\n  appUsedBytes?: number;\n\n  /**\n   * Heap limit visible to the current app process.\n   *\n   * @since 8.0.0\n   */\n  appLimitBytes?: number;\n\n  /**\n   * Whether the OS currently reports low-memory pressure.\n   *\n   * @since 8.0.0\n   */\n  lowMemory?: boolean;\n\n  /**\n   * Platform memory pressure label.\n   *\n   * @since 8.0.0\n   */\n  pressure?: 'normal' | 'warning' | 'critical' | 'unknown';\n}\n\n/**\n * Storage snapshot for the app data volume.\n *\n * All size values are reported in bytes.\n *\n * @since 8.0.0\n */\nexport interface StorageInfo {\n  /**\n   * Total bytes on the app data volume.\n   *\n   * @since 8.0.0\n   */\n  totalBytes?: number;\n\n  /**\n   * Free bytes on the app data volume.\n   *\n   * @since 8.0.0\n   */\n  freeBytes?: number;\n\n  /**\n   * Used bytes on the app data volume.\n   *\n   * @since 8.0.0\n   */\n  usedBytes?: number;\n\n  /**\n   * Storage usage from 0 to 100.\n   *\n   * @since 8.0.0\n   */\n  usedPercent?: number;\n}\n\n/**\n * GPU snapshot for the primary graphics device.\n *\n * @since 8.0.0\n */\nexport interface GpuInfo {\n  /**\n   * Graphics API used to query the GPU.\n   *\n   * @since 8.0.0\n   */\n  api?: 'metal' | 'opengl' | 'webgl' | 'unknown';\n\n  /**\n   * GPU vendor when available.\n   *\n   * @since 8.0.0\n   */\n  vendor?: string;\n\n  /**\n   * GPU renderer or model name when available.\n   *\n   * @since 8.0.0\n   */\n  renderer?: string;\n\n  /**\n   * Graphics API version string when available.\n   *\n   * @since 8.0.0\n   */\n  version?: string;\n\n  /**\n   * Maximum texture size reported by the graphics API.\n   *\n   * @since 8.0.0\n   */\n  maxTextureSize?: number;\n\n  /**\n   * GPU temperature in Celsius when the platform exposes an onboard thermal sensor.\n   *\n   * Android reads this as a best-effort value from device thermal zones. iOS does\n   * not expose raw GPU temperature through public APIs.\n   *\n   * @since 8.0.0\n   */\n  temperatureCelsius?: number;\n}\n\n/**\n * Thermal state reported by the platform.\n *\n * @since 8.0.0\n */\nexport type ThermalState = 'nominal' | 'fair' | 'serious' | 'critical' | 'unknown';\n\n/**\n * Description of an onboard hardware sensor exposed by the platform.\n *\n * @since 8.0.0\n */\nexport interface OnboardSensorDescriptor {\n  /**\n   * Stable sensor type label, for example `pressure`, `ambientTemperature`, or `accelerometer`.\n   *\n   * @since 8.0.0\n   */\n  type: string;\n\n  /**\n   * Platform sensor name when available.\n   *\n   * @since 8.0.0\n   */\n  name?: string;\n\n  /**\n   * Sensor vendor when available.\n   *\n   * @since 8.0.0\n   */\n  vendor?: string;\n\n  /**\n   * Android sensor type id when available.\n   *\n   * @since 8.0.0\n   */\n  platformType?: number;\n\n  /**\n   * Maximum sensor range when available.\n   *\n   * @since 8.0.0\n   */\n  maximumRange?: number;\n\n  /**\n   * Sensor resolution when available.\n   *\n   * @since 8.0.0\n   */\n  resolution?: number;\n\n  /**\n   * Sensor power draw in milliamps when available.\n   *\n   * @since 8.0.0\n   */\n  powerMilliamp?: number;\n\n  /**\n   * Minimum sensor delay in microseconds when available.\n   *\n   * @since 8.0.0\n   */\n  minDelayMicroseconds?: number;\n\n  /**\n   * Whether this is a wake-up sensor when available.\n   *\n   * @since 8.0.0\n   */\n  wakeUp?: boolean;\n}\n\n/**\n * Instant onboard sensor reading.\n *\n * @since 8.0.0\n */\nexport interface OnboardSensorReading {\n  /**\n   * Stable sensor type label.\n   *\n   * @since 8.0.0\n   */\n  type: string;\n\n  /**\n   * Human-readable unit, for example `celsius`, `percent`, `hPa`, `lux`, or `cm`.\n   *\n   * @since 8.0.0\n   */\n  unit: string;\n\n  /**\n   * Sensor value.\n   *\n   * @since 8.0.0\n   */\n  value: number;\n\n  /**\n   * Platform sensor name when available.\n   *\n   * @since 8.0.0\n   */\n  name?: string;\n\n  /**\n   * Reading timestamp as Unix epoch milliseconds.\n   *\n   * @since 8.0.0\n   */\n  timestamp?: number;\n}\n\n/**\n * Onboard sensors snapshot.\n *\n * This only reports hardware sensors exposed by the device or operating system.\n * It does not fetch weather data or any external temperature/humidity source.\n *\n * @since 8.0.0\n */\nexport interface OnboardSensorsInfo {\n  /**\n   * Sensors available to the app.\n   *\n   * @since 8.0.0\n   */\n  availableSensors?: OnboardSensorDescriptor[];\n\n  /**\n   * Instant sensor readings captured for common environmental sensors.\n   *\n   * @since 8.0.0\n   */\n  readings?: OnboardSensorReading[];\n\n  /**\n   * Battery temperature in Celsius when available.\n   *\n   * @since 8.0.0\n   */\n  batteryTemperatureCelsius?: number;\n\n  /**\n   * Ambient air temperature from an onboard sensor in Celsius when available.\n   *\n   * @since 8.0.0\n   */\n  ambientTemperatureCelsius?: number;\n\n  /**\n   * Relative humidity from an onboard sensor as a percentage when available.\n   *\n   * @since 8.0.0\n   */\n  relativeHumidityPercent?: number;\n\n  /**\n   * Atmospheric pressure from an onboard barometer in hectopascals when available.\n   *\n   * @since 8.0.0\n   */\n  pressureHpa?: number;\n\n  /**\n   * Ambient light from an onboard light sensor in lux when available.\n   *\n   * @since 8.0.0\n   */\n  illuminanceLux?: number;\n\n  /**\n   * Proximity distance from an onboard proximity sensor in centimeters when available.\n   *\n   * @since 8.0.0\n   */\n  proximityDistanceCm?: number;\n}\n\n/**\n * Instant device snapshot returned by {@link DeviceInfoPlugin.getInfo}.\n *\n * @since 8.0.0\n */\nexport interface DeviceInfoSnapshot {\n  /**\n   * Snapshot timestamp as Unix epoch milliseconds.\n   *\n   * @since 8.0.0\n   */\n  timestamp: number;\n\n  /**\n   * Platform implementation that produced the snapshot.\n   *\n   * @since 8.0.0\n   */\n  platform: 'ios' | 'android' | 'web';\n\n  /**\n   * CPU information and usage.\n   *\n   * @since 8.0.0\n   */\n  cpu: CpuInfo;\n\n  /**\n   * Memory information and usage.\n   *\n   * @since 8.0.0\n   */\n  memory: MemoryInfo;\n\n  /**\n   * Storage information and usage.\n   *\n   * @since 8.0.0\n   */\n  storage: StorageInfo;\n\n  /**\n   * GPU information when the platform exposes it.\n   *\n   * @since 8.0.0\n   */\n  gpu?: GpuInfo;\n\n  /**\n   * Thermal state when the platform exposes it.\n   *\n   * @since 8.0.0\n   */\n  thermalState?: ThermalState;\n\n  /**\n   * Low-power mode state when the platform exposes it.\n   *\n   * @since 8.0.0\n   */\n  lowPowerMode?: boolean;\n\n  /**\n   * Onboard sensor availability and readings.\n   *\n   * @since 8.0.0\n   */\n  sensors?: OnboardSensorsInfo;\n}\n\n/**\n * Options used to start periodic device snapshots.\n *\n * @since 8.0.0\n */\nexport interface MonitoringOptions {\n  /**\n   * Time between samples in milliseconds.\n   *\n   * Values below 250ms are clamped to 250ms to avoid excessive native work.\n   * Defaults to 1000ms.\n   *\n   * @since 8.0.0\n   */\n  intervalMs?: number;\n\n  /**\n   * Stop automatically after this duration in milliseconds.\n   *\n   * @since 8.0.0\n   */\n  durationMs?: number;\n\n  /**\n   * Stop automatically after this number of emitted samples.\n   *\n   * @since 8.0.0\n   */\n  sampleCount?: number;\n\n  /**\n   * Emit one sample immediately when monitoring starts.\n   *\n   * Defaults to `true`.\n   *\n   * @since 8.0.0\n   */\n  emitImmediately?: boolean;\n}\n\n/**\n * Result returned when monitoring starts.\n *\n * @since 8.0.0\n */\nexport interface StartMonitoringResult {\n  /**\n   * Whether monitoring is active.\n   *\n   * @since 8.0.0\n   */\n  monitoring: boolean;\n\n  /**\n   * Effective interval in milliseconds.\n   *\n   * @since 8.0.0\n   */\n  intervalMs: number;\n\n  /**\n   * Monitoring start timestamp as Unix epoch milliseconds.\n   *\n   * @since 8.0.0\n   */\n  startedAt: number;\n}\n\n/**\n * Result returned by {@link DeviceInfoPlugin.stopMonitoring}.\n *\n * @since 8.0.0\n */\nexport interface StopMonitoringResult {\n  /**\n   * Whether monitoring remains active after the stop request.\n   *\n   * @since 8.0.0\n   */\n  monitoring: boolean;\n}\n\n/**\n * Current monitoring state.\n *\n * @since 8.0.0\n */\nexport interface MonitoringState {\n  /**\n   * Whether monitoring is active.\n   *\n   * @since 8.0.0\n   */\n  monitoring: boolean;\n\n  /**\n   * Effective interval in milliseconds when monitoring is active.\n   *\n   * @since 8.0.0\n   */\n  intervalMs?: number;\n\n  /**\n   * Monitoring start timestamp as Unix epoch milliseconds.\n   *\n   * @since 8.0.0\n   */\n  startedAt?: number;\n\n  /**\n   * Number of samples emitted by the active monitoring session.\n   *\n   * @since 8.0.0\n   */\n  samplesEmitted?: number;\n}\n\n/**\n * Periodic event payload emitted while monitoring is active.\n *\n * @since 8.0.0\n */\nexport interface DeviceInfoUpdate extends DeviceInfoSnapshot {\n  /**\n   * One-based sample sequence for the active monitoring session.\n   *\n   * @since 8.0.0\n   */\n  sequence: number;\n\n  /**\n   * Monitoring start timestamp as Unix epoch milliseconds.\n   *\n   * @since 8.0.0\n   */\n  startedAt: number;\n\n  /**\n   * Elapsed milliseconds since monitoring started.\n   *\n   * @since 8.0.0\n   */\n  elapsedMs: number;\n}\n\n/**\n * Plugin version payload.\n *\n * @since 8.0.0\n */\nexport interface PluginVersionResult {\n  /**\n   * Version identifier returned by the platform implementation.\n   *\n   * @since 8.0.0\n   */\n  version: string;\n}\n\n/**\n * Capacitor plugin contract for reading device CPU, memory, GPU, storage, and onboard sensor metrics.\n *\n * @since 8.0.0\n */\nexport interface DeviceInfoPlugin {\n  /**\n   * Read one CPU, memory, GPU, storage, thermal, and onboard sensor snapshot.\n   *\n   * @since 8.0.0\n   */\n  getInfo(): Promise<DeviceInfoSnapshot>;\n\n  /**\n   * Start periodic device snapshots.\n   *\n   * Listen to `deviceInfoUpdate` to receive samples. Calling this while monitoring\n   * is already active restarts monitoring with the new options.\n   *\n   * @since 8.0.0\n   */\n  startMonitoring(options?: MonitoringOptions): Promise<StartMonitoringResult>;\n\n  /**\n   * Stop periodic device snapshots.\n   *\n   * @since 8.0.0\n   */\n  stopMonitoring(): Promise<StopMonitoringResult>;\n\n  /**\n   * Return current periodic monitoring state.\n   *\n   * @since 8.0.0\n   */\n  isMonitoring(): Promise<MonitoringState>;\n\n  /**\n   * Listen for periodic device snapshots.\n   *\n   * @param eventName Only the `deviceInfoUpdate` event is supported.\n   * @param listenerFunc Callback invoked with each snapshot.\n   * @since 8.0.0\n   */\n  addListener(\n    eventName: 'deviceInfoUpdate',\n    listenerFunc: (event: DeviceInfoUpdate) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners that have been registered on the plugin.\n   *\n   * @since 8.0.0\n   */\n  removeAllListeners(): Promise<void>;\n\n  /**\n   * Get the native Capacitor plugin version.\n   *\n   * @since 8.0.0\n   */\n  getPluginVersion(): Promise<PluginVersionResult>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { DeviceInfoPlugin } from './definitions';
+declare const DeviceInfo: DeviceInfoPlugin;
+export * from './definitions';
+export { DeviceInfo };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const DeviceInfo = registerPlugin('DeviceInfo', {
+    web: () => import('./web').then((m) => new m.DeviceInfoWeb()),
+});
+export * from './definitions';
+export { DeviceInfo };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,UAAU,GAAG,cAAc,CAAmB,YAAY,EAAE;IAChE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { DeviceInfoPlugin } from './definitions';\n\nconst DeviceInfo = registerPlugin<DeviceInfoPlugin>('DeviceInfo', {\n  web: () => import('./web').then((m) => new m.DeviceInfoWeb()),\n});\n\nexport * from './definitions';\nexport { DeviceInfo };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,29 @@
+import { WebPlugin } from '@capacitor/core';
+import type { PluginListenerHandle } from '@capacitor/core';
+import type { DeviceInfoPlugin, DeviceInfoSnapshot, DeviceInfoUpdate, MonitoringOptions, MonitoringState, PluginVersionResult, StartMonitoringResult, StopMonitoringResult } from './definitions';
+export declare class DeviceInfoWeb extends WebPlugin implements DeviceInfoPlugin {
+    private timer;
+    private startedAt;
+    private intervalMs;
+    private samplesEmitted;
+    private sampleLimit;
+    private stopAt;
+    private isEmitting;
+    getInfo(): Promise<DeviceInfoSnapshot>;
+    startMonitoring(options?: MonitoringOptions): Promise<StartMonitoringResult>;
+    stopMonitoring(): Promise<StopMonitoringResult>;
+    isMonitoring(): Promise<MonitoringState>;
+    addListener(eventName: 'deviceInfoUpdate', listenerFunc: (event: DeviceInfoUpdate) => void): Promise<PluginListenerHandle>;
+    removeAllListeners(): Promise<void>;
+    getPluginVersion(): Promise<PluginVersionResult>;
+    private emitSample;
+    private getMemoryInfo;
+    private getStorageInfo;
+    private getGpuInfo;
+    private getOnboardSensorsInfo;
+    private shouldStop;
+    private normalizeInterval;
+    private normalizePositiveInteger;
+    private normalizePositiveNumber;
+    private toPercent;
+}