@aopslab/domain-dm-docman 0.1.2

package/dist/application/factories/index.d.ts

@@ -0,0 +1,43 @@
+export * from './ServiceDocumentFactory.js';
+export * from './ServiceDocumentBuilder.js';
+export * from './ServiceDocumentGroupFactory.js';
+export * from './ServiceDocumentGroupBuilder.js';
+export * from './ServiceDocumentVersionFactory.js';
+export * from './ServiceDocumentVersionBuilder.js';
+export * from './ServiceSectionFactory.js';
+export * from './ServiceSectionBuilder.js';
+export * from './ServicePageFactory.js';
+export * from './ServicePageBuilder.js';
+export * from './ServicePageVersionFactory.js';
+export * from './ServicePageVersionBuilder.js';
+export * from './ServiceDocumentSectionLinkFactory.js';
+export * from './ServiceDocumentSectionLinkBuilder.js';
+export * from './ServiceSectionPageLinkFactory.js';
+export * from './ServiceSectionPageLinkBuilder.js';
+export * from './ServiceSnippetFactory.js';
+export * from './ServiceSnippetBuilder.js';
+export * from './ServicePageSnippetLinkFactory.js';
+export * from './ServicePageSnippetLinkBuilder.js';
+export * from './ServiceAssetFactory.js';
+export * from './ServiceAssetBuilder.js';
+export * from './ServiceAssetVersionFactory.js';
+export * from './ServiceAssetVersionBuilder.js';
+export * from './ServiceEmbedFactory.js';
+export * from './ServiceEmbedBuilder.js';
+export * from './ServicePageEmbedLinkFactory.js';
+export * from './ServicePageEmbedLinkBuilder.js';
+export * from './RepositoryFactoryDocument.js';
+export * from './RepositoryFactoryDocumentGroup.js';
+export * from './RepositoryFactoryDocumentVersion.js';
+export * from './RepositoryFactorySection.js';
+export * from './RepositoryFactoryPage.js';
+export * from './RepositoryFactoryPageVersion.js';
+export * from './RepositoryFactoryDocumentIndexEntry.js';
+export * from './RepositoryFactoryDocumentSectionLink.js';
+export * from './RepositoryFactorySectionPageLink.js';
+export * from './RepositoryFactorySnippet.js';
+export * from './RepositoryFactoryPageSnippetLink.js';
+export * from './RepositoryFactoryAsset.js';
+export * from './RepositoryFactoryAssetVersion.js';
+export * from './RepositoryFactoryEmbed.js';
+export * from './RepositoryFactoryPageEmbedLink.js';

package/dist/application/factories/index.js

@@ -0,0 +1,44 @@
+// Application factory exports
+export * from './ServiceDocumentFactory.js';
+export * from './ServiceDocumentBuilder.js';
+export * from './ServiceDocumentGroupFactory.js';
+export * from './ServiceDocumentGroupBuilder.js';
+export * from './ServiceDocumentVersionFactory.js';
+export * from './ServiceDocumentVersionBuilder.js';
+export * from './ServiceSectionFactory.js';
+export * from './ServiceSectionBuilder.js';
+export * from './ServicePageFactory.js';
+export * from './ServicePageBuilder.js';
+export * from './ServicePageVersionFactory.js';
+export * from './ServicePageVersionBuilder.js';
+export * from './ServiceDocumentSectionLinkFactory.js';
+export * from './ServiceDocumentSectionLinkBuilder.js';
+export * from './ServiceSectionPageLinkFactory.js';
+export * from './ServiceSectionPageLinkBuilder.js';
+export * from './ServiceSnippetFactory.js';
+export * from './ServiceSnippetBuilder.js';
+export * from './ServicePageSnippetLinkFactory.js';
+export * from './ServicePageSnippetLinkBuilder.js';
+export * from './ServiceAssetFactory.js';
+export * from './ServiceAssetBuilder.js';
+export * from './ServiceAssetVersionFactory.js';
+export * from './ServiceAssetVersionBuilder.js';
+export * from './ServiceEmbedFactory.js';
+export * from './ServiceEmbedBuilder.js';
+export * from './ServicePageEmbedLinkFactory.js';
+export * from './ServicePageEmbedLinkBuilder.js';
+export * from './RepositoryFactoryDocument.js';
+export * from './RepositoryFactoryDocumentGroup.js';
+export * from './RepositoryFactoryDocumentVersion.js';
+export * from './RepositoryFactorySection.js';
+export * from './RepositoryFactoryPage.js';
+export * from './RepositoryFactoryPageVersion.js';
+export * from './RepositoryFactoryDocumentIndexEntry.js';
+export * from './RepositoryFactoryDocumentSectionLink.js';
+export * from './RepositoryFactorySectionPageLink.js';
+export * from './RepositoryFactorySnippet.js';
+export * from './RepositoryFactoryPageSnippetLink.js';
+export * from './RepositoryFactoryAsset.js';
+export * from './RepositoryFactoryAssetVersion.js';
+export * from './RepositoryFactoryEmbed.js';
+export * from './RepositoryFactoryPageEmbedLink.js';

