feat(tssdk): expose GraphQL client (#7294)

Fixes #7159

Signed-off-by: Tom Chauveau <[email protected]>

.changes/unreleased/Added-20240506-172454.yaml

@@ -0,0 +1,6 @@
+kind: Added
+body: Expose GraphQL client with getGQLClient in TypescriptSDK
+time: 2024-05-06T17:24:54.589851+02:00
+custom:
+ Author: TomChv
+ PR: "7294"

cmd/codegen/generator/typescript/templates/src/object.ts.gtpl

@@ -47,6 +47,17 @@ export class {{ .Name | QueryToClient | FormatName }} extends BaseClient {
  {{- end }}
  }
 
+ {{- /* Add custom method to main Client */ -}}
+ {{- if .Name | QueryToClient | FormatName | eq "Client" }}
+
+ /**
+ * Get the Raw GraphQL client.
+ */
+ public getGQLClient() {
+ return this._ctx.getGQLClient()
+ }
+ {{- end }}
+
  {{- /* Write methods. */ -}}
  {{- "" }}{{ range $field := .Fields }}
  {{- if Solve . }}

sdk/typescript/context/context.ts

@@ -43,6 +43,16 @@ export class Context {
  return this._client
  }
 
+ public getGQLClient(): GraphQLClient {
+ if (!this._client) {
+ throw new Error(
+ "graphQL connection not established yet, please use it inside a connect or connection function.",
+ )
+ }
+
+ return this._client
+ }
+
  /**
  * Close the connection and the engine if this one was started by the node
  * SDK.

sdk/typescript/test/connect.spec.ts

@@ -14,6 +14,27 @@ import * as bin from "../provisioning/bin.js"
 import { CLI_VERSION } from "../provisioning/default.js"
 
 describe("TypeScript default client", function () {
+ it("Should allow using the GQL client", async function () {
+ this.timeout(60000)
+
+ await connection(async () => {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ const result = await dag.getGQLClient().request<any>(`
+ query {
+ container {
+ from(address: "alpine") {
+ withExec(args: ["echo", "hello", "world"]) {
+ stdout
+ }
+ }
+ }
+ } 
+ `)
+
+ assert.equal(result.container.from.withExec.stdout, "hello world\n")
+ })
+ })
+
  it("Should use the default client and close connection on call to close", async function () {
  this.timeout(60000)