@formant/realtime-sdk 1.4.3 → 1.4.5

package/README.md

@@ -18,36 +18,47 @@ Distributed under the MIT License. See LICENSE.txt for more information.
 
 ## Changelog
 
+### **1.3.0** - 2024-09-09
+
+#### Fixed
+
+-   Redact sensitive ICE credentials.
+
 ### **1.2.0** - 2023-08-18
 
 #### Added
-- Exporting `IRtcPeer` and `RtcStreamType`.
+
+-   Exporting `IRtcPeer` and `RtcStreamType`.
 
 ### **1.1.0** - 2023-08-18
- 
+
 #### Fixed
-- Fixed debug logging level output.
+
+-   Fixed debug logging level output.
 
 ### **1.0.0** - 2023-07-19
 
 #### Added
-- Odometry over teleop 
-- Add support for eventing on all event trigger types 
+
+-   Odometry over teleop
+-   Add support for eventing on all event trigger types
 
 #### Changed
-- Reduce ICE gathering timeout to 3s
-
-#### Fixed 
-- Workaround for lack of getConfiguration method on RTCPeerConnection 
-- Project de-cycling 
-- Fix Odom 
-- Use previously implemented util for detecting STUN vs TURN 
-- Partition connections in a single step… 
-- Immediately eject a disconnected connection from the connection set 
-- More cleanup on rtcClient shutdown 
-- Record RTC connection type metric (host, relay, etc) 
-- Make best-effort to *release* the RtcPeerConnection on close 
-- `isConnectionInitiator` never gets cleared, keeping RtcConnections alive 
-- Add prettier plugin to deterministically sort import ordering 
-- Dependency updates 
-- Resolve realtime-sdk build warnings about re-exporting types 
+
+-   Reduce ICE gathering timeout to 3s
+
+#### Fixed
+
+-   Workaround for lack of getConfiguration method on RTCPeerConnection
+-   Project de-cycling
+-   Fix Odom
+-   Use previously implemented util for detecting STUN vs TURN
+-   Partition connections in a single step…
+-   Immediately eject a disconnected connection from the connection set
+-   More cleanup on rtcClient shutdown
+-   Record RTC connection type metric (host, relay, etc)
+-   Make best-effort to _release_ the RtcPeerConnection on close
+-   `isConnectionInitiator` never gets cleared, keeping RtcConnections alive
+-   Add prettier plugin to deterministically sort import ordering
+-   Dependency updates
+-   Resolve realtime-sdk build warnings about re-exporting types

package/dist/client/AuthClient.d.ts

@@ -35,7 +35,7 @@ export declare class AuthClient extends FormantBaseClient {
     }): Promise<void>;
     getDeviceCredentials(token: string): Promise<IDeviceCredentials>;
     impersonate(token: string, userId: Uuid): Promise<ILoginResult>;
-    createServiceAccount(token: string, name: string, roleId: Uuid, tags: ITags): Promise<ICreateServiceAccountResponse>;
+    createServiceAccount(token: string, name: string, roleId: Uuid, tags: ITags, description?: string): Promise<ICreateServiceAccountResponse>;
     getFeatures(token: string): Promise<Feature[]>;
     checkSso(email: string, allowUserAutoCreation?: boolean): Promise<ICheckSsoResult>;
     loginWithSso(token: string, refreshToken?: string): Promise<ILoginResult>;

package/dist/common/BaseClient.d.ts

@@ -1,11 +1,12 @@
 import { IDictionary } from "../model/IDictionary";
+import { IRequestToken } from "../model/IRequestToken";
 import { IValidation } from "../model/IValidation";
 import { ResponseError } from "./ResponseError";
 export interface IRequestInit {
     method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     headers?: IDictionary;
     body?: any;
-    token?: string;
+    token?: string | IRequestToken;
     allowUnsafeRetries?: boolean;
     json?: boolean;
 }
@@ -40,4 +41,5 @@ export declare abstract class BaseClient {
     protected fetchVerbose<T>(path: string, extendedInit?: IRequestInit): Promise<IResponse<T>>;
     private doFetch;
     private getConstructor;
+    static isNetworkError(error: any): boolean;
 }

package/dist/common/config/index.d.ts

@@ -1,3 +1,4 @@
+export declare const workflowGoogleDriveClientId: string;
 export declare const environment: string;
 export declare const app: string;
 export declare const appPath: string;

package/dist/common/errorConstants.d.ts

@@ -0,0 +1,7 @@
+export declare const temporaryPasswordExpired = "temporary password expired";
+export declare const peerDoesNotExist = "peer does not exist";
+export declare const deviceDisabled = "device disabled";
+export declare const tagRestricted = "missing tag(s) to access this resource";
+export declare const groupNameConflict = "group name already exists";
+export declare const groupTagConflict = "group tag key and value already exists";
+export declare const tooManyEventsToUpdate = "too many events to update";

package/dist/common/isValidTagString.d.ts

@@ -1 +1,3 @@
-export declare function isValidTagString(keyOrValue: string, allowStar?: boolean): boolean;
+export declare function isValidTagString(keyOrValue: string, config?: {
+    allowStar?: boolean;
+}): boolean;

package/dist/common/redact.d.ts

@@ -1,4 +1,6 @@
+export declare const redactKeys: string[];
 /**
  * Returns a copy of an object with sensitive information redacted.
  */
 export declare function redact(object: unknown, visited?: WeakSet<any>): any;
+export declare const redactStringifiedFields: (offerSignal: any) => Record<any, any>;

package/dist/common/setPromiseInterval.d.ts

@@ -3,8 +3,9 @@ export interface IPromiseIntervalOptions {
     delay: number;
     immediate?: boolean;
 }
-export interface IShutdownPromiseInterval {
+export interface IPromiseIntervalHandle {
     stop(): Promise<void>;
+    pending(): Promise<void>;
 }
 /**
  * Runs callback function f periodically.
@@ -13,4 +14,4 @@ export interface IShutdownPromiseInterval {
  *
  * Returns a function that stops execution if invoked.
  */
-export declare function setPromiseInterval({ func, delay, immediate, }: IPromiseIntervalOptions): IShutdownPromiseInterval;
+export declare function setPromiseInterval({ func, delay, immediate, }: IPromiseIntervalOptions): IPromiseIntervalHandle;

package/dist/common/truncate.d.ts

@@ -0,0 +1,4 @@
+export declare function truncate(message: string, options?: {
+    maxMessageLength?: number;
+    truncatedMessageEndLength?: number;
+}): string;