@neurosity/sdk 6.1.1 → 6.2.1-next.0

package/dist/esm/utils/oauth.js

@@ -1,64 +0,0 @@
-import * as errors from "../utils/errors";
-const scopeRequiredByAction = {
-    "marker/add": "write:brainwave-markers",
-    "brainwaves/record": "write:brainwaves",
-    "haptics/queue": "write:haptics",
-    "training/record": "write:kinesis",
-    "training/stop": "write:kinesis",
-    "training/stopAll": "write:kinesis",
-    "wifi/reset": "write:wifi-settings"
-};
-const scopeRequiredByFunctionName = {
-    //metrics
-    accelerometer: "read:accelerometer",
-    brainwaves: "read:brainwaves",
-    calm: "read:calm",
-    focus: "read:focus",
-    kinesis: "read:kinesis",
-    predictions: "read:kinesis",
-    signalQuality: "read:signal-quality",
-    // end of metrics
-    // device info
-    getInfo: "read:devices-info",
-    getSelectedDevice: "read:devices-info",
-    selectDevice: "read:devices-info",
-    onDeviceChange: "read:devices-info",
-    onUserDevicesChange: "read:devices-info",
-    // end device info
-    settings: "read:devices-settings",
-    changeSettings: "write:devices-settings",
-    status: "read:devices-status",
-    addDevice: "write:devices-add",
-    removeDevice: "write:devices-remove",
-    transferDevice: "write:devices-remove"
-};
-export function validateOAuthScopeForAction(userClaims, action) {
-    const { oauth, scopes: scopesString } = userClaims !== null && userClaims !== void 0 ? userClaims : {};
-    if (!oauth) {
-        return [false, null];
-    }
-    const scopes = scopesString.split(",");
-    const { command, action: actionName } = action;
-    const requiredScope = scopeRequiredByAction[`${command}/${actionName}`];
-    const hasRequireScopes = scopes.includes(requiredScope);
-    if (hasRequireScopes) {
-        return [false, null];
-    }
-    return [true, getScopeError(requiredScope)];
-}
-export function validateOAuthScopeForFunctionName(userClaims, functionName) {
-    const { oauth, scopes: scopesString } = userClaims !== null && userClaims !== void 0 ? userClaims : {};
-    if (!oauth) {
-        return [false, null];
-    }
-    const scopes = scopesString.split(",");
-    const requiredScope = scopeRequiredByFunctionName[functionName];
-    const hasRequireScopes = scopes.includes(requiredScope);
-    if (hasRequireScopes) {
-        return [false, null];
-    }
-    return [true, getScopeError(requiredScope)];
-}
-function getScopeError(...requiredScopes) {
-    return new Error(`${errors.prefix}You are trying to access data with an OAuth token without access to the following scopes: ${requiredScopes.join(", ")}.`);
-}

package/dist/esm/utils/pick.d.ts

@@ -1 +0,0 @@
-export declare const pick: (object: any, props: any) => any;

package/dist/esm/utils/pick.js

@@ -1 +0,0 @@
-export const pick = (object, props) => props.reduce((acc, prop) => (Object.assign(Object.assign({}, acc), (object.hasOwnProperty(prop) ? { [prop]: object[prop] } : {}))), {});

package/dist/esm/utils/pipes.d.ts

@@ -1,46 +0,0 @@
-/**
- * Annotates stream with user-defined metadata
- * @method addInfo
- * @example eeg$.pipe(addinfo({ samplingRate: 256, channelNames: ["Af7", "Fp1", "Fp2", "Af8"] })
- * @param {Object} info Info to be added to the EEG stream. Relevant info may include: `samplingRate` and `channelNames`
- * @returns {Observable<Sample|Epoch|PSD>}
- */
-export declare const addInfo: (infoValue: any) => import("rxjs").UnaryFunction<import("rxjs").Observable<any>, import("rxjs").Observable<any>>;
-/**
- * Takes an array or RxJS buffer of EEG Samples and returns an Epoch.
- * @method bufferToEpoch
- * @example eeg$.pipe(bufferTime(1000), bufferToEpoch({ samplingRate: 256 }))
- *
- * @param {Object} options - Data structure options
- * @param {number} [options.samplingRate] Sampling rate
- * @param {string} [options.dataProp='data'] Name of the key associated with eeg data
- *
- * @returns {Observable<Epoch>}
- */
-export declare const bufferToEpoch: ({ samplingRate, dataProp }?: {
-    samplingRate?: number;
-    dataProp?: string;
-}) => import("rxjs").UnaryFunction<import("rxjs").Observable<unknown>, import("rxjs").Observable<{
-    [x: string]: any;
-    info: any;
-}>>;
-/**
- * Converts a stream of individual Samples of EEG data into a stream of Epochs of a given duration emitted at specified interval. This operator functions similarly to a circular buffer internally and allows overlapping Epochs of data to be emitted (e.g. emitting the last one second of data every 100ms).
- * @method epoch
- * @example eeg$.pipe(epoch({ duration: 1024, interval: 100, samplingRate: 256 }))
- * @param {Object} options - Epoching options
- * @param {number} [options.duration=256] Number of samples to include in each epoch
- * @param {number} [options.interval=100] Time (ms) between emitted Epochs
- * @param {number} [options.samplingRate=256] Sampling rate
- * @param {string} [options.dataProp='data'] Name of the key associated with eeg data
- * @returns {Observable} Epoch
- */
-export declare const epoch: ({ duration, interval, samplingRate, dataProp }: {
-    duration: any;
-    interval: any;
-    samplingRate: any;
-    dataProp?: string;
-}) => import("rxjs").UnaryFunction<import("rxjs").Observable<unknown>, import("rxjs").Observable<{
-    [x: string]: any;
-    info: any;
-}>>;

