@clickview/player 0.0.3-dev-us.6 → 0.0.3-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.storybook/stories/utils/mock-playerapi.ts +1 -8
- package/dist/en.json +390 -0
- package/dist/libs/analytics/src/Analytics.d.ts +10 -0
- package/dist/libs/analytics/src/AnalyticsHelper.d.ts +30 -0
- package/dist/libs/analytics/src/clients/CollectionApiClient.d.ts +48 -0
- package/dist/libs/analytics/src/constants/CountryRegionMapping.d.ts +7 -0
- package/dist/libs/analytics/src/constants/EventFirehose.d.ts +4 -0
- package/dist/libs/analytics/src/constants/GlobalChannels.d.ts +3 -0
- package/dist/libs/analytics/src/constants/Regions.d.ts +6 -0
- package/dist/libs/analytics/src/constants/Services.d.ts +4 -0
- package/dist/libs/analytics/src/enums/CountryCode.d.ts +5 -0
- package/dist/libs/analytics/src/enums/RegionName.d.ts +5 -0
- package/dist/libs/analytics/src/interfaces/AnalyticsTypes.d.ts +339 -0
- package/dist/libs/analytics/src/interfaces/Config.d.ts +3 -0
- package/dist/libs/analytics/src/interfaces/Folder.d.ts +3 -0
- package/dist/libs/analytics/src/interfaces/HashObject.d.ts +3 -0
- package/dist/libs/analytics/src/interfaces/Owner.d.ts +3 -0
- package/dist/libs/analytics/src/interfaces/Playlist.d.ts +3 -0
- package/dist/libs/analytics/src/interfaces/Rating.d.ts +4 -0
- package/dist/libs/analytics/src/interfaces/Region.d.ts +5 -0
- package/dist/libs/analytics/src/interfaces/RegionalUrl.d.ts +5 -0
- package/dist/libs/analytics/src/interfaces/Resource.d.ts +5 -0
- package/dist/libs/analytics/src/interfaces/Series.d.ts +3 -0
- package/dist/libs/analytics/src/interfaces/Subtitle.d.ts +4 -0
- package/dist/libs/analytics/src/interfaces/User.d.ts +17 -0
- package/dist/libs/analytics/src/interfaces/VersionData.d.ts +4 -0
- package/dist/libs/analytics/src/interfaces/Video.d.ts +16 -0
- package/dist/libs/analytics/src/interfaces/index.d.ts +15 -0
- package/dist/libs/analytics/src/interfaces/primitives/BaseObject.d.ts +7 -0
- package/dist/libs/analytics/src/models/AnalyticsEvent.d.ts +49 -0
- package/dist/libs/analytics/src/models/CollectionEvent.d.ts +61 -0
- package/dist/libs/analytics/src/services/ContextService.d.ts +19 -0
- package/dist/libs/analytics/src/utils/CollectionApiClientHelper.d.ts +6 -0
- package/dist/libs/analytics/src/utils/DataFormatHelper.d.ts +14 -0
- package/dist/libs/analytics/src/utils/EventWhitelistHelper.d.ts +19 -0
- package/dist/libs/analytics/src/utils/TypeHelper.d.ts +4 -0
- package/dist/libs/analytics/src/utils/UploadDataFormatHelper.d.ts +10 -0
- package/dist/libs/analytics/src/utils/UrlHelper.d.ts +3 -0
- package/dist/libs/analytics/src/utils/UserAgentHelper.d.ts +10 -0
- package/dist/libs/analytics/src/utils/VideoDataFormatHelper.d.ts +42 -0
- package/dist/libs/common/src/backbone/constants/CommonChannels.d.ts +5 -0
- package/dist/libs/common/src/backbone/constants/CommonServices.d.ts +4 -0
- package/dist/libs/common/src/backbone/core/AppLink.d.ts +37 -0
- package/dist/libs/common/src/backbone/core/BaseAppRouter.d.ts +103 -0
- package/dist/libs/common/src/backbone/core/BaseApplication.d.ts +76 -0
- package/dist/libs/common/src/backbone/core/BaseBehavior.d.ts +6 -0
- package/dist/libs/common/src/backbone/core/BaseCollection.d.ts +7 -0
- package/dist/libs/common/src/backbone/core/BaseCollectionView.d.ts +16 -0
- package/dist/libs/common/src/backbone/core/BaseError.d.ts +18 -0
- package/dist/libs/common/src/backbone/core/BaseLayoutView.d.ts +11 -0
- package/dist/libs/common/src/backbone/core/BaseModel.d.ts +27 -0
- package/dist/libs/common/src/backbone/core/BaseNestedModel.d.ts +21 -0
- package/dist/libs/common/src/backbone/core/BaseService.d.ts +10 -0
- package/dist/libs/common/src/backbone/core/BaseView.d.ts +131 -0
- package/dist/libs/common/src/backbone/core/EventNames.d.ts +16 -0
- package/dist/libs/common/src/backbone/core/LayoutService.d.ts +31 -0
- package/dist/libs/common/src/backbone/core/ListenToRadio.d.ts +3 -0
- package/dist/libs/common/src/backbone/core/LocationUtils.d.ts +24 -0
- package/dist/libs/common/src/backbone/core/Middleware.d.ts +10 -0
- package/dist/libs/common/src/backbone/core/Shell.d.ts +79 -0
- package/dist/libs/common/src/backbone/core/Types.d.ts +12 -0
- package/dist/libs/common/src/backbone/core/index.d.ts +27 -0
- package/dist/libs/common/src/backbone/enums/DataServiceErrorType.d.ts +8 -0
- package/dist/libs/common/src/backbone/enums/HttpStatus.d.ts +10 -0
- package/dist/libs/common/src/backbone/enums/HttpVerbs.d.ts +6 -0
- package/dist/libs/common/src/backbone/errors/DevError.d.ts +4 -0
- package/dist/libs/common/src/backbone/index.d.ts +2 -0
- package/dist/libs/common/src/backbone/interfaces/BaseCollectionIdentifier.d.ts +19 -0
- package/dist/libs/common/src/backbone/interfaces/ChainableDataService.d.ts +9 -0
- package/dist/libs/common/src/backbone/interfaces/DataCache.d.ts +8 -0
- package/dist/libs/common/src/backbone/interfaces/DataProvider.d.ts +15 -0
- package/dist/libs/common/src/backbone/interfaces/DataServiceError.d.ts +7 -0
- package/dist/libs/common/src/backbone/interfaces/DataServiceRequests.d.ts +218 -0
- package/dist/libs/common/src/backbone/interfaces/Pagination.d.ts +33 -0
- package/dist/libs/common/src/backbone/interfaces/StickitBinding.d.ts +38 -0
- package/dist/libs/common/src/backbone/interfaces/Xhr.d.ts +9 -0
- package/dist/libs/common/src/backbone/interfaces/index.d.ts +9 -0
- package/dist/libs/common/src/backbone/services/EnvironmentVariables.d.ts +13 -0
- package/dist/libs/common/src/backbone/services/LanguageService.d.ts +22 -0
- package/dist/libs/common/src/backbone/utils/FunctionHelper.d.ts +8 -0
- package/dist/libs/common/src/backbone/utils/UrlHelper.d.ts +14 -0
- package/dist/libs/common/src/react/flight/FlightHelpers.d.ts +14 -0
- package/dist/libs/common/src/react/flight/FlightMiddleware.d.ts +11 -0
- package/dist/libs/common/src/react/flight/FlightReducer.d.ts +2 -0
- package/dist/libs/common/src/react/flight/FlightSimulator.d.ts +24 -0
- package/dist/libs/common/src/react/flight/constants/Actions.d.ts +7 -0
- package/dist/libs/common/src/react/flight/constants/index.d.ts +1 -0
- package/dist/libs/common/src/react/flight/data-layers/AjaxRequest.d.ts +2 -0
- package/dist/libs/common/src/react/flight/data-layers/index.d.ts +1 -0
- package/dist/libs/common/src/react/flight/enums/RequestStatus.d.ts +6 -0
- package/dist/libs/common/src/react/flight/enums/index.d.ts +1 -0
- package/dist/libs/common/src/react/flight/index.d.ts +9 -0
- package/dist/libs/common/src/react/flight/interfaces/Action.d.ts +28 -0
- package/dist/libs/common/src/react/flight/interfaces/Dispatch.d.ts +3 -0
- package/dist/libs/common/src/react/flight/interfaces/FlightState.d.ts +22 -0
- package/dist/libs/common/src/react/flight/interfaces/HttpRequest.d.ts +27 -0
- package/dist/libs/common/src/react/flight/interfaces/NormalizeOptions.d.ts +4 -0
- package/dist/libs/common/src/react/flight/interfaces/NormalizedData.d.ts +7 -0
- package/dist/libs/common/src/react/flight/interfaces/Request.d.ts +29 -0
- package/dist/libs/common/src/react/flight/interfaces/Response.d.ts +9 -0
- package/dist/libs/common/src/react/flight/interfaces/UpdateStateOptions.d.ts +15 -0
- package/dist/libs/common/src/react/flight/interfaces/index.d.ts +9 -0
- package/dist/libs/common/src/react/flight/normalizer/Denormalizer.d.ts +3 -0
- package/dist/libs/common/src/react/flight/normalizer/Normalizer.d.ts +8 -0
- package/dist/libs/common/src/react/flight/normalizer/index.d.ts +2 -0
- package/dist/libs/common/src/react/flight/utils/SimulatorHelper.d.ts +5 -0
- package/dist/libs/common/src/react/flight/utils/StateHelper.d.ts +11 -0
- package/dist/libs/common/src/react/flight/utils/index.d.ts +2 -0
- package/dist/libs/common/src/react/interfaces/ApplicationData.d.ts +3 -0
- package/dist/libs/common/src/react/interfaces/ApplicationState.d.ts +8 -0
- package/dist/libs/common/src/react/interfaces/BaseReducerActions.d.ts +4 -0
- package/dist/libs/common/src/react/interfaces/HashObject.d.ts +3 -0
- package/dist/libs/common/src/react/interfaces/index.d.ts +4 -0
- package/dist/libs/common/src/react/utils/ArrayHelper.d.ts +44 -0
- package/dist/libs/common/src/react/utils/ObjectHelper.d.ts +11 -0
- package/dist/libs/common/src/react/utils/RandomHelper.d.ts +3 -0
- package/dist/libs/common/src/react/utils/TimeHelper.d.ts +8 -0
- package/dist/libs/shared/src/apps/notifications/enums/NotificationType.d.ts +16 -0
- package/dist/libs/shared/src/apps/upload/constants/UploadConstants.d.ts +39 -0
- package/dist/libs/shared/src/components/actions/ActionButton.d.ts +16 -0
- package/dist/libs/shared/src/components/actions/Actions.d.ts +28 -0
- package/dist/libs/shared/src/components/actions/ActionsDropdown.d.ts +15 -0
- package/dist/libs/shared/src/components/app-link/AppLink.d.ts +20 -0
- package/dist/libs/shared/src/components/avatar/Avatar.d.ts +8 -0
- package/dist/libs/shared/src/components/div-button/DivButton.d.ts +10 -0
- package/dist/libs/shared/src/components/feedback-tooltip/FeedbackTooltip.d.ts +6 -0
- package/dist/libs/shared/src/components/icon-button/IconButton.d.ts +19 -0
- package/dist/libs/shared/src/components/image-cropper/SimpleCropper.d.ts +15 -0
- package/dist/libs/shared/src/components/immersive-reader/ImmersiveReader.d.ts +14 -0
- package/dist/libs/shared/src/components/interactive-questions/InteractiveQuestions.d.ts +12 -0
- package/dist/libs/shared/src/components/interactive-questions/formatAnnotationText.d.ts +1 -0
- package/dist/libs/shared/src/components/lazy-image/LazyImage.d.ts +7 -0
- package/dist/libs/shared/src/components/popup/Popup.d.ts +35 -0
- package/dist/libs/shared/src/components/popup/PopupButtons.d.ts +14 -0
- package/dist/libs/shared/src/components/popup/PopupLoadingSpinner.d.ts +2 -0
- package/dist/libs/shared/src/components/spinner-button/SpinnerButton.d.ts +8 -0
- package/dist/libs/shared/src/components/svg-container/SvgContainer.d.ts +21 -0
- package/dist/libs/shared/src/components/svgs/interaction-types/InteractionTypes.d.ts +7 -0
- package/dist/libs/shared/src/components/text/Text.d.ts +13 -0
- package/dist/libs/shared/src/components/thumbnails/base/BaseThumbnail.d.ts +26 -0
- package/dist/libs/shared/src/components/tooltip/Tooltip.d.ts +17 -0
- package/dist/libs/shared/src/components/widgets/items/resource-widget-item/ResourceWidgetItem.d.ts +23 -0
- package/dist/libs/shared/src/constants/AppVariables.d.ts +6 -0
- package/dist/libs/shared/src/constants/ImageSizes.d.ts +8 -0
- package/dist/libs/shared/src/constants/RadioChannels.d.ts +20 -0
- package/dist/libs/shared/src/enums/ClassificationStatus.d.ts +5 -0
- package/dist/libs/shared/src/enums/ClassificationType.d.ts +4 -0
- package/dist/libs/shared/src/enums/CountryCode.d.ts +5 -0
- package/dist/libs/shared/src/enums/CurationStatus.d.ts +12 -0
- package/dist/libs/shared/src/enums/CurriculumType.d.ts +6 -0
- package/dist/libs/shared/src/enums/GlanceFormat.d.ts +3 -0
- package/dist/libs/shared/src/enums/Images.d.ts +27 -0
- package/dist/libs/shared/src/enums/InteractionCorrectness.d.ts +8 -0
- package/dist/libs/shared/src/enums/InteractiveAnswerStatus.d.ts +5 -0
- package/dist/libs/shared/src/enums/InteractiveOriginType.d.ts +4 -0
- package/dist/libs/shared/src/enums/MasterType.d.ts +61 -0
- package/dist/libs/shared/src/enums/MediaQueries.d.ts +20 -0
- package/dist/libs/shared/src/enums/ObjectStatus.d.ts +5 -0
- package/dist/libs/shared/src/enums/PlaylistPrivacy.d.ts +5 -0
- package/dist/libs/shared/src/enums/PresentationStatus.d.ts +4 -0
- package/dist/libs/shared/src/enums/PresentationType.d.ts +4 -0
- package/dist/libs/shared/src/enums/ResourceFileType.d.ts +9 -0
- package/dist/libs/shared/src/enums/SettingKind.d.ts +4 -0
- package/dist/libs/shared/src/enums/SettingName.d.ts +19 -0
- package/dist/libs/shared/src/enums/StaffRequestRole.d.ts +5 -0
- package/dist/libs/shared/src/enums/ThemeType.d.ts +3 -0
- package/dist/libs/shared/src/enums/UserGroup.d.ts +5 -0
- package/dist/libs/shared/src/enums/UserRole.d.ts +15 -0
- package/dist/libs/shared/src/enums/WidgetContents.d.ts +12 -0
- package/dist/libs/shared/src/errors/primitives/DialogError.d.ts +9 -0
- package/dist/libs/shared/src/hooks/UseGetMediaQueryString.d.ts +2 -0
- package/dist/libs/shared/src/hooks/UseLazyLoad.d.ts +6 -0
- package/dist/libs/shared/src/hooks/UseMediaQuery.d.ts +1 -0
- package/dist/libs/shared/src/hooks/UseVideoDragDropState.d.ts +6 -0
- package/dist/libs/shared/src/hooks/useNavLock.d.ts +11 -0
- package/dist/libs/shared/src/images/svg/ImportedSvgs.d.ts +91 -0
- package/dist/libs/shared/src/images/svg/actions/index.d.ts +25 -0
- package/dist/libs/shared/src/images/svg/arrows/index.d.ts +9 -0
- package/dist/libs/shared/src/images/svg/index.d.ts +2 -0
- package/dist/libs/shared/src/images/svg/objects/index.d.ts +38 -0
- package/dist/libs/shared/src/images/svg/player/index.d.ts +14 -0
- package/dist/libs/shared/src/images/svg/settings.d.ts +1 -0
- package/dist/libs/shared/src/images/svg/status/index.d.ts +13 -0
- package/dist/libs/shared/src/interfaces/AppLinkWithLabel.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/DialogOptions.d.ts +13 -0
- package/dist/libs/shared/src/interfaces/ImageUrls.d.ts +16 -0
- package/dist/libs/shared/src/interfaces/QueryParams.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/RegionalUrl.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/VideoTypes.d.ts +2 -0
- package/dist/libs/shared/src/interfaces/WidgetContext.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/app-variables/BaseNotificationsAppVariables.d.ts +16 -0
- package/dist/libs/shared/src/interfaces/app-variables/BaseSearchAppVariables.d.ts +18 -0
- package/dist/libs/shared/src/interfaces/app-variables/index.d.ts +2 -0
- package/dist/libs/shared/src/interfaces/collections/AudienceCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/CategoryCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/ClassificationCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/ClassroomCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/ClassroomGroupCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/ClipCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/CompanyCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/CustomerCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/FolderCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/InteractiveCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/LibraryCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/LinkCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/PersonCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/PlaylistCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/PresentationAudienceCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/ResourceCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/SeriesCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/SubtitleCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/TagCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/UserCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/VideoCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/VideoHistoryCollection.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/collections/WidgetCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/YearGroupCollection.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/collections/index.d.ts +26 -0
- package/dist/libs/shared/src/interfaces/collections/primitives/BasePaginatedCollection.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/collections/primitives/index.d.ts +1 -0
- package/dist/libs/shared/src/interfaces/index.d.ts +14 -0
- package/dist/libs/shared/src/interfaces/models/Audience.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Avatar.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Banner.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Category.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Channel.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Classification.d.ts +22 -0
- package/dist/libs/shared/src/interfaces/models/Classroom.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/ClassroomGroup.d.ts +17 -0
- package/dist/libs/shared/src/interfaces/models/Clip.d.ts +14 -0
- package/dist/libs/shared/src/interfaces/models/Company.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Config.d.ts +16 -0
- package/dist/libs/shared/src/interfaces/models/Country.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/Cover.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Curriculum.d.ts +23 -0
- package/dist/libs/shared/src/interfaces/models/Customer.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/models/EntitySetting.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/models/FileUpload.d.ts +20 -0
- package/dist/libs/shared/src/interfaces/models/Folder.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/models/Following.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/models/Glance.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/models/Group.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/HeroBanner.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Image.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/models/InteractiveMetadata.d.ts +22 -0
- package/dist/libs/shared/src/interfaces/models/Language.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/models/LanguageConfig.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/Library.d.ts +8 -0
- package/dist/libs/shared/src/interfaces/models/Link.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/models/Organisation.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Pdf.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/models/Person.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/PlayerViewKey.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Playlist.d.ts +20 -0
- package/dist/libs/shared/src/interfaces/models/Poster.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Presentation.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/models/PresentationAudience.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/Rating.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/Resource.d.ts +17 -0
- package/dist/libs/shared/src/interfaces/models/Restriction.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/Season.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/models/Series.d.ts +10 -0
- package/dist/libs/shared/src/interfaces/models/Share.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/models/Subject.d.ts +13 -0
- package/dist/libs/shared/src/interfaces/models/Subtitle.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/models/Tag.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/TallPoster.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/models/Theme.d.ts +14 -0
- package/dist/libs/shared/src/interfaces/models/Thumbnail.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/User.d.ts +63 -0
- package/dist/libs/shared/src/interfaces/models/UserChannel.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/models/Video.d.ts +38 -0
- package/dist/libs/shared/src/interfaces/models/VideoHistory.d.ts +12 -0
- package/dist/libs/shared/src/interfaces/models/Widget.d.ts +16 -0
- package/dist/libs/shared/src/interfaces/models/YearGroup.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/index.d.ts +59 -0
- package/dist/libs/shared/src/interfaces/models/interactive/ActionableItem.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/interactive/Interaction.d.ts +14 -0
- package/dist/libs/shared/src/interfaces/models/interactive/InteractionTypeId.d.ts +8 -0
- package/dist/libs/shared/src/interfaces/models/interactive/Interactive.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/models/interactive/Timepoint.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/models/interactive/index.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/interactive-results/InteractiveResult.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/interactive-results/InteractiveResultSet.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/interactive-results/StudentAnswer.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/models/interactive-results/StudentAttempt.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/interactive-results/StudentResult.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/models/interactive-results/index.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/primitives/BaseObject.d.ts +10 -0
- package/dist/libs/shared/src/interfaces/models/primitives/VirtualObject.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/models/primitives/index.d.ts +2 -0
- package/dist/libs/shared/src/interfaces/props/ViewProps.d.ts +8 -0
- package/dist/libs/shared/src/interfaces/props/index.d.ts +1 -0
- package/dist/libs/shared/src/interfaces/requests/CreateInteractiveMetadataRequest.d.ts +12 -0
- package/dist/libs/shared/src/interfaces/requests/CreateInteractiveRequest.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/requests/CreateOrUpdateClipRequest.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/requests/CreateViewKeyRequest.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/requests/EditDetailsRequest.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/requests/EditInteractiveMetadataOriginRequest.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/requests/EditInteractiveMetadataRequest.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/requests/EditInteractiveRequest.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/requests/ReorderRequest.d.ts +12 -0
- package/dist/libs/shared/src/interfaces/requests/UpdateObjectChannel.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/requests/UpdateObjectRating.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/requests/UpdateResourceRequest.d.ts +3 -0
- package/dist/libs/shared/src/interfaces/requests/UpdateVideoRequest.d.ts +9 -0
- package/dist/libs/shared/src/interfaces/requests/index.d.ts +13 -0
- package/dist/libs/shared/src/interfaces/services/BaseConfigDataService.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/services/BaseLibraryDataService.d.ts +10 -0
- package/dist/libs/shared/src/interfaces/services/BaseSeriesDataService.d.ts +4 -0
- package/dist/libs/shared/src/interfaces/services/BaseSettingsDataService.d.ts +7 -0
- package/dist/libs/shared/src/interfaces/services/BaseUserDataService.d.ts +6 -0
- package/dist/libs/shared/src/interfaces/services/BaseVideoDataService.d.ts +5 -0
- package/dist/libs/shared/src/interfaces/services/BaseVideoUploadDataService.d.ts +8 -0
- package/dist/libs/shared/src/interfaces/services/index.d.ts +7 -0
- package/dist/libs/shared/src/utils/DialogHelper.d.ts +24 -0
- package/dist/libs/shared/src/utils/DurationHelper.d.ts +7 -0
- package/dist/libs/shared/src/utils/ImageHelper.d.ts +32 -0
- package/dist/libs/shared/src/utils/ImageSelectHelper.d.ts +7 -0
- package/dist/libs/shared/src/utils/SvgHelper.d.ts +18 -0
- package/dist/libs/shared/src/utils/UserHelper.d.ts +3 -0
- package/dist/libs/shared/src/utils/interaction-type-helper/InteractionTypeHelper.d.ts +16 -0
- package/dist/player-app.css +2430 -0
- package/dist/player-app.js +5636 -0
- package/dist/projects/player/src/components/chapter-bar-items/chapter-bar-item.d.ts +79 -0
- package/dist/projects/player/src/components/chapter-bar-items/chapter-bar-items.d.ts +55 -0
- package/dist/projects/player/src/components/chapter-bar-items/chapter-bar-load-progress.d.ts +55 -0
- package/dist/projects/player/src/components/chapter-bar-items/chapter-bar-play-progress.d.ts +55 -0
- package/dist/projects/player/src/components/chapter-seek-bar/chapter-seek-bar.d.ts +1 -0
- package/dist/projects/player/src/components/chapters-button/chapter-menu-item.d.ts +60 -0
- package/dist/projects/player/src/components/chapters-button/chapters-button.d.ts +1 -0
- package/dist/projects/player/src/components/cog-button/cog-button.d.ts +41 -0
- package/dist/projects/player/src/components/collapserator/collapserator.d.ts +4 -0
- package/dist/projects/player/src/components/mouse-time-display/mouse-time-display.d.ts +3 -0
- package/dist/projects/player/src/components/next-video-menu-item/next-video-menu-item.d.ts +1 -0
- package/dist/projects/player/src/components/playback-rate-button/playback-rate-button.d.ts +1 -0
- package/dist/projects/player/src/components/player/player.d.ts +7 -0
- package/dist/projects/player/src/components/progress-control/progress-control.d.ts +12 -0
- package/dist/projects/player/src/components/quality-selector/quality-button.d.ts +1 -0
- package/dist/projects/player/src/components/quality-selector/quality-menu-item.d.ts +17 -0
- package/dist/projects/player/src/components/subs-caps-button/subs-caps-button.d.ts +1 -0
- package/dist/projects/player/src/components/thumbnail-display/thumbnail-display.d.ts +66 -0
- package/dist/projects/player/src/components/time-tooltip/time-tooltip.d.ts +15 -0
- package/dist/projects/player/src/components/time-wrapper/time-wrapper.d.ts +1 -0
- package/dist/projects/player/src/index.d.ts +9 -0
- package/dist/projects/player/src/interfaces/CollapsibleComponent.d.ts +10 -0
- package/dist/projects/player/src/interfaces/NextVideo.d.ts +4 -0
- package/dist/projects/player/src/interfaces/models/ApiError.d.ts +4 -0
- package/dist/projects/player/src/interfaces/models/ClipData.d.ts +4 -0
- package/dist/projects/player/src/interfaces/models/Config.d.ts +7 -0
- package/dist/projects/player/src/interfaces/models/PlaybackObject.d.ts +53 -0
- package/dist/projects/player/src/players/base-player.d.ts +84 -0
- package/dist/projects/player/src/players/create-clip-player.d.ts +18 -0
- package/dist/projects/player/src/players/interactive-player.d.ts +27 -0
- package/dist/projects/player/src/players/player.d.ts +27 -0
- package/dist/projects/player/src/plugins/clip-plugin/clip-plugin.d.ts +50 -0
- package/dist/projects/player/src/plugins/create-clip-button-plugin/components/create-clip-button.d.ts +1 -0
- package/dist/projects/player/src/plugins/create-clip-button-plugin/create-clip-button-plugin.d.ts +10 -0
- package/dist/projects/player/src/plugins/create-clip-plugin/components/clip-timepoint-selector/clip-timepoint-selector-handle.d.ts +54 -0
- package/dist/projects/player/src/plugins/create-clip-plugin/components/clip-timepoint-selector/clip-timepoint-selector.d.ts +90 -0
- package/dist/projects/player/src/plugins/create-clip-plugin/components/create-clip-seek-bar/create-clip-seek-bar.d.ts +14 -0
- package/dist/projects/player/src/plugins/create-clip-plugin/create-clip-plugin.d.ts +14 -0
- package/dist/projects/player/src/plugins/example-plugin/components/example-button/example-button.d.ts +1 -0
- package/dist/projects/player/src/plugins/example-plugin/components/example-react-button/example-react-button.d.ts +1 -0
- package/dist/projects/player/src/plugins/example-plugin/example-plugin.d.ts +2 -0
- package/dist/projects/player/src/plugins/favourite-plugin/components/favourite-button.d.ts +19 -0
- package/dist/projects/player/src/plugins/favourite-plugin/favourite-plugin.d.ts +28 -0
- package/dist/projects/player/src/plugins/fullscreen-on-rotate-plugin/fullscreen-on-rotate-plugin.d.ts +1 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/add-question-button/add-question-button.d.ts +8 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-annotation/create-annotation-helpers.d.ts +9 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-annotation/create-annotation-link.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-annotation/create-annotation.d.ts +12 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-components.d.ts +7 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-error-feedback/create-error-feedback.d.ts +6 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-image/create-image-cropper.d.ts +15 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-image/create-image.d.ts +15 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-image/upload-image-dropzone.d.ts +6 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-image/upload-image-icon.d.ts +2 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-interaction-buttons/create-interaction-buttons.d.ts +14 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-interaction-heading/create-interaction-heading.d.ts +12 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-missing-word/create-missing-word.d.ts +18 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-multiple-choice/create-multiple-choice.d.ts +18 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-multiple-choice/multiple-choice-answer.d.ts +9 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-short-answer/create-short-answer.d.ts +11 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/create-components/create-type-selector/create-type-selector.d.ts +15 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/feedback/feedback.d.ts +7 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interaction-actions/interaction-actions.d.ts +10 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interaction-footer/interaction-footer.d.ts +20 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interaction-header/interaction-header.d.ts +14 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive/interactive-component.d.ts +1 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive-icon-button/interactive-icon-button.d.ts +8 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive-summary/InteractiveSummaryWrapper.d.ts +18 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive-summary/interactions-bar/interactions-bar.d.ts +9 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive-summary/interactive-summary.d.ts +20 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive-summary/progress-summary/progress-summary.d.ts +12 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/interactive-summary/show-summary-button/show-summary-button.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/question-list/question-list-empty-state.d.ts +2 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/question-list/question-list.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/seek-bar/interactive-bar-item.d.ts +20 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/seek-bar/interactive-bar-items.d.ts +66 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/sliding-timepoint/sliding-timepoints.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/timepoint/timepoint-component.d.ts +35 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/annotation/annotation-interaction.d.ts +3 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/image/image-interaction.d.ts +4 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/interactive-immersive-reader/interactive-immersive-reader.d.ts +8 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/missing-word/missing-word-interaction.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/multiple-choice/multiple-choice-interaction.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/short-answer/short-answer-interaction.d.ts +11 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/true-or-false/true-or-false-interaction.d.ts +13 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/view-components.d.ts +12 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/view-error-feedback/view-error-feedback.d.ts +6 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/view-interaction-buttons/view-iteraction-buttons.d.ts +14 -0
- package/dist/projects/player/src/plugins/interactive-plugin/components/view-components/view-interaction-heading/view-interaction-heading.d.ts +8 -0
- package/dist/projects/player/src/plugins/interactive-plugin/errors/ReconnectionError.d.ts +8 -0
- package/dist/projects/player/src/plugins/interactive-plugin/hooks/useInteractiveState.d.ts +25 -0
- package/dist/projects/player/src/plugins/interactive-plugin/hooks/useInteractiveTrack.d.ts +20 -0
- package/dist/projects/player/src/plugins/interactive-plugin/hooks/useLockPlayer.d.ts +14 -0
- package/dist/projects/player/src/plugins/interactive-plugin/hooks/useStateManager.d.ts +39 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interactive-plugin.d.ts +45 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/InteractionComponent.d.ts +3 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/InteractionProps.d.ts +16 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/InteractionResult.d.ts +4 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/InteractiveMode.d.ts +4 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/InteractiveState.d.ts +28 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/ResultSubmission.d.ts +2 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/SubmissionFunction.d.ts +4 -0
- package/dist/projects/player/src/plugins/interactive-plugin/interfaces/index.d.ts +7 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/InteractiveReducer.d.ts +14 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/ResultsService.d.ts +24 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/getInteractionComponents.d.ts +3 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/getInteractionStateId.d.ts +2 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/getTimepointStateId.d.ts +2 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/helpers.d.ts +2 -0
- package/dist/projects/player/src/plugins/interactive-plugin/utils/interactive-ajax.d.ts +9 -0
- package/dist/projects/player/src/plugins/localcache-plugin/LocalCache.d.ts +12 -0
- package/dist/projects/player/src/plugins/localcache-plugin/compontents/local-cache-indicator.d.ts +1 -0
- package/dist/projects/player/src/plugins/localcache-plugin/localcache-middleware.d.ts +1 -0
- package/dist/projects/player/src/plugins/localcache-plugin/localcache-plugin.d.ts +62 -0
- package/dist/projects/player/src/plugins/next-video-plugin/components/up-next/up-next.d.ts +1 -0
- package/dist/projects/player/src/plugins/next-video-plugin/next-video-plugin.d.ts +44 -0
- package/dist/projects/player/src/plugins/open-externally-plugin/components/open-externally-button.d.ts +1 -0
- package/dist/projects/player/src/plugins/open-externally-plugin/interfaces/ExternalLinkOptions.d.ts +3 -0
- package/dist/projects/player/src/plugins/open-externally-plugin/open-externally-plugin.d.ts +1 -0
- package/dist/projects/player/src/plugins/persist-volume-plugin/persist-volume-plugin.d.ts +1 -0
- package/dist/projects/player/src/plugins/persist-volume-plugin/persist-volume-plugin.test.d.ts +1 -0
- package/dist/projects/player/src/plugins/picture-in-picture-plugin/picture-in-picture-plugin.d.ts +48 -0
- package/dist/projects/player/src/plugins/progress-reporter-plugin/progress-reporter-plugin.d.ts +68 -0
- package/dist/projects/player/src/plugins/progressive-files-plugin/ProgressiveFilesPluginOptions.d.ts +4 -0
- package/dist/projects/player/src/plugins/progressive-files-plugin/ProgressiveRepresentation.d.ts +10 -0
- package/dist/projects/player/src/plugins/progressive-files-plugin/interfaces/Source.d.ts +6 -0
- package/dist/projects/player/src/plugins/progressive-files-plugin/progressive-files-plugin.d.ts +38 -0
- package/dist/projects/player/src/plugins/resources-plugin/components/resource-menu-item/resource-menu-item.d.ts +21 -0
- package/dist/projects/player/src/plugins/resources-plugin/components/resources-button/resources-button.d.ts +1 -0
- package/dist/projects/player/src/plugins/resources-plugin/resources-plugin.d.ts +12 -0
- package/dist/projects/player/src/plugins/touch-controls-plugin/components/touch-controls/touch-controls.d.ts +59 -0
- package/dist/projects/player/src/plugins/touch-controls-plugin/touch-controls-plugin.d.ts +1 -0
- package/dist/projects/player/src/react/CreateClipPlayer.d.ts +3 -0
- package/dist/projects/player/src/react/InteractivePlayer.d.ts +8 -0
- package/dist/projects/player/src/react/Player.d.ts +10 -0
- package/dist/projects/player/src/react/react-component.d.ts +11 -0
- package/dist/projects/player/src/services/analytics-service.d.ts +31 -0
- package/dist/projects/player/src/utils/ajax-helper.d.ts +16 -0
- package/dist/projects/player/src/utils/fn.d.ts +14 -0
- package/dist/projects/player/src/utils/formatTime.d.ts +5 -0
- package/dist/projects/player/src/utils/hotkeys.d.ts +5 -0
- package/dist/projects/player/src/utils/quality-helper.d.ts +19 -0
- package/dist/projects/player/src/utils/quality-helper.test.d.ts +1 -0
- package/dist/projects/player/src/utils/scrollbar-helper.d.ts +6 -0
- package/dist/projects/player/src/utils/track-helper.d.ts +7 -0
- package/dist/projects/player/test/players/test-player.d.ts +17 -0
- package/dist/projects/player/test/setupTests.d.ts +0 -0
- package/dist/projects/player/test/utils/test-helpers.d.ts +8 -0
- package/package.json +3 -5
|
@@ -0,0 +1,339 @@
|
|
|
1
|
+
export declare type AnalyticsEventType = UserAction;
|
|
2
|
+
export interface AnalyticsOptions {
|
|
3
|
+
actionType?: UserAction;
|
|
4
|
+
productArea?: string;
|
|
5
|
+
entity?: EntityType;
|
|
6
|
+
location?: LocationContext;
|
|
7
|
+
descriptor?: ActionDescriptor;
|
|
8
|
+
workflowPhase?: WorkflowPhase;
|
|
9
|
+
eventVersion?: EventVersion;
|
|
10
|
+
}
|
|
11
|
+
export interface ActionContext {
|
|
12
|
+
productArea: string;
|
|
13
|
+
entity: EntityType;
|
|
14
|
+
location: LocationContext;
|
|
15
|
+
descriptor: ActionDescriptor;
|
|
16
|
+
workflowPhase: WorkflowPhase;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* All events recorded are captured within the following action names
|
|
20
|
+
*/
|
|
21
|
+
export declare enum UserAction {
|
|
22
|
+
/**
|
|
23
|
+
* The following events are listed in CollectionApi
|
|
24
|
+
*/
|
|
25
|
+
Stream = "cv_product_stream",
|
|
26
|
+
StreamRaw = "cv_product_stream_raw",
|
|
27
|
+
WebPlayerStream = "cv_product_webplayer_stream",
|
|
28
|
+
StreamProgress = "cv_product_stream_progress",
|
|
29
|
+
Login = "cv_product_login",
|
|
30
|
+
LoginSsoRedirect = "cv_product_login_sso_redirect",
|
|
31
|
+
LoginFailed = "cv_product_login_failed",
|
|
32
|
+
Search = "cv_product_search",
|
|
33
|
+
InstantSearch = "cv_product_search",
|
|
34
|
+
SearchEmptyResult = "cv_product_search_empty_result",
|
|
35
|
+
Filter = "cv_product_search_filter",
|
|
36
|
+
SearchLanding = "cv_product_search_landing",
|
|
37
|
+
Share = "cv_product_share",
|
|
38
|
+
WorkspaceAdd = "cv_product_tv_add",
|
|
39
|
+
/**
|
|
40
|
+
* The following events are unlisted in CollectionApi
|
|
41
|
+
*/
|
|
42
|
+
Rename = "cv_product_rename",
|
|
43
|
+
Move = "cv_product_move",
|
|
44
|
+
Sort = "cv_product_sort",
|
|
45
|
+
Create = "cv_product_create",
|
|
46
|
+
Delete = "cv_product_delete",
|
|
47
|
+
Associate = "cv_product_associate",
|
|
48
|
+
Dissociate = "cv_product_dissociate",
|
|
49
|
+
Edit = "cv_product_edit",
|
|
50
|
+
Approve = "cv_product_approve",
|
|
51
|
+
Reject = "cv_product_reject",
|
|
52
|
+
Disable = "cv_product_disable",
|
|
53
|
+
Upload = "cv_product_upload",
|
|
54
|
+
Download = "cv_product_download",
|
|
55
|
+
Navigate = "cv_product_navigate",
|
|
56
|
+
Click = "cv_product_click",
|
|
57
|
+
Suggest = "cv_product_suggest",
|
|
58
|
+
EditAssoc = "cv_product_edit_assoc",
|
|
59
|
+
Play = "cv_product_play",
|
|
60
|
+
Favourite = "cv_product_favourite",
|
|
61
|
+
Follow = "cv_product_follow",
|
|
62
|
+
Prefer = "cv_product_prefer",
|
|
63
|
+
Print = "cv_product_print",
|
|
64
|
+
Copy = "cv_product_copy",
|
|
65
|
+
Activate = "cv_product_activate",
|
|
66
|
+
VerifyEmail = "cv_product_verify_email",
|
|
67
|
+
ChangePassword = "cv_product_change_password",
|
|
68
|
+
SetAccess = "cv_product_set_access",
|
|
69
|
+
AddToLocalCache = "cv_product_add_to_lc",
|
|
70
|
+
/**
|
|
71
|
+
* Capture migration specific events in dedicated collection.
|
|
72
|
+
* The assumption here is that at some point in the distant future
|
|
73
|
+
* we will not longer care about these collections and it doesn't need to
|
|
74
|
+
* be part of the more general collections set.
|
|
75
|
+
*/
|
|
76
|
+
ResolveWarning = "cv_product_resolve_warning",
|
|
77
|
+
DismissWarning = "cv_product_dismiss_warning"
|
|
78
|
+
}
|
|
79
|
+
export declare enum EntityType {
|
|
80
|
+
Folder = "folder",
|
|
81
|
+
Video = "video",
|
|
82
|
+
Rating = "rating",
|
|
83
|
+
Series = "series",
|
|
84
|
+
Library = "library",
|
|
85
|
+
Resource = "resource",
|
|
86
|
+
Tag = "tag",
|
|
87
|
+
Subtitle = "subtitle",
|
|
88
|
+
Chapter = "chapter",
|
|
89
|
+
Restriction = "restriction",
|
|
90
|
+
Interactive = "interactive",
|
|
91
|
+
PDF = "pdf",
|
|
92
|
+
CustomerSetting = "customer_setting",
|
|
93
|
+
UserSetting = "user_setting",
|
|
94
|
+
StaffRequest = "staff_request",
|
|
95
|
+
Logo = "logo",
|
|
96
|
+
Pagination = "pagination",
|
|
97
|
+
Thumbnail = "thumbnail",
|
|
98
|
+
Banner = "banner",
|
|
99
|
+
Link = "link",
|
|
100
|
+
Playlist = "playlist",
|
|
101
|
+
Playlists = "playlists",
|
|
102
|
+
Person = "person",
|
|
103
|
+
Company = "company",
|
|
104
|
+
Classroom = "classroom",
|
|
105
|
+
ClassroomGroup = "classroom_group",
|
|
106
|
+
Classification = "classification",
|
|
107
|
+
ShareLink = "share_link",
|
|
108
|
+
Upload = "upload",
|
|
109
|
+
SearchResults = "search_results",
|
|
110
|
+
Audience = "audience",
|
|
111
|
+
User = "user",
|
|
112
|
+
Clip = "clip",
|
|
113
|
+
UserChannel = "user_channel",
|
|
114
|
+
Widget = "widget",
|
|
115
|
+
Url = "url",
|
|
116
|
+
SocialShare = "social_share"
|
|
117
|
+
}
|
|
118
|
+
export declare enum LocationContext {
|
|
119
|
+
TopNav = "top_nav",
|
|
120
|
+
LeftNav = "left_nav",
|
|
121
|
+
Popup = "popup",
|
|
122
|
+
Banner = "banner",
|
|
123
|
+
VideoList = "video_list",
|
|
124
|
+
VideoListItem = "video_list_item",
|
|
125
|
+
VideoListHeader = "video_header",
|
|
126
|
+
VideoThumbnail = "video_thumbnail",
|
|
127
|
+
ExpandableVideoThumbnail = "expandable_video_thumbnail",
|
|
128
|
+
VideoItemPreview = "video_item_preview",
|
|
129
|
+
VideoDetails = "video_details",
|
|
130
|
+
VideoDetailsHeader = "video_details_header",
|
|
131
|
+
EditVideoDetails = "edit_video_details",
|
|
132
|
+
EditVideoChapters = "edit_video_chapters",
|
|
133
|
+
EditVideoResources = "edit_video_resources",
|
|
134
|
+
VideoUpload = "video_upload",
|
|
135
|
+
VideoRequest = "video_request",
|
|
136
|
+
Pagination = "pagination",
|
|
137
|
+
LibraryHeader = "library_header",
|
|
138
|
+
LibraryTiles = "library_tiles",
|
|
139
|
+
StaffRequestDetails = "staff_request_details",
|
|
140
|
+
SubFolderList = "sub_folder_list",
|
|
141
|
+
AwaitingReviewVideoListHeader = "awaiting_review_video_list_header",
|
|
142
|
+
AwaitingReviewVideoItem = "awaiting_review_video_item",
|
|
143
|
+
PastReleasesHeader = "past_releases_header",
|
|
144
|
+
MigrationWarnings = "migration_warnings",
|
|
145
|
+
PlaylistListHeader = "playlist_list_header",
|
|
146
|
+
PlaylistListItem = "playlist_list_item",
|
|
147
|
+
SearchBar = "search_bar",
|
|
148
|
+
InstantSearch = "instant_search",
|
|
149
|
+
SearchFilters = "search_filters",
|
|
150
|
+
FeaturedSeriesSearchResult = "featured_series_search_result",
|
|
151
|
+
StaffManager = "staff_manager",
|
|
152
|
+
StaffManagerListItem = "staff_manager_list_item",
|
|
153
|
+
StudentManager = "student_manager",
|
|
154
|
+
StudentManagerListItem = "student_manager_list_item",
|
|
155
|
+
ClassroomsList = "classrooms_list",
|
|
156
|
+
ClassroomsListItem = "classrooms_list_item",
|
|
157
|
+
ClassroomOverview = "classroom_overview",
|
|
158
|
+
ClassroomOverviewStudentListItem = "classroom_overview_student_list_item",
|
|
159
|
+
ManageClassroomStudents = "manage_classroom_students",
|
|
160
|
+
ManageClassroomStudentListItem = "manage_classroom_student_list_item",
|
|
161
|
+
ManageClassroomGroups = "manage_classroom_groups",
|
|
162
|
+
ManageClassroomGroupListItem = "manage_classroom_group_list_item",
|
|
163
|
+
PreviewInteractive = "preview_interactive",
|
|
164
|
+
PreviewInteractiveQuestions = "preview_interactive_questions",
|
|
165
|
+
EditInteractive = "edit_interactive",
|
|
166
|
+
PlaySharedInteractive = "play_shared_interactive",
|
|
167
|
+
PlayPage = "play_page",
|
|
168
|
+
Player = "player",
|
|
169
|
+
FloatingPlayer = "floating_player",
|
|
170
|
+
InteractivePlayer = "interactive_player",
|
|
171
|
+
EmbeddedPlayer = "embedded_player",
|
|
172
|
+
CreateClipPlayer = "create_clip_player",
|
|
173
|
+
ContentUpdatesClassificationBanner = "content_updates_classification_banner",
|
|
174
|
+
PreferencesSettings = "preferences_settings",
|
|
175
|
+
MyUploads = "my_uploads",
|
|
176
|
+
SlidingList = "sliding_list",
|
|
177
|
+
HeroBannerItem = "hero_banner_item",
|
|
178
|
+
SlidingListItem = "sliding_list_item",
|
|
179
|
+
ClassificationListItem = "classification_list_item",
|
|
180
|
+
ClassificationComingSoon = "classification_coming_soon",
|
|
181
|
+
ClassificationHero = "classification_hero",
|
|
182
|
+
Dashboard = "dashboard",
|
|
183
|
+
ProductBanner = "product_banner",
|
|
184
|
+
Settings = "settings"
|
|
185
|
+
}
|
|
186
|
+
export declare enum WorkflowPhase {
|
|
187
|
+
Start = "start",
|
|
188
|
+
Complete = "complete",
|
|
189
|
+
Save = "save",
|
|
190
|
+
Discard = "discard"
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Action descriptor sub-types
|
|
194
|
+
*/
|
|
195
|
+
export declare enum PageDescriptor {
|
|
196
|
+
PageLoad = "page_load"
|
|
197
|
+
}
|
|
198
|
+
export declare enum OperationDescriptor {
|
|
199
|
+
Single = "single",
|
|
200
|
+
Bulk = "bulk",
|
|
201
|
+
All = "all"
|
|
202
|
+
}
|
|
203
|
+
export declare enum SortDescriptor {
|
|
204
|
+
ProductionYear = "production_year",
|
|
205
|
+
Alphabetical = "alphabetical"
|
|
206
|
+
}
|
|
207
|
+
export declare enum FilterDescriptor {
|
|
208
|
+
Content = "content",
|
|
209
|
+
Quality = "quality",
|
|
210
|
+
Duration = "duration",
|
|
211
|
+
Reset = "reset"
|
|
212
|
+
}
|
|
213
|
+
export declare enum DirectSearchDescriptor {
|
|
214
|
+
Submit = "submit",
|
|
215
|
+
ShowAll = "show_all",
|
|
216
|
+
Recent = "recent",
|
|
217
|
+
SearchIcon = "search_icon"
|
|
218
|
+
}
|
|
219
|
+
export declare enum PlaybackDescriptor {
|
|
220
|
+
Start = "start",
|
|
221
|
+
Finish = "finish",
|
|
222
|
+
Terminate = "terminate",
|
|
223
|
+
Play = "play",
|
|
224
|
+
Pause = "pause",
|
|
225
|
+
Playback = "playback",
|
|
226
|
+
NextChapter = "next_chapter",
|
|
227
|
+
PreviousChapter = "previous_chapter",
|
|
228
|
+
FullScreenEnter = "full_screen_enter",
|
|
229
|
+
FullScreenExit = "full_screen_exit"
|
|
230
|
+
}
|
|
231
|
+
export declare enum PlayerDescriptor {
|
|
232
|
+
Embedded = "embedded"
|
|
233
|
+
}
|
|
234
|
+
export declare enum ClickDescriptor {
|
|
235
|
+
TogglePreview = "toggle_preview",
|
|
236
|
+
NavigateHome = "navigate_home",
|
|
237
|
+
OpenInStaffView = "open_in_staff_view",
|
|
238
|
+
Title = "title",
|
|
239
|
+
ToggleHideValidListings = "toggle_hide_valid_listings",
|
|
240
|
+
LaunchImmersiveReader = "launch_immersive_reader",
|
|
241
|
+
CopyEmbedHtml = "copy_embed_html",
|
|
242
|
+
Close = "close",
|
|
243
|
+
Open = "open",
|
|
244
|
+
Button = "button",
|
|
245
|
+
Link = "link",
|
|
246
|
+
Tile = "tile",
|
|
247
|
+
Thumbnail = "thumbnail",
|
|
248
|
+
Cover = "cover",
|
|
249
|
+
TallPoster = "tall_poster",
|
|
250
|
+
Slide = "slide",
|
|
251
|
+
ExternalLink = "external_link"
|
|
252
|
+
}
|
|
253
|
+
export declare enum VideoActionDescriptor {
|
|
254
|
+
FeatureUserChannelVideo = "feature_user_channel_video",
|
|
255
|
+
RemoveFromUserChannelPlaylist = "remove_from_user_channel_playlist",
|
|
256
|
+
ShareClip = "share_clip",
|
|
257
|
+
ViewOriginalVideo = "view_original_video",
|
|
258
|
+
ShareInteractive = "share_interactive",
|
|
259
|
+
DeleteInteractiveVideo = "delete_interactive_video",
|
|
260
|
+
CopyInteractiveVideo = "copy_interactive_video",
|
|
261
|
+
EditInteractiveVideo = "edit_interactive_video",
|
|
262
|
+
PrintAsWorksheet = "print_as_worksheet",
|
|
263
|
+
PreviewInteractiveVideo = "preview_interactive_video",
|
|
264
|
+
ViewResults = "view_results",
|
|
265
|
+
MoveToAnotherFolder = "move_to_another_folder",
|
|
266
|
+
CreateInteractiveVideo = "create_interactive_video",
|
|
267
|
+
ShareVideo = "share_video",
|
|
268
|
+
EditVideo = "edit_video",
|
|
269
|
+
DownloadVideo = "download_video",
|
|
270
|
+
AddToExchange = "add_to_exchange",
|
|
271
|
+
AddToUserChannel = "add_to_user_channel",
|
|
272
|
+
CreateClip = "create_clip",
|
|
273
|
+
FlagVideo = "flag_video",
|
|
274
|
+
AddToLibrary = "add_to_library",
|
|
275
|
+
AddToWorkspace = "add_to_workspace",
|
|
276
|
+
AddToPlaylist = "add_to_playlist",
|
|
277
|
+
RemoveFromPlaylist = "remove_from_playlist",
|
|
278
|
+
AddCurriculumLink = "add_curriculum_link",
|
|
279
|
+
ViewCurriculumLinks = "view_curriculum_links",
|
|
280
|
+
OpenInCurator = "open_in_curator",
|
|
281
|
+
ManageVideoAccess = "manage_video_access",
|
|
282
|
+
Approve = "approve",
|
|
283
|
+
AddToLocalCache = "add_to_local_cache",
|
|
284
|
+
OpenInLibraryEditor = "open_in_library_editor",
|
|
285
|
+
PlayClip = "play_clip",
|
|
286
|
+
EditClip = "edit_clip",
|
|
287
|
+
DeleteClip = "delete_clip",
|
|
288
|
+
EditVideoDetails = "edit_video_details",
|
|
289
|
+
DeleteVideo = "delete_video"
|
|
290
|
+
}
|
|
291
|
+
export declare enum CustomerSettingDescriptor {
|
|
292
|
+
LibraryReview = "library_review"
|
|
293
|
+
}
|
|
294
|
+
export declare enum InteractionTypeDescriptor {
|
|
295
|
+
FileSelect = "file_select",
|
|
296
|
+
DragDrop = "drag_drop"
|
|
297
|
+
}
|
|
298
|
+
export declare enum SuggestionDescriptor {
|
|
299
|
+
Edit = "edit"
|
|
300
|
+
}
|
|
301
|
+
export declare enum AssocDescriptor {
|
|
302
|
+
Image = "image",
|
|
303
|
+
User = "user",
|
|
304
|
+
Playlist = "playlist",
|
|
305
|
+
Link = "link",
|
|
306
|
+
Avatar = "avatar"
|
|
307
|
+
}
|
|
308
|
+
export declare enum ToggleDescriptor {
|
|
309
|
+
On = "on",
|
|
310
|
+
Off = "off"
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* Action descriptors give further context to UserActions
|
|
314
|
+
*/
|
|
315
|
+
export declare type ActionDescriptor = OperationDescriptor | SortDescriptor | FilterDescriptor | DirectSearchDescriptor | PageDescriptor | PlaybackDescriptor | PlayerDescriptor | CustomerSettingDescriptor | SuggestionDescriptor | InteractionTypeDescriptor | AssocDescriptor | ClickDescriptor | ToggleDescriptor | VideoActionDescriptor;
|
|
316
|
+
/**
|
|
317
|
+
* Placeholder values to be used in circumstances where we need
|
|
318
|
+
* to simply signify that a change has occurred. Particularly if it is
|
|
319
|
+
* being collected as a set of other changes.
|
|
320
|
+
*/
|
|
321
|
+
export declare enum EventDefaultValue {
|
|
322
|
+
EntityRemoved = "cv_entity_removed",
|
|
323
|
+
ValueUpdated = "cv_value_updated"
|
|
324
|
+
}
|
|
325
|
+
export declare enum InteractionType {
|
|
326
|
+
FileSelect = "file_select",
|
|
327
|
+
DragDrop = "drag_drop"
|
|
328
|
+
}
|
|
329
|
+
export declare enum SearchQueryType {
|
|
330
|
+
Video = "videos",
|
|
331
|
+
Folder = "categories",
|
|
332
|
+
Series = "series",
|
|
333
|
+
Tags = "tags",
|
|
334
|
+
Subjects = "subjects"
|
|
335
|
+
}
|
|
336
|
+
export declare enum EventVersion {
|
|
337
|
+
V1 = 1,
|
|
338
|
+
V2 = 2
|
|
339
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { BaseObject } from 'libs/analytics/interfaces';
|
|
2
|
+
export declare enum UserGroup {
|
|
3
|
+
Staff = "staff",
|
|
4
|
+
Learner = "learner",
|
|
5
|
+
Unknown = "unknown"
|
|
6
|
+
}
|
|
7
|
+
export interface User extends BaseObject {
|
|
8
|
+
countryCode?: string;
|
|
9
|
+
customerId?: string;
|
|
10
|
+
customerGuid?: string;
|
|
11
|
+
customerName?: string;
|
|
12
|
+
crmId?: number;
|
|
13
|
+
role?: string;
|
|
14
|
+
userGroup?: UserGroup;
|
|
15
|
+
yearGroup?: string;
|
|
16
|
+
isOpenCustomer?: boolean;
|
|
17
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { BaseObject } from 'libs/analytics/interfaces';
|
|
2
|
+
import { Series } from './Series';
|
|
3
|
+
import { Folder } from './Folder';
|
|
4
|
+
import { Owner } from './Owner';
|
|
5
|
+
import { Playlist } from './Playlist';
|
|
6
|
+
import { Rating } from './Rating';
|
|
7
|
+
export interface Video extends BaseObject {
|
|
8
|
+
series?: Series;
|
|
9
|
+
categories?: Folder[];
|
|
10
|
+
owner?: Owner;
|
|
11
|
+
playlist?: Playlist;
|
|
12
|
+
rating?: Rating;
|
|
13
|
+
duration?: number;
|
|
14
|
+
trackingCode?: string;
|
|
15
|
+
productionYear?: number;
|
|
16
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export * from './AnalyticsTypes';
|
|
2
|
+
export * from './User';
|
|
3
|
+
export * from './Config';
|
|
4
|
+
export * from './Owner';
|
|
5
|
+
export * from './Folder';
|
|
6
|
+
export * from './HashObject';
|
|
7
|
+
export * from './Playlist';
|
|
8
|
+
export * from './Resource';
|
|
9
|
+
export * from './Rating';
|
|
10
|
+
export * from './Region';
|
|
11
|
+
export * from './RegionalUrl';
|
|
12
|
+
export * from './Series';
|
|
13
|
+
export * from './Subtitle';
|
|
14
|
+
export * from './Video';
|
|
15
|
+
export * from './primitives/BaseObject';
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { ObjectHash } from 'backbone';
|
|
2
|
+
import { AnalyticsEventType, ActionContext } from 'libs/analytics/interfaces';
|
|
3
|
+
import { EventVersion } from 'libs/analytics/interfaces';
|
|
4
|
+
interface Enrichment {
|
|
5
|
+
[prop: string]: string;
|
|
6
|
+
}
|
|
7
|
+
export interface DataObjectPayload extends ObjectHash {
|
|
8
|
+
}
|
|
9
|
+
export interface DataCollectionPayload extends Array<ObjectHash> {
|
|
10
|
+
}
|
|
11
|
+
export declare type AnalyticsDataPayload = DataObjectPayload | DataCollectionPayload;
|
|
12
|
+
/**
|
|
13
|
+
* Base AnalyticsEvent Object.
|
|
14
|
+
* Acts as a wrapper for our events, encapsulating the event type
|
|
15
|
+
* and a data payload.
|
|
16
|
+
*/
|
|
17
|
+
export declare class AnalyticsEvent<TType extends AnalyticsEventType, TPayload extends AnalyticsDataPayload> {
|
|
18
|
+
type: TType;
|
|
19
|
+
data: TPayload;
|
|
20
|
+
actionContext: ActionContext;
|
|
21
|
+
eventVersion: EventVersion;
|
|
22
|
+
constructor(type: TType, data: TPayload, actionContext?: ActionContext, eventVersion?: EventVersion);
|
|
23
|
+
/**
|
|
24
|
+
* Utility function that allows us to create type guards.
|
|
25
|
+
* @param type EventType
|
|
26
|
+
*/
|
|
27
|
+
isType(type: TType): this is TType;
|
|
28
|
+
/**
|
|
29
|
+
* Mix different enrichments into the base AnalyticsEvent object
|
|
30
|
+
* to keep it as flat as possible.
|
|
31
|
+
*
|
|
32
|
+
* @param key Top level enrichment name
|
|
33
|
+
* @param value Either a string or set of KV Pairs
|
|
34
|
+
*/
|
|
35
|
+
enrich(key: string, value: string | Enrichment): void;
|
|
36
|
+
get(key: string): string | Enrichment;
|
|
37
|
+
/**
|
|
38
|
+
* Check that the incoming enrichment doesn't clash with
|
|
39
|
+
* a pre-existing enrichement.
|
|
40
|
+
*
|
|
41
|
+
* @param key
|
|
42
|
+
*/
|
|
43
|
+
private validateKey;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Alias our analytics type to make our function signatures and typings a little cleaner
|
|
47
|
+
*/
|
|
48
|
+
export declare type CoreAnalyticsType = AnalyticsEvent<AnalyticsEventType, AnalyticsDataPayload>;
|
|
49
|
+
export {};
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { HashObject } from 'libs/analytics/interfaces/HashObject';
|
|
2
|
+
import { VersionData } from 'libs/analytics/interfaces/VersionData';
|
|
3
|
+
import { UserAction, EventVersion, ActionContext } from 'libs/analytics/interfaces/AnalyticsTypes';
|
|
4
|
+
import { Region } from 'libs/analytics/interfaces/Region';
|
|
5
|
+
import { CountryCode } from 'libs/analytics/enums/CountryCode';
|
|
6
|
+
export interface IncomingEvent {
|
|
7
|
+
type: CollectionEventType;
|
|
8
|
+
data: HashObject;
|
|
9
|
+
actionContext: ActionContext;
|
|
10
|
+
eventVersion: EventVersion;
|
|
11
|
+
}
|
|
12
|
+
export interface RequestData {
|
|
13
|
+
url: string;
|
|
14
|
+
referrer: string;
|
|
15
|
+
}
|
|
16
|
+
export interface PlatformData {
|
|
17
|
+
browser: VersionData;
|
|
18
|
+
os: VersionData;
|
|
19
|
+
request: RequestData;
|
|
20
|
+
screenResolution: string;
|
|
21
|
+
}
|
|
22
|
+
export interface CollectionEventUserData {
|
|
23
|
+
id: string;
|
|
24
|
+
role: string;
|
|
25
|
+
userGroup: string;
|
|
26
|
+
yearGroup: string;
|
|
27
|
+
customer: {
|
|
28
|
+
id: string;
|
|
29
|
+
name: string;
|
|
30
|
+
country: CountryCode;
|
|
31
|
+
region: Region;
|
|
32
|
+
customerGuid: string;
|
|
33
|
+
crmId: number;
|
|
34
|
+
openCustomer: boolean;
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
export interface CollectionEventData {
|
|
38
|
+
[entity: string]: HashObject;
|
|
39
|
+
action: HashObject;
|
|
40
|
+
user: CollectionEventUserData;
|
|
41
|
+
platform: PlatformData;
|
|
42
|
+
product: VersionData;
|
|
43
|
+
}
|
|
44
|
+
export interface CollectionEventMetadata {
|
|
45
|
+
timestamp: string;
|
|
46
|
+
client: {
|
|
47
|
+
name: string;
|
|
48
|
+
version: string;
|
|
49
|
+
region: Region;
|
|
50
|
+
};
|
|
51
|
+
eventVersion: EventVersion;
|
|
52
|
+
}
|
|
53
|
+
export declare type CollectionEventType = UserAction;
|
|
54
|
+
/**
|
|
55
|
+
* Model to be sent to CollectionApi.
|
|
56
|
+
*/
|
|
57
|
+
export interface CollectionEvent {
|
|
58
|
+
type: CollectionEventType;
|
|
59
|
+
data: CollectionEventData;
|
|
60
|
+
metadata: CollectionEventMetadata;
|
|
61
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Core } from 'libs/common/core';
|
|
2
|
+
interface ApplicationContext {
|
|
3
|
+
pageLoad: boolean;
|
|
4
|
+
appLink: Core.AppLink;
|
|
5
|
+
}
|
|
6
|
+
export interface AppContextServiceOptions {
|
|
7
|
+
}
|
|
8
|
+
export declare class StaticContextService extends Core.Service {
|
|
9
|
+
private static instance;
|
|
10
|
+
private contextHistory;
|
|
11
|
+
get name(): string;
|
|
12
|
+
static get Instance(): StaticContextService;
|
|
13
|
+
initialize(): void;
|
|
14
|
+
private setContext;
|
|
15
|
+
getCurrentContext(): ApplicationContext;
|
|
16
|
+
fromPageLoad(): boolean;
|
|
17
|
+
}
|
|
18
|
+
export declare const ContextService: StaticContextService;
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { IncomingEvent } from 'libs/analytics/models/CollectionEvent';
|
|
2
|
+
import { HashObject } from 'libs/analytics/interfaces';
|
|
3
|
+
export declare const CollectionApiClientHelper: {
|
|
4
|
+
shouldLog(event: IncomingEvent): boolean;
|
|
5
|
+
formatData(event: IncomingEvent): HashObject | HashObject[];
|
|
6
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { CoreAnalyticsType } from 'libs/analytics/models/AnalyticsEvent';
|
|
2
|
+
import { HashObject } from 'libs/analytics/interfaces';
|
|
3
|
+
declare type DataFormatter = (data: HashObject, event: CoreAnalyticsType) => HashObject;
|
|
4
|
+
export interface DataFormatterHash {
|
|
5
|
+
[eventType: string]: DataFormatter;
|
|
6
|
+
}
|
|
7
|
+
export declare const DataFormatHelper: {
|
|
8
|
+
/**
|
|
9
|
+
* Object will be logged to sink as is
|
|
10
|
+
*/
|
|
11
|
+
passthrough(data: HashObject): HashObject;
|
|
12
|
+
getEditData(data: HashObject, event: CoreAnalyticsType): HashObject;
|
|
13
|
+
};
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { CoreAnalyticsType } from 'libs/analytics/models/AnalyticsEvent';
|
|
2
|
+
/**
|
|
3
|
+
* Manage which events we want to log
|
|
4
|
+
*
|
|
5
|
+
* @description
|
|
6
|
+
* All events have a UserAction type, however, that same type can be used to represent
|
|
7
|
+
* different types of actions. For example, `UserAction.Rename` is used for events involving
|
|
8
|
+
* the renaming of folders, libraries and videos (from different parts of the product).
|
|
9
|
+
*
|
|
10
|
+
* So if a situation arises where we only want to collect events for a certain entity or from a
|
|
11
|
+
* certain part of the product. We can add a custom callback below and filter based on the event's actionContext.
|
|
12
|
+
*/
|
|
13
|
+
export declare const EventWhitelistHelper: {
|
|
14
|
+
allow: () => boolean;
|
|
15
|
+
restrict: () => boolean;
|
|
16
|
+
};
|
|
17
|
+
export interface EventWhitelistHash {
|
|
18
|
+
[eventType: string]: (event: CoreAnalyticsType) => boolean;
|
|
19
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { HashObject, Subtitle, Resource } from 'libs/analytics/interfaces';
|
|
2
|
+
import { CoreAnalyticsType } from 'libs/analytics/models/AnalyticsEvent';
|
|
3
|
+
export declare const UploadDataFormatHelper: {
|
|
4
|
+
getUploadData(data: any, event: CoreAnalyticsType): HashObject;
|
|
5
|
+
formatVideoUpload(data: any, event: CoreAnalyticsType): HashObject[];
|
|
6
|
+
getStartVideoUploadData(files: File[]): HashObject[];
|
|
7
|
+
getDiscardVideoUploadData(uploads: HashObject | HashObject[]): HashObject[];
|
|
8
|
+
getCompleteUploadData(videos: HashObject[]): HashObject[];
|
|
9
|
+
formatResourceUpload(item: Resource | Subtitle): HashObject;
|
|
10
|
+
};
|