Update licenseKey handling (#17316)

Other: Changes related to the introduction of self-service channel for CKEditor 5 Premium Features. See #17317. MAJOR BREAKING CHANGE: `config.licenseKey` is now a required property in the editor configuration. Use `'GPL'` for installations under the GPL terms. See #17317.
ckeditor · Oct 24, 2024 · 5d0fe1e · 5d0fe1e
1 parent 21c6f46
commit 5d0fe1e
Show file tree

Hide file tree

Showing 359 changed files with 11,038 additions and 2,940 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -21,6 +21,7 @@ module.exports = {
 	],
 	rules: {
 		'ckeditor5-rules/ckeditor-imports': 'error',
+		'ckeditor5-rules/prevent-license-key-leak': 'error',
 		'ckeditor5-rules/license-header': [ 'error', {
 			headerLines: [
 				'/**',

diff --git a/docs/_snippets/examples/balloon-block-editor.js b/docs/_snippets/examples/balloon-block-editor.js
@@ -23,7 +23,8 @@ BalloonEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/examples/balloon-editor.js b/docs/_snippets/examples/balloon-editor.js
@@ -25,7 +25,8 @@ BalloonEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/examples/bottom-toolbar-editor.js b/docs/_snippets/examples/bottom-toolbar-editor.js
@@ -202,8 +202,8 @@ DecoupledEditor
 				'mergeTableCells'
 			]
 		},
-
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/examples/classic-editor-short.js b/docs/_snippets/examples/classic-editor-short.js
@@ -14,7 +14,8 @@ ClassicEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/examples/classic-editor.js b/docs/_snippets/examples/classic-editor.js
@@ -23,7 +23,8 @@ ClassicEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/examples/document-editor.js b/docs/_snippets/examples/document-editor.js
@@ -29,7 +29,8 @@ DecoupledEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		const toolbarContainer = document.querySelector( '.document-editor__toolbar' );

diff --git a/docs/_snippets/examples/inline-editor.js b/docs/_snippets/examples/inline-editor.js
@@ -26,7 +26,8 @@ Array.from( inlineInjectElements ).forEach( inlineElement => {
 				'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
 			]
 		},
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	};
 
 	if ( inlineElement.tagName.toLowerCase() == 'header' ) {

diff --git a/docs/_snippets/examples/multi-root-editor.js b/docs/_snippets/examples/multi-root-editor.js
@@ -28,7 +28,8 @@ MultiRootEditor
 					'|', 'link', 'uploadImage', 'insertTable', 'mediaEmbed',
 					'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
 				]
-			}
+			},
+			licenseKey: 'GPL'
 		}
 	)
 	.then( editor => {

diff --git a/docs/_snippets/features/image-upload.js b/docs/_snippets/features/image-upload.js
@@ -61,7 +61,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/mathtype.js b/docs/_snippets/features/mathtype.js
@@ -59,7 +59,8 @@ ClassicEditor
 		table: {
 			contentToolbar: [ 'tableColumn', 'tableRow', 'mergeTableCells' ]
 		},
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 
 	.then( editor => {

diff --git a/docs/_snippets/features/mermaid.js b/docs/_snippets/features/mermaid.js
@@ -39,7 +39,8 @@ ClassicEditor
 				top: window.getViewportTopOffsetConfig()
 			}
 		},
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/placeholder-custom.js b/docs/_snippets/features/placeholder-custom.js
@@ -32,7 +32,8 @@ ClassicEditor
 				top: window.getViewportTopOffsetConfig()
 			}
 		},
-		placeholder: 'Type some content here!'
+		placeholder: 'Type some content here!',
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/placeholder.js b/docs/_snippets/features/placeholder.js
@@ -32,7 +32,8 @@ ClassicEditor
 				top: window.getViewportTopOffsetConfig()
 			}
 		},
-		placeholder: 'Type some content here!'
+		placeholder: 'Type some content here!',
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/read-only-hide-toolbar.js b/docs/_snippets/features/read-only-hide-toolbar.js
@@ -35,7 +35,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/read-only.js b/docs/_snippets/features/read-only.js
@@ -57,7 +57,8 @@ ClassicEditor
 		exportWord: {
 			fileName: 'export-word-demo.docx',
 			tokenUrl: false
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		const button = document.querySelector( '#snippet-read-only-toggle' );

diff --git a/docs/_snippets/features/ui-language-content.js b/docs/_snippets/features/ui-language-content.js
@@ -38,7 +38,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/ui-language-rtl.js b/docs/_snippets/features/ui-language-rtl.js
@@ -36,7 +36,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/ui-language.js b/docs/_snippets/features/ui-language.js
@@ -36,7 +36,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/features/update-placeholder.js b/docs/_snippets/features/update-placeholder.js
@@ -26,7 +26,8 @@ ClassicEditor
 				top: window.getViewportTopOffsetConfig()
 			}
 		},
-		placeholder: 'Type some content here!'
+		placeholder: 'Type some content here!',
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		const button = document.getElementById( 'update-placeholder-button' );

