@ckeditor/ckeditor5-media-embed 37.0.0-alpha.0 → 37.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-media-embed",
-  "version": "37.0.0-alpha.0",
+  "version": "37.0.0-alpha.2",
   "description": "Media embed feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,26 +12,26 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.0",
-    "ckeditor5": "^37.0.0-alpha.0"
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.2",
+    "ckeditor5": "^37.0.0-alpha.2"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
-    "@ckeditor/ckeditor5-editor-balloon": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-widget": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-dev-utils": "^35.0.0",
+    "@ckeditor/ckeditor5-editor-balloon": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-widget": "^37.0.0-alpha.2",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0",
@@ -61,7 +61,7 @@
   ],
   "scripts": {
     "dll:build": "webpack",
-    "build": "tsc -p ./tsconfig.release.json",
+    "build": "tsc -p ./tsconfig.json",
     "postversion": "npm run build"
   },
   "types": "src/index.d.ts"

package/src/augmentation.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { MediaEmbedConfig, AutoMediaEmbed, MediaEmbed, MediaEmbedEditing, MediaEmbedToolbar, MediaEmbedUI, MediaEmbedCommand } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:media-embed/mediaembed~MediaEmbed} feature.
+         *
+         * Read more in {@link module:media-embed/mediaembedconfig~MediaEmbedConfig}.
+         */
+        mediaEmbed?: MediaEmbedConfig;
+    }
+    interface PluginsMap {
+        [AutoMediaEmbed.pluginName]: AutoMediaEmbed;
+        [MediaEmbed.pluginName]: MediaEmbed;
+        [MediaEmbedEditing.pluginName]: MediaEmbedEditing;
+        [MediaEmbedToolbar.pluginName]: MediaEmbedToolbar;
+        [MediaEmbedUI.pluginName]: MediaEmbedUI;
+    }
+    interface CommandsMap {
+        mediaEmbed: MediaEmbedCommand;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/automediaembed.d.ts

@@ -46,8 +46,3 @@ export default class AutoMediaEmbed extends Plugin {
      */
     private _embedMediaBetweenPositions;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [AutoMediaEmbed.pluginName]: AutoMediaEmbed;
-    }
-}

package/src/index.d.ts

@@ -10,3 +10,6 @@ export { default as MediaEmbedEditing } from './mediaembedediting';
 export { default as MediaEmbedUI } from './mediaembedui';
 export { default as AutoMediaEmbed } from './automediaembed';
 export { default as MediaEmbedToolbar } from './mediaembedtoolbar';
+export type { MediaEmbedConfig } from './mediaembedconfig';
+export type { default as MediaEmbedCommand } from './mediaembedcommand';
+import './augmentation';

package/src/index.js

@@ -10,3 +10,4 @@ export { default as MediaEmbedEditing } from './mediaembedediting';
 export { default as MediaEmbedUI } from './mediaembedui';
 export { default as AutoMediaEmbed } from './automediaembed';
 export { default as MediaEmbedToolbar } from './mediaembedtoolbar';
+import './augmentation';

package/src/mediaembed.d.ts

@@ -28,8 +28,3 @@ export default class MediaEmbed extends Plugin {
      */
     static get pluginName(): 'MediaEmbed';
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [MediaEmbed.pluginName]: MediaEmbed;
-    }
-}

package/src/mediaembedcommand.d.ts

@@ -34,8 +34,3 @@ export default class MediaEmbedCommand extends Command {
      */
     execute(url: string): void;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface CommandsMap {
-        mediaEmbed: MediaEmbedCommand;
-    }
-}

package/src/mediaembedconfig.d.ts

