platform/packages/core/src/server.ts

121 lines
3.4 KiB
TypeScript
Raw Normal View History

//
// Copyright © 2022 Hardcore Engineering Inc.
//
// Licensed under the Eclipse Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. You may
// obtain a copy of the License at https://www.eclipse.org/legal/epl-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
2024-11-13 14:25:57 +00:00
import type { Account, Doc, DocIndexState, Domain, Ref } from './classes'
import { MeasureContext } from './measurements'
import { DocumentQuery, FindOptions } from './storage'
import type { DocumentUpdate, Tx } from './tx'
import type { WorkspaceIdWithUrl } from './utils'
/**
* @public
*/
export interface DocInfo {
id: string
hash: string
size: number // Aprox size
}
/**
* @public
*/
export interface StorageIterator {
next: (ctx: MeasureContext) => Promise<DocInfo[]>
close: (ctx: MeasureContext) => Promise<void>
}
export type BroadcastTargets = Record<string, (tx: Tx) => string[] | undefined>
export interface SessionData {
broadcast: {
txes: Tx[]
targets: BroadcastTargets // A set of broadcast filters if required
}
contextCache: Map<string, any>
removedMap: Map<Ref<Doc>, Doc>
userEmail: string
sessionId: string
admin?: boolean
isTriggerCtx?: boolean
account: Account
getAccount: (account: Ref<Account>) => Account | undefined
workspace: WorkspaceIdWithUrl
branding: Branding | null
2024-11-13 14:25:57 +00:00
fulltextUpdates?: Map<Ref<DocIndexState>, DocIndexState>
}
/**
* @public
*/
export interface LowLevelStorage {
// Low level streaming API to retrieve information
// If recheck is passed, all %hash% for documents, will be re-calculated.
find: (ctx: MeasureContext, domain: Domain, recheck?: boolean) => StorageIterator
// Load passed documents from domain
load: (ctx: MeasureContext, domain: Domain, docs: Ref<Doc>[]) => Promise<Doc[]>
// Upload new versions of documents
// docs - new/updated version of documents.
upload: (ctx: MeasureContext, domain: Domain, docs: Doc[]) => Promise<void>
// Remove a list of documents.
clean: (ctx: MeasureContext, domain: Domain, docs: Ref<Doc>[]) => Promise<void>
// Low level direct group API
groupBy: <T, P extends Doc>(
ctx: MeasureContext,
domain: Domain,
field: string,
query?: DocumentQuery<P>
) => Promise<Map<T, number>>
// migrations
rawFindAll: <T extends Doc>(domain: Domain, query: DocumentQuery<T>, options?: FindOptions<T>) => Promise<T[]>
rawUpdate: <T extends Doc>(domain: Domain, query: DocumentQuery<T>, operations: DocumentUpdate<T>) => Promise<void>
rawDeleteMany: <T extends Doc>(domain: Domain, query: DocumentQuery<T>) => Promise<void>
// Traverse documents
traverse: <T extends Doc>(
domain: Domain,
query: DocumentQuery<T>,
options?: Pick<FindOptions<T>, 'sort' | 'limit' | 'projection'>
) => Promise<Iterator<T>>
}
export interface Iterator<T extends Doc> {
next: (count: number) => Promise<T[] | null>
close: () => Promise<void>
}
export interface Branding {
key?: string
front?: string
title?: string
language?: string
initWorkspace?: string
lastNameFirst?: string
protocol?: string
}
export type BrandingMap = Record<string, Branding>