@livepreso/api 6.40.0 → 6.43.0

package/src/models/auto-adjunct.js

@@ -2,8 +2,8 @@ import "./template.js";
 import "./team.js";
 import "./deck.js";
 
-import { register } from "../state-register.js";
 import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -38,7 +38,7 @@ export const AutoAdjunctModel = BaseModel.extend(
 			key: "string",
 			enabled: "boolean",
 			sequence: "number",
-			tags: "array"
+			tags: "array",
 		},
 
 		/**
@@ -48,8 +48,8 @@ export const AutoAdjunctModel = BaseModel.extend(
 		children: {
 			deck: "DeckModel",
 			template: "TemplateModel",
-			team: "TeamModel"
-		}
+			team: "TeamModel",
+		},
 	}
 );
 

package/src/models/base.js

@@ -1,18 +1,17 @@
-import url2 from "url";
+import { DATE_FORMAT_T, removeMultiByteChars } from "../utils.js";
 
-import Model from "ampersand-model";
+import { Api } from "../api.js";
 import Collection from "ampersand-rest-collection";
-import dedent from "dedent-js";
+import Model from "ampersand-model";
+import SuperAgentRequest from "superagent-bluebird-promise";
 import _ from "lodash";
+import dedent from "dedent-js";
+import log from "../log.js";
 import moment from "moment";
 import qs from "qs";
-import SuperAgentRequest from "superagent-bluebird-promise";
-
-import { Api } from "../api.js";
-import log from "../log.js";
 import { registeredStates } from "../state-register.js";
 import { sync } from "../sync.js";
-import { DATE_FORMAT_T, removeMultiByteChars } from "../utils.js";
+import url2 from "url";
 
 /**
  * @constructor
@@ -41,7 +40,7 @@ export const BaseModel = Model.extend(
 
 		constructor(data = {}, opts = {}) {
 			const options = _.defaults(opts, {
-				data: {}
+				data: {},
 			});
 
 			this._unsetChildren = {};
@@ -140,7 +139,7 @@ export const BaseModel = Model.extend(
 			const replacements = _.extend(
 				{},
 				{
-					detailKey: "number"
+					detailKey: "number",
 				},
 				this.urlMatchKeys
 			);
@@ -171,7 +170,7 @@ export const BaseModel = Model.extend(
 			// If that doesn't match, we can sometimes prevent a nasty log
 			// error from being thrown.
 			const split = urlStructure.split("/");
-			const argIndex = split.findIndex(val => {
+			const argIndex = split.findIndex((val) => {
 				return val.indexOf("{") === 0;
 			});
 
@@ -188,7 +187,7 @@ export const BaseModel = Model.extend(
 			let interpolatedString;
 			try {
 				interpolatedString = _.template(urlStructure.replace(/\./g, "_"), {
-					interpolate: /{([\s\S\.]+?)}/g
+					interpolate: /{([\s\S\.]+?)}/g,
 				})(regexes);
 			} catch (e) {
 				log.error(
@@ -249,10 +248,10 @@ export const BaseModel = Model.extend(
 
 		dataTypes: {
 			date: {
-				set: newVal => {
+				set: (newVal) => {
 					return {
 						val: newVal ? moment.utc(newVal).format(DATE_FORMAT_T) : null,
-						type: "date"
+						type: "date",
 					};
 				},
 				compare: (currentVal, newVal) => {
@@ -264,34 +263,34 @@ export const BaseModel = Model.extend(
 						return moment(currentVal).isSame(moment(newVal));
 					}
 					return currentVal !== newVal;
-				}
+				},
 			},
 			stringSanitized: {
-				set: newVal => {
+				set: (newVal) => {
 					return {
 						val: newVal ? removeMultiByteChars(newVal) : newVal,
-						type: "stringSanitized"
+						type: "stringSanitized",
 					};
 				},
 				compare: (currentVal, newVal) => {
 					return currentVal === newVal;
 				},
-				get: val => {
+				get: (val) => {
 					return val;
-				}
+				},
 			},
 			any: {
 				default: () => {
 					return null;
-				}
-			}
+				},
+			},
 		},
 
 		/**
 		 * @property {number} [id]
 		 */
 		props: {
-			id: { type: "any", required: false }
+			id: { type: "any", required: false },
 		},
 
 		/*
@@ -375,13 +374,13 @@ export const BaseModel = Model.extend(
 			// Set previously-initialised children & collections with new
 			// data retrieved during the fetch
 
-			Object.keys(this._children).forEach(key => {
+			Object.keys(this._children).forEach((key) => {
 				if (response[key]) {
 					this[key] = response[key];
 				}
 			});
 
-			Object.keys(this._collections).forEach(key => {
+			Object.keys(this._collections).forEach((key) => {
 				if (response[key]) {
 					this[key] = response[key];
 				}
@@ -389,7 +388,7 @@ export const BaseModel = Model.extend(
 		},
 
 		save() {
-			return Model.prototype.save.apply(this, arguments).tap(response => {
+			return Model.prototype.save.apply(this, arguments).tap((response) => {
 				this._updateResponse(response);
 			});
 		},
@@ -402,7 +401,7 @@ export const BaseModel = Model.extend(
 			this._options = _.extend({}, this._options, options);
 
 			this.isFetching = true;
-			return Model.prototype.fetch.apply(this, arguments).tap(response => {
+			return Model.prototype.fetch.apply(this, arguments).tap((response) => {
 				this.isFetching = false;
 				this._updateResponse(response);
 			});
@@ -414,7 +413,7 @@ export const BaseModel = Model.extend(
 			}
 			return SuperAgentRequest("OPTIONS", this.url())
 				.set(BaseModel.Auth.headers)
-				.then(res => {
+				.then((res) => {
 					if (res.body && res.body.actions) {
 						return res.body.actions;
 					}
@@ -441,13 +440,13 @@ export const BaseModel = Model.extend(
 				)
 			);
 
-			keys.forEach(key => {
+			keys.forEach((key) => {
 				if (!_.isUndefined(this._values[key])) {
 					attrs[key] = this._values[key];
 				}
 			});
 
-			Object.keys(this._expandedValues).forEach(key => {
+			Object.keys(this._expandedValues).forEach((key) => {
 				attrs[key] = this[key];
 			});
 
@@ -457,13 +456,13 @@ export const BaseModel = Model.extend(
 		// Unset all specified children and collection constructors and insert value
 		// definitions for them (necessary for Ampersand State to treat them as values)
 		_convertToValues() {
-			Object.keys(this._children).forEach(key => {
+			Object.keys(this._children).forEach((key) => {
 				this._definition[key] = { type: "any" };
 				this._unsetChildren[key] = this._children[key];
 				delete this._children[key];
 			});
 
-			Object.keys(this._collections).forEach(key => {
+			Object.keys(this._collections).forEach((key) => {
 				this._definition[key] = { type: "any" };
 				this._unsetCollections[key] = this._collections[key];
 				delete this._collections[key];
@@ -658,13 +657,13 @@ export const BaseModel = Model.extend(
 				return object;
 			}, {});
 
-			Object.keys(this._unsetCollections).forEach(key => {
+			Object.keys(this._unsetCollections).forEach((key) => {
 				if (this._unsetCollections[key].canBeEmpty && !this._values[key]) {
 					derived[key] = [];
 				}
 			});
 
-			Object.keys(this._unsetChildren).forEach(key => {
+			Object.keys(this._unsetChildren).forEach((key) => {
 				if (
 					this._unsetChildren[key].canBeEmpty &&
 					!this._values[key] &&
@@ -690,7 +689,7 @@ export const BaseModel = Model.extend(
 				return _.map(item.toJSON(), "url");
 			} else if (_.isArray(item)) {
 				// It's an array of urls or objects
-				return item.map(child => {
+				return item.map((child) => {
 					return this._retrieveURL(child);
 				});
 			} else if (typeof item === "object" && item !== null) {
@@ -698,7 +697,7 @@ export const BaseModel = Model.extend(
 			}
 
 			return null;
-		}
+		},
 	}
 );
 
@@ -807,11 +806,11 @@ function replacePropertyDefinition(object, name) {
 
 			return value;
 		},
-		configurable: true
+		configurable: true,
 	});
 }
 
 // Make matchesURL available as a static method
-BaseModel.matchesURL = function(url) {
+BaseModel.matchesURL = function (url) {
 	return this.prototype.matchesURL(url);
 };

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;
-		}
+		},
 	}
 );