@livepreso/api 6.45.0 → 6.46.0

package/src/models/base.spec.js

@@ -53,7 +53,7 @@ it("should replace child model strings with the registered model", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: 1 });
 	expect(model.test).toBeInstanceOf(TestModel);
@@ -64,7 +64,7 @@ it("should allow the model to be passed in", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: new TestModel({ id: 1 }) });
 	expect(model.test.id).toEqual(1);
@@ -76,7 +76,7 @@ it("should reference parent model if foreign key exists", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: 1 });
 	expect(model).toEqual(model.test.parent);
@@ -86,7 +86,7 @@ it("should throw an error if the child model doesn't exist", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "DoesntExist" },
-		})
+		}),
 	);
 
 	expect(() => new Model()).toThrow();
@@ -97,7 +97,7 @@ it("should convert a url into a model", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: "/api/tests/1/" });
 	expect(model.test.id).toEqual(1);
@@ -115,7 +115,7 @@ it("should convert an object into a model", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: { id: 1 } });
 	expect(model.test.id).toEqual(1);
@@ -127,12 +127,12 @@ it("should replace collection strings with their registered state", () => {
 		BaseCollection.extend({
 			model: "TestModel",
 		}),
-		"TestCollection"
+		"TestCollection",
 	);
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const model = new Model({
 		tests: [{ id: 1 }],
@@ -146,12 +146,12 @@ it("should allow a list of models to be passed into a collection", () => {
 		BaseCollection.extend({
 			model: "TestModel",
 		}),
-		"TestCollection"
+		"TestCollection",
 	);
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const test = new TestModel({ id: 1 });
 	const model = new Model({
@@ -166,12 +166,12 @@ it("should allow a collection to be passed in directly", () => {
 		BaseCollection.extend({
 			model: "TestModel",
 		}),
-		"TestCollection"
+		"TestCollection",
 	);
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const model = new Model({
 		tests: new TestCollection([{ id: 1 }]),
@@ -192,12 +192,12 @@ it("should convert a url into a collection", () => {
 		BaseCollection.extend({
 			model: "TestModel",
 		}),
-		"TestCollection"
+		"TestCollection",
 	);
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const model = new Model({ tests: "/api/tests/" });
 	expect(model.tests).toBeInstanceOf(TestCollection);
@@ -209,7 +209,7 @@ it("should convert an array of objects into a collection", () => {
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const model = new Model({
 		tests: [{ id: 1 }, { id: 2 }],
@@ -331,13 +331,13 @@ it("should pass through values into a derived collection", () => {
 				name: "string",
 			},
 		}),
-		"DerivedModel"
+		"DerivedModel",
 	);
 
 	const DerivedCollection = G(
 		BaseCollection.extend({
 			model: "DerivedModel",
-		})
+		}),
 	);
 
 	const TestModel = G(
@@ -351,7 +351,7 @@ it("should pass through values into a derived collection", () => {
 				},
 			},
 		}),
-		"TestModel"
+		"TestModel",
 	);
 
 	const model = new TestModel({

package/src/models/choicelist.js

@@ -15,7 +15,7 @@ export const ChoicelistModel = BaseModel.extend(
 			created_date: "date",
 			choices: "array",
 		},
-	}
+	},
 );
 
 register("ChoicelistModel", ChoicelistModel);

package/src/models/cms-val.js

@@ -4,6 +4,7 @@ import "./deck.js";
 
 import { BaseModel } from "../models/base.js";
 import { register } from "../state-register.js";
+import { sanitizeBase64 } from "../utils.js";
 
 /**
  * @constructor
@@ -21,6 +22,7 @@ export const CMSValModel = BaseModel.extend(
 			scope: "string",
 			mime: "string",
 			value: "string",
+			_tenancy: "object",
 		},
 
 		/**
@@ -55,7 +57,28 @@ export const CMSValModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+
+		toServer() {
+			const obj = BaseModel.prototype.toServer.call(this);
+			return {
+				...obj,
+				// We shouldn't allow any base64 to get in here, otherwise it can
+				// KO all users appointments.
+				value: sanitizeBase64(obj.value),
+			};
+		},
+
+		toCompactJSON() {
+			const json = this.toJSON();
+			const wanted = ["key", "value", "mime", "scope"];
+
+			const compact = Object.fromEntries(
+				Object.entries(json).filter(([key, val]) => wanted.includes(key)),
+			);
+
+			return compact;
+		},
+	},
 );
 
 register("CMSValModel", CMSValModel);

package/src/models/cms-val.spec.js

@@ -0,0 +1,14 @@
+import { G } from "sp-test/api";
+
+it("should remove large base64 strings from value when saving", async () => {
+	const CMSValModel = G("CMSValModel");
+	const largeBase64 =
+		"data:image/gif;base64," + new Array(50_000).fill("a").join("");
+
+	const cmsVal = new CMSValModel({
+		mime: "image",
+		value: largeBase64,
+	});
+
+	expect(cmsVal.toServer().value).toEqual("");
+});

package/src/models/contact-phone.js

@@ -0,0 +1,57 @@
+import "./customer.js";
+
+import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
+
+/**
+ * @constructor
+ * @alias models.ContactModel
+ * @extends models.BaseModel
+ */
+export const ContactPhoneModel = BaseModel.extend(
+	/** @lends models.ContactPhoneModel# */ {
+		modelName: "contact-phones",
+
+		/**
+		 * @property {date} created_date
+		 * @property {date} modified_date
+		 * @property {boolean} is_valid
+		 * @property {string} raw
+		 * @property {string} e164_format
+		 * @property {string} national_format
+		 * @property {string} number_type
+		 */
+		props: {
+			created_date: "date",
+			modified_date: "date",
+			is_valid: "boolean",
+			raw: "string",
+			e164_format: "string",
+			national_format: "string",
+			number_type: "string",
+		},
+
+		/**
+		 * @property {models.ContactModel} contact
+		 */
+		children: {
+			contact: "ContactModel",
+		},
+
+		toServer() {
+			/* Only write to `raw` field. The others are derived on the server */
+			const data = {
+				raw: this.raw,
+				contact: this._retrieveURL(this.contact),
+			};
+
+			if (this.id) {
+				data.id = this.id;
+			}
+
+			return data;
+		},
+	},
+);
+
+register("ContactPhoneModel", ContactPhoneModel);

package/src/models/contact.js

@@ -100,7 +100,7 @@ export const ContactModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("ContactModel", ContactModel);

package/src/models/customer.js

@@ -76,7 +76,7 @@ export const CustomerModel = BaseModel.extend(
 				deps: ["logo_512", "profile"],
 				fn: function () {
 					// HACK: Check for the REA usecase where it gets images from profile
-					if (this.profile && this.profile.rea_image_large) {
+					if (this.profile?.rea_image_large) {
 						return this.profile.rea_image_large;
 					}
 
@@ -113,7 +113,7 @@ export const CustomerModel = BaseModel.extend(
 				// Filter contacts if this is fetched from an appointment
 				if (topParent && topParent.name === "appointments") {
 					const contactUrls = this.contact_set.map((contact) =>
-						this._retrieveUrl(contact)
+						this._retrieveUrl(contact),
 					);
 
 					const filteredContacts = topParent.contact_set.filter((contact) => {
@@ -140,7 +140,7 @@ export const CustomerModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("CustomerModel", CustomerModel);

package/src/models/deck-note.js

@@ -30,7 +30,7 @@ export const DeckNoteModel = BaseModel.extend(
 			user: "UserModel",
 			team: "TeamModel",
 		},
-	}
+	},
 );
 
 DeckNoteModel.canBeEmpty = true;

package/src/models/deck-tags.js

@@ -44,7 +44,7 @@ export const DeckTagsModel = BaseModel.extend(
 				this.items = tags;
 			});
 		},
-	}
+	},
 );
 
 DeckTagsModel.canBeEmpty = true;

package/src/models/deck-version-screenshot.js

@@ -42,7 +42,7 @@ export const DeckVersionScreenshotModel = BaseModel.extend(
 			const data = BaseModel.prototype.serialize.call(this);
 			return _.omit(data, ["url"]);
 		},
-	}
+	},
 );
 
 register("DeckVersionScreenshotModel", DeckVersionScreenshotModel);

package/src/models/deck-version.js

@@ -1,6 +1,5 @@
 import "../collections/sections.js";
 import "../collections/deck-notes.js";
-import "../collections/templates.js";
 import "./pack.js";
 import "./deck.js";
 import "./asset.js";
@@ -9,6 +8,7 @@ import "./manifest-json.js";
 import { BaseModel } from "./base.js";
 import { DeckVersionScreenshotCollection } from "../collections/deck-version-screenshots.js";
 import Promise from "bluebird";
+import { TemplateCollection } from "../collections.js";
 import _ from "lodash";
 import { register } from "../state-register.js";
 import superagent from "superagent";
@@ -80,12 +80,10 @@ export const DeckVersionModel = BaseModel.extend(
 		/**
 		 * @property {collections.SectionCollection} section_set
 		 * @property {models.DeckNoteCollection} note_set
-		 * @property {models.TemplateCollection} template_set
 		 */
 		collections: {
 			section_set: "SectionCollection",
 			note_set: "DeckNoteCollection",
-			template_set: "TemplateCollection",
 		},
 
 		/**
@@ -99,17 +97,33 @@ export const DeckVersionModel = BaseModel.extend(
 						{},
 						{
 							deckversion: this,
-						}
+						},
 					);
 					return screenshots;
 				},
 			},
+
+			template_set: {
+				deps: ["id"],
+				fn: function () {
+					const templates = new TemplateCollection(
+						{},
+						{
+							data: {
+								deckversion: this.id,
+								scope: "global",
+							},
+						},
+					);
+					return templates;
+				},
+			},
 		},
 
 		getHooksPath() {
 			if (this.isNew()) {
 				throw new Error(
-					"Can only get hooks from a fetched deckversion or at least have an ID"
+					"Can only get hooks from a fetched deckversion or at least have an ID",
 				);
 			}
 
@@ -178,6 +192,17 @@ export const DeckVersionModel = BaseModel.extend(
 			return Promise.all(imports);
 		},
 
+		fetch() {
+			const fetch = BaseModel.prototype.fetch.apply(this, arguments);
+
+			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();
+			});
+		},
+
 		waitForReady() {
 			return this.fetch().then(() => {
 				if (["created", "failed"].indexOf(this.creation_status) > -1) {
@@ -204,7 +229,7 @@ export const DeckVersionModel = BaseModel.extend(
 				upgrade_description: this.upgrade_description,
 			};
 		},
-	}
+	},
 );
 
 register("DeckVersionModel", DeckVersionModel);

package/src/models/deck.js

@@ -56,7 +56,7 @@ export const DeckModel = BaseModel.extend(
 			head_version: "DeckVersionModel",
 			tags: "DeckTagsModel",
 		},
-	}
+	},
 );
 
 register("DeckModel", DeckModel);

package/src/models/dispatch-preview.js

@@ -28,7 +28,7 @@ export const DispatchPreviewModel = BaseModel.extend(
 					throw e;
 				});
 		},
-	}
+	},
 );
 
 register("DispatchPreviewModel", DispatchPreviewModel);

package/src/models/dispatch.js

@@ -105,7 +105,7 @@ export const DispatchModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("DispatchModel", DispatchModel);

package/src/models/event-object.js

@@ -33,7 +33,7 @@ export const EventObjectModel = BaseModel.extend(
 		children: {
 			event: "EventModel",
 		},
-	}
+	},
 );
 
 register("EventObjectModel", EventObjectModel);

package/src/models/event.js

@@ -41,7 +41,7 @@ export const EventModel = BaseModel.extend(
 		collections: {
 			eventobject_set: "EventObjectCollection",
 		},
-	}
+	},
 );
 
 register("EventModel", EventModel);

package/src/models/feed-data.js

@@ -19,7 +19,7 @@ export const FeedDataModel = BaseModel.extend(
 		 */
 		props: {
 			feed_data: "object",
-			feed_debug: {type: "object", default: () => {}},
+			feed_debug: { type: "object", default: () => {} },
 			creation_status: "string",
 		},
 
@@ -42,7 +42,7 @@ export const FeedDataModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("FeedDataModel", FeedDataModel);

package/src/models/file.js

@@ -31,7 +31,7 @@ export const FileModel = BaseModel.extend(
 		children: {
 			event: "UserModel",
 		},
-	}
+	},
 );
 
 register("FileModel", FileModel);

package/src/models/group.js

@@ -24,7 +24,7 @@ export const GroupModel = BaseModel.extend(
 			const urlRoot = Api.getURL();
 			return `${urlRoot}groups/`;
 		},
-	}
+	},
 );
 
 register("GroupModel", GroupModel);

