Block ID implementation by gohabereg · Pull Request #133 · editor-js/document-model

gohabereg · 2026-05-03T16:27:36Z

Added id to the BlockNodes wit
BlockToolAdapter and BlockManager now refer to blocks by id to avoid re-indexing

…nputs-registration

github-actions · 2026-05-03T16:29:05Z

Coverage report for `./packages/dom-adapters`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	96.43%	27/28
🟢	Branches	86.96%	20/23
🟢	Functions	100%	5/5
🟢	Lines	96.43%	27/28

Test suite run success

11 tests passing in 2 suites.

Report generated by 🧪jest coverage report action from 0c4e32b

github-actions · 2026-05-03T16:29:13Z

Coverage report for `./packages/core`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	100%	129/129
🟢	Branches	100%	47/47
🟢	Functions	100%	27/27
🟢	Lines	100%	120/120

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / BlockManager.ts	100%	100%	100%	100%
🟢	`...` / BlockRenderer.ts	100%	100%	100%	100%

Test suite run success

75 tests passing in 7 suites.

Report generated by 🧪jest coverage report action from 0c4e32b

github-actions · 2026-05-03T16:29:16Z

Coverage report for `./packages/model`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	99.8% (+0.01% 🔼)	988/990
🟢	Branches	98.98% (+0.03% 🔼)	292/295
🟢	Functions	97.45% (-0.33% 🔻)	229/235
🟢	Lines	99.79% (+0.01% 🔼)	948/950

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / BlockId.ts	100%	100%	100%	100%
🟢	`...` / BlockAlreadyExistsError.ts	100%	100%	100%	100%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / index.ts	100%	100%	91.67% (-2.27% 🔻)	100%

Test suite run success

538 tests passing in 25 suites.

Report generated by 🧪jest coverage report action from 0c4e32b

github-actions · 2026-05-03T16:29:41Z

Coverage report for `./packages/collaboration-manager`

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	92.51%	358/387
🟢	Branches	85.51%	118/138
🟢	Functions	98.15%	53/54
🟢	Lines	92.41%	353/382

Test suite run success

117 tests passing in 7 suites.

Report generated by 🧪jest coverage report action from 0c4e32b

github-actions · 2026-05-03T16:29:45Z

Coverage report for `./packages/ot-server`

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	70.97%	22/31
🔴	Branches	20%	1/5
🟡	Functions	75%	6/8
🟡	Lines	68.97%	20/29

Test suite run success

4 tests passing in 1 suite.

Report generated by 🧪jest coverage report action from 0c4e32b

github-actions · 2026-05-03T16:31:04Z

⏭️ No files to mutate for ./packages/model

github-actions · 2026-05-03T16:31:14Z

⏭️ No files to mutate for ./packages/core

github-actions · 2026-05-03T16:32:29Z

⏭️ No files to mutate for ./packages/dom-adapters

Copilot

Pull request overview

This PR introduces persistent block IDs across the model/SDK/core stack so blocks can be addressed by identity instead of by mutable array index. It also refactors block rendering and DOM adapter wiring around that new identity-based flow, which is foundational for more stable editor state management.

Changes:

Adds id support to block serialization/init paths and exposes id-based lookup helpers in the model.
Refactors core/dom-adapters to create block adapters through an adapter plugin and render blocks via a dedicated BlockRenderer.
Updates tools, tests, mocks, and fixtures to work with block IDs and the new adapter/event model.

Reviewed changes