package/dist/esm/utils/pipes.js

@@ -1,65 +0,0 @@
-import { pipe } from "rxjs";
-import { bufferCount, scan, filter, map } from "rxjs/operators";
-const defaultDataProp = "data";
-const defaultSamplingRate = 256;
-const isObject = (object) => object instanceof Object && object === Object(object);
-const isFunction = (object) => typeof object === "function";
-const patch = (sample) => (info) => {
-    var _a;
-    return (Object.assign(Object.assign({}, sample), { info: Object.assign(Object.assign({}, ((_a = sample === null || sample === void 0 ? void 0 : sample.info) !== null && _a !== void 0 ? _a : {})), (info || {})) }));
-};
-/**
- * Annotates stream with user-defined metadata
- * @method addInfo
- * @example eeg$.pipe(addinfo({ samplingRate: 256, channelNames: ["Af7", "Fp1", "Fp2", "Af8"] })
- * @param {Object} info Info to be added to the EEG stream. Relevant info may include: `samplingRate` and `channelNames`
- * @returns {Observable<Sample|Epoch|PSD>}
- */
-export const addInfo = (infoValue) => pipe(map((sample) => {
-    if (!isObject(sample) ||
-        (!isObject(infoValue) && !isFunction(infoValue))) {
-        return sample;
-    }
-    const info = isFunction(infoValue) ? infoValue(sample) : infoValue;
-    return patch(sample)(info);
-}));
-/**
- * Get a 2D data array organized by channel from an array of Samples. Credit to Ken from Seattle's elegant transposition
- * http://www.codesuck.com/2012/02/transpose-javascript-array-in-one-line.html
- * @method groupByChannel
- * @param {Array<Sample>} samplesBuffer Array of Samples to be grouped
- * @param {string} [dataProp] Name of the key associated with EEG data
- * @returns {Array<Array<number>>}
- */
-const groupByChannel = (samplesBuffer, dataProp = defaultDataProp) => samplesBuffer[0][dataProp].map((_, channelIndex) => samplesBuffer.map((sample) => sample[dataProp][channelIndex]));
-/**
- * Takes an array or RxJS buffer of EEG Samples and returns an Epoch.
- * @method bufferToEpoch
- * @example eeg$.pipe(bufferTime(1000), bufferToEpoch({ samplingRate: 256 }))
- *
- * @param {Object} options - Data structure options
- * @param {number} [options.samplingRate] Sampling rate
- * @param {string} [options.dataProp='data'] Name of the key associated with eeg data
- *
- * @returns {Observable<Epoch>}
- */
-export const bufferToEpoch = ({ samplingRate = defaultSamplingRate, dataProp = defaultDataProp } = {}) => pipe(map((samplesArray) => ({
-    [dataProp]: groupByChannel(samplesArray, dataProp),
-    info: Object.assign(Object.assign({}, (samplesArray[0] && samplesArray[0].info
-        ? samplesArray[0].info
-        : {})), { startTime: samplesArray[0].timestamp, samplingRate: samplesArray[0].info && samplesArray[0].info.samplingRate
-            ? samplesArray[0].info.samplingRate
-            : samplingRate })
-})));
-/**
- * Converts a stream of individual Samples of EEG data into a stream of Epochs of a given duration emitted at specified interval. This operator functions similarly to a circular buffer internally and allows overlapping Epochs of data to be emitted (e.g. emitting the last one second of data every 100ms).
- * @method epoch
- * @example eeg$.pipe(epoch({ duration: 1024, interval: 100, samplingRate: 256 }))
- * @param {Object} options - Epoching options
- * @param {number} [options.duration=256] Number of samples to include in each epoch
- * @param {number} [options.interval=100] Time (ms) between emitted Epochs
- * @param {number} [options.samplingRate=256] Sampling rate
- * @param {string} [options.dataProp='data'] Name of the key associated with eeg data
- * @returns {Observable} Epoch
- */
-export const epoch = ({ duration, interval, samplingRate, dataProp = defaultDataProp }) => pipe(bufferCount(interval), scan((acc, val) => acc.concat(val).slice(acc.length < duration ? 0 : -duration)), filter((samplesArray) => samplesArray.length === duration), bufferToEpoch({ samplingRate, dataProp }));

