@formant/data-sdk 0.0.144 → 0.0.146

package/dist/types/data-sdk/src/App.d.ts

@@ -6,6 +6,10 @@ export interface IDevice {
     tags: ITags;
 }
 export type AppMessage = {
+    type: "request_date";
+    minTime?: Date;
+    maxTime?: Date;
+} | {
     type: "go_to_time";
     time: number;
 } | {
@@ -51,6 +55,9 @@ export type ModuleConfigurationMessage = {
     configuration: string;
 };
 export type EmbeddedAppMessage = {
+    type: "date_response";
+    data: Date;
+} | {
     type: "overview_devices";
     data: IDevice[];
 } | {
@@ -136,4 +143,5 @@ export declare class App {
         okText?: string;
         cancelText?: string;
     }): Promise<any>;
+    static getDate(minTime?: Date, maxTime?: Date): Promise<unknown>;
 }

package/dist/types/data-sdk/src/Authentication.d.ts

@@ -1,52 +1,2 @@
-export interface User {
-    firstName: string;
-    lastName: string;
-    email: string;
-    organizationId: string;
-    id: string;
-}
-export interface IAuthentication {
-    accessToken: string;
-    organizationId: string;
-    refreshToken: string;
-    userId: string;
-}
-export interface IConfirmForgotPasswordRequest {
-    email: string;
-    confirmationCode: string;
-    newPassword: string;
-}
-export interface IRespondToNewPasswordRequiredChallengeRequest {
-    userId: string;
-    session: string;
-    newPassword: string;
-}
-export declare class Authentication {
-    static token: string | undefined;
-    static refreshToken: string | undefined;
-    static currentUser: User | undefined;
-    static currentOrganization: string | undefined;
-    static isShareToken: boolean;
-    static defaultDeviceId: string | undefined;
-    static waitingForAuth: ((result: boolean) => void)[];
-    static login(email: string, password: string): Promise<IAuthentication | Error>;
-    static loginWithToken(token: string, refreshToken?: string): Promise<void>;
-    static isAuthenticated(): boolean;
-    static getCurrentUser(): User | undefined;
-    static waitTilAuthenticated(): Promise<boolean>;
-    static listenForRefresh(): Promise<void>;
-    static forgotPassword(email: string): Promise<void>;
-    /**
-     * @example
-     * // Body
-     * await Authentication.confirmForgotPassword({
-     *     email: "joe@gmail.com"
-     *     confirmationCode: "1",
-     *     newPassword: "NewPassword"
-     *   });
-     */
-    static confirmForgotPassword(request: IConfirmForgotPasswordRequest): Promise<boolean>;
-    static respondToNewPasswordRequiredChallenge(request: IRespondToNewPasswordRequiredChallengeRequest): Promise<any>;
-    static loginWithGoogle(token: string): Promise<any>;
-    static refresh(token: string): Promise<void>;
-}
+import { IAuthenticationStore } from "./stores/IAuthenticationStore";
+export declare const Authentication: IAuthenticationStore;

package/dist/types/data-sdk/src/Device.d.ts

@@ -12,7 +12,7 @@ import { IEventQuery } from "./main";
 import { AggregateLevel } from "./main";
 import { EventType } from "./main";
 import { IShare } from "./model/IShare";
-import { EventEmitter } from 'events';
+import { EventEmitter } from "events";
 export interface ConfigurationDocument {
     urdfFiles: string[];
     telemetry?: {
@@ -155,5 +155,5 @@ export declare class Device extends EventEmitter implements IRealtimeDevice {
         date: string;
         events: import("./main").IEvent[];
     }[]>;
-    createShareLink(share: IShare, view: string): Promise<string>;
+    createShareLink(share: IShare, view: string): Promise<string | null>;
 }

package/dist/types/data-sdk/src/Fleet.d.ts

@@ -200,5 +200,5 @@ export declare class Fleet {
      *      userName: "User",
      *   });
      */
-    static createShareLink(share: IShare, view: string): Promise<string>;
+    static createShareLink(share: IShare, view: string): Promise<string | null>;
 }

package/dist/types/data-sdk/src/main.d.ts

@@ -129,3 +129,4 @@ export * from "./model/ISqlResult";
 export * from "./model/IAnalyticsModuleConfiguration";
 export * from "./model/IAggregateRow";
 export * from "./model/ISqlRow";
+export * from "./stores/IAuthenticationStore";

package/dist/types/data-sdk/src/model/AccessLevel.d.ts

@@ -1,5 +1,5 @@
 import { accessLevels } from "./accessLevels";
-export type AccessLevel = typeof accessLevels[number];
+export type AccessLevel = (typeof accessLevels)[number];
 export declare const viewer: "viewer" | "operator" | "administrator";
 export declare const operator: "viewer" | "operator" | "administrator";
 export declare const administrator: "viewer" | "operator" | "administrator";

