@chegg-ereader/viewer-utils 1.0.0-dev

package/README.md

@@ -0,0 +1,30 @@
+# @chegg-ereader/viewer-utils
+
+A base viewer utils for ereader.
+
+## Features
+
+- ES6 syntax
+
+## Install
+
+```sh
+yarn add @chegg-ereader/viewer-utils
+// or 
+npm i @chegg-ereader/viewer-utils
+```
+
+### Requirements
+
+- Node.js `v12.x` or later
+
+
+### Usage
+
+```js
+import { registerResizeMonitor } from '@chegg-ereader/viewer-utils';
+
+registerResizeMonitor.addListener((newSize) => {
+  handleSizeChange(newSize);
+});
+```

package/dist/esm/constants.js

@@ -0,0 +1,54 @@
+export var EVENT_VIEWER_READY = "onViewerReady";
+export var EVENT_PDF_PAGE_OPEN = "onPdfPageOpen";
+export var EVENT_PDF_PAGE_LOADED = "onPdfPageLoaded";
+export var EVENT_EPUB_PAGE_OPEN = "onEpubPageOpen";
+export var EVENT_EPUB_PAGE_LOADED = "onEpubPageLoaded";
+export var EVENT_READABLES_READY = "onReadablesReady";
+export var EVENT_ON_USER_SELECTION = "onUserSelection";
+export var EVENT_SELECTION_CLICKED = "onSelectionClicked";
+export var EVENT_CONTEXT_MENU = "onContextMenu";
+export var EVENT_USER_SELECT_START = "onUserSelectStart";
+export var EVENT_USER_SELECT_END = "onUserSelectEnd";
+export var EVENT_CHAPTER_OPEN = "onChapterOpen";
+export var EVENT_CHAPTER_OPENED = "onChapterOpened";
+export var EVENT_NAVIGATION = "onNavigation";
+export var EVENT_ON_TAP = "onTap";
+export var EVENT_KEYBOARD_PRESS = "onKeyboardPress";
+export var EVENT_CONTENT_BACKGROUND_SCROLL = "onContentBackgroundScroll";
+export var EVENT_USER_INTERACTION = "onUserInteraction";
+export var EVENT_VIEWER_NAVIGATION = "onViewerNavigation";
+export var EVENT_VIEWER_PAGE_NAVIGATION = "onViewerPageNavigation";
+export var EVENT_TBS_PROBLEM_CLICKED = "onTbsProblemClicked";
+export var ACTION_INIT = "init";
+export var ACTION_CREATE_HIGHLIGHT = "createHighlight";
+export var ACTION_REMOVE_HIGHLIGHT = "removeHighlight";
+export var ACTION_OPEN_PAGE = "openPage";
+export var ACTION_OPEN_LOCATION = "openLocation";
+export var ACTION_DESELECT = "deselect";
+export var ACTION_SET_FONT_TYPE = "setFontFamily";
+export var ACTION_SET_FONT_SIZE = "setFontSize";
+export var ACTION_LOAD_HIGHLIGHTS = "loadHighlights";
+export var ACTION_LOAD_SEARCH_HIGHLIGHTS = "loadSearchHighlights";
+export var ACTION_REMOVE_SEARCH_HIGHLIGHTS = "removeSearchHighlights";
+export var ACTION_SCROLL_TO_PAGE = "scrollToPage";
+export var ACTION_SCROLL_TO_ANCHOR = "scrollToAnchor";
+export var ACTION_OPEN_CHAPTER = "openChapter";
+export var ACTION_NAVIGATE_NEXT = "navigateNext";
+export var ACTION_NAVIGATE_PREV = "navigatePrev";
+export var ACTION_SET_ZOOM_LEVEL = "setZoomLevel";
+export var ACTION_ADD_KEYBOARD_LISTENER = "addKeyboardListener";
+export var ACTION_REMOVE_KEYBOARD_LISTENER = "removeKeyboardListener";
+export var ACTION_CHECK_READY = "checkViewerReader";
+export var ERROR_CONTENT_LOAD = "onContentLoadError";
+export var EVENT_NOTE_ICON_CLICK = "onNoteIconClick";
+export var EVENT_NOTE_GROUP_CLICK = "onNoteGroupClick";
+export var ACTION_CREATE_SPEECH_HIGHLIGHT = "createSpeechHighlight";
+export var ACTION_REMOVE_SPEECH_HIGHLIGHT = "removeSpeechHighlight";
+export var ACTION_LOAD_TBS = "loadTbs";
+export var MODIFIERS = {
+  CTRL: "ctrlKey",
+  CMD: "metaKey",
+  SHIFT: "shiftKey",
+  ALT: "altKey"
+};
+export var IGNORE_PROPERTY = "data-ignore-touch-detection";

