@livepreso/api 6.42.1 → 6.43.0

package/src/models.js

@@ -17,6 +17,7 @@ export * from "./models/cms-val";
 export * from "./models/contact";
 export * from "./models/customer";
 export * from "./models/deck";
+export * from "./models/deck-tags";
 export * from "./models/deck-version";
 export * from "./models/dispatch";
 export * from "./models/dispatch-preview";
@@ -46,6 +47,7 @@ export * from "./models/slide-selection";
 export * from "./models/snapshot";
 export * from "./models/sub-slide";
 export * from "./models/support-ticket.js";
+export * from "./models/tag.js";
 export * from "./models/tenancy.js";
 export * from "./models/timing-log.js";
 export * from "./models/upload.js";
@@ -55,6 +57,10 @@ export * from "./models/appointment-editor.js";
 export * from "./models/appointment-duplicate.js";
 export * from "./models/appointment-stats.js";
 export * from "./models/appointment-viewing.js";
+export * from "./models/appointment-deckversion-tags.js";
+export * from "./models/appointment-section-tags.js";
+export * from "./models/appointment-slide-tags.js";
+export * from "./models/appointment-adjunct-tags.js";
 export * from "./models/team.js";
 export * from "./models/template.js";
 export * from "./models/auto-adjunct-key-check.js";

package/src/presentation/appointment-presentation.js

@@ -59,6 +59,9 @@ export const AppointmentPresentation = BaseModel.extend(
 const createFromAppointment = function (appointment, options) {
 	const appointmentPresentation = new AppointmentPresentation();
 
+	// Note that we're not passing through tags if appointment.tags is empty.
+	// This is because tags currently aren't available in the telepresenter
+	// bundle and we want to fall back on the model tags for now.
 	appointmentPresentation.presentation.decks.add(
 		appointment.deckversion_set.map((model, index) => {
 			return PresentationDeck.createFromDeckVersion(model, {
@@ -68,7 +71,7 @@ const createFromAppointment = function (appointment, options) {
 				sectionSelections: appointment.appointmentssection_set,
 				slideSelections: appointment.appointmentsslide_set,
 				index,
-				tags: appointment.tags.items,
+				appointmentTags: appointment.tags.length ? appointment.tags : null,
 				...options,
 			});
 		})

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

@@ -64,15 +64,60 @@ BasePresentationModel.getVisibilityAndSequence = function (
 	return config;
 };
 
+const getAppointmentTags = function (model, tags) {
+	const url = model.adjunct?.url() || model.url();
+	const tagItem = tags.find((tag) => tag.content_url === url);
+
+	if (tagItem) {
+		return tagItem.tags || [];
+	}
+
+	// Subslide tags currently aren't included in the
+	// appointmentTags data.
+	return model.tags || [];
+};
+
+const getDeckTags = function (model, tags) {
+	// All non-adjunct sections, slides and subslides have namespaced_key
+	if (model.namespaced_key) {
+		return tags[model.namespaced_key] || model.tags || [];
+	} else if (model.adjunct || model.isAutoAdjunct) {
+		// Autoadjunct keys are unique and move around so we search for them
+		// and ignore the rest of the namespaced key
+		const keys = Object.keys(tags).filter((key) => {
+			if (key.includes("/")) {
+				const splitKey = key.split("/");
+
+				return splitKey[splitKey.length - 1] === model.key;
+			}
+			return key === model.key;
+		});
+		return keys.length ? tags[keys[0]] : [];
+	} else if (model.deck) {
+		// The deck's namespaced key is always "" - this is because the
+		// namespaced key format is section-key/slide-key, but the
+		// deck sits above sections.
+		return tags[""] || model.tags || [];
+	}
+
+	return model.tags || [];
+};
+
+// Retrieve the tags for the model.
+// If appointmentTags is passed through in the options, we call the
+// getAppointmentTags function above to retrieve the appointment tags
+// for the model.
+// if there are no appointmentTags but deckTags are passed
+// through then we call the getDeckTags function.
+// In the future we will always use one of these two methods and
+// references to model.tags should be removed.
 BasePresentationModel.getTags = function (model, options = {}) {
-	if (options.tags) {
-		if (model.namespaced_key) {
-			return options.tags[model.namespaced_key] || [];
-		} else if (model.deck) {
-			return options.tags[""];
-		}
+	if (options.appointmentTags) {
+		return getAppointmentTags(model, options.appointmentTags);
+	}
 
-		return [];
+	if (options.deckTags) {
+		return getDeckTags(model, options.deckTags);
 	}
 
 	return model.tags || [];

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

@@ -137,14 +137,14 @@ describe("#getVisibilityAndSequence", () => {
 });
 
 describe("#getTags", () => {
-	it("should return empty array when no options or model.tags", () => {
+	it("should return empty array when no options or model tags", () => {
 		const tags = BasePresentationModel.getTags({});
 
 		expect(typeof tags).toEqual("object");
 		expect(tags.length).toEqual(0);
 	});
 
-	it("should return model.tags when no tags passed in options", () => {
+	it("should return tags when no tags passed in options", () => {
 		const model = {
 			tags: ["model-tag-1", "model-tag-2"],
 		};
@@ -153,14 +153,14 @@ describe("#getTags", () => {
 		expect(tags).toEqual(model.tags);
 	});
 
-	it("should return options.tags for slide when tags passed in options", () => {
+	it("should return tags for slide when tags passed in options", () => {
 		const model = {
 			namespaced_key: "slide-key",
 			tags: ["model-tag-1", "model-tag-2"],
 		};
 
 		const options = {
-			tags: {
+			deckTags: {
 				"": ["deck-tags"],
 				"slide-key": ["slide-tags"],
 			},
@@ -171,14 +171,14 @@ describe("#getTags", () => {
 		expect(tags).toEqual(["slide-tags"]);
 	});
 
-	it("should return options.tags[''] for welcome slide ", () => {
+	it("should return tags for welcome slide when tags passed in options", () => {
 		const model = {
 			deck: {},
 			tags: ["model-tag-1", "model-tag-2"],
 		};
 
 		const options = {
-			tags: {
+			deckTags: {
 				"": ["deck-tags"],
 				"slide-key": ["slide-tags"],
 			},
@@ -188,4 +188,42 @@ describe("#getTags", () => {
 
 		expect(tags).toEqual(["deck-tags"]);
 	});
+
+	it("should return tags for an adjunct section when tags passed in options", () => {
+		const model = {
+			adjunct: true,
+			key: "adjunctsection-key",
+			tags: ["old-tag-1", "old-tag-2"],
+		};
+
+		const options = {
+			deckTags: {
+				"": ["deck-tags"],
+				"adjunctsection-key": ["adjunctsection-tags"],
+			},
+		};
+
+		const tags = BasePresentationModel.getTags(model, options);
+
+		expect(tags).toEqual(["adjunctsection-tags"]);
+	});
+
+	it("should return tags for an adjunct slide when tags passed in options", () => {
+		const model = {
+			adjunct: true,
+			key: "adjunctslide-key",
+			tags: ["old-tag-1", "old-tag-2"],
+		};
+
+		const options = {
+			deckTags: {
+				"": ["deck-tags"],
+				"section-key/adjunctslide-key": ["adjunctslide-tags"],
+			},
+		};
+
+		const tags = BasePresentationModel.getTags(model, options);
+
+		expect(tags).toEqual(["adjunctslide-tags"]);
+	});
 });

package/src/presentation/presentation-deck.js

@@ -367,6 +367,7 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 		deckID: 1,
 		title: "Local",
 		version: 1,
+		tags: manifestJSON.tags[""] || [],
 	});
 
 	const usesImpostorSections = _.some(

package/src/presentation/presentation-section.js

@@ -206,7 +206,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 		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,
@@ -228,7 +228,7 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 PresentationSection.createFromAdjunctSection = function (
 	adjunctSectionModel,
 	deckVersionModel,
-	options
+	options = {}
 ) {
 	_.defaults(options, {
 		rootAssetPath: null,
@@ -251,6 +251,7 @@ PresentationSection.createFromAdjunctSection = function (
 		key = adjunctSectionModel.key;
 	} else if (keyID) {
 		key = `adjunct-${keyID}`;
+		adjunctSectionModel.key = key;
 	}
 
 	const config = PresentationSection.getVisibilityAndSequence(
@@ -258,6 +259,8 @@ PresentationSection.createFromAdjunctSection = function (
 		options
 	);
 
+	const tags = PresentationSection.getTags(adjunctSectionModel, options);
+
 	const section = new PresentationSection({
 		id: options.getUniqueAdjunctID(),
 		adjunct: adjunctSectionModel.adjunct
@@ -272,10 +275,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,
@@ -318,7 +319,7 @@ PresentationSection.createFromAdjunctSection = function (
 PresentationSection.createFromImpostorSection = function (
 	slideModel,
 	DeckVersionModel,
-	options
+	options = {}
 ) {
 	_.defaults(options, {
 		rootAssetPath: null,
@@ -363,7 +364,7 @@ PresentationSection.createFromImpostorSection = function (
 		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,
@@ -439,7 +440,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") {
@@ -456,6 +457,15 @@ PresentationSection.createFromAutoAdjunct = function (model, opts) {
 		impostor: false,
 	});
 
+	const tags = PresentationSection.getTags(
+		{
+			isAutoAdjunct: true,
+			key: model.key,
+			tags: model.tags,
+		},
+		options
+	);
+
 	const autoAdjunct = new AutoAdjunctModel(model);
 
 	const autoAdjunctSection = new PresentationSection({
@@ -477,6 +487,7 @@ PresentationSection.createFromAutoAdjunct = function (model, opts) {
 		allowConvert: options.allowConvert,
 		deckversion: options.deckversionID,
 		impostor: options.impostor,
+		tags,
 	});
 
 	if (autoAdjunct.template) {

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

@@ -0,0 +1,363 @@
+import { AdjunctSectionModel } from "../models/adjunct-section";
+import { AutoAdjunctModel } from "../models/auto-adjunct";
+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("#createFromAdjunctSection", () => {
+	const getAdjunctSectionJSON = () => {
+		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: 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,
+		};
+
+		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("#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("#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"]);
+	});
+});