@vonage/client-sdk 1.3.0-alpha.0 → 1.3.0-alpha.2

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 (98) hide show
  1. package/api_docs/ts/.nojekyll +1 -0
  2. package/api_docs/ts/assets/highlight.css +127 -0
  3. package/api_docs/ts/assets/main.js +59 -0
  4. package/api_docs/ts/assets/navigation.js +1 -0
  5. package/api_docs/ts/assets/search.js +1 -0
  6. package/api_docs/ts/assets/style.css +1383 -0
  7. package/api_docs/ts/classes/ClientConfig.html +216 -0
  8. package/api_docs/ts/classes/ClientInitConfig.html +155 -0
  9. package/api_docs/ts/classes/VonageClient.html +1170 -0
  10. package/api_docs/ts/functions/convertInitConfig.html +70 -0
  11. package/api_docs/ts/functions/createVonageLogger.html +91 -0
  12. package/api_docs/ts/functions/setDefaultLoggingLevel.html +76 -0
  13. package/api_docs/ts/functions/setVonageClientLoggingLevel.html +76 -0
  14. package/api_docs/ts/index.html +117 -0
  15. package/api_docs/ts/interfaces/ConversationEvent.html +112 -0
  16. package/api_docs/ts/interfaces/ConversationState.html +1201 -0
  17. package/api_docs/ts/interfaces/CustomConversationEvent.html +178 -0
  18. package/api_docs/ts/interfaces/EmbeddedInfo.html +127 -0
  19. package/api_docs/ts/interfaces/EphemeralConversationEvent.html +156 -0
  20. package/api_docs/ts/interfaces/EventsPage.html +109 -0
  21. package/api_docs/ts/interfaces/From.html +97 -0
  22. package/api_docs/ts/interfaces/MemberInvitedEvent.html +167 -0
  23. package/api_docs/ts/interfaces/MemberJoinedEvent.html +167 -0
  24. package/api_docs/ts/interfaces/MemberLeftEvent.html +167 -0
  25. package/api_docs/ts/interfaces/MemberState.html +1201 -0
  26. package/api_docs/ts/interfaces/MessageAudioEvent.html +167 -0
  27. package/api_docs/ts/interfaces/MessageCustomEvent.html +167 -0
  28. package/api_docs/ts/interfaces/MessageFileEvent.html +167 -0
  29. package/api_docs/ts/interfaces/MessageImageEvent.html +167 -0
  30. package/api_docs/ts/interfaces/MessageLocationEvent.html +167 -0
  31. package/api_docs/ts/interfaces/MessageTemplateEvent.html +167 -0
  32. package/api_docs/ts/interfaces/MessageTextEvent.html +167 -0
  33. package/api_docs/ts/interfaces/MessageVCardEvent.html +167 -0
  34. package/api_docs/ts/interfaces/MessageVideoEvent.html +167 -0
  35. package/api_docs/ts/interfaces/NonPersistentConversationEvent.html +141 -0
  36. package/api_docs/ts/interfaces/PersistentConversationEvent.html +117 -0
  37. package/api_docs/ts/interfaces/System.html +134 -0
  38. package/api_docs/ts/modules.html +151 -0
  39. package/api_docs/ts/types/CallDisconnectReason.html +61 -0
  40. package/api_docs/ts/types/CallSayParams.html +66 -0
  41. package/api_docs/ts/types/CancelReason.html +61 -0
  42. package/api_docs/ts/types/ChannelType.html +61 -0
  43. package/api_docs/ts/types/ClientConfigObject.html +61 -0
  44. package/api_docs/ts/types/ClientInitConfigObject.html +61 -0
  45. package/api_docs/ts/types/ConfigRegion.html +61 -0
  46. package/api_docs/ts/types/Conversation.html +68 -0
  47. package/api_docs/ts/types/ConversationsPage.html +66 -0
  48. package/api_docs/ts/types/CreateConversationParameters.html +68 -0
  49. package/api_docs/ts/types/CustomData.html +65 -0
  50. package/api_docs/ts/types/HangupReason.html +61 -0
  51. package/api_docs/ts/types/Json.html +66 -0
  52. package/api_docs/ts/types/JsonValue.html +61 -0
  53. package/api_docs/ts/types/Leg.html +61 -0
  54. package/api_docs/ts/types/LegStatus.html +61 -0
  55. package/api_docs/ts/types/LoggingLevel.html +61 -0
  56. package/api_docs/ts/types/Member.html +66 -0
  57. package/api_docs/ts/types/MembersPage.html +66 -0
  58. package/api_docs/ts/types/OrderBy.html +61 -0
  59. package/api_docs/ts/types/PresentingOrder.html +61 -0
  60. package/api_docs/ts/types/RTCQuality.html +61 -0
  61. package/api_docs/ts/types/RtcStats.html +61 -0
  62. package/api_docs/ts/types/SessionErrorReason.html +61 -0
  63. package/api_docs/ts/types/Topic.html +61 -0
  64. package/api_docs/ts/types/Topics.html +61 -0
  65. package/api_docs/ts/types/User.html +61 -0
  66. package/api_docs/ts/types/VonageError.html +61 -0
  67. package/api_docs/ts/types/VonageErrorType.html +61 -0
  68. package/api_docs/ts/types/VonageLogger.html +61 -0
  69. package/api_docs/ts/variables/CSErrorCodes.html +82 -0
  70. package/api_docs/ts/variables/CallDisconnectReason-1.html +61 -0
  71. package/api_docs/ts/variables/CancelReason-1.html +61 -0
  72. package/api_docs/ts/variables/ChannelType-1.html +61 -0
  73. package/api_docs/ts/variables/ConfigRegion-1.html +61 -0
  74. package/api_docs/ts/variables/HangupReason-1.html +61 -0
  75. package/api_docs/ts/variables/LegStatus-1.html +61 -0
  76. package/api_docs/ts/variables/LoggingLevel-1.html +61 -0
  77. package/api_docs/ts/variables/OrderBy-1.html +61 -0
  78. package/api_docs/ts/variables/PresentingOrder-1.html +61 -0
  79. package/api_docs/ts/variables/SessionErrorCodes.html +96 -0
  80. package/api_docs/ts/variables/SessionErrorReason-1.html +61 -0
  81. package/api_docs/ts/variables/Topic-1.html +61 -0
  82. package/api_docs/ts/variables/Topics-1.html +61 -0
  83. package/api_docs/ts/variables/VonageError-1.html +61 -0
  84. package/api_docs/ts/variables/VonageErrorType-1.html +61 -0
  85. package/dist/client/VonageClient.d.ts +12 -15
  86. package/dist/client/index.cjs +10712 -10408
  87. package/dist/client/index.mjs +10712 -10408
  88. package/dist/coreExtend.d.ts +2 -0
  89. package/dist/kotlin/clientsdk-clientcore_js.d.ts +35 -20
  90. package/dist/utils/JsonUtils.d.ts +9 -0
  91. package/dist/utils/index.d.ts +2 -1
  92. package/dist/utils/logging.d.ts +6 -1
  93. package/dist/vonageClientSDK.js +10206 -9911
  94. package/dist/vonageClientSDK.min.js +1 -1
  95. package/dist/vonageClientSDK.min.mjs +1 -1
  96. package/dist/vonageClientSDK.mjs +10206 -9911
  97. package/package.json +3 -2
  98. package/dist/global.d.ts +0 -7
