@shotstack/schemas 1.8.6 → 1.8.7

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 +50 -75
  2. package/dist/json-schema/asset.json +95 -101
  3. package/dist/json-schema/clip.json +95 -101
  4. package/dist/json-schema/edit.json +95 -101
  5. package/dist/json-schema/rich-caption-asset.json +234 -240
  6. package/dist/json-schema/schemas.json +103 -111
  7. package/dist/json-schema/timeline.json +95 -101
  8. package/dist/json-schema/track.json +95 -101
  9. package/dist/schema.d.ts +40 -47
  10. package/dist/zod/zod.gen.cjs +31 -51
  11. package/dist/zod/zod.gen.d.ts +494 -1158
  12. package/dist/zod/zod.gen.js +26 -46
  13. package/dist/zod/zod.gen.ts +15 -18
  14. package/package.json +1 -1
  15. package/dist/json-schema/word-timing.json +0 -44
package/dist/json-schema/schemas.json CHANGED
@@ -2024,35 +2024,101 @@
2024
2024
  "type": "string"
2025
2025
  },
2026
2026
  "src": {
2027
- "anyOf": [
2028
- {
2029
- "type": "string",
2030
- "description": "The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. Mutually exclusive with `words`."
2031
- },
2032
- {
2033
- "type": "null"
2034
- }
2035
- ]
2036
- },
2037
- "words": {
2038
- "anyOf": [
2039
- {
2040
- "type": "array",
2041
- "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`.",
2042
- "items": {
2043
- "$ref": "#/$defs/WordTiming"
2044
- }
2045
- },
2046
- {
2047
- "type": "null"
2048
- }
2049
- ]
2027
+ "description": "The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip.",
2028
+ "type": "string"
2050
2029
  },
2051
2030
  "font": {
2052
2031
  "anyOf": [
2053
2032
  {
2033
+ "type": "object",
2054
2034
  "description": "Font styling properties for inactive words.",
2055
- "$ref": "#/$defs/RichTextFont"
2035
+ "properties": {
2036
+ "family": {
2037
+ "anyOf": [
2038
+ {
2039
+ "type": "string",
2040
+ "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Roboto\".",
2041
+ "enum": [
2042
+ "Roboto"
2043
+ ]
2044
+ },
2045
+ {
2046
+ "type": "null"
2047
+ }
2048
+ ]
2049
+ },
2050
+ "size": {
2051
+ "anyOf": [
2052
+ {
2053
+ "type": "integer",
2054
+ "description": "The size of the font in pixels (px). Must be between 1 and 500.",
2055
+ "minimum": 1,
2056
+ "maximum": 500
2057
+ },
2058
+ {
2059
+ "type": "null"
2060
+ }
2061
+ ]
2062
+ },
2063
+ "weight": {
2064
+ "anyOf": [
2065
+ {
2066
+ "type": "string",
2067
+ "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)."
2068
+ },
2069
+ {
2070
+ "type": "null"
2071
+ }
2072
+ ]
2073
+ },
2074
+ "color": {
2075
+ "anyOf": [
2076
+ {
2077
+ "type": "string",
2078
+ "description": "The text color using hexadecimal color notation.",
2079
+ "enum": [
2080
+ "#ffffff"
2081
+ ]
2082
+ },
2083
+ {
2084
+ "type": "null"
2085
+ }
2086
+ ]
2087
+ },
2088
+ "opacity": {
2089
+ "anyOf": [
2090
+ {
2091
+ "type": "number",
2092
+ "description": "The opacity of the text where 1 is opaque and 0 is transparent.",
2093
+ "minimum": 0,
2094
+ "maximum": 1
2095
+ },
2096
+ {
2097
+ "type": "null"
2098
+ }
2099
+ ]
2100
+ },
2101
+ "background": {
2102
+ "anyOf": [
2103
+ {
2104
+ "type": "string",
2105
+ "description": "The background color behind the text using hexadecimal color notation."
2106
+ },
2107
+ {
2108
+ "type": "null"
2109
+ }
2110
+ ]
2111
+ }
2112
+ },
2113
+ "additionalProperties": false,
2114
+ "required": [
2115
+ "family",
2116
+ "size",
2117
+ "weight",
2118
+ "color",
2119
+ "opacity",
2120
+ "background"
2121
+ ]
2056
2122
  },
2057
2123
  {
2058
2124
  "type": "null"
@@ -2103,6 +2169,17 @@
2103
2169
  }
2104
2170
  ]
2105
2171
  },
