@atlaskit/media-viewer 54.8.21 → 54.8.23

package/CHANGELOG.md

@@ -1,5 +1,83 @@
 # @atlaskit/media-viewer
 
+## 54.8.23
+
+### Patch Changes
+
+- [`bffd2c37b0e17`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bffd2c37b0e17) -
+  Apply the Volt one-export-per-file standard via `volt-migrate-package` to
+  `@atlaskit/media-viewer`. The bump is **patch** because the public API is unchanged: the package
+  `exports` map is **unchanged** — all 5 public subpaths (`.`, `./classnames`,
+  `./media-viewer-loader`, `./types`, `./viewer-options`) keep their existing targets and expose
+  exactly the same symbols as before. The split moved internal multi-export modules into one module
+  per export; because none of the affected symbols were reachable through the `exports` map, no new
+  re-export shims were needed.
+
+  ### No public API was removed
+
+  Every existing import keeps working:
+
+  ```ts
+  import { MediaViewer } from '@atlaskit/media-viewer';
+  import AsyncMediaViewer from '@atlaskit/media-viewer/media-viewer-loader';
+  import type { MediaViewerExtensions } from '@atlaskit/media-viewer/types';
+  ```
+
+  ### The root barrel is now marked `@deprecated`
+
+  Everything the root entry point (`@atlaskit/media-viewer`) re-exports is also available from a
+  dedicated subpath, so each of its three re-exports now carries a `@deprecated` marker pointing at
+  that subpath. Nothing is removed and no behaviour changes — you will just see a deprecation hint
+  in your editor. VOLTC-139 tracks removing the shims. Prefer:
+
+  ```ts
+  // instead of `import { MediaViewer } from '@atlaskit/media-viewer'`
+  import MediaViewer from '@atlaskit/media-viewer/media-viewer-loader';
+  // instead of `import type { MediaViewerProps } from '@atlaskit/media-viewer'`
+  import type { MediaViewerProps } from '@atlaskit/media-viewer/types';
+  // instead of `import type { ViewerOptionsProps } from '@atlaskit/media-viewer'`
+  import type { ViewerOptionsProps } from '@atlaskit/media-viewer/viewer-options';
+  ```
+
+  ### Note for consumers that mock these modules
+
+  The split deleted three private barrels and hollowed out several internal modules, so a
+  `jest.mock()` or `jest.spyOn()` aimed at one of them will silently stop intercepting. None of
+  these paths are reachable through the `exports` map, but deep-path mocks in downstream tests do
+  reach them. Mock the module that now owns the export instead:
+  - `src/domain/index.tsx` (deleted) — `Outcome` → `domain/outcome`.
+  - `src/utils/index.ts` (deleted) — each helper now owns a module under `utils/`:
+    `isSameIdentifier`, `getSelectedIndex`, `getMediaTypeFromFilename`, `getMimeTypeFromFilename`,
+    `getFolderParent`, `extractArchiveFolderName`, `getFormattedFolderName`, `isMacPrivateFile`,
+    `rejectAfter`.
+  - `src/viewers/svg/utils.ts` (deleted) — `clientRectangle` → `viewers/svg/clientRectangle`,
+    `naturalSizeRectangle` → `viewers/svg/naturalSizeRectangle`, `zoomLevelAfterResize` →
+    `viewers/svg/zoomLevelAfterResize`.
+  - `src/errors.ts` is now types-only (`PrimaryErrorReason`, `SecondaryErrorReason`). Its runtime
+    exports moved out: `MediaViewerError` → `MediaViewerError`, `ArchiveViewerError` →
+    `ArchiveViewerError`, `isMediaViewerError` / `isArchiveViewerError` / `getPrimaryErrorReason` /
+    `getSecondaryErrorReason` / `getErrorDetail` / `getRequestMetadata` / `classifyFailedSrc` /
+    `buildImgErrorDiagnostics` / `buildVideoErrorDiagnostics` → one module each.
+  - `src/analytics/index.ts` is now types-only (`MediaViewerFailureAttributes`) — `fireAnalytics` →
+    `analytics/fireAnalytics`, `getFileAttributes` → `analytics/getFileAttributes`.
+  - `src/download.tsx` now only holds `DisabledToolbarDownloadButton` — `ToolbarDownloadButton` →
+    `ToolbarDownloadButton`, `ErrorViewDownloadButton` → `ErrorViewDownloadButton`. The previously
+    module-private `DownloadItem` and `DownloadButton` also each own a module now.
+  - `src/components/media-viewer.tsx` (renamed, see below) — `MediaViewerWithMediaClient` →
+    `components/media-viewer-with-media-client`, `MediaViewerBase` → `components/media-viewer-base`.
+
+  ### Internal-only renames
+  - `src/components/media-viewer.tsx` → `src/components/media-viewer-base.tsx`
+  - `src/viewers/codeViewer/msg-parser.ts` → `src/viewers/codeViewer/msgToText.ts`
+
+  None of these paths are reachable through the `exports` map. No behaviour change.
+
+## 54.8.22
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 54.8.21
 
 ### Patch Changes

