@xyo-network/prometheus-node-plugin 5.2.4 → 5.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/prometheus-node-plugin",
-  "version": "5.2.4",
+  "version": "5.3.2",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -35,24 +35,27 @@
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
-  "dependencies": {
-    "@xylabs/exists": "~5.0.49",
-    "@xyo-network/abstract-witness": "~5.2.14",
-    "@xyo-network/module-model": "~5.2.14",
-    "@xyo-network/payload-model": "~5.2.14",
-    "@xyo-network/payloadset-plugin": "~5.2.14",
-    "@xyo-network/witness-model": "~5.2.14",
-    "prom-client": "~15.1.3"
-  },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.2.8",
-    "@xylabs/tsconfig": "~7.2.8",
-    "@xylabs/vitest-extended": "~5.0.49",
-    "@xyo-network/payload-wrapper": "~5.2.14",
+    "@xylabs/sdk-js": "^5.0.90",
+    "@xylabs/ts-scripts-yarn3": "~7.5.10",
+    "@xylabs/tsconfig": "~7.5.10",
+    "@xylabs/vitest-extended": "~5.0.90",
+    "@xyo-network/abstract-witness": "~5.3.5",
+    "@xyo-network/module-model": "~5.3.5",
+    "@xyo-network/payload-model": "~5.3.5",
+    "@xyo-network/payloadset-plugin": "~5.3.5",
+    "@xyo-network/sdk-js": "~5.3.5",
+    "@xyo-network/witness-model": "~5.3.5",
+    "prom-client": "~15.1.3",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.15"
+    "vitest": "~4.1.2",
+    "zod": "^4.3.6"
+  },
+  "peerDependencies": {
+    "@xylabs/sdk-js": "^5",
+    "zod": "^4"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}

package/src/Schema.ts

@@ -1,2 +1,4 @@
-export type PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value'
-export const PrometheusMetricValueSchema: PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value'
+import { asSchema } from '@xyo-network/payload-model'
+
+export type PrometheusMetricValueSchema = typeof PrometheusMetricValueSchema
+export const PrometheusMetricValueSchema = asSchema('network.xyo.prometheus.metric.value', true)

package/src/Witness.ts

@@ -1,19 +1,21 @@
 import type { Server } from 'node:http'
 import { createServer } from 'node:http'
 
-import { exists } from '@xylabs/exists'
+import { exists } from '@xylabs/sdk-js'
 import { AbstractWitness } from '@xyo-network/abstract-witness'
 import type { AnyConfigSchema } from '@xyo-network/module-model'
 import { creatableModule } from '@xyo-network/module-model'
