@shotstack/schemas 1.9.8 → 1.9.10

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.
@@ -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
@@ -897,7 +897,7 @@ export interface components {
897
897
  * flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
898
898
  * captions.
899
899
  *
900
- * To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
900
+ * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
901
901
  * matching start and end time.
902
902
  */
903
903
  CaptionAsset: {
@@ -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: {
@@ -1335,13 +1339,6 @@ export interface components {
1335
1339
  /**
1336
1340
  * @description The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
1337
1341
  *
1338
- * ```json
1339
- * {
1340
- * "type": "svg",
1341
- * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
1342
- * }
1343
- * ```
1344
- *
1345
1342
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
1346
1343
  * `<line>`, `<polygon>`, `<polyline>`
1347
1344
  *
@@ -1355,7 +1352,7 @@ export interface components {
1355
1352
  * See [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.
1356
1353
  * @example {
1357
1354
  * "type": "svg",
1358
- * "src": "<svg width=\"200\" height=\"200\"><rect x=\"10\" y=\"10\" width=\"180\" height=\"180\" rx=\"20\" fill=\"#3498db\" stroke=\"#2C3E50\" stroke-width=\"3\"/></svg>"
1355
+ * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
1359
1356
  * }
1360
1357
  */
1361
1358
  SvgAsset: {
@@ -1365,8 +1362,9 @@ export interface components {
1365
1362
  */
1366
1363
  type: "svg";
1367
1364
  /**
1368
- * @description Raw SVG markup string. The shape, fill, stroke, dimensions and opacity
1369
- * are automatically extracted from the SVG content.
1365
+ * @description Raw SVG markup string. The SVG must contain valid SVG elements. The shape,
1366
+ * fill, stroke, dimensions and opacity are automatically extracted from the
1367
+ * SVG content.
1370
1368
  * @example <svg width="100" height="100"><circle cx="50" cy="50" r="40" fill="#3498db"/></svg>
1371
1369
  */
1372
1370
  src: string;
@@ -122,7 +122,7 @@ exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
122
122
  * flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
123
123
  * captions.
124
124
  *
125
- * To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
125
+ * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
126
126
  * matching start and end time.
127
127
  *
128
128
  */
@@ -788,6 +788,8 @@ exports.templateResponseSchema = exports.templateresponseTemplateResponseSchema;
788
788
  * Font properties for the active/highlighted word.
789
789
  */
790
790
  exports.richcaptionpropertiesRichCaptionActiveFontSchema = zod_1.z.object({
791
+ family: zod_1.z.optional(zod_1.z.string()),
792
+ weight: zod_1.z.optional(zod_1.z.unknown()).default('400'),
791
793
  color: zod_1.z.optional(zod_1.z.union([zod_1.z.string().regex(/^#[A-Fa-f0-9]{6}$/), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
792
794
  background: zod_1.z.optional(zod_1.z.union([zod_1.z.string().regex(/^#[A-Fa-f0-9]{6}$/), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
793
795
  opacity: zod_1.z.optional(zod_1.z.union([zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
@@ -1111,14 +1113,7 @@ exports.richcaptionpropertiesRichCaptionActiveSchema = zod_1.z.object({
1111
1113
  shadow: zod_1.z.optional(zod_1.z.union([
1112
1114
  exports.richtextpropertiesRichTextShadowSchema,
1113
1115
  zod_1.z.enum(['none'])
1114
- ])),
1115
- scale: zod_1.z.optional(zod_1.z.union([zod_1.z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
1116
- return undefined; if (Array.isArray(v))
1117
- return v; if (typeof v === 'string') {
1118
- if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v))
1119
- return v;
1120
- return Number(v);
1121
- } return v; }), zod_1.z.number().gte(0.5).lte(2)), zod_1.z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1)
1116
+ ]))
1122
1117
  }).strict();
1123
1118
  exports.richCaptionActiveSchema = exports.richcaptionpropertiesRichCaptionActiveSchema;
1124
1119
  /**
@@ -1633,13 +1628,6 @@ exports.soundtrackSchema = exports.soundtrackSoundtrackSchema;
1633
1628
  /**
1634
1629
  * The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
1635
1630
  *
1636
- * ```json
1637
- * {
1638
- * "type": "svg",
1639
- * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
1640
- * }
1641
- * ```
1642
- *
1643
1631
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
1644
1632
  * `<line>`, `<polygon>`, `<polyline>`
1645
1633
  *