@planqk/planqk-service-sdk 2.1.1 → 2.2.0

package/dist/sdk/core/url/join.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.join = join;
+function join(base, ...segments) {
+    if (!base) {
+        return "";
+    }
+    if (base.includes("://")) {
+        let url;
+        try {
+            url = new URL(base);
+        }
+        catch {
+            // Fallback to path joining if URL is malformed
+            return joinPath(base, ...segments);
+        }
+        for (const segment of segments) {
+            const cleanSegment = trimSlashes(segment);
+            if (cleanSegment) {
+                url.pathname = joinPathSegments(url.pathname, cleanSegment);
+            }
+        }
+        return url.toString();
+    }
+    return joinPath(base, ...segments);
+}
+function joinPath(base, ...segments) {
+    let result = base;
+    for (const segment of segments) {
+        const cleanSegment = trimSlashes(segment);
+        if (cleanSegment) {
+            result = joinPathSegments(result, cleanSegment);
+        }
+    }
+    return result;
+}
+function joinPathSegments(left, right) {
+    if (left.endsWith("/")) {
+        return left + right;
+    }
+    return left + "/" + right;
+}
+function trimSlashes(str) {
+    if (!str)
+        return str;
+    let start = str.startsWith("/") ? 1 : 0;
+    let end = str.endsWith("/") ? str.length - 1 : str.length;
+    return str.slice(start, end);
+}

package/dist/sdk/core/url/qs.d.ts

@@ -0,0 +1,6 @@
+interface QueryStringOptions {
+    arrayFormat?: "indices" | "repeat";
+    encode?: boolean;
+}
+export declare function toQueryString(obj: unknown, options?: QueryStringOptions): string;
+export {};

package/dist/sdk/core/url/qs.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toQueryString = toQueryString;
+const defaultQsOptions = {
+    arrayFormat: "indices",
+    encode: true,
+};
+function encodeValue(value, shouldEncode) {
+    if (value === undefined) {
+        return "";
+    }
+    if (value === null) {
+        return "";
+    }
+    const stringValue = String(value);
+    return shouldEncode ? encodeURIComponent(stringValue) : stringValue;
+}
+function stringifyObject(obj, prefix = "", options) {
+    const parts = [];
+    for (const [key, value] of Object.entries(obj)) {
+        const fullKey = prefix ? `${prefix}[${key}]` : key;
+        if (value === undefined) {
+            continue;
+        }
+        if (Array.isArray(value)) {
+            if (value.length === 0) {
+                continue;
+            }
+            for (let i = 0; i < value.length; i++) {
+                const item = value[i];
+                if (item === undefined) {
+                    continue;
+                }
+                if (typeof item === "object" && !Array.isArray(item) && item !== null) {
+                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                    parts.push(...stringifyObject(item, arrayKey, options));
+                }
+                else {
+                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                    const encodedKey = options.encode ? encodeURIComponent(arrayKey) : arrayKey;
+                    parts.push(`${encodedKey}=${encodeValue(item, options.encode)}`);
+                }
+            }
+        }
+        else if (typeof value === "object" && value !== null) {
+            if (Object.keys(value).length === 0) {
+                continue;
+            }
+            parts.push(...stringifyObject(value, fullKey, options));
+        }
+        else {
+            const encodedKey = options.encode ? encodeURIComponent(fullKey) : fullKey;
+            parts.push(`${encodedKey}=${encodeValue(value, options.encode)}`);
+        }
+    }
+    return parts;
+}
+function toQueryString(obj, options) {
+    if (obj == null || typeof obj !== "object") {
+        return "";
+    }
+    const parts = stringifyObject(obj, "", {
+        ...defaultQsOptions,
+        ...options,
+    });
+    return parts.join("&");
+}

package/dist/sdk/errors/PlanqkServiceApiError.d.ts

