Skip to content

[METAED-1664] Choice optionality and dependency bumps#526

Open
bradbanister wants to merge 4 commits into
mainfrom
METAED-1664
Open

[METAED-1664] Choice optionality and dependency bumps#526
bradbanister wants to merge 4 commits into
mainfrom
METAED-1664

Conversation

@bradbanister

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings July 7, 2026 22:35
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

Test Results

    1 files    460 suites   11m 59s ⏱️
5 574 tests 5 571 ✅ 3 💤 0 ❌
6 380 runs  6 377 ✅ 3 💤 0 ❌

Results for commit e422b6b.

♻️ This comment has been updated with latest results.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 isRequired that accounts for parent context (e.g., choice).
  • Update integration tests and expected artifacts to reflect the new isRequired behavior (many isRequired: true -> false under choice members).
  • Bump and align dependencies (including read-excel-file major version) and add package.json overrides 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants