@livepreso/api 6.53.1 → 6.54.0

package/rush-logs/api.test.cache.log

@@ -0,0 +1 @@
+This project does not define the caching behavior of the "test" command, so caching has been disabled.

package/rush-logs/api.test.log

@@ -0,0 +1,21 @@
+Invoking: jest --coverage --coverageReporters=json 
+PASS src/utils.spec.js (13.424 s)
+PASS src/presentation/base-presentation-model.spec.js (13.213 s)
+PASS src/presentation/presentation-deck.spec.js (14.703 s)
+PASS src/presentation/presentation-slide.spec.js (14.567 s)
+PASS src/presentation/presentation-subslide.spec.js (15.257 s)
+PASS src/presentation/presentation-section.spec.js (17.21 s)
+PASS src/models/timing-log.spec.js (17.84 s)
+PASS src/models/snapshot.spec.js (7.978 s)
+PASS src/api.spec.js (8.053 s)
+PASS src/models/cms-val.spec.js (7.931 s)
+PASS src/models/base.spec.js (12.517 s)
+PASS src/auth.spec.js (9.993 s)
+PASS src/models/user.spec.js (8.741 s)
+PASS src/collections/base.spec.js (13.411 s)
+
+Test Suites: 14 passed, 14 total
+Tests:       144 passed, 144 total
+Snapshots:   0 total
+Time:        33.685 s
+Ran all test suites.

package/src/api.js