package/dist/types/data-sdk/src/model/AnalyticsAggregateType.d.ts

@@ -1,2 +1,2 @@
 import { analyticsAggregateTypes } from "./analyticsAggregteTypes";
-export type AnalyticsAggregateType = typeof analyticsAggregateTypes[number];
+export type AnalyticsAggregateType = (typeof analyticsAggregateTypes)[number];

package/dist/types/data-sdk/src/model/AnalyticsChartType.d.ts

@@ -1,2 +1,2 @@
 import { analyicsChartTypes } from "./analyticsChartTypes";
-export type AnalyticsChartType = typeof analyicsChartTypes[number];
+export type AnalyticsChartType = (typeof analyicsChartTypes)[number];

package/dist/types/data-sdk/src/model/DeviceType.d.ts

@@ -1,2 +1,2 @@
 import { deviceType } from "./deviceTypes";
-export type DeviceType = typeof deviceType[number];
+export type DeviceType = (typeof deviceType)[number];

package/dist/types/data-sdk/src/model/EventType.d.ts

@@ -1,2 +1,2 @@
 import { eventTypes } from "./eventTypes";
-export type EventType = typeof eventTypes[number];
+export type EventType = (typeof eventTypes)[number];

package/dist/types/data-sdk/src/model/HealthStatus.d.ts

@@ -1,2 +1,2 @@
 import { healthStatuses } from "./healthStatuses";
-export type HealthStatus = typeof healthStatuses[number];
+export type HealthStatus = (typeof healthStatuses)[number];

package/dist/types/data-sdk/src/model/Severity.d.ts

@@ -1,2 +1,2 @@
 import { severities } from "./severities";
-export type Severity = typeof severities[number];
+export type Severity = (typeof severities)[number];

package/dist/types/data-sdk/src/model/VideoMimeType.d.ts

@@ -1,2 +1,2 @@
 import { videoMimeTypes } from "./videoMimeTypes";
-export type VideoMimeType = typeof videoMimeTypes[number];
+export type VideoMimeType = (typeof videoMimeTypes)[number];

package/dist/types/data-sdk/src/stores/AuthenticationStore.d.ts

@@ -0,0 +1,56 @@
+import { User, IAuthentication, IAuthenticationStore, IConfirmForgotPasswordRequest, IRespondToNewPasswordRequiredChallengeRequest } from "./IAuthenticationStore";
+interface IAuthenticationStoreOptions {
+    apiUrl: string;
+    refreshAuthToken: () => void;
+    addAccessTokenRefreshListener: (callback: (token: string) => void) => void;
+}
+export declare class AuthenticationStore implements IAuthenticationStore {
+    private _refreshToken;
+    private _isShareToken;
+    private _currentOrganization;
+    private _currentUser;
+    private _defaultDeviceId;
+    private _token;
+    private _waitingForAuth;
+    private _refreshTimer;
+    private readonly _apiUrl;
+    private readonly _refreshAuthToken;
+    private readonly _addAccessTokenRefreshListener;
+    constructor({ apiUrl, refreshAuthToken, addAccessTokenRefreshListener, }: IAuthenticationStoreOptions);
+    get token(): string | undefined;
+    get currentUser(): User | undefined;
+    get currentOrganization(): string | undefined;
+    get defaultDeviceId(): string | undefined;
+    /**
+     * @deprecated Do not use directly. This will be removed in future versions of the API
+     */
+    get refreshToken(): string | undefined;
+    /**
+     * @deprecated Do not use directly. This will be removed in future versions of the API
+     */
+    get isShareToken(): boolean;
+    login(email: string, password: string): Promise<IAuthentication | Error>;
+    loginWithToken(token: string, refreshToken?: string): Promise<void>;
+    isAuthenticated(): boolean;
+    /**
+     * @deprecated use currentUser property instead.
+     */
+    getCurrentUser(): User | undefined;
+    waitTilAuthenticated(): Promise<boolean>;
+    listenForRefresh(): Promise<void>;
+    forgotPassword(email: string): Promise<void>;
+    /**
+     * @example
+     * // Body
+     * await this.confirmForgotPassword({
+     *     email: "joe@gmail.com"
+     *     confirmationCode: "1",
+     *     newPassword: "NewPassword"
+     *   });
+     */
+    confirmForgotPassword(request: IConfirmForgotPasswordRequest): Promise<boolean>;
+    respondToNewPasswordRequiredChallenge(request: IRespondToNewPasswordRequiredChallengeRequest): Promise<any>;
+    loginWithGoogle(token: string): Promise<any>;
+    refresh(token: string): Promise<void>;
+}
+export {};

package/dist/types/data-sdk/src/stores/IAuthenticationStore.d.ts

