@neurosity/sdk 6.1.1 → 6.2.1-next.0

package/dist/cjs/api/index.js

@@ -1,307 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloudClient = exports.SERVER_TIMESTAMP = exports.createUser = exports.credentialWithLink = void 0;
-const rxjs_1 = require("rxjs");
-const rxjs_2 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const firebase_1 = require("./firebase");
-const timesync_1 = require("../timesync");
-const SubscriptionManager_1 = require("../subscriptions/SubscriptionManager");
-const heartbeat_1 = require("../utils/heartbeat");
-const filterInternalKeys_1 = require("../utils/filterInternalKeys");
-var firebase_2 = require("./firebase");
-Object.defineProperty(exports, "credentialWithLink", { enumerable: true, get: function () { return firebase_2.credentialWithLink; } });
-Object.defineProperty(exports, "createUser", { enumerable: true, get: function () { return firebase_2.createUser; } });
-Object.defineProperty(exports, "SERVER_TIMESTAMP", { enumerable: true, get: function () { return firebase_2.SERVER_TIMESTAMP; } });
-/**
- * @hidden
- */
-class CloudClient {
-    constructor(options) {
-        /**
-         * @internal
-         */
-        this._selectedDevice = new rxjs_1.ReplaySubject(1);
-        this.options = options;
-        this.subscriptionManager = new SubscriptionManager_1.SubscriptionManager();
-        this.firebaseApp = new firebase_1.FirebaseApp(options);
-        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.firebaseUser.onAuthStateChanged().subscribe((user) => {
-            this.user = user;
-        });
-        this.firebaseUser.onUserClaimsChange().subscribe((userClaims) => {
-            this.userClaims = userClaims;
-        });
-        this.onDeviceChange().subscribe((device) => {
-            if (this.firebaseDevice) {
-                this.firebaseDevice.disconnect();
-            }
-            if (!device) {
-                return;
-            }
-            this.firebaseDevice = new firebase_1.FirebaseDevice({
-                deviceId: device.deviceId,
-                firebaseApp: this.firebaseApp,
-                dependencies: {
-                    subscriptionManager: this.subscriptionManager
-                }
-            });
-            if (this.options.timesync) {
-                this.timesync = new timesync_1.Timesync({
-                    status$: this.status(),
-                    getTimesync: this.firebaseDevice.getTimesync.bind(this.firebaseDevice)
-                });
-            }
-        });
-    }
-    onDeviceChange() {
-        return this._selectedDevice
-            .asObservable()
-            .pipe((0, operators_1.filter)((value) => value !== undefined));
-    }
-    // Automatically select device when user logs in
-    setAutoSelectedDevice() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Select based on `deviceId` passed
-            if (this.options.deviceId) {
-                return yield this.selectDevice((devices) => {
-                    return devices.find((device) => device.deviceId === this.options.deviceId);
-                });
-            }
-            // Auto select first-claimed device
-            if (!this.options.deviceId && this.options.autoSelectDevice) {
-                return yield this.selectDevice((devices) => {
-                    // Auto select first device
-                    return devices[0];
-                });
-            }
-            return null;
-        });
-    }
-    get actions() {
-        return {
-            dispatch: (action) => {
-                return this.firebaseDevice.dispatchAction(action);
-            }
-        };
-    }
-    dispatchAction(action) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.firebaseDevice.dispatchAction(action);
-        });
-    }
-    disconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.firebaseApp.disconnect();
-        });
-    }
-    getInfo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.firebaseDevice.getInfo();
-        });
-    }
-    login(credentials) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.user) {
-                return Promise.reject(`Already logged in.`);
-            }
-            const auth = yield this.firebaseUser.login(credentials);
-            const selectedDevice = yield this.setAutoSelectedDevice();
-            return Object.assign(Object.assign({}, auth), { selectedDevice });
-        });
-    }
-    logout() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.firebaseDevice) {
-                this.firebaseDevice.disconnect();
-            }
-            return yield this.firebaseUser.logout();
-        });
-    }
-    onAuthStateChanged() {
-        return this.firebaseUser.onAuthStateChanged().pipe((0, operators_1.switchMap)((user) => __awaiter(this, void 0, void 0, function* () {
-            if (!user) {
-                return null;
-            }
-            const selectedDevice = this.didSelectDevice()
-                ? yield this.getSelectedDevice()
-                : yield this.setAutoSelectedDevice();
-            return Object.assign(Object.assign({}, user), { selectedDevice });
-        })));
-    }
-    getDevices() {
-        return this.firebaseUser.getDevices();
-    }
-    addDevice(deviceId) {
-        return this.firebaseUser.addDevice(deviceId);
-    }
-    removeDevice(deviceId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const [hasError, errorMessage] = yield this.firebaseUser
-                .removeDevice(deviceId)
-                .then(() => [false])
-                .catch((error) => [true, error]);
-            if (hasError) {
-                return Promise.reject(errorMessage);
-            }
-            const selectedDevice = yield this.getSelectedDevice();
-            if ((selectedDevice === null || selectedDevice === void 0 ? void 0 : selectedDevice.deviceId) === deviceId) {
-                this._selectedDevice.next(null);
-            }
-        });
-    }
-    transferDevice(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const [hasError, error] = yield this.firebaseUser
-                .transferDevice(options)
-                .then(() => [false])
-                .catch((error) => [true, error]);
-            if (hasError) {
-                return Promise.reject(error);
-            }
-            const selectedDevice = yield this.getSelectedDevice();
-            if ((selectedDevice === null || selectedDevice === void 0 ? void 0 : selectedDevice.deviceId) === options.deviceId) {
-                this._selectedDevice.next(null);
-            }
-        });
-    }
-    onUserDevicesChange() {
-        return this.firebaseUser.onUserDevicesChange();
-    }
-    onUserClaimsChange() {
-        return this.firebaseUser.onUserClaimsChange();
-    }
-    didSelectDevice() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const selectedDevice = yield this.getSelectedDevice();
-            return !!selectedDevice;
-        });
-    }
-    selectDevice(deviceSelector) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const devices = yield this.getDevices();
-            if (!devices) {
-                return Promise.reject(`Did not find any devices for this user. Make sure your device is claimed by your Neurosity account.`);
-            }
-            const deviceTupleSelector = (devices) => devices.find((device) => {
-                if (!Array.isArray(deviceSelector)) {
-                    return false;
-                }
-                const [deviceKey, deviceValue] = deviceSelector;
-                return (JSON.stringify(device === null || device === void 0 ? void 0 : device[deviceKey]) === JSON.stringify(deviceValue));
-            });
-            const device = typeof deviceSelector === "function"
-                ? deviceSelector(devices)
-                : deviceTupleSelector(devices);
-            if (!device) {
-                return Promise.reject(`A device was not provided. Try returning a device from the devicesList provided in the callback.`);
-            }
-            const hasPermission = yield this.firebaseUser.hasDevicePermission(device.deviceId);
-            if (!hasPermission) {
-                return Promise.reject(`Rejected device access due to permissions.`);
-            }
-            this._selectedDevice.next(device);
-            return device;
-        });
-    }
-    getSelectedDevice() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, rxjs_2.firstValueFrom)(this._selectedDevice);
-        });
-    }
-    status() {
-        return this.status$;
-    }
-    observeNamespace(namespace) {
-        const getNamespaceValues = () => (0, rxjs_2.fromEventPattern)((handler) => this.firebaseDevice.onNamespace(namespace, handler), (handler) => this.firebaseDevice.offNamespace(namespace, handler));
-        return this.onDeviceChange().pipe((0, operators_1.switchMap)((selectedDevice) => {
-            return selectedDevice ? getNamespaceValues() : rxjs_1.EMPTY;
-        }));
-    }
-    onceNamespace(namespace) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this.firebaseDevice.onceNamespace(namespace);
-        });
-    }
-    get metrics() {
-        return {
-            next: (metricName, metricValue) => {
-                this.firebaseDevice.nextMetric(metricName, metricValue);
-            },
-            on: (subscription, callback) => {
-                return this.firebaseDevice.onMetric(subscription, callback);
-            },
-            subscribe: (subscription) => {
-                const subscriptionCreated = this.firebaseDevice.subscribeToMetric(subscription);
-                this.subscriptionManager.add(subscriptionCreated);
-                return subscriptionCreated;
-            },
-            unsubscribe: (subscription, listener) => {
-                this.subscriptionManager.remove(subscription);
-                this.firebaseDevice.unsubscribeFromMetric(subscription);
-                this.firebaseDevice.removeMetricListener(subscription, listener);
-            }
-        };
-    }
-    createAccount(credentials) {
-        return this.firebaseUser.createAccount(credentials);
-    }
-    deleteAccount() {
-        return this.firebaseUser.deleteAccount();
-    }
-    createBluetoothToken() {
-        return this.firebaseDevice.createBluetoothToken();
-    }
-    createCustomToken() {
-        return this.firebaseUser.createCustomToken();
-    }
-    removeOAuthAccess() {
-        return this.firebaseUser.removeOAuthAccess();
-    }
-    onUserExperiments() {
-        return this.firebaseUser.onUserExperiments();
-    }
-    deleteUserExperiment(experimentId) {
-        return this.firebaseUser.deleteUserExperiment(experimentId);
-    }
-    get skills() {
-        return {
-            get: (bundleId) => __awaiter(this, void 0, void 0, function* () {
-                return this.firebaseDevice.getSkill(bundleId);
-            })
-        };
-    }
-    get timestamp() {
-        return this.options.timesync ? this.timesync.timestamp : Date.now();
-    }
-    getTimesyncOffset() {
-        return this.timesync.offset;
-    }
-    changeSettings(settings) {
-        return this.firebaseDevice.changeSettings(settings);
-    }
-    goOffline() {
-        this.firebaseApp.goOffline();
-    }
-    goOnline() {
-        this.firebaseApp.goOnline();
-    }
-    /**
-     * @internal
-     */
-    __getApp() {
-        return this.firebaseApp.app;
-    }
-}
-exports.CloudClient = CloudClient;

