@atlaskit/adf-schema 23.1.0 → 23.2.0

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 ADDED
@@ -0,0 +1,1562 @@
1
+ ## API Report File for "@atlaskit/adf-schema"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+ import { CellAttributes } from '@atlaskit/editor-tables/types';
7
+ import LinkifyIt from 'linkify-it';
8
+ import { Mark } from 'prosemirror-model';
9
+ import { MarkSpec } from 'prosemirror-model';
10
+ import { Node as Node_2 } from 'prosemirror-model';
11
+ import { NodeSpec } from 'prosemirror-model';
12
+ import { Schema } from 'prosemirror-model';
13
+
14
+ // @public (undocumented)
15
+ export function acNameToEmoji(
16
+ acName: NameToEmoji,
17
+ ): {
18
+ id: string;
19
+ shortName: string;
20
+ text: string;
21
+ };
22
+
23
+ // @public (undocumented)
24
+ export function acShortcutToEmoji(
25
+ hipchatEmoticonShortName: string,
26
+ ): {
27
+ id: string;
28
+ shortName: string;
29
+ text: string;
30
+ };
31
+
32
+ // @public (undocumented)
33
+ export const alignment: MarkSpec;
34
+
35
+ // @public (undocumented)
36
+ export interface AlignmentAttributes {
37
+ // (undocumented)
38
+ align: 'center' | 'end';
39
+ }
40
+
41
+ // @public
42
+ export interface AlignmentMarkDefinition {
43
+ // (undocumented)
44
+ attrs: AlignmentAttributes;
45
+ // (undocumented)
46
+ type: 'alignment';
47
+ }
48
+
49
+ // @public
50
+ export const alignmentPositionMap: {
51
+ [key: string]: string;
52
+ };
53
+
54
+ // @public (undocumented)
55
+ export const annotation: MarkSpec;
56
+
57
+ // @public (undocumented)
58
+ export type AnnotationDataAttributes = {
59
+ 'data-mark-type': string;
60
+ 'data-mark-annotation-type': AnnotationTypes;
61
+ 'data-id': AnnotationId;
62
+ 'data-mark-annotation-state'?: AnnotationMarkStates;
63
+ };
64
+
65
+ // @public (undocumented)
66
+ export type AnnotationId = string;
67
+
68
+ // @public (undocumented)
69
+ export interface AnnotationMarkAttributes {
70
+ // (undocumented)
71
+ annotationType: AnnotationTypes;
72
+ // (undocumented)
73
+ id: AnnotationId;
74
+ }
75
+
76
+ // @public
77
+ export interface AnnotationMarkDefinition {
78
+ // (undocumented)
79
+ attrs: AnnotationMarkAttributes;
80
+ // (undocumented)
81
+ type: 'annotation';
82
+ }
83
+
84
+ // @public (undocumented)
85
+ export enum AnnotationMarkStates {
86
+ // (undocumented)
87
+ ACTIVE = 'active',
88
+ // (undocumented)
89
+ RESOLVED = 'resolved',
90
+ }
91
+
92
+ // @public (undocumented)
93
+ export enum AnnotationTypes {
94
+ // (undocumented)
95
+ INLINE_COMMENT = 'inlineComment',
96
+ }
97
+
98
+ // @public (undocumented)
99
+ export const B100 = '#4C9AFF';
100
+
101
+ // @public (undocumented)
102
+ export const B400 = '#0052CC';
103
+
104
+ // @public (undocumented)
105
+ export const B50 = '#DEEBFF';
106
+
107
+ // @public (undocumented)
108
+ export const B500 = '#0747A6';
109
+
110
+ // @public (undocumented)
111
+ export const B75 = '#B3D4FF';
112
+
113
+ // @public (undocumented)
114
+ export const blockCard: NodeSpec;
115
+
116
+ // @public
117
+ export interface BlockCardDefinition {
118
+ // (undocumented)
119
+ attrs: CardAttributes;
120
+ // (undocumented)
121
+ type: 'blockCard';
122
+ }
123
+
124
+ // @public
125
+ export type BlockContent =
126
+ | PanelDefinition
127
+ | ParagraphDefinition
128
+ | ParagraphWithAlignmentDefinition
129
+ | BlockQuoteDefinition
130
+ | OrderedListDefinition
131
+ | BulletListDefinition
132
+ | RuleDefinition
133
+ | HeadingDefinition
134
+ | HeadingWithMarksDefinition
135
+ | CodeBlockDefinition
136
+ | MediaGroupDefinition
137
+ | MediaSingleDefinition
138
+ | DecisionListDefinition
139
+ | TaskListDefinition
140
+ | TableDefinition
141
+ | ExpandDefinition
142
+ | ExtensionDefinition
143
+ | BodiedExtensionDefinition
144
+ | BlockCardDefinition
145
+ | EmbedCardDefinition;
146
+
147
+ // @public (undocumented)
148
+ export const blockquote: NodeSpec;
149
+
150
+ // @public
151
+ export interface BlockQuoteDefinition {
152
+ content: Array<ParagraphDefinition>;
153
+ // (undocumented)
154
+ type: 'blockquote';
155
+ }
156
+
157
+ // @public (undocumented)
158
+ export const bodiedExtension: NodeSpec;
159
+
160
+ // @public
161
+ export type BodiedExtensionDefinition = BodiedExtensionBaseDefinition &
162
+ MarksObject<DataConsumerDefinition | FragmentDefinition>;
163
+
164
+ // @public (undocumented)
165
+ export const breakout: MarkSpec;
166
+
167
+ // @public (undocumented)
168
+ export type BreakoutMarkAttrs = {
169
+ mode: 'wide' | 'full-width';
170
+ };
171
+
172
+ // @public
173
+ export interface BreakoutMarkDefinition {
174
+ // (undocumented)
175
+ attrs: BreakoutMarkAttrs;
176
+ // (undocumented)
177
+ type: 'breakout';
178
+ }
179
+
180
+ // @public (undocumented)
181
+ export function buildAnnotationMarkDataAttributes({
182
+ id,
183
+ annotationType,
184
+ state,
185
+ }: BuildDataAttributesProps): AnnotationDataAttributes;
186
+
187
+ // @public (undocumented)
188
+ export const bulletList: NodeSpec;
189
+
190
+ // @public
191
+ export interface BulletListDefinition {
192
+ // (undocumented)
193
+ content: Array<ListItemDefinition>;
194
+ // (undocumented)
195
+ type: 'bulletList';
196
+ }
197
+
198
+ // @public (undocumented)
199
+ export const bulletListSelector = '.ak-ul';
200
+
201
+ // @public (undocumented)
202
+ export const caption: NodeSpec;
203
+
204
+ // @public
205
+ export interface CaptionDefinition {
206
+ // (undocumented)
207
+ content: Array<
208
+ | InlineFormattedText
209
+ | InlineCode
210
+ | HardBreakDefinition
211
+ | MentionDefinition
212
+ | EmojiDefinition
213
+ | DateDefinition
214
+ | PlaceholderDefinition
215
+ | InlineCardDefinition
216
+ | StatusDefinition
217
+ >;
218
+ // (undocumented)
219
+ type: 'caption';
220
+ }
221
+
222
+ // @public (undocumented)
223
+ export type CardAttributes = UrlType | DataType;
224
+
225
+ export { CellAttributes };
226
+
227
+ // @public (undocumented)
228
+ export type CellDomAttrs = {
229
+ colspan?: string;
230
+ rowspan?: string;
231
+ style?: string;
232
+ colorname?: string;
233
+ 'data-colwidth'?: string;
234
+ class?: string;
235
+ };
236
+
237
+ // @public (undocumented)
238
+ export const code: MarkSpec;
239
+
240
+ // @public (undocumented)
241
+ export const codeBlock: NodeSpec;
242
+
243
+ // @public (undocumented)
244
+ export type CodeBlockAttrs = {
245
+ language?: string;
246
+ };
247
+
248
+ // @public
249
+ export type CodeBlockBaseDefinition = {
250
+ type: 'codeBlock';
251
+ content?: Array<TextDefinition & NoMark>;
252
+ marks?: Array<any>;
253
+ attrs?: CodeBlockAttrs;
254
+ };
255
+
256
+ // @public
257
+ export type CodeBlockDefinition = CodeBlockBaseDefinition & NoMark;
258
+
259
+ // @public (undocumented)
260
+ export const codeBlockToJSON: (
261
+ node: Node_2,
262
+ ) => {
263
+ attrs: Record<string, any>;
264
+ };
265
+
266
+ // @public
267
+ export type CodeBlockWithMarksDefinition = CodeBlockBaseDefinition &
268
+ MarksObject<BreakoutMarkDefinition>;
269
+
270
+ // @public
271
+ export interface CodeDefinition {
272
+ // (undocumented)
273
+ type: 'code';
274
+ }
275
+
276
+ // @public (undocumented)
277
+ export const colorPalette: Map<string, TextColorKey>;
278
+
279
+ // @public (undocumented)
280
+ export const colorPaletteExtended: Map<string, TextColorKey>;
281
+
282
+ // @public (undocumented)
283
+ export const confluenceInlineComment: MarkSpec;
284
+
285
+ // @public (undocumented)
286
+ export const confluenceJiraIssue: NodeSpec;
287
+
288
+ // @public (undocumented)
289
+ export const confluenceUnsupportedBlock: NodeSpec;
290
+
291
+ // @public (undocumented)
292
+ export const confluenceUnsupportedInline: NodeSpec;
293
+
294
+ // @public (undocumented)
295
+ export const copyPrivateMediaAttributes: (
296
+ from: Record<string, any>,
297
+ to: Record<string, any>,
298
+ map?: ((str: string) => string) | undefined,
299
+ ) => void;
300
+
301
+ // @public
302
+ export function createSchema<
303
+ N extends string = string,
304
+ M extends string = string
305
+ >(config: SchemaConfig<N, M>): Schema<N, M>;
306
+
307
+ // @public (undocumented)
308
+ export const dataConsumer: MarkSpec;
309
+
310
+ // @public (undocumented)
311
+ export interface DataConsumerAttributes {
312
+ // (undocumented)
313
+ sources: Array<DataConsumerSource>;
314
+ }
315
+
316
+ // @public
317
+ export interface DataConsumerDefinition {
318
+ // (undocumented)
319
+ attrs: DataConsumerAttributes;
320
+ // (undocumented)
321
+ type: 'dataConsumer';
322
+ }
323
+
324
+ // @public
325
+ export const dataConsumerToJSON: (
326
+ mark: Mark,
327
+ ) => {
328
+ type: string;
329
+ attrs: {
330
+ [key: string]: any;
331
+ };
332
+ };
333
+
334
+ // @public (undocumented)
335
+ export interface DataType {
336
+ data: object;
337
+ }
338
+
339
+ // @public (undocumented)
340
+ export const date: NodeSpec;
341
+
342
+ // @public
343
+ export interface DateDefinition {
344
+ // (undocumented)
345
+ attrs: {
346
+ timestamp: string;
347
+ };
348
+ // (undocumented)
349
+ type: 'date';
350
+ }
351
+
352
+ // @public (undocumented)
353
+ export const decisionItem: NodeSpec;
354
+
355
+ // @public
356
+ export interface DecisionItemDefinition {
357
+ // (undocumented)
358
+ attrs: {
359
+ localId: string;
360
+ state: string;
361
+ };
362
+ content?: Array<Inline>;
363
+ // (undocumented)
364
+ type: 'decisionItem';
365
+ }
366
+
367
+ // @public (undocumented)
368
+ export const decisionList: NodeSpec;
369
+
370
+ // @public
371
+ export interface DecisionListDefinition {
372
+ // (undocumented)
373
+ attrs: {
374
+ localId: string;
375
+ };
376
+ content: Array<DecisionItemDefinition>;
377
+ // (undocumented)
378
+ type: 'decisionList';
379
+ }
380
+
381
+ // @public (undocumented)
382
+ export const decisionListSelector: string;
383
+
384
+ // @public (undocumented)
385
+ export const doc: NodeSpec;
386
+
387
+ // @public
388
+ export interface DocNode {
389
+ content: Array<
390
+ | BlockContent
391
+ | LayoutSectionDefinition
392
+ | CodeBlockWithMarksDefinition
393
+ | ExpandWithBreakoutDefinition
394
+ | ParagraphWithIndentationDefinition
395
+ >;
396
+ // (undocumented)
397
+ type: 'doc';
398
+ // (undocumented)
399
+ version: 1;
400
+ }
401
+
402
+ // @public (undocumented)
403
+ export const em: MarkSpec;
404
+
405
+ // @public (undocumented)
406
+ export const embedCard: NodeSpec;
407
+
408
+ // @public (undocumented)
409
+ export interface EmbedCardAttributes extends RichMediaAttributes {
410
+ // (undocumented)
411
+ originalHeight?: number;
412
+ // (undocumented)
413
+ originalWidth?: number;
414
+ url: string;
415
+ }
416
+
417
+ // @public
418
+ export interface EmbedCardDefinition {
419
+ // (undocumented)
420
+ attrs: EmbedCardAttributes;
421
+ // (undocumented)
422
+ type: 'embedCard';
423
+ }
424
+
425
+ // @public
426
+ export interface EmDefinition {
427
+ // (undocumented)
428
+ type: 'em';
429
+ }
430
+
431
+ // @public (undocumented)
432
+ export const emoji: NodeSpec;
433
+
434
+ // @public (undocumented)
435
+ export interface EmojiAttributes {
436
+ // (undocumented)
437
+ id?: string;
438
+ // (undocumented)
439
+ shortName: string;
440
+ // (undocumented)
441
+ text?: string;
442
+ }
443
+
444
+ // @public
445
+ export interface EmojiDefinition {
446
+ // (undocumented)
447
+ attrs: EmojiAttributes;
448
+ // (undocumented)
449
+ type: 'emoji';
450
+ }
451
+
452
+ // @public (undocumented)
453
+ export function emojiIdToAcName(emojiId: string): never;
454
+
455
+ // @public (undocumented)
456
+ export const expand: NodeSpec;
457
+
458
+ // @public
459
+ export type ExpandDefinition = ExpandBaseDefinition & NoMark;
460
+
461
+ // @public (undocumented)
462
+ export const expandToJSON: (
463
+ node: Node_2,
464
+ ) => {
465
+ attrs: {
466
+ [key: string]: any;
467
+ };
468
+ };
469
+
470
+ // @public (undocumented)
471
+ export const extension: NodeSpec;
472
+
473
+ // @public
474
+ export type ExtensionDefinition = ExtensionBaseDefinition &
475
+ MarksObject<DataConsumerDefinition | FragmentDefinition>;
476
+
477
+ // @public (undocumented)
478
+ export type ExtensionLayout = 'default' | 'wide' | 'full-width';
479
+
480
+ // @public (undocumented)
481
+ export interface ExternalMediaAttributes {
482
+ // (undocumented)
483
+ __external?: boolean;
484
+ // (undocumented)
485
+ alt?: string;
486
+ // (undocumented)
487
+ height?: number;
488
+ // (undocumented)
489
+ type: 'external';
490
+ // (undocumented)
491
+ url: string;
492
+ // (undocumented)
493
+ width?: number;
494
+ }
495
+
496
+ // @public (undocumented)
497
+ export const fragment: MarkSpec;
498
+
499
+ // @public (undocumented)
500
+ export interface FragmentAttributes {
501
+ // (undocumented)
502
+ localId: LocalId;
503
+ // (undocumented)
504
+ name?: string;
505
+ }
506
+
507
+ // @public
508
+ export interface FragmentDefinition {
509
+ // (undocumented)
510
+ attrs: FragmentAttributes;
511
+ // (undocumented)
512
+ type: 'fragment';
513
+ }
514
+
515
+ // @public (undocumented)
516
+ export const fragmentToJSON: (
517
+ mark: Mark,
518
+ ) => {
519
+ type: string;
520
+ attrs: {
521
+ name?: any;
522
+ localId: any;
523
+ };
524
+ };
525
+
526
+ // @public (undocumented)
527
+ export const G200 = '#57D9A3';
528
+
529
+ // @public (undocumented)
530
+ export const G300 = '#36B37E';
531
+
532
+ // @public (undocumented)
533
+ export const G400 = '#00875A';
534
+
535
+ // @public (undocumented)
536
+ export const G50 = '#E3FCEF';
537
+
538
+ // @public (undocumented)
539
+ export const G500 = '#006644';
540
+
541
+ // @public (undocumented)
542
+ export const G75 = '#ABF5D1';
543
+
544
+ // @public (undocumented)
545
+ export const generateUuid: () => string;
546
+
547
+ // @public (undocumented)
548
+ export const getCellAttrs: (
549
+ dom: HTMLElement,
550
+ defaultValues?: CellAttributes,
551
+ ) => {
552
+ colspan: number;
553
+ rowspan: number;
554
+ colwidth: number[] | null;
555
+ background: string | null;
556
+ };
557
+
558
+ // @public
559
+ export const getCellDomAttrs: (node: Node_2) => CellDomAttrs;
560
+
561
+ // @public (undocumented)
562
+ export function getEmojiAcName({
563
+ id,
564
+ shortName,
565
+ }: {
566
+ id: string;
567
+ shortName: string;
568
+ }): string;
569
+
570
+ // @public (undocumented)
571
+ export function getLinkMatch(str?: string): Match | null;
572
+
573
+ // @public (undocumented)
574
+ export const hardBreak: NodeSpec;
575
+
576
+ // @public
577
+ export interface HardBreakDefinition {
578
+ // (undocumented)
579
+ attrs?: {
580
+ text?: '\n';
581
+ };
582
+ // (undocumented)
583
+ type: 'hardBreak';
584
+ }
585
+
586
+ // @public (undocumented)
587
+ export const heading: NodeSpec;
588
+
589
+ // @public
590
+ export interface HeadingBaseDefinition {
591
+ // (undocumented)
592
+ attrs: {
593
+ level: number;
594
+ };
595
+ content?: Array<Inline>;
596
+ // (undocumented)
597
+ marks?: Array<any>;
598
+ // (undocumented)
599
+ type: 'heading';
600
+ }
601
+
602
+ // @public
603
+ export type HeadingDefinition = HeadingBaseDefinition & NoMark;
604
+
605
+ // @public
606
+ export type HeadingWithAlignmentDefinition = HeadingBaseDefinition &
607
+ MarksObject<AlignmentMarkDefinition>;
608
+
609
+ // @public
610
+ export type HeadingWithIndentationDefinition = HeadingBaseDefinition &
611
+ MarksObject<IndentationMarkDefinition>;
612
+
613
+ // @public (undocumented)
614
+ export type HeadingWithMarksDefinition =
615
+ | HeadingWithAlignmentDefinition
616
+ | HeadingWithIndentationDefinition;
617
+
618
+ // @public
619
+ export function hexToRgb(color: string): string | null;
620
+
621
+ // @public
622
+ export function hexToRgba(rawColor: string, alpha: number): string | null;
623
+
624
+ // @public (undocumented)
625
+ export const image: NodeSpec;
626
+
627
+ // @public (undocumented)
628
+ export const indentation: MarkSpec;
629
+
630
+ // @public (undocumented)
631
+ export interface IndentationMarkAttributes {
632
+ level: number;
633
+ }
634
+
635
+ // @public
636
+ export interface IndentationMarkDefinition {
637
+ // (undocumented)
638
+ attrs: IndentationMarkAttributes;
639
+ // (undocumented)
640
+ type: 'indentation';
641
+ }
642
+
643
+ // @public
644
+ export type Inline = InlineFormattedText | InlineCode | InlineAtomic;
645
+
646
+ // @public
647
+ export type InlineAtomic =
648
+ | HardBreakDefinition
649
+ | MentionDefinition
650
+ | EmojiDefinition
651
+ | InlineExtensionDefinition
652
+ | DateDefinition
653
+ | PlaceholderDefinition
654
+ | InlineCardDefinition
655
+ | StatusDefinition
656
+ | MediaInlineDefinition;
657
+
658
+ // @public (undocumented)
659
+ export const inlineCard: NodeSpec;
660
+
661
+ // @public
662
+ export interface InlineCardDefinition {
663
+ // (undocumented)
664
+ attrs: CardAttributes;
665
+ // (undocumented)
666
+ type: 'inlineCard';
667
+ }
668
+
669
+ // @public
670
+ export type InlineCode = TextDefinition &
671
+ MarksObject<CodeDefinition | LinkDefinition | AnnotationMarkDefinition>;
672
+
673
+ // @public (undocumented)
674
+ export const inlineExtension: NodeSpec;
675
+
676
+ // @public
677
+ export type InlineExtensionDefinition = InlineExtensionBaseDefinition &
678
+ MarksObject<DataConsumerDefinition | FragmentDefinition>;
679
+
680
+ // @public
681
+ export type InlineFormattedText = TextDefinition &
682
+ MarksObject<
683
+ | LinkDefinition
684
+ | EmDefinition
685
+ | StrongDefinition
686
+ | StrikeDefinition
687
+ | SubSupDefinition
688
+ | UnderlineDefinition
689
+ | TextColorDefinition
690
+ | AnnotationMarkDefinition
691
+ >;
692
+
693
+ // @public
694
+ export type InlineLinkText = TextDefinition & MarksObject<LinkDefinition>;
695
+
696
+ // @public (undocumented)
697
+ export const inlineNodes: Set<string>;
698
+
699
+ // @public (undocumented)
700
+ export function isHex(color: string): boolean;
701
+
702
+ // @public (undocumented)
703
+ export function isRgb(color: string): boolean;
704
+
705
+ // @public
706
+ export const isSafeUrl: (url: string) => boolean;
707
+
708
+ // @public (undocumented)
709
+ export const layoutColumn: NodeSpec;
710
+
711
+ // @public
712
+ export interface LayoutColumnDefinition {
713
+ // (undocumented)
714
+ attrs: {
715
+ width: number;
716
+ };
717
+ content: Array<BlockContent>;
718
+ // (undocumented)
719
+ type: 'layoutColumn';
720
+ }
721
+
722
+ // @public (undocumented)
723
+ export const layoutSection: NodeSpec;
724
+
725
+ // @public (undocumented)
726
+ export type LayoutSectionDefinition =
727
+ | LayoutSectionFullDefinition
728
+ | LayoutSectionWithSingleColumnDefinition;
729
+
730
+ // @public
731
+ export type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
732
+ type: 'layoutSection';
733
+ marks?: Array<BreakoutMarkDefinition>;
734
+ content: Array<LayoutColumnDefinition>;
735
+ };
736
+
737
+ // @public
738
+ export type LayoutSectionWithSingleColumnDefinition = LayoutSectionBaseDefinition & {
739
+ type: 'layoutSection';
740
+ marks?: Array<BreakoutMarkDefinition>;
741
+ content: Array<LayoutColumnDefinition>;
742
+ };
743
+
744
+ // @public (undocumented)
745
+ export const link: MarkSpec;
746
+
747
+ // @public (undocumented)
748
+ export interface LinkAttributes {
749
+ // (undocumented)
750
+ __confluenceMetadata?: ConfluenceLinkMetadata;
751
+ // (undocumented)
752
+ collection?: string;
753
+ href: string;
754
+ // (undocumented)
755
+ id?: string;
756
+ // (undocumented)
757
+ occurrenceKey?: string;
758
+ // (undocumented)
759
+ title?: string;
760
+ }
761
+
762
+ // @public
763
+ export interface LinkDefinition {
764
+ // (undocumented)
765
+ attrs: LinkAttributes;
766
+ // (undocumented)
767
+ type: 'link';
768
+ }
769
+
770
+ // @public (undocumented)
771
+ export const linkify: LinkifyIt.LinkifyIt;
772
+
773
+ // @public (undocumented)
774
+ export const linkifyMatch: (text: string) => Match[];
775
+
776
+ // @public (undocumented)
777
+ export const linkToJSON: (
778
+ mark: Mark,
779
+ ) => {
780
+ type: string;
781
+ attrs: Record<string, string>;
782
+ };
783
+
784
+ // @public (undocumented)
785
+ export const listItem: NodeSpec;
786
+
787
+ // @public (undocumented)
788
+ export interface ListItemArray
789
+ extends Array<
790
+ | ParagraphDefinition
791
+ | OrderedListDefinition
792
+ | BulletListDefinition
793
+ | MediaSingleDefinition
794
+ | CodeBlockDefinition
795
+ > {
796
+ // (undocumented)
797
+ 0: ParagraphDefinition | MediaSingleDefinition | CodeBlockDefinition;
798
+ }
799
+
800
+ // @public
801
+ export interface ListItemDefinition {
802
+ // (undocumented)
803
+ content: ListItemArray;
804
+ // (undocumented)
805
+ type: 'listItem';
806
+ }
807
+
808
+ // @public
809
+ export interface MarksObject<T> {
810
+ // (undocumented)
811
+ marks?: Array<T>;
812
+ }
813
+
814
+ // @public (undocumented)
815
+ export interface Match {
816
+ // (undocumented)
817
+ index: number;
818
+ // (undocumented)
819
+ input?: string;
820
+ // (undocumented)
821
+ lastIndex: number;
822
+ // (undocumented)
823
+ length?: number;
824
+ // (undocumented)
825
+ raw: string;
826
+ // (undocumented)
827
+ schema: any;
828
+ // (undocumented)
829
+ text: string;
830
+ // (undocumented)
831
+ url: string;
832
+ }
833
+
834
+ // @public (undocumented)
835
+ export const media: NodeSpec;
836
+
837
+ // @public (undocumented)
838
+ export type MediaADFAttrs = MediaAttributes | ExternalMediaAttributes;
839
+
840
+ // @public (undocumented)
841
+ export interface MediaAttributes extends MediaBaseAttributes {
842
+ // (undocumented)
843
+ type: 'file' | 'link';
844
+ }
845
+
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)
863
+ collection: string;
864
+ // (undocumented)
865
+ height?: number;
866
+ // (undocumented)
867
+ id: string;
868
+ // (undocumented)
869
+ occurrenceKey?: string;
870
+ // (undocumented)
871
+ width?: number;
872
+ }
873
+
874
+ // @public
875
+ export interface MediaDefinition {
876
+ // (undocumented)
877
+ attrs: MediaADFAttrs;
878
+ // (undocumented)
879
+ marks?: Array<LinkDefinition>;
880
+ // (undocumented)
881
+ type: 'media';
882
+ }
883
+
884
+ // @public (undocumented)
885
+ export type MediaDisplayType = 'file' | 'thumbnail';
886
+
887
+ // @public (undocumented)
888
+ export const mediaGroup: NodeSpec;
889
+
890
+ // @public
891
+ export interface MediaGroupDefinition {
892
+ content: Array<MediaDefinition>;
893
+ // (undocumented)
894
+ type: 'mediaGroup';
895
+ }
896
+
897
+ // @public (undocumented)
898
+ export const mediaInline: NodeSpec;
899
+
900
+ // @public (undocumented)
901
+ export interface MediaInlineAttributes extends MediaBaseAttributes {
902
+ // (undocumented)
903
+ data?: object;
904
+ // (undocumented)
905
+ type?: 'file' | 'link';
906
+ }
907
+
908
+ // @public
909
+ export interface MediaInlineDefinition {
910
+ // (undocumented)
911
+ attrs: MediaInlineAttributes;
912
+ // (undocumented)
913
+ marks?: Array<LinkDefinition>;
914
+ // (undocumented)
915
+ type: 'mediaInline';
916
+ }
917
+
918
+ // @public (undocumented)
919
+ export const mediaSingle: NodeSpec;
920
+
921
+ // @public (undocumented)
922
+ export type MediaSingleDefinition =
923
+ | MediaSingleFullDefinition
924
+ | MediaSingleWithCaptionDefinition;
925
+
926
+ // @public (undocumented)
927
+ export const mediaSingleToJSON: (
928
+ node: Node_2,
929
+ ) => {
930
+ attrs: any;
931
+ };
932
+
933
+ // @public (undocumented)
934
+ export const mediaSingleWithCaption: NodeSpec;
935
+
936
+ // @public (undocumented)
937
+ export const mediaToJSON: (
938
+ node: Node_2,
939
+ ) => {
940
+ attrs: Record<string, any>;
941
+ };
942
+
943
+ // @public (undocumented)
944
+ export type MediaType = 'file' | 'link' | 'external';
945
+
946
+ // @public (undocumented)
947
+ export const mention: NodeSpec;
948
+
949
+ // @public (undocumented)
950
+ export interface MentionAttributes {
951
+ // (undocumented)
952
+ accessLevel?: string;
953
+ // (undocumented)
954
+ id: string;
955
+ // (undocumented)
956
+ text?: string;
957
+ // (undocumented)
958
+ userType?: MentionUserType;
959
+ }
960
+
961
+ // @public
962
+ export interface MentionDefinition {
963
+ // (undocumented)
964
+ attrs: MentionAttributes;
965
+ // (undocumented)
966
+ type: 'mention';
967
+ }
968
+
969
+ // @public (undocumented)
970
+ export const mentionToJSON: (
971
+ node: Node_2,
972
+ ) => {
973
+ attrs: {
974
+ [key: string]: any;
975
+ };
976
+ };
977
+
978
+ // @public (undocumented)
979
+ export type MentionUserType = keyof typeof USER_TYPES;
980
+
981
+ // @public (undocumented)
982
+ export const N0 = '#FFFFFF';
983
+
984
+ // @public (undocumented)
985
+ export const N20 = '#F4F5F7';
986
+
987
+ // @public (undocumented)
988
+ export const N200 = '#6B778C';
989
+
990
+ // @public (undocumented)
991
+ export const N30 = '#EBECF0';
992
+
993
+ // @public (undocumented)
994
+ export const N300 = '#5E6C84';
995
+
996
+ // @public (undocumented)
997
+ export const N40 = '#DFE1E6';
998
+
999
+ // @public (undocumented)
1000
+ export const N50 = '#C1C7D0';
1001
+
1002
+ // @public (undocumented)
1003
+ export const N500 = '#42526E';
1004
+
1005
+ // @public (undocumented)
1006
+ export const N60 = '#B3BAC5';
1007
+
1008
+ // @public (undocumented)
1009
+ export const N80 = '#97A0AF';
1010
+
1011
+ // @public (undocumented)
1012
+ export const N800 = '#172B4D';
1013
+
1014
+ // @public (undocumented)
1015
+ export const N90 = '#8993A4';
1016
+
1017
+ // @public (undocumented)
1018
+ export type NameToEmoji = keyof typeof acNameToEmojiMap;
1019
+
1020
+ // @public (undocumented)
1021
+ export const nestedExpand: NodeSpec;
1022
+
1023
+ // @public
1024
+ export type NestedExpandContent = Array<
1025
+ | ParagraphDefinition
1026
+ | HeadingDefinition
1027
+ | MediaSingleDefinition
1028
+ | MediaGroupDefinition
1029
+ >;
1030
+
1031
+ // @public
1032
+ export type NestedExpandDefinition = NestedExpandBaseDefinition & NoMark;
1033
+
1034
+ // @public
1035
+ export interface NoMark {
1036
+ // (undocumented)
1037
+ marks?: Array<any>;
1038
+ }
1039
+
1040
+ // @public
1041
+ export type NonNestableBlockContent =
1042
+ | PanelDefinition
1043
+ | ParagraphDefinition
1044
+ | BlockQuoteDefinition
1045
+ | OrderedListDefinition
1046
+ | BulletListDefinition
1047
+ | RuleDefinition
1048
+ | HeadingDefinition
1049
+ | CodeBlockDefinition
1050
+ | MediaGroupDefinition
1051
+ | MediaSingleDefinition
1052
+ | DecisionListDefinition
1053
+ | TaskListDefinition
1054
+ | TableDefinition
1055
+ | ExtensionDefinition
1056
+ | BlockCardDefinition
1057
+ | EmbedCardDefinition;
1058
+
1059
+ // @public
1060
+ export function normalizeHexColor(
1061
+ color: string | null,
1062
+ defaultColor?: string,
1063
+ ): string | null;
1064
+
1065
+ // @public
1066
+ export function normalizeUrl(url?: string): string;
1067
+
1068
+ // @public (undocumented)
1069
+ export const orderedList: NodeSpec;
1070
+
1071
+ // @public
1072
+ export interface OrderedListDefinition {
1073
+ // (undocumented)
1074
+ attrs?: {
1075
+ order: number;
1076
+ };
1077
+ // (undocumented)
1078
+ content: Array<ListItemDefinition>;
1079
+ // (undocumented)
1080
+ type: 'orderedList';
1081
+ }
1082
+
1083
+ // @public (undocumented)
1084
+ export const orderedListSelector = '.ak-ol';
1085
+
1086
+ // @public (undocumented)
1087
+ export const P100 = '#998DD9';
1088
+
1089
+ // @public (undocumented)
1090
+ export const P300 = '#6554C0';
1091
+
1092
+ // @public (undocumented)
1093
+ export const P400 = '#5243AA';
1094
+
1095
+ // @public (undocumented)
1096
+ export const P50 = '#EAE6FF';
1097
+
1098
+ // @public (undocumented)
1099
+ export const P500 = '#403294';
1100
+
1101
+ // @public (undocumented)
1102
+ export const P75 = '#C0B6F2';
1103
+
1104
+ // @public (undocumented)
1105
+ export const panel: (allowCustomPanel: boolean) => NodeSpec;
1106
+
1107
+ // @public (undocumented)
1108
+ export interface PanelAttributes {
1109
+ // (undocumented)
1110
+ panelColor?: string;
1111
+ // (undocumented)
1112
+ panelIcon?: string;
1113
+ // (undocumented)
1114
+ panelIconId?: string;
1115
+ // (undocumented)
1116
+ panelIconText?: string;
1117
+ // (undocumented)
1118
+ panelType: PanelType;
1119
+ }
1120
+
1121
+ // @public
1122
+ export interface PanelDefinition {
1123
+ // (undocumented)
1124
+ attrs: PanelAttributes;
1125
+ content: Array<
1126
+ | ParagraphDefinition
1127
+ | HeadingDefinition
1128
+ | OrderedListDefinition
1129
+ | BulletListDefinition
1130
+ | BlockCardDefinition
1131
+ >;
1132
+ // (undocumented)
1133
+ type: 'panel';
1134
+ }
1135
+
1136
+ // @public (undocumented)
1137
+ export enum PanelType {
1138
+ // (undocumented)
1139
+ CUSTOM = 'custom',
1140
+ // (undocumented)
1141
+ ERROR = 'error',
1142
+ // (undocumented)
1143
+ INFO = 'info',
1144
+ // (undocumented)
1145
+ NOTE = 'note',
1146
+ // (undocumented)
1147
+ SUCCESS = 'success',
1148
+ // (undocumented)
1149
+ TIP = 'tip',
1150
+ // (undocumented)
1151
+ WARNING = 'warning',
1152
+ }
1153
+
1154
+ // @public (undocumented)
1155
+ export const paragraph: NodeSpec;
1156
+
1157
+ // @public
1158
+ export interface ParagraphBaseDefinition {
1159
+ content?: Array<Inline>;
1160
+ // (undocumented)
1161
+ marks?: Array<any>;
1162
+ // (undocumented)
1163
+ type: 'paragraph';
1164
+ }
1165
+
1166
+ // @public
1167
+ export type ParagraphDefinition = ParagraphBaseDefinition & NoMark;
1168
+
1169
+ // @public
1170
+ export type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition &
1171
+ MarksObject<AlignmentMarkDefinition>;
1172
+
1173
+ // @public
1174
+ export type ParagraphWithIndentationDefinition = ParagraphBaseDefinition &
1175
+ MarksObject<IndentationMarkDefinition>;
1176
+
1177
+ // @public (undocumented)
1178
+ export type ParagraphWithMarksDefinition =
1179
+ | ParagraphWithAlignmentDefinition
1180
+ | ParagraphWithIndentationDefinition;
1181
+
1182
+ // @public (undocumented)
1183
+ export const placeholder: NodeSpec;
1184
+
1185
+ // @public
1186
+ export interface PlaceholderDefinition {
1187
+ // (undocumented)
1188
+ attrs: {
1189
+ text: string;
1190
+ };
1191
+ // (undocumented)
1192
+ type: 'placeholder';
1193
+ }
1194
+
1195
+ // @public (undocumented)
1196
+ export const R100 = '#FF8F73';
1197
+
1198
+ // @public (undocumented)
1199
+ export const R300 = '#FF5630';
1200
+
1201
+ // @public (undocumented)
1202
+ export const R400 = '#DE350B';
1203
+
1204
+ // @public
1205
+ export const R50 = '#FFEBE6';
1206
+
1207
+ // @public (undocumented)
1208
+ export const R500 = '#BF2600';
1209
+
1210
+ // @public (undocumented)
1211
+ export const R75 = '#FFBDAD';
1212
+
1213
+ // @public (undocumented)
1214
+ export function rgbToHex(value: string): string | null;
1215
+
1216
+ // @public (undocumented)
1217
+ export interface RichMediaAttributes {
1218
+ // (undocumented)
1219
+ layout: RichMediaLayout;
1220
+ width?: number;
1221
+ }
1222
+
1223
+ // @public (undocumented)
1224
+ export type RichMediaLayout =
1225
+ | 'wrap-right'
1226
+ | 'center'
1227
+ | 'wrap-left'
1228
+ | 'wide'
1229
+ | 'full-width'
1230
+ | 'align-end'
1231
+ | 'align-start';
1232
+
1233
+ // @public (undocumented)
1234
+ export const rule: NodeSpec;
1235
+
1236
+ // @public
1237
+ export interface RuleDefinition {
1238
+ // (undocumented)
1239
+ type: 'rule';
1240
+ }
1241
+
1242
+ // @public (undocumented)
1243
+ export function sanitizeNodes(
1244
+ nodes: {
1245
+ [key: string]: NodeSpec;
1246
+ },
1247
+ supportedMarks: {
1248
+ [key: string]: MarkSpec;
1249
+ },
1250
+ ): {
1251
+ [key: string]: NodeSpec;
1252
+ };
1253
+
1254
+ // @public (undocumented)
1255
+ const status_2: NodeSpec;
1256
+ export { status_2 as status };
1257
+
1258
+ // @public
1259
+ export interface StatusDefinition {
1260
+ // (undocumented)
1261
+ attrs: {
1262
+ text: string;
1263
+ color: 'neutral' | 'purple' | 'blue' | 'red' | 'yellow' | 'green';
1264
+ localId?: string;
1265
+ style?: string;
1266
+ };
1267
+ // (undocumented)
1268
+ type: 'status';
1269
+ }
1270
+
1271
+ // @public (undocumented)
1272
+ export const strike: MarkSpec;
1273
+
1274
+ // @public
1275
+ export interface StrikeDefinition {
1276
+ // (undocumented)
1277
+ type: 'strike';
1278
+ }
1279
+
1280
+ // @public (undocumented)
1281
+ export const strong: MarkSpec;
1282
+
1283
+ // @public
1284
+ export interface StrongDefinition {
1285
+ // (undocumented)
1286
+ type: 'strong';
1287
+ }
1288
+
1289
+ // @public (undocumented)
1290
+ export const subsup: MarkSpec;
1291
+
1292
+ // @public (undocumented)
1293
+ export interface SubSupAttributes {
1294
+ // (undocumented)
1295
+ type: 'sub' | 'sup';
1296
+ }
1297
+
1298
+ // @public
1299
+ export interface SubSupDefinition {
1300
+ // (undocumented)
1301
+ attrs: SubSupAttributes;
1302
+ // (undocumented)
1303
+ type: 'subsup';
1304
+ }
1305
+
1306
+ // @public (undocumented)
1307
+ export const T100 = '#79E2F2';
1308
+
1309
+ // @public (undocumented)
1310
+ export const T300 = '#00B8D9';
1311
+
1312
+ // @public (undocumented)
1313
+ export const T50 = '#E6FCFF';
1314
+
1315
+ // @public (undocumented)
1316
+ export const T500 = '#008DA6';
1317
+
1318
+ // @public (undocumented)
1319
+ export const T75 = '#B3F5FF';
1320
+
1321
+ // @public (undocumented)
1322
+ export const table: NodeSpec;
1323
+
1324
+ // @public (undocumented)
1325
+ export interface TableAttributes {
1326
+ // (undocumented)
1327
+ __autoSize?: boolean;
1328
+ // (undocumented)
1329
+ isNumberColumnEnabled?: boolean;
1330
+ // (undocumented)
1331
+ layout?: TableLayout;
1332
+ // (undocumented)
1333
+ localId?: string;
1334
+ }
1335
+
1336
+ // @public (undocumented)
1337
+ export const tableBackgroundBorderColor: string;
1338
+
1339
+ // @public (undocumented)
1340
+ export const tableBackgroundColorNames: Map<string, string>;
1341
+
1342
+ // @public (undocumented)
1343
+ export const tableBackgroundColorPalette: Map<string, string>;
1344
+
1345
+ // @public (undocumented)
1346
+ export const tableCell: NodeSpec;
1347
+
1348
+ // @public (undocumented)
1349
+ export const tableCellContentDomSelector: string;
1350
+
1351
+ // @public (undocumented)
1352
+ export const tableCellContentWrapperSelector: string;
1353
+
1354
+ // @public
1355
+ export interface TableCellDefinition {
1356
+ // (undocumented)
1357
+ attrs?: CellAttributes;
1358
+ // (undocumented)
1359
+ content: TableCellContent;
1360
+ // (undocumented)
1361
+ type: 'tableCell';
1362
+ }
1363
+
1364
+ // @public (undocumented)
1365
+ export const tableCellSelector: string;
1366
+
1367
+ // @public
1368
+ export interface TableDefinition {
1369
+ // (undocumented)
1370
+ attrs?: TableAttributes;
1371
+ // (undocumented)
1372
+ content: Array<TableRowDefinition>;
1373
+ // (undocumented)
1374
+ marks?: Array<FragmentDefinition>;
1375
+ // (undocumented)
1376
+ type: 'table';
1377
+ }
1378
+
1379
+ // @public (undocumented)
1380
+ export const tableHeader: NodeSpec;
1381
+
1382
+ // @public
1383
+ export interface TableHeaderDefinition {
1384
+ // (undocumented)
1385
+ attrs?: CellAttributes;
1386
+ // (undocumented)
1387
+ content: TableCellContent;
1388
+ // (undocumented)
1389
+ type: 'tableHeader';
1390
+ }
1391
+
1392
+ // @public (undocumented)
1393
+ export const tableHeaderSelector: string;
1394
+
1395
+ // @public (undocumented)
1396
+ export type TableLayout = 'default' | 'full-width' | 'wide';
1397
+
1398
+ // @public (undocumented)
1399
+ export const tablePrefixSelector = 'pm-table';
1400
+
1401
+ // @public (undocumented)
1402
+ export const tableRow: NodeSpec;
1403
+
1404
+ // @public
1405
+ export interface TableRowDefinition {
1406
+ // (undocumented)
1407
+ content: Array<TableHeaderDefinition | TableCellDefinition>;
1408
+ // (undocumented)
1409
+ type: 'tableRow';
1410
+ }
1411
+
1412
+ // @public (undocumented)
1413
+ export const tableToJSON: (
1414
+ node: Node_2,
1415
+ ) => {
1416
+ attrs: {
1417
+ [key: string]: any;
1418
+ };
1419
+ };
1420
+
1421
+ // @public (undocumented)
1422
+ export const taskItem: NodeSpec;
1423
+
1424
+ // @public
1425
+ export interface TaskItemDefinition {
1426
+ // (undocumented)
1427
+ attrs: {
1428
+ localId: string;
1429
+ state: 'TODO' | 'DONE';
1430
+ };
1431
+ content?: Array<Inline>;
1432
+ // (undocumented)
1433
+ type: 'taskItem';
1434
+ }
1435
+
1436
+ // @public (undocumented)
1437
+ export const taskList: NodeSpec;
1438
+
1439
+ // @public (undocumented)
1440
+ export interface TaskListContent
1441
+ extends Array<TaskItemDefinition | TaskListDefinition> {
1442
+ // (undocumented)
1443
+ 0: TaskItemDefinition;
1444
+ }
1445
+
1446
+ // @public
1447
+ export interface TaskListDefinition {
1448
+ // (undocumented)
1449
+ attrs: {
1450
+ localId: string;
1451
+ };
1452
+ content: TaskListContent;
1453
+ // (undocumented)
1454
+ type: 'taskList';
1455
+ }
1456
+
1457
+ // @public (undocumented)
1458
+ export const taskListSelector: string;
1459
+
1460
+ // @public (undocumented)
1461
+ export const text: NodeSpec & {
1462
+ toDebugString?: () => string;
1463
+ };
1464
+
1465
+ // @public (undocumented)
1466
+ export const textColor: MarkSpec;
1467
+
1468
+ // @public (undocumented)
1469
+ export interface TextColorAttributes {
1470
+ color: string;
1471
+ }
1472
+
1473
+ // @public
1474
+ export interface TextColorDefinition {
1475
+ // (undocumented)
1476
+ attrs: TextColorAttributes;
1477
+ // (undocumented)
1478
+ type: 'textColor';
1479
+ }
1480
+
1481
+ // @public
1482
+ export interface TextDefinition {
1483
+ // (undocumented)
1484
+ marks?: Array<any>;
1485
+ // (undocumented)
1486
+ text: string;
1487
+ // (undocumented)
1488
+ type: 'text';
1489
+ }
1490
+
1491
+ // @public (undocumented)
1492
+ export const toJSONTableCell: (
1493
+ node: Node_2,
1494
+ ) => {
1495
+ attrs: Record<string, any>;
1496
+ };
1497
+
1498
+ // @public (undocumented)
1499
+ export const toJSONTableHeader: (
1500
+ node: Node_2,
1501
+ ) => {
1502
+ attrs: Record<string, any>;
1503
+ };
1504
+
1505
+ // @public (undocumented)
1506
+ export const typeAheadQuery: MarkSpec;
1507
+
1508
+ // @public (undocumented)
1509
+ export const underline: MarkSpec;
1510
+
1511
+ // @public
1512
+ export interface UnderlineDefinition {
1513
+ // (undocumented)
1514
+ type: 'underline';
1515
+ }
1516
+
1517
+ // @public (undocumented)
1518
+ export const unknownBlock: NodeSpec;
1519
+
1520
+ // @public (undocumented)
1521
+ export const unsupportedBlock: NodeSpec;
1522
+
1523
+ // @public (undocumented)
1524
+ export const unsupportedInline: NodeSpec;
1525
+
1526
+ // @public (undocumented)
1527
+ export const unsupportedMark: MarkSpec;
1528
+
1529
+ // @public (undocumented)
1530
+ export const unsupportedNodeAttribute: MarkSpec;
1531
+
1532
+ // @public (undocumented)
1533
+ export const unsupportedNodeTypesForMediaCards: Set<string>;
1534
+
1535
+ // @public (undocumented)
1536
+ export interface UrlType {
1537
+ url: string;
1538
+ }
1539
+
1540
+ // @public (undocumented)
1541
+ export const uuid: {
1542
+ setStatic(value: string | false): void;
1543
+ generate(): string;
1544
+ };
1545
+
1546
+ // @public (undocumented)
1547
+ export const Y200 = '#FFC400';
1548
+
1549
+ // @public (undocumented)
1550
+ export const Y400 = '#FF991F';
1551
+
1552
+ // @public (undocumented)
1553
+ export const Y50 = '#FFFAE6';
1554
+
1555
+ // @public (undocumented)
1556
+ export const Y500 = '#FF8B00';
1557
+
1558
+ // @public (undocumented)
1559
+ export const Y75 = '#FFF0B3';
1560
+
1561
+ // (No @packageDocumentation comment for this package)
1562
+ ```