@@ -1,12 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as core from "../core/index.js";
 export declare class PlanqkServiceApiError extends Error {
     readonly statusCode?: number;
     readonly body?: unknown;
-    constructor({ message, statusCode, body }: {
+    readonly rawResponse?: core.RawResponse;
+    constructor({ message, statusCode, body, rawResponse, }: {
         message?: string;
         statusCode?: number;
         body?: unknown;
+        rawResponse?: core.RawResponse;
     });
 }

package/dist/sdk/errors/PlanqkServiceApiError.js

@@ -4,18 +4,17 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkServiceApiError = void 0;
+const json_js_1 = require("../core/json.js");
 class PlanqkServiceApiError extends Error {
     statusCode;
     body;
-    constructor({ message, statusCode, body }) {
+    rawResponse;
+    constructor({ message, statusCode, body, rawResponse, }) {
         super(buildMessage({ message, statusCode, body }));
         Object.setPrototypeOf(this, PlanqkServiceApiError.prototype);
-        if (statusCode != null) {
-            this.statusCode = statusCode;
-        }
-        if (body !== undefined) {
-            this.body = body;
-        }
+        this.statusCode = statusCode;
+        this.body = body;
+        this.rawResponse = rawResponse;
     }
 }
 exports.PlanqkServiceApiError = PlanqkServiceApiError;
@@ -28,7 +27,7 @@ function buildMessage({ message, statusCode, body, }) {
         lines.push(`Status code: ${statusCode.toString()}`);
     }
     if (body != null) {
-        lines.push(`Body: ${JSON.stringify(body, undefined, 2)}`);
+        lines.push(`Body: ${(0, json_js_1.toJson)(body, undefined, 2)}`);
     }
     return lines.join("\n");
 }

package/dist/sdk/errors/PlanqkServiceApiTimeoutError.d.ts

@@ -2,5 +2,5 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare class PlanqkServiceApiTimeoutError extends Error {
-    constructor();
+    constructor(message: string);
 }

package/dist/sdk/errors/PlanqkServiceApiTimeoutError.js

@@ -5,8 +5,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkServiceApiTimeoutError = void 0;
 class PlanqkServiceApiTimeoutError extends Error {
-    constructor() {
-        super("Timeout");
+    constructor(message) {
+        super(message);
         Object.setPrototypeOf(this, PlanqkServiceApiTimeoutError.prototype);
     }
 }

package/dist/sdk/errors/index.d.ts

@@ -1,2 +1,2 @@
-export { PlanqkServiceApiError } from "./PlanqkServiceApiError";
-export { PlanqkServiceApiTimeoutError } from "./PlanqkServiceApiTimeoutError";
+export { PlanqkServiceApiError } from "./PlanqkServiceApiError.js";
+export { PlanqkServiceApiTimeoutError } from "./PlanqkServiceApiTimeoutError.js";

package/dist/sdk/errors/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanqkServiceApiTimeoutError = exports.PlanqkServiceApiError = void 0;
-var PlanqkServiceApiError_1 = require("./PlanqkServiceApiError");
-Object.defineProperty(exports, "PlanqkServiceApiError", { enumerable: true, get: function () { return PlanqkServiceApiError_1.PlanqkServiceApiError; } });
-var PlanqkServiceApiTimeoutError_1 = require("./PlanqkServiceApiTimeoutError");
-Object.defineProperty(exports, "PlanqkServiceApiTimeoutError", { enumerable: true, get: function () { return PlanqkServiceApiTimeoutError_1.PlanqkServiceApiTimeoutError; } });
+var PlanqkServiceApiError_js_1 = require("./PlanqkServiceApiError.js");
+Object.defineProperty(exports, "PlanqkServiceApiError", { enumerable: true, get: function () { return PlanqkServiceApiError_js_1.PlanqkServiceApiError; } });
+var PlanqkServiceApiTimeoutError_js_1 = require("./PlanqkServiceApiTimeoutError.js");
+Object.defineProperty(exports, "PlanqkServiceApiTimeoutError", { enumerable: true, get: function () { return PlanqkServiceApiTimeoutError_js_1.PlanqkServiceApiTimeoutError; } });

package/dist/sdk/index.d.ts

@@ -1,4 +1,4 @@
-export * as PlanqkServiceApi from "./api";
-export { PlanqkServiceApiClient } from "./Client";
-export { PlanqkServiceApiEnvironment } from "./environments";
-export { PlanqkServiceApiError, PlanqkServiceApiTimeoutError } from "./errors";
+export * as PlanqkServiceApi from "./api/index.js";
+export { PlanqkServiceApiError, PlanqkServiceApiTimeoutError } from "./errors/index.js";
+export { PlanqkServiceApiClient } from "./Client.js";
+export { PlanqkServiceApiEnvironment } from "./environments.js";

package/dist/sdk/index.js

@@ -33,12 +33,12 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlanqkServiceApiTimeoutError = exports.PlanqkServiceApiError = exports.PlanqkServiceApiEnvironment = exports.PlanqkServiceApiClient = exports.PlanqkServiceApi = void 0;
-exports.PlanqkServiceApi = __importStar(require("./api"));
-var Client_1 = require("./Client");
-Object.defineProperty(exports, "PlanqkServiceApiClient", { enumerable: true, get: function () { return Client_1.PlanqkServiceApiClient; } });
-var environments_1 = require("./environments");
-Object.defineProperty(exports, "PlanqkServiceApiEnvironment", { enumerable: true, get: function () { return environments_1.PlanqkServiceApiEnvironment; } });
-var errors_1 = require("./errors");
-Object.defineProperty(exports, "PlanqkServiceApiError", { enumerable: true, get: function () { return errors_1.PlanqkServiceApiError; } });
-Object.defineProperty(exports, "PlanqkServiceApiTimeoutError", { enumerable: true, get: function () { return errors_1.PlanqkServiceApiTimeoutError; } });
+exports.PlanqkServiceApiEnvironment = exports.PlanqkServiceApiClient = exports.PlanqkServiceApiTimeoutError = exports.PlanqkServiceApiError = exports.PlanqkServiceApi = void 0;
+exports.PlanqkServiceApi = __importStar(require("./api/index.js"));
+var index_js_1 = require("./errors/index.js");
+Object.defineProperty(exports, "PlanqkServiceApiError", { enumerable: true, get: function () { return index_js_1.PlanqkServiceApiError; } });
+Object.defineProperty(exports, "PlanqkServiceApiTimeoutError", { enumerable: true, get: function () { return index_js_1.PlanqkServiceApiTimeoutError; } });
+var Client_js_1 = require("./Client.js");
+Object.defineProperty(exports, "PlanqkServiceApiClient", { enumerable: true, get: function () { return Client_js_1.PlanqkServiceApiClient; } });
+var environments_js_1 = require("./environments.js");
+Object.defineProperty(exports, "PlanqkServiceApiEnvironment", { enumerable: true, get: function () { return environments_js_1.PlanqkServiceApiEnvironment; } });

package/fern/fern.config.json

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

package/fern/generators.yml

@@ -7,7 +7,7 @@ groups:
   local:
     generators:
       - name: fernapi/fern-typescript-node-sdk
-        version: 0.39.3
+        version: 2.4.6
         output:
           location: local-file-system
           path: ../generated/typescript
@@ -18,7 +18,7 @@ groups:
           skipResponseValidation: true
           noSerdeLayer: true
       - name: fernapi/fern-python-sdk
-        version: 4.3.16
+        version: 4.25.0
         output:
           location: local-file-system
           path: ../generated/python

package/fern/openapi/openapi.yml

@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.1.0
 info:
   version: "1.0"
   title: PLANQK Service API
@@ -9,56 +9,38 @@ paths:
     get:
       tags:
         - Service API
-      summary: Health checking endpoint
+      summary: List of service executions
       description: |
-        This method checks the health of the service.
-      operationId: healthCheck
+        Retrieves a list of all service executions.
+        The response includes links to each service execution, allowing for further queries on their status and results.
+      operationId: getServiceExecutions
       responses:
         "200":
-          description: OK
+          description: List of service executions
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  status:
-                    type: string
-                    description: Status of the service
-                    example: "Service is up and running"
+                type: array
+                items:
+                  $ref: "#/components/schemas/ServiceExecution"
     post:
       tags:
         - Service API
       summary: Asynchronous execution of the service
       description: |
-        This method starts a service execution, which in turn is processed asynchronously by PLANQK. 
+        Starts a service execution, which in turn is processed asynchronously. 
         The location header of the response contains the URL which can be used to query the status and the result of the service execution.
-      operationId: execute
+      operationId: startExecution
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
-              additionalProperties:
-                type: object
-              oneOf:
-                - required:
-                    - data
-                  properties:
-                    data:
-                      $ref: '#/components/schemas/InputData'
-                    params:
-                      $ref: '#/components/schemas/InputParams'
-                - required:
-                    - dataRef
-                  properties:
-                    dataRef:
-                      $ref: '#/components/schemas/InputDataRef'
-                    params:
-                      $ref: '#/components/schemas/InputParams'
+              additionalProperties: true
       responses:
         "201":
-          description: Service execution successfully submitted
+          description: Service execution is submitted
           content:
             application/json:
               schema:
@@ -68,23 +50,14 @@ paths:
               description: URL to query the status and the result of a service execution
               schema:
                 type: string
-        "400":
-          description: Invalid input
-        "401":
-          description: Unauthorized
-        "403":
-          description: Forbidden
-        "404":
-          description: Not found
-        "500":
-          description: Internal server error
   /{id}:
     get:
       tags:
         - Service API
       summary: Check the status of a service execution
       description: |
-        This method checks the status of a service execution.
+        Retrieves the status of a service execution.
+        The status can be one of the following: UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED.
       operationId: getStatus
       parameters:
         - in: path
@@ -95,26 +68,20 @@ paths:
             type: string
       responses:
         "200":
-          description: Ok
+          description: A service execution
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/ServiceExecution"
-        "401":
-          description: Unauthorized
-        "403":
-          description: Forbidden
-        "404":
-          description: Not found
-        "500":
-          description: Internal server error
   /{id}/result:
     get:
       tags:
         - Service API
       summary: Get the result of a service execution
       description: |
-        This method retrieves the result of a service execution.
+        Retrieves the result of a service execution.
+        The result is returned as a JSON object containing the status and any additional data.
+        The result may include links to download specific result files.
       operationId: getResult
       parameters:
         - in: path
@@ -125,13 +92,12 @@ paths:
             type: string
       responses:
         "200":
-          description: Ok
+          description: The service execution result
           content:
             application/json:
               schema:
                 type: object
-                additionalProperties:
-                  type: string
+                additionalProperties: true
                 properties:
                   _links:
                     type: object
@@ -145,21 +111,15 @@ paths:
                     properties:
                       status:
                         $ref: '#/components/schemas/ServiceExecution'
-        "401":
-          description: Unauthorized
-        "403":
-          description: Forbidden
-        "404":
-          description: Not found
-        "500":
-          description: Internal server error
   /{id}/result/{file}:
     get:
       tags:
         - Service API
       summary: Download a result file of a service execution
       description: |
-        This method downloads a result file of a service execution.
+        Retrieves a specific result file of a service execution.
+        The file name is provided in the path parameter.
+        The result file is returned as a binary stream.
       operationId: getResultFile
       parameters:
         - in: path
@@ -176,27 +136,19 @@ paths:
             type: string
       responses:
         "200":
-          description: Ok
+          description: The content of a result file
           content:
             application/octet-stream:
               schema:
                 type: string
                 format: binary
-        "401":
-          description: Unauthorized
-        "403":
-          description: Forbidden
-        "404":
-          description: Not found
-        "500":
-          description: Internal server error
   /{id}/log:
     get:
       tags:
         - Service API
       summary: Get the log output of a service execution
       description: |
-        This method retrieves the log output of a service execution.
+        Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
       operationId: getLogs
       parameters:
         - in: path
@@ -207,29 +159,21 @@ paths:
             type: string
       responses:
         "200":
-          description: Ok
+          description: List of log entries
           content:
             application/json:
               schema:
                 type: array
                 items:
                   type: string
-        "401":
-          description: Unauthorized
-        "403":
-          description: Forbidden
-        "404":
-          description: Not found
-        "500":
-          description: Internal server error
   /{id}/cancel:
     put:
       tags:
         - Service API
       summary: Cancel a service execution
       description: |
-        This method cancels a service execution.
-      operationId: cancel
+        Cancel a pending or running service execution.
+      operationId: cancelExecution
       parameters:
         - in: path
           name: id
@@ -239,64 +183,32 @@ paths:
             type: string
       responses:
         "200":
-          description: Ok
+          description: Service execution is cancelled
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/ServiceExecution"
-        "401":
-          description: Unauthorized
-        "403":
-          description: Forbidden
-        "404":
-          description: Not found
-        "500":
-          description: Internal server error
 components:
   schemas:
-    InputData:
-      type: object
-      additionalProperties:
-        type: object
-    InputParams:
-      type: object
-      additionalProperties:
-        type: object
-    InputDataRef:
-      type: object
-      properties:
-        dataPoolId:
-          type: string
-          example: 87cb778e-ac43-11ec-b909-0242ac120002
-        dataSourceDescriptorId:
-          type: string
-          example: 87cb778e-ac43-11ec-b909-0242ac120002
-        fileId:
-          type: string
-          example: 87cb778e-ac43-11ec-b909-0242ac120002
-      required:
-        - dataPoolId
-        - dataSourceDescriptorId
-        - fileId
     ServiceExecution:
       type: object
       properties:
         id:
           type: string
-          example: 87cb778e-ac43-11ec-b909-0242ac120002
+          examples: [ 87cb778e-ac43-11ec-b909-0242ac120002 ]
         status:
           type: string
-          enum: [UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED]
-          example: SUCCEEDED
+          enum: [ UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED ]
+          examples: [ SUCCEEDED ]
         createdAt:
           type: string
-          example: "2022-01-01 22:38:08"
+          examples: [ "2022-01-01 22:38:08" ]
         startedAt:
           type: string
-          example: "2022-01-01 22:39:08"
+          examples: [ "2022-01-01 22:39:08" ]
         endedAt:
           type: string
-          example: "2022-01-01 22:40:08"
+          examples: [ "2022-01-01 22:40:08" ]
     # Representation of link as defined in HAL: https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-11
     HALLink:
       type: object
@@ -326,17 +238,15 @@ components:
         hreflang:
           type: string
           description: The language of the link's target resource (optional)
-
   securitySchemes:
-    oauthClientCredentials:
+    ApplicationCredentials:
       type: oauth2
       flows:
         clientCredentials:
           tokenUrl: https://gateway.platform.planqk.de/token
           scopes: {}
-
-servers:
-  - url: https://gateway.platform.planqk.de
-
 security:
-  - oauthClientCredentials: []
+  - ApplicationCredentials: []
+servers:
+  - url: https://gateway.34.90.225.20.nip.io/<context>/<service>/<version>
+    description: The service endpoint

package/notebooks/python-sdk.ipynb

@@ -18,6 +18,7 @@
    "outputs": [],
    "source": [
     "import os\n",
+    "\n",
     "from dotenv import load_dotenv\n",
     "\n",
     "# Make a copy of .env.example and rename it to .env, place it in the \n",
@@ -218,7 +219,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import json\n",
     "from planqk.service.sdk.types.input_data_ref import InputDataRef\n",
     "\n",
     "# Create a client\n",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "SDK to interact with PLANQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [
@@ -45,6 +45,5 @@
   "private": false,
   "publishConfig": {
     "access": "public"
-  },
-  "readme": "./README-node.md"
+  }
 }

package/planqk/service/_version.py

@@ -1 +1 @@
-__version__ = "2.1.1"
+__version__ = "2.2.0"

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-service-sdk"
-version = "2.1.1"
+version = "2.2.0"
 description = "SDK to interact with PLANQK Managed Services."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },