AFFiNE-Mirror/packages/backend/native/index.d.ts

/* auto-generated by NAPI-RS */
/* eslint-disable */

declare const _default: typeof import('./index')
export default _default

export declare class BackendRuntime {
  acquireCoordinationLease(key: string, owner: string, ttlMs: number): Promise<CoordinationLeaseGrant | null>
  releaseCoordinationLease(key: string, owner: string, fencingToken: bigint | number): Promise<boolean>
  renewCoordinationLease(key: string, owner: string, fencingToken: bigint | number, ttlMs: number): Promise<boolean>
  executeCopilotStream(input: CopilotExecuteInput, maxSteps: number, callback: ((err: Error | null, arg: string) => void), toolCallback: ((err: Error | null, arg: string) => Promise<string>)): Promise<CopilotStreamHandle>
  executeCopilot(input: CopilotExecuteInput): Promise<string>
  assertCopilotRoute(input: CopilotRouteCheckInput): Promise<void>
  /**
   * Merge pending doc updates with y-octo and persist the merged snapshot.
   *
   * Do not use this for snapshots that will be sent back to yjs clients until
   * the y-octo/yjs round-trip compatibility issue is resolved.
   *
   * The caller owns quota reconciliation and must pass a fresh
   * history_max_age_seconds value. The compactor intentionally does not read
   * effective_workspace_quota_states; if a future caller cannot provide a
   * fresh quota state, fail and retry after Node reconciles it.
   */
  compactPendingDocUpdates(workspaceId: string, docId: string, batchLimit: number, historyMinIntervalMs: number, historyMaxAgeSeconds: number, owner: string, leaseTtlMs: number): Promise<RuntimeDocCompactionResult>
  upsertDocSnapshot(workspaceId: string, docId: string, blob: Buffer, timestampMs: number, editorId?: string | undefined | null): Promise<boolean>
  createDocHistory(input: RuntimeDocHistoryInput): Promise<boolean>
  putRuntimeGateIfAbsent(key: string, ttlMs: number): Promise<boolean>
  cleanupExpiredRuntimeGates(limit: number): Promise<number>
  cleanupExpiredUserSessions(limit: number): Promise<number>
  cleanupExpiredSnapshotHistories(limit: number): Promise<number>
  isInviteAbuseUserQuarantinedOrBanned(userId: string): Promise<boolean>
  isInviteAbuseWorkspaceQuarantined(workspaceId: string): Promise<boolean>
  claimInviteAbuseAction(actionId: string, workerId: string): Promise<boolean>
  claimRetryableInviteAbuseActions(workerId: string, limit: number): Promise<Array<RuntimeInviteAbuseClaimedAction>>
  markInviteAbuseAction(actionId: string, workerId: string, status: string, error?: string | undefined | null): Promise<boolean>
  assertWorkspaceInviteQuotaV1(input: RuntimeWorkspaceInviteQuotaInput): Promise<RuntimeWorkspaceInviteQuotaDecision>
  commitWorkspaceInviteQuotaV1(reservationId: string, usage: RuntimeWorkspaceInviteQuotaUsage): Promise<boolean>
  releaseWorkspaceInviteQuotaV1(reservationId: string): Promise<boolean>
  assertMailDeliveryQuotaV1(input: RuntimeMailDeliveryQuotaInput): Promise<RuntimeMailDeliveryQuotaDecision>
  commitMailDeliveryQuotaV1(reservationId: string): Promise<boolean>
  releaseMailDeliveryQuotaV1(reservationId: string): Promise<boolean>
  cleanupExpiredRollingQuota(limit: number): Promise<number>
  createAuthChallenge(purpose: string, token: string, payload: any, ttlMs: number): Promise<boolean>
  getAuthChallenge(purpose: string, token: string): Promise<any | null>
  consumeAuthChallenge(purpose: string, token: string): Promise<any | null>
  createVerificationToken(tokenType: number, credential: string | undefined | null, ttlMs: number): Promise<string>
  getVerificationToken(tokenType: number, token: string, keep?: boolean | undefined | null): Promise<RuntimeVerificationTokenRecord | null>
  verifyVerificationToken(tokenType: number, token: string, credential?: string | undefined | null, keep?: boolean | undefined | null): Promise<RuntimeVerificationTokenRecord | null>
  cleanupExpiredVerificationTokens(limit: number): Promise<number>
  upsertMagicLinkOtp(email: string, otpHash: string, token: string, clientNonce: string | undefined | null, ttlMs: number): Promise<void>
  consumeMagicLinkOtp(email: string, otpHash: string, clientNonce?: string | undefined | null): Promise<RuntimeMagicLinkOtpConsumeResult>
  createWorkspaceInviteLink(workspaceId: string, inviteId: string, inviterUserId: string, ttlMs: number): Promise<RuntimeWorkspaceInviteLinkRecord>
  getWorkspaceInviteLink(workspaceId: string): Promise<RuntimeWorkspaceInviteLinkRecord | null>
  getWorkspaceInviteLinkById(inviteId: string): Promise<RuntimeWorkspaceInviteLinkRecord | null>
  revokeWorkspaceInviteLink(workspaceId: string): Promise<boolean>
  cleanupExpiredRuntimeStates(limit: number): Promise<number>
  refreshWorkspaceAdminStatsDirty(batchLimit: number, owner: string, leaseTtlMs: number): Promise<RuntimeWorkspaceStatsRefreshResult>
  recalibrateWorkspaceAdminStats(lastSid: number, batchLimit: number, owner: string, leaseTtlMs: number): Promise<RuntimeWorkspaceStatsRecalibrationResult>
  writeWorkspaceAdminStatsDailySnapshot(owner: string, leaseTtlMs: number): Promise<RuntimeWorkspaceStatsSnapshotResult>
  recalibrateWorkspaceAdminStatsDaily(batchLimit: number, owner: string, leaseTtlMs: number, lockRetryTimes: number, lockRetryDelayMs: number): Promise<RuntimeWorkspaceStatsDailyRecalibrationResult>
  constructor(privateKey?: string | undefined | null)
  start(): Promise<void>
  stop(): Promise<void>
  reloadConfig(privateKey?: string | undefined | null): Promise<void>
  health(): Promise<BackendRuntimeHealth>
  runMigrations(): Promise<void>
  listByokProfiles(workspaceId: string): Promise<Array<ByokProfileOutput>>
  createByokProfile(input: CreateByokProfileInput): Promise<ByokProfileOutput>
  replaceByokProfile(input: ReplaceByokProfileInput): Promise<ByokProfileOutput>
  rotateByokCredential(input: RotateByokCredentialInput): Promise<ByokProfileOutput>
  probeByokProfile(input: ProbeByokProfileInput): Promise<ByokProbeResultOutput>
  probeByokDraft(input: ProbeByokDraftInput): Promise<ByokProbeResultOutput>
  deleteByokProfile(workspaceId: string, profileId: string): Promise<boolean>
  reorderByokProfiles(input: ReorderByokProfilesInput): Promise<Array<ByokProfileOutput>>
  createByokLocalLease(input: CreateByokLocalLeaseInput): Promise<ByokLocalLeaseOutput>
}

