feat(training): create json schema to validate filesystemtree (#2485)

## Proposed change

<!--
Please include a summary of the changes and the related issue.
Please also include relevant motivation and context.
-->

## Related issues

<!--
Please make sure to follow the [contribution
guidelines](https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md)
-->

*- No issue associated -*

<!-- * 🐛 Fix #issue -->
<!-- * 🐛 Fix resolves #issue -->
<!-- * 🚀 Feature #issue -->
<!-- * 🚀 Feature resolves #issue -->
<!-- *  Pull Request #issue -->

apps/showcase/project.json

@@ -154,6 +154,7 @@
       "defaultConfiguration": "production",
       "dependsOn": [
         "^build",
+        "^extract-folder-structure",
         "generate-translations",
         "generate-theme",
         "generate-dark-theme",
@@ -176,6 +177,7 @@
       "dependsOn": [
         "^build-builders",
         "^build",
+        "^extract-folder-structure",
         "copy-training-assets",
         "prepare-training"
       ]

apps/showcase/schemas/webcontainer-file-system-tree.schema.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "WebContainerFileSystemTreeSchema",
+  "description": "Schema of a webcontainer api file system tree",
+  "required": ["fileSystemTree"],
+  "properties": {
+    "fileSystemTree": {
+      "$ref": "#/definitions/FileSystemTree"
+    }
+  },
+  "definitions": {
+    "FileSystemTree": {
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          {"$ref": "#/definitions/DirectoryNode"},
+          {"$ref": "#/definitions/FileNode"},
+          {"$ref": "#/definitions/SymlinkNode"}
+        ]
+      }
+    },
+    "DirectoryNode": {
+      "type": "object",
+      "required": ["directory"],
+      "properties": {
+        "directory": {
+          "$ref": "#/definitions/FileSystemTree"
+        }
+      }
+    },
+    "FileNode": {
+      "type": "object",
+      "required": [
+        "file"
+      ],
+      "properties": {
+        "file": {
+          "type": "object",
+          "description": "Metadata type",
+          "required": ["contents"],
+          "properties": {
+            "contents": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "SymlinkNode": {
+      "type": "object",
+      "required": [
+        "file"
+      ],
+      "properties": {
+        "file": {
+          "type": "object",
+          "description": "Metadata type",
+          "required": ["symlink"],
+          "properties": {
+            "symlink": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  }
+}

apps/showcase/scripts/prepare-training-exercises/index.cjs

@@ -22,7 +22,9 @@ void (async () => {
     const exerciseStructure = await getFilesTree([{isDir: true, path: `${filePath}`}], {readdir, readFile});
     const [_, commonPath, folderName] = folder.match('(.*)/(exercise|solution)');
     const targetPath = join(commonPath, `${folderName}.json`);
-    const content = JSON.stringify(exerciseStructure);
+    const content = JSON.stringify({
+      fileSystemTree: exerciseStructure
+    });
     await writeFile(targetPath, content);
   }
 })();

apps/showcase/src/components/training/training.component.ts

@@ -157,7 +157,7 @@ function getFilesContent(resources: Resource[]) {
   return (resources.reduce((fileSystemTree: FileSystemTree, resource) => {
     const sanitizedPath = `./${resource.path.replace(new RegExp('^[.]/?'), '')}`;
     const parsedPath = sanitizedPath.split('/').filter((pathEl) => !!pathEl);
-    overrideFileSystemTree(fileSystemTree, JSON.parse(resource.content) as FileSystemTree, parsedPath);
+    overrideFileSystemTree(fileSystemTree, JSON.parse(resource.content).fileSystemTree as FileSystemTree, parsedPath);
     return fileSystemTree;
   }, {} as FileSystemTree)['.'] as DirectoryNode).directory;
 }

packages/@o3r-training/training-tools/cli/extract-folder-structure/extract-folder-structure.cts

@@ -23,9 +23,11 @@ void (async () => {
     readdir: readdir,
     readFile: readFile
   } as FileSystem);
-  const content = JSON.stringify(folderStructure);
+  const content = JSON.stringify({
+    fileSystemTree: folderStructure
+  });
 
-  const targetPath = options.output.replace(/\\/g, "/");
+  const targetPath = options.output.replace(/\\/g, '/');
   const parsedPath = parse(options.output);
   if (parsedPath.dir) {
     await mkdir(parsedPath.dir, {recursive: true});