@hahnpro/hpc-api 3.8.1 → 4.0.0

package/dist/api.d.ts

@@ -6,7 +6,6 @@ import { EventsService } from './events.service';
 import { HttpClient } from './http.service';
 import { ProxyService } from './proxy.service';
 import { SecretService } from './secret.service';
-import { SiDriveIqService } from './sidriveiq.service';
 import { TaskService } from './task.service';
 import { TimeSeriesService } from './timeseries.service';
 import { UserService } from './user.service';
@@ -18,7 +17,7 @@ import { LabelService } from './label.service';
 import { VaultService } from './vault.service';
 import { NotificationService } from './notification.service';
 export declare class API {
-    httpClient: HttpClient;
+    readonly httpClient?: HttpClient;
     assets: AssetService;
     assetTypes: AssetTypesService;
     contents: ContentService;
@@ -36,41 +35,5 @@ export declare class API {
     users: UserService;
     vault: VaultService;
     notifications: NotificationService;
-    /**
-     * @deprecated use "assets" instead
-     */
-    assetManager: AssetService;
-    /**
-     * @deprecated use "contents" instead
-     */
-    contentManager: ContentService;
-    /**
-     * @deprecated use "endpoints" instead
-     */
-    endpointManager: EndpointService;
-    /**
-     * @deprecated use "events" instead
-     */
-    eventsManager: EventsService;
-    /**
-     * @deprecated use "secrets" instead
-     */
-    secretsManager: SecretService;
-    /**
-     * @deprecated use proxy service instead
-     */
-    siDrive: SiDriveIqService;
-    /**
-     * @deprecated use "tasks" instead
-     */
-    taskManager: TaskService;
-    /**
-     * @deprecated use "timeSeries" instead
-     */
-    timeSeriesManager: TimeSeriesService;
-    /**
-     * @deprecated use "users" instead
-     */
-    userManager: UserService;
-    constructor();
+    constructor(httpClient?: HttpClient);
 }

package/dist/api.js

@@ -9,7 +9,6 @@ const events_service_1 = require("./events.service");
 const http_service_1 = require("./http.service");
 const proxy_service_1 = require("./proxy.service");
 const secret_service_1 = require("./secret.service");
-const sidriveiq_service_1 = require("./sidriveiq.service");
 const task_service_1 = require("./task.service");
 const timeseries_service_1 = require("./timeseries.service");
 const user_service_1 = require("./user.service");
@@ -21,23 +20,26 @@ const label_service_1 = require("./label.service");
 const vault_service_1 = require("./vault.service");
 const notification_service_1 = require("./notification.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}`;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+        if (!httpClient) {
+            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(apiUrl, authUrl, realm, client, secret);
         }
-        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(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);
@@ -55,15 +57,6 @@ class API {
         this.users = new user_service_1.UserService(this.httpClient);
         this.vault = new vault_service_1.VaultService(this.httpClient);
         this.notifications = new notification_service_1.NotificationService(this.httpClient);
-        this.assetManager = this.assets;
-        this.contentManager = this.contents;
-        this.endpointManager = this.endpoints;
-        this.eventsManager = this.events;
-        this.secretsManager = this.secrets;
-        this.siDrive = new sidriveiq_service_1.SiDriveIqService(this.httpClient);
-        this.taskManager = this.tasks;
-        this.timeSeriesManager = this.timeSeries;
-        this.userManager = this.users;
     }
 }
 exports.API = API;

package/dist/http.service.d.ts

@@ -1,14 +1,15 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
 import EventSource from 'eventsource';
