@hahnpro/hpc-api 2026.7.2 → 2026.7.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @hahnpro/hpc-api
 
+# 2026.7.3
+
+- Added partial-object validation support to the `isAsset`, `isContent`, `isEvent`, `isLogbookEntry`, and `isTask` type guards
+- Expanded `isAsset` to validate populated asset types as well as all supported asset fields
+- Added stricter enum, resource-reference, and attachment-handling validation to the content analysis, event, and user-message type guards
+- Changed `Event.level (string)` to `EventLevel`
+- Updated `Task.expiryDate` and its type guard to accept strings as well as `Date` values
+
 # 2026.7.2
 
 - Added dedicated logbook API service, logbook interfaces, and mock support

package/package.json

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

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

@@ -8,7 +8,7 @@ export interface Event extends Resource {
     tsRef?: string;
     eventRef?: string;
     cause?: string;
-    level: string;
+    level: EventLevel;
     group?: string;
     owner?: Owner;
     createdBy?: Author;

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

@@ -38,7 +38,7 @@ export interface Task extends Api {
     eventRef$name?: string;
     gitHubNr?: number;
     schedule?: string;
-    expiryDate?: Date;
+    expiryDate?: string | Date;
     parent?: string;
     parent$name?: string;
     subTasks?: string[];

package/src/lib/interfaces/type-guards.d.ts

@@ -1,7 +1,7 @@
 import { type UserMessage } from './ai.interface';
 import type { Asset } from './asset.interface';
 import type { Author } from './author.interface';
-import type { Content, ContentAnalysis } from './content.interface';
+import { type Content, type ContentAnalysis } from './content.interface';
 import { type Event } from './event.interface';
 import { type LogbookEntry } from './logbook.interface';
 import { type Owner } from './owner.interface';
@@ -11,10 +11,20 @@ export declare function isAuthor(value: unknown): value is Author;
 export declare function isOwner(value: unknown): value is Owner;
 export declare function isStorage(value: unknown): value is Storage;
 export declare function isContentAnalysis(value: unknown): value is ContentAnalysis;
-export declare function isAsset(value: unknown): value is Asset;
-export declare function isContent(value: unknown): value is Content;
-export declare function isEvent(value: unknown): value is Event;
+export declare function isAsset(value: unknown, isPartial?: false): value is Asset;
+export declare function isAsset(value: unknown, isPartial: true): value is Partial<Asset>;
+export declare function isAsset(value: unknown, isPartial: boolean): value is Asset | Partial<Asset>;
+export declare function isContent(value: unknown, isPartial?: false): value is Content;
+export declare function isContent(value: unknown, isPartial: true): value is Partial<Content>;
+export declare function isContent(value: unknown, isPartial: boolean): value is Content | Partial<Content>;
+export declare function isEvent(value: unknown, isPartial?: false): value is Event;
+export declare function isEvent(value: unknown, isPartial: true): value is Partial<Event>;
+export declare function isEvent(value: unknown, isPartial: boolean): value is Event | Partial<Event>;
 export declare function isAssignee(value: unknown): value is Assignee;
-export declare function isLogbookEntry(value: unknown): value is LogbookEntry;
-export declare function isTask(value: unknown): value is Task;
+export declare function isLogbookEntry(value: unknown, isPartial?: false): value is LogbookEntry;
+export declare function isLogbookEntry(value: unknown, isPartial: true): value is Partial<LogbookEntry>;
+export declare function isLogbookEntry(value: unknown, isPartial: boolean): value is LogbookEntry | Partial<LogbookEntry>;
+export declare function isTask(value: unknown, isPartial?: false): value is Task;
+export declare function isTask(value: unknown, isPartial: true): value is Partial<Task>;
+export declare function isTask(value: unknown, isPartial: boolean): value is Task | Partial<Task>;
 export declare function isUserMessage(value: unknown): value is UserMessage;

package/src/lib/interfaces/type-guards.js

@@ -12,9 +12,11 @@ exports.isLogbookEntry = isLogbookEntry;
 exports.isTask = isTask;
 exports.isUserMessage = isUserMessage;
 const ai_interface_1 = require("./ai.interface");
+const content_interface_1 = require("./content.interface");
 const event_interface_1 = require("./event.interface");
 const logbook_interface_1 = require("./logbook.interface");
 const owner_interface_1 = require("./owner.interface");
+const resource_interface_1 = require("./resource.interface");
 const task_interface_1 = require("./task.interface");
 function isRecord(value) {
     return typeof value === 'object' && value !== null;
@@ -32,10 +34,14 @@ const isArrayOf = (value, predicate) => Array.isArray(value) && value.every(pred
 const isOptionalArrayOf = (value, predicate) => value === undefined || isArrayOf(value, predicate);
 const isStringArray = (value) => isArrayOf(value, isString);
 const isOptionalStringArray = (value) => isOptionalArrayOf(value, isString);
+const isOptionalUnknownArray = (value) => value === undefined || Array.isArray(value);
+const hasOwn = (value, property) => Object.prototype.hasOwnProperty.call(value, property);
 const isMessageAttachment = (value) => isRecord(value) && isOptionalString(value.id) && isString(value.filename) && isString(value.text);
+const isResourceReference = (value) => isRecord(value) && isString(value.id) && isEnumValue(resource_interface_1.ResourceType, value.resourceType) && isOptionalBoolean(value.dependent);
 const isOneOf = (value, allowed) => allowed.includes(value);
 const isEnumValue = (target, value) => Object.values(target).includes(value);
 const hasPermissions = (value) => isStringArray(value.readPermissions) && isStringArray(value.readWritePermissions);
+const hasOptionalPermissions = (value) => isOptionalStringArray(value.readPermissions) && isOptionalStringArray(value.readWritePermissions);
 const hasResourceMeta = (value, options) => {
     const { owner, author, date } = options;
     if (owner && value.owner !== undefined && !owner(value.owner)) {
@@ -89,61 +95,114 @@ function isContentAnalysis(value) {
     }
     return (isString(value.id) &&
         isString(value.contentId) &&
-        isString(value.status) &&
+        isEnumValue(content_interface_1.ContentAnalysisStatus, value.status) &&
         isOptionalString(value.error) &&
         isOptionalString(value.text) &&
         isOptionalArrayOf(value.pages, (page) => isRecord(page) && isNumber(page.pageNumber) && isOptionalString(page.text)));
 }
-function isAsset(value) {
+function isTemplate(value) {
+    return isRecord(value) && isString(value.id) && isString(value.name) && isRecord(value.template);
+}
+function isAssetType(value) {
     if (!isRecord(value)) {
         return false;
     }
-    return (isString(value.id) &&
-        isOptionalString(value.translationId) &&
+    const hasValidAllowedParents = value.allowedParents === undefined || isStringArray(value.allowedParents) || isArrayOf(value.allowedParents, isAssetType);
+    const hasValidSupertype = value.supertype === undefined || isString(value.supertype) || isAssetType(value.supertype);
+    const hasValidTabPermissions = value.tabPermissions === undefined || (isRecord(value.tabPermissions) && Object.values(value.tabPermissions).every(isStringArray));
+    const hasValidTemplates = value.templates === undefined || isStringArray(value.templates) || isArrayOf(value.templates, isTemplate);
+    return (isOptionalString(value.id) &&
         isString(value.name) &&
-        isOptionalString(value.description) &&
+        isOptionalStringArray(value.tags) &&
+        isOptionalString(value.translationId) &&
+        hasValidAllowedParents &&
+        isOptionalString(value.allowedParent$name) &&
         hasPermissions(value) &&
-        isString(value.type) &&
+        hasValidSupertype &&
+        isOptionalString(value.supertype$name) &&
+        hasOwn(value, 'typeSchema') &&
+        hasOwn(value, 'uiSchema') &&
+        isOptionalString(value.author) &&
+        isOptionalNumber(value.revision) &&
+        isOptionalBoolean(value.isSystemAssetType) &&
+        isOptionalString(value.startTab) &&
+        hasValidTabPermissions &&
+        isOptionalNumber(value.templateVersion) &&
+        hasValidTemplates &&
+        hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: isString }));
+}
+function isAsset(value, isPartial = false) {
+    if (!isRecord(value)) {
+        return false;
+    }
+    let requiredFieldsValid = false;
+    if (!isPartial) {
+        requiredFieldsValid =
+            isOptionalString(value.id) && isString(value.name) && hasPermissions(value) && (isString(value.type) || isAssetType(value.type));
+    }
+    else {
+        requiredFieldsValid =
+            isOptionalString(value.id) &&
+                isOptionalString(value.name) &&
+                hasOptionalPermissions(value) &&
+                isOptional(value.type, (type) => isString(type) || isAssetType(type));
+    }
+    return (requiredFieldsValid &&
+        isOptionalString(value.externalKey) &&
+        isOptionalString(value.translationId) &&
         isOptionalString(value.type$name) &&
         isOptionalStringArray(value.tags) &&
         isOptionalString(value.parent) &&
         isOptionalString(value.parent$name) &&
+        isOptionalStringArray(value.ancestors) &&
+        isOptionalUnknownArray(value.relations) &&
+        isOptionalString(value.image) &&
         isOptionalStringArray(value.attachments) &&
         isOptionalStringArray(value.notificationEndpoints) &&
         isOptionalStringArray(value.aliases) &&
-        isOptional(value.data, isRecord) &&
-        isOptional(value.timeseries, isRecord) &&
-        isOptional(value.event, isRecord) &&
-        hasResourceMeta(value, { owner: isOwner, author: isAuthor }));
+        isOptionalString(value.author) &&
+        isOptionalNumber(value.revision) &&
+        hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: isString }));
 }
-function isContent(value) {
+function isContent(value, isPartial = false) {
     if (!isRecord(value)) {
         return false;
     }
     const hasValidAnalysis = value.analysis === undefined || isString(value.analysis) || isContentAnalysis(value.analysis);
-    return (isOptionalString(value.id) &&
-        isString(value.fileId) &&
-        isString(value.filename) &&
+    let requiredFieldsValid = false;
+    if (!isPartial) {
+        requiredFieldsValid =
+            isString(value.fileId) && isString(value.filename) && isString(value.mimetype) && isNumber(value.size) && hasPermissions(value);
+    }
+    else {
+        requiredFieldsValid =
+            isOptionalString(value.fileId) &&
+                isOptionalString(value.filename) &&
+                isOptionalString(value.mimetype) &&
+                isOptionalNumber(value.size) &&
+                hasOptionalPermissions(value);
+    }
+    return (requiredFieldsValid &&
+        isOptionalString(value.id) &&
         isOptionalString(value.description) &&
-        isString(value.mimetype) &&
-        isNumber(value.size) &&
-        hasPermissions(value) &&
         isOptionalStringArray(value.tags) &&
         isOptionalStringArray(value.assets) &&
         isOptionalArrayOf(value.files, isStorage) &&
-        hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: isString }) &&
-        hasValidAnalysis);
+        hasValidAnalysis &&
+        hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: isString }));
 }
