@bbc/sofie-live-status-gateway-api 1.53.0-in-development

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License (MIT)
+
+Copyright (c) 2018 Norsk rikskringkasting AS (NRK)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# Sofie: The Modern TV News Studio Automation System (Live Status Gateway API)
+
+[![npm](https://img.shields.io/npm/v/@sofie-automation/live-status-gateway-api)](https://www.npmjs.com/package/@sofie-automation/live-status-gateway-api)
+
+This library is used as part of [**Sofie Server Core**](https://github.com/nrkno/sofie-core).
+
+This is a part of the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/).
+
+## Purpose
+
+This library is a collection of typings used by the `live-status-gateway` and consumers of the api it provides.
+
+The package also contains the asyncapi schema, to allow for other consumers of the library to do their own generating if desired.

package/api/asyncapi.yaml

@@ -0,0 +1,51 @@
+asyncapi: '2.6.0'
+id: 'sofie:live-status-gateway:server'
+info:
+  title: Sofie Live Status Service
+  version: '2.0.1'
+  description: This service provides subscriptions for status updates from Sofie
+  license:
+    name: MIT License
+    url: http://opensource.org/licenses/MIT
+  contact:
+    name: Sofie TV Automation
+    url: https://github.com/Sofie-Automation/sofie-core/issues
+
+servers:
+  development:
+    url: localhost
+    description: Server available without authorization
+    protocol: ws
+    protocolVersion: '13'
+
+defaultContentType: application/json
+
+tags:
+  - name: sofie
+  - name: tv-automation
+  - name: broadcast
+
+channels:
+  # As the LSG is websocket only, channels are only used for logical grouping for the generated docs and folder structure.
+  ping:
+    $ref: './topics/ping/pingTopic.yaml'
+  heartbeat:
+    $ref: './topics/heartbeat/heartbeatTopic.yaml'
+  subscriptions:
+    $ref: './topics/subscriptions/subscriptionsTopic.yaml'
+  studio:
+    $ref: './topics/studio/studioTopic.yaml'
+  activePlaylist:
+    $ref: './topics/activePlaylist/activePlaylistTopic.yaml'
+  activePieces:
+    $ref: './topics/activePieces/activePiecesTopic.yaml'
+  segments:
+    $ref: './topics/segments/segmentsTopic.yaml'
+  adLibs:
+    $ref: './topics/adLibs/adLibsTopic.yaml'
+  packages:
+    $ref: './topics/packages/packagesTopic.yaml'
+  buckets:
+    $ref: './topics/buckets/bucketsTopic.yaml'
+  notifications:
+    $ref: './topics/notifications/notificationsTopic.yaml'

package/api/components/adLibs/actionType/actionType-example.yaml

@@ -0,0 +1,2 @@
+name: pvw
+label: Preview

package/api/components/adLibs/actionType/actionType.yaml

@@ -0,0 +1,15 @@
+$defs:
+  adLibActionType:
+    title: AdLibActionType
+    type: object
+    properties:
+      name:
+        type: string
+        description: The string to be passed to the ExecuteAdlib function
+      label:
+        type: string
+        description: The label for the AdLib type
+    required: [name, label]
+    additionalProperties: false
+    examples:
+      - $ref: './actionType-example.yaml'

package/api/components/adLibs/adLibBase/adLibBase-example.yaml

@@ -0,0 +1,9 @@
+id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+name: Music video clip
+sourceLayer: Video Clip
+actionType:
+  - $ref: '../actionType/actionType-example.yaml'
+tags: ['music_video']
+publicData:
+  fileName: MV000123.mxf
+optionsSchema: '{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Play Video Clip","type":"object","properties":{"type":"adlib_action_video_clip","label":{"type":"string"},"clipId":{"type":"string"},"vo":{"type":"boolean"},"target":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Object Id","description":"Id of an object sent to Sofie","type":"string"},"duration":{"type":"number","exclusiveMinimum":0},"takeType":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"AdLib Action Take Type","type":"string","enum":["take_immediate","queue"]},"transition":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"AdLib Action Transition Type","oneOf":[{"type":"object","properties":{"type":"cut"},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":"mix","duration":{"type":"number","exclusiveMinimum":0,"description":"Duration in ms"}},"required":["type","duration"],"additionalProperties":false},{"type":"object","properties":{"type":"wipe","duration":{"type":"number","exclusiveMinimum":0,"description":"Duration in ms"},"patternId":{"type":"string","description":"Type of wipe to use"}},"required":["type","duration","patternId"],"additionalProperties":false},{"type":"object","properties":{"type":"macro","macroId":{"type":"string","description":"Macro template to recall"}},"required":["type","macroId"],"additionalProperties":false}]}},"required":["type","clipId","vo","target"],"additionalProperties":false}"'

package/api/components/adLibs/adLibBase/adLibBase.yaml

@@ -0,0 +1,35 @@
+$defs:
+  adLibBase:
+    title: AdLibBase
+    type: object
+    properties:
+      id:
+        type: string
+        description: Unique id of the AdLib
+      name:
+        type: string
+        description: The user defined AdLib name
+      sourceLayer:
+        type: string
+        description: The source layer name for this AdLib
+      outputLayer:
+        type: string
+        description: The output layer name for this AdLib
+      actionType:
+        type: array
+        description: The available action type names that can be used to modify the execution of the AdLib
+        items:
+          $ref: '../actionType/actionType.yaml#/$defs/adLibActionType'
+      tags:
+        type: array
+        description: Tags attached to this AdLib
+        items:
+          type: string
+      publicData:
+        description: Optional arbitrary data
+      optionsSchema:
+        type: string
+        description: JSON schema definition of the adLib properties that can be modified using the adLibOptions property in executeAdLib
+    required: [id, name, sourceLayer, actionType]
+    examples:
+      - $ref: './adLibBase-example.yaml'

package/api/components/adLibs/adLibStatus/adLibStatus-example.yaml

@@ -0,0 +1,3 @@
+$ref: '../adLibBase/adLibBase-example.yaml'
+segmentId: HsD8_QwE1ZmR5vN3XcK_Ab7y
+partId: JkL3_OpR6WxT1bF8Vq2_Zy9u

package/api/components/adLibs/adLibStatus/adLibStatus.yaml

@@ -0,0 +1,17 @@
+$defs:
+  adLibStatus:
+    title: AdLibStatus
+    allOf:
+      - $ref: '../adLibBase/adLibBase.yaml#/$defs/adLibBase'
+      - type: object
+        title: AdLibStatus
+        properties:
+          segmentId:
+            description: Unique id of the segment this adLib belongs to
+            type: string
+          partId:
+            description: Unique id of the part this adLib belongs to
+            type: string
+        required: [segmentId, partId]
+    examples:
+      - $ref: './adLibStatus-example.yaml'

package/api/components/adLibs/adLibsEvent/adLibsEvent-example.yaml

@@ -0,0 +1,6 @@
+event: 'adLibs'
+rundownPlaylistId: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+adLibs:
+  - $ref: '../adLibStatus/adLibStatus-example.yaml'
+globalAdLibs:
+  - $ref: '../globalAdLibStatus/globalAdLibStatus-example.yaml'

package/api/components/adLibs/adLibsEvent/adLibsEvent.yaml

@@ -0,0 +1,29 @@
+$defs:
+  adLibsEvent:
+    type: object
+    title: AdLibsEvent
+    properties:
+      event:
+        type: string
+        const: adLibs
+      rundownPlaylistId:
+        description: Unique id of the rundown playlist, or null if no playlist is active
+        oneOf:
+          - type: string
+            title: Unique id of the rundown playlist
+          - type: 'null'
+            title: Null if no playlist is active
+      adLibs:
+        type: array
+        description: The available AdLibs for this playlist
+        items:
+          $ref: '../adLibStatus/adLibStatus.yaml#/$defs/adLibStatus'
+      globalAdLibs:
+        type: array
+        description: The available Global AdLibs for this playlist
+        items:
+          $ref: '../globalAdLibStatus/globalAdLibStatus.yaml#/$defs/globalAdLibStatus'
+    required: [event, rundownPlaylistId, adLibs, globalAdLibs]
+    additionalProperties: false
+    examples:
+      - $ref: './adLibsEvent-example.yaml'

package/api/components/adLibs/bucketAdLibStatus/bucketAdLibStatus-example.yaml

@@ -0,0 +1,2 @@
+$ref: '../adLibBase/adLibBase-example.yaml'
+externalId: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'

package/api/components/adLibs/bucketAdLibStatus/bucketAdLibStatus.yaml

@@ -0,0 +1,14 @@
+$defs:
+  bucketAdLibStatus:
+    title: BucketAdLibStatus
+    allOf:
+      - $ref: '../adLibBase/adLibBase.yaml#/$defs/adLibBase'
+      - type: object
+        title: BucketAdLibStatus
+        properties:
+          externalId:
+            type: string
+            description: Id of the adLib recognizable by the external source. Unique within a bucket.
+        required: [externalId]
+    examples:
+      - $ref: './bucketAdLibStatus-example.yaml'

package/api/components/adLibs/globalAdLibStatus/globalAdLibStatus-example.yaml

@@ -0,0 +1 @@
+$ref: '../adLibBase/adLibBase-example.yaml'

package/api/components/adLibs/globalAdLibStatus/globalAdLibStatus.yaml

@@ -0,0 +1,7 @@
+$defs:
+  globalAdLibStatus:
+    title: GlobalAdLibStatus
+    allOf:
+      - $ref: '../adLibBase/adLibBase.yaml#/$defs/adLibBase'
+    examples:
+      - $ref: './globalAdLibStatus-example.yaml'

package/api/components/adLibs/messages/adLibsMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    adLibsMessage:
+      messageId: adLibs
+      title: AdLibs Event Message
+      payload:
+        $ref: '../adLibsEvent/adLibsEvent.yaml#/$defs/adLibsEvent'
+      examples:
+        - payload:
+            $ref: '../adLibsEvent/adLibsEvent-example.yaml'

package/api/components/buckets/bucketStatus/bucketStatus-example.yaml

@@ -0,0 +1,4 @@
+id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+name: My Bucket
+adLibs:
+  - $ref: '../../adLibs/bucketAdLibStatus/bucketAdLibStatus-example.yaml'

package/api/components/buckets/bucketStatus/bucketStatus.yaml

@@ -0,0 +1,20 @@
+$defs:
+  bucketStatus:
+    title: BucketStatus
+    type: object
+    properties:
+      id:
+        description: Unique id of the bucket
+        type: string
+      name:
+        description: The user defined bucket name
+        type: string
+      adLibs:
+        description: The AdLibs in this bucket
+        type: array
+        items:
+          $ref: '../../adLibs/bucketAdLibStatus/bucketAdLibStatus.yaml#/$defs/bucketAdLibStatus'
+    required: [id, name, adLibs]
+    additionalProperties: false
+    examples:
+      - $ref: './bucketStatus-example.yaml'

package/api/components/buckets/bucketsEvent/bucketsEvent-example.yaml

@@ -0,0 +1,3 @@
+event: buckets
+buckets:
+  - $ref: '../bucketStatus/bucketStatus-example.yaml'

package/api/components/buckets/bucketsEvent/bucketsEvent.yaml

@@ -0,0 +1,17 @@
+$defs:
+  bucketsEvent:
+    title: BucketsEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: buckets
+      buckets:
+        description: Buckets available in the Studio
+        type: array
+        items:
+          $ref: '../bucketStatus/bucketStatus.yaml#/$defs/bucketStatus'
+    required: [event, buckets]
+    additionalProperties: false
+    examples:
+      - $ref: './bucketsEvent-example.yaml'

package/api/components/buckets/messages/bucketsMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    bucketsMessage:
+      messageId: buckets
+      title: Buckets in Studio
+      payload:
+        $ref: '../bucketsEvent/bucketsEvent.yaml#/$defs/bucketsEvent'
+      examples:
+        - payload:
+            $ref: '../bucketsEvent/bucketsEvent-example.yaml'

package/api/components/connection/heartbeatEvent/heartbeatEvent-example.yaml

@@ -0,0 +1 @@
+event: heartbeat

package/api/components/connection/heartbeatEvent/heartbeatEvent.yaml

@@ -0,0 +1,12 @@
+$defs:
+  heartbeatEvent:
+    title: HeartbeatEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: heartbeat
+    required: [event]
+    additionalProperties: false
+    examples:
+      - $ref: './heartbeatEvent-example.yaml'

package/api/components/connection/messages/heartbeatMessage.yaml

@@ -0,0 +1,11 @@
+components:
+  messages:
+    heartbeatMessage:
+      name: heartbeat
+      messageId: heartbeat
+      description: Server heartbeat sent if no subscription traffic within 1 second (approximately)
+      payload:
+        $ref: '../heartbeatEvent/heartbeatEvent.yaml#/$defs/heartbeatEvent'
+      examples:
+        - payload:
+            $ref: '../heartbeatEvent/heartbeatEvent-example.yaml'

package/api/components/connection/messages/pingMessage.yaml

@@ -0,0 +1,12 @@
+components:
+  messages:
+    pingMessage:
+      name: ping
+      messageId: ping
+      summary: Ping server to determine whether connection is alive
+      description: Client can ping server to determine whether connection is alive, server responds with pong. This is an application level ping as opposed to default ping in websockets standard which is server initiated
+      payload:
+        $ref: '../pingEvent/pingEvent.yaml#/$defs/pingEvent'
+      examples:
+        - payload:
+            $ref: '../pingEvent/pingEvent-example.yaml'

package/api/components/connection/messages/pongMessage.yaml

@@ -0,0 +1,12 @@
+components:
+  messages:
+    pongMessage:
+      name: pong
+      messageId: pong
+      summary: Pong is a response to ping message
+      description: Server pong response to a ping to determine whether connection is alive. This is an application level pong as opposed to default pong in websockets standard which is sent by client in response to a ping
+      payload:
+        $ref: '../pongEvent/pongEvent.yaml#/$defs/pongEvent'
+      examples:
+        - payload:
+            $ref: '../pongEvent/pongEvent-example.yaml'

package/api/components/connection/pingEvent/pingEvent-example.yaml

@@ -0,0 +1,2 @@
+event: ping
+reqid: 27

package/api/components/connection/pingEvent/pingEvent.yaml

@@ -0,0 +1,14 @@
+$defs:
+  pingEvent:
+    title: PingEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: ping
+      reqid:
+        $ref: '../reqid/reqid.yaml#/$defs/reqid'
+    required: [event, reqid]
+    additionalProperties: false
+    examples:
+      - $ref: './pingEvent-example.yaml'

package/api/components/connection/pongEvent/pongEvent-example.yaml

@@ -0,0 +1,2 @@
+event: pong
+reqid: 27

package/api/components/connection/pongEvent/pongEvent.yaml

@@ -0,0 +1,14 @@
+$defs:
+  pongEvent:
+    title: PongEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: pong
+      reqid:
+        $ref: '../reqid/reqid.yaml#/$defs/reqid'
+    required: [event, reqid]
+    additionalProperties: false
+    examples:
+      - $ref: './pongEvent-example.yaml'

package/api/components/connection/reqid/reqid.yaml

@@ -0,0 +1,4 @@
+$defs:
+  reqid:
+    type: integer
+    description: Client originated ID reflected in response message.

package/api/components/notifications/events/notificationsEvent/notificationsEvent-example.yaml

@@ -0,0 +1,3 @@
+event: notifications
+activeNotifications:
+  - $ref: '../../notificationObj/notificationObj-example.yaml'

package/api/components/notifications/events/notificationsEvent/notificationsEvent.yaml

@@ -0,0 +1,18 @@
+$defs:
+  notificationsEvent:
+    type: object
+    title: NotificationsEvent
+    description: Active notifications in Sofie
+    properties:
+      event:
+        type: string
+        const: notifications
+      activeNotifications:
+        description: Active notifications in Sofie
+        type: array
+        items:
+          $ref: '../../notificationObj/notificationObj.yaml#/$defs/NotificationObj'
+    required: [event, activeNotifications]
+    additionalProperties: false
+    examples:
+      - $ref: './notificationsEvent-example.yaml'

package/api/components/notifications/messages/notificationsMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    notificationsMessage:
+      messageId: notificationsUpdate
+      title: Active notifications in Sofie
+      payload:
+        $ref: '../events/notificationsEvent/notificationsEvent.yaml#/$defs/notificationsEvent'
+      examples:
+        - payload:
+            $ref: '../events/notificationsEvent/notificationsEvent-example.yaml'

package/api/components/notifications/notificationObj/notificationObj-example.yaml

@@ -0,0 +1,7 @@
+_id: 'notif123'
+severity: error
+message: 'disk.space.low'
+relatedTo:
+  $ref: '../target/pieceInstance/notificationTargetPieceInstance-example.yaml'
+created: 1694784932
+modified: 1694784950

package/api/components/notifications/notificationObj/notificationObj.yaml

@@ -0,0 +1,33 @@
+$defs:
+  NotificationObj:
+    type: object
+    title: NotificationObj
+    description: This describes a notification that should be shown to a user. These can come from various sources, and are added and removed dynamically during system usage
+    required:
+      - _id
+      - severity
+      - message
+      - relatedTo
+      - created
+    properties:
+      _id:
+        type: string
+        description: Unique identifier for the notification
+      severity:
+        $ref: '../notificationSeverity.yaml#/$defs/severity'
+      message:
+        type: string
+        description: The message of the notification
+      relatedTo:
+        $ref: '../target/notificationTarget.yaml#/$defs/NotificationTarget'
+      created:
+        type: integer
+        format: int64
+        description: Unix timestamp of creation
+      modified:
+        type: integer
+        format: int64
+        description: Unix timestamp of last modification
+    additionalProperties: false
+    examples:
+      - $ref: './notificationObj-example.yaml'

package/api/components/notifications/notificationSeverity.yaml

@@ -0,0 +1,9 @@
+$defs:
+  severity:
+    type: string
+    title: NotificationSeverity
+    description: Severity level of the notification.
+    enum:
+      - warning
+      - error
+      - info

package/api/components/notifications/target/notificationTarget.yaml

@@ -0,0 +1,16 @@
+$defs:
+  NotificationTarget:
+    title: NotificationTarget
+    description: Describes what the notification is related to
+    oneOf:
+      - $ref: './rundown/notificationTargetRundown.yaml#/$defs/NotificationTargetRundown'
+      - $ref: './rundownPlaylist/notificationTargetRundownPlaylist.yaml#/$defs/NotificationTargetRundownPlaylist'
+      - $ref: './partInstance/notificationTargetPartInstance.yaml#/$defs/NotificationTargetPartInstance'
+      - $ref: './pieceInstance/notificationTargetPieceInstance.yaml#/$defs/NotificationTargetPieceInstance'
+      - $ref: './unknown/notificationTargetUnknown.yaml#/$defs/NotificationTargetUnknown'
+    examples:
+      - $ref: './rundown/notificationTargetRundown-example.yaml'
+      - $ref: './rundownPlaylist/notificationTargetRundownPlaylist-example.yaml'
+      - $ref: './partInstance/notificationTargetPartInstance-example.yaml'
+      - $ref: './pieceInstance/notificationTargetPieceInstance-example.yaml'
+      - $ref: './unknown/notificationTargetUnknown-example.yaml'

package/api/components/notifications/target/notificationTargetType.yaml

@@ -0,0 +1,11 @@
+$defs:
+  NotificationTargetType:
+    type: string
+    title: NotificationTargetType
+    description: Possible NotificationTarget types
+    enum:
+      - rundown
+      - playlist
+      - partInstance
+      - pieceInstance
+      - unknown

package/api/components/notifications/target/partInstance/notificationTargetPartInstance-example.yaml

@@ -0,0 +1,4 @@
+type: partInstance
+studioId: studio01
+rundownId: rd123
+partInstanceId: pi789

package/api/components/notifications/target/partInstance/notificationTargetPartInstance.yaml

@@ -0,0 +1,18 @@
+$defs:
+  NotificationTargetPartInstance:
+    type: object
+    title: NotificationTargetPartInstance
+    required: [type, studioId, rundownId, partInstanceId]
+    properties:
+      type:
+        $ref: '../notificationTargetType.yaml#/$defs/NotificationTargetType'
+        const: partInstance
+      studioId:
+        type: string
+      rundownId:
+        type: string
+      partInstanceId:
+        type: string
+    additionalProperties: false
+    examples:
+      - $ref: './notificationTargetPartInstance-example.yaml'

package/api/components/notifications/target/pieceInstance/notificationTargetPieceInstance-example.yaml

@@ -0,0 +1,5 @@
+type: pieceInstance
+studioId: studio01
+rundownId: rd123
+partInstanceId: pi789
+pieceInstanceId: pc1011

package/api/components/notifications/target/pieceInstance/notificationTargetPieceInstance.yaml

@@ -0,0 +1,20 @@
+$defs:
+  NotificationTargetPieceInstance:
+    type: object
+    title: NotificationTargetPieceInstance
+    required: [type, studioId, rundownId, partInstanceId, pieceInstanceId]
+    properties:
+      type:
+        $ref: '../notificationTargetType.yaml#/$defs/NotificationTargetType'
+        const: pieceInstance
+      studioId:
+        type: string
+      rundownId:
+        type: string
+      partInstanceId:
+        type: string
+      pieceInstanceId:
+        type: string
+    additionalProperties: false
+    examples:
+      - $ref: './notificationTargetPieceInstance-example.yaml'

package/api/components/notifications/target/rundown/notificationTargetRundown-example.yaml

@@ -0,0 +1,3 @@
+type: rundown
+studioId: studio01
+rundownId: rd123

package/api/components/notifications/target/rundown/notificationTargetRundown.yaml

@@ -0,0 +1,16 @@
+$defs:
+  NotificationTargetRundown:
+    type: object
+    title: NotificationTargetRundown
+    required: [type, studioId, rundownId]
+    properties:
+      type:
+        $ref: '../notificationTargetType.yaml#/$defs/NotificationTargetType'
+        const: rundown
+      studioId:
+        type: string
+      rundownId:
+        type: string
+    additionalProperties: false
+    examples:
+      - $ref: './notificationTargetRundown-example.yaml'

package/api/components/notifications/target/rundownPlaylist/notificationTargetRundownPlaylist-example.yaml

@@ -0,0 +1,3 @@
+type: playlist
+studioId: studio01
+playlistId: pl456