@livepreso/api 6.41.0 → 6.44.0

package/src/models/user.js

@@ -3,8 +3,8 @@ import "../collections/groups.js";
 import "../collections/teams.js";
 
 import { Api } from "../api.js";
-import { register } from "../state-register.js";
 import { BaseModel } from "./base.js";
+import { register } from "../state-register.js";
 
 /**
 
@@ -43,7 +43,7 @@ export const UserModel = BaseModel.extend(
 		props: {
 			actions: {
 				type: "array",
-				default: () => []
+				default: () => [],
 			},
 			preferences: {
 				type: "object",
@@ -52,9 +52,9 @@ export const UserModel = BaseModel.extend(
 						notification_sender: "default",
 						email_signature: "",
 						app_prefs: {},
-						timezone: ""
+						timezone: "",
 					};
-				}
+				},
 			},
 			calendar_feed: "string",
 			date_joined: "date",
@@ -71,14 +71,14 @@ export const UserModel = BaseModel.extend(
 			profile: "object",
 			rtms_topic: "string",
 			rtms_token: "string",
-			last_reset_request: "string"
+			last_reset_request: "string",
 		},
 
 		/**
 		 * @property {models.TenancyModel} tenancy
 		 */
 		children: {
-			tenancy: "TenancyModel"
+			tenancy: "TenancyModel",
 		},
 
 		/**
@@ -87,7 +87,7 @@ export const UserModel = BaseModel.extend(
 		 */
 		collections: {
 			groups: "GroupCollection",
-			team_set: "TeamCollection"
+			team_set: "TeamCollection",
 		},
 
 		/**
@@ -100,7 +100,7 @@ export const UserModel = BaseModel.extend(
 				deps: ["first_name", "last_name"],
 				fn: function () {
 					return `${this.first_name} ${this.last_name}`;
-				}
+				},
 			},
 
 			permissions: {
@@ -108,7 +108,9 @@ export const UserModel = BaseModel.extend(
 				fn: function () {
 					const presets = {
 						canCreateCompanyPresets:
-							this.actions.indexOf("Manage Deck Presets") > -1
+							this.actions.indexOf("Manage Deck Presets") > -1,
+						canCreateTeamPresets:
+							this.actions.indexOf("Manage Team Presets") > -1,
 					};
 
 					const presomanager = {
@@ -122,7 +124,7 @@ export const UserModel = BaseModel.extend(
 						isContentCreator: this.actions.indexOf("Create Content") > -1,
 
 						canAddGlobalNotes: this.actions.indexOf("Manage Notes") > -1,
-						canAddTeamNotes: this.actions.indexOf("Manage Team Notes") > -1
+						canAddTeamNotes: this.actions.indexOf("Manage Team Notes") > -1,
 					};
 
 					presomanager.canModifyNotes =
@@ -154,22 +156,22 @@ export const UserModel = BaseModel.extend(
 						canCreateWithoutTeam:
 							this.actions.indexOf("Allow Teamless Appointments") > -1,
 						canUseClosedCaptions:
-							this.actions.indexOf("Use Closed Captions") > -1
+							this.actions.indexOf("Use Closed Captions") > -1,
 					};
 
 					const customers = {
 						canCreateWithoutTeam:
-							this.actions.indexOf("Allow Teamless Customers") > -1
+							this.actions.indexOf("Allow Teamless Customers") > -1,
 					};
 
 					return {
 						presets,
 						appointments,
 						presomanager,
-						customers
+						customers,
 					};
-				}
-			}
+				},
+			},
 		},
 
 		fetchHQLogin() {
@@ -212,7 +214,7 @@ export const UserModel = BaseModel.extend(
 		toServer() {
 			const data = {
 				id: this.id,
-				preferences: this.preferences
+				preferences: this.preferences,
 			};
 
 			if (this.groups) {
@@ -224,7 +226,7 @@ export const UserModel = BaseModel.extend(
 			}
 
 			return data;
-		}
+		},
 	}
 );
 

package/src/models/user.spec.js

@@ -3,7 +3,7 @@ import { G } from "sp-test/api";
 test("User can modify temporary slides", async () => {
 	const UserModel = G("UserModel");
 	const user = new UserModel({
-		actions: ["Manage Temporary Slides"]
+		actions: ["Manage Temporary Slides"],
 	});
 	expect(user.permissions.presomanager.canModifyTemporarySlides).toBe(true);
 });
@@ -11,7 +11,7 @@ test("User can modify temporary slides", async () => {
 test("User can modify editable content", async () => {
 	const UserModel = G("UserModel");
 	const user = new UserModel({
-		actions: ["Create Content"]
+		actions: ["Create Content"],
 	});
 	expect(user.permissions.presomanager.canModifyContent).toBe(true);
 });

package/src/models.js

@@ -8,6 +8,7 @@ export * from "./models/adjunct-slide";
 export * from "./models/adjunct-sub-slide";
 export * from "./models/api";
 export * from "./models/appointment";
+export * from "./models/appointment-tags";
 export * from "./models/asset";
 export * from "./models/auto-adjunct";
 export * from "./models/base";
@@ -16,6 +17,7 @@ export * from "./models/cms-val";
 export * from "./models/contact";
 export * from "./models/customer";
 export * from "./models/deck";
+export * from "./models/deck-tags";
 export * from "./models/deck-version";
 export * from "./models/dispatch";
 export * from "./models/dispatch-preview";
@@ -45,6 +47,7 @@ export * from "./models/slide-selection";
 export * from "./models/snapshot";
 export * from "./models/sub-slide";
 export * from "./models/support-ticket.js";
+export * from "./models/tag.js";
 export * from "./models/tenancy.js";
 export * from "./models/timing-log.js";
 export * from "./models/upload.js";
@@ -54,6 +57,10 @@ export * from "./models/appointment-editor.js";
 export * from "./models/appointment-duplicate.js";
 export * from "./models/appointment-stats.js";
 export * from "./models/appointment-viewing.js";
+export * from "./models/appointment-deckversion-tags.js";
+export * from "./models/appointment-section-tags.js";
+export * from "./models/appointment-slide-tags.js";
+export * from "./models/appointment-adjunct-tags.js";
 export * from "./models/team.js";
 export * from "./models/template.js";
 export * from "./models/auto-adjunct-key-check.js";

package/src/presentation/appointment-presentation.js

@@ -7,8 +7,8 @@ import "../collections/contacts.js";
 
 import { AppointmentModel } from "../models.js";
 import { BaseModel } from "../models/base.js";
-import { register } from "../state-register.js";
 import { PresentationDeck } from "./presentation-deck.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -29,7 +29,7 @@ export const AppointmentPresentation = BaseModel.extend(
 			end: "date",
 			tele: "object",
 			supportMode: "boolean",
-			locks: "array"
+			locks: "array",
 		},
 
 		/**
@@ -42,7 +42,7 @@ export const AppointmentPresentation = BaseModel.extend(
 			presentation: "Presentation",
 			latest_snapshot: "SnapshotModel",
 			latest_feed_data: "FeedDataModel",
-			user: "UserModel"
+			user: "UserModel",
 		},
 
 		/**
@@ -51,14 +51,17 @@ export const AppointmentPresentation = BaseModel.extend(
 		 */
 		collections: {
 			opportunities: "OpportunityCollection",
-			contacts: "ContactCollection"
-		}
+			contacts: "ContactCollection",
+		},
 	}
 );
 
