@atlaskit/media-common 2.9.1 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/media-common
 
+## 2.10.0
+
+### Minor Changes
+
+- [`f461edcfd05`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f461edcfd05) - Added a comparer helper for Media Feature Flags objects
+
+### Patch Changes
+
+- [`fc70978492a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fc70978492a) - Using type for SSR prop to reduce dependency on media-common
+- [`2b24fcc59f2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2b24fcc59f2) - Removed Code Viewer and Zip Previews Feature Flags
+- [`f461edcfd05`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f461edcfd05) - Update CardLoader to use react-loadable
+  Add SSR feature prop to be passed in renderer and media card
+- [`01a41e75803`](https://bitbucket.org/atlassian/atlassian-frontend/commits/01a41e75803) - Removes `allowMediaInline` media prop and replaces with Inline Files feature flag for editor and mobile bridge
+
 ## 2.9.1
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -21,6 +21,18 @@ Object.defineProperty(exports, "defaultMediaFeatureFlags", {
     return _mediaFeatureFlags.defaultMediaFeatureFlags;
   }
 });
+Object.defineProperty(exports, "areEqualFeatureFlags", {
+  enumerable: true,
+  get: function get() {
+    return _mediaFeatureFlags.areEqualFeatureFlags;
+  }
+});
+Object.defineProperty(exports, "useMemoizeFeatureFlags", {
+  enumerable: true,
+  get: function get() {
+    return _mediaFeatureFlags.useMemoizeFeatureFlags;
+  }
+});
 Object.defineProperty(exports, "withMediaAnalyticsContext", {
   enumerable: true,
   get: function get() {

package/dist/cjs/mediaFeatureFlags.js

@@ -4,17 +4,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getMediaFeatureFlag = getMediaFeatureFlag;
-exports.defaultMediaFeatureFlags = void 0;
+exports.useMemoizeFeatureFlags = exports.areEqualFeatureFlags = exports.defaultMediaFeatureFlags = void 0;
+
+var _react = require("react");
 
 var _mediaFeatureFlagLocal = require("./mediaFeatureFlag-local");
 
 // default values defined here, not necessary for components to know directly as they should use the function below
 var defaultMediaFeatureFlags = {
   newCardExperience: false,
-  zipPreviews: false,
   captions: false,
-  folderUploads: false,
-  codeViewer: false
+  mediaInline: false,
+  // We can't yet switch this feature on
+  // TODO https://product-fabric.atlassian.net/browse/MEX-104
+  folderUploads: false
 };
 /**
  * Public accessor from components to fallback to defaults if flags not passed,
@@ -56,4 +59,39 @@ Object.keys(defaultMediaFeatureFlags).forEach(function (flagName) {
     // eslint-disable-next-line no-console
     console.info("%c* LOCAL * MediaFeatureFlag.".concat(flagName, " = ").concat(localOverride), 'font-weight:bold;color:cyan');
   }
-});
+});
+
+var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
+  if (!ffA && !ffB) {
+    return true;
+  }
+
+  if (!ffA || !ffB) {
+    return false;
+  } // With this type we ensure this object will compare all the flags
+
+
+  var results = {
+    newCardExperience: ffA.newCardExperience === ffB.newCardExperience,
+    captions: ffA.captions === ffB.captions,
+    mediaInline: ffA.mediaInline === ffB.mediaInline,
+    folderUploads: ffA.folderUploads === ffB.folderUploads
+  };
+  return Object.values(results).every(function (result) {
+    return result;
+  });
+};
+
+exports.areEqualFeatureFlags = areEqualFeatureFlags;
+
+var useMemoizeFeatureFlags = function useMemoizeFeatureFlags(featureFlags) {
+  var ref = (0, _react.useRef)();
+
+  if (!areEqualFeatureFlags(featureFlags, ref.current)) {
+    ref.current = featureFlags;
+  }
+
+  return ref.current;
+};
+
+exports.useMemoizeFeatureFlags = useMemoizeFeatureFlags;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/media-common",
-	"version": "2.9.1",
+	"version": "2.10.0",
 	"sideEffects": false
 }

package/dist/es2019/index.js

@@ -2,7 +2,7 @@ export { downloadUrl } from './downloadUrl'; // Warning! You can't add new media
 // See packages/media/media-core/src/__tests__/cache-backward-compatibility.spec.ts
 
 // Media Feature Flags
-export { getMediaFeatureFlag, defaultMediaFeatureFlags } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags } from './mediaFeatureFlags';
 // Analytics context
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext'; // Analytics constants
 

package/dist/es2019/mediaFeatureFlags.js

@@ -1,12 +1,14 @@
+import { useRef } from 'react';
 import { getLocalMediaFeatureFlag } from './mediaFeatureFlag-local'; // Media feature flags - type and defaults defined here in one source of truth
 
 // default values defined here, not necessary for components to know directly as they should use the function below
 export const defaultMediaFeatureFlags = {
   newCardExperience: false,
-  zipPreviews: false,
   captions: false,
-  folderUploads: false,
-  codeViewer: false
+  mediaInline: false,
+  // We can't yet switch this feature on
+  // TODO https://product-fabric.atlassian.net/browse/MEX-104
+  folderUploads: false
 };
 /**
  * Public accessor from components to fallback to defaults if flags not passed,
@@ -45,4 +47,31 @@ Object.keys(defaultMediaFeatureFlags).forEach(flagName => {
     // eslint-disable-next-line no-console
     console.info(`%c* LOCAL * MediaFeatureFlag.${flagName} = ${localOverride}`, 'font-weight:bold;color:cyan');
   }
-});
+});
+export const areEqualFeatureFlags = (ffA, ffB) => {
+  if (!ffA && !ffB) {
+    return true;
+  }
+
+  if (!ffA || !ffB) {
+    return false;
+  } // With this type we ensure this object will compare all the flags
+
+
+  const results = {
+    newCardExperience: ffA.newCardExperience === ffB.newCardExperience,
+    captions: ffA.captions === ffB.captions,
+    mediaInline: ffA.mediaInline === ffB.mediaInline,
+    folderUploads: ffA.folderUploads === ffB.folderUploads
+  };
+  return Object.values(results).every(result => result);
+};
+export const useMemoizeFeatureFlags = featureFlags => {
+  const ref = useRef();
+
+  if (!areEqualFeatureFlags(featureFlags, ref.current)) {
+    ref.current = featureFlags;
+  }
+
+  return ref.current;
+};

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/media-common",
-	"version": "2.9.1",
+	"version": "2.10.0",
 	"sideEffects": false
 }

package/dist/esm/index.js

@@ -2,7 +2,7 @@ export { downloadUrl } from './downloadUrl'; // Warning! You can't add new media
 // See packages/media/media-core/src/__tests__/cache-backward-compatibility.spec.ts
 
 // Media Feature Flags
-export { getMediaFeatureFlag, defaultMediaFeatureFlags } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags } from './mediaFeatureFlags';
 // Analytics context
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext'; // Analytics constants
 

package/dist/esm/mediaFeatureFlags.js

@@ -1,12 +1,14 @@
+import { useRef } from 'react';
 import { getLocalMediaFeatureFlag } from './mediaFeatureFlag-local'; // Media feature flags - type and defaults defined here in one source of truth
 
 // default values defined here, not necessary for components to know directly as they should use the function below
 export var defaultMediaFeatureFlags = {
   newCardExperience: false,
-  zipPreviews: false,
   captions: false,
-  folderUploads: false,
-  codeViewer: false
+  mediaInline: false,
+  // We can't yet switch this feature on
+  // TODO https://product-fabric.atlassian.net/browse/MEX-104
+  folderUploads: false
 };
 /**
  * Public accessor from components to fallback to defaults if flags not passed,
@@ -45,4 +47,33 @@ Object.keys(defaultMediaFeatureFlags).forEach(function (flagName) {
     // eslint-disable-next-line no-console
     console.info("%c* LOCAL * MediaFeatureFlag.".concat(flagName, " = ").concat(localOverride), 'font-weight:bold;color:cyan');
   }
-});
+});
+export var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
+  if (!ffA && !ffB) {
+    return true;
+  }
+
+  if (!ffA || !ffB) {
+    return false;
+  } // With this type we ensure this object will compare all the flags
+
+
+  var results = {
+    newCardExperience: ffA.newCardExperience === ffB.newCardExperience,
+    captions: ffA.captions === ffB.captions,
+    mediaInline: ffA.mediaInline === ffB.mediaInline,
+    folderUploads: ffA.folderUploads === ffB.folderUploads
+  };
+  return Object.values(results).every(function (result) {
+    return result;
+  });
+};
+export var useMemoizeFeatureFlags = function useMemoizeFeatureFlags(featureFlags) {
+  var ref = useRef();
+
+  if (!areEqualFeatureFlags(featureFlags, ref.current)) {
+    ref.current = featureFlags;
+  }
+
+  return ref.current;
+};

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/media-common",
-	"version": "2.9.1",
+	"version": "2.10.0",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
 export { downloadUrl } from './downloadUrl';
 export declare type MediaType = 'doc' | 'audio' | 'video' | 'image' | 'archive' | 'unknown';
 export declare type FileStatus = 'uploading' | 'processing' | 'processed' | 'error' | 'failed-processing';
-export { getMediaFeatureFlag, defaultMediaFeatureFlags, } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, } from './mediaFeatureFlags';
 export type { MediaFeatureFlags, WithMediaFeatureFlags, } from './mediaFeatureFlags';
 export interface NumericalCardDimensions {
     width: number;
@@ -11,3 +11,4 @@ export type { PackageAttributes, WithFileAttributes, WithPerformanceAttributes,
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext';
 export { ANALYTICS_MEDIA_CHANNEL } from './analytics/constants';
 export { getMediaTypeFromMimeType, isImageMimeTypeSupportedByBrowser, isDocumentMimeTypeSupportedByBrowser, isMimeTypeSupportedByBrowser, isImageMimeTypeSupportedByServer, isDocumentMimeTypeSupportedByServer, isAudioMimeTypeSupportedByServer, isVideoMimeTypeSupportedByServer, isUnknownMimeTypeSupportedByServer, isMimeTypeSupportedByServer, } from './mediaTypeUtils';
+export declare type SSR = 'client' | 'server';

package/dist/types/mediaFeatureFlags.d.ts

@@ -1,9 +1,8 @@
 export interface MediaFeatureFlags {
     newCardExperience?: boolean;
-    zipPreviews?: boolean;
     captions?: boolean;
+    mediaInline?: boolean;
     folderUploads?: boolean;
-    codeViewer?: boolean;
 }
 export interface WithMediaFeatureFlags {
     featureFlags?: MediaFeatureFlags;
@@ -20,3 +19,5 @@ export declare const defaultMediaFeatureFlags: Required<MediaFeatureFlags>;
  * (you will see a warning in console if override used)
  * */
 export declare function getMediaFeatureFlag<T = boolean>(flagName: keyof MediaFeatureFlags, featureFlags?: MediaFeatureFlags): T;
+export declare const areEqualFeatureFlags: (ffA?: MediaFeatureFlags | undefined, ffB?: MediaFeatureFlags | undefined) => boolean;
+export declare const useMemoizeFeatureFlags: (featureFlags?: MediaFeatureFlags | undefined) => MediaFeatureFlags | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-common",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "description": "Includes common utilities used by other media packages",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -44,7 +44,7 @@
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
-    "@atlaskit/media-test-helpers": "^28.6.0",
+    "@atlaskit/media-test-helpers": "^28.9.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "enzyme": "^3.10.0",
     "lodash": "^4.17.15",