mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-07-01 17:50:50 +08:00
DarkSky
f44a7978d9
#### PR Dependency Tree * **PR #15144** 👈 This tree was auto-generated by [Charcoal](https://github.com/danerwilliams/charcoal) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Document history retention is now explicitly controlled via caller-provided max-age parameters during pending doc compaction. * **Improvements** * Quota state backfilling/reconciliation was improved to reduce unnecessary work and ensure missing quota states are created in batches. * Permission context loading now more strictly respects “known” vs “stale” quota runtime state. * **Bug Fixes** * Workspace member responses now populate invite IDs correctly from the nested user information. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1058 lines
32 KiB
TypeScript
1058 lines
32 KiB
TypeScript
/* auto-generated by NAPI-RS */
|
|
/* eslint-disable */
|
|
export declare class BackendRuntime {
|
|
completeBlobUpload(workspaceId: string, key: string, expectedSize: number, expectedMime: string): Promise<RuntimeBlobCompleteResult>
|
|
completeFsBlobUpload(root: string, bucket: string, workspaceId: string, key: string, expectedSize: number, expectedMime: string): Promise<RuntimeBlobCompleteResult>
|
|
cleanupExpiredPendingBlobs(cutoffMs: number, limit: number): Promise<RuntimeBlobCleanupResult>
|
|
releaseDeletedBlobs(workspaceId: string, limit: number): Promise<RuntimeBlobCleanupResult>
|
|
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>
|
|
/**
|
|
* 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
|
|
* historyMaxAgeSeconds value. The compactor intentionally does not read
|
|
* effective workspace quota state.
|
|
*/
|
|
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>
|
|
deleteDocStorage(workspaceId: string, docId: string): Promise<void>
|
|
putRuntimeGateIfAbsent(key: string, ttlMs: number): Promise<boolean>
|
|
cleanupExpiredRuntimeGates(limit: number): Promise<number>
|
|
cleanupExpiredUserSessions(limit: number): Promise<number>
|
|
cleanupExpiredSnapshotHistories(limit: number): Promise<number>
|
|
objectStorageHealth(): RuntimeObjectStorageHealth
|
|
objectStoragePut(key: string, body: Buffer, metadata?: RuntimeObjectStoragePutOptions | undefined | null): Promise<void>
|
|
objectStoragePresignPut(key: string, metadata?: RuntimeObjectStoragePutOptions | undefined | null): Promise<RuntimePresignedObjectRequest>
|
|
objectStorageCreateMultipartUpload(key: string, metadata?: RuntimeObjectStoragePutOptions | undefined | null): Promise<RuntimeMultipartUploadInit | null>
|
|
objectStoragePresignUploadPart(key: string, uploadId: string, partNumber: number): Promise<RuntimePresignedObjectRequest>
|
|
objectStorageListMultipartUploadParts(key: string, uploadId: string): Promise<Array<RuntimeMultipartUploadPart>>
|
|
objectStorageCompleteMultipartUpload(key: string, uploadId: string, parts: Array<RuntimeMultipartUploadPart>): Promise<void>
|
|
objectStorageAbortMultipartUpload(key: string, uploadId: string): Promise<void>
|
|
objectStorageHead(key: string): Promise<RuntimeObjectMetadata | null>
|
|
objectStorageGet(key: string): Promise<RuntimeObjectGetResult | null>
|
|
objectStorageList(prefix?: string | undefined | null): Promise<Array<RuntimeObjectListEntry>>
|
|
objectStorageDelete(key: string): Promise<void>
|
|
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>
|
|
createByokLocalLease(activeKey: string, leaseId: string, payload: any, ttlMs: number): Promise<RuntimeByokLocalLeaseRecord>
|
|
getByokLocalLease(leaseId: string): Promise<RuntimeByokLocalLeaseRecord | null>
|
|
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()
|
|
start(): Promise<void>
|
|
stop(): Promise<void>
|
|
health(): Promise<BackendRuntimeHealth>
|
|
runMigrations(): Promise<void>
|
|
}
|
|
|
|
export declare class LlmStreamHandle {
|
|
abort(): void
|
|
}
|
|
|
|
export declare class Tokenizer {
|
|
count(content: string, allowedSpecial?: Array<string> | undefined | null): number
|
|
}
|
|
|
|
export interface ActionEvent {
|
|
type: ActionEventType
|
|
actionId: string
|
|
actionVersion: string
|
|
stepId?: string
|
|
status?: ActionRunStatus
|
|
attachment?: any
|
|
result?: any
|
|
errorCode?: string
|
|
errorMessage?: string
|
|
trace?: ActionTrace
|
|
}
|
|
|
|
export type ActionEventType = 'action_start'|
|
|
'step_start'|
|
|
'attachment'|
|
|
'step_end'|
|
|
'action_done'|
|
|
'error';
|
|
|
|
export type ActionRunStatus = 'created'|
|
|
'running'|
|
|
'succeeded'|
|
|
'failed'|
|
|
'aborted';
|
|
|
|
export interface ActionRuntimeInput {
|
|
recipeId: string
|
|
recipeVersion?: string
|
|
input: any
|
|
}
|
|
|
|
export interface ActionTrace {
|
|
actionId: string
|
|
actionVersion: string
|
|
status: ActionRunStatus
|
|
lightweight: Array<any>
|
|
errorCode?: string
|
|
}
|
|
|
|
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 interface BackendRuntimeHealth {
|
|
started: boolean
|
|
databaseConnected: boolean
|
|
objectStorageConfigured: boolean
|
|
}
|
|
|
|
export declare function buildPublicRootDoc(rootDocBin: Buffer, docMetas: Array<PublicDocMetaInput>): Buffer
|
|
|
|
export interface BuiltInPromptRenderContract {
|
|
name: string
|
|
renderParams: Record<string, any>
|
|
}
|
|
|
|
export interface BuiltInPromptSessionContract {
|
|
name: string
|
|
turns: Array<PromptMessageContract>
|
|
renderParams: Record<string, any>
|
|
maxTokenSize: number
|
|
}
|
|
|
|
export interface BuiltInPromptSpec {
|
|
name: string
|
|
action?: string
|
|
model: string
|
|
optionalModels?: Array<string>
|
|
config?: any
|
|
params?: Record<string, PromptParamSpec>
|
|
builtins?: Array<PromptBuiltin>
|
|
messages: Array<PromptSpecMessage>
|
|
}
|
|
|
|
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 CoordinationLeaseGrant {
|
|
key: string
|
|
owner: string
|
|
fencingToken: bigint | number
|
|
}
|
|
|
|
/**
|
|
* 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 declare function llmCollectPromptMetadata(request: PromptMetadataContract): PromptMetadataResult
|
|
|
|
export declare function llmCompileExecutionPlan(value: any): any
|
|
|
|
export interface LlmCoreMessage {
|
|
role: string
|
|
content: Array<any>
|
|
}
|
|
|
|
export declare function llmCountPromptTokens(request: PromptTokenCountContract): PromptTokenCountResult
|
|
|
|
export declare function llmDispatchPrepared(routesJson: string): Promise<string>
|
|
|
|
export declare function llmDispatchPreparedStream(routesJson: string, callback: ((err: Error | null, arg: string) => void)): LlmStreamHandle
|
|
|
|
export declare function llmDispatchToolLoopStream(protocol: string, backendConfigJson: string, requestJson: string, maxSteps: number, callback: ((err: Error | null, arg: string) => void), toolCallback: ((err: Error | null, arg: string) => Promise<string>)): LlmStreamHandle
|
|
|
|
export declare function llmDispatchToolLoopStreamPrepared(routesJson: string, maxSteps: number, callback: ((err: Error | null, arg: string) => void), toolCallback: ((err: Error | null, arg: string) => Promise<string>)): LlmStreamHandle
|
|
|
|
export declare function llmDispatchToolLoopStreamRouted(routesJson: string, requestJson: string, maxSteps: number, callback: ((err: Error | null, arg: string) => void), toolCallback: ((err: Error | null, arg: string) => Promise<string>)): LlmStreamHandle
|
|
|
|
export declare function llmEmbeddingDispatch(protocol: string, backendConfigJson: string, requestJson: string): Promise<string>
|
|
|
|
export declare function llmEmbeddingDispatchPrepared(routesJson: string): Promise<string>
|
|
|
|
export interface LlmEmbeddingRequestContract {
|
|
model: string
|
|
inputs: Array<string>
|
|
dimensions?: number
|
|
taskType?: string
|
|
}
|
|
|
|
export declare function llmGetBuiltInPromptSpec(name: string): BuiltInPromptSpec | null
|
|
|
|
export declare function llmGetContractSchema(name: string): any
|
|
|
|
export declare function llmImageDispatchPrepared(routesJson: string): Promise<string>
|
|
|
|
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
|
|
protocol: 'openai_chat' | 'openai_responses' | 'openai_images' | 'anthropic' | 'gemini' | 'fal_image'
|
|
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 llmNormalizePreparedRoutes(value: any): any
|
|
|
|
export declare function llmPlanAttachmentReference(protocol: string, backendConfigJson: string, sourceJson: string): string
|
|
|
|
export declare function llmRenderBuiltInPrompt(request: BuiltInPromptRenderContract): PromptRenderResult
|
|
|
|
export declare function llmRenderBuiltInSessionPrompt(request: BuiltInPromptSessionContract): PromptSessionResult
|
|
|
|
export declare function llmRenderPrompt(request: PromptRenderContract): PromptRenderResult
|
|
|
|
export declare function llmRenderSessionPrompt(request: PromptSessionContract): 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 declare function llmRerankDispatch(protocol: string, backendConfigJson: string, requestJson: string): Promise<string>
|
|
|
|
export declare function llmRerankDispatchPrepared(routesJson: string): Promise<string>
|
|
|
|
export interface LlmRerankRequestContract {
|
|
model: string
|
|
query: string
|
|
candidates: Array<RerankCandidate>
|
|
topN?: number
|
|
}
|
|
|
|
export declare function llmResolveModelRegistryVariant(request: ModelRegistryResolveRequest): ModelRegistryResolveResponse
|
|
|
|
export declare function llmResolveRequestedModelMatch(payload: RequestedModelMatchRequest): RequestedModelMatchResponse
|
|
|
|
export declare function llmResolveRequestIntent(protocol: string, backendConfigJson: string, intentJson: string): string
|
|
|
|
export declare function llmStructuredDispatch(protocol: string, backendConfigJson: string, requestJson: string): Promise<string>
|
|
|
|
export declare function llmStructuredDispatchPrepared(routesJson: string): Promise<string>
|
|
|
|
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'
|
|
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'
|
|
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' | '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'
|
|
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' | '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 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 declare function processImage(input: Buffer, maxEdge: number, keepExif: boolean): Promise<Buffer>
|
|
|
|
export type PromptBuiltin = 'Date'|
|
|
'Language'|
|
|
'Timezone'|
|
|
'HasDocs'|
|
|
'HasFiles'|
|
|
'HasSelected'|
|
|
'HasCurrentDoc';
|
|
|
|
export interface PromptCountMessage {
|
|
content: string
|
|
}
|
|
|
|
export interface PromptMessageContract {
|
|
role: 'system' | 'assistant' | 'user'
|
|
content: string
|
|
attachments?: Array<any>
|
|
params?: Record<string, any>
|
|
responseFormat?: PromptStructuredResponseContract
|
|
}
|
|
|
|
export interface PromptMetadataContract {
|
|
messages: Array<PromptMessageContract>
|
|
}
|
|
|
|
export interface PromptMetadataResult {
|
|
paramKeys: Array<string>
|
|
templateParams: Record<string, any>
|
|
}
|
|
|
|
export interface PromptParamSpec {
|
|
default?: string
|
|
enumValues?: Array<string>
|
|
}
|
|
|
|
export interface PromptRenderContract {
|
|
messages: Array<PromptMessageContract>
|
|
templateParams: Record<string, any>
|
|
renderParams: Record<string, any>
|
|
}
|
|
|
|
export interface PromptRenderResult {
|
|
messages: Array<PromptMessageContract>
|
|
warnings: Array<string>
|
|
}
|
|
|
|
export interface PromptSessionContract {
|
|
prompt: PromptSessionPrompt
|
|
turns: Array<PromptMessageContract>
|
|
renderParams: Record<string, any>
|
|
maxTokenSize: number
|
|
}
|
|
|
|
export interface PromptSessionPrompt {
|
|
action?: string
|
|
model?: string
|
|
promptTokens: number
|
|
templateParams: Record<string, any>
|
|
messages: Array<PromptMessageContract>
|
|
}
|
|
|
|
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 PromptTokenCountContract {
|
|
model?: string
|
|
messages: Array<PromptCountMessage>
|
|
}
|
|
|
|
export interface PromptTokenCountResult {
|
|
tokens: number
|
|
}
|
|
|
|
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 RequestedModelMatchRequest {
|
|
providerIds: Array<string>
|
|
optionalModels: Array<string>
|
|
requestedModelId?: string
|
|
defaultModel?: string
|
|
}
|
|
|
|
export interface RequestedModelMatchResponse {
|
|
selectedModel?: string
|
|
matchedOptionalModel: boolean
|
|
}
|
|
|
|
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 declare function runNativeActionRecipePreparedStream(input: ActionRuntimeInput, callback: ((err: Error | null, arg: string) => void)): LlmStreamHandle
|
|
|
|
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 RuntimeByokLocalLeaseRecord {
|
|
leaseId: string
|
|
payload: any
|
|
expiresAtMs: number
|
|
}
|
|
|
|
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 RuntimeMagicLinkOtpConsumeResult {
|
|
ok: boolean
|
|
token?: string
|
|
reason?: 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 RuntimeObjectStorageHealth {
|
|
configured: boolean
|
|
provider?: string
|
|
bucket?: string
|
|
endpoint?: string
|
|
region?: string
|
|
hasCredentials: boolean
|
|
forcePathStyle: boolean
|
|
requestTimeoutMs?: number
|
|
minPartSize?: number
|
|
presignExpiresInSeconds?: number
|
|
presignSignContentTypeForPut?: boolean
|
|
usePresignedUrl: boolean
|
|
clientBuildable: boolean
|
|
}
|
|
|
|
export interface RuntimeObjectStoragePutOptions {
|
|
contentType?: string
|
|
contentLength?: number
|
|
checksumCrc32?: string
|
|
}
|
|
|
|
export interface RuntimePresignedObjectRequest {
|
|
url: string
|
|
headersJson: string
|
|
expiresAtMs: 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 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 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
|
|
|
|
export declare function verifyChallengeResponse(response: string, bits: number, resource: string): Promise<boolean>
|