@atlaskit/adf-schema 25.4.0 → 25.5.0

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

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

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

@@ -11,6 +11,9 @@ export var PanelType;
   PanelType["SUCCESS"] = "success";
   PanelType["CUSTOM"] = "custom";
 })(PanelType || (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/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/utils/cells-at-column.js

@@ -1,5 +1,6 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-var _marked = /*#__PURE__*/_regeneratorRuntime.mark(cellsAtColumn);
+import _typeof from "@babel/runtime/helpers/typeof";
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
+var _marked = /*#__PURE__*/_regeneratorRuntime().mark(cellsAtColumn);
 import { columnIsHeader, tableNodeTypes } from '@atlaskit/editor-tables/utils';
 import { getCellIndex, hasMergedColumns, isRootRow } from './table-map';
 /**
@@ -11,7 +12,7 @@ import { getCellIndex, hasMergedColumns, isRootRow } from './table-map';
  */
 export function cellsAtColumn(rect, col) {
   var map, tableStart, table, refColumn, row, index, pos, hasMergedCells, type, cell, cellInfo, skippedRows;
-  return _regeneratorRuntime.wrap(function cellsAtColumn$(_context) {
+  return _regeneratorRuntime().wrap(function cellsAtColumn$(_context) {
     while (1) {
       switch (_context.prev = _context.next) {
         case 0:

package/dist/esm/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/esm/version.json

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

package/dist/types/steps/link-meta-step.d.ts

@@ -0,0 +1,51 @@
+import { Node as PMNode, Schema } from 'prosemirror-model';
+import { ReplaceStep, Step, StepMap, StepResult, Mappable } from 'prosemirror-transform';
+export declare const stepType = "editor-linking-meta";
+export declare const invertStepType = "editor-linking-meta-invert";
+export declare type LinkStepMetadata = {
+    /**
+     * Editor action performed
+     */
+    action?: string;
+    /**
+     * Editor input method that triggered the transaction
+     */
+    inputMethod?: string;
+    /**
+     * The applicable card action for this step
+     * if is RESOLVE then the undo/redo steps should be considered "updates" of a link
+     */
+    cardAction?: 'RESOLVE';
+    /**
+     * Source UI that tiggered this step, if available/applicable
+     */
+    sourceEvent?: unknown;
+};
+/**
+ * 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 declare class LinkMetaStep extends Step {
+    private pos;
+    private metadata;
+    private isInverted;
+    constructor(pos: number | null, metadata: LinkStepMetadata, isInverted?: boolean);
+    getMetadata(): LinkStepMetadata;
+    /**
+     * Generate new undo/redo analytics event when step is inverted
+     */
+    invert(): LinkMetaStep;
+    apply(doc: PMNode): StepResult<any>;
+    map(mapping: Mappable): LinkMetaStep;
+    getMap(): StepMap;
+    merge(): null;
+    toJSON(): {
+        stepType: string;
+        from: number;
+        to: number;
+    };
+    static fromJSON<S extends Schema = any>(_: S, __: {
+        [key: string]: any;
+    }): ReplaceStep<any>;
+}

package/dist/types/steps.d.ts

@@ -6,3 +6,5 @@ export { SetAttrsStep } from './steps/set-attrs';
 export { AnalyticsStep } from './steps/analytics';
 export type { TableColumnOrdering } from './steps/table/types';
 export type { AnalyticsInvertStep, AnalyticsWithChannel, AnalyticsPayload, } from './steps/analytics';
+export { LinkMetaStep } from './steps/link-meta-step';
+export type { LinkStepMetadata } from './steps/link-meta-step';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "25.4.0",
+  "version": "25.5.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "@atlaskit/codemod-utils": "^4.1.0",
-    "@atlaskit/editor-palette": "1.2.0",
+    "@atlaskit/editor-palette": "1.3.0",
     "@atlaskit/editor-tables": "^2.2.0",
     "@atlaskit/tokens": "^1.2.1",
     "@babel/runtime": "^7.0.0",