@livepreso/api 6.44.0 → 6.46.0

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",
@@ -93,8 +96,9 @@ export const PresentationSection = BasePresentationModel.extend(
 			impostor: "boolean",
 			isWelcome: {
 				type: "boolean",
-				default: () => false,
+				default: false,
 			},
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -102,6 +106,7 @@ export const PresentationSection = BasePresentationModel.extend(
 		 */
 		children: {
 			adjunct: "AdjunctModel",
+			template: "TemplateModel",
 		},
 
 		/**
@@ -131,12 +136,12 @@ export const PresentationSection = BasePresentationModel.extend(
 						return PresentationSlide.createFromAdjunctSlide(
 							slide,
 							this,
-							options
+							options,
 						);
 					}
 
 					return PresentationSlide.createFromSlide(slide, options);
-				})
+				}),
 			);
 		},
 
@@ -154,7 +159,7 @@ export const PresentationSection = BasePresentationModel.extend(
 			}
 			return this._url;
 		},
-	}
+	},
 );
 
 /**
@@ -169,8 +174,13 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 		rootAssetPath: null,
 		selections: null,
 		choicelist: null,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	options.screenshots = PresentationSection.screenshotsToMap(
+		options.screenshots,
+	);
+
 	let html;
 	let css;
 
@@ -189,7 +199,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 
 	const config = PresentationSection.getVisibilityAndSequence(
 		sectionModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSection.getTags(sectionModel, options);
@@ -201,7 +211,10 @@ 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,
@@ -212,6 +225,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 		sequence: config.sequence,
 		visible: config.visible,
 		selectionID: config.selectionID,
+		cmsvalkey_set: sectionModel.cmsvalkey_set,
 	});
 
 	return section;
@@ -228,7 +242,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 PresentationSection.createFromAdjunctSection = function (
 	adjunctSectionModel,
 	deckVersionModel,
-	options = {}
+	options = {},
 ) {
 	_.defaults(options, {
 		rootAssetPath: null,
@@ -237,8 +251,13 @@ PresentationSection.createFromAdjunctSection = function (
 		getUniqueAdjunctID: () => {
 			return parseInt(_.uniqueId(), 10);
 		},
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	options.screenshots = PresentationSection.screenshotsToMap(
+		options.screenshots,
+	);
+
 	const keyID =
 		adjunctSectionModel.id ||
 		(adjunctSectionModel.creator_autoadjunct
@@ -256,20 +275,17 @@ PresentationSection.createFromAdjunctSection = function (
 
 	const config = PresentationSection.getVisibilityAndSequence(
 		adjunctSectionModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSection.getTags(adjunctSectionModel, options);
+	const autoAdjunctID = adjunctSectionModel.creator_autoadjunct?.id || null;
 
 	const section = new PresentationSection({
 		id: options.getUniqueAdjunctID(),
-		adjunct: adjunctSectionModel.adjunct
-			? adjunctSectionModel.adjunct.url()
-			: null,
+		adjunct: adjunctSectionModel.adjunct,
 		adjunctID: adjunctSectionModel.id,
-		autoAdjunctID: adjunctSectionModel.creator_autoadjunct
-			? adjunctSectionModel.creator_autoadjunct.id
-			: null,
+		autoAdjunctID,
 		key,
 		thumbnail: adjunctSectionModel.image_256,
 		custom: !adjunctSectionModel.created_by_autoadjunct,
@@ -284,12 +300,15 @@ PresentationSection.createFromAdjunctSection = function (
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
+		cmsvalkey_set: adjunctSectionModel.template?.cmsvalkey_set || [],
+		templateID: adjunctSectionModel.template?.id || null,
+		template: adjunctSectionModel.template || null,
 	});
 
 	if (adjunctSectionModel.template) {
 		if (!adjunctSectionModel.template.index_asset) {
 			throw new Error(
-				"Template missing index_asset. Do you have the whole template available?"
+				"Template missing index_asset. Do you have the whole template available?",
 			);
 		}
 		const origPath = adjunctSectionModel.template.index_asset.orig_path;
@@ -301,14 +320,20 @@ PresentationSection.createFromAdjunctSection = function (
 			css = `${options.rootAssetPath}${origPath}/slide.css`;
 		} else {
 			const assetRoot = getAssetRoot(
-				adjunctSectionModel.template.index_asset.url()
+				adjunctSectionModel.template.index_asset.url(),
 			);
 			html = `${assetRoot}index.html`;
 			css = `${assetRoot}slide.css`;
 		}
 		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;
 	}
@@ -319,14 +344,19 @@ PresentationSection.createFromAdjunctSection = function (
 PresentationSection.createFromImpostorSection = function (
 	slideModel,
 	DeckVersionModel,
-	options = {}
+	options = {},
 ) {
 	_.defaults(options, {
 		rootAssetPath: null,
 		selections: null,
 		choicelist: null,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	options.screenshots = PresentationSection.screenshotsToMap(
+		options.screenshots,
+	);
+
 	let html;
 	let css;
 
@@ -334,7 +364,7 @@ PresentationSection.createFromImpostorSection = function (
 
 	if (options.rootAssetPath) {
 		const baseRoot = getAssetRoot(
-			slideModel.section.deckversion.index_asset.url()
+			slideModel.section.deckversion.index_asset.url(),
 		);
 		const sectionPath = assetRoot.slice(baseRoot.length);
 
@@ -347,11 +377,10 @@ PresentationSection.createFromImpostorSection = function (
 
 	const config = PresentationSection.getVisibilityAndSequence(
 		slideModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSection.getTags(slideModel, options);
-
 	const section = new PresentationSection({
 		id: slideModel.id,
 		adjunctID: null,
@@ -359,7 +388,10 @@ 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,
@@ -370,6 +402,7 @@ PresentationSection.createFromImpostorSection = function (
 		sequence: config.sequence,
 		visible: config.visible,
 		selectionID: config.selectionID,
+		cmsvalkey_set: slideModel.cmsvalkey_set,
 	});
 
 	return section;
@@ -378,7 +411,7 @@ PresentationSection.createFromImpostorSection = function (
 PresentationSection.createFromManifestJSON = function (
 	manifestJSON,
 	sectionKey,
-	index
+	index,
 ) {
 	const section = new PresentationSection({
 		id: parseInt(_.uniqueId(), 10),
@@ -393,6 +426,7 @@ PresentationSection.createFromManifestJSON = function (
 		visible: true,
 		deckversion: 1,
 		tags: manifestJSON.tags[sectionKey] || null,
+		cmsvalkey_set: [],
 	});
 
 	const slideKeys = Object.keys(manifestJSON.titles).filter((slideKey) => {
@@ -405,9 +439,9 @@ PresentationSection.createFromManifestJSON = function (
 				manifestJSON,
 				key,
 				section.id,
-				slideIndex
+				slideIndex,
 			);
-		})
+		}),
 	);
 
 	return section;
@@ -432,8 +466,8 @@ PresentationSection.createFromManifestImpostor = function (section, index) {
 			PresentationSlide.createFromManifestImpostor(
 				slide,
 				index,
-				presentationSection.id
-			)
+				presentationSection.id,
+			),
 		);
 	});
 
@@ -455,15 +489,20 @@ PresentationSection.createFromAutoAdjunct = function (model, opts = {}) {
 		deckversionID: -1,
 		sequence: opts.index,
 		impostor: false,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	options.screenshots = PresentationSection.screenshotsToMap(
+		options.screenshots,
+	);
+
 	const tags = PresentationSection.getTags(
 		{
 			isAutoAdjunct: true,
 			key: model.key,
 			tags: model.tags,
 		},
-		options
+		options,
 	);
 
 	const autoAdjunct = new AutoAdjunctModel(model);
@@ -473,14 +512,18 @@ PresentationSection.createFromAutoAdjunct = function (model, opts = {}) {
 		adjunctID: autoAdjunct.id,
 		autoAdjunctID: autoAdjunct.id,
 		createdByTemplate: autoAdjunct.template !== null,
-		templateID: autoAdjunct.template ? autoAdjunct.template.id : null,
+		templateID: autoAdjunct.template?.id || null,
+		template: autoAdjunct.template || null,
 		html: "",
 		css: "",
 		sequence: options.sequence,
 		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,
@@ -488,13 +531,27 @@ PresentationSection.createFromAutoAdjunct = function (model, opts = {}) {
 		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();
+
+		const missingKeys = autoAdjunct.template.cmsvalkey_set
+			.filter((t) => {
+				return !autoAdjunctSection.cmsvalkey_set.find((k) => k.startsWith(t));
+			})
+			.map((t) => {
+				return `${t}-autoadjunct-${autoAdjunct.id}`;
+			});
+
+		autoAdjunctSection.cmsvalkey_set.push(...missingKeys);
 	} else {
 		autoAdjunctSection.image = autoAdjunct.image_original;
 	}
@@ -507,9 +564,11 @@ PresentationSection.createFromTemplate = function (template, index, minID = 0) {
 
 	const deckversion = new DeckVersionModel(templateModel.deckversion);
 	const templateAssetRoot = getAssetRoot(templateModel.index_asset.url());
+
 	const presentationSection = new PresentationSection({
 		id: minID + parseInt(_.uniqueId(), 10),
 		templateID: templateModel.id,
+		template: templateModel,
 		key: `template-${templateModel.key}`,
 		title: templateModel.title,
 		html: `${templateAssetRoot}index.html`,
@@ -525,6 +584,7 @@ PresentationSection.createFromTemplate = function (template, index, minID = 0) {
 		sequence: 9000 + templateModel.sequence,
 		createdByTemplate: true,
 		index,
+		cmsvalkey_set: [],
 	});
 
 	return presentationSection;

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

@@ -85,17 +85,56 @@ describe("#createFromSection", () => {
 
 		const presentationSection = PresentationSection.createFromSection(
 			section,
-			options
+			options,
 		);
 
 		expect(presentationSection.tags).toEqual(["section-tag"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the slide if no screenshot found", () => {
+			const data = getSectionJSON();
+			const section = new SectionModel(data);
+			const presentationSection =
+				PresentationSection.createFromSection(section);
+			expect(presentationSection.thumbnail).toEqual(data.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const section = new SectionModel(getSectionJSON());
+			const options = {
+				screenshots: {
+					[section.url()]: "test-screenshot.png",
+				},
+			};
+
+			const presentationSection = PresentationSection.createFromSection(
+				section,
+				options,
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });
 
 describe("#createFromAdjunctSection", () => {
-	const getAdjunctSectionJSON = () => {
+	const getAdjunctSectionJSON = (includeTemplate) => {
+		const template = {
+			id: 1,
+			image_256: "template.png",
+			index_asset: {
+				created_date: "2021-07-22T04:57:32.977770Z",
+				data: "index.html",
+				id: 148204,
+				modified_date: "2021-07-22T04:57:32.977790Z",
+				orig_path: "templates/test-template/foo",
+				pack: "https://staging-test.salespreso.com/api/packs/410/",
+				url: "https://staging-test-cdn.salespreso.com/media/pack/410/assets/sections/test-deck/slides/slide-key/index.html",
+			},
+		};
+
 		return {
-			adjunct: "https://staging-test.salespreso.com/api/adjuncts/7470/",
+			adjunct: "/api/adjuncts/7470/",
 			appointment: "https://staging-test.salespreso.com/api/appointments/2422/",
 			created_by_autoadjunct: true,
 			created_date: "2021-09-20T01:57:55.125224Z",
@@ -120,7 +159,7 @@ describe("#createFromAdjunctSection", () => {
 			modified_date: "2021-09-20T01:57:55.125229Z",
 			sequence: 1,
 			tags: [],
-			template: null,
+			template: includeTemplate ? template : null,
 			title: "Five",
 			url: "https://staging-test.salespreso.com/api/adjunctsections/1737/",
 		};
@@ -130,12 +169,13 @@ describe("#createFromAdjunctSection", () => {
 		const adjunctSection = new AdjunctSectionModel(getAdjunctSectionJSON());
 		const presentationSection = PresentationSection.createFromAdjunctSection(
 			adjunctSection,
-			{ id: 1 }
+			{ id: 1 },
 		);
 
 		const expected = {
 			adjunct: {
-				url: "https://staging-test.salespreso.com/api/adjuncts/7470/",
+				url: "/api/adjuncts/7470/",
+				id: 7470,
 			},
 			adjunctID: 1737,
 			adjunctSlideLimit: 0,
@@ -155,6 +195,7 @@ describe("#createFromAdjunctSection", () => {
 			sequence: 1,
 			slides: [],
 			tags: [],
+			template: null,
 			templateID: null,
 			temporary: true,
 			thumbnail:
@@ -162,6 +203,7 @@ describe("#createFromAdjunctSection", () => {
 			title: "Five",
 			url: "/api/adjunctsections/1737/",
 			visible: true,
+			cmsvalkey_set: [],
 		};
 
 		expect(presentationSection.toJSON()).toEqual(expected);
@@ -175,11 +217,42 @@ describe("#createFromAdjunctSection", () => {
 		const presentationSection = PresentationSection.createFromAdjunctSection(
 			adjunctSection,
 			{ id: 1 },
-			options
+			options,
 		);
 
 		expect(presentationSection.tags).toEqual(["adjunctsection-tag"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the model if no screenshot found", () => {
+			const data = getAdjunctSectionJSON(true);
+			const adjunctSection = new AdjunctSectionModel(data);
+			const presentationSlide = PresentationSection.createFromAdjunctSection(
+				adjunctSection,
+				{ id: 1 },
+			);
+			expect(presentationSlide.thumbnail).toEqual(data.template.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const adjunctSection = new AdjunctSectionModel(
+				getAdjunctSectionJSON(true),
+			);
+
+			const options = {
+				screenshots: {
+					"/api/autoadjuncts/545/": "test-screenshot.png",
+				},
+			};
+
+			const presentationSection = PresentationSection.createFromAdjunctSection(
+				adjunctSection,
+				{ id: 1 },
+				options,
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });
 
 describe("#createFromImpostorSection", () => {
@@ -268,11 +341,39 @@ describe("#createFromImpostorSection", () => {
 		const presentationSection = PresentationSection.createFromImpostorSection(
 			impostorSection,
 			null,
-			options
+			options,
 		);
 
 		expect(presentationSection.tags).toEqual(["impostorsection-tag"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the model if no screenshot found", () => {
+			const data = getImpostorSectionJSON();
+			const impostorSection = new SlideModel(data);
+			const presentationSection = PresentationSection.createFromImpostorSection(
+				impostorSection,
+				null,
+			);
+			expect(presentationSection.thumbnail).toEqual(data.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const impostorSection = new SlideModel(getImpostorSectionJSON());
+			const options = {
+				screenshots: {
+					[impostorSection.url()]: "test-screenshot.png",
+				},
+			};
+
+			const presentationSection = PresentationSection.createFromImpostorSection(
+				impostorSection,
+				null,
+				options,
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });
 
 describe("#createFromAutoAdjunct", () => {
@@ -313,7 +414,7 @@ describe("#createFromAutoAdjunct", () => {
 		};
 		const presentationSection = PresentationSection.createFromAutoAdjunct(
 			autoAdjunct,
-			options
+			options,
 		);
 
 		const expected = {
@@ -334,6 +435,7 @@ describe("#createFromAutoAdjunct", () => {
 			key: "autoadjunct-five",
 			sequence: 3,
 			slides: [],
+			template: null,
 			tags: [],
 			templateID: null,
 			temporary: true,
@@ -355,9 +457,39 @@ describe("#createFromAutoAdjunct", () => {
 		};
 		const presentationSection = PresentationSection.createFromAutoAdjunct(
 			autoAdjunct,
-			options
+			options,
 		);
 
 		expect(presentationSection.tags).toEqual(["autoadjunct-tag"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the model if no screenshot found", () => {
+			const data = getAutoAdjunctJSON();
+			const options = { index: 3, deckversionID: 12 };
+			const autoAdjunct = new AutoAdjunctModel(data);
+			const presentationSection = PresentationSection.createFromAutoAdjunct(
+				autoAdjunct,
+				options,
+			);
+			expect(presentationSection.thumbnail).toEqual(data.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const autoAdjunct = new AutoAdjunctModel(getAutoAdjunctJSON());
+			const options = {
+				index: 3,
+				deckversionID: 12,
+				screenshots: {
+					[autoAdjunct.url()]: "test-screenshot.png",
+				},
+			};
+
+			const presentationSection = PresentationSection.createFromAutoAdjunct(
+				autoAdjunct,
+				options,
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });

package/src/presentation/presentation-sections.js

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