Merge pull request Sofie-Automation#1466 from evs-broadcast/feat/playlist-external-id

feat: playlist external ID in REST API and Live Status Gateway

Author: nytamin

meteor/server/api/rest/v1/playlists.ts

@@ -41,12 +41,16 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 	async getAllRundownPlaylists(
 		_connection: Meteor.Connection,
 		_event: string
-	): Promise<ClientAPI.ClientResponse<Array<{ id: string }>>> {
-		const rundownPlaylists = (await RundownPlaylists.findFetchAsync({}, { projection: { _id: 1 } })) as Array<
-			Pick<DBRundownPlaylist, '_id'>
-		>
+	): Promise<ClientAPI.ClientResponse<Array<{ id: string; externalId: string }>>> {
+		const rundownPlaylists = (await RundownPlaylists.findFetchAsync(
+			{},
+			{ projection: { _id: 1, externalId: 1 } }
+		)) as Array<Pick<DBRundownPlaylist, '_id' | 'externalId'>>
 		return ClientAPI.responseSuccess(
-			rundownPlaylists.map((rundownPlaylist) => ({ id: unprotectString(rundownPlaylist._id) }))
+			rundownPlaylists.map((rundownPlaylist) => ({
+				id: unprotectString(rundownPlaylist._id),
+				externalId: rundownPlaylist.externalId,
+			}))
 		)
 	}
 

packages/live-status-gateway-api/api/schemas/activePlaylist.yaml

@@ -13,6 +13,11 @@ $defs:
         oneOf:
           - type: string
           - type: 'null'
+      externalId:
+        description: Id normally sourced from the ingest system
+        oneOf:
+          - type: string
+          - type: 'null'
       name:
         description: User-presentable name for the active playlist
         type: string
@@ -77,11 +82,12 @@ $defs:
             description: The end of the loop
             $ref: '#/$defs/quickLoopMarker'
         required: [locked, running]
-    required: [event, id, name, rundownIds, currentPart, currentSegment, nextPart, timing]
+    required: [event, id, externalId, name, rundownIds, currentPart, currentSegment, nextPart, timing]
     additionalProperties: false
     examples:
       - event: activePlaylist
         id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+        externalId: '1ZIYVYL1aEkNEJbeGsmRXr5s8wtkyxfPRjNSTxZfcoEI'
         name: 'Playlist 0'
         rundownIds: ['y9HauyWkcxQS3XaAOsW40BRLLsI_']
         currentPart:

packages/live-status-gateway-api/api/schemas/studio.yaml

@@ -36,6 +36,9 @@ $defs:
       id:
         description: Unique id of the playlist
         type: string
+      externalId:
+        description: Id normally sourced from the ingest system
+        type: string
       name:
         description: The user defined playlist name
         type: string
@@ -47,9 +50,10 @@ $defs:
           - deactivated
           - rehearsal
           - activated
-    required: [id, name, activationStatus]
+    required: [id, externalId, name, activationStatus]
     additionalProperties: false
     examples:
       - id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+        externalId: '1ZIYVYL1aEkNEJbeGsmRXr5s8wtkyxfPRjNSTxZfcoEI'
         name: 'Playlist 0'
         activationStatus: rehearsal

packages/live-status-gateway-api/src/generated/schema.ts

@@ -102,6 +102,10 @@ interface PlaylistStatus {
 	 * Unique id of the playlist
 	 */
 	id: string
+	/**
+	 * Id normally sourced from the ingest system
+	 */
+	externalId: string
 	/**
 	 * The user defined playlist name
 	 */
@@ -127,6 +131,10 @@ interface ActivePlaylistEvent {
 	 * Unique id of the active playlist
 	 */
 	id: string | null
+	/**
+	 * Id normally sourced from the ingest system
+	 */
+	externalId: string | null
 	/**
 	 * User-presentable name for the active playlist
 	 */

packages/live-status-gateway/src/topics/__tests__/activePlaylist.spec.ts

@@ -53,6 +53,7 @@ describe('ActivePlaylistTopic', () => {
 			event: 'activePlaylist',
 			name: playlist.name,
 			id: unprotectString(playlist._id),
+			externalId: 'NCS_PLAYLIST_1',
 			currentPart: null,
 			nextPart: null,
 			currentSegment: null,
@@ -129,6 +130,7 @@ describe('ActivePlaylistTopic', () => {
 			event: 'activePlaylist',
 			name: playlist.name,
 			id: unprotectString(playlist._id),
+			externalId: 'NCS_PLAYLIST_1',
 			currentPart: {
 				id: 'PART_1',
 				name: 'Test Part',
@@ -232,6 +234,7 @@ describe('ActivePlaylistTopic', () => {
 			event: 'activePlaylist',
 			name: playlist.name,
 			id: unprotectString(playlist._id),
+			externalId: 'NCS_PLAYLIST_1',
 			currentPart: {
 				id: 'PART_1',
 				name: 'Test Part',

packages/live-status-gateway/src/topics/activePlaylistTopic.ts

@@ -40,6 +40,7 @@ const THROTTLE_PERIOD_MS = 100
 
 const PLAYLIST_KEYS = [
 	'_id',
+	'externalId',
 	'activationId',
 	'name',
 	'rundownIdsInOrder',
@@ -103,6 +104,7 @@ export class ActivePlaylistTopic extends WebSocketTopicBase implements WebSocket
 			? literal<ActivePlaylistEvent>({
 					event: 'activePlaylist',
 					id: unprotectString(this._activePlaylist._id),
+					externalId: this._activePlaylist.externalId,
 					name: this._activePlaylist.name,
 					rundownIds: this._activePlaylist.rundownIdsInOrder.map((r) => unprotectString(r)),
 					currentPart:
@@ -172,6 +174,7 @@ export class ActivePlaylistTopic extends WebSocketTopicBase implements WebSocket
 			: literal<ActivePlaylistEvent>({
 					event: 'activePlaylist',
 					id: null,
+					externalId: null,
 					name: '',
 					rundownIds: [],
 					currentPart: null,

packages/live-status-gateway/src/topics/studioTopic.ts

@@ -56,6 +56,7 @@ export class StudioTopic extends WebSocketTopicBase implements WebSocketTopic {
 				if (p.activationId && p.rehearsal) activationStatus = PlaylistActivationStatus.REHEARSAL
 				return literal<PlaylistStatus>({
 					id: unprotectString(p._id),
+					externalId: p.externalId,
 					name: p.name,
 					activationStatus: activationStatus,
 				})

packages/openapi/api/definitions/playlists.yaml

@@ -722,8 +722,11 @@ components:
       properties:
         id:
           type: string
+        externalId:
+          type: string
       required:
         - id
+        - externalId
       additionalProperties: false
   responses:
     putSuccess: