@vonage/client-sdk 1.2.1-beta.6 → 1.2.1-snapshot.100.0

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 (116) hide show
  1. package/README.md +11 -8
  2. package/api_docs/ts/.nojekyll +1 -0
  3. package/api_docs/ts/assets/highlight.css +127 -0
  4. package/api_docs/ts/assets/main.js +59 -0
  5. package/api_docs/ts/assets/navigation.js +1 -0
  6. package/api_docs/ts/assets/search.js +1 -0
  7. package/api_docs/ts/assets/style.css +1394 -0
  8. package/api_docs/ts/classes/ClientConfig.html +13 -0
  9. package/api_docs/ts/classes/ClientInitConfig.html +12 -0
  10. package/api_docs/ts/classes/VonageClient.html +308 -0
  11. package/api_docs/ts/functions/none.html +2 -0
  12. package/api_docs/ts/functions/setDefaultLoggingLevel.html +3 -0
  13. package/api_docs/ts/functions/setVonageClientLoggingLevel.html +3 -0
  14. package/api_docs/ts/functions/some.html +3 -0
  15. package/api_docs/ts/index.html +33 -0
  16. package/api_docs/ts/interfaces/CallSayParams.html +8 -0
  17. package/api_docs/ts/interfaces/Channel.html +8 -0
  18. package/api_docs/ts/interfaces/ClientConfigObject.html +18 -0
  19. package/api_docs/ts/interfaces/ClientInitConfigObject.html +24 -0
  20. package/api_docs/ts/interfaces/Conversation.html +20 -0
  21. package/api_docs/ts/interfaces/ConversationProperties.html +8 -0
  22. package/api_docs/ts/interfaces/ConversationTimestamp.html +5 -0
  23. package/api_docs/ts/interfaces/ConversationsPage.html +8 -0
  24. package/api_docs/ts/interfaces/CreateConversationParameters.html +15 -0
  25. package/api_docs/ts/interfaces/CustomConversationEvent.html +17 -0
  26. package/api_docs/ts/interfaces/EmbeddedInfo.html +9 -0
  27. package/api_docs/ts/interfaces/EphemeralConversationEvent.html +13 -0
  28. package/api_docs/ts/interfaces/EventDeleteConversationEvent.html +15 -0
  29. package/api_docs/ts/interfaces/EventsPage.html +8 -0
  30. package/api_docs/ts/interfaces/GetConversationEventsParameters.html +14 -0
  31. package/api_docs/ts/interfaces/GetConversationMembersParameters.html +8 -0
  32. package/api_docs/ts/interfaces/GetConversationsParameters.html +12 -0
  33. package/api_docs/ts/interfaces/Leg.html +20 -0
  34. package/api_docs/ts/interfaces/LegChannel.html +8 -0
  35. package/api_docs/ts/interfaces/Location.html +6 -0
  36. package/api_docs/ts/interfaces/Member.html +12 -0
  37. package/api_docs/ts/interfaces/MemberChannel.html +8 -0
  38. package/api_docs/ts/interfaces/MemberEventBody.html +6 -0
  39. package/api_docs/ts/interfaces/MemberInvitedEvent.html +15 -0
  40. package/api_docs/ts/interfaces/MemberJoinedEvent.html +15 -0
  41. package/api_docs/ts/interfaces/MemberLeftEvent.html +15 -0
  42. package/api_docs/ts/interfaces/MemberTimestamp.html +5 -0
  43. package/api_docs/ts/interfaces/MembersPage.html +8 -0
  44. package/api_docs/ts/interfaces/MessageAudioEvent.html +15 -0
  45. package/api_docs/ts/interfaces/MessageAudioEventBody.html +6 -0
  46. package/api_docs/ts/interfaces/MessageCustomEvent.html +15 -0
  47. package/api_docs/ts/interfaces/MessageCustomEventBody.html +6 -0
  48. package/api_docs/ts/interfaces/MessageFileEvent.html +15 -0
  49. package/api_docs/ts/interfaces/MessageFileEventBody.html +7 -0
  50. package/api_docs/ts/interfaces/MessageImageEvent.html +15 -0
  51. package/api_docs/ts/interfaces/MessageImageEventBody.html +7 -0
  52. package/api_docs/ts/interfaces/MessageLocationEvent.html +15 -0
  53. package/api_docs/ts/interfaces/MessageLocationEventBody.html +7 -0
  54. package/api_docs/ts/interfaces/MessageTemplateEvent.html +15 -0
  55. package/api_docs/ts/interfaces/MessageTemplateEventBody.html +10 -0
  56. package/api_docs/ts/interfaces/MessageTextEvent.html +15 -0
  57. package/api_docs/ts/interfaces/MessageTextEventBody.html +7 -0
  58. package/api_docs/ts/interfaces/MessageVCardEvent.html +15 -0
  59. package/api_docs/ts/interfaces/MessageVCardEventBody.html +7 -0
  60. package/api_docs/ts/interfaces/MessageVideoEvent.html +15 -0
  61. package/api_docs/ts/interfaces/MessageVideoEventBody.html +7 -0
  62. package/api_docs/ts/interfaces/RTCQuality.html +11 -0
  63. package/api_docs/ts/interfaces/RtcStats.html +11 -0
  64. package/api_docs/ts/interfaces/System.html +7 -0
  65. package/api_docs/ts/interfaces/Template.html +4 -0
  66. package/api_docs/ts/interfaces/UpdateConversationParameters.html +17 -0
  67. package/api_docs/ts/interfaces/User.html +16 -0
  68. package/api_docs/ts/interfaces/UserChannels.html +14 -0
  69. package/api_docs/ts/interfaces/UserTimestamp.html +5 -0
  70. package/api_docs/ts/interfaces/VonageEvent.html +2 -0
  71. package/api_docs/ts/interfaces/VonageLogger.html +10 -0
  72. package/api_docs/ts/interfaces/Whatsapp.html +4 -0
  73. package/api_docs/ts/modules.html +82 -0
  74. package/api_docs/ts/types/ChannelType.html +2 -0
  75. package/api_docs/ts/types/ConfigRegion.html +3 -0
  76. package/api_docs/ts/types/ConversationEvent.html +2 -0
  77. package/api_docs/ts/types/ConversationState.html +2 -0
  78. package/api_docs/ts/types/CustomData.html +3 -0
  79. package/api_docs/ts/types/From.html +2 -0
  80. package/api_docs/ts/types/Json.html +2 -0
  81. package/api_docs/ts/types/JsonValue.html +2 -0
  82. package/api_docs/ts/types/LoggingLevel.html +4 -0
  83. package/api_docs/ts/types/MemberState.html +2 -0
  84. package/api_docs/ts/types/NonPersistentConversationEvent.html +2 -0
  85. package/api_docs/ts/types/Option.html +3 -0
  86. package/api_docs/ts/types/OrderBy.html +2 -0
  87. package/api_docs/ts/types/PersistentConversationEvent.html +2 -0
  88. package/api_docs/ts/types/PresentingOrder.html +2 -0
  89. package/api_docs/ts/types/Topics.html +2 -0
  90. package/api_docs/ts/variables/Topics-1.html +2 -0
  91. package/dist/client/VonageClient.d.ts +260 -29
  92. package/dist/client/index.cjs +28243 -23482
  93. package/dist/client/index.mjs +28237 -23481
  94. package/dist/coreExtend.d.ts +9 -13
  95. package/dist/kotlin/JsUnions.d.ts +143 -92
  96. package/dist/kotlin/clientsdk-clientcore_js.d.ts +268 -197
  97. package/dist/lib/MediaClient.d.ts +1 -1
  98. package/dist/lib/SocketClient.d.ts +7 -2
  99. package/dist/utils/ClientConfig.d.ts +72 -21
  100. package/dist/utils/ConversationEventBodies.d.ts +134 -0
  101. package/dist/utils/ConversationModels.d.ts +150 -12
  102. package/dist/utils/ErrorModels.d.ts +1 -0
  103. package/dist/utils/JsonUtils.d.ts +15 -0
  104. package/dist/utils/Option.d.ts +20 -0
  105. package/dist/utils/RequestParameterModels.d.ts +108 -0
  106. package/dist/utils/index.d.ts +6 -2
  107. package/dist/utils/logging.d.ts +53 -1
  108. package/dist/vonageClientSDK.js +27845 -22942
  109. package/dist/vonageClientSDK.min.js +1 -1
  110. package/dist/vonageClientSDK.min.mjs +1 -1
  111. package/dist/vonageClientSDK.mjs +27839 -22941
  112. package/package.json +7 -3
  113. package/scripts/replaceAllDoNotUseOrImplement.js +25 -0
  114. package/typedoc.json +43 -0
  115. package/dist/global.d.ts +0 -7
  116. package/dist/utils/ConnectivityManager.d.ts +0 -11
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vonage/client-sdk",
3
- "version": "1.2.1-beta.6",
3
+ "version": "1.2.1-snapshot.100.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "module": "dist/client/index.mjs",
@@ -24,14 +24,16 @@
24
24
  "copy:dist": "mkdir dist/kotlin; cp ./src/kotlin/**.d.ts ./dist/kotlin/",
