@privateaim/core-kit 0.6.0

package/src/domains/analysis/constants.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 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 {
+    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
+    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',
+
+    BUILD_START = 'buildStart',
+    BUILD_STOP = 'buildStop',
+    BUILD_STATUS = 'buildStatus',
+
+    CONFIGURATION_LOCK = 'configurationLock',
+    CONFIGURATION_UNLOCK = 'configurationUnlock',
+}
+
+// -------------------------------------------------------------------------
+
+export enum AnalysisContainerPath {
+    CODE = '/opt/code/',
+}

package/src/domains/analysis/entity.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 { Realm, User } from '@authup/core-kit';
+import type { DomainType } from '../constants';
+import type { MasterImage } from '../master-image';
+import type { Project } from '../project';
+import type { DomainEventBaseContext } from '../types-base';
+import type {
+    AnalysisBuildStatus,
+    AnalysisRunStatus,
+} from './constants';
+import type { Registry } from '../registry';
+
+export interface Analysis {
+    id: string;
+
+    name: string | null;
+
+    nodes: number;
+
+    // ------------------------------------------------------------------
+
+    configuration_locked: boolean;
+
+    // ------------------------------------------------------------------
+
+    build_status: AnalysisBuildStatus | null;
+
+    // ------------------------------------------------------------------
+
+    run_status: AnalysisRunStatus | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    registry: Registry;
+
+    registry_id: Registry['id'];
+
+    // ------------------------------------------------------------------
+
+    realm_id: Realm['id'];
+
+    user_id: User['id'];
+
+    // ------------------------------------------------------------------
+
+    project_id: Project['id'];
+
+    project: Project;
+
+    // ------------------------------------------------------------------
+
+    master_image_id: MasterImage['id'] | null;
+
+    master_image: MasterImage;
+}
+
+export type AnalysisEventContext = DomainEventBaseContext & {
+    type: `${DomainType.ANALYSIS}`,
+    data: Analysis
+};

package/src/domains/analysis/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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';
+export * from './constants';

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

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export enum AnalysisBucketType {
+    CODE = 'CODE',
+    RESULT = 'RESULT',
+    TEMP = 'TEMP',
+}

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

@@ -0,0 +1,41 @@
+/*
+ * 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 { 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 {
+    id: string;
+
+    type: `${AnalysisBucketType}`;
+
+    external_id: string | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    analysis_id: Analysis['id'];
+
+    analysis: Analysis;
+
+    // ------------------------------------------------------------------
+
+    realm_id: Realm['id'];
+}
+
+export type AnalysisBucketEventContext = DomainEventBaseContext & {
+    type: `${DomainType.ANALYSIS_BUCKET}`,
+    data: AnalysisBucket
+};

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

@@ -0,0 +1,10 @@
+/*
+ * 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 './constants';
+export * from './entity';
+export * from './utils';

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

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 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 { Analysis } from '../analysis';
+import { AnalysisBucketType } from './constants';
+
+export function buildAnalysisBucketName(
+    type: `${AnalysisBucketType}`,
+    id: Analysis['id'],
+) {
+    switch (type) {
+        case AnalysisBucketType.CODE: {
+            return `analysis-code-files.${id}`;
+        }
+        case AnalysisBucketType.TEMP: {
+            return `analysis-temp-files.${id}`;
+        }
+        case AnalysisBucketType.RESULT: {
+            return `analysis-result-files.${id}`;
+        }
+    }
+
+    throw new SyntaxError('The argument can only have any bucket type value.');
+}

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

@@ -0,0 +1,55 @@
+/*
+ * 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 { 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;
+
+    name: string;
+
+    root: boolean;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    external_id: string;
+
+    // ------------------------------------------------------------------
+
+    bucket_id: AnalysisBucket['id'];
+
+    bucket: AnalysisBucket;
+
+    // ------------------------------------------------------------------
+
+    analysis_id: Analysis['id'];
+
+    analysis: Analysis;
+
+    // ------------------------------------------------------------------
+
+    realm_id: Realm['id'];
+
+    user_id: User['id'] | null;
+
+    robot_id: Robot['id'] | null;
+}
+
+export type AnalysisFileEventContext = DomainEventBaseContext & {
+    type: `${DomainType.ANALYSIS_BUCKET_FILE}`,
+    data: AnalysisBucketFile
+};

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

@@ -0,0 +1,8 @@
+/*
+ * 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/analysis-log/entity.ts

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2022-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 { 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;
+
+    /**
+     * e.g: building, routing, ...
+     */
+    component: string | null;
+
+    /**
+     * e.g: process, check, stop, ...
+     */
+    command: string | null;
+
+    /**
+     * e.g checking, checked
+     */
+    event: string | null;
+
+    /**
+     * e.g: init, ...
+     */
+    step: string | null;
+
+    error: boolean;
+
+    /**
+     * e.g: trainNotBuild, entrypointNotFound, ...
+     */
+    error_code: string | null;
+
+    /**
+     * e.g. started, finished, failed, ...
+     */
+    status: string | null;
+
+    /**
+     * e.g: error_message
+     */
+    status_message: string | null;
+
+    /**
+     * e.g: {station_id: xxx, station_index: 0}
+     */
+    meta: string | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    analysis_id: Analysis['id'];
+
+    analysis: Analysis;
+
+    realm_id: Realm['id'];
+}
+
+export type AnalysisLogEventContext = DomainEventBaseContext & {
+    type: `${DomainType.ANALYSIS_LOG}`,
+    data: AnalysisLog
+};

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

@@ -0,0 +1,8 @@
+/*
+ * 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/analysis-node/constants.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 enum AnalysisNodeApprovalCommand {
+    APPROVE = 'approve',
+    REJECT = 'reject',
+}
+
+export enum AnalysisNodeApprovalStatus {
+    REJECTED = 'rejected',
+    APPROVED = 'approved',
+}
+
+// -------------------------------------------------------------------------
+
+export enum AnalysisNodeRunStatus {
+    ARRIVED = 'arrived',
+    PULLED = 'pulled',
+    PUSHED = 'pushed', // todo: this won't happen anymore
+    DEPARTED = 'departed', // todo: this won't happen anymore
+    FAILED = 'failed', // todo: this won't happen anymore
+}
+
+// -------------------------------------------------------------------------
+
+export enum AnalysisNodeStatic {
+    INCOMING = 'incoming',
+    OUTGOING = 'outgoing',
+}

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

@@ -0,0 +1,65 @@
+/*
+ * 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 { 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 {
+    id: string;
+
+    // ------------------------------------------------------------------
+
+    approval_status: AnalysisNodeApprovalStatus | null;
+
+    run_status: AnalysisNodeRunStatus | null;
+
+    // ------------------------------------------------------------------
+
+    comment: string;
+
+    index: number;
+
+    // ------------------------------------------------------------------
+
+    artifact_tag: string | null;
+
+    artifact_digest: string | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    analysis_id: Analysis['id'];
+
+    analysis: Analysis;
+
+    analysis_realm_id: Realm['id'];
+
+    node_id: Node['id'];
+
+    node: Node;
+
+    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-node/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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';
+export * from './constants';

package/src/domains/constants.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export enum DomainType {
+    MASTER_IMAGE = 'masterImage',
+    MASTER_IMAGE_GROUP = 'masterImageGroup',
+    PROJECT = 'project',
+    PROJECT_NODE = 'projectNode',
+    REGISTRY = 'registry',
+    REGISTRY_PROJECT = 'registryProject',
+    NODE = 'node',
+    SERVICE = 'service',
+    ANALYSIS = 'analysis',
+    ANALYSIS_BUCKET = 'analysisBucket',
+    ANALYSIS_BUCKET_FILE = 'analysisBucketFile',
+    ANALYSIS_LOG = 'analysisLog',
+    ANALYSIS_NODE = 'analysisNode',
+}
+
+export enum DomainSubType {
+    PROJECT_NODE_IN = 'projectNodeIn',
+    PROJECT_NODE_OUT = 'projectNodeOut',
+    ANALYSIS_NODE_IN = 'analysisNodeIn',
+    ANALYSIS_NODE_OUT = 'analysisNodeOut',
+}
+
+export enum DomainEventName {
+    CREATED = 'created',
+    DELETED = 'deleted',
+    UPDATED = 'updated',
+}
+
+export enum DomainEventSubscriptionName {
+    SUBSCRIBE = 'subscribe',
+    UNSUBSCRIBE = 'unsubscribe',
+}

package/src/domains/index.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 './analysis';
+export * from './analysis-bucket';
+export * from './analysis-bucket-file';
+export * from './analysis-log';
+export * from './analysis-node';
+export * from './permission';
+export * from './realm';
+export * from './master-image-group';
+export * from './master-image';
+export * from './project';
+export * from './project-node';
+export * from './registry';
+export * from './registry-project';
+export * from './node';
+export * from './service';
+export * from './constants';
+export * from './types';
+export * from './types-base';
+export * from './utils';

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

@@ -0,0 +1,15 @@
+/*
+ * 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 enum MasterImageCommand {
+    SYNC = 'sync',
+}
+
+export enum MasterImageGroupType {
+    LANGUAGE = 'language',
+    DEFAULT = 'default',
+}

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

@@ -0,0 +1,36 @@
+/*
+ * 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 { DomainType } from '../constants';
+import type { DomainEventBaseContext } from '../types-base';
+
+export interface MasterImage {
+    id: string;
+
+    path: string | null;
+
+    virtual_path: string;
+
+    group_virtual_path: string;
+
+    name: string;
+
+    command: string | null;
+
+    command_arguments: any | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+}
+
+export type MasterImageEventContext = DomainEventBaseContext & {
+    type: `${DomainType.MASTER_IMAGE}`,
+    data: MasterImage
+};

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

@@ -0,0 +1,8 @@
+/*
+ * 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';
+export * from './constants';

package/src/domains/master-image-group/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 { DomainType } from '../constants';
+import type { DomainEventBaseContext } from '../types-base';
+
+export interface MasterImageGroup {
+    id: string;
+
+    name: string;
+
+    path: string;
+
+    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
+};