Copilot reviewed 60 out of 62 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
yarn.lock	Lockfile updates for Inversify/jsdom dependency changes.
packages/sdk/src/tools/facades/InlineToolFacade.ts	Caches inline tool instances as singletons.
packages/sdk/src/tools/facades/BaseToolFacade.ts	Broadens block tool constructor typing.
packages/sdk/src/entities/index.ts	Re-exports adapter/plugin entities.
packages/sdk/src/entities/EventBus/events/index.ts	Exports new adapter event group.
packages/sdk/src/entities/EventBus/events/adapter/ValueNodeChanged.ts	Adds adapter value-change event.
packages/sdk/src/entities/EventBus/events/adapter/KeyRemoved.ts	Adds adapter key-removed event.
packages/sdk/src/entities/EventBus/events/adapter/KeyAdded.ts	Adds adapter key-added event.
packages/sdk/src/entities/EventBus/events/adapter/index.ts	Barrel export for adapter events.
packages/sdk/src/entities/EventBus/events/adapter/AdapterEventType.ts	Defines adapter event names.
packages/sdk/src/entities/EntityType.ts	Adds adapter plugin type.
packages/sdk/src/entities/EditorjsPlugin.ts	Makes plugin constructors generic.
packages/sdk/src/entities/EditorjsAdapterPlugin.ts	Defines adapter plugin contract.
packages/sdk/src/entities/BlockToolAdapter.ts	Replaces interface with abstract id-based adapter base.
packages/sdk/src/entities/BlockTool.ts	Makes block tool adapter type generic.
packages/sdk/src/api/BlocksAPI.ts	Accepts block init objects for insertMany.
packages/sdk/package.json	Adds jsdom test dependency.
packages/sdk/jest.config.ts	Switches SDK tests to jsdom.
packages/playground/src/components/Input.vue	Removes old playground input helper.
packages/playground/src/components/index.ts	Drops removed playground component export.
packages/ot-server/src/DocumentManager.spec.ts	Loosens expectations to tolerate block IDs.
packages/model/src/mocks/data.ts	Adds IDs to mock document blocks.
packages/model/src/entities/inline-fragments/TextNode/TextNode.spec.ts	Tests serialized text node marker field.
packages/model/src/entities/EditorDocument/index.ts	Adds id-aware block APIs and lookup map.
packages/model/src/entities/EditorDocument/EditorDocument.spec.ts	Adds tests for new document getters.
packages/model/src/entities/BlockNode/types/index.ts	Re-exports block ID types/helpers.
packages/model/src/entities/BlockNode/types/BlockNodeSerialized.ts	Adds block `id` and `BlockNodeInit`.
packages/model/src/entities/BlockNode/types/BlockNodeConstructorParameters.ts	Allows optional constructor ID.
packages/model/src/entities/BlockNode/types/BlockId.ts	Introduces nominal block ID type/generator.
packages/model/src/entities/BlockNode/index.ts	Stores/serializes IDs and changes data-node init/events.
packages/model/src/entities/BlockNode/BlockNode.spec.ts	Updates tests for IDs/data-node behavior.
packages/model/src/entities/BlockNode/mocks/index.ts	Adds mocked `getDataNode`.
packages/model/src/EditorJSModel.ts	Exposes block-id and data-node helper APIs.
packages/model/src/EditorJSModel.spec.ts	Tests new model APIs.
packages/model/jest.config.ts	Formatting-only config cleanup.
packages/dom-adapters/tsconfig.json	Enables decorator metadata emission.
packages/dom-adapters/src/tokens.ts	Adds IoC token definitions.
packages/dom-adapters/src/InputsRegistry/index.ts	Adds shared blockId/dataKey input registry.
packages/dom-adapters/src/index.ts	Introduces DOM adapter plugin entrypoint.
packages/dom-adapters/src/FormattingAdapter/index.ts	Refactors formatting adapter to IoC/tool events.
packages/dom-adapters/src/CaretAdapter/index.ts	Reworks caret mapping around InputsRegistry/block IDs.
packages/dom-adapters/src/BlockToolAdapter/index.ts	Replaces old DOM adapter with id-based implementation.
packages/dom-adapters/package.json	Adds Inversify/reflect-metadata dependencies.
packages/core/src/utils/composeDataFromVersion2.ts	Returns block init objects.
packages/core/src/tools/ToolsManager.ts	Migrates tool manager to Inversify.
packages/core/src/tools/internal/block-tools/paragraph/index.ts	Rebuilds paragraph rendering around adapter events.
packages/core/src/tokens.ts	Adds core IoC tokens.
packages/core/src/index.ts	Refactors core bootstrapping/plugin registration for adapters.
packages/core/src/components/SelectionManager.ts	Moves inline-format application logic into core selection manager.
packages/core/src/components/SelectionManager.spec.ts	Updates tests for new selection/tool flow.
packages/core/src/components/BlockRenderer.ts	Adds dedicated block rendering component.
packages/core/src/components/BlockRenderer.spec.ts	Tests new block renderer behavior.
packages/core/src/components/BlockManager.ts	Removes rendering concerns; focuses on block operations.
packages/core/src/components/BlockManager.spec.ts	Updates block manager tests for refactor.
packages/core/src/api/SelectionAPI.ts	Migrates selection API to Inversify.
packages/core/src/api/index.ts	Migrates editor API aggregation to Inversify.
packages/core/src/api/DocumentAPI/DocumentAPI.ts	Migrates document API to Inversify.
packages/core/src/api/BlocksAPI.ts	Updates blocks API typing/DI.
packages/core/src/api/BlocksAPI.integration.spec.ts	Adjusts integration tests for IDs/refactor.
packages/core/package.json	Replaces TypeDI with Inversify.
packages/collaboration-manager/src/CollaborationManager.spec.ts	Loosens block expectations to tolerate IDs.
.nvmrc	Updates pinned Node version.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…re/block-id

