@formant/data-sdk 1.2.0 → 1.3.0

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

@@ -0,0 +1,5 @@
+import { IOnDemandPresenceStreamItemGroup } from "./IOnDemandPresenceStreamItemGroup";
+export interface IOnDemandStreamPresence {
+    streamName: string;
+    presence: IOnDemandPresenceStreamItemGroup[];
+}

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

@@ -0,0 +1,6 @@
+import { IOnDemandStreamPresence } from "./IOnDemandStreamPresence";
+import { OnDemandBufferType } from "./OnDemandBufferType";
+export interface IOnDemandBuffer {
+    bufferType: OnDemandBufferType;
+    streams: IOnDemandStreamPresence[];
+}

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

@@ -0,0 +1,5 @@
+export interface IOnvifDevice {
+    id: string;
+    name: string;
+    address: string;
+}

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

@@ -0,0 +1,6 @@
+export interface IOsInfo {
+    name?: string;
+    vendor?: string;
+    version?: string;
+    release?: string;
+}

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

@@ -0,0 +1,9 @@
+import { ITaggedEntity } from "./ITaggedEntity";
+import { Policies } from "./Policies";
+import { Uuid } from "./Uuid";
+export interface IRole extends ITaggedEntity {
+    organizationId?: Uuid;
+    name: string;
+    policies: Policies;
+    isImmutable?: boolean;
+}

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

@@ -0,0 +1,4 @@
+export interface IRosTopic {
+    name: string;
+    type: 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/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/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/IVideoDevice.d.ts

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

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/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/cognitoRegions.d.ts

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

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/stores/AuthenticationStore.d.ts

@@ -1,4 +1,5 @@
-import { User, IAuthentication, IAuthenticationStore, IConfirmForgotPasswordRequest, IRespondToNewPasswordRequiredChallengeRequest } from "./IAuthenticationStore";
+import { IAuthentication, IAuthenticationStore, IConfirmForgotPasswordRequest, IRespondToNewPasswordRequiredChallengeRequest } from "./IAuthenticationStore";
+import { IUser } from "../model/IUser";
 interface IAuthenticationStoreOptions {
     apiUrl: string;
     refreshAuthToken: () => void;
@@ -18,7 +19,7 @@ export declare class AuthenticationStore implements IAuthenticationStore {
     private readonly _addAccessTokenRefreshListener;
     constructor({ apiUrl, refreshAuthToken, addAccessTokenRefreshListener, }: IAuthenticationStoreOptions);
     get token(): string | undefined;
-    get currentUser(): User | undefined;
+    get currentUser(): IUser | undefined;
     get currentOrganization(): string | undefined;
     get defaultDeviceId(): string | undefined;
     /**
@@ -35,7 +36,7 @@ export declare class AuthenticationStore implements IAuthenticationStore {
     /**
      * @deprecated use currentUser property instead.
      */
-    getCurrentUser(): User | undefined;
+    getCurrentUser(): IUser | undefined;
     waitTilAuthenticated(): Promise<boolean>;
     listenForRefresh(): Promise<void>;
     forgotPassword(email: string): Promise<void>;

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

@@ -1,11 +1,4 @@
-export interface User {
-    firstName: string;
-    lastName: string;
-    email: string;
-    organizationId: string;
-    roleId: string;
-    id: string;
-}
+import { IUser } from "../model/IUser";
 export interface IAuthentication {
     accessToken: string;
     organizationId: string;
@@ -24,7 +17,7 @@ export interface IRespondToNewPasswordRequiredChallengeRequest {
 }
 export interface IAuthenticationStore {
     readonly token: string | undefined;
-    readonly currentUser: User | undefined;
+    readonly currentUser: IUser | undefined;
     readonly currentOrganization: string | undefined;
     readonly defaultDeviceId: string | undefined;
     /**
@@ -38,7 +31,7 @@ export interface IAuthenticationStore {
     login(email: string, password: string): Promise<IAuthentication | Error>;
     loginWithToken(token: string, refreshToken?: string): Promise<void>;
     isAuthenticated(): boolean;
-    getCurrentUser(): User | undefined;
+    getCurrentUser(): IUser | undefined;
     waitTilAuthenticated(): Promise<boolean>;
     listenForRefresh(): Promise<void>;
     forgotPassword(email: string): Promise<void>;

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

@@ -3,4 +3,3 @@ export * from "./numericAggregateUtils";
 export * from "./timeout";
 export * from "./serializeHash";
 export * from "./isRtcPeer";
-export { getRtcClientVersion } from "./rtcClientVersion";

package/package.json

@@ -24,7 +24,7 @@
       }
     }
   },
-  "version": "1.2.0",
+  "version": "1.3.0",
   "scripts": {
     "preversion": "npm run test && tsc --project ./configs/tsconfig.type-check.json",
     "postversion": "make",

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

@@ -1,2 +0,0 @@
-export declare function overrideRtcClientVersion(newVersion: string | null): void;
-export declare function getRtcClientVersion(): string | null;