@ms-cloudpack/common-types-browser 0.6.1 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +9 -3
- package/package.json +2 -1
package/index.d.ts
CHANGED
|
@@ -19,6 +19,7 @@ export interface DefineFlags {
|
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
/** Client-side context object for a Cloudpack session, used for API requests and telemetry. */
|
|
22
|
+
// `| undefined` is used for optional properties to ensure they're set when creating the context.
|
|
22
23
|
export interface PageSessionContext {
|
|
23
24
|
/** UUID for the current session */
|
|
24
25
|
sessionId: string;
|
|
@@ -31,11 +32,16 @@ export interface PageSessionContext {
|
|
|
31
32
|
/** Requested URL */
|
|
32
33
|
requestPath: string;
|
|
33
34
|
/** Cloudpack will query this performance entry to determine the page load time. */
|
|
34
|
-
pageLoadTimePerformanceEntry
|
|
35
|
+
pageLoadTimePerformanceEntry: PageLoadTimePerformanceEntry | undefined;
|
|
35
36
|
/** Variables that will be defined on the window object */
|
|
36
|
-
define
|
|
37
|
+
define: DefineFlags | undefined;
|
|
37
38
|
/** Host API server URLs for linking */
|
|
38
|
-
hostApiServerUrls
|
|
39
|
+
hostApiServerUrls: string[] | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* Whether to show the Cloudpack overlay (status badge and dialog) in the app UI.
|
|
42
|
+
* @default 'always'
|
|
43
|
+
*/
|
|
44
|
+
showOverlay: 'always' | 'errors-only' | 'never' | undefined;
|
|
39
45
|
}
|
|
40
46
|
|
|
41
47
|
/**
|
package/package.json
CHANGED