@atlaskit/media-common 8.2.0 → 9.0.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/media-common
 
+## 9.0.1
+
+### Patch Changes
+
+- [`ec4867e1376`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ec4867e1376) - Removed captions flag and replaced with a new media prop `allowCaptions`. `allowCaptions` is set to `false` by default and products will need to opt in to be able to use captions from now on.
+
+## 9.0.0
+
+### Major Changes
+
+- [`7b6a2c6671b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7b6a2c6671b) - Introducing 'media-state' for handling media internal file state.
+  Introducing 'media-client-react' to provide hooks for seamless media-client integration with React.
+  Introducing 'MediaCardV2' with a feature flag to replace rxjs based fileState subscription with 'useFileState' hook.
+  Removed unused feature flags APIs from 'media-client' and its helper functions from 'media-common'.
+
 ## 8.2.0
 
 ### Minor Changes

package/dist/cjs/index.js

@@ -9,12 +9,6 @@ Object.defineProperty(exports, "ANALYTICS_MEDIA_CHANNEL", {
     return _constants.ANALYTICS_MEDIA_CHANNEL;
   }
 });
-Object.defineProperty(exports, "areEqualFeatureFlags", {
-  enumerable: true,
-  get: function get() {
-    return _mediaFeatureFlags.areEqualFeatureFlags;
-  }
-});
 Object.defineProperty(exports, "debounce", {
   enumerable: true,
   get: function get() {
@@ -147,12 +141,6 @@ Object.defineProperty(exports, "pick", {
     return _helpers.pick;
   }
 });
-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/index.js

@@ -3,12 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "areEqualFeatureFlags", {
-  enumerable: true,
-  get: function get() {
-    return _mediaFeatureFlags.areEqualFeatureFlags;
-  }
-});
 Object.defineProperty(exports, "defaultMediaFeatureFlags", {
   enumerable: true,
   get: function get() {
@@ -33,10 +27,4 @@ Object.defineProperty(exports, "getMediaFeatureFlag", {
     return _mediaFeatureFlags.getMediaFeatureFlag;
   }
 });
-Object.defineProperty(exports, "useMemoizeFeatureFlags", {
-  enumerable: true,
-  get: function get() {
-    return _mediaFeatureFlags.useMemoizeFeatureFlags;
-  }
-});
 var _mediaFeatureFlags = require("./mediaFeatureFlags");

package/dist/cjs/mediaFeatureFlags/mediaFeatureFlags.js

@@ -4,33 +4,13 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getFeatureFlagKeysAllProducts = exports.filterFeatureFlagNames = exports.defaultMediaFeatureFlags = exports.areEqualFeatureFlags = void 0;
+exports.getFeatureFlagKeysAllProducts = exports.filterFeatureFlagNames = exports.defaultMediaFeatureFlags = void 0;
 exports.getMediaFeatureFlag = getMediaFeatureFlag;
-exports.useMemoizeFeatureFlags = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _react = require("react");
 var _types = require("./types");
 var _productKeys = require("./productKeys");
 var _genericFeatureFlag = require("./genericFeatureFlag");
-var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
-  if (!ffA && !ffB) {
-    return true;
-  }
-  if (!ffA || !ffB) {
-    return false;
-  }
-  var results = {
-    captions: ffA.captions === ffB.captions,
-    mediaInline: ffA.mediaInline === ffB.mediaInline,
-    folderUploads: ffA.folderUploads === ffB.folderUploads,
-    securedClipboard: ffA.securedClipboard === ffB.securedClipboard
-  };
-  return Object.values(results).every(function (result) {
-    return result;
-  });
-};
-exports.areEqualFeatureFlags = areEqualFeatureFlags;
 var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {
   var pairs = Object.entries(flags);
   return pairs.filter(function (_ref) {
@@ -96,12 +76,4 @@ var defaultMediaFeatureFlags = {
 exports.defaultMediaFeatureFlags = defaultMediaFeatureFlags;
 function getMediaFeatureFlag(flagName, featureFlags) {
   return (0, _genericFeatureFlag.getGenericFeatureFlag)(flagName, defaultMediaFeatureFlags, featureFlags);
-}
-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/es2019/index.js

@@ -2,7 +2,7 @@ export { downloadUrl } from './downloadUrl';
 // Warning! You can't add new media types!
 // See packages/media/media-core/src/__tests__/cache-backward-compatibility.spec.ts
 // Media Feature Flags
-export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';
 
 // TODO EDM-689 Please, consolidate these two CardDimensions types
 

package/dist/es2019/mediaFeatureFlags/index.js

@@ -1 +1 @@
-export { getMediaFeatureFlag, useMemoizeFeatureFlags, defaultMediaFeatureFlags, areEqualFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';

package/dist/es2019/mediaFeatureFlags/mediaFeatureFlags.js

@@ -1,22 +1,6 @@
-import { useRef } from 'react';
 import { supportedProducts } from './types';
 import { getProductKeys } from './productKeys';
 import { getGenericFeatureFlag } from './genericFeatureFlag';
-export const areEqualFeatureFlags = (ffA, ffB) => {
-  if (!ffA && !ffB) {
-    return true;
-  }
-  if (!ffA || !ffB) {
-    return false;
-  }
-  const results = {
-    captions: ffA.captions === ffB.captions,
-    mediaInline: ffA.mediaInline === ffB.mediaInline,
-    folderUploads: ffA.folderUploads === ffB.folderUploads,
-    securedClipboard: ffA.securedClipboard === ffB.securedClipboard
-  };
-  return Object.values(results).every(result => result);
-};
 export const filterFeatureFlagNames = flags => {
   const pairs = Object.entries(flags);
   return pairs.filter(([_key, value]) => !!value).map(([key]) => key);
@@ -68,11 +52,4 @@ export const defaultMediaFeatureFlags = {
  * */
 export function getMediaFeatureFlag(flagName, featureFlags) {
   return getGenericFeatureFlag(flagName, defaultMediaFeatureFlags, featureFlags);
-}
-export const useMemoizeFeatureFlags = featureFlags => {
-  const ref = useRef();
-  if (!areEqualFeatureFlags(featureFlags, ref.current)) {
-    ref.current = featureFlags;
-  }
-  return ref.current;
-};
+}

package/dist/esm/index.js

@@ -2,7 +2,7 @@ export { downloadUrl } from './downloadUrl';
 // Warning! You can't add new media types!
 // See packages/media/media-core/src/__tests__/cache-backward-compatibility.spec.ts
 // Media Feature Flags
-export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';
 
 // TODO EDM-689 Please, consolidate these two CardDimensions types
 

package/dist/esm/mediaFeatureFlags/index.js

@@ -1 +1 @@
-export { getMediaFeatureFlag, useMemoizeFeatureFlags, defaultMediaFeatureFlags, areEqualFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts } from './mediaFeatureFlags';

package/dist/esm/mediaFeatureFlags/mediaFeatureFlags.js

@@ -1,26 +1,8 @@
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import { useRef } from 'react';
 import { supportedProducts } from './types';
 import { getProductKeys } from './productKeys';
 import { getGenericFeatureFlag } from './genericFeatureFlag';
-export var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
-  if (!ffA && !ffB) {
-    return true;
-  }
-  if (!ffA || !ffB) {
-    return false;
-  }
-  var results = {
-    captions: ffA.captions === ffB.captions,
-    mediaInline: ffA.mediaInline === ffB.mediaInline,
-    folderUploads: ffA.folderUploads === ffB.folderUploads,
-    securedClipboard: ffA.securedClipboard === ffB.securedClipboard
-  };
-  return Object.values(results).every(function (result) {
-    return result;
-  });
-};
 export var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {
   var pairs = Object.entries(flags);
   return pairs.filter(function (_ref) {
@@ -83,11 +65,4 @@ export var defaultMediaFeatureFlags = {
  * */
 export function getMediaFeatureFlag(flagName, featureFlags) {
   return getGenericFeatureFlag(flagName, defaultMediaFeatureFlags, featureFlags);
-}
-export var useMemoizeFeatureFlags = function useMemoizeFeatureFlags(featureFlags) {
-  var ref = useRef();
-  if (!areEqualFeatureFlags(featureFlags, ref.current)) {
-    ref.current = featureFlags;
-  }
-  return ref.current;
-};
+}

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
 export { downloadUrl } from './downloadUrl';
 export type MediaType = 'doc' | 'audio' | 'video' | 'image' | 'archive' | 'unknown';
 export type FileStatus = 'uploading' | 'processing' | 'processed' | 'error' | 'failed-processing';
-export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
 export type { MediaFeatureFlags, WithMediaFeatureFlags, } from './mediaFeatureFlags';
 export interface NumericalCardDimensions {
     width: number;

package/dist/types/mediaFeatureFlags/index.d.ts

@@ -1,2 +1,2 @@
-export { getMediaFeatureFlag, useMemoizeFeatureFlags, defaultMediaFeatureFlags, areEqualFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
 export type { MediaFeatureFlags, WithMediaFeatureFlags, SupportedProduct, } from './types';

package/dist/types/mediaFeatureFlags/mediaFeatureFlags.d.ts

@@ -1,5 +1,4 @@
 import { RequiredMediaFeatureFlags, MediaFeatureFlags } from './types';
-export declare const areEqualFeatureFlags: (ffA?: MediaFeatureFlags, ffB?: MediaFeatureFlags) => boolean;
 export declare const filterFeatureFlagNames: (flags: RequiredMediaFeatureFlags) => Array<keyof MediaFeatureFlags>;
 /**
  * Takes a record of {Media Feature Flag Names → boolean}.
@@ -29,4 +28,3 @@ 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 useMemoizeFeatureFlags: (featureFlags?: MediaFeatureFlags) => MediaFeatureFlags | undefined;

package/dist/types/mediaFeatureFlags/types.d.ts

@@ -1,4 +1,8 @@
 export interface MediaFeatureFlags {
+    /**
+     * @private
+     * @deprecated Use media option `allowCaptions` instead.
+     */
     captions?: boolean;
     mediaInline?: boolean;
     folderUploads?: boolean;

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

@@ -1,7 +1,7 @@
 export { downloadUrl } from './downloadUrl';
 export type MediaType = 'doc' | 'audio' | 'video' | 'image' | 'archive' | 'unknown';
 export type FileStatus = 'uploading' | 'processing' | 'processed' | 'error' | 'failed-processing';
-export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
 export type { MediaFeatureFlags, WithMediaFeatureFlags, } from './mediaFeatureFlags';
 export interface NumericalCardDimensions {
     width: number;

package/dist/types-ts4.5/mediaFeatureFlags/index.d.ts

@@ -1,2 +1,2 @@
-export { getMediaFeatureFlag, useMemoizeFeatureFlags, defaultMediaFeatureFlags, areEqualFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, filterFeatureFlagNames, getFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
 export type { MediaFeatureFlags, WithMediaFeatureFlags, SupportedProduct, } from './types';

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

@@ -1,5 +1,4 @@
 import { RequiredMediaFeatureFlags, MediaFeatureFlags } from './types';
-export declare const areEqualFeatureFlags: (ffA?: MediaFeatureFlags, ffB?: MediaFeatureFlags) => boolean;
 export declare const filterFeatureFlagNames: (flags: RequiredMediaFeatureFlags) => Array<keyof MediaFeatureFlags>;
 /**
  * Takes a record of {Media Feature Flag Names → boolean}.
@@ -29,4 +28,3 @@ 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 useMemoizeFeatureFlags: (featureFlags?: MediaFeatureFlags) => MediaFeatureFlags | undefined;

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

@@ -1,4 +1,8 @@
 export interface MediaFeatureFlags {
+    /**
+     * @private
+     * @deprecated Use media option `allowCaptions` instead.
+     */
     captions?: boolean;
     mediaInline?: boolean;
     folderUploads?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-common",
-  "version": "8.2.0",
+  "version": "9.0.1",
   "description": "Includes common utilities used by other media packages",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -21,12 +21,6 @@ import { default as React_2 } from 'react';
 // @public (undocumented)
 export const ANALYTICS_MEDIA_CHANNEL = 'media';
 
-// @public (undocumented)
-export const areEqualFeatureFlags: (
-  ffA?: MediaFeatureFlags,
-  ffB?: MediaFeatureFlags,
-) => boolean;
-
 // @public (undocumented)
 type BaseAttributes = {};
 
@@ -148,7 +142,7 @@ export const matches: (srcObj: Object) => (obj: Object) => boolean;
 
 // @public (undocumented)
 export interface MediaFeatureFlags {
-  // (undocumented)
+  // @deprecated (undocumented)
   captions?: boolean;
   // (undocumented)
   folderUploads?: boolean;
@@ -305,11 +299,6 @@ export type UIEventPayload<
   actionSubjectId?: string;
 };
 
-// @public (undocumented)
-export const useMemoizeFeatureFlags: (
-  featureFlags?: MediaFeatureFlags,
-) => MediaFeatureFlags | undefined;
-
 // @public (undocumented)
 export type WithFileAttributes = {
   fileAttributes: FileAttributes;

package/tmp/api-report-tmp.d.ts

@@ -10,9 +10,6 @@ import { default as React_2 } from 'react';
 // @public (undocumented)
 export const ANALYTICS_MEDIA_CHANNEL = "media";
 
-// @public (undocumented)
-export const areEqualFeatureFlags: (ffA?: MediaFeatureFlags, ffB?: MediaFeatureFlags) => boolean;
-
 // @public (undocumented)
 type BaseAttributes = {};
 
@@ -116,7 +113,7 @@ export const matches: (srcObj: Object) => (obj: Object) => boolean;
 
 // @public (undocumented)
 export interface MediaFeatureFlags {
-    // (undocumented)
+    // @deprecated (undocumented)
     captions?: boolean;
     // (undocumented)
     folderUploads?: boolean;
@@ -227,9 +224,6 @@ export type UIEventPayload<Attributes extends UIAttributes, Action extends strin
     actionSubjectId?: string;
 };
 
-// @public (undocumented)
-export const useMemoizeFeatureFlags: (featureFlags?: MediaFeatureFlags) => MediaFeatureFlags | undefined;
-
 // @public (undocumented)
 export type WithFileAttributes = {
     fileAttributes: FileAttributes;