package/dist/esm/utils/platform.d.ts

@@ -1,30 +0,0 @@
-export declare const MODEL_VERSION_1 = "1";
-export declare const MODEL_VERSION_2 = "2";
-export declare const MODEL_VERSION_3 = "3";
-export declare const FEATURE_HAPTICS = "haptics";
-export declare const FEATURE_ACCEL = "accel";
-export declare const HAPTIC_P7 = "P7";
-export declare const HAPTIC_P8 = "P8";
-export declare const platformFeaturesByModelVersion: {
-    1: any[];
-    2: string[];
-    3: string[];
-};
-export declare const platformConfigByModelVersion: {
-    1: {};
-    2: {
-        motorByMotorName: {
-            P7: any[];
-            P8: any[];
-        };
-    };
-    3: {
-        motorByMotorName: {
-            P7: any[];
-            P8: any[];
-        };
-    };
-};
-export declare const supportsHaptics: (modelVersion: string) => boolean;
-export declare const supportsAccel: (modelVersion: string) => boolean;
-export declare const getPlatformHapticMotors: (modelVersion: string) => any;

package/dist/esm/utils/platform.js

@@ -1,41 +0,0 @@
-export const MODEL_VERSION_1 = "1";
-export const MODEL_VERSION_2 = "2";
-export const MODEL_VERSION_3 = "3";
-export const FEATURE_HAPTICS = "haptics";
-export const FEATURE_ACCEL = "accel";
-export const HAPTIC_P7 = "P7";
-export const HAPTIC_P8 = "P8";
-export const platformFeaturesByModelVersion = {
-    [MODEL_VERSION_1]: [],
-    [MODEL_VERSION_2]: [FEATURE_HAPTICS, FEATURE_ACCEL],
-    [MODEL_VERSION_3]: [FEATURE_HAPTICS, FEATURE_ACCEL]
-};
-export const platformConfigByModelVersion = {
-    [MODEL_VERSION_1]: {},
-    [MODEL_VERSION_2]: {
-        motorByMotorName: {
-            [HAPTIC_P7]: [],
-            [HAPTIC_P8]: []
-        }
-    },
-    [MODEL_VERSION_3]: {
-        motorByMotorName: {
-            [HAPTIC_P7]: [],
-            [HAPTIC_P8]: []
-        }
-    }
-};
-export const supportsHaptics = (modelVersion) => {
-    const platformFeaturesForModel = platformFeaturesByModelVersion[modelVersion];
-    return platformFeaturesForModel.includes(FEATURE_HAPTICS);
-};
-export const supportsAccel = (modelVersion) => {
-    const platformFeaturesForModel = platformFeaturesByModelVersion[modelVersion];
-    return platformFeaturesForModel.includes(FEATURE_ACCEL);
-};
-export const getPlatformHapticMotors = (modelVersion) => {
-    var _a;
-    const platformConfigForModel = platformConfigByModelVersion[modelVersion];
-    const platformMotorByMotorName = (_a = platformConfigForModel === null || platformConfigForModel === void 0 ? void 0 : platformConfigForModel.motorByMotorName) !== null && _a !== void 0 ? _a : {};
-    return Object.assign({}, platformMotorByMotorName);
-};

package/dist/esm/utils/subscription.d.ts

@@ -1,6 +0,0 @@
-import { SDKOptions } from "../types/options";
-export declare const isMetric: (metric: string) => boolean;
-export declare const getLabels: (metric: string) => string[];
-export declare const hasInvalidLabels: (metric: string, labels: string[]) => boolean;
-export declare const isMetricDisallowed: (metricName: string, options: SDKOptions) => boolean;
-export declare const validate: (metric: string, labels: string[], options: SDKOptions) => Error | false;

package/dist/esm/utils/subscription.js

