feat: Support map types for codersdk typescript gen

Emyrk · Emyrk · commit 9f3e8e4fe181 · 2022-05-12T09:08:45.000-05:00
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
@@ -183,6 +183,28 @@ func (g *Generator) generateAll() (*TypescriptTypes, error) {
 				// type <Name> string
 				// These are enums. Store to expand later.
 				enums[obj.Name()] = obj
+			case *types.Map:
+				// Declared maps that are not structs are still valid codersdk objects.
+				// Handle them custom by calling 'typescriptType' directly instead of
+				// iterating through each struct field.
+				// These types support no json/typescript tags.
+				// These are **NOT** enums, as a map in Go would never be used for an enum.
+				ts, err := g.typescriptType(obj.Type().Underlying())
+				if err != nil {
+					return nil, xerrors.Errorf("(map) generate %q: %w", obj.Name(), err)
+				}
+
+				var str strings.Builder
+				_, _ = str.WriteString(g.posLine(obj))
+				if ts.AboveTypeLine != "" {
+					str.WriteString(ts.AboveTypeLine)
+					str.WriteRune('\n')
+				}
+				// Use similar output syntax to enums.
+				str.WriteString(fmt.Sprintf("export type %s = %s\n", obj.Name(), ts.ValueType))
+				structs[obj.Name()] = str.String()
+			case *types.Array, *types.Slice:
+				// TODO: @emyrk if you need this, follow the same design as "*types.Map" case.
 			}
 		case *types.Var:
 			// TODO: Are any enums var declarations? This is also codersdk.Me.
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -334,6 +334,9 @@ export interface UserPermissionCheckRequest {
   readonly checks: Record<string, UserPermissionCheck>
 }
 
+// From codersdk/users.go:79:6
+export type UserPermissionCheckResponse = Record<string, boolean>
+
 // From codersdk/users.go:74:6
 export interface UserRoles {
   readonly roles: string[]

Original file line number	Diff line number	Diff line change
`@@ -334,6 +334,9 @@ export interface UserPermissionCheckRequest {`
`334`	`334`	`readonly checks: Record<string, UserPermissionCheck>`
`335`	`335`	`}`
`336`	`336`
	`337`	`+// From codersdk/users.go:79:6`
	`338`	`+export type UserPermissionCheckResponse = Record<string, boolean>`
	`339`	`+`
`337`	`340`	`// From codersdk/users.go:74:6`
`338`	`341`	`export interface UserRoles {`
`339`	`342`	`readonly roles: string[]`