@privateaim/core-kit 0.6.0

package/src/domains/types.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 type { AnalysisBucket, AnalysisBucketEventContext } from './analysis-bucket';
+import type {
+    DomainEventName, DomainEventSubscriptionName, DomainSubType, DomainType,
+} from './constants';
+import type { MasterImage, MasterImageEventContext } from './master-image';
+import type { MasterImageGroup, MasterImageGroupEventContext } from './master-image-group';
+import type { Project, ProjectEventContext } from './project';
+import type { ProjectNode, ProjectNodeEventContext } from './project-node';
+import type { Registry, RegistryEventContext } from './registry';
+import type { RegistryProject, RegistryProjectEventContext } from './registry-project';
+import type { Node, NodeEventContext } from './node';
+import type { Analysis, AnalysisEventContext } from './analysis';
+import type { AnalysisBucketFile, AnalysisFileEventContext } from './analysis-bucket-file';
+import type { AnalysisLog, AnalysisLogEventContext } from './analysis-log';
+import type { AnalysisNode, TrainStationEventContext } from './analysis-node';
+
+export type DomainsEventContext = MasterImageEventContext |
+MasterImageGroupEventContext |
+ProjectEventContext |
+ProjectNodeEventContext |
+RegistryEventContext |
+RegistryProjectEventContext |
+NodeEventContext |
+AnalysisEventContext |
+AnalysisLogEventContext |
+AnalysisFileEventContext |
+TrainStationEventContext;
+
+export type DomainEventContext<T extends `${DomainType}` | `${DomainSubType}`> =
+    T extends `${DomainType.MASTER_IMAGE}` ?
+        MasterImageEventContext :
+        T extends `${DomainType.MASTER_IMAGE_GROUP}` ?
+            MasterImageGroupEventContext :
+            T extends `${DomainType.PROJECT}` ?
+                ProjectEventContext :
+                T extends `${DomainType.PROJECT_NODE}` | `${DomainSubType.PROJECT_NODE_IN}` | `${DomainSubType.PROJECT_NODE_OUT}` ?
+                    ProjectNodeEventContext :
+                    T extends `${DomainType.REGISTRY}` ?
+                        RegistryEventContext :
+                        T extends `${DomainType.REGISTRY_PROJECT}` ?
+                            RegistryProjectEventContext :
+                            T extends `${DomainType.NODE}` ?
+                                NodeEventContext :
+                                T extends `${DomainType.ANALYSIS}` ?
+                                    AnalysisEventContext :
+                                    T extends `${DomainType.ANALYSIS_BUCKET}` ?
+                                        AnalysisBucketEventContext :
+                                        T extends `${DomainType.ANALYSIS_LOG}` ?
+                                            AnalysisLogEventContext :
+                                            T extends `${DomainType.ANALYSIS_BUCKET_FILE}` ?
+                                                AnalysisFileEventContext :
+                                                T extends `${DomainType.ANALYSIS_NODE}` | `${DomainSubType.ANALYSIS_NODE_IN}` | `${DomainSubType.ANALYSIS_NODE_OUT}` ?
+                                                    TrainStationEventContext :
+                                                    never;
+
+export type DomainEntity<T extends `${DomainType}` | `${DomainSubType}`> =
+    T extends `${DomainType.MASTER_IMAGE}` ?
+        MasterImage :
+        T extends `${DomainType.MASTER_IMAGE_GROUP}` ?
+            MasterImageGroup :
+            T extends `${DomainType.PROJECT}` ?
+                Project :
+                T extends `${DomainType.PROJECT_NODE}` | `${DomainSubType.PROJECT_NODE_IN}` | `${DomainSubType.PROJECT_NODE_OUT}` ?
+                    ProjectNode :
+                    T extends `${DomainType.REGISTRY}` ?
+                        Registry :
+                        T extends `${DomainType.REGISTRY_PROJECT}` ?
+                            RegistryProject :
+                            T extends `${DomainType.NODE}` ?
+                                Node :
+                                T extends `${DomainType.ANALYSIS}` ?
+                                    Analysis :
+                                    T extends `${DomainType.ANALYSIS_BUCKET}` ?
+                                        AnalysisBucket :
+                                        T extends `${DomainType.ANALYSIS_LOG}` ?
+                                            AnalysisLog :
+                                            T extends `${DomainType.ANALYSIS_BUCKET_FILE}` ?
+                                                AnalysisBucketFile :
+                                                T extends `${DomainType.ANALYSIS_NODE}` | `${DomainSubType.ANALYSIS_NODE_IN}` | `${DomainSubType.ANALYSIS_NODE_OUT}` ?
+                                                    AnalysisNode :
+                                                    never;
+
+export type DomainInput = `${DomainType}` | DomainType | `${DomainSubType}` | DomainSubType;
+
+export type DomainEventFullName<
+    T extends DomainInput = DomainInput,
+> = `${T}${Capitalize<`${DomainEventName}`>}`;
+
+export type DomainEventSubscriptionFullName<
+    T extends DomainInput = DomainInput,
+> = `${T}${Capitalize<`${DomainEventSubscriptionName}`>}`;

package/src/domains/utils.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 {
+    DomainEventName, DomainEventSubscriptionName,
+} from './constants';
+import type { DomainEventFullName, DomainEventSubscriptionFullName, DomainInput } from './types';
+
+export function buildDomainEventFullName<T extends DomainInput>(
+    type: T,
+    event: `${DomainEventName}` | DomainEventName,
+) : DomainEventFullName<T> {
+    const eventCapitalized = event.substring(0, 1).toUpperCase() + event.substring(1);
+
+    return type + eventCapitalized as DomainEventFullName<T>;
+}
+
+export function buildDomainEventSubscriptionFullName<
+    T extends DomainInput,
+>(
+    type: T,
+    event: `${DomainEventSubscriptionName}` | DomainEventSubscriptionName,
+) : DomainEventSubscriptionFullName<T> {
+    const eventCapitalized = event.substring(0, 1).toUpperCase() + event.substring(1);
+
+    return type + eventCapitalized as DomainEventSubscriptionFullName<T>;
+}
+
+export function buildDomainChannelName(type: DomainInput, id?: string | number) {
+    return `${type}${id ? `:${id}` : ''}`;
+}
+
+export function buildDomainNamespaceName(id?: string) {
+    return id ?
+        `/resources#${id}` :
+        '/resources';
+}

package/src/error/constants.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 enum ErrorCode {
+    LICENSE_AGREEMENT = 'license_agreement',
+}

package/src/error/entities/connection-string.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 class APIConnectionStringError extends Error {
+    static connectionStringMissing(serviceName?: string) {
+        const parts : string[] = ['The'];
+        if (typeof serviceName === 'string') {
+            parts.push(serviceName);
+        }
+        parts.push('connection string is not specified.');
+        return new this(parts.join(' '));
+    }
+
+    static connectionStringInvalid(serviceName?: string) {
+        const parts : string[] = ['The'];
+        if (typeof serviceName === 'string') {
+            parts.push(serviceName);
+        }
+        parts.push('connection string is not valid.');
+        return new this(parts.join(' '));
+    }
+}

package/src/error/entities/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 './connection-string';

package/src/error/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 './entities';

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

package/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+    "extends": "../../tsconfig.build.json",
+
+    "compilerOptions": {
+        "outDir": "./dist"
+    },
+
+    "include": [
+        "src/**/*.ts"
+    ]
+}

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "paths": {
+            "@privateaim/kit": [
+                "./packages/kit/src"
+            ]
+        }
+    }
+}