User Data Management

1// One page at a time — for a "Load more" button.
2var page = await authix.getUserData(
3  GetUserDataParams(userId: userId, category: 'notes', limit: 50),
4);
5
6if (page.hasMore) {
7  page = await authix.getUserData(
8    GetUserDataParams(
9      userId: userId,
10      category: 'notes',
11      limit: 50,
12      cursor: page.nextCursor,
13    ),
14  );
15}
16
17// Or let the SDK follow the cursor and stream every record as it arrives.
18await for (final record in authix.iterateUserData(
19  GetUserDataParams(userId: userId, category: 'notes'),
20)) {
21  print(record['title']);
22}
23
24// Bound the traversal when you do not know how much there is.
25final firstFewHundred = await authix
26    .iterateUserData(
27      GetUserDataParams(userId: userId),
28      maxPages: 10,
29    )
30    .toList();

1class Note {
2  final String id;
3  final String title;
4  final int version;
5
6  const Note({required this.id, required this.title, required this.version});
7
8  factory Note.fromJson(Map<String, dynamic> json) => Note(
9        id: json['id']?.toString() ?? '',
10        title: json['title']?.toString() ?? '',
11        version: json['version'] as int? ?? 0,
12      );
13}
14
15// Pass the factory as itemParser to get Note objects instead of raw maps.
16final page = await authix.getUserData<Note>(
17  GetUserDataParams(userId: userId, category: 'notes'),
18  itemParser: Note.fromJson,
19);
20
21for (final note in page) {   // a Page is an Iterable of its records
22  print(note.title);
23}
24
25// Or use the built-in record shape, which types version for you.
26final typed = await authix.getUserData<DataItem>(
27  GetUserDataParams(userId: userId),
28  itemParser: DataItem.fromJson,
29);
30
31typed.first.version;    // int
32typed.first['title'];   // payload field
33typed.first.payload;    // payload without the identity fields

1// Read, then write back with the version you read.
2final current = await authix.getSingleUserData(
3  GetSingleUserDataParams(userId: userId, dataId: dataId),
4);
5
6try {
7  await authix.updateUserData(
8    UpdateUserDataParams(
9      userId: userId,
10      dataId: dataId,
11      data: {'status': 'shipped'},
12      version: current.version,
13    ),
14  );
15} on VersionConflictError catch (e) {
16  // Another device wrote first. Nothing was overwritten — re-read and retry.
17  print('now at version ${e.currentVersion}');
18}

1// Deduct stock and record the order together, or do neither.
2await authix.batch(
3  BatchParams(
4    userId: userId,
5    operations: [
6      const BatchOperation.create(
7        dataCategory: 'orders',
8        data: {'total': 40, 'status': 'placed'},
9      ),
10      BatchOperation.update(
11        id: stockId,
12        version: stock.version,
13        data: {'remaining': 9},
14      ),
15      BatchOperation.delete(id: draftId),
16    ],
17  ),
18);