@livepreso/api 6.53.0 → 6.54.0

package/src/collections/base.js

@@ -320,8 +320,19 @@ export const BaseCollection = Collection.extend(
 			return true;
 		},
 
-		serialize() {
-			const collection = Collection.prototype.serialize.call(this);
+		serialize(...args) {
+			// Don't use the base collection serialize so we can pass in
+			// arguments
+			const collection = this.map((model) => {
+				if (model.serialize) {
+					return model.serialize(...args);
+				} else {
+					const out = {};
+					_.assign(out, model);
+					delete out.collection;
+					return out;
+				}
+			});
 
 			if (_.isObject(this._data) && this._data.url && !collection.length) {
 				return this._data.url;

package/src/collections/base.spec.js

@@ -225,4 +225,41 @@ describe("fetchAll", () => {
 		expect(baseCollection.first().id).toEqual(11);
 		expect(baseCollection.last().id).toEqual(30);
 	});
+
+	it("should serialize collection models with urls", async () => {
+		G(BaseCollection.extend({ model: "TestModel" }), "TestCollection");
+		G(
+			BaseModel.extend({
+				modelName: "bar",
+				children: { test: "TestModel" },
+				collections: { tests: "TestCollection" },
+			}),
+			"TestModel",
+		);
+
+		const Collection = G(BaseCollection.extend({ model: "TestModel" }));
+		const baseCollection = new Collection([
+			{
+				id: 1,
+				url: "/api/bar/1/",
+				test: { id: 1, url: "/api/baz/1/" },
+				tests: [{ id: 2, test: { id: 4 } }],
+			},
+			{
+				id: 2,
+				url: "/api/bar/2/",
+				test: { id: 2, url: "/api/baz/2/" },
+				tests: [],
+			},
+		]);
+		expect(baseCollection.serialize({ urlsOnly: true })).toEqual([
+			{
+				id: 1,
+				test: "/api/bar/1/",
+				url: "/api/bar/1/",
+				tests: ["/api/bar/2/"],
+			},
+			{ id: 2, test: "/api/bar/2/", url: "/api/bar/2/", tests: [] },
+		]);
+	});
 });

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

@@ -242,7 +242,7 @@ export const BaseModel = Model.extend(
 		getIDFromURL(url, resource = "") {
 			const resourceURL = resource || this.getResourceURL();
 
-			if (!url || !resourceURL) {
+			if (typeof url !== "string" || !resourceURL) {
 				return null;
 			}
 
@@ -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);
 			}
 
@@ -693,6 +694,10 @@ export const BaseModel = Model.extend(
 				return {};
 			}
 
+			// Urls only will build a model without its children/collections expanded -
+			// it will return urls instead of the full model.
+			const { urlsOnly = false } = opts ?? {};
+
 			const data = Model.prototype.serialize.apply(this, arguments);
 			data.url = this.url();
 
@@ -706,24 +711,47 @@ export const BaseModel = Model.extend(
 				return object;
 			}, {});
 
-			Object.keys(this._unsetCollections).forEach((key) => {
-				if (this._unsetCollections[key].canBeEmpty && !this._values[key]) {
+			const allCollectionKeys = [
+				...Object.keys(this._unsetCollections),
+				...Object.keys(this._collections),
+			];
+
+			for (const key of allCollectionKeys) {
+				const constructor = this._unsetCollections[key];
+
+				if (urlsOnly && this[key]) {
+					if (typeof this._values[key] === "string") {
+						derived[key] = this._values[key];
+					} else {
+						derived[key] = this[key].map((m) => m.url());
+					}
+				} else if (!constructor) {
+					continue;
+				} else if (constructor.canBeEmpty && !this._values[key]) {
 					derived[key] = [];
 				}
-			});
+			}
 
-			Object.keys(this._unsetChildren).forEach((key) => {
-				if (
-					this._unsetChildren[key].canBeEmpty &&
-					!this._values[key] &&
-					this[key]
-				) {
+			const allChildrenKeys = [
+				...Object.keys(this._unsetChildren),
+				...(urlsOnly ? Object.keys(this._children) : []),
+			];
+
+			for (const key of allChildrenKeys) {
+				const constructor = this._unsetChildren[key];
+
+				if (urlsOnly && this[key]) {
+					derived[key] = this[key].url();
+				} else if (!constructor) {
+					continue;
+				} else if (constructor.canBeEmpty && !this._values[key] && this[key]) {
 					derived[key] = this[key].url();
 				}
-			});
+			}
 
 			return _.extend(data, derived);
 		},
+
 		// Safely retrieve the url from a child or collection that may or may not
 		// be hydrated
 		_retrieveURL(item) {

package/src/models/base.spec.js

@@ -426,3 +426,21 @@ describe(".matchesURL", () => {
 		expect(ActivityModel.matchesURL(url)).toEqual(true);
 	});
 });
+
+it("should allow serializing collections with urls only", () => {
+	G(BaseModel.extend({ modelName: "baz" }), "TestModel");
+	G(BaseCollection.extend({ model: "TestModel" }), "TestCollection");
+	const Model = G(
+		BaseModel.extend({ collections: { tests: "TestCollection" } }),
+	);
+	const model = new Model({
+		tests: [
+			{ id: 1, url: "/api/baz/1/" },
+			{ id: 2, url: "/api/baz/2/" },
+		],
+	});
+	expect(model.serialize({ urlsOnly: true })).toEqual({
+		url: null,
+		tests: ["/api/baz/1/", "/api/baz/2/"],
+	});
+});

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

@@ -141,7 +141,7 @@ export const DeckVersionModel = BaseModel.extend(
 						Object.keys(this.getSafeAttrs()).length === 1 ||
 						!this.index_asset
 					) {
-						return this.fetch();
+						return this.fetch({ fetchTemplates: false });
 					}
 					return null;
 				})
@@ -200,14 +200,17 @@ export const DeckVersionModel = BaseModel.extend(
 			return Promise.all(imports);
 		},
 
-		fetch() {
-			const fetch = BaseModel.prototype.fetch.apply(this, arguments);
+		fetch(opts, ...other) {
+			const fetch = BaseModel.prototype.fetch.apply(this, [opts, ...other]);
+			const shouldFetchTemplates = opts?.fetchTemplates ?? true;
 
 			return Promise.resolve(fetch).tap(() => {
 				// `template_set` used to come on the deckversion response, but we have since
 				// decided to request it separately (this helps with caching). To keep the app
 				// working with minimal changes, we're making the extra request here.
-				return this.template_set.fetch();
+				if (shouldFetchTemplates) {
+					return this.template_set.fetch();
+				}
 			});
 		},
 
@@ -222,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";