@aopslab/domain-kit-docman 0.1.4

package/dist/operations/host-projection.js

@@ -0,0 +1,156 @@
+import { buildDocmanDomainCapabilityManifest } from './dcm.js';
+const CRUD_KINDS = new Set(['list', 'get', 'create', 'update', 'delete']);
+const CUSTOM_ROUTE_OVERRIDES = {
+    'document.delete.safe': {
+        method: 'DELETE',
+        pattern: '/documents/:id/safe',
+        summary: 'Safely delete document'
+    },
+    'document-version.delete.safe': {
+        method: 'DELETE',
+        pattern: '/document-versions/:id/safe',
+        summary: 'Safely delete document version'
+    },
+    'document-version.import-headings': {
+        method: 'POST',
+        pattern: '/document-versions/:id/import-headings',
+        summary: 'Import parsed heading graph into document version'
+    },
+    'document.compose.index': {
+        method: 'POST',
+        pattern: '/document-versions/:id/compose-index',
+        summary: 'Build composed index for document version'
+    },
+    'document.index.build': {
+        method: 'POST',
+        pattern: '/document-versions/:id/index',
+        summary: 'Build persisted retrieval index for document version'
+    },
+    'document.index.get': {
+        method: 'GET',
+        pattern: '/document-versions/:id/index',
+        summary: 'Get persisted retrieval index for document version'
+    },
+    'document.summary.build': {
+        method: 'POST',
+        pattern: '/document-versions/:id/summaries',
+        summary: 'Build persisted summaries for document version'
+    },
+    'document.summary.get': {
+        method: 'GET',
+        pattern: '/document-versions/:id/summaries',
+        summary: 'Get persisted summaries for document version'
+    },
+    'document.search': {
+        method: 'GET',
+        pattern: '/document-versions/:id/search',
+        summary: 'Search persisted retrieval index for document version'
+    },
+    'document.scope.search': {
+        method: 'GET',
+        pattern: '/scopes/:id/documents/search',
+        summary: 'Search persisted retrieval index across latest document versions in one scope'
+    },
+    'document.answer-pack': {
+        method: 'GET',
+        pattern: '/document-versions/:id/answer-pack',
+        summary: 'Get deterministic answer pack for document version'
+    },
+    'document.compose.fetch': {
+        method: 'POST',
+        pattern: '/document-versions/:id/compose-fetch',
+        summary: 'Fetch composed fragment'
+    },
+    'document.publish.materialize': {
+        method: 'POST',
+        pattern: '/document-versions/:id/materialize',
+        summary: 'Materialize publish fragment'
+    },
+    'document-section-link.usage.list': {
+        method: 'GET',
+        pattern: '/sections/:id/document-link-usage',
+        summary: 'List document section-link usage by section'
+    }
+};
+function parseCrudOperation(operationId) {
+    const segments = operationId.split('.').map((segment) => segment.trim()).filter(Boolean);
+    if (segments.length !== 2)
+        return null;
+    const [entity, kindRaw] = segments;
+    if (!CRUD_KINDS.has(kindRaw))
+        return null;
+    return {
+        entity,
+        kind: kindRaw
+    };
+}
+function pluralizePathSegment(segment) {
+    const normalized = segment.trim();
+    if (!normalized)
+        return normalized;
+    if (normalized.endsWith('s'))
+        return `${normalized}es`;
+    return `${normalized}s`;
+}
+function toCrudRoute(operationId, summary) {
+    const parsed = parseCrudOperation(operationId);
+    if (!parsed)
+        return null;
+    const resourcePath = `/${pluralizePathSegment(parsed.entity)}`;
+    const id = `docman.${operationId.replace(/\./g, '.')}`;
+    if (parsed.kind === 'list') {
+        return { id, method: 'GET', pattern: resourcePath, operation: operationId, ...(summary ? { summary } : {}) };
+    }
+    if (parsed.kind === 'get') {
+        return { id, method: 'GET', pattern: `${resourcePath}/:id`, operation: operationId, ...(summary ? { summary } : {}) };
+    }
+    if (parsed.kind === 'create') {
+        return { id, method: 'POST', pattern: resourcePath, operation: operationId, ...(summary ? { summary } : {}) };
+    }
+    if (parsed.kind === 'update') {
+        return { id, method: 'PATCH', pattern: `${resourcePath}/:id`, operation: operationId, ...(summary ? { summary } : {}) };
+    }
+    return { id, method: 'DELETE', pattern: `${resourcePath}/:id`, operation: operationId, ...(summary ? { summary } : {}) };
+}
+function toCustomFallbackRoute(operationId, summary) {
+    const normalizedPath = operationId.replace(/\./g, '/');
+    const id = `docman.${operationId.replace(/\./g, '-')}`;
+    return {
+        id,
+        method: 'POST',
+        pattern: `/operations/${normalizedPath}`,
+        operation: operationId,
+        ...(summary ? { summary } : {})
+    };
+}
+function toRouteFromOperation(operationId, summary) {
+    const override = CUSTOM_ROUTE_OVERRIDES[operationId];
+    if (override) {
+        return {
+            id: `docman.${operationId.replace(/\./g, '-')}`,
+            method: override.method,
+            pattern: override.pattern,
+            operation: operationId,
+            summary: override.summary ?? summary
+        };
+    }
+    const crudRoute = toCrudRoute(operationId, summary);
+    if (crudRoute)
+        return crudRoute;
+    return toCustomFallbackRoute(operationId, summary);
+}
+export function buildDocmanHostRouteProjection(options) {
+    const manifest = buildDocmanDomainCapabilityManifest({
+        refresh: options?.refresh,
+        includeDocs: true
+    });
+    const unique = new Map();
+    for (const operation of manifest.capabilities.operations) {
+        const summary = manifest.docs?.operations?.[operation.operationId]?.summary ?? operation.title;
+        const route = toRouteFromOperation(operation.operationId, summary);
+        const key = `${route.method} ${route.pattern}`;
+        if (!unique.has(key))
+            unique.set(key, route);
+    }
+    return [...unique.values()].sort((left, right) => left.operation.localeCompare(right.operation));
+}

