Module
schema
github.com/riducms/ridu/schema — The immutable generated schema manifest, stable identifiers, and advanced generator/plugin contracts.
Functions 4
schema.NewManifest()Create a manifest from a detached snapshot.
schema.Parse()Parse and validate encoded manifest JSON.
schema.IsSupportedEndpointMethod()Report whether a method belongs to the custom endpoint contract.
schema.IsValidEndpointPath()Validate the deterministic custom endpoint path grammar.
Types 4
type schema.ManifestAn immutable versioned schema contract.
type schema.StableIDA deterministic identifier for schema evolution.
type schema.CollectionSlugA validated collection or global slug.
type schema.LocaleCodeA validated locale identity used by operations, manifests, and storage.
Manifest model 18
type schema.SnapshotThe serializable application and content schema.
type schema.VersionThe manifest wire-format version.
constant schema.CurrentVersionThe schema-manifest format version produced and accepted by this build.
type schema.ApplicationResolved application metadata safe for tooling and the admin.
type schema.EndpointDeterministic public metadata for one application-authored custom endpoint.
type schema.AdminLocalizationSettingsDeterministic admin interface language and timezone configuration.
type schema.AdminLanguageOne statically bundled admin interface language.
type schema.AdminTimeZoneOne browser-safe timezone offered to editors.
type schema.LocalizationSettingsDeterministic content-locale configuration.
type schema.CollectionThe resolved contract for a collection.
type schema.FieldThe resolved contract for one field.
type schema.FieldTypeThe resolved field discriminator shared with generated contracts.
type schema.CapabilitiesResolved feature flags for one collection or global.
type schema.AdminSettingsThe durable ID and current slug of the auth collection trusted by the admin.
type schema.LocaleOne resolved locale in deterministic authoring order.
type schema.CollectionAdminResolved collection presentation, hierarchy, and live-preview metadata.
type schema.CollectionLabelsNormalized singular and plural labels.
type schema.GlobalThe resolved singleton schema alias.
Capability settings 8
type schema.AuthSettingsPublic resolved authentication policy.
type schema.UploadSettingsResolved media validation and delivery policy.
type schema.VersionSettingsResolved drafts, snapshot retention, and autosave policy.
type schema.DocumentLockSettingsResolved authoring lock lease.
type schema.CollectionIndexAn ordered compound index over supported field paths.
type schema.LivePreviewA serializable preview URL template and viewports.
type schema.PreviewBreakpointOne named live-preview viewport.
type schema.ImageSizeOne named derived upload image variant.
Field details 36
type schema.FieldAdmintype schema.FieldAdminComponenttype schema.FieldCategorytype schema.FieldRowtype schema.FieldCollapsibletype schema.FieldTabGrouptype schema.FieldConditiontype schema.FieldConditionKindtype schema.FieldConditionScopetype schema.FieldConditionOperatortype schema.FieldConditionPredicatetype schema.FieldConditionValuetype schema.TextFieldtype schema.SlugFieldtype schema.CodeFieldtype schema.NumberFieldtype schema.DateFieldtype schema.DatePickerAppearancetype schema.PointFieldtype schema.UIFieldtype schema.ValueTypetype schema.VirtualFieldtype schema.SelectFieldtype schema.SelectChoicetype schema.RelationshipFiltertype schema.RelationshipFilterValuetype schema.RelationshipTargettype schema.UploadFieldtype schema.ReferenceDeleteActiontype schema.BlockTypetype schema.RelationshipFieldtype schema.JoinFieldtype schema.NestedFieldtype schema.ArrayRowLabelstype schema.BlocksFieldtype schema.PluginField
Plugin manifest 10
constant schema.CurrentPluginAPIVersionThe compiled backend plugin contract represented by this manifest version.
constant schema.CurrentAdminPluginAPIVersionThe static backend/admin plugin contract represented by this manifest version.
type schema.PluginA compiled plugin that participated in config resolution.
type schema.PluginAdminStatic admin-package pairing metadata.
type schema.PluginCompatibilityA half-open supported Ridu semantic-version interval.
type schema.PluginFieldTypeGenerated Go, TypeScript, and JSON Schema contracts for a plugin field.
type schema.PluginDatabaseAdapterPostgreSQL or SQLite identity for private plugin schema.
type schema.PluginDatabaseContributionOne adapter-specific migration history and owned-table list.
type schema.PluginMigrationOne declarative contiguous adapter-specific migration transition contributed by a plugin.
type schema.PluginEndpointPublic method, path, and summary for one compiled plugin endpoint.
Validation 18
type schema.ValidationErrorA path-aware set of schema issues.
type schema.IssueOne stable path-aware schema problem.
schema.NewValidationError()Create a path-aware validation error from issues.
schema.IsValidStableID()Check canonical deterministic schema identity syntax.
schema.IsValidCollectionSlug()Check URL- and API-facing collection slug syntax.
schema.IsValidLocaleCode()Check locale codes accepted by URLs, contracts, and storage.
schema.IsValidFieldName()Check unquoted generated property and query-path syntax.
schema.IsValidPluginKey()Check a plugin’s stable manifest key.
schema.IsValidPluginMigrationSQL()Check the shared plugin migration execution boundary.
schema.IsValidAdminPluginPackage()Check a static JavaScript package specifier.
schema.IsValidAdminPluginExport()Check a named JavaScript export identifier.
schema.IsValidSemanticVersion()Check a complete unprefixed semantic version.
schema.IsValidSemanticVersionRange()Check a non-empty half-open semantic-version interval.
schema.SemanticVersionInRange()Test a version against a validated half-open interval.
schema.IsValidAdminPluginRoute()Check a package-relative admin plugin route.
schema.IsValidAdminPluginAsset()Check a package-relative static admin side-effect import.
schema.IsValidGoPackage()Check a portable Go import path.
schema.IsValidPluginTable()Check an unquoted adapter-owned plugin table identifier.
Constants 46
constant schema.DatePickerDayAndTimeconstant schema.DatePickerDayOnlyconstant schema.DatePickerTimeOnlyconstant schema.FieldCategoryNestedconstant schema.FieldCategoryPluginconstant schema.FieldCategoryPresentationconstant schema.FieldCategoryRelationshipconstant schema.FieldCategoryScalarconstant schema.FieldCategoryUploadconstant schema.FieldConditionDocumentconstant schema.FieldConditionEqualsconstant schema.FieldConditionKindAllconstant schema.FieldConditionKindAnyconstant schema.FieldConditionKindNotconstant schema.FieldConditionKindPredicateconstant schema.FieldConditionNotEqualsconstant schema.FieldConditionOneOfconstant schema.FieldConditionSiblingconstant schema.FieldTypeArrayconstant schema.FieldTypeBlocksconstant schema.FieldTypeCheckboxconstant schema.FieldTypeCodeconstant schema.FieldTypeDateconstant schema.FieldTypeEmailconstant schema.FieldTypeGroupconstant schema.FieldTypeJoinconstant schema.FieldTypeJSONconstant schema.FieldTypeNumberconstant schema.FieldTypePluginconstant schema.FieldTypePointconstant schema.FieldTypeRadioconstant schema.FieldTypeRelationshipconstant schema.FieldTypeSelectconstant schema.FieldTypeTextconstant schema.FieldTypeTextareaconstant schema.FieldTypeUIconstant schema.FieldTypeUploadconstant schema.FieldTypeVirtualconstant schema.PluginDatabaseAdapterPostgresconstant schema.PluginDatabaseAdapterSQLiteconstant schema.ReferenceDeleteNullifyconstant schema.ReferenceDeleteRestrictconstant schema.ValueTypeBooleanconstant schema.ValueTypeJSONconstant schema.ValueTypeNumberconstant schema.ValueTypeString