@hahnpro/hpc-api 2025.2.12 → 2025.2.15

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @hahnpro/hpc-api
 
+## 2025.2.15
+
+### Major Changes
+
+- **Breaking Change:** The signature of `timeseries::addAssetTimeSeriesValues` has been changed. Now it includes an additional _metadata_ parameter.
+- **Breaking Change:** The signature of `timeseries::addManyAssetTimeSeriesValues` has been changed. The _timeSeries_ parameter now includes _values_ and _metadata_ fields.
+
 ## 2025.2.0
 
 ### Major Changes
@@ -26,13 +33,11 @@
   The third option is to overwrite the `getAccessToken()` method of the `HttpClient`.
 
   The hierarchy of options is:
-
   1. token from api-call
   2. token from `provideExternalToken`
   3. token from `getAccessToken`
 
   # Breaking Changes
-
   1. The signature of `flowDeployments::updateOne` has been changed. The positional parameter `force` is now part of the `options` object (where you can also provide a token as described above).
 
 ## 5.3.4
@@ -130,7 +135,6 @@
 - 19af51f: Updated dependencies to reduce vulnerabilities
 
   **Breaking changes**
-
   - Raise minimum Node.js version to v18 for hpc-api and flow-sdk packages
 
 ## 4.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "2025.2.12",
+  "version": "2025.2.15",
   "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {
