@atlaskit/editor-json-transformer 8.31.4 → 8.31.5

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-json-transformer
 
+## 8.31.5
+
+### Patch Changes
+
+- [`1004093d5acc2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1004093d5acc2) -
+  EDITOR-5371 add util validator function
+
 ## 8.31.4
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -1,11 +1,12 @@
 {
-	"extends": "../../../../tsconfig.entry-points.confluence.json",
+	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
 		"outDir": "../../../../../confluence/tsDist/@atlaskit__editor-json-transformer",
 		"rootDir": "../",
-		"composite": true
+		"composite": true,
+		"noCheck": true
 	},
 	"include": [
 		"../src/**/*.ts",
@@ -23,8 +24,14 @@
 		"../src/**/stories/**/*"
 	],
 	"references": [
+		{
+			"path": "../../adf-schema/afm-cc/tsconfig.json"
+		},
 		{
 			"path": "../../adf-utils/afm-cc/tsconfig.json"
+		},
+		{
+			"path": "../../editor-prosemirror/afm-cc/tsconfig.json"
 		}
 	]
 }

package/afm-jira/tsconfig.json

@@ -1,11 +1,12 @@
 {
-	"extends": "../../../../tsconfig.entry-points.jira.json",
+	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
 		"outDir": "../../../../../jira/tsDist/@atlaskit__editor-json-transformer/app",
 		"rootDir": "../",
-		"composite": true
+		"composite": true,
+		"noCheck": true
 	},
 	"include": [
 		"../src/**/*.ts",
@@ -23,8 +24,14 @@
 		"../src/**/stories/**/*"
 	],
 	"references": [
+		{
+			"path": "../../adf-schema/afm-jira/tsconfig.json"
+		},
 		{
 			"path": "../../adf-utils/afm-jira/tsconfig.json"
+		},
+		{
+			"path": "../../editor-prosemirror/afm-jira/tsconfig.json"
 		}
 	]
 }

package/afm-products/tsconfig.json

@@ -1,11 +1,12 @@
 {
-	"extends": "../../../../tsconfig.entry-points.products.json",
+	"extends": "../../../../tsconfig.local-consumption.json",
 	"compilerOptions": {
 		"declaration": true,
 		"target": "es5",
 		"outDir": "../../../../../tsDist/@atlaskit__editor-json-transformer/app",
 		"rootDir": "../",
-		"composite": true
+		"composite": true,
+		"noCheck": true
 	},
 	"include": [
 		"../src/**/*.ts",
@@ -23,8 +24,14 @@
 		"../src/**/stories/**/*"
 	],
 	"references": [
+		{
+			"path": "../../adf-schema/afm-products/tsconfig.json"
+		},
 		{
 			"path": "../../adf-utils/afm-products/tsconfig.json"
+		},
+		{
+			"path": "../../editor-prosemirror/afm-products/tsconfig.json"
 		}
 	]
 }

package/dist/cjs/index.js

@@ -5,7 +5,9 @@ var _typeof3 = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.nodeToJSON = exports.SchemaStage = exports.JSONTransformer = void 0;
+exports.SchemaStage = exports.JSONTransformer = void 0;
+exports.isJSONDocNode = isJSONDocNode;
+exports.nodeToJSON = 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"));
@@ -265,4 +267,30 @@ var JSONTransformer = exports.JSONTransformer = /*#__PURE__*/function () {
       return (0, _sanitizeNode.sanitizeNode)(_toJSON(node, this.mentionMap));
     }
   }]);
-}();
+}();
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+function isJSONDocNode(value) {
+  if (!value || (0, _typeof2.default)(value) !== 'object') {
+    return false;
+  }
+  var doc = value;
+
+  // Check required properties
+  if (doc.type !== 'doc') {
+    return false;
+  }
+  if (!Array.isArray(doc.content)) {
+    return false;
+  }
+
+  // Version is optional but if present should be a number
+  if (doc.version !== undefined && typeof doc.version !== 'number') {
+    return false;
+  }
+  return true;
+}

package/dist/es2019/index.js

@@ -239,4 +239,31 @@ export class JSONTransformer {
   encodeNode(node) {
     return sanitizeNode(toJSON(node, this.mentionMap));
   }
+}
+
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+export function isJSONDocNode(value) {
+  if (!value || typeof value !== 'object') {
+    return false;
+  }
+  const doc = value;
+
+  // Check required properties
+  if (doc.type !== 'doc') {
+    return false;
+  }
+  if (!Array.isArray(doc.content)) {
+    return false;
+  }
+
+  // Version is optional but if present should be a number
+  if (doc.version !== undefined && typeof doc.version !== 'number') {
+    return false;
+  }
+  return true;
 }

package/dist/esm/index.js

@@ -260,4 +260,31 @@ export var JSONTransformer = /*#__PURE__*/function () {
       return sanitizeNode(_toJSON(node, this.mentionMap));
     }
   }]);
-}();
+}();
+
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+export function isJSONDocNode(value) {
+  if (!value || _typeof(value) !== 'object') {
+    return false;
+  }
+  var doc = value;
+
+  // Check required properties
+  if (doc.type !== 'doc') {
+    return false;
+  }
+  if (!Array.isArray(doc.content)) {
+    return false;
+  }
+
+  // Version is optional but if present should be a number
+  if (doc.version !== undefined && typeof doc.version !== 'number') {
+    return false;
+  }
+  return true;
+}

package/dist/types/index.d.ts

@@ -37,3 +37,10 @@ export declare class JSONTransformer implements Transformer<JSONDocNode> {
      */
     encodeNode(node: PMNode): JSONNode;
 }
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+export declare function isJSONDocNode(value: unknown): value is JSONDocNode;

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

@@ -37,3 +37,10 @@ export declare class JSONTransformer implements Transformer<JSONDocNode> {
      */
     encodeNode(node: PMNode): JSONNode;
 }
+/**
+ * Quick type guard to check if a value is a valid JSONDocNode
+ * This is only a basic structural check, does not validate the entire object nor the schema.
+ * @param value - The value to check
+ * @returns true if the value is a valid JSONDocNode structure
+ */
+export declare function isJSONDocNode(value: unknown): value is JSONDocNode;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-json-transformer",
-	"version": "8.31.4",
+	"version": "8.31.5",
 	"description": "JSON transformer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,13 +29,14 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^51.5.1",
-		"@atlaskit/adf-utils": "^19.26.0",
-		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/adf-schema": "^51.5.0",
+		"@atlaskit/adf-utils": "^19.27.0",
+		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@babel/runtime": "^7.0.0",
 		"lodash": "^4.17.21"
 	},
 	"devDependencies": {
+		"@atlassian/a11y-jest-testing": "^0.10.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {

package/tsconfig.json

@@ -1,6 +1,5 @@
 {
   "extends": "../../../tsconfig.json",
-  "compilerOptions": {},
   "include": [
     "./src/**/*.ts",
     "./src/**/*.tsx",

package/build/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "declaration": true,
-    "target": "es5",
-    "paths": {}
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*",
-    "../src/**/examples.*",
-    "../src/**/examples/*",
-    "../src/**/examples/**/*",
-    "../src/**/*.stories.*",
-    "../src/**/stories/*",
-    "../src/**/stories/**/*"
-  ]
-}