@formant/data-sdk 1.80.3 → 1.80.4

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

@@ -1,35 +0,0 @@
-import { AccessLevel } from "./AccessLevel";
-import { Resource } from "./Resource";
-export declare const resourcePolicyMap: {
-    organization: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    users: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    devices: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "edit-tags"];
-    roles: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "edit-tags"];
-    billing: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    streams: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    views: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "edit-tags"];
-    channels: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    comments: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    teleop: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    terminal: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    portForwarding: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    events: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    commands: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    annotations: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    capture: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    share: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    fileStorage: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    integrations: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    interventions: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    analytics: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    keyValueStorage: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    schedules: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    kiosk: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-    taskSummaries: readonly ["viewer" | "operator" | "administrator", "viewer" | "operator" | "administrator"];
-};
-export type ResourcePolicy<T extends Resource> = (typeof resourcePolicyMap)[T][number];
-export type Policies = {
-    [_ in Resource]?: ResourcePolicy<_>[];
-};
-export declare function getAccessLevel(policies: ResourcePolicy<Resource>[]): AccessLevel | undefined;
-export declare function includesAccess<T extends Resource = Resource>(accessPolicy: ResourcePolicy<T>[] | undefined, targetPolicy: ResourcePolicy<T>): boolean;

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

@@ -1,3 +0,0 @@
-export type RequireKeys<T> = {
-    [K in keyof T & {}]: T[K];
-};

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

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

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

@@ -1,26 +0,0 @@
-import { IRtcClientConfiguration } from "@formant/realtime-sdk";
-export type SessionType = NonNullable<IRtcClientConfiguration["sessionType"]>;
-export declare const SessionTypes: {
-    readonly UNKNOWN: 0;
-    readonly TELEOP: 1;
-    readonly PORT_FORWARD: 2;
-    readonly OBSERVE: 3;
-    readonly HEADLESS: 4;
-};
-export declare const SessionTypeConstants: {
-    readonly Unknown: 0;
-    readonly Teleop: 1;
-    readonly PortForward: 2;
-    readonly Observe: 3;
-    readonly Headless: 4;
-    readonly unknown: 0;
-    readonly teleop: 1;
-    readonly portForward: 2;
-    readonly observe: 3;
-    readonly headless: 4;
-    readonly UNKNOWN: 0;
-    readonly TELEOP: 1;
-    readonly PORT_FORWARD: 2;
-    readonly OBSERVE: 3;
-    readonly HEADLESS: 4;
-};

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

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

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

@@ -1 +0,0 @@
-export type SortOrder = "asc" | "desc";

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

@@ -1,2 +0,0 @@
-import { IStreamTypeMap } from "./IStreamTypeMap";
-export type StreamType = keyof IStreamTypeMap;

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

@@ -1,9 +0,0 @@
-export interface TelemetryResult {
-    deviceId: string;
-    name: string;
-    points: [number, any][];
-    tags: {
-        [key in string]: string | number;
-    };
-    type: string;
-}

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

@@ -1 +0,0 @@
-export type Timestamp = number;

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

@@ -1 +0,0 @@
-export type Uuid = string;

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

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

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

@@ -1 +0,0 @@
-export declare const accessLevels: readonly ["viewer", "operator", "administrator"];

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

@@ -1,2 +0,0 @@
-import { AggregateLevel } from "./AggregateLevel";
-export declare const aggregateLevels: AggregateLevel[];

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

@@ -1 +0,0 @@
-export declare const aggregateTypes: readonly ["min", "max", "standard deviation", "average", "sum", "count"];

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

@@ -1 +0,0 @@
-export declare const analyticsAggregateTypes: readonly ["avg", "sum", "count", "min", "max"];

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

@@ -1 +0,0 @@
-export declare const analyicsChartTypes: readonly ["line", "bar", "table", "pie", "summary"];

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

@@ -1 +0,0 @@
-export declare const annotationTypes: string[];

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

@@ -1 +0,0 @@
-export declare const cognitoRegions: readonly ["AMER", "EMEA", "JAPAC"];

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

@@ -1 +0,0 @@
-export declare const deviceType: readonly ["default", "capture"];

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

@@ -1 +0,0 @@
-export declare const eventTypes: readonly ["triggered-event", "datapoint-event", "device-online", "device-offline", "intervention-request", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "intervention-response", "custom", "comment", "system", "annotation", "task-summary", "stateful"];

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

@@ -1 +0,0 @@
-export declare const healthStatuses: readonly ["unknown", "operational", "offline", "error"];

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

@@ -1 +0,0 @@
-export declare const interventionTypes: string[];

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

@@ -1 +0,0 @@
-export declare const marker3DActions: readonly ["add", "modify", "delete", "delete_all"];

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