package/src/models/handover.js

@@ -46,7 +46,7 @@ export const HandoverModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("HandoverModel", HandoverModel);

package/src/models/hosted-preso.js

@@ -44,7 +44,7 @@ export const HostedPresoModel = BaseModel.extend(
 		collections: {
 			user_set: "UserCollection",
 		},
-	}
+	},
 );
 
 register("HostedPresoModel", HostedPresoModel);

package/src/models/image.js

@@ -69,7 +69,7 @@ export const ImageModel = BaseModel.extend(
 					});
 				});
 		},
-	}
+	},
 );
 
 register("ImageModel", ImageModel);

package/src/models/location.js

@@ -57,7 +57,7 @@ export const LocationModel = BaseModel.extend(
 		collections: {
 			contact_set: "ContactCollection",
 		},
-	}
+	},
 );
 
 register("LocationModel", LocationModel);

package/src/models/manifest-json.js

@@ -57,7 +57,8 @@ export const ManifestJSONModel = BaseModel.extend(
 				},
 			},
 			dimensions: {
-				type: "object",
+				// This could be a list or an object
+				type: "any",
 				default: function () {
 					return {
 						width: 1024,
@@ -107,6 +108,45 @@ export const ManifestJSONModel = BaseModel.extend(
 			},
 		},
 
+		derived: {
+			// Most places just need this value, and making it derived
+			// gives us lower overhead (when we convert with .toJSON() it will
+			// also include this value, and means we don't have to convert back to
+			// a model just to get this again.)
+			screenDimensions: {
+				deps: ["dimensions"],
+				fn: function () {
+					return this.getScreenDimensions();
+				},
+			},
+		},
+
+		getDimensionsByName(name) {
+			if (Array.isArray(this.dimensions)) {
+				const dimension = this.dimensions.find(
+					(d) => d.name.toLowerCase() === name.toLowerCase(),
+				);
+				if (!dimension) {
+					return { width: 1024, height: 767 };
+				}
+				return { width: dimension.width, height: dimension.height };
+			}
+			return this.dimensions;
+		},
+
+		getScreenDimensions() {
+			return this.getDimensionsByName("screen");
+		},
+
+		getPDFDimensions() {
+			if (Array.isArray(this.dimensions)) {
+				const defaultPDFDimensions =
+					this.pdfpreferences?.defaultDimensions || "screen";
+				return this.getDimensionsByName(defaultPDFDimensions);
+			}
+			return this.dimensions;
+		},
+
 		/**
 		 * Returns the path to a manifest asset, using its url as the base.
 		 * @param {?string} key
@@ -117,7 +157,7 @@ export const ManifestJSONModel = BaseModel.extend(
 				const [sectionKey, slideKey = null] = key.split("/");
 				const sectionKeyPath = url2.resolve(
 					this.url(),
-					`sections/${sectionKey}/`
+					`sections/${sectionKey}/`,
 				);
 				if (slideKey) {
 					return url2.resolve(sectionKeyPath, `slides/${slideKey}/`);
@@ -144,7 +184,7 @@ export const ManifestJSONModel = BaseModel.extend(
 
 			return BaseModel.prototype.url.call(this);
 		},
-	}
+	},
 );
 
 /**
@@ -204,7 +244,7 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 			};
 			return templates;
 		},
-		{}
+		{},
 	);
 
 	const limits = {
@@ -278,7 +318,18 @@ ManifestJSONModel.createFromProject = function (projectFile) {
 	}
 
 	if (projectFile.dimensions) {
-		manifest.dimensions = projectFile.dimensions;
+		const { dimensions } = projectFile;
+
+		if (Array.isArray(dimensions)) {
+			const screen = dimensions.filter((d) => d.name === "Screen");
+			if (!screen.length || screen.length > 1) {
+				throw new Error(
+					"Dimensions must contain one value named 'Screen' in project.yaml",
+				);
+			}
+		}
+
+		manifest.dimensions = dimensions;
 	}
 
 	if (projectFile.has_editable_share_support) {

package/src/models/onshare.js

@@ -50,7 +50,7 @@ export const OnShareModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("OnShareModel", OnShareModel);

package/src/models/opportunity.js

@@ -47,7 +47,7 @@ export const OpportunityModel = BaseModel.extend(
 		children: {
 			customer: "CustomerModel",
 		},
-	}
+	},
 );
 
 register("OpportunityModel", OpportunityModel);

package/src/models/pack-diff.js

@@ -55,7 +55,7 @@ export const PackDiffModel = BaseModel.extend(
 
 			return data;
 		},
-	}
+	},
 );
 
 register("PackDiffModel", PackDiffModel);