@letpeoplework/lighthouse-client 1.0.1 → 1.2.0

package/dist/index.d.cts

@@ -162,13 +162,38 @@ declare const getDefaultMetricsDateRange: () => MetricsDateRange;
 type ManualForecastInput = {
     readonly remainingItems?: number;
     readonly targetDate?: string;
+    /**
+     * Override the team's forecast-filter setting for this forecast call:
+     * - `true`  — apply the team's exclusion rule (filtered throughput).
+     * - `false` — skip the team's exclusion rule (raw throughput).
+     * - omit    — respect the team's current setting (default).
+     *
+     * Lighthouse v26.5.24.10+. Older servers ignore this field.
+     */
+    readonly applyFilterOverride?: boolean;
 };
 type BacktestInput = {
     readonly startDate: string;
     readonly endDate: string;
     readonly historicalStartDate: string;
     readonly historicalEndDate: string;
-};
+    /**
+     * Override the team's forecast-filter setting for this backtest call:
+     * - `true`  — apply the team's exclusion rule (filtered throughput).
+     * - `false` — skip the team's exclusion rule (raw throughput).
+     * - omit    — respect the team's current setting (default).
+     *
+     * Lighthouse v26.5.24.10+. Older servers ignore this field.
+     */
+    readonly applyFilterOverride?: boolean;
+};
+/**
+ * Forecast-filter view for team-level throughput / PBC / predictability metrics.
+ * Lighthouse v26.5.24.10+ ignores unknown values and falls back to raw.
+ * - `"filtered"` — apply the team's exclusion rule.
+ * - `"raw"` / omit — return unfiltered data (default).
+ */
+type ThroughputFilterView = "raw" | "filtered";
 type WorkItemAgeEntry = {
     readonly id: number;
     readonly name: string;
@@ -194,6 +219,44 @@ type TotalWorkItemAgeOverTimeResult = {
     readonly endDate: string;
     readonly daily: readonly DailyTotalWorkItemAge[];
 };
+type CumulativeStateTimeStateRow = {
+    readonly state: string;
+    readonly workflowOrder: number;
+    readonly totalDays: number;
+    readonly completedContributionDays: number;
+    readonly ongoingContributionDays: number;
+    readonly itemCount: number;
+    readonly completedItemCount: number;
+    readonly ongoingItemCount: number;
+    readonly meanDays: number;
+    readonly medianDays: number | null;
+};
+type CumulativeStateTimeResult = {
+    readonly states: readonly CumulativeStateTimeStateRow[];
+};
+type CumulativeStateTimeItemRow = {
+    readonly workItemId: number;
+    readonly referenceId: string;
+    readonly title: string;
+    readonly type: string;
+    readonly state: string;
+    readonly stateCategory: string;
+    readonly url: string | null;
+    readonly daysContributed: number;
+};
+type CumulativeStateTimeItemsResult = {
+    readonly state: string;
+    readonly items: readonly CumulativeStateTimeItemRow[];
+};
+type CumulativeStateTimeCandidateRow = {
+    readonly workItemId: number;
+    readonly referenceId: string;
+    readonly title: string;
+    readonly workItemType: string;
+};
+type CumulativeStateTimeCandidatesResult = {
+    readonly items: readonly CumulativeStateTimeCandidateRow[];
+};
 type LighthouseClient = {
     readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
     readonly getVersion: () => Promise<LighthouseApiResult<string>>;
@@ -214,13 +277,13 @@ type LighthouseClient = {
     readonly updatePortfolio: (portfolioId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
     readonly deletePortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
     readonly refreshPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
-    readonly getTeamThroughput: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getTeamThroughput: (teamId: number, range?: MetricsDateRange, view?: ThroughputFilterView) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamArrivals: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamWipOverTime: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamWip: (teamId: number, asOfDate: string) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getTeamCycleTimePercentiles: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getTeamCycleTimeData: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
-    readonly getTeamPredictabilityScore: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getTeamPredictabilityScore: (teamId: number, range?: MetricsDateRange, view?: ThroughputFilterView) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamTotalWorkItemAge: (teamId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
     readonly getTeamTotalWorkItemAgeInfo: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getPortfolioThroughput: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
@@ -236,6 +299,12 @@ type LighthouseClient = {
     readonly getPortfolioTotalWorkItemAgeInfo: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getPortfolioWorkItemAgeOverTime: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<WorkItemAgeOverTimeResult>>;
     readonly getPortfolioTotalWorkItemAgeOverTime: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<TotalWorkItemAgeOverTimeResult>>;
+    readonly getTeamCumulativeStateTime: (teamId: number, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeResult>>;
+    readonly getTeamCumulativeStateTimeItems: (teamId: number, state: string, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeItemsResult>>;
+    readonly getTeamCumulativeStateTimeCandidates: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<CumulativeStateTimeCandidatesResult>>;
+    readonly getPortfolioCumulativeStateTime: (portfolioId: number, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeResult>>;
+    readonly getPortfolioCumulativeStateTimeItems: (portfolioId: number, state: string, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeItemsResult>>;
+    readonly getPortfolioCumulativeStateTimeCandidates: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<CumulativeStateTimeCandidatesResult>>;
     readonly getFeaturesByIds: (ids: readonly number[]) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getFeaturesByReferences: (refs: readonly string[]) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getFeatureWorkItems: (featureId: number) => Promise<LighthouseApiResult<readonly unknown[]>>;
@@ -249,6 +318,12 @@ type LighthouseClient = {
 type LighthouseClientDependencies = {
     readonly fetch?: (url: string, init?: RequestInit) => Promise<ConnectivityFetchResponse>;
 };
+/**
+ * Returns true when `candidate` is strictly newer than `baseline`, false when
+ * it is equal-or-older, and null when either string is unparseable (treat as
+ * "unknown — do not block").
+ */
+declare const isServerVersionNewerThan: (candidate: string, baseline: string) => boolean | null;
 declare const createLighthouseClient: (configuration: LighthouseClientConfiguration, dependencies?: LighthouseClientDependencies) => LighthouseClient;
 
-export { type BacktestInput, type CliAuthSessionPollResult, type CliAuthSessionStartError, type CliAuthSessionStartOutcome, type CliAuthSessionStartResult, type CliConnection, type CliServerAuthMode, type CliServerConnection, type CliStandaloneConnection, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type DailyTotalWorkItemAge, type DailyWorkItemAge, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type ServerAuthModeResult, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, type TotalWorkItemAgeOverTimeResult, type WorkItemAgeEntry, type WorkItemAgeOverTimeResult, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, getStandaloneDiscoveryLockfilePath, loadStandaloneDiscoveryContract, parseStandaloneDiscoveryContract, pollCliAuthSession, queryServerAuthMode, startCliAuthSession, validateLighthouseConnectivity };
+export { type BacktestInput, type CliAuthSessionPollResult, type CliAuthSessionStartError, type CliAuthSessionStartOutcome, type CliAuthSessionStartResult, type CliConnection, type CliServerAuthMode, type CliServerConnection, type CliStandaloneConnection, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type CumulativeStateTimeCandidateRow, type CumulativeStateTimeCandidatesResult, type CumulativeStateTimeItemRow, type CumulativeStateTimeItemsResult, type CumulativeStateTimeResult, type CumulativeStateTimeStateRow, type DailyTotalWorkItemAge, type DailyWorkItemAge, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type ServerAuthModeResult, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, type ThroughputFilterView, type TotalWorkItemAgeOverTimeResult, type WorkItemAgeEntry, type WorkItemAgeOverTimeResult, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, getStandaloneDiscoveryLockfilePath, isServerVersionNewerThan, loadStandaloneDiscoveryContract, parseStandaloneDiscoveryContract, pollCliAuthSession, queryServerAuthMode, startCliAuthSession, validateLighthouseConnectivity };

package/dist/index.d.ts

@@ -162,13 +162,38 @@ declare const getDefaultMetricsDateRange: () => MetricsDateRange;
 type ManualForecastInput = {
     readonly remainingItems?: number;
     readonly targetDate?: string;
+    /**
+     * Override the team's forecast-filter setting for this forecast call:
+     * - `true`  — apply the team's exclusion rule (filtered throughput).
+     * - `false` — skip the team's exclusion rule (raw throughput).
+     * - omit    — respect the team's current setting (default).
+     *
+     * Lighthouse v26.5.24.10+. Older servers ignore this field.
+     */
+    readonly applyFilterOverride?: boolean;
 };
 type BacktestInput = {
     readonly startDate: string;
     readonly endDate: string;
     readonly historicalStartDate: string;
     readonly historicalEndDate: string;
-};
+    /**
+     * Override the team's forecast-filter setting for this backtest call:
+     * - `true`  — apply the team's exclusion rule (filtered throughput).
+     * - `false` — skip the team's exclusion rule (raw throughput).
+     * - omit    — respect the team's current setting (default).
+     *
+     * Lighthouse v26.5.24.10+. Older servers ignore this field.
+     */
+    readonly applyFilterOverride?: boolean;
+};
+/**
+ * Forecast-filter view for team-level throughput / PBC / predictability metrics.
+ * Lighthouse v26.5.24.10+ ignores unknown values and falls back to raw.
+ * - `"filtered"` — apply the team's exclusion rule.
+ * - `"raw"` / omit — return unfiltered data (default).
+ */
+type ThroughputFilterView = "raw" | "filtered";
 type WorkItemAgeEntry = {
     readonly id: number;
     readonly name: string;
@@ -194,6 +219,44 @@ type TotalWorkItemAgeOverTimeResult = {
     readonly endDate: string;
     readonly daily: readonly DailyTotalWorkItemAge[];
 };
+type CumulativeStateTimeStateRow = {
+    readonly state: string;
+    readonly workflowOrder: number;
+    readonly totalDays: number;
+    readonly completedContributionDays: number;
+    readonly ongoingContributionDays: number;
+    readonly itemCount: number;
+    readonly completedItemCount: number;
+    readonly ongoingItemCount: number;
+    readonly meanDays: number;
+    readonly medianDays: number | null;
+};
+type CumulativeStateTimeResult = {
+    readonly states: readonly CumulativeStateTimeStateRow[];
+};
+type CumulativeStateTimeItemRow = {
+    readonly workItemId: number;
+    readonly referenceId: string;
+    readonly title: string;
+    readonly type: string;
+    readonly state: string;
+    readonly stateCategory: string;
+    readonly url: string | null;
+    readonly daysContributed: number;
+};
+type CumulativeStateTimeItemsResult = {
+    readonly state: string;
+    readonly items: readonly CumulativeStateTimeItemRow[];
+};
+type CumulativeStateTimeCandidateRow = {
+    readonly workItemId: number;
+    readonly referenceId: string;
+    readonly title: string;
+    readonly workItemType: string;
+};
+type CumulativeStateTimeCandidatesResult = {
+    readonly items: readonly CumulativeStateTimeCandidateRow[];
+};
 type LighthouseClient = {
     readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
     readonly getVersion: () => Promise<LighthouseApiResult<string>>;
@@ -214,13 +277,13 @@ type LighthouseClient = {
     readonly updatePortfolio: (portfolioId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
     readonly deletePortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
     readonly refreshPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
-    readonly getTeamThroughput: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getTeamThroughput: (teamId: number, range?: MetricsDateRange, view?: ThroughputFilterView) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamArrivals: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamWipOverTime: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamWip: (teamId: number, asOfDate: string) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getTeamCycleTimePercentiles: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getTeamCycleTimeData: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
-    readonly getTeamPredictabilityScore: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getTeamPredictabilityScore: (teamId: number, range?: MetricsDateRange, view?: ThroughputFilterView) => Promise<LighthouseApiResult<unknown>>;
     readonly getTeamTotalWorkItemAge: (teamId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
     readonly getTeamTotalWorkItemAgeInfo: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getPortfolioThroughput: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
@@ -236,6 +299,12 @@ type LighthouseClient = {
     readonly getPortfolioTotalWorkItemAgeInfo: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getPortfolioWorkItemAgeOverTime: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<WorkItemAgeOverTimeResult>>;
     readonly getPortfolioTotalWorkItemAgeOverTime: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<TotalWorkItemAgeOverTimeResult>>;
+    readonly getTeamCumulativeStateTime: (teamId: number, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeResult>>;
+    readonly getTeamCumulativeStateTimeItems: (teamId: number, state: string, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeItemsResult>>;
+    readonly getTeamCumulativeStateTimeCandidates: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<CumulativeStateTimeCandidatesResult>>;
+    readonly getPortfolioCumulativeStateTime: (portfolioId: number, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeResult>>;
+    readonly getPortfolioCumulativeStateTimeItems: (portfolioId: number, state: string, range?: MetricsDateRange, itemIds?: readonly number[]) => Promise<LighthouseApiResult<CumulativeStateTimeItemsResult>>;
+    readonly getPortfolioCumulativeStateTimeCandidates: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<CumulativeStateTimeCandidatesResult>>;
     readonly getFeaturesByIds: (ids: readonly number[]) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getFeaturesByReferences: (refs: readonly string[]) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getFeatureWorkItems: (featureId: number) => Promise<LighthouseApiResult<readonly unknown[]>>;
@@ -249,6 +318,12 @@ type LighthouseClient = {
 type LighthouseClientDependencies = {
     readonly fetch?: (url: string, init?: RequestInit) => Promise<ConnectivityFetchResponse>;
 };
+/**
+ * Returns true when `candidate` is strictly newer than `baseline`, false when
+ * it is equal-or-older, and null when either string is unparseable (treat as
+ * "unknown — do not block").
+ */
+declare const isServerVersionNewerThan: (candidate: string, baseline: string) => boolean | null;
 declare const createLighthouseClient: (configuration: LighthouseClientConfiguration, dependencies?: LighthouseClientDependencies) => LighthouseClient;
 
-export { type BacktestInput, type CliAuthSessionPollResult, type CliAuthSessionStartError, type CliAuthSessionStartOutcome, type CliAuthSessionStartResult, type CliConnection, type CliServerAuthMode, type CliServerConnection, type CliStandaloneConnection, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type DailyTotalWorkItemAge, type DailyWorkItemAge, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type ServerAuthModeResult, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, type TotalWorkItemAgeOverTimeResult, type WorkItemAgeEntry, type WorkItemAgeOverTimeResult, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, getStandaloneDiscoveryLockfilePath, loadStandaloneDiscoveryContract, parseStandaloneDiscoveryContract, pollCliAuthSession, queryServerAuthMode, startCliAuthSession, validateLighthouseConnectivity };
+export { type BacktestInput, type CliAuthSessionPollResult, type CliAuthSessionStartError, type CliAuthSessionStartOutcome, type CliAuthSessionStartResult, type CliConnection, type CliServerAuthMode, type CliServerConnection, type CliStandaloneConnection, type ClientCapability, type ClientPackageContract, type ConnectivityCategory, type ConnectivityDependencies, type ConnectivityFetchResponse, type ConnectivityValidationResult, type CumulativeStateTimeCandidateRow, type CumulativeStateTimeCandidatesResult, type CumulativeStateTimeItemRow, type CumulativeStateTimeItemsResult, type CumulativeStateTimeResult, type CumulativeStateTimeStateRow, type DailyTotalWorkItemAge, type DailyWorkItemAge, type LighthouseApiError, type LighthouseApiResult, type LighthouseAuthContext, type LighthouseAuthOverrides, type LighthouseAuthStatus, type LighthouseAuthStore, type LighthouseClient, type LighthouseClientAuth, type LighthouseClientConfiguration, type LighthouseClientDependencies, type LighthouseConnectionConfiguration, type LighthouseWritePayload, type ManualForecastInput, type MetricsDateRange, type ResolvedLighthouseEndpoint, type ServerAuthModeResult, type StandaloneDiscoveryContract, type StandaloneDiscoveryContractParseResult, type StoredLighthouseAuth, type ThroughputFilterView, type TotalWorkItemAgeOverTimeResult, type WorkItemAgeEntry, type WorkItemAgeOverTimeResult, createLighthouseAuthContext, createLighthouseClient, getClientPackageContract, getDefaultMetricsDateRange, getStandaloneDiscoveryLockfilePath, isServerVersionNewerThan, loadStandaloneDiscoveryContract, parseStandaloneDiscoveryContract, pollCliAuthSession, queryServerAuthMode, startCliAuthSession, validateLighthouseConnectivity };