@atlaskit/editor-json-transformer 8.8.2 → 8.8.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-json-transformer
 
+## 8.8.3
+
+### Patch Changes
+
+- [`43cb4da169a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/43cb4da169a) - Refactored filterNull to use a for loop rather than reduce
+- [`3e03d26ca36`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3e03d26ca36) - [ESS-3031] Added the capability to parse ADF documents for the stage-0 schema
+- Updated dependencies
+
 ## 8.8.2
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -2,19 +2,23 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
+var _typeof3 = require("@babel/runtime/helpers/typeof");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.JSONTransformer = void 0;
+exports.SchemaStage = exports.JSONTransformer = void 0;
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 
 var _adfSchema = require("@atlaskit/adf-schema");
@@ -25,10 +29,22 @@ var _markOverrideRules = require("./markOverrideRules");
 
 var _sanitizeNode = require("./sanitize/sanitize-node");
 
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof3(key) === "symbol" ? key : String(key); }
+
+function _toPrimitive(input, hint) { if (_typeof3(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof3(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+
 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; }
 
+var SchemaStage;
+exports.SchemaStage = SchemaStage;
+
+(function (SchemaStage) {
+  SchemaStage["FINAL"] = "final";
+  SchemaStage["STAGE_0"] = "stage0";
+})(SchemaStage || (exports.SchemaStage = SchemaStage = {}));
+
 var isType = function isType(type) {
   return function (node) {
     return node.type.name === type;
@@ -59,19 +75,22 @@ var isDataConsumer = isType('dataConsumer');
 var isFragmentMark = isType('fragment');
 
 var filterNull = function filterNull(subject) {
-  return Object.keys(subject).reduce(function (acc, key) {
-    var current = subject[key];
+  var output = _objectSpread({}, subject);
 
-    if (current === null) {
-      return acc;
-    }
+  for (var key in output) {
+    var current = output[key];
 
-    if ((0, _typeof2.default)(current) === 'object' && !Array.isArray(current)) {
-      current = filterNull(current);
+    if (current === null) {
+      var _output = output,
+          unusedKey = _output[key],
+          filteredObj = (0, _objectWithoutProperties2.default)(_output, [key].map(_toPropertyKey));
+      output = filteredObj;
+    } else if ((0, _typeof2.default)(current) === 'object' && !Array.isArray(current)) {
+      output[key] = filterNull(current);
     }
+  }
 
-    return _objectSpread(_objectSpread({}, acc), {}, (0, _defineProperty2.default)({}, key, current));
-  }, {});
+  return output;
 };
 
 var createDocFromContent = function createDocFromContent(content) {
@@ -225,23 +244,24 @@ var JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "internalParse",
     value: function internalParse(content) {
-      var doc = _schemaDefault.defaultSchema.nodeFromJSON(content);
-
+      var stage = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SchemaStage.FINAL;
+      var schema = (0, _schemaDefault.getSchemaBasedOnStage)(stage);
+      var doc = schema.nodeFromJSON(content);
       doc.check();
       return doc;
     }
   }, {
     key: "parse",
-    value: function parse(content) {
+    value: function parse(content, stage) {
       if (content.type !== 'doc') {
         throw new Error('Expected content format to be ADF');
       }
 
       if (!content.content || content.content.length === 0) {
-        return this.internalParse(emptyDoc);
+        return this.internalParse(emptyDoc, stage);
       }
 
-      return this.internalParse(content);
+      return this.internalParse(content, stage);
     }
     /**
      * This method is used to encode a single node

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.8.2",
+	"version": "8.8.3",
 	"sideEffects": false
 }

package/dist/es2019/index.js

@@ -1,8 +1,14 @@
 import isEqual from 'lodash/isEqual';
 import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
-import { defaultSchema } from '@atlaskit/adf-schema/schema-default';
+import { getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
 import { markOverrideRuleFor } from './markOverrideRules';
 import { sanitizeNode } from './sanitize/sanitize-node';
+export let SchemaStage;
+
+(function (SchemaStage) {
+  SchemaStage["FINAL"] = "final";
+  SchemaStage["STAGE_0"] = "stage0";
+})(SchemaStage || (SchemaStage = {}));
 
 const isType = type => node => node.type.name === type;
 
@@ -28,21 +34,24 @@ const isDataConsumer = isType('dataConsumer');
 const isFragmentMark = isType('fragment');
 
 const filterNull = subject => {
-  return Object.keys(subject).reduce((acc, key) => {
-    let current = subject[key];
+  let output = { ...subject
+  };
 
-    if (current === null) {
-      return acc;
-    }
+  for (const key in output) {
+    const current = output[key];
 
-    if (typeof current === 'object' && !Array.isArray(current)) {
-      current = filterNull(current);
+    if (current === null) {
+      const {
+        [key]: unusedKey,
+        ...filteredObj
+      } = output;
+      output = filteredObj;
+    } else if (typeof current === 'object' && !Array.isArray(current)) {
+      output[key] = filterNull(current);
     }
+  }
 
-    return { ...acc,
-      [key]: current
-    };
-  }, {});
+  return output;
 };
 
 const createDocFromContent = content => {
@@ -188,22 +197,23 @@ export class JSONTransformer {
     return createDocFromContent(content);
   }
 
-  internalParse(content) {
-    const doc = defaultSchema.nodeFromJSON(content);
+  internalParse(content, stage = SchemaStage.FINAL) {
+    const schema = getSchemaBasedOnStage(stage);
+    const doc = schema.nodeFromJSON(content);
     doc.check();
     return doc;
   }
 
-  parse(content) {
+  parse(content, stage) {
     if (content.type !== 'doc') {
       throw new Error('Expected content format to be ADF');
     }
 
     if (!content.content || content.content.length === 0) {
-      return this.internalParse(emptyDoc);
+      return this.internalParse(emptyDoc, stage);
     }
 
-    return this.internalParse(content);
+    return this.internalParse(content, stage);
   }
   /**
    * This method is used to encode a single node

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.8.2",
+	"version": "8.8.3",
 	"sideEffects": false
 }

package/dist/esm/index.js

@@ -1,7 +1,12 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _typeof from "@babel/runtime/helpers/typeof";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 
 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; }
 
@@ -9,9 +14,15 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 import isEqual from 'lodash/isEqual';
 import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
-import { defaultSchema } from '@atlaskit/adf-schema/schema-default';
+import { getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
 import { markOverrideRuleFor } from './markOverrideRules';
 import { sanitizeNode } from './sanitize/sanitize-node';
+export var SchemaStage;
+
+(function (SchemaStage) {
+  SchemaStage["FINAL"] = "final";
+  SchemaStage["STAGE_0"] = "stage0";
+})(SchemaStage || (SchemaStage = {}));
 
 var isType = function isType(type) {
   return function (node) {
@@ -43,19 +54,23 @@ var isDataConsumer = isType('dataConsumer');
 var isFragmentMark = isType('fragment');
 
 var filterNull = function filterNull(subject) {
-  return Object.keys(subject).reduce(function (acc, key) {
-    var current = subject[key];
+  var output = _objectSpread({}, subject);
+
+  for (var key in output) {
+    var current = output[key];
 
     if (current === null) {
-      return acc;
-    }
+      var _output = output,
+          unusedKey = _output[key],
+          filteredObj = _objectWithoutProperties(_output, [key].map(_toPropertyKey));
 
-    if (_typeof(current) === 'object' && !Array.isArray(current)) {
-      current = filterNull(current);
+      output = filteredObj;
+    } else if (_typeof(current) === 'object' && !Array.isArray(current)) {
+      output[key] = filterNull(current);
     }
+  }
 
-    return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, current));
-  }, {});
+  return output;
 };
 
 var createDocFromContent = function createDocFromContent(content) {
@@ -209,22 +224,24 @@ export var JSONTransformer = /*#__PURE__*/function () {
   }, {
     key: "internalParse",
     value: function internalParse(content) {
-      var doc = defaultSchema.nodeFromJSON(content);
+      var stage = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SchemaStage.FINAL;
+      var schema = getSchemaBasedOnStage(stage);
+      var doc = schema.nodeFromJSON(content);
       doc.check();
       return doc;
     }
   }, {
     key: "parse",
-    value: function parse(content) {
+    value: function parse(content, stage) {
       if (content.type !== 'doc') {
         throw new Error('Expected content format to be ADF');
       }
 
       if (!content.content || content.content.length === 0) {
-        return this.internalParse(emptyDoc);
+        return this.internalParse(emptyDoc, stage);
       }
 
-      return this.internalParse(content);
+      return this.internalParse(content, stage);
     }
     /**
      * This method is used to encode a single node

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.8.2",
+	"version": "8.8.3",
 	"sideEffects": false
 }

package/dist/types/index.d.ts

@@ -5,10 +5,14 @@ interface Transformer<T> {
     encode(node: PMNode): T;
     parse(content: T): PMNode;
 }
+export declare enum SchemaStage {
+    FINAL = "final",
+    STAGE_0 = "stage0"
+}
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
     encode(node: PMNode): JSONDocNode;
     private internalParse;
-    parse(content: JSONDocNode): PMNode;
+    parse(content: JSONDocNode, stage?: SchemaStage): PMNode;
     /**
      * This method is used to encode a single node
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-json-transformer",
-  "version": "8.8.2",
+  "version": "8.8.3",
   "description": "JSON transformer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,14 +12,6 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.0 <4.5": {
-      "*": [
-        "dist/types-ts4.0/*",
-        "dist/types-ts4.0/index.d.ts"
-      ]
-    }
-  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "atlassian": {
@@ -37,23 +29,23 @@
     "./types": "./src/types.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^24.0.0",
-    "@atlaskit/adf-utils": "^17.1.0",
+    "@atlaskit/adf-schema": "^25.0.0",
+    "@atlaskit/adf-utils": "^18.0.0",
     "@babel/runtime": "^7.0.0",
     "lodash": "^4.17.21",
     "prosemirror-model": "1.14.3"
   },
   "devDependencies": {
     "@atlaskit/docs": "*",
-    "@atlaskit/editor-bitbucket-transformer": "^7.2.0",
-    "@atlaskit/editor-common": "^70.2.0",
+    "@atlaskit/editor-bitbucket-transformer": "^8.0.0",
+    "@atlaskit/editor-common": "^72.0.0",
     "@atlaskit/editor-confluence-transformer": "^8.1.0",
-    "@atlaskit/editor-core": "^175.0.0",
+    "@atlaskit/editor-core": "^177.0.0",
     "@atlaskit/editor-jira-transformer": "^8.2.0",
-    "@atlaskit/editor-markdown-transformer": "^4.1.0",
-    "@atlaskit/editor-test-helpers": "^17.2.0",
+    "@atlaskit/editor-markdown-transformer": "^5.0.0",
+    "@atlaskit/editor-test-helpers": "^18.0.0",
     "@atlaskit/editor-wikimarkup-transformer": "^11.1.0",
-    "@atlaskit/util-data-test": "^17.5.0",
+    "@atlaskit/util-data-test": "^17.6.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@emotion/react": "^11.7.1",
     "@types/prosemirror-model": "^1.11.0",

package/report.api.md

@@ -1,12 +1,17 @@
+<!-- API Report Version: 2.3 -->
+
 ## API Report File for "@atlaskit/editor-json-transformer"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
 
-<!--
-	Generated API Report version: 2.0
--->
+### Main Entry Types
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { Node as Node_2 } from 'prosemirror-model';
@@ -33,7 +38,15 @@ export class JSONTransformer implements Transformer_2<JSONDocNode> {
   encode(node: Node_2): JSONDocNode;
   encodeNode(node: Node_2): JSONNode;
   // (undocumented)
-  parse(content: JSONDocNode): Node_2;
+  parse(content: JSONDocNode, stage?: SchemaStage): Node_2;
+}
+
+// @public (undocumented)
+export enum SchemaStage {
+  // (undocumented)
+  FINAL = 'final',
+  // (undocumented)
+  STAGE_0 = 'stage0',
 }
 
 // @public (undocumented)
@@ -46,3 +59,5 @@ interface Transformer_2<T> {
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->

package/dist/types-ts4.0/index.d.ts

@@ -1,16 +0,0 @@
-import { Node as PMNode } from 'prosemirror-model';
-import { JSONDocNode, JSONNode } from './types';
-export type { JSONDocNode, JSONNode } from './types';
-interface Transformer<T> {
-    encode(node: PMNode): T;
-    parse(content: T): PMNode;
-}
-export declare class JSONTransformer implements Transformer<JSONDocNode> {
-    encode(node: PMNode): JSONDocNode;
-    private internalParse;
-    parse(content: JSONDocNode): PMNode;
-    /**
-     * This method is used to encode a single node
-     */
-    encodeNode(node: PMNode): JSONNode;
-}

package/dist/types-ts4.0/markOverrideRules.d.ts

@@ -1,13 +0,0 @@
-interface MarkJson {
-    type: string;
-    attrs: {
-        [key: string]: any;
-    };
-}
-declare type CanOverrideUnsupportedMark = (markJson?: MarkJson) => boolean;
-interface MarkOverrideRule {
-    canOverrideUnsupportedMark: CanOverrideUnsupportedMark;
-}
-declare type MarkOverrideRules = (type: string) => MarkOverrideRule;
-export declare const markOverrideRuleFor: MarkOverrideRules;
-export {};

package/dist/types-ts4.0/sanitize/remove-marks.d.ts

@@ -1,8 +0,0 @@
-import { JSONNode } from '../index';
-export declare function removeMarks(node: JSONNode): {
-    type: string;
-    attrs?: object | undefined;
-    content?: (JSONNode | undefined)[] | undefined;
-    marks?: any[] | undefined;
-    text?: string | undefined;
-};

package/dist/types-ts4.0/sanitize/sanitize-node.d.ts

@@ -1,2 +0,0 @@
-import { JSONNode } from '../types';
-export declare function sanitizeNode(json: JSONNode): JSONNode;

package/dist/types-ts4.0/sanitize.d.ts

@@ -1,2 +0,0 @@
-export { sanitizeNode } from './sanitize/sanitize-node';
-export { removeMarks } from './sanitize/remove-marks';

package/dist/types-ts4.0/types.d.ts

@@ -1,12 +0,0 @@
-export declare type JSONNode = {
-    type: string;
-    attrs?: object;
-    content?: Array<JSONNode | undefined>;
-    marks?: any[];
-    text?: string;
-};
-export declare type JSONDocNode = {
-    version: number;
-    type: 'doc';
-    content: JSONNode[];
-};