angular-toolbox 0.9.5 → 0.10.1

package/lib/model/business/index.d.ts

@@ -3,3 +3,4 @@ export * from './ui';
 export * from './lang';
 export * from './mock/http';
 export * from './subscription';
+export * from './navigator';

package/lib/model/business/navigator/battery-manager.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The `BatteryManager` interface of the Battery Status API provides information about
+ * the system battery charge level. The `navigator.getBattery()` method returns a promise
+ * that resolves with a `BatteryManager` interface.
+ */
+export interface BatteryManager extends EventTarget {
+    /**
+     * A boolean value indicating whether the battery is currently being charged.
+     */
+    readonly charging: boolean;
+    /**
+     * A number representing the remaining time in seconds until the battery is fully charged,
+     * or 0 if the battery is already fully charged.
+     */
+    readonly chargingTime: number;
+    /**
+     * A number representing the remaining time in seconds until the battery
+     * is completely discharged and the system suspends.
+     */
+    readonly dischargingTime: number;
+    /**
+     * A number representing the system's battery charge level scaled to a value between 0.0 and 1.0.
+     */
+    readonly level: number;
+    /**
+     * Fired when the battery charging state (the `charging` property) is updated.
+     *
+     * @param event A generic `Event`.
+     */
+    onlevelchange(event: Event): void;
+    /**
+     * Fired when the battery charging time (the `chargingTime` property) is updated.
+     *
+     * @param event A generic `Event`.
+     */
+    onchargingchange(event: Event): void;
+    /**
+     * Fired when the battery discharging time (the `dischargingTime` property) is updated.
+     *
+     * @param event A generic `Event`.
+     */
+    chargingtimechange(event: Event): void;
+    /**
+     * Fired when the battery level (the `level` property) is updated.
+     *
+     * @param event A generic `Event`.
+     */
+    dischargingtimechange(event: Event): void;
+}

package/lib/model/business/navigator/connection-type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The type of connection as defined by the `NetworkInformation.type` property.
+ */
+export type ConnectionType = 'bluetooth' | 'cellular' | 'ethernet' | 'mixed' | 'none' | 'other' | 'unknown' | 'wifi' | 'wimax';

package/lib/model/business/navigator/effective-connection-type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The effective type of connection as defined by the `NetworkInformation.effectiveType` property.
+ */
+export type EffectiveConnectionType = '2g' | '3g' | '4g' | 'slow-2g';

package/lib/model/business/navigator/index.d.ts

@@ -0,0 +1,4 @@
+export * from './connection-type';
+export * from './effective-connection-type';
+export * from './network-information';
+export * from './battery-manager';

package/lib/model/business/navigator/network-information.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { ConnectionType } from "./connection-type";
+import { EffectiveConnectionType } from "./effective-connection-type";
+/**
+ * The `NetworkInformation` interface of the Network Information API provides
+ * information about the connection a device is using to communicate with the network
+ * and provides a means for scripts to be notified if the connection type changes.
+ * The `NetworkInformation` interface cannot be instantiated. It is instead accessed
+ * through the connection property of the `Navigator` interface or the `WorkerNavigator`
+ * interface.
+ */
+export interface NetworkInformation extends EventTarget {
+    /**
+     * Returns the effective bandwidth estimate in megabits per second,
+     * rounded to the nearest multiple of 25 kilobits per seconds.
+     */
+    readonly downlink: number;
+    /**
+     * Returns the maximum downlink speed, in megabits per second (Mbps),
+     * for the underlying connection technology.
+     */
+    readonly downlinkMax: number;
+    /**
+     * Returns the effective type of the connection meaning one of the `EffectiveConnectionType` enum.
+     * This value is determined using a combination of recently observed round-trip time and downlink values.
+     */
+    readonly effectiveType: EffectiveConnectionType;
+    /**
+     * Returns the type of connection a device is using to communicate with the network.
+     * It will be one of the `ConnectionType` enum.
+     */
+    readonly type: ConnectionType;
+    /**
+     * Returns the estimated effective round-trip time of the current connection,
+     * rounded to the nearest multiple of 25 milliseconds.
+     */
+    readonly rtt: number;
+    /**
+     * Returns `true` whether the user has set a reduced data usage option on the user agent.
+     * `false` otherwise.
+     */
+    readonly saveData: boolean;
+    /**
+     * The event that's fired when connection information changes.
+     */
+    onchange: EventListener;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "0.9.5",
+  "version": "0.10.1",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",