@hahnpro/hpc-api 6.0.0 → 2024.4.0-1

package/CHANGELOG.md

@@ -0,0 +1,383 @@
+# @hahnpro/hpc-api
+
+## [Unreleased]
+
+### Major Changes
+
+- This package now follows a calendar versioning scheme and is tied to the HahnPRO Cloud version.
+
+## 6.0.0
+
+### Major Changes
+
+- df8453d: # Overview
+
+  Multiple ways of providing an authentication token have been added.
+
+  A token can be provided to the `HttpClient` by calling `provideExternalToken(...)`, this token will be used for API-Calls,
+  instead of getting a token directly using the User-Id and Secret.
+
+  Another option ist providing a token directly at an API-Call. For this, a new Option has been added to every API method.
+
+  ```typescript
+  await api.assets.getOne('someId', { token: 'TOKEN' });
+  ```
+
+  The third option is to overwrite the `getAccessToken()` method of the `HttpClient`.
+
+  The hierarchy of options is:
+
+  1. token from api-call
+  2. token from `provideExternalToken`
+  3. token from `getAccessToken`
+
+  # Breaking Changes
+
+  1. The signature of `flowDeployments::updateOne` has been changed. The positional parameter `force` is now part of the `options` object (where you can also provide a token as described above).
+
+## 5.3.4
+
+### Patch Changes
+
+- d3e7ca1: Updated dependencies to reduce vulnerabilities
+
+## 5.3.3
+
+### Patch Changes
+
+- ef6ee56: added missing asset-type-service init to Mock-API
+
+## 5.3.2
+
+### Patch Changes
+
+- b783a01: Updated dependencies to reduce vulnerabilities
+
+## 5.3.1
+
+### Patch Changes
+
+- 74b888f: Updated dependencies to reduce vulnerabilities
+
+## 5.3.0
+
+### Minor Changes
+
+- 0ce38af: Allow Flow-Deployments to be run with owners permissions
+
+## 5.2.8
+
+### Patch Changes
+
+- 4a1d52d: updated axios for vulnerability
+
+## 5.2.7
+
+### Patch Changes
+
+- 713ccbd: Updated dependencies to reduce vulnerabilities
+
+## 5.2.6
+
+### Patch Changes
+
+- 6c7abb2: Updated dependencies to reduce vulnerabilities
+
+## 5.2.5
+
+### Patch Changes
+
+- a6eebf2: Updated dependencies to reduce vulnerabilities
+
+## 5.2.4
+
+### Patch Changes
+
+- f93e4f9: Updated dependencies to reduce vulnerabilities
+
+## 5.2.3
+
+### Patch Changes
+
+- 39b5f50: Updated dependencies to reduce vulnerabilities
+
+## 5.2.2
+
+- Fixed getFilterString method for api services to filter out null and undefined values
+
+## 5.2.1
+
+### Patch Changes
+
+- a431b4f: Added type check to getFilterString function
+
+## 5.2.0
+
+### Minor Changes
+
+- e4a9f4d: Added addManyAssetTimeSeriesValues method to TimeSeries API service
+
+## 5.1.0
+
+### Minor Changes
+
+- f0c4d8d: extend filters of getManyFiltered() + improve mock api
+
+## 5.0.0
+
+### Major Changes
+
+- 19af51f: Updated dependencies to reduce vulnerabilities
+
+  **Breaking changes**
+
+  - Raise minimum Node.js version to v18 for hpc-api and flow-sdk packages
+
+## 4.1.2
+
+### Patch Changes
+
+- f86bcac: Updated dependencies to reduce vulnerabilities
+
+## 4.1.1
+
+### Patch Changes
+
+- eb65f7f: Fixed build target to make api-package compatible with tools that use older language versions (i.e. cypress)
+
+## 4.1.0
+
+### Minor Changes
+
+- 621277d: add event level override functions to asset service
+
+## 4.0.2
+
+### Patch Changes
+
+- cdcd295: add new property to notification service
+
+## 4.0.1
+
+### Patch Changes
+
+- 92673bb: Updated dependencies to reduce vulnerabilities
+
+## 4.0.0
+
+### Major Changes
+
+- a7ea37b: Removed deprecated API methods and properties
+
+### Minor Changes
+
+- a7ea37b: Allow API HttpClient to be provided
+
+## 3.8.1
+
+### Patch Changes
+
+- 75c87ab: fixed addition of timeseries values and events in mock api
+
+## 3.8.0
+
+### Minor Changes
+
+- 6cd509a: Added notification endpoint to create and update notifications
+
+## 3.7.1
+
+### Patch Changes
+
+- 1b1b2d0: Fixed auth token expiration check
+
+## 3.7.0
+
+### Minor Changes
+
+- 7159fd4: Added API function to get Asset Attachments
+
+## 3.6.7
+
+### Patch Changes
+
+- d6e655c: Updated dependencies to reduce vulnerabilities
+
+## 3.6.6
+
+### Patch Changes
+
+- b53dd91: fix addition of timeseries values in mock api
+
+## 3.6.5
+
+### Patch Changes
+
+- b5c2b74: Updated dependencies to reduce vulnerabilities
+
+## 3.6.4
+
+### Patch Changes
+
+- f445b96: Fixes issue with http response encoding/transformation by downgrading axios
+
+## 3.6.3
+
+### Patch Changes
+
+- 827a101: Updated dependencies to reduce vulnerabilities
+
+## 3.6.2
+
+### Patch Changes
+
+- c40f5c5: updated dependencies to reduce vulnerabilities
+
+## 3.6.1
+
+### Patch Changes
+
+- bcc1b60: Fixed bug where wrong endpoint was called when requesting flow diagram revisions. The flow revisions endpoint was called instead.
+
+## 3.6.0
+
+### Minor Changes
+
+- 6a5ab51: fix vault base path
+
+## 3.5.0
+
+### Minor Changes
+
+- f2b8d05: add vault endpoint to create and get secrets
+
+## 3.4.4
+
+### Patch Changes
+
+- 29eb88e: changed over to uuid package for uuid generation. as crypto package is not usable in a cross-platform manner.
+
+## 3.4.3
+
+### Patch Changes
+
+- 6ce20bb: Migrated form openid-client to custom auth implementation, to make the api package browser compatible
+
+## 3.4.2
+
+### Patch Changes
+
+- fa3bf33: Fixes base path of authorization url for HPC API
+
+## 3.4.1
+
+### Patch Changes
+
+- e5202b0: Added paused status to FlowDeploymentService::updateStatus
+
+## 3.4.0
+
+### Minor Changes
+
+- 675a239: Use the more secure client_secret_jwt authentication method for authenticating service accounts against the HPC API
+
+## 3.3.0
+
+### Minor Changes
+
+- 8bd0141: added trash endpoint for all supported resources
+
+## 3.2.1
+
+### Patch Changes
+
+- e0868c0: added createdAt and updatedAt attributes to Event interface
+
+## 3.2.0
+
+### Minor Changes
+
+- 966f2e2: added label service for communication with labels API
+
+## 3.1.0
+
+### Minor Changes
+
+- d95c007: added function for interaction with asset-paperbin API
+
+## 3.0.0
+
+### Major Changes
+
+- 2c6d6f9: added revision functionality for AM and FS
+  - added _getRevisions_, _rollback_ and _deleteRevision_ methods to the services of assets, assettypes, flow-functions and flows
+  - **BREAKING** renamed _findRevisions_ of asset service to _getRevisions_
+  - **BREAKING** renamed old _getRevisions_ method of flow service to _getDiagramRevisions_
+  - **BREAKING** removed _getOneWithHistory_ method of flow-function service and the history and current attributes of flow-functions (use _getRevisions_ instead)
+
+## 2.3.1
+
+### Patch Changes
+
+- 3e3ee84: fixed from wrong date access function to valueof
+
+## 2.3.0
+
+### Minor Changes
+
+- 1edd4da: Added function to flow-service to get flow revisions and function to check if a deployment is on the latest version
+
+## 2.2.0
+
+### Minor Changes
+
+- eac4dea: Added functions for flow-service
+
+## 2.1.1
+
+### Patch Changes
+
+- 8edcf1c: fixed breaking change in mock-api
+
+## 2.1.0
+
+### Minor Changes
+
+- 5c2c1c6: feat: added findRevisions to the asset service
+
+## 2.0.0
+
+### Major Changes
+
+- d16e8fc: Updated the interface types to reflect changes to the Assettypes in the HPC-API.
+
+## 1.1.0
+
+### Minor Changes
+
+- 85cc9d7: add assetId and assetName to endpoint api and combine parameters to a single object
+
+## 1.0.3
+
+### Patch Changes
+
+- dac742f: changed Mock-API init types to be dependent on real types
+
+## 1.0.2
+
+### Patch Changes
+
+- Improve handling of API_BASE_URL and API_BASE_PATH environment variables
+
+## 1.0.1
+
+### Patch Changes
+
+- 507dd6e: Added tags to Assettype interface
+- ab04943: Add timeout for http request queue operations
+
+## 1.0.0
+
+### Major Changes
+
+- 205b556: Split API from main SDK package to its own package.

