Module

ridu

github.com/riducms/ridu — Configure a Ridu application, start its server, and define access rules.

Functions 8

  • ridu.New()

    Create an application from config and a document store.

  • ridu.Resolve()

    Resolve executable config into a deterministic schema manifest.

  • ridu.Execute()

    Run the API, admin, jobs, and shutdown lifecycle.

  • ridu.Allow()

    Allow an access-controlled operation.

  • ridu.Deny()

    Deny an access-controlled operation.

  • ridu.Where()

    Constrain access to documents matching a query expression.

  • ridu.NewAdminLoader()

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

  • ridu.Reject()

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

Types 14

  • type ridu.Config

    The complete author-owned application definition.

  • type ridu.Collection

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.Global

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.AdminLoadContext

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

  • type ridu.AdminLoaderDefinition

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

  • type ridu.BulkOptions

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.PublicationScheduleOptions

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.RemoteUploadInput

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.RootHooks

    RootHooks holds hooks for the whole application. Assign it to Config.Hooks. Its AfterError hooks see every failed operation, including failures that happen before Ridu knows which collection or global is involved.

  • type ridu.TypedMutationOptions

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.UpdateUploadInput

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.UploadGrant

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.UploadGrantRequest

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

  • type ridu.UploadImageEdit

    Public authoring and runtime contracts live in core. These aliases keep the root package as the ergonomic application-facing entry point.

Configuration 16

Runtime setup 12

Local API 14

Authentication 20

Uploads 3

Durable tasks 24

Access 6

Hooks 5

Custom endpoints 3

Plugins 20

Observability 3

Application contracts 1

  • type ridu.App

    A resolved application bound to its document and optional service stores.

Runtime 1

Constants 26