export declare class CopilotStreamHandle {
  abort(): void
}

export declare class StorageRuntime {
  planUnreferencedWorkspaceBlobs(workspaceId: string, gracePeriodDays: number, limit: number): Promise<RuntimeBlobCleanupPlanResult>
  executeBlobCleanupCandidates(runId: string, gracePeriodDays: number, limit: number): Promise<RuntimeBlobCleanupExecuteResult>
  cleanupExpiredPendingBlobs(cutoffMs: number, limit: number): Promise<RuntimeBlobCleanupResult>
  releaseDeletedBlobs(workspaceId: string, limit: number): Promise<RuntimeBlobCleanupResult>
  backfillMissingBlobMetadata(workspaceId: string | undefined | null, limit: number): Promise<RuntimeBlobMetadataBackfillResult>
  rebuildDocBlobRefs(workspaceId: string, docId: string): Promise<RuntimeDocBlobRefsResult>
  rebuildWorkspaceDocBlobRefs(workspaceId: string, limit: number): Promise<RuntimeDocBlobRefsResult>
  reconcileWorkspaceDocuments(workspaceId: string): Promise<RuntimeDocumentCleanupReconcileResult>
  executeDocumentCleanupCandidates(workspaceId: string | undefined | null, gracePeriodDays: number, limit: number): Promise<RuntimeDocumentCleanupExecuteResult>
  ackDocumentCleanupEffect(workspaceId: string, docId: string, cleanupVersion: string, effect: string): Promise<RuntimeDocumentCleanupAckResult>
  constructor()
  start(): Promise<void>
  configure(configJson: string): void
  stop(): Promise<void>
  runMigrations(): Promise<void>
  health(): Promise<StorageRuntimeHealth>
  providerCapabilities(scope: string): Promise<StorageProviderCapabilities>
  putObject(scope: string, key: string, body: Buffer, metadata?: RuntimeObjectStoragePutOptions | undefined | null): Promise<RuntimeObjectMetadata>
  headObject(scope: string, key: string): Promise<RuntimeObjectMetadata | null>
  getObject(scope: string, key: string): Promise<RuntimeObjectGetResult | null>
  listObjects(scope: string, prefix?: string | undefined | null): Promise<Array<RuntimeObjectListEntry>>
  deleteObject(scope: string, key: string): Promise<void>
  presignPut(scope: string, key: string, metadata?: RuntimeObjectStoragePutOptions | undefined | null): Promise<RuntimePresignedObjectRequest | null>
  presignGet(scope: string, key: string): Promise<RuntimePresignedObjectRequest | null>
  createMultipartUpload(scope: string, key: string, metadata?: RuntimeObjectStoragePutOptions | undefined | null): Promise<RuntimeMultipartUploadInit | null>
  presignUploadPart(scope: string, key: string, uploadId: string, partNumber: number): Promise<RuntimePresignedObjectRequest | null>
  proxyUploadPart(scope: string, key: string, uploadId: string, partNumber: number, body: Buffer, contentLength?: number | undefined | null): Promise<string | null>
  listMultipartUploadParts(scope: string, key: string, uploadId: string): Promise<Array<RuntimeMultipartUploadPart> | null>
  completeMultipartUpload(scope: string, key: string, uploadId: string, parts: Array<RuntimeMultipartUploadPart>): Promise<boolean>
  abortMultipartUpload(scope: string, key: string, uploadId: string): Promise<boolean>
  completeWorkspaceBlobUpload(workspaceId: string, key: string, expectedSize: number, expectedMime: string): Promise<RuntimeBlobCompleteResult>
}

export declare class Tokenizer {
  count(content: string, allowedSpecial?: Array<string> | undefined | null): number
}

export declare function activateLicense(request: LicenseKeyRequest): Promise<LicenseResponse>

/**
 * Adds a document ID to the workspace root doc's meta.pages array.
 * This registers the document in the workspace so it appears in the UI.
 *
 * # Arguments
 * * `root_doc_bin` - The current root doc binary (workspaceId doc)
 * * `doc_id` - The document ID to add
 * * `title` - Optional title for the document
 *
 * # Returns
 * A Buffer containing the y-octo update binary to apply to the root doc
 */