package/dist/application/ports/inbound/IAssetServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import { AssetServiceError } from '../../errors/AssetServiceError.js';
+import { IbmAsset, IbmAssetInsert } from '../../../domain/models/index.js';
+export interface IAssetServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmAsset>): Effect.Effect<IbmAsset | null, AssetServiceError>;
+    create(data: IbmAssetInsert): Effect.Effect<IbmAsset, AssetServiceError>;
+    listAssets(filter?: Partial<IbmAsset>, options?: DbQueryOptions<IbmAsset>): Effect.Effect<IbmAsset[], AssetServiceError>;
+    updateAsset(id: string, patch: Partial<IbmAsset>): Effect.Effect<IbmAsset, AssetServiceError>;
+    removeAsset(id: string): Effect.Effect<void, AssetServiceError>;
+}
+export interface IAssetLookupPort {
+    getById(id: string): Effect.Effect<IbmAsset | null, AssetServiceError>;
+}

package/dist/application/ports/inbound/IAssetServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IAssetVersionServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import { AssetVersionServiceError } from '../../errors/AssetVersionServiceError.js';
+import { IbmAssetVersion, IbmAssetVersionInsert, IbmAssetVersionPatch } from '../../../domain/models/index.js';
+export interface IAssetVersionServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmAssetVersion>): Effect.Effect<IbmAssetVersion | null, AssetVersionServiceError>;
+    create(data: IbmAssetVersionInsert): Effect.Effect<IbmAssetVersion, AssetVersionServiceError>;
+    listAssetVersions(filter?: Partial<IbmAssetVersion>, options?: DbQueryOptions<IbmAssetVersion>): Effect.Effect<IbmAssetVersion[], AssetVersionServiceError>;
+    updateAssetVersion(id: string, patch: IbmAssetVersionPatch): Effect.Effect<IbmAssetVersion, AssetVersionServiceError>;
+    removeAssetVersion(id: string): Effect.Effect<void, AssetVersionServiceError>;
+}
+export interface IAssetVersionLookupPort {
+    getById(id: string): Effect.Effect<IbmAssetVersion | null, AssetVersionServiceError>;
+}

package/dist/application/ports/inbound/IAssetVersionServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IDocumentGroupServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { DocumentGroupServiceError } from '../../errors/DocumentGroupServiceError.js';
+import { IbmDocumentGroup, IbmDocumentGroupInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+export interface IDocumentGroupServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmDocumentGroup>): Effect.Effect<IbmDocumentGroup | null, DocumentGroupServiceError>;
+    create(data: IbmDocumentGroupInsert): Effect.Effect<IbmDocumentGroup, DocumentGroupServiceError>;
+    listDocumentGroups(filter?: Partial<IbmDocumentGroup>, options?: DbQueryOptions<IbmDocumentGroup>): Effect.Effect<IbmDocumentGroup[], DocumentGroupServiceError>;
+    updateDocumentGroup(id: string, patch: Partial<IbmDocumentGroup>): Effect.Effect<IbmDocumentGroup, DocumentGroupServiceError>;
+    removeDocumentGroup(id: string): Effect.Effect<void, DocumentGroupServiceError>;
+}
+export interface IDocumentGroupLookupPort {
+    getById(id: string): Effect.Effect<IbmDocumentGroup | null, DocumentGroupServiceError>;
+}

package/dist/application/ports/inbound/IDocumentGroupServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IDocumentSectionLinkServicePort.d.ts

