@atlaskit/renderer 117.1.0 → 118.1.0

package/CHANGELOG.md

@@ -1,5 +1,55 @@
 # @atlaskit/renderer
 
+## 118.1.0
+
+### Minor Changes
+
+- [#154702](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/154702)
+  [`a44461b56d840`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a44461b56d840) -
+  Prop type update for clarity and maintainability
+
+### Patch Changes
+
+- Updated dependencies
+
+## 118.0.0
+
+### Major Changes
+
+- [#155804](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/155804)
+  [`5c9c24138fe0d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5c9c24138fe0d) -
+  ENGHEALTH-3649: Set useSpecBasedValidator renderer prop default to true in renderer, it is already
+  default to true in editor/editor
+
+  WHAT the breaking change is: Editor renderer package (editor view mode) has this
+  useSpecBasedValidator prop,
+
+  1. When set to true, it uses the validateADFEntity fn in
+     packages/editor/editor-core/src/utils/document.ts to validate a document using the ADF schema
+     dynamically
+  2. useSpecBasedValidator used to exist for Editor editor (editor edit mode), but it was removed
+     and default to use validateADFEntity at least before 14 Aug 2023.
+  3. This means any products that are using Editor editor, they have been using validateADFEntity fn
+     to validate documents for around 2 years. Any issues with it should be emerged aleady.
+
+  WHY the change was made
+
+  1. This useSpecBasedValidator is a deprecated prop for renderer, we already removed it for Editor
+     editor, we should do the same for renderer too
+  2. There was a situation around 20 April 2024, where a Jira renderer that didn’t have it enabled
+     actually caused some media bug in Jira. Thread here:
+     https://atlassian.slack.com/archives/CFG3PSQ9E/p1712719739079839
+
+  HOW a consumer should update their code
+
+  1. Consumer should not need to do anything other than update their renderer version
+  2. To be safe, this change is gated, if anything goes wrong, they can turn off the feature gate
+     platform_editor_renderer_rm_usespecbasedvalidator
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 117.1.0
 
 ### Minor Changes

package/dist/cjs/render-document.js

@@ -212,6 +212,11 @@ var renderDocument = exports.renderDocument = function renderDocument(doc, seria
   var stat = {
     sanitizeTime: 0
   };
+
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  if ((0, _platformFeatureFlags.fg)('platform_editor_renderer_rm_usespecbasedvalidator')) {
+    useSpecBasedValidator = true;
+  }
   var _withStopwatch = withStopwatch(function () {
       return memoValidation(doc, schema, adfStage, useSpecBasedValidator, dispatchAnalyticsEvent, skipValidation);
     }),

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

@@ -63,7 +63,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 var NORMAL_SEVERITY_THRESHOLD = exports.NORMAL_SEVERITY_THRESHOLD = 2000;
 var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "117.1.0";
+var packageVersion = "118.1.0";
 var setAsQueryContainerStyles = (0, _react2.css)({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/es2019/render-document.js

@@ -171,6 +171,11 @@ export const renderDocument = (doc, serializer, schema = defaultSchema, adfStage
   const stat = {
     sanitizeTime: 0
   };
+
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  if (fg('platform_editor_renderer_rm_usespecbasedvalidator')) {
+    useSpecBasedValidator = true;
+  }
   const {
     output: validDoc,
     time: sanitizeTime

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

@@ -48,7 +48,7 @@ import { PortalContext } from './PortalContext';
 export const NORMAL_SEVERITY_THRESHOLD = 2000;
 export const DEGRADED_SEVERITY_THRESHOLD = 3000;
 const packageName = "@atlaskit/renderer";
-const packageVersion = "117.1.0";
+const packageVersion = "118.1.0";
 const setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/esm/render-document.js

@@ -205,6 +205,11 @@ export var renderDocument = function renderDocument(doc, serializer) {
   var stat = {
     sanitizeTime: 0
   };
+
+  // eslint-disable-next-line @atlaskit/platform/ensure-feature-flag-prefix
+  if (fg('platform_editor_renderer_rm_usespecbasedvalidator')) {
+    useSpecBasedValidator = true;
+  }
   var _withStopwatch = withStopwatch(function () {
       return memoValidation(doc, schema, adfStage, useSpecBasedValidator, dispatchAnalyticsEvent, skipValidation);
     }),

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

@@ -53,7 +53,7 @@ import { PortalContext } from './PortalContext';
 export var NORMAL_SEVERITY_THRESHOLD = 2000;
 export var DEGRADED_SEVERITY_THRESHOLD = 3000;
 var packageName = "@atlaskit/renderer";
-var packageVersion = "117.1.0";
+var packageVersion = "118.1.0";
 var setAsQueryContainerStyles = css({
   containerName: 'ak-renderer-wrapper',
   containerType: 'inline-size'

package/dist/types/ui/Renderer/PortalContext.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { RendererProps } from '../renderer-props';
+import type { RendererProps } from '../renderer-props';
 export declare const PortalContext: React.Context<HTMLElement | undefined>;
 export declare const usePortal: ({ portal: portalFromProps, }?: {
     portal?: RendererProps['portal'];

package/dist/types-ts4.5/ui/Renderer/PortalContext.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { RendererProps } from '../renderer-props';
+import type { RendererProps } from '../renderer-props';
 export declare const PortalContext: React.Context<HTMLElement | undefined>;
 export declare const usePortal: ({ portal: portalFromProps, }?: {
     portal?: RendererProps['portal'];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/renderer",
-	"version": "117.1.0",
+	"version": "118.1.0",
 	"description": "Renderer component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -31,7 +31,7 @@
 		"@atlaskit/analytics-next": "^11.0.0",
 		"@atlaskit/button": "^23.0.0",
 		"@atlaskit/code": "^17.2.0",
-		"@atlaskit/editor-common": "^105.3.0",
+		"@atlaskit/editor-common": "^105.5.0",
 		"@atlaskit/editor-json-transformer": "^8.24.0",
 		"@atlaskit/editor-palette": "^2.1.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
@@ -42,8 +42,8 @@
 		"@atlaskit/icon": "^26.0.0",
 		"@atlaskit/link-datasource": "^4.10.0",
 		"@atlaskit/media-card": "^79.2.0",
-		"@atlaskit/media-client": "^33.2.0",
-		"@atlaskit/media-client-react": "^4.0.0",
+		"@atlaskit/media-client": "^33.3.0",
+		"@atlaskit/media-client-react": "^4.1.0",
 		"@atlaskit/media-common": "^12.0.0",
 		"@atlaskit/media-filmstrip": "^50.0.0",
 		"@atlaskit/media-ui": "^28.1.0",
@@ -249,6 +249,9 @@
 		"sticky_header_in_embedded_confluence_fix": {
 			"type": "boolean"
 		},
+		"platform_editor_renderer_rm_usespecbasedvalidator": {
+			"type": "boolean"
+		},
 		"platform_editor_add_border_for_nested_panel": {
 			"type": "boolean"
 		},