@livepreso/api 6.40.0 → 6.43.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,11 +1,10 @@
+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";
 
@@ -32,12 +31,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 +174,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 +190,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 +215,13 @@ 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;
 			});
 		},
 
 		toServer() {
-			return this.map(function(model) {
+			return this.map(function (model) {
 				if (model.toServer) {
 					return model.toServer();
 				} else if (model.serialize) {
@@ -261,7 +260,7 @@ export const BaseCollection = Collection.extend(
 			}
 
 			return Promise.all(
-				this.map(model => {
+				this.map((model) => {
 					return model.save(model.toServer(), options);
 				})
 			);
@@ -275,7 +274,7 @@ export const BaseCollection = Collection.extend(
 			}
 
 			return Promise.all(
-				this.map(model => {
+				this.map((model) => {
 					return model.delete(model.toServer(), options);
 				})
 			);
@@ -293,17 +292,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,18 @@
+import { BaseCollection } from "./base.js";
+import { BaseModel } from "../models/base.js";
 import { G } from "sp-test/api";
 import td from "testdouble";
 
-import { BaseModel } from "../models/base.js";
-import { BaseCollection } from "./base.js";
-
 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 +85,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(

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

package/src/collections/deck-notes.js

@@ -1,7 +1,7 @@
 import "../models/deck-note.js";
 
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -18,7 +18,7 @@ export const DeckNoteCollection = BaseCollection.extend(
 				return this.getFullURLPath(`${this.parent.getPlainURL()}notes/`);
 			}
 			return BaseCollection.prototype.url.call(this);
-		}
+		},
 	}
 );
 

package/src/collections/deck-versions.js

@@ -1,9 +1,9 @@
 import "../models/deck-version.js";
 
+import { Auth } from "../auth.js";
+import { BaseCollection } from "./base.js";
 import moment from "moment";
-
 import { register } from "../state-register.js";
-import { BaseCollection } from "./base.js";
 
 /**
  * @constructor
@@ -29,24 +29,27 @@ export const DeckVersionCollection = BaseCollection.extend(
 		 */
 		fetchForUser(userID, dateFrom, dateTo, options = {}) {
 			const FORMAT = "YYYY-MM-DDTHH:mm:ssZ";
-			const dateFromMoment = moment(dateFrom)
-				.startOf("day")
-				.format(FORMAT);
-			const dateToMoment = moment(dateTo)
-				.endOf("day")
-				.format(FORMAT);
+			const dateFromMoment = moment(dateFrom).startOf("day").format(FORMAT);
+			const dateToMoment = moment(dateTo).endOf("day").format(FORMAT);
 			const url = `${this.urlRoot()}scheduled/`;
 
+			const data = {
+				user: userID,
+				begin__gte: dateFromMoment,
+				begin__lte: dateToMoment,
+			};
+
+			// Allow content creators to immediately sync imaging deckversions
+			if (Auth.user.permissions.appointments.isContentCreator) {
+				data.creation_status = ["imaging", "created"];
+			}
+
 			return this.fetch({
 				url,
-				data: {
-					user: userID,
-					begin__gte: dateFromMoment,
-					begin__lte: dateToMoment
-				},
-				...options
+				data,
+				...options,
 			});
-		}
+		},
 	}
 );
 

package/src/collections/decks.js

@@ -1,7 +1,7 @@
 import "../models/deck.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 DeckCollection = BaseCollection.extend(
 	/** @lends collections.DeckCollection# */ {
-		model: "DeckModel"
+		model: "DeckModel",
 	}
 );
 

package/src/collections/deleted-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 DeletedAssetCollection = BaseCollection.extend(
 			}
 
 			return BaseCollection.prototype.url.call(this);
-		}
+		},
 	}
 );
 

package/src/collections/dispatches.js

@@ -1,10 +1,9 @@
 import "../models/dispatch.js";
 
-import moment from "moment";
-
 import { Auth } from "../auth.js";
-import { register } from "../state-register.js";
 import { BaseCollection } from "./base.js";
+import moment from "moment";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -17,24 +16,20 @@ export const DispatchCollection = BaseCollection.extend(
 		model: "DispatchModel",
 
 		fetchCreatedMonthForUser(date, userID = Auth.user.id) {
-			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();
 
 			return this.fetch({
 				data: {
 					user: userID,
 					created_date__gte: dateFrom,
-					created_date__lte: dateTo
-				}
+					created_date__lte: dateTo,
+				},
 			});
 		},
 
 		serialize() {
-			return this.models.map(model => model.serialize());
+			return this.models.map((model) => model.serialize());
 		},
 
 		url() {
@@ -45,7 +40,7 @@ export const DispatchCollection = BaseCollection.extend(
 			}
 
 			return BaseCollection.prototype.url.call(this);
-		}
+		},
 	}
 );