25
25
  "build": "npm run copy:core; rollup -c; npm run copy:dist",
26
26
  "build:rollup": "rollup -c",
27
- "build:readme": "chmod +x ./docs/generate_readme.sh; ./docs/generate_readme.sh",
27
+ "build:readme": "./docs/generate_readme.sh",
28
28
  "snippets": "node snippet.js $PWD",
29
29
  "start": "node dist/Client.js",
30
30
  "build:watch": "tsc -w",
31
31
  "check": "tsc --project ./examples/tsconfig.json --noEmit --skipLibCheck --strictNullChecks true",
32
32
  "lint": "eslint . --ext .ts",
33
33
  "lint:fix": "eslint . --ext .ts --fix",
34
- "clean": "rm -Rf node_modules/*; rm -Rf dist/"
34
+ "clean": "rm -Rf node_modules/*; rm -Rf dist/",
35
+ "build:docs": "typedoc --includeVersion --tsconfig ./tsconfig.json --out api_docs/ts src/client/index.ts --includes examples/snippets --disableSources",
36
+ "clean:doNotUseOrImplementIt": "node ./scripts/replaceAllDoNotUseOrImplement.js ./src/kotlin/clientsdk-clientcore_js.d.ts && node ./scripts/replaceAllDoNotUseOrImplement.js ./dist/kotlin/clientsdk-clientcore_js.d.ts"
35
37
  },
