@atlaskit/renderer 108.16.5 → 108.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @atlaskit/renderer
2
2
 
3
+ ## 108.17.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [#56790](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/56790) [`ff577a7969d4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ff577a7969d4) - ED-21266: Updated @atlaskit/adf-schema to 34.0.1
8
+
9
+ ## 108.17.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#43569](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/43569) [`8c40410ca78`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8c40410ca78) - ED-20043: MultiBodied Extension changes
14
+
15
+ ### Patch Changes
16
+
17
+ - Updated dependencies
18
+
3
19
  ## 108.16.5
4
20
 
5
21
  ### Patch Changes
@@ -41,7 +41,7 @@ var ExtensionRenderer = exports.default = /*#__PURE__*/function (_React$Componen
41
41
  });
42
42
  });
43
43
  (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getNodeRenderer", (0, _memoizeOne.default)(_extensions.getNodeRenderer));
44
- (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "renderExtensionNode", function (extensionProvider) {
44
+ (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "renderExtensionNode", function (extensionProvider, actions) {
45
45
  var _marks$find;
46
46
  var _this$props = _this.props,
47
47
  extensionHandlers = _this$props.extensionHandlers,
@@ -74,9 +74,16 @@ var ExtensionRenderer = exports.default = /*#__PURE__*/function (_React$Componen
74
74
  }
75
75
  if (!result && extensionProvider) {
76
76
  var NodeRenderer = _this.getNodeRenderer(extensionProvider, extensionType, extensionKey);
77
- result = /*#__PURE__*/_react.default.createElement(NodeRenderer, {
78
- node: node
79
- });
77
+ if (node.type === 'multiBodiedExtension') {
78
+ result = /*#__PURE__*/_react.default.createElement(NodeRenderer, {
79
+ node: node,
80
+ actions: actions
81
+ });
82
+ } else {
83
+ result = /*#__PURE__*/_react.default.createElement(NodeRenderer, {
84
+ node: node
85
+ });
86
+ }
80
87
  }
81
88
  } catch (e) {
82
89
  /** We don't want this error to block renderer */
@@ -53,7 +53,7 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
53
53
  var NORMAL_SEVERITY_THRESHOLD = exports.NORMAL_SEVERITY_THRESHOLD = 2000;
54
54
  var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
55
55
  var packageName = "@atlaskit/renderer";
56
- var packageVersion = "108.16.5";
56
+ var packageVersion = "108.17.1";
57
57
  var Renderer = exports.Renderer = /*#__PURE__*/function (_PureComponent) {
58
58
  (0, _inherits2.default)(Renderer, _PureComponent);
59
59
  var _super = _createSuper(Renderer);
@@ -21,7 +21,7 @@ export default class ExtensionRenderer extends React.Component {
21
21
  });
22
22
  });
23
23
  _defineProperty(this, "getNodeRenderer", memoizeOne(getNodeRenderer));
24
- _defineProperty(this, "renderExtensionNode", extensionProvider => {
24
+ _defineProperty(this, "renderExtensionNode", (extensionProvider, actions) => {
25
25
  var _marks$find, _marks$find$attrs;
26
26
  const {
27
27
  extensionHandlers,
@@ -53,9 +53,16 @@ export default class ExtensionRenderer extends React.Component {
53
53
  }
54
54
  if (!result && extensionProvider) {
55
55
  const NodeRenderer = this.getNodeRenderer(extensionProvider, extensionType, extensionKey);
56
- result = /*#__PURE__*/React.createElement(NodeRenderer, {
57
- node: node
58
- });
56
+ if (node.type === 'multiBodiedExtension') {
57
+ result = /*#__PURE__*/React.createElement(NodeRenderer, {
58
+ node: node,
59
+ actions: actions
60
+ });
61
+ } else {
62
+ result = /*#__PURE__*/React.createElement(NodeRenderer, {
63
+ node: node
64
+ });
65
+ }
59
66
  }
60
67
  } catch (e) {
61
68
  /** We don't want this error to block renderer */
@@ -35,7 +35,7 @@ import { RenderTracking } from '../../react/utils/performance/RenderTracking';
35
35
  export const NORMAL_SEVERITY_THRESHOLD = 2000;
36
36
  export const DEGRADED_SEVERITY_THRESHOLD = 3000;
37
37
  const packageName = "@atlaskit/renderer";
38
- const packageVersion = "108.16.5";
38
+ const packageVersion = "108.17.1";
39
39
  export class Renderer extends PureComponent {
40
40
  constructor(props) {
41
41
  super(props);
@@ -34,7 +34,7 @@ var ExtensionRenderer = /*#__PURE__*/function (_React$Component) {
34
34
  });
35
35
  });
36
36
  _defineProperty(_assertThisInitialized(_this), "getNodeRenderer", memoizeOne(getNodeRenderer));
37
- _defineProperty(_assertThisInitialized(_this), "renderExtensionNode", function (extensionProvider) {
37
+ _defineProperty(_assertThisInitialized(_this), "renderExtensionNode", function (extensionProvider, actions) {
38
38
  var _marks$find;
39
39
  var _this$props = _this.props,
40
40
  extensionHandlers = _this$props.extensionHandlers,
@@ -67,9 +67,16 @@ var ExtensionRenderer = /*#__PURE__*/function (_React$Component) {
67
67
  }
68
68
  if (!result && extensionProvider) {
69
69
  var NodeRenderer = _this.getNodeRenderer(extensionProvider, extensionType, extensionKey);
70
- result = /*#__PURE__*/React.createElement(NodeRenderer, {
71
- node: node
72
- });
70
+ if (node.type === 'multiBodiedExtension') {
71
+ result = /*#__PURE__*/React.createElement(NodeRenderer, {
72
+ node: node,
73
+ actions: actions
74
+ });
75
+ } else {
76
+ result = /*#__PURE__*/React.createElement(NodeRenderer, {
77
+ node: node
78
+ });
79
+ }
73
80
  }
74
81
  } catch (e) {
75
82
  /** We don't want this error to block renderer */
@@ -45,7 +45,7 @@ import { RenderTracking } from '../../react/utils/performance/RenderTracking';
45
45
  export var NORMAL_SEVERITY_THRESHOLD = 2000;
46
46
  export var DEGRADED_SEVERITY_THRESHOLD = 3000;
47
47
  var packageName = "@atlaskit/renderer";
48
- var packageVersion = "108.16.5";
48
+ var packageVersion = "108.17.1";
49
49
  export var Renderer = /*#__PURE__*/function (_PureComponent) {
50
50
  _inherits(Renderer, _PureComponent);
51
51
  var _super = _createSuper(Renderer);
@@ -6,6 +6,7 @@ export declare class CardErrorBoundary extends React.PureComponent<{
6
6
  url?: string;
7
7
  onClick?: (e: React.MouseEvent<HTMLElement>, url?: string) => void;
8
8
  isDatasource?: boolean;
9
+ children?: React.ReactNode;
9
10
  } & CardErrorBoundaryProps> {
10
11
  state: {
11
12
  isError: boolean;
@@ -1,12 +1,12 @@
1
1
  import React from 'react';
2
- import { RendererContext } from '../react/types';
3
- import { ExtensionLayout } from '@atlaskit/adf-schema';
2
+ import type { RendererContext } from '../react/types';
3
+ import type { ExtensionLayout } from '@atlaskit/adf-schema';
4
4
  import { getNodeRenderer } from '@atlaskit/editor-common/extensions';
5
- import type { ExtensionHandlers, ExtensionProvider } from '@atlaskit/editor-common/extensions';
6
- import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
7
- import { Mark as PMMark } from '@atlaskit/editor-prosemirror/model';
5
+ import type { ExtensionHandlers, ExtensionProvider, MultiBodiedExtensionActions } from '@atlaskit/editor-common/extensions';
6
+ import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
7
+ import type { Mark as PMMark } from '@atlaskit/editor-prosemirror/model';
8
8
  export interface Props {
9
- type: 'extension' | 'inlineExtension' | 'bodiedExtension';
9
+ type: 'extension' | 'inlineExtension' | 'bodiedExtension' | 'multiBodiedExtension';
10
10
  extensionHandlers?: ExtensionHandlers;
11
11
  providers?: ProviderFactory;
12
12
  rendererContext: RendererContext;
@@ -34,7 +34,7 @@ export default class ExtensionRenderer extends React.Component<Props, State> {
34
34
  componentWillUnmount(): void;
35
35
  handleProvider: (name: keyof State, providerPromise?: Promise<any>) => void;
36
36
  getNodeRenderer: import("memoize-one").MemoizedFn<typeof getNodeRenderer>;
37
- renderExtensionNode: (extensionProvider?: ExtensionProvider | null) => JSX.Element;
37
+ renderExtensionNode: (extensionProvider?: ExtensionProvider | null, actions?: MultiBodiedExtensionActions) => JSX.Element;
38
38
  setupAndRenderExtensionNode: (providers: {
39
39
  extensionProvider?: Promise<ExtensionProvider<any>> | undefined;
40
40
  }) => JSX.Element;
@@ -6,6 +6,7 @@ export declare class CardErrorBoundary extends React.PureComponent<{
6
6
  url?: string;
7
7
  onClick?: (e: React.MouseEvent<HTMLElement>, url?: string) => void;
8
8
  isDatasource?: boolean;
9
+ children?: React.ReactNode;
9
10
  } & CardErrorBoundaryProps> {
10
11
  state: {
11
12
  isError: boolean;
@@ -1,12 +1,12 @@
1
1
  import React from 'react';
2
- import { RendererContext } from '../react/types';
3
- import { ExtensionLayout } from '@atlaskit/adf-schema';
2
+ import type { RendererContext } from '../react/types';
3
+ import type { ExtensionLayout } from '@atlaskit/adf-schema';
4
4
  import { getNodeRenderer } from '@atlaskit/editor-common/extensions';
5
- import type { ExtensionHandlers, ExtensionProvider } from '@atlaskit/editor-common/extensions';
6
- import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
7
- import { Mark as PMMark } from '@atlaskit/editor-prosemirror/model';
5
+ import type { ExtensionHandlers, ExtensionProvider, MultiBodiedExtensionActions } from '@atlaskit/editor-common/extensions';
6
+ import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
7
+ import type { Mark as PMMark } from '@atlaskit/editor-prosemirror/model';
8
8
  export interface Props {
9
- type: 'extension' | 'inlineExtension' | 'bodiedExtension';
9
+ type: 'extension' | 'inlineExtension' | 'bodiedExtension' | 'multiBodiedExtension';
10
10
  extensionHandlers?: ExtensionHandlers;
11
11
  providers?: ProviderFactory;
12
12
  rendererContext: RendererContext;
@@ -34,7 +34,7 @@ export default class ExtensionRenderer extends React.Component<Props, State> {
34
34
  componentWillUnmount(): void;
35
35
  handleProvider: (name: keyof State, providerPromise?: Promise<any>) => void;
36
36
  getNodeRenderer: import("memoize-one").MemoizedFn<typeof getNodeRenderer>;
37
- renderExtensionNode: (extensionProvider?: ExtensionProvider | null) => JSX.Element;
37
+ renderExtensionNode: (extensionProvider?: ExtensionProvider | null, actions?: MultiBodiedExtensionActions) => JSX.Element;
38
38
  setupAndRenderExtensionNode: (providers: {
39
39
  extensionProvider?: Promise<ExtensionProvider<any>> | undefined;
40
40
  }) => JSX.Element;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/renderer",
3
- "version": "108.16.5",
3
+ "version": "108.17.1",
4
4
  "description": "Renderer component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -21,26 +21,27 @@
21
21
  "releaseModel": "continuous",
22
22
  "website": {
23
23
  "name": "Renderer"
24
- }
24
+ },
25
+ "supportsReact18": true
25
26
  },
26
27
  "dependencies": {
27
- "@atlaskit/adf-schema": "^34.0.0",
28
+ "@atlaskit/adf-schema": "^34.0.1",
28
29
  "@atlaskit/adf-utils": "^19.0.0",
29
30
  "@atlaskit/analytics-listeners": "^8.7.0",
30
31
  "@atlaskit/analytics-namespaced-context": "^6.7.0",
31
32
  "@atlaskit/analytics-next": "^9.1.0",
32
33
  "@atlaskit/button": "^16.17.0",
33
- "@atlaskit/code": "^15.0.0",
34
- "@atlaskit/editor-common": "^76.22.0",
34
+ "@atlaskit/code": "^15.1.0",
35
+ "@atlaskit/editor-common": "^76.23.0",
35
36
  "@atlaskit/editor-json-transformer": "^8.10.0",
36
37
  "@atlaskit/editor-palette": "1.5.2",
37
38
  "@atlaskit/editor-prosemirror": "1.1.0",
38
39
  "@atlaskit/editor-shared-styles": "^2.8.0",
39
40
  "@atlaskit/emoji": "^67.6.0",
40
41
  "@atlaskit/icon": "^22.0.0",
41
- "@atlaskit/link-datasource": "^1.18.0",
42
+ "@atlaskit/link-datasource": "^1.19.0",
42
43
  "@atlaskit/media-card": "^77.4.0",
43
- "@atlaskit/media-client": "^25.0.0",
44
+ "@atlaskit/media-client": "^25.1.0",
44
45
  "@atlaskit/media-client-react": "^1.4.0",
45
46
  "@atlaskit/media-common": "^11.0.0",
46
47
  "@atlaskit/media-filmstrip": "^47.0.0",
@@ -51,7 +52,7 @@
51
52
  "@atlaskit/status": "^1.4.0",
52
53
  "@atlaskit/task-decision": "^17.9.0",
53
54
  "@atlaskit/theme": "^12.6.0",
54
- "@atlaskit/tokens": "^1.28.0",
55
+ "@atlaskit/tokens": "^1.29.0",
55
56
  "@atlaskit/tooltip": "^18.0.0",
56
57
  "@babel/runtime": "^7.0.0",
57
58
  "@emotion/react": "^11.7.1",
@@ -84,6 +85,7 @@
84
85
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
85
86
  "@atlassian/feature-flags-test-utils": "*",
86
87
  "@testing-library/react": "^12.1.5",
88
+ "@testing-library/user-event": "^14.4.3",
87
89
  "@types/react-loadable": "^5.4.1",
88
90
  "ajv": "^6.12.6",
89
91
  "enzyme": "^3.10.0",
@@ -1,554 +0,0 @@
1
- ## API Report File for "@atlaskit/renderer"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- /// <reference types="react" />
8
-
9
- import { ACTION } from '@atlaskit/editor-common/analytics';
10
- import { ACTION_SUBJECT } from '@atlaskit/editor-common/analytics';
11
- import { ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
12
- import type { ADFStage } from '@atlaskit/editor-common/validator';
13
- import type { AnnotationProviders } from '@atlaskit/editor-common/types';
14
- import type { CardProps } from '@atlaskit/smart-card';
15
- import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
16
- import type { DocNode } from '@atlaskit/adf-schema';
17
- import type { EmojiResourceConfig } from '@atlaskit/emoji/resource';
18
- import { EVENT_TYPE } from '@atlaskit/editor-common/analytics';
19
- import type { EventHandlers } from '@atlaskit/editor-common/ui';
20
- import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
21
- import { Fragment } from '@atlaskit/editor-prosemirror/model';
22
- import { jsx } from '@emotion/react';
23
- import type { Mark } from '@atlaskit/editor-prosemirror/model';
24
- import type { MediaClientConfig } from '@atlaskit/media-core';
25
- import type { MediaFeatureFlags } from '@atlaskit/media-common';
26
- import { Node as Node_2 } from '@atlaskit/editor-prosemirror/model';
27
- import { OperationalAEP } from '@atlaskit/editor-common/analytics';
28
- import { PropsDifference } from '@atlaskit/editor-common/utils';
29
- import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
30
- import { Schema } from '@atlaskit/editor-prosemirror/model';
31
- import { SEVERITY } from '@atlaskit/editor-common/utils';
32
- import { ShallowPropsDifference } from '@atlaskit/editor-common/utils';
33
- import { SortOrder } from '@atlaskit/editor-common/types';
34
- import type { SSR } from '@atlaskit/media-common';
35
- import type { Transformer as Transformer_2 } from '@atlaskit/editor-common/types';
36
- import { UNSUPPORTED_CONTENT_LEVEL_SEVERITY } from '@atlaskit/editor-common/utils';
37
- import type { UnsupportedContentLevelsTracking } from '@atlaskit/editor-common/utils';
38
- import type { UnsupportedContentPayload } from '@atlaskit/editor-common/utils';
39
- import type { UnsupportedContentTooltipPayload } from '@atlaskit/editor-common/utils';
40
-
41
- // @public (undocumented)
42
- export class ADFEncoder<T> {
43
- constructor(createTransformerWithSchema: TransformerProvider<T>);
44
- // (undocumented)
45
- encode: (value: T) => any;
46
- }
47
-
48
- // @public (undocumented)
49
- type AEP<Action, ActionSubject, ActionSubjectID, Attributes, EventType> = {
50
- action: Action;
51
- actionSubject: ActionSubject;
52
- actionSubjectId?: ActionSubjectID;
53
- attributes?: Attributes;
54
- eventType: EventType;
55
- };
56
-
57
- // @public (undocumented)
58
- type AnalyticsEventPayload<T = void> = AnchorLinkAEP | AnnotationAEP | AnnotationDeleteAEP | CodeBlockCopyAEP | CodeBlockWrapAEP | ComponentCrashErrorAEP | ExpandAEP | HeadingAnchorLinkButtonAEP | InvalidProsemirrorDocumentErrorAEP | MediaLnkTransformedAEP | RendererReRenderedAEP<T> | RendererRenderedAEP | RendererSelectAllCaughtAEP | RendererSelectAllEscapedAEP | RendererStartAEP | RendererTTIAEP | RendererUnsupportedContentLevelsTrackingErrored | RendererUnsupportedContentLevelsTrackingSucceeded | TableSortColumnAEP | TableSortColumnNotAllowedAEP | UnsupportedContentPayload | UnsupportedContentTooltipPayload | VisitLinkAEP | VisitMediaLinkAEP;
59
-
60
- // @public (undocumented)
61
- type AnchorLinkAEP = UIAEP<ACTION.VIEWED, ACTION_SUBJECT.ANCHOR_LINK, undefined, {
62
- platform: PLATFORM.WEB;
63
- mode: MODE.RENDERER;
64
- }>;
65
-
66
- // @public (undocumented)
67
- type AnnotationActionType = ACTION.CLOSED | ACTION.CREATE_NOT_ALLOWED | ACTION.DELETED | ACTION.EDITED | ACTION.INSERTED | ACTION.OPENED | ACTION.RESOLVED | ACTION.VIEWED;
68
-
69
- // @public (undocumented)
70
- type AnnotationAEP = AEP<AnnotationActionType, ACTION_SUBJECT.ANNOTATION, ACTION_SUBJECT_ID.INLINE_COMMENT, AnnotationAEPAttributes, undefined>;
71
-
72
- // @public (undocumented)
73
- type AnnotationAEPAttributes = AnnotationDraftAEPAttributes | AnnotationResolvedAEPAttributes;
74
-
75
- // @public (undocumented)
76
- type AnnotationDeleteAEP = AEP<AnnotationActionType, ACTION_SUBJECT.ANNOTATION, ACTION_SUBJECT_ID, undefined, EVENT_TYPE.TRACK>;
77
-
78
- // @public (undocumented)
79
- type AnnotationDraftAEPAttributes = {
80
- overlap?: number;
81
- };
82
-
83
- // @public (undocumented)
84
- type AnnotationResolvedAEPAttributes = {
85
- method?: RESOLVE_METHOD;
86
- };
87
-
88
- // @public (undocumented)
89
- type ButtonAEP<ActionSubjectID, Attributes> = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ActionSubjectID, Attributes>;
90
-
91
- // @public (undocumented)
92
- type CodeBlockCopyAEP = ButtonAEP<ACTION_SUBJECT_ID.CODEBLOCK_COPY, undefined>;
93
-
94
- // @public (undocumented)
95
- type CodeBlockWrapAEP = ButtonAEP<ACTION_SUBJECT_ID.CODEBLOCK_WRAP, {
96
- wrapped: boolean;
97
- }>;
98
-
99
- // @public (undocumented)
100
- type ComponentCrashErrorAEP = OperationalAEP<ACTION.CRASHED, ACTION_SUBJECT.RENDERER, ACTION_SUBJECT_ID, {
101
- platform: PLATFORM.WEB;
102
- errorMessage?: string;
103
- errorStack?: string;
104
- componentStack?: string;
105
- errorRethrown?: boolean;
106
- }, {
107
- errorStack?: string;
108
- }>;
109
-
110
- // @public (undocumented)
111
- type DispatchAnalyticsEvent = (event: AnalyticsEventPayload) => void;
112
-
113
- // @public (undocumented)
114
- type ExpandAEP = AEP<ACTION.TOGGLE_EXPAND, ACTION_SUBJECT.EXPAND | ACTION_SUBJECT.NESTED_EXPAND, undefined, {
115
- platform: PLATFORM.WEB;
116
- mode: MODE.RENDERER;
117
- expanded: boolean;
118
- }, EVENT_TYPE.TRACK>;
119
-
120
- // @public (undocumented)
121
- type HeadingAnchorLinkButtonAEP = ButtonAEP<ACTION_SUBJECT_ID.HEADING_ANCHOR_LINK, undefined>;
122
-
123
- // @public (undocumented)
124
- type HeadingAnchorLinksConfig = {
125
- activeHeadingId?: string;
126
- allowNestedHeaderLinks?: boolean;
127
- };
128
-
129
- // @public (undocumented)
130
- export type HeadingAnchorLinksProps = HeadingAnchorLinksConfig | boolean;
131
-
132
- // @public (undocumented)
133
- type InvalidProsemirrorDocumentErrorAEP = AEP<ACTION.INVALID_PROSEMIRROR_DOCUMENT, ACTION_SUBJECT.RENDERER, ACTION_SUBJECT_ID, {
134
- platform: PLATFORM.WEB;
135
- errorStack?: string;
136
- }, EVENT_TYPE.OPERATIONAL>;
137
-
138
- // @public (undocumented)
139
- type MediaLnkTransformedAEP = AEP<ACTION.MEDIA_LINK_TRANSFORMED, ACTION_SUBJECT.RENDERER, undefined, undefined, EVENT_TYPE.OPERATIONAL>;
140
-
141
- // @public (undocumented)
142
- interface MediaOptions {
143
- // (undocumented)
144
- allowCaptions?: boolean;
145
- // (undocumented)
146
- allowLinking?: boolean;
147
- // (undocumented)
148
- enableDownloadButton?: boolean;
149
- // (undocumented)
150
- featureFlags?: MediaFeatureFlags;
151
- // (undocumented)
152
- ssr?: MediaSSR;
153
- }
154
-
155
- // @public (undocumented)
156
- export type MediaSSR = {
157
- mode: SSR;
158
- config: MediaClientConfig;
159
- };
160
-
161
- // @public (undocumented)
162
- enum MODE {
163
- // (undocumented)
164
- EDITOR = "editor",
165
- // (undocumented)
166
- RENDERER = "renderer"
167
- }
168
-
169
- // @public (undocumented)
170
- type NodeComponentsProps = {
171
- [key: string]: React.ComponentType<any>;
172
- };
173
-
174
- // @public (undocumented)
175
- interface ParentInfo {
176
- // (undocumented)
177
- parentIsIncompleteTask: boolean;
178
- // (undocumented)
179
- path: Array<Node_2>;
180
- // (undocumented)
181
- pos: number;
182
- }
183
-
184
- // @public (undocumented)
185
- enum PLATFORM {
186
- // (undocumented)
187
- HYBRID = "mobileHybrid",
188
- // (undocumented)
189
- NATIVE = "mobileNative",
190
- // (undocumented)
191
- WEB = "web"
192
- }
193
-
194
- // @public (undocumented)
195
- interface RawObjectFeatureFlags {
196
- // (undocumented)
197
- ['renderer-render-tracking']: string;
198
- }
199
-
200
- // @public (undocumented)
201
- export const ReactRenderer: (props: RendererProps) => jsx.JSX.Element;
202
-
203
- // @public (undocumented)
204
- export class ReactSerializer implements Serializer<JSX.Element> {
205
- constructor(init: ReactSerializerInit);
206
- // (undocumented)
207
- static buildMarkStructure(content: Node_2[]): Mark[];
208
- // (undocumented)
209
- static fromSchema(_: unknown, init: ReactSerializerInit): ReactSerializer;
210
- // (undocumented)
211
- static getChildNodes(fragment: Fragment): (Node_2 | TextWrapper)[];
212
- // (undocumented)
213
- static getMarks(node: Node_2): Mark[];
214
- // (undocumented)
215
- serializeFragment(fragment: Fragment, props?: any, target?: any, key?: string, parentInfo?: ParentInfo): JSX.Element | null;
216
- }
217
-
218
- // @public (undocumented)
219
- interface ReactSerializerInit {
220
- // (undocumented)
221
- allowAltTextOnImages?: boolean;
222
- // (undocumented)
223
- allowAnnotations?: boolean;
224
- // (undocumented)
225
- allowColumnSorting?: boolean;
226
- // (undocumented)
227
- allowCopyToClipboard?: boolean;
228
- // (undocumented)
229
- allowCustomPanels?: boolean;
230
- // (undocumented)
231
- allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
232
- // (undocumented)
233
- allowMediaLinking?: boolean;
234
- // (undocumented)
235
- allowPlaceholderText?: boolean;
236
- // (undocumented)
237
- allowSelectAllTrap?: boolean;
238
- // (undocumented)
239
- allowWindowedCodeBlock?: boolean;
240
- // (undocumented)
241
- allowWrapCodeBlock?: boolean;
242
- // (undocumented)
243
- appearance?: RendererAppearance;
244
- // (undocumented)
245
- disableActions?: boolean;
246
- // (undocumented)
247
- disableHeadingIDs?: boolean;
248
- // (undocumented)
249
- emojiResourceConfig?: EmojiResourceConfig;
250
- // (undocumented)
251
- eventHandlers?: EventHandlers;
252
- // (undocumented)
253
- extensionHandlers?: ExtensionHandlers;
254
- // (undocumented)
255
- fireAnalyticsEvent?: (event: AnalyticsEventPayload) => void;
256
- // (undocumented)
257
- media?: MediaOptions;
258
- // (undocumented)
259
- nodeComponents?: NodeComponentsProps;
260
- // (undocumented)
261
- objectContext?: RendererContext;
262
- // (undocumented)
263
- portal?: HTMLElement;
264
- // (undocumented)
265
- providers?: ProviderFactory;
266
- // (undocumented)
267
- shouldOpenMediaViewer?: boolean;
268
- // (undocumented)
269
- smartLinks?: SmartLinksOptions;
270
- // (undocumented)
271
- stickyHeaders?: StickyHeaderConfig;
272
- // (undocumented)
273
- surroundTextNodesWithTextWrapper?: boolean;
274
- }
275
-
276
- // @public (undocumented)
277
- export const renderDocument: <T>(doc: any, serializer: Serializer<T>, schema?: Schema, adfStage?: ADFStage, useSpecBasedValidator?: boolean, rendererId?: string, dispatchAnalyticsEvent?: DispatchAnalyticsEvent, unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking, appearance?: RendererAppearance) => RenderOutput<T | null>;
278
-
279
- // @public (undocumented)
280
- export type RendererAppearance = 'comment' | 'full-page' | 'full-width' | 'mobile' | undefined;
281
-
282
- // @public (undocumented)
283
- export interface RendererContext {
284
- // (undocumented)
285
- adDoc?: any;
286
- // (undocumented)
287
- containerAri?: string;
288
- // (undocumented)
289
- objectAri?: string;
290
- // (undocumented)
291
- schema?: Schema;
292
- }
293
-
294
- // @public (undocumented)
295
- export interface RendererProps {
296
- addTelepointer?: boolean;
297
- // (undocumented)
298
- adfStage?: ADFStage;
299
- // (undocumented)
300
- allowAltTextOnImages?: boolean;
301
- // (undocumented)
302
- allowAnnotations?: boolean;
303
- // (undocumented)
304
- allowColumnSorting?: boolean;
305
- // (undocumented)
306
- allowCopyToClipboard?: boolean;
307
- // (undocumented)
308
- allowCustomPanels?: boolean;
309
- // (undocumented)
310
- allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
311
- // (undocumented)
312
- allowPlaceholderText?: boolean;
313
- // (undocumented)
314
- allowSelectAllTrap?: boolean;
315
- // (undocumented)
316
- allowUgcScrubber?: boolean;
317
- // (undocumented)
318
- allowWrapCodeBlock?: boolean;
319
- // (undocumented)
320
- analyticsEventSeverityTracking?: {
321
- enabled: boolean;
322
- severityNormalThreshold: number;
323
- severityDegradedThreshold: number;
324
- };
325
- // (undocumented)
326
- annotationProvider?: AnnotationProviders | null;
327
- // (undocumented)
328
- appearance?: RendererAppearance;
329
- // (undocumented)
330
- createAnalyticsEvent?: CreateUIAnalyticsEvent;
331
- // (undocumented)
332
- dataProviders?: ProviderFactory;
333
- // (undocumented)
334
- disableActions?: boolean;
335
- // (undocumented)
336
- disableHeadingIDs?: boolean;
337
- // (undocumented)
338
- document: DocNode;
339
- // (undocumented)
340
- emojiResourceConfig?: EmojiResourceConfig;
341
- // (undocumented)
342
- enableSsrInlineScripts?: boolean;
343
- // (undocumented)
344
- eventHandlers?: EventHandlers;
345
- // (undocumented)
346
- extensionHandlers?: ExtensionHandlers;
347
- // (undocumented)
348
- fadeOutHeight?: number;
349
- featureFlags?: Partial<RawObjectFeatureFlags> | {
350
- [featureFlag: string]: boolean;
351
- };
352
- // (undocumented)
353
- innerRef?: React.RefObject<HTMLDivElement>;
354
- // (undocumented)
355
- maxHeight?: number;
356
- // (undocumented)
357
- media?: MediaOptions;
358
- // (undocumented)
359
- nodeComponents?: NodeComponentsProps;
360
- // (undocumented)
361
- onComplete?: (stat: RenderOutputStat) => void;
362
- // (undocumented)
363
- onError?: (error: any) => void;
364
- // (undocumented)
365
- portal?: HTMLElement;
366
- // (undocumented)
367
- rendererContext?: RendererContext;
368
- // (undocumented)
369
- schema?: Schema;
370
- // (undocumented)
371
- shouldOpenMediaViewer?: boolean;
372
- // (undocumented)
373
- smartLinks?: SmartLinksOptions;
374
- // (undocumented)
375
- stickyHeaders?: StickyHeaderProps;
376
- // (undocumented)
377
- truncated?: boolean;
378
- // (undocumented)
379
- unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking;
380
- // @deprecated (undocumented)
381
- useSpecBasedValidator?: boolean;
382
- }
383
-
384
- // @public (undocumented)
385
- type RendererRenderedAEP = AEP<ACTION.RENDERED, ACTION_SUBJECT.RENDERER, undefined, {
386
- platform: PLATFORM.WEB;
387
- duration: number;
388
- distortedDuration: boolean;
389
- ttfb?: number;
390
- nodes: Record<string, number>;
391
- severity?: SEVERITY;
392
- }, EVENT_TYPE.OPERATIONAL>;
393
-
394
- // @public (undocumented)
395
- type RendererReRenderedAEP<Props> = AEP<ACTION.RE_RENDERED, ACTION_SUBJECT.RENDERER, undefined, {
396
- propsDifference: PropsDifference<Props> | ShallowPropsDifference<Props>;
397
- count: number;
398
- componentId?: string;
399
- }, EVENT_TYPE.OPERATIONAL>;
400
-
401
- // @public (undocumented)
402
- type RendererSelectAllCaughtAEP = AEP<ACTION.SELECT_ALL_CAUGHT, ACTION_SUBJECT.RENDERER, undefined, {
403
- platform: PLATFORM.WEB;
404
- }, EVENT_TYPE.TRACK>;
405
-
406
- // @public (undocumented)
407
- type RendererSelectAllEscapedAEP = AEP<ACTION.SELECT_ALL_ESCAPED, ACTION_SUBJECT.RENDERER, undefined, {
408
- platform: PLATFORM.WEB;
409
- }, EVENT_TYPE.TRACK>;
410
-
411
- // @public (undocumented)
412
- type RendererStartAEP = AEP<ACTION.STARTED, ACTION_SUBJECT.RENDERER, undefined, {
413
- platform: PLATFORM.WEB;
414
- }, EVENT_TYPE.UI>;
415
-
416
- // @public (undocumented)
417
- type RendererTTIAEP = AEP<ACTION.RENDERER_TTI, ACTION_SUBJECT.RENDERER, undefined, {
418
- tti: number;
419
- ttiFromInvocation: number;
420
- canceled: boolean;
421
- }, EVENT_TYPE.OPERATIONAL>;
422
-
423
- // @public (undocumented)
424
- type RendererUnsupportedContentLevelsTrackingErrored = AEP<ACTION.UNSUPPORTED_CONTENT_LEVELS_TRACKING_ERRORED, ACTION_SUBJECT.RENDERER, undefined, {
425
- platform: PLATFORM.WEB;
426
- error: string;
427
- }, EVENT_TYPE.OPERATIONAL>;
428
-
429
- // @public (undocumented)
430
- type RendererUnsupportedContentLevelsTrackingSucceeded = AEP<ACTION.UNSUPPORTED_CONTENT_LEVELS_TRACKING_SUCCEEDED, ACTION_SUBJECT.RENDERER, undefined, {
431
- appearance?: string;
432
- platform: PLATFORM.WEB;
433
- unsupportedContentLevelSeverity: UNSUPPORTED_CONTENT_LEVEL_SEVERITY;
434
- unsupportedContentLevelPercentage: number;
435
- unsupportedNodesCount: number;
436
- supportedNodesCount: number;
437
- }, EVENT_TYPE.OPERATIONAL>;
438
-
439
- // @public (undocumented)
440
- interface RenderOutput<T> {
441
- // (undocumented)
442
- pmDoc?: Node_2;
443
- // (undocumented)
444
- result: T;
445
- // (undocumented)
446
- stat: RenderOutputStat;
447
- }
448
-
449
- // @public (undocumented)
450
- export interface RenderOutputStat {
451
- // (undocumented)
452
- buildTreeTime?: number;
453
- // (undocumented)
454
- sanitizeTime: number;
455
- // (undocumented)
456
- serializeTime?: number;
457
- }
458
-
459
- // @public (undocumented)
460
- enum RESOLVE_METHOD {
461
- // (undocumented)
462
- COMPONENT = "component",
463
- // (undocumented)
464
- CONSUMER = "consumer",
465
- // (undocumented)
466
- ORPHANED = "orphaned"
467
- }
468
-
469
- // @public (undocumented)
470
- export interface Serializer<T> {
471
- // (undocumented)
472
- serializeFragment(fragment: Fragment, props?: any, target?: any, key?: string): T | null;
473
- }
474
-
475
- // @public (undocumented)
476
- interface SmartLinksOptions {
477
- // (undocumented)
478
- frameStyle?: CardProps['frameStyle'];
479
- // (undocumented)
480
- hideHoverPreview?: boolean;
481
- // (undocumented)
482
- showAuthTooltip?: boolean;
483
- // (undocumented)
484
- showServerActions?: boolean;
485
- // (undocumented)
486
- ssr?: boolean;
487
- }
488
-
489
- // @public (undocumented)
490
- type StickyHeaderConfig = {
491
- offsetTop?: number;
492
- };
493
-
494
- // @public (undocumented)
495
- export type StickyHeaderProps = ({
496
- show?: boolean;
497
- } & StickyHeaderConfig) | boolean;
498
-
499
- // @public (undocumented)
500
- type TableSortColumnAEP = AEP<ACTION.SORT_COLUMN, ACTION_SUBJECT.TABLE, undefined, {
501
- platform: PLATFORM.WEB;
502
- mode: MODE.RENDERER;
503
- sortOrder: SortOrder;
504
- columnIndex: number;
505
- }, EVENT_TYPE.TRACK>;
506
-
507
- // @public (undocumented)
508
- type TableSortColumnNotAllowedAEP = AEP<ACTION.SORT_COLUMN_NOT_ALLOWED, ACTION_SUBJECT.TABLE, undefined, {
509
- platform: PLATFORM.WEB;
510
- mode: MODE.RENDERER;
511
- }, EVENT_TYPE.TRACK>;
512
-
513
- // @public (undocumented)
514
- export class TextSerializer implements Serializer<string> {
515
- constructor(schema: Schema);
516
- // (undocumented)
517
- static fromSchema(schema?: Schema): TextSerializer;
518
- // (undocumented)
519
- serializeFragment(fragment: Fragment): string;
520
- }
521
-
522
- // @public (undocumented)
523
- interface TextWrapper {
524
- // (undocumented)
525
- content: Node_2[];
526
- // (undocumented)
527
- nodeSize: number;
528
- // (undocumented)
529
- type: {
530
- name: 'textWrapper';
531
- };
532
- }
533
-
534
- // @public (undocumented)
535
- type TransformerProvider<T> = (schema: Schema) => Transformer_2<T>;
536
-
537
- // @public (undocumented)
538
- type UIAEP<Action, ActionSubject, ActionSubjectID, Attributes> = AEP<Action, ActionSubject, ActionSubjectID, Attributes, EVENT_TYPE.UI>;
539
-
540
- // @public (undocumented)
541
- type VisitLinkAEP = AEP<ACTION.VISITED, ACTION_SUBJECT.LINK, undefined, {
542
- platform: PLATFORM.WEB;
543
- mode: MODE.RENDERER;
544
- }, EVENT_TYPE.TRACK>;
545
-
546
- // @public (undocumented)
547
- type VisitMediaLinkAEP = AEP<ACTION.VISITED, ACTION_SUBJECT.MEDIA, ACTION_SUBJECT_ID.LINK, {
548
- platform: PLATFORM.WEB;
549
- mode: MODE.RENDERER;
550
- }, EVENT_TYPE.TRACK>;
551
-
552
- // (No @packageDocumentation comment for this package)
553
-
554
- ```