@planqk/planqk-service-sdk 2.1.1 → 2.2.0

package/src/index.test.ts

@@ -3,7 +3,7 @@ import {test} from 'vitest'
 import 'dotenv/config'
 import {PlanqkServiceClient} from "./client";
 
-test.skip('adds 1 + 2 to equal 3', {timeout: 5 * 60 * 1000}, async () => {
+test.skip('integration test', {timeout: 5 * 60 * 1000}, async () => {
   const tokenEndpoint = process.env.TOKEN_ENDPOINT
   const serviceEndpoint = process.env.SERVICE_ENDPOINT
   const consumerKey = process.env.CONSUMER_KEY
@@ -15,29 +15,42 @@ test.skip('adds 1 + 2 to equal 3', {timeout: 5 * 60 * 1000}, async () => {
   console.log(`Consumer secret: ${consumerSecret}`)
 
   const client = new PlanqkServiceClient(serviceEndpoint!, consumerKey, consumerSecret, tokenEndpoint);
-  await client.api().healthCheck()
 
-  // prepare your input data and parameters
-  const data = {input: {a: 1, b: 2}};
-  const params = {param1: "value1", param2: "value2"};
+  let serviceExecutions = await client.api().getServiceExecutions()
+  console.log(serviceExecutions)
 
-  // execute the service
-  let serviceExecution = await client.api().execute({data, params})
+  const data = {n_coin_tosses: 2}
+  // const dataRef = {
+  //   dataPoolId: "87cb778e-ac43-11ec-b909-0242ac120002",
+  //   dataSourceDescriptorId: "87cb778e-ac43-11ec-b909-0242ac120002",
+  //   fileId: "87cb778e-ac43-11ec-b909-0242ac120002"
+  // }
+  const params = {shots: 100}
+
+  let serviceExecution = await client.api().startExecution({data, params}, {timeoutInSeconds: 60})
   console.log(serviceExecution)
 
-  // retrieve the status of a service execution
-  serviceExecution = await client.api().getStatus(serviceExecution.id!);
+  serviceExecution = await client.api().getStatus(serviceExecution.id!)
+  console.log(serviceExecution)
 
-  // wait for the service execution to finish
-  const finalStates = ["SUCCEEDED", "CANCELLED", "FAILED"];
+  const finalStates = ["SUCCEEDED", "CANCELLED", "FAILED"]
   while (!finalStates.includes(serviceExecution.status!)) {
-    serviceExecution = await client.api().getStatus(serviceExecution.id!);
+    serviceExecution = await client.api().getStatus(serviceExecution.id!)
   }
   console.log(serviceExecution)
 
-  // retrieve the result
-  await client.api().getResult(serviceExecution.id!)
+  const result = await client.api().getResult(serviceExecution.id!)
+  console.log(result)
+
+  const logs = await client.api().getLogs(serviceExecution.id!)
+  console.log(logs)
+
+  serviceExecution = await client.api().cancelExecution(serviceExecution.id!)
+  console.log(serviceExecution)
+
+  serviceExecution = await client.api().getStatus(serviceExecution.id!)
+  console.log(serviceExecution)
 
-  // retrieve the logs
-  await client.api().getLogs(serviceExecution.id!)
+  serviceExecutions = await client.api().getServiceExecutions()
+  console.log(serviceExecutions)
 })

package/src/sdk/Client.ts

@@ -2,31 +2,51 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as environments from "./environments";
-import * as core from "./core";
-import { ServiceApi } from "./api/resources/serviceApi/client/Client";
+import * as environments from "./environments.js";
+import * as core from "./core/index.js";
+import { mergeHeaders } from "./core/headers.js";
+import { ServiceApi } from "./api/resources/serviceApi/client/Client.js";
 
 export declare namespace PlanqkServiceApiClient {
-    interface Options {
+    export interface Options {
         environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         token: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 
-    interface RequestOptions {
+    export interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
         /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 
 export class PlanqkServiceApiClient {
-    constructor(protected readonly _options: PlanqkServiceApiClient.Options) {}
-
+    protected readonly _options: PlanqkServiceApiClient.Options;
     protected _serviceApi: ServiceApi | undefined;
 
+    constructor(_options: PlanqkServiceApiClient.Options) {
+        this._options = {
+            ..._options,
+            headers: mergeHeaders(
+                {
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                _options?.headers,
+            ),
+        };
+    }
+
     public get serviceApi(): ServiceApi {
         return (this._serviceApi ??= new ServiceApi(this._options));
     }

package/src/sdk/api/index.ts

@@ -1,3 +1,2 @@
-export * from "./resources";
-export * from "./types";
-export * from "./errors";
+export * from "./resources/index.js";
+export * from "./types/index.js";

package/src/sdk/api/resources/index.ts

@@ -1,2 +1,2 @@
-export * as serviceApi from "./serviceApi";
-export * from "./serviceApi/types";
+export * as serviceApi from "./serviceApi/index.js";
+export * from "./serviceApi/types/index.js";