coder · Emyrk · Dec 11, 2024 · Nov 26, 2024 · Nov 26, 2024 · Nov 26, 2024
diff --git a/Makefile b/Makefile
@@ -640,7 +640,9 @@ vpn/vpn.pb.go: vpn/vpn.proto
 		./vpn/vpn.proto
 
 site/src/api/typesGenerated.ts: $(wildcard scripts/apitypings/*) $(shell find ./codersdk $(FIND_EXCLUSIONS) -type f -name '*.go')
-	go run ./scripts/apitypings/ > $@
+	# -C sets the directory for the go run command
+	go run -C ./scripts/apitypings main.go > $@
+	(cd ./site && npx biome format --write ./src/api/typesGenerated.ts)
 	./scripts/pnpm_install.sh
 
 site/e2e/provisionerGenerated.ts: provisionerd/proto/provisionerd.pb.go provisionersdk/proto/provisioner.pb.go

diff --git a/codersdk/healthsdk/healthsdk.go b/codersdk/healthsdk/healthsdk.go
@@ -131,7 +131,7 @@ func (r *HealthcheckReport) Summarize(docsURL string) []string {
 
 // BaseReport holds fields common to various health reports.
 type BaseReport struct {
-	Error     *string          `json:"error"`
+	Error     *string          `json:"error,omitempty"`
 	Severity  health.Severity  `json:"severity" enums:"ok,warning,error"`
 	Warnings  []health.Message `json:"warnings"`
 	Dismissed bool             `json:"dismissed"`
@@ -185,8 +185,8 @@ type DERPHealthReport struct {
 	// Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead.
 	Healthy      bool                      `json:"healthy"`
 	Regions      map[int]*DERPRegionReport `json:"regions"`
-	Netcheck     *netcheck.Report          `json:"netcheck"`
-	NetcheckErr  *string                   `json:"netcheck_err"`
+	Netcheck     *netcheck.Report          `json:"netcheck,omitempty"`
+	NetcheckErr  *string                   `json:"netcheck_err,omitempty"`
 	NetcheckLogs []string                  `json:"netcheck_logs"`
 }
 
@@ -196,7 +196,7 @@ type DERPRegionReport struct {
 	Healthy     bool                `json:"healthy"`
 	Severity    health.Severity     `json:"severity" enums:"ok,warning,error"`
 	Warnings    []health.Message    `json:"warnings"`
-	Error       *string             `json:"error"`
+	Error       *string             `json:"error,omitempty"`
 	Region      *tailcfg.DERPRegion `json:"region"`
 	NodeReports []*DERPNodeReport   `json:"node_reports"`
 }
@@ -207,7 +207,7 @@ type DERPNodeReport struct {
 	Healthy  bool             `json:"healthy"`
 	Severity health.Severity  `json:"severity" enums:"ok,warning,error"`
 	Warnings []health.Message `json:"warnings"`
-	Error    *string          `json:"error"`
+	Error    *string          `json:"error,omitempty"`
 
 	Node *tailcfg.DERPNode `json:"node"`
 

diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -157,13 +157,13 @@ type CreateTemplateRequest struct {
 	// AllowUserAutostart allows users to set a schedule for autostarting their
 	// workspace. By default this is true. This can only be disabled when using
 	// an enterprise license.
-	AllowUserAutostart *bool `json:"allow_user_autostart"`
+	AllowUserAutostart *bool `json:"allow_user_autostart,omitempty"`
 
 	// AllowUserAutostop allows users to set a custom workspace TTL to use in
 	// place of the template's DefaultTTL field. By default this is true. If
 	// false, the DefaultTTL will always be used. This can only be disabled when
 	// using an enterprise license.
-	AllowUserAutostop *bool `json:"allow_user_autostop"`
+	AllowUserAutostop *bool `json:"allow_user_autostop,omitempty"`
 
 	// FailureTTLMillis allows optionally specifying the max lifetime before Coder
 	// stops all resources for failed workspaces created from this template.
@@ -202,7 +202,7 @@ type CreateWorkspaceRequest struct {
 	// TemplateVersionID can be used to specify a specific version of a template for creating the workspace.
 	TemplateVersionID uuid.UUID `json:"template_version_id,omitempty" validate:"required_without=TemplateID,excluded_with=TemplateID" format:"uuid"`
 	Name              string    `json:"name" validate:"workspace_name,required"`
-	AutostartSchedule *string   `json:"autostart_schedule"`
+	AutostartSchedule *string   `json:"autostart_schedule,omitempty"`
 	TTLMillis         *int64    `json:"ttl_ms,omitempty"`
 	// RichParameterValues allows for additional parameters to be provided
 	// during the initial provision.

diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -242,14 +242,14 @@ type UpdateTemplateMeta struct {
 	// any new workspaces from using this template.
 	// If passed an empty string, will remove the deprecated message, making
 	// the template usable for new workspaces again.
-	DeprecationMessage *string `json:"deprecation_message"`
+	DeprecationMessage *string `json:"deprecation_message,omitempty"`
 	// DisableEveryoneGroupAccess allows optionally disabling the default
 	// behavior of granting the 'everyone' group access to use the template.
 	// If this is set to true, the template will not be available to all users,
 	// and must be explicitly granted to users or groups in the permissions settings
 	// of the template.
 	DisableEveryoneGroupAccess bool                          `json:"disable_everyone_group_access"`
-	MaxPortShareLevel          *WorkspaceAgentPortShareLevel `json:"max_port_share_level"`
+	MaxPortShareLevel          *WorkspaceAgentPortShareLevel `json:"max_port_share_level,omitempty"`
 }
 
 type TemplateExample struct {

diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -260,7 +260,7 @@ type UpdateWorkspaceAutostartRequest struct {
 	// Schedule is expected to be of the form `CRON_TZ=<IANA Timezone> <min> <hour> * * <dow>`
 	// Example: `CRON_TZ=US/Central 30 9 * * 1-5` represents 0930 in the timezone US/Central
 	// on weekdays (Mon-Fri). `CRON_TZ` defaults to UTC if not present.
-	Schedule *string `json:"schedule"`
+	Schedule *string `json:"schedule,omitempty"`
 }
 
 // UpdateWorkspaceAutostart sets the autostart schedule for workspace by id.

diff --git a/go.mod b/go.mod
@@ -182,7 +182,7 @@ require (
 	golang.org/x/sync v0.10.0
 	golang.org/x/sys v0.28.0
 	golang.org/x/term v0.27.0
-	golang.org/x/text v0.21.0
+	golang.org/x/text v0.21.0 // indirect
 	golang.org/x/tools v0.28.0
 	golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da
 	google.golang.org/api v0.210.0

diff --git a/scripts/apitypings/README.md b/scripts/apitypings/README.md
@@ -2,37 +2,4 @@
 
 This main.go generates typescript types from the codersdk types in Go.
 
-# Features
-
-- Supports Go types
-  - [x] Basics (string/int/etc)
-  - [x] Maps
-  - [x] Slices
-  - [x] Enums
-  - [x] Pointers
-  - [ ] External Types (uses `any` atm)
-    - Some custom external types are hardcoded in (eg: time.Time)
-
-## Type overrides
-
-```golang
-type Foo struct {
-	// Force the typescript type to be a number
-	CreatedAt time.Duration `json:"created_at" typescript:"number"`
-}
-```
-
-## Ignore Types
-
-Do not generate ignored types.
-
-```golang
-// @typescript-ignore InternalType
-type InternalType struct {
-	// ...
-}
-```
-
-# Future Ideas
-
-- Use a yaml config for overriding certain types
+Uses it's own `go.mod` to exclude goja deps from the main go.mod.
diff --git a/scripts/apitypings/go.mod b/scripts/apitypings/go.mod
@@ -0,0 +1,135 @@
+module github.com/coder/coder/scripts/apitypings
+
+go 1.23.1
+
+toolchain go1.23.3
+
+require (
+	github.com/coder/coder/v2 v2.0.0-00010101000000-000000000000
+	github.com/coder/guts v0.0.0-20241209221220-f181da87c0bc
+	github.com/coder/serpent v0.10.0
+	github.com/stretchr/testify v1.10.0
+)
+
+require (
+	cdr.dev/slog v1.6.2-0.20241112041820-0ec81e6e67bb // indirect
+	github.com/DataDog/appsec-internal-go v1.8.0 // indirect
+	github.com/DataDog/datadog-agent/pkg/obfuscate v0.48.0 // indirect
+	github.com/DataDog/datadog-agent/pkg/remoteconfig/state v0.57.0 // indirect
+	github.com/DataDog/datadog-go/v5 v5.3.0 // indirect
+	github.com/DataDog/go-libddwaf/v3 v3.4.0 // indirect
+	github.com/DataDog/go-tuf v1.1.0-0.5.2 // indirect
+	github.com/DataDog/gostackparse v0.7.0 // indirect
+	github.com/DataDog/sketches-go v1.4.5 // indirect
+	github.com/Microsoft/go-winio v0.6.2 // indirect
+	github.com/agext/levenshtein v1.2.3 // indirect
+	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
+	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/coder/pretty v0.0.0-20230908205945-e89ba86370e0 // indirect
+	github.com/coder/terraform-provider-coder v1.0.2 // indirect
+	github.com/coreos/go-oidc/v3 v3.11.0 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/dlclark/regexp2 v1.11.4 // indirect
+	github.com/dop251/goja v0.0.0-20241024094426-79f3a7efcdbd // indirect
+	github.com/dustin/go-humanize v1.0.1 // indirect
+	github.com/eapache/queue/v2 v2.0.0-20230407133247-75960ed334e4 // indirect
+	github.com/ebitengine/purego v0.6.0-alpha.5 // indirect
+	github.com/fatih/color v1.18.0 // indirect
+	github.com/fatih/structtag v1.2.0 // indirect
+	github.com/go-chi/chi/v5 v5.1.0 // indirect
+	github.com/go-jose/go-jose/v4 v4.0.2 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-sourcemap/sourcemap v2.1.3+incompatible // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/pprof v0.0.0-20230817174616-7a8ec2ada47b // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 // indirect
+	github.com/hashicorp/errwrap v1.1.0 // indirect
+	github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect
+	github.com/hashicorp/go-hclog v1.6.3 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
+	github.com/hashicorp/go-secure-stdlib/parseutil v0.1.7 // indirect
+	github.com/hashicorp/go-secure-stdlib/strutil v0.1.2 // indirect
+	github.com/hashicorp/go-sockaddr v1.0.2 // indirect
+	github.com/hashicorp/go-uuid v1.0.3 // indirect
+	github.com/hashicorp/go-version v1.7.0 // indirect
+	github.com/hashicorp/hcl/v2 v2.23.0 // indirect
+	github.com/hashicorp/logutils v1.0.0 // indirect
+	github.com/hashicorp/terraform-plugin-go v0.23.0 // indirect
+	github.com/hashicorp/terraform-plugin-log v0.9.0 // indirect
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.34.0 // indirect
+	github.com/hashicorp/yamux v0.1.2 // indirect
+	github.com/klauspost/compress v1.17.9 // indirect
+	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mitchellh/copystructure v1.2.0 // indirect
+	github.com/mitchellh/go-testing-interface v1.14.1 // indirect
+	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
+	github.com/mitchellh/mapstructure v1.5.1-0.20231216201459-8508981c8b6c // indirect
+	github.com/mitchellh/reflectwalk v1.0.2 // indirect
+	github.com/moby/moby v27.3.1+incompatible // indirect
+	github.com/muesli/termenv v0.15.3-0.20240618155329-98d742f6907a // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/outcaste-io/ristretto v0.2.3 // indirect
+	github.com/philhofer/fwd v1.1.3-0.20240612014219-fbbf4953d986 // indirect
+	github.com/pion/transport/v2 v2.2.10 // indirect
+	github.com/pion/udp v0.1.4 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
+	github.com/prometheus/client_golang v1.20.5 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.61.0 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/richardartoul/molecule v1.0.1-0.20240531184615-7ca0df43c0b3 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
+	github.com/robfig/cron/v3 v3.0.1 // indirect
+	github.com/ryanuber/go-glob v1.0.0 // indirect
+	github.com/secure-systems-lab/go-securesystemslib v0.7.0 // indirect
+	github.com/spaolacci/murmur3 v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/tinylib/msgp v1.2.1 // indirect
+	github.com/valyala/fasthttp v1.56.0 // indirect
+	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
+	github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
+	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
+	github.com/zclconf/go-cty v1.15.0 // indirect
+	github.com/zeebo/errs v1.3.0 // indirect
+	go.nhat.io/otelsql v0.14.0 // indirect
+	go.opentelemetry.io/otel v1.30.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.29.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.28.0 // indirect
+	go.opentelemetry.io/otel/metric v1.30.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.30.0 // indirect
+	go.opentelemetry.io/otel/trace v1.30.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
+	go.uber.org/atomic v1.11.0 // indirect
+	golang.org/x/crypto v0.30.0 // indirect
+	golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa // indirect
+	golang.org/x/mod v0.22.0 // indirect
+	golang.org/x/net v0.32.0 // indirect
+	golang.org/x/oauth2 v0.24.0 // indirect
+	golang.org/x/sync v0.10.0 // indirect
+	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/term v0.27.0 // indirect
+	golang.org/x/text v0.21.0 // indirect
+	golang.org/x/time v0.8.0 // indirect
+	golang.org/x/tools v0.28.0 // indirect
+	golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect
+	google.golang.org/appengine v1.6.8 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20241113202542-65e8d215514f // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20241118233622-e639e219e697 // indirect
+	google.golang.org/grpc v1.68.0 // indirect
+	google.golang.org/protobuf v1.35.2 // indirect
+	gopkg.in/DataDog/dd-trace-go.v1 v1.69.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	nhooyr.io/websocket v1.8.7 // indirect
+	storj.io/drpc v0.0.33 // indirect
+)
+
+replace github.com/coder/coder/v2 => ../../