@shotstack/schemas 1.14.1 → 1.15.0

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 (75) hide show
  1. package/dist/api.bundled.json +8 -5
  2. package/dist/json-schema/edit.json +3823 -4207
  3. package/dist/json-schema/index.cjs +1 -6
  4. package/dist/json-schema/index.d.ts +1 -11
  5. package/dist/json-schema/index.js +0 -5
  6. package/dist/schema.d.ts +16 -5
  7. package/dist/zod/zod.gen.cjs +10 -2
  8. package/dist/zod/zod.gen.d.ts +10 -2
  9. package/dist/zod/zod.gen.js +10 -2
  10. package/dist/zod/zod.gen.ts +10 -2
  11. package/package.json +1 -1
  12. package/dist/json-schema/asset.json +0 -2725
  13. package/dist/json-schema/audio-asset.json +0 -315
  14. package/dist/json-schema/blueprint.json +0 -380
  15. package/dist/json-schema/caption-asset.json +0 -285
  16. package/dist/json-schema/caption-background.json +0 -61
  17. package/dist/json-schema/caption-detailer.json +0 -275
  18. package/dist/json-schema/caption-font.json +0 -97
  19. package/dist/json-schema/caption-margin.json +0 -49
  20. package/dist/json-schema/chroma-key.json +0 -46
  21. package/dist/json-schema/clip.json +0 -3236
  22. package/dist/json-schema/crop.json +0 -69
  23. package/dist/json-schema/destinations.json +0 -613
  24. package/dist/json-schema/flip-transformation.json +0 -37
  25. package/dist/json-schema/font.json +0 -18
  26. package/dist/json-schema/google-cloud-storage-destination-options.json +0 -42
  27. package/dist/json-schema/google-cloud-storage-destination.json +0 -73
  28. package/dist/json-schema/google-drive-destination-options.json +0 -37
  29. package/dist/json-schema/google-drive-destination.json +0 -68
  30. package/dist/json-schema/image-asset.json +0 -173
  31. package/dist/json-schema/image-to-video-asset.json +0 -151
  32. package/dist/json-schema/luma-asset.json +0 -38
  33. package/dist/json-schema/merge-field.json +0 -23
  34. package/dist/json-schema/offset.json +0 -175
  35. package/dist/json-schema/output.json +0 -907
  36. package/dist/json-schema/poster.json +0 -18
  37. package/dist/json-schema/range.json +0 -39
  38. package/dist/json-schema/rich-caption-active-font.json +0 -106
  39. package/dist/json-schema/rich-caption-active.json +0 -291
  40. package/dist/json-schema/rich-caption-animation.json +0 -46
  41. package/dist/json-schema/rich-caption-asset.json +0 -1247
  42. package/dist/json-schema/rich-text-alignment.json +0 -47
  43. package/dist/json-schema/rich-text-animation.json +0 -74
  44. package/dist/json-schema/rich-text-asset.json +0 -761
  45. package/dist/json-schema/rich-text-background.json +0 -78
  46. package/dist/json-schema/rich-text-content.json +0 -394
  47. package/dist/json-schema/rich-text-effects.json +0 -400
  48. package/dist/json-schema/rich-text-font.json +0 -157
  49. package/dist/json-schema/rich-text-gradient.json +0 -68
  50. package/dist/json-schema/rich-text-shadow.json +0 -79
  51. package/dist/json-schema/rich-text-stroke.json +0 -55
  52. package/dist/json-schema/rich-text-style.json +0 -165
  53. package/dist/json-schema/rotate-transformation.json +0 -153
  54. package/dist/json-schema/s3destination-options.json +0 -59
  55. package/dist/json-schema/s3destination.json +0 -90
  56. package/dist/json-schema/schemas.json +0 -4730
  57. package/dist/json-schema/shape-asset.json +0 -225
  58. package/dist/json-schema/shotstack-destination.json +0 -33
  59. package/dist/json-schema/size.json +0 -41
  60. package/dist/json-schema/skew-transformation.json +0 -175
  61. package/dist/json-schema/soundtrack.json +0 -47
  62. package/dist/json-schema/svg-asset.json +0 -26
  63. package/dist/json-schema/template.json +0 -827
  64. package/dist/json-schema/text-to-image-asset.json +0 -128
  65. package/dist/json-schema/text-to-speech-asset.json +0 -239
  66. package/dist/json-schema/thumbnail.json +0 -25
  67. package/dist/json-schema/timeline.json +0 -3364
  68. package/dist/json-schema/track.json +0 -3251
  69. package/dist/json-schema/transformation.json +0 -281
  70. package/dist/json-schema/transition.json +0 -85
  71. package/dist/json-schema/tween.json +0 -120
  72. package/dist/json-schema/video-asset.json +0 -471
  73. package/dist/json-schema/vimeo-destination-options.json +0 -149
  74. package/dist/json-schema/vimeo-destination-privacy-options.json +0 -90
  75. package/dist/json-schema/vimeo-destination.json +0 -178
