@ckeditor/ckeditor5-widget 37.0.0-alpha.0 → 37.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-widget",
-  "version": "37.0.0-alpha.0",
+  "version": "37.0.0-alpha.1",
   "description": "Widget API for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,29 +11,29 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.1",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-editor-balloon": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-horizontal-line": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-media-embed": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-editor-balloon": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-horizontal-line": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-media-embed": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.1",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -60,7 +60,7 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "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,13 @@
+/**
+ * @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 { Widget, WidgetResize, WidgetToolbarRepository, WidgetTypeAround } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Widget.pluginName]: Widget;
+        [WidgetResize.pluginName]: WidgetResize;
+        [WidgetToolbarRepository.pluginName]: WidgetToolbarRepository;
+        [WidgetTypeAround.pluginName]: WidgetTypeAround;
+    }
+}

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/highlightstack.d.ts

@@ -48,7 +48,7 @@ export default class HighlightStack extends HighlightStack_base {
 /**
  * Fired when top element on {@link module:widget/highlightstack~HighlightStack} has been changed
  *
- * @eventName change:top
+ * @eventName ~HighlightStack#change:top
  */
 export type HighlightStackChangeEvent = {
     name: 'change' | 'change:top';

package/src/index.d.ts

@@ -2,8 +2,12 @@
  * @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
  */
+/**
+ * @module widget
+ */
 export { default as Widget } from './widget';
 export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
 export { default as WidgetResize } from './widgetresize';
 export { default as WidgetTypeAround } from './widgettypearound/widgettypearound';
 export * from './utils';
+import './augmentation';

package/src/index.js

@@ -2,8 +2,12 @@
  * @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
  */
+/**
+ * @module widget
+ */
 export { default as Widget } from './widget';
 export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
 export { default as WidgetResize } from './widgetresize';
 export { default as WidgetTypeAround } from './widgettypearound/widgettypearound';
 export * from './utils';
+import './augmentation';

package/src/verticalnavigation.d.ts

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module widget/verticalnavigationhandler
+ * @module widget/verticalnavigation
  */
 import { type GetCallback } from '@ckeditor/ckeditor5-utils';
 import type { EditingController, ViewDocumentArrowKeyEvent } from '@ckeditor/ckeditor5-engine';

package/src/verticalnavigation.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module widget/verticalnavigationhandler
+ * @module widget/verticalnavigation
  */
 import { keyCodes, Rect } from '@ckeditor/ckeditor5-utils';
 /**

package/src/widget.d.ts

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

package/src/widgetresize/resizer.d.ts

@@ -159,19 +159,19 @@ export default class Resizer extends Resizer_base {
     private _appendSizeUI;
 }
 /**
- * @eventName begin
+ * @eventName ~Resizer#begin
  */
 export type ResizerBeginEvent = DecoratedMethodEvent<Resizer, 'begin'>;
 /**
- * @eventName cancel
+ * @eventName ~Resizer#cancel
  */
 export type ResizerCancelEvent = DecoratedMethodEvent<Resizer, 'cancel'>;
 /**
- * @eventName commit
+ * @eventName ~Resizer#commit
  */
 export type ResizerCommitEvent = DecoratedMethodEvent<Resizer, 'commit'>;
 /**
- * @eventName updateSize
+ * @eventName ~Resizer#updateSize
  */
 export type ResizerUpdateSizeEvent = DecoratedMethodEvent<Resizer, 'updateSize'>;
 export {};

package/src/widgetresize.d.ts

@@ -123,8 +123,3 @@ export interface ResizerOptions {
     getHandleHost: (widgetWrapper: HTMLElement) => HTMLElement;
     isCentered?: (resizer: Resizer) => boolean;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [WidgetResize.pluginName]: WidgetResize;
-    }
-}

package/src/widgettoolbarrepository.d.ts

@@ -85,14 +85,9 @@ export default class WidgetToolbarRepository extends Plugin {
      * Otherwise, repositions the toolbar's balloon when toolbar's view is the most top view in balloon stack.
      *
      * It might happen here that the toolbar's view is under another view. Then do nothing as the other toolbar view
-     * should be still visible after the {@link module:core/editor/editorui~EditorUI#event:update}.
+     * should be still visible after the {@link module:ui/editorui/editorui~EditorUI#event:update}.
      */
     private _showToolbar;
     private _isToolbarVisible;
     private _isToolbarInBalloon;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [WidgetToolbarRepository.pluginName]: WidgetToolbarRepository;
-    }
-}

package/src/widgettoolbarrepository.js

@@ -105,14 +105,14 @@ export default class WidgetToolbarRepository extends Plugin {
         // Trying to register a toolbar without any item.
         if (!items.length) {
             /**
-             * When {@link #register registering} a new widget toolbar, you need to provide a non-empty array with
-             * the items that will be inserted into the toolbar.
+             * When {@link module:widget/widgettoolbarrepository~WidgetToolbarRepository#register registering} a new widget toolbar, you
+             * need to provide a non-empty array with the items that will be inserted into the toolbar.
              *
              * If you see this error when integrating the editor, you likely forgot to configure one of the widget toolbars.
              *
              * See for instance:
              *
-             * * {@link module:table/table~TableConfig#contentToolbar `config.table.contentToolbar`}
+             * * {@link module:table/tableconfig~TableConfig#contentToolbar `config.table.contentToolbar`}
              * * {@link module:image/imageconfig~ImageConfig#toolbar `config.image.toolbar`}
              *
              * @error widget-toolbar-no-items
@@ -204,7 +204,7 @@ export default class WidgetToolbarRepository extends Plugin {
      * Otherwise, repositions the toolbar's balloon when toolbar's view is the most top view in balloon stack.
      *
      * It might happen here that the toolbar's view is under another view. Then do nothing as the other toolbar view
-     * should be still visible after the {@link module:core/editor/editorui~EditorUI#event:update}.
+     * should be still visible after the {@link module:ui/editorui/editorui~EditorUI#event:update}.
      */
     _showToolbar(toolbarDefinition, relatedElement) {
         if (this._isToolbarVisible(toolbarDefinition)) {

package/src/widgettypearound/widgettypearound.d.ts

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module widget/widgettypearound
+ * @module widget/widgettypearound/widgettypearound
  */
 import { Plugin, type PluginDependencies } from '@ckeditor/ckeditor5-core';
 import '../../theme/widgettypearound.css';
@@ -51,7 +51,7 @@ export default class WidgetTypeAround extends Plugin {
      */
     private _insertParagraph;
     /**
-     * A wrapper for the {@link module:utils/emittermixin~EmitterMixin#listenTo} method that executes the callbacks only
+     * A wrapper for the {@link module:utils/emittermixin~Emitter#listenTo} method that executes the callbacks only
      * when the plugin {@link #isEnabled is enabled}.
      *
      * @param emitter The object that fires the event.
@@ -225,8 +225,3 @@ export default class WidgetTypeAround extends Plugin {
      */
     private _enableDeleteContentIntegration;
 }
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [WidgetTypeAround.pluginName]: WidgetTypeAround;
-    }
-}

package/src/widgettypearound/widgettypearound.js

@@ -4,7 +4,7 @@
  */
 /* global DOMParser */
 /**
- * @module widget/widgettypearound
+ * @module widget/widgettypearound/widgettypearound
  */
 import { Plugin } from '@ckeditor/ckeditor5-core';
 import { Template } from '@ckeditor/ckeditor5-ui';
@@ -114,7 +114,7 @@ export default class WidgetTypeAround extends Plugin {
         editingView.scrollToTheSelection();
     }
     /**
-     * A wrapper for the {@link module:utils/emittermixin~EmitterMixin#listenTo} method that executes the callbacks only
+     * A wrapper for the {@link module:utils/emittermixin~Emitter#listenTo} method that executes the callbacks only
      * when the plugin {@link #isEnabled is enabled}.
      *
      * @param emitter The object that fires the event.