@@ -0,0 +1,58 @@
+export interface User {
+    firstName: string;
+    lastName: string;
+    email: string;
+    organizationId: string;
+    roleId: string;
+    id: string;
+}
+export interface IAuthentication {
+    accessToken: string;
+    organizationId: string;
+    refreshToken: string;
+    userId: string;
+}
+export interface IConfirmForgotPasswordRequest {
+    email: string;
+    confirmationCode: string;
+    newPassword: string;
+}
+export interface IRespondToNewPasswordRequiredChallengeRequest {
+    userId: string;
+    session: string;
+    newPassword: string;
+}
+export interface IAuthenticationStore {
+    readonly token: string | undefined;
+    readonly currentUser: User | undefined;
+    readonly currentOrganization: string | undefined;
+    readonly defaultDeviceId: string | undefined;
+    /**
+     * @deprecated Do not use directly. This will be removed in future versions of the API
+     */
+    readonly refreshToken: string | undefined;
+    /**
+     * @deprecated Do not use directly. This will be removed in future versions of the API
+     */
+    readonly isShareToken: boolean;
+    login(email: string, password: string): Promise<IAuthentication | Error>;
+    loginWithToken(token: string, refreshToken?: string): Promise<void>;
+    isAuthenticated(): boolean;
+    getCurrentUser(): User | undefined;
+    waitTilAuthenticated(): Promise<boolean>;
+    listenForRefresh(): Promise<void>;
+    forgotPassword(email: string): Promise<void>;
+    /**
+     * @example
+     * // Body
+     * await this.confirmForgotPassword({
+     *     email: "joe@gmail.com"
+     *     confirmationCode: "1",
+     *     newPassword: "NewPassword"
+     *   });
+     */
+    confirmForgotPassword(request: IConfirmForgotPasswordRequest): Promise<boolean>;
+    respondToNewPasswordRequiredChallenge(request: IRespondToNewPasswordRequiredChallengeRequest): Promise<any>;
+    loginWithGoogle(token: string): Promise<any>;
+    refresh(token: string): Promise<void>;
+}

package/dist/types/data-sdk/src/utils/aggregateFunctionUtils.d.ts

@@ -1,11 +1,11 @@
 import { INumericAggregate } from "../model/INumericAggregate";
 export declare const vailableAggregationIntervals: readonly ["day", "week", "month", "year", "hour", "minute", "quarter"];
-export type ValidAggregationInterval = typeof vailableAggregationIntervals[number];
+export type ValidAggregationInterval = (typeof vailableAggregationIntervals)[number];
 export type IAggregateByDateFunctions = {
     [key in ValidAggregationInterval]: AggregateFunction;
 };
 export declare const aggregateFunctions: readonly ["interval", "start", "end", "sub", "get"];
-export type AggregateFunctions = typeof aggregateFunctions[number];
+export type AggregateFunctions = (typeof aggregateFunctions)[number];
 export type AggregateFunction = {
     [key in AggregateFunctions]: any;
 };

package/package.json

@@ -18,27 +18,39 @@
       "require": "./dist/data-sdk.umd.js"
     }
   },
-  "version": "0.0.144",
+  "version": "0.0.146",
   "scripts": {
     "dev": "vite --port 9146",
     "build": "tsc && vite build",
     "serve": "vite preview",
-    "types": "tsc src/*.ts --lib ESNext,DOM --declaration --emitDeclarationOnly --downlevelIteration --outDir dist/types",
+    "test": "concurrently --kill-others-on-fail npm:test:*",
+    "test:unit": "vitest run",
+    "coverage": "vitest run --coverage",
+    "prettier:check": "prettier --check src/",
+    "prettier:write": "prettier --write src/",
+    "types": "tsc --project ./tsconfig.types.json",
     "docs": "typedoc src/main.ts --theme default --out ../../docs/data-sdk/"
   },
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
     "@rollup/plugin-node-resolve": "^15.0.2",
-    "@types/node": "^18.15.11",
-    "typedoc": "^0.22.13",
-    "typescript": "^4.9.3",
-    "vite": "^4.1.0",
-    "grpc-web": "1.2.1"
+    "@types/node": "^18.16.3",
+    "@vitest/coverage-c8": "^0.30.1",
+    "concurrently": "^8.0.1",
+    "grpc-web": "1.2.1",
+    "prettier": "2.8.8",
+    "typedoc": "^0.24.6",
+    "typescript": "^5.0.4",
+    "vite": "^4.3.3",
+    "vitest": "^0.30.1"
   },
   "types": "./dist/types/data-sdk/src/main.d.ts",
   "dependencies": {
     "@formant/realtime-sdk": "0.0.20",
-    "date-fns": "^2.29.3"
+    "date-fns": "^2.30.0"
+  },
+  "engines": {
+    "node": "^18.12.0 || ^16.13.0"
   }
 }