@livepreso/api 6.42.1 → 6.45.0

package/src/models/section.js

@@ -34,6 +34,7 @@ export const SectionModel = BaseModel.extend(
 		 * @property {string} title
 		 * @property {boolean} uploaded
 		 * @property {boolean} visible
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			adjunctslide_limit: "number",
@@ -62,6 +63,7 @@ export const SectionModel = BaseModel.extend(
 				type: "array",
 				default: () => [],
 			},
+			cmsvalkey_set: "array",
 		},
 
 		/**

package/src/models/slide.js

@@ -35,6 +35,7 @@ export const SlideModel = BaseModel.extend(
 		 * @property {boolean} uploaded
 		 * @property {boolean} visible
 		 * @property {array} tags
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			adjunctslide_limit: "number",
@@ -63,6 +64,7 @@ export const SlideModel = BaseModel.extend(
 				type: "array",
 				default: () => [],
 			},
+			cmsvalkey_set: "array",
 		},
 
 		/**

package/src/models/tag.js

@@ -0,0 +1,42 @@
+import "./user.js";
+import "./team.js";
+import "./deck.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.TagModel
+ * @extends models.BaseModel
+ */
+export const TagModel = BaseModel.extend(
+	/** @lends models.TagModel# */ {
+		modelName: "tags",
+
+		/**
+		 * @property {string} scope
+		 * @property {string} key
+		 * @property {string} description
+		 */
+		props: {
+			scope: "string",
+			key: "string",
+			description: "string",
+			visible: "boolean",
+		},
+
+		/**
+		 * @property {models.UserModel} user
+		 * @property {models.TeamModel} team
+		 * @property {models.DeckModel} deck
+		 */
+		children: {
+			user: "UserModel",
+			team: "TeamModel",
+			deck: "DeckModel",
+		},
+	}
+);
+
+register("TagModel", TagModel);

package/src/models/template.js