-function isEvent(value) {
+function isEvent(value, isPartial = false) {
     if (!isRecord(value)) {
         return false;
     }
-    return (isOptionalString(value.id) &&
-        isString(value.name) &&
+    const requiredFieldsValid = isPartial
+        ? isOptionalString(value.name) && hasOptionalPermissions(value) && isOptional(value.level, (level) => isEnumValue(event_interface_1.EventLevel, level))
+        : isString(value.name) && hasPermissions(value) && isEnumValue(event_interface_1.EventLevel, value.level);
+    return (requiredFieldsValid &&
+        isOptionalString(value.id) &&
         isOptionalString(value.description) &&
         isOptionalStringArray(value.tags) &&
-        hasPermissions(value) &&
-        isEnumValue(event_interface_1.EventLevel, value.level) &&
+        isOptionalArrayOf(value.refs, isResourceReference) &&
         isOptional(value.data, isRecord) &&
         isOptionalString(value.assetRef) &&
         isOptionalString(value.assetRef$name) &&
@@ -152,20 +211,27 @@ function isEvent(value) {
         isOptionalString(value.eventRef) &&
         isOptionalString(value.cause) &&
         isOptionalString(value.group) &&
-        hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: isString }));
+        hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: (candidate) => isString(candidate) || isDate(candidate) }));
 }
 function isAssignee(value) {
     return isRecord(value) && isString(value.id) && isEnumValue(task_interface_1.AssigneeType, value.type);
 }
