core

CollectionHooks configures resource-level callbacks through Collection.Hooks or Global.Hooks. Use BeforeChange to change values before a save, AfterRead to change a response without changing storage, and AfterCommit for effects that must run only after a successful commit. Each list runs in declaration order. Resource hooks run before field hooks in the same phase, except AfterCommit, where field hooks run first. Globals do not support BeforeDuplicate, BeforeDelete, or AfterDelete.

HookContext supplies the request, values, and local API to a collection or global hook. Change entries in Data before saving, or values in Document to change the response after saving. A Hook returns only an error.

PluginDescriptor is deterministic public metadata for one compiled plugin. It is copied into the canonical manifest so generators, migration planning, the admin build, and compatibility tooling all inspect the same declaration. Executable hooks, handlers, validators, and secrets never belong here.

Application-level configuration for the framework-owned admin.

Admin interface languages and editor timezone choices.

One statically bundled admin interface language.

One timezone offered by the admin interface.

Author-facing singular and plural collection names.

One ordered compound database index.

Serializable presentation metadata for a global.

Executable application-owned Ridu configuration.

Application content-locale configuration.

Dynamically limit content locales shown to one author.

Request input for dynamic admin locale visibility.

One content locale and its ordered fallback chain.

Collection defines one document collection in authoring configuration.

Serializable collection presentation metadata.

Global defines one singleton document in authoring configuration.

Revision and draft behavior for a versioned resource.

Read content for the signed-in user while a Go admin loader runs.

A Go admin loader ready to register in your application's Admin.Loaders.

BulkOptions controls the actor and localization of an atomic batch or empty-trash operation. Bulk actions do not consume per-document revisions, population, draft status, or caller IDs.

FieldGraphContext identifies the resource a graph plugin is editing. Resource transforms complete first; graph transforms then run once in Plugins order. Resource hooks, endpoints and domain capabilities retain their own contracts.

PublicationScheduleOptions controls revision fencing and the saved display timezone. TimeZone is optional; it never changes the instant supplied in runAt.

TypedReadOptions controls population/projection without changing the generated definition's single-locale or all-locales output shape.

UploadGrant is a short-lived delivery URL for one upload object. The URL authorizes that object without carrying the session token.

UploadGrantRequest names one upload document and an optional configured image size. An empty Size selects the original object.

The maximum encoded JSON size accepted for durable task input or output.

Resolve executable config into the immutable canonical schema manifest.

Resolve an application and bind it to an already-open document store.

Structured operation-boundary failure.

Result of one atomic inverse-relationship mutation.

Locale selection for one single-document Local API operation.

Projection, population, authorization, draft, trash, and locale controls for one read.

Filtering, pagination, projection, population, authorization, and locale controls for a list read.

Field, filtering, pagination, authorization, draft, trash, and locale controls for one unique-value read.

A count-free bounded unique-index range for background work.

Authorization, optimistic concurrency, response population, create status, and locale controls for one write.

Side-effect-free access evaluation input.

Evaluated operation and per-field permission booleans.

Migration-owned source identity, status, and timestamps.

File bytes and application-owned metadata for one upload.

A public HTTP(S) asset and upload metadata.

One named derived image variant and fit policy.

Result counters from upload reconciliation.

Validation and object-storage behavior for an upload collection.

Atomic upload replacement, image edit, document data, and publishing input.

A reversible crop and focal point on the oriented source image.

Safe current lock metadata and actor capabilities.

Expiration policy for coordinated authoring locks.

One short-lived read-only resource capability.

One named authoring viewport offered by live preview.

Serializable same- or cross-origin editor preview configuration.

A presence-aware value used by nullable generated Go mutation fields.

Construct a present generated mutation field with a concrete value.

Construct a present generated mutation field whose JSON value is null.

A write-only generated mutation value that refuses to encode JSON null.

Construct a required generated mutation value that must not encode as JSON null.

Construct a present omittable generated mutation value that must not encode as JSON null.

Create a generated-model handle for one collection slug.

An unbound typed collection descriptor.

Typed collection methods for strict writes, incomplete working drafts, publication, reads, and deletion.

A typed list result with the ordinary page metadata.

Filter, paginate, populate and project generated documents without changing the binding’s locale shape.

Actor, draft intent, expected revision, locale, and response controls for a generated Go mutation.

Create a generated-model handle for one global slug.

Typed singleton methods for reads, working drafts, publication, restoration, and discard.

Generated typed definition for one global.

Typed Find and List reads with population, projection and all translations.

A typed global read with population, projection and all translations.

A collection read descriptor for generated all-locales document models.

A global read descriptor for generated all-locales document models.

An allow, deny, or filtered authorization result.

Access rules for collection reads and mutations.

