@nxtedition/types 23.1.3 → 23.1.4

package/dist/nxtpression.d.ts

@@ -58,6 +58,7 @@ declare interface AssetCreatedProvidedRecord {
 
 declare interface AssetDaemonRecord {
     "user-notify"?: boolean;
+    validate?: boolean;
 }
 
 declare interface AssetDaemonUserNotifyStateRecord {
@@ -65,6 +66,11 @@ declare interface AssetDaemonUserNotifyStateRecord {
     version?: number;
 }
 
+declare interface AssetDaemonValidateStateRecord {
+    since?: string | 0 | null;
+    version?: number;
+}
+
 declare interface AssetDeadlinesRecord {
     value?: Nxtpression<string, {
         id: string;
@@ -687,7 +693,7 @@ declare interface DeviceDomainStatusRecord {
     version?: string;
 }
 
-declare interface DomainRecords extends AssetDomainRecords, AuthDomainRecords, BundleDomainRecords, CalendarEventDomainRecords, CloneDomainRecords, CommentReactionDomainRecords, CommentReadMarkDomainRecords, CommentDomainRecords, ConditionDomainRecords, ConnectionDomainRecords, ContactDomainRecords, DeepstreamDomainRecords, DesignDomainRecords, DeviceDomainRecords, EditDomainRecords, EventDomainRecords, FileDomainRecords, FolderDomainRecords, GeneralDomainRecords, HarvestDomainRecords, IngestclipDomainRecords, IngestScheduleDomainRecords, MediaDomainRecords, MonitorDomainRecords, NoteDomainRecords, PanelDomainRecords, PermissionDomainRecords, PipelinePresetDomainRecords, PipelineDomainRecords, PlanningDomainRecords, PrompterDomainRecords, PublishDomainRecords, PublishedDomainRecords, RenderPresetDomainRecords, RenderDomainRecords, RevsDomainRecords, RoleDomainRecords, SchemaDomainRecords, ScriptDomainRecords, SearchDomainRecords, SettingsDomainRecords, ShotboxDomainRecords, StoryboardDomainRecords, StreamDomainRecords, SubtitleStyleDomainRecords, SubtitleDomainRecords, TemplateDomainRecords, UserNotificationStatusDomainRecords, UserNotificationDomainRecords, UserDomainRecords, UsernameDomainRecords {
+declare interface DomainRecords extends AssetDomainRecords, AuthDomainRecords, BundleDomainRecords, CalendarEventDomainRecords, CloneDomainRecords, CommentReactionDomainRecords, CommentReadMarkDomainRecords, CommentDomainRecords, ConditionDomainRecords, ConnectionDomainRecords, ContactDomainRecords, DeepstreamDomainRecords, DesignDomainRecords, DeviceDomainRecords, EditDomainRecords, EventDomainRecords, FileDomainRecords, FolderDomainRecords, GalleryDomainRecords, GeneralDomainRecords, HarvestDomainRecords, IngestclipDomainRecords, IngestScheduleDomainRecords, MediaDomainRecords, MonitorDomainRecords, NoteDomainRecords, PanelDomainRecords, PermissionDomainRecords, PipelinePresetDomainRecords, PipelineDomainRecords, PlanningDomainRecords, PrompterDomainRecords, PublishDomainRecords, PublishedDomainRecords, RenderPresetDomainRecords, RenderDomainRecords, RevsDomainRecords, RoleDomainRecords, SchemaDomainRecords, ScriptDomainRecords, SearchDomainRecords, SettingsDomainRecords, ShotboxDomainRecords, StorageDomainRecords, StoryboardDomainRecords, StreamDomainRecords, SubtitleStyleDomainRecords, SubtitleDomainRecords, TemplateDomainRecords, UserNotificationStatusDomainRecords, UserNotificationDomainRecords, UserDomainRecords, UsernameDomainRecords {
 }
 
 declare type Dynamic = false | string[];
@@ -761,8 +767,11 @@ declare type EmptyObject = {
 
  // With `EmptyObject` only the first case is valid.
  const bar1: EmptyObject = {}; // Pass
- const bar2: EmptyObject = 42; // Fail
- const bar3: EmptyObject = []; // Fail
+ // @ts-expect-error
+ const bar2: EmptyObject = []; // Fail
+ // @ts-expect-error
+ const bar3: EmptyObject = 42; // Fail
+ // @ts-expect-error
  const bar4: EmptyObject = {a: 1}; // Fail
  ```
 
@@ -807,6 +816,7 @@ declare interface EventDomainRecords {
     ":event.duration?": EventDurationRecord;
     ":event.children?": EventChildrenRecord;
     ":event.props?": EventPropsRecord;
+    ":event.stats?": EventStatsRecord;
 }
 
 declare interface EventDurationRecord {
@@ -832,6 +842,7 @@ declare interface EventOverlayRecord {
 declare type EventProps = {
     source?: string;
     cueCard?: boolean | string;
+    printRundownColor?: string;
     startTime?: number;
     shotboxGroup?: string | string[];
     shotboxVisible?: boolean;
@@ -843,12 +854,17 @@ declare interface EventRecord {
     start?: number | null;
     end?: number | null;
     duration?: number | null;
+    position?: string;
     text?: string;
     lang?: string;
     style?: string;
     styleOverrides?: SubtitleEventStyleOverrides;
 }
 
+declare interface EventStatsRecord {
+    type?: string;
+}
+
 declare interface EventTemplateRecord {
     mixin?: string[];
     properties?: object;
@@ -1010,9 +1026,11 @@ declare interface FileConnectionSmbRecord extends FileConnectionBase {
     protocol?: "smb";
     host?: string;
     share?: string;
+    root?: string;
     workgroup?: string;
     username?: string;
     password?: string;
+    createFolders?: boolean;
 }
 
 declare interface FileDomainRecords {
@@ -1184,6 +1202,16 @@ declare interface FormattedTextNodeContent {
     format?: number;
 }
 
+declare interface GalleryDomainRecord {
+    sources?: {
+        program?: string;
+    };
+}
+
+declare interface GalleryDomainRecords {
+    ":gallery": GalleryDomainRecord;
+}
+
 declare interface GeneralAssetRecord {
     title?: string;
     tags?: string;
@@ -1358,7 +1386,7 @@ declare interface HttpConnectionResponseHandler<ResOutput = undefined> {
 
  @example
  ```
- import {If} from 'type-fest';
+ import type {If} from 'type-fest';
 
  type A = If<true, 'yes', 'no'>;
  //=> 'yes'
@@ -1378,7 +1406,7 @@ declare interface HttpConnectionResponseHandler<ResOutput = undefined> {
 
  @example
  ```
- import {If, IsAny, IsNever} from 'type-fest';
+ import type {If, IsAny, IsNever} from 'type-fest';
 
  type A = If<IsAny<unknown>, 'is any', 'not any'>;
  //=> 'not any'
@@ -1389,7 +1417,7 @@ declare interface HttpConnectionResponseHandler<ResOutput = undefined> {
 
  @example
  ```
- import {If, IsEqual} from 'type-fest';
+ import type {If, IsEqual} from 'type-fest';
 
  type IfEqual<T, U, IfBranch, ElseBranch> = If<IsEqual<T, U>, IfBranch, ElseBranch>;
 
@@ -1400,6 +1428,41 @@ declare interface HttpConnectionResponseHandler<ResOutput = undefined> {
  //=> 'not equal'
  ```
 
+ Note: Sometimes using the `If` type can make an implementation non–tail-recursive, which can impact performance. In such cases, it’s better to use a conditional directly. Refer to the following example:
+
+ @example
+ ```
+ import type {If, IsEqual, StringRepeat} from 'type-fest';
+
+ type HundredZeroes = StringRepeat<'0', 100>;
+
+ // The following implementation is not tail recursive
+ type Includes<S extends string, Char extends string> =
+ 	S extends `${infer First}${infer Rest}`
+ 		? If<IsEqual<First, Char>,
+ 			'found',
+ 			Includes<Rest, Char>>
+ 		: 'not found';
+
+ // Hence, instantiations with long strings will fail
+ // @ts-expect-error
+ type Fails = Includes<HundredZeroes, '1'>;
+ //           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ // Error: Type instantiation is excessively deep and possibly infinite.
+
+ // However, if we use a simple conditional instead of `If`, the implementation becomes tail-recursive
+ type IncludesWithoutIf<S extends string, Char extends string> =
+ 	S extends `${infer First}${infer Rest}`
+ 		? IsEqual<First, Char> extends true
+ 			? 'found'
+ 			: IncludesWithoutIf<Rest, Char>
+ 		: 'not found';
+
+ // Now, instantiations with long strings will work
+ type Works = IncludesWithoutIf<HundredZeroes, '1'>;
+ //=> 'not found'
+ ```
+
  @category Type Guard
  @category Utilities
  */
@@ -1483,7 +1546,7 @@ declare type InternalIsUnion<T, U = T> =
 	IsNever<T> extends true
 		? false
 		: T extends any
-			? [U] extends [T]
+			? IsEqual<U, T> extends true
 				? false
 				: true
 			: never
@@ -1503,15 +1566,54 @@ declare type InternalIsUnion<T, U = T> =
  import type {IsEmptyObject} from 'type-fest';
 
  type Pass = IsEmptyObject<{}>; //=> true
- type Fail = IsEmptyObject<[]>; //=> false
- type Fail = IsEmptyObject<null>; //=> false
+ type Fail1 = IsEmptyObject<[]>; //=> false
+ type Fail2 = IsEmptyObject<null>; //=> false
  ```
 
- @see EmptyObject
+ @see {@link EmptyObject}
  @category Object
  */
 declare type IsEmptyObject<T> = T extends EmptyObject_2 ? true : false;
 
+/**
+ Returns a boolean for whether the two given types are equal.
+
+ @link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+ @link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+ Use-cases:
+ - If you want to make a conditional branch based on the result of a comparison of two types.
+
+ @example
+ ```
+ import type {IsEqual} from 'type-fest';
+
+ // This type returns a boolean for whether the given array includes the given item.
+ // `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+ type Includes<Value extends readonly any[], Item> =
+ 	Value extends readonly [Value[0], ...infer rest]
+ 		? IsEqual<Value[0], Item> extends true
+ 			? true
+ 			: Includes<rest, Item>
+ 		: false;
+ ```
+
+ @category Type Guard
+ @category Utilities
+ */
+declare type IsEqual<A, B> =
+	[A] extends [B]
+		? [B] extends [A]
+			? _IsEqual<A, B>
+			: false
+		: false;
+
+declare type _IsEqual<A, B> =
+	(<G>() => G extends A & G | G ? 1 : 2) extends
+	(<G>() => G extends B & G | G ? 1 : 2)
+		? true
+		: false;
+
 /**
  Returns a boolean for whether the given type is `never`.
 
@@ -1525,29 +1627,41 @@ declare type IsEmptyObject<T> = T extends EmptyObject_2 ? true : false;
  ```
  import type {IsNever, And} from 'type-fest';
 
- // https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
- type AreStringsEqual<A extends string, B extends string> =
- 	And<
- 		IsNever<Exclude<A, B>> extends true ? true : false,
- 		IsNever<Exclude<B, A>> extends true ? true : false
- 	>;
-
- type EndIfEqual<I extends string, O extends string> =
- 	AreStringsEqual<I, O> extends true
- 		? never
- 		: void;
-
- function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
- 	if (input === output) {
- 		process.exit(0);
- 	}
- }
-
- endIfEqual('abc', 'abc');
+ type A = IsNever<never>;
+ //=> true
+
+ type B = IsNever<any>;
+ //=> false
+
+ type C = IsNever<unknown>;
+ //=> false
+
+ type D = IsNever<never[]>;
+ //=> false
+
+ type E = IsNever<object>;
+ //=> false
+
+ type F = IsNever<string>;
+ //=> false
+ ```
+
+ @example
+ ```
+ import type {IsNever} from 'type-fest';
+
+ type IsTrue<T> = T extends true ? true : false;
+
+ // When a distributive conditional is instantiated with `never`, the entire conditional results in `never`.
+ type A = IsTrue<never>;
  //=> never
 
- endIfEqual('abc', '123');
- //=> void
+ // If you don't want that behaviour, you can explicitly add an `IsNever` check before the distributive conditional.
+ type IsTrueFixed<T> =
+ 	IsNever<T> extends true ? false : T extends true ? true : false;
+
+ type B = IsTrueFixed<never>;
+ //=> false
  ```
 
  @category Type Guard
@@ -1821,6 +1935,7 @@ declare type Minimum<Value extends number | bigint> = TagBase<{
 declare interface MiscRecords {
     "asset-daemon": AssetDaemonRecord;
     "asset-daemon:user-notify.state": AssetDaemonUserNotifyStateRecord;
+    "asset-daemon:validate.state": AssetDaemonValidateStateRecord;
     "deepstream-replicator.stats?": DeepstreamReplicatorStatsRecord;
 }
 
@@ -2000,7 +2115,7 @@ declare interface NxtError {
     errors?: NxtError[] | null;
 }
 
-declare type Nxtpression<ReturnValue = unknown, Context extends object = object> = {
+declare type Nxtpression<ReturnValue = unknown, Context extends Record<string, unknown> = Record<string, unknown>> = {
     /**
      * TS-HACK: this property doesn't really exist on the nxtpression string,
      * it is only here to make sure the generic Context won't get stripped.
@@ -2060,6 +2175,7 @@ declare interface NxtStatusMessage {
         title: string;
         url: string;
     };
+    data?: unknown;
 }
 
 declare interface NxtStatusNode extends NxtStatusObject {
@@ -2278,6 +2394,10 @@ declare interface Operator<T, R> {
 declare interface OperatorFunction<T, R> extends UnaryFunction<Observable<T>, Observable<R>> {
 }
 
+declare type PageOrientation = "landscape" | "portrait";
+
+declare type PageSize = "A5" | "A4" | "A3";
+
 declare interface PanelDomainPanelRecord {
     title?: string;
     /**
@@ -2399,6 +2519,39 @@ declare interface PlanningRecord {
     deadline?: string | null;
 }
 
+declare type PrintOptionalScriptNodes = "event" | "event-data" | "comment" | "heading" | "list" | "quote" | "paragraph" | "horizontalrule";
+
+declare type PrintOptions = PrintScriptOptions | PrintRundownOptions;
+
+declare interface PrintOptionsBase {
+    title: string;
+    horizontalMargin: number;
+    pageSize: PageSize;
+    orientation: PageOrientation;
+    fontSize: number;
+    fontFamily?: string;
+    hide: PrintOptionalScriptNodes[];
+}
+
+declare interface PrintRundownColumn {
+    key: "id" | "title" | "time" | "duration" | "position" | "accDuration" | "type";
+    label: string;
+    width: string;
+    textAlign: "right" | "left" | "center";
+}
+
+declare interface PrintRundownOptions extends PrintOptionsBase {
+    type: "rundown";
+    columns: PrintRundownColumn[];
+    rangeStart?: number;
+    rangeEnd?: number;
+    hide: Exclude<PrintOptionalScriptNodes, "event-data">[];
+}
+
+declare interface PrintScriptOptions extends PrintOptionsBase {
+    type: "script";
+}
+
 declare interface PromotedTag {
     name: string | null;
     icon: string | null;
@@ -2834,6 +2987,7 @@ declare interface RenderSceneObject {
     transcribe?: {
         language?: string;
         pan?: number[];
+        diarization?: boolean;
     };
     /** @deprecated Use video.crop instead */
     crop?: RenderSceneCrop;
@@ -2898,13 +3052,23 @@ declare interface RevsRecord {
 }
 
 declare interface RoleDomainRecords {
+    ":role": RoleRecord;
+    ":role.users?": RoleUsersRecord;
     ":role.tags": RoleTagsRecord;
 }
 
+declare type RoleRecord = {
+    permissions?: Record<string, string[]>;
+};
+
 declare interface RoleTagsRecord {
     value: string[];
 }
 
+declare type RoleUsersRecord = {
+    value?: string[];
+};
+
 declare interface RpcPermission {
     type: "rpc";
     method: string;
@@ -3251,6 +3415,7 @@ declare interface Settings {
             sortBy?: "index" | "title";
             showPreview?: boolean;
         };
+        contentMaxWidth?: number;
         colorTags?: PromotedTag[];
         readType?: "characters" | "words" | "wordsPerMinute";
         readRate?: number;
@@ -3436,6 +3601,7 @@ declare interface Settings {
     };
     print?: {
         fontFamilies?: string[];
+        presets?: Array<PrintOptions>;
     };
     hiddenPreviews?: Array<{
         id?: string;
@@ -3451,6 +3617,7 @@ declare interface Settings {
             downloadPath?: string;
             renderPath?: string;
             renderPresetPath?: string;
+            renderPresets?: string[];
             videoRenderPreset?: string;
             imageRenderPreset?: string;
             audioRenderPreset?: string;
@@ -3461,6 +3628,9 @@ declare interface Settings {
                 template?: string;
             };
         };
+        ograf?: {
+            template?: string;
+        };
         rive?: {
             template?: string;
         };
@@ -3536,8 +3706,10 @@ declare interface Settings {
         layout?: string;
     };
     performance?: {
-        /** List of message identifiers to ignore in overall health aggregation (format: "serviceName:messageText") */
-        ignoredMessages?: string[];
+        /** List of message identifiers to ignore warnings (format: "serviceName:messageText") */
+        ignoredWarnings?: string[];
+        /** List of message identifiers to ignore errors (format: "serviceName:messageText") */
+        ignoredErrors?: string[];
     };
     app?: {
         enableUpdate?: boolean;
@@ -3622,16 +3794,12 @@ declare interface ShotboxStreamGroup {
  ```
  import type {SingleKeyObject} from 'type-fest';
 
- const someFunction = <T>(parameter: SingleKeyObject<T>) => {};
+ declare function someFunction<T>(parameter: SingleKeyObject<T>): void;
 
- someFunction({
- 	value: true
- });
+ someFunction({value: true});
 
- someFunction({
- 	value: true,
- 	otherKey: true
- });
+ // @ts-expect-error
+ someFunction({value: true, otherKey: true});
  // Error: Argument of type '{value: boolean; otherKey: boolean}' is not assignable to parameter of type 'never'.ts(2345)
  ```
 
@@ -3646,6 +3814,48 @@ declare type Spread<T1, T2> = Omit<T2, keyof T1> & T1;
 
 declare type StatsRecord = Union["stats"];
 
+declare interface StorageDomainRecord {
+    zone: string;
+    hostname: string | null;
+    port?: number | null;
+    location?: string;
+    cache?: boolean | null;
+    allows?: string[];
+    capacity?: number | null;
+    rxBytesSecMax?: number | null;
+    txBytesSecMax?: number | null;
+    rxBytesSecLimit?: number | null;
+    txBytesSecLimit?: number | null;
+}
+
+declare interface StorageDomainRecords {
+    ":storage": StorageDomainRecord;
+    ":storage.stats": StorageStatsDomainRecord;
+    ":storage-zone": StorageZoneDomainRecord;
+}
+
+declare interface StorageFsStats {
+    concurrency?: number;
+    path?: string;
+    snapshot?: number | null;
+    available?: number;
+    free?: number;
+    used?: number;
+    size?: number;
+    state?: string;
+    [key: string]: unknown;
+}
+
+declare interface StorageIoQueues {
+    highest: number;
+    higher: number;
+    high: number;
+    normal: number;
+    low: number;
+    lower: number;
+    lowest: number;
+}
+
 declare interface StorageLocationsRecord {
     [key: string]: StorageLocationsRecordEntry;
 }
@@ -3675,6 +3885,58 @@ declare interface StorageRecords {
     "storage.zones?": StorageZonesRecord;
 }
 
+declare interface StorageS3Stats {
+    bucket?: string;
+    region?: string;
+    endpoint?: string;
+    path?: string;
+    storageClass?: string;
+    [key: string]: unknown;
+}
+
+declare interface StorageStatsDomainRecord {
+    id: string;
+    location: string;
+    timestamp: string;
+    type: string;
+    zone: string;
+    origin: string;
+    free: number | null;
+    size: number | null;
+    available: number | null;
+    cache: boolean | null;
+    capacity: number | null;
+    limiter: {
+        readBytesPerSecond: number | undefined;
+        writeBytesPerSecond: number | undefined;
+    };
+    http: {
+        downstreamConnected: number;
+        upstreamConnected: number;
+        pending: number;
+        completed: number;
+        failed: number;
+    };
+    io: {
+        read: {
+            bytesPerSecond: number;
+            pending: number;
+            queues: StorageIoQueues;
+        };
+        write: {
+            bytesPerSecond: number;
+            pending: number;
+            queues: StorageIoQueues;
+        };
+    };
+    fs?: StorageFsStats;
+    s3?: StorageS3Stats;
+}
+
+declare interface StorageZoneDomainRecord {
+    priority?: number;
+}
+
 declare interface StorageZonesRecord {
     [key: string]: {
         priority: number;
@@ -4159,6 +4421,39 @@ declare interface TemplateDomainRecords {
 
 declare interface TemplateProperty {
     path?: string;
+    type?: string;
+    label?: string;
+    defaultValue?: string;
+    widget?: {
+        type: string;
+    };
+    properties?: object;
+    items?: {
+        properties?: Record<string, TemplatePropertySchema>;
+    };
+    render?: {
+        type: "image";
+        profile?: {
+            format?: string;
+            video?: {
+                width: number;
+                height: number;
+                fit: "cover";
+            };
+        };
+    };
+}
+
+declare interface TemplatePropertySchema {
+    path?: string;
+    type?: string;
+    label?: string;
+    defaultValue?: string;
+    widget?: {
+        type: string;
+    };
+    items?: TemplatePropertySchema;
+    properties?: Record<string, TemplatePropertySchema>;
 }
 
 declare interface TemplateRecord {

package/dist/records/domains/connection/file/smb.d.ts

@@ -3,7 +3,9 @@ export interface FileConnectionSmbRecord extends FileConnectionBase {
     protocol?: "smb";
     host?: string;
     share?: string;
+    root?: string;
     workgroup?: string;
     username?: string;
     password?: string;
+    createFolders?: boolean;
 }

package/dist/records/domains/event.d.ts

@@ -10,11 +10,13 @@ export interface EventDomainRecords {
     ":event.duration?": EventDurationRecord;
     ":event.children?": EventChildrenRecord;
     ":event.props?": EventPropsRecord;
+    ":event.stats?": EventStatsRecord;
 }
 export interface EventRecord {
     start?: number | null;
     end?: number | null;
     duration?: number | null;
+    position?: string;
     text?: string;
     lang?: string;
     style?: string;
@@ -40,11 +42,15 @@ export interface EventChildrenRecord {
 type EventProps = {
     source?: string;
     cueCard?: boolean | string;
+    printRundownColor?: string;
     startTime?: number;
     shotboxGroup?: string | string[];
     shotboxVisible?: boolean;
 };
 export type EventPropsRecord = EventProps & Record<Exclude<string, keyof EventProps>, JsonValue>;
+export interface EventStatsRecord {
+    type?: string;
+}
 export interface EventOverlayRecord {
     [eventId: string]: {
         data: EventPropsRecord;

package/dist/records/domains/gallery.d.ts

@@ -0,0 +1,8 @@
+export interface GalleryDomainRecords {
+    ":gallery": GalleryDomainRecord;
+}
+export interface GalleryDomainRecord {
+    sources?: {
+        program?: string;
+    };
+}

package/dist/records/domains/gallery.js

@@ -0,0 +1 @@
+export {};