@@ -0,0 +1,16 @@
+import { Effect } from 'effect';
+import { DocumentSectionLinkServiceError } from '../../errors/DocumentSectionLinkServiceError.js';
+import { IbmDocumentSectionLink, IbmDocumentSectionLinkInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import type { DocumentSectionLinkUsageItem } from '../repository-ports/IRepositoryPortDocumentSectionLink.js';
+export interface IDocumentSectionLinkServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmDocumentSectionLink>): Effect.Effect<IbmDocumentSectionLink | null, DocumentSectionLinkServiceError>;
+    create(data: IbmDocumentSectionLinkInsert): Effect.Effect<IbmDocumentSectionLink, DocumentSectionLinkServiceError>;
+    listDocumentSectionLinks(filter?: Partial<IbmDocumentSectionLink>, options?: DbQueryOptions<IbmDocumentSectionLink>): Effect.Effect<IbmDocumentSectionLink[], DocumentSectionLinkServiceError>;
+    updateDocumentSectionLink(id: string, patch: Partial<IbmDocumentSectionLink>): Effect.Effect<IbmDocumentSectionLink, DocumentSectionLinkServiceError>;
+    removeDocumentSectionLink(id: string): Effect.Effect<void, DocumentSectionLinkServiceError>;
+    listDocumentSectionLinkUsageBySectionId(sectionId: string): Effect.Effect<DocumentSectionLinkUsageItem[], DocumentSectionLinkServiceError>;
+}
+export interface IDocumentSectionLinkLookupPort {
+    getById(id: string): Effect.Effect<IbmDocumentSectionLink | null, DocumentSectionLinkServiceError>;
+}

package/dist/application/ports/inbound/IDocumentSectionLinkServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IDocumentServicePort.d.ts

