@nxtedition/types 23.0.30 → 23.0.32

package/dist/index.d.ts

@@ -21,8 +21,13 @@ export type Records = {
 } & {
     [Property in keyof DesignDomainRecords as `${string}${Property}${string}`]: DesignDomainRecords[Property];
 } & {
+    "media.subtitles": {
+        languages?: Record<string, string>;
+        fontFaces?: SubtitleFontFace[];
+    };
     "media.subtitles?": {
-        languages: Record<string, string>;
+        languages?: Record<string, string>;
+        fontFaces?: SubtitleFontFace[];
     };
     "media.transcribe?": {
         engines: Record<string, string>;
@@ -67,3 +72,9 @@ export type Records = {
 interface DomainRows {
     rows: string[];
 }
+interface SubtitleFontFace {
+    family: string;
+    asset?: string;
+    weight?: "normal" | "bold";
+    style?: "normal" | "italic";
+}

package/dist/schema.json

@@ -1585,6 +1585,10 @@
         "DownloadFileOptions": {
             "additionalProperties": false,
             "properties": {
+                "collisionPostfix": {
+                    "description": "If true, a postfix like (1), (2), etc. will be added to the filename in\ncase a file with the requested name already exists.",
+                    "type": "boolean"
+                },
                 "directory": {
                     "type": "string"
                 },
@@ -1609,6 +1613,52 @@
             ],
             "type": "object"
         },
+        "DownloadMessage": {
+            "additionalProperties": false,
+            "properties": {
+                "bytes": {
+                    "type": "number"
+                },
+                "done": {
+                    "type": "boolean"
+                },
+                "id": {
+                    "type": "string"
+                },
+                "savePath": {
+                    "type": "string"
+                },
+                "size": {
+                    "type": "number"
+                },
+                "state": {
+                    "enum": [
+                        "cancelled",
+                        "completed",
+                        "interrupted",
+                        "progressing"
+                    ],
+                    "type": "string"
+                },
+                "title": {
+                    "type": "string"
+                },
+                "type": {
+                    "const": "download",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "bytes",
+                "id",
+                "savePath",
+                "size",
+                "state",
+                "title",
+                "type"
+            ],
+            "type": "object"
+        },
         "Dynamic": {
             "anyOf": [
                 {
@@ -1800,7 +1850,7 @@
                     "type": "string"
                 },
                 "styleOverrides": {
-                    "$ref": "#/definitions/EventSubtitleStyle"
+                    "$ref": "#/definitions/SubtitleEventStyleOverrides"
                 },
                 "text": {
                     "type": "string"
@@ -1808,16 +1858,6 @@
             },
             "type": "object"
         },
-        "EventSubtitleStyle": {
-            "additionalProperties": false,
-            "properties": {
-                "alignment": {
-                    "description": "1 - bottom left\n2 - bottom center\n3 - bottom right\n4 - center left\n5 - center center\n6 - center right\n7 - top left\n8 - top center\n9 - top right",
-                    "type": "string"
-                }
-            },
-            "type": "object"
-        },
         "FacebookConnectionRecord": {
             "additionalProperties": false,
             "properties": {
@@ -3104,14 +3144,12 @@
                 "locations",
                 "mimeType",
                 "position",
-                "progress",
                 "ranges",
                 "refs",
                 "replicas",
                 "resumable",
                 "seekable",
                 "size",
-                "speed",
                 "tags",
                 "uploading",
                 "zones"
@@ -3302,8 +3340,20 @@
                 "live": {
                     "type": "boolean"
                 },
+                "subtitle": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "codec": {
+                            "type": "string"
+                        }
+                    },
+                    "type": "object"
+                },
                 "type": {
                     "$ref": "#/definitions/MediaType"
+                },
+                "url": {
+                    "type": "string"
                 }
             },
             "required": [
@@ -3931,6 +3981,81 @@
                 }
             ]
         },
+        "Omit<SubtitleStyleDomainRecord,\"scaledBorderAndShadow\"|\"futureWordWrapping\">": {
+            "additionalProperties": false,
+            "properties": {
+                "alignment": {
+                    "type": "string"
+                },
+                "angle": {
+                    "type": "string"
+                },
+                "backColour": {
+                    "type": "string"
+                },
+                "bold": {
+                    "type": "string"
+                },
+                "borderStyle": {
+                    "type": "string"
+                },
+                "encoding": {
+                    "type": "string"
+                },
+                "fontname": {
+                    "type": "string"
+                },
+                "fontsize": {
+                    "type": "string"
+                },
+                "italic": {
+                    "type": "string"
+                },
+                "marginL": {
+                    "type": "string"
+                },
+                "marginR": {
+                    "type": "string"
+                },
+                "marginV": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "outline": {
+                    "type": "string"
+                },
+                "outlineColour": {
+                    "type": "string"
+                },
+                "primaryColour": {
+                    "type": "string"
+                },
+                "scaleX": {
+                    "type": "string"
+                },
+                "scaleY": {
+                    "type": "string"
+                },
+                "secondaryColour": {
+                    "type": "string"
+                },
+                "shadow": {
+                    "type": "string"
+                },
+                "spacing": {
+                    "type": "string"
+                },
+                "strikeOut": {
+                    "type": "string"
+                },
+                "underline": {
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "OpenDialogOptions": {
             "additionalProperties": false,
             "properties": {
@@ -4257,6 +4382,9 @@
                 "debug": {
                     "type": "boolean"
                 },
+                "download": {
+                    "$ref": "#/definitions/PartialObjectDeep<{displaySaveDialog?:boolean;batchDownloadDialogMode?:\"file\"|\"directory\";},{}>"
+                },
                 "edit": {
                     "$ref": "#/definitions/PartialObjectDeep<{thumbnailView:\"none\"|\"filmStrip\"|\"thumbnail\";voiceOver:{inputDevice?:string;inputGainDb:number;backgroundReductionDb:number;recordMode:\"instant\"|\"punchAndRoll\";preRollDuration:number;};},{}>"
                 },
@@ -4274,7 +4402,7 @@
                     "type": "array"
                 },
                 "featurePreview": {
-                    "$ref": "#/definitions/PartialObjectDeep<{collections?:boolean;semanticSearch?:boolean;},{}>"
+                    "$ref": "#/definitions/PartialObjectDeep<{collections?:boolean;semanticSearch?:boolean;ameRemoteRendering?:boolean;},{}>"
                 },
                 "flags": {
                     "$ref": "#/definitions/PartialObjectDeep<{utils:boolean;history:boolean;refs:boolean;access:boolean;files:boolean;export:boolean;json:boolean;hlsjs:boolean;resetRenders?:boolean;resetReplicas?:boolean;assetStatus?:boolean;consolidateMedia?:boolean;hideInAssetMenu?:boolean;assetRoute?:boolean;devWarnings?:boolean;},{}>"
@@ -4308,7 +4436,7 @@
                     "$ref": "#/definitions/PartialObjectDeep<{display:{[actionKey:string]:KeymapSetting;};browser:{[actionKey:string]:KeymapSetting;};gallery:{[actionKey:string]:KeymapSetting;};global:{[actionKey:string]:KeymapSetting;};player:{[actionKey:string]:KeymapSetting;};script:{[actionKey:string]:KeymapSetting;};codeEditor:{[actionKey:string]:KeymapSetting;};bookmarks:{[actionKey:string]:KeymapSetting;};edit:{[actionKey:string]:KeymapSetting;};rundown:{[actionKey:string]:KeymapSetting;};segment:{[actionKey:string]:KeymapSetting;};},{}>"
                 },
                 "media": {
-                    "$ref": "#/definitions/PartialObjectDeep<{defaultFrameRate:number;placeholder?:string;guide?:{mask?:boolean;actionSafe?:boolean;titleSafe?:boolean;};stepManyFrames:number;liveZoomDuration:number;importTitleTemplate:string;tile:{preview:boolean|\"play\"|\"seek\"|\"disabled\"|\"seekplay\";showRenderProgress:boolean;};timecodeReference:string;maxSubclipDuration:number;rewindStep:number;forwardStep:number;interlacedPlayback:string;playbackRates:number[];subtitles:{spacing:number;maxCharactersPerLine:number;};subtitleTemplateId?:string;initialVolume:string;guides:{label:string;aspectRatio:string;}[];download:boolean;editMode:{enabled:boolean;defaultEnterOption:\"none\"|\"edit\"|\"createNew\";defaultExitOption:\"none\"|\"update\"|\"leave\";};transcribe?:{subtitleDisclaimer?:{isUserConfigurable?:boolean;defaultValue?:{enabled?:false;text?:{language:string;value:string;}[];offset?:number;duration?:number;};};};openCommand?:string|{url?:string;command?:string;app?:string;args?:string[];};},{}>"
+                    "$ref": "#/definitions/PartialObjectDeep<{defaultFrameRate:number;placeholder?:string;guide?:{mask?:boolean;actionSafe?:boolean;titleSafe?:boolean;};stepManyFrames:number;liveZoomDuration:number;importTitleTemplate:string;tile:{preview:boolean|\"play\"|\"seek\"|\"disabled\"|\"seekplay\";showRenderProgress:boolean;};timecodeReference:string;maxSubclipDuration:number;rewindStep:number;forwardStep:number;interlacedPlayback:string;playbackRates:number[];subtitles:{spacing:number;maxCharactersPerLine:number;aspectRatios?:{aspectRatio?:string;style?:string;maxCharactersPerLine?:number;}[];};subtitleTemplateId?:string;initialVolume:string;guides:{label:string;aspectRatio:string;}[];download:boolean;editMode:{enabled:boolean;defaultEnterOption:\"none\"|\"edit\"|\"createNew\";defaultExitOption:\"none\"|\"update\"|\"leave\";};transcribe?:{subtitleDisclaimer?:{isUserConfigurable?:boolean;defaultValue?:{enabled?:false;text?:{language:string;value:string;}[];offset?:number;duration?:number;};};};openCommand?:string|{url?:string;command?:string;app?:string;args?:string[];};},{}>"
                 },
                 "module": {
                     "$ref": "#/definitions/PartialObjectDeep<{tabs?:ModuleTabs;},{}>"
@@ -4347,7 +4475,7 @@
                     "$ref": "#/definitions/PartialObjectDeep<{exclude:string[];},{}>"
                 },
                 "upload": {
-                    "$ref": "#/definitions/PartialObjectDeep<{defaultGrouping?:\"\"|\"collection\"|\"stitch\";hideStoryboardCollection?:boolean;},{}>"
+                    "$ref": "#/definitions/PartialObjectDeep<{defaultGrouping?:\"\"|\"collection\"|\"stitch\";hideStoryboardCollection?:boolean;displayUploadFilesDialog?:\"always\"|\"never\"|\"ifMultipleFiles\";},{}>"
                 }
             },
             "type": "object"
@@ -4464,10 +4592,13 @@
             },
             "type": "object"
         },
-        "PartialObjectDeep<{collections?:boolean;semanticSearch?:boolean;},{}>": {
+        "PartialObjectDeep<{collections?:boolean;semanticSearch?:boolean;ameRemoteRendering?:boolean;},{}>": {
             "additionalProperties": false,
             "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
             "properties": {
+                "ameRemoteRendering": {
+                    "type": "boolean"
+                },
                 "collections": {
                     "type": "boolean"
                 },
@@ -4534,7 +4665,7 @@
             },
             "type": "object"
         },
-        "PartialObjectDeep<{defaultFrameRate:number;placeholder?:string;guide?:{mask?:boolean;actionSafe?:boolean;titleSafe?:boolean;};stepManyFrames:number;liveZoomDuration:number;importTitleTemplate:string;tile:{preview:boolean|\"play\"|\"seek\"|\"disabled\"|\"seekplay\";showRenderProgress:boolean;};timecodeReference:string;maxSubclipDuration:number;rewindStep:number;forwardStep:number;interlacedPlayback:string;playbackRates:number[];subtitles:{spacing:number;maxCharactersPerLine:number;};subtitleTemplateId?:string;initialVolume:string;guides:{label:string;aspectRatio:string;}[];download:boolean;editMode:{enabled:boolean;defaultEnterOption:\"none\"|\"edit\"|\"createNew\";defaultExitOption:\"none\"|\"update\"|\"leave\";};transcribe?:{subtitleDisclaimer?:{isUserConfigurable?:boolean;defaultValue?:{enabled?:false;text?:{language:string;value:string;}[];offset?:number;duration?:number;};};};openCommand?:string|{url?:string;command?:string;app?:string;args?:string[];};},{}>": {
+        "PartialObjectDeep<{defaultFrameRate:number;placeholder?:string;guide?:{mask?:boolean;actionSafe?:boolean;titleSafe?:boolean;};stepManyFrames:number;liveZoomDuration:number;importTitleTemplate:string;tile:{preview:boolean|\"play\"|\"seek\"|\"disabled\"|\"seekplay\";showRenderProgress:boolean;};timecodeReference:string;maxSubclipDuration:number;rewindStep:number;forwardStep:number;interlacedPlayback:string;playbackRates:number[];subtitles:{spacing:number;maxCharactersPerLine:number;aspectRatios?:{aspectRatio?:string;style?:string;maxCharactersPerLine?:number;}[];};subtitleTemplateId?:string;initialVolume:string;guides:{label:string;aspectRatio:string;}[];download:boolean;editMode:{enabled:boolean;defaultEnterOption:\"none\"|\"edit\"|\"createNew\";defaultExitOption:\"none\"|\"update\"|\"leave\";};transcribe?:{subtitleDisclaimer?:{isUserConfigurable?:boolean;defaultValue?:{enabled?:false;text?:{language:string;value:string;}[];offset?:number;duration?:number;};};};openCommand?:string|{url?:string;command?:string;app?:string;args?:string[];};},{}>": {
             "additionalProperties": false,
             "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
             "properties": {
@@ -4617,7 +4748,7 @@
                     "type": "string"
                 },
                 "subtitles": {
-                    "$ref": "#/definitions/PartialObjectDeep<{spacing:number;maxCharactersPerLine:number;},{}>"
+                    "$ref": "#/definitions/PartialObjectDeep<{spacing:number;maxCharactersPerLine:number;aspectRatios?:{aspectRatio?:string;style?:string;maxCharactersPerLine?:number;}[];},{}>"
                 },
                 "tile": {
                     "$ref": "#/definitions/PartialObjectDeep<{preview:boolean|\"play\"|\"seek\"|\"disabled\"|\"seekplay\";showRenderProgress:boolean;},{}>"
@@ -4631,7 +4762,7 @@
             },
             "type": "object"
         },
-        "PartialObjectDeep<{defaultGrouping?:\"\"|\"collection\"|\"stitch\";hideStoryboardCollection?:boolean;},{}>": {
+        "PartialObjectDeep<{defaultGrouping?:\"\"|\"collection\"|\"stitch\";hideStoryboardCollection?:boolean;displayUploadFilesDialog?:\"always\"|\"never\"|\"ifMultipleFiles\";},{}>": {
             "additionalProperties": false,
             "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
             "properties": {
@@ -4643,6 +4774,14 @@
                     ],
                     "type": "string"
                 },
+                "displayUploadFilesDialog": {
+                    "enum": [
+                        "always",
+                        "ifMultipleFiles",
+                        "never"
+                    ],
+                    "type": "string"
+                },
                 "hideStoryboardCollection": {
                     "type": "boolean"
                 }
@@ -4699,6 +4838,24 @@
             },
             "type": "object"
         },
+        "PartialObjectDeep<{displaySaveDialog?:boolean;batchDownloadDialogMode?:\"file\"|\"directory\";},{}>": {
+            "additionalProperties": false,
+            "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
+            "properties": {
+                "batchDownloadDialogMode": {
+                    "description": "Whether to prompt the user for each individual file path,\nor just the directory.",
+                    "enum": [
+                        "directory",
+                        "file"
+                    ],
+                    "type": "string"
+                },
+                "displaySaveDialog": {
+                    "type": "boolean"
+                }
+            },
+            "type": "object"
+        },
         "PartialObjectDeep<{enable:boolean;show24Hours:boolean;showAmPm:boolean;showSeconds:boolean;showDayOfWeek:boolean;showDate:boolean;format?:string;},{}>": {
             "additionalProperties": false,
             "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
@@ -5124,10 +5281,29 @@
             },
             "type": "object"
         },
-        "PartialObjectDeep<{spacing:number;maxCharactersPerLine:number;},{}>": {
+        "PartialObjectDeep<{spacing:number;maxCharactersPerLine:number;aspectRatios?:{aspectRatio?:string;style?:string;maxCharactersPerLine?:number;}[];},{}>": {
             "additionalProperties": false,
             "description": "Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.",
             "properties": {
+                "aspectRatios": {
+                    "items": {
+                        "additionalProperties": false,
+                        "properties": {
+                            "aspectRatio": {
+                                "description": "aspect ratio in the form of \"width:height\"",
+                                "type": "string"
+                            },
+                            "maxCharactersPerLine": {
+                                "type": "number"
+                            },
+                            "style": {
+                                "type": "string"
+                            }
+                        },
+                        "type": "object"
+                    },
+                    "type": "array"
+                },
                 "maxCharactersPerLine": {
                     "type": "number"
                 },
@@ -5825,16 +6001,34 @@
                     },
                     "type": "object"
                 },
+                "media.subtitles": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "fontFaces": {
+                            "items": {
+                                "$ref": "#/definitions/SubtitleFontFace"
+                            },
+                            "type": "array"
+                        },
+                        "languages": {
+                            "$ref": "#/definitions/Record<string,string>"
+                        }
+                    },
+                    "type": "object"
+                },
                 "media.subtitles?": {
                     "additionalProperties": false,
                     "properties": {
+                        "fontFaces": {
+                            "items": {
+                                "$ref": "#/definitions/SubtitleFontFace"
+                            },
+                            "type": "array"
+                        },
                         "languages": {
                             "$ref": "#/definitions/Record<string,string>"
                         }
                     },
-                    "required": [
-                        "languages"
-                    ],
                     "type": "object"
                 },
                 "media.transcribe?": {
@@ -5884,6 +6078,7 @@
                 "deepstream-replicator.stats?",
                 "hub-transcribe:render-profile",
                 "media.consolidate",
+                "media.subtitles",
                 "media.subtitles?",
                 "media.transcribe?"
             ],
@@ -6053,6 +6248,16 @@
                     },
                     "type": "array"
                 },
