@hahnpro/hpc-api 2026.9.10 → 2026.9.12

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @hahnpro/hpc-api
 
+# 2026.9.12
+
+- Added permission verification support for object references, including reference-check endpoints for resources, AI threads, and user messages
+- Added the `PermissionLevel` enum
+- Added pagination and sorting parameters to object-reference queries
+
+# 2026.9.11
+
+- Added `api.knowledge` client, shared types and mock support for pages, revisions, discovery and lifecycle operations #5262
+
 # 2026.9.10
 
 - Updated AI interface and added limit to `getValuesOfPeriod` of timeseries service

package/package.json

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

package/src/lib/api.d.ts

@@ -1,6 +1,6 @@
 import type { TimeSeriesValueFeedManagementApi } from './interfaces';
 import { QueueOptions } from './queue';
-import { AiService, AlertService, AssetService, AssetTypesService, AuthzService, ContentService, CrmService, DataspaceService, EndpointService, EventService, FlangeSkillControlService, FlowDeploymentService, FlowFunctionService, FlowModuleService, FlowService, HttpClientService, LabelService, LogbookService, NotificationRuleService, NotificationService, ObjectReferenceService, OrganizationsAdministrationService, OrganizationsResourcesService, OrganizationsService, ProxyService, SearchService, TaskService, TimeSeriesService, UserService, VaultService } from './services';
+import { AiService, AlertService, AssetService, AssetTypesService, AuthzService, ContentService, CrmService, DataspaceService, EndpointService, EventService, FlangeSkillControlService, FlowDeploymentService, FlowFunctionService, FlowModuleService, FlowService, HttpClientService, KnowledgeService, LabelService, LogbookService, NotificationRuleService, NotificationService, ObjectReferenceService, OrganizationsAdministrationService, OrganizationsResourcesService, OrganizationsService, ProxyService, SearchService, TaskService, TimeSeriesService, UserService, VaultService } from './services';
 export declare class API {
     readonly httpClient?: HttpClientService;
     ai: AiService;
@@ -18,6 +18,7 @@ export declare class API {
     flowDeployments: FlowDeploymentService;
     flowFunctions: FlowFunctionService;
     flowModules: FlowModuleService;
+    knowledge: KnowledgeService;
     labels: LabelService;
     logbook: LogbookService;
     objectReferences: ObjectReferenceService;

package/src/lib/api.js

@@ -49,6 +49,7 @@ class API {
         this.flowDeployments = new services_1.FlowDeploymentService(this.httpClient);
         this.flowFunctions = new services_1.FlowFunctionService(this.httpClient);
         this.flowModules = new services_1.FlowModuleService(this.httpClient);
+        this.knowledge = new services_1.KnowledgeService(this.httpClient);
         this.labels = new services_1.LabelService(this.httpClient);
         this.logbook = new services_1.LogbookService(this.httpClient);
         this.objectReferences = new services_1.ObjectReferenceService(this.httpClient);

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

@@ -66,7 +66,7 @@ export { NatsConsumers, natsFlowsPrefix, natsHpcPrefix, NatsStreams } from './na
 export { NotificationRuleStatus } from './notification-rule.interface';
 export { OrganizationMembersInviteOrAdd } from './organization.interface';
 export { OwnerType } from './owner.interface';
-export { ObjectReferenceType } from './reference.interface';
+export { ObjectReferenceType, PermissionLevel } from './reference.interface';
 export { arePopulated, CommandType, EventType, isPopulated, PermissionType, ResourceApiPath, resourceApiPathToTypeMap, ResourceType, } from './resource.interface';
 export { ACTIVE_TASK_STATUSES, AssigneeType, buildTaskStatusFilter, INACTIVE_TASK_STATUSES, Priority, TaskStatus } from './task.interface';
 export { RETENTION_VALUES } from './timeseries.interface';
@@ -77,3 +77,4 @@ export { WebSocketMessageType } from './websockets.interface';
 export type { AiThreadListChangedEvent, WebSocketError } from './websockets.interface';
 export * from './authz';
 export * from './crm-autonomy.interface';
+export * from './knowledge.interface';

package/src/lib/interfaces/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowDiagram = exports.Flow = exports.NATS_FLOW_TRIGGER_STATUSES = exports.FlowDeployment = exports.UNKOWN_STATES = exports.STOPPED_STATES = exports.RUNNING_STATES = exports.PROCESSING_STATES = exports.FlowDeploymentStatus = exports.ERROR_STATES = exports.TimeSlotStatus = exports.APPLICATION_AREA = exports.eventLevels = exports.EventLevelOverrideWrapper = exports.EventLevel = exports.NotificationEndpointType = exports.NotificationEndpointStatus = exports.NotificationEndpointSpamProtection = exports.DataspaceWorkflowType = exports.DataspaceAllowedResourceTypes = exports.instanceOfTimePeriod = exports.ReturnType = exports.IndexingStatus = exports.ContentAnalysisStatus = exports.BillingResourceType = exports.ChangeAction = exports.DEFAULT_THRESHOLD_CONDITION = exports.DEFAULT_RELATIVE_CONDITION = exports.DEFAULT_DEADMAN_CONDITION = exports.AlertType = exports.AlertStatus = exports.AlertLevel = exports.ToolType = exports.ToolName = exports.ToolMessageStatus = exports.Role = exports.ReturnToReferrerTool = exports.ReferenceType = exports.OneShotTaskId = exports.HandOffTool = exports.FinishReason = exports.ErrorMessageType = exports.AvailableLanguages = exports.AttachmentHandlingMode = exports.ATTACHMENT_CAPABLE_AGENT_IDS = exports.AssistantMessageStatus = exports.AiAssistantId = exports.AgentId = exports.MAX_TIME_SERIES_PER_VALUE_FEED = exports.LogbookEntrySource = void 0;
-exports.WebSocketMessageType = exports.SecretType = exports.isUserMessage = exports.isTask = exports.isStorage = exports.isOwner = exports.isLogbookEntry = exports.isEvent = exports.isContentAnalysis = exports.isContent = exports.isAuthor = exports.isAssignee = exports.isAsset = exports.TranslationEditData = exports.RETENTION_VALUES = exports.TaskStatus = exports.Priority = exports.INACTIVE_TASK_STATUSES = exports.buildTaskStatusFilter = exports.AssigneeType = exports.ACTIVE_TASK_STATUSES = exports.ResourceType = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.PermissionType = exports.isPopulated = exports.EventType = exports.CommandType = exports.arePopulated = exports.ObjectReferenceType = exports.OwnerType = exports.OrganizationMembersInviteOrAdd = exports.NotificationRuleStatus = exports.NatsStreams = exports.natsHpcPrefix = exports.natsFlowsPrefix = exports.NatsConsumers = exports.SubscriptionType = exports.LABEL_COLORS = void 0;
+exports.WebSocketMessageType = exports.SecretType = exports.isUserMessage = exports.isTask = exports.isStorage = exports.isOwner = exports.isLogbookEntry = exports.isEvent = exports.isContentAnalysis = exports.isContent = exports.isAuthor = exports.isAssignee = exports.isAsset = exports.TranslationEditData = exports.RETENTION_VALUES = exports.TaskStatus = exports.Priority = exports.INACTIVE_TASK_STATUSES = exports.buildTaskStatusFilter = exports.AssigneeType = exports.ACTIVE_TASK_STATUSES = exports.ResourceType = exports.resourceApiPathToTypeMap = exports.ResourceApiPath = exports.PermissionType = exports.isPopulated = exports.EventType = exports.CommandType = exports.arePopulated = exports.PermissionLevel = exports.ObjectReferenceType = exports.OwnerType = exports.OrganizationMembersInviteOrAdd = exports.NotificationRuleStatus = exports.NatsStreams = exports.natsHpcPrefix = exports.natsFlowsPrefix = exports.NatsConsumers = exports.SubscriptionType = exports.LABEL_COLORS = void 0;
 const tslib_1 = require("tslib");
 var logbook_interface_1 = require("./logbook.interface");
 Object.defineProperty(exports, "LogbookEntrySource", { enumerable: true, get: function () { return logbook_interface_1.LogbookEntrySource; } });
@@ -85,6 +85,7 @@ var owner_interface_1 = require("./owner.interface");
 Object.defineProperty(exports, "OwnerType", { enumerable: true, get: function () { return owner_interface_1.OwnerType; } });
 var reference_interface_1 = require("./reference.interface");
 Object.defineProperty(exports, "ObjectReferenceType", { enumerable: true, get: function () { return reference_interface_1.ObjectReferenceType; } });
+Object.defineProperty(exports, "PermissionLevel", { enumerable: true, get: function () { return reference_interface_1.PermissionLevel; } });
 var resource_interface_1 = require("./resource.interface");
 Object.defineProperty(exports, "arePopulated", { enumerable: true, get: function () { return resource_interface_1.arePopulated; } });
 Object.defineProperty(exports, "CommandType", { enumerable: true, get: function () { return resource_interface_1.CommandType; } });
@@ -123,3 +124,4 @@ var websockets_interface_1 = require("./websockets.interface");
 Object.defineProperty(exports, "WebSocketMessageType", { enumerable: true, get: function () { return websockets_interface_1.WebSocketMessageType; } });
 tslib_1.__exportStar(require("./authz"), exports);
 tslib_1.__exportStar(require("./crm-autonomy.interface"), exports);
+tslib_1.__exportStar(require("./knowledge.interface"), exports);

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

@@ -0,0 +1,142 @@
+import type { Author } from './author.interface';
+import type { Owner } from './owner.interface';
+import { ResourceType } from './resource.interface';
+export declare const KNOWLEDGE_TARGET_TYPES: readonly [ResourceType.KNOWLEDGE, ResourceType.ASSET, ResourceType.ASSETTYPE, ResourceType.CONTENT, ResourceType.EVENT, ResourceType.TASK];
+export interface KnowledgeTarget {
+    resourceType: (typeof KNOWLEDGE_TARGET_TYPES)[number];
+    id: string;
+}
+export interface KnowledgeSource {
+    id: string;
+    kind: 'observation' | 'resource' | 'external';
+    target?: KnowledgeTarget;
+    text?: string;
+    url?: string;
+    version?: string;
+    locator?: string;
+    /** False means the target was not readable at response time. */
+    available?: boolean;
+}
+export interface KnowledgeLink {
+    target: KnowledgeTarget;
+    explicit: boolean;
+    parsed: boolean;
+}
+export type KnowledgeApplicability = {
+    mode: 'unknown' | 'organization';
+} | {
+    mode: 'assets';
+    assetIds: string[];
+} | {
+    mode: 'subtree';
+    rootId: string;
+    assetTypeId?: string;
+} | {
+    mode: 'assetType';
+    assetTypeId: string;
+};
+export interface KnowledgeConfirmation {
+    actor: Author;
+    at: string;
+    revision: number;
+}
+export interface KnowledgePage {
+    id: string;
+    owner: Owner;
+    title: string;
+    body: string;
+    type: string;
+    description?: string;
+    tags: string[];
+    resource?: KnowledgeTarget;
+    origin: {
+        actor: Author;
+        at: string;
+        context?: KnowledgeTarget;
+    };
+    sources: KnowledgeSource[];
+    links: KnowledgeLink[];
+    applicability: KnowledgeApplicability;
+    readPermissions: string[];
+    readWritePermissions: string[];
+    state: 'active' | 'withdrawn';
+    staleAfter?: string;
+    confirmations: KnowledgeConfirmation[];
+    revision: number;
+    recordVersion: number;
+    createdBy: Author;
+    updatedBy: Author;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string;
+}
+export interface CreateKnowledge {
+    title: string;
+    body: string;
+    type?: string;
+    description?: string;
+    tags?: string[];
+    /** `null` clears the value on update. */
+    resource?: KnowledgeTarget | null;
+    /** `null` clears the value on update. */
+    originContext?: KnowledgeTarget | null;
+    sources?: Omit<KnowledgeSource, 'available'>[];
+    explicitLinks?: KnowledgeTarget[];
+    applicability?: KnowledgeApplicability;
+    readPermissions?: string[];
+    readWritePermissions?: string[];
+    staleAfter?: string | null;
+}
+export type UpdateKnowledge = Partial<CreateKnowledge> & {
+    recordVersion: number;
+};
+export interface KnowledgeVersion {
+    recordVersion: number;
+}
+export interface ConfirmKnowledge extends KnowledgeVersion {
+    revision: number;
+}
+export type KnowledgeRelation = 'OBSERVED_IN' | 'EVIDENCED_BY' | 'RELATED_TO' | 'APPLIES_TO';
+export type KnowledgeScopeResult = 'matches' | 'not-established' | 'not-evaluated';
+export interface KnowledgeQuery {
+    group?: 'direct' | 'broader' | 'related';
+    query?: string;
+    contextType?: 'asset' | 'location' | 'organization';
+    contextId?: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface KnowledgeBacklinkQuery {
+    targetType: KnowledgeTarget['resourceType'];
+    targetId: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface KnowledgePreview extends Omit<KnowledgePage, 'body'> {
+    excerpt: string;
+    scope: KnowledgeScopeResult;
+    relations: KnowledgeRelation[];
+    stale: boolean;
+}
+export interface KnowledgeList {
+    docs: KnowledgePreview[];
+    nextCursor?: string;
+    status: 'complete' | 'more' | 'incomplete' | 'unavailable';
+}
+export interface KnowledgeHome {
+    direct: KnowledgeList;
+    broader: KnowledgeList;
+    related: KnowledgeList;
+}
+export interface KnowledgeBatch {
+    docs: KnowledgePage[];
+    unavailableIds: string[];
+}
+export interface KnowledgeRevision {
+    page: KnowledgePage;
+    current: {
+        revision: number;
+        recordVersion: number;
+        state: KnowledgePage['state'];
+    };
+}

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KNOWLEDGE_TARGET_TYPES = void 0;
+const resource_interface_1 = require("./resource.interface");
+exports.KNOWLEDGE_TARGET_TYPES = [
+    resource_interface_1.ResourceType.KNOWLEDGE,
+    resource_interface_1.ResourceType.ASSET,
+    resource_interface_1.ResourceType.ASSETTYPE,
+    resource_interface_1.ResourceType.CONTENT,
+    resource_interface_1.ResourceType.EVENT,
+    resource_interface_1.ResourceType.TASK,
+];

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

@@ -1,3 +1,9 @@
+import { ResourceType } from './resource.interface';
+export declare enum PermissionLevel {
+    READ = "read",
+    WRITE = "write",
+    NONE = "none"
+}
 export declare enum ObjectReferenceType {
     /**
      * Used for testing purposes to simulate references between objects.
@@ -30,9 +36,9 @@ export interface ObjectReference {
     id: number;
     src: string;
     tgt: string;
-    srcType: string;
-    tgtType: string;
-    relType: string;
+    srcType: ResourceType;
+    tgtType: ResourceType;
+    relType: ObjectReferenceType;
     createdAt: number;
     updatedAt: number;
     createdBy: string;
@@ -48,21 +54,10 @@ export interface ObjectReference {
 export interface CreateReferenceDto {
     srcId: string;
     tgtId: string;
-    srcType: string;
-    tgtType: string;
+    srcType: ResourceType;
+    tgtType: ResourceType;
     relSrc: string;
     relType: ObjectReferenceType;
-    displayData: {
-        src?: Record<string, unknown>;
-        tgt?: Record<string, unknown>;
-        [key: string]: unknown;
-    };
-    tgtDeleted?: boolean;
-    orgId?: string;
-    srcReadPermissions?: string[];
-    srcReadWritePermissions?: string[];
-    tgtReadPermissions?: string[];
-    tgtReadWritePermissions?: string[];
 }
 export interface ReferencesQuery {
     objId: string;

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

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectReferenceType = void 0;
+exports.ObjectReferenceType = exports.PermissionLevel = void 0;
+var PermissionLevel;
+(function (PermissionLevel) {
+    PermissionLevel["READ"] = "read";
+    PermissionLevel["WRITE"] = "write";
+    PermissionLevel["NONE"] = "none";
+})(PermissionLevel || (exports.PermissionLevel = PermissionLevel = {}));
 var ObjectReferenceType;
 (function (ObjectReferenceType) {
     /**

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

@@ -11,6 +11,7 @@ export declare enum ResourceType {
     FLOWDEPLOYMENT = "flowdeployment",
     FLOWFUNCTION = "flowfunction",
     FLOWMODULE = "flowmodule",
+    KNOWLEDGE = "knowledge",
     LABEL = "label",
     LOGBOOKENTRY = "logbookentry",
     NOTIFICATIONENDPOINT = "notificationendpoint",
@@ -33,12 +34,16 @@ export declare enum ResourceApiPath {
     FLOWDEPLOYMENT = "flow/deployments",
     FLOWFUNCTION = "flow/functions",
     FLOWMODULE = "flow/modules",
+    KNOWLEDGE = "knowledge",
     LABEL = "labels",
+    LOGBOOKENTRY = "tasks/logbook",
     NOTIFICATIONENDPOINT = "notification/endpoints",
     NOTIFICATIONRULE = "notification/rules",
     SECRET = "vault/secrets",
     TIMESERIES = "tsm",
-    TASK = "tasks"
+    TASK = "tasks",
+    THREAD = "ai/threads",
+    USERMESSAGE = "ai/messages"
 }
 export declare const resourceApiPathToTypeMap: Record<ResourceApiPath, ResourceType>;
 export declare enum EventType {

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

@@ -14,6 +14,7 @@ var ResourceType;
     ResourceType["FLOWDEPLOYMENT"] = "flowdeployment";
     ResourceType["FLOWFUNCTION"] = "flowfunction";
     ResourceType["FLOWMODULE"] = "flowmodule";
+    ResourceType["KNOWLEDGE"] = "knowledge";
     ResourceType["LABEL"] = "label";
     ResourceType["LOGBOOKENTRY"] = "logbookentry";
     ResourceType["NOTIFICATIONENDPOINT"] = "notificationendpoint";
@@ -37,12 +38,16 @@ var ResourceApiPath;
     ResourceApiPath["FLOWDEPLOYMENT"] = "flow/deployments";
     ResourceApiPath["FLOWFUNCTION"] = "flow/functions";
     ResourceApiPath["FLOWMODULE"] = "flow/modules";
+    ResourceApiPath["KNOWLEDGE"] = "knowledge";
     ResourceApiPath["LABEL"] = "labels";
+    ResourceApiPath["LOGBOOKENTRY"] = "tasks/logbook";
     ResourceApiPath["NOTIFICATIONENDPOINT"] = "notification/endpoints";
     ResourceApiPath["NOTIFICATIONRULE"] = "notification/rules";
     ResourceApiPath["SECRET"] = "vault/secrets";
     ResourceApiPath["TIMESERIES"] = "tsm";
     ResourceApiPath["TASK"] = "tasks";
+    ResourceApiPath["THREAD"] = "ai/threads";
+    ResourceApiPath["USERMESSAGE"] = "ai/messages";
 })(ResourceApiPath || (exports.ResourceApiPath = ResourceApiPath = {}));
 exports.resourceApiPathToTypeMap = {
     [ResourceApiPath.ALERT]: ResourceType.ALERT,
@@ -54,12 +59,16 @@ exports.resourceApiPathToTypeMap = {
     [ResourceApiPath.FLOWDEPLOYMENT]: ResourceType.FLOWDEPLOYMENT,
     [ResourceApiPath.FLOWFUNCTION]: ResourceType.FLOWFUNCTION,
     [ResourceApiPath.FLOWMODULE]: ResourceType.FLOWMODULE,
+    [ResourceApiPath.KNOWLEDGE]: ResourceType.KNOWLEDGE,
     [ResourceApiPath.LABEL]: ResourceType.LABEL,
+    [ResourceApiPath.LOGBOOKENTRY]: ResourceType.LOGBOOKENTRY,
     [ResourceApiPath.NOTIFICATIONENDPOINT]: ResourceType.NOTIFICATIONENDPOINT,
     [ResourceApiPath.NOTIFICATIONRULE]: ResourceType.NOTIFICATIONRULE,
     [ResourceApiPath.SECRET]: ResourceType.SECRET,
     [ResourceApiPath.TIMESERIES]: ResourceType.TIMESERIES,
     [ResourceApiPath.TASK]: ResourceType.TASK,
+    [ResourceApiPath.THREAD]: ResourceType.THREAD,
+    [ResourceApiPath.USERMESSAGE]: ResourceType.USERMESSAGE,
 };
 var EventType;
 (function (EventType) {

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

@@ -1,4 +1,4 @@
-import { AiAssistant, AiSkill, AiSkillSummary, AudioTranscription, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, Thread, ThreadPopulated, TokenOption } from '../interfaces';
+import { AiAssistant, AiSkill, AiSkillSummary, AudioTranscription, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, PermissionLevel, Thread, ThreadPopulated, TokenOption } from '../interfaces';
 import { AiService } from '../services';
 import type { CrossPlatformFormData } from '../utils';
 import { APIBaseMock } from './api-base.mock';
@@ -18,6 +18,8 @@ export declare class AiMockService extends APIBaseMock<never> implements AiServi
     replaceSkill(_id: string, _form: CrossPlatformFormData, _options?: Config): Promise<AiSkill>;
     getThreadMessages(threadId: string): Promise<Paginated<Message>>;
     getThread(threadId: string): Promise<ThreadPopulated>;
+    getThreadReferenceCheck(threadId: string, _permissionLevel?: PermissionLevel, _options?: Config): Promise<ThreadPopulated>;
+    getUserMessageReferenceCheck(messageId: string, _permissionLevel?: PermissionLevel, _options?: Config): Promise<Message>;
     getLatestThread(): Promise<ThreadPopulated>;
     listThreads(): Promise<ThreadPopulated[]>;
     listAssistantThreads(assistantId: string): Promise<ThreadPopulated[]>;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AiMockService = void 0;
+const interfaces_1 = require("../interfaces");
 const api_base_mock_1 = require("./api-base.mock");
 class AiMockService extends api_base_mock_1.APIBaseMock {
     constructor() {
@@ -48,6 +49,12 @@ class AiMockService extends api_base_mock_1.APIBaseMock {
     getThread(threadId) {
         throw new Error('Method not implemented.');
     }
+    getThreadReferenceCheck(threadId, _permissionLevel = interfaces_1.PermissionLevel.READ, _options = {}) {
+        throw new Error('Method not implemented.');
+    }
+    getUserMessageReferenceCheck(messageId, _permissionLevel = interfaces_1.PermissionLevel.READ, _options = {}) {
+        throw new Error('Method not implemented.');
+    }
     getLatestThread() {
         throw new Error('Method not implemented.');
     }

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

@@ -1,5 +1,5 @@
 import { API } from '../api';
-import { Artifact, Asset, AssetRevision, AssetType, Content, Endpoint, Event, FlowDeployment, FlowDiagram, FlowDto, FlowFunctionDto, FlowFunctionRevision, FlowModule, FlowRevision, Label, LogbookEntry, Notification, ObjectReference, Organization, Secret, Task, TimeSeries, TimeSeriesValue, TimeSeriesValueFeed, Translation, UserSettings, VaultSecret } from '../interfaces';
+import { Artifact, Asset, AssetRevision, AssetType, Content, Endpoint, Event, FlowDeployment, FlowDiagram, FlowDto, FlowFunctionDto, FlowFunctionRevision, FlowModule, FlowRevision, Label, LogbookEntry, Notification, ObjectReference, Organization, Secret, Task, TimeSeries, TimeSeriesValue, TimeSeriesValueFeed, Translation, UserSettings, VaultSecret, type KnowledgePage } from '../interfaces';
 import { AiMockService } from './ai.mock.service';
 import { AlertMockService } from './alert.mock.service';
 import { AssetMockService } from './asset.mock.service';
@@ -16,6 +16,7 @@ import { FlowFunctionsMockService } from './flow-functions.mock.service';
 import { FlowModulesMockService } from './flow-modules.mock.service';
 import { FlowMockService } from './flow.mock.service';
 import { HttpClientMockService } from './http-client.mock.service';
+import { KnowledgeMockService } from './knowledge.mock.service';
 import { LabelMockService } from './label.mock.service';
 import { LogbookMockService } from './logbook.mock.service';
 import { NotificationRulesMockService } from './notification-rules.mock.service';
@@ -31,6 +32,7 @@ import { TimeseriesMockService } from './timeseries.mock.service';
 import { UserMockService } from './user.mock.service';
 import { VaultMockService } from './vault.mock.service';
 export interface MockAPIInitData {
+    knowledge?: KnowledgePage[];
     assets?: AssetInit[];
     assetRevisions?: AssetRevisionInit[];
     contents?: ContentInit[];
@@ -58,6 +60,7 @@ export interface MockAPIInitData {
     translations?: TranslationInit[];
 }
 export declare class MockAPI implements API {
+    knowledge: KnowledgeMockService;
     ai: AiMockService;
     alerts: AlertMockService;
     assets: AssetMockService;

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

@@ -18,6 +18,7 @@ const flow_functions_mock_service_1 = require("./flow-functions.mock.service");
 const flow_modules_mock_service_1 = require("./flow-modules.mock.service");
 const flow_mock_service_1 = require("./flow.mock.service");
 const http_client_mock_service_1 = require("./http-client.mock.service");
+const knowledge_mock_service_1 = require("./knowledge.mock.service");
 const label_mock_service_1 = require("./label.mock.service");
 const logbook_mock_service_1 = require("./logbook.mock.service");
 const notification_rules_mock_service_1 = require("./notification-rules.mock.service");
@@ -35,6 +36,7 @@ const vault_mock_service_1 = require("./vault.mock.service");
 class MockAPI {
     constructor(initData) {
         this.proxy = null;
+        this.knowledge = new knowledge_mock_service_1.KnowledgeMockService(initData.knowledge);
         const { assets = [], assetRevisions = [], contents = [], endpoints = [], secrets = [], timeSeries = [], tasks = [], events = [], users, flows = [], flowRevisions = [], deployments = [], functions = [], functionRevisions = [], modules = [], diagrams = [], labels = [], logbookEntries = [], vault = [], notifications = [], organizations = [], objectReferences = [], timeSeriesValueFeeds = [], resourceSetNames = [], translations = [], } = initData;
         // convert init data to normal data that the services usually use
         const assetTypes = assets

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

@@ -1,4 +1,4 @@
-import { AddToProperty, Asset, AssetRevision, Attachment, DeleteQuery, EventCause, EventLevelOverride, Filter, Paginated, RemoveFromProperty, RequestParameter, SearchResultItem, TokenOption, Translation } from '../interfaces';
+import { AddToProperty, Asset, AssetRevision, Attachment, Config, DeleteQuery, EventCause, EventLevelOverride, Filter, Paginated, PermissionLevel, RemoveFromProperty, RequestParameter, SearchResultItem, TokenOption, Translation } from '../interfaces';
 import { AssetService } from '../services';
 import { CrossPlatformFormData } from '../utils';
 import type { MockAPI } from './api.mock';
@@ -19,6 +19,7 @@ export declare class AssetMockService extends BaseService implements AssetServic
     constructor(api: MockAPI, assets: Asset[], revisions: AssetRevision[], translations?: Array<Translation & {
         id: string;
     }>);
+    getReferenceCheck(id: string, _permissionLevel: PermissionLevel, _options?: Config): Promise<Asset>;
     addElementToProperty(id: string, dto: AddToProperty): Promise<Asset>;
     removeElementFromProperty(id: string, dto: RemoveFromProperty): Promise<Asset>;
     private getAssets;

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

@@ -14,6 +14,9 @@ class AssetMockService extends BaseService {
         this.revisions = revisions;
         this.translations = translations;
     }
+    getReferenceCheck(id, _permissionLevel, _options = {}) {
+        return this.getOne(id);
+    }
     addElementToProperty(id, dto) {
         throw new Error('Method not implemented.');
     }

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

@@ -1,4 +1,4 @@
-import { Content, DeleteQuery, Paginated, RequestParameter, ReturnType } from '../interfaces';
+import { Config, Content, DeleteQuery, Paginated, PermissionLevel, RequestParameter, ReturnType } from '../interfaces';
 import { ContentService } from '../services';
 import { CrossPlatformFormData } from '../utils';
 import { DataMockService } from './data.mock.service';
@@ -14,6 +14,7 @@ declare class BaseService extends BaseService_base {
 export declare class ContentMockService extends BaseService implements ContentService {
     private contentData;
     constructor(contents: Content[], contentData: any[]);
+    getReferenceCheck(id: string, _permissionLevel: PermissionLevel, _options?: Config): Promise<Content>;
     download(id: string, raw?: boolean, options?: any): Promise<Blob | ArrayBuffer>;
     download(id: string, returnType: ReturnType.TEXT, options?: any): Promise<string>;
     download(id: string, returnType: ReturnType.JSON, options?: any): Promise<Record<string, unknown>>;

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

@@ -16,6 +16,9 @@ class ContentMockService extends BaseService {
             this.contentData.set(contents[i].id, contentData[i]);
         }
     }
+    getReferenceCheck(id, _permissionLevel, _options = {}) {
+        return this.getOne(id);
+    }
     download(id, second, options = {}) {
         let returnType;
         if (typeof second === 'boolean' || second == null) {

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

@@ -1,4 +1,4 @@
-import { Event, EventCountByAsset } from '../interfaces';
+import { Config, Event, EventCountByAsset, PermissionLevel } from '../interfaces';
 import { EventService } from '../services';
 import { DataMockService } from './data.mock.service';
 import { ShareMockService } from './share.mock.service';
@@ -9,6 +9,7 @@ declare class BaseService extends BaseService_base {
 }
 export declare class EventMockService extends BaseService implements EventService {
     constructor(events: Event[]);
+    getReferenceCheck(id: string, _permissionLevel: PermissionLevel, _options?: Config): Promise<Event>;
     getEventCountByAsset(assetId: string): Promise<EventCountByAsset>;
     getLastEventByAssetAndGroup(assetId: string, group: string): Promise<Event>;
     getLastEventByAssetAndGroups(assetId: string, groups: string[]): Promise<Record<string, string>>;

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

@@ -12,6 +12,9 @@ class EventMockService extends BaseService {
         super();
         this.data = events;
     }
+    getReferenceCheck(id, _permissionLevel, _options = {}) {
+        return this.getOne(id);
+    }
     getEventCountByAsset(assetId) {
         const events = this.data.filter((event) => event.assetRef === assetId);
         const critical = events.filter((event) => event.level === interfaces_1.EventLevel.Critical).length;

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

@@ -34,3 +34,4 @@ export { UserMockService } from './user.mock.service';
 export { VaultMockService } from './vault.mock.service';
 export { TimeseriesValueFeedManagementMockService } from './timeseries-value-feed-management.mock.service';
 export * from './authz';
+export * from './knowledge.mock.service';

package/src/lib/mock/index.js

@@ -72,3 +72,4 @@ Object.defineProperty(exports, "VaultMockService", { enumerable: true, get: func
 var timeseries_value_feed_management_mock_service_1 = require("./timeseries-value-feed-management.mock.service");
 Object.defineProperty(exports, "TimeseriesValueFeedManagementMockService", { enumerable: true, get: function () { return timeseries_value_feed_management_mock_service_1.TimeseriesValueFeedManagementMockService; } });
 tslib_1.__exportStar(require("./authz"), exports);
+tslib_1.__exportStar(require("./knowledge.mock.service"), exports);

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

@@ -0,0 +1,28 @@
+import { type ConfirmKnowledge, type CreateKnowledge, type KnowledgeBacklinkQuery, type KnowledgeBatch, type KnowledgeHome, type KnowledgeList, type KnowledgePage, type KnowledgeQuery, type KnowledgeRevision, type KnowledgeVersion, type UpdateKnowledge } from '../interfaces';
+import { KnowledgeService } from '../services/knowledge.service';
+export declare class KnowledgeMockService extends KnowledgeService {
+    data: KnowledgePage[];
+    private readonly revisions;
+    constructor(data?: KnowledgePage[]);
+    private remember;
+    /** As in the backend, only changes to these fields create a revision. */
+    private content;
+    private page;
+    private list;
+    addOne(dto: CreateKnowledge): Promise<KnowledgePage>;
+    getOne(id: string): Promise<KnowledgePage>;
+    getMany(query?: KnowledgeQuery): Promise<KnowledgeList>;
+    getHome(query?: KnowledgeQuery): Promise<KnowledgeHome>;
+    getBacklinks(query: KnowledgeBacklinkQuery): Promise<KnowledgeList>;
+    getRelated(id: string, query?: Pick<KnowledgeQuery, 'cursor' | 'limit'>): Promise<KnowledgeList>;
+    getRevision(id: string, revision: number): Promise<KnowledgeRevision>;
+    readBatch(ids: string[]): Promise<KnowledgeBatch>;
+    private check;
+    updateOne(id: string, dto: UpdateKnowledge): Promise<KnowledgePage>;
+    confirm(id: string, dto: ConfirmKnowledge): Promise<KnowledgePage>;
+    withdraw(id: string, dto: KnowledgeVersion): Promise<KnowledgePage>;
+    restore(id: string, dto: KnowledgeVersion): Promise<KnowledgePage>;
+    purgeOrganization(organizationId: string): Promise<{
+        deleted: number;
+    }>;
+}

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

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeMockService = void 0;
+const interfaces_1 = require("../interfaces");
+const knowledge_service_1 = require("../services/knowledge.service");
+class KnowledgeMockService extends knowledge_service_1.KnowledgeService {
+    constructor(data = []) {
+        super(null);
+        this.data = data;
+        this.revisions = new Map();
+        this.data = structuredClone(data);
+        this.data.forEach((page) => this.remember(page));
+    }
+    remember(page) {
+        this.revisions.set(`${page.id}:${page.revision}`, structuredClone(page));
+    }
+    /** As in the backend, only changes to these fields create a revision. */
+    content(page) {
+        const { title, body, type, description, tags, resource, sources, applicability, links, origin } = page;
+        return JSON.stringify({ title, body, type, description, tags, resource, sources, applicability, links, context: origin.context });
+    }
+    page(id) {
+        const page = this.data.find((item) => item.id === id);
+        if (!page) {
+            throw new Error('Knowledge page not found');
+        }
+        return page;
+    }
+    list(pages, query = {}) {
+        const offset = Number(query.cursor || 0);
+        const active = pages.filter((page) => page.state === 'active');
+        const docs = active.slice(offset, offset + (query.limit || 20)).map(({ body, ...page }) => ({
+            ...structuredClone(page),
+            excerpt: body.slice(0, 300),
+            scope: 'not-evaluated',
+            relations: [],
+            stale: !!page.staleAfter && Date.parse(page.staleAfter) <= Date.now(),
+        }));
+        const more = offset + docs.length < active.length;
+        return { docs, status: more ? 'more' : 'complete', ...(more ? { nextCursor: String(offset + docs.length) } : {}) };
+    }
+    async addOne(dto) {
+        const now = new Date().toISOString();
+        const page = {
+            id: Array.from(globalThis.crypto.getRandomValues(new Uint8Array(12)), (byte) => byte.toString(16).padStart(2, '0')).join(''),
+            title: dto.title,
+            body: dto.body,
+            type: dto.type || 'Maintenance Note',
+            description: dto.description,
+            tags: dto.tags || [],
+            owner: { id: 'mock-org', type: interfaces_1.OwnerType.ORG },
+            createdBy: { id: 'mock-user' },
+            updatedBy: { id: 'mock-user' },
+            createdAt: now,
+            updatedAt: now,
+            origin: { actor: { id: 'mock-user' }, at: now, context: dto.originContext ?? undefined },
+            resource: dto.resource ?? undefined,
+            sources: dto.sources || [],
+            links: (dto.explicitLinks || []).map((target) => ({ target, explicit: true, parsed: false })),
+            applicability: dto.applicability || { mode: 'unknown' },
+            readPermissions: dto.readPermissions || [],
+            readWritePermissions: dto.readWritePermissions || ['mock-org'],
+            state: 'active',
+            revision: 1,
+            recordVersion: 1,
+            confirmations: [],
+            staleAfter: dto.staleAfter || undefined,
+        };
+        this.data.push(page);
+        this.remember(page);
+        return structuredClone(page);
+    }
+    async getOne(id) {
+        return structuredClone(this.page(id));
+    }
+    async getMany(query = {}) {
+        const term = query.query?.toLowerCase();
+        return this.list(this.data.filter((page) => !term || `${page.title} ${page.body}`.toLowerCase().includes(term)), query);
+    }
+    async getHome(query = {}) {
+        return { direct: await this.getMany(query), broader: { docs: [], status: 'complete' }, related: { docs: [], status: 'complete' } };
+    }
+    async getBacklinks(query) {
+        return this.list(this.data.filter((page) => [...page.links, ...page.sources].some((item) => item.target?.resourceType === query.targetType && item.target.id === query.targetId)), query);
+    }
+    async getRelated(id, query = {}) {
+        const page = this.page(id);
+        const outgoing = page.links.filter((link) => link.target.resourceType === interfaces_1.ResourceType.KNOWLEDGE).map((link) => link.target.id);
+        return this.list(this.data.filter((item) => item.id !== id &&
+            (outgoing.includes(item.id) ||
+                item.links.some((link) => link.target.resourceType === interfaces_1.ResourceType.KNOWLEDGE && link.target.id === id))), query);
+    }
+    async getRevision(id, revision) {
+        const current = this.page(id);
+        const page = this.revisions.get(`${id}:${revision}`);
+        if (!page) {
+            throw new Error('Revision not found');
+        }
+        return {
+            page: structuredClone(page),
+            current: { revision: current.revision, recordVersion: current.recordVersion, state: current.state },
+        };
+    }
+    async readBatch(ids) {
+        return {
+            docs: structuredClone(this.data.filter((page) => ids.includes(page.id) && page.state === 'active')),
+            unavailableIds: ids.filter((id) => !this.data.some((page) => page.id === id && page.state === 'active')),
+        };
+    }
+    check(id, version) {
+        const page = this.page(id);
+        if (page.recordVersion !== version) {
+            throw new Error('Version conflict');
+        }
+        return page;
+    }
+    async updateOne(id, dto) {
+        const page = this.check(id, dto.recordVersion);
+        const before = this.content(page);
+        const { explicitLinks, originContext, staleAfter, resource, recordVersion: _version, ...fields } = dto;
+        Object.assign(page, fields);
+        if (resource !== undefined) {
+            page.resource = resource ?? undefined;
+        }
+        if (explicitLinks) {
+            page.links = explicitLinks.map((target) => ({ target, explicit: true, parsed: false }));
+        }
+        if (originContext !== undefined) {
+            page.origin.context = originContext ?? undefined;
+        }
+        if (staleAfter !== undefined) {
+            page.staleAfter = staleAfter || undefined;
+        }
+        if (this.content(page) !== before) {
+            page.revision++;
+            this.remember(page);
+        }
+        page.recordVersion++;
+        return structuredClone(page);
+    }
+    async confirm(id, dto) {
+        const page = this.check(id, dto.recordVersion);
+        if (page.revision !== dto.revision) {
+            throw new Error('Revision conflict');
+        }
+        page.confirmations.push({ actor: { id: 'mock-user' }, at: new Date().toISOString(), revision: page.revision });
+        page.recordVersion++;
+        return structuredClone(page);
+    }
+    async withdraw(id, dto) {
+        const page = this.check(id, dto.recordVersion);
+        page.state = 'withdrawn';
+        page.deletedAt = new Date().toISOString();
+        page.recordVersion++;
+        return structuredClone(page);
+    }
+    async restore(id, dto) {
+        const page = this.check(id, dto.recordVersion);
+        page.state = 'active';
+        delete page.deletedAt;
+        page.recordVersion++;
+        return structuredClone(page);
+    }
+    async purgeOrganization(organizationId) {
+        const kept = this.data.filter((page) => page.owner.id !== organizationId);
+        const deleted = this.data.length - kept.length;
+        this.data = kept;
+        return { deleted };
+    }
+}
+exports.KnowledgeMockService = KnowledgeMockService;

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

@@ -1,8 +1,9 @@
-import { LogbookEntry, LogbookEntryDto, Paginated, TokenOption } from '../interfaces';
+import { Config, LogbookEntry, LogbookEntryDto, Paginated, PermissionLevel, TokenOption } from '../interfaces';
 import { LogbookService } from '../services';
 import { APIBaseMock } from './api-base.mock';
 export declare class LogbookMockService extends APIBaseMock<LogbookEntry> implements LogbookService {
     constructor(logbookEntries?: LogbookEntry[]);
+    getReferenceCheck(id: string, _permissionLevel: PermissionLevel, _options?: Config): Promise<LogbookEntry>;
     getEntries(taskId: string, limit?: number, offset?: number, _options?: TokenOption): Promise<Paginated<LogbookEntry>>;
     getEntriesByIds(ids: string[], _options?: TokenOption): Promise<LogbookEntry[]>;
     addEntry(taskId: string, dto: LogbookEntryDto, _options?: TokenOption): Promise<LogbookEntry>;

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

@@ -7,6 +7,9 @@ class LogbookMockService extends api_base_mock_1.APIBaseMock {
     constructor(logbookEntries = []) {
         super(logbookEntries);
     }
+    getReferenceCheck(id, _permissionLevel, _options = {}) {
+        return Promise.resolve(this.data.find((entry) => entry.id === id));
+    }
     async getEntries(taskId, limit = 50, offset = 0, _options = {}) {
         const taskEntries = this.data.filter((e) => e.taskId === taskId);
         const docs = taskEntries.slice(offset, offset + limit);

package/src/lib/mock/object-reference.mock.service.d.ts

@@ -1,13 +1,12 @@
-import { CreateReferenceDto, ObjectReference, ObjectReferenceType, Paginated, ReferencesQuery, TokenOption } from '../interfaces';
+import { Config, CreateReferenceDto, ObjectReference, ObjectReferenceType, Paginated, ReferencesQuery } from '../interfaces';
 import { ObjectReferenceService } from '../services/object-reference.service';
 import { APIBaseMock } from './api-base.mock';
 export declare class ObjectReferenceMockService extends APIBaseMock<ObjectReference> implements ObjectReferenceService {
     constructor(initialData: ObjectReference[]);
-    find(query: ReferencesQuery, _options?: TokenOption): Promise<Paginated<ObjectReference>>;
-    findAll(objId: string, _options?: TokenOption): Promise<ObjectReference[]>;
-    create(dto: CreateReferenceDto, _options?: TokenOption): Promise<ObjectReference>;
-    update(referenceId: number, updateData: Partial<Omit<ObjectReference, 'id' | 'createdAt'>>, _options?: TokenOption): Promise<ObjectReference>;
-    deleteById(refId: string, _options?: TokenOption): Promise<void>;
-    deleteByReference(src: string, tgt: string, relType: ObjectReferenceType, _options?: TokenOption): Promise<void>;
-    checkConnection(srcId: string, tgtId: string, type?: ObjectReferenceType, _options?: TokenOption): Promise<boolean>;
+    find(query: ReferencesQuery, _options?: Config): Promise<Paginated<ObjectReference>>;
+    findAll(objId: string, _options?: Config): Promise<ObjectReference[]>;
+    create(dto: CreateReferenceDto, _options?: Config): Promise<ObjectReference>;
+    deleteById(refId: string, _options?: Config): Promise<void>;
+    deleteByReference(src: string, tgt: string, relType: ObjectReferenceType, _options?: Config): Promise<void>;
+    checkConnection(srcId: string, tgtId: string, type?: ObjectReferenceType, _options?: Config): Promise<boolean>;
 }

package/src/lib/mock/object-reference.mock.service.js

@@ -25,10 +25,16 @@ class ObjectReferenceMockService extends api_base_mock_1.APIBaseMock {
             // Note: connectedObjType filter logic could be added here if needed
             return true;
         });
+        const limit = query.limit ?? docs.length;
+        const page = query.page ?? 1;
+        const start = (page - 1) * limit;
+        const paginatedDocs = docs.slice(start, start + limit);
         return {
-            docs,
+            docs: paginatedDocs,
             total: docs.length,
-            limit: docs.length,
+            limit,
+            page,
+            pages: limit > 0 ? Math.ceil(docs.length / limit) : 0,
         };
     }
     async findAll(objId, _options = {}) {
@@ -43,8 +49,8 @@ class ObjectReferenceMockService extends api_base_mock_1.APIBaseMock {
             tgtType: dto.tgtType,
             relType: dto.relType,
             relSrc: dto.relSrc,
-            displayData: dto.displayData,
-            tgtDeleted: dto.tgtDeleted ?? false,
+            displayData: {},
+            tgtDeleted: false,
             createdAt: Date.now(),
             updatedAt: Date.now(),
             createdBy: 'mock-user',
@@ -52,18 +58,6 @@ class ObjectReferenceMockService extends api_base_mock_1.APIBaseMock {
         this.data.push(newRef);
         return newRef;
     }
-    async update(referenceId, updateData, _options = {}) {
-        const index = this.data.findIndex((ref) => ref.id === referenceId);
-        if (index === -1) {
-            throw new Error(`Reference with id ${referenceId} not found`);
-        }
-        this.data[index] = {
-            ...this.data[index],
-            ...updateData,
-            updatedAt: Date.now(),
-        };
-        return this.data[index];
-    }
     async deleteById(refId, _options = {}) {
         const id = parseInt(refId, 10);
         this.data = this.data.filter((ref) => ref.id !== id);

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

@@ -1,4 +1,4 @@
-import { DeleteQuery, Paginated, RequestParameter, Task } from '../interfaces';
+import { Config, DeleteQuery, Paginated, PermissionLevel, RequestParameter, Task } from '../interfaces';
 import { TaskService } from '../services';
 import type { CreateAbsenceRequest } from '../services/task.service';
 import { DataMockService } from './data.mock.service';
@@ -13,6 +13,7 @@ declare class BaseService extends BaseService_base {
 }
 export declare class TaskMockService extends BaseService implements TaskService {
     constructor(tasks: Task[]);
+    getReferenceCheck(id: string, _permissionLevel: PermissionLevel, _options?: Config): Promise<Task>;
     createTaskAttachedToAsset(dto: any): Promise<Task>;
     createAbsence(dto: CreateAbsenceRequest): Promise<Task>;
     deleteOne(taskId: string, deleteQuery?: DeleteQuery): Promise<Task>;

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

@@ -11,6 +11,9 @@ class TaskMockService extends BaseService {
     constructor(tasks) {
         super(tasks);
     }
+    getReferenceCheck(id, _permissionLevel, _options = {}) {
+        return this.getOne(id);
+    }
     async createTaskAttachedToAsset(dto) {
         this.data.push(dto);
         return Promise.resolve(dto);

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

@@ -1,5 +1,5 @@
 import { APIBase } from '../api-base';
-import { AiAssistant, AiAssistantId, AiSkill, AiSkillSummary, AudioTranscription, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, Thread, ThreadPopulated, TokenOption } from '../interfaces';
+import { AiAssistant, AiAssistantId, AiSkill, AiSkillSummary, AudioTranscription, Config, Message, OneShotTaskId, OneShotTaskResult, Paginated, PermissionLevel, Thread, ThreadPopulated, TokenOption } from '../interfaces';
 import { CrossPlatformFormData } from '../utils';
 import { HttpClientService } from './http-client.service';
 export declare class AiService extends APIBase {
@@ -19,6 +19,8 @@ export declare class AiService extends APIBase {
     replaceSkill(id: string, form: CrossPlatformFormData, options?: Config): Promise<AiSkill>;
     getThreadMessages(threadId: string): Promise<Paginated<Message>>;
     getThread(threadId: string): Promise<ThreadPopulated>;
+    getThreadReferenceCheck(threadId: string, permissionLevel?: PermissionLevel, options?: Config): Promise<ThreadPopulated>;
+    getUserMessageReferenceCheck(messageId: string, permissionLevel?: PermissionLevel, options?: Config): Promise<Message>;
     getLatestThread(): Promise<ThreadPopulated>;
     listThreads(assistantIds?: AiAssistantId[], params?: {}, options?: TokenOption): Promise<ThreadPopulated[]>;
     provideFeedback(traceId: string, value: number, comment?: string): Promise<void>;

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AiService = void 0;
 const api_base_1 = require("../api-base");
+const interfaces_1 = require("../interfaces");
 const utils_1 = require("../utils");
 const AUDIO_TRANSCRIPTION_TIMEOUT_MS = 5 * 60000;
 class AiService extends api_base_1.APIBase {
@@ -62,6 +63,18 @@ class AiService extends api_base_1.APIBase {
     getThread(threadId) {
         return this.httpClient.get(`${this.basePath}/threads/${threadId}`);
     }
+    getThreadReferenceCheck(threadId, permissionLevel = interfaces_1.PermissionLevel.NONE, options = {}) {
+        return this.httpClient.get(`${this.basePath}/threads/${threadId}/reference-check`, {
+            ...options,
+            params: { permissionLevel, ...options.params },
+        });
+    }
+    getUserMessageReferenceCheck(messageId, permissionLevel = interfaces_1.PermissionLevel.NONE, options = {}) {
+        return this.httpClient.get(`${this.basePath}/messages/${messageId}/reference-check`, {
+            ...options,
+            params: { permissionLevel, ...options.params },
+        });
+    }
     getLatestThread() {
         return this.httpClient.get(`${this.basePath}/threads/latest`);
     }

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

@@ -1,4 +1,4 @@
-import { AddToProperty, Asset, AssetRevision, Attachment, DeleteAssetQuery, EventCause, EventLevelOverride, Filter, Paginated, RemoveFromProperty, RequestParameter, SearchResultItem, TokenOption, Translation } from '../interfaces';
+import { AddToProperty, Asset, AssetRevision, Attachment, Config, DeleteAssetQuery, EventCause, EventLevelOverride, Filter, Paginated, PermissionLevel, RemoveFromProperty, RequestParameter, SearchResultItem, TokenOption, Translation } from '../interfaces';
 import { CrossPlatformFormData } from '../utils';
 import { DataService } from './data.service';
 import { HttpClientService } from './http-client.service';
@@ -13,6 +13,7 @@ declare class BaseService extends BaseService_base {
 }
 export declare class AssetService extends BaseService {
     constructor(httpClient: HttpClientService);
+    getReferenceCheck(id: string, permissionLevel: PermissionLevel, options?: Config): Promise<Asset>;
     count(filter: Filter, options?: TokenOption): Promise<number>;
     deleteOne(id: string, deleteQuery?: DeleteAssetQuery, options?: TokenOption): Promise<any>;
     addAttachment: (id: string, form: CrossPlatformFormData, options?: TokenOption) => Promise<Asset>;

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

@@ -20,6 +20,12 @@ class AssetService extends BaseService {
             });
         };
     }
+    getReferenceCheck(id, permissionLevel, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${id}/reference-check`, {
+            ...options,
+            params: { ...options.params, permissionLevel },
+        });
+    }
     count(filter, options = {}) {
         const params = { filter: (0, utils_1.getFilterString)(filter) };
         return this.httpClient.get(`${this.basePath}/count`, { params, ...options });

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

@@ -1,4 +1,4 @@
-import { Config, Content, ReturnType, TokenOption } from '../interfaces';
+import { Config, Content, PermissionLevel, ReturnType, TokenOption } from '../interfaces';
 import { CrossPlatformFormData } from '../utils';
 import { DataService } from './data.service';
 import { HttpClientService } from './http-client.service';
@@ -13,6 +13,7 @@ declare class BaseService extends BaseService_base {
 }
 export declare class ContentService extends BaseService {
     constructor(httpClient: HttpClientService);
+    getReferenceCheck(id: string, permissionLevel: PermissionLevel, options?: Config): Promise<Content>;
     upload: (form: CrossPlatformFormData, options?: Config) => Promise<Content>;
     download(id: string, raw?: boolean, options?: TokenOption): Promise<Blob | ArrayBuffer>;
     download(id: string, returnType: ReturnType.TEXT, options?: TokenOption): Promise<string>;

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

@@ -22,6 +22,12 @@ class ContentService extends BaseService {
             });
         };
     }
+    getReferenceCheck(id, permissionLevel, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${id}/reference-check`, {
+            ...options,
+            params: { ...options.params, permissionLevel },
+        });
+    }
     async download(id, second, options = {}) {
         let returnType;
         if (typeof second === 'boolean' || second == null) {

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

@@ -1,4 +1,4 @@
-import { Event, EventCountByAsset, TokenOption } from '../interfaces';
+import { Config, Event, EventCountByAsset, PermissionLevel, TokenOption } from '../interfaces';
 import { DataService } from './data.service';
 import { HttpClientService } from './http-client.service';
 import { ShareService } from './share.service';
@@ -9,6 +9,7 @@ declare class BaseService extends BaseService_base {
 }
 export declare class EventService extends BaseService {
     constructor(httpClient: HttpClientService);
+    getReferenceCheck(id: string, permissionLevel: PermissionLevel, options?: Config): Promise<Event>;
     getEventCountByAsset(assetId: string, options?: TokenOption): Promise<EventCountByAsset>;
     getLastEventByAssetAndGroup(assetId: string, group: string, options?: TokenOption): Promise<Event>;
     getLastEventByAssetAndGroups(assetId: string, groups: string[], options?: TokenOption): Promise<Record<string, string>>;

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

@@ -10,6 +10,12 @@ class EventService extends BaseService {
     constructor(httpClient) {
         super(httpClient, '/events');
     }
+    getReferenceCheck(id, permissionLevel, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${id}/reference-check`, {
+            ...options,
+            params: { ...options.params, permissionLevel },
+        });
+    }
     getEventCountByAsset(assetId, options = {}) {
         return this.httpClient.get(`${this.basePath}/countByAsset/${assetId}`, options);
     }

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

@@ -33,3 +33,4 @@ export { TimeseriesValueFeedManagementService } from './timeseries-value-feed-ma
 export { UserService } from './user.service';
 export { VaultService } from './vault.service';
 export * from './authz';
+export * from './knowledge.service';

package/src/lib/services/index.js

@@ -71,3 +71,4 @@ Object.defineProperty(exports, "UserService", { enumerable: true, get: function
 var vault_service_1 = require("./vault.service");
 Object.defineProperty(exports, "VaultService", { enumerable: true, get: function () { return vault_service_1.VaultService; } });
 tslib_1.__exportStar(require("./authz"), exports);
+tslib_1.__exportStar(require("./knowledge.service"), exports);

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

@@ -0,0 +1,22 @@
+import { APIBase } from '../api-base';
+import type { Config, ConfirmKnowledge, CreateKnowledge, KnowledgeBacklinkQuery, KnowledgeBatch, KnowledgeHome, KnowledgeList, KnowledgePage, KnowledgeQuery, KnowledgeRevision, KnowledgeVersion, UpdateKnowledge } from '../interfaces';
+import { HttpClientService } from './http-client.service';
+export declare class KnowledgeService extends APIBase {
+    constructor(httpClient: HttpClientService);
+    addOne(dto: CreateKnowledge, options?: Config): Promise<KnowledgePage>;
+    getOne(id: string, options?: Config): Promise<KnowledgePage>;
+    getMany(query?: KnowledgeQuery, options?: Config): Promise<KnowledgeList>;
+    getHome(query?: KnowledgeQuery, options?: Config): Promise<KnowledgeHome>;
+    getBacklinks(query: KnowledgeBacklinkQuery, options?: Config): Promise<KnowledgeList>;
+    getRelated(id: string, query?: Pick<KnowledgeQuery, 'cursor' | 'limit'>, options?: Config): Promise<KnowledgeList>;
+    getRevision(id: string, revision: number, options?: Config): Promise<KnowledgeRevision>;
+    readBatch(ids: string[], options?: Config): Promise<KnowledgeBatch>;
+    updateOne(id: string, dto: UpdateKnowledge, options?: Config): Promise<KnowledgePage>;
+    confirm(id: string, dto: ConfirmKnowledge, options?: Config): Promise<KnowledgePage>;
+    withdraw(id: string, dto: KnowledgeVersion, options?: Config): Promise<KnowledgePage>;
+    restore(id: string, dto: KnowledgeVersion, options?: Config): Promise<KnowledgePage>;
+    /** Permanently deletes all pages and revisions of an organization; for organization deletion only. */
+    purgeOrganization(organizationId: string, options?: Config): Promise<{
+        deleted: number;
+    }>;
+}

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeService = void 0;
+const api_base_1 = require("../api-base");
+class KnowledgeService extends api_base_1.APIBase {
+    constructor(httpClient) {
+        super(httpClient, '/knowledge');
+    }
+    addOne(dto, options = {}) {
+        return this.httpClient.post(this.basePath, dto, options);
+    }
+    getOne(id, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${encodeURIComponent(id)}`, options);
+    }
+    getMany(query = {}, options = {}) {
+        return this.httpClient.get(this.basePath, { ...options, params: query });
+    }
+    getHome(query = {}, options = {}) {
+        return this.httpClient.get(`${this.basePath}/home`, { ...options, params: query });
+    }
+    getBacklinks(query, options = {}) {
+        return this.httpClient.get(`${this.basePath}/backlinks`, { ...options, params: query });
+    }
+    getRelated(id, query = {}, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${encodeURIComponent(id)}/related`, { ...options, params: query });
+    }
+    getRevision(id, revision, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${encodeURIComponent(id)}/revisions/${revision}`, options);
+    }
+    readBatch(ids, options = {}) {
+        return this.httpClient.post(`${this.basePath}/read-batch`, { ids }, options);
+    }
+    updateOne(id, dto, options = {}) {
+        return this.httpClient.patch(`${this.basePath}/${encodeURIComponent(id)}`, dto, options);
+    }
+    confirm(id, dto, options = {}) {
+        return this.httpClient.post(`${this.basePath}/${encodeURIComponent(id)}/confirm`, dto, options);
+    }
+    withdraw(id, dto, options = {}) {
+        return this.httpClient.post(`${this.basePath}/${encodeURIComponent(id)}/withdraw`, dto, options);
+    }
+    restore(id, dto, options = {}) {
+        return this.httpClient.post(`${this.basePath}/${encodeURIComponent(id)}/restore`, dto, options);
+    }
+    /** Permanently deletes all pages and revisions of an organization; for organization deletion only. */
+    purgeOrganization(organizationId, options = {}) {
+        return this.httpClient.delete(`${this.basePath}/organizations/${encodeURIComponent(organizationId)}`, options);
+    }
+}
+exports.KnowledgeService = KnowledgeService;

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

@@ -1,8 +1,9 @@
 import { APIBase } from '../api-base';
-import { LogbookEntry, LogbookEntryDto, Paginated, TokenOption } from '../interfaces';
+import { Config, LogbookEntry, LogbookEntryDto, Paginated, PermissionLevel, TokenOption } from '../interfaces';
 import { HttpClientService } from './http-client.service';
 export declare class LogbookService extends APIBase {
     constructor(httpClient: HttpClientService);
+    getReferenceCheck(entryId: string, permissionLevel: PermissionLevel, options?: Config): Promise<LogbookEntry>;
     getEntries(taskId: string, limit?: number, offset?: number, options?: TokenOption): Promise<Paginated<LogbookEntry>>;
     getEntriesByIds(ids: string[], options?: TokenOption): Promise<LogbookEntry[]>;
     addEntry(taskId: string, entry: LogbookEntryDto, options?: TokenOption): Promise<LogbookEntry>;

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

@@ -6,6 +6,12 @@ class LogbookService extends api_base_1.APIBase {
     constructor(httpClient) {
         super(httpClient, '/tasks/logbook');
     }
+    getReferenceCheck(entryId, permissionLevel, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${entryId}/reference-check`, {
+            ...options,
+            params: { ...options.params, permissionLevel },
+        });
+    }
     getEntries(taskId, limit = 50, offset = 0, options = {}) {
         return this.httpClient.get(this.basePath, {
             ...options,

package/src/lib/services/object-reference.service.d.ts

@@ -1,13 +1,12 @@
 import { APIBase } from '../api-base';
-import { CreateReferenceDto, ObjectReference, ObjectReferenceType, Paginated, ReferencesQuery, TokenOption } from '../interfaces';
+import { Config, CreateReferenceDto, ObjectReference, ObjectReferenceType, Paginated, ReferencesQuery } from '../interfaces';
 import { HttpClientService } from './http-client.service';
 export declare class ObjectReferenceService extends APIBase {
     constructor(httpClient: HttpClientService);
-    find(query: ReferencesQuery, options?: TokenOption): Promise<Paginated<ObjectReference>>;
-    findAll(objId: string, options?: TokenOption): Promise<ObjectReference[]>;
-    create(dto: CreateReferenceDto, options?: TokenOption): Promise<ObjectReference>;
-    update(referenceId: number, updateData: Partial<Omit<ObjectReference, 'id' | 'createdAt'>>, options?: TokenOption): Promise<ObjectReference>;
-    deleteById(refId: string, options?: TokenOption): Promise<void>;
-    deleteByReference(src: string, tgt: string, relType: ObjectReferenceType, options?: TokenOption): Promise<void>;
-    checkConnection(srcId: string, tgtId: string, type?: ObjectReferenceType, options?: TokenOption): Promise<boolean>;
+    find(query: ReferencesQuery, options?: Config): Promise<Paginated<ObjectReference>>;
+    findAll(objId: string, options?: Config): Promise<ObjectReference[]>;
+    create(dto: CreateReferenceDto, options?: Config): Promise<ObjectReference>;
+    deleteById(refId: string, options?: Config): Promise<void>;
+    deleteByReference(src: string, tgt: string, relType: ObjectReferenceType, options?: Config): Promise<void>;
+    checkConnection(srcId: string, tgtId: string, type?: ObjectReferenceType, options?: Config): Promise<boolean>;
 }

package/src/lib/services/object-reference.service.js

@@ -21,6 +21,15 @@ class ObjectReferenceService extends api_base_1.APIBase {
         if (query.objIsSrc === true) {
             params.append('objIsSrc', query.objIsSrc.toString());
         }
+        if (query.limit !== undefined) {
+            params.append('limit', query.limit.toString());
+        }
+        if (query.page !== undefined) {
+            params.append('page', query.page.toString());
+        }
+        if (query.sort) {
+            params.append('sort', query.sort);
+        }
         return await this.httpClient.get(`${this.basePath}?${params.toString()}`, options);
     }
     async findAll(objId, options = {}) {
@@ -29,9 +38,6 @@ class ObjectReferenceService extends api_base_1.APIBase {
     async create(dto, options = {}) {
         return await this.httpClient.post(this.basePath, dto, options);
     }
-    async update(referenceId, updateData, options = {}) {
-        return await this.httpClient.put(`${this.basePath}/${referenceId}`, updateData, options);
-    }
     async deleteById(refId, options = {}) {
         await this.httpClient.delete(`${this.basePath}/${refId}`, options);
     }

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

@@ -1,4 +1,4 @@
-import { Paginated, Task, TokenOption } from '../interfaces';
+import { Config, Paginated, PermissionLevel, Task, TokenOption } from '../interfaces';
 import { DataService } from './data.service';
 import { HttpClientService } from './http-client.service';
 import { ShareService } from './share.service';
@@ -20,6 +20,7 @@ export interface CreateAbsenceRequest {
 }
 export declare class TaskService extends BaseService {
     constructor(httpClient: HttpClientService);
+    getReferenceCheck(id: string, permissionLevel: PermissionLevel, options?: Config): Promise<Task>;
     createTaskAttachedToAsset(dto: any, options?: TokenOption): Promise<Task>;
     findByName(name: string, options?: TokenOption): Promise<Paginated<Task>>;
     findByAsset(assetId: string, options?: TokenOption): Promise<Paginated<Task>>;

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

@@ -11,6 +11,12 @@ class TaskService extends BaseService {
     constructor(httpClient) {
         super(httpClient, '/tasks');
     }
+    getReferenceCheck(id, permissionLevel, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${id}/reference-check`, {
+            ...options,
+            params: { ...options.params, permissionLevel },
+        });
+    }
     // we may not need this method (already have the addOne method from ShareService)
     createTaskAttachedToAsset(dto, options = {}) {
         return this.httpClient.post(this.basePath, dto, options);