@@ -1,5 +1,7 @@
1
1
  import './kotlin/clientsdk-clientcore_js';
2
+ import { Json as InternalJson } from './utils/JsonUtils';
2
3
  declare module './kotlin/clientsdk-clientcore_js' {
4
+ type Json = InternalJson;
3
5
  namespace vonage {
4
6
  interface CombinedClientJS {
5
7
  /**
@@ -26,7 +26,7 @@ export declare namespace vonage {
26
26
  get core(): any/* com.vonage.clientcore.core.CoreClientWithMedia */;
27
27
  get emitter(): Nullable<vonage.CombinedEvents>;
28
28
  set emitter(value: Nullable<vonage.CombinedEvents>);
29
- createConversation(name: Nullable<string>, displayName: Nullable<string>): Promise<string>;
29
+ createConversation(parameters: Nullable<vonage.CreateConversationParametersJS>): Promise<string>;
30
30
  joinConversation(cid: string): Promise<string>;
31
31
  inviteToConversation(cid: string, username: string): Promise<string>;
32
32
  leaveConversation(cid: string): Promise<any>;
@@ -38,7 +38,7 @@ export declare namespace vonage {
38
38
  sendMessageTextEvent(cid: string, text: string): Promise<string>;
39
39
  sendMessageCustomEvent(cid: string, customData: string): Promise<string>;
40
40
  sendMessageImageEvent(cid: string, imageURL: URL): Promise<string>;
41
- sendEphemeralEvent(cid: string, customBody: string): Promise<string>;
41
+ sendEphemeralEvent(cid: string, customData: string): Promise<string>;
42
42
  deleteEvent(id: number, conversationId: string): Promise<any>;
43
43
  setConfig(config: vonage.ConfigObjectJS): void;
44
44
  createSession(token: string, sessionId: Nullable<string>): Promise<string>;
@@ -426,8 +426,15 @@ export declare namespace vonage {
426
426
  get displayName(): Nullable<string>;
427
427
  get imageUrl(): Nullable<string>;
428
428
  get state(): Nullable<string>;
429
- get customData(): Nullable<string>;
430
- get customSortKey(): Nullable<string>;
429
+ get properties(): vonage.ConversationJS.Properties;
430
+ }
431
+ namespace ConversationJS {
432
+ class Properties {
433
+ private constructor();
434
+ get ttl(): Nullable<number>;
435
+ get customSortKey(): Nullable<string>;
436
+ get customData(): Nullable<string>;
437
+ }
431
438
  }
432
439
  const ConversationStateJS: {
433
440
  get ACTIVE(): string;
@@ -662,11 +669,19 @@ export declare namespace vonage {
662
669
  reconnection(): void;
663
670
  sessionError(reason: vonage.SessionErrorReasonJS): void;
664
671
  }
672
+ interface CreateConversationParametersJS {
673
+ readonly name?: Nullable<string>;
674
+ readonly displayName?: Nullable<string>;
675
+ readonly imageUrl?: Nullable<string>;
676
+ readonly ttl?: Nullable<any>/* Nullable<kotlin.Number> */;
677
+ readonly customSortKey?: Nullable<string>;
678
+ readonly customData?: Nullable<string>;
679
+ }
665
680
  }
666
681
  export declare namespace vonage {
667
682
  interface IChatClientJS extends vonage.ICoreClientJS {
668
683
  readonly core: any/* com.vonage.clientcore.core.CoreClient */;
669
- createConversation(name: Nullable<string>, displayName: Nullable<string>): Promise<string>;
684
+ createConversation(parameters: Nullable<vonage.CreateConversationParametersJS>): Promise<string>;
670
685
  joinConversation(cid: string): Promise<string>;
671
686
  inviteToConversation(cid: string, username: string): Promise<string>;
672
687
  leaveConversation(cid: string): Promise<any>;
@@ -678,7 +693,7 @@ export declare namespace vonage {
678
693
  sendMessageTextEvent(cid: string, text: string): Promise<string>;
679
694
  sendMessageCustomEvent(cid: string, customData: string): Promise<string>;
680
695
  sendMessageImageEvent(cid: string, imageURL: URL): Promise<string>;
681
- sendEphemeralEvent(cid: string, customBody: string): Promise<string>;
696
+ sendEphemeralEvent(cid: string, customData: string): Promise<string>;
682
697
  deleteEvent(id: number, conversationId: string): Promise<any>;
683
698
  setConfig(config: vonage.ConfigObjectJS): void;
684
699
  createSession(token: string, sessionId: Nullable<string>): Promise<string>;
@@ -725,7 +740,6 @@ export declare namespace vonage {
725
740
  }
726
741
  export declare namespace vonage {
727
742
  const DEFAULT_REGION: vonage.CoreClientConfigRegionJS;
728
- const DEFAULT_LOGGING_LEVEL: vonage.LoggingLevelJS;
729
743
  abstract class CoreClientConfigRegionJS {
730
744
  private constructor();
731
745
  get coreRegion(): any/* com.vonage.clientcore.core.api.ClientConfigRegion */;
@@ -836,6 +850,8 @@ export declare namespace vonage {
836
850
  get name(): "Verbose" | "Debug" | "Info" | "Warn" | "Error" | "Assert";
837
851
  get ordinal(): 0 | 1 | 2 | 3 | 4 | 5;
838
852
  }
853
+ const DEFAULT_LOGGING_LEVEL: vonage.LoggingLevelJS;
854
+ function setDefaultLoggingLevel(level: vonage.LoggingLevelJS): void;
839
855
  abstract class SessionErrorReasonJS {
840
856
  private constructor();
841
857
  get reason(): any/* com.vonage.clientcore.core.api.SessionErrorReason */;
@@ -856,7 +872,6 @@ export declare namespace vonage {
856
872
  get name(): "EXPIRED_TOKEN" | "TRANSPORT_CLOSED" | "PING_TIMEOUT";
857
873
  get ordinal(): 0 | 1 | 2;
858
874
  }
859
- function setDefaultLoggingLevel(level: vonage.LoggingLevelJS): void;
860
875
  interface ICoreClientJS {
861
876
  readonly core: any/* com.vonage.clientcore.core.CoreClient */;
862
877
  setConfig(config: vonage.ConfigObjectJS): void;
@@ -1019,7 +1034,7 @@ export declare namespace vonage {
1019
1034
  enableRtcStatsCollection(interval: any/* kotlin.Number */, mediaId: string): void;
1020
1035
  }
1021
1036
  interface MediaClientDelegateJS {
1022
- onRtcStats(rtcStats: any/* com.vonage.clientcore.core.reducers.call.RTCStats */, legId: string): void;
1037
+ onRtcStats(rtcStats: vonage.RTCStatsJS, legId: string): void;
1023
1038
  onConnectionChange(id: string, status: string): void;
1024
1039
  onNetworkChange(legId: string, status: string): void;
1025
1040
  }
@@ -1090,17 +1105,17 @@ export declare namespace vonage {
1090
1105
  equals(other: Nullable<any>): boolean;
1091
1106
  }
1092
1107
  class RTCStatsJS {
1093
- constructor(audioRecvPackets: any/* kotlin.Long */, audioRecvPacketsLost: number, audioRecvBytes: any/* kotlin.Long */, audioRecvJitter: number, audioSentPackets: any/* kotlin.Long */, audioSentBytes: any/* kotlin.Long */, audioSentPacketsLost: number, audioRtt: number, audioSentJitter: number);
1094
- get audioRecvPackets(): any/* kotlin.Long */;
1095
- get audioRecvPacketsLost(): number;
1096
- get audioRecvBytes(): any/* kotlin.Long */;
1097
- get audioRecvJitter(): number;
1098
- get audioSentPackets(): any/* kotlin.Long */;
1099
- get audioSentBytes(): any/* kotlin.Long */;
1100
- get audioSentPacketsLost(): number;
1101
- get audioRtt(): number;
1102
- get audioSentJitter(): number;
1103
- copy(audioRecvPackets?: any/* kotlin.Long */, audioRecvPacketsLost?: number, audioRecvBytes?: any/* kotlin.Long */, audioRecvJitter?: number, audioSentPackets?: any/* kotlin.Long */, audioSentBytes?: any/* kotlin.Long */, audioSentPacketsLost?: number, audioRtt?: number, audioSentJitter?: number): vonage.RTCStatsJS;
1108
+ constructor(audioRecvPackets: any/* kotlin.Number */, audioRecvPacketsLost: any/* kotlin.Number */, audioRecvBytes: any/* kotlin.Number */, audioRecvJitter: any/* kotlin.Number */, audioSentPackets: any/* kotlin.Number */, audioSentBytes: any/* kotlin.Number */, audioSentPacketsLost: any/* kotlin.Number */, audioRtt: any/* kotlin.Number */, audioSentJitter: any/* kotlin.Number */);
1109
+ get audioRecvPackets(): any/* kotlin.Number */;
1110
+ get audioRecvPacketsLost(): any/* kotlin.Number */;
1111
+ get audioRecvBytes(): any/* kotlin.Number */;
1112
+ get audioRecvJitter(): any/* kotlin.Number */;
1113
+ get audioSentPackets(): any/* kotlin.Number */;
1114
+ get audioSentBytes(): any/* kotlin.Number */;
1115
+ get audioSentPacketsLost(): any/* kotlin.Number */;
1116
+ get audioRtt(): any/* kotlin.Number */;
1117
+ get audioSentJitter(): any/* kotlin.Number */;
1118
+ copy(audioRecvPackets?: any/* kotlin.Number */, audioRecvPacketsLost?: any/* kotlin.Number */, audioRecvBytes?: any/* kotlin.Number */, audioRecvJitter?: any/* kotlin.Number */, audioSentPackets?: any/* kotlin.Number */, audioSentBytes?: any/* kotlin.Number */, audioSentPacketsLost?: any/* kotlin.Number */, audioRtt?: any/* kotlin.Number */, audioSentJitter?: any/* kotlin.Number */): vonage.RTCStatsJS;
1104
1119
  toString(): string;
1105
1120
  hashCode(): number;
1106
1121
  equals(other: Nullable<any>): boolean;
@@ -0,0 +1,9 @@
1
+ export type JsonValue = object | null | boolean | string | number;
2
+ export type Json = {
3
+ [property: string]: Json | JsonValue;
4
+ } | Json[];
5
+ /**
6
+ * Represents custom data, which can be a JSON object or a JSON-formatted string.
7
+ * There is a 2MB limit on the size of the custom data object.
8
+ */
9
+ export type CustomData = Json | string;
@@ -1,5 +1,6 @@
1
1
  export { ClientConfig, ClientInitConfig, ClientConfigObject, ClientInitConfigObject, ConfigRegion, convertInitConfig } from './ClientConfig';
2
- export { type Topic, type VonageLogger, LoggingLevel, Topics, createVonageLogger, setDefaultLoggingLevel } from './logging';
2
+ export { type Topic, type VonageLogger, LoggingLevel, Topics, createVonageLogger, setDefaultLoggingLevel, setVonageClientLoggingLevel } from './logging';
3
+ export * from './JsonUtils';
3
4
  export * from './ConversationModels';
4
5
  export * from '../kotlin/JsUnions';
5
6
  export * from './ErrorModels';
@@ -11,7 +11,12 @@ export declare const LoggingLevel: typeof vonage.LoggingLevelJS;
11
11
  * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
12
12
  * @param level - The logging level to set.
13
13
  */
14
- export declare const setDefaultLoggingLevel: typeof vonage.setDefaultLoggingLevel;
14
+ export declare const setDefaultLoggingLevel: (level: LoggingLevel) => void;
15
+ /**
16
+ * @deprecated Use {@link ClientInitConfig.loggingLevel} instead.
17
+ * @param level - The logging level to set.
18
+ */
19
+ export declare const setVonageClientLoggingLevel: (level: LoggingLevel) => void;
15
20
  export type VonageLogger = VonageLoggerJS | ({
16
21
  minLogLevel?: LoggingLevel;
17
22
  topics?: Topics[];