@formant/data-sdk 1.64.0 → 1.66.0

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

@@ -0,0 +1,27 @@
+import { IBattery } from "./IBattery";
+import { IBitset } from "./IBitset";
+import { IFile } from "./IFile";
+import { IHealth } from "./IHealth";
+import { IImage } from "./IImage";
+import { ILocalization } from "./ILocalization";
+import { ILocation } from "./ILocation";
+import { INumericSetEntry } from "./INumericSetEntry";
+import { IPointCloud } from "./IPointCloud";
+import { ITransformNode } from "./ITransformNode";
+import { IVideo } from "./IVideo";
+export interface IStreamTypeMap {
+    bitset: IBitset;
+    localization: ILocalization;
+    "point cloud": IPointCloud;
+    location: ILocation;
+    file: IFile;
+    health: IHealth;
+    "transform tree": ITransformNode;
+    battery: IBattery;
+    video: IVideo;
+    "numeric set": INumericSetEntry[];
+    json: string;
+    image: IImage;
+    numeric: number;
+    text: string;
+}

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

@@ -0,0 +1,3 @@
+import { IBaseEvent } from "./IBaseEvent";
+export interface ISystemEvent extends IBaseEvent<"system"> {
+}

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

@@ -0,0 +1,3 @@
+export interface ITagParameters {
+    choices: string[];
+}

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

@@ -0,0 +1,3 @@
+export interface ITagSets {
+    [key: string]: string[];
+}

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

@@ -0,0 +1,5 @@
+import { IBaseEntity } from "./IBaseEntity";
+import { ITags } from "./ITags";
+export interface ITaggedEntity extends IBaseEntity {
+    tags: ITags;
+}

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

@@ -0,0 +1,4 @@
+import { Uuid } from "./Uuid";
+export interface ITaggedUsers {
+    [key: string]: Uuid[];
+}

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

@@ -0,0 +1,3 @@
+export interface ITags {
+    [key: string]: string;
+}

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

@@ -0,0 +1,7 @@
+import { ISqlColumn } from "./ISqlColumn";
+export interface ITaskReportColumn {
+    tableName: string;
+    columns?: ISqlColumn[];
+    name: string;
+    yAxis?: string;
+}

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

@@ -0,0 +1,13 @@
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface ITaskSummary extends IBaseEvent<"task-summary"> {
+    taskSummaryFormatId: Uuid;
+    report: {
+        [key: string]: any;
+    };
+    taskId: string;
+    deviceId: Uuid;
+    generatedAt: IsoDate;
+    deletedAt?: IsoDate | null;
+}

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

@@ -0,0 +1,3 @@
+export interface ITeleopRequestData {
+    instruction: string;
+}

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

@@ -0,0 +1,4 @@
+export interface ITeleopResponseData {
+    state: "inProgress" | "requestAssistance" | "success" | "failure";
+    notes?: string;
+}

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

@@ -0,0 +1,3 @@
+import { IRtcSessionRecord } from "./IRtcSessionRecord";
+export interface ITeleopSessionRecord extends IRtcSessionRecord<"teleop-session-record"> {
+}

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

@@ -0,0 +1,6 @@
+import { IQuaternion } from "./IQuaternion";
+import { IVector3 } from "./IVector3";
+export interface ITransform {
+    translation: IVector3;
+    rotation: IQuaternion;
+}

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

@@ -0,0 +1,7 @@
+import { ITransform } from "./ITransform";
+export interface ITransformNode {
+    name?: string;
+    transform?: ITransform;
+    children?: ITransformNode[];
+    url?: string;
+}

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

@@ -0,0 +1,11 @@
+import { EventType } from "./EventType";
+import { IBaseEvent } from "./IBaseEvent";
+import { IsoDate } from "./IsoDate";
+import { Severity } from "./Severity";
+import { Uuid } from "./Uuid";
+export interface ITriggeredEvent<T extends EventType = EventType> extends IBaseEvent<T> {
+    severity: Severity;
+    eventTriggerId: Uuid;
+    interval?: number;
+    intervalStart?: IsoDate;
+}

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

@@ -0,0 +1,5 @@
+import { IVector3 } from "./IVector3";
+export interface ITwist {
+    linear: IVector3;
+    angular: IVector3;
+}

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

@@ -0,0 +1,29 @@
+import { ITaggedEntity } from "./ITaggedEntity";
+import { Uuid } from "./Uuid";
+import { IsoDate } from "./IsoDate";
+import { CognitoRegion } from "./CognitoRegion";
+import { IUserScope } from "./IUserScope";
+export interface IUser extends ITaggedEntity {
+    organizationId?: Uuid;
+    accountId?: Uuid | null;
+    roleId: Uuid | null;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    scope?: IUserScope | null;
+    teamId?: Uuid | null;
+    eventTriggerGroupId?: Uuid | null;
+    phoneNumber?: string;
+    enabled?: boolean;
+    isOrganizationOwner?: boolean;
+    termsAccepted?: string;
+    lastLoggedIn?: IsoDate;
+    passwordHash?: string | null;
+    isSingleSignOn?: boolean;
+    isServiceAccount?: boolean;
+    region: CognitoRegion;
+    jobTitle?: string;
+    language?: string;
+    units?: string;
+    timezone?: string;
+}

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

