Merge branch 'main' into feature/edot

.github/workflows/generate.yml

@@ -22,7 +22,7 @@ jobs:
         npm run generate
     - name: Upload generated schemas
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: schemas
         path: |

file-formats/rvbc/README.md

@@ -0,0 +1,5 @@
+# RVBC File Format
+
+File | Cardinality | Definition | Schema | Example
+:--- | :--- | :--- | :--- | :---
+`<name>.rvbc.json` | 1 | [`zif_aff_rvbc_v1.intf.abap`](./type/zif_aff_rvbc_v1.intf.abap) | [`rvbc-v1.json`](./rvbc-v1.json) | [`z_aff_example_rvbc.rvbc.json`]

file-formats/rvbc/examples/z_aff_example_rvbc.rvbc.json

@@ -0,0 +1,17 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "Example RVBC for ABAP File Formats",
+    "originalLanguage": "en"
+  },
+  "bookletDefinition": {
+    "source": "predefined",
+    "status": "draft",
+    "application": "test.app.adt.editor",
+    "extensibilityMode": "supportedPredefinedQueries"
+  },
+  "ina1Services": {
+    "predefined": "UI_INA_TST_FLIGHT_SERVBIND",
+    "custom": "YY1_TEST_INA1"
+  }
+}

file-formats/rvbc/rvbc-v1.json

