@ckeditor/ckeditor5-link 0.0.0-nightly-20240422.0 → 0.0.0-nightly-20240424.0

package/dist/types/utils/manualdecorator.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @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
+ */
+/**
+ * @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 link/utils/manualdecorator
+ */
+import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
+import type { MatcherObjectPattern } from 'ckeditor5/src/engine.js';
+import type { NormalizedLinkDecoratorManualDefinition } from '../utils.js';
+declare const ManualDecorator_base: {
+    new (): import("ckeditor5/src/utils.js").Observable;
+    prototype: import("ckeditor5/src/utils.js").Observable;
+};
+/**
+ * Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~ManualDecorator#value}
+ * to support integration with the UI state. An instance of this class is a model with the state of individual manual decorators.
+ * These decorators are kept as collections in {@link module:link/linkcommand~LinkCommand#manualDecorators}.
+ */
+export default class ManualDecorator extends ManualDecorator_base {
+    /**
+     * An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
+     */
+    id: string;
+    /**
+     * The value of the current manual decorator. It reflects its state from the UI.
+     *
+     * @observable
+     */
+    value: boolean | undefined;
+    /**
+     * The default value of manual decorator.
+     */
+    defaultValue?: boolean;
+    /**
+     * The label used in the user interface to toggle the manual decorator.
+     */
+    label: string;
+    /**
+     * A set of attributes added to downcasted data when the decorator is activated for a specific link.
+     * Attributes should be added in a form of attributes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+     */
+    attributes?: Record<string, string>;
+    /**
+     * A set of classes added to downcasted data when the decorator is activated for a specific link.
+     * Classes should be added in a form of classes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+     */
+    classes?: ArrayOrItem<string>;
+    /**
+     * A set of styles added to downcasted data when the decorator is activated for a specific link.
+     * Styles should be added in a form of styles defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+     */
+    styles?: Record<string, string>;
+    /**
+     * Creates a new instance of {@link module:link/utils/manualdecorator~ManualDecorator}.
+     *
+     * @param config.id The name of the attribute used in the model that represents a given manual decorator.
+     * For example: `'linkIsExternal'`.
+     * @param config.label The label used in the user interface to toggle the manual decorator.
+     * @param config.attributes A set of attributes added to output data when the decorator is active for a specific link.
+     * Attributes should keep the format of attributes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+     * @param [config.defaultValue] Controls whether the decorator is "on" by default.
+     */
+    constructor({ id, label, attributes, classes, styles, defaultValue }: NormalizedLinkDecoratorManualDefinition);
+    /**
+     * Returns {@link module:engine/view/matcher~MatcherPattern} with decorator attributes.
+     *
+     * @internal
+     */
+    _createPattern(): MatcherObjectPattern;
+}
+export {};

package/dist/types/utils.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @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
+ */
+/**
+ * @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 link/utils
+ */
+import type { DowncastConversionApi, Element, Schema, ViewAttributeElement, ViewNode, ViewDocumentFragment } from 'ckeditor5/src/engine.js';
+import type { LocaleTranslate } from 'ckeditor5/src/utils.js';
+import type { LinkDecoratorAutomaticDefinition, LinkDecoratorDefinition, LinkDecoratorManualDefinition } from './linkconfig.js';
+/**
+ * A keystroke used by the {@link module:link/linkui~LinkUI link UI feature}.
+ */
+export declare const LINK_KEYSTROKE = "Ctrl+K";
+/**
+ * Returns `true` if a given view node is the link element.
+ */
+export declare function isLinkElement(node: ViewNode | ViewDocumentFragment): boolean;
+/**
+ * Creates a link {@link module:engine/view/attributeelement~AttributeElement} with the provided `href` attribute.
+ */
+export declare function createLinkElement(href: string, { writer }: DowncastConversionApi): ViewAttributeElement;
+/**
+ * Returns a safe URL based on a given value.
+ *
+ * A URL is considered safe if it is safe for the user (does not contain any malicious code).
+ *
+ * If a URL is considered unsafe, a simple `"#"` is returned.
+ *
+ * @internal
+ */
+export declare function ensureSafeUrl(url: unknown, allowedProtocols?: Array<string>): string;
+/**
+ * Returns the {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`} configuration processed
+ * to respect the locale of the editor, i.e. to display the {@link module:link/linkconfig~LinkDecoratorManualDefinition label}
+ * in the correct language.
+ *
+ * **Note**: Only the few most commonly used labels are translated automatically. Other labels should be manually
+ * translated in the {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`} configuration.
+ *
+ * @param t Shorthand for {@link module:utils/locale~Locale#t Locale#t}.
+ * @param decorators The decorator reference where the label values should be localized.
+ */
+export declare function getLocalizedDecorators(t: LocaleTranslate, decorators: Array<NormalizedLinkDecoratorDefinition>): Array<NormalizedLinkDecoratorDefinition>;
+/**
+ * Converts an object with defined decorators to a normalized array of decorators. The `id` key is added for each decorator and
+ * is used as the attribute's name in the model.
+ */
+export declare function normalizeDecorators(decorators?: Record<string, LinkDecoratorDefinition>): Array<NormalizedLinkDecoratorDefinition>;
+/**
+ * Returns `true` if the specified `element` can be linked (the element allows the `linkHref` attribute).
+ */
+export declare function isLinkableElement(element: Element | null, schema: Schema): element is Element;
+/**
+ * Returns `true` if the specified `value` is an email.
+ */
+export declare function isEmail(value: string): boolean;
+/**
+ * Adds the protocol prefix to the specified `link` when:
+ *
+ * * it does not contain it already, and there is a {@link module:link/linkconfig~LinkConfig#defaultProtocol `defaultProtocol` }
+ * configuration value provided,
+ * * or the link is an email address.
+ */
+export declare function addLinkProtocolIfApplicable(link: string, defaultProtocol?: string): string;
+/**
+ * Checks if protocol is already included in the link.
+ */
+export declare function linkHasProtocol(link: string): boolean;
+/**
+ * Opens the link in a new browser tab.
+ */
+export declare function openLink(link: string): void;
+export type NormalizedLinkDecoratorAutomaticDefinition = LinkDecoratorAutomaticDefinition & {
+    id: string;
+};
+export type NormalizedLinkDecoratorManualDefinition = LinkDecoratorManualDefinition & {
+    id: string;
+};
+export type NormalizedLinkDecoratorDefinition = NormalizedLinkDecoratorAutomaticDefinition | NormalizedLinkDecoratorManualDefinition;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-link",
-  "version": "0.0.0-nightly-20240422.0",
+  "version": "0.0.0-nightly-20240424.0",
   "description": "Link feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,8 +13,8 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20240422.0",
-    "ckeditor5": "0.0.0-nightly-20240422.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20240424.0",
+    "ckeditor5": "0.0.0-nightly-20240424.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",
@@ -27,6 +27,7 @@
     "directory": "packages/ckeditor5-link"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/src/index.d.ts

@@ -12,7 +12,7 @@ export { default as LinkImage } from './linkimage.js';
 export { default as LinkImageEditing } from './linkimageediting.js';
 export { default as LinkImageUI } from './linkimageui.js';
 export { default as AutoLink } from './autolink.js';
-export { LinkConfig, type LinkDecoratorDefinition } from './linkconfig.js';
+export type { LinkConfig, LinkDecoratorDefinition } from './linkconfig.js';
 export { default as LinkCommand } from './linkcommand.js';
 export { default as UnlinkCommand } from './unlinkcommand.js';
 import './augmentation.js';