@nxtedition/types 23.1.3 → 23.1.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.
Files changed (39) hide show
  1. package/dist/common/block.d.ts +1 -0
  2. package/dist/common/block.js +31 -13
  3. package/dist/common/file.js +9 -8
  4. package/dist/common/index.d.ts +2 -0
  5. package/dist/common/index.js +2 -0
  6. package/dist/common/json-schema.d.ts +95 -0
  7. package/dist/common/json-schema.js +1 -0
  8. package/dist/common/location.js +1 -1
  9. package/dist/common/nxtpression.d.ts +1 -1
  10. package/dist/common/print.d.ts +30 -0
  11. package/dist/common/print.js +1 -0
  12. package/dist/common/render-scene.d.ts +1 -0
  13. package/dist/common/rule.js +2 -2
  14. package/dist/common/settings.d.ts +11 -2
  15. package/dist/nxtpression.d.ts +451 -205
  16. package/dist/records/domains/connection/file/smb.d.ts +2 -0
  17. package/dist/records/domains/event.d.ts +20 -0
  18. package/dist/records/domains/gallery.d.ts +8 -0
  19. package/dist/records/domains/gallery.js +1 -0
  20. package/dist/records/domains/index.d.ts +5 -1
  21. package/dist/records/domains/index.js +2 -0
  22. package/dist/records/domains/role.d.ts +8 -0
  23. package/dist/records/domains/storage.d.ts +87 -0
  24. package/dist/records/domains/storage.js +1 -0
  25. package/dist/records/domains/template.d.ts +32 -0
  26. package/dist/records/exact/index.d.ts +6 -0
  27. package/dist/records/exact/monitor.d.ts +1 -0
  28. package/dist/records/validate/assert-guard.js +1641 -454
  29. package/dist/records/validate/assert.js +1645 -448
  30. package/dist/records/validate/is.js +92 -26
  31. package/dist/records/validate/schemas.d.ts +3 -10
  32. package/dist/records/validate/schemas.js +1336 -254
  33. package/dist/records/validate/stringify.js +348 -253
  34. package/dist/records/validate/utils.js +2 -2
  35. package/dist/records/validate/validate-equals.js +2245 -481
  36. package/dist/records/validate/validate.js +1549 -429
  37. package/dist/rpc.js +2 -2
  38. package/dist/tsdoc-metadata.json +1 -1
  39. package/package.json +13 -14
@@ -3,7 +3,9 @@ export interface FileConnectionSmbRecord extends FileConnectionBase {
3
3
  protocol?: "smb";
4
4
  host?: string;
5
5
  share?: string;
6
+ root?: string;
6
7
  workgroup?: string;
7
8
  username?: string;
8
9
  password?: string;
10
+ createFolders?: boolean;
9
11
  }
@@ -10,11 +10,15 @@ export interface EventDomainRecords {
10
10
  ":event.duration?": EventDurationRecord;
11
11
  ":event.children?": EventChildrenRecord;
12
12
  ":event.props?": EventPropsRecord;
13
+ ":event.stats?": EventStatsRecord;
14
+ ":event.readDuration?": EventReadDurationRecord;
15
+ ":event.readRate?": EventReadRateRecord;
13
16
  }
