@privateaim/core-kit 0.8.21 → 0.8.23

package/src/domains/analysis/constants.ts

@@ -5,72 +5,13 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-export enum AnalysisBuildStatus {
-    STARTING = 'starting', // ui trigger
-    STARTED = 'started', // tb trigger
-
-    STOPPING = 'stopping', // ui trigger
-    STOPPED = 'stopped', // tb trigger
-
-    FINISHED = 'finished', // tb trigger
-    FAILED = 'failed', // tb trigger
-}
-
-// -------------------------------------------------------------------------
-
-export enum AnalysisConfigurationStatus {
-    NODES = 'nodes',
-    MASTER_IMAGE = 'masterImage',
-    FILES = 'files',
-    FINISHED = 'finished',
-}
-
-// -------------------------------------------------------------------------
-
-export enum AnalysisRunStatus {
-    STARTING = 'starting',
-    STARTED = 'started',
-
-    RUNNING = 'running',
-
-    STOPPING = 'stopping',
-    STOPPED = 'stopped',
-
-    FINISHED = 'finished',
-    FAILED = 'failed',
-}
-
-// -------------------------------------------------------------------------
-
-export enum AnalysisResultStatus {
-    STARTED = 'started',
-
-    DOWNLOADING = 'downloading',
-    DOWNLOADED = 'downloaded',
-
-    PROCESSING = 'extracting',
-    PROCESSED = 'extracted',
-
-    FINISHED = 'finished',
-    FAILED = 'failed',
-}
-
-// -------------------------------------------------------------------------
-
-export enum AnalysisAPICommand {
-    SPIN_UP = 'spinUp',
-    TEAR_DOWN = 'tearDown',
-
+export enum AnalysisCommand {
     BUILD_START = 'buildStart',
-    BUILD_STOP = 'buildStop',
-    BUILD_STATUS = 'buildStatus',
+    BUILD_CHECK = 'buildCheck',
 
     CONFIGURATION_LOCK = 'configurationLock',
     CONFIGURATION_UNLOCK = 'configurationUnlock',
-}
-
-// -------------------------------------------------------------------------
 
-export enum AnalysisContainerPath {
-    CODE = '/opt/code/',
+    DISTRIBUTION_START = 'distributionStart',
+    DISTRIBUTION_CHECK = 'distributionCheck',
 }

package/src/domains/analysis/entity.ts

@@ -6,12 +6,9 @@
  */
 
 import type { Realm, User } from '@authup/core-kit';
+import type { ProcessStatus } from '@privateaim/kit';
 import type { MasterImage, MasterImageCommandArgument } from '../master-image';
 import type { Project } from '../project';
-import type {
-    AnalysisBuildStatus,
-    AnalysisRunStatus,
-} from './constants';
 import type { Registry } from '../registry';
 
 export interface Analysis {
@@ -21,8 +18,18 @@ export interface Analysis {
 
     description: string | null;
 
+    // ------------------------------------------------------------------
+
+    /**
+     * Amount of nodes assigned to the analysis.
+     */
     nodes: number;
 
+    /**
+     * Amount of nodes which approved the analysis.
+     */
+    nodes_approved: number;
+
     // ------------------------------------------------------------------
 
     configuration_locked: boolean;
@@ -54,23 +61,47 @@ export interface Analysis {
 
     // ------------------------------------------------------------------
 
-    build_status: AnalysisBuildStatus | null;
+    build_status: `${ProcessStatus}` | null;
 
-    // ------------------------------------------------------------------
+    /**
+     * Define if the node constraints are satisfied for the build process.
+     */
+    build_nodes_valid: boolean;
 
     /**
-     * todo: add distribution_status
+     * Percentage for building image
      */
+    build_progress: number | null;
+
+    /**
+     * Hash for build process.
+     */
+    build_hash: string | null;
+
+    /**
+     * Operating system
+     */
+    build_os: string | null;
 
-    // ------------------------------------------------------------------
     /**
-     * todo: rename to execution_status
+     * Size in bytes
      */
-    run_status: AnalysisRunStatus | null;
+    build_size: number | null;
+
+    // ------------------------------------------------------------------
+
+    distribution_status: `${ProcessStatus}` | null;
 
     /**
-     * todo: add execution_progress
+     * Percentage for distributing image
      */
+    distribution_progress: number | null;
+
+    // ------------------------------------------------------------------
+
+    execution_status: `${ProcessStatus}` | null;
+
+    execution_progress: number | null;
 
     // ------------------------------------------------------------------
 

package/src/domains/analysis/error.ts

@@ -5,7 +5,13 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-export class AnalysisError extends Error {
+import { HubError } from '@privateaim/kit';
+
+export class AnalysisError extends HubError {
+    static notFound() {
+        return new AnalysisError('The Analysis could not be found.');
+    }
+
     static defaultNodeRequired() {
         return new AnalysisError('At least one default node must be selected.');
     }
@@ -14,6 +20,10 @@ export class AnalysisError extends Error {
         return new AnalysisError('An aggregator node node must be selected.');
     }
 
+    static nodesApprovalRequired() {
+        return new AnalysisError('All assigned nodes have to approve the analysis.');
+    }
+
     static entrypointRequired() {
         return new AnalysisError('An entrypoint must be selected.');
     }
@@ -26,6 +36,10 @@ export class AnalysisError extends Error {
         return new AnalysisError('The analysis configuration is locked.');
     }
 
+    static configurationNotLocked() {
+        return new AnalysisError('The analysis configuration is not locked.');
+    }
+
     static buildInitialized() {
         return new AnalysisError('The analysis build process has already been initialized.');
     }

package/src/domains/analysis/helpers/builder.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 { ProcessStatus } from '@privateaim/kit';
+import type { Analysis } from '../entity';
+import { AnalysisError } from '../error';
+
+export class AnalysisBuilderCommandChecker {
+    /**
+     * Verify if the build start process can be triggered.
+     *
+     * @param entity
+     */
+    static canStart(entity: Analysis) {
+        if (!entity.configuration_locked) {
+            throw AnalysisError.configurationNotLocked();
+        }
+
+        if (!entity.build_nodes_valid) {
+            throw AnalysisError.nodesApprovalRequired();
+        }
+
+        if (!entity.build_status) {
+            return;
+        }
+
+        if (
+            entity.build_status === ProcessStatus.FAILED ||
+            entity.build_status === ProcessStatus.STOPPED
+        ) {
+            return;
+        }
+
+        throw new AnalysisError('The analysis build can not be started.');
+    }
+
+    /**
+     * Check if the build check process can be triggered.
+     *
+     * @param entity
+     */
+    static canCheck(entity: Analysis) {
+        if (!entity.configuration_locked) {
+            throw new AnalysisError('The analysis configuration must be locked before checking the build status.');
+        }
+
+        if (!entity.build_status) {
+            throw new AnalysisError('The analysis build process has not been initialized.');
+        }
+
+        if (entity.build_status === ProcessStatus.FINISHED) {
+            throw new AnalysisError('The analysis build process has already been successfully completed.');
+        }
+
+        // todo: check time
+    }
+}

package/src/domains/analysis/helpers/configurator.ts

@@ -0,0 +1,68 @@
+/*
+ * 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 { ProcessStatus } from '@privateaim/kit';
+import type { Analysis } from '../entity';
+import { AnalysisError } from '../error';
+
+export class AnalysisConfiguratorCommandChecker {
+    /**
+     * Check if the analysis configuration can be locked.
+     *
+     * @param entity
+     */
+    static canLock(entity: Analysis) : void {
+        if (entity.configuration_locked) {
+            throw AnalysisError.configurationLocked();
+        }
+
+        if (entity.build_status) {
+            throw AnalysisError.buildInitialized();
+        }
+
+        if (!entity.configuration_node_default_valid) {
+            throw AnalysisError.defaultNodeRequired();
+        }
+
+        if (!entity.configuration_node_aggregator_valid) {
+            throw AnalysisError.aggregatorNodeRequired();
+        }
+
+        if (!entity.configuration_entrypoint_valid) {
+            throw AnalysisError.entrypointRequired();
+        }
+
+        if (!entity.configuration_image_valid) {
+            throw AnalysisError.imageAssignmentRequired();
+        }
+    }
+
+    /**
+     * Check if the analysis configuration can be unlocked.
+     *
+     * @param entity
+     */
+    static canUnlock(entity: Analysis): void {
+        if (!entity.configuration_locked) {
+            throw new AnalysisError('The analysis configuration is already unlocked.');
+        }
+
+        if (!entity.distribution_status) {
+            return;
+        }
+
+        if (
+            entity.build_status === ProcessStatus.FAILED ||
+            entity.build_status === ProcessStatus.STOPPED ||
+            entity.build_status === ProcessStatus.STOPPING
+        ) {
+            return;
+        }
+
+        throw new AnalysisError('The analysis configuration can not be unlocked.');
+    }
+}

package/src/domains/analysis/helpers/distributor.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 { ProcessStatus } from '@privateaim/kit';
+import type { Analysis } from '../entity';
+import { AnalysisError } from '../error';
+
+export class AnalysisDistributorCommandChecker {
+    /**
+     * Check if the distribution start process can be triggered.
+     *
+     * @param entity
+     */
+    static canStart(entity: Analysis) {
+        if (!entity.build_status || entity.build_status !== ProcessStatus.FINISHED) {
+            throw new AnalysisError('The analysis is not built yet.');
+        }
+    }
+
+    /**
+     * Check if the distribution check process can be triggered.
+     *
+     * @param entity
+     */
+    static canCheck(entity: Analysis) {
+        if (!entity.build_status) {
+            throw new AnalysisError('The analysis build process has not been initialized.');
+        }
+
+        if (entity.build_status !== ProcessStatus.FINISHED) {
+            throw new AnalysisError('The analysis build process has not been finished.');
+        }
+
+        // todo: check time
+    }
+}

package/src/domains/analysis/helpers/index.ts

@@ -0,0 +1,10 @@
+/*
+ * 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 * from './builder';
+export * from './configurator';
+export * from './distributor';

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

@@ -14,13 +14,9 @@ export interface AnalysisBucket {
 
     type: `${AnalysisBucketType}`;
 
-    external_id: string | null;
-
     // ------------------------------------------------------------------
 
-    created_at: Date;
-
-    updated_at: Date;
+    bucket_id: string;
 
     // ------------------------------------------------------------------
 
@@ -31,4 +27,10 @@ export interface AnalysisBucket {
     // ------------------------------------------------------------------
 
     realm_id: Realm['id'];
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
 }

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

@@ -5,14 +5,16 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { Realm, Robot, User } from '@authup/core-kit';
+import type {
+    Client, Realm, Robot, User,
+} from '@authup/core-kit';
 import type { AnalysisBucket } from '../analysis-bucket';
 import type { Analysis } from '../analysis';
 
 export interface AnalysisBucketFile {
     id: string;
 
-    name: string;
+    path: string;
 
     root: boolean;
 
@@ -24,13 +26,15 @@ export interface AnalysisBucketFile {
 
     // ------------------------------------------------------------------
 
-    external_id: string;
+    bucket_id: string;
+
+    bucket_file_id: string;
 
     // ------------------------------------------------------------------
 
-    bucket_id: AnalysisBucket['id'];
+    analysis_bucket_id: AnalysisBucket['id'];
 
-    bucket: AnalysisBucket;
+    analysis_bucket: AnalysisBucket;
 
     // ------------------------------------------------------------------
 
@@ -42,6 +46,8 @@ export interface AnalysisBucketFile {
 
     realm_id: Realm['id'];
 
+    client_id: Client['id'] | null;
+
     user_id: User['id'] | null;
 
     robot_id: Robot['id'] | null;

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

@@ -14,18 +14,3 @@ export enum AnalysisNodeApprovalStatus {
     REJECTED = 'rejected',
     APPROVED = 'approved',
 }
-
-// -------------------------------------------------------------------------
-
-export enum AnalysisNodeRunStatus {
-    STARTING = 'starting',
-    STARTED = 'started',
-
-    STOPPING = 'stopping',
-    STOPPED = 'stopped',
-
-    RUNNING = 'running',
-    FINISHED = 'finished',
-
-    FAILED = 'failed',
-}

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

@@ -6,9 +6,10 @@
  */
 
 import type { Realm } from '@authup/core-kit';
+import type { ProcessStatus } from '@privateaim/kit';
 import type { Node } from '../node';
 import type { Analysis } from '../analysis';
-import type { AnalysisNodeApprovalStatus, AnalysisNodeRunStatus } from './constants';
+import type { AnalysisNodeApprovalStatus } from './constants';
 
 export interface AnalysisNode {
     id: string;
@@ -19,7 +20,9 @@ export interface AnalysisNode {
 
     // ------------------------------------------------------------------
 
-    run_status: AnalysisNodeRunStatus | null;
+    execution_status: ProcessStatus | null;
+
+    execution_progress: number | null;
 
     // ------------------------------------------------------------------
 

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

@@ -25,7 +25,7 @@ export interface AnalysisPermission extends PermissionRelation {
 
     // ------------------------------------------------------------------
 
-    created_at: Date | string;
+    created_at: string;
 
-    updated_at: Date | string;
+    updated_at: string;
 }

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

@@ -5,11 +5,16 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
+import type { ProcessStatus } from '@privateaim/kit';
 import type { MasterImageCommandArgument } from './types';
 
 export interface MasterImage {
     id: string;
 
+    build_status: `${ProcessStatus}` | null;
+
+    build_progress: number | null;
+
     path: string | null;
 
     virtual_path: string;

package/src/domains/node/entity.ts

@@ -5,7 +5,7 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import type { Realm, Robot } from '@authup/core-kit';
+import type { Client, Realm, Robot } from '@authup/core-kit';
 import type { RegistryProject } from '../registry-project';
 import type { Registry } from '../registry';
 import type { NodeType } from './constants';
@@ -37,6 +37,11 @@ export interface Node {
 
     // ------------------------------------------------------------------
 
+    client_id: Client['id'] | null;
+
+    /**
+     * @deprecated
+     */
     robot_id: Robot['id'] | null;
 
     // ------------------------------------------------------------------

package/dist/domains/analysis/helpers.d.ts

@@ -1,15 +0,0 @@
-import { AnalysisAPICommand } 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 declare function isAnalysisAPICommandExecutable(entity: Analysis, command: `${AnalysisAPICommand}`): CanResult;
-export {};
-//# sourceMappingURL=helpers.d.ts.map

package/dist/domains/analysis/helpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/domains/analysis/helpers.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,kBAAkB,EAAuB,MAAM,aAAa,CAAC;AACtE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGzC,KAAK,SAAS,GAAG;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC1C,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,GAAG,kBAAkB,EAAE,GAChC,SAAS,CAyIZ"}