@hahnpro/hpc-api 1.0.1 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Hahn PRO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/api.js

@@ -15,19 +15,22 @@ const timeseries_service_1 = require("./timeseries.service");
 const user_service_1 = require("./user.service");
 class API {
     constructor() {
+        const normalizePath = (value = '', defaultValue = '') => value.replace(/^\/+|\/+$/g, '') || defaultValue;
         let apiBaseUrl = process.env.API_BASE_URL || 'https://testing.hahnpro.com';
         if (!apiBaseUrl.startsWith('https') && !apiBaseUrl.startsWith('http')) {
             console.info('no protocol specified - using HTTPS');
             apiBaseUrl = `https://${apiBaseUrl}`;
         }
+        const apiUrl = apiBaseUrl + '/' + normalizePath(process.env.API_BASE_PATH, 'api');
         const authBaseUrl = process.env.AUTH_BASE_URL || apiBaseUrl;
+        const authUrl = authBaseUrl + '/' + normalizePath(process.env.AUTH_BASE_PATH, 'auth');
         const realm = process.env.AUTH_REALM || 'hpc';
         const client = process.env.API_USER || 'flow-executor-service';
         const secret = process.env.AUTH_SECRET;
         if (!secret) {
             throw new Error('"API_BASE_URL", "API_USER", "AUTH_REALM" and "AUTH_SECRET" environment variables must be set');
         }
-        this.httpClient = new http_service_1.HttpClient(apiBaseUrl, authBaseUrl, realm, client, secret);
+        this.httpClient = new http_service_1.HttpClient(apiUrl, authUrl, realm, client, secret);
         this.assets = new asset_service_1.AssetService(this.httpClient);
         this.assetTypes = new assettypes_service_1.AssetTypesService(this.httpClient);
         this.contents = new content_service_1.ContentService(this.httpClient);

package/dist/asset.interface.d.ts

@@ -1,33 +1,37 @@
-export interface Asset {
+export interface AssetType {
     id?: string;
     name: string;
-    type: string | AssetType;
-    type$name?: string;
+    tags?: string[];
+    allowedParents?: string[];
+    allowedParent$name?: string;
     readPermissions: string[];
     readWritePermissions: string[];
-    tags?: string[];
-    parent?: any | Asset;
-    parent$name?: string;
-    data?: any;
-    attachments?: string[];
-    image?: string;
+    supertype?: string;
+    supertype$name?: string;
+    typeSchema: any;
+    uiSchema: any;
     actions?: string[];
-    notificationEndpoints?: string[];
     createdAt?: string;
     updatedAt?: string;
 }
-export interface AssetType {
+export interface Asset {
     id?: string;
     name: string;
-    tags?: string[];
-    allowedParent?: string;
-    allowedParent$name?: string;
+    type: string | AssetType;
+    type$name?: string;
     readPermissions: string[];
     readWritePermissions: string[];
-    typeSchema: any;
-    supertype?: string;
-    supertype$name?: string;
-    uiSchema: any;
+    parent?: any | Asset;
+    parent$name?: string;
+    ancestors?: string[];
+    tags?: string[];
+    relations?: any[];
+    data?: any;
+    image?: string;
+    author?: string;
+    revision?: number;
+    attachments?: string[];
+    notificationEndpoints?: string[];
     actions?: string[];
     createdAt?: string;
     updatedAt?: string;

package/dist/asset.service.js

@@ -4,7 +4,7 @@ exports.AssetService = void 0;
 const data_service_1 = require("./data.service");
 class AssetService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_ASSET_URL || 'api/assets');
+        super(httpClient, '/assets');
         this.addAttachment = (id, form) => {
             const headers = Object.assign({}, form.getHeaders());
             return this.httpClient.post(`${this.basePath}/${id}/attachment`, form, {

package/dist/assettypes.service.js

@@ -4,7 +4,7 @@ exports.AssetTypesService = void 0;
 const data_service_1 = require("./data.service");
 class AssetTypesService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, 'api/assettypes');
+        super(httpClient, '/assettypes');
     }
 }
 exports.AssetTypesService = AssetTypesService;

package/dist/content.service.js

@@ -5,7 +5,7 @@ const content_interface_1 = require("./content.interface");
 const data_service_1 = require("./data.service");
 class ContentService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_CONTENT_URL || 'api/contents');
+        super(httpClient, '/contents');
         this.upload = (form) => {
             const headers = Object.assign({}, form.getHeaders());
             return this.httpClient.post(`${this.basePath}`, form, { headers, maxBodyLength: Infinity, maxContentLength: Infinity });

package/dist/endpoint.interface.d.ts

@@ -9,9 +9,9 @@ export interface Endpoint {
         authToken: string;
         recipients?: string[];
     };
-    notificationCheck: number;
-    notificationCount: number;
-    notificationPause: number;
+    notificationCheckInterval: number;
+    notificationPauseInterval: number;
+    nbOfNotificationsBetweenPauseInterval: number;
     readPermissions: string[];
     readWritePermissions: string[];
 }
@@ -23,3 +23,13 @@ export interface EndpointLog {
     group?: string;
     updatedAt?: string;
 }
+export interface NotificationPayload {
+    subject: string;
+    message: string;
+    group?: string;
+    level?: string;
+    eventLink?: string;
+    assetId?: string;
+    assetName?: string;
+    assetLink?: string;
+}

package/dist/endpoint.service.d.ts

@@ -1,8 +1,8 @@
 import { HttpClient } from './http.service';
 import { DataService } from './data.service';
-import { Endpoint, EndpointLog } from './endpoint.interface';
+import { Endpoint, NotificationPayload, EndpointLog } from './endpoint.interface';
 export declare class EndpointService extends DataService<Endpoint> {
     constructor(httpClient: HttpClient);
-    sendNotification(endpointId: string, subject: string, message: string, group: string, eventLink?: string, assetLink?: string): Promise<void>;
+    sendNotification(endpointId: string, payload: NotificationPayload): Promise<void>;
     readLastLogByGroup(endpointId: string, group: string): Promise<EndpointLog>;
 }

package/dist/endpoint.service.js

@@ -4,11 +4,10 @@ exports.EndpointService = void 0;
 const data_service_1 = require("./data.service");
 class EndpointService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_ENDPOINT_URL || 'api/notification/endpoints');
+        super(httpClient, '/notification/endpoints');
     }
-    sendNotification(endpointId, subject, message, group, eventLink, assetLink) {
-        const body = Object.assign(Object.assign({ subject, message, group }, (eventLink && { eventLink })), (assetLink && { assetLink }));
-        return this.httpClient.post(`${this.basePath}/${endpointId}`, body);
+    sendNotification(endpointId, payload) {
+        return this.httpClient.post(`${this.basePath}/${endpointId}`, payload);
     }
     readLastLogByGroup(endpointId, group) {
         return this.httpClient.get(`${this.basePath}/${endpointId}/logs/${group}/last`);

package/dist/events.service.js

@@ -4,7 +4,7 @@ exports.EventsService = void 0;
 const data_service_1 = require("./data.service");
 class EventsService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_EVENTS_URL || 'api/events');
+        super(httpClient, '/events');
     }
     getLastEventByAssetAndGroup(assetId, group) {
         return this.httpClient.get(`${this.basePath}/last/${assetId}/${group}`);

package/dist/http.service.d.ts

@@ -8,7 +8,7 @@ export declare class HttpClient {
     private readonly requestQueue;
     private accessToken;
     private accessTokenExpiration;
-    constructor(apiBaseUrl: string, authBaseUrl: string, realm: string, client: string, secret: string);
+    constructor(baseURL: string, authbaseURL: string, realm: string, client: string, secret: string);
     getQueueStats: () => {
         peak: number;
         pending: number;

package/dist/http.service.js

@@ -6,7 +6,7 @@ const axios_1 = (0, tslib_1.__importDefault)(require("axios"));
 const Queue_1 = require("./Queue");
 const EXPIRATION_BUFFER = 30 * 1000;
 class HttpClient {
-    constructor(apiBaseUrl, authBaseUrl, realm, client, secret) {
+    constructor(baseURL, authbaseURL, realm, client, secret) {
         this.realm = realm;
         this.client = client;
         this.secret = secret;
@@ -50,7 +50,7 @@ class HttpClient {
                 ]);
                 const headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
                 this.authAxiosInstance
-                    .post(`/auth/realms/${this.realm}/protocol/openid-connect/token`, params.toString(), { headers })
+                    .post(`/realms/${this.realm}/protocol/openid-connect/token`, params.toString(), { headers })
                     .then((res) => {
                     var _a;
                     if (((_a = res === null || res === void 0 ? void 0 : res.data) === null || _a === void 0 ? void 0 : _a.access_token) && res.data.expires_in) {
@@ -65,9 +65,8 @@ class HttpClient {
                     .catch(reject);
             });
         };
-        authBaseUrl = authBaseUrl || apiBaseUrl;
-        this.axiosInstance = axios_1.default.create({ baseURL: apiBaseUrl, timeout: 60000 });
-        this.authAxiosInstance = axios_1.default.create({ baseURL: authBaseUrl, timeout: 10000 });
+        this.axiosInstance = axios_1.default.create({ baseURL, timeout: 60000 });
+        this.authAxiosInstance = axios_1.default.create({ baseURL: authbaseURL || baseURL, timeout: 10000 });
         this.requestQueue = new Queue_1.Queue({ concurrency: 1, timeout: 70000, throwOnTimeout: true });
     }
 }

package/dist/mock/api.mock.d.ts

@@ -1,13 +1,17 @@
 import { API } from '../api';
-import { Asset } from '../asset.interface';
-import { Storage } from '../content.interface';
-import { TimeSeriesValue } from '../timeseries.interface';
+import { Asset, AssetType } from '../asset.interface';
+import { Content } from '../content.interface';
+import { Secret } from '../secret.interface';
+import { TimeSeries, TimeSeriesValue } from '../timeseries.interface';
 import { AssetMockService } from './asset.mock.service';
 import { AssetTypesMockService } from './assetTypes.mock.service';
 import { ContentMockService } from './content.mock.service';
+import { Endpoint } from '../endpoint.interface';
 import { EndpointMockService } from './endpoint.mock.service';
+import { Event } from '../events.interface';
 import { EventsMockService } from './events.mock.service';
 import { SecretMockService } from './secret.mock.service';
+import { Task } from '../task.interface';
 import { TimeseriesMockService } from './timeseries.mock.service';
 import { TaskMockService } from './task.mock.service';
 import { UserMockService } from './user.mock.service';
@@ -43,119 +47,26 @@ export declare class MockAPI implements API {
         users?: UserInit;
     });
 }
-export interface AssetInit {
-    id: string;
-    name: string;
-    type: AssetTypeInit | string;
-    type$name?: string;
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-    notificationEndpoints?: string[];
-    tags?: string[];
-    parent?: any | Asset;
-    parent$name?: string;
-    data?: any;
-    actions?: string[];
-    image?: string;
-    attachments?: string[];
-    createdAt?: string;
-    updatedAt?: string;
-}
-export interface AssetTypeInit {
-    id: string;
-    name: string;
-    allowedParent?: string;
-    allowedParent$name?: string;
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-    typeSchema?: any;
-    uiSchema?: any;
-    supertype?: string;
-    supertype$name?: string;
-    actions?: string[];
-}
-export interface ContentInit {
-    id: string;
-    fileId?: string;
-    filename: string;
+export declare type Identity<T> = {
+    [P in keyof T]: T[P];
+};
+export declare type AtLeast<T, K extends keyof T> = Identity<Partial<T> & Pick<T, K>>;
+export declare type Replace<T, K extends keyof T, TReplace> = Identity<Pick<T, Exclude<keyof T, K>> & {
+    [P in K]: TReplace;
+}>;
+export declare type AssetInit = Replace<AtLeast<Asset, 'id' | 'name' | 'type'>, 'type', AssetTypeInit | string>;
+export declare type AssetTypeInit = AtLeast<AssetType, 'id' | 'name'>;
+export declare type ContentInit = Identity<AtLeast<Content, 'id' | 'filename'> & {
     filePath?: string;
-    mimetype?: string;
-    size?: number;
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-    tags?: string[];
-    assets?: string[];
-    files?: Storage[];
-    createdAt?: string;
-    updatedAt?: string;
     data?: any;
-}
-export interface EndpointInit {
-    id?: string;
-    name: string;
-    description?: string;
-    status?: string;
-    config?: {
-        type: string;
-        url?: string;
-        authToken: string;
-        recipients?: string[];
-    };
-    notificationCheck?: number;
-    notificationCount?: number;
-    notificationPause?: number;
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-}
-export interface SecretInit {
-    id?: string;
-    name: string;
-    key: string;
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-}
-export interface TimeSeriesInit {
-    id: string;
-    name: string;
-    assetRef?: string;
-    assetRef$name?: string;
-    assetTsId?: string;
-    minDate?: Date;
-    tsRef?: [string];
-    metrics?: string[];
+}>;
+export declare type EndpointInit = AtLeast<Endpoint, 'name'>;
+export declare type SecretInit = AtLeast<Secret, 'name' | 'key'>;
+export declare type TimeSeriesInit = Identity<AtLeast<TimeSeries, 'id' | 'name'> & {
     values: TimeSeriesValue[];
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-}
-export interface TaskInit {
-    id?: string;
-    name: string;
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-    assetRef?: string;
-    assetRef$name?: string;
-    subTasks?: string[];
-    assignedTo: string[];
-    status?: string;
-    acceptedBy?: string;
-}
-export interface EventInit {
-    id?: string;
-    name: string;
-    tags?: string[];
-    readPermissions?: string[];
-    readWritePermissions?: string[];
-    assetRef?: string;
-    assetRef$name?: string;
-    alertRef?: string;
-    alertRef$name?: string;
-    tsRef?: string;
-    tsRef$name?: string;
-    eventRef?: string;
-    cause?: string;
-    level?: string;
-    group?: string;
-}
+}>;
+export declare type TaskInit = AtLeast<Task, 'name' | 'assignedTo'>;
+export declare type EventInit = AtLeast<Event, 'name'>;
 export interface UserInit {
     roles: string[];
 }

package/dist/mock/api.mock.js

@@ -58,9 +58,9 @@ class MockAPI {
             description: value.description,
             status: value.status,
             config: value.config,
-            notificationCheck: value.notificationCheck,
-            notificationCount: value.notificationCount,
-            notificationPause: value.notificationPause,
+            notificationCheckInterval: value.notificationCheckInterval,
+            notificationPauseInterval: value.notificationPauseInterval,
+            nbOfNotificationsBetweenPauseInterval: value.nbOfNotificationsBetweenPauseInterval,
             readPermissions: [],
             readWritePermissions: [],
         }));
@@ -70,7 +70,6 @@ class MockAPI {
             readPermissions: [],
             readWritePermissions: [],
             assetRef: v.assetRef,
-            assetRef$name: v.assetRef$name,
             subTasks: [],
             assignedTo: v.assignedTo,
             status: v.status,
@@ -84,9 +83,7 @@ class MockAPI {
             assetRef: v.assetRef,
             assetRef$name: v.assetRef$name,
             alertRef: v.alertRef,
-            alertRef$name: v.alertRef$name,
             tsRef: v.tsRef,
-            tsRef$name: v.tsRef$name,
             tags: v.tags,
             cause: v.cause,
             level: v.level,

package/dist/mock/endpoint.mock.service.d.ts

@@ -1,9 +1,9 @@
-import { Endpoint } from '../endpoint.interface';
+import { Endpoint, NotificationPayload } from '../endpoint.interface';
 import { EndpointService } from '../endpoint.service';
 import { DataMockService } from './data.mock.service';
 export declare class EndpointMockService extends DataMockService<Endpoint> implements EndpointService {
     constructor(endpoints: Endpoint[]);
-    sendNotification(endpointId: string, subject: string, message: string, group: string, eventLink?: string, assetLink?: string): Promise<void>;
+    sendNotification(endpointId: string, payload: NotificationPayload): Promise<void>;
     readLastLogByGroup(endpointId: string, group: string): Promise<{
         id: string;
         endpoint: string;

package/dist/mock/endpoint.mock.service.js

@@ -7,7 +7,7 @@ class EndpointMockService extends data_mock_service_1.DataMockService {
         super();
         this.data = endpoints;
     }
-    sendNotification(endpointId, subject, message, group, eventLink, assetLink) {
+    sendNotification(endpointId, payload) {
         return Promise.resolve();
     }
     readLastLogByGroup(endpointId, group) {

package/dist/proxy.service.js

@@ -11,7 +11,7 @@ class ProxyService {
     }
     url(proxyId, path = '/') {
         path = path.startsWith('/') ? path : `/${path}`;
-        return `api/${proxyId}${path}`;
+        return `/proxy/${proxyId}${path}`;
     }
 }
 exports.ProxyService = ProxyService;

package/dist/secret.service.js

@@ -4,7 +4,7 @@ exports.SecretService = void 0;
 const data_service_1 = require("./data.service");
 class SecretService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_SECRET_URL || '/api/secrets');
+        super(httpClient, '/secrets');
     }
 }
 exports.SecretService = SecretService;

package/dist/sidriveiq.service.js

@@ -4,7 +4,7 @@ exports.SiDriveIqService = void 0;
 class SiDriveIqService {
     constructor(httpClient) {
         this.httpClient = httpClient;
-        this.basePath = 'api/sidrive/api/v0';
+        this.basePath = '/proxy/sidrive/api/v0';
     }
     getAssets(params = {}) {
         return this.httpClient.get(`${this.basePath}/assets`, { params });

package/dist/task.service.js

@@ -4,7 +4,7 @@ exports.TaskService = void 0;
 const data_service_1 = require("./data.service");
 class TaskService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_TSK_URL || 'api/tasks');
+        super(httpClient, '/tasks');
     }
     createTaskAttachedToAsset(dto) {
         return this.httpClient.post(this.basePath, dto);

package/dist/timeseries.service.js

@@ -4,7 +4,7 @@ exports.TimeSeriesService = void 0;
 const data_service_1 = require("./data.service");
 class TimeSeriesService extends data_service_1.DataService {
     constructor(httpClient) {
-        super(httpClient, process.env.DEBUG_TSM_URL || 'api/tsm');
+        super(httpClient, '/tsm');
     }
     addValue(id, value) {
         return this.httpClient.post(`${this.basePath}/${id}`, value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Module for easy access to the HahnPRO API",
   "license": "MIT",
   "author": {
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:hahnpro/flow.git"
+    "url": "git@github.com:hahnprojects/flow.git"
   },
   "directories": {
     "lib": "lib",
@@ -24,7 +24,7 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "^0.23.0",
+    "axios": "^0.25.0",
     "form-data": "^4.0.0",
     "jwt-decode": "^3.1.2",
     "p-queue": "^6.6.2"