@livepreso/api 6.41.0 → 6.44.0

package/src/collections/appointment-tags.js

@@ -0,0 +1,136 @@
+import { getState, register } from "../state-register.js";
+
+import { BaseCollection } from "./base.js";
+import _ from "lodash";
+
+/**
+ * @constructor
+ * @alias collections.AppointmentTagsCollection
+ * @extends collections.BaseCollection
+ * @see models.AppointmentTagsModel
+ */
+export const AppointmentTagsCollection = BaseCollection.extend(
+	/** @lends collections.AppointmentTagsCollection# */ {
+		model: "AppointmentTagsModel",
+
+		tagNameCollectionMapping: {
+			deckversion: "AppointmentDeckVersionTagsCollection",
+			section: "AppointmentSectionTagsCollection",
+			slide: "AppointmentSlideTagsCollection",
+			adjunct: "AppointmentAdjunctTagsCollection",
+		},
+
+		_mapResultsToModel(result) {
+			// Maps a model from a content specific tag to a more generic one.
+			// It's generally the same thing, except instead of something like:
+			//
+			//  slide: "/api/slides/1/"
+			//
+			// It becomes:
+			//
+			//  content_type: "slide",
+			//  content_url: "/api/slides/1/"
+			//
+			// So that we can return the list side by side.
+			const AppointmentTagsModel = getState("AppointmentTagsModel");
+			const resultType = Object.keys(result).find((key) => {
+				return Object.keys(this.tagNameCollectionMapping).includes(key);
+			});
+			if (!resultType) {
+				throw new Error("Unknown type of result found");
+			}
+			return new AppointmentTagsModel({
+				tags: result.tags,
+				content_type: resultType,
+				content_url: result[resultType],
+				appointment: result.appointment,
+				user: result.user,
+				url: result.url,
+			});
+		},
+
+		// These methods don't quite make sense right now, disable it for development.
+		async fetchSet() {
+			throw new Error("Not implemented");
+		},
+
+		async fetchModels() {
+			throw new Error("Not implemented");
+		},
+
+		async delete() {
+			throw new Error("Cannot delete using this collection");
+		},
+
+		async save() {
+			throw new Error("Not implemented");
+		},
+
+		async fetch(options) {
+			const AppointmentModel = getState("AppointmentModel");
+
+			let hasAppointment =
+				this._options?.appointment instanceof AppointmentModel ||
+				options?.appointment instanceof AppointmentModel;
+
+			if (!hasAppointment && this.parent instanceof AppointmentModel) {
+				options.appointment = this.parent;
+				hasAppointment = true;
+			}
+
+			if (!hasAppointment) {
+				throw new Error(
+					"Requires an appointment model in collection options to fetch."
+				);
+			}
+
+			const tagModels = Object.values(this.tagNameCollectionMapping);
+			// Fetch all the separate tag models and combine them into a single collection
+			const results = (
+				await Promise.all(
+					tagModels.map((tagModel) => {
+						const Collection = getState(tagModel);
+						const tags = new Collection({}, this._options);
+						return tags.fetch(options);
+					})
+				)
+			)
+				.flatMap((collection) => collection.results)
+				.map(this._mapResultsToModel.bind(this));
+
+			this.add(results);
+
+			return {
+				count: results.length,
+				next: null,
+				previous: null,
+				results: this.toJSON(),
+			};
+		},
+
+		// Used by Telepresenter to add the tags in the hostedpreso bundle to
+		// the appointment tags collection
+		addFromAppointment(appointment) {
+			const tagCollectionNames = [
+				"appointmentdeckversiontags_set",
+				"appointmentsectiontags_set",
+				"appointmentslidetags_set",
+				"appointmentadjuncttags_set",
+			];
+
+			// flatMap currently doesn't work in TelePresenter
+			const results = _.flatten(
+				tagCollectionNames.map((collectionName) => {
+					const collection = appointment[collectionName];
+					return collection?._data || [];
+				})
+			).map(this._mapResultsToModel.bind(this));
+
+			this.add(results);
+		},
+	}
+);
+
+AppointmentTagsCollection.canBeEmpty = true;
+
+register("AppointmentTagsCollection", AppointmentTagsCollection);