+                "subtitle": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/SubtitleProfile"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ]
+                },
                 "transcribe": {
                     "additionalProperties": false,
                     "properties": {
@@ -6117,6 +6322,21 @@
                 "subtitle": {
                     "type": "string"
                 },
+                "subtitleTracks": {
+                    "additionalProperties": {
+                        "additionalProperties": false,
+                        "properties": {
+                            "style": {
+                                "type": "string"
+                            },
+                            "styleOverrides": {
+                                "$ref": "#/definitions/Omit<SubtitleStyleDomainRecord,\"scaledBorderAndShadow\"|\"futureWordWrapping\">"
+                            }
+                        },
+                        "type": "object"
+                    },
+                    "type": "object"
+                },
                 "transcribe": {
                     "additionalProperties": false,
                     "properties": {
@@ -6653,6 +6873,97 @@
             },
             "type": "object"
         },
+        "SubtitleEventStyleOverrides": {
+            "additionalProperties": false,
+            "properties": {
+                "alignment": {
+                    "type": "string"
+                },
+                "backColour": {
+                    "type": "string"
+                },
+                "bold": {
+                    "type": "string"
+                },
+                "fontname": {
+                    "type": "string"
+                },
+                "fontsize": {
+                    "type": "string"
+                },
+                "italic": {
+                    "type": "string"
+                },
+                "marginL": {
+                    "type": "string"
+                },
+                "marginR": {
+                    "type": "string"
+                },
+                "marginV": {
+                    "type": "string"
+                },
+                "outlineColour": {
+                    "type": "string"
+                },
+                "primaryColour": {
+                    "type": "string"
+                },
+                "secondaryColour": {
+                    "type": "string"
+                },
+                "strikeOut": {
+                    "type": "string"
+                },
+                "underline": {
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "SubtitleFontFace": {
+            "additionalProperties": false,
+            "properties": {
+                "asset": {
+                    "type": "string"
+                },
+                "family": {
+                    "type": "string"
+                },
+                "style": {
+                    "enum": [
+                        "italic",
+                        "normal"
+                    ],
+                    "type": "string"
+                },
+                "weight": {
+                    "enum": [
+                        "bold",
+                        "normal"
+                    ],
+                    "type": "string"
+                }
+            },
+            "required": [
+                "family"
+            ],
+            "type": "object"
+        },
+        "SubtitleProfile": {
+            "additionalProperties": false,
+            "properties": {
+                "lang": {
+                    "description": "Corresponds to a key in `media.subtitles?#languages`, or '_all' to render all languages.",
+                    "type": "string"
+                },
+                "style": {
+                    "description": "Will pick styling from the corresponding `${style}:subtitle-style` asset.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "SubtitleStyleDomainRecord": {
             "additionalProperties": false,
             "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/types",
-  "version": "23.0.30",
+  "version": "23.0.32",
   "license": "MIT",
   "type": "module",
   "exports": {