Migrate external commands to Zod#7369
Open
waldekmastykarz wants to merge 2 commits into
Open
Conversation
Migrates all external commands (connection-add, connection-get, connection-remove, connection-doctor, connection-schema-add, connection-urltoitemresolver-add, item-add) from the legacy options/validators pattern to Zod schema validation. Closes pnp#7302 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the external workload commands shown in the diff from the legacy options/validators approach to schema-driven validation using Zod, aligning them with the CLI’s schema-based parsing/validation/telemetry pipeline.
Changes:
- Introduces Zod schemas (
schema+getRefinedSchemawhere needed) for multipleexternalconnection/item commands. - Replaces legacy validator-based tests with direct schema
safeParse(...)validation tests. - Updates unknown-option payload handling to the Zod-aware helper where applicable.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/m365/external/commands/item/item-add.ts | Adds Zod schema for item creation options and switches to Zod-aware unknown-option payload helper. |
| src/m365/external/commands/item/item-add.spec.ts | Updates validation tests to use schema safeParse. |
| src/m365/external/commands/connection/connection-urltoitemresolver-add.ts | Adds Zod schema for URL-to-item resolver creation options. |
| src/m365/external/commands/connection/connection-urltoitemresolver-add.spec.ts | Updates tests to validate via schema and adds unknown-option negative test. |
| src/m365/external/commands/connection/connection-schema-add.ts | Adds Zod schema with refined validation for connection ID and schema JSON content. |
| src/m365/external/commands/connection/connection-schema-add.spec.ts | Updates schema/id/schema JSON validation tests to use safeParse. |
| src/m365/external/commands/connection/connection-remove.ts | Adds strict Zod schema + refined option-set validation (id xor name). |
| src/m365/external/commands/connection/connection-remove.spec.ts | Adds schema-based option-set and unknown-option validation tests. |
| src/m365/external/commands/connection/connection-get.ts | Adds strict Zod schema + refined option-set validation (id xor name). |
| src/m365/external/commands/connection/connection-get.spec.ts | Adds schema-based option-set and unknown-option validation tests. |
| src/m365/external/commands/connection/connection-doctor.ts | Adds strict Zod schema for id and ux (enum). |
| src/m365/external/commands/connection/connection-doctor.spec.ts | Updates ux validation tests to schema safeParse and adds unknown-option negative test. |
| src/m365/external/commands/connection/connection-add.ts | Adds strict Zod schema for connection creation, including reserved ID checks. |
| src/m365/external/commands/connection/connection-add.spec.ts | Updates connection ID validation tests to use schema safeParse and adds unknown-option negative test. |
- connection-add: use message instead of error in refinement - connection-schema-add: add separate JSON parse validation refinement - item-add: add .passthrough() to z.object() for unknown options Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Migrates all
externalcommands from the legacy options/validators/telemetry pattern to Zod schema validation.Closes #7302
Changes
Migrated the following commands:
.min()/.max()/.refine()id/name) viagetRefinedSchema()id/name) +forceboolean viagetRefinedSchema()uxenum validation viaz.enum().refine().refine(), usesz.object(notz.strictObject) forallowUnknownOptionssupport, switched toaddUnknownOptionsToPayloadZodTesting