@@ -1 +0,0 @@
-export declare const marker3DTypes: readonly ["arrow", "cube", "sphere", "cylinder", "line_strip", "line_list", "cube_list", "sphere_list", "points", "text_view_facing", "mesh_resource", "triangle_list"];

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

@@ -1 +0,0 @@
-export declare const onDemandBufferTypes: readonly ["s3_asset", "datapoint"];

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

@@ -1 +0,0 @@
-export declare const resources: readonly ["organization", "users", "devices", "roles", "streams", "views", "channels", "comments", "teleop", "terminal", "portForwarding", "events", "commands", "annotations", "capture", "share", "fileStorage", "integrations", "interventions", "analytics", "keyValueStorage", "schedules", "kiosk", "billing", "taskSummaries"];

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

@@ -1 +0,0 @@
-export declare const severities: readonly ["info", "warning", "error", "critical"];

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

@@ -1 +0,0 @@
-export declare const videoMimeTypes: readonly ["video/mp4"];

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

@@ -1,9 +0,0 @@
-import { IChallenge } from "../model/IChallenge";
-export declare class LoginFailureError extends Error {
-    readonly reason: string;
-    constructor(reason: string);
-}
-export declare class LoginChallengedError extends Error {
-    readonly challenge: IChallenge;
-    constructor(challenge: IChallenge);
-}

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

@@ -1,15 +0,0 @@
-import { IChallenge } from "../model/IChallenge";
-import { IAuthentication } from "./IAuthentication";
-export interface AuthSuccessResult {
-    result: "success";
-    authentication: IAuthentication;
-}
-export interface AuthFailedResult {
-    result: "failure";
-    reason: string;
-}
-export interface AuthChallengeResult {
-    result: "challenged";
-    challenge: IChallenge;
-}
-export type AuthenticationResult = AuthSuccessResult | AuthFailedResult | AuthChallengeResult;

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

@@ -1,70 +0,0 @@
-import { AuthenticationResult } from "./AuthenticationResult";
-import { IAuthenticationStore } from "./IAuthenticationStore";
-import { IUser } from "../model/IUser";
-import { IAuthentication } from "./IAuthentication";
-import { ICheckSsoResult } from "./ICheckSsoResult";
-import { IConfirmForgotPasswordRequest } from "./IConfirmForgotPasswordRequest";
-import { IRespondToNewPasswordRequiredChallengeRequest } from "./IRespondToNewPasswordRequiredChallengeRequest";
-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 _apiUrl;
-    private readonly _refreshAuthToken;
-    private readonly _addAccessTokenRefreshListener;
-    constructor({ apiUrl, refreshAuthToken, addAccessTokenRefreshListener, }: IAuthenticationStoreOptions);
-    set apiUrl(url: string);
-    get apiUrl(): string;
-    get token(): string | undefined;
-    get currentUser(): IUser | 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>;
-    login(email: string, password: string, options: {
-        advanced: true;
-    }): Promise<AuthenticationResult>;
-    loginWithToken(token: string, refreshToken?: string): Promise<void>;
-    isAuthenticated(): boolean;
-    loginToPeer(peerUrl: string, username: string, password: string): Promise<void>;
-    /**
-     * @deprecated use currentUser property instead.
-     */
-    getCurrentUser(): IUser | 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>;
-    checkSso(email: string, allowUserAutoCreation?: boolean): Promise<ICheckSsoResult>;
-    loginWithSso(ssoToken: string, ssoRefreshToken?: string): Promise<void>;
-}
-export {};

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

@@ -1,6 +0,0 @@
-export interface IAuthentication {
-    accessToken: string;
-    organizationId: string;
-    refreshToken: string;
-    userId: string;
-}

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

