Extract common types from model to new package by gohabereg · Pull Request #156 · editor-js/document-model

gohabereg · 2026-06-20T15:46:17Z

Added model-types packages with the types that might be used by external developers.

model-types package is intended to be used only within model and sdk packages. Tools/Plugins should only import sdk package, mode package only should be used by internal packages such as core and ot-server. There is yarn workspace constraint now to check this on precommit (yarn.config.cjs file)

Copilot instructions

Make sure there's no duplicate definitions (all definitions are migrated to model-types package)
model-types package is used only within model and sdk packages
model-types entities are not re-exported from the model, only from sdk
There's no changes to business logic, only imports updates

github-actions · 2026-06-20T15:47:01Z

Unit Tests

Package	Coverage	Delta
@editorjs/model	98.25%	-0.18% 🔴
@editorjs/dom-adapters	86.95%	0% ⚪️
@editorjs/collaboration-manager	85.81%	0% ⚪️
@editorjs/ot-server	20%	0% ⚪️
@editorjs/core	89.55%	0% ⚪️
@editorjs/model-types	97.82%	N/A

Mutation Tests

Package	Mutation score	Dashboard URL
@editorjs/core	48.58% 🔴	Dashboard
@editorjs/dom-adapters	8.77% 🔴	Dashboard
@editorjs/model	92.75% 🟢	Dashboard
@editorjs/collaboration-manager	60.96% 🟡	Dashboard

Copilot

Pull request overview

This PR introduces a new @editorjs/model-types workspace to host low-level shared types/events previously defined in @editorjs/model, and updates the monorepo so that tools/plugins consume these types via @editorjs/sdk (not via model or model-types directly). It also adds Yarn constraints to enforce the intended workspace dependency boundaries.

Changes:

Added yarn.config.cjs constraints to restrict which workspaces may depend on @editorjs/model-types and @editorjs/model.
Updated package dependencies, TS project references, and imports across sdk, model, ui, playground, and ot-server to use the new model-types package (and re-export from sdk).
Updated @editorjs/sdk public exports to surface model-types types/events, plus added a temporary keypath re-export through sdk.

Reviewed changes

Copilot reviewed 220 out of 225 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
yarn.config.cjs	Adds Yarn constraints logic to enforce allowed dependency relationships between workspaces.
README.md	Documents `@editorjs/model-types` and clarifies intended consumption paths (`sdk` for tools/plugins).
packages/ui/tsconfig.json	Removes direct TS project reference to `model`.
packages/ui/tsconfig.build.json	Updates build references (currently includes `model-types`).
packages/ui/src/InlineToolbar/InlineToolbar.ts	Switches model-derived types to be imported from `@editorjs/sdk`.
packages/ui/package.json	Removes direct dependency on `@editorjs/model`.
packages/sdk/tsconfig.json	Updates TS project reference to `model-types`.
packages/sdk/tsconfig.build.json	Updates TS build reference to `model-types`.
packages/sdk/src/utils/keypath.ts	Adds temporary re-export of keypath helpers from `model-types` via `sdk`.
packages/sdk/src/utils/index.ts	Adds a utils barrel exporting keyboardShortcut + keypath helpers.
packages/sdk/src/tools/facades/BlockToolFacade.ts	Switches `BlockChildType`/constants/types to come from `model-types` and keypath via `sdk` utils.
packages/sdk/src/tools/facades/BaseToolFacade.spec.ts	Updates test imports from `model` to `model-types`.
packages/sdk/src/index.ts	Re-exports model-types types/events from the SDK public entrypoint.
packages/sdk/src/entities/InlineTool.ts	Updates type imports from `model` to `model-types`.
packages/sdk/src/entities/index.ts	Adds `Index` re-export (in addition to SDK root exports).
packages/sdk/src/entities/EventBus/events/core/SelectionChangedCoreEvent.ts	Updates Index/fragment/tool-name type sourcing post-extraction.
packages/sdk/src/entities/EventBus/events/adapter/ValueNodeChanged.ts	Switches `ValueSerialized` import from `model` to `model-types`.
packages/sdk/src/entities/EventBus/EventBus.ts	Re-exports `EventBus` from `model-types` instead of defining it locally.
packages/sdk/src/entities/EditorjsAdapterPlugin.ts	Switches `BlockId` type import to `model-types`.
packages/sdk/src/entities/Config.ts	Removes `EditorJSModel` type dependency by changing `onModelUpdate` typing.
packages/sdk/src/entities/BlockToolAdapter.ts	Switches event/type imports from `model` to `model-types`.
packages/sdk/src/entities/BlockTool.ts	Switches `ValueSerialized` type import to `model-types`.
packages/sdk/src/api/TextAPI.ts	Switches `InlineFragment` type import to `model-types`.
packages/sdk/src/api/SelectionAPI.ts	Switches `Caret`/`CaretManagerEvents` type imports to `model-types`.
packages/sdk/src/api/DocumentAPI.ts	Updates document/data types to come from `model-types` and Index from SDK entities.
packages/sdk/src/api/BlocksAPI.ts	Updates serialized document type usage to `model-types` document data shape.
packages/sdk/package.json	Switches dependency from `@editorjs/model` to `@editorjs/model-types` and bumps Jest tooling.
packages/model-types/package.json	Defines the new `@editorjs/model-types` package (including Jest tooling versions).
packages/playground/src/components/CaretIndex.vue	Switches event/index imports to come from `@editorjs/sdk` while keeping `EditorJSModel` local.
packages/playground/src/App.vue	Adapts to the SDK `onModelUpdate` typing change by casting.
packages/playground/package.json	Adds `@editorjs/sdk` dependency for direct usage.
packages/ot-server/src/DocumentManager.spec.ts	Switches `IndexBuilder` import from `model` to `sdk`.
packages/ot-server/package.json	Adds `@editorjs/sdk` dependency and bumps Jest typings/version.
packages/model/tsconfig.json	Adds TS project reference to `model-types`.
packages/model/src/utils/textUtils.ts	Switches inline-fragment-related type imports to `@editorjs/model-types`.
packages/model/src/EventBus/index.ts	Re-exports model-types event enums from the `model` package.
packages/model/src/utils/index.ts	Re-exports model-types nominal/create helpers from the `model` package.
packages/model/src/entities/BlockNode/index.ts	Re-exports several model-types types/helpers from the `model` package.