package/dist/cjs/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Neurosity"), exports);
-__exportStar(require("./api/bluetooth"), exports);

package/dist/cjs/subscriptions/SubscriptionManager.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionManager = void 0;
-/**
- * @hidden
- */
-class SubscriptionManager {
-    constructor() {
-        this._subscriptions = {};
-    }
-    get() {
-        return this._subscriptions;
-    }
-    toList() {
-        return Object.values(this._subscriptions);
-    }
-    add(subscription) {
-        this._subscriptions[subscription.id] = subscription;
-    }
-    remove(subscription) {
-        if (!(subscription.id in this._subscriptions)) {
-            return;
-        }
-        Reflect.deleteProperty(this._subscriptions, subscription.id);
-    }
-}
-exports.SubscriptionManager = SubscriptionManager;

package/dist/cjs/timesync/Timesync.js

@@ -1,78 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Timesync = void 0;
-const rxjs_1 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const operators_2 = require("rxjs/operators");
-const outliers_1 = __importDefault(require("outliers"));
-const whileOnline_1 = require("../utils/whileOnline");
-const defaultOptions = {
-    bufferSize: 100,
-    updateInterval: 1 * 60 * 1000 // every minute
-};
-class Timesync {
-    constructor(options) {
-        this._offset = 0;
-        this.options = Object.assign(Object.assign({}, defaultOptions), options);
-        this.start();
-    }
-    start() {
-        const { bufferSize, updateInterval, status$ } = this.options;
-        const burst$ = (0, rxjs_1.range)(0, bufferSize);
-        const timer$ = (0, rxjs_1.timer)(updateInterval, updateInterval).pipe((0, operators_1.map)((i) => bufferSize + i), (0, whileOnline_1.whileOnline)({
-            status$,
-            allowWhileOnSleepMode: true
-        }));
-        const firstTimeDeviceIsOnline$ = status$.pipe((0, operators_1.filter)((status) => status.state === "online"), (0, operators_1.take)(1));
-        firstTimeDeviceIsOnline$
-            .pipe((0, operators_2.switchMap)(() => {
-            return burst$.pipe((0, operators_1.concatWith)(timer$), this.toOffset(), (0, operators_2.bufferCount)(bufferSize, 1), this.filterOutliers(), (0, operators_1.map)((list) => this.average(list)));
-        }))
-            .subscribe((offset) => {
-            this._offset = offset;
-        });
-    }
-    filterOutliers() {
-        return (0, rxjs_1.pipe)((0, operators_1.map)((offsets) => {
-            return offsets.filter((0, outliers_1.default)());
-        }));
-    }
-    toOffset() {
-        const { getTimesync } = this.options;
-        return (0, rxjs_1.pipe)((0, operators_2.concatMap)(() => __awaiter(this, void 0, void 0, function* () {
-            const requestStartTime = Date.now();
-            const [error, serverTime] = yield getTimesync()
-                .then((offset) => [null, offset])
-                .catch((error) => [error]);
-            if (error) {
-                return 0;
-            }
-            const responseEndTime = Date.now();
-            const oneWayDuration = (responseEndTime - requestStartTime) / 2;
-            const offset = responseEndTime - oneWayDuration - serverTime;
-            return offset;
-        })));
-    }
-    average(list) {
-        return Math.round(list.reduce((acc, number) => acc + number) / list.length);
-    }
-    get offset() {
-        return this._offset;
-    }
-    get timestamp() {
-        return Date.now() + this._offset;
-    }
-}
-exports.Timesync = Timesync;

