@livepreso/api 6.44.0 → 6.46.0

package/src/models/snapshot.js

@@ -2,6 +2,7 @@ import "./appointment.js";
 
 import { BaseModel } from "./base.js";
 import { register } from "../state-register.js";
+import { sanitizeBase64 } from "../utils.js";
 
 /**
  * @constructor
@@ -19,6 +20,7 @@ export const SnapshotModel = BaseModel.extend(
 		props: {
 			context: "object",
 			creation_status: "string",
+			force_requires_capture: "boolean",
 		},
 
 		/**
@@ -30,17 +32,24 @@ export const SnapshotModel = BaseModel.extend(
 
 		toServer() {
 			const data = {
-				context: JSON.stringify(this.context),
+				context: JSON.stringify(
+					// If this is a base64 string, and it's sufficiently long enough that it'll
+					// cause issues if we save it, let's just remove it. Better that it can save.
+					sanitizeBase64(this.context, (obj) => obj.length > 50_000),
+				),
 				appointment: this._retrieveURL(this.appointment),
 			};
 
+			if (typeof this.force_requires_capture !== "undefined") {
+				data.force_requires_capture = this.force_requires_capture;
+			}
 			if (this.id) {
 				data.id = this.id;
 			}
 
 			return data;
 		},
-	}
+	},
 );
 
 register("SnapshotModel", SnapshotModel);

package/src/models/snapshot.spec.js

@@ -0,0 +1,31 @@
+import { G } from "sp-test/api";
+
+it("should remove large base64 strings from context when saving", async () => {
+	const SnapshotModel = G("SnapshotModel");
+	const smallBase64 = "data:image/gif;base64,abcdefghhikl";
+	const largeBase64 = smallBase64 + new Array(50_000).fill("a").join("");
+
+	const snapshot = new SnapshotModel({
+		context: {
+			number: 1,
+			nested: {
+				skip: null,
+				normal: "hello",
+				small: smallBase64,
+				large: largeBase64,
+				arr: [smallBase64, largeBase64, 1, "foo"],
+			},
+		},
+	});
+
+	expect(JSON.parse(snapshot.toServer().context)).toEqual({
+		number: 1,
+		nested: {
+			skip: null,
+			normal: "hello",
+			small: smallBase64, // Small ones are ok
+			large: "",
+			arr: [smallBase64, "", 1, "foo"],
+		},
+	});
+});

package/src/models/sub-slide.js

@@ -56,7 +56,7 @@ export const SubSlideModel = BaseModel.extend(
 			index_asset: "AssetModel",
 			slide: "SlideModel",
 		},
-	}
+	},
 );
 
 register("SubSlideModel", SubSlideModel);

package/src/models/support-ticket.js

@@ -33,7 +33,7 @@ export const SupportTicketModel = BaseModel.extend(
 			user: "UserModel",
 			resolved_by: "UserModel",
 		},
-	}
+	},
 );
 
 register("SupportTicketModel", SupportTicketModel);

package/src/models/tag.js

@@ -36,7 +36,7 @@ export const TagModel = BaseModel.extend(
 			team: "TeamModel",
 			deck: "DeckModel",
 		},
-	}
+	},
 );
 
 register("TagModel", TagModel);

package/src/models/team.js

@@ -1,3 +1,5 @@
+import "../collections/decks.js";
+import "../collections/users.js";
 import "./user.js";
 
 import { BaseModel } from "./base.js";
@@ -23,6 +25,7 @@ export const TeamModel = BaseModel.extend(
 			name: "string",
 			profile: "object",
 			has_autoadjuncts: "boolean",
+			has_cmsvals: "boolean",
 			theme_enabled: "boolean",
 			is_selectable: "boolean",
 			brand_colour: "string",
@@ -40,13 +43,21 @@ export const TeamModel = BaseModel.extend(
 
 		/**
 		 * @property {collections.UserCollection} user_set
-		 * @property {collections.PresentationDeckCollection} deck_set
+		 * @property {collections.DeckCollection} deck_set
 		 */
 		collections: {
 			user_set: "UserCollection",
-			deck_set: "PresentationDeckCollection",
+			deck_set: "DeckCollection",
 		},
-	}
+		derived: {
+			hasCustomContent: {
+				deps: ["has_autoadjuncts", "has_cmsvals"],
+				fn: function () {
+					return this.has_autoadjuncts || this.has_cmsvals;
+				},
+			},
+		},
+	},
 );
 
 register("TeamModel", TeamModel);

package/src/models/template.js

@@ -1,7 +1,9 @@
 import "./deck-version.js";
 import "./asset.js";
 
