@formant/realtime-sdk 0.0.19 → 1.0.0

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Formant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# Formant Realtime SDK
+
+A library for accessing realtime connections your Formant devices/fleet.
+
+## Get Started
+
+```bash
+$ npm install --save @formant/realtime-sdk@latest
+
+# or with
+
+$ yarn add @formant/realtime-sdk@latest
+```
+
+## License
+
+Distributed under the MIT License. See LICENSE.txt for more information.
+
+## Changelog
+
+### **1.0.0** - 2023-07-19
+
+#### Added
+- 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 

package/dist/{common → client}/Credentials.d.ts

@@ -1,4 +1,4 @@
-import { AuthClient } from "../client/AuthClient";
+import { AuthClient } from "./AuthClient";
 export declare class Credentials {
     private authClient;
     private email;

package/dist/common/BaseClient.d.ts

@@ -1,10 +1,9 @@
+import { IDictionary } from "../model/IDictionary";
 import { IValidation } from "../model/IValidation";
 import { ResponseError } from "./ResponseError";
 export interface IRequestInit {
     method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-    headers?: {
-        [key: string]: string;
-    };
+    headers?: IDictionary;
     body?: any;
     token?: string;
     allowUnsafeRetries?: boolean;
@@ -24,12 +23,14 @@ export declare abstract class BaseClient {
     private configuredRetries;
     private timeoutMs?;
     private maxBackoffDelayMs;
+    private json;
     constructor(endpoint: string | undefined, options?: {
         validateHeaders?: (headers: Headers) => IValidation;
         verbose?: boolean;
         retries?: number;
         timeoutMs?: number;
         maxBackoffDelayMs?: number;
+        json?: boolean;
     });
     protected getRetries(): number;
     protected getHeaders(): {

package/dist/common/LogReporter.d.ts

@@ -1,7 +1,5 @@
 import { IStatEntry, StatsReporter } from "./StatsReporter";
-export declare class LogReporter implements StatsReporter<"simple"> {
-    name: string;
-    type: "simple";
+export declare class LogReporter extends StatsReporter<"simple"> {
     private message;
     constructor(message: string);
     send(values: IStatEntry[]): Promise<void>;

package/dist/common/LruCache.d.ts

@@ -1,5 +1,5 @@
 import BaseLruCache from "lru-cache";
-export declare type CacheOptions<V> = BaseLruCache.Options<string, V> & {
+export type CacheOptions<V> = BaseLruCache.Options<string, V> & {
     name: string;
     fastStringify?: boolean;
 };

package/dist/common/PromiseLruCache.d.ts

@@ -1,5 +1,5 @@
 import { CacheOptions, LruCache } from "./LruCache";
-export declare type PromiseCacheOptions<V> = CacheOptions<Promise<V>> & {
+export type PromiseCacheOptions<V> = CacheOptions<Promise<V>> & {
     expireRejectedPromiseValues?: boolean;
     rejectedPromiseValueTtl?: number;
 };

package/dist/common/ResponseError.d.ts

@@ -2,9 +2,10 @@ import { IValidation } from "../model/IValidation";
 export declare class ResponseError extends Error {
     method: string;
     url: string;
+    requestBody: any;
     statusCode: number;
+    headers: any;
     body: any;
     validationErrors: IValidation;
-    headers?: any;
-    constructor(method: string, url: string, statusCode: number, body: any, validationErrors?: IValidation, headers?: any);
+    constructor(method: string, url: string, requestBody: any, statusCode: number, headers: any, body: any, validationErrors?: IValidation);
 }

package/dist/common/StatsManager.d.ts

@@ -2,7 +2,7 @@ import { IStat } from "../model/IStat";
 import { ITags } from "../model/ITags";
 import { StatsReporter } from "./StatsReporter";
 export declare class StatsManager {
-    private samplePeriodSeconds;
+    static readonly samplePeriodMs: number;
     private buffer;
     private reporters;
     private flushInterval;

package/dist/common/StatsReporter.d.ts

@@ -4,13 +4,14 @@ export interface IEntryTypeMap {
     simple: IStatEntry;
     tagged: ITaggedStatEntry;
 }
-export declare type StatsReporterType = keyof IEntryTypeMap;
-export declare type IStatEntry = Omit<IMetric, "tags">;
-export declare type ITaggedStatEntry = IStatEntry & {
+export type StatsReporterType = keyof IEntryTypeMap;
+export type IStatEntry = Omit<IMetric, "tags">;
+export type ITaggedStatEntry = IStatEntry & {
     tags: ITags;
 };
 export declare abstract class StatsReporter<T extends StatsReporterType = StatsReporterType> {
-    name: string;
-    type: T;
-    abstract send(values: IEntryTypeMap[T][], intervalSeconds: number): Promise<void>;
+    readonly type: T;
+    readonly name: string;
+    constructor(type: T, name: string);
+    abstract send(values: IEntryTypeMap[T][], intervalMs: number): Promise<void>;
 }

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

@@ -18,3 +18,5 @@ export declare const jestWorkerId: string | undefined;
 export declare const sheetExportMaxRowCount: number;
 export declare const logToFile: boolean;
 export declare const enableSelfServe: boolean;
+export type UsageMetricsAggregateLevel = "day" | "hour" | "minute";
+export declare const aggregateLevel: UsageMetricsAggregateLevel;

package/dist/common/defined.d.ts

@@ -1,3 +1,6 @@
+export declare function assertsDefined<T>(value: T | undefined, message?: string): asserts value is T;
+export declare function assertsNotNull<T>(value: T | null, message?: string): asserts value is T;
+export declare function assertsDefinedAndNotNull<T>(value: T | undefined | null, message?: string): asserts value is T;
 export declare function defined<T>(value: T | undefined): T;
 export declare function notNull<T>(value: T | null): T;
 export declare function definedAndNotNull<T>(value: T | undefined | null): T;

package/dist/common/isErrorType.d.ts

@@ -0,0 +1 @@
+export declare function isErrorType<T extends Error>(error: unknown, constructor: new (...x: any[]) => T, predicate?: (t: T) => boolean): error is T;

package/dist/common/narrowError.d.ts

@@ -1 +1 @@
-export declare function narrowError<T>(error: unknown, constructor: new (...x: any[]) => T, predicate?: (t: T) => boolean): T;
+export declare function narrowError<T extends Error>(error: unknown, constructor: new (...x: any[]) => T, predicate?: (t: T) => boolean): T;

package/dist/common/redact.d.ts

@@ -1,4 +1,4 @@
 /**
  * Returns a copy of an object with sensitive information redacted.
  */
-export declare function redact(object: any, visited?: Set<any>): any;
+export declare function redact(object: unknown, visited?: WeakSet<any>): any;