@atlaskit/media-common 2.16.2 → 2.16.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/media-common
 
+## 2.16.3
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 2.16.2
 
 ### Patch Changes

package/analytics/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/analytics/index.js",
   "module:es2019": "../dist/es2019/analytics/index.js",
   "sideEffects": false,
-  "types": "../dist/types/analytics/index.d.ts"
+  "types": "../dist/types/analytics/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/analytics/index.d.ts"
+      ]
+    }
+  }
 }

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

package/dist/types-ts4.0/analytics/constants.d.ts

@@ -0,0 +1 @@
+export declare const ANALYTICS_MEDIA_CHANNEL = "media";

package/dist/types-ts4.0/analytics/index.d.ts

@@ -0,0 +1,3 @@
+export type { PackageAttributes, WithFileAttributes, FileAttributes, SuccessAttributes, FailureAttributes, OperationalAttributes, OperationalEventPayload, UIAttributes, UIEventPayload, ScreenAttributes, ScreenEventPayload, TrackAttributes, TrackEventPayload, ContextPublicAttributes, ContextStaticProps, } from './types';
+export { withMediaAnalyticsContext } from './withMediaAnalyticsContext';
+export { ANALYTICS_MEDIA_CHANNEL } from './constants';

package/dist/types-ts4.0/analytics/types.d.ts

@@ -0,0 +1,77 @@
+import { GasCorePayload } from '@atlaskit/analytics-gas-types';
+import { MEDIA_CONTEXT } from '@atlaskit/analytics-namespaced-context/MediaAnalyticsContext';
+import { MediaType, FileStatus, WithMediaFeatureFlags } from '..';
+export declare type BaseAttributes = {};
+export declare type PackageAttributes = {
+    packageName: string;
+    packageVersion: string;
+    componentName: string;
+    component: string;
+};
+export declare type BaseEventPayload<Attributes extends BaseAttributes> = Omit<GasCorePayload, 'attributes'> & {
+    attributes: Attributes;
+};
+export declare type FileAttributes = {
+    fileId: string;
+    fileSize?: number;
+    fileMediatype?: MediaType;
+    fileMimetype?: string;
+    fileSource?: string;
+    fileStatus?: FileStatus;
+};
+export declare type PerformanceAttributes = {
+    overall: {
+        durationSincePageStart: number;
+        durationSinceCommenced?: number;
+    };
+};
+export declare type WithFileAttributes = {
+    fileAttributes: FileAttributes;
+};
+export declare type WithPerformanceAttributes = {
+    performanceAttributes?: PerformanceAttributes;
+};
+export declare type SuccessAttributes = {
+    status: 'success';
+    fileMediatype?: MediaType;
+};
+export declare type FailureAttributes = {
+    status: 'fail';
+    failReason: string;
+    error?: string;
+    errorDetail?: string;
+};
+export declare type StatusAttributes = SuccessAttributes | FailureAttributes;
+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 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 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 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 ContextPublicAttributes = PackageAttributes;
+export declare type ContextPrivateAttributes = WithMediaFeatureFlags;
+export declare type ContextStaticProps = WithMediaFeatureFlags;
+export declare type ContextData = ContextPublicAttributes & {
+    [MEDIA_CONTEXT]: ContextPrivateAttributes;
+};

