@letpeoplework/lighthouse-client 0.5.0 → 0.6.0

package/dist/index.cjs

@@ -350,18 +350,6 @@ var mapAuthMode = (serverMode) => {
       return "misconfigured";
   }
 };
-var getAuthStartFailureCategory = (statusCode) => {
-  if (statusCode === 401 || statusCode === 403) {
-    return "unauthorized";
-  }
-  if (statusCode === 404) {
-    return "misconfigured";
-  }
-  if (statusCode >= 500 && statusCode <= 599) {
-    return "dependency-failure";
-  }
-  return "unexpected";
-};
 var getErrorReasonFromResponse = async (response, fallback) => {
   try {
     const body = (await response.text()).trim();
@@ -427,7 +415,7 @@ var startCliAuthSession = async (endpointUrl, dependencies) => {
     if (!response.ok) {
       return {
         status: "error",
-        category: getAuthStartFailureCategory(response.status),
+        category: getFailureCategoryForStatus(response.status),
         reason: await getErrorReasonFromResponse(
           response,
           `HTTP ${response.status}`
@@ -607,7 +595,13 @@ var requestJson = async (configuration, dependencies, route, requestOptions) =>
         )
       );
     }
-    const value = response.json !== void 0 ? await response.json() : JSON.parse(await response.text());
+    if (response.json === void 0) {
+      return {
+        ok: true,
+        value: JSON.parse(await response.text())
+      };
+    }
+    const value = await response.json();
     return {
       ok: true,
       value
@@ -659,6 +653,9 @@ 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 createLighthouseClient = (configuration, dependencies = {}) => ({
   checkConnectivity: async () => {
     const fetchDependency = getFetchDependency(dependencies);
@@ -779,29 +776,152 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
     }
   ),
   getTeamThroughput: async (teamId, range) => {
-    const r = range ?? getDefaultMetricsDateRange();
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/throughput?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamArrivals: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/arrivals?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamWipOverTime: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
     return requestJson(
       configuration,
       dependencies,
-      `/v1/teams/${teamId}/metrics/throughput?startDate=${r.startDate}&endDate=${r.endDate}`,
+      `/v1/teams/${teamId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
       { method: "GET" }
     );
   },
+  getTeamWip: async (teamId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/teams/${teamId}/metrics/wip?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
   getTeamCycleTimePercentiles: async (teamId, range) => {
-    const r = range ?? getDefaultMetricsDateRange();
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/cycleTimePercentiles?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamCycleTimeData: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/cycleTimeData?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamPredictabilityScore: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/multiitemforecastpredictabilityscore?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamTotalWorkItemAge: async (teamId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/teams/${teamId}/metrics/totalWorkItemAge?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
+  getTeamTotalWorkItemAgePbc: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
     return requestJson(
       configuration,
       dependencies,
-      `/v1/teams/${teamId}/metrics/cycleTimePercentiles?startDate=${r.startDate}&endDate=${r.endDate}`,
+      `/v1/teams/${teamId}/metrics/totalWorkItemAge/pbc?${getMetricsDateRangeQuery(r)}`,
       { method: "GET" }
     );
   },
   getPortfolioThroughput: async (portfolioId, range) => {
-    const r = range ?? getDefaultMetricsDateRange();
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/throughput?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioCycleTimePercentiles: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/cycleTimePercentiles?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioArrivals: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/arrivals?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioWipOverTime: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioWip: async (portfolioId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/portfolios/${portfolioId}/metrics/wip?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
+  getPortfolioCycleTimeData: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/cycleTimeData?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioPredictabilityScore: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/multiitemforecastpredictabilityscore?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioTotalWorkItemAge: async (portfolioId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/portfolios/${portfolioId}/metrics/totalWorkItemAge?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
+  getPortfolioTotalWorkItemAgePbc: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
     return requestJson(
       configuration,
       dependencies,
-      `/v1/portfolios/${portfolioId}/metrics/throughput?startDate=${r.startDate}&endDate=${r.endDate}`,
+      `/v1/portfolios/${portfolioId}/metrics/totalWorkItemAge/pbc?${getMetricsDateRangeQuery(r)}`,
       { method: "GET" }
     );
   },

package/dist/index.d.cts

@@ -188,8 +188,23 @@ type LighthouseClient = {
     readonly deletePortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
     readonly refreshPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
     readonly getTeamThroughput: (teamId: number, range?: MetricsDateRange) => 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 getTeamTotalWorkItemAge: (teamId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
+    readonly getTeamTotalWorkItemAgePbc: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getPortfolioThroughput: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getPortfolioCycleTimePercentiles: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getPortfolioArrivals: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getPortfolioWipOverTime: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    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 getPortfolioTotalWorkItemAge: (portfolioId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
+    readonly getPortfolioTotalWorkItemAgePbc: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     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[]>>;

package/dist/index.d.ts

@@ -188,8 +188,23 @@ type LighthouseClient = {
     readonly deletePortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
     readonly refreshPortfolio: (portfolioId: number) => Promise<LighthouseApiResult<void>>;
     readonly getTeamThroughput: (teamId: number, range?: MetricsDateRange) => 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 getTeamTotalWorkItemAge: (teamId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
+    readonly getTeamTotalWorkItemAgePbc: (teamId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     readonly getPortfolioThroughput: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getPortfolioCycleTimePercentiles: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<readonly unknown[]>>;
+    readonly getPortfolioArrivals: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    readonly getPortfolioWipOverTime: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
+    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 getPortfolioTotalWorkItemAge: (portfolioId: number, asOfDate: string) => Promise<LighthouseApiResult<number>>;
+    readonly getPortfolioTotalWorkItemAgePbc: (portfolioId: number, range?: MetricsDateRange) => Promise<LighthouseApiResult<unknown>>;
     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[]>>;

package/dist/index.js

@@ -318,18 +318,6 @@ var mapAuthMode = (serverMode) => {
       return "misconfigured";
   }
 };
-var getAuthStartFailureCategory = (statusCode) => {
-  if (statusCode === 401 || statusCode === 403) {
-    return "unauthorized";
-  }
-  if (statusCode === 404) {
-    return "misconfigured";
-  }
-  if (statusCode >= 500 && statusCode <= 599) {
-    return "dependency-failure";
-  }
-  return "unexpected";
-};
 var getErrorReasonFromResponse = async (response, fallback) => {
   try {
     const body = (await response.text()).trim();
@@ -395,7 +383,7 @@ var startCliAuthSession = async (endpointUrl, dependencies) => {
     if (!response.ok) {
       return {
         status: "error",
-        category: getAuthStartFailureCategory(response.status),
+        category: getFailureCategoryForStatus(response.status),
         reason: await getErrorReasonFromResponse(
           response,
           `HTTP ${response.status}`
@@ -575,7 +563,13 @@ var requestJson = async (configuration, dependencies, route, requestOptions) =>
         )
       );
     }
-    const value = response.json !== void 0 ? await response.json() : JSON.parse(await response.text());
+    if (response.json === void 0) {
+      return {
+        ok: true,
+        value: JSON.parse(await response.text())
+      };
+    }
+    const value = await response.json();
     return {
       ok: true,
       value
@@ -627,6 +621,9 @@ 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 createLighthouseClient = (configuration, dependencies = {}) => ({
   checkConnectivity: async () => {
     const fetchDependency = getFetchDependency(dependencies);
@@ -747,29 +744,152 @@ var createLighthouseClient = (configuration, dependencies = {}) => ({
     }
   ),
   getTeamThroughput: async (teamId, range) => {
-    const r = range ?? getDefaultMetricsDateRange();
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/throughput?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamArrivals: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/arrivals?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamWipOverTime: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
     return requestJson(
       configuration,
       dependencies,
-      `/v1/teams/${teamId}/metrics/throughput?startDate=${r.startDate}&endDate=${r.endDate}`,
+      `/v1/teams/${teamId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
       { method: "GET" }
     );
   },
+  getTeamWip: async (teamId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/teams/${teamId}/metrics/wip?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
   getTeamCycleTimePercentiles: async (teamId, range) => {
-    const r = range ?? getDefaultMetricsDateRange();
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/cycleTimePercentiles?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamCycleTimeData: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/cycleTimeData?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamPredictabilityScore: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/teams/${teamId}/metrics/multiitemforecastpredictabilityscore?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getTeamTotalWorkItemAge: async (teamId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/teams/${teamId}/metrics/totalWorkItemAge?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
+  getTeamTotalWorkItemAgePbc: async (teamId, range) => {
+    const r = getResolvedMetricsDateRange(range);
     return requestJson(
       configuration,
       dependencies,
-      `/v1/teams/${teamId}/metrics/cycleTimePercentiles?startDate=${r.startDate}&endDate=${r.endDate}`,
+      `/v1/teams/${teamId}/metrics/totalWorkItemAge/pbc?${getMetricsDateRangeQuery(r)}`,
       { method: "GET" }
     );
   },
   getPortfolioThroughput: async (portfolioId, range) => {
-    const r = range ?? getDefaultMetricsDateRange();
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/throughput?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioCycleTimePercentiles: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/cycleTimePercentiles?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioArrivals: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/arrivals?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioWipOverTime: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/wipOverTime?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioWip: async (portfolioId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/portfolios/${portfolioId}/metrics/wip?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
+  getPortfolioCycleTimeData: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/cycleTimeData?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioPredictabilityScore: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
+    return requestJson(
+      configuration,
+      dependencies,
+      `/v1/portfolios/${portfolioId}/metrics/multiitemforecastpredictabilityscore?${getMetricsDateRangeQuery(r)}`,
+      { method: "GET" }
+    );
+  },
+  getPortfolioTotalWorkItemAge: async (portfolioId, asOfDate) => requestJson(
+    configuration,
+    dependencies,
+    `/v1/portfolios/${portfolioId}/metrics/totalWorkItemAge?${getMetricsAsOfDateQuery(asOfDate)}`,
+    { method: "GET" }
+  ),
+  getPortfolioTotalWorkItemAgePbc: async (portfolioId, range) => {
+    const r = getResolvedMetricsDateRange(range);
     return requestJson(
       configuration,
       dependencies,
-      `/v1/portfolios/${portfolioId}/metrics/throughput?startDate=${r.startDate}&endDate=${r.endDate}`,
+      `/v1/portfolios/${portfolioId}/metrics/totalWorkItemAge/pbc?${getMetricsDateRangeQuery(r)}`,
       { method: "GET" }
     );
   },

package/package.json

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