@ckeditor/ckeditor5-bookmark 0.0.1 → 44.0.0-alpha.0

package/lang/translations/uk.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: uk\n"
+"Plural-Forms: nplurals=3; plural=(n % 10 == 1 && n % 100 != 11 ? 0 : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20) ? 1 : 2);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/ur.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: ur\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/uz.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: uz\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/vi.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: vi\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/zh-cn.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: zh_CN\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/lang/translations/zh.po

@@ -0,0 +1,56 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
+#
+# Check out the official contributor's guide:
+# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language: zh_TW\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "The label of the bookmark toolbar button. Also, a bookmark form header."
+msgid "Bookmark"
+msgstr ""
+
+msgctxt "The button in the bookmark insert form."
+msgid "Insert"
+msgstr ""
+
+msgctxt "The button in the bookmark update form."
+msgid "Update"
+msgstr ""
+
+msgctxt "Button opening the Bookmark editing balloon."
+msgid "Edit bookmark"
+msgstr ""
+
+msgctxt "Toolbar button tooltip for bookmark remove button."
+msgid "Remove bookmark"
+msgstr ""
+
+msgctxt "The label of the input in the bookmark insert and update form. Also, the tooltip for the bookmark name in the bookmark preview."
+msgid "Bookmark name"
+msgstr ""
+
+msgctxt "The description of bookmark input in the bookmark insert form."
+msgid "Enter the bookmark name without spaces."
+msgstr ""
+
+msgctxt "The error message. Displayed when the bookmark name is empty."
+msgid "Bookmark must not be empty."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name includes spaces."
+msgid "Bookmark name cannot contain space characters."
+msgstr ""
+
+msgctxt "The error message. Displayed when provided name already exists."
+msgid "Bookmark name already exists."
+msgstr ""
+
+msgctxt "The label for the bookmark widget."
+msgid "bookmark widget"
+msgstr ""

package/package.json

@@ -1,14 +1,43 @@
 {
   "name": "@ckeditor/ckeditor5-bookmark",
-  "version": "0.0.1",
+  "version": "44.0.0-alpha.0",
+  "description": "Bookmark feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
     "ckeditor5",
     "ckeditor 5",
-    "ckeditor5-lib"
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
   ],
+  "type": "module",
+  "main": "src/index.js",
+  "dependencies": {
+    "ckeditor5": "44.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "44.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "44.0.0-alpha.0",
+    "@ckeditor/ckeditor5-widget": "44.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "44.0.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "44.0.0-alpha.0"
+  },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
   "homepage": "https://ckeditor.com/ckeditor-5",
-  "bugs": "https://github.com/ckeditor/ckeditor5/issues"
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-bookmark"
+  },
+  "files": [
+    "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "types": "src/index.d.ts"
 }

package/src/augmentation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Bookmark, BookmarkEditing, BookmarkUI, InsertBookmarkCommand, UpdateBookmarkCommand, BookmarkConfig } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:bookmark/bookmark~Bookmark} feature.
+         *
+         * Read more in {@link module:bookmark/bookmarkconfig~BookmarkConfig}.
+         */
+        bookmark?: BookmarkConfig;
+    }
+    interface PluginsMap {
+        [Bookmark.pluginName]: Bookmark;
+        [BookmarkEditing.pluginName]: BookmarkEditing;
+        [BookmarkUI.pluginName]: BookmarkUI;
+    }
+    interface CommandsMap {
+        insertBookmark: InsertBookmarkCommand;
+        updateBookmark: UpdateBookmarkCommand;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2024, 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/bookmark.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module bookmark/bookmark
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Widget } from 'ckeditor5/src/widget.js';
+import BookmarkUI from './bookmarkui.js';
+import BookmarkEditing from './bookmarkediting.js';
+/**
+ * The bookmark feature.
+ *
+ * For a detailed overview, check the {@glink features/bookmarks Bookmarks} feature guide.
+ */
+export default class Bookmark extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Bookmark";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof BookmarkEditing, typeof BookmarkUI, typeof Widget];
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/bookmark.js

@@ -0,0 +1,36 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module bookmark/bookmark
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Widget } from 'ckeditor5/src/widget.js';
+import BookmarkUI from './bookmarkui.js';
+import BookmarkEditing from './bookmarkediting.js';
+/**
+ * The bookmark feature.
+ *
+ * For a detailed overview, check the {@glink features/bookmarks Bookmarks} feature guide.
+ */
+export default class Bookmark extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Bookmark';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [BookmarkEditing, BookmarkUI, Widget];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/bookmarkconfig.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module bookmark/bookmarkconfig
+ */
+/**
+ * The configuration of the bookmark feature.
+ *
+ * The properties defined in this config are set in the `config.bookmark` namespace.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		bookmark: {
+ * 			// Bookmark configuration.
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface BookmarkConfig {
+    /**
+     * Allows to convert into bookmarks non-empty anchor elements.
+     *
+     * With this option enabled you will have all non-empty anchors converted into bookmakrs.
+     * For example:
+     *
+     *```html
+     * <a id="bookmark">Bookmark</a>
+     *```
+     *
+     * will be converted into:
+     *
+     *```html
+     * <a id="bookmark"></a>Bookmark
+     *```
+     *
+     * **Note:** This is enabled by default.
+     *
+     * @default true
+     */
+    enableNonEmptyAnchorConversion?: boolean;
+}

package/src/bookmarkconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2024, 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/bookmarkediting.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module bookmark/bookmarkediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import type { Element } from 'ckeditor5/src/engine.js';
+import '../theme/bookmark.css';
+/**
+ * The bookmark editing plugin.
+ */
+export default class BookmarkEditing extends Plugin {
+    /**
+     * A collection of bookmarks elements in the document.
+     */
+    private _bookmarkElements;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "BookmarkEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Returns the model element for the given bookmark ID if it exists.
+     */
+    getElementForBookmarkId(bookmarkId: string): Element | null;
+    /**
+     * Defines the schema for the bookmark feature.
+     */
+    private _defineSchema;
+    /**
+     * Defines the converters for the bookmark feature.
+     */
+    private _defineConverters;
+    /**
+     * Creates a UI element for the `bookmark` representation in editing view.
+     */
+    private _createBookmarkUIElement;
+    /**
+     * Tracking the added or removed bookmark elements.
+     */
+    private _trackBookmarkElements;
+}