-const createFromAppointment = function(appointment, options) {
+const createFromAppointment = function (appointment, options) {
 	const appointmentPresentation = new AppointmentPresentation();
 
+	// Note that we're not passing through tags if appointment.tags is empty.
+	// This is because tags currently aren't available in the telepresenter
+	// bundle and we want to fall back on the model tags for now.
 	appointmentPresentation.presentation.decks.add(
 		appointment.deckversion_set.map((model, index) => {
 			return PresentationDeck.createFromDeckVersion(model, {
@@ -68,7 +71,8 @@ const createFromAppointment = function(appointment, options) {
 				sectionSelections: appointment.appointmentssection_set,
 				slideSelections: appointment.appointmentsslide_set,
 				index,
-				...options
+				appointmentTags: appointment.tags.length ? appointment.tags : null,
+				...options,
 			});
 		})
 	);
@@ -94,7 +98,7 @@ const createFromAppointment = function(appointment, options) {
  * @memberof presentation.AppointmentPresentation
  * @param {string} url
  */
-AppointmentPresentation.createFromURL = function(url, options = {}) {
+AppointmentPresentation.createFromURL = function (url, options = {}) {
 	const appointment = new AppointmentModel({ url });
 
 	return appointment.fetchAll(true).then(() => {
@@ -107,7 +111,7 @@ AppointmentPresentation.createFromURL = function(url, options = {}) {
  * @memberof presentation.AppointmentPresentation
  * @param {number} id
  */
-AppointmentPresentation.createFromID = function(id, options = {}) {
+AppointmentPresentation.createFromID = function (id, options = {}) {
 	const appointment = new AppointmentModel({ id });
 
 	return appointment.fetchAll().then(() => {
@@ -120,7 +124,7 @@ AppointmentPresentation.createFromID = function(id, options = {}) {
  * @memberof presentation.AppointmentPresentation
  * @param {model} appointment
  */
-AppointmentPresentation.createFromAppointment = function(
+AppointmentPresentation.createFromAppointment = function (
 	appointment,
 	options = {}
 ) {

package/src/presentation/base-presentation-model.js

@@ -9,7 +9,7 @@ export const BasePresentationModel = BaseModel.extend(
 	/** @lends presentation.BasePresentationModel# */ {
 		url() {
 			return null;
-		}
+		},
 	}
 );
 
@@ -21,20 +21,23 @@ export const BasePresentationModel = BaseModel.extend(
  * model's state to determine sequence & vis when selections are used.
  */
 
-BasePresentationModel.getVisibilityAndSequence = function(model, options = {}) {
+BasePresentationModel.getVisibilityAndSequence = function (
+	model,
+	options = {}
+) {
 	const { choicelist = null, selections = null } = options;
 	const url = model.url();
 
 	const config = {
 		visible: model.visible || model.enabled || false,
 		sequence: model.sequence,
-		selectionID: null
+		selectionID: null,
 	};
 
 	if (choicelist) {
 		// All items should have a choicelist entry - if it's not in
 		// the choicelist, it's not in the preso
-		const choice = choicelist.find(item => item.url === url);
+		const choice = choicelist.find((item) => item.url === url);
 
 		if (choice) {
 			config.sequence = choicelist.indexOf(choice);
@@ -46,7 +49,7 @@ BasePresentationModel.getVisibilityAndSequence = function(model, options = {}) {
 		// Non-adjunct subslides and adjunct sections/slides/subslides
 		// have no selections - they fall through here using their
 		// model's values
-		const selection = selections.find(selection => selection.url === url);
+		const selection = selections.find((selection) => selection.url === url);
 
 		if (selection) {
 			config.visible = selection.visible;
@@ -61,4 +64,63 @@ BasePresentationModel.getVisibilityAndSequence = function(model, options = {}) {
 	return config;
 };
 
+const getAppointmentTags = function (model, tags) {
+	const url = model.adjunct?.url() || model.url();
+	const tagItem = tags.find((tag) => tag.content_url === url);
+
+	if (tagItem) {
+		return tagItem.tags || [];
+	}
+
+	// Subslide tags currently aren't included in the
+	// appointmentTags data.
+	return model.tags || [];
+};
+
+const getDeckTags = function (model, tags) {
+	// All non-adjunct sections, slides and subslides have namespaced_key
+	if (model.namespaced_key) {
+		return tags[model.namespaced_key] || model.tags || [];
+	} else if (model.adjunct || model.isAutoAdjunct) {
+		// Autoadjunct keys are unique and move around so we search for them
+		// and ignore the rest of the namespaced key
+		const keys = Object.keys(tags).filter((key) => {
+			if (key.includes("/")) {
+				const splitKey = key.split("/");
+
+				return splitKey[splitKey.length - 1] === model.key;
+			}
+			return key === model.key;
+		});
+		return keys.length ? tags[keys[0]] : [];
+	} else if (model.deck) {
+		// The deck's namespaced key is always "" - this is because the
+		// namespaced key format is section-key/slide-key, but the
+		// deck sits above sections.
+		return tags[""] || model.tags || [];
+	}
+
+	return model.tags || [];
+};
+
+// Retrieve the tags for the model.
+// If appointmentTags is passed through in the options, we call the
+// getAppointmentTags function above to retrieve the appointment tags
+// for the model.
+// if there are no appointmentTags but deckTags are passed
+// through then we call the getDeckTags function.
+// In the future we will always use one of these two methods and
+// references to model.tags should be removed.
+BasePresentationModel.getTags = function (model, options = {}) {
+	if (options.appointmentTags) {
+		return getAppointmentTags(model, options.appointmentTags);
+	}
+
+	if (options.deckTags) {
+		return getDeckTags(model, options.deckTags);
+	}
+
+	return model.tags || [];
+};
+
 BasePresentationModel.canBeEmpty = true;

package/src/presentation/base-presentation-model.spec.js

@@ -5,13 +5,13 @@ describe("#getVisibilityAndSequence", () => {
 		const config = BasePresentationModel.getVisibilityAndSequence({
 			sequence: 99,
 			visible: true,
-			url: () => ""
+			url: () => "",
 		});
 
 		const expected = {
 			sequence: 99,
 			visible: true,
-			selectionID: null
+			selectionID: null,
 		};
 
 		expect(config).toEqual(expected);
@@ -21,13 +21,13 @@ describe("#getVisibilityAndSequence", () => {
 		const config = BasePresentationModel.getVisibilityAndSequence({
 			sequence: 99,
 			visible: true,
-			url: () => ""
+			url: () => "",
 		});
 
 		const expected = {
 			sequence: 99,
 			visible: true,
-			selectionID: null
+			selectionID: null,
 		};
 
 		expect(config).toEqual(expected);
@@ -37,25 +37,25 @@ describe("#getVisibilityAndSequence", () => {
 		const choicelist = [
 			{
 				url: "bleh/meh",
-				visible: true
-			}
+				visible: true,
+			},
 		];
 
 		const config = BasePresentationModel.getVisibilityAndSequence(
 			{
 				sequence: 99,
 				visible: false,
-				url: () => "bleh/meh"
+				url: () => "bleh/meh",
 			},
 			{
-				choicelist
+				choicelist,
 			}
 		);
 
 		const expected = {
 			sequence: 0,
 			visible: true,
-			selectionID: null
+			selectionID: null,
 		};
 
 		expect(config).toEqual(expected);
@@ -67,25 +67,25 @@ describe("#getVisibilityAndSequence", () => {
 				url: "bleh/meh",
 				visible: true,
 				sequence: 27,
-				id: 58
-			}
+				id: 58,
+			},
 		];
 
 		const config = BasePresentationModel.getVisibilityAndSequence(
 			{
 				sequence: 99,
 				visible: false,
-				url: () => "bleh/meh"
+				url: () => "bleh/meh",
 			},
 			{
-				selections
+				selections,
 			}
 		);
 
 		const expected = {
 			sequence: 27,
 			visible: true,
-			selectionID: 58
+			selectionID: 58,
 		};
 
 		expect(config).toEqual(expected);
@@ -95,12 +95,12 @@ describe("#getVisibilityAndSequence", () => {
 		const choicelist = [
 			{
 				url: "gah/meh",
-				visible: false
+				visible: false,
 			},
 			{
 				url: "bleh/meh",
-				visible: true
-			}
+				visible: true,
+			},
 		];
 
 		const selections = [
@@ -108,26 +108,26 @@ describe("#getVisibilityAndSequence", () => {
 				url: "bleh/meh",
 				visible: true,
 				sequence: 27,
-				id: 58
-			}
+				id: 58,
+			},
 		];
 
 		const config = BasePresentationModel.getVisibilityAndSequence(
 			{
 				sequence: 99,
 				visible: false,
-				url: () => "bleh/meh"
+				url: () => "bleh/meh",
 			},
 			{
 				choicelist,
-				selections
+				selections,
 			}
 		);
 
 		const expected = {
 			sequence: 1,
 			visible: true,
-			selectionID: null
+			selectionID: null,
 		};
 
 		expect(config).toEqual(expected);
@@ -135,3 +135,95 @@ describe("#getVisibilityAndSequence", () => {
 
 	// adjuncts!!
 });
+
+describe("#getTags", () => {
+	it("should return empty array when no options or model tags", () => {
+		const tags = BasePresentationModel.getTags({});
+
+		expect(typeof tags).toEqual("object");
+		expect(tags.length).toEqual(0);
+	});
+
+	it("should return tags when no tags passed in options", () => {
+		const model = {
+			tags: ["model-tag-1", "model-tag-2"],
+		};
+		const tags = BasePresentationModel.getTags(model);
+
+		expect(tags).toEqual(model.tags);
+	});
+
+	it("should return tags for slide when tags passed in options", () => {
+		const model = {
+			namespaced_key: "slide-key",
+			tags: ["model-tag-1", "model-tag-2"],
+		};
+
+		const options = {
+			deckTags: {
+				"": ["deck-tags"],
+				"slide-key": ["slide-tags"],
+			},
+		};
+
+		const tags = BasePresentationModel.getTags(model, options);
+
+		expect(tags).toEqual(["slide-tags"]);
+	});
+
+	it("should return tags for welcome slide when tags passed in options", () => {
+		const model = {
+			deck: {},
+			tags: ["model-tag-1", "model-tag-2"],
+		};
+
+		const options = {
+			deckTags: {
+				"": ["deck-tags"],
+				"slide-key": ["slide-tags"],
+			},
+		};
+
+		const tags = BasePresentationModel.getTags(model, options);
+
+		expect(tags).toEqual(["deck-tags"]);
+	});
+
+	it("should return tags for an adjunct section when tags passed in options", () => {
+		const model = {
+			adjunct: true,
+			key: "adjunctsection-key",
+			tags: ["old-tag-1", "old-tag-2"],
+		};
+
+		const options = {
+			deckTags: {
+				"": ["deck-tags"],
+				"adjunctsection-key": ["adjunctsection-tags"],
+			},
+		};
+
+		const tags = BasePresentationModel.getTags(model, options);
+
+		expect(tags).toEqual(["adjunctsection-tags"]);
+	});
+
+	it("should return tags for an adjunct slide when tags passed in options", () => {
+		const model = {
+			adjunct: true,
+			key: "adjunctslide-key",
+			tags: ["old-tag-1", "old-tag-2"],
+		};
+
+		const options = {
+			deckTags: {
+				"": ["deck-tags"],
+				"section-key/adjunctslide-key": ["adjunctslide-tags"],
+			},
+		};
+
+		const tags = BasePresentationModel.getTags(model, options);
+
+		expect(tags).toEqual(["adjunctslide-tags"]);
+	});
+});