Module
core
github.com/riducms/ridu/core — Application contracts and the operation runtime behind the root facade.
Types 19
type core.PluginDescriptorVersioned plugin metadata and capabilities.
type core.AdminConfigApplication-level configuration for the framework-owned admin.
type core.AdminLocalizationConfigAdmin interface languages and editor timezone choices.
type core.AdminLanguageOne statically bundled admin interface language.
type core.AdminTimeZoneOne timezone offered by the admin interface.
type core.CollectionLabelsAuthor-facing singular and plural collection names.
type core.CollectionIndexOne ordered compound database index.
type core.GlobalAdminSerializable presentation metadata for a global.
type core.ComputedContextRuntime input for one virtual field resolver.
type core.ConfigExecutable application-owned Ridu configuration.
type core.LocalizationConfigApplication content-locale configuration.
type core.LocaleAvailabilityDynamically limit content locales shown to one author.
type core.LocaleAvailabilityContextRequest input for dynamic admin locale visibility.
type core.LocaleOne content locale and its ordered fallback chain.
type core.CollectionExecutable authoring configuration for one document collection.
type core.CollectionAdminSerializable collection presentation metadata.
type core.GlobalExecutable authoring configuration for one singleton document.
type core.VersionConfigRevision and draft behavior for a versioned resource.
type core.ComputedResolve one validated virtual field value.
Runtime 42
constant core.FrameworkVersiontype core.Apptype core.LocalAPIApp.RunTasks()type core.Operationtype core.ReadinessChecktype core.AuditEventtype core.RequestObservationtype core.RequestErrorEventtype core.TaskBackofftype core.TaskHandlertype core.TaskReconcilertype core.TaskContexttype core.TaskOptiontype core.TaskEnqueueOptionstype core.TaskReceipttype core.TaskResulttype core.TaskErrorCodetype core.TaskErrortype core.TaskRunSummarytype core.TypedTasktype core.HandlerOptionstype core.ServerOptionstype core.StoreFactorytype core.StorageFactorytype core.ExecuteOptioncore.WithUploadStorage()core.WithStore()core.WithProjectMigrations()core.WithAddress()core.WithHandlerOptions()core.WithServerOptions()core.Execute()core.TaskQueue()core.TaskRetries()core.TaskTimeout()core.TaskRetention()core.TaskAdmissionReconciler()core.NewTask()core.RetryTask()core.RetryTaskAfter()core.AbortTask()
Application 6
constant core.MaxTaskPayloadBytesThe maximum encoded JSON size accepted for durable task input or output.
App.Manifest()App.Local()App.Handler()core.Resolve()Resolve executable config into the immutable canonical schema manifest.
core.New()Resolve an application and bind it to an already-open document store.
Local API 65
LocalAPI.Create()LocalAPI.CreateWithOptions()LocalAPI.Duplicate()LocalAPI.DuplicateWithOptions()LocalAPI.Find()LocalAPI.FindWithOptions()LocalAPI.List()LocalAPI.Distinct()LocalAPI.ListWindow()LocalAPI.Update()LocalAPI.UpdateWithOptions()LocalAPI.Delete()LocalAPI.DeleteWithOptions()LocalAPI.RestoreDeleted()LocalAPI.DeletePermanent()LocalAPI.Publish()LocalAPI.PublishWithOptions()LocalAPI.PublishChanges()LocalAPI.PublishChangesWithOptions()LocalAPI.Unpublish()LocalAPI.UnpublishWithOptions()LocalAPI.Versions()LocalAPI.Version()LocalAPI.Restore()LocalAPI.RestoreAsDraft()LocalAPI.RestoreVersionWithOptions()LocalAPI.Import()LocalAPI.Capabilities()LocalAPI.UpdateRevision()LocalAPI.MutateJoin()LocalAPI.CopyLocale()LocalAPI.RestoreDeletedWithOptions()LocalAPI.DeletePermanentWithOptions()LocalAPI.MutateJoinWithOptions()LocalAPI.CopyLocaleWithOptions()LocalAPI.VersionsWithOptions()LocalAPI.VersionWithOptions()LocalAPI.BulkUpdate()LocalAPI.BulkPublish()LocalAPI.BulkUnpublish()LocalAPI.BulkDelete()LocalAPI.BulkRestoreDeleted()LocalAPI.BulkDeletePermanent()LocalAPI.EmptyTrash()LocalAPI.Global()LocalAPI.UpdateGlobal()LocalAPI.GlobalWithOptions()LocalAPI.UpdateGlobalWithOptions()LocalAPI.PublishGlobal()LocalAPI.PublishGlobalWithOptions()LocalAPI.PublishGlobalChanges()LocalAPI.PublishGlobalChangesWithOptions()LocalAPI.UnpublishGlobal()LocalAPI.UnpublishGlobalWithOptions()LocalAPI.CopyGlobalLocale()LocalAPI.CopyGlobalLocaleWithOptions()LocalAPI.GlobalVersionsWithOptions()LocalAPI.GlobalVersion()LocalAPI.GlobalVersionWithOptions()LocalAPI.RestoreGlobal()LocalAPI.RestoreGlobalAsDraft()LocalAPI.RestoreGlobalVersionWithOptions()LocalAPI.GlobalVersions()type core.OperationErrortype core.JoinMutationResult
Local API options 9
type core.LocaleOptionsLocale selection for one single-document Local API operation.
type core.FindOptionsProjection, population, authorization, draft, trash, and locale controls for one read.
type core.ListOptionsFiltering, pagination, projection, population, authorization, and locale controls for a list read.
type core.DistinctOptionsField, filtering, pagination, authorization, draft, trash, and locale controls for one unique-value read.
type core.ListWindowOptionsA count-free bounded unique-index range for background work.
type core.MutationOptionsAuthorization, optimistic concurrency, response population, create status, and locale controls for one write.
type core.CapabilityOptionsSide-effect-free access evaluation input.
type core.AccessCapabilitiesEvaluated operation and per-field permission booleans.
type core.ImportOptionsMigration-owned source identity, status, and timestamps.
Authentication 51
type core.AuthIdentitytype core.AuthSessiontype core.LoginOptionsApp.AuthInitialized()App.AuthBootstrapAvailable()App.CreateAuthUser()App.Login()App.Session()App.RotateSession()App.Sessions()App.RevokeSession()App.Logout()App.LogoutAll()App.ChangePassword()App.RequestPasswordReset()App.ResetPassword()App.RequestVerification()App.VerifyEmail()App.CreateAPIKey()App.AuthenticateAPIKeyIdentity()App.AuthenticateExternalIdentity()App.APIKeys()App.RevokeAPIKey()App.AuthenticateAPIKey()App.PruneExpiredAuth()App.CreateAuthUserWithOptions()App.CreateAuthUserForTransport()App.CreateAuthUserForTransportWithOptions()App.SetPassword()App.LoginWithOptions()App.AuthenticateExternal()App.ForceUnlock()App.UnlockAuthUser()type core.PasswordPolicytype core.PasswordResetConfigtype core.VerifyEmailConfigtype core.PasswordResetNotificationtype core.VerifyEmailNotificationtype core.AuthAccesstype core.AuthContexttype core.AuthHookstype core.AuthStrategytype core.AuthStrategyContexttype core.AuthStrategyResulttype core.AuthAccessRuletype core.AuthHooktype core.AuthOperationtype core.AuthSessionInfotype core.APIKeytype core.APIKeyInfotype core.AuthConfig
Uploads 20
type core.UploadInputFile bytes and application-owned metadata for one upload.
type core.RemoteUploadInputA public HTTP(S) asset and upload metadata.
App.Upload()App.UploadFromURL()App.OpenUploadWithOptions()App.UpdateUploadImage()App.ReconcileUploads()App.Duplicate()App.DuplicateForIdentity()App.DuplicateWithOptions()App.UploadForIdentity()App.UploadFromURLForIdentity()App.UpdateUploadImageForIdentity()App.OpenUpload()App.OpenUploadForIdentity()App.CleanupUploads()type core.ImageSizeOne named derived image variant and fit policy.
type core.ReconcileResultResult counters from upload reconciliation.
type core.UploadConfigValidation and object-storage behavior for an upload collection.
type core.UpdateUploadImageInputFocal point and optional crop for regenerating image variants.
Publishing 4
Document locks 5
type core.DocumentLockStateSafe current lock metadata and actor capabilities.
App.DocumentLock()App.AcquireDocumentLock()App.ReleaseDocumentLock()type core.DocumentLockConfigExpiration policy for coordinated authoring locks.
Live preview 8
type core.PreviewTokenOne short-lived read-only resource capability.
App.CreateCollectionPreviewToken()App.FindCollectionPreview()App.CreateGlobalPreviewToken()App.FindGlobalPreview()App.RevokePreviewToken()type core.PreviewBreakpointOne named authoring viewport offered by live preview.
type core.LivePreviewConfigSerializable same- or cross-origin editor preview configuration.
Preferences 4
Generated Go API 14
type core.InputA presence-aware value used by nullable generated Go mutation fields.
core.Set()Construct a present generated mutation field with a concrete value.
core.Null()Construct a present generated mutation field whose JSON value is null.
type core.NonNullInputA write-only generated mutation value that refuses to encode JSON null.
core.NonNull()Construct a required generated mutation value that must not encode as JSON null.
core.SetNonNull()Construct a present omittable generated mutation value that must not encode as JSON null.
core.NewTypedCollection()Create a generated-model handle for one collection slug.
type core.TypedCollectionAn unbound typed collection descriptor.
type core.BoundTypedCollectionTyped Create, Import, Find, List, Update, UpdateRevision, and Delete methods.
type core.TypedPageA typed list result with the ordinary page metadata.
type core.TypedListOptionsList controls whose result shape remains compatible with one generated Go document model.
core.NewTypedGlobal()Create a generated-model handle for one global slug.
type core.BoundTypedGlobalTyped Find, Update, Publish, Unpublish, Restore, and RestoreAsDraft methods.
type core.TypedGlobalGenerated typed definition for one global.
Access 12
type core.AccessDecisionAn allow, deny, or filtered authorization result.
type core.CollectionAccessAccess rules for collection reads and mutations.
type core.GlobalAccessAccess rules for reading, updating, publishing, and unpublishing a global.
type core.AccessRuleReturn an authorization decision for one operation.
type core.AccessContextIdentity, operation, locale, and request data for an access rule.
type core.FieldAccessIndependent authorization rules for one authored field path.
type core.FieldAccessRuleAuthorize one field operation; false rejects writes or redacts reads.
type core.FieldAccessContextThe concrete field occurrence and transaction state supplied to a field rule.
type core.AccessDecisionKindAllow, deny, or filtered access-decision discriminant.
core.Allow()Authorize an operation without a document predicate.
core.Deny()Reject an operation.
core.Where()Authorize only documents matching an atomic predicate.
Hooks 6
type core.CollectionHooksOrdered lifecycle hooks for a collection.
type core.HookA collection lifecycle callback.
type core.HookContextTransactional operation state passed to lifecycle hooks.
type core.RootHooksApplication-wide failure hooks for errors raised before a resource resolves.
interface core.AfterCommitDispatcherDeliver committed lifecycle effects immediately or through an application boundary.
type core.AfterCommitEffectIdentity and executable work for one committed hook.
Interfaces 3
interface core.PluginThe minimum compiled backend plugin contract.
interface core.DescriptorProviderOpt into versioned generation, migration, and compatibility tooling.
interface core.TaskDefinitionNon-generic compiled task boundary stored in Config.Tasks.
Capabilities 10
interface core.GenerationProviderContribute deterministic files that require executable plugin configuration.
type core.PluginGenerationContextImmutable schema state supplied to plugin generation.
type core.PluginGeneratedArtifactOne deterministic plugin-scoped generated file.
interface core.ConfigTransformerTransform a defensive copy of authored config before final validation.
interface core.HookProviderAppend compiled collection or field hooks.
interface core.FieldValidatorProviderProvide path-aware runtime validators for plugin field keys.
interface core.EndpointProviderContribute exact REST endpoints below a namespaced plugin prefix.
interface core.TransportProviderBind an established application-level protocol once at startup.
type core.OperationCapabilitiesNon-secret permission summary for resource operations.
type core.FieldCapabilitiesEvaluated permissions for one authored field path.
Custom endpoints 3
type core.EndpointOne application-authored method and path handler mounted at root, collection, or global scope.
type core.EndpointContextRaw HTTP, route parameters, verified actor identity, and LocalAPI supplied to a custom endpoint.
type core.EndpointHandlerTrusted compiled custom endpoint handler.
Descriptors 16
constant core.PluginAPIVersionThe compiled backend plugin contract version supported by this Ridu release.
constant core.AdminPluginAPIVersionThe statically bundled admin-plugin contract version supported by this Ridu release.
type core.RiduCompatibilityA half-open supported framework semantic-version interval.
type core.AdminPluginMetadataStatic pairing metadata for a plugin admin package.
type core.PluginFieldTypeExact generated Go, TypeScript, where, and OpenAPI types for a plugin field.
type core.PluginDatabaseAdapterA closed adapter identity for exceptional private plugin schema.
type core.PluginDatabaseContributionOne explicitly adapter-scoped private migration bundle.
type core.PluginMigrationOne immutable contiguous reversible adapter-specific transition.
type core.PluginHookContributionOrdered collection or field hooks contributed by a plugin.
type core.PluginFieldValidationContextResolved plugin field and candidate value supplied to validation.
type core.PluginFieldValidatorReturn path-aware issues for one plugin-owned value.
type core.PluginEndpointOne exact method-specific namespaced plugin REST endpoint.
type core.PluginEndpointContextAuthenticated HTTP and LocalAPI context for a plugin endpoint.
type core.PluginEndpointHandlerTrusted compiled namespaced endpoint handler.
type core.PluginTransportOne exact application-level HTTP protocol route.
type core.PluginTransportContextInitialized application state supplied while a plugin binds transports.
Constants 36
constant core.AccessAllowconstant core.AccessDenyconstant core.AccessWhereconstant core.AuthOperationAPIKeyconstant core.AuthOperationEmailVerificationconstant core.AuthOperationExternalStrategyconstant core.AuthOperationForgotPasswordconstant core.AuthOperationLoginconstant core.AuthOperationLogoutconstant core.AuthOperationMeconstant core.AuthOperationPasswordResetconstant core.AuthOperationRefreshconstant core.OperationAdminconstant core.OperationCreateconstant core.OperationDeleteconstant core.OperationDeletePermanentconstant core.OperationDuplicateconstant core.OperationPublishconstant core.OperationReadconstant core.OperationReadVersionsconstant core.OperationRestoreDeletedconstant core.OperationUnlockconstant core.OperationUnpublishconstant core.OperationUpdateconstant core.PluginDatabaseAdapterPostgresconstant core.PluginDatabaseAdapterSQLiteconstant core.TaskBackoffExponentialconstant core.TaskBackoffFixedconstant core.TaskBackoffLinearconstant core.TaskErrorInvalidInputconstant core.TaskErrorInvalidOutputconstant core.TaskErrorLeaseLostconstant core.TaskErrorNotFoundconstant core.TaskErrorNotRegisteredconstant core.TaskErrorStoreFailedconstant core.TaskErrorUnavailable
Methods 27
AccessDecision.Filter()AccessDecision.Kind()BoundTypedCollection.Create()BoundTypedCollection.Delete()BoundTypedCollection.Find()BoundTypedCollection.Import()BoundTypedCollection.List()BoundTypedCollection.Update()BoundTypedCollection.UpdateRevision()BoundTypedGlobal.Find()BoundTypedGlobal.Publish()BoundTypedGlobal.Restore()BoundTypedGlobal.RestoreAsDraft()BoundTypedGlobal.Unpublish()BoundTypedGlobal.Update()Input.MarshalJSON()NonNullInput.MarshalJSON()TaskError.Error()TaskError.Unwrap()TypedCollection.Slug()TypedCollection.With()TypedGlobal.Slug()TypedGlobal.With()TypedTask.Cancel()TypedTask.Enqueue()TypedTask.Result()TypedTask.TaskSlug()