@livepreso/api 6.42.1 → 6.45.0

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

@@ -0,0 +1,496 @@
+import { AdjunctSectionModel } from "../models/adjunct-section";
+import { AutoAdjunctModel } from "../models/auto-adjunct";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
+import { PresentationSection } from "./presentation-section";
+import { SectionModel } from "../models/section";
+import { SlideModel } from "../models/slide";
+
+describe("#createFromSection", () => {
+	const getSectionJSON = () => {
+		return {
+			adjunctslide_limit: 0,
+			created_date: "2021-07-19T01:17:59.522119Z",
+			deckversion: "https://staging-test.salespreso.com/api/deckversions/408/",
+			description: "",
+			enabled: true,
+			id: 1728,
+			image_128:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/section/123/456.jpg",
+			image_256:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/section/123/456.jpg",
+			image_512:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/section/123/456.jpg",
+			index_asset: {
+				created_date: "2021-07-19T01:17:58.068483Z",
+				data: "sections/agenda/index.html",
+				hash_algorithm: "sha-256",
+				hash_digest:
+					"f84e1e0b43f4b25168e4a8997b11a2c1c2848376b128b2d72ba5bd4f44c17dcc",
+				id: 148115,
+				modified_date: "2021-07-19T01:17:58.068507Z",
+				orig_path: "sections/agenda",
+				pack: "https://staging-test.salespreso.com/api/packs/409/",
+				url: "https://staging-test-cdn.salespreso.com/media/pack/409/assets/sections/agenda/index.html",
+			},
+			key: "agenda",
+			modified_date: "2021-07-19T01:20:43.815965Z",
+			namespaced_key: "agenda",
+			sequence: 0,
+			slide_set: [],
+			tags: [],
+			title: "Agenda",
+			url: "https://staging-test.salespreso.com/api/sections/1728/",
+		};
+	};
+
+	it("should create a presentation section", async () => {
+		const section = new SectionModel(getSectionJSON());
+		const presentationSection = PresentationSection.createFromSection(section);
+
+		const expected = {
+			adjunctID: null,
+			adjunctSlideLimit: 0,
+			autoAdjunctID: null,
+			createdByAutoAdjunct: false,
+			createdByTemplate: false,
+			css: "https://staging-test-cdn.salespreso.com/media/pack/409/assets/sections/agenda/slide.css",
+			custom: false,
+			deckversion: 408,
+			editable: false,
+			html: "https://staging-test-cdn.salespreso.com/media/pack/409/assets/sections/agenda/index.html",
+			id: 1728,
+			impostor: false,
+			index: 0,
+			isWelcome: false,
+			key: "agenda",
+			selectionID: null,
+			sequence: 0,
+			slides: [],
+			tags: [],
+			templateID: null,
+			thumbnail:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/section/123/456.jpg",
+			title: "Agenda",
+			url: "/api/sections/1728/",
+			visible: true,
+		};
+
+		expect(presentationSection.toJSON()).toEqual(expected);
+	});
+
+	it("should use deckTags when available", async () => {
+		const section = new SectionModel(getSectionJSON());
+		const options = {
+			deckTags: { agenda: ["section-tag"] },
+		};
+
+		const presentationSection = PresentationSection.createFromSection(
+			section,
+			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: new DeckVersionScreenshotCollection([
+					{ subject: section.url(), image_256: "test-screenshot.png" },
+				]),
+			};
+
+			const presentationSection = PresentationSection.createFromSection(
+				section,
+				options
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
+});
+
+describe("#createFromAdjunctSection", () => {
+	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/",
+			appointment: "https://staging-test.salespreso.com/api/appointments/2422/",
+			created_by_autoadjunct: true,
+			created_date: "2021-09-20T01:57:55.125224Z",
+			creator_autoadjunct:
+				"https://staging-test.salespreso.com/api/autoadjuncts/545/",
+			deckversion: "https://staging-test.salespreso.com/api/deckversions/408/",
+			deleted: false,
+			enabled: true,
+			html_content:
+				'<img src="https://staging-test-cdn.salespreso.com/media/autoadjunct/123.png">',
+			id: 1737,
+			image_128:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			image_256:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			image_512:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			image_1024:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.png",
+			image_original:
+				"https://staging-test-cdn.salespreso.com/media/autoadjunct/123.png",
+			modified_date: "2021-09-20T01:57:55.125229Z",
+			sequence: 1,
+			tags: [],
+			template: includeTemplate ? template : null,
+			title: "Five",
+			url: "https://staging-test.salespreso.com/api/adjunctsections/1737/",
+		};
+	};
+
+	it("should create a presentation section", async () => {
+		const adjunctSection = new AdjunctSectionModel(getAdjunctSectionJSON());
+		const presentationSection = PresentationSection.createFromAdjunctSection(
+			adjunctSection,
+			{ id: 1 }
+		);
+
+		const expected = {
+			adjunct: {
+				url: "https://staging-test.salespreso.com/api/adjuncts/7470/",
+			},
+			adjunctID: 1737,
+			adjunctSlideLimit: 0,
+			autoAdjunctID: 545,
+			createdByAutoAdjunct: true,
+			createdByTemplate: false,
+			custom: false,
+			deckversion: 1,
+			editable: false,
+			id: 1,
+			image:
+				"https://staging-test-cdn.salespreso.com/media/autoadjunct/123.png",
+			impostor: false,
+			index: 1,
+			isWelcome: false,
+			key: "adjunct-1737",
+			sequence: 1,
+			slides: [],
+			tags: [],
+			templateID: null,
+			temporary: true,
+			thumbnail:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			title: "Five",
+			url: "/api/adjunctsections/1737/",
+			visible: true,
+			cmsvalkey_set: [],
+		};
+
+		expect(presentationSection.toJSON()).toEqual(expected);
+	});
+
+	it("should use deckTags when available", async () => {
+		const adjunctSection = new AdjunctSectionModel(getAdjunctSectionJSON());
+		const options = {
+			deckTags: { "adjunct-1737": ["adjunctsection-tag"] },
+		};
+		const presentationSection = PresentationSection.createFromAdjunctSection(
+			adjunctSection,
+			{ id: 1 },
+			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: new DeckVersionScreenshotCollection([
+					{
+						subject: "/api/autoadjuncts/545/",
+						image_256: "test-screenshot.png",
+					},
+				]),
+			};
+
+			const presentationSection = PresentationSection.createFromAdjunctSection(
+				adjunctSection,
+				{ id: 1 },
+				options
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
+});
+
+describe("#createFromImpostorSection", () => {
+	const getImpostorSectionJSON = () => {
+		return {
+			created_date: "2021-09-20T02:59:06.968285Z",
+			description: "",
+			enabled: true,
+			id: 23898,
+			image_128:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/slide/123/456.jpg",
+			image_256:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/slide/123/456.jpg",
+			image_512:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/slide/123/456.jpg",
+			index_asset: {
+				created_date: "2021-09-20T02:59:02.361498Z",
+				data: "sections/test-deck/slides/agenda/index.html",
+				hash_algorithm: "sha-256",
+				hash_digest:
+					"b77283717f1a99bce5b8aea67e007f11aad06473f5fe26412c15e707f8758343",
+				id: 153400,
+				modified_date: "2021-09-20T02:59:02.361528Z",
+				orig_path: "sections/test-deck/slides/agenda",
+				pack: "https://staging-test.salespreso.com/api/packs/427/",
+				url: "https://staging-test-cdn.salespreso.com/media/pack/427/assets/sections/test-deck/slides/agenda/index.html",
+			},
+			key: "agenda",
+			modified_date: "2021-09-20T03:05:27.811485Z",
+			namespaced_key: "test-deck/agenda",
+			section: {
+				id: 2,
+				deckversion: {
+					id: 3,
+				},
+			},
+			sequence: 0,
+			subslide_set: [],
+			tags: ["section-header"],
+			title: "Agenda",
+			url: "https://staging-test.salespreso.com/api/slides/23898/",
+		};
+	};
+
+	it("should create a presentation section", async () => {
+		const impostorSection = new SlideModel(getImpostorSectionJSON());
+		const presentationSection =
+			PresentationSection.createFromImpostorSection(impostorSection);
+
+		const expected = {
+			adjunctID: null,
+			adjunctSlideLimit: 0,
+			autoAdjunctID: null,
+			createdByAutoAdjunct: false,
+			createdByTemplate: false,
+			css: "https://staging-test-cdn.salespreso.com/media/pack/427/assets/sections/test-deck/slides/agenda/slide.css",
+			custom: false,
+			deckversion: 3,
+			editable: false,
+			html: "https://staging-test-cdn.salespreso.com/media/pack/427/assets/sections/test-deck/slides/agenda/index.html",
+			id: 23898,
+			impostor: true,
+			index: 0,
+			isWelcome: false,
+			key: "agenda",
+			selectionID: null,
+			sequence: 0,
+			slides: [],
+			tags: ["section-header"],
+			templateID: null,
+			thumbnail:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/slide/123/456.jpg",
+			title: "Agenda",
+			url: "/api/slides/23898/",
+			visible: true,
+		};
+
+		expect(presentationSection.toJSON()).toEqual(expected);
+	});
+
+	it("should use deckTags when available", async () => {
+		const impostorSection = new SlideModel(getImpostorSectionJSON());
+		const options = {
+			deckTags: { "test-deck/agenda": ["impostorsection-tag"] },
+		};
+		const presentationSection = PresentationSection.createFromImpostorSection(
+			impostorSection,
+			null,
+			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: new DeckVersionScreenshotCollection([
+					{ subject: impostorSection.url(), image_256: "test-screenshot.png" },
+				]),
+			};
+
+			const presentationSection = PresentationSection.createFromImpostorSection(
+				impostorSection,
+				null,
+				options
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
+});
+
+describe("#createFromAutoAdjunct", () => {
+	const getAutoAdjunctJSON = () => {
+		return {
+			after_key: "autoadjunct-i-am-template-section",
+			created_date: "2021-09-16T04:25:54.459641Z",
+			deck: "https://staging-test.salespreso.com/api/decks/6/",
+			enabled: true,
+			id: 545,
+			image_128:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			image_256:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			image_512:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			image_1024:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.png",
+			image_original:
+				"https://staging-test-cdn.salespreso.com/media/autoadjunct/123.png",
+			key: "autoadjunct-five",
+			modified_date: "2021-09-20T01:57:55.090828Z",
+			name: "Five",
+			parent_key: "",
+			sequence: 1,
+			tags: [],
+			team: null,
+			template: null,
+			url: "https://staging-test.salespreso.com/api/autoadjuncts/545/",
+		};
+	};
+
+	it("should create a presentation section", async () => {
+		const autoAdjunct = new AutoAdjunctModel(getAutoAdjunctJSON());
+		const options = {
+			index: 3,
+			deckversionID: 12,
+		};
+		const presentationSection = PresentationSection.createFromAutoAdjunct(
+			autoAdjunct,
+			options
+		);
+
+		const expected = {
+			adjunctID: 545,
+			adjunctSlideLimit: 0,
+			autoAdjunctID: 545,
+			createdByAutoAdjunct: false,
+			createdByTemplate: false,
+			css: "",
+			deckversion: 12,
+			html: "",
+			id: 545,
+			image:
+				"https://staging-test-cdn.salespreso.com/media/autoadjunct/123.png",
+			impostor: false,
+			index: 3,
+			isWelcome: false,
+			key: "autoadjunct-five",
+			sequence: 3,
+			slides: [],
+			tags: [],
+			templateID: null,
+			temporary: true,
+			thumbnail:
+				"https://staging-test-cdn.salespreso.com/media/CACHE/images/autoadjunct/123/456.jpg",
+			title: "Five",
+			url: "/api/adjunctsections/545/",
+			visible: true,
+		};
+		expect(presentationSection.toJSON()).toEqual(expected);
+	});
+
+	it("should use deckTags when available", async () => {
+		const autoAdjunct = new AutoAdjunctModel(getAutoAdjunctJSON());
+		const options = {
+			index: 3,
+			deckversionID: 12,
+			deckTags: { "autoadjunct-five": ["autoadjunct-tag"] },
+		};
+		const presentationSection = PresentationSection.createFromAutoAdjunct(
+			autoAdjunct,
+			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: new DeckVersionScreenshotCollection([
+					{ subject: autoAdjunct.url(), image_256: "test-screenshot.png" },
+				]),
+			};
+
+			const presentationSection = PresentationSection.createFromAutoAdjunct(
+				autoAdjunct,
+				options
+			);
+			expect(presentationSection.thumbnail).toEqual("test-screenshot.png");
+		});
+	});
+});

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",
 		},
 
 		/**
@@ -116,6 +118,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,
@@ -154,9 +157,9 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 		html,
 		css,
 		key: slideModel.key,
-		thumbnail: slideModel.image_256,
+		thumbnail: PresentationSlide.getThumbnail(slideModel, options.screenshots),
 		custom: false,
-		editable: slideModel.tags.indexOf("editable") > -1,
+		editable: tags.indexOf("editable") > -1,
 		title: slideModel.title,
 		section: slideModel.section.id,
 		tags,
@@ -164,6 +167,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 		sequence: config.sequence,
 		visible: config.visible,
 		selectionID: config.selectionID,
+		cmsvalkey_set: slideModel.cmsvalkey_set,
 	});
 
 	slide.subslides.add(
@@ -183,7 +187,7 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 	if (
 		adjunctSubslides.length &&
 		!slide.subslides.length &&
-		!(slideModel.tags.indexOf("subslide_container") > -1)
+		!(tags.indexOf("subslide_container") > -1)
 	) {
 		slide.subslides.add(PresentationSubSlide.createFromSlide(slide));
 	}
@@ -229,6 +233,7 @@ PresentationSlide.createFromAdjunctSlide = function (
 		getUniqueAdjunctID: () => {
 			return parseInt(_.uniqueId(), 10);
 		},
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
 	const keyID =
@@ -243,6 +248,7 @@ PresentationSlide.createFromAdjunctSlide = function (
 		key = adjunctSlideModel.key;
 	} else if (keyID) {
 		key = `adjunct-${keyID}`;
+		adjunctSlideModel.key = key;
 	}
 
 	const config = PresentationSlide.getVisibilityAndSequence(
@@ -250,6 +256,8 @@ PresentationSlide.createFromAdjunctSlide = function (
 		options
 	);
 
+	const tags = PresentationSlide.getTags(adjunctSlideModel, options);
+
 	const slide = new PresentationSlide({
 		id: options.id || options.getUniqueAdjunctID(),
 		adjunct: adjunctSlideModel.adjunct ? adjunctSlideModel.adjunct.url() : null,
@@ -265,10 +273,11 @@ PresentationSlide.createFromAdjunctSlide = function (
 		temporary: adjunctSlideModel.created_by_autoadjunct,
 		title: adjunctSlideModel.title,
 		section: section ? section.id : null,
-		tags: adjunctSlideModel.tags,
+		tags,
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
+		cmsvalkey_set: [],
 	});
 
 	if (adjunctSlideModel.template) {
@@ -293,7 +302,14 @@ PresentationSlide.createFromAdjunctSlide = function (
 		}
 		slide.html = html;
 		slide.css = css;
-		slide.thumbnail = adjunctSlideModel.template.image_256;
+
+		slide.thumbnail =
+			// Try and use autoadjunct screenshot (if there is one), otherwise
+			// use the template's image as a fallback
+			PresentationSlide.getThumbnail(
+				adjunctSlideModel.creator_autoadjunct,
+				options.screenshots
+			) || adjunctSlideModel.template.image_256;
 	} else {
 		slide.image = adjunctSlideModel.image_original;
 	}
@@ -323,6 +339,7 @@ PresentationSlide.createFromManifestJSON = function (
 		visible: true,
 		section: sectionID,
 		tags: manifestJSON.tags[key] || null,
+		cmsvalkey_set: [],
 	});
 
 	return slide;
@@ -365,11 +382,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") {
@@ -384,8 +402,18 @@ PresentationSlide.createFromAutoAdjunct = function (model, opts) {
 		deckversionID: -1,
 		sequence: opts.index,
 		impostor: false,
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 	});
 
+	const tags = PresentationSlide.getTags(
+		{
+			isAutoAdjunct: true,
+			key: model.key,
+			tags: model.tags,
+		},
+		options
+	);
+
 	const autoAdjunct = new AutoAdjunctModel(model);
 
 	const autoAdjunctSlide = new PresentationSlide({
@@ -400,17 +428,22 @@ PresentationSlide.createFromAutoAdjunct = function (model, opts) {
 		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,
 		allowConvert: options.allowConvert,
 		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();