Add ts tests

encoding/typescript/gen.go

@@ -64,6 +64,9 @@ func GenerateTypes(sch thema.Schema, cfg *TypeConfig) (*ast.File, error) {
 	}
 	if cfg.CuetsyConfig == nil {
 		cfg.CuetsyConfig = &cuetsy.Config{
+			ImportMapper: func(_ string) (string, error) {
+				return "", nil
+			},
 			Export: true,
 		}
 	}

encoding/typescript/ts_test.go

@@ -0,0 +1,62 @@
+package typescript
+
+import (
+	"github.com/stretchr/testify/require"
+	"testing"
+
+	"cuelang.org/go/cue/cuecontext"
+	"github.com/grafana/thema"
+	"github.com/grafana/thema/internal/txtartest/bindlin"
+	"github.com/grafana/thema/internal/txtartest/vanilla"
+)
+
+func TestGenerate(t *testing.T) {
+	test := vanilla.TxTarTest{
+		Root:    "../../testdata/lineage",
+		Name:    "encoding/typescript/TestGenerate",
+		ThemaFS: thema.CueJointFS,
+		Skip: map[string]string{
+			"lineage/refexscalar": "bounds constraints are not supported as they lack a direct typescript equivalent",
+			"lineage/refscalar":   "bounds constraints are not supported as they lack a direct typescript equivalent",
+		},
+	}
+
+	ctx := cuecontext.New()
+	rt := thema.NewRuntime(ctx)
+
+	table := []struct {
+		name string
+		cfg  *TypeConfig
+	}{
+		{
+			name: "nilcfg",
+			cfg:  nil,
+		},
+		{},
+	}
+
+	for _, tb := range table {
+		t.Run(tb.name, func(t *testing.T) {
+			testcpy := test
+			testcpy.Name += "/" + tb.name
+			testcpy.Run(t, func(tc *vanilla.Test) {
+				if testing.Short() && tc.HasTag("slow") {
+					t.Skip("case is tagged #slow, skipping for -short")
+				}
+				lin, err := bindlin.BindTxtarLineage(tc, rt)
+				if err != nil {
+					tc.Fatal(err)
+				}
+
+				for sch := lin.First(); sch != nil; sch = sch.Successor() {
+					f, err := GenerateTypes(sch, tb.cfg)
+					if err != nil {
+						tc.Fatal(err)
+					}
+					_, err = tc.Write([]byte(f.String())) //nolint:gosec,errcheck
+					require.NoError(t, err)
+				}
+			})
+		})
+	}
+}

testdata/lineage/basic-multiversion.txtar

