@kalisio/kdk 2.6.2 → 2.6.3

package/client/schemas/capture.create.json

@@ -0,0 +1,132 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://www.kalisio.xyz/schemas/capture.create.json#",
+  "description": "Capture schema",
+  "type": "object",
+  "groups": {
+    "group-advanced-settings": {
+      "label": "schemas.CAPTURE_ADVANCED_SETTINGS"
+    }
+  },
+  "properties": {
+    "resolution": {
+      "type": "object", 
+      "label": "resolution",
+      "field": {
+        "component": "form/KResolutionField",
+        "label": "schemas.CAPTURE_RESOLUTION_FIELD_LABEL"
+      }
+    },
+    "format": {
+      "type": "string", 
+      "default": "png",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.CAPTURE_FORMAT_FIELD_LABEL",
+        "options": [
+          { "label": "schemas.CAPTURE_PNG_FORMAT_FIELD_LABEL", "value": "png" },
+          { "label": "schemas.CAPTURE_PDF_FORMAT_FIELD_LABEL", "value": "pdf" }
+        ]
+      }
+    },
+    "header": {
+      "type": ["string", "null"],
+      "maxLength": 200,
+      "toolbar": {
+        "xs": [
+          ["bold", "italic", "underline", "strike", "align"],
+          [{
+            "label": "",
+            "icon": "format_align_left",
+            "list": "only-icons",
+            "options": ["left", "center", "right"]
+          }],
+          ["undo", "redo"]
+        ],
+        "gt.xs": [
+          ["bold", "italic", "underline", "strike", "align"],
+          [{
+            "label": "",
+            "icon": "format_align_left",
+            "list": "only-icons",
+            "options": ["left", "center", "right"]
+          }],
+          ["undo", "redo"]
+        ]
+      },
+      "field": {
+        "component": "form/KTextareaField",
+        "label": "schemas.CAPTURE_HEADER_FIELD_LABEL"
+      }
+    },
+    "footer": {
+      "type": ["string", "null"],
+      "toolbar": {
+        "xs": [
+          ["bold", "italic", "underline", "strike", "align"],
+          [{
+            "label": "",
+            "icon": "format_align_left",
+            "list": "only-icons",
+            "options": ["left", "center", "right"]
+          }],
+          ["undo", "redo"]
+        ],
+        "gt.xs": [
+          ["bold", "italic", "underline", "strike", "align"],
+          [{
+            "label": "",
+            "icon": "format_align_left",
+            "list": "only-icons",
+            "options": ["left", "center", "right"]
+          }],
+          ["undo", "redo"]
+        ]
+      },
+      "field": {
+        "component": "form/KTextareaField",
+        "label": "schemas.CAPTURE_FOOTER_FIELD_LABEL"
+      }
+    },
+    "legend": {
+      "type": "string", 
+      "default": "none",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.CAPTURE_LEGEND_POSITION_FIELD_LABEL",
+        "options": [
+          { "label": "schemas.CAPTURE_NOT_DISPLAYED_FIELD_LABEL", "value": "none" },
+          { "label": "schemas.CAPTURE_LEFT_POSITION_FIELD_LABEL", "value": "left" },
+          { "label": "schemas.CAPTURE_RIGHT_POSITION_FIELD_LABEL", "value": "right" }
+        ]
+      }
+    },
+    "north": {
+      "type": "string", 
+      "default": "none",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.CAPTURE_COMPASS_POSITION_FIELD_LABEL",
+        "options": [
+          { "label": "schemas.CAPTURE_NOT_DISPLAYED_FIELD_LABEL", "value": "none" },
+          { "label": "schemas.CAPTURE_TOP_LEFT_POSITION_FIELD_LABEL", "value": "top-left" },
+          { "label": "schemas.CAPTURE_TOP_RIGHT_POSITION_FIELD_LABEL", "value": "top-right" }, 
+          { "label": "schemas.CAPTURE_BOTTOM_RIGHT_POSITION_FIELD_LABEL", "value": "bottom-right" }, 
+          { "label": "schemas.CAPTURE_BOTTOM_LEFT_POSITION_FIELD_LABEL", "value": "bottom-left" }
+        ]
+      }
+    },
+    "dateTime": {
+      "type": "object",
+      "group": "group-advanced-settings",
+      "default": { "start": "2023-11-17T23:00:00.000Z", "end": "2023-12-17T23:00:00.000Z"},
+      "field": {
+        "component": "form/KDateTimeRangeField",
+        "min": "2022-12-31T23:00:00.000Z",
+        "max": "2023-12-17T23:00:00.000Z",
+        "label": "schemas.CAPTURE_DATETIME_RANGE_FIELD_LABEL"
+      }
+    }
+  },
+  "required": ["resolution", "north", "legend", "format"]
+}

