@planqk/planqk-api-sdk 1.3.6 → 1.6.0

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

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface LogEntry {
+    /** Log message content. */
+    message?: string;
+    /** Severity of the log entry. */
+    severity?: LogEntry.Severity;
+    /** Timestamp when the entry was logged. */
+    timestamp?: string;
+}
+
+export namespace LogEntry {
+    /**
+     * Severity of the log entry.
+     */
+    export type Severity = "DEBUG" | "NOTICE" | "INFO" | "WARNING" | "ERROR";
+    export const Severity = {
+        Debug: "DEBUG",
+        Notice: "NOTICE",
+        Info: "INFO",
+        Warning: "WARNING",
+        Error: "ERROR",
+    } as const;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * A single data point in a time series metric
+ */
+export interface MetricDataPoint {
+    /** Timestamp of the data point in milliseconds since Unix epoch (UTC) */
+    timestamp?: number;
+    /** The metric value */
+    value?: number;
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ServiceExecutionDto {
+    id?: string;
+    createdAt?: string;
+    startedAt?: string;
+    endedAt?: string;
+    status?: ServiceExecutionDto.Status;
+}
+
+export namespace ServiceExecutionDto {
+    export type Status = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELLED";
+    export const Status = {
+        Unknown: "UNKNOWN",
+        Pending: "PENDING",
+        Running: "RUNNING",
+        Succeeded: "SUCCEEDED",
+        Failed: "FAILED",
+        Cancelled: "CANCELLED",
+    } as const;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as PlanqkApi from "../index.js";
+
+export type ServiceExecutionLogs = PlanqkApi.LogEntry[];

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as PlanqkApi from "../index.js";
+
+/**
+ * Resource usage metrics for a service execution
+ */
+export interface ServiceExecutionMetrics {
+    /** Service execution ID */
+    serviceExecutionId?: string;
+    /** CPU usage metrics time series */
+    cpuUsage?: PlanqkApi.MetricDataPoint[];
+    /** CPU limit metrics time series */
+    cpuLimit?: PlanqkApi.MetricDataPoint[];
+    /** Memory usage metrics time series */
+    memoryUsage?: PlanqkApi.MetricDataPoint[];
+    /** Memory limit metrics time series */
+    memoryLimit?: PlanqkApi.MetricDataPoint[];
+    /** Time range start */
+    startTime?: string;
+    /** Time range end */
+    endTime?: string;
+}

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

@@ -0,0 +1,48 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ServiceJobDto {
+    /** The ID of the service job. */
+    id?: string;
+    /** The ID of the service for which this job was created. */
+    serviceId?: string;
+    /** The ID of the service definition for which this job was created. */
+    serviceDefinitionId?: string;
+    /** Status of the service job. */
+    status?: ServiceJobDto.Status;
+    /** Timestamp when the service job was created. */
+    createdAt?: string;
+    /** Timestamp when the service job started. */
+    startedAt?: string;
+    /** Timestamp when the service job ended. */
+    endedAt?: string;
+    /** Type identifier for the service job, indicating whether the underlying service is a 'managed' or 'workflow' service. */
+    type?: ServiceJobDto.Type;
+    /** List of tags associated with the service job. Tags are saved in lowercase and can be used for filtering and searching. */
+    tags?: string[];
+}
+
+export namespace ServiceJobDto {
+    /**
+     * Status of the service job.
+     */
+    export type Status = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELLED";
+    export const Status = {
+        Unknown: "UNKNOWN",
+        Pending: "PENDING",
+        Running: "RUNNING",
+        Succeeded: "SUCCEEDED",
+        Failed: "FAILED",
+        Cancelled: "CANCELLED",
+    } as const;
+    /**
+     * Type identifier for the service job, indicating whether the underlying service is a 'managed' or 'workflow' service.
+     */
+    export type Type = "MANAGED" | "EXTERNAL" | "WORKFLOW";
+    export const Type = {
+        Managed: "MANAGED",
+        External: "EXTERNAL",
+        Workflow: "WORKFLOW",
+    } as const;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface VariableInstance {
+    id?: string;
+    name?: string;
+    type?: string;
+    value?: any;
+}

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

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as PlanqkApi from "../index.js";
+
+export interface WorkflowInstance {
+    id?: string;
+    state?: WorkflowInstance.State;
+    startedAt?: string;
+    endedAt?: string;
+    activities?: PlanqkApi.ActivityInstance[];
+    variables?: PlanqkApi.VariableInstance[];
+}
+
+export namespace WorkflowInstance {
+    export type State = "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELLED";
+    export const State = {
+        Unknown: "UNKNOWN",
+        Pending: "PENDING",
+        Running: "RUNNING",
+        Succeeded: "SUCCEEDED",
+        Failed: "FAILED",
+        Cancelled: "CANCELLED",
+    } as const;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as PlanqkApi from "../index.js";
+
+export interface WorkflowServiceExecutionDto {
+    workflowInstance?: PlanqkApi.WorkflowInstance;
+    workflowModel?: string;
+}

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

@@ -1,3 +1,13 @@
 export * from "./OauthScope.js";
 export * from "./DataPoolDto.js";
+export * from "./ServiceJobDto.js";
 export * from "./DataPoolFileDto.js";
+export * from "./LogEntry.js";
+export * from "./ServiceExecutionLogs.js";
+export * from "./ServiceExecutionDto.js";
+export * from "./ActivityInstance.js";
+export * from "./VariableInstance.js";
+export * from "./WorkflowInstance.js";
+export * from "./WorkflowServiceExecutionDto.js";
+export * from "./MetricDataPoint.js";
+export * from "./ServiceExecutionMetrics.js";

package/src/sdk/core/exports.ts

@@ -0,0 +1 @@
+export * from "./file/exports.js";

package/src/sdk/core/fetcher/Fetcher.ts

@@ -1,14 +1,14 @@
 import { toJson } from "../json.js";
 import { APIResponse } from "./APIResponse.js";
-import { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
-import { Supplier } from "./Supplier.js";
 import { createRequestUrl } from "./createRequestUrl.js";
 import { getErrorResponseBody } from "./getErrorResponseBody.js";
 import { getFetchFn } from "./getFetchFn.js";
 import { getRequestBody } from "./getRequestBody.js";
 import { getResponseBody } from "./getResponseBody.js";
 import { makeRequest } from "./makeRequest.js";
+import { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
 import { requestWithRetries } from "./requestWithRetries.js";
+import { Supplier } from "./Supplier.js";
 
 export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
 
@@ -18,7 +18,7 @@ export declare namespace Fetcher {
         method: string;
         contentType?: string;
         headers?: Record<string, string | Supplier<string | undefined> | undefined>;
-        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        queryParameters?: Record<string, unknown>;
         body?: unknown;
         timeoutMs?: number;
         maxRetries?: number;

package/src/sdk/core/fetcher/index.ts

@@ -1,9 +1,9 @@
 export type { APIResponse } from "./APIResponse.js";
-export { fetcher } from "./Fetcher.js";
+export type { BinaryResponse } from "./BinaryResponse.js";
 export type { Fetcher, FetchFunction } from "./Fetcher.js";
+export { fetcher } from "./Fetcher.js";
 export { getHeader } from "./getHeader.js";
-export { Supplier } from "./Supplier.js";
-export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
-export type { RawResponse, WithRawResponse } from "./RawResponse.js";
 export { HttpResponsePromise } from "./HttpResponsePromise.js";
-export { BinaryResponse } from "./BinaryResponse.js";
+export type { RawResponse, WithRawResponse } from "./RawResponse.js";
+export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.js";
+export { Supplier } from "./Supplier.js";

package/src/sdk/core/file/exports.ts

@@ -0,0 +1 @@
+export { Uploadable } from "./types.js";

package/src/sdk/core/file/file.ts

@@ -0,0 +1,186 @@
+import { Uploadable } from "./types.js";
+
+export async function toBinaryUploadRequest(
+    file: Uploadable,
+): Promise<{ body: Uploadable.FileLike; headers?: Record<string, string> }> {
+    const { data, filename, contentLength, contentType } = await getFileWithMetadata(file);
+    const request = {
+        body: data,
+        headers: {} as Record<string, string>,
+    };
+    if (filename) {
+        request.headers["Content-Disposition"] = `attachment; filename="${filename}"`;
+    }
+    if (contentType) {
+        request.headers["Content-Type"] = contentType;
+    }
+    if (contentLength != null) {
+        request.headers["Content-Length"] = contentLength.toString();
+    }
+    return request;
+}
+
+async function getFileWithMetadata(file: Uploadable): Promise<Uploadable.WithMetadata> {
+    if (isFileLike(file)) {
+        return getFileWithMetadata({
+            data: file,
+        });
+    }
+    if ("path" in file) {
+        const fs = await import("fs");
+        if (!fs || !fs.createReadStream) {
+            throw new Error("File path uploads are not supported in this environment.");
+        }
+        const data = fs.createReadStream(file.path);
+        const contentLength = file.contentLength ?? (await tryGetFileSizeFromPath(file.path));
+        const filename = file.filename ?? getNameFromPath(file.path);
+        return {
+            data,
+            filename,
+            contentType: file.contentType,
+            contentLength,
+        };
+    }
+    if ("data" in file) {
+        const data = file.data;
+        const contentLength = file.contentLength ?? (await tryGetContentLengthFromFileLike(data));
+        const filename = file.filename ?? tryGetNameFromFileLike(data);
+        return {
+            data,
+            filename,
+            contentType: file.contentType ?? tryGetContentTypeFromFileLike(data),
+            contentLength,
+        };
+    }
+
+    throw new Error(`Invalid FileUpload of type ${typeof file}: ${JSON.stringify(file)}`);
+}
+
+function isFileLike(value: unknown): value is Uploadable.FileLike {
+    return (
+        isBuffer(value) ||
+        isArrayBufferView(value) ||
+        isArrayBuffer(value) ||
+        isUint8Array(value) ||
+        isBlob(value) ||
+        isFile(value) ||
+        isStreamLike(value) ||
+        isReadableStream(value)
+    );
+}
+
+async function tryGetFileSizeFromPath(path: string): Promise<number | undefined> {
+    try {
+        const fs = await import("fs");
+        if (!fs || !fs.promises || !fs.promises.stat) {
+            return undefined;
+        }
+        const fileStat = await fs.promises.stat(path);
+        return fileStat.size;
+    } catch (fallbackError) {
+        return undefined;
+    }
+}
+
+function tryGetNameFromFileLike(data: Uploadable.FileLike): string | undefined {
+    if (isNamedValue(data)) {
+        return data.name;
+    }
+    if (isPathedValue(data)) {
+        return getNameFromPath(data.path.toString());
+    }
+    return undefined;
+}
+
+async function tryGetContentLengthFromFileLike(data: Uploadable.FileLike): Promise<number | undefined> {
+    if (isBuffer(data)) {
+        return data.length;
+    }
+    if (isArrayBufferView(data)) {
+        return data.byteLength;
+    }
+    if (isArrayBuffer(data)) {
+        return data.byteLength;
+    }
+    if (isBlob(data)) {
+        return data.size;
+    }
+    if (isFile(data)) {
+        return data.size;
+    }
+    if (isPathedValue(data)) {
+        return await tryGetFileSizeFromPath(data.path.toString());
+    }
+    return undefined;
+}
+
+function tryGetContentTypeFromFileLike(data: Uploadable.FileLike): string | undefined {
+    if (isBlob(data)) {
+        return data.type;
+    }
+    if (isFile(data)) {
+        return data.type;
+    }
+
+    return undefined;
+}
+
+function getNameFromPath(path: string): string | undefined {
+    const lastForwardSlash = path.lastIndexOf("/");
+    const lastBackSlash = path.lastIndexOf("\\");
+    const lastSlashIndex = Math.max(lastForwardSlash, lastBackSlash);
+    return lastSlashIndex >= 0 ? path.substring(lastSlashIndex + 1) : path;
+}
+
+type NamedValue = {
+    name: string;
+} & unknown;
+
+type PathedValue = {
+    path: string | { toString(): string };
+} & unknown;
+
+type StreamLike = {
+    read?: () => unknown;
+    pipe?: (dest: unknown) => unknown;
+} & unknown;
+
+function isNamedValue(value: unknown): value is NamedValue {
+    return typeof value === "object" && value != null && "name" in value;
+}
+
+function isPathedValue(value: unknown): value is PathedValue {
+    return typeof value === "object" && value != null && "path" in value;
+}
+
+function isStreamLike(value: unknown): value is StreamLike {
+    return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
+}
+
+function isReadableStream(value: unknown): value is ReadableStream {
+    return typeof value === "object" && value != null && "getReader" in value;
+}
+
+function isBuffer(value: unknown): value is Buffer {
+    return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
+}
+
+function isArrayBufferView(value: unknown): value is ArrayBufferView {
+    return typeof ArrayBuffer !== "undefined" && ArrayBuffer.isView(value);
+}
+
+function isArrayBuffer(value: unknown): value is ArrayBuffer {
+    return typeof ArrayBuffer !== "undefined" && value instanceof ArrayBuffer;
+}
+
+function isUint8Array(value: unknown): value is Uint8Array {
+    return typeof Uint8Array !== "undefined" && value instanceof Uint8Array;
+}
+
+function isBlob(value: unknown): value is Blob {
+    return typeof Blob !== "undefined" && value instanceof Blob;
+}
+
+function isFile(value: unknown): value is File {
+    return typeof File !== "undefined" && value instanceof File;
+}

package/src/sdk/core/file/index.ts

@@ -0,0 +1,2 @@
+export * from "./file.js";
+export * from "./types.js";

package/src/sdk/core/file/types.ts

@@ -0,0 +1,81 @@
+/**
+ * A file that can be uploaded. Can be a file-like object (stream, buffer, blob, etc.),
+ * a path to a file, or an object with a file-like object and metadata.
+ */
+export type Uploadable = Uploadable.FileLike | Uploadable.FromPath | Uploadable.WithMetadata;
+
+export namespace Uploadable {
+    /**
+     * Various file-like objects that can be used to upload a file.
+     */
+    export type FileLike =
+        | ArrayBuffer
+        | ArrayBufferLike
+        | ArrayBufferView
+        | Uint8Array
+        | import("buffer").Buffer
+        | import("buffer").Blob
+        | import("buffer").File
+        | import("stream").Readable
+        | import("stream/web").ReadableStream
+        | globalThis.Blob
+        | globalThis.File
+        | ReadableStream;
+
+    /**
+     * A file path with optional metadata, used for uploading a file from the file system.
+     */
+    export type FromPath = {
+        /** The path to the file to upload */
+        path: string;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * If not provided, the file size will be determined from the file system.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         */
+        contentLength?: number;
+    };
+
+    /**
+     * A file-like object with metadata, used for uploading files.
+     */
+    export type WithMetadata = {
+        /** The file data */
+        data: FileLike;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         *
+         * If not provided, the content type may be determined from the data itself.
+         * * If the data is a `File`, `Blob`, or similar, the content type will be determined from the file itself, if the type is set.
+         * * Any other data type will not have a content type set, and the upload request will use `Content-Type: application/octet-stream` instead.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         * If the content length is not provided and cannot be determined, the upload request will not include the `Content-Length` header, but will use `Transfer-Encoding: chunked` instead.
+         *
+         * If not provided, the file size will be determined depending on the data type.
+         * * If the data is of type `fs.ReadStream` (`createReadStream`), the size will be determined from the file system.
+         * * If the data is a `Buffer`, `ArrayBuffer`, `Uint8Array`, `Blob`, `File`, or similar, the size will be determined from the data itself.
+         * * If the data is a `Readable` or `ReadableStream`, the size will not be determined.
+         */
+        contentLength?: number;
+    };
+}

package/src/sdk/core/form-data-utils/FormDataWrapper.ts

@@ -125,7 +125,10 @@ export class FormDataWrapper {
     private async convertToBlob(value: unknown): Promise<Blob> {
         if (isStreamLike(value) || isReadableStream(value)) {
             const buffer = await streamToBuffer(value);
-            return new Blob([buffer]);
+            // Create a new Uint8Array to ensure ArrayBuffer compatibility
+            const uint8Array = new Uint8Array(buffer.length);
+            uint8Array.set(buffer);
+            return new Blob([uint8Array]);
         }
 
         if (value instanceof Blob) {
@@ -133,7 +136,10 @@ export class FormDataWrapper {
         }
 
         if (isBuffer(value)) {
-            return new Blob([value]);
+            // Create a new Uint8Array to ensure ArrayBuffer compatibility
+            const uint8Array = new Uint8Array(value.length);
+            uint8Array.set(value);
+            return new Blob([uint8Array]);
         }
 
         if (value instanceof ArrayBuffer) {
@@ -141,7 +147,10 @@ export class FormDataWrapper {
         }
 
         if (isArrayBufferView(value)) {
-            return new Blob([value]);
+            // Create a new Uint8Array to ensure ArrayBuffer compatibility
+            const uint8Array = new Uint8Array(value.byteLength);
+            uint8Array.set(new Uint8Array(value.buffer, value.byteOffset, value.byteLength));
+            return new Blob([uint8Array]);
         }
 
         if (typeof value === "string") {

package/src/sdk/core/index.ts

@@ -2,4 +2,4 @@ export * from "./fetcher/index.js";
 export * from "./runtime/index.js";
 export * as url from "./url/index.js";
 export * from "./form-data-utils/index.js";
-export * from "./file.js";
+export * as file from "./file/index.js";

package/src/sdk/core/url/join.ts

@@ -3,6 +3,10 @@ export function join(base: string, ...segments: string[]): string {
         return "";
     }
 
+    if (segments.length === 0) {
+        return base;
+    }
+
     if (base.includes("://")) {
         let url: URL;
         try {
@@ -12,6 +16,9 @@ export function join(base: string, ...segments: string[]): string {
             return joinPath(base, ...segments);
         }
 
+        const lastSegment = segments[segments.length - 1];
+        const shouldPreserveTrailingSlash = lastSegment && lastSegment.endsWith("/");
+
         for (const segment of segments) {
             const cleanSegment = trimSlashes(segment);
             if (cleanSegment) {
@@ -19,6 +26,10 @@ export function join(base: string, ...segments: string[]): string {
             }
         }
 
+        if (shouldPreserveTrailingSlash && !url.pathname.endsWith("/")) {
+            url.pathname += "/";
+        }
+
         return url.toString();
     }
 
@@ -26,8 +37,15 @@ export function join(base: string, ...segments: string[]): string {
 }
 
 function joinPath(base: string, ...segments: string[]): string {
+    if (segments.length === 0) {
+        return base;
+    }
+
     let result = base;
 
+    const lastSegment = segments[segments.length - 1];
+    const shouldPreserveTrailingSlash = lastSegment && lastSegment.endsWith("/");
+
     for (const segment of segments) {
         const cleanSegment = trimSlashes(segment);
         if (cleanSegment) {
@@ -35,6 +53,10 @@ function joinPath(base: string, ...segments: string[]): string {
         }
     }
 
+    if (shouldPreserveTrailingSlash && !result.endsWith("/")) {
+        result += "/";
+    }
+
     return result;
 }
 
@@ -48,8 +70,11 @@ function joinPathSegments(left: string, right: string): string {
 function trimSlashes(str: string): string {
     if (!str) return str;
 
-    let start = str.startsWith("/") ? 1 : 0;
-    let end = str.endsWith("/") ? str.length - 1 : str.length;
+    let start = 0;
+    let end = str.length;
+
+    if (str.startsWith("/")) start = 1;
+    if (str.endsWith("/")) end = str.length - 1;
 
-    return str.slice(start, end);
+    return start === 0 && end === str.length ? str : str.slice(start, end);
 }

package/src/sdk/exports.ts

@@ -0,0 +1 @@
+export * from "./core/exports.js";

package/src/sdk/index.ts

@@ -2,3 +2,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";
+export * from "./exports.js";