@shotstack/schemas 1.9.9 → 1.9.10

package/dist/api.bundled.json

@@ -1752,7 +1752,7 @@
         ]
       },
       "CaptionAsset": {
-        "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset\") or [Audio](#tocs_audioasset\") with\nmatching start and end time.\n",
+        "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.\n",
         "type": "object",
         "properties": {
           "type": {
@@ -2417,7 +2417,7 @@
         ]
       },
       "SvgAsset": {
-        "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n```json\n{\n  \"type\": \"svg\",\n  \"src\": \"<svg width=\\\"100\\\" height=\\\"100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"40\\\" fill=\\\"#FF0000\\\"/></svg>\"\n}\n```\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
+        "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
         "type": "object",
         "properties": {
           "type": {
@@ -2430,7 +2430,7 @@
             "example": "svg"
           },
           "src": {
-            "description": "Raw SVG markup string. The shape, fill, stroke, dimensions and opacity\nare automatically extracted from the SVG content.\n",
+            "description": "Raw SVG markup string. The SVG must contain valid SVG elements. The shape,\nfill, stroke, dimensions and opacity are automatically extracted from the\nSVG content.\n",
             "type": "string",
             "minLength": 1,
             "maxLength": 500000,
@@ -2444,7 +2444,7 @@
         ],
         "example": {
           "type": "svg",
-          "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>"
+          "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
         }
       },
       "Transition": {

package/dist/json-schema/caption-asset.json

@@ -2,7 +2,7 @@
   "name": "CaptionAsset",
   "strict": true,
   "schema": {
-    "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset\") or [Audio](#tocs_audioasset\") with\nmatching start and end time.\n",
+    "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.\n",
     "type": "object",
     "properties": {
       "type": {

package/dist/json-schema/schemas.json

@@ -1734,7 +1734,7 @@
       ]
     },
     "CaptionAsset": {
-      "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset\") or [Audio](#tocs_audioasset\") with\nmatching start and end time.\n",
+      "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with\nmatching start and end time.\n",
       "type": "object",
       "properties": {
         "type": {
@@ -2761,7 +2761,7 @@
       ]
     },
     "SvgAsset": {
-      "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n```json\n{\n  \"type\": \"svg\",\n  \"src\": \"<svg width=\\\"100\\\" height=\\\"100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"40\\\" fill=\\\"#FF0000\\\"/></svg>\"\n}\n```\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
+      "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
       "type": "object",
       "properties": {
         "type": {
@@ -2772,7 +2772,7 @@
           ]
         },
         "src": {
-          "description": "Raw SVG markup string. The shape, fill, stroke, dimensions and opacity\nare automatically extracted from the SVG content.\n",
+          "description": "Raw SVG markup string. The SVG must contain valid SVG elements. The shape,\nfill, stroke, dimensions and opacity are automatically extracted from the\nSVG content.\n",
           "type": "string"
         }
       },

package/dist/json-schema/svg-asset.json

@@ -2,7 +2,7 @@
   "name": "SvgAsset",
   "strict": true,
   "schema": {
-    "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n```json\n{\n  \"type\": \"svg\",\n  \"src\": \"<svg width=\\\"100\\\" height=\\\"100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"40\\\" fill=\\\"#FF0000\\\"/></svg>\"\n}\n```\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
+    "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
     "type": "object",
     "properties": {
       "type": {
@@ -13,7 +13,7 @@
         ]
       },
       "src": {
-        "description": "Raw SVG markup string. The shape, fill, stroke, dimensions and opacity\nare automatically extracted from the SVG content.\n",
+        "description": "Raw SVG markup string. The SVG must contain valid SVG elements. The shape,\nfill, stroke, dimensions and opacity are automatically extracted from the\nSVG content.\n",
         "type": "string"
       }
     },

package/dist/schema.d.ts

@@ -897,7 +897,7 @@ export interface components {
          *     flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
          *     captions.
          *
-         *     To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
+         *     To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
          *     matching start and end time.
          */
         CaptionAsset: {
@@ -1339,13 +1339,6 @@ export interface components {
         /**
          * @description The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
          *
-         *     ```json
-         *     {
-         *       "type": "svg",
-         *       "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
-         *     }
-         *     ```
-         *
          *     **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
          *     `<line>`, `<polygon>`, `<polyline>`
          *
@@ -1359,7 +1352,7 @@ export interface components {
          *     See [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.
          * @example {
          *       "type": "svg",
-         *       "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>"
+         *       "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
          *     }
          */
         SvgAsset: {
@@ -1369,8 +1362,9 @@ export interface components {
              */
             type: "svg";
             /**
-             * @description Raw SVG markup string. The shape, fill, stroke, dimensions and opacity
-             *     are automatically extracted from the SVG content.
+             * @description Raw SVG markup string. The SVG must contain valid SVG elements. The shape,
+             *     fill, stroke, dimensions and opacity are automatically extracted from the
+             *     SVG content.
              * @example <svg width="100" height="100"><circle cx="50" cy="50" r="40" fill="#3498db"/></svg>
              */
             src: string;

package/dist/zod/zod.gen.cjs

@@ -122,7 +122,7 @@ exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema;
  * flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
  * captions.
  *
- * To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
+ * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
  * matching start and end time.
  *
  */
@@ -1628,13 +1628,6 @@ exports.soundtrackSchema = exports.soundtrackSoundtrackSchema;
 /**
  * The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
  *
- * ```json
- * {
- * "type": "svg",
- * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
- * }
- * ```
- *
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
  * `<line>`, `<polygon>`, `<polyline>`
  *

package/dist/zod/zod.gen.d.ts

@@ -70,7 +70,7 @@ export declare const captionMarginSchema: z.ZodObject<{
  * flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
  * captions.
  *
- * To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
+ * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
  * matching start and end time.
  *
  */
@@ -4653,13 +4653,6 @@ export declare const soundtrackSchema: z.ZodObject<{
 /**
  * The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
  *
- * ```json
- * {
- * "type": "svg",
- * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
- * }
- * ```
- *
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
  * `<line>`, `<polygon>`, `<polyline>`
  *

package/dist/zod/zod.gen.js

@@ -114,7 +114,7 @@ export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
  * flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
  * captions.
  *
- * To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
+ * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
  * matching start and end time.
  *
  */
@@ -1620,13 +1620,6 @@ export const soundtrackSchema = soundtrackSoundtrackSchema;
 /**
  * The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
  *
- * ```json
- * {
- * "type": "svg",
- * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
- * }
- * ```
- *
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
  * `<line>`, `<polygon>`, `<polyline>`
  *

package/dist/zod/zod.gen.ts

@@ -76,7 +76,7 @@ export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
  * flexibility with styling and layout. For example you can scale, position or crop a video without modifying the
  * captions.
  *
- * To sync captions with a video or audio file use a [Video](#tocs_videoasset") or [Audio](#tocs_audioasset") with
+ * To sync captions with a video or audio file use a [Video](#tocs_videoasset) or [Audio](#tocs_audioasset) with
  * matching start and end time.
  *
  */
@@ -1318,13 +1318,6 @@ export const soundtrackSchema = soundtrackSoundtrackSchema;
 /**
  * The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
  *
- * ```json
- * {
- * "type": "svg",
- * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
- * }
- * ```
- *
  * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
  * `<line>`, `<polygon>`, `<polyline>`
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shotstack/schemas",
-  "version": "1.9.9",
+  "version": "1.9.10",
   "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
   "type": "module",
   "main": "dist/index.js",