@webex/calling 0.0.1-next.0 → 0.0.1-next.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 (122) hide show
  1. package/README.md +51 -66
  2. package/dist/module/CallHistory/CallHistory.js +84 -84
  3. package/dist/module/CallHistory/callHistoryFixtures.js +307 -307
  4. package/dist/module/CallHistory/constants.js +9 -9
  5. package/dist/module/CallHistory/types.js +1 -1
  6. package/dist/module/CallSettings/CallSettings.js +65 -65
  7. package/dist/module/CallSettings/UcmBackendConnector.js +100 -100
  8. package/dist/module/CallSettings/WxCallBackendConnector.js +287 -287
  9. package/dist/module/CallSettings/constants.js +11 -11
  10. package/dist/module/CallSettings/testFixtures.js +62 -62
  11. package/dist/module/CallSettings/types.js +1 -1
  12. package/dist/module/CallingClient/CallingClient.js +268 -268
  13. package/dist/module/CallingClient/callRecordFixtures.js +93 -93
  14. package/dist/module/CallingClient/calling/CallerId/index.js +169 -169
  15. package/dist/module/CallingClient/calling/CallerId/types.js +1 -1
  16. package/dist/module/CallingClient/calling/call.js +1649 -1649
  17. package/dist/module/CallingClient/calling/callManager.js +274 -274
  18. package/dist/module/CallingClient/calling/index.js +2 -2
  19. package/dist/module/CallingClient/calling/types.js +53 -53
  20. package/dist/module/CallingClient/callingClientFixtures.js +38 -38
  21. package/dist/module/CallingClient/constants.js +122 -122
  22. package/dist/module/CallingClient/line/index.js +110 -110
  23. package/dist/module/CallingClient/line/types.js +14 -14
  24. package/dist/module/CallingClient/registration/index.js +1 -1
  25. package/dist/module/CallingClient/registration/register.js +507 -507
  26. package/dist/module/CallingClient/registration/registerFixtures.js +28 -28
  27. package/dist/module/CallingClient/registration/types.js +1 -1
  28. package/dist/module/CallingClient/types.js +1 -1
  29. package/dist/module/Contacts/ContactsClient.js +487 -487
  30. package/dist/module/Contacts/constants.js +20 -20
  31. package/dist/module/Contacts/contactFixtures.js +284 -284
  32. package/dist/module/Contacts/types.js +10 -10
  33. package/dist/module/Errors/catalog/CallError.js +26 -26
  34. package/dist/module/Errors/catalog/CallingDeviceError.js +18 -18
  35. package/dist/module/Errors/catalog/ExtendedError.js +10 -10
  36. package/dist/module/Errors/catalog/LineError.js +24 -24
  37. package/dist/module/Errors/index.js +2 -2
  38. package/dist/module/Errors/types.js +48 -48
  39. package/dist/module/Events/impl/index.js +19 -19
  40. package/dist/module/Events/types.js +74 -74
  41. package/dist/module/Logger/index.js +114 -114
  42. package/dist/module/Logger/types.js +25 -25
  43. package/dist/module/Metrics/index.js +232 -232
  44. package/dist/module/Metrics/types.js +37 -37
  45. package/dist/module/SDKConnector/index.js +39 -39
  46. package/dist/module/SDKConnector/types.js +1 -1
  47. package/dist/module/SDKConnector/utils.js +12 -12
  48. package/dist/module/Voicemail/BroadworksBackendConnector.js +289 -289
  49. package/dist/module/Voicemail/UcmBackendConnector.js +275 -275
  50. package/dist/module/Voicemail/Voicemail.js +110 -110
  51. package/dist/module/Voicemail/WxCallBackendConnector.js +279 -279
  52. package/dist/module/Voicemail/constants.js +29 -29
  53. package/dist/module/Voicemail/types.js +1 -1
  54. package/dist/module/Voicemail/voicemailFixture.js +449 -449
  55. package/dist/module/common/Utils.js +802 -802
  56. package/dist/module/common/constants.js +40 -40
  57. package/dist/module/common/index.js +1 -1
  58. package/dist/module/common/testUtil.js +938 -938
  59. package/dist/module/common/types.js +57 -57
  60. package/dist/module/index.js +8 -8
  61. package/dist/types/CallHistory/CallHistory.d.ts +18 -18
  62. package/dist/types/CallHistory/callHistoryFixtures.d.ts +94 -94
  63. package/dist/types/CallHistory/constants.d.ts +9 -9
  64. package/dist/types/CallHistory/types.d.ts +20 -20
  65. package/dist/types/CallSettings/CallSettings.d.ts +19 -19
  66. package/dist/types/CallSettings/UcmBackendConnector.d.ts +19 -19
  67. package/dist/types/CallSettings/WxCallBackendConnector.d.ts +21 -21
  68. package/dist/types/CallSettings/constants.d.ts +11 -11
  69. package/dist/types/CallSettings/testFixtures.d.ts +15 -15
  70. package/dist/types/CallSettings/types.d.ts +107 -107
  71. package/dist/types/CallingClient/CallingClient.d.ts +37 -37
  72. package/dist/types/CallingClient/callRecordFixtures.d.ts +3 -3
  73. package/dist/types/CallingClient/calling/CallerId/index.d.ts +17 -17
  74. package/dist/types/CallingClient/calling/CallerId/types.d.ts +41 -41
  75. package/dist/types/CallingClient/calling/call.d.ts +94 -94
  76. package/dist/types/CallingClient/calling/call.d.ts.map +1 -1
  77. package/dist/types/CallingClient/calling/callManager.d.ts +21 -21
  78. package/dist/types/CallingClient/calling/index.d.ts +2 -2
  79. package/dist/types/CallingClient/calling/types.d.ts +203 -203
  80. package/dist/types/CallingClient/calling/types.d.ts.map +1 -1
  81. package/dist/types/CallingClient/callingClientFixtures.d.ts +18 -18
  82. package/dist/types/CallingClient/constants.d.ts +122 -122
  83. package/dist/types/CallingClient/line/index.d.ts +38 -38
  84. package/dist/types/CallingClient/line/types.d.ts +50 -50
  85. package/dist/types/CallingClient/registration/index.d.ts +1 -1
  86. package/dist/types/CallingClient/registration/register.d.ts +64 -64
  87. package/dist/types/CallingClient/registration/registerFixtures.d.ts +28 -28
  88. package/dist/types/CallingClient/registration/types.d.ts +20 -20
  89. package/dist/types/CallingClient/types.d.ts +29 -29
  90. package/dist/types/Contacts/ContactsClient.d.ts +27 -27
  91. package/dist/types/Contacts/constants.d.ts +19 -19
  92. package/dist/types/Contacts/contactFixtures.d.ts +280 -280
  93. package/dist/types/Contacts/types.d.ts +74 -74
  94. package/dist/types/Errors/catalog/CallError.d.ts +11 -11
  95. package/dist/types/Errors/catalog/CallingDeviceError.d.ts +10 -10
  96. package/dist/types/Errors/catalog/ExtendedError.d.ts +6 -6
  97. package/dist/types/Errors/catalog/LineError.d.ts +10 -10
  98. package/dist/types/Errors/index.d.ts +2 -2
  99. package/dist/types/Errors/types.d.ts +60 -60
  100. package/dist/types/Events/impl/index.d.ts +8 -8
  101. package/dist/types/Events/types.d.ts +283 -283
  102. package/dist/types/Logger/index.d.ts +12 -12
  103. package/dist/types/Logger/types.d.ts +25 -25
  104. package/dist/types/Metrics/index.d.ts +5 -5
  105. package/dist/types/Metrics/types.d.ts +42 -42
  106. package/dist/types/SDKConnector/index.d.ts +12 -12
  107. package/dist/types/SDKConnector/types.d.ts +128 -128
  108. package/dist/types/SDKConnector/utils.d.ts +5 -5
  109. package/dist/types/Voicemail/BroadworksBackendConnector.d.ts +27 -27
  110. package/dist/types/Voicemail/UcmBackendConnector.d.ts +34 -34
  111. package/dist/types/Voicemail/Voicemail.d.ts +27 -27
  112. package/dist/types/Voicemail/WxCallBackendConnector.d.ts +23 -23
  113. package/dist/types/Voicemail/constants.d.ts +29 -29
  114. package/dist/types/Voicemail/types.d.ts +133 -133
  115. package/dist/types/Voicemail/voicemailFixture.d.ts +349 -349
  116. package/dist/types/common/Utils.d.ts +34 -34
  117. package/dist/types/common/constants.d.ts +40 -40
  118. package/dist/types/common/index.d.ts +1 -1
  119. package/dist/types/common/testUtil.d.ts +3611 -3611
  120. package/dist/types/common/types.d.ts +191 -191
  121. package/dist/types/index.d.ts +8 -8
  122. package/package.json +6 -41