package/dist/esm/modules/bridgeListener.js

@@ -0,0 +1,18 @@
+import { bridge } from "@chegg-ereader/bridge";
+export { triggerBridgeEvent, listenBridgeEvent, addBridgeListeners };
+
+function listenBridgeEvent(type, cb) {
+  bridge.listen(type, function (payload, done) {
+    var type = payload.type,
+        params = payload.params;
+    cb(payload, done);
+  });
+}
+
+function addBridgeListeners(map) {
+  bridge.addListeners(map);
+}
+
+function triggerBridgeEvent(payload) {
+  bridge.trigger(payload);
+}

package/dist/esm/modules/ePubStyleManager/types.js

@@ -0,0 +1,8 @@
+export var FONT_TYPES = {
+  0: "DEFAULT",
+  1: "Roboto",
+  2: "Open Sans",
+  3: "Lato",
+  4: "Merriweather"
+};
+export var DEFAULT_TYPE = 0;

package/dist/esm/modules/keyboard_manager.js

@@ -0,0 +1,67 @@
+import { MODIFIERS } from "../constants";
+var $registered = false;
+var $listeners;
+var $id = 0;
+var modifier_names = Object.keys(MODIFIERS).map(function (key) {
+  return MODIFIERS[key];
+});
+export { resetKeyboardListener, addKeyboardListener };
+resetKeyboardListener();
+
+function addKeyboardListener(_ref) {
+  var key = _ref.key,
+      modifier = _ref.modifier,
+      onShortcut = _ref.onShortcut,
+      prevent = _ref.prevent;
+  var id = "listener-".concat($id++);
+  register();
+  listener.$cb_id = id;
+  $listeners.push(listener);
+  return id;
+
+  function listener(e) {
+    var is_mac = navigator.platform.indexOf("Mac") > -1;
+
+    if (modifier) {
+      if (modifier == MODIFIERS.CMD && !is_mac) {
+        modifier = MODIFIERS.CTRL;
+      }
+
+      if (!e[modifier]) {
+        return;
+      }
+    } else {
+      for (var i = 0, _modifier; _modifier = modifier_names[i]; i++) {
+        // @ts-ignore
+        if (e[_modifier]) {
+          return;
+        }
+      }
+    }
+
+    if (e.key === key) {
+      onShortcut(e);
+    }
+
+    if (prevent) {
+      e.preventDefault();
+    }
+  }
+}
+
+function resetKeyboardListener() {
+  $registered = false;
+  $listeners = [];
+}
+
+function register() {
+  if ($registered) return;
+  $registered = true;
+  window.addEventListener("keyup", listener);
+}
+
+function listener(e) {
+  $listeners.forEach(function (listener) {
+    listener(e);
+  });
+}

package/dist/esm/modules/resizeMonitor.js

@@ -0,0 +1,73 @@
+export { __reset, registerResizeMonitor, addOnEnd, addConstant };
+var $listeners = {
+  constant: [],
+  onEnd: []
+};
+var $handle;
+var $registered = false; //@ts-ignore
+
+var $last_width = global.innerWidth || 0; //@ts-ignore
+
+var $last_height = global.innerHeight || 0;
+
+function __reset() {
+  $registered = false;
+  $listeners.constant = [];
+  $listeners.onEnd = [];
+}
+
+function addOnEnd(cb) {
+  $listeners.onEnd.push(cb);
+  return function unregister() {
+    var index = $listeners.onEnd.indexOf(cb);
+
+    if (index > -1) {
+      $listeners.onEnd.splice(index, 1);
+    }
+  };
+}
+
+function addConstant(cb) {
+  $listeners.constant.push(cb);
+  return function unregister() {
+    var index = $listeners.constant.indexOf(cb);
+
+    if (index > -1) {
+      $listeners.constant.splice(index, 1);
+    }
+  };
+}
+
+function registerResizeMonitor() {
+  if ($registered) return;
+
+  if (!("addEventListener" in global)) {
+    return;
+  }
+
+  window.addEventListener("resize", listener);
+  window.addEventListener("orientationchange", listener);
+  $registered = true;
+}
+
+function listener() {
+  clearTimeout($handle);
+  $handle = setTimeout(function () {
+    if (window.innerWidth === $last_width && window.innerHeight === $last_height) {
+      return;
+    }
+
+    $last_width = window.innerWidth;
+    $last_height = window.innerHeight;
+    onEnd();
+    $listeners.constant.forEach(function (listener) {
+      window.requestAnimationFrame(listener);
+    });
+  }, 500);
+}
+
+function onEnd() {
+  $listeners.onEnd.forEach(function (listener) {
+    window.requestAnimationFrame(listener);
+  });
+}

