Framework
DIRECTORY
API reference for robo.js
Framework
API reference documentation for robo.js.
Classes
AdapterBuilder- Builder for composing adapter wrappers.AdapterError- Thrown when an adapter operation fails.AdapterWrapper- Base class for adapter wrappers.AsyncMutex- Simple async mutex for serializing operations.CacheAdapter- LRU cache wrapper for adapters.CatalogLockManager- Lock manager for catalog operations.Catalog- Catalog class for managing ID -> chunk mappings.ChunkLockManager- Lock manager for chunk operations.ChunkManager- Chunk manager for a single model.CompressionAdapter- Compression wrapper for adapters.ConnectionError- Thrown when connection to the storage backend fails after retries are exhausted.CuckooFilter- Cuckoo Filter implementation with 16-bit fingerprints.DataCorruptionError- Thrown when data corruption is detected (malformed chunk, catalog mismatch).EncryptionAdapter- Encryption wrapper for adapters.Env- Sometimes you need to store sensitive information, like API keys, database URLs, or other credentials.FeatureNotSupportedError- Thrown when a feature is not supported by the current adapter configuration.Field- Field builder class with fluent modifiers.FileAdapter- File-based storage adapter using the filesystem.FlashcoreError- Base error class for all Flashcore errors.FlashcoreModel- FlashcoreModel class.FlashcoreSchemaError- Thrown when schema validation fails on startup (breaking schema drift).IndexPersistenceManagerIntegrityChecker- Integrity Checker.JunctionTableManager- Junction table manager for many-to-many relationships.KeyvAdapter- Keyv adapter for Flashcore.LegacyFileAdapter- Legacy file adapter for backward compatibility with existing .robo/data stores.Logger- The logger class provides a simple and flexible logging system.MemoryAdapter- In-memory storage adapter using Map.MigrationError- Thrown when a migration fails.MigrationLockManager- Manager for migration lock acquisition and release.MigrationRegistry- Migration registry for discovered migrations.MigrationRunner- Migration runner class.NotFoundError- Thrown when a record is not found (e.g., update/delete on non-existent record).PluginManager- Plugin Manager - handles plugin lifecycle, middleware, and extensions.QueryPlanner- Query Planner.RecordValidator- Record validator for schema-based validation.RelationField- Relation field builder for model relationships.RepairEngine- Repair Engine.ResilienceAdapter- Resilience wrapper for adapters.SafeKeyEncoder- SafeKeyEncoder class for stateful encoding operations.SafetyError- Thrown when a safety limit is violated (reserved prefixes, result size limits).SchemaHistoryManager- Manager for schema version history.SchemaMetadataManager- Manager for schema metadata persistence.SerialTransactionQueue- Serial mode queue for serializing transactions within the process.SortedIndex- SortedIndex implementation using a B+Tree.State- States are your Robo's personal memory bank.StorageExhaustedError- Thrown when storage is exhausted (ENOSPC, quota exceeded).TransactionConflictError- Thrown when a transaction conflict is detected (optimistic locking failure).TransactionContext- Transaction context implementation.TypeSerializer- Type serializer for storing and retrieving records.UniqueConstraintError- Thrown when a unique constraint is violated.UniqueIndexManager- Manages unique constraints for a model.ValidationError- Thrown when input validation fails (schema validation, type checking, required fields).WriteAheadLog- Write-Ahead Log manager.
Interfaces
AdapterCapabilitiesReport- Extended capabilities that an adapter can self-report.AdapterCapabilities- Normalized adapter capabilities.AdapterTransaction- Transaction context provided by native adapter transactions.AggregatedMetadata- Base interface for aggregated namespace metadata.ApiEntryApiAutoRepairConfig- Configuration for automatic repair on startup.AvailableIndexes- Available indexes for query planning.BaseConfigBatchResult- Batch operation result for createMany/updateMany/deleteMany.BatchedIncludeResult- Batched include result for N+1 prevention.BuildCompleteContext- Context provided to build/complete.ts hooks.BuildContext- Context provided to build hooks.BuildStore- Key-value store for passing data between build hooks.BuildTransformContext- Context provided to build/transform.ts hooks.CacheOptions- Options for the LRU cache wrapper.CacheStats- Cache statistics.CascadeContext- Context for cascade operations.CascadeOp- Cascade operation collected during delete traversal.CatalogData- Catalog data for serialization (v2 format).CatalogDeleteDelta- Delete catalog mapping for an id.CatalogEntry- Catalog entry for a single record.CatalogRebuildOptions- Options for catalog rebuild.CatalogRebuildProgress- Progress update during catalog rebuild.CatalogRebuildResult- Result of a catalog rebuild operation.CatalogSetDelta- Set catalog mapping: id → chunkId.CatalogSetSegmentsDelta- Set catalog mapping for a segmented record: id → segmentIds[].CatalogVerificationResult- Result of catalog verification.ChangeAnalysisResult- Result of analyzing schema changes.ChunkDeleteDelta- Delete a record from a chunk.ChunkPatchDelta- Apply a partial patch to a record in a chunk (update).ChunkPutDelta- Put a full record into a chunk (create / upsert).ChunkStats- Chunk statistics.CliCommandConfig- Configuration for a CLI command.CliCommandEntry- CLI command entry in the manifest.CliCommandModule- Complete CLI command module exports.CliContext- Context passed to CLI command handlers.CliExtendConfig- Configuration for extending an existing CLI command.CliExtendModule- Complete CLI extension module exports.CliExtensionEntry- CLI extension entry in the manifest.CliManifest- CLI manifest structure.CliOptionConfig- Configuration for a CLI option (flag).CompoundUniqueConstraint- Compound unique constraint definition.CompressionOptions- Options for the compression wrapper.ConfigCountArgs- Count arguments.CreateArgsCreateManyArgs- CreateMany arguments.CuckooFilterData- Serialized filter data for persistence.CuckooFilterOptions- Options for creating a Cuckoo filter.DeleteArgs- Delete arguments.DeleteManyArgs- DeleteMany arguments.DeltaBuildResult- Result from building deltas.DiscoveredRoute- Discovered route definition from a plugin or project.DrainHandle- Handle returned when adding a drain to the logger.EncodedKeyData- Encoded key structure for v1 format.EncryptionOptions- Options for the encryption wrapper.EntriesAccessor- Accessor interface for route entries during build.EnvMetadata- Environment variable metadata stored in env.json.EnvPattern- Pattern definition for validating environment variables.EnvVariableStatus- Status of a single environment variable.EpochData- Persisted epoch data for stale detection.ErrorContext- Context provided to error hooks.EventConfigEventExportsConfig- Configuration for which exports to capture from handler files.FieldDef- Internal field definition structure.FieldDiffEntry- A single field modification entry.FieldMetadata- Field metadata stored for schema history tracking.FieldQueryResolver- Field-level query resolver for specific operators.FileAdapterOptions- Options for the FileAdapter.FileDrainOptions- Options for creating a file drain imperatively.FileOutputConfig- Configuration for a file-based log output.FilterAddDelta- Add an ID to the Cuckoo filter.FilterIntegrityResult- Result of a filter integrity check.FilterRemoveDelta- Remove an ID from the Cuckoo filter.FindFirstArgs- FindFirst arguments (same as FindMany).FindManyArgs- FindMany arguments.FindUniqueArgs- Find unique arguments.FlashcoreAdapterFlashcoreConfig- Configuration for the Flashcore v1 client.FlashcoreGetOptions- Options for KV get operation.FlashcoreIntrospection- Introspection data returned by Flashcore.$.introspect().FlashcoreKvOptions- Options for KV operations.FlashcoreMetrics- Metrics counters for performance tracking.FlashcoreModelOptions- Model options for registration.FlashcorePluginDefinition- Flashcore plugin definition.FlashcorePlugin- Flashcore plugin interface (Phase 10).FlashcoreSchema- Schema namespace wrapper for plugin model registration.FlushResult- Result of a flush operation.FullRepairResult- Combined repair result for all index types.HandlerEntry- A handler entry in the manifest.HandlerModule- Handler object returned after lazy import.HandlerRecord- Handler record representing a registered handler in the portal.HmrContext- Context provided to HMR hooks.HmrEventContext- Context passed to HMR event subscribers.HmrEventRouteInfo- Route info included in HMR event context.HmrHandlerInfo- Handler info for routes affected by HMR.HmrHookConfig- HMR hook configuration for filtering events.HmrReloadHandlerPayload- Payload for HMR handler reload events.HmrReloadRoutePayload- Payload for HMR route reload events.HmrRouteInfo- Route info for HMR events.HmrSubscribeOptions- Options for filtering HMR events when subscribing.HmrSubscription- Subscription handle returned byhmr.subscribe().Hmr- HMR API interface.HookContext- Hook execution context.HookEntry- A lifecycle hook entry.HotModule- Interface returned byhmr.module()for registering cleanup callbacks.ITransactionContext- Transaction context interface exposed to user code.IncludeContext- Context for resolving includes.IncludeOptions- Options for include clause parsing.IndexIntegrityResult- Result of a sorted index integrity check.IndexOptions- Options for creating a custom index.IndexPersistenceOptions- Options for the IndexPersistenceManager.IndexProvider- Custom index provider - creates and manages indexes.IndexRemoveDelta- Remove a value from a sorted index.IndexUpsertDelta- Upsert a value into a sorted index.Index- Custom index instance - manages indexed data.InitContext- Context provided to init hooks.InitOptions- Options for Flashcore.$.init().IntegrityCheckOptions- Options for integrity checking.IntegrityCheckProgress- Progress update during integrity check.IntegrityReport- Complete integrity report for a model.IpcEmitOptions- Options for emit().IpcEvent- IPC Event that flows between app and host.IpcState- Host state and capabilities.JsonPatch- JSON Patch operation (RFC 6902).JunctionTableDef- Junction table schema definition.KeyConfig- Configuration for key generation from file paths.KeyvAdapterOptionsKeyvLike- Keyv instance interface.LegacyFileAdapterOptionsLoadedCliCommand- Loaded CLI command with resolved handler.LoadedCliExtension- Loaded CLI extension with resolved handlers.LockAcquisitionResult- Result of a lock acquisition attempt.LockStatus- Current lock status.LoggerOptionsManifestApi- The Manifest API singleton interface.ManifestConfigMap- Map of plugin config types.ManifestHookMap- Map of hook types.ManifestMetadataMap- Map of namespace metadata types.ManifestOptions- Options for manifest operations.ManifestRouteMap- Map of namespace to available route names.ManifestSeedEnv- Seed environment configuration.ManifestSeed- Seed configuration for a plugin.ManyToManyConnect- Connect/disconnect operations for manyToMany.MetadataIndex- Metadata aggregation index stored in metadata/@.json.MigrationContext- Context passed to migration up/down functions.MigrationDefinition- Migration definition provided by user.MigrationLockOptions- Migration lock manager options.MigrationLock- Migration lock data.MigrationMetadata- Migration metadata stored in adapter.MigrationModelAccessor- Model accessor for migrations (subset of full model API).MigrationResult- Result of running a single migration.MigrationRunOptions- Options for running migrations.MigrationRunnerOptions- Options for the migration runner.MigrationStatusReport- Migration status report for CLI.ModelDiff- Diff for a single model between versions.ModelHooks- Model hooks for lifecycle events.ModelInfo- Model information available in setup context.ModelOptions- Model options for registration.ModelQueryResolver- Model-level query resolver for complete control over queries.ModelTransactionContext- Model-level transaction context for bulk operations.ModuleController- Controller for module-level enable/disable operations.ModuleState- Internal module state tracking.NamespaceRouteDefinitions- Route definitions for a namespace.NestingConfig- Configuration for nested directory handling.NormalizedField- Normalized field for internal use.NormalizedSchema- Normalized schema for internal use.OperationParams- Parameters passed to middleware functions.OrderByInput- Order by input.PackageJsonParsedIncludeEntry- Parsed include entry with resolved options.PluginContext- Plugin context available in middleware and extensions.PluginCountArgsPluginCreateManyArgsPluginDataPluginDeleteArgsPluginDeleteManyArgsPluginFindUniqueArgsPluginInfo- Information about an installed plugin.PluginManifestInfo- Minimal plugin manifest info for seed operations.PluginMetaOptionsPluginMiddleware- Middleware hooks for each operation type.PluginSetupContext- Context passed to plugin setup() function.PluginState- Plugin-scoped state storage.PluginUpdateArgsPluginUpdateManyArgsPluginUpsertArgsPortalApi- The Portal API interface.PortalNamespaceConfig- Namespace configuration from manifest.PortalNamespaces- Portal namespace definitions.PortalRouteConfig- Route configuration from manifest.PrepareContext- Context provided to prepare hooks.ProcessedEntry- A scanned entry after processing by the route processor.ProjectMetadata- Project metadata stored in robo.json.PromptQuestionQueryArgs- Query arguments for planning.QueryContext- Context passed to custom query operators.QueryPlan- Query execution plan.RangeOptions- Range query options.ReadSetEntry- Read set entry for version tracking.RecoveryContext- Extended recovery context that can be used when models are loaded.RecoveryResult- Result of WAL recovery.RegisteredMigration- Registered migration with computed checksum.RelationDef- Internal relation field definition.RelationFieldValue- Relation field value in create/update data.RelationInfo- Relation metadata for a model.RelationMetadata- Relation metadata for schema tracking.RelationValidationError- Result of relation schema validation.RepairOptions- Options for repair operations.RepairProgress- Progress update during repair.RepairResult- Result of a repair operation.ResilienceOptions- Options for the resilience wrapper.RoboMessageRoboReplyRoboRequestRoboStateMessageRouteConfig- Configuration for a route definition.RouteDefinitionConfig- Serialized route configuration for the manifest.RouteDefinition- Route definition with handler and controller info.RouteEntries- Aggregated route entries organized by namespace and route name.ScannedEntry- Represents a file discovered during directory scanning.SchemaChange- Schema change descriptor.SchemaField- Schema field (either a Field or RelationField).SchemaHistoryEntry- Schema history entry for visual diff support.SchemaMetadata- Schema metadata persisted per model.SchemaSnapshot- Namespace-level schema snapshot.SchemaValidationError- Individual validation error.ScopedPortal- Scoped portal for plugins.SeedConfig- Seed configuration for a plugin.SeedEnvConfigSeedEnvVariableConfigSeedHookConfigSeedHookGeneratorsSeedHookHelpersSegmentDeleteDelta- Delete a segment for a large record.SegmentPutDelta- Put a segment for a large record.SegmentWriteSerialQueueItem- Serial mode queue item.SetupContext- Context provided to setup hooks.SortedIndexData- Serialized index data for persistence.SpiritMessageStartContext- Context provided to start hooks.StopContext- Context provided to stop hooks.TransactionContextState- Internal transaction context state.TransactionExecutionOptions- Internal options for transaction execution.TransactionOptions- Transaction options for Flashcore.$.transaction().TransactionResult- Transaction execution result.UniqueAcquireDelta- Acquire a unique constraint key.UniqueChange- Unique constraint change descriptor.UniqueConstraintOptions- Options for unique constraint operations.UniqueIndexEntry- Unique index entry stored in the adapter.UniqueIntegrityResult- Result of unique index integrity check.UniqueReleaseDelta- Release a unique constraint key.UniqueUpdate- Unique constraint update descriptor.UpdateArgs- Update arguments.UpdateManyArgs- UpdateMany arguments.UpsertArgs- Upsert arguments.ValidationResult- Validation result from schema validation.VersionDiff- Diff between two schema versions.WalConfig- WAL configuration options.WalEntryHeader- WAL entry header (stored when segmented).WalEntry- Complete WAL entry structure.WalSegmentInfo- Segmentation info for large WAL entries.WhereInput- Where clause input.
Type Aliases
BatchOperation- Operation types for atomic batch operations.ChunkData- Chunk data format.CliAfterHook- Hook that runs after the original command handler completes.CliBeforeHook- Hook that runs before the original command handler.CliHandler- CLI command handler function signature.CliOptionTypeMap- Maps CLI option type strings to their TypeScript types.CliOptionsFromConfig- Infers the complete typed options object from a CLI command config.ControllerFactory- Controller factory function type.CreateInput- Create input type - omit id (auto-generated), required without defaults are required.CreateScopedPortal- Create a scoped portal for a plugin.DisposeCallback- Callback function registered for cleanup when a module is reloaded.ExtractOptionName- Extracts the option name from the --name format.FieldType- Supported field types.FlashcoreClient- Type helper for the Flashcore client.HmrCallback- Callback function for HMR event subscriptions.HooksManifest- All hooks organized by hook type.HttpMethodIncludeClause- Include clause for relations.InferFieldType- Infer the TypeScript type for a field type.InferModelType- Infer the TypeScript type for a complete model schema.LifecycleHookType- Lifecycle hook types that support priority-based execution.LogDrainLogLevelManifestSeedEnvVariables- Seed environment variable configuration.MetadataAggregatorRegistry- Registry of metadata aggregators by namespace.MetadataAggregator- Function that aggregates metadata from handler entries.MiddlewareFn- Middleware function signature - Express/Koa style.MigrationStatus- Migration status values.OnDeleteAction- Delete behavior for relations.OperationArgs- Operation arguments by type.OperationResult- Operation result by type.OperationType- Operation types that can be intercepted by middleware.OrderBy- Order by clause for sorting.OrderDirection- Order direction.PluginRegistry- Plugin registry stored in plugins.json.PluginQueryOperatorFn- Custom query operator function.RelationType- Relation types for model relationships.ResolvedTransactionMode- Effective transaction mode after resolving 'auto'.RouteDefinitions- All route definitions stored in routes/@.json.RouteHandlerRouteType- Route type identifier combining namespace and route name.SchemaChangeType- Types of schema changes that can be detected.SchemaFields- Schema fields object (model schema definition).SeedHookHandlerSeedsIndex- Seeds index stored in seeds/@.json.SelectClause- Select clause for projection.SmartCliCommandConfig- Smart CLI command config for use with createCliCommandConfig().StagedOperation- Staged operation type for transaction context.TimestampFormat- Timestamp format for log entries.TransactionCommitHandler- Transaction commit handler type.TransactionMode- Transaction modes supported by Flashcore.UniqueWhere- Unique where clause - by id or unique fields.UpdateInput- Update input type - all fields optional except id which is not allowed.ValueOfCliOption- Computes the final value type for a CLI option:.WalAuthoritativeDelta- Union of all authoritative delta types.WalDerivedDelta- Union of all derived delta types.WalEntryInput- Input for beginning a new WAL entry.WalInverseDelta- Inverse deltas use the same types (for rollback).WalOp- WAL operation type.WalPhase- WAL phase markers for tracking operation progress.WatcherCallback- Watcher callback signature.WhereClause- Where clause for filtering records.WhereOperators- Where clause operators for filtering.WithClientExtensions- Client extension type helper.WithPluginExtensions- Plugin extension type helper.
Functions
AcquireUniqueConstraints- Acquire multiple unique constraints atomically (best effort).AnalyzeNamespaceChanges- Analyze namespace-level changes (model additions/removals).AnalyzeSchemaChanges- Analyze schema changes between stored metadata and current schema.ApplyCatalogDeleteDelta- Recovery-aware catalog delete.ApplyCatalogSetDelta- Recovery-aware catalog set.ApplyCatalogSetSegmentsDelta- Recovery-aware catalog set for segmented records.ApplyDefaults- Apply default values to a record.ApplyModelExtensions- Apply model extensions from all plugins to a model instance.ApplyPatch- Merge a patch into an existing record.ApplyPatches- Apply JSON Patch operations to an object.BuildAdapter- Create a new AdapterBuilder with the given base adapter.BuildCreateDeltas- Build deltas for a create operation.BuildCreateSegmentedDeltasBuildDeleteDeltas- Build deltas for a delete operation.BuildDeleteSegmentedDeltasBuildIndexKey- Build a sorted index key.BuildModelKey- Build a model key for internal storage.BuildPluginKey- Build a plugin storage key.BuildSchemaHistoryKey- Build a schema history key.BuildSchemaKey- Build a schema metadata key.BuildTransactionOptions- Build effective transaction options with defaults.BuildUniqueKey- Build a unique index key.BuildUpdateChunkToSegmentsDeltasBuildUpdateDeltas- Build deltas for an update operation.BuildUpdateSegmentedDeltasBuildUpdateSegmentsToChunkDeltasBuildWalEntryKey- Build a WAL entry key.BuildWalSegmentKey- Build a WAL segment key.CalculateRetryDelay- Calculate retry delay with optional jitter.CheckRestrictConstraints- Check if delete should be blocked due to restrict policy.ClearSerialQueue- Clear the serial queue (for testing).CollectCascadeOperations- Collect all cascade operations for a delete.CompareChecksums- Compare two schema checksums.ComposeColorsComposeLegacyKey- Compose a key using the legacy format.ComposeMiddleware- Compose multiple middleware functions into one.ComposeV1Key- Compose a key using the safe (v1) format.CompoundUnique- Create a compound unique constraint across multiple fields.ComputePatch- Compute a minimal patch from old and new record.ComputePatches- Compute JSON Patch (RFC 6902) between two objects.ComputeSchemaChecksum- Compute a deterministic checksum for a schema.ConsoleDrain- A drain function that writes logs either to stdout/stderr (in Node.js).CreateBoundContext- Create a bound context for a plugin that can be used in middleware.CreateCacheAdapter- Create a new CacheAdapter wrapping another adapter.CreateChunkManager- Create a chunk manager for a model.CreateCliCommandConfig- Creates a CLI command configuration with proper type inference.CreateClientExtensions- Create client extensions object for Flashcore.$.CreateCompressionAdapter- Create a new CompressionAdapter wrapping another adapter.CreateConditionalMiddleware- Create a middleware that conditionally executes based on model name.CreateEncryptionAdapter- Create a new EncryptionAdapter wrapping another adapter.CreateErrorHandlerMiddleware- Create a middleware that wraps the operation in a try-catch.CreateFileAdapter- Create a new FileAdapter instance.CreateFileDrain- Creates a file-based log drain.CreateFullTextIndex- Create an inverted index for full-text search.CreateJunctionSchema- Create the schema definition for a junction table.CreateKeyvAdapterFromOptions- Dynamically import Keyv and create an adapter.CreateKeyvAdapter- Create a KeyvAdapter from a Keyv instance.CreateLegacyFileAdapter- Create a new LegacyFileAdapter instance.CreateLevelFilteredDrain- Wraps a drain with level filtering.CreateLoggingMiddleware- Create a simple middleware that logs operations.CreateMemoryAdapter- Create a new MemoryAdapter instance.CreateMigrationRunner- Create a migration runner with model access.CreateModel- Create a FlashcoreModel instance.CreateMultiDrain- Composes multiple drains into a single drain that calls all of them.CreatePluginManager- Create a new plugin manager.CreatePluginState- Create a plugin-scoped state instance.CreateResilienceAdapter- Create a new ResilienceAdapter wrapping another adapter.CreateSimpleIndex- Create a simple in-memory index for testing.CreateTrieIndex- Create a trie-based index for prefix matching and autocomplete.CreateValidationMiddleware- Create a middleware that validates args before passing to next.DecodeKey- Decode a storage key back to (namespace, key) pair.DecodeUniqueValue- Decode a unique index value back to its original form.DefineIndex- Define a custom index provider.DefineMigration- Define a migration script.DefinePlugin- Define a Flashcore plugin with full type safety.Delay- Delay helper for retry logic.Emit- Emits an IPC event to the outbox for the host to process.EncodeKey- Encode a (namespace, key) pair into a safe storage key.EncodeUniqueValue- Encode a value for use in unique index keys.EvaluatePluginWhere- Evaluate a where clause against a record.EvaluateWhere- Evaluate a where clause against a record.ExecuteAfterCreate- Execute after-create hook.ExecuteAfterDelete- Execute after-delete hook.ExecuteAfterUpdate- Execute after-update hook.ExecuteBeforeCreate- Execute before-create hook.ExecuteBeforeDelete- Execute before-delete hook.ExecuteBeforeUpdate- Execute before-update hook.ExecuteCascadeOperations- Execute collected cascade operations.ExecuteIndexPlan- Execute a query plan against sorted index.ExecuteWithMiddleware- Execute operation through middleware pipeline.ExtractTimestamp- Extract timestamp from a generated ID (if possible).FilterMightContain- Check if a record might exist using filter.ForModels- Create a middleware that only runs for specific models.ForOperations- Create a middleware that only runs for specific operations.FormatSchemaChanges- Format schema changes for display.FormatTimestamp- Formats a timestamp according to the specified format.GenerateId- Generate a collision-resistant ID.GenerateMigrationContent- Generate migration file content.GenerateMigrationFilename- Helper to generate a migration filename.GenerateRandomId- Generate a random ID (no timestamp component).GetConfig- Returns the currently loaded configuration.GetIndexPersistenceManager- Get the global IndexPersistenceManager instance.GetJunctionModelName- Get deterministic junction model name for two models.GetJunctionTableDef- Get junction table definition for a many-to-many relation.GetMissingRequiredFields- Get missing required fields.GetModeName- Get a descriptive name for a transaction mode.GetPluginContext- Get plugin context for a model.GetPluginManager- Get the global plugin manager.GetPluginNames- Get all registered plugin names.GetPluginOptions- Gets the config options for a specific plugin package.GetSerialQueue- Get the serial transaction queue.GetState- Gets the current IPC state from state.json written by the host.GetUnknownFields- Get field names that are unknown (not in schema).GetWalManager- Get the global WAL manager instance.HasAcidSupport- Check if ACID transactions are available.HasIncludes- Check if an include clause has any entries.HasPlugin- Check if a plugin is registered.HasScanCapability- Check if an adapter supports scanning.HasSchemaChanged- Check if a schema has any changes from stored metadata.InferNamespace- Infer namespace from package name.IsCapable- Checks if a capability/event type is supported by the host.IsJunctionModel- Check if a model name is a junction table.IsReservedPrefix- Check if a key starts with a reserved prefix.IsSerializedBigInt- Check if a value is a serialized BigInt.IsSerializedDate- Check if a value is a serialized date.IsValidId- Validate an ID string.IsWalEnabled- Check if WAL is globally enabled.LoggerMergeHooks- Merge hook objects.MetadataToNormalizedField- Convert FieldMetadata back to a partial NormalizedField structure.NeedsEncoding- Check if a key needs encoding (contains unsafe characters).NormalizeCapabilities- Normalize adapter capabilities.NormalizeNamespace- Normalize namespace input to an array of strings.NormalizeRecordShape- Normalize a record shape by:.NormalizeSchema- Normalize a schema definition into internal format.NormalizedFieldToMetadata- Convert a NormalizedField to FieldMetadata for storage.ParseJunctionModelName- Parse junction model name to extract the two related models.ParseLegacyKey- Parse a legacy composed key back to namespace and key.PrioritizeHookAfter- Set a plugin's hook to run after another plugin's hook.PrioritizeHookBefore- Set a plugin's hook to run before another plugin's hook.RebuildCatalogFromChunks- Rebuild a catalog from chunks and segments stored in the adapter.RecoverWal- Recover from any orphaned WAL entries.RegisterEnvPattern- Register a custom pattern for validating environment variables.ReleaseUniqueConstraints- Release multiple unique constraints.ReplayEntryWithContext- Replay a WAL entry with full model context.RequireCapability- Check if an adapter meets minimum requirements for a feature.RequiresAcid- Check if multi-key atomic operations are supported.RequiresVersionTracking- Determine if a mode requires version tracking for conflict detection.ResolveAutoMode- Resolve 'auto' mode to a concrete mode based on adapter capabilities.ResolveInclude- Resolve includes for a single record.ResolveIncludesBatched- Resolve includes for multiple records with batching (N+1 prevention).RollbackEntryWithContext- Rollback a WAL entry with full model context.ScanKeysToArray- Collect all scan results into an array.ScanKeys- Normalize adapter scan results into an async iterable.SetHookPriority- Set the execution priority for a specific plugin's hook.SetIndexPersistenceManager- Set the global IndexPersistenceManager instance.SetPluginManager- Set the global plugin manager.SetState- Set a value in the state.SetWalManager- Set the global WAL manager instance.SortRecords- Sort records by orderBy clause.SummarizeChanges- Summarize changes for logging.ThrowIfInvalid- Throw validation error if result has errors.ValidateForeignKey- Validate that a foreign key points to an existing record.ValidateForeignKeys- Validate all foreign keys in a record's data.ValidateHooks- Validate hooks object structure.ValidateMode- Validate that a transaction mode is supported by the adapter.ValidateNotReserved- Validate that a key does not use reserved prefixes.ValidateRelationsSchema- Validate relation schema definitions at build/registration time.VerifyCatalogIntegrity- Verify catalog integrity against stored chunks and segments.WarnMissingCapabilities- Log warnings for missing recommended capabilities.WrapModelWithPluginAccess- Wrap a model proxy to include plugin context access.
Variables
AdapterPresets- Recommended wrapper stacks for common use cases.Ansi_regexCatalogLockManager- Global catalog lock manager instance.Catalog_version- Version number for catalog format.ChunkLockManager- Global chunk lock manager instance.ColorDebug_modeDefaultDefault_auto_repair_config- Default auto-repair configuration.Default_connection_settings- Default connection/retry settings.Default_hook_priority- Default hook priority.Default_index_persistence_settings- Default index persistence settings.Default_max_chunk_size- Default chunk size limits.Default_max_records_per_chunk- Default maximum records per chunk.Default_namespace_separator- Default namespace separator for joining array namespaces.Default_on_delete- Default onDelete action for relations.Default_safety_config- Alias for safety config (used by query operations).Default_safety_limits- Default safety limits for queries.Default_transaction_settings- Default transaction settings.Encoded_key_prefix- Prefix for encoded keys that contain special characters.EnvF- Field builder factory object.FlashcoreSystem- Flashcore.$ system API with Proxy wrapper.Flashcore- Built-in KV database for long-term storage.FullTextIndexProvider- Full-text index provider for search.Hmr- HMR cleanup API for hot module replacement.Id_constraints- ID validation constraints.Ipc- Robo IPC Protocol for host-app communication.Junction_prefix- Prefix for junction table model names.Legacy_key_separator- Separator between namespace and key in the legacy composed key format.Manifest- The Manifest API singleton.Max_cascade_depth- Maximum cascade depth to prevent infinite recursion.Max_include_depth- Maximum include depth for relation loading.Max_lengths- Maximum lengths for validation.Max_schema_history_entries- Maximum number of schema history entries to keep.Max_version_value- Maximum safe version value (2^53 - 1).MigrationRegistry- Global migration registry instance.Migration_lock_key- Key for the migration lock.Migration_lock_timeout_ms- Default migration lock timeout (5 minutes).Migration_status_prefix- Key prefix for migration metadata.Migration_template- Migration template for code generation.Mode- Modes are a way to define "profiles" for your Robo session.Portal- The portal singleton with typed namespace access.Reserved_prefixes- Reserved key prefixes for internal Flashcore data.Robo- Robo is the main entry point for your app.SafeKeyEncoder- Default encoder instance.Safe_id_pattern- Valid characters for record IDs (no encoding needed).Safe_key_chars- Characters that are safe in storage keys (no encoding needed).Schema_meta_suffix- Key suffix for model schema metadata.TrieIndexProvider- Trie index provider for autocomplete/prefix search.Version_field_name- Name of the auto-injected version field for optimistic locking.Version_overflow_warn_threshold- Threshold for version overflow warning.Wal_clock_skew_tolerance_ms- Clock skew tolerance for WAL staleness detection (5 seconds).Wal_default_segment_size- Default maximum size for a single WAL entry value (100KB).Wal_entry_key_prefix- Key prefix for WAL entry headers.Wal_entry_prefix- Extract the WAL entry prefix for scanning.Wal_segment_prefix- Key prefix for WAL entry segments (for large entries).Wal_stale_threshold_ms- Default threshold for considering a WAL entry "stale" (5 minutes).