export declare function addDocToRootDoc(rootDocBin: Buffer, docId: string, title?: string | undefined | null): Buffer

export const AFFINE_PRO_LICENSE_AES_KEY: string | undefined | null

export const AFFINE_PRO_PUBLIC_KEY: string | undefined | null

export declare function assertSafeUrl(request: AssertSafeUrlRequest): void

export interface AssertSafeUrlRequest {
  url: string
}

export declare function authSessionAccessTokenKeyId(token: string): string | null

export interface AuthSessionAccessTokenVerification {
  status: string
  userId?: string
  authSessionId?: string
}

export interface AuthSessionRefreshToken {
  token: string
  id: string
  secretHash: string
}

export interface BackendRuntimeHealth {
  started: boolean
  databaseConnected: boolean
}

export declare function buildPublicRootDoc(rootDocBin: Buffer, docMetas: Array<PublicDocMetaInput>): Buffer

export interface BuiltInManagedTarget {
  id: string
  displayName: string
  minimumTier: BuiltInManagedTargetTier
}

export type BuiltInManagedTargetTier =  'Standard'|
'Premium';

export interface BuiltInPromptRenderContract {
  name: string
  renderParams: Record<string, any>
}

export interface BuiltInPromptSessionContract {
  name: string
  turns: Array<PromptMessageContract>
  renderParams: Record<string, any>
}

export interface BuiltInPromptSpec {
  name: string
  action?: string
  config?: any
  params?: Record<string, PromptParamSpec>
  builtins?: Array<PromptBuiltin>
  messages: Array<PromptSpecMessage>
}

export interface BuiltInRouteOptions {
  routeId: string
  standardDefaultTargetId?: string
  premiumDefaultTargetId?: string
  choices: Array<BuiltInManagedTarget>
}

export interface ByokCapabilityInput {
  input: Array<string>
  output: Array<string>
  features: Array<string>
  attachmentKinds: Array<string>
  attachmentSources: Array<string>
}

export interface ByokCatalogModelOutput {
  modelId: string
  displayName: string
  recommended: boolean
  capabilities: Array<ByokCapabilityInput>
}

export interface ByokCatalogOutput {
  version: string
  providers: Array<ByokCatalogProviderOutput>
}

export interface ByokCatalogProviderOutput {
  provider: string
  models: Array<ByokCatalogModelOutput>
}

export interface ByokEndpointInput {
  kind: string
  url?: string
}

export interface ByokLocalLeaseOutput {
  leaseId: string
  expiresAtMs: number
}

export interface ByokModelDeclarationInput {
  modelId: string
  enabled: boolean
  capabilities: Array<ByokCapabilityInput>
}

export interface ByokModelProbeCheckOutput {
  operation: string
  status: ByokProbeStatusOutput
}

export interface ByokModelProbeOutput {
  modelId: string
  checks: Array<ByokModelProbeCheckOutput>
}

export interface ByokProbeCheckInput {
  modelId: string
  operation: string
}

export interface ByokProbeResultOutput {
  definitionFingerprint: string
  stale: boolean
  connection: ByokProbeStatusOutput
  models: Array<ByokModelProbeOutput>
}

export interface ByokProbeStatusOutput {
  kind: string
  testedAtMs?: number
  errorKind?: string
}

export interface ByokProfileDefinitionInput {
  version: number
  endpoint: ByokEndpointInput
  models: Array<ByokModelDeclarationInput>
}

export interface ByokProfileOrderInput {
  profileId: string
  expectedRevision: number
}

export interface ByokProfileOutput {
  profileId: string
  workspaceId: string
  provider: string
  name: string
  description?: string
  definition: ByokProfileDefinitionInput
  enabled: boolean
  sortOrder: number
  revision: number
  validation?: ByokValidationOutput
}

export interface ByokValidationOutput {
  definitionFingerprint: string
  credentialGeneration: number
  connection: ByokProbeStatusOutput
  models: Array<ByokModelProbeOutput>
}

export interface CanonicalChatRequestContract {
  model: string
  messages: Array<PromptMessageContract>
  maxTokens?: number
  temperature?: number
  tools?: Array<ToolContract>
  include?: Array<string>
  reasoning?: any
  responseSchema?: any
  attachmentCapability?: CapabilityAttachmentContract
  middleware?: any
}

export interface CanonicalStructuredRequestContract {
  model: string
  messages: Array<PromptMessageContract>
  schema?: any
  maxTokens?: number
  temperature?: number
  reasoning?: any
  strict?: boolean
  responseMimeType?: string
  attachmentCapability?: CapabilityAttachmentContract
  middleware?: any
}

export interface CapabilityAttachmentContract {
  kinds: Array<'image' | 'audio' | 'file'>
  sourceKinds?: Array<'url' | 'data' | 'bytes' | 'file_handle'>
  allowRemoteUrls?: boolean
}

export interface CapabilityMatchRequest {
  models: Array<CapabilityModelContract>
  cond: ModelConditionsContract
}

export interface CapabilityMatchResponse {
  modelId?: string
}

export interface CapabilityModelCapability {
  input: Array<'text' | 'image' | 'audio' | 'file'>
  output: Array<'text' | 'image' | 'object' | 'structured' | 'embedding' | 'rerank'>
  attachments?: CapabilityAttachmentContract
  structuredAttachments?: CapabilityAttachmentContract
  defaultForOutputType?: boolean
}

export interface CapabilityModelContract {
  id: string
  capabilities: Array<CapabilityModelCapability>
}

export declare function checkLicenseHealth(request: LicenseHealthRequest): Promise<LicenseResponse>

export interface Chunk {
  index: number
  content: string
}

