# All files / blocks/markdown deprecated.js

0% Statements 0/44
0% Branches 0/87
0% Functions 0/13
0% Lines 0/44

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537

     /** Markdown block deprecated version definitions
     *
     * Backward Compatibility Strategy:
     * - v6: Before multilingual feature (content/html as top-level)
     * - v5: With data-show-frontmatter in HTML
     * - v4: Before showFrontmatter/frontmatterData addition
     * - v3: Before shikiTheme addition
     * - v2: Before mermaidBgColor addition
     * - v1: Initial version
     *
     * WordPress Gutenberg automatically applies migrations in sequence when
     * block structure changes. Each version includes a migrate() function
     * that transforms old block data to the current schema.
     *
     * Key Migration Point (v6 - Multilingual):
     * The multilingual feature introduces a new data structure:
     * - Old: content/html as top-level attributes
     * - New: languages object containing per-language content/html
     *
     * Migration detects old blocks by checking for missing languages attribute
     * and converts content/html to the new languages structure.
     *
     * Key Migration Point (v5):
     * WordPress stores block attributes in two ways:
     * 1. Block comment: Used by default for new attributes
     * 2. HTML attributes (data-*): Legacy storage when source: 'attribute' is set
     *
     * When data-show-frontmatter was removed from save.js, existing blocks
     * had this attribute in their HTML but NOT in the block comment.
     * Without source: 'attribute' in v5, WordPress would read from comment
     * (defaulting to false) instead of HTML (actual value).
     * This caused validation errors when frontmatter was true in HTML.
     */

    import { useBlockProps } from '@wordpress/block-editor';

    /**
     * v6: Before multilingual feature
     * This deprecated version represents blocks before the languages attribute was added.
     *
     * Migration Strategy:
     * - Detects old blocks by checking for missing or empty languages attribute
     * - Converts top-level content/html to languages object structure
     * - Uses site's default language from wpGfmConfig or falls back to 'en'
     */
    const v6 = {
    	attributes: {
    		content: {
    			type: 'string',
    			default: '',
    		},
    		html: {
    			type: 'string',
    			default: '',
    		},
    		mermaidBgColor: {
    			type: 'string',
    			default: 'transparent',
    		},
    		shikiTheme: {
    			type: 'string',
    			default: '',
    		},
    		showFrontmatter: {
    			type: 'boolean',
    			default: false,
    		},
    		frontmatterData: {
    			type: 'object',
    			default: {},
    		},
    		// Note: languages, defaultLanguage, availableLanguages, showLanguageSwitcher
    		// were not present in v6 (pre-multilingual)
    	},

    	/**
    	 * Determine if block needs migration
    	 * Returns true for blocks that have content but no languages attribute
    	 */
    	isEligible( attributes ) {
    		// Block needs migration if:
    		// 1. Has no languages attribute OR languages is empty object
    		// 2. AND has content or html (not a brand new empty block)
    		const hasNoLanguages = ! attributes.languages ||
    			( typeof attributes.languages === 'object' &&
    			  Object.keys( attributes.languages ).length === 0 );
    		const hasContent = attributes.content || attributes.html;

    		return hasNoLanguages && hasContent;
    	},

    	/** save function (pre-multilingual format) */
    	save( { attributes } ) {
    		const { content, html, mermaidBgColor, shikiTheme, showFrontmatter = false } = attributes;

    		const bgColor = mermaidBgColor || 'transparent';
    		const theme = shikiTheme || '';

    		const blockProps = useBlockProps.save( {
    			className: 'gfmr-markdown-container',
    		} );

    		return (
    			<div { ...blockProps }>
    				<div
    					className="gfmr-markdown-source"
    					style={ {
    						display: 'none',
    						visibility: 'hidden',
    						position: 'absolute',
    						left: '-9999px',
    						top: '-9999px',
    						width: '1px',
    						height: '1px',
    						overflow: 'hidden',
    					} }
    					aria-hidden="true"
    				>
    					{ content }
    				</div>

    				<div
    					className="gfmr-markdown-rendered"
    					data-mermaid-bg-color={ bgColor }
    					data-shiki-theme={ theme }
    					dangerouslySetInnerHTML={ { __html: html || '' } }
    				/>
    			</div>
    		);
    	},

    	/**
    	 * Migrate to multilingual format
    	 * Converts content/html to languages object structure
    	 */
    	migrate( attributes ) {
    		// Get site's default language from config or fall back to 'en'
    		const defaultLang = ( typeof window !== 'undefined' &&
    			window.wpGfmConfig?.siteLanguage ) || 'en';

    		const { content, html, ...rest } = attributes;

    		// Log migration in debug mode
    		if ( typeof window !== 'undefined' && window.WP_DEBUG ) {
    			console.log( '[GFMR] Migrating block to multilingual format:', {
    				defaultLang,
    				contentLength: ( content || '' ).length,
    			} );
    		}

    		return {
    			...rest,
    			// Keep content/html for backward compatibility during transition
    			content: content || '',
    			html: html || '',
    			// New multilingual attributes
    			languages: {
    				[ defaultLang ]: {
    					content: content || '',
    					html: html || '',
    				},
    			},
    			defaultLanguage: defaultLang,
    			availableLanguages: [ defaultLang ],
    			showLanguageSwitcher: false, // Single language, no need for switcher
    		};
    	},
    };

    /**
     * v5: Version with data-show-frontmatter attribute in HTML
     * This deprecated version represents the save.js before data-show-frontmatter was removed.
     *
     * Critical Implementation:
     * - Uses source: 'attribute' to read showFrontmatter from HTML data attribute
     * - This allows reading the true value from legacy blocks instead of block comment
     * - Without this, validation errors occur on blocks where frontmatter=true
     */
    const v5 = {
    	attributes: {
    		content: {
    			type: 'string',
    			default: '',
    		},
    		html: {
    			type: 'string',
    			default: '',
    		},
    		mermaidBgColor: {
    			type: 'string',
    			default: 'transparent',
    		},
    		shikiTheme: {
    			type: 'string',
    			default: '',
    		},
    		showFrontmatter: {
    			type: 'boolean',
    			default: false,
    			source: 'attribute',
    			selector: '.gfmr-markdown-rendered',
    			attribute: 'data-show-frontmatter',
    		},
    		frontmatterData: {
    			type: 'object',
    			default: {},
    		},
    	},

    	/** save function */
    	save( { attributes } ) {
    		const { content, html, mermaidBgColor, shikiTheme, showFrontmatter = false, frontmatterData = {} } = attributes;

    		// Fallback processing for mermaidBgColor (undefined protection)
    		const bgColor = mermaidBgColor || 'transparent';
    		// Shiki theme used during HTML generation (for frontend comparison)
    		const theme = shikiTheme || '';

    		const blockProps = useBlockProps.save( {
    			className: 'gfmr-markdown-container',
    		} );

    		return (
    			<div { ...blockProps }>
    				{ /* Preserve original Markdown (hidden) */ }
    				<div
    					className="gfmr-markdown-source"
    					style={ {
    						display: 'none',
    						visibility: 'hidden',
    						position: 'absolute',
    						left: '-9999px',
    						top: '-9999px',
    						width: '1px',
    						height: '1px',
    						overflow: 'hidden',
    					} }
    					aria-hidden="true"
    				>
    					{ content }
    				</div>

    				{ /* Rendered HTML (with data-show-frontmatter) */ }
    				<div
    					className="gfmr-markdown-rendered"
    					data-mermaid-bg-color={ bgColor }
    					data-shiki-theme={ theme }
    					data-show-frontmatter={ showFrontmatter }
    					dangerouslySetInnerHTML={ { __html: html || '' } }
    				/>
    			</div>
    		);
    	},

    	/** Automatic migration */
    	migrate( attributes ) {
    		return {
    			content: attributes.content || '',
    			html: attributes.html || '',
    			mermaidBgColor: attributes.mermaidBgColor || 'transparent',
    			shikiTheme: attributes.shikiTheme || '',
    			showFrontmatter: attributes.showFrontmatter || false,
    			frontmatterData: attributes.frontmatterData || {}, // Explicitly set default
    		};
    	},
    };

    /**
     * v4: Before showFrontmatter and frontmatterData attributes addition
     * This version has shikiTheme but no showFrontmatter/frontmatterData attributes.
     */
    const v4 = {
    	attributes: {
    		content: {
    			type: 'string',
    			default: '',
    		},
    		html: {
    			type: 'string',
    			default: '',
    		},
    		mermaidBgColor: {
    			type: 'string',
    			default: 'transparent',
    		},
    		shikiTheme: {
    			type: 'string',
    			default: '',
    		},
    		// Note: showFrontmatter and frontmatterData attributes were not present in v4
    	},

    	/** save function */
    	save( { attributes } ) {
    		const { content, html, mermaidBgColor, shikiTheme } = attributes;

    		// Fallback processing for mermaidBgColor (undefined protection)
    		const bgColor = mermaidBgColor || 'transparent';
    		// Shiki theme used during HTML generation (for frontend comparison)
    		const theme = shikiTheme || '';

    		const blockProps = useBlockProps.save( {
    			className: 'gfmr-markdown-container',
    		} );

    		return (
    			<div { ...blockProps }>
    				{ /* Preserve original Markdown (hidden) */ }
    				<div
    					className="gfmr-markdown-source"
    					style={ {
    						display: 'none',
    						visibility: 'hidden',
    						position: 'absolute',
    						left: '-9999px',
    						top: '-9999px',
    						width: '1px',
    						height: '1px',
    						overflow: 'hidden',
    					} }
    					aria-hidden="true"
    				>
    					{ content }
    				</div>

    				{ /* Rendered HTML (without data-show-frontmatter) */ }
    				<div
    					className="gfmr-markdown-rendered"
    					data-mermaid-bg-color={ bgColor }
    					data-shiki-theme={ theme }
    					dangerouslySetInnerHTML={ { __html: html || '' } }
    				/>
    			</div>
    		);
    	},

    	/** Automatic migration */
    	migrate( attributes ) {
    		return {
    			content: attributes.content || '',
    			html: attributes.html || '',
    			mermaidBgColor: attributes.mermaidBgColor || 'transparent',
    			shikiTheme: attributes.shikiTheme || '',
    			showFrontmatter: false, // New attribute with false default
    			frontmatterData: {}, // New attribute with empty object default
    		};
    	},
    };

    /**
     * v3: Before shikiTheme attribute addition
     * This version has mermaidBgColor but no shikiTheme attribute.
     */
    const v3 = {
    	attributes: {
    		content: {
    			type: 'string',
    			default: '',
    		},
    		html: {
    			type: 'string',
    			default: '',
    		},
    		mermaidBgColor: {
    			type: 'string',
    			default: 'transparent',
    		},
    		// Note: shikiTheme attribute was not present in v3
    	},

    	/** save function */
    	save( { attributes } ) {
    		const { content, html, mermaidBgColor } = attributes;

    		// Fallback processing for mermaidBgColor (undefined protection)
    		const bgColor = mermaidBgColor || 'transparent';

    		const blockProps = useBlockProps.save( {
    			className: 'gfmr-markdown-container',
    		} );

    		return (
    			<div { ...blockProps }>
    				{ /* Preserve original Markdown (hidden) */ }
    				<div
    					className="gfmr-markdown-source"
    					style={ {
    						display: 'none',
    						visibility: 'hidden',
    						position: 'absolute',
    						left: '-9999px',
    						top: '-9999px',
    						width: '1px',
    						height: '1px',
    						overflow: 'hidden',
    					} }
    					aria-hidden="true"
    				>
    					{ content }
    				</div>

    				{ /* Rendered HTML (without data-shiki-theme) */ }
    				<div
    					className="gfmr-markdown-rendered"
    					data-mermaid-bg-color={ bgColor }
    					dangerouslySetInnerHTML={ { __html: html || '' } }
    				/>
    			</div>
    		);
    	},

    	/** Automatic migration */
    	migrate( attributes ) {
    		return {
    			content: attributes.content || '',
    			html: attributes.html || '',
    			mermaidBgColor: attributes.mermaidBgColor || 'transparent',
    			shikiTheme: '', // New attribute with empty default
    		};
    	},
    };

    /** v2: Before mermaidBgColor attribute addition */
    const v2 = {
    	attributes: {
    		content: {
    			type: 'string',
    			default: ''
    		},
    		html: {
    			type: 'string',
    			default: ''
    		}
    	},

    	/** save function */
    	save( { attributes } ) {
    		const { content, html } = attributes;
    		const blockProps = useBlockProps.save( {
    			className: 'gfmr-markdown-container'
    		} );

    		return (
    			<div { ...blockProps }>
    				{/* Preserve original Markdown (hidden) */}
    				<div
    					className="gfmr-markdown-source"
    					style={ {
    						display: 'none',
    						visibility: 'hidden',
    						position: 'absolute',
    						left: '-9999px',
    						top: '-9999px',
    						width: '1px',
    						height: '1px',
    						overflow: 'hidden'
    					} }
    					aria-hidden="true"
    				>
    					{ content }
    				</div>

    				{/* Rendered HTML (without data-mermaid-bg-color attribute) */}
    				<div
    					className="gfmr-markdown-rendered"
    					dangerouslySetInnerHTML={ { __html: html || '' } }
    				/>
    			</div>
    		);
    	},

    	/** Automatic migration */
    	migrate( attributes ) {
    		return {
    			content: attributes.content || '',
    			html: attributes.html || '',
    			mermaidBgColor: 'transparent',
    			shikiTheme: '', // New attribute with empty default
    		};
    	},
    };

    /** v1: Initial version */
    const v1 = {
    	attributes: {
    		content: {
    			type: 'string',
    			default: ''
    		},
    		html: {
    			type: 'string',
    			default: ''
    		}
    	},

    	/** save function */
    	save( { attributes } ) {
    		const { content, html } = attributes;
    		const blockProps = useBlockProps.save( {
    			className: 'gfmr-markdown-container'
    		} );

    		return (
    			<div { ...blockProps }>
    				{/* Preserve original Markdown (hidden) */}
    				<div className="gfmr-markdown-source" style={ { display: 'none' } }>
    					{ content }
    				</div>

    				{/* Rendered HTML */}
    				<div
    					className="gfmr-markdown-rendered"
    					dangerouslySetInnerHTML={ { __html: html || '' } }
    				/>
    			</div>
    		);
    	},

    	/** Automatic migration */
    	migrate( attributes ) {
    		return {
    			content: attributes.content || '',
    			html: attributes.html || '',
    			mermaidBgColor: 'transparent',
    			shikiTheme: '', // New attribute with empty default
    		};
    	},
    };

    export default [
    	v6, // Before multilingual feature (content/html as top-level)
    	v5, // With data-show-frontmatter in HTML
    	v4, // Before showFrontmatter/frontmatterData addition
    	v3, // Before shikiTheme addition
    	v2, // Before mermaidBgColor addition
    	v1, // Initial version (display: none only)
    ];