package/dist/types-ts4.0/analytics/withMediaAnalyticsContext.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { MediaFeatureFlags } from '../mediaFeatureFlags';
+import { ContextPublicAttributes } from './types';
+/**
+ * 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 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-ts4.0/docs/index.d.ts

@@ -0,0 +1 @@
+export { createRxjsNotice } from './rxjs-notice';

package/dist/types-ts4.0/docs/rxjs-notice.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function createRxjsNotice(componentName: string): JSX.Element;

package/dist/types-ts4.0/downloadUrl.d.ts

@@ -0,0 +1,4 @@
+export interface DownloadUrlOptions {
+    name?: string;
+}
+export declare const downloadUrl: (url: string, options?: DownloadUrlOptions | undefined) => void;

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

@@ -0,0 +1,15 @@
+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, filterFeatureFlagNames, filterFeatureFlagKeysAllProducts, } from './mediaFeatureFlags';
+export type { MediaFeatureFlags, WithMediaFeatureFlags, } from './mediaFeatureFlags';
+export interface NumericalCardDimensions {
+    width: number;
+    height: number;
+}
+export type { PackageAttributes, WithFileAttributes, WithPerformanceAttributes, FileAttributes, PerformanceAttributes, SuccessAttributes, FailureAttributes, OperationalAttributes, OperationalEventPayload, UIAttributes, UIEventPayload, ScreenAttributes, ScreenEventPayload, TrackAttributes, TrackEventPayload, ContextPublicAttributes, ContextStaticProps, } from './analytics/types';
+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-ts4.0/mediaFeatureFlag-local.d.ts

@@ -0,0 +1 @@
+export declare const getLocalMediaFeatureFlag: (key: string) => string | null;

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

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

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

@@ -0,0 +1,26 @@
+import { RequiredMediaFeatureFlags, MediaFeatureFlags, SupportedProduct } from './types';
+export declare const areEqualFeatureFlags: (ffA?: MediaFeatureFlags | undefined, ffB?: MediaFeatureFlags | undefined) => boolean;
+export declare const filterFeatureFlagNames: (flags: RequiredMediaFeatureFlags) => Array<keyof MediaFeatureFlags>;
+/**
+ * Takes a record of {Media Feature Flag Names → boolean} and a supported product name.
+ * Returns the corresponding product’s Launch Darkly Keys for each of the flags set as true in the input record.
+ * */
+export declare const mapAndFilterFeatureFlagNames: (flags: RequiredMediaFeatureFlags, product: SupportedProduct) => Array<string>;
+/**
+ * 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 defaultMediaFeatureFlags: Required<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 useMemoizeFeatureFlags: (featureFlags?: MediaFeatureFlags | undefined) => MediaFeatureFlags | undefined;

package/dist/types-ts4.0/mediaFeatureFlags/productKeys.d.ts

@@ -0,0 +1,2 @@
+import { ProductKeys } from './types';
+export declare const getProductKeys: () => ProductKeys;

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

@@ -0,0 +1,21 @@
+export interface MediaFeatureFlags {
+    newCardExperience?: boolean;
+    captions?: boolean;
+    mediaInline?: boolean;
+    folderUploads?: boolean;
+    observedWidth?: boolean;
+    timestampOnVideo?: boolean;
+    mediaUploadApiV2?: boolean;
+    memoryCacheLogging?: boolean;
+}
+export interface WithMediaFeatureFlags {
+    featureFlags?: MediaFeatureFlags;
+}
+export declare type RequiredMediaFeatureFlags = Record<keyof Required<MediaFeatureFlags>, boolean>;
+export declare type MediaFeatureFlagsMap = Record<keyof Required<MediaFeatureFlags>, string>;
+export declare const supportedProducts: readonly [
+    "confluence",
+    "jira"
+];
+export declare type SupportedProduct = typeof supportedProducts[number];
+export declare type ProductKeys = Record<SupportedProduct, MediaFeatureFlagsMap>;

package/dist/types-ts4.0/mediaTypeUtils/index.d.ts

@@ -0,0 +1,4 @@
+import { MediaType } from '..';
+export { isImageMimeTypeSupportedByBrowser, isDocumentMimeTypeSupportedByBrowser, isAudioMimeTypeSupportedByBrowser, isVideoMimeTypeSupportedByBrowser, isMimeTypeSupportedByBrowser, } from './isMimeTypeSupportedByBrowser';
+export { isImageMimeTypeSupportedByServer, isDocumentMimeTypeSupportedByServer, isAudioMimeTypeSupportedByServer, isVideoMimeTypeSupportedByServer, isUnknownMimeTypeSupportedByServer, isMimeTypeSupportedByServer, } from './isMimeTypeSupportedByServer';
+export declare const getMediaTypeFromMimeType: (mimeType: string) => MediaType;

package/dist/types-ts4.0/mediaTypeUtils/isArchive.d.ts

@@ -0,0 +1 @@
+export declare const isArchive: (mimeType: string) => boolean;

package/dist/types-ts4.0/mediaTypeUtils/isMimeTypeSupportedByBrowser.d.ts

@@ -0,0 +1,14 @@
+export declare const isImageMimeTypeSupportedByBrowser: (mimeType: string) => boolean;
+export declare const isDocumentMimeTypeSupportedByBrowser: (mimeType: string) => boolean;
+export declare const isAudioMimeTypeSupportedByBrowser: (mimeType: string) => boolean;
+/**
+ * For backward compatilbity, we assume MP4/MOV is natively supported.
+ * TODO: Improve detection of supported video formats by the browser.
+ *
+ * See related tickets:
+ * - https://product-fabric.atlassian.net/browse/MPT-477
+ * - https://product-fabric.atlassian.net/browse/EDM-634
+ * - https://product-fabric.atlassian.net/browse/EDM-426
+ */
+export declare const isVideoMimeTypeSupportedByBrowser: (mimeType: string) => boolean;
+export declare const isMimeTypeSupportedByBrowser: (mimeType: string) => boolean;

package/dist/types-ts4.0/mediaTypeUtils/isMimeTypeSupportedByServer.d.ts

@@ -0,0 +1,6 @@
+export declare const isImageMimeTypeSupportedByServer: (mimeType: string) => boolean;
+export declare const isDocumentMimeTypeSupportedByServer: (mimeType: string) => boolean;
+export declare const isAudioMimeTypeSupportedByServer: (mimeType: string) => boolean;
+export declare const isVideoMimeTypeSupportedByServer: (mimeType: string) => boolean;
+export declare const isUnknownMimeTypeSupportedByServer: (mimeType: string) => boolean;
+export declare const isMimeTypeSupportedByServer: (mimeType: string) => boolean;

package/dist/types-ts4.0/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/downloadUrl/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/downloadUrl.js",
   "module:es2019": "../dist/es2019/downloadUrl.js",
   "sideEffects": false,
-  "types": "../dist/types/downloadUrl.d.ts"
+  "types": "../dist/types/downloadUrl.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/downloadUrl.d.ts"
+      ]
+    }
+  }
 }

package/mediaFeatureFlags/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/mediaFeatureFlags/index.js",
   "module:es2019": "../dist/es2019/mediaFeatureFlags/index.js",
   "sideEffects": false,
-  "types": "../dist/types/mediaFeatureFlags/index.d.ts"
+  "types": "../dist/types/mediaFeatureFlags/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/mediaFeatureFlags/index.d.ts"
+      ]
+    }
+  }
 }

package/mediaTypeUtils/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/mediaTypeUtils/index.js",
   "module:es2019": "../dist/es2019/mediaTypeUtils/index.js",
   "sideEffects": false,
-  "types": "../dist/types/mediaTypeUtils/index.d.ts"
+  "types": "../dist/types/mediaTypeUtils/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/mediaTypeUtils/index.d.ts"
+      ]
+    }
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-common",
-  "version": "2.16.2",
+  "version": "2.16.3",
   "description": "Includes common utilities used by other media packages",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
@@ -49,7 +56,7 @@
     "enzyme": "^3.10.0",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
 }