@@ -0,0 +1,300 @@
+import { Effect } from 'effect';
+import { DocumentServiceError } from '../../errors/DocumentServiceError.js';
+import { IbmDocument, IbmDocumentIndexEntry, IbmDocumentInsert, IbmDocumentVersion } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import type { DocmanDocumentDeleteReport } from '../../services/documentCascadeDelete.js';
+export type DocumentLocaleOptions = {
+    locale?: string;
+    fallbackLocale?: string;
+};
+export type DocmanComposeSourceFormat = 'md' | 'mdx';
+export type DocumentListOptions = DbQueryOptions<IbmDocument> & DocumentLocaleOptions & {
+    includeVersionInfo?: boolean;
+};
+export type IbmDocumentWithVersions = IbmDocument & {
+    documentVersions?: IbmDocumentVersion[];
+};
+export type DocmanPageNodeIndexItem = {
+    linkId: string;
+    pageVersionId: string;
+    pageId: string;
+    format: DocmanComposeSourceFormat;
+    number: string;
+    depth: number;
+    position: number;
+    title: string;
+    titleVisible: boolean;
+    pageBreakBefore: boolean;
+    pageBreakAfter: boolean;
+    parentLinkId?: string;
+    directives?: unknown;
+};
+export type DocmanSectionNodeIndexItem = {
+    linkId: string;
+    sectionId: string;
+    number: string;
+    depth: number;
+    position: number;
+    title: string;
+    pageBreakBefore: boolean;
+    pageBreakAfter: boolean;
+    parentLinkId?: string;
+    directives?: unknown;
+};
+export type DocmanComposedPageIndex = {
+    pageNumber: number;
+    format: DocmanComposeSourceFormat;
+    formats: DocmanComposeSourceFormat[];
+    itemNumbers: string[];
+    pageVersionIds: string[];
+};
+export type DocmanDocumentComposeIndexItem = ({
+    kind: 'section';
+} & DocmanSectionNodeIndexItem) | ({
+    kind: 'page';
+} & DocmanPageNodeIndexItem);
+export type DocmanDocumentComposeKind = 'document' | 'section' | 'page';
+export type DocmanPublishTarget = 'markdown' | 'html';
+export type DocmanDocumentIndexEntryKind = 'section' | 'page';
+export type DocmanDocumentSummaryEntryKind = 'document' | 'section' | 'page';
+export type DocmanDocumentRetrievalStrategy = 'lexical' | 'hybrid' | 'semantic';
+export type DocmanPublishedFragmentWarning = {
+    code: string;
+    message: string;
+};
+export type DocmanResolvedAssetReference = {
+    token: string;
+    ref: string;
+    assetId: string;
+    assetVersionId: string;
+    assetVersion: number;
+    assetUid?: string;
+    slug?: string;
+    title?: string;
+    altText?: string;
+    kind: string;
+    mime: string;
+    href: string;
+    width?: number;
+    height?: number;
+};
+export type DocmanDocumentComposeFetchInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+    sectionId?: string;
+    pageVersionId?: string;
+    pageNumber?: number;
+};
+export type DocmanDocumentComposeFetchResult = {
+    documentVersionId: string;
+    kind: DocmanDocumentComposeKind;
+    format: DocmanComposeSourceFormat;
+    formats: DocmanComposeSourceFormat[];
+    content: string;
+    assets: DocmanResolvedAssetReference[];
+    pageNumber?: number;
+    sectionId?: string;
+    pageVersionId?: string;
+};
+export type DocmanDocumentPublishMaterializeInput = DocmanDocumentComposeFetchInput & {
+    target: DocmanPublishTarget;
+};
+export type DocmanDocumentPublishMaterializeResult = DocmanDocumentComposeFetchResult & {
+    target: DocmanPublishTarget;
+    mediaType: string;
+    warnings: DocmanPublishedFragmentWarning[];
+};
+export type DocmanDocumentComposeIndex = {
+    documentId: string;
+    documentVersionId: string;
+    title: string;
+    items: DocmanDocumentComposeIndexItem[];
+    pages: DocmanComposedPageIndex[];
+};
+export type DocmanDocumentIndexBuildInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+};
+export type DocmanDocumentIndexGetInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+};
+export type DocmanDocumentSummaryBuildInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+};
+export type DocmanDocumentSummaryGetInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+};
+export type DocmanDocumentSearchInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+    q: string;
+    limit?: number;
+    retrievalStrategy?: DocmanDocumentRetrievalStrategy;
+};
+export type DocmanScopeDocumentSearchInput = DocumentLocaleOptions & {
+    scopeId: string;
+    q: string;
+    limit?: number;
+    retrievalStrategy?: DocmanDocumentRetrievalStrategy;
+};
+export type DocmanDocumentAnswerPackInput = DocumentLocaleOptions & {
+    documentVersionId: string;
+    q: string;
+    limit?: number;
+    retrievalStrategy?: DocmanDocumentRetrievalStrategy;
+};
+export type DocmanDocumentIndexSnapshotEntry = Pick<IbmDocumentIndexEntry, 'linkId' | 'parentLinkId' | 'anchor' | 'parentAnchor' | 'number' | 'depth' | 'position' | 'title' | 'breadcrumb' | 'titleVisible' | 'pageBreakBefore' | 'pageBreakAfter' | 'sectionId' | 'sectionUid' | 'sectionSlug' | 'pageId' | 'pageUid' | 'pageVersionId' | 'format' | 'pageNumberStart' | 'pageNumberEnd'> & {
+    itemKind: DocmanDocumentIndexEntryKind;
+};
+export type DocmanDocumentSearchHit = Pick<IbmDocumentIndexEntry, 'anchor' | 'parentAnchor' | 'number' | 'depth' | 'title' | 'breadcrumb' | 'sectionId' | 'sectionUid' | 'sectionSlug' | 'pageId' | 'pageUid' | 'pageVersionId' | 'format' | 'pageNumberStart' | 'pageNumberEnd'> & {
+    itemKind: DocmanDocumentIndexEntryKind;
+    score: number;
+    excerpt: string;
+    matchedBy: DocmanDocumentAnswerPackMatchField[];
+    lexicalScore: number;
+    semanticScore?: number;
+};
+export type DocmanDocumentSearchProvenance = {
+    strategy: 'lexical-search-v1' | 'hybrid-search-v1' | 'semantic-search-v1';
+    retrievalStrategy: DocmanDocumentRetrievalStrategy;
+    vectorAvailable: boolean;
+    vectorProvider?: string;
+    vectorModel?: string;
+};
+export type DocmanDocumentIndexSnapshot = {
+    documentId?: string;
+    documentVersionId: string;
+    title?: string;
+    locale?: string;
+    fallbackLocale?: string;
+    built: boolean;
+    buildFingerprint?: string;
+    documentAnchor?: string;
+    entries: DocmanDocumentIndexSnapshotEntry[];
+    counts: {
+        sections: number;
+        pages: number;
+    };
+};
+export type DocmanDocumentSummarySnapshotEntry = Pick<IbmDocumentIndexEntry, 'linkId' | 'parentLinkId' | 'anchor' | 'parentAnchor' | 'number' | 'depth' | 'position' | 'title' | 'breadcrumb' | 'titleVisible' | 'pageBreakBefore' | 'pageBreakAfter' | 'sectionId' | 'sectionUid' | 'sectionSlug' | 'pageId' | 'pageUid' | 'pageVersionId' | 'format' | 'pageNumberStart' | 'pageNumberEnd'> & {
+    itemKind: DocmanDocumentSummaryEntryKind;
+    summaryText: string;
+    sourceCharCount: number;
+    sourceWordCount: number;
+    summaryCharCount: number;
+    summaryWordCount: number;
+};
+export type DocmanDocumentSummarySnapshot = {
+    documentId?: string;
+    documentVersionId: string;
+    title?: string;
+    locale?: string;
+    fallbackLocale?: string;
+    built: boolean;
+    buildFingerprint?: string;
+    documentAnchor?: string;
+    entries: DocmanDocumentSummarySnapshotEntry[];
+    counts: {
+        documents: number;
+        sections: number;
+        pages: number;
+    };
+};
+export type DocmanDocumentSearchResult = {
+    documentVersionId: string;
+    locale?: string;
+    fallbackLocale?: string;
+    q: string;
+    built: boolean;
+    buildFingerprint?: string;
+    hits: DocmanDocumentSearchHit[];
+    provenance: DocmanDocumentSearchProvenance;
+};
+export type DocmanScopeDocumentSearchHit = DocmanDocumentSearchHit & {
+    documentId: string;
+    documentTitle: string;
+    documentSlug?: string;
+    documentVersionId: string;
+    documentVersionTitle: string;
+    documentVersionNumber?: number;
+};
+export type DocmanScopeDocumentSearchFailure = {
+    documentId?: string;
+    documentTitle?: string;
+    documentVersionId?: string;
+    stage: 'resolve-latest-version' | 'build-index' | 'search';
+    message: string;
+};
+export type DocmanScopeDocumentSearchBuildReport = {
+    autoBuiltDocumentVersionIds: string[];
+    failures: DocmanScopeDocumentSearchFailure[];
+};
+export type DocmanScopeDocumentSearchProvenance = {
+    strategy: 'lexical-search-v1' | 'hybrid-search-v1' | 'semantic-search-v1';
+    retrievalStrategy: DocmanDocumentRetrievalStrategy;
+    totalDocumentCount: number;
+    searchedDocumentCount: number;
+    autoBuiltDocumentCount: number;
+    failedDocumentCount: number;
+};
+export type DocmanScopeDocumentSearchResult = {
+    scopeId: string;
+    locale?: string;
+    fallbackLocale?: string;
+    q: string;
+    hits: DocmanScopeDocumentSearchHit[];
+    provenance: DocmanScopeDocumentSearchProvenance;
+    buildReport: DocmanScopeDocumentSearchBuildReport;
+};
+export type DocmanDocumentAnswerPackMatchField = 'title' | 'breadcrumb' | 'number' | 'bodyText' | 'summaryText' | 'semanticVector';
+export type DocmanDocumentAnswerPackAnswerSource = 'summary' | 'excerpt' | 'title' | 'none';
+export type DocmanDocumentAnswerPackCitation = Pick<IbmDocumentIndexEntry, 'anchor' | 'parentAnchor' | 'number' | 'depth' | 'title' | 'breadcrumb' | 'sectionId' | 'sectionUid' | 'sectionSlug' | 'pageId' | 'pageUid' | 'pageVersionId' | 'format' | 'pageNumberStart' | 'pageNumberEnd'> & {
+    itemKind: DocmanDocumentSummaryEntryKind;
+    score: number;
+    excerpt: string;
+    matchedBy: DocmanDocumentAnswerPackMatchField[];
+    summaryText?: string;
+    lexicalScore: number;
+    semanticScore?: number;
+};
+export type DocmanDocumentAnswerPackProvenance = {
+    strategy: 'deterministic-answer-pack-v1' | 'hybrid-answer-pack-v1' | 'semantic-answer-pack-v1';
+    retrievalStrategy: DocmanDocumentRetrievalStrategy;
+    citationCount: number;
+    selectedAnchor?: string;
+    selectedItemKind?: DocmanDocumentSummaryEntryKind;
+    primaryMatchedBy: DocmanDocumentAnswerPackMatchField[];
+    vectorAvailable: boolean;
+    vectorProvider?: string;
+    vectorModel?: string;
+};
+export type DocmanDocumentAnswerPackResult = {
+    documentVersionId: string;
+    locale?: string;
+    fallbackLocale?: string;
+    q: string;
+    built: boolean;
+    buildFingerprint?: string;
+    answer: string;
+    answerSource: DocmanDocumentAnswerPackAnswerSource;
+    citations: DocmanDocumentAnswerPackCitation[];
+    provenance: DocmanDocumentAnswerPackProvenance;
+};
+export interface IDocumentServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmDocument>): Effect.Effect<IbmDocument | null, DocumentServiceError>;
+    create(data: IbmDocumentInsert): Effect.Effect<IbmDocument, DocumentServiceError>;
+    listDocuments(filter?: Partial<IbmDocument>, options?: DocumentListOptions): Effect.Effect<IbmDocumentWithVersions[], DocumentServiceError>;
+    updateDocument(id: string, patch: Partial<IbmDocument>): Effect.Effect<IbmDocument, DocumentServiceError>;
+    removeDocument(id: string): Effect.Effect<void, DocumentServiceError>;
+    removeDocumentSafe(id: string, confirmName: string): Effect.Effect<DocmanDocumentDeleteReport, DocumentServiceError>;
+    buildDocumentIndex(documentVersionId: string, options?: DocumentLocaleOptions): Effect.Effect<DocmanDocumentComposeIndex, DocumentServiceError>;
+    buildPersistedDocumentIndex(input: DocmanDocumentIndexBuildInput): Effect.Effect<DocmanDocumentIndexSnapshot, DocumentServiceError>;
+    getPersistedDocumentIndex(input: DocmanDocumentIndexGetInput): Effect.Effect<DocmanDocumentIndexSnapshot, DocumentServiceError>;
+    buildPersistedDocumentSummary(input: DocmanDocumentSummaryBuildInput): Effect.Effect<DocmanDocumentSummarySnapshot, DocumentServiceError>;
+    getPersistedDocumentSummary(input: DocmanDocumentSummaryGetInput): Effect.Effect<DocmanDocumentSummarySnapshot, DocumentServiceError>;
+    searchPersistedDocumentIndex(input: DocmanDocumentSearchInput): Effect.Effect<DocmanDocumentSearchResult, DocumentServiceError>;
+    searchScopePersistedDocumentIndex(input: DocmanScopeDocumentSearchInput): Effect.Effect<DocmanScopeDocumentSearchResult, DocumentServiceError>;
+    getDocumentAnswerPack(input: DocmanDocumentAnswerPackInput): Effect.Effect<DocmanDocumentAnswerPackResult, DocumentServiceError>;
+    fetchComposedFragment(input: DocmanDocumentComposeFetchInput): Effect.Effect<DocmanDocumentComposeFetchResult, DocumentServiceError>;
+    materializePublishedFragment(input: DocmanDocumentPublishMaterializeInput): Effect.Effect<DocmanDocumentPublishMaterializeResult, DocumentServiceError>;
+}
+export interface IDocumentLookupPort {
+    getById(id: string): Effect.Effect<IbmDocument | null, DocumentServiceError>;
+}