package/client/schemas/catalog.update.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://www.kalisio.xyz/schemas/catalog.update.json#",
+  "title": "schemas.OBJECT_NAME",
+  "description": "Layer edition schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string", 
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.CATALOG_NAME_FIELD_LABEL"
+      }
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 4096,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.CATALOG_DESCRIPTION_FIELD_LABEL"
+      }
+    },
+    "featureId": {
+      "type": ["string", "null"],
+      "maxLength": 256,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.CATALOG_FEATURE_ID_FIELD_LABEL"
+      }
+    },
+    "featureLabel": {
+      "type": ["string", "null"],
+      "maxLength": 256,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.CATALOG_FEATURE_LABEL_FIELD_LABEL"
+      }
+    }
+  },
+  "required": ["name"]
+}
+

package/client/schemas/messages.update.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/schemas/messages.edit.json",
+  "description": "Messages edition schema",
+  "type": "object",
+  "properties": {
+    "body": {
+      "type": "string",
+      "minLength": 1,
+      "field": {
+        "component": "form/KTextareaField"
+      }
+    }
+  },
+  "required": ["body"]
+}

package/client/schemas/projects.create.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://www.kalisio.xyz/schemas/projects.create.json#",
+  "title": "schemas.PROJECT_CREATE_TITLE",
+  "description": "Project creation schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.PROJECT_NAME_FIELD_LABEL"
+      }
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 2048,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.PROJECT_DESCRIPTION_FIELD_LABEL"
+      }
+    },
+    "layers": {
+      "type": "array",
+      "field": {
+        "component": "form/KSelectLayersField",
+        "label": "schemas.PROJECT_LAYERS_FIELD_LABEL"
+      }
+    },
+    "views": {
+      "type": "array",
+      "field": {
+        "component": "form/KSelectViewsField",
+        "label": "schemas.PROJECT_VIEWS_FIELD_LABEL"
+      }
+    },
+    "identifier": {
+      "type": ["string", "null"],
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.PROJECT_INDENTIFIER_FIELD_LABEL"
+      }
+    }
+  },
+  "required": [
+    "name", "layers"
+  ]
+}

package/client/schemas/projects.update.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://www.kalisio.xyz/schemas/projects.update.json#",
+  "title": "schemas.OBJECT_NAME",
+  "description": "Project edition schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.PROJECT_NAME_FIELD_LABEL"
+      }
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 2048,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.PROJECT_DESCRIPTION_FIELD_LABEL"
+      }
+    },
+    "layers": {
+      "type": "array",
+      "field": {
+        "component": "form/KSelectLayersField",
+        "label": "schemas.PROJECT_LAYERS_FIELD_LABEL"
+      }
+    },
+    "views": {
+      "type": "array",
+      "field": {
+        "component": "form/KSelectViewsField",
+        "label": "schemas.PROJECT_VIEWS_FIELD_LABEL"
+      }
+    },
+    "identifier": {
+      "type": ["string", "null"],
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.PROJECT_INDENTIFIER_FIELD_LABEL"
+      }
+    }
+  },
+  "required": [
+    "name", "layers"
+  ]
+}

package/client/schemas/settings.update.json

