@livepreso/api 6.44.0 → 6.45.0

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-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";
@@ -39,6 +40,7 @@ export const DeckVersionModel = BaseModel.extend(
 		 * @property {boolean} has_editable_share_support
 		 * @property {string} point_in_time_share_policy
 		 * @property {string[]} tags
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			image_128: "string",
@@ -59,6 +61,7 @@ export const DeckVersionModel = BaseModel.extend(
 			has_editable_share_support: "boolean",
 			point_in_time_share_policy: "string",
 			tags: "array",
+			cmsvalkey_set: "array",
 		},
 
 		/**
@@ -86,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"
@@ -117,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/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

@@ -311,7 +311,7 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 	// 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 = true;
+	manifest.app_settings.fieldsets.enforce_required = false;
 
 	return manifest;
 };

package/src/models/section.js

@@ -34,6 +34,7 @@ export const SectionModel = BaseModel.extend(
 		 * @property {string} title
 		 * @property {boolean} uploaded
 		 * @property {boolean} visible
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			adjunctslide_limit: "number",
@@ -62,6 +63,7 @@ export const SectionModel = BaseModel.extend(
 				type: "array",
 				default: () => [],
 			},
+			cmsvalkey_set: "array",
 		},
 
 		/**

package/src/models/slide.js

@@ -35,6 +35,7 @@ export const SlideModel = BaseModel.extend(
 		 * @property {boolean} uploaded
 		 * @property {boolean} visible
 		 * @property {array} tags
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			adjunctslide_limit: "number",
@@ -63,6 +64,7 @@ export const SlideModel = BaseModel.extend(
 				type: "array",
 				default: () => [],
 			},
+			cmsvalkey_set: "array",
 		},
 
 		/**

package/src/models/template.js

@@ -23,6 +23,7 @@ export const TemplateModel = BaseModel.extend(
 		 * @property {string} image_128
 		 * @property {string} image_256
 		 * @property {string} image_512
+		 * @property {string[]} cmsvalkey_set
 		 */
 		props: {
 			created_date: "date",
@@ -33,6 +34,7 @@ export const TemplateModel = BaseModel.extend(
 			image_128: "string",
 			image_256: "string",
 			image_512: "string",
+			cmsvalkey_set: "array",
 		},
 
 		/**

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

@@ -157,6 +157,8 @@ 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,
 					};
 
 					const customers = {

package/src/models.js

@@ -19,6 +19,7 @@ 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";
@@ -65,3 +66,4 @@ 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";
@@ -58,20 +59,27 @@ export const AppointmentPresentation = BaseModel.extend(
 
 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,
 			});
 		})

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
@@ -13,6 +16,80 @@ export const BasePresentationModel = BaseModel.extend(
 	}
 );
 
+/**
+ * Logic to pick a thumbnail based on either the model itself or from
+ * and overriding screenshot if one exists.
+ */
+BasePresentationModel.getThumbnail = function (model, screenshots) {
+	const overrideScreenshot =
+		screenshots?.filter((screen) => {
+			return screen.subject === model.url();
+		}) ?? [];
+
+	if (overrideScreenshot.length) {
+		if (overrideScreenshot.length > 1) {
+			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.
+			`);
+		}
+
+		return overrideScreenshot[0].image_256;
+	}
+
+	return 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,7 +97,6 @@ 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 = {}

package/src/presentation/base-presentation-model.spec.js

@@ -1,4 +1,5 @@
 import { BasePresentationModel } from "./base-presentation-model.js";
+import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
 
 describe("#getVisibilityAndSequence", () => {
 	it("should return model defaults when no options", () => {
@@ -227,3 +228,79 @@ describe("#getTags", () => {
 		expect(tags).toEqual(["adjunctslide-tags"]);
 	});
 });
+
+describe("#filterScreenshotsByTeam", () => {
+	const screenshots = new DeckVersionScreenshotCollection([
+		{
+			subject: "/api/slides/1/",
+			image_256: "global-screenshot-1.png",
+			team: null,
+		},
+		{
+			subject: "/api/slides/2/",
+			image_256: "global-screenshot-2.png",
+			team: null,
+		},
+		{
+			subject: "/api/slides/1/",
+			image_256: "team-1-screenshot.png",
+			team: "/api/teams/1/",
+		},
+		{
+			subject: "/api/sections/2/",
+			image_256: "team-1-screenshot.png",
+			team: "/api/teams/1/",
+		},
+		// Just for testing that the team filters don't get cross-contaminated
+		{
+			subject: "/api/sections/2/",
+			image_256: "team-2-screenshot.png",
+			team: "/api/teams/2/",
+		},
+	]);
+
+	it("should just return global screenshots if team is null", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+			screenshots,
+			null
+		).toJSON();
+
+		expect(filtered).toEqual([
+			{
+				subject: "/api/slides/1/",
+				image_256: "global-screenshot-1.png",
+				team: null,
+			},
+			{
+				subject: "/api/slides/2/",
+				image_256: "global-screenshot-2.png",
+				team: null,
+			},
+		]);
+	});
+
+	it("should return globals with team override", () => {
+		const filtered = BasePresentationModel.filterScreenshotsByTeam(
+			screenshots,
+			1
+		).toJSON();
+
+		expect(filtered).toEqual([
+			{
+				image_256: "global-screenshot-2.png",
+				subject: "/api/slides/2/",
+				team: null,
+			},
+			{
+				image_256: "team-1-screenshot.png",
+				subject: "/api/sections/2/",
+				team: "/api/teams/1/",
+			},
+			{
+				image_256: "team-1-screenshot.png",
+				subject: "/api/slides/1/",
+				team: "/api/teams/1/",
+			},
+		]);
+	});
+});