Skip to content

feat: omit 'undefined' when generating SSDK and @required trait is used #537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

feat: omit 'undefined' when generating SSDK and @required trait is used #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions ...t-codegen/src/main/java/software/amazon/smithy/typescript/codegen/StructureGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ final class StructureGenerator implements Runnable {
private final SymbolProvider symbolProvider;
private final TypeScriptWriter writer;
private final StructureShape shape;
private final boolean includeValidation;
private final boolean generateServerSdk;

/**
* sets 'includeValidation' to 'false' for backwards compatibility.
Expand All @@ -53,12 +53,12 @@ final class StructureGenerator implements Runnable {
SymbolProvider symbolProvider,
TypeScriptWriter writer,
StructureShape shape,
boolean includeValidation) {
boolean generateServerSdk) {
this.model = model;
this.symbolProvider = symbolProvider;
this.writer = writer;
this.shape = shape;
this.includeValidation = includeValidation;
this.generateServerSdk = generateServerSdk;
}

@Override
Expand Down Expand Up @@ -133,13 +133,13 @@ private void renderNonErrorStructure() {

StructuredMemberWriter config = new StructuredMemberWriter(
model, symbolProvider, shape.getAllMembers().values());
config.writeMembers(writer, shape);
config.writeMembers(writer, shape, generateServerSdk);
writer.closeBlock("}");
writer.write("");
renderStructureNamespace(config, includeValidation);
renderStructureNamespace(config, generateServerSdk);
}

private void renderStructureNamespace(StructuredMemberWriter structuredMemberWriter, boolean includeValidation) {
private void renderStructureNamespace(StructuredMemberWriter structuredMemberWriter, boolean generateServerSdk) {
Symbol symbol = symbolProvider.toSymbol(shape);
writer.openBlock("export namespace $L {", "}", symbol.getName(), () -> {
String objectParam = "obj";
Expand All @@ -151,7 +151,7 @@ private void renderStructureNamespace(StructuredMemberWriter structuredMemberWri
}
);

if (!includeValidation) {
if (!generateServerSdk) {
return;
}

Expand Down Expand Up @@ -219,7 +219,7 @@ private void renderErrorStructure() {
ErrorTrait errorTrait = shape.getTrait(ErrorTrait.class).orElseThrow(IllegalStateException::new);
Symbol symbol = symbolProvider.toSymbol(shape);
writer.writeShapeDocs(shape);
boolean isServerSdk = this.includeValidation;
boolean isServerSdk = this.generateServerSdk;
writer.openBlock("export class $T extends $L {", symbol, "__BaseException");
writer.write("readonly name: $1S = $1S;", shape.getId().getName());
writer.write("readonly $$fault: $1S = $1S;", errorTrait.getValue());
Expand All @@ -231,7 +231,7 @@ private void renderErrorStructure() {
// since any error interface must extend from JavaScript Error interface, message member is already
// required in the JavaScript Error interface
structuredMemberWriter.skipMembers.add("message");
structuredMemberWriter.writeMembers(writer, shape);
structuredMemberWriter.writeMembers(writer, shape, isServerSdk);
structuredMemberWriter.writeErrorConstructor(writer, shape, isServerSdk);
writer.closeBlock("}");
writer.write("");
Expand Down
4 changes: 2 additions & 2 deletions ...degen/src/main/java/software/amazon/smithy/typescript/codegen/StructuredMemberWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ final class StructuredMemberWriter {
this.members = new LinkedHashSet<>(members);
}

void writeMembers(TypeScriptWriter writer, Shape shape) {
void writeMembers(TypeScriptWriter writer, Shape shape, Boolean generateServerSdk) {
int position = -1;
for (MemberShape member : members) {
if (skipMembers.contains(member.getMemberName())) {
Expand All @@ -79,7 +79,7 @@ void writeMembers(TypeScriptWriter writer, Shape shape) {
boolean wroteDocs = !noDocs && writer.writeMemberDocs(model, member);
String memberName = getSanitizedMemberName(member);
String optionalSuffix = shape.isUnionShape() || !isRequiredMember(member) ? "?" : "";
String typeSuffix = isRequiredMember(member) ? " | undefined" : "";
String typeSuffix = isRequiredMember(member) && !generateServerSdk ? " | undefined" : "";
writer.write("${L}${L}${L}: ${T}${L};", memberPrefix, memberName, optionalSuffix,
symbolProvider.toSymbol(member), typeSuffix);

Expand Down