chore: fixup typegen for preview types (#17339)

Emyrk · web-flow · commit 15584e69ef21 · 2025-04-11T13:21:46.000-05:00
Preview types override the json marshal behavior.
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -141,6 +141,14 @@ type DynamicParametersResponse struct {
 	// TODO: Workspace tags
 }
 
+// FriendlyDiagnostic is included to guarantee it is generated in the output
+// types. This is used as the type override for `previewtypes.Diagnostic`.
+type FriendlyDiagnostic = previewtypes.FriendlyDiagnostic
+
+// NullHCLString is included to guarantee it is generated in the output
+// types. This is used as the type override for `previewtypes.HCLString`.
+type NullHCLString = previewtypes.NullHCLString
+
 func (c *Client) TemplateVersionDynamicParameters(ctx context.Context, version uuid.UUID) (*wsjson.Stream[DynamicParametersResponse, DynamicParametersRequest], error) {
 	conn, err := c.Dial(ctx, fmt.Sprintf("/api/v2/templateversions/%s/dynamic-parameters", version), nil)
 	if err != nil {
diff --git a/scripts/apitypings/main.go b/scripts/apitypings/main.go
@@ -32,10 +32,9 @@ func main() {
 	// Serpent has some types referenced in the codersdk.
 	// We want the referenced types generated.
 	referencePackages := map[string]string{
-		"github.com/coder/preview":    "",
-		"github.com/coder/serpent":    "Serpent",
-		"github.com/hashicorp/hcl/v2": "Hcl",
-		"tailscale.com/derp":          "",
+		"github.com/coder/preview/types": "Preview",
+		"github.com/coder/serpent":       "Serpent",
+		"tailscale.com/derp":             "",
 		// Conflicting name "DERPRegion"
 		"tailscale.com/tailcfg":      "Tail",
 		"tailscale.com/net/netcheck": "Netcheck",
@@ -90,8 +89,22 @@ func TypeMappings(gen *guts.GoParser) error {
 	gen.IncludeCustomDeclaration(map[string]guts.TypeOverride{
 		"github.com/coder/coder/v2/codersdk.NullTime": config.OverrideNullable(config.OverrideLiteral(bindings.KeywordString)),
 		// opt.Bool can return 'null' if unset
-		"tailscale.com/types/opt.Bool":           config.OverrideNullable(config.OverrideLiteral(bindings.KeywordBoolean)),
-		"github.com/hashicorp/hcl/v2.Expression": config.OverrideLiteral(bindings.KeywordUnknown),
+		"tailscale.com/types/opt.Bool": config.OverrideNullable(config.OverrideLiteral(bindings.KeywordBoolean)),
+		// hcl diagnostics should be cast to `preview.FriendlyDiagnostic`
+		"github.com/hashicorp/hcl/v2.Diagnostic": func() bindings.ExpressionType {
+			return bindings.Reference(bindings.Identifier{
+				Name:    "FriendlyDiagnostic",
+				Package: nil,
+				Prefix:  "",
+			})
+		},
+		"github.com/coder/preview/types.HCLString": func() bindings.ExpressionType {
+			return bindings.Reference(bindings.Identifier{
+				Name:    "NullHCLString",
+				Package: nil,
+				Prefix:  "",
+			})
+		},
 	})
 
 	err := gen.IncludeCustom(map[string]string{
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