package/dist/esm/modules/swipeNavigation/swipeEvents.js

@@ -0,0 +1,99 @@
+export { initSwipeEvents };
+var START = "touchstart";
+var END = "touchend";
+/*
+these values are derived from the default values
+of Hammerjs
+ */
+
+var MIN_DISTANCE = 10;
+var MIN_VELOCITY = 0.3;
+var MAX_DELTA_Y = 60;
+var $active;
+var $start_time;
+var $start_x;
+var $start_y;
+resetParams();
+export var SWIPE_DIRECTIONS;
+
+(function (SWIPE_DIRECTIONS) {
+  SWIPE_DIRECTIONS[SWIPE_DIRECTIONS["LEFT"] = 0] = "LEFT";
+  SWIPE_DIRECTIONS[SWIPE_DIRECTIONS["RIGHT"] = 1] = "RIGHT";
+})(SWIPE_DIRECTIONS || (SWIPE_DIRECTIONS = {}));
+
+function initSwipeEvents() {
+  document.addEventListener(START, start);
+  document.addEventListener(END, end);
+
+  if ('addEventListener' in global) {
+    window.addEventListener("orientationchange", function () {
+      document.removeEventListener(START, start);
+      document.removeEventListener(END, end);
+      document.addEventListener(START, start);
+      document.addEventListener(END, end);
+    });
+  }
+}
+
+function start(e) {
+  resetParams();
+
+  if (!e.touches || e.touches.length == 0) {
+    return;
+  }
+
+  var touch = e.touches[0];
+  $start_time = Date.now();
+  $start_x = touch.clientX;
+  $start_y = touch.clientY;
+  $active = true;
+}
+
+function end(e) {
+  var selection = window.getSelection();
+
+  if (!$active || selection && !selection.isCollapsed) {
+    resetParams();
+    return;
+  }
+
+  if (!e.changedTouches || e.changedTouches.length == 0) {
+    return;
+  }
+
+  var changed_touch = e.changedTouches[0];
+  var time_delta = Date.now() - $start_time;
+  var delta_y = Math.abs(changed_touch.clientY - $start_y);
+  var distance = changed_touch.clientX - $start_x;
+  var velocity = distance / time_delta;
+  resetParams();
+
+  if (delta_y > MAX_DELTA_Y) {
+    return;
+  }
+
+  if (Math.abs(velocity) < MIN_VELOCITY) {
+    return;
+  }
+
+  if (Math.abs(distance) < MIN_DISTANCE) {
+    return;
+  }
+
+  var direction = velocity > 0 ? SWIPE_DIRECTIONS.RIGHT : SWIPE_DIRECTIONS.LEFT;
+  var event = new CustomEvent("swipe", {
+    detail: {
+      direction: direction,
+      origEvent: e
+    }
+  });
+  console.log('dispatching');
+  document.dispatchEvent(event);
+}
+
+function resetParams() {
+  $active = false;
+  $start_time = 0;
+  $start_x = 0;
+  $start_y = 0;
+}

package/dist/esm/modules/touchDetector.js

