kangaroo_app_sdk_platform_interface

Internal support package, not the app-facing SDK. Application developers should use kangaroo_app_sdk when it is released. That app-facing package is currently unpublished (publish_to: none) while its native release gates remain open. Installing this interface alone does not provide a working customer or business SDK.

Shared customer feature contracts, native method/event channels, result unions, and generated JSON models are consumed by the app-facing and platform packages. This interface does not initialize native customer SDK artifacts. It is not the separate Business SDK and exposes no Business Flutter integration.

This package's platform metadata declares Android, iOS, and web integration targets. It is an internal API boundary, not a promise that the app-facing package currently ships those integrations; that package declares its own platforms and remains unpublished. Generic Dart models and channel contracts do not establish desktop SDK support. The already published 0.0.1 metadata does not change until a separately authorized new release.

License: Apache-2.0 — Copyright 2026 Mobicept Inc. See LICENSE for the full license.

Requirements

Requires Dart 3 and Flutter 3.10 or newer. Generated models are included; normal consumers do not run code generation. Checked-in unions use Freezed 2.x. This package itself needs no Maven, CocoaPods, or SPM artifacts.

Customer SDK setup

See the app-facing package README for initialization, feature APIs, and push-token registration, and the publication guide for distribution gates and local validation.

The published name kangaroo_app_sdk_platform_interface and version 0.0.1 remain unchanged. The source now prepares 0.0.2 for review only; no new version is published by this change. pub.dev generates its Installing tab and import boilerplate; that does not make this the app-facing SDK. Updating this README on the published page requires a separately authorized new package version.

Offline interface example

example/example.dart demonstrates decoding a synthetic countries payload and authorization envelope into typed results. It uses no credentials, network, native SDK initialization, or platform registration. This is an example for interface implementers, not customer application setup. From this package, after resolving dependencies through FVM:

fvm flutter test test/example/interface_example_test.dart

pub.dev documentation review

The published 0.0.1 score report identifies two missing ten-point criteria: no example, and 439 documented API elements out of 2,411 (18.2%), below the 20% threshold. The prepared source adds the offline example and documents core configuration, result/state semantics, and twelve customer feature contracts, including registration, streams, and deserializer failure behavior.

These changes target those criteria, but the hosted score is unchanged. The release owner must validate/publish 0.0.2 and wait for pub.dev analysis before reporting new points or an authoritative documentation percentage. Generated model serialization and union behavior are unchanged; only redundant model imports are removed. Broader generation-template documentation should be maintained in the upstream generator when it is updated.

The complete hosted score is 120/160 at review time. In addition to the documentation/example criteria, static analysis earns 40/50 and dependency freshness earns 30/40. The prepared source removes analyzer-identified redundant imports and the deprecated @required annotation without changing optional nullable success data. Existing repository style-only infos are not suppressed.

freezed_annotation remains on compatible 2.x intentionally. Moving to 3.1.0 only to improve a score would require a coordinated generator/runtime migration and regeneration, preserving consumer when/map behavior and tests. This patch does not pretend to close that dependency-freshness criterion. Repository/issue-link reachability warnings also need an owner access review; no repository visibility or permission settings are changed.