@@ -20,7 +20,7 @@ export const Api = {
 	 * @memberof api.Api
 	 * @prop {number} version
 	 */
-	version: 32,
+	version: 33,
 
 	/**
 	 * Initialize the api. Connects to the network and returns the

package/src/collections/auto-adjuncts.js

@@ -1,6 +1,5 @@
 import "../models/auto-adjunct.js";
 
-import Auth from "../auth.js";
 import { BaseCollection } from "./base.js";
 import { register } from "../state-register.js";
 
@@ -23,27 +22,6 @@ export const AutoAdjunctCollection = BaseCollection.extend(
 				},
 			});
 		},
-
-		fetch(opts = {}) {
-			const { user } = Auth;
-
-			if (!opts.data) {
-				opts.data = {};
-			}
-
-			// Let's only add this if it's not already being set, in case a global user
-			// DOES want to see a specific team.
-			if (!opts.data.team) {
-				//
-				// Filter all global autoadjuncts, and only query teams that
-				// the authorized user is a part of. This is mostly for the case where
-				// a 'global' temp slide admin could end up seeing autoadjuncts for
-				// many teams - which would be increadibly confusing.
-				opts.data.team = [null].concat(user.team_set.map((team) => team.id));
-			}
-
-			return BaseCollection.prototype.fetch.call(this, opts);
-		},
 	},
 );
 

package/src/collections/cms-vals.js

@@ -1,3 +1,4 @@
+import _ from "lodash";
 import "../models/cms-val.js";
 
 import Auth from "../auth.js";
@@ -43,4 +44,31 @@ export const CMSValCollection = BaseCollection.extend(
 
 CMSValCollection.canBeEmpty = true;
 
+CMSValCollection.getPrioritized = (cmsVals, tenancy = Auth.user.tenancy) => {
+	const cmsValsGroupedBySlides = _.groupBy(cmsVals, "key");
+
+	return _.map(cmsValsGroupedBySlides, (group) => {
+		const scenarioCmsVal = group.find((cmsValue) => !!cmsValue.scenario);
+
+		// The first cms val owned by the tenancy you're in
+		const tenancyStandardDeckCmsVal = group.find(
+			(cmsValue) =>
+				!cmsValue.scenario && cmsValue._tenancy?.owner_id === tenancy.id,
+		);
+
+		// The first cms val owned by the parent tenancy.
+		const parentTenancyStandardDeckCmsVal = group.find(
+			(cmsValue) =>
+				!cmsValue.scenario && cmsValue._tenancy?.owner_id !== tenancy.id,
+		);
+
+		// Order of preference: Scenario > Tenancy > Parent Tenancy
+		return (
+			scenarioCmsVal ||
+			tenancyStandardDeckCmsVal ||
+			parentTenancyStandardDeckCmsVal
+		);
+	});
+};
+
 register("CMSValCollection", CMSValCollection);

package/src/collections/cms-vals.spec.js

@@ -0,0 +1,66 @@
+import { CMSValCollection } from "./cms-vals.js";
+
+const childTenancy = { id: "66d7572f-85f6-4552-879a-25cf05ae311f" };
+const parentTenancy = { id: "cf5ad5a5-d149-42b4-b09b-e52b7afdf507" };
+const testScenarioURL =
+	"http://my/api/scenario/362bddc7-1821-4f43-921c-244e5c3175f7/";
+
+describe("#.getPrioritized", () => {
+	const scenarioCmsVal = {
+		id: 1,
+		key: "foo",
+		value: "Scenario",
+		scenario: testScenarioURL,
+		_tenancy: { owner_id: childTenancy.id },
+	};
+
+	const tenancyCmsVal = {
+		id: 2,
+		key: "foo",
+		value: "Tenancy",
+		scenario: testScenarioURL,
+		_tenancy: { owner_id: childTenancy.id },
+	};
+
+	const parentTenancyCmsVal = {
+		id: 3,
+		key: "foo",
+		value: "Parent Tenancy",
+		scenario: testScenarioURL,
+		_tenancy: { owner_id: parentTenancy.id },
+	};
+
+	const testFn = (cmsvals, tenancy) =>
+		CMSValCollection.getPrioritized(cmsvals, tenancy).filter(
+			(c) => c.key === "foo",
+		);
+
+	it("prefer scenario cmsval over others", () => {
+		const cmsvals = [scenarioCmsVal, tenancyCmsVal, parentTenancyCmsVal];
+		const results = testFn(cmsvals, childTenancy);
+		expect(results).toHaveLength(1);
+		expect(results[0].value).toEqual("Scenario");
+	});
+
+	it("prefer tenancy cmsval over others", () => {
+		const cmsvals = [
+			{ ...scenarioCmsVal, key: "bar" },
+			tenancyCmsVal,
+			parentTenancyCmsVal,
+		];
+		const results = testFn(cmsvals, childTenancy);
+		expect(results).toHaveLength(1);
+		expect(results[0].value).toEqual("Tenancy");
+	});
+
+	it("prefer global tenancy cmsval over others", () => {
+		const cmsvals = [
+			{ ...scenarioCmsVal, key: "bar" },
+			{ ...tenancyCmsVal, key: "baz" },
+			parentTenancyCmsVal,
+		];
+		const results = testFn(cmsvals, childTenancy);
+		expect(results).toHaveLength(1);
+		expect(results[0].value).toEqual("Parent Tenancy");
+	});
+});

package/src/collections/deck-version-screenshots.js

@@ -1,6 +1,5 @@
 import "../models/deck-version-screenshot.js";
 
-import Auth from "../auth.js";
 import { BaseCollection } from "./base.js";
 import { register } from "../state-register.js";
 
@@ -14,27 +13,6 @@ export const DeckVersionScreenshotCollection = BaseCollection.extend(
 	/** @lends collections.DeckVersionScreenshotCollection# */ {
 		model: "DeckVersionScreenshotModel",
 
-		fetch(opts = {}) {
-			const { user } = Auth;
-
-			if (!opts.data) {
-				opts.data = {};
-			}
-
-			// Let's only add this if it's not already being set, in case a global user
-			// DOES want to see a specific team.
-			if (user && !opts.data.team) {
-				//
-				// Filter all global autoadjuncts, and only query teams that
-				// the authorized user is a part of. This is mostly for the case where
-				// a 'global' temp slide admin could end up seeing autoadjuncts for
-				// many teams - which would be increadibly confusing.
-				opts.data.team = [null].concat(user.team_set.map((team) => team.id));
-			}
-
-			return BaseCollection.prototype.fetch.call(this, opts);
-		},
-
 		url() {
 			if (!this._url && this.parent) {
 				this._options.deckversion = this.parent;

package/src/collections/scenarios.js

@@ -0,0 +1,18 @@
+import "../models/scenario.js";
+
+import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias collections.ScenarioCollection
+ * @extends collections.BaseCollection
+ * @see models.ScenarioModel
+ */
+export const ScenarioCollection = BaseCollection.extend(
+	/** @lends collections.ScenarioCollection# */ {
+		model: "ScenarioModel",
+	},
+);
+
+register("ScenarioCollection", ScenarioCollection);

package/src/collections.js

@@ -26,6 +26,7 @@ export * from "./collections/opportunities";
 export * from "./collections/pack-diffs";
 export * from "./collections/packs";
 export * from "./collections/presets";
+export * from "./collections/scenarios";
 export * from "./collections/section-selections";
 export * from "./collections/sections";
 export * from "./collections/signing-backends";

package/src/fixtures.js

@@ -22,8 +22,24 @@ const presentationCollections = {
 	PresentationSubSlides: presentation.PresentationSubSlides,
 };
 
+function uuid() {
+	return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
+		const r = (Math.random() * 16) | 0;
+		const v = c === "x" ? r : (r & 0x3) | 0x8;
+		return v.toString(16);
+	});
+}
+
 function makeFactory(name, Model, ignoreFields = []) {
-	const factory = Factory.define(name, Model).sequence("id");
+	const factory = Factory.define(name, Model);
+	const { detailType } = Model.prototype;
+	if (detailType === "string" || detailType === "number") {
+		factory.sequence("id");
+	} else if (detailType === "uuid") {
+		factory.attr("id", () => uuid());
+	} else {
+		throw new Error("Unknown detailType " + detailType);
+	}
 
 	const { _definition: definition, _children: children } = Model.prototype;
 

package/src/models/appointment.js

@@ -3,6 +3,7 @@ import "./snapshot.js";
 import "./feed-data.js";
 import "./preset.js";
 import "./team.js";
+import "./scenario.js";
 import "./hosted-preso.js";
 import "./appointment-stats.js";
 import "./appointment-tags.js";
@@ -122,6 +123,8 @@ export const AppointmentModel = BaseModel.extend(
 		 * @property {models.SnapshotModel} latest_snapshot
 		 * @property {models.UserModel} user
 		 * @property {models.AppointmentStatsModel} appointmentStats
+		 * @property {models.ScenarioModel} scenario
+		 * @property {models.TeamModel} team_branding
 		 */
 		children: {
 			preset: "PresetModel",
@@ -130,7 +133,8 @@ export const AppointmentModel = BaseModel.extend(
 			user: "UserModel",
 			latest_tele: "HostedPresoModel",
 			stats: "AppointmentStatsModel",
-			team: "TeamModel",
+			scenario: "ScenarioModel",
+			team_branding: "TeamModel",
 		},
 
 		/**
@@ -273,6 +277,14 @@ export const AppointmentModel = BaseModel.extend(
 						this.adjunctSubSlides?.fetch(fetchOptions),
 						this.contact_set?.fetchSet(fetchOptions),
 						this.tags?.fetch(fetchOptions),
+						this.team_branding?.fetch(fetchOptions),
+						this.scenario?.fetch(fetchOptions)?.catch((e) => {
+							if (e.status === 404) {
+								this.scenario = null;
+								return;
+							}
+							throw e;
+						}),
 						this.user?.fetch(fetchOptions)?.catch((e) => {
 							if (e.status && e.status === 404) {
 								// It's possible for a user to be deactivated, which means they'll
@@ -318,16 +330,29 @@ export const AppointmentModel = BaseModel.extend(
 					return Promise.all(fetches);
 				})
 				.then(() => {
-					return Promise.all(
-						this.deckversion_set.map((model) => {
+					const scenarioID = this.scenario?.id ?? null;
+					const scenarioFilter = [null];
+					if (scenarioID) {
+						scenarioFilter.push(scenarioID);
+					}
+
+					return Promise.all([
+						this.scenario?.owner_team?.fetch?.(fetchOptions),
+						...this.deckversion_set.map((model) => {
 							return Promise.all([
-								model.screenshots.fetch(fetchOptions),
+								model.screenshots.fetch(
+									_.merge(fetchOptions, {
+										data: {
+											scenario: scenarioFilter,
+										},
+									}),
+								),
 								model.template_set.fetchSet(fetchOptions),
 								model.manifest_json.fetch(fetchOptions),
 								model.deck.fetch(fetchOptions),
 							]);
 						}),
-					);
+					]);
 				})
 				.then(() => {
 					const deckversionTemplates =
@@ -385,7 +410,8 @@ export const AppointmentModel = BaseModel.extend(
 				no_edit_after: appointment.no_edit_after,
 				no_share_after: appointment.no_share_after,
 				no_delete_after: appointment.no_delete_after,
-				team: this._retrieveURL(appointment.team),
+				scenario: this._retrieveURL(appointment.scenario),
+				team_branding: this._retrieveURL(appointment.team_branding),
 				editors_can_change_editors: appointment.editors_can_change_editors,
 				share_visibility_mode: appointment.share_visibility_mode,
 			};

package/src/models/auto-adjunct.js

@@ -1,5 +1,5 @@
 import "./template.js";
-import "./team.js";
+import "./scenario.js";
 import "./deck.js";
 
 import { BaseModel } from "./base.js";
@@ -49,11 +49,12 @@ export const AutoAdjunctModel = BaseModel.extend(
 		/**
 		 * @property {models.DeckModel} deck
 		 * @property {models.TemplateModel} template
+		 * @property {models.ScenarioModel} scenario
 		 */
 		children: {
 			deck: "DeckModel",
 			template: "TemplateModel",
-			team: "TeamModel",
+			scenario: "ScenarioModel",
 		},
 	},
 );

package/src/models/base.js

@@ -259,8 +259,9 @@ export const BaseModel = Model.extend(
 			}
 
 			const idStr = urlEnd.split(resourceEnd).join("");
-
-			if ((idStr.match(/\//g) || []).length === 1) {
+			if (this.detailType === "uuid") {
+				return idStr.slice(0, -1);
+			} else if ((idStr.match(/\//g) || []).length === 1) {
 				return parseInt(idStr.slice(0, -1), 10);
 			}
 

package/src/models/cms-val.js

@@ -1,5 +1,5 @@
 import "./user.js";
-import "./team.js";
+import "./scenario.js";
 import "./deck.js";
 
 import { BaseModel } from "../models/base.js";
@@ -28,12 +28,12 @@ export const CMSValModel = BaseModel.extend(
 		/**
 		 * @property {models.UserModel} user
 		 * @property {models.DeckModel} deck
-		 * @property {models.TeamModel} team
+		 * @property {models.ScenarioModel} scenario
 		 */
 		children: {
 			user: "UserModel",
 			deck: "DeckModel",
-			team: "TeamModel",
+			scenario: "ScenarioModel",
 		},
 
 		url() {

package/src/models/deck-version-screenshot.js

@@ -1,4 +1,4 @@
-import "./team.js";
+import "./scenario.js";
 
 import { BaseModel } from "./base.js";
 import _ from "lodash";
@@ -35,7 +35,7 @@ export const DeckVersionScreenshotModel = BaseModel.extend(
 		},
 
 		children: {
-			team: "TeamModel",
+			scenario: "ScenarioModel",
 		},
 
 		serialize() {

package/src/models/deck-version.js

@@ -225,13 +225,13 @@ export const DeckVersionModel = BaseModel.extend(
 			);
 		},
 
-		fetchLayout: function (presetId, teamIds) {
+		fetchLayout: function (presetId, scenarioID) {
 			let queryParams = { version: this.version };
 			if (presetId) {
 				queryParams.preset_id = presetId;
 			}
-			if (teamIds) {
-				queryParams.team_id = teamIds;
+			if (scenarioID) {
+				queryParams.scenario_id = scenarioID;
 			}
 
 			if (!this.id) {

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.js

@@ -42,6 +42,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, {

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);
 };