feat(LSG): add buckets topic

meteor/server/api/buckets.ts

@@ -1,6 +1,6 @@
 import * as _ from 'underscore'
 import { Meteor } from 'meteor/meteor'
-import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { Bucket } from '@sofie-automation/corelib/dist/dataModel/Bucket'
 import { getRandomId, getRandomString, literal } from '../lib/tempLib'
 import { BucketAdLib } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibPiece'
 import { AdLibAction, AdLibActionCommon } from '@sofie-automation/corelib/dist/dataModel/AdlibAction'

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

@@ -52,7 +52,7 @@
 	DEFAULT_MINIMUM_TAKE_SPAN,
 	DEFAULT_FALLBACK_PART_DURATION,
 } from '@sofie-automation/shared-lib/dist/core/constants'
-import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { Bucket } from '@sofie-automation/corelib/dist/dataModel/Bucket'
 import { ForceQuickLoopAutoNext } from '@sofie-automation/shared-lib/dist/core/model/StudioSettings'
 
 /*

meteor/server/api/userActions.ts

@@ -15,7 +15,7 @@ import { MOSDeviceActions } from './ingest/mosDevice/actions'
 import { MethodContextAPI } from './methodContext'
 import { ServerClientAPI } from './client'
 import { triggerWriteAccessBecauseNoCheckNecessary } from '../security/securityVerify'
-import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { Bucket } from '@sofie-automation/corelib/dist/dataModel/Bucket'
 import { BucketsAPI } from './buckets'
 import { BucketAdLib } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibPiece'
 import { AdLibActionCommon } from '@sofie-automation/corelib/dist/dataModel/AdlibAction'

meteor/server/collections/bucket.ts

@@ -1,7 +1,7 @@
 import { BucketAdLibAction } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibAction'
 import { BucketAdLib } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibPiece'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
-import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { Bucket } from '@sofie-automation/corelib/dist/dataModel/Bucket'
 import { createAsyncOnlyMongoCollection } from './collection'
 import { registerIndex } from './indices'
 

meteor/server/publications/buckets.ts

@@ -1,15 +1,17 @@
 import { FindOptions } from '@sofie-automation/meteor-lib/dist/collections/lib'
 import { meteorPublish } from './lib/lib'
-import { MeteorPubSub } from '@sofie-automation/meteor-lib/dist/api/pubsub'
-import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { Bucket } from '@sofie-automation/corelib/dist/dataModel/Bucket'
 import { BucketAdLibActions, BucketAdLibs, Buckets } from '../collections'
 import { check, Match } from 'meteor/check'
 import { StudioId, BucketId, ShowStyleVariantId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 import { triggerWriteAccessBecauseNoCheckNecessary } from '../security/securityVerify'
+import { MongoQuery } from '@sofie-automation/corelib/dist/mongo'
+import { BucketAdLib } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibPiece'
+import { BucketAdLibAction } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibAction'
 
 meteorPublish(
-	MeteorPubSub.buckets,
+	CorelibPubSub.buckets,
 	async function (studioId: StudioId, bucketId: BucketId | null, _token: string | undefined) {
 		check(studioId, String)
 		check(bucketId, Match.Maybe(String))
@@ -20,68 +22,61 @@
 			fields: {},
 		}
 
-		return Buckets.findWithCursor(
-			bucketId
-				? {
-						_id: bucketId,
-						studioId,
-				  }
-				: {
-						studioId,
-				  },
-			modifier
-		)
+		const selector: MongoQuery<Bucket> = {
+			studioId,
+		}
+		if (bucketId) selector._id = bucketId
+
+		return Buckets.findWithCursor(selector, modifier)
 	}
 )
 
 meteorPublish(
 	CorelibPubSub.bucketAdLibPieces,
-	async function (studioId: StudioId, bucketId: BucketId, showStyleVariantIds: ShowStyleVariantId[]) {
+	async function (studioId: StudioId, bucketId: BucketId | null, showStyleVariantIds: ShowStyleVariantId[]) {
 		check(studioId, String)
-		check(bucketId, String)
+		check(bucketId, Match.Maybe(String))
 		check(showStyleVariantIds, Array)
 
 		triggerWriteAccessBecauseNoCheckNecessary()
 
-		return BucketAdLibs.findWithCursor(
-			{
-				studioId: studioId,
-				bucketId: bucketId,
-				showStyleVariantId: {
-					$in: [null, ...showStyleVariantIds], // null = valid for all variants
-				},
+		const selector: MongoQuery<BucketAdLib> = {
+			studioId: studioId,
+			showStyleVariantId: {
+				$in: [null, ...showStyleVariantIds], // null = valid for all variants
+			},
+		}
+		if (bucketId) selector.bucketId = bucketId
+
+		return BucketAdLibs.findWithCursor(selector, {
+			fields: {
+				ingestInfo: 0, // This is a large blob, and is not of interest to the UI
 			},
-			{
-				fields: {
-					ingestInfo: 0, // This is a large blob, and is not of interest to the UI
-				},
-			}
-		)
+		})
 	}
 )
 
 meteorPublish(
 	CorelibPubSub.bucketAdLibActions,
-	async function (studioId: StudioId, bucketId: BucketId, showStyleVariantIds: ShowStyleVariantId[]) {
+	async function (studioId: StudioId, bucketId: BucketId | null, showStyleVariantIds: ShowStyleVariantId[]) {
 		check(studioId, String)
-		check(bucketId, String)
+		check(bucketId, Match.Maybe(String))
 		check(showStyleVariantIds, Array)
 
 		triggerWriteAccessBecauseNoCheckNecessary()
 
-		return BucketAdLibActions.findWithCursor(
-			{
-				studioId: studioId,
-				bucketId: bucketId,
-				showStyleVariantId: {
-					$in: [null, ...showStyleVariantIds], // null = valid for all variants
-				},
+		const selector: MongoQuery<BucketAdLibAction> = {
+			studioId: studioId,
+			showStyleVariantId: {
+				$in: [null, ...showStyleVariantIds], // null = valid for all variants
+			},
+		}
+		if (bucketId) selector.bucketId = bucketId
+
+		return BucketAdLibActions.findWithCursor(selector, {
+			fields: {
+				ingestInfo: 0, // This is a large blob, and is not of interest to the UI
 			},
-			{
-				fields: {
-					ingestInfo: 0, // This is a large blob, and is not of interest to the UI
-				},
-			}
-		)
+		})
 	}
 )

meteor/server/publications/pieceContentStatusUI/bucket/publication.ts

@@ -21,7 +21,7 @@
 	SetupObserversResult,
 } from '../../../lib/customPublication'
 import { BucketContentCache, createReactiveContentCache } from './bucketContentCache'
-import { Bucket } from '@sofie-automation/meteor-lib/dist/collections/Buckets'
+import { Bucket } from '@sofie-automation/corelib/dist/dataModel/Bucket'
 import {
 	addItemsWithDependenciesChangesToChangedSet,
 	fetchStudio,

packages/meteor-lib/src/collections/Buckets.ts → packages/corelib/src/dataModel/Bucket.ts

@@ -1,4 +1,4 @@
-import { BucketId, StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { BucketId, StudioId } from './Ids'
 
 /**
  * A Bucket is an container for AdLib pieces that do not come from a MOS gateway and are

packages/corelib/src/pubsub.ts

@@ -37,6 +37,7 @@ import {
 } from '@sofie-automation/shared-lib/dist/core/model/Ids'
 import { BlueprintId, BucketId, RundownPlaylistActivationId, SegmentId, ShowStyleVariantId } from './dataModel/Ids'
 import { PackageInfoDB } from './dataModel/PackageInfos'
+import { Bucket } from './dataModel/Bucket'
 
 /**
  * Ids of possible DDP subscriptions for any the UI and gateways accessing the Rundown & RundownPlaylist model.
@@ -135,12 +136,16 @@ export enum CorelibPubSub {
 	packageContainerStatuses = 'packageContainerStatuses',
 
 	/**
-	 * Fetch all bucket adlib pieces for the specified Studio and Bucket.
+	 * Fetch either all buckets for the given Studio, or the Bucket specified.
+	 */
+	buckets = 'buckets',
+	/**
+	 * Fetch all bucket adlib pieces for the specified Studio and Bucket (or all buckets in a Studio).
 	 * The result will be limited to ones valid to the ShowStyleVariants specified, as well as ones marked as valid in any ShowStyleVariant
 	 */
 	bucketAdLibPieces = 'bucketAdLibPieces',
 	/**
-	 * Fetch all bucket adlib action for the specified Studio and Bucket.
+	 * Fetch all bucket adlib action for the specified Studio and Bucket (or all buckets in a Studio).
 	 * The result will be limited to ones valid to the ShowStyleVariants specified, as well as ones marked as valid in any ShowStyleVariant
 	 */
 	bucketAdLibActions = 'bucketAdLibActions',
