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