@ckeditor/ckeditor5-engine 44.1.0 → 44.2.0-alpha.0

package/dist/index.d.ts

@@ -1,122 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module engine
- */
-export * from './view/placeholder.js';
-export { default as EditingController } from './controller/editingcontroller.js';
-export { default as DataController, type DataControllerInitEvent, type DataControllerSetEvent, type DataControllerToModelEvent, type DataControllerToViewEvent } from './controller/datacontroller.js';
-export { default as Conversion } from './conversion/conversion.js';
-export type { default as DowncastDispatcher, DowncastAddMarkerEvent, DowncastAttributeEvent, DowncastConversionApi, DowncastInsertEvent, DowncastRemoveEvent, DowncastRemoveMarkerEvent, DowncastSelectionEvent } from './conversion/downcastdispatcher.js';
-export type { default as UpcastDispatcher, UpcastConversionApi, UpcastConversionData, UpcastElementEvent, UpcastTextEvent } from './conversion/upcastdispatcher.js';
-export type { AddHighlightCallback, AttributeDescriptor, ElementCreatorFunction, HighlightDescriptor, RemoveHighlightCallback, MarkerElementCreatorFunction, SlotFilter } from './conversion/downcasthelpers.js';
-export type { default as Mapper, MapperModelToViewPositionEvent, MapperViewToModelPositionEvent } from './conversion/mapper.js';
-export type { default as ModelConsumable } from './conversion/modelconsumable.js';
-export type { Consumables, default as ViewConsumable } from './conversion/viewconsumable.js';
-export type { default as DataProcessor } from './dataprocessor/dataprocessor.js';
-export { default as HtmlDataProcessor } from './dataprocessor/htmldataprocessor.js';
-export { default as XmlDataProcessor } from './dataprocessor/xmldataprocessor.js';
-export type { default as Operation } from './model/operation/operation.js';
-export { default as InsertOperation } from './model/operation/insertoperation.js';
-export { default as MoveOperation } from './model/operation/moveoperation.js';
-export { default as MergeOperation } from './model/operation/mergeoperation.js';
-export { default as SplitOperation } from './model/operation/splitoperation.js';
-export { default as MarkerOperation } from './model/operation/markeroperation.js';
-export { default as OperationFactory } from './model/operation/operationfactory.js';
-export { default as AttributeOperation } from './model/operation/attributeoperation.js';
-export { default as RenameOperation } from './model/operation/renameoperation.js';
-export { default as RootAttributeOperation } from './model/operation/rootattributeoperation.js';
-export { default as RootOperation } from './model/operation/rootoperation.js';
-export { default as NoOperation } from './model/operation/nooperation.js';
-export { transformSets } from './model/operation/transform.js';
-export { default as DocumentSelection, type DocumentSelectionChangeRangeEvent, type DocumentSelectionChangeMarkerEvent, type DocumentSelectionChangeAttributeEvent } from './model/documentselection.js';
-export { default as Range } from './model/range.js';
-export { default as LiveRange, type LiveRangeChangeRangeEvent } from './model/liverange.js';
-export { default as LivePosition } from './model/liveposition.js';
-export { default as Model } from './model/model.js';
-export { default as TreeWalker, type TreeWalkerValue } from './model/treewalker.js';
-export { default as Element } from './model/element.js';
-export { default as Position, type PositionOffset } from './model/position.js';
-export { default as DocumentFragment } from './model/documentfragment.js';
-export { default as History } from './model/history.js';
-export { default as Text } from './model/text.js';
-export { default as TextProxy } from './model/textproxy.js';
-export type { default as Document, ModelPostFixer } from './model/document.js';
-export type { Marker } from './model/markercollection.js';
-export type { default as Batch } from './model/batch.js';
-export type { default as Differ, DiffItem, DiffItemAttribute, DiffItemInsert, DiffItemRemove } from './model/differ.js';
-export type { default as Item } from './model/item.js';
-export type { default as Node, NodeAttributes } from './model/node.js';
-export type { default as RootElement } from './model/rootelement.js';
-export type { default as Schema, SchemaAttributeCheckCallback, SchemaChildCheckCallback, AttributeProperties, SchemaItemDefinition, SchemaContext, SchemaContextDefinition } from './model/schema.js';
-export type { default as Selection, Selectable } from './model/selection.js';
-export type { default as TypeCheckable } from './model/typecheckable.js';
-export type { default as Writer } from './model/writer.js';
-export * from './model/utils/autoparagraphing.js';
-export type { DocumentChangeEvent } from './model/document.js';
-export type { DocumentSelectionChangeEvent } from './model/documentselection.js';
-export type { ModelApplyOperationEvent, ModelDeleteContentEvent, ModelGetSelectedContentEvent, ModelInsertContentEvent, ModelInsertObjectEvent, ModelModifySelectionEvent, ModelCanEditAtEvent } from './model/model.js';
-export type { SelectionChangeRangeEvent } from './model/selection.js';
-export { default as DataTransfer } from './view/datatransfer.js';
-export { default as DomConverter } from './view/domconverter.js';
-export { default as Renderer } from './view/renderer.js';
-export { default as EditingView } from './view/view.js';
-export { default as ViewDocument } from './view/document.js';
-export { default as ViewText } from './view/text.js';
-export { default as ViewElement, type ElementAttributes as ViewElementAttributes } from './view/element.js';
-export { default as ViewContainerElement } from './view/containerelement.js';
-export { default as ViewEditableElement } from './view/editableelement.js';
-export { default as ViewRootEditableElement } from './view/rooteditableelement.js';
-export { default as ViewAttributeElement } from './view/attributeelement.js';
-export { default as ViewEmptyElement } from './view/emptyelement.js';
-export { default as ViewRawElement } from './view/rawelement.js';
-export { default as ViewUIElement } from './view/uielement.js';
-export { default as ViewDocumentFragment } from './view/documentfragment.js';
-export { default as ViewTreeWalker, type TreeWalkerValue as ViewTreeWalkerValue } from './view/treewalker.js';
-export type { default as ViewElementDefinition, ElementObjectDefinition } from './view/elementdefinition.js';
-export type { default as ViewDocumentSelection } from './view/documentselection.js';
-export { default as AttributeElement } from './view/attributeelement.js';
-export type { default as ViewItem } from './view/item.js';
-export type { default as ViewNode } from './view/node.js';
-export type { default as ViewPosition, PositionOffset as ViewPositionOffset } from './view/position.js';
-export type { default as ViewRange } from './view/range.js';
-export type { default as ViewSelection, ViewSelectionChangeEvent, Selectable as ViewSelectable } from './view/selection.js';
-export type { default as ViewTypeCheckable } from './view/typecheckable.js';
-export { getFillerOffset } from './view/containerelement.js';
-export { default as Observer } from './view/observer/observer.js';
-export { default as ClickObserver } from './view/observer/clickobserver.js';
-export { default as DomEventObserver } from './view/observer/domeventobserver.js';
-export { default as MouseObserver } from './view/observer/mouseobserver.js';
-export { default as TabObserver } from './view/observer/tabobserver.js';
-export { default as FocusObserver, type ViewDocumentBlurEvent, type ViewDocumentFocusEvent } from './view/observer/focusobserver.js';
-export { default as DowncastWriter } from './view/downcastwriter.js';
-export { default as UpcastWriter } from './view/upcastwriter.js';
-export { default as Matcher, type MatcherPattern, type MatcherObjectPattern, type Match, type MatchResult } from './view/matcher.js';
-export { default as BubblingEventInfo } from './view/observer/bubblingeventinfo.js';
-export { default as DomEventData } from './view/observer/domeventdata.js';
-export type { BubblingEvent } from './view/observer/bubblingemittermixin.js';
-export type { ViewDocumentArrowKeyEvent } from './view/observer/arrowkeysobserver.js';
-export type { ViewDocumentCompositionStartEvent, ViewDocumentCompositionUpdateEvent, ViewDocumentCompositionEndEvent } from './view/observer/compositionobserver.js';
-export type { ViewDocumentInputEvent } from './view/observer/inputobserver.js';
-export type { ViewDocumentMutationsEvent, MutationData } from './view/observer/mutationobserver.js';
-export type { ViewDocumentKeyDownEvent, ViewDocumentKeyUpEvent, KeyEventData } from './view/observer/keyobserver.js';
-export type { ViewDocumentLayoutChangedEvent } from './view/document.js';
-export type { ViewDocumentMouseDownEvent, ViewDocumentMouseUpEvent, ViewDocumentMouseOverEvent, ViewDocumentMouseOutEvent } from './view/observer/mouseobserver.js';
-export type { ViewDocumentTabEvent } from './view/observer/tabobserver.js';
-export type { ViewDocumentClickEvent } from './view/observer/clickobserver.js';
-export type { ViewDocumentSelectionChangeEvent } from './view/observer/selectionobserver.js';
-export type { ViewRenderEvent, ViewScrollToTheSelectionEvent } from './view/view.js';
-export { default as StylesMap, StylesProcessor, type BoxSides } from './view/stylesmap.js';
-export * from './view/styles/background.js';
-export * from './view/styles/border.js';
-export * from './view/styles/margin.js';
-export * from './view/styles/padding.js';
-export * from './view/styles/utils.js';
-export { getData as _getModelData, setData as _setModelData, parse as _parseModel, stringify as _stringifyModel } from './dev-utils/model.js';
-export { getData as _getViewData, setData as _setViewData, parse as _parseView, stringify as _stringifyView } from './dev-utils/view.js';

