@livepreso/api 6.41.0 → 6.44.0

package/src/presentation/presentation-subslide.spec.js

@@ -1,7 +1,7 @@
 import { AdjunctSubSlideModel } from "../models/adjunct-sub-slide";
+import { PresentationSubSlide } from "./presentation-subslide";
 import { SlideModel } from "../models/slide";
 import { SubSlideModel } from "../models/sub-slide";
-import { PresentationSubSlide } from "./presentation-subslide";
 
 describe("#createFromSubSlide", () => {
 	const subslideJSON = {
@@ -15,15 +15,11 @@ describe("#createFromSubSlide", () => {
 		index_asset: {
 			created_date: "2020-07-20T03:25:15.530683Z",
 			data: "sections/test-deck/slides/why_myob_vision/index.html",
-			hash_algorithm: "sha-256",
-			hash_digest:
-				"5e2426643a0d9f9360f343891da19faecf6bd37584ed4be05528c87b981f1f26",
 			id: 7836,
 			modified_date: "2020-07-20T03:25:15.530717Z",
 			orig_path: "sections/test-deck/slides/why_myob_vision",
 			pack: "http://bleh/api/packs/17/",
-			url:
-				"http://bleh/media/pack/17/assets/sections/test-deck/slides/why_myob_vision/index.html"
+			url: "http://bleh/media/pack/17/assets/sections/test-deck/slides/why_myob_vision/index.html",
 		},
 		key: "subslide-1",
 		modified_date: "2020-07-20T03:25:49.393305Z",
@@ -32,7 +28,7 @@ describe("#createFromSubSlide", () => {
 		slide: "http://bleh/api/slides/1273/",
 		tags: [],
 		title: "",
-		url: "http://bleh/api/subslides/458/"
+		url: "http://bleh/api/subslides/458/",
 	};
 
 	it("should create a presentation subslide", async () => {
@@ -51,11 +47,24 @@ describe("#createFromSubSlide", () => {
 			index: 0,
 			sequence: 0,
 			visible: true,
-			url: subslide.url()
+			url: subslide.url(),
 		};
 
 		expect(presentationSub.toJSON()).toEqual(expected);
 	});
+
+	it("should use deckTags when available", async () => {
+		const subslide = new SubSlideModel(subslideJSON);
+		const options = {
+			deckTags: { "test-deck/why_myob_vision/subslide-1": ["subslide-tag"] },
+		};
+		const presentationSub = PresentationSubSlide.createFromSubSlide(
+			subslide,
+			options
+		);
+
+		expect(presentationSub.tags).toEqual(["subslide-tag"]);
+	});
 });
 
 describe("#createFromAdjunctSubSlide", () => {
@@ -81,7 +90,7 @@ describe("#createFromAdjunctSubSlide", () => {
 		tags: [],
 		template: null,
 		title: "addition-1",
-		url: "http://bleh/api/adjunctsubslides/562/"
+		url: "http://bleh/api/adjunctsubslides/562/",
 	};
 
 	it("should create a presentation subslide", async () => {
@@ -108,11 +117,30 @@ describe("#createFromAdjunctSubSlide", () => {
 			index: 2,
 			sequence: 2,
 			visible: true,
-			url: subslide.url()
+			tags: [],
+			url: subslide.url(),
 		};
 
 		expect(presentationSub.toJSON()).toEqual(expected);
 	});
+
+	it("should use deckTags when available", async () => {
+		const subslide = new AdjunctSubSlideModel(adjunctSubSlideJSON);
+
+		const options = {
+			id: 23,
+			deckTags: {
+				"test-deck/why_myob_vision/adjunct-562": ["adjunctsubslide-tag"],
+			},
+		};
+		const presentationSub = PresentationSubSlide.createFromAdjunctSubSlide(
+			subslide,
+			{ id: 58 },
+			options
+		);
+
+		expect(presentationSub.tags).toEqual(["adjunctsubslide-tag"]);
+	});
 });
 
 describe("#createFromSlide", () => {
@@ -133,7 +161,7 @@ describe("#createFromSlide", () => {
 		subslide_set: [],
 		tags: [],
 		title: "Why MYOB",
-		url: "http://bleh/api/slides/1273/"
+		url: "http://bleh/api/slides/1273/",
 	};
 
 	it("should create a presentation subslide", async () => {
@@ -152,7 +180,7 @@ describe("#createFromSlide", () => {
 			title: "Why MYOB",
 			slide: 1273,
 			tags: [],
-			url: "/api/subslides/1273/"
+			url: "/api/subslides/1273/",
 		};
 
 		expect(presentationSub.toJSON()).toEqual(expected);

package/src/presentation/presentation-subslides.js

@@ -1,7 +1,7 @@
 import "./presentation-subslide.js";
 
-import { register } from "../state-register.js";
 import { BasePresentationCollection } from "./base-presentation-collection.js";
+import { register } from "../state-register.js";
 
 /**
  * @constructor
@@ -12,7 +12,7 @@ import { BasePresentationCollection } from "./base-presentation-collection.js";
 export const PresentationSubSlideCollection = BasePresentationCollection.extend(
 	/** @lends presentation.PresentationSubSlideCollection# */ {
 		comparator: "sequence",
-		model: "PresentationSubSlide"
+		model: "PresentationSubSlide",
 	}
 );
 

package/src/presentation/presentation.js

@@ -1,25 +1,25 @@
 import "./presentation-decks.js";
 
+import { DeckVersionModel, ManifestJSONModel } from "../models.js";
+
+import { BasePresentationModel } from "./base-presentation-model.js";
+import { PresentationDeck } from "./presentation-deck.js";
 import Promise from "bluebird";
 import _ from "lodash";
-
 import log from "../log.js";
-import { DeckVersionModel, ManifestJSONModel } from "../models.js";
 import { register } from "../state-register.js";
-import { BasePresentationModel } from "./base-presentation-model.js";
-import { PresentationDeck } from "./presentation-deck.js";
 
 export const Presentation = BasePresentationModel.extend({
 	collections: {
-		decks: "PresentationDeckCollection"
-	}
+		decks: "PresentationDeckCollection",
+	},
 });
 
-Presentation.createFromDeckversion = function(deckversionURL, options) {
+Presentation.createFromDeckversion = function (deckversionURL, options) {
 	const deckversion = new DeckVersionModel(deckversionURL);
 
-	options = _.defaults(options, {
-		includeTemplates: false
+	const opts = _.defaults(options, {
+		includeTemplates: false,
 	});
 
 	return deckversion
@@ -27,29 +27,41 @@ Presentation.createFromDeckversion = function(deckversionURL, options) {
 		.then(() => {
 			return Promise.all([
 				deckversion.manifest_json.fetch(),
-				deckversion.deck.fetch()
+				deckversion.deck.fetch(),
 			]);
 		})
 		.then(() => {
+			return deckversion.deck.tags.fetch();
+		})
+		.then(() => {
+			const deckTags = deckversion.deck.tags.items.reduce((tagObj, tagItem) => {
+				tagObj[tagItem.namespaced_key] = tagItem.tags;
+				return tagObj;
+			}, {});
+
 			const presentation = new Presentation();
-			const createOpts = {};
-			if (options.includeTemplates) {
+
+			const createOpts = {
+				deckTags,
+			};
+
+			if (opts.includeTemplates) {
 				createOpts.templates = deckversion.template_set.toJSON();
 			}
 
 			presentation.decks.add([
-				PresentationDeck.createFromDeckVersion(deckversion, createOpts)
+				PresentationDeck.createFromDeckVersion(deckversion, createOpts),
 			]);
 
 			return presentation;
 		})
-		.catch(e => {
+		.catch((e) => {
 			log.error(e);
 			throw e;
 		});
 };
 
-Presentation.createFromManifestJSON = function(manifestJSON, url) {
+Presentation.createFromManifestJSON = function (manifestJSON, url) {
 	const manifestModel = new ManifestJSONModel(manifestJSON.toJSON());
 	// Let's use the model to transport the manifest url.
 	manifestModel._url = url;

package/src/state-register.js

@@ -4,3 +4,10 @@ export const register = (name, State) => {
 	State.prototype._registerName = name;
 	registeredStates[name] = State;
 };
+
+export const getState = (name) => {
+	if (!registeredStates[name]) {
+		throw new Error(`Registered state '${name}' not found.`);
+	}
+	return registeredStates[name];
+};

package/src/sync.js

@@ -1,18 +1,16 @@
-import url2 from "url";
-
 import Promise from "bluebird";
-import _ from "lodash";
-import superagent from "superagent";
 import SuperAgentRequest from "superagent-bluebird-promise";
-
+import _ from "lodash";
 import log from "./log.js";
 import { middlewares } from "./middleware.js";
+import superagent from "superagent";
+import url2 from "url";
 
 const defaults = _.defaults;
 const assign = _.assign;
 
 // Throw an error when a URL is needed, and none is supplied.
-const urlError = function() {
+const urlError = function () {
 	throw new Error(`A "url" property or function must be specified`);
 };
 
@@ -22,15 +20,15 @@ export const methodMap = {
 	update: "PUT",
 	patch: "PATCH",
 	delete: "DELETE",
-	read: "GET"
+	read: "GET",
 };
 
-export const defaultFetchURL = function({ model }) {
+export const defaultFetchURL = function ({ model }) {
 	log.warn("Deprecation: defaultFetchURL is deprecated. Just use .url()");
 	return model.url();
 };
 
-export const buildURL = function({ method, model }) {
+export const buildURL = function ({ method, model }) {
 	const url = model.url();
 	const urlParse = url2.parse(url);
 
@@ -42,13 +40,13 @@ export const buildURL = function({ method, model }) {
 	return url;
 };
 
-export const sync = function(method) {
+export const sync = function (method) {
 	const syncArguments = arguments;
 
 	if (method === "read") {
 		// look for sync methods
 		const syncActions = [];
-		middlewares.forEach(middleware => {
+		middlewares.forEach((middleware) => {
 			if (middleware.sync) {
 				syncActions.push(middleware.sync.apply(this, syncArguments));
 			}
@@ -61,13 +59,13 @@ export const sync = function(method) {
 	return ajaxSync.apply(this, syncArguments);
 };
 
-export const ajaxSync = function(method, model, options) {
+export const ajaxSync = function (method, model, options) {
 	const type = methodMap[method];
 
 	// Default options, unless specified.
 	defaults(options || (options = {}), {
 		emulateHTTP: false,
-		emulateJSON: false
+		emulateJSON: false,
 	});
 
 	// Default request options.
@@ -118,7 +116,7 @@ export const ajaxSync = function(method, model, options) {
 
 	options.xhr = request;
 
-	middlewares.forEach(middleware => {
+	middlewares.forEach((middleware) => {
 		if (middleware.preflight) {
 			middleware.preflight(request);
 		}
@@ -160,12 +158,12 @@ export const ajaxSync = function(method, model, options) {
 	if (options.cached && !options.deleted) {
 		return Promise.resolve(options.cachedResponse)
 			.then(getNextMiddleware(request))
-			.then(function(response) {
+			.then(function (response) {
 				if (!response.data) {
 					response.data = JSON.parse(response.text);
 				}
 
-				return Promise.each(middlewares, middleware => {
+				return Promise.each(middlewares, (middleware) => {
 					return middleware.success(request, response, model, true);
 				}).then(() => {
 					if (options.success) {
@@ -175,8 +173,8 @@ export const ajaxSync = function(method, model, options) {
 					return response.data;
 				});
 			})
-			.catch(function(response) {
-				return Promise.each(middlewares, middleware => {
+			.catch(function (response) {
+				return Promise.each(middlewares, (middleware) => {
 					return middleware.error(response, model);
 				}).then(() => {
 					if (options.error) {
@@ -193,7 +191,7 @@ export const ajaxSync = function(method, model, options) {
 			// can have the request continue trying for minutes otherwise.
 			.timeout(60 * 1000)
 			.then(getNextMiddleware(request))
-			.then(function(response) {
+			.then(function (response) {
 				let data;
 				try {
 					data = JSON.parse(response.text);
@@ -205,7 +203,7 @@ export const ajaxSync = function(method, model, options) {
 					model.set(data);
 				}
 
-				return Promise.each(middlewares, middleware => {
+				return Promise.each(middlewares, (middleware) => {
 					return middleware.success(request, response, model, false);
 				}).then(() => {
 					if (options.success) {
@@ -215,7 +213,7 @@ export const ajaxSync = function(method, model, options) {
 					return data;
 				});
 			})
-			.catch(superagent.SuperagentPromiseError, e => {
+			.catch(superagent.SuperagentPromiseError, (e) => {
 				if (
 					e.res &&
 					e.res.body &&
@@ -225,8 +223,8 @@ export const ajaxSync = function(method, model, options) {
 				}
 				throw e;
 			})
-			.catch(function(response) {
-				return Promise.each(middlewares, middleware => {
+			.catch(function (response) {
+				return Promise.each(middlewares, (middleware) => {
 					return middleware.error(response);
 				}).then(() => {
 					if (options.error) {

package/src/utils.js

@@ -1,8 +1,7 @@
+import _ from "lodash";
 /* eslint-disable no-control-regex */
 import url2 from "url";
 
-import _ from "lodash";
-
 export const DATE_FORMAT = "YYYY-MM-DD HH:mm:ss.SSSSSS[Z]";
 export const DATE_FORMAT_T = "YYYY-MM-DDTHH:mm:ss.SSSSSS[Z]";
 
@@ -63,7 +62,7 @@ export function replaceHostname(data, before, after) {
 	if (typeof data === "string" && data.indexOf("http") === 0) {
 		return data.replace(hostnameBefore, hostnameAfter);
 	} else if (Array.isArray(data)) {
-		return data.map(item => replaceHostname(item, before, after));
+		return data.map((item) => replaceHostname(item, before, after));
 	} else if (_.isObject(data)) {
 		return Object.keys(data).reduce((newObj, key) => {
 			newObj[key] = replaceHostname(data[key], before, after);
@@ -76,14 +75,14 @@ export function replaceHostname(data, before, after) {
 // Takes the deckversion model and retrieves the highest id between all of
 // the sections, slides and subslides
 export function getMaxID(deckVersionModel) {
-	const ids = deckVersionModel.section_set.map(section => {
+	const ids = deckVersionModel.section_set.map((section) => {
 		let slides = [];
 		if (section.slide_set) {
-			slides = section.slide_set.map(slide => {
+			slides = section.slide_set.map((slide) => {
 				let subslides = [];
 
 				if (slide.subslide_set) {
-					subslides = slide.subslide_set.map(subslide => subslide.id);
+					subslides = slide.subslide_set.map((subslide) => subslide.id);
 				}
 
 				return [slide.id, ...subslides];
@@ -130,5 +129,7 @@ export function isImpostor(model) {
 export function isImpostorDeck(deckVersionModel) {
 	const section = deckVersionModel.section_set.first();
 
-	return Boolean(section && section.slide_set.find(slide => isImpostor(slide)));
+	return Boolean(
+		section && section.slide_set.find((slide) => isImpostor(slide))
+	);
 }

package/src/utils.spec.js

@@ -2,30 +2,30 @@ import {
 	getHostname,
 	getShortURL,
 	removeMultiByteChars,
-	replaceHostname
+	replaceHostname,
 } from "./utils.js";
 
 describe("getShortURL()", () => {
-	test("shorten a full url to a short one", function() {
+	test("shorten a full url to a short one", function () {
 		const url = "http://client.salespreso.com/api/users/1/";
 		expect(getShortURL(url)).toEqual("/api/users/1/");
 	});
 
-	test("not break an already short url", function() {
+	test("not break an already short url", function () {
 		const url = "/api/users/1/";
 		expect(getShortURL(url)).toEqual("/api/users/1/");
 	});
 });
 
 describe("removeMultiByteChars()", () => {
-	test("correctly strip offending multibyte characters from string", function() {
+	test("correctly strip offending multibyte characters from string", function () {
 		const testString = "SUZI LUCK’S CANTEEN & COCKTAIL BAR";
 		expect(removeMultiByteChars(testString)).toEqual(
 			"SUZI LUCKS CANTEEN & COCKTAIL BAR"
 		);
 	});
 
-	test("sanatize urls correctly", function() {
+	test("sanatize urls correctly", function () {
 		const testString = "http://client.salespreso.com/api/users/1/’";
 		const testString2 = "/api/users/1/’";
 		const testString3 = "/api/users/1/?param=1&test=3&_r=4";
@@ -93,11 +93,11 @@ describe("replaceHostname()", () => {
 	it("replaces hostnames in an array", () => {
 		const data = [
 			"https://old.url.com/api/appointments/1/",
-			"https://old.url.com/api/foo/1/bars/1/"
+			"https://old.url.com/api/foo/1/bars/1/",
 		];
 		const expected = [
 			"https://brand.new.com/api/appointments/1/",
-			"https://brand.new.com/api/foo/1/bars/1/"
+			"https://brand.new.com/api/foo/1/bars/1/",
 		];
 		const actual = replaceHostname(data, "old.url.com", "brand.new.com");
 		expect(actual).toEqual(expected);
@@ -105,10 +105,10 @@ describe("replaceHostname()", () => {
 
 	it("replaces hostnames in an object", () => {
 		const data = {
-			url: "https://old.url.com/api/appointments/1/"
+			url: "https://old.url.com/api/appointments/1/",
 		};
 		const expected = {
-			url: "https://brand.new.com/api/appointments/1/"
+			url: "https://brand.new.com/api/appointments/1/",
 		};
 
 		const actual = replaceHostname(data, "old.url.com", "brand.new.com");
@@ -117,10 +117,10 @@ describe("replaceHostname()", () => {
 
 	it("hostnames not related aren't affected", () => {
 		const data = {
-			url: "https://some.otherurl.com/helloworld/"
+			url: "https://some.otherurl.com/helloworld/",
 		};
 		const expected = {
-			url: "https://some.otherurl.com/helloworld/"
+			url: "https://some.otherurl.com/helloworld/",
 		};
 
 		const actual = replaceHostname(data, "old.url.com", "brand.new.com");
@@ -136,8 +136,8 @@ describe("replaceHostname()", () => {
 			anArray: [beforeURL, beforeURL],
 			nestedObject: {
 				first: beforeURL,
-				second: beforeURL
-			}
+				second: beforeURL,
+			},
 		};
 
 		const expected = {
@@ -145,8 +145,8 @@ describe("replaceHostname()", () => {
 			anArray: [afterURL, afterURL],
 			nestedObject: {
 				first: afterURL,
-				second: afterURL
-			}
+				second: afterURL,
+			},
 		};
 
 		const actual = replaceHostname(data, "old.url.com", "some.otherurl.com");

package/.editorconfig

@@ -1,9 +0,0 @@
-# http://editorconfig.org/
-root = true
-
-[*]
-end_of_line = lf
-trim_trailing_whitespace = true
-insert_final_newline = true
-charset = utf-8
-indent_style = tab

package/.eslintrc

@@ -1,25 +0,0 @@
-{
-	"rules": {
-		"react/prop-types": 0,
-		"id-length": 0
-	},
-	"extends": [
-		"salespreso",
-		"prettier"
-	],
-	"parserOptions": {
-		"ecmaFeatures": {
-			"legacyDecorators": true
-		},
-		"sourceType": "module"
-	},
-	"globals": {
-		"SystemJS": true,
-		"test": true
-	},
-	"settings": {
-		"react": {
-			"version": "16.0"
-		}
-	}
-}

package/.prettierrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-	trailingComma: "none"
-};

package/jsdoc.json

@@ -1,12 +0,0 @@
-{
-	"opts": {
-		"template": "node_modules/docdash",
-		"destination": "./docs",
-		"recurse": true,
-		"readme": "README.md"
-	},
-	"plugins": ["node_modules/jsdoc-babel"],
-	"babel": {
-		"plugins": ["transform-object-rest-spread"]
-	}
-}