@planqk/planqk-service-sdk 1.6.0 → 1.8.0

package/dist/client.d.ts

@@ -2,7 +2,7 @@ import { GetInterimResultsRequest, GetInterimResultsResponse, GetResultResponse,
 import { ServiceApi } from './sdk/api/resources/serviceApi/client/Client';
 export declare class PlanqkServiceClient {
     private _api;
-    constructor(serviceEndpoint: string, consumerKey: string, consumerSecret: string, tokenEndpoint?: string);
+    constructor(serviceEndpoint: string, consumerKey?: string, consumerSecret?: string, tokenEndpoint?: string);
     cancelExecution(jobId: string, requestOptions?: ServiceApi.RequestOptions): Promise<Job>;
     getInterimResults(jobId: string, request?: GetInterimResultsRequest, requestOptions?: ServiceApi.RequestOptions): Promise<GetInterimResultsResponse>;
     getResult(jobId: string, requestOptions?: ServiceApi.RequestOptions): Promise<GetResultResponse>;

package/dist/client.js

@@ -15,11 +15,19 @@ const sdk_1 = require("./sdk");
 const api_1 = require("./sdk/api");
 class PlanqkServiceClient {
     constructor(serviceEndpoint, consumerKey, consumerSecret, tokenEndpoint = auth_1.DEFAULT_TOKEN_ENDPOINT) {
-        const auth = new auth_1.PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint);
-        this._api = new sdk_1.PlanqkServiceApiClient({
-            environment: () => serviceEndpoint,
-            token: () => __awaiter(this, void 0, void 0, function* () { return auth.getAccessToken(); }),
-        });
+        if (consumerKey && consumerSecret) {
+            const auth = new auth_1.PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint);
+            this._api = new sdk_1.PlanqkServiceApiClient({
+                environment: () => serviceEndpoint,
+                token: () => __awaiter(this, void 0, void 0, function* () { return auth.getAccessToken(); }),
+            });
+        }
+        else {
+            this._api = new sdk_1.PlanqkServiceApiClient({
+                environment: () => serviceEndpoint,
+                token: () => __awaiter(this, void 0, void 0, function* () { return Math.random().toString(36).slice(2); }),
+            });
+        }
     }
     cancelExecution(jobId, requestOptions) {
         return this._api.serviceApi.cancelExecution(jobId, requestOptions);

package/dist/sdk/api/resources/serviceApi/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 export declare namespace ServiceApi {
     interface Options {
         environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;

package/dist/sdk/api/resources/serviceApi/client/Client.js

@@ -41,7 +41,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServiceApi = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const PlanqkServiceApi = __importStar(require("../../.."));
+const PlanqkServiceApi = __importStar(require("../../../index"));
 const errors = __importStar(require("../../../../errors"));
 const url_join_1 = __importDefault(require("url-join"));
 class ServiceApi {

package/dist/sdk/api/resources/serviceApi/client/requests/GetInterimResultsRequest.d.ts

@@ -4,7 +4,6 @@
 export interface GetInterimResultsRequest {
     /**
      * Either true or false to show only the last or all interim results (default: false).
-     *
      */
     last?: boolean;
 }

package/dist/sdk/api/resources/serviceApi/client/requests/StartExecutionRequest.d.ts

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as PlanqkServiceApi from "../../../..";
+import * as PlanqkServiceApi from "../../../../index";
 /**
  * @example
  *     {}
  */
 export interface StartExecutionRequest {
     data?: PlanqkServiceApi.InputData;
+    dataRef?: PlanqkServiceApi.InputRef;
     params?: PlanqkServiceApi.InputParams;
 }

package/dist/sdk/api/resources/serviceApi/types/GetInterimResultsResponse.d.ts

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 export type GetInterimResultsResponse = PlanqkServiceApi.InterimResultResponse[] | PlanqkServiceApi.InterimResultResponse;

package/dist/sdk/api/resources/serviceApi/types/GetResultResponse.d.ts

@@ -1,5 +1,5 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as PlanqkServiceApi from "../../..";
-export type GetResultResponse = PlanqkServiceApi.ResultResponse | PlanqkServiceApi.ErrorResponse;
+import * as PlanqkServiceApi from "../../../index";
+export type GetResultResponse = PlanqkServiceApi.ObjectResponse | PlanqkServiceApi.StringResponse | PlanqkServiceApi.NumberResponse | PlanqkServiceApi.ArrayResponse;

package/dist/sdk/api/resources/statusApi/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 export declare namespace StatusApi {
     interface Options {
         environment?: core.Supplier<environments.PlanqkServiceApiEnvironment | string>;

package/dist/sdk/api/types/ArrayResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ArrayResponse = Record<string, any>[];

package/dist/sdk/api/types/InputRef.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InputRef {
+    dataPoolId: string;
+    dataSourceDescriptorId: string;
+    fileId: string;
+}

package/dist/sdk/api/types/Job.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as PlanqkServiceApi from "..";
+import * as PlanqkServiceApi from "../index";
 export interface Job {
     id?: string;
     status?: PlanqkServiceApi.JobStatus;

package/dist/sdk/api/types/{ErrorResponse.d.ts → NumberResponse.d.ts}

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ErrorResponse = Record<string, any>;
+export type NumberResponse = number;

package/dist/sdk/api/types/NumberResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/{ResultResponse.d.ts → ObjectResponse.d.ts}

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ResultResponse = Record<string, any>;
+export type ObjectResponse = Record<string, any>;

package/dist/sdk/api/types/ObjectResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/StringResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type StringResponse = string;

package/dist/sdk/api/types/StringResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/index.d.ts

@@ -1,7 +1,10 @@
 export * from "./InputData";
 export * from "./InputParams";
+export * from "./InputRef";
 export * from "./InterimResultResponse";
-export * from "./ResultResponse";
-export * from "./ErrorResponse";
+export * from "./ObjectResponse";
+export * from "./StringResponse";
+export * from "./NumberResponse";
+export * from "./ArrayResponse";
 export * from "./JobStatus";
 export * from "./Job";

package/dist/sdk/api/types/index.js

@@ -16,8 +16,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./InputData"), exports);
 __exportStar(require("./InputParams"), exports);
+__exportStar(require("./InputRef"), exports);
 __exportStar(require("./InterimResultResponse"), exports);
-__exportStar(require("./ResultResponse"), exports);
-__exportStar(require("./ErrorResponse"), exports);
+__exportStar(require("./ObjectResponse"), exports);
+__exportStar(require("./StringResponse"), exports);
+__exportStar(require("./NumberResponse"), exports);
+__exportStar(require("./ArrayResponse"), exports);
 __exportStar(require("./JobStatus"), exports);
 __exportStar(require("./Job"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "description": "Typescript SDK to execute PlanQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/src/client.ts

@@ -15,12 +15,19 @@ import {ServiceApi} from './sdk/api/resources/serviceApi/client/Client'
 export class PlanqkServiceClient {
   private _api: PlanqkServiceApiClient
 
-  constructor(serviceEndpoint: string, consumerKey: string, consumerSecret: string, tokenEndpoint: string = DEFAULT_TOKEN_ENDPOINT) {
-    const auth = new PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint)
-    this._api = new PlanqkServiceApiClient({
-      environment: () => serviceEndpoint,
-      token: async () => auth.getAccessToken(),
-    })
+  constructor(serviceEndpoint: string, consumerKey?: string, consumerSecret?: string, tokenEndpoint: string = DEFAULT_TOKEN_ENDPOINT) {
+    if (consumerKey && consumerSecret) {
+      const auth = new PlanqkServiceAuth(consumerKey, consumerSecret, tokenEndpoint)
+      this._api = new PlanqkServiceApiClient({
+        environment: () => serviceEndpoint,
+        token: async () => auth.getAccessToken(),
+      })
+    } else {
+      this._api = new PlanqkServiceApiClient({
+        environment: () => serviceEndpoint,
+        token: async () => Math.random().toString(36).slice(2),
+      })
+    }
   }
 
   public cancelExecution(jobId: string, requestOptions?: ServiceApi.RequestOptions): Promise<Job> {

package/src/sdk/api/resources/serviceApi/client/Client.ts

@@ -4,7 +4,7 @@
 
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 import * as errors from "../../../../errors";
 import urlJoin from "url-join";
 

package/src/sdk/api/resources/serviceApi/client/requests/GetInterimResultsRequest.ts

@@ -5,7 +5,6 @@
 export interface GetInterimResultsRequest {
     /**
      * Either true or false to show only the last or all interim results (default: false).
-     *
      */
     last?: boolean;
 }

package/src/sdk/api/resources/serviceApi/client/requests/StartExecutionRequest.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as PlanqkServiceApi from "../../../..";
+import * as PlanqkServiceApi from "../../../../index";
 
 /**
  * @example
@@ -10,5 +10,6 @@ import * as PlanqkServiceApi from "../../../..";
  */
 export interface StartExecutionRequest {
     data?: PlanqkServiceApi.InputData;
+    dataRef?: PlanqkServiceApi.InputRef;
     params?: PlanqkServiceApi.InputParams;
 }

package/src/sdk/api/resources/serviceApi/types/GetInterimResultsResponse.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 
 export type GetInterimResultsResponse =
     | PlanqkServiceApi.InterimResultResponse[]

package/src/sdk/api/resources/serviceApi/types/GetResultResponse.ts

@@ -2,6 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 
-export type GetResultResponse = PlanqkServiceApi.ResultResponse | PlanqkServiceApi.ErrorResponse;
+export type GetResultResponse =
+    | PlanqkServiceApi.ObjectResponse
+    | PlanqkServiceApi.StringResponse
+    | PlanqkServiceApi.NumberResponse
+    | PlanqkServiceApi.ArrayResponse;

package/src/sdk/api/resources/statusApi/client/Client.ts

@@ -4,7 +4,7 @@
 
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as PlanqkServiceApi from "../../..";
+import * as PlanqkServiceApi from "../../../index";
 import * as errors from "../../../../errors";
 
 export declare namespace StatusApi {

package/src/sdk/api/types/ArrayResponse.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type ArrayResponse = Record<string, any>[];

package/src/sdk/api/types/InputRef.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface InputRef {
+    dataPoolId: string;
+    dataSourceDescriptorId: string;
+    fileId: string;
+}

package/src/sdk/api/types/Job.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-import * as PlanqkServiceApi from "..";
+import * as PlanqkServiceApi from "../index";
 
 export interface Job {
     id?: string;

package/src/sdk/api/types/{ErrorResponse.ts → NumberResponse.ts}

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type ErrorResponse = Record<string, any>;
+export type NumberResponse = number;

package/src/sdk/api/types/{ResultResponse.ts → ObjectResponse.ts}

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type ResultResponse = Record<string, any>;
+export type ObjectResponse = Record<string, any>;

package/src/sdk/api/types/StringResponse.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type StringResponse = string;

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

@@ -1,7 +1,10 @@
 export * from "./InputData";
 export * from "./InputParams";
+export * from "./InputRef";
 export * from "./InterimResultResponse";
-export * from "./ResultResponse";
-export * from "./ErrorResponse";
+export * from "./ObjectResponse";
+export * from "./StringResponse";
+export * from "./NumberResponse";
+export * from "./ArrayResponse";
 export * from "./JobStatus";
 export * from "./Job";

package/tests/integration.test.ts

@@ -1,23 +1,45 @@
 import {PlanqkServiceAuth, PlanqkServiceClient} from '../src'
 import {PlanqkServiceApiClient} from '../src/sdk'
-import {JobStatus} from '../src/sdk/api'
+import {JobStatus, StartExecutionRequest} from '../src/sdk/api'
 import {complexInput} from './fixtures/complex-input'
 
-const serviceEndpoint = process.env.SERVICE_ENDPOINT
+const serviceEndpoint = process.env.SERVICE_ENDPOINT || 'http://localhost:8081'
 const consumerKey = process.env.CONSUMER_KEY
 const consumerSecret = process.env.CONSUMER_SECRET
 
-if (!serviceEndpoint || !consumerKey || !consumerSecret) {
-  throw new Error('Environment variables SERVICE_ENDPOINT, CONSUMER_KEY, or CONSUMER_SECRET are not defined')
-}
+test('should use client', async () => {
+  const client = new PlanqkServiceClient(serviceEndpoint, consumerKey, consumerSecret)
+
+  const health = await client.healthCheck()
+  expect(health.status).toBe('Service is up and running')
+
+  let job = await client.startExecution(complexInput)
+  expect(job.id).toBeDefined()
+  expect(job.status).toBe(JobStatus.Pending)
+
+  job = await client.getStatus(job.id!)
 
-test('should use generated client', async () => {
-  const auth = new PlanqkServiceAuth(consumerKey, consumerSecret)
+  const result = await client.getResult(job.id!)
+  expect(result).toBeDefined()
+
+  job = await client.getStatus(job.id!)
+  expect(job.status).toBe(JobStatus.Succeeded)
+}, 5 * 60 * 1000)
 
-  const api = new PlanqkServiceApiClient({
-    environment: () => serviceEndpoint,
-    token: async () => auth.getAccessToken(),
-  })
+test('should use raw client', async () => {
+  let api: PlanqkServiceApiClient
+  if (consumerKey && consumerSecret) {
+    const auth = new PlanqkServiceAuth(consumerKey, consumerSecret)
+    api = new PlanqkServiceApiClient({
+      environment: () => serviceEndpoint,
+      token: async () => auth.getAccessToken(),
+    })
+  } else {
+    api = new PlanqkServiceApiClient({
+      environment: () => serviceEndpoint,
+      token: async () => Math.random().toString(36).slice(2),
+    })
+  }
 
   const health = await api.statusApi.healthCheck()
   expect(health.status).toBe('Service is up and running')
@@ -41,13 +63,22 @@ test('should use generated client', async () => {
   expect(result).toBeDefined()
 }, 5 * 60 * 1000)
 
-test('should use client abstraction', async () => {
+test('should use client with data pool ref', async () => {
   const client = new PlanqkServiceClient(serviceEndpoint, consumerKey, consumerSecret)
 
   const health = await client.healthCheck()
   expect(health.status).toBe('Service is up and running')
 
-  let job = await client.startExecution(complexInput)
+  const request: StartExecutionRequest = {
+    dataRef: {
+      dataPoolId: 'e3859bb2-1959-4d3d-852b-62ee81b28a72',
+      dataSourceDescriptorId: '1c8d341e-1c86-4e19-acae-2f84bcab55ca',
+      fileId: 'f5251675-49c6-49f3-a3a6-de75b8335d76',
+    },
+    params: {},
+  }
+
+  let job = await client.startExecution(request)
   expect(job.id).toBeDefined()
   expect(job.status).toBe(JobStatus.Pending)