package/dist/model/batch.d.ts

@@ -1,110 +0,0 @@
-/**
- * @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-licensing-options
- */
-import type Operation from './operation/operation.js';
-/**
- * A batch instance groups model changes ({@link module:engine/model/operation/operation~Operation operations}). All operations
- * grouped in a single batch can be reverted together, so you can also think about a batch as of a single undo step. If you want
- * to extend a given undo step, you can add more changes to the batch using {@link module:engine/model/model~Model#enqueueChange}:
- *
- * ```ts
- * model.enqueueChange( batch, writer => {
- * 	writer.insertText( 'foo', paragraph, 'end' );
- * } );
- * ```
- *
- * @see module:engine/model/model~Model#enqueueChange
- * @see module:engine/model/model~Model#change
- */
-export default class Batch implements BatchType {
-    /**
-     * An array of operations that compose this batch.
-     */
-    readonly operations: Array<Operation>;
-    /**
-     * Whether the batch can be undone through the undo feature.
-     */
-    readonly isUndoable: boolean;
-    /**
-     * Whether the batch includes operations created locally (`true`) or operations created on other, remote editors (`false`).
-     */
-    readonly isLocal: boolean;
-    /**
-     * Whether the batch was created by the undo feature and undoes other operations.
-     */
-    readonly isUndo: boolean;
-    /**
-     * Whether the batch includes operations connected with typing.
-     */
-    readonly isTyping: boolean;
-    /**
-     * Creates a batch instance.
-     *
-     * @see module:engine/model/model~Model#enqueueChange
-     * @see module:engine/model/model~Model#change
-     * @param type A set of flags that specify the type of the batch. Batch type can alter how some of the features work
-     * when encountering a given `Batch` instance (for example, when a feature listens to applied operations).
-     */
-    constructor(type?: BatchType);
-    /**
-     * The type of the batch.
-     *
-     * **This property has been deprecated and is always set to the `'default'` value.**
-     *
-     * It can be one of the following values:
-     * * `'default'` &ndash; All "normal" batches. This is the most commonly used type.
-     * * `'transparent'` &ndash; A batch that should be ignored by other features, i.e. an initial batch or collaborative editing
-     * changes.
-     *
-     * @deprecated
-     */
-    get type(): 'default';
-    /**
-     * Returns the base version of this batch, which is equal to the base version of the first operation in the batch.
-     * If there are no operations in the batch or neither operation has the base version set, it returns `null`.
-     */
-    get baseVersion(): number | null;
-    /**
-     * Adds an operation to the batch instance.
-     *
-     * @param operation An operation to add.
-     * @returns The added operation.
-     */
-    addOperation(operation: Operation): Operation;
-}
-/**
- * A set of flags that specify the type of the batch. Batch type can alter how some of the features work
- * when encountering a given `Batch` instance (for example, when a feature listens to applied operations).
- */
-export interface BatchType {
-    /**
-     * Whether a batch can be undone through undo feature.
-     *
-     * @default true
-     */
-    isUndoable?: boolean;
-    /**
-     * Whether a batch includes operations created locally (`true`) or operations created on
-     * other, remote editors (`false`).
-     *
-     * @default true
-     */
-    isLocal?: boolean;
-    /**
-     * Whether a batch was created by the undo feature and undoes other operations.
-     *
-     * @default false
-     */
-    isUndo?: boolean;
-    /**
-     * Whether a batch includes operations connected with a typing action.
-     *
-     * @default false
-     */
-    isTyping?: boolean;
-}