@internetarchive/bookreader 5.0.0-88-alpha.7 → 5.0.0-88-alpha.9

package/dist/esm/plugins/plugin.chapters.js

@@ -0,0 +1,288 @@
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+function _decorate(e, r, t, i) { var o = _getDecoratorsApi(); if (i) for (var n = 0; n < i.length; n++) o = i[n](o); var s = r(function (e) { o.initializeInstanceElements(e, a.elements); }, t), a = o.decorateClass(_coalesceClassElements(s.d.map(_createElementDescriptor)), e); return o.initializeClassElements(s.F, a.elements), o.runClassFinishers(s.F, a.finishers); }
+function _getDecoratorsApi() { _getDecoratorsApi = function _getDecoratorsApi() { return e; }; var e = { elementsDefinitionOrder: [["method"], ["field"]], initializeInstanceElements: function initializeInstanceElements(e, r) { ["method", "field"].forEach(function (t) { r.forEach(function (r) { r.kind === t && "own" === r.placement && this.defineClassElement(e, r); }, this); }, this); }, initializeClassElements: function initializeClassElements(e, r) { var t = e.prototype; ["method", "field"].forEach(function (i) { r.forEach(function (r) { var o = r.placement; if (r.kind === i && ("static" === o || "prototype" === o)) { var n = "static" === o ? e : t; this.defineClassElement(n, r); } }, this); }, this); }, defineClassElement: function defineClassElement(e, r) { var t = r.descriptor; if ("field" === r.kind) { var i = r.initializer; t = { enumerable: t.enumerable, writable: t.writable, configurable: t.configurable, value: void 0 === i ? void 0 : i.call(e) }; } Object.defineProperty(e, r.key, t); }, decorateClass: function decorateClass(e, r) { var t = [], i = [], o = { static: [], prototype: [], own: [] }; if (e.forEach(function (e) { this.addElementPlacement(e, o); }, this), e.forEach(function (e) { if (!_hasDecorators(e)) return t.push(e); var r = this.decorateElement(e, o); t.push(r.element), t.push.apply(t, r.extras), i.push.apply(i, r.finishers); }, this), !r) return { elements: t, finishers: i }; var n = this.decorateConstructor(t, r); return i.push.apply(i, n.finishers), n.finishers = i, n; }, addElementPlacement: function addElementPlacement(e, r, t) { var i = r[e.placement]; if (!t && -1 !== i.indexOf(e.key)) throw new TypeError("Duplicated element (" + e.key + ")"); i.push(e.key); }, decorateElement: function decorateElement(e, r) { for (var t = [], i = [], o = e.decorators, n = o.length - 1; n >= 0; n--) { var s = r[e.placement]; s.splice(s.indexOf(e.key), 1); var a = this.fromElementDescriptor(e), l = this.toElementFinisherExtras((0, o[n])(a) || a); e = l.element, this.addElementPlacement(e, r), l.finisher && i.push(l.finisher); var c = l.extras; if (c) { for (var p = 0; p < c.length; p++) this.addElementPlacement(c[p], r); t.push.apply(t, c); } } return { element: e, finishers: i, extras: t }; }, decorateConstructor: function decorateConstructor(e, r) { for (var t = [], i = r.length - 1; i >= 0; i--) { var o = this.fromClassDescriptor(e), n = this.toClassDescriptor((0, r[i])(o) || o); if (void 0 !== n.finisher && t.push(n.finisher), void 0 !== n.elements) { e = n.elements; for (var s = 0; s < e.length - 1; s++) for (var a = s + 1; a < e.length; a++) if (e[s].key === e[a].key && e[s].placement === e[a].placement) throw new TypeError("Duplicated element (" + e[s].key + ")"); } } return { elements: e, finishers: t }; }, fromElementDescriptor: function fromElementDescriptor(e) { var r = { kind: e.kind, key: e.key, placement: e.placement, descriptor: e.descriptor }; return Object.defineProperty(r, Symbol.toStringTag, { value: "Descriptor", configurable: !0 }), "field" === e.kind && (r.initializer = e.initializer), r; }, toElementDescriptors: function toElementDescriptors(e) { if (void 0 !== e) return _toArray(e).map(function (e) { var r = this.toElementDescriptor(e); return this.disallowProperty(e, "finisher", "An element descriptor"), this.disallowProperty(e, "extras", "An element descriptor"), r; }, this); }, toElementDescriptor: function toElementDescriptor(e) { var r = e.kind + ""; if ("method" !== r && "field" !== r) throw new TypeError('An element descriptor\'s .kind property must be either "method" or "field", but a decorator created an element descriptor with .kind "' + r + '"'); var t = _toPropertyKey(e.key), i = e.placement + ""; if ("static" !== i && "prototype" !== i && "own" !== i) throw new TypeError('An element descriptor\'s .placement property must be one of "static", "prototype" or "own", but a decorator created an element descriptor with .placement "' + i + '"'); var o = e.descriptor; this.disallowProperty(e, "elements", "An element descriptor"); var n = { kind: r, key: t, placement: i, descriptor: Object.assign({}, o) }; return "field" !== r ? this.disallowProperty(e, "initializer", "A method descriptor") : (this.disallowProperty(o, "get", "The property descriptor of a field descriptor"), this.disallowProperty(o, "set", "The property descriptor of a field descriptor"), this.disallowProperty(o, "value", "The property descriptor of a field descriptor"), n.initializer = e.initializer), n; }, toElementFinisherExtras: function toElementFinisherExtras(e) { return { element: this.toElementDescriptor(e), finisher: _optionalCallableProperty(e, "finisher"), extras: this.toElementDescriptors(e.extras) }; }, fromClassDescriptor: function fromClassDescriptor(e) { var r = { kind: "class", elements: e.map(this.fromElementDescriptor, this) }; return Object.defineProperty(r, Symbol.toStringTag, { value: "Descriptor", configurable: !0 }), r; }, toClassDescriptor: function toClassDescriptor(e) { var r = e.kind + ""; if ("class" !== r) throw new TypeError('A class descriptor\'s .kind property must be "class", but a decorator created a class descriptor with .kind "' + r + '"'); this.disallowProperty(e, "key", "A class descriptor"), this.disallowProperty(e, "placement", "A class descriptor"), this.disallowProperty(e, "descriptor", "A class descriptor"), this.disallowProperty(e, "initializer", "A class descriptor"), this.disallowProperty(e, "extras", "A class descriptor"); var t = _optionalCallableProperty(e, "finisher"); return { elements: this.toElementDescriptors(e.elements), finisher: t }; }, runClassFinishers: function runClassFinishers(e, r) { for (var t = 0; t < r.length; t++) { var i = (0, r[t])(e); if (void 0 !== i) { if ("function" != typeof i) throw new TypeError("Finishers must return a constructor."); e = i; } } return e; }, disallowProperty: function disallowProperty(e, r, t) { if (void 0 !== e[r]) throw new TypeError(t + " can't have a ." + r + " property."); } }; return e; }
+function _createElementDescriptor(e) { var r, t = _toPropertyKey(e.key); "method" === e.kind ? r = { value: e.value, writable: !0, configurable: !0, enumerable: !1 } : "get" === e.kind ? r = { get: e.value, configurable: !0, enumerable: !1 } : "set" === e.kind ? r = { set: e.value, configurable: !0, enumerable: !1 } : "field" === e.kind && (r = { configurable: !0, writable: !0, enumerable: !0 }); var i = { kind: "field" === e.kind ? "field" : "method", key: t, placement: e.static ? "static" : "field" === e.kind ? "own" : "prototype", descriptor: r }; return e.decorators && (i.decorators = e.decorators), "field" === e.kind && (i.initializer = e.value), i; }
+function _coalesceGetterSetter(e, r) { void 0 !== e.descriptor.get ? r.descriptor.get = e.descriptor.get : r.descriptor.set = e.descriptor.set; }
+function _coalesceClassElements(e) { for (var r = [], isSameElement = function isSameElement(e) { return "method" === e.kind && e.key === o.key && e.placement === o.placement; }, t = 0; t < e.length; t++) { var i, o = e[t]; if ("method" === o.kind && (i = r.find(isSameElement))) { if (_isDataDescriptor(o.descriptor) || _isDataDescriptor(i.descriptor)) { if (_hasDecorators(o) || _hasDecorators(i)) throw new ReferenceError("Duplicated methods (" + o.key + ") can't be decorated."); i.descriptor = o.descriptor; } else { if (_hasDecorators(o)) { if (_hasDecorators(i)) throw new ReferenceError("Decorators can't be placed on different accessors with for the same property (" + o.key + ")."); i.decorators = o.decorators; } _coalesceGetterSetter(o, i); } } else r.push(o); } return r; }
+function _hasDecorators(e) { return e.decorators && e.decorators.length; }
+function _isDataDescriptor(e) { return void 0 !== e && !(void 0 === e.value && void 0 === e.writable); }
+function _optionalCallableProperty(e, r) { var t = e[r]; if (void 0 !== t && "function" != typeof t) throw new TypeError("Expected '" + r + "' to be a function"); return t; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _toArray(r) { return _arrayWithHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function _superPropGet(t, e, o, r) { var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), e, o); return 2 & r && "function" == typeof p ? function (t) { return p.apply(o, t); } : p; }
+function _get() { return _get = "undefined" != typeof Reflect && Reflect.get ? Reflect.get.bind() : function (e, t, r) { var p = _superPropBase(e, t); if (p) { var n = Object.getOwnPropertyDescriptor(p, t); return n.get ? n.get.call(arguments.length < 3 ? e : r) : n.value; } }, _get.apply(null, arguments); }
+function _superPropBase(t, o) { for (; !{}.hasOwnProperty.call(t, o) && null !== (t = _getPrototypeOf(t));); return t; }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _taggedTemplateLiteral(e, t) { return t || (t = e.slice(0)), Object.freeze(Object.defineProperties(e, { raw: { value: Object.freeze(t) } })); }
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
+/* global BookReader */
+import { css, html, LitElement, nothing } from "lit";
+import { customElement, property } from 'lit/decorators.js';
+import { ifDefined } from 'lit/directives/if-defined.js';
+import { styleMap } from 'lit/directives/style-map.js';
+import '@internetarchive/icon-toc/icon-toc';
+/** @typedef {import('@/src/BookNavigator/book-navigator.js').BookNavigator} BookNavigator */
+
+/**
+ * Plugin for chapter markers in BookReader. Fetches from openlibrary.org
+ * Could be forked, or extended to alter behavior
+ */
+
+jQuery.extend(BookReader.defaultOptions, {
+  olHost: 'https://openlibrary.org',
+  enableChaptersPlugin: true,
+  bookId: ''
+});
+
+/** @override Extend to call Open Library for TOC */
+BookReader.prototype.init = function (super_) {
+  return function () {
+    super_.call(this);
+    if (this.options.enableChaptersPlugin && this.ui !== 'embed') {
+      this._chapterInit();
+    }
+  };
+}(BookReader.prototype.init);
+BookReader.prototype._chapterInit = /*#__PURE__*/_asyncToGenerator(function* () {
+  var _this$options$table_o;
+  var rawTableOfContents = null;
+  // Prefer IA TOC for now, until we update the second half to check for
+  // `openlibrary_edition` on the IA metadata instead of making a bunch of
+  // requests to OL.
+  if ((_this$options$table_o = this.options.table_of_contents) !== null && _this$options$table_o !== void 0 && _this$options$table_o.length) {
+    rawTableOfContents = this.options.table_of_contents;
+  } else {
+    var _olEdition$table_of_c;
+    var olEdition = yield this.getOpenLibraryRecord(this.options.olHost, this.options.bookId);
+    if (olEdition !== null && olEdition !== void 0 && (_olEdition$table_of_c = olEdition.table_of_contents) !== null && _olEdition$table_of_c !== void 0 && _olEdition$table_of_c.length) {
+      rawTableOfContents = olEdition.table_of_contents;
+    }
+  }
+  if (rawTableOfContents) {
+    this._tocEntries = rawTableOfContents.map(rawTOCEntry => Object.assign({}, rawTOCEntry, {
+      pageIndex: typeof rawTOCEntry.leaf == 'number' ? this.book.leafNumToIndex(rawTOCEntry.leaf) : rawTOCEntry.pagenum ? this.book.getPageIndex(rawTOCEntry.pagenum) : undefined
+    }));
+    this._chaptersRender(this._tocEntries);
+    this.bind(BookReader.eventNames.pageChanged, () => this._chaptersUpdateCurrent());
+  }
+});
+
+/**
+ * Update the table of contents based on array of TOC entries.
+ */
+BookReader.prototype._chaptersRender = function () {
+  var shell = /** @type {BookNavigator} */this.shell;
+  shell.menuProviders['chapters'] = {
+    id: 'chapters',
+    icon: html(_templateObject || (_templateObject = _taggedTemplateLiteral(["<ia-icon-toc style=\"width: var(--iconWidth); height: var(--iconHeight);\"></ia-icon-toc>"]))),
+    label: 'Table of Contents',
+    component: html(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["<br-chapters-panel\n      .contents=\"", "\"\n      .jumpToPage=\"", "\"\n      @connected=\"", "\"\n    />"])), this._tocEntries, pageIndex => {
+      this._chaptersUpdateCurrent(pageIndex);
+      this.jumpToIndex(pageIndex);
+    }, e => {
+      this._chaptersPanel = e.target;
+      this._chaptersUpdateCurrent();
+    })
+  };
+  shell.addMenuShortcut('chapters');
+  shell.updateMenuContents();
+  this._tocEntries.forEach((tocEntry, i) => this._chaptersRenderMarker(tocEntry, i));
+};
+
+/**
+ * @typedef {Object} TocEntry
+ * Table of contents entry as defined by Open Library, with some extra values for internal use
+ * @property {number} [level]
+ * @property {string} [label]
+ * @property {string} [title]
+ * @property {PageString} [pagenum]
+ * @property {LeafNum} [leaf]
+ * @property {number} [pageIndex] - Added
+ *
+ * @example {
+ *   "pagenum": "17",
+ *   "level": 1,
+ *   "label": "CHAPTER I",
+ *   "title": "THE COUNTRY AND THE MISSION"
+ * }
+ */
+
+/**
+ * @param {TocEntry} tocEntry
+ * @param {number} entryIndex
+ */
+BookReader.prototype._chaptersRenderMarker = function (tocEntry, entryIndex) {
+  if (tocEntry.pageIndex == undefined) return;
+
+  //creates a string with non-void tocEntry.label and tocEntry.title
+  var chapterStr = [tocEntry.label, tocEntry.title].filter(x => x).join(' ') || "Chapter ".concat(entryIndex + 1);
+  var percentThrough = BookReader.util.cssPercentage(tocEntry.pageIndex, this.book.getNumLeafs() - 1);
+  $("<div></div>").append($('<div />').text(chapterStr).append($('<div class="BRchapterPage" />').text(this.book.getPageName(tocEntry.pageIndex)))).addClass('BRchapter').css({
+    left: percentThrough
+  }).appendTo(this.$('.BRnavline')).on("mouseenter", event => {
+    // remove hover effect from other markers then turn on just for this
+    var marker = event.currentTarget;
+    var tooltip = marker.querySelector('div');
+    var tooltipOffset = tooltip.getBoundingClientRect();
+    var targetOffset = marker.getBoundingClientRect();
+    var boxSizeAdjust = parseInt(getComputedStyle(tooltip).paddingLeft) * 2;
+    if (tooltipOffset.x - boxSizeAdjust < 0) {
+      tooltip.style.setProperty('transform', "translateX(-".concat(targetOffset.left - boxSizeAdjust, "px)"));
+    }
+    this.$('.BRsearch,.BRchapter').removeClass('front');
+    $(event.target).addClass('front');
+  }).on("mouseleave", event => $(event.target).removeClass('front')).on('click', () => {
+    this._chaptersUpdateCurrent(tocEntry.pageIndex);
+    this.jumpToIndex(tocEntry.pageIndex);
+  });
+  this.$('.BRchapter, .BRsearch').each((i, el) => {
+    var $el = $(el);
+    $el.on("mouseenter", () => $el.addClass('front')).on("mouseleave", () => $el.removeClass('front'));
+  });
+};
+
+/**
+ * This makes a call to OL API and calls the given callback function with the
+ * response from the API.
+ *
+ * @param {string} olHost
+ * @param {string} ocaid
+ */
+BookReader.prototype.getOpenLibraryRecord = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator(function* (olHost, ocaid) {
+    var _data;
+    // Try looking up by ocaid first, then by source_record
+    var baseURL = "".concat(olHost, "/query.json?type=/type/edition&*=");
+    var fetchUrlByBookId = "".concat(baseURL, "&ocaid=").concat(ocaid);
+    var data = yield $.ajax({
+      url: fetchUrlByBookId
+    });
+    if (!data || !data.length) {
+      // try sourceid
+      data = yield $.ajax({
+        url: "".concat(baseURL, "&source_records=ia:").concat(ocaid)
+      });
+    }
+    return (_data = data) === null || _data === void 0 ? void 0 : _data[0];
+  });
+  return function (_x, _x2) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+
+/**
+ * @private
+ * Highlights the current chapter based on current page
+ * @param {PageIndex} curIndex
+ */
+BookReader.prototype._chaptersUpdateCurrent = function () {
+  var curIndex = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : this.mode == 2 ? Math.max(...this.displayedIndices) : this.firstIndex;
+  var tocEntriesIndexed = this._tocEntries.filter(el => el.pageIndex != undefined).reverse();
+  var currChapter = tocEntriesIndexed[
+  // subtract one so that 2up shows the right label
+  tocEntriesIndexed.findIndex(chapter => chapter.pageIndex <= curIndex)];
+  if (this._chaptersPanel) {
+    this._chaptersPanel.currentChapter = currChapter;
+  }
+};
+export var BRChaptersPanel = _decorate(null, function (_initialize, _LitElement) {
+  class BRChaptersPanel extends _LitElement {
+    /** @type {TocEntry[]} */
+
+    /** @type {TocEntry?} */
+
+    /** @type {(pageIndex: PageIndex) => void} */
+
+    /**
+     * @param {TocEntry[]} contents
+     */
+    constructor(contents) {
+      super();
+      _initialize(this);
+      this.contents = contents;
+    }
+
+    /**
+     * @param {TocEntry} tocEntry
+     */
+  }
+  return {
+    F: BRChaptersPanel,
+    d: [{
+      kind: "field",
+      decorators: [property({
+        type: Array
+      })],
+      key: "contents",
+      value() {
+        return [];
+      }
+    }, {
+      kind: "field",
+      decorators: [property({
+        type: Object
+      })],
+      key: "currentChapter",
+      value() {
+        return {};
+      }
+    }, {
+      kind: "field",
+      key: "jumpToPage",
+      value() {
+        return () => {};
+      }
+    }, {
+      kind: "method",
+      key: "render",
+      value: function render() {
+        return html(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n      <ol>\n        ", "\n      </ol>\n    "])), this.contents.map(tocEntry => this.renderTOCEntry(tocEntry)));
+      }
+    }, {
+      kind: "method",
+      key: "renderTOCEntry",
+      value: function renderTOCEntry(tocEntry) {
+        var chapterTitle = [tocEntry.label, tocEntry.title].filter(x => x).join(' ');
+        var clickable = tocEntry.pageIndex != undefined;
+        // note the click-tracking won't work...
+        return html(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral([" <li\n      class=\"\n        BRtable-contents-el\n        ", "\n        ", "\n      \"\n      style=\"", "\"\n      data-event-click-tracking=\"", "\"\n      @click=\"", "\"\n    >\n      ", "\n      ", "\n    </li>"])), clickable ? 'clickable' : '', tocEntry == this.currentChapter ? 'current' : '', styleMap({
+          marginLeft: (tocEntry.level - 1) * 10 + 'px'
+        }), ifDefined(clickable ? 'BRTOCPanel|GoToChapter' : undefined), () => this.jumpToPage(tocEntry.pageIndex), chapterTitle, tocEntry.pagenum ? html(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n            <br />\n            <span class=\"BRTOCElementPage\">Page ", "</span>\n          "])), tocEntry.pagenum) : nothing);
+      }
+    }, {
+      kind: "method",
+      key: "connectedCallback",
+      value: function connectedCallback() {
+        _superPropGet(BRChaptersPanel, "connectedCallback", this, 3)([]);
+        this.dispatchEvent(new CustomEvent('connected'));
+      }
+    }, {
+      kind: "method",
+      key: "updated",
+      value: function updated(changedProperties) {
+        if (changedProperties.has('currentChapter')) {
+          var _this$shadowRoot$quer;
+          (_this$shadowRoot$quer = this.shadowRoot.querySelector('li.current')) === null || _this$shadowRoot$quer === void 0 || _this$shadowRoot$quer.scrollIntoView({
+            block: 'nearest',
+            behavior: 'smooth'
+          });
+        }
+      }
+    }, {
+      kind: "get",
+      static: true,
+      key: "styles",
+      value: function value() {
+        return css(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral(["\n      ol {\n        padding: 0;\n        margin: 0;\n        margin-right: 5px;\n      }\n      li {\n        padding: 10px;\n        overflow: hidden;\n        border-radius: 4px;\n      }\n      li.clickable {\n        font-weight: normal;\n        cursor: pointer;\n        transition: background-color 0.2s;\n      }\n\n      li.clickable:not(.current):hover {\n        background-color: rgba(255, 255, 255, 0.05);\n      }\n\n      li.current {\n        background-color: rgba(255, 255, 255, 0.9);\n        color: #333;\n      }\n\n      .BRTOCElementPage {\n        font-size: 0.85em;\n        opacity: 0.8;\n      }\n    "])));
+      }
+    }]
+  };
+}, LitElement);
+customElements.define('br-chapters-panel', BRChaptersPanel);

