aparavi-client 1.0.2

package/dist/cli/src/types/events.js

@@ -0,0 +1,119 @@
+"use strict";
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENT_TYPE = void 0;
+/**
+ * Event type enumeration for sophisticated client subscription and event routing.
+ *
+ * This enumeration defines event categories used for intelligent event filtering
+ * and routing in multi-client environments. It enables clients to subscribe
+ * to specific types of events based on their needs and capabilities, reducing
+ * network traffic and improving system performance.
+ *
+ * Event Categories:
+ * ----------------
+ * NONE: Unsubscribe from all events (cleanup and disconnection)
+ * ALL: Subscribe to all events regardless of category (comprehensive monitoring)
+ * DEBUGGER: Debug-specific events for debugging protocol communication
+ * DETAIL: Real-time processing events requiring immediate client attention
+ * SUMMARY: Periodic status summaries suitable for dashboard monitoring
+ * OUTPUT: Standard output and logging messages
+ * FLOW: Pipeline flow events - component execution tracking
+ * TASK: Task lifecycle events - start, stop, state changes
+ *
+ * Subscription Strategies:
+ * -----------------------
+ * NONE: Used during client disconnection to stop all event delivery
+ *       and perform cleanup of monitoring subscriptions.
+ *
+ * ALL: Comprehensive monitoring for administrative clients that need
+ *      complete visibility into task execution and debugging activities.
+ *
+ * DEBUGGER: Debug protocol events including breakpoint hits, variable
+ *           changes, stack traces, and debugging session management.
+ *
+ * DETAIL: Real-time processing events including object processing updates,
+ *         error/warning messages, metrics updates, and immediate status
+ *         changes requiring client response or display updates.
+ *
+ * SUMMARY: Periodic status summaries sent at CONST_STATUS_UPDATE_FREQ
+ *          intervals containing complete task status, suitable for
+ *          monitoring dashboards and periodic client updates.
+ *
+ * OUTPUT: Standard output and logging messages from task execution.
+ *
+ * FLOW: Pipeline flow events tracking component execution, data flow
+ *       between pipeline stages, and processing pipeline status.
+ *
+ * TASK: Task lifecycle events including task start, stop, pause, resume,
+ *       and state changes for task management interfaces.
+ *
+ * Network Optimization:
+ * --------------------
+ * Event filtering reduces network traffic by sending only relevant events
+ * to interested clients. SUMMARY subscriptions receive consolidated status
+ * updates rather than individual processing events, significantly reducing
+ * bandwidth usage for monitoring applications.
+ *
+ * Multi-Client Support:
+ * --------------------
+ * Different clients can subscribe to different event types simultaneously:
+ * - Debugging clients: DEBUGGER + DETAIL for comprehensive debugging
+ * - Monitoring dashboards: SUMMARY for efficient status tracking
+ * - Administrative tools: ALL for complete system visibility
+ * - Log viewers: OUTPUT for message monitoring
+ * - Pipeline managers: FLOW + TASK for execution tracking
+ *
+ * @example
+ * ```typescript
+ * // Subscribe to debugging and detail events
+ * const subscription = EVENT_TYPE.DEBUGGER | EVENT_TYPE.DETAIL;
+ *
+ * // Check if client wants specific events
+ * if (clientSubscription & EVENT_TYPE.SUMMARY) {
+ *     sendSummaryUpdate(client, taskStatus);
+ * }
+ * ```
+ */
+var EVENT_TYPE;
+(function (EVENT_TYPE) {
+    /** No events - unsubscribe from all event types */
+    EVENT_TYPE[EVENT_TYPE["NONE"] = 0] = "NONE";
+    /** Debug protocol events - DAP and debugging-specific events like breakpoints, stack traces */
+    EVENT_TYPE[EVENT_TYPE["DEBUGGER"] = 1] = "DEBUGGER";
+    /** Real-time processing events - immediate updates for live monitoring */
+    EVENT_TYPE[EVENT_TYPE["DETAIL"] = 2] = "DETAIL";
+    /** Periodic status summaries - dashboard monitoring with reduced frequency */
+    EVENT_TYPE[EVENT_TYPE["SUMMARY"] = 4] = "SUMMARY";
+    /** Standard output and logging messages from task execution */
+    EVENT_TYPE[EVENT_TYPE["OUTPUT"] = 8] = "OUTPUT";
+    /** Pipeline flow events - component execution tracking and data flow visualization */
+    EVENT_TYPE[EVENT_TYPE["FLOW"] = 16] = "FLOW";
+    /** Task lifecycle events - start, stop, state changes, and task management */
+    EVENT_TYPE[EVENT_TYPE["TASK"] = 32] = "TASK";
+    /** Convenience combination - ALL events except NONE for comprehensive monitoring */
+    EVENT_TYPE[EVENT_TYPE["ALL"] = 63] = "ALL"; // Binary: 111111
+})(EVENT_TYPE || (exports.EVENT_TYPE = EVENT_TYPE = {}));
+//# sourceMappingURL=events.js.map

