@atlaskit/media-common 2.15.0 → 2.16.2

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/media-common
 
+## 2.16.2
+
+### Patch Changes
+
+- [`c81ee725277`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c81ee725277) - Add attribute fileMediaType into media viewer loadSucceeded event
+- Updated dependencies
+
+## 2.16.1
+
+### Patch Changes
+
+- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
+
+## 2.16.0
+
+### Minor Changes
+
+- [`a332288b5ea`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a332288b5ea) - Added analytics for media-card memoryCacheLogging and added relevant featureFlag keys for media-common package.
+
 ## 2.15.0
 
 ### Minor Changes

package/dist/cjs/mediaFeatureFlags/mediaFeatureFlags.js

@@ -35,7 +35,8 @@ var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
     folderUploads: ffA.folderUploads === ffB.folderUploads,
     observedWidth: ffA.observedWidth === ffB.observedWidth,
     timestampOnVideo: ffA.timestampOnVideo === ffB.timestampOnVideo,
-    mediaUploadApiV2: ffA.mediaUploadApiV2 === ffB.mediaUploadApiV2
+    mediaUploadApiV2: ffA.mediaUploadApiV2 === ffB.mediaUploadApiV2,
+    memoryCacheLogging: ffA.memoryCacheLogging === ffB.memoryCacheLogging
   };
   return Object.values(results).every(function (result) {
     return result;
@@ -106,7 +107,8 @@ var defaultMediaFeatureFlags = {
   folderUploads: false,
   observedWidth: false,
   timestampOnVideo: false,
-  mediaUploadApiV2: true
+  mediaUploadApiV2: true,
+  memoryCacheLogging: false
 };
 /**
  * Public accessor from components to fallback to defaults if flags not passed,

package/dist/cjs/mediaFeatureFlags/productKeys.js

@@ -14,7 +14,8 @@ var productKeys = {
     observedWidth: '',
     // TODO https://product-fabric.atlassian.net/browse/MEX-1620
     timestampOnVideo: '',
-    mediaUploadApiV2: 'confluence.enable.media.upload.api.v2'
+    mediaUploadApiV2: 'confluence.enable.media.upload.api.v2',
+    memoryCacheLogging: 'confluence-frontend-media-card-memory-cache-logging'
   },
   jira: {
     newCardExperience: 'issue.details.media-cards-new-experience',
@@ -26,7 +27,8 @@ var productKeys = {
     observedWidth: '',
     // TODO https://product-fabric.atlassian.net/browse/MEX-1620
     timestampOnVideo: '',
-    mediaUploadApiV2: 'issue.details.enable-media-upload-api-version-2'
+    mediaUploadApiV2: 'issue.details.enable-media-upload-api-version-2',
+    memoryCacheLogging: 'jira-frontend-media-card-memory-cache-logging'
   }
 };
 

package/dist/cjs/version.json

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

package/dist/es2019/mediaFeatureFlags/mediaFeatureFlags.js

@@ -18,7 +18,8 @@ export const areEqualFeatureFlags = (ffA, ffB) => {
     folderUploads: ffA.folderUploads === ffB.folderUploads,
     observedWidth: ffA.observedWidth === ffB.observedWidth,
     timestampOnVideo: ffA.timestampOnVideo === ffB.timestampOnVideo,
-    mediaUploadApiV2: ffA.mediaUploadApiV2 === ffB.mediaUploadApiV2
+    mediaUploadApiV2: ffA.mediaUploadApiV2 === ffB.mediaUploadApiV2,
+    memoryCacheLogging: ffA.memoryCacheLogging === ffB.memoryCacheLogging
   };
   return Object.values(results).every(result => result);
 };
@@ -57,7 +58,8 @@ export const defaultMediaFeatureFlags = {
   folderUploads: false,
   observedWidth: false,
   timestampOnVideo: false,
-  mediaUploadApiV2: true
+  mediaUploadApiV2: true,
+  memoryCacheLogging: false
 };
 /**
  * Public accessor from components to fallback to defaults if flags not passed,

package/dist/es2019/mediaFeatureFlags/productKeys.js

@@ -8,7 +8,8 @@ const productKeys = {
     observedWidth: '',
     // TODO https://product-fabric.atlassian.net/browse/MEX-1620
     timestampOnVideo: '',
-    mediaUploadApiV2: 'confluence.enable.media.upload.api.v2'
+    mediaUploadApiV2: 'confluence.enable.media.upload.api.v2',
+    memoryCacheLogging: 'confluence-frontend-media-card-memory-cache-logging'
   },
   jira: {
     newCardExperience: 'issue.details.media-cards-new-experience',
@@ -20,7 +21,8 @@ const productKeys = {
     observedWidth: '',
     // TODO https://product-fabric.atlassian.net/browse/MEX-1620
     timestampOnVideo: '',
-    mediaUploadApiV2: 'issue.details.enable-media-upload-api-version-2'
+    mediaUploadApiV2: 'issue.details.enable-media-upload-api-version-2',
+    memoryCacheLogging: 'jira-frontend-media-card-memory-cache-logging'
   }
 };
 export const getProductKeys = () => productKeys;

package/dist/es2019/version.json

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

package/dist/esm/mediaFeatureFlags/mediaFeatureFlags.js

@@ -19,7 +19,8 @@ export var areEqualFeatureFlags = function areEqualFeatureFlags(ffA, ffB) {
     folderUploads: ffA.folderUploads === ffB.folderUploads,
     observedWidth: ffA.observedWidth === ffB.observedWidth,
     timestampOnVideo: ffA.timestampOnVideo === ffB.timestampOnVideo,
-    mediaUploadApiV2: ffA.mediaUploadApiV2 === ffB.mediaUploadApiV2
+    mediaUploadApiV2: ffA.mediaUploadApiV2 === ffB.mediaUploadApiV2,
+    memoryCacheLogging: ffA.memoryCacheLogging === ffB.memoryCacheLogging
   };
   return Object.values(results).every(function (result) {
     return result;
@@ -79,7 +80,8 @@ export var defaultMediaFeatureFlags = {
   folderUploads: false,
   observedWidth: false,
   timestampOnVideo: false,
-  mediaUploadApiV2: true
+  mediaUploadApiV2: true,
+  memoryCacheLogging: false
 };
 /**
  * Public accessor from components to fallback to defaults if flags not passed,

package/dist/esm/mediaFeatureFlags/productKeys.js

@@ -8,7 +8,8 @@ var productKeys = {
     observedWidth: '',
     // TODO https://product-fabric.atlassian.net/browse/MEX-1620
     timestampOnVideo: '',
-    mediaUploadApiV2: 'confluence.enable.media.upload.api.v2'
+    mediaUploadApiV2: 'confluence.enable.media.upload.api.v2',
+    memoryCacheLogging: 'confluence-frontend-media-card-memory-cache-logging'
   },
   jira: {
     newCardExperience: 'issue.details.media-cards-new-experience',
@@ -20,7 +21,8 @@ var productKeys = {
     observedWidth: '',
     // TODO https://product-fabric.atlassian.net/browse/MEX-1620
     timestampOnVideo: '',
-    mediaUploadApiV2: 'issue.details.enable-media-upload-api-version-2'
+    mediaUploadApiV2: 'issue.details.enable-media-upload-api-version-2',
+    memoryCacheLogging: 'jira-frontend-media-card-memory-cache-logging'
   }
 };
 export var getProductKeys = function getProductKeys() {

package/dist/esm/version.json

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

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

@@ -33,6 +33,7 @@ export declare type WithPerformanceAttributes = {
 };
 export declare type SuccessAttributes = {
     status: 'success';
+    fileMediatype?: MediaType;
 };
 export declare type FailureAttributes = {
     status: 'fail';

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

@@ -6,6 +6,7 @@ export interface MediaFeatureFlags {
     observedWidth?: boolean;
     timestampOnVideo?: boolean;
     mediaUploadApiV2?: boolean;
+    memoryCacheLogging?: boolean;
 }
 export interface WithMediaFeatureFlags {
     featureFlags?: MediaFeatureFlags;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-common",
-  "version": "2.15.0",
+  "version": "2.16.2",
   "description": "Includes common utilities used by other media packages",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -33,9 +33,9 @@
   "scripts": {},
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.0.5",
-    "@atlaskit/analytics-namespaced-context": "^6.4.0",
+    "@atlaskit/analytics-namespaced-context": "^6.5.0",
     "@atlaskit/analytics-next": "^8.1.1",
-    "@atlaskit/section-message": "^6.0.0",
+    "@atlaskit/section-message": "^6.2.0",
     "@babel/runtime": "^7.0.0"
   },
   "peerDependencies": {
@@ -49,7 +49,7 @@
     "enzyme": "^3.10.0",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "typescript": "4.2.4"
+    "typescript": "4.3.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }

package/report.api.md

@@ -0,0 +1,308 @@
+## API Report File for "@atlaskit/media-common"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { GasCorePayload } from '@atlaskit/analytics-gas-types';
+import { default as React_2 } from 'react';
+
+export declare const ANALYTICS_MEDIA_CHANNEL = 'media';
+
+export declare const areEqualFeatureFlags: (
+  ffA?: MediaFeatureFlags | undefined,
+  ffB?: MediaFeatureFlags | undefined,
+) => boolean;
+
+declare type BaseAttributes = {};
+
+declare type BaseEventPayload<Attributes extends BaseAttributes> = Omit<
+  GasCorePayload,
+  'attributes'
+> & {
+  attributes: Attributes;
+};
+
+export declare type ContextPublicAttributes = PackageAttributes;
+
+export declare type ContextStaticProps = WithMediaFeatureFlags;
+
+export declare const debounce: (
+  func: Function,
+  wait: number,
+) => (...args: any[]) => void;
+
+export declare const defaultMediaFeatureFlags: Required<MediaFeatureFlags>;
+
+export declare const downloadUrl: (
+  url: string,
+  options?: DownloadUrlOptions | undefined,
+) => void;
+
+declare interface DownloadUrlOptions {
+  name?: string;
+}
+
+export declare type FailureAttributes = {
+  status: 'fail';
+  failReason: string;
+  error?: string;
+  errorDetail?: string;
+};
+
+export declare type FileAttributes = {
+  fileId: string;
+  fileSize?: number;
+  fileMediatype?: MediaType;
+  fileMimetype?: string;
+  fileSource?: string;
+  fileStatus?: FileStatus;
+};
+
+export declare type FileStatus =
+  | 'uploading'
+  | 'processing'
+  | 'processed'
+  | 'error'
+  | 'failed-processing';
+
+/**
+ * Takes a record of {Media Feature Flag Names → boolean}.
+ * Returns the Launch Darkly Keys from all products for each of the flags set as true in the input record.
+ * */
+export declare const filterFeatureFlagKeysAllProducts: (
+  flags: RequiredMediaFeatureFlags,
+) => Array<string>;
+
+export declare const filterFeatureFlagNames: (
+  flags: RequiredMediaFeatureFlags,
+) => Array<keyof MediaFeatureFlags>;
+
+/**
+ * Public accessor from components to fallback to defaults if flags not passed,
+ * otherwise whatever product has set will be returned.
+ *
+ * To override locally for testing:
+ * - `localStorage[flagName] = true` to enable locally,
+ * - `delete localStorage[flagName]` to remove.
+ *
+ * (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 getMediaTypeFromMimeType: (mimeType: string) => MediaType;
+
+export declare const isAudioMimeTypeSupportedByServer: (
+  mimeType: string,
+) => boolean;
+
+export declare const isDocumentMimeTypeSupportedByBrowser: (
+  mimeType: string,
+) => boolean;
+
+export declare const isDocumentMimeTypeSupportedByServer: (
+  mimeType: string,
+) => boolean;
+
+export declare const isImageMimeTypeSupportedByBrowser: (
+  mimeType: string,
+) => boolean;
+
+export declare const isImageMimeTypeSupportedByServer: (
+  mimeType: string,
+) => boolean;
+
+export declare const isMimeTypeSupportedByBrowser: (
+  mimeType: string,
+) => boolean;
+
+export declare const isMimeTypeSupportedByServer: (mimeType: string) => boolean;
+
+export declare const isUndefined: (value: any) => boolean;
+
+export declare const isUnknownMimeTypeSupportedByServer: (
+  mimeType: string,
+) => boolean;
+
+export declare const isVideoMimeTypeSupportedByServer: (
+  mimeType: string,
+) => boolean;
+
+export declare const matches: (srcObj: Object) => (obj: Object) => boolean;
+
+export declare interface MediaFeatureFlags {
+  newCardExperience?: boolean;
+  captions?: boolean;
+  mediaInline?: boolean;
+  folderUploads?: boolean;
+  observedWidth?: boolean;
+  timestampOnVideo?: boolean;
+  mediaUploadApiV2?: boolean;
+}
+
+export declare type MediaType =
+  | 'doc'
+  | 'audio'
+  | 'video'
+  | 'image'
+  | 'archive'
+  | 'unknown';
+
+export declare interface NumericalCardDimensions {
+  width: number;
+  height: number;
+}
+
+export declare const omitBy: (
+  obj: Object,
+  predicate: Function,
+) => {
+  [k: string]: any;
+};
+
+export declare type OperationalAttributes =
+  | BaseAttributes
+  | (BaseAttributes & WithFileAttributes)
+  | (BaseAttributes & WithFileAttributes & StatusAttributes)
+  | (BaseAttributes &
+      WithFileAttributes &
+      StatusAttributes &
+      WithPerformanceAttributes);
+
+export declare type OperationalEventPayload<
+  Attributes extends OperationalAttributes,
+  Action extends string,
+  ActionSubject extends string,
+  ActionSubjectId extends string = string
+> = BaseEventPayload<Attributes> & {
+  eventType: 'operational';
+  action: Action;
+  actionSubject: ActionSubject;
+  actionSubjectId?: ActionSubjectId;
+};
+
+export declare type PackageAttributes = {
+  packageName: string;
+  packageVersion: string;
+  componentName: string;
+  component: string;
+};
+
+export declare type PerformanceAttributes = {
+  overall: {
+    durationSincePageStart: number;
+    durationSinceCommenced?: number;
+  };
+};
+
+export declare const pick: (
+  obj?: Object | undefined,
+  keys?: Array<String>,
+) => {
+  [k: string]: any;
+};
+
+declare type RequiredMediaFeatureFlags = Record<
+  keyof Required<MediaFeatureFlags>,
+  boolean
+>;
+
+export declare type ScreenAttributes =
+  | BaseAttributes
+  | (BaseAttributes & WithFileAttributes);
+
+export declare type ScreenEventPayload<
+  Attributes extends ScreenAttributes,
+  ActionSubject extends string
+> = BaseEventPayload<Attributes> & {
+  eventType: 'screen';
+  actionSubject: ActionSubject;
+  name: ActionSubject;
+};
+
+export declare type SSR = 'client' | 'server';
+
+declare type StatusAttributes = SuccessAttributes | FailureAttributes;
+
+export declare type SuccessAttributes = {
+  status: 'success';
+};
+
+export declare type TrackAttributes =
+  | BaseAttributes
+  | (BaseAttributes & WithFileAttributes);
+
+export declare type TrackEventPayload<
+  Attributes extends TrackAttributes,
+  Action extends string,
+  ActionSubject extends string,
+  ActionSubjectId extends string = string
+> = BaseEventPayload<Attributes> & {
+  eventType: 'track';
+  action: Action;
+  actionSubject: ActionSubject;
+  actionSubjectId?: ActionSubjectId;
+};
+
+export declare type UIAttributes =
+  | BaseAttributes
+  | (BaseAttributes & WithFileAttributes);
+
+export declare type UIEventPayload<
+  Attributes extends UIAttributes,
+  Action extends string,
+  ActionSubject extends string
+> = BaseEventPayload<Attributes> & {
+  eventType: 'ui';
+  action: Action;
+  actionSubject: ActionSubject;
+  actionSubjectId?: string;
+};
+
+export declare const useMemoizeFeatureFlags: (
+  featureFlags?: MediaFeatureFlags | undefined,
+) => MediaFeatureFlags | undefined;
+
+export declare type WithFileAttributes = {
+  fileAttributes: FileAttributes;
+};
+
+/**
+ * HOC for attaching MediaAnalyticsContext to a top-level React Component.
+ *
+ * Similar than "packages/analytics/analytics-next/src/hocs/withAnalyticsContext.tsx",
+ * except that we restrict attributes put in this context using ContextPublicAttributes and ContextPrivateAttributes.
+ *
+ * As a constraint, the wrapped React Component's props must extend ContextStaticProps.
+ *
+ * @param {ContextPublicAttributes} attributes public attributes to put in context
+ *
+ * @see packages/analytics/analytics-next/src/hocs/withAnalyticsContext.tsx
+ */
+export declare const withMediaAnalyticsContext: (
+  contextPublicAttributes: ContextPublicAttributes,
+  options?: {
+    filterFeatureFlags?: Array<keyof MediaFeatureFlags>;
+  },
+) => <
+  Props extends WithMediaFeatureFlags,
+  Component extends React_2.ComponentType<Props>
+>(
+  WrappedComponent: React_2.JSXElementConstructor<Props> & Component,
+) => React_2.ForwardRefExoticComponent<
+  React_2.PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props>> &
+    React_2.RefAttributes<any>
+>;
+
+export declare interface WithMediaFeatureFlags {
+  featureFlags?: MediaFeatureFlags;
+}
+
+export declare type WithPerformanceAttributes = {
+  performanceAttributes?: PerformanceAttributes;
+};
+
+export {};
+```