@atlaskit/renderer 136.0.5 → 136.0.6

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/renderer
 
+## 136.0.6
+
+### Patch Changes
+
+- [`da678c24b2eb7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/da678c24b2eb7) -
+  `validateADFEntity` takes an optional trailing `adfStage`, and full-ADF strictness is opt-in: only
+  a caller that names `final` is validated against full ADF, while omitting the argument keeps
+  stage-0 specs acceptable. Every existing caller behaves exactly as it did before.
+
+  Strictness is opt-in rather than derived from a default because a document holding a stage-0-only
+  construct, such as a `layoutSection` with a single column, otherwise has that content wrapped as
+  unsupported. Editors carry such constructs by design, since the editor's own schema enables them,
+  and renderers meet them in stored documents as well as in partially streamed ones. The legacy
+  `getValidDocument` path never enforced these cardinality rules, so deriving strictness
+  automatically would have made the two validation paths disagree on the same document.
+
+  `renderDocument`'s `adfStage` argument is consequently optional and no longer defaults to `final`
+  before reaching validation. It forwards whatever the caller supplied, and the legacy branch keeps
+  its own `final` default because it reads the value as a schema selector rather than as a
+  strictness request.
+
+  All of this is a no-op while `platform_editor_adf_validator_stage0` is off, and with the flag on
+  it changes nothing for callers that do not name a stage.
+
+- Updated dependencies
+
 ## 136.0.5
 
 ### Patch Changes

package/dist/cjs/render-document.js

@@ -46,9 +46,15 @@ var _validation = function _validation(doc, schema, adfStage, useSpecBasedValida
         eventType: _analytics.EVENT_TYPE.OPERATIONAL
       });
     }
-    result = skipValidation ? transformedAdf || doc : (0, _utils.validateADFEntity)(schema, transformedAdf || doc, dispatchAnalyticsEvent, validationOverrides);
+
+    // Forward `adfStage` only when a caller names one. Omitting it keeps stage-0 specs acceptable,
+    // which is what a renderer wants: stored documents can contain them, and wrapping such content
+    // as unsupported is worse than rendering it. A caller that declares `final` asks for full-ADF
+    // strictness and gets it. The legacy branch below reads the same value as a schema selector and
+    // so keeps its own `final` default.
+    result = skipValidation ? transformedAdf || doc : (0, _utils.validateADFEntity)(schema, transformedAdf || doc, dispatchAnalyticsEvent, validationOverrides, adfStage);
   } else {
-    result = (0, _validator.getValidDocument)(doc, schema, adfStage);
+    result = (0, _validator.getValidDocument)(doc, schema, adfStage !== null && adfStage !== void 0 ? adfStage : 'final');
   }
   if (!result) {
     return result;
@@ -218,7 +224,7 @@ var memoCreateNodeAndCheck = (0, _memoizeOne.default)(_createNodeAndCheck, funct
 });
 var renderDocument = exports.renderDocument = function renderDocument(doc, serializer) {
   var schema = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : _schemaDefault.defaultSchema;
-  var adfStage = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'final';
+  var adfStage = arguments.length > 3 ? arguments[3] : undefined;
   var useSpecBasedValidator = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
   var rendererId = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : 'noid';
   var dispatchAnalyticsEvent = arguments.length > 6 ? arguments[6] : undefined;

package/dist/cjs/ui/Renderer/index.js

@@ -73,7 +73,7 @@ var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
 var TABLE_INFO_TIMEOUT = 10000;
 var RENDER_EVENT_SAMPLE_RATE = 0.1;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "136.0.4";
+var packageVersion = "136.0.6";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/es2019/render-document.js

@@ -39,9 +39,15 @@ const _validation = (doc, schema, adfStage, useSpecBasedValidator, dispatchAnaly
         eventType: EVENT_TYPE.OPERATIONAL
       });
     }
-    result = skipValidation ? transformedAdf || doc : validateADFEntity(schema, transformedAdf || doc, dispatchAnalyticsEvent, validationOverrides);
+
+    // Forward `adfStage` only when a caller names one. Omitting it keeps stage-0 specs acceptable,
+    // which is what a renderer wants: stored documents can contain them, and wrapping such content
+    // as unsupported is worse than rendering it. A caller that declares `final` asks for full-ADF
+    // strictness and gets it. The legacy branch below reads the same value as a schema selector and
+    // so keeps its own `final` default.
+    result = skipValidation ? transformedAdf || doc : validateADFEntity(schema, transformedAdf || doc, dispatchAnalyticsEvent, validationOverrides, adfStage);
   } else {
-    result = getValidDocument(doc, schema, adfStage);
+    result = getValidDocument(doc, schema, adfStage !== null && adfStage !== void 0 ? adfStage : 'final');
   }
   if (!result) {
     return result;
@@ -192,7 +198,7 @@ const memoCreateNodeAndCheck = memoizeOne(_createNodeAndCheck, (newArgs, lastArg
   const [oldSchema, oldDoc] = lastArgs;
   return newSchema === oldSchema && areDocsEqual(newDoc, oldDoc);
 });
-export const renderDocument = (doc, serializer, schema = defaultSchema, adfStage = 'final', useSpecBasedValidator = false, rendererId = 'noid', dispatchAnalyticsEvent, unsupportedContentLevelsTracking, appearance, includeNodesCountInStats, skipValidation, validationOverrides) => {
+export const renderDocument = (doc, serializer, schema = defaultSchema, adfStage, useSpecBasedValidator = false, rendererId = 'noid', dispatchAnalyticsEvent, unsupportedContentLevelsTracking, appearance, includeNodesCountInStats, skipValidation, validationOverrides) => {
   const stat = {
     sanitizeTime: 0
   };

package/dist/es2019/ui/Renderer/index.js

@@ -59,7 +59,7 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 const TABLE_INFO_TIMEOUT = 10000;
 const RENDER_EVENT_SAMPLE_RATE = 0.1;
 const packageName = "@atlaskit/renderer";
-const packageVersion = "136.0.4";
+const packageVersion = "136.0.6";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/esm/render-document.js

@@ -39,9 +39,15 @@ var _validation = function _validation(doc, schema, adfStage, useSpecBasedValida
         eventType: EVENT_TYPE.OPERATIONAL
       });
     }
-    result = skipValidation ? transformedAdf || doc : validateADFEntity(schema, transformedAdf || doc, dispatchAnalyticsEvent, validationOverrides);
+
+    // Forward `adfStage` only when a caller names one. Omitting it keeps stage-0 specs acceptable,
+    // which is what a renderer wants: stored documents can contain them, and wrapping such content
+    // as unsupported is worse than rendering it. A caller that declares `final` asks for full-ADF
+    // strictness and gets it. The legacy branch below reads the same value as a schema selector and
+    // so keeps its own `final` default.
+    result = skipValidation ? transformedAdf || doc : validateADFEntity(schema, transformedAdf || doc, dispatchAnalyticsEvent, validationOverrides, adfStage);
   } else {
-    result = getValidDocument(doc, schema, adfStage);
+    result = getValidDocument(doc, schema, adfStage !== null && adfStage !== void 0 ? adfStage : 'final');
   }
   if (!result) {
     return result;
@@ -211,7 +217,7 @@ var memoCreateNodeAndCheck = memoizeOne(_createNodeAndCheck, function (newArgs,
 });
 export var renderDocument = function renderDocument(doc, serializer) {
   var schema = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : defaultSchema;
-  var adfStage = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'final';
+  var adfStage = arguments.length > 3 ? arguments[3] : undefined;
   var useSpecBasedValidator = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : false;
   var rendererId = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : 'noid';
   var dispatchAnalyticsEvent = arguments.length > 6 ? arguments[6] : undefined;

package/dist/esm/ui/Renderer/index.js

@@ -64,7 +64,7 @@ export var DEGRADED_SEVERITY_THRESHOLD = 3000;
 var TABLE_INFO_TIMEOUT = 10000;
 var RENDER_EVENT_SAMPLE_RATE = 0.1;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "136.0.4";
+var packageVersion = "136.0.6";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "136.0.5",
+	"version": "136.0.6",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -31,13 +31,13 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^57.0.0",
-		"@atlaskit/adf-utils": "^20.6.0",
+		"@atlaskit/adf-utils": "^20.7.0",
 		"@atlaskit/afm-i18n-platform-editor-renderer": "2.200.0",
 		"@atlaskit/analytics-listeners": "^11.1.0",
 		"@atlaskit/analytics-namespaced-context": "^8.1.0",
 		"@atlaskit/analytics-next": "^12.3.0",
 		"@atlaskit/browser-apis": "^1.2.0",
-		"@atlaskit/button": "^25.0.0",
+		"@atlaskit/button": "^25.1.0",
 		"@atlaskit/code": "^19.0.0",
 		"@atlaskit/css": "^1.0.0",
 		"@atlaskit/editor-json-transformer": "^9.4.0",
@@ -84,7 +84,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^119.7.0",
+		"@atlaskit/editor-common": "^119.9.0",
 		"@atlaskit/link-provider": "^5.3.0",
 		"@atlaskit/media-core": "^38.0.0",
 		"react": "^18.2.0",