@@ -0,0 +1,85 @@
+import { triggerBridgeEvent } from "./bridgeListener";
+import { EVENT_USER_INTERACTION, IGNORE_PROPERTY } from "../constants";
+export { registerTouchDetector, registerTouchDetectorListener, addTouchDectectorListener, removeTouchDetectorListener, resetTouchDetector, triggerTouchDetectorListeners, useIClick, checkIgnore };
+var $listeners;
+var $registered;
+var $event = "click";
+resetTouchDetector();
+
+function useIClick() {
+  $event = "iclick";
+}
+
+function registerTouchDetector() {
+  if ($registered) return;
+  registerTouchDetectorListener();
+  addTouchDectectorListener(function () {
+    triggerBridgeEvent({
+      type: EVENT_USER_INTERACTION,
+      params: {}
+    });
+  });
+}
+
+function registerTouchDetectorListener() {
+  if ($registered) return; //@ts-ignore
+
+  if (!global.document) {
+    return;
+  }
+
+  document.body.addEventListener($event, triggerTouchDetectorListeners);
+  $registered = true;
+}
+
+function triggerTouchDetectorListeners(e) {
+  var el = e && e.target;
+  var has_selection = window.getSelection && window.getSelection();
+  if (has_selection && has_selection.toString().length) return;
+
+  if (checkIgnore(el)) {
+    return;
+  }
+
+  $listeners.forEach(function (cb) {
+    return cb({});
+  });
+}
+
+function addTouchDectectorListener(cb) {
+  $listeners.push(cb);
+}
+
+function removeTouchDetectorListener(cb) {
+  var index = $listeners.indexOf(cb);
+
+  if (index > -1) {
+    $listeners.splice(index, 1);
+  }
+}
+
+function resetTouchDetector() {
+  $listeners = [];
+  $registered = false; //@ts-ignore
+
+  if (!global.document) {
+    return;
+  }
+
+  document.body.removeEventListener($event, triggerTouchDetectorListeners);
+}
+
+function checkIgnore(el) {
+  var property = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : IGNORE_PROPERTY;
+  if (!el) return false;
+
+  do {
+    if (el.getAttribute && el.getAttribute(property)) {
+      return true;
+    }
+
+    el = el.parentNode;
+  } while (el && el != document.body);
+
+  return false;
+}

package/dist/esm/modules/types.js

@@ -0,0 +1,16 @@
+export * from './ePubStyleManager/types';
+export * from './swipeNavigation/types';
+import { ACTION_ADD_KEYBOARD_LISTENER, ACTION_CREATE_HIGHLIGHT, ACTION_DESELECT, ACTION_LOAD_HIGHLIGHTS, ACTION_LOAD_SEARCH_HIGHLIGHTS, ACTION_REMOVE_SEARCH_HIGHLIGHTS, ACTION_OPEN_PAGE, ACTION_OPEN_LOCATION, ACTION_REMOVE_HIGHLIGHT, ACTION_SET_FONT_TYPE, ACTION_SET_ZOOM_LEVEL, ACTION_SET_FONT_SIZE, ACTION_INIT, ACTION_NAVIGATE_NEXT, ACTION_NAVIGATE_PREV, ACTION_CHECK_READY, ACTION_CREATE_SPEECH_HIGHLIGHT, ACTION_REMOVE_SPEECH_HIGHLIGHT, ACTION_LOAD_TBS } from "../constants";
+export var IMAGE_SIZE;
+
+(function (IMAGE_SIZE) {
+  IMAGE_SIZE["SM"] = "SM";
+  IMAGE_SIZE["MED"] = "MED";
+  IMAGE_SIZE["LRG"] = "LRG";
+})(IMAGE_SIZE || (IMAGE_SIZE = {}));
+
+export var ImageSizes = {
+  768: IMAGE_SIZE.SM,
+  992: IMAGE_SIZE.MED,
+  1920: IMAGE_SIZE.LRG
+};

package/dist/esm/payloads.js

@@ -0,0 +1,8 @@
+export var NAVIGATION_TYPE;
+
+(function (NAVIGATION_TYPE) {
+  NAVIGATION_TYPE["SWIPE"] = "swipe";
+  NAVIGATION_TYPE["TAP"] = "tap";
+  NAVIGATION_TYPE["CLICK"] = "click";
+  NAVIGATION_TYPE["KEYPRESS"] = "typed";
+})(NAVIGATION_TYPE || (NAVIGATION_TYPE = {}));

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@chegg-ereader/viewer-utils",
+  "version": "1.0.0-dev",
+  "private": false,
+  "description": "A base viewer utils for ereader.",
+  "license": "MIT",
+  "author": "hcheg-reader",
+  "main": "tsconfig.json",
+  "repository": "https://www.github.com/hcheg-reader/chegg-ereader/viewer-utils",
+  "scripts": {
+    "test": "exit 0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.18.10",
+    "@babel/cli": "^7.18.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}