package/dist/application/ports/inbound/IDocumentServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IDocumentVersionServicePort.d.ts

@@ -0,0 +1,106 @@
+import { Effect } from 'effect';
+import { DocumentVersionServiceError } from '../../errors/DocumentVersionServiceError.js';
+import { IbmDocumentVersion, IbmDocumentVersionInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import type { DocmanDocumentVersionDeleteReport } from '../../services/documentCascadeDelete.js';
+export type DocmanDocumentVersionSetCurrentInput = {
+    documentVersionId: string;
+    documentId?: string;
+    publish?: boolean;
+    publishedAt?: Date | string;
+    expectedPreviousVersionId?: string;
+};
+export type DocmanDocumentVersionSetCurrentResult = {
+    documentId: string;
+    currentVersionId: string;
+    previousCurrentVersionIds: string[];
+    changed: boolean;
+    publishedAt: Date | null;
+    status: string | null;
+    warnings: string[];
+};
+export type DocmanParsedHeadingGraphNodeKind = 'section' | 'page';
+export type DocmanParsedHeadingGraphNode = {
+    kind: DocmanParsedHeadingGraphNodeKind;
+    title: string;
+    depth?: number;
+    slug?: string;
+    bodyMarkdown?: string;
+    children?: DocmanParsedHeadingGraphNode[];
+};
+export type DocmanParsedHeadingGraph = {
+    sourceHash?: string;
+    sourcePath?: string;
+    nodes: DocmanParsedHeadingGraphNode[];
+};
+export type DocmanHeadingImportExistingGraphPolicy = 'error' | 'append' | 'replace';
+export type DocmanHeadingImportSlugStrategy = 'hash-suffix-on-collision' | 'kebab-from-title';
+export type DocmanHeadingImportBodyAssignment = 'leaf-page-content';
+export type DocmanHeadingImportPagePolicy = 'h4-and-below';
+export type DocmanDocumentVersionImportHeadingsInput = {
+    documentVersionId: string;
+    scopeId: string;
+    parsedGraph: DocmanParsedHeadingGraph;
+    options?: {
+        dryRun?: boolean;
+        existingGraphPolicy?: DocmanHeadingImportExistingGraphPolicy;
+        slugStrategy?: DocmanHeadingImportSlugStrategy;
+        bodyAssignment?: DocmanHeadingImportBodyAssignment;
+        headingToPagePolicy?: DocmanHeadingImportPagePolicy;
+        synthesizeOverviewPages?: boolean;
+    };
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type DocmanHeadingImportWarning = {
+    code: string;
+    message: string;
+    path?: string;
+};
+export type DocmanImportedSectionGraphItem = {
+    title: string;
+    slug?: string;
+    depth: number;
+    position: number;
+    parentLinkId?: string;
+    sectionId?: string;
+    documentSectionLinkId?: string;
+};
+export type DocmanImportedPageGraphItem = {
+    title: string;
+    depth: number;
+    position: number;
+    parentLinkId?: string;
+    pageId?: string;
+    pageVersionId?: string;
+    documentSectionLinkId?: string;
+    sectionPageLinkId?: string;
+};
+export type DocmanDocumentVersionImportHeadingsResult = {
+    documentVersionId: string;
+    dryRun: boolean;
+    summary: {
+        sectionsCreated: number;
+        pagesCreated: number;
+        documentLinksCreated: number;
+        sectionPageLinksCreated: number;
+        warnings: DocmanHeadingImportWarning[];
+    };
+    graph: {
+        sections: DocmanImportedSectionGraphItem[];
+        pages: DocmanImportedPageGraphItem[];
+    };
+};
+export interface IDocumentVersionServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmDocumentVersion>): Effect.Effect<IbmDocumentVersion | null, DocumentVersionServiceError>;
+    create(data: IbmDocumentVersionInsert): Effect.Effect<IbmDocumentVersion, DocumentVersionServiceError>;
+    listDocumentVersions(filter?: Partial<IbmDocumentVersion>, options?: DbQueryOptions<IbmDocumentVersion>): Effect.Effect<IbmDocumentVersion[], DocumentVersionServiceError>;
+    updateDocumentVersion(id: string, patch: Partial<IbmDocumentVersion>): Effect.Effect<IbmDocumentVersion, DocumentVersionServiceError>;
+    removeDocumentVersion(id: string): Effect.Effect<void, DocumentVersionServiceError>;
+    removeDocumentVersionSafe(id: string): Effect.Effect<DocmanDocumentVersionDeleteReport, DocumentVersionServiceError>;
+    importHeadings(input: DocmanDocumentVersionImportHeadingsInput): Effect.Effect<DocmanDocumentVersionImportHeadingsResult, DocumentVersionServiceError>;
+    setCurrent(input: DocmanDocumentVersionSetCurrentInput): Effect.Effect<DocmanDocumentVersionSetCurrentResult, DocumentVersionServiceError>;
+}
+export interface IDocumentVersionLookupPort {
+    getById(id: string): Effect.Effect<IbmDocumentVersion | null, DocumentVersionServiceError>;
+}

