@webex/event-dictionary-ts 0.0.3 → 0.0.1236

package/README.md

@@ -1,4 +1,46 @@
 # @webex/event-dictionary-ts
 
-This package is used as a type-only module to provide typing to the event
-tooling within the various `@webex` packages.
+This package is designed as a *type module* to be consumed within various `@webex` scoped packages. This module reflects the contents of our event dictionary tooling internally, exposed for external consumption.
+
+## Table of Contents
+
+* [Consumption](#consumption)
+  * [Installation](#installation)
+  * [Usage](#usage)
+* [Contribute](#contribute)
+* [Maintainers](#maintainers)
+
+## Consumption
+
+This package is intended to be consumed within a [TypeScript](https://www.typescriptlang.org/) project as a *type module*.
+
+### Installation
+
+This project is meant to be consumed as a **dev-dependency**.
+
+Installation can be performed by using the following commands:
+
+```bash
+# Project root
+yarn add --dev @webex/event-dictionary-ts
+```
+
+### Usage
+
+This package is expected to be consumed as a TypeScript *type module*.
+
+```ts
+import type { Event } from '@webex/event-dictionary-ts';
+```
+
+To see a full list of event interfaces, please inspect the `./dist/index.d.ts` file from the root of this module.
+
+## Contribute
+
+This product is a reflection of our internal event designations and is not intended to be contributed to externally, and exists only as a permeable resource for other products interacting with our metrics service.
+
+## Maintainers
+
+This package is maintained by [Webex by Cisco](https://www.webex.com/)
+
+

package/generated/typescript/index.d.ts

@@ -235,6 +235,14 @@ export interface Event {
         canProceed: boolean;
         state?: string;
         mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+        /**
+         * Details associated with a share floor type
+         */
+        floorType?: {
+          name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+          priority?: {};
+          additionalProperties?: false;
+        };
         csi?: number;
         /**
          * media capability for both transmit and receive
@@ -267,7 +275,7 @@ export interface Event {
           additionalProperties?: false;
         };
         mediaLines?: {
-          mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+          mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
           remoteIP?: string;
           localIP?: string;
           localNetworkPrefix?: string;
@@ -820,6 +828,18 @@ export interface Event {
           granted?: "one_way" | "two_way";
           additionalProperties?: false;
         };
+        /**
+         * Pstn Carrier Infos
+         */
+        pstnCarrierInfo?: {
+          cic?: string;
+          carrierName?: string;
+          ucreDnsSrvs?: string[];
+          additionalProperties?: false;
+        };
+        pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+        l2sipCallbackUrl?: string;
+        ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
         name:
           | "client.alert.displayed"
           | "client.alert.removed"
@@ -885,10 +905,12 @@ export interface Event {
           | "client.locus.media.request"
           | "client.locus.media.response"
           | "client.media-engine.crash"
+          | "client.media-engine.launched"
           | "client.media-engine.lost"
           | "client.media-engine.local-sdp-generated"
           | "client.media-engine.ready"
           | "client.media-engine.remote-sdp-received"
+          | "client.media-engine.start-launch"
           | "client.media-status"
           | "client.media.capabilities"
           | "client.media.reachability"
@@ -957,6 +979,8 @@ export interface Event {
           | "client.muted"
           | "client.network.changed"
           | "client.notification.received"
+          | "client.onboarding-window.start"
+          | "client.onboarding-window.end"
           | "client.permission.closed"
           | "client.permission.prompted"
           | "client.pin.collected"
@@ -2946,6 +2970,14 @@ export interface Event {
            * iOS specific. The audio session is activated.
            */
           iosAudioSessionActiveTime?: number;
+          /**
+           * If the call was started in background then when the user unlocks the screen the time is recorded. At this time the camera will be opened. Meaningful only on iOS.
+           */
+          switchedToForegroundTime?: number;
+          /**
+           * The time between call join and call close.
+           */
+          callDuration?: number;
           additionalProperties?: false;
         };
         /**
@@ -2954,10 +2986,13 @@ export interface Event {
         wxcCallMetadata?: {
           bwcCallType?: "Sip" | "Xsi" | "Other";
           callAcceptInBackground?: boolean;
+          callNegotiatedAsVideo?: boolean;
           callOrigin?: string;
           callType?: string;
           endReason?: string;
+          iceEnabled?: boolean;
           iosAcceptCallImmediately?: boolean;
+          ipv6Negotiated?: boolean;
           mediaCreateOnCallCreate?: boolean;
           mediaStartOnCallCreate?: boolean;
           wxcCallId?: string;
@@ -2969,6 +3004,14 @@ export interface Event {
         canProceed: boolean;
         state?: string;
         mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+        /**
+         * Details associated with a share floor type
+         */
+        floorType?: {
+          name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+          priority?: {};
+          additionalProperties?: false;
+        };
         csi?: number;
         /**
          * media capability for both transmit and receive
@@ -3001,7 +3044,7 @@ export interface Event {
           additionalProperties?: false;
         };
         mediaLines?: {
-          mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+          mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
           remoteIP?: string;
           localIP?: string;
           localNetworkPrefix?: string;
@@ -3661,6 +3704,18 @@ export interface Event {
           seq?: number;
           additionalProperties?: false;
         };
+        /**
+         * Pstn Carrier Infos
+         */
+        pstnCarrierInfo?: {
+          cic?: string;
+          carrierName?: string;
+          ucreDnsSrvs?: string[];
+          additionalProperties?: false;
+        };
+        pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+        l2sipCallbackUrl?: string;
+        ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
         remoteAgent?: string;
         name:
           | "breakout.breakout-session.move.initiated"
@@ -3687,6 +3742,8 @@ export interface Event {
           | "ivr.join.response"
           | "ivr.l2sip.call.request"
           | "ivr.l2sip.call.response"
+          | "ivr.l2sip.createmedia.request"
+          | "ivr.l2sip.createmedia.response"
           | "ivr.l2sip.dialing.status"
           | "ivr.l2sip.terminate.request"
           | "ivr.l2sip.terminate.response"
@@ -3697,6 +3754,8 @@ export interface Event {
           | "ivr.locus.connect.request"
           | "ivr.locus.connect.response"
           | "ivr.locus.connect.status.update"
+          | "ivr.locus.handover.request"
+          | "ivr.locus.handover.response"
           | "ivr.mrs.meetinginfo.query"
           | "ivr.mrs.routingprofile.query"
           | "ivr.notify.request"
@@ -4275,6 +4334,7 @@ export interface Event {
             meetingType?: string;
             numberOfClustersTried?: number;
             preferredClustersLoadBalanced?: string[];
+            preferTranscode?: boolean;
             reachableCloudReachabilityClustersCount?: number;
             reachableHybridMediaReachabilityClustersCount?: number;
             reachabilityClusters?: string[];
@@ -4535,6 +4595,14 @@ export interface Event {
         canProceed: boolean;
         state?: string;
         mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+        /**
+         * Details associated with a share floor type
+         */
+        floorType?: {
+          name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+          priority?: {};
+          additionalProperties?: false;
+        };
         csi?: number;
         /**
          * media capability for both transmit and receive
@@ -4567,7 +4635,7 @@ export interface Event {
           additionalProperties?: false;
         };
         mediaLines?: {
-          mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+          mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
           remoteIP?: string;
           localIP?: string;
           localNetworkPrefix?: string;
@@ -5149,6 +5217,18 @@ export interface Event {
           seq?: number;
           additionalProperties?: false;
         };
+        /**
+         * Pstn Carrier Infos
+         */
+        pstnCarrierInfo?: {
+          cic?: string;
+          carrierName?: string;
+          ucreDnsSrvs?: string[];
+          additionalProperties?: false;
+        };
+        pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+        l2sipCallbackUrl?: string;
+        ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
         trigger?: "dummyTrigger1" | "dummyTrigger2" | "media-quality";
         name: "server.mediaquality.event" | "client.mediaquality.event";
         /**
@@ -5453,6 +5533,7 @@ export interface Event {
               };
               fecPackets: number;
               fecBitrate: number;
+              dscpValue?: number;
               rtxPackets?: number;
               rtxBitrate?: number;
               rtpPackets: number;
@@ -5816,6 +5897,7 @@ export interface Event {
               };
               fecPackets: number;
               fecBitrate: number;
+              dscpValue?: number;
               rtxPackets?: number;
               rtxBitrate?: number;
               rtpPackets: number;
@@ -6018,6 +6100,7 @@ export interface Event {
               };
               fecPackets: number;
               fecBitrate: number;
+              dscpValue?: number;
               rtxPackets?: number;
               rtxBitrate?: number;
               meanRtxDelay?: number;
@@ -6423,6 +6506,7 @@ export interface Event {
               };
               fecPackets: number;
               fecBitrate: number;
+              dscpValue?: number;
               rtxPackets?: number;
               rtxBitrate?: number;
               meanRtxDelay?: number;
@@ -6719,6 +6803,7 @@ export interface Event {
               };
               fecPackets: number;
               fecBitrate: number;
+              dscpValue?: number;
               rtxPackets?: number;
               rtxBitrate?: number;
               rtpPackets: number;
@@ -6836,6 +6921,7 @@ export interface Event {
               };
               fecPackets: number;
               fecBitrate: number;
+              dscpValue?: number;
               rtxPackets?: number;
               rtxBitrate?: number;
               meanRtxDelay?: number;
@@ -7096,6 +7182,14 @@ export interface Event {
         canProceed: boolean;
         state?: string;
         mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+        /**
+         * Details associated with a share floor type
+         */
+        floorType?: {
+          name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+          priority?: {};
+          additionalProperties?: false;
+        };
         csi?: number;
         /**
          * media capability for both transmit and receive
@@ -7128,7 +7222,7 @@ export interface Event {
           additionalProperties?: false;
         };
         mediaLines?: {
-          mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+          mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
           remoteIP?: string;
           localIP?: string;
           localNetworkPrefix?: string;
@@ -7710,6 +7804,18 @@ export interface Event {
           seq?: number;
           additionalProperties?: false;
         };
+        /**
+         * Pstn Carrier Infos
+         */
+        pstnCarrierInfo?: {
+          cic?: string;
+          carrierName?: string;
+          ucreDnsSrvs?: string[];
+          additionalProperties?: false;
+        };
+        pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+        l2sipCallbackUrl?: string;
+        ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
         name:
           | "client.feature.audio.noise.removal"
           | "client.feature.embedded-object-info"
@@ -8683,6 +8789,14 @@ export interface ClientEvent {
   canProceed: boolean;
   state?: string;
   mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+  /**
+   * Details associated with a share floor type
+   */
+  floorType?: {
+    name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+    priority?: {};
+    additionalProperties?: false;
+  };
   csi?: number;
   /**
    * media capability for both transmit and receive
@@ -8715,7 +8829,7 @@ export interface ClientEvent {
     additionalProperties?: false;
   };
   mediaLines?: {
-    mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+    mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
     remoteIP?: string;
     localIP?: string;
     localNetworkPrefix?: string;
@@ -9261,6 +9375,18 @@ export interface ClientEvent {
     granted?: "one_way" | "two_way";
     additionalProperties?: false;
   };
+  /**
+   * Pstn Carrier Infos
+   */
+  pstnCarrierInfo?: {
+    cic?: string;
+    carrierName?: string;
+    ucreDnsSrvs?: string[];
+    additionalProperties?: false;
+  };
+  pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+  l2sipCallbackUrl?: string;
+  ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
   name:
     | "client.alert.displayed"
     | "client.alert.removed"
@@ -9326,10 +9452,12 @@ export interface ClientEvent {
     | "client.locus.media.request"
     | "client.locus.media.response"
     | "client.media-engine.crash"
+    | "client.media-engine.launched"
     | "client.media-engine.lost"
     | "client.media-engine.local-sdp-generated"
     | "client.media-engine.ready"
     | "client.media-engine.remote-sdp-received"
+    | "client.media-engine.start-launch"
     | "client.media-status"
     | "client.media.capabilities"
     | "client.media.reachability"
@@ -9398,6 +9526,8 @@ export interface ClientEvent {
     | "client.muted"
     | "client.network.changed"
     | "client.notification.received"
+    | "client.onboarding-window.start"
+    | "client.onboarding-window.end"
     | "client.permission.closed"
     | "client.permission.prompted"
     | "client.pin.collected"
@@ -11387,6 +11517,14 @@ export interface ClientEvent {
      * iOS specific. The audio session is activated.
      */
     iosAudioSessionActiveTime?: number;
+    /**
+     * If the call was started in background then when the user unlocks the screen the time is recorded. At this time the camera will be opened. Meaningful only on iOS.
+     */
+    switchedToForegroundTime?: number;
+    /**
+     * The time between call join and call close.
+     */
+    callDuration?: number;
     additionalProperties?: false;
   };
   /**
@@ -11395,10 +11533,13 @@ export interface ClientEvent {
   wxcCallMetadata?: {
     bwcCallType?: "Sip" | "Xsi" | "Other";
     callAcceptInBackground?: boolean;
+    callNegotiatedAsVideo?: boolean;
     callOrigin?: string;
     callType?: string;
     endReason?: string;
+    iceEnabled?: boolean;
     iosAcceptCallImmediately?: boolean;
+    ipv6Negotiated?: boolean;
     mediaCreateOnCallCreate?: boolean;
     mediaStartOnCallCreate?: boolean;
     wxcCallId?: string;
@@ -11421,6 +11562,14 @@ export interface FeatureEvent {
   canProceed: boolean;
   state?: string;
   mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+  /**
+   * Details associated with a share floor type
+   */
+  floorType?: {
+    name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+    priority?: {};
+    additionalProperties?: false;
+  };
   csi?: number;
   /**
    * media capability for both transmit and receive
@@ -11453,7 +11602,7 @@ export interface FeatureEvent {
     additionalProperties?: false;
   };
   mediaLines?: {
-    mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+    mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
     remoteIP?: string;
     localIP?: string;
     localNetworkPrefix?: string;
@@ -12028,6 +12177,18 @@ export interface FeatureEvent {
     seq?: number;
     additionalProperties?: false;
   };
+  /**
+   * Pstn Carrier Infos
+   */
+  pstnCarrierInfo?: {
+    cic?: string;
+    carrierName?: string;
+    ucreDnsSrvs?: string[];
+    additionalProperties?: false;
+  };
+  pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+  l2sipCallbackUrl?: string;
+  ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
   name:
     | "client.feature.audio.noise.removal"
     | "client.feature.embedded-object-info"
@@ -12959,6 +13120,14 @@ export interface MediaQualityEvent {
   canProceed: boolean;
   state?: string;
   mediaType?: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+  /**
+   * Details associated with a share floor type
+   */
+  floorType?: {
+    name: "DEFAULT" | "EMBEDDED_APP" | "OTHER";
+    priority?: {};
+    additionalProperties?: false;
+  };
   csi?: number;
   /**
    * media capability for both transmit and receive
@@ -12991,7 +13160,7 @@ export interface MediaQualityEvent {
     additionalProperties?: false;
   };
   mediaLines?: {
-    mediaType: "audio" | "embedded_app" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
+    mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
     remoteIP?: string;
     localIP?: string;
     localNetworkPrefix?: string;
@@ -13566,6 +13735,18 @@ export interface MediaQualityEvent {
     seq?: number;
     additionalProperties?: false;
   };
+  /**
+   * Pstn Carrier Infos
+   */
+  pstnCarrierInfo?: {
+    cic?: string;
+    carrierName?: string;
+    ucreDnsSrvs?: string[];
+    additionalProperties?: false;
+  };
+  pstnAudioCallType?: "PSTN" | "CCA_E" | "CCA_SP" | "EDGE_AUDIO";
+  l2sipCallbackUrl?: string;
+  ivrDialingStatusOriginator?: "L2SIP" | "CLOUD_PROXY" | "CARRIER" | "UNIDENTIFIED";
   trigger?: "dummyTrigger1" | "dummyTrigger2" | "media-quality";
   name: "server.mediaquality.event" | "client.mediaquality.event";
   /**
@@ -13870,6 +14051,7 @@ export interface MediaQualityEvent {
         };
         fecPackets: number;
         fecBitrate: number;
+        dscpValue?: number;
         rtxPackets?: number;
         rtxBitrate?: number;
         rtpPackets: number;
@@ -14230,6 +14412,7 @@ export interface MediaQualityEvent {
         };
         fecPackets: number;
         fecBitrate: number;
+        dscpValue?: number;
         rtxPackets?: number;
         rtxBitrate?: number;
         rtpPackets: number;
@@ -14432,6 +14615,7 @@ export interface MediaQualityEvent {
         };
         fecPackets: number;
         fecBitrate: number;
+        dscpValue?: number;
         rtxPackets?: number;
         rtxBitrate?: number;
         meanRtxDelay?: number;
@@ -14837,6 +15021,7 @@ export interface MediaQualityEvent {
         };
         fecPackets: number;
         fecBitrate: number;
+        dscpValue?: number;
         rtxPackets?: number;
         rtxBitrate?: number;
         meanRtxDelay?: number;
@@ -15133,6 +15318,7 @@ export interface MediaQualityEvent {
         };
         fecPackets: number;
         fecBitrate: number;
+        dscpValue?: number;
         rtxPackets?: number;
         rtxBitrate?: number;
         rtpPackets: number;
@@ -15250,6 +15436,7 @@ export interface MediaQualityEvent {
         };
         fecPackets: number;
         fecBitrate: number;
+        dscpValue?: number;
         rtxPackets?: number;
         rtxBitrate?: number;
         meanRtxDelay?: number;

package/package.json

@@ -12,7 +12,7 @@
   "scripts": {
     "build": "npm run build:typescript && npm run build:version",
     "build:typescript": "node ./src/main.js --from raml --to ts --input ../../diagnostic-events.raml --output ./generated/typescript/index.d.ts --types Event,ClientEvent,FeatureEvent,MediaQualityEvent",
-    "build:version": "node ./scripts/version-bump.js",
+    "build:version": "node ./scripts/version-bump.js --version $BUILD_NUMBER",
     "publish:npm": "npm run publish:npm:setup && npm run publish:npm:tar",
     "publish:npm:setup": "echo \"//registry.npmjs.org/:_authToken=${NPM_TOKEN}\" > ./.npmrc",
     "publish:npm:tar": "npm publish --access public"
@@ -29,5 +29,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "version": "0.0.3"
+  "version": "0.0.1236"
 }