package/dist/cjs/timesync/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Timesync"), exports);

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

@@ -1,10 +0,0 @@
-export interface Accelerometer {
-    acceleration: number;
-    inclination: number;
-    orientation: number;
-    pitch: number;
-    roll: number;
-    x: number;
-    y: number;
-    z: number;
-}

package/dist/cjs/types/accelerometer.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,16 +0,0 @@
-/**
- * @hidden
- */
-export interface Action {
-    command: string;
-    action: string;
-    message?: any;
-    responseRequired?: boolean;
-    responseTimeout?: number;
-}
-/**
- * @hidden
- */
-export interface Actions {
-    dispatch(action: Action): Promise<any>;
-}

package/dist/cjs/types/actions.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1 +0,0 @@
-export declare type AwarenessLabels = "calm" | "focus";

package/dist/cjs/types/awareness.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,26 +0,0 @@
-export declare type BrainwavesLabel = "raw" | "rawUnfiltered" | "powerByBand" | "psd";
-export declare type AmplitudeByChannel = number[][];
-export interface Epoch {
-    data: AmplitudeByChannel;
-    info: {
-        samplingRate: number;
-        startTime: number;
-    };
-}
-export declare type PSDByChannel = number[][];
-export interface PSD {
-    psd: PSDByChannel;
-    freqs: number[];
-    info: {
-        samplingRate: number;
-        startTime: number;
-    };
-}
-export declare type BandName = "gamma" | "beta" | "alpha" | "theta" | "delta";
-export interface PowerByBand {
-    gamma: number[];
-    beta: number[];
-    alpha: number[];
-    theta: number[];
-    delta: number[];
-}

