@hahnpro/hpc-api 2025.10.4 → 2025.11.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @hahnpro/hpc-api
 
+## 2025.10.5
+
+### Major Changes
+
+- Optimized SSE event handling in HttpClient and updated the corresponding function signatures in the API services.
+
 ## 2025.10.4
 
 ### Patch Changes

package/package.json

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

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

@@ -12,6 +12,7 @@ export interface RequestParameter {
     limit?: number;
     page?: number;
     populate?: string;
+    select?: string;
     sort?: string;
     lang?: string;
 }

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

@@ -19,12 +19,13 @@ export type { TagRule, NotificationRule, StatusRule } from './notification-rule.
 export type { Owner } from './owner.interface';
 export type { Organization, OrganizationCreateDto, OrganizationData, OrganizationDataKind, OrganizationDomain, OrganizationName, OrganizationRolesAdjustment, OrganizationSearchQuery, SubscriptionType, UserWithOrgRoles, } from './organization.interface';
 export type { OrganizationRoleRepresentation } from './organization-role-representation.interface';
-export type { OrganizationResourcesProgress, OrganizationResourcesProgressDto, OrganizationResourcesProgressErrorDto, } from './organizations-resources.interface';
+export type { OrganizationResourcesProgress, OrganizationResourcesProgressDto, OrganizationResourcesProgressErrorDto, CreateOrgWithResourcesDto, } from './organizations-resources.interface';
 export type { Resource, ResourceReference } from './resource.interface';
 export type { JsonSchema, JsonSchemaArray, JsonSchemaForm, JsonSchemaType, JsonSchemaTypeName } from './schema.interface';
 export type { DeleteQuery, DeleteAssetTypeQuery, DeleteAssetQuery } from './query.interface';
 export type { SearchOptions, SearchResult, SearchSortOption, SortableField } from './search.interface';
 export type { Secret } from './secret.interface';
+export type { ServerSentEvent } from './sse.interface';
 export type { FileType, Artifact, Storage, StorageProvider } from './storage.interface';
 export type { Task, LogbookEntry, LogbookEntryDto } from './task.interface';
 export type { TimeSeries, TimeSeriesBucket, TimeSeriesCondition, TimeSeriesValue, TS_GROUPS } from './timeseries.interface';

package/src/lib/interfaces/organizations-resources.interface.d.ts

@@ -1,9 +1,12 @@
 export type OrganizationResourcesProgress = OrganizationResourcesProgressDto | OrganizationResourcesProgressErrorDto;
 export interface OrganizationResourcesProgressDto {
-    step: string;
-    stepNumber: number;
-    maxSteps: number;
+    readonly step: string;
+    readonly stepNumber: number;
+    readonly maxSteps: number;
 }
 export interface OrganizationResourcesProgressErrorDto {
-    message: string;
+    readonly message: string;
+}
+export interface CreateOrgWithResourcesDto {
+    readonly resourceSetName: string;
 }

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

@@ -0,0 +1,6 @@
+export interface ServerSentEvent<T> {
+    data: T;
+    event?: string;
+    id?: string;
+    retry?: number;
+}

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

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

package/src/lib/mock/organizations-resources.mock.service.d.ts

@@ -1,12 +1,12 @@
 import { Observable } from 'rxjs';
 import { APIBaseMock } from '.';
-import { Organization, OrganizationResourcesProgressDto } from '../interfaces';
+import { CreateOrgWithResourcesDto, Organization, OrganizationResourcesProgress, ServerSentEvent } from '../interfaces';
 import { OrganizationsResourcesService } from '../services';
 export declare class OrganizationsResourcesMockService extends APIBaseMock<Organization> implements OrganizationsResourcesService {
     resourceSetNames: string[];
     constructor(resourceSetNames: string[]);
     getResourceSetNames(): Promise<string[]>;
-    createResourcesForOrganization(organizationId: string, resourceSetName: string): Promise<string>;
-    getResourceCreationProgress(organizationId: string): Observable<OrganizationResourcesProgressDto>;
-    getSseObservable(organizationId: string, path: 'creationTask'): Observable<OrganizationResourcesProgressDto>;
+    createResourcesForOrganization(organizationId: string, body: CreateOrgWithResourcesDto): Promise<string>;
+    getResourceCreationProgress(organizationId: string): Observable<ServerSentEvent<OrganizationResourcesProgress>>;
+    getSseObservable(organizationId: string, path: 'creationTask'): Observable<ServerSentEvent<OrganizationResourcesProgress>>;
 }

package/src/lib/mock/organizations-resources.mock.service.js

