@hahnpro/hpc-api 2025.2.4 → 2025.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2025.2.4",
+  "version": "2025.2.6",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {
@@ -8,7 +8,7 @@
     "url": "https://hahnpro.com"
   },
   "dependencies": {
-    "axios": "1.8.2",
+    "axios": "1.8.4",
     "eventsource": "3.0.5",
     "form-data": "4.0.2",
     "jose": "5.10.0",

package/src/index.d.ts

@@ -1,11 +1,9 @@
 export * from './lib/api';
 export type * from './lib/interfaces';
-export * from './lib/asset.interface';
 export * from './lib/content.interface';
 export * from './lib/data.interface';
 export * from './lib/data.service';
 export * from './lib/endpoint.interface';
-export * from './lib/events.interface';
 export * from './lib/flow.interface';
 export * from './lib/flow-deployment.interface';
 export * from './lib/flow-function.interface';
@@ -13,9 +11,7 @@ export * from './lib/http.service';
 export * from './lib/label.interface';
 export * from './lib/mock';
 export * from './lib/notification.interface';
-export * from './lib/resource.interface';
 export * from './lib/schema.interface';
 export * from './lib/secret.interface';
 export * from './lib/task.interface';
-export * from './lib/timeseries.interface';
 export * from './lib/vault.interface';

package/src/index.js

@@ -2,12 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lib/api"), exports);
-tslib_1.__exportStar(require("./lib/asset.interface"), exports);
 tslib_1.__exportStar(require("./lib/content.interface"), exports);
 tslib_1.__exportStar(require("./lib/data.interface"), exports);
 tslib_1.__exportStar(require("./lib/data.service"), exports);
 tslib_1.__exportStar(require("./lib/endpoint.interface"), exports);
-tslib_1.__exportStar(require("./lib/events.interface"), exports);
 tslib_1.__exportStar(require("./lib/flow.interface"), exports);
 tslib_1.__exportStar(require("./lib/flow-deployment.interface"), exports);
 tslib_1.__exportStar(require("./lib/flow-function.interface"), exports);
@@ -15,9 +13,7 @@ tslib_1.__exportStar(require("./lib/http.service"), exports);
 tslib_1.__exportStar(require("./lib/label.interface"), exports);
 tslib_1.__exportStar(require("./lib/mock"), exports);
 tslib_1.__exportStar(require("./lib/notification.interface"), exports);
-tslib_1.__exportStar(require("./lib/resource.interface"), exports);
 tslib_1.__exportStar(require("./lib/schema.interface"), exports);
 tslib_1.__exportStar(require("./lib/secret.interface"), exports);
 tslib_1.__exportStar(require("./lib/task.interface"), exports);
-tslib_1.__exportStar(require("./lib/timeseries.interface"), exports);
 tslib_1.__exportStar(require("./lib/vault.interface"), exports);

package/src/lib/alert.interface.d.ts

@@ -0,0 +1,43 @@
+import { Author, Owner } from './interfaces';
+export interface Alert {
+    id?: string;
+    name: string;
+    description?: string;
+    tsRefs: TimeSeriesReference[];
+    status: string;
+    condition: AlertCondition;
+    messageTmpl?: string;
+    tags?: string[];
+    readPermissions: string[];
+    readWritePermissions: string[];
+    createdBy?: Author;
+    updatedBy?: Author;
+    owner?: Owner;
+}
+export interface AlertCondition {
+    type: AlertType;
+    level: AlertLevel;
+    operator?: string;
+    range?: number[];
+    value?: number;
+    change?: string;
+    period?: string;
+    stopPeriod?: string;
+}
+export interface TimeSeriesReference {
+    alias?: string;
+    id: string;
+    field: string;
+}
+export declare enum AlertType {
+    Threshold = "threshold",
+    Relative = "relative",
+    Deadman = "deadman"
+}
+export declare enum AlertLevel {
+    CRITICAL = "CRITICAL",
+    WARNING = "WARNING",
+    INFO = "INFO",
+    OK = "OK",
+    ANY = "ANY"
+}

package/src/lib/alert.interface.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertLevel = exports.AlertType = void 0;
+var AlertType;
+(function (AlertType) {
+    AlertType["Threshold"] = "threshold";
+    AlertType["Relative"] = "relative";
+    AlertType["Deadman"] = "deadman";
+})(AlertType || (exports.AlertType = AlertType = {}));
+var AlertLevel;
+(function (AlertLevel) {
+    AlertLevel["CRITICAL"] = "CRITICAL";
+    AlertLevel["WARNING"] = "WARNING";
+    AlertLevel["INFO"] = "INFO";
+    AlertLevel["OK"] = "OK";
+    AlertLevel["ANY"] = "ANY";
+})(AlertLevel || (exports.AlertLevel = AlertLevel = {}));

package/src/lib/alert.service.d.ts

@@ -0,0 +1,6 @@
+import { Alert } from './alert.interface';
+import { DataService } from './data.service';
+import { HttpClient } from './http.service';
+export declare class AlertService extends DataService<Alert> {
+    constructor(httpClient: HttpClient);
+}

package/src/lib/alert.service.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertService = void 0;
+const data_service_1 = require("./data.service");
+class AlertService extends data_service_1.DataService {
+    constructor(httpClient) {
+        super(httpClient, '/alerts');
+    }
+}
+exports.AlertService = AlertService;

package/src/lib/api.d.ts

@@ -1,31 +1,30 @@
-import { AssetService } from './asset.service';
-import { AssetTypesService } from './assettypes.service';
+import { AlertService } from './alert.service';
 import { ContentService } from './content.service';
 import { EndpointService } from './endpoint.service';
-import { EventsService } from './events.service';
 import { FlowDeploymentService } from './flow-deployment.service';
 import { FlowFunctionService } from './flow-function.service';
 import { FlowModuleService } from './flow-module.service';
 import { FlowService } from './flow.service';
 import { HttpClient } from './http.service';
 import { LabelService } from './label.service';
+import { NotificationRuleService } from './notification-rule.service';
 import { NotificationService } from './notification.service';
 import { OrganizationService } from './organization.service';
 import { ProxyService } from './proxy.service';
 import { SecretService } from './secret.service';
-import { AiService } from './services';
+import { AiService, AssetService, AssetTypesService, EventService, TimeSeriesService } from './services';
 import { TaskService } from './task.service';
-import { TimeSeriesService } from './timeseries.service';
 import { UserService } from './user.service';
 import { VaultService } from './vault.service';
 export declare class API {
     readonly httpClient?: HttpClient;
     ai: AiService;
+    alerts: AlertService;
     assets: AssetService;
     assetTypes: AssetTypesService;
     contents: ContentService;
     endpoints: EndpointService;
-    events: EventsService;
+    events: EventService;
     flows: FlowService;
     flowDeployments: FlowDeploymentService;
     flowFunctions: FlowFunctionService;
@@ -39,6 +38,7 @@ export declare class API {
     users: UserService;
     vault: VaultService;
     notifications: NotificationService;
+    notificationRules: NotificationRuleService;
     constructor(httpClient?: HttpClient, context?: {
         tokenSubject?: string;
     });

package/src/lib/api.js

@@ -1,24 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.API = void 0;
-const asset_service_1 = require("./asset.service");
-const assettypes_service_1 = require("./assettypes.service");
+const alert_service_1 = require("./alert.service");
 const content_service_1 = require("./content.service");
 const endpoint_service_1 = require("./endpoint.service");
-const events_service_1 = require("./events.service");
 const flow_deployment_service_1 = require("./flow-deployment.service");
 const flow_function_service_1 = require("./flow-function.service");
 const flow_module_service_1 = require("./flow-module.service");
 const flow_service_1 = require("./flow.service");
 const http_service_1 = require("./http.service");
 const label_service_1 = require("./label.service");
+const notification_rule_service_1 = require("./notification-rule.service");
 const notification_service_1 = require("./notification.service");
 const organization_service_1 = require("./organization.service");
 const proxy_service_1 = require("./proxy.service");
 const secret_service_1 = require("./secret.service");
 const services_1 = require("./services");
 const task_service_1 = require("./task.service");
-const timeseries_service_1 = require("./timeseries.service");
 const user_service_1 = require("./user.service");
 const vault_service_1 = require("./vault.service");
 class API {
@@ -45,11 +43,12 @@ class API {
             this.httpClient = new http_service_1.HttpClient(apiUrl, authUrl, realm, client, secret, context?.tokenSubject);
         }
         this.ai = new services_1.AiService(this.httpClient);
-        this.assets = new asset_service_1.AssetService(this.httpClient);
-        this.assetTypes = new assettypes_service_1.AssetTypesService(this.httpClient);
+        this.alerts = new alert_service_1.AlertService(this.httpClient);
+        this.assets = new services_1.AssetService(this.httpClient);
+        this.assetTypes = new services_1.AssetTypesService(this.httpClient);
         this.contents = new content_service_1.ContentService(this.httpClient);
         this.endpoints = new endpoint_service_1.EndpointService(this.httpClient);
-        this.events = new events_service_1.EventsService(this.httpClient);
+        this.events = new services_1.EventService(this.httpClient);
         this.flows = new flow_service_1.FlowService(this.httpClient);
         this.flowDeployments = new flow_deployment_service_1.FlowDeploymentService(this.httpClient);
         this.flowFunctions = new flow_function_service_1.FlowFunctionService(this.httpClient);
@@ -59,10 +58,11 @@ class API {
         this.proxy = new proxy_service_1.ProxyService(this.httpClient);
         this.secrets = new secret_service_1.SecretService(this.httpClient);
         this.tasks = new task_service_1.TaskService(this.httpClient);
-        this.timeSeries = new timeseries_service_1.TimeSeriesService(this.httpClient);
+        this.timeSeries = new services_1.TimeSeriesService(this.httpClient);
         this.users = new user_service_1.UserService(this.httpClient);
         this.vault = new vault_service_1.VaultService(this.httpClient);
         this.notifications = new notification_service_1.NotificationService(this.httpClient);
+        this.notificationRules = new notification_rule_service_1.NotificationRuleService(this.httpClient);
     }
 }
 exports.API = API;

package/src/lib/content.interface.d.ts

@@ -1,3 +1,4 @@
+import { Author, Owner } from './interfaces';
 import { Storage } from './storage.interface';
 export interface Content {
     id?: string;
@@ -10,6 +11,9 @@ export interface Content {
     tags?: string[];
     assets?: string[];
     files?: Storage[];
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;

package/src/lib/flow-deployment.interface.d.ts

@@ -1,5 +1,5 @@
 import { FlowDiagram, FlowDto } from './flow.interface';
-import { Resource } from './resource.interface';
+import { Resource } from './interfaces';
 import { Storage } from './storage.interface';
 export interface FlowDeployment extends Resource {
     flow: string | FlowDto;

package/src/lib/flow-deployment.service.d.ts

@@ -2,7 +2,7 @@ import { APIBase } from './api-base';
 import { DataService } from './data.service';
 import { FlowDeployment, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowLog } from './flow-deployment.interface';
 import { HttpClient, TokenOption } from './http.service';
-import { ResourceReference } from './resource.interface';
+import { ResourceReference } from './interfaces';
 import { TrashService } from './trash.service';
 interface BaseService extends DataService<FlowDeployment>, TrashService<FlowDeployment> {
 }

package/src/lib/flow.interface.d.ts

@@ -1,5 +1,5 @@
 import { FlowDeployment } from './flow-deployment.interface';
-import { Resource } from './resource.interface';
+import { Resource } from './interfaces';
 import { JsonSchemaForm } from './schema.interface';
 export interface FlowDto extends Resource {
     diagram: string | FlowDiagram;

package/src/lib/interfaces/ai.interface.d.ts

@@ -1,4 +1,82 @@
+import { Owner } from './resource.interface';
+export interface AiAssistant {
+    id: string;
+    agent?: string;
+    pipeline?: string[];
+    i18n: Record<AvailableLanguages, AssistantLabels>;
+    icon?: string;
+    readPermissions?: string[];
+}
+type AvailableLanguages = 'de' | 'en';
+interface AssistantLabels {
+    name: string;
+    description?: string;
+    welcomeMessage?: string;
+}
+interface BaseMessage {
+    id?: string;
+    thread: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface AssistantMessage extends BaseMessage {
+    role: 'assistant';
+    content?: string;
+    agentStack?: string[];
+    status?: 'pending' | 'processing' | 'completed' | 'failed';
+    toolCalls?: {
+        type: 'tool-call';
+        toolCallId: string;
+        toolName: string;
+        args: any;
+    }[];
+    toolResults?: {
+        type: 'tool-result';
+        toolCallId: string;
+        toolName: string;
+        args: any;
+        result: any;
+    }[];
+    contextVariables?: Record<string, unknown>;
+    finishReason?: 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other' | 'unknown';
+}
+export interface SystemMessage extends BaseMessage {
+    role: 'system';
+}
+export interface ToolMessage extends BaseMessage {
+    role: 'user';
+    toolCallId?: string;
+    toolName?: string;
+    toolType?: 'handoff' | 'choice' | 'action';
+    agentStack?: string[];
+    status?: 'pending' | 'processing' | 'completed' | 'failed';
+    result?: any;
+    args?: any;
+    contextVariables?: Record<string, unknown>;
+}
+export interface UserMessage extends BaseMessage {
+    role: 'user';
+    content?: string;
+    hidden?: boolean;
+}
+export type Message = AssistantMessage | SystemMessage | ToolMessage | UserMessage;
 export interface SpeechToken {
     token: string;
     region: string;
 }
+export interface Thread {
+    id: string;
+    assistantId: string;
+    owner: Owner;
+    messages: string[] | Message[];
+    isEphemeral: boolean;
+    firstMessage?: string | Message;
+    lastMessage?: string | Message;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ThreadPopulated extends Thread {
+    firstMessage?: Message;
+    lastMessage?: Message;
+}
+export {};

package/src/lib/{asset.interface.d.ts → interfaces/asset.interface.d.ts}

@@ -1,4 +1,5 @@
-import { Content } from './content.interface';
+import { Content } from '../content.interface';
+import { Author, Owner } from './resource.interface';
 export interface AssetType {
     id?: string;
     name: string;
@@ -14,6 +15,9 @@ export interface AssetType {
     actions?: string[];
     author?: string;
     revision?: number;
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
@@ -40,6 +44,9 @@ export interface Asset {
     actions?: string[];
     author?: string;
     revision?: number;
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
     createdAt?: string;
     updatedAt?: string;
     deletedAt?: string;
@@ -76,3 +83,8 @@ export interface EventLevelOverride {
         [eventCause: string]: string;
     };
 }
+export interface Template {
+    id: string;
+    name: string;
+    template: Record<string, any>;
+}

package/src/lib/interfaces/event.interface.d.ts

@@ -0,0 +1,21 @@
+import { Author, Owner, Resource } from './resource.interface';
+export interface Event extends Resource {
+    data?: {
+        tsField: string;
+        timestamp: string;
+        value: number;
+    };
+    assetRef?: string;
+    assetRef$name?: string;
+    alertRef?: string;
+    tsRef?: string;
+    eventRef?: string;
+    cause: string;
+    level: EventLevel;
+    group?: string;
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
+}
+export type EventLevel = 'INFO' | 'OK' | 'WARNING' | 'CRITICAL';
+export type CreateEventDto = Omit<Event, 'id' | 'assetRef$name' | 'createdAt' | 'updatedAt'>;

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

@@ -1 +1,5 @@
-export type { SpeechToken } from './ai.interface';
+export type { Resource, ResourceReference, Owner, OwnerType, Author } from './resource.interface';
+export type { AiAssistant, AssistantMessage, Message, SpeechToken, SystemMessage, Thread, ThreadPopulated, ToolMessage, UserMessage, } from './ai.interface';
+export type { Action, ActionRevision, Asset, AssetRevision, AssetType, AssetTypeRevision, Attachment, EventCause, EventLevelOverride, Template, } from './asset.interface';
+export type { Event, EventLevel, CreateEventDto } from './event.interface';
+export type { TimeSeries, TimeSeriesBucket, TimeSeriesCondition, TimeSeriesValue, TS_GROUPS } from './timeseries.interface';

package/src/lib/{resource.interface.d.ts → interfaces/resource.interface.d.ts}

@@ -1,32 +1,34 @@
-export interface ResourceReference {
-    id: string;
-    resourceType: string;
-    dependent?: boolean;
-}
 export interface Resource {
-    id: string;
-    owner?: Owner;
+    id?: string;
     name: string;
-    readPermissions: string[];
-    readWritePermissions: string[];
     description?: string;
-    author?: string;
     tags?: string[];
     refs?: ResourceReference[];
-    createdAt?: string | Date;
-    updatedAt?: string | Date;
-    deletedAt?: string | Date;
-    revision?: string;
+    readPermissions: string[];
+    readWritePermissions: string[];
+    owner?: Owner;
+    createdAt?: string;
     createdBy?: Author;
+    updatedAt?: string;
     updatedBy?: Author;
+    deletedAt?: string;
 }
-export interface Author {
+export interface ResourceReference {
     id: string;
-    username: string;
-    impersonatorId?: string;
-    impersonatorUsername?: string;
+    resourceType: string;
+    dependent?: boolean;
 }
 export interface Owner {
     id: string;
-    type: 'org' | 'user';
+    type: OwnerType;
+}
+export declare enum OwnerType {
+    ORG = "org",
+    USER = "user"
+}
+export interface Author {
+    id: string;
+    username?: string;
+    impersonatorId?: string;
+    impersonatorUsername?: string;
 }

package/src/lib/interfaces/resource.interface.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OwnerType = void 0;
+var OwnerType;
+(function (OwnerType) {
+    OwnerType["ORG"] = "org";
+    OwnerType["USER"] = "user";
+})(OwnerType || (exports.OwnerType = OwnerType = {}));

package/src/lib/mock/ai.mock.service.d.ts

@@ -1,9 +1,21 @@
 import { APIBase } from '../api-base';
+import { Paginated } from '../data.interface';
 import { HttpClient } from '../http.service';
-import { SpeechToken } from '../interfaces';
+import { AiAssistant, Message, SpeechToken, Thread, ThreadPopulated } from '../interfaces';
 import { AiService } from '../services';
 export declare class AiMockService extends APIBase implements AiService {
     httpClient: HttpClient;
     basePath: string;
+    message(message: string, threadId?: string, assistantId?: string): Promise<Message>;
+    createThread(assistantId: string): Promise<ThreadPopulated>;
+    getLatestAssistantThread(assistantId: string): Promise<ThreadPopulated>;
+    getAssistant(assistantId: string): Promise<AiAssistant>;
+    getAssistants(): Promise<AiAssistant[]>;
     getSpeechToken(): Promise<SpeechToken>;
+    getThreadMessages(threadId: string): Promise<Paginated<Message[]>>;
+    getThread(threadId: string): Promise<ThreadPopulated>;
+    getLatestThread(): Promise<ThreadPopulated>;
+    listThreads(): Promise<ThreadPopulated[]>;
+    listAssistantThreads(assistantId: string): Promise<ThreadPopulated[]>;
+    deleteThread(threadId: string): Promise<Thread>;
 }

package/src/lib/mock/ai.mock.service.js

@@ -3,7 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AiMockService = void 0;
 const api_base_1 = require("../api-base");
 class AiMockService extends api_base_1.APIBase {
-    async getSpeechToken() {
+    message(message, threadId, assistantId) {
+        throw new Error('Method not implemented.');
+    }
+    createThread(assistantId) {
+        throw new Error('Method not implemented.');
+    }
+    getLatestAssistantThread(assistantId) {
+        throw new Error('Method not implemented.');
+    }
+    getAssistant(assistantId) {
+        throw new Error('Method not implemented.');
+    }
+    getAssistants() {
+        throw new Error('Method not implemented.');
+    }
+    getSpeechToken() {
+        throw new Error('Method not implemented.');
+    }
+    getThreadMessages(threadId) {
+        throw new Error('Method not implemented.');
+    }
+    getThread(threadId) {
+        throw new Error('Method not implemented.');
+    }
+    getLatestThread() {
+        throw new Error('Method not implemented.');
+    }
+    listThreads() {
+        throw new Error('Method not implemented.');
+    }
+    listAssistantThreads(assistantId) {
+        throw new Error('Method not implemented.');
+    }
+    deleteThread(threadId) {
         throw new Error('Method not implemented.');
     }
 }

package/src/lib/mock/api.mock.d.ts

@@ -1,8 +1,7 @@
+import { AlertService } from '../alert.service';
 import { API } from '../api';
-import { Asset, AssetRevision, AssetType } from '../asset.interface';
 import { Content } from '../content.interface';
 import { Endpoint } from '../endpoint.interface';
-import { Event } from '../events.interface';
 import { FlowDeployment } from '../flow-deployment.interface';
 import { FlowDeploymentService } from '../flow-deployment.service';
 import { FlowFunctionDto, FlowFunctionRevision } from '../flow-function.interface';
@@ -11,20 +10,21 @@ import { FlowModule } from '../flow-module.interface';
 import { FlowModuleService } from '../flow-module.service';
 import { FlowDiagram, FlowDto, FlowRevision } from '../flow.interface';
 import { FlowService } from '../flow.service';
+import { Asset, AssetRevision, AssetType, Event, TimeSeries, TimeSeriesValue } from '../interfaces';
 import { Label } from '../label.interface';
+import { NotificationRuleService } from '../notification-rule.service';
 import { Notification } from '../notification.interface';
 import { Organization } from '../organization.interface';
 import { Secret } from '../secret.interface';
 import { AiService } from '../services';
 import { Artifact } from '../storage.interface';
 import { Task } from '../task.interface';
-import { TimeSeries, TimeSeriesValue } from '../timeseries.interface';
 import { VaultSecret } from '../vault.interface';
 import { AssetMockService } from './asset.mock.service';
 import { AssetTypesMockService } from './assetTypes.mock.service';
 import { ContentMockService } from './content.mock.service';
 import { EndpointMockService } from './endpoint.mock.service';
-import { EventsMockService } from './events.mock.service';
+import { EventMockService } from './event.mock.service';
 import { HttpMockService } from './http.mock.service';
 import { LabelMockService } from './label.mock.service';
 import { NotificationMockService } from './notification.mock.service';
@@ -57,18 +57,20 @@ export interface MockAPIInitData {
     organizations?: OrganizationInit[];
 }
 export declare class MockAPI implements API {
-    ai: AiService;
     httpClient: HttpMockService;
+    ai: AiService;
+    alerts: AlertService;
     assets: AssetMockService;
     assetTypes: AssetTypesMockService;
     contents: ContentMockService;
     endpoints: EndpointMockService;
-    events: EventsMockService;
+    events: EventMockService;
     flows: FlowService;
     flowDeployments: FlowDeploymentService;
     flowFunctions: FlowFunctionService;
     flowModules: FlowModuleService;
     labels: LabelMockService;
+    notificationRules: NotificationRuleService;
     proxy: any;
     secrets: SecretMockService;
     tasks: TaskMockService;