@livepreso/api 6.42.1 → 6.43.0

package/src/collections/appointment-tags.js

@@ -0,0 +1,136 @@
+import { getState, register } from "../state-register.js";
+
+import { BaseCollection } from "./base.js";
+import _ from "lodash";
+
+/**
+ * @constructor
+ * @alias collections.AppointmentTagsCollection
+ * @extends collections.BaseCollection
+ * @see models.AppointmentTagsModel
+ */
+export const AppointmentTagsCollection = BaseCollection.extend(
+	/** @lends collections.AppointmentTagsCollection# */ {
+		model: "AppointmentTagsModel",
+
+		tagNameCollectionMapping: {
+			deckversion: "AppointmentDeckVersionTagsCollection",
+			section: "AppointmentSectionTagsCollection",
+			slide: "AppointmentSlideTagsCollection",
+			adjunct: "AppointmentAdjunctTagsCollection",
+		},
+
+		_mapResultsToModel(result) {
+			// Maps a model from a content specific tag to a more generic one.
+			// It's generally the same thing, except instead of something like:
+			//
+			//  slide: "/api/slides/1/"
+			//
+			// It becomes:
+			//
+			//  content_type: "slide",
+			//  content_url: "/api/slides/1/"
+			//
+			// So that we can return the list side by side.
+			const AppointmentTagsModel = getState("AppointmentTagsModel");
+			const resultType = Object.keys(result).find((key) => {
+				return Object.keys(this.tagNameCollectionMapping).includes(key);
+			});
+			if (!resultType) {
+				throw new Error("Unknown type of result found");
+			}
+			return new AppointmentTagsModel({
+				tags: result.tags,
+				content_type: resultType,
+				content_url: result[resultType],
+				appointment: result.appointment,
+				user: result.user,
+				url: result.url,
+			});
+		},
+
+		// These methods don't quite make sense right now, disable it for development.
+		async fetchSet() {
+			throw new Error("Not implemented");
+		},
+
+		async fetchModels() {
+			throw new Error("Not implemented");
+		},
+
+		async delete() {
+			throw new Error("Cannot delete using this collection");
+		},
+
+		async save() {
+			throw new Error("Not implemented");
+		},
+
+		async fetch(options) {
+			const AppointmentModel = getState("AppointmentModel");
+
+			let hasAppointment =
+				this._options?.appointment instanceof AppointmentModel ||
+				options?.appointment instanceof AppointmentModel;
+
+			if (!hasAppointment && this.parent instanceof AppointmentModel) {
+				options.appointment = this.parent;
+				hasAppointment = true;
+			}
+
+			if (!hasAppointment) {
+				throw new Error(
+					"Requires an appointment model in collection options to fetch."
+				);
+			}
+
+			const tagModels = Object.values(this.tagNameCollectionMapping);
+			// Fetch all the separate tag models and combine them into a single collection
+			const results = (
+				await Promise.all(
+					tagModels.map((tagModel) => {
+						const Collection = getState(tagModel);
+						const tags = new Collection({}, this._options);
+						return tags.fetch(options);
+					})
+				)
+			)
+				.flatMap((collection) => collection.results)
+				.map(this._mapResultsToModel.bind(this));
+
+			this.add(results);
+
+			return {
+				count: results.length,
+				next: null,
+				previous: null,
+				results: this.toJSON(),
+			};
+		},
+
+		// Used by Telepresenter to add the tags in the hostedpreso bundle to
+		// the appointment tags collection
+		addFromAppointment(appointment) {
+			const tagCollectionNames = [
+				"appointmentdeckversiontags_set",
+				"appointmentsectiontags_set",
+				"appointmentslidetags_set",
+				"appointmentadjuncttags_set",
+			];
+
+			// flatMap currently doesn't work in TelePresenter
+			const results = _.flatten(
+				tagCollectionNames.map((collectionName) => {
+					const collection = appointment[collectionName];
+					return collection?._data || [];
+				})
+			).map(this._mapResultsToModel.bind(this));
+
+			this.add(results);
+		},
+	}
+);
+
+AppointmentTagsCollection.canBeEmpty = true;
+
+register("AppointmentTagsCollection", AppointmentTagsCollection);

package/src/collections/tags.js

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

package/src/collections.js

@@ -36,5 +36,11 @@ export * from "./collections/users";
 export * from "./collections/uploads";
 export * from "./collections/appointment-editors.js";
 export * from "./collections/appointment-duplicates.js";
+export * from "./collections/tags.js";
 export * from "./collections/teams.js";
 export * from "./collections/templates.js";