package/dist/esm/plugins/plugin.iframe.js

@@ -0,0 +1,44 @@
+/* global BookReader */
+/**
+ * Plugin for two-way communication between a BookReader in an IFrame and the
+ * parent web page
+ */
+
+var MESSAGE_TYPE_FRAGMENT_CHANGE = 'bookReaderFragmentChange';
+BookReader.prototype.init = function (super_) {
+  return function () {
+    super_.call(this);
+    _attachEventListeners(this);
+  };
+}(BookReader.prototype.init);
+
+/**
+ * @private
+ * Using window.postMessage() and event listeners, the plugin notifies the
+ * parent window when pages change, and the parent window can also
+ * explicitly request a page change by sending its own message.
+ *
+ * @param {BookReader} br
+ * @param {Window?} [parent]
+ */
+export function _attachEventListeners(br) {
+  var parent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : window.parent;
+  // Not embedded, abort
+  if (!parent) {
+    return;
+  }
+  br.bind(BookReader.eventNames.fragmentChange, () => {
+    var fragment = br.fragmentFromParams(br.paramsFromCurrent());
+    parent.postMessage({
+      type: MESSAGE_TYPE_FRAGMENT_CHANGE,
+      fragment
+    }, '*');
+  });
+  window.addEventListener('message', event => {
+    // Not a recognized message type, abort
+    if (!event.data || event.data.type !== MESSAGE_TYPE_FRAGMENT_CHANGE) {
+      return;
+    }
+    br.updateFromParams(br.paramsFromFragment(event.data.fragment));
+  });
+}