export interface CommandResponse {
  error?: LicenseError
}

export interface ContentPolicyMatch {
  type: string
  reason: string
  value?: string
  span?: ContentPolicyMatchSpan
}

export interface ContentPolicyMatchSpan {
  start: number
  end: number
}

export interface ContentPolicyScanInput {
  value: string
  checks?: Array<string>
}

export interface ContentPolicyScanResult {
  version: number
  original: string
  normalized: string
  skeleton: string
  matched: boolean
  matches: Array<ContentPolicyMatch>
  flags: Array<string>
}

export interface CoordinationLeaseGrant {
  key: string
  owner: string
  fencingToken: bigint | number
}

export interface CopilotAccessProjection {
  routeAllowed: boolean
  managedTier: CopilotManagedTier
  serverByok: boolean
  localByok: boolean
}

export declare function copilotActionRecipe(actionId: string, actionVersion?: string | undefined | null): string

export interface CopilotExecuteInput {
  slot: string
  builtInRouteId?: string
  workspaceId?: string
  userId?: string
  localLeaseId?: string
  access: CopilotAccessProjection
  managedTargetId?: string
  targetOverride?: CopilotTargetOverrideInput
  request: unknown
}

export type CopilotManagedTier =  'Standard'|
'Premium';

export interface CopilotRouteCheckInput {
  slot: string
  builtInRouteId?: string
  workspaceId?: string
  userId?: string
  localLeaseId?: string
  access: CopilotAccessProjection
  managedTargetId?: string
  targetOverride?: CopilotTargetOverrideInput
}

export interface CopilotTargetOverrideInput {
  profileId: string
  modelId: string
}

export declare function createAuthSessionRefreshToken(): AuthSessionRefreshToken

export interface CreateByokLocalLeaseInput {
  workspaceId: string
  userId: string
  providers: Array<CreateByokLocalLeaseProviderInput>
}

export interface CreateByokLocalLeaseProviderInput {
  provider: string
  name: string
  description?: string
  credential: string
  definition: ByokProfileDefinitionInput
  enabled: boolean
}

export interface CreateByokProfileInput {
  workspaceId: string
  provider: string
  name: string
  description?: string
  credential: string
  definition: ByokProfileDefinitionInput
  enabled: boolean
  actorUserId: string
}

/**
 * Converts markdown content to AFFiNE-compatible y-octo document binary.
 *
 * # Arguments
 * * `title` - The document title
 * * `markdown` - The markdown content to convert
 * * `doc_id` - The document ID to use for the y-octo doc
 *
 * # Returns
 * A Buffer containing the y-octo document update binary
 */
export declare function createDocWithMarkdown(title: string, markdown: string, docId: string): Buffer

export declare function createLicenseCustomerPortal(request: LicenseKeyRequest): Promise<PortalResponse>

export declare function deactivateLicense(request: LicenseKeyRequest): Promise<CommandResponse>

export declare function evaluatePermissionV1(input: any): any

export declare function fetchRemoteAttachment(request: RemoteAttachmentFetchRequest): Promise<RemoteAttachmentFetchResponse>

export declare function fromModelName(modelName: string): Tokenizer | null

export declare function getMime(input: Uint8Array): string

export declare function htmlSanitize(input: string): string

export interface ImageInspection {
  mimeType: string
  width: number
  height: number
}

export interface ImageInspectionOptions {
  maxWidth?: number
  maxHeight?: number
  maxPixels?: number
}

export declare function inferRemoteMimeType(request: RemoteMimeTypeRequest): Promise<string>

export declare function inspectImageForProxy(input: Buffer, options?: ImageInspectionOptions | undefined | null): ImageInspection

export interface LicenseError {
  status: number
  body: string
}

export interface LicenseHealthRequest {
  licenseKey: string
  validateKey: string
}

export interface LicenseInfo {
  plan: string
  recurring: string
  quantity: number
  expiresAt: number
  validateKey: string
}

export interface LicenseKeyRequest {
  licenseKey: string
}

export interface LicenseRecurringRequest {
  licenseKey: string
  recurring: string
}

export interface LicenseResponse {
  license?: LicenseInfo
  error?: LicenseError
}

export interface LicenseSeatsRequest {
  licenseKey: string
  seats: number
}

export declare function llmBuildCanonicalRequest(request: CanonicalChatRequestContract): LlmRequestContract

export declare function llmBuildCanonicalStructuredRequest(request: CanonicalStructuredRequestContract): LlmStructuredRequestContract

export declare function llmBuildEmbeddingRequest(request: LlmEmbeddingRequestContract): LlmEmbeddingRequestContract

export declare function llmBuildImageRequestFromMessages(request: LlmImageRequestBuildContract): LlmImageRequestContract

export declare function llmBuildRerankRequest(request: LlmRerankRequestContract): LlmRerankRequestContract

export declare function llmCanonicalJsonSchemaHash(schema: any): string

export interface LlmCoreMessage {
  role: string
  content: Array<any>
}

export interface LlmEmbeddingRequestContract {
  model: string
  inputs: Array<string>
  dimensions?: number
  taskType?: string
}

export declare function llmGetBuiltInPromptSpec(name: string): BuiltInPromptSpec | null

export declare function llmGetBuiltInRouteOptions(name: string): BuiltInRouteOptions | null

export declare function llmGetByokCatalog(): ByokCatalogOutput

export declare function llmGetContractSchema(name: string): any

export interface LlmImageInputContract {
  kind: 'url' | 'data' | 'bytes'
  url?: string
  dataBase64?: string
  data?: Array<number>
  mediaType?: string
  fileName?: string
}

