@dossierhq/core/lib/index.d.ts

The core Dossier library used by clients and server alike, used to interact with schema and entities directly, as well as remotely through a client.

export { ErrorResultError, ErrorType, assertErrorResultType, assertOkResult, createErrorResult, createErrorResultFromError, notOk, ok, type ErrorFromResult, type ErrorResult, type OkFromResult, type OkResult, type PromiseResult, type Result, } from './ErrorResult.js';
export { NoOpLogger, createConsoleLogger, type Logger, type LoggerContext } from './Logger.js';
export { EntityQueryOrder, EntityStatus, PublishedEntityQueryOrder, RichTextNodeType, type AdvisoryLockOptions, type AdvisoryLockPayload, type AdvisoryLockReleasePayload, type BoundingBox, type Component, type Connection, type Edge, type Entity, type EntityArchivePayload, type EntityCreate, type EntityCreatePayload, type EntityDeletePayload, type EntityInfo, type EntityLike, type EntityMutationOptions, type EntityProcessDirtyPayload, type EntityPublishPayload, type EntityPublishingPayload, type EntityQuery, type EntityReference, type EntitySamplingOptions, type EntitySamplingPayload, type EntitySharedQuery, type EntityUnarchivePayload, type EntityUnpublishPayload, type EntityUpdate, type EntityUpdatePayload, type EntityUpsert, type EntityUpsertPayload, type EntityVersionReference, type Location, type PageInfo, type Paging, type PublishedEntity, type PublishedEntityInfo, type PublishedEntityQuery, type PublishedEntitySharedQuery, type RichText, type RichTextCodeHighlightNode, type RichTextCodeNode, type RichTextComponentNode, type RichTextElementNode, type RichTextEntityLinkNode, type RichTextEntityNode, type RichTextHeadingNode, type RichTextLineBreakNode, type RichTextLinkNode, type RichTextListItemNode, type RichTextListNode, type RichTextNode, type RichTextParagraphNode, type RichTextRootNode, type RichTextTabNode, type RichTextTextNode, type UniqueIndexReference, } from './Types.js';
export { withAdvisoryLock } from './client/AdvisoryLockUtils.js';
export { DossierClientModifyingOperations, DossierClientOperationName, convertJsonDossierClientResult, createBaseDossierClient, executeJsonDossierClientOperation, type DossierClient, type DossierClientMiddleware, type DossierClientOperation, type DossierExceptionClient, type JsonDossierClientOperationArgs, } from './client/DossierClient.js';
export { convertJsonConnection, convertJsonEdge, convertJsonResult, convertJsonSyncEvent, type JsonConnection, type JsonEdge, type JsonResult, type JsonSyncEvent, } from './client/JsonUtils.js';
export { getAllNodesForConnection, getAllPagesForConnection, getPagingInfo, type PagingInfo, } from './client/PagingUtils.js';
export { PublishedDossierClientOperationName, convertJsonPublishedDossierClientResult, createBasePublishedDossierClient, executeJsonPublishedDossierClientOperation, type JsonPublishedDossierClientOperationArgs, type PublishedDossierClient, type PublishedDossierClientMiddleware, type PublishedDossierClientOperation, type PublishedDossierExceptionClient, } from './client/PublishedDossierClient.js';
export { LoggingClientMiddleware, type ClientContext, type ContextProvider, } from './client/SharedClient.js';
export { decodeURLSearchParamsParam, encodeObjectToURLSearchParams, encodeURLSearchParams, } from './client/UrlQueryUtils.js';
export { normalizeComponent, normalizeContentField, normalizeEntityFields, } from './content/ContentNormalizer.js';
export { contentValuePathToString, type ContentValuePath } from './content/ContentPath.js';
export { transformComponent, transformEntityFields, type ContentTransformer, } from './content/ContentTransformer.js';
export { ContentTraverseNodeErrorType, ContentTraverseNodeType, traverseComponent, traverseContentField, traverseEntity, type ContentTraverseNode, } from './content/ContentTraverser.js';
export { isBooleanItemField, isBooleanListField, isBooleanSingleField, isComponentItemField, isComponentListField, isComponentSingleField, isLocationItemField, isLocationListField, isLocationSingleField, isNumberItemField, isNumberListField, isNumberSingleField, isReferenceItemField, isReferenceListField, isReferenceSingleField, isRichTextCodeHighlightNode, isRichTextCodeNode, isRichTextComponentNode, isRichTextElementNode, isRichTextEntityLinkNode, isRichTextEntityNode, isRichTextHeadingNode, isRichTextItemField, isRichTextLineBreakNode, isRichTextLinkNode, isRichTextListField, isRichTextListItemNode, isRichTextListNode, isRichTextParagraphNode, isRichTextRootNode, isRichTextSingleField, isRichTextTabNode, isRichTextTextNode, isStringItemField, isStringListField, isStringSingleField, } from './content/ContentTypeUtils.js';
export { copyEntity, getEntityNameBase, isEntityNameAsRequested } from './content/ContentUtils.js';
export { groupValidationIssuesByTopLevelPath, validateEntityInfo, validateEntityInfoForCreate, validateEntityInfoForUpdate, validateTraverseNodeForPublish, validateTraverseNodeForSave, type PublishValidationIssue, type SaveValidationIssue, } from './content/ContentValidator.js';
export { transformRichText } from './content/RichTextTransformer.js';
export { createRichText, createRichTextComponentNode, createRichTextEntityLinkNode, createRichTextEntityNode, createRichTextHeadingNode, createRichTextLineBreakNode, createRichTextListItemNode, createRichTextListNode, createRichTextParagraphNode, createRichTextTabNode, createRichTextTextAndWhitespaceNodes, createRichTextTextNode, richTextTextNodeHasFormat, } from './content/RichTextUtils.js';
export { EventType, type ArchiveEntitySyncEvent, type ChangelogEvent, type ChangelogEventQuery, type ChangelogEventSharedQuery, type CreateEntitySyncEvent, type CreatePrincipalChangelogEvent, type CreatePrincipalSyncEvent, type DeleteEntitiesSyncEvent, type EntityChangelogEvent, type PublishEntitiesSyncEvent, type SchemaChangelogEvent, type SyncEvent, type UnarchiveEntitySyncEvent, type UnpublishEntitiesSyncEvent, type UpdateEntitySyncEvent, type UpdateSchemaSyncEvent, } from './events/EventTypes.js';
export { PublishedSchema } from './schema/PublishedSchema.js';
export { Schema, SchemaWithMigrations } from './schema/Schema.js';
export { FieldType, REQUIRED_RICH_TEXT_NODES, type BooleanFieldSpecification, type BooleanFieldSpecificationUpdate, type ComponentFieldSpecification, type ComponentFieldSpecificationUpdate, type ComponentTypeSpecification, type ComponentTypeSpecificationUpdate, type EntityTypeSpecification, type EntityTypeSpecificationUpdate, type FieldSpecification, type FieldSpecificationUpdate, type FieldValueTypeMap, type LegacyComponentTypeSpecification, type LegacyEntityTypeSpecification, type LegacySchemaSpecificationWithMigrations, type LocationFieldSpecification, type LocationFieldSpecificationUpdate, type NumberFieldSpecification, type NumberFieldSpecificationUpdate, type PublishedBooleanFieldSpecification, type PublishedComponentFieldSpecification, type PublishedComponentTypeSpecification, type PublishedEntityTypeSpecification, type PublishedFieldSpecification, type PublishedLocationFieldSpecification, type PublishedNumberFieldSpecification, type PublishedReferenceFieldSpecification, type PublishedRichTextFieldSpecification, type PublishedSchemaSpecification, type PublishedStringFieldSpecification, type ReferenceFieldSpecification, type ReferenceFieldSpecificationUpdate, type RichTextFieldSpecification, type RichTextFieldSpecificationUpdate, type SchemaIndexSpecification, type SchemaMigrationAction, type SchemaPatternSpecification, type SchemaSpecification, type SchemaSpecificationUpdate, type SchemaSpecificationUpdatePayload, type SchemaSpecificationWithMigrations, type SchemaTransientMigrationAction, type SchemaVersionMigration, type StringFieldSpecification, type StringFieldSpecificationUpdate, } from './schema/SchemaSpecification.js';
export { isFieldValueEqual } from './utils/isFieldValueEqual.js';