@shotstack/schemas 1.8.3 → 1.8.5

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.
@@ -2051,95 +2051,8 @@
2051
2051
  "font": {
2052
2052
  "anyOf": [
2053
2053
  {
2054
- "type": "object",
2055
2054
  "description": "Font styling properties for inactive words.",
2056
- "properties": {
2057
- "family": {
2058
- "anyOf": [
2059
- {
2060
- "type": "string",
2061
- "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Roboto\".",
2062
- "enum": [
2063
- "Roboto"
2064
- ]
2065
- },
2066
- {
2067
- "type": "null"
2068
- }
2069
- ]
2070
- },
2071
- "size": {
2072
- "anyOf": [
2073
- {
2074
- "type": "integer",
2075
- "description": "The size of the font in pixels (px). Must be between 1 and 500.",
2076
- "minimum": 1,
2077
- "maximum": 500
2078
- },
2079
- {
2080
- "type": "null"
2081
- }
2082
- ]
2083
- },
2084
- "weight": {
2085
- "anyOf": [
2086
- {
2087
- "type": "string",
2088
- "description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest)."
2089
- },
2090
- {
2091
- "type": "null"
2092
- }
2093
- ]
2094
- },
2095
- "color": {
2096
- "anyOf": [
2097
- {
2098
- "type": "string",
2099
- "description": "The text color using hexadecimal color notation.",
2100
- "enum": [
2101
- "#ffffff"
2102
- ]
2103
- },
2104
- {
2105
- "type": "null"
2106
- }
2107
- ]
2108
- },
2109
- "opacity": {
2110
- "anyOf": [
2111
- {
2112
- "type": "number",
2113
- "description": "The opacity of the text where 1 is opaque and 0 is transparent.",
2114
- "minimum": 0,
2115
- "maximum": 1
2116
- },
2117
- {
2118
- "type": "null"
2119
- }
2120
- ]
2121
- },
2122
- "background": {
2123
- "anyOf": [
2124
- {
2125
- "type": "string",
2126
- "description": "The background color behind the text using hexadecimal color notation."
2127
- },
2128
- {
2129
- "type": "null"
2130
- }
2131
- ]
2132
- }
2133
- },
2134
- "additionalProperties": false,
2135
- "required": [
2136
- "family",
2137
- "size",
2138
- "weight",
2139
- "color",
2140
- "opacity",
2141
- "background"
2142
- ]
2055
+ "$ref": "#/$defs/RichTextFont"
2143
2056
  },
2144
2057
  {
2145
2058
  "type": "null"
@@ -4662,6 +4575,126 @@
4662
4575
  "options"
4663
4576
  ],
4664
4577
  "additionalProperties": false
4578
+ },
4579
+ {
4580
+ "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage-usage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
4581
+ "properties": {
4582
+ "provider": {
4583
+ "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
4584
+ "type": "string",
4585
+ "enum": [
4586
+ "akamai-netstorage"
4587
+ ]
4588
+ },
4589
+ "options": {
4590
+ "anyOf": [
4591
+ {
4592
+ "type": "object",
4593
+ "description": "Additional Akamai NetStorage configuration options.",
4594
+ "properties": {
4595
+ "host": {
4596
+ "description": "The Akamai NetStorage hostname, i.e. `example-nsu.akamaihd.net`.",
4597
+ "type": "string"
4598
+ },
4599
+ "cpCode": {
4600
+ "description": "The Content Provider code (CP code) for the NetStorage upload directory.",
4601
+ "type": "string"
4602
+ },
4603
+ "path": {
4604
+ "description": "A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.",
4605
+ "type": [
4606
+ "string",
4607
+ "null"
4608
+ ]
4609
+ },
4610
+ "filename": {
4611
+ "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
4612
+ "type": [
4613
+ "string",
4614
+ "null"
4615
+ ]
4616
+ }
4617
+ },
4618
+ "required": [
4619
+ "host",
4620
+ "cpCode",
4621
+ "path",
4622
+ "filename"
4623
+ ],
4624
+ "additionalProperties": false
4625
+ },
4626
+ {
4627
+ "type": "null"
4628
+ }
4629
+ ]
4630
+ }
4631
+ },
4632
+ "type": "object",
4633
+ "required": [
4634
+ "provider",
4635
+ "options"
4636
+ ],
4637
+ "additionalProperties": false
4638
+ },
4639
+ {
4640
+ "description": "Send videos and assets to [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/). Send files to any container with a custom prefix and filename. Azure credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/azure-blob-storage), not in the request.",
4641
+ "properties": {
4642
+ "provider": {
4643
+ "description": "The destination to send assets to - set to `azure-blob-storage` for Azure Blob Storage.",
4644
+ "type": "string",
4645
+ "enum": [
4646
+ "azure-blob-storage"
4647
+ ]
4648
+ },
4649
+ "options": {
4650
+ "anyOf": [
4651
+ {
4652
+ "type": "object",
4653
+ "description": "Additional Azure Blob Storage configuration options.",
4654
+ "properties": {
4655
+ "accountName": {
4656
+ "description": "The Azure Storage account name.",
4657
+ "type": "string"
4658
+ },
4659
+ "container": {
4660
+ "description": "The Blob container name. The container must exist in the Azure Storage account before files can be sent.",
4661
+ "type": "string"
4662
+ },
4663
+ "prefix": {
4664
+ "description": "A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.",
4665
+ "type": [
4666
+ "string",
4667
+ "null"
4668
+ ]
4669
+ },
4670
+ "filename": {
4671
+ "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
4672
+ "type": [
4673
+ "string",
4674
+ "null"
4675
+ ]
4676
+ }
4677
+ },
4678
+ "required": [
4679
+ "accountName",
4680
+ "container",
4681
+ "prefix",
4682
+ "filename"
4683
+ ],
4684
+ "additionalProperties": false
4685
+ },
4686
+ {
4687
+ "type": "null"
4688
+ }
4689
+ ]
4690
+ }
4691
+ },
4692
+ "type": "object",
4693
+ "required": [
4694
+ "provider",
4695
+ "options"
4696
+ ],
4697
+ "additionalProperties": false
4665
4698
  }
4666
4699
  ]