@@ -42,14 +42,14 @@ export interface MediaEmbedConfig {
      * * "flickr",
      * * "facebook"
      *
-     * See the {@link module:media-embed/mediaembed~MediaEmbedProvider provider syntax} to learn more about
+     * See the {@link module:media-embed/mediaembedconfig~MediaEmbedProvider provider syntax} to learn more about
      * different kinds of media and media providers.
      *
      * **Note**: The default media provider configuration may not support all possible media URLs,
      * only the most common are included.
      *
      * Media without rendering functions are always represented in the data using the "semantic" markup. See
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#previewsInData `config.mediaEmbed.previewsInData`} to
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#previewsInData `config.mediaEmbed.previewsInData`} to
      * learn more about possible data outputs.
      *
      * The priority of media providers corresponds to the order of configuration. The first provider
@@ -57,7 +57,7 @@ export interface MediaEmbedConfig {
      * The URL is never matched against the remaining providers.
      *
      * To discard **all** default media providers, simply override this configuration with your own
-     * {@link module:media-embed/mediaembed~MediaEmbedProvider definitions}:
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedProvider definitions}:
      *
      * ```ts
      * ClassicEditor
@@ -82,15 +82,15 @@ export interface MediaEmbedConfig {
      * https://github.com/ckeditor/ckeditor5-media-embed/blob/master/src/mediaembedediting.js
      *
      * To **extend** the list of default providers, use
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#extraProviders `config.mediaEmbed.extraProviders`}.
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#extraProviders `config.mediaEmbed.extraProviders`}.
      *
      * To **remove** certain providers, use
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#removeProviders `config.mediaEmbed.removeProviders`}.
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#removeProviders `config.mediaEmbed.removeProviders`}.
      */
     providers?: Array<MediaEmbedProvider>;
     /**
      * The additional media providers supported by the editor. This configuration helps extend the default
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#providers}.
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#providers}.
      *
      * ```ts
      * ClassicEditor
@@ -111,13 +111,13 @@ export interface MediaEmbedConfig {
      * 	.catch( ... );
      * ```
      *
-     * See the {@link module:media-embed/mediaembed~MediaEmbedProvider provider syntax} to learn more.
+     * See the {@link module:media-embed/mediaembedconfig~MediaEmbedProvider provider syntax} to learn more.
      */
     extraProviders?: Array<MediaEmbedProvider>;
     /**
      * The list of media providers that should not be used despite being available in
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#providers `config.mediaEmbed.providers`} and
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#extraProviders `config.mediaEmbed.extraProviders`}
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#providers `config.mediaEmbed.providers`} and
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#extraProviders `config.mediaEmbed.extraProviders`}
      *
      * ```ts
      * mediaEmbed: {
@@ -129,8 +129,8 @@ export interface MediaEmbedConfig {
     /**
      * Overrides the element name used for "semantic" data.
      *
-     * This is not relevant if {@link module:media-embed/mediaembed~MediaEmbedConfig#previewsInData `config.mediaEmbed.previewsInData`}
-     * is set to `true`.
+     * This is not relevant if
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#previewsInData `config.mediaEmbed.previewsInData`} is set to `true`.
      *
      * When not set, the feature produces the `<oembed>` tag:
      *
@@ -184,7 +184,7 @@ export interface MediaEmbedConfig {
      *
      * **Note:** Media without preview are always represented in the data using the "semantic" markup
      * regardless of the value of the `previewsInData`. Learn more about different kinds of media
-     * in the {@link module:media-embed/mediaembed~MediaEmbedConfig#providers `config.mediaEmbed.providers`}
+     * in the {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#providers `config.mediaEmbed.providers`}
      * configuration description.
      *
      * @defualt false
@@ -200,10 +200,10 @@ export interface MediaEmbedConfig {
 }
 /**
  * The media embed provider descriptor. Used in
- * {@link module:media-embed/mediaembed~MediaEmbedConfig#providers `config.mediaEmbed.providers`} and
- * {@link module:media-embed/mediaembed~MediaEmbedConfig#extraProviders `config.mediaEmbed.extraProviders`}.
+ * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#providers `config.mediaEmbed.providers`} and
+ * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#extraProviders `config.mediaEmbed.extraProviders`}.
  *
- * See {@link module:media-embed/mediaembed~MediaEmbedConfig} to learn more.
+ * See {@link module:media-embed/mediaembedconfig~MediaEmbedConfig} to learn more.
  *
  * ```ts
  * {
@@ -253,7 +253,7 @@ export interface MediaEmbedConfig {
 export interface MediaEmbedProvider {
     /**
      * The name of the provider. Used e.g. when
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#removeProviders removing providers}.
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#removeProviders removing providers}.
      */
     name: string;
     /**
@@ -271,18 +271,8 @@ export interface MediaEmbedProvider {
      * preview of the media identified by a certain ID or a hash. When not defined, the media embed feature
      * will use a generic media representation in the view and output data.
      * Note that when
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig#previewsInData `config.mediaEmbed.previewsInData`}
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#previewsInData `config.mediaEmbed.previewsInData`}
      * is `true`, the rendering function **will always** be used for the media in the editor data output.
      */
     html?: (match: RegExpMatchArray) => string;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:media-embed/mediaembed~MediaEmbed} feature.
-         *
-         * Read more in {@link module:media-embed/mediaembed~MediaEmbedConfig}.
-         */
-        mediaEmbed?: MediaEmbedConfig;
-    }
-}

package/src/mediaembedediting.d.ts

@@ -29,8 +29,3 @@ export default class MediaEmbedEditing extends Plugin {
      */
     init(): void;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [MediaEmbedEditing.pluginName]: MediaEmbedEditing;
-    }
-}

package/src/mediaembedtoolbar.d.ts

@@ -11,7 +11,7 @@ import './mediaembedconfig';
  * The media embed toolbar plugin. It creates a toolbar for media embed that shows up when the media element is selected.
  *
  * Instances of toolbar components (e.g. buttons) are created based on the
- * {@link module:media-embed/mediaembed~MediaEmbedConfig#toolbar `media.toolbar` configuration option}.
+ * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#toolbar `media.toolbar` configuration option}.
  */
 export default class MediaEmbedToolbar extends Plugin {
     /**
@@ -27,8 +27,3 @@ export default class MediaEmbedToolbar extends Plugin {
      */
     afterInit(): void;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [MediaEmbedToolbar.pluginName]: MediaEmbedToolbar;
-    }
-}

package/src/mediaembedtoolbar.js

@@ -13,7 +13,7 @@ import './mediaembedconfig';
  * The media embed toolbar plugin. It creates a toolbar for media embed that shows up when the media element is selected.
  *
  * Instances of toolbar components (e.g. buttons) are created based on the
- * {@link module:media-embed/mediaembed~MediaEmbedConfig#toolbar `media.toolbar` configuration option}.
+ * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#toolbar `media.toolbar` configuration option}.
  */
 export default class MediaEmbedToolbar extends Plugin {
     /**

package/src/mediaembedui.d.ts

@@ -24,8 +24,3 @@ export default class MediaEmbedUI extends Plugin {
     init(): void;
     private _setUpDropdown;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [MediaEmbedUI.pluginName]: MediaEmbedUI;
-    }
-}

package/src/mediaregistry.d.ts

@@ -23,7 +23,7 @@ export default class MediaRegistry {
     locale: Locale;
     /**
      * The media provider definitions available for the registry. Usually corresponding with the
-     * {@link module:media-embed/mediaembed~MediaEmbedConfig media configuration}.
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig media configuration}.
      */
     providerDefinitions: Array<MediaEmbedProvider>;
     /**