Skip to content

fix(types): drain bare @superdoc/common shim, reach zero shims (SD-2893) #3154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caio-pizzol merged 1 commit into from
May 5, 2026
Merged

fix(types): drain bare @superdoc/common shim, reach zero shims (SD-2893) #3154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/superdoc/scripts/audit-declarations.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ const RELOCATION_GUARD_PACKAGES = [
'@superdoc/painter-dom',
'@superdoc/pm-adapter',
'@superdoc/style-engine',
'@superdoc/common',
'@superdoc/common/list-marker-utils',
];

Expand Down
23 changes: 20 additions & 3 deletions packages/superdoc/scripts/ensure-types.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,11 @@ if (handwrittenCopiedSuperEditor > 0) {
// public surface. Adding shared/ to vite-plugin-dts's `include` would shift the
// common-ancestor of all source files to the repo root and reorganise the
// entire dist tree, so we run tsc directly for just the files we relocate.
// Today: list-marker-utils plus its sibling layout-constants. Add new entries
// here in lockstep with `RELOCATION_RULES` below.
const SHARED_COMMON_DTS_TARGETS = ['list-marker-utils.ts', 'layout-constants.ts'];
// Today: list-marker-utils plus its sibling layout-constants, and
// comments-types (the four Comment* types referenced via bare @superdoc/common
// imports in three internal-only dist d.ts files). Add new entries here in
// lockstep with `RELOCATION_RULES` below.
const SHARED_COMMON_DTS_TARGETS = ['list-marker-utils.ts', 'layout-constants.ts', 'comments-types.ts'];
{
const { spawnSync: _spawnSync } = require('node:child_process');
const tscBin = path.join(repoRoot, 'node_modules', '.bin', 'tsc');
Expand Down Expand Up @@ -285,6 +287,20 @@ const RELOCATION_RULES = [
distEntry: 'layout-engine/style-engine/src/ooxml/index.d.ts',
matchSubpaths: false,
},
// SD-2893: bare @superdoc/common appears in three internal-only dist d.ts
// files for the four Comment* types (Comment, CommentContent, CommentJSON,
// CommentThreadingProfile). Point the bare specifier at comments-types.d.ts
// (emitted via SHARED_COMMON_DTS_TARGETS) so the rewrite resolves to a real
// file. matchSubpaths: false because only the bare specifier is referenced;
// any future @superdoc/common/<other-subpath> import would not be auto-
// rewritten, falling through to the audit gate. The runtime-value imports
// from the main entry (DOCX, PDF, HTML, getFileObject, compareVersions,
// BlankDOCX) are still handled by the inline-replacement step above.
{
pkg: '@superdoc/common',
distEntry: 'shared/common/comments-types.d.ts',
matchSubpaths: false,
},
];

// Guard packages that must never fall back to `_internal-shims.d.ts`.
Expand All @@ -300,6 +316,7 @@ const RELOCATION_GUARD_PACKAGES = [
'@superdoc/painter-dom',
'@superdoc/pm-adapter',
'@superdoc/style-engine',
'@superdoc/common',
'@superdoc/common/list-marker-utils',
];

Expand Down
Loading