hcloud-sdk 22.47.0 → 22.49.0

package/changelog.md

@@ -1,5 +1,11 @@
-## [22.47.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.46.0...v22.47.0) (2026-10-05)
+## [22.49.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.48.0...v22.49.0) (2026-10-07)
 
 ### Features
 
-* add pool execute subject ([9024875](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9024875f030bd8ef190b1f9f8aa3fb9fb7efc697))
+* add a capacityInGB quota for default storage as well ([3b4ae0c](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/3b4ae0cf85bb1a85e5ba8d070c805ff216196169))
+* add capacityInGB which reflects license quota as max usable capacity ([75a1dea](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/75a1dea437d657eacd967abaad9ae3e5688bd468))
+* reflect new introduced byos license endpoint and interfaces ([efcb701](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/efcb701645e1e0f06800ba8e7c13c117d547c444))
+
+### Bug Fixes
+
+* default license quota determination and application ([e228077](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e2280774fec9b1a4969743b8c70ded3e307625fd))

package/lib/interfaces/global/Storage.d.ts

@@ -17,7 +17,13 @@ export type Storage = {
     spaces: (ReducedSpace & {
         storageUsed: number;
     })[];
+    /** Total bytes used across all spaces assigned to this storage. For the default storage only the spaces of the requesting organization. */
     storageUsed: number;
+    /**
+     * Licensed maximum capacity in GB (1 GB = 1024³ bytes). For the default storage the default storage quota of the organization.
+     * For own storages the storages quota of the organization, shared across all of its own storages (0 if own storages are not allowed).
+     */
+    capacityInGB: number;
     valid: boolean;
     errorMessage?: string;
 };
@@ -32,6 +38,21 @@ export type StorageConfiguration = {
     isDefault: boolean;
     valid: boolean;
 };
