feat: Express embedded structs via extends in TypeScript

mafredri · mafredri · commit c04a70001da9 · 2022-05-06T09:05:37.000Z
diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -73,7 +73,7 @@ func (c *Client) UpdateActiveTemplateVersion(ctx context.Context, template uuid.
 // TemplateVersionsByTemplate.
 type TemplateVersionsByTemplateRequest struct {
 	TemplateID uuid.UUID `json:"template_id" validate:"required"`
-	Pagination `json:"pagination"`
+	Pagination
 }
 
 // TemplateVersionsByTemplate lists versions associated with a template.
diff --git a/codersdk/users.go b/codersdk/users.go
@@ -23,8 +23,8 @@ const (
 type UsersRequest struct {
 	Search string `json:"search"`
 	// Filter users by status
-	Status     string `json:"status"`
-	Pagination `json:"pagination"`
+	Status string `json:"status"`
+	Pagination
 }
 
 // User represents a user in Coder.
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
@@ -237,10 +237,28 @@ func (g *Generator) posLine(obj types.Object) string {
 func (g *Generator) buildStruct(obj types.Object, st *types.Struct) (string, error) {
 	var s strings.Builder
 	_, _ = s.WriteString(g.posLine(obj))
+	_, _ = s.WriteString(fmt.Sprintf("export interface %s ", obj.Name()))
 
-	_, _ = s.WriteString(fmt.Sprintf("export interface %s {\n", obj.Name()))
+	// Handle named embedded structs in the codersdk package via extension.
+	var extends []string
+	extendedFields := make(map[int]bool)
+	for i := 0; i < st.NumFields(); i++ {
+		field := st.Field(i)
+		if field.Embedded() && field.Pkg().Name() == "codersdk" {
+			extendedFields[i] = true
+			extends = append(extends, field.Name())
+		}
+	}
+	if len(extends) > 0 {
+		_, _ = s.WriteString(fmt.Sprintf("extends %s ", strings.Join(extends, ", ")))
+	}
+
+	_, _ = s.WriteString("{\n")
 	// For each field in the struct, we print 1 line of the typescript interface
 	for i := 0; i < st.NumFields(); i++ {
+		if extendedFields[i] {
+			continue
+		}
 		field := st.Field(i)
 		tag := reflect.StructTag(st.Tag(i))
 
@@ -326,7 +344,7 @@ func (g *Generator) typescriptType(ty types.Type) (TypescriptType, error) {
 		return TypescriptType{
 			ValueType: "any",
 			AboveTypeLine: fmt.Sprintf("%s\n%s",
-				indentedComment("Embedded struct, please fix by naming it"),
+				indentedComment("Embedded anonymous struct, please fix by naming it"),
 				indentedComment("eslint-disable-next-line @typescript-eslint/no-explicit-any"),
 			),
 		}, nil
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -258,9 +258,8 @@ export interface TemplateVersionParameterSchema {
 }
 
 // From codersdk/templates.go:74:6
-export interface TemplateVersionsByTemplateRequest {
+export interface TemplateVersionsByTemplateRequest extends Pagination {
   readonly template_id: string
-  readonly pagination: Pagination
 }
 
 // From codersdk/templates.go:28:6
@@ -311,10 +310,9 @@ export interface UserRoles {
 }
 
 // From codersdk/users.go:23:6
-export interface UsersRequest {
+export interface UsersRequest extends Pagination {
   readonly search: string
   readonly status: string
-  readonly pagination: Pagination
 }
 
 // From codersdk/workspaces.go:18:6

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ func (c *Client) UpdateActiveTemplateVersion(ctx context.Context, template uuid.`
`73`	`73`	`// TemplateVersionsByTemplate.`
`74`	`74`	`type TemplateVersionsByTemplateRequest struct {`
`75`	`75`	TemplateID uuid.UUID `json:"template_id" validate:"required"`
`76`		- Pagination `json:"pagination"`
	`76`	`+ Pagination`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`// TemplateVersionsByTemplate lists versions associated with a template.`
Original file line number	Diff line number	Diff line change
`@@ -258,9 +258,8 @@ export interface TemplateVersionParameterSchema {`
`258`	`258`	`}`
`259`	`259`
`260`	`260`	`// From codersdk/templates.go:74:6`
`261`		`-export interface TemplateVersionsByTemplateRequest {`
	`261`	`+export interface TemplateVersionsByTemplateRequest extends Pagination {`
`262`	`262`	`readonly template_id: string`
`263`		`- readonly pagination: Pagination`
`264`	`263`	`}`
`265`	`264`
`266`	`265`	`// From codersdk/templates.go:28:6`
`@@ -311,10 +310,9 @@ export interface UserRoles {`
`311`	`310`	`}`
`312`	`311`
`313`	`312`	`// From codersdk/users.go:23:6`
`314`		`-export interface UsersRequest {`
	`313`	`+export interface UsersRequest extends Pagination {`
`315`	`314`	`readonly search: string`
`316`	`315`	`readonly status: string`
`317`		`- readonly pagination: Pagination`
`318`	`316`	`}`
`319`	`317`
`320`	`318`	`// From codersdk/workspaces.go:18:6`