refactor(cosmosgen): wire ts generic template (#4725)

julienrbrt · web-flow · commit f7398b8925c1 · 2025-06-11T19:59:58.000Z
diff --git a/changelog.md b/changelog.md
@@ -9,7 +9,7 @@
 
 ### Fixes
 
-- [#4691](https://github.com/ignite/cli/pull/4691), [#4706](https://github.com/ignite/cli/pull/4706) Fix ts-client query template and solely Go template for `ts-client` generation.
+- [#4691](https://github.com/ignite/cli/pull/4691), [#4706](https://github.com/ignite/cli/pull/4706), [#4725](https://github.com/ignite/cli/pull/4725) Fix ts-client query template and solely Go template for `ts-client` generation.
 
 ## [`v29.0.0`](https://github.com/ignite/cli/releases/tag/v29.0.0)
 
diff --git a/ignite/pkg/cosmosanalysis/module/module.go b/ignite/pkg/cosmosanalysis/module/module.go
@@ -58,6 +58,9 @@ type HTTPQuery struct {
 	// Name of the RPC func.
 	Name string `json:"name,omitempty"`
 
+	// RequestType is the type of the request.
+	RequestType string `json:"request_type,omitempty"`
+
 	// ResponseType is the type of the response.
 	ResponseType string `json:"response_type,omitempty"`
 
@@ -303,6 +306,7 @@ func (d *moduleDiscoverer) discover(pkg protoanalysis.Package) (Module, error) {
 					Rules:        q.HTTPRules,
 					Paginated:    isPaginated,
 					FilePath:     pkgmsg.Path,
+					RequestType:  q.RequestType,
 					ResponseType: q.ReturnsType,
 				})
 			}
diff --git a/ignite/pkg/cosmosanalysis/module/module_test.go b/ignite/pkg/cosmosanalysis/module/module_test.go
@@ -156,6 +156,7 @@ func newModule(relChainPath, goImportPath string) module.Module {
 			{
 				Name:         "MyQuery",
 				FullName:     "QueryMyQuery",
+				RequestType:  "QueryMyQueryRequest",
 				ResponseType: "QueryMyQueryResponse",
 				Rules: []protoanalysis.HTTPRule{
 					{
@@ -174,6 +175,7 @@ func newModule(relChainPath, goImportPath string) module.Module {
 			{
 				Name:         "Foo",
 				FullName:     "QueryFoo",
+				RequestType:  "QueryFooRequest",
 				ResponseType: "QueryFooResponse",
 				Rules: []protoanalysis.HTTPRule{
 					{
diff --git a/ignite/pkg/cosmosgen/template.go b/ignite/pkg/cosmosgen/template.go
@@ -2,10 +2,8 @@ package cosmosgen
 
 import (
 	"embed"
-	"fmt"
 	"os"
 	"path/filepath"
-	"sort"
 	"strings"
 	"text/template"
 
@@ -87,50 +85,17 @@ func (t templateWriter) Write(destDir, protoPath string, data interface{}) error
 			path = strings.ReplaceAll(path, "=**}", "}")
 			return path
 		},
-		"mapToTypeScriptObject": func(m map[string]string) string {
-			// mapToTypeScriptObject converts a map to a TypeScript object string.
-			// e.g. {"key1"?: value1; "key2"?: value2}
-
-			sortedKeys := make([]string, 0, len(m))
-			for k := range m {
-				sortedKeys = append(sortedKeys, k)
+		"transformParamsToUnion": func(params []string) string {
+			if len(params) == 0 {
+				return `""`
 			}
-			sort.Strings(sortedKeys)
-
-			var sb strings.Builder
-			sb.WriteString("{")
-			sb.WriteString("\n")
-			for _, k := range sortedKeys {
-				typeStr := m[k]
-
-				if strings.Contains(typeStr, ".") {
-					// TODO(@julienrbrt): parse proto types to deepest inner type and remove hardcoded pagination types.
-					if strings.Contains(typeStr, ".") {
-						if strings.EqualFold(typeStr, "cosmos.base.query.v1beta1.PageRequest") {
-							sb.WriteString(`      "pagination.key"?: string;`)
-							sb.WriteString("\n")
-							sb.WriteString(`      "pagination.offset"?: string;`)
-							sb.WriteString("\n")
-							sb.WriteString(`      "pagination.limit"?: string;`)
-							sb.WriteString("\n")
-							sb.WriteString(`      "pagination.count_total"?: boolean;`)
-							sb.WriteString("\n")
-							sb.WriteString(`      "pagination.reverse"?: boolean;`)
-							sb.WriteString("\n")
-							continue
-						}
-
-						sb.WriteString(fmt.Sprintf(`      "%s"?: any /* TODO */;`, k))
-						sb.WriteString("\n")
-						continue
-					}
-				}
-
-				sb.WriteString(fmt.Sprintf(`      "%s"?: %s;`, k, protoTypeToTypeScriptType(typeStr)))
-				sb.WriteString("\n")
+
+			var quotedParams []string
+			for _, param := range params {
+				quotedParams = append(quotedParams, `"`+param+`"`)
 			}
-			sb.WriteString("    }")
-			return sb.String()
+
+			return strings.Join(quotedParams, " | ")
 		},
 		"inc": func(i int) int {
 			return i + 1
@@ -167,31 +132,3 @@ func (t templateWriter) Write(destDir, protoPath string, data interface{}) error
 
 	return nil
 }
-
-// protoTypeToTypeScriptType converts a proto type string to a TypeScript type string.
-// e.g. "string" -> "string", "int32" -> "number", "bool" -> "boolean", "bytes" -> "Uint8Array", etc.
-func protoTypeToTypeScriptType(pt string) string {
-	isRepeated := strings.HasPrefix(pt, "repeated ")
-	if isRepeated {
-		pt = strings.TrimPrefix(pt, "repeated ")
-	}
-
-	var tsBaseType string
-	switch pt {
-	case "string":
-		tsBaseType = "string"
-	case "int32", "int64", "uint32", "uint64", "sint32", "sint64", "fixed32", "fixed64", "sfixed32", "sfixed64", "float", "double":
-		tsBaseType = "number"
-	case "bool":
-		tsBaseType = "boolean"
-	case "bytes":
-		tsBaseType = "Uint8Array"
-	default:
-		tsBaseType = pt
-	}
-
-	if isRepeated {
-		return tsBaseType + "[]"
-	}
-	return tsBaseType
-}
diff --git a/ignite/pkg/cosmosgen/templates/rest/rest.ts.tpl b/ignite/pkg/cosmosgen/templates/rest/rest.ts.tpl
@@ -1,7 +1,8 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
 {{ range .HTTPQueries }}import { {{ .ResponseType }} } from "{{ resolveFile .FilePath }}";
 {{ end }}
-// Import relevant Request types here
+{{ range .HTTPQueries }}import { {{ .RequestType }} } from "{{ resolveFile .FilePath }}";
+{{ end }}
 
 import type {SnakeCasedPropertiesDeep} from 'type-fest';
 
@@ -203,9 +204,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     {{- if (index .Rules 0).Params }}
     {{- range $i, $param := (index .Rules 0).Params }}{{ if $i }}, {{ end }}{{ $param }}: string{{- end }},
     {{- end }}{{- if gt (len (index .Rules 0).QueryFields) 0 }}
-    query?: {{ mapToTypeScriptObject (index .Rules 0).QueryFields }},
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<{{ .RequestType }}>>>,{{ transformParamsToUnion (index .Rules 0).Params }}>,
 {{- else}}
     query?: Record<string, any>,
 {{- end}}
diff --git a/ignite/pkg/cosmosgen/testdata/expected_files/ts-client/mars/rest.ts b/ignite/pkg/cosmosgen/testdata/expected_files/ts-client/mars/rest.ts
@@ -5,7 +5,12 @@ import { QueryWithPaginationResponse } from "./types/planet/mars/mars";
 import { QueryWithQueryParamsResponse } from "./types/planet/mars/mars";
 import { QueryWithQueryParamsWithPaginationResponse } from "./types/planet/mars/mars";
 
-// Import relevant Request types here
+import { QuerySimpleRequest } from "./types/planet/mars/mars";
+import { QuerySimpleParamsRequest } from "./types/planet/mars/mars";
+import { QueryWithPaginationRequest } from "./types/planet/mars/mars";
+import { QueryWithQueryParamsRequest } from "./types/planet/mars/mars";
+import { QueryWithQueryParamsWithPaginationRequest } from "./types/planet/mars/mars";
+
 
 import type {SnakeCasedPropertiesDeep} from 'type-fest';
 
@@ -241,15 +246,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
    * @request GET:/ignite/mars/query_with_params/{mytypefield}
    */
   queryQueryParamsWithPagination = (mytypefield: string,
-    query?: {
-      "pagination.key"?: string;
-      "pagination.offset"?: string;
-      "pagination.limit"?: string;
-      "pagination.count_total"?: boolean;
-      "pagination.reverse"?: boolean;
-    },
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithPaginationRequest>>>,"mytypefield">,
     params: RequestParams = {},
   ) =>
     this.request<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithPaginationResponse>>>({
@@ -265,20 +262,14 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
    *
    * @tags Query
    * @name queryQueryWithQueryParams
-   * @request GET:/ignite/mars/query_with_query_params/{mytypefield}
+   * @request GET:/ignite/mars/query_with_query_params/{mytypefield}/{mybool}
    */
-  queryQueryWithQueryParams = (mytypefield: string,
-    query?: {
-      "mybool"?: boolean;
-      "myrepeatedbool"?: boolean[];
-      "query_param"?: string;
-    },
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+  queryQueryWithQueryParams = (mytypefield: string, mybool: string,
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsRequest>>>,"mytypefield" | "mybool">,
     params: RequestParams = {},
   ) =>
     this.request<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsResponse>>>({
-      path: `/ignite/mars/query_with_query_params/${mytypefield}`,
+      path: `/ignite/mars/query_with_query_params/${mytypefield}/${mybool}`,
       method: "GET",
       query: query,
       format: "json",
@@ -293,16 +284,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
    * @request GET:/ignite/mars/query_with_query_params/{mytypefield}
    */
   queryQueryWithQueryParamsWithPagination = (mytypefield: string,
-    query?: {
-      "pagination.key"?: string;
-      "pagination.offset"?: string;
-      "pagination.limit"?: string;
-      "pagination.count_total"?: boolean;
-      "pagination.reverse"?: boolean;
-      "query_param"?: string;
-    },
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsWithPaginationRequest>>>,"mytypefield">,
     params: RequestParams = {},
   ) =>
     this.request<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsWithPaginationResponse>>>({
diff --git a/ignite/pkg/cosmosgen/testdata/testchain/proto/planet/mars/mars.proto b/ignite/pkg/cosmosgen/testdata/testchain/proto/planet/mars/mars.proto
@@ -41,7 +41,7 @@ service Query {
   }
 
   rpc QueryWithQueryParams(QueryWithQueryParamsRequest) returns (QueryWithQueryParamsResponse) {
-    option (google.api.http).get = "/ignite/mars/query_with_query_params/{mytypefield}";
+    option (google.api.http).get = "/ignite/mars/query_with_query_params/{mytypefield}/{mybool}";
   }
 
   rpc QueryWithQueryParamsWithPagination(QueryWithQueryParamsWithPaginationRequest) returns (QueryWithQueryParamsWithPaginationResponse) {
diff --git a/ignite/pkg/cosmosgen/testdata/testchain/ts-client/mars/rest.ts b/ignite/pkg/cosmosgen/testdata/testchain/ts-client/mars/rest.ts
@@ -5,7 +5,12 @@ import { QueryWithPaginationResponse } from "./types/planet/mars/mars";
 import { QueryWithQueryParamsResponse } from "./types/planet/mars/mars";
 import { QueryWithQueryParamsWithPaginationResponse } from "./types/planet/mars/mars";
 
-// Import relevant Request types here
+import { QuerySimpleRequest } from "./types/planet/mars/mars";
+import { QuerySimpleParamsRequest } from "./types/planet/mars/mars";
+import { QueryWithPaginationRequest } from "./types/planet/mars/mars";
+import { QueryWithQueryParamsRequest } from "./types/planet/mars/mars";
+import { QueryWithQueryParamsWithPaginationRequest } from "./types/planet/mars/mars";
+
 
 import type {SnakeCasedPropertiesDeep} from 'type-fest';
 
@@ -241,15 +246,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
    * @request GET:/ignite/mars/query_with_params/{mytypefield}
    */
   queryQueryParamsWithPagination = (mytypefield: string,
-    query?: {
-      "pagination.key"?: string;
-      "pagination.offset"?: string;
-      "pagination.limit"?: string;
-      "pagination.count_total"?: boolean;
-      "pagination.reverse"?: boolean;
-    },
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithPaginationRequest>>>,"mytypefield">,
     params: RequestParams = {},
   ) =>
     this.request<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithPaginationResponse>>>({
@@ -265,20 +262,14 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
    *
    * @tags Query
    * @name queryQueryWithQueryParams
-   * @request GET:/ignite/mars/query_with_query_params/{mytypefield}
+   * @request GET:/ignite/mars/query_with_query_params/{mytypefield}/{mybool}
    */
-  queryQueryWithQueryParams = (mytypefield: string,
-    query?: {
-      "mybool"?: boolean;
-      "myrepeatedbool"?: boolean[];
-      "query_param"?: string;
-    },
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+  queryQueryWithQueryParams = (mytypefield: string, mybool: string,
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsRequest>>>,"mytypefield" | "mybool">,
     params: RequestParams = {},
   ) =>
     this.request<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsResponse>>>({
-      path: `/ignite/mars/query_with_query_params/${mytypefield}`,
+      path: `/ignite/mars/query_with_query_params/${mytypefield}/${mybool}`,
       method: "GET",
       query: query,
       format: "json",
@@ -293,16 +284,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
    * @request GET:/ignite/mars/query_with_query_params/{mytypefield}
    */
   queryQueryWithQueryParamsWithPagination = (mytypefield: string,
-    query?: {
-      "pagination.key"?: string;
-      "pagination.offset"?: string;
-      "pagination.limit"?: string;
-      "pagination.count_total"?: boolean;
-      "pagination.reverse"?: boolean;
-      "query_param"?: string;
-    },
-    // query should be typed as e.g.  Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryAllBalancesRequest>>>,"address">
-    // i.e. the generated Request type as menioned above and omit the keys in Params as a union (key1 | key2 | key3 etc.)
+    query?: Omit<FlattenObject<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsWithPaginationRequest>>>,"mytypefield">,
     params: RequestParams = {},
   ) =>
     this.request<SnakeCasedPropertiesDeep<ChangeProtoToJSPrimitives<QueryWithQueryParamsWithPaginationResponse>>>({

Original file line number	Diff line number	Diff line change
`@@ -156,6 +156,7 @@ func newModule(relChainPath, goImportPath string) module.Module {`
`156`	`156`	`{`
`157`	`157`	`Name: "MyQuery",`
`158`	`158`	`FullName: "QueryMyQuery",`
	`159`	`+ RequestType: "QueryMyQueryRequest",`
`159`	`160`	`ResponseType: "QueryMyQueryResponse",`
`160`	`161`	`Rules: []protoanalysis.HTTPRule{`
`161`	`162`	`{`
`@@ -174,6 +175,7 @@ func newModule(relChainPath, goImportPath string) module.Module {`
`174`	`175`	`{`
`175`	`176`	`Name: "Foo",`
`176`	`177`	`FullName: "QueryFoo",`
	`178`	`+ RequestType: "QueryFooRequest",`
`177`	`179`	`ResponseType: "QueryFooResponse",`
`178`	`180`	`Rules: []protoanalysis.HTTPRule{`
`179`	`181`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ service Query {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`rpc QueryWithQueryParams(QueryWithQueryParamsRequest) returns (QueryWithQueryParamsResponse) {`
`44`		`- option (google.api.http).get = "/ignite/mars/query_with_query_params/{mytypefield}";`
	`44`	`+ option (google.api.http).get = "/ignite/mars/query_with_query_params/{mytypefield}/{mybool}";`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`rpc QueryWithQueryParamsWithPagination(QueryWithQueryParamsWithPaginationRequest) returns (QueryWithQueryParamsWithPaginationResponse) {`