lightspeed/integration/adapter_sdk

Ecosystem adapter SDK contracts and reference adapters for M41.

Types

One adapter contract.

pub type AdapterContract {
  AdapterContract(
    name: String,
    boundary: Boundary,
    provider_module: String,
    sdk_version: Semver,
    adapter_version: Semver,
    capabilities: List(Capability),
    verification_steps: List(VerificationStep),
    support_tier: String,
    migration_guide: String,
  )
}

Constructors

  • AdapterContract(
      name: String,
      boundary: Boundary,
      provider_module: String,
      sdk_version: Semver,
      adapter_version: Semver,
      capabilities: List(Capability),
      verification_steps: List(VerificationStep),
      support_tier: String,
      migration_guide: String,
    )

Adapter boundary class.

pub type Boundary {
  DatabaseSource
  ObjectStoreSource
  QueueSource
  BillingService
  IdentityService
}

Constructors

  • DatabaseSource
  • ObjectStoreSource
  • QueueSource
  • BillingService
  • IdentityService

Adapter capability contract.

pub type Capability {
  PullBatch
  PushBatch
  AckCheckpoint
  ReplayCheckpoint
  IdempotentWrites
  WebhookVerification
  TenantScopedAuth
  HealthProbe
}

Constructors

  • PullBatch
  • PushBatch
  • AckCheckpoint
  • ReplayCheckpoint
  • IdempotentWrites
  • WebhookVerification
  • TenantScopedAuth
  • HealthProbe

Compatibility guarantees for adapter boundaries.

pub type CompatibilityPolicy {
  CompatibilityPolicy(
    sdk_major: Int,
    adapter_major: Int,
    min_adapter_minor: Int,
    max_adapter_minor: Int,
    deprecation_window_days: Int,
  )
}

Constructors

  • CompatibilityPolicy(
      sdk_major: Int,
      adapter_major: Int,
      min_adapter_minor: Int,
      max_adapter_minor: Int,
      deprecation_window_days: Int,
    )

Stable SDK semantic version.

pub type Semver {
  Semver(major: Int, minor: Int, patch: Int)
}

Constructors

  • Semver(major: Int, minor: Int, patch: Int)

Verification step for developer/operator integration checks.

pub type VerificationStep {
  VerificationStep(
    id: String,
    instruction: String,
    expected_evidence: String,
  )
}

Constructors

  • VerificationStep(
      id: String,
      instruction: String,
      expected_evidence: String,
    )

Values

pub fn adapter_signature(adapter: AdapterContract) -> String

Stable adapter signature.

pub fn billing_service_adapter() -> AdapterContract

Reference adapter: billing service.

pub fn boundary(adapter: AdapterContract) -> Boundary

Adapter boundary accessor.

pub fn boundary_label(boundary: Boundary) -> String

Stable boundary label.

pub fn capabilities(adapter: AdapterContract) -> List(Capability)

Adapter capability accessor.

pub fn capability_label(capability: Capability) -> String

Stable capability label.

pub fn compatibility_policy() -> CompatibilityPolicy

Current adapter compatibility policy.

pub fn compatibility_policy_label(
  policy: CompatibilityPolicy,
) -> String

Stable compatibility policy label.

pub fn compatibility_signature(
  policy: CompatibilityPolicy,
) -> String

Stable compatibility signature across all reference adapters.

pub fn compatible(
  adapter: AdapterContract,
  policy: CompatibilityPolicy,
) -> Bool

Validate adapter compatibility against one policy.

pub fn identity_service_adapter() -> AdapterContract

Reference adapter: identity provider.

pub fn name(adapter: AdapterContract) -> String

Adapter name accessor.

pub fn object_store_source_adapter() -> AdapterContract

Reference adapter: object-store batch source.

pub fn postgres_cdc_source_adapter() -> AdapterContract

Reference adapter: Postgres CDC source.

pub fn queue_source_adapter() -> AdapterContract

Reference adapter: queue source.

pub fn reference_adapters() -> List(AdapterContract)

Reference M41 adapters.

pub fn reference_adapters_compatible(
  policy: CompatibilityPolicy,
) -> Bool

Validate all reference adapters against one policy.

pub fn sdk_version() -> Semver

Current stable SDK version.

pub fn semver_label(version: Semver) -> String

Stable semver label.

pub fn valid(adapter: AdapterContract) -> Bool

Validate one adapter contract.

pub fn verification_signature(
  steps: List(VerificationStep),
) -> String

Stable verification signature.

pub fn verification_step_signature(
  step: VerificationStep,
) -> String

Stable verification step signature.

pub fn verification_steps(
  adapter: AdapterContract,
) -> List(VerificationStep)

Adapter verification steps accessor.

Search Document