refactor(schema): improve titles, connect values & remove duplications

CONTRIBUTING.md

@@ -13,6 +13,10 @@ It can be merged into a single file using
 If you need to make changes to the schema, edit the individual files then
 run the merge script to get the final one.
 
+Please use unique naming for `title` property because it's important for auto-generating-type tools.
+For example, if you need to auto-convert JSON-Schema into Typescript (TS), the `title` naming will be
+utilized for Interface and Type.
+
 Some places in the documentation pull information from the unified schema file
 so you will only see them if you merge the files.
 

docs/schema/animated-properties/animated-property.json

@@ -5,23 +5,13 @@
     "description": "An animatable property that holds an array of numbers",
     "allOf": [
         {
-
-            "properties": {
-                "ix": {
-                    "title": "Property Index",
-                    "type": "integer"
-                },
-                "a": {
-                    "title": "Animated",
-                    "description": "Whether the property is animated",
-                    "$ref": "#/$defs/helpers/int-boolean",
-                    "default": 0
-                },
-                "x": {
-                    "title": "Expression",
-                    "type": "string"
-                }
-            }
+            "$ref": "#/$defs/animated-properties/animated"
+        },
+        {
+            "$ref": "#/$defs/helpers/property-index"
+        },
+        {
+            "$ref": "#/$defs/animated-properties/expression"
         },
         {
             "if": {

docs/schema/animated-properties/animated.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "title": "Animated",
+    "description": "Whether the property is animated",
+    "type": "object",
+    "properties": {
+        "a": {
+            "$ref": "#/$defs/helpers/int-boolean",
+            "default": 0
+        }
+    },
+    "additionalProperties": false
+}

docs/schema/animated-properties/expression.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "title": "Expression",
+    "type": "object",
+    "properties": {
+        "x": {
+            "type": "string"
+        }
+    },
+    "additionalProperties": false
+}

docs/schema/animated-properties/gradient-colors.json

@@ -6,7 +6,7 @@
 
     "properties": {
         "k": {
-            "title": "Colors",
+            "title": "Gradient Colors Multi Dimensional",
             "$ref": "#/$defs/animated-properties/multi-dimensional"
         },
         "p": {

docs/schema/animated-properties/keyframe.json

@@ -7,17 +7,17 @@
         {
             "properties": {
                 "t": {
-                    "title": "Time",
+                    "title": "Keyframe Time",
                     "type": "number",
                     "default": 0
                 },
                 "h": {
-                    "title": "Hold",
+                    "title": "Keyframe Hold",
                     "$ref": "#/$defs/helpers/int-boolean",
                     "default": 0
                 },
                 "s": {
-                    "title": "Value",
+                    "title": "Keyframe Value",
                     "description": "Value at this keyframe. Note the if the property is a scalar, keyframe values are still represented as arrays",
                     "type": "array",
                     "items": {

docs/schema/animated-properties/position.json

@@ -5,22 +5,10 @@
     "description": "An animatable property to represent a position in space",
     "allOf": [
         {
-            "properties": {
-                "ix": {
-                    "title": "Property Index",
-                    "type": "integer"
-                },
-                "a": {
-                    "title": "Animated",
-                    "description": "Whether the property is animated",
-                    "$ref": "#/$defs/helpers/int-boolean",
-                    "default": 0
-                },
-                "x": {
-                    "title": "Expression",
-                    "type": "string"
-                }
-            }
+            "$ref": "#/$defs/animated-properties/animated"
+        },
+        {
+            "$ref": "#/$defs/helpers/property-index"
         },
         {
             "if": {

docs/schema/animated-properties/shape-property.json

@@ -5,22 +5,13 @@
     "description": "An animatable property that holds a Bezier",
     "allOf": [
         {
-            "properties": {
-                "ix": {
-                    "title": "Property Index",
-                    "type": "integer"
-                },
-                "a": {
-                    "title": "Animated",
-                    "description": "Whether the property is animated",
-                    "$ref": "#/$defs/helpers/int-boolean",
-                    "default": 0
-                },
-                "x": {
-                    "title": "Expression",
-                    "type": "string"
-                }
-            }
+            "$ref": "#/$defs/animated-properties/animated"
+        },
+        {
+            "$ref": "#/$defs/helpers/property-index"
+        },
+        {
+            "$ref": "#/$defs/animated-properties/expression"
         },
         {
             "if": {

docs/schema/animated-properties/value.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type": "object",
-    "title": "Value",
+    "title": "Animated Property Value",
     "description": "An animatable property that holds a float",
     "allOf": [
         {

docs/schema/animation/animation.json

@@ -7,6 +7,12 @@
         {
             "$ref": "#/$defs/helpers/visual-object"
         },
+        {
+            "$ref": "#/$defs/helpers/three-dimensional"
+        },
+        {
+            "$ref": "#/$defs/helpers/framerate"
+        },
         {
             "type": "object",
             "properties": {
@@ -15,41 +21,28 @@
                     "type": "string",
                     "default": "5.5.2"
                 },
-                "fr": {
-                    "title": "Framerate",
-                    "description": "Framerate in frames per second",
-                    "type": "number",
-                    "default": 60
-                },
                 "ip": {
-                    "title": "In Point",
+                    "title": "Animation In Point",
                     "description": "\"In Point\", which frame the animation starts at (usually 0)",
                     "type": "number",
                     "default": 0
                 },
                 "op": {
-                    "title": "Out Point",
+                    "title": "Animation Out Point",
                     "description": "\"Out Point\", which frame the animation stops/loops at, which makes this the duration in frames when `ip` is 0",
                     "type": "number",
                     "default": 60
                 },
                 "w": {
-                    "title": "Width",
-                    "description": "Width of the animation",
+                    "title": "Animation Width",
                     "type": "integer",
                     "default": 512
                 },
                 "h": {
-                    "title": "Height",
-                    "description": "Height of the animation",
+                    "title": "Animation Height",
                     "type": "integer",
                     "default": 512
                 },
-                "ddd": {
-                    "title": "Threedimensional",
-                    "$ref": "#/$defs/helpers/int-boolean",
-                    "default": 0
-                },
                 "assets": {
                     "title": "Assets",
                     "type": "array",
@@ -72,7 +65,7 @@
                     "$ref": "#/$defs/text/font-list"
                 },
                 "chars": {
-                    "title": "Chars",
+                    "title": "Animation Chars Data",
                     "description": "Data defining text characters as lottie shapes",
                     "type": "array",
                     "items": {
@@ -93,7 +86,6 @@
                     }
                 },
                 "mb": {
-                    "title": "Motion Blur",
                     "$ref": "#/$defs/animation/motion-blur"
                 }
             },

docs/schema/assets/image.json

@@ -11,19 +11,17 @@
             "type": "object",
             "properties": {
                 "w": {
-                    "title": "Width",
-                    "description": "Width of the image",
+                    "title": "Image Width",
                     "type": "number",
                     "default": 0
                 },
                 "h": {
-                    "title": "Height",
-                    "description": "Height of the image",
+                    "title": "Image Height",
                     "type": "number",
                     "default": 0
                 },
                 "u": {
-                    "title": "Path",
+                    "title": "Image Path",
                     "description": "Path to the directory containing an image",
                     "type": "string",
                     "default": ""

docs/schema/assets/precomposition.json

@@ -11,19 +11,10 @@
             "$ref": "#/$defs/animation/composition"
         },
         {
-            "type": "object",
-            "properties": {
-                "nm": {
-                    "type": "string",
-                    "title": "Name",
-                    "description": "Name of the precomposition"
-                },
-                "fr": {
-                    "title": "Framerate",
-                    "description": "Framerate in frames per second",
-                    "type": "number"
-                }
-            }
+            "$ref": "#/$defs/helpers/name"
+        },
+        {
+            "$ref": "#/$defs/helpers/framerate"
         }
     ]
 }

docs/schema/assets/sound.json

@@ -11,19 +11,19 @@
             "type": "object",
             "properties": {
                 "u": {
-                    "title": "Path",
+                    "title": "Sound Path",
                     "description": "Path to the directory containing a sound file",
                     "type": "string",
                     "default": ""
                 },
                 "p": {
-                    "title": "File name",
+                    "title": "Sound File name",
                     "description": "Sound filename or data url",
                     "type": "string",
                     "default": ""
                 },
                 "e": {
-                    "title": "Embedded",
+                    "title": "Sound Embedded",
                     "description": "Whether the sound is embedded",
                     "$ref": "#/$defs/helpers/int-boolean",
                     "default": 0

docs/schema/constants/blend-mode.json

@@ -5,67 +5,67 @@
     "description": "",
     "oneOf": [
         {
-            "title": "Normal",
+            "title": "Blend Mode Normal",
             "const": 0
         },
         {
-            "title": "Multiply",
+            "title": "Blend Mode Multiply",
             "const": 1
         },
         {
-            "title": "Screen",
+            "title": "Blend Mode Screen",
             "const": 2
         },
         {
-            "title": "Overlay",
+            "title": "Blend Mode Overlay",
             "const": 3
         },
         {
-            "title": "Darken",
+            "title": "Blend Mode Darken",
             "const": 4
         },
         {
-            "title": "Lighten",
+            "title": "Blend Mode Lighten",
             "const": 5
         },
         {
-            "title": "Color Dodge",
+            "title": "Blend Mode Color Dodge",
             "const": 6
         },
         {
-            "title": "Color Burn",
+            "title": "Blend Mode Color Burn",
             "const": 7
         },
         {
-            "title": "Hard Light",
+            "title": "Blend Mode Hard Light",
             "const": 8
         },
         {
-            "title": "Soft Light",
+            "title": "Blend Mode Soft Light",
             "const": 9
         },
         {
-            "title": "Difference",
+            "title": "Blend Mode Difference",
             "const": 10
         },
         {
-            "title": "Exclusion",
+            "title": "Blend Mode Exclusion",
             "const": 11
         },
         {
-            "title": "Hue",
+            "title": "Blend Mode Hue",
             "const": 12
         },
         {
-            "title": "Saturation",
+            "title": "Blend Mode Saturation",
             "const": 13
         },
         {
-            "title": "Color",
+            "title": "Blend Mode Color",
             "const": 14
         },
         {
-            "title": "Luminosity",
+            "title": "Blend Mode Luminosity",
             "const": 15
         }
     ]