@atlaskit/editor-json-transformer 8.19.1 → 8.20.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-json-transformer
 
+## 8.20.0
+
+### Minor Changes
+
+- [#152594](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/152594)
+  [`91885511b74c6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/91885511b74c6) -
+  The JSON Transformer now supports being initialised with a schema rather. This is backwards
+  compatible and the parse method still supports overriding this based on the set stage
+
 ## 8.19.1
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -50,6 +50,8 @@ var isUnsupportedNode = function isUnsupportedNode(node) {
 };
 var isDataConsumer = isType('dataConsumer');
 var isFragmentMark = isType('fragment');
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 var filterNull = function filterNull(subject) {
   var output = _objectSpread({}, subject);
   for (var key in output) {
@@ -182,7 +184,9 @@ var getUnwrappedNodeAttributes = function getUnwrappedNodeAttributes(node, mark,
 };
 var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
   function JSONTransformer() {
+    var schema = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : _schemaDefault.defaultSchema;
     (0, _classCallCheck2.default)(this, JSONTransformer);
+    this.schema = schema;
   }
   (0, _createClass2.default)(JSONTransformer, [{
     key: "encode",
@@ -198,9 +202,7 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
     }
   }, {
     key: "internalParse",
-    value: function internalParse(content) {
-      var stage = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SchemaStage.FINAL;
-      var schema = (0, _schemaDefault.getSchemaBasedOnStage)(stage);
+    value: function internalParse(content, schema) {
       var doc = schema.nodeFromJSON(content);
       doc.check();
       return doc;
@@ -211,10 +213,11 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
       if (content.type !== 'doc') {
         throw new Error('Expected content format to be ADF');
       }
+      var schema = !!stage ? (0, _schemaDefault.getSchemaBasedOnStage)(stage) : this.schema;
       if (!content.content || content.content.length === 0) {
-        return this.internalParse(emptyDoc, stage);
+        return this.internalParse(emptyDoc, schema);
       }
-      return this.internalParse(content, stage);
+      return this.internalParse(content, schema);
     }
 
     /**

package/dist/es2019/index.js

@@ -1,6 +1,6 @@
 import isEqual from 'lodash/isEqual';
 import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
-import { getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
+import { defaultSchema, getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
 import { markOverrideRuleFor } from './markOverrideRules';
 import { sanitizeNode } from './sanitize/sanitize-node';
 export let SchemaStage = /*#__PURE__*/function (SchemaStage) {
@@ -27,6 +27,8 @@ const isNestedExpand = isType('nestedExpand');
 const isUnsupportedNode = node => isType('unsupportedBlock')(node) || isType('unsupportedInline')(node);
 const isDataConsumer = isType('dataConsumer');
 const isFragmentMark = isType('fragment');
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const filterNull = subject => {
   let output = {
     ...subject
@@ -165,6 +167,9 @@ const getUnwrappedNodeAttributes = (node, mark, obj) => {
   return attributes;
 };
 export class JSONTransformer {
+  constructor(schema = defaultSchema) {
+    this.schema = schema;
+  }
   encode(node) {
     const content = [];
     node.content.forEach(child => {
@@ -175,8 +180,7 @@ export class JSONTransformer {
     }
     return createDocFromContent(content);
   }
-  internalParse(content, stage = SchemaStage.FINAL) {
-    const schema = getSchemaBasedOnStage(stage);
+  internalParse(content, schema) {
     const doc = schema.nodeFromJSON(content);
     doc.check();
     return doc;
@@ -185,10 +189,11 @@ export class JSONTransformer {
     if (content.type !== 'doc') {
       throw new Error('Expected content format to be ADF');
     }
+    const schema = !!stage ? getSchemaBasedOnStage(stage) : this.schema;
     if (!content.content || content.content.length === 0) {
-      return this.internalParse(emptyDoc, stage);
+      return this.internalParse(emptyDoc, schema);
     }
-    return this.internalParse(content, stage);
+    return this.internalParse(content, schema);
   }
 
   /**

package/dist/esm/index.js

@@ -9,7 +9,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import isEqual from 'lodash/isEqual';
 import { codeBlockToJSON, dataConsumerToJSON, expandToJSON, fragmentToJSON, linkToJSON, mediaSingleToJSON, mediaToJSON, mentionToJSON, tableToJSON, toJSONTableCell, toJSONTableHeader } from '@atlaskit/adf-schema';
-import { getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
+import { defaultSchema, getSchemaBasedOnStage } from '@atlaskit/adf-schema/schema-default';
 import { markOverrideRuleFor } from './markOverrideRules';
 import { sanitizeNode } from './sanitize/sanitize-node';
 export var SchemaStage = /*#__PURE__*/function (SchemaStage) {
@@ -42,6 +42,8 @@ var isUnsupportedNode = function isUnsupportedNode(node) {
 };
 var isDataConsumer = isType('dataConsumer');
 var isFragmentMark = isType('fragment');
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 var filterNull = function filterNull(subject) {
   var output = _objectSpread({}, subject);
   for (var key in output) {
@@ -174,7 +176,9 @@ var getUnwrappedNodeAttributes = function getUnwrappedNodeAttributes(node, mark,
 };
 export var JSONTransformer = /*#__PURE__*/function () {
   function JSONTransformer() {
+    var schema = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultSchema;
     _classCallCheck(this, JSONTransformer);
+    this.schema = schema;
   }
   _createClass(JSONTransformer, [{
     key: "encode",
@@ -190,9 +194,7 @@ export var JSONTransformer = /*#__PURE__*/function () {
     }
   }, {
     key: "internalParse",
-    value: function internalParse(content) {
-      var stage = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : SchemaStage.FINAL;
-      var schema = getSchemaBasedOnStage(stage);
+    value: function internalParse(content, schema) {
       var doc = schema.nodeFromJSON(content);
       doc.check();
       return doc;
@@ -203,10 +205,11 @@ export var JSONTransformer = /*#__PURE__*/function () {
       if (content.type !== 'doc') {
         throw new Error('Expected content format to be ADF');
       }
+      var schema = !!stage ? getSchemaBasedOnStage(stage) : this.schema;
       if (!content.content || content.content.length === 0) {
-        return this.internalParse(emptyDoc, stage);
+        return this.internalParse(emptyDoc, schema);
       }
-      return this.internalParse(content, stage);
+      return this.internalParse(content, schema);
     }
 
     /**

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
 import type { JSONDocNode, JSONNode } from './types';
 export type { JSONDocNode, JSONNode } from './types';
 interface Transformer<T> {
@@ -10,6 +10,8 @@ export declare enum SchemaStage {
     STAGE_0 = "stage0"
 }
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
+    private schema;
+    constructor(schema?: Schema);
     encode(node: PMNode): JSONDocNode;
     private internalParse;
     parse(content: JSONDocNode, stage?: SchemaStage): PMNode;

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

@@ -1,4 +1,4 @@
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Node as PMNode, Schema } from '@atlaskit/editor-prosemirror/model';
 import type { JSONDocNode, JSONNode } from './types';
 export type { JSONDocNode, JSONNode } from './types';
 interface Transformer<T> {
@@ -10,6 +10,8 @@ export declare enum SchemaStage {
     STAGE_0 = "stage0"
 }
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
+    private schema;
+    constructor(schema?: Schema);
     encode(node: PMNode): JSONDocNode;
     private internalParse;
     parse(content: JSONDocNode, stage?: SchemaStage): PMNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.19.1",
+	"version": "8.20.0",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"