export interface LlmImageOptionsContract {
  n?: number
  size?: string
  aspectRatio?: string
  quality?: string
  outputFormat?: 'png' | 'jpeg' | 'webp'
  outputCompression?: number
  background?: string
  seed?: number
}

export interface LlmImageProviderOptionsContract {
  provider: 'openai' | 'gemini' | 'fal' | 'extra'
  options?: {
    input_fidelity?: string;
    response_modalities?: string[];
    model_name?: string;
    image_size?: unknown;
    aspect_ratio?: string;
    num_images?: number;
    enable_safety_checker?: boolean;
    output_format?: 'jpeg' | 'png' | 'webp';
    sync_mode?: boolean;
    enable_prompt_expansion?: boolean;
    loras?: unknown;
    controlnets?: unknown;
    extra?: unknown;
    } | unknown
  }

export interface LlmImageRequestBuildContract {
  model: string
  messages: Array<PromptMessageContract>
  options?: any
}

export interface LlmImageRequestContract {
  model: string
  prompt: string
  operation: 'generate' | 'edit'
  images?: Array<LlmImageInputContract>
  mask?: LlmImageInputContract
  options?: LlmImageOptionsContract
  providerOptions?: LlmImageProviderOptionsContract
}

export declare function llmInferPromptModelConditions(messages: Array<PromptMessageContract>): ModelConditionsContract

export declare function llmListBuiltInPromptSpecs(): Array<BuiltInPromptSpec>

export declare function llmMatchModelCapabilities(payload: CapabilityMatchRequest): CapabilityMatchResponse

export declare function llmMatchModelRegistry(request: ModelRegistryMatchRequest): ModelRegistryMatchResponse

export declare function llmRenderBuiltInPrompt(request: BuiltInPromptRenderContract): PromptRenderResult

export declare function llmRenderBuiltInSessionPrompt(request: BuiltInPromptSessionContract): PromptSessionResult

export interface LlmRequestContract {
  model: string
  messages: Array<LlmCoreMessage>
  stream?: boolean
  maxTokens?: number
  temperature?: number
  tools?: Array<ToolContract>
  toolChoice?: any
  include?: Array<string>
  reasoning?: any
  responseSchema?: any
  middleware?: any
}

export interface LlmRerankRequestContract {
  model: string
  query: string
  candidates: Array<RerankCandidate>
  topN?: number
}

export declare function llmResolveModelRegistryVariant(request: ModelRegistryResolveRequest): ModelRegistryResolveResponse

export interface LlmStructuredRequestContract {
  model: string
  messages: Array<LlmCoreMessage>
  schema: any
  maxTokens?: number
  temperature?: number
  reasoning?: any
  strict?: boolean
  responseMimeType?: string
  middleware?: any
}

export declare function llmValidateContract(name: string, value: any): any

export declare function llmValidateJsonSchema(schema: any, value: any): any

/**
 * Merge updates in form like `Y.applyUpdate(doc, update)` way and return the
 * result binary.
 */
export declare function mergeUpdatesInApplyWay(updates: Array<Buffer>): Buffer

export declare function mintChallengeResponse(resource: string, bits?: number | undefined | null): Promise<string>

export interface ModelConditionsContract {
  inputTypes?: Array<'text' | 'image' | 'audio' | 'file'>
  attachmentKinds?: Array<'image' | 'audio' | 'file'>
  attachmentSourceKinds?: Array<'url' | 'data' | 'bytes' | 'file_handle'>
  hasRemoteAttachments?: boolean
  modelId?: string
  outputType?: 'text' | 'image' | 'object' | 'structured' | 'embedding' | 'rerank'
}

export interface ModelRegistryMatchRequest {
  backendKind: 'openai_chat' | 'openai_responses' | 'anthropic' | 'cloudflare_workers_ai' | 'gemini_api' | 'gemini_vertex' | 'fal' | 'anthropic_vertex' | 'deepseek' | 'kimi' | 'opencode_go' | 'opencode_zen'
  cond: ModelConditionsContract
}

export interface ModelRegistryMatchResponse {
  variant?: ModelRegistryVariantContract
}

export interface ModelRegistryResolveRequest {
  backendKind?: 'openai_chat' | 'openai_responses' | 'anthropic' | 'cloudflare_workers_ai' | 'gemini_api' | 'gemini_vertex' | 'fal' | 'anthropic_vertex' | 'deepseek' | 'kimi' | 'opencode_go' | 'opencode_zen'
  modelId: string
}

export interface ModelRegistryResolveResponse {
  variant?: ModelRegistryVariantContract
  matchedBy?: string
}

export interface ModelRegistryRouteContract {
  protocol?: 'openai_chat' | 'openai_responses' | 'openai_images' | 'anthropic' | 'gemini' | 'fal_image'
  requestLayer?: 'anthropic' | 'chat_completions' | 'chat_completions_no_v1' | 'cloudflare_workers_ai' | 'responses' | 'openai_images' | 'fal' | 'vertex' | 'vertex_anthropic' | 'gemini_api' | 'gemini_vertex'
}

export interface ModelRegistryVariantContract {
  backendKind: 'openai_chat' | 'openai_responses' | 'anthropic' | 'cloudflare_workers_ai' | 'gemini_api' | 'gemini_vertex' | 'fal' | 'anthropic_vertex' | 'deepseek' | 'kimi' | 'opencode_go' | 'opencode_zen'
  canonicalKey: string
  rawModelId: string
  displayName?: string
  aliases: Array<string>
  legacyAliases?: Array<string>
  capabilities: Array<CapabilityModelCapability>
  protocol?: 'openai_chat' | 'openai_responses' | 'openai_images' | 'anthropic' | 'gemini' | 'fal_image'
  requestLayer?: 'anthropic' | 'chat_completions' | 'chat_completions_no_v1' | 'cloudflare_workers_ai' | 'responses' | 'openai_images' | 'fal' | 'vertex' | 'vertex_anthropic' | 'gemini_api' | 'gemini_vertex'
  routeOverrides?: Record<string, ModelRegistryRouteContract>
  behaviorFlags?: Array<string>
}