+import { Queue } from './Queue';
 export declare class HttpClient {
-    private readonly baseURL;
-    private readonly authBaseURL;
-    private readonly realm;
-    private readonly clientId;
-    private readonly clientSecret;
-    private readonly axiosInstance;
-    private readonly authAxiosInstance;
-    private readonly requestQueue;
+    protected readonly baseURL: string;
+    protected readonly authBaseURL: string;
+    protected readonly realm: string;
+    protected readonly clientId: string;
+    protected readonly clientSecret: string;
+    protected readonly axiosInstance: AxiosInstance;
+    protected readonly authAxiosInstance: AxiosInstance;
+    protected readonly requestQueue: Queue;
     private tokenSet;
     eventSourcesMap: Map<string, {
         eventSource: EventSource;
@@ -26,12 +27,21 @@ export declare class HttpClient {
     get: <T>(url: string, config?: AxiosRequestConfig) => Promise<T>;
     post: <T>(url: string, data: any, config?: AxiosRequestConfig) => Promise<T>;
     put: <T>(url: string, data: any, config?: AxiosRequestConfig) => Promise<T>;
-    private request;
+    protected request: <T>(method: Method, url: string, config?: AxiosRequestConfig, data?: any) => Promise<T>;
     addEventSource(url: string, listener: (event: MessageEvent) => void, errorListener?: (event: MessageEvent) => void): Promise<any>;
     destroyEventSource(id: string): void;
     destroyAllEventSources(): void;
     getAccessToken: (forceRefresh?: boolean) => Promise<string>;
-    private validateIssuer;
-    private discoverIssuer;
-    private requestAccessToken;
+    protected validateIssuer(issuer: Issuer): Issuer;
+    protected discoverIssuer(uri: string): Promise<Issuer>;
+    protected requestAccessToken(): Promise<string>;
 }
+interface Issuer {
+    issuer: string;
+    token_endpoint: string;
+    grant_types_supported: string[];
+    token_endpoint_auth_methods_supported: string[];
+    token_endpoint_auth_signing_alg?: string;
+    token_endpoint_auth_signing_alg_values_supported: string[];
+}
+export {};

package/dist/http.service.js

@@ -4,11 +4,11 @@ exports.HttpClient = void 0;
 const tslib_1 = require("tslib");
 const axios_1 = tslib_1.__importDefault(require("axios"));
 const eventsource_1 = tslib_1.__importDefault(require("eventsource"));
-const uuid_1 = require("uuid");
 const jose_1 = require("jose");
+const node_querystring_1 = require("node:querystring");
+const uuid_1 = require("uuid");
 const Queue_1 = require("./Queue");
 const token_set_1 = require("./token-set");
-const querystring_1 = require("querystring");
 class HttpClient {
     constructor(baseURL, authBaseURL, realm, clientId, clientSecret) {
         this.baseURL = baseURL;
@@ -117,7 +117,7 @@ class HttpClient {
             client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
             grant_type: 'client_credentials',
         };
-        const authResponse = await this.authAxiosInstance.post(issuer.token_endpoint, (0, querystring_1.stringify)(opts), {
+        const authResponse = await this.authAxiosInstance.post(issuer.token_endpoint, (0, node_querystring_1.stringify)(opts), {
             headers: { Accept: 'application/json', 'Content-Type': 'application/x-www-form-urlencoded' },
         });
         if (((_b = authResponse === null || authResponse === void 0 ? void 0 : authResponse.data) === null || _b === void 0 ? void 0 : _b.access_token) && authResponse.data.expires_in) {

package/dist/index.d.ts

@@ -18,4 +18,3 @@ export * from './resource.interface';
 export * from './schema.interface';
 export * from './vault.interface';
 export * from './notification.interface';
-export * as SiDrive from './sidriveiq.interface';

package/dist/index.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SiDrive = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./api"), exports);
 tslib_1.__exportStar(require("./asset.interface"), exports);
@@ -22,4 +21,3 @@ tslib_1.__exportStar(require("./resource.interface"), exports);
 tslib_1.__exportStar(require("./schema.interface"), exports);
 tslib_1.__exportStar(require("./vault.interface"), exports);
 tslib_1.__exportStar(require("./notification.interface"), exports);
-exports.SiDrive = tslib_1.__importStar(require("./sidriveiq.interface"));

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

@@ -49,15 +49,6 @@ export declare class MockAPI implements API {
     users: UserMockService;
     vault: VaultMockService;
     notifications: NotificationMockService;
-    assetManager: AssetMockService;
-    contentManager: ContentMockService;
-    endpointManager: EndpointMockService;
-    eventsManager: EventsMockService;
-    secretsManager: SecretMockService;
-    siDrive: any;
-    taskManager: TaskMockService;
-    timeSeriesManager: TimeseriesMockService;
-    userManager: UserMockService;
     constructor(initData: {
         assets?: AssetInit[];
         assetRevisions?: AssetRevisionInit[];

package/dist/mock/api.mock.js

@@ -23,7 +23,6 @@ class MockAPI {
     constructor(initData) {
         this.httpClient = null;
         this.proxy = null;
-        this.siDrive = null;
         const { assets = [], assetRevisions = [], contents = [], endpoints = [], secrets = [], timeSeries = [], tasks = [], events = [], users, flows = [], flowRevisions = [], deployments = [], functions = [], functionRevisions = [], modules = [], diagrams = [], labels = [], vault = [], notifications = [], } = initData;
         const assetTypes = assets
             .map((v) => v.type)
@@ -131,14 +130,6 @@ class MockAPI {
         this.labels = new label_mock_service_1.LabelMockService(labels1);
         this.vault = new vault_mock_service_1.VaultMockService(vaultSecrets1);
         this.notifications = new notification_mock_service_1.NotificationMockService(notifications1);
-        this.assetManager = this.assets;
-        this.contentManager = this.contents;
-        this.endpointManager = this.endpoints;
-        this.secretsManager = this.secrets;
-        this.timeSeriesManager = this.timeSeries;
-        this.taskManager = this.tasks;
-        this.eventsManager = this.events;
-        this.userManager = this.users;
     }
 }
 exports.MockAPI = MockAPI;

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

@@ -55,12 +55,12 @@ class AssetMockService extends BaseService {
     }
     async addAttachment(id, form) {
         const asset = this.data.find((v) => v.id === id);
-        const content = await this.api.contentManager.upload(form);
+        const content = await this.api.contents.upload(form);
         asset.attachments.push(content.id);
         return Promise.resolve(asset);
     }
     async getAttachments(assetId) {
-        const contents = await this.api.contentManager.getMany();
+        const contents = await this.api.contents.getMany();
         const docs = contents.docs.filter((c) => { var _a, _b; return (_b = (_a = c.assets) === null || _a === void 0 ? void 0 : _a.includes) === null || _b === void 0 ? void 0 : _b.call(_a, assetId); });
         return { docs, total: docs.length, limit: 0 };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "3.8.1",
+  "version": "4.0.0",
   "description": "Module for easy access to the HahnPRO API",
   "license": "MIT",
   "author": {
@@ -24,10 +24,10 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "~1.3.6",
+    "axios": "~1.4.0",
     "eventsource": "^2.0.2",
     "form-data": "^4.0.0",
-    "jose": "^4.14.1",
+    "jose": "^4.14.4",
     "jwt-decode": "^3.1.2",
     "p-queue": "^6.6.2",
     "ts-mixer": "^6.0.3",

package/dist/sidriveiq.interface.d.ts

@@ -1,104 +0,0 @@
-export interface Asset {
-    id: string;
-    type_id: string;
-    name: string;
-    description: string;
-    tag: string;
-    agent_id: string;
-    is_active: boolean;
-}
-export interface File {
-    id: string;
-    name: string;
-    status: string;
-    content_type: string;
-    created_at: string;
-    length: number;
-}
-export interface List<T> {
-    cursor: string;
-    values: T[];
-}
-export interface Log {
-    ref_id: string;
-    ref_type: RefType;
-    severity: Severity;
-    created_at: string;
-    text: string;
-    actor: string;
-    category: string;
-    item_type: string;
-    gone_at: string;
-}
-export interface Mail {
-    from: string;
-    to: string;
-    cc?: string;
-    subject: string;
-    body: string;
-    is_html: boolean;
-}
-export interface Property {
-    path: string;
-    name: string;
-    unit: string;
-    data_type: string;
-    is_mandatory: boolean;
-}
-export type RefType = 'Unknown' | 'Asset' | 'AssetType' | 'Container' | 'ContainerType' | 'Action' | 'AssetReport' | 'ReportType';
-export type Severity = 'Info' | 'Warning' | 'Error' | 'All';
-export interface Subset {
-    id: string;
-    name: string;
-}
-export interface TimeSeries {
-    ts: string;
-    v: any;
-}
-export interface RangeParams {
-    from?: string | Date;
-    to?: string | Date;
-}
-export interface CursorParams {
-    limit?: number;
-    cursor?: string;
-}
-export interface PaginationParams {
-    page?: number;
-    page_size?: number;
-    sort?: string;
-}
-export interface AssetsParams extends CursorParams {
-    name_filter?: string;
-    type_filter?: string;
-    tag_filter?: string;
-    agent_filter?: string;
-}
-export interface PropertiesParams extends CursorParams {
-    path_filter?: string;
-    subset_filter?: string;
-    only_assigned?: boolean;
-    only_mandatory?: boolean;
-}
-export interface TimeSeriesParams extends CursorParams, RangeParams {
-}
-export interface FilesCountParams extends RangeParams {
-    name_filter?: string;
-    status_filter?: 'Imported' | 'Scanned' | 'ScannedButEmpty';
-    exclude?: string;
-}
-export interface FilesParams extends FilesCountParams, PaginationParams {
-}
-export interface LogsParams extends PaginationParams, RangeParams {
-    categories: string[];
-    severity?: Severity;
-    filter?: string;
-}
-export interface LogDto {
-    text: string;
-    severity: Severity;
-    created_at: string;
-    actor: string;
-    category: string;
-    gone_at: string;
-}

package/dist/sidriveiq.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sidriveiq.service.d.ts

@@ -1,97 +0,0 @@
-import FormData from 'form-data';
-import { HttpClient } from './http.service';
-import { Asset, AssetsParams, File, FilesCountParams, FilesParams, List, Log, LogDto, LogsParams, Mail, PropertiesParams, Property, RangeParams, Subset, TimeSeries, TimeSeriesParams } from './sidriveiq.interface';
-export declare class SiDriveIqService {
-    private readonly httpClient;
-    private basePath;
-    constructor(httpClient: HttpClient);
-    /**
-     * @deprecated
-     */
-    getAssets(params?: AssetsParams): Promise<List<Asset>>;
-    /**
-     * @deprecated
-     */
-    getAssetCount(params?: AssetsParams): Promise<number>;
-    /**
-     * @deprecated
-     */
-    getAsset(assetId: string | number): Promise<Asset>;
-    /**
-     * @deprecated
-     */
-    getProperties(assetId: string | number, params?: PropertiesParams): Promise<List<Property>>;
-    /**
-     * @deprecated
-     */
-    getProperty(assetId: string | number, path: string): Promise<Property>;
-    /**
-     * @deprecated
-     */
-    getSubsets(assetId: string | number): Promise<List<TimeSeries>>;
-    /**
-     * @deprecated
-     */
-    getSubset(assetId: string | number, subsetId: string): Promise<Subset>;
-    /**
-     * @deprecated
-     */
-    getSubsetProperties(assetId: string | number, subsetId: string, pathFilter?: string): Promise<List<Property>>;
-    /**
-     * @deprecated
-     */
-    getTimeSeries(assetId: string | number, path: string, params?: TimeSeriesParams): Promise<List<TimeSeries>>;
-    /**
-     * @deprecated
-     */
-    getTimeSeriesCount(assetId: string | number, path: string, params?: RangeParams): Promise<number>;
-    /**
-     * @deprecated
-     */
-    getRecentTimeSeries(assetId: string | number, path: string, timestamp?: Date): Promise<TimeSeries>;
-    /**
-     * @deprecated
-     */
-    addTimeSeries(assetId: string | number, path: string, values: TimeSeries[]): Promise<void>;
-    /**
-     * @deprecated
-     */
-    getFiles(assetId: string | number, params?: FilesParams): Promise<File[]>;
-    /**
-     * @deprecated
-     */
-    getFileCount(assetId: string | number, params?: FilesCountParams): Promise<number>;
-    /**
-     * @deprecated
-     */
-    getFile(assetId: string | number, fileId: string): Promise<File>;
-    /**
-     * @deprecated
-     */
-    downloadFile(assetId: string | number, fileId: string): Promise<ArrayBuffer>;
-    /**
-     * @deprecated
-     */
-    uploadFile(assetId: string | number, form: FormData): Promise<string>;
-    /**
-     * @deprecated
-     */
-    deleteFile(assetId: string | number, fileId: string): Promise<void>;
-    /**
-     * @deprecated
-     */
-    getLogs(assetId: string | number, params: LogsParams): Promise<List<Log>>;
-    /**
-     * @deprecated
-     */
-    getLogCount(assetId: string | number, params: LogsParams): Promise<number>;
-    /**
-     * @deprecated
-     */
-    addLog(assetId: string | number, item: LogDto): Promise<void>;
-    /**
-     * @deprecated
-     */
-    sendMail(mail: Mail): Promise<string>;
-    private convertDates;
-}

package/dist/sidriveiq.service.js

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SiDriveIqService = void 0;
-class SiDriveIqService {
-    constructor(httpClient) {
-        this.httpClient = httpClient;
-        this.basePath = '/proxy/sidrive/api/v0';
-    }
-    getAssets(params = {}) {
-        return this.httpClient.get(`${this.basePath}/assets`, { params });
-    }
-    getAssetCount(params = {}) {
-        return this.httpClient.get(`${this.basePath}/assets/count`, { params });
-    }
-    getAsset(assetId) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}`);
-    }
-    getProperties(assetId, params = {}) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/properties`, { params });
-    }
-    getProperty(assetId, path) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/properties/${path}`);
-    }
-    getSubsets(assetId) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/subsets`);
-    }
-    getSubset(assetId, subsetId) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/subsets/${subsetId}`);
-    }
-    getSubsetProperties(assetId, subsetId, pathFilter) {
-        const params = Object.assign({}, (pathFilter && { path_filter: pathFilter }));
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/subsets/${subsetId}/properties`, { params });
-    }
-    getTimeSeries(assetId, path, params = {}) {
-        params = this.convertDates(params);
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/properties/${path}/timeseries`, { params });
-    }
-    getTimeSeriesCount(assetId, path, params = {}) {
-        params = this.convertDates(params);
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/properties/${path}/timeseries/count`, { params });
-    }
-    getRecentTimeSeries(assetId, path, timestamp) {
-        const params = Object.assign({}, (timestamp && { timestamp: timestamp.toISOString() }));
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/properties/${path}/timeseries/recent`, { params });
-    }
-    addTimeSeries(assetId, path, values) {
-        return this.httpClient.post(`${this.basePath}/assets/${assetId}/properties/${path}/timeseries`, values);
-    }
-    getFiles(assetId, params = {}) {
-        params = this.convertDates(params);
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/files/import`, { params });
-    }
-    getFileCount(assetId, params = {}) {
-        params = this.convertDates(params);
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/files/import/count`, { params });
-    }
-    getFile(assetId, fileId) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/files/import/${fileId}`);
-    }
-    downloadFile(assetId, fileId) {
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/files/import/${fileId}/download`, {
-            headers: { 'response-type': 'arraybuffer' },
-            responseType: 'arraybuffer',
-        });
-    }
-    uploadFile(assetId, form) {
-        const headers = Object.assign({}, form.getHeaders());
-        return this.httpClient.post(`${this.basePath}/assets/${assetId}/files/import`, form, { headers });
-    }
-    deleteFile(assetId, fileId) {
-        return this.httpClient.delete(`${this.basePath}/assets/${assetId}/files/import/${fileId}`);
-    }
-    getLogs(assetId, params) {
-        params = this.convertDates(params);
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/logs`, { params });
-    }
-    getLogCount(assetId, params) {
-        params = this.convertDates(params);
-        return this.httpClient.get(`${this.basePath}/assets/${assetId}/logs/count`, { params });
-    }
-    addLog(assetId, item) {
-        return this.httpClient.post(`${this.basePath}/assets/${assetId}/logs`, item);
-    }
-    sendMail(mail) {
-        return this.httpClient.post(`${this.basePath}/mails`, mail);
-    }
-    convertDates(params) {
-        if (params.from) {
-            params.from = new Date(params.from).toISOString();
-        }
-        if (params.to) {
-            params.to = new Date(params.to).toISOString();
-        }
-        return params;
-    }
-}
-exports.SiDriveIqService = SiDriveIqService;