@seal-sdk/integration
v0.13.0
Published
Integration infrastructure for the SEAL SDK.
Readme
@seal-sdk/integration
Integration infrastructure for the SEAL SDK.
The @seal-sdk/integration package provides a common abstraction for connecting
the platform to external and internal resources through typed connectors.
Architecture
The package is centered around the IntegrationEngine, which executes
integration requests through registered connectors.
Platform
|
v
IntegrationEngine
|
+-- MemoryConnector
+-- HttpConnector
+-- RestConnector
+-- FileConnector
|
+-- Authentication
|
+-- Retry policiesIntegrationEngine
IntegrationEngine coordinates integration requests and delegates execution
to the appropriate registered connector.
Its responsibility is orchestration rather than implementing the internal behavior of individual connectors.
Connectors
MemoryConnector
Provides an in-memory integration mechanism useful for local execution, testing and deterministic integration scenarios.
HttpConnector
Provides HTTP request execution and supports HTTP-oriented payloads.
It can operate with authentication and retry behavior while keeping those concerns separated from the connector contract.
RestConnector
Provides REST-oriented operations on top of HTTP integration.
REST actions are translated into the corresponding HTTP methods before the request is delegated to the HTTP connector.
FileConnector
Provides file-system integration.
Supported operations include:
- read
- write
- exists
- delete
Authentication
The integration package provides authentication strategies including:
- API key authentication
- Bearer authentication
- OAuth authentication
Authentication behavior remains separated from connector orchestration.
Retry policies
Retry behavior is represented independently from connector execution.
Available implementations include:
- fixed retry policy
- no-retry policy
Platform integration
The IntegrationEngine is exposed through the Platform layer as part of the
SDK architecture.
Platform
|
+-- Workflow
+-- Session
+-- Progress
+-- Analytics
+-- IntegrationEngineRegistry
The IntegrationEngine participates in the SDK engine infrastructure through
the EngineRegistry.
This allows integration capabilities to be registered and consumed through the same architectural mechanisms used by other platform engines.
Design principles
The integration package follows these principles:
- explicit contracts
- typed integration requests
- modular connectors
- separation of orchestration and connector implementation
- isolated authentication behavior
- isolated retry policies
- predictable failure responses
- Platform exposure
- EngineRegistry integration
The package is designed so that integration capabilities can evolve without coupling external-system behavior directly to the learning-domain engines.
