@hahnpro/hpc-api 2026.2.4 → 2026.2.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @hahnpro/hpc-api
 
+# 2026.2.6
+- Updated Search-Interface: SearchResult -> SearchMatchReason -> SearchMatchReasonContentPart
+- Updated search-service search method
+- Update AI-Interface: added ResourceSelectionRejected interface
+
+# 2026.2.5
+
+### Patch Changes
+
+- Added to Ai-Interface: ResourceSelectionOption abd SelectionMessage
+- Added getLogbookEntriesByIds to task.service
+
 # 2026.2.2
 
 ### Patch Changes

package/package.json

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

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

@@ -35,13 +35,15 @@ export declare enum Role {
 export declare enum ToolType {
     HANDOFF = "handoff",
     CHOICE = "choice",
-    ACTION = "action"
+    ACTION = "action",
+    BUILT_IN_ACTION = "built_in-action"
 }
 export declare enum ReferenceType {
     ASSET = "asset",
     ASSET_TYPE = "asset-type",
     DOCUMENT = "document",
     EVENT = "event",
+    LOGBOOK_ENTRY = "logbook-entry",
     TASK = "task",
     WEB_SOURCE = "web-source"
 }
@@ -53,11 +55,21 @@ export interface AiAssistant {
     icon?: string;
     readPermissions?: string[];
 }
+export interface ResourceSelectionRejected {
+    rejected: true;
+    message: string;
+}
 interface AssistantLabels {
     name: string;
     description?: string;
     welcomeMessage?: string;
 }
+interface SelectionMessage {
+    message: string;
+    resourceType: ReferenceType;
+    moreMatches: boolean;
+    choices: ResourceSelectionOption[];
+}
 interface BaseMessage {
     id?: string;
     responseId?: string;
@@ -103,7 +115,7 @@ export interface ToolMessage extends BaseMessage {
     agentStack?: string[];
     status?: ToolMessageStatus;
     result?: any;
-    args?: any;
+    args?: SelectionMessage | any;
     contextVariables?: Record<string, unknown>;
 }
 export interface UserMessage extends BaseMessage {
@@ -132,4 +144,29 @@ export interface ThreadPopulated extends Thread {
     firstMessage?: Message;
     lastMessage?: Message;
 }
+export interface BaseResourceSelectionOption {
+    id: string;
+    name?: string;
+    resourceType: ReferenceType;
+}
+export interface AssetResourceSelectionOption extends BaseResourceSelectionOption {
+    resourceType: ReferenceType.ASSET;
+    type?: string;
+    typeName?: string;
+    location?: string;
+    factory?: string;
+}
+export interface DocumentResourceSelectionOption extends BaseResourceSelectionOption {
+    resourceType: ReferenceType.DOCUMENT;
+    mimetype?: string;
+}
+export interface LogbookEntryResourceSelectionOption extends BaseResourceSelectionOption {
+    resourceType: ReferenceType.LOGBOOK_ENTRY;
+    date: string;
+    duration?: number;
+}
+export interface GenericResourceSelectionOption extends BaseResourceSelectionOption {
+    resourceType: Exclude<ReferenceType, ReferenceType.ASSET | ReferenceType.DOCUMENT | ReferenceType.LOGBOOK_ENTRY>;
+}
+export type ResourceSelectionOption = AssetResourceSelectionOption | DocumentResourceSelectionOption | LogbookEntryResourceSelectionOption | GenericResourceSelectionOption;
 export {};

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

@@ -44,6 +44,7 @@ var ToolType;
     ToolType["HANDOFF"] = "handoff";
     ToolType["CHOICE"] = "choice";
     ToolType["ACTION"] = "action";
+    ToolType["BUILT_IN_ACTION"] = "built_in-action";
 })(ToolType || (exports.ToolType = ToolType = {}));
 var ReferenceType;
 (function (ReferenceType) {
@@ -51,6 +52,7 @@ var ReferenceType;
     ReferenceType["ASSET_TYPE"] = "asset-type";
     ReferenceType["DOCUMENT"] = "document";
     ReferenceType["EVENT"] = "event";
+    ReferenceType["LOGBOOK_ENTRY"] = "logbook-entry";
     ReferenceType["TASK"] = "task";
     ReferenceType["WEB_SOURCE"] = "web-source";
 })(ReferenceType || (exports.ReferenceType = ReferenceType = {}));

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

@@ -1,4 +1,4 @@
-export type { AiAssistant, AssistantMessage, Message, SpeechToken, SystemMessage, Thread, ThreadPopulated, ToolMessage, UserMessage, } from './ai.interface';
+export type { AiAssistant, AssetResourceSelectionOption, AssistantMessage, DocumentResourceSelectionOption, GenericResourceSelectionOption, LogbookEntryResourceSelectionOption, Message, ResourceSelectionOption, ResourceSelectionRejected, SpeechToken, SystemMessage, Thread, ThreadPopulated, ToolMessage, UserMessage, } from './ai.interface';
 export type { Alert, AlertCondition, TimeSeriesReference } from './alert.interface';
 export type { Api } from './api.interface';
 export type { AddToProperty, Asset, AssetRevision, AssetType, AssetTypeRevision, Attachment, EventCause, EventLevelOverride, RemoveFromProperty, Template, } from './asset.interface';
@@ -19,18 +19,18 @@ 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, CreateOrganizationDto, OrganizationData, OrganizationDataKind, OrganizationDomain, OrganizationExtraProperties, OrganizationName, OrganizationRolesAdjustment, OrganizationSearchQuery, SubscriptionType, UserWithOrgRoles, } from './organization.interface';
+export type { CreateOrganizationDto, Organization, 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';
-export type { ConnectedResources, ConnectedResourceType, OrgResourcePermission, Resource, ResourceReference, SharedResources, } from './resource.interface';
 export type { CreateReferenceDto, ObjectReference, ReferencesQuery } from './reference.interface';
+export type { ConnectedResources, ConnectedResourceType, OrgResourcePermission, Resource, ResourceReference, SharedResources, } from './resource.interface';
 export type { JsonSchema, JsonSchemaArray, JsonSchemaForm, JsonSchemaType, JsonSchemaTypeName } from './schema.interface';
-export type { SearchOptions, SearchResult, SearchSortOption, SortableField } from './search.interface';
+export type { SearchMatchReason, SearchMatchReasonContentPart, SearchOptions, SearchResult, SearchSortOption, SortableField, } from './search.interface';
 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, Assignee } from './task.interface';
