@lde/pipeline 0.43.0 → 0.44.0

package/dist/progressReporter.d.ts

@@ -1,157 +0,0 @@
-import type { Dataset, Distribution } from '@lde/dataset';
-import type { ValidityVerdict } from '@lde/distribution-health';
-import type { ValidationReport } from './validator.js';
-import type { ImportDetails } from './distribution/resolver.js';
-import type { TimeoutTransitionEvent } from './sparql/timeoutPolicy.js';
-export interface DistributionAnalysisResult {
-    distribution: Distribution;
-    type: 'sparql' | 'data-dump' | 'network-error';
-    available: boolean;
-    statusCode?: number;
-    error?: string;
-    warnings: string[];
-    /**
-     * The source-change fingerprint observed for this distribution, or `null`
-     * when none could be established (e.g. a live SPARQL endpoint). The shared
-     * key against which a validity verdict's `validatedFingerprint` is matched,
-     * so a consumer can record it on the reachability rail. Always populated by
-     * the pipeline; optional so consumers constructing the result need not set it.
-     */
-    fingerprint?: string | null;
-}
-/**
- * Items a writer left out of a dataset’s output instead of failing the
- * dataset – documents a destination refused, say – reported once per
- * (dataset, target) as the writer finalizes the dataset.
- */
-export interface ItemsRejected {
-    /** The part of the destination that refused them, e.g. a search index’s
-     *  type name. */
-    readonly target: string;
-    /** Items the dataset wrote to {@link target}, the rejected ones included. */
-    readonly written: number;
-    /** Items left out. */
-    readonly rejected: number;
-    /** Why, most frequent first: each distinct reason, how many items it
-     *  rejected, and the ids of a few of them. Bounded by the writer, so a
-     *  reason that varies per item cannot grow it without limit. */
-    readonly reasons: readonly RejectionReason[];
-}
-/** One reason a writer rejected items, in {@link ItemsRejected.reasons}. */
-export interface RejectionReason {
-    readonly reason: string;
-    readonly count: number;
-    /** Ids of some of the items rejected for this reason. */
-    readonly examples: readonly string[];
-}
-/**
- * Values a stage read from a dataset but could not interpret – an integer
- * field over `onbekend`, a date over `Z.j` – and so left out of the items it
- * produced, reported once per (dataset, target, field) when the dataset
- * completes. The item itself is still produced; only the value is missing.
- */
-export interface ValuesUnread {
-    /** The kind of item the values were read for, e.g. a search type’s name. */
-    readonly target: string;
-    /** The field that could not read them; dotted for a nested field. */
-    readonly field: string;
-    /** How many values the field left out. */
-    readonly unread: number;
-    /** A few of them, each a distinct value. Bounded, so a field that rejects
-     *  every value cannot grow the report with the data. */
-    readonly examples: readonly UnreadValue[];
-}
-/** One value a stage could not read, in {@link ValuesUnread.examples}. */
-export interface UnreadValue {
-    /** What the value was read from, as the stage names it – for a search
-     *  document, the node it was projected from, which a publisher can look up
-     *  even where the document is keyed on something else. */
-    readonly id: string;
-    /** The value as the source stated it. */
-    readonly value: string;
-}
-export interface ProgressReporter {
-    pipelineStart?(name: string): void;
-    datasetsSelected?(count: number, duration: number): void;
-    /**
-     * Called when the run is abandoned because the selection was empty – no
-     * commit, destination unchanged. Distinct from a completed run that indexed
-     * nothing: the writers were told to abort, so nothing was swept or swapped.
-     */
-    selectionEmpty?(reason: string): void;
-    datasetStart?(dataset: Dataset): void;
-    /** Called each time a single distribution probe completes. */
-    distributionProbed?(result: DistributionAnalysisResult): void;
-    /** Called when a data-dump import begins. */
-    importStarted?(): void;
-    /** Called when importing a distribution fails. */
-    importFailed?(distribution: Distribution, error: string): void;
-    /**
-     * Called with the RDF-validity verdict for a distribution the pipeline
-     * attempted, whether valid or invalid, and even when the dataset is
-     * otherwise skipped (no summary produced). The verdict is a plain
-     * TypeScript value; consumers decide how (and whether) to record it as RDF.
-     */
-    distributionValidated?(distribution: Distribution, verdict: ValidityVerdict): void;
-    /** Called when a dataset’s source is resolved; `imported` is set when the
-     *  source serves an imported data dump. */
-    distributionSelected?(dataset: Dataset, distribution: Distribution, imported?: ImportDetails): void;
-    stageStart?(stage: string): void;
-    stageProgress?(update: {
-        itemsProcessed: number;
-        quadsGenerated: number;
-        memoryUsageBytes: number;
-        heapUsedBytes: number;
-    }): void;
-    stageComplete?(stage: string, result: {
-        itemsProcessed: number;
-        quadsGenerated: number;
-        duration: number;
-    }): void;
-    stageFailed?(stage: string, error: Error): void;
-    stageSkipped?(stage: string, reason: string): void;
-    /**
-     * Called once per (dataset, validator) pair after all stages for a dataset
-     * have run. Fires regardless of whether any stage actually invoked
-     * `validate()` – the report reflects the validator’s accumulated state.
-     * When no stage produced data, the report typically carries
-     * `quadsValidated: 0` and `conforms: true` (the SHACL vacuous-truth
-     * default); consumers that want to distinguish ‘not tested’ from ‘tested
-     * and passed’ can read `quadsValidated`.
-     */
-    datasetValidated?(dataset: Dataset, report: ValidationReport): void;
-    datasetComplete?(dataset: Dataset, result: {
-        memoryUsageBytes: number;
-        heapUsedBytes: number;
-    }): void;
-    datasetSkipped?(dataset: Dataset, reason: string): void;
-    /**
-     * Called when a writer leaves some of a dataset’s items out rather than
-     * failing the dataset ({@link RunContext.itemsRejected}).
-     */
-    itemsRejected?(dataset: Dataset, rejection: ItemsRejected): void;
-    /**
-     * Called once per (target, field) that left values out of a dataset’s items
-     * ({@link BatchContext.valueUnread}), just before {@link datasetComplete}.
-     * Not called for a dataset whose stages or write failed: nothing of it is
-     * kept, so neither is what it could not read.
-     */
-    valuesUnread?(dataset: Dataset, unread: ValuesUnread): void;
-    pipelineComplete?(result: {
-        duration: number;
-        memoryUsageBytes: number;
-        heapUsedBytes: number;
-    }): void;
-    /**
-     * Called when a {@link TimeoutPolicy} tightens the budget for an
-     * endpoint after a run of consecutive timeouts. Lets operators
-     * distinguish a fast-failed stage from an unexpected speedup.
-     */
-    timeoutTightened?(event: TimeoutTransitionEvent): void;
-    /**
-     * Called when a {@link TimeoutPolicy} relaxes the budget back to the
-     * default after a successful request on a previously-tightened endpoint.
-     */
-    timeoutRelaxed?(event: TimeoutTransitionEvent): void;
-}
-//# sourceMappingURL=progressReporter.d.ts.map