package/dist/esm/plugins/plugin.iiif.js

@@ -0,0 +1,146 @@
+// @ts-check
+var BookReader = /** @type {typeof import('../BookReader').default} */window.BookReader;
+export var DEFAULT_OPTIONS = {
+  enabled: true,
+  /** @type {import('@iiif/presentation-3').Manifest | import('@iiif/presentation-2').Manifest} */
+  manifest: null
+};
+class IIIFPlugin {
+  constructor() {
+    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : DEFAULT_OPTIONS;
+    var optionVariables = arguments.length > 1 ? arguments[1] : undefined;
+    this.options = options;
+    this.optionVariables = optionVariables;
+    this.manifest = options.manifest;
+  }
+  load() {
+    if (this.manifest["@context"] == "http://iiif.io/api/presentation/2/context.json") {
+      var manifest = /** @type {import('@iiif/presentation-2').Manifest} */this.manifest;
+      return this.manifestToBookReaderV2(manifest);
+    } else if (this.manifest["@context"] == "http://iiif.io/api/presentation/3/context.json") {
+      var _manifest = /** @type {import('@iiif/presentation-3').Manifest} */this.manifest;
+      return this.manifestToBookReaderV3(_manifest);
+    } else {
+      throw new Error("Unsupported IIIF context " + this.manifest["@context"]);
+    }
+  }
+
+  /**
+   * @param {import('@iiif/presentation-3').Manifest} manifest
+   */
+  manifestToBookReaderV3(manifest) {
+    /** @type {import('../BookReader/options.js').BookReaderOptions} */
+    var book = {
+      bookTitle: resolveInternationalString(manifest.label),
+      pageProgression: manifest.viewingDirection == "right-to-left" ? "rl" : "lr",
+      // numLeafs: manifest.items.length,
+      metadata: (manifest.metadata || []).map(metadata => {
+        return {
+          label: resolveInternationalString(metadata.label),
+          value: resolveInternationalString(metadata.value)
+        };
+      }),
+      data: [],
+      /**
+       * @this {import('../BookReader.js').default}
+       */
+      getPageURI(pageIndex, reduce, rotate) {
+        var percent = Math.floor(100 * 1 / reduce);
+        var bodyArr = manifest.items[pageIndex].items[0].items[0].body;
+        var body = bodyArr instanceof Array ? bodyArr[0] : bodyArr;
+        var uri = body.service[0].id;
+        return "".concat(uri, "/full/pct:").concat(percent, "/0/default.jpg");
+      }
+    };
+    if (manifest.viewingDirection == "top-to-bottom" || manifest.viewingDirection == "bottom-to-top") {
+      console.warn("Unsupported viewingDirection", manifest.viewingDirection);
+    }
+    var spread = [];
+    manifest.items.forEach((item, index) => {
+      var bodyArr = manifest.items[index].items[0].items[0].body;
+      var body = bodyArr instanceof Array ? bodyArr[0] : bodyArr;
+      var uri = body.service[0].id;
+      /** @type {import('../BookReader/options.js').PageData} */
+      var pageData = {
+        uri,
+        width: item.width,
+        height: item.height,
+        pageNum: resolveInternationalString(item.label)
+      };
+      spread.push(pageData);
+      if (index % 2 == 0) {
+        book.data.push(spread);
+        spread = [];
+      }
+    });
+    if (spread.length > 0) {
+      book.data.push(spread);
+    }
+    return book;
+  }
+
+  /**
+   * @param {import('@iiif/presentation-2').Manifest} manifest
+   */
+  manifestToBookReaderV2(manifest) {
+    var _manifest$thumbnail;
+    /** @type {import('../BookReader/options.js').BookReaderOptions} */
+    var book = {
+      bookTitle: manifest.label,
+      metadata: manifest.metadata,
+      thumbnail: (_manifest$thumbnail = manifest.thumbnail) === null || _manifest$thumbnail === void 0 ? void 0 : _manifest$thumbnail['@id'],
+      // numLeafs: manifest.sequences[0].canvases.length,
+      data: [],
+      /**
+       * @this {import('../BookReader.js').default}
+       */
+      getPageURI(pageIndex, reduce, rotate) {
+        var percent = Math.floor(100 * 1 / reduce);
+        var uri = manifest.sequences[0].canvases[pageIndex].images[0].resource.service['@id'];
+        return "".concat(uri, "/full/pct:").concat(percent, "/0/default.jpg");
+      }
+    };
+    var spread = [];
+    manifest.sequences[0].canvases.forEach((canvas, index) => {
+      /** @type {import('../BookReader/options.js').PageData} */
+      var pageData = {
+        uri: canvas.images[0].resource.service['@id'],
+        width: canvas.width,
+        height: canvas.height,
+        pageNum: canvas.label
+      };
+      spread.push(pageData);
+      if (index % 2 == 0) {
+        book.data.push(spread);
+        spread = [];
+      }
+    });
+    if (spread.length > 0) {
+      book.data.push(spread);
+    }
+    return book;
+  }
+}
+
+/**
+ * @param {import('@iiif/presentation-3').InternationalString} internationalString
+ */
+function resolveInternationalString(internationalString) {
+  var anyLang = Object.keys(internationalString)[0];
+  return (internationalString[navigator.language] || internationalString[anyLang])[0];
+}
+export class BookReaderWithIIIFPlugin extends BookReader {
+  setup(options) {
+    var pluginOpts = Object.assign({}, DEFAULT_OPTIONS, options.plugins.iiif);
+    if (pluginOpts.enabled) {
+      this.iiifPlugin = new IIIFPlugin(pluginOpts, options.vars);
+      // Write this back; this way the plugin is the source of truth, and BR just
+      // contains a reference to it.
+      options.plugins.iiif = this.iiifPlugin.options;
+      Object.assign(options, this.iiifPlugin.load());
+    }
+    return super.setup(options);
+  }
+}
+window.BookReader = BookReaderWithIIIFPlugin;
+export default BookReaderWithIIIFPlugin;