package/dist/cjs/ArchiveViewerError.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ArchiveViewerError = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _MediaViewerError2 = require("./MediaViewerError");
+function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var ArchiveViewerError = exports.ArchiveViewerError = /*#__PURE__*/function (_MediaViewerError) {
+  function ArchiveViewerError(primaryReason, secondaryError, zipEntry) {
+    var _this;
+    (0, _classCallCheck2.default)(this, ArchiveViewerError);
+    _this = _callSuper(this, ArchiveViewerError, [primaryReason, secondaryError]);
+    _this.primaryReason = primaryReason;
+    _this.secondaryError = secondaryError;
+    _this.zipEntry = zipEntry;
+    return _this;
+  }
+  (0, _inherits2.default)(ArchiveViewerError, _MediaViewerError);
+  return (0, _createClass2.default)(ArchiveViewerError);
+}(_MediaViewerError2.MediaViewerError);

package/dist/cjs/DownloadButton.js

@@ -0,0 +1,39 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DownloadButton = DownloadButton;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireWildcard(require("react"));
+var _useAnalyticsEvents2 = require("@atlaskit/analytics-next/useAnalyticsEvents");
+var _MediaButton = _interopRequireDefault(require("@atlaskit/media-ui/MediaButton"));
+var _Tooltip = _interopRequireDefault(require("@atlaskit/tooltip/Tooltip"));
+var _fireAnalytics = require("./analytics/fireAnalytics");
+var _noop = require("./noop");
+var _excluded = ["analyticspayload", "onClick", "tooltip"];
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+function DownloadButton(_ref) {
+  var analyticspayload = _ref.analyticspayload,
+    _ref$onClick = _ref.onClick,
+    providedOnClick = _ref$onClick === void 0 ? _noop.noop : _ref$onClick,
+    tooltip = _ref.tooltip,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var _useAnalyticsEvents = (0, _useAnalyticsEvents2.useAnalyticsEvents)(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  var onClick = (0, _react.useCallback)(function (event, analyticsEvent) {
+    (0, _fireAnalytics.fireAnalytics)(analyticspayload, createAnalyticsEvent);
+    providedOnClick(event, analyticsEvent);
+  }, [analyticspayload, providedOnClick, createAnalyticsEvent]);
+  var downloadButton = /*#__PURE__*/_react.default.createElement(_MediaButton.default, (0, _extends2.default)({}, rest, {
+    onClick: onClick
+  }));
+  return tooltip ? /*#__PURE__*/_react.default.createElement(_Tooltip.default, {
+    content: tooltip,
+    position: "bottom",
+    tag: "span"
+  }, downloadButton) : downloadButton;
+}

package/dist/cjs/DownloadButtonProps.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/DownloadItem.js

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DownloadItem = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = _interopRequireWildcard(require("react"));
+var _useAnalyticsEvents2 = require("@atlaskit/analytics-next/useAnalyticsEvents");
+var _mediaClient = require("@atlaskit/media-client");
+var _abuseModal = require("@atlaskit/media-ui/abuseModal");
+var _createItemDownloader = require("./createItemDownloader");
+var _DownloadButton = require("./DownloadButton");
+var _useDownloadButtonDisabledProps = require("./useDownloadButtonDisabledProps");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+var DownloadItem = exports.DownloadItem = function DownloadItem(_ref) {
+  var testId = _ref.testId,
+    fileState = _ref.fileState,
+    mediaClient = _ref.mediaClient,
+    collectionName = _ref.collectionName,
+    appearance = _ref.appearance,
+    analyticspayload = _ref.analyticspayload,
+    traceContext = _ref.traceContext,
+    iconBefore = _ref.iconBefore,
+    children = _ref.children,
+    fallbackMediaName = _ref.fallbackMediaName;
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isAbuseModalOpen = _useState2[0],
+    setIsAbuseModalOpen = _useState2[1];
+  var _useAnalyticsEvents = (0, _useAnalyticsEvents2.useAnalyticsEvents)(),
+    createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
+  var _useDownloadButtonDis = (0, _useDownloadButtonDisabledProps.useDownloadButtonDisabledProps)(mediaClient),
+    isDisabled = _useDownloadButtonDis.isDisabled,
+    tooltip = _useDownloadButtonDis.tooltip;
+  var shouldRenderAbuseModal = !(0, _mediaClient.isErrorFileState)(fileState) && !!fileState.abuseClassification;
+  var itemDownloader = (0, _createItemDownloader.createItemDownloader)(fileState, mediaClient, {
+    collectionName: collectionName,
+    createAnalyticsEvent: createAnalyticsEvent,
+    traceContext: traceContext,
+    fallbackMediaName: fallbackMediaName
+  });
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, shouldRenderAbuseModal && /*#__PURE__*/_react.default.createElement(_abuseModal.AbuseModal, {
+    isOpen: isAbuseModalOpen,
+    onConfirm: itemDownloader,
+    onClose: function onClose() {
+      return setIsAbuseModalOpen(false);
+    }
+  }), /*#__PURE__*/_react.default.createElement(_DownloadButton.DownloadButton, {
+    testId: testId,
+    appearance: appearance,
+    analyticspayload: analyticspayload,
+    isDisabled: isDisabled,
+    tooltip: tooltip,
+    onClick: function onClick() {
+      if (shouldRenderAbuseModal) {
+        setIsAbuseModalOpen(true);
+      } else {
+        itemDownloader();
+      }
+    },
+    iconBefore: iconBefore
+  }, children));
+};