@@ -1840,3 +1840,59 @@ type Basicmultiversion struct {
 
 // BasicmultiversionWithDefault defines model for Basicmultiversion.WithDefault.
 type BasicmultiversionWithDefault string
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Basic-Multiversion {
+  init: string;
+}
+export interface Basic-Multiversion {
+  init: string;
+  optional?: number;
+}
+export interface Basic-Multiversion {
+  init: string;
+  optional?: number;
+  withDefault?: ('foo' | 'bar');
+}
+
+export const defaultBasic-Multiversion: Partial<Basic-Multiversion> = {
+  withDefault: 'foo',
+};
+export interface Basic-Multiversion {
+  init: string;
+  optional?: number;
+  withDefault?: ('foo' | 'bar' | 'baz');
+}
+
+export const defaultBasic-Multiversion: Partial<Basic-Multiversion> = {
+  withDefault: 'foo',
+};
+export interface Basic-Multiversion {
+  optional?: number;
+  renamed: string;
+  withDefault: ('foo' | 'bar' | 'baz');
+}
+
+export const defaultBasic-Multiversion: Partial<Basic-Multiversion> = {
+  withDefault: 'bar',
+};
+export interface Basic-Multiversion {
+  optional?: number;
+  renamed: string;
+  withDefault: ('foo' | 'bar' | 'baz' | 'bing');
+}
+
+export const defaultBasic-Multiversion: Partial<Basic-Multiversion> = {
+  withDefault: 'bar',
+};
+export interface Basic-Multiversion {
+  optional?: number;
+  toObj: {
+    init: string;
+  };
+  withDefault: ('foo' | 'bar' | 'baz' | 'bing');
+}
+
+export const defaultBasic-Multiversion: Partial<Basic-Multiversion> = {
+  withDefault: 'bar',
+};

testdata/lineage/embedexref.txtar

@@ -189,3 +189,9 @@ type EmbedexrefRefField2 int
 Schema count: 1
 Schema versions: 0.0
 Lenses count: 0
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Embedexref {
+  refField1: string;
+  refField2: 42;
+}

testdata/lineage/embedref.txtar

@@ -314,3 +314,9 @@ type Embedref struct {
 
 // EmbedrefRefField2 defines model for Embedref.RefField2.
 type EmbedrefRefField2 int
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Embedref {
+  refField1: string;
+  refField2: 42;
+}

testdata/lineage/expand.txtar

@@ -687,3 +687,30 @@ type Expand struct {
 
 // ExpandWithDefault defines model for Expand.WithDefault.
 type ExpandWithDefault string
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Expand {
+  init: string;
+}
+export interface Expand {
+  init: string;
+  optional?: number;
+}
+export interface Expand {
+  init: string;
+  optional?: number;
+  withDefault?: ('foo' | 'bar');
+}
+
+export const defaultExpand: Partial<Expand> = {
+  withDefault: 'foo',
+};
+export interface Expand {
+  init: string;
+  optional?: number;
+  withDefault?: ('foo' | 'bar' | 'baz');
+}
+
+export const defaultExpand: Partial<Expand> = {
+  withDefault: 'foo',
+};

testdata/lineage/go-any.txtar

@@ -314,3 +314,14 @@ type Goany struct {
 	} `json:"structVal"`
 	Value any `json:"value"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Go-Any {
+  emptyMap: Record<string, unknown>;
+  optional?: (string | boolean);
+  structVal: {
+    inner: (string | number);
+    innerOptional?: unknown;
+  };
+  value: (string | boolean);
+}

testdata/lineage/join/embedref.txtar

@@ -218,3 +218,10 @@ type Embedref struct {
 
 // EmbedrefRefField2 defines model for Embedref.RefField2.
 type EmbedrefRefField2 int
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Embedref {
+  foo: string;
+  refField1: string;
+  refField2: 42;
+}

testdata/lineage/join/exref.txtar

@@ -268,3 +268,14 @@ type Exref struct {
 	Ref    ExRef    `json:"ref"`
 	Refdef ExRefDef `json:"refdef"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Exref {
+  foo: string;
+  ref: {
+    normalField: string;
+  };
+  refdef: {
+    defField: string;
+  };
+}

testdata/lineage/join/nearoptional.txtar

@@ -276,3 +276,20 @@ type Nearoptional struct {
 	} `json:"astruct,omitempty"`
 	Notoptional int32 `json:"notoptional"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Nearoptional {
+  abool?: boolean;
+  abytes?: string;
+  alist?: Array<string>;
+  anint?: number;
+  astring?: string;
+  astruct?: {
+    nested: string;
+  };
+  notoptional: number;
+}
+
+export const defaultNearoptional: Partial<Nearoptional> = {
+  alist: [],
+};

testdata/lineage/join/onenone.txtar

@@ -122,3 +122,8 @@ package onenone
 
 // Foo defines model for foo.
 type Foo = string
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Onenone {
+  foo: string;
+}

testdata/lineage/join/oneone.txtar

@@ -149,3 +149,9 @@ type Oneone struct {
 	Bar string `json:"bar"`
 	Foo string `json:"foo"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Oneone {
+  bar: string;
+  foo: string;
+}

testdata/lineage/join/onestruct.txtar

@@ -185,3 +185,11 @@ type AField struct {
 
 // Foo defines model for foo.
 type Foo = string
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Onestruct {
+  aField: {
+    defLitField: string;
+  };
+  foo: string;
+}

testdata/lineage/join/repeat.txtar

@@ -123,3 +123,8 @@ package repeat
 type Repeat struct {
 	Foo string `json:"foo"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Repeat {
+  foo: string;
+}

testdata/lineage/maps.txtar

@@ -605,3 +605,24 @@ type ValPrimitive map[string]bool
 type ValStruct map[string]struct {
 	Foo string `json:"foo"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Maps {
+  aComplexMap?: {
+    foo: string;
+  };
+  optValList?: Record<string, Array<string>>;
+  optValPrimitive?: Record<string, boolean>;
+  optValStruct?: Record<string, {
+  foo: string,
+}>;
+  refValue: Record<string, {
+  foo: string,
+}>;
+  someField: Record<string, boolean>;
+  valList: Record<string, Array<string>>;
+  valPrimitive: Record<string, boolean>;
+  valStruct: Record<string, {
+  foo: string,
+}>;
+}

testdata/lineage/nearoptional.txtar

@@ -294,3 +294,20 @@ type Nearoptional struct {
 	} `json:"astruct,omitempty"`
 	Notoptional int32 `json:"notoptional"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Nearoptional {
+  abool?: boolean;
+  abytes?: string;
+  alist?: Array<string>;
+  anint?: number;
+  astring?: string;
+  astruct?: {
+    nested: string;
+  };
+  notoptional: number;
+}
+
+export const defaultNearoptional: Partial<Nearoptional> = {
+  alist: [],
+};

testdata/lineage/noref.txtar

@@ -224,3 +224,8 @@ type Baz struct {
 
 // SomeField defines model for someField.
 type SomeField = string
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Noref {
+  someField: string;
+}

testdata/lineage/one-schema-versionless.txtar

@@ -119,3 +119,8 @@ package oneschemaversionless
 
 // Firstfield defines model for firstfield.
 type Firstfield = string
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface One-Schema-Versionless {
+  firstfield: string;
+}

testdata/lineage/optional.txtar

@@ -18,3 +18,19 @@ schemas: [{
 	}
 }]
 lenses: []
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Optional {
+  abool?: boolean;
+  abytes?: string;
+  alist?: Array<string>;
+  anint?: number;
+  astring?: string;
+  astruct?: {
+    nested: string;
+  };
+}
+
+export const defaultOptional: Partial<Optional> = {
+  alist: [],
+};

testdata/lineage/refexstruct.txtar

@@ -212,3 +212,12 @@ type Baz struct {
 type Refexstruct struct {
 	ABaz Baz `json:"aBaz"`
 }
+
+-- out/encoding/typescript/TestGenerate/nilcfg --
+export interface Refexstruct {
+  aBaz: {
+    run: string;
+    tell: string;
+    dat: number;
+  };
+}