@bbc/sofie-live-status-gateway-api 1.53.0-nightly-fix-syncingestchanges-removePartInstance-59fb212-20250318-201816.0

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 (Shared Lib)
+
+[![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,139 @@
+asyncapi: 2.6.0
+id: 'urn:nrk:no:sofie:live-status-gateway:server'
+info:
+  title: Sofie Live Status Service
+  description: This service provides subscriptions for status updates from Sofie
+  version: 2.0.0
+  license:
+    name: MIT License
+    url: http://opensource.org/licenses/MIT
+  contact:
+    name: Sofie TV Automation - NRK Team
+    url: https://github.com/nrkno/sofie-core/issues
+
+servers:
+  development:
+    url: localhost
+    description: Server available without authorisation
+    protocol: ws
+    protocolVersion: '13'
+
+defaultContentType: application/json
+
+tags:
+  - name: sofie
+  - name: tv-automation
+  - name: broadcast
+
+channels:
+  /:
+    publish:
+      description: Send messages to the root API
+      operationId: processRootMessage
+      message:
+        oneOf:
+          - $ref: '#/components/messages/ping'
+          - $ref: '#/components/messages/subscribe'
+          - $ref: '#/components/messages/unsubscribe'
+    subscribe:
+      description: Messages that are received from the API
+      operationId: sendRootMessage
+      message:
+        oneOf:
+          - $ref: '#/components/messages/pong'
+          - $ref: '#/components/messages/heartbeat'
+          - $ref: '#/components/messages/subscriptionStatus'
+          - $ref: '#/components/messages/studio'
+          - $ref: '#/components/messages/activePlaylist'
+          - $ref: '#/components/messages/activePieces'
+          - $ref: '#/components/messages/segments'
+          - $ref: '#/components/messages/adLibs'
+          - $ref: '#/components/messages/packages'
+          - $ref: '#/components/messages/buckets'
+components:
+  messages:
+    ping:
+      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: './schemas/root.yaml#/$defs/ping'
+      x-response:
+        $ref: '#/components/messages/pong'
+    pong:
+      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: './schemas/root.yaml#/$defs/pong'
+    heartbeat:
+      name: heartbeat
+      messageId: heartbeat
+      description: Server heartbeat sent if no subscription traffic within 1 second (approximately)
+      payload:
+        $ref: './schemas/root.yaml#/$defs/heartbeat'
+    subscribe:
+      name: subscribe
+      messageId: subscribe
+      description: Subscribe to a topic
+      payload:
+        $ref: './schemas/root.yaml#/$defs/subscribe'
+      x-response:
+        $ref: './schemas/root.yaml#/$defs/subscriptionStatus'
+    unsubscribe:
+      name: unsubscribe
+      messageId: unsubscribe
+      description: Unsubscribe from a topic
+      payload:
+        $ref: './schemas/root.yaml#/$defs/unsubscribe'
+      x-response:
+        $ref: './schemas/root.yaml#/$defs/subscriptionStatus'
+    subscriptionStatus:
+      messageId: subscriptionStatus
+      description: Subscription status response to subscribe or unsubscribe
+      payload:
+        $ref: './schemas/root.yaml#/$defs/subscriptionStatus'
+    studio:
+      name: studio
+      messageId: studioUpdate
+      description: Studio status
+      payload:
+        $ref: './schemas/studio.yaml#/$defs/studio'
+    activePlaylist:
+      name: activePlaylist
+      messageId: activePlaylistUpdate
+      description: Active Playlist status
+      payload:
+        $ref: './schemas/activePlaylist.yaml#/$defs/activePlaylist'
+    activePieces:
+      name: activePieces
+      messageId: activePiecesUpdate
+      summary: Active Pieces status
+      description: Pieces from the active Playlist that are currently active (on air)
+      payload:
+        $ref: './schemas/activePieces.yaml#/$defs/activePieces'
+    segments:
+      name: segments
+      messageId: segmentsUpdate
+      description: Segments in active Playlist
+      payload:
+        $ref: './schemas/segments.yaml#/$defs/segments'
+    adLibs:
+      name: adLibs
+      messageId: adLibsUpdate
+      description: AdLibs in active Playlist
+      payload:
+        $ref: './schemas/adLibs.yaml#/$defs/adLibs'
+    packages:
+      name: packages
+      messageId: packages
+      description: Status of Packages expected by Pieces
+      payload:
+        $ref: './schemas/packages.yaml#/$defs/packages'
+    buckets:
+      name: buckets
+      description: Buckets in Studio
+      payload:
+        $ref: './schemas/buckets.yaml#/$defs/buckets'

package/api/schemas/activePieces.yaml

@@ -0,0 +1,27 @@
+title: Active Pieces
+description: Active Pieces schema for websocket subscriptions
+$defs:
+  activePieces:
+    type: object
+    title: ActivePiecesEvent
+    properties:
+      event:
+        type: string
+        const: activePieces
+      rundownPlaylistId:
+        description: Unique id of the rundown playlist, or null if no playlist is active
+        oneOf:
+          - type: string
+          - type: 'null'
+      activePieces:
+        description: Pieces that are currently active (on air)
+        type: array
+        items:
+          $ref: './activePlaylist.yaml#/$defs/piece'
+    required: [event, rundownPlaylistId, activePieces]
+    additionalProperties: false
+    examples:
+      - event: activePieces
+        rundownPlaylistId: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+        activePieces:
+          - $ref: './activePlaylist.yaml#/$defs/piece/examples/0'

package/api/schemas/activePlaylist.yaml

@@ -0,0 +1,277 @@
+title: Active Playlist
+description: Active Playlist schema for websocket subscriptions
+$defs:
+  activePlaylist:
+    type: object
+    title: ActivePlaylistEvent
+    properties:
+      event:
+        type: string
+        const: activePlaylist
+      id:
+        description: Unique id of the active playlist
+        oneOf:
+          - type: string
+          - type: 'null'
+      name:
+        description: User-presentable name for the active playlist
+        type: string
+      rundownIds:
+        description: The set of rundownIds in the active playlist, in order
+        type: array
+        items:
+          type: string
+      currentPart:
+        description: The current Part - if empty, no part in the active playlist is live
+        $ref: '#/$defs/currentPart'
+      currentSegment:
+        description: The Segment of the current Part - if empty, no part in the active playlist is live
+        $ref: '#/$defs/currentSegment'
+      nextPart:
+        description: The next Part - if empty, no part will follow live part
+        $ref: '#/$defs/part'
+      publicData:
+        description: Optional arbitrary data
+      timing:
+        description: Timing information about the active playlist
+        type: object
+        title: ActivePlaylistTiming
+        properties:
+          timingMode:
+            description: 'Timing mode for the playlist.'
+            type: string
+            title: ActivePlaylistTimingMode
+            enum:
+              - none
+              - forward-time
+              - back-time
+          startedPlayback:
+            description: Unix timestamp of when the playlist started (milliseconds)
+            type: number
+          expectedStart:
+            description: Unix timestamp of when the playlist is expected to start (milliseconds). Required when the timingMode is set to forward-time.
+            type: number
+          expectedDurationMs:
+            description: Duration of the playlist in ms
+            type: number
+          expectedEnd:
+            description: Unix timestamp of when the playlist is expected to end (milliseconds) Required when the timingMode is set to back-time.
+            type: number
+        required: [timingMode]
+        additionalProperties: false
+      quickLoop:
+        description: Information about the current quickLoop, if any
+        type: object
+        title: ActivePlaylistQuickLoop
+        properties:
+          locked:
+            description: Whether the user is allowed to make alterations to the Start/End markers
+            type: boolean
+          running:
+            description: Whether the loop has two valid markers and is currently running
+            type: boolean
+          start:
+            description: The start of the loop
+            $ref: '#/$defs/quickLoopMarker'
+          end:
+            description: The end of the loop
+            $ref: '#/$defs/quickLoopMarker'
+        required: [locked, running]
+    required: [event, id, name, rundownIds, currentPart, currentSegment, nextPart, timing]
+    additionalProperties: false
+    examples:
+      - event: activePlaylist
+        id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+        name: 'Playlist 0'
+        rundownIds: ['y9HauyWkcxQS3XaAOsW40BRLLsI_']
+        currentPart:
+          $ref: '#/$defs/currentPart/examples/0'
+        currentSegment:
+          $ref: '#/$defs/currentSegment/examples/0'
+        nextPart:
+          $ref: '#/$defs/part/examples/0'
+        publicData:
+          category: 'Evening News'
+        timing:
+          timingMode: 'forward-time'
+          expectedStart: 1728895750727
+          expectedDurationMs: 180000
+  partBase:
+    type: object
+    title: PartStatus
+    properties:
+      id:
+        description: Unique id of the part
+        type: string
+      name:
+        description: User name of the part
+        type: string
+      segmentId:
+        description: Unique id of the segment this part belongs to
+        type: string
+      autoNext:
+        description: If this part will progress to the next automatically
+        type: boolean
+        default: false
+      pieces:
+        description: All pieces in this part
+        type: array
+        items:
+          $ref: '#/$defs/piece'
+      publicData:
+        description: Optional arbitrary data
+    required: [id, name, segmentId, pieces]
+    # additionalProperties: false
+    examples:
+      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        name: 'Intro'
+        segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
+        autoNext: false
+        pieces:
+          - $ref: '#/$defs/piece/examples/0'
+        publicData:
+          partType: 'intro'
+  part:
+    oneOf:
+      - $ref: '#/$defs/partBase'
+      - type: 'null'
+    examples:
+      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        name: 'Intro'
+        segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
+        autoNext: false
+        pieces:
+          - $ref: '#/$defs/piece/examples/0'
+  currentPart:
+    oneOf:
+      - title: CurrentPartStatus
+        allOf:
+          - $ref: '#/$defs/partBase'
+          - type: object
+            properties:
+              timing:
+                description: Timing information about the current part
+                type: object
+                title: CurrentPartTiming
+                properties:
+                  startTime:
+                    description: Unix timestamp of when the part started (milliseconds)
+                    type: number
+                  expectedDurationMs:
+                    description: Expected duration of the part (milliseconds)
+                    type: number
+                  projectedEndTime:
+                    description: Unix timestamp of when the part is projected to end (milliseconds). A sum of `startTime` and `expectedDurationMs`.
+                    type: number
+                required: [startTime, expectedDurationMs, projectedEndTime]
+            required: [timing]
+      - type: 'null'
+    examples:
+      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        name: 'Intro'
+        segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
+        autoNext: false
+        timing:
+          startTime: 1600000060000
+          expectedDurationMs: 15000
+          projectedEndTime: 1600000075000
+        pieces:
+          - $ref: '#/$defs/piece/examples/0'
+        publicData:
+          partType: 'intro'
+  currentSegment:
+    oneOf:
+      - type: object
+        title: CurrentSegment
+        properties:
+          id:
+            description: Unique id of the segment
+            type: string
+          timing:
+            description: Timing information about the current segment
+            type: object
+            title: CurrentSegmentTiming
+            properties:
+              expectedDurationMs:
+                description: Expected duration of the segment
+                type: number
+              budgetDurationMs:
+                description: Budget duration of the segment
+                type: number
+              projectedEndTime:
+                description: Unix timestamp of when the segment is projected to end (milliseconds). The time this segment started, offset by its budget duration, if the segment has a defined budget duration. Otherwise, the time the current part started, offset by the difference between expected durations of all parts in this segment and the as-played durations of the parts that already stopped.
+                type: number
+              countdownType:
+                description: 'Countdown type within the segment. Default: `part_expected_duration`'
+                type: string
+                title: SegmentCountdownType
+                enum:
+                  - part_expected_duration
+                  - segment_budget_duration
+            required: [expectedDurationMs, projectedEndTime]
+        required: [id, timing]
+        additionalProperties: false
+      - type: 'null'
+    examples:
+      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        timing:
+          expectedDurationMs: 15000
+          budgetDurationMs: 20000
+          projectedEndTime: 1600000075000
+          countdownType: segment_budget_duration
+  piece:
+    type: object
+    title: PieceStatus
+    properties:
+      id:
+        description: Unique id of the Piece
+        type: string
+      name:
+        description: User-facing name of the Piece
+        type: string
+      sourceLayer:
+        description: The source layer name for this Piece
+        type: string
+      outputLayer:
+        description: The output layer name for this Piece
+        type: string
+      tags:
+        description: Tags attached to this Piece
+        type: array
+        items:
+          type: string
+      publicData:
+        description: Optional arbitrary data
+    required: [id, name, sourceLayer, outputLayer]
+    additionalProperties: false
+    examples:
+      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        name: 'Camera 1'
+        sourceLayer: 'Camera'
+        outputLayer: 'PGM'
+        tags: ['camera']
+        publicData:
+          switcherSource: 1
+  quickLoopMarker:
+    type: object
+    title: QuickLoopMarker
+    properties:
+      markerType:
+        description: The type of entity the marker is locked to
+        title: QuickLoopMarkerType
+        type: string
+        enum:
+          - playlist
+          - rundown
+          - segment
+          - part
+      rundownId:
+        description: The rundown that this marker references. This will be set for rundown, segment and part markers
+        type: string
+      segmentId:
+        description: The segment that this marker references. This will be set for segment and part markers
+        type: string
+      partId:
+        description: The part that this marker references. This will be set for only part markers
+        type: string
+    required: [markerType]

package/api/schemas/adLibs.yaml

@@ -0,0 +1,116 @@
+title: AdLibs
+description: AdLibs schema for websocket subscriptions
+$defs:
+  adLibs:
+    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
+          - type: 'null'
+      adLibs:
+        description: The available AdLibs for this playlist
+        type: array
+        items:
+          $ref: '#/$defs/adLib'
+      globalAdLibs:
+        description: The available Global AdLibs for this playlist
+        type: array
+        items:
+          $ref: '#/$defs/globalAdLib'
+    required: [event, rundownPlaylistId, adLibs, globalAdLibs]
+    additionalProperties: false
+    examples:
+      - event: adLibs
+        rundownPlaylistId: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+        adLibs:
+          $ref: '#/$defs/adLib/examples'
+        globalAdLibs:
+          $ref: '#/$defs/adLibBase/examples'
+  adLib:
+    title: AdLibStatus
+    allOf:
+      - $ref: '#/$defs/adLibBase'
+      - type: object
+        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:
+      - id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+        name: Music video clip
+        sourceLayer: Video Clip
+        actionType:
+          - name: pvw
+            label: Preview
+        tags: ['music_video']
+        segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
+        partId: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        publicData:
+          fileName: MV000123.mxf
+  globalAdLib:
+    title: GlobalAdLibStatus
+    allOf:
+      - $ref: '#/$defs/adLibBase'
+  adLibBase:
+    type: object
+    title: AdLibBaseStatus
+    properties:
+      id:
+        description: Unique id of the AdLib
+        type: string
+      name:
+        description: The user defined AdLib name
+        type: string
+      sourceLayer:
+        description: The source layer name for this AdLib
+        type: string
+      outputLayer:
+        description: The output layer name for this AdLib
+        type: string
+      actionType:
+        description: The available action type names that can be used to modify the execution of the AdLib
+        type: array
+        items:
+          type: object
+          title: AdLibActionType
+          properties:
+            name:
+              description: The string to be passed to the ExecuteAdlib function
+              type: string
+            label:
+              description: The label for the AdLib type
+              type: string
+          required: [name, label]
+          additionalProperties: false
+      tags:
+        description: Tags attached to this AdLib
+        type: array
+        items:
+          type: string
+      publicData:
+        description: Optional arbitrary data
+      optionsSchema:
+        description: JSON schema definition of the adLib properties that can be modified using the adLibOptions property in executeAdLib
+        type: string
+    required: [id, name, sourceLayer, actionType]
+    examples:
+      - id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+        name: Music video clip
+        sourceLayer: Video Clip
+        actionType:
+          - name: pvw
+            label: Preview
+        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/schemas/buckets.yaml

@@ -0,0 +1,62 @@
+title: Buckets
+description: Buckets schema for websocket subscriptions
+$defs:
+  buckets:
+    type: object
+    title: BucketsEvent
+    properties:
+      event:
+        type: string
+        const: buckets
+      buckets:
+        description: Buckets available in the Studio
+        type: array
+        items:
+          $ref: '#/$defs/bucket'
+    required: [event, buckets]
+    additionalProperties: false
+    examples:
+      - event: buckets
+        buckets:
+          $ref: '#/$defs/bucket/examples'
+  bucket:
+    type: object
+    title: BucketStatus
+    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: '#/$defs/bucketAdlib'
+    examples:
+      - id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+        name: My Bucket
+        adLibs:
+          $ref: '#/$defs/bucketAdlib/examples'
+  bucketAdlib:
+    title: BucketAdLibStatus
+    allOf:
+      - $ref: './adLibs.yaml#/$defs/adLibBase'
+      - type: object
+        properties:
+          externalId:
+            type: string
+            description: Id of the adlib recognizable by the external source. Unique within a bucket.
+        required: [externalId]
+    examples:
+      - externalId: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+        id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+        name: Music video clip
+        sourceLayer: Video Clip
+        actionType:
+          - name: pvw
+            label: Preview
+        tags: ['music_video']
+        publicData:
+          fileName: MV000123.mxf