@@ -1,6 +1 @@
1
- module.exports.edit = require('./edit.json');
2
- module.exports.template = require('./template.json');
3
- module.exports.blueprint = require('./blueprint.json');
4
- module.exports.richTextContent = require('./rich-text-content.json');
5
- module.exports.richTextEffects = require('./rich-text-effects.json');
6
- module.exports.captionDetailer = require('./caption-detailer.json');
1
+ module.exports = { edit: require('./edit.json') };
@@ -1,11 +1 @@
1
- export interface JsonSchema {
2
- name: string;
3
- strict: boolean;
4
- schema: Record<string, unknown>;
5
- }
6
- export declare const edit: JsonSchema;
7
- export declare const template: JsonSchema;
8
- export declare const blueprint: JsonSchema;
9
- export declare const richTextContent: JsonSchema;
10
- export declare const richTextEffects: JsonSchema;
11
- export declare const captionDetailer: JsonSchema;
1
+ export declare const edit: Record<string, unknown>;
@@ -1,8 +1,3 @@
1
1
  import { createRequire } from 'module';
2
2
  const require = createRequire(import.meta.url);
3
3
  export const edit = require('./edit.json');
4
- export const template = require('./template.json');
5
- export const blueprint = require('./blueprint.json');
6
- export const richTextContent = require('./rich-text-content.json');
7
- export const richTextEffects = require('./rich-text-effects.json');
8
- export const captionDetailer = require('./caption-detailer.json');
package/dist/schema.d.ts CHANGED
@@ -412,7 +412,10 @@ export interface components {
412
412
  };
413
413
  /** @description A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time. */
414
414
  Timeline: {
415
- /** @description A music or audio soundtrack file in mp3 format. */
415
+ /**
416
+ * @deprecated
417
+ * @description A music or audio soundtrack file in mp3 format. Deprecated - use an [AudioAsset](#tocs_audioasset) clip on its own track instead.
418
+ */
416
419
  soundtrack?: components["schemas"]["Soundtrack"];
417
420
  /** @description A hexadecimal value for the timeline background colour. Defaults to #000000 (black). */
418
421
  background?: string;
@@ -423,7 +426,11 @@ export interface components {
423
426
  /** @description Disable the caching of ingested source footage and assets. See [caching](https://shotstack.io/docs/guide/architecting-an-application/caching/) for more details. */
424
427
  cache?: boolean;
425
428
  };
426
- /** @description A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest. */
429
+ /**
430
+ * @deprecated
431
+ * @description **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.
432
+ * A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
433
+ */
427
434
  Soundtrack: {
428
435
  /**
429
436
  * @description The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.
@@ -686,7 +693,11 @@ export interface components {
686
693
  crop?: components["schemas"]["Crop"];
687
694
  };
688
695
  /**
689
- * @description The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
696
+ * @deprecated
697
+ * @description **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type
698
+ * continues to function; no behaviour change for existing integrations.
699
+ *
700
+ * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
690
701
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
691
702
  */
692
703
  TextAsset: {
@@ -1373,7 +1384,7 @@ export interface components {
1373
1384
  };
1374
1385
  /**
1375
1386
  * @deprecated
1376
- * @description **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
1387
+ * @description **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
1377
1388
  *
1378
1389
  * The HtmlAsset clip type lets you create text based layout and formatting using
1379
1390
  * HTML and CSS. You can also set the height and width of a bounding box for the HTML
@@ -1448,7 +1459,7 @@ export interface components {
1448
1459
  };
1449
1460
  /**
1450
1461
  * @deprecated
1451
- * @description **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
1462
+ * @description **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
1452
1463
  *
1453
1464
  * The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
1454
1465
  */
@@ -431,7 +431,7 @@ exports.html5AssetHtml5AssetSchema = zod_1.z.object({
431
431
  }).strict();
432
432
  exports.html5AssetSchema = exports.html5AssetHtml5AssetSchema;
433
433
  /**
434
- * **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
434
+ * **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
435
435
  *
436
436
  * The HtmlAsset clip type lets you create text based layout and formatting using
437
437
  * HTML and CSS. You can also set the height and width of a bounding box for the HTML
@@ -1668,7 +1668,10 @@ exports.sourceSourceSchema = zod_1.z.object({
1668
1668
  }).strict();
1669
1669
  exports.sourceSchema = exports.sourceSourceSchema;
1670
1670
  /**
1671
+ * **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.
1671
1672
  * A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
1673
+ *
1674
+ * @deprecated
1672
1675
  */
1673
1676
  exports.soundtrackSoundtrackSchema = zod_1.z.object({
1674
1677
  src: zod_1.z.string().min(1).regex(/\S/),
@@ -1823,9 +1826,14 @@ exports.textpropertiesTextStrokeSchema = zod_1.z.object({
1823
1826
  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*\}\}$/)]))
1824
1827
  }).strict();
