sourcepoint_unified_cmp 0.1.3

flutter plugin for the sourcepoint unified CMP, with integrations for Android and iOS

sourcepoint unified cmp

NOTE: this is a work in progress - see TODO section for more details

This is the flutter integration for sourcepoint's unified CMP sdk.

requirements

Packages:

• dart
• flutter
• swiftformat

dart pub global activate melos
dart pub global activate very_good_cli
dart pub global activate pana
dart pub global activate flutter_plugin_tools

example usage:

The flutter api is work in progress and will likely change.

However there are two main concepts:

• there is a SourcepointController() which:
  • takes the account config initially
  • provides a way to load the consent on app startup - either by loading the consent from cache, or explicitly ask the user
  • provides a way to load the consent dialog on demand.
• there is a SourcepointUnifiedCMPBuilder() widget which:
  • takes the controller as argument
  • loads the child widget once the consent is available

sample code:

For a running examples please check the sample app at example/lib/main.dart - the sample app can be run using melos run run:example -- -d sdk (android only atm).

// init the controller with the account config
final config = SPConfig(
    accountId: 22,
    propertyId: 7639,
    propertyName: 'tcfv2.mobile.webview',
    pmId: '122058',
);

_controller = SourcepointController(config: config);

in the widget tree, the consent can initially be loaded using the SourcepointUnifiedCMPBuilder:

SourcepointUnifiedCMPBuilder(
    controller: _controller,
    builder: (BuildContext context, AsyncSnapshot<SPConsent> snapshot) {
        List<Widget> children;
        if (snapshot.hasData) {
            final consent = snapshot.data;
            debugPrint('user consent has been loaded:');
            debugPrint('   grants: ${consent?.gdpr?.grants}');
            debugPrint('euconsent: ${consent?.gdpr?.euconsent}');
            children = <Widget>[
                Text('Result: we got initial consent'),
            ];
        } else if (snapshot.hasError) {
            children = <Widget>[
                Text('Error: ${snapshot.error}'),
            ];
        } else {
            children = const <Widget>[
                Text('Awaiting consent...'),
            ];
        }
        return children
    },
)

Result:

When opening the app for the first time, the consent dialog will be shown:

Any subsequent run will load the consent from cache:

In both cases we get this consent output:

user consent has been loaded:
    grants: {5e7ced57b8e05c5a7d171cda: GDPRPurposeGrants(granted: false, purposeGrants: {}), 5e37fc3e56a5e60e003a7124: GDPRPurposeGrants(granted: true, purposeGrants: {5e87321eb31ef52cd96cc552: true, 5e87321eb31ef52cd96cc553: true, 5e87321eb31ef52cd96cc554: true, 5e87321eb31ef52cd96cc555: true, 5e87321eb31ef52cd96cc556: true, 5e87321eb31ef52cd96cc558: true, 5e87321eb31ef52cd96cc559: true, 5e87321eb31ef52cd96cc55a: true, 5e87321eb31ef52cd96cc55b: true, 5e87321eb31ef52cd96cc55c: true}), 5e4a5fbf26de4a77922b38a6: GDPRPurposeGrants(granted: true, purposeGrants: {5e87321eb31ef52cd96cc556: true})}
    euconsent: CP4X2gAP4X2gAAGABCENDgCgAL3AAEIAAAYgAHgACAB4AAgDAgAIAMggAEAGQYACADIQABABkOAAgAyKAAQAZAAA.YAAAAAAAAAAA

There is also a way to react on consent changes via an event delegate:

  _controller = SourcepointController(config: config)
    ..setEventDelegate(
      SourcepointEventDelegate(
        onConsentReady: (SPConsent consent) {
          debugPrint('DELEGATE onConsentReady: Consent string: '
              '${consent.gdpr?.euconsent}');
        },
        onSpFinished: (SPConsent consent) {
          debugPrint(
            'DELEGATE SpFinished: Consent string: ${consent.gdpr?.euconsent}',
          );
        },
      ),
    );

with those delegates in place we can now also add a button to load the consent dialog on demand:

  TextButton(
    onPressed: () {
      _controller.loadPrivacyManager(
        pmId: '122058',
      );
    },
    child: const Text('Load Privacy Manager'),
  )

Which results in

DELEGATE onConsentReady: Consent string: CP4u7EAP4u7EAAGABCENDgCgAAAAAAAAAAYgAAAAAAAA.YAAAAAAAAAAA
DELEGATE SpFinished: Consent string: CP4u7EAP4u7EAAGABCENDgCgAAAAAAAAAAYgAAAAAAAA.YAAAAAAAAAAA

TODO

• ❌ commit on an api
  • ✅ the api for the initial consent loading
  • ✅ api on the on demand loading of the consent message (#5)
  • ✅ implementation of a SourcepointEventDelegate which allows the flutter stack to hook onto consent events (#6)
  • ❌ commit on namings, at the moment the public api of this packages does not stick to a single rule, sometimes it's SourcepointUnifiedCMP, sometimes it's SourcepointCMP, and in other places just Sourcepoint
• ✅ implementation for ios/swift (#7)
• ❌ implementation of tests
• ❌ open source this as a proper flutter package.
  • ❌ add proper (dart) documentation
• ❌ additional apis:
  • ❌ ingesting consent into platforms webview
  • ❌ more app samples

resources

sourcepoint

• sourcepoint ios SDK
• sourcepoint android SDK

tooling

• Flutter
• Flutter documentation
• using melos and very_good_cli
• very good dev
• melos
• example melos + pigeon repo: flutterfire
• example pigeon + swift host and flutter api