package/dist/cjs/types/brainwaves.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,6 +0,0 @@
-export interface Calm {
-    metric: "awareness";
-    label: "calm";
-    probability: number;
-    timestamp: number;
-}

package/dist/cjs/types/calm.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,22 +0,0 @@
-import { Observable } from "rxjs";
-import { User } from "@firebase/auth-types";
-import { Actions } from "./actions";
-import { Metrics } from "./metrics";
-import { SkillsClient } from "./skill";
-import { Credentials } from "./credentials";
-import { ChangeSettings } from "./settings";
-/**
- * @hidden
- */
-export interface Client {
-    user: User | null;
-    actions: Actions;
-    disconnect(): Promise<any>;
-    getInfo(): Promise<any>;
-    login?(credentials: Credentials): Promise<any>;
-    observeNamespace(namespace: string): Observable<any>;
-    metrics: Metrics;
-    skills: SkillsClient;
-    timestamp: number;
-    changeSettings(settings: ChangeSettings): Promise<void>;
-}

package/dist/cjs/types/client.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,12 +0,0 @@
-export declare type CustomToken = {
-    customToken: string;
-};
-export declare type EmailAndPassword = {
-    email: string;
-    password: string;
-};
-export declare type OAuthCredentials = {
-    idToken: string;
-    providerId: string;
-};
-export declare type Credentials = EmailAndPassword | OAuthCredentials | CustomToken;

package/dist/cjs/types/credentials.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,18 +0,0 @@
-export interface DeviceInfo {
-    deviceId: string;
-    deviceNickname: string;
-    channelNames: string[];
-    channels: number;
-    samplingRate: number;
-    manufacturer: string;
-    model: string;
-    modelName: string;
-    modelVersion: string;
-    osVersion: string;
-    apiVersion: string;
-    emulator?: boolean;
-}
-declare type DeviceSelectorKeyValue = [string, string | number | string[]];
-declare type DeviceSelectorFunction = (devices: DeviceInfo[]) => DeviceInfo;
-export declare type DeviceSelector = DeviceSelectorKeyValue | DeviceSelectorFunction;
-export {};

package/dist/cjs/types/deviceInfo.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,12 +0,0 @@
-import { Marker } from "./marker";
-/**
- * @hidden
- */
-export declare type Epoch = {
-    data: number[];
-    info?: {
-        channelNames?: string[];
-        samplingRate?: number;
-        marker?: Marker[];
-    };
-};

package/dist/cjs/types/epoch.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,9 +0,0 @@
-export declare type Experiment = {
-    deviceId: string;
-    id: string;
-    labels: string[];
-    name: string;
-    timestamp: number;
-    totalTrials: number;
-    userId: string;
-};

package/dist/cjs/types/experiment.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,6 +0,0 @@
-export interface Focus {
-    metric: "awareness";
-    label: "focus";
-    probability: number;
-    timestamp: number;
-}

package/dist/cjs/types/focus.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });