@atlaskit/editor-core 187.42.5 → 187.43.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-core
 
+## 187.43.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.
+
+## 187.42.6
+
+### Patch Changes
+
+- [`37c62369dae`](https://bitbucket.org/atlassian/atlassian-frontend/commits/37c62369dae) - NO-ISSUE Import doc builder types from editor-common
+
 ## 187.42.5
 
 ### Patch Changes

package/dist/cjs/labs/next/presets/universal.js

@@ -130,7 +130,7 @@ function createUniversalPreset(appearance, props, featureFlags, prevAppearance,
     return builder;
   }).maybeAdd(_plugins.captionPlugin, function (plugin, builder) {
     // EDM-799: inside caption plugin we do the feature flag in enabling the plugin
-    if (props.media && (0, _mediaCommon.getMediaFeatureFlag)('captions', props.media.featureFlags)) {
+    if (props.media && (props.media.allowCaptions || (0, _mediaCommon.getMediaFeatureFlag)('captions', props.media.featureFlags))) {
       return builder.add(plugin);
     }
     return builder;

package/dist/cjs/plugins/copy-button/pm-plugins/main.js

@@ -11,16 +11,16 @@ var _pluginKey = require("./plugin-key");
 function getMarkSelectionDecorationStartAndEnd(_ref) {
   var markType = _ref.markType,
     transaction = _ref.transaction;
-  var headHesolvedPos = transaction.selection.$head;
+  var headResolvedPos = transaction.selection.$head;
   var textNodeIndex = transaction.selection.$head.index();
-  var textNode = headHesolvedPos.parent.maybeChild(textNodeIndex);
+  var textNode = headResolvedPos.parent.maybeChild(textNodeIndex);
   var textNodeOffset = 0;
-  headHesolvedPos.parent.forEach(function (_node, nodeOffset, index) {
+  headResolvedPos.parent.forEach(function (_node, nodeOffset, index) {
     if (index === textNodeIndex) {
       textNodeOffset = nodeOffset;
     }
   });
-  var start = headHesolvedPos.start(headHesolvedPos.depth) + textNodeOffset;
+  var start = headResolvedPos.start(headResolvedPos.depth) + textNodeOffset;
   var end = start + textNode.text.length;
   return {
     start: start,

package/dist/cjs/plugins/media/index.js

@@ -73,14 +73,20 @@ var mediaPlugin = function mediaPlugin(_ref2) {
         allowMediaGroup = _ref3$allowMediaGroup === void 0 ? true : _ref3$allowMediaGroup,
         _ref3$allowMediaSingl = _ref3.allowMediaSingle,
         allowMediaSingle = _ref3$allowMediaSingl === void 0 ? false : _ref3$allowMediaSingl,
+        allowCaptions = _ref3.allowCaptions,
         mediaFeatureFlags = _ref3.featureFlags;
-      var captions = (0, _mediaCommon.getMediaFeatureFlag)('captions', mediaFeatureFlags);
       var allowMediaInline = (0, _mediaCommon.getMediaFeatureFlag)('mediaInline', mediaFeatureFlags);
+      var withCaption = (0, _mediaCommon.getMediaFeatureFlag)('captions', mediaFeatureFlags);
+
+      // temporary mapping - we will support captions feature flag until
+      // confluence removes the feature flag support in their code base and
+      // utilizes allowCaptions media prop instead
+      var mappedAllowCaptions = allowCaptions ? allowCaptions : withCaption;
       var mediaSingleOption = (0, _platformFeatureFlags.getBooleanFF)('platform.editor.media.extended-resize-experience') ? {
-        withCaption: captions,
+        withCaption: mappedAllowCaptions,
         withExtendedWidthTypes: true
       } : {
-        withCaption: captions,
+        withCaption: mappedAllowCaptions,
         withExtendedWidthTypes: false
       };
       var mediaSingleNode = (0, _adfSchema.mediaSingleSpec)(mediaSingleOption);

package/dist/cjs/plugins/media/nodeviews/mediaSingle.js

@@ -370,7 +370,8 @@ var MediaSingleNode = /*#__PURE__*/function (_Component) {
           contentWidth: contentWidthForLegacyExperience,
           containerWidth: containerWidth,
           gutterOffset: _mediaSingle.MEDIA_SINGLE_GUTTER_SIZE
-        })
+        }),
+        allowCaptions: mediaOptions.allowCaptions
       };
       var resizableMediaSingleProps = _objectSpread({
         view: view,
@@ -394,7 +395,7 @@ var MediaSingleNode = /*#__PURE__*/function (_Component) {
           canResize = canResize && !disabledNode;
         }
       }
-      var shouldShowPlaceholder = (0, _mediaCommon2.getMediaFeatureFlag)('captions', mediaOptions.featureFlags) && node.childCount !== 2 && isSelected && state.selection instanceof _state.NodeSelection;
+      var shouldShowPlaceholder = (mediaOptions.allowCaptions || (0, _mediaCommon2.getMediaFeatureFlag)('captions', mediaOptions.featureFlags)) && node.childCount !== 2 && isSelected && state.selection instanceof _state.NodeSelection;
       var MediaChildren = (0, _react.jsx)("figure", {
         ref: this.mediaSingleWrapperRef,
         css: [_styles.figureWrapper],

package/dist/cjs/plugins/media/pm-plugins/keymap.js

@@ -18,7 +18,7 @@ function keymapPlugin(options, editorAnalyticsAPI) {
     featureFlags = _ref.featureFlags;
   (0, _keymaps.bindKeymapWithCommand)(_keymaps.undo.common, ignoreLinksInSteps, list);
   (0, _keymaps.bindKeymapWithCommand)(_keymaps.enter.common, splitMediaGroup, list);
-  if ((0, _mediaCommon.getMediaFeatureFlag)('captions', featureFlags)) {
+  if (options !== null && options !== void 0 && options.allowCaptions || (0, _mediaCommon.getMediaFeatureFlag)('captions', featureFlags)) {
     (0, _keymaps.bindKeymapWithCommand)(_keymaps.moveDown.common, insertAndSelectCaption(editorAnalyticsAPI), list);
     (0, _keymaps.bindKeymapWithCommand)(_keymaps.tab.common, insertAndSelectCaption(editorAnalyticsAPI), list);
     (0, _keymaps.bindKeymapWithCommand)(_keymaps.moveLeft.common, arrowLeftFromMediaSingle(options === null || options === void 0 ? void 0 : options.editorSelectionAPI), list);

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/editor-core";
 exports.name = name;
-var version = "187.42.5";
+var version = "187.43.0";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/es2019/labs/next/presets/universal.js

@@ -119,7 +119,7 @@ export default function createUniversalPreset(appearance, props, featureFlags, p
     return builder;
   }).maybeAdd(captionPlugin, (plugin, builder) => {
     // EDM-799: inside caption plugin we do the feature flag in enabling the plugin
-    if (props.media && getMediaFeatureFlag('captions', props.media.featureFlags)) {
+    if (props.media && (props.media.allowCaptions || getMediaFeatureFlag('captions', props.media.featureFlags))) {
       return builder.add(plugin);
     }
     return builder;

package/dist/es2019/plugins/copy-button/pm-plugins/main.js

@@ -5,16 +5,16 @@ function getMarkSelectionDecorationStartAndEnd({
   markType,
   transaction
 }) {
-  const headHesolvedPos = transaction.selection.$head;
+  const headResolvedPos = transaction.selection.$head;
   const textNodeIndex = transaction.selection.$head.index();
-  const textNode = headHesolvedPos.parent.maybeChild(textNodeIndex);
+  const textNode = headResolvedPos.parent.maybeChild(textNodeIndex);
   let textNodeOffset = 0;
-  headHesolvedPos.parent.forEach((_node, nodeOffset, index) => {
+  headResolvedPos.parent.forEach((_node, nodeOffset, index) => {
     if (index === textNodeIndex) {
       textNodeOffset = nodeOffset;
     }
   });
-  const start = headHesolvedPos.start(headHesolvedPos.depth) + textNodeOffset;
+  const start = headResolvedPos.start(headResolvedPos.depth) + textNodeOffset;
   const end = start + textNode.text.length;
   return {
     start,

package/dist/es2019/plugins/media/index.js

@@ -60,15 +60,21 @@ const mediaPlugin = ({
       const {
         allowMediaGroup = true,
         allowMediaSingle = false,
+        allowCaptions,
         featureFlags: mediaFeatureFlags
       } = options || {};
-      const captions = getMediaFeatureFlag('captions', mediaFeatureFlags);
       const allowMediaInline = getMediaFeatureFlag('mediaInline', mediaFeatureFlags);
+      const withCaption = getMediaFeatureFlag('captions', mediaFeatureFlags);
+
+      // temporary mapping - we will support captions feature flag until
+      // confluence removes the feature flag support in their code base and
+      // utilizes allowCaptions media prop instead
+      const mappedAllowCaptions = allowCaptions ? allowCaptions : withCaption;
       const mediaSingleOption = getBooleanFF('platform.editor.media.extended-resize-experience') ? {
-        withCaption: captions,
+        withCaption: mappedAllowCaptions,
         withExtendedWidthTypes: true
       } : {
-        withCaption: captions,
+        withCaption: mappedAllowCaptions,
         withExtendedWidthTypes: false
       };
       const mediaSingleNode = mediaSingleSpec(mediaSingleOption);

package/dist/es2019/plugins/media/nodeviews/mediaSingle.js

@@ -277,7 +277,8 @@ export default class MediaSingleNode extends Component {
         contentWidth: contentWidthForLegacyExperience,
         containerWidth,
         gutterOffset: MEDIA_SINGLE_GUTTER_SIZE
-      })
+      }),
+      allowCaptions: mediaOptions.allowCaptions
     };
     const resizableMediaSingleProps = {
       view: view,
@@ -304,7 +305,7 @@ export default class MediaSingleNode extends Component {
         canResize = canResize && !disabledNode;
       }
     }
-    const shouldShowPlaceholder = getMediaFeatureFlag('captions', mediaOptions.featureFlags) && node.childCount !== 2 && isSelected && state.selection instanceof NodeSelection;
+    const shouldShowPlaceholder = (mediaOptions.allowCaptions || getMediaFeatureFlag('captions', mediaOptions.featureFlags)) && node.childCount !== 2 && isSelected && state.selection instanceof NodeSelection;
     const MediaChildren = jsx("figure", {
       ref: this.mediaSingleWrapperRef,
       css: [figureWrapper],

package/dist/es2019/plugins/media/pm-plugins/keymap.js

@@ -12,7 +12,7 @@ export function keymapPlugin(options, editorAnalyticsAPI) {
   } = options || {};
   bindKeymapWithCommand(undo.common, ignoreLinksInSteps, list);
   bindKeymapWithCommand(enter.common, splitMediaGroup, list);
-  if (getMediaFeatureFlag('captions', featureFlags)) {
+  if (options !== null && options !== void 0 && options.allowCaptions || getMediaFeatureFlag('captions', featureFlags)) {
     bindKeymapWithCommand(moveDown.common, insertAndSelectCaption(editorAnalyticsAPI), list);
     bindKeymapWithCommand(tab.common, insertAndSelectCaption(editorAnalyticsAPI), list);
     bindKeymapWithCommand(moveLeft.common, arrowLeftFromMediaSingle(options === null || options === void 0 ? void 0 : options.editorSelectionAPI), list);

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/editor-core";
-export const version = "187.42.5";
+export const version = "187.43.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/labs/next/presets/universal.js

@@ -123,7 +123,7 @@ export default function createUniversalPreset(appearance, props, featureFlags, p
     return builder;
   }).maybeAdd(captionPlugin, function (plugin, builder) {
     // EDM-799: inside caption plugin we do the feature flag in enabling the plugin
-    if (props.media && getMediaFeatureFlag('captions', props.media.featureFlags)) {
+    if (props.media && (props.media.allowCaptions || getMediaFeatureFlag('captions', props.media.featureFlags))) {
       return builder.add(plugin);
     }
     return builder;

package/dist/esm/plugins/copy-button/pm-plugins/main.js

@@ -4,16 +4,16 @@ import { copyButtonPluginKey } from './plugin-key';
 function getMarkSelectionDecorationStartAndEnd(_ref) {
   var markType = _ref.markType,
     transaction = _ref.transaction;
-  var headHesolvedPos = transaction.selection.$head;
+  var headResolvedPos = transaction.selection.$head;
   var textNodeIndex = transaction.selection.$head.index();
-  var textNode = headHesolvedPos.parent.maybeChild(textNodeIndex);
+  var textNode = headResolvedPos.parent.maybeChild(textNodeIndex);
   var textNodeOffset = 0;
-  headHesolvedPos.parent.forEach(function (_node, nodeOffset, index) {
+  headResolvedPos.parent.forEach(function (_node, nodeOffset, index) {
     if (index === textNodeIndex) {
       textNodeOffset = nodeOffset;
     }
   });
-  var start = headHesolvedPos.start(headHesolvedPos.depth) + textNodeOffset;
+  var start = headResolvedPos.start(headResolvedPos.depth) + textNodeOffset;
   var end = start + textNode.text.length;
   return {
     start: start,

package/dist/esm/plugins/media/index.js

@@ -60,14 +60,20 @@ var mediaPlugin = function mediaPlugin(_ref2) {
         allowMediaGroup = _ref3$allowMediaGroup === void 0 ? true : _ref3$allowMediaGroup,
         _ref3$allowMediaSingl = _ref3.allowMediaSingle,
         allowMediaSingle = _ref3$allowMediaSingl === void 0 ? false : _ref3$allowMediaSingl,
+        allowCaptions = _ref3.allowCaptions,
         mediaFeatureFlags = _ref3.featureFlags;
-      var captions = getMediaFeatureFlag('captions', mediaFeatureFlags);
       var allowMediaInline = getMediaFeatureFlag('mediaInline', mediaFeatureFlags);
+      var withCaption = getMediaFeatureFlag('captions', mediaFeatureFlags);
+
+      // temporary mapping - we will support captions feature flag until
+      // confluence removes the feature flag support in their code base and
+      // utilizes allowCaptions media prop instead
+      var mappedAllowCaptions = allowCaptions ? allowCaptions : withCaption;
       var mediaSingleOption = getBooleanFF('platform.editor.media.extended-resize-experience') ? {
-        withCaption: captions,
+        withCaption: mappedAllowCaptions,
         withExtendedWidthTypes: true
       } : {
-        withCaption: captions,
+        withCaption: mappedAllowCaptions,
         withExtendedWidthTypes: false
       };
       var mediaSingleNode = mediaSingleSpec(mediaSingleOption);

package/dist/esm/plugins/media/nodeviews/mediaSingle.js

@@ -361,7 +361,8 @@ var MediaSingleNode = /*#__PURE__*/function (_Component) {
           contentWidth: contentWidthForLegacyExperience,
           containerWidth: containerWidth,
           gutterOffset: MEDIA_SINGLE_GUTTER_SIZE
-        })
+        }),
+        allowCaptions: mediaOptions.allowCaptions
       };
       var resizableMediaSingleProps = _objectSpread({
         view: view,
@@ -385,7 +386,7 @@ var MediaSingleNode = /*#__PURE__*/function (_Component) {
           canResize = canResize && !disabledNode;
         }
       }
-      var shouldShowPlaceholder = getMediaFeatureFlag('captions', mediaOptions.featureFlags) && node.childCount !== 2 && isSelected && state.selection instanceof NodeSelection;
+      var shouldShowPlaceholder = (mediaOptions.allowCaptions || getMediaFeatureFlag('captions', mediaOptions.featureFlags)) && node.childCount !== 2 && isSelected && state.selection instanceof NodeSelection;
       var MediaChildren = jsx("figure", {
         ref: this.mediaSingleWrapperRef,
         css: [figureWrapper],

package/dist/esm/plugins/media/pm-plugins/keymap.js

@@ -11,7 +11,7 @@ export function keymapPlugin(options, editorAnalyticsAPI) {
     featureFlags = _ref.featureFlags;
   bindKeymapWithCommand(undo.common, ignoreLinksInSteps, list);
   bindKeymapWithCommand(enter.common, splitMediaGroup, list);
-  if (getMediaFeatureFlag('captions', featureFlags)) {
+  if (options !== null && options !== void 0 && options.allowCaptions || getMediaFeatureFlag('captions', featureFlags)) {
     bindKeymapWithCommand(moveDown.common, insertAndSelectCaption(editorAnalyticsAPI), list);
     bindKeymapWithCommand(tab.common, insertAndSelectCaption(editorAnalyticsAPI), list);
     bindKeymapWithCommand(moveLeft.common, arrowLeftFromMediaSingle(options === null || options === void 0 ? void 0 : options.editorSelectionAPI), list);

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/editor-core";
-export var version = "187.42.5";
+export var version = "187.43.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/plugins/media/types.d.ts

@@ -42,6 +42,7 @@ export interface MediaOptions {
     editorSelectionAPI?: EditorSelectionAPI;
     featureFlags?: MediaFeatureFlags;
     getEditorFeatureFlags?: GetEditorFeatureFlags;
+    allowCaptions?: boolean;
 }
 export interface MediaSingleOptions {
     disableLayout?: boolean;

package/dist/types-ts4.5/plugins/media/types.d.ts

@@ -42,6 +42,7 @@ export interface MediaOptions {
     editorSelectionAPI?: EditorSelectionAPI;
     featureFlags?: MediaFeatureFlags;
     getEditorFeatureFlags?: GetEditorFeatureFlags;
+    allowCaptions?: boolean;
 }
 export interface MediaSingleOptions {
     disableLayout?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-core",
-  "version": "187.42.5",
+  "version": "187.43.0",
   "description": "A package contains Atlassian editor core functionality",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -167,7 +167,7 @@
     "@atlaskit/media-test-helpers": "^33.0.0",
     "@atlaskit/menu": "^1.10.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",
-    "@atlaskit/renderer": "^108.11.0",
+    "@atlaskit/renderer": "^108.12.0",
     "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/smart-user-picker": "^6.3.0",
     "@atlaskit/synchrony-test-helpers": "^2.3.0",

package/report.api.md

@@ -1206,6 +1206,8 @@ export interface MediaOptions {
   // (undocumented)
   allowBreakoutSnapPoints?: boolean;
   // (undocumented)
+  allowCaptions?: boolean;
+  // (undocumented)
   allowDropzoneDropLine?: boolean;
   // (undocumented)
   allowLazyLoading?: boolean;

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

@@ -1092,6 +1092,8 @@ export interface MediaOptions {
     // (undocumented)
     allowBreakoutSnapPoints?: boolean;
     // (undocumented)
+    allowCaptions?: boolean;
+    // (undocumented)
     allowDropzoneDropLine?: boolean;
     // (undocumented)
     allowLazyLoading?: boolean;