@atlaskit/adf-schema 25.3.2 → 25.5.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @atlaskit/adf-schema
 
+## 25.5.0
+
+### Minor Changes
+
+- [`0237059f136`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0237059f136) - Adds `LinkMetaStep` prosemirror step to be used to annotate a transaction with metadata about how (action, input method etc) for how a transaction has been performed.
+
+### Patch Changes
+
+- [`2e01c9c74b5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2e01c9c74b5) - DUMMY remove before merging to master; dupe adf-schema via adf-utils
+- Updated dependencies
+
+## 25.4.0
+
+### Minor Changes
+
+- [`bf04c417bfd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bf04c417bfd) - Add "border" mark to stage0 ADF schema
+- [`af9a85063e5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/af9a85063e5) - add image border toolbar
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 25.3.2
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -339,6 +339,18 @@ Object.defineProperty(exports, "bodiedExtension", {
     return _schema.bodiedExtension;
   }
 });
+Object.defineProperty(exports, "border", {
+  enumerable: true,
+  get: function get() {
+    return _schema.border;
+  }
+});
+Object.defineProperty(exports, "borderColorPalette", {
+  enumerable: true,
+  get: function get() {
+    return _schema.borderColorPalette;
+  }
+});
 Object.defineProperty(exports, "breakout", {
   enumerable: true,
   get: function get() {

package/dist/cjs/schema/create-schema.js

@@ -254,6 +254,9 @@ var marksInOrder = [{
 }, {
   name: 'indentation',
   spec: _marks.indentation
+}, {
+  name: 'border',
+  spec: _marks.border
 }, {
   name: 'unsupportedMark',
   spec: _marks.unsupportedMark

package/dist/cjs/schema/default-schema.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getSchemaBasedOnStage = exports.defaultSchemaConfig = exports.defaultSchema = void 0;
 var _nodes = require("./nodes");
+var _marks = require("./marks");
 var _createSchema = require("./create-schema");
 var getDefaultSchemaConfig = function getDefaultSchemaConfig() {
   var defaultSchemaConfig = {
@@ -24,6 +25,9 @@ var getSchemaBasedOnStage = function getSchemaBasedOnStage() {
     defaultSchemaConfig.customNodeSpecs = {
       layoutSection: _nodes.layoutSectionWithSingleColumn
     };
+    defaultSchemaConfig.customMarkSpecs = {
+      border: _marks.border
+    };
   }
   return (0, _createSchema.createSchema)(defaultSchemaConfig);
 };

package/dist/cjs/schema/index.js

@@ -57,6 +57,18 @@ Object.defineProperty(exports, "bodiedExtension", {
     return _nodes.bodiedExtension;
   }
 });
+Object.defineProperty(exports, "border", {
+  enumerable: true,
+  get: function get() {
+    return _marks.border;
+  }
+});
+Object.defineProperty(exports, "borderColorPalette", {
+  enumerable: true,
+  get: function get() {
+    return _marks.borderColorPalette;
+  }
+});
 Object.defineProperty(exports, "breakout", {
   enumerable: true,
   get: function get() {

package/dist/cjs/schema/jira-schema.js

@@ -16,6 +16,10 @@ exports.isSchemaWithSubSupMark = isSchemaWithSubSupMark;
 exports.isSchemaWithTables = isSchemaWithTables;
 exports.isSchemaWithTextColor = isSchemaWithTextColor;
 var _createSchema = require("./create-schema");
+/**
+ * @deprecated [ED-15676] We have stopped supporting product specific schemas. Use `@atlaskit/adf-schema/schema-default` instead.
+ **/
+
 /**
  * @deprecated [ED-15676] We have stopped supporting product specific schemas. Use `@atlaskit/adf-schema/schema-default` instead.
  **/

package/dist/cjs/schema/marks/alignment.js

@@ -11,6 +11,10 @@ var alignmentPositionMap = {
   right: 'end',
   center: 'center'
 };
+
+/**
+ * @name alignment_mark
+ */
 exports.alignmentPositionMap = alignmentPositionMap;
 var alignment = {
   excludes: "alignment ".concat(_groups.INDENTATION),

package/dist/cjs/schema/marks/border.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.borderColorPalette = exports.border = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _editorPalette = require("@atlaskit/editor-palette");
+var _colors = require("../../utils/colors");
+/**
+ * @name border_mark
+ * @stage 0
+ * @description This mark adds decoration to an element, and any element decorated with it will also have a border style.
+ */
+
+var borderColorArrayPalette = [[_colors.N300A, 'Subtle gray'], [_colors.N600, 'Gray'], [_colors.N1000, 'Bold gray']];
+var borderColorPalette = new Map();
+exports.borderColorPalette = borderColorPalette;
+borderColorArrayPalette.forEach(function (_ref) {
+  var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+    color = _ref2[0],
+    label = _ref2[1];
+  return borderColorPalette.set(color.toLowerCase(), label);
+});
+var border = {
+  inclusive: false,
+  parseDOM: [{
+    tag: 'div[data-mark-type="border"]',
+    getAttrs: function getAttrs(domNode) {
+      var _dom$getAttribute, _dom$getAttribute2;
+      var dom = domNode;
+      var color = ((_dom$getAttribute = dom.getAttribute('data-color')) !== null && _dom$getAttribute !== void 0 ? _dom$getAttribute : '').toLowerCase();
+      var size = +((_dom$getAttribute2 = dom.getAttribute('data-size')) !== null && _dom$getAttribute2 !== void 0 ? _dom$getAttribute2 : '0');
+      return {
+        size: size > 3 ? 3 : size < 1 ? false : size,
+        color: borderColorPalette.has(color) ? color : false
+      };
+    }
+  }],
+  attrs: {
+    color: {},
+    size: {}
+  },
+  toDOM: function toDOM(mark) {
+    // Note -- while there is no way to create custom colors using default tooling
+    // the editor does supported ad hoc color values -- and there may be content
+    // which has been migrated or created via apis which use such values.
+    var paletteColorValue = (0, _editorPalette.hexToEditorBorderPaletteColor)(mark.attrs.color) || mark.attrs.color;
+    return ['div', {
+      'data-mark-type': 'border',
+      'data-color': mark.attrs.color,
+      'data-size': mark.attrs.size,
+      style: "--custom-palette-color: ".concat(paletteColorValue)
+    }];
+  }
+};
+exports.border = border;

package/dist/cjs/schema/marks/breakout.js

@@ -5,6 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.breakout = void 0;
 var allowedTypes = ['wide', 'full-width'];
+
+/**
+ * @name breakout_mark
+ */
+
 var breakout = {
   spanning: false,
   inclusive: false,

package/dist/cjs/schema/marks/code.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.code = void 0;
 var _groups = require("../groups");
+/**
+ * @name code_mark
+ */
+
 var code = {
   excludes: "".concat(_groups.FONT_STYLE, " ").concat(_groups.LINK, " ").concat(_groups.SEARCH_QUERY, " ").concat(_groups.COLOR),
   inclusive: true,

package/dist/cjs/schema/marks/data-consumer.js

@@ -5,6 +5,23 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.toJSON = exports.dataConsumer = void 0;
 var _parseDOM = require("../../utils/parseDOM");
+/**
+ * This annotation is purely for reference, & does _nothing_ given annotating
+ * `minLength` on an array of strings is not supported with our schema+spec
+ * generator.
+ *
+ * We're keeping it to signal that data consumer `sources` shouldn't be empty
+ * strings
+ *
+ * // @minLength 1
+ */
+
+/**
+ * @name dataConsumer_mark
+ * @description This mark is used for metadata surrounding a node consuming data
+ * from a given source node
+ */
+
 var parseDataConsumer = function parseDataConsumer(maybeValue) {
   var sources = (0, _parseDOM.isDOMElement)(maybeValue) && maybeValue.getAttribute('data-sources');
   try {

package/dist/cjs/schema/marks/em.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.em = void 0;
 var _groups = require("../groups");
+/**
+ * @name em_mark
+ */
+
 var emDOM = ['em'];
 var em = {
   inclusive: true,

package/dist/cjs/schema/marks/fragment.js

@@ -9,6 +9,12 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _parseDOM = require("../../utils/parseDOM");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/**
+ * @name fragment_mark
+ * @description Indicates that the elements decorated with this mark belong to a "fragment" entity, which represents a collection of ADF nodes.
+ * This entity can be referred to later by its `localId` attribute.
+ */
+
 var parseFragment = function parseFragment(maybeValue) {
   var _maybeValue$getAttrib;
   if (!(0, _parseDOM.isDOMElement)(maybeValue)) {

package/dist/cjs/schema/marks/indentation.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.indentation = void 0;
 var _groups = require("../groups");
+/**
+ * @name indentation_mark
+ */
+
 var indentation = {
   excludes: "indentation ".concat(_groups.ALIGNMENT),
   group: _groups.INDENTATION,

package/dist/cjs/schema/marks/index.js

@@ -33,6 +33,18 @@ Object.defineProperty(exports, "annotation", {
     return _annotation.annotation;
   }
 });
+Object.defineProperty(exports, "border", {
+  enumerable: true,
+  get: function get() {
+    return _border.border;
+  }
+});
+Object.defineProperty(exports, "borderColorPalette", {
+  enumerable: true,
+  get: function get() {
+    return _border.borderColorPalette;
+  }
+});
 Object.defineProperty(exports, "breakout", {
   enumerable: true,
   get: function get() {
@@ -182,4 +194,5 @@ var _annotation = require("./annotation");
 var _unsupportedMark = require("./unsupported-mark");
 var _unsupportedNodeAttributes = require("./unsupported-node-attributes");
 var _dataConsumer = require("./data-consumer");
-var _fragment = require("./fragment");
+var _fragment = require("./fragment");
+var _border = require("./border");

package/dist/cjs/schema/marks/link.js

@@ -10,6 +10,10 @@ var _groups = require("../groups");
 var _url = require("../../utils/url");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/**
+ * @name link_mark
+ */
+
 var getLinkAttrs = function getLinkAttrs(attribute) {
   return function (domNode) {
     var dom = domNode;

package/dist/cjs/schema/marks/strike.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.strike = void 0;
 var _groups = require("../groups");
+/**
+ * @name strike_mark
+ */
+
 var strike = {
   inclusive: true,
   group: _groups.FONT_STYLE,

package/dist/cjs/schema/marks/strong.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.strong = void 0;
 var _groups = require("../groups");
+/**
+ * @name strong_mark
+ */
+
 var strongDOM = ['strong'];
 var strong = {
   inclusive: true,

package/dist/cjs/schema/marks/subsup.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.subsup = void 0;
 var _groups = require("../groups");
+/**
+ * @name subsup_mark
+ */
+
 function getAttrFromVerticalAlign(node) {
   if (node.style.verticalAlign) {
     var type = node.style.verticalAlign.slice(0, 3);

package/dist/cjs/schema/marks/text-color.js

@@ -10,6 +10,10 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _editorPalette = require("@atlaskit/editor-palette");
 var _groups = require("../groups");
 var _colors = require("../../utils/colors");
+/**
+ * @name textColor_mark
+ */
+
 // used for extended palette in text color picker
 var colorArrayPalette = [
 // default row - first color is added programatically

package/dist/cjs/schema/marks/underline.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.underline = void 0;
 var _groups = require("../groups");
+/**
+ * @name underline_mark
+ */
+
 var underline = {
   inclusive: true,
   group: _groups.FONT_STYLE,

package/dist/cjs/schema/nodes/bodied-extension.js

@@ -5,6 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.bodiedExtension = void 0;
 var _extensions = require("../../utils/extensions");
+/**
+ * @name bodiedExtension_node
+ */
+
+/**
+ * @name bodiedExtension_with_marks_node
+ */
+
 var createBodiedExtensionNodeSpec = function createBodiedExtensionNodeSpec() {
   var nodeSpec = {
     inline: false,

package/dist/cjs/schema/nodes/code-block.js

@@ -5,6 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.toJSON = exports.codeBlock = void 0;
 var _prosemirrorModel = require("prosemirror-model");
+/**
+ * @name codeBlock_node
+ */
+
+/**
+ * @name codeBlock_with_no_marks_node
+ */
+
+/**
+ * @name codeBlock_with_marks_node
+ */
+
 var getLanguageFromEditorStyle = function getLanguageFromEditorStyle(dom) {
   return dom.getAttribute('data-language') || undefined;
 };

package/dist/cjs/schema/nodes/decision-item.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.decisionItem = void 0;
 var _uuid = require("../../utils/uuid");
+/**
+ * @name decisionItem_node
+ */
+
 var decisionItem = {
   content: 'inline*',
   defining: true,

package/dist/cjs/schema/nodes/decision-list.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.decisionListSelector = exports.decisionList = void 0;
 var _uuid = require("../../utils/uuid");
+/**
+ * @name decisionList_node
+ */
+
 var name = 'decisionList';
 var decisionListSelector = "[data-node-type=\"".concat(name, "\"]");
 exports.decisionListSelector = decisionListSelector;

package/dist/cjs/schema/nodes/emoji.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.emoji = void 0;
 var _emoji = require("../../utils/confluence/emoji");
+/**
+ * @name emoji_node
+ */
+
 var emoji = {
   inline: true,
   group: 'inline',

package/dist/cjs/schema/nodes/extension.js

@@ -5,6 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.extension = void 0;
 var _extensions = require("../../utils/extensions");
+/**
+ * @name extension_node
+ */
+
+/**
+ * @name extension_with_marks_node
+ */
+
 var createExtensionNodeSpec = function createExtensionNodeSpec() {
   var nodeSpec = {
     inline: false,

package/dist/cjs/schema/nodes/inline-extension.js

@@ -5,6 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.inlineExtension = void 0;
 var _extensions = require("../../utils/extensions");
+/**
+ * @name inlineExtension_node
+ */
+
+/**
+ * @name inlineExtension_with_marks_node
+ */
+
 var createInlineExtensionNodeSpec = function createInlineExtensionNodeSpec() {
   var nodeSpec = {
     inline: true,

package/dist/cjs/schema/nodes/media-group.js

@@ -8,12 +8,15 @@ exports.mediaGroup = void 0;
  * @name mediaGroup_node
  */
 
+// Temporary due to an existing issue in validator below:
+// https://product-fabric.atlassian.net/jira/servicedesk/projects/DTR/queues/issue/DTR-1429
+// TODO: Remove border and link marks from white list
 var mediaGroup = {
   inline: false,
   group: 'block',
   content: '(media|unsupportedBlock)+',
   attrs: {},
-  marks: 'unsupportedMark unsupportedNodeAttribute',
+  marks: 'unsupportedMark unsupportedNodeAttribute border link',
   selectable: false,
   parseDOM: [{
     tag: 'div[data-node-type="mediaGroup"]'

package/dist/cjs/schema/nodes/media-inline.js

@@ -5,5 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.mediaInline = void 0;
 var _media = require("./media");
+/**
+ * @name mediaInline_node
+ */
+
 var mediaInline = (0, _media.createMediaSpec)(_media.defaultAttrs, true);
 exports.mediaInline = mediaInline;

package/dist/cjs/schema/nodes/media-single.js

@@ -46,7 +46,7 @@ var mediaSingle = {
   atom: true,
   content: 'media|unsupportedBlock+|media unsupportedBlock+',
   attrs: defaultAttrs,
-  marks: 'unsupportedMark unsupportedNodeAttribute link',
+  marks: 'unsupportedMark unsupportedNodeAttribute border link',
   parseDOM: [{
     tag: 'div[data-node-type="mediaSingle"]',
     getAttrs: function getAttrs(dom) {

package/dist/cjs/schema/nodes/media.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.toJSON = exports.media = exports.defaultAttrs = exports.createMediaSpec = exports.copyPrivateAttributes = exports.camelCaseToKebabCase = void 0;
 var _colors = require("../../utils/colors");
+/**
+ * @name media_node
+ */
+
 var defaultAttrs = {
   id: {
     default: ''

package/dist/cjs/schema/nodes/mention.js

@@ -11,6 +11,9 @@ exports.USER_TYPES = USER_TYPES;
   USER_TYPES["SPECIAL"] = "SPECIAL";
   USER_TYPES["APP"] = "APP";
 })(USER_TYPES || (exports.USER_TYPES = USER_TYPES = {}));
+/**
+ * @name mention_node
+ */
 var mention = {
   inline: true,
   group: 'inline',

package/dist/cjs/schema/nodes/panel.js

@@ -19,6 +19,9 @@ exports.PanelType = PanelType;
   PanelType["SUCCESS"] = "success";
   PanelType["CUSTOM"] = "custom";
 })(PanelType || (exports.PanelType = PanelType = {}));
+/**
+ * @name panel_node
+ */
 var getDefaultAttrs = function getDefaultAttrs() {
   var attrs = {
     panelType: {

package/dist/cjs/schema/nodes/paragraph.js

@@ -20,15 +20,12 @@ exports.paragraph = void 0;
  * type T1 = X | Y
  * type T2 = A | T1 | B // T2 = A | X | Y | B
  */
-
 /**
  * @name paragraph_with_alignment_node
  */
-
 /**
  * @name paragraph_with_indentation_node
  */
-
 var isImageNode = function isImageNode(node) {
   return Boolean(node && node.nodeName.toLowerCase() === 'img');
 };

package/dist/cjs/schema/nodes/status.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.status = void 0;
 var _uuid = require("../../utils/uuid");
+/**
+ * @name status_node
+ */
+
 var status = {
   inline: true,
   group: 'inline',

package/dist/cjs/schema/nodes/tableNodes.js

@@ -134,6 +134,29 @@ exports.tableBackgroundColorNames = tableBackgroundColorNames;
   tableBackgroundColorPalette.set(colorValue.toLowerCase(), colorName);
   tableBackgroundColorNames.set(colorName.toLowerCase(), colorValue.toLowerCase());
 });
+
+/**
+ * @name table_node
+ */
+
+/**
+ * @name table_row_node
+ */
+
+/**
+ * @name table_cell_content
+ * @minItems 1
+ * @allowUnsupportedBlock true
+ */
+
+/**
+ * @name table_cell_node
+ */
+
+/**
+ * @name table_header_node
+ */
+
 // TODO: Fix any, potential issue. ED-5048
 var createTableSpec = function createTableSpec() {
   var attrs = {

package/dist/cjs/schema/nodes/task-item.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.taskItem = void 0;
 var _uuid = require("../../utils/uuid");
+/**
+ * @name taskItem_node
+ */
+
 var taskItem = {
   content: 'inline*',
   defining: true,

package/dist/cjs/schema/nodes/task-list.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.taskListSelector = exports.taskList = void 0;
 var _uuid = require("../../utils/uuid");
+/**
+ * @name taskList_node
+ */
+
 var name = 'actionList';
 var taskListSelector = "[data-node-type=\"".concat(name, "\"]");
 exports.taskListSelector = taskListSelector;