-import type { Payload, Schema } from '@xyo-network/payload-model'
+import {
+  asSchema, type Payload, type Schema,
+} from '@xyo-network/payload-model'
 import type { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'
 import { collectDefaultMetrics, Registry } from 'prom-client'
 
 import type { PrometheusMetricValuePayload } from './Payload.ts'
 import { PrometheusMetricValueSchema } from './Schema.ts'
 
-export type PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config'
-export const PrometheusNodeWitnessConfigSchema: PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config'
+export type PrometheusNodeWitnessConfigSchema = typeof PrometheusNodeWitnessConfigSchema
+export const PrometheusNodeWitnessConfigSchema = asSchema('network.xyo.prometheus.node.witness.config', true)
 
 export type PrometheusNodeWitnessConfig = WitnessConfig<{
   port?: number

package/dist/node/Payload.d.ts

@@ -1,10 +0,0 @@
-import type { Payload } from '@xyo-network/payload-model';
-import type { Aggregator, MetricType } from 'prom-client';
-import type { PrometheusMetricValueSchema } from './Schema.ts';
-export type PrometheusMetricValuePayload = Payload<{
-    aggregator: Aggregator;
-    name: string;
-    type: MetricType;
-    values: (number | string | object)[];
-}, PrometheusMetricValueSchema>;
-//# sourceMappingURL=Payload.d.ts.map

package/dist/node/Payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAEzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAA;AAE9D,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAChD;IACE,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CACrC,EACD,2BAA2B,CAC5B,CAAA"}

package/dist/node/Plugin.d.ts

@@ -1,3 +0,0 @@
-import { PrometheusNodeWitness } from './Witness.ts';
-export declare const PrometheusNodePlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetWitnessPlugin<PrometheusNodeWitness<import("./Witness.ts").PrometheusNodeWitnessParams>>;
-//# sourceMappingURL=Plugin.d.ts.map

package/dist/node/Plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEpD,eAAO,MAAM,oBAAoB,mJAS9B,CAAA"}

package/dist/node/Schema.d.ts

@@ -1,3 +0,0 @@
-export type PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value';
-export declare const PrometheusMetricValueSchema: PrometheusMetricValueSchema;
-//# sourceMappingURL=Schema.d.ts.map

package/dist/node/Schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAA;AAC/E,eAAO,MAAM,2BAA2B,EAAE,2BAAmE,CAAA"}

package/dist/node/Witness.d.ts

@@ -1,25 +0,0 @@
-import type { Server } from 'node:http';
-import { AbstractWitness } from '@xyo-network/abstract-witness';
-import type { AnyConfigSchema } from '@xyo-network/module-model';
-import type { Payload, Schema } from '@xyo-network/payload-model';
-import type { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
-import { Registry } from 'prom-client';
-export type PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config';
-export declare const PrometheusNodeWitnessConfigSchema: PrometheusNodeWitnessConfigSchema;
-export type PrometheusNodeWitnessConfig = WitnessConfig<{
-    port?: number;
-    schema: PrometheusNodeWitnessConfigSchema;
-}>;
-export type PrometheusNodeWitnessParams = WitnessParams<AnyConfigSchema<PrometheusNodeWitnessConfig>>;
-export declare class PrometheusNodeWitness<TParams extends PrometheusNodeWitnessParams = PrometheusNodeWitnessParams> extends AbstractWitness<TParams> {
-    static readonly configSchemas: Schema[];
-    static readonly defaultConfigSchema: Schema;
-    protected _registry: Registry<"text/plain; version=0.0.4; charset=utf-8">;
-    protected server?: Server;
-    get registry(): Registry;
-    protected observeHandler(_payloads?: Partial<Payload>[]): Promise<Payload[]>;
-    protected startHandler(): Promise<void>;
-    protected stopHandler(): Promise<void>;
-    private generateMetricValues;
-}
-//# sourceMappingURL=Witness.d.ts.map

package/dist/node/Witness.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAIvC,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,EAAyB,QAAQ,EAAE,MAAM,aAAa,CAAA;AAK7D,MAAM,MAAM,iCAAiC,GAAG,4CAA4C,CAAA;AAC5F,eAAO,MAAM,iCAAiC,EAAE,iCAAgF,CAAA;AAEhI,MAAM,MAAM,2BAA2B,GAAG,aAAa,CAAC;IACtD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,iCAAiC,CAAA;CAC1C,CAAC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG,aAAa,CAAC,eAAe,CAAC,2BAA2B,CAAC,CAAC,CAAA;AAGrG,qBAAa,qBAAqB,CAAC,OAAO,SAAS,2BAA2B,GAAG,2BAA2B,CAAE,SAAQ,eAAe,CAAC,OAAO,CAAC;IAC5I,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAA8D;IAC9G,gBAAyB,mBAAmB,EAAE,MAAM,CAAoC;IACxF,SAAS,CAAC,SAAS,uDAAiB;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAEzB,IAAI,QAAQ,IAAI,QAAQ,CAEvB;cAEwB,cAAc,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIlE,YAAY;cAcZ,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAKvC,oBAAoB;CAUnC"}

package/dist/node/index.d.ts

@@ -1,5 +0,0 @@
-export * from './Payload.ts';
-export { PrometheusNodePlugin as default, PrometheusNodePlugin } from './Plugin.ts';
-export * from './Schema.ts';
-export * from './Witness.ts';
-//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,oBAAoB,IAAI,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AACnF,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/dist/node/index.mjs

@@ -1,75 +0,0 @@
-// src/Plugin.ts
-import { PayloadSetSchema } from "@xyo-network/payload-model";
-import { createPayloadSetWitnessPlugin } from "@xyo-network/payloadset-plugin";
-
-// src/Schema.ts
-var PrometheusMetricValueSchema = "network.xyo.prometheus.metric.value";
-
-// src/Witness.ts
-import { createServer } from "http";
-import { exists } from "@xylabs/exists";
-import { AbstractWitness } from "@xyo-network/abstract-witness";
-import { creatableModule } from "@xyo-network/module-model";
-import { collectDefaultMetrics, Registry } from "prom-client";
-var PrometheusNodeWitnessConfigSchema = "network.xyo.prometheus.node.witness.config";
-creatableModule();
-var PrometheusNodeWitness = class extends AbstractWitness {
-  static configSchemas = [...super.configSchemas, PrometheusNodeWitnessConfigSchema];
-  static defaultConfigSchema = PrometheusNodeWitnessConfigSchema;
-  _registry = new Registry();
-  server;
-  get registry() {
-    return this._registry;
-  }
-  async observeHandler(_payloads) {
-    return await this.generateMetricValues();
-  }
-  async startHandler() {
-    collectDefaultMetrics({ register: this._registry });
-    if (this.config.port) {
-      this.server = createServer(async (_request, response) => {
-        response.writeHead(200);
-        response.end(await this._registry.metrics());
-      });
-      this.server.listen(this.config.port);
-    }
-    return await super.startHandler();
-  }
-  async stopHandler() {
-    this.server?.close();
-    await super.stopHandler();
-  }
-  async generateMetricValues() {
-    return (await this._registry.getMetricsAsJSON()).map((metric) => {
-      const values = metric.values;
-      if (values) {
-        return {
-          aggregator: metric.aggregator,
-          name: metric.name,
-          schema: PrometheusMetricValueSchema,
-          type: metric.type,
-          values
-        };
-      }
-    }).filter(exists);
-  }
-};
-
-// src/Plugin.ts
-var PrometheusNodePlugin = () => createPayloadSetWitnessPlugin(
-  { required: { [PrometheusMetricValueSchema]: 1 }, schema: PayloadSetSchema },
-  {
-    witness: async (params) => {
-      const result = await PrometheusNodeWitness.create(params);
-      return result;
-    }
-  }
-);
-export {
-  PrometheusMetricValueSchema,
-  PrometheusNodePlugin,
-  PrometheusNodeWitness,
-  PrometheusNodeWitnessConfigSchema,
-  PrometheusNodePlugin as default
-};
-//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/Plugin.ts","../../src/Schema.ts","../../src/Witness.ts"],"sourcesContent":["import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { PrometheusMetricValueSchema } from './Schema.ts'\nimport { PrometheusNodeWitness } from './Witness.ts'\n\nexport const PrometheusNodePlugin = () =>\n  createPayloadSetWitnessPlugin<PrometheusNodeWitness>(\n    { required: { [PrometheusMetricValueSchema]: 1 }, schema: PayloadSetSchema },\n    {\n      witness: async (params) => {\n        const result = await PrometheusNodeWitness.create(params)\n        return result\n      },\n    },\n  )\n","export type PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value'\nexport const PrometheusMetricValueSchema: PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value'\n","import type { Server } from 'node:http'\nimport { createServer } from 'node:http'\n\nimport { exists } from '@xylabs/exists'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport type { Payload, Schema } from '@xyo-network/payload-model'\nimport type { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'\nimport { collectDefaultMetrics, Registry } from 'prom-client'\n\nimport type { PrometheusMetricValuePayload } from './Payload.ts'\nimport { PrometheusMetricValueSchema } from './Schema.ts'\n\nexport type PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config'\nexport const PrometheusNodeWitnessConfigSchema: PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config'\n\nexport type PrometheusNodeWitnessConfig = WitnessConfig<{\n  port?: number\n  schema: PrometheusNodeWitnessConfigSchema\n}>\n\nexport type PrometheusNodeWitnessParams = WitnessParams<AnyConfigSchema<PrometheusNodeWitnessConfig>>\n\ncreatableModule()\nexport class PrometheusNodeWitness<TParams extends PrometheusNodeWitnessParams = PrometheusNodeWitnessParams> extends AbstractWitness<TParams> {\n  static override readonly configSchemas: Schema[] = [...super.configSchemas, PrometheusNodeWitnessConfigSchema]\n  static override readonly defaultConfigSchema: Schema = PrometheusNodeWitnessConfigSchema\n  protected _registry = new Registry()\n  protected server?: Server\n\n  get registry(): Registry {\n    return this._registry\n  }\n\n  protected override async observeHandler(_payloads?: Partial<Payload>[]): Promise<Payload[]> {\n    return await this.generateMetricValues()\n  }\n\n  protected override async startHandler() {\n    collectDefaultMetrics({ register: this._registry })\n    if (this.config.port) {\n      // eslint-disable-next-line @typescript-eslint/no-misused-promises\n      this.server = createServer(async (_request, response) => {\n        response.writeHead(200)\n\n        response.end(await this._registry.metrics())\n      })\n      this.server.listen(this.config.port)\n    }\n    return await super.startHandler()\n  }\n\n  protected override async stopHandler(): Promise<void> {\n    this.server?.close()\n    await super.stopHandler()\n  }\n\n  private async generateMetricValues(): Promise<PrometheusMetricValuePayload[]> {\n    return (await this._registry.getMetricsAsJSON()).map((metric) => {\n      const values = metric.values\n      if (values) {\n        return {\n          aggregator: metric.aggregator, name: metric.name, schema: PrometheusMetricValueSchema, type: metric.type, values,\n        }\n      }\n    }).filter(exists)\n  }\n}\n"],"mappings":";AAAA,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;;;ACAvC,IAAM,8BAA2D;;;ACAxE,SAAS,oBAAoB;AAE7B,SAAS,cAAc;AACvB,SAAS,uBAAuB;AAEhC,SAAS,uBAAuB;AAGhC,SAAS,uBAAuB,gBAAgB;AAMzC,IAAM,oCAAuE;AASpF,gBAAgB;AACT,IAAM,wBAAN,cAA+G,gBAAyB;AAAA,EAC7I,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,iCAAiC;AAAA,EAC7G,OAAyB,sBAA8B;AAAA,EAC7C,YAAY,IAAI,SAAS;AAAA,EACzB;AAAA,EAEV,IAAI,WAAqB;AACvB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAyB,eAAe,WAAoD;AAC1F,WAAO,MAAM,KAAK,qBAAqB;AAAA,EACzC;AAAA,EAEA,MAAyB,eAAe;AACtC,0BAAsB,EAAE,UAAU,KAAK,UAAU,CAAC;AAClD,QAAI,KAAK,OAAO,MAAM;AAEpB,WAAK,SAAS,aAAa,OAAO,UAAU,aAAa;AACvD,iBAAS,UAAU,GAAG;AAEtB,iBAAS,IAAI,MAAM,KAAK,UAAU,QAAQ,CAAC;AAAA,MAC7C,CAAC;AACD,WAAK,OAAO,OAAO,KAAK,OAAO,IAAI;AAAA,IACrC;AACA,WAAO,MAAM,MAAM,aAAa;AAAA,EAClC;AAAA,EAEA,MAAyB,cAA6B;AACpD,SAAK,QAAQ,MAAM;AACnB,UAAM,MAAM,YAAY;AAAA,EAC1B;AAAA,EAEA,MAAc,uBAAgE;AAC5E,YAAQ,MAAM,KAAK,UAAU,iBAAiB,GAAG,IAAI,CAAC,WAAW;AAC/D,YAAM,SAAS,OAAO;AACtB,UAAI,QAAQ;AACV,eAAO;AAAA,UACL,YAAY,OAAO;AAAA,UAAY,MAAM,OAAO;AAAA,UAAM,QAAQ;AAAA,UAA6B,MAAM,OAAO;AAAA,UAAM;AAAA,QAC5G;AAAA,MACF;AAAA,IACF,CAAC,EAAE,OAAO,MAAM;AAAA,EAClB;AACF;;;AF9DO,IAAM,uBAAuB,MAClC;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,2BAA2B,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EAC3E;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,sBAAsB,OAAO,MAAM;AACxD,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}