+export type StorageCapacity = {
+    storageId: string;
+    /** Organization the capacity was determined for. For own storages the owner, for the default storage the requested organization. */
+    organizationId: string;
+    /** Whether the storage is the default storage */
+    isDefault: boolean;
+    /** Whether the license of the organization allows own storages */
+    byos: boolean;
+    /** Licensed capacity in bytes. For own storages across all own storages of the organization, for the default storage the default storage quota of the organization. */
+    capacityBytes?: number;
+    /** Current usage in bytes. For own storages across all own storages of the organization, for the default storage by the spaces of the organization. */
+    usedBytes?: number;
+    /** Whether an upload of the requested size would exceed the licensed capacity */
+    exceeded: boolean;
+};
 export type StorageDto = Omit<Storage, "accessKeyId" | "secretAccessKey">;
 export type StorageCreateDto = Pick<Storage, "name" | "endpoint" | "bucket" | "region"> & {
     accessKeyId: string;

package/lib/interfaces/high5/space/execution/index.d.ts

@@ -1,5 +1,5 @@
 import { HCloud } from "../../../../Hcloud";
-import { ReducedSpace } from "../../../global";
+import { PaginatedResponse, ReducedSpace } from "../../../global";
 import { ReducedOrganization, ReducedUser } from "../../../idp";
 import { WaveCatalog, WaveEngine } from "../../wave";
 import { ReducedEvent } from "../event";
@@ -159,6 +159,27 @@ export interface High5ExecutionStatus {
     startTime?: number;
     currentRetry?: number;
     assignedClient?: string;
+    /**
+     * Plaintext payload data of the execution, only set when searching execution states by payload
+     * (filter keys "payload" or "payload.<path>"). JSON payloads are returned as JSON value, generic payloads as string.
+     */
+    payload?: unknown;
+}
+/**
+ * Response of an execution state search. Searches with payload filters count at most 1000 matches,
+ * a higher number of matches is reported with total = 1000 and totalCapped = true.
+ */
+export interface High5ExecutionStatusSearchResponse extends PaginatedResponse<High5ExecutionStatus> {
+    /** True if total holds the capped count of a payload search instead of the exact number of matches */
+    totalCapped: boolean;
+}
+/**
+ * Response of a full execution state search by payload, which considers all executions but skips the count
+ */
+export interface High5ExecutionStatusFullSearchResponse {
+    items: High5ExecutionStatus[];
+    /** True if a next page exists */
+    hasMore: boolean;
 }
 export interface High5ExecutionLog {
     _id: string;

package/lib/interfaces/idp/organization/license/index.d.ts

@@ -24,6 +24,17 @@ type LicenseQuotaBase = {
             domains: {
                 quota: number;
             };
+            /** Bring your own storage quota. Absent on older licenses, in which case own storages are not allowed. */
+            storages?: {
+                byos: boolean;
+                quota: number;
+                capacityInGB: number;
+            };
+            /** Default (hcloud provided) storage quota. Absent on older licenses, in which case a capacity of 1 GB applies. */
+            defaultStorage?: {
+                /** Maximum usage of the default storage in GB (1 GB = 1024³ bytes). */
+                capacityInGB: number;
+            };
             logPeriodInDays: number;
         };
     };

package/lib/service/high5/execution/status/index.d.ts

@@ -1,20 +1,46 @@
 import Base, { MaybeRaw } from "../../../../Base";
-import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
-import { High5ExecutionStatus } from "../../../../interfaces/high5/space/execution";
+import { SearchParams } from "../../../../interfaces/global";
+import { High5ExecutionStatusFullSearchResponse, High5ExecutionStatusSearchResponse } from "../../../../interfaces/high5/space/execution";
 export declare class High5OrganizationExecutionStates extends Base {
     /**
-     * Retrieves all stream execution logs for a given execution inside an organization.
+     * Retrieves the stream execution states of an organization.
+     *
+     * Besides the fields of the execution state, filters can target the payload of the execution:
+     * - `payload.<path>` filters JSON payloads by the value at the given property path, e.g. `payload.user.id`.
+     *   `is` matches the exact value (numbers and booleans keep their type), `starts with` is case-sensitive, `contains` and `ends with` are case-insensitive.
+     * - `payload` with `contains` is a case-insensitive text search over all string values of the payload. A single word only matches
+     *   whole words, values with separators are searched as phrase. Only the newest 10000 matching executions are considered,
+     *   use {@link fullSearchExecutionStates} to consider all of them.
+     *
+     * When filtering by payload, each state contains the `payload` of its execution and the total is capped at 1000 (see `totalCapped`).
      * @param orgName Name of the Organization
      * @param filters (optional) Array of search filters
      * @param sorting (optional) Sorting object
      * @param limit (optional) Max number of results (1-100; defaults to 25)
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
-     * @returns Object containing an array of Stream execution logs as well as the total number of results
+     * @returns Object containing an array of Stream execution states, the total number of results and whether the total is capped
      */
     searchExecutionStates<R extends boolean = false>({ orgName, filters, sorting, limit, page }: SearchParams & {
         orgName: string;
     }, raw?: {
         raw: R;
-    }): Promise<MaybeRaw<R, PaginatedResponse<High5ExecutionStatus>>>;
+    }): Promise<MaybeRaw<R, High5ExecutionStatusSearchResponse>>;
+    /**
+     * Retrieves the stream execution states of an organization by payload, considering all executions without limits.
+     * The count is skipped, so instead of a total the response tells whether a next page exists. Takes the same filters as
+     * {@link searchExecutionStates}, but can take considerably longer for payload filters matching many executions.
+     * Searches without payload filters behave like {@link searchExecutionStates}.
+     * @param orgName Name of the Organization
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Stream execution states and whether a next page exists
+     */
+    fullSearchExecutionStates<R extends boolean = false>({ orgName, filters, sorting, limit, page }: SearchParams & {
+        orgName: string;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, High5ExecutionStatusFullSearchResponse>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/high5/execution/status/index.js

@@ -18,13 +18,22 @@ const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseH
 const searchFilter_1 = require("../../../../helper/searchFilter");
 class High5OrganizationExecutionStates extends Base_1.default {
     /**
-     * Retrieves all stream execution logs for a given execution inside an organization.
+     * Retrieves the stream execution states of an organization.
+     *
+     * Besides the fields of the execution state, filters can target the payload of the execution:
+     * - `payload.<path>` filters JSON payloads by the value at the given property path, e.g. `payload.user.id`.
+     *   `is` matches the exact value (numbers and booleans keep their type), `starts with` is case-sensitive, `contains` and `ends with` are case-insensitive.
+     * - `payload` with `contains` is a case-insensitive text search over all string values of the payload. A single word only matches
+     *   whole words, values with separators are searched as phrase. Only the newest 10000 matching executions are considered,
+     *   use {@link fullSearchExecutionStates} to consider all of them.
+     *
+     * When filtering by payload, each state contains the `payload` of its execution and the total is capped at 1000 (see `totalCapped`).
      * @param orgName Name of the Organization
      * @param filters (optional) Array of search filters
      * @param sorting (optional) Sorting object
      * @param limit (optional) Max number of results (1-100; defaults to 25)
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
-     * @returns Object containing an array of Stream execution logs as well as the total number of results
+     * @returns Object containing an array of Stream execution states, the total number of results and whether the total is capped
      */
     searchExecutionStates(_a, raw_1) {
         return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0 }, raw) {
@@ -33,7 +42,34 @@ class High5OrganizationExecutionStates extends Base_1.default {
                 filters: filtersDTO,
                 sorting: sorting,
             });
-            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
+            const data = Object.assign(Object.assign({}, (0, paginatedResponseHelper_1.createPaginatedResponse)(resp)), { totalCapped: resp.headers["total-capped"] === "true" });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data }) : data);
+        });
+    }
+    /**
+     * Retrieves the stream execution states of an organization by payload, considering all executions without limits.
+     * The count is skipped, so instead of a total the response tells whether a next page exists. Takes the same filters as
+     * {@link searchExecutionStates}, but can take considerably longer for payload filters matching many executions.
+     * Searches without payload filters behave like {@link searchExecutionStates}.
+     * @param orgName Name of the Organization
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of Stream execution states and whether a next page exists
+     */
+    fullSearchExecutionStates(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0 }, raw) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/execution/status/search?page=${page}&limit=${limit}&fullSearch=true`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            // searches without payload filters are not full searches and report a total instead
+            const hasMoreHeader = resp.headers["has-more"];
+            const hasMore = hasMoreHeader !== undefined ? hasMoreHeader === "true" : (page + 1) * limit < parseInt(String(resp.headers["total"]), 10);
+            const data = { items: resp.data, hasMore };
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data }) : data);
         });
     }
     getEndpoint(endpoint) {

package/lib/service/idp/organization/storage/index.d.ts

@@ -1,6 +1,6 @@
 import Base, { MaybeRaw } from "../../../../Base";
 import { PaginatedResponse, SearchFilter, Sorting } from "../../../../interfaces/global";
-import { StorageDto as Storage, StorageConfiguration, StorageCreateDto, StoragePatchDto } from "../../../../interfaces/global/Storage";
+import { StorageDto as Storage, StorageCapacity, StorageConfiguration, StorageCreateDto, StoragePatchDto } from "../../../../interfaces/global/Storage";
 export declare class IdpOrganizationStorages extends Base {
     /**
      * Creates a new Storage in the specified Organization.
@@ -82,5 +82,20 @@ export declare class IdpOrganizationStorages extends Base {
     getStorageConfig<R extends boolean = false>(pat: string, storageId?: string, decrypt?: boolean, raw?: {
         raw: R;
     }): Promise<MaybeRaw<R, StorageConfiguration>>;
+    /**
+     * Checks whether the specified Storage can take an upload of the given size according to the license of an Organization.
+     * Own Storages are limited by the storages quota of the owning Organization, the default Storage by the default storage quota
+     * of the given Organization (counting only its Spaces). Requires a Personal Access Token (PAT) with appropriate permissions.
+     *
+     * @param pat Personal Access Token
+     * @param storageId (optional) ID of storage. If not provided or "default", the default storage is checked.
+     * @param uploadSize (optional) Size of the upload that is about to start in bytes. If omitted, it is checked whether the capacity is already reached.
+     * @param orgName (optional) Name of the Organization the upload belongs to. Required for the default storage, must be the owner for own storages.
+     * @param raw (optional) If true, returns the raw Axios response instead of the data
+     * @returns The Storage capacity
+     */
+    getStorageCapacity<R extends boolean = false>(pat: string, storageId?: string, uploadSize?: number, orgName?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, StorageCapacity>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/idp/organization/storage/index.js

@@ -129,6 +129,30 @@ class IdpOrganizationStorages extends Base_1.default {
             return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
+    /**
+     * Checks whether the specified Storage can take an upload of the given size according to the license of an Organization.
+     * Own Storages are limited by the storages quota of the owning Organization, the default Storage by the default storage quota
+     * of the given Organization (counting only its Spaces). Requires a Personal Access Token (PAT) with appropriate permissions.
+     *
+     * @param pat Personal Access Token
+     * @param storageId (optional) ID of storage. If not provided or "default", the default storage is checked.
+     * @param uploadSize (optional) Size of the upload that is about to start in bytes. If omitted, it is checked whether the capacity is already reached.
+     * @param orgName (optional) Name of the Organization the upload belongs to. Required for the default storage, must be the owner for own storages.
+     * @param raw (optional) If true, returns the raw Axios response instead of the data
+     * @returns The Storage capacity
+     */
+    getStorageCapacity(pat_1) {
+        return __awaiter(this, arguments, void 0, function* (pat, storageId = "default", uploadSize, orgName, raw) {
+            const resp = yield this.axios.get(`${this.options.server}/api/account/v1/storage/${storageId}/capacity`, {
+                params: Object.assign(Object.assign({}, (uploadSize !== undefined ? { uploadSize } : {})), (orgName !== undefined ? { orgName } : {})),
+                headers: {
+                    Authorization: `Bearer ${pat}`,
+                    "x-hcloud-login-enforce": "true",
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/account/v1/org${endpoint}`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hcloud-sdk",
-  "version": "22.47.0",
+  "version": "22.49.0",
   "description": "hcloud platform sdk",
   "main": "index.js",
   "types": "index.d.ts",