@@ -0,0 +1,286 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://www.kalisio.xyz/schemas/settings.update.json#",
+  "title": "schemas.UPDATE_SETTINGS_TITLE",
+  "type": "object",
+  "groups": {
+    "group-time": { "label": "schemas.TIME_FORMAT_SETTINGS" },
+    "group-timeline": { "label": "schemas.TIMELINE_SETTINGS" },
+    "group-timeseries": { "label": "schemas.TIMESERIES_SETTINGS" },
+    "group-map": { "label": "schemas.MAP_SETTINGS" },
+    "group-units": { "label": "schemas.UNITS_SETTINGS" },
+    "group-notation": { "label": "schemas.NOTATION_SETTINGS" }
+  },
+  "properties": {
+    "shortTime": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.TIME_FORMAT_SHORT_TIME_FIELD_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://momentjs.com/docs/#/displaying/format/" }
+      }
+    },
+    "longTime": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.TIME_FORMAT_LONG_TIME_FIELD_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://momentjs.com/docs/#/displaying/format/" }
+      }
+    },
+    "shortDate": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.TIME_FORMAT_SHORT_DATE_FIELD_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://momentjs.com/docs/#/displaying/format/" }
+
+      }
+    },
+    "longDate": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.TIME_FORMAT_LONG_DATE_FIELD_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://momentjs.com/docs/#/displaying/format/" }
+      }
+    },
+    "shortYear": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.TIME_FORMAT_SHORT_YEAR_FIELD_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://momentjs.com/docs/#/displaying/format/" }
+      }
+    },
+    "longYear": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.TIME_FORMAT_LONG_YEAR_FIELD_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://momentjs.com/docs/#/displaying/format/" }
+      }
+    },
+    "timezone": {
+      "type": "string",
+      "group": "group-time",
+      "field": {
+        "component": "form/KTimezoneField",
+        "label": "schemas.TIME_FORMAT_TIMEZONE_FIELD_LABEL"
+      }
+    },
+    "timelineStep": {
+      "type": "number",
+      "group": "group-timeline",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.TIMELINE_STEP",        
+        "options": [
+          { "label": "5m", "value": 5  },
+          { "label": "10m", "value": 10 },
+          { "label": "12m", "value": 12 },
+          { "label": "15m", "value": 15 },
+          { "label": "20m", "value": 20 },
+          { "label": "30m", "value": 30 },
+          { "label": "1H", "value": 60, "selected": true },
+          { "label": "3H", "value": 180 },
+          { "label": "6H", "value": 360 },
+          { "label": "12H", "value": 720 },
+          { "label": "24H", "value": 1440 }
+        ],
+        "clearable": false
+      }
+    },
+    "timelineInterval": {
+      "type": "number",
+      "group": "group-timeline",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.TIMELINE_INTERVAL",        
+        "options": [
+          { "label": "10s", "value": 10  },
+          { "label": "30s", "value": 30  },
+          { "label": "1m", "value": 60, "selected": true },
+          { "label": "5m", "value": 300 },
+          { "label": "10m", "value": 600 },
+          { "label": "15m", "value": 900 },
+          { "label": "30m", "value": 1800 }
+        ],
+        "clearable": false
+      }
+    },
+    "timeseriesSpan": {
+      "type": "number",
+      "group": "group-timeseries",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.TIMESERIES_SPAN",      
+        "options": [
+          { "label": "3H", "value": 180 },
+          { "label": "6H", "value": 360 },
+          { "label": "12H", "value": 720 },
+          { "label": "24H", "value": 1440, "selected": true },
+          { "label": "48H", "value": 2880 },
+          { "label": "72H", "value": 4320 },
+          { "label": "96H", "value": 5760 }
+        ],
+        "clearable": false
+      }
+    },
+    "timeseriesGroupBy": {
+      "type": "string",
+      "group": "group-timeseries",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.TIMESERIES_GROUP_BY",
+        "options": [
+          { "label": "schemas.TIMESERIES_GROUP_BY_VARIABLE", "value": "variable" },
+          { "label": "schemas.TIMESERIES_GROUP_BY_FEATURE", "value": "feature", "selected": true }
+        ],
+        "clearable": false
+      }
+    },
+    "restoreView": {
+      "type": "boolean",
+      "group": "group-map",
+      "field": {
+        "component": "form/KToggleField",
+        "label": "schemas.RESTORE_VIEW_FIELD_LABEL"
+      }
+    },
+    "restoreLayers": {
+      "type": "boolean",
+      "group": "group-map",
+      "field": {
+        "component": "form/KToggleField",
+        "label": "schemas.RESTORE_LAYERS_FIELD_LABEL"
+      }
+    },
+    "location": {
+      "type": "string",
+      "group": "group-map",
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.LOCATION_FORMAT_LABEL",
+        "helper": { "icon": "las la-question-circle", "url": "https://github.com/nerik/formatcoords#formatting" }
+      }
+    },
+    "navigator": {
+      "type": "string",
+      "group": "group-map",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.NAVIGATOR_APP_LABEL",
+        "options": [
+          { "label": "Waze", "value": "waze" },
+          { "label": "Google Maps", "value": "google-maps" },
+          { "label": "Apple Plan", "value": "apple-plan" }
+        ],
+        "clearable": false
+      }
+    },
+    "defaultLength": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.LENGTH_FIELD_LABEL",
+        "quantity": "length"
+      }
+    },
+    "defaultAltitude": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.ALTITUDE_FIELD_LABEL",
+        "quantity": "altitude"
+      }
+    },
+    "defaultArea": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.AREA_FIELD_LABEL",
+        "quantity": "area"
+      }
+    },
+    "defaultVelocity": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.VELOCITY_FIELD_LABEL",
+        "quantity": "velocity"
+      }
+    },
+    "defaultTemperature": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.TEMPERATURE_FIELD_LABEL",
+        "quantity": "temperature"
+      }
+    },
+    "defaultAngle": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.ANGLE_FIELD_LABEL",
+        "quantity": "angle"
+      }
+    },
+    "defaultEquivalentDoseRate": {
+      "type": "string",
+      "group": "group-units",
+      "field": {
+        "component": "form/KUnitField",
+        "label": "schemas.EQUIVALENT_DOSE_RATE_FIELD_LABEL",
+        "quantity": "equivalentDoseRate"
+      }
+    },
+    "defaultNotation": {
+      "type": "string",
+      "group": "group-notation",
+      "field": {
+        "component": "form/KSelectField",
+        "label": "schemas.NOTATION_FIELD_LABEL",
+        "options": [
+          { "label": "schemas.AUTO_NOTATION_FIELD_LABEL", "value": "auto", "selected": true },
+          { "label": "schemas.FIXED_NOTATION_FIELD_LABEL", "value": "fixed" },
+          { "label": "schemas.EXPONENTIAL_NOTATION_FIELD_LABEL", "value": "exponential" }
+        ],
+        "clearable": false
+      }
+    },
+    "defaultPrecision": {
+      "type": "number",
+      "group": "group-notation",
+      "minimum": 0,
+      "maximum": 6,
+      "field": {
+        "component": "form/KNumberField",
+        "label": "schemas.PRECISION_FIELD_LABEL"
+      }
+    }
+  },
+  "required": [
+    "shortTime",
+    "longTime",
+    "shortDate",
+    "longDate",
+    "shortYear",
+    "longYear",
+    "timezone",
+    "location"
+  ]
+}

