@atlaskit/media-file-preview 0.2.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/media-file-preview
 
+## 0.3.0
+
+### Minor Changes
+
+- [#70034](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/70034) [`0cf829b2ca1f`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0cf829b2ca1f) - Breaking: renamed return value from getScriptProps to getSsrScriptProps
+
 ## 0.2.1
 
 ### Patch Changes

package/dist/cjs/useFilePreview.js

@@ -264,10 +264,10 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
   }, [preview === null || preview === void 0 ? void 0 : preview.dataURI]);
 
   // FOR SSR
-  var getScriptProps = function getScriptProps() {
+  var getSsrScriptProps = ssr === 'server' ? function () {
     var _ssrReliabilityRef$cu;
     return (0, _globalScope.generateScriptProps)(identifier, preview === null || preview === void 0 ? void 0 : preview.dataURI, requestDimensions, ((_ssrReliabilityRef$cu = ssrReliabilityRef.current.server) === null || _ssrReliabilityRef$cu === void 0 ? void 0 : _ssrReliabilityRef$cu.status) === 'fail' ? ssrReliabilityRef.current.server : undefined);
-  };
+  } : undefined;
 
   // CXP-2723 TODO: should consider simplifying our analytics, and how
   // we might get rid of ssrReliabiltyRef from our hook
@@ -279,7 +279,7 @@ var useFilePreview = exports.useFilePreview = function useFilePreview(_ref) {
     ssrReliabilityRef: ssrReliabilityRef,
     onImageError: onImageError,
     onImageLoad: onImageLoad,
-    getScriptProps: getScriptProps
+    getSsrScriptProps: getSsrScriptProps
   };
 };
 var initialSsrReliability = {

package/dist/es2019/useFilePreview.js

@@ -15,6 +15,7 @@ export const useFilePreview = ({
   traceContext,
   skipRemote,
   mediaBlobUrlAttrs,
+  // TODO: mediaBlobUrlAttrs can be missing several values contained in the file details. The preview hook is not updating the params in the preview after the file details are available.
   allowAnimated = true,
   upscale,
   maxAge
@@ -243,10 +244,10 @@ export const useFilePreview = ({
   }, [preview === null || preview === void 0 ? void 0 : preview.dataURI]);
 
   // FOR SSR
-  const getScriptProps = () => {
+  const getSsrScriptProps = ssr === 'server' ? () => {
     var _ssrReliabilityRef$cu;
     return generateScriptProps(identifier, preview === null || preview === void 0 ? void 0 : preview.dataURI, requestDimensions, ((_ssrReliabilityRef$cu = ssrReliabilityRef.current.server) === null || _ssrReliabilityRef$cu === void 0 ? void 0 : _ssrReliabilityRef$cu.status) === 'fail' ? ssrReliabilityRef.current.server : undefined);
-  };
+  } : undefined;
 
   // CXP-2723 TODO: should consider simplifying our analytics, and how
   // we might get rid of ssrReliabiltyRef from our hook
@@ -258,7 +259,7 @@ export const useFilePreview = ({
     ssrReliabilityRef,
     onImageError,
     onImageLoad,
-    getScriptProps
+    getSsrScriptProps
   };
 };
 const initialSsrReliability = {

package/dist/esm/useFilePreview.js

@@ -257,10 +257,10 @@ export var useFilePreview = function useFilePreview(_ref) {
   }, [preview === null || preview === void 0 ? void 0 : preview.dataURI]);
 
   // FOR SSR
-  var getScriptProps = function getScriptProps() {
+  var getSsrScriptProps = ssr === 'server' ? function () {
     var _ssrReliabilityRef$cu;
     return generateScriptProps(identifier, preview === null || preview === void 0 ? void 0 : preview.dataURI, requestDimensions, ((_ssrReliabilityRef$cu = ssrReliabilityRef.current.server) === null || _ssrReliabilityRef$cu === void 0 ? void 0 : _ssrReliabilityRef$cu.status) === 'fail' ? ssrReliabilityRef.current.server : undefined);
-  };
+  } : undefined;
 
   // CXP-2723 TODO: should consider simplifying our analytics, and how
   // we might get rid of ssrReliabiltyRef from our hook
@@ -272,7 +272,7 @@ export var useFilePreview = function useFilePreview(_ref) {
     ssrReliabilityRef: ssrReliabilityRef,
     onImageError: onImageError,
     onImageLoad: onImageLoad,
-    getScriptProps: getScriptProps
+    getSsrScriptProps: getSsrScriptProps
   };
 };
 var initialSsrReliability = {

package/dist/types/useFilePreview.d.ts

@@ -35,5 +35,5 @@ export declare const useFilePreview: ({ resizeMode, identifier, ssr, dimensions,
     ssrReliabilityRef: import("react").MutableRefObject<SSRStatus>;
     onImageError: (newPreview?: MediaFilePreview) => void;
     onImageLoad: (newPreview?: MediaFilePreview) => void;
-    getScriptProps: () => import("react").ScriptHTMLAttributes<HTMLScriptElement>;
+    getSsrScriptProps: (() => import("react").ScriptHTMLAttributes<HTMLScriptElement>) | undefined;
 };

package/dist/types-ts4.5/useFilePreview.d.ts

@@ -35,5 +35,5 @@ export declare const useFilePreview: ({ resizeMode, identifier, ssr, dimensions,
     ssrReliabilityRef: import("react").MutableRefObject<SSRStatus>;
     onImageError: (newPreview?: MediaFilePreview) => void;
     onImageLoad: (newPreview?: MediaFilePreview) => void;
-    getScriptProps: () => import("react").ScriptHTMLAttributes<HTMLScriptElement>;
+    getSsrScriptProps: (() => import("react").ScriptHTMLAttributes<HTMLScriptElement>) | undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-file-preview",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A React Hook to fetch and render file previews. It's overloaded with fancy features like SSR, lazy loading, memory cache and local preview.",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -50,7 +50,7 @@
     "@af/integration-testing": "*",
     "@af/visual-regression": "*",
     "@atlaskit/media-state": "^1.0.3",
-    "@atlaskit/media-test-data": "^1.1.1",
+    "@atlaskit/media-test-data": "^1.2.0",
     "@atlaskit/section-message": "^6.4.17",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",