@sofie-automation/blueprints-integration 1.51.5 → 1.52.0-in-testing.0
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.
- package/CHANGELOG.md +41 -0
- package/dist/abPlayback.d.ts +5 -3
- package/dist/abPlayback.d.ts.map +1 -1
- package/dist/abPlayback.js.map +1 -1
- package/dist/action.d.ts +4 -2
- package/dist/action.d.ts.map +1 -1
- package/dist/api/base.js +1 -1
- package/dist/api/base.js.map +1 -1
- package/dist/api/showStyle.d.ts +27 -8
- package/dist/api/showStyle.d.ts.map +1 -1
- package/dist/api/showStyle.js +3 -0
- package/dist/api/showStyle.js.map +1 -1
- package/dist/api/studio.d.ts +40 -7
- package/dist/api/studio.d.ts.map +1 -1
- package/dist/api/system.d.ts +15 -1
- package/dist/api/system.d.ts.map +1 -1
- package/dist/content.d.ts +7 -1
- package/dist/content.d.ts.map +1 -1
- package/dist/content.js.map +1 -1
- package/dist/context/adlibActionContext.d.ts +6 -3
- package/dist/context/adlibActionContext.d.ts.map +1 -1
- package/dist/context/eventContext.d.ts +3 -0
- package/dist/context/eventContext.d.ts.map +1 -1
- package/dist/context/index.d.ts +1 -0
- package/dist/context/index.d.ts.map +1 -1
- package/dist/context/index.js +1 -0
- package/dist/context/index.js.map +1 -1
- package/dist/context/onSetAsNextContext.d.ts +12 -2
- package/dist/context/onSetAsNextContext.d.ts.map +1 -1
- package/dist/context/partsAndPieceActionContext.d.ts +5 -2
- package/dist/context/partsAndPieceActionContext.d.ts.map +1 -1
- package/dist/context/processIngestDataContext.d.ts +49 -0
- package/dist/context/processIngestDataContext.d.ts.map +1 -0
- package/dist/context/processIngestDataContext.js +3 -0
- package/dist/context/processIngestDataContext.js.map +1 -0
- package/dist/context/quickLoopInfo.d.ts +7 -0
- package/dist/context/quickLoopInfo.d.ts.map +1 -0
- package/dist/context/quickLoopInfo.js +3 -0
- package/dist/context/quickLoopInfo.js.map +1 -0
- package/dist/context/routeSetContext.d.ts +8 -0
- package/dist/context/routeSetContext.d.ts.map +1 -0
- package/dist/context/routeSetContext.js +3 -0
- package/dist/context/routeSetContext.js.map +1 -0
- package/dist/context/rundownContext.d.ts +3 -2
- package/dist/context/rundownContext.d.ts.map +1 -1
- package/dist/context/systemApplyConfigContext.d.ts +6 -0
- package/dist/context/systemApplyConfigContext.d.ts.map +1 -0
- package/dist/context/systemApplyConfigContext.js +3 -0
- package/dist/context/systemApplyConfigContext.js.map +1 -0
- package/dist/documents/adlibPiece.d.ts +2 -0
- package/dist/documents/adlibPiece.d.ts.map +1 -1
- package/dist/documents/part.d.ts +10 -2
- package/dist/documents/part.d.ts.map +1 -1
- package/dist/documents/part.js +1 -1
- package/dist/documents/part.js.map +1 -1
- package/dist/documents/piece.d.ts +14 -0
- package/dist/documents/piece.d.ts.map +1 -1
- package/dist/documents/piece.js +1 -1
- package/dist/documents/piece.js.map +1 -1
- package/dist/documents/pieceGeneric.js +1 -1
- package/dist/documents/pieceGeneric.js.map +1 -1
- package/dist/documents/playlistTiming.js +1 -1
- package/dist/documents/playlistTiming.js.map +1 -1
- package/dist/documents/rundown.d.ts +5 -0
- package/dist/documents/rundown.d.ts.map +1 -1
- package/dist/documents/segment.d.ts +20 -0
- package/dist/documents/segment.d.ts.map +1 -1
- package/dist/documents/segment.js +9 -2
- package/dist/documents/segment.js.map +1 -1
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -1
- package/dist/ingest-types.d.ts +43 -0
- package/dist/ingest-types.d.ts.map +1 -0
- package/dist/ingest-types.js +3 -0
- package/dist/ingest-types.js.map +1 -0
- package/dist/ingest.d.ts +355 -3
- package/dist/ingest.d.ts.map +1 -1
- package/dist/ingest.js +54 -0
- package/dist/ingest.js.map +1 -1
- package/dist/lib.js +1 -1
- package/dist/lib.js.map +1 -1
- package/dist/message.js +1 -1
- package/dist/message.js.map +1 -1
- package/dist/migrations.d.ts +10 -61
- package/dist/migrations.d.ts.map +1 -1
- package/dist/timeline.js +1 -1
- package/dist/timeline.js.map +1 -1
- package/dist/triggers.d.ts +36 -1
- package/dist/triggers.d.ts.map +1 -1
- package/dist/triggers.js +22 -2
- package/dist/triggers.js.map +1 -1
- package/dist/userEditing.d.ts +105 -0
- package/dist/userEditing.d.ts.map +1 -0
- package/dist/userEditing.js +13 -0
- package/dist/userEditing.js.map +1 -0
- package/dist/util.js +1 -1
- package/dist/util.js.map +1 -1
- package/package.json +7 -7
package/dist/ingest.d.ts
CHANGED
|
@@ -1,8 +1,360 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { IngestPart, IngestSegment } from '@sofie-automation/shared-lib/dist/peripheralDevice/ingest';
|
|
2
2
|
import { IBlueprintRundownDBData } from './documents';
|
|
3
|
+
import { ReadonlyDeep } from 'type-fest';
|
|
4
|
+
import { SofieIngestRundown } from './ingest-types';
|
|
3
5
|
export { IngestPart, IngestPlaylist, IngestRundown, IngestSegment, IngestAdlib, } from '@sofie-automation/shared-lib/dist/peripheralDevice/ingest';
|
|
4
|
-
/** The
|
|
5
|
-
export interface ExtendedIngestRundown extends
|
|
6
|
+
/** The IngestRundown is extended with data from Core */
|
|
7
|
+
export interface ExtendedIngestRundown<TRundownPayload = unknown, TSegmentPayload = unknown, TPartPayload = unknown> extends SofieIngestRundown<TRundownPayload, TSegmentPayload, TPartPayload> {
|
|
6
8
|
coreData: IBlueprintRundownDBData | undefined;
|
|
7
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* Describes the possible ingest changes that can have been made to a part by the NRCS
|
|
12
|
+
*/
|
|
13
|
+
export declare enum NrcsIngestPartChangeDetails {
|
|
14
|
+
Inserted = "inserted",
|
|
15
|
+
Deleted = "deleted",
|
|
16
|
+
Updated = "updated"
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Describes some of the possible ingest changes that can have been made to a segment by the NRCS
|
|
20
|
+
*/
|
|
21
|
+
export declare enum NrcsIngestSegmentChangeDetailsEnum {
|
|
22
|
+
/**
|
|
23
|
+
* The segment has been inserted into the rundown, or the segment has changed sufficiently to require a full regeneration
|
|
24
|
+
*/
|
|
25
|
+
InsertedOrUpdated = "inserted-or-updated",
|
|
26
|
+
/**
|
|
27
|
+
* The segment has been removed from the rundown
|
|
28
|
+
*/
|
|
29
|
+
Deleted = "deleted"
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Describes the possible ingest changes that can have been made to the rundown properties by the NRCS
|
|
33
|
+
*/
|
|
34
|
+
export declare enum NrcsIngestRundownChangeDetails {
|
|
35
|
+
/**
|
|
36
|
+
* The payload or name of the rundown has changed.
|
|
37
|
+
*/
|
|
38
|
+
Payload = "payload",
|
|
39
|
+
/**
|
|
40
|
+
* A full regeneration of the rundown and all segments is required.
|
|
41
|
+
* This will typically remove all user driven changes.
|
|
42
|
+
*/
|
|
43
|
+
Regenerate = "regenerate"
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Describes the possible ingest changes that can have been made to the contents of a segment by the NRCS
|
|
47
|
+
*/
|
|
48
|
+
export interface NrcsIngestSegmentChangeDetailsObject {
|
|
49
|
+
/**
|
|
50
|
+
* True when the payload or name of the segment has changed.
|
|
51
|
+
*/
|
|
52
|
+
payloadChanged?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* True when the rank of any part in the segment has changed.
|
|
55
|
+
*/
|
|
56
|
+
partOrderChanged?: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Descibes the changes to the parts in the rundown
|
|
59
|
+
*/
|
|
60
|
+
partChanges?: Record<string, NrcsIngestPartChangeDetails>;
|
|
61
|
+
}
|
|
62
|
+
export declare enum IngestChangeType {
|
|
63
|
+
/** Indicate that this change is from ingest operations */
|
|
64
|
+
Ingest = "ingest",
|
|
65
|
+
/** Indicate that this change is from user operations */
|
|
66
|
+
User = "user"
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Describes the possible ingest changes that can have been made to a segment by the NRCS
|
|
70
|
+
*/
|
|
71
|
+
export type NrcsIngestSegmentChangeDetails = NrcsIngestSegmentChangeDetailsEnum | NrcsIngestSegmentChangeDetailsObject;
|
|
72
|
+
export interface NrcsIngestChangeDetails {
|
|
73
|
+
/** Indicate that this change is from ingest operations */
|
|
74
|
+
source: IngestChangeType.Ingest;
|
|
75
|
+
/**
|
|
76
|
+
* True when the rank of any segment in the rundown has changed.
|
|
77
|
+
* Expressing what exactly has changed non-trivial particularly how to represent that in this structure,
|
|
78
|
+
* so for now we just have a simple boolean.
|
|
79
|
+
* If this is false, no segments have been reordered, added or removed.
|
|
80
|
+
*/
|
|
81
|
+
segmentOrderChanged?: boolean;
|
|
82
|
+
/**
|
|
83
|
+
* Describes the changes to the rundown itself
|
|
84
|
+
*/
|
|
85
|
+
rundownChanges?: NrcsIngestRundownChangeDetails;
|
|
86
|
+
/**
|
|
87
|
+
* Describes the changes to the segments in the rundown
|
|
88
|
+
*/
|
|
89
|
+
segmentChanges?: Record<string, NrcsIngestSegmentChangeDetails>;
|
|
90
|
+
/**
|
|
91
|
+
* Describes any changes to segment external ids
|
|
92
|
+
* This is used to ensure that content belonging to a segment gets moved between segments correctly
|
|
93
|
+
* Note: this is not currently defined by Sofie, but is defined by `groupPartsInRundownAndChanges` and `groupMosPartsInRundownAndChangesWithSeparator`
|
|
94
|
+
*/
|
|
95
|
+
changedSegmentExternalIds?: Record<string, string>;
|
|
96
|
+
}
|
|
97
|
+
export interface UserOperationTarget {
|
|
98
|
+
segmentExternalId: string | undefined;
|
|
99
|
+
partExternalId: string | undefined;
|
|
100
|
+
pieceExternalId: string | undefined;
|
|
101
|
+
}
|
|
102
|
+
export declare enum DefaultUserOperationsTypes {
|
|
103
|
+
REVERT_SEGMENT = "__sofie-revert-segment",
|
|
104
|
+
REVERT_PART = "__sofie-revert-part",
|
|
105
|
+
REVERT_RUNDOWN = "__sofie-revert-rundown",
|
|
106
|
+
UPDATE_PROPS = "__sofie-update-props",
|
|
107
|
+
IMPORT_MOS_ITEM = "__sofie-import-mos"
|
|
108
|
+
}
|
|
109
|
+
export interface DefaultUserOperationRevertRundown {
|
|
110
|
+
id: DefaultUserOperationsTypes.REVERT_RUNDOWN;
|
|
111
|
+
payload: Record<string, never>;
|
|
112
|
+
}
|
|
113
|
+
export interface DefaultUserOperationRevertSegment {
|
|
114
|
+
id: DefaultUserOperationsTypes.REVERT_SEGMENT;
|
|
115
|
+
payload: Record<string, never>;
|
|
116
|
+
}
|
|
117
|
+
export interface DefaultUserOperationRevertPart {
|
|
118
|
+
id: DefaultUserOperationsTypes.REVERT_PART;
|
|
119
|
+
}
|
|
120
|
+
export interface DefaultUserOperationEditProperties {
|
|
121
|
+
id: DefaultUserOperationsTypes.UPDATE_PROPS;
|
|
122
|
+
payload: {
|
|
123
|
+
pieceTypeProperties: {
|
|
124
|
+
type: string;
|
|
125
|
+
value: Record<string, any>;
|
|
126
|
+
};
|
|
127
|
+
globalProperties: Record<string, any>;
|
|
128
|
+
};
|
|
129
|
+
}
|
|
130
|
+
export type DefaultUserOperationImportMOSItem = {
|
|
131
|
+
id: DefaultUserOperationsTypes.IMPORT_MOS_ITEM;
|
|
132
|
+
payloadType: string;
|
|
133
|
+
payload: any;
|
|
134
|
+
};
|
|
135
|
+
export type DefaultUserOperations = DefaultUserOperationRevertRundown | DefaultUserOperationRevertSegment | DefaultUserOperationRevertPart | DefaultUserOperationEditProperties | DefaultUserOperationImportMOSItem;
|
|
136
|
+
export interface UserOperationChange<TCustomBlueprintOperations extends {
|
|
137
|
+
id: string;
|
|
138
|
+
} = never> {
|
|
139
|
+
/** Indicate that this change is from user operations */
|
|
140
|
+
source: IngestChangeType.User;
|
|
141
|
+
operationTarget: UserOperationTarget;
|
|
142
|
+
operation: DefaultUserOperations | TCustomBlueprintOperations;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* The MutableIngestRundown is used to modify the contents of an IngestRundown during ingest.
|
|
146
|
+
* The public properties and methods are used i blueprints to selectively apply incoming
|
|
147
|
+
* or apply user operations to the SofieIngestRundown.
|
|
148
|
+
*/
|
|
149
|
+
export interface MutableIngestRundown<TRundownPayload = unknown, TSegmentPayload = unknown, TPartPayload = unknown> {
|
|
150
|
+
/** Id of the rundown as reported by the ingest gateway. Must be unique for each rundown owned by the gateway */
|
|
151
|
+
readonly externalId: string;
|
|
152
|
+
/** Name of the rundown */
|
|
153
|
+
readonly name: string;
|
|
154
|
+
/** Something that identified the data source. eg "spreadsheet", "mos" */
|
|
155
|
+
readonly type: string;
|
|
156
|
+
/** Payload of rundown metadata. For use by other blueprints methods */
|
|
157
|
+
readonly payload: ReadonlyDeep<TRundownPayload> | undefined;
|
|
158
|
+
readonly userEditStates: Record<string, boolean>;
|
|
159
|
+
/** Array of segments in this rundown */
|
|
160
|
+
readonly segments: ReadonlyArray<MutableIngestSegment<TSegmentPayload, TPartPayload>>;
|
|
161
|
+
/**
|
|
162
|
+
* Search for a Part through the whole IngestRundown
|
|
163
|
+
* @param partExternalId externalId of the Part
|
|
164
|
+
*/
|
|
165
|
+
findPart(partExternalId: string): MutableIngestPart<TPartPayload> | undefined;
|
|
166
|
+
/**
|
|
167
|
+
* Search for a Part through the whole IngestRundown
|
|
168
|
+
* @param partExternalId externalId of the Part
|
|
169
|
+
* @returns The part and segment that the part belongs to
|
|
170
|
+
*/
|
|
171
|
+
findPartAndSegment(partExternalId: string): {
|
|
172
|
+
part: MutableIngestPart<TPartPayload>;
|
|
173
|
+
segment: MutableIngestSegment<TSegmentPayload, TPartPayload>;
|
|
174
|
+
} | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* Returns a Segment with a certain externalId
|
|
177
|
+
* @param segmentExternalId
|
|
178
|
+
*/
|
|
179
|
+
getSegment(segmentExternalId: string): MutableIngestSegment<TSegmentPayload, TPartPayload> | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* Move a segment to a new position in the rundown
|
|
182
|
+
* @param segmentExternalId externalId of the Segment to move
|
|
183
|
+
* @param beforeSegmentExternalId externalId of the Segment to position before. If null, position at the end
|
|
184
|
+
*/
|
|
185
|
+
moveSegmentBefore(segmentExternalId: string, beforeSegmentExternalId: string | null): void;
|
|
186
|
+
/**
|
|
187
|
+
* Move a segment to a new position in the rundown
|
|
188
|
+
* @param segmentExternalId externalId of the Segment to move
|
|
189
|
+
* @param afterSegmentExternalId externalId of the Segment to position after. If null, position at the beginning
|
|
190
|
+
*/
|
|
191
|
+
moveSegmentAfter(segmentExternalId: string, afterSegmentExternalId: string | null): void;
|
|
192
|
+
/**
|
|
193
|
+
* Replace a Segment in the Rundown with a new one. If the Segment does not already exist, it will be inserted.
|
|
194
|
+
* This will replace all of the Parts in the Segment as well, along with the payload and other properties of the Segment.
|
|
195
|
+
* @param segment the new IngestSegment to insert
|
|
196
|
+
* @param beforeSegmentExternalId externalId of the Segment to position before. If null, position at the end
|
|
197
|
+
* @returns the new MutableIngestSegment
|
|
198
|
+
*/
|
|
199
|
+
replaceSegment(segment: Omit<IngestSegment<TSegmentPayload, TPartPayload>, 'rank'>, beforeSegmentExternalId: string | null): MutableIngestSegment<TSegmentPayload, TPartPayload>;
|
|
200
|
+
/**
|
|
201
|
+
* Change the externalId of a Segment
|
|
202
|
+
* @param oldSegmentExternalId Id of the segment to change
|
|
203
|
+
* @param newSegmentExternalId New id for the segment
|
|
204
|
+
*/
|
|
205
|
+
changeSegmentExternalId(oldSegmentExternalId: string, newSegmentExternalId: string): MutableIngestSegment<TSegmentPayload, TPartPayload>;
|
|
206
|
+
/**
|
|
207
|
+
* Change the originalExternalId of a Segment
|
|
208
|
+
* This allows for tracking of segments that have been renamed, after a Segment has been added or replaced
|
|
209
|
+
* @param segmentExternalId Id of the segment to update
|
|
210
|
+
* @param originalSegmentExternalId Original id for the segment
|
|
211
|
+
*/
|
|
212
|
+
changeSegmentOriginalExternalId(segmentExternalId: string, originalSegmentExternalId: string): MutableIngestSegment<TSegmentPayload, TPartPayload>;
|
|
213
|
+
/**
|
|
214
|
+
* Remove a Segment from the Rundown
|
|
215
|
+
* @param segmentExternalId externalId of the Segment to remove
|
|
216
|
+
* @returns true if the segment was removed, false if it was not found
|
|
217
|
+
*/
|
|
218
|
+
removeSegment(segmentExternalId: string): boolean;
|
|
219
|
+
/**
|
|
220
|
+
* Remove all Segments from the Rundown
|
|
221
|
+
*/
|
|
222
|
+
removeAllSegments(): void;
|
|
223
|
+
/**
|
|
224
|
+
* Force the whole Rundown to be re-run through the ingest blueprints, even if there are no changes
|
|
225
|
+
*/
|
|
226
|
+
forceFullRegenerate(): void;
|
|
227
|
+
/**
|
|
228
|
+
* Set name of the Rundown
|
|
229
|
+
*/
|
|
230
|
+
setName(name: string): void;
|
|
231
|
+
/**
|
|
232
|
+
* Update the payload of the Rundown
|
|
233
|
+
* This will trigger the Rundown and RundownPlaylist to be updated, but not Segments
|
|
234
|
+
* @param payload the new payload
|
|
235
|
+
*/
|
|
236
|
+
replacePayload(payload: ReadonlyDeep<TRundownPayload> | TRundownPayload): void;
|
|
237
|
+
/**
|
|
238
|
+
* Update the portion of the payload of the Rundown
|
|
239
|
+
* This will trigger the Rundown and RundownPlaylist to be updated, but not Segments
|
|
240
|
+
* @param key the key of the payload to update
|
|
241
|
+
* @param value the new value
|
|
242
|
+
*/
|
|
243
|
+
setPayloadProperty<TKey extends keyof TRundownPayload>(key: TKey, value: ReadonlyDeep<TRundownPayload[TKey]> | TRundownPayload[TKey]): void;
|
|
244
|
+
/**
|
|
245
|
+
* Set a value in the userEditState
|
|
246
|
+
*/
|
|
247
|
+
setUserEditState(key: string, value: boolean): void;
|
|
248
|
+
}
|
|
249
|
+
export interface MutableIngestSegment<TSegmentPayload = unknown, TPartPayload = unknown> {
|
|
250
|
+
/** Id of the segment as reported by the ingest gateway. Must be unique for each segment in the rundown */
|
|
251
|
+
readonly externalId: string;
|
|
252
|
+
/** Name of the segment */
|
|
253
|
+
readonly name: string;
|
|
254
|
+
/** If the segment has had it's externalId changed, the id before the change */
|
|
255
|
+
readonly originalExternalId: string | undefined;
|
|
256
|
+
/** Payload of segment metadata. For use by other blueprints methods */
|
|
257
|
+
readonly payload: ReadonlyDeep<TSegmentPayload> | undefined;
|
|
258
|
+
readonly userEditStates: Record<string, boolean>;
|
|
259
|
+
/** Array of parts in this segment */
|
|
260
|
+
readonly parts: ReadonlyArray<MutableIngestPart<TPartPayload>>;
|
|
261
|
+
/**
|
|
262
|
+
* Get a Part from the Segment
|
|
263
|
+
* @param partExternalId externalId of the Part
|
|
264
|
+
*/
|
|
265
|
+
getPart(partExternalId: string): MutableIngestPart<TPartPayload> | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* Move a part to a new position in the segment
|
|
268
|
+
* @param partExternalId externalId of the Part to move
|
|
269
|
+
* @param beforePartExternalId externalId of the Part to position before. If null, position at the end
|
|
270
|
+
*/
|
|
271
|
+
movePartBefore(partExternalId: string, beforePartExternalId: string | null): void;
|
|
272
|
+
/**
|
|
273
|
+
* Move a part to a new position in the segment
|
|
274
|
+
* @param partExternalId externalId of the Part to move
|
|
275
|
+
* @param afterPartExternalId externalId of the Part to position after. If null, position at the beginning
|
|
276
|
+
*/
|
|
277
|
+
movePartAfter(partExternalId: string, afterPartExternalId: string | null): void;
|
|
278
|
+
/**
|
|
279
|
+
* Replace a Part in the Segment with a new one. If the Part does not already exist, it will be inserted.
|
|
280
|
+
* This will replace the payload and other properties of the Part.
|
|
281
|
+
* @param ingestPart the new IngestPart to insert
|
|
282
|
+
* @param beforePartExternalId externalId of the Part to position before. If null, position at the end
|
|
283
|
+
* @returns the new MutableIngestPart
|
|
284
|
+
*/
|
|
285
|
+
replacePart(ingestPart: Omit<IngestPart<TPartPayload>, 'rank'>, beforePartExternalId: string | null): MutableIngestPart<TPartPayload>;
|
|
286
|
+
/**
|
|
287
|
+
* Remove a Part from the Segment
|
|
288
|
+
* @param partExternalId externalId of the Part to remove
|
|
289
|
+
* @returns true if the part was removed, false if it was not found
|
|
290
|
+
*/
|
|
291
|
+
removePart(partExternalId: string): boolean;
|
|
292
|
+
/**
|
|
293
|
+
* Force this segment to be regenerated, even if there are no changes
|
|
294
|
+
*/
|
|
295
|
+
forceRegenerate(): void;
|
|
296
|
+
/**
|
|
297
|
+
* Set the name of the Segment
|
|
298
|
+
*/
|
|
299
|
+
setName(name: string): void;
|
|
300
|
+
/**
|
|
301
|
+
* Update the payload of the Segment
|
|
302
|
+
* This will trigger the Segment to be updated
|
|
303
|
+
* @param payload the new payload
|
|
304
|
+
*/
|
|
305
|
+
replacePayload(payload: ReadonlyDeep<TSegmentPayload> | TSegmentPayload): void;
|
|
306
|
+
/**
|
|
307
|
+
* Update the portion of the payload of the Segment
|
|
308
|
+
* This will trigger the Segment to be updated
|
|
309
|
+
* @param key the key of the payload to update
|
|
310
|
+
* @param value the new value
|
|
311
|
+
*/
|
|
312
|
+
setPayloadProperty<TKey extends keyof TSegmentPayload>(key: TKey, value: ReadonlyDeep<TSegmentPayload[TKey]> | TSegmentPayload[TKey]): void;
|
|
313
|
+
setUserEditState(key: string, value: boolean): void;
|
|
314
|
+
}
|
|
315
|
+
export interface MutableIngestPart<TPartPayload = unknown> {
|
|
316
|
+
/** Id of the part as reported by the ingest gateway. Must be unique for each part in the rundown */
|
|
317
|
+
readonly externalId: string;
|
|
318
|
+
/** Name of the part */
|
|
319
|
+
readonly name: string;
|
|
320
|
+
/** Payload of the part. For use by other blueprints methods */
|
|
321
|
+
readonly payload: ReadonlyDeep<TPartPayload> | undefined;
|
|
322
|
+
readonly userEditStates: Record<string, boolean>;
|
|
323
|
+
/**
|
|
324
|
+
* Set the name of the Part
|
|
325
|
+
*/
|
|
326
|
+
setName(name: string): void;
|
|
327
|
+
/**
|
|
328
|
+
* Update the payload of the Part
|
|
329
|
+
* This will trigger the Segment to be updated
|
|
330
|
+
* @param payload the new payload
|
|
331
|
+
*/
|
|
332
|
+
replacePayload(payload: ReadonlyDeep<TPartPayload> | TPartPayload): void;
|
|
333
|
+
/**
|
|
334
|
+
* Update the portion of the payload of the Part
|
|
335
|
+
* This will trigger the Segment to be updated
|
|
336
|
+
* @param key the key of the payload to update
|
|
337
|
+
* @param value the new value
|
|
338
|
+
*/
|
|
339
|
+
setPayloadProperty<TKey extends keyof TPartPayload>(key: TKey, value: ReadonlyDeep<TPartPayload[TKey]> | TPartPayload[TKey]): void;
|
|
340
|
+
setUserEditState(key: string, value: boolean): void;
|
|
341
|
+
}
|
|
342
|
+
export type TransformPayloadFunction<T> = (payload: any, oldPayload: ReadonlyDeep<T> | undefined) => T | ReadonlyDeep<T>;
|
|
343
|
+
export interface IngestDefaultChangesOptions<TRundownPayload = unknown, TSegmentPayload = unknown, TPartPayload = unknown> {
|
|
344
|
+
/**
|
|
345
|
+
* A custom transform for the payload of a Rundown.
|
|
346
|
+
* Typically this will translate from a NRCS native structure to a javascript friendly structure.
|
|
347
|
+
*/
|
|
348
|
+
transformRundownPayload: TransformPayloadFunction<TRundownPayload>;
|
|
349
|
+
/**
|
|
350
|
+
* A custom transform for the payload of a Segment.
|
|
351
|
+
* Typically this will translate from a NRCS native structure to a javascript friendly structure.
|
|
352
|
+
*/
|
|
353
|
+
transformSegmentPayload: TransformPayloadFunction<TSegmentPayload>;
|
|
354
|
+
/**
|
|
355
|
+
* A custom transform for the payload of a Part.
|
|
356
|
+
* Typically this will translate from a NRCS native structure to a javascript friendly structure.
|
|
357
|
+
*/
|
|
358
|
+
transformPartPayload: TransformPayloadFunction<TPartPayload>;
|
|
359
|
+
}
|
|
8
360
|
//# sourceMappingURL=ingest.d.ts.map
|
package/dist/ingest.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ingest.d.ts","sourceRoot":"","sources":["../src/ingest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2DAA2D,CAAA;
|
|
1
|
+
{"version":3,"file":"ingest.d.ts","sourceRoot":"","sources":["../src/ingest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,2DAA2D,CAAA;AACrG,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAEnD,OAAO,EACN,UAAU,EACV,cAAc,EACd,aAAa,EACb,aAAa,EACb,WAAW,GACX,MAAM,2DAA2D,CAAA;AAElE,wDAAwD;AACxD,MAAM,WAAW,qBAAqB,CAAC,eAAe,GAAG,OAAO,EAAE,eAAe,GAAG,OAAO,EAAE,YAAY,GAAG,OAAO,CAClH,SAAQ,kBAAkB,CAAC,eAAe,EAAE,eAAe,EAAE,YAAY,CAAC;IAC1E,QAAQ,EAAE,uBAAuB,GAAG,SAAS,CAAA;CAC7C;AAED;;GAEG;AACH,oBAAY,2BAA2B;IACtC,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,kCAAkC;IAC7C;;OAEG;IACH,iBAAiB,wBAAwB;IACzC;;OAEG;IACH,OAAO,YAAY;CACnB;AAED;;GAEG;AACH,oBAAY,8BAA8B;IACzC;;OAEG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,UAAU,eAAe;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACpD;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAA;CACzD;AAED,oBAAY,gBAAgB;IAC3B,0DAA0D;IAC1D,MAAM,WAAW;IACjB,wDAAwD;IACxD,IAAI,SAAS;CACb;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,kCAAkC,GAAG,oCAAoC,CAAA;AAEtH,MAAM,WAAW,uBAAuB;IACvC,0DAA0D;IAC1D,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAA;IAE/B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,8BAA8B,CAAA;IAE/C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAA;IAE/D;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAClD;AAED,MAAM,WAAW,mBAAmB;IACnC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CACnC;AAED,oBAAY,0BAA0B;IACrC,cAAc,2BAA2B;IACzC,WAAW,wBAAwB;IACnC,cAAc,2BAA2B;IACzC,YAAY,yBAAyB;IACrC,eAAe,uBAAuB;CACtC;AAED,MAAM,WAAW,iCAAiC;IACjD,EAAE,EAAE,0BAA0B,CAAC,cAAc,CAAA;IAC7C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,iCAAiC;IACjD,EAAE,EAAE,0BAA0B,CAAC,cAAc,CAAA;IAC7C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,8BAA8B;IAC9C,EAAE,EAAE,0BAA0B,CAAC,WAAW,CAAA;CAC1C;AAED,MAAM,WAAW,kCAAkC;IAClD,EAAE,EAAE,0BAA0B,CAAC,YAAY,CAAA;IAC3C,OAAO,EAAE;QACR,mBAAmB,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;SAAE,CAAA;QACjE,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KACrC,CAAA;CACD;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC/C,EAAE,EAAE,0BAA0B,CAAC,eAAe,CAAA;IAE9C,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,qBAAqB,GAC9B,iCAAiC,GACjC,iCAAiC,GACjC,8BAA8B,GAC9B,kCAAkC,GAClC,iCAAiC,CAAA;AAEpC,MAAM,WAAW,mBAAmB,CAAC,0BAA0B,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK;IAC7F,wDAAwD;IACxD,MAAM,EAAE,gBAAgB,CAAC,IAAI,CAAA;IAE7B,eAAe,EAAE,mBAAmB,CAAA;IACpC,SAAS,EAAE,qBAAqB,GAAG,0BAA0B,CAAA;CAC7D;AACD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,eAAe,GAAG,OAAO,EAAE,eAAe,GAAG,OAAO,EAAE,YAAY,GAAG,OAAO;IACjH,gHAAgH;IAChH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,yEAAyE;IACzE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,uEAAuE;IACvE,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;IAE3D,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhD,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,CAAA;IAErF;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,iBAAiB,CAAC,YAAY,CAAC,GAAG,SAAS,CAAA;IAE7E;;;;OAIG;IACH,kBAAkB,CAAC,cAAc,EAAE,MAAM,GACtC;QACA,IAAI,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAA;QACrC,OAAO,EAAE,oBAAoB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;KAC3D,GACD,SAAS,CAAA;IAEZ;;;OAGG;IACH,UAAU,CAAC,iBAAiB,EAAE,MAAM,GAAG,oBAAoB,CAAC,eAAe,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAEtG;;;;OAIG;IACH,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAE1F;;;;OAIG;IACH,gBAAgB,CAAC,iBAAiB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAExF;;;;;;OAMG;IACH,cAAc,CACb,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,EACnE,uBAAuB,EAAE,MAAM,GAAG,IAAI,GACpC,oBAAoB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAEtD;;;;OAIG;IACH,uBAAuB,CACtB,oBAAoB,EAAE,MAAM,EAC5B,oBAAoB,EAAE,MAAM,GAC1B,oBAAoB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAEtD;;;;;OAKG;IACH,+BAA+B,CAC9B,iBAAiB,EAAE,MAAM,EACzB,yBAAyB,EAAE,MAAM,GAC/B,oBAAoB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;IAEtD;;;;OAIG;IACH,aAAa,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAA;IAEjD;;OAEG;IACH,iBAAiB,IAAI,IAAI,CAAA;IAEzB;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,eAAe,GAAG,IAAI,CAAA;IAE9E;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,SAAS,MAAM,eAAe,EACpD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAChE,IAAI,CAAA;IAEP;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;CACnD;AAED,MAAM,WAAW,oBAAoB,CAAC,eAAe,GAAG,OAAO,EAAE,YAAY,GAAG,OAAO;IACtF,0GAA0G;IAC1G,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,+EAA+E;IAC/E,QAAQ,CAAC,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAA;IAE/C,uEAAuE;IACvE,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,SAAS,CAAA;IAE3D,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhD,qCAAqC;IACrC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAA;IAE9D;;;OAGG;IACH,OAAO,CAAC,cAAc,EAAE,MAAM,GAAG,iBAAiB,CAAC,YAAY,CAAC,GAAG,SAAS,CAAA;IAE5E;;;;OAIG;IACH,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAEjF;;;;OAIG;IACH,aAAa,CAAC,cAAc,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAE/E;;;;;;OAMG;IACH,WAAW,CACV,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,EAClD,oBAAoB,EAAE,MAAM,GAAG,IAAI,GACjC,iBAAiB,CAAC,YAAY,CAAC,CAAA;IAElC;;;;OAIG;IACH,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAA;IAE3C;;OAEG;IACH,eAAe,IAAI,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,eAAe,GAAG,IAAI,CAAA;IAE9E;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,SAAS,MAAM,eAAe,EACpD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,GAChE,IAAI,CAAA;IAEP,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;CACnD;AAED,MAAM,WAAW,iBAAiB,CAAC,YAAY,GAAG,OAAO;IACxD,oGAAoG;IACpG,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,uBAAuB;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,YAAY,CAAC,GAAG,SAAS,CAAA;IAExD,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEhD;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,YAAY,CAAC,GAAG,YAAY,GAAG,IAAI,CAAA;IAExE;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,SAAS,MAAM,YAAY,EACjD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,GAC1D,IAAI,CAAA;IAEP,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;CACnD;AAED,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,KAAK,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;AAExH,MAAM,WAAW,2BAA2B,CAC3C,eAAe,GAAG,OAAO,EACzB,eAAe,GAAG,OAAO,EACzB,YAAY,GAAG,OAAO;IAEtB;;;OAGG;IACH,uBAAuB,EAAE,wBAAwB,CAAC,eAAe,CAAC,CAAA;IAClE;;;OAGG;IACH,uBAAuB,EAAE,wBAAwB,CAAC,eAAe,CAAC,CAAA;IAClE;;;OAGG;IACH,oBAAoB,EAAE,wBAAwB,CAAC,YAAY,CAAC,CAAA;CAC5D"}
|
package/dist/ingest.js
CHANGED
|
@@ -1,3 +1,57 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DefaultUserOperationsTypes = exports.IngestChangeType = exports.NrcsIngestRundownChangeDetails = exports.NrcsIngestSegmentChangeDetailsEnum = exports.NrcsIngestPartChangeDetails = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Describes the possible ingest changes that can have been made to a part by the NRCS
|
|
6
|
+
*/
|
|
7
|
+
var NrcsIngestPartChangeDetails;
|
|
8
|
+
(function (NrcsIngestPartChangeDetails) {
|
|
9
|
+
NrcsIngestPartChangeDetails["Inserted"] = "inserted";
|
|
10
|
+
NrcsIngestPartChangeDetails["Deleted"] = "deleted";
|
|
11
|
+
NrcsIngestPartChangeDetails["Updated"] = "updated";
|
|
12
|
+
})(NrcsIngestPartChangeDetails || (exports.NrcsIngestPartChangeDetails = NrcsIngestPartChangeDetails = {}));
|
|
13
|
+
/**
|
|
14
|
+
* Describes some of the possible ingest changes that can have been made to a segment by the NRCS
|
|
15
|
+
*/
|
|
16
|
+
var NrcsIngestSegmentChangeDetailsEnum;
|
|
17
|
+
(function (NrcsIngestSegmentChangeDetailsEnum) {
|
|
18
|
+
/**
|
|
19
|
+
* The segment has been inserted into the rundown, or the segment has changed sufficiently to require a full regeneration
|
|
20
|
+
*/
|
|
21
|
+
NrcsIngestSegmentChangeDetailsEnum["InsertedOrUpdated"] = "inserted-or-updated";
|
|
22
|
+
/**
|
|
23
|
+
* The segment has been removed from the rundown
|
|
24
|
+
*/
|
|
25
|
+
NrcsIngestSegmentChangeDetailsEnum["Deleted"] = "deleted";
|
|
26
|
+
})(NrcsIngestSegmentChangeDetailsEnum || (exports.NrcsIngestSegmentChangeDetailsEnum = NrcsIngestSegmentChangeDetailsEnum = {}));
|
|
27
|
+
/**
|
|
28
|
+
* Describes the possible ingest changes that can have been made to the rundown properties by the NRCS
|
|
29
|
+
*/
|
|
30
|
+
var NrcsIngestRundownChangeDetails;
|
|
31
|
+
(function (NrcsIngestRundownChangeDetails) {
|
|
32
|
+
/**
|
|
33
|
+
* The payload or name of the rundown has changed.
|
|
34
|
+
*/
|
|
35
|
+
NrcsIngestRundownChangeDetails["Payload"] = "payload";
|
|
36
|
+
/**
|
|
37
|
+
* A full regeneration of the rundown and all segments is required.
|
|
38
|
+
* This will typically remove all user driven changes.
|
|
39
|
+
*/
|
|
40
|
+
NrcsIngestRundownChangeDetails["Regenerate"] = "regenerate";
|
|
41
|
+
})(NrcsIngestRundownChangeDetails || (exports.NrcsIngestRundownChangeDetails = NrcsIngestRundownChangeDetails = {}));
|
|
42
|
+
var IngestChangeType;
|
|
43
|
+
(function (IngestChangeType) {
|
|
44
|
+
/** Indicate that this change is from ingest operations */
|
|
45
|
+
IngestChangeType["Ingest"] = "ingest";
|
|
46
|
+
/** Indicate that this change is from user operations */
|
|
47
|
+
IngestChangeType["User"] = "user";
|
|
48
|
+
})(IngestChangeType || (exports.IngestChangeType = IngestChangeType = {}));
|
|
49
|
+
var DefaultUserOperationsTypes;
|
|
50
|
+
(function (DefaultUserOperationsTypes) {
|
|
51
|
+
DefaultUserOperationsTypes["REVERT_SEGMENT"] = "__sofie-revert-segment";
|
|
52
|
+
DefaultUserOperationsTypes["REVERT_PART"] = "__sofie-revert-part";
|
|
53
|
+
DefaultUserOperationsTypes["REVERT_RUNDOWN"] = "__sofie-revert-rundown";
|
|
54
|
+
DefaultUserOperationsTypes["UPDATE_PROPS"] = "__sofie-update-props";
|
|
55
|
+
DefaultUserOperationsTypes["IMPORT_MOS_ITEM"] = "__sofie-import-mos";
|
|
56
|
+
})(DefaultUserOperationsTypes || (exports.DefaultUserOperationsTypes = DefaultUserOperationsTypes = {}));
|
|
3
57
|
//# sourceMappingURL=ingest.js.map
|
package/dist/ingest.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ingest.js","sourceRoot":"","sources":["../src/ingest.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"ingest.js","sourceRoot":"","sources":["../src/ingest.ts"],"names":[],"mappings":";;;AAmBA;;GAEG;AACH,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACtC,oDAAqB,CAAA;IACrB,kDAAmB,CAAA;IACnB,kDAAmB,CAAA;AACpB,CAAC,EAJW,2BAA2B,2CAA3B,2BAA2B,QAItC;AAED;;GAEG;AACH,IAAY,kCASX;AATD,WAAY,kCAAkC;IAC7C;;OAEG;IACH,+EAAyC,CAAA;IACzC;;OAEG;IACH,yDAAmB,CAAA;AACpB,CAAC,EATW,kCAAkC,kDAAlC,kCAAkC,QAS7C;AAED;;GAEG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACzC;;OAEG;IACH,qDAAmB,CAAA;IAEnB;;;OAGG;IACH,2DAAyB,CAAA;AAC1B,CAAC,EAXW,8BAA8B,8CAA9B,8BAA8B,QAWzC;AAsBD,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC3B,0DAA0D;IAC1D,qCAAiB,CAAA;IACjB,wDAAwD;IACxD,iCAAa,CAAA;AACd,CAAC,EALW,gBAAgB,gCAAhB,gBAAgB,QAK3B;AA2CD,IAAY,0BAMX;AAND,WAAY,0BAA0B;IACrC,uEAAyC,CAAA;IACzC,iEAAmC,CAAA;IACnC,uEAAyC,CAAA;IACzC,mEAAqC,CAAA;IACrC,oEAAsC,CAAA;AACvC,CAAC,EANW,0BAA0B,0CAA1B,0BAA0B,QAMrC"}
|
package/dist/lib.js
CHANGED
|
@@ -6,5 +6,5 @@ var NoteSeverity;
|
|
|
6
6
|
NoteSeverity[NoteSeverity["WARNING"] = 1] = "WARNING";
|
|
7
7
|
NoteSeverity[NoteSeverity["ERROR"] = 2] = "ERROR";
|
|
8
8
|
NoteSeverity[NoteSeverity["INFO"] = 3] = "INFO";
|
|
9
|
-
})(NoteSeverity
|
|
9
|
+
})(NoteSeverity || (exports.NoteSeverity = NoteSeverity = {}));
|
|
10
10
|
//# sourceMappingURL=lib.js.map
|
package/dist/lib.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";;;AAWA,IAAY,YAIX;AAJD,WAAY,YAAY;IACvB,qDAAW,CAAA;IACX,iDAAS,CAAA;IACT,+CAAQ,CAAA;AACT,CAAC,EAJW,YAAY,
|
|
1
|
+
{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";;;AAWA,IAAY,YAIX;AAJD,WAAY,YAAY;IACvB,qDAAW,CAAA;IACX,iDAAS,CAAA;IACT,+CAAQ,CAAA;AACT,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}
|
package/dist/message.js
CHANGED
|
@@ -5,5 +5,5 @@ var IBlueprintExternalMessageQueueType;
|
|
|
5
5
|
(function (IBlueprintExternalMessageQueueType) {
|
|
6
6
|
IBlueprintExternalMessageQueueType["SLACK"] = "slack";
|
|
7
7
|
IBlueprintExternalMessageQueueType["RABBIT_MQ"] = "rabbitmq";
|
|
8
|
-
})(IBlueprintExternalMessageQueueType
|
|
8
|
+
})(IBlueprintExternalMessageQueueType || (exports.IBlueprintExternalMessageQueueType = IBlueprintExternalMessageQueueType = {}));
|
|
9
9
|
//# sourceMappingURL=message.js.map
|
package/dist/message.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"message.js","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":";;;AAoBA,IAAY,kCAGX;AAHD,WAAY,kCAAkC;IAC7C,qDAAe,CAAA;IACf,4DAAsB,CAAA;AACvB,CAAC,EAHW,kCAAkC,
|
|
1
|
+
{"version":3,"file":"message.js","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":";;;AAoBA,IAAY,kCAGX;AAHD,WAAY,kCAAkC;IAC7C,qDAAe,CAAA;IACf,4DAAsB,CAAA;AACvB,CAAC,EAHW,kCAAkC,kDAAlC,kCAAkC,QAG7C"}
|
package/dist/migrations.d.ts
CHANGED
|
@@ -1,14 +1,9 @@
|
|
|
1
|
-
import { ConfigItemValue } from './common';
|
|
2
|
-
import { OmitId } from './lib';
|
|
3
|
-
import { IBlueprintShowStyleVariant, IOutputLayer, ISourceLayer } from './showStyle';
|
|
4
1
|
import { IBlueprintTriggeredActions } from './triggers';
|
|
5
|
-
import { BlueprintMapping } from './studio';
|
|
6
|
-
import { TSR } from './timeline';
|
|
7
2
|
export interface MigrationStepInput {
|
|
8
3
|
stepId?: string;
|
|
9
4
|
label: string;
|
|
10
5
|
description?: string;
|
|
11
|
-
inputType: 'text' | 'multiline' | 'int' | 'checkbox' | 'dropdown' | '
|
|
6
|
+
inputType: 'text' | 'multiline' | 'int' | 'checkbox' | 'dropdown' | 'toggle' | null;
|
|
12
7
|
attribute: string | null;
|
|
13
8
|
defaultValue?: any;
|
|
14
9
|
dropdownOptions?: string[];
|
|
@@ -22,64 +17,20 @@ export interface MigrationStepInputFilteredResult {
|
|
|
22
17
|
[attribute: string]: any;
|
|
23
18
|
}
|
|
24
19
|
export type ValidateFunctionCore = (afterMigration: boolean) => Promise<boolean | string>;
|
|
25
|
-
export type ValidateFunctionSystem = (context: MigrationContextSystem, afterMigration: boolean) => boolean | string
|
|
26
|
-
export type
|
|
27
|
-
export type ValidateFunctionShowStyle = (context: MigrationContextShowStyle, afterMigration: boolean) => boolean | string;
|
|
28
|
-
export type ValidateFunction = ValidateFunctionStudio | ValidateFunctionShowStyle | ValidateFunctionSystem | ValidateFunctionCore;
|
|
20
|
+
export type ValidateFunctionSystem = (context: MigrationContextSystem, afterMigration: boolean) => Promise<boolean | string>;
|
|
21
|
+
export type ValidateFunction = ValidateFunctionSystem | ValidateFunctionCore;
|
|
29
22
|
export type MigrateFunctionCore = (input: MigrationStepInputFilteredResult) => Promise<void>;
|
|
30
|
-
export type MigrateFunctionSystem = (context: MigrationContextSystem, input: MigrationStepInputFilteredResult) => void
|
|
31
|
-
export type
|
|
32
|
-
export type MigrateFunctionShowStyle = (context: MigrationContextShowStyle, input: MigrationStepInputFilteredResult) => void;
|
|
33
|
-
export type MigrateFunction = MigrateFunctionStudio | MigrateFunctionShowStyle | MigrateFunctionSystem | MigrateFunctionCore;
|
|
23
|
+
export type MigrateFunctionSystem = (context: MigrationContextSystem, input: MigrationStepInputFilteredResult) => Promise<void>;
|
|
24
|
+
export type MigrateFunction = MigrateFunctionSystem | MigrateFunctionCore;
|
|
34
25
|
export type InputFunctionCore = () => MigrationStepInput[];
|
|
35
26
|
export type InputFunctionSystem = (context: MigrationContextSystem) => MigrationStepInput[];
|
|
36
|
-
export type
|
|
37
|
-
export type InputFunctionShowStyle = (context: MigrationContextShowStyle) => MigrationStepInput[];
|
|
38
|
-
export type InputFunction = InputFunctionStudio | InputFunctionShowStyle | InputFunctionSystem | InputFunctionCore;
|
|
39
|
-
export interface MigrationContextStudio {
|
|
40
|
-
getMapping: (mappingId: string) => BlueprintMapping | undefined;
|
|
41
|
-
insertMapping: (mappingId: string, mapping: OmitId<BlueprintMapping>) => string;
|
|
42
|
-
updateMapping: (mappingId: string, mapping: Partial<BlueprintMapping>) => void;
|
|
43
|
-
removeMapping: (mappingId: string) => void;
|
|
44
|
-
getConfig: (configId: string) => ConfigItemValue | undefined;
|
|
45
|
-
setConfig: (configId: string, value: ConfigItemValue) => void;
|
|
46
|
-
removeConfig: (configId: string) => void;
|
|
47
|
-
getDevice: (deviceId: string) => TSR.DeviceOptionsAny | undefined;
|
|
48
|
-
insertDevice: (deviceId: string, device: TSR.DeviceOptionsAny) => string | null;
|
|
49
|
-
updateDevice: (deviceId: string, device: Partial<TSR.DeviceOptionsAny>) => void;
|
|
50
|
-
removeDevice: (deviceId: string) => void;
|
|
51
|
-
}
|
|
52
|
-
export interface ShowStyleVariantPart {
|
|
53
|
-
name: string;
|
|
54
|
-
}
|
|
27
|
+
export type InputFunction = InputFunctionSystem | InputFunctionCore;
|
|
55
28
|
interface MigrationContextWithTriggeredActions {
|
|
56
|
-
getAllTriggeredActions: () => IBlueprintTriggeredActions[]
|
|
57
|
-
getTriggeredAction: (triggeredActionId: string) => IBlueprintTriggeredActions | undefined
|
|
29
|
+
getAllTriggeredActions: () => Promise<IBlueprintTriggeredActions[]>;
|
|
30
|
+
getTriggeredAction: (triggeredActionId: string) => Promise<IBlueprintTriggeredActions | undefined>;
|
|
58
31
|
getTriggeredActionId: (triggeredActionId: string) => string;
|
|
59
|
-
setTriggeredAction: (triggeredActions: IBlueprintTriggeredActions) => void
|
|
60
|
-
removeTriggeredAction: (triggeredActionId: string) => void
|
|
61
|
-
}
|
|
62
|
-
export interface MigrationContextShowStyle extends MigrationContextWithTriggeredActions {
|
|
63
|
-
getAllVariants: () => IBlueprintShowStyleVariant[];
|
|
64
|
-
getVariantId: (variantId: string) => string;
|
|
65
|
-
getVariant: (variantId: string) => IBlueprintShowStyleVariant | undefined;
|
|
66
|
-
insertVariant: (variantId: string, variant: OmitId<ShowStyleVariantPart>) => string;
|
|
67
|
-
updateVariant: (variantId: string, variant: Partial<ShowStyleVariantPart>) => void;
|
|
68
|
-
removeVariant: (variantId: string) => void;
|
|
69
|
-
getSourceLayer: (sourceLayerId: string) => ISourceLayer | undefined;
|
|
70
|
-
insertSourceLayer: (sourceLayerId: string, layer: OmitId<ISourceLayer>) => string;
|
|
71
|
-
updateSourceLayer: (sourceLayerId: string, layer: Partial<ISourceLayer>) => void;
|
|
72
|
-
removeSourceLayer: (sourceLayerId: string) => void;
|
|
73
|
-
getOutputLayer: (outputLayerId: string) => IOutputLayer | undefined;
|
|
74
|
-
insertOutputLayer: (outputLayerId: string, layer: OmitId<IOutputLayer>) => string;
|
|
75
|
-
updateOutputLayer: (outputLayerId: string, layer: Partial<IOutputLayer>) => void;
|
|
76
|
-
removeOutputLayer: (outputLayerId: string) => void;
|
|
77
|
-
getBaseConfig: (configId: string) => ConfigItemValue | undefined;
|
|
78
|
-
setBaseConfig: (configId: string, value: ConfigItemValue) => void;
|
|
79
|
-
removeBaseConfig: (configId: string) => void;
|
|
80
|
-
getVariantConfig: (variantId: string, configId: string) => ConfigItemValue | undefined;
|
|
81
|
-
setVariantConfig: (variantId: string, configId: string, value: ConfigItemValue) => void;
|
|
82
|
-
removeVariantConfig: (variantId: string, configId: string) => void;
|
|
32
|
+
setTriggeredAction: (triggeredActions: IBlueprintTriggeredActions) => Promise<void>;
|
|
33
|
+
removeTriggeredAction: (triggeredActionId: string) => Promise<void>;
|
|
83
34
|
}
|
|
84
35
|
export type MigrationContextSystem = MigrationContextWithTriggeredActions;
|
|
85
36
|
export interface MigrationStepBase<TValidate extends ValidateFunction, TMigrate extends MigrateFunction, TInput extends InputFunction> {
|
|
@@ -114,7 +65,5 @@ export interface MigrationStep<TValidate extends ValidateFunction, TMigrate exte
|
|
|
114
65
|
}
|
|
115
66
|
export type MigrationStepCore = MigrationStep<ValidateFunctionCore, MigrateFunctionCore, InputFunctionCore>;
|
|
116
67
|
export type MigrationStepSystem = MigrationStep<ValidateFunctionSystem, MigrateFunctionSystem, InputFunctionSystem>;
|
|
117
|
-
export type MigrationStepStudio = MigrationStep<ValidateFunctionStudio, MigrateFunctionStudio, InputFunctionStudio>;
|
|
118
|
-
export type MigrationStepShowStyle = MigrationStep<ValidateFunctionShowStyle, MigrateFunctionShowStyle, InputFunctionShowStyle>;
|
|
119
68
|
export {};
|
|
120
69
|
//# sourceMappingURL=migrations.d.ts.map
|
package/dist/migrations.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../src/migrations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../src/migrations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAEvD,MAAM,WAAW,kBAAkB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,WAAW,GAAG,KAAK,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,CAAA;IACnF,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC1B;AACD,MAAM,WAAW,wBAAwB;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,GAAG,CAAA;CACV;AACD,MAAM,WAAW,gCAAgC;IAChD,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAA;CACxB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,cAAc,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,CAAA;AACzF,MAAM,MAAM,sBAAsB,GAAG,CACpC,OAAO,EAAE,sBAAsB,EAC/B,cAAc,EAAE,OAAO,KACnB,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC,CAAA;AAC9B,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GAAG,oBAAoB,CAAA;AAE5E,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,gCAAgC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAC5F,MAAM,MAAM,qBAAqB,GAAG,CACnC,OAAO,EAAE,sBAAsB,EAC/B,KAAK,EAAE,gCAAgC,KACnC,OAAO,CAAC,IAAI,CAAC,CAAA;AAClB,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,mBAAmB,CAAA;AAEzE,MAAM,MAAM,iBAAiB,GAAG,MAAM,kBAAkB,EAAE,CAAA;AAC1D,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,EAAE,sBAAsB,KAAK,kBAAkB,EAAE,CAAA;AAC3F,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,iBAAiB,CAAA;AAEnE,UAAU,oCAAoC;IAC7C,sBAAsB,EAAE,MAAM,OAAO,CAAC,0BAA0B,EAAE,CAAC,CAAA;IACnE,kBAAkB,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC,CAAA;IAClG,oBAAoB,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,MAAM,CAAA;IAC3D,kBAAkB,EAAE,CAAC,gBAAgB,EAAE,0BAA0B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACnF,qBAAqB,EAAE,CAAC,iBAAiB,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACnE;AAED,MAAM,MAAM,sBAAsB,GAAG,oCAAoC,CAAA;AAEzE,MAAM,WAAW,iBAAiB,CACjC,SAAS,SAAS,gBAAgB,EAClC,QAAQ,SAAS,eAAe,EAChC,MAAM,SAAS,aAAa;IAE5B,8BAA8B;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,2GAA2G;IAC3G,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,SAAS,CAAA;IAEnB,oFAAoF;IACpF,qBAAqB,EAAE,OAAO,CAAA;IAC9B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,iDAAiD;IACjD,KAAK,CAAC,EAAE,kBAAkB,EAAE,GAAG,MAAM,CAAA;IAErC,iHAAiH;IACjH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC3B;AACD,MAAM,WAAW,aAAa,CAC7B,SAAS,SAAS,gBAAgB,EAClC,QAAQ,SAAS,eAAe,EAChC,MAAM,SAAS,aAAa,CAC3B,SAAQ,iBAAiB,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC;IACvD,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,iBAAiB,CAAC,CAAA;AAC3G,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,sBAAsB,EAAE,qBAAqB,EAAE,mBAAmB,CAAC,CAAA"}
|
package/dist/timeline.js
CHANGED
|
@@ -11,5 +11,5 @@ var TimelineObjClassesCore;
|
|
|
11
11
|
TimelineObjClassesCore["RundownActive"] = "rundown_active";
|
|
12
12
|
TimelineObjClassesCore["BeforeFirstPart"] = "before_first_part";
|
|
13
13
|
TimelineObjClassesCore["NoNextPart"] = "last_part";
|
|
14
|
-
})(TimelineObjClassesCore
|
|
14
|
+
})(TimelineObjClassesCore || (exports.TimelineObjClassesCore = TimelineObjClassesCore = {}));
|
|
15
15
|
//# sourceMappingURL=timeline.js.map
|
package/dist/timeline.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timeline.js","sourceRoot":"","sources":["../src/timeline.ts"],"names":[],"mappings":";;;AACA,+DAA2D;AAElD,oFAFA,SAAG,OAEA;AAEZ,kFAI8D;AAH7D,+GAAA,mBAAmB,OAAA;AAKpB,IAAY,sBAKX;AALD,WAAY,sBAAsB;IACjC,+DAAqC,CAAA;IACrC,0DAAgC,CAAA;IAChC,+DAAqC,CAAA;IACrC,kDAAwB,CAAA;AACzB,CAAC,EALW,sBAAsB,
|
|
1
|
+
{"version":3,"file":"timeline.js","sourceRoot":"","sources":["../src/timeline.ts"],"names":[],"mappings":";;;AACA,+DAA2D;AAElD,oFAFA,SAAG,OAEA;AAEZ,kFAI8D;AAH7D,+GAAA,mBAAmB,OAAA;AAKpB,IAAY,sBAKX;AALD,WAAY,sBAAsB;IACjC,+DAAqC,CAAA;IACrC,0DAAgC,CAAA;IAChC,+DAAqC,CAAA;IACrC,kDAAwB,CAAA;AACzB,CAAC,EALW,sBAAsB,sCAAtB,sBAAsB,QAKjC"}
|