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
|
/**
* @license
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {AttributeHelperPluginApi} from '../../../api/attribute-helper';
import {PluginApi} from '../../../api/plugin';
import {getAppContext} from '../../../services/app-context';
export class GrAttributeHelper implements AttributeHelperPluginApi {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
private readonly _promises = new Map<string, Promise<any>>();
private readonly reporting = getAppContext().reportingService;
// TODO(TS): Change any to something more like HTMLElement.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
constructor(readonly plugin: PluginApi, public element: any) {
this.reporting.trackApi(this.plugin, 'attribute', 'constructor');
}
_getChangedEventName(name: string): string {
return name.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase() + '-changed';
}
/**
* Returns true if the property is defined on wrapped element.
*/
_elementHasProperty(name: string) {
return this.element[name] !== undefined;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
_reportValue(callback: (value: any) => void, value: any) {
try {
callback(value);
} catch (e) {
console.info(e);
}
}
/**
* Binds callback to property updates.
*
* @param name Property name.
* @return Unbind function.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
bind(name: string, callback: (value: any) => void) {
this.reporting.trackApi(this.plugin, 'attribute', 'bind');
const attributeChangedEventName = this._getChangedEventName(name);
const changedHandler = (e: CustomEvent) =>
this._reportValue(callback, e.detail.value);
const unbind = () =>
this.element.removeEventListener(
attributeChangedEventName,
changedHandler
);
this.element.addEventListener(attributeChangedEventName, changedHandler);
if (this._elementHasProperty(name)) {
this._reportValue(callback, this.element[name]);
}
return unbind;
}
/**
* Get value of the property from wrapped object. Waits for the property
* to be initialized if it isn't defined.
*/
get(name: string): Promise<unknown> {
this.reporting.trackApi(this.plugin, 'attribute', 'get');
if (this._elementHasProperty(name)) {
return Promise.resolve(this.element[name]);
}
if (!this._promises.has(name)) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let resolve: (value: any) => void;
const promise = new Promise(r => (resolve = r));
const unbind = this.bind(name, value => {
resolve(value);
unbind();
});
this._promises.set(name, promise);
}
return this._promises.get(name)!;
}
/**
* Sets value of property (not attribute!) and dispatches event to force
* notify.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
set(name: string, value: any) {
this.reporting.trackApi(this.plugin, 'attribute', 'set');
this.element[name] = value;
this.element.dispatchEvent(
new CustomEvent(this._getChangedEventName(name), {detail: {value}})
);
}
}
|