+import { Auth } from "../auth.js";
 import { BaseModel } from "./base.js";
+import SuperAgentRequest from "superagent-bluebird-promise";
 import { register } from "../state-register.js";
 
 /**
@@ -18,32 +20,102 @@ export const TemplateModel = BaseModel.extend(
 		 * @property {date} modified_date
 		 * @property {string} title
 		 * @property {string} key
+		 * @property {scope} scope
 		 * @property {number} sequence
-		 * @property {string} image_128
+		 * @property {object} context
+		 * @property {string} image_original
 		 * @property {string} image_128
 		 * @property {string} image_256
 		 * @property {string} image_512
+		 * @property {string[]} cmsvalkey_set
+		 * @property {boolean} available_in_presos
 		 */
 		props: {
 			created_date: "date",
 			modified_date: "date",
 			title: "string",
 			key: "string",
+			scope: {
+				type: "string",
+				default: "global",
+				values: ["global", "team", "user"],
+			},
 			sequence: "number",
+			context: {
+				type: "object",
+				default: () => {},
+			},
+			image_original: "string",
 			image_128: "string",
 			image_256: "string",
 			image_512: "string",
+			cmsvalkey_set: "array",
+			available_in_presos: {
+				type: "boolean",
+				default: true,
+			},
 		},
 
 		/**
 		 * @property {models.AssetModel} index_asset
 		 * @property {models.DeckVersionModel} deckversion
+		 * @property {models.Template} original_template
 		 */
 		children: {
 			index_asset: "AssetModel",
 			deckversion: "DeckVersionModel",
+			original_template: "TemplateModel",
+		},
+
+		async saveWithImage() {
+			const formData = new FormData();
+
+			if (this.image_original) {
+				const image = await SuperAgentRequest.get(
+					this.image_original,
+				).responseType("blob");
+
+				formData.append("image_original", image.body, "image.png");
+			}
+
+			for (const field of ["title", "key", "scope", "sequence"]) {
+				if (this[field]) {
+					formData.append(field, this[field]);
+				}
+			}
+
+			for (const field of ["original_template", "deckversion"]) {
+				if (this[field]) {
+					formData.append(field, this[field].url());
+				}
+			}
+
+			// Set these here, because after the save these will be set to whatever the return value
+			// is in the next request.
+			const cmsvalkeys = this.cmsvalkey_set;
+			const context = this.context;
+
+			await SuperAgentRequest.post(this.url())
+				.send(formData)
+				.set(Auth.headers)
+				.then((response) => {
+					Object.keys(response.body).forEach((key) => {
+						this.set(key, response.body[key]);
+					});
+					return response;
+				});
+
+			// HACK: Can't send an array (or can't figure out how to do it!) to django,
+			// so we send it in a seperate patch.
+			return await this.save(
+				{
+					cmsvalkey_set: cmsvalkeys,
+					context,
+				},
+				{ patch: true },
+			);
 		},
-	}
+	},
 );
 
 register("TemplateModel", TemplateModel);

package/src/models/tenancy.js

