@hahnpro/hpc-api 2025.12.1 → 2026.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/package.json +1 -1
  3. package/src/lib/interfaces/endpoint.interface.d.ts +8 -0
  4. package/src/lib/interfaces/index.d.ts +5 -3
  5. package/src/lib/interfaces/index.js +8 -1
  6. package/src/lib/interfaces/label.interface.d.ts +3 -1
  7. package/src/lib/interfaces/label.interface.js +2 -0
  8. package/src/lib/interfaces/organization.interface.d.ts +1 -1
  9. package/src/lib/interfaces/resource.interface.d.ts +18 -0
  10. package/src/lib/interfaces/resource.interface.js +36 -1
  11. package/src/lib/interfaces/task.interface.d.ts +31 -12
  12. package/src/lib/interfaces/task.interface.js +21 -0
  13. package/src/lib/interfaces/timeseries.interface.d.ts +7 -0
  14. package/src/lib/interfaces/vault.interface.d.ts +5 -0
  15. package/src/lib/mock/alert.mock.service.d.ts +7 -1
  16. package/src/lib/mock/alert.mock.service.js +10 -1
  17. package/src/lib/mock/api.mock.js +3 -1
  18. package/src/lib/mock/asset.mock.service.d.ts +2 -2
  19. package/src/lib/mock/asset.mock.service.js +2 -1
  20. package/src/lib/mock/assetTypes.mock.service.d.ts +2 -2
  21. package/src/lib/mock/assetTypes.mock.service.js +2 -1
  22. package/src/lib/mock/content.mock.service.d.ts +2 -2
  23. package/src/lib/mock/content.mock.service.js +2 -1
  24. package/src/lib/mock/endpoint.mock.service.d.ts +8 -1
  25. package/src/lib/mock/endpoint.mock.service.js +11 -1
  26. package/src/lib/mock/event.mock.service.d.ts +8 -1
  27. package/src/lib/mock/event.mock.service.js +11 -1
  28. package/src/lib/mock/flow-deployment.mock.service.d.ts +2 -2
  29. package/src/lib/mock/flow-deployment.mock.service.js +2 -1
  30. package/src/lib/mock/flow-functions.mock.service.d.ts +7 -1
  31. package/src/lib/mock/flow-functions.mock.service.js +10 -1
  32. package/src/lib/mock/flow-modules.mock.service.d.ts +6 -2
  33. package/src/lib/mock/flow-modules.mock.service.js +10 -1
  34. package/src/lib/mock/flow.mock.service.d.ts +2 -2
  35. package/src/lib/mock/flow.mock.service.js +2 -1
  36. package/src/lib/mock/notification-rules.mock.service.d.ts +8 -1
  37. package/src/lib/mock/notification-rules.mock.service.js +11 -1
  38. package/src/lib/mock/organizations-administration.mock.service.d.ts +2 -2
  39. package/src/lib/mock/organizations-administration.mock.service.js +2 -2
  40. package/src/lib/mock/organizations.mock.service.d.ts +3 -3
  41. package/src/lib/mock/organizations.mock.service.js +1 -1
  42. package/src/lib/mock/share.mock.service.d.ts +2 -2
  43. package/src/lib/mock/share.mock.service.js +1 -1
  44. package/src/lib/mock/task.mock.service.d.ts +2 -2
  45. package/src/lib/mock/task.mock.service.js +3 -2
  46. package/src/lib/mock/timeseries.mock.service.d.ts +4 -2
  47. package/src/lib/mock/timeseries.mock.service.js +1 -1
  48. package/src/lib/mock/trash.mock.service.d.ts +1 -0
  49. package/src/lib/mock/trash.mock.service.js +3 -3
  50. package/src/lib/services/alert.service.d.ts +8 -1
  51. package/src/lib/services/alert.service.js +11 -1
  52. package/src/lib/services/asset.service.d.ts +2 -2
  53. package/src/lib/services/asset.service.js +2 -1
  54. package/src/lib/services/assettypes.service.d.ts +2 -1
  55. package/src/lib/services/assettypes.service.js +3 -1
  56. package/src/lib/services/content.service.d.ts +2 -2
  57. package/src/lib/services/content.service.js +2 -1
  58. package/src/lib/services/endpoint.service.d.ts +8 -2
  59. package/src/lib/services/endpoint.service.js +11 -1
  60. package/src/lib/services/event.service.d.ts +8 -2
  61. package/src/lib/services/event.service.js +11 -1
  62. package/src/lib/services/flow-deployment.service.d.ts +3 -2
  63. package/src/lib/services/flow-deployment.service.js +2 -1
  64. package/src/lib/services/flow-function.service.d.ts +8 -2
  65. package/src/lib/services/flow-function.service.js +11 -1
  66. package/src/lib/services/flow-module.service.d.ts +8 -2
  67. package/src/lib/services/flow-module.service.js +11 -1
  68. package/src/lib/services/flow.service.d.ts +2 -2
  69. package/src/lib/services/flow.service.js +2 -1
  70. package/src/lib/services/http-client.service.d.ts +8 -1
  71. package/src/lib/services/http-client.service.js +9 -0
  72. package/src/lib/services/notification-rule.service.d.ts +8 -2
  73. package/src/lib/services/notification-rule.service.js +11 -1
  74. package/src/lib/services/organizations-administration.service.d.ts +5 -5
  75. package/src/lib/services/organizations-administration.service.js +7 -7
  76. package/src/lib/services/organizations.service.d.ts +3 -3
  77. package/src/lib/services/organizations.service.js +1 -1
  78. package/src/lib/services/share.service.d.ts +2 -2
  79. package/src/lib/services/share.service.js +2 -2
  80. package/src/lib/services/task.service.d.ts +2 -2
  81. package/src/lib/services/task.service.js +2 -1
  82. package/src/lib/services/timeseries.service.d.ts +2 -2
  83. package/src/lib/services/timeseries.service.js +2 -1
