@nxtedition/types 23.0.60 → 23.0.62

package/dist/common/asset-indexer.d.ts

@@ -0,0 +1,98 @@
+import type { IsoTimestamp } from './index.ts';
+export interface AssetIndexerCoreFields {
+    id: string;
+    title?: string;
+    description?: string;
+    created?: IsoTimestamp;
+    createdBy?: string;
+    createdByTitle?: string;
+    origin?: string;
+    modified?: IsoTimestamp;
+    modifiedBy?: string;
+    modifiedByAll?: string[];
+    modifiedByTitle?: string;
+    duration?: number;
+    tags?: string[];
+    deadlines?: IsoTimestamp[];
+    deadlinesCount?: number;
+    deadlines_date_range?: Array<{
+        gte: IsoTimestamp;
+        lte: IsoTimestamp;
+    }>;
+    assignees?: string[];
+    assigneesCount?: number;
+    locations?: Array<{
+        lat: number;
+        lon: number;
+    }>;
+    locationsCount?: number;
+    types?: string[];
+    primaryType?: string;
+    rawTypes?: string[];
+    status?: {
+        messages?: Array<{
+            code?: string;
+            level?: number;
+        }>;
+    };
+    published?: IsoTimestamp[];
+    publishedCount?: number;
+    storage?: {
+        files?: string[];
+        replicas?: string[];
+        locations?: string[];
+        zones?: string[];
+        uploading?: boolean;
+        size?: number;
+        filesCount?: number;
+        replicasCount?: number;
+        locationsCount?: number;
+    };
+    refs?: number;
+    refsByType?: Record<string, number>;
+    recurrence_date_range?: {
+        gte: IsoTimestamp;
+        lte: IsoTimestamp | null;
+    };
+    media_date_range?: {
+        gte: IsoTimestamp;
+        lte: IsoTimestamp;
+    };
+    ingestschedule_date_range?: {
+        gte: IsoTimestamp;
+        lte: IsoTimestamp | null;
+    };
+    ingestschedule?: {
+        type?: string;
+        sources?: string[];
+        routes?: string[];
+    };
+    username?: string;
+    user?: string;
+    "note.text"?: string;
+    subtitles?: string;
+    graphics?: string;
+    story?: {
+        content?: string;
+        graphics?: string[];
+    };
+    storyboard?: {
+        content?: unknown[];
+    };
+    /**
+     * These fields are populated from the provided `{id}:asset.media?` record as
+     * configured in the `asset.media` record. Due to the dynamic nature of that record,
+     * it's hard to type these fields more specifically. For now we only list a few
+     * (probably) expected fields.
+     */
+    media?: {
+        audio?: unknown;
+        video?: unknown;
+        timecode?: unknown;
+        language?: unknown;
+        transcribe?: unknown;
+    };
+    embedding?: Array<{
+        vector: number[];
+    }>;
+}

package/dist/common/asset-indexer.js

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

package/dist/common/index.d.ts

@@ -1,3 +1,4 @@
+export * from './asset-indexer.ts';
 export * from './block.ts';
 export * from './clone.ts';
 export * from './date.ts';
@@ -6,6 +7,7 @@ export * from './location.ts';
 export * from './nxtpression.ts';
 export * from './lock.ts';
 export * from './media.ts';
+export * from './panel-property.ts';
 export * from './pipeline.ts';
 export * from './promoted-tag.ts';
 export * from './render-preset.ts';
@@ -13,9 +15,11 @@ export * from './render-profile.ts';
 export * from './render-query.ts';
 export * from './render-scene.ts';
 export * from './rule.ts';
+export * from './schema-property.ts';
 export * from './search.ts';
 export * from './settings.ts';
 export * from './subtitle-style.ts';
