hcloud-sdk 22.2.3 → 22.3.0

package/changelog.md

@@ -1,5 +1,9 @@
-## [22.2.3](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.2.2...v22.2.3) (2026-07-22)
+## [22.3.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.2.3...v22.3.0) (2026-07-23)
 
-### Bug Fixes
+### Features
 
-* add string values to MessageSource enum members ([2b1e9f6](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/2b1e9f6a5c176301b0467b4a576c87cfb0a91860))
+* **agent:** add cache management methods ([da44ee3](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/da44ee3b051c22c3aa632f92617a4f8bed260118))
+
+### Performance Improvements
+
+* extend StreamCacheMetadata and High5ExecutionPackage interfaces ([adf2425](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/adf2425c2da8e51a7cfc99b3f6cade0c8289d91a))

package/lib/interfaces/agent/cache/index.d.ts

@@ -0,0 +1,15 @@
+export interface StreamCacheMetadata {
+    streamId: string;
+    orgName: string;
+    spaceName: string;
+    eventName: string;
+    streamName: string;
+    hash: string;
+    hits: number;
+    createdAt: number;
+    remainingTtl: number;
+    lastExecution?: number;
+}
+export interface StreamCacheWipeResult {
+    deleted: number;
+}

package/lib/interfaces/agent/cache/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -57,6 +57,8 @@ export interface High5ExecutionPackage {
     info: StreamInfo;
     debug: boolean;
     executionId: string;
+    streamName: string;
+    eventName: string;
 }
 type StreamInfo = {
     target: string;

package/lib/service/agent/cache/index.d.ts

@@ -0,0 +1,38 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { StreamCacheMetadata, StreamCacheWipeResult } from "../../../interfaces/agent/cache";
+export declare class AgentCache extends Base {
+    /**
+     * Retrieves metadata for all currently cached stream definitions.
+     * The cached design content is not exposed.
+     * @returns Array of cached stream metadata
+     */
+    listStreamCache<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, StreamCacheMetadata[]>>;
+    /**
+     * Retrieves metadata for a single cached stream entry by stream ID.
+     * The cached design content is not exposed.
+     * @param streamId - ID of the stream
+     * @returns Cached stream metadata
+     */
+    getStreamCache<R extends boolean = false>(streamId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, StreamCacheMetadata>>;
+    /**
+     * Deletes a single cached stream entry by stream ID.
+     * Does not interrupt currently running executions.
+     * @param streamId - ID of the stream cache entry to delete
+     */
+    deleteStreamCache<R extends boolean = false>(streamId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Deletes all cached stream entries.
+     * Does not interrupt currently running executions, future executions will rebuild the cache naturally.
+     * @returns Number of deleted cache entries
+     */
+    clearCache<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, StreamCacheWipeResult>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/agent/cache/index.js

@@ -0,0 +1,67 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentCache = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+class AgentCache extends Base_1.default {
+    /**
+     * Retrieves metadata for all currently cached stream definitions.
+     * The cached design content is not exposed.
+     * @returns Array of cached stream metadata
+     */
+    listStreamCache(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/cache`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Retrieves metadata for a single cached stream entry by stream ID.
+     * The cached design content is not exposed.
+     * @param streamId - ID of the stream
+     * @returns Cached stream metadata
+     */
+    getStreamCache(streamId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/cache/${streamId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Deletes a single cached stream entry by stream ID.
+     * Does not interrupt currently running executions.
+     * @param streamId - ID of the stream cache entry to delete
+     */
+    deleteStreamCache(streamId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/cache/${streamId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Deletes all cached stream entries.
+     * Does not interrupt currently running executions, future executions will rebuild the cache naturally.
+     * @returns Number of deleted cache entries
+     */
+    clearCache(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/cache`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/agent${endpoint}`;
+    }
+}
+exports.AgentCache = AgentCache;

package/lib/service/agent/index.d.ts

@@ -1,6 +1,7 @@
 import Base from "../../Base";
 import { AgentBundle } from "./bundle";
 import { DevBundle } from "./bundle/dev";
+import { AgentCache } from "./cache";
 import { AgentContext } from "./context";
 import { AgentInstaller } from "./installer";
 import { AgentLogging } from "./logging";
@@ -18,5 +19,7 @@ export default class Agent extends Base {
     private _logging?;
     get module(): AgentModule;
     private _module?;
+    get cache(): AgentCache;
+    private _cache?;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/agent/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Base_1 = __importDefault(require("../../Base"));
 const bundle_1 = require("./bundle");
 const dev_1 = require("./bundle/dev");
+const cache_1 = require("./cache");
 const context_1 = require("./context");
 const installer_1 = require("./installer");
 const logging_1 = require("./logging");
@@ -47,6 +48,12 @@ class Agent extends Base_1.default {
         }
         return this._module;
     }
+    get cache() {
+        if (this._cache === undefined) {
+            this._cache = new cache_1.AgentCache(this.options, this.axios);
+        }
+        return this._cache;
+    }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/agent${endpoint}`;
     }

package/package.json

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