@@ -23,6 +23,7 @@ export const TemplateModel = BaseModel.extend(
 		 * @property {string} image_128
 		 * @property {string} image_256
 		 * @property {string} image_512
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			created_date: "date",
@@ -33,6 +34,7 @@ export const TemplateModel = BaseModel.extend(
 			image_128: "string",
 			image_256: "string",
 			image_512: "string",
+			cmsvalkey_set: "array",
 		},
 
 		/**

package/src/models/token.js

@@ -0,0 +1,47 @@
+import "./user.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.TokenModel
+ * @extends models.BaseModel
+ */
+export const TokenModel = BaseModel.extend(
+	/** @lends models.TokenModel# */ {
+		modelName: "tokens",
+
+		/**
+		 * @property {date} created_date
+		 * @property {boolean} expired
+		 * @property {date} expires_at
+		 * @property {string} key
+		 * @property {number} seconds_to_expiry
+		 * @property {string} agent
+		 * @property {string} agent_version
+		 */
+		props: {
+			created_date: "date",
+			expired: "boolean",
+			expires_at: "date",
+			key: "string",
+			seconds_to_expiry: "number",
+			agent: "string",
+			agent_version: "string",
+		},
+
+		/**
+		 * @property {models.UserModel} user
+		 */
+		children: {
+			user: "UserModel",
+		},
+
+		url() {
+			return `${this.urlRoot()}${this.key}/`;
+		},
+	}
+);
+
+register("TokenModel", TokenModel);

package/src/models/user.js

@@ -109,6 +109,8 @@ export const UserModel = BaseModel.extend(
 					const presets = {
 						canCreateCompanyPresets:
 							this.actions.indexOf("Manage Deck Presets") > -1,
+						canCreateTeamPresets:
+							this.actions.indexOf("Manage Team Presets") > -1,
 					};
 
 					const presomanager = {
@@ -155,6 +157,8 @@ export const UserModel = BaseModel.extend(
 							this.actions.indexOf("Allow Teamless Appointments") > -1,
 						canUseClosedCaptions:
 							this.actions.indexOf("Use Closed Captions") > -1,
+						canCreateMutedAppointments:
+							this.actions.indexOf("Create Muted Appointments") > -1,
 					};
 
 					const customers = {

package/src/models.js

@@ -17,7 +17,9 @@ 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/deck-version-screenshot";
 export * from "./models/dispatch";
 export * from "./models/dispatch-preview";
 export * from "./models/envs.js";
@@ -46,6 +48,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,7 +58,12 @@ 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";
 export * from "./models/transcribe-socket.js";
+export * from "./models/token.js";

package/src/presentation/appointment-presentation.js

@@ -5,7 +5,8 @@ import "../models/user.js";
 import "../collections/opportunities.js";
 import "../collections/contacts.js";
 
-import { AppointmentModel } from "../models.js";
+import { AppointmentModel, TeamModel } from "../models.js";
+
 import { BaseModel } from "../models/base.js";
 import { PresentationDeck } from "./presentation-deck.js";
 import { register } from "../state-register.js";
@@ -58,17 +59,27 @@ export const AppointmentPresentation = BaseModel.extend(
 
 const createFromAppointment = function (appointment, options) {
 	const appointmentPresentation = new AppointmentPresentation();
+	const team = appointment.team ? new TeamModel(appointment.team).id : null;
 
+	// 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) => {
+			const screenshots = PresentationDeck.filterScreenshotsByTeam(
+				model.screenshots,
+				team
+			);
+
 			return PresentationDeck.createFromDeckVersion(model, {
 				adjunctSections: appointment.adjunctSections,
 				adjunctSlides: appointment.adjunctSlides,
 				adjunctSubSlides: appointment.adjunctSubSlides,
 				sectionSelections: appointment.appointmentssection_set,
 				slideSelections: appointment.appointmentsslide_set,
+				appointmentTags: appointment.tags.length ? appointment.tags : null,
+				screenshots,
 				index,
-				tags: appointment.tags.items,
 				...options,
 			});
 		})

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

@@ -1,4 +1,7 @@
 import { BaseModel } from "../models/base.js";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
+import { TeamModel } from "../models/team.js";
+import _ from "lodash";
 
 /**
  * @constructor
@@ -13,6 +16,80 @@ export const BasePresentationModel = BaseModel.extend(
 	}
 );
 
+/**
+ * Logic to pick a thumbnail based on either the model itself or from
+ * and overriding screenshot if one exists.
+ */
+BasePresentationModel.getThumbnail = function (model, screenshots) {
+	const overrideScreenshot =
+		screenshots?.filter((screen) => {
+			return screen.subject === model.url();
+		}) ?? [];
+
+	if (overrideScreenshot.length) {
+		if (overrideScreenshot.length > 1) {
+			throw new Error(`
+				Found multiple screenshots that could match this subject. If there is a team
+				and a global, be sure to remove the screenshot that you don't need.
+			`);
+		}
+
+		return overrideScreenshot[0].image_256;
+	}
+
+	return model.image_256;
+};
+
+/**
+ * Takes a list of screenshots and filters it to only be a list used by a single team
+ * (or company wide).
+ *
+ * The logic should be like this:
+ *
+ *	* If the team is null, we just return all global screenshots (team = null)
+ *	* If we select a team, we take those global screenshots and replace any that have a
+ *		team specific version of that screenshot. If none is found, the team will want to
+ *		see the same global version. Obviously only one team's screenshots should be available.
+ */
+BasePresentationModel.filterScreenshotsByTeam = function (
+	_screenshots,
+	_team = null
+) {
+	const screenshots = new DeckVersionScreenshotCollection(_screenshots);
+	const team = _team ? new TeamModel(_team) : null;
+
+	const globalScreenshots = screenshots
+		.filter((screen) => screen.team === null)
+		.map((screen) => screen.toJSON());
+
+	const result = globalScreenshots;
+
+	if (team) {
+		const teamScreenshots = screenshots
+			.filter((screen) => screen.team && screen.team.url() === team.url())
+			.map((screen) => ({ ...screen.toJSON(), team: screen.team.url() }));
+
+		for (const teamScreen of teamScreenshots) {
+			const existingGlobalIndex = _.findIndex(result, {
+				subject: teamScreen.subject,
+			});
+
+			if (existingGlobalIndex === -1) {
+				// If there isn't an existing global version, just add the team
+				// screenshot to the list
+				result.push(teamScreen);
+			} else {
+				// Otherwise we should use the team version instead of the global version
+				result[existingGlobalIndex] = teamScreen;
+			}
+		}
+	}
+
+	// Try to return it in the same order every time
+	const ordered = _.orderBy(result, ["team", "subject"], ["desc", "asc"]);
+	return new DeckVersionScreenshotCollection(ordered);
+};
+
 /**
  * Standard function for retrieving the visibility and sequence of a model
  * from a choicelist or section & slide selections. If a choicelist is
@@ -20,7 +97,6 @@ export const BasePresentationModel = BaseModel.extend(
  * Adjuncts are included in choicelists but not in selections so we use the
  * model's state to determine sequence & vis when selections are used.
  */
-
 BasePresentationModel.getVisibilityAndSequence = function (
 	model,
 	options = {}
@@ -64,15 +140,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

@@ -1,4 +1,5 @@
 import { BasePresentationModel } from "./base-presentation-model.js";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
 
 describe("#getVisibilityAndSequence", () => {
 	it("should return model defaults when no options", () => {
@@ -137,14 +138,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 +154,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 +172,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 +189,118 @@ 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"]);
+	});
+});
+
+describe("#filterScreenshotsByTeam", () => {
+	const screenshots = new DeckVersionScreenshotCollection([
+		{
+			subject: "/api/slides/1/",
+			image_256: "global-screenshot-1.png",
+			team: null,
+		},
+		{
+			subject: "/api/slides/2/",
+			image_256: "global-screenshot-2.png",
+			team: null,
+		},
+		{
+			subject: "/api/slides/1/",
+			image_256: "team-1-screenshot.png",
+			team: "/api/teams/1/",
+		},
+		{
+			subject: "/api/sections/2/",
+			image_256: "team-1-screenshot.png",
+			team: "/api/teams/1/",
+		},
+		// Just for testing that the team filters don't get cross-contaminated
+		{
+			subject: "/api/sections/2/",
+			image_256: "team-2-screenshot.png",
+			team: "/api/teams/2/",
+		},
+	]);
+
+	it("should just return global screenshots if team is null", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+			screenshots,
+			null
+		).toJSON();
+
+		expect(filtered).toEqual([
+			{
+				subject: "/api/slides/1/",
+				image_256: "global-screenshot-1.png",
+				team: null,
+			},
+			{
+				subject: "/api/slides/2/",
+				image_256: "global-screenshot-2.png",
+				team: null,
+			},
+		]);
+	});
+
+	it("should return globals with team override", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+			screenshots,
+			1
+		).toJSON();
+
+		expect(filtered).toEqual([
+			{
+				image_256: "global-screenshot-2.png",
+				subject: "/api/slides/2/",
+				team: null,
+			},
+			{
+				image_256: "team-1-screenshot.png",
+				subject: "/api/sections/2/",
+				team: "/api/teams/1/",
+			},
+			{
+				image_256: "team-1-screenshot.png",
+				subject: "/api/slides/1/",
+				team: "/api/teams/1/",
+			},
+		]);
+	});
 });

package/src/presentation/presentation-deck.js

@@ -41,6 +41,7 @@ export const PresentationDeck = BasePresentationModel.extend(
 		 * @property {boolean} editable
 		 * @property {array} tags
 		 * @property {number} version
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			html: "string",
@@ -57,6 +58,7 @@ export const PresentationDeck = BasePresentationModel.extend(
 			editable: "boolean",
 			tags: "array",
 			version: "number",
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -109,11 +111,13 @@ PresentationDeck.createFromDeckVersion = function (
 ) {
 	_.defaults(options, {
 		index: 0,
+		autoAdjuncts: new collections.AutoAdjunctCollection(),
 		adjunctSections: new collections.AdjunctSectionCollection(),
 		adjunctSlides: new collections.AdjunctSlideCollection(),
 		adjunctSubSlides: new collections.AdjunctSubSlideCollection(),
 		sectionSelections: new collections.SectionSelectionCollection(),
 		slideSelections: new collections.SlideSelectionCollection(),
+		screenshots: new collections.DeckVersionScreenshotCollection(),
 		rootAssetPath: null,
 		templates: null,
 		choicelist: null,
@@ -138,7 +142,10 @@ PresentationDeck.createFromDeckVersion = function (
 		css,
 		id: deckVersionModel.id,
 		index: options.index,
-		thumbnail: deckVersionModel.image_256,
+		thumbnail: PresentationDeck.getThumbnail(
+			deckVersionModel,
+			options.screenshots
+		),
 		deckID: deckVersionModel.deck.id,
 		visible: true,
 		key: deckVersionModel.deck.key,
@@ -148,6 +155,7 @@ PresentationDeck.createFromDeckVersion = function (
 		tags,
 		version: deckVersionModel.version,
 		usesImpostorSections: isImpostorDeck(deckVersionModel),
+		cmsvalkey_set: deckVersionModel.cmsvalkey_set || [],
 	});
 
 	if (!deck.key) {
@@ -342,13 +350,41 @@ PresentationDeck.createFromDeckVersion = function (
 			options.templates.map((template, index) => {
 				return PresentationSection.createFromTemplate(
 					template,
-					index,
+					deck.sections.length + index,
 					options.getUniqueAdjunctID()
 				);
 			})
 		);
 	}
 
+	// This is generally only used by screenshots
+	if (options.autoAdjuncts) {
+		const autoSections = options.autoAdjuncts.map((auto, index) => {
+			// We already have the template on the deckversion, so we can find it here.
+			if (!auto.template) {
+				throw new Error(
+					"Attempted to use an autoadjunct that has no template."
+				);
+			}
+
+			const section = PresentationSection.createFromTemplate(
+				auto.template,
+				deck.sections.length + index,
+				options.getUniqueAdjunctID()
+			);
+
+			// We've just borrowed the "from template" method above. We want to add
+			// back some of the specific keys about the auto.
+			section.autoAdjunctID = auto.id;
+			section.key = auto.key;
+			section.title = auto.name;
+
+			return section;
+		});
+
+		deck.sections.add(autoSections);
+	}
+
 	setSequentialSequences(deck);
 
 	return deck;
@@ -367,6 +403,8 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 		deckID: 1,
 		title: "Local",
 		version: 1,
+		tags: manifestJSON.tags[""] || [],
+		cmsvalkey_set: [],
 	});
 
 	const usesImpostorSections = _.some(
@@ -390,6 +428,7 @@ PresentationDeck.createFromManifestJSON = function (manifestJSON) {
 				css: url2.resolve(manifestJSON.getAssetPath(key), "slide.css"),
 				title: manifestJSON.titles[key],
 				tags: manifestJSON.tags[key] || [],
+				cmsvalkey_set: [],
 			};
 		});