gohabereg added 17 commits April 17, 2026 20:55

Fix inputs and values attachments to be data-first

0d5817e

Merge branch 'main' of github.com:editor-js/document-model into fix/i…

c5ff274

…nputs-registration

Load adapters as plugin

e4c246d

Merge branch 'main' of github.com:editor-js/document-model into fix/i…

40a6409

…nputs-registration

Fix tests

abe46db

Review comments

40c4284

(try to) fix test run for core package

ba5077d

Run base branch coverage manually

e424775

Fix unit-tests action: use ArtiomTr with pre-generated coverage files

5990de3

Try just PR branch tests

208c95d

Try clear before build

0996eac

Try no cache

8958a51

Use latest node

0ea33bc

Review comments resolved

d265bd3

Resolve review comments

7fe438f

Add destoryBlockToolAdapter method to Adapter plugin

0ad4ae1

Block ID implementation

9eb123a

gohabereg changed the base branch from main to fix/inputs-registration May 3, 2026 16:27

gohabereg added 4 commits May 3, 2026 18:24

Fix lint

bb7fc7c

Fix tests

f6702e4

Fix build

b4cbdfa

Remove userId from getBlockSerialized method

a5fa55f

Fix call in the block manager

8235392

Base automatically changed from fix/inputs-registration to main May 5, 2026 00:21

gohabereg requested a review from Copilot May 5, 2026 19:00

Copilot started reviewing on behalf of gohabereg May 5, 2026 19:01 View session

Copilot AI reviewed May 5, 2026

View reviewed changes

Review comments

d696d9f

ilyamore88 changed the base branch from main to feature/keypath-support May 6, 2026 14:46

ilyamore88 changed the base branch from feature/keypath-support to main May 6, 2026 14:46

Merge branch 'main' of github.com:editor-js/document-model into featu…

e727e7e

…re/block-id

gohabereg requested review from e11sy, ilyamore88 and neSpecc May 7, 2026 16:36

neSpecc reviewed May 7, 2026

View reviewed changes

Comment thread packages/core/src/components/BlockManager.spec.ts

neSpecc approved these changes May 7, 2026

View reviewed changes

ilyamore88 approved these changes May 7, 2026

View reviewed changes

gohabereg and others added 2 commits May 7, 2026 20:43

Cover uncovered lines

ab47b6d

Merge branch 'main' into feature/block-id

0c4e32b

gohabereg added this pull request to the merge queue May 7, 2026

Merged via the queue into main with commit 82aed33 May 7, 2026
24 checks passed

gohabereg deleted the feature/block-id branch May 7, 2026 20:08

Conversation

gohabereg commented May 3, 2026

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report for ./packages/dom-adapters

Test suite run success

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report for ./packages/core

Test suite run success

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report for ./packages/model

Test suite run success

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report for ./packages/collaboration-manager

Test suite run success

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report for ./packages/ot-server

Test suite run success

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented May 3, 2026 •

edited

Loading

Coverage report for `./packages/dom-adapters`

github-actions Bot commented May 3, 2026 •

edited

Loading

Coverage report for `./packages/core`

github-actions Bot commented May 3, 2026 •

edited

Loading

Coverage report for `./packages/model`

github-actions Bot commented May 3, 2026 •

edited

Loading

Coverage report for `./packages/collaboration-manager`

github-actions Bot commented May 3, 2026 •

edited

Loading

Coverage report for `./packages/ot-server`

github-actions Bot commented May 3, 2026 •

edited

Loading

github-actions Bot commented May 3, 2026 •

edited

Loading

github-actions Bot commented May 3, 2026 •

edited

Loading