-function isLogbookEntry(value) {
+function isLogbookEntry(value, isPartial = false) {
     if (!isRecord(value)) {
         return false;
     }
-    return (isString(value.taskId) &&
-        isString(value.date) &&
-        isNumber(value.duration) &&
-        isEnumValue(logbook_interface_1.LogbookEntrySource, value.source) &&
-        isString(value.id) &&
+    const requiredFieldsValid = isPartial
+        ? isOptionalString(value.taskId) &&
+            isOptionalString(value.date) &&
+            isOptionalNumber(value.duration) &&
+            isOptional(value.source, (source) => isEnumValue(logbook_interface_1.LogbookEntrySource, source)) &&
+            isOptionalString(value.id)
+        : isString(value.taskId) &&
+            isString(value.date) &&
+            isNumber(value.duration) &&
+            isEnumValue(logbook_interface_1.LogbookEntrySource, value.source) &&
+            isString(value.id);
+    return (requiredFieldsValid &&
         isOptionalString(value.comment) &&
         isOptionalString(value.createdAt) &&
         isOptionalString(value.updatedAt) &&
@@ -173,34 +239,37 @@ function isLogbookEntry(value) {
         isOptional(value.data, isRecord) &&
         isOptional(value.createdBy, isAuthor));
 }
-function isTask(value) {
+function isTask(value, isPartial = false) {
     if (!isRecord(value)) {
         return false;
     }
     const hasValidStatusHistory = value.statusHistoryLog === undefined ||
         (Array.isArray(value.statusHistoryLog) && value.statusHistoryLog.every((status) => isEnumValue(task_interface_1.TaskStatus, status)));
-    return (isOptionalString(value.id) &&
+    const requiredFieldsValid = isPartial
+        ? isOptionalString(value.name) &&
+            isOptional(value.priority, (priority) => isEnumValue(task_interface_1.Priority, priority)) &&
+            hasOptionalPermissions(value) &&
+            isOptionalArrayOf(value.assignedTo, isAssignee)
+        : isString(value.name) && isEnumValue(task_interface_1.Priority, value.priority) && hasPermissions(value) && isArrayOf(value.assignedTo, isAssignee);
+    return (requiredFieldsValid &&
+        isOptionalString(value.id) &&
         isOptionalDateOrString(value.createdAt) &&
         isOptionalDateOrString(value.updatedAt) &&
         isOptionalDateOrString(value.deletedAt) &&
         isOptionalNumber(value.revision) &&
         hasResourceMeta(value, { owner: isOwner, author: isAuthor, date: (candidate) => isString(candidate) || candidate instanceof Date }) &&
-        isString(value.name) &&
         isOptionalString(value.description) &&
-        isEnumValue(task_interface_1.Priority, value.priority) &&
         isOptionalStringArray(value.tags) &&
-        hasPermissions(value) &&
         isOptionalString(value.assetRef) &&
         isOptionalString(value.assetRef$name) &&
         isOptionalString(value.eventRef) &&
         isOptionalString(value.eventRef$name) &&
         isOptionalNumber(value.gitHubNr) &&
         isOptionalString(value.schedule) &&
-        (value.expiryDate === undefined || value.expiryDate instanceof Date) &&
+        isOptionalDateOrString(value.expiryDate) &&
         isOptionalString(value.parent) &&
         isOptionalString(value.parent$name) &&
         isOptionalStringArray(value.subTasks) &&
-        isArrayOf(value.assignedTo, isAssignee) &&
         isOptionalString(value.acceptedBy) &&
         (value.status === undefined || isEnumValue(task_interface_1.TaskStatus, value.status)) &&
         hasValidStatusHistory &&
@@ -220,5 +289,6 @@ function isUserMessage(value) {
         isOptionalString(value.content) &&
         isOptionalBoolean(value.hidden) &&
         isOptionalBoolean(value.useWebSearch) &&
+        isOptional(value.attachmentHandling, (mode) => isEnumValue(ai_interface_1.AttachmentHandlingMode, mode)) &&
         isOptionalArrayOf(value.attachments, isMessageAttachment));
 }

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

@@ -8,7 +8,6 @@ export interface UserSettings extends Api {
     creationWriteRoles?: Permission[];
     deletionRequested?: boolean;
     favoriteLabelsOrder?: Record<string, number>;
-    language?: string;
     tableSettings?: TableSetting[];
     userId?: string;
 }