@shotstack/schemas 1.9.2 → 1.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/api.bundled.json +48 -4
  2. package/dist/json-schema/asset.json +78 -5
  3. package/dist/json-schema/clip.json +78 -5
  4. package/dist/json-schema/edit.json +78 -5
  5. package/dist/json-schema/{rich-caption-word-animation.json → rich-caption-animation.json} +1 -1
  6. package/dist/json-schema/rich-caption-asset.json +166 -93
  7. package/dist/json-schema/schemas.json +83 -5
  8. package/dist/json-schema/timeline.json +78 -5
  9. package/dist/json-schema/track.json +78 -5
  10. package/dist/schema.d.ts +32 -3
  11. package/dist/zod/zod.gen.cjs +88 -57
  12. package/dist/zod/zod.gen.d.ts +197 -237
  13. package/dist/zod/zod.gen.js +83 -52
  14. package/dist/zod/zod.gen.ts +60 -40
  15. package/package.json +1 -1
package/dist/json-schema/rich-caption-asset.json CHANGED
@@ -107,7 +107,80 @@
107
107
  "style": {
108
108
  "anyOf": [
109
109
  {
110
- "$ref": "#/$defs/RichTextStyle"
110
+ "type": "object",
111
+ "properties": {
112
+ "letterSpacing": {
113
+ "anyOf": [
114
+ {
115
+ "type": "number"
116
+ },
117
+ {
118
+ "type": "null"
119
+ }
120
+ ]
121
+ },
122
+ "lineHeight": {
123
+ "anyOf": [
124
+ {
125
+ "type": "number",
126
+ "minimum": 0,
127
+ "maximum": 10
128
+ },
129
+ {
130
+ "type": "null"
131
+ }
132
+ ]
133
+ },
134
+ "textTransform": {
135
+ "anyOf": [
136
+ {
137
+ "type": "string",
138
+ "enum": [
139
+ "none",
140
+ "uppercase",
141
+ "lowercase",
142
+ "capitalize"
143
+ ]
144
+ },
145
+ {
146
+ "type": "null"
147
+ }
148
+ ]
149
+ },
150
+ "textDecoration": {
151
+ "anyOf": [
152
+ {
153
+ "type": "string",
154
+ "enum": [
155
+ "none",
156
+ "underline",
157
+ "line-through"
158
+ ]
159
+ },
160
+ {
161
+ "type": "null"
162
+ }
163
+ ]
164
+ },
165
+ "gradient": {
166
+ "anyOf": [
167
+ {
168
+ "$ref": "#/$defs/RichTextGradient"
169
+ },
170
+ {
171
+ "type": "null"
172
+ }
173
+ ]
174
+ }
175
+ },
176
+ "additionalProperties": false,
177
+ "required": [
178
+ "letterSpacing",
179
+ "lineHeight",
180
+ "textTransform",
181
+ "textDecoration",
182
+ "gradient"
183
+ ]
111
184
  },
112
185
  {
113
186
  "type": "null"
@@ -188,10 +261,10 @@
188
261
  }
189
262
  ]
190
263
  },
