@planqk/planqk-api-sdk 1.2.0 → 1.3.0

package/apps/ts-test-app/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "ts-test-app",
+  "version": "1.0.0",
+  "main": "index.ts",
+  "scripts": {
+    "start": "npx tsc && node dist/index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "description": "",
+  "dependencies": {
+    "@planqk/planqk-api-sdk": "^1.2.0",
+    "@types/node": "^20.14.10"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}

package/apps/ts-test-app/test-file.txt

@@ -0,0 +1 @@
+This is a test file for the PlanQK API SDK.

package/apps/ts-test-app/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

package/dist/index.d.ts

@@ -1,4 +1 @@
-export * as PlanqkApi from "./api/index.js";
-export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
-export { PlanqkApiClient } from "./Client.js";
-export { PlanqkApiEnvironment } from "./environments.js";
+export * from "./sdk";

package/dist/index.js

@@ -10,35 +10,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlanqkApiEnvironment = exports.PlanqkApiClient = exports.PlanqkApiTimeoutError = exports.PlanqkApiError = exports.PlanqkApi = void 0;
-exports.PlanqkApi = __importStar(require("./api/index.js"));
-var index_js_1 = require("./errors/index.js");
-Object.defineProperty(exports, "PlanqkApiError", { enumerable: true, get: function () { return index_js_1.PlanqkApiError; } });
-Object.defineProperty(exports, "PlanqkApiTimeoutError", { enumerable: true, get: function () { return index_js_1.PlanqkApiTimeoutError; } });
-var Client_js_1 = require("./Client.js");
-Object.defineProperty(exports, "PlanqkApiClient", { enumerable: true, get: function () { return Client_js_1.PlanqkApiClient; } });
-var environments_js_1 = require("./environments.js");
-Object.defineProperty(exports, "PlanqkApiEnvironment", { enumerable: true, get: function () { return environments_js_1.PlanqkApiEnvironment; } });
+__exportStar(require("./sdk"), exports);

package/dist/{Client.d.ts → sdk/Client.d.ts}

@@ -4,13 +4,12 @@
 import * as environments from "./environments.js";
 import * as core from "./core/index.js";
 import { DataPools } from "./api/resources/dataPools/client/Client.js";
-import { Authentication } from "./api/resources/authentication/client/Client.js";
 export declare namespace PlanqkApiClient {
     interface Options {
         environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
         /** Override the X-OrganizationId header */
         organizationId?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
@@ -32,8 +31,6 @@ export declare namespace PlanqkApiClient {
 export declare class PlanqkApiClient {
     protected readonly _options: PlanqkApiClient.Options;
     protected _dataPools: DataPools | undefined;
-    protected _authentication: Authentication | undefined;
-    constructor(_options?: PlanqkApiClient.Options);
+    constructor(_options: PlanqkApiClient.Options);
     get dataPools(): DataPools;
-    get authentication(): Authentication;
 }

package/dist/{Client.js → sdk/Client.js}

@@ -40,12 +40,10 @@ exports.PlanqkApiClient = void 0;
 const core = __importStar(require("./core/index.js"));
 const headers_js_1 = require("./core/headers.js");
 const Client_js_1 = require("./api/resources/dataPools/client/Client.js");
-const Client_js_2 = require("./api/resources/authentication/client/Client.js");
 class PlanqkApiClient {
     _options;
     _dataPools;
-    _authentication;
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = {
             ..._options,
             headers: (0, headers_js_1.mergeHeaders)({
@@ -59,8 +57,5 @@ class PlanqkApiClient {
     get dataPools() {
         return (this._dataPools ??= new Client_js_1.DataPools(this._options));
     }
-    get authentication() {
-        return (this._authentication ??= new Client_js_2.Authentication(this._options));
-    }
 }
 exports.PlanqkApiClient = PlanqkApiClient;

package/dist/{api → sdk/api}/resources/dataPools/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace DataPools {
         environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
         /** Override the X-OrganizationId header */
         organizationId?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
@@ -33,7 +33,7 @@ export declare namespace DataPools {
  */
 export declare class DataPools {
     protected readonly _options: DataPools.Options;
-    constructor(_options?: DataPools.Options);
+    constructor(_options: DataPools.Options);
     /**
      * Get a specific data pool (identified by its ID).
      *
@@ -179,6 +179,6 @@ export declare class DataPools {
     deleteDataPoolFile(id: string, fileId: string, requestOptions?: DataPools.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteDataPoolFile;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-Auth-Token": string | undefined;
+        "X-Auth-Token": string;
     }>;
 }

package/dist/{api → sdk/api}/resources/dataPools/client/Client.js

@@ -47,7 +47,7 @@ const errors = __importStar(require("../../../../errors/index.js"));
  */
 class DataPools {
     _options;
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**

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

@@ -0,0 +1,2 @@
+export * as dataPools from "./dataPools/index.js";
+export * from "./dataPools/client/requests/index.js";

package/dist/{api → sdk/api}/resources/index.js

@@ -36,8 +36,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataPools = exports.authentication = void 0;
-exports.authentication = __importStar(require("./authentication/index.js"));
-__exportStar(require("./authentication/types/index.js"), exports);
+exports.dataPools = void 0;
 exports.dataPools = __importStar(require("./dataPools/index.js"));
 __exportStar(require("./dataPools/client/requests/index.js"), exports);

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

@@ -0,0 +1,3 @@
+export * from "./OauthScope.js";
+export * from "./DataPoolDto.js";
+export * from "./DataPoolFileDto.js";

package/dist/{api/resources/authentication → sdk/api}/types/index.js

@@ -14,4 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./AuthorizeResponse.js"), exports);
+__exportStar(require("./OauthScope.js"), exports);
+__exportStar(require("./DataPoolDto.js"), exports);
+__exportStar(require("./DataPoolFileDto.js"), exports);

package/dist/sdk/index.d.ts

@@ -0,0 +1,4 @@
+export * as PlanqkApi from "./api/index.js";
+export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
+export { PlanqkApiClient } from "./Client.js";
+export { PlanqkApiEnvironment } from "./environments.js";

package/dist/sdk/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlanqkApiEnvironment = exports.PlanqkApiClient = exports.PlanqkApiTimeoutError = exports.PlanqkApiError = exports.PlanqkApi = void 0;
+exports.PlanqkApi = __importStar(require("./api/index.js"));
+var index_js_1 = require("./errors/index.js");
+Object.defineProperty(exports, "PlanqkApiError", { enumerable: true, get: function () { return index_js_1.PlanqkApiError; } });
+Object.defineProperty(exports, "PlanqkApiTimeoutError", { enumerable: true, get: function () { return index_js_1.PlanqkApiTimeoutError; } });
+var Client_js_1 = require("./Client.js");
+Object.defineProperty(exports, "PlanqkApiClient", { enumerable: true, get: function () { return Client_js_1.PlanqkApiClient; } });
+var environments_js_1 = require("./environments.js");
+Object.defineProperty(exports, "PlanqkApiEnvironment", { enumerable: true, get: function () { return environments_js_1.PlanqkApiEnvironment; } });

package/fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "planqk",
-  "version": "0.65.25"
+  "version": "0.65.35"
 }

package/fern/openapi/openapi.json

@@ -17,10 +17,6 @@
     }
   ],
   "tags": [
-    {
-      "name": "Authentication",
-      "description": "Endpoints for checking authentication and authorization."
-    },
     {
       "name": "Data Pools",
       "description": "Manage data pools, which are organized collections of files that serve as reusable data sources for services."
@@ -475,57 +471,6 @@
         ]
       }
     },
-    "/authorize": {
-      "post": {
-        "tags": [
-          "Authentication"
-        ],
-        "description": "Get the authenticated principal based on the provided token.",
-        "operationId": "authorize",
-        "parameters": [
-          {
-            "name": "X-Auth-Token",
-            "in": "header",
-            "required": false,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "The scopes of the provided token.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "oneOf": [
-                    {
-                      "$ref": "#/components/schemas/PersonalAccessTokenPrincipal"
-                    },
-                    {
-                      "$ref": "#/components/schemas/ServiceExecutionTokenPrincipal"
-                    }
-                  ]
-                }
-              }
-            }
-          },
-          "401": {
-            "description": "Unauthorized"
-          },
-          "403": {
-            "description": "Forbidden"
-          },
-          "404": {
-            "description": "Not Found"
-          },
-          "500": {
-            "description": "Internal Server Error"
-          }
-        }
-      }
-    },
     "/datapools/{id}/files/{fileId}": {
       "get": {
         "tags": [
@@ -746,151 +691,6 @@
             "pattern": "^\\d{4}\\-\\d{2}\\-\\d{2}\\s{1}\\d{2}\\:\\d{2}\\:\\d{2}$"
           }
         }
-      },
-      "AccessToken": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "format": "uuid"
-          },
-          "name": {
-            "type": "string"
-          },
-          "createdAt": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "usedAt": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "expiresAt": {
-            "type": "string",
-            "format": "date"
-          }
-        }
-      },
-      "OrganizationMembership": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "format": "uuid"
-          },
-          "accountType": {
-            "type": "string",
-            "enum": [
-              "BASIC",
-              "PRO",
-              "BUSINESS"
-            ]
-          },
-          "role": {
-            "type": "string",
-            "enum": [
-              "VIEWER",
-              "MAINTAINER",
-              "OWNER"
-            ]
-          }
-        }
-      },
-      "PersonalAccessTokenPrincipal": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "format": "uuid"
-          },
-          "accessToken": {
-            "$ref": "#/components/schemas/AccessToken"
-          },
-          "accountType": {
-            "type": "string",
-            "enum": [
-              "BASIC",
-              "PRO",
-              "BUSINESS"
-            ]
-          },
-          "organizationMemberships": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/OrganizationMembership"
-            }
-          }
-        }
-      },
-      "ServiceExecution": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "format": "uuid"
-          },
-          "createdAt": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "startedAt": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "endedAt": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "status": {
-            "type": "string",
-            "enum": [
-              "UNKNOWN",
-              "PENDING",
-              "RUNNING",
-              "SUCCEEDED",
-              "FAILED"
-            ]
-          }
-        }
-      },
-      "ServiceExecutionTokenPrincipal": {
-        "type": "object",
-        "properties": {
-          "serviceExecution": {
-            "$ref": "#/components/schemas/ServiceExecution"
-          },
-          "serviceProvider": {
-            "$ref": "#/components/schemas/UserContext"
-          }
-        }
-      },
-      "UserContext": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "format": "uuid"
-          },
-          "contextType": {
-            "type": "string",
-            "enum": [
-              "USER",
-              "ORGANIZATION",
-              "SERVICE_EXECUTION"
-            ]
-          },
-          "accountType": {
-            "type": "string",
-            "enum": [
-              "BASIC",
-              "PRO",
-              "BUSINESS"
-            ]
-          },
-          "parent": {
-            "$ref": "#/components/schemas/UserContext"
-          }
-        }
       }
     },
     "securitySchemes": {
@@ -903,8 +703,8 @@
         "type": "oauth2",
         "flows": {
           "password": {
-            "tokenUrl": "https://login.platform.planqk.de/realms/planqk/protocol/openid-connect/token",
-            "refreshUrl": "https://login.platform.planqk.de/realms/planqk/protocol/openid-connect/token",
+            "tokenUrl": "https://login.planqk.de/realms/planqk/protocol/openid-connect/token",
+            "refreshUrl": "https://login.planqk.de/realms/planqk/protocol/openid-connect/token",
             "scopes": {
               "profile": ""
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@planqk/planqk-api-sdk",
-  "version": "1.2.0",
-  "description": "SDK to interact with official PLANQK API.",
+  "version": "1.3.0",
+  "description": "SDK to interact with the official PLANQK API.",
   "author": "Kipu Quantum GmbH",
   "contributors": [
     "Wurster, Michael <michael.wurster@kipu-quantum.com>"
@@ -43,6 +43,5 @@
   "private": false,
   "publishConfig": {
     "access": "public"
-  },
-  "readme": "./README-node.md"
+  }
 }

package/planqk/api/_version.py

@@ -1 +1 @@
-__version__ = "1.2.0"
+__version__ = "1.3.0"

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-api-sdk"
-version = "1.2.0"
+version = "1.3.0"
 description = "SDK to interact with the official PLANQK API."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },
@@ -28,6 +28,7 @@ dev = [
     "pylint>=3.3.5",
     "pytest>=8.3.5",
     "pytest-dotenv>=0.5.2",
+    "python-dotenv>=1.1.1",
 ]
 
 [project.urls]
@@ -49,8 +50,3 @@ include = ["planqk*"]
 ignore-paths = '^planqk/api/sdk/.*$'
 max-line-length = 120
 disable = ['missing-module-docstring', 'missing-class-docstring', 'missing-function-docstring']
-
-[tool.uv.workspace]
-members = [
-    "python-test-app",
-]

package/src/index.test.ts

@@ -1,15 +1,16 @@
 import process from 'node:process'
 import {test} from 'vitest'
 import 'dotenv/config'
-import {PlanqkApiClient} from "./Client";
+import {PlanqkApiClient} from "./sdk";
 
-test.skip('adds 1 + 2 to equal 3', {timeout: 5 * 60 * 1000}, async () => {
-  const accessToken = process.env.PLANQK_PERSONAL_ACCESS_TOKEN!
+test.skip('integration test: data pools', {timeout: 5 * 60 * 1000}, async () => {
   const baseUrl = process.env.PLANQK_API_BASE_URL!
+  const apiKey = process.env.PLANQK_PERSONAL_ACCESS_TOKEN!
+  const organizationId = process.env.PLANQK_ORGANIZATION_ID
 
-  const client = new PlanqkApiClient({baseUrl: baseUrl, apiKey: () => accessToken});
+  const client = new PlanqkApiClient({baseUrl, apiKey, organizationId})
 
-  const dataPools = await client.dataPools.getDataPools();
+  const dataPools = await client.dataPools.getDataPools()
   console.log(dataPools)
 
   const files = await client.dataPools.getDataPoolFiles(dataPools[0].id!)

package/src/index.ts

@@ -1,4 +1 @@
-export * as PlanqkApi from "./api/index.js";
-export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
-export { PlanqkApiClient } from "./Client.js";
-export { PlanqkApiEnvironment } from "./environments.js";
+export * from "./sdk";

package/src/{Client.ts → sdk/Client.ts}

@@ -6,14 +6,13 @@ import * as environments from "./environments.js";
 import * as core from "./core/index.js";
 import { mergeHeaders } from "./core/headers.js";
 import { DataPools } from "./api/resources/dataPools/client/Client.js";
-import { Authentication } from "./api/resources/authentication/client/Client.js";
 
 export declare namespace PlanqkApiClient {
     export interface Options {
         environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
         /** Override the X-OrganizationId header */
         organizationId?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
@@ -37,9 +36,8 @@ export declare namespace PlanqkApiClient {
 export class PlanqkApiClient {
     protected readonly _options: PlanqkApiClient.Options;
     protected _dataPools: DataPools | undefined;
-    protected _authentication: Authentication | undefined;
 
-    constructor(_options: PlanqkApiClient.Options = {}) {
+    constructor(_options: PlanqkApiClient.Options) {
         this._options = {
             ..._options,
             headers: mergeHeaders(
@@ -57,8 +55,4 @@ export class PlanqkApiClient {
     public get dataPools(): DataPools {
         return (this._dataPools ??= new DataPools(this._options));
     }
-
-    public get authentication(): Authentication {
-        return (this._authentication ??= new Authentication(this._options));
-    }
 }

package/src/{api → sdk/api}/resources/dataPools/client/Client.ts

@@ -14,7 +14,7 @@ export declare namespace DataPools {
         environment?: core.Supplier<environments.PlanqkApiEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
         /** Override the X-OrganizationId header */
         organizationId?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
@@ -41,7 +41,7 @@ export declare namespace DataPools {
 export class DataPools {
     protected readonly _options: DataPools.Options;
 
-    constructor(_options: DataPools.Options = {}) {
+    constructor(_options: DataPools.Options) {
         this._options = _options;
     }
 

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

@@ -0,0 +1,2 @@
+export * as dataPools from "./dataPools/index.js";
+export * from "./dataPools/client/requests/index.js";

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

@@ -0,0 +1,3 @@
+export * from "./OauthScope.js";
+export * from "./DataPoolDto.js";
+export * from "./DataPoolFileDto.js";

package/src/sdk/index.ts

@@ -0,0 +1,4 @@
+export * as PlanqkApi from "./api/index.js";
+export { PlanqkApiError, PlanqkApiTimeoutError } from "./errors/index.js";
+export { PlanqkApiClient } from "./Client.js";
+export { PlanqkApiEnvironment } from "./environments.js";