[METAED-1664] Choice optionality and dependency bumps#526
Open
bradbanister wants to merge 4 commits into
Open
Conversation
Test Results 1 files 460 suites 11m 59s ⏱️ Results for commit e422b6b. ♻️ This comment has been updated with latest results. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Ed-Fi API Schema “requiredness” semantics for properties under choice contexts (making choice members effectively optional in the payload), while also bumping several dependencies across the monorepo (notably read-excel-file, @xmldom/xmldom, joi, esbuild) and adding root-level overrides to pin transitive packages.
Changes:
- Adjust API schema JsonPath/document-path mapping enhancers to compute an effective
isRequiredthat accounts for parent context (e.g.,choice). - Update integration tests and expected artifacts to reflect the new
isRequiredbehavior (manyisRequired: true -> falseunder choice members). - Bump and align dependencies (including
read-excel-filemajor version) and addpackage.jsonoverrides with corresponding lockfile updates.
Reviewed changes
Copilot reviewed 22 out of 23 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/metaed-plugin-edfi-xsd/package.json | Bumps @xmldom/xmldom dependency. |
| packages/metaed-plugin-edfi-xml-dictionary/test/integration/XmlDataDictionaryGenerator.test.ts | Updates Excel-reading test code for new read-excel-file API and adds typing. |
| packages/metaed-plugin-edfi-xml-dictionary/package.json | Bumps @xmldom/xmldom and upgrades read-excel-file devDependency. |
| packages/metaed-plugin-edfi-sql-dictionary/test/integration/SqlDataDictionaryGenerator.test.ts | Updates Excel-reading test code for new read-excel-file API and adds typing. |
| packages/metaed-plugin-edfi-sql-dictionary/package.json | Upgrades read-excel-file devDependency. |
| packages/metaed-plugin-edfi-handbook/test/integration/EdFiDataHandbookAsExcelGenerator.test.ts | Updates Excel-reading test code for new read-excel-file API and adds typing. |
| packages/metaed-plugin-edfi-handbook/package.json | Upgrades read-excel-file devDependency. |
| packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.1-api-schema-authoritative.json | Updates expected API schema authoritative output (isRequired changes under choice members). |
| packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-6.0-api-schema-authoritative.json | Updates expected API schema authoritative output (isRequired changes under choice members). |
| packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_3/ds-5.2-api-schema-authoritative.json | Updates expected API schema authoritative output (isRequired changes under choice members). |
| packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_2/ds-5.1-api-schema-authoritative.json | Updates expected API schema authoritative output (isRequired changes under choice members). |
| packages/metaed-plugin-edfi-api-schema/test/integration/artifact/v7_1/ds-5.0-api-schema-authoritative.json | Updates expected API schema authoritative output (isRequired changes under choice members). |
| packages/metaed-plugin-edfi-api-schema/test/enhancer/DocumentPathsMappingEnhancer.test.ts | Updates/adds snapshots to validate new effective requiredness behavior for choices. |
| packages/metaed-plugin-edfi-api-schema/src/model/JsonPathsMapping.ts | Adds isRequired to JsonPathsInfo to capture effective requiredness after parent context. |
| packages/metaed-plugin-edfi-api-schema/src/enhancer/MergeJsonPathsMappingEnhancer.ts | Propagates parent-context optionality and introduces effective isRequired on mapping entries. |
| packages/metaed-plugin-edfi-api-schema/src/enhancer/DocumentPathsMappingEnhancer.ts | Uses jsonPathsInfo.isRequired (effective) instead of raw property requiredness. |
| packages/metaed-plugin-edfi-api-schema/src/enhancer/AllJsonPathsMappingEnhancer.ts | Propagates parent-context optionality and introduces effective isRequired on mapping entries. |
| packages/metaed-plugin-edfi-api-schema/package.json | Bumps joi dependency. |
| packages/metaed-plugin-edfi-api-catalog/test/integration/ApiCatalogGenerator.test.ts | Updates Excel-reading test code for new read-excel-file API and adjusts typings. |
| packages/metaed-plugin-edfi-api-catalog/package.json | Upgrades read-excel-file devDependency. |
| packages/metaed-core/package.json | Bumps joi dependency. |
| package.json | Bumps esbuild and adds dependency overrides to pin transitive versions. |
| package-lock.json | Lockfile refresh reflecting dependency bumps and overrides. |
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.
No description provided.