@atlaskit/editor-common 87.0.2 → 87.0.4

package/dist/types/lazy-node-view/replace-node-views.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="lodash" />
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { CacheLoadedReactNodeViews, NodeViewConstructor } from './types';
+/**
+ * 🧱 Internal: Editor FE Platform
+ *
+ * Debounces and replaces the node views in a ProseMirror editor with lazy-loaded node views.
+ *
+ * This function is used to update the `nodeViews` property of the `EditorView` after lazy-loaded
+ * node views have been loaded. It uses a debounced approach to ensure that the replacement does
+ * not happen too frequently, which can be performance-intensive.
+ *
+ * The function checks if there are any loaded node views in the cache associated with the given
+ * `EditorView`. If there are, it replaces the current `nodeViews` in the `EditorView` with the
+ * loaded node views. The replacement is scheduled using `requestIdleCallback` or
+ * `requestAnimationFrame` to avoid blocking the main thread, especially in Firefox where
+ * `requestIdleCallback` may not be supported.
+ *
+ * @param {WeakMap<EditorView, Record<string, NodeViewConstructor>>} cache - A WeakMap that stores
+ *        the loaded node views for each `EditorView`. The key is the `EditorView`, and the value
+ *        is a record of node type names to their corresponding `NodeViewConstructor`.
+ * @param {EditorView} view - The ProseMirror `EditorView` instance whose `nodeViews` property
+ *        needs to be updated.
+ *
+ * @example
+ * const cache = new WeakMap();
+ * const view = new EditorView(...);
+ *
+ * // Assume some node views have been loaded and stored in the cache
+ * cache.set(view, {
+ *   'table': TableViewConstructor,
+ *   'tableCell': TableCellViewConstructor,
+ * });
+ *
+ * debouncedReplaceNodeviews(cache, view);
+ */
+export declare const debouncedReplaceNodeviews: import("lodash").DebouncedFunc<(cache: CacheLoadedReactNodeViews, view: EditorView) => void>;
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export declare const queueReplaceNodeViews: (view: EditorView, { nodeName, nodeViewFunc }: {
+    nodeName: string;
+    nodeViewFunc: NodeViewConstructor;
+}) => void;

package/dist/types/lazy-node-view/types.d.ts

