@formant/realtime-sdk 1.3.0 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (217) hide show
  1. package/dist/client/AuthClient.d.ts +42 -0
  2. package/dist/client/Credentials.d.ts +10 -0
  3. package/dist/client/LanAgentClient.d.ts +7 -0
  4. package/dist/client/RtcSignalingClient.d.ts +20 -0
  5. package/dist/common/BaseClient.d.ts +43 -0
  6. package/dist/common/ConnectionError.d.ts +6 -0
  7. package/dist/common/FormantBaseClient.d.ts +13 -0
  8. package/dist/common/LogApiTransport.d.ts +11 -0
  9. package/dist/common/LogClient.d.ts +6 -0
  10. package/dist/common/LogReporter.d.ts +6 -0
  11. package/dist/common/LruCache.d.ts +20 -0
  12. package/dist/common/PromiseLruCache.d.ts +11 -0
  13. package/dist/common/ResponseError.d.ts +11 -0
  14. package/dist/common/ResponseHeadersError.d.ts +7 -0
  15. package/dist/common/StatsManager.d.ts +39 -0
  16. package/dist/common/StatsReporter.d.ts +17 -0
  17. package/dist/common/assertUnreachable.d.ts +1 -0
  18. package/dist/common/browser.d.ts +2 -0
  19. package/dist/common/collectErrors.d.ts +1 -0
  20. package/dist/common/config/index.d.ts +23 -0
  21. package/dist/common/defined.d.ts +6 -0
  22. package/dist/common/delay.d.ts +1 -0
  23. package/dist/common/errorToObject.d.ts +16 -0
  24. package/dist/common/errorToString.d.ts +6 -0
  25. package/dist/common/filterIceServers.d.ts +8 -0
  26. package/dist/common/instanceId.d.ts +1 -0
  27. package/dist/common/isErrorType.d.ts +1 -0
  28. package/dist/common/isObject.d.ts +1 -0
  29. package/dist/common/isValidTagString.d.ts +1 -0
  30. package/dist/common/logger.d.ts +4 -0
  31. package/dist/common/narrowError.d.ts +1 -0
  32. package/dist/common/objectMapValues.d.ts +9 -0
  33. package/dist/common/redact.d.ts +5 -0
  34. package/dist/common/setPromiseInterval.d.ts +16 -0
  35. package/dist/common/stats.d.ts +2 -0
  36. package/dist/common/toStringSafe.d.ts +8 -0
  37. package/dist/date-fns/parseIsoDate.d.ts +1 -0
  38. package/dist/index.js +2 -0
  39. package/dist/index.js.LICENSE.txt +19 -0
  40. package/dist/model/AnnotationAreaType.d.ts +2 -0
  41. package/dist/model/AuditLogActionType.d.ts +5 -0
  42. package/dist/model/CognitoRegion.d.ts +2 -0
  43. package/dist/model/Feature.d.ts +3 -0
  44. package/dist/model/HealthStatus.d.ts +2 -0
  45. package/dist/model/HexRgbColor.d.ts +1 -0
  46. package/dist/model/IAdminSignupRequest.d.ts +14 -0
  47. package/dist/model/IAnnotationAreaTypeMap.d.ts +4 -0
  48. package/dist/model/IAudioChunk.d.ts +5 -0
  49. package/dist/model/IAuditLog.d.ts +14 -0
  50. package/dist/model/IAuthentication.d.ts +8 -0
  51. package/dist/model/IBaseEntity.d.ts +7 -0
  52. package/dist/model/IBattery.d.ts +6 -0
  53. package/dist/model/IBitset.d.ts +4 -0
  54. package/dist/model/IBoundingBox.d.ts +6 -0
  55. package/dist/model/IChallenge.d.ts +7 -0
  56. package/dist/model/ICheckSsoResult.d.ts +5 -0
  57. package/dist/model/IColorRGBA.d.ts +6 -0
  58. package/dist/model/ICompressedImage.d.ts +3 -0
  59. package/dist/model/ICreateServiceAccountResponse.d.ts +5 -0
  60. package/dist/model/IDeviceCredentials.d.ts +9 -0
  61. package/dist/model/IDictionary.d.ts +3 -0
  62. package/dist/model/IFile.d.ts +6 -0
  63. package/dist/model/IFilter.d.ts +11 -0
  64. package/dist/model/IGetFeaturesResponse.d.ts +4 -0
  65. package/dist/model/IGoal.d.ts +5 -0
  66. package/dist/model/IGoalID.d.ts +3 -0
  67. package/dist/model/IGoogleLoginRequest.d.ts +4 -0
  68. package/dist/model/IH264VideoFrame.d.ts +5 -0
  69. package/dist/model/IHealth.d.ts +5 -0
  70. package/dist/model/IImage.d.ts +6 -0
  71. package/dist/model/IImageAnnotation.d.ts +9 -0
  72. package/dist/model/IJointState.d.ts +8 -0
  73. package/dist/model/IJoy.d.ts +4 -0
  74. package/dist/model/IJsonString.d.ts +3 -0
  75. package/dist/model/IListResponse.d.ts +3 -0
  76. package/dist/model/ILocalization.d.ts +14 -0
  77. package/dist/model/ILocation.d.ts +6 -0
  78. package/dist/model/ILogLine.d.ts +9 -0
  79. package/dist/model/ILoginRequest.d.ts +7 -0
  80. package/dist/model/ILoginResult.d.ts +7 -0
  81. package/dist/model/IMap.d.ts +10 -0
  82. package/dist/model/IMarker3D.d.ts +23 -0
  83. package/dist/model/IMarker3DArray.d.ts +4 -0
  84. package/dist/model/IMetric.d.ts +7 -0
  85. package/dist/model/INumericSetEntry.d.ts +5 -0
  86. package/dist/model/IOdometry.d.ts +7 -0
  87. package/dist/model/IPath.d.ts +5 -0
  88. package/dist/model/IPoint.d.ts +2 -0
  89. package/dist/model/IPointCloud.d.ts +6 -0
  90. package/dist/model/IPoseWithCovariance.d.ts +5 -0
  91. package/dist/model/IPostLanRtcOfferRequest.d.ts +3 -0
  92. package/dist/model/IPostLanRtcOfferResponse.d.ts +3 -0
  93. package/dist/model/IQuaternion.d.ts +6 -0
  94. package/dist/model/IRtcAddSignalsRequest.d.ts +4 -0
  95. package/dist/model/IRtcCapabilitySet.d.ts +6 -0
  96. package/dist/model/IRtcCreatePeerRequest.d.ts +6 -0
  97. package/dist/model/IRtcCreateSessionRequest.d.ts +5 -0
  98. package/dist/model/IRtcIceServer.d.ts +5 -0
  99. package/dist/model/IRtcInfo.d.ts +7 -0
  100. package/dist/model/IRtcPeer.d.ts +11 -0
  101. package/dist/model/IRtcPeerDescription.d.ts +6 -0
  102. package/dist/model/IRtcPortForwardingConfiguration.d.ts +3 -0
  103. package/dist/model/IRtcSession.d.ts +12 -0
  104. package/dist/model/IRtcSignal.d.ts +3 -0
  105. package/dist/model/IRtcStream.d.ts +9 -0
  106. package/dist/model/IRtcStreamCapability.d.ts +6 -0
  107. package/dist/model/IRtcStreamingConfiguration.d.ts +4 -0
  108. package/dist/model/IScopeFilter.d.ts +6 -0
  109. package/dist/model/IStat.d.ts +21 -0
  110. package/dist/model/IStreamTypeMap.d.ts +27 -0
  111. package/dist/model/ITagFilter.d.ts +4 -0
  112. package/dist/model/ITagSets.d.ts +3 -0
  113. package/dist/model/ITaggedEntity.d.ts +5 -0
  114. package/dist/model/ITags.d.ts +2 -0
  115. package/dist/model/ITransform.d.ts +6 -0
  116. package/dist/model/ITransformNode.d.ts +8 -0
  117. package/dist/model/ITwist.d.ts +5 -0
  118. package/dist/model/IUser.d.ts +36 -0
  119. package/dist/model/IUserScope.d.ts +16 -0
  120. package/dist/model/IValidation.d.ts +3 -0
  121. package/dist/model/IVector3.d.ts +5 -0
  122. package/dist/model/IVideo.d.ts +7 -0
  123. package/dist/model/IsoDate.d.ts +1 -0
  124. package/dist/model/LanguageType.d.ts +2 -0
  125. package/dist/model/LogLevel.d.ts +2 -0
  126. package/dist/model/Marker3DAction.d.ts +2 -0
  127. package/dist/model/Marker3DType.d.ts +2 -0
  128. package/dist/model/OrganizationPlan.d.ts +2 -0
  129. package/dist/model/RequireKeys.d.ts +3 -0
  130. package/dist/model/RtcConnectionStatus.d.ts +2 -0
  131. package/dist/model/RtcIceServerProtocol.d.ts +2 -0
  132. package/dist/model/RtcIceTransportPolicy.d.ts +2 -0
  133. package/dist/model/RtcSessionType.d.ts +2 -0
  134. package/dist/model/RtcStreamType.d.ts +3 -0
  135. package/dist/model/SmsOptInStatus.d.ts +2 -0
  136. package/dist/model/StreamType.d.ts +2 -0
  137. package/dist/model/Timeout.d.ts +1 -0
  138. package/dist/model/Timestamp.d.ts +1 -0
  139. package/dist/model/Uuid.d.ts +1 -0
  140. package/dist/model/VideoMimeType.d.ts +2 -0
  141. package/dist/model/auditLogActionTypes.d.ts +1 -0
  142. package/dist/model/bytes.d.ts +9 -0
  143. package/dist/model/cognitoRegions.d.ts +1 -0
  144. package/dist/model/duration.d.ts +10 -0
  145. package/dist/model/features.d.ts +2 -0
  146. package/dist/model/healthStatuses.d.ts +5 -0
  147. package/dist/model/languageTypes.d.ts +1 -0
  148. package/dist/model/logLevels.d.ts +1 -0
  149. package/dist/model/marker3DActions.d.ts +1 -0
  150. package/dist/model/marker3DTypes.d.ts +1 -0
  151. package/dist/model/organizationPlans.d.ts +1 -0
  152. package/dist/model/rtcConnectionStatuses.d.ts +1 -0
  153. package/dist/model/rtcIceServerProtocols.d.ts +1 -0
  154. package/dist/model/rtcIceTransportPolicies.d.ts +1 -0
  155. package/dist/model/rtcSessionTypes.d.ts +1 -0
  156. package/dist/model/rtcStreamTypes.d.ts +28 -0
  157. package/dist/model/smsOptInStatuses.d.ts +1 -0
  158. package/dist/model/videoMimeTypes.d.ts +1 -0
  159. package/dist/protos/api/signaling/v1/signaling.proto +114 -0
  160. package/dist/protos/api/signaling/v1/signaling_grpc_web_pb.d.ts +125 -0
  161. package/dist/protos/api/signaling/v1/signaling_grpc_web_pb.js +626 -0
  162. package/dist/protos/api/signaling/v1/signaling_pb.d.ts +458 -0
  163. package/dist/protos/api/signaling/v1/signaling_pb.js +3854 -0
  164. package/dist/realtime-sdk/src/config/index.d.ts +2 -0
  165. package/dist/realtime-sdk/src/index.d.ts +18 -0
  166. package/dist/rtc-client/DeadlineEnforcer.d.ts +4 -0
  167. package/dist/rtc-client/DeadlineReachedError.d.ts +3 -0
  168. package/dist/rtc-client/IHasPeerConnection.d.ts +3 -0
  169. package/dist/rtc-client/IHasRemoteDeviceId.d.ts +4 -0
  170. package/dist/rtc-client/RtcClient.d.ts +71 -0
  171. package/dist/rtc-client/RtcClientV1.d.ts +52 -0
  172. package/dist/rtc-client/RtcConnection.d.ts +95 -0
  173. package/dist/rtc-client/RtcConnectionV1.d.ts +73 -0
  174. package/dist/rtc-client/RtcSessionMetrics.d.ts +17 -0
  175. package/dist/rtc-client/RtcSessionMetricsV1.d.ts +14 -0
  176. package/dist/rtc-client/config/index.d.ts +11 -0
  177. package/dist/rtc-client/gatherPingMetrics.d.ts +17 -0
  178. package/dist/rtc-client/models/IIceMode.d.ts +1 -0
  179. package/dist/rtc-client/models/IPingInfo.d.ts +10 -0
  180. package/dist/rtc-client/models/IPingPayload.d.ts +6 -0
  181. package/dist/rtc-client/models/IRTCStatsIceCandidate.d.ts +9 -0
  182. package/dist/rtc-client/models/IRTCStatsIceCandidatePair.d.ts +9 -0
  183. package/dist/rtc-client/models/IRTCStatsTransport.d.ts +8 -0
  184. package/dist/rtc-client/models/IRtcAgentInfo.d.ts +3 -0
  185. package/dist/rtc-client/models/IRtcClientConfiguration.d.ts +18 -0
  186. package/dist/rtc-client/models/IRtcConnectionBaseConfiguration.d.ts +16 -0
  187. package/dist/rtc-client/models/IRtcConnectionConfiguration.d.ts +6 -0
  188. package/dist/rtc-client/models/IRtcConnectionRemoteConfiguration.d.ts +6 -0
  189. package/dist/rtc-client/models/IRtcConnectionStatsInfo.d.ts +9 -0
  190. package/dist/rtc-client/models/IRtcPointCloud.d.ts +5 -0
  191. package/dist/rtc-client/models/IRtcSendConfiguration.d.ts +4 -0
  192. package/dist/rtc-client/models/IRtcSessionMetricsMessageCounts.d.ts +6 -0
  193. package/dist/rtc-client/models/IRtcStreamCommunication.d.ts +4 -0
  194. package/dist/rtc-client/models/IRtcStreamMessage.d.ts +7 -0
  195. package/dist/rtc-client/models/IRtcStreamMessageChunk.d.ts +7 -0
  196. package/dist/rtc-client/models/IRtcStreamMessageHeader.d.ts +7 -0
  197. package/dist/rtc-client/models/IRtcStreamPayload.d.ts +55 -0
  198. package/dist/rtc-client/models/IRtcStreamsInfo.d.ts +9 -0
  199. package/dist/rtc-client/models/IStreamControl.d.ts +23 -0
  200. package/dist/rtc-client/models/RtcChannelLabel.d.ts +2 -0
  201. package/dist/rtc-client/models/RtcCommunicationType.d.ts +1 -0
  202. package/dist/rtc-client/models/rtcChannelLabels.d.ts +1 -0
  203. package/dist/rtc-client/models-v1/IRtcClientConfigurationV1.d.ts +11 -0
  204. package/dist/rtc-client/models-v1/IRtcConnectionConfigurationV1.d.ts +12 -0
  205. package/dist/rtc-client/utils/assertHasPeerConnection.d.ts +1 -0
  206. package/dist/rtc-client/utils/createRtcStreamMessage.d.ts +4 -0
  207. package/dist/rtc-client/utils/encodeStreamId.d.ts +3 -0
  208. package/dist/rtc-client/utils/garbageCollect.d.ts +1 -0
  209. package/dist/rtc-client/utils/getErrorMessage.d.ts +1 -0
  210. package/dist/rtc-client/utils/iceModeFromRtcConnectionInfo.d.ts +3 -0
  211. package/dist/rtc-client/utils/isInactive.d.ts +1 -0
  212. package/dist/rtc-client/utils/partition.d.ts +1 -0
  213. package/dist/rtc-client/utils/peerToRtcPeer.d.ts +3 -0
  214. package/dist/rtc-client/utils/reassembleMessageChunks.d.ts +3 -0
  215. package/dist/rtc-client/utils/reifyZeroValues.d.ts +2 -0
  216. package/dist/rtc-client/utils/streamIsEqual.d.ts +2 -0
  217. package/package.json +1 -1
