baxcloud_core 0.1.5

Headless BaxCloud foundation — config, HTTP API, tokens, rooms, and analytics metadata for Flutter SDKs and UI kits.

baxcloud_core

Headless BaxCloud foundation for Flutter SDKs and UI kits.

Features

• BaxConfig — projectId, apiKey, optional bundleId / appVersion / buildNumber
• BaxApiClient — tokens, rooms, call invites, push-token registration
• BaxRoomSession — room credential session helper
• BaxcloudUser — shared identity; avatarUrl only here; participant metadata + update / copyWith
• BaxSdkTelemetry — UI kits register package name/version; sent as deviceMetadata.sdk on token create
  • On release, bump pubspec.yaml and lib/version.dart to the same version
• Call models (BaxCallInvitation, BaxPushPlatform, …)
• Analytics device + location metadata on token requests (OS, platform, model, versions, locale, country/continent)
  • Host appVersion / buildNumber = client app; sdk = BaxCloud packages
  • Dashboard resolves raw device model codes to marketing names where known

Installation

dependencies:
  baxcloud_core: ^0.1.5

flutter pub get

Quick start

import 'package:baxcloud_core/baxcloud_core.dart';

var user = BaxcloudUser(
  userId: 'u1',
  name: 'Ada',
  avatarUrl: 'https://example.com/ada.png',
  metadata: {'role': 'host', 'locale': 'en'},
);

// Later — patch profile / custom map (mergeMetadata defaults to true)
user = user.update(name: 'Ada Lovelace', metadata: {'plan': 'pro'});

final config = BaxConfig(
  projectId: 'your-project-id',
  apiKey: 'bax_pk_your_client_key',
);

final client = BaxApiClient(config: config);
final creds = await client.createToken(
  BaxTokenRequest(
    roomName: 'lobby',
    userId: user.userId,
    userName: user.name,
    avatarUrl: user.avatarUrl,
    metadata: user.metadata, // participant only
    // roomMetadata: {'title': 'Lobby'}, // only when room is auto-created
  ),
);

Prefer a client key (bax_pk_…) from the dashboard.

Documentation

Resource	Link
UI Kits overview	baxcloud.tech/docs/uikits
Calls UI Kit	baxcloud.tech/docs/uikits/calls
API authentication	baxcloud.tech/docs/api/authentication
Site	baxcloud.tech

UI kits and BaxApiClient talk to BaxCloud for you — prefer those APIs over raw HTTP.

License

MIT — see LICENSE.