Skip to content
Navigation Menu
{{ message }}
forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathservice.ts
More file actions
388 lines (329 loc) · 13.5 KB
/
Copy pathservice.ts
File metadata and controls
388 lines (329 loc) · 13.5 KB
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
import * as embed from './embed';
import { Report } from './report';
import { Create } from './create';
import { Dashboard } from './dashboard';
import { Tile } from './tile';
import { Page } from './page';
import * as utils from './util';
import * as wpmp from 'window-post-message-proxy';
import * as hpm from 'http-post-message';
import * as router from 'powerbi-router';
import * as models from 'powerbi-models';
export interface IEvent<T> {
type: string;
id: string;
name: string;
value: T;
}
export interface ICustomEvent<T> extends CustomEvent {
detail: T;
}
export interface IEventHandler<T> {
(event: ICustomEvent<T>): any;
}
export interface IHpmFactory {
(wpmp: wpmp.WindowPostMessageProxy, targetWindow?: Window, version?: string, type?: string, origin?: string): hpm.HttpPostMessage;
}
export interface IWpmpFactory {
(name?: string, logMessages?: boolean, eventSourceOverrideWindow?: Window): wpmp.WindowPostMessageProxy;
}
export interface IRouterFactory {
(wpmp: wpmp.WindowPostMessageProxy): router.Router;
}
export interface IPowerBiElement extends HTMLElement {
powerBiEmbed: embed.Embed;
}
export interface IDebugOptions {
logMessages?: boolean;
wpmpName?: string;
}
export interface IServiceConfiguration extends IDebugOptions {
autoEmbedOnContentLoaded?: boolean;
onError?: (error: any) => any;
version?: string;
type?: string;
}
export interface IService {
hpm: hpm.HttpPostMessage;
}
/**
* The Power BI Service embed component, which is the entry point to embed all other Power BI components into your application
*
* @export
* @class Service
* @implements {IService}
*/
export class Service implements IService {
/**
* A list of components that this service can embed
*/
private static components: (typeof Report | typeof Tile | typeof Dashboard)[] = [
Tile,
Report,
Dashboard
];
/**
* The default configuration for the service
*/
private static defaultConfig: IServiceConfiguration = {
autoEmbedOnContentLoaded: false,
onError: (...args) => console.log(args[0], args.slice(1))
};
/**
* Gets or sets the access token as the global fallback token to use when a local token is not provided for a report or tile.
*
* @type {string}
*/
accessToken: string;
/**The Configuration object for the service*/
private config: IServiceConfiguration;
/** A list of Dashboard, Report and Tile components that have been embedded using this service instance. */
private embeds: embed.Embed[];
/** TODO: Look for way to make hpm private without sacraficing ease of maitenance. This should be private but in embed needs to call methods. */
hpm: hpm.HttpPostMessage;
/** TODO: Look for way to make wpmp private. This is only public to allow stopping the wpmp in tests */
wpmp: wpmp.WindowPostMessageProxy;
private router: router.Router;
/**
* Creates an instance of a Power BI Service.
*
* @param {IHpmFactory} hpmFactory The http post message factory used in the postMessage communication layer
* @param {IWpmpFactory} wpmpFactory The window post message factory used in the postMessage communication layer
* @param {IRouterFactory} routerFactory The router factory used in the postMessage communication layer
* @param {IServiceConfiguration} [config={}]
*/
constructor(hpmFactory: IHpmFactory, wpmpFactory: IWpmpFactory, routerFactory: IRouterFactory, config: IServiceConfiguration = {}) {
this.wpmp = wpmpFactory(config.wpmpName, config.logMessages);
this.hpm = hpmFactory(this.wpmp, null, config.version, config.type);
this.router = routerFactory(this.wpmp);
/**
* Adds handler for report events.
*/
this.router.post(`/reports/:uniqueId/events/:eventName`, (req, res) => {
const event: IEvent<any> = {
type: 'report',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
this.handleEvent(event);
});
this.router.post(`/reports/:uniqueId/pages/:pageName/events/:eventName`, (req, res) => {
const event: IEvent<any> = {
type: 'report',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
this.handleEvent(event);
});
this.router.post(`/dashboards/:uniqueId/events/:eventName`, (req, res) => {
const event: IEvent<any> = {
type: 'dashboard',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
this.handleEvent(event);
});
this.embeds = [];
// TODO: Change when Object.assign is available.
this.config = utils.assign({}, Service.defaultConfig, config);
if (this.config.autoEmbedOnContentLoaded) {
this.enableAutoEmbed();
}
}
/**
* Creates new report
* @param {HTMLElement} element
* @param {embed.IEmbedConfiguration} [config={}]
* @returns {embed.Embed}
*/
createReport(element: HTMLElement, config: embed.IEmbedConfiguration): embed.Embed {
config.type = 'create';
let powerBiElement = <IPowerBiElement>element;
const component = new Create(this, powerBiElement, config);
powerBiElement.powerBiEmbed = component;
this.addOrOverwriteEmbed(component, element);
return component;
}
/**
* TODO: Add a description here
*
* @param {HTMLElement} [container]
* @param {embed.IEmbedConfiguration} [config=undefined]
* @returns {embed.Embed[]}
*/
init(container?: HTMLElement, config: embed.IEmbedConfiguration = undefined): embed.Embed[] {
container = (container && container instanceof HTMLElement) ? container : document.body;
const elements = Array.prototype.slice.call(container.querySelectorAll(`[${embed.Embed.embedUrlAttribute}]`));
return elements.map(element => this.embed(element, config));
}
/**
* Given a configuration based on an HTML element,
* if the component has already been created and attached to the element, reuses the component instance and existing iframe,
* otherwise creates a new component instance.
*
* @param {HTMLElement} element
* @param {embed.IEmbedConfiguration} [config={}]
* @returns {embed.Embed}
*/
embed(element: HTMLElement, config: embed.IEmbedConfiguration = {}): embed.Embed {
let component: embed.Embed;
let powerBiElement = <IPowerBiElement>element;
if (powerBiElement.powerBiEmbed) {
component = this.embedExisting(powerBiElement, config);
}
else {
component = this.embedNew(powerBiElement, config);
}
return component;
}
/**
* Given a configuration based on a Power BI element, saves the component instance that reference the element for later lookup.
*
* @private
* @param {IPowerBiElement} element
* @param {embed.IEmbedConfiguration} config
* @returns {embed.Embed}
*/
private embedNew(element: IPowerBiElement, config: embed.IEmbedConfiguration): embed.Embed {
const componentType = config.type || element.getAttribute(embed.Embed.typeAttribute);
if (!componentType) {
throw new Error(`Attempted to embed using config ${JSON.stringify(config)} on element ${element.outerHTML}, but could not determine what type of component to embed. You must specify a type in the configuration or as an attribute such as '${embed.Embed.typeAttribute}="${Report.type.toLowerCase()}"'.`);
}
// Saves the type as part of the configuration so that it can be referenced later at a known location.
config.type = componentType;
const Component = utils.find(component => componentType === component.type.toLowerCase(), Service.components);
if (!Component) {
throw new Error(`Attempted to embed component of type: ${componentType} but did not find any matching component. Please verify the type you specified is intended.`);
}
const component = new Component(this, element, config);
element.powerBiEmbed = component;
this.addOrOverwriteEmbed(component, element);
return component;
}
/**
* Given an element that already contains an embed component, load with a new configuration.
*
* @private
* @param {IPowerBiElement} element
* @param {embed.IEmbedConfiguration} config
* @returns {embed.Embed}
*/
private embedExisting(element: IPowerBiElement, config: embed.IEmbedConfiguration): embed.Embed {
const component = utils.find(x => x.element === element, this.embeds);
if (!component) {
throw new Error(`Attempted to embed using config ${JSON.stringify(config)} on element ${element.outerHTML} which already has embedded comopnent associated, but could not find the existing comopnent in the list of active components. This could indicate the embeds list is out of sync with the DOM, or the component is referencing the incorrect HTML element.`);
}
/**
* TODO: Dynamic embed type switching could be supported but there is work needed to prepare the service state and DOM cleanup.
* remove all event handlers from the DOM, then reset the element to initial state which removes iframe, and removes from list of embeds
* then we can call the embedNew function which would allow setting the proper embedUrl and construction of object based on the new type.
*/
if (typeof config.type === "string" && config.type !== component.config.type) {
/**
* When loading report after create we want to use existing Iframe to optimize load period
*/
if(config.type === "report" && component.config.type === "create") {
const report = new Report(this, element, config, element.powerBiEmbed.iframe);
report.load(<embed.IInternalEmbedConfiguration>config);
element.powerBiEmbed = report;
this.addOrOverwriteEmbed(component, element);
return report;
}
throw new Error(`Embedding on an existing element with a different type than the previous embed object is not supported. Attempted to embed using config ${JSON.stringify(config)} on element ${element.outerHTML}, but the existing element contains an embed of type: ${this.config.type} which does not match the new type: ${config.type}`);
}
component.load(<embed.IInternalEmbedConfiguration>config);
return component;
}
/**
* Adds an event handler for DOMContentLoaded, which searches the DOM for elements that have the 'powerbi-embed-url' attribute,
* and automatically attempts to embed a powerbi component based on information from other powerbi-* attributes.
*
* Note: Only runs if `config.autoEmbedOnContentLoaded` is true when the service is created.
* This handler is typically useful only for applications that are rendered on the server so that all required data is available when the handler is called.
*/
enableAutoEmbed(): void {
window.addEventListener('DOMContentLoaded', (event: Event) => this.init(document.body), false);
}
/**
* Returns an instance of the component associated with the element.
*
* @param {HTMLElement} element
* @returns {(Report | Tile)}
*/
get(element: HTMLElement): Report | Tile | Dashboard {
const powerBiElement = <IPowerBiElement>element;
if (!powerBiElement.powerBiEmbed) {
throw new Error(`You attempted to get an instance of powerbi component associated with element: ${element.outerHTML} but there was no associated instance.`);
}
return powerBiElement.powerBiEmbed;
}
/**
* Finds an embed instance by the name or unique ID that is provided.
*
* @param {string} uniqueId
* @returns {(Report | Tile)}
*/
find(uniqueId: string): Report | Tile | Dashboard {
return utils.find(x => x.config.uniqueId === uniqueId, this.embeds);
}
addOrOverwriteEmbed(component: embed.Embed, element: HTMLElement): void {
// remove embeds over the same div element.
this.embeds = this.embeds.filter(function(embed) {
return embed.element.id !== element.id;
});
this.embeds.push(component);
}
/**
* Given an HTML element that has a component embedded within it, removes the component from the list of embedded components, removes the association between the element and the component, and removes the iframe.
*
* @param {HTMLElement} element
* @returns {void}
*/
reset(element: HTMLElement): void {
const powerBiElement = <IPowerBiElement>element;
if (!powerBiElement.powerBiEmbed) {
return;
}
/** Removes the component from an internal list of components. */
utils.remove(x => x === powerBiElement.powerBiEmbed, this.embeds);
/** Deletes a property from the HTML element. */
delete powerBiElement.powerBiEmbed;
/** Removes the iframe from the element. */
const iframe = element.querySelector('iframe');
if (iframe) {
if(iframe.remove !== undefined) {
iframe.remove();
}
else {
/** Workaround for IE: unhandled rejection TypeError: object doesn't support propert or method 'remove' */
iframe.parentElement.removeChild(iframe);
}
}
}
/**
* Given an event object, finds the embed component with the matching type and ID, and invokes its handleEvent method with the event object.
*
* @private
* @param {IEvent<any>} event
*/
private handleEvent(event: IEvent<any>): void {
const embed = utils.find(embed => {
return (embed.config.uniqueId === event.id);
}, this.embeds);
if (embed) {
const value = event.value;
if (event.name === 'pageChanged') {
const pageKey = 'newPage';
const page: models.IPage = value[pageKey];
if (!page) {
throw new Error(`Page model not found at 'event.value.${pageKey}'.`);
}
value[pageKey] = new Page(embed, page.name, page.displayName);
}
utils.raiseCustomEvent(embed.element, event.name, value);
}
}
}
You can’t perform that action at this time.