+export type { Assignee, LogbookEntry, LogbookEntryDto, Task } 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';
@@ -42,5 +42,5 @@ export { EventLevel } from './event.interface';
 export { LABEL_COLORS } from './label.interface';
 export { OwnerType } from './owner.interface';
 export { ObjectReferenceType } from './reference.interface';
-export { PermissionType, ResourceType, ResourceApiPath, resourceApiPathToTypeMap } from './resource.interface';
-export { Priority, TaskStatus, AssigneeType } from './task.interface';
+export { PermissionType, ResourceApiPath, resourceApiPathToTypeMap, ResourceType } from './resource.interface';
+export { AssigneeType, Priority, TaskStatus } from './task.interface';

package/src/lib/interfaces/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssigneeType = exports.TaskStatus = exports.Priority = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.ResourceType = exports.PermissionType = exports.ObjectReferenceType = exports.OwnerType = exports.LABEL_COLORS = exports.EventLevel = exports.instanceOfTimePeriod = exports.ReturnType = exports.AlertType = exports.AlertLevel = exports.ToolType = exports.ToolMessageStatus = exports.Role = exports.ReferenceType = exports.FinishReason = exports.AvailableLanguages = exports.AssistantMessageStatus = exports.OrganizationMembersInviteOrAdd = void 0;
+exports.TaskStatus = exports.Priority = exports.AssigneeType = exports.ResourceType = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.PermissionType = exports.ObjectReferenceType = exports.OwnerType = exports.LABEL_COLORS = exports.EventLevel = exports.instanceOfTimePeriod = exports.ReturnType = exports.AlertType = exports.AlertLevel = exports.ToolType = exports.ToolMessageStatus = exports.Role = exports.ReferenceType = exports.FinishReason = exports.AvailableLanguages = exports.AssistantMessageStatus = 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 ai_interface_1 = require("./ai.interface");
@@ -28,10 +28,10 @@ var reference_interface_1 = require("./reference.interface");
 Object.defineProperty(exports, "ObjectReferenceType", { enumerable: true, get: function () { return reference_interface_1.ObjectReferenceType; } });
 var resource_interface_1 = require("./resource.interface");
 Object.defineProperty(exports, "PermissionType", { enumerable: true, get: function () { return resource_interface_1.PermissionType; } });
