@privateaim/core-kit 0.6.0

package/src/domains/master-image-group/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/node/constants.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 NodeType {
+    AGGREGATOR = 'aggregator',
+    DEFAULT = 'default',
+}
+
+export enum NodeSocketClientEventName {
+    CONNECT = 'nodeConnect',
+    DISCONNECT = 'nodeDisconnect',
+    MESSAGE = 'nodeMessage',
+}
+
+export enum NodeSocketServerEventName {
+    CONNECTED = 'nodeConnected',
+    DISCONNECTED = 'nodeDisconnected',
+    MESSAGE = 'nodeMessage',
+}

package/src/domains/node/entity.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 } 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 {
+    id: string;
+
+    external_name: string | null;
+
+    name: string;
+
+    hidden: boolean;
+
+    type: `${NodeType}`;
+
+    online: boolean;
+
+    // ------------------------------------------------------------------
+
+    registry_id: Registry['id'];
+
+    registry: Registry;
+
+    registry_project_id: RegistryProject['id'] | null;
+
+    registry_project: RegistryProject;
+
+    // ------------------------------------------------------------------
+
+    robot_id: Robot['id'] | null;
+
+    // ------------------------------------------------------------------
+
+    realm_id: Realm['id'];
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+}
+
+export type NodeEventContext = DomainEventBaseContext & {
+    type: `${DomainType.NODE}`,
+    data: Node
+};

package/src/domains/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 './constants';
+export * from './entity';

package/src/domains/permission/constants.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 { PermissionName as AuthPermissionName } from '@authup/core-kit';
+
+export enum PermissionKey {
+    BUCKET_ADD = 'bucket_add',
+    BUCKET_EDIT = 'bucket_edit',
+    BUCKET_DROP = 'bucket_drop',
+
+    PROJECT_ADD = 'project_add',
+    PROJECT_DROP = 'project_drop',
+    PROJECT_EDIT = 'project_edit',
+    PROJECT_APPROVE = 'project_approve',
+
+    REGISTRY_MANAGE = 'registry_manage',
+    REGISTRY_PROJECT_MANAGE = 'registry_project_manage',
+
+    NODE_ADD = 'node_add',
+    NODE_DROP = 'node_drop',
+    NODE_EDIT = 'node_edit',
+
+    ANALYSIS_APPROVE = 'analysis_approve',
+    ANALYSIS_EDIT = 'analysis_edit',
+    ANALYSIS_ADD = 'analysis_add',
+    ANALYSIS_EXECUTION_START = 'analysis_execution_start',
+    ANALYSIS_EXECUTION_STOP = 'analysis_execution_stop',
+    ANALYSIS_DROP = 'analysis_drop',
+    ANALYSIS_RESULT_READ = 'analysis_result_read', // todo: this is maybe not required anymore
+
+    MASTER_IMAGE_MANAGE = 'master_image_manage',
+    MASTER_IMAGE_GROUP_MANAGE = 'master_image_group_manage',
+
+    SERVICE_MANAGE = 'service_manage',
+}
+
+export const PermissionID = {
+    ...PermissionKey,
+    ...AuthPermissionName,
+};
+
+export type PermissionIDType = typeof PermissionID[keyof typeof PermissionID];

package/src/domains/permission/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 './constants';

package/src/domains/project/entity.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 { DomainEventBaseContext } from '../types-base';
+
+export interface Project {
+    id: string;
+
+    name: string;
+
+    analyses: number;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    realm_id: Realm['id'];
+
+    user_id: User['id'];
+
+    master_image_id: MasterImage['id'] | null;
+
+    master_image: MasterImage | null;
+}
+
+export type ProjectEventContext = DomainEventBaseContext & {
+    type: `${DomainType.PROJECT}`,
+    data: Project
+};

package/src/domains/project/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/project-node/constants.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 ProjectNodeApprovalCommand {
+    APPROVE = 'approve',
+    REJECT = 'reject',
+}
+
+export enum ProjectNodeApprovalStatus {
+    REJECTED = 'rejected',
+    APPROVED = 'approved',
+}

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

@@ -0,0 +1,46 @@
+/*
+ * 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 { Project } from '../project';
+import type { Node } from '../node';
+import type { DomainEventBaseContext } from '../types-base';
+import type { ProjectNodeApprovalStatus } from './constants';
+
+export interface ProjectNode {
+    id: string;
+
+    approval_status: ProjectNodeApprovalStatus | null;
+
+    comment: string | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+
+    // ------------------------------------------------------------------
+
+    project_id: Project['id'];
+
+    project: Project;
+
+    project_realm_id: Realm['id'];
+
+    node_id: Node['id'];
+
+    node: Node;
+
+    node_realm_id: Realm['id'];
+}
+
+export type ProjectNodeEventContext = DomainEventBaseContext & {
+    type: `${DomainType.PROJECT_NODE}`,
+    data: ProjectNode
+};

package/src/domains/project-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 './constants';
+export * from './entity';

package/src/domains/realm/index.ts

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

package/src/domains/realm/socket.ts

@@ -0,0 +1,18 @@
+/*
+ * 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';
+
+export function buildSocketRealmNamespaceName(realmId: Realm['id']) {
+    return `/resources#${realmId}`;
+}
+
+export function parseSocketRealmNamespaceName(name: string) : string | undefined {
+    return name.startsWith('/resources#') ?
+        name.substring('/resources#'.length) :
+        name;
+}

package/src/domains/registry/constants.ts

@@ -0,0 +1,8 @@
+/*
+ * 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 const registryRobotSecretRegex = /^(?=.*[A-Z])(?=.*[a-z])(?=.*\d).{8,}$/;

package/src/domains/registry/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 Registry {
+    id: string;
+
+    name: string;
+
+    host: string;
+
+    // ------------------------------------------------------------------
+
+    account_name: string | null;
+
+    account_secret: string | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+}
+
+export type RegistryEventContext = DomainEventBaseContext & {
+    type: `${DomainType.REGISTRY}`,
+    data: Registry
+};

package/src/domains/registry/index.ts

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

package/src/domains/registry/utils.ts

@@ -0,0 +1,15 @@
+/*
+ * 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 { Registry } from './entity';
+
+export function buildRegistryClientConnectionStringFromRegistry(entity: Registry) {
+    // todo: support other registries beside harbor and v2.0
+
+    const url = `https://${entity.host}/api/v2.0/`;
+    return `${entity.account_name}:${entity.account_secret}@${url}`;
+}

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

@@ -0,0 +1,15 @@
+/*
+ * 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.
+ */
+
+export enum RegistryProjectType {
+    DEFAULT = 'default',
+    AGGREGATOR = 'aggregator',
+    INCOMING = 'incoming',
+    OUTGOING = 'outgoing',
+    MASTER_IMAGES = 'masterImages',
+    NODE = 'node',
+}

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

@@ -0,0 +1,64 @@
+/*
+ * 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 { Registry } from '../registry';
+import type { DomainEventBaseContext } from '../types-base';
+import type { RegistryProjectType } from './constants';
+
+export interface RegistryProject {
+    id: string;
+
+    name: string;
+
+    type: `${RegistryProjectType}`;
+
+    public: boolean;
+
+    // ------------------------------------------------------------------
+
+    // a-z0-9-_ {0,255}
+    external_name: string;
+
+    external_id: string | null;
+
+    // ------------------------------------------------------------------
+
+    account_id: string | null;
+
+    account_name: string | null;
+
+    account_secret: string | null;
+
+    // ------------------------------------------------------------------
+
+    webhook_name: string | null;
+
+    webhook_exists: boolean | null;
+
+    // ------------------------------------------------------------------
+
+    registry_id: Registry['id'];
+
+    registry: Registry;
+
+    // ------------------------------------------------------------------
+
+    realm_id: Realm['id'] | null;
+
+    // ------------------------------------------------------------------
+
+    created_at: Date;
+
+    updated_at: Date;
+}
+
+export type RegistryProjectEventContext = DomainEventBaseContext & {
+    type: `${DomainType.REGISTRY_PROJECT}`,
+    data: RegistryProject
+};

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

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

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

@@ -0,0 +1,12 @@
+/*
+ * 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 { RegistryProject } from './entity';
+
+export function buildSocketRegistryProjectRoomName(id?: RegistryProject['id']) {
+    return `registry-projects${id ? `#${id}` : ''}`;
+}

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

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+import { createNanoID } from '@privateaim/kit';
+
+export function generateRegistryProjectId() {
+    return createNanoID('0123456789abcdefghijklmnopqrstuvwxyz');
+}

package/src/domains/service/constants.ts

@@ -0,0 +1,14 @@
+/*
+ * 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 ServiceID {
+    // Core Service(s)
+    SYSTEM = 'system',
+
+    // Third Party Service(s)
+    REGISTRY = 'registry',
+}

package/src/domains/service/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 './registry';
+export * from './secret-engine';
+export * from './constants';
+export * from './station-registry';

package/src/domains/service/registry/constants.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 RegistryAPICommand {
+    SETUP = 'setup',
+    CLEANUP = 'cleanup',
+    DELETE = 'delete',
+
+    PROJECT_LINK = 'projectLink',
+    PROJECT_UNLINK = 'projectUnlink',
+}
+
+/**
+ * Incoming train project name
+ */
+export const REGISTRY_INCOMING_PROJECT_NAME = 'incoming';
+
+/**
+ * Outgoing train project name
+ */
+export const REGISTRY_OUTGOING_PROJECT_NAME = 'outgoing';
+
+/**
+ * Master Image project name
+ */
+export const REGISTRY_MASTER_IMAGE_PROJECT_NAME = 'master';
+
+/**
+ * Latest image tag
+ */
+export const REGISTRY_ARTIFACT_TAG_LATEST = 'latest';
+
+/**
+ * base image tag
+ */
+export const REGISTRY_ARTIFACT_TAG_BASE = 'base';

package/src/domains/service/registry/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 './constants';

package/src/domains/service/secret-engine/constants.ts

@@ -0,0 +1,14 @@
+/*
+ * 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 SecretStorageAPICommand {
+    ENGINE_CREATE = 'engineCreate',
+
+    ENGINE_KEY_SAVE = 'engineKeySave',
+    ENGINE_KEY_PULL = 'engineKeyPull',
+    ENGINE_KEY_DROP = 'engineKeyDrop',
+}

package/src/domains/service/secret-engine/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 './constants';
+export * from './type';

package/src/domains/service/secret-engine/type.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.
+ */
+
+import type { SecretStorageAPICommand } from './constants';
+
+export type SecretStorageCommandType = `${SecretStorageAPICommand}`;

package/src/domains/service/station-registry/constants.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 enum StationRegistryAPICommand {
+    SYNC = 'sync',
+}

package/src/domains/service/station-registry/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 './constants';

package/src/domains/types-base.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 { DomainEventName } from './constants';
+
+export type DomainEntityWithID = {
+    [key: string]: any,
+    id: any
+};
+export type DomainEntityID<T> = T extends DomainEntityWithID ?
+    T['id'] :
+    never;
+
+export type DomainEventBaseContext = {
+    event: `${DomainEventName}`,
+    type: string
+};