@livepreso/api 6.44.0 → 6.46.0

package/src/presentation/base-presentation-model.spec.js

@@ -1,4 +1,5 @@
 import { BasePresentationModel } from "./base-presentation-model.js";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
 
 describe("#getVisibilityAndSequence", () => {
 	it("should return model defaults when no options", () => {
@@ -49,7 +50,7 @@ describe("#getVisibilityAndSequence", () => {
 			},
 			{
 				choicelist,
-			}
+			},
 		);
 
 		const expected = {
@@ -79,7 +80,7 @@ describe("#getVisibilityAndSequence", () => {
 			},
 			{
 				selections,
-			}
+			},
 		);
 
 		const expected = {
@@ -121,7 +122,7 @@ describe("#getVisibilityAndSequence", () => {
 			{
 				choicelist,
 				selections,
-			}
+			},
 		);
 
 		const expected = {
@@ -227,3 +228,79 @@ describe("#getTags", () => {
 		expect(tags).toEqual(["adjunctslide-tags"]);
 	});
 });
+
+describe("#filterScreenshotsByTeam", () => {
+	const screenshots = new DeckVersionScreenshotCollection([
+		{
+			subject: "/api/slides/1/",
+			image_256: "global-screenshot-1.png",
+			team: null,
+		},
+		{
+			subject: "/api/slides/2/",
+			image_256: "global-screenshot-2.png",
+			team: null,
+		},
+		{
+			subject: "/api/slides/1/",
+			image_256: "team-1-screenshot.png",
+			team: "/api/teams/1/",
+		},
+		{
+			subject: "/api/sections/2/",
+			image_256: "team-1-screenshot.png",
+			team: "/api/teams/1/",
+		},
+		// Just for testing that the team filters don't get cross-contaminated
+		{
+			subject: "/api/sections/2/",
+			image_256: "team-2-screenshot.png",
+			team: "/api/teams/2/",
+		},
+	]);
+
+	it("should just return global screenshots if team is null", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+			screenshots,
+			null,
+		).toJSON();
+
+		expect(filtered).toEqual([
+			{
+				subject: "/api/slides/1/",
+				image_256: "global-screenshot-1.png",
+				team: null,
+			},
+			{
+				subject: "/api/slides/2/",
+				image_256: "global-screenshot-2.png",
+				team: null,
+			},
+		]);
+	});
+
+	it("should return globals with team override", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+			screenshots,
+			1,
+		).toJSON();
+
+		expect(filtered).toEqual([
+			{
+				image_256: "global-screenshot-2.png",
+				subject: "/api/slides/2/",
+				team: null,
+			},
+			{
+				image_256: "team-1-screenshot.png",
+				subject: "/api/sections/2/",
+				team: "/api/teams/1/",
+			},
+			{
+				image_256: "team-1-screenshot.png",
+				subject: "/api/slides/1/",
+				team: "/api/teams/1/",
+			},
+		]);
+	});
+});

package/src/presentation/presentation-deck.js

@@ -41,6 +41,7 @@ export const PresentationDeck = BasePresentationModel.extend(
 		 * @property {boolean} editable
 		 * @property {array} tags
 		 * @property {number} version
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			html: "string",
@@ -49,7 +50,10 @@ export const PresentationDeck = BasePresentationModel.extend(
 			deckID: "number",
 			index: "number",
 			thumbnail: "string",
-			visible: "boolean",
+			visible: {
+				type: "boolean",
+				visible: true,
+			},
 			key: "string",
 			common: "object",
 			title: "string",
@@ -57,6 +61,7 @@ export const PresentationDeck = BasePresentationModel.extend(
 			editable: "boolean",
 			tags: "array",
 			version: "number",
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -91,7 +96,7 @@ export const PresentationDeck = BasePresentationModel.extend(
 
 			return this._url;
 		},
-	}
+	},
 );
 
 /**
@@ -105,20 +110,24 @@ export const PresentationDeck = BasePresentationModel.extend(
  */
 PresentationDeck.createFromDeckVersion = function (
 	deckVersionModel,
-	options = {}
+	options = {},
 ) {
 	_.defaults(options, {
 		index: 0,
+		autoAdjuncts: new collections.AutoAdjunctCollection(),
 		adjunctSections: new collections.AdjunctSectionCollection(),
 		adjunctSlides: new collections.AdjunctSlideCollection(),
 		adjunctSubSlides: new collections.AdjunctSubSlideCollection(),
 		sectionSelections: new collections.SectionSelectionCollection(),
 		slideSelections: new collections.SlideSelectionCollection(),
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 		rootAssetPath: null,
 		templates: null,
 		choicelist: null,
 	});
 
+	options.screenshots = PresentationDeck.screenshotsToMap(options.screenshots);
+
 	const assetRoot = getAssetRoot(deckVersionModel.index_asset.url());
 	let html;
 	let css;
@@ -138,7 +147,10 @@ PresentationDeck.createFromDeckVersion = function (
 		css,
 		id: deckVersionModel.id,
 		index: options.index,
-		thumbnail: deckVersionModel.image_256,
+		thumbnail: PresentationDeck.getThumbnail(
+			deckVersionModel,
+			options.screenshots,
+		),
 		deckID: deckVersionModel.deck.id,
 		visible: true,
 		key: deckVersionModel.deck.key,
@@ -148,12 +160,13 @@ PresentationDeck.createFromDeckVersion = function (
 		tags,
 		version: deckVersionModel.version,
 		usesImpostorSections: isImpostorDeck(deckVersionModel),
+		cmsvalkey_set: deckVersionModel.cmsvalkey_set || [],
 	});
 
 	if (!deck.key) {
 		log.warn(
 			"Deck key not available to presentation",
-			deckVersionModel.deck.toJSON()
+			deckVersionModel.deck.toJSON(),
 		);
 	}
 
@@ -178,7 +191,7 @@ PresentationDeck.createFromDeckVersion = function (
 					url: selection.slide.url(),
 					id: selection.id,
 				};
-			})
+			}),
 		);
 
 	// We want all adjuncts to have fake ids that can't possibly overlap with the ids of
