interface
RiduClient
interface RiduClient<Config extends RiduConfigShape = DefaultRiduConfig> { ... }The complete typed REST client for schema, auth, access, content, uploads, versions, globals, preview, and preferences.
Source packages/sdk/src/index.ts:60
schema(options?: RequestOptions) => Promise<SchemaManifest>- The schema value.
request(path: string, init?: RequestInit, options?: RequestOptions) => Promise<Response>- The request value.
requestPlugin<Result = unknown>(plugin: string, path: string, body: unknown, options?: RequestOptions) => Promise<Result>- The requestPlugin value.
login<Slug extends AuthCollectionSlug<Config>>(collection: Slug, credentials: LoginCredentials, options?: RequestOptions) => Promise<AuthSession<OutputFor<Config, Slug>>>- The login value.
session(options?: RequestOptions) => Promise<AuthSession<AuthUser<Config>>>- The session value.
refreshSession(options?: RequestOptions) => Promise<AuthSession<AuthUser<Config>>>- The refreshSession value.
logout(options?: RequestOptions) => Promise<LogoutEnvelope>- The logout value.
logoutAll(options?: RequestOptions) => Promise<LogoutEnvelope>- The logoutAll value.
sessions(options?: RequestOptions) => Promise<AuthSessionInfo[]>- The sessions value.
revokeSession(id: string, options?: RequestOptions) => Promise<DeleteEnvelope>- The revokeSession value.
requestPasswordReset<Slug extends AuthCollectionSlug<Config>>(collection: Slug, email: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The requestPasswordReset value.
resetPassword<Slug extends AuthCollectionSlug<Config>>(collection: Slug, token: string, password: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The resetPassword value.
authBootstrap<Slug extends AuthCollectionSlug<Config>>(collection: Slug, options?: RequestOptions) => Promise<AuthBootstrapEnvelope>- The authBootstrap value.
createAuthUser<Slug extends AuthCollectionSlug<Config>>(collection: Slug, data: CreateFor<Config, Slug>, password: string, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The createAuthUser value.
requestVerification<Slug extends AuthCollectionSlug<Config>>(collection: Slug, email: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The requestVerification value.
verifyEmail<Slug extends AuthCollectionSlug<Config>>(collection: Slug, token: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The verifyEmail value.
changePassword(currentPassword: string, password: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The changePassword value.
createAPIKey(input: CreateAPIKeyInput, options?: RequestOptions) => Promise<APIKey>- The createAPIKey value.
apiKeys(options?: RequestOptions) => Promise<APIKeyInfo[]>- The apiKeys value.
revokeAPIKey(id: string, options?: RequestOptions) => Promise<DeleteEnvelope>- The revokeAPIKey value.
forceUnlock<Slug extends AuthCollectionSlug<Config>>(collection: Slug, id: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The forceUnlock value.
preference<Value = unknown>(key: string, options?: RequestOptions) => Promise<Value>- The preference value.
setPreference<Value>(key: string, value: Value, options?: RequestOptions) => Promise<Value>- The setPreference value.
deletePreference(key: string, options?: RequestOptions) => Promise<DeleteEnvelope>- The deletePreference value.
resetPreferences(options?: RequestOptions) => Promise<AuthActionEnvelope>- The resetPreferences value.
collectionAccess<Slug extends CollectionSlug<Config>>(collection: Slug, options?: CollectionAccessOptions<CreateFor<Config, Slug> & UpdateFor<Config, Slug>, LocaleFor<Config>>) => Promise<AccessCapabilitiesEnvelope>- The collectionAccess value.
resolveFilteredSelection<Slug extends CollectionSlug<Config>>(collection: Slug, options?: CollectionSelectionOptions<WhereFor<Config, Slug>, LocaleFor<Config>>) => Promise<CollectionSelectionEnvelope>- The resolveFilteredSelection value.
documentLock<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, options?: RequestOptions) => Promise<DocumentLockEnvelope>- The documentLock value.
acquireDocumentLock<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, takeover?: boolean, options?: RequestOptions) => Promise<DocumentLockEnvelope>- The acquireDocumentLock value.
releaseDocumentLock<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, options?: RequestOptions) => Promise<DeleteEnvelope>- The releaseDocumentLock value.
globalAccess<Slug extends GlobalSlug<Config>>(slug: Slug, options?: GlobalAccessOptions<GlobalUpdateFor<Config, Slug>, LocaleFor<Config>>) => Promise<AccessCapabilitiesEnvelope>- The globalAccess value.
createPreviewToken<Slug extends DraftCollectionSlug<Config>>(collection: Slug, id: string, options?: RequestOptions) => Promise<PreviewToken>- The createPreviewToken value.
revokePreviewToken(token: string, options?: RequestOptions) => Promise<AuthActionEnvelope>- The revokePreviewToken value.
preview<Slug extends DraftCollectionSlug<Config>>(collection: Slug, id: string, token: string, options?: RequestOptions) => Promise<OutputFor<Config, Slug>>- The preview value.
createGlobalPreviewToken<Slug extends DraftGlobalSlug<Config>>(slug: Slug, options?: RequestOptions) => Promise<PreviewToken>- The createGlobalPreviewToken value.
previewGlobal<Slug extends DraftGlobalSlug<Config>>(slug: Slug, token: string, options?: RequestOptions) => Promise<GlobalOutputFor<Config, Slug>>- The previewGlobal value.
list<Slug extends CollectionSlug<Config>, const Options extends ListOptions<WhereFor<Config, Slug>, SelectFor<Config, Slug>, PopulateFor<Config, Slug>, LocaleFor<Config>> | undefined = undefined>(collection: Slug, options?: Options) => Promise<PageEnvelope<CollectionQueryResult<Config, Slug, Options>>>- The list value.
count<Slug extends CollectionSlug<Config>>(collection: Slug, options?: Pick<ListOptions<WhereFor<Config, Slug>, never, never, LocaleFor<Config>>, "where" | "trash" | "locale" | "fallbackLocale" | "signal" | "headers">) => Promise<CountEnvelope>- The count value.
find<Slug extends CollectionSlug<Config>, const Options extends FindOptions<SelectFor<Config, Slug>, PopulateFor<Config, Slug>, LocaleFor<Config>> | undefined = undefined>(collection: Slug, id: string, options?: Options) => Promise<CollectionQueryResult<Config, Slug, Options>>- The find value.
create<Slug extends CollectionSlug<Config>>(collection: Slug, data: CreateFor<Config, Slug>, options?: CreateOptions<LocaleFor<Config>, CollectionVersionsFor<Config, Slug>, CollectionDraftsFor<Config, Slug>>) => Promise<OutputFor<Config, Slug>>- The create value.
duplicate<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, overrides?: Partial<Omit<CreateFor<Config, Slug>, "id">>, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The duplicate value.
copyLocale<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, input: CopyLocaleInput<LocaleFor<Config>>, options?: RevisionOptions) => Promise<OutputFor<Config, Slug>>- The copyLocale value.
update<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, data: UpdateFor<Config, Slug>, options?: MutationOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The update value.
mutateJoin<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, field: string, input: JoinMutationInput, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<JoinMutationEnvelope<OutputFor<Config, Slug>>>- The mutateJoin value.
delete<Slug extends CollectionSlug<Config>>(collection: Slug, id: string, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<DeleteEnvelope>- The delete value.
bulkUpdate<Slug extends CollectionSlug<Config>>(collection: Slug, ids: readonly string[], data: UpdateFor<Config, Slug>, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The bulkUpdate value.
bulkPublish<Slug extends VersionCollectionSlug<Config>>(collection: Slug, ids: readonly string[], options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The bulkPublish value.
bulkUnpublish<Slug extends DraftCollectionSlug<Config>>(collection: Slug, ids: readonly string[], options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The bulkUnpublish value.
bulkDelete<Slug extends CollectionSlug<Config>>(collection: Slug, ids: readonly string[], options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The bulkDelete value.
bulkRestoreDeleted<Slug extends TrashCollectionSlug<Config>>(collection: Slug, ids: readonly string[], options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The bulkRestoreDeleted value.
bulkDeletePermanent<Slug extends TrashCollectionSlug<Config>>(collection: Slug, ids: readonly string[], options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The bulkDeletePermanent value.
emptyTrash<Slug extends TrashCollectionSlug<Config>>(collection: Slug, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>[]>- The emptyTrash value.
restoreDeleted<Slug extends TrashCollectionSlug<Config>>(collection: Slug, id: string, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The restoreDeleted value.
deletePermanent<Slug extends TrashCollectionSlug<Config>>(collection: Slug, id: string, options?: MutationLocaleOptions<LocaleFor<Config>>) => Promise<DeleteEnvelope>- The deletePermanent value.
upload<Slug extends UploadCollectionSlug<Config>>(collection: Slug, file: Blob, options?: UploadOptions<CreateFor<Config, Slug>, LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The upload value.
uploadFromURL<Slug extends UploadCollectionSlug<Config>>(collection: Slug, url: string, options?: UploadOptions<CreateFor<Config, Slug>, LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The uploadFromURL value.
updateUploadImage<Slug extends UploadCollectionSlug<Config>>(collection: Slug, id: string, input: UploadImageInput, options?: RevisionOptions) => Promise<OutputFor<Config, Slug>>- The updateUploadImage value.
versions<Slug extends VersionCollectionSlug<Config>, const Options extends LocaleOptions<LocaleFor<Config>> | undefined = undefined>(collection: Slug, id: string, options?: Options) => Promise<Version<LocaleResult<OutputFor<Config, Slug>, AllLocalesOutputFor<Config, Slug>, Options>>[]>- The versions value.
version<Slug extends VersionCollectionSlug<Config>, const Options extends LocaleOptions<LocaleFor<Config>> | undefined = undefined>(collection: Slug, id: string, revision: number, options?: Options) => Promise<Version<LocaleResult<OutputFor<Config, Slug>, AllLocalesOutputFor<Config, Slug>, Options>>>- The version value.
schedulePublish<Slug extends VersionCollectionSlug<Config>>(collection: Slug, id: string, runAt: string | Date, options?: RevisionOptions) => Promise<ScheduledPublish>- The schedulePublish value.
scheduledPublishes<Slug extends VersionCollectionSlug<Config>>(collection: Slug, id: string, options?: RequestOptions) => Promise<ScheduledPublish[]>- The scheduledPublishes value.
cancelScheduledPublish<Slug extends VersionCollectionSlug<Config>>(collection: Slug, id: string, jobID: string, options?: RequestOptions) => Promise<DeleteEnvelope>- The cancelScheduledPublish value.
publish<Slug extends VersionCollectionSlug<Config>>(collection: Slug, id: string, options?: MutationOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The publish value.
publishChanges<Slug extends VersionCollectionSlug<Config>>(collection: Slug, id: string, data: UpdateFor<Config, Slug>, options?: MutationOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The publishChanges value.
unpublish<Slug extends DraftCollectionSlug<Config>>(collection: Slug, id: string, options?: MutationOptions<LocaleFor<Config>>) => Promise<OutputFor<Config, Slug>>- The unpublish value.
restore<Slug extends VersionCollectionSlug<Config>>(collection: Slug, id: string, revision: number, options?: RestoreOptions<LocaleFor<Config>, CollectionDraftsFor<Config, Slug>>) => Promise<OutputFor<Config, Slug>>- The restore value.
global<Slug extends GlobalSlug<Config>, const Options extends FindOptions<GlobalSelectFor<Config, Slug>, GlobalPopulateFor<Config, Slug>, LocaleFor<Config>> | undefined = undefined>(slug: Slug, options?: Options) => Promise<GlobalQueryResult<Config, Slug, Options>>- The global value.
updateGlobal<Slug extends GlobalSlug<Config>>(slug: Slug, data: GlobalUpdateFor<Config, Slug>, options?: MutationOptions<LocaleFor<Config>>) => Promise<GlobalOutputFor<Config, Slug>>- The updateGlobal value.
copyGlobalLocale<Slug extends GlobalSlug<Config>>(slug: Slug, input: CopyLocaleInput<LocaleFor<Config>>, options?: RevisionOptions) => Promise<GlobalOutputFor<Config, Slug>>- The copyGlobalLocale value.
globalVersions<Slug extends VersionGlobalSlug<Config>, const Options extends LocaleOptions<LocaleFor<Config>> | undefined = undefined>(slug: Slug, options?: Options) => Promise<Version<LocaleResult<GlobalOutputFor<Config, Slug>, GlobalAllLocalesOutputFor<Config, Slug>, Options>>[]>- The globalVersions value.
globalVersion<Slug extends VersionGlobalSlug<Config>, const Options extends LocaleOptions<LocaleFor<Config>> | undefined = undefined>(slug: Slug, revision: number, options?: Options) => Promise<Version<LocaleResult<GlobalOutputFor<Config, Slug>, GlobalAllLocalesOutputFor<Config, Slug>, Options>>>- The globalVersion value.
publishGlobal<Slug extends VersionGlobalSlug<Config>>(slug: Slug, options?: MutationOptions<LocaleFor<Config>>) => Promise<GlobalOutputFor<Config, Slug>>- The publishGlobal value.
publishGlobalChanges<Slug extends VersionGlobalSlug<Config>>(slug: Slug, data: GlobalUpdateFor<Config, Slug>, options?: MutationOptions<LocaleFor<Config>>) => Promise<GlobalOutputFor<Config, Slug>>- The publishGlobalChanges value.
unpublishGlobal<Slug extends DraftGlobalSlug<Config>>(slug: Slug, options?: MutationOptions<LocaleFor<Config>>) => Promise<GlobalOutputFor<Config, Slug>>- The unpublishGlobal value.
restoreGlobal<Slug extends VersionGlobalSlug<Config>>(slug: Slug, revision: number, options?: RestoreOptions<LocaleFor<Config>, GlobalDraftsFor<Config, Slug>>) => Promise<GlobalOutputFor<Config, Slug>>- The restoreGlobal value.
Capability-specific methods only accept generated slugs with the required auth, upload, trash, or version capability.
The SDK validates stable envelopes at runtime; generated document shapes remain TypeScript contracts rather than a second client-side schema validator.
Methods
RiduClient.schema()Read the resolved public schema manifest.
RiduClient.request()Dispatch a raw same-origin request to an application-authored custom endpoint.
RiduClient.requestPlugin()POST to one declared namespaced plugin endpoint through the configured SDK transport.
RiduClient.preference()Read one preference for the authenticated identity.
RiduClient.setPreference()Create or replace one preference.
RiduClient.deletePreference()Delete one preference.
RiduClient.resetPreferences()Delete every preference for the authenticated identity.
RiduClient.login()Authenticate against an auth-enabled collection.
RiduClient.session()Read and validate the current session.
RiduClient.refreshSession()Rotate the current session.
RiduClient.logout()End the current session.
RiduClient.logoutAll()End every session owned by the current user.
RiduClient.sessions()List the current user’s active sessions.
RiduClient.revokeSession()Revoke one owned session by ID.
RiduClient.requestPasswordReset()Request a password-reset token through the configured delivery hook.
RiduClient.resetPassword()Consume a password-reset token.
RiduClient.authBootstrap()Check whether the configured admin collection still allows one-time first-user setup.
RiduClient.createAuthUser()Create an auth user and credential together.
RiduClient.requestVerification()Request an email-verification token through the configured delivery hook.
RiduClient.verifyEmail()Consume an email-verification token.
RiduClient.changePassword()Change the current user’s password.
RiduClient.createAPIKey()Create an API key; its secret is returned only once.
RiduClient.apiKeys()List API-key metadata without secrets.
RiduClient.revokeAPIKey()Revoke one API key.
RiduClient.forceUnlock()Clear lockout state for an auth user when authorized.
RiduClient.collectionAccess()Evaluate operation and field capabilities for a prospective collection operation.
RiduClient.resolveFilteredSelection()Resolve a filter to authorized IDs and per-document capabilities.
RiduClient.globalAccess()Evaluate operation and field capabilities for a global.
RiduClient.documentLock()Read the current document-lock lease.
RiduClient.acquireDocumentLock()Acquire or renew a document lock, optionally taking over an eligible lease.
RiduClient.releaseDocumentLock()Release a document lock owned by the current user.
RiduClient.list()List authorized collection documents with locale-, projection-, and population-dependent results.
RiduClient.count()Count authorized documents matching a typed filter.
RiduClient.find()Find one authorized document with a locale-, projection-, and population-dependent result.
RiduClient.create()Create one collection document with capability-checked draft intent.
RiduClient.duplicate()Duplicate a document with optional typed create-field overrides.
RiduClient.copyLocale()Copy localized values between locales on one document; from and to define the locale scope.
RiduClient.update()Update one document, optionally guarded by its revision.
RiduClient.mutateJoin()Atomically add and remove IDs through a join field.
RiduClient.delete()Delete or trash one document according to collection capabilities.
RiduClient.bulkUpdate()Update an explicit set of document IDs.
RiduClient.bulkPublish()Publish an explicit set of versioned documents.
RiduClient.bulkUnpublish()Unpublish an explicit set of draft-enabled documents.
RiduClient.bulkDelete()Delete or trash an explicit set of document IDs.
RiduClient.bulkRestoreDeleted()Restore an explicit set of trashed document IDs.
RiduClient.bulkDeletePermanent()Permanently delete an explicit set of trashed document IDs.
RiduClient.emptyTrash()Permanently delete every authorized trashed document in a collection.
RiduClient.restoreDeleted()Restore one trashed document.
RiduClient.deletePermanent()Permanently delete one trashed document and its retained state.
RiduClient.upload()Upload a Blob with optional typed metadata.
RiduClient.uploadFromURL()Ask the server to ingest a remote URL with optional typed metadata.
RiduClient.updateUploadImage()Update non-localized focal/crop metadata and regenerate configured image sizes.
RiduClient.versions()List stored versions with locale-dependent snapshot types.
RiduClient.version()Read one stored revision with a locale-dependent snapshot type.
RiduClient.schedulePublish()Schedule a versioned document for publication with an optional revision fence.
RiduClient.scheduledPublishes()List scheduled publication jobs for one document.
RiduClient.cancelScheduledPublish()Cancel one scheduled publication job.
RiduClient.publish()Publish the current version of a document.
RiduClient.publishChanges()Atomically apply edited values and publish through publish access and hooks.
RiduClient.unpublish()Return a published draft-enabled document to draft.
RiduClient.restore()Restore a historical revision, optionally as a draft.
RiduClient.global()Read one global with a locale-, projection-, and population-dependent result.
RiduClient.updateGlobal()Update a global, optionally guarded by its revision.
RiduClient.copyGlobalLocale()Copy localized values between locales on a global; from and to define the locale scope.
RiduClient.globalVersions()List stored versions for a versioned global with locale-dependent snapshot types.
RiduClient.globalVersion()Read one stored global revision with a locale-dependent snapshot type.
RiduClient.publishGlobal()Publish a versioned global.
RiduClient.publishGlobalChanges()Atomically apply edited singleton values and publish through global publish access and hooks.
RiduClient.unpublishGlobal()Return a draft-enabled global to draft.
RiduClient.restoreGlobal()Restore a historical global revision, optionally as a draft.
RiduClient.createPreviewToken()Create a short-lived preview token for a draft-enabled collection document.
RiduClient.revokePreviewToken()Revoke a preview token before it expires.
RiduClient.preview()Read preview data using a scoped token.
RiduClient.createGlobalPreviewToken()Create a short-lived preview token for a draft-enabled global.
RiduClient.previewGlobal()Read global preview data using a scoped token.