+export * from "./collections/appointment-tags.js";
+export * from "./collections/appointment-deckversion-tags.js";
+export * from "./collections/appointment-section-tags.js";
+export * from "./collections/appointment-slide-tags.js";
+export * from "./collections/appointment-adjunct-tags.js";

package/src/models/appointment-adjunct-tags.js

@@ -0,0 +1,41 @@
+import "./appointment.js";
+import "./user.js";
+import "./adjunct.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.AppointmentAdjunctTagsModel
+ * @extends models.BaseModel
+ */
+export const AppointmentAdjunctTagsModel = BaseModel.extend(
+	/** @lends models.AppointmentAdjunctTagsModel# */ {
+		modelName: "appointment-adjunct-tags",
+
+		urlMatchKeys: {
+			"appointment.id": "number",
+		},
+
+		/**
+		 * @property {string[]} tags
+		 */
+		props: {
+			tags: "array",
+		},
+
+		/**
+		 * @property {models.AppointmentModel} appointment
+		 * @property {models.AdjunctModel} adjunct
+		 * @property {models.UserModel} user
+		 */
+		children: {
+			appointment: "AppointmentModel",
+			adjunct: "AdjunctModel",
+			user: "UserModel",
+		},
+	}
+);
+
+register("AppointmentAdjunctTagsModel", AppointmentAdjunctTagsModel);

package/src/models/appointment-deckversion-tags.js

@@ -0,0 +1,41 @@
+import "./appointment.js";
+import "./user.js";
+import "./deck-version.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.AppointmentDeckVersionTagsModel
+ * @extends models.BaseModel
+ */
+export const AppointmentDeckVersionTagsModel = BaseModel.extend(
+	/** @lends models.AppointmentDeckVersionTagsModel# */ {
+		modelName: "appointment-deckversion-tags",
+
+		urlMatchKeys: {
+			"appointment.id": "number",
+		},
+
+		/**
+		 * @property {string[]} tags
+		 */
+		props: {
+			tags: "array",
+		},
+
+		/**
+		 * @property {models.AppointmentModel} appointment
+		 * @property {models.DeckVersionModel} deckversion
+		 * @property {models.UserModel} user
+		 */
+		children: {
+			appointment: "AppointmentModel",
+			deckversion: "DeckVersionModel",
+			user: "UserModel",
+		},
+	}
+);
+
+register("AppointmentDeckVersionTagsModel", AppointmentDeckVersionTagsModel);

package/src/models/appointment-section-tags.js

@@ -0,0 +1,41 @@
+import "./appointment.js";
+import "./user.js";
+import "./slide.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.AppointmentSectionTagsModel
+ * @extends models.BaseModel
+ */
+export const AppointmentSectionTagsModel = BaseModel.extend(
+	/** @lends models.AppointmentSectionTagsModel# */ {
+		modelName: "appointment-section-tags",
+
+		urlMatchKeys: {
+			"appointment.id": "number",
+		},
+
+		/**
+		 * @property {string[]} tags
+		 */
+		props: {
+			tags: "array",
+		},
+
+		/**
+		 * @property {models.AppointmentModel} appointment
+		 * @property {models.SectionModel} slide
+		 * @property {models.UserModel} user
+		 */
+		children: {
+			appointment: "AppointmentModel",
+			section: "SectionModel",
+			user: "UserModel",
+		},
+	}
+);
+
+register("AppointmentSectionTagsModel", AppointmentSectionTagsModel);

package/src/models/appointment-slide-tags.js

@@ -0,0 +1,41 @@
+import "./appointment.js";
+import "./user.js";
+import "./slide.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.AppointmentSlideTagsModel
+ * @extends models.BaseModel
+ */
+export const AppointmentSlideTagsModel = BaseModel.extend(
+	/** @lends models.AppointmentSlideTagsModel# */ {
+		modelName: "appointment-slide-tags",
+
+		urlMatchKeys: {
+			"appointment.id": "number",
+		},
+
+		/**
+		 * @property {string[]} tags
+		 */
+		props: {
+			tags: "array",
+		},
+
+		/**
+		 * @property {models.AppointmentModel} appointment
+		 * @property {models.SlideModel} slide
+		 * @property {models.UserModel} user
+		 */
+		children: {
+			appointment: "AppointmentModel",
+			slide: "SlideModel",
+			user: "UserModel",
+		},
+	}
+);
+
+register("AppointmentSlideTagsModel", AppointmentSlideTagsModel);

package/src/models/appointment-tags.js