@@ -0,0 +1,4 @@
+import { AccessLevel } from "./AccessLevel";
+export interface IUserParameters {
+    roles?: AccessLevel[];
+}

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

@@ -0,0 +1,15 @@
+import { IScopeFilter } from "./IScopeFilter";
+import { RequireKeys } from "./RequiredKeys";
+export interface IUserResourceScope {
+    roles?: IScopeFilter;
+    users?: IScopeFilter;
+    teams?: IScopeFilter;
+    devices?: IScopeFilter;
+    fleets?: IScopeFilter;
+    events?: IScopeFilter;
+    views?: IScopeFilter;
+}
+export interface IUserScope extends IScopeFilter, IUserResourceScope {
+}
+export type IFullUserScope = IScopeFilter & RequireKeys<IUserResourceScope>;
+export declare const fullAccessUserScope: IFullUserScope;

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

@@ -0,0 +1,4 @@
+export interface IVector2 {
+    x: number;
+    y: number;
+}

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

@@ -0,0 +1,5 @@
+export interface IVector3 {
+    x: number;
+    y: number;
+    z: number;
+}

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

@@ -0,0 +1,7 @@
+import { VideoMimeType } from "./VideoMimeType";
+export interface IVideo {
+    url: string;
+    size?: number;
+    duration: number;
+    mimeType: VideoMimeType;
+}

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

@@ -0,0 +1,4 @@
+export interface IVideoDevice {
+    path: string;
+    name: string;
+}

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

@@ -0,0 +1,15 @@
+import { IsoDate } from "./IsoDate";
+import { Uuid } from "./Uuid";
+export interface IView {
+    id: Uuid;
+    createdAt: IsoDate;
+    updatedAt: IsoDate;
+    organizationId: Uuid;
+    name: string;
+    url: string;
+    showOnSingleDevice: boolean;
+    showOnMultiDevice: boolean;
+    showOnTeleop: boolean;
+    showOnAnalytics: boolean;
+    showTimeline: boolean;
+}

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

@@ -0,0 +1,4 @@
+import { Uuid } from "./Uuid";
+export interface IDeviceFollower {
+    userId: Uuid;
+}

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

@@ -0,0 +1,4 @@
+import { INetwork } from "./INetwork";
+export interface INetworkInfo {
+    networks: INetwork[];
+}

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

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

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

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

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

@@ -0,0 +1,39 @@
+import { StreamType } from "./StreamType";
+export type FieldType = "string" | "integer" | "number" | "array" | "object" | "boolean";
+export interface IJsonBaseSchema<T extends FieldType> {
+    title?: string;
+    description?: string;
+    type: T;
+    required?: string[];
+    $schema?: string;
+    "$formant.visible.when"?: [string, "=", string];
+}
+export interface IJsonBaseSchemaWithDefault<T extends FieldType, U> extends IJsonBaseSchema<T> {
+    default?: U;
+}
+export interface IPropertyObject {
+    [key: string]: JsonSchema;
+}
+export interface IJsonObjectSchema extends IJsonBaseSchema<"object"> {
+    properties?: IPropertyObject;
+    "$formant.documentationUrl"?: string;
+}
+export interface IJsonArraySchema extends IJsonBaseSchema<"array"> {
+    items: {
+        type: "integer" | "number" | "string" | "object";
+        properties: IPropertyObject;
+        required?: string[];
+        "$formant.itemName"?: string;
+    };
+}
+export interface IJsonStringSchema extends IJsonBaseSchemaWithDefault<"string", string> {
+    enum?: string[];
+    "$formant.streams.byType"?: StreamType;
+    "$formant.placeholder"?: string;
+    "$formant.groups"?: boolean;
+    "$formant.date"?: boolean;
+}
+export type IJsonBooleanSchema = IJsonBaseSchemaWithDefault<"boolean", boolean>;
+export type IJsonIntegerSchema = IJsonBaseSchemaWithDefault<"integer", number>;
+export type IJsonNumberSchema = IJsonBaseSchemaWithDefault<"number", number>;
+export type JsonSchema = IJsonObjectSchema | IJsonStringSchema | IJsonArraySchema | IJsonBooleanSchema | IJsonIntegerSchema | IJsonNumberSchema;

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

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

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

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

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

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

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

@@ -0,0 +1,35 @@
+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

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

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

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

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

@@ -0,0 +1,26 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+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

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

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

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

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

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

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

@@ -0,0 +1 @@
+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

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

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

@@ -0,0 +1 @@
+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

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

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

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

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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,70 @@
+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

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

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

@@ -0,0 +1,43 @@
+import { IUser } from "../model/IUser";
+import { AuthenticationResult } from "./AuthenticationResult";
+import { IConfirmForgotPasswordRequest } from "./IConfirmForgotPasswordRequest";
+import { IAuthentication } from "./IAuthentication";
+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;
+    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>;
+}