@c8y/options 1021.22.141 → 1021.22.145

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.
Files changed (2) hide show
  1. package/package.json +2 -2
  2. package/src/ApplicationOptions.d.ts +5 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@c8y/options",
3
- "version": "1021.22.141",
3
+ "version": "1021.22.145",
4
4
  "license": "Apache-2.0",
5
5
  "author": "Cumulocity",
6
6
  "description": "Cumulocity application options",
@@ -17,6 +17,6 @@
17
17
  "options"
18
18
  ],
19
19
  "peerDependencies": {
20
- "@c8y/client": "1021.22.141"
20
+ "@c8y/client": "1021.22.145"
21
21
  }
22
22
  }
package/src/ApplicationOptions.d.ts CHANGED
@@ -36,13 +36,13 @@ export interface ApplicationOptions {
36
36
  * If set to `false`, no dynamic options will be fetched.
37
37
  * */
38
38
  dynamicOptionsUrl?: string | boolean;
39
- /** URL to favicon. */
39
+ /** URL to favicon. Will be ignored for security reasons if provided as a URL query parameter. */
40
40
  faviconUrl?: string;
41
- /** URL to *.css file which will replace default branding. */
41
+ /** URL to `*.css` file which will replace default branding. Will be ignored for security reasons if provided as a URL query parameter. */
42
42
  brandingUrl?: string;
43
43
  /** Enables the branding preview mode. If set to true, the `dynamicOptionsUrl` will be polled regularly for changes. In case the `lastUpdated` field of the dynamic options changes, the page is reloaded in order to apply the new branding. */
44
44
  brandingPreview?: boolean;
45
- /** Object with properties that will be converted to CSS custom variables. */
45
+ /** Object with properties that will be converted to CSS custom variables. Will be ignored for security reasons if provided as a URL query parameter. */
46
46
  brandingCssVars?: BrandingCssVars;
47
47
  /**
48
48
  * Allows for adding or overriding languages available in the application.
@@ -85,9 +85,9 @@ export interface ApplicationOptions {
85
85
  * ```
86
86
  */
87
87
  i18nExtra?: I18nExtra;
88
- /** Array of URLs to additional *.css files to be loaded at runtime. */
88
+ /** Array of URLs to additional `*.css` files to be loaded at runtime. Will be ignored for security reasons if provided as a URL query parameter. */
89
89
  extraCssUrls?: string[];
90
- /** Stylesheet (CSS) that will be added at runtime. The string should actually contain the CSS not a path or URL to it. */
90
+ /** Stylesheet (CSS) that will be added at runtime. The string should actually contain the CSS not a path or URL to it. Will be ignored for security reasons if provided as a URL query parameter. */
91
91
  extraCss?: string;
92
92
  /** Documentation links settings. */
93
93
  docs?: Docs;