feat: YAML type validation

README.md

@@ -142,6 +142,7 @@ See the [DEVELOPMENT](./docs/DEVELOPMENT.md) and [CONTRIBUTING](https://github.c
 
 ## Acknowledgments
 - CEL Textmate Grammar was taken from [vscode-cel](https://github.com/hmarr/vscode-cel)
+- Range conversion from `yaml` to `vscode` from [actions/languageservices](https://github.com/actions/languageservices/blob/4280a967a8aa058dd3c8825349b90bc932d82283/workflow-parser/src/workflows/yaml-object-reader.ts#L220)
 
 ## License
 

server/package.json

@@ -13,9 +13,13 @@
 	},
 	"dependencies": {
 		"@openfga/syntax-transformer": "^0.2.0-beta.4",
+		"ajv": "^8.12.0",
 		"vscode-languageserver": "^8.1.0",
 		"vscode-languageserver-textdocument": "^1.0.11",
-		"yaml": "^2.3.2"
+		"yaml": "^2.3.3"
 	},
-	"scripts": {}
+	"scripts": {},
+	"devDependencies": {
+		"@types/js-yaml": "^4.0.8"
+	}
 }

server/src/openfga-yaml-schema.ts

@@ -0,0 +1,161 @@
+
+export const OPENFGA_YAML_SCHEMA = {
+	type: "object",
+	oneOf: [
+		{ required: ["model_file"] },
+		{ required: ["model"] }
+	],
+	properties: {
+		name: {
+			type: "string",
+			description: "The store name"
+		},
+		model_file: {
+			type: "string",
+			description: "The Authorization Model"
+		},
+		model: {
+			type: "string",
+			description: "The Authorization Model"
+		},
+		tuples: {
+			type: "array",
+			items: {
+				type: "object",
+				additionalProperties: false,
+				properties: {
+					user: {
+						type: "string",
+						description: "The user"
+					},
+					relation: {
+						type: "string",
+						description: "The relation"
+					},
+					object: {
+						type: "string",
+						description: "The object"
+					},
+					condition: {
+						type: "object",
+						additionalProperties: false,
+						properties: {
+							name: {
+								type: "string",
+							},
+							context: {
+								type: "object"
+							}
+						}
+					}
+				}
+			}
+		},
+		tests: {
+			type: "array",
+			items: {
+				type: "object",
+				additionalProperties: false,
+				properties: {
+					name: {
+						type: "string",
+						description: "The test name"
+					},
+					description: {
+						type: "string",
+						description: "The test description"
+					},
+					tuples: {
+						type: "array",
+						items: {
+							type: "object",
+							additionalProperties: false,
+							properties: {
+								user: {
+									type: "string",
+									description: "The user"
+								},
+								relation: {
+									type: "string",
+									description: "The relation"
+								},
+								object: {
+									type: "string",
+									description: "The object"
+								},
+								context: {
+									type: "object"
+								}
+							}
+						}
+					},
+					check: {
+						type: "array",
+						items: {
+							type: "object",
+							additionalProperties: false,
+							properties: {
+								user: {
+									type: "string",
+									description: "The user"
+								},
+								object: {
+									type: "string",
+									description: "The object"
+								},
+								assertions: {
+									type: "object",
+									patternProperties: {
+										".*": {
+											type: "boolean"
+										}
+									}
+								},
+								context: {
+									type: "object"
+								}
+							}
+						}
+					},
+					list_objects: {
+						type: "array",
+						items: {
+							type: "object",
+							additionalProperties: false,
+							properties: {
+								user: {
+									type: "string",
+									description: "The user"
+								},
+								relation: {
+									type: "string",
+									description: "The relation"
+								},
+								type: {
+									type: "string",
+									description: "The object type"
+								},
+								assertions: {
+									type: "object",
+									patternProperties: {
+										".*": {
+											type: "array",
+											items: {
+												type: "string"
+											}
+										}
+									}
+								},
+								context: {
+									type: "object"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	required: ["tests"],
+	additionalProperties: false,
+};