@atlaskit/renderer 108.11.18 → 108.12.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/renderer
 
+## 108.12.0
+
+### Minor 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.
+
 ## 108.11.18
 
 ### Patch Changes

package/dist/cjs/react/nodes/mediaSingle/index.js

@@ -56,8 +56,11 @@ var MediaSingle = function MediaSingle(props) {
     layout = props.layout,
     children = props.children,
     widthAttr = props.width,
-    widthType = props.widthType;
+    widthType = props.widthType,
+    _props$allowCaptions = props.allowCaptions,
+    allowCaptions = _props$allowCaptions === void 0 ? false : _props$allowCaptions;
   var isCaptionsFlaggedOn = (0, _mediaCommon.getMediaFeatureFlag)('captions', featureFlags);
+  var showCaptions = allowCaptions ? allowCaptions : isCaptionsFlaggedOn;
   var _React$useState = _react.default.useState({
       width: 0,
       height: 0
@@ -169,7 +172,7 @@ var MediaSingle = function MediaSingle(props) {
         widthType: widthType
       },
       fullWidthMode: isFullWidth
-    }, (0, _react2.jsx)(_react.Fragment, null, mediaComponent), isCaptionsFlaggedOn && caption);
+    }, (0, _react2.jsx)(_react.Fragment, null, mediaComponent), showCaptions && caption);
   };
   return (0, _react2.jsx)(_ui.WidthConsumer, null, function (_ref3) {
     var width = _ref3.width,

package/dist/cjs/ui/Renderer/index.js

@@ -55,7 +55,7 @@ exports.NORMAL_SEVERITY_THRESHOLD = NORMAL_SEVERITY_THRESHOLD;
 var DEGRADED_SEVERITY_THRESHOLD = 3000;
 exports.DEGRADED_SEVERITY_THRESHOLD = DEGRADED_SEVERITY_THRESHOLD;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "108.11.18";
+var packageVersion = "108.12.0";
 var Renderer = /*#__PURE__*/function (_PureComponent) {
   (0, _inherits2.default)(Renderer, _PureComponent);
   var _super = _createSuper(Renderer);

package/dist/es2019/react/nodes/mediaSingle/index.js

@@ -1,4 +1,5 @@
 /** @jsx jsx */
+
 import { default as React, Fragment } from 'react';
 import { jsx } from '@emotion/react';
 import { injectIntl } from 'react-intl-next';
@@ -43,9 +44,11 @@ const MediaSingle = props => {
     layout,
     children,
     width: widthAttr,
-    widthType
+    widthType,
+    allowCaptions = false
   } = props;
   const isCaptionsFlaggedOn = getMediaFeatureFlag('captions', featureFlags);
+  const showCaptions = allowCaptions ? allowCaptions : isCaptionsFlaggedOn;
   const [externalImageDimensions, setExternalImageDimensions] = React.useState({
     width: 0,
     height: 0
@@ -154,7 +157,7 @@ const MediaSingle = props => {
         widthType
       },
       fullWidthMode: isFullWidth
-    }, jsx(Fragment, null, mediaComponent), isCaptionsFlaggedOn && caption);
+    }, jsx(Fragment, null, mediaComponent), showCaptions && caption);
   };
   return jsx(WidthConsumer, null, ({
     width,

package/dist/es2019/ui/Renderer/index.js

@@ -35,7 +35,7 @@ import { RenderTracking } from '../../react/utils/performance/RenderTracking';
 export const NORMAL_SEVERITY_THRESHOLD = 2000;
 export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 const packageName = "@atlaskit/renderer";
-const packageVersion = "108.11.18";
+const packageVersion = "108.12.0";
 export class Renderer extends PureComponent {
   constructor(props) {
     super(props);

package/dist/esm/react/nodes/mediaSingle/index.js

@@ -1,5 +1,6 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 /** @jsx jsx */
+
 import { default as React, Fragment } from 'react';
 import { jsx } from '@emotion/react';
 import { injectIntl } from 'react-intl-next';
@@ -44,8 +45,11 @@ var MediaSingle = function MediaSingle(props) {
     layout = props.layout,
     children = props.children,
     widthAttr = props.width,
-    widthType = props.widthType;
+    widthType = props.widthType,
+    _props$allowCaptions = props.allowCaptions,
+    allowCaptions = _props$allowCaptions === void 0 ? false : _props$allowCaptions;
   var isCaptionsFlaggedOn = getMediaFeatureFlag('captions', featureFlags);
+  var showCaptions = allowCaptions ? allowCaptions : isCaptionsFlaggedOn;
   var _React$useState = React.useState({
       width: 0,
       height: 0
@@ -157,7 +161,7 @@ var MediaSingle = function MediaSingle(props) {
         widthType: widthType
       },
       fullWidthMode: isFullWidth
-    }, jsx(Fragment, null, mediaComponent), isCaptionsFlaggedOn && caption);
+    }, jsx(Fragment, null, mediaComponent), showCaptions && caption);
   };
   return jsx(WidthConsumer, null, function (_ref3) {
     var width = _ref3.width,

package/dist/esm/ui/Renderer/index.js

@@ -45,7 +45,7 @@ import { RenderTracking } from '../../react/utils/performance/RenderTracking';
 export var NORMAL_SEVERITY_THRESHOLD = 2000;
 export var DEGRADED_SEVERITY_THRESHOLD = 3000;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "108.11.18";
+var packageVersion = "108.12.0";
 export var Renderer = /*#__PURE__*/function (_PureComponent) {
   _inherits(Renderer, _PureComponent);
   var _super = _createSuper(Renderer);

package/dist/types/react/nodes/mediaSingle/index.d.ts

@@ -1,11 +1,10 @@
-/** @jsx jsx */
 import { default as React } from 'react';
-import { WrappedComponentProps } from 'react-intl-next';
-import { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
-import { MediaFeatureFlags } from '@atlaskit/media-common';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
+import type { MediaFeatureFlags } from '@atlaskit/media-common';
 import type { EventHandlers, MediaSingleWidthType } from '@atlaskit/editor-common/ui';
-import { AnalyticsEventPayload } from '../../../analytics/events';
-import { RendererAppearance } from '../../../ui/Renderer/types';
+import type { AnalyticsEventPayload } from '../../../analytics/events';
+import type { RendererAppearance } from '../../../ui/Renderer/types';
 export interface Props {
     children: React.ReactNode;
     layout: MediaSingleLayout;
@@ -16,6 +15,7 @@ export interface Props {
     rendererAppearance: RendererAppearance;
     fireAnalyticsEvent?: (event: AnalyticsEventPayload) => void;
     featureFlags?: MediaFeatureFlags;
+    allowCaptions?: boolean;
 }
 export declare const getMediaContainerWidth: (currentContainerWidth: number, layout: MediaSingleLayout) => number;
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {

package/dist/types/types/mediaOptions.d.ts

@@ -1,5 +1,5 @@
-import { MediaClientConfig } from '@atlaskit/media-core';
-import { MediaFeatureFlags, SSR } from '@atlaskit/media-common';
+import type { MediaClientConfig } from '@atlaskit/media-core';
+import type { MediaFeatureFlags, SSR } from '@atlaskit/media-common';
 export type MediaSSR = {
     mode: SSR;
     config: MediaClientConfig;
@@ -9,4 +9,5 @@ export interface MediaOptions {
     enableDownloadButton?: boolean;
     featureFlags?: MediaFeatureFlags;
     ssr?: MediaSSR;
+    allowCaptions?: boolean;
 }

package/dist/types-ts4.5/react/nodes/mediaSingle/index.d.ts

@@ -1,11 +1,10 @@
-/** @jsx jsx */
 import { default as React } from 'react';
-import { WrappedComponentProps } from 'react-intl-next';
-import { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
-import { MediaFeatureFlags } from '@atlaskit/media-common';
+import type { WrappedComponentProps } from 'react-intl-next';
+import type { RichMediaLayout as MediaSingleLayout } from '@atlaskit/adf-schema';
+import type { MediaFeatureFlags } from '@atlaskit/media-common';
 import type { EventHandlers, MediaSingleWidthType } from '@atlaskit/editor-common/ui';
-import { AnalyticsEventPayload } from '../../../analytics/events';
-import { RendererAppearance } from '../../../ui/Renderer/types';
+import type { AnalyticsEventPayload } from '../../../analytics/events';
+import type { RendererAppearance } from '../../../ui/Renderer/types';
 export interface Props {
     children: React.ReactNode;
     layout: MediaSingleLayout;
@@ -16,6 +15,7 @@ export interface Props {
     rendererAppearance: RendererAppearance;
     fireAnalyticsEvent?: (event: AnalyticsEventPayload) => void;
     featureFlags?: MediaFeatureFlags;
+    allowCaptions?: boolean;
 }
 export declare const getMediaContainerWidth: (currentContainerWidth: number, layout: MediaSingleLayout) => number;
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {

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

@@ -1,5 +1,5 @@
-import { MediaClientConfig } from '@atlaskit/media-core';
-import { MediaFeatureFlags, SSR } from '@atlaskit/media-common';
+import type { MediaClientConfig } from '@atlaskit/media-core';
+import type { MediaFeatureFlags, SSR } from '@atlaskit/media-common';
 export type MediaSSR = {
     mode: SSR;
     config: MediaClientConfig;
@@ -9,4 +9,5 @@ export interface MediaOptions {
     enableDownloadButton?: boolean;
     featureFlags?: MediaFeatureFlags;
     ssr?: MediaSSR;
+    allowCaptions?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/renderer",
-  "version": "108.11.18",
+  "version": "108.12.0",
   "description": "Renderer component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -31,8 +31,8 @@ import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { jsx } from '@emotion/react';
 import type { Mark } from '@atlaskit/editor-prosemirror/model';
-import { MediaClientConfig } from '@atlaskit/media-core';
-import { MediaFeatureFlags } from '@atlaskit/media-common';
+import type { MediaClientConfig } from '@atlaskit/media-core';
+import type { MediaFeatureFlags } from '@atlaskit/media-common';
 import { Node as Node_2 } from '@atlaskit/editor-prosemirror/model';
 import { OperationalAEP } from '@atlaskit/editor-common/analytics';
 import { PropsDifference } from '@atlaskit/editor-common/utils';
@@ -41,7 +41,7 @@ import { Schema } from '@atlaskit/editor-prosemirror/model';
 import { SEVERITY } from '@atlaskit/editor-common/utils';
 import { ShallowPropsDifference } from '@atlaskit/editor-common/utils';
 import { SortOrder } from '@atlaskit/editor-common/types';
-import { SSR } from '@atlaskit/media-common';
+import type { SSR } from '@atlaskit/media-common';
 import type { Transformer as Transformer_2 } from '@atlaskit/editor-common/types';
 import { UNSUPPORTED_CONTENT_LEVEL_SEVERITY } from '@atlaskit/editor-common/utils';
 import type { UnsupportedContentLevelsTracking } from '@atlaskit/editor-common/utils';
@@ -236,6 +236,8 @@ type MediaLnkTransformedAEP = AEP<
 
 // @public (undocumented)
 interface MediaOptions {
+  // (undocumented)
+  allowCaptions?: boolean;
   // (undocumented)
   allowLinking?: boolean;
   // (undocumented)

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

@@ -20,8 +20,8 @@ import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
 import { Fragment } from '@atlaskit/editor-prosemirror/model';
 import { jsx } from '@emotion/react';
 import type { Mark } from '@atlaskit/editor-prosemirror/model';
-import { MediaClientConfig } from '@atlaskit/media-core';
-import { MediaFeatureFlags } from '@atlaskit/media-common';
+import type { MediaClientConfig } from '@atlaskit/media-core';
+import type { MediaFeatureFlags } from '@atlaskit/media-common';
 import { Node as Node_2 } from '@atlaskit/editor-prosemirror/model';
 import { OperationalAEP } from '@atlaskit/editor-common/analytics';
 import { PropsDifference } from '@atlaskit/editor-common/utils';
@@ -30,7 +30,7 @@ import { Schema } from '@atlaskit/editor-prosemirror/model';
 import { SEVERITY } from '@atlaskit/editor-common/utils';
 import { ShallowPropsDifference } from '@atlaskit/editor-common/utils';
 import { SortOrder } from '@atlaskit/editor-common/types';
-import { SSR } from '@atlaskit/media-common';
+import type { SSR } from '@atlaskit/media-common';
 import type { Transformer as Transformer_2 } from '@atlaskit/editor-common/types';
 import { UNSUPPORTED_CONTENT_LEVEL_SEVERITY } from '@atlaskit/editor-common/utils';
 import type { UnsupportedContentLevelsTracking } from '@atlaskit/editor-common/utils';
@@ -139,6 +139,8 @@ type MediaLnkTransformedAEP = AEP<ACTION.MEDIA_LINK_TRANSFORMED, ACTION_SUBJECT.
 
 // @public (undocumented)
 interface MediaOptions {
+    // (undocumented)
+    allowCaptions?: boolean;
     // (undocumented)
     allowLinking?: boolean;
     // (undocumented)