@hahnpro/hpc-api 2026.1.0 → 2026.1.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @hahnpro/hpc-api
 
+## 2026.1.1
+
+### Patch Changes
+
+- Updated Endpoint, TimeSeries and Vault Interfaces
+- Added arbitrary options to FlowDeploymentService::updateOne(...) method
+
 ## 2026.1.0
 
 - Updated Task Interface

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2026.1.0",
+  "version": "2026.1.2",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {
@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@microsoft/fetch-event-source": "2.0.1",
-    "axios": "1.13.2",
+    "axios": "1.13.4",
     "eventsource": "4.1.0",
     "jose": "5.10.0",
     "jwt-decode": "4.0.0",

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

@@ -1,3 +1,5 @@
+import { Author } from './author.interface';
+import { Owner } from './owner.interface';
 export interface Endpoint {
     id?: string;
     name: string;
@@ -14,6 +16,12 @@ export interface Endpoint {
     nbOfNotificationsBetweenPauseInterval: number;
     readPermissions: string[];
     readWritePermissions: string[];
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
 }
 export interface EndpointLog {
     id?: string;

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

@@ -19,7 +19,7 @@ export type { NotificationRule, StatusRule, TagRule } from './notification-rule.
 export type { Notification, NotificationType } from './notification.interface';
 export type { OrganizationRoleRepresentation } from './organization-role-representation.interface';
 export { OrganizationMembersInviteOrAdd } from './organization.interface';
-export type { Organization, OrganizationCreateDto, OrganizationData, OrganizationDataKind, OrganizationDomain, OrganizationExtraProperties, OrganizationName, OrganizationRolesAdjustment, OrganizationSearchQuery, SubscriptionType, UserWithOrgRoles, } from './organization.interface';
+export type { Organization, CreateOrganizationDto, OrganizationData, OrganizationDataKind, OrganizationDomain, OrganizationExtraProperties, OrganizationName, OrganizationRolesAdjustment, OrganizationSearchQuery, SubscriptionType, UserWithOrgRoles, } from './organization.interface';
 export type { CreateOrgWithResourcesDto, OrganizationResourcesProgress, OrganizationResourcesProgressDto, OrganizationResourcesProgressErrorDto, } from './organizations-resources.interface';
 export type { Owner } from './owner.interface';
 export type { DeleteAssetQuery, DeleteAssetTypeQuery, DeleteQuery } from './query.interface';
@@ -29,7 +29,7 @@ export type { SearchOptions, SearchResult, SearchSortOption, SortableField } fro
 export type { Secret } from './secret.interface';
 export type { ServerSentEvent } from './sse.interface';
 export type { Artifact, FileType, Storage, StorageProvider } from './storage.interface';
-export type { LogbookEntry, LogbookEntryDto, Task } from './task.interface';
+export type { LogbookEntry, LogbookEntryDto, Task, Assignee } from './task.interface';
 export type { TimeSeries, TimeSeriesBucket, TimeSeriesCondition, TimeSeriesValue, TS_GROUPS } from './timeseries.interface';
 export type { Application, Consent, Permission, TableSetting, TableSettingProfile, UserSettings } from './user-settings.interface';
 export type { VaultSecret } from './vault.interface';
@@ -39,4 +39,4 @@ export { instanceOfTimePeriod } from './data.interface';
 export { LABEL_COLORS } from './label.interface';
 export { OwnerType } from './owner.interface';
 export { PermissionType, ResourceType, ResourceApiPath, resourceApiPathToTypeMap } from './resource.interface';
-export { Priority, TaskStatus } from './task.interface';
+export { Priority, TaskStatus, AssigneeType } from './task.interface';

package/src/lib/interfaces/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskStatus = exports.Priority = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.ResourceType = exports.PermissionType = exports.OwnerType = exports.LABEL_COLORS = exports.instanceOfTimePeriod = exports.ReturnType = exports.AlertType = exports.AlertLevel = exports.OrganizationMembersInviteOrAdd = void 0;
+exports.AssigneeType = exports.TaskStatus = exports.Priority = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.ResourceType = exports.PermissionType = exports.OwnerType = exports.LABEL_COLORS = exports.instanceOfTimePeriod = exports.ReturnType = exports.AlertType = exports.AlertLevel = exports.OrganizationMembersInviteOrAdd = void 0;
 var organization_interface_1 = require("./organization.interface");
 Object.defineProperty(exports, "OrganizationMembersInviteOrAdd", { enumerable: true, get: function () { return organization_interface_1.OrganizationMembersInviteOrAdd; } });
 var alert_interface_1 = require("./alert.interface");
@@ -22,3 +22,4 @@ Object.defineProperty(exports, "resourceApiPathToTypeMap", { enumerable: true, g
 var task_interface_1 = require("./task.interface");
 Object.defineProperty(exports, "Priority", { enumerable: true, get: function () { return task_interface_1.Priority; } });
 Object.defineProperty(exports, "TaskStatus", { enumerable: true, get: function () { return task_interface_1.TaskStatus; } });
+Object.defineProperty(exports, "AssigneeType", { enumerable: true, get: function () { return task_interface_1.AssigneeType; } });

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

@@ -20,7 +20,7 @@ export interface Organization extends Api {
     deletionRequested?: boolean;
     isSuperOrganization?: boolean;
 }
-export interface OrganizationCreateDto {
+export interface CreateOrganizationDto {
     name: string;
     description?: string;
     domains?: string[];

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

@@ -1,4 +1,12 @@
 import { Api, Author } from '.';
+export declare enum AssigneeType {
+    USER = "user",
+    ORG = "org"
+}
+export interface Assignee {
+    id: string;
+    type: AssigneeType;
+}
 export declare enum TaskStatus {
     OPENED = "OPENED",
     CLOSED = "CLOSED",
@@ -22,7 +30,6 @@ export interface Task extends Api {
     description?: string;
     priority: Priority;
     tags?: string[];
-    author?: string;
     readPermissions: string[];
     readWritePermissions: string[];
     assetRef?: string;
@@ -35,9 +42,9 @@ export interface Task extends Api {
     parent?: string;
     parent$name?: string;
     subTasks?: string[];
-    assignedTo: string[];
-    status?: TaskStatus;
+    assignedTo: Assignee[];
     acceptedBy?: string;
+    status?: TaskStatus;
     reason?: string;
     statusHistoryLog?: TaskStatus[];
     logbookSchema?: string;

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

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

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

@@ -1,3 +1,5 @@
+import { Author } from './author.interface';
+import { Owner } from './owner.interface';
 export interface TimeSeries {
     id?: string;
     name: string;
@@ -15,6 +17,11 @@ export interface TimeSeries {
     autoDelData: Date;
     autoDelBucket: Date;
     metadata?: Record<string, any>;
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
+    createdAt?: string;
+    updatedAt?: string;
     deletedAt?: string;
 }
 export interface TimeSeriesCondition {

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

@@ -1,3 +1,5 @@
+import { Author } from './author.interface';
+import { Owner } from './owner.interface';
 export interface VaultSecret {
     id?: string;
     name: string;
@@ -6,5 +8,8 @@ export interface VaultSecret {
     version?: number;
     readPermissions: string[];
     readWritePermissions: string[];
+    owner?: Owner;
+    createdBy?: Author;
+    updatedBy?: Author;
     updatedAt?: string;
 }

package/src/lib/mock/api.mock.js

@@ -26,6 +26,7 @@ class MockAPI {
             readPermissions: v.readPermissions ?? [],
             readWritePermissions: v.readWritePermissions ?? [],
             type: assetTypes[index],
+            attachments: [],
         }));
         const assetRevisions1 = assetRevisions.map((v, index) => ({
             ...v,

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

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { APIBaseMock, OrganizationsMockService } from '.';
-import { Filter, Organization, OrganizationCreateDto, OrganizationResourcesProgress, OrganizationSearchQuery, Paginated, RequestParameter, ServerSentEvent, SubscriptionType, UserWithOrgRoles } from '../interfaces';
+import { CreateOrganizationDto, Filter, Organization, OrganizationResourcesProgress, OrganizationSearchQuery, Paginated, RequestParameter, ServerSentEvent, SubscriptionType, UserWithOrgRoles } from '../interfaces';
 import { OrganizationsAdministrationService } from '../services';
 export declare class OrganizationsAdministrationMockService extends APIBaseMock<Organization> implements OrganizationsAdministrationService {
     private readonly organizationMockService;
@@ -14,6 +14,6 @@ export declare class OrganizationsAdministrationMockService extends APIBaseMock<
     getMany(params?: RequestParameter): Promise<Paginated<Organization>>;
     getManyFiltered(filter: Filter, params?: RequestParameter): Promise<Paginated<Organization>>;
     search(query: OrganizationSearchQuery): Promise<Organization[]>;
-    createOrganization(organizationCreateDto: OrganizationCreateDto, emailsToInvite: string[], emailsToAdd: string[], createOrgAsOwner?: boolean): Promise<Organization>;
+    createOrganization(organizationCreateDto: CreateOrganizationDto, usersWithOrgRolesToInvite: UserWithOrgRoles[], usersWithOrgRolesToAdd: UserWithOrgRoles[], createOrgAsOwner?: boolean): Promise<Organization>;
     getOrganizationDeletionProgress(organizationId: string): Observable<ServerSentEvent<OrganizationResourcesProgress>>;
 }

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

@@ -76,9 +76,9 @@ class OrganizationsAdministrationMockService extends _1.APIBaseMock {
     async search(query) {
         return Promise.resolve(this.data.filter((entry) => entry.name === query.name || entry.name.startsWith(query.name)));
     }
-    createOrganization(organizationCreateDto, emailsToInvite, emailsToAdd, createOrgAsOwner = false) {
+    createOrganization(organizationCreateDto, usersWithOrgRolesToInvite, usersWithOrgRolesToAdd, createOrgAsOwner = false) {
         if (!organizationCreateDto?.name ||
-            ([...emailsToInvite, ...emailsToAdd].length === 0 && !createOrgAsOwner) ||
+            ([...usersWithOrgRolesToInvite, ...usersWithOrgRolesToAdd].length === 0 && !createOrgAsOwner) ||
             this.data.some((org) => org.name === organizationCreateDto.name)) {
             return Promise.reject('Bad Request');
         }

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

@@ -1,12 +1,12 @@
 import { APIBaseMock } from '.';
-import { KeycloakProfile, Organization, OrganizationCreateDto, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment } from '../interfaces';
+import { CreateOrganizationDto, KeycloakProfile, Organization, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment } from '../interfaces';
 import { OrganizationsService } from '../services';
 import { OrganizationRoleRepresentation } from '../services/organizations.service';
 export declare class OrganizationsMockService extends APIBaseMock<Organization> implements OrganizationsService {
     constructor(organizations: Organization[]);
-    addOrganizationInvitation(id: string, email: string, roles: string[]): Promise<void>;
+    inviteUser(id: string, email: string, roles: string[]): Promise<void>;
     getOrganizationIdByName(name: string): Promise<OrganizationName>;
-    addOne(dto: OrganizationCreateDto): Promise<Organization>;
+    addOne(dto: CreateOrganizationDto): Promise<Organization>;
     getOneCombined(id: string): Promise<Organization>;
     addOrganizationRole(id: string, roleDto: OrganizationRoleRepresentation): Promise<OrganizationRoleRepresentation[]>;
     checkForOrganizationUniqueness(name: string): Promise<void>;
@@ -14,7 +14,7 @@ export declare class OrganizationsMockService extends APIBaseMock<Organization>
     getActiveOrganizationOfUser(): Promise<Organization>;
     getMyOrganizations(): Promise<Organization[]>;
     getOrganizationData(id: string, kinds?: OrganizationDataKind[]): Promise<OrganizationData>;
-    getOrganizationMemberById(id: string, userId: string): Promise<KeycloakProfile>;
+    getMemberById(id: string, userId: string): Promise<KeycloakProfile>;
     getOrganizationNamesByIds(ids: string[]): Promise<OrganizationName[]>;
     getUserOrganizationRoles(ids: string[], userId: string): Promise<Record<string, OrganizationRoleRepresentation[]>>;
     getUserOrganizations(userId: string): Promise<Organization[]>;

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

@@ -8,7 +8,7 @@ class OrganizationsMockService extends _1.APIBaseMock {
         super(null);
         this.data = organizations;
     }
-    addOrganizationInvitation(id, email, roles) {
+    inviteUser(id, email, roles) {
         if (!id || !email || !roles?.length) {
             return Promise.reject('Bad Request');
         }
@@ -50,7 +50,7 @@ class OrganizationsMockService extends _1.APIBaseMock {
     getOrganizationData(id, kinds) {
         return Promise.resolve(undefined);
     }
-    getOrganizationMemberById(id, userId) {
+    getMemberById(id, userId) {
         return Promise.resolve(undefined);
     }
     getOrganizationNamesByIds(ids) {

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

@@ -11,6 +11,7 @@ export declare class FlowDeploymentService extends BaseService {
     addMany(dto: any[], options?: TokenOption): Promise<FlowDeployment[]>;
     updateOne(id: string, dto: any, options?: TokenOption & {
         force: boolean;
+        [key: string]: any;
     }): Promise<FlowDeployment>;
     getDeploymentStatistics(id: string, options?: TokenOption): Promise<FlowDeploymentStatistic>;
     getDeploymentMetrics(id: string, range?: string, interval?: string, options?: TokenOption): Promise<FlowDeploymentMetrics>;

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

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { APIBase } from '../api-base';
-import { Filter, Organization, OrganizationCreateDto, OrganizationResourcesProgress, OrganizationSearchQuery, Paginated, RequestParameter, ServerSentEvent, SubscriptionType, UserWithOrgRoles } from '../interfaces';
+import { CreateOrganizationDto, Filter, Organization, OrganizationResourcesProgress, OrganizationSearchQuery, Paginated, RequestParameter, ServerSentEvent, SubscriptionType, UserWithOrgRoles } from '../interfaces';
 import { HttpClientService } from './';
 /**
  * Service for managing organizations with administrative privileges (superuser role required).
@@ -41,13 +41,13 @@ export declare class OrganizationsAdministrationService extends APIBase {
      * Creates an organization with a free subscription and invites or adds a user to it.
      * The owner of the organization can be either the user or the service account 'organization-client', depending on the 'createOrgAsOwner' flag in the OrganizationCreateFlowDto.
      *
-     * @param {OrganizationCreateDto} organizationCreateDto - The data transfer object containing the organization details for creation
-     * @param {string[]} emailsToInvite - The email addresses of the users to be invited to the organization
-     * @param {string[]} emailsToAdd - The email addresses of the users to be added without an invitation to the organization
+     * @param {CreateOrganizationDto} createOrganizationDto - The data transfer object containing the organization details for creation
+     * @param {UserWithOrgRoles[]} usersWithOrgRolesToInvite - The email addresses with the individual org roles of the users to be invited to the organization
+     * @param {UserWithOrgRoles[]} usersWithOrgRolesToAdd - The email addresses with the individual org roles of the users to be added without an invitation to the organization
      * @param {boolean} createOrgAsOwner - Whether to create the organization with the user as the owner
      * @returns {Promise<Organization>} - An promise of the created organization
      */
-    createOrganization(organizationCreateDto: OrganizationCreateDto, emailsToInvite: string[], emailsToAdd: string[], createOrgAsOwner?: boolean): Promise<Organization>;
+    createOrganization(createOrganizationDto: CreateOrganizationDto, usersWithOrgRolesToInvite: UserWithOrgRoles[], usersWithOrgRolesToAdd: UserWithOrgRoles[], createOrgAsOwner?: boolean): Promise<Organization>;
     addOrganizationMembers(id: string, usersWithOrgRoles: UserWithOrgRoles[]): Promise<void>;
     addSubscriptionToOrganization(id: string, type: SubscriptionType): Promise<Organization>;
     /**

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

@@ -56,17 +56,17 @@ class OrganizationsAdministrationService extends api_base_1.APIBase {
      * Creates an organization with a free subscription and invites or adds a user to it.
      * The owner of the organization can be either the user or the service account 'organization-client', depending on the 'createOrgAsOwner' flag in the OrganizationCreateFlowDto.
      *
-     * @param {OrganizationCreateDto} organizationCreateDto - The data transfer object containing the organization details for creation
-     * @param {string[]} emailsToInvite - The email addresses of the users to be invited to the organization
-     * @param {string[]} emailsToAdd - The email addresses of the users to be added without an invitation to the organization
+     * @param {CreateOrganizationDto} createOrganizationDto - The data transfer object containing the organization details for creation
+     * @param {UserWithOrgRoles[]} usersWithOrgRolesToInvite - The email addresses with the individual org roles of the users to be invited to the organization
+     * @param {UserWithOrgRoles[]} usersWithOrgRolesToAdd - The email addresses with the individual org roles of the users to be added without an invitation to the organization
      * @param {boolean} createOrgAsOwner - Whether to create the organization with the user as the owner
      * @returns {Promise<Organization>} - An promise of the created organization
      */
-    createOrganization(organizationCreateDto, emailsToInvite, emailsToAdd, createOrgAsOwner = false) {
+    createOrganization(createOrganizationDto, usersWithOrgRolesToInvite, usersWithOrgRolesToAdd, createOrgAsOwner = false) {
         return this.httpClient.post(`${this.basePath}/create-org`, {
-            organizationDto: organizationCreateDto,
-            emailsToInvite,
-            emailsToAdd,
+            createOrganizationDto,
+            usersWithOrgRolesToInvite,
+            usersWithOrgRolesToAdd,
             createOrgAsOwner,
         });
     }

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

@@ -1,5 +1,5 @@
 import { APIBase } from '../api-base';
-import { KeycloakProfile, Organization, OrganizationCreateDto, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment } from '../interfaces';
+import { CreateOrganizationDto, KeycloakProfile, Organization, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment } from '../interfaces';
 import { HttpClientService } from './';
 export declare class OrganizationsService extends APIBase {
     constructor(httpClientClient: HttpClientService);
@@ -9,7 +9,7 @@ export declare class OrganizationsService extends APIBase {
      * @param dto organization information
      * @returns newly created organization
      */
-    addOne(dto: OrganizationCreateDto): Promise<Organization>;
+    addOne(dto: CreateOrganizationDto): Promise<Organization>;
     /**
      * Invite a user to an organization.
      *
@@ -18,7 +18,7 @@ export declare class OrganizationsService extends APIBase {
      * @param roles roles (names) which the user should get in the organization
      * @returns newly created invitation
      */
-    addOrganizationInvitation(id: string, email: string, roles: string[]): Promise<void>;
+    inviteUser(id: string, email: string, roles: string[]): Promise<void>;
     /**
      * Add organization role to an organization.
      *
@@ -104,7 +104,7 @@ export declare class OrganizationsService extends APIBase {
      * @param {string} userId - user id of requested member
      * @returns {Promise<KeycloakProfile>} member
      */
-    getOrganizationMemberById(id: string, userId: string): Promise<KeycloakProfile>;
+    getMemberById(id: string, userId: string): Promise<KeycloakProfile>;
     /**
      * Returns the names of organizations with the provided ids.
      *

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

@@ -23,7 +23,7 @@ class OrganizationsService extends api_base_1.APIBase {
      * @param roles roles (names) which the user should get in the organization
      * @returns newly created invitation
      */
-    addOrganizationInvitation(id, email, roles) {
+    inviteUser(id, email, roles) {
         return this.httpClient.post(`${this.basePath}/${id}/data/invitations`, { roles, email });
     }
     /**
@@ -134,8 +134,8 @@ class OrganizationsService extends api_base_1.APIBase {
      * @param {string} userId - user id of requested member
      * @returns {Promise<KeycloakProfile>} member
      */
-    getOrganizationMemberById(id, userId) {
-        return this.httpClient.get(`${this.basePath}/${id}/data/employees/${userId}`);
+    getMemberById(id, userId) {
+        return this.httpClient.get(`${this.basePath}/${id}/data/members/${userId}`);
     }
     /**
      * Returns the names of organizations with the provided ids.