@atlaskit/adf-schema 26.3.0 → 26.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 26.4.0
+
+### Minor Changes
+
+- [`1bab0faa2c8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1bab0faa2c8) - Add a new custom ProseMirror step OverrideDocumentStep for easy document replacing.
+
 ## 26.3.0
 
 ### Minor Changes

package/dist/cjs/steps/override-document-step.js

@@ -0,0 +1,94 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.overrideDocumentStepType = exports.OverrideDocumentStep = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _prosemirrorTransform = require("prosemirror-transform");
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(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; } }
+var overrideDocumentStepType = 'override-document';
+exports.overrideDocumentStepType = overrideDocumentStepType;
+var OverrideDocumentStep = /*#__PURE__*/function (_Step) {
+  (0, _inherits2.default)(OverrideDocumentStep, _Step);
+  var _super = _createSuper(OverrideDocumentStep);
+  function OverrideDocumentStep(opts) {
+    var _this;
+    (0, _classCallCheck2.default)(this, OverrideDocumentStep);
+    _this = _super.call(this);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "inverted", false);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "oldDocumentSize", 0);
+    var inverted = opts.inverted,
+      nextDocument = opts.nextDocument;
+    if (nextDocument.type.name !== 'doc') {
+      throw new Error('nextDocument should be the entire prosemirror doc node and not only its content.');
+    }
+    _this.nextDocument = nextDocument;
+    _this.inverted = Boolean(inverted);
+    return _this;
+  }
+  (0, _createClass2.default)(OverrideDocumentStep, [{
+    key: "apply",
+    value: function apply(doc) {
+      this.oldDocumentSize = doc.content.size;
+      return _prosemirrorTransform.StepResult.ok(this.nextDocument);
+    }
+  }, {
+    key: "map",
+    value: function map() {
+      return new OverrideDocumentStep({
+        nextDocument: this.nextDocument,
+        inverted: this.inverted
+      });
+    }
+  }, {
+    key: "getMap",
+    value: function getMap() {
+      if (!this.nextDocument || !this.oldDocumentSize) {
+        return new _prosemirrorTransform.StepMap([0, 0, 0]);
+      }
+      var oldSize = this.oldDocumentSize;
+      var nextDocumentSize = this.nextDocument.content.size;
+      return new _prosemirrorTransform.StepMap([0, oldSize, nextDocumentSize]);
+    }
+  }, {
+    key: "invert",
+    value: function invert(doc) {
+      return new OverrideDocumentStep({
+        nextDocument: doc,
+        inverted: true
+      });
+    }
+  }, {
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        stepType: overrideDocumentStepType,
+        inverted: this.inverted,
+        nextDocument: this.nextDocument.toJSON()
+      };
+    }
+  }], [{
+    key: "fromJSON",
+    value: function fromJSON(schema, json) {
+      if (!json || json.stepType !== overrideDocumentStepType) {
+        throw new RangeError('Invalid overrideDocument step OverrideDocumentStep.fromJSON');
+      }
+      return new OverrideDocumentStep({
+        inverted: json.inverted,
+        nextDocument: schema.nodeFromJSON(json.nextDocument)
+      });
+    }
+  }]);
+  return OverrideDocumentStep;
+}(_prosemirrorTransform.Step);
+exports.OverrideDocumentStep = OverrideDocumentStep;
+_prosemirrorTransform.Step.jsonID(overrideDocumentStepType, OverrideDocumentStep);

package/dist/cjs/steps.js

@@ -33,6 +33,12 @@ Object.defineProperty(exports, "LinkMetaStep", {
     return _linkMetaStep.LinkMetaStep;
   }
 });
+Object.defineProperty(exports, "OverrideDocumentStep", {
+  enumerable: true,
+  get: function get() {
+    return _overrideDocumentStep.OverrideDocumentStep;
+  }
+});
 Object.defineProperty(exports, "SetAttrsStep", {
   enumerable: true,
   get: function get() {
@@ -57,4 +63,5 @@ var _typeAhead = require("./steps/type-ahead");
 var _addColumn = require("./steps/table/add-column");
 var _setAttrs = require("./steps/set-attrs");
 var _analytics = require("./steps/analytics");
-var _linkMetaStep = require("./steps/link-meta-step");
+var _linkMetaStep = require("./steps/link-meta-step");
+var _overrideDocumentStep = require("./steps/override-document-step");

package/dist/cjs/version.json

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

package/dist/es2019/steps/override-document-step.js

@@ -0,0 +1,60 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { Step, StepResult, StepMap } from 'prosemirror-transform';
+export const overrideDocumentStepType = 'override-document';
+export class OverrideDocumentStep extends Step {
+  constructor(opts) {
+    super();
+    _defineProperty(this, "inverted", false);
+    _defineProperty(this, "oldDocumentSize", 0);
+    const {
+      inverted,
+      nextDocument
+    } = opts;
+    if (nextDocument.type.name !== 'doc') {
+      throw new Error('nextDocument should be the entire prosemirror doc node and not only its content.');
+    }
+    this.nextDocument = nextDocument;
+    this.inverted = Boolean(inverted);
+  }
+  apply(doc) {
+    this.oldDocumentSize = doc.content.size;
+    return StepResult.ok(this.nextDocument);
+  }
+  map() {
+    return new OverrideDocumentStep({
+      nextDocument: this.nextDocument,
+      inverted: this.inverted
+    });
+  }
+  getMap() {
+    if (!this.nextDocument || !this.oldDocumentSize) {
+      return new StepMap([0, 0, 0]);
+    }
+    const oldSize = this.oldDocumentSize;
+    const nextDocumentSize = this.nextDocument.content.size;
+    return new StepMap([0, oldSize, nextDocumentSize]);
+  }
+  invert(doc) {
+    return new OverrideDocumentStep({
+      nextDocument: doc,
+      inverted: true
+    });
+  }
+  toJSON() {
+    return {
+      stepType: overrideDocumentStepType,
+      inverted: this.inverted,
+      nextDocument: this.nextDocument.toJSON()
+    };
+  }
+  static fromJSON(schema, json) {
+    if (!json || json.stepType !== overrideDocumentStepType) {
+      throw new RangeError('Invalid overrideDocument step OverrideDocumentStep.fromJSON');
+    }
+    return new OverrideDocumentStep({
+      inverted: json.inverted,
+      nextDocument: schema.nodeFromJSON(json.nextDocument)
+    });
+  }
+}
+Step.jsonID(overrideDocumentStepType, OverrideDocumentStep);

package/dist/es2019/steps.js

@@ -4,4 +4,5 @@ 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 { LinkMetaStep } from './steps/link-meta-step';
+export { LinkMetaStep } from './steps/link-meta-step';
+export { OverrideDocumentStep } from './steps/override-document-step';

package/dist/es2019/version.json

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

package/dist/esm/steps/override-document-step.js

@@ -0,0 +1,85 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+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 { Step, StepResult, StepMap } from 'prosemirror-transform';
+export var overrideDocumentStepType = 'override-document';
+export var OverrideDocumentStep = /*#__PURE__*/function (_Step) {
+  _inherits(OverrideDocumentStep, _Step);
+  var _super = _createSuper(OverrideDocumentStep);
+  function OverrideDocumentStep(opts) {
+    var _this;
+    _classCallCheck(this, OverrideDocumentStep);
+    _this = _super.call(this);
+    _defineProperty(_assertThisInitialized(_this), "inverted", false);
+    _defineProperty(_assertThisInitialized(_this), "oldDocumentSize", 0);
+    var inverted = opts.inverted,
+      nextDocument = opts.nextDocument;
+    if (nextDocument.type.name !== 'doc') {
+      throw new Error('nextDocument should be the entire prosemirror doc node and not only its content.');
+    }
+    _this.nextDocument = nextDocument;
+    _this.inverted = Boolean(inverted);
+    return _this;
+  }
+  _createClass(OverrideDocumentStep, [{
+    key: "apply",
+    value: function apply(doc) {
+      this.oldDocumentSize = doc.content.size;
+      return StepResult.ok(this.nextDocument);
+    }
+  }, {
+    key: "map",
+    value: function map() {
+      return new OverrideDocumentStep({
+        nextDocument: this.nextDocument,
+        inverted: this.inverted
+      });
+    }
+  }, {
+    key: "getMap",
+    value: function getMap() {
+      if (!this.nextDocument || !this.oldDocumentSize) {
+        return new StepMap([0, 0, 0]);
+      }
+      var oldSize = this.oldDocumentSize;
+      var nextDocumentSize = this.nextDocument.content.size;
+      return new StepMap([0, oldSize, nextDocumentSize]);
+    }
+  }, {
+    key: "invert",
+    value: function invert(doc) {
+      return new OverrideDocumentStep({
+        nextDocument: doc,
+        inverted: true
+      });
+    }
+  }, {
+    key: "toJSON",
+    value: function toJSON() {
+      return {
+        stepType: overrideDocumentStepType,
+        inverted: this.inverted,
+        nextDocument: this.nextDocument.toJSON()
+      };
+    }
+  }], [{
+    key: "fromJSON",
+    value: function fromJSON(schema, json) {
+      if (!json || json.stepType !== overrideDocumentStepType) {
+        throw new RangeError('Invalid overrideDocument step OverrideDocumentStep.fromJSON');
+      }
+      return new OverrideDocumentStep({
+        inverted: json.inverted,
+        nextDocument: schema.nodeFromJSON(json.nextDocument)
+      });
+    }
+  }]);
+  return OverrideDocumentStep;
+}(Step);
+Step.jsonID(overrideDocumentStepType, OverrideDocumentStep);

package/dist/esm/steps.js

@@ -4,4 +4,5 @@ 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 { LinkMetaStep } from './steps/link-meta-step';
+export { LinkMetaStep } from './steps/link-meta-step';
+export { OverrideDocumentStep } from './steps/override-document-step';

package/dist/esm/version.json

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

package/dist/types/steps/override-document-step.d.ts

@@ -0,0 +1,27 @@
+import { Step, StepResult, StepMap } from 'prosemirror-transform';
+import { Node as PMNode, Schema } from 'prosemirror-model';
+type Options = {
+    nextDocument: PMNode;
+    inverted?: boolean;
+};
+export declare const overrideDocumentStepType = "override-document";
+export declare class OverrideDocumentStep extends Step {
+    inverted: boolean;
+    private nextDocument;
+    private oldDocumentSize;
+    constructor(opts: Options);
+    apply(doc: PMNode): StepResult;
+    map(): OverrideDocumentStep;
+    getMap(): StepMap;
+    invert(doc: PMNode): OverrideDocumentStep;
+    toJSON(): OverrideDocumentStepJSON;
+    static fromJSON(schema: Schema, json: OverrideDocumentStepJSON): OverrideDocumentStep;
+}
+export type OverrideDocumentStepJSON = {
+    stepType: 'override-document';
+    inverted: boolean;
+    nextDocument: {
+        [key: string]: any;
+    };
+};
+export {};

package/dist/types/steps.d.ts

@@ -8,3 +8,5 @@ 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';
+export { OverrideDocumentStep } from './steps/override-document-step';
+export type { OverrideDocumentStepJSON } from './steps/override-document-step';

package/dist/types-ts4.5/steps/override-document-step.d.ts

@@ -0,0 +1,27 @@
+import { Step, StepResult, StepMap } from 'prosemirror-transform';
+import { Node as PMNode, Schema } from 'prosemirror-model';
+type Options = {
+    nextDocument: PMNode;
+    inverted?: boolean;
+};
+export declare const overrideDocumentStepType = "override-document";
+export declare class OverrideDocumentStep extends Step {
+    inverted: boolean;
+    private nextDocument;
+    private oldDocumentSize;
+    constructor(opts: Options);
+    apply(doc: PMNode): StepResult;
+    map(): OverrideDocumentStep;
+    getMap(): StepMap;
+    invert(doc: PMNode): OverrideDocumentStep;
+    toJSON(): OverrideDocumentStepJSON;
+    static fromJSON(schema: Schema, json: OverrideDocumentStepJSON): OverrideDocumentStep;
+}
+export type OverrideDocumentStepJSON = {
+    stepType: 'override-document';
+    inverted: boolean;
+    nextDocument: {
+        [key: string]: any;
+    };
+};
+export {};

package/dist/types-ts4.5/steps.d.ts

@@ -8,3 +8,5 @@ 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';
+export { OverrideDocumentStep } from './steps/override-document-step';
+export type { OverrideDocumentStepJSON } from './steps/override-document-step';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "26.3.0",
+  "version": "26.4.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"