@c2l2c/backstage-plugin-dora-metrics 0.4.0 → 0.4.2

package/dist/index.d.ts

@@ -0,0 +1,97 @@
+export { default as doraMetricsPlugin } from './alpha.js';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { OAuthApi, ConfigApi } from '@backstage/core-plugin-api';
+import React from 'react';
+import '@backstage/frontend-plugin-api';
+
+type DoraRating = 'elite' | 'high' | 'medium' | 'low';
+interface PrDetail {
+    number: number;
+    title: string;
+    url: string;
+    durationHours: number;
+    mergedAt: string;
+    author?: string;
+    authorAvatar?: string;
+}
+interface DoraMetricValue {
+    value: number;
+    unit: string;
+    rating: DoraRating;
+    target: number;
+    slowestPRs?: PrDetail[];
+}
+interface DoraEnvironment {
+    name: string;
+    /**
+     * Raw branch pattern as configured — a single branch name, a comma-separated
+     * list ("main,master"), or a JavaScript regex string ("^(main|master)$").
+     * The client resolves this to a concrete list of branches at query time.
+     */
+    branch: string;
+    isProduction: boolean;
+    label: string;
+}
+interface DoraTargets {
+    deploymentFrequency: number;
+    leadTime: number;
+    changeFailureRate: number;
+    mttr: number;
+}
+interface DoraMetrics {
+    deploymentFrequency: DoraMetricValue;
+    leadTime: DoraMetricValue;
+    /** null for non-production environments */
+    changeFailureRate: DoraMetricValue | null;
+    /** null for non-production environments */
+    mttr: DoraMetricValue | null;
+    /** null for non-production environments */
+    numberOfHotfixes: DoraMetricValue | null;
+}
+interface DoraHistoryPoint {
+    weekLabel: string;
+    bucketMidMs: number;
+    deploymentCount: number;
+    leadTimeHours: number;
+    changeFailureRate?: number;
+    mttrHours?: number;
+}
+interface DoraMetricsApi {
+    getEnvironments(): DoraEnvironment[];
+    getDefaultDays(): number;
+    getTargets(): DoraTargets;
+    getMetrics(projectSlug: string, env: DoraEnvironment, days: number, targetsOverride?: Partial<DoraTargets>): Promise<DoraMetrics>;
+    getHistory(projectSlug: string, env: DoraEnvironment, days: number): Promise<DoraHistoryPoint[]>;
+}
+declare const doraMetricsApiRef: _backstage_core_plugin_api.ApiRef<DoraMetricsApi>;
+
+declare class DoraMetricsClient implements DoraMetricsApi {
+    private readonly githubAuthApi;
+    private readonly configApi;
+    constructor(githubAuthApi: OAuthApi, configApi: ConfigApi);
+    private getConfig;
+    getEnvironments(): DoraEnvironment[];
+    getDefaultDays(): number;
+    getTargets(): DoraTargets;
+    private fetchWithAuth;
+    /**
+     * Fetch all merged PRs for an environment, resolving branch patterns and
+     * deduplicating across multiple branches by PR number.
+     */
+    private fetchMergedPRs;
+    getMetrics(projectSlug: string, env: DoraEnvironment, days: number, targetsOverride?: Partial<DoraTargets>): Promise<DoraMetrics>;
+    getHistory(projectSlug: string, env: DoraEnvironment, days: number): Promise<DoraHistoryPoint[]>;
+}
+
+declare class MockDoraMetricsClient implements DoraMetricsApi {
+    getEnvironments(): DoraEnvironment[];
+    getDefaultDays(): number;
+    getTargets(): DoraTargets;
+    getMetrics(_projectSlug: string, env: DoraEnvironment, _days: number, _targetsOverride?: Partial<DoraTargets>): Promise<DoraMetrics>;
+    getHistory(_projectSlug: string, env: DoraEnvironment, _days: number): Promise<DoraHistoryPoint[]>;
+}
+
+declare function DoraMetricsContent(): React.JSX.Element | null;
+
+export { DoraMetricsClient, DoraMetricsContent, MockDoraMetricsClient, doraMetricsApiRef };
+export type { DoraEnvironment, DoraMetricValue, DoraMetrics, DoraMetricsApi, DoraRating, DoraTargets, PrDetail };

package/dist/index.esm.js

@@ -0,0 +1,6 @@
+export { doraMetricsPlugin } from './plugin.esm.js';
+export { doraMetricsApiRef } from './api/types.esm.js';
+export { DoraMetricsClient } from './api/DoraMetricsClient.esm.js';
+export { MockDoraMetricsClient } from './api/MockDoraMetricsClient.esm.js';
+export { DoraMetricsContent } from './components/DoraMetricsContent.esm.js';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/plugin.esm.js

@@ -0,0 +1,11 @@
+import { createFrontendPlugin } from '@backstage/frontend-plugin-api';
+import { doraMetricsEntityContentExtension } from './extensions/entityContent.esm.js';
+import { doraMetricsApiExtension } from './extensions/api.esm.js';
+
+const doraMetricsPlugin = createFrontendPlugin({
+  pluginId: "dora-metrics",
+  extensions: [doraMetricsEntityContentExtension, doraMetricsApiExtension]
+});
+
+export { doraMetricsPlugin };
+//# sourceMappingURL=plugin.esm.js.map

package/dist/plugin.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.esm.js","sources":["../src/plugin.ts"],"sourcesContent":["import { createFrontendPlugin, type FrontendPlugin } from '@backstage/frontend-plugin-api';\nimport { doraMetricsEntityContentExtension } from './extensions/entityContent';\nimport { doraMetricsApiExtension } from './extensions/api';\n\nexport const doraMetricsPlugin: FrontendPlugin = createFrontendPlugin({\n  pluginId: 'dora-metrics',\n  extensions: [doraMetricsEntityContentExtension, doraMetricsApiExtension],\n});\n"],"names":[],"mappings":";;;;AAIO,MAAM,oBAAoC,oBAAA,CAAqB;AAAA,EACpE,QAAA,EAAU,cAAA;AAAA,EACV,UAAA,EAAY,CAAC,iCAAA,EAAmC,uBAAuB;AACzE,CAAC;;;;"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@c2l2c/backstage-plugin-dora-metrics",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "A Backstage frontend plugin that displays DORA metrics (Deployment Frequency, Lead Time, Change Failure Rate, MTTR) for catalog entities via the GitHub API.",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.esm.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
   "backstage": {
     "pluginId": "dora-metrics",
     "role": "frontend-plugin",
@@ -96,5 +96,15 @@
   },
   "engines": {
     "node": ">=20"
+  },
+  "typesVersions": {
+    "*": {
+      "alpha": [
+        "dist/alpha.d.ts"
+      ],
+      "package.json": [
+        "package.json"
+      ]
+    }
   }
 }