@livepreso/api 6.42.1 → 6.45.0

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";
@@ -49,6 +50,7 @@ export const AppointmentModel = BaseModel.extend(
 		 * @property {string} display_title
 		 * @property {string} viewtype
 		 * @property {boolean} support_mode
+		 * @property {boolean} is_muted
 		 * @property {date} no_edit_after
 		 * @property {date} no_share_after
 		 * @property {date} no_delete_after
@@ -72,6 +74,7 @@ export const AppointmentModel = BaseModel.extend(
 			display_title: "stringSanitized",
 			viewtype: "string",
 			support_mode: "boolean",
+			is_muted: "boolean",
 			no_edit_after: "date",
 			no_share_after: "date",
 			no_delete_after: "date",
@@ -94,6 +97,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 +117,6 @@ export const AppointmentModel = BaseModel.extend(
 			user: "UserModel",
 			latest_tele: "HostedPresoModel",
 			stats: "AppointmentStatsModel",
-			tags: "AppointmentTagsModel",
 			team: "TeamModel",
 		},
 
@@ -205,6 +212,14 @@ export const AppointmentModel = BaseModel.extend(
 				},
 			},
 		},
+
+		getHooksPath() {
+			if (!this.deckversion_set.length) {
+				throw new Error("Requires a deckversion to get hooks.");
+			}
+			return this.deckversion_set.first().getHooksPath();
+		},
+
 		fetchAll(fetchSelf = false, options = {}) {
 			return Promise.resolve()
 				.then(() => {
@@ -272,6 +287,7 @@ export const AppointmentModel = BaseModel.extend(
 					return Promise.all(
 						this.deckversion_set.map((model) => {
 							return Promise.all([
+								model.screenshots.fetch(options),
 								model.template_set.fetchSet(options),
 								model.manifest_json.fetch(options),
 								model.deck.fetch(options),
@@ -298,6 +314,7 @@ export const AppointmentModel = BaseModel.extend(
 				viewtype: appointment.viewtype,
 				preset: this._retrieveURL(appointment.preset),
 				locks: appointment.locks,
+				is_muted: appointment.is_muted,
 				no_edit_after: appointment.no_edit_after,
 				no_share_after: appointment.no_share_after,
 				no_delete_after: appointment.no_delete_after,

package/src/models/auto-adjunct.js

@@ -25,6 +25,7 @@ export const AutoAdjunctModel = BaseModel.extend(
 		 * @property {string} after_key
 		 * @property {boolean} enabled
 		 * @property {number} sequence
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			image_128: "string",
@@ -39,6 +40,7 @@ export const AutoAdjunctModel = BaseModel.extend(
 			enabled: "boolean",
 			sequence: "number",
 			tags: "array",
+			cmsvalkey_set: "array",
 		},
 
 		/**

package/src/models/base.js

@@ -26,6 +26,10 @@ export const BaseModel = Model.extend(
 		// behaviour from automatically hydrating all children and collections on a fetch.
 		isFetching: false,
 
+		// Useful to figure out whether the model is just a URL (unfetched), or has been
+		// fetched from the server (an object).
+		_isFetched: true,
+
 		// Object of regexes that should be used to match a url in `matchesURL`
 		// For example the URL: /api/foo/{pk}/bar/ might have the following:
 		//
@@ -38,11 +42,13 @@ export const BaseModel = Model.extend(
 		// ```
 		urlMatchKeys: {},
 
-		constructor(data = {}, opts = {}) {
+		constructor(_data = {}, opts = {}) {
 			const options = _.defaults(opts, {
 				data: {},
 			});
 
+			let data = _data;
+
 			this._unsetChildren = {};
 			this._unsetCollections = {};
 			this._expandedValues = {};
@@ -61,6 +67,13 @@ export const BaseModel = Model.extend(
 			// Convert any strings into a url format we can understand
 			if (_.isString(data)) {
 				data = { url: data };
+				this._isFetched = false;
+			}
+
+			// Convert model ids into a format we can understand
+			if (_.isNumber(data)) {
+				data = { id: data };
+				this._isFetched = false;
 			}
 
 			const dataCopy = _.extend({}, data);
@@ -402,6 +415,7 @@ export const BaseModel = Model.extend(
 
 			this.isFetching = true;
 			return Model.prototype.fetch.apply(this, arguments).tap((response) => {
+				this._isFetched = true;
 				this.isFetching = false;
 				this._updateResponse(response);
 			});
@@ -421,6 +435,10 @@ export const BaseModel = Model.extend(
 				});
 		},
 
+		isFetched() {
+			return this._isFetched;
+		},
+
 		getSafeAttrs(key) {
 			if (!_.isUndefined(key)) {
 				return !_.isUndefined(this._expandedValues[key])

package/src/models/base.spec.js

@@ -7,7 +7,7 @@ import log from "../log.js";
 import moment from "moment";
 import td from "testdouble";
 
-it("should set date types correctly (SP-2698)", function () {
+it("should set date types correctly (SP-2698)", () => {
 	const TestModel = BaseModel.extend({ props: { testDate: "date" } });
 
 	const model = new TestModel();
@@ -48,7 +48,7 @@ it("should not append a slash to a get query", () => {
 	expect(model.url()).toEqual("/api/tests/?foo=bar");
 });
 
-it("should replace child model strings with the registered model", function () {
+it("should replace child model strings with the registered model", () => {
 	const TestModel = G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
@@ -59,7 +59,7 @@ it("should replace child model strings with the registered model", function () {
 	expect(model.test).toBeInstanceOf(TestModel);
 });
 
-it("should allow the model to be passed in", function () {
+it("should allow the model to be passed in", () => {
 	const TestModel = G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
@@ -71,7 +71,7 @@ it("should allow the model to be passed in", function () {
 	expect(model.test).toBeInstanceOf(TestModel);
 });
 
-it("should reference parent model if foreign key exists", function () {
+it("should reference parent model if foreign key exists", () => {
 	G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
@@ -92,7 +92,7 @@ it("should throw an error if the child model doesn't exist", () => {
 	expect(() => new Model()).toThrow();
 });
 
-it("should convert a url into a model", function () {
+it("should convert a url into a model", () => {
 	G(BaseModel.extend({ modelName: "tests" }), "TestModel");
 	const Model = G(
 		BaseModel.extend({
@@ -103,7 +103,14 @@ it("should convert a url into a model", function () {
 	expect(model.test.id).toEqual(1);
 });
 
-it("should convert an object into a model", function () {
+it("should convert an id into a model", () => {
+	const TestModel = BaseModel.extend({ modelName: "test" });
+	const testModel = new TestModel(1);
+	expect(testModel.id).toEqual(1);
+	expect(testModel.url()).toEqual("/test/1/");
+});
+
+it("should convert an object into a model", () => {
 	G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
@@ -114,7 +121,7 @@ it("should convert an object into a model", function () {
 	expect(model.test.id).toEqual(1);
 });
 
-it("should replace collection strings with their registered state", function () {
+it("should replace collection strings with their registered state", () => {
 	G(BaseModel, "TestModel");
 	const TestCollection = G(
 		BaseCollection.extend({
@@ -133,7 +140,7 @@ it("should replace collection strings with their registered state", function ()
 	expect(model.tests).toBeInstanceOf(TestCollection);
 });
 
-it("should allow a list of models to be passed into a collection", function () {
+it("should allow a list of models to be passed into a collection", () => {
 	const TestModel = G(BaseModel, "TestModel");
 	G(
 		BaseCollection.extend({
@@ -211,7 +218,7 @@ it("should convert an array of objects into a collection", () => {
 	expect(model.tests.at(1).id).toEqual(2);
 });
 
-it("should correctly sanitize strings of multibyte characters (preserving spaces)", function () {
+it("should correctly sanitize strings of multibyte characters (preserving spaces)", () => {
 	const TestModel = BaseModel.extend({
 		props: {
 			normalString: "string",

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

@@ -0,0 +1,48 @@
+import "./team.js";
+
+import { BaseModel } from "./base.js";
+import _ from "lodash";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.DeckVersionScreenshotModel
+ * @extends models.BaseModel
+ */
+export const DeckVersionScreenshotModel = BaseModel.extend(
+	/** @lends models.DeckVersionScreenshotModel# */ {
+		modelName: "deckversion-screenshots",
+
+		urlMatchKeys: {
+			"deckversion.id": "number",
+		},
+
+		/**
+		 * @property {date} created_date
+		 * @property {date} modified_date
+		 * @property {string} image_128
+		 * @property {string} image_256
+		 * @property {string} image_512
+		 * @property {string} subject - A url for a screenshotted model (section, slide, etc.)
+		 */
+		props: {
+			created_date: "date",
+			modified_date: "date",
+			image_128: "string",
+			image_256: "string",
+			image_512: "string",
+			subject: "string",
+		},
+
+		children: {
+			team: "TeamModel",
+		},
+
+		serialize() {
+			const data = BaseModel.prototype.serialize.call(this);
+			return _.omit(data, ["url"]);
+		},
+	}
+);
+
+register("DeckVersionScreenshotModel", DeckVersionScreenshotModel);

package/src/models/deck-version.js

@@ -7,6 +7,7 @@ import "./asset.js";
 import "./manifest-json.js";
 
 import { BaseModel } from "./base.js";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
 import Promise from "bluebird";
 import _ from "lodash";
 import { register } from "../state-register.js";
@@ -37,7 +38,9 @@ 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
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			image_128: "string",
@@ -56,7 +59,9 @@ 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",
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -84,10 +89,24 @@ export const DeckVersionModel = BaseModel.extend(
 		},
 
 		/**
-		 * @todo This should eventually return a hooks interface
-		 * @returns {object}
+		 * @property {collections.DeckVersionScreenshotCollection} screenshots
 		 */
-		getHooks() {
+		derived: {
+			screenshots: {
+				deps: ["id"],
+				fn: function () {
+					const screenshots = new DeckVersionScreenshotCollection(
+						{},
+						{
+							deckversion: this,
+						}
+					);
+					return screenshots;
+				},
+			},
+		},
+
+		getHooksPath() {
 			if (this.isNew()) {
 				throw new Error(
 					"Can only get hooks from a fetched deckversion or at least have an ID"
@@ -115,8 +134,17 @@ export const DeckVersionModel = BaseModel.extend(
 					if (!this.manifest_json.hooks) {
 						throw new Error("Manifest does not contain a hooks entry");
 					}
-					const hooksPath = `${rootAssetUrl}${this.manifest_json.hooks}`;
+					return `${rootAssetUrl}${this.manifest_json.hooks}`;
+				});
+		},
 
+		/**
+		 * @todo This should eventually return a hooks interface
+		 * @returns {object}
+		 */
+		getHooks() {
+			return this.getHooksPath()
+				.then((hooksPath) => {
 					return SystemJS.import(hooksPath);
 				})
 				.then((hooks) => {

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/feed-data.js

@@ -14,10 +14,12 @@ export const FeedDataModel = BaseModel.extend(
 
 		/**
 		 * @property {object} feed_data
+		 * @property {object} feed_debug
 		 * @property {string} creation_status
 		 */
 		props: {
 			feed_data: "object",
+			feed_debug: {type: "object", default: () => {}},
 			creation_status: "string",
 		},
 

package/src/models/image.js

@@ -1,6 +1,8 @@
 import "./user.js";
 
+import { Auth } from "../auth.js";
 import { BaseModel } from "./base.js";
+import SuperAgentRequest from "superagent-bluebird-promise";
 import { register } from "../state-register.js";
 
 /**
@@ -37,6 +39,36 @@ export const ImageModel = BaseModel.extend(
 		children: {
 			event: "UserModel",
 		},
+		uploadBase64(data) {
+			// mime will be in the format "image/png;base64"
+			const fileType = data.mime.split(";")[0];
+			const fileEnd = fileType.split("/")[1];
+
+			return fetch(data.value)
+				.then((res) => {
+					return res.blob();
+				})
+				.then((blob) => {
+					const file = new File([blob], `image.${fileEnd}`, { type: fileType });
+					const formData = new FormData();
+					formData.append("image_original", file);
+
+					return this.uploadFile(file);
+				});
+		},
+		uploadFile(file) {
+			const formData = new FormData();
+			formData.append("image_original", file);
+
+			return SuperAgentRequest.post(this.url())
+				.send(formData)
+				.set(Auth.headers)
+				.then((response) => {
+					Object.keys(response.body).forEach((key) => {
+						this.set(key, response.body[key]);
+					});
+				});
+		},
 	}
 );
 

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,
@@ -96,6 +99,9 @@ export const ManifestJSONModel = BaseModel.extend(
 						appointment: {
 							show_visible_default: false,
 						},
+						fieldsets: {
+							enforce_required: false,
+						},
 					};
 				},
 			},
@@ -147,6 +153,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 +227,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 +240,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 +286,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;
@@ -265,6 +307,12 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 		};
 	}
 
+	// For all new decks going forward, this should be set to true.
+	// This means we validate that a fieldset field has a value. Before
+	// this change, it was possible to save with a required field unfilled.
+	// This just keeps backwards compatability.
+	manifest.app_settings.fieldsets.enforce_required = false;
+
 	return manifest;
 };
 

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