Comments suppressed due to low confidence (2)

packages/ui/tsconfig.build.json:12

@editorjs/ui doesn’t import @editorjs/model-types directly (it imports from @editorjs/sdk), so adding a direct TS project reference to ../model-types unnecessarily couples the build graph to model-types. Keeping only the sdk reference still builds model-types transitively (since sdk references it) and better matches the stated dependency boundaries.
packages/model/src/entities/BlockNode/index.ts:642
This file re-exports multiple @editorjs/model-types symbols (BlockNodeInit, BlockIndexOrId, createDataKey, createBlockId, etc.) from @editorjs/model. That violates the intended rule that model-types entities are not re-exported from the model package (only from @editorjs/sdk). To keep a single public surface, remove these re-exports from the model package and update internal imports/tests to consume them from @editorjs/model-types or @editorjs/sdk.

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

gohabereg · 2026-06-22T00:26:59Z

If anyone wanna re-run review, I've hit a limit

…ere's only one artifact

…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

…traction # Conflicts: # packages/core/src/api/SelectionAPI.spec.ts # packages/core/src/api/SelectionAPI.ts # packages/core/src/components/SelectionManager.spec.ts # packages/core/src/components/SelectionManager.ts # packages/core/src/index.ts # packages/core/src/tools/internal/inline-tools/bold/index.ts # packages/core/src/tools/internal/inline-tools/italic/index.ts # packages/core/src/tools/internal/inline-tools/link/index.ts # packages/model/src/entities/inline-fragments/FormattingInlineNode/types/FormattingAction.ts # packages/sdk/src/api/SelectionAPI.ts # packages/sdk/src/entities/EventBus/events/core/SelectionChangedCoreEvent.ts # packages/sdk/src/tools/facades/BaseToolFacade.spec.ts # packages/ui/src/InlineToolbar/InlineToolbar.ts

Copilot

Pull request overview

Copilot reviewed 236 out of 241 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

packages/ui/tsconfig.build.json:12

@editorjs/model-types is intended to be depended on directly only by @editorjs/model and @editorjs/sdk. Adding it as a TS project reference from @editorjs/ui tightens coupling and makes the build graph diverge from package.json dependencies. @editorjs/sdk already references model-types, so ui can rely on that transitive reference instead.

