@letpeoplework/lighthouse-client 1.1.0 → 1.3.0

package/dist/index.d.cts

@@ -4,7 +4,7 @@ type ClientPackageContract = {
     readonly capabilities: readonly ClientCapability[];
 };
 declare const getClientPackageContract: () => ClientPackageContract;
-type ConnectivityCategory = "success" | "unreachable" | "misconfigured" | "unauthorized" | "dependency-failure" | "unexpected";
+type ConnectivityCategory = "success" | "unreachable" | "misconfigured" | "unauthorized" | "dependency-failure" | "concurrency-conflict" | "unexpected";
 type StandaloneDiscoveryContract = {
     readonly contractVersion: 1;
     readonly lighthouseUrl: string;
@@ -219,6 +219,61 @@ 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 DayOfWeek = "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday";
+type RecurringBlackoutRule = {
+    readonly id: number;
+    readonly weekdays: readonly DayOfWeek[];
+    readonly intervalWeeks: number;
+    readonly start: string;
+    readonly end: string | null;
+    readonly description: string;
+    readonly summary: string;
+};
+type RecurringBlackoutRuleInput = {
+    readonly weekdays: readonly DayOfWeek[];
+    readonly intervalWeeks: number;
+    readonly start: string;
+    readonly end: string | null;
+    readonly description: string;
+};
 type LighthouseClient = {
     readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
     readonly getVersion: () => Promise<LighthouseApiResult<string>>;
@@ -261,6 +316,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[]>>;
@@ -268,12 +329,22 @@ type LighthouseClient = {
     readonly createDelivery: (portfolioId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
     readonly updateDelivery: (deliveryId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
     readonly deleteDelivery: (deliveryId: number) => Promise<LighthouseApiResult<undefined>>;
+    readonly getRecurringBlackoutRules: () => Promise<LighthouseApiResult<readonly RecurringBlackoutRule[]>>;
+    readonly createRecurringBlackoutRule: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<RecurringBlackoutRule>>;
+    readonly updateRecurringBlackoutRule: (id: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<RecurringBlackoutRule>>;
+    readonly deleteRecurringBlackoutRule: (id: number) => Promise<LighthouseApiResult<undefined>>;
     readonly runManualForecast: (teamId: number, payload: ManualForecastInput) => Promise<LighthouseApiResult<unknown>>;
     readonly runBacktest: (teamId: number, payload: BacktestInput) => Promise<LighthouseApiResult<unknown>>;
 };
 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 ThroughputFilterView, 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 DayOfWeek, 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 RecurringBlackoutRule, type RecurringBlackoutRuleInput, 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

@@ -4,7 +4,7 @@ type ClientPackageContract = {
     readonly capabilities: readonly ClientCapability[];
 };
 declare const getClientPackageContract: () => ClientPackageContract;
-type ConnectivityCategory = "success" | "unreachable" | "misconfigured" | "unauthorized" | "dependency-failure" | "unexpected";
+type ConnectivityCategory = "success" | "unreachable" | "misconfigured" | "unauthorized" | "dependency-failure" | "concurrency-conflict" | "unexpected";
 type StandaloneDiscoveryContract = {
     readonly contractVersion: 1;
     readonly lighthouseUrl: string;
@@ -219,6 +219,61 @@ 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 DayOfWeek = "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday";
+type RecurringBlackoutRule = {
+    readonly id: number;
+    readonly weekdays: readonly DayOfWeek[];
+    readonly intervalWeeks: number;
+    readonly start: string;
+    readonly end: string | null;
+    readonly description: string;
+    readonly summary: string;
+};
+type RecurringBlackoutRuleInput = {
+    readonly weekdays: readonly DayOfWeek[];
+    readonly intervalWeeks: number;
+    readonly start: string;
+    readonly end: string | null;
+    readonly description: string;
+};
 type LighthouseClient = {
     readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
     readonly getVersion: () => Promise<LighthouseApiResult<string>>;
@@ -261,6 +316,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[]>>;
@@ -268,12 +329,22 @@ type LighthouseClient = {
     readonly createDelivery: (portfolioId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
     readonly updateDelivery: (deliveryId: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<unknown>>;
     readonly deleteDelivery: (deliveryId: number) => Promise<LighthouseApiResult<undefined>>;
+    readonly getRecurringBlackoutRules: () => Promise<LighthouseApiResult<readonly RecurringBlackoutRule[]>>;
+    readonly createRecurringBlackoutRule: (payload: LighthouseWritePayload) => Promise<LighthouseApiResult<RecurringBlackoutRule>>;
+    readonly updateRecurringBlackoutRule: (id: number, payload: LighthouseWritePayload) => Promise<LighthouseApiResult<RecurringBlackoutRule>>;
+    readonly deleteRecurringBlackoutRule: (id: number) => Promise<LighthouseApiResult<undefined>>;
     readonly runManualForecast: (teamId: number, payload: ManualForecastInput) => Promise<LighthouseApiResult<unknown>>;
     readonly runBacktest: (teamId: number, payload: BacktestInput) => Promise<LighthouseApiResult<unknown>>;
 };
 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 ThroughputFilterView, 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 DayOfWeek, 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 RecurringBlackoutRule, type RecurringBlackoutRuleInput, 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 };