package/README.md

@@ -0,0 +1,11 @@
+# hpc-api
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build hpc-api` to build the library.
+
+## Running unit tests
+
+Run `nx test hpc-api` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -1,47 +1,30 @@
 {
   "name": "@hahnpro/hpc-api",
-  "version": "6.0.0",
-  "description": "Module for easy access to the HahnPRO API",
+  "version": "2024.4.0-1",
+  "description": "Module for easy access to the HahnPRO Cloud API",
   "license": "MIT",
   "author": {
     "name": "Hahn Projects GmbH",
     "url": "https://hahnpro.com"
   },
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:hahnprojects/flow.git"
-  },
-  "directories": {
-    "lib": "lib",
-    "test": "test"
-  },
-  "files": [
-    "dist"
-  ],
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
   "dependencies": {
     "axios": "1.7.9",
-    "eventsource": "2.0.2",
+    "eventsource": "3.0.2",
     "form-data": "4.0.1",
     "jose": "5.9.6",
     "jwt-decode": "4.0.0",
-    "p-queue": "6.6.2",
+    "p-queue": "8.1.0",
     "ts-mixer": "6.0.4",
-    "uuid": "11.0.5"
+    "tslib": "2.8.1"
   },
   "devDependencies": {
-    "@types/eventsource": "1.1.15",
     "axios-mock-adapter": "2.1.0"
   },
   "engines": {
-    "node": ">=v18"
+    "node": ">=v20"
   },
-  "scripts": {
-    "build": "../../node_modules/.bin/tsc -p tsconfig.lib.json",
-    "build:nocomments": "../../node_modules/.bin/tsc -p tsconfig.nocomments.json"
-  }
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "module": "./src/index.js",
+  "type": "module"
 }

package/src/index.d.ts

@@ -0,0 +1,20 @@
+export * from './lib/api';
+export * from './lib/asset.interface';
+export * from './lib/content.interface';
+export * from './lib/data.interface';
+export * from './lib/data.service';
+export * from './lib/endpoint.interface';
+export * from './lib/events.interface';
+export * from './lib/flow.interface';
+export * from './lib/flow-deployment.interface';
+export * from './lib/flow-function.interface';
+export * from './lib/http.service';
+export * from './lib/label.interface';
+export * from './lib/mock';
+export * from './lib/notification.interface';
+export * from './lib/resource.interface';
+export * from './lib/schema.interface';
+export * from './lib/secret.interface';
+export * from './lib/task.interface';
+export * from './lib/timeseries.interface';
+export * from './lib/vault.interface';

package/src/index.js

@@ -0,0 +1,20 @@
+export * from './lib/api';
+export * from './lib/asset.interface';
+export * from './lib/content.interface';
+export * from './lib/data.interface';
+export * from './lib/data.service';
+export * from './lib/endpoint.interface';
+export * from './lib/events.interface';
+export * from './lib/flow.interface';
+export * from './lib/flow-deployment.interface';
+export * from './lib/flow-function.interface';
+export * from './lib/http.service';
+export * from './lib/label.interface';
+export * from './lib/mock';
+export * from './lib/notification.interface';
+export * from './lib/resource.interface';
+export * from './lib/schema.interface';
+export * from './lib/secret.interface';
+export * from './lib/task.interface';
+export * from './lib/timeseries.interface';
+export * from './lib/vault.interface';

package/{dist → src/lib}/Queue.js

@@ -1,9 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Queue = void 0;
-const tslib_1 = require("tslib");
-const p_queue_1 = tslib_1.__importDefault(require("p-queue"));
-class Queue extends p_queue_1.default {
+import PQueue from 'p-queue';
+export class Queue extends PQueue {
     constructor(options) {
         super(options);
         this.peak = 0;
@@ -24,4 +20,3 @@ class Queue extends p_queue_1.default {
         };
     }
 }
-exports.Queue = Queue;

package/src/lib/api-base.js

@@ -0,0 +1,6 @@
+export class APIBase {
+    constructor(httpClient, basePath) {
+        this.httpClient = httpClient;
+        this.basePath = basePath;
+    }
+}

package/src/lib/api.js

@@ -0,0 +1,60 @@
+import { AssetService } from './asset.service';
+import { AssetTypesService } from './assettypes.service';
+import { ContentService } from './content.service';
+import { EndpointService } from './endpoint.service';
+import { EventsService } from './events.service';
+import { FlowDeploymentService } from './flow-deployment.service';
+import { FlowFunctionService } from './flow-function.service';
+import { FlowModuleService } from './flow-module.service';
+import { FlowService } from './flow.service';
+import { HttpClient } from './http.service';
+import { LabelService } from './label.service';
+import { NotificationService } from './notification.service';
+import { ProxyService } from './proxy.service';
+import { SecretService } from './secret.service';
+import { TaskService } from './task.service';
+import { TimeSeriesService } from './timeseries.service';
+import { UserService } from './user.service';
+import { VaultService } from './vault.service';
+export class API {
+    constructor(httpClient, context) {
+        this.httpClient = httpClient;
+        if (!httpClient) {
+            // remove leading and trailing slashes
+            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')) {
+                /* eslint-disable-next-line no-console */
+                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 HttpClient(apiUrl, authUrl, realm, client, secret, context?.tokenSubject);
+        }
+        this.assets = new AssetService(this.httpClient);
+        this.assetTypes = new AssetTypesService(this.httpClient);
+        this.contents = new ContentService(this.httpClient);
+        this.endpoints = new EndpointService(this.httpClient);
+        this.events = new EventsService(this.httpClient);
+        this.flows = new FlowService(this.httpClient);
+        this.flowDeployments = new FlowDeploymentService(this.httpClient);
+        this.flowFunctions = new FlowFunctionService(this.httpClient);
+        this.flowModules = new FlowModuleService(this.httpClient);
+        this.labels = new LabelService(this.httpClient);
+        this.proxy = new ProxyService(this.httpClient);
+        this.secrets = new SecretService(this.httpClient);
+        this.tasks = new TaskService(this.httpClient);
+        this.timeSeries = new TimeSeriesService(this.httpClient);
+        this.users = new UserService(this.httpClient);
+        this.vault = new VaultService(this.httpClient);
+        this.notifications = new NotificationService(this.httpClient);
+    }
+}

package/src/lib/asset.interface.js

@@ -0,0 +1 @@
+export {};

package/{dist → src/lib}/asset.service.js

@@ -1,26 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssetService = void 0;
-const tslib_1 = require("tslib");
-const ts_mixer_1 = require("ts-mixer");
-const api_base_1 = require("./api-base");
-const data_service_1 = require("./data.service");
-const trash_service_1 = require("./trash.service");
-let BaseService = class BaseService extends api_base_1.APIBase {
+import { __decorate } from "tslib";
+import { mix } from 'ts-mixer';
+import { APIBase } from './api-base';
+import { DataService } from './data.service';
+import { TrashService } from './trash.service';
+let BaseService = class BaseService extends APIBase {
 };
-BaseService = tslib_1.__decorate([
-    (0, ts_mixer_1.mix)(data_service_1.DataService, trash_service_1.TrashService)
+BaseService = __decorate([
+    mix(DataService, TrashService)
 ], BaseService);
-class AssetService extends BaseService {
+export class AssetService extends BaseService {
     constructor(httpClient) {
         super(httpClient, '/assets');
         this.addAttachment = (id, form, options = {}) => {
-            const headers = Object.assign({}, form.getHeaders());
-            return this.httpClient.post(`${this.basePath}/${id}/attachment`, form, Object.assign({ headers, maxBodyLength: Infinity, maxContentLength: Infinity }, options));
+            const headers = { ...form.getHeaders() };
+            return this.httpClient.post(`${this.basePath}/${id}/attachment`, form, {
+                headers,
+                maxBodyLength: Infinity,
+                maxContentLength: Infinity,
+                ...options,
+            });
         };
     }
     deleteOne(id, force = false, options = {}) {
-        return this.httpClient.delete(`${this.basePath}/${id}`, Object.assign({ params: { force } }, options));
+        return this.httpClient.delete(`${this.basePath}/${id}`, { params: { force }, ...options });
     }
     getChildren(assetId, params = {}, options = {}) {
         return this.getManyFiltered({ parent: assetId }, params, options);
@@ -29,7 +31,10 @@ class AssetService extends BaseService {
         return this.httpClient.get(`${this.basePath}/${assetId}/attachments`, options);
     }
     getEventLevelOverride(ids, causes, options = {}) {
-        return this.httpClient.get(`${this.basePath}/eventcauses`, Object.assign({ params: { ids: ids.join(','), causes: causes.join(',') } }, options));
+        return this.httpClient.get(`${this.basePath}/eventcauses`, {
+            params: { ids: ids.join(','), causes: causes.join(',') },
+            ...options,
+        });
     }
     updateEventCausesAsset(id, dto, options = {}) {
         return this.httpClient.put(`${this.basePath}/${id}/eventcauses`, dto, options);
@@ -44,4 +49,3 @@ class AssetService extends BaseService {
         return this.httpClient.delete(`${this.basePath}/${assetId}/revisions/${revisionId}`, options);
     }
 }
-exports.AssetService = AssetService;

package/src/lib/assettypes.service.js

@@ -0,0 +1,24 @@
+import { __decorate } from "tslib";
+import { mix } from 'ts-mixer';
+import { APIBase } from './api-base';
+import { DataService } from './data.service';
+import { TrashService } from './trash.service';
+let BaseService = class BaseService extends APIBase {
+};
+BaseService = __decorate([
+    mix(DataService, TrashService)
+], BaseService);
+export class AssetTypesService extends BaseService {
+    constructor(httpClient) {
+        super(httpClient, '/assettypes');
+    }
+    getRevisions(id, options = {}) {
+        return this.httpClient.get(`${this.basePath}/${id}/revisions`, options);
+    }
+    rollback(id, revisionId, options = {}) {
+        return this.httpClient.put(`${this.basePath}/${id}/rollback`, { revisionId }, options);
+    }
+    deleteRevision(id, revisionId, options = {}) {
+        return this.httpClient.delete(`${this.basePath}/${id}/revisions/${revisionId}`, options);
+    }
+}

package/{dist → src/lib}/content.interface.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReturnType = void 0;
-var ReturnType;
+export var ReturnType;
 (function (ReturnType) {
     ReturnType[ReturnType["TEXT"] = 0] = "TEXT";
     ReturnType[ReturnType["JSON"] = 1] = "JSON";
@@ -9,4 +6,4 @@ var ReturnType;
     ReturnType[ReturnType["BLOB"] = 3] = "BLOB";
     ReturnType[ReturnType["ARRAYBUFFER"] = 4] = "ARRAYBUFFER";
     ReturnType[ReturnType["NODESTREAM"] = 5] = "NODESTREAM";
-})(ReturnType || (exports.ReturnType = ReturnType = {}));
+})(ReturnType || (ReturnType = {}));