@@ -11,14 +11,14 @@ class OrganizationsResourcesMockService extends _1.APIBaseMock {
     getResourceSetNames() {
         return Promise.resolve(this.resourceSetNames);
     }
-    createResourcesForOrganization(organizationId, resourceSetName) {
+    createResourcesForOrganization(organizationId, body) {
         throw new Error('Method not implemented.');
     }
     getResourceCreationProgress(organizationId) {
         throw new Error('Method not implemented.');
     }
     getSseObservable(organizationId, path) {
-        throw new Error('Method not implemented.');
+        return undefined;
     }
 }
 exports.OrganizationsResourcesMockService = OrganizationsResourcesMockService;

package/src/lib/services/http-client.service.d.ts

@@ -1,8 +1,7 @@
-import { EventSourceMessage } from '@microsoft/fetch-event-source';
 import { AxiosInstance, Method } from 'axios';
 import { EventSource } from 'eventsource';
 import { Observable } from 'rxjs';
-import { Config, Issuer, TokenOption } from '../interfaces';
+import { Config, Issuer, ServerSentEvent, TokenOption } from '../interfaces';
 import { Queue } from '../queue';
 import { TokenSet } from '../token-set';
 export interface HttpClientConfig {
@@ -46,7 +45,7 @@ export declare class HttpClientService {
     put: <T>(url: string, data: any, config?: Config) => Promise<T>;
     patch: <T>(url: string, data: any, config?: Config) => Promise<T>;
     protected request: <T>(method: Method, url: string, config?: Config, data?: any) => Promise<T>;
-    getSseObservable<T>(path: string, onmessage: (event: EventSourceMessage) => T): Observable<T>;
+    getSseObservable<T>(path: string): Observable<ServerSentEvent<T>>;
     addEventSource(url: string, listener: (event: MessageEvent) => void, errorListener?: (event: MessageEvent) => void, options?: TokenOption): Promise<string>;
     destroyEventSource(id: string): void;
     destroyAllEventSources(): void;

package/src/lib/services/http-client.service.js

@@ -68,46 +68,58 @@ class HttpClientService {
         this.authAxiosInstance = axios_1.default.create({ baseURL: this.authBaseURL, timeout: 10000 });
         this.requestQueue = new queue_1.Queue({ concurrency: 1, timeout: 70000, throwOnTimeout: true });
     }
-    getSseObservable(path, onmessage) {
-        const subject = new rxjs_1.Subject();
-        this.getAccessToken()
-            .then((token) => {
+    getSseObservable(path) {
+        return new rxjs_1.Observable((subscriber) => {
             const ctrl = new AbortController();
-            (0, fetch_event_source_1.fetchEventSource)(`${this.baseURL.replace(/\/+$/, '')}/${path.replace(/^\/+/, '')}`, {
-                headers: { authorization: 'Bearer ' + token },
-                signal: ctrl.signal,
-                onopen: async (response) => {
-                    if (!response.ok) {
-                        subject.error(new Error(`HTTP ${response.status}: ${response.statusText}`));
+            this.getAccessToken()
+                .then((token) => {
+                (0, fetch_event_source_1.fetchEventSource)(`${this.baseURL.replace(/\/+$/, '')}/${path.replace(/^\/+/, '')}`, {
+                    headers: { Authorization: `Bearer ${token}` },
+                    signal: ctrl.signal,
+                    onopen: async (response) => {
+                        if (!response.ok) {
+                            subscriber.error(new Error(`HTTP ${response.status}: ${response.statusText}`));
+                            ctrl.abort();
+                        }
+                    },
+                    onmessage: (event) => {
+                        if (!event.data && !event.event && !event.id) {
+                            return;
+                        }
+                        else if (event.event === 'error') {
+                            subscriber.error(new Error(event.data));
+                        }
+                        else {
+                            try {
+                                const parsedData = JSON.parse(event.data);
+                                subscriber.next({
+                                    data: parsedData,
+                                    event: event.event,
+                                    id: event.id,
+                                    retry: event.retry,
+                                });
+                            }
+                            catch (err) {
+                                subscriber.error(err);
+                            }
+                        }
+                    },
+                    onclose: () => {
+                        subscriber.complete();
+                    },
+                    onerror: (err) => {
+                        subscriber.error(err);
                         ctrl.abort();
-                    }
-                },
-                onmessage(event) {
-                    if (event.id === '' && event.data === '' && event.event === '' && !event.retry) {
-                        // Skip empty messages used as keep-alive signals
-                        return;
-                    }
-                    try {
-                        subject.next(onmessage(event));
-                    }
-                    catch (error) {
-                        subject.error({ message: error.message ?? String(error) });
-                    }
-                },
-                onclose() {
-                    subject.complete();
-                    ctrl.abort();
-                },
-                onerror(err) {
-                    subject.error(err);
-                    ctrl.abort();
-                },
+                    },
+                });
+            })
+                .catch((err) => {
+                subscriber.error(err);
             });
-        })
-            .catch((err) => {
-            subject.error(err);
+            return () => {
+                ctrl.abort();
+            };
         });
-        return subject.asObservable();
     }
     async addEventSource(url, listener, errorListener, options = {}) {
         const id = globalThis.crypto.randomUUID();

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

@@ -1,11 +1,12 @@
 import { Observable } from 'rxjs';
 import { APIBase } from '../api-base';
-import { OrganizationResourcesProgressDto } from '../interfaces';
+import { CreateOrgWithResourcesDto, OrganizationResourcesProgress, ServerSentEvent } from '../interfaces';
 import { HttpClientService } from './';
 export declare class OrganizationsResourcesService extends APIBase {
     constructor(httpClient: HttpClientService);
     /**
      * Fetches the names of all available resource sets.
+     *
      * @returns {Promise<string[]>} A promise that resolves to an array of resource set names.
      */
     getResourceSetNames(): Promise<string[]>;
@@ -15,22 +16,23 @@ export declare class OrganizationsResourcesService extends APIBase {
      * The progress status update messages can be received by subscribing to the `getResourceCreationProgress` method with the same organization ID.
      *
      * @param {string} organizationId - The ID of the organization for which resources are to be created.
-     * @param {string} resourceSetName - The name of the resource set to be used for resource creation from the S3 bucket.
+     * @param {CreateOrgWithResourcesDto} body - The options for resource creation, including the resource set name.
      * @returns {Promise<string>} - A promise that resolves to the id of the resource creation task.
      */
-    createResourcesForOrganization(organizationId: string, resourceSetName: string): Promise<string>;
+    createResourcesForOrganization(organizationId: string, body: CreateOrgWithResourcesDto): Promise<string>;
     /**
      * Subscribes to server-sent events to receive real-time progress updates on the resource tasks for a specific organization.
+     *
      * @param {string} organizationId - The ID of the organization to monitor the resources progress updates for.
      * @param {string} path - The API path segment for the SSE endpoint
-     * @returns {Observable<OrganizationResourcesProgress>} An observable that emits progress updates.
+     * @returns {Observable<ServerSentEvent<OrganizationResourcesProgress>>} An observable that emits progress updates.
      */
-    getSseObservable(organizationId: string, path: 'creationTask'): Observable<OrganizationResourcesProgressDto>;
+    getSseObservable(organizationId: string, path: 'creationTask'): Observable<ServerSentEvent<OrganizationResourcesProgress>>;
     /**
      * Subscribes to server-sent events to receive real-time progress updates on the resource creation task for a specific organization
      *
      * @param {string} organizationId - The ID of the organization to monitor the resource creation progress for.
      * @returns {Observable<OrganizationResourcesProgress>} An observable that emits progress updates.
      */
-    getResourceCreationProgress(organizationId: string): Observable<OrganizationResourcesProgressDto>;
+    getResourceCreationProgress(organizationId: string): Observable<ServerSentEvent<OrganizationResourcesProgress>>;
 }

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

@@ -8,6 +8,7 @@ class OrganizationsResourcesService extends api_base_1.APIBase {
     }
     /**
      * Fetches the names of all available resource sets.
+     *
      * @returns {Promise<string[]>} A promise that resolves to an array of resource set names.
      */
     getResourceSetNames() {
@@ -19,34 +20,21 @@ class OrganizationsResourcesService extends api_base_1.APIBase {
      * The progress status update messages can be received by subscribing to the `getResourceCreationProgress` method with the same organization ID.
      *
      * @param {string} organizationId - The ID of the organization for which resources are to be created.
-     * @param {string} resourceSetName - The name of the resource set to be used for resource creation from the S3 bucket.
+     * @param {CreateOrgWithResourcesDto} body - The options for resource creation, including the resource set name.
      * @returns {Promise<string>} - A promise that resolves to the id of the resource creation task.
      */
-    createResourcesForOrganization(organizationId, resourceSetName) {
-        return this.httpClient.post(`${this.basePath}/${organizationId}`, { resourceSetName });
+    createResourcesForOrganization(organizationId, body) {
+        return this.httpClient.post(`${this.basePath}/${organizationId}`, body);
     }
     /**
      * Subscribes to server-sent events to receive real-time progress updates on the resource tasks for a specific organization.
+     *
      * @param {string} organizationId - The ID of the organization to monitor the resources progress updates for.
      * @param {string} path - The API path segment for the SSE endpoint
-     * @returns {Observable<OrganizationResourcesProgress>} An observable that emits progress updates.
+     * @returns {Observable<ServerSentEvent<OrganizationResourcesProgress>>} An observable that emits progress updates.
      */
     getSseObservable(organizationId, path) {
-        return this.httpClient.getSseObservable(`${this.basePath}/${path}/${organizationId}`, (event) => {
-            let data = null;
-            try {
-                data = JSON.parse(event.data);
-            }
-            catch (err) {
-                throw new Error('Failed to parse SSE event data as JSON: ' + (err.message ?? String(err)));
-            }
-            if ('message' in data) {
-                throw new Error(data.message);
-            }
-            else {
-                return data;
-            }
-        });
+        return this.httpClient.getSseObservable(`${this.basePath}/${path}/${organizationId}`);
     }
     /**
      * Subscribes to server-sent events to receive real-time progress updates on the resource creation task for a specific organization