@atlaskit/adf-schema 23.2.0 → 23.3.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/report.api.md CHANGED
@@ -11,8 +11,7 @@ import { Node as Node_2 } from 'prosemirror-model';
11
11
  import { NodeSpec } from 'prosemirror-model';
12
12
  import { Schema } from 'prosemirror-model';
13
13
 
14
- // @public (undocumented)
15
- export function acNameToEmoji(
14
+ export declare function acNameToEmoji(
16
15
  acName: NameToEmoji,
17
16
  ): {
18
17
  id: string;
@@ -20,8 +19,41 @@ export function acNameToEmoji(
20
19
  text: string;
21
20
  };
22
21
 
23
- // @public (undocumented)
24
- export function acShortcutToEmoji(
22
+ /**
23
+ * Confluence glyphs ac:name of <ac:emoticon /> map to new emojis
24
+ * {
25
+ * [ac:name] : ['emoji-id', 'emoji-shortName', 'emoji-fallback']
26
+ * ...
27
+ * }
28
+ * Glyphs that do not map to Fabric Emoji
29
+ * will be mapped to Emoji Id '2b50' (:star:) with preserving ac:name as shortName attribute;
30
+ */
31
+ declare const acNameToEmojiMap: {
32
+ smile: string[];
33
+ sad: string[];
34
+ cheeky: string[];
35
+ laugh: string[];
36
+ wink: string[];
37
+ information: string[];
38
+ tick: string[];
39
+ cross: string[];
40
+ warning: string[];
41
+ plus: string[];
42
+ minus: string[];
43
+ question: string[];
44
+ 'thumbs-up': string[];
45
+ 'thumbs-down': string[];
46
+ 'light-on': string[];
47
+ 'yellow-star': string[];
48
+ 'light-off': string[];
49
+ 'red-star': string[];
50
+ 'green-star': string[];
51
+ 'blue-star': string[];
52
+ heart: string[];
53
+ 'broken-heart': string[];
54
+ };
55
+
56
+ export declare function acShortcutToEmoji(
25
57
  hipchatEmoticonShortName: string,
26
58
  ): {
27
59
  id: string;
@@ -29,100 +61,82 @@ export function acShortcutToEmoji(
29
61
  text: string;
30
62
  };
31
63
 
32
- // @public (undocumented)
33
- export const alignment: MarkSpec;
64
+ export declare const alignment: MarkSpec;
34
65
 
35
- // @public (undocumented)
36
- export interface AlignmentAttributes {
37
- // (undocumented)
66
+ export declare interface AlignmentAttributes {
38
67
  align: 'center' | 'end';
39
68
  }
40
69
 
41
- // @public
42
- export interface AlignmentMarkDefinition {
43
- // (undocumented)
44
- attrs: AlignmentAttributes;
45
- // (undocumented)
70
+ /**
71
+ * @name alignment_mark
72
+ */
73
+ export declare interface AlignmentMarkDefinition {
46
74
  type: 'alignment';
75
+ attrs: AlignmentAttributes;
47
76
  }
48
77
 
49
- // @public
50
- export const alignmentPositionMap: {
78
+ /** TODO: Flip these positions for RTL */
79
+ export declare const alignmentPositionMap: {
51
80
  [key: string]: string;
52
81
  };
53
82
 
54
- // @public (undocumented)
55
- export const annotation: MarkSpec;
83
+ export declare const annotation: MarkSpec;
56
84
 
57
- // @public (undocumented)
58
- export type AnnotationDataAttributes = {
85
+ export declare type AnnotationDataAttributes = {
59
86
  'data-mark-type': string;
60
87
  'data-mark-annotation-type': AnnotationTypes;
61
88
  'data-id': AnnotationId;
62
89
  'data-mark-annotation-state'?: AnnotationMarkStates;
63
90
  };
64
91
 
65
- // @public (undocumented)
66
- export type AnnotationId = string;
92
+ export declare type AnnotationId = string;
67
93
 
68
- // @public (undocumented)
69
- export interface AnnotationMarkAttributes {
70
- // (undocumented)
71
- annotationType: AnnotationTypes;
72
- // (undocumented)
94
+ export declare interface AnnotationMarkAttributes {
73
95
  id: AnnotationId;
96
+ annotationType: AnnotationTypes;
74
97
  }
75
98
 
76
- // @public
77
- export interface AnnotationMarkDefinition {
78
- // (undocumented)
79
- attrs: AnnotationMarkAttributes;
80
- // (undocumented)
99
+ /**
100
+ * @name annotation_mark
101
+ */
102
+ export declare interface AnnotationMarkDefinition {
81
103
  type: 'annotation';
104
+ attrs: AnnotationMarkAttributes;
82
105
  }
83
106
 
84
- // @public (undocumented)
85
- export enum AnnotationMarkStates {
86
- // (undocumented)
87
- ACTIVE = 'active',
88
- // (undocumented)
107
+ export declare enum AnnotationMarkStates {
89
108
  RESOLVED = 'resolved',
109
+ ACTIVE = 'active',
90
110
  }
91
111
 
92
- // @public (undocumented)
93
- export enum AnnotationTypes {
94
- // (undocumented)
112
+ export declare enum AnnotationTypes {
95
113
  INLINE_COMMENT = 'inlineComment',
96
114
  }
97
115
 
98
- // @public (undocumented)
99
- export const B100 = '#4C9AFF';
116
+ export declare const B100 = '#4C9AFF';
100
117
 
101
- // @public (undocumented)
102
- export const B400 = '#0052CC';
118
+ export declare const B400 = '#0052CC';
103
119
 
104
- // @public (undocumented)
105
- export const B50 = '#DEEBFF';
120
+ export declare const B50 = '#DEEBFF';
106
121
 
107
- // @public (undocumented)
108
- export const B500 = '#0747A6';
122
+ export declare const B500 = '#0747A6';
109
123
 
110
- // @public (undocumented)
111
- export const B75 = '#B3D4FF';
124
+ export declare const B75 = '#B3D4FF';
112
125
 
113
- // @public (undocumented)
114
- export const blockCard: NodeSpec;
126
+ export declare const blockCard: NodeSpec;
115
127
 
116
- // @public
117
- export interface BlockCardDefinition {
118
- // (undocumented)
119
- attrs: CardAttributes;
120
- // (undocumented)
128
+ /**
129
+ * @name blockCard_node
130
+ */
131
+ export declare interface BlockCardDefinition {
121
132
  type: 'blockCard';
133
+ attrs: CardAttributes;
122
134
  }
123
135
 
124
- // @public
125
- export type BlockContent =
136
+ /**
137
+ * @name block_content
138
+ */
139
+ export declare type BlockContent =
126
140
  | PanelDefinition
127
141
  | ParagraphDefinition
128
142
  | ParagraphWithAlignmentDefinition
@@ -144,66 +158,91 @@ export type BlockContent =
144
158
  | BlockCardDefinition
145
159
  | EmbedCardDefinition;
146
160
 
147
- // @public (undocumented)
148
- export const blockquote: NodeSpec;
161
+ export declare const blockquote: NodeSpec;
149
162
 
150
- // @public
151
- export interface BlockQuoteDefinition {
152
- content: Array<ParagraphDefinition>;
153
- // (undocumented)
163
+ /**
164
+ * @name blockquote_node
165
+ */
166
+ export declare interface BlockQuoteDefinition {
154
167
  type: 'blockquote';
168
+ /**
169
+ * @minItems 1
170
+ * @allowUnsupportedBlock true
171
+ */
172
+ content: Array<ParagraphDefinition>;
155
173
  }
156
174
 
157
- // @public (undocumented)
158
- export const bodiedExtension: NodeSpec;
175
+ export declare const bodiedExtension: NodeSpec;
176
+
177
+ /**
178
+ * @name bodiedExtension_node
179
+ */
180
+ declare interface BodiedExtensionBaseDefinition {
181
+ type: 'bodiedExtension';
182
+ attrs: ExtensionAttributes;
183
+ marks?: Array<any>;
184
+ /**
185
+ * @minItems 1
186
+ * @allowUnsupportedBlock true
187
+ */
188
+ content: Array<NonNestableBlockContent>;
189
+ }
159
190
 
160
- // @public
161
- export type BodiedExtensionDefinition = BodiedExtensionBaseDefinition &
191
+ /**
192
+ * @name bodiedExtension_with_marks_node
193
+ */
194
+ export declare type BodiedExtensionDefinition = BodiedExtensionBaseDefinition &
162
195
  MarksObject<DataConsumerDefinition | FragmentDefinition>;
163
196
 
164
- // @public (undocumented)
165
- export const breakout: MarkSpec;
197
+ export declare const breakout: MarkSpec;
166
198
 
167
- // @public (undocumented)
168
- export type BreakoutMarkAttrs = {
199
+ export declare type BreakoutMarkAttrs = {
169
200
  mode: 'wide' | 'full-width';
170
201
  };
171
202
 
172
- // @public
173
- export interface BreakoutMarkDefinition {
174
- // (undocumented)
175
- attrs: BreakoutMarkAttrs;
176
- // (undocumented)
203
+ /**
204
+ * @name breakout_mark
205
+ */
206
+ export declare interface BreakoutMarkDefinition {
177
207
  type: 'breakout';
208
+ attrs: BreakoutMarkAttrs;
178
209
  }
179
210
 
180
- // @public (undocumented)
181
- export function buildAnnotationMarkDataAttributes({
211
+ export declare function buildAnnotationMarkDataAttributes({
182
212
  id,
183
213
  annotationType,
184
214
  state,
185
215
  }: BuildDataAttributesProps): AnnotationDataAttributes;
186
216
 
187
- // @public (undocumented)
188
- export const bulletList: NodeSpec;
217
+ declare type BuildDataAttributesProps = AnnotationMarkAttributes & {
218
+ state?: AnnotationMarkStates | undefined | null;
219
+ };
189
220
 
190
- // @public
191
- export interface BulletListDefinition {
192
- // (undocumented)
193
- content: Array<ListItemDefinition>;
194
- // (undocumented)
221
+ export declare const bulletList: NodeSpec;
222
+
223
+ /**
224
+ * @name bulletList_node
225
+ */
226
+ export declare interface BulletListDefinition {
195
227
  type: 'bulletList';
228
+ /**
229
+ * @minItems 1
230
+ */
231
+ content: Array<ListItemDefinition>;
196
232
  }
197
233
 
198
- // @public (undocumented)
199
- export const bulletListSelector = '.ak-ul';
234
+ export declare const bulletListSelector = '.ak-ul';
200
235
 
201
- // @public (undocumented)
202
- export const caption: NodeSpec;
236
+ export declare const caption: NodeSpec;
203
237
 
204
- // @public
205
- export interface CaptionDefinition {
206
- // (undocumented)
238
+ /**
239
+ * @name caption_node
240
+ */
241
+ export declare interface CaptionDefinition {
242
+ type: 'caption';
243
+ /**
244
+ * @minItems 0
245
+ */
207
246
  content: Array<
208
247
  | InlineFormattedText
209
248
  | InlineCode
@@ -215,17 +254,13 @@ export interface CaptionDefinition {
215
254
  | InlineCardDefinition
216
255
  | StatusDefinition
217
256
  >;
218
- // (undocumented)
219
- type: 'caption';
220
257
  }
221
258
 
222
- // @public (undocumented)
223
- export type CardAttributes = UrlType | DataType;
259
+ export declare type CardAttributes = UrlType | DataType;
224
260
 
225
261
  export { CellAttributes };
226
262
 
227
- // @public (undocumented)
228
- export type CellDomAttrs = {
263
+ export declare type CellDomAttrs = {
229
264
  colspan?: string;
230
265
  rowspan?: string;
231
266
  style?: string;
@@ -234,95 +269,131 @@ export type CellDomAttrs = {
234
269
  class?: string;
235
270
  };
236
271
 
237
- // @public (undocumented)
238
- export const code: MarkSpec;
272
+ export declare const code: MarkSpec;
239
273
 
240
- // @public (undocumented)
241
- export const codeBlock: NodeSpec;
274
+ export declare const codeBlock: NodeSpec;
242
275
 
243
- // @public (undocumented)
244
- export type CodeBlockAttrs = {
276
+ export declare type CodeBlockAttrs = {
245
277
  language?: string;
246
278
  };
247
279
 
248
- // @public
249
- export type CodeBlockBaseDefinition = {
280
+ /**
281
+ * @name codeBlock_node
282
+ */
283
+ export declare type CodeBlockBaseDefinition = {
250
284
  type: 'codeBlock';
285
+ /**
286
+ * @allowUnsupportedInline true
287
+ */
251
288
  content?: Array<TextDefinition & NoMark>;
252
289
  marks?: Array<any>;
253
290
  attrs?: CodeBlockAttrs;
254
291
  };
255
292
 
256
- // @public
257
- export type CodeBlockDefinition = CodeBlockBaseDefinition & NoMark;
293
+ /**
294
+ * @name codeBlock_with_no_marks_node
295
+ */
296
+ export declare type CodeBlockDefinition = CodeBlockBaseDefinition & NoMark;
258
297
 
259
- // @public (undocumented)
260
- export const codeBlockToJSON: (
298
+ export declare const codeBlockToJSON: (
261
299
  node: Node_2,
262
300
  ) => {
263
301
  attrs: Record<string, any>;
264
302
  };
265
303
 
266
- // @public
267
- export type CodeBlockWithMarksDefinition = CodeBlockBaseDefinition &
304
+ /**
305
+ * @name codeBlock_with_marks_node
306
+ */
307
+ export declare type CodeBlockWithMarksDefinition = CodeBlockBaseDefinition &
268
308
  MarksObject<BreakoutMarkDefinition>;
269
309
 
270
- // @public
271
- export interface CodeDefinition {
272
- // (undocumented)
310
+ /**
311
+ * @name code_mark
312
+ */
313
+ export declare interface CodeDefinition {
273
314
  type: 'code';
274
315
  }
275
316
 
276
- // @public (undocumented)
277
- export const colorPalette: Map<string, TextColorKey>;
317
+ export declare const colorPalette: Map<string, TextColorKey>;
278
318
 
279
- // @public (undocumented)
280
- export const colorPaletteExtended: Map<string, TextColorKey>;
319
+ export declare const colorPaletteExtended: Map<string, TextColorKey>;
281
320
 
282
- // @public (undocumented)
283
- export const confluenceInlineComment: MarkSpec;
321
+ export declare const confluenceInlineComment: MarkSpec;
284
322
 
285
- // @public (undocumented)
286
- export const confluenceJiraIssue: NodeSpec;
323
+ export declare const confluenceJiraIssue: NodeSpec;
324
+
325
+ declare interface ConfluenceLinkMetadata {
326
+ linkType: string;
327
+ versionAtSave?: string | null;
328
+ fileName?: string | null;
329
+ spaceKey?: string | null;
330
+ contentTitle?: string | null;
331
+ isRenamedTitle?: boolean;
332
+ anchorName?: string | null;
333
+ contentId?: string | null;
334
+ container?: ConfluenceLinkMetadata;
335
+ }
287
336
 
288
- // @public (undocumented)
289
- export const confluenceUnsupportedBlock: NodeSpec;
337
+ export declare const confluenceUnsupportedBlock: NodeSpec;
290
338
 
291
- // @public (undocumented)
292
- export const confluenceUnsupportedInline: NodeSpec;
339
+ export declare const confluenceUnsupportedInline: NodeSpec;
293
340
 
294
- // @public (undocumented)
295
- export const copyPrivateMediaAttributes: (
341
+ export declare const copyPrivateMediaAttributes: (
296
342
  from: Record<string, any>,
297
343
  to: Record<string, any>,
298
344
  map?: ((str: string) => string) | undefined,
299
345
  ) => void;
300
346
 
301
- // @public
302
- export function createSchema<
347
+ /**
348
+ * Creates a schema preserving order of marks and nodes.
349
+ */
350
+ export declare function createSchema<
303
351
  N extends string = string,
304
352
  M extends string = string
305
353
  >(config: SchemaConfig<N, M>): Schema<N, M>;
306
354
 
307
- // @public (undocumented)
308
- export const dataConsumer: MarkSpec;
355
+ export declare const dataConsumer: MarkSpec;
309
356
 
310
- // @public (undocumented)
311
- export interface DataConsumerAttributes {
312
- // (undocumented)
357
+ export declare interface DataConsumerAttributes {
358
+ /**
359
+ * @minItems 1
360
+ */
313
361
  sources: Array<DataConsumerSource>;
314
362
  }
315
363
 
316
- // @public
317
- export interface DataConsumerDefinition {
318
- // (undocumented)
319
- attrs: DataConsumerAttributes;
320
- // (undocumented)
364
+ /**
365
+ * @name dataConsumer_mark
366
+ * @description This mark is used for metadata surrounding a node consuming data
367
+ * from a given source node
368
+ */
369
+ export declare interface DataConsumerDefinition {
321
370
  type: 'dataConsumer';
371
+ attrs: DataConsumerAttributes;
322
372
  }
323
373
 
324
- // @public
325
- export const dataConsumerToJSON: (
374
+ /**
375
+ * This annotation is purely for reference, & does _nothing_ given annotating
376
+ * `minLength` on an array of strings is not supported with our schema+spec
377
+ * generator.
378
+ *
379
+ * We're keeping it to signal that data consumer `sources` shouldn't be empty
380
+ * strings
381
+ *
382
+ * // @minLength 1
383
+ */
384
+ declare type DataConsumerSource = string;
385
+
386
+ /**
387
+ * We want to ensure any "invalid ADF" doesn't get serialised, but the entire
388
+ * mark itself is not valid without a non-empty `sources`.
389
+ *
390
+ * We _almost could_ simply return `null` if sources length is < 0 & would fit
391
+ * the type signature of prosemirror-model's `fragment` but not `mark`'s toJSON.
392
+ *
393
+ * So we'll leave any extra transformation checks in
394
+ * `editor-json-transformer`(?)
395
+ */
396
+ export declare const dataConsumerToJSON: (
326
397
  mark: Mark,
327
398
  ) => {
328
399
  type: string;
@@ -331,61 +402,75 @@ export const dataConsumerToJSON: (
331
402
  };
332
403
  };
333
404
 
334
- // @public (undocumented)
335
- export interface DataType {
405
+ export declare interface DataType {
406
+ /**
407
+ * @additionalProperties true
408
+ */
336
409
  data: object;
337
410
  }
338
411
 
339
- // @public (undocumented)
340
- export const date: NodeSpec;
412
+ export declare const date: NodeSpec;
341
413
 
342
- // @public
343
- export interface DateDefinition {
344
- // (undocumented)
414
+ /**
415
+ * @name date_node
416
+ */
417
+ export declare interface DateDefinition {
418
+ type: 'date';
345
419
  attrs: {
420
+ /**
421
+ * @minLength 1
422
+ */
346
423
  timestamp: string;
347
424
  };
348
- // (undocumented)
349
- type: 'date';
350
425
  }
351
426
 
352
- // @public (undocumented)
353
- export const decisionItem: NodeSpec;
427
+ export declare const decisionItem: NodeSpec;
354
428
 
355
- // @public
356
- export interface DecisionItemDefinition {
357
- // (undocumented)
429
+ /**
430
+ * @name decisionItem_node
431
+ */
432
+ export declare interface DecisionItemDefinition {
433
+ type: 'decisionItem';
434
+ /**
435
+ * @allowUnsupportedInline true
436
+ */
437
+ content?: Array<Inline>;
358
438
  attrs: {
359
439
  localId: string;
360
440
  state: string;
361
441
  };
362
- content?: Array<Inline>;
363
- // (undocumented)
364
- type: 'decisionItem';
365
442
  }
366
443
 
367
- // @public (undocumented)
368
- export const decisionList: NodeSpec;
444
+ export declare const decisionList: NodeSpec;
369
445
 
370
- // @public
371
- export interface DecisionListDefinition {
372
- // (undocumented)
446
+ /**
447
+ * @name decisionList_node
448
+ */
449
+ export declare interface DecisionListDefinition {
450
+ type: 'decisionList';
451
+ /**
452
+ * @minItems 1
453
+ * @allowUnsupportedBlock true
454
+ */
455
+ content: Array<DecisionItemDefinition>;
373
456
  attrs: {
374
457
  localId: string;
375
458
  };
376
- content: Array<DecisionItemDefinition>;
377
- // (undocumented)
378
- type: 'decisionList';
379
459
  }
380
460
 
381
- // @public (undocumented)
382
- export const decisionListSelector: string;
461
+ export declare const decisionListSelector: string;
383
462
 
384
- // @public (undocumented)
385
- export const doc: NodeSpec;
463
+ export declare const doc: NodeSpec;
386
464
 
387
- // @public
388
- export interface DocNode {
465
+ /**
466
+ * @name doc_node
467
+ */
468
+ export declare interface DocNode {
469
+ version: 1;
470
+ type: 'doc';
471
+ /**
472
+ * @allowUnsupportedBlock true
473
+ */
389
474
  content: Array<
390
475
  | BlockContent
391
476
  | LayoutSectionDefinition
@@ -393,73 +478,78 @@ export interface DocNode {
393
478
  | ExpandWithBreakoutDefinition
394
479
  | ParagraphWithIndentationDefinition
395
480
  >;
396
- // (undocumented)
397
- type: 'doc';
398
- // (undocumented)
399
- version: 1;
400
481
  }
401
482
 
402
- // @public (undocumented)
403
- export const em: MarkSpec;
483
+ export declare const em: MarkSpec;
404
484
 
405
- // @public (undocumented)
406
- export const embedCard: NodeSpec;
485
+ export declare const embedCard: NodeSpec;
407
486
 
408
- // @public (undocumented)
409
- export interface EmbedCardAttributes extends RichMediaAttributes {
410
- // (undocumented)
411
- originalHeight?: number;
412
- // (undocumented)
487
+ export declare interface EmbedCardAttributes extends RichMediaAttributes {
413
488
  originalWidth?: number;
489
+ originalHeight?: number;
490
+ /**
491
+ * @validatorFn safeUrl
492
+ */
414
493
  url: string;
415
494
  }
416
495
 
417
- // @public
418
- export interface EmbedCardDefinition {
419
- // (undocumented)
420
- attrs: EmbedCardAttributes;
421
- // (undocumented)
496
+ /**
497
+ * @name embedCard_node
498
+ */
499
+ export declare interface EmbedCardDefinition {
422
500
  type: 'embedCard';
501
+ attrs: EmbedCardAttributes;
423
502
  }
424
503
 
425
- // @public
426
- export interface EmDefinition {
427
- // (undocumented)
504
+ /**
505
+ * @name em_mark
506
+ */
507
+ export declare interface EmDefinition {
428
508
  type: 'em';
429
509
  }
430
510
 
431
- // @public (undocumented)
432
- export const emoji: NodeSpec;
511
+ export declare const emoji: NodeSpec;
433
512
 
434
- // @public (undocumented)
435
- export interface EmojiAttributes {
436
- // (undocumented)
513
+ export declare interface EmojiAttributes {
437
514
  id?: string;
438
- // (undocumented)
439
515
  shortName: string;
440
- // (undocumented)
441
516
  text?: string;
442
517
  }
443
518
 
444
- // @public
445
- export interface EmojiDefinition {
446
- // (undocumented)
447
- attrs: EmojiAttributes;
448
- // (undocumented)
519
+ /**
520
+ * @name emoji_node
521
+ */
522
+ export declare interface EmojiDefinition {
449
523
  type: 'emoji';
524
+ attrs: EmojiAttributes;
450
525
  }
451
526
 
452
- // @public (undocumented)
453
- export function emojiIdToAcName(emojiId: string): never;
527
+ export declare function emojiIdToAcName(emojiId: string): never;
454
528
 
455
- // @public (undocumented)
456
- export const expand: NodeSpec;
529
+ export declare const expand: NodeSpec;
530
+
531
+ /**
532
+ * @name expand_node
533
+ */
534
+ declare interface ExpandBaseDefinition {
535
+ type: 'expand';
536
+ attrs: {
537
+ title?: string;
538
+ };
539
+ /**
540
+ * @minItems 1
541
+ * @allowUnsupportedBlock true
542
+ */
543
+ content: Array<NonNestableBlockContent>;
544
+ marks?: Array<any>;
545
+ }
457
546
 
458
- // @public
459
- export type ExpandDefinition = ExpandBaseDefinition & NoMark;
547
+ /**
548
+ * @name expand_with_no_mark_node
549
+ */
550
+ export declare type ExpandDefinition = ExpandBaseDefinition & NoMark;
460
551
 
461
- // @public (undocumented)
462
- export const expandToJSON: (
552
+ export declare const expandToJSON: (
463
553
  node: Node_2,
464
554
  ) => {
465
555
  attrs: {
@@ -467,53 +557,79 @@ export const expandToJSON: (
467
557
  };
468
558
  };
469
559
 
470
- // @public (undocumented)
471
- export const extension: NodeSpec;
560
+ /**
561
+ * @name expand_with_breakout_mark_node
562
+ */
563
+ declare type ExpandWithBreakoutDefinition = ExpandBaseDefinition &
564
+ MarksObject<BreakoutMarkDefinition>;
565
+
566
+ export declare const extension: NodeSpec;
567
+
568
+ declare interface ExtensionAttributes {
569
+ /**
570
+ * @minLength 1
571
+ */
572
+ extensionKey: string;
573
+ /**
574
+ * @minLength 1
575
+ */
576
+ extensionType: string;
577
+ parameters?: object;
578
+ text?: string;
579
+ layout?: ExtensionLayout;
580
+ /**
581
+ * @minLength 1
582
+ */
583
+ localId?: string;
584
+ }
472
585
 
473
- // @public
474
- export type ExtensionDefinition = ExtensionBaseDefinition &
586
+ /**
587
+ * @name extension_node
588
+ */
589
+ declare interface ExtensionBaseDefinition {
590
+ type: 'extension';
591
+ attrs: ExtensionAttributes;
592
+ marks?: Array<any>;
593
+ }
594
+
595
+ /**
596
+ * @name extension_with_marks_node
597
+ */
598
+ export declare type ExtensionDefinition = ExtensionBaseDefinition &
475
599
  MarksObject<DataConsumerDefinition | FragmentDefinition>;
476
600
 
477
- // @public (undocumented)
478
- export type ExtensionLayout = 'default' | 'wide' | 'full-width';
601
+ export declare type ExtensionLayout = 'default' | 'wide' | 'full-width';
479
602
 
480
- // @public (undocumented)
481
- export interface ExternalMediaAttributes {
482
- // (undocumented)
483
- __external?: boolean;
484
- // (undocumented)
485
- alt?: string;
486
- // (undocumented)
487
- height?: number;
488
- // (undocumented)
603
+ export declare interface ExternalMediaAttributes {
489
604
  type: 'external';
490
- // (undocumented)
491
605
  url: string;
492
- // (undocumented)
606
+ alt?: string;
493
607
  width?: number;
608
+ height?: number;
609
+ __external?: boolean;
494
610
  }
495
611
 
496
- // @public (undocumented)
497
- export const fragment: MarkSpec;
612
+ export declare const fragment: MarkSpec;
498
613
 
499
- // @public (undocumented)
500
- export interface FragmentAttributes {
501
- // (undocumented)
614
+ export declare interface FragmentAttributes {
615
+ /**
616
+ * @minLength 1
617
+ */
502
618
  localId: LocalId;
503
- // (undocumented)
504
619
  name?: string;
505
620
  }
506
621
 
507
- // @public
508
- export interface FragmentDefinition {
509
- // (undocumented)
510
- attrs: FragmentAttributes;
511
- // (undocumented)
622
+ /**
623
+ * @name fragment_mark
624
+ * @description Indicates that the elements decorated with this mark belong to a "fragment" entity, which represents a collection of ADF nodes.
625
+ * This entity can be referred to later by its `localId` attribute.
626
+ */
627
+ export declare interface FragmentDefinition {
512
628
  type: 'fragment';
629
+ attrs: FragmentAttributes;
513
630
  }
514
631
 
515
- // @public (undocumented)
516
- export const fragmentToJSON: (
632
+ export declare const fragmentToJSON: (
517
633
  mark: Mark,
518
634
  ) => {
519
635
  type: string;
@@ -523,29 +639,21 @@ export const fragmentToJSON: (
523
639
  };
524
640
  };
525
641
 
526
- // @public (undocumented)
527
- export const G200 = '#57D9A3';
642
+ export declare const G200 = '#57D9A3';
528
643
 
529
- // @public (undocumented)
530
- export const G300 = '#36B37E';
644
+ export declare const G300 = '#36B37E';
531
645
 
532
- // @public (undocumented)
533
- export const G400 = '#00875A';
646
+ export declare const G400 = '#00875A';
534
647
 
535
- // @public (undocumented)
536
- export const G50 = '#E3FCEF';
648
+ export declare const G50 = '#E3FCEF';
537
649
 
538
- // @public (undocumented)
539
- export const G500 = '#006644';
650
+ export declare const G500 = '#006644';
540
651
 
541
- // @public (undocumented)
542
- export const G75 = '#ABF5D1';
652
+ export declare const G75 = '#ABF5D1';
543
653
 
544
- // @public (undocumented)
545
- export const generateUuid: () => string;
654
+ export declare const generateUuid: () => string;
546
655
 
547
- // @public (undocumented)
548
- export const getCellAttrs: (
656
+ export declare const getCellAttrs: (
549
657
  dom: HTMLElement,
550
658
  defaultValues?: CellAttributes,
551
659
  ) => {
@@ -555,11 +663,13 @@ export const getCellAttrs: (
555
663
  background: string | null;
556
664
  };
557
665
 
558
- // @public
559
- export const getCellDomAttrs: (node: Node_2) => CellDomAttrs;
666
+ /**
667
+ * gets cell dom attributes based on node attributes
668
+ * @returns CellDomAttrs
669
+ */
670
+ export declare const getCellDomAttrs: (node: Node_2) => CellDomAttrs;
560
671
 
561
- // @public (undocumented)
562
- export function getEmojiAcName({
672
+ export declare function getEmojiAcName({
563
673
  id,
564
674
  shortName,
565
675
  }: {
@@ -567,84 +677,109 @@ export function getEmojiAcName({
567
677
  shortName: string;
568
678
  }): string;
569
679
 
570
- // @public (undocumented)
571
- export function getLinkMatch(str?: string): Match | null;
680
+ export declare function getLinkMatch(str?: string): Match | null;
572
681
 
573
- // @public (undocumented)
574
- export const hardBreak: NodeSpec;
682
+ export declare const hardBreak: NodeSpec;
575
683
 
576
- // @public
577
- export interface HardBreakDefinition {
578
- // (undocumented)
684
+ /**
685
+ * @name hardBreak_node
686
+ */
687
+ export declare interface HardBreakDefinition {
688
+ type: 'hardBreak';
579
689
  attrs?: {
580
690
  text?: '\n';
581
691
  };
582
- // (undocumented)
583
- type: 'hardBreak';
584
692
  }
585
693
 
586
- // @public (undocumented)
587
- export const heading: NodeSpec;
694
+ export declare const heading: NodeSpec;
588
695
 
589
- // @public
590
- export interface HeadingBaseDefinition {
591
- // (undocumented)
696
+ /**
697
+ * @name heading_node
698
+ */
699
+ export declare interface HeadingBaseDefinition {
700
+ type: 'heading';
701
+ /**
702
+ * @allowUnsupportedInline true
703
+ */
704
+ content?: Array<Inline>;
705
+ marks?: Array<any>;
592
706
  attrs: {
707
+ /**
708
+ * @minimum 1
709
+ * @maximum 6
710
+ */
593
711
  level: number;
594
712
  };
595
- content?: Array<Inline>;
596
- // (undocumented)
597
- marks?: Array<any>;
598
- // (undocumented)
599
- type: 'heading';
600
713
  }
601
714
 
602
- // @public
603
- export type HeadingDefinition = HeadingBaseDefinition & NoMark;
715
+ /**
716
+ * @name heading_with_no_marks_node
717
+ */
718
+ export declare type HeadingDefinition = HeadingBaseDefinition & NoMark;
604
719
 
605
- // @public
606
- export type HeadingWithAlignmentDefinition = HeadingBaseDefinition &
720
+ /**
721
+ * @name heading_with_alignment_node
722
+ */
723
+ export declare type HeadingWithAlignmentDefinition = HeadingBaseDefinition &
607
724
  MarksObject<AlignmentMarkDefinition>;
608
725
 
609
- // @public
610
- export type HeadingWithIndentationDefinition = HeadingBaseDefinition &
726
+ /**
727
+ * @name heading_with_indentation_node
728
+ */
729
+ export declare type HeadingWithIndentationDefinition = HeadingBaseDefinition &
611
730
  MarksObject<IndentationMarkDefinition>;
612
731
 
613
- // @public (undocumented)
614
- export type HeadingWithMarksDefinition =
732
+ export declare type HeadingWithMarksDefinition =
615
733
  | HeadingWithAlignmentDefinition
616
734
  | HeadingWithIndentationDefinition;
617
735
 
618
- // @public
619
- export function hexToRgb(color: string): string | null;
620
-
621
- // @public
622
- export function hexToRgba(rawColor: string, alpha: number): string | null;
736
+ /**
737
+ * Converts hex color format to rgb.
738
+ * Works well with full hex color format and shortcut as well.
739
+ *
740
+ * @param hex - hex color string (#xxx, or #xxxxxx)
741
+ */
742
+ export declare function hexToRgb(color: string): string | null;
743
+
744
+ /**
745
+ * Converts hex color format to rgba.
746
+ *
747
+ * @param hex - hex color string (#xxx, or #xxxxxx)
748
+ */
749
+ export declare function hexToRgba(
750
+ rawColor: string,
751
+ alpha: number,
752
+ ): string | null;
623
753
 
624
- // @public (undocumented)
625
- export const image: NodeSpec;
754
+ export declare const image: NodeSpec;
626
755
 
627
- // @public (undocumented)
628
- export const indentation: MarkSpec;
756
+ export declare const indentation: MarkSpec;
629
757
 
630
- // @public (undocumented)
631
- export interface IndentationMarkAttributes {
758
+ export declare interface IndentationMarkAttributes {
759
+ /**
760
+ * @minimum 1
761
+ * @maximum 6
762
+ */
632
763
  level: number;
633
764
  }
634
765
 
635
- // @public
636
- export interface IndentationMarkDefinition {
637
- // (undocumented)
638
- attrs: IndentationMarkAttributes;
639
- // (undocumented)
766
+ /**
767
+ * @name indentation_mark
768
+ */
769
+ export declare interface IndentationMarkDefinition {
640
770
  type: 'indentation';
771
+ attrs: IndentationMarkAttributes;
641
772
  }
642
773
 
643
- // @public
644
- export type Inline = InlineFormattedText | InlineCode | InlineAtomic;
774
+ /**
775
+ * @name inline_node
776
+ */
777
+ export declare type Inline = InlineFormattedText | InlineCode | InlineAtomic;
645
778
 
646
- // @public
647
- export type InlineAtomic =
779
+ /**
780
+ * @name atomic_inline_node
781
+ */
782
+ export declare type InlineAtomic =
648
783
  | HardBreakDefinition
649
784
  | MentionDefinition
650
785
  | EmojiDefinition
@@ -655,30 +790,60 @@ export type InlineAtomic =
655
790
  | StatusDefinition
656
791
  | MediaInlineDefinition;
657
792
 
658
- // @public (undocumented)
659
- export const inlineCard: NodeSpec;
793
+ export declare const inlineCard: NodeSpec;
660
794
 
661
- // @public
662
- export interface InlineCardDefinition {
663
- // (undocumented)
664
- attrs: CardAttributes;
665
- // (undocumented)
795
+ /**
796
+ * @name inlineCard_node
797
+ */
798
+ export declare interface InlineCardDefinition {
666
799
  type: 'inlineCard';
800
+ attrs: CardAttributes;
667
801
  }
668
802
 
669
- // @public
670
- export type InlineCode = TextDefinition &
803
+ /**
804
+ * @name code_inline_node
805
+ */
806
+ export declare type InlineCode = TextDefinition &
671
807
  MarksObject<CodeDefinition | LinkDefinition | AnnotationMarkDefinition>;
672
808
 
673
- // @public (undocumented)
674
- export const inlineExtension: NodeSpec;
809
+ export declare const inlineExtension: NodeSpec;
810
+
811
+ declare interface InlineExtensionAttributes {
812
+ /**
813
+ * @minLength 1
814
+ */
815
+ extensionKey: string;
816
+ /**
817
+ * @minLength 1
818
+ */
819
+ extensionType: string;
820
+ parameters?: object;
821
+ text?: string;
822
+ /**
823
+ * @minLength 1
824
+ */
825
+ localId?: string;
826
+ }
827
+
828
+ /**
829
+ * @name inlineExtension_node
830
+ */
831
+ declare interface InlineExtensionBaseDefinition {
832
+ type: 'inlineExtension';
833
+ attrs: InlineExtensionAttributes;
834
+ marks?: Array<any>;
835
+ }
675
836
 
676
- // @public
677
- export type InlineExtensionDefinition = InlineExtensionBaseDefinition &
837
+ /**
838
+ * @name inlineExtension_with_marks_node
839
+ */
840
+ export declare type InlineExtensionDefinition = InlineExtensionBaseDefinition &
678
841
  MarksObject<DataConsumerDefinition | FragmentDefinition>;
679
842
 
680
- // @public
681
- export type InlineFormattedText = TextDefinition &
843
+ /**
844
+ * @name formatted_text_inline_node
845
+ */
846
+ export declare type InlineFormattedText = TextDefinition &
682
847
  MarksObject<
683
848
  | LinkDefinition
684
849
  | EmDefinition
@@ -690,102 +855,127 @@ export type InlineFormattedText = TextDefinition &
690
855
  | AnnotationMarkDefinition
691
856
  >;
692
857
 
693
- // @public
694
- export type InlineLinkText = TextDefinition & MarksObject<LinkDefinition>;
858
+ /**
859
+ * @name link_text_inline_node
860
+ */
861
+ export declare type InlineLinkText = TextDefinition &
862
+ MarksObject<LinkDefinition>;
695
863
 
696
- // @public (undocumented)
697
- export const inlineNodes: Set<string>;
864
+ export declare const inlineNodes: Set<string>;
698
865
 
699
- // @public (undocumented)
700
- export function isHex(color: string): boolean;
866
+ export declare function isHex(color: string): boolean;
701
867
 
702
- // @public (undocumented)
703
- export function isRgb(color: string): boolean;
868
+ export declare function isRgb(color: string): boolean;
704
869
 
705
- // @public
706
- export const isSafeUrl: (url: string) => boolean;
870
+ /**
871
+ * Please notify the Editor Mobile team (Slack: #help-mobilekit) if the logic for this changes.
872
+ */
873
+ export declare const isSafeUrl: (url: string) => boolean;
707
874
 
708
- // @public (undocumented)
709
- export const layoutColumn: NodeSpec;
875
+ export declare const layoutColumn: NodeSpec;
710
876
 
711
- // @public
712
- export interface LayoutColumnDefinition {
713
- // (undocumented)
877
+ /**
878
+ * @name layoutColumn_node
879
+ */
880
+ export declare interface LayoutColumnDefinition {
881
+ type: 'layoutColumn';
714
882
  attrs: {
883
+ /**
884
+ * @minimum 0
885
+ * @maximum 100
886
+ */
715
887
  width: number;
716
888
  };
889
+ /**
890
+ * @minItems 1
891
+ * @allowUnsupportedBlock true
892
+ */
717
893
  content: Array<BlockContent>;
718
- // (undocumented)
719
- type: 'layoutColumn';
720
894
  }
721
895
 
722
- // @public (undocumented)
723
- export const layoutSection: NodeSpec;
896
+ export declare const layoutSection: NodeSpec;
724
897
 
725
- // @public (undocumented)
726
- export type LayoutSectionDefinition =
898
+ /**
899
+ * @name layoutSection_node
900
+ */
901
+ declare type LayoutSectionBaseDefinition = {
902
+ type: 'layoutSection';
903
+ marks?: Array<BreakoutMarkDefinition>;
904
+ content: Array<LayoutColumnDefinition>;
905
+ };
906
+
907
+ export declare type LayoutSectionDefinition =
727
908
  | LayoutSectionFullDefinition
728
909
  | LayoutSectionWithSingleColumnDefinition;
729
910
 
730
- // @public
731
- export type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
911
+ /**
912
+ * Need duplicate `type` and `marks` to make both validator and json-schema satisfied
913
+ */
914
+ /**
915
+ * @name layoutSection_full_node
916
+ */
917
+ export declare type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
732
918
  type: 'layoutSection';
733
919
  marks?: Array<BreakoutMarkDefinition>;
920
+ /**
921
+ * @minItems 2
922
+ * @maxItems 3
923
+ * @allowUnsupportedBlock true
924
+ */
734
925
  content: Array<LayoutColumnDefinition>;
735
926
  };
736
927
 
737
- // @public
738
- export type LayoutSectionWithSingleColumnDefinition = LayoutSectionBaseDefinition & {
928
+ /**
929
+ * @stage 0
930
+ * @name layoutSection_with_single_column_node
931
+ */
932
+ export declare type LayoutSectionWithSingleColumnDefinition = LayoutSectionBaseDefinition & {
739
933
  type: 'layoutSection';
740
934
  marks?: Array<BreakoutMarkDefinition>;
935
+ /**
936
+ * @minItems 1
937
+ * @maxItems 3
938
+ * @allowUnsupportedBlock true
939
+ */
741
940
  content: Array<LayoutColumnDefinition>;
742
941
  };
743
942
 
744
- // @public (undocumented)
745
- export const link: MarkSpec;
943
+ export declare const link: MarkSpec;
746
944
 
747
- // @public (undocumented)
748
- export interface LinkAttributes {
749
- // (undocumented)
750
- __confluenceMetadata?: ConfluenceLinkMetadata;
751
- // (undocumented)
752
- collection?: string;
945
+ export declare interface LinkAttributes {
946
+ /**
947
+ * @validatorFn safeUrl
948
+ */
753
949
  href: string;
754
- // (undocumented)
950
+ title?: string;
755
951
  id?: string;
756
- // (undocumented)
952
+ collection?: string;
757
953
  occurrenceKey?: string;
758
- // (undocumented)
759
- title?: string;
954
+ __confluenceMetadata?: ConfluenceLinkMetadata;
760
955
  }
761
956
 
762
- // @public
763
- export interface LinkDefinition {
764
- // (undocumented)
765
- attrs: LinkAttributes;
766
- // (undocumented)
957
+ /**
958
+ * @name link_mark
959
+ */
960
+ export declare interface LinkDefinition {
767
961
  type: 'link';
962
+ attrs: LinkAttributes;
768
963
  }
769
964
 
770
- // @public (undocumented)
771
- export const linkify: LinkifyIt.LinkifyIt;
965
+ export declare const linkify: LinkifyIt.LinkifyIt;
772
966
 
773
- // @public (undocumented)
774
- export const linkifyMatch: (text: string) => Match[];
967
+ export declare const linkifyMatch: (text: string) => Match[];
775
968
 
776
- // @public (undocumented)
777
- export const linkToJSON: (
969
+ export declare const linkToJSON: (
778
970
  mark: Mark,
779
971
  ) => {
780
972
  type: string;
781
973
  attrs: Record<string, string>;
782
974
  };
783
975
 
784
- // @public (undocumented)
785
- export const listItem: NodeSpec;
976
+ export declare const listItem: NodeSpec;
786
977
 
787
- // @public (undocumented)
788
- export interface ListItemArray
978
+ export declare interface ListItemArray
789
979
  extends Array<
790
980
  | ParagraphDefinition
791
981
  | OrderedListDefinition
@@ -793,181 +983,199 @@ export interface ListItemArray
793
983
  | MediaSingleDefinition
794
984
  | CodeBlockDefinition
795
985
  > {
796
- // (undocumented)
797
986
  0: ParagraphDefinition | MediaSingleDefinition | CodeBlockDefinition;
798
987
  }
799
988
 
800
- // @public
801
- export interface ListItemDefinition {
802
- // (undocumented)
803
- content: ListItemArray;
804
- // (undocumented)
989
+ /**
990
+ * @name listItem_node
991
+ */
992
+ export declare interface ListItemDefinition {
805
993
  type: 'listItem';
994
+ /**
995
+ * @minItems 1
996
+ */
997
+ content: ListItemArray;
806
998
  }
807
999
 
808
- // @public
809
- export interface MarksObject<T> {
810
- // (undocumented)
1000
+ declare type LocalId = string;
1001
+
1002
+ /**
1003
+ * @additionalProperties true
1004
+ */
1005
+ export declare interface MarksObject<T> {
811
1006
  marks?: Array<T>;
812
1007
  }
813
1008
 
814
- // @public (undocumented)
815
- export interface Match {
816
- // (undocumented)
1009
+ export declare interface Match {
1010
+ schema: any;
817
1011
  index: number;
818
- // (undocumented)
819
- input?: string;
820
- // (undocumented)
821
1012
  lastIndex: number;
822
- // (undocumented)
823
- length?: number;
824
- // (undocumented)
825
1013
  raw: string;
826
- // (undocumented)
827
- schema: any;
828
- // (undocumented)
829
1014
  text: string;
830
- // (undocumented)
831
1015
  url: string;
1016
+ length?: number;
1017
+ input?: string;
832
1018
  }
833
1019
 
834
- // @public (undocumented)
835
- export const media: NodeSpec;
1020
+ export declare const media: NodeSpec;
836
1021
 
837
- // @public (undocumented)
838
- export type MediaADFAttrs = MediaAttributes | ExternalMediaAttributes;
1022
+ export declare type MediaADFAttrs = MediaAttributes | ExternalMediaAttributes;
839
1023
 
840
- // @public (undocumented)
841
- export interface MediaAttributes extends MediaBaseAttributes {
842
- // (undocumented)
1024
+ export declare interface MediaAttributes extends MediaBaseAttributes {
843
1025
  type: 'file' | 'link';
844
1026
  }
845
1027
 
846
- // @public (undocumented)
847
- export interface MediaBaseAttributes {
848
- // (undocumented)
849
- __contextId?: string | null;
850
- // (undocumented)
851
- __displayType?: MediaDisplayType | null;
852
- // (undocumented)
853
- __external?: boolean;
854
- // (undocumented)
855
- __fileMimeType?: string | null;
856
- // (undocumented)
857
- __fileName?: string | null;
858
- // (undocumented)
859
- __fileSize?: number | null;
860
- // (undocumented)
861
- alt?: string;
862
- // (undocumented)
1028
+ export declare interface MediaBaseAttributes {
1029
+ /**
1030
+ * @minLength 1
1031
+ */
1032
+ id: string;
863
1033
  collection: string;
864
- // (undocumented)
865
1034
  height?: number;
866
- // (undocumented)
867
- id: string;
868
- // (undocumented)
869
- occurrenceKey?: string;
870
- // (undocumented)
871
1035
  width?: number;
1036
+ /**
1037
+ * @minLength 1
1038
+ */
1039
+ occurrenceKey?: string;
1040
+ alt?: string;
1041
+ __fileName?: string | null;
1042
+ __fileSize?: number | null;
1043
+ __fileMimeType?: string | null;
1044
+ __displayType?: MediaDisplayType | null;
1045
+ __contextId?: string | null;
1046
+ __external?: boolean;
872
1047
  }
873
1048
 
874
- // @public
875
- export interface MediaDefinition {
876
- // (undocumented)
1049
+ /**
1050
+ * @additionalProperties true
1051
+ */
1052
+ declare interface MediaCaptionContent {
1053
+ /**
1054
+ * @minItems 1
1055
+ * @maxItems 2
1056
+ * @allowUnsupportedBlock true
1057
+ */
1058
+ content: [MediaDefinition, CaptionDefinition?];
1059
+ }
1060
+
1061
+ /**
1062
+ * @name media_node
1063
+ */
1064
+ export declare interface MediaDefinition {
1065
+ type: 'media';
1066
+ /**
1067
+ * @minItems 1
1068
+ */
877
1069
  attrs: MediaADFAttrs;
878
- // (undocumented)
879
1070
  marks?: Array<LinkDefinition>;
880
- // (undocumented)
881
- type: 'media';
882
1071
  }
883
1072
 
884
- // @public (undocumented)
885
- export type MediaDisplayType = 'file' | 'thumbnail';
1073
+ export declare type MediaDisplayType = 'file' | 'thumbnail';
886
1074
 
887
- // @public (undocumented)
888
- export const mediaGroup: NodeSpec;
1075
+ export declare const mediaGroup: NodeSpec;
889
1076
 
890
- // @public
891
- export interface MediaGroupDefinition {
892
- content: Array<MediaDefinition>;
893
- // (undocumented)
1077
+ /**
1078
+ * @name mediaGroup_node
1079
+ */
1080
+ export declare interface MediaGroupDefinition {
894
1081
  type: 'mediaGroup';
1082
+ /**
1083
+ * @minItems 1
1084
+ * @allowUnsupportedBlock true
1085
+ */
1086
+ content: Array<MediaDefinition>;
895
1087
  }
896
1088
 
897
- // @public (undocumented)
898
- export const mediaInline: NodeSpec;
1089
+ export declare const mediaInline: NodeSpec;
899
1090
 
900
- // @public (undocumented)
901
- export interface MediaInlineAttributes extends MediaBaseAttributes {
902
- // (undocumented)
1091
+ export declare interface MediaInlineAttributes extends MediaBaseAttributes {
903
1092
  data?: object;
904
- // (undocumented)
905
1093
  type?: 'file' | 'link';
906
1094
  }
907
1095
 
908
- // @public
909
- export interface MediaInlineDefinition {
910
- // (undocumented)
1096
+ /**
1097
+ * @name mediaInline_node
1098
+ */
1099
+ export declare interface MediaInlineDefinition {
1100
+ type: 'mediaInline';
911
1101
  attrs: MediaInlineAttributes;
912
- // (undocumented)
913
1102
  marks?: Array<LinkDefinition>;
914
- // (undocumented)
915
- type: 'mediaInline';
916
1103
  }
917
1104
 
918
- // @public (undocumented)
919
- export const mediaSingle: NodeSpec;
1105
+ export declare const mediaSingle: NodeSpec;
920
1106
 
921
- // @public (undocumented)
922
- export type MediaSingleDefinition =
1107
+ /**
1108
+ * @name mediaSingle_node
1109
+ * @additionalProperties true
1110
+ */
1111
+ declare interface MediaSingleBaseDefinition {
1112
+ type: 'mediaSingle';
1113
+ attrs?: RichMediaAttributes;
1114
+ marks?: Array<LinkDefinition>;
1115
+ }
1116
+
1117
+ export declare type MediaSingleDefinition =
923
1118
  | MediaSingleFullDefinition
924
1119
  | MediaSingleWithCaptionDefinition;
925
1120
 
926
- // @public (undocumented)
927
- export const mediaSingleToJSON: (
1121
+ /**
1122
+ * @additionalProperties true
1123
+ */
1124
+ declare interface MediaSingleFullContent {
1125
+ /**
1126
+ * @minItems 1
1127
+ * @maxItems 1
1128
+ * @allowUnsupportedBlock true
1129
+ */
1130
+ content: Array<MediaDefinition>;
1131
+ }
1132
+
1133
+ /**
1134
+ * @name mediaSingle_full_node
1135
+ */
1136
+ declare type MediaSingleFullDefinition = MediaSingleBaseDefinition &
1137
+ MediaSingleFullContent;
1138
+
1139
+ export declare const mediaSingleToJSON: (
928
1140
  node: Node_2,
929
1141
  ) => {
930
1142
  attrs: any;
931
1143
  };
932
1144
 
933
- // @public (undocumented)
934
- export const mediaSingleWithCaption: NodeSpec;
1145
+ export declare const mediaSingleWithCaption: NodeSpec;
935
1146
 
936
- // @public (undocumented)
937
- export const mediaToJSON: (
1147
+ /**
1148
+ * @name mediaSingle_caption_node
1149
+ */
1150
+ declare type MediaSingleWithCaptionDefinition = MediaSingleBaseDefinition &
1151
+ MediaCaptionContent;
1152
+
1153
+ export declare const mediaToJSON: (
938
1154
  node: Node_2,
939
1155
  ) => {
940
1156
  attrs: Record<string, any>;
941
1157
  };
942
1158
 
943
- // @public (undocumented)
944
- export type MediaType = 'file' | 'link' | 'external';
1159
+ export declare type MediaType = 'file' | 'link' | 'external';
945
1160
 
946
- // @public (undocumented)
947
- export const mention: NodeSpec;
1161
+ export declare const mention: NodeSpec;
948
1162
 
949
- // @public (undocumented)
950
- export interface MentionAttributes {
951
- // (undocumented)
952
- accessLevel?: string;
953
- // (undocumented)
1163
+ export declare interface MentionAttributes {
954
1164
  id: string;
955
- // (undocumented)
956
1165
  text?: string;
957
- // (undocumented)
958
1166
  userType?: MentionUserType;
1167
+ accessLevel?: string;
959
1168
  }
960
1169
 
961
- // @public
962
- export interface MentionDefinition {
963
- // (undocumented)
964
- attrs: MentionAttributes;
965
- // (undocumented)
1170
+ /**
1171
+ * @name mention_node
1172
+ */
1173
+ export declare interface MentionDefinition {
966
1174
  type: 'mention';
1175
+ attrs: MentionAttributes;
967
1176
  }
968
1177
 
969
- // @public (undocumented)
970
- export const mentionToJSON: (
1178
+ export declare const mentionToJSON: (
971
1179
  node: Node_2,
972
1180
  ) => {
973
1181
  attrs: {
@@ -975,70 +1183,79 @@ export const mentionToJSON: (
975
1183
  };
976
1184
  };
977
1185
 
978
- // @public (undocumented)
979
- export type MentionUserType = keyof typeof USER_TYPES;
1186
+ export declare type MentionUserType = keyof typeof USER_TYPES;
980
1187
 
981
- // @public (undocumented)
982
- export const N0 = '#FFFFFF';
1188
+ export declare const N0 = '#FFFFFF';
983
1189
 
984
- // @public (undocumented)
985
- export const N20 = '#F4F5F7';
1190
+ export declare const N20 = '#F4F5F7';
986
1191
 
987
- // @public (undocumented)
988
- export const N200 = '#6B778C';
1192
+ export declare const N200 = '#6B778C';
989
1193
 
990
- // @public (undocumented)
991
- export const N30 = '#EBECF0';
1194
+ export declare const N30 = '#EBECF0';
992
1195
 
993
- // @public (undocumented)
994
- export const N300 = '#5E6C84';
1196
+ export declare const N300 = '#5E6C84';
995
1197
 
996
- // @public (undocumented)
997
- export const N40 = '#DFE1E6';
1198
+ export declare const N40 = '#DFE1E6';
998
1199
 
999
- // @public (undocumented)
1000
- export const N50 = '#C1C7D0';
1200
+ export declare const N50 = '#C1C7D0';
1001
1201
 
1002
- // @public (undocumented)
1003
- export const N500 = '#42526E';
1202
+ export declare const N500 = '#42526E';
1004
1203
 
1005
- // @public (undocumented)
1006
- export const N60 = '#B3BAC5';
1204
+ export declare const N60 = '#B3BAC5';
1007
1205
 
1008
- // @public (undocumented)
1009
- export const N80 = '#97A0AF';
1206
+ export declare const N80 = '#97A0AF';
1010
1207
 
1011
- // @public (undocumented)
1012
- export const N800 = '#172B4D';
1208
+ export declare const N800 = '#172B4D';
1013
1209
 
1014
- // @public (undocumented)
1015
- export const N90 = '#8993A4';
1210
+ export declare const N90 = '#8993A4';
1016
1211
 
1017
- // @public (undocumented)
1018
- export type NameToEmoji = keyof typeof acNameToEmojiMap;
1212
+ export declare type NameToEmoji = keyof typeof acNameToEmojiMap;
1019
1213
 
1020
- // @public (undocumented)
1021
- export const nestedExpand: NodeSpec;
1214
+ export declare const nestedExpand: NodeSpec;
1022
1215
 
1023
- // @public
1024
- export type NestedExpandContent = Array<
1216
+ /**
1217
+ * @name nestedExpand_node
1218
+ */
1219
+ declare interface NestedExpandBaseDefinition {
1220
+ type: 'nestedExpand';
1221
+ attrs: {
1222
+ title?: string;
1223
+ };
1224
+ content: NestedExpandContent;
1225
+ }
1226
+
1227
+ /**
1228
+ * @name nestedExpand_content
1229
+ * @minItems 1
1230
+ * @allowUnsupportedBlock true
1231
+ */
1232
+ export declare type NestedExpandContent = Array<
1025
1233
  | ParagraphDefinition
1026
1234
  | HeadingDefinition
1027
1235
  | MediaSingleDefinition
1028
1236
  | MediaGroupDefinition
1029
1237
  >;
1030
1238
 
1031
- // @public
1032
- export type NestedExpandDefinition = NestedExpandBaseDefinition & NoMark;
1033
-
1034
- // @public
1035
- export interface NoMark {
1036
- // (undocumented)
1239
+ /**
1240
+ * @name nestedExpand_with_no_marks_node
1241
+ */
1242
+ export declare type NestedExpandDefinition = NestedExpandBaseDefinition &
1243
+ NoMark;
1244
+
1245
+ /**
1246
+ * @additionalProperties true
1247
+ */
1248
+ export declare interface NoMark {
1249
+ /**
1250
+ * @maxItems 0
1251
+ */
1037
1252
  marks?: Array<any>;
1038
1253
  }
1039
1254
 
1040
- // @public
1041
- export type NonNestableBlockContent =
1255
+ /**
1256
+ * @name non_nestable_block_content
1257
+ */
1258
+ export declare type NonNestableBlockContent =
1042
1259
  | PanelDefinition
1043
1260
  | ParagraphDefinition
1044
1261
  | BlockQuoteDefinition
@@ -1056,72 +1273,72 @@ export type NonNestableBlockContent =
1056
1273
  | BlockCardDefinition
1057
1274
  | EmbedCardDefinition;
1058
1275
 
1059
- // @public
1060
- export function normalizeHexColor(
1276
+ /**
1277
+ * @return String with HEX-coded color
1278
+ */
1279
+ export declare function normalizeHexColor(
1061
1280
  color: string | null,
1062
1281
  defaultColor?: string,
1063
1282
  ): string | null;
1064
1283
 
1065
- // @public
1066
- export function normalizeUrl(url?: string): string;
1284
+ /**
1285
+ * Adds protocol to url if needed.
1286
+ */
1287
+ export declare function normalizeUrl(url?: string): string;
1067
1288
 
1068
- // @public (undocumented)
1069
- export const orderedList: NodeSpec;
1289
+ export declare const orderedList: NodeSpec;
1070
1290
 
1071
- // @public
1072
- export interface OrderedListDefinition {
1073
- // (undocumented)
1291
+ /**
1292
+ * @name orderedList_node
1293
+ */
1294
+ export declare interface OrderedListDefinition {
1295
+ type: 'orderedList';
1296
+ /**
1297
+ * @minItems 1
1298
+ */
1299
+ content: Array<ListItemDefinition>;
1074
1300
  attrs?: {
1301
+ /**
1302
+ * @minimum 1
1303
+ */
1075
1304
  order: number;
1076
1305
  };
1077
- // (undocumented)
1078
- content: Array<ListItemDefinition>;
1079
- // (undocumented)
1080
- type: 'orderedList';
1081
1306
  }
1082
1307
 
1083
- // @public (undocumented)
1084
- export const orderedListSelector = '.ak-ol';
1308
+ export declare const orderedListSelector = '.ak-ol';
1085
1309
 
1086
- // @public (undocumented)
1087
- export const P100 = '#998DD9';
1310
+ export declare const P100 = '#998DD9';
1088
1311
 
1089
- // @public (undocumented)
1090
- export const P300 = '#6554C0';
1312
+ export declare const P300 = '#6554C0';
1091
1313
 
1092
- // @public (undocumented)
1093
- export const P400 = '#5243AA';
1314
+ export declare const P400 = '#5243AA';
1094
1315
 
1095
- // @public (undocumented)
1096
- export const P50 = '#EAE6FF';
1316
+ export declare const P50 = '#EAE6FF';
1097
1317
 
1098
- // @public (undocumented)
1099
- export const P500 = '#403294';
1318
+ export declare const P500 = '#403294';
1100
1319
 
1101
- // @public (undocumented)
1102
- export const P75 = '#C0B6F2';
1320
+ export declare const P75 = '#C0B6F2';
1103
1321
 
1104
- // @public (undocumented)
1105
- export const panel: (allowCustomPanel: boolean) => NodeSpec;
1322
+ export declare const panel: (allowCustomPanel: boolean) => NodeSpec;
1106
1323
 
1107
- // @public (undocumented)
1108
- export interface PanelAttributes {
1109
- // (undocumented)
1110
- panelColor?: string;
1111
- // (undocumented)
1324
+ export declare interface PanelAttributes {
1325
+ panelType: PanelType;
1112
1326
  panelIcon?: string;
1113
- // (undocumented)
1114
1327
  panelIconId?: string;
1115
- // (undocumented)
1116
1328
  panelIconText?: string;
1117
- // (undocumented)
1118
- panelType: PanelType;
1329
+ panelColor?: string;
1119
1330
  }
1120
1331
 
1121
- // @public
1122
- export interface PanelDefinition {
1123
- // (undocumented)
1332
+ /**
1333
+ * @name panel_node
1334
+ */
1335
+ export declare interface PanelDefinition {
1336
+ type: 'panel';
1124
1337
  attrs: PanelAttributes;
1338
+ /**
1339
+ * @minItems 1
1340
+ * @allowUnsupportedBlock true
1341
+ */
1125
1342
  content: Array<
1126
1343
  | ParagraphDefinition
1127
1344
  | HeadingDefinition
@@ -1129,99 +1346,103 @@ export interface PanelDefinition {
1129
1346
  | BulletListDefinition
1130
1347
  | BlockCardDefinition
1131
1348
  >;
1132
- // (undocumented)
1133
- type: 'panel';
1134
1349
  }
1135
1350
 
1136
- // @public (undocumented)
1137
- export enum PanelType {
1138
- // (undocumented)
1139
- CUSTOM = 'custom',
1140
- // (undocumented)
1141
- ERROR = 'error',
1142
- // (undocumented)
1351
+ export declare enum PanelType {
1143
1352
  INFO = 'info',
1144
- // (undocumented)
1145
1353
  NOTE = 'note',
1146
- // (undocumented)
1147
- SUCCESS = 'success',
1148
- // (undocumented)
1149
1354
  TIP = 'tip',
1150
- // (undocumented)
1151
1355
  WARNING = 'warning',
1356
+ ERROR = 'error',
1357
+ SUCCESS = 'success',
1358
+ CUSTOM = 'custom',
1152
1359
  }
1153
1360
 
1154
- // @public (undocumented)
1155
- export const paragraph: NodeSpec;
1361
+ export declare const paragraph: NodeSpec;
1156
1362
 
1157
- // @public
1158
- export interface ParagraphBaseDefinition {
1363
+ /**
1364
+ * @name paragraph_node
1365
+ */
1366
+ export declare interface ParagraphBaseDefinition {
1367
+ type: 'paragraph';
1368
+ /**
1369
+ * @allowUnsupportedInline true
1370
+ */
1159
1371
  content?: Array<Inline>;
1160
- // (undocumented)
1161
1372
  marks?: Array<any>;
1162
- // (undocumented)
1163
- type: 'paragraph';
1164
1373
  }
1165
1374
 
1166
- // @public
1167
- export type ParagraphDefinition = ParagraphBaseDefinition & NoMark;
1168
-
1169
- // @public
1170
- export type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition &
1375
+ /**
1376
+ * @name paragraph_with_no_marks_node
1377
+ */
1378
+ export declare type ParagraphDefinition = ParagraphBaseDefinition & NoMark;
1379
+
1380
+ /**
1381
+ * NOTE: Need this because TS is too smart and inline everything.
1382
+ * So we need to give them separate identity.
1383
+ * Probably there's a way to solve it but that will need time and exploration.
1384
+ * // http://bit.ly/2raXFX5
1385
+ * type T1 = X | Y
1386
+ * type T2 = A | T1 | B // T2 = A | X | Y | B
1387
+ */
1388
+ /**
1389
+ * @name paragraph_with_alignment_node
1390
+ */
1391
+ export declare type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition &
1171
1392
  MarksObject<AlignmentMarkDefinition>;
1172
1393
 
1173
- // @public
1174
- export type ParagraphWithIndentationDefinition = ParagraphBaseDefinition &
1394
+ /**
1395
+ * @name paragraph_with_indentation_node
1396
+ */
1397
+ export declare type ParagraphWithIndentationDefinition = ParagraphBaseDefinition &
1175
1398
  MarksObject<IndentationMarkDefinition>;
1176
1399
 
1177
- // @public (undocumented)
1178
- export type ParagraphWithMarksDefinition =
1400
+ export declare type ParagraphWithMarksDefinition =
1179
1401
  | ParagraphWithAlignmentDefinition
1180
1402
  | ParagraphWithIndentationDefinition;
1181
1403
 
1182
- // @public (undocumented)
1183
- export const placeholder: NodeSpec;
1404
+ export declare const placeholder: NodeSpec;
1184
1405
 
1185
- // @public
1186
- export interface PlaceholderDefinition {
1187
- // (undocumented)
1406
+ /**
1407
+ * @name placeholder_node
1408
+ */
1409
+ export declare interface PlaceholderDefinition {
1410
+ type: 'placeholder';
1188
1411
  attrs: {
1189
1412
  text: string;
1190
1413
  };
1191
- // (undocumented)
1192
- type: 'placeholder';
1193
1414
  }
1194
1415
 
1195
- // @public (undocumented)
1196
- export const R100 = '#FF8F73';
1416
+ export declare const R100 = '#FF8F73';
1197
1417
 
1198
- // @public (undocumented)
1199
- export const R300 = '#FF5630';
1418
+ export declare const R300 = '#FF5630';
1200
1419
 
1201
- // @public (undocumented)
1202
- export const R400 = '#DE350B';
1420
+ export declare const R400 = '#DE350B';
1203
1421
 
1204
- // @public
1205
- export const R50 = '#FFEBE6';
1422
+ /**
1423
+ * We're avoding importing these colors from @atlaskit/theme since we
1424
+ * do not want to have react as a dependency of this package.
1425
+ * TODO: Refactor this once tokenization by Core team is ready
1426
+ * https://product-fabric.atlassian.net/browse/CS-908
1427
+ */
1428
+ export declare const R50 = '#FFEBE6';
1206
1429
 
1207
- // @public (undocumented)
1208
- export const R500 = '#BF2600';
1430
+ export declare const R500 = '#BF2600';
1209
1431
 
1210
- // @public (undocumented)
1211
- export const R75 = '#FFBDAD';
1432
+ export declare const R75 = '#FFBDAD';
1212
1433
 
1213
- // @public (undocumented)
1214
- export function rgbToHex(value: string): string | null;
1434
+ export declare function rgbToHex(value: string): string | null;
1215
1435
 
1216
- // @public (undocumented)
1217
- export interface RichMediaAttributes {
1218
- // (undocumented)
1219
- layout: RichMediaLayout;
1436
+ export declare interface RichMediaAttributes {
1437
+ /**
1438
+ * @minimum 0
1439
+ * @maximum 100
1440
+ */
1220
1441
  width?: number;
1442
+ layout: RichMediaLayout;
1221
1443
  }
1222
1444
 
1223
- // @public (undocumented)
1224
- export type RichMediaLayout =
1445
+ export declare type RichMediaLayout =
1225
1446
  | 'wrap-right'
1226
1447
  | 'center'
1227
1448
  | 'wrap-left'
@@ -1230,17 +1451,16 @@ export type RichMediaLayout =
1230
1451
  | 'align-end'
1231
1452
  | 'align-start';
1232
1453
 
1233
- // @public (undocumented)
1234
- export const rule: NodeSpec;
1454
+ export declare const rule: NodeSpec;
1235
1455
 
1236
- // @public
1237
- export interface RuleDefinition {
1238
- // (undocumented)
1456
+ /**
1457
+ * @name rule_node
1458
+ */
1459
+ export declare interface RuleDefinition {
1239
1460
  type: 'rule';
1240
1461
  }
1241
1462
 
1242
- // @public (undocumented)
1243
- export function sanitizeNodes(
1463
+ export declare function sanitizeNodes(
1244
1464
  nodes: {
1245
1465
  [key: string]: NodeSpec;
1246
1466
  },
@@ -1251,166 +1471,187 @@ export function sanitizeNodes(
1251
1471
  [key: string]: NodeSpec;
1252
1472
  };
1253
1473
 
1254
- // @public (undocumented)
1255
- const status_2: NodeSpec;
1474
+ declare interface SchemaConfig<N = string, M = string> {
1475
+ nodes: N[];
1476
+ customNodeSpecs?: SchemaCustomNodeSpecs;
1477
+ marks?: M[];
1478
+ customMarkSpecs?: SchemaCustomMarkSpecs;
1479
+ }
1480
+
1481
+ declare interface SchemaCustomMarkSpecs {
1482
+ [name: string]: MarkSpec;
1483
+ }
1484
+
1485
+ declare interface SchemaCustomNodeSpecs {
1486
+ [name: string]: NodeSpec;
1487
+ }
1488
+
1489
+ declare const status_2: NodeSpec;
1256
1490
  export { status_2 as status };
1257
1491
 
1258
- // @public
1259
- export interface StatusDefinition {
1260
- // (undocumented)
1492
+ /**
1493
+ * @name status_node
1494
+ */
1495
+ export declare interface StatusDefinition {
1496
+ type: 'status';
1261
1497
  attrs: {
1498
+ /**
1499
+ * @minLength 1
1500
+ */
1262
1501
  text: string;
1263
1502
  color: 'neutral' | 'purple' | 'blue' | 'red' | 'yellow' | 'green';
1264
1503
  localId?: string;
1504
+ /**
1505
+ * Supported values are bold and subtle
1506
+ */
1265
1507
  style?: string;
1266
1508
  };
1267
- // (undocumented)
1268
- type: 'status';
1269
1509
  }
1270
1510
 
1271
- // @public (undocumented)
1272
- export const strike: MarkSpec;
1511
+ export declare const strike: MarkSpec;
1273
1512
 
1274
- // @public
1275
- export interface StrikeDefinition {
1276
- // (undocumented)
1513
+ /**
1514
+ * @name strike_mark
1515
+ */
1516
+ export declare interface StrikeDefinition {
1277
1517
  type: 'strike';
1278
1518
  }
1279
1519
 
1280
- // @public (undocumented)
1281
- export const strong: MarkSpec;
1520
+ export declare const strong: MarkSpec;
1282
1521
 
1283
- // @public
1284
- export interface StrongDefinition {
1285
- // (undocumented)
1522
+ /**
1523
+ * @name strong_mark
1524
+ */
1525
+ export declare interface StrongDefinition {
1286
1526
  type: 'strong';
1287
1527
  }
1288
1528
 
1289
- // @public (undocumented)
1290
- export const subsup: MarkSpec;
1529
+ export declare const subsup: MarkSpec;
1291
1530
 
1292
- // @public (undocumented)
1293
- export interface SubSupAttributes {
1294
- // (undocumented)
1531
+ export declare interface SubSupAttributes {
1295
1532
  type: 'sub' | 'sup';
1296
1533
  }
1297
1534
 
1298
- // @public
1299
- export interface SubSupDefinition {
1300
- // (undocumented)
1301
- attrs: SubSupAttributes;
1302
- // (undocumented)
1535
+ /**
1536
+ * @name subsup_mark
1537
+ */
1538
+ export declare interface SubSupDefinition {
1303
1539
  type: 'subsup';
1540
+ attrs: SubSupAttributes;
1304
1541
  }
1305
1542
 
1306
- // @public (undocumented)
1307
- export const T100 = '#79E2F2';
1543
+ export declare const T100 = '#79E2F2';
1308
1544
 
1309
- // @public (undocumented)
1310
- export const T300 = '#00B8D9';
1545
+ export declare const T300 = '#00B8D9';
1311
1546
 
1312
- // @public (undocumented)
1313
- export const T50 = '#E6FCFF';
1547
+ export declare const T50 = '#E6FCFF';
1314
1548
 
1315
- // @public (undocumented)
1316
- export const T500 = '#008DA6';
1549
+ export declare const T500 = '#008DA6';
1317
1550
 
1318
- // @public (undocumented)
1319
- export const T75 = '#B3F5FF';
1551
+ export declare const T75 = '#B3F5FF';
1320
1552
 
1321
- // @public (undocumented)
1322
- export const table: NodeSpec;
1553
+ export declare const table: NodeSpec;
1323
1554
 
1324
- // @public (undocumented)
1325
- export interface TableAttributes {
1326
- // (undocumented)
1327
- __autoSize?: boolean;
1328
- // (undocumented)
1555
+ export declare interface TableAttributes {
1329
1556
  isNumberColumnEnabled?: boolean;
1330
- // (undocumented)
1331
1557
  layout?: TableLayout;
1332
- // (undocumented)
1558
+ __autoSize?: boolean;
1559
+ /**
1560
+ * @minLength 1
1561
+ */
1333
1562
  localId?: string;
1334
1563
  }
1335
1564
 
1336
- // @public (undocumented)
1337
- export const tableBackgroundBorderColor: string;
1565
+ export declare const tableBackgroundBorderColor: string;
1566
+
1567
+ export declare const tableBackgroundColorNames: Map<string, string>;
1338
1568
 
1339
- // @public (undocumented)
1340
- export const tableBackgroundColorNames: Map<string, string>;
1569
+ export declare const tableBackgroundColorPalette: Map<string, string>;
1341
1570
 
1342
- // @public (undocumented)
1343
- export const tableBackgroundColorPalette: Map<string, string>;
1571
+ export declare const tableCell: NodeSpec;
1344
1572
 
1345
- // @public (undocumented)
1346
- export const tableCell: NodeSpec;
1573
+ /**
1574
+ * @name table_cell_content
1575
+ * @minItems 1
1576
+ * @allowUnsupportedBlock true
1577
+ */
1578
+ declare type TableCellContent = Array<
1579
+ | PanelDefinition
1580
+ | ParagraphDefinition
1581
+ | ParagraphWithAlignmentDefinition
1582
+ | BlockQuoteDefinition
1583
+ | OrderedListDefinition
1584
+ | BulletListDefinition
1585
+ | RuleDefinition
1586
+ | HeadingDefinition
1587
+ | HeadingWithMarksDefinition
1588
+ | CodeBlockDefinition
1589
+ | MediaGroupDefinition
1590
+ | MediaSingleDefinition
1591
+ | DecisionListDefinition
1592
+ | TaskListDefinition
1593
+ | ExtensionDefinition
1594
+ | BlockCardDefinition
1595
+ | NestedExpandDefinition
1596
+ | EmbedCardDefinition
1597
+ >;
1347
1598
 
1348
- // @public (undocumented)
1349
- export const tableCellContentDomSelector: string;
1599
+ export declare const tableCellContentDomSelector: string;
1350
1600
 
1351
- // @public (undocumented)
1352
- export const tableCellContentWrapperSelector: string;
1601
+ export declare const tableCellContentWrapperSelector: string;
1353
1602
 
1354
- // @public
1355
- export interface TableCellDefinition {
1356
- // (undocumented)
1603
+ /**
1604
+ * @name table_cell_node
1605
+ */
1606
+ export declare interface TableCellDefinition {
1607
+ type: 'tableCell';
1357
1608
  attrs?: CellAttributes;
1358
- // (undocumented)
1359
1609
  content: TableCellContent;
1360
- // (undocumented)
1361
- type: 'tableCell';
1362
1610
  }
1363
1611
 
1364
- // @public (undocumented)
1365
- export const tableCellSelector: string;
1612
+ export declare const tableCellSelector: string;
1366
1613
 
1367
- // @public
1368
- export interface TableDefinition {
1369
- // (undocumented)
1614
+ /**
1615
+ * @name table_node
1616
+ */
1617
+ export declare interface TableDefinition {
1618
+ type: 'table';
1370
1619
  attrs?: TableAttributes;
1371
- // (undocumented)
1620
+ /**
1621
+ * @minItems 1
1622
+ */
1372
1623
  content: Array<TableRowDefinition>;
1373
- // (undocumented)
1374
1624
  marks?: Array<FragmentDefinition>;
1375
- // (undocumented)
1376
- type: 'table';
1377
1625
  }
1378
1626
 
1379
- // @public (undocumented)
1380
- export const tableHeader: NodeSpec;
1627
+ export declare const tableHeader: NodeSpec;
1381
1628
 
1382
- // @public
1383
- export interface TableHeaderDefinition {
1384
- // (undocumented)
1629
+ /**
1630
+ * @name table_header_node
1631
+ */
1632
+ export declare interface TableHeaderDefinition {
1633
+ type: 'tableHeader';
1385
1634
  attrs?: CellAttributes;
1386
- // (undocumented)
1387
1635
  content: TableCellContent;
1388
- // (undocumented)
1389
- type: 'tableHeader';
1390
1636
  }
1391
1637
 
1392
- // @public (undocumented)
1393
- export const tableHeaderSelector: string;
1638
+ export declare const tableHeaderSelector: string;
1394
1639
 
1395
- // @public (undocumented)
1396
- export type TableLayout = 'default' | 'full-width' | 'wide';
1640
+ export declare type TableLayout = 'default' | 'full-width' | 'wide';
1397
1641
 
1398
- // @public (undocumented)
1399
- export const tablePrefixSelector = 'pm-table';
1642
+ export declare const tablePrefixSelector = 'pm-table';
1400
1643
 
1401
- // @public (undocumented)
1402
- export const tableRow: NodeSpec;
1644
+ export declare const tableRow: NodeSpec;
1403
1645
 
1404
- // @public
1405
- export interface TableRowDefinition {
1406
- // (undocumented)
1407
- content: Array<TableHeaderDefinition | TableCellDefinition>;
1408
- // (undocumented)
1646
+ /**
1647
+ * @name table_row_node
1648
+ */
1649
+ export declare interface TableRowDefinition {
1409
1650
  type: 'tableRow';
1651
+ content: Array<TableHeaderDefinition | TableCellDefinition>;
1410
1652
  }
1411
1653
 
1412
- // @public (undocumented)
1413
- export const tableToJSON: (
1654
+ export declare const tableToJSON: (
1414
1655
  node: Node_2,
1415
1656
  ) => {
1416
1657
  attrs: {
@@ -1418,145 +1659,165 @@ export const tableToJSON: (
1418
1659
  };
1419
1660
  };
1420
1661
 
1421
- // @public (undocumented)
1422
- export const taskItem: NodeSpec;
1662
+ export declare const taskItem: NodeSpec;
1423
1663
 
1424
- // @public
1425
- export interface TaskItemDefinition {
1426
- // (undocumented)
1664
+ /**
1665
+ * @name taskItem_node
1666
+ */
1667
+ export declare interface TaskItemDefinition {
1668
+ type: 'taskItem';
1669
+ /**
1670
+ * @allowUnsupportedInline true
1671
+ */
1672
+ content?: Array<Inline>;
1427
1673
  attrs: {
1428
1674
  localId: string;
1429
1675
  state: 'TODO' | 'DONE';
1430
1676
  };
1431
- content?: Array<Inline>;
1432
- // (undocumented)
1433
- type: 'taskItem';
1434
1677
  }
1435
1678
 
1436
- // @public (undocumented)
1437
- export const taskList: NodeSpec;
1679
+ export declare const taskList: NodeSpec;
1438
1680
 
1439
- // @public (undocumented)
1440
- export interface TaskListContent
1681
+ export declare interface TaskListContent
1441
1682
  extends Array<TaskItemDefinition | TaskListDefinition> {
1442
- // (undocumented)
1443
1683
  0: TaskItemDefinition;
1444
1684
  }
1445
1685
 
1446
- // @public
1447
- export interface TaskListDefinition {
1448
- // (undocumented)
1686
+ /**
1687
+ * @name taskList_node
1688
+ */
1689
+ export declare interface TaskListDefinition {
1690
+ type: 'taskList';
1691
+ /**
1692
+ * @minItems 1
1693
+ * @allowUnsupportedBlock true
1694
+ */
1695
+ content: TaskListContent;
1449
1696
  attrs: {
1450
1697
  localId: string;
1451
1698
  };
1452
- content: TaskListContent;
1453
- // (undocumented)
1454
- type: 'taskList';
1455
1699
  }
1456
1700
 
1457
- // @public (undocumented)
1458
- export const taskListSelector: string;
1701
+ export declare const taskListSelector: string;
1459
1702
 
1460
- // @public (undocumented)
1461
- export const text: NodeSpec & {
1703
+ export declare const text: NodeSpec & {
1462
1704
  toDebugString?: () => string;
1463
1705
  };
1464
1706
 
1465
- // @public (undocumented)
1466
- export const textColor: MarkSpec;
1707
+ export declare const textColor: MarkSpec;
1467
1708
 
1468
- // @public (undocumented)
1469
- export interface TextColorAttributes {
1709
+ export declare interface TextColorAttributes {
1710
+ /**
1711
+ * @pattern "^#[0-9a-fA-F]{6}$"
1712
+ */
1470
1713
  color: string;
1471
1714
  }
1472
1715
 
1473
- // @public
1474
- export interface TextColorDefinition {
1475
- // (undocumented)
1476
- attrs: TextColorAttributes;
1477
- // (undocumented)
1716
+ /**
1717
+ * @name textColor_mark
1718
+ */
1719
+ export declare interface TextColorDefinition {
1478
1720
  type: 'textColor';
1721
+ attrs: TextColorAttributes;
1479
1722
  }
1480
1723
 
1481
- // @public
1482
- export interface TextDefinition {
1483
- // (undocumented)
1484
- marks?: Array<any>;
1485
- // (undocumented)
1486
- text: string;
1487
- // (undocumented)
1724
+ declare type TextColorKey =
1725
+ | 'Light gray'
1726
+ | 'Purple'
1727
+ | 'Teal'
1728
+ | 'Green'
1729
+ | 'Red'
1730
+ | 'Orange'
1731
+ | 'Dark gray'
1732
+ | 'Blue'
1733
+ | 'Yellow'
1734
+ | 'Dark blue'
1735
+ | 'Dark teal'
1736
+ | 'Dark green'
1737
+ | 'Dark red'
1738
+ | 'Dark purple'
1739
+ | 'White'
1740
+ | 'Light blue'
1741
+ | 'Light teal'
1742
+ | 'Light green'
1743
+ | 'Light yellow'
1744
+ | 'Light red'
1745
+ | 'Light purple';
1746
+
1747
+ /**
1748
+ * @name text_node
1749
+ */
1750
+ export declare interface TextDefinition {
1488
1751
  type: 'text';
1752
+ /**
1753
+ * @minLength 1
1754
+ */
1755
+ text: string;
1756
+ marks?: Array<any>;
1489
1757
  }
1490
1758
 
1491
- // @public (undocumented)
1492
- export const toJSONTableCell: (
1759
+ export declare const toJSONTableCell: (
1493
1760
  node: Node_2,
1494
1761
  ) => {
1495
1762
  attrs: Record<string, any>;
1496
1763
  };
1497
1764
 
1498
- // @public (undocumented)
1499
- export const toJSONTableHeader: (
1765
+ export declare const toJSONTableHeader: (
1500
1766
  node: Node_2,
1501
1767
  ) => {
1502
1768
  attrs: Record<string, any>;
1503
1769
  };
1504
1770
 
1505
- // @public (undocumented)
1506
- export const typeAheadQuery: MarkSpec;
1771
+ export declare const typeAheadQuery: MarkSpec;
1507
1772
 
1508
- // @public (undocumented)
1509
- export const underline: MarkSpec;
1773
+ export declare const underline: MarkSpec;
1510
1774
 
1511
- // @public
1512
- export interface UnderlineDefinition {
1513
- // (undocumented)
1775
+ /**
1776
+ * @name underline_mark
1777
+ */
1778
+ export declare interface UnderlineDefinition {
1514
1779
  type: 'underline';
1515
1780
  }
1516
1781
 
1517
- // @public (undocumented)
1518
- export const unknownBlock: NodeSpec;
1782
+ export declare const unknownBlock: NodeSpec;
1519
1783
 
1520
- // @public (undocumented)
1521
- export const unsupportedBlock: NodeSpec;
1784
+ export declare const unsupportedBlock: NodeSpec;
1522
1785
 
1523
- // @public (undocumented)
1524
- export const unsupportedInline: NodeSpec;
1786
+ export declare const unsupportedInline: NodeSpec;
1525
1787
 
1526
- // @public (undocumented)
1527
- export const unsupportedMark: MarkSpec;
1788
+ export declare const unsupportedMark: MarkSpec;
1528
1789
 
1529
- // @public (undocumented)
1530
- export const unsupportedNodeAttribute: MarkSpec;
1790
+ export declare const unsupportedNodeAttribute: MarkSpec;
1531
1791
 
1532
- // @public (undocumented)
1533
- export const unsupportedNodeTypesForMediaCards: Set<string>;
1792
+ export declare const unsupportedNodeTypesForMediaCards: Set<string>;
1534
1793
 
1535
- // @public (undocumented)
1536
- export interface UrlType {
1794
+ export declare interface UrlType {
1795
+ /**
1796
+ * @validatorFn safeUrl
1797
+ */
1537
1798
  url: string;
1538
1799
  }
1539
1800
 
1540
- // @public (undocumented)
1541
- export const uuid: {
1801
+ declare enum USER_TYPES {
1802
+ DEFAULT = 'DEFAULT',
1803
+ SPECIAL = 'SPECIAL',
1804
+ APP = 'APP',
1805
+ }
1806
+
1807
+ export declare const uuid: {
1542
1808
  setStatic(value: string | false): void;
1543
1809
  generate(): string;
1544
1810
  };
1545
1811
 
1546
- // @public (undocumented)
1547
- export const Y200 = '#FFC400';
1812
+ export declare const Y200 = '#FFC400';
1548
1813
 
1549
- // @public (undocumented)
1550
- export const Y400 = '#FF991F';
1814
+ export declare const Y400 = '#FF991F';
1551
1815
 
1552
- // @public (undocumented)
1553
- export const Y50 = '#FFFAE6';
1816
+ export declare const Y50 = '#FFFAE6';
1554
1817
 
1555
- // @public (undocumented)
1556
- export const Y500 = '#FF8B00';
1818
+ export declare const Y500 = '#FF8B00';
1557
1819
 
1558
- // @public (undocumented)
1559
- export const Y75 = '#FFF0B3';
1820
+ export declare const Y75 = '#FFF0B3';
1560
1821
 
1561
- // (No @packageDocumentation comment for this package)
1822
+ export {};
1562
1823
  ```