@@ -1,45 +0,0 @@
-import { IUser } from "../model/IUser";
-import { AuthenticationResult } from "./AuthenticationResult";
-import { IAuthentication } from "./IAuthentication";
-import { IConfirmForgotPasswordRequest } from "./IConfirmForgotPasswordRequest";
-import { IRespondToNewPasswordRequiredChallengeRequest } from "./IRespondToNewPasswordRequiredChallengeRequest";
-export interface IAuthenticationStore {
-    readonly token: string | undefined;
-    readonly currentUser: IUser | 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;
-    set apiUrl(url: string);
-    get apiUrl(): string;
-    login(email: string, password: string): Promise<IAuthentication>;
-    login(email: string, password: string, options: {
-        advanced: true;
-    }): Promise<AuthenticationResult>;
-    loginWithToken(token: string, refreshToken?: string): Promise<void>;
-    loginToPeer(peerUrl: string, username: string, password: string): Promise<void>;
-    isAuthenticated(): boolean;
-    getCurrentUser(): IUser | 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/stores/ICheckSsoResult.d.ts

@@ -1,5 +0,0 @@
-export interface ICheckSsoResult {
-    issuer: string;
-    clientId: string;
-    isSso?: boolean;
-}

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

@@ -1,5 +0,0 @@
-export interface IConfirmForgotPasswordRequest {
-    email: string;
-    confirmationCode: string;
-    newPassword: string;
-}

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

@@ -1,5 +0,0 @@
-export interface IRespondToNewPasswordRequiredChallengeRequest {
-    userId: string;
-    session: string;
-    newPassword: string;
-}

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

@@ -1,25 +0,0 @@
-import { RtcClient, RtcClientV1, IRtcClientConfiguration } from "@formant/realtime-sdk";
-type ReceiveFn = IRtcClientConfiguration["receive"];
-type CreateClientFn<T extends RtcClient | RtcClientV1> = (receive: ReceiveFn) => T;
-export interface IRtcClientPoolOptions<T extends RtcClient | RtcClientV1> {
-    createClient: CreateClientFn<T>;
-    ttlMs?: number;
-}
-declare const singleton: unique symbol;
-export declare class RtcClientPool<T extends RtcClient | RtcClientV1> {
-    [singleton]: T | null;
-    private readonly createClient;
-    private readonly ttlMs;
-    private readonly proxyHandler;
-    private proxyReceivers;
-    private teardownTimeout;
-    constructor(options: IRtcClientPoolOptions<T>);
-    get isActive(): boolean;
-    get size(): number;
-    get(onReceive?: ReceiveFn): T;
-    private allocate;
-    private teardown;
-    private dispatch;
-    private releaseInstance;
-}
-export {};

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

@@ -1,38 +0,0 @@
-import { INumericAggregate } from "../model/INumericAggregate";
-import * as dateFns from "date-fns";
-import { AggregateLevel } from "../model/AggregateLevel";
-export declare const vailableAggregationIntervals: readonly ["day", "week", "month", "year", "hour", "minute", "quarter"];
-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 AggregateFunction = {
-    [key in AggregateFunctions]: any;
-};
-export declare function getVariance(a: INumericAggregate): number;
-export declare function getStandardDeviation(a: INumericAggregate): number;
-export declare function getMax(a: INumericAggregate): number;
-export declare function getMin(a: INumericAggregate): number;
-export declare function getAverage(a: INumericAggregate): number;
-export declare function getSum(a: INumericAggregate): number;
-export declare function getCount(a: INumericAggregate): number;
-export declare const aggregateFunctionMap: {
-    min: typeof getMin;
-    max: typeof getMax;
-    "standard deviation": typeof getStandardDeviation;
-    average: typeof getAverage;
-    sum: typeof getSum;
-    count: typeof getCount;
-};
-interface IAggregateFunctions {
-    interval: (interval: dateFns.Interval) => Date[];
-    start: (date: Date | number) => Date;
-    end: (date: Date | number) => Date;
-    sub: (date: Date | number, amount: number) => Date;
-    get: (date: Date | number) => number;
-}
-export declare const aggregateByDateFunctions: Record<AggregateLevel, IAggregateFunctions>;
-export declare const formatTimeFrameText: (start: string, end: string) => string;
-export {};

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

@@ -1 +0,0 @@
-export declare function getCurrentModuleContext(): string | null;

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

@@ -1,2 +0,0 @@
-import { IRtcPeer } from "@formant/realtime-sdk";
-export declare const isRtcPeer: (peer: IRtcPeer | undefined) => peer is IRtcPeer;

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

@@ -1,26 +0,0 @@
-import { INumericAggregate } from "../model/INumericAggregate";
-import { IStreamAggregateData } from "../model/IStreamAggregateData";
-import { IStreamTypeMap } from "../model/IStreamTypeMap";
-export type WireINumericSetAggregateMap = {
-    [id: string]: {
-        value: INumericAggregate;
-        unit?: string;
-    };
-};
-export declare function getZeroINumericSet(): {
-    min: number;
-    max: number;
-    sum: number;
-    count: number;
-    sumOfSquares: number;
-};
-export declare function reduceNumericStreamAggregates(stream: IStreamAggregateData<keyof IStreamTypeMap>): {
-    min: number;
-    max: number;
-    sum: number;
-    count: number;
-    sumOfSquares: number;
-};
-export declare function reduceNumericSetStreamAggregates(stream: IStreamAggregateData<keyof IStreamTypeMap>, numericSetKey: string): INumericAggregate;
-export declare function combineNumericAggregates(e1: INumericAggregate, e2: INumericAggregate): INumericAggregate;
-export declare function combineNumericSetAggregates(e1: WireINumericSetAggregateMap, e2: WireINumericSetAggregateMap): WireINumericSetAggregateMap;

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

@@ -1,2 +0,0 @@
-export declare function serializeHash(value: any): string;
-export declare function deserializeHash(value: string): any;

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

@@ -1 +0,0 @@
-export declare function stringToArrayBuffer(input: string): Uint8Array;

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

@@ -1 +0,0 @@
-export declare const timeout: (s: number) => Promise<unknown>;