package/dist/application/ports/inbound/IDocumentVersionServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IEmbedServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { EmbedServiceError } from '../../errors/EmbedServiceError.js';
+import { IbmEmbed, IbmEmbedInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+export interface IEmbedServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmEmbed>): Effect.Effect<IbmEmbed | null, EmbedServiceError>;
+    create(data: IbmEmbedInsert): Effect.Effect<IbmEmbed, EmbedServiceError>;
+    listEmbeds(filter?: Partial<IbmEmbed>, options?: DbQueryOptions<IbmEmbed>): Effect.Effect<IbmEmbed[], EmbedServiceError>;
+    updateEmbed(id: string, patch: Partial<IbmEmbed>): Effect.Effect<IbmEmbed, EmbedServiceError>;
+    removeEmbed(id: string): Effect.Effect<void, EmbedServiceError>;
+}
+export interface IEmbedLookupPort {
+    getById(id: string): Effect.Effect<IbmEmbed | null, EmbedServiceError>;
+}

package/dist/application/ports/inbound/IEmbedServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IPageEmbedLinkServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { PageEmbedLinkServiceError } from '../../errors/PageEmbedLinkServiceError.js';
+import { IbmPageEmbedLink, IbmPageEmbedLinkInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+export interface IPageEmbedLinkServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmPageEmbedLink>): Effect.Effect<IbmPageEmbedLink | null, PageEmbedLinkServiceError>;
+    create(data: IbmPageEmbedLinkInsert): Effect.Effect<IbmPageEmbedLink, PageEmbedLinkServiceError>;
+    listPageEmbedLinks(filter?: Partial<IbmPageEmbedLink>, options?: DbQueryOptions<IbmPageEmbedLink>): Effect.Effect<IbmPageEmbedLink[], PageEmbedLinkServiceError>;
+    updatePageEmbedLink(id: string, patch: Partial<IbmPageEmbedLink>): Effect.Effect<IbmPageEmbedLink, PageEmbedLinkServiceError>;
+    removePageEmbedLink(id: string): Effect.Effect<void, PageEmbedLinkServiceError>;
+}
+export interface IPageEmbedLinkLookupPort {
+    getById(id: string): Effect.Effect<IbmPageEmbedLink | null, PageEmbedLinkServiceError>;
+}

