@c8y/options 1022.10.1 → 1022.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@c8y/options",
-  "version": "1022.10.1",
+  "version": "1022.13.0",
   "license": "Apache-2.0",
   "author": "Cumulocity",
   "description": "Cumulocity application options",
@@ -17,6 +17,6 @@
     "options"
   ],
   "peerDependencies": {
-    "@c8y/client": "1022.10.1"
+    "@c8y/client": "1022.13.0"
   }
 }

package/src/ApplicationOptions.d.ts

@@ -46,7 +46,7 @@ export interface ApplicationOptions {
   dynamicOptionsUrl?: string | boolean;
   /** URL to favicon. */
   faviconUrl?: string;
-  /** URL to *.css file which will replace default branding. */
+  /** URL to `*.css` file which will replace default branding. */
   brandingUrl?: string;
   /** 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. */
   brandingPreview?: boolean;
@@ -57,12 +57,11 @@ export interface ApplicationOptions {
    *
    * Its keys are language codes and its values are objects with the following properties:
    *
-   * - `name`: English name of the language,
-   * - `nativeName`: native name of the language,
-   * - `url`: full URL to JSON file with compiled translations;
-   *    if not defined, translations will be loaded from `${localePath}/${langCode}.json`.
+   * - **name:** English name of the language,
+   * - **nativeName:** native name of the language,
+   * - **url:** full URL to JSON file with compiled translations;
+   *    if not defined, translations will be loaded from `${localePath}/${langCode}.json.
    *
-   * Example:
    * ```json
    * "languages": {
    *   "de": {
@@ -80,7 +79,7 @@ export interface ApplicationOptions {
    * Its keys are language codes (https://cumulocity.com/docs/section/getting_started/#a-name-languages-a-available-languages)
    * and its values are objects with key-value pairs, where the key is the original string in English and the value - its translation.
    *
-   * - `Home`: "Startseite"
+   * - **Home:** "Startseite"
    *
    * For example, you can add the translation of your custom cookie banner configured in the branding settings:
    * ```json
@@ -93,7 +92,7 @@ export interface ApplicationOptions {
    * ```
    */
   i18nExtra?: I18nExtra;
-  /** Array of URLs to additional *.css files to be loaded at runtime. */
+  /** Array of URLs to additional `*.css` files to be loaded at runtime. */
   extraCssUrls?: string[];
   /** Stylesheet (CSS) that will be added at runtime. The string should actually contain the CSS not a path or URL to it. */
   extraCss?: string;
@@ -277,8 +276,8 @@ export interface ApplicationOptions {
   /**
    * Defines the type of refresh mechanism used for alarms in the application.
    *
-   * - 'realtime': Utilizes a realtime mechanism for updating alarms.
-   * - 'interval': Utilizes HTTP polling at regular intervals to refresh the alarms.
+   * - **realtime:** Utilizes a realtime mechanism for updating alarms.
+   * - **interval:** Utilizes HTTP polling at regular intervals to refresh the alarms.
    *
    * This setting allows to switch between realtime and interval-based refresh methods.
    */
@@ -289,7 +288,16 @@ export interface ApplicationOptions {
    * (e.g. in the HTML-Widget). The keys are the import paths and the values are the URLs.
    *
    * You can also add a js file but need to copy it. Or you can add a node module name but
-   * this need to have a single entry point. Otherwise you need to copy the files.
+   * this need to have a single entry point. Otherwise you need to copy the files. A url can also
+   * be used but you need to ensure that the CSP rules are not blocking the loading of the file.
+   *
+   * ```
+   * {
+   *  'my-widget': 'https://example.com/path/to/widget.js',
+   *  'node-module': '@scope/my-node-module',
+   *  'local-js': './my-local-file.js'
+   * }
+   * ```
    */
   importMap?: {
     [key: string]: string;