Module
@riducms/sdk
@riducms/sdk — The generated-contract-aware Fetch client for browser and server applications.
Functions 11
createClient()Create a typed client from a Ridu base URL and transport options.
memoryTokenStore()Hold a token-transport session in memory, for scripts, tests, and server processes that act as one user. It follows the store contract: a late event for a replaced token is ignored.
connectLivePreview()Connect a frontend preview window or iframe to authenticated admin updates.
convertLexicalToPlaintext()A document's text without formatting, for previews, search, notifications or a language model. Blocks are separated by a blank line, list items are on their own lines, and a line break is a newline. Pure and synchronous, like `renderRichTextHTML`.
documentRecoveryIssue()Return the first unsupported envelope path without interpreting schema-owned payloads. Both editor admission and portable rendering use this lossless JSON boundary.
escapeRichText()Public function escapeRichText from @riducms/sdk.
renderRichTextHTML()Pure synchronous rendering: no editor bundle, DOM, Svelte dependency or network requests.
renderRichTextText()Public function renderRichTextText from @riducms/sdk.
richTextElementTag()Public function richTextElementTag from @riducms/sdk.
safeRichTextURL()Public function safeRichTextURL from @riducms/sdk.
createAdminLoader()Bind authored runtime behavior to a Go-derived contract. Only generated code should call this; application code consumes the resulting typed reference.
Classes 1
class RiduErrorA structured SDK failure with an error code, HTTP status, request ID, validation issues, and details.
Collections 13
Globals 9
Authentication 18
RiduAuth.login()RiduAuth.getSession()RiduAuth.rotate()RiduAuth.logout()RiduAuth.logoutAll()RiduAuth.sessions()RiduAuth.revokeSession()RiduAuth.requestPasswordReset()RiduAuth.resetPassword()RiduAuth.bootstrap()RiduAuth.createUser()RiduAuth.requestVerification()RiduAuth.verifyEmail()RiduAuth.changePassword()RiduAuth.createAPIKey()RiduAuth.apiKeys()RiduAuth.revokeAPIKey()RiduAuth.forceUnlock()
Uploads 3
Versions and publishing 9
Trash 5
Schema and preferences 5
Custom endpoints 1
Access and locks 6
Live preview 5
Plugins 1
Interfaces 41
interface RiduClientinterface ClientOptionsinterface RequestOptionsinterface LocaleOptionsinterface MutationLocaleOptionsinterface MutationOptionsinterface RevisionOptionsinterface ListOptionsinterface FindOptionsinterface UploadOptionsinterface UpdateUploadInputinterface UploadFileinterface Versioninterface CollectionContractinterface GlobalContractinterface RiduConfigShapeinterface LoginCredentialsinterface AuthOptionsinterface SessionTokenStoreinterface UploadURLinterface UploadURLOptionsinterface CopyLocaleInputinterface CollectionSelectionOptionsinterface RiduAuthinterface LivePreviewTargetinterface LivePreviewConnectioninterface RiduLivePreviewReadyMessageinterface RiduLivePreviewUpdateMessageinterface RichTextDocumentinterface RichTextElementNodeinterface RichTextPlaintextOptionsinterface RichTextReferenceNodeinterface RichTextRenderOptionsinterface RichTextRootNodeinterface RichTextTextNodeinterface AdminLoaderinterface AuthSessioninterface AuthSessionInfointerface LiveValidationOptionsinterface PublicationScheduleOptionsinterface UploadImageEdit
Types 42
type CreateOptionstype RestoreOptionstype CollectionSlugtype GlobalSlugtype GlobalContractFortype AuthCollectionSlugtype UploadCollectionSlugtype VersionCollectionSlugtype DraftCollectionSlugtype VersionGlobalSlugtype DraftGlobalSlugtype OutputFortype AllLocalesOutputFortype CreateFortype UpdateFortype WhereFortype SelectFortype PopulateFortype GlobalOutputFortype GlobalAllLocalesOutputFortype GlobalUpdateFortype GlobalSelectFortype GlobalPopulateFortype AuthUsertype LoginInputtype AuthCollectionInputtype SessionFortype SessionCollectioninterface JoinMutationInputinterface ScheduledPublicationtype Middlewaretype MiddlewareNexttype Live preview constantstype RichTextBlockNodetype RichTextBlockRendererstype RichTextDocumentInputtype RichTextElementFormattype RichTextNodetype DraftCreateFortype DraftUpdateFortype GlobalDraftUpdateFortype UpdateOptions
Methods 20
RiduClient.getUploadURL()RiduClient.getUploadURLs()RiduClient.readUploadSource()RiduClient.previewUploadFromURL()ClientOptions.fetch()LivePreviewConnection.disconnect()LivePreviewConnection.ready()RichTextRenderOptions.fallback()AdminLoader.decode()AdminLoader.query()RiduClient.adminCollectionList()RiduClient.adminLoad()RiduClient.countGlobalVersions()RiduClient.countVersions()RiduClient.discardDraft()RiduClient.discardGlobalDraft()RiduClient.scheduleUnpublish()SessionTokenStore.cleared()SessionTokenStore.issued()SessionTokenStore.verified()
Constants 3
constant RIDU_LIVE_PREVIEW_CHANNEL_PARAMPublic constant RIDU_LIVE_PREVIEW_CHANNEL_PARAM from @riducms/sdk.
constant RIDU_LIVE_PREVIEW_MESSAGEPublic constant RIDU_LIVE_PREVIEW_MESSAGE from @riducms/sdk.
constant RIDU_PREVIEW_TOKEN_PARAMPublic constant RIDU_PREVIEW_TOKEN_PARAM from @riducms/sdk.