@privateaim/core-http-kit 0.4.0

package/src/domains/base.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 { createClient, isClient } from 'hapic';
+import type { Client, RequestBaseOptions } from 'hapic';
+import type { BaseAPIContext } from './types-base';
+
+export class BaseAPI {
+    protected client! : Client;
+
+    // -----------------------------------------------------------------------------------
+
+    constructor(context?: BaseAPIContext) {
+        context = context || {};
+
+        this.setClient(context.client);
+    }
+
+    // -----------------------------------------------------------------------------------
+
+    setClient(input?: Client | RequestBaseOptions) {
+        this.client = isClient(input) ?
+            input :
+            createClient(input);
+    }
+}

package/src/domains/index.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 './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 './analysis';
+export * from './analysis-bucket-file';
+export * from './analysis-log';
+export * from './analysis-node';
+export * from './service';
+export * from './types-base';

package/src/domains/master-image/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 './module';

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

@@ -0,0 +1,47 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+
+import type { MasterImage, MasterImageCommand } from '@privateaim/core';
+import { BaseAPI } from '../base';
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+
+export class MasterImageAPI extends BaseAPI {
+    async getMany(data?: BuildInput<MasterImage>): Promise<CollectionResourceResponse<MasterImage>> {
+        const response = await this.client.get(`master-images${buildQuery(data)}`);
+        return response.data;
+    }
+
+    async getOne(
+        id: MasterImage['id'],
+        data?: BuildInput<MasterImage>,
+    ): Promise<SingleResourceResponse<MasterImage>> {
+        const response = await this.client.get(`master-images/${id}${buildQuery(data)}`);
+        return response.data;
+    }
+
+    async delete(id: MasterImage['id']): Promise<SingleResourceResponse<MasterImage>> {
+        const response = await this.client.delete(`master-images/${id}`);
+        return response.data;
+    }
+
+    async runCommand(
+        command: MasterImageCommand,
+        data: Record<string, any> = {},
+    ): Promise<SingleResourceResponse<Record<string, any>>> {
+        const actionData = {
+            command,
+            ...data,
+        };
+
+        const { data: response } = await this.client.post('master-images/command', actionData);
+
+        return response;
+    }
+}

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 './module';

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

@@ -0,0 +1,25 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+import type { MasterImageGroup } from '@privateaim/core';
+import { BaseAPI } from '../base';
+
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+
+export class MasterImageGroupAPI extends BaseAPI {
+    async getMany(data?: BuildInput<MasterImageGroup>): Promise<CollectionResourceResponse<MasterImageGroup>> {
+        const response = await this.client.get(`master-image-groups${buildQuery(data)}`);
+        return response.data;
+    }
+
+    async getOne(id: MasterImageGroup['id']): Promise<SingleResourceResponse<MasterImageGroup>> {
+        const response = await this.client.delete(`master-image-groups/${id}`);
+        return response.data;
+    }
+}

package/src/domains/node/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 './module';

