Skip to content

Commit 556e94a

Browse files
jridgewelljridgewell
authored
Lint remaining static enums in src (ampproject#36821)
* tmp * Fix types * Fix types * Types * Undo changes to VideoAnalyticsEvents_Enum It requires its own PR. * Inline fetch-polyfill enum * stop linting tests * Fix make-extension template * Fix typescript shames * Fix suspicious LHS error * Fix type * fix test
1 parent 9dc8f18 commit 556e94a

File tree

387 files changed

+3620
-3231
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

387 files changed

+3620
-3231
lines changed

Diff for: ‎3p/ampcontext.js

+45-33
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import {MessageType} from '#core/3p-frame-messaging';
2-
import {AmpEvents} from '#core/constants/amp-events';
1+
import {MessageType_Enum} from '#core/3p-frame-messaging';
2+
import {AmpEvents_Enum} from '#core/constants/amp-events';
33
import {Deferred} from '#core/data-structures/promise';
44
import {isObject} from '#core/types';
55
import {dict, map} from '#core/types/object';
@@ -129,8 +129,8 @@ export class AbstractAmpContext {
129129
/** Registers an general handler for page visibility. */
130130
listenForPageVisibility_() {
131131
this.client_.makeRequest(
132-
MessageType.SEND_EMBED_STATE,
133-
MessageType.EMBED_STATE,
132+
MessageType_Enum.SEND_EMBED_STATE,
133+
MessageType_Enum.EMBED_STATE,
134134
(data) => {
135135
this.hidden = data['pageHidden'];
136136
this.dispatchVisibilityChangeEvent_();
@@ -145,7 +145,7 @@ export class AbstractAmpContext {
145145
dispatchVisibilityChangeEvent_() {
146146
const event = this.win_.document.createEvent('Event');
147147
event.data = {hidden: this.hidden};
148-
event.initEvent(AmpEvents.VISIBILITY_CHANGE, true, true);
148+
event.initEvent(AmpEvents_Enum.VISIBILITY_CHANGE, true, true);
149149
this.win_.dispatchEvent(event);
150150
}
151151

@@ -157,9 +157,12 @@ export class AbstractAmpContext {
157157
* every time we receive a page visibility message.
158158
*/
159159
onPageVisibilityChange(callback) {
160-
return this.client_.registerCallback(MessageType.EMBED_STATE, (data) => {
161-
callback({hidden: data['pageHidden']});
162-
});
160+
return this.client_.registerCallback(
161+
MessageType_Enum.EMBED_STATE,
162+
(data) => {
163+
callback({hidden: data['pageHidden']});
164+
}
165+
);
163166
}
164167

165168
/**
@@ -171,8 +174,8 @@ export class AbstractAmpContext {
171174
*/
172175
observeIntersection(callback) {
173176
return this.client_.makeRequest(
174-
MessageType.SEND_INTERSECTIONS,
175-
MessageType.INTERSECTION,
177+
MessageType_Enum.SEND_INTERSECTIONS,
178+
MessageType_Enum.INTERSECTION,
176179
(intersection) => {
177180
callback(intersection['changes']);
178181
}
@@ -188,7 +191,7 @@ export class AbstractAmpContext {
188191
*/
189192
getHtml(selector, attributes, callback) {
190193
this.client_.getData(
191-
MessageType.GET_HTML,
194+
MessageType_Enum.GET_HTML,
192195
dict({
193196
'selector': selector,
194197
'attributes': attributes,
@@ -203,7 +206,7 @@ export class AbstractAmpContext {
203206
* @param {function(*)} callback
204207
*/
205208
getConsentState(callback) {
206-
this.client_.getData(MessageType.GET_CONSENT_STATE, null, callback);
209+
this.client_.getData(MessageType_Enum.GET_CONSENT_STATE, null, callback);
207210
}
208211

209212
/**
@@ -217,7 +220,7 @@ export class AbstractAmpContext {
217220
requestResize(width, height, hasOverflow) {
218221
const requestId = this.nextResizeRequestId_++;
219222
this.client_.sendMessage(
220-
MessageType.EMBED_SIZE,
223+
MessageType_Enum.EMBED_SIZE,
221224
dict({
222225
'id': requestId,
223226
'width': width,
@@ -234,21 +237,27 @@ export class AbstractAmpContext {
234237
* Set up listeners to handle responses from request size.
235238
*/
236239
listenToResizeResponse_() {
237-
this.client_.registerCallback(MessageType.EMBED_SIZE_CHANGED, (data) => {
238-
const id = data['id'];
239-
if (id !== undefined) {
240-
this.resizeIdToDeferred_[id].resolve();
241-
delete this.resizeIdToDeferred_[id];
240+
this.client_.registerCallback(
241+
MessageType_Enum.EMBED_SIZE_CHANGED,
242+
(data) => {
243+
const id = data['id'];
244+
if (id !== undefined) {
245+
this.resizeIdToDeferred_[id].resolve();
246+
delete this.resizeIdToDeferred_[id];
247+
}
242248
}
243-
});
249+
);
244250

245-
this.client_.registerCallback(MessageType.EMBED_SIZE_DENIED, (data) => {
246-
const id = data['id'];
247-
if (id !== undefined) {
248-
this.resizeIdToDeferred_[id].reject('Resizing is denied');
249-
delete this.resizeIdToDeferred_[id];
251+
this.client_.registerCallback(
252+
MessageType_Enum.EMBED_SIZE_DENIED,
253+
(data) => {
254+
const id = data['id'];
255+
if (id !== undefined) {
256+
this.resizeIdToDeferred_[id].reject('Resizing is denied');
257+
delete this.resizeIdToDeferred_[id];
258+
}
250259
}
251-
});
260+
);
252261
}
253262

254263
/**
@@ -257,7 +266,7 @@ export class AbstractAmpContext {
257266
*/
258267
sendDeprecationNotice_(endpoint) {
259268
this.client_.sendMessage(
260-
MessageType.USER_ERROR_IN_IFRAME,
269+
MessageType_Enum.USER_ERROR_IN_IFRAME,
261270
dict({
262271
'message': `${endpoint} is deprecated`,
263272
'expected': true,
@@ -273,9 +282,12 @@ export class AbstractAmpContext {
273282
* request succeeds.
274283
*/
275284
onResizeSuccess(callback) {
276-
this.client_.registerCallback(MessageType.EMBED_SIZE_CHANGED, (obj) => {
277-
callback(obj['requestedHeight'], obj['requestedWidth']);
278-
});
285+
this.client_.registerCallback(
286+
MessageType_Enum.EMBED_SIZE_CHANGED,
287+
(obj) => {
288+
callback(obj['requestedHeight'], obj['requestedWidth']);
289+
}
290+
);
279291
this.sendDeprecationNotice_('onResizeSuccess');
280292
}
281293

@@ -287,7 +299,7 @@ export class AbstractAmpContext {
287299
* request is denied.
288300
*/
289301
onResizeDenied(callback) {
290-
this.client_.registerCallback(MessageType.EMBED_SIZE_DENIED, (obj) => {
302+
this.client_.registerCallback(MessageType_Enum.EMBED_SIZE_DENIED, (obj) => {
291303
callback(obj['requestedHeight'], obj['requestedWidth']);
292304
});
293305
this.sendDeprecationNotice_('onResizeDenied');
@@ -297,7 +309,7 @@ export class AbstractAmpContext {
297309
* Make the ad interactive.
298310
*/
299311
signalInteractive() {
300-
this.client_.sendMessage(MessageType.SIGNAL_INTERACTIVE);
312+
this.client_.sendMessage(MessageType_Enum.SIGNAL_INTERACTIVE);
301313
}
302314

303315
/**
@@ -314,7 +326,7 @@ export class AbstractAmpContext {
314326
* Notifies the parent document of no content available inside embed.
315327
*/
316328
noContentAvailable() {
317-
this.client_.sendMessage(MessageType.NO_CONTENT);
329+
this.client_.sendMessage(MessageType_Enum.NO_CONTENT);
318330
}
319331

320332
/**
@@ -414,7 +426,7 @@ export class AbstractAmpContext {
414426
return;
415427
}
416428
this.client_.sendMessage(
417-
MessageType.USER_ERROR_IN_IFRAME,
429+
MessageType_Enum.USER_ERROR_IN_IFRAME,
418430
dict({
419431
'message': e.message,
420432
})

Diff for: ‎3p/iframe-transport-client.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
import {IframeTransportEventDef, MessageType} from '#core/3p-frame-messaging';
1+
import {
2+
IframeTransportEventDef,
3+
MessageType_Enum,
4+
} from '#core/3p-frame-messaging';
25
import {tryParseJson} from '#core/types/object/json';
36

47
import {dev, devAssert, user, userAssert} from '#utils/log';
@@ -46,8 +49,8 @@ export class IframeTransportClient {
4649
)
4750
);
4851
this.iframeMessagingClient_.makeRequest(
49-
MessageType.SEND_IFRAME_TRANSPORT_EVENTS,
50-
MessageType.IFRAME_TRANSPORT_EVENTS,
52+
MessageType_Enum.SEND_IFRAME_TRANSPORT_EVENTS,
53+
MessageType_Enum.IFRAME_TRANSPORT_EVENTS,
5154
(eventData) => {
5255
const events = /** @type {!Array<IframeTransportEventDef>} */ (
5356
eventData['events']
@@ -163,7 +166,7 @@ export class IframeTransportContext {
163166
*/
164167
sendResponseToCreative(data) {
165168
this.iframeMessagingClient_./*OK*/ sendMessage(
166-
MessageType.IFRAME_TRANSPORT_RESPONSE,
169+
MessageType_Enum.IFRAME_TRANSPORT_RESPONSE,
167170
/** @type {!JsonObject} */
168171
({message: data, ...this.baseMessage_})
169172
);

Diff for: ‎ads/google/a4a/utils.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export const ValidAdContainerTypes = {
3939
};
4040

4141
/**
42-
* See `VisibilityState` enum.
42+
* See `VisibilityState_Enum` enum.
4343
* @const {!Object<string, string>}
4444
*/
4545
const visibilityStateCodes = {
@@ -1090,7 +1090,7 @@ export function setNameframeExperimentConfigs(headers, nameframeConfig) {
10901090
* than 32 capabilities to this enum.
10911091
* @enum {number}
10921092
*/
1093-
const Capability = {
1093+
const Capability_Enum = {
10941094
SVG_SUPPORTED: 1 << 0,
10951095
SANDBOXING_ALLOW_TOP_NAVIGATION_BY_USER_ACTIVATION_SUPPORTED: 1 << 1,
10961096
SANDBOXING_ALLOW_POPUPS_TO_ESCAPE_SANDBOX_SUPPORTED: 1 << 2,
@@ -1105,17 +1105,17 @@ function getBrowserCapabilitiesBitmap(win) {
11051105
let browserCapabilities = 0;
11061106
const doc = win.document;
11071107
if (win.SVGElement && doc.createElementNS) {
1108-
browserCapabilities |= Capability.SVG_SUPPORTED;
1108+
browserCapabilities |= Capability_Enum.SVG_SUPPORTED;
11091109
}
11101110
const iframeEl = doc.createElement('iframe');
11111111
if (iframeEl.sandbox && iframeEl.sandbox.supports) {
11121112
if (iframeEl.sandbox.supports('allow-top-navigation-by-user-activation')) {
11131113
browserCapabilities |=
1114-
Capability.SANDBOXING_ALLOW_TOP_NAVIGATION_BY_USER_ACTIVATION_SUPPORTED;
1114+
Capability_Enum.SANDBOXING_ALLOW_TOP_NAVIGATION_BY_USER_ACTIVATION_SUPPORTED;
11151115
}
11161116
if (iframeEl.sandbox.supports('allow-popups-to-escape-sandbox')) {
11171117
browserCapabilities |=
1118-
Capability.SANDBOXING_ALLOW_POPUPS_TO_ESCAPE_SANDBOX_SUPPORTED;
1118+
Capability_Enum.SANDBOXING_ALLOW_POPUPS_TO_ESCAPE_SANDBOX_SUPPORTED;
11191119
}
11201120
}
11211121
return browserCapabilities;

Diff for: ‎ads/google/ima/ima-video.js

+16-14
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ function onImaLoadSuccess(global, data) {
549549
requestAds();
550550
} else {
551551
// Let amp-ima-video know that we are done set-up.
552-
postMessage({event: VideoEvents.LOAD});
552+
postMessage({event: VideoEvents_Enum.LOAD});
553553
}
554554
}
555555

@@ -564,7 +564,7 @@ function onImaLoadFail() {
564564
showControlsThrottled
565565
);
566566
imaLoadAllowed = false;
567-
postMessage({event: VideoEvents.LOAD});
567+
postMessage({event: VideoEvents_Enum.LOAD});
568568
}
569569

570570
/**
@@ -688,8 +688,8 @@ export function onContentEnded() {
688688
toggle(elements['overlayButton'], true);
689689
}
690690

691-
postMessage({event: VideoEvents.PAUSE});
692-
postMessage({event: VideoEvents.ENDED});
691+
postMessage({event: VideoEvents_Enum.PAUSE});
692+
postMessage({event: VideoEvents_Enum.ENDED});
693693
}
694694

695695
/**
@@ -737,7 +737,7 @@ export function onAdsManagerLoaded(global, adsManagerLoadedEvent) {
737737
if (muteAdsManagerOnLoaded) {
738738
adsManager.setVolume(0);
739739
}
740-
postMessage({event: VideoEvents.LOAD});
740+
postMessage({event: VideoEvents_Enum.LOAD});
741741
}
742742

743743
/**
@@ -750,7 +750,7 @@ export function onAdsLoaderError() {
750750
// Send this message to trigger auto-play for failed pre-roll requests -
751751
// failing to load an ad is just as good as loading one as far as starting
752752
// playback is concerned because our content will be ready to play.
753-
postMessage({event: VideoEvents.LOAD});
753+
postMessage({event: VideoEvents_Enum.LOAD});
754754
addHoverEventToElement(
755755
/** @type {!Element} */ (elements['video']),
756756
showControlsThrottled
@@ -766,7 +766,7 @@ export function onAdsLoaderError() {
766766
* @visibleForTesting
767767
*/
768768
export function onAdError() {
769-
postMessage({event: VideoEvents.AD_END});
769+
postMessage({event: VideoEvents_Enum.AD_END});
770770
currentAd = null;
771771
if (adsManager) {
772772
adsManager.destroy();
@@ -824,7 +824,7 @@ export function onContentPauseRequested(global) {
824824
}
825825
adsActive = true;
826826
playerState = PlayerStates.PLAYING;
827-
postMessage({event: VideoEvents.AD_START});
827+
postMessage({event: VideoEvents_Enum.AD_START});
828828
toggle(elements['adContainer'], true);
829829
showAdControls();
830830

@@ -849,7 +849,7 @@ export function onContentResumeRequested() {
849849
/** @type {!Element} */ (video),
850850
showControlsThrottled
851851
);
852-
postMessage({event: VideoEvents.AD_END});
852+
postMessage({event: VideoEvents_Enum.AD_END});
853853
resetControlsAfterAd();
854854
if (!contentComplete) {
855855
// CONTENT_RESUME will fire after post-rolls as well, and we don't want to
@@ -1096,7 +1096,7 @@ export function playVideo() {
10961096
video.play();
10971097
}
10981098
playerState = PlayerStates.PLAYING;
1099-
postMessage({event: VideoEvents.PLAYING});
1099+
postMessage({event: VideoEvents_Enum.PLAYING});
11001100
toggleRootDataAttribute('playing', true);
11011101
}
11021102

@@ -1121,7 +1121,7 @@ export function pauseVideo(event = null) {
11211121
}
11221122
}
11231123
playerState = PlayerStates.PAUSED;
1124-
postMessage({event: VideoEvents.PAUSE});
1124+
postMessage({event: VideoEvents_Enum.PAUSE});
11251125
toggleRootDataAttribute('playing', false);
11261126
}
11271127

@@ -1168,7 +1168,9 @@ export function toggleMuted(video, muted) {
11681168
muteAdsManagerOnLoaded = muted;
11691169
}
11701170
toggleRootDataAttribute('muted', muted);
1171-
postMessage({event: muted ? VideoEvents.MUTED : VideoEvents.UNMUTED});
1171+
postMessage({
1172+
event: muted ? VideoEvents_Enum.MUTED : VideoEvents_Enum.UNMUTED,
1173+
});
11721174
}
11731175

11741176
/**
@@ -1622,10 +1624,10 @@ export function setConsentStateForTesting(newConsentState) {
16221624
*
16231625
* Copied from src/video-interface.js.
16241626
*
1625-
* @const {!Object<string, string>}
1627+
* @enum {string}
16261628
*/
16271629
// TODO(aghassemi, #9216): Use video-interface.js
1628-
const VideoEvents = {
1630+
const VideoEvents_Enum = {
16291631
/**
16301632
* load
16311633
*

0 commit comments

Comments
 (0)