@shotstack/schemas 1.1.2 → 1.3.0

package/dist/zod/zod.gen.js

@@ -715,6 +715,23 @@ export const shotstackDestinationShotstackDestinationSchema = z.object({
     exclude: z.optional(z.boolean()),
 });
 export const shotstackDestinationSchema = shotstackDestinationShotstackDestinationSchema;
+/**
+ * Pass additional options to control how TikTok publishes video.
+ */
+export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
+    title: z.optional(z.string().max(150)),
+    privacyLevel: z.optional(z.enum(["public", "friends", "private"])),
+    disableDuet: z.optional(z.boolean()).default(false),
+    disableStitch: z.optional(z.boolean()).default(false),
+    disableComment: z.optional(z.boolean()).default(false),
+});
+/**
+ * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
+ */
+export const tiktokDestinationTiktokDestinationSchema = z.object({
+    provider: z.string().default("tiktok"),
+    options: z.optional(tiktokDestinationOptionsTiktokDestinationOptionsSchema),
+});
 /**
  * Options to control the visibility of videos and privacy features.
  */
@@ -731,6 +748,7 @@ export const vimeoDestinationOptionsVimeoDestinationOptionsSchema = z.object({
     name: z.optional(z.string()),
     description: z.optional(z.string()),
     privacy: z.optional(vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema),
+    folderUri: z.optional(z.string()),
 });
 export const vimeoDestinationOptionsSchema = vimeoDestinationOptionsVimeoDestinationOptionsSchema;
 /**
@@ -777,6 +795,11 @@ export const destinationsDestinationsSchema = z.union([
         destinations: z.optional(z.literal("vimeoDestination_VimeoDestination")),
     })
         .and(vimeoDestinationVimeoDestinationSchema),
+    z
+        .object({
+        destinations: z.optional(z.literal("tiktokDestination_TiktokDestination")),
+    })
+        .and(tiktokDestinationTiktokDestinationSchema),
 ]);
 export const destinationsSchema = destinationsDestinationsSchema;
 /**
@@ -1135,6 +1158,15 @@ export const richtextpropertiesRichTextBackgroundSchema = z.object({
     borderRadius: z.optional(z.number().gte(0)).default(0),
 });
 export const richTextBackgroundSchema = richtextpropertiesRichTextBackgroundSchema;
+/**
+ * Border styling properties for the text bounding box.
+ */
+export const richtextpropertiesRichTextBorderSchema = z.object({
+    width: z.optional(z.number().gte(0)).default(0),
+    color: z.optional(z.string().regex(/^#[A-Fa-f0-9]{6}$/)).default("#000000"),
+    opacity: z.optional(z.number().gte(0).lte(1)).default(1),
+    radius: z.optional(z.number().gte(0)).default(0),
+});
 /**
  * Font properties for rich text.
  */
@@ -1161,6 +1193,15 @@ export const richtextpropertiesRichTextGradientSchema = z.object({
         .min(2),
 });
 export const richTextGradientSchema = richtextpropertiesRichTextGradientSchema;
+/**
+ * Padding properties for individual sides of the text bounding box.
+ */
+export const richtextpropertiesRichTextPaddingSchema = z.object({
+    top: z.optional(z.number().gte(0)).default(0),
+    right: z.optional(z.number().gte(0)).default(0),
+    bottom: z.optional(z.number().gte(0)).default(0),
+    left: z.optional(z.number().gte(0)).default(0),
+});
 /**
  * Text shadow properties.
  */
@@ -1207,6 +1248,8 @@ export const richtextassetRichTextAssetSchema = z.object({
     stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
     shadow: z.optional(richtextpropertiesRichTextShadowSchema),
     background: z.optional(richtextpropertiesRichTextBackgroundSchema),
+    border: z.optional(richtextpropertiesRichTextBorderSchema),
+    padding: z.optional(z.union([z.number().gte(0), richtextpropertiesRichTextPaddingSchema])),
     align: z.optional(richtextpropertiesRichTextAlignmentSchema),
     animation: z.optional(richtextpropertiesRichTextAnimationSchema),
 });
@@ -1445,11 +1488,21 @@ export const textpropertiesTextAlignmentSchema = z.object({
     vertical: z.optional(z.enum(["top", "center", "bottom"])),
 });
 export const textAlignmentSchema = textpropertiesTextAlignmentSchema;
+/**
+ * Animation properties for text entrance effects.
+ */
+export const textpropertiesTextAnimationSchema = z.object({
+    preset: z.enum(["typewriter"]),
+    duration: z.optional(z.number().gte(0.1).lte(30)),
+});
 /**
  * Displays a background box behind the text.
  */
 export const textpropertiesTextBackgroundSchema = z.object({
-    color: z.optional(z.string()),
+    color: z.optional(z.string().regex(/^#[A-Fa-f0-9]{6}$/)),
+    opacity: z.optional(z.number().gte(0).lte(1)),
+    padding: z.optional(z.number().gte(0).lte(100)),
+    borderRadius: z.optional(z.number().gte(0)),
 });
 export const textBackgroundSchema = textpropertiesTextBackgroundSchema;
 /**
@@ -1464,6 +1517,13 @@ export const textpropertiesTextFontSchema = z.object({
     lineHeight: z.optional(z.number()),
 });
 export const textFontSchema = textpropertiesTextFontSchema;
+/**
+ * Text stroke (outline) properties.
+ */
+export const textpropertiesTextStrokeSchema = z.object({
+    width: z.optional(z.number().gte(0).lte(10)),
+    color: z.optional(z.string().regex(/^#[A-Fa-f0-9]{6}$/)),
+});
 /**
  * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
@@ -1477,6 +1537,9 @@ export const textassetTextAssetSchema = z.object({
     font: z.optional(textpropertiesTextFontSchema),
     background: z.optional(textpropertiesTextBackgroundSchema),
     alignment: z.optional(textpropertiesTextAlignmentSchema),
+    stroke: z.optional(textpropertiesTextStrokeSchema),
+    animation: z.optional(textpropertiesTextAnimationSchema),
+    ellipsis: z.optional(z.string()),
 });
 export const textAssetSchema = textassetTextAssetSchema;
 /**
@@ -1519,7 +1582,7 @@ export const outputOutputSchema = z.object({
         z.literal(59.94),
         z.literal(60),
     ])),
-    scaleTo: z.optional(z.enum(["preview", "mobile", "sd", "hd", "1080"])),
+    scaleTo: z.optional(z.enum(["preview", "mobile", "sd", "hd", "1080", "4k"])),
     quality: z.optional(z.enum(["verylow", "low", "medium", "high", "veryhigh"])),
     repeat: z.optional(z.boolean()),
     mute: z.optional(z.boolean()),
@@ -1534,6 +1597,7 @@ export const outputSchema = outputOutputSchema;
  */
 export const transitionTransitionSchema = z.object({
     in: z.optional(z.enum([
+        "none",
         "fade",
         "fadeSlow",
         "fadeFast",
@@ -1597,6 +1661,7 @@ export const transitionTransitionSchema = z.object({
         "zoom",
     ])),
     out: z.optional(z.enum([
+        "none",
         "fade",
         "fadeSlow",
         "fadeFast",
@@ -1718,7 +1783,7 @@ export const audioassetAudioAssetSchema = z.object({
     trim: z.optional(z.number()),
     volume: z.optional(z.union([z.number().gte(0).lte(1), z.array(tweenTweenSchema)])),
     speed: z.optional(z.number().gte(0).lte(10)),
-    effect: z.optional(z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
+    effect: z.optional(z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
 });
 export const audioAssetSchema = audioassetAudioAssetSchema;
 /**
@@ -1737,11 +1802,11 @@ export const rotatetransformationRotateTransformationSchema = z.object({
 });
 export const rotateTransformationSchema = rotatetransformationRotateTransformationSchema;
 /**
- * Skew a clip so its edges are sheared at an angle. Use values between 0 and 3. Over 3 the clip will be skewed almost flat.
+ * Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat.
  */
 export const skewtransformationSkewTransformationSchema = z.object({
-    x: z.optional(z.union([z.number(), z.array(tweenTweenSchema)])),
-    y: z.optional(z.union([z.number(), z.array(tweenTweenSchema)])),
+    x: z.optional(z.union([z.number().gte(-100).lte(100), z.array(tweenTweenSchema)])),
+    y: z.optional(z.union([z.number().gte(-100).lte(100), z.array(tweenTweenSchema)])),
 });
 export const skewTransformationSchema = skewtransformationSkewTransformationSchema;
 /**
@@ -1810,7 +1875,7 @@ export const videoassetVideoAssetSchema = z.object({
     transcode: z.optional(z.boolean()).default(false),
     trim: z.optional(z.number()),
     volume: z.optional(z.union([z.number().gte(0).lte(1), z.array(tweenTweenSchema)])),
-    volumeEffect: z.optional(z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
+    volumeEffect: z.optional(z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
     speed: z.optional(z.number().gte(0).lte(10)),
     crop: z.optional(cropCropSchema),
     chromaKey: z.optional(chromakeyChromaKeySchema),
@@ -1891,6 +1956,8 @@ export const clipClipSchema = z.object({
     length: z.union([z.number(), z.literal("auto"), z.literal("end")]),
     fit: z.optional(z.enum(["cover", "contain", "crop", "none"])),
     scale: z.optional(z.number()),
+    width: z.optional(z.int().gte(1).lte(3840)),
+    height: z.optional(z.int().gte(1).lte(2160)),
     position: z.optional(z.enum([
         "top",
         "topRight",
@@ -1936,6 +2003,7 @@ export const clipClipSchema = z.object({
     ])),
     opacity: z.optional(z.union([z.number(), z.array(tweenTweenSchema)])),
     transform: z.optional(transformationTransformationSchema),
+    alias: z.optional(z.string().regex(/^[A-Za-z0-9_-]+$/)),
 });
 export const clipSchema = clipClipSchema;
 /**

package/dist/zod/zod.gen.ts

@@ -894,6 +894,25 @@ export const shotstackDestinationShotstackDestinationSchema = z.object({
 export const shotstackDestinationSchema =
   shotstackDestinationShotstackDestinationSchema;
 
+/**
+ * Pass additional options to control how TikTok publishes video.
+ */
+export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
+  title: z.optional(z.string().max(150)),
+  privacyLevel: z.optional(z.enum(["public", "friends", "private"])),
+  disableDuet: z.optional(z.boolean()).default(false),
+  disableStitch: z.optional(z.boolean()).default(false),
+  disableComment: z.optional(z.boolean()).default(false),
+});
+
+/**
+ * Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
+ */
+export const tiktokDestinationTiktokDestinationSchema = z.object({
+  provider: z.string().default("tiktok"),
+  options: z.optional(tiktokDestinationOptionsTiktokDestinationOptionsSchema),
+});
+
 /**
  * Options to control the visibility of videos and privacy features.
  */
@@ -918,6 +937,7 @@ export const vimeoDestinationOptionsVimeoDestinationOptionsSchema = z.object({
   privacy: z.optional(
     vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema
   ),
+  folderUri: z.optional(z.string()),
 });
 
 export const vimeoDestinationOptionsSchema =
@@ -975,6 +995,13 @@ export const destinationsDestinationsSchema = z.union([
       destinations: z.optional(z.literal("vimeoDestination_VimeoDestination")),
     })
     .and(vimeoDestinationVimeoDestinationSchema),
+  z
+    .object({
+      destinations: z.optional(
+        z.literal("tiktokDestination_TiktokDestination")
+      ),
+    })
+    .and(tiktokDestinationTiktokDestinationSchema),
 ]);
 
 export const destinationsSchema = destinationsDestinationsSchema;
@@ -1431,6 +1458,16 @@ export const richtextpropertiesRichTextBackgroundSchema = z.object({
 export const richTextBackgroundSchema =
   richtextpropertiesRichTextBackgroundSchema;
 
+/**
+ * Border styling properties for the text bounding box.
+ */
+export const richtextpropertiesRichTextBorderSchema = z.object({
+  width: z.optional(z.number().gte(0)).default(0),
+  color: z.optional(z.string().regex(/^#[A-Fa-f0-9]{6}$/)).default("#000000"),
+  opacity: z.optional(z.number().gte(0).lte(1)).default(1),
+  radius: z.optional(z.number().gte(0)).default(0),
+});
+
 /**
  * Font properties for rich text.
  */
@@ -1463,6 +1500,16 @@ export const richtextpropertiesRichTextGradientSchema = z.object({
 
 export const richTextGradientSchema = richtextpropertiesRichTextGradientSchema;
 
+/**
+ * Padding properties for individual sides of the text bounding box.
+ */
+export const richtextpropertiesRichTextPaddingSchema = z.object({
+  top: z.optional(z.number().gte(0)).default(0),
+  right: z.optional(z.number().gte(0)).default(0),
+  bottom: z.optional(z.number().gte(0)).default(0),
+  left: z.optional(z.number().gte(0)).default(0),
+});
+
 /**
  * Text shadow properties.
  */
@@ -1517,6 +1564,10 @@ export const richtextassetRichTextAssetSchema = z.object({
   stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
   shadow: z.optional(richtextpropertiesRichTextShadowSchema),
   background: z.optional(richtextpropertiesRichTextBackgroundSchema),
+  border: z.optional(richtextpropertiesRichTextBorderSchema),
+  padding: z.optional(
+    z.union([z.number().gte(0), richtextpropertiesRichTextPaddingSchema])
+  ),
   align: z.optional(richtextpropertiesRichTextAlignmentSchema),
   animation: z.optional(richtextpropertiesRichTextAnimationSchema),
 });
@@ -1823,11 +1874,22 @@ export const textpropertiesTextAlignmentSchema = z.object({
 
 export const textAlignmentSchema = textpropertiesTextAlignmentSchema;
 
+/**
+ * Animation properties for text entrance effects.
+ */
+export const textpropertiesTextAnimationSchema = z.object({
+  preset: z.enum(["typewriter"]),
+  duration: z.optional(z.number().gte(0.1).lte(30)),
+});
+
 /**
  * Displays a background box behind the text.
  */
 export const textpropertiesTextBackgroundSchema = z.object({
-  color: z.optional(z.string()),
+  color: z.optional(z.string().regex(/^#[A-Fa-f0-9]{6}$/)),
+  opacity: z.optional(z.number().gte(0).lte(1)),
+  padding: z.optional(z.number().gte(0).lte(100)),
+  borderRadius: z.optional(z.number().gte(0)),
 });
 
 export const textBackgroundSchema = textpropertiesTextBackgroundSchema;
@@ -1846,6 +1908,14 @@ export const textpropertiesTextFontSchema = z.object({
 
 export const textFontSchema = textpropertiesTextFontSchema;
 
+/**
+ * Text stroke (outline) properties.
+ */
+export const textpropertiesTextStrokeSchema = z.object({
+  width: z.optional(z.number().gte(0).lte(10)),
+  color: z.optional(z.string().regex(/^#[A-Fa-f0-9]{6}$/)),
+});
+
 /**
  * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
@@ -1859,6 +1929,9 @@ export const textassetTextAssetSchema = z.object({
   font: z.optional(textpropertiesTextFontSchema),
   background: z.optional(textpropertiesTextBackgroundSchema),
   alignment: z.optional(textpropertiesTextAlignmentSchema),
+  stroke: z.optional(textpropertiesTextStrokeSchema),
+  animation: z.optional(textpropertiesTextAnimationSchema),
+  ellipsis: z.optional(z.string()),
 });
 
 export const textAssetSchema = textassetTextAssetSchema;
@@ -1911,7 +1984,7 @@ export const outputOutputSchema = z.object({
       z.literal(60),
     ])
   ),
-  scaleTo: z.optional(z.enum(["preview", "mobile", "sd", "hd", "1080"])),
+  scaleTo: z.optional(z.enum(["preview", "mobile", "sd", "hd", "1080", "4k"])),
   quality: z.optional(z.enum(["verylow", "low", "medium", "high", "veryhigh"])),
   repeat: z.optional(z.boolean()),
   mute: z.optional(z.boolean()),
@@ -1929,6 +2002,7 @@ export const outputSchema = outputOutputSchema;
 export const transitionTransitionSchema = z.object({
   in: z.optional(
     z.enum([
+      "none",
       "fade",
       "fadeSlow",
       "fadeFast",
@@ -1994,6 +2068,7 @@ export const transitionTransitionSchema = z.object({
   ),
   out: z.optional(
     z.enum([
+      "none",
       "fade",
       "fadeSlow",
       "fadeFast",
@@ -2124,7 +2199,7 @@ export const audioassetAudioAssetSchema = z.object({
     z.union([z.number().gte(0).lte(1), z.array(tweenTweenSchema)])
   ),
   speed: z.optional(z.number().gte(0).lte(10)),
-  effect: z.optional(z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
+  effect: z.optional(z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
 });
 
 export const audioAssetSchema = audioassetAudioAssetSchema;
@@ -2156,11 +2231,15 @@ export const rotateTransformationSchema =
   rotatetransformationRotateTransformationSchema;
 
 /**
- * Skew a clip so its edges are sheared at an angle. Use values between 0 and 3. Over 3 the clip will be skewed almost flat.
+ * Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat.
  */
 export const skewtransformationSkewTransformationSchema = z.object({
-  x: z.optional(z.union([z.number(), z.array(tweenTweenSchema)])),
-  y: z.optional(z.union([z.number(), z.array(tweenTweenSchema)])),
+  x: z.optional(
+    z.union([z.number().gte(-100).lte(100), z.array(tweenTweenSchema)])
+  ),
+  y: z.optional(
+    z.union([z.number().gte(-100).lte(100), z.array(tweenTweenSchema)])
+  ),
 });
 
 export const skewTransformationSchema =
@@ -2244,7 +2323,9 @@ export const videoassetVideoAssetSchema = z.object({
   volume: z.optional(
     z.union([z.number().gte(0).lte(1), z.array(tweenTweenSchema)])
   ),
-  volumeEffect: z.optional(z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
+  volumeEffect: z.optional(
+    z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])
+  ),
   speed: z.optional(z.number().gte(0).lte(10)),
   crop: z.optional(cropCropSchema),
   chromaKey: z.optional(chromakeyChromaKeySchema),
@@ -2329,6 +2410,8 @@ export const clipClipSchema = z.object({
   length: z.union([z.number(), z.literal("auto"), z.literal("end")]),
   fit: z.optional(z.enum(["cover", "contain", "crop", "none"])),
   scale: z.optional(z.number()),
+  width: z.optional(z.int().gte(1).lte(3840)),
+  height: z.optional(z.int().gte(1).lte(2160)),
   position: z.optional(
     z.enum([
       "top",
@@ -2380,6 +2463,7 @@ export const clipClipSchema = z.object({
   ),
   opacity: z.optional(z.union([z.number(), z.array(tweenTweenSchema)])),
   transform: z.optional(transformationTransformationSchema),
+  alias: z.optional(z.string().regex(/^[A-Za-z0-9_-]+$/)),
 });
 
 export const clipSchema = clipClipSchema;

package/package.json

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