npm - @letpeoplework/lighthouse-client - Versions diffs - 0.8.0 → 1.0.0 - Mend

@letpeoplework/lighthouse-client 0.8.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/index.cjs CHANGED Viewed

@@ -703,6 +703,54 @@ var requestNoContent = async (configuration, dependencies, route, requestOptions
 var getResolvedMetricsDateRange = (range) => range ?? getDefaultMetricsDateRange();
 var getMetricsDateRangeQuery = (range) => `startDate=${encodeURIComponent(range.startDate)}&endDate=${encodeURIComponent(range.endDate)}`;
 var getMetricsAsOfDateQuery = (asOfDate) => `asOfDate=${encodeURIComponent(asOfDate)}`;
+var addUtcDays = (dateStr, days) => {
+  const d = /* @__PURE__ */ new Date(`${dateStr}T00:00:00Z`);
+  d.setUTCDate(d.getUTCDate() + days);
+  return d.toISOString().split("T")[0];
+};
+var computeItemAge = (dayDate, startedDate) => {
+  const day = Date.parse(`${dayDate}T00:00:00Z`);
+  const started = Date.parse(startedDate);
+  const diffDays = Math.floor((day - started) / 864e5);
+  return Math.max(1, diffDays + 1);
+};
+var deriveWorkItemAgeOverTime = (startDate, endDate, wipData) => {
+  const daily = Object.entries(
+    wipData.workItemsPerUnitOfTime
+  ).map(([dayIndexStr, items]) => {
+    const dayIndex = Number.parseInt(dayIndexStr, 10);
+    const date = addUtcDays(startDate, dayIndex);
+    const ageItems = items.filter(
+      (item) => item.startedDate != null && item.startedDate.length > 0
+    ).map((item) => ({
+      id: item.id,
+      name: item.name,
+      referenceId: item.referenceId,
+      age: computeItemAge(date, item.startedDate)
+    }));
+    return { date, items: ageItems };
+  });
+  daily.sort((a, b) => a.date.localeCompare(b.date));
+  return { startDate, endDate, daily };
+};
+var deriveTotalWorkItemAgeOverTime = (startDate, endDate, wipData) => {
+  const daily = Object.entries(
+    wipData.workItemsPerUnitOfTime
+  ).map(([dayIndexStr, items]) => {
+    const dayIndex = Number.parseInt(dayIndexStr, 10);
+    const date = addUtcDays(startDate, dayIndex);
+    const activeItems = items.filter(
+      (item) => item.startedDate != null && item.startedDate.length > 0
+    );
+    const totalAge = activeItems.reduce(
+      (sum, item) => sum + computeItemAge(date, item.startedDate),
+      0
+    );
+    return { date, totalAge, itemCount: activeItems.length };
+  });
+  daily.sort((a, b) => a.date.localeCompare(b.date));
+  return { startDate, endDate, daily };
+};
 var createLighthouseClient = (configuration, dependencies = {}) => ({
   checkConnectivity: async () => {
     const fetchDependency = getFetchDependency(dependencies);
@@ -897,6 +945,42 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
       { method: "GET" }
     );
   },
+  getTeamWorkItemAgeOverTime: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveWorkItemAgeOverTime(r.startDate, r.endDate, wipResult.value)
+    };
+  },
+  getTeamTotalWorkItemAgeOverTime: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveTotalWorkItemAgeOverTime(
+        r.startDate,
+        r.endDate,
+        wipResult.value
+      )
+    };
+  },
   getPortfolioThroughput: async (portfolioId, range) => {
     const r = getResolvedMetricsDateRange(range);
     return requestJson(
@@ -972,6 +1056,42 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
       { method: "GET" }
     );
   },
