@hahnpro/flow-sdk 9.6.5 → 2025.2.0-beta.2

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

@@ -10,13 +10,13 @@ exports.handleApiError = handleApiError;
 exports.runPyScript = runPyScript;
 exports.truncate = truncate;
 const tslib_1 = require("tslib");
-const axios_1 = require("axios");
 const fs_1 = require("fs");
-const isPlainObject_1 = tslib_1.__importDefault(require("lodash/isPlainObject"));
 const path_1 = require("path");
+const util_1 = require("util");
+const axios_1 = require("axios");
+const isPlainObject_1 = tslib_1.__importDefault(require("lodash/isPlainObject"));
 const python_shell_1 = require("python-shell");
 const string_interp_1 = tslib_1.__importDefault(require("string-interp"));
-const util_1 = require("util");
 function fillTemplate(value, ...templateVariables) {
     if ((0, isPlainObject_1.default)(value)) {
         for (const key of Object.keys(value)) {
@@ -39,6 +39,7 @@ function fillTemplate(value, ...templateVariables) {
                 }
             }
             catch (err) {
+                // ignore
             }
         }
     }
@@ -64,6 +65,42 @@ function toArray(value = []) {
 function delay(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
+/**
+ * Creates a promise that resolves after a specified delay, with support for cancellation via an AbortSignal.
+ *
+ * @param {number} ms - The delay duration in milliseconds.
+ * @param {Object} [options] - Optional configuration.
+ * @param {AbortSignal} [options.signal] - An AbortSignal to allow cancellation of the delay.
+ *
+ * @returns {Promise<void>} A promise that resolves after the specified delay or rejects if aborted.
+ *
+ * @throws {Error} If the AbortSignal is already aborted or gets aborted during the delay, the promise rejects with an "AbortError".
+ *
+ * @details Usage:
+ * ```typescript
+ * @FlowFunction('test.task.LongRunningTask')
+ * class LongRunningTask extends FlowTask<Properties> {
+ *   private readonly abortController = new AbortController();
+ *
+ *   constructor(...) {...}
+ *
+ *   @InputStream()
+ *   public async loveMeLongTime(event) {
+ *     try {
+ *       await delayWithAbort(this.properties.delay, { signal: this.abortController.signal });
+ *       return this.emitEvent({ foo: 'bar' }, null);
+ *     } catch (err) {
+ *       if (err.message === 'AbortError') {
+ *         return; // Task was aborted
+ *       }
+ *       throw err;
+ *     }
+ *   }
+ *
+ *   public onDestroy = () => { this.abortController.abort(); };
+ * }
+ * ```
+ */
 function delayWithAbort(ms, options) {
     return new Promise((resolve, reject) => {
         if (options?.signal?.aborted) {
@@ -80,6 +117,7 @@ function delayWithAbort(ms, options) {
 async function deleteFiles(dir, ...filenames) {
     for (const filename of filenames) {
         await fs_1.promises.unlink((0, path_1.join)(dir, filename)).catch((err) => {
+            /*ignore*/
         });
     }
 }
@@ -128,6 +166,9 @@ function runPyScript(scriptPath, data) {
         });
     });
 }
+/**
+ * Truncates an object or string to the specified max length and depth
+ */
 function truncate(msg, depth = 4, maxStringLength = 1000) {
     let truncated = (0, util_1.inspect)(msg, { depth, maxStringLength });
     if (truncated.startsWith("'") && truncated.endsWith("'")) {

package/LICENSE

@@ -1,21 +0,0 @@
-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 → src/lib}/FlowApplication.d.ts

@@ -5,11 +5,11 @@ import { AmqpConnectionManager } from 'amqp-connection-manager';
 import { CloudEvent } from 'cloudevents';
 import { PartialObserver } from 'rxjs';
 import { AmqpConnection, AmqpConnectionConfig } from './amqp';
+import { ContextManager } from './ContextManager';
 import { ClassType, Flow, FlowElementContext } from './flow.interface';
 import { FlowEvent } from './FlowEvent';
 import { Logger } from './FlowLogger';
 import { RpcClient } from './RpcClient';
-import { ContextManager } from './ContextManager';
 interface FlowAppConfig {
     logger?: Logger;
     amqpConfig?: AmqpConnectionConfig;

package/{dist → src/lib}/FlowElement.d.ts

@@ -1,5 +1,5 @@
-import { PythonShell } from 'python-shell';
 import { API } from '@hahnpro/hpc-api';
+import { PythonShell } from 'python-shell';
 import { ClassType, DeploymentMessage, FlowContext, FlowElementContext } from './flow.interface';
 import { Context } from './FlowApplication';
 import { FlowEvent } from './FlowEvent';

package/{dist → src/lib}/nats.d.ts

@@ -1,6 +1,6 @@
+import { Consumer, ConsumerConfig, PubAck } from '@nats-io/jetstream';
 import { ConnectionOptions, NatsConnection } from '@nats-io/nats-core';
 import { CloudEvent } from 'cloudevents';
-import { Consumer, ConsumerConfig, PubAck } from '@nats-io/jetstream';
 import { Logger } from './FlowLogger';
 export type NatsEvent<T> = Pick<CloudEvent<T>, 'type' | 'source' | 'subject' | 'data' | 'datacontenttype' | 'time'>;
 export declare const natsFlowsPrefixFlowDeployment = "fs.flowdeployment";