@tryghost/prometheus-metrics 4.1.13 → 5.0.0

package/README.md

@@ -8,6 +8,21 @@ Prometheus metrics integration for exposing Ghost runtime counters, gauges, and
 
 ## Usage
 
+Import the metrics client from the package root:
+
+```ts
+import { PrometheusClient } from '@tryghost/prometheus-metrics';
+```
+
+The standalone server is available separately:
+
+```ts
+import { MetricsServer } from '@tryghost/prometheus-metrics/server';
+```
+
+Install Express 4 or 5 in your application when using `MetricsServer`. Express is
+an optional peer dependency and is not loaded by the package root.
+
 ## Develop
 
 This is a monorepo package.

package/build/PrometheusClient.d.ts

@@ -1,4 +1,4 @@
-import { Request, Response } from 'express';
+import type { Request, Response } from 'express';
 import client from 'prom-client';
 import type { Metric, MetricObjectWithValues, MetricValue } from 'prom-client';
 import type { Knex } from 'knex';

package/build/index.d.ts

@@ -1,2 +1 @@
-export * from './MetricsServer';
 export * from './PrometheusClient';

package/build/index.js

@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./MetricsServer"), exports);
 __exportStar(require("./PrometheusClient"), exports);

package/build/server.d.ts

@@ -0,0 +1 @@
+export * from './MetricsServer';

package/build/server.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./MetricsServer"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/prometheus-metrics",
-  "version": "4.1.13",
+  "version": "5.0.0",
   "author": "Ghost Foundation",
   "repository": {
     "type": "git",
@@ -12,15 +12,31 @@
   ],
   "main": "build/index.js",
   "types": "build/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "server": [
+        "build/server.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./server": {
+      "types": "./build/server.d.ts",
+      "default": "./build/server.js"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@tryghost/debug": "^2.3.12",
-    "@tryghost/logging": "^5.4.3",
-    "express": "5.2.1",
-    "prom-client": "15.1.3",
-    "stoppable": "1.1.0"
+    "@tryghost/debug": "^2.3.14",
+    "@tryghost/logging": "^5.4.5",
+    "prom-client": "^15.1.3",
+    "stoppable": "^1.1.0"
   },
   "devDependencies": {
     "@types/express": "5.0.6",
@@ -28,12 +44,21 @@
     "@types/sinon": "22.0.0",
     "@types/stoppable": "1.1.3",
     "@types/supertest": "7.2.1",
+    "express": "5.2.1",
     "knex": "3.3.0",
     "nock": "14.0.17",
     "sinon": "22.1.0",
     "supertest": "7.2.2",
     "typescript": "7.0.2"
   },
+  "peerDependencies": {
+    "express": "^4.0.0 || ^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    }
+  },
   "scripts": {
     "dev": "tsc --watch --preserveWatchOutput --sourceMap",
     "build": "pnpm run build:ts",