@atlaskit/editor-json-transformer 8.25.1 → 8.26.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-json-transformer
 
+## 8.26.0
+
+### Minor Changes
+
+- [`7b86b50272e47`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b86b50272e47) -
+  Expose new utility function, `nodeToJSON` which can be used to safely return a JSON object from a
+  node.
+
 ## 8.25.1
 
 ### Patch Changes

package/afm-passionfruit/tsconfig.json

@@ -0,0 +1,30 @@
+{
+	"extends": "../../../../tsconfig.entry-points.passionfruit.json",
+	"compilerOptions": {
+		"declaration": true,
+		"target": "es5",
+		"outDir": "../../../../../passionfruit/tsDist/@atlaskit__editor-json-transformer/app",
+		"rootDir": "../",
+		"composite": true
+	},
+	"include": [
+		"../src/**/*.ts",
+		"../src/**/*.tsx"
+	],
+	"exclude": [
+		"../src/**/__tests__/*",
+		"../src/**/*.test.*",
+		"../src/**/test.*",
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
+	],
+	"references": [
+		{
+			"path": "../../adf-utils/afm-passionfruit/tsconfig.json"
+		}
+	]
+}

package/afm-volt/tsconfig.json

@@ -14,7 +14,13 @@
 	"exclude": [
 		"../src/**/__tests__/*",
 		"../src/**/*.test.*",
-		"../src/**/test.*"
+		"../src/**/test.*",
+		"../src/**/examples.*",
+		"../src/**/examples/*",
+		"../src/**/examples/**/*",
+		"../src/**/*.stories.*",
+		"../src/**/stories/*",
+		"../src/**/stories/**/*"
 	],
 	"references": [
 		{

package/dist/cjs/index.js

@@ -5,7 +5,7 @@ var _typeof3 = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.SchemaStage = exports.JSONTransformer = void 0;
+exports.nodeToJSON = exports.SchemaStage = exports.JSONTransformer = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
@@ -84,7 +84,16 @@ var emptyDoc = createDocFromContent([{
   type: 'paragraph',
   content: []
 }]);
-var _toJSON = function toJSON(node, mentionMap) {
+
+/**
+ * Transforms a Prosemirror node into a JSON representation. Compared with
+ * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
+ *
+ * @param node The Prosemirror node to transform.
+ * @param mentionMap A map of mention IDs to their display names.
+ * @returns The JSON representation of the node.
+ */
+var _toJSON = exports.nodeToJSON = function toJSON(node, mentionMap) {
   var obj = {
     type: node.type.name
   };

package/dist/es2019/index.js

@@ -66,6 +66,15 @@ const emptyDoc = createDocFromContent([{
   type: 'paragraph',
   content: []
 }]);
+
+/**
+ * Transforms a Prosemirror node into a JSON representation. Compared with
+ * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
+ *
+ * @param node The Prosemirror node to transform.
+ * @param mentionMap A map of mention IDs to their display names.
+ * @returns The JSON representation of the node.
+ */
 const toJSON = (node, mentionMap) => {
   const obj = {
     type: node.type.name
@@ -158,6 +167,7 @@ const toJSON = (node, mentionMap) => {
   }
   return obj;
 };
+export { toJSON as nodeToJSON };
 const canOverrideMark = (mark, existingMarks) => {
   if (existingMarks.some(e => mark.attrs.originalValue.type === e.type.name)) {
     return markOverrideRuleFor(mark.attrs.originalValue.type).canOverrideUnsupportedMark();

package/dist/esm/index.js

@@ -78,6 +78,15 @@ var emptyDoc = createDocFromContent([{
   type: 'paragraph',
   content: []
 }]);
+
+/**
+ * Transforms a Prosemirror node into a JSON representation. Compared with
+ * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
+ *
+ * @param node The Prosemirror node to transform.
+ * @param mentionMap A map of mention IDs to their display names.
+ * @returns The JSON representation of the node.
+ */
 var _toJSON = function toJSON(node, mentionMap) {
   var obj = {
     type: node.type.name
@@ -169,6 +178,7 @@ var _toJSON = function toJSON(node, mentionMap) {
   }
   return obj;
 };
+export { _toJSON as nodeToJSON };
 var canOverrideMark = function canOverrideMark(mark, existingMarks) {
   if (existingMarks.some(function (e) {
     return mark.attrs.originalValue.type === e.type.name;

package/dist/types/index.d.ts

@@ -10,6 +10,16 @@ export declare enum SchemaStage {
     FINAL = "final",
     STAGE_0 = "stage0"
 }
+/**
+ * Transforms a Prosemirror node into a JSON representation. Compared with
+ * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
+ *
+ * @param node The Prosemirror node to transform.
+ * @param mentionMap A map of mention IDs to their display names.
+ * @returns The JSON representation of the node.
+ */
+declare const toJSON: (node: PMNode, mentionMap?: Record<string, string | undefined>) => JSONNode;
+export { toJSON as nodeToJSON };
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
     private schema;
     private mentionMap;

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

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

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

@@ -10,6 +10,16 @@ export declare enum SchemaStage {
     FINAL = "final",
     STAGE_0 = "stage0"
 }
+/**
+ * Transforms a Prosemirror node into a JSON representation. Compared with
+ * native Prosemirror JSON, this representation ensures we have valid ADF attrs.
+ *
+ * @param node The Prosemirror node to transform.
+ * @param mentionMap A map of mention IDs to their display names.
+ * @returns The JSON representation of the node.
+ */
+declare const toJSON: (node: PMNode, mentionMap?: Record<string, string | undefined>) => JSONNode;
+export { toJSON as nodeToJSON };
 export declare class JSONTransformer implements Transformer<JSONDocNode> {
     private schema;
     private mentionMap;

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

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

package/markOverrideRules/package.json

@@ -6,7 +6,7 @@
   "sideEffects": false,
   "types": "../dist/types/markOverrideRules.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/markOverrideRules.d.ts"
       ]

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.25.1",
+	"version": "8.26.0",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -36,14 +36,13 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^50.2.0",
-		"@atlaskit/adf-utils": "^19.20.0",
+		"@atlaskit/adf-utils": "^19.21.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21"
 	},
 	"devDependencies": {
-		"react": "^18.2.0",
-		"typescript": "~5.4.2"
+		"react": "^18.2.0"
 	},
 	"techstack": {
 		"@atlassian/frontend": {

package/sanitize/package.json

@@ -6,7 +6,7 @@
   "sideEffects": false,
   "types": "../dist/types/sanitize.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/sanitize.d.ts"
       ]

package/types/package.json

@@ -6,7 +6,7 @@
   "sideEffects": false,
   "types": "../dist/types/types.d.ts",
   "typesVersions": {
-    ">=4.5 <5.4": {
+    ">=4.5 <5.9": {
       "*": [
         "../dist/types-ts4.5/types.d.ts"
       ]