@aopslab/domain-dm-docman 0.1.2

package/dist/application/services/service.assetVersion.d.ts

@@ -0,0 +1,25 @@
+import { Effect } from 'effect';
+import { XfLogger } from '@aopslab/xf-logger';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import type { IRepositoryPortAssetVersion } from '../ports/repository-ports/index.js';
+import type { IAssetVersionServicePort } from '../ports/inbound/index.js';
+import { AssetVersionServiceError } from '../errors/AssetVersionServiceError.js';
+import { IbmAssetVersion, IbmAssetVersionInsert, IbmAssetVersionPatch } from '../../domain/models/index.js';
+export interface AssetVersionServiceDependencies {
+}
+export interface AssetVersionServiceOptions {
+    assetVersionRepository: IRepositoryPortAssetVersion;
+    serviceDependencies?: Partial<AssetVersionServiceDependencies>;
+    logger?: XfLogger;
+    locale?: string;
+}
+export declare class AssetVersionService implements IAssetVersionServicePort {
+    private readonly assetVersionRepository;
+    private readonly logger?;
+    constructor(options: AssetVersionServiceOptions);
+    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>;
+}

package/dist/application/services/service.assetVersion.js

@@ -0,0 +1,58 @@
+import { Effect } from 'effect';
+import { pipe } from 'effect/Function';
+import { validateInput, XfErrorFactory, effectErrorInfo } from '@aopslab/xf-core';
+import { mapDbError } from '@aopslab/xf-db';
+import { assetVersionMutablePatchZodSchema, assetVersionZodSchemaInsert, } from '../../domain/models/index.js';
+import { validateBmInputWithSchema } from './service.zod-validation.js';
+export class AssetVersionService {
+    assetVersionRepository;
+    logger;
+    constructor(options) {
+        this.assetVersionRepository = options.assetVersionRepository;
+        this.logger = options.logger?.child({ module: this.constructor.name });
+    }
+    getById(id, options) {
+        const stage = 'AssetVersionService::getById';
+        return pipe(validateInput(id, 'id', { stage }), Effect.flatMap((entityId) => this.assetVersionRepository.findById(entityId, options).pipe(Effect.mapError(mapDbError({ stage, operation: 'findById', factory: XfErrorFactory.notFound })))), Effect.tapError((e) => Effect.sync(() => {
+            const info = effectErrorInfo(e);
+            this.logger?.error({ error: info.unwrapped, stage }, 'Error in getById');
+        })));
+    }
+    create(data) {
+        const stage = 'AssetVersionService::create';
+        return pipe(validateInput(data, 'data', { stage }), Effect.flatMap((input) => validateBmInputWithSchema({
+            input,
+            schema: assetVersionZodSchemaInsert,
+            stage,
+            operation: 'AssetVersionService::create.assetVersionZodSchemaInsert',
+            field: 'data',
+        })), Effect.flatMap((input) => this.assetVersionRepository.create(input).pipe(Effect.mapError(mapDbError({ stage, operation: 'create', factory: XfErrorFactory.createFailed })))));
+    }
+    listAssetVersions(filter = {}, options) {
+        const stage = 'AssetVersionService::listAssetVersions';
+        return pipe(validateInput(filter, 'filter', { stage }), Effect.flatMap((matchEq) => this.assetVersionRepository.find({ matchEq, options }).pipe(Effect.mapError(mapDbError({ stage, operation: 'find', factory: XfErrorFactory.notFound })))), Effect.tapError((e) => Effect.sync(() => {
+            const info = effectErrorInfo(e);
+            this.logger?.error({ error: info.unwrapped, stage }, 'Error in listAssetVersions');
+        })));
+    }
+    updateAssetVersion(id, patch) {
+        const stage = 'AssetVersionService::updateAssetVersion';
+        if (!patch || Object.keys(patch).length === 0) {
+            return Effect.fail(XfErrorFactory.inputRequired({ field: 'patch', stage }));
+        }
+        return pipe(validateInput(id, 'id', { stage }), Effect.flatMap((entityId) => validateBmInputWithSchema({
+            input: patch,
+            schema: assetVersionMutablePatchZodSchema,
+            stage,
+            operation: 'AssetVersionService::updateAssetVersion.assetVersionMutablePatchZodSchema',
+            field: 'patch',
+        }).pipe(Effect.map(() => entityId))), Effect.flatMap((entityId) => this.assetVersionRepository.patchById(entityId, patch).pipe(Effect.mapError(mapDbError({ stage, operation: 'patchById', factory: XfErrorFactory.upsertFailed })))), Effect.tapError((e) => Effect.sync(() => {
+            const info = effectErrorInfo(e);
+            this.logger?.error({ error: info.unwrapped, stage }, 'Error in updateAssetVersion');
+        })));
+    }
+    removeAssetVersion(id) {
+        const stage = 'AssetVersionService::removeAssetVersion';
+        return pipe(validateInput(id, 'id', { stage }), Effect.flatMap((entityId) => this.assetVersionRepository.deleteById(entityId).pipe(Effect.mapError(mapDbError({ stage, operation: 'deleteById', factory: XfErrorFactory.upsertFailed })))), Effect.map(() => undefined));
+    }
+}