package/dist/esm/plugins/plugin.resume.js

@@ -0,0 +1,66 @@
+import * as docCookies from '../util/docCookies.js';
+
+/* global BookReader */
+
+/** @deprecated Exposed for backward compatibility */
+BookReader.docCookies = docCookies;
+
+/**
+ * Plugin to remember the current page number in a cookie
+ */
+jQuery.extend(BookReader.defaultOptions, {
+  enablePageResume: true,
+  /** @type {string|null} eg '/', '/details/id' */
+  resumeCookiePath: null
+});
+
+/** @override */
+BookReader.prototype.init = function (super_) {
+  return function () {
+    super_.call(this);
+    if (this.options.enablePageResume) {
+      this.bind(BookReader.eventNames.fragmentChange, () => {
+        var params = this.paramsFromCurrent();
+        this.updateResumeValue(params.index);
+      });
+    }
+  };
+}(BookReader.prototype.init);
+
+/**
+ * Gets page resume value, for remembering reader's page
+ * Can be overridden for different implementation
+ *
+ * @return {number|null}
+ */
+BookReader.prototype.getResumeValue = function () {
+  var val = BookReader.docCookies.getItem('br-resume');
+  if (val !== null) return parseInt(val);else return null;
+};
+
+/**
+ * Return cookie path using pathname up to /page/... or /mode/...
+ * using window.location.pathname for urlPathPart:
+ * - matches encoding
+ * - ignores querystring part
+ * - ignores fragment part (after #)
+ * @param {string} urlPathPart - window.location.pathname
+ */
+BookReader.prototype.getCookiePath = function (urlPathPart) {
+  return urlPathPart.match('.+?(?=/page/|/mode/|$)')[0];
+};
+
+/**
+ * Sets page resume value, for remembering reader's page
+ * Can be overridden for different implementation
+ *
+ * @param {Number} index leaf index
+ * @param {string} [cookieName]
+ */
+BookReader.prototype.updateResumeValue = function (index, cookieName) {
+  var ttl = new Date(+new Date() + 12096e5); // 2 weeks
+  // For multiple files in item, leave resumeCookiePath blank
+  // It's likely we can remove resumeCookiePath using getCookiePath()
+  var path = this.options.resumeCookiePath || this.getCookiePath(window.location.pathname);
+  BookReader.docCookies.setItem(cookieName || 'br-resume', index, ttl, path, null, false);
+};