@annoto/widget-api 3.31.0-alpha.0 → 3.32.0-alpha.0

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.32.0-alpha.0](https://github.com/Annoto/annoto/compare/v3.31.0...v3.32.0-alpha.0) (2023-10-01)
+
+
+### Bug Fixes
+
+* **widget-api:** fix generated docs ([2b722f3](https://github.com/Annoto/annoto/commit/2b722f3048c2382996601d45a0fce4add6d56e7d))
+
+
+### Features
+
+* moderated comments actions ([#194](https://github.com/Annoto/annoto/issues/194)) ([deaa06f](https://github.com/Annoto/annoto/commit/deaa06fb90c01beaa51fd53866123853b5fa3c76))
+
+
+
+
+
+# [3.31.0](https://github.com/Annoto/annoto/compare/v3.31.0-alpha.0...v3.31.0) (2023-09-03)
+
+**Note:** Version bump only for package @annoto/widget-api
+
+
+
+
+
 # [3.31.0-alpha.0](https://github.com/Annoto/annoto/compare/v3.30.0...v3.31.0-alpha.0) (2023-08-31)
 
 

package/dist/build/config/permissions.d.ts

@@ -1,9 +1,8 @@
-type UserScopeType = 'outcast' | 'user' | 'member' | 'moderator' | 'super-mod' | 'admin';
+export type UserScopeType = 'outcast' | 'user' | 'member' | 'moderator' | 'super-mod' | 'admin';
 export interface IPermissions {
     /**
      * If defined, only users with this scope will see the widget.
      */
     scope?: UserScopeType;
 }
-export {};
 //# sourceMappingURL=permissions.d.ts.map

package/dist/build/config/permissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../lib/config/permissions.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;AAEzF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB"}
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../lib/config/permissions.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;AAEhG,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB"}

package/dist/build/config/widget.d.ts

@@ -13,12 +13,12 @@ export interface IWidgetConfig<F = IFeatures> {
     positionElement?: string | HTMLElement;
     /**
      * Configuration options that affect the user experience.
-     * Overrides any backend and {@link IConfig} ux settings.
+     * Overrides any backend and {@link Config!IConfig} ux settings.
      */
     ux?: IWidgetUx;
     /**
      * Enable/disable and configure features
-     * Modifying the features will override the backend and {@link IConfig} features.
+     * Modifying the features will override the backend and {@link Config!IConfig} features.
      * @remarks
      * If Feature is not enabled for the license it cannot be enabled via this api.
      */

package/dist/build/events/cta-stats-event.d.ts

@@ -17,7 +17,7 @@ export interface ICtaStatsEvent {
      */
     type: CtaStatsType;
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build/events/my-activity.d.ts

@@ -9,15 +9,15 @@ export interface IMyActivity {
      */
     replies: number;
     /**
-     * acc_completion from {@link IVideoBenchmarkEvent}
+     * acc_completion from {@link Events!IVideoBenchmarkEvent}
      */
     completion: number;
     /**
-     * acc_heatmap from {@link IVideoBenchmarkEvent}
+     * acc_heatmap from {@link Events!IVideoBenchmarkEvent}
      */
     heatmap: IVideoBenchmarkHeatmap;
     /**
-     * acc_watch_time from {@link IVideoBenchmarkEvent}
+     * acc_watch_time from {@link Events!IVideoBenchmarkEvent}
      */
     watch_time: number;
     /**
@@ -25,7 +25,7 @@ export interface IMyActivity {
      */
     sso_id?: string;
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build/events/stats-event.d.ts

@@ -27,7 +27,7 @@ export interface IStatsEvent {
      */
     type: StatsTypeEnum;
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build/events/video-benchmark-event.d.ts

@@ -11,7 +11,7 @@ export interface IVideoBenchmarkHeatmap {
 }
 export interface IVideoBenchmarkEvent {
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build/player-adapter/index.d.ts

@@ -88,13 +88,13 @@ export interface IPlayerAdaptorApi {
     /**
      * @description Get currently played media source. The returned value, identifies
      * the current video and must be unique. It can be a full URL or an unique identifier.
-     * Notice: this value can be overriden by player.mediaSrc widget configuration.
+     * Notice: this value can be overriden by hooks.mediaDetails widget configuration.
      * @returns {string | Promise<string>}
      */
     mediaSrc(): string | Promise<string>;
     /**
      * @description (OPTIONAL) Get Details for the media.
-     * Notice: this value can be overriden by player.mediaDetails widget configuration.
+     * Notice: this value can be overriden by hooks.mediaDetails widget configuration.
      * @return {IMediaDetails | Promise<IMediaDetails>}
      */
     mediaMetadata?(): IMediaDetails | Promise<IMediaDetails>;
@@ -166,63 +166,63 @@ export interface IPlayerAdaptorApi {
      * @description cb should be called when the player is setup and the media metadata is loaded.
      * Note: This method MUST be called as the first event.
      * If your player does not support this event, simulate it by calling the cb manually.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onReady(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media is played.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onPlay(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media is paused.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onPause(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media is seeked
      * (playback position changes after seeking).
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onSeek(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media playback current time is updated.
      * Or when the media duration is changed.
      * can be frequent. 200 msec is a good choice for period.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onTimeUpdate(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media source changes.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onMediaChange(cb: PlayerEventCallback): void;
     /**
      * @description (OPTIONAL) cb should be called when media is ended
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect media end.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onEnded?(cb: PlayerEventCallback): void;
     /**
      * @description (OPTIONAL) cb should be called when full screen state of the player changes.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect full screen changes.
-     * @param cb{(isFullScreen?: boolean) => void} the callback may pass non mandatory new full screen state as boolean.
+     * @param cb the callback may pass non mandatory new full screen state as boolean.
      */
     onFullScreen?(cb: (isFullScreen?: boolean) => void): void;
     /**
      * @description (OPTIONAL) cb should be called when player size changes.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect size change.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onSizeChange?(cb: PlayerEventCallback): void;
     /**
      * @description (OPTIONAL) cb should be called when
      * the media element/player is taken off of a page.
      * Useful for dynamic websites.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onRemove?(cb: PlayerEventCallback): void;
     /**
@@ -230,28 +230,28 @@ export interface IPlayerAdaptorApi {
      * or keydown event captured on player.
      * Implementation of this callback may improve interactions and fast forwarding limit functionality
      * NOTE: if not supported the function must be undefined.
-     * @param cb{CaptureUIEventCallback}
+     * @param cb
      */
     onCaptureUIEvent?(cb: CaptureUIEventCallback): void;
     /**
      * @description (OPTIONAL) Get player controls description parameters.
      * The parameters describe behavior of the player controls.
-     * @returns {ControlsDescriptor} controls descriptor object
+     * @returns controls descriptor object
      */
     controlsDescriptor?(): IControlsDescriptor;
     /**
      * @description (OPTIONAL) If defined will be called at view refreshes of the widget.
      * Allows the player to perform optional adjustments to the controls descriptor.
      * NOTE: may be called frequently, so no heavy operations should be performed.
-     * @param isPhone {boolean}
-     * @param isFullScreen {boolean}
+     * @param isPhone
+     * @param isFullScreen
      */
     updateControlsDescriptor?(isPhone: boolean, isFullScreen: boolean): void;
     /**
      * @description (OPTIONAL) Get player controls hidden state.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
-     * @returns {boolean}
+     * @returns
      */
     controlsHidden?(): boolean;
     /**
@@ -259,7 +259,7 @@ export interface IPlayerAdaptorApi {
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
-     * @returns {number | string} if string, may contain 'px'
+     * @returns if string, may contain 'px'
      */
     controlsHeight?(): number | string;
     /**
@@ -267,7 +267,7 @@ export interface IPlayerAdaptorApi {
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
-     * @returns {number | string} if string, may contain 'px'
+     * @returns if string, may contain 'px'
      */
     trackMarginLeft?(): number | string;
     /**
@@ -275,7 +275,7 @@ export interface IPlayerAdaptorApi {
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
-     * @returns {number | string} if string, may contain 'px'
+     * @returns if string, may contain 'px'
      */
     trackMarginRight?(): number | string;
     /**
@@ -285,7 +285,7 @@ export interface IPlayerAdaptorApi {
      * and controlsDescriptor.mouse parameters.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
-     * @param cb{function}
+     * @param cb
      */
     onControlsShow?(cb: PlayerEventCallback): void;
     /**
@@ -295,7 +295,7 @@ export interface IPlayerAdaptorApi {
      * and controlsDescriptor.mouse parameters.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onControlsHide?(cb: PlayerEventCallback): void;
     /**
@@ -315,7 +315,7 @@ export interface IPlayerAdaptorApi {
      * mouse over the players controls, for example for players where Annoto Timeline interfers with
      * some hover functionality of the player. The function is required only for Iframe players for
      * other players Annoto can detect the event by itself.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onControlsEnter?(cb: PlayerEventCallback): void;
     /**
@@ -327,7 +327,7 @@ export interface IPlayerAdaptorApi {
      * mouse over the players controls, for example for players where Annoto Timeline interfers with
      * some hover functionality of the player. The function is required only for Iframe players for
      * other players Annoto can detect the event by itself.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onControlsLeave?(cb: PlayerEventCallback): void;
 }

package/dist/build_esm/config/permissions.d.ts

@@ -1,9 +1,8 @@
-type UserScopeType = 'outcast' | 'user' | 'member' | 'moderator' | 'super-mod' | 'admin';
+export type UserScopeType = 'outcast' | 'user' | 'member' | 'moderator' | 'super-mod' | 'admin';
 export interface IPermissions {
     /**
      * If defined, only users with this scope will see the widget.
      */
     scope?: UserScopeType;
 }
-export {};
 //# sourceMappingURL=permissions.d.ts.map

package/dist/build_esm/config/permissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../lib/config/permissions.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;AAEzF,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB"}
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../lib/config/permissions.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;AAEhG,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;CACzB"}

package/dist/build_esm/config/widget.d.ts

@@ -13,12 +13,12 @@ export interface IWidgetConfig<F = IFeatures> {
     positionElement?: string | HTMLElement;
     /**
      * Configuration options that affect the user experience.
-     * Overrides any backend and {@link IConfig} ux settings.
+     * Overrides any backend and {@link Config!IConfig} ux settings.
      */
     ux?: IWidgetUx;
     /**
      * Enable/disable and configure features
-     * Modifying the features will override the backend and {@link IConfig} features.
+     * Modifying the features will override the backend and {@link Config!IConfig} features.
      * @remarks
      * If Feature is not enabled for the license it cannot be enabled via this api.
      */

package/dist/build_esm/events/cta-stats-event.d.ts

@@ -17,7 +17,7 @@ export interface ICtaStatsEvent {
      */
     type: CtaStatsType;
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build_esm/events/my-activity.d.ts

@@ -9,15 +9,15 @@ export interface IMyActivity {
      */
     replies: number;
     /**
-     * acc_completion from {@link IVideoBenchmarkEvent}
+     * acc_completion from {@link Events!IVideoBenchmarkEvent}
      */
     completion: number;
     /**
-     * acc_heatmap from {@link IVideoBenchmarkEvent}
+     * acc_heatmap from {@link Events!IVideoBenchmarkEvent}
      */
     heatmap: IVideoBenchmarkHeatmap;
     /**
-     * acc_watch_time from {@link IVideoBenchmarkEvent}
+     * acc_watch_time from {@link Events!IVideoBenchmarkEvent}
      */
     watch_time: number;
     /**
@@ -25,7 +25,7 @@ export interface IMyActivity {
      */
     sso_id?: string;
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build_esm/events/stats-event.d.ts

@@ -27,7 +27,7 @@ export interface IStatsEvent {
      */
     type: StatsTypeEnum;
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build_esm/events/video-benchmark-event.d.ts

@@ -11,7 +11,7 @@ export interface IVideoBenchmarkHeatmap {
 }
 export interface IVideoBenchmarkEvent {
     /**
-     * The group Id provided on {@link IGroupDetails}
+     * The group Id provided on {@link Config!IGroupDetails}
      */
     group_id?: string;
     /**

package/dist/build_esm/player-adapter/index.d.ts

@@ -88,13 +88,13 @@ export interface IPlayerAdaptorApi {
     /**
      * @description Get currently played media source. The returned value, identifies
      * the current video and must be unique. It can be a full URL or an unique identifier.
-     * Notice: this value can be overriden by player.mediaSrc widget configuration.
+     * Notice: this value can be overriden by hooks.mediaDetails widget configuration.
      * @returns {string | Promise<string>}
      */
     mediaSrc(): string | Promise<string>;
     /**
      * @description (OPTIONAL) Get Details for the media.
-     * Notice: this value can be overriden by player.mediaDetails widget configuration.
+     * Notice: this value can be overriden by hooks.mediaDetails widget configuration.
      * @return {IMediaDetails | Promise<IMediaDetails>}
      */
     mediaMetadata?(): IMediaDetails | Promise<IMediaDetails>;
@@ -166,63 +166,63 @@ export interface IPlayerAdaptorApi {
      * @description cb should be called when the player is setup and the media metadata is loaded.
      * Note: This method MUST be called as the first event.
      * If your player does not support this event, simulate it by calling the cb manually.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onReady(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media is played.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onPlay(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media is paused.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onPause(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media is seeked
      * (playback position changes after seeking).
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onSeek(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media playback current time is updated.
      * Or when the media duration is changed.
      * can be frequent. 200 msec is a good choice for period.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onTimeUpdate(cb: PlayerEventCallback): void;
     /**
      * @description cb should be called when the media source changes.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onMediaChange(cb: PlayerEventCallback): void;
     /**
      * @description (OPTIONAL) cb should be called when media is ended
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect media end.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onEnded?(cb: PlayerEventCallback): void;
     /**
      * @description (OPTIONAL) cb should be called when full screen state of the player changes.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect full screen changes.
-     * @param cb{(isFullScreen?: boolean) => void} the callback may pass non mandatory new full screen state as boolean.
+     * @param cb the callback may pass non mandatory new full screen state as boolean.
      */
     onFullScreen?(cb: (isFullScreen?: boolean) => void): void;
     /**
      * @description (OPTIONAL) cb should be called when player size changes.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect size change.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onSizeChange?(cb: PlayerEventCallback): void;
     /**
      * @description (OPTIONAL) cb should be called when
      * the media element/player is taken off of a page.
      * Useful for dynamic websites.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onRemove?(cb: PlayerEventCallback): void;
     /**
@@ -230,28 +230,28 @@ export interface IPlayerAdaptorApi {
      * or keydown event captured on player.
      * Implementation of this callback may improve interactions and fast forwarding limit functionality
      * NOTE: if not supported the function must be undefined.
-     * @param cb{CaptureUIEventCallback}
+     * @param cb
      */
     onCaptureUIEvent?(cb: CaptureUIEventCallback): void;
     /**
      * @description (OPTIONAL) Get player controls description parameters.
      * The parameters describe behavior of the player controls.
-     * @returns {ControlsDescriptor} controls descriptor object
+     * @returns controls descriptor object
      */
     controlsDescriptor?(): IControlsDescriptor;
     /**
      * @description (OPTIONAL) If defined will be called at view refreshes of the widget.
      * Allows the player to perform optional adjustments to the controls descriptor.
      * NOTE: may be called frequently, so no heavy operations should be performed.
-     * @param isPhone {boolean}
-     * @param isFullScreen {boolean}
+     * @param isPhone
+     * @param isFullScreen
      */
     updateControlsDescriptor?(isPhone: boolean, isFullScreen: boolean): void;
     /**
      * @description (OPTIONAL) Get player controls hidden state.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
-     * @returns {boolean}
+     * @returns
      */
     controlsHidden?(): boolean;
     /**
@@ -259,7 +259,7 @@ export interface IPlayerAdaptorApi {
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
-     * @returns {number | string} if string, may contain 'px'
+     * @returns if string, may contain 'px'
      */
     controlsHeight?(): number | string;
     /**
@@ -267,7 +267,7 @@ export interface IPlayerAdaptorApi {
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
-     * @returns {number | string} if string, may contain 'px'
+     * @returns if string, may contain 'px'
      */
     trackMarginLeft?(): number | string;
     /**
@@ -275,7 +275,7 @@ export interface IPlayerAdaptorApi {
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
-     * @returns {number | string} if string, may contain 'px'
+     * @returns if string, may contain 'px'
      */
     trackMarginRight?(): number | string;
     /**
@@ -285,7 +285,7 @@ export interface IPlayerAdaptorApi {
      * and controlsDescriptor.mouse parameters.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
-     * @param cb{function}
+     * @param cb
      */
     onControlsShow?(cb: PlayerEventCallback): void;
     /**
@@ -295,7 +295,7 @@ export interface IPlayerAdaptorApi {
      * and controlsDescriptor.mouse parameters.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onControlsHide?(cb: PlayerEventCallback): void;
     /**
@@ -315,7 +315,7 @@ export interface IPlayerAdaptorApi {
      * mouse over the players controls, for example for players where Annoto Timeline interfers with
      * some hover functionality of the player. The function is required only for Iframe players for
      * other players Annoto can detect the event by itself.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onControlsEnter?(cb: PlayerEventCallback): void;
     /**
@@ -327,7 +327,7 @@ export interface IPlayerAdaptorApi {
      * mouse over the players controls, for example for players where Annoto Timeline interfers with
      * some hover functionality of the player. The function is required only for Iframe players for
      * other players Annoto can detect the event by itself.
-     * @param cb{PlayerEventCallback}
+     * @param cb
      */
     onControlsLeave?(cb: PlayerEventCallback): void;
 }