@@ -206,7 +219,7 @@ PresentationDeck.createFromDeckVersion = function (
 		deckVersionModel.section_set.forEach((sectionModel) => {
 			const section = PresentationSection.createFromSection(
 				sectionModel,
-				options
+				options,
 			);
 
 			section.addSlides(sectionModel.slide_set, options);
@@ -223,7 +236,7 @@ PresentationDeck.createFromDeckVersion = function (
 			const section = PresentationSection.createFromAdjunctSection(
 				adjunctSection,
 				DeckVersionModel,
-				options
+				options,
 			);
 
 			deck.sections.add(section);
@@ -256,7 +269,7 @@ PresentationDeck.createFromDeckVersion = function (
 				const section = PresentationSection.createFromImpostorSection(
 					slideModel,
 					DeckVersionModel,
-					options
+					options,
 				);
 
 				deck.sections.add(section);
@@ -273,7 +286,7 @@ PresentationDeck.createFromDeckVersion = function (
 				const slide = PresentationSlide.createFromAdjunctSlide(
 					adjunctSlideModel,
 					null,
-					options
+					options,
 				);
 
 				slides.push(slide);
@@ -289,7 +302,7 @@ PresentationDeck.createFromDeckVersion = function (
 		// next section.
 		deck.sections.models.reverse().forEach((section) => {
 			const sectionSlides = slides.filter(
-				(slide) => slide.sequence > section.sequence
+				(slide) => slide.sequence > section.sequence,
 			);
 
 			section.slides.add(sectionSlides);
@@ -329,7 +342,7 @@ PresentationDeck.createFromDeckVersion = function (
 				const adjunctSection = PresentationSection.createFromAdjunctSection(
 					adjunctSlideModel,
 					DeckVersionModel,
-					options
+					options,
 				);
 
 				deck.sections.add(adjunctSection);
@@ -342,13 +355,41 @@ PresentationDeck.createFromDeckVersion = function (
 			options.templates.map((template, index) => {
 				return PresentationSection.createFromTemplate(
 					template,
-					index,
-					options.getUniqueAdjunctID()
+					deck.sections.length + index,
+					options.getUniqueAdjunctID(),
 				);
-			})
+			}),
 		);
 	}
 
+	// This is generally only used by screenshots
+	if (options.autoAdjuncts) {
+		const autoSections = options.autoAdjuncts.map((auto, index) => {
+			// We already have the template on the deckversion, so we can find it here.
+			if (!auto.template) {
+				throw new Error(
+					"Attempted to use an autoadjunct that has no template.",
+				);
+			}
+
+			const section = PresentationSection.createFromTemplate(
+				auto.template,
+				deck.sections.length + index,
+				options.getUniqueAdjunctID(),
+			);
+
+			// We've just borrowed the "from template" method above. We want to add
+			// back some of the specific keys about the auto.
+			section.autoAdjunctID = auto.id;
+			section.key = auto.key;
+			section.title = auto.name;
+
+			return section;
+		});
+
+		deck.sections.add(autoSections);
+	}
+
 	setSequentialSequences(deck);
 
 	return deck;
@@ -368,11 +409,12 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 		title: "Local",
 		version: 1,
 		tags: manifestJSON.tags[""] || [],
+		cmsvalkey_set: [],
 	});
 
 	const usesImpostorSections = _.some(
 		manifestJSON.tags,
-		(tags) => tags.indexOf("section-header") !== -1
+		(tags) => tags.indexOf("section-header") !== -1,
 	);
 	deck.usesImpostorSections = usesImpostorSections;
 
@@ -391,13 +433,14 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 				css: url2.resolve(manifestJSON.getAssetPath(key), "slide.css"),
 				title: manifestJSON.titles[key],
 				tags: manifestJSON.tags[key] || [],
+				cmsvalkey_set: [],
 			};
 		});
 
 		items = _.sortBy(items, "sequence");
 
 		const sections = items.filter(
-			(item) => item.tags.indexOf("section-header") !== -1
+			(item) => item.tags.indexOf("section-header") !== -1,
 		);
 
 		sections.forEach((item, index) => {
@@ -414,7 +457,7 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 		deck.sections.add(
 			sections.map((section, index) => {
 				return PresentationSection.createFromManifestImpostor(section, index);
-			})
+			}),
 		);
 
 		deck.realSection = PresentationSection.createFromManifestImpostor(items[0]);
@@ -428,9 +471,9 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 				return PresentationSection.createFromManifestJSON(
 					manifestJSON,
 					key,
-					index
+					index,
 				);
-			})
+			}),
 		);
 	}
 
