@nxtedition/types 23.0.39 → 23.0.40

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.
@@ -299,6 +299,10 @@ declare interface CommentDomainRepliesProvidedRecord {
299
299
  value?: string[];
300
300
  }
301
301
 
302
+ declare interface CommentNodeContent extends ElementNodeContent {
303
+ type: "comment";
304
+ }
305
+
302
306
  declare interface CommentReactionDomainRecord {
303
307
  comment: string;
304
308
  user: string;
@@ -409,11 +413,49 @@ declare interface EditRecord {
409
413
  changeId?: string;
410
414
  }
411
415
 
416
+ declare type ElementFormatType = 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
417
+
418
+ declare interface ElementNodeContent {
419
+ type: SerializedLexicalNode["type"];
420
+ children: TextNodeContent[];
421
+ }
422
+
412
423
  declare interface EventDomainRecords {
413
424
  ":event": EventRecord;
414
- ":event._template?": Record<string, unknown>;
425
+ ":event._template?": EventTemplateRecord;
426
+ ":event.overlay?": EventOverlayRecord;
427
+ ":event.template?": EventTemplateRecord;
428
+ ":event.duration?": EventDurationRecord;
429
+ ":event.props?": EventPropsRecord;
430
+ }
431
+
432
+ declare interface EventDurationRecord {
433
+ scheduled?: number;
434
+ actual?: number;
435
+ in?: number;
436
+ out?: number | null;
437
+ }
438
+
439
+ declare interface EventNodeContent {
440
+ type: "event";
441
+ id: string;
442
+ mixin: string;
443
+ children: EventNodeContent[];
444
+ }
445
+
446
+ declare interface EventOverlayRecord {
447
+ [eventId: string]: {
448
+ data: EventPropsRecord;
449
+ };
415
450
  }
416
451
 
452
+ declare type EventProps = {
453
+ source?: string;
454
+ cueCard?: boolean | string;
455
+ };
456
+
457
+ declare type EventPropsRecord = EventProps & Record<Exclude<string, keyof EventProps>, JsonValue>;
458
+
417
459
  declare interface EventRecord {
418
460
  start?: number;
419
461
  end?: number;
@@ -424,6 +466,14 @@ declare interface EventRecord {
424
466
  styleOverrides?: SubtitleEventStyleOverrides;
425
467
  }
426
468
 
469
+ declare interface EventTemplateRecord {
470
+ mixin?: string[];
471
+ properties?: object;
472
+ layout?: {
473
+ title?: string;
474
+ };
475
+ }
476
+
427
477
  declare interface FacebookConnectionRecord extends ConnectionRecordCommon {
428
478
  type: "facebook";
429
479
  grantedScopes?: string[];
@@ -637,6 +687,16 @@ declare interface FileStats extends File_2 {
637
687
  speed?: number & Minimum<0>;
638
688
  }
639
689
 
690
+ declare interface FontFace_2 {
691
+ name: string;
692
+ family: string;
693
+ asset: string;
694
+ url: string;
695
+ weight: number;
696
+ style: "normal" | "italic";
697
+ ranges: Range_2[];
698
+ }
699
+
640
700
  declare interface GeneralCreatedRecord {
641
701
  time?: string;
642
702
  user?: string;
@@ -688,12 +748,27 @@ declare interface GeneralTitleRecord {
688
748
 
689
749
  declare type Get<Data, Path extends string> = Path extends keyof Data ? Data[Path] : unknown;
690
750
 
751
+ declare interface HeadingNodeContent extends ElementNodeContent {
752
+ type: "heading";
753
+ tag: "h1" | "h2" | "h3";
754
+ }
755
+
756
+ declare interface HorizontalRuleContent {
757
+ type: "horizontalrule";
758
+ }
759
+
691
760
  export declare const isNxtpressionFetch: (input: unknown) => input is NxtpressionFetch;
692
761
 
693
762
  export declare const isNxtpressionNxt: (input: unknown) => input is NxtpressionNxt;
694
763
 
695
764
  declare type IsoTimestamp = string;
696
765
 
766
+ declare type JsonPrimitive = string | number | boolean | null;
767
+
768
+ declare type JsonValue = JsonPrimitive | JsonValue[] | {
769
+ [key: string]: JsonValue;
770
+ };
771
+
697
772
  declare interface KeymapSetting {
698
773
  title: string;
699
774
  sequence?: string;
@@ -701,6 +776,20 @@ declare interface KeymapSetting {
701
776
 
702
777
  declare type LayoutWidget = WidgetType | WidgetItem;
703
778
 
779
+ declare interface ListItemNodeContent {
780
+ type: "listitem";
781
+ value: number;
782
+ checked?: boolean;
783
+ children: TextNodeContent[];
784
+ }
785
+
786
+ declare interface ListNodeContent {
787
+ type: "list";
788
+ listType: "bullet" | "number" | "check";
789
+ tag: "ul" | "ol";
790
+ children: ListItemNodeContent[];
791
+ }
792
+
704
793
  declare type Maximum<Value extends number | bigint> = TagBase<{
705
794
  target: Value extends number ? "number" : "bigint";
706
795
  kind: "maximum";
@@ -940,6 +1029,10 @@ declare interface NetworkInterfaceInfo {
940
1029
  txErrorsValue?: number;
941
1030
  }
942
1031
 
1032
+ declare const NODE_STATE_KEY = "$";
1033
+
1034
+ declare type NodeContent = EventNodeContent | TextNodeContent | ParagraphNodeContent | CommentNodeContent | ListNodeContent | ListItemNodeContent | HeadingNodeContent | HorizontalRuleContent | QuoteNodeContent;
1035
+
943
1036
  declare type NotificationReason = "mentioned" | "assigned" | "author" | "participated" | "always";
944
1037
 
945
1038
  declare type Numeric<Value extends number | bigint> = Value extends number ? Value : `BigInt(${Value})`;
@@ -1284,6 +1377,10 @@ declare interface PanelProperty {
1284
1377
  oneOf?: unknown[];
1285
1378
  }
1286
1379
 
1380
+ declare interface ParagraphNodeContent extends ElementNodeContent {
1381
+ type: "paragraph";
1382
+ }
1383
+
1287
1384
  declare type Paths<Data> = keyof Data & string;
1288
1385
 
1289
1386
  declare type Pattern<Value extends string> = TagBase<{
@@ -1432,6 +1529,10 @@ declare interface PublishStatsRecordCommon {
1432
1529
  defaults?: Record<string, unknown>;
1433
1530
  }
1434
1531
 
1532
+ declare interface QuoteNodeContent extends ElementNodeContent {
1533
+ type: "quote";
1534
+ }
1535
+
1435
1536
  export declare const randomNxtpressionFetch: () => NxtpressionFetch;
1436
1537
 
1437
1538
  export declare const randomNxtpressionNxt: () => {
@@ -1447,6 +1548,11 @@ export declare const randomNxtpressionNxt: () => {
1447
1548
  hash: never;
1448
1549
  };
1449
1550
 
1551
+ declare type Range_2 = [
1552
+ number,
1553
+ number
1554
+ ];
1555
+
1450
1556
  declare type Records = {
1451
1557
  [Property in Domains as `${string}${Property}`]: DomainRecords[Property];
1452
1558
  } & {
@@ -1469,6 +1575,10 @@ declare type Records = {
1469
1575
  languages: Record<string, string>;
1470
1576
  };
1471
1577
  };
1578
+ "media.fonts?": {
1579
+ fontFaces?: FontFace_2[];
1580
+ fontFamilyNames?: Array<FontFace_2["family"]>;
1581
+ };
1472
1582
  "media.consolidate": {
1473
1583
  presets?: {
1474
1584
  [type in MediaType]: RenderPreset;
@@ -1526,23 +1636,7 @@ declare interface RenderDomainCpuStats {
1526
1636
  size: number | null;
1527
1637
  };
1528
1638
  meminfo: {
1529
- total: number | null;
1530
- free: number | null;
1531
- used: number | null;
1532
- active: number | null;
1533
- available: number | null;
1534
- buffers: number | null;
1535
- cached: number | null;
1536
- buffcache: number | null;
1537
- reclaimable: number | null;
1538
- swaptotal: number | null;
1539
- swapused: number | null;
1540
- swapfree: number | null;
1541
- slab: number | null;
1542
- sReclaimable: number | null;
1543
- kernelStack: number | null;
1544
- memTotal: number | null;
1545
- memAvailable: number | null;
1639
+ [key: string]: unknown;
1546
1640
  };
1547
1641
  };
1548
1642
  }
@@ -1595,13 +1689,13 @@ declare interface RenderDomainStatsRecord {
1595
1689
  available?: boolean | null;
1596
1690
  toobusy?: boolean | null;
1597
1691
  cpuAvailable?: boolean | null;
1598
- cpuComputeAvailable?: boolean | null;
1692
+ cpuComputeAvailable?: number | null;
1599
1693
  cpuComputeReservation?: number | null;
1600
1694
  cpuCompute?: number | null;
1601
1695
  cpuComputeLimit?: number | null;
1602
1696
  cpuComputeTotal?: number | null;
1603
1697
  cpuComputeValue?: number | null;
1604
- cpuMemoryAvailable?: boolean | null;
1698
+ cpuMemoryAvailable?: number | null;
1605
1699
  cpuMemoryReservation?: number | null;
1606
1700
  cpuMemory?: number | null;
1607
1701
  cpuMemoryLimit?: number | null;
@@ -1609,19 +1703,19 @@ declare interface RenderDomainStatsRecord {
1609
1703
  cpuMemoryTotal?: number | null;
1610
1704
  gpuType?: string | null;
1611
1705
  gpuAvailable?: boolean | null;
1612
- gpuComputeAvailable?: boolean | null;
1706
+ gpuComputeAvailable?: number | null;
1613
1707
  gpuComputeReservation?: number | null;
1614
1708
  gpuCompute?: number | null;
1615
1709
  gpuComputeLimit?: number | null;
1616
1710
  gpuComputeValue?: number | null;
1617
1711
  gpuComputeTotal?: number | null;
1618
- gpuMemoryAvailable?: boolean | null;
1712
+ gpuMemoryAvailable?: number | null;
1619
1713
  gpuMemoryReservation?: number | null;
1620
1714
  gpuMemory?: number | null;
1621
1715
  gpuMemoryLimit?: number | null;
1622
1716
  gpuMemoryValue?: number | null;
1623
1717
  gpuMemoryTotal?: number | null;
1624
- gpuQueueAvailable?: boolean | null;
1718
+ gpuQueueAvailable?: number | null;
1625
1719
  gpuQueueReservation?: number | null;
1626
1720
  gpuQueueLimit?: number | null;
1627
1721
  gpuQueueValue?: number | null;
@@ -1632,10 +1726,10 @@ declare interface RenderDomainStatsRecord {
1632
1726
  gpuEncoderTotal?: number | null;
1633
1727
  gpuDecoder?: number | null;
1634
1728
  gpuDecoderLimit?: number | null;
1635
- gpuDecoderValue?: null;
1729
+ gpuDecoderValue?: number | null;
1636
1730
  gpuDecoderTotal?: number | null;
1637
1731
  netAvailable?: boolean | null;
1638
- netTransferAvailable?: boolean | null;
1732
+ netTransferAvailable?: number | null;
1639
1733
  netTransferReservation?: number | null;
1640
1734
  netTransfer?: number | null;
1641
1735
  netTransferLimit?: number | null;
@@ -1648,6 +1742,8 @@ declare interface RenderDomainStatsRecord {
1648
1742
  gpuStat?: RenderDomainGpuStats | null;
1649
1743
  cpuStat?: RenderDomainCpuStats | null;
1650
1744
  netStat?: RenderDomainNetStats | null;
1745
+ limits?: unknown;
1746
+ taskset?: string;
1651
1747
  }
1652
1748
 
1653
1749
  declare type RenderPreset = RenderPresetObject | string;
@@ -1765,14 +1861,64 @@ declare interface RpcPermission {
1765
1861
  tags?: undefined;
1766
1862
  }
1767
1863
 
1864
+ /**
1865
+ * A record for non-script automation assets that can have child events.
1866
+ */
1768
1867
  declare interface ScriptChildrenRecord {
1769
1868
  value?: string[];
1770
1869
  }
1771
1870
 
1871
+ declare interface ScriptContentRecord {
1872
+ nodes: NodeContent[];
1873
+ }
1874
+
1772
1875
  declare interface ScriptDomainRecords {
1876
+ ":script": ScriptRecord;
1877
+ ":script?": ScriptEditorStateRecord;
1878
+ ":script.revisions?": ScriptRevisionsRecord;
1879
+ ":script.revision": ScriptRevisionRecord;
1880
+ ":script.revision?": ScriptEditorStateRevisionRecord;
1881
+ ":script.content?": ScriptContentRecord;
1882
+ ":script.text?": ScriptTextRecord;
1773
1883
  ":script.children": ScriptChildrenRecord;
1774
1884
  }
1775
1885
 
1886
+ declare interface ScriptEditorStateRecord {
1887
+ value: SerializedEditorState;
1888
+ }
1889
+
1890
+ declare interface ScriptEditorStateRevisionRecord {
1891
+ $parent: string;
1892
+ scriptId: string;
1893
+ userId: string;
1894
+ value: SerializedEditorState;
1895
+ }
1896
+
1897
+ declare interface ScriptRecord {
1898
+ value: YjsSnapshot;
1899
+ }
1900
+
1901
+ declare interface ScriptRevision {
1902
+ id: string;
1903
+ userId: string;
1904
+ }
1905
+
1906
+ declare interface ScriptRevisionRecord {
1907
+ $parent: string;
1908
+ scriptId: string;
1909
+ userId: string;
1910
+ value: YjsSnapshot;
1911
+ }
1912
+
1913
+ declare interface ScriptRevisionsRecord {
1914
+ value: ScriptRevision[];
1915
+ }
1916
+
1917
+ declare interface ScriptTextRecord {
1918
+ content: string;
1919
+ graphics: string;
1920
+ }
1921
+
1776
1922
  declare interface SearchDomainRecords {
1777
1923
  ":search?": SearchRecord;
1778
1924
  }
@@ -1790,12 +1936,36 @@ declare interface SerializedAutoLinkNode {
1790
1936
  url: string;
1791
1937
  }
1792
1938
 
1939
+ declare interface SerializedEditorState<T extends SerializedLexicalNode = SerializedLexicalNode> {
1940
+ root: SerializedRootNode_2<T>;
1941
+ }
1942
+
1943
+ declare type SerializedElementNode<T extends SerializedLexicalNode = SerializedLexicalNode> = Spread<{
1944
+ children: Array<T>;
1945
+ direction: 'ltr' | 'rtl' | null;
1946
+ format: ElementFormatType;
1947
+ indent: number;
1948
+ textFormat?: number;
1949
+ textStyle?: string;
1950
+ }, SerializedLexicalNode>;
1951
+
1793
1952
  declare interface SerializedEmojiNode {
1794
1953
  type: "emoji";
1795
1954
  version: 1;
1796
1955
  emojiId: string;
1797
1956
  }
1798
1957
 
1958
+ /**
1959
+ * The base type for all serialized nodes
1960
+ */
1961
+ declare type SerializedLexicalNode = {
1962
+ /** The type string used by the Node class */
1963
+ type: string;
1964
+ /** A numeric version for this schema, defaulting to 1, but not generally recommended for use */
1965
+ version: number;
1966
+ [NODE_STATE_KEY]?: Record<string, unknown>;
1967
+ };
1968
+
1799
1969
  declare interface SerializedLineBreakNode {
1800
1970
  type: "linebreak";
1801
1971
  version: 1;
@@ -1834,6 +2004,8 @@ declare interface SerializedRootNode {
1834
2004
  children: SerializedNode[];
1835
2005
  }
1836
2006
 
2007
+ declare type SerializedRootNode_2<T extends SerializedLexicalNode = SerializedLexicalNode> = SerializedElementNode<T>;
2008
+
1837
2009
  declare interface SerializedTextNode {
1838
2010
  type: "text";
1839
2011
  version: 1;
@@ -1918,12 +2090,26 @@ declare interface Settings {
1918
2090
  };
1919
2091
  script?: {
1920
2092
  createMenu: {
1921
- showPreview: boolean;
2093
+ sortBy?: "index" | "title";
2094
+ showPreview?: boolean;
1922
2095
  };
1923
2096
  colorTags: PromotedTag[];
2097
+ readType: "characters" | "words" | "wordsPerMinute";
2098
+ readRate: number;
2099
+ collapsedNodes: {
2100
+ [eventId: string]: {
2101
+ preview?: boolean;
2102
+ children?: boolean;
2103
+ };
2104
+ };
1924
2105
  };
1925
2106
  events?: {
1926
2107
  graphicBaseTemplate?: string;
2108
+ favorites?: string[];
2109
+ defaults?: Record<string, {
2110
+ event: string;
2111
+ property: string;
2112
+ }>;
1927
2113
  };
1928
2114
  rundown?: {
1929
2115
  eventThumbnails: boolean;
@@ -2061,6 +2247,7 @@ declare interface Settings {
2061
2247
  excerpt: {
2062
2248
  maxLines: number;
2063
2249
  mode: string;
2250
+ comments?: boolean;
2064
2251
  };
2065
2252
  };
2066
2253
  note?: {
@@ -2077,6 +2264,9 @@ declare interface Settings {
2077
2264
  maxHeight: number;
2078
2265
  };
2079
2266
  };
2267
+ print?: {
2268
+ fontFamilies?: string[];
2269
+ };
2080
2270
  hiddenPreviews?: Array<{
2081
2271
  id: string;
2082
2272
  folded: boolean;
@@ -2112,6 +2302,7 @@ declare interface Settings {
2112
2302
  hideInAssetMenu?: boolean;
2113
2303
  assetRoute?: boolean;
2114
2304
  devWarnings?: boolean;
2305
+ multiplexWebSockets?: boolean;
2115
2306
  };
2116
2307
  notifications?: {
2117
2308
  events: {
@@ -2134,6 +2325,8 @@ declare interface SettingsPanelStoreTab extends ModuleTabsSettingsValue {
2134
2325
  activeSectionIndex: number;
2135
2326
  }
2136
2327
 
2328
+ declare type Spread<T1, T2> = Omit<T2, keyof T1> & T1;
2329
+
2137
2330
  declare interface StorageLocationsRecord {
2138
2331
  [key: string]: StorageLocationsRecordEntry;
2139
2332
  }
@@ -2426,6 +2619,11 @@ declare interface SubtitleStyleDomainRecord {
2426
2619
  encoding?: string;
2427
2620
  scaledBorderAndShadow?: boolean;
2428
2621
  futureWordWrapping?: boolean;
2622
+ previewSettings?: {
2623
+ aspectRatio?: string;
2624
+ backgroundAssetId?: string;
2625
+ text?: string;
2626
+ };
2429
2627
  }
2430
2628
 
2431
2629
  declare interface SubtitleStyleDomainRecords {
@@ -2521,6 +2719,13 @@ declare interface TestOperation {
2521
2719
  value: any;
2522
2720
  }
2523
2721
 
2722
+ declare interface TextNodeContent {
2723
+ type: "text" | "link" | "autolink";
2724
+ text: string;
2725
+ style?: string;
2726
+ format?: number;
2727
+ }
2728
+
2524
2729
  declare type Type<Value extends "int32" | "uint32" | "int64" | "uint64" | "float" | "double"> = TagBase<{
2525
2730
  target: Value extends "int64" | "uint64" ? "bigint" | "number" : "number";
2526
2731
  kind: "type";
@@ -2744,6 +2949,13 @@ declare interface WidgetItem {
2744
2949
 
2745
2950
  declare type WidgetType = "default" | "assetTypes" | "assetTags" | "geopoint" | "poster" | "textarea" | "tags";
2746
2951
 
2952
+ /**
2953
+ * A base64 encoded string representing a complete Yjs document state.
2954
+ * This is created using `Y.encodeStateAsUpdate()` and is used for
2955
+ * persistence and versioning.
2956
+ */
2957
+ declare type YjsSnapshot = string;
2958
+
2747
2959
  declare interface YoutubePublishRecord extends PublishRecordCommon<"youtube"> {
2748
2960
  draft?: {
2749
2961
  snippet?: {
package/dist/rpc.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { type AssertionGuard as __AssertionGuard } from "typia";
2
+ import { SerializedEditorState } from 'lexical';
2
3
  import { CloneSource, CloneTarget, CloneRule } from './common/index.js';
3
4
  export interface RpcMethods {
4
5
  "media/applySubtitles": [
@@ -35,6 +36,14 @@ export interface RpcMethods {
35
36
  },
36
37
  string[]
37
38
  ];
39
+ "script/yjsToLexical": [
40
+ string,
41
+ SerializedEditorState
42
+ ];
43
+ "script/lexicalToYjs": [
44
+ SerializedEditorState,
45
+ string
46
+ ];
38
47
  }
39
48
  export type NxtImportMode = "seed" | "clone";
40
49
  export declare const isNxtImportMode: (input: unknown) => input is NxtImportMode;