@luzmo/dashboard-contents-types 1.0.3 → 1.0.4

package/assets/json-schemas/text.schema.json.d.ts

@@ -1,6 +1,6 @@
 declare const _default: {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/text.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/text.schema.json",
     "type": "object",
     "description": "Text item",
     "properties": {
@@ -11,7 +11,7 @@ declare const _default: {
         },
         "options": {
             "description": "Options of the Text item",
-            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/text-options.schema.json"
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/text-options.schema.json"
         }
     }
 };

package/assets/json-schemas/video-options.schema.json.d.ts

@@ -0,0 +1,318 @@
+declare const _default: {
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/video-options.schema.json",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "properties": {
+        "autoHide": {
+            "default": true,
+            "description": "Auto-hide the controls",
+            "type": "boolean"
+        },
+        "autoPlay": {
+            "default": false,
+            "description": "Autoplay the video when the page loads",
+            "type": "boolean"
+        },
+        "backdropColor": {
+            "default": "#000000",
+            "description": "Backdrop color of the video",
+            "type": "string"
+        },
+        "loader": {
+            "description": "The loader configuration",
+            "properties": {
+                "background": {
+                    "default": "#f9f9f9",
+                    "description": "Background color of the chart loader element",
+                    "type": "string"
+                },
+                "fontColor": {
+                    "default": "#5a5a5a",
+                    "description": "Font color of the text of the chart loaders",
+                    "type": "string"
+                },
+                "locale": {
+                    "default": "en",
+                    "description": "Locale to be used if \"msg\" is set",
+                    "examples": [
+                        "en",
+                        "fr"
+                    ],
+                    "type": "string"
+                },
+                "mode": {
+                    "default": "light",
+                    "description": "Light or dark loader",
+                    "type": "string"
+                },
+                "msg": {
+                    "description": "Loading message",
+                    "examples": [
+                        "Loading dashboard..."
+                    ],
+                    "type": "string"
+                },
+                "showBranded": {
+                    "default": false,
+                    "description": "Shows the branded \"powered by\" information",
+                    "type": "boolean"
+                },
+                "spinnerBackground": {
+                    "default": "rgba(169, 169, 169, 0.14)",
+                    "description": "Background color of the spinner",
+                    "type": "string"
+                },
+                "spinnerColor": {
+                    "default": "rgba(255, 165, 0, 0.7)",
+                    "description": "Spinner color of the loader",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "locale": {
+            "default": "en",
+            "description": "Locale to be used",
+            "examples": [
+                "en",
+                "fr"
+            ],
+            "type": "string"
+        },
+        "lookupFiltering": {
+            "default": false,
+            "description": "Allow interactive filtering of charts with linked datasets",
+            "type": "boolean"
+        },
+        "loop": {
+            "default": false,
+            "description": "Whether to loop the video",
+            "type": "boolean"
+        },
+        "poster": {
+            "description": "Whether to show a placeholder poster, clicking on the object will play the video",
+            "properties": {
+                "show": {
+                    "default": false,
+                    "description": "Show or hide the poster",
+                    "type": "boolean"
+                },
+                "url": {
+                    "default": "",
+                    "description": "URL of the poster to show, url to a png, jpeg file",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "showControls": {
+            "default": true,
+            "description": "To hide or show controls",
+            "type": "boolean"
+        },
+        "sources": {
+            "default": "{ \"en\" : [{ \"src\": \"https://cdn.luzmo.com/luzmo_overview.mp4\", type: \"video/mp4\" }] }",
+            "description": "Use sources, if you wish to embed a video from web links.\nA key-value object, where the value is a list of objects with \"src\" property.\nA Key is a locale, a value is the video source.",
+            "type": "object"
+        },
+        "theme": {
+            "description": "Theme configuration",
+            "properties": {
+                "borders": {
+                    "description": "Custom border styling",
+                    "properties": {
+                        "border-bottom-width": {
+                            "description": "Border bottom width",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-color": {
+                            "description": "Border color",
+                            "examples": [
+                                "rgba(216, 216, 216, 1)",
+                                "rgb(147, 146, 148)"
+                            ],
+                            "type": "string"
+                        },
+                        "border-left-width": {
+                            "description": "Border left width",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-radius": {
+                            "description": "Border radius",
+                            "examples": [
+                                "0",
+                                "12px",
+                                "20px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-right-width": {
+                            "description": "Border right width",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        },
+                        "border-style": {
+                            "description": "Border style",
+                            "examples": [
+                                "none",
+                                "solid",
+                                "dotted",
+                                "dashed"
+                            ],
+                            "type": "string"
+                        },
+                        "border-top-width": {
+                            "description": "Border top width",
+                            "examples": [
+                                "0px",
+                                "1px",
+                                "3px"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
+                "boxShadow": {
+                    "description": "Custom shadow styling",
+                    "properties": {
+                        "color": {
+                            "description": "Shadow color",
+                            "examples": [
+                                "rgb(0, 0, 0)",
+                                "rgb(100, 100, 103)"
+                            ],
+                            "type": "string"
+                        },
+                        "size": {
+                            "description": "Shadow size",
+                            "enum": [
+                                "L",
+                                "M",
+                                "S",
+                                "none"
+                            ],
+                            "examples": [
+                                "none",
+                                "S",
+                                "M",
+                                "L"
+                            ],
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
+                "font": {
+                    "description": "Custom font styling",
+                    "properties": {
+                        "font-style": {
+                            "const": "normal",
+                            "description": "Use it to reset the font style to \"normal\"",
+                            "type": "string"
+                        },
+                        "font-weight": {
+                            "description": "Font weight",
+                            "examples": [
+                                400,
+                                700
+                            ],
+                            "type": "number"
+                        },
+                        "fontFamily": {
+                            "description": "Font family",
+                            "examples": [
+                                "Lato",
+                                "Montserrat",
+                                "Roboto Mono",
+                                "Arial",
+                                "Times New Roman"
+                            ],
+                            "type": "string"
+                        },
+                        "fontSize": {
+                            "description": "Font size in px",
+                            "examples": [
+                                10,
+                                15,
+                                18
+                            ],
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
+                "id": {
+                    "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
+                    "examples": [
+                        "seasonal",
+                        "urban"
+                    ],
+                    "type": "string"
+                },
+                "itemsBackground": {
+                    "description": "Custom item background color",
+                    "examples": [
+                        "rgb(255, 255, 255)",
+                        "rgb(71, 69, 69)",
+                        "rgb(195, 191, 191)"
+                    ],
+                    "type": "string"
+                },
+                "type": {
+                    "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
+                    "examples": [
+                        "custom"
+                    ],
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "timezoneId": {
+            "description": "The timezone that will be used in the dashboard. This timezone id needs to be a valid id that is available in the IANA timezone database",
+            "examples": [
+                "Europe/Brussels",
+                "America/New_York"
+            ],
+            "type": "string"
+        },
+        "type": {
+            "description": "Whether the URL is a YouTube or web link",
+            "enum": [
+                "web",
+                "youtube"
+            ],
+            "type": "string"
+        },
+        "youtube": {
+            "default": {
+                "en": [
+                    {
+                        "src": "youtube_url"
+                    }
+                ]
+            },
+            "description": "A key-value object, where the value is a list of objects with \"src\" property.\nuse YouTube, if you wish to embed a YouTube video",
+            "type": "object"
+        }
+    },
+    "type": "object"
+}
+
+;
+
+export default _default;

package/assets/json-schemas/video.schema.json.d.ts

@@ -0,0 +1,19 @@
+declare const _default: {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/video.schema.json",
+    "type": "object",
+    "description": "Video item",
+    "properties": {
+        "type": {
+            "description": "Type of the item",
+            "type": "string",
+            "const": "video"
+        },
+        "options": {
+            "description": "Options of the Video item",
+            "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.90/video-options.schema.json"
+        }
+    }
+};
+
+export default _default;

package/assets/json-schemas/viz-item-type.schema.json.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.89/viz-item-type.schema.json",
+    "$id": "https://developer.luzmo.com/assets/json-schemas/0.1.90/viz-item-type.schema.json",
     "$schema": "http://json-schema.org/draft-07/schema#",
     "enum": [
         "area-chart",