Feat: Remove API Family Layer (@W-18726388@)#425
Merged
joeluong-sfcc merged 4 commits intofeature/oasfrom Jul 7, 2025
Merged
Conversation
vcua-mobify
approved these changes
Jul 2, 2025
Contributor
vcua-mobify
left a comment
There was a problem hiding this comment.
LGTM
I ran the generator and have verified that the namespaces are no longer there in the generated APIs. APIs like ShopperContext and Catalog which in the past had naming collisions did not have any.
alexvuong
approved these changes
Jul 2, 2025
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.
The intention of this PR was to remove the API family layer, however, since the OAS commerce SDK is modeled after the OAS Isomorphic SDK, the current version of the OAS SDK is already implemented without the API family layer, without any typescript naming collision issues.
This PR removes the namespace surrounding all the API classes, as this is redundant after introducing the
<apiName>Typesnamespace, such asShopperProductsTypesorShopperLoginTypes, which solves the same problem of preventing naming collisions. This is much more straightforward so you can callShopperLoginwithout needing to useShopperLogin.ShopperLoginExample of what the top level
index.tsfile looks like. As you can see, we do not export under API family namespace and export the classes directly.