Access rules for reading, updating, publishing, and unpublishing a global.

Return an authorization decision for one operation.

Identity, operation, locale, and request data for an access rule.

Allow, deny, or filtered access-decision discriminant.

Authorize an operation without a document predicate.

Reject an operation.

Authorize only documents matching an atomic predicate.

Run code during a collection or global lifecycle phase.

Application-wide failure hooks for errors raised before a resource resolves.

Choose how hooks run after their transaction commits.

The operation details and callback passed to an after-commit dispatcher.

The minimum compiled backend plugin contract.

Opt into versioned generation, migration, and compatibility tooling.

Non-generic compiled task boundary stored in Config.Tasks.

FieldGraphTransformer edits immutable fields through public graph operations. The input and result are snapshotted. Plugins should return deterministic edits; closure captures and other plugin-owned external state remain their responsibility. Duplicate plugin keys are rejected before any transform runs.

FieldGraphValidator checks a resource's final immutable field configuration after every graph transformer has completed. It cannot publish graph edits. Use this for plugin-owned schema and host settings, not document validation; runtime value validators belong to the field or plugin value contract.

Contribute deterministic files that require executable plugin configuration.

Immutable schema state supplied to plugin generation.

One deterministic plugin-scoped generated file.

Transform a defensive copy of authored config before final validation.

Append compiled collection or field hooks.

Provide path-aware runtime validators for plugin field keys.

Contribute exact REST endpoints below a namespaced plugin prefix.

Bind an established application-level protocol once at startup.

Non-secret permission summary for resource operations.

Evaluated permissions for one authored field path.

One application-authored method and path handler mounted at root, collection, or global scope.

Raw HTTP, route parameters, verified actor identity, and LocalAPI supplied to a custom endpoint.

Trusted compiled custom endpoint handler.

The compiled backend plugin contract version supported by this Ridu release.

The statically bundled admin-plugin contract version supported by this Ridu release.

A half-open supported framework semantic-version interval.

Static pairing metadata for a plugin admin package.

Exact generated Go, TypeScript, where, and OpenAPI types for a plugin field.

Ordered collection or field hooks contributed by a plugin.

Resolved plugin field and candidate value supplied to validation.

Return path-aware issues for one plugin-owned value.

Initialized application state supplied while a plugin binds transports.

Public constant AccessAllow from github.com/riducms/ridu/core.

Public constant AccessDeny from github.com/riducms/ridu/core.

Public constant AccessWhere from github.com/riducms/ridu/core.

Public constant AuthOperationAPIKey from github.com/riducms/ridu/core.

Public constant AuthOperationEmailVerification from github.com/riducms/ridu/core.

Public constant AuthOperationExternalStrategy from github.com/riducms/ridu/core.

Public constant AuthOperationForgotPassword from github.com/riducms/ridu/core.

Public constant AuthOperationLogin from github.com/riducms/ridu/core.

Public constant AuthOperationLogout from github.com/riducms/ridu/core.

Public constant AuthOperationMe from github.com/riducms/ridu/core.

Public constant AuthOperationPasswordReset from github.com/riducms/ridu/core.

Public constant AuthOperationRotate from github.com/riducms/ridu/core.

Public constant AuthOperationSession from github.com/riducms/ridu/core.

Public constant TaskBackoffExponential from github.com/riducms/ridu/core.

Public constant TaskBackoffFixed from github.com/riducms/ridu/core.

Public constant TaskBackoffLinear from github.com/riducms/ridu/core.

Public constant TaskErrorInvalidInput from github.com/riducms/ridu/core.

Public constant TaskErrorInvalidOutput from github.com/riducms/ridu/core.

Public constant TaskErrorLeaseLost from github.com/riducms/ridu/core.

Public constant TaskErrorNotFound from github.com/riducms/ridu/core.

Public constant TaskErrorNotRegistered from github.com/riducms/ridu/core.

Public constant TaskErrorStoreFailed from github.com/riducms/ridu/core.

Public constant TaskErrorUnavailable from github.com/riducms/ridu/core.

DefaultUploadGrantLifetime is used when a grant request omits a lifetime.

MaxUploadGrantLifetime bounds how long a leaked delivery URL stays usable.

MaxUploadGrantsPerRequest bounds one grant request.

Define a Go read function whose result is supplied to an admin component.

NewTypedAllLocalesCollection constructs an all-locales generated read definition.

NewTypedAllLocalesGlobal constructs an all-locales generated global definition.

Reject stops an operation from a collection, global, or field hook with a message for the person who made the request. The admin shows the message, and REST, the SDK, and the Local API return it as a "rejected" error (HTTP 422). Any other error from a hook is reported as an internal failure whose message stays on the server.