@shotstack/schemas 1.9.8 → 1.9.9

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.
@@ -1896,7 +1896,7 @@
1896
1896
  "example": "uppercase"
1897
1897
  },
1898
1898
  "size": {
1899
- "description": "The font size of the active word in pixels. Overrides the scale property when set.",
1899
+ "description": "The font size in pixels. Can be used as an alternative to font.size.",
1900
1900
  "type": "number",
1901
1901
  "minimum": 1,
1902
1902
  "maximum": 500,
@@ -1974,6 +1974,15 @@
1974
1974
  "description": "Font properties for the active/highlighted word.",
1975
1975
  "type": "object",
1976
1976
  "properties": {
1977
+ "family": {
1978
+ "description": "The font family for the active word. Inherits from the base font.family when not set.",
1979
+ "type": "string",
1980
+ "example": "Roboto"
1981
+ },
1982
+ "weight": {
1983
+ "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n",
1984
+ "default": "400"
1985
+ },
1977
1986
  "color": {
1978
1987
  "description": "The active word color using hexadecimal color notation.",
1979
1988
  "type": "string",
@@ -1995,7 +2004,7 @@
1995
2004
  "example": 1
1996
2005
  },
1997
2006
  "size": {
1998
- "description": "The font size of the active word in pixels. Overrides the scale property when set.",
2007
+ "description": "The font size of the active word in pixels.",
1999
2008
  "type": "number",
2000
2009
  "minimum": 1,
2001
2010
  "maximum": 500,
@@ -2050,14 +2059,6 @@
2050
2059
  ]
2051
2060
  }
2052
2061
  ]
2053
- },
2054
- "scale": {
2055
- "description": "Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.",
2056
- "type": "number",
2057
- "minimum": 0.5,
2058
- "maximum": 2,
2059
- "default": 1,
2060
- "example": 1.2
2061
2062
  }
2062
2063
  },
2063
2064
  "additionalProperties": false
@@ -1828,31 +1828,38 @@
1828
1828
  "type": "null"
1829
1829
  }
1830
1830
  ]
1831
- },
1832
- "scale": {
1833
- "anyOf": [
1834
- {
1835
- "type": "number",
1836
- "minimum": 0.5,
1837
- "maximum": 2
1838
- },
1839
- {
1840
- "type": "null"
1841
- }
1842
- ]
1843
1831
  }
1844
1832
  },
1845
1833
  "additionalProperties": false,
1846
1834
  "required": [
1847
1835
  "font",
1848
1836
  "stroke",
1849
- "shadow",
1850
- "scale"
1837
+ "shadow"
1851
1838
  ]
1852
1839
  },
1853
1840
  "RichCaptionActiveFont": {
1854
1841
  "type": "object",
1855
1842
  "properties": {
1843
+ "family": {
1844
+ "anyOf": [
1845
+ {
1846
+ "type": "string"
1847
+ },
1848
+ {
1849
+ "type": "null"
1850
+ }
1851
+ ]
1852
+ },
1853
+ "weight": {
1854
+ "anyOf": [
1855
+ {
1856
+ "type": "string"
1857
+ },
1858
+ {
1859
+ "type": "null"
1860
+ }
1861
+ ]
1862
+ },
1856
1863
  "color": {
1857
1864
  "anyOf": [
1858
1865
  {
@@ -1915,6 +1922,8 @@
1915
1922
  },
1916
1923
  "additionalProperties": false,
1917
1924
  "required": [
1925
+ "family",
1926
+ "weight",
1918
1927
  "color",
1919
1928
  "background",
1920
1929
  "opacity",
@@ -2060,31 +2060,38 @@
2060
2060
  "type": "null"
2061
2061
  }
2062
2062
  ]
2063
- },
2064
- "scale": {
2065
- "anyOf": [
2066
- {
2067
- "type": "number",
2068
- "minimum": 0.5,
2069
- "maximum": 2
2070
- },
2071
- {
2072
- "type": "null"
2073
- }
2074
- ]
2075
2063
  }
2076
2064
  },
2077
2065
  "additionalProperties": false,
2078
2066
  "required": [
2079
2067
  "font",
2080
2068
  "stroke",
2081
- "shadow",
2082
- "scale"
2069
+ "shadow"
2083
2070
  ]
2084
2071
  },
