@neurosity/sdk 6.2.4 → 6.4.0-next.0

package/dist/cjs/Neurosity.d.ts

@@ -11,7 +11,7 @@ import { Calm } from "./types/calm";
 import { Focus } from "./types/focus";
 import { BrainwavesLabel, Epoch, PowerByBand, PSD } from "./types/brainwaves";
 import { Accelerometer } from "./types/accelerometer";
-import { DeviceInfo } from "./types/deviceInfo";
+import { DeviceInfo, OSVersion } from "./types/deviceInfo";
 import { DeviceStatus } from "./types/status";
 import { Action } from "./types/actions";
 import { HapticEffects } from "./types/hapticEffects";
@@ -404,6 +404,22 @@ export declare class Neurosity {
      * @returns Observable of `settings` metric events
      */
     settings(): Observable<Settings>;
+    /**
+     * <StreamingModes wifi={true} />
+     *
+     * Observes the current OS version and all subsequent version changes in real-time.
+     *
+     * ```typescript
+     * neurosity.osVersion().subscribe((osVersion) => {
+     *   console.log(osVersion);
+     * });
+     *
+     * // "16.0.0"
+     * ```
+     *
+     * @returns Observable of `osVersion` events. e.g 16.0.0
+     */
+    osVersion(): Observable<OSVersion>;
     /**
      * <StreamingModes wifi={true} bluetooth={true} />
      *

package/dist/cjs/Neurosity.js

@@ -39,6 +39,7 @@ exports.Notion = exports.Neurosity = void 0;
 const rxjs_1 = require("rxjs");
 const rxjs_2 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const operators_2 = require("rxjs/operators");
 const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
 const index_1 = require("./api/index");
 const index_2 = require("./api/index");
@@ -99,6 +100,7 @@ class Neurosity {
         if (!!bluetoothTransport) {
             this.bluetoothClient = new bluetooth_1.BluetoothClient({
                 selectedDevice$: this.onDeviceChange(),
+                osVersion$: this.osVersion(),
                 createBluetoothToken: this.createBluetoothToken.bind(this),
                 transport: bluetoothTransport
             });
@@ -144,12 +146,12 @@ class Neurosity {
     streamingState() {
         const isWifiOnline = (state) => [status_1.STATUS.ONLINE, status_1.STATUS.UPDATING].includes(state);
         return this.streamingMode$.pipe((0, operators_1.switchMap)((streamingMode) => {
-            return this.onDeviceChange().pipe((0, operators_1.switchMap)((selectDevice) => {
+            return this.onDeviceChange().pipe((0, operators_2.combineLatestWith)(this.osVersion()), (0, operators_1.switchMap)(([selectDevice, osVersion]) => {
                 if (!selectDevice) {
                     return rxjs_2.EMPTY;
                 }
                 const isUnableToUseBluetooth = this.isMissingBluetoothTransport ||
-                    !(0, bluetooth_1.osHasBluetoothSupport)(selectDevice);
+                    !(0, bluetooth_1.osHasBluetoothSupport)(selectDevice, osVersion);
                 if (isUnableToUseBluetooth) {
                     return this.cloudClient.status().pipe((0, operators_1.map)(({ state }) => ({
                         connected: isWifiOnline(state),
@@ -795,6 +797,28 @@ class Neurosity {
         }
         return this.cloudClient.observeNamespace("settings");
     }
+    /**
+     * <StreamingModes wifi={true} />
+     *
+     * Observes the current OS version and all subsequent version changes in real-time.
+     *
+     * ```typescript
+     * neurosity.osVersion().subscribe((osVersion) => {
+     *   console.log(osVersion);
+     * });
+     *
+     * // "16.0.0"
+     * ```
+     *
+     * @returns Observable of `osVersion` events. e.g 16.0.0
+     */
+    osVersion() {
+        const [hasOAuthError, OAuthError] = (0, oauth_1.validateOAuthScopeForFunctionName)(this.cloudClient.userClaims, "osVersion");
+        if (hasOAuthError) {
+            return (0, rxjs_1.throwError)(() => OAuthError);
+        }
+        return this.cloudClient.osVersion();
+    }
     /**
      * <StreamingModes wifi={true} bluetooth={true} />
      *

package/dist/cjs/api/bluetooth/BluetoothClient.d.ts

@@ -2,7 +2,7 @@ import { Observable } from "rxjs";
 import { ReplaySubject } from "rxjs";
 import { WebBluetoothTransport } from "./web/WebBluetoothTransport";
 import { ReactNativeTransport } from "./react-native/ReactNativeTransport";
-import { DeviceInfo } from "../../types/deviceInfo";
+import { DeviceInfo, OSVersion } from "../../types/deviceInfo";
 import { Action } from "../../types/actions";
 import { Epoch } from "../../types/epoch";
 import { BLUETOOTH_CONNECTION } from "./types";
@@ -16,12 +16,14 @@ declare type CreateBluetoothToken = () => Promise<string>;
 declare type Options = {
     transport: BluetoothTransport;
     selectedDevice$: Observable<DeviceInfo>;
+    osVersion$: Observable<OSVersion>;
     createBluetoothToken: CreateBluetoothToken;
 };
 export declare class BluetoothClient {
     transport: BluetoothTransport;
     deviceInfo: DeviceInfo;
     selectedDevice$: ReplaySubject<DeviceInfo>;
+    osVersion$: ReplaySubject<string>;
     isAuthenticated$: ReplaySubject<boolean>;
     _focus$: Observable<any>;
     _calm$: Observable<any>;

package/dist/cjs/api/bluetooth/BluetoothClient.js

@@ -22,6 +22,7 @@ const osHasBluetoothSupport_1 = require("./utils/osHasBluetoothSupport");
 class BluetoothClient {
     constructor(options) {
         this.selectedDevice$ = new rxjs_2.ReplaySubject(1);
+        this.osVersion$ = new rxjs_2.ReplaySubject(1);
         this.isAuthenticated$ = new rxjs_2.ReplaySubject(1);
         const { transport, selectedDevice$, createBluetoothToken } = options !== null && options !== void 0 ? options : {};
         if (!transport) {
@@ -33,7 +34,9 @@ class BluetoothClient {
             selectedDevice$.subscribe(this.selectedDevice$);
         }
         // Auto Connect
-        this.transport._autoConnect(this.selectedDevice$).subscribe({
+        this.transport
+            ._autoConnect(this.selectedDevice$, this.osVersion$)
+            .subscribe({
             error: (error) => {
                 var _a;
                 this.transport.addLog(`Auto connect: error -> ${(_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : error}`);
@@ -48,7 +51,7 @@ class BluetoothClient {
             this.transport.addLog("Auto authentication not enabled");
         }
         // Auto manage action notifications
-        this.transport._autoToggleActionNotifications(this.selectedDevice$);
+        this.transport._autoToggleActionNotifications(this.selectedDevice$, this.osVersion$);
         // Multicast metrics (share)
         this._focus$ = this._subscribeWhileAuthenticated("focus");
         this._calm$ = this._subscribeWhileAuthenticated("calm");
@@ -72,7 +75,7 @@ class BluetoothClient {
         const reauthenticateInterval$ = (0, rxjs_1.timer)(0, REAUTHENTICATE_INTERVAL).pipe((0, operators_1.tap)(() => {
             this.transport.addLog(`Auto authentication in progress...`);
         }));
-        return this.selectedDevice$.pipe((0, operators_1.switchMap)((selectedDevice) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice)
+        return this.selectedDevice$.pipe((0, operators_1.combineLatestWith)(this.osVersion$), (0, operators_1.switchMap)(([selectedDevice, osVersion]) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion)
             ? rxjs_2.EMPTY
             : this.connection().pipe((0, operators_1.switchMap)((connection) => connection === types_1.BLUETOOTH_CONNECTION.CONNECTED
                 ? reauthenticateInterval$
@@ -92,7 +95,8 @@ class BluetoothClient {
     _hasBluetoothSupport() {
         return __awaiter(this, void 0, void 0, function* () {
             const selectedDevice = yield (0, rxjs_1.firstValueFrom)(this.selectedDevice$);
-            return (0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice);
+            const osVersion = yield (0, rxjs_1.firstValueFrom)(this.osVersion$);
+            return (0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion);
         });
     }
     authenticate(token) {
@@ -173,7 +177,7 @@ class BluetoothClient {
         });
     }
     _subscribeWhileAuthenticated(characteristicName) {
-        return this.selectedDevice$.pipe((0, operators_1.switchMap)((selectedDevice) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice)
+        return this.selectedDevice$.pipe((0, operators_1.combineLatestWith)(this.osVersion$), (0, operators_1.switchMap)(([selectedDevice, osVersion]) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion)
             ? rxjs_2.EMPTY
             : this.isAuthenticated$.pipe((0, operators_2.distinctUntilChanged)(), (0, operators_1.switchMap)((isAuthenticated) => isAuthenticated
                 ? this.transport.subscribeToCharacteristic({

package/dist/cjs/api/bluetooth/BluetoothTransport.d.ts

@@ -1,7 +1,7 @@
 import { Observable, Subject } from "rxjs";
 import { BLUETOOTH_CONNECTION, TRANSPORT_TYPE } from "./types";
 import { Action } from "../../types/actions";
-import { DeviceInfo } from "../../types/deviceInfo";
+import { DeviceInfo, OSVersion } from "../../types/deviceInfo";
 import { Peripheral } from "./react-native/types/BleManagerTypes";
 export declare type DeviceNicknameOrPeripheral = string | Peripheral;
 /**
@@ -10,7 +10,7 @@ export declare type DeviceNicknameOrPeripheral = string | Peripheral;
 export interface BluetoothTransport {
     type: TRANSPORT_TYPE;
     connect(deviceNicknameORPeripheral?: DeviceNicknameOrPeripheral): Promise<void>;
-    _autoConnect(selectedDevice$: Observable<DeviceInfo>): Observable<void>;
+    _autoConnect(selectedDevice$: Observable<DeviceInfo>, osVersion: Observable<OSVersion>): Observable<void>;
     disconnect(): Promise<void>;
     connection(): Observable<BLUETOOTH_CONNECTION>;
     requestDevice?(): any;

package/dist/cjs/api/bluetooth/react-native/ReactNativeTransport.d.ts

@@ -7,7 +7,7 @@ import { BleManager } from "./types/BleManagerTypes";
 import { Peripheral } from "./types/BleManagerTypes";
 import { NativeEventEmitter } from "./types/ReactNativeTypes";
 import { PlatformOSType } from "./types/ReactNativeTypes";
-import { DeviceInfo } from "../../../types/deviceInfo";
+import { DeviceInfo, OSVersion } from "../../../types/deviceInfo";
 declare type Characteristic = {
     characteristicUUID: string;
     serviceUUID: string;
@@ -48,7 +48,7 @@ export declare class ReactNativeTransport implements BluetoothTransport {
     constructor(options: Options);
     addLog(log: string): void;
     isConnected(): boolean;
-    _autoConnect(selectedDevice$: Observable<DeviceInfo>): Observable<void>;
+    _autoConnect(selectedDevice$: Observable<DeviceInfo>, osVersion$: Observable<OSVersion>): Observable<void>;
     enableAutoConnect(autoConnect: boolean): void;
     connection(): Observable<BLUETOOTH_CONNECTION>;
     _fromEvent(eventName: string): Observable<any>;
@@ -65,7 +65,7 @@ export declare class ReactNativeTransport implements BluetoothTransport {
     writeCharacteristic(characteristicName: string, data: string): Promise<void>;
     _addPendingAction(actionId: number): void;
     _removePendingAction(actionId: number): void;
-    _autoToggleActionNotifications(selectedDevice$: Observable<DeviceInfo>): Promise<void>;
+    _autoToggleActionNotifications(selectedDevice$: Observable<DeviceInfo>, osVersion$: Observable<OSVersion>): Promise<void>;
     dispatchAction({ characteristicName, action }: ActionOptions): Promise<any>;
 }
 export {};

package/dist/cjs/api/bluetooth/react-native/ReactNativeTransport.js

@@ -104,11 +104,11 @@ class ReactNativeTransport {
         const connection = this.connection$.getValue();
         return connection === types_1.BLUETOOTH_CONNECTION.CONNECTED;
     }
-    _autoConnect(selectedDevice$) {
+    _autoConnect(selectedDevice$, osVersion$) {
         const selectedDeviceAfterDisconnect$ = this.onDisconnected$.pipe((0, operators_1.switchMap)(() => selectedDevice$));
         return this._isAutoConnectEnabled$.pipe((0, operators_1.switchMap)((isAutoConnectEnabled) => isAutoConnectEnabled
             ? (0, rxjs_1.merge)(selectedDevice$, selectedDeviceAfterDisconnect$)
-            : rxjs_2.NEVER), (0, operators_1.switchMap)((selectedDevice) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice)
+            : rxjs_2.NEVER), (0, operators_3.combineLatestWith)(osVersion$), (0, operators_1.switchMap)(([selectedDevice, osVersion]) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion)
             ? rxjs_2.NEVER
             : this.scan().pipe((0, operators_1.switchMap)((peripherals) => {
                 const peripheralMatch = peripherals.find((peripheral) => peripheral.name === (selectedDevice === null || selectedDevice === void 0 ? void 0 : selectedDevice.deviceNickname));
@@ -336,7 +336,7 @@ class ReactNativeTransport {
         const actions = this.pendingActions$.getValue();
         this.pendingActions$.next(actions.filter((id) => id !== actionId));
     }
-    _autoToggleActionNotifications(selectedDevice$) {
+    _autoToggleActionNotifications(selectedDevice$, osVersion$) {
         return __awaiter(this, void 0, void 0, function* () {
             let started = false;
             const sideEffects$ = this.connection$.asObservable().pipe((0, operators_1.switchMap)((connection) => connection === types_1.BLUETOOTH_CONNECTION.CONNECTED
@@ -367,7 +367,9 @@ class ReactNativeTransport {
                 }
             })));
             selectedDevice$
-                .pipe((0, operators_1.switchMap)((selectedDevice) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice) ? rxjs_2.EMPTY : sideEffects$))
+                .pipe((0, operators_3.combineLatestWith)(osVersion$), (0, operators_1.switchMap)(([selectedDevice, osVersion]) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion)
+                ? rxjs_2.EMPTY
+                : sideEffects$))
                 .subscribe();
         });
     }

package/dist/cjs/api/bluetooth/utils/osHasBluetoothSupport.d.ts

@@ -1,2 +1,2 @@
-import { DeviceInfo } from "../../../types/deviceInfo";
-export declare function osHasBluetoothSupport(selectedDevice: DeviceInfo): any;
+import { DeviceInfo, OSVersion } from "../../../types/deviceInfo";
+export declare function osHasBluetoothSupport(selectedDevice: DeviceInfo, osVersion?: OSVersion): any;

package/dist/cjs/api/bluetooth/utils/osHasBluetoothSupport.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.osHasBluetoothSupport = void 0;
 const gte_1 = __importDefault(require("semver/functions/gte"));
-function osHasBluetoothSupport(selectedDevice) {
+function osHasBluetoothSupport(selectedDevice, osVersion) {
     if (!selectedDevice) {
         return false;
     }
@@ -18,6 +18,8 @@ function osHasBluetoothSupport(selectedDevice) {
     if (isEmulator) {
         return false;
     }
-    return (0, gte_1.default)(selectedDevice.osVersion, "16.0.0");
+    // `osVersion` is updated in real time,
+    // unlike accessing via `selectedDevice.osVersion`
+    return (0, gte_1.default)(osVersion !== null && osVersion !== void 0 ? osVersion : selectedDevice.osVersion, "16.0.0");
 }
 exports.osHasBluetoothSupport = osHasBluetoothSupport;

package/dist/cjs/api/bluetooth/web/WebBluetoothTransport.d.ts

@@ -4,7 +4,7 @@ import { Observable } from "rxjs";
 import { BluetoothTransport } from "../BluetoothTransport";
 import { ActionOptions, SubscribeOptions } from "../types";
 import { TRANSPORT_TYPE, BLUETOOTH_CONNECTION } from "../types";
-import { DeviceInfo } from "../../../types/deviceInfo";
+import { DeviceInfo, OSVersion } from "../../../types/deviceInfo";
 declare type Options = {
     autoConnect?: boolean;
 };
@@ -25,7 +25,7 @@ export declare class WebBluetoothTransport implements BluetoothTransport {
     _isAutoConnectEnabled$: ReplaySubject<boolean>;
     constructor(options?: Options);
     _getPairedDevices(): Promise<BluetoothDevice[]>;
-    _autoConnect(selectedDevice$: Observable<DeviceInfo>): Observable<void>;
+    _autoConnect(selectedDevice$: Observable<DeviceInfo>, osVersion$: Observable<OSVersion>): Observable<void>;
     enableAutoConnect(autoConnect: boolean): void;
     addLog(log: string): void;
     isConnected(): boolean;
@@ -48,7 +48,7 @@ export declare class WebBluetoothTransport implements BluetoothTransport {
     writeCharacteristic(characteristicName: string, data: string): Promise<void>;
     _addPendingAction(actionId: number): void;
     _removePendingAction(actionId: number): void;
-    _autoToggleActionNotifications(selectedDevice$: Observable<DeviceInfo>): Promise<void>;
+    _autoToggleActionNotifications(selectedDevice$: Observable<DeviceInfo>, osVersion$: Observable<OSVersion>): Promise<void>;
     dispatchAction({ characteristicName, action }: ActionOptions): Promise<any>;
 }
 export {};

package/dist/cjs/api/bluetooth/web/WebBluetoothTransport.js

@@ -64,10 +64,12 @@ class WebBluetoothTransport {
             return yield navigator.bluetooth.getDevices();
         });
     }
-    _autoConnect(selectedDevice$) {
+    _autoConnect(selectedDevice$, osVersion$) {
         return this._isAutoConnectEnabled$.pipe((0, operators_1.switchMap)((isAutoConnectEnabled) => isAutoConnectEnabled
             ? (0, rxjs_1.merge)(selectedDevice$, this.onDisconnected$.pipe((0, operators_1.switchMap)(() => selectedDevice$)))
-            : rxjs_2.NEVER), (0, operators_1.switchMap)((selectedDevice) => (0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice) ? (0, rxjs_1.of)(selectedDevice) : rxjs_2.EMPTY), (0, operators_1.switchMap)((selectedDevice) => __awaiter(this, void 0, void 0, function* () {
+            : rxjs_2.NEVER), (0, operators_1.combineLatestWith)(osVersion$), (0, operators_1.switchMap)(([selectedDevice, osVersion]) => (0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion)
+            ? (0, rxjs_1.of)(selectedDevice)
+            : rxjs_2.EMPTY), (0, operators_1.switchMap)((selectedDevice) => __awaiter(this, void 0, void 0, function* () {
             var _a;
             const { deviceNickname } = selectedDevice;
             if (this.isConnected()) {
@@ -307,7 +309,7 @@ class WebBluetoothTransport {
         const actions = this.pendingActions$.getValue();
         this.pendingActions$.next(actions.filter((id) => id !== actionId));
     }
-    _autoToggleActionNotifications(selectedDevice$) {
+    _autoToggleActionNotifications(selectedDevice$, osVersion$) {
         return __awaiter(this, void 0, void 0, function* () {
             let actionsCharacteristic;
             let started = false;
@@ -341,7 +343,9 @@ class WebBluetoothTransport {
                 }
             })));
             selectedDevice$
-                .pipe((0, operators_1.switchMap)((selectedDevice) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice) ? rxjs_2.EMPTY : sideEffects$))
+                .pipe((0, operators_1.combineLatestWith)(osVersion$), (0, operators_1.switchMap)(([selectedDevice, osVersion]) => !(0, osHasBluetoothSupport_1.osHasBluetoothSupport)(selectedDevice, osVersion)
+                ? rxjs_2.EMPTY
+                : sideEffects$))
                 .subscribe();
         });
     }

package/dist/cjs/api/index.d.ts

@@ -11,7 +11,7 @@ import { Credentials, CustomToken } from "../types/credentials";
 import { EmailAndPassword } from "../types/credentials";
 import { ChangeSettings } from "../types/settings";
 import { DeviceStatus } from "../types/status";
-import { DeviceInfo, DeviceSelector } from "../types/deviceInfo";
+import { DeviceInfo, DeviceSelector, OSVersion } from "../types/deviceInfo";
 import { UserClaims } from "../types/user";
 import { OAuthRemoveResponse } from "../types/oauth";
 import { Experiment } from "../types/experiment";
@@ -30,8 +30,10 @@ export declare class CloudClient implements Client {
     protected timesync: Timesync;
     protected subscriptionManager: SubscriptionManager;
     protected status$: Observable<DeviceStatus>;
+    protected osVersion$: Observable<OSVersion>;
     constructor(options: SDKOptions);
     onDeviceChange(): Observable<DeviceInfo>;
+    osVersion(): Observable<OSVersion>;
     private setAutoSelectedDevice;
     get actions(): Actions;
     dispatchAction(action: Action): Promise<any>;

package/dist/cjs/api/index.js

@@ -37,6 +37,7 @@ class CloudClient {
         this.firebaseUser = new firebase_1.FirebaseUser(this.firebaseApp);
         this._selectedDevice.next(undefined);
         this.status$ = (0, heartbeat_1.heartbeatAwareStatus)(this.observeNamespace("status").pipe((0, operators_1.share)())).pipe((0, filterInternalKeys_1.filterInternalKeys)(), (0, operators_1.shareReplay)(1));
+        this.osVersion$ = this.observeNamespace("info/osVersion").pipe((0, operators_1.shareReplay)(1));
         this.firebaseUser.onAuthStateChanged().subscribe((user) => {
             this.user = user;
         });
@@ -70,6 +71,9 @@ class CloudClient {
             .asObservable()
             .pipe((0, operators_1.filter)((value) => value !== undefined));
     }
+    osVersion() {
+        return this.osVersion$;
+    }
     // Automatically select device when user logs in
     setAutoSelectedDevice() {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/cjs/types/deviceInfo.d.ts

@@ -1,3 +1,4 @@
+export declare type OSVersion = string;
 export interface DeviceInfo {
     deviceId: string;
     deviceNickname: string;
@@ -8,7 +9,7 @@ export interface DeviceInfo {
     model: string;
     modelName: string;
     modelVersion: string;
-    osVersion: string;
+    osVersion: OSVersion;
     apiVersion: string;
     emulator?: boolean;
 }

package/dist/cjs/utils/oauth.js

@@ -50,6 +50,7 @@ const scopeRequiredByFunctionName = {
     selectDevice: "read:devices-info",
     onDeviceChange: "read:devices-info",
     onUserDevicesChange: "read:devices-info",
+    osVersion: "read:devices-info",
     // end device info
     settings: "read:devices-settings",
     changeSettings: "write:devices-settings",