1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
//
// hero-carousel-overlay-common.ts
// AppStoreKit
//
// Created by Jonathan Ellenbogen on 12/11/20.
// Copyright (c) 2016 Apple Inc. All rights reserved.
//
import * as models from "../../../api/models";
import * as serverData from "../../../foundation/json-parsing/server-data";
import * as mediaAttributes from "../../../foundation/media/attributes";
import * as mediaDataStructure from "../../../foundation/media/data-structure";
import * as mediaRelationship from "../../../foundation/media/relationships";
import * as color from "../../../foundation/util/color-util";
import * as breakoutsCommon from "../../arcade/breakouts-common";
import * as contentAttributes from "../../content/attributes";
import * as content from "../../content/content";
import * as lockups from "../../lockups/lockups";
import * as metricsHelpersClicks from "../../metrics/helpers/clicks";
import * as metricsHelpersImpressions from "../../metrics/helpers/impressions";
import * as heroCommon from "./hero-common";
import * as lottery from "../../util/lottery";
export function overlayFromData(objectGraph, data, requirements) {
const heroCarouselItemOverlay = new models.HeroCarouselItemOverlay();
heroCarouselItemOverlay.overlayType = overlayTypeFromData(objectGraph, data);
heroCarouselItemOverlay.displayOptions = {
horizontalPlacement: overlayPlacementFromData(objectGraph, data),
textAlignment: overlayTextAlignmentFromData(objectGraph, data),
isOverDarkContent: overlayIsOverDarkContent(objectGraph, data),
};
const primaryContent = content.primaryContentForData(objectGraph, data);
// If this EI can and should show the expected release date of an app, override the badge.
const fallbackLabel = mediaAttributes.attributeAsString(data, "label");
if (contentAttributes.contentAttributeAsBooleanOrFalse(objectGraph, data, "showExpectedReleaseDate")) {
heroCarouselItemOverlay.badgeText = objectGraph.loc.uppercased(content.dynamicPreorderDateFromData(objectGraph, primaryContent, fallbackLabel));
}
else {
heroCarouselItemOverlay.badgeText = fallbackLabel;
}
heroCarouselItemOverlay.titleText =
content.editorialNotesFromData(objectGraph, data, "name") ||
contentAttributes.contentAttributeAsString(objectGraph, primaryContent, "name");
if (heroCarouselItemOverlay.overlayType === "singleModule" ||
heroCarouselItemOverlay.overlayType === "collectionModule") {
heroCarouselItemOverlay.descriptionText = content.editorialNotesFromData(objectGraph, data, "tagline");
}
else {
heroCarouselItemOverlay.descriptionText =
content.editorialNotesFromData(objectGraph, data, "short") ||
contentAttributes.contentAttributeAsString(objectGraph, primaryContent, "tagline");
}
heroCarouselItemOverlay.callToActionText = mediaAttributes.attributeAsString(data, "breakoutCallToActionLabel");
heroCarouselItemOverlay.buttonTitle = overlayButtonTitleFromData(objectGraph, data);
if (heroCarouselItemOverlay.overlayType === "lockup" || heroCarouselItemOverlay.overlayType === "singleModule") {
heroCarouselItemOverlay.lockup = overlayLockupFromData(objectGraph, data, requirements);
}
// For hero items the design is to use editorial labels instead of "Apple Arcade" so we replace that text here
if ((fallbackLabel === null || fallbackLabel === void 0 ? void 0 : fallbackLabel.length) > 0 && serverData.isDefinedNonNull(heroCarouselItemOverlay.lockup)) {
heroCarouselItemOverlay.lockup.heading = fallbackLabel;
}
heroCarouselItemOverlay.collectionIcons = overlayCollectionIconsFromData(objectGraph, data);
if (serverData.isDefinedNonNullNonEmpty(heroCarouselItemOverlay.lockup)) {
heroCarouselItemOverlay.clickAction = heroCarouselItemOverlay.lockup.clickAction;
heroCarouselItemOverlay.impressionMetrics = heroCarouselItemOverlay.lockup.impressionMetrics;
}
else {
const heroCarouselItemOverlayMetricsOptions = {
targetType: "lockup",
pageInformation: requirements.metricsPageInformation,
locationTracker: requirements.metricsLocationTracker,
recoMetricsData: mediaDataStructure.metricsFromMediaApiObject(data),
};
const overlayMetricsTitle = heroCarouselItemTitleFromData(objectGraph, data);
const heroCarouselItemOverlayAction = breakoutsCommon.actionFromData(objectGraph, data);
heroCarouselItemOverlayAction.title = overlayMetricsTitle;
const heroCarouselItemOverlayClickOptions = {
pageInformation: requirements.metricsPageInformation,
locationTracker: requirements.metricsLocationTracker,
recoMetricsData: mediaDataStructure.metricsFromMediaApiObject(data),
targetType: "lockup",
id: data.id,
};
metricsHelpersClicks.addClickEventToAction(objectGraph, heroCarouselItemOverlayAction, heroCarouselItemOverlayClickOptions);
heroCarouselItemOverlay.clickAction = heroCarouselItemOverlayAction;
const heroCarouselItemOverlayImpressionsOptions = metricsHelpersImpressions.impressionOptions(objectGraph, data, overlayMetricsTitle, heroCarouselItemOverlayMetricsOptions);
metricsHelpersImpressions.addImpressionFields(objectGraph, heroCarouselItemOverlay, heroCarouselItemOverlayImpressionsOptions);
}
return heroCarouselItemOverlay;
}
export function overlayTypeFromData(objectGraph, data) {
const displayMaterial = mediaAttributes.attributeAsBooleanOrFalse(data, "displayBreakoutMaterial");
const editorialItemKind = mediaAttributes.attributeAsString(data, "kind");
const relatedCollection = mediaRelationship.relationshipCollection(data, "card-contents");
const tagline = content.editorialNotesFromData(objectGraph, data, "tagline");
const canPresentHeroModuleStyle = allowHeroModuleStylePresentation(objectGraph) && (tagline === null || tagline === void 0 ? void 0 : tagline.length) > 0;
let relatedApp = mediaRelationship.relationshipData(objectGraph, data, "primary-content");
if (serverData.isNullOrEmpty(relatedApp) && serverData.isDefinedNonNullNonEmpty(relatedCollection)) {
relatedApp = relatedCollection[0];
}
if (serverData.isDefinedNonNull(relatedApp) && editorialItemKind === "App") {
return canPresentHeroModuleStyle ? "singleModule" : "lockup";
}
else if (serverData.isDefinedNonNullNonEmpty(relatedCollection) && editorialItemKind === "Collection") {
return canPresentHeroModuleStyle ? "collectionModule" : "collectionLockup";
}
else if (displayMaterial) {
return "materialText";
}
else {
return objectGraph.client.isTV ? "materialText" : "text";
}
}
export function heroCarouselItemTitleFromData(objectGraph, data) {
const overlayType = overlayTypeFromData(objectGraph, data);
const primaryContent = mediaRelationship.relationshipData(objectGraph, data, "primary-content");
switch (overlayType) {
case "lockup":
case "singleModule":
return mediaAttributes.attributeAsString(primaryContent, "name");
case "materialText":
case "text":
case "collectionLockup":
case "collectionModule":
return (content.editorialNotesFromData(objectGraph, data, "name") ||
contentAttributes.contentAttributeAsString(objectGraph, primaryContent, "name"));
default:
return null;
}
}
export function overlayLockupFromData(objectGraph, data, requirements) {
let relatedApp = mediaRelationship.relationshipData(objectGraph, data, "primary-content");
const relatedCollection = mediaRelationship.relationshipCollection(data, "card-contents");
if (serverData.isNullOrEmpty(relatedApp) && serverData.isDefinedNonNullNonEmpty(relatedCollection)) {
relatedApp = relatedCollection[0];
}
if (serverData.isNullOrEmpty(relatedApp)) {
return null;
}
// Create the lockup
const lockupOptions = {
metricsOptions: {
pageInformation: requirements.metricsPageInformation,
locationTracker: requirements.metricsLocationTracker,
recoMetricsData: mediaDataStructure.metricsFromMediaApiObject(data),
},
artworkUseCase: requirements.lockupArtworkUseCase,
offerStyle: "transparent",
offerEnvironment: "dark",
canDisplayArcadeOfferButton: requirements.canDisplayArcadeOfferButton,
shouldHideArcadeHeader: objectGraph.featureFlags.isEnabled("hide_arcade_header_on_arcade_tab"),
isContainedInPreorderExclusiveShelf: requirements.isContainedInPreorderExclusiveShelf,
};
const lockup = lockups.lockupFromData(objectGraph, relatedApp, lockupOptions);
const primaryContent = content.primaryContentForData(objectGraph, data);
const editorialTagline = content.editorialNotesFromData(objectGraph, data, "short") ||
contentAttributes.contentAttributeAsString(objectGraph, primaryContent, "tagline");
if ((editorialTagline === null || editorialTagline === void 0 ? void 0 : editorialTagline.length) > 0) {
lockup.subtitle = editorialTagline;
}
return lockup;
}
export function overlayCollectionIconsFromData(objectGraph, data) {
const relatedCollection = mediaRelationship.relationshipCollection(data, "card-contents");
if (serverData.isNullOrEmpty(relatedCollection)) {
return null;
}
const icons = [];
for (const item of relatedCollection) {
const icon = content.iconFromData(objectGraph, item, {
useCase: 1 /* content.ArtworkUseCase.LockupIconSmall */,
withJoeColorPlaceholder: true,
});
if (serverData.isDefinedNonNullNonEmpty(icon)) {
icons.push(icon);
}
}
return serverData.isDefinedNonNullNonEmpty(icons) ? icons : null;
}
export function overlayButtonTitleFromData(objectGraph, data) {
if (objectGraph.client.deviceType !== "tv") {
return null;
}
const overlayType = overlayTypeFromData(objectGraph, data);
switch (overlayType) {
case "lockup":
return objectGraph.loc.string("HERO_CAROUSEL_OVERLAY_BUTTON_TITLE_GAME");
case "materialText":
case "text":
let buttonTitle = objectGraph.loc.string("HERO_CAROUSEL_OVERLAY_BUTTON_TITLE_VIEW");
if (buttonTitle === "HERO_CAROUSEL_OVERLAY_BUTTON_TITLE_VIEW") {
buttonTitle = objectGraph.loc.string("HERO_CAROUSEL_OVERLAY_BUTTON_TITLE_GAME");
}
return buttonTitle;
case "collectionLockup":
return objectGraph.loc.string("HERO_CAROUSEL_OVERLAY_BUTTON_TITLE_COLLECTION");
default:
return null;
}
}
export function overlayIsOverDarkContent(objectGraph, data) {
const heroVideoData = heroCommon.heroVideoFromData(objectGraph, data);
const heroArtworkData = heroCommon.heroArtworkFromData(objectGraph, data);
const backgroundColor = heroVideoData.backgroundColor || heroArtworkData.backgroundColor;
if (!backgroundColor) {
return true;
}
return color.isDarkColor(backgroundColor, 50);
}
export function overlayPlacementFromData(objectGraph, data) {
if (objectGraph.client.isPhone) {
return "center";
}
if (objectGraph.client.isTV) {
return "leading";
}
const heroCarouselItemPlacementString = mediaAttributes.attributeAsString(data, "breakoutTextAlignment");
if (!serverData.isDefinedNonNullNonEmpty(heroCarouselItemPlacementString)) {
return objectGraph.client.isMac ? "center" : "leading";
}
switch (heroCarouselItemPlacementString.toLowerCase()) {
case "left":
return "leading";
case "center":
return "center";
case "right":
return "trailing";
default:
return "leading";
}
}
/**
* The text alignment to use for a particular detail position on large breakouts
* @param data
*/
function overlayTextAlignmentFromData(objectGraph, data) {
const placement = overlayPlacementFromData(objectGraph, data);
const isTV = objectGraph.client.isTV;
switch (placement) {
case "leading":
return "leading";
case "trailing":
return "leading";
case "center":
if (isTV) {
return "leading";
}
else {
return objectGraph.client.isMac ? "center" : "leading";
}
default:
return "leading";
}
}
/**
* Decides whether to account for the Hero 3.0 styles.
*
* @param objectGraph The object graph.
*/
function allowHeroModuleStylePresentation(objectGraph) {
const isNotTV = !objectGraph.client.isTV;
const isFeatureEnabledForCurrentUser = lottery.isFeatureEnabledForCurrentUser(objectGraph, objectGraph.bag.hero3RolloutRate);
return isNotTV && isFeatureEnabledForCurrentUser;
}
//# sourceMappingURL=hero-carousel-overlay-common.js.map
|