…traction # Conflicts: # packages/sdk/src/tools/facades/BlockToolFacade.ts

Reversean · 2026-06-25T20:49:45Z

+  TextUnformattedEvent,
+  CaretManagerCaretUpdatedEvent,
+  BlockAddedEvent,
+  BlockRemovedEvent


Should we re-export CaretManagerCaretAddedEvent, CaretManagerCaretRemovedEvent, PropertyModifiedEvent, TuneModifiedEvent here?

According on events-catalog.mmd, I assume that yes.

Reversean · 2026-06-25T20:49:45Z

    },
    {
-      "path": "../sdk/tsconfig.build.json"
+      "path": "../model/tsconfig.build.json"


Since @editorjs/model was moved to devDependencies, should ../model/tsconfig.build.json be here?

tsconfig.json doesn't have it.

document-model/packages/collaboration-manager/tsconfig.json

Lines 17 to 23 in 33b279c

"node_modules/**/*",

"dist/**/*",

"**/*.spec.ts"

],

"references": [

{

"path": "../sdk/tsconfig.build.json"

)

Reversean · 2026-06-25T21:18:56Z

+  PropertyModifiedEvent,
+  TuneModifiedEvent


Seems like unused import.

Suggested change

PropertyModifiedEvent,

TuneModifiedEvent

PropertyModifiedEvent

Extract common types from model to new package

5496497

gohabereg requested a review from Copilot June 20, 2026 15:46

Copilot started reviewing on behalf of gohabereg June 20, 2026 15:46 View session

update lockfile

7a48346

Copilot AI reviewed Jun 20, 2026

View reviewed changes

gohabereg added 2 commits June 21, 2026 22:27

Review commnets

6d15060

Fix CI

fb3f9f6

github-advanced-security AI found potential problems Jun 22, 2026

View reviewed changes

Comment thread .github/workflows/model-types.yml Fixed

gohabereg added 2 commits June 22, 2026 01:06

Update lock

2ea27a8

Fix lint for model, and base coverage action to check if package exists

803325b

gohabereg and others added 7 commits June 22, 2026 01:48

Enable mutation tests for collab-manager, fix coverage report when th…

60a25a6

…ere's only one artifact

Potential fix for pull request finding 'CodeQL / Workflow does not co…

a6d8da4

…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

add write permissions for pr comment

38aea03

Try downloading artifacts separately to guarantee location

bfa6ff4

Add json reporter for collab manager mutation tests

2c1e16b

Merge main

e14bef2

neSpecc requested review from Reversean and Copilot June 24, 2026 18:42

Copilot started reviewing on behalf of neSpecc June 24, 2026 18:42 View session

Copilot AI reviewed Jun 24, 2026

View reviewed changes

Comment thread .husky/pre-commit

Comment thread packages/model/src/entities/BlockNode/index.ts Outdated

gohabereg added 2 commits June 24, 2026 21:02

Merge remote-tracking branch 'origin/main' into chore/common-types-ex…

9094ab1

…traction # Conflicts: # packages/sdk/src/tools/facades/BlockToolFacade.ts

Clean-up re-exports

33b279c

neSpecc approved these changes Jun 24, 2026

View reviewed changes

Reversean requested changes Jun 25, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Extract common types from model to new package#156

Extract common types from model to new package#156
gohabereg wants to merge 15 commits into
mainfrom
chore/common-types-extraction

gohabereg commented Jun 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gohabereg commented Jun 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reversean Jun 25, 2026

Uh oh!

Reversean Jun 25, 2026

Uh oh!

Reversean Jun 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	"node_modules/*/",
	"dist/*/",
	"*/.spec.ts"
	],
	"references": [
	{
	"path": "../sdk/tsconfig.build.json"

	PropertyModifiedEvent,
	TuneModifiedEvent
	PropertyModifiedEvent

Uh oh!

Conversation

gohabereg commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Copilot instructions

Uh oh!

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

Uh oh!

Unit Tests

Mutation Tests

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!

gohabereg commented Jun 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reversean Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

Reversean Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

Reversean Jun 25, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gohabereg commented Jun 20, 2026 •

edited

Loading

github-actions Bot commented Jun 20, 2026 •

edited

Loading