stream-engine v1.0.4

StreamEngine

StreamEngine is a flexible, flow-based processing engine designed for hierarchical data processing. It's primarily tailored for configuring building component parameters in systems like Autodesk Inventor or Revit, but can be adapted for various processing needs. This application was written by Aaron Rutledge for Method Building Systems, LLC.

Features

• Hierarchical data processing
• Customizable node types
• Asynchronous processing
• Built-in utilities for data fetching and JSONata processing
• Easy to extend and customize
• Automatic component loading
• Support for mixed component types in a single stream

Installation

To install StreamEngine, run the following command in your project directory:

npm install stream-engine

Usage

Here's a basic example of how to use StreamEngine:

import { runStream } from 'stream-engine';

const stream = { streamId: '1', rootNodeId: 'root', customProperties: { jsonataExpression: '$.name' }, nodes: [ { nodeId: 'root', nodeType: 'exampleComponent', children: 'child', customProperties: { name: 'Root Node' } }, { nodeId: 'child', nodeType: 'jsonataComponent', children: [], customProperties: {} }, ], };

const initialMessage = { data: 'initial' };

async function main() { const result = await runStream(stream, initialMessage); console.log(result); }

main();

Creating Custom Components

To create a custom component, extend the BaseComponent class:

import BaseComponent from 'stream-engine/lib/baseComponent';

class MyCustomComponent extends BaseComponent { async onInit() { // Initialization code }

async addToMessage() { // Modify and return the message this.message.customData = 'Processed by MyCustomComponent'; return this.message; }

getContext() { return { nodeId: this.node.nodeId, nodeType: this.node.nodeType, customProperties: this.node.customProperties }; } }

export default MyCustomComponent;

API Reference

runStream(stream, initialMessage, targetNodeId)

Processes a stream and returns the final message.

• stream: The stream configuration object
• initialMessage: The initial message to be processed
• targetNodeId: (Optional) ID of a target node to stop processing at

BaseComponent

Base class for creating custom components.

• constructor(message, node, utils, globalMessage, stream): Initializes the component
• onInit(): Called when the component is initialized
• addToMessage(): Processes and modifies the message
• getContext(): Returns the context of the component

Testing

To run the test suite, use the following command:

npm test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.