package/dist/application/services/service.document.d.ts

@@ -0,0 +1,167 @@
+import { Effect } from 'effect';
+import { XfLogger } from '@aopslab/xf-logger';
+import type { IRepositoryPortAsset, IRepositoryPortAssetVersion, IRepositoryPortDocument, IRepositoryPortDocumentIndexEntry, IRepositoryPortDocumentSectionLink, IRepositoryPortDocumentVersion, IRepositoryPortPage, IRepositoryPortPageEmbedLink, IRepositoryPortPageSnippetLink, IRepositoryPortPageVersion, IRepositoryPortSection, IRepositoryPortSectionPageLink } from '../ports/repository-ports/index.js';
+import type { DocmanDocumentAnswerPackInput, DocmanDocumentAnswerPackResult, DocmanDocumentComposeFetchInput, DocmanDocumentComposeFetchResult, DocmanDocumentComposeIndex, DocmanDocumentIndexBuildInput, DocmanDocumentIndexGetInput, DocmanDocumentSummaryBuildInput, DocmanDocumentSummaryGetInput, DocmanDocumentSearchInput, DocmanDocumentSearchResult, DocmanScopeDocumentSearchInput, DocmanScopeDocumentSearchResult, DocmanDocumentIndexSnapshot, DocmanDocumentSummarySnapshot, DocmanDocumentPublishMaterializeInput, DocmanDocumentPublishMaterializeResult, DocumentListOptions, DocumentLocaleOptions, IbmDocumentWithVersions, IDocumentServicePort } from '../ports/inbound/index.js';
+import { DocumentServiceError } from '../errors/DocumentServiceError.js';
+import { IbmDocument, IbmDocumentInsert } from '../../domain/models/index.js';
+import { DbQueryOptions } from '@aopslab/xf-db';
+import { type DocmanDocumentDeleteReport } from './documentCascadeDelete.js';
+import { type DocmanEmbeddingProvider } from './documentRetrievalAiSupport.js';
+export interface DocumentServiceDependencies {
+    assetRepository?: IRepositoryPortAsset;
+    assetVersionRepository?: IRepositoryPortAssetVersion;
+    documentVersionRepository?: IRepositoryPortDocumentVersion;
+    documentIndexEntryRepository?: IRepositoryPortDocumentIndexEntry;
+    documentSectionLinkRepository?: IRepositoryPortDocumentSectionLink;
+    sectionRepository?: IRepositoryPortSection;
+    pageRepository?: IRepositoryPortPage;
+    pageVersionRepository?: IRepositoryPortPageVersion;
+    sectionPageLinkRepository?: IRepositoryPortSectionPageLink;
+    pageSnippetLinkRepository?: IRepositoryPortPageSnippetLink;
+    pageEmbedLinkRepository?: IRepositoryPortPageEmbedLink;
+    embeddingProvider?: DocmanEmbeddingProvider;
+}
+export interface DocumentServiceOptions {
+    documentRepository: IRepositoryPortDocument;
+    serviceDependencies?: Partial<DocumentServiceDependencies>;
+    logger?: XfLogger;
+    locale?: string;
+}
+export declare class DocumentService implements IDocumentServicePort {
+    private readonly documentRepository;
+    private readonly assetRepository?;
+    private readonly assetVersionRepository?;
+    private readonly documentVersionRepository?;
+    private readonly documentIndexEntryRepository?;
+    private readonly documentSectionLinkRepository?;
+    private readonly sectionRepository?;
+    private readonly pageRepository?;
+    private readonly pageVersionRepository?;
+    private readonly sectionPageLinkRepository?;
+    private readonly pageSnippetLinkRepository?;
+    private readonly pageEmbedLinkRepository?;
+    private readonly embeddingProvider;
+    private readonly logger?;
+    private readonly locale?;
+    constructor(options: DocumentServiceOptions);
+    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>;
+    buildDocumentIndex(documentVersionId: string, options?: DocumentLocaleOptions): Effect.Effect<DocmanDocumentComposeIndex, DocumentServiceError>;
+    buildPersistedDocumentIndex(input: DocmanDocumentIndexBuildInput): Effect.Effect<DocmanDocumentIndexSnapshot, DocumentServiceError>;
+    private buildPersistedDocumentIndexForResolvedInput;
+    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>;
+    removeDocumentSafe(id: string, confirmName: string): Effect.Effect<DocmanDocumentDeleteReport, DocumentServiceError>;
+    private resolveComposedDocument;
+    private composeDynamicPages;
+    private createEmptyPage;
+    private toDocumentComposeIndex;
+    private resolveDocumentIndexLocaleKey;
+    private listPersistedDocumentIndexRows;
+    private deletePersistedDocumentIndexRows;
+    private createPersistedDocumentIndexRows;
+    private matchesPersistedDocumentIndexRows;
+    private matchesPersistedDocumentIndexRow;
+    private persistedDocumentIndexRowKey;
+    private normalizePersistedDocumentIndexComparableValue;
+    private buildPersistedDocumentIndexBuildKey;
+    private toPersistedDocumentIndexRows;
+    private toPersistedDocumentIndexSnapshot;
+    private toPersistedDocumentSummarySnapshot;
+    private toPersistedDocumentIndexSnapshotEntry;
+    private toPersistedDocumentSummarySnapshotEntry;
+    private buildDocumentAnswerPack;
+    private toDocumentAnswerPackCitation;
+    private analyzeDocumentAnswerPackRow;
+    private buildDocumentAnswerPackExcerpt;
+    private resolveDocumentAnswerPackKindPriority;
+    private selectDocumentAnswerPackAnswer;
+    private searchPersistedDocumentIndexRows;
+    private toPersistedDocumentSearchHit;
+    private toDocumentIndexBoolean;
+    private toNonNegativeInteger;
+    private scorePersistedDocumentIndexRow;
+    private resolveDocumentRetrievalStrategy;
+    private toDocumentAnswerPackProvenanceStrategy;
+    private toDocumentSearchProvenance;
+    private toDocumentSearchStrategy;
+    private resolveScopeSearchDocumentSeed;
+    private toScopeDocumentSearchHit;
+    private describeScopeSearchError;
+    private rankPersistedDocumentSearchRows;
+    private rankDocumentAnswerPackRows;
+    private applySemanticScoreToMatch;
+    private resolvePersistedDocumentSemanticScore;
+    private resolveDocumentVectorState;
+    private buildPersistedDocumentIndexExcerpt;
+    private extractExcerpt;
+    private resolveDocumentIndexSearchLimit;
+    private resolveDocumentAnswerPackLimit;
+    private tokenizeDocumentIndexSearchTokens;
+    private normalizeDocumentIndexSearchText;
+    private buildPersistedDocumentIndexEmbeddingText;
+    private populatePersistedDocumentIndexEmbeddings;
+    private refreshPersistedDocumentIndexEmbeddings;
+    private extractDocumentIndexBodyText;
+    private resolvePersistedDocumentAuthoredSummaryText;
+    private toPersistedDocumentSummaryPatches;
+    private buildPersistedDocumentSummaryMetrics;
+    private normalizeDocumentSummarySourceText;
+    private buildDeterministicDocumentSummaryText;
+    private truncateDocumentSummaryText;
+    private countDocumentSummaryWords;
+    private buildPersistedDocumentPageRanges;
+    private buildDocumentIndexBreadcrumb;
+    private renderDocumentSourceBundleFromResolved;
+    private renderSectionSourceBundleFromSection;
+    private renderSinglePageItemSourceBundle;
+    private renderPageSourceBundle;
+    private materializePublishContent;
+    private materializeMarkdownPublishContent;
+    private materializeHtmlPublishContent;
+    private tokenizeHtmlMaterializationBlocks;
+    private renderMarkdownBlockToHtml;
+    private buildPublishedHtmlDocument;
+    private toPublishedHtmlTitle;
+    private isHtmlLikeStandaloneLine;
+    private pushPublishWarning;
+    private renderSectionHeading;
+    private renderPageBody;
+    private splitContentByPageBreakMarkers;
+    private collectSubtreeItems;
+    private resolveDocumentTitle;
+    private resolveSectionTitle;
+    private resolvePageTitle;
+    private resolvePageContent;
+    private resolveComposePageSource;
+    private resolveVersionReleaseNotes;
+    private resolveAssetReferenceToken;
+    private resolveAssetHref;
+    private uniqueAssetRefs;
+    private uniqueModulePreambles;
+    private prependModulePreambles;
+    private stripDocumentListOptions;
+    private resolveLocaleOptions;
+    private normalizeLocale;
+    private normalizeNonEmpty;
+    private escapeHtml;
+    private resolveLocalizedValue;
+    private buildLanguageCandidates;
+    private withLocaleOptions;
+    private traverseLinks;
+    private resolveNumber;
+    private pushUnique;
+    private joinMarkdown;
+    private resolveCascadeDependencies;
+    private requireDependency;
+    private normalizeCascadeError;
+}