@@ -1,24 +0,0 @@
-import { metrics } from "@neurosity/ipk";
-import * as errors from "../utils/errors";
-export const isMetric = (metric) => Object.keys(metrics).includes(metric);
-export const getLabels = (metric) => Object.keys(metrics[metric]);
-export const hasInvalidLabels = (metric, labels) => {
-    const validLabels = getLabels(metric);
-    return !labels.every((label) => validLabels.includes(label));
-};
-export const isMetricDisallowed = (metricName, options) => "skill" in options &&
-    "metrics" in options.skill &&
-    !options.skill.metrics.includes(metricName);
-export const validate = (metric, labels, options) => {
-    const validLabels = getLabels(metric).join(", ");
-    if (!labels.length) {
-        return new Error(`${errors.prefix}At least one label is required for ${metric} metric. Please add one of the following labels: ${validLabels}`);
-    }
-    if (isMetricDisallowed(metric, options)) {
-        return new Error(`${errors.prefix}No permission to access the ${metric} metric. To access this metric, edit the skill's permissions`);
-    }
-    if (hasInvalidLabels(metric, labels)) {
-        return new Error(`${errors.prefix}One ore more labels provided to ${metric} are invalid. The valid labels for ${metric} are ${validLabels}`);
-    }
-    return false;
-};

package/dist/esm/utils/transferDevice.d.ts

@@ -1,9 +0,0 @@
-export declare type TransferDeviceByEmail = {
-    recipientsEmail: string;
-    deviceId: string;
-};
-export declare type TransferDeviceByUserId = {
-    recipientsUserId: string;
-    deviceId: string;
-};
-export declare type TransferDeviceOptions = TransferDeviceByEmail | TransferDeviceByUserId;

package/dist/esm/utils/transferDevice.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/utils/whileOnline.d.ts

@@ -1,8 +0,0 @@
-import { Observable } from "rxjs";
-import { DeviceStatus } from "../types/status";
-declare type Options = {
-    status$: Observable<DeviceStatus>;
-    allowWhileOnSleepMode: boolean;
-};
-export declare function whileOnline({ status$, allowWhileOnSleepMode }: Options): import("rxjs").UnaryFunction<Observable<unknown>, Observable<any>>;
-export {};

package/dist/esm/utils/whileOnline.js

@@ -1,11 +0,0 @@
-import { pipe, of, EMPTY } from "rxjs";
-import { mergeMap, withLatestFrom } from "rxjs/operators";
-export function whileOnline({ status$, allowWhileOnSleepMode }) {
-    return pipe(withLatestFrom(status$), mergeMap(([value, status]) => shouldAllowMetrics(status, allowWhileOnSleepMode)
-        ? of(value)
-        : EMPTY));
-}
-function shouldAllowMetrics(status, allowWhileOnSleepMode) {
-    return (status.state === "online" &&
-        (allowWhileOnSleepMode ? true : !status.sleepMode));
-}

package/dist/examples/auth.html

@@ -1,32 +0,0 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Neurosity SDK - Auth Inheritance</title></head><body> <pre>View source</pre> <script src="//www.gstatic.com/firebasejs/7.2.0/firebase-app.js"></script> <script src="//www.gstatic.com/firebasejs/7.2.0/firebase-auth.js"></script> <script src="//www.gstatic.com/firebasejs/7.2.0/firebase-database.js"></script> <script type="module">
-      import { Neurosity } from "./neurosity.mjs";
-
-      const config = {
-        apiKey: "AIzaSyB0TkZ83Fj0CIzn8AAmE-Osc92s3ER8hy8",
-        authDomain: "neurosity-device.firebaseapp.com",
-        databaseURL: "https://neurosity-device.firebaseio.com",
-        projectId: "neurosity-device",
-        storageBucket: "neurosity-device.appspot.com",
-        messagingSenderId: "212595049674"
-      };
-
-      firebase.initializeApp(config);
-
-      (async () => {
-        await firebase.auth().signInWithEmailAndPassword("email", "password");
-
-        firebase.auth().onAuthStateChanged((user) => {
-          console.log("app user", user ? user.uid : null);
-        });
-
-        const neurosity = new Neurosity({
-          deviceId: "deviceId"
-        });
-
-        // Neurosity login is not required since a previously
-        // defined neurosity firebase app is used for Neurosity
-
-        const info = await neurosity.getInfo();
-        console.log("info", info);
-      })();
-    </script> </body></html>

package/dist/examples/cloud.html

@@ -1,17 +0,0 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Neurosity SDK - Cloud mode</title></head><body> <pre>View source</pre> <script type="module">
-      import { Neurosity } from "./neurosity.mjs";
-
-      (async () => {
-        const neurosity = new Neurosity({
-          deviceId: process.env.NEUROSITY_DEVICE_ID
-        });
-
-        await neurosity.login({
-          email: process.env.NEUROSITY_EMAIL,
-          password: process.env.NEUROSITY_PASSWORD
-        });
-
-        const info = await neurosity.getInfo();
-        console.log("info", info);
-      })();
-    </script> </body></html>

package/dist/examples/index.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Neurosity SDK - Examples</title></head><body> <ul> <li><a href="/auth.html">Auth</a></li> <li><a href="/cloud.html">Cloud</a></li> <li><a href="/training.html">Training</a></li> </ul> </body></html>