feat!: rename ExO export fields to match updated entity names [AIS-388] - #2352
Draft
Joe Bingham (jshmo) wants to merge 6 commits into
Draft
feat!: rename ExO export fields to match updated entity names [AIS-388]#2352Joe Bingham (jshmo) wants to merge 6 commits into
Joe Bingham (jshmo) wants to merge 6 commits into
Conversation
Rename three ExO entity arrays in the exported JSON and their user-facing task/log strings to match the updated feature naming: - componentTypes -> components (Component Type -> Component) - templates -> experienceTemplates (Template -> Experience Template) - fragments -> experienceFragments (Fragment -> Experience Fragment) Updates the ContentfulExportField type and the include-experience-orchestration option description. designTokens and experiences are unaffected. BREAKING CHANGE: exported JSON field names componentTypes, templates and fragments are renamed to components, experienceTemplates and experienceFragments. Consumers of the export output (e.g. contentful-import, AIS-387) must update in lockstep. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…d ExO endpoints [AIS-388] v12.13.0 renames the ExO plain-client endpoints; the old ones are now deprecated. Switch the export to the non-deprecated endpoints: - componentType.getMany -> component.getMany - template.getMany -> experienceTemplate.getMany - fragment.getMany -> experienceFragment.getMany designToken.getMany is now implemented in the SDK, so drop the stale AIS-135 "not yet implemented" note (the graceful try/catch stays for spaces without the exo_m1 entitlement). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…388] The ExO export tasks previously had no unit coverage — every existing test omits `plainClient` and `includeExperienceOrchestration`, so all six ExO tasks were always skipped. Add tests that exercise the code AIS-388 changed: - ExO entities are skipped by default (flag off) - each entity is fetched via its non-deprecated endpoint (component / experienceTemplate / experienceFragment, not the deprecated componentType / template / fragment) and lands on its renamed field - deprecated endpoints are never called - cursor pagination follows `pages.next` and aggregates across pages - the target environmentId is threaded through to ExO endpoints - a failing endpoint degrades to [] without aborting the other entities Verified by mutation: reverting an endpoint to its deprecated name turns these tests red. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The exo branch predates Renovate setup on main (#2331), so renovate.json was absent, failing the renovate-usage CI check. Restore the same config used on main, extending local>contentful/renovate-config. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This reverts commit 52c7e7d. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Author
|
Governance check just failing until #2331 is consumed in the exo branch 🙂 |
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
1 participant
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
Updates
contentful-exportto be compatible with the latest ExO entity naming (PROD-2918, AIS-388).Three ExO entity types were renamed per the feature naming recommendations:
Changes
lib/tasks/get-space-data.js):componentTypes→componentsfragments→experienceFragmentstemplates→experienceTemplatestypes.d.ts): updatedContentfulExportFieldunion.Fetching Component Types data→Fetching Components data,Fetching Templates data→Fetching Experience Templates data,Fetching Fragments data→Fetching Experience Fragments data, and matching skip-warning messages.lib/usageParams.js):include-experience-orchestrationdescribe string.designTokensandexperiencesare unaffected. The underlying SDK method names (componentType.getMany,template.getMany,fragment.getMany) are unchanged — only the output field names and display strings changed.Breaking change
This renames exported JSON schema fields — a breaking change. Consumers of the output (e.g.
contentful-import) must update in lockstep. Coordinate with AIS-387. Needs a major semver bump; commit includesfeat!+BREAKING CHANGE:footer.Verification
npm run build(tsc typecheck + babel) — passesnpm run test:unit— 49/49 passnpm run lint— fails to load thestandardeslint config in this environment (pre-existing config-resolution issue, unrelated to these string/identifier renames)🤖 Generated with Claude Code