Skip to main content
[AVAILABLE] as a library, 45 tests. The four enterprise-named connectors are explicit mocks, not integrations, see below.

​
Purpose

The contract every connector implements, plus generic reference implementations (HttpConnector, MockConnector) and four enterprise-shaped reference mocks. See Add a connector with the Connector SDK.

​
Install

npm install @parmana/connector-sdk

​
Key exports

​
Contracts, [AVAILABLE]

ExportSignature
Connector (interface){ connectorId, capabilities, execute(request: ConnectorRequest, context: ConnectorExecutionContext): Promise<ConnectorResponse> }
ConnectorRequest{ capability, businessTransactionId, action, target, parameters }, note capability and action are separate fields, expected to match by convention
connectorCapabilities(strings[])Validates each string as namespace:verb, throws at construction on a malformed one, not at execution time
ConnectorFactory (interface)Construction contract future connectors implement. No concrete factory ships.
ConnectorMetadata, ConnectorVersion, ConnectorHealthRegistration-time descriptive metadata, checked by SdkConnectorExecutor before every invocation

​
Reference implementations, [AVAILABLE]

ExportPurpose
HttpConnectorCapability-aware HTTP forwarding, per-request timeout, Bearer-token credential injection from an already-resolved CredentialHandle, fails closed on timeout or non-2xx. A different, newer class from @parmana/execution-gateway’s HttpConnector.
MockConnectorScripted responses (script: { respond }) or failure injection (script: { failWith }) for hermetic testing. .invocations records every request received.
SapConnector, OracleConnector, WorkdayConnector, SalesforceConnector[AVAILABLE] as reference mocks only. Thin factories wrapping MockConnector under an enterprise-shaped connectorId, self-documented: “deterministic, in-memory connector used until the real enterprise connector is implemented.” None is wired into the default server, none calls a real SAP, Oracle, Workday, or Salesforce system.

​
Credential and registry seams, [AVAILABLE]

ExportPurpose
CredentialProvider (interface){ providerId, resolve(connectorId): Promise<CredentialHandle> }
StaticCredentialProviderIn-memory map, tests and local dev only
CredentialVaultAdapterAdapts any CredentialProvider into execution-control’s CredentialVault interface
SdkConnectorExecutorAdapts the SDK’s Connector into execution-control’s ConnectorExecutor, rejects version mismatches, "unavailable" health, and any credential that isn’t a branded CredentialHandle
ConnectorSdkRegistryImplements execution-control’s ConnectorRegistry, composes InMemoryConnectorRegistry internally, adds metadata/version/health/credential-provider registration
CapabilityConnectorPolicyWraps a ConnectorPolicy, checks the requested action against the connector’s declared capabilities
ConnectorEvidence (model)What lands at ExecutionResult.metadata.connector: connector ID, version, capability, sanitized endpoint, redacted request/response summaries, a connectorEvidenceHash. See Execution trust records.

​
Minimal example

import { MockConnector, connectorCapabilities } from "@parmana/connector-sdk";

const mock = new MockConnector({
  connectorId: "example",
  capabilities: connectorCapabilities(["crm:read"]),
  script: { respond: () => ({ success: true, metadata: { recordId: "example-1" } }) },
});
Full runnable version: Add a connector with the Connector SDK.

​
Next

Add a connector with the Connector SDK

Implement, test, and see what reaching the default server actually requires.

@parmana/execution-control

The seams this package implements rather than replaces.