diff --git a/docs/_snippets/features/wproofreader.js b/docs/_snippets/features/wproofreader.js
@@ -52,7 +52,8 @@ ClassicEditor
 		},
 		table: {
 			contentToolbar: [ 'tableColumn', 'tableRow', 'mergeTableCells' ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/framework/development-tools/inspector.js b/docs/_snippets/framework/development-tools/inspector.js
@@ -16,7 +16,8 @@ ClassicEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/framework/tutorials/block-widget.js b/docs/_snippets/framework/tutorials/block-widget.js
@@ -233,7 +233,8 @@ ClassicEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		console.log( 'Editor was initialized', editor );

diff --git a/docs/_snippets/framework/tutorials/external-data-widget.js b/docs/_snippets/framework/tutorials/external-data-widget.js
@@ -194,7 +194,8 @@ class ExternalDataWidgetEditing extends Plugin {
 ClassicEditor
 	.create( document.querySelector( '#snippet-external-data-widget' ), {
 		plugins: [ Essentials, Paragraph, Heading, List, Bold, Italic, ExternalDataWidget ],
-		toolbar: [ 'undo', 'redo', '|', 'external', '|', 'heading', '|', 'bold', 'italic', '|', 'numberedList', 'bulletedList' ]
+		toolbar: [ 'undo', 'redo', '|', 'external', '|', 'heading', '|', 'bold', 'italic', '|', 'numberedList', 'bulletedList' ],
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		console.log( 'Editor was initialized', editor );

diff --git a/docs/_snippets/framework/tutorials/inline-widget.js b/docs/_snippets/framework/tutorials/inline-widget.js
@@ -221,7 +221,8 @@ ClassicEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		console.log( 'Editor was initialized', editor );

diff --git a/docs/_snippets/framework/tutorials/using-react-in-widget.html b/docs/_snippets/framework/tutorials/using-react-in-widget.html
@@ -293,7 +293,8 @@ <h3>Other deals</h3>
                         <ProductPreview id={id} {...product} />
                     );
                 }
-            }
+            },
+            licenseKey: 'GPL'
         };
 
         this.handleEditorDataChange = this.handleEditorDataChange.bind( this );

diff --git a/docs/_snippets/framework/ui/ui-button.js b/docs/_snippets/framework/ui/ui-button.js
@@ -68,7 +68,8 @@ document.querySelector( '.ui-button' ).append( toolbarButtons.element );
 
 ClassicEditor
 	.create( document.querySelector( '#ui-button-editor' ), {
-		plugins: [ Essentials ]
+		plugins: [ Essentials ],
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		this.tooltipManager = new TooltipManager( editor );

diff --git a/docs/_snippets/framework/ui/ui-dialog.js b/docs/_snippets/framework/ui/ui-dialog.js
@@ -74,7 +74,8 @@ class MinimalisticDialog extends Plugin {
 ClassicEditor
 	.create( document.querySelector( '#ui-dialog-editor' ), {
 		plugins: [ Essentials, Paragraph, Bold, Italic, Underline, MinimalisticDialog, Dialog ],
-		toolbar: [ 'bold', 'italic', 'underline', '|', 'showDialog' ]
+		toolbar: [ 'bold', 'italic', 'underline', '|', 'showDialog' ],
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.attachTourBalloon( {

diff --git a/docs/_snippets/framework/ui/ui-modal.js b/docs/_snippets/framework/ui/ui-modal.js
@@ -75,7 +75,8 @@ class MinimalisticModal extends Plugin {
 ClassicEditor
 	.create( document.querySelector( '#ui-modal-editor' ), {
 		plugins: [ Essentials, Paragraph, Bold, Italic, Underline, MinimalisticModal, Dialog ],
-		toolbar: [ 'bold', 'italic', 'underline', '|', 'showModal' ]
+		toolbar: [ 'bold', 'italic', 'underline', '|', 'showModal' ],
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.attachTourBalloon( {

diff --git a/docs/_snippets/installation/getting-and-setting-data/manualsave.js b/docs/_snippets/installation/getting-and-setting-data/manualsave.js
@@ -21,7 +21,8 @@ ClassicEditor
 			viewportOffset: {
 				top: window.getViewportTopOffsetConfig()
 			}
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/blocktoolbar.js b/docs/_snippets/installation/setup/blocktoolbar.js
@@ -32,7 +32,8 @@ ClassicEditor
 			'|',
 			'outdent', 'indent'
 		],
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editorBasic = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-basic.js b/docs/_snippets/installation/setup/toolbar-basic.js
@@ -33,7 +33,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-breakpoint.js b/docs/_snippets/installation/setup/toolbar-breakpoint.js
@@ -61,7 +61,8 @@ ClassicEditor
 				{ model: 'heading4', view: 'h5', title: 'Heading 4', class: 'ck-heading_heading4' }
 			]
 		},
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-grouping.js b/docs/_snippets/installation/setup/toolbar-grouping.js
@@ -58,7 +58,8 @@ ClassicEditor
 				{ model: 'heading4', view: 'h5', title: 'Heading 4', class: 'ck-heading_heading4' }
 			]
 		},
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-nested-icon.js b/docs/_snippets/installation/setup/toolbar-nested-icon.js
@@ -56,7 +56,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-nested-label.js b/docs/_snippets/installation/setup/toolbar-nested-label.js
@@ -45,7 +45,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-nested-simple.js b/docs/_snippets/installation/setup/toolbar-nested-simple.js
@@ -48,7 +48,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-nested-tooltip.js b/docs/_snippets/installation/setup/toolbar-nested-tooltip.js
@@ -39,7 +39,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-separator.js b/docs/_snippets/installation/setup/toolbar-separator.js
@@ -33,7 +33,8 @@ ClassicEditor
 			tokenUrl: TOKEN_URL,
 			forceDemoLabel: true,
 			allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ]
-		}
+		},
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;

diff --git a/docs/_snippets/installation/setup/toolbar-wrapping.js b/docs/_snippets/installation/setup/toolbar-wrapping.js
@@ -63,7 +63,8 @@ ClassicEditor
 		table: {
 			contentToolbar: [ 'tableColumn', 'tableRow', 'mergeTableCells', 'tableProperties', 'tableCellProperties' ]
 		},
-		cloudServices: CS_CONFIG
+		cloudServices: CS_CONFIG,
+		licenseKey: 'GPL'
 	} )
 	.then( editor => {
 		window.editor = editor;