@privateaim/core-kit 0.8.4 → 0.8.6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@privateaim/core-kit",
-    "version": "0.8.4",
+    "version": "0.8.6",
     "license": "Apache-2.0",
     "description": "",
     "exports": {
@@ -26,12 +26,12 @@
         "build-watch": "rimraf ./dist && tsc -p tsconfig.build.json --watch"
     },
     "devDependencies": {
-        "@authup/core-kit": "^1.0.0-beta.22",
-        "@privateaim/kit": "^0.8.4"
+        "@authup/core-kit": "^1.0.0-beta.24",
+        "@privateaim/kit": "^0.8.6"
     },
     "peerDependencies": {
-        "@authup/core-kit": "^1.0.0-beta.22",
-        "@privateaim/kit": "^0.8.4"
+        "@authup/core-kit": "^1.0.0-beta.24",
+        "@privateaim/kit": "^0.8.6"
     },
     "gitHead": "5d3b6f4ce1edf2383bdfbf66e913a08c8a3a2e40",
     "publishConfig": {

package/src/domains/analysis/constants.ts

@@ -19,11 +19,9 @@ export enum AnalysisBuildStatus {
 // -------------------------------------------------------------------------
 
 export enum AnalysisConfigurationStatus {
-    BASE_CONFIGURED = 'base',
-    SECURITY_CONFIGURED = 'security_configured', // todo: still relevant ?
-    RESOURCE_CONFIGURED = 'resource_configured',
-    HASH_GENERATED = 'hash_generated', // todo: still relevant ?
-    HASH_SIGNED = 'hash_signed', // todo: signed by xyz
+    NODES = 'nodes',
+    MASTER_IMAGE = 'masterImage',
+    FILES = 'files',
     FINISHED = 'finished',
 }
 

package/src/domains/analysis/entity.ts

@@ -6,10 +6,8 @@
  */
 
 import type { Realm, User } from '@authup/core-kit';
-import type { DomainType } from '../constants';
-import type { MasterImage } from '../master-image';
+import type { MasterImage, MasterImageCommandArgument } from '../master-image';
 import type { Project } from '../project';
-import type { DomainEventBaseContext } from '../types-base';
 import type {
     AnalysisBuildStatus,
     AnalysisRunStatus,
@@ -63,12 +61,11 @@ export interface Analysis {
 
     // ------------------------------------------------------------------
 
+    image_command_arguments: MasterImageCommandArgument[] | null;
+
+    // ------------------------------------------------------------------
+
     master_image_id: MasterImage['id'] | null;
 
     master_image: MasterImage;
 }
-
-export type AnalysisEventContext = DomainEventBaseContext & {
-    type: `${DomainType.ANALYSIS}`,
-    data: Analysis
-};

package/src/domains/analysis/helpers.ts

@@ -0,0 +1,147 @@
+/*
+ * Copyright (c) 2025.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { AnalysisAPICommand, AnalysisBuildStatus } from './constants';
+import type { Analysis } from './entity';
+
+type CanResult = {
+    success: boolean,
+    message: string,
+};
+
+/**
+ * Check if an analysis can be build based on analysis attributes (build_status, configuration_locked, ...)
+ *
+ * @param entity
+ * @param command
+ */
+export function isAnalysisAPICommandExecutable(
+    entity: Analysis,
+    command: `${AnalysisAPICommand}`,
+) : CanResult {
+    const output : CanResult = {
+        success: false,
+        message: `The analysis command ${command} cannot be executed.`,
+    };
+
+    switch (command) {
+        case AnalysisAPICommand.BUILD_START: {
+            if (!entity.configuration_locked) {
+                output.success = false;
+                output.message = 'The analysis configuration must be locked before starting the build.';
+                return output;
+            }
+
+            if (!entity.build_status) {
+                output.success = true;
+                return output;
+            }
+
+            if (
+                entity.build_status === AnalysisBuildStatus.FAILED ||
+                entity.build_status === AnalysisBuildStatus.STOPPED
+            ) {
+                output.success = true;
+                return output;
+            }
+
+            output.message = `The current analysis build status "${entity.build_status}" does not allow a build start.`;
+            return output;
+        }
+        case AnalysisAPICommand.BUILD_STOP: {
+            if (!entity.configuration_locked) {
+                output.message = 'The analysis configuration must be locked before stopping the build.';
+                return output;
+            }
+
+            if (!entity.build_status) {
+                output.message = 'The analysis build process has not been initialized.';
+                return output;
+            }
+
+            if (entity.build_status === AnalysisBuildStatus.STOPPING ||
+                entity.build_status === AnalysisBuildStatus.STARTED ||
+                entity.build_status === AnalysisBuildStatus.STARTING
+            ) {
+                output.success = true;
+                return output;
+            }
+
+            output.message = `The current analysis build status "${entity.build_status}" does not allow a build stop.`;
+            return output;
+        }
+        case AnalysisAPICommand.BUILD_STATUS: {
+            if (!entity.configuration_locked) {
+                output.message = 'The analysis configuration must be locked before checking the build status.';
+                return output;
+            }
+
+            if (!entity.build_status) {
+                output.message = 'The analysis build process has not been initialized.';
+                return output;
+            }
+
+            if (entity.build_status === AnalysisBuildStatus.FINISHED) {
+                output.message = 'The analysis build process has already been successfully completed.';
+                return output;
+            }
+
+            output.success = true;
+            return output;
+        }
+        case AnalysisAPICommand.CONFIGURATION_LOCK: {
+            if (entity.configuration_locked) {
+                output.message = 'The analysis configuration is already locked.';
+                return output;
+            }
+
+            if (entity.build_status) {
+                output.message = 'The analysis build process has already been initialized.';
+                return output;
+            }
+
+            // todo: unknown if one of them is an aggregator.
+            if (entity.nodes < 2) {
+                output.message = 'The analysis requires at least two nodes.';
+                return output;
+            }
+
+            if (!entity.master_image_id) {
+                output.message = 'A master image must be assigned to the analysis.';
+                return output;
+            }
+
+            output.success = true;
+            return output;
+        }
+        case AnalysisAPICommand.CONFIGURATION_UNLOCK: {
+            if (!entity.configuration_locked) {
+                output.message = 'The analysis configuration is already unlocked.';
+                return output;
+            }
+
+            if (!entity.build_status) {
+                output.success = true;
+                return output;
+            }
+
+            if (
+                entity.build_status === AnalysisBuildStatus.FAILED ||
+                entity.build_status === AnalysisBuildStatus.STOPPED ||
+                entity.build_status === AnalysisBuildStatus.STOPPING
+            ) {
+                output.success = true;
+                return output;
+            }
+
+            output.message = `The current analysis build status "${entity.build_status}" does not allow unlocking the configuration.`;
+            return output;
+        }
+    }
+
+    return output;
+}

package/src/domains/analysis/index.ts

@@ -6,4 +6,5 @@
  */
 
 export * from './entity';
+export * from './helpers';
 export * from './constants';

package/src/domains/analysis-bucket/entity.ts

@@ -7,8 +7,6 @@
 
 import type { Realm } from '@authup/core-kit';
 import type { Analysis } from '../analysis';
-import type { DomainType } from '../constants';
-import type { DomainEventBaseContext } from '../types-base';
 import type { AnalysisBucketType } from './constants';
 
 export interface AnalysisBucket {
@@ -34,8 +32,3 @@ export interface AnalysisBucket {
 
     realm_id: Realm['id'];
 }
-
-export type AnalysisBucketEventContext = DomainEventBaseContext & {
-    type: `${DomainType.ANALYSIS_BUCKET}`,
-    data: AnalysisBucket
-};

package/src/domains/analysis-bucket-file/entity.ts

@@ -7,9 +7,7 @@
 
 import type { Realm, Robot, User } from '@authup/core-kit';
 import type { AnalysisBucket } from '../analysis-bucket';
-import type { DomainType } from '../constants';
 import type { Analysis } from '../analysis';
-import type { DomainEventBaseContext } from '../types-base';
 
 export interface AnalysisBucketFile {
     id: string;
@@ -48,8 +46,3 @@ export interface AnalysisBucketFile {
 
     robot_id: Robot['id'] | null;
 }
-
-export type AnalysisFileEventContext = DomainEventBaseContext & {
-    type: `${DomainType.ANALYSIS_BUCKET_FILE}`,
-    data: AnalysisBucketFile
-};

package/src/domains/analysis-log/entity.ts

@@ -6,11 +6,9 @@
  */
 
 import type { Realm } from '@authup/core-kit';
-import type { DomainType } from '../constants';
 import type {
     Analysis,
 } from '../analysis';
-import type { DomainEventBaseContext } from '../types-base';
 
 export interface AnalysisLog {
     id: string;
@@ -71,8 +69,3 @@ export interface AnalysisLog {
 
     realm_id: Realm['id'];
 }
-
-export type AnalysisLogEventContext = DomainEventBaseContext & {
-    type: `${DomainType.ANALYSIS_LOG}`,
-    data: AnalysisLog
-};

package/src/domains/analysis-node/entity.ts

@@ -6,10 +6,8 @@
  */
 
 import type { Realm } from '@authup/core-kit';
-import type { DomainType } from '../constants';
 import type { Node } from '../node';
 import type { Analysis } from '../analysis';
-import type { DomainEventBaseContext } from '../types-base';
 import type { AnalysisNodeApprovalStatus, AnalysisNodeRunStatus } from './constants';
 
 export interface AnalysisNode {
@@ -53,13 +51,3 @@ export interface AnalysisNode {
 
     node_realm_id: Realm['id'];
 }
-
-export type TrainStationEventContext = DomainEventBaseContext & {
-    type: `${DomainType.ANALYSIS_NODE}`,
-    data: AnalysisNode
-};
-
-export type AnalyseNodeSocketEventData = Record<string, { online: boolean, realmId: string }>;
-export type AnalyseNodeSocketCTSEvents = {
-    analysisNodes: (id: Analysis['id'], cb?: (err: null | Error, data: AnalyseNodeSocketEventData) => void) => void
-};

package/src/domains/analysis-permission/entity.ts

@@ -7,8 +7,6 @@
 
 import type { PermissionRelation, Realm } from '@authup/core-kit';
 import type { Analysis } from '../analysis';
-import type { DomainType } from '../constants';
-import type { DomainEventBaseContext } from '../types-base';
 
 export interface AnalysisPermission extends PermissionRelation {
     id: string;
@@ -31,8 +29,3 @@ export interface AnalysisPermission extends PermissionRelation {
 
     updated_at: Date | string;
 }
-
-export type AnalysisPermissionEventContext = DomainEventBaseContext & {
-    type: `${DomainType.ANALYSIS_PERMISSION}`,
-    data: AnalysisPermission
-};

package/src/domains/constants.ts

@@ -7,6 +7,7 @@
 
 export enum DomainType {
     MASTER_IMAGE = 'masterImage',
+    MASTER_IMAGE_EVENT_LOG = 'masterImageEventLog',
     MASTER_IMAGE_GROUP = 'masterImageGroup',
     PROJECT = 'project',
     PROJECT_NODE = 'projectNode',

package/src/domains/index.ts

@@ -14,6 +14,7 @@ export * from './analysis-permission';
 export * from './realm';
 export * from './master-image-group';
 export * from './master-image';
+export * from './master-image-event-log';
 export * from './project';
 export * from './project-node';
 export * from './registry';

package/src/domains/master-image/entity.ts

@@ -5,8 +5,7 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { DomainType } from '../constants';
-import type { DomainEventBaseContext } from '../types-base';
+import type { MasterImageCommandArgument } from './types';
 
 export interface MasterImage {
     id: string;
@@ -21,7 +20,7 @@ export interface MasterImage {
 
     command: string | null;
 
-    command_arguments: any | null;
+    command_arguments: MasterImageCommandArgument[] | null;
 
     // ------------------------------------------------------------------
 
@@ -29,8 +28,3 @@ export interface MasterImage {
 
     updated_at: Date;
 }
-
-export type MasterImageEventContext = DomainEventBaseContext & {
-    type: `${DomainType.MASTER_IMAGE}`,
-    data: MasterImage
-};

package/src/domains/master-image/index.ts

@@ -6,3 +6,4 @@
  */
 export * from './entity';
 export * from './constants';
+export * from './types';

package/src/domains/master-image/types.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2025.
+ *  Author Peter Placzek (tada5hi)
+ *  For the full copyright and license information,
+ *  view the LICENSE file that was distributed with this source code.
+ */
+
+export type MasterImageCommandArgument = {
+    value: string,
+    position?: 'before' | 'after'
+};

package/src/domains/master-image-event-log/entity.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2021-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { MasterImage } from '../master-image';
+
+export interface MasterImageEventLog {
+    id: string;
+
+    name: string;
+
+    data: unknown | null;
+
+    // ------------------------------------------------------------------
+
+    expiring: boolean;
+
+    expires_at: Date;
+
+    // ------------------------------------------------------------------
+
+    master_image_id: string | null;
+
+    master_image: MasterImage | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+}

package/src/domains/master-image-event-log/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2021-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+export * from './entity';

package/src/domains/master-image-group/entity.ts

@@ -5,9 +5,6 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { DomainType } from '../constants';
-import type { DomainEventBaseContext } from '../types-base';
-
 export interface MasterImageGroup {
     id: string;
 
@@ -17,18 +14,9 @@ export interface MasterImageGroup {
 
     virtual_path: string;
 
-    command: string | null;
-
-    command_arguments: any | null;
-
     // ------------------------------------------------------------------
 
     created_at: Date;
 
     updated_at: Date;
 }
-
-export type MasterImageGroupEventContext = DomainEventBaseContext & {
-    type: `${DomainType.MASTER_IMAGE_GROUP}`,
-    data: MasterImageGroup
-};

package/src/domains/node/entity.ts

@@ -6,10 +6,8 @@
  */
 
 import type { Realm, Robot } from '@authup/core-kit';
-import type { DomainType } from '../constants';
 import type { RegistryProject } from '../registry-project';
 import type { Registry } from '../registry';
-import type { DomainEventBaseContext } from '../types-base';
 import type { NodeType } from './constants';
 
 export interface Node {
@@ -17,6 +15,8 @@ export interface Node {
 
     external_name: string | null;
 
+    public_key: string | null;
+
     name: string;
 
     hidden: boolean;
@@ -49,8 +49,3 @@ export interface Node {
 
     updated_at: Date;
 }
-
-export type NodeEventContext = DomainEventBaseContext & {
-    type: `${DomainType.NODE}`,
-    data: Node
-};

package/src/domains/project/entity.ts

@@ -6,9 +6,7 @@
  */
 
 import type { Realm, Robot, User } from '@authup/core-kit';
-import type { DomainType } from '../constants';
 import type { MasterImage } from '../master-image';
-import type { DomainEventBaseContext } from '../types-base';
 
 export interface Project {
     id: string;
@@ -41,8 +39,3 @@ export interface Project {
 
     master_image: MasterImage | null;
 }
-
-export type ProjectEventContext = DomainEventBaseContext & {
-    type: `${DomainType.PROJECT}`,
-    data: Project
-};

package/src/domains/project-node/entity.ts

@@ -6,10 +6,8 @@
  */
 
 import type { Realm } from '@authup/core-kit';
-import type { DomainType } from '../constants';
 import type { Project } from '../project';
 import type { Node } from '../node';
-import type { DomainEventBaseContext } from '../types-base';
 import type { ProjectNodeApprovalStatus } from './constants';
 
 export interface ProjectNode {
@@ -39,8 +37,3 @@ export interface ProjectNode {
 
     node_realm_id: Realm['id'];
 }
-
-export type ProjectNodeEventContext = DomainEventBaseContext & {
-    type: `${DomainType.PROJECT_NODE}`,
-    data: ProjectNode
-};

package/src/domains/registry/entity.ts

@@ -5,9 +5,6 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { DomainType } from '../constants';
-import type { DomainEventBaseContext } from '../types-base';
-
 export interface Registry {
     id: string;
 
@@ -27,8 +24,3 @@ export interface Registry {
 
     updated_at: Date;
 }
-
-export type RegistryEventContext = DomainEventBaseContext & {
-    type: `${DomainType.REGISTRY}`,
-    data: Registry
-};

package/src/domains/registry-project/entity.ts

@@ -6,9 +6,7 @@
  */
 
 import type { Realm } from '@authup/core-kit';
-import type { DomainType } from '../constants';
 import type { Registry } from '../registry';
-import type { DomainEventBaseContext } from '../types-base';
 import type { RegistryProjectType } from './constants';
 
 export interface RegistryProject {
@@ -57,8 +55,3 @@ export interface RegistryProject {
 
     updated_at: Date;
 }
-
-export type RegistryProjectEventContext = DomainEventBaseContext & {
-    type: `${DomainType.REGISTRY_PROJECT}`,
-    data: RegistryProject
-};