-Object.defineProperty(exports, "ResourceType", { enumerable: true, get: function () { return resource_interface_1.ResourceType; } });
 Object.defineProperty(exports, "ResourceApiPath", { enumerable: true, get: function () { return resource_interface_1.ResourceApiPath; } });
 Object.defineProperty(exports, "resourceApiPathToTypeMap", { enumerable: true, get: function () { return resource_interface_1.resourceApiPathToTypeMap; } });
+Object.defineProperty(exports, "ResourceType", { enumerable: true, get: function () { return resource_interface_1.ResourceType; } });
 var task_interface_1 = require("./task.interface");
+Object.defineProperty(exports, "AssigneeType", { enumerable: true, get: function () { return task_interface_1.AssigneeType; } });
 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/reference.interface.d.ts

@@ -12,7 +12,12 @@ export declare enum ObjectReferenceType {
      * Marks an Object as updated by an AI-Thread.
      * Object is linked to the AI-Thread's ID.'
      */
-    UPDATED_BY_THREAD = "updated_by_thread"
+    UPDATED_BY_THREAD = "updated_by_thread",
+    /**
+     * Marks an Object as being part of the 'Weber Engineering Flange Skill Check Application' to link examinees to an
+     * examination, in which they participate.
+     */
+    FLANGE_SKILL_CHECK_APPLICATION_EXAMINATION_EXAMINEE = "flange_skill_check_application_examination_examinee"
 }
 export interface ObjectReference {
     id: number;

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

@@ -17,4 +17,9 @@ var ObjectReferenceType;
      * Object is linked to the AI-Thread's ID.'
      */
     ObjectReferenceType["UPDATED_BY_THREAD"] = "updated_by_thread";
+    /**
+     * Marks an Object as being part of the 'Weber Engineering Flange Skill Check Application' to link examinees to an
+     * examination, in which they participate.
+     */
+    ObjectReferenceType["FLANGE_SKILL_CHECK_APPLICATION_EXAMINATION_EXAMINEE"] = "flange_skill_check_application_examination_examinee";
 })(ObjectReferenceType || (exports.ObjectReferenceType = ObjectReferenceType = {}));

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

@@ -14,10 +14,20 @@ export interface SearchSortOption<T> {
     field: SortableField<T>;
     order: 'asc' | 'desc';
 }