package/dist/operations/index.d.ts

@@ -0,0 +1,10 @@
+export * from './types.js';
+export * from './definition.js';
+export * from './io-types.js';
+export * from './schemas.js';
+export * from './host-projection.js';
+export * from './catalog.js';
+export * from './tool-input.js';
+export * from './contract.js';
+export * from './executor.js';
+export * from './dcm.js';

package/dist/operations/index.js

@@ -0,0 +1,10 @@
+export * from './types.js';
+export * from './definition.js';
+export * from './io-types.js';
+export * from './schemas.js';
+export * from './host-projection.js';
+export * from './catalog.js';
+export * from './tool-input.js';
+export * from './contract.js';
+export * from './executor.js';
+export * from './dcm.js';

package/dist/operations/io-types.d.ts

@@ -0,0 +1,125 @@
+import type { IbmDocument, IbmDocumentInsert } from '@aopslab/domain-dm-docman/models';
+import type { DocmanComposeSourceFormat, DocmanDocumentAnswerPackInput, DocmanDocumentAnswerPackResult, DocmanDocumentComposeFetchInput, DocmanDocumentComposeFetchResult, DocmanDocumentComposeIndex, DocmanDocumentIndexBuildInput, DocmanDocumentIndexGetInput, DocmanDocumentIndexSnapshot, DocmanDocumentSummaryBuildInput, DocmanDocumentSummaryGetInput, DocmanDocumentSummarySnapshot, DocmanDocumentSearchInput, DocmanDocumentSearchResult, DocmanDocumentPublishMaterializeInput, DocmanDocumentPublishMaterializeResult, DocmanDocumentVersionImportHeadingsInput, DocmanDocumentVersionImportHeadingsResult, DocmanScopeDocumentSearchInput, DocmanScopeDocumentSearchResult, DocmanPublishTarget, DocmanPublishedFragmentWarning, DocumentListOptions, DocmanResolvedAssetReference, IbmDocumentWithVersions } from '@aopslab/domain-dm-docman/ports';
+import type { DocumentSectionLinkUsageItem } from '@aopslab/domain-dm-docman/repository-ports';
+export type { DocmanDocumentComposeFetchInput, DocmanDocumentComposeFetchResult, DocmanDocumentComposeIndex, DocmanDocumentAnswerPackInput, DocmanDocumentAnswerPackResult, DocmanDocumentIndexBuildInput, DocmanDocumentIndexGetInput, DocmanDocumentIndexSnapshot, DocmanDocumentSummaryBuildInput, DocmanDocumentSummaryGetInput, DocmanDocumentSummarySnapshot, DocmanDocumentSearchInput, DocmanDocumentSearchResult, DocmanScopeDocumentSearchInput, DocmanScopeDocumentSearchResult, DocmanDocumentPublishMaterializeInput, DocmanDocumentPublishMaterializeResult, DocmanDocumentVersionImportHeadingsInput, DocmanDocumentVersionImportHeadingsResult, DocmanComposeSourceFormat, DocmanPublishTarget, DocmanPublishedFragmentWarning, DocmanResolvedAssetReference, DocumentListOptions, IbmDocument, IbmDocumentInsert, IbmDocumentWithVersions, };
+export type DocmanCrudEntity = 'document' | 'document-group' | 'document-version' | 'section' | 'page' | 'page-version' | 'document-section-link' | 'section-page-link' | 'snippet' | 'page-snippet-link' | 'asset' | 'asset-version' | 'embed' | 'page-embed-link';
+export type DocmanCrudKind = 'list' | 'get' | 'create' | 'update' | 'delete';
+export type DocmanCrudOperationId = `${DocmanCrudEntity}.${DocmanCrudKind}`;
+type DocmanCrudInput<TId extends DocmanCrudOperationId> = TId extends `${string}.list` ? {
+    filter?: Record<string, unknown>;
+    options?: DocumentListOptions;
+} : TId extends `${string}.get` ? {
+    id: string;
+    options?: DocumentListOptions;
+} : TId extends `${string}.create` ? {
+    data: Record<string, unknown>;
+} : TId extends `${string}.update` ? {
+    id: string;
+    patch: Record<string, unknown>;
+} : {
+    id: string;
+};
+type DocmanCrudOutput<TId extends DocmanCrudOperationId> = TId extends `${string}.list` ? unknown[] : TId extends `${string}.get` ? unknown | null : TId extends `${string}.create` | `${string}.update` ? unknown : unknown;
+export type DocmanDocumentListOperationInput = {
+    filter?: Partial<IbmDocument>;
+    options?: DocumentListOptions;
+};
+export type DocmanDocumentGetOperationInput = {
+    id: string;
+    options?: DocumentListOptions;
+};
+export type DocmanDocumentCreateOperationInput = {
+    data: IbmDocumentInsert;
+};
+export type DocmanDocumentUpdateOperationInput = {
+    id: string;
+    patch: Partial<IbmDocument>;
+};
+export type DocmanDocumentComposeIndexOperationInput = {
+    documentVersionId: string;
+    options?: {
+        locale?: string;
+        fallbackLocale?: string;
+    };
+};
+export type DocmanDocumentIndexBuildOperationInput = DocmanDocumentIndexBuildInput;
+export type DocmanDocumentIndexGetOperationInput = DocmanDocumentIndexGetInput;
+export type DocmanDocumentSummaryBuildOperationInput = DocmanDocumentSummaryBuildInput;
+export type DocmanDocumentSummaryGetOperationInput = DocmanDocumentSummaryGetInput;
+export type DocmanDocumentSearchOperationInput = DocmanDocumentSearchInput;
+export type DocmanScopeDocumentSearchOperationInput = DocmanScopeDocumentSearchInput;
+export type DocmanDocumentAnswerPackOperationInput = DocmanDocumentAnswerPackInput;
+export type DocmanDocumentDeleteSafeOperationInput = {
+    id: string;
+    confirmName: string;
+};
+export type DocmanDocumentVersionDeleteSafeOperationInput = {
+    id: string;
+};
+export type DocmanDocumentVersionImportHeadingsOperationInput = DocmanDocumentVersionImportHeadingsInput;
+export type DocmanDocumentVersionSetCurrentOperationInput = {
+    documentVersionId: string;
+    documentId?: string;
+    publish?: boolean;
+    publishedAt?: Date | string;
+    expectedPreviousVersionId?: string;
+};
+export type DocmanDocumentVersionSetCurrentOperationOutput = {
+    documentId: string;
+    currentVersionId: string;
+    previousCurrentVersionIds: string[];
+    changed: boolean;
+    publishedAt: Date | null;
+    status: string | null;
+    warnings: string[];
+};
+export type DocmanDocumentSectionLinkUsageListOperationInput = {
+    sectionId: string;
+};
+type DocmanCustomOperationInputById = {
+    'document.compose.index': DocmanDocumentComposeIndexOperationInput;
+    'document.index.build': DocmanDocumentIndexBuildOperationInput;
+    'document.index.get': DocmanDocumentIndexGetOperationInput;
+    'document.summary.build': DocmanDocumentSummaryBuildOperationInput;
+    'document.summary.get': DocmanDocumentSummaryGetOperationInput;
+    'document.search': DocmanDocumentSearchOperationInput;
+    'document.scope.search': DocmanScopeDocumentSearchOperationInput;
+    'document.answer-pack': DocmanDocumentAnswerPackOperationInput;
+    'document.compose.fetch': DocmanDocumentComposeFetchInput;
+    'document.publish.materialize': DocmanDocumentPublishMaterializeInput;
+    'document.delete.safe': DocmanDocumentDeleteSafeOperationInput;
+    'document-version.delete.safe': DocmanDocumentVersionDeleteSafeOperationInput;
+    'document-version.import-headings': DocmanDocumentVersionImportHeadingsOperationInput;
+    'document-version.set-current': DocmanDocumentVersionSetCurrentOperationInput;
+    'document-section-link.usage.list': DocmanDocumentSectionLinkUsageListOperationInput;
+};
+type DocmanCustomOperationOutputById = {
+    'document.compose.index': DocmanDocumentComposeIndex;
+    'document.index.build': DocmanDocumentIndexSnapshot;
+    'document.index.get': DocmanDocumentIndexSnapshot;
+    'document.summary.build': DocmanDocumentSummarySnapshot;
+    'document.summary.get': DocmanDocumentSummarySnapshot;
+    'document.search': DocmanDocumentSearchResult;
+    'document.scope.search': DocmanScopeDocumentSearchResult;
+    'document.answer-pack': DocmanDocumentAnswerPackResult;
+    'document.compose.fetch': DocmanDocumentComposeFetchResult;
+    'document.publish.materialize': DocmanDocumentPublishMaterializeResult;
+    'document.delete.safe': unknown;
+    'document-version.delete.safe': unknown;
+    'document-version.import-headings': DocmanDocumentVersionImportHeadingsResult;
+    'document-version.set-current': DocmanDocumentVersionSetCurrentOperationOutput;
+    'document-section-link.usage.list': DocumentSectionLinkUsageItem[];
+};
+export type DocmanOperationInputById = {
+    [TId in DocmanCrudOperationId]: DocmanCrudInput<TId>;
+} & DocmanCustomOperationInputById;
+export type DocmanOperationOutputById = {
+    [TId in DocmanCrudOperationId]: DocmanCrudOutput<TId>;
+} & DocmanCustomOperationOutputById;
+export type DocmanTypedOperationId = Extract<keyof DocmanOperationInputById, string>;
+export type DocmanOperationHostContextInput = {
+    scopeId?: string;
+    scopeResolution?: 'explicit' | 'cascade';
+};
+export type DocmanOperationInput<TId extends DocmanTypedOperationId> = DocmanOperationInputById[TId] & DocmanOperationHostContextInput;
+export type DocmanOperationOutput<TId extends DocmanTypedOperationId> = DocmanOperationOutputById[TId];

package/dist/operations/io-types.js

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

package/dist/operations/schemas.d.ts

@@ -0,0 +1,10 @@
+import type { DocmanOperationSchemaRef } from './types.js';
+type JsonSchema = Record<string, unknown>;
+export declare function createDocmanSchemaRef(ref: string): DocmanOperationSchemaRef;
+export declare function getDocmanOperationIoSchemaRefs(operationId: string): {
+    inputRef: string;
+    outputRef: string;
+} | undefined;
+export declare function getDocmanContractSchema(ref: string): JsonSchema | undefined;
+export declare function resolveDocmanSchemaRefName(schema: unknown): string | undefined;
+export {};