export interface NativeBlockInfo {
  blockId: string
  flavour: string
  content?: Array<string>
  blob?: Array<string>
  refDocId?: Array<string>
  refInfo?: Array<string>
  parentFlavour?: string
  parentBlockId?: string
  additional?: string
}

export interface NativeCrawlResult {
  blocks: Array<NativeBlockInfo>
  title: string
  summary: string
}

export interface NativeMarkdownResult {
  title: string
  markdown: string
  knownUnsupportedBlocks: Array<string>
  unknownBlocks: Array<string>
}

export interface NativePageDocContent {
  title: string
  summary: string
}

export interface NativeWorkspaceDocContent {
  name: string
  avatarKey: string
}

export declare function parseAuthSessionRefreshToken(token: string): ParsedAuthSessionRefreshToken | null

export interface ParsedAuthSessionRefreshToken {
  id: string
  secretHash: string
}

export interface ParsedDoc {
  name: string
  chunks: Array<Chunk>
}

export declare function parseDoc(filePath: string, doc: Buffer): Promise<ParsedDoc>

export declare function parseDocFromBinary(docBin: Buffer, docId: string): NativeCrawlResult

export declare function parseDocToMarkdown(docBin: Buffer, docId: string, aiEditable?: boolean | undefined | null, docUrlPrefix?: string | undefined | null): NativeMarkdownResult

export declare function parsePageDoc(docBin: Buffer, maxSummaryLength?: number | undefined | null): NativePageDocContent | null

export declare function parseWorkspaceDoc(docBin: Buffer): NativeWorkspaceDocContent | null

export declare function permissionActionRoleMatrixV1(): any

export declare function permissionActionRoleMatrixV1Json(): string

export interface PortalResponse {
  url?: string
  error?: LicenseError
}

export interface ProbeByokDraftInput {
  workspaceId: string
  provider: string
  credential?: string
  profileId?: string
  expectedRevision?: number
  definition: ByokProfileDefinitionInput
  checks: Array<ByokProbeCheckInput>
}

export interface ProbeByokProfileInput {
  workspaceId: string
  profileId: string
  checks: Array<ByokProbeCheckInput>
}

export declare function processImage(input: Buffer, maxEdge: number, keepExif: boolean): Promise<Buffer>

export type PromptBuiltin =  'Date'|
'Language'|
'Timezone'|
'HasDocs'|
'HasFiles'|
'HasSelected'|
'HasCurrentDoc';

export interface PromptMessageContract {
  role: 'system' | 'assistant' | 'user'
  content: string
  attachments?: Array<any>
  params?: Record<string, any>
  responseFormat?: PromptStructuredResponseContract
}

export interface PromptParamSpec {
  default?: string
  enumValues?: Array<string>
}

export interface PromptRenderResult {
  messages: Array<PromptMessageContract>
  warnings: Array<string>
}

export interface PromptSessionResult {
  messages: Array<PromptMessageContract>
  warnings: Array<string>
  promptMessagePositions: Array<number>
}

export interface PromptSpecMessage {
  role: 'system' | 'assistant' | 'user'
  template: string
}

export interface PromptStructuredResponseContract {
  type: 'json_schema'
  responseSchemaJson: Record<string, unknown>
  schemaHash: string
  strict?: boolean
}

export interface ProviderDriverSpec {
  driverId: string
  providerType: string
  models: Array<string>
  routes: Array<ProviderRouteSpec>
  hostOnly?: ProviderHostOnlySpec
}

export interface ProviderHostOnlySpec {
  errorMapper?: string
  structuredRetry?: boolean
  providerToolAlias?: boolean
}

export interface ProviderRouteSpec {
  kind: string
  protocol: string
  requestLayer?: string
  supportsNativeFallback?: boolean
  supportsToolLoop?: boolean
  requestMiddlewares?: Array<string>
  streamMiddlewares?: Array<string>
  nodeTextMiddlewares?: Array<string>
}

export interface PublicDocMetaInput {
  id: string
  title?: string
}

export declare function readAllDocIdsFromRootDoc(docBin: Buffer, includeTrash?: boolean | undefined | null): Array<string>

export interface RemoteAttachmentFetchRequest {
  url: string
  timeoutMs?: number
  maxBytes: number
  allowPrivateTargetOrigin?: boolean
  expectedContentTypePrefix?: string
  maxImageWidth?: number
  maxImageHeight?: number
  maxImagePixels?: number
}

export interface RemoteAttachmentFetchResponse {
  finalUrl: string
  mimeType: string
  body: Buffer
}

export interface RemoteMimeTypeRequest {
  url: string
  timeoutMs?: number
}

export interface ReorderByokProfilesInput {
  workspaceId: string
  profiles: Array<ByokProfileOrderInput>
  actorUserId: string
}

export interface ReplaceByokProfileInput {
  workspaceId: string
  profileId: string
  expectedRevision: number
  name: string
  description?: string
  definition: ByokProfileDefinitionInput
  credential?: string
  enabled: boolean
  actorUserId: string
}

export interface RerankCandidate {
  id?: string
  text: string
}

export interface ResolvedEntitlement {
  plan: string
  valid: boolean
  status: string
  quantity?: number
  expiresAt?: string
  subjectId?: string
  targetId?: string
  recurring?: string
  issuedAt?: string
  entity?: string
  issuer?: string
  quota: ResolvedQuota
  flags: Record<string, boolean>
  errorCode?: string
  errorMessage?: string
}

