@atlaskit/media-common 2.11.0 → 2.12.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/media-common
 
+## 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

package/dist/cjs/index.js

@@ -33,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() {

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/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/media-common",
-	"version": "2.11.0",
+	"version": "2.12.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, areEqualFeatureFlags, useMemoizeFeatureFlags } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames } from './mediaFeatureFlags';
 // Analytics context
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext'; // Analytics constants
 

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/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/media-common",
-	"version": "2.11.0",
+	"version": "2.12.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, areEqualFeatureFlags, useMemoizeFeatureFlags } from './mediaFeatureFlags';
+export { getMediaFeatureFlag, defaultMediaFeatureFlags, areEqualFeatureFlags, useMemoizeFeatureFlags, filterFeatureFlagNames } from './mediaFeatureFlags';
 // Analytics context
 export { withMediaAnalyticsContext } from './analytics/withMediaAnalyticsContext'; // Analytics constants
 

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/version.json

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

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;

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/package.json

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