package/src/domains/node/module.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+import type { Node } from '@privateaim/core';
+import { BaseAPI } from '../base';
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+import { nullifyEmptyObjectProperties } from '../../utils';
+
+export class NodeAPI extends BaseAPI {
+    async getMany(options?: BuildInput<Node>): Promise<CollectionResourceResponse<Node>> {
+        const response = await this.client.get(`nodes${buildQuery(options)}`);
+
+        return response.data;
+    }
+
+    async getOne(id: Node['id'], options?: BuildInput<Node>): Promise<SingleResourceResponse<Node>> {
+        const response = await this.client.get(`nodes/${id}${buildQuery(options)}`);
+
+        return response.data;
+    }
+
+    async create(data: Record<string, any>): Promise<SingleResourceResponse<Node>> {
+        const response = await this.client.post('nodes', nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async update(id: Node['id'], data: Record<string, any>): Promise<SingleResourceResponse<Node>> {
+        const response = await this.client.post(`nodes/${id}`, nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async delete(id: Node['id']): Promise<SingleResourceResponse<Node>> {
+        const response = await this.client.delete(`nodes/${id}`);
+
+        return response.data;
+    }
+
+    async runCommand(id: Node['id'], task: string, data: Record<string, any>): Promise<SingleResourceResponse<Node>> {
+        const response = await this.client.post(`nodes/${id}/task`, { task, ...data });
+
+        return response.data;
+    }
+}

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 './module';

package/src/domains/project/module.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+import type { Project } from '@privateaim/core';
+import { BaseAPI } from '../base';
+import { nullifyEmptyObjectProperties } from '../../utils';
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+
+export class ProjectAPI extends BaseAPI {
+    async getMany(record?: BuildInput<Project>): Promise<CollectionResourceResponse<Project>> {
+        const response = await this.client.get(`projects${buildQuery(record)}`);
+        return response.data;
+    }
+
+    async getOne(id: Project['id'], requestRecord?: BuildInput<Project>): Promise<SingleResourceResponse<Project>> {
+        const response = await this.client.get(`projects/${id}${buildQuery(requestRecord)}`);
+
+        return response.data;
+    }
+
+    async create(data: Record<string, any>): Promise<SingleResourceResponse<Project>> {
+        const response = await this.client.post('projects', nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async delete(id: Project['id']): Promise<SingleResourceResponse<Project>> {
+        const response = await this.client.delete(`projects/${id}`);
+        return response.data;
+    }
+
+    async update(id: Project['id'], data: Record<string, any>): Promise<SingleResourceResponse<Project>> {
+        const response = await this.client.post(`projects/${id}`, nullifyEmptyObjectProperties(data));
+        return response.data;
+    }
+}

package/src/domains/project-node/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 './module';

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

@@ -0,0 +1,45 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+import type { ProjectNode } from '@privateaim/core';
+import { nullifyEmptyObjectProperties } from '../../utils';
+import { BaseAPI } from '../base';
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+
+export class ProjectNodeAPI extends BaseAPI {
+    async getMany(data?: BuildInput<ProjectNode>): Promise<CollectionResourceResponse<ProjectNode>> {
+        const response = await this.client.get(`project-nodes${buildQuery(data)}`);
+
+        return response.data;
+    }
+
+    async getOne(id: ProjectNode['id'], data?: BuildInput<ProjectNode>): Promise<SingleResourceResponse<ProjectNode>> {
+        const response = await this.client.get(`project-nodes/${id}${buildQuery(data)}`);
+
+        return response.data;
+    }
+
+    async create(data: Partial<ProjectNode>): Promise<SingleResourceResponse<ProjectNode>> {
+        const response = await this.client.post('project-nodes', data);
+
+        return response.data;
+    }
+
+    async update(id: ProjectNode['id'], data: Partial<ProjectNode>): Promise<SingleResourceResponse<ProjectNode>> {
+        const response = await this.client.post(`project-nodes/${id}`, nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async delete(id: ProjectNode['id']): Promise<SingleResourceResponse<ProjectNode>> {
+        const response = await this.client.delete(`project-nodes/${id}`);
+
+        return response.data;
+    }
+}

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

package/src/domains/registry/module.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+import type { Registry } from '@privateaim/core';
+import { BaseAPI } from '../base';
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+import { nullifyEmptyObjectProperties } from '../../utils';
+
+export class RegistryAPI extends BaseAPI {
+    async getMany(options?: BuildInput<Registry>): Promise<CollectionResourceResponse<Registry>> {
+        const response = await this.client.get(`registries${buildQuery(options)}`);
+
+        return response.data;
+    }
+
+    async getOne(id: Registry['id'], options?: BuildInput<Registry>): Promise<SingleResourceResponse<Registry>> {
+        const response = await this.client.get(`registries/${id}${buildQuery(options)}`);
+
+        return response.data;
+    }
+
+    async create(data: Record<string, any>): Promise<SingleResourceResponse<Registry>> {
+        const response = await this.client.post('registries', nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async update(id: Registry['id'], data: Record<string, any>): Promise<SingleResourceResponse<Registry>> {
+        const response = await this.client.post(`registries/${id}`, nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async delete(id: Registry['id']): Promise<SingleResourceResponse<Registry>> {
+        const response = await this.client.delete(`registries/${id}`);
+
+        return response.data;
+    }
+}

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

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

@@ -0,0 +1,45 @@
+/*
+ * 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 { BuildInput } from 'rapiq';
+import { buildQuery } from 'rapiq';
+import type { RegistryProject } from '@privateaim/core';
+import { BaseAPI } from '../base';
+import type { CollectionResourceResponse, SingleResourceResponse } from '../types-base';
+import { nullifyEmptyObjectProperties } from '../../utils';
+
+export class RegistryProjectAPI extends BaseAPI {
+    async getMany(options?: BuildInput<RegistryProject>): Promise<CollectionResourceResponse<RegistryProject>> {
+        const response = await this.client.get(`registry-projects${buildQuery(options)}`);
+
+        return response.data;
+    }
+
+    async getOne(id: RegistryProject['id'], options?: BuildInput<RegistryProject>): Promise<SingleResourceResponse<RegistryProject>> {
+        const response = await this.client.get(`registry-projects/${id}${buildQuery(options)}`);
+
+        return response.data;
+    }
+
+    async create(data: Record<string, any>): Promise<SingleResourceResponse<RegistryProject>> {
+        const response = await this.client.post('registry-projects', nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async update(id: RegistryProject['id'], data: Record<string, any>): Promise<SingleResourceResponse<RegistryProject>> {
+        const response = await this.client.post(`registry-projects/${id}`, nullifyEmptyObjectProperties(data));
+
+        return response.data;
+    }
+
+    async delete(id: RegistryProject['id']): Promise<SingleResourceResponse<RegistryProject>> {
+        const response = await this.client.delete(`registry-projects/${id}`);
+
+        return response.data;
+    }
+}

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

package/src/domains/service/module.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 { Registry, RegistryAPICommand, RegistryProject } from '@privateaim/core';
+import { ServiceID } from '@privateaim/core';
+import type { SingleResourceResponse } from '../types-base';
+import { BaseAPI } from '../base';
+import { nullifyEmptyObjectProperties } from '../../utils';
+
+export class ServiceAPI extends BaseAPI {
+    async runCommand(
+        id: `${ServiceID}`,
+        command: string,
+        data?: Record<string, any>,
+    ): Promise<SingleResourceResponse<Record<string, any>>> {
+        data = data || {};
+
+        const { data: resultData } = await this.client.post(`services/${id}/command`, nullifyEmptyObjectProperties({ command, ...data }));
+
+        return resultData;
+    }
+
+    async runRegistryCommand(
+        command: `${RegistryAPICommand}`,
+        data: {
+            id: Registry['id'] | RegistryProject['id'],
+            [key: string]: any
+        },
+    ): Promise<SingleResourceResponse<Record<string, any>>> {
+        return this.runCommand(ServiceID.REGISTRY, command, data);
+    }
+}

package/src/domains/types-base.ts

@@ -0,0 +1,42 @@
+/*
+ * 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 { Client, RequestBaseOptions } from 'hapic';
+import type { BuildInput } from 'rapiq';
+
+export type SingleResourceResponse<R> = R;
+export type CollectionResourceResponse<R> = {
+    data: R[],
+    meta: {
+        limit: number,
+        offset: number,
+        total: number
+    }
+};
+
+export type DomainEntityWithID = {
+    [key: string]: any,
+    id: any
+};
+export type DomainEntityID<T> = T extends DomainEntityWithID ?
+    T['id'] :
+    never;
+
+export interface DomainAPISlim<T> {
+    getMany(record?: BuildInput<T>) : Promise<CollectionResourceResponse<T>>;
+    getOne(id: DomainEntityID<T>, record?: BuildInput<T>) : Promise<SingleResourceResponse<T>>;
+    delete(id: DomainEntityID<T>) : Promise<SingleResourceResponse<T>>;
+    create(data: Partial<T>) : Promise<SingleResourceResponse<T>>;
+}
+
+export interface DomainAPI<T> extends DomainAPISlim<T> {
+    update(id: DomainEntityID<T>, data: Partial<T>) : Promise<SingleResourceResponse<T>>;
+}
+
+export type BaseAPIContext = {
+    client?: Client | RequestBaseOptions
+};

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

package/src/utils/duplicate-slashes.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2022.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export function cleanDoubleSlashes(input: string) : string {
+    if (input.indexOf('://') !== -1) {
+        return input.split('://')
+            .map((str) => cleanDoubleSlashes(str))
+            .join('://');
+    }
+
+    return input.replace(/\/+/g, '/');
+}

package/src/utils/index.ts

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

package/src/utils/object-property.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2021.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { isPropertySet } from '@authup/kit';
+
+export function nullifyEmptyObjectProperties<T extends Record<string, any>>(data: T) : T {
+    const keys : (keyof T)[] = Object.keys(data);
+
+    for (let i = 0; i < keys.length; i++) {
+        if (data[keys[i]] === '') {
+            data[keys[i]] = null as T[keyof T];
+        }
+    }
+
+    return data;
+}
+
+export function deleteUndefinedObjectProperties<T extends Record<string, any>>(data: T) : T {
+    const keys : string[] = Object.keys(data);
+
+    for (let i = 0; i < keys.length; i++) {
+        if (typeof data[keys[i]] === 'undefined') {
+            delete data[keys[i]];
+        }
+    }
+
+    return data;
+}
+
+export function extractObjectProperty<T extends Record<string, any>, K extends keyof T>(
+    data: T | undefined,
+    key: K,
+) : T[K] | undefined {
+    if (!data) {
+        return undefined;
+    }
+
+    if (isPropertySet(data, key)) {
+        return data[key];
+    }
+
+    return undefined;
+}

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/core": [
+                "./packages/core/src"
+            ]
+        }
+    }
+}