feat: add tutorial types for find, compare, completeness and validate

Author: tnagorra

functions/definition/tutorial/common.yaml

@@ -0,0 +1,119 @@
+FbEnumInformationPageBlockType:
+  model: alias
+  type:
+    type: enum
+    members:
+      - label: 'TEXT'
+        value: 'text'
+      - label: 'IMAGE'
+        value: 'image'
+
+FbInformationPageBlock:
+  model: alias
+  type:
+    type: object
+    fields:
+      blockNumber:
+        type: int
+      blockType:
+        type: FbEnumInformationPageBlockType
+      textDescription: # NOTE: required if type is TEXT
+        type: string
+        optional: true
+      image: # NOTE: required if tyoe is IMAGE
+        type: string
+        optional: true
+
+FbInformationPage:
+  model: alias
+  type:
+    type: object
+    fields:
+      pageNumber:
+        type: int
+      title:
+        type: string
+      blocks:
+        type:
+          type: list
+          elementType: FbInformationPageBlock
+
+FbScreenBlock:
+  model: alias
+  type:
+    type: object
+    fields:
+      title:
+        type: string
+      description:
+        type: string
+      # FIXME: Do we add enum here?
+      icon:
+        type: string
+
+FbScreen:
+  model: alias
+  type:
+    type: object
+    fields:
+      hint:
+        type: FbScreenBlock
+      instructions:
+        type: FbScreenBlock
+      success:
+        type: FbScreenBlock
+
+FbBaseTutorial:
+  model: alias
+  type:
+    type: object
+    fields:
+      # deprecated
+      exampleImage1:
+        type: string
+        optional: true
+      exampleImage2:
+        type: string
+        optional: true
+      contributorCount: # NOTE: intially zero
+        type: int
+      informationPages:
+        type:
+          type: list
+          elementType: FbInformationPage
+      lookFor:
+        type: string
+      name:
+        type: string
+      progress:
+        type: int
+      projectDetails:
+        type: string
+      projectId:
+        type: string
+      projectTopicKey: # NOTE: deprecated
+        type: string
+      status:
+        type:
+          type: literal
+          value: tutorial
+      tutorialDraftId: # NOTE: deprecated
+        type: string
+
+FbBaseTutorialGroup:
+  model: alias
+  type:
+    type: object
+    fields:
+      finishedCount: # NOTE: initially zero
+        type: int
+      groupId: # NOTE: initially 101
+        type: int
+      numberOfTasks:
+        type: int
+      progress: # NOTE: initially zero
+        type: int
+      projectId:
+        type: string
+      requiredCount: # NOTE: always 5?
+        type: int

functions/definition/tutorial/compare.yaml

@@ -0,0 +1,61 @@
+FbCompareTutorial:
+  model: alias
+  type:
+    type: object
+    fields:
+      projectType:
+        type:
+          type: literal
+          value: 3
+      tileServer:
+        type: FbObjRasterTileServer
+      tileServerB:
+        type: FbObjRasterTileServer
+      zoomLevel:
+        type: int
+      screens:
+        type:
+          type: list
+          elementType: FbScreen
+
+FbCompareTutorialGroup:
+  model: alias
+  type:
+    type: object
+    fields:
+      xMax:
+        type: int
+      xMin:
+        type: int
+      yMax:
+        type: int
+      yMin:
+        type: int
+
+FbCompareTutorialTask:
+  model: alias
+  type:
+    type: object
+    fields:
+      geometry: # NOTE: initially empty string
+        type: string
+      groupId:
+        type: int
+      projectId:
+        type: string
+      referenceAnswer:
+        type: int
+      screen:
+        type: int
+      taskId:
+        type: string
+      taskId_real:
+        type: string
+      taskX:
+        type: int
+      taskY:
+        type: int
+      url:
+        type: string
+      urlB:
+        type: string

functions/definition/tutorial/completeness.yaml

@@ -0,0 +1,63 @@
+FbCompletenessTutorial:
+  model: alias
+  type:
+    type: object
+    fields:
+      projectType:
+        type:
+          type: literal
+          value: 4
+      tileServer:
+        type: FbObjRasterTileServer
+      tileServerB:
+        type: FbObjRasterTileServer
+      overlayTileServer:
+        type: FbObjUnifiedOverlayTileServer
+      zoomLevel:
+        type: int
+      screens:
+        type:
+          type: list
+          elementType: FbScreen
+
+FbCompletenessTutorialGroup:
+  model: alias
+  type:
+    type: object
+    fields:
+      xMax:
+        type: int
+      xMin:
+        type: int
+      yMax:
+        type: int
+      yMin:
+        type: int
+
+FbCompletenessTutorialTask:
+  model: alias
+  type:
+    type: object
+    fields:
+      geometry: # NOTE: initially empty string
+        type: string
+      groupId:
+        type: int
+      projectId:
+        type: string
+      referenceAnswer:
+        type: int
+      screen:
+        type: int
+      taskId:
+        type: string
+      taskId_real:
+        type: string
+      taskX:
+        type: int
+      taskY:
+        type: int
+      url:
+        type: string
+      urlB:
+        type: string

functions/definition/tutorial/find.yaml

@@ -0,0 +1,57 @@
+FbFindTutorial:
+  model: alias
+  type:
+    type: object
+    fields:
+      projectType:
+        type:
+          type: literal
+          value: 1
+      tileServer:
+        type: FbObjRasterTileServer
+      zoomLevel:
+        type: int
+      screens:
+        type:
+          type: list
+          elementType: FbScreen
+
+FbFindTutorialGroup:
+  model: alias
+  type:
+    type: object
+    fields:
+      xMax:
+        type: int
+      xMin:
+        type: int
+      yMax:
+        type: int
+      yMin:
+        type: int
+
+FbFindTutorialTask:
+  model: alias
+  type:
+    type: object
+    fields:
+      geometry: # NOTE: initially empty string
+        type: string
+      groupId:
+        type: int
+      projectId:
+        type: string
+      referenceAnswer:
+        type: int
+      screen:
+        type: int
+      taskId:
+        type: string
+      taskId_real:
+        type: string
+      taskX:
+        type: int
+      taskY:
+        type: int
+      url:
+        type: string

functions/definition/tutorial/validate.yaml

@@ -0,0 +1,56 @@
+FbValidateTutorial:
+  model: alias
+  type:
+    type: object
+    fields:
+      inputGeometries: # NOTE: local path to geometry file
+        type: string
+      projectType:
+        type:
+          type: literal
+          value: 2
+      tileServer:
+        type: FbObjRasterTileServer
+      zoomLevel:
+        type: int
+      screens:
+        type:
+          type: list
+          elementType: FbScreen
+      customOptions:
+        # optional: true
+        type:
+          type: list
+          elementType: FbObjCustomOption
+
+FbValidateTutorialTaskProperties:
+  model: alias
+  type:
+    type: object
+    fields:
+      building:
+        type: string
+      description:
+        type: string
+      reference:
+        type: string # NOTE: not sure if this is int or string
+      screen:
+        type: string # NOTE: not sure if this is int or string
+
+FbValidateTutorialTask:
+  model: alias
+  type:
+    type: object
+    fields:
+      taskId:
+        type: string
+      geojson: # NOTE: polygon geometry object
+        type: unknown
+      properties:
+        type: FbValidateTutorialTaskProperties
+      screen:
+        type: int
+      reference:
+        type: int
+      geometry: # NOTE: geometry as WKT
+        type: string