package/dist/progressReporter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"progressReporter.d.ts","sourceRoot":"","sources":["../src/progressReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAExE,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,eAAe,CAAC;IAC/C,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;qBACiB;IACjB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;oEAEgE;IAChE,QAAQ,CAAC,OAAO,EAAE,SAAS,eAAe,EAAE,CAAC;CAC9C;AAED,4EAA4E;AAC5E,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,qEAAqE;IACrE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;4DACwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;CAC3C;AAED,0EAA0E;AAC1E,MAAM,WAAW,WAAW;IAC1B;;8DAE0D;IAC1D,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,gBAAgB,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACzD;;;;OAIG;IACH,cAAc,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,YAAY,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,8DAA8D;IAC9D,kBAAkB,CAAC,CAAC,MAAM,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAC9D,6CAA6C;IAC7C,aAAa,CAAC,IAAI,IAAI,CAAC;IACvB,kDAAkD;IAClD,YAAY,CAAC,CAAC,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/D;;;;;OAKG;IACH,qBAAqB,CAAC,CACpB,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,eAAe,GACvB,IAAI,CAAC;IACR;+CAC2C;IAC3C,oBAAoB,CAAC,CACnB,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,YAAY,EAC1B,QAAQ,CAAC,EAAE,aAAa,GACvB,IAAI,CAAC;IACR,UAAU,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,aAAa,CAAC,CAAC,MAAM,EAAE;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,gBAAgB,EAAE,MAAM,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;KACvB,GAAG,IAAI,CAAC;IACT,aAAa,CAAC,CACZ,KAAK,EAAE,MAAM,EACb,MAAM,EAAE;QACN,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,QAAQ,EAAE,MAAM,CAAC;KAClB,GACA,IAAI,CAAC;IACR,WAAW,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAChD,YAAY,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACnD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpE,eAAe,CAAC,CACd,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,GAC1D,IAAI,CAAC;IACR,cAAc,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACxD;;;OAGG;IACH,aAAa,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,GAAG,IAAI,CAAC;IACjE;;;;;OAKG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAC5D,gBAAgB,CAAC,CAAC,MAAM,EAAE;QACxB,QAAQ,EAAE,MAAM,CAAC;QACjB,gBAAgB,EAAE,MAAM,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;KACvB,GAAG,IAAI,CAAC;IACT;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACvD;;;OAGG;IACH,cAAc,CAAC,CAAC,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACtD"}