4667
4700
  },
@@ -1879,88 +1879,7 @@
1879
1879
  "font": {
1880
1880
  "anyOf": [
1881
1881
  {
1882
- "type": "object",
1883
- "properties": {
1884
- "family": {
1885
- "anyOf": [
1886
- {
1887
- "type": "string",
1888
- "enum": [
1889
- "Roboto"
1890
- ]
1891
- },
1892
- {
1893
- "type": "null"
1894
- }
1895
- ]
1896
- },
1897
- "size": {
1898
- "anyOf": [
1899
- {
1900
- "type": "integer",
1901
- "minimum": 1,
1902
- "maximum": 500
1903
- },
1904
- {
1905
- "type": "null"
1906
- }
1907
- ]
1908
- },
1909
- "weight": {
1910
- "anyOf": [
1911
- {
1912
- "type": "string"
1913
- },
1914
- {
1915
- "type": "null"
1916
- }
1917
- ]
1918
- },
1919
- "color": {
1920
- "anyOf": [
1921
- {
1922
- "type": "string",
1923
- "enum": [
1924
- "#ffffff"
1925
- ]
1926
- },
1927
- {
1928
- "type": "null"
1929
- }
1930
- ]
1931
- },
1932
- "opacity": {
1933
- "anyOf": [
1934
- {
1935
- "type": "number",
1936
- "minimum": 0,
1937
- "maximum": 1
1938
- },
1939
- {
1940
- "type": "null"
1941
- }
1942
- ]
1943
- },
1944
- "background": {
1945
- "anyOf": [
1946
- {
1947
- "type": "string"
1948
- },
1949
- {
1950
- "type": "null"
1951
- }
1952
- ]
1953
- }
1954
- },
1955
- "additionalProperties": false,
1956
- "required": [
1957
- "family",
1958
- "size",
1959
- "weight",
1960
- "color",
1961
- "opacity",
1962
- "background"
1963
- ]
1882
+ "$ref": "#/$defs/RichTextFont"
1964
1883
  },
1965
1884
  {
1966
1885
  "type": "null"
@@ -1766,88 +1766,7 @@
1766
1766
  "font": {
1767
1767
  "anyOf": [
1768
1768
  {
1769
- "type": "object",
1770
- "properties": {
1771
- "family": {
1772
- "anyOf": [
1773
- {
1774
- "type": "string",
1775
- "enum": [
1776
- "Roboto"
1777
- ]
1778
- },
1779
- {
1780
- "type": "null"
1781
- }
1782
- ]
1783
- },
1784
- "size": {
1785
- "anyOf": [
1786
- {
1787
- "type": "integer",
1788
- "minimum": 1,
1789
- "maximum": 500
1790
- },
1791
- {
1792
- "type": "null"
1793
- }
1794
- ]
1795
- },
1796
- "weight": {
1797
- "anyOf": [
1798
- {
1799
- "type": "string"
1800
- },
1801
- {
1802
- "type": "null"
1803
- }
1804
- ]
1805
- },
1806
- "color": {
1807
- "anyOf": [
1808
- {
1809
- "type": "string",
1810
- "enum": [
1811
- "#ffffff"
1812
- ]
1813
- },
1814
- {
1815
- "type": "null"
1816
- }
1817
- ]
1818
- },
1819
- "opacity": {
1820
- "anyOf": [
1821
- {
1822
- "type": "number",
1823
- "minimum": 0,
1824
- "maximum": 1
1825
- },
1826
- {
1827
- "type": "null"
1828
- }
1829
- ]
1830
- },
1831
- "background": {
1832
- "anyOf": [
1833
- {
1834
- "type": "string"
1835
- },
1836
- {
1837
- "type": "null"
1838
- }
1839
- ]
1840
- }
1841
- },
1842
- "additionalProperties": false,
1843
- "required": [
1844
- "family",
1845
- "size",
1846
- "weight",
1847
- "color",
1848
- "opacity",
1849
- "background"
1850
- ]
1769
+ "$ref": "#/$defs/RichTextFont"
1851
1770
  },
1852
1771
  {
1853
1772
  "type": "null"
package/dist/schema.d.ts CHANGED
@@ -997,42 +997,7 @@ export interface components {
997
997
  /** @description Pre-provided word-level timing data. Use this instead of `src` when you have word timestamps from an external source. Mutually exclusive with `src`. */
998
998
  words?: components["schemas"]["WordTiming"][];
999
999
  /** @description Font styling properties for inactive words. */
1000
- font?: {
1001
- /**
1002
- * @description The font family name. This must be the Family name embedded in the font, i.e. "Roboto".
1003
- * @default Roboto
1004
- * @example Roboto
1005
- */
1006
- family?: string;
1007
- /**
1008
- * @description The size of the font in pixels (px). Must be between 1 and 500.
1009
- * @default 24
1010
- * @example 48
1011
- */
1012
- size?: number;
1013
- /**
1014
- * @description The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).
1015
- * @default 400
1016
- */
1017
- weight?: unknown;
1018
- /**
1019
- * @description The text color using hexadecimal color notation.
1020
- * @default #ffffff
1021
- * @example #ffffff
1022
- */
1023
- color?: string;
1024
- /**
1025
- * @description The opacity of the text where 1 is opaque and 0 is transparent.
1026
- * @default 1
1027
- * @example 0.9
1028
- */
1029
- opacity?: number;
1030
- /**
1031
- * @description The background color behind the text using hexadecimal color notation.
1032
- * @example #000000
1033
- */
1034
- background?: string;
1035
- };
1000
+ font?: components["schemas"]["RichTextFont"];
1036
1001
  /** @description Text style properties including spacing, line height, and transformations. */
1037
1002
  style?: components["schemas"]["RichTextStyle"];
1038
1003
  /** @description Text stroke (outline) properties for inactive words. */
@@ -2851,6 +2816,66 @@ export interface components {
2851
2816
  */
2852
2817
  disableComment?: boolean;
2853
2818
  };
2819
+ } | {
2820
+ /**
2821
+ * @description The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.
2822
+ * @default akamai-netstorage
2823
+ * @example akamai-netstorage
2824
+ */
2825
+ provider: string;
2826
+ /** @description Additional Akamai NetStorage configuration options. */
2827
+ options?: {
2828
+ /**
2829
+ * @description The Akamai NetStorage hostname, i.e. `example-nsu.akamaihd.net`.
2830
+ * @example example-nsu.akamaihd.net
2831
+ */
2832
+ host: string;
2833
+ /**
2834
+ * @description The Content Provider code (CP code) for the NetStorage upload directory.
2835
+ * @example 123456
2836
+ */
2837
+ cpCode: string;
2838
+ /**
2839
+ * @description A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.
2840
+ * @example videos
2841
+ */
2842
+ path?: string | null;
2843
+ /**
2844
+ * @description Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.
2845
+ * @example my-file
2846
+ */
2847
+ filename?: string | null;
2848
+ };
2849
+ } | {
2850
+ /**
2851
+ * @description The destination to send assets to - set to `azure-blob-storage` for Azure Blob Storage.
2852
+ * @default azure-blob-storage
2853
+ * @example azure-blob-storage
2854
+ */
2855
+ provider: string;
2856
+ /** @description Additional Azure Blob Storage configuration options. */
2857
+ options?: {
2858
+ /**
2859
+ * @description The Azure Storage account name.
2860
+ * @example mystorageaccount
2861
+ */
2862
+ accountName: string;
2863
+ /**
2864
+ * @description The Blob container name. The container must exist in the Azure Storage account before files can be sent.
2865
+ * @example my-container
2866
+ */
2867
+ container: string;
2868
+ /**
2869
+ * @description A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.
2870
+ * @example videos
2871
+ */
2872
+ prefix?: string | null;
2873
+ /**
2874
+ * @description Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.
2875
+ * @example my-file
2876
+ */
2877
+ filename?: string | null;
2878
+ };
2854
2879
  };
2855
2880
  /** @description Send videos and assets to the [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service. This destination is enabled by default. */
2856
2881
  ShotstackDestination: {