@shotstack/schemas 1.24.0-beta.2 → 1.24.0-beta.3

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.
@@ -769,6 +769,13 @@ export const mergefieldMergeFieldSchema = z.object({
769
769
  replace: z.unknown()
770
770
  }).strict();
771
771
  export const mergeFieldSchema = mergefieldMergeFieldSchema;
772
+ /**
773
+ * Silences English profanity in the clip's speech, and any listed `words`. The audio is transcribed when the edit renders, and the volume drops to zero just before each matching word and returns just after it. Rich captions transcribed from this clip show the same words masked. Profanity detection is not exhaustive: list any word that must not be heard. Cannot be combined with `speed`, `duck` or a volume tween array.
774
+ */
775
+ export const muteMuteSchema = z.object({
776
+ words: z.optional(z.array(z.string().min(1).max(50).regex(/^\S+$/)).min(1).max(200))
777
+ }).strict();
778
+ export const muteSchema = muteMuteSchema;
772
779
  /**
773
780
  * Inverts the clip, turning light areas dark and dark areas light. It has no properties other than `type` and cannot be animated.
774
781
  */
@@ -2397,7 +2404,8 @@ export const audioassetAudioAssetSchema = z.object({
2397
2404
  'fadeOut',
2398
2405
  'fadeInFadeOut'
2399
2406
  ])),
2400
- duck: z.optional(duckDuckSchema)
2407
+ duck: z.optional(duckDuckSchema),
2408
+ mute: z.optional(muteMuteSchema)
2401
2409
  }).strict().superRefine((data, ctx) => {
2402
2410
  var hasSrc = typeof data.src === "string" && data.src.trim().length > 0;
2403
2411
  var hasPrompt = typeof data.prompt === "string" && data.prompt.trim().length > 0;
@@ -2609,7 +2617,7 @@ export const pixelatefilterPixelateFilterSchema = z.object({
2609
2617
  }).strict();
2610
2618
  export const pixelateFilterSchema = pixelatefilterPixelateFilterSchema;
2611
2619
  /**
2612
- * Offsets the red and blue channels in opposite directions to create a color fringing effect.
2620
+ * Offsets the red and blue channels in opposite directions to create a color fringing effect. Channels pushed past one edge of the frame reappear at the opposite edge, so small values such as 0.02 work best and 1 or -1 shows no split.
2613
2621
  */
2614
2622
  export const rgbsplitfilterRgbSplitFilterSchema = z.object({
2615
2623
  type: z.enum(['rgbSplit']),
@@ -2696,7 +2704,7 @@ export const sharpenfilterSharpenFilterSchema = z.object({
2696
2704
  }).strict();
2697
2705
  export const sharpenFilterSchema = sharpenfilterSharpenFilterSchema;
2698
2706
  /**
2699
- * A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Keyframe values outside a field's range are limited to that range.
2707
+ * A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Tween values outside a field's range are limited to that range.
2700
2708
  */
2701
2709
  export const filterFilterSchema = z.discriminatedUnion("type", [
2702
2710
  brightnessfilterBrightnessFilterSchema,
@@ -2892,6 +2900,7 @@ export const videoassetVideoAssetSchema = z.object({
2892
2900
  'fadeOut',
2893
2901
  'fadeInFadeOut'
2894
2902
  ])),
2903
+ mute: z.optional(muteMuteSchema),
2895
2904
  speed: z.optional(z.union([
2896
2905
  z.union([z.preprocess(((v) => { if (v === '' || v === null || v === undefined)
2897
2906
  return undefined; if (Array.isArray(v))
@@ -734,6 +734,15 @@ export const mergefieldMergeFieldSchema = z.object({
734
734
 
735
735
  export const mergeFieldSchema = mergefieldMergeFieldSchema;
736
736
 
737
+ /**
738
+ * Silences English profanity in the clip's speech, and any listed `words`. The audio is transcribed when the edit renders, and the volume drops to zero just before each matching word and returns just after it. Rich captions transcribed from this clip show the same words masked. Profanity detection is not exhaustive: list any word that must not be heard. Cannot be combined with `speed`, `duck` or a volume tween array.
739
+ */
740
+ export const muteMuteSchema = z.object({
741
+ words: z.optional(z.array(z.string().min(1).max(50).regex(/^\S+$/)).min(1).max(200))
742
+ }).strict();
743
+
744
+ export const muteSchema = muteMuteSchema;
745
+
737
746
  /**
738
747
  * Inverts the clip, turning light areas dark and dark areas light. It has no properties other than `type` and cannot be animated.
739
748
  */
@@ -1998,7 +2007,8 @@ export const audioassetAudioAssetSchema = z.object({
1998
2007
  'fadeOut',
1999
2008
  'fadeInFadeOut'
2000
2009
  ])),
2001
- duck: z.optional(duckDuckSchema)
2010
+ duck: z.optional(duckDuckSchema),
2011
+ mute: z.optional(muteMuteSchema)
2002
2012
  }).strict().superRefine((data, ctx) => {
2003
2013
  var hasSrc = typeof data.src === "string" && data.src.trim().length > 0;
2004
2014
  var hasPrompt = typeof data.prompt === "string" && data.prompt.trim().length > 0;
@@ -2136,7 +2146,7 @@ export const pixelatefilterPixelateFilterSchema = z.object({
2136
2146
  export const pixelateFilterSchema = pixelatefilterPixelateFilterSchema;
2137
2147
 
2138
2148
  /**
2139
- * Offsets the red and blue channels in opposite directions to create a color fringing effect.
2149
+ * Offsets the red and blue channels in opposite directions to create a color fringing effect. Channels pushed past one edge of the frame reappear at the opposite edge, so small values such as 0.02 work best and 1 or -1 shows no split.
2140
2150
  */
2141
2151
  export const rgbsplitfilterRgbSplitFilterSchema = z.object({
2142
2152
  type: z.enum(['rgbSplit']),
@@ -2195,7 +2205,7 @@ export const sharpenfilterSharpenFilterSchema = z.object({
2195
2205
  export const sharpenFilterSchema = sharpenfilterSharpenFilterSchema;
2196
2206
 
2197
2207
  /**
2198
- * A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Keyframe values outside a field's range are limited to that range.
2208
+ * A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Tween values outside a field's range are limited to that range.
2199
2209
  */
2200
2210
  export const filterFilterSchema = z.discriminatedUnion("type", [
2201
2211
  brightnessfilterBrightnessFilterSchema,
@@ -2359,6 +2369,7 @@ export const videoassetVideoAssetSchema = z.object({
2359
2369
  'fadeOut',
2360
2370
  'fadeInFadeOut'
2361
2371
  ])),
2372
+ mute: z.optional(muteMuteSchema),
2362
2373
  speed: z.optional(z.union([
2363
2374
  z.union([z.preprocess(((v: unknown) => { if (v === '' || v === null || v === undefined) return undefined; if (Array.isArray(v)) return v; if (typeof v === 'string') { if (/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/.test(v)) return v; return Number(v); } return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
2364
2375
  z.array(tweenTweenSchema)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.24.0-beta.2",
3
+ "version": "1.24.0-beta.3",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",