export interface ResolvedQuota {
  blobLimit: number
  storageQuota: number
  seatLimit?: number
  seatQuota?: number
  historyPeriod: number
  copilotActionLimit?: number
}

export interface ResolveEntitlementInput {
  deploymentType: string
  targetType: string
  targetId?: string
  plan?: string
  quantity?: number
  signedPayload?: Buffer
  publicKey?: string
  licenseAesKey?: string
  now: string
}

export declare function resolveEntitlementV1(input: ResolveEntitlementInput): ResolvedEntitlement

export interface RotateByokCredentialInput {
  workspaceId: string
  profileId: string
  expectedRevision: number
  credential: string
  actorUserId: string
}

export interface RuntimeBlobCleanupExecuteResult {
  scannedCandidates: number
  deletedObjects: number
  deletedMetadata: number
  skippedStillReferenced: number
  failed: number
  workspaceIds: Array<string>
}

export interface RuntimeBlobCleanupPlanResult {
  runId?: string
  scannedBlobs: number
  candidatesMarked: number
  protectedByDocRefs: number
  protectedByMetadata: number
  protectedByOtherRefs: number
  nextCursor?: string
}

export interface RuntimeBlobCleanupResult {
  scanned: number
  deleted: number
  abortedMultipart: number
  workspaceIds: Array<string>
}

export interface RuntimeBlobCompleteResult {
  ok: boolean
  reason?: string
  contentType?: string
  contentLength?: number
  lastModifiedMs?: number
}

export interface RuntimeBlobMetadataBackfillResult {
  scannedObjects: number
  headedObjects: number
  upsertedMetadata: number
  skippedExisting: number
  skippedWorkspaceMissing: number
  failed: number
  nextCursor?: string
  workspaceIds: Array<string>
}

export interface RuntimeDocBlobRefsResult {
  scannedDocs: number
  parsedDocs: number
  refsWritten: number
  refsDeleted: number
  failedDocs: number
  nextCursor?: string
}

export interface RuntimeDocCompactionResult {
  leaseAcquired: boolean
  merged: boolean
  workspaceId: string
  docId: string
  updatesMerged: number
  historyCreated: boolean
}

export interface RuntimeDocHistoryInput {
  workspaceId: string
  docId: string
  blob: Buffer
  timestampMs: number
  editorId?: string
  force: boolean
  historyMinIntervalMs: number
  historyMaxAgeMs: number
}

export interface RuntimeDocumentCleanupAckResult {
  completed: boolean
}

export interface RuntimeDocumentCleanupEffect {
  workspaceId: string
  docId: string
  cleanupVersion: string
  commentObjectsDone: boolean
  searchDone: boolean
  copilotDone: boolean
}

export interface RuntimeDocumentCleanupExecuteResult {
  scannedCandidates: number
  serializationRetries: number
  executed: number
  recovered: number
  reset: number
  failed: number
  deletedRows: number
  effects: Array<RuntimeDocumentCleanupEffect>
}

export interface RuntimeDocumentCleanupReconcileResult {
  scannedDocs: number
  marked: number
  reset: number
  recovered: number
}

export interface RuntimeInviteAbuseActionRequired {
  action: string
  subjectKey: string
  evidenceId: string
  actionId: string
}

export interface RuntimeInviteAbuseClaimedAction {
  action: string
  subjectKey: string
  evidenceId: string
  actionId: string
  actorUserId: string
  workspaceId: string
}

export interface RuntimeMagicLinkOtpConsumeResult {
  ok: boolean
  token?: string
  reason?: string
}

export interface RuntimeMailDeliveryQuotaDecision {
  allowed: boolean
  reservationId?: string
  mailClass: string
  retryAfterSeconds?: number
  reason?: string
  scopeKey?: string
  windowSeconds?: number
  limit?: number
  current?: number
  requested?: number
}

export interface RuntimeMailDeliveryQuotaInput {
  requestId?: string
  mailName: string
  recipient: RuntimeMailDeliveryQuotaRecipientInput
  metadata: RuntimeMailDeliveryQuotaMetadataInput
  source?: RuntimeQuotaSourceInput
}

export interface RuntimeMailDeliveryQuotaMetadataInput {
  actorUserId?: string
  workspaceId?: string
  notificationId?: string
  abuseSubjectKey?: string
}

export interface RuntimeMailDeliveryQuotaRecipientInput {
  email: string
  domain: string
  userId?: string
}

export interface RuntimeMultipartUploadInit {
  uploadId: string
  expiresAtMs: number
}

export interface RuntimeMultipartUploadPart {
  partNumber: number
  etag: string
}

export interface RuntimeObjectGetResult {
  body: Buffer
  metadata: RuntimeObjectMetadata
}

export interface RuntimeObjectListEntry {
  key: string
  contentLength: number
  lastModifiedMs: number
}

export interface RuntimeObjectMetadata {
  contentType: string
  contentLength: number
  lastModifiedMs: number
  checksumCrc32?: string
}

export interface RuntimeObjectStoragePutOptions {
  contentType?: string
  contentLength?: number
  checksumCrc32?: string
}

export interface RuntimePresignedObjectRequest {
  url: string
  headersJson: string
  expiresAtMs: number
}

export interface RuntimeQuotaSourceInput {
  trusted: boolean
  ip?: string
  country?: string
  asn?: number
  rayId?: string
}

export interface RuntimeQuotaTargetDomainInput {
  domain: string
  count: number
}

export interface RuntimeVerificationTokenRecord {
  tokenType: number
  token: string
  credential?: string
  expiresAtMs: number
}