14
17
  export interface EventRecord {
15
18
  start?: number | null;
16
19
  end?: number | null;
17
20
  duration?: number | null;
21
+ position?: string;
18
22
  text?: string;
19
23
  lang?: string;
20
24
  style?: string;
@@ -40,16 +44,31 @@ export interface EventChildrenRecord {
40
44
  type EventProps = {
41
45
  source?: string;
42
46
  cueCard?: boolean | string;
47
+ printRundownColor?: string;
43
48
  startTime?: number;
44
49
  shotboxGroup?: string | string[];
45
50
  shotboxVisible?: boolean;
46
51
  };
47
52
  export type EventPropsRecord = EventProps & Record<Exclude<string, keyof EventProps>, JsonValue>;
53
+ export interface EventStatsRecord {
54
+ type?: string;
55
+ }
48
56
  export interface EventOverlayRecord {
49
57
  [eventId: string]: {
50
58
  data: EventPropsRecord;
51
59
  };
52
60
  }
61
+ export interface EventReadDurationRecord {
62
+ numChars?: number;
63
+ numWords?: number;
64
+ readRate?: number;
65
+ readDuration?: number;
66
+ readType?: ReadType;
67
+ }
68
+ export interface EventReadRateRecord {
69
+ readRate?: number;
70
+ readType?: ReadType;
71
+ }
53
72
  export interface SubtitleEventStyleOverrides {
54
73
  marginL?: string;
55
74
  marginR?: string;
@@ -66,4 +85,5 @@ export interface SubtitleEventStyleOverrides {
66
85
  underline?: string;
67
86
  strikeOut?: string;
68
87
  }
88
+ export type ReadType = "characters" | "words" | "wordsPerMinute";
69
89
  export {};
@@ -0,0 +1,8 @@
1
+ export interface GalleryDomainRecords {
2
+ ":gallery": GalleryDomainRecord;
3
+ }
4
+ export interface GalleryDomainRecord {
5
+ sources?: {
6
+ program?: string;
7
+ };
8
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -16,6 +16,7 @@ import type { EditDomainRecords } from './edit.ts';
16
16
  import type { EventDomainRecords } from './event.ts';
17
17
  import type { FileDomainRecords } from './file.ts';
18
18
  import type { FolderDomainRecords } from './folder.ts';
19
+ import type { GalleryDomainRecords } from './gallery.ts';
19
20
  import type { GeneralDomainRecords } from './general.ts';
20
21
  import type { HarvestDomainRecords } from './harvest.ts';
21
22
  import type { IngestclipDomainRecords } from './ingestclip.ts';
@@ -40,6 +41,7 @@ import type { ScriptDomainRecords } from './script.ts';
40
41
  import type { SearchDomainRecords } from './search.ts';
41
42
  import type { SettingsDomainRecords } from './settings.ts';
42
43
  import type { ShotboxDomainRecords } from './shotbox.ts';
44
+ import type { StorageDomainRecords } from './storage.ts';
43
45
  import type { StoryboardDomainRecords } from './storyboard.ts';
44
46
  import type { StreamDomainRecords } from './stream.ts';
45
47
  import type { SubtitleStyleDomainRecords } from './subtitle-style.ts';
@@ -67,6 +69,7 @@ export * from './edit.ts';
67
69
  export * from './event.ts';
68
70
  export * from './file.ts';
69
71
  export * from './folder.ts';
72
+ export * from './gallery.ts';
70
73
  export * from './general.ts';
71
74
  export * from './harvest.ts';
72
75
  export * from './ingestclip.ts';
@@ -91,6 +94,7 @@ export * from './script.ts';
91
94
  export * from './search.ts';
92
95
  export * from './settings.ts';
93
96
  export * from './shotbox.ts';
97
+ export * from './storage.ts';
94
98
  export * from './storyboard.ts';
95
99
  export * from './stream.ts';
96
100
  export * from './subtitle-style.ts';
@@ -100,5 +104,5 @@ export * from './user-notification-status.ts';
100
104
  export * from './user-notification.ts';
101
105
  export * from './user.ts';
102
106
  export * from './username.ts';
103
- export 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 {
107
+ export 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 {
104
108
  }
@@ -16,6 +16,7 @@ export * from "./edit.js";
16
16
  export * from "./event.js";
17
17
  export * from "./file.js";
18
18
  export * from "./folder.js";
19
+ export * from "./gallery.js";
19
20
  export * from "./general.js";
20
21
  export * from "./harvest.js";
21
22
  export * from "./ingestclip.js";
@@ -40,6 +41,7 @@ export * from "./script.js";
40
41
  export * from "./search.js";
41
42
  export * from "./settings.js";
42
43
  export * from "./shotbox.js";
44
+ export * from "./storage.js";
43
45
  export * from "./storyboard.js";
44
46
  export * from "./stream.js";
45
47
  export * from "./subtitle-style.js";
@@ -1,6 +1,14 @@
1
1
  export interface RoleDomainRecords {
2
+ ":role": RoleRecord;
3
+ ":role.users?": RoleUsersRecord;
2
4
  ":role.tags": RoleTagsRecord;
3
5
  }
6
+ export type RoleRecord = {
7
+ permissions?: Record<string, string[]>;
8
+ };
4
9
  export interface RoleTagsRecord {
5
10
  value: string[];
6
11
  }
12
+ export type RoleUsersRecord = {
13
+ value?: string[];
14
+ };
@@ -0,0 +1,87 @@
1
+ export interface StorageDomainRecords {
2
+ ":storage": StorageDomainRecord;
3
+ ":storage.stats": StorageStatsDomainRecord;
4
+ ":storage-zone": StorageZoneDomainRecord;
5
+ }
6
+ export interface StorageZoneDomainRecord {
7
+ priority?: number;
8
+ }
9
+ export interface StorageFsStats {
10
+ concurrency?: number;
11
+ path?: string;
12
+ snapshot?: number | null;
13
+ available?: number;
14
+ free?: number;
15
+ used?: number;
16
+ size?: number;
17
+ state?: string;
18
+ [key: string]: unknown;
19
+ }
20
+ export interface StorageS3Stats {
21
+ bucket?: string;
22
+ region?: string;
23
+ endpoint?: string;
24
+ path?: string;
25
+ storageClass?: string;
26
+ [key: string]: unknown;
27
+ }
28
+ export interface StorageStatsDomainRecord {
29
+ id: string;
30
+ location: string;
31
+ timestamp: string;
32
+ type: string;
33
+ zone: string;
34
+ origin: string;
35
+ free: number | null;
36
+ size: number | null;
37
+ available: number | null;
38
+ cache: boolean | null;
39
+ capacity: number | null;
40
+ limiter: {
41
+ readBytesPerSecond: number | undefined;
42
+ writeBytesPerSecond: number | undefined;
43
+ };
44
+ http: {
45
+ downstreamConnected: number;
46
+ upstreamConnected: number;
47
+ pending: number;
48
+ completed: number;
49
+ failed: number;
50
+ };
51
+ io: {
52
+ read: {
53
+ bytesPerSecond: number;
54
+ pending: number;
55
+ queues: StorageIoQueues;
56
+ };
57
+ write: {
58
+ bytesPerSecond: number;
59
+ pending: number;
60
+ queues: StorageIoQueues;
61
+ };
62
+ };
63
+ fs?: StorageFsStats;
64
+ s3?: StorageS3Stats;
65
+ }
66
+ export interface StorageIoQueues {
67
+ highest: number;
68
+ higher: number;
69
+ high: number;
70
+ normal: number;
71
+ low: number;
72
+ lower: number;
73
+ lowest: number;
74
+ }
75
+ export interface StorageDomainRecord {
76
+ zone: string;
77
+ hostname: string | null;
78
+ port?: number | null;
79
+ location?: string;
80
+ cache?: boolean | null;
81
+ allows?: string[];
82
+ capacity?: number | null;
83
+ rxBytesSecMax?: number | null;
84
+ txBytesSecMax?: number | null;
85
+ rxBytesSecLimit?: number | null;
86
+ txBytesSecLimit?: number | null;
87
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -10,4 +10,36 @@ export interface TemplateRecord {
10
10
  }
11
11
  export interface TemplateProperty {
12
12
  path?: string;
13
+ type?: string;
14
+ label?: string;
15
+ defaultValue?: string;
16
+ widget?: {
17
+ type: string;
18
+ };
19
+ properties?: object;
20
+ items?: {
21
+ properties?: Record<string, TemplatePropertySchema>;
22
+ };
23
+ render?: {
24
+ type: "image";
25
+ profile?: {
26
+ format?: string;
27
+ video?: {
28
+ width: number;
29
+ height: number;
30
+ fit: "cover";
31
+ };
32
+ };
33
+ };
34
+ }
35
+ export interface TemplatePropertySchema {
36
+ path?: string;
37
+ type?: string;
38
+ label?: string;
39
+ defaultValue?: string;
40
+ widget?: {
41
+ type: string;
42
+ };
43
+ items?: TemplatePropertySchema;
44
+ properties?: Record<string, TemplatePropertySchema>;
13
45
  }
@@ -9,11 +9,16 @@ export * from './media.ts';
9
9
  export type ExactRecords = MiscRecords & MediaRecords & AssetRecords & MonitorRecords & StorageRecords;
10
10
  export interface AssetDaemonRecord {
11
11
  "user-notify"?: boolean;
12
+ validate?: boolean;
12
13
  }
13
14
  export interface AssetDaemonUserNotifyStateRecord {
14
15
  since?: string | 0 | null;
15
16
  version?: number;
16
17
  }
18
+ export interface AssetDaemonValidateStateRecord {
19
+ since?: string | 0 | null;
20
+ version?: number;
21
+ }
17
22
  export interface DeepstreamReplicatorStatsRecord {
18
23
  replicators?: Record<string, {
19
24
  to: {
@@ -29,6 +34,7 @@ export interface DeepstreamReplicatorStatsRecord {
29
34
  export interface MiscRecords {
30
35
  "asset-daemon": AssetDaemonRecord;
31
36
  "asset-daemon:user-notify.state": AssetDaemonUserNotifyStateRecord;
37
+ "asset-daemon:validate.state": AssetDaemonValidateStateRecord;
32
38
  "deepstream-replicator.stats?": DeepstreamReplicatorStatsRecord;
33
39
  }
34
40
  export interface DomainRows {
@@ -21,6 +21,7 @@ export interface NxtStatusMessage {
21
21
  title: string;
22
22
  url: string;
23
23
  };
24
+ data?: unknown;
24
25
  }
25
26
  export interface NxtStatusObject {
26
27
  level: number;