@atlaskit/media-common 2.10.3 → 2.12.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/media-common
 
+## 2.12.1
+
+### Patch Changes
+
+- [`cb2392f6d33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb2392f6d33) - Upgrade to TypeScript 4.2.4
+
+## 2.12.0
+
+### Minor Changes
+
+- [`bac667f95d5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bac667f95d5) - Export utility filterFeatureFlagNames and type RequiredMediaFeatureFlags
+
+## 2.11.0
+
+### Minor Changes
+
+- [`8742dbe70bd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8742dbe70bd) - MEX-1102 Removed lodash dependencies from media component and converted all to local functions (lightweight helpers)
+
 ## 2.10.3
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -15,6 +15,12 @@ Object.defineProperty(exports, "areEqualFeatureFlags", {
     return _mediaFeatureFlags.areEqualFeatureFlags;
   }
 });
+Object.defineProperty(exports, "debounce", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.debounce;
+  }
+});
 Object.defineProperty(exports, "defaultMediaFeatureFlags", {
   enumerable: true,
   get: function get() {
@@ -27,6 +33,12 @@ Object.defineProperty(exports, "downloadUrl", {
     return _downloadUrl.downloadUrl;
   }
 });
+Object.defineProperty(exports, "filterFeatureFlagNames", {
+  enumerable: true,
+  get: function get() {
+    return _mediaFeatureFlags.filterFeatureFlagNames;
+  }
+});
 Object.defineProperty(exports, "getMediaFeatureFlag", {
   enumerable: true,
   get: function get() {
@@ -81,6 +93,12 @@ Object.defineProperty(exports, "isMimeTypeSupportedByServer", {
     return _mediaTypeUtils.isMimeTypeSupportedByServer;
   }
 });
+Object.defineProperty(exports, "isUndefined", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.isUndefined;
+  }
+});
 Object.defineProperty(exports, "isUnknownMimeTypeSupportedByServer", {
   enumerable: true,
   get: function get() {
@@ -93,6 +111,24 @@ Object.defineProperty(exports, "isVideoMimeTypeSupportedByServer", {
     return _mediaTypeUtils.isVideoMimeTypeSupportedByServer;
   }
 });
+Object.defineProperty(exports, "matches", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.matches;
+  }
+});
+Object.defineProperty(exports, "omitBy", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.omitBy;
+  }
+});
+Object.defineProperty(exports, "pick", {
+  enumerable: true,
+  get: function get() {
+    return _helpers.pick;
+  }
+});
 Object.defineProperty(exports, "useMemoizeFeatureFlags", {
   enumerable: true,
   get: function get() {
@@ -114,4 +150,6 @@ var _withMediaAnalyticsContext = require("./analytics/withMediaAnalyticsContext"
 
 var _constants = require("./analytics/constants");
 
-var _mediaTypeUtils = require("./mediaTypeUtils");
+var _mediaTypeUtils = require("./mediaTypeUtils");
+
+var _helpers = require("./utils/helpers");

package/dist/cjs/mediaFeatureFlags.js

@@ -1,12 +1,16 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.defaultMediaFeatureFlags = exports.areEqualFeatureFlags = void 0;
+exports.filterFeatureFlagNames = exports.defaultMediaFeatureFlags = exports.areEqualFeatureFlags = void 0;
 exports.getMediaFeatureFlag = getMediaFeatureFlag;
 exports.useMemoizeFeatureFlags = void 0;
 
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
 var _react = require("react");
 
 var _mediaFeatureFlagLocal = require("./mediaFeatureFlag-local");
@@ -62,7 +66,7 @@ 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');
   }
-});
+}); // With this type we ensure the object will contain all the flags
 
 var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
   if (!ffA && !ffB) {
@@ -71,8 +75,7 @@ var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
 
   if (!ffA || !ffB) {
     return false;
-  } // With this type we ensure this object will compare all the flags
-
+  }
 
   var results = {
     newCardExperience: ffA.newCardExperience === ffB.newCardExperience,
@@ -99,4 +102,22 @@ var useMemoizeFeatureFlags = function useMemoizeFeatureFlags(featureFlags) {
   return ref.current;
 };
 
-exports.useMemoizeFeatureFlags = useMemoizeFeatureFlags;
+exports.useMemoizeFeatureFlags = useMemoizeFeatureFlags;
+
+var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {
+  var pairs = Object.entries(flags);
+  return pairs.filter(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+        _key = _ref2[0],
+        value = _ref2[1];
+
+    return !!value;
+  }).map(function (_ref3) {
+    var _ref4 = (0, _slicedToArray2.default)(_ref3, 1),
+        key = _ref4[0];
+
+    return key;
+  });
+};
+
+exports.filterFeatureFlagNames = filterFeatureFlagNames;

package/dist/cjs/utils/helpers.js

@@ -0,0 +1,77 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pick = exports.omitBy = exports.matches = exports.isUndefined = exports.debounce = void 0;
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var isUndefined = function isUndefined(value) {
+  return value === undefined;
+};
+
+exports.isUndefined = isUndefined;
+
+var pick = function pick(obj) {
+  var keys = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+
+  if (obj === undefined) {
+    return {};
+  }
+
+  return Object.fromEntries(Object.entries(obj).filter(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 1),
+        k = _ref2[0];
+
+    return keys.includes(k);
+  }));
+};
+
+exports.pick = pick;
+
+var omitBy = function omitBy(obj, predicate) {
+  return Object.fromEntries(Object.entries(obj).filter(function (_ref3) {
+    var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+        k = _ref4[0],
+        v = _ref4[1];
+
+    return !predicate(v);
+  }));
+};
+
+exports.omitBy = omitBy;
+
+var debounce = function debounce(func, wait) {
+  var timeout;
+  return function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    clearTimeout(timeout);
+    timeout = setTimeout(function () {
+      return func.apply(void 0, args);
+    }, wait);
+  };
+};
+
+exports.debounce = debounce;
+
+var matches = function matches(srcObj) {
+  return function (obj) {
+    var key;
+
+    for (key in srcObj) {
+      if (obj[key] === undefined || obj[key] !== srcObj[key]) {
+        return false;
+      }
+    }
+
+    return true;
+  };
+};
+
+exports.matches = matches;

package/dist/cjs/version.json

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

package/dist/es2019/index.js

@@ -2,9 +2,10 @@ 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, areEqualFeatureFlags, useMemoizeFeatureFlags } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames } from './mediaFeatureFlags';
 // Analytics context
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext'; // Analytics constants
 
 export { ANALYTICS_MEDIA_CHANNEL } from './analytics/constants';
-export { getMediaTypeFromMimeType, isImageMimeTypeSupportedByBrowser, isDocumentMimeTypeSupportedByBrowser, isMimeTypeSupportedByBrowser, isImageMimeTypeSupportedByServer, isDocumentMimeTypeSupportedByServer, isAudioMimeTypeSupportedByServer, isVideoMimeTypeSupportedByServer, isUnknownMimeTypeSupportedByServer, isMimeTypeSupportedByServer } from './mediaTypeUtils';
+export { getMediaTypeFromMimeType, isImageMimeTypeSupportedByBrowser, isDocumentMimeTypeSupportedByBrowser, isMimeTypeSupportedByBrowser, isImageMimeTypeSupportedByServer, isDocumentMimeTypeSupportedByServer, isAudioMimeTypeSupportedByServer, isVideoMimeTypeSupportedByServer, isUnknownMimeTypeSupportedByServer, isMimeTypeSupportedByServer } from './mediaTypeUtils';
+export { isUndefined, pick, omitBy, debounce, matches } from './utils/helpers';

package/dist/es2019/mediaFeatureFlags.js

@@ -49,7 +49,8 @@ Object.keys(defaultMediaFeatureFlags).forEach(flagName => {
     // eslint-disable-next-line no-console
     console.info(`%c* LOCAL * MediaFeatureFlag.${flagName} = ${localOverride}`, 'font-weight:bold;color:cyan');
   }
-});
+}); // With this type we ensure the object will contain all the flags
+
 export const areEqualFeatureFlags = (ffA, ffB) => {
   if (!ffA && !ffB) {
     return true;
@@ -57,8 +58,7 @@ export const areEqualFeatureFlags = (ffA, ffB) => {
 
   if (!ffA || !ffB) {
     return false;
-  } // With this type we ensure this object will compare all the flags
-
+  }
 
   const results = {
     newCardExperience: ffA.newCardExperience === ffB.newCardExperience,
@@ -78,4 +78,8 @@ export const useMemoizeFeatureFlags = featureFlags => {
   }
 
   return ref.current;
+};
+export const filterFeatureFlagNames = flags => {
+  const pairs = Object.entries(flags);
+  return pairs.filter(([_key, value]) => !!value).map(([key]) => key);
 };

package/dist/es2019/utils/helpers.js

@@ -0,0 +1,29 @@
+export const isUndefined = value => value === undefined;
+export const pick = (obj, keys = []) => {
+  if (obj === undefined) {
+    return {};
+  }
+
+  return Object.fromEntries(Object.entries(obj).filter(([k]) => keys.includes(k)));
+};
+export const omitBy = (obj, predicate) => Object.fromEntries(Object.entries(obj).filter(([k, v]) => !predicate(v)));
+export const debounce = (func, wait) => {
+  let timeout;
+  return (...args) => {
+    clearTimeout(timeout);
+    timeout = setTimeout(() => func(...args), wait);
+  };
+};
+export const matches = srcObj => {
+  return obj => {
+    let key;
+
+    for (key in srcObj) {
+      if (obj[key] === undefined || obj[key] !== srcObj[key]) {
+        return false;
+      }
+    }
+
+    return true;
+  };
+};

package/dist/es2019/version.json

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

package/dist/esm/index.js

@@ -2,9 +2,10 @@ 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, areEqualFeatureFlags, useMemoizeFeatureFlags } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames } from './mediaFeatureFlags';
 // Analytics context
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext'; // Analytics constants
 
 export { ANALYTICS_MEDIA_CHANNEL } from './analytics/constants';
-export { getMediaTypeFromMimeType, isImageMimeTypeSupportedByBrowser, isDocumentMimeTypeSupportedByBrowser, isMimeTypeSupportedByBrowser, isImageMimeTypeSupportedByServer, isDocumentMimeTypeSupportedByServer, isAudioMimeTypeSupportedByServer, isVideoMimeTypeSupportedByServer, isUnknownMimeTypeSupportedByServer, isMimeTypeSupportedByServer } from './mediaTypeUtils';
+export { getMediaTypeFromMimeType, isImageMimeTypeSupportedByBrowser, isDocumentMimeTypeSupportedByBrowser, isMimeTypeSupportedByBrowser, isImageMimeTypeSupportedByServer, isDocumentMimeTypeSupportedByServer, isAudioMimeTypeSupportedByServer, isVideoMimeTypeSupportedByServer, isUnknownMimeTypeSupportedByServer, isMimeTypeSupportedByServer } from './mediaTypeUtils';
+export { isUndefined, pick, omitBy, debounce, matches } from './utils/helpers';

package/dist/esm/mediaFeatureFlags.js

@@ -1,3 +1,4 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { useRef } from 'react';
 import { getLocalMediaFeatureFlag } from './mediaFeatureFlag-local'; // Media feature flags - type and defaults defined here in one source of truth
 
@@ -49,7 +50,8 @@ 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');
   }
-});
+}); // With this type we ensure the object will contain all the flags
+
 export var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
   if (!ffA && !ffB) {
     return true;
@@ -57,8 +59,7 @@ export var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
 
   if (!ffA || !ffB) {
     return false;
-  } // With this type we ensure this object will compare all the flags
-
+  }
 
   var results = {
     newCardExperience: ffA.newCardExperience === ffB.newCardExperience,
@@ -80,4 +81,19 @@ export var useMemoizeFeatureFlags = function useMemoizeFeatureFlags(featureFlags
   }
 
   return ref.current;
+};
+export var filterFeatureFlagNames = function filterFeatureFlagNames(flags) {
+  var pairs = Object.entries(flags);
+  return pairs.filter(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+        _key = _ref2[0],
+        value = _ref2[1];
+
+    return !!value;
+  }).map(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 1),
+        key = _ref4[0];
+
+    return key;
+  });
 };

package/dist/esm/utils/helpers.js

@@ -0,0 +1,53 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+export var isUndefined = function isUndefined(value) {
+  return value === undefined;
+};
+export var pick = function pick(obj) {
+  var keys = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+
+  if (obj === undefined) {
+    return {};
+  }
+
+  return Object.fromEntries(Object.entries(obj).filter(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 1),
+        k = _ref2[0];
+
+    return keys.includes(k);
+  }));
+};
+export var omitBy = function omitBy(obj, predicate) {
+  return Object.fromEntries(Object.entries(obj).filter(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+        k = _ref4[0],
+        v = _ref4[1];
+
+    return !predicate(v);
+  }));
+};
+export var debounce = function debounce(func, wait) {
+  var timeout;
+  return function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    clearTimeout(timeout);
+    timeout = setTimeout(function () {
+      return func.apply(void 0, args);
+    }, wait);
+  };
+};
+export var matches = function matches(srcObj) {
+  return function (obj) {
+    var key;
+
+    for (key in srcObj) {
+      if (obj[key] === undefined || obj[key] !== srcObj[key]) {
+        return false;
+      }
+    }
+
+    return true;
+  };
+};

package/dist/esm/version.json

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

package/dist/types/analytics/withMediaAnalyticsContext.d.ts

@@ -15,4 +15,4 @@ import { ContextPublicAttributes } from './types';
  */
 export declare const withMediaAnalyticsContext: (contextPublicAttributes: ContextPublicAttributes, options?: {
     filterFeatureFlags?: Array<keyof MediaFeatureFlags>;
-}) => <Props extends import("../mediaFeatureFlags").WithMediaFeatureFlags, Component extends React.ComponentType<Props>>(WrappedComponent: (((props: Props) => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) & Component) | ((new (props: Props) => React.Component<Props, any, any>) & Component)) => React.ForwardRefExoticComponent<React.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props>> & React.RefAttributes<any>>;
+}) => <Props extends import("../mediaFeatureFlags").WithMediaFeatureFlags, Component extends React.ComponentType<Props>>(WrappedComponent: React.JSXElementConstructor<Props> & Component) => React.ForwardRefExoticComponent<React.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props>> & React.RefAttributes<any>>;

package/dist/types/index.d.ts

@@ -1,8 +1,8 @@
 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, areEqualFeatureFlags, useMemoizeFeatureFlags, } from './mediaFeatureFlags';
-export type { MediaFeatureFlags, WithMediaFeatureFlags, } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames, } from './mediaFeatureFlags';
+export type { MediaFeatureFlags, WithMediaFeatureFlags, RequiredMediaFeatureFlags, } from './mediaFeatureFlags';
 export interface NumericalCardDimensions {
     width: number;
     height: number;
@@ -12,3 +12,4 @@ 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';
+export { isUndefined, pick, omitBy, debounce, matches } from './utils/helpers';

package/dist/types/mediaFeatureFlags.d.ts

@@ -21,5 +21,7 @@ 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 type RequiredMediaFeatureFlags = Record<keyof Required<MediaFeatureFlags>, boolean>;
 export declare const areEqualFeatureFlags: (ffA?: MediaFeatureFlags | undefined, ffB?: MediaFeatureFlags | undefined) => boolean;
 export declare const useMemoizeFeatureFlags: (featureFlags?: MediaFeatureFlags | undefined) => MediaFeatureFlags | undefined;
+export declare const filterFeatureFlagNames: (flags: RequiredMediaFeatureFlags) => Array<keyof MediaFeatureFlags>;

package/dist/types/utils/helpers.d.ts

@@ -0,0 +1,9 @@
+export declare const isUndefined: (value: any) => boolean;
+export declare const pick: (obj?: Object | undefined, keys?: Array<String>) => {
+    [k: string]: any;
+};
+export declare const omitBy: (obj: Object, predicate: Function) => {
+    [k: string]: any;
+};
+export declare const debounce: (func: Function, wait: number) => (...args: any[]) => void;
+export declare const matches: (srcObj: Object) => (obj: Object) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-common",
-  "version": "2.10.3",
+  "version": "2.12.1",
   "description": "Includes common utilities used by other media packages",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -44,13 +44,12 @@
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
-    "@atlaskit/media-test-helpers": "^29.1.0",
+    "@atlaskit/media-test-helpers": "^29.4.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.21",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "typescript": "3.9.6"
+    "typescript": "4.2.4"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }