orbitnest_studio_flutter library
Deprecated entry point, kept so import 'package:nestcore_flutter/orbitnest_studio_flutter.dart' keeps working
after an app switches its dependency from orbitnest_studio_flutter to
nestcore_flutter. Import package:nestcore_flutter/nestcore_flutter.dart
instead; this file will be removed in a future major version.
Classes
- AdminUser
- Admin user model for project management
- AiChatResult
- AiChunk
- AiCitation
-
A source the model was given; the reply cites it as
[index]. - AiClientChunk
- A chunk with your own vector, for AiDocumentSource.chunks.
- AiCollection
- AiCollectionRef
-
One collection:
client.collections.from('handbook'). - AiCollectionSearch
- AiCollectionStats
- AiContentPart
-
One part of a message: text, or an image as a
data:image/png;base64,…URL (or an https URL with OpenAI and Anthropic). - AiCredits
- Whether the project's AI calls can be paid from its workspace's prepaid credit (NestCoreAi.credits). A project's own provider key always wins; without one, credit pays for the call at the platform's key.
- AiDocument
- AiDocumentPage
- AiDocumentSource
- Where a document's text comes from.
- AiEmbedResult
- AiMemory
-
One remembered fact about a subject (
user:<id>,agent:support, …). - AiMemoryAddResult
- AiMemoryInput
-
One memory to add: the body of
memory.add(), and an item ofmemory.addMany(). - AiMemoryMatch
- A memory search hit.
- AiMemoryPage
- AiMemoryQuery
-
One memory search: the body of
memory.search(), and an item ofmemory.searchMany(). Give query, or queryEmbedding with its model. - AiMemorySearchResult
- AiMemorySubject
- AiMessage
- AiReembedResult
- AiSearchDocument
- The document a search hit came from.
- AiSearchResult
- AiStreamDone
- AiStreamError
- A failure, before or during the stream. The stream ends after it.
- AiStreamEvent
- Events of NestCoreAi.chatStream.
- AiTextDelta
- AiThread
- AiThreadMessage
- AiThreadPage
- AiThreadPart
- One part of a thread message: text, an image URL (data: or https), or an image in project storage (read under the caller's storage policies).
- AiThreadRef
-
One thread:
client.ai.threads.from(id). - AiThreads
-
Threads: persistent conversations with per-message tokens and cost. A
signed-in user owns the threads they create; the service key can create
threads for any user (
ownerUserId). - AiTool
- A tool the model may call. parameters is the JSON Schema of the arguments.
- AiToolCall
- A call the model asked for. Send it back unchanged in the assistant message (signature carries provider state some models require).
- AiToolCallEvent
- AiTrace
- One model call: who, which model, tokens, latency, cost, outcome.
- AiTracePage
-
ApiResponse<
T> - Response wrapper for API calls
- AuthAuthenticatedState
- AuthBloc
- BLoC for managing authentication state
- AuthClearErrorEvent
- AuthErrorState
- AuthEvent
- Authentication events
- AuthGetUserEvent
- AuthInitializeEvent
- AuthInitialState
- AuthListPasskeysEvent
- AuthLoadingState
- AuthMfaRequiredState
-
The password step succeeded but the account has a verified MFA factor, so a
second factor is required before a session is issued. Complete the sign-in
by calling
NestCoreAuth.verifyMfa(challengeToken:, code:). - AuthOperationError
- AuthOperationLoading
- AuthOperationOtpSent
- AuthOperationResult
- Generic auth operation result
- AuthOperationSuccess
- AuthOtpSentState
- AuthPasskeyRegisteredState
- AuthPasskeyRevokedState
- AuthPasskeysListedState
- AuthPasskeyUpdatedState
- AuthPasswordResetSentState
- AuthRefreshSessionEvent
- AuthRegisterPasskeyEvent
- AuthRenamePasskeyEvent
- AuthResetPasswordForEmailEvent
- AuthResponse
- Response from authentication operations
- AuthRevokePasskeyEvent
- AuthSignInWithEmailEvent
- AuthSignInWithPasskeyEvent
- AuthSignInWithPasswordEvent
- AuthSignOutEvent
- AuthSignUpEvent
- AuthSignUpWithEmailEvent
- AuthSignUpWithPasskeyEvent
- AuthState
- Authentication states
- AuthUnauthenticatedState
- AuthUpdatePasswordEvent
- AuthUpdateUserEvent
- AuthUserUpdatedState
- AuthVerifyMfaEvent
- Complete an MFA-gated sign-in by exchanging the challenge token + a TOTP or recovery code for a session.
- AuthVerifySignInEvent
- AuthVerifySignUpEvent
- AuthVerifySmsOtpEvent
- BackgroundJob
- Model for a background job.
- BackgroundJobRun
- Model for a single execution run of a background job.
- BroadcastPayload
- A custom broadcast event.
- DatabaseBloc
- BLoC for managing database operations
- DatabaseBulkDeletedState
- DatabaseBulkDeleteEvent
- DatabaseBulkInsertedState
- DatabaseBulkInsertEvent
- DatabaseBulkUpdatedState
- DatabaseBulkUpdateEvent
- DatabaseDataDeletedState
- DatabaseDataInsertedState
- DatabaseDataSelectedState
- DatabaseDataUpdatedState
- DatabaseDeleteEvent
- DatabaseErrorState
- DatabaseEvent
- Database events for CRUD operations only
- DatabaseExecuteSqlEvent
- DatabaseInitialState
- DatabaseInsertEvent
- DatabaseLoadingState
- DatabaseSelectEvent
- DatabaseSqlExecutedState
- DatabaseState
- Database states for CRUD operations only
- DatabaseUpdateEvent
- EdgeFunction
- Edge function definition
- EnvConfig
- Environment configuration service Loads configuration from .env file or environment variables
- EnvironmentVariable
- Environment variable
- ErrorCodes
- Error codes for NestCore exceptions
- ErrorResponse
- Error response structure
- FunctionExecutionResult
- Function execution result
- FunctionLogEntry
- Function logs entry
- FunctionResponse
- Response from edge function invocation
- FunctionsBloc
- BLoC for managing edge functions state Handles only function invocation operations.
- FunctionsErrorState
- FunctionsEvent
- Edge functions events for invocation only
- FunctionsInitialState
- FunctionsInvokedState
- FunctionsInvokeEvent
- FunctionsLoadingState
- FunctionsState
- Edge functions states for invocation only
- HealthCheckResponse
- Health check response
- JobsService
- Service for background jobs API calls (admin only).
-
ListResponse<
T> - Generic list response wrapper
- MigrationFailure
- Details of the migration that stopped a run.
- MigrationLogController
- A small ChangeNotifier that backs a migration UI: it triggers runs, fetches status, and accumulates human-readable log lines a widget can render.
- MigrationRunResult
-
Result of a
run/runOnemigration call. - MigrationService
- Client for the server-side migration runner.
- MigrationStatusEntry
- One migration's combined on-disk + registry state.
- NestCoreAi
- AI Gateway: chat, streaming and embeddings through the project's own provider keys (NestCore → Project Settings → AI). Calls need a signed-in user or a service-role key.
- NestCoreAuth
- Simplified Auth API that wraps the BLoC pattern Provides direct async methods like Supabase
- NestCoreClient
- Main client for NestCore
- NestCoreCollections
-
Vector collections: documents chunked, embedded and searched with hybrid
(vector + keyword) retrieval under RLS. Creating collections and adding
shared documents needs the service key; a collection with
userIngestlets signed-in users add documents only they can read. - NestCoreConstants
- General constants for NestCore package
- NestCoreDatabase
- Database API: direct async CRUD helpers and a Supabase-style query builder.
- NestCoreFunctions
- Simplified Edge Functions API that wraps the BLoC pattern Provides direct async methods for function invocation only
- NestCoreLogger
- Logger service for NestCore package
- NestCoreMemory
-
Memory API: facts about a user (or an agent, an org…) with semantic
search. A signed-in user reads and writes only their own memory; the
service key may name any
subject(type:id, e.g.user:<id>). - NestCoreRealtime
- Supabase-style realtime facade exposed on NestCoreClient.
- NestCoreStorage
-
Storage facade —
client.storage.from('bucket')returns a StorageBucket. -
OperationResult<
T> - PaginationInfo
- Pagination information
- PasskeyAuthenticatorService
- Bridges WebAuthn options/responses produced by the NestCore server with the platform credential APIs (Android Credential Manager, iOS ASAuthorization).
- PasskeyDevice
- A registered WebAuthn / passkey credential bound to the current user.
- PasswordResetResponse
- Response for password reset operations
- PgChangesPayload
- A row-level change event delivered from the server.
- PostgrestCountResponse
- Response for count-only operations
-
PostgrestQueryBuilder<
T> - Supabase-style query builder over the NestCore data API.
-
PostgrestResponse<
T> - Response from PostgreSQL operations (Supabase-compatible)
-
PostgrestSingleResponse<
T> - Simplified response for operations that return single items
- RealtimeBroadcastEvent
- RealtimeChannel
- A realtime channel that aggregates DB-change and broadcast subscriptions.
- RealtimeDbEvent
- RealtimeErrorEvent
- RealtimeEvent
- Union type for anything delivered over a RealtimeChannel.
- RealtimeFilter
- RealtimePresenceEvent
- Fired whenever the server sends a full presence roster snapshot.
- RealtimeSystemEvent
- SemanticFilter
-
One filter of a semantic query:
column op value. op is one ofeq,neq,gt,gte,lt,lte,like,ilike,in(a list) oris(null,trueorfalse). - SemanticResponse
- Result of a semantic query: rows nearest to the query by meaning.
- Session
- Session model representing an authenticated session
- StorageBucket
- Operations scoped to a single storage bucket.
- StorageTransform
- On-the-fly image transform options for StorageBucket.getPublicUrl.
-
SuccessResponse<
T> - Success response with optional data
- ThreadRunCitation
- ThreadRunDelta
- ThreadRunDone
- ThreadRunError
- A failure, before or during the run. The stream ends after it.
- ThreadRunEvent
-
Events of
AiThreadRef.run: ThreadRunMessage first, then ThreadRunCitations, ThreadRunDeltas and tool events, then one ThreadRunDone — or a ThreadRunError, never a thrown error. - ThreadRunMessage
- The id of the assistant message being written (saved as it streams).
- ThreadRunResult
-
runOnce(): the finished assistant message. - ThreadRunToolCall
- The model called a built-in tool; its ThreadRunToolResult follows.
- ThreadRunToolResult
- ThreadRunUsage
- User
- User model representing an authenticated user
- UserUpdateResponse
- Response for user update operations
Enums
- AiThreadTool
- Built-in tools a thread run may give the model.
- ChannelStatus
- OperationStatus
- Generic operation result
- PgEvent
Extensions
- AuthStateX on AuthState
- Extension for AuthState to add convenience methods
- DatabaseStateX on DatabaseState
- Extension for DatabaseState to add convenience methods
- FunctionsStateX on FunctionsState
- Extension for FunctionsState to add convenience methods
-
PostgrestQueryBuilderX
on PostgrestQueryBuilder<
T> - Extension to add convenient methods
Typedefs
-
JsonList
= List<
JsonMap> -
JsonMap
= Map<
String, dynamic> - Type definitions for JSON data
- OrbitNestAi = NestCoreAi
- OrbitNestAuth = NestCoreAuth
- OrbitNestClient = NestCoreClient
- OrbitNestCollections = NestCoreCollections
- OrbitNestConstants = NestCoreConstants
- OrbitNestDatabase = NestCoreDatabase
- OrbitNestException = NestCoreException
- OrbitNestFunctions = NestCoreFunctions
- OrbitNestLogger = NestCoreLogger
- OrbitNestMemory = NestCoreMemory
- OrbitNestRealtime = NestCoreRealtime
- OrbitNestStorage = NestCoreStorage
Exceptions / Errors
- AiException
- Thrown by NestCoreAi.chat, NestCoreAi.embed and NestCoreAi.models.
- AuthException
- Authentication-specific exception
- DatabaseException
- Database-specific exception
- FunctionException
- Edge function-specific exception
- JobException
- Background job-specific exception.
- MigrationException
- Migration-specific exception.
- NestCoreException
- Base exception class for NestCore errors
- StorageException
- Thrown by every StorageBucket request method.