1825
1828
  /**
1829
+ * **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type
1830
+ * continues to function; no behaviour change for existing integrations.
1831
+ *
1826
1832
  * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
1827
1833
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
1828
1834
  *
1835
+ *
1836
+ * @deprecated
1829
1837
  */
1830
1838
  exports.textassetTextAssetSchema = zod_1.z.object({
1831
1839
  type: zod_1.z.enum(['text']),
@@ -2375,7 +2383,7 @@ exports.texttospeechassetTextToSpeechAssetSchema = zod_1.z.object({
2375
2383
  }).strict();
2376
2384
  exports.textToSpeechAssetSchema = exports.texttospeechassetTextToSpeechAssetSchema;
2377
2385
  /**
2378
- * **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
2386
+ * **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
2379
2387
  *
2380
2388
  * The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
2381
2389
  *
@@ -773,7 +773,7 @@ export declare const html5AssetSchema: z.ZodObject<{
773
773
  js: z.ZodOptional<z.ZodString>;
774
774
  }, z.core.$strict>;
775
775
  /**
776
- * **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
776
+ * **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
777
777
  *
778
778
  * The HtmlAsset clip type lets you create text based layout and formatting using
779
779
  * HTML and CSS. You can also set the height and width of a bounding box for the HTML
@@ -4710,7 +4710,10 @@ export declare const sourceSchema: z.ZodObject<{
4710
4710
  callback: z.ZodOptional<z.ZodString>;
4711
4711
  }, z.core.$strict>;
4712
4712
  /**
4713
+ * **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.
4713
4714
  * A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
4715
+ *
4716
+ * @deprecated
4714
4717
  */
4715
4718
  export declare const soundtrackSoundtrackSchema: z.ZodObject<{
4716
4719
  src: z.ZodString;
@@ -4855,9 +4858,14 @@ export declare const textpropertiesTextStrokeSchema: z.ZodObject<{
4855
4858
  color: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodString]>>;
4856
4859
  }, z.core.$strict>;
4857
4860
  /**
4861
+ * **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type
4862
+ * continues to function; no behaviour change for existing integrations.
4863
+ *
4858
4864
  * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
4859
4865
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
4860
4866
  *
4867
+ *
4868
+ * @deprecated
4861
4869
  */
4862
4870
  export declare const textassetTextAssetSchema: z.ZodObject<{
4863
4871
  type: z.ZodEnum<{
@@ -6358,7 +6366,7 @@ export declare const textToSpeechAssetSchema: z.ZodObject<{
6358
6366
  }>>;
6359
6367
  }, z.core.$strict>;
6360
6368
  /**
6361
- * **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
6369
+ * **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
6362
6370
  *
6363
6371
  * The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
6364
6372
  *
@@ -423,7 +423,7 @@ export const html5AssetHtml5AssetSchema = z.object({
423
423
  }).strict();
424
424
  export const html5AssetSchema = html5AssetHtml5AssetSchema;
425
425
  /**
426
- * **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
426
+ * **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
427
427
  *
428
428
  * The HtmlAsset clip type lets you create text based layout and formatting using
429
429
  * HTML and CSS. You can also set the height and width of a bounding box for the HTML
@@ -1660,7 +1660,10 @@ export const sourceSourceSchema = z.object({
1660
1660
  }).strict();
1661
1661
  export const sourceSchema = sourceSourceSchema;
1662
1662
  /**
1663
+ * **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.
1663
1664
  * A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
1665
+ *
1666
+ * @deprecated
1664
1667
  */
1665
1668
  export const soundtrackSoundtrackSchema = z.object({
1666
1669
  src: z.string().min(1).regex(/\S/),
@@ -1815,9 +1818,14 @@ export const textpropertiesTextStrokeSchema = z.object({
1815
1818
  color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]))
1816
1819
  }).strict();
1817
1820
  /**
1821
+ * **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type
1822
+ * continues to function; no behaviour change for existing integrations.
1823
+ *
1818
1824
  * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
1819
1825
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
1820
1826
  *
1827
+ *
1828
+ * @deprecated
1821
1829
  */
1822
1830
  export const textassetTextAssetSchema = z.object({
1823
1831
  type: z.enum(['text']),
@@ -2367,7 +2375,7 @@ export const texttospeechassetTextToSpeechAssetSchema = z.object({
2367
2375
  }).strict();
2368
2376
  export const textToSpeechAssetSchema = texttospeechassetTextToSpeechAssetSchema;
2369
2377
  /**
2370
- * **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
2378
+ * **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
2371
2379
  *
2372
2380
  * The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
2373
2381
  *
@@ -381,7 +381,7 @@ export const html5AssetHtml5AssetSchema = z.object({
381
381
  export const html5AssetSchema = html5AssetHtml5AssetSchema;
382
382
 
383
383
  /**
384
- * **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
384
+ * **Notice: The HtmlAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
385
385
  *
386
386
  * The HtmlAsset clip type lets you create text based layout and formatting using
387
387
  * HTML and CSS. You can also set the height and width of a bounding box for the HTML
@@ -1358,7 +1358,10 @@ export const sourceSourceSchema = z.object({
1358
1358
  export const sourceSchema = sourceSourceSchema;
1359
1359
 
1360
1360
  /**
1361
+ * **Notice: The Soundtrack is deprecated, use an [AudioAsset](#tocs_audioasset) clip on its own track instead.** This type continues to function; no behaviour change for existing integrations.
1361
1362
  * A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
1363
+ *
1364
+ * @deprecated
1362
1365
  */
1363
1366
  export const soundtrackSoundtrackSchema = z.object({
1364
1367
  src: z.string().min(1).regex(/\S/),
@@ -1467,9 +1470,14 @@ export const textpropertiesTextStrokeSchema = z.object({
1467
1470
  }).strict();
1468
1471
 
1469
1472
  /**
1473
+ * **Notice: The TextAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.** This type
1474
+ * continues to function; no behaviour change for existing integrations.
1475
+ *
1470
1476
  * The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
1471
1477
  * [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
1472
1478
  *
1479
+ *
1480
+ * @deprecated
1473
1481
  */
1474
1482
  export const textassetTextAssetSchema = z.object({
1475
1483
  type: z.enum(['text']),
@@ -1921,7 +1929,7 @@ export const texttospeechassetTextToSpeechAssetSchema = z.object({
1921
1929
  export const textToSpeechAssetSchema = texttospeechassetTextToSpeechAssetSchema;
1922
1930
 
1923
1931
  /**
1924
- * **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
1932
+ * **Notice: The TitleAsset is deprecated, use the [RichTextAsset](#tocs_richtextasset) instead.**
1925
1933
  *
1926
1934
  * The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
1927
1935
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shotstack/schemas",
3
- "version": "1.14.1",
3
+ "version": "1.15.0",
4
4
  "description": "Centralized OpenAPI schemas and TypeScript types for Shotstack API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",