ckeditor5-blazor 1.11.0 → 1.12.0

package/src/elements/ui-part.test.ts

@@ -2,7 +2,6 @@ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 import {
   createEditorPreset,
-  createUIPartSnapshot,
   renderTestEditor,
   renderTestUIPart,
   waitForDestroyAllEditors,
@@ -34,7 +33,7 @@ describe('ui-part component', () => {
       const editor = await waitForTestEditor();
       const toolbarElement = editor.ui.view.toolbar?.element;
 
-      const el = renderTestUIPart(createUIPartSnapshot('toolbar'));
+      const el = renderTestUIPart();
 
       await vi.waitFor(() => {
         expect(el.contains(toolbarElement!)).toBe(true);
@@ -49,7 +48,7 @@ describe('ui-part component', () => {
       const editor = await waitForTestEditor();
       const menubarElement = (editor.ui.view as any).menuBarView.element;
 
-      const el = renderTestUIPart(createUIPartSnapshot('menubar'));
+      const el = renderTestUIPart({ name: 'menubar' });
 
       await vi.waitFor(() => {
         expect(el.children.length).toBeGreaterThan(0);
@@ -59,7 +58,7 @@ describe('ui-part component', () => {
     });
 
     it('should mount UI part before editor is created', async () => {
-      const el = renderTestUIPart(createUIPartSnapshot('toolbar'));
+      const el = renderTestUIPart();
 
       appendMultirootEditor();
 
@@ -80,7 +79,7 @@ describe('ui-part component', () => {
       const toolbarElement = editor.ui.view.toolbar?.element;
 
       // Render UI part without editorId
-      const el = renderTestUIPart({ editorId: undefined } as any);
+      const el = renderTestUIPart({ editorId: null });
 
       await vi.waitFor(() => {
         expect(el.contains(toolbarElement!)).toBe(true);
@@ -90,7 +89,7 @@ describe('ui-part component', () => {
     });
 
     it('should not mount UI part if element is disconnected before editor is ready', async () => {
-      const el = renderTestUIPart(createUIPartSnapshot('toolbar'));
+      const el = renderTestUIPart();
       el.remove();
 
       appendMultirootEditor();
@@ -109,7 +108,7 @@ describe('ui-part component', () => {
     });
 
     it('should clear UI part element on destruction', async () => {
-      const el = renderTestUIPart(createUIPartSnapshot('toolbar'));
+      const el = renderTestUIPart();
 
       await vi.waitFor(() => {
         expect(el.children.length).toBeGreaterThan(0);
@@ -125,7 +124,7 @@ describe('ui-part component', () => {
     });
 
     it('should hide element during destruction', async () => {
-      const el = renderTestUIPart(createUIPartSnapshot('toolbar'));
+      const el = renderTestUIPart();
 
       // If we remove immediately, disconnectedCallback should hide it.
       el.remove();
@@ -138,7 +137,7 @@ describe('ui-part component', () => {
       document.body.innerHTML = '';
       await EditorsRegistry.the.reset();
 
-      const el = renderTestUIPart(createUIPartSnapshot('toolbar'));
+      const el = renderTestUIPart();
 
       el.remove();
 

package/src/interop/create-editable-blazor-interop.test.ts

@@ -28,7 +28,7 @@ describe('createEditableBlazorInterop', () => {
     dotnetInterop = createDotNetInteropMock();
     globalThis.DotNet = createDotnet();
 
-    element = renderTestEditable({}, {
+    element = renderTestEditable({
       interactive: false,
     });
 
@@ -120,7 +120,10 @@ describe('createEditableBlazorInterop', () => {
   });
 
   it('should ignore events for an unknown root name', async () => {
-    const custom = renderTestEditable({ rootName: 'other' }, { interactive: false });
+    const custom = renderTestEditable({
+      rootName: 'other',
+      interactive: false,
+    });
 
     const interop = createEditableBlazorInterop(custom, dotnetInterop);
     const editor = await waitForTestEditor();

package/dist/elements/editor/utils/assign-initial-data-to-editor-config.d.ts

@@ -1,10 +0,0 @@
-import { EditorConfig } from 'ckeditor5';
-/**
- * Assigns initial data to specified editor config.
- *
- * @param dataOrMap Initial data to be assigned to config.
- * @param config Config of the editor.
- * @returns The updated configuration object.
- */
-export declare function assignInitialDataToEditorConfig<C extends EditorConfig>(dataOrMap: string | Record<string, string>, config: C): C;
-//# sourceMappingURL=assign-initial-data-to-editor-config.d.ts.map

package/dist/elements/editor/utils/assign-initial-data-to-editor-config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assign-initial-data-to-editor-config.d.ts","sourceRoot":"","sources":["../../../../../src/elements/editor/utils/assign-initial-data-to-editor-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C;;;;;;GAMG;AACH,wBAAgB,+BAA+B,CAAC,CAAC,SAAS,YAAY,EACpE,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC1C,MAAM,EAAE,CAAC,GACR,CAAC,CA8BH"}

package/dist/elements/editor/utils/assign-source-elements-to-editor-config.d.ts

@@ -1,12 +0,0 @@
-import { EditorRelaxedConstructor } from '../types/editor-relaxed-constructor.type';
-import { EditorConfig } from 'ckeditor5';
-/**
- * Assigns a DOM element to the editor configuration in a way that is compatible with the specific editor type.
- *
- * @param Editor Constructor of the editor used to determine the location of element config entry.
- * @param elementOrMap Element to be assigned to config.
- * @param config Config of the editor.
- * @returns The updated configuration object.
- */
-export declare function assignSourceElementsToEditorConfig<C extends EditorConfig>(Editor: EditorRelaxedConstructor, elementOrMap: HTMLElement | Record<string, HTMLElement>, config: C): C;
-//# sourceMappingURL=assign-source-elements-to-editor-config.d.ts.map

package/dist/elements/editor/utils/assign-source-elements-to-editor-config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assign-source-elements-to-editor-config.d.ts","sourceRoot":"","sources":["../../../../../src/elements/editor/utils/assign-source-elements-to-editor-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACzF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C;;;;;;;GAOG;AACH,wBAAgB,kCAAkC,CAAC,CAAC,SAAS,YAAY,EACvE,MAAM,EAAE,wBAAwB,EAChC,YAAY,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACvD,MAAM,EAAE,CAAC,GACR,CAAC,CAuCH"}

package/dist/elements/editor/utils/query-editor-editables.d.ts

@@ -1,25 +0,0 @@
-import { EditorId } from '../typings';
-/**
- * Gets the initial root elements for the editor based on its type.
- *
- * @param editorId The editor's ID.
- * @returns The root element(s) for the editor.
- */
-export declare function queryEditablesElements(editorId: EditorId): Record<string, HTMLElement>;
-/**
- * Gets the initial data for the roots of the editor. If the editor is a single editing-like editor,
- * it retrieves the initial value from the element's attribute. Otherwise, it returns an object mapping
- * editable names to their initial values.
- *
- * @param editorId The editor's ID.
- * @returns The initial values for the editor's roots.
- */
-export declare function queryEditablesSnapshotContent(editorId: EditorId): Record<string, string>;
-/**
- * Type representing an editable item within an editor.
- */
-export type EditableItem = {
-    element: HTMLElement;
-    content: string | null;
-};
-//# sourceMappingURL=query-editor-editables.d.ts.map

package/dist/elements/editor/utils/query-editor-editables.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-editor-editables.d.ts","sourceRoot":"","sources":["../../../../../src/elements/editor/utils/query-editor-editables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAI3C;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,QAAQ,+BAIxD;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,QAAQ,GAIW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAChG;AAiED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,CAAC"}

package/src/elements/editor/utils/assign-initial-data-to-editor-config.ts

@@ -1,47 +0,0 @@
-import type { EditorConfig } from 'ckeditor5';
-
-/**
- * Assigns initial data to specified editor config.
- *
- * @param dataOrMap Initial data to be assigned to config.
- * @param config Config of the editor.
- * @returns The updated configuration object.
- */
-export function assignInitialDataToEditorConfig<C extends EditorConfig>(
-  dataOrMap: string | Record<string, string>,
-  config: C,
-): C {
-  const dataMap = toDataMap(dataOrMap);
-  const allRootsKeys = new Set([
-    ...Object.keys(dataMap),
-    ...Object.keys(config.roots ?? {}),
-  ]);
-
-  const rootsConfig = Array.from(allRootsKeys).reduce((acc, rootKey) => ({
-    ...acc,
-    [rootKey]: {
-      ...config.roots?.[rootKey],
-      ...rootKey === 'main' ? config.root : {},
-
-      /* v8 ignore next 5 */
-      ...rootKey in dataMap
-        ? {
-            initialData: dataMap[rootKey],
-          }
-        : {},
-    },
-  }), Object.create(config.roots || {}));
-
-  const mappedConfig: C = {
-    ...config,
-    roots: rootsConfig,
-  };
-
-  delete mappedConfig.root;
-
-  return mappedConfig;
-}
-
-function toDataMap(element: string | Record<string, string>): Record<string, string> {
-  return typeof element === 'string' ? { main: element } : { ...element };
-}

package/src/elements/editor/utils/assign-source-elements-to-editor-config.ts

@@ -1,59 +0,0 @@
-import type { EditorRelaxedConstructor } from '../types/editor-relaxed-constructor.type';
-import type { EditorConfig } from 'ckeditor5';
-
-/**
- * Assigns a DOM element to the editor configuration in a way that is compatible with the specific editor type.
- *
- * @param Editor Constructor of the editor used to determine the location of element config entry.
- * @param elementOrMap Element to be assigned to config.
- * @param config Config of the editor.
- * @returns The updated configuration object.
- */
-export function assignSourceElementsToEditorConfig<C extends EditorConfig>(
-  Editor: EditorRelaxedConstructor,
-  elementOrMap: HTMLElement | Record<string, HTMLElement>,
-  config: C,
-): C {
-  const elementsMap = toElementsMap(elementOrMap);
-
-  if (!Editor.editorName || Editor.editorName === 'ClassicEditor') {
-    return {
-      ...config,
-      attachTo: elementsMap['main'],
-    };
-  }
-
-  const allRootsKeys = new Set([
-    ...Object.keys(elementsMap),
-    ...Object.keys(config.roots ?? {}),
-  ]);
-
-  const rootsConfig = Array.from(allRootsKeys).reduce((acc, rootKey) => ({
-    ...acc,
-    [rootKey]: {
-      /* v8 ignore next */
-      ...config.roots?.[rootKey],
-      ...rootKey === 'main' ? config.root : {},
-
-      /* v8 ignore next 5 */
-      ...rootKey in elementsMap
-        ? {
-            element: elementsMap[rootKey],
-          }
-        : {},
-    },
-  }), Object.create(config.roots || {}));
-
-  const mappedConfig: C = {
-    ...config,
-    roots: rootsConfig,
-  };
-
-  delete mappedConfig.root;
-
-  return mappedConfig;
-}
-
-function toElementsMap(element: HTMLElement | Record<string, HTMLElement>): Record<string, HTMLElement> {
-  return element instanceof HTMLElement ? { main: element } : { ...element };
-}

package/src/elements/editor/utils/query-editor-editables.ts

@@ -1,101 +0,0 @@
-import type { EditorId } from '../typings';
-
-import { filterObjectValues, mapObjectValues } from '../../../shared';
-
-/**
- * Gets the initial root elements for the editor based on its type.
- *
- * @param editorId The editor's ID.
- * @returns The root element(s) for the editor.
- */
-export function queryEditablesElements(editorId: EditorId) {
-  const editables = queryAllEditorEditables(editorId);
-
-  return mapObjectValues(editables, ({ element }) => element);
-}
-
-/**
- * Gets the initial data for the roots of the editor. If the editor is a single editing-like editor,
- * it retrieves the initial value from the element's attribute. Otherwise, it returns an object mapping
- * editable names to their initial values.
- *
- * @param editorId The editor's ID.
- * @returns The initial values for the editor's roots.
- */
-export function queryEditablesSnapshotContent(editorId: EditorId) {
-  const editables = queryAllEditorEditables(editorId);
-  const values = mapObjectValues(editables, ({ content }) => content);
-
-  return filterObjectValues(values, value => typeof value === 'string') as Record<string, string>;
-}
-
-/**
- * Queries all editable elements within a specific editor instance. It picks
- * initial values from actually rendered elements or from the editor container's.
- *
- * It may differ from the `initialData` used during editor creation, as it might
- * not set all roots or set different values.
- *
- * @param editorId The ID of the editor to query.
- * @returns An object mapping editable names to their corresponding elements and initial values.
- */
-function queryAllEditorEditables(editorId: EditorId) {
-  const acc = (
-    Array
-      .from(document.querySelectorAll<HTMLElement>(`cke5-editable[data-cke-editor-id="${editorId}"]`))
-      .reduce<Record<string, EditableItem>>((acc, element) => {
-        const rootName = element.getAttribute('data-cke-root-name')!;
-        const content = element.getAttribute('data-cke-content');
-
-        acc[rootName] = {
-          element: element.querySelector<HTMLElement>('[data-cke-editable-content]')!,
-          content,
-        };
-
-        return acc;
-      }, Object.create({}))
-  );
-
-  const editor = document.querySelector<HTMLElement>(`cke5-editor[data-cke-editor-id="${editorId}"]`);
-
-  /* v8 ignore next -- @preserve */
-  if (!editor) {
-    return acc;
-  }
-
-  const currentMain = acc['main'];
-  const initialRootEditableValue = JSON.parse(editor.getAttribute('data-cke-content')!);
-  const contentElement = document.querySelector<HTMLElement>(`#${editorId}_editor `);
-
-  // If found `main` editable, but it has no content, try to fill it from the editor container.
-  if (currentMain && initialRootEditableValue?.['main']) {
-    return {
-      ...acc,
-      main: {
-        ...currentMain,
-        content: currentMain.content || initialRootEditableValue['main'],
-      },
-    };
-  }
-
-  // If no `main` editable found, try to create it from the editor container.
-  if (contentElement) {
-    return {
-      ...acc,
-      main: {
-        element: contentElement,
-        content: initialRootEditableValue?.['main'] || null,
-      },
-    };
-  }
-
-  return acc;
-}
-
-/**
- * Type representing an editable item within an editor.
- */
-export type EditableItem = {
-  element: HTMLElement;
-  content: string | null;
-};