box-content-preview 3.94.0 → 3.96.0

package/README.md

@@ -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.94.0-blue.svg?style=flat-square)](https://github.com/box/box-content-preview)
+[![version](https://img.shields.io/badge/version-v3.96.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.94.0
+- Version: v3.96.0
 - Locale: en-US
 
-https://cdn01.boxcdn.net/platform/preview/3.94.0/en-US/preview.js
-https://cdn01.boxcdn.net/platform/preview/3.94.0/en-US/preview.css
+https://cdn01.boxcdn.net/platform/preview/3.96.0/en-US/preview.js
+https://cdn01.boxcdn.net/platform/preview/3.96.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.94.0/en-US/preview.js"></script>
+    <script src="https://cdn01.boxcdn.net/platform/preview/3.96.0/en-US/preview.js"></script>
     <link
       rel="stylesheet"
-      href="https://cdn01.boxcdn.net/platform/preview/3.94.0/en-US/preview.css"
+      href="https://cdn01.boxcdn.net/platform/preview/3.96.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.94.0`
+- Check out a specific version with `git checkout v3.96.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

@@ -314,6 +314,7 @@ class PreviewError extends Error {
 /* harmony export */   Ci: () => (/* binding */ CLASS_BOX_PREVIEW_VIDEO_PRELOAD_PLAY_OVERLAY),
 /* harmony export */   D4: () => (/* binding */ CLASS_ANNOTATIONS_VIDEO_FTUX_CURSOR_SEEN),
 /* harmony export */   EP: () => (/* binding */ ORIGINAL_REP_NAME),
+/* harmony export */   Ed: () => (/* binding */ BLUEPRINT_MIGRATION_SUPPORTING_UI),
 /* harmony export */   Ev: () => (/* binding */ BROWSERS),
 /* harmony export */   FD: () => (/* binding */ SELECTOR_BOX_PREVIEW_LOGO_DEFAULT),
 /* harmony export */   GA: () => (/* binding */ ANNOTATOR_EVENT),
@@ -337,6 +338,7 @@ class PreviewError extends Error {
 /* harmony export */   Mi: () => (/* binding */ PDFJS_CSS_UNITS),
 /* harmony export */   Mj: () => (/* binding */ CLASS_BOX_PREVIEW_THUMBNAILS_CLOSE_ACTIVE),
 /* harmony export */   N7: () => (/* binding */ DISCOVERABILITY_ATTRIBUTE),
+/* harmony export */   OQ: () => (/* binding */ BLUEPRINT_MIGRATION_CONTROLS_BAR),
 /* harmony export */   OW: () => (/* binding */ PRELOAD_REP_NAME),
 /* harmony export */   Oo: () => (/* binding */ CLASS_ANNOTATIONS_CREATE_REGION),
 /* harmony export */   P8: () => (/* binding */ CLASS_BOX_PREVIEW_HAS_HEADER),
@@ -367,9 +369,11 @@ class PreviewError extends Error {
 /* harmony export */   bE: () => (/* binding */ SELECTOR_BOX_PREVIEW_CONTENT),
 /* harmony export */   br: () => (/* binding */ FILE_OPTION_FILE_VERSION_ID),
 /* harmony export */   c6: () => (/* binding */ PRELOAD_PAGED_REP_NAME),
+/* harmony export */   cA: () => (/* binding */ BLUEPRINT_MIGRATION_ARCHIVE),
 /* harmony export */   cP: () => (/* binding */ CLASS_BOX_PREVIEW_PRELOAD_WRAPPER_VIDEO),
 /* harmony export */   cR: () => (/* binding */ TEXT_STATIC_ASSETS_VERSION),
 /* harmony export */   cZ: () => (/* binding */ CLASS_ANNOTATIONS_DISCOVERABLE),
+/* harmony export */   dR: () => (/* binding */ BLUEPRINT_MIGRATION_MEDIA_CONTROLS),
 /* harmony export */   eA: () => (/* binding */ SUBTITLES_OFF),
 /* harmony export */   eF: () => (/* binding */ CLASS_BOX_PREVIEW_PRELOAD_CONTENT),
 /* harmony export */   eM: () => (/* binding */ CLASS_BOX_PREVIEW_HAS_NAVIGATION),
@@ -525,6 +529,13 @@ const X_REP_HINT_VIDEO_MP4 = '[mp4]';
 const X_REP_HINT_WAVEFORM = '[waveform]';
 const AI_TRANSCRIPTION_FOR_VIDEO_SUBTITLES = 'aiTranscriptionForVideoSubtitles';
 const AUDIO_PLAYER_V2 = 'audioPlayerV2.enabled';
+
+// One per wave of the Blueprint migration. Each is reported as its own metric dimension so a
+// dashboard can compare a wave's timings with its flag on against the same wave with it off.
+const BLUEPRINT_MIGRATION_ARCHIVE = 'blueprintMigrationArchive.enabled';
+const BLUEPRINT_MIGRATION_CONTROLS_BAR = 'blueprintMigrationControlsBar.enabled';
+const BLUEPRINT_MIGRATION_MEDIA_CONTROLS = 'blueprintMigrationMediaControls.enabled';
+const BLUEPRINT_MIGRATION_SUPPORTING_UI = 'blueprintMigrationSupportingUi.enabled';
 const PDFJS_CSS_UNITS = 96.0 / 72.0; // Should match CSS_UNITS in pdf_viewer.js
 const PDFJS_MAX_AUTO_SCALE = 1.25; // Should match MAX_AUTO_SCALE in pdf_viewer.js
 const PDFJS_WIDTH_PADDING_PX = 40; // Should match SCROLLBAR_PADDING in pdf_viewer.js
@@ -1018,7 +1029,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 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.94.0"; // eslint-disable-line no-undef
+const CLIENT_VERSION = "3.96.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 = {};
@@ -24650,7 +24661,7 @@ class Browser {
 ;// ./src/lib/Logger.js
 /* eslint-disable no-undef */
 const CLIENT_NAME = "box-content-preview";
-const CLIENT_VERSION = "3.94.0";
+const CLIENT_VERSION = "3.96.0";
 /* eslint-enable no-undef */
 
 class Logger {
@@ -55034,18 +55045,15 @@ const LOG_RETRY_COUNT = 3; // number of times to retry logging preview event
 const MS_IN_S = 1000; // ms in a sec
 const SUPPORT_URL = 'https://support.box.com';
 
-// All preview assets are relative to preview.js. Here we create a location
-// object that mimics the window location object and points to where
-// preview.js is loaded from by the browser. This needs to be done statically
-// outside the class so that location is found while this script is executing
-// and not when preview is instantiated, which is too late.
-// findScriptLocation throws when there is no preview.js <script> tag in the DOM;
-// npm consumers have no such tag and populate this via Preview.show({ location }).
-let PREVIEW_LOCATION;
-try {
-  PREVIEW_LOCATION = (0,util/* findScriptLocation */.Is)(constants/* PREVIEW_SCRIPT_NAME */.Lq, document.currentScript);
-} catch (e) {
-  PREVIEW_LOCATION = {};
+// document.currentScript is this file only while it evaluates.
+const IS_NPM_BUILD =  true && true;
+let PREVIEW_LOCATION = {};
+if (!IS_NPM_BUILD) {
+  try {
+    PREVIEW_LOCATION = (0,util/* findScriptLocation */.Is)(constants/* PREVIEW_SCRIPT_NAME */.Lq, document.currentScript);
+  } catch (e) {
+    PREVIEW_LOCATION = {};
+  }
 }
 class Preview extends (events_default()) {
   //--------------------------------------------------------------------------
@@ -55116,10 +55124,6 @@ class Preview extends (events_default()) {
     DEFAULT_DISABLED_VIEWERS.forEach(viewerName => {
       this.disabledViewers[viewerName] = 1;
     });
-
-    // All preview assets are relative to preview.js. Here we create a location
-    // object that mimics the window location object and points to where
-    // preview.js is loaded from by the browser.
     this.location = PREVIEW_LOCATION;
     this.cache = new lib_Cache();
     this.ui = new lib_PreviewUI();
@@ -55188,11 +55192,11 @@ class Preview extends (events_default()) {
     // But it cannot be a random object.
     if (token === null || typeof token !== 'object') {
       // npm consumers have no CDN-served pdfjs at runtime; force the bundled npm pdfjs path.
-      const finalOptions =  true ? Preview_objectSpread(Preview_objectSpread({}, options), {}, {
+      const finalOptions = IS_NPM_BUILD ? Preview_objectSpread(Preview_objectSpread({}, options), {}, {
         features: Preview_objectSpread({
           useNpmPdfjs: true
         }, options.features || {})
-      }) : 0;
+      }) : options;
       this.previewOptions = Preview_objectSpread(Preview_objectSpread({}, finalOptions), {}, {
         token
       });
@@ -55210,6 +55214,11 @@ class Preview extends (events_default()) {
     // Parse the preview options
     this.parseOptions(this.previewOptions);
 
+    // /preview.js parses to locale ''. Throw only when locale is absent.
+    if ((0,util/* getProp */.GT)(this.location, 'locale') == null) {
+      throw new Error('Missing preview location. Load preview.js, or pass location to show().');
+    }
+
     // Load the preview
     this.load(fileIdOrFile);
   }
@@ -56123,11 +56132,18 @@ class Preview extends (events_default()) {
   loadFromCache() {
     // Log cache hit
     this.logger.setCached();
-
-    // Finally load the viewer
-    this.loadViewer();
     const needsVideoReps = this.isVideoFileByExtension() && !this.hasPlayableVideoReps(this.file);
-    if (!this.options.skipServerUpdate || needsVideoReps) {
+    const needsTranscriptionRep = isFeatureEnabled(this.options.features, constants/* AI_TRANSCRIPTION_FOR_VIDEO_SUBTITLES */.Iu) && this.isVideoFileByExtension() && !this.hasTranscriptionRep(this.file);
+    // Captions are optional — do not treat a missing extracted_text rep like missing
+    // dash/mp4. skipServerUpdate still skips this refresh; default reopen already
+    // calls loadFromServer() because skipServerUpdate is false.
+    const needsServerRefresh = !this.options.skipServerUpdate || needsVideoReps || needsTranscriptionRep;
+
+    // Play from cache immediately. Default reopen still refreshes file info in the
+    // background; handleFileInfoResponse then updates the live viewer if extracted_text
+    // arrived. A failed captions-only refresh must not uncache or destroy playback.
+    this.loadViewer();
+    if (needsServerRefresh) {
       this.loadFromServer();
     }
   }
@@ -56158,7 +56174,14 @@ class Preview extends (events_default()) {
     const fileInfoUrl = (0,util/* appendQueryParams */.Ne)(getURL(this.file.id, fileVersionId, apiHost), params);
     this.api.get(fileInfoUrl, {
       headers: this.getRequestHeaders()
-    }).then(this.handleFileInfoResponse).catch(this.handleFetchError);
+    }).then(this.handleFileInfoResponse).catch(err => {
+      // Captions are optional. If a cache-hit viewer is already playing dash/mp4,
+      // a failed background file-info refresh must not uncache or triggerError.
+      if (this.viewer && this.hasPlayableVideoReps(this.file)) {
+        return;
+      }
+      this.handleFetchError(err);
+    });
   }
 
   /**
@@ -56249,6 +56272,7 @@ class Preview extends (events_default()) {
       if (this.isVideoFileByExtension() && !this.hasPlayableVideoReps(file)) {
         throw new PreviewError/* default */.A(lib_events/* ERROR_CODE */.bo.ACCOUNT, "This preview didn’t load because your account is unable to preview this file type. Please try to open or download the file to view.");
       }
+      const needsTranscriptionReload = this.canUseDash() && isFeatureEnabled(this.options.features, constants/* AI_TRANSCRIPTION_FOR_VIDEO_SUBTITLES */.Iu) && this.isVideoFileByExtension() && !this.hasTranscriptionRep(cachedFile) && this.hasTranscriptionRep(file);
 
       // Should load viewer for first time if:
       //   - File isn't cached OR
@@ -56262,6 +56286,18 @@ class Preview extends (events_default()) {
       } else if (cachedFile.file_version.sha1 !== file.file_version.sha1 || isFileWatermarked) {
         this.logger.setCacheStale(); // Log that cache is stale
         this.reload(true); // Reload viewer without fetching updated file info from server
+      } else if (needsTranscriptionReload) {
+        // Cache was valid but lacked extracted_text (e.g. prefetch without the hint).
+        // Server refresh now has the rep — update the already-playing viewer so
+        // loadTranscription can attach captions. Only call it after loadeddata;
+        // calling earlier duplicates the Auto-generated Shaka track and can throw
+        // if UI is not ready. If loadeddata has not fired, the handler uses this file.
+        if (this.viewer) {
+          this.viewer.options.file = this.file;
+          if (this.viewer.isLoaded() && typeof this.viewer.loadTranscription === 'function') {
+            this.viewer.loadTranscription();
+          }
+        }
       }
     } catch (err) {
       const error = err instanceof PreviewError/* default */.A ? err : new PreviewError/* default */.A(lib_events/* ERROR_CODE */.bo.LOAD_VIEWER, "This preview didn’t load. Please try to open or download the file to view.", {}, err.message);
@@ -56382,6 +56418,31 @@ class Preview extends (events_default()) {
     });
   }
 
+  /**
+   * Returns true if file has an extracted_text transcription rep with a content URL.
+   *
+   * @private
+   * @param {Object} file - File object
+   * @return {boolean}
+   */
+  hasTranscriptionRep(file) {
+    if (!file?.representations?.entries) {
+      return false;
+    }
+    const extractedText = getRepresentation(file, 'extracted_text');
+    return !!extractedText?.content?.url_template;
+  }
+
+  /**
+   * Returns true when Dash playback is available and not disabled.
+   *
+   * @private
+   * @return {boolean}
+   */
+  canUseDash() {
+    return lib_Browser.canPlayDash() && !this.disabledViewers.Dash;
+  }
+
   /**
    * Returns true if file has playable video representations (dash or mp4).
    *
@@ -56836,7 +56897,7 @@ class Preview extends (events_default()) {
       previewMode,
       sharedLinkAuth
     } = this.options || {};
-    this.emit(name, Preview_objectSpread(Preview_objectSpread({}, payload), {}, {
+    this.emit(name, Preview_objectSpread(Preview_objectSpread(Preview_objectSpread({}, payload), this.getBlueprintMigrationTags()), {}, {
       access_pattern: accessPattern,
       client_name: clientName,
       content_type: (0,util/* getProp */.GT)(this.viewer, 'options.viewer.NAME', ''),
@@ -56854,6 +56915,26 @@ class Preview extends (events_default()) {
     }, getClientLogDetails()));
   }
 
+  /**
+   * Returns the state of each Blueprint migration wave for this preview session. Every metric
+   * and error carries all four, including the waves that are off, so the flag-off side of a
+   * rollout is measured the same way as the flag-on side rather than inferred from its absence.
+   *
+   * @private
+   * @return {Object} Blueprint migration dimensions
+   */
+  getBlueprintMigrationTags() {
+    const {
+      features
+    } = this.options || {};
+    return {
+      blueprint_archive: isFeatureEnabled(features, constants/* BLUEPRINT_MIGRATION_ARCHIVE */.cA),
+      blueprint_controls_bar: isFeatureEnabled(features, constants/* BLUEPRINT_MIGRATION_CONTROLS_BAR */.OQ),
+      blueprint_media_controls: isFeatureEnabled(features, constants/* BLUEPRINT_MIGRATION_MEDIA_CONTROLS */.dR),
+      blueprint_supporting_ui: isFeatureEnabled(features, constants/* BLUEPRINT_MIGRATION_SUPPORTING_UI */.Ed)
+    };
+  }
+
   /**
    * Returns the prefetch/preload dimensions for this preview session. Only attached to
    * the load event, preview_preload_outcome counter, and preview_error — exactly one
@@ -56877,7 +56958,7 @@ class Preview extends (events_default()) {
    * @return {Object} Headers
    */
   getRequestHeaders(token) {
-    const isDash = lib_Browser.canPlayDash() && !this.disabledViewers.Dash;
+    const isDash = this.canUseDash();
     let videoHint = isDash ? constants/* X_REP_HINT_VIDEO_DASH */.yF : constants/* X_REP_HINT_VIDEO_MP4 */.Zg;
     if (isDash && isFeatureEnabled(this.options.features, constants/* AI_TRANSCRIPTION_FOR_VIDEO_SUBTITLES */.Iu)) {
       videoHint += constants/* X_REP_HINT_VIDEO_DASH_EXTRACTED_TEXT */.xU;
@@ -57155,8 +57236,10 @@ class Preview extends (events_default()) {
     return (0,util/* getProp */.GT)(this.previewOptions, `fileOptions.${fileId}.${optionName}`);
   }
 }
-globalThis.Box = globalThis.Box || {};
-globalThis.Box.Preview = Preview;
+if (!IS_NPM_BUILD) {
+  globalThis.Box = globalThis.Box || {};
+  globalThis.Box.Preview = Preview;
+}
 /* harmony default export */ const lib_Preview = (Preview);
 ;// ./src/index.ts
 // useNpmPdfjs is auto-injected by Preview.show() under __BCP_NPM_BUILD__.

package/package.json

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