@atlaskit/adf-schema 25.4.0 → 25.5.0

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

@@ -6,6 +6,11 @@ export const alignmentPositionMap = {
   right: 'end',
   center: 'center'
 };
+
+/**
+ * @name alignment_mark
+ */
+
 export const alignment = {
   excludes: `alignment ${INDENTATION}`,
   group: ALIGNMENT,

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

@@ -1,5 +1,12 @@
 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.
+ */
+
 const borderColorArrayPalette = [[N300A, 'Subtle gray'], [N600, 'Gray'], [N1000, 'Bold gray']];
 export const borderColorPalette = new Map();
 borderColorArrayPalette.forEach(([color, label]) => borderColorPalette.set(color.toLowerCase(), label));

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

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

package/dist/es2019/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
+ */
+
 const parseDataConsumer = maybeValue => {
   const sources = isDOMElement(maybeValue) && maybeValue.getAttribute('data-sources');
   try {

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

@@ -1,4 +1,11 @@
 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.
+ */
+
 const parseFragment = maybeValue => {
   var _maybeValue$getAttrib;
   if (!isDOMElement(maybeValue)) {

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

@@ -1,4 +1,9 @@
 import { ALIGNMENT, INDENTATION } from '../groups';
+
+/**
+ * @name indentation_mark
+ */
+
 export const indentation = {
   excludes: `indentation ${ALIGNMENT}`,
   group: INDENTATION,

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

@@ -1,5 +1,10 @@
 import { LINK } from '../groups';
 import { isRootRelative, isSafeUrl, normalizeUrl } from '../../utils/url';
+
+/**
+ * @name link_mark
+ */
+
 const getLinkAttrs = attribute => domNode => {
   const dom = domNode;
   const href = dom.getAttribute(attribute) || '';

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

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

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

@@ -1,6 +1,11 @@
 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
 const colorArrayPalette = [
 // default row - first color is added programatically

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

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

package/dist/es2019/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
+ */
+
 const getLanguageFromEditorStyle = dom => {
   return dom.getAttribute('data-language') || undefined;
 };

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

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

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

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

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

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

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

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

package/dist/es2019/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 const layoutSection = {
   content: '(layoutColumn | unsupportedBlock){1,3} unsupportedBlock* | unsupportedBlock+',
   marks: 'unsupportedMark unsupportedNodeAttribute',

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

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

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

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

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

@@ -4,6 +4,9 @@ export let USER_TYPES;
   USER_TYPES["SPECIAL"] = "SPECIAL";
   USER_TYPES["APP"] = "APP";
 })(USER_TYPES || (USER_TYPES = {}));
+/**
+ * @name mention_node
+ */
 export const mention = {
   inline: true,
   group: 'inline',

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

@@ -8,6 +8,9 @@ export let PanelType;
   PanelType["SUCCESS"] = "success";
   PanelType["CUSTOM"] = "custom";
 })(PanelType || (PanelType = {}));
+/**
+ * @name panel_node
+ */
 const getDefaultAttrs = () => {
   let attrs = {
     panelType: {

package/dist/es2019/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
  */
-
 const isImageNode = node => {
   return Boolean(node && node.nodeName.toLowerCase() === 'img');
 };

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

@@ -114,6 +114,29 @@ export const 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
 const createTableSpec = () => {
   const attrs = {

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

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

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

@@ -1,4 +1,9 @@
 import { uuid } from '../../utils/uuid';
+
+/**
+ * @name taskList_node
+ */
+
 const name = 'actionList';
 export const taskListSelector = `[data-node-type="${name}"]`;
 export const taskList = {

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

@@ -0,0 +1,71 @@
+import { Slice } from 'prosemirror-model';
+import { ReplaceStep, Step, StepMap, StepResult } from 'prosemirror-transform';
+export const stepType = 'editor-linking-meta';
+export const 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 class LinkMetaStep extends Step {
+  constructor(pos, metadata, isInverted = false) {
+    super();
+    this.pos = pos;
+    this.metadata = metadata;
+    this.isInverted = isInverted;
+  }
+  getMetadata() {
+    return this.metadata;
+  }
+
+  /**
+   * Generate new undo/redo analytics event when step is inverted
+   */
+  invert() {
+    /**
+     * Omit sourceEvent in history
+     */
+    const {
+      sourceEvent,
+      ...metadata
+    } = this.metadata;
+    return new LinkMetaStep(this.pos, metadata, true);
+  }
+
+  // Should make no modifications to the doc
+  apply(doc) {
+    return StepResult.ok(doc);
+  }
+  map(mapping) {
+    let 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);
+  }
+  getMap() {
+    return new StepMap([this.pos || 0, 0, 0]);
+  }
+
+  // Return null to avoid merging events
+  merge() {
+    return null;
+  }
+  toJSON() {
+    // When serialized we should create a noop Replace step
+    return {
+      stepType: 'replace',
+      from: 0,
+      to: 0
+    };
+  }
+  static 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);
+  }
+}
+
+/** Register this step with Prosemirror */
+Step.jsonID(stepType, LinkMetaStep);

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.0",
 	"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/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);