@schibsted/pulse-sdk 8.0.0-rc.2 → 8.0.0-rc.20

package/dist/ejs/tpaas-builders/builders.js

@@ -0,0 +1,271 @@
+import { merge } from 'ts-deepmerge';
+import { AnonymousViewUIElement, CompletedHealthAction, EngagementAd, EngagementAffiliate, EngagementAudio, EngagementForm, EngagementHealthUIElement, EngagementOffer, EngagementSchoolUIElement, EngagementSportsUIElement, EngagementTeaser, EngagementTvModule, EngagementTvSearch, EngagementUIElement, EngagementVideo, EngagementVideoAd, EngagementWidget, HeartbeatCommercialArticle, ImpressionAd, ImpressionAdSlot, ImpressionAffiliate, ImpressionForm, ImpressionHealthUIElement, ImpressionOffer, ImpressionPlayer, ImpressionSchoolUIElement, ImpressionSportsUIElement, ImpressionTeaser, ImpressionUIElement, ImpressionWidget, LeaveArticle, LeaveAudioPage, LeaveError, LeaveFrontpage, LeaveLandingpage, LeaveListing, LeaveLockedArticle, LeaveLockedAudioPage, LeaveLockedPage, LeaveLockedVideoPage, LeavePage, LeaveSchoolPage, LeaveSportsPage, LeaveVideoPage, LeaveWeather, LoadAd, RequestAd, ViewArticle, ViewAudioPage, ViewError, ViewFrontpage, ViewHealthPage, ViewLandingpage, ViewListing, ViewLockedArticle, ViewLockedAudioPage, ViewLockedPage, ViewLockedVideoPage, ViewPage, ViewSchoolPage, ViewSportsPage, ViewTitle, ViewVideoPage, ViewWeather, } from '../tpaas-schemas';
+import { builder as anonymousBuilder } from './builders/anonymous';
+import { builder as baseEventBuilder } from './builders/baseEvent';
+import { builder as catalogVersionBuilder } from './builders/catalogVersion';
+import { builder as consentsBuilder } from './builders/consents';
+import { builder as deviceBuilder } from './builders/device';
+import { builder as experimentsBuilder } from './builders/experiments';
+import { builder as navigationTypeBuilder } from './builders/navigationType';
+import { builder as pageContentBuilder } from './builders/pageContent';
+import { builder as pageInfoBuilder } from './builders/pageInfo';
+import { builder as pageSportsBuilder } from './builders/pageSports';
+import { builder as pageviewIdBuilder } from './builders/pageviewId';
+import { builder as providerBuilder } from './builders/provider';
+import { builder as referrerBuilder } from './builders/referrer';
+import { builder as sessionBuilder } from './builders/session';
+import { builder as timeBuilder } from './builders/time';
+import { builder as trackerBuilder } from './builders/trackerBuilder';
+import { builder as userBuilder } from './builders/user';
+import { builder as utmBuilder } from './builders/utm';
+/**
+ * Common builders output to be merged into all events
+ * @param createdAt
+ * @param dependencies {TpaasEventBuilderDependencies}
+ * @private
+ */
+export const getCommonBuildersOutput = (createdAt, dependencies, input) => {
+    const { isHybrid, version, environmentId, jwe, user, consents, providerId, providerName, providerGroup, providerStage, providerProduct, providerVersion, component, componentVersion, pageviewId, currentPage, currentPageReferrer, routingStage, } = dependencies;
+    const { experiments } = input;
+    return merge(trackerBuilder({ isHybrid, version, routingStage }), timeBuilder(createdAt), sessionBuilder(createdAt), deviceBuilder(environmentId, jwe), userBuilder(user), baseEventBuilder(), consentsBuilder(consents), providerBuilder(providerId, providerStage, providerProduct, providerVersion, component, componentVersion, providerName, providerGroup), pageInfoBuilder(currentPage), pageviewIdBuilder(pageviewId), utmBuilder(), referrerBuilder(currentPageReferrer), catalogVersionBuilder(), experimentsBuilder(dependencies.experiments, experiments));
+};
+const getElementEventBuildersOutput = (createdAt, dependencies, input) => merge(getCommonBuildersOutput(createdAt, dependencies, input), pageContentBuilder(dependencies.currentPageContent));
+const getSportsElementEventBuildersOutput = (createdAt, dependencies, input) => merge(getElementEventBuildersOutput(createdAt, dependencies, input), pageSportsBuilder(dependencies.currentPageSports));
+// there's a bug in the ts-deepmerge library that doesn't properly resolve merging optionals with required properties
+// due to this, we need to do 2 things:
+// (1) manually omit navigationType from the input before merging.
+// it has no effect on the final value since navigationType will always be set by the navigationTypeBuilder.
+// (2) ensure page is always defined in the input, even when it's not passed to the SDK
+// again, it has no effect on the final value because several builders are passing a page object
+// But this makes TS happy in an elegant way, without type assertions at the merge level
+const normalizePageInput = (input) => {
+    const { page, ...rest } = input;
+    if (!page) {
+        return {
+            ...rest,
+            page: {},
+        };
+    }
+    if (!('navigationType' in page)) {
+        return input;
+    }
+    const { navigationType: _, ...pageRest } = page;
+    return {
+        ...rest,
+        page: {
+            ...pageRest,
+        },
+    };
+};
+// #region AnonymousView Event Builders
+export function buildAnonymousViewUIElementEvent(input, dependencies) {
+    const createdAt = new Date();
+    const { isHybrid, version, pageviewId, providerId, providerName, providerGroup, providerStage, providerProduct, providerVersion, component, componentVersion, currentPageReferrer, routingStage, } = dependencies;
+    return merge(AnonymousViewUIElement, baseEventBuilder(), trackerBuilder({ isHybrid, version, routingStage }), timeBuilder(createdAt), pageviewIdBuilder(pageviewId), utmBuilder(), anonymousBuilder(), providerBuilder(providerId, providerStage, providerProduct, providerVersion, component, componentVersion, providerName, providerGroup), referrerBuilder(currentPageReferrer), experimentsBuilder(dependencies.experiments, input.experiments), catalogVersionBuilder(), normalizePageInput(input));
+}
+// #endregion
+// #region View Event Builders
+export function buildViewArticleEvent(input, dependencies) {
+    return merge(ViewArticle, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewAudioPageEvent(input, dependencies) {
+    return merge(ViewAudioPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewErrorEvent(input, dependencies) {
+    return merge(ViewError, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewFrontpageEvent(input, dependencies) {
+    return merge(ViewFrontpage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewLandingpageEvent(input, dependencies) {
+    return merge(ViewLandingpage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewListingEvent(input, dependencies) {
+    return merge(ViewListing, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewLockedArticleEvent(input, dependencies) {
+    return merge(ViewLockedArticle, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewLockedAudioPageEvent(input, dependencies) {
+    return merge(ViewLockedAudioPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewLockedPageEvent(input, dependencies) {
+    return merge(ViewLockedPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewLockedVideoPageEvent(input, dependencies) {
+    return merge(ViewLockedVideoPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveLockedVideoPageEvent(input, dependencies) {
+    return merge(LeaveLockedVideoPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewPageEvent(input, dependencies) {
+    return merge(ViewPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewSportsPageEvent(input, dependencies) {
+    return merge(ViewSportsPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewSchoolPageEvent(input, dependencies) {
+    return merge(ViewSchoolPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewTitleEvent(input, dependencies) {
+    return merge(ViewTitle, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewVideoPageEvent(input, dependencies) {
+    return merge(ViewVideoPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildViewWeatherEvent(input, dependencies) {
+    return merge(ViewWeather, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+// #endregion
+// #region Leave Event Builders
+export function buildLeaveArticleEvent(input, dependencies) {
+    return merge(LeaveArticle, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveAudioPageEvent(input, dependencies) {
+    return merge(LeaveAudioPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveErrorEvent(input, dependencies) {
+    return merge(LeaveError, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveFrontpageEvent(input, dependencies) {
+    return merge(LeaveFrontpage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveLandingpageEvent(input, dependencies) {
+    return merge(LeaveLandingpage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveListingEvent(input, dependencies) {
+    return merge(LeaveListing, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveLockedArticleEvent(input, dependencies) {
+    return merge(LeaveLockedArticle, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveLockedAudioPageEvent(input, dependencies) {
+    return merge(LeaveLockedAudioPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveLockedPageEvent(input, dependencies) {
+    return merge(LeaveLockedPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeavePageEvent(input, dependencies) {
+    return merge(LeavePage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveSportsPageEvent(input, dependencies) {
+    return merge(LeaveSportsPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveSchoolPageEvent(input, dependencies) {
+    return merge(LeaveSchoolPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveVideoPageEvent(input, dependencies) {
+    return merge(LeaveVideoPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildLeaveWeatherEvent(input, dependencies) {
+    const createdAt = new Date();
+    const { isHybrid, version, providerId, providerName, providerGroup, providerStage, providerProduct, providerVersion, component, componentVersion, user, experiments, routingStage, } = dependencies;
+    return merge(normalizePageInput(input), LeaveWeather, timeBuilder(createdAt), trackerBuilder({ isHybrid, version, routingStage }), baseEventBuilder(), providerBuilder(providerId, providerStage, providerProduct, providerVersion, component, componentVersion, providerName, providerGroup), userBuilder(user), experimentsBuilder(experiments, input.experiments), consentsBuilder(dependencies.consents), deviceBuilder(dependencies.environmentId, dependencies.jwe), catalogVersionBuilder(), navigationTypeBuilder(input.page?.navigationType), pageviewIdBuilder(dependencies.pageviewId), pageInfoBuilder(dependencies.currentPage), referrerBuilder(dependencies.currentPageReferrer));
+}
+// #endregion
+// #region Engagement Event Builders
+export function buildEngagementAdEvent(input, dependencies) {
+    return merge(EngagementAd, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementAffiliateEvent(input, dependencies) {
+    return merge(EngagementAffiliate, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementAudioEvent(input, dependencies) {
+    return merge(EngagementAudio, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementFormEvent(input, dependencies) {
+    return merge(EngagementForm, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementOfferEvent(input, dependencies) {
+    return merge(EngagementOffer, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementSportsUIElementEvent(input, dependencies) {
+    return merge(EngagementSportsUIElement, getSportsElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementSchoolUIElementEvent(input, dependencies) {
+    return merge(EngagementSchoolUIElement, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementTeaserEvent(input, dependencies) {
+    return merge(EngagementTeaser, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementTvModuleEvent(input, dependencies) {
+    return merge(EngagementTvModule, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementTvSearchEvent(input, dependencies) {
+    return merge(EngagementTvSearch, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementUIElementEvent(input, dependencies) {
+    return merge(EngagementUIElement, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementVideoEvent(input, dependencies) {
+    return merge(EngagementVideo, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementVideoAdEvent(input, dependencies) {
+    return merge(EngagementVideoAd, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementWidgetEvent(input, dependencies) {
+    return merge(EngagementWidget, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+// #endregion
+// #region Heartbeat Event Builders
+export function buildHeartbeatCommercialArticleEvent(input, dependencies) {
+    return merge(HeartbeatCommercialArticle, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+// #endregion
+// #region Health Event Builders
+export function buildCompletedHealthActionEvent(input, dependencies) {
+    return merge(CompletedHealthAction, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildEngagementHealthUIElementEvent(input, dependencies) {
+    return merge(EngagementHealthUIElement, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildViewHealthPageEvent(input, dependencies) {
+    return merge(ViewHealthPage, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input), navigationTypeBuilder(input.page?.navigationType));
+}
+export function buildImpressionHealthUIElementEvent(input, dependencies) {
+    return merge(ImpressionHealthUIElement, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+// #endregion
+// #region Impression Event Builders
+export function buildImpressionAdEvent(input, dependencies) {
+    return merge(ImpressionAd, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionAdSlotEvent(input, dependencies) {
+    return merge(ImpressionAdSlot, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionAffiliateEvent(input, dependencies) {
+    return merge(ImpressionAffiliate, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionFormEvent(input, dependencies) {
+    return merge(ImpressionForm, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionOfferEvent(input, dependencies) {
+    return merge(ImpressionOffer, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionPlayerEvent(input, dependencies) {
+    return merge(ImpressionPlayer, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionSportsUIElementEvent(input, dependencies) {
+    return merge(ImpressionSportsUIElement, getSportsElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionSchoolUIElementEvent(input, dependencies) {
+    return merge(ImpressionSchoolUIElement, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionTeaserEvent(input, dependencies) {
+    return merge(ImpressionTeaser, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionUIElementEvent(input, dependencies) {
+    return merge(ImpressionUIElement, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildImpressionWidgetEvent(input, dependencies) {
+    return merge(ImpressionWidget, getElementEventBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+// #endregion
+// #region Ad Lifecycle Event Builders
+export function buildLoadAdEvent(input, dependencies) {
+    return merge(LoadAd, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+export function buildRequestAdEvent(input, dependencies) {
+    return merge(RequestAd, getCommonBuildersOutput(new Date(), dependencies, input), normalizePageInput(input));
+}
+// #endregion

package/dist/ejs/tpaas-builders/guards.js

@@ -0,0 +1,4 @@
+import { PAGE_TYPE_VALUES } from '../tpaas-schemas';
+export function isPageType(pageType) {
+    return PAGE_TYPE_VALUES.some((val) => val === pageType);
+}

package/dist/ejs/tpaas-builders/index.js

@@ -0,0 +1,2 @@
+export * from './builders';
+export { isPageType } from './guards';