@clickview/player 0.0.25-rc.0 → 0.0.26-dev.0

package/dist/libs/analytics/src/interfaces/AnalyticsTypes.d.ts

@@ -1,406 +1,406 @@
-export declare type AnalyticsEventType = UserAction;
-export interface AnalyticsOptions {
-    actionType?: UserAction;
-    productArea?: string;
-    entity?: EntityType;
-    location?: LocationContext;
-    descriptor?: ActionDescriptor;
-    workflowPhase?: WorkflowPhase;
-    eventVersion?: EventVersion;
-}
-export interface ActionContext {
-    productArea: string;
-    entity: EntityType;
-    location: LocationContext;
-    descriptor: ActionDescriptor;
-    workflowPhase: WorkflowPhase;
-}
-/**
- * All events recorded are captured within the following action names
- */
-export declare enum UserAction {
-    /**
-     * The following events are listed in CollectionApi
-     */
-    Stream = "cv_product_stream",
-    WebPlayerStream = "cv_product_webplayer_stream",
-    StreamProgress = "cv_product_stream_progress",
-    Login = "cv_product_login",
-    LoginSsoRedirect = "cv_product_login_sso_redirect",
-    LoginFailed = "cv_product_login_failed",
-    Search = "cv_product_search",
-    InstantSearch = "cv_product_instant_search",
-    SearchEmptyResult = "cv_product_search_empty_result",
-    Filter = "cv_product_search_filter",
-    SearchLanding = "cv_product_search_landing",
-    Share = "cv_product_share",
-    Unshare = "cv_product_unshare",
-    WorkspaceAdd = "cv_product_tv_add",
-    /**
-     * The following events are unlisted in CollectionApi
-     */
-    Rename = "cv_product_rename",
-    Move = "cv_product_move",
-    Sort = "cv_product_sort",
-    Create = "cv_product_create",
-    Delete = "cv_product_delete",
-    Associate = "cv_product_associate",
-    Dissociate = "cv_product_dissociate",
-    Edit = "cv_product_edit",
-    Approve = "cv_product_approve",
-    Reject = "cv_product_reject",
-    Disable = "cv_product_disable",
-    Upload = "cv_product_upload",
-    Download = "cv_product_download",
-    Navigate = "cv_product_navigate",
-    Click = "cv_product_click",
-    Suggest = "cv_product_suggest",
-    EditAssoc = "cv_product_edit_assoc",
-    Play = "cv_product_play",
-    Favourite = "cv_product_favourite",
-    Follow = "cv_product_follow",
-    Prefer = "cv_product_prefer",
-    Print = "cv_product_print",
-    Copy = "cv_product_copy",
-    Activate = "cv_product_activate",
-    VerifyEmail = "cv_product_verify_email",
-    ChangePassword = "cv_product_change_password",
-    ManageGroup = "cv_product_manage_group",
-    Export = "cv_product_export",
-    SendEmail = "cv_product_send_email",
-    Publish = "cv_product_publish",
-    Answer = "cv_product_submit",
-    Complete = "cv_product_complete",
-    Archive = "cv_product_archive",
-    Promote = "cv_product_promote",
-    Demote = "cv_product_demote",
-    SetAccess = "cv_product_set_access",
-    AddToLocalCache = "cv_product_add_to_lc",
-    /**
-     * Capture migration specific events in dedicated collection.
-     * The assumption here is that at some point in the distant future
-     * we will not longer care about these collections and it doesn't need to
-     * be part of the more general collections set.
-     */
-    ResolveWarning = "cv_product_resolve_warning",
-    DismissWarning = "cv_product_dismiss_warning"
-}
-export declare enum EntityType {
-    Folder = "folder",
-    Video = "video",
-    Rating = "rating",
-    Series = "series",
-    Library = "library",
-    Resource = "resource",
-    Tag = "tag",
-    Subtitle = "subtitle",
-    Chapter = "chapter",
-    Restriction = "restriction",
-    Interactive = "interactive",
-    Interaction = "interaction",
-    PDF = "pdf",
-    CustomerSetting = "customer_setting",
-    UserSetting = "user_setting",
-    StaffRequest = "staff_request",
-    Logo = "logo",
-    Pagination = "pagination",
-    Thumbnail = "thumbnail",
-    Banner = "banner",
-    Link = "link",
-    Playlist = "playlist",
-    Playlists = "playlists",
-    Person = "person",
-    Company = "company",
-    Classroom = "classroom",
-    ClassroomGroup = "classroom_group",
-    Classification = "classification",
-    ShareLink = "share_link",
-    DirectShare = "direct_share",
-    Upload = "upload",
-    SearchResults = "search_results",
-    Audience = "audience",
-    User = "user",
-    Clip = "clip",
-    UserChannel = "user_channel",
-    Widget = "widget",
-    Url = "url",
-    SocialShare = "social_share"
-}
-export declare enum LocationContext {
-    TopNav = "top_nav",
-    LeftNav = "left_nav",
-    Popup = "popup",
-    Banner = "banner",
-    VideoList = "video_list",
-    VideoListItem = "video_list_item",
-    VideoListHeader = "video_header",
-    VideoThumbnail = "video_thumbnail",
-    ExpandableVideoThumbnail = "expandable_video_thumbnail",
-    VideoItemPreview = "video_item_preview",
-    VideoDetails = "video_details",
-    VideoDetailsHeader = "video_details_header",
-    EditVideoDetails = "edit_video_details",
-    EditVideoChapters = "edit_video_chapters",
-    EditVideoResources = "edit_video_resources",
-    VideoUpload = "video_upload",
-    VideoRequest = "video_request",
-    Pagination = "pagination",
-    LibraryHeader = "library_header",
-    LibraryTiles = "library_tiles",
-    StaffRequestDetails = "staff_request_details",
-    SubFolderList = "sub_folder_list",
-    AwaitingReviewVideoListHeader = "awaiting_review_video_list_header",
-    AwaitingReviewVideoItem = "awaiting_review_video_item",
-    PastReleasesHeader = "past_releases_header",
-    MigrationWarnings = "migration_warnings",
-    PlaylistListHeader = "playlist_list_header",
-    PlaylistListItem = "playlist_list_item",
-    SeriesListItem = "series_list_item",
-    SearchBar = "search_bar",
-    InstantSearch = "instant_search",
-    SearchFilters = "search_filters",
-    FeaturedSeriesSearchResult = "featured_series_search_result",
-    StaffManager = "staff_manager",
-    StaffManagerListItem = "staff_manager_list_item",
-    StudentManager = "student_manager",
-    StudentManagerListItem = "student_manager_list_item",
-    EditUser = "edit_user",
-    Classroom = "classroom",
-    ClassroomsList = "classrooms_list",
-    ClassroomsListItem = "classrooms_list_item",
-    ManageClassroomStudents = "manage_classroom_students",
-    ManageClassroomStudentListItem = "manage_classroom_student_list_item",
-    ManageClassroomGroups = "manage_classroom_groups",
-    ManageClassroomGroupListItem = "manage_classroom_group_list_item",
-    ManageClassroomTeachers = "manage_classroom_teachers",
-    ManageClassroomTeacherListItem = "manage_classroom_teachers_list_item",
-    ArchivedClassrooms = "archived_classrooms",
-    PreviewInteractive = "preview_interactive",
-    PreviewSharedInteractive = "preview_shared_interactive",
-    PreviewInteractiveQuestions = "preview_interactive_questions",
-    EditInteractive = "edit_interactive",
-    EditInteractiveDetails = "edit_interactive_details",
-    PlaySharedInteractive = "play_shared_interactive",
-    PlayInteractive = "play_interactive",
-    InteractiveListItem = "interactive_list_item",
-    DeleteInteractive = "delete_interactive",
-    NewInteractive = "new_interactive",
-    CopyInteractive = "copy_interactive",
-    UnpublishInteractive = "unpublish_interactive",
-    ShareInteractive = "share_interactive",
-    PlayPage = "play_page",
-    Player = "player",
-    FloatingPlayer = "floating_player",
-    InteractivePlayer = "interactive_player",
-    EmbeddedPlayer = "embedded_player",
-    CreateClipPlayer = "create_clip_player",
-    PlayClip = "play_clip",
-    PlaySharedClip = "play_shared_clip",
-    ClipListItem = "clip_list_item",
-    ContentUpdatesClassificationBanner = "content_updates_classification_banner",
-    PreferencesSettings = "preferences_settings",
-    TopicsOnboarding = "topics_onboarding",
-    MyUploads = "my_uploads",
-    SlidingList = "sliding_list",
-    HeroBannerItem = "hero_banner_item",
-    SlidingListItem = "sliding_list_item",
-    ClassificationListItem = "classification_list_item",
-    ClassificationComingSoon = "classification_coming_soon",
-    ClassificationHero = "classification_hero",
-    Dashboard = "dashboard",
-    ProductBanner = "product_banner",
-    UserOptions = "user_options",
-    Settings = "settings",
-    StudentFeed = "student_feed",
-    SharedByMe = "shared_by_me",
-    SharedWithMe = "shared_with_me",
-    TopVideos = "top_videos",
-    VideoViewsList = "video_views_list",
-    LiteUpgradeFeedbackPopup = "lite_upgrade_feedback_popup",
-    LiteUpgradeBanner = "lite_upgrade_banner",
-    LiteUpgradeOnboarding = "lite_upgrade_onboarding"
-}
-export declare enum WorkflowPhase {
-    Start = "start",
-    Complete = "complete",
-    Save = "save",
-    Discard = "discard"
-}
-/**
- * Action descriptor sub-types
- */
-export declare enum PageDescriptor {
-    PageLoad = "page_load"
-}
-export declare enum OperationDescriptor {
-    Single = "single",
-    Bulk = "bulk",
-    All = "all"
-}
-export declare enum PublishDescriptor {
-    Publish = "publish",
-    Unpublish = "unpublish"
-}
-export declare enum EmailDescriptor {
-    ActivateUser = "activate_user",
-    VerifyEmail = "verify_email"
-}
-export declare enum SortDescriptor {
-    ProductionYear = "production_year",
-    Alphabetical = "alphabetical"
-}
-export declare enum FilterDescriptor {
-    Content = "content",
-    Quality = "quality",
-    Duration = "duration",
-    Reset = "reset"
-}
-export declare enum DirectSearchDescriptor {
-    Submit = "submit",
-    ShowAll = "show_all",
-    Recent = "recent",
-    SearchIcon = "search_icon"
-}
-export declare enum PlaybackDescriptor {
-    Start = "start",
-    Finish = "finish",
-    Terminate = "terminate",
-    Play = "play",
-    Pause = "pause",
-    Playback = "playback",
-    NextChapter = "next_chapter",
-    PreviousChapter = "previous_chapter",
-    FullScreenEnter = "full_screen_enter",
-    FullScreenExit = "full_screen_exit"
-}
-export declare enum PlayerDescriptor {
-    Embedded = "embedded"
-}
-export declare enum ClickDescriptor {
-    TogglePreview = "toggle_preview",
-    NavigateHome = "navigate_home",
-    OpenInStaffView = "open_in_staff_view",
-    Title = "title",
-    ToggleHideValidListings = "toggle_hide_valid_listings",
-    LaunchImmersiveReader = "launch_immersive_reader",
-    CopyEmbedHtml = "copy_embed_html",
-    Close = "close",
-    Open = "open",
-    Button = "button",
-    Link = "link",
-    Tile = "tile",
-    Thumbnail = "thumbnail",
-    Cover = "cover",
-    TallPoster = "tall_poster",
-    Slide = "slide",
-    ExternalLink = "external_link",
-    ViewStudentWorkspace = "view_student_workspace"
-}
-export declare enum VideoActionDescriptor {
-    FeatureUserChannelVideo = "feature_user_channel_video",
-    RemoveFromUserChannelPlaylist = "remove_from_user_channel_playlist",
-    ShareClip = "share_clip",
-    ViewOriginalVideo = "view_original_video",
-    ShareInteractive = "share_interactive",
-    DeleteInteractiveVideo = "delete_interactive_video",
-    CopyInteractiveVideo = "copy_interactive_video",
-    EditInteractiveVideo = "edit_interactive_video",
-    PrintAsWorksheet = "print_as_worksheet",
-    PreviewInteractiveVideo = "preview_interactive_video",
-    ViewResults = "view_results",
-    ViewUsage = "view_usage",
-    MoveToAnotherFolder = "move_to_another_folder",
-    CreateInteractiveVideo = "create_interactive_video",
-    ShareVideo = "share_video",
-    EditVideo = "edit_video",
-    DownloadVideo = "download_video",
-    AddToExchange = "add_to_exchange",
-    AddToUserChannel = "add_to_user_channel",
-    CreateClip = "create_clip",
-    FlagVideo = "flag_video",
-    AddToLibrary = "add_to_library",
-    AddToWorkspace = "add_to_workspace",
-    AddToPlaylist = "add_to_playlist",
-    RemoveFromPlaylist = "remove_from_playlist",
-    AddCurriculumLink = "add_curriculum_link",
-    ViewCurriculumLinks = "view_curriculum_links",
-    OpenInCurator = "open_in_curator",
-    ManageVideoAccess = "manage_video_access",
-    Approve = "approve",
-    AddToLocalCache = "add_to_local_cache",
-    OpenInLibraryEditor = "open_in_library_editor",
-    PlayClip = "play_clip",
-    EditClip = "edit_clip",
-    DeleteClip = "delete_clip",
-    EditVideoDetails = "edit_video_details",
-    DeleteVideo = "delete_video"
-}
-export declare enum VerifyEmailDescriptor {
-    Remove = "remove"
-}
-export declare enum CustomerSettingDescriptor {
-    LibraryReview = "library_review"
-}
-export declare enum InteractionTypeDescriptor {
-    FileSelect = "file_select",
-    DragDrop = "drag_drop"
-}
-export declare enum SuggestionDescriptor {
-    Edit = "edit"
-}
-export declare enum AssocDescriptor {
-    Image = "image",
-    User = "user",
-    Playlist = "playlist",
-    Link = "link",
-    Avatar = "avatar",
-    Clip = "clip",
-    Interactive = "interactive",
-    Classroom = "classroom"
-}
-export declare enum ToggleDescriptor {
-    On = "on",
-    Off = "off"
-}
-export declare enum InteractiveSessionDescriptor {
-    ContinueSession = "continue_session",
-    NewSession = "new_session"
-}
-export declare enum ShareDescriptors {
-    DirectShare = "direct_share",
-    CopyLink = "copy_link",
-    CopyEmbedHtml = "copy_embed_html",
-    PluginEmbed = "plugin_embed"
-}
-export declare enum UpgradeBannerDescriptors {
-    GoToOnline = "go_to_online",
-    Feedback = "feedback"
-}
-/**
- * Action descriptors give further context to UserActions
- */
-export declare type ActionDescriptor = OperationDescriptor | SortDescriptor | FilterDescriptor | DirectSearchDescriptor | PageDescriptor | PlaybackDescriptor | PlayerDescriptor | CustomerSettingDescriptor | SuggestionDescriptor | InteractionTypeDescriptor | AssocDescriptor | ClickDescriptor | ToggleDescriptor | VideoActionDescriptor | EmailDescriptor | InteractiveSessionDescriptor | PublishDescriptor | VerifyEmailDescriptor | ShareDescriptors | UpgradeBannerDescriptors;
-/**
- * Placeholder values to be used in circumstances where we need
- * to simply signify that a change has occurred. Particularly if it is
- * being collected as a set of other changes.
- */
-export declare enum EventDefaultValue {
-    EntityRemoved = "cv_entity_removed",
-    ValueUpdated = "cv_value_updated"
-}
-export declare enum InteractionType {
-    FileSelect = "file_select",
-    DragDrop = "drag_drop"
-}
-export declare enum SearchQueryType {
-    Video = "videos",
-    Folder = "categories",
-    Series = "series",
-    Tags = "tags",
-    Subjects = "subjects"
-}
-export declare enum EventVersion {
-    V1 = 1,
-    V2 = 2
-}
+export declare type AnalyticsEventType = UserAction;
+export interface AnalyticsOptions {
+    actionType?: UserAction;
+    productArea?: string;
+    entity?: EntityType;
+    location?: LocationContext;
+    descriptor?: ActionDescriptor;
+    workflowPhase?: WorkflowPhase;
+    eventVersion?: EventVersion;
+}
+export interface ActionContext {
+    productArea: string;
+    entity: EntityType;
+    location: LocationContext;
+    descriptor: ActionDescriptor;
+    workflowPhase: WorkflowPhase;
+}
+/**
+ * All events recorded are captured within the following action names
+ */
+export declare enum UserAction {
+    /**
+     * The following events are listed in CollectionApi
+     */
+    Stream = "cv_product_stream",
+    WebPlayerStream = "cv_product_webplayer_stream",
+    StreamProgress = "cv_product_stream_progress",
+    Login = "cv_product_login",
+    LoginSsoRedirect = "cv_product_login_sso_redirect",
+    LoginFailed = "cv_product_login_failed",
+    Search = "cv_product_search",
+    InstantSearch = "cv_product_instant_search",
+    SearchEmptyResult = "cv_product_search_empty_result",
+    Filter = "cv_product_search_filter",
+    SearchLanding = "cv_product_search_landing",
+    Share = "cv_product_share",
+    Unshare = "cv_product_unshare",
+    WorkspaceAdd = "cv_product_tv_add",
+    /**
+     * The following events are unlisted in CollectionApi
+     */
+    Rename = "cv_product_rename",
+    Move = "cv_product_move",
+    Sort = "cv_product_sort",
+    Create = "cv_product_create",
+    Delete = "cv_product_delete",
+    Associate = "cv_product_associate",
+    Dissociate = "cv_product_dissociate",
+    Edit = "cv_product_edit",
+    Approve = "cv_product_approve",
+    Reject = "cv_product_reject",
+    Disable = "cv_product_disable",
+    Upload = "cv_product_upload",
+    Download = "cv_product_download",
+    Navigate = "cv_product_navigate",
+    Click = "cv_product_click",
+    Suggest = "cv_product_suggest",
+    EditAssoc = "cv_product_edit_assoc",
+    Play = "cv_product_play",
+    Favourite = "cv_product_favourite",
+    Follow = "cv_product_follow",
+    Prefer = "cv_product_prefer",
+    Print = "cv_product_print",
+    Copy = "cv_product_copy",
+    Activate = "cv_product_activate",
+    VerifyEmail = "cv_product_verify_email",
+    ChangePassword = "cv_product_change_password",
+    ManageGroup = "cv_product_manage_group",
+    Export = "cv_product_export",
+    SendEmail = "cv_product_send_email",
+    Publish = "cv_product_publish",
+    Answer = "cv_product_submit",
+    Complete = "cv_product_complete",
+    Archive = "cv_product_archive",
+    Promote = "cv_product_promote",
+    Demote = "cv_product_demote",
+    SetAccess = "cv_product_set_access",
+    AddToLocalCache = "cv_product_add_to_lc",
+    /**
+     * Capture migration specific events in dedicated collection.
+     * The assumption here is that at some point in the distant future
+     * we will not longer care about these collections and it doesn't need to
+     * be part of the more general collections set.
+     */
+    ResolveWarning = "cv_product_resolve_warning",
+    DismissWarning = "cv_product_dismiss_warning"
+}
+export declare enum EntityType {
+    Folder = "folder",
+    Video = "video",
+    Rating = "rating",
+    Series = "series",
+    Library = "library",
+    Resource = "resource",
+    Tag = "tag",
+    Subtitle = "subtitle",
+    Chapter = "chapter",
+    Restriction = "restriction",
+    Interactive = "interactive",
+    Interaction = "interaction",
+    PDF = "pdf",
+    CustomerSetting = "customer_setting",
+    UserSetting = "user_setting",
+    StaffRequest = "staff_request",
+    Logo = "logo",
+    Pagination = "pagination",
+    Thumbnail = "thumbnail",
+    Banner = "banner",
+    Link = "link",
+    Playlist = "playlist",
+    Playlists = "playlists",
+    Person = "person",
+    Company = "company",
+    Classroom = "classroom",
+    ClassroomGroup = "classroom_group",
+    Classification = "classification",
+    ShareLink = "share_link",
+    DirectShare = "direct_share",
+    Upload = "upload",
+    SearchResults = "search_results",
+    Audience = "audience",
+    User = "user",
+    Clip = "clip",
+    UserChannel = "user_channel",
+    Widget = "widget",
+    Url = "url",
+    SocialShare = "social_share"
+}
+export declare enum LocationContext {
+    TopNav = "top_nav",
+    LeftNav = "left_nav",
+    Popup = "popup",
+    Banner = "banner",
+    VideoList = "video_list",
+    VideoListItem = "video_list_item",
+    VideoListHeader = "video_header",
+    VideoThumbnail = "video_thumbnail",
+    ExpandableVideoThumbnail = "expandable_video_thumbnail",
+    VideoItemPreview = "video_item_preview",
+    VideoDetails = "video_details",
+    VideoDetailsHeader = "video_details_header",
+    EditVideoDetails = "edit_video_details",
+    EditVideoChapters = "edit_video_chapters",
+    EditVideoResources = "edit_video_resources",
+    VideoUpload = "video_upload",
+    VideoRequest = "video_request",
+    Pagination = "pagination",
+    LibraryHeader = "library_header",
+    LibraryTiles = "library_tiles",
+    StaffRequestDetails = "staff_request_details",
+    SubFolderList = "sub_folder_list",
+    AwaitingReviewVideoListHeader = "awaiting_review_video_list_header",
+    AwaitingReviewVideoItem = "awaiting_review_video_item",
+    PastReleasesHeader = "past_releases_header",
+    MigrationWarnings = "migration_warnings",
+    PlaylistListHeader = "playlist_list_header",
+    PlaylistListItem = "playlist_list_item",
+    SeriesListItem = "series_list_item",
+    SearchBar = "search_bar",
+    InstantSearch = "instant_search",
+    SearchFilters = "search_filters",
+    FeaturedSeriesSearchResult = "featured_series_search_result",
+    StaffManager = "staff_manager",
+    StaffManagerListItem = "staff_manager_list_item",
+    StudentManager = "student_manager",
+    StudentManagerListItem = "student_manager_list_item",
+    EditUser = "edit_user",
+    Classroom = "classroom",
+    ClassroomsList = "classrooms_list",
+    ClassroomsListItem = "classrooms_list_item",
+    ManageClassroomStudents = "manage_classroom_students",
+    ManageClassroomStudentListItem = "manage_classroom_student_list_item",
+    ManageClassroomGroups = "manage_classroom_groups",
+    ManageClassroomGroupListItem = "manage_classroom_group_list_item",
+    ManageClassroomTeachers = "manage_classroom_teachers",
+    ManageClassroomTeacherListItem = "manage_classroom_teachers_list_item",
+    ArchivedClassrooms = "archived_classrooms",
+    PreviewInteractive = "preview_interactive",
+    PreviewSharedInteractive = "preview_shared_interactive",
+    PreviewInteractiveQuestions = "preview_interactive_questions",
+    EditInteractive = "edit_interactive",
+    EditInteractiveDetails = "edit_interactive_details",
+    PlaySharedInteractive = "play_shared_interactive",
+    PlayInteractive = "play_interactive",
+    InteractiveListItem = "interactive_list_item",
+    DeleteInteractive = "delete_interactive",
+    NewInteractive = "new_interactive",
+    CopyInteractive = "copy_interactive",
+    UnpublishInteractive = "unpublish_interactive",
+    ShareInteractive = "share_interactive",
+    PlayPage = "play_page",
+    Player = "player",
+    FloatingPlayer = "floating_player",
+    InteractivePlayer = "interactive_player",
+    EmbeddedPlayer = "embedded_player",
+    CreateClipPlayer = "create_clip_player",
+    PlayClip = "play_clip",
+    PlaySharedClip = "play_shared_clip",
+    ClipListItem = "clip_list_item",
+    ContentUpdatesClassificationBanner = "content_updates_classification_banner",
+    PreferencesSettings = "preferences_settings",
+    TopicsOnboarding = "topics_onboarding",
+    MyUploads = "my_uploads",
+    SlidingList = "sliding_list",
+    HeroBannerItem = "hero_banner_item",
+    SlidingListItem = "sliding_list_item",
+    ClassificationListItem = "classification_list_item",
+    ClassificationComingSoon = "classification_coming_soon",
+    ClassificationHero = "classification_hero",
+    Dashboard = "dashboard",
+    ProductBanner = "product_banner",
+    UserOptions = "user_options",
+    Settings = "settings",
+    StudentFeed = "student_feed",
+    SharedByMe = "shared_by_me",
+    SharedWithMe = "shared_with_me",
+    TopVideos = "top_videos",
+    VideoViewsList = "video_views_list",
+    LiteUpgradeFeedbackPopup = "lite_upgrade_feedback_popup",
+    LiteUpgradeBanner = "lite_upgrade_banner",
+    LiteUpgradeOnboarding = "lite_upgrade_onboarding"
+}
+export declare enum WorkflowPhase {
+    Start = "start",
+    Complete = "complete",
+    Save = "save",
+    Discard = "discard"
+}
+/**
+ * Action descriptor sub-types
+ */
+export declare enum PageDescriptor {
+    PageLoad = "page_load"
+}
+export declare enum OperationDescriptor {
+    Single = "single",
+    Bulk = "bulk",
+    All = "all"
+}
+export declare enum PublishDescriptor {
+    Publish = "publish",
+    Unpublish = "unpublish"
+}
+export declare enum EmailDescriptor {
+    ActivateUser = "activate_user",
+    VerifyEmail = "verify_email"
+}
+export declare enum SortDescriptor {
+    ProductionYear = "production_year",
+    Alphabetical = "alphabetical"
+}
+export declare enum FilterDescriptor {
+    Content = "content",
+    Quality = "quality",
+    Duration = "duration",
+    Reset = "reset"
+}
+export declare enum DirectSearchDescriptor {
+    Submit = "submit",
+    ShowAll = "show_all",
+    Recent = "recent",
+    SearchIcon = "search_icon"
+}
+export declare enum PlaybackDescriptor {
+    Start = "start",
+    Finish = "finish",
+    Terminate = "terminate",
+    Play = "play",
+    Pause = "pause",
+    Playback = "playback",
+    NextChapter = "next_chapter",
+    PreviousChapter = "previous_chapter",
+    FullScreenEnter = "full_screen_enter",
+    FullScreenExit = "full_screen_exit"
+}
+export declare enum PlayerDescriptor {
+    Embedded = "embedded"
+}
+export declare enum ClickDescriptor {
+    TogglePreview = "toggle_preview",
+    NavigateHome = "navigate_home",
+    OpenInStaffView = "open_in_staff_view",
+    Title = "title",
+    ToggleHideValidListings = "toggle_hide_valid_listings",
+    LaunchImmersiveReader = "launch_immersive_reader",
+    CopyEmbedHtml = "copy_embed_html",
+    Close = "close",
+    Open = "open",
+    Button = "button",
+    Link = "link",
+    Tile = "tile",
+    Thumbnail = "thumbnail",
+    Cover = "cover",
+    TallPoster = "tall_poster",
+    Slide = "slide",
+    ExternalLink = "external_link",
+    ViewStudentWorkspace = "view_student_workspace"
+}
+export declare enum VideoActionDescriptor {
+    FeatureUserChannelVideo = "feature_user_channel_video",
+    RemoveFromUserChannelPlaylist = "remove_from_user_channel_playlist",
+    ShareClip = "share_clip",
+    ViewOriginalVideo = "view_original_video",
+    ShareInteractive = "share_interactive",
+    DeleteInteractiveVideo = "delete_interactive_video",
+    CopyInteractiveVideo = "copy_interactive_video",
+    EditInteractiveVideo = "edit_interactive_video",
+    PrintAsWorksheet = "print_as_worksheet",
+    PreviewInteractiveVideo = "preview_interactive_video",
+    ViewResults = "view_results",
+    ViewUsage = "view_usage",
+    MoveToAnotherFolder = "move_to_another_folder",
+    CreateInteractiveVideo = "create_interactive_video",
+    ShareVideo = "share_video",
+    EditVideo = "edit_video",
+    DownloadVideo = "download_video",
+    AddToExchange = "add_to_exchange",
+    AddToUserChannel = "add_to_user_channel",
+    CreateClip = "create_clip",
+    FlagVideo = "flag_video",
+    AddToLibrary = "add_to_library",
+    AddToWorkspace = "add_to_workspace",
+    AddToPlaylist = "add_to_playlist",
+    RemoveFromPlaylist = "remove_from_playlist",
+    AddCurriculumLink = "add_curriculum_link",
+    ViewCurriculumLinks = "view_curriculum_links",
+    OpenInCurator = "open_in_curator",
+    ManageVideoAccess = "manage_video_access",
+    Approve = "approve",
+    AddToLocalCache = "add_to_local_cache",
+    OpenInLibraryEditor = "open_in_library_editor",
+    PlayClip = "play_clip",
+    EditClip = "edit_clip",
+    DeleteClip = "delete_clip",
+    EditVideoDetails = "edit_video_details",
+    DeleteVideo = "delete_video"
+}
+export declare enum VerifyEmailDescriptor {
+    Remove = "remove"
+}
+export declare enum CustomerSettingDescriptor {
+    LibraryReview = "library_review"
+}
+export declare enum InteractionTypeDescriptor {
+    FileSelect = "file_select",
+    DragDrop = "drag_drop"
+}
+export declare enum SuggestionDescriptor {
+    Edit = "edit"
+}
+export declare enum AssocDescriptor {
+    Image = "image",
+    User = "user",
+    Playlist = "playlist",
+    Link = "link",
+    Avatar = "avatar",
+    Clip = "clip",
+    Interactive = "interactive",
+    Classroom = "classroom"
+}
+export declare enum ToggleDescriptor {
+    On = "on",
+    Off = "off"
+}
+export declare enum InteractiveSessionDescriptor {
+    ContinueSession = "continue_session",
+    NewSession = "new_session"
+}
+export declare enum ShareDescriptors {
+    DirectShare = "direct_share",
+    CopyLink = "copy_link",
+    CopyEmbedHtml = "copy_embed_html",
+    PluginEmbed = "plugin_embed"
+}
+export declare enum UpgradeBannerDescriptors {
+    GoToOnline = "go_to_online",
+    Feedback = "feedback"
+}
+/**
+ * Action descriptors give further context to UserActions
+ */
+export declare type ActionDescriptor = OperationDescriptor | SortDescriptor | FilterDescriptor | DirectSearchDescriptor | PageDescriptor | PlaybackDescriptor | PlayerDescriptor | CustomerSettingDescriptor | SuggestionDescriptor | InteractionTypeDescriptor | AssocDescriptor | ClickDescriptor | ToggleDescriptor | VideoActionDescriptor | EmailDescriptor | InteractiveSessionDescriptor | PublishDescriptor | VerifyEmailDescriptor | ShareDescriptors | UpgradeBannerDescriptors;
+/**
+ * Placeholder values to be used in circumstances where we need
+ * to simply signify that a change has occurred. Particularly if it is
+ * being collected as a set of other changes.
+ */
+export declare enum EventDefaultValue {
+    EntityRemoved = "cv_entity_removed",
+    ValueUpdated = "cv_value_updated"
+}
+export declare enum InteractionType {
+    FileSelect = "file_select",
+    DragDrop = "drag_drop"
+}
+export declare enum SearchQueryType {
+    Video = "videos",
+    Folder = "categories",
+    Series = "series",
+    Tags = "tags",
+    Subjects = "subjects"
+}
+export declare enum EventVersion {
+    V1 = 1,
+    V2 = 2
+}