@@ -8,26 +8,28 @@ import { register } from "../state-register.js";
  */
 export const AppointmentTagsModel = BaseModel.extend(
 	/** @lends models.AppointmentTagsModel# */ {
-		modelName: "appointment-tags",
+		urlMatchKeys: {
+			"appointment.id": "number",
+		},
 
 		/**
-		 * @property {object} tags
+		 * @property {string[]} tags
+		 * @property {string} content_type
+		 * @property {string} content_url
 		 */
 		props: {
-			items: "object",
-		},
-
-		url() {
-			if (this.parent && this.parent.modelName === "appointments") {
-				return this.getFullURLPath(`${this.parent.getPlainURL()}tags/`);
-			}
-			return BaseModel.prototype.url.call(this);
+			tags: "array",
+			content_type: "string",
+			content_url: "string",
 		},
 
-		fetch() {
-			return BaseModel.prototype.fetch.call(this).tap((tags) => {
-				this.items = tags;
-			});
+		/**
+		 * @property {models.AppointmentModel} appointment
+		 * @property {models.UserModel} user
+		 */
+		children: {
+			appointment: "AppointmentModel",
+			user: "UserModel",
 		},
 	}
 );

package/src/models/appointment.js

@@ -14,6 +14,7 @@ import "../collections/section-selections.js";
 import "../collections/slide-selections.js";
 import "../collections/dispatches.js";
 import "../collections/users.js";
+import "../collections/appointment-tags";
 
 import { AdjunctSectionCollection } from "../collections/adjunct-sections.js";
 import { AdjunctSlideCollection } from "../collections/adjunct-slides.js";
@@ -94,6 +95,11 @@ export const AppointmentModel = BaseModel.extend(
 			appointmentsslide_set: "SlideSelectionCollection",
 			dispatch_set: "DispatchCollection",
 			current_editor_set: "UserCollection",
+			tags: "AppointmentTagsCollection",
+			appointmentdeckversiontags_set: "AppointmentDeckVersionTagsCollection",
+			appointmentsectiontags_set: "AppointmentSectionTagsCollection",
+			appointmentslidetags_set: "AppointmentSlideTagsCollection",
+			appointmentadjuncttags_set: "AppointmentAdjunctTagsCollection",
 		},
 
 		/**
@@ -109,7 +115,6 @@ export const AppointmentModel = BaseModel.extend(
 			user: "UserModel",
 			latest_tele: "HostedPresoModel",
 			stats: "AppointmentStatsModel",
-			tags: "AppointmentTagsModel",
 			team: "TeamModel",
 		},
 

package/src/models/deck-tags.js

@@ -0,0 +1,52 @@
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.DeckTagsModel
+ * @extends models.BaseModel
+ */
+export const DeckTagsModel = BaseModel.extend(
+	/** @lends models.DeckTagsModel# */ {
+		modelName: "deck-tags",
+
+		/**
+		 * @property {object} items
+		 */
+		props: {
+			items: "object",
+		},
+
+		url() {
+			if (this.parent && this.parent.modelName === "decks") {
+				return this.getFullURLPath(`${this.parent.getPlainURL()}tags/`);
+			}
+			return BaseModel.prototype.url.call(this);
+		},
+
+		fetch(opts) {
+			return BaseModel.prototype.fetch.call(this, opts).tap((tags) => {
+				this.items = tags;
+			});
+		},
+
+		isNew() {
+			// Force deck-tags to always use PUT.
+			return false;
+		},
+
+		toServer() {
+			return this.items;
+		},
+
+		save() {
+			return BaseModel.prototype.save.call(this).tap((tags) => {
+				this.items = tags;
+			});
+		},
+	}
+);
+
+DeckTagsModel.canBeEmpty = true;
+
+register("DeckTagsModel", DeckTagsModel);

package/src/models/deck-version.js

@@ -37,6 +37,7 @@ export const DeckVersionModel = BaseModel.extend(
 		 * @property {string} upgrade_description
 		 * @property {string} friendly_release_notes
 		 * @property {boolean} has_editable_share_support
+		 * @property {string} point_in_time_share_policy
 		 * @property {string[]} tags
 		 */
 		props: {
@@ -56,6 +57,7 @@ export const DeckVersionModel = BaseModel.extend(
 			upgrade_description: "string",
 			friendly_release_notes: "string",
 			has_editable_share_support: "boolean",
+			point_in_time_share_policy: "string",
 			tags: "array",
 		},
 

package/src/models/deck.js

@@ -1,3 +1,4 @@
+import "./deck-tags.js";
 import "./deck-version.js";
 
 import { BaseModel } from "./base.js";
@@ -53,6 +54,7 @@ export const DeckModel = BaseModel.extend(
 		children: {
 			approved_version: "DeckVersionModel",
 			head_version: "DeckVersionModel",
+			tags: "DeckTagsModel",
 		},
 	}
 );

package/src/models/manifest-json.js

@@ -77,6 +77,9 @@ export const ManifestJSONModel = BaseModel.extend(
 				type: "boolean",
 				default: false,
 			},
+			point_in_time_share_policy: {
+				type: "string",
+			},
 			notify_salesperson_after_feeds_fetched: {
 				type: "boolean",
 				default: false,
@@ -147,6 +150,41 @@ export const ManifestJSONModel = BaseModel.extend(
  * object.
  */
 ManifestJSONModel.createFromProject = function (projectFile) {
+	// If the deck is an impostor deck, we have to update some things for
+	// them to make sense in the impostor format
+	if (projectFile.impostor) {
+		// There is only one real section; all of the "sections" defined in the
+		// project.yaml are actually slides, and slides can't have a maxAdjunctSlides
+		// value. We get around this by totalling up all of the maxAdjunctSlides values
+		// across the sections and give that number to the real section. Later e.g. in the
+		// app, that number will be taken and divided by the number of impostor sections
+		// to get the maxAdjunctSlides value for each impostor section
+		const maxAdjunctSlides = projectFile.sections.reduce((num, section) => {
+			return num + (section.maxAdjunctSlides || 0);
+		}, 0);
+
+		// Create a "real" section (that will never be seen by the user) and give
+		// it all of the sections & slides. Impostor sections (which are technically
+		// slides) are given the "section-header" tag to mark them as sections
+		projectFile.sections = [
+			{
+				maxAdjunctSlides,
+				key: projectFile.key,
+				title: projectFile.name,
+				slides: projectFile.sections.reduce((sections, section) => {
+					const newSection = {
+						...section,
+						slides: [],
+					};
+					newSection.tags = ["section-header"].concat(newSection.tags || []);
+
+					sections.push(newSection, ...(section.slides || []));
+					return sections;
+				}, []),
+			},
+		];
+	}
+
 	const titles = projectFile.sections.reduce((titles, section) => {
 		titles[section.key] = section.title;
 		for (const slide of section.slides || []) {
@@ -186,13 +224,9 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 	}, {});
 
 	const tags = projectFile.sections.reduce((tags, section) => {
-		if (section.tags) {
-			tags[section.key] = section.tags;
-		}
+		tags[section.key] = section.tags || [];
 		for (const slide of section.slides || []) {
-			if (slide.tags) {
-				tags[`${section.key}/${slide.key}`] = slide.tags;
-			}
+			tags[`${section.key}/${slide.key}`] = slide.tags || [];
 		}
 		return tags;
 	}, {});
@@ -203,7 +237,7 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 		if (projectFile.welcome.tags) {
 			// It's convention to use an empty string for the
 			// Welcome slide's key
-			tags[""] = projectFile.welcome.tags;
+			tags[""] = projectFile.welcome.tags || [];
 		}
 	}
 
@@ -249,6 +283,11 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 			projectFile.has_editable_share_support;
 	}
 
+	if (projectFile.point_in_time_share_policy) {
+		manifest.point_in_time_share_policy =
+			projectFile.point_in_time_share_policy;
+	}
+
 	if (projectFile.notify_salesperson_after_feeds_fetched) {
 		manifest.notify_salesperson_after_feeds_fetched =
 			projectFile.notify_salesperson_after_feeds_fetched;

package/src/models/preset.js

@@ -1,5 +1,6 @@
 import "./user.js";
 import "./deck.js";
+import "./team.js";
 
 import { BaseModel } from "./base.js";
 import { register } from "../state-register.js";
@@ -32,10 +33,13 @@ export const PresetModel = BaseModel.extend(
 		/**
 		 * @property {models.UserModel} user
 		 * @property {models.DeckModel} deck
+		 * @property {models.TeamModel} team
 		 */
 		children: {
 			user: "UserModel",
 			deck: "DeckModel",
+			team: "TeamModel",
+			keylist_team: "TeamModel",
 		},
 
 		toServer() {
@@ -54,9 +58,24 @@ export const PresetModel = BaseModel.extend(
 				data.id = this.id;
 			}
 
+			const teamURL = this._retrieveURL(this.team);
+
+			if (teamURL) {
+				data.team = teamURL;
+			}
+			const keylistTeamURL = this._retrieveURL(this.keylist_team);
+
+			if (keylistTeamURL) {
+				data.keylist_team = keylistTeamURL;
+			}
+
 			return data;
 		},
 	}
 );
 
+PresetModel.USER_VISIBILITY = "__user__";
+PresetModel.GLOBAL_VISIBILITY = "__global__";
+PresetModel.STANDARD_SLIDE_SOURCE = "__standard__";
+
 register("PresetModel", PresetModel);

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/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 = {