@livepreso/api 6.42.1 → 6.45.0

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",
 				},
@@ -158,4 +164,51 @@ describe("#createFromDeckVersion", () => {
 		);
 		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-section.js

@@ -1,5 +1,7 @@
 import "./presentation-slides.js";
 
+import * as collections from "../collections.js";
+
 import {
 	AdjunctSectionModel,
 	AdjunctSlideModel,
@@ -50,6 +52,7 @@ export const PresentationSection = BasePresentationModel.extend(
 		 * @property {array} tags
 		 * @property {boolean} impostor
 		 * @property {boolean} isWelcome
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			id: "number",
@@ -95,6 +98,7 @@ export const PresentationSection = BasePresentationModel.extend(
 				type: "boolean",
 				default: () => false,
 			},
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -169,6 +173,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 		rootAssetPath: null,
 		selections: null,
 		choicelist: null,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
 	let html;
@@ -201,17 +206,21 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 		css,
 		key: sectionModel.key,
 		adjunctSlideLimit: sectionModel.adjunctslide_limit,
-		thumbnail: sectionModel.image_256,
+		thumbnail: PresentationSection.getThumbnail(
+			sectionModel,
+			options.screenshots
+		),
 		custom: false,
 		impostor: false,
 		title: sectionModel.title,
 		deckversion: sectionModel.deckversion.id,
-		editable: sectionModel.tags.indexOf("editable") > -1,
+		editable: tags.indexOf("editable") > -1,
 		tags,
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
 		selectionID: config.selectionID,
+		cmsvalkey_set: sectionModel.cmsvalkey_set,
 	});
 
 	return section;
@@ -228,7 +237,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 PresentationSection.createFromAdjunctSection = function (
 	adjunctSectionModel,
 	deckVersionModel,
-	options
+	options = {}
 ) {
 	_.defaults(options, {
 		rootAssetPath: null,
@@ -237,6 +246,7 @@ PresentationSection.createFromAdjunctSection = function (
 		getUniqueAdjunctID: () => {
 			return parseInt(_.uniqueId(), 10);
 		},
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
 	const keyID =
@@ -251,6 +261,7 @@ PresentationSection.createFromAdjunctSection = function (
 		key = adjunctSectionModel.key;
 	} else if (keyID) {
 		key = `adjunct-${keyID}`;
+		adjunctSectionModel.key = key;
 	}
 
 	const config = PresentationSection.getVisibilityAndSequence(
@@ -258,6 +269,8 @@ PresentationSection.createFromAdjunctSection = function (
 		options
 	);
 
+	const tags = PresentationSection.getTags(adjunctSectionModel, options);
+
 	const section = new PresentationSection({
 		id: options.getUniqueAdjunctID(),
 		adjunct: adjunctSectionModel.adjunct
@@ -272,10 +285,8 @@ PresentationSection.createFromAdjunctSection = function (
 		custom: !adjunctSectionModel.created_by_autoadjunct,
 		createdByAutoAdjunct: adjunctSectionModel.created_by_autoadjunct,
 		createdByTemplate: Boolean(adjunctSectionModel.template),
-		impostor:
-			adjunctSectionModel.tags &&
-			adjunctSectionModel.tags.indexOf("section-header") > -1,
-		tags: adjunctSectionModel.tags,
+		impostor: tags.indexOf("section-header") > -1,
+		tags: tags,
 		temporary: adjunctSectionModel.created_by_autoadjunct,
 		title: adjunctSectionModel.title,
 		deckversion: deckVersionModel.id,
@@ -283,6 +294,7 @@ PresentationSection.createFromAdjunctSection = function (
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
+		cmsvalkey_set: [],
 	});
 
 	if (adjunctSectionModel.template) {
@@ -307,7 +319,13 @@ PresentationSection.createFromAdjunctSection = function (
 		}
 		section.html = html;
 		section.css = css;
-		section.thumbnail = adjunctSectionModel.template.image_256;
+		section.thumbnail =
+			// Try and use autoadjunct screenshot (if there is one), otherwise
+			// use the template's image as a fallback
+			PresentationSection.getThumbnail(
+				adjunctSectionModel.creator_autoadjunct,
+				options.screenshots
+			) || adjunctSectionModel.template.image_256;
 	} else {
 		section.image = adjunctSectionModel.image_original;
 	}
@@ -318,12 +336,13 @@ PresentationSection.createFromAdjunctSection = function (
 PresentationSection.createFromImpostorSection = function (
 	slideModel,
 	DeckVersionModel,
-	options
+	options = {}
 ) {
 	_.defaults(options, {
 		rootAssetPath: null,
 		selections: null,
 		choicelist: null,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
 	let html;
@@ -358,17 +377,21 @@ PresentationSection.createFromImpostorSection = function (
 		css,
 		key: slideModel.key,
 		adjunctSlideLimit: slideModel.adjunctslide_limit,
-		thumbnail: slideModel.image_256,
+		thumbnail: PresentationSection.getThumbnail(
+			slideModel,
+			options.screenshots
+		),
 		custom: false,
 		impostor: true,
 		title: slideModel.title,
 		deckversion: slideModel.section.deckversion.id,
-		editable: slideModel.tags.indexOf("editable") > -1,
+		editable: tags.indexOf("editable") > -1,
 		tags,
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
 		selectionID: config.selectionID,
+		cmsvalkey_set: slideModel.cmsvalkey_set,
 	});
 
 	return section;
@@ -392,6 +415,7 @@ PresentationSection.createFromManifestJSON = function (
 		visible: true,
 		deckversion: 1,
 		tags: manifestJSON.tags[sectionKey] || null,
+		cmsvalkey_set: [],
 	});
 
 	const slideKeys = Object.keys(manifestJSON.titles).filter((slideKey) => {
@@ -439,7 +463,7 @@ PresentationSection.createFromManifestImpostor = function (section, index) {
 	return presentationSection;
 };
 
-PresentationSection.createFromAutoAdjunct = function (model, opts) {
+PresentationSection.createFromAutoAdjunct = function (model, opts = {}) {
 	const requiredKeys = ["index", "deckversionID"];
 	for (const key of requiredKeys) {
 		if (typeof opts[key] === "undefined") {
@@ -454,8 +478,18 @@ PresentationSection.createFromAutoAdjunct = function (model, opts) {
 		deckversionID: -1,
 		sequence: opts.index,
 		impostor: false,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	const tags = PresentationSection.getTags(
+		{
+			isAutoAdjunct: true,
+			key: model.key,
+			tags: model.tags,
+		},
+		options
+	);
+
 	const autoAdjunct = new AutoAdjunctModel(model);
 
 	const autoAdjunctSection = new PresentationSection({
@@ -470,17 +504,25 @@ PresentationSection.createFromAutoAdjunct = function (model, opts) {
 		index: options.index,
 		key: autoAdjunct.key,
 		createdByAutoAdjunct: false,
-		thumbnail: autoAdjunct.image_256,
+		thumbnail: PresentationSection.getThumbnail(
+			autoAdjunct,
+			options.screenshots
+		),
 		temporary: true,
 		title: autoAdjunct.name,
 		visible: options.visible,
 		allowConvert: options.allowConvert,
 		deckversion: options.deckversionID,
 		impostor: options.impostor,
+		tags,
+		cmsvalkey_set: autoAdjunct.cmsvalkey_set,
 	});
 
 	if (autoAdjunct.template) {
-		autoAdjunctSection.thumbnail = autoAdjunct.template.image_256;
+		// If we've found a new screenshot for it, we don't want to override it here
+		if (!autoAdjunctSection.thumbnail) {
+			autoAdjunctSection.thumbnail = autoAdjunct.template.image_256;
+		}
 		autoAdjunctSection.createdByTemplate = true;
 		autoAdjunctSection.templateID = autoAdjunct.template.id;
 		autoAdjunctSection.html = autoAdjunct.template.index_asset.url();
@@ -514,6 +556,7 @@ PresentationSection.createFromTemplate = function (template, index, minID = 0) {
 		sequence: 9000 + templateModel.sequence,
 		createdByTemplate: true,
 		index,
+		cmsvalkey_set: [],
 	});
 
 	return presentationSection;