@hahnpro/hpc-api 2025.2.2 → 2025.2.4

package/README.md

@@ -61,6 +61,8 @@ defaults to `https://testing.hahnpro.com`), `AUTH_BASE_URL` (defaults to `API_BA
 
 ```typescript
 import { API } from '@hahnpro/flow-sdk';
+// or by using dotenv
+import * as dotenv from 'dotenv';
 
 // explicitly set the envs
 process.env.API_BASE_URL = '*your API URL*';
@@ -69,9 +71,6 @@ process.env.AUTH_REALM = '*the Keycloak Realm*';
 process.env.API_USER = '*your username*';
 process.env.AUTH_SECRET = '*your secret*';
 
-// or by using dotenv
-import * as dotenv from 'dotenv';
-
 dotenv.config();
 
 const api = new API();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2025.2.2",
+  "version": "2025.2.4",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {
@@ -8,10 +8,10 @@
     "url": "https://hahnpro.com"
   },
   "dependencies": {
-    "axios": "1.7.9",
+    "axios": "1.8.2",
     "eventsource": "3.0.5",
     "form-data": "4.0.2",
-    "jose": "5.9.6",
+    "jose": "5.10.0",
     "jwt-decode": "4.0.0",
     "p-queue": "6.6.2",
     "ts-mixer": "6.0.4",

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './lib/api';
+export type * from './lib/interfaces';
 export * from './lib/asset.interface';
 export * from './lib/content.interface';
 export * from './lib/data.interface';

package/src/lib/api.d.ts

@@ -10,14 +10,17 @@ import { FlowService } from './flow.service';
 import { HttpClient } from './http.service';
 import { LabelService } from './label.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 { 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;
     assets: AssetService;
     assetTypes: AssetTypesService;
     contents: ContentService;
@@ -28,6 +31,7 @@ export declare class API {
     flowFunctions: FlowFunctionService;
     flowModules: FlowModuleService;
     labels: LabelService;
+    organizations: OrganizationService;
     proxy: ProxyService;
     secrets: SecretService;
     tasks: TaskService;

package/src/lib/api.js

@@ -13,8 +13,10 @@ const flow_service_1 = require("./flow.service");
 const http_service_1 = require("./http.service");
 const label_service_1 = require("./label.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");
@@ -42,6 +44,7 @@ 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.contents = new content_service_1.ContentService(this.httpClient);
@@ -52,6 +55,7 @@ class API {
         this.flowFunctions = new flow_function_service_1.FlowFunctionService(this.httpClient);
         this.flowModules = new flow_module_service_1.FlowModuleService(this.httpClient);
         this.labels = new label_service_1.LabelService(this.httpClient);
+        this.organizations = new organization_service_1.OrganizationService(this.httpClient);
         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);

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

@@ -0,0 +1,4 @@
+export interface SpeechToken {
+    token: string;
+    region: string;
+}

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

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

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

@@ -0,0 +1 @@
+export type { SpeechToken } from './ai.interface';

package/src/lib/interfaces/index.js

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

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

@@ -0,0 +1,9 @@
+import { APIBase } from '../api-base';
+import { HttpClient } from '../http.service';
+import { SpeechToken } from '../interfaces';
+import { AiService } from '../services';
+export declare class AiMockService extends APIBase implements AiService {
+    httpClient: HttpClient;
+    basePath: string;
+    getSpeechToken(): Promise<SpeechToken>;
+}

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

@@ -0,0 +1,10 @@
+"use strict";
+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() {
+        throw new Error('Method not implemented.');
+    }
+}
+exports.AiMockService = AiMockService;

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

@@ -13,7 +13,9 @@ import { FlowDiagram, FlowDto, FlowRevision } from '../flow.interface';
 import { FlowService } from '../flow.service';
 import { Label } from '../label.interface';
 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';
@@ -26,6 +28,7 @@ import { EventsMockService } from './events.mock.service';
 import { HttpMockService } from './http.mock.service';
 import { LabelMockService } from './label.mock.service';
 import { NotificationMockService } from './notification.mock.service';
+import { OrganizationMockService } from './organization.mock.service';
 import { SecretMockService } from './secret.mock.service';
 import { TaskMockService } from './task.mock.service';
 import { TimeseriesMockService } from './timeseries.mock.service';
@@ -51,8 +54,10 @@ export interface MockAPIInitData {
     labels?: LabelInit[];
     vault?: VaultSecretInit[];
     notifications?: NotificationInit[];
+    organizations?: OrganizationInit[];
 }
 export declare class MockAPI implements API {
+    ai: AiService;
     httpClient: HttpMockService;
     assets: AssetMockService;
     assetTypes: AssetTypesMockService;
@@ -71,6 +76,7 @@ export declare class MockAPI implements API {
     users: UserMockService;
     vault: VaultMockService;
     notifications: NotificationMockService;
+    organizations: OrganizationMockService;
     constructor(initData: MockAPIInitData);
 }
 export type Identity<T> = {
@@ -107,6 +113,7 @@ export type FlowDiagramInit = AtLeast<FlowDiagram, 'id' | 'flow'>;
 export type LabelInit = AtLeast<Label, 'id' | 'name'>;
 export type VaultSecretInit = AtLeast<VaultSecret, 'name' | 'secret'>;
 export type NotificationInit = AtLeast<Notification, 'id' | 'name' | 'userId' | 'notificationType'>;
+export type OrganizationInit = AtLeast<Organization, 'id' | 'name'>;
 export interface UserInit {
     roles: string[];
 }

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

@@ -16,6 +16,7 @@ const flow_mock_service_1 = require("./flow.mock.service");
 const http_mock_service_1 = require("./http.mock.service");
 const label_mock_service_1 = require("./label.mock.service");
 const notification_mock_service_1 = require("./notification.mock.service");
+const organization_mock_service_1 = require("./organization.mock.service");
 const secret_mock_service_1 = require("./secret.mock.service");
 const task_mock_service_1 = require("./task.mock.service");
 const timeseries_mock_service_1 = require("./timeseries.mock.service");
@@ -24,7 +25,7 @@ const vault_mock_service_1 = require("./vault.mock.service");
 class MockAPI {
     constructor(initData) {
         this.proxy = null;
-        const { assets = [], assetRevisions = [], contents = [], endpoints = [], secrets = [], timeSeries = [], tasks = [], events = [], users, flows = [], flowRevisions = [], deployments = [], functions = [], functionRevisions = [], modules = [], diagrams = [], labels = [], vault = [], notifications = [], } = initData;
+        const { assets = [], assetRevisions = [], contents = [], endpoints = [], secrets = [], timeSeries = [], tasks = [], events = [], users, flows = [], flowRevisions = [], deployments = [], functions = [], functionRevisions = [], modules = [], diagrams = [], labels = [], vault = [], notifications = [], organizations = [], } = initData;
         // convert init data to normal data that the services usually use
         const assetTypes = assets
             .map((v) => v.type)
@@ -182,6 +183,10 @@ class MockAPI {
             description: v.description ?? '',
             read: v.read ?? false,
         }));
+        const organizations1 = organizations.map((v) => ({
+            ...v,
+            domains: v.domains ?? [],
+        }));
         this.assets = new asset_mock_service_1.AssetMockService(this, assets1, assetRevisions1);
         this.assetTypes = new assetTypes_mock_service_1.AssetTypesMockService(assetTypes, []);
         this.contents = new content_mock_service_1.ContentMockService(contents1, contentData);
@@ -198,6 +203,7 @@ class MockAPI {
         this.labels = new label_mock_service_1.LabelMockService(labels1);
         this.vault = new vault_mock_service_1.VaultMockService(vaultSecrets1);
         this.notifications = new notification_mock_service_1.NotificationMockService(notifications1);
+        this.organizations = new organization_mock_service_1.OrganizationMockService(organizations1);
         this.httpClient = new http_mock_service_1.HttpMockService();
     }
 }

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

@@ -10,3 +10,4 @@ export * from './task.mock.service';
 export * from './events.mock.service';
 export * from './vault.mock.service';
 export * from './notification.mock.service';
+export * from './organization.mock.service';

package/src/lib/mock/index.js

@@ -13,3 +13,4 @@ tslib_1.__exportStar(require("./task.mock.service"), exports);
 tslib_1.__exportStar(require("./events.mock.service"), exports);
 tslib_1.__exportStar(require("./vault.mock.service"), exports);
 tslib_1.__exportStar(require("./notification.mock.service"), exports);
+tslib_1.__exportStar(require("./organization.mock.service"), exports);

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

@@ -0,0 +1,7 @@
+import { Organization } from '../organization.interface';
+import { OrganizationService } from '../organization.service';
+import { DataMockService } from './data.mock.service';
+export declare class OrganizationMockService extends DataMockService<Organization> implements OrganizationService {
+    constructor(organizations: Organization[]);
+    addOrganizationInvitation(id: string, email: string, roles: string[]): Promise<void>;
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationMockService = void 0;
+const data_mock_service_1 = require("./data.mock.service");
+class OrganizationMockService extends data_mock_service_1.DataMockService {
+    constructor(organizations) {
+        super();
+        this.data = organizations;
+    }
+    addOrganizationInvitation(id, email, roles) {
+        if (!id || !email || !roles?.length) {
+            return Promise.reject();
+        }
+        return Promise.resolve();
+    }
+}
+exports.OrganizationMockService = OrganizationMockService;

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

@@ -0,0 +1,25 @@
+import { Author } from './resource.interface';
+export interface Organization {
+    id?: string;
+    name: string;
+    description?: string;
+    realm?: string;
+    domains?: string[];
+    logo?: string;
+    addressLine?: string;
+    zipCode?: string;
+    city?: string;
+    phoneNumber?: string;
+    website?: string;
+    vat?: string;
+    certificates?: string[];
+    services?: string[];
+    subscriptionId?: string;
+    previousSubscriptions?: string[];
+    assetId?: string;
+    verified?: boolean;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    createdBy?: Author;
+    updatedBy?: Author;
+}

package/src/lib/organization.interface.js

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

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

@@ -0,0 +1,7 @@
+import { DataService } from './data.service';
+import { HttpClient } from './http.service';
+import { Organization } from './organization.interface';
+export declare class OrganizationService extends DataService<Organization> {
+    constructor(httpClient: HttpClient);
+    addOrganizationInvitation(id: string, email: string, roles: string[]): Promise<void>;
+}

package/src/lib/organization.service.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationService = void 0;
+const data_service_1 = require("./data.service");
+class OrganizationService extends data_service_1.DataService {
+    constructor(httpClient) {
+        super(httpClient, '/organizations');
+    }
+    addOrganizationInvitation(id, email, roles) {
+        return this.httpClient.post(`${this.basePath}/${id}/data/invitations`, { roles, email });
+    }
+}
+exports.OrganizationService = OrganizationService;

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

@@ -0,0 +1,7 @@
+import { APIBase } from '../api-base';
+import { HttpClient } from '../http.service';
+import { SpeechToken } from '../interfaces';
+export declare class AiService extends APIBase {
+    constructor(httpClient: HttpClient);
+    getSpeechToken(): Promise<SpeechToken>;
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiService = void 0;
+const api_base_1 = require("../api-base");
+class AiService extends api_base_1.APIBase {
+    constructor(httpClient) {
+        super(httpClient, '/assistants');
+    }
+    async getSpeechToken() {
+        return this.httpClient.get(`${this.basePath}/speech/token`);
+    }
+}
+exports.AiService = AiService;

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

@@ -0,0 +1 @@
+export { AiService } from './ai.service';

package/src/lib/services/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiService = void 0;
+var ai_service_1 = require("./ai.service");
+Object.defineProperty(exports, "AiService", { enumerable: true, get: function () { return ai_service_1.AiService; } });

package/src/lib/user-settings.interface.d.ts

@@ -1,7 +1,6 @@
 export interface UserSettings {
     userId: string;
     language: string;
-    activeRoles: Permission[];
     creationReadRoles: Permission[];
     creationWriteRoles: Permission[];
     activeTags: string[];