@iwonz/ywtc 3.4.0 → 3.5.0

package/dist/report.d.ts

@@ -1,211 +1,32 @@
-import type { DiscoveredPage, GraphEdgeStatus, ProviderKind, SourceResource, SourceSelection, SourceStatus, TransferScope } from './domain.js';
-import { type IssueInput, type MigrationIssue } from './issues.js';
-import type { CommentTransferStatus, PageTransferStatus, ResourceTransferState, RunStatus, StateLoadSource } from './state.js';
-export type ReportInventoryStatus = 'pending' | 'complete' | 'failed';
-export type ReportResourceStatus = ResourceTransferState['status'];
-export interface TransferReportResource {
-    sourceId: string;
-    sourceName: string;
-    kind: Exclude<SourceResource['kind'], 'grid'>;
-    status: ReportResourceStatus;
-    sourceBytes?: number;
-    transferredBytes?: number;
-    destinationId?: string;
-    destinationName?: string;
-    error?: string;
-}
-export interface TransferReportPage {
-    sourceCanonicalId: string;
-    sourceId: string;
-    sourceTitle: string;
-    sourceUrl: string;
-    destinationId?: string;
-    destinationTitle?: string;
-    destinationUrl?: string;
-    parentId?: string;
-    depth: number;
-    status: PageTransferStatus;
-    inventoryStatus: ReportInventoryStatus;
-    resources: number;
-    resourceItems: TransferReportResource[];
-    sourceBytes?: number;
-    transferredBytes: number;
-    bytesUnknown: number;
-    links: number;
-    images: number;
-    tables: number;
-    grids: number;
-    codeBlocks: number;
-    degraded: boolean;
-    resourceFallbacks: Array<{
-        name: string;
-        error: string;
-    }>;
-    warnings: string[];
-    normalizations?: string[];
-    error?: string;
-    comments: {
-        status: CommentTransferStatus;
-        threads: number;
-        comments: number;
-        participants: number;
-        attachments: number;
-        bytes: number;
-        archiveName?: string;
-        destinationId?: string;
-        revision?: boolean;
-        stale?: boolean;
-        error?: string;
-        preview?: string;
-    };
-}
-export interface TransferReportEdge {
-    from: string;
-    raw: string;
-    to?: string;
-    status: GraphEdgeStatus;
-    message?: string;
-}
-export interface TransferReportIssue extends MigrationIssue {
-    pageTitle?: string;
-    pageAnchor?: string;
-    resourceName?: string;
-    action: string;
-}
-type PageStatusCounts = Record<PageTransferStatus, number>;
-type ResourceStatusCounts = Record<ReportResourceStatus, number>;
-type EdgeStatusCounts = Record<GraphEdgeStatus, number>;
-type CommentStatusCounts = Record<CommentTransferStatus, number>;
-export interface TransferReportSummary {
-    pages: number;
-    returnedDescendants: number;
-    selectedDescendants: number;
-    excludedPages: number;
-    maximumDepth: number;
-    hierarchyGaps: number;
-    hierarchyRepairs: number;
-    complete: number;
-    partial: number;
-    failed: number;
-    blocked: number;
-    conflicts: number;
-    unprocessedPages: number;
-    resources: number;
-    attachments: number;
-    resourceImages: number;
-    resourcesComplete: number;
-    resourcesPartial: number;
-    resourcesFailed: number;
-    resourcesPlanned: number;
-    bytes: number;
-    sourceBytes: number;
-    bytesUnknown: number;
-    links: number;
-    images: number;
-    tables: number;
-    grids: number;
-    codeBlocks: number;
-    cycles: number;
-    normalizations: number;
-    degradations: number;
-    warnings: number;
-    errors: number;
-    retryableFailures: number;
-    inventoryComplete: boolean;
-    inventoriedPages: number;
-    inventoryFailedPages: number;
-    commentThreads: number;
-    comments: number;
-    commentParticipants: number;
-    commentAttachments: number;
-    commentBytes: number;
-    commentStatuses: CommentStatusCounts;
-    durationMs?: number;
-    pageStatuses: PageStatusCounts;
-    resourceStatuses: ResourceStatusCounts;
-    traversalStatuses: EdgeStatusCounts;
-}
-export interface TransferReportData {
-    runId: string;
-    startedAt: string;
-    finishedAt?: string;
-    status: RunStatus;
-    dryRun: boolean;
-    commentsEnabled: boolean;
-    scope: TransferScope;
-    sourceStatus: SourceStatus;
-    selection: SourceSelection;
-    direction: string;
-    source: {
-        provider: ProviderKind;
-        profile: string;
-        rootId: string;
-        title: string;
-        url: string;
-    };
-    destination: {
-        provider: ProviderKind | 'filesystem';
-        profile?: string;
-        id: string;
-        url?: string;
-        format?: string;
-    };
-    state: {
-        id: string;
-        path: string;
-        mode: 'automatic' | 'explicit';
-        source: StateLoadSource;
-        backupPath?: string;
-    };
-    pages: TransferReportPage[];
-    edges: TransferReportEdge[];
-    hierarchyRepairs: Array<{
-        sourceCanonicalId: string;
-        mode: 'moved' | 'recreated';
-        oldParentId?: string;
-        newParentId: string;
-        oldDestinationId: string;
-        newDestinationId: string;
-        verified: boolean;
-    }>;
-    warnings: string[];
-    errors: string[];
-    issues: TransferReportIssue[];
-    outputs: Array<{
-        label: string;
-        value: string;
-    }>;
-    summary: TransferReportSummary;
-}
-export interface MigrationReportPaths {
-    runId: string;
-    directory: string;
-    html: string;
-    json: string;
-}
-interface PreviewPair {
-    source: string;
-    destination: string;
-}
+import type { DiscoveredPage, SourceSelection, SourceStatus } from './domain.js';
+import { type IssueInput } from './issues.js';
+import { type MigrationReportPaths, type PreviewPair, type ReportPresentationPayload, type TransferReportData, type TransferReportPage } from './report-contract.js';
+import type { RunStatus } from './state.js';
+export type { MigrationReportPaths, PreviewPair, ReportInventoryStatus, ReportPresentationPayload, ReportPresentationStatus, ReportResourceStatus, TransferReportCommentItem, TransferReportData, TransferReportEdge, TransferReportExcludedPage, TransferReportIssue, TransferReportPage, TransferReportResource, TransferReportSummary, } from './report-contract.js';
+export declare const REPORT_DATA_MARKER = "{\"__ywtc_report_payload__\":true}";
+export declare function injectReportPayload(shell: string, payload: ReportPresentationPayload): string;
 export declare class TransferReport {
     readonly data: TransferReportData;
     private readonly previews;
     private readonly issueCollector;
-    constructor(input: Omit<TransferReportData, 'runId' | 'startedAt' | 'status' | 'sourceStatus' | 'commentsEnabled' | 'selection' | 'pages' | 'edges' | 'hierarchyRepairs' | 'warnings' | 'errors' | 'issues' | 'outputs' | 'summary'> & {
+    private readonly secrets;
+    constructor(input: Omit<TransferReportData, 'runId' | 'startedAt' | 'status' | 'sourceStatus' | 'commentsEnabled' | 'selection' | 'pages' | 'excludedPages' | 'edges' | 'hierarchyRepairs' | 'warnings' | 'errors' | 'issues' | 'outputs' | 'summary'> & {
         sourceStatus?: SourceStatus;
         commentsEnabled?: boolean;
+        secrets?: string[];
     });
     registerPages(pages: DiscoveredPage[]): void;
     updatePage(sourceCanonicalId: string, update: Partial<TransferReportPage>): void;
     addPage(page: TransferReportPage, previews?: PreviewPair, collectIssues?: boolean): void;
-    setEdges(edges: TransferReportEdge[]): void;
+    setEdges(edges: TransferReportData['edges']): void;
     setSelection(selection: SourceSelection): void;
+    setDestinationUrl(url: string): void;
     addHierarchyRepair(repair: TransferReportData['hierarchyRepairs'][number]): void;
     issue(input: IssueInput): void;
     warning(message: string): void;
     error(message: string): void;
     output(label: string, value: string): void;
+    private finalizeOutcomes;
     finish(status: RunStatus): void;
     write(reportsDirectory: string): Promise<MigrationReportPaths>;
 }
-export {};