@@ -0,0 +1,157 @@
+{
+  "$comment": "This file is autogenerated, do not edit manually, see https://github.com/SAP/abap-file-formats for more information.",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/SAP/abap-file-formats/blob/main/file-formats/rvbc/rvbc-v1.json",
+  "title": "Object Type RVBC",
+  "description": "Object type RVBC",
+  "type": "object",
+  "properties": {
+    "formatVersion": {
+      "title": "Format Version",
+      "description": "Format version",
+      "type": "string",
+      "const": "1"
+    },
+    "header": {
+      "title": "Header",
+      "description": "Header",
+      "type": "object",
+      "properties": {
+        "description": {
+          "title": "Description",
+          "description": "Description of the ABAP object",
+          "type": "string",
+          "maxLength": 60
+        },
+        "originalLanguage": {
+          "title": "Original Language",
+          "description": "Original language of the ABAP object",
+          "type": "string",
+          "minLength": 2
+        },
+        "abapLanguageVersion": {
+          "title": "ABAP Language Version",
+          "description": "ABAP language version",
+          "type": "string",
+          "enum": [
+            "standard",
+            "keyUser",
+            "cloudDevelopment"
+          ],
+          "enumTitles": [
+            "Standard",
+            "ABAP for Key Users",
+            "ABAP Cloud Development"
+          ],
+          "enumDescriptions": [
+            "Standard",
+            "ABAP for key user extensibility",
+            "ABAP cloud development"
+          ],
+          "default": "standard"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "description",
+        "originalLanguage"
+      ]
+    },
+    "bookletDefinition": {
+      "title": "Booklet Definition",
+      "description": "Booklet definition",
+      "type": "object",
+      "properties": {
+        "source": {
+          "title": "Source",
+          "description": "Source",
+          "type": "string",
+          "enum": [
+            "predefined",
+            "custom"
+          ],
+          "enumTitles": [
+            "Predefined",
+            "Custom"
+          ],
+          "enumDescriptions": [
+            "Predefined",
+            "Custom"
+          ],
+          "default": "predefined"
+        },
+        "status": {
+          "title": "Status",
+          "description": "Status",
+          "type": "string",
+          "enum": [
+            "draft",
+            "final"
+          ],
+          "enumTitles": [
+            "Draft",
+            "Final"
+          ],
+          "enumDescriptions": [
+            "Draft",
+            "Final"
+          ],
+          "default": "draft"
+        },
+        "application": {
+          "title": "Fiori Application",
+          "description": "Fiori application",
+          "type": "string",
+          "maxLength": 70
+        },
+        "extensibilityMode": {
+          "title": "Extensibility Mode",
+          "description": "Extensibility mode",
+          "type": "string",
+          "enum": [
+            "fullySupported",
+            "supportedPredefinedQueries",
+            "notSupported"
+          ],
+          "enumTitles": [
+            "Fully Supported Including Custom Analytical Queries",
+            "Supported Only for Predefined Analytical Queries",
+            "Not Supported"
+          ],
+          "enumDescriptions": [
+            "Fully supported including custom analytical queries",
+            "Supported only for predefined analytical queries",
+            "Not supported"
+          ],
+          "default": "notSupported"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ina1Services": {
+      "title": "InA Services",
+      "description": "InA services",
+      "type": "object",
+      "properties": {
+        "predefined": {
+          "title": "Predefined InA Service",
+          "description": "Predefined InA service",
+          "type": "string",
+          "maxLength": 40
+        },
+        "custom": {
+          "title": "Custom InA Service",
+          "description": "Custom InA service",
+          "type": "string",
+          "maxLength": 40
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "formatVersion",
+    "header"
+  ]
+}

file-formats/rvbc/type/zif_aff_rvbc_v1.intf.abap

@@ -0,0 +1,100 @@
+"! AFF type for the object RVBC ( Review Booklets )
+INTERFACE zif_aff_rvbc_v1
+  PUBLIC.
+
+  TYPES ty_app_id             TYPE c LENGTH 70.
+  TYPES ty_ina1_service_name  TYPE c LENGTH 40.
+
+  "! $values { @link zif_aff_rvbc_v1.data:co_extensibility_mode }
+  "! $default { @link zif_aff_rvbc_v1.data:co_extensibility_mode.not_supported }
+  TYPES ty_extensibility_mode TYPE n LENGTH 2.
+  CONSTANTS:
+    BEGIN OF co_extensibility_mode,
+      "! <p class="shorttext">Fully Supported Including Custom Analytical Queries</p>
+      "! Fully supported including custom analytical queries
+      fully_supported              TYPE ty_extensibility_mode VALUE 0,
+      "! <p class="shorttext">Supported Only for Predefined Analytical Queries</p>
+      "! Supported only for predefined analytical queries
+      supported_predefined_queries TYPE ty_extensibility_mode VALUE 1,
+      "! <p class="shorttext">Not Supported</p>
+      "! Not supported
+      not_supported                TYPE ty_extensibility_mode VALUE 2,
+    END OF co_extensibility_mode.
+
+  "! $values { @link zif_aff_rvbc_v1.data:co_source }
+  "! $default { @link zif_aff_rvbc_v1.data:co_source.predefined }
+  TYPES ty_source TYPE n LENGTH 1.
+  CONSTANTS:
+    BEGIN OF co_source,
+      "! <p class="shorttext">Predefined</p>
+      "! Predefined
+      predefined TYPE ty_source VALUE 1,
+      "! <p class="shorttext">Custom</p>
+      "! Custom
+      custom     TYPE ty_source VALUE 2,
+    END OF co_source.
+
+  "! $values { @link zif_aff_rvbc_v1.data:co_status }
+  "! $default { @link zif_aff_rvbc_v1.data:co_status.draft }
+  TYPES ty_status TYPE n LENGTH 1.
+  CONSTANTS:
+    BEGIN OF co_status,
+      "! <p class="shorttext">Draft</p>
+      "! Draft
+      draft TYPE ty_status VALUE 1,
+      "! <p class="shorttext">Final</p>
+      "! Final
+      final TYPE ty_status VALUE 2,
+    END OF co_status.
+
+  TYPES:
+    "! <p class="shorttext">Review Booklet Definition</p>
+    "! Review booklet definition
+    BEGIN OF ty_booklet_definition,
+      "! <p class="shorttext">Source</p>
+      "! Source
+      source             TYPE ty_source,
+      "! <p class="shorttext">Status</p>
+      "! Status
+      status             TYPE ty_status,
+      "! <p class="shorttext">Fiori Application</p>
+      "! Fiori application
+      application        TYPE ty_app_id,
+      "! <p class="shorttext">Extensibility Mode</p>
+      "! Extensibility mode
+      extensibility_mode TYPE ty_extensibility_mode,
+    END OF ty_booklet_definition.
+
+  TYPES:
+    "! <p class="shorttext">InA Services</p>
+    "! InA Services
+    BEGIN OF ty_ina1_services,
+      "! <p class="shorttext">Predefined InA Service</p>
+      "! Predefined InA service
+      predefined TYPE ty_ina1_service_name,
+      "! <p class="shorttext">Custom InA Service</p>
+      "! Custom InA service
+      custom     TYPE ty_ina1_service_name,
+    END OF ty_ina1_services.
+
+  TYPES:
+    "! <p class="shorttext">Object Type RVBC</p>
+    "! Object type RVBC
+    BEGIN OF ty_main,
+      "! <p class="shorttext">Format Version</p>
+      "! Format version
+      "! $required
+      format_version     TYPE zif_aff_types_v1=>ty_format_version,
+      "! <p class="shorttext">Header</p>
+      "! Header
+      "! $required
+      header             TYPE zif_aff_types_v1=>ty_header_60,
+      "! <p class="shorttext">Booklet Definition</p>
+      "! Booklet definition
+      booklet_definition TYPE ty_booklet_definition,
+      "! <p class="shorttext">InA Services</p>
+      "! InA services
+      ina1_services      TYPE ty_ina1_services,
+    END OF ty_main.
+
+ENDINTERFACE.

file-formats/rvbc/type/zif_aff_rvbc_v1.intf.json

@@ -0,0 +1,7 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "AFF type for RVBC ( Review Booklet )",
+    "originalLanguage": "en"
+  }
+}