API reference
Reference for the public API of @sidedoc/backend, generated by TypeDoc from the TSDoc comments in app/sidedoc-backend/src. It covers everything exported from src/index.ts.
Do not edit these pages by hand. Run npm run docs:api in docs/ (the docs build does this first) to regenerate them. To change a description, edit the comment in the source. See Contributing for the comment conventions, and Architecture for how the pieces fit together.
Classes
- ActiveRecordSession
- AppFactory
- BackupServiceImpl
- Document
- DocumentApplicationService
- DocumentationServiceImpl
- DocumentRecord
- DocumentServiceImpl
- ExportServiceImpl
- Folder
- FolderApplicationService
- IndexedDBDocumentService
- IndexedDBWorkspaceService
- InMemoryDocumentService
- InMemoryWorkspaceService
- PersistenceUiController
- ProfileServiceImpl
- ServiceContainer
- ServicesFactory
- ShadowApplicationService
- StorageServiceImpl
- TemplateServiceImpl
- TransformationApplicationService
- TransformationServiceImpl
- ValidationApplicationService
- ValidationServiceImpl
- VocabularyApplicationService
- VocabularyServiceImpl
- Workspace
- WorkspaceApplicationService
- WorkspaceFactory
- WorkspacePersistenceService
- WorkspaceRecord
- WorkspaceServiceImpl
Interfaces
- ActiveRecordServices
- AgentValue
- AuditInfo
- BackupInfo
- BackupService
- BinaryExport
- ContainerValue
- DocumentationEntry
- DocumentationQuery
- DocumentationService
- DocumentInstance
- DocumentLinkTarget
- DocumentProfile
- DocumentRecordApi
- DocumentService
- DocumentTemplate
- ExportService
- FieldDescriptor
- FieldVocabularyAttachment
- FieldVocabularyAttachmentRegistry
- FieldVocabularyBinding
- FieldVocabularyEnforcement
- FolderNode
- GoogleDrivePersistenceConfig
- JsonLdExportOptions
- LinkedDocumentCandidate
- LinkedDocumentsOption
- LiteralValue
- LocalFsPersistenceConfig
- MaterializedVocabularyConcept
- MaterializedVocabularyIndex
- MaterializedVocabularyScheme
- OAuthClient
- OAuthState
- OAuthTokenSet
- PersistenceProviderServiceEntry
- PersistenceUiControllerConfig
- PersistenceUiControllerViewModel
- ProfileService
- QAStatus
- RdfMappingEntry
- RdfMappingOptions
- RichTextValue
- S3ConnectOptions
- S3PersistenceConfig
- ServicesApi
- StorageBinding
- StorageLocation
- StorageService
- SyncStatus
- TauriLocalPersistenceConfig
- TemplateService
- TermValue
- TextExport
- TransformationService
- TypeDefinition
- TypedValue
- TypeLibrary
- UrlValue
- ValidationIssue
- ValidationResult
- ValidationService
- VersionInfo
- VocabularyConceptSummary
- VocabularyListResult
- VocabularySchemeSummary
- VocabularyService
- WorkspaceFactoryConfig
- WorkspacePersistenceProvider
- WorkspacePersistenceServiceOptions
- WorkspaceRecordApi
- WorkspaceService
- WorkspaceSnapshot
Type Aliases
DcatMappingOptions- DocumentData
- ExportFormatId
- FieldValue
- HelpLevel
- ID
- ISODateString
- JsonValue
- Locale
- LocalizedString
- ServiceName
- StorageProviderKind
- URI
- ValueTreeNode
Variables
applyDcatMapping- DEFAULT_DOCUMENT_EXPORT_CSS
- DEFAULT_TARGET_MODEL
- EXPORT_FORMATS
- htmlDocumentTransformer
- htmlPdfTransformer
- jsonLdDocumentTransformer
- KNOWN_TRANSFORM_NAMES
- markdownDocumentTransformer
- PERSISTENCE_PROVIDER_IDS
- RDF_MAPPING_MATRIX
- SERVICE_NAMES
- STORAGE_PROVIDER_KINDS
- version
Functions
- applyFieldVocabularyAttachments
- applyPatch
- applyRdfMapping
- availableRdfTargets
- clearIndexedDB
- clearStorage
- createActiveRecordSession
- createEditorNodeViewModelAdapter
- createEditorRenderingAdapter
- createEditorSessionAdapter
- createEmptyFromSchema
- createGoogleDrivePersistenceService
- createGoogleDrivePersistenceServiceFromEnv
- createGoogleDriveProvider
- createLocalFsPersistenceService
- createLocalFsPersistenceServiceFromEnv
- createLocalFsProvider
- createMockServices
- createPersistenceUiController
- createProfileFromSchema
- createProfileShadowAdapter
- createS3PersistenceService
- createS3PersistenceServiceFromEnv
- createS3Provider
- createShadow
- createTauriLocalPersistenceService
- createTauriLocalPersistenceServiceFromEnv
- createTauriLocalProvider
- createUnionRenderingAdapter
- createValueRenderingAdapter
- createValueTreeAdapter
- createWorkspacePersistenceService
- defaultRdfTarget
- detectProfileId
- documentToHtml
- documentToJsonLd
- documentToMarkdown
- findRdfMapping
- generateSkeletonFromProfile
- getLocalizedString
- getMaxOccurrences
- getMinOccurrences
- getSchemaForPath
- getStorageState
- hasMeaningfulContent
- htmlToPdfBlob
- initializeMockWorkspace
- isSafeHref
- loadProfileFromSchemaUrls
- materializeVocabularyIndexFromSkosDocuments
- normalizeDocument
- normalizeFieldVocabularyBinding
- pickTranslation
- resolveSchemaNode
- safeHref
- seedEmptyValueArrays
- typeTagFor
- validateImportedData
- validateMapping