npm - box-content-preview - Versions diffs - 3.69.0 → 3.70.0 - Mend

box-content-preview 3.69.0 → 3.70.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -2,7 +2,7 @@
 [![Mergify Status](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/box/box-content-preview&style=flat)](https://mergify.io)
 [![Styled With Prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![build status](https://img.shields.io/travis/box/box-content-preview/master.svg?style=flat-square)](https://travis-ci.org/box/box-content-preview)
-[![version](https://img.shields.io/badge/version-v3.69.0-blue.svg?style=flat-square)](https://github.com/box/box-content-preview)
+[![version](https://img.shields.io/badge/version-v3.70.0-blue.svg?style=flat-square)](https://github.com/box/box-content-preview)
 [![npm version](https://img.shields.io/npm/v/box-ui-elements.svg?style=flat-square)](https://www.npmjs.com/package/box-ui-elements)
 # [Box Content Preview](https://developer.box.com/docs/box-content-preview)
@@ -22,11 +22,11 @@ We encourage all users to update their applications to utilize modern browsers f
 ## Current Version
-- Version: v3.69.0
+- Version: v3.70.0
 - Locale: en-US
-https://cdn01.boxcdn.net/platform/preview/3.69.0/en-US/preview.js
-https://cdn01.boxcdn.net/platform/preview/3.69.0/en-US/preview.css
+https://cdn01.boxcdn.net/platform/preview/3.70.0/en-US/preview.js
+https://cdn01.boxcdn.net/platform/preview/3.70.0/en-US/preview.css
 ## Supported Locales
@@ -52,10 +52,10 @@ You can self-host the Box Content Preview library or reference the versions avai
     <title>Box Content Preview Demo</title>
     <!-- Latest version of Preview SDK for your locale -->
-    <script src="https://cdn01.boxcdn.net/platform/preview/3.69.0/en-US/preview.js"></script>
+    <script src="https://cdn01.boxcdn.net/platform/preview/3.70.0/en-US/preview.js"></script>
     <link
       rel="stylesheet"
-      href="https://cdn01.boxcdn.net/platform/preview/3.69.0/en-US/preview.css"
+      href="https://cdn01.boxcdn.net/platform/preview/3.70.0/en-US/preview.css"
     />
   </head>
   <body>
@@ -76,7 +76,7 @@ To self-host the Box Content Preview library, follow these steps:
 1. Either fork the repo and check out the version you want to host or download the specific version as a zip:
-- Check out a specific version with `git checkout v3.69.0`
+- Check out a specific version with `git checkout v3.70.0`
 - Download a specific version as a zip from https://github.com/box/box-content-preview/releases
 2. Install dependencies and build the library with `yarn install && yarn build:i18n && yarn build:prod`

package/dist/lib/index.js CHANGED Viewed

@@ -17387,6 +17387,15 @@ const USER_DOCUMENT_THUMBNAIL_EVENTS = {
   NAVIGATE: 'user_document_thumbnails_navigate',
   OPEN: 'user_document_thumbnails_open'
 };
+// Events fired when using gallery view
+const USER_DOCUMENT_GALLERY_EVENTS = {
+  DISMISS: 'user_document_gallery_dismiss',
+  // The gallery closes without the user settling on a page
+  NAVIGATE: 'user_document_gallery_navigate',
+  // The user picks a page, or closes on one they browsed to
+  OPEN: 'user_document_gallery_open' // The user opens the gallery
+};
 const MISSING_EXTERNAL_REFS = 'missing_x_refs';
 const MEDIA_METRIC = {
   bufferFill: 'bufferFill',
@@ -17416,7 +17425,7 @@ function util_toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var
 const CLIENT_NAME = "box-content-preview"; // eslint-disable-line no-undef
 const CLIENT_NAME_KEY = 'box_client_name';
 const CLIENT_VERSION_KEY = 'box_client_version';
-const CLIENT_VERSION = "3.69.0"; // eslint-disable-line no-undef
+const CLIENT_VERSION = "3.70.0"; // eslint-disable-line no-undef
 const HEADER_CLIENT_NAME = 'X-Box-Client-Name';
 const HEADER_CLIENT_VERSION = 'X-Box-Client-Version';
 const PROMISE_MAP = {};
@@ -19141,7 +19150,7 @@ class Browser {
 ;// ./src/lib/Logger.js
 /* eslint-disable no-undef */
 const Logger_CLIENT_NAME = "box-content-preview";
-const Logger_CLIENT_VERSION = "3.69.0";
+const Logger_CLIENT_VERSION = "3.70.0";
 /* eslint-enable no-undef */
 class Logger {
@@ -24627,13 +24636,13 @@ const ImageLoader_VIEWERS = [{
   NAME: 'Image',
   CONSTRUCTOR: image_ImageViewer,
   REP: 'jpg',
-  EXT: ['jpeg', 'jpg', 'cr2', 'crw', 'dng', 'nef', 'raf', 'raw'],
+  EXT: ['jpeg', 'jpg', 'cr2', 'cr3', 'crw', 'dng', 'nef', 'raf', 'raw'],
   ASSET: '1.jpg'
 }, {
   NAME: 'Image',
   CONSTRUCTOR: image_ImageViewer,
   REP: 'png',
-  EXT: ['ai', 'bmp', 'dcm', 'eps', 'gif', 'heic', 'png', 'ps', 'psd', 'tga', 'tif', 'tiff', 'webp'],
+  EXT: ['ai', 'avif', 'bmp', 'dcm', 'eps', 'gif', 'heic', 'png', 'ps', 'psd', 'tga', 'tif', 'tiff', 'webp'],
   ASSET: '1.png'
 }];
 class ImageLoader extends viewers_AssetLoader {
@@ -39742,6 +39751,7 @@ const GalleryTile = /*#__PURE__*/__WEBPACK_EXTERNAL_MODULE_react_default__.memo(
       "aria-selected": isFocused,
       className: `bp-gallery-tile${isFocused ? ' bp-gallery-tile--selected' : ''}`,
       "data-page": pageNum,
+      "data-resin-target": "galleryTile",
       onClick: () => onClick(pageNum),
       onFocus: () => onFocus(pageNum),
       role: "option",
@@ -40092,6 +40102,7 @@ class GalleryController {
     GalleryController_defineProperty(this, "focusToggle", void 0);
     GalleryController_defineProperty(this, "onBeforeOpen", void 0);
     GalleryController_defineProperty(this, "onAfterClose", void 0);
+    GalleryController_defineProperty(this, "onClose", void 0);
     GalleryController_defineProperty(this, "galleryRoot", null);
     GalleryController_defineProperty(this, "galleryEl", null);
     GalleryController_defineProperty(this, "galleryThumbnail", null);
@@ -40100,6 +40111,7 @@ class GalleryController {
     GalleryController_defineProperty(this, "gallerySidebarTimeoutId", null);
     GalleryController_defineProperty(this, "sidebarWasOpen", false);
     GalleryController_defineProperty(this, "isGalleryOpen", false);
+    GalleryController_defineProperty(this, "pickedPage", null);
     GalleryController_defineProperty(this, "toggle", () => {
       this.isGalleryOpen = !this.isGalleryOpen;
       if (this.isGalleryOpen) {
@@ -40150,6 +40162,11 @@ class GalleryController {
             }, THUMBNAILS_SIDEBAR_TRANSITION_TIME);
           }
         }
+        const {
+          pickedPage
+        } = this;
+        this.pickedPage = null;
+        this.onClose(pickedPage ?? navigateToPage);
       }
       this.requestUiUpdate();
       if (!this.isGalleryOpen) {
@@ -40159,6 +40176,7 @@ class GalleryController {
     });
     GalleryController_defineProperty(this, "handleGalleryNavigate", pageNum => {
       this.galleryFocusedPage = pageNum;
+      this.pickedPage = pageNum;
       this.toggle();
     });
     GalleryController_defineProperty(this, "handleFocusChange", pageNum => {
@@ -40189,6 +40207,7 @@ class GalleryController {
     this.focusToggle = opts.focusToggle;
     this.onBeforeOpen = opts.onBeforeOpen;
     this.onAfterClose = opts.onAfterClose;
+    this.onClose = opts.onClose;
   }
   get isOpen() {
     return this.isGalleryOpen;
@@ -40229,6 +40248,12 @@ class GalleryController {
     }
   }
   destroy() {
+    // Teardown with the gallery still open (file switch, preview closed) resolves the open
+    // instead of leaving it looking abandoned. Depends on the viewer destroying this controller
+    // before BaseViewer.destroy drops the metric listeners.
+    if (this.isGalleryOpen) {
+      this.onClose(null);
+    }
     if (this.galleryMountTimeoutId !== null) {
       clearTimeout(this.galleryMountTimeoutId);
       this.galleryMountTimeoutId = null;
@@ -40275,6 +40300,7 @@ class GalleryController {
     }
     const thumbnail = this.galleryThumbnail;
     this.galleryEl = document.createElement('div');
+    this.galleryEl.setAttribute('data-resin-component', 'gallery');
     this.containerEl.insertBefore(this.galleryEl, this.containerEl.querySelector('.bp-ControlsRoot'));
     this.galleryRoot = __WEBPACK_EXTERNAL_MODULE_react_dom_client_4cb20cd7_createRoot__(this.galleryEl);
     this.galleryFocusedPage = pdfViewer.currentPageNumber;
@@ -41844,7 +41870,8 @@ class DocBaseViewer extends viewers_BaseViewer {
         }
       },
       onBeforeOpen: () => this.handleGalleryEnter(),
-      onAfterClose: () => this.handleGalleryExit()
+      onAfterClose: () => this.handleGalleryExit(),
+      onClose: landedPage => this.handleGalleryClose(landedPage)
     });
   }
@@ -43575,9 +43602,35 @@ class DocBaseViewer extends viewers_BaseViewer {
     if (this.annotator) {
       this.annotator.toggleAnnotationMode(AnnotationMode.NONE);
     }
+    this.emitMetric({
+      name: USER_DOCUMENT_GALLERY_EVENTS.OPEN,
+      data: this.pdfViewer?.pagesCount ?? 0
+    });
     this.emit(VIEWER_EVENT.galleryOpen);
   }
+  /**
+   * Called as the gallery closes, with the page the user landed on or null if they left without
+   * settling on one. Reported as two distinct metrics so the pick-through rate is measurable.
+   *
+   * @protected
+   * @param {number|null} landedPage - Page the gallery left the document on, or null if unchanged
+   * @return {void}
+   */
+  handleGalleryClose(landedPage) {
+    if (landedPage !== null) {
+      this.emitMetric({
+        name: USER_DOCUMENT_GALLERY_EVENTS.NAVIGATE,
+        data: landedPage
+      });
+    } else {
+      this.emitMetric({
+        name: USER_DOCUMENT_GALLERY_EVENTS.DISMISS,
+        data: this.pdfViewer?.pagesCount ?? 0
+      });
+    }
+  }
   /**
    * Called after the gallery closes. Restores REGION mode so the region-comment cursor is active.
    *

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "box-content-preview",
-    "version": "3.69.0",
+    "version": "3.70.0",
     "description": "Box Content Preview UI Element",
     "author": "Box (https://www.box.com/)",
     "license": "SEE LICENSE IN LICENSE",