+  getPortfolioWorkItemAgeOverTime: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveWorkItemAgeOverTime(r.startDate, r.endDate, wipResult.value)
+    };
+  },
+  getPortfolioTotalWorkItemAgeOverTime: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveTotalWorkItemAgeOverTime(
+        r.startDate,
+        r.endDate,
+        wipResult.value
+      )
+    };
+  },
   getFeaturesByIds: async (ids) => {
     const queryString = ids.map((id) => `ids=${encodeURIComponent(id)}`).join("&");
     return requestJson(

package/dist/index.d.cts CHANGED Viewed

@@ -169,6 +169,31 @@ type BacktestInput = {
     readonly historicalStartDate: string;
     readonly historicalEndDate: string;
 };
+type WorkItemAgeEntry = {
+    readonly id: number;
+    readonly name: string;
+    readonly referenceId: string;
+    readonly age: number;
+};
+type DailyWorkItemAge = {
+    readonly date: string;
+    readonly items: readonly WorkItemAgeEntry[];
+};
+type DailyTotalWorkItemAge = {
+    readonly date: string;
+    readonly totalAge: number;
+    readonly itemCount: number;
+};
+type WorkItemAgeOverTimeResult = {
+    readonly startDate: string;
+    readonly endDate: string;
+    readonly daily: readonly DailyWorkItemAge[];
+};
+type TotalWorkItemAgeOverTimeResult = {
+    readonly startDate: string;
+    readonly endDate: string;
+    readonly daily: readonly DailyTotalWorkItemAge[];
+};
 type LighthouseClient = {
     readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
     readonly getVersion: () => Promise<LighthouseApiResult<string>>;
@@ -205,8 +230,12 @@ type LighthouseClient = {
     readonly getPortfolioWip: (portfolioId: number, asOfDate: string) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getPortfolioCycleTimeData: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getPortfolioPredictabilityScore: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getTeamWorkItemAgeOverTime: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<WorkItemAgeOverTimeResult>>;
+    readonly getTeamTotalWorkItemAgeOverTime: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<TotalWorkItemAgeOverTimeResult>>;
     readonly getPortfolioTotalWorkItemAge: (portfolioId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
     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 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[]>>;
@@ -222,4 +251,4 @@ type LighthouseClientDependencies = {
 };
 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 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, 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 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 };

package/dist/index.d.ts CHANGED Viewed

@@ -169,6 +169,31 @@ type BacktestInput = {
     readonly historicalStartDate: string;
     readonly historicalEndDate: string;
 };
+type WorkItemAgeEntry = {
+    readonly id: number;
+    readonly name: string;
+    readonly referenceId: string;
+    readonly age: number;
+};
+type DailyWorkItemAge = {
+    readonly date: string;
+    readonly items: readonly WorkItemAgeEntry[];
+};
+type DailyTotalWorkItemAge = {
+    readonly date: string;
+    readonly totalAge: number;
+    readonly itemCount: number;
+};
+type WorkItemAgeOverTimeResult = {
+    readonly startDate: string;
+    readonly endDate: string;
+    readonly daily: readonly DailyWorkItemAge[];
+};
+type TotalWorkItemAgeOverTimeResult = {
+    readonly startDate: string;
+    readonly endDate: string;
+    readonly daily: readonly DailyTotalWorkItemAge[];
+};
 type LighthouseClient = {
     readonly checkConnectivity: () => Promise<ConnectivityValidationResult>;
     readonly getVersion: () => Promise<LighthouseApiResult<string>>;
@@ -205,8 +230,12 @@ type LighthouseClient = {
     readonly getPortfolioWip: (portfolioId: number, asOfDate: string) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getPortfolioCycleTimeData: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
     readonly getPortfolioPredictabilityScore: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getTeamWorkItemAgeOverTime: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<WorkItemAgeOverTimeResult>>;
+    readonly getTeamTotalWorkItemAgeOverTime: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<TotalWorkItemAgeOverTimeResult>>;
     readonly getPortfolioTotalWorkItemAge: (portfolioId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
     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 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[]>>;
@@ -222,4 +251,4 @@ type LighthouseClientDependencies = {
 };
 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 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, 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 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 };

package/dist/index.js CHANGED Viewed

@@ -669,6 +669,54 @@ var requestNoContent = async (configuration, dependencies, route, requestOptions
 var getResolvedMetricsDateRange = (range) => range ?? getDefaultMetricsDateRange();
 var getMetricsDateRangeQuery = (range) => `startDate=${encodeURIComponent(range.startDate)}&endDate=${encodeURIComponent(range.endDate)}`;
 var getMetricsAsOfDateQuery = (asOfDate) => `asOfDate=${encodeURIComponent(asOfDate)}`;
+var addUtcDays = (dateStr, days) => {
+  const d = /* @__PURE__ */ new Date(`${dateStr}T00:00:00Z`);
+  d.setUTCDate(d.getUTCDate() + days);
+  return d.toISOString().split("T")[0];
+};
+var computeItemAge = (dayDate, startedDate) => {
+  const day = Date.parse(`${dayDate}T00:00:00Z`);
+  const started = Date.parse(startedDate);
+  const diffDays = Math.floor((day - started) / 864e5);
+  return Math.max(1, diffDays + 1);
+};
+var deriveWorkItemAgeOverTime = (startDate, endDate, wipData) => {
+  const daily = Object.entries(
+    wipData.workItemsPerUnitOfTime
+  ).map(([dayIndexStr, items]) => {
+    const dayIndex = Number.parseInt(dayIndexStr, 10);
+    const date = addUtcDays(startDate, dayIndex);
+    const ageItems = items.filter(
+      (item) => item.startedDate != null && item.startedDate.length > 0
+    ).map((item) => ({
+      id: item.id,
+      name: item.name,
+      referenceId: item.referenceId,
+      age: computeItemAge(date, item.startedDate)
+    }));
+    return { date, items: ageItems };
+  });
+  daily.sort((a, b) => a.date.localeCompare(b.date));
+  return { startDate, endDate, daily };
+};
+var deriveTotalWorkItemAgeOverTime = (startDate, endDate, wipData) => {
+  const daily = Object.entries(
+    wipData.workItemsPerUnitOfTime
+  ).map(([dayIndexStr, items]) => {
+    const dayIndex = Number.parseInt(dayIndexStr, 10);
+    const date = addUtcDays(startDate, dayIndex);
+    const activeItems = items.filter(
+      (item) => item.startedDate != null && item.startedDate.length > 0
+    );
+    const totalAge = activeItems.reduce(
+      (sum, item) => sum + computeItemAge(date, item.startedDate),
+      0
+    );
+    return { date, totalAge, itemCount: activeItems.length };
+  });
+  daily.sort((a, b) => a.date.localeCompare(b.date));
+  return { startDate, endDate, daily };
+};
 var createLighthouseClient = (configuration, dependencies = {}) => ({
   checkConnectivity: async () => {
     const fetchDependency = getFetchDependency(dependencies);
@@ -863,6 +911,42 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
       { method: "GET" }
     );
   },
+  getTeamWorkItemAgeOverTime: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveWorkItemAgeOverTime(r.startDate, r.endDate, wipResult.value)
+    };
+  },
+  getTeamTotalWorkItemAgeOverTime: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveTotalWorkItemAgeOverTime(
+        r.startDate,
+        r.endDate,
+        wipResult.value
+      )
+    };
+  },
   getPortfolioThroughput: async (portfolioId, range) => {
     const r = getResolvedMetricsDateRange(range);
     return requestJson(
@@ -938,6 +1022,42 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
       { method: "GET" }
     );
   },
+  getPortfolioWorkItemAgeOverTime: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveWorkItemAgeOverTime(r.startDate, r.endDate, wipResult.value)
+    };
+  },
+  getPortfolioTotalWorkItemAgeOverTime: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    const wipResult = await requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+    if (!wipResult.ok) {
+      return wipResult;
+    }
+    return {
+      ok: true,
+      value: deriveTotalWorkItemAgeOverTime(
+        r.startDate,
+        r.endDate,
+        wipResult.value
+      )
+    };
+  },
   getFeaturesByIds: async (ids) => {
     const queryString = ids.map((id) => `ids=${encodeURIComponent(id)}`).join("&");
     return requestJson(

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@letpeoplework/lighthouse-client",
-  "version": "0.8.0",
+  "version": "1.0.0",
   "description": "Shared Lighthouse API client contracts",
   "repository": "https://github.com/LetPeopleWork/lighthouse-clients",
   "type": "module",