@livepreso/api 6.53.1 → 6.55.0

package/src/models/preset.js

@@ -1,6 +1,7 @@
 import "./user.js";
 import "./deck.js";
 import "./team.js";
+import "./scenario.js";
 
 import { BaseModel } from "./base.js";
 import { register } from "../state-register.js";
@@ -36,13 +37,14 @@ export const PresetModel = BaseModel.extend(
 		/**
 		 * @property {models.UserModel} user
 		 * @property {models.DeckModel} deck
-		 * @property {models.TeamModel} team
+		 * @property {models.TeamMode} team
+		 * @property {models.ScenarioMode} keylist_scenario
 		 */
 		children: {
 			user: "UserModel",
 			deck: "DeckModel",
 			team: "TeamModel",
-			keylist_team: "TeamModel",
+			keylist_scenario: "ScenarioModel",
 		},
 
 		toServer() {
@@ -66,10 +68,10 @@ export const PresetModel = BaseModel.extend(
 			if (teamURL) {
 				data.team = teamURL;
 			}
-			const keylistTeamURL = this._retrieveURL(this.keylist_team);
+			const keylistScenarioURL = this._retrieveURL(this.keylist_scenario);
 
-			if (keylistTeamURL) {
-				data.keylist_team = keylistTeamURL;
+			if (keylistScenarioURL) {
+				data.keylist_scenario = keylistScenarioURL;
 			}
 
 			return data;
@@ -79,6 +81,6 @@ export const PresetModel = BaseModel.extend(
 
 PresetModel.USER_VISIBILITY = "__user__";
 PresetModel.GLOBAL_VISIBILITY = "__global__";
-PresetModel.STANDARD_SLIDE_SOURCE = "__standard__";
+PresetModel.STANDARD_DECK = "__standard__";
 
 register("PresetModel", PresetModel);

package/src/models/scenario.js

@@ -0,0 +1,39 @@
+import _ from "lodash";
+import "./team.js";
+import "./deck.js";
+
+import { register } from "../state-register.js";
+import { BaseModel } from "../models/base.js";
+
+/**
+ * @constructor
+ * @alias models.ScenarioModel
+ * @extends models.BaseModel
+ */
+export const ScenarioModel = BaseModel.extend(
+	/** @lends models.ScenarioModel# */ {
+		modelName: "scenarios",
+		detailType: "uuid",
+
+		props: {
+			name: "string",
+			must_use_with_preset_for_this_scenario: "boolean",
+			can_use_personal_presets: "boolean",
+		},
+
+		/**
+		 * @property {models.DeckModel} deck
+		 * @property {models.TeamModel} owner_team
+		 */
+		children: {
+			deck: "DeckModel",
+			owner_team: "TeamModel",
+		},
+
+		toServer() {
+			return _.omit(this.serialize({ urlsOnly: true }), ["url"]);
+		},
+	},
+);
+
+register("ScenarioModel", ScenarioModel);

package/src/models/user.js

@@ -117,17 +117,23 @@ export const UserModel = BaseModel.extend(
 					};
 
 					const presomanager = {
+						// Can create or delete slides
 						isGlobalTemporarySlideManager:
 							this.actions.indexOf("Manage Temporary Slides") > -1,
 						isTeamTemporarySlideManager:
 							this.actions.indexOf("Manage Team Temporary Slides") > -1,
 
+						// Can update content within a slide (text, images, etc.)
+						isContentAdmin: this.actions.indexOf("Administer Content") > -1,
 						isTeamContentManager:
 							this.actions.indexOf("Manage Team Editable Text") > -1,
-						isContentCreator: this.actions.indexOf("Create Content") > -1,
 
 						canAddGlobalNotes: this.actions.indexOf("Manage Notes") > -1,
 						canAddTeamNotes: this.actions.indexOf("Manage Team Notes") > -1,
+
+						// This is someone that uses the CDK/publishes content, not someone
+						// that edits content.
+						isContentCreator: this.actions.indexOf("Create Content") > -1,
 					};
 
 					presomanager.canModifyNotes =
@@ -139,6 +145,7 @@ export const UserModel = BaseModel.extend(
 
 					presomanager.isPresoManagerUser =
 						presomanager.canModifyTemporarySlides ||
+						presomanager.canModifyNotes ||
 						presomanager.canModifyContent;
 
 					presomanager.canModifyContent =

package/src/models.js

@@ -21,6 +21,7 @@ export * from "./models/deck";
 export * from "./models/deck-tags";
 export * from "./models/deck-version";
 export * from "./models/deck-version-screenshot";
+export * from "./models/deck-layout";
 export * from "./models/dispatch";
 export * from "./models/dispatch-preview";
 export * from "./models/envs.js";
@@ -42,6 +43,7 @@ export * from "./models/preset";
 export * from "./models/refresh-request";
 export * from "./models/room";
 export * from "./models/salesforce-lookup.js";
+export * from "./models/scenario";
 export * from "./models/section";
 export * from "./models/section-selection";
 export * from "./models/signing-backend";

package/src/presentation/appointment-presentation.js

@@ -5,7 +5,7 @@ import "../models/user.js";
 import "../collections/opportunities.js";
 import "../collections/contacts.js";
 
-import { AppointmentModel, TeamModel } from "../models.js";
+import { AppointmentModel, ScenarioModel } from "../models.js";
 
 import { BaseModel } from "../models/base.js";
 import { PresentationDeck } from "./presentation-deck.js";
@@ -59,16 +59,18 @@ export const AppointmentPresentation = BaseModel.extend(
 
 const createFromAppointment = function (appointment, options) {
 	const appointmentPresentation = new AppointmentPresentation();
-	const team = appointment.team ? new TeamModel(appointment.team).id : null;
+	const scenario = appointment.scenario
+		? new ScenarioModel(appointment.scenario).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(
+			const screenshots = PresentationDeck.filterScreenshotsByScenario(
 				model.screenshots,
-				team,
+				scenario,
 			);
 
 			return PresentationDeck.createFromDeckVersion(model, {
@@ -80,6 +82,7 @@ const createFromAppointment = function (appointment, options) {
 				appointmentTags: appointment.tags.length ? appointment.tags : null,
 				screenshots,
 				index,
+				rootAssetPath: options?.rootAssetPath ?? null,
 				...options,
 			});
 		}),

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

@@ -1,6 +1,6 @@
 import { BaseModel } from "../models/base.js";
 import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
-import { TeamModel } from "../models/team.js";
+import { ScenarioModel } from "../models/scenario.js";
 import _ from "lodash";
 
 /**
@@ -24,7 +24,7 @@ BasePresentationModel.screenshotsToMap = function (screenshots) {
 	return screenshots.reduce((result, model) => {
 		if (result[model.subject]) {
 			throw new Error(`
-				Found multiple screenshots that could match this subject. If there is a team
+				Found multiple screenshots that could match this subject. If there is a scenario
 				and a global, be sure to remove the screenshot that you don't need.
 			`);
 		}
@@ -50,52 +50,58 @@ BasePresentationModel.getThumbnail = function (model, screenshots) {
 };
 
 /**
- * Takes a list of screenshots and filters it to only be a list used by a single team
+ * Takes a list of screenshots and filters it to only be a list used by a single scenario
  * (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.
+ *	* If the scenario is null, we just return all global screenshots (scenario = null)
+ *	* If we select a scenario, we take those global screenshots and replace any that have a
+ *		scenario specific version of that screenshot. If none is found, the
+ *		scenario will want to see the same global version. Obviously only one
+ *		scenario's screenshots should be available.
  */
-BasePresentationModel.filterScreenshotsByTeam = function (
+BasePresentationModel.filterScreenshotsByScenario = function (
 	_screenshots,
-	_team = null,
+	_scenario = null,
 ) {
 	const screenshots = new DeckVersionScreenshotCollection(_screenshots);
-	const team = _team ? new TeamModel(_team) : null;
+	const scenario = _scenario ? new ScenarioModel({ id: _scenario }) : null;
 
 	const globalScreenshots = screenshots
-		.filter((screen) => screen.team === null)
+		.filter((screen) => screen.scenario === 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) {
+	if (scenario) {
+		const scenarioScreenshots = screenshots
+			.filter(
+				(screen) => screen.scenario && screen.scenario.url() === scenario.url(),
+			)
+			.map((screen) => ({
+				...screen.toJSON(),
+				scenario: screen.scenario.url(),
+			}));
+
+		for (const scenarioScreen of scenarioScreenshots) {
 			const existingGlobalIndex = _.findIndex(result, {
-				subject: teamScreen.subject,
+				subject: scenarioScreen.subject,
 			});
 
 			if (existingGlobalIndex === -1) {
-				// If there isn't an existing global version, just add the team
+				// If there isn't an existing global version, just add the scenario
 				// screenshot to the list
-				result.push(teamScreen);
+				result.push(scenarioScreen);
 			} else {
-				// Otherwise we should use the team version instead of the global version
-				result[existingGlobalIndex] = teamScreen;
+				// Otherwise we should use the scenario version instead of the global version
+				result[existingGlobalIndex] = scenarioScreen;
 			}
 		}
 	}
 
 	// Try to return it in the same order every time
-	const ordered = _.orderBy(result, ["team", "subject"], ["desc", "asc"]);
+	const ordered = _.orderBy(result, ["scenario", "subject"], ["desc", "asc"]);
 	return new DeckVersionScreenshotCollection(ordered);
 };
 

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

@@ -229,38 +229,38 @@ describe("#getTags", () => {
 	});
 });
 
-describe("#filterScreenshotsByTeam", () => {
+describe("#filterScreenshotsByScenario", () => {
 	const screenshots = new DeckVersionScreenshotCollection([
 		{
 			subject: "/api/slides/1/",
 			image_256: "global-screenshot-1.png",
-			team: null,
+			scenario: null,
 		},
 		{
 			subject: "/api/slides/2/",
 			image_256: "global-screenshot-2.png",
-			team: null,
+			scenario: null,
 		},
 		{
 			subject: "/api/slides/1/",
-			image_256: "team-1-screenshot.png",
-			team: "/api/teams/1/",
+			image_256: "scenario-1-screenshot.png",
+			scenario: "/api/scenarios/50465ccb-8887-4e1c-bb01-84c91a58c7ea/",
 		},
 		{
 			subject: "/api/sections/2/",
-			image_256: "team-1-screenshot.png",
-			team: "/api/teams/1/",
+			image_256: "scenario-1-screenshot.png",
+			scenario: "/api/scenarios/50465ccb-8887-4e1c-bb01-84c91a58c7ea/",
 		},
-		// Just for testing that the team filters don't get cross-contaminated
+		// Just for testing that the scenario filters don't get cross-contaminated
 		{
 			subject: "/api/sections/2/",
-			image_256: "team-2-screenshot.png",
-			team: "/api/teams/2/",
+			image_256: "scenario-2-screenshot.png",
+			scenario: "/api/scenarios/9d35f335-efe7-4e5b-8365-f2afa229469d/",
 		},
 	]);
 
-	it("should just return global screenshots if team is null", () => {
-		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+	it("should just return global screenshots if scenario is null", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByScenario(
 			screenshots,
 			null,
 		).toJSON();
@@ -269,37 +269,37 @@ describe("#filterScreenshotsByTeam", () => {
 			{
 				subject: "/api/slides/1/",
 				image_256: "global-screenshot-1.png",
-				team: null,
+				scenario: null,
 			},
 			{
 				subject: "/api/slides/2/",
 				image_256: "global-screenshot-2.png",
-				team: null,
+				scenario: null,
 			},
 		]);
 	});
 
-	it("should return globals with team override", () => {
-		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+	it("should return globals with scenario override", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByScenario(
 			screenshots,
-			1,
+			"50465ccb-8887-4e1c-bb01-84c91a58c7ea",
 		).toJSON();
 
 		expect(filtered).toEqual([
 			{
 				image_256: "global-screenshot-2.png",
 				subject: "/api/slides/2/",
-				team: null,
+				scenario: null,
 			},
 			{
-				image_256: "team-1-screenshot.png",
+				image_256: "scenario-1-screenshot.png",
 				subject: "/api/sections/2/",
-				team: "/api/teams/1/",
+				scenario: "/api/scenarios/50465ccb-8887-4e1c-bb01-84c91a58c7ea/",
 			},
 			{
-				image_256: "team-1-screenshot.png",
+				image_256: "scenario-1-screenshot.png",
 				subject: "/api/slides/1/",
-				team: "/api/teams/1/",
+				scenario: "/api/scenarios/50465ccb-8887-4e1c-bb01-84c91a58c7ea/",
 			},
 		]);
 	});

package/src/presentation/presentation-deck.js

@@ -60,6 +60,9 @@ export const PresentationDeck = BasePresentationModel.extend(
 			title: "string",
 			usesImpostorSections: "boolean",
 			editable: "boolean",
+			titleEditable: "boolean",
+			notesEditable: "boolean",
+			tagsEditable: "boolean",
 			tags: "array",
 			version: "number",
 			namespacedKey: "string",
@@ -159,6 +162,9 @@ PresentationDeck.createFromDeckVersion = function (
 		common: deckVersionModel.manifest_json.common,
 		title: deckVersionModel.deck.title,
 		editable: tags.indexOf("editable") > -1,
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		tags,
 		version: deckVersionModel.version,
 		usesImpostorSections: isImpostorDeck(deckVersionModel),

package/src/presentation/presentation-section.js

@@ -49,7 +49,10 @@ export const PresentationSection = BasePresentationModel.extend(
 		 * @property {boolean} visible
 		 * @property {number} deckversion
 		 * @property {number} selectionID
-		 * @property {boolean} editable
+		 * @property {bool} editable
+		 * @property {bool} titleEditable
+		 * @property {bool} notesEditable
+		 * @property {bool} tagsEditable
 		 * @property {array} tags
 		 * @property {boolean} impostor
 		 * @property {boolean} isWelcome
@@ -94,6 +97,9 @@ export const PresentationSection = BasePresentationModel.extend(
 			deckversion: "number",
 			selectionID: "number",
 			editable: "boolean",
+			titleEditable: "boolean",
+			notesEditable: "boolean",
+			tagsEditable: "boolean",
 			tags: "array",
 			impostor: "boolean",
 			isWelcome: {
@@ -226,6 +232,11 @@ PresentationSection.createFromSection = function (sectionModel, options = {}) {
 		title: sectionModel.title,
 		deckversion: sectionModel.deckversion.id,
 		editable: tags.indexOf("editable") > -1,
+		// By default this is true for a deck slide. These can be changed later in PM depending
+		// on the logged in user and properties of an AutoAdjunct
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		tags,
 		index: config.sequence,
 		sequence: config.sequence,
@@ -304,6 +315,9 @@ PresentationSection.createFromAdjunctSection = function (
 		title: adjunctSectionModel.title,
 		deckversion: deckVersionModel.id,
 		editable: false,
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		index: config.sequence,
 		sequence: config.sequence,
 		visible: config.visible,
@@ -404,6 +418,9 @@ PresentationSection.createFromImpostorSection = function (
 		title: slideModel.title,
 		deckversion: slideModel.section.deckversion.id,
 		editable: tags.indexOf("editable") > -1,
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		tags,
 		index: config.sequence,
 		sequence: config.sequence,
@@ -554,6 +571,10 @@ PresentationSection.createFromAutoAdjunct = function (model, opts = {}) {
 		tags,
 		cmsvalkey_set: autoAdjunct.cmsvalkey_set,
 		namespacedKey: autoAdjunct.namespaced_key,
+		editable: true,
+		titleEditable: true,
+		notesEditable: true,
+		tagsEditable: true,
 	});
 
 	if (autoAdjunct.template) {
@@ -608,6 +629,10 @@ PresentationSection.createFromTemplate = function (template, index, minID = 0) {
 		index,
 		cmsvalkey_set: [],
 		namespacedKey: templateModel.namespaced_key,
+		editable: false,
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 	});
 
 	return presentationSection;

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

@@ -56,6 +56,9 @@ describe("#createFromSection", () => {
 			custom: false,
 			deckversion: 408,
 			editable: false,
+			titleEditable: false,
+			notesEditable: true,
+			tagsEditable: true,
 			html: "https://staging-test-cdn.salespreso.com/media/pack/409/assets/sections/agenda/index.html",
 			id: 1728,
 			impostor: false,
@@ -184,7 +187,6 @@ describe("#createFromAdjunctSection", () => {
 			createdByTemplate: false,
 			custom: false,
 			deckversion: 1,
-			editable: false,
 			id: 1,
 			image:
 				"https://staging-test-cdn.salespreso.com/media/autoadjunct/123.png",
@@ -204,6 +206,10 @@ describe("#createFromAdjunctSection", () => {
 			url: "/api/adjunctsections/1737/",
 			visible: true,
 			cmsvalkey_set: [],
+			editable: false,
+			titleEditable: false,
+			notesEditable: true,
+			tagsEditable: true,
 		};
 
 		expect(presentationSection.toJSON()).toEqual(expected);
@@ -312,6 +318,9 @@ describe("#createFromImpostorSection", () => {
 			custom: false,
 			deckversion: 3,
 			editable: false,
+			titleEditable: false,
+			notesEditable: true,
+			tagsEditable: true,
 			html: "https://staging-test-cdn.salespreso.com/media/pack/427/assets/sections/test-deck/slides/agenda/index.html",
 			id: 23898,
 			impostor: true,
@@ -441,6 +450,10 @@ describe("#createFromAutoAdjunct", () => {
 			title: "Five",
 			url: "/api/adjunctsections/545/",
 			visible: true,
+			editable: true,
+			titleEditable: true,
+			tagsEditable: true,
+			notesEditable: true,
 		};
 		expect(presentationSection.toJSON()).toEqual(expected);
 	});

package/src/presentation/presentation-slide.js

@@ -41,6 +41,9 @@ export const PresentationSlide = BasePresentationModel.extend(
 		 * @property {string} thumbnail
 		 * @property {number} selectionID
 		 * @property {bool} editable
+		 * @property {bool} titleEditable
+		 * @property {bool} notesEditable
+		 * @property {bool} tagsEditable
 		 * @property {array} tags
 		 * @property {string[]} cmsvalkey_set
 		 */
@@ -80,6 +83,9 @@ export const PresentationSlide = BasePresentationModel.extend(
 			thumbnail: "string",
 			selectionID: "number",
 			editable: "boolean",
+			titleEditable: "boolean",
+			notesEditable: "boolean",
+			tagsEditable: "boolean",
 			tags: "array",
 			cmsvalkey_set: "array",
 		},
@@ -170,6 +176,11 @@ PresentationSlide.createFromSlide = function (slideModel, options = {}) {
 		thumbnail: PresentationSlide.getThumbnail(slideModel, options.screenshots),
 		custom: false,
 		editable: tags.indexOf("editable") > -1,
+		// By default this is true for a deck slide. These can be changed later in PM depending
+		// on the logged in user and properties of an AutoAdjunct
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		title: slideModel.title,
 		section: slideModel.section.id,
 		sectionKey: slideModel.section.key,
@@ -358,6 +369,9 @@ PresentationSlide.createFromManifestJSON = function (
 		css: url2.resolve(manifestJSON.getAssetPath(key), "slide.css"),
 		key: slideKey,
 		editable: false,
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		sequence: manifestJSON.ordering[key],
 		thumbnail: null,
 		custom: false,
@@ -387,6 +401,9 @@ PresentationSlide.createFromManifestImpostor = function (
 	const presentationSlide = new PresentationSlide({
 		id: parseInt(_.uniqueId(), 10),
 		editable: slide.tags.indexOf("editable") !== -1,
+		titleEditable: false,
+		notesEditable: true,
+		tagsEditable: true,
 		thumbnail: null,
 		custom: false,
 		visible: true,
@@ -409,6 +426,9 @@ PresentationSlide.createFromTemplate = function (
 		...template,
 		id: minID + parseInt(_.uniqueId(), 10),
 		editable: false,
+		titleEditable: false,
+		notesEditable: false,
+		tagsEditable: false,
 		thumbnail: null,
 		custom: false,
 		visible: true,
@@ -479,6 +499,10 @@ PresentationSlide.createFromAutoAdjunct = function (model, opts = {}) {
 		tags,
 		cmsvalkey_set: autoAdjunct.cmsvalkey_set,
 		namespacedKey: autoAdjunct.namespaced_key,
+		editable: true,
+		titleEditable: true,
+		notesEditable: true,
+		tagsEditable: true,
 	});
 
 	if (autoAdjunct.template) {

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

@@ -46,6 +46,9 @@ describe("#createFromSlide", () => {
 			css: "https://staging-test-cdn.salespreso.com/media/pack/410/assets/sections/test-deck/slides/slide-key/slide.css",
 			custom: false,
 			editable: false,
+			titleEditable: false,
+			tagsEditable: true,
+			notesEditable: true,
 			html: "https://staging-test-cdn.salespreso.com/media/pack/410/assets/sections/test-deck/slides/slide-key/index.html",
 			id: 23219,
 			index: 13,
@@ -294,6 +297,10 @@ describe("#createFromAutoAdjunct", () => {
 			title: "Three",
 			url: "/api/adjunctslides/525/",
 			visible: true,
+			editable: true,
+			titleEditable: true,
+			notesEditable: true,
+			tagsEditable: true,
 		};
 
 		expect(presentationSlide.toJSON()).toEqual(expected);