2172
+ "border": {
2173
+ "anyOf": [
2174
+ {
2175
+ "description": "Border styling properties for the caption bounding box.",
2176
+ "$ref": "#/$defs/RichTextAsset/properties/border"
2177
+ },
2178
+ {
2179
+ "type": "null"
2180
+ }
2181
+ ]
2182
+ },
2106
2183
  "padding": {
2107
2184
  "description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
2108
2185
  "anyOf": [
@@ -2151,107 +2228,22 @@
2151
2228
  "type": "null"
2152
2229
  }
2153
2230
  ]
2154
- },
2155
- "position": {
2156
- "anyOf": [
2157
- {
2158
- "type": "string",
2159
- "description": "Vertical position of the caption on screen.",
2160
- "enum": [
2161
- "top",
2162
- "center",
2163
- "bottom"
2164
- ]
2165
- },
2166
- {
2167
- "type": "null"
2168
- }
2169
- ]
2170
- },
2171
- "maxWidth": {
2172
- "anyOf": [
2173
- {
2174
- "type": "number",
2175
- "description": "Maximum width of the caption as a ratio of the frame width. Must be between 0.1 and 1.",
2176
- "minimum": 0.1,
2177
- "maximum": 1
2178
- },
2179
- {
2180
- "type": "null"
2181
- }
2182
- ]
2183
- },
2184
- "maxLines": {
2185
- "anyOf": [
2186
- {
2187
- "type": "integer",
2188
- "description": "Maximum number of lines to display at once. Must be between 1 and 10.",
2189
- "minimum": 1,
2190
- "maximum": 10
2191
- },
2192
- {
2193
- "type": "null"
2194
- }
2195
- ]
2196
2231
  }
2197
2232
  },
2198
2233
  "additionalProperties": false,
2199
2234
  "required": [
2200
2235
  "type",
2201
2236
  "src",
2202
- "words",
2203
2237
  "font",
2204
2238
  "style",
2205
2239
  "stroke",
2206
2240
  "shadow",
2207
2241
  "background",
2242
+ "border",
2208
2243
  "padding",
2209
2244
  "align",
2210
2245
  "active",
2211
- "wordAnimation",
2212
- "position",
2213
- "maxWidth",
2214
- "maxLines"
2215
- ]
2216
- },
2217
- "WordTiming": {
2218
- "description": "Word-level timing information for caption animation.",
2219
- "type": "object",
2220
- "properties": {
2221
- "text": {
2222
- "description": "The word text to display.",
2223
- "type": "string"
2224
- },
2225
- "start": {
2226
- "description": "Start time of the word in milliseconds.",
2227
- "type": "number",
2228
- "minimum": 0
2229
- },
2230
- "end": {
2231
- "description": "End time of the word in milliseconds.",
2232
- "type": "number",
2233
- "minimum": 0
2234
- },
2235
- "confidence": {
2236
- "anyOf": [
2237
- {
2238
- "type": "number",
2239
- "description": "Speech-to-text confidence score between 0 and 1.",
2240
- "minimum": 0,
2241
- "maximum": 1
2242
- },
2243
- {
2244
- "type": "null"
2245
- }
2246
- ]
2247
- }
2248
- },
2249
- "additionalProperties": false,
2250
- "required": [
2251
- "text",
2252
- "start",
2253
- "end",
2254
- "confidence"
2246
+ "wordAnimation"
2255
2247
  ]
2256
2248
  },
2257
2249
  "RichCaptionActive": {
package/dist/json-schema/timeline.json CHANGED
@@ -1854,32 +1854,93 @@
1854
1854
  "type": "string"
1855
1855
  },
1856
1856
  "src": {
1857
- "anyOf": [
1858
- {
1859
- "type": "string"
1860
- },
1861
- {
1862
- "type": "null"
1863
- }
1864
- ]
1865
- },
1866
- "words": {
1867
- "anyOf": [
1868
- {
1869
- "type": "array",
1870
- "items": {
1871
- "$ref": "#/$defs/WordTiming"
1872
- }
1873
- },
1874
- {
1875
- "type": "null"
1876
- }
1877
- ]
1857
+ "type": "string"
1878
1858
  },