package/src/collections/appointments.js

@@ -1,11 +1,10 @@
 import "../models/appointment.js";
 
-import moment from "moment";
-
 import { Auth } from "../auth.js";
+import { BaseCollection } from "./base.js";
 import log from "../log.js";
+import moment from "moment";
 import { register } from "../state-register.js";
-import { BaseCollection } from "./base.js";
 
 /**
  * @constructor
@@ -47,7 +46,11 @@ export const AppointmentCollection = BaseCollection.extend(
 		) {
 			return this.fetch({
 				...options,
-				data: AppointmentCollection.monthParametersForUser(date, userID, "sort")
+				data: AppointmentCollection.monthParametersForUser(
+					date,
+					userID,
+					"sort"
+				),
 			});
 		},
 
@@ -62,7 +65,7 @@ export const AppointmentCollection = BaseCollection.extend(
 					date,
 					userID,
 					"sort"
-				)
+				),
 			});
 		},
 
@@ -78,9 +81,9 @@ export const AppointmentCollection = BaseCollection.extend(
 					date,
 					userID,
 					"created"
-				)
+				),
 			});
-		}
+		},
 	}
 );
 
@@ -93,22 +96,18 @@ export const AppointmentCollection = BaseCollection.extend(
  * @param {string} [parameter="sort"]
  * @returns {object}
  */
-AppointmentCollection.fortnightParametersForUser = function(
+AppointmentCollection.fortnightParametersForUser = function (
 	date,
 	userID = Auth.user.id,
 	parameter = "sort"
 ) {
-	const dateFrom = moment(date)
-		.subtract(1, "week")
-		.format();
-	const dateTo = moment(date)
-		.add(1, "week")
-		.format();
+	const dateFrom = moment(date).subtract(1, "week").format();
+	const dateTo = moment(date).add(1, "week").format();
 
 	// The server only returns apts with 'ready' creation status by default
 	const data = {
 		user: userID,
-		creation_status: ["processing", "ready"]
+		creation_status: ["processing", "ready"],
 	};
 
 	data[`${parameter}_date__gte`] = dateFrom;
@@ -126,22 +125,18 @@ AppointmentCollection.fortnightParametersForUser = function(
  * @param {string} [parameter="sort"]
  * @returns {object}
  */
-AppointmentCollection.monthParametersForUser = function(
+AppointmentCollection.monthParametersForUser = function (
 	date,
 	userID = Auth.user.id,
 	parameter = "sort"
 ) {
-	const dateFrom = moment(date)
-		.startOf("month")
-		.format();
-	const dateTo = moment(date)
-		.endOf("month")
-		.format();
+	const dateFrom = moment(date).startOf("month").format();
+	const dateTo = moment(date).endOf("month").format();
 
 	// The server only returns apts with 'ready' creation status by default
 	const data = {
 		user: userID,
-		creation_status: ["processing", "ready"]
+		creation_status: ["processing", "ready"],
 	};
 
 	data[`${parameter}_date__gte`] = dateFrom;

package/src/collections/assets.js

@@ -1,7 +1,7 @@
 import "../models/asset.js";
 
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -11,7 +11,7 @@ import { BaseCollection } from "./base.js";
  */
 export const AssetCollection = BaseCollection.extend(
 	/** @lends collections.AssetCollection# */ {
-		model: "AssetModel"
+		model: "AssetModel",
 	}
 );
 

package/src/collections/auto-adjuncts.js

@@ -1,8 +1,8 @@
 import "../models/auto-adjunct.js";
 
 import Auth from "../auth.js";
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -19,8 +19,8 @@ export const AutoAdjunctCollection = BaseCollection.extend(
 			return this.fetch({
 				...options,
 				data: {
-					deck: deckID
-				}
+					deck: deckID,
+				},
 			});
 		},
 
@@ -39,11 +39,11 @@ export const AutoAdjunctCollection = BaseCollection.extend(
 				// the authorized user is a part of. This is mostly for the case where
 				// a 'global' temp slide admin could end up seeing autoadjuncts for
 				// many teams - which would be increadibly confusing.
-				opts.data.team = [null].concat(user.team_set.map(team => team.id));
+				opts.data.team = [null].concat(user.team_set.map((team) => team.id));
 			}
 
 			return BaseCollection.prototype.fetch.call(this, opts);
-		}
+		},
 	}
 );
 

