@livepreso/api 6.44.0 → 6.46.0

package/src/models/asset.js

@@ -33,6 +33,20 @@ export const AssetModel = BaseModel.extend(
 			orig_path: "string",
 		},
 
+		/**
+		 * The asset serializer actually returns the file in question for the URL.
+		 * This method returns the actual URL of the asset endpoint, for example:
+		 *
+		 * /api/assets/2/
+		 */
+		assetURL() {
+			// HACK: For some reason the API endpoint returns a url with a pack in it, but
+			// this doesn't actually work. We just want the 'asset' url.
+			return `${this.getResourceURL().replace("/packs/{pack.id}", "")}${
+				this.id
+			}/`;
+		},
+
 		/**
 		 * @property {models.PackModel} pack
 		 */
@@ -43,7 +57,7 @@ export const AssetModel = BaseModel.extend(
 		url() {
 			return this._url;
 		},
-	}
+	},
 );
 
 register("AssetModel", AssetModel);

package/src/models/auto-adjunct-key-check.js

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

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,8 @@ export const AutoAdjunctModel = BaseModel.extend(
 			enabled: "boolean",
 			sequence: "number",
 			tags: "array",
+			cmsvalkey_set: "array",
+			_tenancy: "object",
 		},
 
 		/**
@@ -50,7 +53,7 @@ export const AutoAdjunctModel = BaseModel.extend(
 			template: "TemplateModel",
 			team: "TeamModel",
 		},
-	}
+	},
 );
 
 register("AutoAdjunctModel", AutoAdjunctModel);

package/src/models/base.js

@@ -21,11 +21,16 @@ export const BaseModel = Model.extend(
 	/** @lends models.BaseModel# */ {
 		modelName: null,
 		queryData: {},
+		detailType: "number",
 
 		// This is unfortunately necessary to avoid the default ampersand model/state
 		// 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 +43,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 +68,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);
@@ -86,6 +100,15 @@ export const BaseModel = Model.extend(
 				if (def && (def.isState || def instanceof Collection)) {
 					dataCopy[key] = def.toJSON();
 				}
+
+				if (def && Array.isArray(def)) {
+					dataCopy[key] = def.map((obj) => {
+						if (obj instanceof Model) {
+							return obj.toJSON();
+						}
+						return obj;
+					});
+				}
 			}
 
 			this.registerStates();
@@ -118,7 +141,7 @@ export const BaseModel = Model.extend(
 					for (const derivedProp of Object.keys(this._data[derivedKey])) {
 						this[derivedKey].set(
 							derivedProp,
-							this._data[derivedKey][derivedProp]
+							this._data[derivedKey][derivedProp],
 						);
 					}
 				}
@@ -139,9 +162,9 @@ export const BaseModel = Model.extend(
 			const replacements = _.extend(
 				{},
 				{
-					detailKey: "number",
+					detailKey: this.detailType,
 				},
-				this.urlMatchKeys
+				this.urlMatchKeys,
 			);
 
 			const regexes = Object.keys(replacements).reduce((result, key) => {
@@ -149,6 +172,8 @@ export const BaseModel = Model.extend(
 				const name = key.replace(/\./g, "_");
 				if (type === "number") {
 					result[name] = "\\d+";
+				} else if (type === "uuid") {
+					result[name] = "([a-z]|[0-9]|-)+";
 				} else if (type === "string") {
 					result[name] = "\\w+";
 				} else {
@@ -195,7 +220,7 @@ export const BaseModel = Model.extend(
 				Failed to match URL '${url}' for model '${this.modelName}'.
 				This is usually because the regex type for a key hasn't been set.
 				Error: `,
-					e
+					e,
 				);
 				return false;
 			}
@@ -213,8 +238,8 @@ export const BaseModel = Model.extend(
 		// and we want to ignore the hostname (https://staging-demo.salespreso.com)
 		// and strip out the '/api' from both the resource url and the variable url
 		// so that we can use the remaining part to isolate the id
-		_getIDFromURL(url) {
-			const resourceURL = this.getResourceURL();
+		_getIDFromURL(url, resource = "") {
+			const resourceURL = resource || this.getResourceURL();
 
 			if (!url || !resourceURL) {
 				return null;
@@ -305,7 +330,7 @@ export const BaseModel = Model.extend(
 			const Model = registeredStates[model];
 			if (!Model) {
 				throw new Error(
-					`'${model}' not found! Did you forget to import it on the '${this.modelName}' model?`
+					`'${model}' not found! Did you forget to import it on the '${this.modelName}' model?`,
 				);
 			}
 			this._children[prop] = Model;
@@ -315,7 +340,7 @@ export const BaseModel = Model.extend(
 			const Collection = state[collection];
 			if (!Collection) {
 				throw new Error(
-					`'${collection}' not found! Did you forget to import it on the '${this.modelName}' model?`
+					`'${collection}' not found! Did you forget to import it on the '${this.modelName}' model?`,
 				);
 			}
 			this._collections[prop] = Collection;
@@ -349,7 +374,7 @@ export const BaseModel = Model.extend(
 						}
 					}
 				},
-				this
+				this,
 			);
 
 			// Loop throught the collections and replace with the registered collection
@@ -360,7 +385,7 @@ export const BaseModel = Model.extend(
 						this._registerCollection(registeredStates, prop, collection);
 					}
 				},
-				this
+				this,
 			);
 		},
 
@@ -402,6 +427,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 +447,10 @@ export const BaseModel = Model.extend(
 				});
 		},
 
+		isFetched() {
+			return this._isFetched;
+		},
+
 		getSafeAttrs(key) {
 			if (!_.isUndefined(key)) {
 				return !_.isUndefined(this._expandedValues[key])
@@ -434,10 +464,10 @@ export const BaseModel = Model.extend(
 				_.concat(
 					_.concat(
 						Object.keys(this._unsetChildren),
-						Object.keys(this._unsetCollections)
+						Object.keys(this._unsetCollections),
 					),
-					Object.keys(this._values)
-				)
+					Object.keys(this._values),
+				),
 			);
 
 			keys.forEach((key) => {
@@ -490,12 +520,12 @@ export const BaseModel = Model.extend(
 				if (typeof this._children[child] === "function") {
 					this._safeSet(
 						child,
-						new this._children[child](val, { parent: this })
+						new this._children[child](val, { parent: this }),
 					);
 					this.listenTo(
 						this[child],
 						"all",
-						this._getCachedEventBubblingHandler(child)
+						this._getCachedEventBubblingHandler(child),
 					);
 				} else {
 					this._safeSet(child, val);
@@ -523,7 +553,7 @@ export const BaseModel = Model.extend(
 				if (typeof this._collections[coll] === "function") {
 					this._safeSet(
 						coll,
-						new this._collections[coll](val, { parent: this })
+						new this._collections[coll](val, { parent: this }),
 					);
 				} else {
 					this._safeSet(coll, val);
@@ -583,7 +613,6 @@ export const BaseModel = Model.extend(
 			if (this._url && this.isNew()) {
 				return this.getFullURLPath(this._url);
 			}
-
 			return this.getFullURLPath(this.getPlainURL());
 		},
 
@@ -599,6 +628,10 @@ export const BaseModel = Model.extend(
 				resp += "/";
 			}
 
+			if (!resp.includes("{") || !resp.includes("}")) {
+				return resp;
+			}
+
 			// Replace any values in a url with one from the model.
 			// So if you have /path/to/{model.id}/
 			// It will check the model from "this.model.id" and replace
@@ -637,7 +670,7 @@ export const BaseModel = Model.extend(
 			return sync.apply(this, arguments);
 		},
 
-		serialize() {
+		serialize(opts = { derived: true }) {
 			// Return nothing if data passed is falsy. More than likely this is
 			// a null value
 			if (!this._data) {
@@ -647,7 +680,7 @@ export const BaseModel = Model.extend(
 			const data = Model.prototype.serialize.apply(this, arguments);
 			data.url = this.url();
 
-			let derived = this.getAttributes({ derived: true });
+			let derived = this.getAttributes(opts);
 			derived = Object.keys(derived).reduce((object, key) => {
 				let value = derived[key];
 				if (value instanceof Collection || value instanceof Model) {
@@ -698,7 +731,7 @@ export const BaseModel = Model.extend(
 
 			return null;
 		},
-	}
+	},
 );
 
 function replacePropertyDefinition(object, name) {
@@ -767,7 +800,7 @@ function replacePropertyDefinition(object, name) {
 		get() {
 			if (!this._values) {
 				throw new Error(
-					`Trying to retrieve value ${name} of model ${object.modelName} during constructor`
+					`Trying to retrieve value ${name} of model ${object.modelName} during constructor`,
 				);
 			}
 

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,35 +48,35 @@ 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({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: 1 });
 	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({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: new TestModel({ id: 1 }) });
 	expect(model.test.id).toEqual(1);
 	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({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: 1 });
 	expect(model).toEqual(model.test.parent);
@@ -86,46 +86,53 @@ it("should throw an error if the child model doesn't exist", () => {
 	const Model = G(
 		BaseModel.extend({
 			children: { test: "DoesntExist" },
-		})
+		}),
 	);
 
 	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({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: "/api/tests/1/" });
 	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({
 			children: { test: "TestModel" },
-		})
+		}),
 	);
 	const model = new Model({ test: { id: 1 } });
 	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({
 			model: "TestModel",
 		}),
-		"TestCollection"
+		"TestCollection",
 	);
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const model = new Model({
 		tests: [{ id: 1 }],
@@ -133,18 +140,18 @@ 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({
 			model: "TestModel",
 		}),
-		"TestCollection"
+		"TestCollection",
 	);
 	const Model = G(
 		BaseModel.extend({
 			collections: { tests: "TestCollection" },
-		})
+		}),
 	);
 	const test = new TestModel({ id: 1 });
 	const model = new Model({
@@ -159,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 }]),
@@ -185,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);
@@ -202,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 }],
@@ -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",
@@ -324,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(
@@ -344,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;