@@ -8,9 +8,9 @@
     "url": "https://hahnpro.com"
   },
   "dependencies": {
-    "axios": "1.8.4",
-    "eventsource": "3.0.6",
-    "form-data": "4.0.2",
+    "axios": "1.10.0",
+    "eventsource": "4.0.0",
+    "form-data": "4.0.3",
     "jose": "5.10.0",
     "jwt-decode": "4.0.0",
     "p-queue": "6.6.2",

package/src/lib/data.service.js

@@ -12,7 +12,7 @@ class DataService extends api_base_1.APIBase {
     }
     getOne(id, options = {}) {
         const params = options.populate ? { populate: options.populate } : {};
-        return this.httpClient.get(`${this.basePath}/${id}`, { params });
+        return this.httpClient.get(`${this.basePath}/${id}`, { params, ...options });
     }
     getMany(params = {}, options = {}) {
         params.limit = params.limit || 0;

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

@@ -15,11 +15,13 @@ interface AssistantLabels {
 }
 interface BaseMessage {
     id?: string;
+    responseId?: string;
     thread: string;
     createdAt?: string;
     updatedAt?: string;
 }
 export interface AssistantMessage extends BaseMessage {
+    responseId?: string;
     role: 'assistant';
     content?: string;
     agentStack?: string[];
@@ -39,6 +41,11 @@ export interface AssistantMessage extends BaseMessage {
     }[];
     contextVariables?: Record<string, unknown>;
     finishReason?: 'stop' | 'length' | 'content-filter' | 'tool-calls' | 'error' | 'other' | 'unknown';
+    traceId?: string;
+    feedback?: {
+        value: number;
+        comment?: string;
+    };
 }
 export interface SystemMessage extends BaseMessage {
     role: 'system';

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

@@ -1,16 +1,12 @@
 import { Author, Owner, Resource } from './resource.interface';
 export interface Event extends Resource {
-    data?: {
-        tsField: string;
-        timestamp: string;
-        value: number;
-    };
+    data?: Record<string, any>;
     assetRef?: string;
     assetRef$name?: string;
     alertRef?: string;
     tsRef?: string;
     eventRef?: string;
-    cause: string;
+    cause?: string;
     level: EventLevel;
     group?: string;
     owner?: Owner;

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

@@ -14,6 +14,7 @@ export interface TimeSeries {
     tsRef?: [string];
     autoDelData: Date;
     autoDelBucket: Date;
+    metadata?: Record<string, any>;
     deletedAt?: string;
 }
 export interface TimeSeriesCondition {

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

@@ -17,5 +17,6 @@ export declare class AiMockService extends APIBase implements AiService {
     getLatestThread(): Promise<ThreadPopulated>;
     listThreads(): Promise<ThreadPopulated[]>;
     listAssistantThreads(assistantId: string): Promise<ThreadPopulated[]>;
+    provideFeedback(traceId: string, value: number, comment?: string): Promise<void>;
     deleteThread(threadId: string): Promise<Thread>;
 }

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

@@ -36,6 +36,9 @@ class AiMockService extends api_base_1.APIBase {
     listAssistantThreads(assistantId) {
         throw new Error('Method not implemented.');
     }
+    provideFeedback(traceId, value, comment) {
+        throw new Error('Method not implemented.');
+    }
     deleteThread(threadId) {
         throw new Error('Method not implemented.');
     }

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

@@ -22,10 +22,13 @@ export declare class TimeseriesMockService extends BaseService implements TimeSe
     })[]>>;
     addAssetTimeSeriesValues(assetId: string, name: string, readPermissions: string[], readWritePermissions: string[], values: {
         [timestamp: string]: any;
-    }): Promise<TimeSeries>;
+    }, metadata?: Record<string, any>): Promise<TimeSeries>;
     addManyAssetTimeSeriesValues(assetId: string, readPermissions: string[], readWritePermissions: string[], timeSeries: {
         [timeSeriesName: string]: {
-            [timestamp: string]: any;
+            values: {
+                [timestamp: string]: any;
+            };
+            metadata?: Record<string, any>;
         };
     }): Promise<PromiseSettledResult<TimeSeries>[]>;
     addValue(id: string, value: {

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

@@ -29,7 +29,7 @@ class TimeseriesMockService extends BaseService {
         const page = this.getItems(params, false);
         return Promise.resolve(page);
     }
-    addAssetTimeSeriesValues(assetId, name, readPermissions, readWritePermissions, values) {
+    addAssetTimeSeriesValues(assetId, name, readPermissions, readWritePermissions, values, metadata) {
         const ts = this.data.find((v) => v.assetRef === assetId);
         const data = Object.entries(values).map(([timestamp, value]) => {
             if (value !== null && typeof value === 'object') {
@@ -52,6 +52,7 @@ class TimeseriesMockService extends BaseService {
                 readWritePermissions,
                 assetRef: assetId,
                 data,
+                metadata,
             };
             return this.addOne(dto);
         }
@@ -61,7 +62,7 @@ class TimeseriesMockService extends BaseService {
     addManyAssetTimeSeriesValues(assetId, readPermissions, readWritePermissions, timeSeries) {
         const ts = this.data.find((v) => v.assetRef === assetId);
         const psr = [];
-        for (const [tsName, values] of Object.entries(timeSeries)) {
+        for (const [tsName, { values, metadata }] of Object.entries(timeSeries)) {
             const data = Object.entries(values).map(([timestamp, value]) => {
                 if (value !== null && typeof value === 'object') {
                     return { timestamp, ...value };
@@ -83,6 +84,7 @@ class TimeseriesMockService extends BaseService {
                     readWritePermissions,
                     assetRef: assetId,
                     data,
+                    metadata,
                 };
                 this.addOne(dto).then((v) => psr.push({ status: 'fulfilled', value: v }));
             }

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

@@ -4,7 +4,7 @@ import { HttpClient, TokenOption } from '../http.service';
 import { AiAssistant, Message, SpeechToken, Thread, ThreadPopulated } from '../interfaces';
 export declare class AiService extends APIBase {
     constructor(httpClient: HttpClient);
-    addMessage(message: string, threadId?: string, assistantId?: string): Promise<Message>;
+    addMessage(message: string, threadId?: string, assistantId?: string, context?: Record<string, unknown>): Promise<Message>;
     createThread(assistantId: string, isEphemeral?: boolean): Promise<ThreadPopulated>;
     getLatestAssistantThread(assistantId: string): Promise<ThreadPopulated>;
     listAssistantThreads(assistantId: string): Promise<ThreadPopulated[]>;
@@ -15,5 +15,6 @@ export declare class AiService extends APIBase {
     getThread(threadId: string): Promise<ThreadPopulated>;
     getLatestThread(): Promise<ThreadPopulated>;
     listThreads(assistantIds?: string[], params?: {}, options?: TokenOption): Promise<ThreadPopulated[]>;
+    provideFeedback(traceId: string, value: number, comment?: string): Promise<void>;
     deleteThread(threadId: string): Promise<Thread>;
 }

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

@@ -6,8 +6,8 @@ class AiService extends api_base_1.APIBase {
     constructor(httpClient) {
         super(httpClient, '/ai');
     }
-    addMessage(message, threadId, assistantId) {
-        return this.httpClient.post(`${this.basePath}/message`, { message, threadId, assistantId });
+    addMessage(message, threadId, assistantId, context) {
+        return this.httpClient.post(`${this.basePath}/message`, { message, threadId, assistantId, context });
     }
     createThread(assistantId, isEphemeral) {
         return this.httpClient.post(`${this.basePath}/threads`, { assistantId, isEphemeral });
@@ -42,6 +42,9 @@ class AiService extends api_base_1.APIBase {
         }
         return this.httpClient.get(`${this.basePath}/threads`, { params, ...options });
     }
+    provideFeedback(traceId, value, comment) {
+        return this.httpClient.post(`${this.basePath}/feedback`, { traceId, value, comment });
+    }
     deleteThread(threadId) {
         return this.httpClient.delete(`${this.basePath}/threads/${threadId}`);
     }

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

@@ -26,11 +26,12 @@ export declare class TimeSeriesService extends BaseService {
      *   ...
      * }
      * @param options
+     * @param metadata - Optional metadata to be associated with the time series.
      * @returns a promise that resolves to the time series that was added.
      */
     addAssetTimeSeriesValues(assetId: string, name: string, readPermissions: string[], readWritePermissions: string[], values: {
         [timestamp: string]: any;
-    }, options?: TokenOption): Promise<TimeSeries>;
+    }, metadata?: Record<string, any>, options?: TokenOption): Promise<TimeSeries>;
     /**
      * Adds multiple time series values to an asset by the name of the time series.
      * If the time series does not exist, it is created.
@@ -42,8 +43,11 @@ export declare class TimeSeriesService extends BaseService {
      * @param timeSeries - The time series values are specified as an object with the following structure:
      * {
      *  [timeSeriesName: string]: { // The name of the time series
-     *    [timestamp: string]: any, // The timestamp and value pairs
-     *    ...
+     *    values: { // The time series values are specified as an object with the following structure:
+     *      [timestamp: string]: any, // The timestamp and value pairs
+     *      ...
+     *    },
+     *    metadata?: Record<string, any>, // Optional metadata to be associated with the time series
      *  },
      *  ...
      * }
@@ -58,7 +62,10 @@ export declare class TimeSeriesService extends BaseService {
      */
     addManyAssetTimeSeriesValues(assetId: string, readPermissions: string[], readWritePermissions: string[], timeSeries: {
         [timeSeriesName: string]: {
-            [timestamp: string]: any;
+            values: {
+                [timestamp: string]: any;
+            };
+            metadata?: Record<string, any>;
         };
     }, options?: TokenOption): Promise<PromiseSettledResult<TimeSeries>[]>;
     getMostRecentValue(id: string, before?: Date, options?: TokenOption): Promise<TimeSeriesValue>;

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

@@ -31,14 +31,16 @@ class TimeSeriesService extends BaseService {
      *   ...
      * }
      * @param options
+     * @param metadata - Optional metadata to be associated with the time series.
      * @returns a promise that resolves to the time series that was added.
      */
-    addAssetTimeSeriesValues(assetId, name, readPermissions, readWritePermissions, values, options = {}) {
+    addAssetTimeSeriesValues(assetId, name, readPermissions, readWritePermissions, values, metadata, options = {}) {
         const dto = {
             name,
             readPermissions,
             readWritePermissions,
             values,
+            metadata,
         };
         return this.httpClient.post(`${this.basePath}/assets/${assetId}`, dto, options);
     }
@@ -53,8 +55,11 @@ class TimeSeriesService extends BaseService {
      * @param timeSeries - The time series values are specified as an object with the following structure:
      * {
      *  [timeSeriesName: string]: { // The name of the time series
-     *    [timestamp: string]: any, // The timestamp and value pairs
-     *    ...
+     *    values: { // The time series values are specified as an object with the following structure:
+     *      [timestamp: string]: any, // The timestamp and value pairs
+     *      ...
+     *    },
+     *    metadata?: Record<string, any>, // Optional metadata to be associated with the time series
      *  },
      *  ...
      * }
@@ -68,11 +73,12 @@ class TimeSeriesService extends BaseService {
      * }
      */
     addManyAssetTimeSeriesValues(assetId, readPermissions, readWritePermissions, timeSeries, options = {}) {
-        const dtos = Object.entries(timeSeries).map(([name, values]) => ({
+        const dtos = Object.entries(timeSeries).map(([name, { values, metadata }]) => ({
             name,
             readPermissions,
             readWritePermissions,
             values,
+            metadata,
         }));
         return this.httpClient.post(`${this.basePath}/assets/${assetId}/bulk`, dtos, options);
     }