2085
2072
  "RichCaptionActiveFont": {
2086
2073
  "type": "object",
2087
2074
  "properties": {
2075
+ "family": {
2076
+ "anyOf": [
2077
+ {
2078
+ "type": "string"
2079
+ },
2080
+ {
2081
+ "type": "null"
2082
+ }
2083
+ ]
2084
+ },
2085
+ "weight": {
2086
+ "anyOf": [
2087
+ {
2088
+ "type": "string"
2089
+ },
2090
+ {
2091
+ "type": "null"
2092
+ }
2093
+ ]
2094
+ },
2088
2095
  "color": {
2089
2096
  "anyOf": [
2090
2097
  {
@@ -2147,6 +2154,8 @@
2147
2154
  },
2148
2155
  "additionalProperties": false,
2149
2156
  "required": [
2157
+ "family",
2158
+ "weight",
2150
2159
  "color",
2151
2160
  "background",
2152
2161
  "opacity",
@@ -2244,31 +2244,38 @@
2244
2244
  "type": "null"
2245
2245
  }
2246
2246
  ]
2247
- },
2248
- "scale": {
2249
- "anyOf": [
2250
- {
2251
- "type": "number",
2252
- "minimum": 0.5,
2253
- "maximum": 2
2254
- },
2255
- {
2256
- "type": "null"
2257
- }
2258
- ]
2259
2247
  }
2260
2248
  },
2261
2249
  "additionalProperties": false,
2262
2250
  "required": [
2263
2251
  "font",
2264
2252
  "stroke",
2265
- "shadow",
2266
- "scale"
2253
+ "shadow"
2267
2254
  ]
2268
2255
  },