package/client/schemas/tags.update.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://kalisio.xyz/schemas/tags.update.json#",
+  "title": "schemas.OBJECT_NAME",
+  "description": "Tags update schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string", 
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "KTagManager.TAG_NAME"
+      }
+    },
+    "description": { 
+      "type": ["string", "null"],
+      "field": {
+        "component": "form/KTextField",
+        "label": "KTagManager.TAG_DESCRIPTION"
+      }
+    },
+    "color": {
+      "type": "string",
+      "default": "grey-3",
+      "field": {
+        "component": "form/KColorField",
+        "label": "KTagManager.TAG_COLOR",
+        "clearable": false
+      }
+    }
+  },
+  "required": ["name", "color"]
+}

package/client/schemas/users.update-profile.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://kalisio.xyz/schemas/users.update-profile.json#",
+  "title": "schemas.OBJECT_NAME",
+  "description": "User profile",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string", 
+      "maxLength": 128,
+      "minLength": 3,
+      "field": {
+        "component": "form/KTextField",
+        "label": "schemas.NAME_FIELD_LABEL"
+      }
+    },
+    "avatar": { 
+      "type": "object",
+      "field": {
+        "component": "form/KFileField",
+        "label": "schemas.AVATAR_FIELD_LABEL",
+        "mimeTypes": ".png,.jpg,.jpeg,.webp",
+        "maxFileSize": 524288,
+        "readContent": false,
+        "storage": {
+          "path": "avatars/<%= _id %>",
+          "context": "global"
+        }
+      }
+    }
+  },
+  "required": ["name"]
+}
+