package/dist/application/ports/inbound/IPageEmbedLinkServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IPageServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { PageServiceError } from '../../errors/PageServiceError.js';
+import { IbmPage, IbmPageInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+export interface IPageServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmPage>): Effect.Effect<IbmPage | null, PageServiceError>;
+    create(data: IbmPageInsert): Effect.Effect<IbmPage, PageServiceError>;
+    listPages(filter?: Partial<IbmPage>, options?: DbQueryOptions<IbmPage>): Effect.Effect<IbmPage[], PageServiceError>;
+    updatePage(id: string, patch: Partial<IbmPage>): Effect.Effect<IbmPage, PageServiceError>;
+    removePage(id: string): Effect.Effect<void, PageServiceError>;
+}
+export interface IPageLookupPort {
+    getById(id: string): Effect.Effect<IbmPage | null, PageServiceError>;
+}

package/dist/application/ports/inbound/IPageServicePort.js

@@ -0,0 +1 @@
+export {};

package/dist/application/ports/inbound/IPageSnippetLinkServicePort.d.ts

@@ -0,0 +1,14 @@
+import { Effect } from 'effect';
+import { PageSnippetLinkServiceError } from '../../errors/PageSnippetLinkServiceError.js';
+import { IbmPageSnippetLink, IbmPageSnippetLinkInsert } from '../../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+export interface IPageSnippetLinkServicePort {
+    getById(id: string, options?: DbQueryOptions<IbmPageSnippetLink>): Effect.Effect<IbmPageSnippetLink | null, PageSnippetLinkServiceError>;
+    create(data: IbmPageSnippetLinkInsert): Effect.Effect<IbmPageSnippetLink, PageSnippetLinkServiceError>;
+    listPageSnippetLinks(filter?: Partial<IbmPageSnippetLink>, options?: DbQueryOptions<IbmPageSnippetLink>): Effect.Effect<IbmPageSnippetLink[], PageSnippetLinkServiceError>;
+    updatePageSnippetLink(id: string, patch: Partial<IbmPageSnippetLink>): Effect.Effect<IbmPageSnippetLink, PageSnippetLinkServiceError>;
+    removePageSnippetLink(id: string): Effect.Effect<void, PageSnippetLinkServiceError>;
+}
+export interface IPageSnippetLinkLookupPort {
+    getById(id: string): Effect.Effect<IbmPageSnippetLink | null, PageSnippetLinkServiceError>;
+}

package/dist/application/ports/inbound/IPageSnippetLinkServicePort.js

@@ -0,0 +1 @@
+export {};