@@ -0,0 +1,14 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Decoration, DecorationSource, EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export type NodeViewConstructor = (node: PMNode, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export type LoadedReactNodeViews = Record<string, NodeViewConstructor>;
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export type CacheLoadedReactNodeViews = WeakMap<EditorView, LoadedReactNodeViews>;

package/dist/types/styles/shared/code-block.d.ts

@@ -6,6 +6,7 @@ export declare const CodeBlockSharedCssClassName: {
     CODEBLOCK_LINE_NUMBER_GUTTER: string;
     CODEBLOCK_CONTENT: string;
     DS_CODEBLOCK: string;
+    CODEBLOCK_CONTENT_WRAPPED: string;
 };
 export declare const codeBlockSharedStyles: () => import("@emotion/react").SerializedStyles;
 export declare const codeBlockInListSafariFix: import("@emotion/react").SerializedStyles;

package/dist/types-ts4.5/code-block/index.d.ts

@@ -0,0 +1,9 @@
+import type { Node as PmNode } from '@atlaskit/editor-prosemirror/model';
+export declare const defaultWordWrapState = false;
+export declare const codeBlockWrappedStates: WeakMap<PmNode, boolean | undefined>;
+export declare const isCodeBlockWordWrapEnabled: (codeBlockNode: PmNode) => boolean;
+/**
+ * As the code block node is used as the key, there is instances where the node will be destroyed & recreated and is no longer a valid key.
+ * In these instances, we must get the value from that old node and set it to the value of the new node.
+ */
+export declare const transferCodeBlockWrappedValue: (oldCodeBlockNode: PmNode, newCodeBlockNode: PmNode) => void;

package/dist/types-ts4.5/lazy-node-view/index.d.ts

@@ -1,7 +1,8 @@
-/// <reference types="lodash" />
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { Decoration, DecorationSource, EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
+import type { Decoration, EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
 import type { DispatchAnalyticsEvent } from '../analytics';
+import type { NodeViewConstructor } from './types';
+export type { NodeViewConstructor };
 /**
  * 📢 Public Type
  *
@@ -19,52 +20,6 @@ export type LazyLoadingProps<NodeViewOptions> = {
     getNodeViewOptions: () => NodeViewOptions;
     dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
 };
-/**
- * 🧱 Internal: Editor FE Platform
- */
-export type NodeViewConstructor = (node: PMNode, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
-/**
- * 🧱 Internal: Editor FE Platform
- */
-type LoadedReactNodeViews = Record<string, NodeViewConstructor>;
-/**
- * 🧱 Internal: Editor FE Platform
- */
-type CacheType = WeakMap<EditorView, LoadedReactNodeViews>;
-/**
- * 🧱 Internal: Editor FE Platform
- *
- * Debounces and replaces the node views in a ProseMirror editor with lazy-loaded node views.
- *
- * This function is used to update the `nodeViews` property of the `EditorView` after lazy-loaded
- * node views have been loaded. It uses a debounced approach to ensure that the replacement does
- * not happen too frequently, which can be performance-intensive.
- *
- * The function checks if there are any loaded node views in the cache associated with the given
- * `EditorView`. If there are, it replaces the current `nodeViews` in the `EditorView` with the
- * loaded node views. The replacement is scheduled using `requestIdleCallback` or
- * `requestAnimationFrame` to avoid blocking the main thread, especially in Firefox where
- * `requestIdleCallback` may not be supported.
- *
- * @param {WeakMap<EditorView, Record<string, NodeViewConstructor>>} cache - A WeakMap that stores
- *        the loaded node views for each `EditorView`. The key is the `EditorView`, and the value
- *        is a record of node type names to their corresponding `NodeViewConstructor`.
- * @param {EditorView} view - The ProseMirror `EditorView` instance whose `nodeViews` property
- *        needs to be updated.
- *
- * @example
- * const cache = new WeakMap();
- * const view = new EditorView(...);
- *
- * // Assume some node views have been loaded and stored in the cache
- * cache.set(view, {
- *   'table': TableViewConstructor,
- *   'tableCell': TableCellViewConstructor,
- * });
- *
- * debouncedReplaceNodeviews(cache, view);
- */
-export declare const debouncedReplaceNodeviews: import("lodash").DebouncedFunc<(cache: CacheType, view: EditorView) => void>;
 /**
  * 📢 Public: Any EditorPlugin can use this function
  *
@@ -106,4 +61,3 @@ export declare const debouncedReplaceNodeviews: import("lodash").DebouncedFunc<(
  * // Then, use `lazyTableView` in ProseMirror editor setup to enhance 'table' nodes with lazy loading
  */
 export declare const withLazyLoading: <Options>({ nodeName, loader, getNodeViewOptions, dispatchAnalyticsEvent, }: LazyLoadingProps<Options>) => NodeViewConstructor;
-export {};

package/dist/types-ts4.5/lazy-node-view/node-view.d.ts

@@ -0,0 +1,12 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * 🧱 Internal: Editor FE Platform
+ *
+ * A NodeView that serves as a placeholder until the actual NodeView is loaded.
+ */
+export declare class LazyNodeView implements NodeView {
+    dom: Node;
+    contentDOM?: HTMLElement;
+    constructor(node: PMNode, view: EditorView, getPos: () => number | undefined);
+}

package/dist/types-ts4.5/lazy-node-view/replace-node-views.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="lodash" />
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { CacheLoadedReactNodeViews, NodeViewConstructor } from './types';
+/**
+ * 🧱 Internal: Editor FE Platform
+ *
+ * Debounces and replaces the node views in a ProseMirror editor with lazy-loaded node views.
+ *
+ * This function is used to update the `nodeViews` property of the `EditorView` after lazy-loaded
+ * node views have been loaded. It uses a debounced approach to ensure that the replacement does
+ * not happen too frequently, which can be performance-intensive.
+ *
+ * The function checks if there are any loaded node views in the cache associated with the given
+ * `EditorView`. If there are, it replaces the current `nodeViews` in the `EditorView` with the
+ * loaded node views. The replacement is scheduled using `requestIdleCallback` or
+ * `requestAnimationFrame` to avoid blocking the main thread, especially in Firefox where
+ * `requestIdleCallback` may not be supported.
+ *
+ * @param {WeakMap<EditorView, Record<string, NodeViewConstructor>>} cache - A WeakMap that stores
+ *        the loaded node views for each `EditorView`. The key is the `EditorView`, and the value
+ *        is a record of node type names to their corresponding `NodeViewConstructor`.
+ * @param {EditorView} view - The ProseMirror `EditorView` instance whose `nodeViews` property
+ *        needs to be updated.
+ *
+ * @example
+ * const cache = new WeakMap();
+ * const view = new EditorView(...);
+ *
+ * // Assume some node views have been loaded and stored in the cache
+ * cache.set(view, {
+ *   'table': TableViewConstructor,
+ *   'tableCell': TableCellViewConstructor,
+ * });
+ *
+ * debouncedReplaceNodeviews(cache, view);
+ */
+export declare const debouncedReplaceNodeviews: import("lodash").DebouncedFunc<(cache: CacheLoadedReactNodeViews, view: EditorView) => void>;
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export declare const queueReplaceNodeViews: (view: EditorView, { nodeName, nodeViewFunc }: {
+    nodeName: string;
+    nodeViewFunc: NodeViewConstructor;
+}) => void;

package/dist/types-ts4.5/lazy-node-view/types.d.ts

@@ -0,0 +1,14 @@
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Decoration, DecorationSource, EditorView, NodeView } from '@atlaskit/editor-prosemirror/view';
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export type NodeViewConstructor = (node: PMNode, view: EditorView, getPos: () => number | undefined, decorations: readonly Decoration[], innerDecorations: DecorationSource) => NodeView;
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export type LoadedReactNodeViews = Record<string, NodeViewConstructor>;
+/**
+ * 🧱 Internal: Editor FE Platform
+ */
+export type CacheLoadedReactNodeViews = WeakMap<EditorView, LoadedReactNodeViews>;

package/dist/types-ts4.5/styles/shared/code-block.d.ts

@@ -6,6 +6,7 @@ export declare const CodeBlockSharedCssClassName: {
     CODEBLOCK_LINE_NUMBER_GUTTER: string;
     CODEBLOCK_CONTENT: string;
     DS_CODEBLOCK: string;
+    CODEBLOCK_CONTENT_WRAPPED: string;
 };
 export declare const codeBlockSharedStyles: () => import("@emotion/react").SerializedStyles;
 export declare const codeBlockInListSafariFix: import("@emotion/react").SerializedStyles;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "87.0.2",
+	"version": "87.0.4",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -93,6 +93,7 @@
 		"./constants": "./src/link/constants.ts",
 		"./doc-utils": "./src/doc-utils/index.ts",
 		"./expand": "./src/expand/index.ts",
+		"./code-block": "./src/code-block/index.ts",
 		"./table": "./src/table/index.ts",
 		"./lazy-node-view": "./src/lazy-node-view/index.ts"
 	},
@@ -115,7 +116,7 @@
 		"@atlaskit/editor-shared-styles": "^2.13.0",
 		"@atlaskit/editor-tables": "^2.8.0",
 		"@atlaskit/emoji": "^67.6.0",
-		"@atlaskit/icon": "^22.7.0",
+		"@atlaskit/icon": "^22.8.0",
 		"@atlaskit/icon-object": "^6.4.0",
 		"@atlaskit/link-datasource": "^2.9.0",
 		"@atlaskit/link-picker": "^1.41.0",
@@ -264,6 +265,9 @@
 		},
 		"editor_inline_comments_paste_insert_nodes": {
 			"type": "boolean"
+		},
+		"editor_support_code_block_wrapping": {
+			"type": "boolean"
 		}
 	}
 }