Dart Types Reference

1final authix = NeuctraAuthix(
2  config, {
3  http.Client? client,      // bring your own — BrowserClient, a mock, a retrying wrapper
4  SessionStore? session,    // share one cookie jar between clients
5});
6
7authix.appId;      // String
8authix.baseUrl;    // String — trailing slashes stripped
9authix.keyType;    // ApiKeyType.publishable | ApiKeyType.secret
10authix.keyPrefix;  // String — 'pk_live_a1b2c3d4'. Safe to log.
11authix.appName;    // String?
12authix.timeout;    // Duration
13authix.session;    // SessionStore
14authix.close();    // releases the client, if the SDK created it
15
16authix.toString(); // masks the key: 'sk_live_e5f6a7b8…cccc'

1// Parse a key locally, without contacting the API.
2final parsed = parseApiKey('pk_live_a1b2c3d4_…');
3
4parsed?.type;    // ApiKeyType.publishable
5parsed?.env;     // 'live'
6parsed?.prefix;  // 'pk_live_a1b2c3d4' — the lookup handle, not a secret
7
8// null for a missing or malformed key, so you can reject it early.
9parseApiKey('nonsense'); // null
10
11// Render a key safely for logs.
12maskApiKey(key); // 'pk_live_a1b2c3d4…9999'

1final page = await authix.getUserData(
2  GetUserDataParams(userId: userId, limit: 50),
3);
4
5// A Page IS an Iterable of its records.
6for (final record in page) {
7  print(record['title']);
8}
9
10page.length;      // records in this page
11page.isEmpty;     // from Iterable
12page.first;       // from Iterable
13page[0];          // indexed access
14page.hasMore;     // bool
15page.nextCursor;  // String? — pass back as cursor
16page.total;       // int — records in this page, as the API reported it
17page.raw;         // Map<String, dynamic> — the undecoded body
18
19Page<Map<String, dynamic>>.empty(); // a seed value for UI state

1// Every iterate* method returns a Stream, so rows render as they arrive.
2await for (final record in authix.iterateUserData(
3  GetUserDataParams(userId: userId),
4  maxPages: 10,
5)) {
6  print(record['title']);
7}
8
9// Walk any cursor-taking method yourself.
10await for (final page in authix.pages(
11  (cursor) => authix.getUserData(
12    GetUserDataParams(userId: userId, cursor: cursor),
13  ),
14)) {
15  print('${page.length} records');
16}

1typedef ItemParser<T> = T Function(Map<String, dynamic> json);
2
3// Your own model
4final notes = await authix.getUserData<Note>(
5  GetUserDataParams(userId: userId),
6  itemParser: Note.fromJson,
7);
8
9// Or the built-in record shape, which types version for you
10final items = await authix.getUserData<DataItem>(
11  GetUserDataParams(userId: userId),
12  itemParser: DataItem.fromJson,
13);

1try {
2  await authix.updateUserData(
3    UpdateUserDataParams(
4      userId: userId,
5      dataId: dataId,
6      data: {'status': 'shipped'},
7      version: 3,
8    ),
9  );
10} on VersionConflictError catch (e) {
11  e.currentVersion;   // int? — where the record is now
12  e.expectedVersion;  // int? — what you sent
13} on InsufficientScopeError catch (e) {
14  e.hint;             // String? — which credential the endpoint needs
15} on RateLimitError catch (e) {
16  e.resetDate;        // String? — when the quota resets
17} on AuthixApiError catch (e) {
18  e.status;           // int
19  e.code;             // String? — 'VERSION_CONFLICT', 'INSUFFICIENT_SCOPE', …
20  e.payload;          // Map<String, dynamic> — the decoded body
21} on AuthixException catch (e) {
22  // The base type — catches configuration and network failures too.
23  e.message;
24}

1authix.session.hasSession;            // bool
2authix.session.sessionCookie;         // String? — persist this
3authix.session.cookies;               // Map<String, String>, unmodifiable
4authix.session.cookieHeader;          // String? — what gets sent
5
6authix.session.setSessionCookie(v);   // restore a persisted session
7authix.session.setCookie(name, v);    // seed any cookie
8authix.session.clearSession();        // drop the Neuctra Authix session cookie only
9authix.session.clear();               // drop everything
10
11SessionStore.sessionCookieName;       // 'authix_user_session'

1final result = await authix.rawRequest(
2  const SDKRequestOptions(
3    method: 'POST',
4    path: '/custom/endpoint',
5    data: {'foo': 'bar'},
6    query: {'verbose': true},
7    extraHeaders: {'x-trace-id': 'abc123'},
8    injectAppId: true,
9  ),
10);