package/src/collections/base.js

@@ -1,14 +1,17 @@
+import { Api } from "../api.js";
+import { BaseModel } from "../models/base.js";
 import Collection from "ampersand-rest-collection";
 import Promise from "bluebird";
 import _ from "lodash";
-import qs from "qs";
-
-import { Api } from "../api.js";
 import log from "../log.js";
-import { BaseModel } from "../models/base.js";
+import qs from "qs";
 import { registeredStates } from "../state-register.js";
 import { sync } from "../sync.js";
 
+// Current hardcoded limit for maximum number of pages fetched
+// automatically by fetchAll
+const pageLimit = 20;
+
 /**
  * @constructor
  * @alias collections.BaseCollection
@@ -32,12 +35,12 @@ export const BaseCollection = Collection.extend(
 		urlMatchKeys: {},
 
 		defaultFetchData: {
-			per_page: 1000
+			per_page: 1000,
 		},
 
 		constructor(data = {}, opts = {}) {
 			const options = _.defaults(opts, {
-				data: {}
+				data: {},
 			});
 
 			// We ensure that we pass an array because we don't want the collection constructor to
@@ -175,11 +178,11 @@ export const BaseCollection = Collection.extend(
 		},
 
 		fetchModels(options = {}) {
-			return Promise.all(this.models.map(model => model.fetch(options)));
+			return Promise.all(this.models.map((model) => model.fetch(options)));
 		},
 
 		fetchSet(opts = {}) {
-			const idSet = this.models.map(model => model.id);
+			const idSet = this.models.map((model) => model.id);
 
 			if (!idSet.length) {
 				log.warn(`Tried to fetch ${this.modelName} set with no models`);
@@ -191,14 +194,14 @@ export const BaseCollection = Collection.extend(
 			const options = {
 				data: {
 					...data,
-					id: idSet
+					id: idSet,
 				},
-				...otherOpts
+				...otherOpts,
 			};
 
 			// Necessary because these models were already initialised before the fetch,
 			// and the children weren't updated correctly with the new data.
-			return this.fetch(options).tap(data => {
+			return this.fetch(options).tap((data) => {
 				this.reset();
 				this.add(data.results);
 			});
@@ -216,13 +219,80 @@ export const BaseCollection = Collection.extend(
 				this._url = options.url;
 			}
 
-			return Collection.prototype.fetch.call(this, options).tap(response => {
+			return Collection.prototype.fetch.call(this, options).tap((response) => {
 				this._data = response;
 			});
 		},
 
+		fetchAll(opts = {}) {
+			const options = _.cloneDeep(opts);
+
+			// Add default params to the fetch (ie ?per_page=1000)
+			options.data = _.extend({}, this.queryData, options.data || {});
+			this._options = _.extend({}, this._options, options);
+
+			this.queryData = { ...this._options.data };
+
+			if (this._options.url) {
+				this._url = options.url;
+			}
+
+			const checkPages = (response) => {
+				const notLastPage = response.total_pages > response.page;
+				const belowPageLimit = response.page < pageLimit;
+
+				if (notLastPage && belowPageLimit) {
+					const options = {
+						...this._options,
+						data: {
+							...this._options.data,
+							page: response.page + 1,
+						},
+					};
+
+					// Update the collection with the new data & page number
+					this._options = options;
+					this.queryData = { ...options.data };
+
+					return this.fetchPage().then((response) => {
+						checkPages(response);
+					});
+				} else {
+					// The collection's models are replaced with the latest
+					// batch of models every time a new page is fetched.
+					// Here we add back all of the previously-fetched models.
+					this.add(this._data.results);
+					return this._data;
+				}
+			};
+
+			return this.fetchPage().then((response) => {
+				return checkPages(response);
+			});
+		},
+
+		fetchPage() {
+			return Collection.prototype.fetch
+				.call(this, this._options)
+				.then((response) => {
+					// Add the response data to this._data - if we're fetching
+					// multiple pages, this._data.results will contain all of the
+					// results fetched from all pages so far
+					if (this._data.results?.length) {
+						this._data = {
+							...response,
+							results: [...this._data.results, ...response.results],
+						};
+					} else {
+						this._data = response;
+					}
+
+					return response;
+				});
+		},
+
 		toServer() {
-			return this.map(function(model) {
+			return this.map(function (model) {
 				if (model.toServer) {
 					return model.toServer();
 				} else if (model.serialize) {
@@ -261,7 +331,7 @@ export const BaseCollection = Collection.extend(
 			}
 
 			return Promise.all(
-				this.map(model => {
+				this.map((model) => {
 					return model.save(model.toServer(), options);
 				})
 			);
@@ -275,7 +345,7 @@ export const BaseCollection = Collection.extend(
 			}
 
 			return Promise.all(
-				this.map(model => {
+				this.map((model) => {
 					return model.delete(model.toServer(), options);
 				})
 			);
@@ -293,17 +363,17 @@ export const BaseCollection = Collection.extend(
 				// can be passed to the model.
 				//
 				// TODO: Regex match for URLs
-				return results.map(function(attr) {
+				return results.map(function (attr) {
 					return { url: attr };
 				});
 			}
 
 			return results;
-		}
+		},
 	}
 );
 
 // Make matchesURL available as a static method
-BaseCollection.matchesURL = function(url) {
+BaseCollection.matchesURL = function (url) {
 	return this.prototype.matchesURL(url);
 };

package/src/collections/base.spec.js

@@ -1,19 +1,20 @@
+import { BaseCollection } from "./base.js";
+import { BaseModel } from "../models/base.js";
+import AmpersandCollection from "ampersand-rest-collection";
 import { G } from "sp-test/api";
 import td from "testdouble";
-
-import { BaseModel } from "../models/base.js";
-import { BaseCollection } from "./base.js";
+import Promise from "bluebird";
 
 it("should parse an array of urls into models", () => {
 	G(BaseModel, "TestModel").extend({ modelName: "tests" });
 	const Collection = G(BaseCollection).extend({
-		model: "TestModel"
+		model: "TestModel",
 	});
 	const collection = new Collection(["/api/tests/1/", "/api/tests/2/"]);
 	expect(collection.models).toHaveLength(2);
 });
 
-it("should fetch the individual models in the collection", async function() {
+it("should fetch the individual models in the collection", async function () {
 	G(BaseModel, "TestModel");
 	const Collection = G(BaseCollection).extend({ model: "TestModel" });
 	const collection = new Collection([{ id: 1 }, { id: 2 }]);
@@ -86,12 +87,12 @@ it("should query multiple values if using an array", () => {
 	const Collection = G(BaseCollection);
 	const collection = new Collection(
 		{
-			url: "/api/appointments/"
+			url: "/api/appointments/",
 		},
 		{
 			data: {
-				foo: [1, 2, null]
-			}
+				foo: [1, 2, null],
+			},
 		}
 	);
 	expect(collection.url()).toEqual(
@@ -120,3 +121,94 @@ it("should be empty on initialize", () => {
 	const collection = new Collection();
 	expect(collection.length).toEqual(0);
 });
+
+const mockFetchResults = (dataFn) => {
+	jest
+		.spyOn(AmpersandCollection.prototype, "fetch")
+		.mockImplementation((opts) => {
+			const fetchResults = dataFn(opts);
+			return Promise.resolve(fetchResults);
+		});
+};
+
+describe("fetchAll", () => {
+	it("calls Collection.prototype.fetch", async () => {
+		mockFetchResults(() => {
+			return {
+				results: [{ id: 20 }, { id: 21 }, { id: 22 }],
+			};
+		});
+
+		G(BaseModel, "TestModel");
+		const Collection = G(BaseCollection.extend({ model: "TestModel" }));
+		const baseCollection = new Collection();
+
+		await baseCollection.fetchAll();
+
+		expect(baseCollection.length).toEqual(3);
+		expect(baseCollection.first().id).toEqual(20);
+	});
+
+	it("adds results to existing results", async () => {
+		mockFetchResults(() => {
+			return {
+				results: [{ id: 22 }],
+			};
+		});
+
+		G(BaseModel, "TestModel");
+		const Collection = G(BaseCollection.extend({ model: "TestModel" }));
+		const baseCollection = new Collection([{ id: 15 }]);
+
+		await baseCollection.fetchAll();
+
+		expect(baseCollection.length).toEqual(2);
+		// The models are sorted by ID
+		expect(baseCollection.first().id).toEqual(15);
+		expect(baseCollection.last().id).toEqual(22);
+	});
+
+	it("fetches multiple pages", async () => {
+		mockFetchResults((opts) => {
+			const page = opts.data.page || 1;
+			const fetchResults = {
+				total_pages: 5,
+				page,
+				results: [{ id: page + 10 }],
+			};
+			return Promise.resolve(fetchResults);
+		});
+
+		G(BaseModel, "TestModel");
+		const Collection = G(BaseCollection.extend({ model: "TestModel" }));
+		const baseCollection = new Collection();
+
+		await baseCollection.fetchAll();
+
+		expect(baseCollection.length).toEqual(5);
+		expect(baseCollection.first().id).toEqual(11);
+		expect(baseCollection.last().id).toEqual(15);
+	});
+
+	it("stops fetching pages at the hardcoded limit", async () => {
+		mockFetchResults((opts) => {
+			const page = opts.data.page || 1;
+			const fetchResults = {
+				total_pages: 50,
+				page,
+				results: [{ id: page + 10 }],
+			};
+			return Promise.resolve(fetchResults);
+		});
+
+		G(BaseModel, "TestModel");
+		const Collection = G(BaseCollection.extend({ model: "TestModel" }));
+		const baseCollection = new Collection();
+
+		await baseCollection.fetchAll();
+
+		expect(baseCollection.length).toEqual(20);
+		expect(baseCollection.first().id).toEqual(11);
+		expect(baseCollection.last().id).toEqual(30);
+	});
+});

package/src/collections/cms-vals.js

@@ -1,8 +1,8 @@
 import "../models/cms-val.js";
 
 import Auth from "../auth.js";
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -29,11 +29,11 @@ export const CMSValCollection = BaseCollection.extend(
 				// the authorized user is a part of. This is mostly for the case where
 				// a 'global' temp slide admin could end up seeing autoadjuncts for
 				// many teams - which would be increadibly confusing.
-				opts.data.team = [null].concat(user.team_set.map(team => team.id));
+				opts.data.team = [null].concat(user.team_set.map((team) => team.id));
 			}
 
 			return BaseCollection.prototype.fetch.call(this, opts);
-		}
+		},
 	}
 );
 

package/src/collections/contacts.js

@@ -1,7 +1,7 @@
 import "../models/contact.js";
 
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -11,7 +11,7 @@ import { BaseCollection } from "./base.js";
  */
 export const ContactCollection = BaseCollection.extend(
 	/** @lends collections.ContactCollection# */ {
-		model: "ContactModel"
+		model: "ContactModel",
 	}
 );
 

package/src/collections/created-assets.js

@@ -1,7 +1,7 @@
 import "../models/asset.js";
 
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -19,7 +19,7 @@ export const CreatedAssetCollection = BaseCollection.extend(
 			}
 
 			return BaseCollection.prototype.url.call(this);
-		}
+		},
 	}
 );
 

package/src/collections/customers.js

@@ -1,7 +1,7 @@
 import "../models/customer.js";
 
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -11,7 +11,7 @@ import { BaseCollection } from "./base.js";
  */
 export const CustomerCollection = BaseCollection.extend(
 	/** @lends collections.CustomerCollection# */ {
-		model: "CustomerModel"
+		model: "CustomerModel",
 	}
 );