Module
@riducms/protocol
@riducms/protocol — Generated wire contracts and runtime guards shared by the SDK and admin.
Types 15
constant PROTOCOL_VERSIONThe generated REST/protocol contract version.
constant SCHEMA_MANIFEST_VERSIONThe schema-manifest wire version accepted by this package.
constant ADMIN_PLUGIN_API_VERSIONThe framework-owned admin-plugin contract version.
type ErrorCodeStable machine-readable failure codes.
type SchemaPluginDatabaseAdapterThe database dialect for one private plugin schema bundle.
type SchemaGlobalA singleton resource represented with the collection schema shape and global capability.
type FieldTypeEvery built-in and plugin field discriminator understood by the manifest.
type FieldCategoryThe structural category used by schema-driven consumers.
type SchemaFieldConditionA manifest-safe recursive expression controlling admin visibility.
type SchemaFieldConditionValueA canonically encoded typed condition operand.
type SchemaDatePickerAppearanceThe admin date/time control mode.
type SchemaPointFieldThe point field’s currently empty type-specific manifest.
type SchemaUIFieldThe presentation-only UI field’s currently empty type-specific manifest.
type SchemaValueTypeThe generated value category of a virtual field.
type SchemaReferenceDeleteActionThe behavior when a referenced target is permanently deleted.
Functions 4
isValidationIssue()Guard an unknown value as a validation issue.
isErrorEnvelope()Guard an unknown value as a complete error envelope.
errorPayload()Return the payload inside a validated error envelope.
isPageEnvelope()Guard an unknown value as a page envelope.
Interfaces 91
interface ValidationIssueinterface ErrorPayloadinterface ErrorEnvelopeinterface Paginationinterface PageEnvelopeinterface DocumentEnvelopeinterface CountEnvelopeinterface BulkEnvelopeinterface DeleteEnvelopeinterface JoinMutationInputinterface JoinMutationEnvelopeinterface PreferenceEnvelopeinterface OperationCapabilitiesinterface FieldCapabilitiesinterface AccessCapabilitiesEnvelopeinterface CollectionSelectionInputinterface CollectionSelectionIteminterface CollectionSelectionEnvelopeinterface DocumentLockinterface DocumentLockEnvelopeinterface AuthSessioninterface AuthSessionInfointerface SessionEnvelopeinterface AuthSessionsEnvelopeinterface LogoutEnvelopeinterface AuthActionEnvelopeinterface AuthBootstrapEnvelopeinterface APIKeyinterface APIKeyInfointerface PreviewTokeninterface ScheduledPublishinterface ScheduledPublishEnvelopeinterface ScheduledPublishesEnvelopeinterface PreviewTokenEnvelopeinterface APIKeyEnvelopeinterface APIKeysEnvelopeinterface SchemaManifestinterface SchemaApplicationinterface SchemaEndpointinterface SchemaAdminLocalizationSettingsinterface SchemaAdminLanguageinterface SchemaAdminTimeZoneinterface SchemaAdminSettingsinterface SchemaLocalizationSettingsinterface SchemaLocaleinterface SchemaPlugininterface SchemaPluginCompatibilityinterface SchemaPluginAdmininterface SchemaPluginFieldTypeinterface SchemaPluginDatabaseContributioninterface SchemaPluginMigrationinterface SchemaPluginEndpointinterface SchemaCollectioninterface SchemaCollectionIndexinterface SchemaDocumentLockSettingsinterface SchemaCollectionLabelsinterface SchemaCapabilitiesinterface SchemaCollectionAdmininterface SchemaLivePreviewinterface SchemaPreviewBreakpointinterface SchemaAuthSettingsinterface SchemaUploadSettingsinterface SchemaImageSizeinterface SchemaVersionSettingsinterface SchemaFieldinterface SchemaFieldAdmininterface SchemaFieldAdminComponentinterface SchemaFieldRowinterface SchemaFieldCollapsibleinterface SchemaFieldTabGroupinterface SchemaFieldConditionPredicateinterface SchemaTextFieldinterface SchemaSlugFieldinterface SchemaCodeFieldinterface SchemaNumberFieldinterface SchemaDateFieldinterface SchemaJoinFieldinterface SchemaVirtualFieldinterface SchemaSelectFieldinterface SchemaSelectChoiceinterface SchemaRelationshipFieldinterface SchemaRelationshipFilterinterface SchemaRelationshipFilterValueinterface SchemaRelationshipTargetinterface SchemaUploadFieldinterface SchemaNestedFieldinterface SchemaArrayRowLabelsinterface SchemaBlocksFieldinterface SchemaBlockTypeinterface SchemaPluginFieldinterface SchemaEnvelope