package/dist/cli/src/types/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../../aparavi-client/src/types/events.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,IAAY,UAwBX;AAxBD,WAAY,UAAU;IACrB,mDAAmD;IACnD,2CAAQ,CAAA;IAER,+FAA+F;IAC/F,mDAAiB,CAAA;IAEjB,0EAA0E;IAC1E,+CAAe,CAAA;IAEf,8EAA8E;IAC9E,iDAAgB,CAAA;IAEhB,+DAA+D;IAC/D,+CAAe,CAAA;IAEf,sFAAsF;IACtF,4CAAa,CAAA;IAEb,8EAA8E;IAC9E,4CAAa,CAAA;IAEb,oFAAoF;IACpF,0CAAwD,CAAA,CAAC,iBAAiB;AAC3E,CAAC,EAxBW,UAAU,0BAAV,UAAU,QAwBrB"}

package/dist/cli/src/types/index.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Type definitions for the Aparavi TypeScript SDK.
+ *
+ * Re-exports all type definitions from individual modules for convenient imports.
+ */
+__exportStar(require("./client"), exports);
+__exportStar(require("./data"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./pipeline"), exports);
+__exportStar(require("./task"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cli/src/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../aparavi-client/src/types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;;;;;;;AAEH;;;;GAIG;AAEH,2CAAyB;AACzB,yCAAuB;AACvB,2CAAyB;AACzB,6CAA2B;AAC3B,yCAAuB"}

package/dist/cli/src/types/pipeline.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pipeline.js.map

package/dist/cli/src/types/pipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../../../../aparavi-client/src/types/pipeline.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG"}

package/dist/cli/src/types/task.js

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TASK_STATE = void 0;
+/**
+ * Task Management Types: Comprehensive Status Tracking and Event Management System.
+ *
+ * This module defines the complete type system for sophisticated task lifecycle management,
+ * real-time status monitoring, and event-driven communication in distributed computational
+ * pipeline systems. It provides structured data models for tracking complex task execution
+ * states, processing statistics, error management, and pipeline flow visualization.
+ */
+/**
+ * Task lifecycle state enumeration for comprehensive state management.
+ *
+ * This enumeration defines all possible states in the task execution lifecycle,
+ * providing clear state transitions and enabling proper resource management,
+ * error handling, and client notification. Each state represents a distinct
+ * phase with specific characteristics and available operations.
+ *
+ * Lifecycle Phases:
+ * ----------------
+ * NONE: Initial state before any resources are allocated or configuration
+ *       is processed. Tasks in this state can be safely discarded without
+ *       cleanup operations.
+ *
+ * STARTING: Resource allocation and initial setup phase. Ports are allocated,
+ *           temporary files created, and subprocess preparation occurs.
+ *
+ * INITIALIZING: Subprocess has been created and is performing pipeline
+ *               initialization. Service interfaces are being established.
+ *
+ * RUNNING: Task is operational and processing requests. All interfaces
+ *          are available and the pipeline is actively executing.
+ *
+ * STOPPING: Graceful shutdown initiated. Subprocess is being terminated
+ *           and resources are being cleaned up.
+ *
+ * COMPLETED: Task finished successfully. All resources cleaned up and
+ *            final status available for client queries.
+ *
+ * CANCELLED: Task was terminated before completion. Resources cleaned up
+ *            and termination reason available in status.
+ *
+ * State Transitions:
+ * -----------------
+ * Normal execution flow:
+ * NONE → STARTING → INITIALIZING → RUNNING → STOPPING → COMPLETED
+ *
+ * Cancellation flow:
+ * Any state → STOPPING → CANCELLED
+ *
+ * Error handling:
+ * Any state → STOPPING → COMPLETED (with error exit code)
+ *
+ * Resource Management:
+ * -------------------
+ * - NONE/COMPLETED/CANCELLED: No active resources requiring cleanup
+ * - STARTING/INITIALIZING/RUNNING: Active resources requiring cleanup
+ * - STOPPING: Cleanup in progress, resources being deallocated
+ *
+ * Client Operations:
+ * -----------------
+ * - NONE: Configuration and launch operations available
+ * - STARTING/INITIALIZING: Status monitoring available
+ * - RUNNING: Full debugging and data processing operations available
+ * - STOPPING: Limited status monitoring, operations being rejected
+ * - COMPLETED/CANCELLED: Status queries only, task cleanup may be initiated
+ *
+ * Wait Operations:
+ * ---------------
+ * Clients can wait for specific state transitions using wait_for_running()
+ * and similar methods. State transitions trigger event notifications to
+ * all subscribed monitoring clients.
+ */
+var TASK_STATE;
+(function (TASK_STATE) {
+    /** Initial state - no resources allocated */
+    TASK_STATE[TASK_STATE["NONE"] = 0] = "NONE";
+    /** Resource allocation and subprocess preparation */
+    TASK_STATE[TASK_STATE["STARTING"] = 1] = "STARTING";
+    /** Subprocess initialization and service startup */
+    TASK_STATE[TASK_STATE["INITIALIZING"] = 2] = "INITIALIZING";
+    /** Operational state - processing requests */
+    TASK_STATE[TASK_STATE["RUNNING"] = 3] = "RUNNING";
+    /** Graceful shutdown and resource cleanup in progress */
+    TASK_STATE[TASK_STATE["STOPPING"] = 4] = "STOPPING";
+    /** Successful completion - resources cleaned up */
+    TASK_STATE[TASK_STATE["COMPLETED"] = 5] = "COMPLETED";
+    /** Terminated before completion - resources cleaned up */
+    TASK_STATE[TASK_STATE["CANCELLED"] = 6] = "CANCELLED";
+})(TASK_STATE || (exports.TASK_STATE = TASK_STATE = {}));
+//# sourceMappingURL=task.js.map

package/dist/cli/src/types/task.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"task.js","sourceRoot":"","sources":["../../../../aparavi-client/src/types/task.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,IAAY,UAqBX;AArBD,WAAY,UAAU;IACrB,6CAA6C;IAC7C,2CAAQ,CAAA;IAER,qDAAqD;IACrD,mDAAY,CAAA;IAEZ,oDAAoD;IACpD,2DAAgB,CAAA;IAEhB,8CAA8C;IAC9C,iDAAW,CAAA;IAEX,yDAAyD;IACzD,mDAAY,CAAA;IAEZ,mDAAmD;IACnD,qDAAa,CAAA;IAEb,0DAA0D;IAC1D,qDAAa,CAAA;AACd,CAAC,EArBW,UAAU,0BAAV,UAAU,QAqBrB"}