@atlaskit/adf-schema 25.4.0 → 25.5.1

package/dist/es2019/steps/type-ahead.js

@@ -1,11 +1,11 @@
 import { Slice } from 'prosemirror-model';
 import { ReplaceStep, Step, StepMap, StepResult } from 'prosemirror-transform';
 export const insertTypeAheadStepType = 'atlaskit-insert-type-ahead';
-export let InsertTypeAheadStages;
-(function (InsertTypeAheadStages) {
+export let InsertTypeAheadStages = /*#__PURE__*/function (InsertTypeAheadStages) {
   InsertTypeAheadStages["DELETING_RAW_QUERY"] = "DELETING_RAW_QUERY";
   InsertTypeAheadStages["INSERTING_ITEM"] = "INSERTING_ITEM";
-})(InsertTypeAheadStages || (InsertTypeAheadStages = {}));
+  return InsertTypeAheadStages;
+}({});
 export class InsertTypeAheadStep extends Step {
   constructor({
     stage,

package/dist/es2019/steps.js

@@ -3,4 +3,5 @@ export { TableSortStep } from './steps/table/sort-column';
 export { InsertTypeAheadStages, InsertTypeAheadStep } from './steps/type-ahead';
 export { AddColumnStep } from './steps/table/add-column';
 export { SetAttrsStep } from './steps/set-attrs';
-export { AnalyticsStep } from './steps/analytics';
+export { AnalyticsStep } from './steps/analytics';
+export { LinkMetaStep } from './steps/link-meta-step';

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "25.4.0",
+	"version": "25.5.1",
 	"sideEffects": false
 }

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

@@ -1,4 +1,9 @@
 import { createSchema } from './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/esm/schema/marks/alignment.js

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

package/dist/esm/schema/marks/annotation.js

@@ -5,15 +5,15 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  * @name annotation_mark
  */
 
-export var AnnotationTypes;
-(function (AnnotationTypes) {
+export var AnnotationTypes = /*#__PURE__*/function (AnnotationTypes) {
   AnnotationTypes["INLINE_COMMENT"] = "inlineComment";
-})(AnnotationTypes || (AnnotationTypes = {}));
-export var AnnotationMarkStates;
-(function (AnnotationMarkStates) {
+  return AnnotationTypes;
+}({});
+export var AnnotationMarkStates = /*#__PURE__*/function (AnnotationMarkStates) {
   AnnotationMarkStates["RESOLVED"] = "resolved";
   AnnotationMarkStates["ACTIVE"] = "active";
-})(AnnotationMarkStates || (AnnotationMarkStates = {}));
+  return AnnotationMarkStates;
+}({});
 export function buildDataAttributes(_ref) {
   var id = _ref.id,
     annotationType = _ref.annotationType,

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

@@ -1,6 +1,13 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { hexToEditorBorderPaletteColor } from '@atlaskit/editor-palette';
 import { N300A, N600, N1000 } from '../../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 = [[N300A, 'Subtle gray'], [N600, 'Gray'], [N1000, 'Bold gray']];
 export var borderColorPalette = new Map();
 borderColorArrayPalette.forEach(function (_ref) {

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

@@ -1,4 +1,9 @@
 var allowedTypes = ['wide', 'full-width'];
+
+/**
+ * @name breakout_mark
+ */
+
 export var breakout = {
   spanning: false,
   inclusive: false,

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

@@ -11,6 +11,12 @@ import { isDOMElement } from '../../utils/parseDOM';
  * // @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 = isDOMElement(maybeValue) && maybeValue.getAttribute('data-sources');
   try {

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

@@ -2,6 +2,13 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _defineProperty(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; }
 import { isDOMElement } from '../../utils/parseDOM';
+
+/**
+ * @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 (!isDOMElement(maybeValue)) {

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

@@ -1,4 +1,9 @@
 import { ALIGNMENT, INDENTATION } from '../groups';
+
+/**
+ * @name indentation_mark
+ */
+
 export var indentation = {
   excludes: "indentation ".concat(ALIGNMENT),
   group: INDENTATION,

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

@@ -3,6 +3,11 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 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) { _defineProperty(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; }
 import { LINK } from '../groups';
 import { isRootRelative, isSafeUrl, normalizeUrl } from '../../utils/url';
+
+/**
+ * @name link_mark
+ */
+
 var getLinkAttrs = function getLinkAttrs(attribute) {
   return function (domNode) {
     var dom = domNode;

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

@@ -1,4 +1,9 @@
 import { FONT_STYLE } from '../groups';
+
+/**
+ * @name subsup_mark
+ */
+
 function getAttrFromVerticalAlign(node) {
   if (node.style.verticalAlign) {
     var type = node.style.verticalAlign.slice(0, 3);

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

@@ -3,6 +3,11 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { hexToEditorTextPaletteColor } from '@atlaskit/editor-palette';
 import { COLOR } from '../groups';
 import { rgbToHex, N0, N80, P50, P300, P500, T75, T300, T500, G75, G300, G500, R75, R300, R500, Y75, Y200, Y400, B75, B100, B500 } from '../../utils/colors';
+
+/**
+ * @name textColor_mark
+ */
+
 // used for extended palette in text color picker
 var colorArrayPalette = [
 // default row - first color is added programatically

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

@@ -1,4 +1,13 @@
 import { getExtensionAttrs } from '../../utils/extensions';
+
+/**
+ * @name bodiedExtension_node
+ */
+
+/**
+ * @name bodiedExtension_with_marks_node
+ */
+
 var createBodiedExtensionNodeSpec = function createBodiedExtensionNodeSpec() {
   var nodeSpec = {
     inline: false,

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

@@ -1,4 +1,17 @@
 import { Fragment } from '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/esm/schema/nodes/decision-item.js

@@ -1,4 +1,9 @@
 import { uuid } from '../../utils/uuid';
+
+/**
+ * @name decisionItem_node
+ */
+
 export var decisionItem = {
   content: 'inline*',
   defining: true,

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

@@ -1,4 +1,13 @@
 import { getExtensionAttrs } from '../../utils/extensions';
+
+/**
+ * @name extension_node
+ */
+
+/**
+ * @name extension_with_marks_node
+ */
+
 var createExtensionNodeSpec = function createExtensionNodeSpec() {
   var nodeSpec = {
     inline: false,

package/dist/esm/schema/nodes/heading.js

@@ -10,11 +10,9 @@
 /**
  * @name heading_with_alignment_node
  */
-
 /**
  * @name heading_with_indentation_node
  */
-
 export var heading = {
   attrs: {
     level: {

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

@@ -1,4 +1,13 @@
 import { getExtensionAttrs } from '../../utils/extensions';
+
+/**
+ * @name inlineExtension_node
+ */
+
+/**
+ * @name inlineExtension_with_marks_node
+ */
+
 var createInlineExtensionNodeSpec = function createInlineExtensionNodeSpec() {
   var nodeSpec = {
     inline: true,

package/dist/esm/schema/nodes/layout-section.js

@@ -5,16 +5,13 @@
 /**
  * Need duplicate `type` and `marks` to make both validator and json-schema satisfied
  */
-
 /**
  * @name layoutSection_full_node
  */
-
 /**
  * @stage 0
  * @name layoutSection_with_single_column_node
  */
-
 export var layoutSection = {
   content: '(layoutColumn | unsupportedBlock){1,3} unsupportedBlock* | unsupportedBlock+',
   marks: 'unsupportedMark unsupportedNodeAttribute',

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

@@ -1,2 +1,7 @@
 import { createMediaSpec, defaultAttrs } from './media';
+
+/**
+ * @name mediaInline_node
+ */
+
 export var mediaInline = createMediaSpec(defaultAttrs, true);

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

@@ -1,4 +1,9 @@
 import { N30 } from '../../utils/colors';
+
+/**
+ * @name media_node
+ */
+
 export var defaultAttrs = {
   id: {
     default: ''

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

@@ -1,9 +1,14 @@
-export var USER_TYPES;
-(function (USER_TYPES) {
+export var USER_TYPES = /*#__PURE__*/function (USER_TYPES) {
   USER_TYPES["DEFAULT"] = "DEFAULT";
   USER_TYPES["SPECIAL"] = "SPECIAL";
   USER_TYPES["APP"] = "APP";
-})(USER_TYPES || (USER_TYPES = {}));
+  return USER_TYPES;
+}({});
+
+/**
+ * @name mention_node
+ */
+
 export var mention = {
   inline: true,
   group: 'inline',

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

@@ -1,8 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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) { _defineProperty(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; }
-export var PanelType;
-(function (PanelType) {
+export var PanelType = /*#__PURE__*/function (PanelType) {
   PanelType["INFO"] = "info";
   PanelType["NOTE"] = "note";
   PanelType["TIP"] = "tip";
@@ -10,7 +9,13 @@ export var PanelType;
   PanelType["ERROR"] = "error";
   PanelType["SUCCESS"] = "success";
   PanelType["CUSTOM"] = "custom";
-})(PanelType || (PanelType = {}));
+  return PanelType;
+}({});
+
+/**
+ * @name panel_node
+ */
+
 var getDefaultAttrs = function getDefaultAttrs() {
   var attrs = {
     panelType: {

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

@@ -14,15 +14,12 @@
  * 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/esm/schema/nodes/tableNodes.js

@@ -117,6 +117,29 @@ export var tableBackgroundColorNames = new Map();
   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/esm/schema/nodes/task-item.js

@@ -1,4 +1,9 @@
 import { uuid } from '../../utils/uuid';
+
+/**
+ * @name taskItem_node
+ */
+
 export var taskItem = {
   content: 'inline*',
   defining: true,

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

@@ -1,4 +1,9 @@
 import { uuid } from '../../utils/uuid';
+
+/**
+ * @name taskList_node
+ */
+
 var name = 'actionList';
 export var taskListSelector = "[data-node-type=\"".concat(name, "\"]");
 export var taskList = {

package/dist/esm/steps/analytics.js

@@ -14,11 +14,11 @@ import { Step, StepResult, StepMap, ReplaceStep } from 'prosemirror-transform';
 import { Slice } from 'prosemirror-model';
 export var analyticsStepType = 'atlaskit-analytics';
 export var analyticsInvertStepType = 'atlaskit-analytics-invert';
-var HISTORY_ACTIONS;
-(function (HISTORY_ACTIONS) {
+var HISTORY_ACTIONS = /*#__PURE__*/function (HISTORY_ACTIONS) {
   HISTORY_ACTIONS["UNDID"] = "undid";
   HISTORY_ACTIONS["REDID"] = "redid";
-})(HISTORY_ACTIONS || (HISTORY_ACTIONS = {}));
+  return HISTORY_ACTIONS;
+}(HISTORY_ACTIONS || {});
 /** Creates undo event from a normal analytics event */
 function createUndoEvent(analyticsEvent) {
   var _analyticsEvent$paylo;

package/dist/esm/steps/link-meta-step.js

@@ -0,0 +1,103 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+var _excluded = ["sourceEvent"];
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+import { Slice } from 'prosemirror-model';
+import { ReplaceStep, Step, StepMap, StepResult } from 'prosemirror-transform';
+export var stepType = 'editor-linking-meta';
+export var invertStepType = 'editor-linking-meta-invert';
+/**
+ * Custom Prosemirror Step to attach metadata about user interactions with links
+ * Using a Step means that it will work with prosemirror-history and we get utilise when
+ * firing events on history change
+ */
+export var LinkMetaStep = /*#__PURE__*/function (_Step) {
+  _inherits(LinkMetaStep, _Step);
+  var _super = _createSuper(LinkMetaStep);
+  function LinkMetaStep(pos, metadata) {
+    var _this;
+    var isInverted = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+    _classCallCheck(this, LinkMetaStep);
+    _this = _super.call(this);
+    _this.pos = pos;
+    _this.metadata = metadata;
+    _this.isInverted = isInverted;
+    return _this;
+  }
+  _createClass(LinkMetaStep, [{
+    key: "getMetadata",
+    value: function getMetadata() {
+      return this.metadata;
+    }
+
+    /**
+     * Generate new undo/redo analytics event when step is inverted
+     */
+  }, {
+    key: "invert",
+    value: function invert() {
+      /**
+       * Omit sourceEvent in history
+       */
+      var _this$metadata = this.metadata,
+        sourceEvent = _this$metadata.sourceEvent,
+        metadata = _objectWithoutProperties(_this$metadata, _excluded);
+      return new LinkMetaStep(this.pos, metadata, true);
+    }
+
+    // Should make no modifications to the doc
+  }, {
+    key: "apply",
+    value: function apply(doc) {
+      return StepResult.ok(doc);
+    }
+  }, {
+    key: "map",
+    value: function map(mapping) {
+      var newPos = this.pos;
+      if (typeof newPos === 'number') {
+        newPos = mapping.map(newPos);
+      }
+      // Return the same events, this step will never be removed
+      return new LinkMetaStep(newPos, this.metadata, this.isInverted);
+    }
+  }, {
+    key: "getMap",
+    value: function getMap() {
+      return new StepMap([this.pos || 0, 0, 0]);
+    }
+
+    // Return null to avoid merging events
+  }, {
+    key: "merge",
+    value: function merge() {
+      return null;
+    }
+  }, {
+    key: "toJSON",
+    value: function toJSON() {
+      // When serialized we should create a noop Replace step
+      return {
+        stepType: 'replace',
+        from: 0,
+        to: 0
+      };
+    }
+  }], [{
+    key: "fromJSON",
+    value: function fromJSON(_, __) {
+      // This is a "local custom step" once serialized
+      // we need to transform it in a no-operation action
+      return new ReplaceStep(0, 0, Slice.empty);
+    }
+  }]);
+  return LinkMetaStep;
+}(Step);
+
+/** Register this step with Prosemirror */
+Step.jsonID(stepType, LinkMetaStep);

package/dist/esm/steps/table/add-column.js

@@ -11,7 +11,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 import { Step, StepMap, StepResult, Transform } from 'prosemirror-transform';
 import { cellsAtColumn } from './utils/cells-at-column';
 import { findColumn } from './utils/find-column';

package/dist/esm/steps/table/constants.js

@@ -1,5 +1,5 @@
-export var SortOrder;
-(function (SortOrder) {
+export var SortOrder = /*#__PURE__*/function (SortOrder) {
   SortOrder["ASC"] = "asc";
   SortOrder["DESC"] = "desc";
-})(SortOrder || (SortOrder = {}));
+  return SortOrder;
+}({});