package/README.md CHANGED
@@ -1,67 +1,52 @@
1
- # web-calling-sdk
2
-
3
- > A framework for interacting with Web Calling API across multiple browsers.
4
-
5
- > API guide https://sqbu-github.cisco.com/pages/webrtc-calling/mobius/mobius-api-spec/docs/
6
- > Registration flow details https://wiki.cisco.com/display/IPCBU/Registration+Flows
7
- > Calling SDK API https://wiki.cisco.com/display/IPCBU/Calling+SDK+API
8
-
9
- ## Developing
10
-
11
- ```shell
12
- git clone https://github.com/webex/webex-js-sdk.git
13
- cd web-js-sdk/
14
- yarn i
15
- ```
16
-
17
- ### Building
18
-
19
- If your project needs some additional steps for the developer to build the
20
- project after some code changes, state them here:
21
-
22
- ```shell
23
- yarn workspaces foreach --parallel --verbose run build:src
24
-
25
- yarn workspace @webex/calling run build
26
- ```
27
-
28
- ### Testing
29
-
30
- ```shell
31
- yarn workspace @webex/calling run test
32
- ```
33
-
34
-
35
- ### Testing on samples // This will change in future for now
36
-
37
- ```
38
- yarn workspace @webex/calling run build:browser
39
- yarn run samples:serve
40
- ```
41
-
42
-
43
- ### Deploying / Publishing
44
-
45
- In case there's some step you have to take that publishes this project to a
46
- server, this is the right time to state it.
47
-
48
- ```shell
49
- yarn release
50
- ```
51
-
52
- ### Consuming the SDK
53
-
54
- The Calling SDK package can be incorporated into an existing project by updating the .npmrc and package.json. Add the line pasted below to get access to the calling-sdk package located in the artifactory.
55
-
56
- ```shell
57
- @webex:registry=https://engci-maven.cisco.com/artifactory/api/npm/webex-npm-group
58
- ```
59
-
60
- Use the following commands to update the package.json and package.lock/yarn.lock with the latest version of the calling-sdk package.
61
- ```shell
62
- npm install @webex/web-calling-sdk
63
- ```
64
- (or)
65
- ```shell
66
- yarn add @webex/web-calling-sdk
1
+ # @webex/calling
2
+
3
+ With the Webex Calling SDK, you can effortlessly integrate fundamental audio calling capabilities into your solutions, enhancing the way your users connect.
4
+
5
+ > [Introduction to the Webex Web Calling SDK](https://github.com/webex/webex-js-sdk/wiki/Introducing-the-Webex-Web-Calling-SDK)
6
+ > [Quickstart guide](https://github.com/webex/webex-js-sdk/wiki/Quickstart-Guide-(Calling))
7
+ > API guide - TBD
8
+
9
+
10
+ ## Developing
11
+
12
+ ```shell
13
+ git clone https://github.com/\<your-fork\>/webex-js-sdk.git
14
+ cd web-js-sdk/
15
+ yarn install
16
+ ```
17
+
18
+ ### Building
19
+
20
+ If your project needs some additional steps for the developer to build the
21
+ project after some code changes, state them here:
22
+
23
+ ```shell
24
+ yarn workspaces foreach --parallel --verbose run build:src
25
+
26
+ yarn build:local
27
+ ```
28
+
29
+ ### Testing
30
+
31
+ ```shell
32
+ yarn workspace @webex/calling run test
33
+ ```
34
+
35
+ ### Testing on samples
36
+ ```shell
37
+ yarn run samples:serve
38
+ ```
39
+
40
+ ### Consuming the SDK
41
+
42
+ The Calling package can be incorporated into an existing project by updating the package.json. Add the line pasted below to get access to the calling-sdk package located in the artifactory.
43
+
44
+
45
+ Use the following commands to update the package.json and package.lock/yarn.lock with the latest version of the calling-sdk package.
46
+ ```shell
47
+ npm install @webex/web-calling-sdk
48
+ ```
49
+ (or)
50
+ ```shell
51
+ yarn add @webex/web-calling-sdk
67
52
  ```
@@ -1,84 +1,84 @@
1
- import SDKConnector from '../SDKConnector';
2
- import { ALLOWED_SERVICES, HTTP_METHODS, SORT, SORT_BY } from '../common/types';
3
- import log from '../Logger';
4
- import { serviceErrorCodeHandler } from '../common/Utils';
5
- import { CALL_HISTORY_FILE, FROM_DATE, HISTORY, LIMIT, NUMBER_OF_DAYS } from './constants';
6
- import { STATUS_CODE, SUCCESS_MESSAGE, USER_SESSIONS } from '../common/constants';
7
- import { EVENT_KEYS, MOBIUS_EVENT_KEYS, } from '../Events/types';
8
- import { Eventing } from '../Events/impl';
9
- export class CallHistory extends Eventing {
10
- sdkConnector;
11
- webex;
12
- janusUrl = '';
13
- fromDate = '';
14
- loggerContext = {
15
- file: CALL_HISTORY_FILE,
16
- method: 'getCallHistoryData',
17
- };
18
- userSessions;
19
- constructor(webex, logger) {
20
- super();
21
- this.sdkConnector = SDKConnector;
22
- if (!this.sdkConnector.getWebex()) {
23
- SDKConnector.setWebex(webex);
24
- }
25
- this.webex = this.sdkConnector.getWebex();
26
- this.janusUrl = this.webex.internal.services._serviceUrls.janus;
27
- this.registerSessionsListener();
28
- log.setLogger(logger.level, CALL_HISTORY_FILE);
29
- }
30
- async getCallHistoryData(days = NUMBER_OF_DAYS, limit = LIMIT, sort = SORT.DEFAULT, sortBy = SORT_BY.DEFAULT) {
31
- const date = new Date();
32
- date.setDate(date.getDate() - days);
33
- this.fromDate = date.toISOString();
34
- const sortByParam = Object.values(SORT_BY).includes(sortBy) ? sortBy : SORT_BY.DEFAULT;
35
- const sortParam = Object.values(SORT).includes(sort) ? sort : SORT.DEFAULT;
36
- log.log(`Janus API URL ${this.janusUrl}`, this.loggerContext);
37
- log.info(`Call history from date : ${this.fromDate}`, this.loggerContext);
38
- log.info(`Call history sort type : ${sortParam}`, this.loggerContext);
39
- log.info(`Call history sortby type : ${sortByParam}`, this.loggerContext);
40
- const url = `${this.janusUrl}/${HISTORY}/${USER_SESSIONS}${FROM_DATE}=${this.fromDate}&limit=${limit}&includeNewSessionTypes=true&sort=${sortParam}`;
41
- try {
42
- const janusResponse = await this.webex.request({
43
- uri: `${url}`,
44
- method: HTTP_METHODS.GET,
45
- service: ALLOWED_SERVICES.JANUS,
46
- });
47
- this.userSessions = janusResponse.body;
48
- if (sortByParam === SORT_BY.START_TIME) {
49
- if (sortParam === SORT.DESC) {
50
- this.userSessions[USER_SESSIONS].sort((element, compareElement) => new Date(compareElement[sortByParam]).getTime() -
51
- new Date(element[sortByParam]).getTime());
52
- }
53
- else if (sortParam === SORT.ASC) {
54
- this.userSessions[USER_SESSIONS].sort((element, compareElement) => new Date(element[sortByParam]).getTime() -
55
- new Date(compareElement[sortByParam]).getTime());
56
- }
57
- }
58
- const responseDetails = {
59
- statusCode: this.userSessions[STATUS_CODE],
60
- data: {
61
- userSessions: this.userSessions[USER_SESSIONS],
62
- },
63
- message: SUCCESS_MESSAGE,
64
- };
65
- return responseDetails;
66
- }
67
- catch (err) {
68
- const errorInfo = err;
69
- const errorStatus = serviceErrorCodeHandler(errorInfo, this.loggerContext);
70
- return errorStatus;
71
- }
72
- }
73
- getSDKConnector() {
74
- return this.sdkConnector;
75
- }
76
- registerSessionsListener() {
77
- this.sdkConnector.registerListener(MOBIUS_EVENT_KEYS.CALL_SESSION_EVENT_INCLUSIVE, async (event) => {
78
- if (event && event.data.userSessions.userSessions) {
79
- this.emit(EVENT_KEYS.CALL_HISTORY_USER_SESSION_INFO, event);
80
- }
81
- });
82
- }
83
- }
84
- export const createCallHistoryClient = (webex, logger) => new CallHistory(webex, logger);
1
+ import SDKConnector from '../SDKConnector';
2
+ import { ALLOWED_SERVICES, HTTP_METHODS, SORT, SORT_BY } from '../common/types';
3
+ import log from '../Logger';
4
+ import { serviceErrorCodeHandler } from '../common/Utils';
5
+ import { CALL_HISTORY_FILE, FROM_DATE, HISTORY, LIMIT, NUMBER_OF_DAYS } from './constants';
6
+ import { STATUS_CODE, SUCCESS_MESSAGE, USER_SESSIONS } from '../common/constants';
7
+ import { EVENT_KEYS, MOBIUS_EVENT_KEYS, } from '../Events/types';
8
+ import { Eventing } from '../Events/impl';
9
+ export class CallHistory extends Eventing {
10
+ sdkConnector;
11
+ webex;
12
+ janusUrl = '';
13
+ fromDate = '';
14
+ loggerContext = {
15
+ file: CALL_HISTORY_FILE,
16
+ method: 'getCallHistoryData',
17
+ };
18
+ userSessions;
19
+ constructor(webex, logger) {
20
+ super();
21
+ this.sdkConnector = SDKConnector;
22
+ if (!this.sdkConnector.getWebex()) {
23
+ SDKConnector.setWebex(webex);
24
+ }
25
+ this.webex = this.sdkConnector.getWebex();
26
+ this.janusUrl = this.webex.internal.services._serviceUrls.janus;
27
+ this.registerSessionsListener();
28
+ log.setLogger(logger.level, CALL_HISTORY_FILE);
29
+ }
30
+ async getCallHistoryData(days = NUMBER_OF_DAYS, limit = LIMIT, sort = SORT.DEFAULT, sortBy = SORT_BY.DEFAULT) {
31
+ const date = new Date();
32
+ date.setDate(date.getDate() - days);
33
+ this.fromDate = date.toISOString();
34
+ const sortByParam = Object.values(SORT_BY).includes(sortBy) ? sortBy : SORT_BY.DEFAULT;
35
+ const sortParam = Object.values(SORT).includes(sort) ? sort : SORT.DEFAULT;
36
+ log.log(`Janus API URL ${this.janusUrl}`, this.loggerContext);
37
+ log.info(`Call history from date : ${this.fromDate}`, this.loggerContext);
38
+ log.info(`Call history sort type : ${sortParam}`, this.loggerContext);
39
+ log.info(`Call history sortby type : ${sortByParam}`, this.loggerContext);
40
+ const url = `${this.janusUrl}/${HISTORY}/${USER_SESSIONS}${FROM_DATE}=${this.fromDate}&limit=${limit}&includeNewSessionTypes=true&sort=${sortParam}`;
41
+ try {
42
+ const janusResponse = await this.webex.request({
43
+ uri: `${url}`,
44
+ method: HTTP_METHODS.GET,
45
+ service: ALLOWED_SERVICES.JANUS,
46
+ });
47
+ this.userSessions = janusResponse.body;
48
+ if (sortByParam === SORT_BY.START_TIME) {
49
+ if (sortParam === SORT.DESC) {
50
+ this.userSessions[USER_SESSIONS].sort((element, compareElement) => new Date(compareElement[sortByParam]).getTime() -
51
+ new Date(element[sortByParam]).getTime());
52
+ }
53
+ else if (sortParam === SORT.ASC) {
54
+ this.userSessions[USER_SESSIONS].sort((element, compareElement) => new Date(element[sortByParam]).getTime() -
55
+ new Date(compareElement[sortByParam]).getTime());
56
+ }
57
+ }
58
+ const responseDetails = {
59
+ statusCode: this.userSessions[STATUS_CODE],
60
+ data: {
61
+ userSessions: this.userSessions[USER_SESSIONS],
62
+ },
63
+ message: SUCCESS_MESSAGE,
64
+ };
65
+ return responseDetails;
66
+ }
67
+ catch (err) {
68
+ const errorInfo = err;
69
+ const errorStatus = serviceErrorCodeHandler(errorInfo, this.loggerContext);
70
+ return errorStatus;
71
+ }
72
+ }
73
+ getSDKConnector() {
74
+ return this.sdkConnector;
75
+ }
76
+ registerSessionsListener() {
77
+ this.sdkConnector.registerListener(MOBIUS_EVENT_KEYS.CALL_SESSION_EVENT_INCLUSIVE, async (event) => {
78
+ if (event && event.data.userSessions.userSessions) {
79
+ this.emit(EVENT_KEYS.CALL_HISTORY_USER_SESSION_INFO, event);
80
+ }
81
+ });
82
+ }
83
+ }
84
+ export const createCallHistoryClient = (webex, logger) => new CallHistory(webex, logger);