@@ -443,7 +486,7 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 				index_asset: {
 					url: url2.resolve(
 						manifestJSON.getTemplateAssetPath(key),
-						"index.html"
+						"index.html",
 					),
 				},
 			};
@@ -454,7 +497,7 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 		deck.sections.add(
 			templates.map((template, index) => {
 				return PresentationSection.createFromTemplate(template, index, minID);
-			})
+			}),
 		);
 	}
 

package/src/presentation/presentation-deck.spec.js

@@ -1,4 +1,5 @@
 import { DeckVersionModel } from "../models/deck-version";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
 import { G } from "sp-test/api";
 import { ManifestJSONModel } from "../models/manifest-json";
 import { PresentationDeck } from "./presentation-deck";
@@ -57,6 +58,7 @@ describe("#createFromManifestJSON", () => {
 
 describe("#createFromDeckVersion", () => {
 	const deckVersionJSON = {
+		image_256: "http://path/to/deck/thumbnail.png",
 		template_set: [
 			{
 				id: 20,
@@ -87,6 +89,7 @@ describe("#createFromDeckVersion", () => {
 			{
 				id: 1,
 				title: "Section 1",
+				image_256: "default_section.png",
 				index_asset: {
 					url: "http://path/to/index.html",
 				},
@@ -99,6 +102,7 @@ describe("#createFromDeckVersion", () => {
 						index_asset: {
 							url: "http://path/to/index.html",
 						},
+						image_256: "default_slide.png",
 						subslide_set: [],
 						section: { id: 1 },
 					},
@@ -107,6 +111,7 @@ describe("#createFromDeckVersion", () => {
 			{
 				id: 2,
 				title: "Section 2",
+				image_256: "default_section.png",
 				index_asset: {
 					url: "http://path/to/index.html",
 				},
@@ -117,6 +122,7 @@ describe("#createFromDeckVersion", () => {
 			{
 				id: 3,
 				title: "Section 3",
+				image_256: "default_section.png",
 				index_asset: {
 					url: "http://path/to/index.html",
 				},
@@ -135,7 +141,7 @@ describe("#createFromDeckVersion", () => {
 		expect(deck.sections.length).toEqual(3);
 		expect(deck.sections.at(0).title).toEqual("Section 1");
 		expect(deck.sections.at(deck.sections.length - 1).title).toEqual(
-			"Section 3"
+			"Section 3",
 		);
 	});
 
@@ -154,8 +160,55 @@ describe("#createFromDeckVersion", () => {
 		expect(lastSection.title).toEqual("Orange");
 		expect(lastSection.key).toEqual("template-orange");
 		expect(lastSection.html).toEqual(
-			"http://path/to/template/orange/index.html"
+			"http://path/to/template/orange/index.html",
 		);
 		expect(lastSection.css).toEqual("http://path/to/template/orange/slide.css");
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the slide if no screenshot found", () => {
+			const deck = new DeckVersionModel(deckVersionJSON);
+			const presentationDeck = PresentationDeck.createFromDeckVersion(deck);
+			expect(presentationDeck.thumbnail).toEqual(deckVersionJSON.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const deck = new DeckVersionModel(deckVersionJSON);
+			const options = {
+				screenshots: new DeckVersionScreenshotCollection([
+					{ subject: deck.url(), image_256: "test-screenshot.png" },
+				]),
+			};
+
+			const presentationDeck = PresentationDeck.createFromDeckVersion(
+				deck,
+				options,
+			);
+			expect(presentationDeck.thumbnail).toEqual("test-screenshot.png");
+		});
+
+		it("should pass screenshots to nested models", () => {
+			const deck = new DeckVersionModel(deckVersionJSON);
+			const section = deck.section_set.first();
+			const slide = section.slide_set.first();
+
+			const options = {
+				screenshots: new DeckVersionScreenshotCollection([
+					{ subject: deck.url(), image_256: "test-screenshot.png" },
+					{ subject: section.url(), image_256: "test-screenshot.png" },
+					{ subject: slide.url(), image_256: "test-screenshot.png" },
+				]),
+			};
+
+			const presentationDeck = PresentationDeck.createFromDeckVersion(
+				deck,
+				options,
+			);
+			const presentationSection = presentationDeck.sections.first();
+			const presentationSlide = presentationSection.slides.first();
+
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+			expect(presentationSlide.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });

package/src/presentation/presentation-decks.js

@@ -13,7 +13,7 @@ export const PresentationDeckCollection = BasePresentationCollection.extend(
 	/** @lends presentation.PresentationDeckCollection# */ {
 		comparator: "sequence",
 		model: "PresentationDeck",
-	}
+	},
 );
 
 register("PresentationDeckCollection", PresentationDeckCollection);