hcloud-sdk 22.14.1 → 22.16.0

package/changelog.md

@@ -1,5 +1,5 @@
-## [22.14.1](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.14.0...v22.14.1) (2026-08-05)
+## [22.16.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v22.15.0...v22.16.0) (2026-08-11)
 
-### Bug Fixes
+### Features
 
-* enable @ for passkey_name ([51ed955](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/51ed955a2f697b122b2f46e99144ab84d1be1072))
+* **experimental:** add high5/stream AI service ([3b6113b](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/3b6113b32038ee9d30e9859b3eeaa8b6919a72ca))

package/lib/Hcloud.d.ts

@@ -2,6 +2,7 @@ import { AxiosInstance } from "axios";
 import { HcloudLogger, Options } from "./Base";
 import { RefreshToken } from "./interfaces/axios";
 import AgentService from "./service/agent";
+import AIService from "./service/ai";
 import AuditorService from "./service/auditor";
 import BouncerService from "./service/bouncer";
 import CosmoService from "./service/cosmo";
@@ -14,6 +15,8 @@ import NatsService from "./service/nats";
 import PanelService from "./service/panel";
 import ShortsService from "./service/shorts";
 export declare class HCloud {
+    get AI(): AIService;
+    private _AI?;
     get Agent(): AgentService;
     private _Agent?;
     get Auditor(): AuditorService;

package/lib/Hcloud.js

@@ -19,6 +19,7 @@ const ErrorHelper_1 = __importDefault(require("./helper/ErrorHelper"));
 const axios_2 = require("./interfaces/axios");
 const idp_1 = require("./interfaces/idp");
 const agent_1 = __importDefault(require("./service/agent"));
+const ai_1 = __importDefault(require("./service/ai"));
 const auditor_1 = __importDefault(require("./service/auditor"));
 const bouncer_1 = __importDefault(require("./service/bouncer"));
 const cosmo_1 = __importDefault(require("./service/cosmo"));
@@ -32,6 +33,12 @@ const panel_1 = __importDefault(require("./service/panel"));
 const shorts_1 = __importDefault(require("./service/shorts"));
 // tslint:disable-next-line
 class HCloud {
+    get AI() {
+        if (this._AI === undefined) {
+            this._AI = new ai_1.default(this.options, this.axios);
+        }
+        return this._AI;
+    }
     get Agent() {
         if (this._Agent === undefined) {
             this._Agent = new agent_1.default(this.options, this.axios);

package/lib/interfaces/ai/index.d.ts

@@ -0,0 +1,40 @@
+import { ReducedSpace } from "../global";
+import type { DesignContent } from "../high5/space/event/stream/design/StreamDesign";
+import { ReducedOrganization, ReducedUser } from "../idp";
+export type AIHigh5StreamPayloadType = "design" | "documentation";
+export interface AIHigh5StreamRequest {
+    message: string;
+    type: AIHigh5StreamPayloadType;
+    payload: DesignContent;
+}
+export type AIHigh5StreamEvent = {
+    type: "start";
+    response: AIHigh5StreamResponse;
+} | {
+    type: "chunk";
+    message: string;
+} | {
+    type: "done";
+    response: Omit<AIHigh5StreamResponse, "message">;
+} | {
+    type: "error";
+    message: string;
+};
+export type AIHigh5StreamResponse = {
+    message: string;
+    type: AIHigh5StreamPayloadType;
+    organization: ReducedOrganization;
+    space: ReducedSpace;
+    createdBy: ReducedUser;
+    createDate: number;
+} & ({
+    source: "user";
+} | {
+    source: "ai";
+    type: "design";
+    payload?: DesignContent;
+} | {
+    source: "ai";
+    type: "documentation";
+    payload?: string;
+});

package/lib/interfaces/ai/index.js

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

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

@@ -1364,11 +1364,11 @@ export declare const ErrorCodes: readonly [{
     readonly message: "Invalid storage configuration. Please run test in idp in order to validate. If still invalid, please recheck the storage configuration and/or contact your cloud storage administrator.";
 }, {
     readonly code: "009.057.0001";
-    readonly error: "address-book.not.found";
+    readonly error: "address.book.not.found";
     readonly message: "Address book not found";
 }, {
     readonly code: "009.057.0002";
-    readonly error: "address-book.name.in.use";
+    readonly error: "address.book.name.in.use";
     readonly message: "An address book with this name already exists in the space";
 }, {
     readonly code: "010.000.0002";

package/lib/interfaces/global/ErrorCodes.js

@@ -1710,12 +1710,12 @@ exports.ErrorCodes = [
     },
     {
         code: "009.057.0001",
-        error: "address-book.not.found",
+        error: "address.book.not.found",
         message: "Address book not found"
     },
     {
         code: "009.057.0002",
-        error: "address-book.name.in.use",
+        error: "address.book.name.in.use",
         message: "An address book with this name already exists in the space"
     },
     {

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

@@ -4,6 +4,7 @@ export interface High5Space extends Space {
     highestPermissionOfUser: High5SpacePermission;
     waveEngine: string;
     enableDev?: boolean;
+    eventExecutionTarget?: string;
 }
 export interface High5SpaceEntityPermission {
     organization: ReducedOrganization;

package/lib/service/ai/high5/index.d.ts

@@ -0,0 +1,7 @@
+import Base from "../../../Base";
+import { AIHigh5Stream } from "./stream";
+export default class AIHigh5 extends Base {
+    get stream(): AIHigh5Stream;
+    private _stream?;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/ai/high5/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Base_1 = __importDefault(require("../../../Base"));
+const stream_1 = require("./stream");
+class AIHigh5 extends Base_1.default {
+    get stream() {
+        if (this._stream === undefined) {
+            this._stream = new stream_1.AIHigh5Stream(this.options, this.axios);
+        }
+        return this._stream;
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/ai${endpoint}`;
+    }
+}
+exports.default = AIHigh5;

package/lib/service/ai/high5/stream/index.d.ts

@@ -0,0 +1,33 @@
+import { AxiosInstance } from "axios";
+import Base, { MaybeRaw, Options } from "../../../../Base";
+import { AIHigh5StreamEvent, type AIHigh5StreamRequest, AIHigh5StreamResponse } from "../../../../interfaces/ai";
+import { SortDirection } from "../../../../interfaces/global";
+export declare class AIHigh5Stream extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Get the message history of a High5 stream.
+     *
+     * @param organization Name of the Organization
+     * @param space Name of the Space
+     * @param streamId ID of the stream
+     * @param page (optional) The page to retrieve
+     * @param limit (optional) The maximum amount of streams that should be returned
+     * @param direction (optional) Sort direction of the returned streams
+     * @param raw (optional) If true, returns the raw Axios response
+     * @returns Array of stream responses
+     */
+    get<R extends boolean = false>(organization: string, space: string, streamId: string, page?: number, limit?: number, direction?: SortDirection, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AIHigh5StreamResponse[]>>;
+    /**
+     * Send a message to a High5 stream and receive the response as a stream of Server-Sent Events.
+     *
+     * @param organization Name of the Organization
+     * @param space Name of the Space
+     * @param streamId ID of the stream
+     * @param request The message request to send
+     * @param onMessage Callback invoked for each event received from the stream
+     */
+    post(organization: string, space: string, streamId: string, request: AIHigh5StreamRequest, onMessage: (event: AIHigh5StreamEvent) => void): Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/ai/high5/stream/index.js

@@ -0,0 +1,109 @@
+"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.AIHigh5Stream = void 0;
+const Base_1 = __importDefault(require("../../../../Base"));
+class AIHigh5Stream extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+    }
+    /**
+     * Get the message history of a High5 stream.
+     *
+     * @param organization Name of the Organization
+     * @param space Name of the Space
+     * @param streamId ID of the stream
+     * @param page (optional) The page to retrieve
+     * @param limit (optional) The maximum amount of streams that should be returned
+     * @param direction (optional) Sort direction of the returned streams
+     * @param raw (optional) If true, returns the raw Axios response
+     * @returns Array of stream responses
+     */
+    get(organization, space, streamId, page, limit, direction, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/high5/org/${organization}/spaces/${space}/streams/${streamId}`), {
+                params: { limit, page, direction },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Send a message to a High5 stream and receive the response as a stream of Server-Sent Events.
+     *
+     * @param organization Name of the Organization
+     * @param space Name of the Space
+     * @param streamId ID of the stream
+     * @param request The message request to send
+     * @param onMessage Callback invoked for each event received from the stream
+     */
+    post(organization, space, streamId, request, onMessage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/high5/org/${organization}/spaces/${space}/streams/${streamId}`), request, {
+                responseType: "stream",
+                adapter: "fetch",
+                headers: {
+                    Accept: "text/event-stream",
+                },
+            });
+            const reader = resp.data.getReader();
+            const decoder = new TextDecoder();
+            let buffer = "";
+            let response;
+            while (true) {
+                const { done, value } = yield reader.read();
+                if (done) {
+                    break;
+                }
+                buffer += decoder.decode(value, { stream: true });
+                const events = buffer.split(/\r?\n\r?\n/);
+                buffer = (_a = events.pop()) !== null && _a !== void 0 ? _a : "";
+                for (const event of events) {
+                    const data = event.split(/\r?\n/).find(line => line.startsWith("data:"));
+                    if (!data) {
+                        continue;
+                    }
+                    const parsed = JSON.parse(data.slice("data:".length).trim());
+                    switch (parsed.type) {
+                        case "start":
+                            response = parsed.response;
+                            onMessage({ type: "start", response });
+                            break;
+                        case "chunk":
+                            if (!response) {
+                                throw new Error("Received chunk before start");
+                            }
+                            response.message += parsed.message;
+                            onMessage({ type: "chunk", message: parsed.message });
+                            break;
+                        case "done":
+                            if (!response) {
+                                throw new Error("Received done before start");
+                            }
+                            onMessage({ type: "done", response });
+                            return;
+                        case "error":
+                            throw new Error(parsed.message);
+                        default:
+                            throw new Error("Unknown event type");
+                    }
+                }
+            }
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/ai${endpoint}`;
+    }
+}
+exports.AIHigh5Stream = AIHigh5Stream;

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

@@ -0,0 +1,15 @@
+import Base, { MaybeRaw } from "../../Base";
+import { Version } from "../../interfaces/global";
+import AIHigh5 from "./high5";
+export default class AIService extends Base {
+    get high5(): AIHigh5;
+    private _high5?;
+    /**
+     * Requests the endpoint version
+     * @returns Version object
+     */
+    version<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Version>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/ai/index.js

@@ -0,0 +1,38 @@
+"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 });
+const Base_1 = __importDefault(require("../../Base"));
+const high5_1 = __importDefault(require("./high5"));
+class AIService extends Base_1.default {
+    get high5() {
+        if (this._high5 === undefined) {
+            this._high5 = new high5_1.default(this.options, this.axios);
+        }
+        return this._high5;
+    }
+    /**
+     * Requests the endpoint version
+     * @returns Version object
+     */
+    version(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint("/v1/version"), {});
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/ai${endpoint}`;
+    }
+}
+exports.default = AIService;

package/lib/service/high5/space/index.d.ts

@@ -149,6 +149,16 @@ export declare class High5Space extends Base {
     enableDev<R extends boolean = false>(orgName: string, spaceName: string, enableDev: boolean, raw?: {
         raw: R;
     }): Promise<MaybeRaw<R, Space>>;
+    /**
+     * Updates the execution target used when this space executes its own internal events.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param eventExecutionTarget New execution target: a user email or a pool name
+     * @returns The updated space
+     */
+    setEventExecutionTarget<R extends boolean = false>(orgName: string, spaceName: string, eventExecutionTarget: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Space>>;
     /**
      * Updates the avatar of the specified High5 space
      * @param orgName Name of the organization

package/lib/service/high5/space/index.js

@@ -246,6 +246,21 @@ class High5Space extends Base_1.default {
             return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
+    /**
+     * Updates the execution target used when this space executes its own internal events.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param eventExecutionTarget New execution target: a user email or a pool name
+     * @returns The updated space
+     */
+    setEventExecutionTarget(orgName, spaceName, eventExecutionTarget, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/target`), {
+                eventExecutionTarget,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
     /**
      * Updates the avatar of the specified High5 space
      * @param orgName Name of the organization

package/package.json

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