+export * from './subtitle.ts';
 export * from './error.ts';
 export * from './user-notification.ts';
 export interface Message {

package/dist/common/index.js

@@ -1,3 +1,4 @@
+export * from "./asset-indexer.js";
 export * from "./block.js";
 export * from "./clone.js";
 export * from "./date.js";
@@ -6,6 +7,7 @@ export * from "./location.js";
 export * from "./nxtpression.js";
 export * from "./lock.js";
 export * from "./media.js";
+export * from "./panel-property.js";
 export * from "./pipeline.js";
 export * from "./promoted-tag.js";
 export * from "./render-preset.js";
@@ -13,8 +15,10 @@ export * from "./render-profile.js";
 export * from "./render-query.js";
 export * from "./render-scene.js";
 export * from "./rule.js";
+export * from "./schema-property.js";
 export * from "./search.js";
 export * from "./settings.js";
 export * from "./subtitle-style.js";
+export * from "./subtitle.js";
 export * from "./error.js";
 export * from "./user-notification.js";

package/dist/common/panel-property.d.ts

@@ -0,0 +1,29 @@
+import type { Nxtpression } from './nxtpression.ts';
+export interface PanelProperty<Value = unknown> {
+    /** Specifying what type of data will be entered into the field. */
+    type: "array" | "asset" | "boolean" | "datetime" | "number" | "string" | "object" | "rpc";
+    /** User-friendly title of the property. This will be used as the field's label in the UI. */
+    title?: string;
+    description?: string;
+    domain?: string;
+    path?: string;
+    computed?: Nxtpression<Value>;
+    /** An object specifying where to index the data. Adding this will effectively make the data searchable. */
+    index?: {
+        /** A string specifying the user-friendly title of the search property. This is what users will see when creating search filters and bookmarks. */
+        label: string;
+        /** A string specifying where to store the data in the search index. Note that this should be a globally unique value in the system. Typically you'd use `{domain}.{path}` and you should prefer English in camel case */
+        path: string;
+    };
+    /** If present, indicates that the user must specify a value for the asset to be treated as valid. */
+    required?: boolean;
+    oneOf?: Array<{
+        const?: Value;
+        title?: string;
+    }>;
+    anyOf?: Array<{
+        const?: Value;
+        title?: string;
+    }>;
+    enum?: Value[];
+}

package/dist/common/panel-property.js

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

package/dist/common/schema-property.d.ts

@@ -0,0 +1,12 @@
+import type { PanelProperty, Nxtpression } from '../';
+export interface SchemaProperty extends PanelProperty {
+    recordName?: Nxtpression<string, {
+        id: string;
+    }>;
+    setter?: Nxtpression<(value: unknown) => void, {
+        id: string;
+        value: unknown;
+    }>;
+    default?: unknown;
+    const?: unknown;
+}

package/dist/common/schema-property.js

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

package/dist/common/settings.d.ts

@@ -106,6 +106,7 @@ export interface Settings {
     };
     rundown?: {
         eventThumbnails?: boolean;
+        scriptEventFolding: "folded" | "unfoldedUntilFolded";
     };
     gallery?: {
         dimOnBlur?: boolean;
@@ -220,6 +221,15 @@ export interface Settings {
     };
     edit?: {
         thumbnailView?: "filmStrip" | "thumbnail" | "none";
+        normalize?: {
+            presets?: Array<{
+                id: string;
+                title: string;
+                i: number;
+                tp: number;
+            }>;
+            defaultPresetId?: string;
+        };
         voiceOver?: {
             inputDevice?: string;
             inputGainDb?: number;
@@ -329,6 +339,12 @@ export interface Settings {
         subscribeSearchHits?: boolean;
         parseRegex?: boolean;
     };
+    display?: {
+        disableHotArea?: boolean;
+    };
+    bookmarks?: {
+        refreshInterval?: number;
+    };
 }
 export type SettingsPaths = Paths<Settings>;
 interface ModuleTabs {

package/dist/common/subtitle.d.ts

@@ -0,0 +1,4 @@
+export type ApplySubtitleSource = string | {
+    type: "file";
+    file: string;
+};

package/dist/common/subtitle.js

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

package/dist/nxtpression.d.ts

@@ -137,6 +137,7 @@ declare interface AssetDomainRecords {
     ":asset.media?": AssetDomainMediaProvidedRecord;
     ":asset.presence?": AssetDomainPresenceProvidedRecord;
     ":asset.comments?": AssetCommentsRecord;
+    ":asset.record?": AssetRecordProvidedRecord;
 }
 
 declare interface AssetDomainStatusProvidedRecord {
@@ -157,6 +158,10 @@ declare interface AssetDurationRecord {
     dynamic?: Dynamic;
 }
 
+declare interface AssetDynamicPropertiesProvidedRecord {
+    value?: DynamicProperty[];
+}
+
 declare interface AssetEmbeddingRecord {
     value?: Nxtpression<string, {
         id: string;
@@ -175,6 +180,104 @@ declare interface AssetIconRecord {
     dynamic?: Dynamic;
 }
 
+declare interface AssetIndexerCoreFields {
+    id: string;
+    title?: string;
+    description?: string;
+    created?: IsoTimestamp;
+    createdBy?: string;
+    createdByTitle?: string;
+    origin?: string;
+    modified?: IsoTimestamp;
+    modifiedBy?: string;
+    modifiedByAll?: string[];
+    modifiedByTitle?: string;
+    duration?: number;
+    tags?: string[];
+    deadlines?: IsoTimestamp[];
+    deadlinesCount?: number;
+    deadlines_date_range?: Array<{
+        gte: IsoTimestamp;
+        lte: IsoTimestamp;
+    }>;
+    assignees?: string[];
+    assigneesCount?: number;
+    locations?: Array<{
+        lat: number;
+        lon: number;
+    }>;
+    locationsCount?: number;
+    types?: string[];
+    primaryType?: string;
+    rawTypes?: string[];
+    status?: {
+        messages?: Array<{
+            code?: string;
+            level?: number;
+        }>;
+    };
+    published?: IsoTimestamp[];
+    publishedCount?: number;
+    storage?: {
+        files?: string[];
+        replicas?: string[];
+        locations?: string[];
+        zones?: string[];
+        uploading?: boolean;
+        size?: number;
+        filesCount?: number;
+        replicasCount?: number;
+        locationsCount?: number;
+    };
+    refs?: number;
+    refsByType?: Record<string, number>;
+    recurrence_date_range?: {
+        gte: IsoTimestamp;
+        lte: IsoTimestamp | null;
+    };
+    media_date_range?: {
+        gte: IsoTimestamp;
+        lte: IsoTimestamp;
+    };
+    ingestschedule_date_range?: {
+        gte: IsoTimestamp;
+        lte: IsoTimestamp | null;
+    };
+    ingestschedule?: {
+        type?: string;
+        sources?: string[];
+        routes?: string[];
+    };
+    username?: string;
+    user?: string;
+    "note.text"?: string;
+    subtitles?: string;
+    graphics?: string;
+    story?: {
+        content?: string;
+        graphics?: string[];
+    };
+    storyboard?: {
+        content?: unknown[];
+    };
+    /**
+     * These fields are populated from the provided `{id}:asset.media?` record as
+     * configured in the `asset.media` record. Due to the dynamic nature of that record,
+     * it's hard to type these fields more specifically. For now we only list a few
+     * (probably) expected fields.
+     */
+    media?: {
+        audio?: unknown;
+        video?: unknown;
+        timecode?: unknown;
+        language?: unknown;
+        transcribe?: unknown;
+    };
+    embedding?: Array<{
+        vector: number[];
+    }>;
+}
+
 declare interface AssetLocationsRecord {
     value?: Nxtpression<Array<{
         lat: number;
@@ -208,11 +311,21 @@ declare interface AssetRawTypesProvidedRecord {
     value?: string[];
 }
 
+/**
+ * Elasticsearch indexed record for an asset.
+ * Extends core fields with dynamic properties from panels and schemas.
+ */
+declare interface AssetRecordProvidedRecord extends AssetIndexerCoreFields {
+    /** Dynamic properties from panels and schemas (keys defined by property.index.path) */
+    [dynamicProperty: string]: unknown;
+}
+
 declare interface AssetRecords {
     "asset.assignees": AssetAssigneesRecord;
     "asset.clone": AssetCloneRecord;
     "asset.deadlines": AssetDeadlinesRecord;
     "asset.duration": AssetDurationRecord;
+    "asset.dynamicProperties?": AssetDynamicPropertiesProvidedRecord;
     "asset.embedding": AssetEmbeddingRecord;
     "asset.icon": AssetIconRecord;
     "asset.locations": AssetLocationsRecord;
@@ -244,7 +357,7 @@ declare interface AssetTagsRecord {
 }
 
 declare interface AssetTitleProvidedRecord {
-    value?: string;
+    value?: string | null;
 }
 
 declare interface AssetTitleRecord {
@@ -505,11 +618,44 @@ declare interface DesignViewRow<Id = string, Key = string, Value = void> {
     value: Value;
 }
 
-declare interface DomainRecords extends AssetDomainRecords, AuthDomainRecords, BundleDomainRecords, CalendarEventDomainRecords, CloneDomainRecords, CommentReactionDomainRecords, CommentReadMarkDomainRecords, CommentDomainRecords, ConditionDomainRecords, ConnectionDomainRecords, ContactDomainRecords, DeepstreamDomainRecords, DesignDomainRecords, EditDomainRecords, EventDomainRecords, FileDomainRecords, GeneralDomainRecords, HarvestDomainRecords, IngestclipDomainRecords, MediaDomainRecords, MonitorDomainRecords, PanelDomainRecords, PermissionDomainRecords, PipelinePresetDomainRecords, PipelineDomainRecords, PlanningDomainRecords, PrompterDomainRecords, PublishDomainRecords, PublishedDomainRecords, RenderPresetDomainRecords, RenderDomainRecords, RevsDomainRecords, RoleDomainRecords, ScriptDomainRecords, SearchDomainRecords, SettingsDomainRecords, ShotboxDomainRecords, StoryboardDomainRecords, SubtitleStyleDomainRecords, SubtitleDomainRecords, TemplateDomainRecords, UserNotificationStatusDomainRecords, UserNotificationDomainRecords, UserDomainRecords, UsernameDomainRecords {
+declare interface DeviceDomainRecord {
+    type?: "display";
+    display?: {
+        activeAsset?: string;
+        editor?: string;
+    };
+}
+
+declare interface DeviceDomainRecords {
+    ":device": DeviceDomainRecord;
+    ":device.status?": DeviceDomainStatusRecord;
+}
+
+declare interface DeviceDomainStatusRecord {
+    since?: string;
+    heartbeat?: string;
+    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, ScriptDomainRecords, SearchDomainRecords, SettingsDomainRecords, ShotboxDomainRecords, StoryboardDomainRecords, SubtitleStyleDomainRecords, SubtitleDomainRecords, TemplateDomainRecords, UserNotificationStatusDomainRecords, UserNotificationDomainRecords, UserDomainRecords, UsernameDomainRecords {
 }
 
 declare type Dynamic = false | string[];
 
+/**
+ * Dynamic property definition.
+ * Properties come from :panel assets or :schema assets.
+ */
+declare interface DynamicProperty extends Omit<PanelProperty, "path">, Omit<SchemaProperty, "path"> {
+    /** ID of the panel asset that defines this property (for panel-sourced properties) */
+    panel?: string;
+    /** ID of the schema asset that defines this property (for schema-sourced properties) */
+    schema?: string;
+    /** List of asset types this property supports */
+    supports: string[];
+    path: string;
+}
+
 declare interface EditDomainRecords {
     ":edit": EditRecord;
 }
@@ -948,6 +1094,14 @@ declare interface FileStats extends File_2 {
     complete: boolean;
 }
 
+declare interface FolderDomainRecords {
+    ":folder.items": FolderItemsDomainRecord;
+}
+
+declare interface FolderItemsDomainRecord {
+    value: string[];
+}
+
 declare interface FontFace_2 {
     name: string;
     family: string;
@@ -1207,6 +1361,48 @@ declare interface IngestclipDomainRecords {
     ":ingestclip": IngestclipDomainRecord;
 }
 
+declare interface IngestIo {
+    route?: string;
+    /** List of connection IDs */
+    publish?: string[];
+}
+
+declare interface IngestScheduleDomainRecord {
+    io?: {
+        [id: string]: IngestIo;
+    };
+    sourcesHint?: string;
+    enabled?: boolean;
+    clipname?: Nxtpression<string>;
+    autoTags?: string[];
+    storyboard?: string | null;
+    pipeline?: string | null;
+    type?: "instant" | "repeat" | "salami";
+    salami?: {
+        gallery?: string | null;
+        tag?: string;
+    };
+    repeat?: IngestScheduleRepeat;
+}
+
+declare interface IngestScheduleDomainRecords {
+    ":ingestschedule": IngestScheduleDomainRecord;
+    ":ingestschedule.stats?": IngestScheduleDomainStatsRecord;
+}
+
+declare interface IngestScheduleDomainStatsRecord {
+    error?: unknown;
+}
+
+declare interface IngestScheduleRepeat {
+    freq?: RepeatFreq;
+    until?: string;
+    start?: string;
+    tzid?: string;
+    duration?: number;
+    byweekday?: number[];
+}
+
 /**
  The actual implementation of `IsUnion`.
  */
@@ -1429,6 +1625,7 @@ declare interface MediaProbeRecord {
 declare interface MediaRecords {
     "media.subtitles": MediaSubtitlesRecord;
     "media.subtitles?": MediaSubtitlesProvidedRecord;
+    "media.transcribe": MediaTranscribeRecord;
     "media.transcribe?": MediaTranscribeProvidedRecord;
     "media.fonts?": MediaFonts;
     "media.consolidate": MediaConsolidateRecord;
@@ -1474,6 +1671,16 @@ declare interface MediaTranscribeProvidedRecord {
     translate?: {
         languages: Record<string, string>;
     };
+    replacers?: Record<string, TranscribeReplacer | TranscribeReplacer[]>;
+}
+
+declare interface MediaTranscribeRecord {
+    engines: Record<string, string>;
+    languages: Record<string, string>;
+    translate?: {
+        languages: Record<string, string>;
+    };
+    replacers?: Record<string, TranscribeReplacer | TranscribeReplacer[]>;
 }
 
 declare type MediaTranscriptChangesRecord = {
@@ -1682,6 +1889,14 @@ declare const NODE_STATE_KEY = "$";
 
 declare type NodeContent = EventNodeContent | TextNodeContent | ParagraphNodeContent | CommentNodeContent | ListNodeContent | ListItemNodeContent | HeadingNodeContent | HorizontalRuleContent | QuoteNodeContent;
 
+declare interface NoteDomainRecord {
+    value: string;
+}
+
+declare interface NoteDomainRecords {
+    ":note": NoteDomainRecord;
+}
+
 declare type NotificationReason = "mentioned" | "assigned" | "author" | "participated" | "always";
 
 declare type Numeric<T extends bigint> = `${T}` extends `${infer N extends number}` ? N : never;
@@ -2005,7 +2220,7 @@ declare interface PanelLayoutItem {
     widget?: LayoutWidget;
 }
 
-declare interface PanelProperty {
+declare interface PanelProperty<Value = unknown> {
     /** Specifying what type of data will be entered into the field. */
     type: "array" | "asset" | "boolean" | "datetime" | "number" | "string" | "object" | "rpc";
     /** User-friendly title of the property. This will be used as the field's label in the UI. */
@@ -2013,7 +2228,7 @@ declare interface PanelProperty {
     description?: string;
     domain?: string;
     path?: string;
-    computed?: Nxtpression<unknown>;
+    computed?: Nxtpression<Value>;
     /** An object specifying where to index the data. Adding this will effectively make the data searchable. */
     index?: {
         /** A string specifying the user-friendly title of the search property. This is what users will see when creating search filters and bookmarks. */
@@ -2024,13 +2239,14 @@ declare interface PanelProperty {
     /** If present, indicates that the user must specify a value for the asset to be treated as valid. */
     required?: boolean;
     oneOf?: Array<{
-        const?: unknown;
+        const?: Value;
         title?: string;
     }>;
     anyOf?: Array<{
-        const?: unknown;
+        const?: Value;
         title?: string;
     }>;
+    enum?: Value[];
 }
 
 declare interface ParagraphNodeContent extends ElementNodeContent {
@@ -2470,6 +2686,13 @@ declare interface RenderSceneObject {
     };
 }
 
+/**
+ * 0 = Monthly
+ * 2 = Weekly
+ * 3 = Daily
+ */
+declare type RepeatFreq = 0 | 2 | 3;
+
 declare interface ReplaceOperation {
     op: 'replace';
     path: string;
@@ -2516,6 +2739,18 @@ declare interface RpcPermission {
     tags?: undefined;
 }
 
+declare interface SchemaProperty extends PanelProperty {
+    recordName?: Nxtpression<string, {
+        id: string;
+    }>;
+    setter?: Nxtpression<(value: unknown) => void, {
+        id: string;
+        value: unknown;
+    }>;
+    default?: unknown;
+    const?: unknown;
+}
+
 /**
  * A record for non-script automation assets that can have child events.
  */
@@ -2830,6 +3065,7 @@ declare interface Settings {
     };
     rundown?: {
         eventThumbnails?: boolean;
+        scriptEventFolding: "folded" | "unfoldedUntilFolded";
     };
     gallery?: {
         dimOnBlur?: boolean;
@@ -2944,6 +3180,15 @@ declare interface Settings {
     };
     edit?: {
         thumbnailView?: "filmStrip" | "thumbnail" | "none";
+        normalize?: {
+            presets?: Array<{
+                id: string;
+                title: string;
+                i: number;
+                tp: number;
+            }>;
+            defaultPresetId?: string;
+        };
         voiceOver?: {
             inputDevice?: string;
             inputGainDb?: number;
@@ -3053,12 +3298,24 @@ declare interface Settings {
         subscribeSearchHits?: boolean;
         parseRegex?: boolean;
     };
+    display?: {
+        disableHotArea?: boolean;
+    };
+    bookmarks?: {
+        refreshInterval?: number;
+    };
 }
 
 declare interface SettingsDomainRecords {
     ":settings": SettingsRecord;
+    ":settings.node": SettingsNodeRecord;
 }
 
+declare type SettingsNodeRecord = Record<string, {
+    collapsed: boolean;
+    hidden: boolean;
+}>;
+
 declare interface SettingsPanelStoreTab extends ModuleTabsSettingsValue {
     activeSectionIndex?: number;
 }
@@ -3568,6 +3825,38 @@ declare interface TextNodeContent {
     format?: number;
 }
 
+declare interface TranscribeForEachWordReplacer {
+    type: "items";
+    items: string[];
+    _comment?: string;
+    replacers: Array<{
+        /** Expression that should return RegExp or string arg to new RegExp */
+        pattern: Nxtpression<unknown, {
+            item: string;
+        }>;
+        replacement: Nxtpression<string | ((...args: unknown[]) => string), {
+            item: string;
+        }>;
+        flags?: string;
+        _comment?: string;
+    }>;
+}
+
+declare type TranscribeReplacer = TranscribeReplaceReplacer | TranscribeForEachWordReplacer;
+
+declare interface TranscribeReplaceReplacer {
+    type?: "replace";
+    /** Expression that should return RegExp or string arg to new RegExp */
+    pattern: Nxtpression<unknown, {
+        item: string;
+    }>;
+    replacement: Nxtpression<string | ((...args: unknown[]) => string), {
+        item: string;
+    }>;
+    flags?: string;
+    _comment?: string;
+}
+
 /**
  * Type tag for specifying numeric bit-width representations.
  *