@@ -297,14 +302,15 @@ export interface CorelibPubSubTypes {
 		token?: string
 	) => CollectionName.Studios
 	[CorelibPubSub.timelineDatastore]: (studioId: StudioId, token?: string) => CollectionName.TimelineDatastore
+	[CorelibPubSub.buckets]: (studioId: StudioId, bucketId: BucketId | null, token?: string) => CollectionName.Buckets
 	[CorelibPubSub.bucketAdLibPieces]: (
 		studioId: StudioId,
-		bucketId: BucketId,
+		bucketId: BucketId | null,
 		showStyleVariantIds: ShowStyleVariantId[]
 	) => CollectionName.BucketAdLibPieces
 	[CorelibPubSub.bucketAdLibActions]: (
 		studioId: StudioId,
-		bucketId: BucketId,
+		bucketId: BucketId | null,
 		showStyleVariantIds: ShowStyleVariantId[]
 	) => CollectionName.BucketAdLibActions
 	[CorelibPubSub.expectedPackages]: (studioIds: StudioId[], token?: string) => CollectionName.ExpectedPackages
@@ -323,6 +329,7 @@ export type CorelibPubSubCollections = {
 	[CollectionName.AdLibActions]: AdLibAction
 	[CollectionName.AdLibPieces]: AdLibPiece
 	[CollectionName.Blueprints]: Blueprint
+	[CollectionName.Buckets]: Bucket
 	[CollectionName.BucketAdLibActions]: BucketAdLibAction
 	[CollectionName.BucketAdLibPieces]: BucketAdLib
 	[CollectionName.ExpectedMediaItems]: ExpectedMediaItem

packages/documentation/docs/for-developers/data-model.md

@@ -24,7 +24,7 @@ Currently, there is not a very clearly defined flow for modifying these document
 This includes:
 
 - [Blueprints](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/Blueprint.ts)
-- [Buckets](https://github.com/nrkno/sofie-core/blob/master/meteor/lib/collections/Buckets.ts)
+- [Buckets](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/Bucket.ts)
 - [CoreSystem](https://github.com/nrkno/sofie-core/blob/master/meteor/lib/collections/CoreSystem.ts)
 - [Evaluations](https://github.com/nrkno/sofie-core/blob/master/meteor/lib/collections/Evaluations.ts)
 - [ExternalMessageQueue](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/ExternalMessageQueue.ts)

packages/documentation/versioned_docs/version-1.50.0/for-developers/data-model.md

@@ -24,7 +24,7 @@ Currently, there is not a very clearly defined flow for modifying these document
 This includes:
 
 - [Blueprints](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/Blueprint.ts)
-- [Buckets](https://github.com/nrkno/sofie-core/blob/master/meteor/lib/collections/Buckets.ts)
+- [Buckets](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/Bucket.ts)
 - [CoreSystem](https://github.com/nrkno/sofie-core/blob/master/meteor/lib/collections/CoreSystem.ts)
 - [Evaluations](https://github.com/nrkno/sofie-core/blob/master/meteor/lib/collections/Evaluations.ts)
 - [ExternalMessageQueue](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/ExternalMessageQueue.ts)

packages/live-status-gateway/api/asyncapi.yaml

@@ -48,6 +48,7 @@ channels:
           - $ref: '#/components/messages/activePieces'
           - $ref: '#/components/messages/segments'
           - $ref: '#/components/messages/adLibs'
+          - $ref: '#/components/messages/buckets'
 components:
   messages:
     ping:
@@ -124,3 +125,8 @@ components:
       description: AdLibs in active Playlist
       payload:
         $ref: './schemas/adLibs.yaml#/$defs/adLibs'
+    buckets:
+      name: buckets
+      description: Buckets in Studio
+      payload:
+        $ref: './schemas/buckets.yaml#/$defs/buckets'

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

@@ -0,0 +1,39 @@
+title: Buckets
+description: Buckets schema for websocket subscriptions
+$defs:
+  buckets:
+    type: object
+    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
+    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.yaml#/$defs/adLib'
+    examples:
+      - id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+        name: My Bucket
+        adLibs:
+          $ref: './adLibs.yaml#/$defs/adLib/examples'