2269
2256
  "RichCaptionActiveFont": {
2270
2257
  "type": "object",
2271
2258
  "properties": {
2259
+ "family": {
2260
+ "anyOf": [
2261
+ {
2262
+ "type": "string"
2263
+ },
2264
+ {
2265
+ "type": "null"
2266
+ }
2267
+ ]
2268
+ },
2269
+ "weight": {
2270
+ "anyOf": [
2271
+ {
2272
+ "type": "string"
2273
+ },
2274
+ {
2275
+ "type": "null"
2276
+ }
2277
+ ]
2278
+ },
2272
2279
  "color": {
2273
2280
  "anyOf": [
2274
2281
  {
@@ -2331,6 +2338,8 @@
2331
2338
  },
2332
2339
  "additionalProperties": false,
2333
2340
  "required": [
2341
+ "family",
2342
+ "weight",
2334
2343
  "color",
2335
2344
  "background",
2336
2345
  "opacity",
@@ -5,6 +5,28 @@
5
5
  "description": "Font properties for the active/highlighted word.",
6
6
  "type": "object",
7
7
  "properties": {
8
+ "family": {
9
+ "anyOf": [
10
+ {
11
+ "type": "string",
12
+ "description": "The font family for the active word. Inherits from the base font.family when not set."
13
+ },
14
+ {
15
+ "type": "null"
16
+ }
17
+ ]
18
+ },
19
+ "weight": {
20
+ "anyOf": [
21
+ {
22
+ "type": "string",
23
+ "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n"
24
+ },
25
+ {
26
+ "type": "null"
27
+ }
28
+ ]
29
+ },
8
30
  "color": {
9
31
  "anyOf": [
10
32
  {
@@ -44,7 +66,7 @@
44
66
  "anyOf": [
45
67
  {
46
68
  "type": "number",
47
- "description": "The font size of the active word in pixels. Overrides the scale property when set.",
69
+ "description": "The font size of the active word in pixels.",
48
70
  "minimum": 1,
49
71
  "maximum": 500
50
72
  },
@@ -72,6 +94,8 @@
72
94
  },
73
95
  "additionalProperties": false,
74
96
  "required": [
97
+ "family",
98
+ "weight",
75
99
  "color",
76
100
  "background",
77
101
  "opacity",
@@ -49,33 +49,41 @@
49
49
  "type": "null"
50
50
  }
51
51
  ]
52
- },
53
- "scale": {
54
- "anyOf": [
55
- {
56
- "type": "number",
57
- "description": "Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.",
58
- "minimum": 0.5,
59
- "maximum": 2
60
- },
61
- {
62
- "type": "null"
63
- }
64
- ]
65
52
  }
66
53
  },
67
54
  "additionalProperties": false,
68
55
  "required": [
69
56
  "font",
70
57
  "stroke",
71
- "shadow",
72
- "scale"
58
+ "shadow"
73
59
  ],
74
60
  "$defs": {
75
61
  "RichCaptionActiveFont": {
76
62
  "description": "Font properties for the active/highlighted word.",
77
63
  "type": "object",
78
64
  "properties": {
65
+ "family": {
66
+ "anyOf": [
67
+ {
68
+ "type": "string",
69
+ "description": "The font family for the active word. Inherits from the base font.family when not set."
70
+ },
71
+ {
72
+ "type": "null"
73
+ }
74
+ ]
75
+ },
76
+ "weight": {
77
+ "anyOf": [
78
+ {
79
+ "type": "string",
80
+ "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n"
81
+ },
82
+ {
83
+ "type": "null"
84
+ }
85
+ ]
86
+ },
79
87
  "color": {
80
88
  "anyOf": [
81
89
  {
@@ -115,7 +123,7 @@
115
123
  "anyOf": [
116
124
  {
117
125
  "type": "number",
118
- "description": "The font size of the active word in pixels. Overrides the scale property when set.",
126
+ "description": "The font size of the active word in pixels.",
119
127
  "minimum": 1,
120
128
  "maximum": 500
121
129
  },
@@ -143,6 +151,8 @@
143
151
  },
144
152
  "additionalProperties": false,
145
153
  "required": [
154
+ "family",
155
+ "weight",
146
156
  "color",
147
157
  "background",
148
158
  "opacity",
@@ -1076,31 +1076,38 @@
1076
1076
  "type": "null"
1077
1077
  }
1078
1078
  ]
1079
- },
1080
- "scale": {
1081
- "anyOf": [
1082
- {
1083
- "type": "number",
1084
- "minimum": 0.5,
1085
- "maximum": 2
1086
- },
1087
- {
1088
- "type": "null"
1089
- }
1090
- ]
1091
1079
  }
1092
1080
  },
1093
1081
  "additionalProperties": false,
1094
1082
  "required": [
1095
1083
  "font",
1096
1084
  "stroke",
1097
- "shadow",
1098
- "scale"
1085
+ "shadow"
1099
1086
  ]
1100
1087
  },
1101
1088
  "RichCaptionActiveFont": {
1102
1089
  "type": "object",
1103
1090
  "properties": {
1091
+ "family": {
1092
+ "anyOf": [
1093
+ {
1094
+ "type": "string"
1095
+ },
1096
+ {
1097
+ "type": "null"
1098
+ }
1099
+ ]
1100
+ },
1101
+ "weight": {
1102
+ "anyOf": [
1103
+ {
1104
+ "type": "string"
1105
+ },
1106
+ {
1107
+ "type": "null"
1108
+ }
1109
+ ]
1110
+ },
1104
1111
  "color": {
1105
1112
  "anyOf": [
1106
1113
  {
@@ -1163,6 +1170,8 @@
1163
1170
  },
1164
1171
  "additionalProperties": false,
1165
1172
  "required": [
1173
+ "family",
1174
+ "weight",
1166
1175
  "color",
1167
1176
  "background",
1168
1177
  "opacity",
@@ -2176,7 +2176,7 @@
2176
2176
  "anyOf": [
2177
2177
  {
2178
2178
  "type": "number",
2179
- "description": "The font size of the active word in pixels. Overrides the scale property when set.",
2179
+ "description": "The font size in pixels. Can be used as an alternative to font.size.",
2180
2180
  "minimum": 1,
2181
2181
  "maximum": 500
2182
2182
  },
@@ -2386,33 +2386,41 @@
2386
2386
  "type": "null"
2387
2387
  }
2388
2388
  ]
2389
- },
2390
- "scale": {
2391
- "anyOf": [
2392
- {
2393
- "type": "number",
2394
- "description": "Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.",
2395
- "minimum": 0.5,
2396
- "maximum": 2
2397
- },
2398
- {
2399
- "type": "null"
2400
- }
2401
- ]
2402
2389
  }
2403
2390
  },
2404
2391
  "additionalProperties": false,
2405
2392
  "required": [
2406
2393
  "font",
2407
2394
  "stroke",
2408
- "shadow",
2409
- "scale"
2395
+ "shadow"
2410
2396
  ]
2411
2397
  },
2412
2398
  "RichCaptionActiveFont": {
2413
2399
  "description": "Font properties for the active/highlighted word.",
2414
2400
  "type": "object",
2415
2401
  "properties": {
2402
+ "family": {
2403
+ "anyOf": [
2404
+ {
2405
+ "type": "string",
2406
+ "description": "The font family for the active word. Inherits from the base font.family when not set."
2407
+ },
2408
+ {
2409
+ "type": "null"
2410
+ }
2411
+ ]
2412
+ },
2413
+ "weight": {
2414
+ "anyOf": [
2415
+ {
2416
+ "type": "string",
2417
+ "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n"
2418
+ },
2419
+ {
2420
+ "type": "null"
2421
+ }
2422
+ ]
2423
+ },
2416
2424
  "color": {
2417
2425
  "anyOf": [
2418
2426
  {
@@ -2452,7 +2460,7 @@
2452
2460
  "anyOf": [
2453
2461
  {
2454
2462
  "type": "number",
2455
- "description": "The font size of the active word in pixels. Overrides the scale property when set.",
2463
+ "description": "The font size of the active word in pixels.",
2456
2464
  "minimum": 1,
2457
2465
  "maximum": 500
2458
2466
  },
@@ -2480,6 +2488,8 @@
2480
2488
  },
2481
2489
  "additionalProperties": false,
2482
2490
  "required": [
2491
+ "family",
2492
+ "weight",
2483
2493
  "color",
2484
2494
  "background",
2485
2495
  "opacity",
@@ -2188,31 +2188,38 @@
2188
2188
  "type": "null"
2189
2189
  }
2190
2190
  ]
2191
- },
2192
- "scale": {
2193
- "anyOf": [
2194
- {
2195
- "type": "number",
2196
- "minimum": 0.5,
2197
- "maximum": 2
2198
- },
2199
- {
2200
- "type": "null"
2201
- }
2202
- ]
2203
2191
  }
2204
2192
  },
2205
2193
  "additionalProperties": false,
2206
2194
  "required": [
2207
2195
  "font",
2208
2196
  "stroke",
2209
- "shadow",
2210
- "scale"
2197
+ "shadow"
2211
2198
  ]
2212
2199
  },
2213
2200
  "RichCaptionActiveFont": {
2214
2201
  "type": "object",
2215
2202
  "properties": {
2203
+ "family": {
2204
+ "anyOf": [
2205
+ {
2206
+ "type": "string"
2207
+ },
2208
+ {
2209
+ "type": "null"
2210
+ }
2211
+ ]
2212
+ },
2213
+ "weight": {
2214
+ "anyOf": [
2215
+ {
2216
+ "type": "string"
2217
+ },
2218
+ {
2219
+ "type": "null"
2220
+ }
2221
+ ]
2222
+ },
2216
2223
  "color": {
2217
2224
  "anyOf": [
2218
2225
  {
@@ -2275,6 +2282,8 @@
2275
2282
  },
2276
2283
  "additionalProperties": false,
2277
2284
  "required": [
2285
+ "family",
2286
+ "weight",
2278
2287
  "color",
2279
2288
  "background",
2280
2289
  "opacity",
@@ -2075,31 +2075,38 @@
2075
2075
  "type": "null"
2076
2076
  }
2077
2077
  ]
2078
- },
2079
- "scale": {
2080
- "anyOf": [
2081
- {
2082
- "type": "number",
2083
- "minimum": 0.5,
2084
- "maximum": 2
2085
- },
2086
- {
2087
- "type": "null"
2088
- }
2089
- ]
2090
2078
  }
2091
2079
  },
2092
2080
  "additionalProperties": false,
2093
2081
  "required": [
2094
2082
  "font",
2095
2083
  "stroke",
2096
- "shadow",
2097
- "scale"
2084
+ "shadow"
2098
2085
  ]
2099
2086
  },
2100
2087
  "RichCaptionActiveFont": {
2101
2088
  "type": "object",
2102
2089
  "properties": {
2090
+ "family": {
2091
+ "anyOf": [
2092
+ {
2093
+ "type": "string"
2094
+ },
2095
+ {
2096
+ "type": "null"
2097
+ }
2098
+ ]
2099
+ },
2100
+ "weight": {
2101
+ "anyOf": [
2102
+ {
2103
+ "type": "string"
2104
+ },
2105
+ {
2106
+ "type": "null"
2107
+ }
2108
+ ]
2109
+ },
2103
2110
  "color": {
2104
2111
  "anyOf": [
2105
2112
  {
@@ -2162,6 +2169,8 @@
2162
2169
  },
2163
2170
  "additionalProperties": false,
2164
2171
  "required": [
2172
+ "family",
2173
+ "weight",
2165
2174
  "color",
2166
2175
  "background",
2167
2176
  "opacity",
package/dist/schema.d.ts CHANGED
@@ -1004,7 +1004,7 @@ export interface components {
1004
1004
  */
1005
1005
  textTransform?: "none" | "uppercase" | "lowercase" | "capitalize";
1006
1006
  /**
1007
- * @description The font size of the active word in pixels. Overrides the scale property when set.
1007
+ * @description The font size in pixels. Can be used as an alternative to font.size.
1008
1008
  * @example 120
1009
1009
  */
1010
1010
  size?: number;
@@ -1037,6 +1037,16 @@ export interface components {
1037
1037
  };
1038
1038
  /** @description Font properties for the active/highlighted word. */
1039
1039
  RichCaptionActiveFont: {
1040
+ /**
1041
+ * @description The font family for the active word. Inherits from the base font.family when not set.
1042
+ * @example Roboto
1043
+ */
1044
+ family?: string;
1045
+ /**
1046
+ * @description The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.
1047
+ * @default 400
1048
+ */
1049
+ weight?: unknown;
1040
1050
  /**
1041
1051
  * @description The active word color using hexadecimal color notation.
1042
1052
  * @example #C96741
@@ -1054,7 +1064,7 @@ export interface components {
1054
1064
  */
1055
1065
  opacity?: number;
1056
1066
  /**
1057
- * @description The font size of the active word in pixels. Overrides the scale property when set.
1067
+ * @description The font size of the active word in pixels.
1058
1068
  * @example 120
1059
1069
  */
1060
1070
  size?: number;
@@ -1074,12 +1084,6 @@ export interface components {
1074
1084
  stroke?: components["schemas"]["RichTextStroke"] | "none";
1075
1085
  /** @description Shadow properties for the active word. Set to "none" to explicitly remove the base shadow on the active word. */
1076
1086
  shadow?: components["schemas"]["RichTextShadow"] | "none";
1077
- /**
1078
- * @description Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.
1079
- * @default 1
1080
- * @example 1.2
1081
- */
1082
- scale?: number;
1083
1087
  };
1084
1088
  /** @description Word-level animation properties for caption effects. */
1085
1089
  RichCaptionAnimation: {