@hahnpro/hpc-api 1.0.2 → 2.1.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/asset.interface.d.ts

@@ -1,34 +1,43 @@
-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 AssetParent {
     id?: string;
     name: string;
-    tags?: string[];
-    allowedParent?: string;
-    allowedParent$name?: string;
+    type: string | AssetType;
     readPermissions: string[];
     readWritePermissions: string[];
-    typeSchema: any;
-    supertype?: string;
-    supertype$name?: string;
-    uiSchema: any;
+    parent?: any | Asset;
+    ancestors?: string[];
+    tags?: string[];
+    relations?: any[];
+    data?: any;
+    image?: string;
+    author?: string;
+    revision?: number;
+}
+export interface Asset extends AssetParent {
+    type$name?: string;
+    parent$name?: string;
+    attachments?: string[];
+    notificationEndpoints?: string[];
     actions?: string[];
+}
+export interface AssetRevision extends AssetParent {
+    originalId?: string;
     createdAt?: string;
     updatedAt?: string;
 }

package/dist/asset.service.d.ts

@@ -1,5 +1,5 @@
 import FormData from 'form-data';
-import { Asset } from './asset.interface';
+import { Asset, AssetRevision } from './asset.interface';
 import { Paginated, RequestParameter } from './data.interface';
 import { DataService } from './data.service';
 import { HttpClient } from './http.service';
@@ -7,4 +7,5 @@ export declare class AssetService extends DataService<Asset> {
     constructor(httpClient: HttpClient);
     addAttachment: (id: string, form: FormData) => Promise<Asset>;
     getChildren(assetId: string, params?: RequestParameter): Promise<Paginated<Asset[]>>;
+    findRevisions(assetId: string): Promise<Paginated<AssetRevision[]>>;
 }

package/dist/asset.service.js

@@ -17,5 +17,8 @@ class AssetService extends data_service_1.DataService {
     getChildren(assetId, params = {}) {
         return this.getManyFiltered({ parent: assetId }, params);
     }
+    findRevisions(assetId) {
+        return this.httpClient.get(`${this.basePath}/${assetId}/revisions`);
+    }
 }
 exports.AssetService = AssetService;

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

@@ -6,9 +6,8 @@ class EndpointService extends data_service_1.DataService {
     constructor(httpClient) {
         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/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, AssetRevision, 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';
@@ -34,6 +38,7 @@ export declare class MockAPI implements API {
     userManager: UserMockService;
     constructor(initData: {
         assets?: AssetInit[];
+        revisions: AssetRevisionInit[];
         contents?: ContentInit[];
         endpoints?: EndpointInit[];
         secrets?: SecretInit[];
@@ -43,119 +48,27 @@ 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 AssetRevisionInit = Replace<AtLeast<AssetRevision, '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

@@ -16,7 +16,7 @@ class MockAPI {
         this.httpClient = null;
         this.proxy = null;
         this.siDrive = null;
-        const { assets = [], contents = [], endpoints = [], secrets = [], timeSeries = [], tasks = [], events = [], users } = initData;
+        const { assets = [], revisions = [], contents = [], endpoints = [], secrets = [], timeSeries = [], tasks = [], events = [], users, } = initData;
         const assetTypes = assets
             .map((v) => v.type)
             .map((v) => {
@@ -32,6 +32,7 @@ class MockAPI {
                 };
         });
         const assets1 = assets.map((v, index) => (Object.assign(Object.assign({}, v), { readPermissions: [], readWritePermissions: [], type: assetTypes[index] })));
+        const revisions1 = revisions.map((v, index) => (Object.assign(Object.assign({}, v), { readPermissions: [], readWritePermissions: [], type: assetTypes[index] })));
         const contents1 = contents.map((v) => (Object.assign(Object.assign({}, v), { readPermissions: [], readWritePermissions: [], size: 0, fileId: '', mimetype: v.mimetype || '' })));
         const contentData = contents.map((v) => {
             return v.data ? v.data : (0, fs_1.readFileSync)((0, path_1.join)(v.filePath, v.filename));
@@ -58,9 +59,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 +71,6 @@ class MockAPI {
             readPermissions: [],
             readWritePermissions: [],
             assetRef: v.assetRef,
-            assetRef$name: v.assetRef$name,
             subTasks: [],
             assignedTo: v.assignedTo,
             status: v.status,
@@ -84,16 +84,14 @@ 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,
             group: v.group,
         }));
         const timeseriesValues = timeSeries.map((v) => v.values);
-        this.assets = new asset_mock_service_1.AssetMockService(this, assets1);
+        this.assets = new asset_mock_service_1.AssetMockService(this, assets1, revisions1);
         this.contents = new content_mock_service_1.ContentMockService(contents1, contentData);
         this.endpoints = new endpoint_mock_service_1.EndpointMockService(endpoint1);
         this.secrets = new secret_mock_service_1.SecretMockService(secrets1);

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

@@ -1,12 +1,14 @@
 import FormData from 'form-data';
-import { Asset } from '../asset.interface';
+import { Asset, AssetRevision } from '../asset.interface';
 import { AssetService } from '../asset.service';
 import { Paginated, RequestParameter } from '../data.interface';
 import { MockAPI } from './api.mock';
 import { DataMockService } from './data.mock.service';
 export declare class AssetMockService extends DataMockService<Asset> implements AssetService {
     private api;
-    constructor(api: MockAPI, assets: Asset[]);
+    private revisions;
+    constructor(api: MockAPI, assets: Asset[], revisions: AssetRevision[]);
     addAttachment(id: string, form: FormData): Promise<Asset>;
     getChildren(assetId: string, params?: RequestParameter): Promise<Paginated<Asset[]>>;
+    findRevisions(assetId: string): Promise<Paginated<AssetRevision[]>>;
 }

package/dist/mock/asset.mock.service.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AssetMockService = void 0;
 const data_mock_service_1 = require("./data.mock.service");
 class AssetMockService extends data_mock_service_1.DataMockService {
-    constructor(api, assets) {
+    constructor(api, assets, revisions) {
         super();
         this.api = api;
+        this.revisions = [];
         this.data = assets;
+        this.revisions = revisions;
     }
     async addAttachment(id, form) {
         const asset = this.data.find((v) => v.id === id);
@@ -17,5 +19,14 @@ class AssetMockService extends data_mock_service_1.DataMockService {
     getChildren(assetId, params = {}) {
         return this.getManyFiltered({ parent: assetId }, params);
     }
+    findRevisions(assetId) {
+        const newData = this.revisions.filter((revision) => revision.originalId === assetId);
+        const page = {
+            docs: newData,
+            limit: Number.MAX_SAFE_INTEGER,
+            total: newData.length,
+        };
+        return Promise.resolve(page);
+    }
 }
 exports.AssetMockService = AssetMockService;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "1.0.2",
+  "version": "2.1.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"