191
- "wordAnimation": {
264
+ "animation": {
192
265
  "anyOf": [
193
266
  {
194
- "$ref": "#/$defs/RichCaptionWordAnimation"
267
+ "$ref": "#/$defs/RichCaptionAnimation"
195
268
  },
196
269
  {
197
270
  "type": "null"
@@ -212,97 +285,9 @@
212
285
  "padding",
213
286
  "align",
214
287
  "active",
215
- "wordAnimation"
288
+ "animation"
216
289
  ],
217
290
  "$defs": {
218
- "RichTextStyle": {
219
- "properties": {
220
- "letterSpacing": {
221
- "anyOf": [
222
- {
223
- "type": "number"
224
- },
225
- {
226
- "type": "null"
227
- }
228
- ]
229
- },
230
- "wordSpacing": {
231
- "anyOf": [
232
- {
233
- "type": "number",
234
- "minimum": 0
235
- },
236
- {
237
- "type": "null"
238
- }
239
- ]
240
- },
241
- "lineHeight": {
242
- "anyOf": [
243
- {
244
- "type": "number",
245
- "minimum": 0,
246
- "maximum": 10
247
- },
248
- {
249
- "type": "null"
250
- }
251
- ]
252
- },
253
- "textTransform": {
254
- "anyOf": [
255
- {
256
- "type": "string",
257
- "enum": [
258
- "none",
259
- "uppercase",
260
- "lowercase",
261
- "capitalize"
262
- ]
263
- },
264
- {
265
- "type": "null"
266
- }
267
- ]
268
- },
269
- "textDecoration": {
270
- "anyOf": [
271
- {
272
- "type": "string",
273
- "enum": [
274
- "none",
275
- "underline",
276
- "line-through"
277
- ]
278
- },
279
- {
280
- "type": "null"
281
- }
282
- ]
283
- },
284
- "gradient": {
285
- "anyOf": [
286
- {
287
- "$ref": "#/$defs/RichTextGradient"
288
- },
289
- {
290
- "type": "null"
291
- }
292
- ]
293
- }
294
- },
295
- "additionalProperties": false,
296
- "type": "object",
297
- "required": [
298
- "letterSpacing",
299
- "wordSpacing",
300
- "lineHeight",
301
- "textTransform",
302
- "textDecoration",
303
- "gradient"
304
- ]
305
- },
306
291
  "RichTextGradient": {
307
292
  "properties": {
308
293
  "type": {
@@ -841,6 +826,94 @@
841
826
  "stroke"
842
827
  ]
843
828
  },
829
+ "RichTextStyle": {
830
+ "properties": {
831
+ "letterSpacing": {
832
+ "anyOf": [
833
+ {
834
+ "type": "number"
835
+ },
836
+ {
837
+ "type": "null"
838
+ }
839
+ ]
840
+ },
841
+ "wordSpacing": {
842
+ "anyOf": [
843
+ {
844
+ "type": "number",
845
+ "minimum": 0
846
+ },
847
+ {
848
+ "type": "null"
849
+ }
850
+ ]
851
+ },
852
+ "lineHeight": {
853
+ "anyOf": [
854
+ {
855
+ "type": "number",
856
+ "minimum": 0,
857
+ "maximum": 10
858
+ },
859
+ {
860
+ "type": "null"
861
+ }
862
+ ]
863
+ },
864
+ "textTransform": {
865
+ "anyOf": [
866
+ {
867
+ "type": "string",
868
+ "enum": [
869
+ "none",
870
+ "uppercase",
871
+ "lowercase",
872
+ "capitalize"
873
+ ]
874
+ },
875
+ {
876
+ "type": "null"
877
+ }
878
+ ]
879
+ },
880
+ "textDecoration": {
881
+ "anyOf": [
882
+ {
883
+ "type": "string",
884
+ "enum": [
885
+ "none",
886
+ "underline",
887
+ "line-through"
888
+ ]
889
+ },
890
+ {
891
+ "type": "null"
892
+ }
893
+ ]
894
+ },
895
+ "gradient": {
896
+ "anyOf": [
897
+ {
898
+ "$ref": "#/$defs/RichTextGradient"
899
+ },
900
+ {
901
+ "type": "null"
902
+ }
903
+ ]
904
+ }
905
+ },
906
+ "additionalProperties": false,
907
+ "type": "object",
908
+ "required": [
909
+ "letterSpacing",
910
+ "wordSpacing",
911
+ "lineHeight",
912
+ "textTransform",
913
+ "textDecoration",
914
+ "gradient"
915
+ ]
916
+ },
844
917
  "RichTextAlignment": {
845
918
  "properties": {
846
919
  "horizontal": {
@@ -1074,7 +1147,7 @@
1074
1147
  "textDecoration"
1075
1148
  ]
1076
1149
  },
1077
- "RichCaptionWordAnimation": {
1150
+ "RichCaptionAnimation": {
1078
1151
  "type": "object",
1079
1152
  "properties": {
1080
1153
  "style": {
package/dist/json-schema/schemas.json CHANGED
@@ -2128,8 +2128,86 @@
2128
2128
  "style": {
2129
2129
  "anyOf": [
2130
2130
  {
2131
+ "type": "object",
2131
2132
  "description": "Text style properties including spacing, line height, and transformations.",
2132
- "$ref": "#/$defs/RichTextStyle"
2133
+ "properties": {
2134
+ "letterSpacing": {
2135
+ "anyOf": [
2136
+ {
2137
+ "type": "number",
2138
+ "description": "Additional spacing between letters in pixels. Can be negative for tighter spacing."
2139
+ },
2140
+ {
2141
+ "type": "null"
2142
+ }
2143
+ ]
2144
+ },
2145
+ "lineHeight": {
2146
+ "anyOf": [
2147
+ {
2148
+ "type": "number",
2149
+ "description": "The line height as a multiplier of the font size. Must be between 0 and 10.",
2150
+ "minimum": 0,
2151
+ "maximum": 10
2152
+ },
2153
+ {
2154
+ "type": "null"
2155
+ }
2156
+ ]
2157
+ },
2158
+ "textTransform": {
2159
+ "anyOf": [
2160
+ {
2161
+ "type": "string",
2162
+ "description": "Text transformation to apply.",
2163
+ "enum": [
2164
+ "none",
2165
+ "uppercase",
2166
+ "lowercase",
2167
+ "capitalize"
2168
+ ]
2169
+ },
2170
+ {
2171
+ "type": "null"
2172
+ }
2173
+ ]
2174
+ },
2175
+ "textDecoration": {
2176
+ "anyOf": [
2177
+ {
2178
+ "type": "string",
2179
+ "description": "Text decoration to apply.",
2180
+ "enum": [
2181
+ "none",
2182
+ "underline",
2183
+ "line-through"
2184
+ ]
2185
+ },
2186
+ {
2187
+ "type": "null"
2188
+ }
2189
+ ]
2190
+ },
2191
+ "gradient": {
2192
+ "anyOf": [
2193
+ {
2194
+ "description": "Gradient fill for text instead of solid color.",
2195
+ "$ref": "#/$defs/RichTextGradient"
2196
+ },
2197
+ {
2198
+ "type": "null"
2199
+ }
2200
+ ]
2201
+ }
2202
+ },
2203
+ "additionalProperties": false,
2204
+ "required": [
2205
+ "letterSpacing",
2206
+ "lineHeight",
2207
+ "textTransform",
2208
+ "textDecoration",
2209
+ "gradient"
2210
+ ]
2133
2211
  },
2134
2212
  {
2135
2213
  "type": "null"
@@ -2218,11 +2296,11 @@
2218
2296
  }
2219
2297
  ]
2220
2298
  },
2221
- "wordAnimation": {
2299
+ "animation": {
2222
2300
  "anyOf": [
2223
2301
  {
2224
2302
  "description": "Word-level animation properties controlling how words are highlighted or revealed.",
2225
- "$ref": "#/$defs/RichCaptionWordAnimation"
2303
+ "$ref": "#/$defs/RichCaptionAnimation"
2226
2304
  },
2227
2305
  {
2228
2306
  "type": "null"
@@ -2243,7 +2321,7 @@
2243
2321
  "padding",
2244
2322
  "align",
2245
2323
  "active",
2246
- "wordAnimation"
2324
+ "animation"
2247
2325
  ]
2248
2326
  },
2249
2327
  "RichCaptionActive": {
@@ -2384,7 +2462,7 @@
2384
2462
  "textDecoration"
2385
2463
  ]
2386
2464
  },
2387
- "RichCaptionWordAnimation": {
2465
+ "RichCaptionAnimation": {
2388
2466
  "description": "Word-level animation properties for caption effects.",
2389
2467
  "type": "object",
2390
2468
  "properties": {
package/dist/json-schema/timeline.json CHANGED
@@ -1950,7 +1950,80 @@
1950
1950
  "style": {
1951
1951
  "anyOf": [
1952
1952
  {
1953
- "$ref": "#/$defs/RichTextStyle"
1953
+ "type": "object",
1954
+ "properties": {
1955
+ "letterSpacing": {
1956
+ "anyOf": [
1957
+ {
1958
+ "type": "number"
1959
+ },
1960
+ {
1961
+ "type": "null"
1962
+ }
1963
+ ]
1964
+ },
1965
+ "lineHeight": {
1966
+ "anyOf": [
1967
+ {
1968
+ "type": "number",
1969
+ "minimum": 0,
1970
+ "maximum": 10
1971
+ },
1972
+ {
1973
+ "type": "null"
1974
+ }
1975
+ ]
1976
+ },
1977
+ "textTransform": {
1978
+ "anyOf": [
1979
+ {
1980
+ "type": "string",
1981
+ "enum": [
1982
+ "none",
1983
+ "uppercase",
1984
+ "lowercase",
1985
+ "capitalize"
1986
+ ]
1987
+ },
1988
+ {
1989
+ "type": "null"
1990
+ }
1991
+ ]
1992
+ },
1993
+ "textDecoration": {
1994
+ "anyOf": [
1995
+ {
1996
+ "type": "string",
1997
+ "enum": [
1998
+ "none",
1999
+ "underline",
2000
+ "line-through"
2001
+ ]
2002
+ },
2003
+ {
2004
+ "type": "null"
2005
+ }
2006
+ ]
2007
+ },
2008
+ "gradient": {
2009
+ "anyOf": [
2010
+ {
2011
+ "$ref": "#/$defs/RichTextGradient"
2012
+ },
2013
+ {
2014
+ "type": "null"
2015
+ }
2016
+ ]
2017
+ }
2018
+ },
2019
+ "additionalProperties": false,
2020
+ "required": [
2021
+ "letterSpacing",
2022
+ "lineHeight",
2023
+ "textTransform",
2024
+ "textDecoration",
2025
+ "gradient"
2026
+ ]
1954
2027
  },
1955
2028
  {
1956
2029
  "type": "null"
@@ -2031,10 +2104,10 @@
2031
2104
  }
2032
2105
  ]
2033
2106
  },
2034
- "wordAnimation": {
2107
+ "animation": {
2035
2108
  "anyOf": [
2036
2109
  {
2037
- "$ref": "#/$defs/RichCaptionWordAnimation"
2110
+ "$ref": "#/$defs/RichCaptionAnimation"
2038
2111
  },
2039
2112
  {
2040
2113
  "type": "null"
@@ -2055,7 +2128,7 @@
2055
2128
  "padding",
2056
2129
  "align",
2057
2130
  "active",
2058
- "wordAnimation"
2131
+ "animation"
2059
2132
  ]
2060
2133
  },
2061
2134
  "RichCaptionActive": {
@@ -2186,7 +2259,7 @@
2186
2259
  "textDecoration"
2187
2260
  ]
2188
2261
  },
2189
- "RichCaptionWordAnimation": {
2262
+ "RichCaptionAnimation": {
2190
2263
  "type": "object",
2191
2264
  "properties": {
2192
2265
  "style": {
package/dist/json-schema/track.json CHANGED
@@ -1837,7 +1837,80 @@
1837
1837
  "style": {
1838
1838
  "anyOf": [
1839
1839
  {
1840
- "$ref": "#/$defs/RichTextStyle"
1840
+ "type": "object",
1841
+ "properties": {
1842
+ "letterSpacing": {
1843
+ "anyOf": [
1844
+ {
1845
+ "type": "number"
1846
+ },
1847
+ {
1848
+ "type": "null"
1849
+ }
1850
+ ]
1851
+ },
1852
+ "lineHeight": {
1853
+ "anyOf": [
1854
+ {
1855
+ "type": "number",
1856
+ "minimum": 0,
1857
+ "maximum": 10
1858
+ },
1859
+ {
1860
+ "type": "null"
1861
+ }
1862
+ ]
1863
+ },
1864
+ "textTransform": {
1865
+ "anyOf": [
1866
+ {
1867
+ "type": "string",
1868
+ "enum": [
1869
+ "none",
1870
+ "uppercase",
1871
+ "lowercase",
1872
+ "capitalize"
1873
+ ]
1874
+ },
1875
+ {
1876
+ "type": "null"
1877
+ }
1878
+ ]
1879
+ },
1880
+ "textDecoration": {
1881
+ "anyOf": [
1882
+ {
1883
+ "type": "string",
1884
+ "enum": [
1885
+ "none",
1886
+ "underline",
1887
+ "line-through"
1888
+ ]
1889
+ },
1890
+ {
1891
+ "type": "null"
1892
+ }
1893
+ ]
1894
+ },
1895
+ "gradient": {
1896
+ "anyOf": [
1897
+ {
1898
+ "$ref": "#/$defs/RichTextGradient"
1899
+ },
1900
+ {
1901
+ "type": "null"
1902
+ }
1903
+ ]
1904
+ }
1905
+ },
1906
+ "additionalProperties": false,
1907
+ "required": [
1908
+ "letterSpacing",
1909
+ "lineHeight",
1910
+ "textTransform",
1911
+ "textDecoration",
1912
+ "gradient"
1913
+ ]
1841
1914
  },
1842
1915
  {
1843
1916
  "type": "null"
@@ -1918,10 +1991,10 @@
1918
1991
  }
1919
1992
  ]
1920
1993
  },
1921
- "wordAnimation": {
1994
+ "animation": {
1922
1995
  "anyOf": [
1923
1996
  {
1924
- "$ref": "#/$defs/RichCaptionWordAnimation"
1997
+ "$ref": "#/$defs/RichCaptionAnimation"
1925
1998
  },
1926
1999
  {
1927
2000
  "type": "null"
@@ -1942,7 +2015,7 @@
1942
2015
  "padding",
1943
2016
  "align",
1944
2017
  "active",
1945
- "wordAnimation"
2018
+ "animation"
1946
2019
  ]
1947
2020
  },
1948
2021
  "RichCaptionActive": {
@@ -2073,7 +2146,7 @@
2073
2146
  "textDecoration"
2074
2147
  ]
2075
2148
  },
2076
- "RichCaptionWordAnimation": {
2149
+ "RichCaptionAnimation": {
2077
2150
  "type": "object",
2078
2151
  "properties": {
2079
2152
  "style": {
package/dist/schema.d.ts CHANGED
@@ -1032,7 +1032,36 @@ export interface components {
1032
1032
  background?: string;
1033
1033
  };
1034
1034
  /** @description Text style properties including spacing, line height, and transformations. */
1035
- style?: components["schemas"]["RichTextStyle"];
1035
+ style?: {
1036
+ /**
1037
+ * @description Additional spacing between letters in pixels. Can be negative for tighter spacing.
1038
+ * @default 0
1039
+ * @example 2
1040
+ */
1041
+ letterSpacing?: number;
1042
+ /**
1043
+ * @description The line height as a multiplier of the font size. Must be between 0 and 10.
1044
+ * @default 1.2
1045
+ * @example 1.5
1046
+ */
1047
+ lineHeight?: number;
1048
+ /**
1049
+ * @description Text transformation to apply.
1050
+ * @default none
1051
+ * @example uppercase
1052
+ * @enum {string}
1053
+ */
1054
+ textTransform?: "none" | "uppercase" | "lowercase" | "capitalize";
1055
+ /**
1056
+ * @description Text decoration to apply.
1057
+ * @default none
1058
+ * @example underline
1059
+ * @enum {string}
1060
+ */
1061
+ textDecoration?: "none" | "underline" | "line-through";
1062
+ /** @description Gradient fill for text instead of solid color. */
1063
+ gradient?: components["schemas"]["RichTextGradient"];
1064
+ };
1036
1065
  /** @description Text stroke (outline) properties for inactive words. */
1037
1066
  stroke?: components["schemas"]["RichTextStroke"];
1038
1067
  /** @description Text shadow properties. */
@@ -1048,7 +1077,7 @@ export interface components {
1048
1077
  /** @description Styling properties for the active/highlighted word. These override the base styling when a word is being spoken. */
1049
1078
  active?: components["schemas"]["RichCaptionActive"];
1050
1079
  /** @description Word-level animation properties controlling how words are highlighted or revealed. */
1051
- wordAnimation?: components["schemas"]["RichCaptionWordAnimation"];
1080
+ animation?: components["schemas"]["RichCaptionAnimation"];
1052
1081
  };
1053
1082
  /** @description Font properties for the active/highlighted word. */
1054
1083
  RichCaptionActiveFont: {
@@ -1093,7 +1122,7 @@ export interface components {
1093
1122
  scale?: number;
1094
1123
  };
1095
1124
  /** @description Word-level animation properties for caption effects. */
1096
- RichCaptionWordAnimation: {
1125
+ RichCaptionAnimation: {
1097
1126
  /**
1098
1127
  * @description The animation style to apply to words: <ul>
1099
1128
  * <li>`karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)</li>