36
38
  "author": "Vonage CS Team <nexmo.rtc.ci@vonage.com> (https://developer.vonage.com/client-sdk/overview)",
37
39
  "license": "SEE LICENSE IN LICENSE",
@@ -69,6 +71,7 @@
69
71
  "rollup-plugin-swc3": "^0.8.0",
70
72
  "rollup-plugin-typescript2": "^0.34.1",
71
73
  "tslib": "^2.4.1",
74
+ "typedoc": "^0.25.4",
72
75
  "typescript": "^4.9.4"
73
76
  },
74
77
  "dependencies": {
@@ -78,6 +81,7 @@
78
81
  "sdp-transform": "^2.14.1",
79
82
  "socket.io-client": "^4.7.2",
80
83
  "socketio-wildcard": "^2.0.0",
84
+ "typedoc-plugin-missing-exports": "^2.1.0",
81
85
  "webrtc-adapter": "^8.2.3"
82
86
  }
83
87
  }
@@ -0,0 +1,25 @@
1
+ import { readFileSync, writeFileSync } from 'fs';
2
+
3
+ function replaceAllDoNotUseOrImplement(filePath) {
4
+ const oldLines = readFileSync(filePath, 'utf8').split('\n');
5
+ const newLines = [];
6
+
7
+ let toSkip = false;
8
+
9
+ for (let line of oldLines) {
10
+ if (line.includes('__doNotUseOrImplementIt')) {
11
+ toSkip = !line.includes(';');
12
+ continue;
13
+ } else if (toSkip) {
14
+ toSkip = !line.includes('};');
15
+ continue;
16
+ }
17
+
18
+ newLines.push(line);
19
+ }
20
+
21
+ writeFileSync(filePath, newLines.join('\n'), 'utf8');
22
+ }
23
+
24
+ const filePath = process.argv[2];
25
+ replaceAllDoNotUseOrImplement(filePath);
package/typedoc.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "$schema": "https://typedoc.org/schema.json",
3
+ "disableSources": true,
4
+ "hideGenerator": true,
5
+ "navigation": {
6
+ "includeCategories": true,
7
+ "includeGroups": true
8
+ },
9
+ "excludeInternal": true,
10
+ // "plugin": ["typedoc-plugin-missing-exports"],
11
+ "categorizeByGroup": true,
12
+ "visibilityFilters": {
13
+ "protected": false,
14
+ "private": false,
15
+ "inherited": true,
16
+ "external": true,
17
+ "@alpha": true,
18
+ "@beta": true
19
+ },
20
+ "excludeReferences": true,
21
+ "excludeNotDocumented": true,
22
+ "excludeNotDocumentedKinds": [
23
+ "Module",
24
+ "Namespace",
25
+ // "Enum",
26
+ // "EnumMember",
27
+ "Variable",
28
+ "Function",
29
+ // "Class",
30
+ // "Interface",
31
+ // "Constructor",
32
+ // "Property",
33
+ "Method",
34
+ "CallSignature",
35
+ "IndexSignature",
36
+ "ConstructorSignature",
37
+ // "Accessor",
38
+ // "GetSignature",
39
+ // "SetSignature",
40
+ "TypeAlias",
41
+ "Reference"
42
+ ]
43
+ }
package/dist/global.d.ts DELETED
@@ -1,7 +0,0 @@
1
- declare global {
2
- type JsonValue = object | null | boolean | string | number;
3
- type Json = {
4
- [property: string]: Json | JsonValue;
5
- } | Json[];
6
- }
7
- export {};
@@ -1,11 +0,0 @@
1
- import * as KMPPackage from '../kotlin/clientsdk-clientcore_js';
2
- import vonage from '../utils/vonage';
3
- export declare class ConnectivityManager {
4
- private legId;
5
- private isOnline;
6
- private delegate;
7
- handleNetworkChange(): void;
8
- constructor();
9
- setLegId(legId: string, delegate: KMPPackage.Nullable<vonage.MediaClientDelegateJS>): void;
10
- unsetLegId(): void;
11
- }