@shotstack/schemas 1.7.1 → 1.8.3

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.
@@ -36,7 +36,88 @@
36
36
  "font": {
37
37
  "anyOf": [
38
38
  {
39
- "$ref": "#/$defs/RichTextFont"
39
+ "type": "object",
40
+ "properties": {
41
+ "family": {
42
+ "anyOf": [
43
+ {
44
+ "type": "string",
45
+ "enum": [
46
+ "Roboto"
47
+ ]
48
+ },
49
+ {
50
+ "type": "null"
51
+ }
52
+ ]
53
+ },
54
+ "size": {
55
+ "anyOf": [
56
+ {
57
+ "type": "integer",
58
+ "minimum": 1,
59
+ "maximum": 500
60
+ },
61
+ {
62
+ "type": "null"
63
+ }
64
+ ]
65
+ },
66
+ "weight": {
67
+ "anyOf": [
68
+ {
69
+ "type": "string"
70
+ },
71
+ {
72
+ "type": "null"
73
+ }
74
+ ]
75
+ },
76
+ "color": {
77
+ "anyOf": [
78
+ {
79
+ "type": "string",
80
+ "enum": [
81
+ "#ffffff"
82
+ ]
83
+ },
84
+ {
85
+ "type": "null"
86
+ }
87
+ ]
88
+ },
89
+ "opacity": {
90
+ "anyOf": [
91
+ {
92
+ "type": "number",
93
+ "minimum": 0,
94
+ "maximum": 1
95
+ },
96
+ {
97
+ "type": "null"
98
+ }
99
+ ]
100
+ },
101
+ "background": {
102
+ "anyOf": [
103
+ {
104
+ "type": "string"
105
+ },
106
+ {
107
+ "type": "null"
108
+ }
109
+ ]
110
+ }
111
+ },
112
+ "additionalProperties": false,
113
+ "required": [
114
+ "family",
115
+ "size",
116
+ "weight",
117
+ "color",
118
+ "opacity",
119
+ "background"
120
+ ]
40
121
  },
41
122
  {
42
123
  "type": "null"
@@ -221,145 +302,6 @@
221
302
  "confidence"
222
303
  ]
223
304
  },
224
- "RichTextFont": {
225
- "properties": {
226
- "family": {
227
- "anyOf": [
228
- {
229
- "type": "string",
230
- "enum": [
231
- "Open Sans"
232
- ]
233
- },
234
- {
235
- "type": "null"
236
- }
237
- ]
238
- },
239
- "size": {
240
- "anyOf": [
241
- {
242
- "type": "integer",
243
- "minimum": 1,
244
- "maximum": 500
245
- },
246
- {
247
- "type": "null"
248
- }
249
- ]
250
- },
251
- "weight": {
252
- "anyOf": [
253
- {
254
- "type": "string"
255
- },
256
- {
257
- "type": "null"
258
- }
259
- ]
260
- },
261
- "color": {
262
- "anyOf": [
263
- {
264
- "type": "string"
265
- },
266
- {
267
- "type": "null"
268
- }
269
- ]
270
- },
271
- "opacity": {
272
- "anyOf": [
273
- {
274
- "type": "number",
275
- "minimum": 0,
276
- "maximum": 1
277
- },
278
- {
279
- "type": "null"
280
- }
281
- ]
282
- },
283
- "background": {
284
- "anyOf": [
285
- {
286
- "type": "string"
287
- },
288
- {
289
- "type": "null"
290
- }
291
- ]
292
- },
293
- "stroke": {
294
- "anyOf": [
295
- {
296
- "$ref": "#/$defs/RichTextStroke"
297
- },
298
- {
299
- "type": "null"
300
- }
301
- ]
302
- }
303
- },
304
- "additionalProperties": false,
305
- "type": "object",
306
- "required": [
307
- "family",
308
- "size",
309
- "weight",
310
- "color",
311
- "opacity",
312
- "background",
313
- "stroke"
314
- ]
315
- },
316
- "RichTextStroke": {
317
- "properties": {
318
- "width": {
319
- "anyOf": [
320
- {
321
- "type": "number",
322
- "minimum": 0
323
- },
324
- {
325
- "type": "null"
326
- }
327
- ]
328
- },
329
- "color": {
330
- "anyOf": [
331
- {
332
- "type": "string",
333
- "enum": [
334
- "#000000"
335
- ]
336
- },
337
- {
338
- "type": "null"
339
- }
340
- ]
341
- },
342
- "opacity": {
343
- "anyOf": [
344
- {
345
- "type": "number",
346
- "minimum": 0,
347
- "maximum": 1
348
- },
349
- {
350
- "type": "null"
351
- }
352
- ]
353
- }
354
- },
355
- "additionalProperties": false,
356
- "type": "object",
357
- "required": [
358
- "width",
359
- "color",
360
- "opacity"
361
- ]
362
- },
363
305
  "RichTextStyle": {
364
306
  "properties": {
365
307
  "letterSpacing": {
@@ -506,6 +448,53 @@
506
448
  "additionalProperties": false,
507
449
  "type": "object"
508
450
  },
451
+ "RichTextStroke": {
452
+ "properties": {
453
+ "width": {
454
+ "anyOf": [
455
+ {
456
+ "type": "number",
457
+ "minimum": 0
458
+ },
459
+ {
460
+ "type": "null"
461
+ }
462
+ ]
463
+ },
464
+ "color": {
465
+ "anyOf": [
466
+ {
467
+ "type": "string",
468
+ "enum": [
469
+ "#000000"
470
+ ]
471
+ },
472
+ {
473
+ "type": "null"
474
+ }
475
+ ]
476
+ },
477
+ "opacity": {
478
+ "anyOf": [
479
+ {
480
+ "type": "number",
481
+ "minimum": 0,
482
+ "maximum": 1
483
+ },
484
+ {
485
+ "type": "null"
486
+ }
487
+ ]
488
+ }
489
+ },
490
+ "additionalProperties": false,
491
+ "type": "object",
492
+ "required": [
493
+ "width",
494
+ "color",
495
+ "opacity"
496
+ ]
497
+ },
509
498
  "RichTextShadow": {
510
499
  "properties": {
511
500
  "offsetX": {
@@ -847,6 +836,98 @@
847
836
  "animation"
848
837
  ]
849
838
  },
839
+ "RichTextFont": {
840
+ "properties": {
841
+ "family": {
842
+ "anyOf": [
843
+ {
844
+ "type": "string",
845
+ "enum": [
846
+ "Open Sans"
847
+ ]
848
+ },
849
+ {
850
+ "type": "null"
851
+ }
852
+ ]
853
+ },
854
+ "size": {
855
+ "anyOf": [
856
+ {
857
+ "type": "integer",
858
+ "minimum": 1,
859
+ "maximum": 500
860
+ },
861
+ {
862
+ "type": "null"
863
+ }
864
+ ]
865
+ },
866
+ "weight": {
867
+ "anyOf": [
868
+ {
869
+ "type": "string"
870
+ },
871
+ {
872
+ "type": "null"
873
+ }
874
+ ]
875
+ },
876
+ "color": {
877
+ "anyOf": [
878
+ {
879
+ "type": "string"
880
+ },
881
+ {
882
+ "type": "null"
883
+ }
884
+ ]
885
+ },
886
+ "opacity": {
887
+ "anyOf": [
888
+ {
889
+ "type": "number",
890
+ "minimum": 0,
891
+ "maximum": 1
892
+ },
893
+ {
894
+ "type": "null"
895
+ }
896
+ ]
897
+ },
898
+ "background": {
899
+ "anyOf": [
900
+ {
901
+ "type": "string"
902
+ },
903
+ {
904
+ "type": "null"
905
+ }
906
+ ]
907
+ },
908
+ "stroke": {
909
+ "anyOf": [
910
+ {
911
+ "$ref": "#/$defs/RichTextStroke"
912
+ },
913
+ {
914
+ "type": "null"
915
+ }
916
+ ]
917
+ }
918
+ },
919
+ "additionalProperties": false,
920
+ "type": "object",
921
+ "required": [
922
+ "family",
923
+ "size",
924
+ "weight",
925
+ "color",
926
+ "opacity",
927
+ "background",
928
+ "stroke"
929
+ ]
930
+ },
850
931
  "RichTextAlignment": {
851
932
  "properties": {
852
933
  "horizontal": {
@@ -2051,8 +2051,95 @@
2051
2051
  "font": {
2052
2052
  "anyOf": [
2053
2053
  {
2054
+ "type": "object",
2054
2055
  "description": "Font styling properties for inactive words.",
2055
- "$ref": "#/$defs/RichTextFont"
2056
+ "properties": {
2057
+ "family": {
2058
+ "anyOf": [
2059
+ {
2060
+ "type": "string",
2061
+ "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Roboto\".",
2062
+ "enum": [
2063
+ "Roboto"
2064
+ ]
2065
+ },
2066
+ {
2067
+ "type": "null"
2068
+ }
2069
+ ]
2070
+ },
2071
+ "size": {
2072
+ "anyOf": [
2073
+ {
2074
+ "type": "integer",
2075
+ "description": "The size of the font in pixels (px). Must be between 1 and 500.",
2076
+ "minimum": 1,
2077
+ "maximum": 500
2078
+ },
2079
+ {
2080
+ "type": "null"
2081
+ }
2082
+ ]
2083
+ },
2084
+ "weight": {
2085
+ "anyOf": [
2086
+ {
2087
+ "type": "string",
2088
+ "description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest)."
2089
+ },
2090
+ {
2091
+ "type": "null"
2092
+ }
2093
+ ]
2094
+ },
2095
+ "color": {
2096
+ "anyOf": [
2097
+ {
2098
+ "type": "string",
2099
+ "description": "The text color using hexadecimal color notation.",
2100
+ "enum": [
2101
+ "#ffffff"
2102
+ ]
2103
+ },
2104
+ {
2105
+ "type": "null"
2106
+ }
2107
+ ]
2108
+ },
2109
+ "opacity": {
2110
+ "anyOf": [
2111
+ {
2112
+ "type": "number",
2113
+ "description": "The opacity of the text where 1 is opaque and 0 is transparent.",
2114
+ "minimum": 0,
2115
+ "maximum": 1
2116
+ },
2117
+ {
2118
+ "type": "null"
2119
+ }
2120
+ ]
2121
+ },
2122
+ "background": {
2123
+ "anyOf": [
2124
+ {
2125
+ "type": "string",
2126
+ "description": "The background color behind the text using hexadecimal color notation."
2127
+ },
2128
+ {
2129
+ "type": "null"
2130
+ }
2131
+ ]
2132
+ }
2133
+ },
2134
+ "additionalProperties": false,
2135
+ "required": [
2136
+ "family",
2137
+ "size",
2138
+ "weight",
2139
+ "color",
2140
+ "opacity",
2141
+ "background"
2142
+ ]
2056
2143
  },
2057
2144
  {
2058
2145
  "type": "null"
@@ -1879,7 +1879,88 @@
1879
1879
  "font": {
1880
1880
  "anyOf": [
1881
1881
  {
1882
- "$ref": "#/$defs/RichTextFont"
1882
+ "type": "object",
1883
+ "properties": {
1884
+ "family": {
1885
+ "anyOf": [
1886
+ {
1887
+ "type": "string",
1888
+ "enum": [
1889
+ "Roboto"
1890
+ ]
1891
+ },
1892
+ {
1893
+ "type": "null"
1894
+ }
1895
+ ]
1896
+ },
1897
+ "size": {
1898
+ "anyOf": [
1899
+ {
1900
+ "type": "integer",
1901
+ "minimum": 1,
1902
+ "maximum": 500
1903
+ },
1904
+ {
1905
+ "type": "null"
1906
+ }
1907
+ ]
1908
+ },
1909
+ "weight": {
1910
+ "anyOf": [
1911
+ {
1912
+ "type": "string"
1913
+ },
1914
+ {
1915
+ "type": "null"
1916
+ }
1917
+ ]
1918
+ },
1919
+ "color": {
1920
+ "anyOf": [
1921
+ {
1922
+ "type": "string",
1923
+ "enum": [
1924
+ "#ffffff"
1925
+ ]
1926
+ },
1927
+ {
1928
+ "type": "null"
1929
+ }
1930
+ ]
1931
+ },
1932
+ "opacity": {
1933
+ "anyOf": [
1934
+ {
1935
+ "type": "number",
1936
+ "minimum": 0,
1937
+ "maximum": 1
1938
+ },
1939
+ {
1940
+ "type": "null"
1941
+ }
1942
+ ]
1943
+ },
1944
+ "background": {
1945
+ "anyOf": [
1946
+ {
1947
+ "type": "string"
1948
+ },
1949
+ {
1950
+ "type": "null"
1951
+ }
1952
+ ]
1953
+ }
1954
+ },
1955
+ "additionalProperties": false,
1956
+ "required": [
1957
+ "family",
1958
+ "size",
1959
+ "weight",
1960
+ "color",
1961
+ "opacity",
1962
+ "background"
1963
+ ]
1883
1964
  },
1884
1965
  {
1885
1966
  "type": "null"
@@ -1766,7 +1766,88 @@
1766
1766
  "font": {
1767
1767
  "anyOf": [
1768
1768
  {
1769
- "$ref": "#/$defs/RichTextFont"
1769
+ "type": "object",
1770
+ "properties": {
1771
+ "family": {
1772
+ "anyOf": [
1773
+ {
1774
+ "type": "string",
1775
+ "enum": [
1776
+ "Roboto"
1777
+ ]
1778
+ },
1779
+ {
1780
+ "type": "null"
1781
+ }
1782
+ ]
1783
+ },
1784
+ "size": {
1785
+ "anyOf": [
1786
+ {
1787
+ "type": "integer",
1788
+ "minimum": 1,
1789
+ "maximum": 500
1790
+ },
1791
+ {
1792
+ "type": "null"
1793
+ }
1794
+ ]
1795
+ },
1796
+ "weight": {
1797
+ "anyOf": [
1798
+ {
1799
+ "type": "string"
1800
+ },
1801
+ {
1802
+ "type": "null"
1803
+ }
1804
+ ]
1805
+ },
1806
+ "color": {
1807
+ "anyOf": [
1808
+ {
1809
+ "type": "string",
1810
+ "enum": [
1811
+ "#ffffff"
1812
+ ]
1813
+ },
1814
+ {
1815
+ "type": "null"
1816
+ }
1817
+ ]
1818
+ },
1819
+ "opacity": {
1820
+ "anyOf": [
1821
+ {
1822
+ "type": "number",
1823
+ "minimum": 0,
1824
+ "maximum": 1
1825
+ },
1826
+ {
1827
+ "type": "null"
1828
+ }
1829
+ ]
1830
+ },
1831
+ "background": {
1832
+ "anyOf": [
1833
+ {
1834
+ "type": "string"
1835
+ },
1836
+ {
1837
+ "type": "null"
1838
+ }
1839
+ ]
1840
+ }
1841
+ },
1842
+ "additionalProperties": false,
1843
+ "required": [
1844
+ "family",
1845
+ "size",
1846
+ "weight",
1847
+ "color",
1848
+ "opacity",
1849
+ "background"
1850
+ ]
1770
1851
  },
1771
1852
  {
1772
1853
  "type": "null"
package/dist/schema.d.ts CHANGED
@@ -997,7 +997,42 @@ export interface components {
997
997
  /** @description Pre-provided word-level timing data. Use this instead of `src` when you have word timestamps from an external source. Mutually exclusive with `src`. */
998
998
  words?: components["schemas"]["WordTiming"][];
999
999
  /** @description Font styling properties for inactive words. */
1000
- font?: components["schemas"]["RichTextFont"];
1000
+ font?: {
1001
+ /**
1002
+ * @description The font family name. This must be the Family name embedded in the font, i.e. "Roboto".
1003
+ * @default Roboto
1004
+ * @example Roboto
1005
+ */
1006
+ family?: string;
1007
+ /**
1008
+ * @description The size of the font in pixels (px). Must be between 1 and 500.
1009
+ * @default 24
1010
+ * @example 48
1011
+ */
1012
+ size?: number;
1013
+ /**
1014
+ * @description The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).
1015
+ * @default 400
1016
+ */
1017
+ weight?: unknown;
1018
+ /**
1019
+ * @description The text color using hexadecimal color notation.
1020
+ * @default #ffffff
1021
+ * @example #ffffff
1022
+ */
1023
+ color?: string;
1024
+ /**
1025
+ * @description The opacity of the text where 1 is opaque and 0 is transparent.
1026
+ * @default 1
1027
+ * @example 0.9
1028
+ */
1029
+ opacity?: number;
1030
+ /**
1031
+ * @description The background color behind the text using hexadecimal color notation.
1032
+ * @example #000000
1033
+ */
1034
+ background?: string;
1035
+ };
1001
1036
  /** @description Text style properties including spacing, line height, and transformations. */
1002
1037
  style?: components["schemas"]["RichTextStyle"];
1003
1038
  /** @description Text stroke (outline) properties for inactive words. */