@@ -1,6 +1,12 @@
1
- import { HttpClientService } from '.';
1
+ import { DataService, HttpClientService } from '.';
2
+ import { APIBase } from '../api-base';
2
3
  import { NotificationRule } from '../interfaces';
3
4
  import { ShareService } from './share.service';
4
- export declare class NotificationRuleService extends ShareService<NotificationRule> {
5
+ interface BaseService extends DataService<NotificationRule>, ShareService {
6
+ }
7
+ declare class BaseService extends APIBase {
8
+ }
9
+ export declare class NotificationRuleService extends BaseService {
5
10
  constructor(httpClient: HttpClientService);
6
11
  }
12
+ export {};
@@ -1,8 +1,18 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.NotificationRuleService = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const ts_mixer_1 = require("ts-mixer");
6
+ const _1 = require(".");
7
+ const api_base_1 = require("../api-base");
4
8
  const share_service_1 = require("./share.service");
5
- class NotificationRuleService extends share_service_1.ShareService {
9
+ let BaseService = class BaseService extends api_base_1.APIBase {
10
+ };
11
+ BaseService = tslib_1.__decorate([
12
+ (0, ts_mixer_1.mix)(_1.DataService, share_service_1.ShareService)
13
+ ], BaseService);
14
+ /* eslint-enable @typescript-eslint/no-unsafe-declaration-merging */
15
+ class NotificationRuleService extends BaseService {
6
16
  constructor(httpClient) {
7
17
  super(httpClient, '/notification/rules');
8
18
  }
@@ -1,6 +1,6 @@
1
1
  import { Observable } from 'rxjs';
2
2
  import { APIBase } from '../api-base';
3
- import { Filter, Organization, OrganizationCreateDto, OrganizationResourcesProgress, OrganizationSearchQuery, Paginated, RequestParameter, ServerSentEvent, SubscriptionType, UserWithOrgRoles } from '../interfaces';
3
+ import { CreateOrganizationDto, Filter, Organization, OrganizationResourcesProgress, OrganizationSearchQuery, Paginated, RequestParameter, ServerSentEvent, SubscriptionType, UserWithOrgRoles } from '../interfaces';
4
4
  import { HttpClientService } from './';
5
5
  /**
6
6
  * Service for managing organizations with administrative privileges (superuser role required).
@@ -41,13 +41,13 @@ export declare class OrganizationsAdministrationService extends APIBase {
41
41
  * Creates an organization with a free subscription and invites or adds a user to it.
42
42
  * The owner of the organization can be either the user or the service account 'organization-client', depending on the 'createOrgAsOwner' flag in the OrganizationCreateFlowDto.
43
43
  *
44
- * @param {OrganizationCreateDto} organizationCreateDto - The data transfer object containing the organization details for creation
45
- * @param {string[]} emailsToInvite - The email addresses of the users to be invited to the organization
46
- * @param {string[]} emailsToAdd - The email addresses of the users to be added without an invitation to the organization
44
+ * @param {CreateOrganizationDto} createOrganizationDto - The data transfer object containing the organization details for creation
45
+ * @param {UserWithOrgRoles[]} usersWithOrgRolesToInvite - The email addresses with the individual org roles of the users to be invited to the organization
46
+ * @param {UserWithOrgRoles[]} usersWithOrgRolesToAdd - The email addresses with the individual org roles of the users to be added without an invitation to the organization
47
47
  * @param {boolean} createOrgAsOwner - Whether to create the organization with the user as the owner
48
48
  * @returns {Promise<Organization>} - An promise of the created organization
49
49
  */
50
- createOrganization(organizationCreateDto: OrganizationCreateDto, emailsToInvite: string[], emailsToAdd: string[], createOrgAsOwner?: boolean): Promise<Organization>;
50
+ createOrganization(createOrganizationDto: CreateOrganizationDto, usersWithOrgRolesToInvite: UserWithOrgRoles[], usersWithOrgRolesToAdd: UserWithOrgRoles[], createOrgAsOwner?: boolean): Promise<Organization>;
51
51
  addOrganizationMembers(id: string, usersWithOrgRoles: UserWithOrgRoles[]): Promise<void>;
52
52
  addSubscriptionToOrganization(id: string, type: SubscriptionType): Promise<Organization>;
53
53
  /**
@@ -56,17 +56,17 @@ class OrganizationsAdministrationService extends api_base_1.APIBase {
56
56
  * Creates an organization with a free subscription and invites or adds a user to it.
57
57
  * The owner of the organization can be either the user or the service account 'organization-client', depending on the 'createOrgAsOwner' flag in the OrganizationCreateFlowDto.
58
58
  *
59
- * @param {OrganizationCreateDto} organizationCreateDto - The data transfer object containing the organization details for creation
60
- * @param {string[]} emailsToInvite - The email addresses of the users to be invited to the organization
61
- * @param {string[]} emailsToAdd - The email addresses of the users to be added without an invitation to the organization
59
+ * @param {CreateOrganizationDto} createOrganizationDto - The data transfer object containing the organization details for creation
60
+ * @param {UserWithOrgRoles[]} usersWithOrgRolesToInvite - The email addresses with the individual org roles of the users to be invited to the organization
61
+ * @param {UserWithOrgRoles[]} usersWithOrgRolesToAdd - The email addresses with the individual org roles of the users to be added without an invitation to the organization
62
62
  * @param {boolean} createOrgAsOwner - Whether to create the organization with the user as the owner
63
63
  * @returns {Promise<Organization>} - An promise of the created organization
64
64
  */
65
- createOrganization(organizationCreateDto, emailsToInvite, emailsToAdd, createOrgAsOwner = false) {
65
+ createOrganization(createOrganizationDto, usersWithOrgRolesToInvite, usersWithOrgRolesToAdd, createOrgAsOwner = false) {
66
66
  return this.httpClient.post(`${this.basePath}/create-org`, {
67
- organizationDto: organizationCreateDto,
68
- emailsToInvite,
69
- emailsToAdd,
67
+ createOrganizationDto,
68
+ usersWithOrgRolesToInvite,
69
+ usersWithOrgRolesToAdd,
70
70
  createOrgAsOwner,
71
71
  });
72
72
  }
@@ -1,5 +1,5 @@
1
1
  import { APIBase } from '../api-base';
2
- import { KeycloakProfile, Organization, OrganizationCreateDto, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment } from '../interfaces';
2
+ import { CreateOrganizationDto, KeycloakProfile, Organization, OrganizationData, OrganizationDataKind, OrganizationName, OrganizationRolesAdjustment } from '../interfaces';
3
3
  import { HttpClientService } from './';
4
4
  export declare class OrganizationsService extends APIBase {
5
5
  constructor(httpClientClient: HttpClientService);
@@ -9,7 +9,7 @@ export declare class OrganizationsService extends APIBase {
9
9
  * @param dto organization information
10
10
  * @returns newly created organization
11
11
  */
12
- addOne(dto: OrganizationCreateDto): Promise<Organization>;
12
+ addOne(dto: CreateOrganizationDto): Promise<Organization>;
13
13
  /**
14
14
  * Invite a user to an organization.
15
15
  *
@@ -18,7 +18,7 @@ export declare class OrganizationsService extends APIBase {
18
18
  * @param roles roles (names) which the user should get in the organization
19
19
  * @returns newly created invitation
20
20
  */
21
- addOrganizationInvitation(id: string, email: string, roles: string[]): Promise<void>;
21
+ inviteUser(id: string, email: string, roles: string[]): Promise<void>;
22
22
  /**
23
23
  * Add organization role to an organization.
24
24
  *
@@ -23,7 +23,7 @@ class OrganizationsService extends api_base_1.APIBase {
23
23
  * @param roles roles (names) which the user should get in the organization
24
24
  * @returns newly created invitation
25
25
  */
26
- addOrganizationInvitation(id, email, roles) {
26
+ inviteUser(id, email, roles) {
27
27
  return this.httpClient.post(`${this.basePath}/${id}/data/invitations`, { roles, email });
28
28
  }
29
29
  /**
@@ -1,6 +1,6 @@
1
+ import { APIBase } from '../api-base';
1
2
  import { OrgResourcePermission, SharedResources, TokenOption } from '../interfaces';
2
- import { DataService } from './data.service';
3
- export declare class ShareService<T> extends DataService<T> {
3
+ export declare class ShareService extends APIBase {
4
4
  getBasePath(): string;
5
5
  cancelAccess(id: string, options?: TokenOption): Promise<void>;
6
6
  share(ids: string[], orgResourcePermissions: OrgResourcePermission[], connectedResourcesToShare?: SharedResources, sourceIds?: string[], sourceType?: string, options?: TokenOption): Promise<void>;
@@ -1,8 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ShareService = void 0;
4
- const data_service_1 = require("./data.service");
5
- class ShareService extends data_service_1.DataService {
4
+ const api_base_1 = require("../api-base");
5
+ class ShareService extends api_base_1.APIBase {
6
6
  getBasePath() {
7
7
  return this.basePath;
8
8
  }
@@ -1,8 +1,8 @@
1
- import { HttpClientService, TrashService } from '.';
1
+ import { DataService, HttpClientService, TrashService } from '.';
2
2
  import { APIBase } from '../api-base';
3
3
  import { LogbookEntry, LogbookEntryDto, Paginated, Task, TokenOption } from '../interfaces';
4
4
  import { ShareService } from './share.service';
5
- interface BaseService extends ShareService<Task>, TrashService<Task> {
5
+ interface BaseService extends DataService<Task>, ShareService, TrashService<Task> {
6
6
  }
7
7
  declare class BaseService extends APIBase {
8
8
  }
@@ -9,8 +9,9 @@ const share_service_1 = require("./share.service");
9
9
  let BaseService = class BaseService extends api_base_1.APIBase {
10
10
  };
11
11
  BaseService = tslib_1.__decorate([
12
- (0, ts_mixer_1.mix)(share_service_1.ShareService, _1.TrashService)
12
+ (0, ts_mixer_1.mix)(_1.DataService, share_service_1.ShareService, _1.TrashService)
13
13
  ], BaseService);
14
+ /* eslint-enable @typescript-eslint/no-unsafe-declaration-merging */
14
15
  class TaskService extends BaseService {
15
16
  constructor(httpClient) {
16
17
  super(httpClient, '/tasks');
@@ -1,8 +1,8 @@
1
- import { HttpClientService, TrashService } from '.';
1
+ import { DataService, HttpClientService, TrashService } from '.';
2
2
  import { APIBase } from '../api-base';
3
3
  import { Paginated, TimeSeries, TimeSeriesValue, TokenOption, TS_GROUPS } from '../interfaces';
4
4
  import { ShareService } from './share.service';
5
- interface BaseService extends ShareService<TimeSeries>, TrashService<TimeSeries> {
5
+ interface BaseService extends DataService<TimeSeries>, ShareService, TrashService<TimeSeries> {
6
6
  }
7
7
  declare class BaseService extends APIBase {
8
8
  }
@@ -9,8 +9,9 @@ const share_service_1 = require("./share.service");
9
9
  let BaseService = class BaseService extends api_base_1.APIBase {
10
10
  };
11
11
  BaseService = tslib_1.__decorate([
12
- (0, ts_mixer_1.mix)(share_service_1.ShareService, _1.TrashService)
12
+ (0, ts_mixer_1.mix)(_1.DataService, share_service_1.ShareService, _1.TrashService)
13
13
  ], BaseService);
14
+ /* eslint-enable @typescript-eslint/no-unsafe-declaration-merging */
14
15
  class TimeSeriesService extends BaseService {
15
16
  constructor(httpClient) {
16
17
  super(httpClient, '/tsm');