Merge branch 'suggestion/author-fields'

README.md

@@ -128,6 +128,8 @@ Examples of how to validate can be found here: _---TODO---_
   "$schema": "https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json", // [optional] Reference to the JSON-schema
   "title": "", // [optional] string, a short name of the GFX-template. Used for informational purposes only.
   "description": "", // [optional] string, a description GFX-template. Used for informational purposes only.
+  "authorName": "", // [optional] string, name of the author.
+  "authorEmail": "", // [optional] string, email to the author.
   "type": "object", // MUST be "object"
   "properties": {
     // MUST be an object

gdd-meta-schema/v1/schema.json

@@ -27,6 +27,15 @@
       "type": "string",
       "description": "A description GFX-template. Used for informational purposes only."
     },
+    "authorName": {
+      "type": "string",
+      "description": "Name of the author"
+    },
+    "authorEmail": {
+      "type": "string",
+      "description": "Email to the author",
+      "format": "email"
+    },
     "properties": {
       "type": "object",
       "patternProperties": {

lib/unit-tests/__tests__/basic.test.ts

@@ -82,6 +82,20 @@ describe('Schema - Basic types', () => {
 			})
 		).toMatch(/not.*object/)
 
+		expect(
+			validateSchema({
+				type: 'object',
+				properties: {},
+				authorName: 123, // bad type
+			})
+		).toMatch(/not.*string/)
+		expect(
+			validateSchema({
+				type: 'object',
+				properties: {},
+				authorEmail: 'not-an-email', // bad format
+			})
+		).toMatch(/does not conform.*email.*format/)
 		expect(
 			validateSchema({
 				type: 'object',
@@ -97,6 +111,8 @@ describe('Schema - Basic types', () => {
 				title: 'A title',
 				description: 'a description',
 				$schema: 'https://superflytv.github.io/GraphicsDataDefinition/gdd-meta-schema/v1/schema.json',
+				authorName: 'author',
+				authorEmail: '[email protected]',
 				gddPlayoutOptions: {},
 			})
 		).toBe(null)