@atlaskit/editor-common 119.8.0 → 119.9.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @atlaskit/editor-common
 
+## 119.9.0
+
+### Minor 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.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 119.8.0
 
 ### Minor Changes

package/dist/cjs/monitoring/error.js

@@ -28,7 +28,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "119.7.0";
+var packageVersion = "119.9.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -24,7 +24,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "119.7.0";
+var packageVersion = "119.9.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = (0, _react2.keyframes)({

package/dist/cjs/utils/validate-using-spec.js

@@ -15,6 +15,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _validator = require("@atlaskit/adf-utils/validator");
 var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _analytics = require("../analytics");
+var _ADFStages = require("./ADFStages");
 var _trackUnsupportedContent = require("./track-unsupported-content");
 var _wrapWithUnsupported = require("./wrapWithUnsupported");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -168,11 +169,18 @@ function trackValidationError(dispatchAnalyticsEvent, error, entity) {
 }
 
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-var validateADFEntity = exports.validateADFEntity = function validateADFEntity(schema, node, dispatchAnalyticsEvent, validationOverrides) {
+var validateADFEntity = exports.validateADFEntity = function validateADFEntity(schema, node, dispatchAnalyticsEvent, validationOverrides, adfStage) {
   var nodes = Object.keys(schema.nodes);
   var marks = Object.keys(schema.marks);
+  // Full-ADF strictness is opt-in: only a caller that names `final` gets it, and omitting `adfStage`
+  // keeps stage-0 specs acceptable. Strictness has to be asked for rather than defaulted into,
+  // because a document holding a stage-0-only construct, such as a `layoutSection` with one 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.
+  // `stage0` is only observable while `platform_editor_adf_validator_stage0` is enabled.
   var validate = (0, _validator.validator)(nodes, marks, {
-    allowPrivateAttributes: true
+    allowPrivateAttributes: true,
+    stage0: adfStage !== _ADFStages.ADFStages.FINAL
   });
   var emptyDoc = {
     type: 'doc',

package/dist/es2019/monitoring/error.js

@@ -14,7 +14,7 @@ const NETWORK_FAILURE_REGEX = /^network failure/i;
 const RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "119.7.0";
+const packageVersion = "119.9.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -14,7 +14,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "119.7.0";
+const packageVersion = "119.9.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 const fadeIn = keyframes({

package/dist/es2019/utils/validate-using-spec.js

@@ -2,6 +2,7 @@ import { validator } from '@atlaskit/adf-utils/validator';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { ACTION_SUBJECT_ID } from '../analytics';
 export const UNSUPPORTED_NODE_ATTRIBUTE = 'unsupportedNodeAttribute';
+import { ADFStages } from './ADFStages';
 import { fireUnsupportedEvent } from './track-unsupported-content';
 import { wrapWithUnsupported } from './wrapWithUnsupported';
 const errorCallbackFor = (marks, validate, dispatchAnalyticsEvent, validationOverrides) => {
@@ -149,11 +150,18 @@ function trackValidationError(dispatchAnalyticsEvent, error, entity) {
 }
 
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export const validateADFEntity = (schema, node, dispatchAnalyticsEvent, validationOverrides) => {
+export const validateADFEntity = (schema, node, dispatchAnalyticsEvent, validationOverrides, adfStage) => {
   const nodes = Object.keys(schema.nodes);
   const marks = Object.keys(schema.marks);
+  // Full-ADF strictness is opt-in: only a caller that names `final` gets it, and omitting `adfStage`
+  // keeps stage-0 specs acceptable. Strictness has to be asked for rather than defaulted into,
+  // because a document holding a stage-0-only construct, such as a `layoutSection` with one 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.
+  // `stage0` is only observable while `platform_editor_adf_validator_stage0` is enabled.
   const validate = validator(nodes, marks, {
-    allowPrivateAttributes: true
+    allowPrivateAttributes: true,
+    stage0: adfStage !== ADFStages.FINAL
   });
   const emptyDoc = {
     type: 'doc',

package/dist/esm/monitoring/error.js

@@ -20,7 +20,7 @@ var NETWORK_FAILURE_REGEX = /^network failure/i;
 var RESIZE_OBSERVER_LOOP_REGEX = /ResizeObserver loop completed with undelivered notifications/;
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "119.7.0";
+var packageVersion = "119.9.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

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

@@ -21,7 +21,7 @@ import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import { fg } from '@atlaskit/platform-feature-flags';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "119.7.0";
+var packageVersion = "119.9.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var fadeIn = keyframes({

package/dist/esm/utils/validate-using-spec.js

@@ -5,6 +5,7 @@ import { validator } from '@atlaskit/adf-utils/validator';
 import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { ACTION_SUBJECT_ID } from '../analytics';
 export var UNSUPPORTED_NODE_ATTRIBUTE = 'unsupportedNodeAttribute';
+import { ADFStages } from './ADFStages';
 import { fireUnsupportedEvent } from './track-unsupported-content';
 import { wrapWithUnsupported } from './wrapWithUnsupported';
 var errorCallbackFor = function errorCallbackFor(marks, validate, dispatchAnalyticsEvent, validationOverrides) {
@@ -155,11 +156,18 @@ function trackValidationError(dispatchAnalyticsEvent, error, entity) {
 }
 
 // eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
-export var validateADFEntity = function validateADFEntity(schema, node, dispatchAnalyticsEvent, validationOverrides) {
+export var validateADFEntity = function validateADFEntity(schema, node, dispatchAnalyticsEvent, validationOverrides, adfStage) {
   var nodes = Object.keys(schema.nodes);
   var marks = Object.keys(schema.marks);
+  // Full-ADF strictness is opt-in: only a caller that names `final` gets it, and omitting `adfStage`
+  // keeps stage-0 specs acceptable. Strictness has to be asked for rather than defaulted into,
+  // because a document holding a stage-0-only construct, such as a `layoutSection` with one 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.
+  // `stage0` is only observable while `platform_editor_adf_validator_stage0` is enabled.
   var validate = validator(nodes, marks, {
-    allowPrivateAttributes: true
+    allowPrivateAttributes: true,
+    stage0: adfStage !== ADFStages.FINAL
   });
   var emptyDoc = {
     type: 'doc',

package/dist/types/utils/validate-using-spec.d.ts

@@ -3,6 +3,7 @@ import type { ErrorCallbackOptions, Validate, ValidationError } from '@atlaskit/
 import type { Schema } from '@atlaskit/editor-prosemirror/model';
 export declare const UNSUPPORTED_NODE_ATTRIBUTE = "unsupportedNodeAttribute";
 import type { UnsupportedContentPayload } from './unsupportedContent/types';
+import type { ADFStage } from './validator';
 export type DispatchAnalyticsEvent = (event: UnsupportedContentPayload) => void;
 export declare const validationErrorHandler: (entity: ADFEntity, error: ValidationError, options: ErrorCallbackOptions, marks: string[], validate: Validate, dispatchAnalyticsEvent?: DispatchAnalyticsEvent) => ADFEntity | {
     attrs: {
@@ -14,5 +15,5 @@ export declare const validateADFEntity: (schema: Schema, node: ADFEntity, dispat
     allowExpandInPanel?: boolean;
     allowNestedTables?: boolean;
     allowTableInPanel?: boolean;
-}) => ADFEntity;
+}, adfStage?: ADFStage) => ADFEntity;
 export { wrapWithUnsupported } from './wrapWithUnsupported';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "119.8.0",
+	"version": "119.9.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -30,7 +30,7 @@
 	"dependencies": {
 		"@atlaskit/activity-provider": "^3.0.0",
 		"@atlaskit/adf-schema": "^57.0.0",
-		"@atlaskit/adf-utils": "^20.6.0",
+		"@atlaskit/adf-utils": "^20.7.0",
 		"@atlaskit/afm-i18n-platform-editor-editor-common": "2.200.0",
 		"@atlaskit/analytics-listeners": "^11.1.0",
 		"@atlaskit/analytics-namespaced-context": "^8.1.0",