@livepreso/api 6.44.0 → 6.46.0

package/src/presentation/presentation-slide.js

@@ -41,6 +41,7 @@ export const PresentationSlide = BasePresentationModel.extend(
 		 * @property {number} selectionID
 		 * @property {bool} editable
 		 * @property {array} tags
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			id: "number",
@@ -77,6 +78,7 @@ export const PresentationSlide = BasePresentationModel.extend(
 			selectionID: "number",
 			editable: "boolean",
 			tags: "array",
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -84,6 +86,7 @@ export const PresentationSlide = BasePresentationModel.extend(
 		 */
 		children: {
 			adjunct: "AdjunctModel",
+			template: "TemplateModel",
 		},
 
 		/**
@@ -103,7 +106,7 @@ export const PresentationSlide = BasePresentationModel.extend(
 			}
 			return this._url;
 		},
-	}
+	},
 );
 
 /**
@@ -116,6 +119,7 @@ export const PresentationSlide = BasePresentationModel.extend(
 PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 	_.defaults(options, {
 		adjunctSubSlides: new collections.AdjunctSubSlideCollection(),
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 		rootAssetPath: null,
 		selections: null,
 		choicelist: null,
@@ -124,6 +128,8 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 		},
 	});
 
+	options.screenshots = PresentationSlide.screenshotsToMap(options.screenshots);
+
 	let html;
 	let css;
 
@@ -131,7 +137,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 
 	if (options.rootAssetPath) {
 		const baseRoot = getAssetRoot(
-			slideModel.section.deckversion.index_asset.url()
+			slideModel.section.deckversion.index_asset.url(),
 		);
 		const slidePath = assetRoot.slice(baseRoot.length);
 		html = `${options.rootAssetPath}${slidePath}index.html`;
@@ -143,7 +149,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 
 	const config = PresentationSlide.getVisibilityAndSequence(
 		slideModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSlide.getTags(slideModel, options);
@@ -154,7 +160,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 		html,
 		css,
 		key: slideModel.key,
-		thumbnail: slideModel.image_256,
+		thumbnail: PresentationSlide.getThumbnail(slideModel, options.screenshots),
 		custom: false,
 		editable: tags.indexOf("editable") > -1,
 		title: slideModel.title,
@@ -164,12 +170,13 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 		sequence: config.sequence,
 		visible: config.visible,
 		selectionID: config.selectionID,
+		cmsvalkey_set: slideModel.cmsvalkey_set,
 	});
 
 	slide.subslides.add(
 		slideModel.subslide_set.map((model) => {
 			return PresentationSubSlide.createFromSubSlide(model, options);
-		})
+		}),
 	);
 
 	const adjunctSubslides = options.adjunctSubSlides.filter((model) => {
@@ -202,7 +209,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 				...options,
 				id,
 			});
-		})
+		}),
 	);
 
 	return slide;
@@ -219,7 +226,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 PresentationSlide.createFromAdjunctSlide = function (
 	adjunctSlideModel,
 	section = null,
-	options = {}
+	options = {},
 ) {
 	_.defaults(options, {
 		id: null,
@@ -229,8 +236,11 @@ PresentationSlide.createFromAdjunctSlide = function (
 		getUniqueAdjunctID: () => {
 			return parseInt(_.uniqueId(), 10);
 		},
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	options.screenshots = PresentationSlide.screenshotsToMap(options.screenshots);
+
 	const keyID =
 		adjunctSlideModel.id ||
 		(adjunctSlideModel.creator_autoadjunct
@@ -248,18 +258,18 @@ PresentationSlide.createFromAdjunctSlide = function (
 
 	const config = PresentationSlide.getVisibilityAndSequence(
 		adjunctSlideModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSlide.getTags(adjunctSlideModel, options);
 
+	const autoAdjunctID = adjunctSlideModel.creator_autoadjunct?.id || null;
+
 	const slide = new PresentationSlide({
 		id: options.id || options.getUniqueAdjunctID(),
-		adjunct: adjunctSlideModel.adjunct ? adjunctSlideModel.adjunct.url() : null,
+		adjunct: adjunctSlideModel.adjunct,
 		adjunctID: adjunctSlideModel.id,
-		autoAdjunctID: adjunctSlideModel.creator_autoadjunct
-			? adjunctSlideModel.creator_autoadjunct.id
-			: null,
+		autoAdjunctID,
 		key,
 		thumbnail: adjunctSlideModel.image_256,
 		createdByAutoAdjunct: adjunctSlideModel.created_by_autoadjunct,
@@ -272,12 +282,15 @@ PresentationSlide.createFromAdjunctSlide = function (
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
+		cmsvalkey_set: adjunctSlideModel.template?.cmsvalkey_set || [],
+		templateID: adjunctSlideModel.template?.id || null,
+		template: adjunctSlideModel.template || null,
 	});
 
 	if (adjunctSlideModel.template) {
 		if (!adjunctSlideModel.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 = adjunctSlideModel.template.index_asset.orig_path;
@@ -289,14 +302,24 @@ PresentationSlide.createFromAdjunctSlide = function (
 			css = `${options.rootAssetPath}${origPath}/slide.css`;
 		} else {
 			const assetRoot = getAssetRoot(
-				adjunctSlideModel.template.index_asset.url()
+				adjunctSlideModel.template.index_asset.url(),
 			);
 			html = `${assetRoot}index.html`;
 			css = `${assetRoot}slide.css`;
 		}
 		slide.html = html;
 		slide.css = css;
-		slide.thumbnail = adjunctSlideModel.template.image_256;
+
+		if (adjunctSlideModel.creator_autoadjunct) {
+			slide.thumbnail = PresentationSlide.getThumbnail(
+				adjunctSlideModel.creator_autoadjunct,
+				options.screenshots,
+			);
+		}
+
+		if (!slide.thumbnail) {
+			slide.thumbnail = adjunctSlideModel.template.image_256;
+		}
 	} else {
 		slide.image = adjunctSlideModel.image_original;
 	}
@@ -308,7 +331,7 @@ PresentationSlide.createFromManifestJSON = function (
 	manifestJSON,
 	key,
 	sectionID,
-	index
+	index,
 ) {
 	const [, slideKey] = key.split("/");
 
@@ -326,6 +349,7 @@ PresentationSlide.createFromManifestJSON = function (
 		visible: true,
 		section: sectionID,
 		tags: manifestJSON.tags[key] || null,
+		cmsvalkey_set: [],
 	});
 
 	return slide;
@@ -334,7 +358,7 @@ PresentationSlide.createFromManifestJSON = function (
 PresentationSlide.createFromManifestImpostor = function (
 	slide,
 	index,
-	sectionID
+	sectionID,
 ) {
 	const presentationSlide = new PresentationSlide({
 		id: parseInt(_.uniqueId(), 10),
@@ -354,7 +378,7 @@ PresentationSlide.createFromTemplate = function (
 	template,
 	index,
 	sectionID,
-	minID = 0
+	minID = 0,
 ) {
 	const presentationSlide = new PresentationSlide({
 		...template,
@@ -368,11 +392,12 @@ PresentationSlide.createFromTemplate = function (
 		autoAdjunctID: Number(_.uniqueId()),
 		index,
 		createdByTemplate: true,
+		cmsvalkey_set: [],
 	});
 	return presentationSlide;
 };
 
-PresentationSlide.createFromAutoAdjunct = function (model, opts) {
+PresentationSlide.createFromAutoAdjunct = function (model, opts = {}) {
 	const requiredKeys = ["index", "deckversionID"];
 	for (const key of requiredKeys) {
 		if (typeof opts[key] === "undefined") {
@@ -387,15 +412,18 @@ PresentationSlide.createFromAutoAdjunct = function (model, opts) {
 		deckversionID: -1,
 		sequence: opts.index,
 		impostor: false,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	options.screenshots = PresentationSlide.screenshotsToMap(options.screenshots);
+
 	const tags = PresentationSlide.getTags(
 		{
 			isAutoAdjunct: true,
 			key: model.key,
 			tags: model.tags,
 		},
-		options
+		options,
 	);
 
 	const autoAdjunct = new AutoAdjunctModel(model);
@@ -405,14 +433,15 @@ PresentationSlide.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: PresentationSlide.getThumbnail(autoAdjunct, options.screenshots),
 		temporary: true,
 		title: autoAdjunct.name,
 		visible: options.visible,
@@ -420,13 +449,30 @@ PresentationSlide.createFromAutoAdjunct = function (model, opts) {
 		deckversion: options.deckversionID,
 		impostor: options.impostor,
 		tags,
+		cmsvalkey_set: autoAdjunct.cmsvalkey_set,
 	});
 
 	if (autoAdjunct.template) {
-		autoAdjunctSlide.thumbnail = autoAdjunct.template.image_256;
+		// If we've found a new screenshot for it, we don't want to override it here
+		if (!autoAdjunctSlide.thumbnail) {
+			autoAdjunctSlide.thumbnail = autoAdjunct.template.image_256;
+		}
 		autoAdjunctSlide.createdByTemplate = true;
 		autoAdjunctSlide.templateID = autoAdjunct.template.id;
 		autoAdjunctSlide.html = autoAdjunct.template.index_asset.url();
+		//
+		// We've had some instances where the caching was returning the wrong data, and the
+		// app was unable to recover when an autoadjunct was missing keys. So, check for missing
+		// keys.
+		const missingKeys = autoAdjunct.template.cmsvalkey_set
+			.filter((t) => {
+				return !autoAdjunctSlide.cmsvalkey_set.find((k) => k.startsWith(t));
+			})
+			.map((t) => {
+				return `${t}-autoadjunct-${autoAdjunct.id}`;
+			});
+
+		autoAdjunctSlide.cmsvalkey_set.push(...missingKeys);
 	} else {
 		autoAdjunctSlide.image = autoAdjunct.image_original;
 	}

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

@@ -75,10 +75,47 @@ describe("#createFromSlide", () => {
 
 		expect(presentationSlide.tags).toEqual(["slide-tag"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the model if no screenshot found", () => {
+			const slide = new SlideModel(getSlideJSON());
+			const presentationSlide = PresentationSlide.createFromSlide(slide);
+			expect(presentationSlide.thumbnail).toEqual(null);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const slide = new SlideModel(getSlideJSON());
+			const options = {
+				screenshots: {
+					"/api/slides/23219/": "test-screenshot.png",
+				},
+			};
+
+			const presentationSlide = PresentationSlide.createFromSlide(
+				slide,
+				options,
+			);
+			expect(presentationSlide.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });
 
 describe("#createFromAdjunctSlide", () => {
-	const getAdjunctSlideJSON = () => {
+	const getAdjunctSlideJSON = (includeTemplate = false) => {
+		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/7457/",
 			appointment: "https://staging-test.salespreso.com/api/appointments/2426/",
@@ -105,7 +142,7 @@ describe("#createFromAdjunctSlide", () => {
 			section: "https://staging-test.salespreso.com/api/sections/1755/",
 			sequence: 3,
 			tags: [],
-			template: null,
+			template: includeTemplate ? template : null,
 			title: "Six",
 			url: "https://staging-test.salespreso.com/api/adjunctslides/10529/",
 		};
@@ -117,9 +154,6 @@ describe("#createFromAdjunctSlide", () => {
 			PresentationSlide.createFromAdjunctSlide(adjunctSlide);
 
 		const expected = {
-			adjunct: {
-				url: "https://staging-test.salespreso.com/api/adjuncts/7457/",
-			},
 			adjunctID: 10529,
 			autoAdjunctID: 541,
 			createdByAutoAdjunct: true,
@@ -141,9 +175,12 @@ describe("#createFromAdjunctSlide", () => {
 			title: "Six",
 			url: "/api/adjunctslides/10529/",
 			visible: true,
+			cmsvalkey_set: [],
 		};
 
-		expect(presentationSlide.toJSON()).toEqual(expected);
+		expect(presentationSlide.toJSON()).toEqual(
+			expect.objectContaining(expected),
+		);
 	});
 
 	it("should use deckTags when available", async () => {
@@ -155,11 +192,39 @@ describe("#createFromAdjunctSlide", () => {
 		const presentationSlide = PresentationSlide.createFromAdjunctSlide(
 			adjunctSlide,
 			null,
-			options
+			options,
 		);
 
 		expect(presentationSlide.tags).toEqual(["adjunctslide-tag"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the model if no screenshot found", () => {
+			const data = getAdjunctSlideJSON(true);
+			const adjunctSlide = new AdjunctSlideModel(data);
+			const presentationSlide =
+				PresentationSlide.createFromAdjunctSlide(adjunctSlide);
+
+			expect(presentationSlide.thumbnail).toEqual(data.template.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const adjunctSlide = new AdjunctSlideModel(getAdjunctSlideJSON(true));
+
+			const options = {
+				screenshots: {
+					"/api/autoadjuncts/541/": "test-screenshot.png",
+				},
+			};
+
+			const presentationSlide = PresentationSlide.createFromAdjunctSlide(
+				adjunctSlide,
+				null,
+				options,
+			);
+			expect(presentationSlide.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });
 
 describe("#createFromAutoAdjunct", () => {
@@ -201,7 +266,7 @@ describe("#createFromAutoAdjunct", () => {
 
 		const presentationSlide = PresentationSlide.createFromAutoAdjunct(
 			autoAdjunct,
-			options
+			options,
 		);
 
 		const expected = {
@@ -219,6 +284,7 @@ describe("#createFromAutoAdjunct", () => {
 			sequence: 3,
 			subslides: [],
 			tags: [],
+			template: null,
 			templateID: null,
 			temporary: true,
 			thumbnail:
@@ -243,8 +309,38 @@ describe("#createFromAutoAdjunct", () => {
 
 		const presentationSlide = PresentationSlide.createFromAutoAdjunct(
 			autoAdjunct,
-			options
+			options,
 		);
 		expect(presentationSlide.tags).toEqual(["autoadjunct-tags"]);
 	});
+
+	describe("Screenshots", () => {
+		it("should use the default image from the model if no screenshot found", () => {
+			const options = { index: 3, deckversionID: 12 };
+			const data = getAutoAdjunctJSON();
+			const autoAdjunct = new AutoAdjunctModel(data);
+			const presentationSlide = PresentationSlide.createFromAutoAdjunct(
+				autoAdjunct,
+				options,
+			);
+			expect(presentationSlide.thumbnail).toEqual(data.image_256);
+		});
+
+		it("should use the screenshot model if it matches", () => {
+			const options = {
+				index: 3,
+				deckversionID: 12,
+				screenshots: {
+					"/api/autoadjuncts/525/": "test-screenshot.png",
+				},
+			};
+			const data = getAutoAdjunctJSON();
+			const autoAdjunct = new AutoAdjunctModel(data);
+			const presentationSlide = PresentationSlide.createFromAutoAdjunct(
+				autoAdjunct,
+				options,
+			);
+			expect(presentationSlide.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
 });

package/src/presentation/presentation-slides.js

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

package/src/presentation/presentation-subslide.js

@@ -62,7 +62,7 @@ export const PresentationSubSlide = BasePresentationModel.extend(
 
 			return this._url;
 		},
-	}
+	},
 );
 
 /**
@@ -74,7 +74,7 @@ export const PresentationSubSlide = BasePresentationModel.extend(
  */
 PresentationSubSlide.createFromSubSlide = function (
 	subSlideModel,
-	options = {}
+	options = {},
 ) {
 	_.defaults(options, {
 		selections: null,
@@ -83,7 +83,7 @@ PresentationSubSlide.createFromSubSlide = function (
 
 	const config = PresentationSubSlide.getVisibilityAndSequence(
 		subSlideModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSubSlide.getTags(subSlideModel, options);
@@ -116,7 +116,7 @@ PresentationSubSlide.createFromSubSlide = function (
 PresentationSubSlide.createFromAdjunctSubSlide = function (
 	adjunctSubSlideModel,
 	slideModel,
-	options = {}
+	options = {},
 ) {
 	_.defaults(options, {
 		id: null,
@@ -132,7 +132,7 @@ PresentationSubSlide.createFromAdjunctSubSlide = function (
 
 	const config = PresentationSubSlide.getVisibilityAndSequence(
 		adjunctSubSlideModel,
-		options
+		options,
 	);
 
 	const tags = PresentationSubSlide.getTags(adjunctSubSlideModel, options);

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

@@ -60,7 +60,7 @@ describe("#createFromSubSlide", () => {
 		};
 		const presentationSub = PresentationSubSlide.createFromSubSlide(
 			subslide,
-			options
+			options,
 		);
 
 		expect(presentationSub.tags).toEqual(["subslide-tag"]);
@@ -98,7 +98,7 @@ describe("#createFromAdjunctSubSlide", () => {
 		const presentationSub = PresentationSubSlide.createFromAdjunctSubSlide(
 			subslide,
 			{ id: 58 },
-			{ id: 23 }
+			{ id: 23 },
 		);
 
 		// The adjunct subslide model doesn't have an image prop or a tags prop,
@@ -136,7 +136,7 @@ describe("#createFromAdjunctSubSlide", () => {
 		const presentationSub = PresentationSubSlide.createFromAdjunctSubSlide(
 			subslide,
 			{ id: 58 },
-			options
+			options,
 		);
 
 		expect(presentationSub.tags).toEqual(["adjunctsubslide-tag"]);

package/src/presentation/presentation-subslides.js

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

package/src/presentation/presentation.js

@@ -2,6 +2,7 @@ import "./presentation-decks.js";
 
 import { DeckVersionModel, ManifestJSONModel } from "../models.js";
 
+import { AutoAdjunctCollection } from "../collections/auto-adjuncts.js";
 import { BasePresentationModel } from "./base-presentation-model.js";
 import { PresentationDeck } from "./presentation-deck.js";
 import Promise from "bluebird";
@@ -17,9 +18,10 @@ export const Presentation = BasePresentationModel.extend({
 
 Presentation.createFromDeckversion = function (deckversionURL, options) {
 	const deckversion = new DeckVersionModel(deckversionURL);
-
 	const opts = _.defaults(options, {
 		includeTemplates: false,
+		choicelist: null,
+		autoAdjuncts: new AutoAdjunctCollection(),
 	});
 
 	return deckversion
@@ -30,6 +32,21 @@ Presentation.createFromDeckversion = function (deckversionURL, options) {
 				deckversion.deck.fetch(),
 			]);
 		})
+		.then(async () => {
+			const templates = [...deckversion.template_set.models];
+
+			for (const auto of opts.autoAdjuncts.models) {
+				const dvTemplate = templates.find(
+					(t) => t.url() === auto.template.url(),
+				);
+				if (dvTemplate) {
+					auto.template = dvTemplate;
+				} else {
+					await auto.template.fetch();
+					templates.push(auto.template);
+				}
+			}
+		})
 		.then(() => {
 			return deckversion.deck.tags.fetch();
 		})
@@ -41,16 +58,17 @@ Presentation.createFromDeckversion = function (deckversionURL, options) {
 
 			const presentation = new Presentation();
 
-			const createOpts = {
-				deckTags,
-			};
+			const { includeTemplates, ...otherOpts } = opts;
 
-			if (opts.includeTemplates) {
-				createOpts.templates = deckversion.template_set.toJSON();
+			if (includeTemplates) {
+				otherOpts.templates = deckversion.template_set.toJSON();
 			}
 
 			presentation.decks.add([
-				PresentationDeck.createFromDeckVersion(deckversion, createOpts),
+				PresentationDeck.createFromDeckVersion(deckversion, {
+					...otherOpts,
+					deckTags,
+				}),
 			]);
 
 			return presentation;
@@ -63,7 +81,8 @@ Presentation.createFromDeckversion = function (deckversionURL, options) {
 
 Presentation.createFromManifestJSON = function (manifestJSON, url) {
 	const manifestModel = new ManifestJSONModel(manifestJSON.toJSON());
-	// Let's use the model to transport the manifest url.
+
+	// Let's use the model to transport the base url for the deck assets
 	manifestModel._url = url;
 
 	const deck = PresentationDeck.createFromManifestJSON(manifestModel);