export interface RuntimeWorkspaceInviteLinkRecord {
  workspaceId: string
  inviteId: string
  inviterUserId: string
  expiresAtMs: number
}

export interface RuntimeWorkspaceInviteQuotaDecision {
  allowed: boolean
  reservationId?: string
  retryAfterSeconds?: number
  reason?: string
  scopeKey?: string
  windowSeconds?: number
  limit?: number
  current?: number
  requested?: number
  actionRequired?: RuntimeInviteAbuseActionRequired
}

export interface RuntimeWorkspaceInviteQuotaInput {
  actorUserId: string
  workspaceId: string
  requestId?: string
  targetCount: number
  targetDomains: Array<RuntimeQuotaTargetDomainInput>
  source?: RuntimeQuotaSourceInput
}

export interface RuntimeWorkspaceInviteQuotaUsage {
  targetCount: number
  targetDomains: Array<RuntimeQuotaTargetDomainInput>
}

export interface RuntimeWorkspaceStatsDailyRecalibrationResult {
  processed: number
  lastSid: number
  snapshotted: number
  skipped: boolean
}

export interface RuntimeWorkspaceStatsRecalibrationResult {
  processed: number
  lastSid: number
  skipped: boolean
}

export interface RuntimeWorkspaceStatsRefreshResult {
  processed: number
  backlog: number
  skipped: boolean
}

export interface RuntimeWorkspaceStatsSnapshotResult {
  snapshotted: number
  skipped: boolean
}

export declare function safeFetch(request: SafeFetchRequest): Promise<SafeFetchResponse>

export type SafeFetchMethod =  'get'|
'head'|
'post'|
'put'|
'propfind'|
'report';

export interface SafeFetchRequest {
  url: string
  method?: SafeFetchMethod
  headers?: Record<string, string>
  body?: Buffer
  timeoutMs?: number
  maxRedirects?: number
  maxBytes?: number
  allowedHeaders?: Array<string>
  allowedHosts?: Array<string>
  allowHttp?: boolean
  allowPrivateTargetOrigin?: boolean
  enableEch?: boolean
  echConfigList?: Buffer
}

export interface SafeFetchResponse {
  status: number
  finalUrl: string
  headers: Record<string, string>
  body: Buffer
}

export declare function scanContentPolicyV1(input: ContentPolicyScanInput): ContentPolicyScanResult

export declare function signAuthSessionAccessToken(userId: string, authSessionId: string, keyId: string, secret: Buffer, issuedAt: number, expiresAt: number): string

export interface StorageProviderCapabilities {
  put: boolean
  get: boolean
  head: boolean
  list: boolean
  delete: boolean
  presignPut: boolean
  presignGet: boolean
  multipartDirect: boolean
  proxyUpload: boolean
  assetpack: boolean
  serverMediatedOnly: boolean
}

export interface StorageRuntimeHealth {
  started: boolean
  databaseConnected: boolean
  providerConfigured: boolean
  provider?: string
  bucket?: string
}

export interface ToolContract {
  name: string
  description?: string
  parameters: any
}

/**
 * Updates or creates the docProperties record for a document.
 *
 * # Arguments
 * * `existing_binary` - The current docProperties document binary
 * * `properties_doc_id` - The docProperties document ID
 *   (db$${workspaceId}$docProperties)
 * * `target_doc_id` - The document ID to update in docProperties
 * * `created_by` - Optional creator user ID
 * * `updated_by` - Optional updater user ID
 *
 * # Returns
 * A Buffer containing only the delta (changes) as a y-octo update binary
 */
export declare function updateDocProperties(existingBinary: Buffer, propertiesDocId: string, targetDocId: string, createdBy?: string | undefined | null, updatedBy?: string | undefined | null): Buffer

/**
 * Updates a document's title without touching content blocks.
 *
 * # Arguments
 * * `existing_binary` - The current document binary
 * * `title` - The new title
 * * `doc_id` - The document ID
 *
 * # Returns
 * A Buffer containing only the delta (changes) as a y-octo update binary
 */
export declare function updateDocTitle(existingBinary: Buffer, title: string, docId: string): Buffer

/**
 * Updates an existing document with new markdown content.
 * Uses structural diffing to apply block-level replacements for changes.
 *
 * # Arguments
 * * `existing_binary` - The current document binary
 * * `new_markdown` - The new markdown content to apply
 * * `doc_id` - The document ID
 *
 * # Returns
 * A Buffer containing only the delta (changes) as a y-octo update binary
 */
export declare function updateDocWithMarkdown(existingBinary: Buffer, newMarkdown: string, docId: string): Buffer

export declare function updateLicenseRecurring(request: LicenseRecurringRequest): Promise<CommandResponse>

export declare function updateLicenseSeats(request: LicenseSeatsRequest): Promise<CommandResponse>

/**
 * Updates a document title in the workspace root doc's meta.pages array.
 *
 * # Arguments
 * * `root_doc_bin` - The current root doc binary (workspaceId doc)
 * * `doc_id` - The document ID to update
 * * `title` - The new title for the document
 *
 * # Returns
 * A Buffer containing the y-octo update binary to apply to the root doc
 */
export declare function updateRootDocMetaTitle(rootDocBin: Buffer, docId: string, title: string): Buffer

/**
 * Check whether a Yjs update binary can be decoded without applying it to a
 * document state.
 */
export declare function validateDocUpdate(update: Buffer): Promise<boolean>

export declare function verifyAuthSessionAccessToken(token: string, expectedKeyId: string, secret: Buffer, now: number): AuthSessionAccessTokenVerification

export declare function verifyChallengeResponse(response: string, bits: number, resource: string): Promise<boolean>