@@ -11,6 +11,7 @@ import { register } from "../state-register.js";
 export const TenancyModel = BaseModel.extend(
 	/** @lends models.TenancyModel# */ {
 		modelName: "tenancies",
+		detailType: "uuid",
 
 		/**
 		 * @property {string[]} eventtag_set
@@ -31,6 +32,8 @@ export const TenancyModel = BaseModel.extend(
 			logo_background_colour: "string",
 			billing_frequency: "string",
 			is_default: "boolean",
+			eula_key: "string",
+			eula_url: "string",
 			status_set: {
 				type: "array",
 				default: () => [],
@@ -43,7 +46,7 @@ export const TenancyModel = BaseModel.extend(
 		children: {
 			administrator: "UserModel",
 		},
-	}
+	},
 );
 
 register("TenancyModel", TenancyModel);

package/src/models/timing-log.js

@@ -113,7 +113,7 @@ export const TimingLogModel = BaseModel.extend(
 			const user = getShortURL(this.user.url());
 
 			const url = getShortURL(
-				this.hostedPreso ? this.hostedPreso.url() : this.appointment.url()
+				this.hostedPreso ? this.hostedPreso.url() : this.appointment.url(),
 			);
 			// At this point, the expected output should have a space instead of a T in this
 			// date format.
@@ -308,7 +308,7 @@ export const TimingLogModel = BaseModel.extend(
 					throw e;
 				});
 		},
-	}
+	},
 );
 
 register("TimingLogModel", TimingLogModel);

package/src/models/timing-log.spec.js

@@ -35,7 +35,7 @@ describe("TimingLogModel", () => {
 
 		// Some precision in milliseconds is lost here
 		expect(timingLog.events[0].timestamp).toEqual(
-			"2016-10-27T00:42:47.044000Z"
+			"2016-10-27T00:42:47.044000Z",
 		);
 		expect(timingLog.events[0].path).toEqual("/api/sections/1/");
 	});

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/transcribe-socket.js

@@ -13,7 +13,7 @@ export const TranscribeSocketModel = BaseModel.extend(
 		props: {
 			presigned_url: "string",
 		},
-	}
+	},
 );
 
 register("TranscribeSocketModel", TranscribeSocketModel);

package/src/models/user.js

@@ -53,6 +53,7 @@ export const UserModel = BaseModel.extend(
 						email_signature: "",
 						app_prefs: {},
 						timezone: "",
+						eula_key: "",
 					};
 				},
 			},
@@ -134,6 +135,10 @@ export const UserModel = BaseModel.extend(
 						presomanager.isGlobalTemporarySlideManager ||
 						presomanager.isTeamTemporarySlideManager;
 
+					presomanager.isPresoManagerUser =
+						presomanager.canModifyTemporarySlides ||
+						presomanager.canModifyContent;
+
 					presomanager.canModifyContent =
 						this.actions.indexOf("Create Content") > -1 ||
 						this.actions.indexOf("Manage Team Editable Text") > -1;
@@ -157,6 +162,14 @@ 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,
+						canHandoverPresosOfOthers:
+							this.actions.indexOf("Handover Presos of Others") > -1,
+						canChooseShareVisAnyone:
+							this.actions.indexOf("Choose Share Visibility Anyone") > -1,
+						canChooseShareVis2fa:
+							this.actions.indexOf("Choose Share Visibility 2FA") > -1,
 					};
 
 					const customers = {
@@ -183,7 +196,7 @@ export const UserModel = BaseModel.extend(
 			return this.fetch({ url: `${resourceURL}?_=${preventCachingID}` }).then(
 				({ url }) => {
 					return url;
-				}
+				},
 			);
 		},
 
@@ -227,7 +240,7 @@ export const UserModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("UserModel", UserModel);

package/src/models.js

@@ -15,10 +15,12 @@ export * from "./models/base";
 export * from "./models/choicelist.js";
 export * from "./models/cms-val";
 export * from "./models/contact";
+export * from "./models/contact-phone";
 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";
@@ -60,8 +62,10 @@ 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-template.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";
@@ -53,28 +54,35 @@ export const AppointmentPresentation = BaseModel.extend(
 			opportunities: "OpportunityCollection",
 			contacts: "ContactCollection",
 		},
-	}
+	},
 );
 
 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,
-				index,
 				appointmentTags: appointment.tags.length ? appointment.tags : null,
+				screenshots,
+				index,
 				...options,
 			});
-		})
+		}),
 	);
 
 	appointmentPresentation.tele = appointment.latest_tele;
@@ -126,7 +134,7 @@ AppointmentPresentation.createFromID = function (id, options = {}) {
  */
 AppointmentPresentation.createFromAppointment = function (
 	appointment,
-	options = {}
+	options = {},
 ) {
 	return createFromAppointment(appointment, options);
 };

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

@@ -6,7 +6,7 @@ import { BaseCollection } from "../collections/base.js";
  * @extends collections.BaseCollection
  */
 export const BasePresentationCollection = BaseCollection.extend(
-	/** @lends presentation.BasePresentationCollection# */ {}
+	/** @lends presentation.BasePresentationCollection# */ {},
 );
 
 BasePresentationCollection.canBeEmpty = true;

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
@@ -10,9 +13,92 @@ export const BasePresentationModel = BaseModel.extend(
 		url() {
 			return null;
 		},
-	}
+	},
 );
 
+BasePresentationModel.screenshotsToMap = function (screenshots) {
+	if (!screenshots?.models) {
+		return 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
+				and a global, be sure to remove the screenshot that you don't need.
+			`);
+		}
+		result[model.subject] = model.image_256;
+		return result;
+	}, {});
+};
+
+/**
+ * Logic to pick a thumbnail based on either the model itself or from
+ * and overriding screenshot if one exists.
+ */
+BasePresentationModel.getThumbnail = function (model, screenshots) {
+	if (screenshots?.models) {
+		throw new Error("Expected map file");
+	}
+
+	if (!model) {
+		return null;
+	}
+
+	return screenshots[model.url()] || 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,10 +106,9 @@ 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 = {}
+	options = {},
 ) {
 	const { choicelist = null, selections = null } = options;
 	const url = model.url();