1879
1859
  "font": {
1880
1860
  "anyOf": [
1881
1861
  {
1882
- "$ref": "#/$defs/RichTextFont"
1862
+ "type": "object",
1863
+ "properties": {
1864
+ "family": {
1865
+ "anyOf": [
1866
+ {
1867
+ "type": "string",
1868
+ "enum": [
1869
+ "Roboto"
1870
+ ]
1871
+ },
1872
+ {
1873
+ "type": "null"
1874
+ }
1875
+ ]
1876
+ },
1877
+ "size": {
1878
+ "anyOf": [
1879
+ {
1880
+ "type": "integer",
1881
+ "minimum": 1,
1882
+ "maximum": 500
1883
+ },
1884
+ {
1885
+ "type": "null"
1886
+ }
1887
+ ]
1888
+ },
1889
+ "weight": {
1890
+ "anyOf": [
1891
+ {
1892
+ "type": "string"
1893
+ },
1894
+ {
1895
+ "type": "null"
1896
+ }
1897
+ ]
1898
+ },
1899
+ "color": {
1900
+ "anyOf": [
1901
+ {
1902
+ "type": "string",
1903
+ "enum": [
1904
+ "#ffffff"
1905
+ ]
1906
+ },
1907
+ {
1908
+ "type": "null"
1909
+ }
1910
+ ]
1911
+ },
1912
+ "opacity": {
1913
+ "anyOf": [
1914
+ {
1915
+ "type": "number",
1916
+ "minimum": 0,
1917
+ "maximum": 1
1918
+ },
1919
+ {
1920
+ "type": "null"
1921
+ }
1922
+ ]
1923
+ },
1924
+ "background": {
1925
+ "anyOf": [
1926
+ {
1927
+ "type": "string"
1928
+ },
1929
+ {
1930
+ "type": "null"
1931
+ }
1932
+ ]
1933
+ }
1934
+ },
1935
+ "additionalProperties": false,
1936
+ "required": [
1937
+ "family",
1938
+ "size",
1939
+ "weight",
1940
+ "color",
1941
+ "opacity",
1942
+ "background"
1943
+ ]
1883
1944
  },
1884
1945
  {
1885
1946
  "type": "null"
@@ -1926,6 +1987,16 @@
1926
1987
  }
1927
1988
  ]
1928
1989
  },
1990
+ "border": {
1991
+ "anyOf": [
1992
+ {
1993
+ "$ref": "#/$defs/RichTextAsset/properties/border"
1994
+ },
1995
+ {
1996
+ "type": "null"
1997
+ }
1998
+ ]
1999
+ },
1929
2000
  "padding": {
1930
2001
  "anyOf": [
1931
2002
  {
@@ -1969,99 +2040,22 @@
1969
2040
  "type": "null"
1970
2041
  }
1971
2042
  ]
1972
- },
1973
- "position": {
1974
- "anyOf": [
1975
- {
1976
- "type": "string",
1977
- "enum": [
1978
- "top",
1979
- "center",
1980
- "bottom"
1981
- ]
1982
- },
1983
- {
1984
- "type": "null"
1985
- }
1986
- ]
1987
- },
1988
- "maxWidth": {
1989
- "anyOf": [
1990
- {
1991
- "type": "number",
1992
- "minimum": 0.1,
1993
- "maximum": 1
1994
- },
1995
- {
1996
- "type": "null"
1997
- }
1998
- ]
1999
- },
2000
- "maxLines": {
2001
- "anyOf": [
2002
- {
2003
- "type": "integer",
2004
- "minimum": 1,
2005
- "maximum": 10
2006
- },
2007
- {
2008
- "type": "null"
2009
- }
2010
- ]
2011
2043
  }
2012
2044
  },
2013
2045
  "additionalProperties": false,
2014
2046
  "required": [
2015
2047
  "type",
2016
2048
  "src",
2017
- "words",
2018
2049
  "font",
2019
2050
  "style",
2020
2051
  "stroke",
2021
2052
  "shadow",
2022
2053
  "background",
2054
+ "border",
2023
2055
  "padding",
2024
2056
  "align",
2025
2057
  "active",
2026
- "wordAnimation",
2027
- "position",
2028
- "maxWidth",
2029
- "maxLines"
2030
- ]
2031
- },
2032
- "WordTiming": {
2033
- "type": "object",
2034
- "properties": {
2035
- "text": {
2036
- "type": "string"
2037
- },
2038
- "start": {
2039
- "type": "number",
2040
- "minimum": 0
2041
- },
2042
- "end": {
2043
- "type": "number",
2044
- "minimum": 0
2045
- },
2046
- "confidence": {
2047
- "anyOf": [
2048
- {
2049
- "type": "number",
2050
- "minimum": 0,
2051
- "maximum": 1
2052
- },
2053
- {
2054
- "type": "null"
2055
- }
2056
- ]
2057
- }
2058
- },
2059
- "additionalProperties": false,
2060
- "required": [
2061
- "text",
2062
- "start",
2063
- "end",
2064
- "confidence"
2058
+ "wordAnimation"
2065
2059
  ]
2066
2060
  },
2067
2061
  "RichCaptionActive": {