@@ -0,0 +1,23 @@
1
+ export declare const rtcPipelineType = "rtc";
2
+ export declare const telemetryPipelineType = "telemetry";
3
+ export type IStreamControl = IRtcStreamControl | ITelemetryStreamControl | IDegradeVideoStreamControl | IAudioStreamControl | ISetLowBandwidthMode;
4
+ export interface IStreamControlBase {
5
+ streamName: string;
6
+ }
7
+ export interface IRtcStreamControl extends IStreamControlBase {
8
+ pipeline: typeof rtcPipelineType;
9
+ enable: boolean;
10
+ }
11
+ export interface ITelemetryStreamControl extends IStreamControlBase {
12
+ pipeline: typeof telemetryPipelineType;
13
+ enablePriorityUpload: boolean;
14
+ }
15
+ export interface IDegradeVideoStreamControl extends IStreamControlBase {
16
+ degradeVideoQuality: boolean;
17
+ }
18
+ export interface IAudioStreamControl extends IStreamControlBase {
19
+ setAudioFormat: string;
20
+ }
21
+ export interface ISetLowBandwidthMode extends IStreamControlBase {
22
+ setLowBandwidthMode: boolean;
23
+ }
@@ -0,0 +1,2 @@
1
+ import { rtcChannelLabels } from "./rtcChannelLabels";
2
+ export type RtcChannelLabel = (typeof rtcChannelLabels)[number];
@@ -0,0 +1 @@
1
+ export type RtcCommunicationType = "message" | "message-chunk";
@@ -0,0 +1 @@
1
+ export declare const rtcChannelLabels: readonly ["stream.latest-try-once", "stream.reliable", "stream.latest-reliable", "stream.latest-ttl", "heartbeat"];
@@ -0,0 +1,11 @@
1
+ import { RtcSignalingClient } from "../../client/RtcSignalingClient";
2
+ import { IRtcCapabilitySet } from "../../model/IRtcCapabilitySet";
3
+ import { Uuid } from "../../model/Uuid";
4
+ import { IRtcStreamMessage } from "../models/IRtcStreamMessage";
5
+ export interface IRtcClientConfigurationV1 {
6
+ signalingClient: RtcSignalingClient;
7
+ getToken: () => Promise<string>;
8
+ receive: (peerId: Uuid, message: IRtcStreamMessage) => void;
9
+ alternateRTCPeerConnection?: typeof RTCPeerConnection;
10
+ capabilitySet?: IRtcCapabilitySet;
11
+ }
@@ -0,0 +1,12 @@
1
+ import { IRtcPeer } from "../../model/IRtcPeer";
2
+ import { IRtcSignal } from "../../model/IRtcSignal";
3
+ import { Uuid } from "../../model/Uuid";
4
+ import { IRtcStreamMessage } from "../models/IRtcStreamMessage";
5
+ export interface IRtcConnectionConfigurationV1 {
6
+ sessionId: Uuid;
7
+ localPeer: IRtcPeer;
8
+ remotePeer: IRtcPeer;
9
+ isOffer: boolean;
10
+ sendSignal: (signal: IRtcSignal) => Promise<void>;
11
+ receive: (peerId: Uuid, message: IRtcStreamMessage) => void;
12
+ }
@@ -0,0 +1 @@
1
+ export declare function assertHasPeerConnection(it: RTCPeerConnection | null): asserts it is RTCPeerConnection;
@@ -0,0 +1,4 @@
1
+ import { IRtcStream } from "../../model/IRtcStream";
2
+ import { IRtcStreamMessage } from "../models/IRtcStreamMessage";
3
+ import { IRtcStreamPayload } from "../models/IRtcStreamPayload";
4
+ export declare function createRtcStreamMessage(stream: IRtcStream, payload: IRtcStreamPayload, frameId?: string): IRtcStreamMessage;
@@ -0,0 +1,3 @@
1
+ import { IRtcStream } from "../../model/IRtcStream";
2
+ export declare function encodeStreamId({ entityId, streamName, streamType, }: IRtcStream): string;
3
+ export declare function decodeStreamId(streamId: string): IRtcStream;
@@ -0,0 +1 @@
1
+ export declare function forceGarbageCollection(): void;
@@ -0,0 +1 @@
1
+ export declare function getErrorMessage(error: unknown): string;
@@ -0,0 +1,3 @@
1
+ import { IIceMode } from "../models/IIceMode";
2
+ import { IRtcConnectionStatsInfo } from "../models/IRtcConnectionStatsInfo";
3
+ export declare function iceModeFromRtcConnectionStatsInfo(info: IRtcConnectionStatsInfo): IIceMode;
@@ -0,0 +1 @@
1
+ export declare function isInactive(peerConnection: RTCPeerConnection): boolean;
@@ -0,0 +1 @@
1
+ export declare function partition<T>(source: T[], predicate: (_: T, idx: number, array: T[]) => boolean): [T[], T[]];
@@ -0,0 +1,3 @@
1
+ import { IRtcPeer } from "../../model/IRtcPeer";
2
+ import { Peer } from "../../protos/api/signaling/v1/signaling_pb";
3
+ export declare function peerToRtcPeer(peer: Peer): IRtcPeer;
@@ -0,0 +1,3 @@
1
+ import { IRtcStreamMessage } from "../models/IRtcStreamMessage";
2
+ import { IRtcStreamMessageChunk } from "../models/IRtcStreamMessageChunk";
3
+ export declare function reassembleMessageChunks(chunks: IRtcStreamMessageChunk[]): IRtcStreamMessage | undefined;
@@ -0,0 +1,2 @@
1
+ import { IRtcStreamMessage } from "../models/IRtcStreamMessage";
2
+ export declare function reifyZeroValues(message: IRtcStreamMessage): IRtcStreamMessage;
@@ -0,0 +1,2 @@
1
+ import { IRtcStream } from "../../model/IRtcStream";
2
+ export declare function streamIsEqual(stream1: IRtcStream, stream2: IRtcStream): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@formant/realtime-sdk",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "license": "MIT",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/realtime-sdk/src/index.d.ts",