+export interface SearchMatchReason {
+    field: string;
+    content: SearchMatchReasonContentPart[];
+}
+export interface SearchMatchReasonContentPart {
+    text: string;
+    isHighlighted: boolean;
+}
 export interface SearchResult<T extends {
     id?: string;
 } = any, K extends keyof T & string = keyof T & string> {
-    docs: Pick<T, K | 'id'>[];
+    docs: (Pick<T, K | 'id'> & {
+        matchReason?: SearchMatchReason[];
+    })[];
     limit: number;
     offset: number;
     total: number;

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

@@ -1,8 +1,8 @@
 import { APIBaseMock } from '.';
-import type { SearchOptions, SearchResult, TokenOption } from '../interfaces';
+import type { ResourceType, SearchOptions, SearchResult, TokenOption } from '../interfaces';
 import { SearchService } from '../services';
 export declare class SearchMockService extends APIBaseMock<never> implements SearchService {
     search<T extends {
         id?: string;
-    }, K extends keyof T & string = keyof T & string>(query: SearchOptions<T, K>, tokenOption?: TokenOption): Promise<SearchResult<T, K>>;
+    }, K extends keyof T & string = keyof T & string>(options: SearchOptions<T, K>, targetResourceTypes?: ResourceType[], tokenOption?: TokenOption): Promise<SearchResult<T, K>>;
 }

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchMockService = void 0;
 const _1 = require(".");
 class SearchMockService extends _1.APIBaseMock {
-    search(query, tokenOption = {}) {
+    search(options, targetResourceTypes = [], tokenOption = {}) {
         throw new Error('Method not implemented.');
     }
 }

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

@@ -15,6 +15,7 @@ export declare class TaskMockService extends BaseService implements TaskService
     findByName(name: string, options?: any): Promise<Paginated<Task>>;
     findByAsset(assetId: string, options?: any): Promise<Paginated<Task>>;
     getLogbookEntries(taskId: string, limit?: number, offset?: number, _options?: TokenOption): Promise<Paginated<LogbookEntry>>;
+    getLogbookEntriesByIds(ids: string[], _options?: TokenOption): Promise<LogbookEntry[]>;
     addLogbookEntry(taskId: string, dto: LogbookEntryDto, _options?: TokenOption): Promise<LogbookEntry>;
     updateLogbookEntry(taskId: string, entryId: string, dto: Partial<LogbookEntryDto>, _options?: TokenOption): Promise<LogbookEntry>;
     deleteLogbookEntry(taskId: string, entryId: string, _options?: TokenOption): Promise<{

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

@@ -67,6 +67,10 @@ class TaskMockService extends BaseService {
             pages: Math.max(1, Math.ceil(taskEntries.length / limit)),
         };
     }
+    getLogbookEntriesByIds(ids, _options = {}) {
+        const entries = this.entries.filter((e) => ids.includes(e.id));
+        return Promise.resolve(entries);
+    }
     async addLogbookEntry(taskId, dto, _options = {}) {
         const id = globalThis.crypto?.randomUUID?.() || Math.random().toString(36).slice(2);
         const now = new Date().toISOString();

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

@@ -1,9 +1,9 @@
 import { HttpClientService } from '.';
 import { APIBase } from '../api-base';
-import type { SearchOptions, SearchResult, TokenOption } from '../interfaces';
+import type { ResourceType, SearchOptions, SearchResult, TokenOption } from '../interfaces';
 export declare class SearchService extends APIBase {
     constructor(httpClient: HttpClientService);
     search<T extends {
         id?: string;
-    }, K extends keyof T & string = keyof T & string>(query: SearchOptions<T, K>, tokenOption?: TokenOption): Promise<SearchResult<T, K>>;
+    }, K extends keyof T & string = keyof T & string>(options: SearchOptions<T, K>, targetResourceTypes?: ResourceType[], tokenOption?: TokenOption): Promise<SearchResult<T, K>>;
 }

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

@@ -6,8 +6,8 @@ class SearchService extends api_base_1.APIBase {
     constructor(httpClient) {
         super(httpClient, '/search');
     }
-    search(query, tokenOption = {}) {
-        return this.httpClient.post(this.basePath, query, tokenOption);
+    search(options, targetResourceTypes = [], tokenOption = {}) {
+        return this.httpClient.post(this.basePath, { options, targetResourceTypes }, tokenOption);
     }
 }
 exports.SearchService = SearchService;

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

@@ -12,6 +12,7 @@ export declare class TaskService extends BaseService {
     findByName(name: string, options?: TokenOption): Promise<Paginated<Task>>;
     findByAsset(assetId: string, options?: TokenOption): Promise<Paginated<Task>>;
     getLogbookEntries(taskId: string, limit?: number, offset?: number, options?: TokenOption): Promise<Paginated<LogbookEntry>>;
+    getLogbookEntriesByIds(ids: string[], options?: TokenOption): Promise<LogbookEntry[]>;
     addLogbookEntry(taskId: string, entry: LogbookEntryDto, options?: TokenOption): Promise<LogbookEntry>;
     updateLogbookEntry(taskId: string, entryId: string, entry: Partial<LogbookEntryDto>, options?: TokenOption): Promise<LogbookEntry>;
     deleteLogbookEntry(taskId: string, entryId: string, options?: TokenOption): Promise<{

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

@@ -21,10 +21,10 @@ class TaskService extends BaseService {
         return this.httpClient.post(this.basePath, dto, options);
     }
     findByName(name, options = {}) {
-        return this.httpClient.get(`${this.basePath}?name=${encodeURIComponent(name)}`, options);
+        return this.httpClient.get(`${this.basePath}`, { ...options, params: { filter: `name==${name}` } });
     }
     findByAsset(assetId, options = {}) {
-        return this.httpClient.get(`${this.basePath}?assetRef=${assetId}`, options);
+        return this.httpClient.get(`${this.basePath}`, { ...options, params: { filter: `assetRef==${assetId}` } });
     }
     getLogbookEntries(taskId, limit = 50, offset = 0, options = {}) {
         return this.httpClient.get(`${this.basePath}/${taskId}/logbook`, {
@@ -32,6 +32,14 @@ class TaskService extends BaseService {
             params: { limit: String(limit), offset: String(offset) },
         });
     }
+    getLogbookEntriesByIds(ids, options = {}) {
+        return this.httpClient.get(`${this.basePath}/logbook`, {
+            ...options,
+            params: {
+                ids: ids.join(','),
+            },
+        });
+    }
     addLogbookEntry(taskId, entry, options = {}) {
         return this.httpClient.post(`${this.basePath}/${taskId}/logbook`, entry, options);
     }