@livepreso/api 6.41.0 → 6.44.0

package/src/models/base.spec.js

@@ -1,14 +1,13 @@
-import moment from "moment";
-import { G } from "sp-test/api";
-import td from "testdouble";
-
 import { Api } from "../api.js";
 import { BaseCollection } from "../collections/base.js";
-import log from "../log.js";
-import { DATE_FORMAT_T } from "../utils.js";
 import { BaseModel } from "./base.js";
+import { DATE_FORMAT_T } from "../utils.js";
+import { G } from "sp-test/api";
+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)", function () {
 	const TestModel = BaseModel.extend({ props: { testDate: "date" } });
 
 	const model = new TestModel();
@@ -49,22 +48,22 @@ 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", function () {
 	const TestModel = G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
-			children: { test: "TestModel" }
+			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", function () {
 	const TestModel = G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
-			children: { test: "TestModel" }
+			children: { test: "TestModel" },
 		})
 	);
 	const model = new Model({ test: new TestModel({ id: 1 }) });
@@ -72,11 +71,11 @@ 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", function () {
 	G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
-			children: { test: "TestModel" }
+			children: { test: "TestModel" },
 		})
 	);
 	const model = new Model({ test: 1 });
@@ -86,70 +85,70 @@ it("should reference parent model if foreign key exists", function() {
 it("should throw an error if the child model doesn't exist", () => {
 	const Model = G(
 		BaseModel.extend({
-			children: { test: "DoesntExist" }
+			children: { test: "DoesntExist" },
 		})
 	);
 
 	expect(() => new Model()).toThrow();
 });
 
-it("should convert a url into a model", function() {
+it("should convert a url into a model", function () {
 	G(BaseModel.extend({ modelName: "tests" }), "TestModel");
 	const Model = G(
 		BaseModel.extend({
-			children: { test: "TestModel" }
+			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 object into a model", function () {
 	G(BaseModel, "TestModel");
 	const Model = G(
 		BaseModel.extend({
-			children: { test: "TestModel" }
+			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", function () {
 	G(BaseModel, "TestModel");
 	const TestCollection = G(
 		BaseCollection.extend({
-			model: "TestModel"
+			model: "TestModel",
 		}),
 		"TestCollection"
 	);
 	const Model = G(
 		BaseModel.extend({
-			collections: { tests: "TestCollection" }
+			collections: { tests: "TestCollection" },
 		})
 	);
 	const model = new Model({
-		tests: [{ id: 1 }]
+		tests: [{ id: 1 }],
 	});
 	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", function () {
 	const TestModel = G(BaseModel, "TestModel");
 	G(
 		BaseCollection.extend({
-			model: "TestModel"
+			model: "TestModel",
 		}),
 		"TestCollection"
 	);
 	const Model = G(
 		BaseModel.extend({
-			collections: { tests: "TestCollection" }
+			collections: { tests: "TestCollection" },
 		})
 	);
 	const test = new TestModel({ id: 1 });
 	const model = new Model({
-		tests: [test]
+		tests: [test],
 	});
 	expect(model.tests.first().id).toEqual(1);
 });
@@ -158,24 +157,24 @@ it("should allow a collection to be passed in directly", () => {
 	G(BaseModel, "TestModel");
 	const TestCollection = G(
 		BaseCollection.extend({
-			model: "TestModel"
+			model: "TestModel",
 		}),
 		"TestCollection"
 	);
 	const Model = G(
 		BaseModel.extend({
-			collections: { tests: "TestCollection" }
+			collections: { tests: "TestCollection" },
 		})
 	);
 	const model = new Model({
-		tests: new TestCollection([{ id: 1 }])
+		tests: new TestCollection([{ id: 1 }]),
 	});
 	expect(model.tests).toBeInstanceOf(TestCollection);
 });
 
 it("should throw an error if the child collection doesn't exist", () => {
 	const Model = BaseModel.extend({
-		collections: { mustFail: "DoesntExist" }
+		collections: { mustFail: "DoesntExist" },
 	});
 	expect(() => new Model()).toThrow();
 });
@@ -184,13 +183,13 @@ it("should convert a url into a collection", () => {
 	G(BaseModel, "TestModel");
 	const TestCollection = G(
 		BaseCollection.extend({
-			model: "TestModel"
+			model: "TestModel",
 		}),
 		"TestCollection"
 	);
 	const Model = G(
 		BaseModel.extend({
-			collections: { tests: "TestCollection" }
+			collections: { tests: "TestCollection" },
 		})
 	);
 	const model = new Model({ tests: "/api/tests/" });
@@ -202,25 +201,25 @@ it("should convert an array of objects into a collection", () => {
 	G(BaseCollection.extend({ model: "TestModel" }), "TestCollection");
 	const Model = G(
 		BaseModel.extend({
-			collections: { tests: "TestCollection" }
+			collections: { tests: "TestCollection" },
 		})
 	);
 	const model = new Model({
-		tests: [{ id: 1 }, { id: 2 }]
+		tests: [{ id: 1 }, { id: 2 }],
 	});
 	expect(model.tests.at(0).id).toEqual(1);
 	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)", function () {
 	const TestModel = BaseModel.extend({
 		props: {
 			normalString: "string",
 			control: "stringSanitized",
 			withSpace: "stringSanitized",
 			withoutSpace: "stringSanitized",
-			withSpecialCharacters: "stringSanitized"
-		}
+			withSpecialCharacters: "stringSanitized",
+		},
 	});
 
 	const model = new TestModel({
@@ -228,7 +227,7 @@ it("should correctly sanitize strings of multibyte characters (preserving spaces
 		control: "ABC",
 		withSpace: "A’ B Cç",
 		withoutSpace: "AãB®C",
-		withSpecialCharacters: "!@#$%^&*()_+"
+		withSpecialCharacters: "!@#$%^&*()_+",
 	});
 
 	expect(model.normalString).toEqual("A’ B Cç");
@@ -242,8 +241,8 @@ it("should allow passing in another model into a model", () => {
 	const TestModel = BaseModel.extend({
 		modelName: "test",
 		props: {
-			foo: "string"
-		}
+			foo: "string",
+		},
 	});
 
 	const firstModel = new TestModel({ foo: "bar" });
@@ -255,7 +254,7 @@ it("should allow passing in another model into a model", () => {
 it("should retrieve the ID when there is no resource URL", () => {
 	const testURL = "http://localhost:9980/api/test/34/";
 	const TestModel = BaseModel.extend({
-		modelName: "test"
+		modelName: "test",
 	});
 
 	const testModel = new TestModel({ url: testURL });
@@ -267,7 +266,7 @@ it("should retrieve the ID when there is no resource URL", () => {
 it("should retrieve the ID when the resource URL is the same as the hostname", () => {
 	const testURL = "http://localhost:9980/api/test/34/";
 	const TestModel = BaseModel.extend({
-		modelName: "test"
+		modelName: "test",
 	});
 
 	TestModel.prototype.getResourceURL = jest.fn(() => {
@@ -282,7 +281,7 @@ it("should retrieve the ID when the resource URL is the same as the hostname", (
 it("should retrieve the ID when the resource hostname is different to the URL hostname", () => {
 	const testURL = "http://some-hostname/api/test/34/";
 	const TestModel = BaseModel.extend({
-		modelName: "test"
+		modelName: "test",
 	});
 
 	TestModel.prototype.getResourceURL = jest.fn(() => {
@@ -298,8 +297,8 @@ it("should pass through values into a derived model", () => {
 	const DerivedModel = BaseModel.extend({
 		modelName: "derived",
 		props: {
-			name: "string"
-		}
+			name: "string",
+		},
 	});
 	const TestModel = BaseModel.extend({
 		modelName: "test",
@@ -307,9 +306,9 @@ it("should pass through values into a derived model", () => {
 			myDerivedModel: {
 				fn() {
 					return new DerivedModel();
-				}
-			}
-		}
+				},
+			},
+		},
 	});
 
 	const model = new TestModel({ myDerivedModel: { id: 1, name: "foo" } });
@@ -322,15 +321,15 @@ it("should pass through values into a derived collection", () => {
 		BaseModel.extend({
 			modelName: "derived",
 			props: {
-				name: "string"
-			}
+				name: "string",
+			},
 		}),
 		"DerivedModel"
 	);
 
 	const DerivedCollection = G(
 		BaseCollection.extend({
-			model: "DerivedModel"
+			model: "DerivedModel",
 		})
 	);
 
@@ -341,15 +340,15 @@ it("should pass through values into a derived collection", () => {
 				myDerivedCollection: {
 					fn() {
 						return new DerivedCollection();
-					}
-				}
-			}
+					},
+				},
+			},
 		}),
 		"TestModel"
 	);
 
 	const model = new TestModel({
-		myDerivedCollection: [{ id: 1, name: "foo" }]
+		myDerivedCollection: [{ id: 1, name: "foo" }],
 	});
 	expect(model.myDerivedCollection.first().id).toEqual(1);
 	expect(model.myDerivedCollection.first().name).toEqual("foo");
@@ -358,14 +357,14 @@ it("should pass through values into a derived collection", () => {
 describe(".matchesURL", () => {
 	it("should have a model match the right url", () => {
 		const TestModel = G(BaseModel, "TestModel").extend({
-			modelName: "foo"
+			modelName: "foo",
 		});
 		expect(TestModel.matchesURL("/api/foo/1/")).toEqual(true);
 	});
 
 	it("should have a model not match the wrong url", () => {
 		const TestModel = G(BaseModel, "TestModel").extend({
-			modelName: "foo"
+			modelName: "foo",
 		});
 		expect(TestModel.matchesURL("/api/bar/1/")).toEqual(false);
 	});
@@ -376,7 +375,7 @@ describe(".matchesURL", () => {
 			modelName: "bar",
 			getResourceURL() {
 				return "/api/bar/{foo}/";
-			}
+			},
 		});
 		expect(TestModel.matchesURL("/api/foo/1/")).toEqual(false);
 		expect(errorFn).not.toBeCalled();
@@ -388,7 +387,7 @@ describe(".matchesURL", () => {
 			modelName: "bar",
 			getResourceURL() {
 				return "/api/bar/{foo}/";
-			}
+			},
 		});
 		expect(TestModel.matchesURL("/api/bar/1/")).toEqual(false);
 		expect(errorFn).toBeCalled();
@@ -399,11 +398,11 @@ describe(".matchesURL", () => {
 			modelName: "bar",
 			urlMatchKeys: {
 				foo: "string",
-				bar: "number"
+				bar: "number",
 			},
 			getResourceURL() {
 				return "/api/bar/{bar}/{foo}/";
-			}
+			},
 		});
 		expect(TestModel.matchesURL("/api/bar/1/hello/1/")).toEqual(true);
 	});
@@ -415,7 +414,7 @@ describe(".matchesURL", () => {
 		const ActivityModel = G("ActivityItemModel").extend({
 			getResourceURL() {
 				return `${endpoint}activities/`;
-			}
+			},
 		});
 		expect(ActivityModel.matchesURL(url)).toEqual(true);
 	});

package/src/models/choicelist.js

@@ -13,8 +13,8 @@ export const ChoicelistModel = BaseModel.extend(
 		props: {
 			modified_date: "date",
 			created_date: "date",
-			choices: "array"
-		}
+			choices: "array",
+		},
 	}
 );
 

package/src/models/cms-val.js

@@ -20,7 +20,7 @@ export const CMSValModel = BaseModel.extend(
 			key: "string",
 			scope: "string",
 			mime: "string",
-			value: "string"
+			value: "string",
 		},
 
 		/**
@@ -31,7 +31,7 @@ export const CMSValModel = BaseModel.extend(
 		children: {
 			user: "UserModel",
 			deck: "DeckModel",
-			team: "TeamModel"
+			team: "TeamModel",
 		},
 
 		url() {
@@ -54,7 +54,7 @@ export const CMSValModel = BaseModel.extend(
 			data.user = this.user ? this.user.url() : undefined;
 
 			return data;
-		}
+		},
 	}
 );
 

package/src/models/contact.js

@@ -3,8 +3,8 @@ import "./customer.js";
 import "./location.js";
 import "../collections/opportunities.js";
 
-import { register } from "../state-register.js";
 import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -42,14 +42,14 @@ export const ContactModel = BaseModel.extend(
 			photo_512: "string",
 			position: "string",
 			profile: "object",
-			fixture_key: "string"
+			fixture_key: "string",
 		},
 
 		/**
 		 * @property {collections.OpportunityCollection} opportunity_set
 		 */
 		collections: {
-			opportunity_set: "OpportunityCollection"
+			opportunity_set: "OpportunityCollection",
 		},
 
 		/**
@@ -60,7 +60,7 @@ export const ContactModel = BaseModel.extend(
 		children: {
 			location: "LocationModel",
 			customer: "CustomerModel",
-			user: "UserModel"
+			user: "UserModel",
 		},
 
 		/**
@@ -74,10 +74,10 @@ export const ContactModel = BaseModel.extend(
 			 */
 			fullName: {
 				deps: ["name_first", "name_last"],
-				fn: function() {
+				fn: function () {
 					return `${this.name_first} ${this.name_last}`;
-				}
-			}
+				},
+			},
 		},
 
 		toServer() {
@@ -91,7 +91,7 @@ export const ContactModel = BaseModel.extend(
 				opportunity_set: this._retrieveURL(this.opportunity_set),
 				customer: this._retrieveURL(this.customer),
 				location: this._retrieveURL(this.location),
-				user: this._retrieveURL(this.user)
+				user: this._retrieveURL(this.user),
 			};
 
 			if (this.id) {
@@ -99,7 +99,7 @@ export const ContactModel = BaseModel.extend(
 			}
 
 			return data;
-		}
+		},
 	}
 );
 

package/src/models/customer.js

@@ -5,8 +5,8 @@ import "../collections/locations.js";
 import "../collections/opportunities.js";
 import "../collections/teams.js";
 
-import { register } from "../state-register.js";
 import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -43,7 +43,7 @@ export const CustomerModel = BaseModel.extend(
 			profile: "object",
 			soft_deleted: "boolean",
 			title: "stringSanitized",
-			website: "string"
+			website: "string",
 		},
 
 		/**
@@ -52,7 +52,7 @@ export const CustomerModel = BaseModel.extend(
 		 */
 		children: {
 			default_location: "LocationModel",
-			default_opportunity: "OpportunityModel"
+			default_opportunity: "OpportunityModel",
 		},
 
 		/**
@@ -64,7 +64,7 @@ export const CustomerModel = BaseModel.extend(
 			contact_set: "ContactCollection",
 			opportunity_set: "OpportunityCollection",
 			location_set: "LocationCollection",
-			team_set: "TeamCollection"
+			team_set: "TeamCollection",
 		},
 
 		/**
@@ -74,26 +74,26 @@ export const CustomerModel = BaseModel.extend(
 		derived: {
 			logo: {
 				deps: ["logo_512", "profile"],
-				fn: function() {
+				fn: function () {
 					// HACK: Check for the REA usecase where it gets images from profile
 					if (this.profile && this.profile.rea_image_large) {
 						return this.profile.rea_image_large;
 					}
 
 					return this.logo_512;
-				}
+				},
 			},
 			primaryColour: {
 				deps: ["primary_colour", "profile"],
-				fn: function() {
+				fn: function () {
 					// HACK: Check for the REA usecase where it gets primary colour from profile
 					if (this.profile && this.profile.primary_colour) {
 						return this.profile.primary_colour;
 					}
 
 					return this.primary_colour;
-				}
-			}
+				},
+			},
 		},
 
 		fetch() {
@@ -112,11 +112,11 @@ 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 =>
+					const contactUrls = this.contact_set.map((contact) =>
 						this._retrieveUrl(contact)
 					);
 
-					const filteredContacts = topParent.contact_set.filter(contact => {
+					const filteredContacts = topParent.contact_set.filter((contact) => {
 						return contactUrls.indexOf(this._retrieveUrl(contact)) > -1;
 					});
 
@@ -131,7 +131,7 @@ export const CustomerModel = BaseModel.extend(
 				primary_colour: this.primary_colour,
 				title: this.title,
 				website: this.website,
-				team_set: this._retrieveURL(this.team_set)
+				team_set: this._retrieveURL(this.team_set),
 			};
 
 			if (this.id) {
@@ -139,7 +139,7 @@ export const CustomerModel = BaseModel.extend(
 			}
 
 			return data;
-		}
+		},
 	}
 );
 

package/src/models/deck-note.js

@@ -1,5 +1,5 @@
-import { register } from "../state-register.js";
 import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -22,14 +22,14 @@ export const DeckNoteModel = BaseModel.extend(
 			modified_date: "date",
 			note: "string",
 			mime: "string",
-			parent_key: "string"
+			parent_key: "string",
 		},
 
 		children: {
 			deck: "DeckModel",
 			user: "UserModel",
-			team: "TeamModel"
-		}
+			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);