package/dist/cjs/DownloadItemProps.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/ErrorViewDownloadButton.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ErrorViewDownloadButton = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _reactIntl = require("react-intl");
+var _messages = require("@atlaskit/media-ui/messages");
+var _DownloadItem = require("./DownloadItem");
+var _failedPreviewDownloadButtonClicked = require("./analytics/events/ui/failedPreviewDownloadButtonClicked");
+var _styleWrappers = require("./styleWrappers");
+var ErrorViewDownloadButton = exports.ErrorViewDownloadButton = function ErrorViewDownloadButton(_ref) {
+  var fileState = _ref.fileState,
+    mediaClient = _ref.mediaClient,
+    error = _ref.error,
+    traceContext = _ref.traceContext,
+    collectionName = _ref.collectionName;
+  var downloadEvent = (0, _failedPreviewDownloadButtonClicked.createFailedPreviewDownloadButtonClickedEvent)(fileState, error);
+  var testId = 'media-viewer-error-download-button';
+  return /*#__PURE__*/_react.default.createElement(_styleWrappers.DownloadButtonWrapper, null, /*#__PURE__*/_react.default.createElement(_DownloadItem.DownloadItem, {
+    testId: testId,
+    analyticspayload: downloadEvent,
+    appearance: "primary",
+    fileState: fileState,
+    mediaClient: mediaClient,
+    collectionName: collectionName,
+    traceContext: traceContext
+  }, /*#__PURE__*/_react.default.createElement(_reactIntl.FormattedMessage, _messages.messages.download)));
+};