@hahnpro/hpc-api 2026.6.3 → 2026.6.5

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @hahnpro/hpc-api
 
+# 2026.6.5
+
+- Added new endpoints to the Dataspace API service client
+
 # 2026.6.1
 
 - Added Dataspace API service client

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2026.6.3",
+  "version": "2026.6.5",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {

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

@@ -78,3 +78,12 @@ export interface FlowLog {
     time: string;
     type: string;
 }
+export type NatsFlowTriggerData = {
+    correlationId: string;
+} & Record<string, unknown>;
+export type NatsFlowTriggerStatus = 'failed' | 'in progress' | 'finished';
+export declare const NATS_FLOW_TRIGGER_STATUSES: NatsFlowTriggerStatus[];
+export interface NatsFlowTriggerState {
+    status: NatsFlowTriggerStatus;
+    progress: number;
+}

package/src/lib/interfaces/flow-deployment.interface.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlowDeployment = void 0;
+exports.NATS_FLOW_TRIGGER_STATUSES = exports.FlowDeployment = void 0;
 const resource_interface_1 = require("./resource.interface");
 class FlowDeployment extends resource_interface_1.ResourceClass {
 }
 exports.FlowDeployment = FlowDeployment;
+exports.NATS_FLOW_TRIGGER_STATUSES = ['failed', 'in progress', 'finished'];

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

@@ -13,7 +13,7 @@ export type { EdgeDeviceRequestResponse, EdgeDeviceResult, WebIOData } from './e
 export type { AdditionalNotificationData, Endpoint, EndpointConfig, EndpointLog, NotificationEndpoint, NotificationEndpointLog, NotificationLogType, NotificationPayload, SearchEndpointResult, } from './endpoint.interface';
 export type { CreateEventDto, Event, EventCountByAsset } from './event.interface';
 export type { BookedExaminee, Examination, ReviewScore, TimeSlot, WorkStation } from './flange-skill-control.interface';
-export type { FlowConnection, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowElement, FlowLog, FlowModel, Metrics, Stats, StatsValues, } from './flow-deployment.interface';
+export type { FlowConnection, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowElement, FlowLog, FlowModel, NatsFlowTriggerState, NatsFlowTriggerStatus, Metrics, NatsFlowTriggerData, Stats, StatsValues, } from './flow-deployment.interface';
 export type { BillingEventsData, DeploymentId, DeploymentTriggerResponse, Executor, ExecutorEnvironment, ExecutorEventType, ExecutorId, ExecutorStats, WorkerId, } from './flow-executor.interface';
 export type { DataDescription, FlowFunction, FlowFunctionDto, FlowFunctionRevision, SearchFlowTypeResult, Stream, } from './flow-function.interface';
 export type { FlowModule, FlowModuleArtifact } from './flow-module.interface';
@@ -53,7 +53,7 @@ export { NotificationEndpointSpamProtection, NotificationEndpointStatus, Notific
 export { EventLevel, EventLevelOverrideWrapper, eventLevels } from './event.interface';
 export { APPLICATION_AREA, TimeSlotStatus } from './flange-skill-control.interface';
 export { ERROR_STATES, FlowDeploymentStatus, PROCESSING_STATES, RUNNING_STATES, STOPPED_STATES, UNKOWN_STATES, } from './flow-deployment-status.interface';
-export { FlowDeployment } from './flow-deployment.interface';
+export { FlowDeployment, NATS_FLOW_TRIGGER_STATUSES } from './flow-deployment.interface';
 export { Flow, FlowDiagram } from './flow.interface';
 export { LABEL_COLORS } from './label.interface';
 export { SubscriptionType } from './marketplace.interface';

package/src/lib/interfaces/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationRuleStatus = exports.NatsStreams = exports.natsHpcPrefix = exports.natsFlowsPrefix = exports.NatsConsumers = exports.SubscriptionType = exports.LABEL_COLORS = exports.FlowDiagram = exports.Flow = exports.FlowDeployment = exports.UNKOWN_STATES = exports.STOPPED_STATES = exports.RUNNING_STATES = exports.PROCESSING_STATES = exports.FlowDeploymentStatus = exports.ERROR_STATES = exports.TimeSlotStatus = exports.APPLICATION_AREA = exports.eventLevels = exports.EventLevelOverrideWrapper = exports.EventLevel = exports.NotificationEndpointType = exports.NotificationEndpointStatus = exports.NotificationEndpointSpamProtection = exports.instanceOfTimePeriod = exports.ReturnType = exports.IndexingStatus = exports.ContentAnalysisStatus = exports.BillingResourceType = exports.ChangeAction = exports.DEFAULT_THRESHOLD_CONDITION = exports.DEFAULT_RELATIVE_CONDITION = exports.DEFAULT_DEADMAN_CONDITION = exports.AlertType = exports.AlertStatus = exports.AlertLevel = exports.ToolType = exports.ToolName = exports.ToolMessageStatus = exports.Role = exports.ReturnToReferrerTool = exports.ReferenceType = exports.HandOffTool = exports.FinishReason = exports.ErrorMessageType = exports.AvailableLanguages = exports.AttachmentHandlingMode = exports.AssistantMessageStatus = exports.AiAssistantId = exports.AgentId = void 0;
-exports.WebSocketMessageType = exports.SecretType = exports.isUserMessage = exports.isTask = exports.isStorage = exports.isOwner = exports.isLogbookEntry = exports.isEvent = exports.isContentAnalysis = exports.isContent = exports.isAuthor = exports.isAssignee = exports.isAsset = exports.TranslationEditData = exports.RETENTION_VALUES = exports.TaskStatus = exports.Priority = exports.INACTIVE_TASK_STATUSES = exports.buildTaskStatusFilter = exports.AssigneeType = exports.ACTIVE_TASK_STATUSES = exports.ResourceType = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.PermissionType = exports.isPopulated = exports.EventType = exports.CommandType = exports.arePopulated = exports.ObjectReferenceType = exports.OwnerType = exports.OrganizationMembersInviteOrAdd = void 0;
+exports.NatsStreams = exports.natsHpcPrefix = exports.natsFlowsPrefix = exports.NatsConsumers = exports.SubscriptionType = exports.LABEL_COLORS = exports.FlowDiagram = exports.Flow = exports.NATS_FLOW_TRIGGER_STATUSES = exports.FlowDeployment = exports.UNKOWN_STATES = exports.STOPPED_STATES = exports.RUNNING_STATES = exports.PROCESSING_STATES = exports.FlowDeploymentStatus = exports.ERROR_STATES = exports.TimeSlotStatus = exports.APPLICATION_AREA = exports.eventLevels = exports.EventLevelOverrideWrapper = exports.EventLevel = exports.NotificationEndpointType = exports.NotificationEndpointStatus = exports.NotificationEndpointSpamProtection = exports.instanceOfTimePeriod = exports.ReturnType = exports.IndexingStatus = exports.ContentAnalysisStatus = exports.BillingResourceType = exports.ChangeAction = exports.DEFAULT_THRESHOLD_CONDITION = exports.DEFAULT_RELATIVE_CONDITION = exports.DEFAULT_DEADMAN_CONDITION = exports.AlertType = exports.AlertStatus = exports.AlertLevel = exports.ToolType = exports.ToolName = exports.ToolMessageStatus = exports.Role = exports.ReturnToReferrerTool = exports.ReferenceType = exports.HandOffTool = exports.FinishReason = exports.ErrorMessageType = exports.AvailableLanguages = exports.AttachmentHandlingMode = exports.AssistantMessageStatus = exports.AiAssistantId = exports.AgentId = void 0;
+exports.WebSocketMessageType = exports.SecretType = exports.isUserMessage = exports.isTask = exports.isStorage = exports.isOwner = exports.isLogbookEntry = exports.isEvent = exports.isContentAnalysis = exports.isContent = exports.isAuthor = exports.isAssignee = exports.isAsset = exports.TranslationEditData = exports.RETENTION_VALUES = exports.TaskStatus = exports.Priority = exports.INACTIVE_TASK_STATUSES = exports.buildTaskStatusFilter = exports.AssigneeType = exports.ACTIVE_TASK_STATUSES = exports.ResourceType = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.PermissionType = exports.isPopulated = exports.EventType = exports.CommandType = exports.arePopulated = exports.ObjectReferenceType = exports.OwnerType = exports.OrganizationMembersInviteOrAdd = exports.NotificationRuleStatus = void 0;
 var ai_interface_1 = require("./ai.interface");
 Object.defineProperty(exports, "AgentId", { enumerable: true, get: function () { return ai_interface_1.AgentId; } });
 Object.defineProperty(exports, "AiAssistantId", { enumerable: true, get: function () { return ai_interface_1.AiAssistantId; } });
@@ -54,6 +54,7 @@ Object.defineProperty(exports, "STOPPED_STATES", { enumerable: true, get: functi
 Object.defineProperty(exports, "UNKOWN_STATES", { enumerable: true, get: function () { return flow_deployment_status_interface_1.UNKOWN_STATES; } });
 var flow_deployment_interface_1 = require("./flow-deployment.interface");
 Object.defineProperty(exports, "FlowDeployment", { enumerable: true, get: function () { return flow_deployment_interface_1.FlowDeployment; } });
+Object.defineProperty(exports, "NATS_FLOW_TRIGGER_STATUSES", { enumerable: true, get: function () { return flow_deployment_interface_1.NATS_FLOW_TRIGGER_STATUSES; } });
 var flow_interface_1 = require("./flow.interface");
 Object.defineProperty(exports, "Flow", { enumerable: true, get: function () { return flow_interface_1.Flow; } });
 Object.defineProperty(exports, "FlowDiagram", { enumerable: true, get: function () { return flow_interface_1.FlowDiagram; } });

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

@@ -43,6 +43,7 @@ export declare const NatsConsumers: {
         };
     };
     readonly flows: {
+        readonly FlowTrigger: "flow-trigger";
         readonly FlowDeploymentTrigger: "flow-deployment-trigger";
         readonly FlowDeploymentDeploy: "flow-deployment-deploy";
         readonly FlowDeploymentHealth: "flow-deployment-health";

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

@@ -46,6 +46,7 @@ exports.NatsConsumers = {
         },
     },
     [exports.NatsStreams.Flows]: {
+        FlowTrigger: 'flow-trigger',
         FlowDeploymentTrigger: 'flow-deployment-trigger',
         FlowDeploymentDeploy: 'flow-deployment-deploy',
         FlowDeploymentHealth: 'flow-deployment-health',

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

@@ -1,8 +1,19 @@
 import { APIBaseMock } from '.';
-import { ShareInDataspaceDto, ShareInDataspaceResult } from '../interfaces';
+import { ResourceType, ShareInDataspaceDto, ShareInDataspaceResult } from '../interfaces';
 import { DataspaceService } from '../services';
 export declare class DataspaceMockService extends APIBaseMock<ShareInDataspaceResult> implements DataspaceService {
     readonly shareInDataspaceCalls: ShareInDataspaceDto[];
+    readonly checkSharingStatusCalls: Array<{
+        resourceId: string;
+        resourceType: ResourceType;
+    }>;
+    readonly checkSharingWorkflowStatusCalls: string[];
+    readonly awaitSharingWorkflowResultCalls: string[];
+    checkStatusResult: boolean;
+    shareResult: ShareInDataspaceResult | null;
     constructor();
     shareInDataspace(dto: ShareInDataspaceDto): Promise<ShareInDataspaceResult>;
+    checkSharingStatus(resourceId: string, resourceType: ResourceType): Promise<boolean>;
+    checkSharingWorkflowStatus(resourceId: string): Promise<boolean>;
+    awaitSharingWorkflowResult(resourceId: string): Promise<ShareInDataspaceResult | null>;
 }

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

@@ -6,12 +6,28 @@ class DataspaceMockService extends _1.APIBaseMock {
     constructor() {
         super();
         this.shareInDataspaceCalls = [];
+        this.checkSharingStatusCalls = [];
+        this.checkSharingWorkflowStatusCalls = [];
+        this.awaitSharingWorkflowResultCalls = [];
+        this.checkStatusResult = false;
+        this.shareResult = { status: 'finished' };
     }
     async shareInDataspace(dto) {
         this.shareInDataspaceCalls.push(dto);
-        const result = { status: 'finished' };
-        this.data.push(result);
-        return result;
+        this.data.push(this.shareResult);
+        return this.shareResult;
+    }
+    async checkSharingStatus(resourceId, resourceType) {
+        this.checkSharingStatusCalls.push({ resourceId, resourceType });
+        return this.checkStatusResult;
+    }
+    async checkSharingWorkflowStatus(resourceId) {
+        this.checkSharingWorkflowStatusCalls.push(resourceId);
+        return this.checkStatusResult;
+    }
+    async awaitSharingWorkflowResult(resourceId) {
+        this.awaitSharingWorkflowResultCalls.push(resourceId);
+        return this.shareResult;
     }
 }
 exports.DataspaceMockService = DataspaceMockService;

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

@@ -1,5 +1,5 @@
 import { APIBaseMock, DataMockService, MockAPI, TrashMockService } from '.';
-import { FlowDeployment, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowLog, ResourceReference } from '../interfaces';
+import { FlowDeployment, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowLog, NatsFlowTriggerData, NatsFlowTriggerState, ResourceReference } from '../interfaces';
 import { FlowDeploymentService } from '../services';
 import { ShareMockService } from './share.mock.service';
 interface BaseService extends DataMockService<FlowDeployment>, ShareMockService<FlowDeployment>, TrashMockService<FlowDeployment> {
@@ -8,6 +8,7 @@ declare class BaseService extends APIBaseMock<FlowDeployment> {
 }
 export declare class FlowDeploymentMockService extends BaseService implements FlowDeploymentService {
     private api;
+    private readonly flowTriggerStates;
     constructor(deployments: FlowDeployment[], api: MockAPI);
     subscribeToStatus(id: string, listener: (event: MessageEvent<any>) => void, errorListener?: (event: MessageEvent<any>) => void): Promise<string>;
     subscribeToLogs(id: string, listener: (event: MessageEvent<any>) => void, errorListener?: (event: MessageEvent) => void): Promise<string>;
@@ -26,6 +27,12 @@ export declare class FlowDeploymentMockService extends BaseService implements Fl
         tags?: string[];
     }): Promise<FlowDeployment>;
     deleteOne(id: string): Promise<FlowDeployment>;
+    triggerFlow(dto: {
+        flowDeploymentId: string;
+        data?: Record<string, unknown>;
+    }): Promise<NatsFlowTriggerData>;
+    sendWebhookCallback(correlationId: string, dto: NatsFlowTriggerState): Promise<void>;
+    subscribeToNatsFlowWebhookState(correlationId: string, listener: (event: MessageEvent<string>) => void, errorListener?: (event: MessageEvent) => void): Promise<string>;
     private getReferences;
 }
 export {};

package/src/lib/mock/flow-deployment.mock.service.js

@@ -16,6 +16,7 @@ class FlowDeploymentMockService extends BaseService {
     constructor(deployments, api) {
         super(deployments);
         this.api = api;
+        this.flowTriggerStates = new Map();
     }
     subscribeToStatus(id, listener, errorListener) {
         listener(new MessageEvent('message', { data: 'running' }));
@@ -120,6 +121,24 @@ class FlowDeploymentMockService extends BaseService {
         await this.api.flows.updateOne(flow.id, flow);
         return super.deleteOne(id);
     }
+    triggerFlow(dto) {
+        const correlationId = globalThis.crypto.randomUUID();
+        this.flowTriggerStates.set(correlationId, { status: 'in progress', progress: 0 });
+        return Promise.resolve({ correlationId, ...dto });
+    }
+    sendWebhookCallback(correlationId, dto) {
+        const state = this.flowTriggerStates.get(correlationId);
+        if (!state) {
+            return Promise.reject();
+        }
+        this.flowTriggerStates.set(correlationId, { status: dto.status, progress: dto.progress });
+        return Promise.resolve();
+    }
+    subscribeToNatsFlowWebhookState(correlationId, listener, errorListener) {
+        const state = this.flowTriggerStates.get(correlationId);
+        listener(new MessageEvent('message', { data: JSON.stringify(state ?? { status: 'in progress', progress: 0 }) }));
+        return Promise.resolve(correlationId);
+    }
     async getReferences(properties) {
         // super simplified version of real resolver
         return Promise.all(Object.keys(properties).map(async (prop) => {

package/src/lib/services/dataspace.service.d.ts

@@ -1,7 +1,10 @@
 import { APIBase } from '../api-base';
-import { ShareInDataspaceDto, ShareInDataspaceResult, TokenOption } from '../interfaces';
+import { ResourceType, ShareInDataspaceDto, ShareInDataspaceResult, TokenOption } from '../interfaces';
 import { HttpClientService } from './http-client.service';
 export declare class DataspaceService extends APIBase {
     constructor(httpClient: HttpClientService);
     shareInDataspace(dto: ShareInDataspaceDto, options?: TokenOption): Promise<ShareInDataspaceResult>;
+    checkSharingStatus(resourceId: string, resourceType: ResourceType, options?: TokenOption): Promise<boolean>;
+    checkSharingWorkflowStatus(resourceId: string, options?: TokenOption): Promise<boolean>;
+    awaitSharingWorkflowResult(resourceId: string, options?: TokenOption): Promise<ShareInDataspaceResult | null>;
 }

package/src/lib/services/dataspace.service.js

@@ -9,5 +9,21 @@ class DataspaceService extends api_base_1.APIBase {
     shareInDataspace(dto, options = {}) {
         return this.httpClient.post(`${this.basePath}/share`, dto, options);
     }
+    checkSharingStatus(resourceId, resourceType, options = {}) {
+        const params = new URLSearchParams();
+        params.append('resourceId', resourceId);
+        params.append('resourceType', resourceType);
+        return this.httpClient.get(`${this.basePath}/share/status`, { params, ...options });
+    }
+    checkSharingWorkflowStatus(resourceId, options = {}) {
+        const params = new URLSearchParams();
+        params.append('resourceId', resourceId);
+        return this.httpClient.get(`${this.basePath}/share/workflow-status`, { params, ...options });
+    }
+    awaitSharingWorkflowResult(resourceId, options = {}) {
+        const params = new URLSearchParams();
+        params.append('resourceId', resourceId);
+        return this.httpClient.get(`${this.basePath}/share/workflow-result`, { params, ...options });
+    }
 }
 exports.DataspaceService = DataspaceService;

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

@@ -1,6 +1,6 @@
 import { DataService, HttpClientService, TrashService } from '.';
 import { APIBase } from '../api-base';
-import { DeleteQuery, FlowDeployment, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowLog, ResourceReference, TokenOption } from '../interfaces';
+import { DeleteQuery, FlowDeployment, FlowDeploymentMetrics, FlowDeploymentStatistic, FlowLog, NatsFlowTriggerData, NatsFlowTriggerState, ResourceReference, TokenOption } from '../interfaces';
 import { ShareService } from './share.service';
 interface BaseService extends DataService<FlowDeployment>, ShareService, TrashService<FlowDeployment> {
 }
@@ -28,6 +28,12 @@ export declare class FlowDeploymentService extends BaseService {
         readWritePermissions?: string[];
         tags?: string[];
     }, options?: TokenOption): Promise<FlowDeployment>;
+    triggerFlow(dto: {
+        flowDeploymentId: string;
+        data?: Record<string, unknown>;
+    }, options?: TokenOption): Promise<NatsFlowTriggerData>;
+    sendWebhookCallback(correlationId: string, dto: NatsFlowTriggerState, options?: TokenOption): Promise<void>;
+    subscribeToNatsFlowWebhookState(correlationId: string, listener: (event: MessageEvent<string>) => void, errorListener?: (event: MessageEvent) => void, options?: TokenOption): Promise<string>;
     subscribeToStatus(id: string, listener: (event: MessageEvent<any>) => void, errorListener?: (event: MessageEvent) => void, options?: TokenOption): Promise<string>;
     subscribeToLogs(id: string, listener: (event: MessageEvent<any>) => void, errorListener?: (event: MessageEvent) => void, options?: TokenOption): Promise<string>;
 }

package/src/lib/services/flow-deployment.service.js

@@ -63,6 +63,15 @@ class FlowDeploymentService extends BaseService {
     addOne(dto, options = {}) {
         return super.addOne(dto, options);
     }
+    triggerFlow(dto, options = {}) {
+        return this.httpClient.post(`${this.basePath}/trigger`, dto, options);
+    }
+    sendWebhookCallback(correlationId, dto, options = {}) {
+        return this.httpClient.post(`${this.basePath}/webhook/${correlationId}/callback`, dto, options);
+    }
+    subscribeToNatsFlowWebhookState(correlationId, listener, errorListener, options = {}) {
+        return this.httpClient.addEventSource(`${this.basePath}/webhook/${correlationId}/subscribe`, listener, errorListener, options);
+    }
     subscribeToStatus(id, listener, errorListener, options = {}) {
         return this.httpClient.addEventSource(`${this.basePath}/${id}/status`, listener, errorListener, options);
     }

package/src/lib/services/organizations.service.d.ts

@@ -2,7 +2,7 @@ import { APIBase } from '../api-base';
 import { CreateOrganizationDto, KeycloakProfile, Organization, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment, OrganizationSearchQuery } from '../interfaces';
 import { HttpClientService } from './';
 export declare class OrganizationsService extends APIBase {
-    constructor(httpClientClient: HttpClientService);
+    constructor(httpClient: HttpClientService);
     searchForOrganizationNames(query: OrganizationSearchQuery): Promise<OrganizationName[]>;
     /**
      * Create an organization.

package/src/lib/services/organizations.service.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrganizationsService = void 0;
 const api_base_1 = require("../api-base");
 class OrganizationsService extends api_base_1.APIBase {
-    constructor(httpClientClient) {
-        super(httpClientClient, '/organizations');
+    constructor(httpClient) {
+        super(httpClient, '/organizations');
     }
     searchForOrganizationNames(query) {
         const params = {};