soroq_sdk 0.1.1

Pure Dart client and models for talking to the Soroq OTA control plane.

soroq_sdk

soroq_sdk is the pure Dart client layer for Soroq.

Use it when you want to talk to the Soroq control plane from Dart without pulling in any platform plugin code.

What It Includes

• typed request and response models for patch checks, boot reports, and patch health
• a small SoroqControlPlaneClient for the hosted control-plane endpoints
• bundle and manifest download helpers
• pure Dart data structures for bundled metadata and runtime events

Native runtime bridging lives in the sibling soroq_flutter package so this package can stay portable across Flutter and non-Flutter Dart code.

If you are onboarding a Flutter app to the public Soroq alpha, start with:

• docs/public-alpha-android-quickstart.md

Installation

dependencies:
  soroq_sdk: ^0.1.1

Quick Start

import 'package:soroq_sdk/soroq_sdk.dart';

Future<void> main() async {
  final client = SoroqControlPlaneClient(
    baseUrl: Uri.parse('https://your-soroq-control-plane.example'),
  );

  final patchCheck = await client.patchCheck(
    const SoroqPatchCheckRequest(
      appId: 'com.example.app',
      runtimeId: 'runtime-fingerprint',
      currentPatchNumber: 0,
    ),
  );

  if (patchCheck.patchAvailable) {
    print('Patch available: ${patchCheck.patch?.id}');
  }
}

Typical Flow

1. Build or compute the app runtime identity in your host app.
2. Call patchCheck(...) to ask the control plane whether a newer patch is available for that runtime.
3. Download the signed manifest and bundle from the returned URLs.
4. After the runtime applies or rejects a patch, report the result with reportBoot(...).
5. Inspect rollout health with patchHealth(...) when you need operator-side visibility.

API Surface

• SoroqControlPlaneClient
  • patchCheck(...)
  • reportBoot(...)
  • patchHealth(...)
  • downloadPatchBundle(...)
  • downloadPatchManifest(...)
• wire models for patch descriptors, activation modes, patch kinds, bundled metadata, and runtime events

Status

This package is part of the current Soroq public-alpha preparation work. The core control-plane protocol is real and already used by the companion Flutter runtime/plugin, but the overall product is still evolving toward a more polished Shorebird-style developer workflow.