[Blueprints] Require WXR author maps in Blueprint v2 types - #3869
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the Blueprint v2 TypeScript schema to enforce that WXR content using authorsMode: "map" must also provide an authorsMap, and adds a type-level test to prevent regressions.
Changes:
- Refactors the WXR content definition into a discriminated union that requires
authorsMapwhenauthorsMode: 'map'. - Adds a TypeScript test case asserting that missing
authorsMapis a compile-time error.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/playground/blueprints/src/lib/v2/wep-1-blueprint-v2-schema/appendix-A-blueprint-v2-schema.ts | Encodes authorsMode: 'map' ⇒ authorsMap required via a unioned WXR content type. |
| packages/playground/blueprints/src/tests/v2/blueprint-v2-declaration.spec.ts | Adds a @ts-expect-error guard test for missing authorsMap under authorsMode: 'map'. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+530
to
+534
| * The default author to use when `mode` is "default-author". | ||
| * | ||
| * @default "admin". | ||
| */ | ||
| defaultAuthorUsername?: string; |
Comment on lines
+498
to
+510
| /** | ||
| * How to handle authors that don't exist on the current site. | ||
| * | ||
| * Possible values: | ||
| * | ||
| * * "create" – Create a new author. | ||
| * * "default-author" – Use the default author. | ||
| * | ||
| * @default "create". | ||
| */ | ||
| authorsMode?: 'create' | 'default-author'; | ||
| authorsMap?: Record<RemoteUsername, LocalUsername>; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Updates the Blueprint v2 declaration type so WXR content with
authorsMode: "map"must also provideauthorsMap.Why?
The schema docs already say
authorsMapis required when WXR author mode ismap. Encoding that in the TypeScript declaration catches incomplete Blueprints before they reach a runner.Scope
This is type-only. It does not change WXR import execution, URL rewriting, or author matching behavior.
Testing
npm run format:uncommittedgit diff --checknpm exec nx run playground-blueprints:typechecknpm exec nx run playground-blueprints:lintnpm exec nx run playground-blueprints:test:vite -- --testFiles=packages/playground/blueprints/src/tests/v2/blueprint-v2-declaration.spec.tsPart of #2592.